@shopify/shop-minis-cli 0.0.0-hackathon.20250221160544

package/build/dev-panel/topics.svg

@@ -0,0 +1,3 @@
+<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M2.8498 3.56614C3.05315 2.65106 3.86477 2 4.80217 2H18.7399C19.6383 2 20.4265 2.59907 20.667 3.46471L23 11.8637V20C23 21.1046 22.1046 22 21 22H3C1.89543 22 1 21.1046 1 20V11.8902L2.8498 3.56614ZM18.7399 4L4.80217 4L3.02439 12H20.9621L18.7399 4ZM3 20V14H21V20H3ZM14 16H10V18H14V16ZM6 8.70001L18 8.70001V10.5L6 10.5V8.70001ZM17 5.20001L7 5.20001V7.00001L17 7.00001V5.20001Z" fill="black"/>
+</svg>

package/build/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env -S node --experimental-json-modules --require=suppress-experimental-warnings --no-deprecation
+export {};

package/build/index.js

@@ -0,0 +1,53 @@
+#!/usr/bin/env -S node --experimental-json-modules --require=suppress-experimental-warnings --no-deprecation
+import { Command } from 'commander';
+import { loadCommand as loadCancelSubmissionCommand } from './commands/cancel-submission/index.js';
+import { loadCommand as loadCheckSubmissionCommand } from './commands/check-submission/index.js';
+import { loadCommand as loadCodemodCommand } from './commands/codemod/index.js';
+import { CLI_VERSION } from './commands/config.js';
+import { loadCommand as loadCreateExtensionCommand } from './commands/create-extension/index.js';
+import { loadCommand as loadCreateMiniCommand } from './commands/create-mini/index.js';
+import { loadCommand as loadDevCommand } from './commands/dev/index.js';
+import { command as doctorCommand } from './commands/doctor/index.js';
+import { command as featuresCommand } from './commands/features/index.js';
+import { loadCommand as loadGenerateGraphqlTypesCommand } from './commands/generate-graphql-types/index.js';
+import { loadCommand as loadInfoCommand } from './commands/info/index.js';
+import { loadCommand as loadSetupCommand } from './commands/setup/index.js';
+import { loadCommand as loadSubmitCommand } from './commands/submit/index.js';
+import { loadCommand as loadUpgradeCommand } from './commands/upgrade/index.js';
+import { loadCommand as loadValidateManifestCommand } from './commands/validate-manifest/index.js';
+import { loadCommand as loadAppCommand } from './commands/app/index.js';
+const program = new Command();
+async function loadCommands() {
+    loadCreateMiniCommand(program);
+    await loadDevCommand(program);
+    loadGenerateGraphqlTypesCommand(program);
+    loadSubmitCommand(program);
+    loadCancelSubmissionCommand(program);
+    loadCheckSubmissionCommand(program);
+    loadUpgradeCommand(program);
+    loadValidateManifestCommand(program);
+    loadCodemodCommand(program);
+    loadInfoCommand(program);
+    loadSetupCommand(program);
+    loadCreateExtensionCommand(program);
+    loadAppCommand(program);
+    program.addCommand(doctorCommand);
+    program.addCommand(featuresCommand);
+}
+program
+    .name('shop-minis')
+    .description('CLI for Shop Minis development')
+    .version(CLI_VERSION);
+loadCommands()
+    .then(() => {
+    if (process.argv.length < 3) {
+        // Avoid exiting with code 1 even if program.parse() defaults to showing help content.
+        program.help();
+    }
+    program.parse();
+})
+    .catch(err => {
+    console.log(err);
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,OAAO,EAAC,MAAM,WAAW,CAAA;AAEjC,OAAO,EAAC,WAAW,IAAI,2BAA2B,EAAC,MAAM,uCAAuC,CAAA;AAChG,OAAO,EAAC,WAAW,IAAI,0BAA0B,EAAC,MAAM,sCAAsC,CAAA;AAC9F,OAAO,EAAC,WAAW,IAAI,kBAAkB,EAAC,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAC,WAAW,IAAI,0BAA0B,EAAC,MAAM,sCAAsC,CAAA;AAC9F,OAAO,EAAC,WAAW,IAAI,qBAAqB,EAAC,MAAM,iCAAiC,CAAA;AACpF,OAAO,EAAC,WAAW,IAAI,cAAc,EAAC,MAAM,yBAAyB,CAAA;AACrE,OAAO,EAAC,OAAO,IAAI,aAAa,EAAC,MAAM,4BAA4B,CAAA;AACnE,OAAO,EAAC,OAAO,IAAI,eAAe,EAAC,MAAM,8BAA8B,CAAA;AACvE,OAAO,EAAC,WAAW,IAAI,+BAA+B,EAAC,MAAM,4CAA4C,CAAA;AACzG,OAAO,EAAC,WAAW,IAAI,eAAe,EAAC,MAAM,0BAA0B,CAAA;AACvE,OAAO,EAAC,WAAW,IAAI,gBAAgB,EAAC,MAAM,2BAA2B,CAAA;AACzE,OAAO,EAAC,WAAW,IAAI,iBAAiB,EAAC,MAAM,4BAA4B,CAAA;AAC3E,OAAO,EAAC,WAAW,IAAI,kBAAkB,EAAC,MAAM,6BAA6B,CAAA;AAC7E,OAAO,EAAC,WAAW,IAAI,2BAA2B,EAAC,MAAM,uCAAuC,CAAA;AAChG,OAAO,EAAC,WAAW,IAAI,cAAc,EAAC,MAAM,yBAAyB,CAAA;AAErE,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;AAE7B,KAAK,UAAU,YAAY;IACzB,qBAAqB,CAAC,OAAO,CAAC,CAAA;IAC9B,MAAM,cAAc,CAAC,OAAO,CAAC,CAAA;IAC7B,+BAA+B,CAAC,OAAO,CAAC,CAAA;IACxC,iBAAiB,CAAC,OAAO,CAAC,CAAA;IAC1B,2BAA2B,CAAC,OAAO,CAAC,CAAA;IACpC,0BAA0B,CAAC,OAAO,CAAC,CAAA;IACnC,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAC3B,2BAA2B,CAAC,OAAO,CAAC,CAAA;IACpC,kBAAkB,CAAC,OAAO,CAAC,CAAA;IAC3B,eAAe,CAAC,OAAO,CAAC,CAAA;IACxB,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACzB,0BAA0B,CAAC,OAAO,CAAC,CAAA;IACnC,cAAc,CAAC,OAAO,CAAC,CAAA;IAEvB,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;IACjC,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,CAAA;AACrC,CAAC;AAED,OAAO;KACJ,IAAI,CAAC,YAAY,CAAC;KAClB,WAAW,CAAC,gCAAgC,CAAC;KAC7C,OAAO,CAAC,WAAW,CAAC,CAAA;AAEvB,YAAY,EAAE;KACX,IAAI,CAAC,GAAG,EAAE;IACT,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QAC3B,sFAAsF;QACtF,OAAO,CAAC,IAAI,EAAE,CAAA;KACf;IACD,OAAO,CAAC,KAAK,EAAE,CAAA;AACjB,CAAC,CAAC;KACD,KAAK,CAAC,GAAG,CAAC,EAAE;IACX,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAChB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC,CAAC,CAAA"}

package/build/schemas/manifest.schema.json

@@ -0,0 +1,185 @@
+{
+  "$id": "/manifest.schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "type": "object",
+  "title": "Shop Mini Manifest",
+  "additionalProperties": false,
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the Mini"
+    },
+    "handle": {
+      "type": "string",
+      "description": "A unique identifier for the Mini",
+      "pattern": "^(?:@[a-z0-9-*~][a-z0-9-*._~]*/)?[a-z0-9-~][a-z0-9-._~]*$"
+    },
+    "description": {
+      "type": "string",
+      "description": "The description of the Mini"
+    },
+    "activation_subpath": {
+      "type": "string",
+      "description": "A route on your Mini's Shopify app that will be used to activate (enable entry points) your Mini for the first time. This route path will be appended to the end of the admin URL of the Shopify app. For example, the value 'activate' will correspond to the URL https://admin.shopify.com/store/example-store/apps/my-handle/activate",
+      "pattern": "^(?:[a-z0-9~-]+/)*[a-z0-9~-]+$"
+    },
+    "shopify_apps": {
+      "type": "object",
+      "description": "The Shopify apps associated with the Mini",
+      "properties": {
+        "production": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The Shopify app ID for production"
+        },
+        "development": {
+          "type": "array",
+          "description": "The Shopify app IDs for development",
+          "uniqueItems": true,
+          "items": {"type": "integer", "minimum": 1}
+        }
+      }
+    },
+    "notification_topics": {
+      "type": "array",
+      "description": "Specifies the reason for communication and the scope for messages. An example of a topic could be live streaming related notifications related to a merchant",
+      "items": {
+        "type": "object",
+        "required": ["handle", "description", "scope"],
+        "properties": {
+          "handle": {
+            "type": "string",
+            "description": "Text identifier of the topic"
+          },
+          "description": {
+            "type": "string",
+            "description": "Reason for the communication using the topic"
+          },
+          "scope": {
+            "type": "string",
+            "description": "The scope in which messages are processed for the topic. SHOP means each message will be processed in the scope of a specific merchant, PRODUCT means each message will be processed in the scope of a specific product",
+            "enum": ["SHOP", "PRODUCT"]
+          }
+        }
+      }
+    },
+    "notification_templates": {
+      "type": "array",
+      "description": "Specify the message which will be sent to subscribers when notification is triggered by the mutation",
+      "items": {
+        "type": "object",
+        "required": [
+          "handle",
+          "topic_handle",
+          "title",
+          "body",
+          "cooldown_minutes"
+        ],
+        "properties": {
+          "handle": {
+            "type": "string",
+            "description": "Text identifier of the template"
+          },
+          "topic_handle": {
+            "type": "string",
+            "description": "Reference to a notification topic"
+          },
+          "title": {
+            "type": "string",
+            "description": "Template of notification title, supports interpolation using the Liquid template language"
+          },
+          "body": {
+            "type": "string",
+            "description": "Template of notification body, supports interpolation using the Liquid template language"
+          },
+          "cooldown_minutes": {
+            "type": "number",
+            "description": "How often the template allowes to send the exact same message to the same user, in minutes"
+          }
+        }
+      }
+    },
+    "entry_points": {
+      "type": "array",
+      "description": "A list of entry points that the Mini supports",
+      "items": {
+        "type": "object",
+        "properties": {
+          "location": {
+            "type": "string",
+            "enum": [
+              "PRODUCT_PAGE",
+              "STORE_PAGE",
+              "PRODUCT_PAGE_CONTEXT_MENU",
+              "STORE_PAGE_CONTEXT_MENU",
+              "ORDER_CONFIRMATION_PAGE",
+              "ORDER_MANAGEMENT_PAGE",
+              "HOME_FEED"
+            ]
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "LINK",
+              "DEFAULT_CARD",
+              "IMAGE_COLLECTION",
+              "VIDEO_COLLECTION",
+              "EVENT_CARD_V2",
+              "PRODUCT_OFFER_CARD",
+              "IMAGE_COLLECTION_V2",
+              "VIDEO_COLLECTION_V2"
+            ]
+          }
+        },
+        "allOf": [
+          {
+            "if": {"properties": {"type": {"const": "LINK"}}},
+            "then": {"required": ["location"]}
+          },
+          {
+            "if": {"properties": {"type": {"const": "DEFAULT_CARD"}}},
+            "then": {"required": ["location"]}
+          },
+          {
+            "if": {"properties": {"type": {"const": "IMAGE_COLLECTION"}}},
+            "then": {"required": ["location"]}
+          },
+          {
+            "if": {"properties": {"type": {"const": "IMAGE_COLLECTION_V2"}}},
+            "then": {"required": ["location"]}
+          },
+          {
+            "if": {"properties": {"type": {"const": "VIDEO_COLLECTION"}}},
+            "then": {"required": ["location"]}
+          },
+          {
+            "if": {"properties": {"type": {"const": "VIDEO_COLLECTION_V2"}}},
+            "then": {"required": ["location"]}
+          },
+          {
+            "if": {"properties": {"type": {"const": "EVENT_CARD_V2"}}},
+            "then": {"required": ["location"]}
+          }
+        ]
+      }
+    },
+    "trusted_domains": {
+      "type": "array",
+      "description": "A list of domains that the minis uses to make requests and fetch information. Requests to domains that are not in this list will fail in production.",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      }
+    },
+    "features": {
+      "type": "array",
+      "description": "A list of optional features that your mini app has enabled",
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "enum": ["FULL_BLEED_VIEWER", "STANDALONE"]
+      }
+    }
+  },
+  "required": ["name", "handle"]
+}

