@shopify/ui-extensions 2025.10.0-rc.44 → 2025.10.0-rc.45

package/build/ts/docs/shared/components/ColorField.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ColorField.d.ts","sourceRoot":"","sources":["../../../../../src/docs/shared/components/ColorField.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,mCAAmC,EAAC,MAAM,cAAc,CAAC;AAEtE,QAAA,MAAM,IAAI,EAAE,mCAMX,CAAC;AAEF,eAAe,IAAI,CAAC"}
+{"version":3,"file":"ColorField.d.ts","sourceRoot":"","sources":["../../../../../src/docs/shared/components/ColorField.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,mCAAmC,EAAC,MAAM,cAAc,CAAC;AAEtE,QAAA,MAAM,IAAI,EAAE,mCAOX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/api/intents/intents.d.ts

@@ -0,0 +1,132 @@
+/**
+ * User dismissed or closed the workflow without completing it.
+ */
+export interface ClosedIntentResponse {
+    code?: 'closed';
+}
+/**
+ * Successful intent completion.
+ */
+export interface SuccessIntentResponse {
+    code?: 'ok';
+    data?: {
+        [key: string]: unknown;
+    };
+}
+/**
+ * Failed intent completion.
+ */
+export interface ErrorIntentResponse {
+    code?: 'error';
+    message?: string;
+    issues?: {
+        /**
+         * The path to the field with the issue.
+         */
+        path?: string[];
+        /**
+         * The error message for the issue.
+         */
+        message?: string;
+        /**
+         * A code identifier for the issue.
+         */
+        code?: string;
+    }[];
+}
+/**
+ * Result of an intent activity.
+ * Discriminated union representing all possible completion outcomes.
+ */
+export type IntentResponse = SuccessIntentResponse | ErrorIntentResponse | ClosedIntentResponse;
+/**
+ * Activity handle for tracking intent workflow progress.
+ */
+export interface IntentActivity {
+    /**
+     * A Promise that resolves when the intent workflow completes, returning the response.
+     */
+    complete?: Promise<IntentResponse>;
+}
+/**
+ * The action to perform on a resource.
+ */
+export type IntentAction = 'create' | 'edit';
+/**
+ * Supported resource types that can be targeted by intents.
+ */
+export type IntentType = 'shopify/Article' | 'shopify/Catalog' | 'shopify/Collection' | 'shopify/Customer' | 'shopify/Discount' | 'shopify/Market' | 'shopify/Menu' | 'shopify/MetafieldDefinition' | 'shopify/Metaobject' | 'shopify/MetaobjectDefinition' | 'shopify/Page' | 'shopify/Product' | 'shopify/ProductVariant';
+/**
+ * Options for invoking intents when using the query string format.
+ */
+export interface IntentQueryOptions {
+    /**
+     * The resource identifier for edit actions (e.g., 'gid://shopify/Product/123').
+     */
+    value?: string;
+    /**
+     * Additional data required for certain intent types.
+     * For example:
+     * - Discount creation requires { type: 'amount-off-product' | 'amount-off-order' | 'buy-x-get-y' | 'free-shipping' }
+     * - ProductVariant creation requires { productId: 'gid://shopify/Product/123' }
+     * - Metaobject creation requires { type: 'shopify--color-pattern' }
+     */
+    data?: {
+        [key: string]: unknown;
+    };
+}
+/**
+ * Structured description of an intent to invoke.
+ */
+export interface IntentQuery extends IntentQueryOptions {
+    /**
+     * The operation to perform on the target resource.
+     */
+    action: IntentAction;
+    /**
+     * The resource type (e.g., 'shopify/Product').
+     */
+    type: IntentType;
+}
+/**
+ * The invoke API for triggering intent workflows.
+ *
+ * @param intent - Either a string query or structured object describing the intent
+ * @param options - Optional parameters when using string query format
+ * @returns A Promise resolving to an activity handle for tracking the workflow
+ *
+ * @example
+ * ```javascript
+ * // Create a new product
+ * const activity = await intents.invoke('create:shopify/Product');
+ * const response = await activity.complete;
+ *
+ * // Edit an existing product
+ * const activity = await intents.invoke('edit:shopify/Product,gid://shopify/Product/123');
+ * const response = await activity.complete;
+ *
+ * // Create a discount with required type
+ * const activity = await intents.invoke('create:shopify/Discount', {
+ *   data: { type: 'amount-off-product' }
+ * });
+ * const response = await activity.complete;
+ * ```
+ */
+export interface IntentInvokeApi {
+    (query: IntentQuery): Promise<IntentActivity>;
+    (intentURL: string, options?: IntentQueryOptions): Promise<IntentActivity>;
+}
+/**
+ * Intent information provided to the receiver of an intent.
+ */
+export interface Intents {
+    /**
+     * The URL that was used to launch the intent.
+     */
+    launchUrl?: string | URL;
+    /**
+     * Invoke an intent workflow to create or edit Shopify resources.
+     */
+    invoke?: IntentInvokeApi;
+}
+//# sourceMappingURL=intents.d.ts.map

package/build/ts/surfaces/admin/api/intents/intents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intents.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/intents/intents.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,QAAQ,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;QAChB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;CACL;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,mBAAmB,GACnB,oBAAoB,CAAC;AAEzB;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,6BAA6B,GAC7B,oBAAoB,GACpB,8BAA8B,GAC9B,cAAc,GACd,iBAAiB,GACjB,wBAAwB,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,IAAI,CAAC,EAAE;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9C,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5E;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACzB;;OAEG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B"}

package/build/ts/surfaces/admin/api/intents/intents.doc.d.ts

@@ -0,0 +1,4 @@
+import { ReferenceEntityTemplateSchema } from '@shopify/generate-docs';
+declare const data: ReferenceEntityTemplateSchema;
+export default data;
+//# sourceMappingURL=intents.doc.d.ts.map

package/build/ts/surfaces/admin/api/intents/intents.doc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"intents.doc.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/intents/intents.doc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,6BAA6B,EAAC,MAAM,wBAAwB,CAAC;AAErE,QAAA,MAAM,IAAI,EAAE,6BA2hBX,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/build/ts/surfaces/admin/api/standard/standard.d.ts

@@ -2,12 +2,8 @@ import type { I18n } from '../../../../api';
 import { ApiVersion } from '../../../../shared';
 import type { Storage } from './storage';
 import type { ExtensionTarget as AnyExtensionTarget } from '../../extension-targets';
-export interface Intents {
-    /**
-     * The URL that was used to launch the intent.
-     */
-    launchUrl?: string | URL;
-}
+import type { Intents } from '../intents/intents';
+export type { Intents } from '../intents/intents';
 /**
  * GraphQL error returned by the Shopify Admin API.
  */
@@ -64,5 +60,4 @@ export interface StandardApi<ExtensionTarget extends AnyExtensionTarget> {
         errors?: GraphQLError[];
     }>;
 }
-export {};
 //# sourceMappingURL=standard.d.ts.map

package/build/ts/surfaces/admin/api/standard/standard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/standard/standard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AAEnF,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,UAAU,IAAI;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,eAAe,SAAS,kBAAkB;IACrE;;OAEG;IACH,SAAS,EAAE;QACT,MAAM,EAAE,eAAe,CAAC;KACzB,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,CAAC,IAAI,GAAG,OAAO,EAAE,SAAS,GAAG;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,EAC1D,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAC,SAAS,CAAC,EAAE,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;KAAC,KACrE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,YAAY,EAAE,CAAA;KAAC,CAAC,CAAC;CACtD"}
+{"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/admin/api/standard/standard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAC,UAAU,EAAC,MAAM,oBAAoB,CAAC;AAC9C,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAC,eAAe,IAAI,kBAAkB,EAAC,MAAM,yBAAyB,CAAC;AACnF,OAAO,KAAK,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAEhD,YAAY,EAAC,OAAO,EAAC,MAAM,oBAAoB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE;QACT,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,UAAU,IAAI;IACZ;;OAEG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,eAAe,SAAS,kBAAkB;IACrE;;OAEG;IACH,SAAS,EAAE;QACT,MAAM,EAAE,eAAe,CAAC;KACzB,CAAC;IAEF;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,CAAC,IAAI,GAAG,OAAO,EAAE,SAAS,GAAG;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAC,EAC1D,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAC,SAAS,CAAC,EAAE,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;KAAC,KACrE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,YAAY,EAAE,CAAA;KAAC,CAAC,CAAC;CACtD"}