@graphcommerce/hygraph-cli 9.0.4-canary.0 → 9.0.4-canary.10

package/package.json

@@ -2,17 +2,22 @@
   "name": "@graphcommerce/hygraph-cli",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "9.0.4-canary.0",
+  "version": "9.0.4-canary.10",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./dist/index.js"
+    }
+  },
   "scripts": {
-    "dev": "tsc --preserveWatchOutput --watch",
-    "build": "tsc",
-    "prepack": "tsc"
+    "dev": "pkgroll --clean-dist --watch",
+    "build": "pkgroll --clean-dist",
+    "prepack": "pkgroll --clean-dist"
   },
-  "type": "commonjs",
-  "main": "dist/index.js",
-  "types": "src/index.ts",
   "dependencies": {
     "@hygraph/management-sdk": "1.2.5",
+    "@types/prompts": "^2.4.9",
     "@whatwg-node/fetch": "^0.10.1",
     "graphql": "^16.10.0",
     "graphql-tag": "^2.12.6",
@@ -20,14 +25,14 @@
   },
   "peerDependencies": {
     "@apollo/client": "*",
-    "@graphcommerce/eslint-config-pwa": "^9.0.4-canary.0",
-    "@graphcommerce/next-config": "^9.0.4-canary.0",
-    "@graphcommerce/prettier-config-pwa": "^9.0.4-canary.0",
-    "@graphcommerce/typescript-config-pwa": "^9.0.4-canary.0",
+    "@graphcommerce/eslint-config-pwa": "^9.0.4-canary.10",
+    "@graphcommerce/next-config": "^9.0.4-canary.10",
+    "@graphcommerce/prettier-config-pwa": "^9.0.4-canary.10",
+    "@graphcommerce/typescript-config-pwa": "^9.0.4-canary.10",
     "dotenv": "^16.1.4"
   },
   "devDependencies": {
-    "@types/prompts": "^2.4.9",
+    "pkgroll": "^2.5.1",
     "typescript": "5.7.2"
   },
   "sideEffects": false,

package/src/migrationActionFactory.ts

@@ -136,20 +136,20 @@ export function migrationActionFactory(schema: Schema, client: Client) {
    * 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.
+   * 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.
+   * 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 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
+   * 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'.
    */
   const migrationAction = (
@@ -161,8 +161,8 @@ export function migrationActionFactory(schema: Schema, client: Client) {
     parentType?: 'model' | 'component' | 'enumeration',
   ) => {
     /**
-     * Check if the entity already exists.
-     * If an update or deletion is made, it does not matter if the entity already exists
+     * Check if the entity already exists. If an update or deletion is made, it does not matter if
+     * the entity already exists
      */
     const alreadyExists = () => {
       if (action !== 'create') {

package/tsconfig.json

@@ -11,7 +11,7 @@
     "noLib": false,
     "strict": true,
     "resolveJsonModule": true,
-    "moduleResolution": "Node",
-    "module": "CommonJS"
+    "moduleResolution": "Bundler",
+    "module": "ESNext"
   }
 }

package/dist/UpsertClient.js

@@ -1,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpsertClient = void 0;
-const management_sdk_1 = require("@hygraph/management-sdk");
-class UpsertClient extends management_sdk_1.Client {
-    schema;
-    constructor(params, schema) {
-        super(params);
-        this.schema = schema;
-    }
-    /** @public */
-    upsertModel(data) {
-        const exists = this.schema.models.some((m) => m.apiId === data.apiId);
-        return exists ? this.createModel(data) : this.updateModel(data);
-    }
-    /** @public */
-    upsertComponent(data) {
-        const exists = this.schema.models.some((m) => m.apiId === data.apiId);
-        return exists ? this.createComponent(data) : this.updateComponent(data);
-    }
-    /** @public */
-    upsertSimpleField(data) {
-        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)
-    // }
-    /** @public */
-    upsertRelationalField(data) {
-        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);
-    }
-    /** @public */
-    upsertUnionField(data) {
-        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);
-    }
-    /** @public */
-    upsertComponentField(data) {
-        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);
-    }
-    /** @public */
-    upsertComponentUnionField(data) {
-        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);
-    }
-    /** @public */
-    upsertEnumeration(data) {
-        const exists = this.schema.enumerations.some((e) => e.apiId === data.apiId);
-        return exists ? this.createEnumeration(data) : this.updateEnumeration(data);
-    }
-    /** @public */
-    upsertEnumerableField(data) {
-        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);
-    }
-    /** @public */
-    upsertStage(data) {
-        const exists = this.schema.stages.some((m) => m.apiId === data.apiId);
-        return exists ? this.createStage(data) : this.updateStage(data);
-    }
-    /** @public */
-    upsertLocale(data) {
-        const exists = this.schema.locales.some((m) => m.apiId === data.apiId);
-        return exists ? this.createLocale(data) : this.updateLocale(data);
-    }
-}
-exports.UpsertClient = UpsertClient;

