@shopify/cli-kit 1.1.1 → 2.0.3

package/dist/index.d.ts

@@ -10,8 +10,11 @@ import { platform } from 'node:process';
 import { z } from 'zod';
 import Conf from 'conf';
 import nodeFetch, { RequestInfo, RequestInit } from 'node-fetch';
+import FormData from 'form-data';
 import semver$1 from 'semver/classes/semver';
 import coerce from 'semver/functions/coerce';
+import * as _oclif_core_lib_interfaces from '@oclif/core/lib/interfaces';
+import { Plugin } from '@oclif/core/lib/interfaces';
 
 function _mergeNamespaces(n, m) {
   m.forEach(function (e) {
@@ -29,7 +32,7 @@ function _mergeNamespaces(n, m) {
 }
 
 interface Question {
-    type: 'input' | 'select';
+    type: 'input' | 'select' | 'autocomplete';
     name: string;
     message: string;
     validate?: (value: string) => string | boolean;
@@ -63,7 +66,7 @@ declare namespace ui {
  * A fatal error represents an error shouldn't be rescued and that causes the execution to terminate.
  * There shouldn't be code that catches fatal errors.
  */
-declare class Fatal extends Error {
+declare abstract class Fatal extends Error {
     tryMessage: string | null;
     constructor(message: string, tryMessage?: string | null);
 }
@@ -161,7 +164,7 @@ declare namespace system {
   };
 }
 
-declare function create$1(templateContent: string): (data: object) => Promise<string>;
+declare function create(templateContent: string): (data: object) => Promise<string>;
 /**
  * Given a directory, it traverses the files and directories recursively
  * and replaces variables in directory and file names, and files' content
@@ -173,10 +176,11 @@ declare function create$1(templateContent: string): (data: object) => Promise<st
  */
 declare function recursiveDirectoryCopy(from: string, to: string, data: any): Promise<void>;
 
+declare const template_create: typeof create;
 declare const template_recursiveDirectoryCopy: typeof recursiveDirectoryCopy;
 declare namespace template {
   export {
-    create$1 as create,
+    template_create as create,
     template_recursiveDirectoryCopy as recursiveDirectoryCopy,
   };
 }
@@ -216,8 +220,19 @@ declare namespace string {
   };
 }
 
+/**
+ * Given an absolute filesystem path, it makes it relative to
+ * the current working directory. This is useful when logging paths
+ * to allow the users to click on the file and let the OS open it
+ * in the editor of choice.
+ * @param path {string} Path to relativize
+ * @returns {string} Relativized path.
+ */
+declare function relativize(path: string): string;
+
 var path = /*#__PURE__*/_mergeNamespaces({
   __proto__: null,
+  relativize: relativize,
   findUp: findUp,
   glob: fastGlob
 }, [pathe]);
@@ -313,11 +328,17 @@ declare namespace file {
 }
 
 declare const factory: simple_git.SimpleGitFactory;
+declare function downloadRepository({ repoUrl, destination }: {
+    repoUrl: string;
+    destination: string;
+}): Promise<void>;
 
 declare const git_factory: typeof factory;
+declare const git_downloadRepository: typeof downloadRepository;
 declare namespace git {
   export {
     git_factory as factory,
+    git_downloadRepository as downloadRepository,
   };
 }
 
@@ -449,7 +470,7 @@ interface OutputProcess {
      * to send standard output and error data that gets formatted with the
      * right prefix.
      */
-    action: (stdout: Writable, stderr: Writable) => Promise<void>;
+    action: (stdout: Writable, stderr: Writable, signal: AbortSignal) => Promise<void>;
 }
 /**
  * Use this function when you have multiple concurrent processes that send data events
@@ -473,6 +494,7 @@ declare const output_warn: typeof warn;
 declare const output_newline: typeof newline;
 declare const output_error: typeof error;
 declare const output_stringifyMessage: typeof stringifyMessage;
+type output_OutputProcess = OutputProcess;
 declare const output_concurrent: typeof concurrent;
 declare const output_shouldDisplayColors: typeof shouldDisplayColors;
 declare namespace output {
@@ -490,43 +512,98 @@ declare namespace output {
     output_newline as newline,
     output_error as error,
     output_stringifyMessage as stringifyMessage,
+    output_OutputProcess as OutputProcess,
     output_concurrent as concurrent,
     output_shouldDisplayColors as shouldDisplayColors,
   };
 }
 
-declare enum DependencyManager {
-    Npm = "npm",
-    Yarn = "yarn",
-    Pnpm = "pnpm"
-}
-declare const dependencyManager: string[];
+declare const dependencyManager: readonly ["yarn", "npm", "pnpm"];
+declare type DependencyManager = typeof dependencyManager[number];
+declare const PackageJsonNotFoundError: (directory: string) => Bug;
 /**
  * Returns the dependency manager used to run the create workflow.
  * @param env {Object} The environment variables of the process in which the CLI runs.
  * @returns The dependency manager
  */
 declare function dependencyManagerUsedForCreating(env?: NodeJS.ProcessEnv): DependencyManager;
+interface InstallNPMDependenciesRecursivelyOptions {
+    /**
+     * The dependency manager to use to install the dependencies.
+     */
+    dependencyManager: DependencyManager;
+    /**
+     * The directory from where we'll find package.json's recursively
+     */
+    directory: string;
+    /**
+     * Specifies the maximum depth of the glob search.
+     */
+    deep?: number;
+}
+/**
+ * This function traverses down a directory tree to find directories containing a package.json
+ * and installs the dependencies if needed. To know if it's needed, it uses the "check" command
+ * provided by dependency managers.
+ * @param options {InstallNPMDependenciesRecursivelyOptions} Options to install dependencies recursively.
+ */
+declare function installNPMDependenciesRecursively(options: InstallNPMDependenciesRecursivelyOptions): Promise<void>;
 /**
  * Installs the dependencies in the given directory.
  * @param directory {string} The directory that contains the package.json
  * @param dependencyManager {DependencyManager} The dependency manager to use to install the dependencies.
  * @param stdout {Writable} Standard output stream.
+ * @param stderr {Writable} Standard error stream.
+ * @param signal {AbortSignal} Abort signal.
  * @returns stderr {Writable} Standard error stream.
  */
-declare function install(directory: string, dependencyManager: DependencyManager, stdout?: Writable, stderr?: Writable): Promise<void>;
+declare function install(directory: string, dependencyManager: DependencyManager, stdout?: Writable, stderr?: Writable, signal?: AbortSignal): Promise<void>;
+/**
+ * Returns the list of production and dev dependencies of a package.json
+ * @param packageJsonPath {string} Path to the package.json file
+ * @returns A promise that resolves with the list of dependencies.
+ */
+declare function getDependencies(packageJsonPath: string): Promise<string[]>;
+declare type DependencyType = 'dev' | 'prod' | 'peer';
+interface AddNPMDependenciesIfNeededOptions {
+    /** How dependencies should be added */
+    type: DependencyType;
+    /** The dependency manager to use to add dependencies */
+    dependencyManager: DependencyManager;
+    /** The directory that contains the package.json where dependencies will be added */
+    directory: string;
+    /** Standard output coming from the underlying installation process */
+    stdout?: Writable;
+    /** Standard error coming from the underlying installation process */
+    stderr?: Writable;
+    /** Abort signal to stop the process */
+    signal?: AbortSignal;
+}
+/**
+ * Adds dependencies to a Node project (i.e. a project that has a package.json)
+ * @param dependencies {string[]} List of dependencies to be added.
+ * @param options {AddNPMDependenciesIfNeededOptions} Options for adding dependencies.
+ */
+declare function addNPMDependenciesIfNeeded(dependencies: string[], options: AddNPMDependenciesIfNeededOptions): Promise<void>;
 
-type dependency_DependencyManager = DependencyManager;
-declare const dependency_DependencyManager: typeof DependencyManager;
 declare const dependency_dependencyManager: typeof dependencyManager;
+type dependency_DependencyManager = DependencyManager;
+declare const dependency_PackageJsonNotFoundError: typeof PackageJsonNotFoundError;
 declare const dependency_dependencyManagerUsedForCreating: typeof dependencyManagerUsedForCreating;
+declare const dependency_installNPMDependenciesRecursively: typeof installNPMDependenciesRecursively;
 declare const dependency_install: typeof install;
+declare const dependency_getDependencies: typeof getDependencies;
+declare const dependency_addNPMDependenciesIfNeeded: typeof addNPMDependenciesIfNeeded;
 declare namespace dependency {
   export {
-    dependency_DependencyManager as DependencyManager,
     dependency_dependencyManager as dependencyManager,
+    dependency_DependencyManager as DependencyManager,
+    dependency_PackageJsonNotFoundError as PackageJsonNotFoundError,
     dependency_dependencyManagerUsedForCreating as dependencyManagerUsedForCreating,
+    dependency_installNPMDependenciesRecursively as installNPMDependenciesRecursively,
     dependency_install as install,
+    dependency_getDependencies as getDependencies,
+    dependency_addNPMDependenciesIfNeeded as addNPMDependenciesIfNeeded,
   };
 }
 
@@ -780,6 +857,7 @@ declare function ensureAuthenticatedAdmin(store: string, scopes?: string[]): Pro
  * @returns {OAuthSession} An instance with the access tokens organized by application.
  */
 declare function ensureAuthenticated(applications: OAuthApplications, env?: NodeJS.ProcessEnv): Promise<OAuthSession>;
+declare function logout(): Promise<void>;
 
 type session_OAuthApplications = OAuthApplications;
 type session_AdminSession = AdminSession;
@@ -788,6 +866,7 @@ declare const session_ensureAuthenticatedPartners: typeof ensureAuthenticatedPar
 declare const session_ensureAuthenticatedStorefront: typeof ensureAuthenticatedStorefront;
 declare const session_ensureAuthenticatedAdmin: typeof ensureAuthenticatedAdmin;
 declare const session_ensureAuthenticated: typeof ensureAuthenticated;
+declare const session_logout: typeof logout;
 declare namespace session {
   export {
     session_OAuthApplications as OAuthApplications,
@@ -797,6 +876,7 @@ declare namespace session {
     session_ensureAuthenticatedStorefront as ensureAuthenticatedStorefront,
     session_ensureAuthenticatedAdmin as ensureAuthenticatedAdmin,
     session_ensureAuthenticated as ensureAuthenticated,
+    session_logout as logout,
   };
 }
 
@@ -828,19 +908,6 @@ declare namespace yaml {
   };
 }
 
-interface CreateOptions {
-    port: number;
-    authToken: string;
-}
-declare function create(options: CreateOptions): Promise<string>;
-
-declare const tunnel_create: typeof create;
-declare namespace tunnel {
-  export {
-    tunnel_create as create,
-  };
-}
-
 interface CachedAppInfo {
     appId: string;
     orgId?: string;
@@ -903,16 +970,6 @@ interface FindOrganizationQuerySchema {
             id: string;
             businessName: string;
             website: string;
-            stores: {
-                nodes: {
-                    shopId: string;
-                    link: string;
-                    shopDomain: string;
-                    shopName: string;
-                    transferDisabled: boolean;
-                    convertableToPartnerTest: boolean;
-                }[];
-            };
             apps: {
                 nodes: {
                     id: string;
@@ -945,7 +1002,6 @@ interface CreateAppQueryVariables {
     title: string;
     appUrl: string;
     redir: string[];
-    type: string;
 }
 interface CreateAppQuerySchema {
     appCreate: {
@@ -982,6 +1038,121 @@ interface UpdateURLsQuerySchema {
     };
 }
 
+declare const FindAppQuery: string;
+interface FindAppQuerySchema {
+    app: {
+        id: string;
+        title: string;
+        apiKey: string;
+        apiSecretKeys: {
+            secret: string;
+        }[];
+        appType: string;
+    };
+}
+
+declare const UpdateDraftMutation: string;
+interface ExtensionUpdateDraftInput {
+    apiKey: string;
+    clientMutationId: string;
+    config: string;
+    context: string | undefined;
+    registrationId: string;
+}
+interface ExtensionUpdateDraftPayload {
+    clientMutationId: string;
+    extensionVersion: ExtensionVersion;
+    userErrors: {
+        field: string[];
+        message: string;
+    }[];
+}
+interface ExtensionVersion {
+    config: string;
+    context: string;
+    id: string;
+    lastUserInteractionAt: string;
+    location: string;
+    registrationId: string;
+    registrationUuid: string;
+    uuid: string;
+    validationErrors: {
+        field: string[];
+        message: string;
+    }[];
+    versionTag: string;
+}
+
+declare const GenerateSignedUploadUrl: string;
+interface GenerateSignedUploadUrlVariables {
+    apiKey: string;
+    deploymentUuid: string;
+    bundleFormat: number;
+}
+interface GenerateSignedUploadUrlSchema {
+    deploymentGenerateSignedUploadUrl: {
+        signedUploadUrl: string;
+        userErrors: {
+            field: string[];
+            message: string;
+        }[];
+    };
+}
+
+declare const CreateDeployment: string;
+interface CreateDeploymentVariables {
+    apiKey: string;
+    uuid: string;
+    bundleUrl: string;
+}
+interface CreateDeploymentSchema {
+    deploymentCreate: {
+        deployment: {
+            uuid: string;
+        };
+        userErrors: {
+            field: string[];
+            message: string;
+        }[];
+    };
+}
+
+declare const AllStoresByOrganizationQuery: string;
+interface AllStoresByOrganizationSchema {
+    organizations: {
+        nodes: {
+            id: string;
+            stores: {
+                nodes: {
+                    shopId: string;
+                    link: string;
+                    shopDomain: string;
+                    shopName: string;
+                    transferDisabled: boolean;
+                    convertableToPartnerTest: boolean;
+                }[];
+            };
+        }[];
+    };
+}
+
+declare const ConvertDevToTestStoreQuery: string;
+interface ConvertDevToTestStoreVariables {
+    input: {
+        organizationID: number;
+        shopId: string;
+    };
+}
+interface ConvertDevToTestStoreSchema {
+    convertDevToTestStore: {
+        convertedToTestStore: boolean;
+        userErrors: {
+            field: string[];
+            message: string;
+        }[];
+    };
+}
+
 declare const index_FindOrganizationQuery: typeof FindOrganizationQuery;
 type index_FindOrganizationQuerySchema = FindOrganizationQuerySchema;
 type index_AllOrganizationsQuerySchema = AllOrganizationsQuerySchema;
@@ -992,6 +1163,23 @@ type index_CreateAppQuerySchema = CreateAppQuerySchema;
 declare const index_UpdateURLsQuery: typeof UpdateURLsQuery;
 type index_UpdateURLsQueryVariables = UpdateURLsQueryVariables;
 type index_UpdateURLsQuerySchema = UpdateURLsQuerySchema;
+declare const index_FindAppQuery: typeof FindAppQuery;
+type index_FindAppQuerySchema = FindAppQuerySchema;
+declare const index_UpdateDraftMutation: typeof UpdateDraftMutation;
+type index_ExtensionUpdateDraftInput = ExtensionUpdateDraftInput;
+type index_ExtensionUpdateDraftPayload = ExtensionUpdateDraftPayload;
+type index_ExtensionVersion = ExtensionVersion;
+declare const index_GenerateSignedUploadUrl: typeof GenerateSignedUploadUrl;
+type index_GenerateSignedUploadUrlVariables = GenerateSignedUploadUrlVariables;
+type index_GenerateSignedUploadUrlSchema = GenerateSignedUploadUrlSchema;
+declare const index_CreateDeployment: typeof CreateDeployment;
+type index_CreateDeploymentVariables = CreateDeploymentVariables;
+type index_CreateDeploymentSchema = CreateDeploymentSchema;
+declare const index_AllStoresByOrganizationQuery: typeof AllStoresByOrganizationQuery;
+type index_AllStoresByOrganizationSchema = AllStoresByOrganizationSchema;
+declare const index_ConvertDevToTestStoreQuery: typeof ConvertDevToTestStoreQuery;
+type index_ConvertDevToTestStoreVariables = ConvertDevToTestStoreVariables;
+type index_ConvertDevToTestStoreSchema = ConvertDevToTestStoreSchema;
 declare namespace index {
   export {
     index_FindOrganizationQuery as FindOrganizationQuery,
@@ -1004,6 +1192,23 @@ declare namespace index {
     index_UpdateURLsQuery as UpdateURLsQuery,
     index_UpdateURLsQueryVariables as UpdateURLsQueryVariables,
     index_UpdateURLsQuerySchema as UpdateURLsQuerySchema,
+    index_FindAppQuery as FindAppQuery,
+    index_FindAppQuerySchema as FindAppQuerySchema,
+    index_UpdateDraftMutation as UpdateDraftMutation,
+    index_ExtensionUpdateDraftInput as ExtensionUpdateDraftInput,
+    index_ExtensionUpdateDraftPayload as ExtensionUpdateDraftPayload,
+    index_ExtensionVersion as ExtensionVersion,
+    index_GenerateSignedUploadUrl as GenerateSignedUploadUrl,
+    index_GenerateSignedUploadUrlVariables as GenerateSignedUploadUrlVariables,
+    index_GenerateSignedUploadUrlSchema as GenerateSignedUploadUrlSchema,
+    index_CreateDeployment as CreateDeployment,
+    index_CreateDeploymentVariables as CreateDeploymentVariables,
+    index_CreateDeploymentSchema as CreateDeploymentSchema,
+    index_AllStoresByOrganizationQuery as AllStoresByOrganizationQuery,
+    index_AllStoresByOrganizationSchema as AllStoresByOrganizationSchema,
+    index_ConvertDevToTestStoreQuery as ConvertDevToTestStoreQuery,
+    index_ConvertDevToTestStoreVariables as ConvertDevToTestStoreVariables,
+    index_ConvertDevToTestStoreSchema as ConvertDevToTestStoreSchema,
   };
 }
 
@@ -1031,10 +1236,23 @@ declare type Response = ReturnType<typeof nodeFetch>;
  */
 declare function fetch(url: RequestInfo, init?: RequestInit): Response;
 
+declare function formData(): FormData;
+
 declare const http_fetch: typeof fetch;
+declare const http_formData: typeof formData;
 declare namespace http {
   export {
     http_fetch as fetch,
+    http_formData as formData,
+  };
+}
+
+declare function zip(inputDirectory: string, outputZipPath: string): Promise<void>;
+
+declare const archiver_zip: typeof zip;
+declare namespace archiver {
+  export {
+    archiver_zip as zip,
   };
 }
 
@@ -1124,6 +1342,10 @@ declare namespace npm {
   };
 }
 
+/**
+ * Returns an available port in the current environment.
+ * @returns {Promise<number>} A promise that resolves with an availabe port.
+ */
 declare function getRandomPort(): Promise<number>;
 
 declare const port_getRandomPort: typeof getRandomPort;
@@ -1133,6 +1355,48 @@ declare namespace port {
   };
 }
 
+/**
+ * An object that contains the flags that
+ * are shared across all the commands.
+ */
+declare const globalFlags: {
+    verbose: _oclif_core_lib_interfaces.BooleanFlag<boolean>;
+};
+
+declare const cli_globalFlags: typeof globalFlags;
+declare namespace cli {
+  export {
+    cli_globalFlags as globalFlags,
+  };
+}
+
+/**
+ * Generates and returns a random UUID.
+ * @returns {string} The random UUID generated.
+ */
+declare const generateRandomUUID: () => string;
+
+declare const id_generateRandomUUID: typeof generateRandomUUID;
+declare namespace id {
+  export {
+    id_generateRandomUUID as generateRandomUUID,
+  };
+}
+
+/**
+ * Creates a temporary directory and ties its lifeclcycle to the lifecycle of the callback.
+ * @param callback {(string) => void} Callback to execute. When the callback exits, the temporary directory is destroyed.
+ * @returns {Promise<T>} Promise that resolves with the value returned by the callback.
+ */
+declare function directory<T>(callback: (directory: string) => Promise<T>): Promise<T>;
+
+declare const temporary_directory: typeof directory;
+declare namespace temporary {
+  export {
+    temporary_directory as directory,
+  };
+}
+
 declare const constants: {
     environmentVariables: {
         unitTest: string;
@@ -1185,5 +1449,20 @@ declare const constants: {
     };
 };
 
-export { api, checksum, constants, dependency, environment, error$1 as error, file, git, github, http, npm, os, output, path, port, ruby, schema, semver, session, store, string, system, template, toml, tunnel, ui, version, yaml };
+interface TunnelPlugin {
+    start: (options: TunnelStartOptions) => Promise<string>;
+}
+interface TunnelStartOptions {
+    port: number;
+}
+declare function lookupTunnelPlugin(plugins: Plugin[]): Promise<TunnelPlugin | undefined>;
+
+declare const plugins_lookupTunnelPlugin: typeof lookupTunnelPlugin;
+declare namespace plugins {
+  export {
+    plugins_lookupTunnelPlugin as lookupTunnelPlugin,
+  };
+}
+
+export { api, archiver, checksum, cli, constants, dependency, environment, error$1 as error, file, git, github, http, id, npm, os, output, path, plugins, port, ruby, schema, semver, session, store, string, system, template, temporary, toml, ui, version, yaml };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,4 +1,4 @@
-export { q as api, w as checksum, C as constants, d as dependency, i as environment, e as error, f as file, g as git, c as github, r as http, A as npm, h as os, o as output, p as path, B as port, x as ruby, k as schema, z as semver, j as session, n as store, b as string, s as system, t as template, l as toml, m as tunnel, u as ui, v as version, y as yaml } from './index-8fb3a5d8.js';
+export { n as api, r as archiver, w as checksum, C as cli, G as constants, d as dependency, i as environment, e as error, f as file, g as git, c as github, q as http, D as id, A as npm, h as os, o as output, p as path, H as plugins, B as port, x as ruby, k as schema, z as semver, j as session, m as store, b as string, s as system, t as template, E as temporary, l as toml, u as ui, v as version, y as yaml } from './index-cee0245d.js';
 import 'assert';
 import 'events';
 import 'readline';

package/dist/{multipart-parser-561fdeba.js → multipart-parser-b4090c19.js}

@@ -1,6 +1,6 @@
 import 'node:fs';
 import 'node:path';
-import { F as FormData, a as File } from './index-8fb3a5d8.js';
+import { F as FormData, a as File } from './index-cee0245d.js';
 import 'assert';
 import 'events';
 import 'readline';
@@ -470,4 +470,4 @@ async function toFormData(Body, ct) {
 }
 
 export { toFormData };
-//# sourceMappingURL=multipart-parser-561fdeba.js.map
+//# sourceMappingURL=multipart-parser-b4090c19.js.map