@shopify/cli-kit 0.30.1 → 0.31.3

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import { Writable } from 'node:stream';
+import open from 'open';
 import path$1 from 'path';
 import * as fs from 'fs';
 import { EventEmitter } from 'events';
@@ -101,15 +102,36 @@ declare const exec: (command: string, args: string[], options?: ExecOptions | un
 type system_ExecOptions = ExecOptions;
 declare const system_captureOutput: typeof captureOutput;
 declare const system_exec: typeof exec;
+declare const system_open: typeof open;
 declare namespace system {
   export {
     system_ExecOptions as ExecOptions,
     system_captureOutput as captureOutput,
     system_exec as exec,
+    system_open as open,
   };
 }
 
-declare function template(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
+ * using the Liquid template engine.
+ * Files indicate that they are liquid template by using the .liquid extension.
+ * @param from {string} Directory that contains the template.
+ * @param to {string} Output directory.
+ * @param data {string} Data to feed the template engine.
+ */
+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 {
+    template_create as create,
+    template_recursiveDirectoryCopy as recursiveDirectoryCopy,
+  };
+}
 
 interface Options$4 {
     splitRegexp?: RegExp | RegExp[];
@@ -122,8 +144,13 @@ declare function camelCase(input: string, options?: Options$4): string;
 
 declare function paramCase(input: string, options?: Options$4): string;
 
+/** Returns a random string */
+declare function randomHex(size: number): string;
+
+declare const string_randomHex: typeof randomHex;
 declare namespace string {
   export {
+    string_randomHex as randomHex,
     camelCase as camelize,
     paramCase as hyphenize,
   };
@@ -490,7 +517,19 @@ declare namespace path {
   };
 }
 
+/**
+ * It reads a file and returns its content as a string using the
+ * utf-8 encoding
+ * @param path {string} Path to the file to read.
+ * @returns {Promise<string>} A promise that resolves with the content of the file.
+ */
 declare function read(path: string): Promise<string>;
+/**
+ * Copies a file
+ * @param from {string} Path to the directory or file to be copied.
+ * @param to {string} Destination path.
+ */
+declare function copy(from: string, to: string): Promise<void>;
 declare function write(path: string, data: string): Promise<void>;
 declare function mkdir(path: string): Promise<void>;
 declare function rmdir(path: string): Promise<void>;
@@ -499,6 +538,7 @@ declare function isDirectory(path: string): Promise<boolean>;
 declare function exists(path: string): Promise<boolean>;
 
 declare const file_read: typeof read;
+declare const file_copy: typeof copy;
 declare const file_write: typeof write;
 declare const file_mkdir: typeof mkdir;
 declare const file_rmdir: typeof rmdir;
@@ -508,6 +548,7 @@ declare const file_exists: typeof exists;
 declare namespace file {
   export {
     file_read as read,
+    file_copy as copy,
     file_write as write,
     file_mkdir as mkdir,
     file_rmdir as rmdir,
@@ -658,7 +699,7 @@ declare enum Environment {
  * Returns the environment to be used for the interactions with the partners' CLI API.
  * @param env The environment variables from the environment of the current process.
  */
-declare function partners$1(env?: NodeJS.ProcessEnv): Environment;
+declare function partners$2(env?: NodeJS.ProcessEnv): Environment;
 /**
  * Returns the environment to be used for the interactions with the admin API.
  * @param env The environment variables from the environment of the current process.
@@ -672,7 +713,7 @@ declare function identity$1(env?: NodeJS.ProcessEnv): Environment;
 
 declare namespace service {
   export {
-    partners$1 as partners,
+    partners$2 as partners,
     shopify$1 as shopify,
     identity$1 as identity,
   };
@@ -686,7 +727,7 @@ declare const NotProvidedStoreFQDNError: Abort;
  * It returns the Partners' API service we should interact with.
  * @returns {string} Fully-qualified domain of the partners service we should interact with.
  */
-declare function partners(): Promise<string>;
+declare function partners$1(): Promise<string>;
 /**
  * It returns the Identity service we should interact with.
  * @returns {string} Fully-qualified domain of the Identity service we should interact with.
@@ -705,7 +746,6 @@ declare const fqdn_CouldntObtainPartnersSpinFQDNError: typeof CouldntObtainPartn
 declare const fqdn_CouldntObtainIdentitySpinFQDNError: typeof CouldntObtainIdentitySpinFQDNError;
 declare const fqdn_CouldntObtainShopifySpinFQDNError: typeof CouldntObtainShopifySpinFQDNError;
 declare const fqdn_NotProvidedStoreFQDNError: typeof NotProvidedStoreFQDNError;
-declare const fqdn_partners: typeof partners;
 declare const fqdn_identity: typeof identity;
 declare const fqdn_shopify: typeof shopify;
 declare namespace fqdn {
@@ -714,7 +754,7 @@ declare namespace fqdn {
     fqdn_CouldntObtainIdentitySpinFQDNError as CouldntObtainIdentitySpinFQDNError,
     fqdn_CouldntObtainShopifySpinFQDNError as CouldntObtainShopifySpinFQDNError,
     fqdn_NotProvidedStoreFQDNError as NotProvidedStoreFQDNError,
-    fqdn_partners as partners,
+    partners$1 as partners,
     fqdn_identity as identity,
     fqdn_shopify as shopify,
   };
@@ -731,6 +771,61 @@ declare namespace environment {
   };
 }
 
+/**
+ * A scope supported by the Shopify Admin API.
+ */
+declare type AdminAPIScope = 'graphql' | 'themes' | 'collaborator' | string;
+/**
+ * It represents the options to authenticate against the Shopify Admin API.
+ */
+interface AdminAPIOAuthOptions {
+    /** List of scopes to request permissions for */
+    scopes: AdminAPIScope[];
+}
+/**
+ * A scope supported by the Partners API.
+ */
+declare type PartnersAPIScope = 'cli' | string;
+interface PartnersAPIOAuthOptions {
+    /** List of scopes to request permissions for */
+    scopes: PartnersAPIScope[];
+}
+/**
+ * A scope supported by the Storefront Renderer API.
+ */
+declare type StorefrontRendererScope = 'devtools' | string;
+interface StorefrontRendererAPIOAuthOptions {
+    /** List of scopes to request permissions for */
+    scopes: StorefrontRendererScope[];
+}
+interface ShopifyOAuthOptions {
+    storeFqdn?: string;
+    storefrontRendererApi?: StorefrontRendererAPIOAuthOptions;
+    adminApi?: AdminAPIOAuthOptions;
+}
+/**
+ * It represents the authentication requirements and
+ * is the input necessary to trigger the authentication
+ * flow.
+ */
+interface OAuthApplications {
+    shopify?: ShopifyOAuthOptions;
+    partnersApi?: PartnersAPIOAuthOptions;
+}
+/**
+ * This method ensures that we have a valid session to authenticate against the given applications using the provided scopes.
+ * @param options {OAuthApplications} An object containing the applications we need to be authenticated with.
+ * @returns {OAuthSession} An instance with the access tokens organized by application.
+ */
+declare function ensureAuthenticated(applications: OAuthApplications): Promise<void>;
+
+declare const session_ensureAuthenticated: typeof ensureAuthenticated;
+declare namespace session {
+  export {
+    session_ensureAuthenticated as ensureAuthenticated,
+  };
+}
+
 declare namespace util {
     type AssertEqual<T, Expected> = [T] extends [Expected] ? [Expected] extends [T] ? true : false : false;
     function assertNever(_x: never): never;
@@ -2057,356 +2152,6 @@ declare namespace schema {
   };
 }
 
-/**
- * This schema represents the format of the session
- * that we cache in the system to avoid unnecessary
- * token exchanges.
- *
- * @example
- *   {
- *      "accounts.shopify.com": {...}
- *      "identity.spin.com": {...}
- *   }
- *
- */
-declare const SessionSchema: ZodObject<{}, "strip", ZodObject<{
-    /**
-     * It contains the identity token. Before usint it, we exchange it
-     * to get a token that we can use with different applications. The exchanged
-     * tokens for the applications are stored under applications.
-     */
-    identity: ZodObject<{
-        accessToken: ZodString;
-        refreshToken: ZodString;
-        expiresAt: ZodEffects<ZodDate, Date, Date>;
-        scopes: ZodArray<ZodString, "many">;
-    }, "strip", ZodTypeAny, {
-        accessToken: string;
-        refreshToken: string;
-        expiresAt: Date;
-        scopes: string[];
-    }, {
-        accessToken: string;
-        refreshToken: string;
-        expiresAt: Date;
-        scopes: string[];
-    }>;
-    /**
-     * It contains exchanged tokens for the applications the CLI
-     * authenticates with. Tokens are scoped under the fqdn of the applications.
-     */
-    applications: ZodObject<{
-        /**
-         * Exchanged tokens for Admin applications.
-         */
-        adminApi: ZodObject<{}, "strip", ZodObject<{
-            accessToken: ZodString;
-            expiresAt: ZodEffects<ZodDate, Date, Date>;
-            scopes: ZodArray<ZodString, "many">;
-        }, "strip", ZodTypeAny, {
-            accessToken: string;
-            expiresAt: Date;
-            scopes: string[];
-        }, {
-            accessToken: string;
-            expiresAt: Date;
-            scopes: string[];
-        }>, {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        }, {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        }>;
-        /**
-         * Exchanged tokens for Partner applications.
-         */
-        partnersApi: ZodObject<{}, "strip", ZodObject<{
-            accessToken: ZodString;
-            expiresAt: ZodEffects<ZodDate, Date, Date>;
-            scopes: ZodArray<ZodString, "many">;
-        }, "strip", ZodTypeAny, {
-            accessToken: string;
-            expiresAt: Date;
-            scopes: string[];
-        }, {
-            accessToken: string;
-            expiresAt: Date;
-            scopes: string[];
-        }>, {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        }, {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        }>;
-        /**
-         * Exchanged tokens for Storefront Renderer applications.
-         */
-        storefrontRendererApi: ZodObject<{}, "strip", ZodObject<{
-            accessToken: ZodString;
-            expiresAt: ZodEffects<ZodDate, Date, Date>;
-            scopes: ZodArray<ZodString, "many">;
-        }, "strip", ZodTypeAny, {
-            accessToken: string;
-            expiresAt: Date;
-            scopes: string[];
-        }, {
-            accessToken: string;
-            expiresAt: Date;
-            scopes: string[];
-        }>, {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        }, {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        }>;
-    }, "strip", ZodTypeAny, {
-        adminApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-        partnersApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-        storefrontRendererApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-    }, {
-        adminApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-        partnersApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-        storefrontRendererApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-    }>;
-}, "strip", ZodTypeAny, {
-    identity: {
-        accessToken: string;
-        refreshToken: string;
-        expiresAt: Date;
-        scopes: string[];
-    };
-    applications: {
-        adminApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-        partnersApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-        storefrontRendererApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-    };
-}, {
-    identity: {
-        accessToken: string;
-        refreshToken: string;
-        expiresAt: Date;
-        scopes: string[];
-    };
-    applications: {
-        adminApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-        partnersApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-        storefrontRendererApi: {
-            [x: string]: {
-                accessToken: string;
-                expiresAt: Date;
-                scopes: string[];
-            };
-        };
-    };
-}>, {
-    [x: string]: {
-        identity: {
-            accessToken: string;
-            refreshToken: string;
-            expiresAt: Date;
-            scopes: string[];
-        };
-        applications: {
-            adminApi: {
-                [x: string]: {
-                    accessToken: string;
-                    expiresAt: Date;
-                    scopes: string[];
-                };
-            };
-            partnersApi: {
-                [x: string]: {
-                    accessToken: string;
-                    expiresAt: Date;
-                    scopes: string[];
-                };
-            };
-            storefrontRendererApi: {
-                [x: string]: {
-                    accessToken: string;
-                    expiresAt: Date;
-                    scopes: string[];
-                };
-            };
-        };
-    };
-}, {
-    [x: string]: {
-        identity: {
-            accessToken: string;
-            refreshToken: string;
-            expiresAt: Date;
-            scopes: string[];
-        };
-        applications: {
-            adminApi: {
-                [x: string]: {
-                    accessToken: string;
-                    expiresAt: Date;
-                    scopes: string[];
-                };
-            };
-            partnersApi: {
-                [x: string]: {
-                    accessToken: string;
-                    expiresAt: Date;
-                    scopes: string[];
-                };
-            };
-            storefrontRendererApi: {
-                [x: string]: {
-                    accessToken: string;
-                    expiresAt: Date;
-                    scopes: string[];
-                };
-            };
-        };
-    };
-}>;
-declare type Session = TypeOf<typeof SessionSchema>;
-
-/**
- * A scope supported by the Shopify Admin API.
- */
-declare type AdminAPIScope = 'graphql' | 'themes' | 'collaborator' | string;
-/**
- * It represents the options to authenticate against the Shopify Admin API.
- */
-interface AdminAPIOAuthOptions {
-    /** List of scopes to request permissions for */
-    scopes: AdminAPIScope[];
-}
-/**
- * A scope supported by the Partners API.
- */
-declare type PartnersAPIScope = 'cli' | string;
-interface PartnersAPIOAuthOptions {
-    /** List of scopes to request permissions for */
-    scopes: PartnersAPIScope[];
-}
-/**
- * A scope supported by the Storefront Renderer API.
- */
-declare type StorefrontRendererScope = 'devtools' | string;
-interface StorefrontRendererAPIOAuthOptions {
-    /** List of scopes to request permissions for */
-    scopes: StorefrontRendererScope[];
-}
-interface ShopifyOAuthOptions {
-    storeFqdn?: string;
-    storefrontRendererApi?: StorefrontRendererAPIOAuthOptions;
-    adminApi?: AdminAPIOAuthOptions;
-}
-/**
- * It represents the authentication requirements and
- * is the input necessary to trigger the authentication
- * flow.
- */
-interface OAuthApplications {
-    shopify?: ShopifyOAuthOptions;
-    partnersApi?: PartnersAPIOAuthOptions;
-}
-/**
- * This method ensures that we have a valid session to authenticate against the given applications using the provided scopes.
- * @param options {OAuthApplications} An object containing the applications we need to be authenticated with.
- * @returns {OAuthSession} An instance with the access tokens organized by application.
- */
-declare function ensureAuthenticated(applications: OAuthApplications): Promise<Session>;
-
-declare const session_ensureAuthenticated: typeof ensureAuthenticated;
-declare namespace session {
-  export {
-    session_ensureAuthenticated as ensureAuthenticated,
-  };
-}
-
 declare function parse(input: string): object;
 
 declare const toml_parse: typeof parse;
@@ -3621,6 +3366,51 @@ declare namespace store {
   };
 }
 
+/**
+ * The schema represents an application token.
+ *
+ */
+declare const ApplicationTokenSchema: ZodObject<{
+    accessToken: ZodString;
+    expiresAt: ZodEffects<ZodDate, Date, Date>;
+    scopes: ZodArray<ZodString, "many">;
+}, "strip", ZodTypeAny, {
+    accessToken: string;
+    expiresAt: Date;
+    scopes: string[];
+}, {
+    accessToken: string;
+    expiresAt: Date;
+    scopes: string[];
+}>;
+declare type ApplicationToken = TypeOf<typeof ApplicationTokenSchema>;
+
+declare function request$1<T>(query: any, token: ApplicationToken, store: string, variables?: any): Promise<T>;
+
+declare namespace admin {
+  export {
+    request$1 as request,
+  };
+}
+
+declare function request<T>(query: any, token: ApplicationToken, variables?: any): Promise<T>;
+
+declare const partners_request: typeof request;
+declare namespace partners {
+  export {
+    partners_request as request,
+  };
+}
+
+declare const api_admin: typeof admin;
+declare const api_partners: typeof partners;
+declare namespace api {
+  export {
+    api_admin as admin,
+    api_partners as partners,
+  };
+}
+
 /** @type {typeof globalThis.Blob} */
 declare const Blob: typeof globalThis.Blob;
 
@@ -3858,7 +3648,10 @@ declare const constants: {
     keychain: {
         service: string;
     };
+    session: {
+        expirationTimeMarginInMinutes: number;
+    };
 };
 
-export { constants, dependency, environment, error$1 as error, file, http, os, output$1 as output, path, schema, session, store, string, system, template, toml, ui, version };
+export { api, constants, dependency, environment, error$1 as error, file, http, os, output$1 as output, path, schema, session, store, string, system, template, toml, ui, version };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,4 +1,4 @@
-export { m as constants, d as dependency, g as environment, e as error, f as file, l as http, c as os, o as output, p as path, i as schema, h as session, k as store, b as string, s as system, t as template, j as toml, u as ui, v as version } from './index-0360f23d.js';
+export { l as api, n as constants, d as dependency, g as environment, e as error, f as file, m as http, c as os, o as output, p as path, i as schema, h as session, k as store, b as string, s as system, t as template, j as toml, u as ui, v as version } from './index-80382e6b.js';
 import 'assert';
 import 'events';
 import 'readline';
@@ -16,6 +16,7 @@ import 'node:url';
 import 'node:os';
 import 'buffer';
 import 'util';
+import 'open';
 import 'node:fs';
 import 'constants';
 import 'http';
@@ -27,6 +28,7 @@ import 'http2';
 import 'tls';
 import 'net';
 import 'crypto';
+import 'punycode';
 import 'node:http';
 import 'node:https';
 import 'node:zlib';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/{multipart-parser-580f5b8c.js → multipart-parser-54cbb259.js}

@@ -1,6 +1,6 @@
 import 'node:fs';
 import 'node:path';
-import { F as FormData, a as File } from './index-0360f23d.js';
+import { F as FormData, a as File } from './index-80382e6b.js';
 import 'assert';
 import 'events';
 import 'readline';
@@ -17,6 +17,7 @@ import 'node:url';
 import 'node:os';
 import 'buffer';
 import 'util';
+import 'open';
 import 'constants';
 import 'http';
 import 'https';
@@ -27,6 +28,7 @@ import 'http2';
 import 'tls';
 import 'net';
 import 'crypto';
+import 'punycode';
 import 'node:http';
 import 'node:https';
 import 'node:zlib';
@@ -465,4 +467,4 @@ async function toFormData(Body, ct) {
 }
 
 export { toFormData };
-//# sourceMappingURL=multipart-parser-580f5b8c.js.map
+//# sourceMappingURL=multipart-parser-54cbb259.js.map