feat: Split library in to `framework` and `primitives` sub-packages #42

morgsmccauley · 2023-11-16T02:44:20Z

This PR merges dev-1.1 in to main, the major change in this being the splitting of the core library in to sub-packages, @near-lake/framework and @near-lake/primitives.

I've merged main back in to this branch to make them compatible. This included #28, which has been slightly modified to fit the new package structure.

I've also updated the main README.md to highlight this package split.

After this is merged, I'll add the Changesets Action to automate package releases :)

…hed under a new name

Co-authored-by: Morgan McCauley <morgan@mccauley.co.nz>

Build: update to monorepo + use turborepo

…-lake-framework

…indexer with new primitives

…rimitives feat: port rust indexer primitives to JS

Beta Release Of Packages + renaming packages

fix: Ensure `primitives` is installed when installing `framework`

* add README * add dependency explaination * Update packages/near-lake-framework/README.md Co-authored-by: Roshaan Siddiqui <siddiqui.roshaan@gmail.com> * Update packages/near-lake-framework/README.md Co-authored-by: Roshaan Siddiqui <siddiqui.roshaan@gmail.com> * Update README.md Remove Events interface spec * Update packages/near-lake-framework/README.md Co-authored-by: Bohdan Khorolets <bogdan@khorolets.com> * Update packages/near-lake-framework/README.md Co-authored-by: Bohdan Khorolets <bogdan@khorolets.com> --------- Co-authored-by: Roshaan Siddiqui <siddiqui.roshaan@gmail.com> Co-authored-by: Bohdan Khorolets <bogdan@khorolets.com>

* add README * add Receipt section * Event section * add StateChange section * Update README.md Remove executed receipts private field * Update README.md Remove private explanation from Block * Apply suggestions from code review Co-authored-by: Roshaan Siddiqui <siddiqui.roshaan@gmail.com> * Update README.md Add Read More on trx section note * add event interface spec * Update packages/near-lake-primitives/README.md Co-authored-by: Bohdan Khorolets <bogdan@khorolets.com> * Update README.md * Update README.md add missing return types * Update README.md add return type for from constructor --------- Co-authored-by: Roshaan Siddiqui <siddiqui.roshaan@gmail.com> Co-authored-by: Bohdan Khorolets <bogdan@khorolets.com>

feat: can fetch logs from a block

* typedocs --------- Co-authored-by: Roshaan Siddiqui <siddiqui.roshaan@gmail.com>

* fix: Current version of `turbo` breaks `npm i` in GitHub Actions * chore: Remove `postinstall` hook to unblock GH action

roshaans

Overall looks good to me, but I have not been able to successfully build this package on my machine yet.

roshaans · 2023-11-27T18:20:38Z

packages/near-lake-framework/package.json

+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.32.0",
+    "@near-lake/primitives": "^0.1.0"


Should we change this to file../near-lake-primitives now that this will be published in the main package?

This is the error I get when I try to run npm run build from the root directory:

@near-lake/framework:build: src/types.ts(3,53): error TS2307: Cannot find module '@near-lake/prim itives' or its corresponding type declarations.

The NPM entry point was incorrect, I've pushed a fix. Can you please try rebuild?

Should we change this to file../near-lake-primitives now that this will be published in the main package?

NPM will use the local package if the versions align. It's better to keep it locked at a specific version so we can work on them independently, i.e. we might make changes to primitives which aren't yet ready to be merged in to framework. Using file wouldn't allow us to choose when to upgrade.

roshaans

LGTM! Able to build the package successfully.

roshaans and others added 30 commits January 24, 2023 09:16

feat: update to monorepo + use turborepo

85721c5

feat: add changesets for versioning/publishing

edc610b

feat: add linting support

c02cb38

style: fix styling with eslint

0a2c857

change near-lake-framwork repo name to prevent it from getting publis…

c2846e2

…hed under a new name

cache entire dist folder with its contents during build pipline

6ba9857

remove eslint support + restore prettier config

1a93ed4

Update formatting in turbo.json

4243125

Co-authored-by: Morgan McCauley <morgan@mccauley.co.nz>

Merge pull request #18 from near/roshaan/dplt-754-change-to-monorepo

f55dbe6

Build: update to monorepo + use turborepo

add examples app for demo purposes

b5adb9c

add @near-lake/indexer-primitives

20437f2

types: convert some interfaces to types

a1c6eed

export only core types needed by near-indexer-framework

83dfb49

only export types that are needed

68f42ad

