@shopify/cli-kit 4.3.0 → 4.5.0

package/dist/public/node/api/bulk-operations/fetch.js

@@ -0,0 +1,42 @@
+import { BULK_OPERATIONS_MIN_API_VERSION } from './constants.js';
+import { adminRequestDoc } from '../admin.js';
+import { GetBulkOperationById, } from '../../../../cli/api/graphql/bulk-operations/generated/get-bulk-operation-by-id.js';
+import { ListBulkOperations, } from '../../../../cli/api/graphql/bulk-operations/generated/list-bulk-operations.js';
+/**
+ * Fetches a single bulk operation by ID.
+ *
+ * @param options - The admin session, operation ID, and optional API version.
+ * @returns The bulk operation, or null if it doesn't exist.
+ */
+export async function fetchBulkOperationById(options) {
+    const { adminSession, operationId, version } = options;
+    const response = await adminRequestDoc({
+        query: GetBulkOperationById,
+        session: adminSession,
+        variables: { id: operationId },
+        version: version ?? BULK_OPERATIONS_MIN_API_VERSION,
+    });
+    return response.bulkOperation;
+}
+/**
+ * Fetches recent bulk operations for the store.
+ *
+ * @param options - The admin session, optional API version, look-back window, and page size.
+ * @returns The list of bulk operation nodes, most recent first.
+ */
+export async function fetchRecentBulkOperations(options) {
+    const { adminSession, version, sinceDays = 7, first = 100 } = options;
+    const since = new Date(Date.now() - sinceDays * 24 * 60 * 60 * 1000).toISOString().split('T')[0];
+    const response = await adminRequestDoc({
+        query: ListBulkOperations,
+        session: adminSession,
+        variables: {
+            query: `created_at:>=${since}`,
+            first,
+            sortKey: 'CREATED_AT',
+        },
+        version: version ?? BULK_OPERATIONS_MIN_API_VERSION,
+    });
+    return response.bulkOperations.nodes;
+}
+//# sourceMappingURL=fetch.js.map

package/dist/public/node/api/bulk-operations/fetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../../../../src/public/node/api/bulk-operations/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,+BAA+B,EAAC,MAAM,gBAAgB,CAAA;AAC9D,OAAO,EAAC,eAAe,EAAC,MAAM,aAAa,CAAA;AAE3C,OAAO,EACL,oBAAoB,GAErB,MAAM,mFAAmF,CAAA;AAC1F,OAAO,EACL,kBAAkB,GAGnB,MAAM,+EAA+E,CAAA;AAQtF;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,OAAsC;IAEtC,MAAM,EAAC,YAAY,EAAE,WAAW,EAAE,OAAO,EAAC,GAAG,OAAO,CAAA;IAEpD,MAAM,QAAQ,GAAG,MAAM,eAAe,CAA0C;QAC9E,KAAK,EAAE,oBAAoB;QAC3B,OAAO,EAAE,YAAY;QACrB,SAAS,EAAE,EAAC,EAAE,EAAE,WAAW,EAAC;QAC5B,OAAO,EAAE,OAAO,IAAI,+BAA+B;KACpD,CAAC,CAAA;IAEF,OAAO,QAAQ,CAAC,aAAa,CAAA;AAC/B,CAAC;AAWD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC7C,OAAyC;IAEzC,MAAM,EAAC,YAAY,EAAE,OAAO,EAAE,SAAS,GAAG,CAAC,EAAE,KAAK,GAAG,GAAG,EAAC,GAAG,OAAO,CAAA;IAEnE,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAEhG,MAAM,QAAQ,GAAG,MAAM,eAAe,CAA4D;QAChG,KAAK,EAAE,kBAAkB;QACzB,OAAO,EAAE,YAAY;QACrB,SAAS,EAAE;YACT,KAAK,EAAE,gBAAgB,KAAK,EAAE;YAC9B,KAAK;YACL,OAAO,EAAE,YAAY;SACtB;QACD,OAAO,EAAE,OAAO,IAAI,+BAA+B;KACpD,CAAC,CAAA;IAEF,OAAO,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAA;AACtC,CAAC","sourcesContent":["import {BULK_OPERATIONS_MIN_API_VERSION} from './constants.js'\nimport {adminRequestDoc} from '../admin.js'\nimport {AdminSession} from '../../session.js'\nimport {\n  GetBulkOperationById,\n  GetBulkOperationByIdQuery,\n} from '../../../../cli/api/graphql/bulk-operations/generated/get-bulk-operation-by-id.js'\nimport {\n  ListBulkOperations,\n  ListBulkOperationsQuery,\n  ListBulkOperationsQueryVariables,\n} from '../../../../cli/api/graphql/bulk-operations/generated/list-bulk-operations.js'\n\ninterface FetchBulkOperationByIdOptions {\n  adminSession: AdminSession\n  operationId: string\n  version?: string\n}\n\n/**\n * Fetches a single bulk operation by ID.\n *\n * @param options - The admin session, operation ID, and optional API version.\n * @returns The bulk operation, or null if it doesn't exist.\n */\nexport async function fetchBulkOperationById(\n  options: FetchBulkOperationByIdOptions,\n): Promise<GetBulkOperationByIdQuery['bulkOperation']> {\n  const {adminSession, operationId, version} = options\n\n  const response = await adminRequestDoc<GetBulkOperationByIdQuery, {id: string}>({\n    query: GetBulkOperationById,\n    session: adminSession,\n    variables: {id: operationId},\n    version: version ?? BULK_OPERATIONS_MIN_API_VERSION,\n  })\n\n  return response.bulkOperation\n}\n\ninterface FetchRecentBulkOperationsOptions {\n  adminSession: AdminSession\n  version?: string\n  /** Number of days back to include. Defaults to 7. */\n  sinceDays?: number\n  /** Maximum number of operations to return. Defaults to 100. */\n  first?: number\n}\n\n/**\n * Fetches recent bulk operations for the store.\n *\n * @param options - The admin session, optional API version, look-back window, and page size.\n * @returns The list of bulk operation nodes, most recent first.\n */\nexport async function fetchRecentBulkOperations(\n  options: FetchRecentBulkOperationsOptions,\n): Promise<ListBulkOperationsQuery['bulkOperations']['nodes']> {\n  const {adminSession, version, sinceDays = 7, first = 100} = options\n\n  const since = new Date(Date.now() - sinceDays * 24 * 60 * 60 * 1000).toISOString().split('T')[0]\n\n  const response = await adminRequestDoc<ListBulkOperationsQuery, ListBulkOperationsQueryVariables>({\n    query: ListBulkOperations,\n    session: adminSession,\n    variables: {\n      query: `created_at:>=${since}`,\n      first,\n      sortKey: 'CREATED_AT',\n    },\n    version: version ?? BULK_OPERATIONS_MIN_API_VERSION,\n  })\n\n  return response.bulkOperations.nodes\n}\n"]}

