Rename planx-client to core (#1463)

.github/workflows/pull-request.yml

@@ -125,7 +125,7 @@ jobs:
           cache: "pnpm"
           cache-dependency-path: "**/pnpm-lock.yaml"
       - run: pnpm distribute ../api.planx.uk
-        working-directory: planx-client
+        working-directory: core
       - name: Install dependencies
         run: pnpm install --frozen-lockfile
         working-directory: api.planx.uk
@@ -163,7 +163,7 @@ jobs:
           cache: "pnpm"
           cache-dependency-path: "**/pnpm-lock.yaml"
       - run: pnpm distribute ../${{ env.EDITOR_DIRECTORY }}
-        working-directory: planx-client
+        working-directory: core
       - run: pnpm install --frozen-lockfile
         working-directory: ${{ env.EDITOR_DIRECTORY }}
       - run: pnpm build
@@ -196,7 +196,7 @@ jobs:
           cache-dependency-path: "**/pnpm-lock.yaml"
       - run: pnpm distribute ../${{ env.EDITOR_DIRECTORY }}
         if: steps.cache-react-build-assets.outputs.cache-hit != 'true'
-        working-directory: planx-client
+        working-directory: core
       - run: pnpm install --frozen-lockfile
         if: steps.cache-react-build-assets.outputs.cache-hit != 'true'
         working-directory: ${{ env.EDITOR_DIRECTORY }}
@@ -239,7 +239,7 @@ jobs:
           cache-dependency-path: "**/pnpm-lock.yaml"
       - run: pnpm distribute ../${{ env.EDITOR_DIRECTORY }}
         if: steps.cache-storybook-assets.outputs.cache-hit != 'true'
-        working-directory: planx-client
+        working-directory: core
       - run: pnpm install --frozen-lockfile
         if: steps.cache-storybook-assets.outputs.cache-hit != 'true'
         working-directory: ${{ env.EDITOR_DIRECTORY }}

.github/workflows/push-main.yml

@@ -49,7 +49,7 @@ jobs:
             ${{ runner.os }}-
       - run: npm install -g pnpm@${{ env.PNPM_VERSION }}
       - run: pnpm distribute ../editor.planx.uk
-        working-directory: planx-client
+        working-directory: core
       - run: pnpm install --frozen-lockfile
         working-directory: editor.planx.uk
       - run: pnpm build

.github/workflows/push-production.yml

@@ -49,7 +49,7 @@ jobs:
             ${{ runner.os }}-
       - run: npm install -g pnpm@${{ env.PNPM_VERSION }}
       - run: pnpm distribute ../editor.planx.uk
-        working-directory: planx-client
+        working-directory: core
       - run: pnpm install --frozen-lockfile
         working-directory: editor.planx.uk
       - run: pnpm build

api.planx.uk/Dockerfile

@@ -9,8 +9,8 @@ RUN npm install -g [email protected]
 
 # install cachable shared package
 COPY shared ./shared
-RUN pnpm install ./shared/planx-client*
-RUN cd node_modules/planx-client && pnpm install && pnpm build
+RUN pnpm install ./shared/core*
+RUN cd node_modules/core && pnpm install && pnpm build
 
 # update package cache using lockfile
 # see https://pnpm.io/cli/fetch

api.planx.uk/client/index.ts

@@ -1,14 +1,13 @@
-import { Client } from "planx-client";
+import { CoreDomainClient } from "core";
 /**
- * The planx-client doesn't expose a graphql interface like the graphql/hasura clients do
+ * core doesn't expose a graphql interface like the graphql/hasura clients do
  * instead, they encapsulates query and business logic to only expose declarative interfaces
  */
-export const adminClient = new Client({
+export const _admin = new CoreDomainClient({
   hasuraSecret: process.env.HASURA_GRAPHQL_ADMIN_SECRET!,
   targetURL: process.env.HASURA_GRAPHQL_URL!,
 });
 
-export const publicClient = new Client({
-  hasuraSecret: "",
+export const _public = new CoreDomainClient({
   targetURL: process.env.HASURA_GRAPHQL_URL!,
 });

api.planx.uk/package.json

@@ -35,7 +35,7 @@
     "passport": "^0.5.3",
     "passport-google-oauth20": "^2.0.0",
     "pino-noir": "^2.2.1",
-    "planx-client": "file:shared/planx-client-1.0.0.tgz",
+    "core": "file:shared/core-1.0.0.tgz",
     "slack-notify": "^2.0.3",
     "string-to-stream": "^3.0.1"
   },

planx-client/README.md → core/README.md

@@ -1,8 +1,8 @@
-# PlanX Client
+# PlanX Core
 
 This package is a declarative boundary between the data access layer (GraphQL/Hasura/Postgres) and the PlanX domain.
 
-Currently, this package is not published but it is copied and linked to project folders (i.e. `pnpm link planx-client`).
+Currently, this package is not published but it is copied and linked to project folders (i.e. `pnpm link core`).
 
 To Update, run `pnpm distribute` which will build and install a local version of this package into each dependent project.
 Optionally, you can distribute (copy files) to a specific location with `pnpm distribute ../api.planx.uk` (where the last argument is a relative path to a directory from the project root).

planx-client/package.json → core/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "planx-client",
+  "name": "core",
   "private": true,
   "version": "1.0.0",
   "description": "A declarative interface for PlanX data operations",

planx-client/scripts/build-and-install.sh → core/scripts/build-and-install.sh

@@ -23,14 +23,14 @@ do
   mkdir -p ${destination}/shared
 
   # remove any previous version
-  rm -rf ${destination}/node_modules/planx-client
-  rm -rf ${destination}/shared/planx-client*
+  rm -rf ${destination}/node_modules/core
+  rm -rf ${destination}/shared/core*
 
   # install a current build
   cp -f ${pack} ${destination}/shared
   cd ${destination}
   pnpm add ./shared/${pack}
-  cd ${destination}/node_modules/planx-client
+  cd ${destination}/node_modules/core
   pnpm install --frozen-lockfile
   pnpm build
   cd ${project_root}

planx-client/src/index.ts → core/src/index.ts

@@ -8,7 +8,7 @@ import { getDocumentTemplateNames } from "./document-templates";
 
 const defaultURL = process.env.HASURA_GRAPHQL_URL;
 
-export class Client {
+export class CoreDomainClient {
   client: GraphQLClient;
 
   constructor(args: {

e2e/install-dependencies.sh

@@ -5,7 +5,7 @@ SCRIPT_DIR=$(dirname "$0")
 
 set -e
 
-(cd "${SCRIPT_DIR}/../planx-client" && pnpm install && pnpm build && pnpm distribute)
+(cd "${SCRIPT_DIR}/../core" && pnpm install && pnpm build && pnpm distribute)
 (cd "${SCRIPT_DIR}/../editor.planx.uk" && pnpm install && pnpm build)
 
 if [ -z "${CI}" ]; then

e2e/package.json

@@ -13,7 +13,7 @@
     "graphql-request": "^5.1.0",
     "isomorphic-fetch": "^3.0.0",
     "jsonwebtoken": "^8.5.1",
-    "planx-client": "link:../planx-client",
+    "core": "link:../core",
     "serve": "^14.1.2"
   },
   "devDependencies": {