commercelayer · gciotola · Mar 6, 2024 · Mar 6, 2024 · Mar 6, 2024
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -6,11 +6,12 @@ parameters:
     default: "returns"
 
 orbs:
-  aws-s3: circleci/aws-s3@3.1.1
+  aws-cli: circleci/aws-cli@4.1.3
+  aws-s3: circleci/aws-s3@4.0.0
 
 image: &image
   docker:
-    - image: cimg/node:18.15.0
+    - image: cimg/node:20.11.0
   resource_class: medium+
 
 setup: &setup
@@ -28,7 +29,7 @@ jobs:
       - <<: *setup
       - run:
           name: Audit
-          command: pnpm audit --audit-level high && pnpm audit || exit 0
+          command: pnpm audit || exit 0
       - run:
           name: Test
           command: pnpm --if-present lint && pnpm --if-present ts:check && pnpm --if-present test
@@ -42,9 +43,10 @@ jobs:
       - run:
           name: Build
           command: pnpm build
+      - aws-cli/setup:
+          aws_access_key_id: AWS_ACCESS_KEY
+          aws_secret_access_key: AWS_SECRET_ACCESS_KEY
       - aws-s3/sync:
-          aws-access-key-id: AWS_ACCESS_KEY
-          aws-secret-access-key: AWS_SECRET_ACCESS_KEY
           from: packages/app/dist
           to: "s3://$S3_ASSETS_BUCKET/team/fe-static-apps/<< pipeline.parameters.project-name >>/<< pipeline.git.tag >>"
 
@@ -65,9 +67,10 @@ jobs:
       - run:
           name: Inject configuration
           command: "cp packages/app/public/config.preview-<< parameters.preview-env >>.js packages/app/dist/config.local.js"
+      - aws-cli/setup:
+          aws_access_key_id: AWS_ACCESS_KEY
+          aws_secret_access_key: AWS_SECRET_ACCESS_KEY
       - aws-s3/sync:
-          aws-access-key-id: AWS_ACCESS_KEY
-          aws-secret-access-key: AWS_SECRET_ACCESS_KEY
           from: packages/app/dist
           to: "s3://$S3_ASSETS_DEV_BUCKET/team/fe-static-apps/<< pipeline.parameters.project-name >>/<< pipeline.git.tag >>-<< parameters.preview-env >>"
 

diff --git a/.github/workflows/tag_pull_request.yaml b/.github/workflows/tag_pull_request.yaml
@@ -0,0 +1,9 @@
+name: Tag Pull Request
+
+on:
+  pull_request_target:
+
+jobs:
+  tag-pull-request:
+    uses: commercelayer/.github/.github/workflows/tag_pull_request.yaml@main
+    secrets: inherit
diff --git a/.gitignore b/.gitignore
@@ -72,8 +72,8 @@ typings/
 .yarn-integrity
 
 # dotenv environment variables file
-.env
-.env.test
+# .env  --> we want to keep it versionated by default. Use `.env.(local|production)` for custom env to be ignored
+.env.*
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache

diff --git a/.npmrc b/.npmrc
@@ -1,2 +1,3 @@
-use-node-version=18.15.0
+//registry.npmjs.org/:_authToken=${NPM_READ_TOKEN}
+use-node-version=20.11.0
 auto-install-peers=true
diff --git a/package.json b/package.json
@@ -24,15 +24,15 @@
   "license": "MIT",
   "engines": {
     "node": ">=18",
-    "pnpm": ">=7"
+    "pnpm": ">=8"
   },
   "workspaces": [
     "packages/*"
   ],
   "devDependencies": {
-    "husky": "^9.0.10",
+    "husky": "^9.0.11",
     "lerna": "^8.1.2",
     "lint-staged": "^15.2.2",
-    "npm-check-updates": "^16.14.14"
+    "npm-check-updates": "^16.14.15"
   }
