Merge pull request #241 from CrystallizeAPI/feat-js-api-client-v5

feat(v5): big revamp and cleaning

Author: Plopix

.github/CODE_OF_CONDUCT.md

@@ -21,24 +21,24 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
--   Demonstrating empathy and kindness toward other people
--   Being respectful of differing opinions, viewpoints, and experiences
--   Giving and gracefully accepting constructive feedback
--   Accepting responsibility and apologizing to those affected by our mistakes,
-    and learning from the experience
--   Focusing on what is best not just for us as individuals, but for the overall
-    community
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
 
 Examples of unacceptable behavior include:
 
--   The use of sexualized language or imagery, and sexual attention or advances of
-    any kind
--   Trolling, insulting or derogatory comments, and personal or political attacks
--   Public or private harassment
--   Publishing others' private information, such as a physical or email address,
-    without their explicit permission
--   Other conduct which could reasonably be considered inappropriate in a
-    professional setting
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Enforcement Responsibilities
 

.github/workflows/deploy-to-pages.yaml

@@ -0,0 +1,52 @@
+name: Deploy Docs
+
+on:
+    workflow_run:
+        workflows: ['CI']
+        types:
+            - completed
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+jobs:
+    build:
+        name: 🦾 Build the doc artefact
+        if: github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.head_branch == 'main'
+        runs-on: ubuntu-latest
+        steps:
+            - name: ⬇️ Checkout repo
+              uses: actions/checkout@v5
+
+            - name: 📦 Setup Node.js
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 22
+                  package-manager-cache: false
+
+            - name: 📦 Setup pnpm
+              uses: pnpm/action-setup@v4
+
+            - name: 📥 Download deps
+              run: pnpm install && pnpm run build
+
+            - name: 🏄 Install, build, and upload
+              uses: withastro/action@v4
+              with:
+                  path: apps/demo
+                  node-version: 22
+                  package-manager: pnpm@latest
+    deploy:
+        name: 🚀 Deploy to GitHub Pages
+        if: github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.head_branch == 'main'
+        needs: build
+        runs-on: ubuntu-latest
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        steps:
+            - name: 🚢 Ship it
+              id: deployment
+              uses: actions/deploy-pages@v4

.github/workflows/gh-pages.yaml

@@ -6,52 +6,64 @@ on:
     pull_request:
         types: [opened, synchronize, reopened]
 
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref }}
+    cancel-in-progress: true
+
 jobs:
     lint:
         name: 💄 Prettier
         runs-on: ubuntu-latest
         steps:
             - name: ⬇️ Checkout repo
-              uses: actions/checkout@v4
+              uses: actions/checkout@v5
 
-            - uses: actionsx/prettier@v3
+            - name: ⎔ Setup node
+              uses: actions/setup-node@v5
               with:
-                  args: --check .
+                  node-version: 22
+                  package-manager-cache: false
+
+            - name: ⎔ Set up pnpm
+              uses: pnpm/action-setup@v4
+
+            - name: 📥 Download deps
+              run: pnpm install
 
+            - name: 💄 Prettier
+              run: pnpm run prettier:check
     test:
         name: 🧪 Tests
         runs-on: ubuntu-latest
         needs: [lint]
         strategy:
             matrix:
-                node: [18, 20]
-        env:
-            TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
-            TURBO_TEAM: ${{ secrets.TURBO_TEAM }}
+                node: [22, 24]
         steps:
-            - name: 🛑 Cancel Previous Runs
-              uses: styfle/cancel-workflow-action@0.12.1
-
             - name: ⬇️ Checkout repo
-              uses: actions/checkout@v4
+              uses: actions/checkout@v5
 
             - name: ⎔ Setup node
-              uses: actions/setup-node@v4
+              uses: actions/setup-node@v5
               with:
                   node-version: ${{ matrix.node }}
+                  package-manager-cache: false
 
             - name: ⎔ Set up pnpm
               uses: pnpm/action-setup@v4
-              with:
-                  version: 9.12.3
 
             - name: 📥 Download deps
               run: |
                   echo ::group::..:: Mono Repo Tests ::..