package/build/templates-index.d.ts

@@ -0,0 +1,6 @@
+export declare const TEMPLATES: {
+    title: string;
+    description: string;
+    value: string;
+}[];
+export declare const TEMPLATE_VALUES: string[];

package/build/templates-index.js

@@ -0,0 +1,24 @@
+export const TEMPLATES = [
+    {
+        title: 'Getting Started',
+        description: 'A template that generates a fully functioning Shop Mini',
+        value: 'getting_started',
+    },
+    {
+        title: 'Blank',
+        description: 'A blank canvas so you can create from scratch',
+        value: 'blank',
+    },
+    {
+        title: 'Shoppable Videos',
+        description: 'An opinionated starting point for Minis displaying a feed of videos',
+        value: 'shoppable_videos',
+    },
+    {
+        title: 'Shoppable Posts',
+        description: 'An opinionated starting point for Minis displaying a feed of images',
+        value: 'shoppable_posts',
+    },
+];
+export const TEMPLATE_VALUES = TEMPLATES.map(template => template.value);
+//# sourceMappingURL=templates-index.js.map

package/build/templates-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates-index.js","sourceRoot":"","sources":["../src/templates-index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB;QACE,KAAK,EAAE,iBAAiB;QACxB,WAAW,EAAE,yDAAyD;QACtE,KAAK,EAAE,iBAAiB;KACzB;IACD;QACE,KAAK,EAAE,OAAO;QACd,WAAW,EAAE,+CAA+C;QAC5D,KAAK,EAAE,OAAO;KACf;IACD;QACE,KAAK,EAAE,kBAAkB;QACzB,WAAW,EACT,qEAAqE;QACvE,KAAK,EAAE,kBAAkB;KAC1B;IACD;QACE,KAAK,EAAE,iBAAiB;QACxB,WAAW,EACT,qEAAqE;QACvE,KAAK,EAAE,iBAAiB;KACzB;CACF,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAG,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA"}