package/dist/public/node/api/bulk-operations/format-bulk-operation-status.d.ts

@@ -0,0 +1,45 @@
+import { GetBulkOperationByIdQuery } from '../../../../cli/api/graphql/bulk-operations/generated/get-bulk-operation-by-id.js';
+import { TokenizedString } from '../../output.js';
+import { TokenItem } from '../../ui.js';
+/**
+ * Produces a human-readable status line for a bulk operation.
+ *
+ * @param operation - The bulk operation.
+ * @returns A tokenized status string.
+ */
+export declare function formatBulkOperationStatus(operation: NonNullable<GetBulkOperationByIdQuery['bulkOperation']>): TokenizedString;
+interface UserError {
+    field?: string[] | null;
+    message: string;
+}
+/**
+ * Renders a list of bulk operation user errors.
+ *
+ * @param userErrors - The user errors to render.
+ * @param headline - The headline for the error block.
+ */
+export declare function renderBulkOperationUserErrors(userErrors: UserError[], headline: string): void;
+export interface BulkOperationCancellationResult {
+    headline: string;
+    body?: TokenItem;
+    customSections?: {
+        body: {
+            list: {
+                items: string[];
+            };
+        }[];
+    }[];
+    renderType: 'success' | 'warning' | 'info';
+}
+/**
+ * Classifies the outcome of a cancellation request into a renderable payload.
+ *
+ * The engine intentionally stays command-agnostic: for an in-progress cancellation it returns just
+ * the headline and render type, leaving each command to append its own "check status" hint (which
+ * references that command's own `bulk status` invocation).
+ *
+ * @param operation - The bulk operation after the cancel request.
+ * @returns The headline, body, sections, and render type to use.
+ */
+export declare function formatBulkOperationCancellationResult(operation: NonNullable<GetBulkOperationByIdQuery['bulkOperation']>): BulkOperationCancellationResult;
+export {};

package/dist/public/node/api/bulk-operations/format-bulk-operation-status.js

@@ -0,0 +1,91 @@
+import { outputContent, outputToken } from '../../output.js';
+import { renderError } from '../../ui.js';
+/**
+ * Produces a human-readable status line for a bulk operation.
+ *
+ * @param operation - The bulk operation.
+ * @returns A tokenized status string.
+ */
+export function formatBulkOperationStatus(operation) {
+    switch (operation.status) {
+        case 'RUNNING':
+            return outputContent `Bulk operation in progress${operation.objectCount > 0
+                ? outputToken.gray(` (${String(operation.objectCount)} objects ${operation.type === 'MUTATION' ? 'written' : 'read'})`)
+                : ''}`;
+        case 'CREATED':
+            return outputContent `Starting`;
+        case 'COMPLETED':
+            return outputContent `Bulk operation succeeded: ${outputToken.gray(`${String(operation.objectCount)} objects`)}`;
+        case 'FAILED':
+            return outputContent `Bulk operation failed. ${outputToken.errorText(`Error: ${operation.errorCode ?? 'unknown'}`)}`;
+        case 'CANCELING':
+            return outputContent `Bulk operation canceling...`;
+        case 'CANCELED':
+            return outputContent `Bulk operation canceled.`;
+        case 'EXPIRED':
+            return outputContent `Bulk operation expired.`;
+        default:
+            return outputContent `Bulk operation status: ${operation.status}`;
+    }
+}
+/**
+ * Renders a list of bulk operation user errors.
+ *
+ * @param userErrors - The user errors to render.
+ * @param headline - The headline for the error block.
+ */
+export function renderBulkOperationUserErrors(userErrors, headline) {
+    const errorMessages = userErrors
+        .map((error) => outputContent `${error.field?.join('.') ?? 'unknown'}: ${error.message}`.value)
+        .join('\n');
+    renderError({
+        headline,
+        body: errorMessages,
+    });
+}
+/**
+ * Classifies the outcome of a cancellation request into a renderable payload.
+ *
+ * The engine intentionally stays command-agnostic: for an in-progress cancellation it returns just
+ * the headline and render type, leaving each command to append its own "check status" hint (which
+ * references that command's own `bulk status` invocation).
+ *
+ * @param operation - The bulk operation after the cancel request.
+ * @returns The headline, body, sections, and render type to use.
+ */
+export function formatBulkOperationCancellationResult(operation) {
+    const headline = formatBulkOperationStatus(operation).value;
+    switch (operation.status) {
+        case 'CANCELING':
+            return {
+                headline: 'Bulk operation is being cancelled.',
+                renderType: 'success',
+            };
+        case 'CANCELED':
+        case 'COMPLETED':
+        case 'FAILED': {
+            const items = [
+                outputContent `ID: ${outputToken.cyan(operation.id)}`.value,
+                outputContent `Status: ${outputToken.yellow(operation.status)}`.value,
+                outputContent `Created at: ${outputToken.gray(String(operation.createdAt))}`.value,
+                ...(operation.completedAt
+                    ? [outputContent `Completed at: ${outputToken.gray(String(operation.completedAt))}`.value]
+                    : []),
+            ];
+            return {
+                headline: outputContent `Bulk operation is already ${operation.status.toLowerCase()}.`.value,
+                body: outputContent `This operation has already finished and can't be canceled.`.value,
+                customSections: [{ body: [{ list: { items } }] }],
+                renderType: 'warning',
+            };
+        }
+        case 'CREATED':
+        case 'EXPIRED':
+        case 'RUNNING':
+            return {
+                headline,
+                renderType: 'info',
+            };
+    }
+}
+//# sourceMappingURL=format-bulk-operation-status.js.map

