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

package/src/readSchema.ts

@@ -0,0 +1,61 @@
+import { ApolloClient, InMemoryCache, gql, HttpLink } from '@apollo/client'
+import { GraphCommerceConfig } from '@graphcommerce/next-config'
+import { fetch } from '@whatwg-node/fetch'
+
+export const readSchema = async (config: GraphCommerceConfig) => {
+  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 ApolloClient({
+    link: new HttpLink({
+      uri: 'https://management.hygraph.com/graphql',
+      fetch,
+      headers: { Authorization: `Bearer ${config.hygraphWriteAccessToken}` },
+    }),
+    cache: new InMemoryCache(),
+  })
+
+  const { data } = await hygraphClient.query({
+    query: 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
+}

package/src/types.ts

@@ -1,4 +1,11 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
-import { MigrationInfo } from '@hygraph/management-sdk/dist/ManagementAPIClient'
+import type { Model, Component, Enumeration } from '@hygraph/management-sdk'
+import type { MigrationInfo } from '@hygraph/management-sdk/dist/src/ManagementAPIClient'
 
 export type Migration = (name: string | undefined) => Promise<MigrationInfo>
+
+export type Schema = {
+  models: Model[]
+  components: Component[]
+  enumerations: Enumeration[]
+}

package/src/migrations/dynamicRow.ts

@@ -1,229 +0,0 @@
-import { loadConfig } from '@graphcommerce/next-config'
-import { Client, SimpleFieldType, VisibilityTypes } from '@hygraph/management-sdk'
-import dotenv from 'dotenv'
-
-dotenv.config()
-
-export const dynamicRow = async (name: string | undefined) => {
-  const config = 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 client = new Client({
-    authToken: config.hygraphWriteAccessToken,
-    endpoint: config.hygraphWriteAccessEndpoint,
-    name,
-  })
-
-  // ? ENUMERATIONS
-  client.createEnumeration({
-    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' },
-    ],
-  })
-
-  client.createEnumeration({
-    displayName: 'Dynamic Row Placement',
-    apiId: 'DynamicRowPlacement',
-    values: [
-      { displayName: 'Before', apiId: 'BEFORE' },
-      { displayName: 'After', apiId: 'AFTER' },
-      { displayName: 'Replace', apiId: 'REPLACE' },
-    ],
-  })
-
-  // ? COMPONENTS
-  client.createComponent({
-    displayName: 'Text',
-    apiId: 'ConditionText',
-    apiIdPlural: 'ConditionTexts',
-  })
-
-  client.createComponent({
-    displayName: 'Number',
-    apiId: 'ConditionNumber',
-    apiIdPlural: 'ConditionNumbers',
-  })
-
-  client.createComponent({
-    displayName: 'AND',
-    apiId: 'ConditionAnd',
-    apiIdPlural: 'ConditionAnds',
-    description: 'All of these conditions must match',
-  })
-
-  client.createComponent({
-    displayName: 'OR',
-    apiId: 'ConditionOr',
-    apiIdPlural: 'ConditionOrs',
-    description: 'One of these conditions must match',
-  })
-
-  client.createComponentUnionField({
-    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({
-    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 (.)',
-        },
-      },
-    },
-  })
-
-  client.createSimpleField({
-    displayName: 'Value',
-    apiId: 'value',
-    type: SimpleFieldType.String,
-    parentApiId: 'ConditionText',
-    isRequired: true,
-  })
-
-  client.createSimpleField({
-    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 (.)',
-        },
-      },
-    },
-  })
-
-  client.createEnumerableField({
-    displayName: 'Operator',
-    apiId: 'operator',
-    parentApiId: 'ConditionNumber',
-    enumerationApiId: 'DynamicRowConditionNumberOperator',
-    isRequired: true,
-  })
-
-  client.createSimpleField({
-    displayName: 'Value',
-    apiId: 'value',
-    type: SimpleFieldType.Float,
-    parentApiId: 'ConditionNumber',
-    isRequired: true,
-  })
-
-  // ? MODEL
-  client.createModel({
-    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({
-    displayName: 'Internal name',
-    apiId: 'internalName',
-    description: 'Only used for internal reference',
-    type: SimpleFieldType.String,
-    isTitle: true,
-    isRequired: true,
-    isUnique: true,
-    modelApiId: 'DynamicRow',
-  })
-
-  client.createUnionField({
-    displayName: 'Row',
-    apiId: 'row',
-    reverseField: {
-      modelApiIds: ['RowQuote', 'RowLinks', 'RowColumnOne'],
-      apiId: 'dynamicRow',
-      displayName: 'DynamicRows',
-      visibility: VisibilityTypes.Hidden,
-      isList: true,
-    },
-    parentApiId: 'DynamicRow',
-  })
-
-  client.createEnumerableField({
-    displayName: 'Placement',
-    apiId: 'placement',
-    parentApiId: 'DynamicRow',
-    enumerationApiId: 'DynamicRowPlacement',
-    description: 'Where will the row be placed relative to the target',
-    isRequired: true,
-  })
-
-  client.createUnionField({
-    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',
-  })
-
-  client.createComponentUnionField({
-    displayName: 'Conditions (OR)',
-    apiId: 'conditions',
-    parentApiId: 'DynamicRow',
-    description: 'One of these conditions must match',
-    componentApiIds: ['ConditionAnd', 'ConditionText', 'ConditionNumber'],
-    isList: true,
-  })
-
-  return client.run(true)
-}