package/build/utils/archive.d.ts

@@ -0,0 +1,30 @@
+import archiver from 'archiver';
+interface ZipOptions {
+    /**
+     * The absolute path to the directory to be zipped.
+     */
+    inputDirectory: string;
+    /**
+     * The absolute path to the output zip file.
+     */
+    outputArchivePath: string;
+    /**
+     * Pattern to match when adding files to archive, uses glob expressions.
+     */
+    matchFilePattern?: string;
+    /**
+     * Patterns to ignore adding files to archive, uses glob expressions.
+     */
+    ignore?: string[];
+}
+/**
+ * Creates a tar.gz
+ *
+ * This is a copy of `zip` [from cli-kit](https://github.com/Shopify/cli/blob/0aa5eb4fe34519e10297977e640dc521f9ab1676/packages/cli-kit/src/public/node/archiver.ts#L31)
+ *
+ * Our version defaults to tar.gz, theirs is hard-coded to zip
+ *
+ * @param options - ZipOptions.
+ */
+export declare function zip(options: ZipOptions, format?: archiver.Format): Promise<void>;
+export {};

package/build/utils/archive.js

@@ -0,0 +1,38 @@
+import { createWriteStream } from 'node:fs';
+import archiver from 'archiver';
+import { relativePath } from '@shopify/cli-kit/node/path';
+import { glob } from '@shopify/cli-kit/node/fs';
+import { outputDebug, outputContent, outputToken, } from '@shopify/cli-kit/node/output';
+/**
+ * Creates a tar.gz
+ *
+ * This is a copy of `zip` [from cli-kit](https://github.com/Shopify/cli/blob/0aa5eb4fe34519e10297977e640dc521f9ab1676/packages/cli-kit/src/public/node/archiver.ts#L31)
+ *
+ * Our version defaults to tar.gz, theirs is hard-coded to zip
+ *
+ * @param options - ZipOptions.
+ */
+export async function zip(options, format = 'tar') {
+    const { inputDirectory, outputArchivePath, matchFilePattern = '**/*', ignore, } = options;
+    outputDebug(outputContent `${format === 'zip' ? 'Zipping' : 'Creating tar.gz of'} ${outputToken.path(inputDirectory)} into ${outputToken.path(outputArchivePath)}`);
+    const pathsToZip = await glob(matchFilePattern, {
+        cwd: inputDirectory,
+        absolute: true,
+        dot: true,
+        followSymbolicLinks: false,
+        ignore,
+    });
+    return new Promise((resolve, reject) => {
+        const archive = archiver(format, { gzip: true });
+        const output = createWriteStream(outputArchivePath);
+        output.on('close', () => resolve());
+        archive.on('error', error => reject(error));
+        archive.pipe(output);
+        for (const filePath of pathsToZip) {
+            const fileRelativePath = relativePath(inputDirectory, filePath);
+            archive.file(filePath, { name: fileRelativePath });
+        }
+        archive.finalize();
+    });
+}
+//# sourceMappingURL=archive.js.map

