feat(WIP): new canary

Author: ommeirelles

.codesandbox/ci.json

@@ -4,12 +4,11 @@
     "packages/api",
     "packages/cli",
     "packages/core",
-    "packages/graphql-utils",
     "packages/lighthouse",
     "packages/sdk",
     "packages/ui",
     "packages/components"
   ],
   "sandboxes": ["store-ui-typescript-0gd9u"],
-  "node": "18"
+  "node": "20"
 }

.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
 
       - name: Install dependencies
         run: pnpm i

.github/workflows/release.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: "pnpm"
           registry-url: "https://registry.npmjs.org"
 

.gitignore

@@ -39,6 +39,7 @@ build/Release
 dist/
 build/
 storybook-static/
+.faststore
 
 # Dependency directories
 node_modules/

.vscode/settings.json

@@ -12,7 +12,7 @@
     "source.organizeImports.biome": "explicit"
   },
   "[json]": {
-    "editor.defaultFormatter": "biomejs.biome"
+    "editor.defaultFormatter": "vscode.json-language-features"
   },
   "[javascript]": {
     "editor.defaultFormatter": "biomejs.biome"
@@ -25,5 +25,6 @@
   },
   "[typescriptreact]": {
     "editor.defaultFormatter": "biomejs.biome"
-  }
+  },
+  "editor.fontFamily": "'MesloLGS NF', Menlo, Monaco, 'Courier New', monospace"
 }

makefile

@@ -0,0 +1,33 @@
+clean:
+	-rm -rf ./packages/*/dist
+	-rm -rf ./apps/*/.next
+	-rm -rf ./packages/api/src/__generated__
+	-rm -rf ./packages/core/@generated/*
+	-rm -rf ./apps/*/.faststore
+	-rm -rf ./packages/*/.faststore
+	-rm -rf ./packages/*/.next
+
+clean-modules: clean
+	-rm -rf ./packages/*/node_modules
+	-rm -rf ./apps/*/node_modules
+	-rm -rf ./node_modules
+	-rm -rf ./pnpm-lock.yaml
+	-pnpm cache delete
+	-pnpm install --force
+	-$(MAKE) build
+
+build: clean
+	(cd ./packages/components && pnpm build)
+	(cd ./packages/ui && pnpm build)
+	(cd ./packages/sdk && pnpm build)
+	(cd ./packages/api && pnpm build)
+	(cd ./packages/cli && pnpm build)
+
+clean-e2e: clean-modules env-e2e
+	-pnpm dlx playwright uninstall
+	-(cd ./apps/starter && pnpm playwright install --with-deps)
+	-pnpm run test:e2e
+
+env-e2e:
+	-export DEBUG=pw:api
+	-export CI=true

package.json

@@ -32,14 +32,10 @@
     "stylelint-order": "^5.0.0",
     "stylelint-scss": "^4.0.1",
     "turbo": "^2.3.4",
-    "typescript": "5.3.2"
+    "typescript": "catalog:"
   },
   "version": "0.0.0",
