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

package/src/migrationAction.ts

@@ -0,0 +1,217 @@
+import { loadConfig } from '@graphcommerce/next-config'
+import {
+  BatchMigrationCreateModelInput,
+  BatchMigrationCreateComponentInput,
+  BatchMigrationCreateEnumerationInput,
+  BatchMigrationCreateSimpleFieldInput,
+  BatchMigrationCreateEnumerableFieldInput,
+  BatchMigrationCreateRelationalFieldInput,
+  BatchMigrationCreateUnionFieldInput,
+  BatchMigrationCreateComponentFieldInput,
+  BatchMigrationDeleteComponentInput,
+  BatchMigrationDeleteEnumerationInput,
+  BatchMigrationDeleteModelInput,
+  BatchMigrationUpdateComponentFieldInput,
+  BatchMigrationUpdateComponentInput,
+  BatchMigrationUpdateEnumerableFieldInput,
+  BatchMigrationUpdateEnumerationInput,
+  BatchMigrationUpdateModelInput,
+  BatchMigrationUpdateRelationalFieldInput,
+  BatchMigrationUpdateSimpleFieldInput,
+  BatchMigrationUpdateUnionFieldInput,
+  BatchMigrationDeleteFieldInput,
+  BatchMigrationCreateComponentUnionFieldInput,
+  BatchMigrationUpdateComponentUnionFieldInput,
+} from '@hygraph/management-sdk'
+import dotenv from 'dotenv'
+import { initClient } from './client'
+import { graphcommerceLog, capitalize } from './log-functions'
+import { Schema } from './types'
+
+dotenv.config()
+const config = loadConfig(process.cwd())
+
+export const client = initClient(config, undefined)
+
+type AllActions =
+  | BatchMigrationCreateModelInput
+  | BatchMigrationUpdateModelInput
+  | BatchMigrationDeleteModelInput
+  | BatchMigrationCreateComponentInput
+  | BatchMigrationUpdateComponentInput
+  | BatchMigrationDeleteComponentInput
+  | BatchMigrationCreateEnumerationInput
+  | BatchMigrationUpdateEnumerationInput
+  | BatchMigrationDeleteEnumerationInput
+  | BatchMigrationCreateSimpleFieldInput // type: SimpleFieldType
+  | BatchMigrationUpdateSimpleFieldInput
+  | BatchMigrationCreateEnumerableFieldInput
+  | BatchMigrationUpdateEnumerableFieldInput
+  | BatchMigrationCreateRelationalFieldInput // type: RelationalFieldType
+  | BatchMigrationUpdateRelationalFieldInput
+  | BatchMigrationCreateUnionFieldInput
+  | BatchMigrationUpdateUnionFieldInput
+  | BatchMigrationCreateComponentFieldInput
+  | BatchMigrationUpdateComponentFieldInput
+  | BatchMigrationDeleteFieldInput
+  | BatchMigrationCreateComponentUnionFieldInput
+  | BatchMigrationUpdateComponentUnionFieldInput
+
+/**
+ * This constant is used to assign the right action of the management SDK to the migratioAction
+ * function
+ */
+const actionMap = client
+  ? {
+      create: {
+        model: (innerprops: BatchMigrationCreateModelInput) => client.createModel(innerprops),
+        component: (innerprops: BatchMigrationCreateComponentInput) =>
+          client.createComponent(innerprops),
+        enumeration: (innerprops: BatchMigrationCreateEnumerationInput) =>
+          client.createEnumeration(innerprops),
+        simpleField: (innerprops: BatchMigrationCreateSimpleFieldInput) =>
+          client.createSimpleField(innerprops),
+        enumerableField: (innerprops: BatchMigrationCreateEnumerableFieldInput) =>
+          client.createEnumerableField(innerprops),
+        componentField: (innerprops: BatchMigrationCreateComponentFieldInput) =>
+          client.createComponentField(innerprops),
+        relationalField: (innerprops: BatchMigrationCreateRelationalFieldInput) =>
+          client.createRelationalField(innerprops),
+        unionField: (innerprops: BatchMigrationCreateUnionFieldInput) =>
+          client.createUnionField(innerprops),
+        componentUnionField: (innerprops: BatchMigrationCreateComponentUnionFieldInput) =>
+          client.createComponentUnionField(innerprops),
+      },
+      update: {
+        model: (innerprops: BatchMigrationUpdateModelInput) => client.updateModel(innerprops),
+        component: (innerprops: BatchMigrationUpdateComponentInput) =>
+          client.updateComponent(innerprops),
+        enumeration: (innerprops: BatchMigrationUpdateEnumerationInput) =>
+          client.updateEnumeration(innerprops),
+        simpleField: (innerprops: BatchMigrationUpdateSimpleFieldInput) =>
+          client.updateSimpleField(innerprops),
+        enumerableField: (innerprops: BatchMigrationUpdateEnumerableFieldInput) =>
+          client.updateEnumerableField(innerprops),
+        componentField: (innerprops: BatchMigrationUpdateComponentFieldInput) =>
+          client.updateComponentField(innerprops),
+        relationalField: (innerprops: BatchMigrationUpdateRelationalFieldInput) =>
+          client.updateRelationalField(innerprops),
+        unionField: (innerprops: BatchMigrationUpdateUnionFieldInput) =>
+          client.updateUnionField(innerprops),
+        componentUnionField: (innerprops: BatchMigrationUpdateComponentUnionFieldInput) =>
+          client.updateComponentUnionField(innerprops),
+      },
+      delete: {
+        model: (innerprops: BatchMigrationDeleteModelInput) => client.deleteModel(innerprops),
+        component: (innerprops: BatchMigrationDeleteComponentInput) =>
+          client.deleteComponent(innerprops),
+        enumeration: (innerprops: BatchMigrationDeleteEnumerationInput) =>
+          client.deleteEnumeration(innerprops),
+        simpleField: (innerprops: BatchMigrationDeleteFieldInput) => client.deleteField(innerprops),
+        enumerableField: (innerprops: BatchMigrationDeleteFieldInput) =>
+          client.deleteField(innerprops),
+        componentField: (innerprops: BatchMigrationDeleteFieldInput) =>
+          client.deleteField(innerprops),
+        relationalField: (innerprops: BatchMigrationDeleteFieldInput) =>
+          client.deleteField(innerprops),
+        unionField: (innerprops: BatchMigrationDeleteFieldInput) => client.deleteField(innerprops),
+        componentUnionField: (innerprops: BatchMigrationDeleteFieldInput) =>
+          client.deleteField(innerprops),
+      },
+    }
+  : undefined
+
+/**
+ * This function is our variation on the client.migrationAction functions from the hygraph
+ * management sdk.
+ *
+ * MigrationAction() is better suited because it is a single function for all actions. More
+ * importantly, if the action fails, because a field with the apiID already exists for instance. it
+ * will skip this action but still continue the whole migration, while the management sdk function
+ * will bail.
+ *
+ * It takes the schema as argument, which is always the same.
+ *
+ * Then it takes the type of schema entity you want to do an action upon, and the action you want to
+ * do.
+ *
+ * The fourth arguments are the props that belong to the action you want to do. For instance, if you
+ * want to create a model, you need to pass the props that belong to a model.
+ *
+ * The last two arguments are optional. If you want to create a field, you need to pass the apiId of
+ * the model or component you want to create the field on. If you want to create a field on a
+ * component, you also need to pass the parentType, which is either 'model' or 'component'.
+ */
+export const migrationAction = (
+  schema: Schema,
+  type:
+    | 'model'
+    | 'component'
+    | 'enumeration'
+    | 'simpleField'
+    | 'componentField'
+    | 'enumerableField'
+    | 'relationalField'
+    | 'unionField'
+    | 'componentUnionField',
+  action: 'create' | 'update' | 'delete',
+  props: AllActions,
+  parentApiId?: string,
+  parentType?: 'model' | 'component' | 'enumeration',
+) => {
+  // Check if the entity already exists
+  const alreadyExists = () => {
+    switch (type) {
+      case 'model':
+        return schema.models.some((model) => model.apiId === props.apiId)
+
+      case 'component':
+        return schema.components.some((component) => component.apiId === props.apiId)
+
+      case 'enumeration':
+        return schema.enumerations.some((enumeration) => enumeration.apiId === props.apiId)
+
+      case 'simpleField':
+      case 'enumerableField':
+      case 'relationalField':
+      case 'unionField':
+      case 'componentUnionField': {
+        let parent
+        switch (parentType) {
+          case 'model': {
+            parent = schema.models.find((model) => model.apiId === parentApiId)
+            break
+          }
+          case 'component': {
+            parent = schema.components.find((component) => component.apiId === parentApiId)
+            break
+          }
+          default:
+            return false // or undefined or any other value you want if no match
+        }
+        return parent?.fields.some((field) => field.apiId === props.apiId)
+      }
+      default: {
+        return false // or undefined or any other value you want if no match
+      }
+    }
+  }
+
+  const actionFunc = actionMap && actionMap[action] && actionMap[action][type]
+
+  if (!alreadyExists()) {
+    if (actionFunc) {
+      graphcommerceLog(`${capitalize(action)} ${type} with apiId ${props.apiId}...`)
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore | This error is a loss on typescript autocomplete, but the function is called correctly
+      actionFunc(props)
+    } else {
+      graphcommerceLog(`Action ${action} is not supported for ${type}`, 'error')
+    }
+  } else {
+    graphcommerceLog(
+      `${capitalize(type)} with apiId ${props.apiId} on ${parentApiId} already exists`,
+      'warning',
+    )
+  }
+}