package/build/utils/archive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"archive.js","sourceRoot":"","sources":["../../src/utils/archive.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,SAAS,CAAA;AAEzC,OAAO,QAAQ,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAC,YAAY,EAAC,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAC,IAAI,EAAC,MAAM,0BAA0B,CAAA;AAC7C,OAAO,EACL,WAAW,EACX,aAAa,EACb,WAAW,GACZ,MAAM,8BAA8B,CAAA;AAwBrC;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CACvB,OAAmB,EACnB,SAA0B,KAAK;IAE/B,MAAM,EACJ,cAAc,EACd,iBAAiB,EACjB,gBAAgB,GAAG,MAAM,EACzB,MAAM,GACP,GAAG,OAAO,CAAA;IAEX,WAAW,CACT,aAAa,CAAA,GACX,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,oBACjC,IAAI,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,WAAW,CAAC,IAAI,CAC3D,iBAAiB,CAClB,EAAE,CACJ,CAAA;IACD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE;QAC9C,GAAG,EAAE,cAAc;QACnB,QAAQ,EAAE,IAAI;QACd,GAAG,EAAE,IAAI;QACT,mBAAmB,EAAE,KAAK;QAC1B,MAAM;KACP,CAAC,CAAA;IAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAA;QAE9C,MAAM,MAAM,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,CAAA;QACnD,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;QACnC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;QAC3C,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAEpB,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE;YACjC,MAAM,gBAAgB,GAAG,YAAY,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;YAC/D,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,CAAC,CAAA;SACjD;QAED,OAAO,CAAC,QAAQ,EAAE,CAAA;IACpB,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/build/utils/codemod.d.ts

@@ -0,0 +1,86 @@
+import jscodeshift from 'jscodeshift';
+export type Root = ReturnType<typeof jscodeshift>;
+export declare const j: jscodeshift.JSCodeshift;
+/**
+ * Find the first import declaration of a module
+ *
+ * Returns an object containing:
+ * - `importDeclaration`: This is the whole import node. This is null if no import is found
+ * - `specifier`: This is the specific import specifier node that matches the name/alias. Also null if not found
+ *
+ * If `importedAsName` is not provided, it will look for an import like:
+ * ```
+ * import {importedName} from 'importPath'
+ * ```
+ *
+ * If `importedAsName` is provided, it will look for an import like:
+ * ```
+ * import {importedName as importedAsName} from 'importPath'
+ * ```
+ */
+export declare const findImportOf: (root: import("jscodeshift/src/Collection.js").Collection<any>, importPath: string, importedName: string, importedAsName?: string) => {
+    specifier: import("ast-types").namedTypes.ImportSpecifier | import("ast-types").namedTypes.ImportDefaultSpecifier | import("ast-types").namedTypes.ImportNamespaceSpecifier | null;
+    importDeclaration: import("ast-types").namedTypes.ImportDeclaration;
+};
+/**
+ * Ensure that an import of a module is present in the file
+ *
+ * If the import is not present, it will be added below other imports or
+ * to the top of the file if no other imports are found
+ *
+ * Returns the specifier and import declaration nodes that were found, edited or created
+ */
+export declare const ensureImportOf: (root: import("jscodeshift/src/Collection.js").Collection<any>, importPath: string, importedName: string, importedAsName?: string) => {
+    specifier: import("ast-types").namedTypes.ImportSpecifier | import("ast-types").namedTypes.ImportDefaultSpecifier | import("ast-types").namedTypes.ImportNamespaceSpecifier;
+    importDeclaration: import("ast-types").namedTypes.ImportDeclaration;
+};
+/**
+ * Find an object expression by its name like
+ *
+ * ```
+ * const objName = {
+ *   key: 'value',
+ * }
+ * ```
+ *
+ * Returns the object expression node if found, otherwise null
+ *
+ * If multiple are found, the first one is returned
+ */
+export declare const findObjectExpression: (root: import("jscodeshift/src/Collection.js").Collection<any>, objName: string) => import("ast-types").namedTypes.ObjectExpression | null;
+/**
+ * Find an object's property by it's key
+ *
+ * Returns the property node that was found or null
+ */
+export declare const findObjectProperty: ({ obj, key, }: {
+    obj: jscodeshift.ObjectExpression;
+    key: string;
+}) => jscodeshift.Property | null;
+/**
+ * Return all the objects keys
+ *
+ * Only returns keys of types Identifier and StringLiteral eg
+ *
+ * const foo = { 'cool-key': 'value', otherKey: 'ok' }
+ */
+export declare const objectKeys: ({ obj, }: {
+    obj: jscodeshift.ObjectExpression;
+}) => string[];
+/**
+ * Ensure that an object has a property with a specific key
+ *
+ * If the property is not present, it will be added to the object
+ *
+ * If `defaultValue` is provided, the property will be set to that value if it does not exist
+ *
+ * If `overwrite` is also true, the property will be replaced with the `defaultValue`
+ *
+ * Returns the property node that was found or created
+ */
+export declare const ensureObjectProperty: ({ obj, key, defaultValue, overwrite, }: {
+    obj: jscodeshift.ObjectExpression;
+    key: string;
+    defaultValue: jscodeshift.Property['value'];
+    overwrite?: boolean | undefined;
+}) => import("ast-types").namedTypes.Property;

package/build/utils/codemod.js

@@ -0,0 +1,161 @@
+import jscodeshift from 'jscodeshift';
+export const j = jscodeshift.withParser('tsx');
+/**
+ * Find the first import declaration of a module
+ *
+ * Returns an object containing:
+ * - `importDeclaration`: This is the whole import node. This is null if no import is found
+ * - `specifier`: This is the specific import specifier node that matches the name/alias. Also null if not found
+ *
+ * If `importedAsName` is not provided, it will look for an import like:
+ * ```
+ * import {importedName} from 'importPath'
+ * ```
+ *
+ * If `importedAsName` is provided, it will look for an import like:
+ * ```
+ * import {importedName as importedAsName} from 'importPath'
+ * ```
+ */
+export const findImportOf = (root, importPath, importedName, importedAsName) => {
+    const matchedImportDeclaration = root
+        .find(j.ImportDeclaration, {
+        source: { value: importPath },
+    })
+        .nodes()[0] ?? null;
+    const matchedSpecifier = matchedImportDeclaration?.specifiers?.filter(specifier => {
+        if (specifier.type !== 'ImportSpecifier')
+            return false;
+        return importedAsName
+            ? specifier.imported.name === importedName &&
+                specifier?.local?.name === importedAsName
+            : specifier.imported.name === importedName;
+    })[0] ?? null;
+    return {
+        specifier: matchedSpecifier,
+        importDeclaration: matchedImportDeclaration,
+    };
+};
+/**
+ * Ensure that an import of a module is present in the file
+ *
+ * If the import is not present, it will be added below other imports or
+ * to the top of the file if no other imports are found
+ *
+ * Returns the specifier and import declaration nodes that were found, edited or created
+ */
+export const ensureImportOf = (root, importPath, importedName, importedAsName) => {
+    let { importDeclaration, specifier } = findImportOf(root, importPath, importedName, importedAsName);
+    if (!specifier) {
+        specifier = importedAsName
+            ? j.importSpecifier(j.identifier(importedName), j.identifier(importedAsName))
+            : j.importSpecifier(j.identifier(importedName));
+        if (!importDeclaration) {
+            importDeclaration = j.importDeclaration([], j.literal(importPath));
+            const existingImports = root.find(j.ImportDeclaration);
+            // Put it after the existing imports if possible
+            if (existingImports.length > 0) {
+                existingImports
+                    .at(existingImports.length - 1)
+                    .insertAfter(importDeclaration);
+            }
+            else {
+                root.get().node.program.body.unshift(importDeclaration);
+            }
+        }
+        importDeclaration?.specifiers?.push(specifier);
+    }
+    return { specifier, importDeclaration };
+};
+/**
+ * Find an object expression by its name like
+ *
+ * ```
+ * const objName = {
+ *   key: 'value',
+ * }
+ * ```
+ *
+ * Returns the object expression node if found, otherwise null
+ *
+ * If multiple are found, the first one is returned
+ */
+export const findObjectExpression = (root, objName) => {
+    const result = root
+        .find(j.VariableDeclarator, {
+        id: { type: 'Identifier', name: objName },
+        init: { type: 'ObjectExpression' },
+    })
+        .nodes()[0];
+    return result && result?.init?.type === 'ObjectExpression'
+        ? result.init
+        : null;
+};
+/**
+ * Find an object's property by it's key
+ *
+ * Returns the property node that was found or null
+ */
+export const findObjectProperty = ({ obj, key, }) => {
+    const properties = obj.properties;
+    return (properties.find(prop => {
+        if (prop.type !== 'ObjectProperty')
+            return false;
+        if (prop.key.type === 'Identifier' && prop.key.name === key)
+            return true;
+        if (prop.key.type === 'StringLiteral' && prop.key.value === key)
+            return true;
+        return false;
+    }) ?? null);
+};
+/**
+ * Return all the objects keys
+ *
+ * Only returns keys of types Identifier and StringLiteral eg
+ *
+ * const foo = { 'cool-key': 'value', otherKey: 'ok' }
+ */
+export const objectKeys = ({ obj, }) => {
+    const properties = obj.properties;
+    return properties
+        .map(prop => {
+        if (prop.type !== 'ObjectProperty')
+            return null;
+        if (prop.key.type === 'Identifier')
+            return prop.key.name;
+        if (prop.key.type === 'StringLiteral')
+            return prop.key.value;
+        return null;
+    })
+        .filter(value => typeof value === 'string');
+};
+/**
+ * Ensure that an object has a property with a specific key
+ *
+ * If the property is not present, it will be added to the object
+ *
+ * If `defaultValue` is provided, the property will be set to that value if it does not exist
+ *
+ * If `overwrite` is also true, the property will be replaced with the `defaultValue`
+ *
+ * Returns the property node that was found or created
+ */
+export const ensureObjectProperty = ({ obj, key, defaultValue, overwrite = false, }) => {
+    const properties = obj.properties;
+    let targetProperty = findObjectProperty({ obj, key });
+    if (targetProperty) {
+        if (overwrite) {
+            targetProperty.value = defaultValue;
+        }
+    }
+    else {
+        const safeKeyName = /^[a-zA-Z_$][a-zA-Z_$0-9]*$/;
+        const identifier = safeKeyName.test(key)
+            ? j.identifier(key)
+            : j.stringLiteral(key);
+        targetProperty = j.property('init', identifier, defaultValue);
+        properties.push(targetProperty);
+    }
+    return targetProperty;
+};
+//# sourceMappingURL=codemod.js.map

package/build/utils/codemod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codemod.js","sourceRoot":"","sources":["../../src/utils/codemod.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,aAAa,CAAA;AAGrC,MAAM,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;AAE9C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,IAAU,EACV,UAAkB,EAClB,YAAoB,EACpB,cAAuB,EACvB,EAAE;IACF,MAAM,wBAAwB,GAC5B,IAAI;SACD,IAAI,CAAC,CAAC,CAAC,iBAAiB,EAAE;QACzB,MAAM,EAAE,EAAC,KAAK,EAAE,UAAU,EAAC;KAC5B,CAAC;SACD,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;IAEvB,MAAM,gBAAgB,GACpB,wBAAwB,EAAE,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE;QACvD,IAAI,SAAS,CAAC,IAAI,KAAK,iBAAiB;YAAE,OAAO,KAAK,CAAA;QAEtD,OAAO,cAAc;YACnB,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY;gBACtC,SAAS,EAAE,KAAK,EAAE,IAAI,KAAK,cAAc;YAC7C,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY,CAAA;IAC9C,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;IAEf,OAAO;QACL,SAAS,EAAE,gBAAgB;QAC3B,iBAAiB,EAAE,wBAAwB;KAC5C,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,IAAU,EACV,UAAkB,EAClB,YAAoB,EACpB,cAAuB,EACvB,EAAE;IACF,IAAI,EAAC,iBAAiB,EAAE,SAAS,EAAC,GAAG,YAAY,CAC/C,IAAI,EACJ,UAAU,EACV,YAAY,EACZ,cAAc,CACf,CAAA;IAED,IAAI,CAAC,SAAS,EAAE;QACd,SAAS,GAAG,cAAc;YACxB,CAAC,CAAC,CAAC,CAAC,eAAe,CACf,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,EAC1B,CAAC,CAAC,UAAU,CAAC,cAAc,CAAC,CAC7B;YACH,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAA;QAEjD,IAAI,CAAC,iBAAiB,EAAE;YACtB,iBAAiB,GAAG,CAAC,CAAC,iBAAiB,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAA;YAElE,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAA;YAEtD,gDAAgD;YAChD,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC9B,eAAe;qBACZ,EAAE,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC;qBAC9B,WAAW,CAAC,iBAAiB,CAAC,CAAA;aAClC;iBAAM;gBACL,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;aACxD;SACF;QAED,iBAAiB,EAAE,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;KAC/C;IAED,OAAO,EAAC,SAAS,EAAE,iBAAiB,EAAC,CAAA;AACvC,CAAC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,IAAU,EAAE,OAAe,EAAE,EAAE;IAClE,MAAM,MAAM,GAAG,IAAI;SAChB,IAAI,CAAC,CAAC,CAAC,kBAAkB,EAAE;QAC1B,EAAE,EAAE,EAAC,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAC;QACvC,IAAI,EAAE,EAAC,IAAI,EAAE,kBAAkB,EAAC;KACjC,CAAC;SACD,KAAK,EAAE,CAAC,CAAC,CAAC,CAAA;IAEb,OAAO,MAAM,IAAI,MAAM,EAAE,IAAI,EAAE,IAAI,KAAK,kBAAkB;QACxD,CAAC,CAAC,MAAM,CAAC,IAAI;QACb,CAAC,CAAC,IAAI,CAAA;AACV,CAAC,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EACjC,GAAG,EACH,GAAG,GAIJ,EAA+B,EAAE;IAChC,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAA;IAEjC,OAAO,CACJ,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACtB,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB;YAAE,OAAO,KAAK,CAAA;QAChD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,GAAG;YAAE,OAAO,IAAI,CAAA;QACxE,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,eAAe,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,GAAG;YAC7D,OAAO,IAAI,CAAA;QAEb,OAAO,KAAK,CAAA;IACd,CAAC,CAA0B,IAAI,IAAI,CACpC,CAAA;AACH,CAAC,CAAA;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,EACzB,GAAG,GAGJ,EAAY,EAAE;IACb,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAA;IAEjC,OAAO,UAAU;SACd,GAAG,CAAC,IAAI,CAAC,EAAE;QACV,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB;YAAE,OAAO,IAAI,CAAA;QAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAA;QACxD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,eAAe;YAAE,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAA;QAE5D,OAAO,IAAI,CAAA;IACb,CAAC,CAAC;SACD,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAa,CAAA;AAC3D,CAAC,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EACnC,GAAG,EACH,GAAG,EACH,YAAY,EACZ,SAAS,GAAG,KAAK,GAMlB,EAAE,EAAE;IACH,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAA;IAEjC,IAAI,cAAc,GAAG,kBAAkB,CAAC,EAAC,GAAG,EAAE,GAAG,EAAC,CAAC,CAAA;IAEnD,IAAI,cAAc,EAAE;QAClB,IAAI,SAAS,EAAE;YACb,cAAc,CAAC,KAAK,GAAG,YAAY,CAAA;SACpC;KACF;SAAM;QACL,MAAM,WAAW,GAAG,4BAA4B,CAAA;QAChD,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC;YACtC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC;YACnB,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAA;QAExB,cAAc,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,EAAE,YAAY,CAAC,CAAA;QAE7D,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;KAChC;IAED,OAAO,cAAc,CAAA;AACvB,CAAC,CAAA"}

package/build/utils/common-tasks.d.ts

@@ -0,0 +1 @@
+export declare function assertNetworkAndAuth(): Promise<void>;