-                  pnpm install
+                  pnpm install && pnpm run build
                   echo ::endgroup::
 
             - name: 🏄 Run the tests
+              env:
+                  CRYSTALLIZE_TENANT_ID: 6890ca9cd065ed6bcafdf9e5
+                  CRYSTALLIZE_TENANT_IDENTIFIER: js-api-client-integration-tests
+                  CRYSTALLIZE_ACCESS_TOKEN_ID: ${{ secrets.CRYSTALLIZE_ACCESS_TOKEN_ID }}
+                  CRYSTALLIZE_ACCESS_TOKEN_SECRET: ${{ secrets.CRYSTALLIZE_ACCESS_TOKEN_SECRET }}
               run: |
                   echo ::group::..:: Mono Repo Tests ::..
                   pnpm run test
@@ -62,21 +74,17 @@ jobs:
         runs-on: ubuntu-latest
         needs: [lint, test]
         steps:
-            - name: 🛑 Cancel Previous Runs
-              uses: styfle/cancel-workflow-action@0.12.1
-
             - name: ⬇️ Checkout repo
-              uses: actions/checkout@v4
+              uses: actions/checkout@v5
 
             - name: ⎔ Setup node
-              uses: actions/setup-node@v4
+              uses: actions/setup-node@v5
               with:
-                  node-version: 20
+                  node-version: 22
+                  package-manager-cache: false
 
             - name: ⎔ Set up pnpm
               uses: pnpm/action-setup@v4
-              with:
-                  version: 9.12.3
 
             - name: 📥 Download deps
               run: pnpm install && pnpm run build

.github/workflows/main-ci.yaml

@@ -1,3 +1,4 @@
 node_modules
 dist
 build
+.astro

.prettierignore

@@ -15,9 +15,12 @@
         "**/build": true,
         "**/dist": true,
         "**/.turbo": true,
+        "**/.astro": true,
         "**/.cache": true
     },
-    "files.associations": {},
+    "files.associations": {
+        "**/*/*.css": "tailwindcss"
+    },
     "todo-tree.general.tags": ["@todo:", "@fixme:", "@bug:"],
     "todo-tree.general.statusBar": "top three",
     "todo-tree.tree.groupedByTag": true,
@@ -42,5 +45,25 @@
             "group": "Default"
         }
     ],
-    "favorites.sortOrder": "ASC"
+    "favorites.sortOrder": "ASC",
+    "peacock.color": "#004c4d",
+    "workbench.colorCustomizations": {
+        "activityBar.activeBackground": "#007e80",
+        "activityBar.background": "#007e80",
+        "activityBar.foreground": "#e7e7e7",
+        "activityBar.inactiveForeground": "#e7e7e799",
+        "activityBarBadge.background": "#ff80fd",
+        "activityBarBadge.foreground": "#15202b",
+        "commandCenter.border": "#e7e7e799",
+        "sash.hoverBorder": "#007e80",
+        "statusBar.background": "#004c4d",
+        "statusBar.foreground": "#e7e7e7",
+        "statusBarItem.hoverBackground": "#007e80",
+        "statusBarItem.remoteBackground": "#004c4d",
+        "statusBarItem.remoteForeground": "#e7e7e7",
+        "titleBar.activeBackground": "#004c4d",
+        "titleBar.activeForeground": "#e7e7e7",
+        "titleBar.inactiveBackground": "#004c4d99",
+        "titleBar.inactiveForeground": "#e7e7e799"
+    }
 }

.vscode/settings.json

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2022 Crystallize, https://crystallize.com
+Copyright (c) 2025 Crystallize, https://crystallize.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -31,7 +31,7 @@ clean: ## Clean non-essential files
 
 .PHONY: codeclean
 codeclean: ## Code Clean
-	@pnpm prettier --write .
+	@pnpm run prettier:fix
 
 .PHONY: tests
 tests: ## Run the tests
@@ -62,4 +62,4 @@ add-component-compliance-files: ## Add the compliance files into all the compone
 .PHONY: start-demo-app
 start-demo-app: ## Start Demo App
 	@echo " ..:: Starting Demo App ::.."
-	@pnpm run demo
+	@cd apps/demo && pnpm run dev