package/src/migrations/graphcommerce5to6.ts

@@ -0,0 +1,149 @@
+import { RelationalFieldType, SimpleFieldType, VisibilityTypes } from '@hygraph/management-sdk'
+import { migrationAction, client } from '../migrationAction'
+import { Schema } from '../types'
+
+export const graphcommerce5to6 = async (schema: Schema) => {
+  if (!client) {
+    return 0
+  }
+
+  // ? ENUMERATIONS
+  migrationAction(schema, 'enumeration', 'create', {
+    displayName: 'Row Links Variants',
+    apiId: 'RowLinksVariants',
+    values: [
+      { displayName: 'Inline', apiId: 'Inline' },
+      { displayName: 'Image Label Swiper', apiId: 'ImageLabelSwiper' },
+      { displayName: 'Logo Swiper', apiId: 'LogoSwiper' },
+      { displayName: 'USPS', apiId: 'Usps' },
+    ],
+  })
+
+  // ? MODEL
+  migrationAction(schema, 'model', 'create', {
+    apiId: 'RowLinks',
+    apiIdPlural: 'RowLinksMultiple',
+    displayName: 'Row Links',
+    description: 'Row Links is a Row of PageLinks with different variants',
+  })
+
+  migrationAction(
+    schema,
+    'simpleField',
+    'create',
+    {
+      displayName: 'Identity',
+      apiId: 'identity',
+      description: 'Only used for internal reference',
+      type: SimpleFieldType.String,
+      isTitle: true,
+      isRequired: true,
+      isUnique: true,
+      modelApiId: 'RowLinks',
+    },
+    'RowLinks',
+    'model',
+  )
+
+  migrationAction(
+    schema,
+    'enumerableField',
+    'create',
+    {
+      displayName: 'Variant',
+      apiId: 'linksVariant',
+      parentApiId: 'RowLinks',
+      enumerationApiId: 'RowLinksVariants',
+      description: 'Different variants for Row Links',
+    },
+    'RowLinks',
+    'model',
+  )
+
+  migrationAction(
+    schema,
+    'simpleField',
+    'create',
+    {
+      displayName: 'Title',
+      apiId: 'title',
+      type: SimpleFieldType.String,
+      isRequired: true,
+      modelApiId: 'RowLinks',
+      isLocalized: true,
+    },
+    'RowLinks',
+    'model',
+  )
+
+  migrationAction(
+    schema,
+    'simpleField',
+    'create',
+    {
+      displayName: 'Copy',
+      apiId: 'rowLinksCopy',
+      type: SimpleFieldType.Richtext,
+      isLocalized: true,
+      modelApiId: 'RowLinks',
+    },
+    'RowLinks',
+    'model',
+  )
+
+  migrationAction(
+    schema,
+    'relationalField',
+    'create',
+    {
+      displayName: 'Links',
+      apiId: 'pageLinks',
+      modelApiId: 'RowLinks',
+      type: RelationalFieldType.Relation,
+      reverseField: {
+        apiId: 'rowLinks',
+        modelApiId: 'PageLink',
+        displayName: 'RowLinks',
+        visibility: VisibilityTypes.Hidden,
+        isList: true,
+      },
+      visibility: VisibilityTypes.ReadWrite,
+      isList: true,
+    },
+    'RowLinks',
+    'model',
+  )
+
+  migrationAction(
+    schema,
+    'unionField',
+    'update',
+    {
+      apiId: 'content',
+      displayName: 'Content',
+      modelApiId: 'Page',
+      reverseField: {
+        modelApiIds: [
+          'RowLinks',
+          'RowServiceOptions',
+          'RowSpecialBanner',
+          'RowQuote',
+          'RowProduct',
+          'RowColumnOne',
+          'RowColumnTwo',
+          'RowColumnThree',
+          'RowHeroBanner',
+          'RowBlogContent',
+          'RowButtonList',
+          'RowContentLinks',
+          'RowButtonLinkList',
+        ],
+        // visibility: VisibilityTypes.Hidden, => Currently not supported for updateUnionField | https://github.com/hygraph/management-sdk/issues/34
+      },
+    },
+    'Page',
+    'model',
+  )
+
+  return client.run(true)
+}

