@graphcommerce/hygraph-cli 7.0.0-canary.21 → 7.0.0

package/dist/migrations/{dynamicRow.js → graphcommerce6to7.js}

@@ -1,28 +1,22 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dynamicRow = void 0;
-const next_config_1 = require("@graphcommerce/next-config");
+exports.graphcommerce6to7 = void 0;
 const management_sdk_1 = require("@hygraph/management-sdk");
-const dotenv_1 = __importDefault(require("dotenv"));
-dotenv_1.default.config();
-const dynamicRow = async (name) => {
-    const config = (0, next_config_1.loadConfig)(process.cwd());
-    if (!config.hygraphWriteAccessEndpoint) {
-        throw new Error('Please provide hygraphWriteAccessEndpoint in your config or GC_HYGRAPH_WRITE_ACCESS_ENDPOINT in your env');
-    }
-    if (!config.hygraphWriteAccessToken) {
-        throw new Error('Please provide GC_HYGRAPH_WRITE_ACCESS_TOKEN in your env');
+const migrationAction_1 = require("../migrationAction");
+const graphcommerce6to7 = async (schema) => {
+    if (!migrationAction_1.client) {
+        return 0;
     }
-    const client = new management_sdk_1.Client({
-        authToken: config.hygraphWriteAccessToken,
-        endpoint: config.hygraphWriteAccessEndpoint,
-        name,
-    });
     // ? ENUMERATIONS
-    client.createEnumeration({
+    (0, migrationAction_1.migrationAction)(schema, 'enumeration', 'create', {
+        displayName: 'Row Column One Variants',
+        apiId: 'RowColumnOneVariants',
+        values: [
+            { displayName: 'Default', apiId: 'Default' },
+            { displayName: 'Message', apiId: 'Message' },
+        ],
+    });
+    (0, migrationAction_1.migrationAction)(schema, 'enumeration', 'create', {
         displayName: 'Dynamic Row Condition Number Operator',
         apiId: 'DynamicRowConditionNumberOperator',
         values: [
@@ -31,7 +25,7 @@ const dynamicRow = async (name) => {
             { displayName: 'Equal to', apiId: 'EQUAL' },
         ],
     });
-    client.createEnumeration({
+    (0, migrationAction_1.migrationAction)(schema, 'enumeration', 'create', {
         displayName: 'Dynamic Row Placement',
         apiId: 'DynamicRowPlacement',
         values: [
@@ -41,43 +35,36 @@ const dynamicRow = async (name) => {
         ],
     });
     // ? COMPONENTS
-    client.createComponent({
+    (0, migrationAction_1.migrationAction)(schema, 'component', 'create', {
         displayName: 'Text',
         apiId: 'ConditionText',
         apiIdPlural: 'ConditionTexts',
     });
-    client.createComponent({
+    (0, migrationAction_1.migrationAction)(schema, 'component', 'create', {
         displayName: 'Number',
         apiId: 'ConditionNumber',
         apiIdPlural: 'ConditionNumbers',
     });
-    client.createComponent({
+    (0, migrationAction_1.migrationAction)(schema, 'component', 'create', {
         displayName: 'AND',
         apiId: 'ConditionAnd',
         apiIdPlural: 'ConditionAnds',
         description: 'All of these conditions must match',
     });
-    client.createComponent({
+    (0, migrationAction_1.migrationAction)(schema, 'component', 'create', {
         displayName: 'OR',
         apiId: 'ConditionOr',
         apiIdPlural: 'ConditionOrs',
         description: 'One of these conditions must match',
     });
-    client.createComponentUnionField({
+    (0, migrationAction_1.migrationAction)(schema, 'componentUnionField', 'create', {
         displayName: 'Conditions',
         apiId: 'conditions',
         parentApiId: 'ConditionAnd',
         componentApiIds: ['ConditionOr', 'ConditionText', 'ConditionNumber'],
         isList: true,
-    });
-    client.createComponentUnionField({
-        displayName: 'Conditions',
-        apiId: 'conditions',
-        parentApiId: 'ConditionOr',
-        componentApiIds: ['ConditionText', 'ConditionNumber'],
-        isList: true,
-    });
-    client.createSimpleField({
+    }, 'ConditionAnd', 'component');
+    (0, migrationAction_1.migrationAction)(schema, 'simpleField', 'create', {
         displayName: 'Property',
         apiId: 'property',
         type: management_sdk_1.SimpleFieldType.String,
@@ -93,15 +80,15 @@ const dynamicRow = async (name) => {
                 },
             },
         },
-    });
-    client.createSimpleField({
+    }, 'ConditionText', 'component');
+    (0, migrationAction_1.migrationAction)(schema, 'simpleField', 'create', {
         displayName: 'Value',
         apiId: 'value',
         type: management_sdk_1.SimpleFieldType.String,
         parentApiId: 'ConditionText',
         isRequired: true,
-    });
-    client.createSimpleField({
+    }, 'ConditionText', 'component');
+    (0, migrationAction_1.migrationAction)(schema, 'simpleField', 'create', {
         displayName: 'Property',
         apiId: 'property',
         type: management_sdk_1.SimpleFieldType.String,
@@ -116,29 +103,29 @@ const dynamicRow = async (name) => {
                 },
             },
         },
-    });
-    client.createEnumerableField({
+    }, 'ConditionNumber', 'component');
+    (0, migrationAction_1.migrationAction)(schema, 'enumerableField', 'create', {
         displayName: 'Operator',
         apiId: 'operator',
         parentApiId: 'ConditionNumber',
         enumerationApiId: 'DynamicRowConditionNumberOperator',
         isRequired: true,
-    });
-    client.createSimpleField({
+    }, 'ConditionNumber', 'component');
+    (0, migrationAction_1.migrationAction)(schema, 'simpleField', 'create', {
         displayName: 'Value',
         apiId: 'value',
         type: management_sdk_1.SimpleFieldType.Float,
         parentApiId: 'ConditionNumber',
         isRequired: true,
-    });
+    }, 'ConditionNumber', 'component');
     // ? MODEL
-    client.createModel({
+    (0, migrationAction_1.migrationAction)(schema, 'model', 'create', {
+        displayName: 'Dynamic Row',
         apiId: 'DynamicRow',
         apiIdPlural: 'DynamicRows',
-        displayName: 'Dynamic Row',
         description: 'Dynamic rows allow you to add specific Row models to pages based on the properties of the page',
     });
-    client.createSimpleField({
+    (0, migrationAction_1.migrationAction)(schema, 'simpleField', 'create', {
         displayName: 'Internal name',
         apiId: 'internalName',
         description: 'Only used for internal reference',
@@ -147,8 +134,8 @@ const dynamicRow = async (name) => {
         isRequired: true,
         isUnique: true,
         modelApiId: 'DynamicRow',
-    });
-    client.createUnionField({
+    }, 'DynamicRow', 'model');
+    (0, migrationAction_1.migrationAction)(schema, 'unionField', 'create', {
         displayName: 'Row',
         apiId: 'row',
         reverseField: {
@@ -159,16 +146,16 @@ const dynamicRow = async (name) => {
             isList: true,
         },
         parentApiId: 'DynamicRow',
-    });
-    client.createEnumerableField({
+    }, 'DynamicRow', 'model');
+    (0, migrationAction_1.migrationAction)(schema, 'enumerableField', 'create', {
         displayName: 'Placement',
         apiId: 'placement',
         parentApiId: 'DynamicRow',
         enumerationApiId: 'DynamicRowPlacement',
         description: 'Where will the row be placed relative to the target',
         isRequired: true,
-    });
-    client.createUnionField({
+    }, 'DynamicRow', 'model');
+    (0, migrationAction_1.migrationAction)(schema, 'unionField', 'create', {
         displayName: 'Placement target',
         apiId: 'target',
         description: 'Optional: When the target is left blank it will place the Dynamic Row on the start or end.',
@@ -193,15 +180,22 @@ const dynamicRow = async (name) => {
             isList: true,
         },
         parentApiId: 'DynamicRow',
-    });
-    client.createComponentUnionField({
+    }, 'DynamicRow', 'model');
+    (0, migrationAction_1.migrationAction)(schema, 'componentUnionField', 'create', {
         displayName: 'Conditions (OR)',
         apiId: 'conditions',
         parentApiId: 'DynamicRow',
         description: 'One of these conditions must match',
         componentApiIds: ['ConditionAnd', 'ConditionText', 'ConditionNumber'],
         isList: true,
-    });
-    return client.run(true);
+    }, 'DynamicRow', 'model');
+    // ? Row Column One
+    (0, migrationAction_1.migrationAction)(schema, 'enumerableField', 'create', {
+        displayName: 'Variant',
+        apiId: 'rowColumnOneVariant',
+        enumerationApiId: 'RowColumnOneVariants',
+        parentApiId: 'RowColumnOne',
+    }, 'RowColumnOne', 'model');
+    return migrationAction_1.client.run(true);
 };
-exports.dynamicRow = dynamicRow;
+exports.graphcommerce6to7 = graphcommerce6to7;

package/dist/migrations/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./graphcommerce5to6"), exports);
+__exportStar(require("./graphcommerce6to7"), exports);

package/dist/readSchema.js

@@ -0,0 +1,58 @@
+"use strict";
+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;
+    const hygraphClient = new client_1.ApolloClient({
+        link: new client_1.HttpLink({
+            uri: 'https://management.hygraph.com/graphql',
+            fetch: fetch_1.fetch,
+            headers: { Authorization: `Bearer ${config.hygraphWriteAccessToken}` },
+        }),
+        cache: new client_1.InMemoryCache(),
+    });
+    const { data } = await hygraphClient.query({
+        query: (0, client_1.gql) `
+      query getSchema($projectId: ID!) {
+        viewer {
+          project(id: $projectId) {
+            environment(name: "master") {
+              contentModel {
+                models {
+                  apiId
+                  apiIdPlural
+                  fields {
+                    apiId
+                  }
+                }
+                components {
+                  apiId
+                  apiIdPlural
+                  fields {
+                    apiId
+                  }
+                }
+                enumerations {
+                  apiId
+                }
+              }
+            }
+          }
+        }
+      }
+    `,
+        variables: {
+            projectId,
+        },
+    });
+    return data;
+};
+exports.readSchema = readSchema;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/hygraph-cli",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "7.0.0-canary.21",
+  "version": "7.0.0",
   "author": "",
   "license": "MIT",
   "scripts": {
@@ -14,20 +14,23 @@
   "main": "dist/index.js",
   "types": "src/index.ts",
   "dependencies": {
-    "@graphcommerce/next-config": "7.0.0-canary.21",
-    "@graphql-codegen/cli": "3.2.2",
-    "@graphql-mesh/cli": "latest",
-    "@graphql-mesh/types": "latest",
-    "@graphql-mesh/utils": "latest",
-    "@hygraph/management-sdk": "^1.1.2-alpha.1",
-    "graphql": "16.6.0",
-    "graphql-tag": "^2.12.6"
+    "@apollo/client": "~3.7.17",
+    "@graphcommerce/next-config": "7.0.0",
+    "@hygraph/management-sdk": "1.2.3",
+    "graphql-tag": "^2.12.6",
+    "prompts": "^2.4.2",
+    "@whatwg-node/fetch": "^0.9.4"
+  },
+  "peerDependencies": {
+    "graphql": "^16.7.1",
+    "dotenv": "^16.1.4"
   },
   "devDependencies": {
-    "@graphcommerce/eslint-config-pwa": "7.0.0-canary.21",
-    "@graphcommerce/prettier-config-pwa": "7.0.0-canary.21",
-    "@graphcommerce/typescript-config-pwa": "7.0.0-canary.21",
-    "typescript": "4.9.5"
+    "@types/prompts": "^2.4.4",
+    "@graphcommerce/eslint-config-pwa": "7.0.0",
+    "@graphcommerce/prettier-config-pwa": "7.0.0",
+    "@graphcommerce/typescript-config-pwa": "7.0.0",
+    "typescript": "5.1.3"
   },
   "sideEffects": false,
   "prettier": "@graphcommerce/prettier-config-pwa",

package/src/client.ts

@@ -0,0 +1,25 @@
+import { GraphCommerceConfig } from '@graphcommerce/next-config'
+import { Client } from '@hygraph/management-sdk'
+import { graphcommerceLog } from './log-functions'
+
+export const initClient = (config: GraphCommerceConfig, name: string | undefined) => {
+  if (!config.hygraphWriteAccessEndpoint) {
+    graphcommerceLog(
+      'Please provide hygraphWriteAccessEndpoint in your config or GC_HYGRAPH_WRITE_ACCESS_ENDPOINT in your env file',
+      'error',
+    )
+
+    return 0
+  }
+  if (!config.hygraphWriteAccessToken) {
+    graphcommerceLog('Please provide GC_HYGRAPH_WRITE_ACCESS_TOKEN in your env file')
+
+    return 0
+  }
+
+  return new Client({
+    authToken: config.hygraphWriteAccessToken,
+    endpoint: config.hygraphWriteAccessEndpoint,
+    name,
+  })
+}

package/src/log-functions.ts

@@ -0,0 +1,12 @@
+export const capitalize = (word: string) =>
+  word.charAt(0).toUpperCase() + word.slice(1).toLowerCase()
+
+export const graphcommerceLog = (message: string, type?: 'info' | 'warning' | 'error') => {
+  const color = {
+    error: '\x1b[31m\x1b[1m%s\x1b[0m',
+    warning: '\x1b[33m\x1b[1m%s\x1b[0m',
+    info: '\x1b[36m\x1b[1m%s\x1b[0m',
+  }
+  // eslint-disable-next-line no-console
+  console.log(type ? color[type] : '', `[GraphCommerce]: ${message}`)
+}

package/src/migrateHygraph.ts

@@ -1,73 +1,86 @@
-/* eslint-disable no-console */
-/* eslint-disable import/no-extraneous-dependencies */
-import readline from 'readline'
-import { MigrationInfo } from '@hygraph/management-sdk/dist/ManagementAPIClient'
-import { dynamicRow } from './migrations/dynamicRow'
+import fs from 'fs'
+import { loadConfig } from '@graphcommerce/next-config'
+import type { MigrationInfo } from '@hygraph/management-sdk/dist/src/ManagementAPIClient'
+import dotenv from 'dotenv'
+import prompts, { PromptObject } from 'prompts'
+import { graphcommerceLog } from './log-functions'
+import * as migrations from './migrations'
+import { readSchema } from './readSchema'
+import { Schema } from './types'
 
-export async function migrateHygraph() {
-  let forceRun = false
-
-  // Interface to determine if force run should be enabled
-  readline.createInterface({
-    input: process.stdin,
-    output: process.stdout,
-  })
+dotenv.config()
 
-  const affirmativeAnswers = ['y', 'yes', 'Y', 'YES']
+export async function migrateHygraph() {
+  const config = loadConfig(process.cwd())
 
-  const handleKeypress = (key: string) => {
-    if (affirmativeAnswers.includes(key.toLowerCase())) {
-      console.log('\nForce run enabled')
-      forceRun = true
-    } else {
-      console.log('\nForce run disabled')
-      forceRun = false
-    }
+  /**
+   * 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']
 
-    process.stdin.pause()
-  }
+  graphcommerceLog(`Graphcommerce version: ${graphcommerceVersion}`, 'info')
 
-  // Listen for keypress events
-  process.stdin.on('keypress', handleKeypress)
-  process.stdin.setRawMode(true)
-  process.stdin.resume()
+  // Extract the currently existing models, components and enumerations from the Hygraph schema.
+  const schemaViewer = await readSchema(config)
+  const schema: Schema = schemaViewer.viewer.project.environment.contentModel
 
-  console.log('Enable force run? (y/n)')
+  // A list of possible migrations
+  const possibleMigrations: [string, (schema: Schema) => Promise<0 | MigrationInfo>][] =
+    Object.entries(migrations)
 
-  // Wait for input
-  await new Promise<void>((resolve) => {
-    process.stdin.once('data', () => {
-      // Stop listening for input
-      process.stdin.removeListener('keypress', handleKeypress)
-      process.stdin.setRawMode(false)
+  // Here we setup the list we ask the user to choose from
+  const selectMigrationInput: PromptObject<string> | PromptObject<string>[] = {
+    type: 'select',
+    name: 'selectedMigration',
+    message: '\x1b[36m\x1b[1m[GraphCommerce]: Select migration',
+    choices: [],
+  }
 
-      resolve()
-    })
-  })
+  for (const [name, migration] of possibleMigrations) {
+    if (Array.isArray(selectMigrationInput.choices)) {
+      selectMigrationInput?.choices?.push({ title: name, value: { name, migration } })
+    }
+  }
 
-  // TODO: Choose migration
-  // TODO: GC-Version based migration
-  const possibleMigrations: [string, (name: string | undefined) => Promise<MigrationInfo>][] = [
-    ['add_dynamic_rows', dynamicRow],
-  ]
+  // 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)
+    const { migration, name } = selectMigrationOutput.selectedMigration
+    graphcommerceLog(
+      `You have selected the ${selectMigrationOutput.selectedMigration.name} migration`,
+      'info',
+    )
 
-  for (const [name, migration] of possibleMigrations) {
     try {
+      // Here we try to run the migration
       // eslint-disable-next-line no-await-in-loop
-      const result = await migration(forceRun ? undefined : name)
-      console.log(result)
+      const result = await migration(schema)
 
+      graphcommerceLog(`Migration result: ${JSON.stringify(result)}`, 'info')
+      if (!result) {
+        throw new Error(
+          '[GraphCommerce]: No migration client found. Please make sure your GC_HYGRAPH_WRITE_ACCESS_ENDPOINT and GC_HYGRAPH_WRITE_ACCESS_TOKEN in your env file are correct.',
+        )
+      }
       if (result.status !== 'SUCCESS') {
-        throw new Error(`Migration not successful: ${result.status} ${name}:\n${result.errors}`)
+        throw new Error(
+          `[GraphCommerce]: Migration not successful: ${result.status} ${name}:\n${result.errors}`,
+        )
       }
 
-      console.log(`Migration successful: ${name}`)
+      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
-        console.error(msg)
+        graphcommerceLog(`${msg}`, 'error')
       }
     }
+  } catch (error) {
+    graphcommerceLog(`[GraphCommerce]: An error occurred: ${error}`, 'error')
   }
 }