package/dist/public/node/api/bulk-operations/format-bulk-operation-status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-bulk-operation-status.js","sourceRoot":"","sources":["../../../../../src/public/node/api/bulk-operations/format-bulk-operation-status.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAE,WAAW,EAAkB,MAAM,iBAAiB,CAAA;AAC3E,OAAO,EAAC,WAAW,EAAY,MAAM,aAAa,CAAA;AAElD;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CACvC,SAAkE;IAElE,QAAQ,SAAS,CAAC,MAAM,EAAE,CAAC;QACzB,KAAK,SAAS;YACZ,OAAO,aAAa,CAAA,6BACjB,SAAS,CAAC,WAAsB,GAAG,CAAC;gBACnC,CAAC,CAAC,WAAW,CAAC,IAAI,CACd,KAAK,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,YAAY,SAAS,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,GAAG,CACpG;gBACH,CAAC,CAAC,EACN,EAAE,CAAA;QACJ,KAAK,SAAS;YACZ,OAAO,aAAa,CAAA,UAAU,CAAA;QAChC,KAAK,WAAW;YACd,OAAO,aAAa,CAAA,6BAA6B,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAA;QACjH,KAAK,QAAQ;YACX,OAAO,aAAa,CAAA,0BAA0B,WAAW,CAAC,SAAS,CACjE,UAAU,SAAS,CAAC,SAAS,IAAI,SAAS,EAAE,CAC7C,EAAE,CAAA;QACL,KAAK,WAAW;YACd,OAAO,aAAa,CAAA,6BAA6B,CAAA;QACnD,KAAK,UAAU;YACb,OAAO,aAAa,CAAA,0BAA0B,CAAA;QAChD,KAAK,SAAS;YACZ,OAAO,aAAa,CAAA,yBAAyB,CAAA;QAC/C;YACE,OAAO,aAAa,CAAA,0BAA0B,SAAS,CAAC,MAAM,EAAE,CAAA;IACpE,CAAC;AACH,CAAC;AAOD;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAAC,UAAuB,EAAE,QAAgB;IACrF,MAAM,aAAa,GAAG,UAAU;SAC7B,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAA,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,SAAS,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC;SAC7F,IAAI,CAAC,IAAI,CAAC,CAAA;IAEb,WAAW,CAAC;QACV,QAAQ;QACR,IAAI,EAAE,aAAa;KACpB,CAAC,CAAA;AACJ,CAAC;AASD;;;;;;;;;GASG;AACH,MAAM,UAAU,qCAAqC,CACnD,SAAkE;IAElE,MAAM,QAAQ,GAAG,yBAAyB,CAAC,SAAS,CAAC,CAAC,KAAK,CAAA;IAE3D,QAAQ,SAAS,CAAC,MAAM,EAAE,CAAC;QACzB,KAAK,WAAW;YACd,OAAO;gBACL,QAAQ,EAAE,oCAAoC;gBAC9C,UAAU,EAAE,SAAS;aACtB,CAAA;QACH,KAAK,UAAU,CAAC;QAChB,KAAK,WAAW,CAAC;QACjB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,KAAK,GAAG;gBACZ,aAAa,CAAA,OAAO,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK;gBAC1D,aAAa,CAAA,WAAW,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK;gBACpE,aAAa,CAAA,eAAe,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,KAAK;gBACjF,GAAG,CAAC,SAAS,CAAC,WAAW;oBACvB,CAAC,CAAC,CAAC,aAAa,CAAA,iBAAiB,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC;oBACzF,CAAC,CAAC,EAAE,CAAC;aACR,CAAA;YACD,OAAO;gBACL,QAAQ,EAAE,aAAa,CAAA,6BAA6B,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,KAAK;gBAC3F,IAAI,EAAE,aAAa,CAAA,4DAA4D,CAAC,KAAK;gBACrF,cAAc,EAAE,CAAC,EAAC,IAAI,EAAE,CAAC,EAAC,IAAI,EAAE,EAAC,KAAK,EAAC,EAAC,CAAC,EAAC,CAAC;gBAC3C,UAAU,EAAE,SAAS;aACtB,CAAA;QACH,CAAC;QACD,KAAK,SAAS,CAAC;QACf,KAAK,SAAS,CAAC;QACf,KAAK,SAAS;YACZ,OAAO;gBACL,QAAQ;gBACR,UAAU,EAAE,MAAM;aACnB,CAAA;IACL,CAAC;AACH,CAAC","sourcesContent":["import {GetBulkOperationByIdQuery} from '../../../../cli/api/graphql/bulk-operations/generated/get-bulk-operation-by-id.js'\nimport {outputContent, outputToken, TokenizedString} from '../../output.js'\nimport {renderError, TokenItem} from '../../ui.js'\n\n/**\n * Produces a human-readable status line for a bulk operation.\n *\n * @param operation - The bulk operation.\n * @returns A tokenized status string.\n */\nexport function formatBulkOperationStatus(\n  operation: NonNullable<GetBulkOperationByIdQuery['bulkOperation']>,\n): TokenizedString {\n  switch (operation.status) {\n    case 'RUNNING':\n      return outputContent`Bulk operation in progress${\n        (operation.objectCount as number) > 0\n          ? outputToken.gray(\n              ` (${String(operation.objectCount)} objects ${operation.type === 'MUTATION' ? 'written' : 'read'})`,\n            )\n          : ''\n      }`\n    case 'CREATED':\n      return outputContent`Starting`\n    case 'COMPLETED':\n      return outputContent`Bulk operation succeeded: ${outputToken.gray(`${String(operation.objectCount)} objects`)}`\n    case 'FAILED':\n      return outputContent`Bulk operation failed. ${outputToken.errorText(\n        `Error: ${operation.errorCode ?? 'unknown'}`,\n      )}`\n    case 'CANCELING':\n      return outputContent`Bulk operation canceling...`\n    case 'CANCELED':\n      return outputContent`Bulk operation canceled.`\n    case 'EXPIRED':\n      return outputContent`Bulk operation expired.`\n    default:\n      return outputContent`Bulk operation status: ${operation.status}`\n  }\n}\n\ninterface UserError {\n  field?: string[] | null\n  message: string\n}\n\n/**\n * Renders a list of bulk operation user errors.\n *\n * @param userErrors - The user errors to render.\n * @param headline - The headline for the error block.\n */\nexport function renderBulkOperationUserErrors(userErrors: UserError[], headline: string): void {\n  const errorMessages = userErrors\n    .map((error) => outputContent`${error.field?.join('.') ?? 'unknown'}: ${error.message}`.value)\n    .join('\\n')\n\n  renderError({\n    headline,\n    body: errorMessages,\n  })\n}\n\nexport interface BulkOperationCancellationResult {\n  headline: string\n  body?: TokenItem\n  customSections?: {body: {list: {items: string[]}}[]}[]\n  renderType: 'success' | 'warning' | 'info'\n}\n\n/**\n * Classifies the outcome of a cancellation request into a renderable payload.\n *\n * The engine intentionally stays command-agnostic: for an in-progress cancellation it returns just\n * the headline and render type, leaving each command to append its own \"check status\" hint (which\n * references that command's own `bulk status` invocation).\n *\n * @param operation - The bulk operation after the cancel request.\n * @returns The headline, body, sections, and render type to use.\n */\nexport function formatBulkOperationCancellationResult(\n  operation: NonNullable<GetBulkOperationByIdQuery['bulkOperation']>,\n): BulkOperationCancellationResult {\n  const headline = formatBulkOperationStatus(operation).value\n\n  switch (operation.status) {\n    case 'CANCELING':\n      return {\n        headline: 'Bulk operation is being cancelled.',\n        renderType: 'success',\n      }\n    case 'CANCELED':\n    case 'COMPLETED':\n    case 'FAILED': {\n      const items = [\n        outputContent`ID: ${outputToken.cyan(operation.id)}`.value,\n        outputContent`Status: ${outputToken.yellow(operation.status)}`.value,\n        outputContent`Created at: ${outputToken.gray(String(operation.createdAt))}`.value,\n        ...(operation.completedAt\n          ? [outputContent`Completed at: ${outputToken.gray(String(operation.completedAt))}`.value]\n          : []),\n      ]\n      return {\n        headline: outputContent`Bulk operation is already ${operation.status.toLowerCase()}.`.value,\n        body: outputContent`This operation has already finished and can't be canceled.`.value,\n        customSections: [{body: [{list: {items}}]}],\n        renderType: 'warning',\n      }\n    }\n    case 'CREATED':\n    case 'EXPIRED':\n    case 'RUNNING':\n      return {\n        headline,\n        renderType: 'info',\n      }\n  }\n}\n"]}

