@graphcommerce/hygraph-cli 9.0.0-canary.72 → 9.0.0-canary.74

package/dist/migrations/graphcommerce7to8.js

@@ -2,23 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.graphcommerce7to8 = void 0;
 const management_sdk_1 = require("@hygraph/management-sdk");
-const migrationAction_1 = require("../migrationAction");
-const graphcommerce7to8 = async (schema) => {
-    if (!migrationAction_1.client) {
-        return 0;
-    }
+const migrationActionFactory_1 = require("../migrationActionFactory");
+const graphcommerce7to8 = async (schema, client) => {
+    const { migrationAction } = (0, migrationActionFactory_1.migrationActionFactory)(schema, client);
     const hasRow = schema.models
         .find((m) => m.apiId === 'DynamicRow')
         ?.fields.some((f) => f.apiId === 'row');
     if (hasRow) {
-        (0, migrationAction_1.migrationAction)(schema, 'unionField', 'update', {
+        migrationAction(schema, 'unionField', 'update', {
             apiId: 'row',
             displayName: 'Row Deprecated',
             parentApiId: 'DynamicRow',
             description: 'This field is deprecated. Use Rows instead.',
         });
     }
-    (0, migrationAction_1.migrationAction)(schema, 'unionField', 'create', {
+    migrationAction(schema, 'unionField', 'create', {
         displayName: 'Rows',
         apiId: 'rows',
         isList: true,
@@ -31,13 +29,13 @@ const graphcommerce7to8 = async (schema) => {
         },
         parentApiId: 'DynamicRow',
     }, 'DynamicRow', 'model');
-    (0, migrationAction_1.migrationAction)(schema, 'componentUnionField', 'create', {
+    migrationAction(schema, 'componentUnionField', 'create', {
         displayName: 'Conditions',
         apiId: 'conditions',
         parentApiId: 'ConditionOr',
         componentApiIds: ['ConditionText', 'ConditionNumber'],
         isList: true,
     }, 'ConditionOr', 'component');
-    return migrationAction_1.client.run(true);
+    return client.run(true);
 };
 exports.graphcommerce7to8 = graphcommerce7to8;

package/dist/migrations/graphcommerce8to9.js

@@ -1,22 +1,68 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.graphcommerce8to9 = void 0;
-const migrationAction_1 = require("../migrationAction");
-const graphcommerce8to9 = async (schema) => {
-    if (!migrationAction_1.client) {
-        return 0;
-    }
-    // This migration is for GC 8.0 and is not yet exported as a usable migration.
+const management_sdk_1 = require("@hygraph/management-sdk");
+const migrationActionFactory_1 = require("../migrationActionFactory");
+const graphcommerce8to9 = async (schema, client) => {
+    const { migrationAction } = (0, migrationActionFactory_1.migrationActionFactory)(schema, client);
     // Removes the deprecated 'Row' field which was deprecated in GC@7.1
     const hasRow = schema.models
         .find((m) => m.apiId === 'DynamicRow')
         ?.fields.some((f) => f.apiId === 'row');
     if (hasRow) {
-        (0, migrationAction_1.migrationAction)(schema, 'simpleField', 'delete', {
+        migrationAction(schema, 'simpleField', 'delete', {
             apiId: 'row',
             parentApiId: 'DynamicRow',
         });
     }
-    return migrationAction_1.client.run(true);
+    const hasRowCategory = schema.models.some((m) => m.apiId === 'RowCategory');
+    //
+    if (!hasRowCategory) {
+        migrationAction(schema, 'model', 'create', {
+            apiId: 'RowCategory',
+            displayName: 'Row Category',
+            apiIdPlural: 'RowProductLists',
+            description: 'A model that displays a category',
+        });
+        migrationAction(schema, 'simpleField', 'create', {
+            position: 1,
+            type: management_sdk_1.SimpleFieldType.String,
+            formConfig: { renderer: 'GCMS_SLUG', config: { isLowercase: true } },
+            validations: {
+                String: {
+                    matches: {
+                        regex: '^[a-z0-9]+(?:[-/][a-z0-9]+)*$',
+                        errorMessage: 'The category URL must be a valid slug',
+                    },
+                },
+            },
+            parentApiId: 'RowCategory',
+            displayName: 'Category URL',
+            apiId: 'categoryUrl',
+            description: 'The URL of the category, may include slashes',
+            isTitle: true,
+            isLocalized: true,
+            isRequired: true,
+            visibility: management_sdk_1.VisibilityTypes.ReadWrite,
+        }, 'RowCategory', 'model');
+        migrationAction(schema, 'enumeration', 'create', {
+            displayName: 'Row Category Variant',
+            apiId: 'RowCategoryVariant',
+            values: [
+                { displayName: 'Backstory', apiId: 'Backstory' },
+                { displayName: 'Grid', apiId: 'Grid' },
+                { displayName: 'Swipeable', apiId: 'Swipeable' },
+            ],
+        });
+        migrationAction(schema, 'enumerableField', 'create', {
+            displayName: 'Variant',
+            apiId: 'variant',
+            parentApiId: 'RowCategory',
+            enumerationApiId: 'RowCategoryVariant',
+            description: 'As what variant wil the RowCategory be displayed',
+            isRequired: true,
+        }, 'RowCategory', 'model');
+    }
+    return client.run(true);
 };
 exports.graphcommerce8to9 = graphcommerce8to9;

package/dist/readSchema.js

@@ -2,33 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readSchema = void 0;
 const client_1 = require("@apollo/client");
-const fetch_1 = require("@whatwg-node/fetch");
-const readSchema = async (config) => {
-    if (!config.hygraphProjectId) {
-        throw new Error('Please provide GC_HYGRAPH_PROJECT_ID in your env file.');
-    }
-    if (!config.hygraphWriteAccessToken) {
-        throw new Error('Please provide GC_HYGRAPH_WRITE_ACCESS_TOKEN in your env file.');
-    }
-    const projectId = config.hygraphProjectId;
-    if (!config.hygraphManagementApi) {
-        throw new Error('Please provide GC_HYGRAPH_MANAGEMENT_API in your env file.');
-    }
-    const hygraphClient = new client_1.ApolloClient({
-        link: new client_1.HttpLink({
-            uri: config.hygraphManagementApi,
-            fetch: fetch_1.fetch,
-            headers: { Authorization: `Bearer ${config.hygraphWriteAccessToken}` },
-        }),
-        cache: new client_1.InMemoryCache(),
-    });
-    const { data } = await hygraphClient.query({
+const readSchema = async (managementClient, projectId) => {
+    const { data } = await managementClient.query({
         query: (0, client_1.gql) `
       query getSchema($projectId: ID!) {
         viewer {
           project(id: $projectId) {
             environment(name: "master") {
               contentModel {
+                locales {
+                  id
+                  apiId
+                }
+                stages {
+                  id
+                  apiId
+                }
                 models {
                   apiId
                   apiIdPlural

package/dist/utils/getConfig.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getConfig = getConfig;
+function getConfig(config) {
+    let { hygraphProjectId: projectId, hygraphWriteAccessToken: authToken, hygraphManagementApi: uri, hygraphEndpoint, } = config;
+    if (!authToken) {
+        throw new Error('Please provide GC_HYGRAPH_WRITE_ACCESS_TOKEN in your env file.');
+    }
+    if (!projectId) {
+        projectId = new URL(hygraphEndpoint).pathname.split('/')?.[1];
+    }
+    if (!uri) {
+        const endpoint = new URL(hygraphEndpoint);
+        endpoint.hostname = `management-${endpoint.hostname}`.replace('.cdn', '');
+        endpoint.pathname = 'graphql';
+        uri = endpoint.toString();
+    }
+    return { projectId, authToken, uri };
+}

package/dist/utils/getEndpointUrl.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnvironment = getEnvironment;
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+async function getEnvironment(client, config) {
+    const endpoints = await client.query({
+        query: (0, graphql_tag_1.default) `
+      query Environments($projectId: ID!) {
+        viewer {
+          id
+          project(id: $projectId) {
+            environments {
+              name
+              endpoint
+              migrations {
+                name
+                status
+              }
+            }
+          }
+        }
+      }
+    `,
+        variables: { projectId: config.projectId },
+        errorPolicy: 'all',
+    });
+    if (endpoints.errors) {
+        const isBadInput = endpoints.errors.some((e) => e.extensions?.code === 'BAD_USER_INPUT');
+        if (isBadInput) {
+            throw Error(`
+        Could not find environment for projectId ${config.projectId}. 
+        Please check your GC_HYGRAPH_PROJECT_ID in your env file.
+      `);
+        }
+        throw new Error(`An error occurred: ${endpoints.errors.map((e) => e.message).join('\n')}`);
+    }
+    const environment = endpoints.data.viewer.project.environments.find((env) => env.name === 'master') ??
+        endpoints.data.viewer.project.environments?.[0];
+    return environment;
+}

package/dist/utils/getManagementClient.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getManagementClient = getManagementClient;
+const client_1 = require("@apollo/client");
+function getManagementClient(config) {
+    const { authToken: accessToken, uri } = config;
+    return new client_1.ApolloClient({
+        link: new client_1.HttpLink({
+            uri,
+            fetch,
+            headers: { Authorization: `Bearer ${accessToken}` },
+        }),
+        cache: new client_1.InMemoryCache(),
+    });
+}

package/dist/{log-functions.js → utils/graphCommerceLog.js}

@@ -10,6 +10,6 @@ const graphcommerceLog = (message, type) => {
         info: '\x1b[36m\x1b[1m%s\x1b[0m',
     };
     // eslint-disable-next-line no-console
-    console.log(type ? color[type] : '', `[GraphCommerce]: ${message}`);
+    console.log(type ? color[type] : '', `${message}`);
 };
 exports.graphcommerceLog = graphcommerceLog;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/hygraph-cli",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "9.0.0-canary.72",
+  "version": "9.0.0-canary.74",
   "scripts": {
     "dev": "tsc --preserveWatchOutput --watch",
     "build": "tsc",
@@ -19,10 +19,10 @@
   },
   "peerDependencies": {
     "@apollo/client": "^3",
-    "@graphcommerce/eslint-config-pwa": "^9.0.0-canary.72",
-    "@graphcommerce/next-config": "^9.0.0-canary.72",
-    "@graphcommerce/prettier-config-pwa": "^9.0.0-canary.72",
-    "@graphcommerce/typescript-config-pwa": "^9.0.0-canary.72",
+    "@graphcommerce/eslint-config-pwa": "^9.0.0-canary.74",
+    "@graphcommerce/next-config": "^9.0.0-canary.74",
+    "@graphcommerce/prettier-config-pwa": "^9.0.0-canary.74",
+    "@graphcommerce/typescript-config-pwa": "^9.0.0-canary.74",
     "dotenv": "^16.1.4",
     "graphql": "^16.7.1"
   },

package/src/UpsertClient.ts

@@ -0,0 +1,99 @@
+import {
+  BatchMigrationCreateComponentFieldInput,
+  BatchMigrationCreateComponentInput,
+  BatchMigrationCreateComponentUnionFieldInput,
+  BatchMigrationCreateEnumerableFieldInput,
+  BatchMigrationCreateEnumerationInput,
+  BatchMigrationCreateLocaleInput,
+  BatchMigrationCreateModelInput,
+  BatchMigrationCreateRelationalFieldInput,
+  BatchMigrationCreateSimpleFieldInput,
+  BatchMigrationCreateStageInput,
+  BatchMigrationCreateUnionFieldInput,
+  Client,
+} from '@hygraph/management-sdk'
+import { Schema } from './types'
+
+interface MigrationParams {
+  name?: string
+  endpoint: string
+  authToken: string
+}
+
+export class UpsertClient extends Client {
+  constructor(
+    params: MigrationParams,
+    private schema: Schema,
+  ) {
+    super(params)
+  }
+
+  upsertModel(data: BatchMigrationCreateModelInput) {
+    const exists = this.schema.models.some((m) => m.apiId === data.apiId)
+    return exists ? this.createModel(data) : this.updateModel(data)
+  }
+
+  upsertComponent(data: BatchMigrationCreateComponentInput) {
+    const exists = this.schema.models.some((m) => m.apiId === data.apiId)
+    return exists ? this.createComponent(data) : this.updateComponent(data)
+  }
+
+  upsertSimpleField(data: BatchMigrationCreateSimpleFieldInput) {
+    const model = this.schema.models.find((m) => m.apiId === data.parentApiId)
+    const exists = model?.fields.some((f) => f.apiId === data.apiId)
+    return exists
+      ? this.createSimpleField(data)
+      : this.updateSimpleField({ ...data, embeddableModels: undefined })
+  }
+
+  // upsertRemoteField(data: BatchMigrationCreateRemoteFieldInput) {
+  //   const model = this.schema.models.find((m) => m.apiId === data.parentApiId)
+  //   const exists = model?.fields.some((f) => f.apiId === data.apiId)
+  //   return exists ? this.createRemoteField(data) : this.updateRemoteField(data)
+  // }
+
+  upsertRelationalField(data: BatchMigrationCreateRelationalFieldInput) {
+    const model = this.schema.models.find((m) => m.apiId === data.parentApiId)
+    const exists = model?.fields.some((f) => f.apiId === data.apiId)
+    return exists ? this.createRelationalField(data) : this.updateRelationalField(data)
+  }
+
+  upsertUnionField(data: BatchMigrationCreateUnionFieldInput) {
+    const model = this.schema.models.find((m) => m.apiId === data.parentApiId)
+    const exists = model?.fields.some((f) => f.apiId === data.apiId)
+    return exists ? this.createUnionField(data) : this.updateUnionField(data)
+  }
+
+  upsertComponentField(data: BatchMigrationCreateComponentFieldInput) {
+    const model = this.schema.models.find((m) => m.apiId === data.parentApiId)
+    const exists = model?.fields.some((f) => f.apiId === data.apiId)
+    return exists ? this.createComponentField(data) : this.updateComponentField(data)
+  }
+
+  upsertComponentUnionField(data: BatchMigrationCreateComponentUnionFieldInput) {
+    const model = this.schema.models.find((m) => m.apiId === data.parentApiId)
+    const exists = model?.fields.some((f) => f.apiId === data.apiId)
+    return exists ? this.createComponentUnionField(data) : this.updateComponentUnionField(data)
+  }
+
+  upsertEnumeration(data: BatchMigrationCreateEnumerationInput) {
+    const exists = this.schema.enumerations.some((e) => e.apiId === data.apiId)
+    return exists ? this.createEnumeration(data) : this.updateEnumeration(data)
+  }
+
+  upsertEnumerableField(data: BatchMigrationCreateEnumerableFieldInput) {
+    const model = this.schema.models.find((m) => m.apiId === data.parentApiId)
+    const exists = model?.fields.some((f) => f.apiId === data.apiId)
+    return exists ? this.createEnumerableField(data) : this.updateEnumerableField(data)
+  }
+
+  upsertStage(data: BatchMigrationCreateStageInput) {
+    const exists = this.schema.stages.some((m) => m.apiId === data.apiId)
+    return exists ? this.createStage(data) : this.updateStage(data)
+  }
+
+  upsertLocale(data: BatchMigrationCreateLocaleInput) {
+    const exists = this.schema.locales.some((m) => m.apiId === data.apiId)
+    return exists ? this.createLocale(data) : this.updateLocale(data)
+  }
+}

package/src/index.ts

@@ -1 +1 @@
-export { migrateHygraph } from './migrateHygraph'
+export { migrateHygraphCli as migrateHygraph } from './migrateHygraphCli'

package/src/migrateHygraphCli.ts

@@ -0,0 +1,113 @@
+import fs from 'fs'
+import { loadConfig } from '@graphcommerce/next-config'
+import dotenv from 'dotenv'
+import prompts, { PromptObject } from 'prompts'
+import { UpsertClient } from './UpsertClient'
+import * as availableMigrations from './migrations'
+import { readSchema } from './readSchema'
+import { MigrationFunction, Schema } from './types'
+import { getConfig } from './utils/getConfig'
+import { getEnvironment } from './utils/getEndpointUrl'
+import { getManagementClient } from './utils/getManagementClient'
+import { graphcommerceLog } from './utils/graphCommerceLog'
+
+dotenv.config()
+
+export async function migrateHygraphCli() {
+  const hygraphConfig = getConfig(loadConfig(process.cwd()))
+
+  /**
+   * Extracting the current GC version. Are we gonna use the current version to determine which
+   * scripts should be runned? Or do we let the user pick the migration from a list? 🤔
+   */
+  const packageJson = fs.readFileSync('package.json', 'utf8')
+  const packageData = JSON.parse(packageJson)
+  const graphcommerceVersion = packageData.dependencies['@graphcommerce/next-ui']
+  graphcommerceLog(`Graphcommerce version: ${graphcommerceVersion}`, 'info')
+
+  const mangementClient = getManagementClient(hygraphConfig)
+  // Extract the currently existing models, components and enumerations from the Hygraph schema.
+  const schemaViewer = await readSchema(mangementClient, hygraphConfig.projectId)
+  const schema: Schema = schemaViewer.viewer.project.environment.contentModel
+
+  // A list of possible migrations
+  const possibleMigrations: [string, MigrationFunction][] = Object.entries(availableMigrations)
+
+  // Here we setup the list we ask the user to choose from
+  const selectMigrationInput: PromptObject<string> = {
+    type: 'select',
+    name: 'selectedMigration',
+    message: '\x1b[36m\x1b[1m[]: Select migration',
+    choices: possibleMigrations.map(([name, migration]) => ({
+      title: name,
+      value: { name, migration },
+    })),
+  }
+
+  // Here we ask the user to choose a migration from a list of possible migrations
+  try {
+    graphcommerceLog('Available migrations: ', 'info')
+    const selectMigrationOutput = await prompts(selectMigrationInput)
+
+    let { migration, name } = selectMigrationOutput.selectedMigration as {
+      name: string
+      migration: MigrationFunction
+    }
+
+    graphcommerceLog(
+      `You have selected the ${selectMigrationOutput.selectedMigration.name} migration`,
+      'info',
+    )
+
+    try {
+      const { endpoint, migrations } = await getEnvironment(mangementClient, hygraphConfig)
+
+      const migrationExists = migrations.find(
+        (m) => m.name?.startsWith(name) && m.status === 'SUCCESS',
+      )
+      if (migrationExists) {
+        if (!process.argv.includes('--force')) {
+          graphcommerceLog(
+            `Migration ${name} as ${migrationExists.name} already exists in Hygraph with the status SUCCESS. To rerun this migration use the --force option. Exiting now..`,
+            'info',
+          )
+          process.exit(1)
+        } else {
+          graphcommerceLog(
+            `Migration ${name} as ${migrationExists.name} already exists in Hygraph with the status SUCCESS. Using --force, rerunning migration..`,
+            'warning',
+          )
+        }
+        name = `${name}-${Date.now()}`
+      }
+
+      // Here we try to run the migration
+      const result = await migration(
+        schema,
+        new UpsertClient({ authToken: hygraphConfig.authToken, endpoint, name }, schema),
+      )
+
+      graphcommerceLog(`Migration result: ${JSON.stringify(result)}`, 'info')
+      if (!result) {
+        graphcommerceLog(
+          'No migration client found. Please make sure your GC_HYGRAPH_WRITE_ACCESS_TOKEN in your env file is correct.',
+        )
+        process.exit(1)
+      }
+      if (result.status !== 'SUCCESS') {
+        graphcommerceLog(`Migration not successful: ${result.status} ${name}:\n${result.errors}`)
+        process.exit(1)
+      }
+
+      graphcommerceLog(`Migration successful: ${name}`, 'info')
+    } catch (err) {
+      if (err instanceof Error) {
+        const garbledErrorIndex = err.message.indexOf(': {"')
+        const msg = garbledErrorIndex > 0 ? err.message.slice(0, garbledErrorIndex) : err.message
+        graphcommerceLog(`${msg}`, 'error')
+      }
+    }
+  } catch (error) {
+    graphcommerceLog(`An error occurred: ${error}`, 'error')
+  }
+}