feat(passport): nextjs packages (#2768)

Author: shineli1984

.cursorrules

@@ -53,4 +53,17 @@ Always use conventional commit format for all commits and PR titles:
 - Use the body to explain what and why vs. how
 - Wrap the body at 72 characters
 
-When creating PRs, always follow this conventional commit style for both the commit messages and PR titles.
+When creating PRs, always follow this conventional commit style for both the commit messages and PR titles.
+
+## Principles
+The following list of principles should be honoured when introducing changes:
+- always check what's the best practice in the industry
+- raise with the user if there is a package out there that is a 80-90% fit instead of writing from scratch
+- always clean up after changes
+- focus on root cause instead of fixing symptoms
+- trace changes applied locally and in-branch against main when debugging issues locally to first understand if it's a pre-existing bug
+- do not come up with new requirements or alter requirements by yourself. Propose alternatives first.
+- follow the same architecture pattern in the repo. If there is significant benefit to do things differently, raise it first.
+- when refactoring, check if any existing functionality has been changed/broken or new functionality has been added. if inevertible, call it out.
+- always check or ask if a problem/bug exists after certain changes. trace back and find all the changes applied in between and use that as scope for debugging.
+- when coming up with a fix, keep going after the first layer of root cause until you can reason about the entire data flow/userflow is sound.

.github/actions/setup/action.yaml

@@ -19,4 +19,4 @@ runs:
 
     - name: install dependencies
       shell: bash
-      run: pnpm install --frozen-lockfile
+      run: pnpm install --frozen-lockfile

.github/workflows/pr.yaml

@@ -3,7 +3,7 @@ name: PR
 on:
   pull_request:
     branches:
-      - '**'
+      - "**"
   merge_group:
     branches:
       - main
@@ -42,7 +42,7 @@ jobs:
         uses: ./.github/actions/setup
 
       - name: Build, Lint & Test
-        run: pnpm --if-present nx affected -t build,lint,test 
+        run: pnpm --if-present nx affected -t build,lint,test
 
   build-lint-test-examples:
     name: Build, Lint & Test Examples
@@ -64,7 +64,7 @@ jobs:
 
       - name: Prepare SDK
         run: pnpm prepare:sdk
-        
+
       - name: Prepare examples
         run: pnpm prepare:examples
 
@@ -118,7 +118,7 @@ jobs:
         with:
           ref: ${{ github.event.pull_request.head.ref }}
           fetch-depth: 0
-          
+
       - name: setup
         uses: ./.github/actions/setup
 
@@ -130,7 +130,7 @@ jobs:
 
       - name: Prepare tests
         run: pnpm prepare:tests
-        
+
       - name: Update modules
         run: pnpm install --frozen-lockfile=false
 

.github/workflows/publish.yaml

@@ -69,17 +69,17 @@ jobs:
           echo "Check user permissions for triggering actor - ${{ github.triggering_actor }}"
           echo "user-permission = ${{ steps.check_user_permission.outputs.user-permission }}"
           echo "require-result = ${{ steps.check_user_permission.outputs.require-result }}"
-  
+
       - name: Admin Permission Check
         if: ${{ steps.check_user_permission.outputs.require-result != 'true' && env.RELEASE_TYPE == 'major' }}
         run: exit 1
-  
+
       - name: Allowed Actors Check
         id: allowed_actors_check
         # only allow certain SDK team members to run this workflow
         if: ${{ contains(fromJson(env.SDK_PUBLISH_MAJOR_VERSION_ACTORS), github.triggering_actor) && env.RELEASE_TYPE == 'major' }}
         run: echo "ALLOWED_ACTOR=true" >> $GITHUB_OUTPUT
-  
+
       - name: Allowed Actors Filter
         if: ${{ steps.allowed_actors_check.outputs.ALLOWED_ACTOR != 'true' && env.RELEASE_TYPE == 'major' }}
         run: exit 1
@@ -97,7 +97,7 @@ jobs:
         run: |
           git config user.name "platform-sa"
           git config user.email "platform-sa@users.noreply.github.com"
-        
+
       - name: Initialize current versions
         run: pnpm --filter @imtbl/sdk... --filter @imtbl/checkout-widgets... exec sh -c "jq --arg version \"$(npm view @imtbl/metrics versions --json | jq -r '.[-1]')\" '.version = \$version' package.json > package.tmp.json && mv package.tmp.json package.json"
 
@@ -106,7 +106,7 @@ jobs:
 
       - name: Build SDK & Checkout Widgets
         run: pnpm build
-      
+
       - name: Pack SDK & Checkout Widgets packages and dependencies
         run: pnpm pack-npm-packages
 
@@ -118,7 +118,7 @@ jobs:
 
       - name: Publish Github Release
         if: ${{ !startsWith(env.RELEASE_TYPE, 'pre') }}
-        run: pnpm nx release changelog $(jq -r '.version' ./sdk/package.json) $( ${{ env.DRY_RUN }} && echo "--dry-run" || echo "") 
+        run: pnpm nx release changelog $(jq -r '.version' ./sdk/package.json) $( ${{ env.DRY_RUN }} && echo "--dry-run" || echo "")
 
       - name: Tag Git Pre-Release
         if: ${{ startsWith(env.RELEASE_TYPE, 'pre') }}
@@ -163,7 +163,7 @@ jobs:
         uses: ./.github/actions/notify-slack-publish-status
         with:
           message: "❌ Failed to publish SDK version ${{steps.release.outputs.RELEASE_NAME}} to NPM. ${{ github.triggering_actor }} please check the logs for more details."
-          
+
       - name: Wait for NPM @latest Update
         id: wait_for_npm_update
         if: ${{ !startsWith(env.RELEASE_TYPE, 'pre') && github.event_name != 'push' }} && env.DRY_RUN == 'false'

.husky/pre-commit

@@ -2,6 +2,6 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 # prevent heap limit allocation errors - increased to 8GB
-export NODE_OPTIONS="--max-old-space-size=8192"
+export NODE_OPTIONS="--max-old-space-size=10240"
 
 pnpm lint-staged

.npmrc

@@ -7,3 +7,7 @@ public-hoist-pattern[]=@imtbl/*
 public-hoist-pattern[]=*openzeppelin*
 public-hoist-pattern[]=*solidity*
 public-hoist-pattern[]=eslint-*
+
+# Serialize git-hosted package preparation to prevent parallel yarn installs
+# from corrupting each other (seaport packages use yarn install as prepare script)
+network-concurrency=1

.syncpackrc

@@ -6,6 +6,13 @@
       "dependencies": ["$LOCAL"],
       "dependencyTypes": ["prod", "dev"],
       "pinVersion": "workspace:*"
+    },
+    {
+      "label": "Allow flexible peer dependency ranges for auth-next packages and sdk",
+      "dependencies": ["next", "next-auth", "react"],
+      "dependencyTypes": ["peer"],
+      "packages": ["@imtbl/auth-next-server", "@imtbl/auth-next-client", "@imtbl/sdk"],
+      "isIgnored": true
     }
   ]
 }

examples/orderbook/create-bid-with-nextjs/tests/base.spec.ts

@@ -16,13 +16,13 @@ test.describe("home page", () => {
 test.describe("create bid with ERC721", () => {
   test("loads creation screen", async ({ page }) => {
     await page.getByTestId("create-bid-with-erc721").click();
-    await expect(page.getByRole("heading", { level: 1 })).toBeVisible();
+    await expect(page.getByRole("heading", { name: /Create.*ERC721.*bid/i })).toBeVisible();
   });
 });
 
 test.describe("create bid with ERC1155", () => {
   test("loads creation screen", async ({ page }) => {
     await page.getByTestId("create-bid-with-erc1155").click();
-    await expect(page.getByRole("heading", { level: 1 })).toBeVisible();
+    await expect(page.getByRole("heading", { name: /Create.*ERC1155.*bid/i })).toBeVisible();
   });
 });

examples/orderbook/create-collection-bid-with-nextjs/tests/base.spec.ts

@@ -16,13 +16,13 @@ test.describe("home page", () => {
 test.describe("create collection bid with ERC721", () => {
   test("loads creation screen", async ({ page }) => {
     await page.getByTestId("create-collection-bid-with-erc721").click();
-    await expect(page.getByRole("heading", { level: 1 })).toBeVisible();
+    await expect(page.getByRole("heading", { name: /Create ERC721 collection bid/i })).toBeVisible();
   });
 });
 
 test.describe("create collection bid with ERC1155", () => {
   test("loads creation screen", async ({ page }) => {
     await page.getByTestId("create-collection-bid-with-erc1155").click();
-    await expect(page.getByRole("heading", { level: 1 })).toBeVisible();
+    await expect(page.getByRole("heading", { name: /Create ERC1155 collection bid/i })).toBeVisible();
   });
 });

examples/orderbook/create-listing-with-nextjs/tests/base.spec.ts

@@ -16,13 +16,13 @@ test.describe("home page", () => {
 test.describe("create listing with ERC721", () => {
   test("loads creation screen", async ({ page }) => {
     await page.getByTestId("create-listing-with-erc721").click();
-    await expect(page.getByRole("heading", { level: 1 })).toBeVisible();
+    await expect(page.getByRole("heading", { name: /Create ERC721 listing/i })).toBeVisible();
   });
 });
 
 test.describe("create listing with ERC1155", () => {
   test("loads creation screen", async ({ page }) => {
     await page.getByTestId("create-listing-with-erc1155").click();
-    await expect(page.getByRole("heading", { level: 1 })).toBeVisible();
+    await expect(page.getByRole("heading", { name: /Create ERC1155 listing/i })).toBeVisible();
   });
 });