package/dist/public/node/api/bulk-operations/helpers.d.ts

@@ -0,0 +1,51 @@
+import { AdminSession } from '../../session.js';
+/**
+ * Normalizes a bulk operation ID to a GID.
+ *
+ * @param id - A numeric ID or a full GID.
+ * @returns The GID form of the ID.
+ */
+export declare function normalizeBulkOperationId(id: string): string;
+/**
+ * Extracts the numeric ID from a bulk operation GID.
+ *
+ * @param gid - A GID like "gid://shopify/BulkOperation/123".
+ * @returns The numeric ID, or the original string if it isn't a recognized GID.
+ */
+export declare function extractBulkOperationId(gid: string): string;
+/**
+ * Validates that a GraphQL document contains exactly one operation definition.
+ *
+ * @param graphqlOperation - The GraphQL query or mutation string to validate.
+ * @throws AbortError if the document doesn't contain exactly one operation or has syntax errors.
+ */
+export declare function validateSingleOperation(graphqlOperation: string): void;
+/**
+ * Checks if a GraphQL operation is a mutation.
+ *
+ * @param graphqlOperation - The GraphQL query or mutation string to check.
+ * @returns True if the operation is a mutation, false otherwise.
+ * @throws AbortError if the operation has invalid GraphQL syntax.
+ */
+export declare function isMutation(graphqlOperation: string): boolean;
+/**
+ * Options for resolving an API version.
+ */
+interface ResolveApiVersionOptions {
+    /** Admin session containing store credentials. */
+    adminSession: AdminSession;
+    /** The API version specified by the user. */
+    userSpecifiedVersion?: string;
+    /** Optional minimum version to use as a fallback when no version is specified. */
+    minimumDefaultVersion?: string;
+}
+/**
+ * Determines the API version to use based on the user provided version and the available versions.
+ * The 'unstable' version is always allowed without validation.
+ *
+ * @param options - Options for resolving the API version.
+ * @returns The resolved API version.
+ * @throws AbortError if the provided version is not allowed.
+ */
+export declare function resolveApiVersion(options: ResolveApiVersionOptions): Promise<string>;
+export {};

package/dist/public/node/api/bulk-operations/helpers.js

@@ -0,0 +1,110 @@
+import { fetchApiVersions } from '../admin.js';
+import { AbortError } from '../../error.js';
+import { outputContent } from '../../output.js';
+import { parse } from 'graphql';
+/**
+ * Normalizes a bulk operation ID to a GID.
+ *
+ * @param id - A numeric ID or a full GID.
+ * @returns The GID form of the ID.
+ */
+export function normalizeBulkOperationId(id) {
+    // If already a GID, return as-is
+    if (id.startsWith('gid://')) {
+        return id;
+    }
+    // If numeric, convert to GID
+    if (/^\d+$/.test(id)) {
+        return `gid://shopify/BulkOperation/${id}`;
+    }
+    // Otherwise return as-is (let API handle any errors)
+    return id;
+}
+/**
+ * Extracts the numeric ID from a bulk operation GID.
+ *
+ * @param gid - A GID like "gid://shopify/BulkOperation/123".
+ * @returns The numeric ID, or the original string if it isn't a recognized GID.
+ */
+export function extractBulkOperationId(gid) {
+    const match = gid.match(/^gid:\/\/shopify\/BulkOperation\/(\d+)$/);
+    return match?.[1] ?? gid;
+}
+/**
+ * Validates that a GraphQL document contains exactly one operation definition.
+ *
+ * @param graphqlOperation - The GraphQL query or mutation string to validate.
+ * @throws AbortError if the document doesn't contain exactly one operation or has syntax errors.
+ */
+export function validateSingleOperation(graphqlOperation) {
+    let document;
+    try {
+        document = parse(graphqlOperation);
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            throw new AbortError(`Invalid GraphQL syntax: ${error.message}`);
+        }
+        throw error;
+    }
+    const operationDefinitions = document.definitions.filter((def) => def.kind === 'OperationDefinition');
+    if (operationDefinitions.length !== 1) {
+        throw new AbortError('GraphQL document must contain exactly one operation definition. Multiple operations are not supported.');
+    }
+}
+/**
+ * Checks if a GraphQL operation is a mutation.
+ *
+ * @param graphqlOperation - The GraphQL query or mutation string to check.
+ * @returns True if the operation is a mutation, false otherwise.
+ * @throws AbortError if the operation has invalid GraphQL syntax.
+ */
+export function isMutation(graphqlOperation) {
+    let document;
+    try {
+        document = parse(graphqlOperation);
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            throw new AbortError(`Invalid GraphQL syntax: ${error.message}`);
+        }
+        throw error;
+    }
+    const operationDefinition = document.definitions.find((def) => def.kind === 'OperationDefinition');
+    return operationDefinition?.operation === 'mutation';
+}
+/**
+ * Determines the API version to use based on the user provided version and the available versions.
+ * The 'unstable' version is always allowed without validation.
+ *
+ * @param options - Options for resolving the API version.
+ * @returns The resolved API version.
+ * @throws AbortError if the provided version is not allowed.
+ */
+export async function resolveApiVersion(options) {
+    const { adminSession, userSpecifiedVersion, minimumDefaultVersion } = options;
+    if (userSpecifiedVersion === 'unstable')
+        return userSpecifiedVersion;
+    const availableVersions = await fetchApiVersions(adminSession);
+    if (!userSpecifiedVersion) {
+        // Return the most recent supported version, or minimumDefaultVersion if specified, whichever is newer.
+        const supportedVersions = availableVersions.filter((version) => version.supported).map((version) => version.handle);
+        if (minimumDefaultVersion) {
+            supportedVersions.push(minimumDefaultVersion);
+        }
+        const latest = supportedVersions.sort().reverse()[0];
+        if (!latest) {
+            throw new AbortError('No supported API versions available for this store.');
+        }
+        return latest;
+    }
+    // Check if the user provided version is allowed. Unsupported versions (RC) are allowed here.
+    const versionList = availableVersions.map((version) => version.handle);
+    if (versionList.includes(userSpecifiedVersion))
+        return userSpecifiedVersion;
+    // Invalid user provided version.
+    const firstLine = outputContent `Invalid API version: ${userSpecifiedVersion}`.value;
+    const secondLine = outputContent `Allowed versions: ${versionList.join(', ')}`.value;
+    throw new AbortError(firstLine, secondLine);
+}
+//# sourceMappingURL=helpers.js.map