-  "volta": {
-    "node": "18.19.0",
-    "pnpm": "9.15.5"
-  },
-  "packageManager": "pnpm@9.15.5",
+  "packageManager": "pnpm@10.20.0",
   "lint-staged": {
     "*.{ts,js,tsx,jsx,json}": "pnpm lint:fix",
     "*.scss": "stylelint --fix"

packages/api/local/server.mjs

@@ -0,0 +1,57 @@
+import { useLogger, useMaskedErrors } from '@envelop/core'
+import { useGraphQlJit } from '@envelop/graphql-jit'
+import { useParserCache } from '@envelop/parser-cache'
+import { useValidationCache } from '@envelop/validation-cache'
+import { GraphqlVtexContextFactory, GraphqlVtexSchema } from '@faststore/api'
+import { createYoga } from 'graphql-yoga'
+import { createServer } from 'node:http'
+const serverPort = process.env.PORT ?? '4000'
+
+/** @type {import("../src").Options} */
+const apiOptions = {
+  platform: 'vtex',
+  account: 'storeframework',
+  locale: 'en-US',
+  environment: 'vtexcommercestable',
+  channel:
+    '{"salesChannel":"1","regionId":"","hasOnlyDefaultSalesChannel":"true"}',
+  showSponsored: false,
+}
+
+const yoga = createYoga({
+  schema: GraphqlVtexSchema(),
+  context: GraphqlVtexContextFactory(apiOptions),
+  plugins: [
+    useMaskedErrors({
+      maskError: (err) => {
+        if (
+          err instanceof GraphQLError &&
+          isFastStoreError(err.originalError)
+        ) {
+          return err
+        }
+
+        console.error(err)
+
+        return new GraphQLError(`Sorry, something went wrong. ${err}`)
+      },
+    }),
+    useGraphQlJit(),
+    useValidationCache(),
+    useParserCache(),
+    useLogger({
+      logFn: (eventName, { args }) =>
+        console.log(
+          `${eventName}(${args?.operationName ?? 'unknown_operation_name'}): ${JSON.stringify(args?.variableValues)}`
+        ),
+    }),
+  ],
+})
+const server = createServer(yoga)
+
+// Start the server and you're done!
+server.listen(serverPort, () => {
+  console.info(
+    `🚀 GraphQL server ready at http://localhost:${serverPort}/graphql`
+  )
+})

packages/api/local/server.ts

@@ -2,75 +2,70 @@
   "name": "@faststore/api",
   "version": "3.93.0-dev.1",
   "license": "MIT",
-  "main": "dist/cjs/src/index.js",
-  "typings": "dist/esm/src/index.d.ts",
-  "module": "dist/esm/src/index.js",
+  "main": "dist/cjs/index.js",
+  "typings": "dist/src/index.d.ts",
+  "module": "dist/es/index.mjs",
   "repository": "vtex/faststore",
   "files": [
     "dist",
     "src"
   ],
   "exports": {
     ".": {
-      "import": "./dist/esm/src/index.js",
-      "require": "./dist/cjs/src/index.js",
-      "types": "./dist/esm/src/index.d.ts",
-      "default": "./dist/esm/src/index.js"
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/es/index.mjs",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/es/index.mjs"
     }
   },
-  "browserslist": "node 18",
+  "browserslist": "node 20",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "scripts": {
-    "dev": "concurrently \"pnpm run generate -w\" \"tsc --watch\" \"pnpm run dev:graphql\"",
-    "dev:graphql": "nodemon --watch src --ext graphql --exec \"copyfiles \"src/**/*.graphql\" dist/esm\"",
-    "dev:server": "tsx --no-cache ./local/server.ts",
-    "build": "graphql-codegen --config codegen.yml && (pnpm build:cjs && pnpm build:esm)",
-    "build:cjs": "tsc --module commonjs --moduleResolution node10 --outDir dist/cjs && copyfiles \"src/**/*.graphql\" dist/cjs",
-    "build:esm": "tsc && copyfiles \"src/**/*.graphql\" dist/esm",
-    "test:int": "jest --projects jest.int.config.js",
-    "test:intc": "jest --projects jest.int.config.js --coverage",
-    "test:unit": "jest --projects jest.unit.config.js --silent",
-    "test:unitc": "jest --projects jest.unit.config.js --silent --coverage",
+    "dev": "concurrently \"pnpm run generate -w\" \"vite build --watch\" \"pnpm run dev:server\"",
+    "build": "vite build",
+    "prebuild": "pnpm generate",
+    "test:int": "vitest run ./test/integration",
+    "test:intc": "pnpm run test:int --coverage",
+    "test:unit": "vitest run ./test/unit",
+    "test:unitc": "pnpm run test:unit --coverage",
     "test": "pnpm run test:unit && pnpm run test:int",
-    "generate": "graphql-codegen --config codegen.yml"
+    "generate": "graphql-codegen --config codegen.yml",
+    "dev:server": "pnpm build && node ./local/server.mjs"
   },
   "dependencies": {
     "@graphql-tools/load-files": "^7.0.0",
-    "@graphql-tools/schema": "^9.0.0",
-    "@graphql-tools/utils": "^10.2.0",
-    "@rollup/plugin-graphql": "^1.0.0",
-    "cookie": "^0.7.0",
+    "@graphql-tools/merge": "catalog:",
+    "@graphql-tools/schema": "catalog:",
+    "@graphql-tools/utils": "catalog:",
+    "cookie": "catalog:",
     "dataloader": "^2.1.0",
-    "fast-deep-equal": "^3.1.3",
+    "fast-deep-equal": "catalog:",
     "isomorphic-unfetch": "^3.1.0",
     "p-limit": "^3.1.0",
     "sanitize-html": "^2.11.0"
   },
   "devDependencies": {
-    "@graphql-codegen/cli": "2.2.0",
-    "@graphql-codegen/typescript": "2.2.2",
-    "@parcel/watcher": "^2.4.0",
+    "@envelop/core": "catalog:",
+    "@envelop/graphql-jit": "catalog:",
+    "@envelop/parser-cache": "catalog:",
+    "@envelop/validation-cache": "catalog:",
+    "@graphql-codegen/cli": "catalog:",
+    "@graphql-codegen/typescript": "catalog:",
     "@types/cookie": "^0.6.0",
     "@types/express": "^4.17.16",
-    "@types/jest": "29.1.0",
     "@types/sanitize-html": "^2.9.1",
     "concurrently": "^6.2.1",
     "copyfiles": "^2.4.1",
-    "express": "^4.17.3",
-    "express-graphql": "^0.12.0",
-    "graphql": "^15.6.0",
-    "jest": "^29.7.0",
-    "nodemon": "^3.0.2",
-    "ts-jest": "29.1.1",
-    "tslib": "^2.3.1",
-    "tsx": "^4.6.2"
+    "graphql": "catalog:",
+    "graphql-yoga": "^5.16.1",
+    "tslib": "catalog:",
+    "vite": "catalog:",
+    "vite-plugin-dts": "catalog:",
+    "vitest": "^4.0.7"
   },
   "peerDependencies": {
-    "graphql": "^15.6.0"
-  },
-  "volta": {
-    "extends": "../../package.json"
+    "graphql": "catalog:"
   }
 }