package/dist/migrateHygraphCli.js

@@ -1,88 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.migrateHygraphCli = migrateHygraphCli;
-const fs_1 = __importDefault(require("fs"));
-const next_config_1 = require("@graphcommerce/next-config");
-const dotenv_1 = __importDefault(require("dotenv"));
-const prompts_1 = __importDefault(require("prompts"));
-const migrations_1 = require("./migrations");
-const readSchema_1 = require("./readSchema");
-const UpsertClient_1 = require("./UpsertClient");
-const getConfig_1 = require("./utils/getConfig");
-const getEndpointUrl_1 = require("./utils/getEndpointUrl");
-const getManagementClient_1 = require("./utils/getManagementClient");
-const graphCommerceLog_1 = require("./utils/graphCommerceLog");
-dotenv_1.default.config();
-async function migrateHygraphCli() {
-    const hygraphConfig = (0, getConfig_1.getConfig)((0, next_config_1.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_1.default.readFileSync('package.json', 'utf8');
-    const packageData = JSON.parse(packageJson);
-    const graphcommerceVersion = packageData.dependencies['@graphcommerce/next-ui'];
-    (0, graphCommerceLog_1.graphcommerceLog)(`Graphcommerce version: ${graphcommerceVersion}`, 'info');
-    const mangementClient = (0, getManagementClient_1.getManagementClient)(hygraphConfig);
-    // Extract the currently existing models, components and enumerations from the Hygraph schema.
-    const schemaViewer = await (0, readSchema_1.readSchema)(mangementClient, hygraphConfig.projectId);
-    const schema = schemaViewer.viewer.project.environment.contentModel;
-    // A list of possible migrations
-    const possibleMigrations = Object.entries(migrations_1.availableMigrations);
-    // Here we setup the list we ask the user to choose from
-    const selectMigrationInput = {
-        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 {
-        (0, graphCommerceLog_1.graphcommerceLog)('Available migrations: ', 'info');
-        const selectMigrationOutput = await (0, prompts_1.default)(selectMigrationInput);
-        let { migration, name } = selectMigrationOutput.selectedMigration;
-        (0, graphCommerceLog_1.graphcommerceLog)(`You have selected the ${selectMigrationOutput.selectedMigration.name} migration`, 'info');
-        try {
-            const { endpoint, migrations } = await (0, getEndpointUrl_1.getEnvironment)(mangementClient, hygraphConfig);
-            const migrationExists = migrations.find((m) => m.name?.startsWith(name) && m.status === 'SUCCESS');
-            if (migrationExists) {
-                if (!process.argv.includes('--force')) {
-                    (0, graphCommerceLog_1.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 {
-                    (0, graphCommerceLog_1.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_1.UpsertClient({ authToken: hygraphConfig.authToken, endpoint, name }, schema));
-            (0, graphCommerceLog_1.graphcommerceLog)(`Migration result: ${JSON.stringify(result)}`, 'info');
-            if (!result) {
-                (0, graphCommerceLog_1.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') {
-                (0, graphCommerceLog_1.graphcommerceLog)(`Migration not successful: ${result.status} ${name}:\n${result.errors}`);
-                process.exit(1);
-            }
-            (0, graphCommerceLog_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;
-                (0, graphCommerceLog_1.graphcommerceLog)(`${msg}`, 'error');
-            }
-        }
-    }
-    catch (error) {
-        (0, graphCommerceLog_1.graphcommerceLog)(`An error occurred: ${error}`, 'error');
-    }
-}

package/dist/migrationActionFactory.js

@@ -1,133 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.migrationActionFactory = migrationActionFactory;
-const dotenv_1 = __importDefault(require("dotenv"));
-const graphCommerceLog_1 = require("./utils/graphCommerceLog");
-dotenv_1.default.config();
-function migrationActionFactory(schema, client) {
-    /**
-     * This constant is used to assign the right action of the management SDK to the migratioAction
-     * function
-     */
-    const actionMap = client
-        ? {
-            create: {
-                model: (innerprops) => client.createModel(innerprops),
-                component: (innerprops) => client.createComponent(innerprops),
-                enumeration: (innerprops) => client.createEnumeration(innerprops),
-                simpleField: (innerprops) => client.createSimpleField(innerprops),
-                enumerableField: (innerprops) => client.createEnumerableField(innerprops),
-                componentField: (innerprops) => client.createComponentField(innerprops),
-                relationalField: (innerprops) => client.createRelationalField(innerprops),
-                unionField: (innerprops) => client.createUnionField(innerprops),
-                componentUnionField: (innerprops) => client.createComponentUnionField(innerprops),
-            },
-            update: {
-                model: (innerprops) => client.updateModel(innerprops),
-                component: (innerprops) => client.updateComponent(innerprops),
-                enumeration: (innerprops) => client.updateEnumeration(innerprops),
-                simpleField: (innerprops) => client.updateSimpleField(innerprops),
-                enumerableField: (innerprops) => client.updateEnumerableField(innerprops),
-                componentField: (innerprops) => client.updateComponentField(innerprops),
-                relationalField: (innerprops) => client.updateRelationalField(innerprops),
-                unionField: (innerprops) => client.updateUnionField(innerprops),
-                componentUnionField: (innerprops) => client.updateComponentUnionField(innerprops),
-            },
-            delete: {
-                model: (innerprops) => client.deleteModel(innerprops),
-                component: (innerprops) => client.deleteComponent(innerprops),
-                enumeration: (innerprops) => client.deleteEnumeration(innerprops),
-                simpleField: (innerprops) => client.deleteField(innerprops),
-                enumerableField: (innerprops) => client.deleteField(innerprops),
-                componentField: (innerprops) => client.deleteField(innerprops),
-                relationalField: (innerprops) => client.deleteField(innerprops),
-                unionField: (innerprops) => client.deleteField(innerprops),
-                componentUnionField: (innerprops) => 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'.
-     */
-    const migrationAction = (_schema, type, action, props, parentApiId, parentType) => {
-        /**
-         * Check if the entity already exists.
-         * If an update or deletion is made, it does not matter if the entity already exists
-         */
-        const alreadyExists = () => {
-            if (action !== 'create') {
-                return false;
-            }
-            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;
-                    }
-                    return parent?.fields.some((field) => field.apiId === props.apiId);
-                }
-                default: {
-                    return false;
-                }
-            }
-        };
-        const actionFunc = actionMap && actionMap[action] && actionMap[action][type];
-        if (!alreadyExists()) {
-            if (actionFunc) {
-                (0, graphCommerceLog_1.graphcommerceLog)(`${(0, graphCommerceLog_1.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 {
-                (0, graphCommerceLog_1.graphcommerceLog)(`Action ${action} is not supported for ${type}`, 'error');
-            }
-        }
-        else {
-            (0, graphCommerceLog_1.graphcommerceLog)(`${(0, graphCommerceLog_1.capitalize)(type)} with apiId ${props.apiId} on ${parentApiId} already exists`, 'warning');
-        }
-    };
-    return {
-        migrationAction,
-    };
-}

package/dist/migrations/graphcommerce5to6.js

@@ -1,98 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.graphcommerce5to6 = void 0;
-const management_sdk_1 = require("@hygraph/management-sdk");
-const migrationActionFactory_1 = require("../migrationActionFactory");
-const graphcommerce5to6 = async (schema, client) => {
-    const { migrationAction } = (0, migrationActionFactory_1.migrationActionFactory)(schema, client);
-    // ? 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: management_sdk_1.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: management_sdk_1.SimpleFieldType.String,
-        isRequired: true,
-        modelApiId: 'RowLinks',
-        isLocalized: true,
-    }, 'RowLinks', 'model');
-    migrationAction(schema, 'simpleField', 'create', {
-        displayName: 'Copy',
-        apiId: 'rowLinksCopy',
-        type: management_sdk_1.SimpleFieldType.Richtext,
-        isLocalized: true,
-        modelApiId: 'RowLinks',
-    }, 'RowLinks', 'model');
-    migrationAction(schema, 'relationalField', 'create', {
-        displayName: 'Links',
-        apiId: 'pageLinks',
-        modelApiId: 'RowLinks',
-        type: management_sdk_1.RelationalFieldType.Relation,
-        reverseField: {
-            apiId: 'rowLinks',
-            modelApiId: 'PageLink',
-            displayName: 'RowLinks',
-            visibility: management_sdk_1.VisibilityTypes.Hidden,
-            isList: true,
-        },
-        visibility: management_sdk_1.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);
-};
-exports.graphcommerce5to6 = graphcommerce5to6;