-}
+}
diff --git a/packages/app/.env b/packages/app/.env
@@ -0,0 +1,4 @@
+# Base router path for the project
+PUBLIC_PROJECT_PATH=
+# When set it defines the slug for the self hosted version of the project
+PUBLIC_SELF_HOSTED_SLUG=
diff --git a/packages/app/.env.local.sample b/packages/app/.env.local.sample
diff --git a/packages/app/README.md b/packages/app/README.md
@@ -26,7 +26,7 @@ You need a local Node.JS (version 18+) environment and some React.JS knowledge t
 git clone https://github.com/<your username>/app-returns.git && cd app-returns
 ```
 
-3. Set your environment by creating a new `/src/app/.env.local` file starting from `/src/app/.env.local.sample` (not required for local development).
+3. Set your environment by creating a new `/src/app/.env.local` file starting from `/src/app/.env` (not required for local development).
 
 4. Install dependencies and run the development server:
 

diff --git a/packages/app/global.d.ts b/packages/app/global.d.ts
diff --git a/packages/app/index.html b/packages/app/index.html
@@ -3,22 +3,35 @@
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Returns | Commerce Layer</title>
+    <title>Commerce Layer</title>
     <link
       rel="icon"
       type="image/png"
       href="https://data.commercelayer.app/assets/images/favicons/favicon-32x32.png"
     />
     <link rel="preconnect" href="https://fonts.gstatic.com" />
+    <script src="https://unpkg.com/react@18/umd/react.production.min.js"></script>
+    <script src="https://unpkg.com/react-dom@18/umd/react-dom.production.min.js"></script>
     <link
       href="https://fonts.googleapis.com/css2?family=Manrope:wght@400;500;600;700;800&display=swap"
       rel="stylesheet"
     />
   </head>
   <body>
-    <div id="root"></div>
+    <div id="root-app"></div>
+
     <script src="/config.local.js"></script>
     <script src="/config.js"></script>
+
     <script type="module" src="/src/main.tsx"></script>
+
+    <script>
+      window.addEventListener('DOMContentLoaded', () => {
+        window.clApp_returns.init(document.getElementById('root-app'), {
+            organizationSlug: '%PUBLIC_SELF_HOSTED_SLUG%',
+            routerBase: '%PUBLIC_PROJECT_PATH%'
+          })
+      })
+    </script>
   </body>
 </html>
diff --git a/packages/app/package.json b/packages/app/package.json
@@ -16,31 +16,32 @@
   },
   "dependencies": {
     "@ac-dev/countries-service": "^1.2.0",
-    "@commercelayer/app-elements": "1.14.0",
-    "@commercelayer/sdk": "5.31.1",
+    "@commercelayer/app-elements": "1.16.0",
+    "@commercelayer/sdk": "5.33.1",
     "@hookform/resolvers": "^3.3.4",
     "lodash": "^4.17.21",
-    "query-string": "^8.2.0",
+    "query-string": "^9.0.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-hook-form": "^7.50.1",
-    "swr": "^2.2.4",
-    "type-fest": "^4.10.2",
-    "wouter": "^3.0.0",
+    "react-hook-form": "^7.51.0",
+    "swr": "^2.2.5",
+    "type-fest": "^4.11.1",
+    "wouter": "^3.0.1",
     "zod": "^3.22.4"
   },
   "devDependencies": {
     "@commercelayer/eslint-config-ts-react": "^1.3.0",
     "@types/lodash": "^4.14.202",
-    "@types/node": "^20.11.16",
-    "@types/react": "^18.2.55",
-    "@types/react-dom": "^18.2.19",
+    "@types/node": "^20.11.24",
+    "@types/react": "^18.2.63",
+    "@types/react-dom": "^18.2.20",
     "@vitejs/plugin-react": "^4.2.1",
-    "eslint": "^8.56.0",
+    "eslint": "^8.57.0",
     "jsdom": "^24.0.0",
+    "rollup-plugin-external-globals": "^0.9.2",
     "typescript": "^5.3.3",
-    "vite": "^5.0.12",
+    "vite": "^5.1.5",
     "vite-tsconfig-paths": "^4.3.1",
-    "vitest": "^1.2.2"
+    "vitest": "^1.3.1"
   }
 }
diff --git a/packages/app/public/config.preview-prd.js b/packages/app/public/config.preview-prd.js
@@ -0,0 +1,3 @@
+window.clAppConfig = {
+  domain: 'commercelayer.io'
+}
diff --git a/packages/app/public/config.preview-stg.js b/packages/app/public/config.preview-stg.js
@@ -0,0 +1,3 @@
+window.clAppConfig = {
+  domain: 'commercelayer.co'
+}
diff --git a/packages/app/src/App.tsx b/packages/app/src/App.tsx
@@ -4,71 +4,37 @@ import { Home } from '#pages/Home'
 import { RestockReturn } from '#pages/RestockReturn'
 import { ReturnDetails } from '#pages/ReturnDetails'
 import { ReturnsList } from '#pages/ReturnsList'
-import {
-  CoreSdkProvider,
-  ErrorBoundary,
-  GTMProvider,
-  MetaTags,
-  PageSkeleton,
-  TokenProvider
-} from '@commercelayer/app-elements'
-import { SWRConfig } from 'swr'
+import type { FC } from 'react'
 import { Route, Router, Switch } from 'wouter'
 import { appRoutes } from './data/routes'
 
-const isDev = Boolean(import.meta.env.DEV)
-
-export function App(): JSX.Element {
-  const basePath =
-    import.meta.env.PUBLIC_PROJECT_PATH != null
-      ? `/${import.meta.env.PUBLIC_PROJECT_PATH}`
-      : undefined
+interface AppProps {
+  routerBase?: string
+}
 
+export const App: FC<AppProps> = ({ routerBase }) => {
   return (
-    <ErrorBoundary hasContainer>
-      <SWRConfig
-        value={{
-          revalidateOnFocus: false
-        }}
-      >
-        <TokenProvider
-          appSlug='returns'
-          kind='returns'
-          domain={window.clAppConfig.domain}
-          reauthenticateOnInvalidAuth={!isDev}
-          loadingElement={<PageSkeleton />}
-          devMode={isDev}
-          organizationSlug={import.meta.env.PUBLIC_SELF_HOSTED_SLUG}
-        >
-          <GTMProvider gtmId={window.clAppConfig.gtmId}>
-            <MetaTags />
-            <CoreSdkProvider>
-              <Router base={basePath}>
-                <Switch>
-                  <Route path={appRoutes.home.path}>
-                    <Home />
-                  </Route>
-                  <Route path={appRoutes.list.path}>
-                    <ReturnsList />
-                  </Route>
-                  <Route path={appRoutes.filters.path}>
-                    <Filters />
-                  </Route>
-                  <Route path={appRoutes.details.path}>
-                    <ReturnDetails />
-                  </Route>
-                  <Route path={appRoutes.restock.path}>
-                    <RestockReturn />
-                  </Route>
-                  <Route>
-                    <ErrorNotFound />
-                  </Route>
-                </Switch>
-              </Router>
-            </CoreSdkProvider>
-          </GTMProvider>
-        </TokenProvider>
-      </SWRConfig>
-    </ErrorBoundary>
+    <Router base={routerBase}>
+      <Switch>
+        <Route path={appRoutes.home.path}>
+          <Home />
+        </Route>
+        <Route path={appRoutes.list.path}>
+          <ReturnsList />
+        </Route>
+        <Route path={appRoutes.filters.path}>
+          <Filters />
+        </Route>
+        <Route path={appRoutes.details.path}>
+          <ReturnDetails />
+        </Route>
+        <Route path={appRoutes.restock.path}>
+          <RestockReturn />
+        </Route>
+        <Route>
+          <ErrorNotFound />
+        </Route>
+      </Switch>
+    </Router>
   )
 }
diff --git a/packages/app/src/main.tsx b/packages/app/src/main.tsx
@@ -1,11 +1,43 @@
+import {
+  CoreSdkProvider,
+  ErrorBoundary,
+  MetaTags,
+  PageSkeleton,
+  TokenProvider,
+  createApp
+} from '@commercelayer/app-elements'
 import '@commercelayer/app-elements/style.css'
-import React from 'react'
-import ReactDOM from 'react-dom/client'
+import { StrictMode } from 'react'
+import { SWRConfig } from 'swr'
 import { App } from './App'
 
-// eslint-disable-next-line @typescript-eslint/non-nullable-type-assertion-style
-ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
-  <React.StrictMode>
-    <App />
-  </React.StrictMode>
+const isDev = Boolean(import.meta.env.DEV)
+
+createApp(
+  (props) => (
+    <StrictMode>
+      <ErrorBoundary hasContainer>
+        <SWRConfig
+          value={{
+            revalidateOnFocus: false
+          }}
+        >
+          <TokenProvider
+            kind='returns'
+            appSlug='returns'
+            devMode={isDev}
+            reauthenticateOnInvalidAuth={!isDev && props?.onInvalidAuth == null}
+            loadingElement={<PageSkeleton />}
+            {...props}
+          >
+            <CoreSdkProvider>
+              <MetaTags />
+              <App routerBase={props?.routerBase} />
+            </CoreSdkProvider>
+          </TokenProvider>
+        </SWRConfig>
+      </ErrorBoundary>
+    </StrictMode>
+  ),
+  'returns'
 )
diff --git a/packages/app/src/metricsApi/fetcher.ts b/packages/app/src/metricsApi/fetcher.ts
@@ -3,15 +3,17 @@ interface MetricsApiFetcherParams {
   slug: string
   accessToken: string
   body: Record<string, any>
+  domain: string
 }
 
 export const metricsApiFetcher = async <Data>({
   endpoint,
   slug,
   accessToken,
-  body
+  body,
+  domain
 }: MetricsApiFetcherParams): Promise<VndApiResponse<Data>> => {
-  const url = `https://${slug}.${window.clAppConfig.domain}/metrics${endpoint}`
+  const url = `https://${slug}.${domain}/metrics${endpoint}`
   const response = await fetch(url, {
     method: 'POST',
     headers: {