Makefile

@@ -6,30 +6,26 @@ In order to simplify their maintenance they are all in this Git Repository.
 
 All contributions will happen here:
 
--   PRs and Issues are therefore open, discuss, contribute in one place
--   Many things will be shared accross the `components`: Coding Standards, CI & Automations, Tests, etc.
+- PRs and Issues are therefore open, discuss, contribute in one place
+- Many things will be shared accross the `components`: Coding Standards, CI & Automations, Tests, etc.
 
-✅ Nevertheless, all the `compoenents` (here library) will continue to be independant and pushed in their own repository. (through magic mechanisms that we have internally)
+✅ Nevertheless, all the `components` (here library) will continue to be independant and pushed in their own repository. (through magic mechanisms that we have internally)
 
 ## Managed Repositories
 
-| Libraries                                                                                                | Licence | Version                                      |
-| -------------------------------------------------------------------------------------------------------- | ------- | -------------------------------------------- |
-| [Import Export SDK](https://github.com/CrystallizeAPI/import-export-sdk)                                 | ![mit]  | ![import-export-sdk]                         |
-| [JS Api Client](https://github.com/CrystallizeAPI/js-api-client)                                         | ![mit]  | ![js-api-client-version]                     |
-| [React JS Hooks](https://github.com/CrystallizeAPI/reactjs-hooks)                                        | ![mit]  | ![reactjs-hooks-version]                     |
-| [React JS Components](https://github.com/CrystallizeAPI/reactjs-components)                              | ![mit]  | ![reactjs-components-version]                |
-| [Node Service Api Router](https://github.com/CrystallizeAPI/node-service-api-router)                     | ![mit]  | ![node-service-api-router-version]           |
-| [Node Service Api Request Handlers](https://github.com/CrystallizeAPI/node-service-api-request-handlers) | ![mit]  | ![node-service-api-request-handlers-version] |
-| [Schema](https://github.com/CrystallizeAPI/schema)                                                       | ![mit]  | ![schema]                                    |
+| Libraries                                                                   | Licence | Version                       |
+| --------------------------------------------------------------------------- | ------- | ----------------------------- |
+| [JS Api Client](https://github.com/CrystallizeAPI/js-api-client)            | ![mit]  | ![js-api-client-version]      |
+| [React JS Components](https://github.com/CrystallizeAPI/reactjs-components) | ![mit]  | ![reactjs-components-version] |
+| [Schema](https://github.com/CrystallizeAPI/schema)                          | ![mit]  | ![schema]                     |
 
 ## Contributions
 
 ### Conventions
 
--   Pull Requests and Issues should start with `[$COMPONENT_NAME]`
--   CI will fail if Coding Standars are not OK
--   CI will fail if Tests are not OK
+- Pull Requests and Issues should start with `[$COMPONENT_NAME]`
+- CI will fail if Coding Standars are not OK
+- CI will fail if Tests are not OK
 
 ### Coding Standards
 
@@ -72,10 +68,6 @@ make add-component COMPONENT=my-new-component
 > If not already done, you still need create the Github sub-repository and add an entry in `components/manifest.json`
 
 [mit]: https://img.shields.io/badge/license-MIT-green?style=flat-square&labelColor=black
-[import-export-sdk]: https://img.shields.io/npm/v/@crystallize/import-export-sdk?label=version&style=flat-square
 [js-api-client-version]: https://img.shields.io/npm/v/@crystallize/js-api-client?label=version&style=flat-square
-[reactjs-hooks-version]: https://img.shields.io/npm/v/@crystallize/reactjs-hooks?label=version&style=flat-square
 [reactjs-components-version]: https://img.shields.io/npm/v/@crystallize/reactjs-components?label=version&style=flat-square
-[node-service-api-router-version]: https://img.shields.io/npm/v/@crystallize/node-service-api-router?label=version&style=flat-square
-[node-service-api-request-handlers-version]: https://img.shields.io/npm/v/@crystallize/node-service-api-request-handlers?label=version&style=flat-square
 [schema]: https://img.shields.io/npm/v/@crystallize/schema?label=version&style=flat-square