strict ts config to catch errors

e7f8c05

add helper for receipts conversion + clean up

924d616

add helper to convert from state change view to state change type

efcec1d

add implementation details for methods of the block class

7533fc3

add indexer-primitives as a dependency to framework + change types

3591d33

remove version from indexer-examples repo

ef59152

style: change naming + change Array<> to []

9926417

style: consistency with views

57a3556

remove accidetnally checked in code

48ba6a2

rename state_changes file + create LakeConfig + export types for near…

0c4ec53

…-lake-framework

feat: make near-lake-framework work with new indexer primitives

4b24183

feat: run different indexer examples from root. restructing + simple …

9c472c6

…indexer with new primitives

fix: do not throw error for logToRawEvent, simply return

5ca5b33

switch to examples package

d1e3ee3

formatting: code formatting

75abfb5

convert block header to class with a static method

8bb0dbc

roshaans and others added 17 commits February 1, 2023 10:03

Merge pull request #20 from near/roshaan/dplt-752-port-rust-indexer-p…

e37274b

…rimitives feat: port rust indexer primitives to JS

style: update package name

f80444f

fix: change package names

938698d

testing release with changeset, hey morgan

8bacb3a

chore: Update package-lock.json

1a4bc4d

fix: change prepare instruction

1e5ae47

Merge pull request #24 from near/roshaan/test-release

26dde98

Beta Release Of Packages + renaming packages

fix: Ensure primitives is installed when installing framework

626bdcb

Merge pull request #26 from near/fix/framework-workspace-deps

5fc40c1

fix: Ensure `primitives` is installed when installing `framework`

feat: can fetch logs from a block

c2afbab

Merge pull request #34 from near/feat/fetch-raw-logs

ad9caff

feat: can fetch logs from a block

Add TypeDocs to lake-primitives (#35)

76ce7e5

* typedocs --------- Co-authored-by: Roshaan Siddiqui <siddiqui.roshaan@gmail.com>

move docs

83e98f8

Merge remote-tracking branch 'origin/main' into dev-1.1

ac18cc1

fix: Current version of turbo breaks npm i in GitHub Actions (#44)

408545c

* fix: Current version of `turbo` breaks `npm i` in GitHub Actions * chore: Remove `postinstall` hook to unblock GH action

morgsmccauley temporarily deployed to github-pages November 16, 2023 03:09 — with GitHub Pages Inactive

morgsmccauley changed the title ~~Merge dev-1.1 in to main~~ feat: Split library in to framework and primitives sub-packages Nov 16, 2023

chore: Describe package split in README.md (#45)

be36a7a

morgsmccauley temporarily deployed to github-pages November 16, 2023 03:32 — with GitHub Pages Inactive

morgsmccauley linked an issue Nov 16, 2023 that may be closed by this pull request

Merge dev-1.1 branch #40

Closed

roshaans requested review from khorolets and roshaans November 27, 2023 17:51

roshaans reviewed Nov 27, 2023

View reviewed changes

fix: Use correct NPM entrypoint for primitives

e738043

roshaans self-requested a review November 28, 2023 19:33

roshaans approved these changes Nov 28, 2023

View reviewed changes

morgsmccauley merged commit cab772c into main Nov 28, 2023
4 of 6 checks passed

morgsmccauley deleted the dev-1.1 branch November 28, 2023 19:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Split library in to `framework` and `primitives` sub-packages #42

feat: Split library in to `framework` and `primitives` sub-packages #42

morgsmccauley commented Nov 16, 2023 •

edited

roshaans left a comment

roshaans Nov 27, 2023

roshaans Nov 27, 2023

morgsmccauley Nov 27, 2023

morgsmccauley Nov 27, 2023

roshaans left a comment

feat: Split library in to framework and primitives sub-packages #42

feat: Split library in to framework and primitives sub-packages #42

Conversation

morgsmccauley commented Nov 16, 2023 • edited

roshaans left a comment

Choose a reason for hiding this comment

roshaans Nov 27, 2023

Choose a reason for hiding this comment

roshaans Nov 27, 2023

Choose a reason for hiding this comment

morgsmccauley Nov 27, 2023

Choose a reason for hiding this comment

morgsmccauley Nov 27, 2023

Choose a reason for hiding this comment

roshaans left a comment

Choose a reason for hiding this comment

feat: Split library in to `framework` and `primitives` sub-packages #42

feat: Split library in to `framework` and `primitives` sub-packages #42

morgsmccauley commented Nov 16, 2023 •

edited