package/src/migrations/graphcommerce6to7.ts

@@ -0,0 +1,307 @@
+import { SimpleFieldType, VisibilityTypes } from '@hygraph/management-sdk'
+import { migrationAction, client } from '../migrationAction'
+import { Schema } from '../types'
+
+export const graphcommerce6to7 = async (schema: Schema) => {
+  if (!client) {
+    return 0
+  }
+
+  // ? ENUMERATIONS
+  migrationAction(schema, 'enumeration', 'create', {
+    displayName: 'Row Column One Variants',
+    apiId: 'RowColumnOneVariants',
+    values: [
+      { displayName: 'Default', apiId: 'Default' },
+      { displayName: 'Message', apiId: 'Message' },
+    ],
+  })
+
+  migrationAction(schema, 'enumeration', 'create', {
+    displayName: 'Dynamic Row Condition Number Operator',
+    apiId: 'DynamicRowConditionNumberOperator',
+    values: [
+      { displayName: 'Greater than or equal to', apiId: 'GTE' },
+      { displayName: 'Less than or equal to', apiId: 'LTE' },
+      { displayName: 'Equal to', apiId: 'EQUAL' },
+    ],
+  })
+
+  migrationAction(schema, 'enumeration', 'create', {
+    displayName: 'Dynamic Row Placement',
+    apiId: 'DynamicRowPlacement',
+    values: [
+      { displayName: 'Before', apiId: 'BEFORE' },
+      { displayName: 'After', apiId: 'AFTER' },
+      { displayName: 'Replace', apiId: 'REPLACE' },
+    ],
+  })
+
+  // ? COMPONENTS
+  migrationAction(schema, 'component', 'create', {
+    displayName: 'Text',
+    apiId: 'ConditionText',
+    apiIdPlural: 'ConditionTexts',
+  })
+
+  migrationAction(schema, 'component', 'create', {
+    displayName: 'Number',
+    apiId: 'ConditionNumber',
+    apiIdPlural: 'ConditionNumbers',
+  })
+
+  migrationAction(schema, 'component', 'create', {
+    displayName: 'AND',
+    apiId: 'ConditionAnd',
+    apiIdPlural: 'ConditionAnds',
+    description: 'All of these conditions must match',
+  })
+
+  migrationAction(schema, 'component', 'create', {
+    displayName: 'OR',
+    apiId: 'ConditionOr',
+    apiIdPlural: 'ConditionOrs',
+    description: 'One of these conditions must match',
+  })
+
+  migrationAction(
+    schema,
+    'componentUnionField',
+    'create',
+    {
+      displayName: 'Conditions',
+      apiId: 'conditions',
+      parentApiId: 'ConditionAnd',
+      componentApiIds: ['ConditionOr', 'ConditionText', 'ConditionNumber'],
+      isList: true,
+    },
+    'ConditionAnd',
+    'component',
+  )
+
+  migrationAction(
+    schema,
+    'simpleField',
+    'create',
+    {
+      displayName: 'Property',
+      apiId: 'property',
+      type: SimpleFieldType.String,
+      parentApiId: 'ConditionText',
+      description:
+        'Path to the value of the object being evaluated.\n\nFor products: url_key, category, sku',
+      isRequired: true,
+      validations: {
+        String: {
+          matches: {
+            flags: ['i', 's'],
+            regex: '^[a-z0-9-_.]+$',
+            errorMessage: 'Only letters, numbers, dashes (-), underscores (_) or dots allowed (.)',
+          },
+        },
+      },
+    },
+    'ConditionText',
+    'component',
+  )
+
+  migrationAction(
+    schema,
+    'simpleField',
+    'create',
+    {
+      displayName: 'Value',
+      apiId: 'value',
+      type: SimpleFieldType.String,
+      parentApiId: 'ConditionText',
+      isRequired: true,
+    },
+    'ConditionText',
+    'component',
+  )
+
+  migrationAction(
+    schema,
+    'simpleField',
+    'create',
+    {
+      displayName: 'Property',
+      apiId: 'property',
+      type: SimpleFieldType.String,
+      parentApiId: 'ConditionNumber',
+      isRequired: true,
+      validations: {
+        String: {
+          matches: {
+            flags: ['i', 's'],
+            regex: '^[a-z0-9-_.]+$',
+            errorMessage: 'Only letters, numbers, dashes (-), underscores (_) or dots allowed (.)',
+          },
+        },
+      },
+    },
+    'ConditionNumber',
+    'component',
+  )
+
+  migrationAction(
+    schema,
+    'enumerableField',
+    'create',
+    {
+      displayName: 'Operator',
+      apiId: 'operator',
+      parentApiId: 'ConditionNumber',
+      enumerationApiId: 'DynamicRowConditionNumberOperator',
+      isRequired: true,
+    },
+    'ConditionNumber',
+    'component',
+  )
+
+  migrationAction(
+    schema,
+    'simpleField',
+    'create',
+    {
+      displayName: 'Value',
+      apiId: 'value',
+      type: SimpleFieldType.Float,
+      parentApiId: 'ConditionNumber',
+      isRequired: true,
+    },
+    'ConditionNumber',
+    'component',
+  )
+
+  // ? MODEL
+  migrationAction(schema, 'model', 'create', {
+    displayName: 'Dynamic Row',
+    apiId: 'DynamicRow',
+    apiIdPlural: 'DynamicRows',
+    description:
+      'Dynamic rows allow you to add specific Row models to pages based on the properties of the page',
+  })
+
+  migrationAction(
+    schema,
+    'simpleField',
+    'create',
+    {
+      displayName: 'Internal name',
+      apiId: 'internalName',
+      description: 'Only used for internal reference',
+      type: SimpleFieldType.String,
+      isTitle: true,
+      isRequired: true,
+      isUnique: true,
+      modelApiId: 'DynamicRow',
+    },
+    'DynamicRow',
+    'model',
+  )
+
+  migrationAction(
+    schema,
+    'unionField',
+    'create',
+    {
+      displayName: 'Row',
+      apiId: 'row',
+      reverseField: {
+        modelApiIds: ['RowQuote', 'RowLinks', 'RowColumnOne'],
+        apiId: 'dynamicRow',
+        displayName: 'DynamicRows',
+        visibility: VisibilityTypes.Hidden,
+        isList: true,
+      },
+      parentApiId: 'DynamicRow',
+    },
+    'DynamicRow',
+    'model',
+  )
+
+  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,
+    },
+    'DynamicRow',
+    'model',
+  )
+
+  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.',
+      reverseField: {
+        modelApiIds: [
+          'RowQuote',
+          'RowLinks',
+          'RowColumnOne',
+          'RowColumnTwo',
+          'RowColumnThree',
+          'RowServiceOptions',
+          'RowContentLinks',
+          'RowButtonLinkList',
+          'RowProduct',
+          'RowSpecialBanner',
+          'RowHeroBanner',
+          'RowBlogContent',
+        ],
+        apiId: 'dynamicRowsTarget',
+        displayName: 'DynamicRowsTarget',
+        visibility: VisibilityTypes.Hidden,
+        isList: true,
+      },
+      parentApiId: 'DynamicRow',
+    },
+    'DynamicRow',
+    'model',
+  )
+
+  migrationAction(
+    schema,
+    'componentUnionField',
+    'create',
+    {
+      displayName: 'Conditions (OR)',
+      apiId: 'conditions',
+      parentApiId: 'DynamicRow',
+      description: 'One of these conditions must match',
+      componentApiIds: ['ConditionAnd', 'ConditionText', 'ConditionNumber'],
+      isList: true,
+    },
+    'DynamicRow',
+    'model',
+  )
+
+  // ? Row Column One
+  migrationAction(
+    schema,
+    'enumerableField',
+    'create',
+    {
+      displayName: 'Variant',
+      apiId: 'rowColumnOneVariant',
+      enumerationApiId: 'RowColumnOneVariants',
+      parentApiId: 'RowColumnOne',
+    },
+    'RowColumnOne',
+    'model',
+  )
+
+  return client.run(true)
+}

package/src/migrations/index.ts

@@ -0,0 +1,2 @@
+export * from './graphcommerce5to6'
+export * from './graphcommerce6to7'