package/dist/public/node/api/bulk-operations/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../../../src/public/node/api/bulk-operations/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,gBAAgB,EAAC,MAAM,aAAa,CAAA;AAE5C,OAAO,EAAC,UAAU,EAAC,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAC,aAAa,EAAC,MAAM,iBAAiB,CAAA;AAC7C,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,EAAU;IACjD,iCAAiC;IACjC,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,EAAE,CAAA;IACX,CAAC;IAED,6BAA6B;IAC7B,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QACrB,OAAO,+BAA+B,EAAE,EAAE,CAAA;IAC5C,CAAC;IAED,qDAAqD;IACrD,OAAO,EAAE,CAAA;AACX,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,GAAW;IAChD,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,yCAAyC,CAAC,CAAA;IAClE,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAA;AAC1B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,gBAAwB;IAC9D,IAAI,QAAQ,CAAA;IACZ,IAAI,CAAC;QACH,QAAQ,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAA;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,MAAM,IAAI,UAAU,CAAC,2BAA2B,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;QAClE,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;IAED,MAAM,oBAAoB,GAAG,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,qBAAqB,CAAC,CAAA;IAErG,IAAI,oBAAoB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,UAAU,CAClB,wGAAwG,CACzG,CAAA;IACH,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,gBAAwB;IACjD,IAAI,QAAQ,CAAA;IACZ,IAAI,CAAC;QACH,QAAQ,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAA;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,MAAM,IAAI,UAAU,CAAC,2BAA2B,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;QAClE,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;IAED,MAAM,mBAAmB,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,qBAAqB,CAAC,CAAA;IAElG,OAAO,mBAAmB,EAAE,SAAS,KAAK,UAAU,CAAA;AACtD,CAAC;AAcD;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAC,OAAiC;IACvE,MAAM,EAAC,YAAY,EAAE,oBAAoB,EAAE,qBAAqB,EAAC,GAAG,OAAO,CAAA;IAE3E,IAAI,oBAAoB,KAAK,UAAU;QAAE,OAAO,oBAAoB,CAAA;IAEpE,MAAM,iBAAiB,GAAG,MAAM,gBAAgB,CAAC,YAAY,CAAC,CAAA;IAE9D,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC1B,uGAAuG;QACvG,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;QACnH,IAAI,qBAAqB,EAAE,CAAC;YAC1B,iBAAiB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAA;QAC/C,CAAC;QAED,MAAM,MAAM,GAAG,iBAAiB,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;QACpD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,UAAU,CAAC,qDAAqD,CAAC,CAAA;QAC7E,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED,6FAA6F;IAC7F,MAAM,WAAW,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;IACtE,IAAI,WAAW,CAAC,QAAQ,CAAC,oBAAoB,CAAC;QAAE,OAAO,oBAAoB,CAAA;IAE3E,iCAAiC;IACjC,MAAM,SAAS,GAAG,aAAa,CAAA,wBAAwB,oBAAoB,EAAE,CAAC,KAAK,CAAA;IACnF,MAAM,UAAU,GAAG,aAAa,CAAA,qBAAqB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAA;IACnF,MAAM,IAAI,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;AAC7C,CAAC","sourcesContent":["import {fetchApiVersions} from '../admin.js'\nimport {AdminSession} from '../../session.js'\nimport {AbortError} from '../../error.js'\nimport {outputContent} from '../../output.js'\nimport {parse} from 'graphql'\n\n/**\n * Normalizes a bulk operation ID to a GID.\n *\n * @param id - A numeric ID or a full GID.\n * @returns The GID form of the ID.\n */\nexport function normalizeBulkOperationId(id: string): string {\n  // If already a GID, return as-is\n  if (id.startsWith('gid://')) {\n    return id\n  }\n\n  // If numeric, convert to GID\n  if (/^\\d+$/.test(id)) {\n    return `gid://shopify/BulkOperation/${id}`\n  }\n\n  // Otherwise return as-is (let API handle any errors)\n  return id\n}\n\n/**\n * Extracts the numeric ID from a bulk operation GID.\n *\n * @param gid - A GID like \"gid://shopify/BulkOperation/123\".\n * @returns The numeric ID, or the original string if it isn't a recognized GID.\n */\nexport function extractBulkOperationId(gid: string): string {\n  const match = gid.match(/^gid:\\/\\/shopify\\/BulkOperation\\/(\\d+)$/)\n  return match?.[1] ?? gid\n}\n\n/**\n * Validates that a GraphQL document contains exactly one operation definition.\n *\n * @param graphqlOperation - The GraphQL query or mutation string to validate.\n * @throws AbortError if the document doesn't contain exactly one operation or has syntax errors.\n */\nexport function validateSingleOperation(graphqlOperation: string): void {\n  let document\n  try {\n    document = parse(graphqlOperation)\n  } catch (error) {\n    if (error instanceof Error) {\n      throw new AbortError(`Invalid GraphQL syntax: ${error.message}`)\n    }\n    throw error\n  }\n\n  const operationDefinitions = document.definitions.filter((def) => def.kind === 'OperationDefinition')\n\n  if (operationDefinitions.length !== 1) {\n    throw new AbortError(\n      'GraphQL document must contain exactly one operation definition. Multiple operations are not supported.',\n    )\n  }\n}\n\n/**\n * Checks if a GraphQL operation is a mutation.\n *\n * @param graphqlOperation - The GraphQL query or mutation string to check.\n * @returns True if the operation is a mutation, false otherwise.\n * @throws AbortError if the operation has invalid GraphQL syntax.\n */\nexport function isMutation(graphqlOperation: string): boolean {\n  let document\n  try {\n    document = parse(graphqlOperation)\n  } catch (error) {\n    if (error instanceof Error) {\n      throw new AbortError(`Invalid GraphQL syntax: ${error.message}`)\n    }\n    throw error\n  }\n\n  const operationDefinition = document.definitions.find((def) => def.kind === 'OperationDefinition')\n\n  return operationDefinition?.operation === 'mutation'\n}\n\n/**\n * Options for resolving an API version.\n */\ninterface ResolveApiVersionOptions {\n  /** Admin session containing store credentials. */\n  adminSession: AdminSession\n  /** The API version specified by the user. */\n  userSpecifiedVersion?: string\n  /** Optional minimum version to use as a fallback when no version is specified. */\n  minimumDefaultVersion?: string\n}\n\n/**\n * Determines the API version to use based on the user provided version and the available versions.\n * The 'unstable' version is always allowed without validation.\n *\n * @param options - Options for resolving the API version.\n * @returns The resolved API version.\n * @throws AbortError if the provided version is not allowed.\n */\nexport async function resolveApiVersion(options: ResolveApiVersionOptions): Promise<string> {\n  const {adminSession, userSpecifiedVersion, minimumDefaultVersion} = options\n\n  if (userSpecifiedVersion === 'unstable') return userSpecifiedVersion\n\n  const availableVersions = await fetchApiVersions(adminSession)\n\n  if (!userSpecifiedVersion) {\n    // Return the most recent supported version, or minimumDefaultVersion if specified, whichever is newer.\n    const supportedVersions = availableVersions.filter((version) => version.supported).map((version) => version.handle)\n    if (minimumDefaultVersion) {\n      supportedVersions.push(minimumDefaultVersion)\n    }\n\n    const latest = supportedVersions.sort().reverse()[0]\n    if (!latest) {\n      throw new AbortError('No supported API versions available for this store.')\n    }\n    return latest\n  }\n\n  // Check if the user provided version is allowed. Unsupported versions (RC) are allowed here.\n  const versionList = availableVersions.map((version) => version.handle)\n  if (versionList.includes(userSpecifiedVersion)) return userSpecifiedVersion\n\n  // Invalid user provided version.\n  const firstLine = outputContent`Invalid API version: ${userSpecifiedVersion}`.value\n  const secondLine = outputContent`Allowed versions: ${versionList.join(', ')}`.value\n  throw new AbortError(firstLine, secondLine)\n}\n"]}

package/dist/public/node/api/bulk-operations/query.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Inputs for resolving a bulk operation's GraphQL query.
+ */
+interface ResolveBulkOperationQueryInput {
+    /** Inline GraphQL operation string. */
+    query?: string;
+    /** Path to a file containing the GraphQL operation. */
+    queryFile?: string;
+}
+/**
+ * Resolves the GraphQL operation for a bulk command from either an inline `--query` value or a
+ * `--query-file` path, validating that it's non-empty and contains exactly one operation.
+ *
+ * Centralizes the read-and-validate logic shared by the app and store bulk execute commands.
+ *
+ * @param input - The inline query and/or the query file path (exactly one is expected).
+ * @returns The validated GraphQL operation string.
+ * @throws AbortError if the value/file is empty or missing, or the operation is invalid.
+ * @throws BugError if neither input was provided (oclif's exactlyOne constraint should prevent this).
+ */
+export declare function resolveBulkOperationQuery(input: ResolveBulkOperationQueryInput): Promise<string>;
+export {};

package/dist/public/node/api/bulk-operations/query.js

@@ -0,0 +1,40 @@
+import { validateSingleOperation } from './helpers.js';
+import { AbortError, BugError } from '../../error.js';
+import { fileExists, readFile } from '../../fs.js';
+import { outputContent, outputToken } from '../../output.js';
+/**
+ * Resolves the GraphQL operation for a bulk command from either an inline `--query` value or a
+ * `--query-file` path, validating that it's non-empty and contains exactly one operation.
+ *
+ * Centralizes the read-and-validate logic shared by the app and store bulk execute commands.
+ *
+ * @param input - The inline query and/or the query file path (exactly one is expected).
+ * @returns The validated GraphQL operation string.
+ * @throws AbortError if the value/file is empty or missing, or the operation is invalid.
+ * @throws BugError if neither input was provided (oclif's exactlyOne constraint should prevent this).
+ */
+export async function resolveBulkOperationQuery(input) {
+    let query;
+    if (input.query !== undefined) {
+        if (!input.query.trim()) {
+            throw new AbortError('The --query flag value is empty. Please provide a valid GraphQL query or mutation.');
+        }
+        query = input.query;
+    }
+    else if (input.queryFile) {
+        if (!(await fileExists(input.queryFile))) {
+            throw new AbortError(outputContent `Query file not found at ${outputToken.path(input.queryFile)}. Please check the path and try again.`);
+        }
+        const fileContents = await readFile(input.queryFile, { encoding: 'utf8' });
+        if (!fileContents.trim()) {
+            throw new AbortError(outputContent `Query file at ${outputToken.path(input.queryFile)} is empty. Please provide a valid GraphQL query or mutation.`);
+        }
+        query = fileContents;
+    }
+    else {
+        throw new BugError('Query should have been provided via --query or --query-file flags due to exactlyOne constraint. This indicates the oclif flag validation failed.');
+    }
+    validateSingleOperation(query);
+    return query;
+}
+//# sourceMappingURL=query.js.map

package/dist/public/node/api/bulk-operations/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../../../../../src/public/node/api/bulk-operations/query.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,uBAAuB,EAAC,MAAM,cAAc,CAAA;AACpD,OAAO,EAAC,UAAU,EAAE,QAAQ,EAAC,MAAM,gBAAgB,CAAA;AACnD,OAAO,EAAC,UAAU,EAAE,QAAQ,EAAC,MAAM,aAAa,CAAA;AAChD,OAAO,EAAC,aAAa,EAAE,WAAW,EAAC,MAAM,iBAAiB,CAAA;AAY1D;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAAC,KAAqC;IACnF,IAAI,KAAa,CAAA;IAEjB,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YACxB,MAAM,IAAI,UAAU,CAAC,oFAAoF,CAAC,CAAA;QAC5G,CAAC;QACD,KAAK,GAAG,KAAK,CAAC,KAAK,CAAA;IACrB,CAAC;SAAM,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,CAAC,MAAM,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,UAAU,CAClB,aAAa,CAAA,2BAA2B,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,wCAAwC,CAClH,CAAA;QACH,CAAC;QACD,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAA;QACxE,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,CAAC;YACzB,MAAM,IAAI,UAAU,CAClB,aAAa,CAAA,iBAAiB,WAAW,CAAC,IAAI,CAC5C,KAAK,CAAC,SAAS,CAChB,8DAA8D,CAChE,CAAA;QACH,CAAC;QACD,KAAK,GAAG,YAAY,CAAA;IACtB,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,QAAQ,CAChB,kJAAkJ,CACnJ,CAAA;IACH,CAAC;IAED,uBAAuB,CAAC,KAAK,CAAC,CAAA;IAE9B,OAAO,KAAK,CAAA;AACd,CAAC","sourcesContent":["import {validateSingleOperation} from './helpers.js'\nimport {AbortError, BugError} from '../../error.js'\nimport {fileExists, readFile} from '../../fs.js'\nimport {outputContent, outputToken} from '../../output.js'\n\n/**\n * Inputs for resolving a bulk operation's GraphQL query.\n */\ninterface ResolveBulkOperationQueryInput {\n  /** Inline GraphQL operation string. */\n  query?: string\n  /** Path to a file containing the GraphQL operation. */\n  queryFile?: string\n}\n\n/**\n * Resolves the GraphQL operation for a bulk command from either an inline `--query` value or a\n * `--query-file` path, validating that it's non-empty and contains exactly one operation.\n *\n * Centralizes the read-and-validate logic shared by the app and store bulk execute commands.\n *\n * @param input - The inline query and/or the query file path (exactly one is expected).\n * @returns The validated GraphQL operation string.\n * @throws AbortError if the value/file is empty or missing, or the operation is invalid.\n * @throws BugError if neither input was provided (oclif's exactlyOne constraint should prevent this).\n */\nexport async function resolveBulkOperationQuery(input: ResolveBulkOperationQueryInput): Promise<string> {\n  let query: string\n\n  if (input.query !== undefined) {\n    if (!input.query.trim()) {\n      throw new AbortError('The --query flag value is empty. Please provide a valid GraphQL query or mutation.')\n    }\n    query = input.query\n  } else if (input.queryFile) {\n    if (!(await fileExists(input.queryFile))) {\n      throw new AbortError(\n        outputContent`Query file not found at ${outputToken.path(input.queryFile)}. Please check the path and try again.`,\n      )\n    }\n    const fileContents = await readFile(input.queryFile, {encoding: 'utf8'})\n    if (!fileContents.trim()) {\n      throw new AbortError(\n        outputContent`Query file at ${outputToken.path(\n          input.queryFile,\n        )} is empty. Please provide a valid GraphQL query or mutation.`,\n      )\n    }\n    query = fileContents\n  } else {\n    throw new BugError(\n      'Query should have been provided via --query or --query-file flags due to exactlyOne constraint. This indicates the oclif flag validation failed.',\n    )\n  }\n\n  validateSingleOperation(query)\n\n  return query\n}\n"]}

package/dist/public/node/api/bulk-operations/run-mutation.d.ts

@@ -0,0 +1,16 @@
+import { BulkOperationRunMutationMutation } from '../../../../cli/api/graphql/bulk-operations/generated/bulk-operation-run-mutation.js';
+import { AdminSession } from '../../session.js';
+interface BulkOperationRunMutationOptions {
+    adminSession: AdminSession;
+    query: string;
+    variablesJsonl?: string;
+    version?: string;
+}
+/**
+ * Stages a JSONL variables file then starts a bulk mutation operation on the store.
+ *
+ * @param options - The admin session, mutation, JSONL variables, and optional API version.
+ * @returns The bulkOperationRunMutation result, including the created operation and any user errors.
+ */
+export declare function runBulkOperationMutation(options: BulkOperationRunMutationOptions): Promise<BulkOperationRunMutationMutation['bulkOperationRunMutation']>;
+export {};

package/dist/public/node/api/bulk-operations/run-mutation.js

@@ -0,0 +1,27 @@
+import { stageFile } from './stage-file.js';
+import { BulkOperationRunMutation as BulkOperationRunMutationDoc, } from '../../../../cli/api/graphql/bulk-operations/generated/bulk-operation-run-mutation.js';
+import { adminRequestDoc } from '../admin.js';
+/**
+ * Stages a JSONL variables file then starts a bulk mutation operation on the store.
+ *
+ * @param options - The admin session, mutation, JSONL variables, and optional API version.
+ * @returns The bulkOperationRunMutation result, including the created operation and any user errors.
+ */
+export async function runBulkOperationMutation(options) {
+    const { adminSession, query: mutation, variablesJsonl, version } = options;
+    const stagedUploadPath = await stageFile({
+        adminSession,
+        variablesJsonl,
+    });
+    const response = await adminRequestDoc({
+        query: BulkOperationRunMutationDoc,
+        session: adminSession,
+        variables: {
+            mutation,
+            stagedUploadPath,
+        },
+        ...(version && { version }),
+    });
+    return response.bulkOperationRunMutation;
+}
+//# sourceMappingURL=run-mutation.js.map

package/dist/public/node/api/bulk-operations/run-mutation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-mutation.js","sourceRoot":"","sources":["../../../../../src/public/node/api/bulk-operations/run-mutation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,SAAS,EAAC,MAAM,iBAAiB,CAAA;AACzC,OAAO,EACL,wBAAwB,IAAI,2BAA2B,GAGxD,MAAM,sFAAsF,CAAA;AAC7F,OAAO,EAAC,eAAe,EAAC,MAAM,aAAa,CAAA;AAU3C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,OAAwC;IAExC,MAAM,EAAC,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,EAAC,GAAG,OAAO,CAAA;IAExE,MAAM,gBAAgB,GAAG,MAAM,SAAS,CAAC;QACvC,YAAY;QACZ,cAAc;KACf,CAAC,CAAA;IAEF,MAAM,QAAQ,GAAG,MAAM,eAAe,CAA8E;QAClH,KAAK,EAAE,2BAA2B;QAClC,OAAO,EAAE,YAAY;QACrB,SAAS,EAAE;YACT,QAAQ;YACR,gBAAgB;SACjB;QACD,GAAG,CAAC,OAAO,IAAI,EAAC,OAAO,EAAC,CAAC;KAC1B,CAAC,CAAA;IAEF,OAAO,QAAQ,CAAC,wBAAwB,CAAA;AAC1C,CAAC","sourcesContent":["import {stageFile} from './stage-file.js'\nimport {\n  BulkOperationRunMutation as BulkOperationRunMutationDoc,\n  BulkOperationRunMutationMutation,\n  BulkOperationRunMutationMutationVariables,\n} from '../../../../cli/api/graphql/bulk-operations/generated/bulk-operation-run-mutation.js'\nimport {adminRequestDoc} from '../admin.js'\nimport {AdminSession} from '../../session.js'\n\ninterface BulkOperationRunMutationOptions {\n  adminSession: AdminSession\n  query: string\n  variablesJsonl?: string\n  version?: string\n}\n\n/**\n * Stages a JSONL variables file then starts a bulk mutation operation on the store.\n *\n * @param options - The admin session, mutation, JSONL variables, and optional API version.\n * @returns The bulkOperationRunMutation result, including the created operation and any user errors.\n */\nexport async function runBulkOperationMutation(\n  options: BulkOperationRunMutationOptions,\n): Promise<BulkOperationRunMutationMutation['bulkOperationRunMutation']> {\n  const {adminSession, query: mutation, variablesJsonl, version} = options\n\n  const stagedUploadPath = await stageFile({\n    adminSession,\n    variablesJsonl,\n  })\n\n  const response = await adminRequestDoc<BulkOperationRunMutationMutation, BulkOperationRunMutationMutationVariables>({\n    query: BulkOperationRunMutationDoc,\n    session: adminSession,\n    variables: {\n      mutation,\n      stagedUploadPath,\n    },\n    ...(version && {version}),\n  })\n\n  return response.bulkOperationRunMutation\n}\n"]}

package/dist/public/node/api/bulk-operations/run-query.d.ts

@@ -0,0 +1,15 @@
+import { BulkOperationRunQueryMutation } from '../../../../cli/api/graphql/bulk-operations/generated/bulk-operation-run-query.js';
+import { AdminSession } from '../../session.js';
+interface BulkOperationRunQueryOptions {
+    adminSession: AdminSession;
+    query: string;
+    version?: string;
+}
+/**
+ * Starts a bulk query operation on the store.
+ *
+ * @param options - The admin session, query, and optional API version.
+ * @returns The bulkOperationRunQuery result, including the created operation and any user errors.
+ */
+export declare function runBulkOperationQuery(options: BulkOperationRunQueryOptions): Promise<BulkOperationRunQueryMutation['bulkOperationRunQuery']>;
+export {};

package/dist/public/node/api/bulk-operations/run-query.js

@@ -0,0 +1,19 @@
+import { BulkOperationRunQuery, } from '../../../../cli/api/graphql/bulk-operations/generated/bulk-operation-run-query.js';
+import { adminRequestDoc } from '../admin.js';
+/**
+ * Starts a bulk query operation on the store.
+ *
+ * @param options - The admin session, query, and optional API version.
+ * @returns The bulkOperationRunQuery result, including the created operation and any user errors.
+ */
+export async function runBulkOperationQuery(options) {
+    const { adminSession, query, version } = options;
+    const response = await adminRequestDoc({
+        query: BulkOperationRunQuery,
+        session: adminSession,
+        variables: { query },
+        ...(version && { version }),
+    });
+    return response.bulkOperationRunQuery;
+}
+//# sourceMappingURL=run-query.js.map

package/dist/public/node/api/bulk-operations/run-query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run-query.js","sourceRoot":"","sources":["../../../../../src/public/node/api/bulk-operations/run-query.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,GAEtB,MAAM,mFAAmF,CAAA;AAC1F,OAAO,EAAC,eAAe,EAAC,MAAM,aAAa,CAAA;AAS3C;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,OAAqC;IAErC,MAAM,EAAC,YAAY,EAAE,KAAK,EAAE,OAAO,EAAC,GAAG,OAAO,CAAA;IAE9C,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAiD;QACrF,KAAK,EAAE,qBAAqB;QAC5B,OAAO,EAAE,YAAY;QACrB,SAAS,EAAE,EAAC,KAAK,EAAC;QAClB,GAAG,CAAC,OAAO,IAAI,EAAC,OAAO,EAAC,CAAC;KAC1B,CAAC,CAAA;IAEF,OAAO,QAAQ,CAAC,qBAAqB,CAAA;AACvC,CAAC","sourcesContent":["import {\n  BulkOperationRunQuery,\n  BulkOperationRunQueryMutation,\n} from '../../../../cli/api/graphql/bulk-operations/generated/bulk-operation-run-query.js'\nimport {adminRequestDoc} from '../admin.js'\nimport {AdminSession} from '../../session.js'\n\ninterface BulkOperationRunQueryOptions {\n  adminSession: AdminSession\n  query: string\n  version?: string\n}\n\n/**\n * Starts a bulk query operation on the store.\n *\n * @param options - The admin session, query, and optional API version.\n * @returns The bulkOperationRunQuery result, including the created operation and any user errors.\n */\nexport async function runBulkOperationQuery(\n  options: BulkOperationRunQueryOptions,\n): Promise<BulkOperationRunQueryMutation['bulkOperationRunQuery']> {\n  const {adminSession, query, version} = options\n\n  const response = await adminRequestDoc<BulkOperationRunQueryMutation, {query: string}>({\n    query: BulkOperationRunQuery,\n    session: adminSession,\n    variables: {query},\n    ...(version && {version}),\n  })\n\n  return response.bulkOperationRunQuery\n}\n"]}

package/dist/public/node/api/bulk-operations/stage-file.d.ts

@@ -0,0 +1,13 @@
+import { AdminSession } from '../../session.js';
+interface StageFileOptions {
+    adminSession: AdminSession;
+    variablesJsonl?: string;
+}
+/**
+ * Uploads bulk mutation variables to a staged upload target and returns the staged upload key.
+ *
+ * @param options - The admin session and JSONL variables.
+ * @returns The staged upload key used as `stagedUploadPath` for the bulk mutation.
+ */
+export declare function stageFile(options: StageFileOptions): Promise<string>;
+export {};