@sixtyninecommerce/admin 0.7.0 → 0.9.0

package/dist/hooks/assignments.js

@@ -0,0 +1,53 @@
+export const ASSIGNMENT_FIELDS = /* GraphQL */ `
+  id
+  kind
+  installationId
+  appSlug
+  locationId
+  paymentMethodId
+  createdAt
+  removedAt
+`;
+export const LIST_QUERY = /* GraphQL */ `
+  query AppProviderAssignments($kind: String) {
+    appProviderAssignments(kind: $kind) { ${ASSIGNMENT_FIELDS} }
+  }
+`;
+export const ASSIGN_MUTATION = /* GraphQL */ `
+  mutation AssignAppProvider($input: AssignAppProviderInput!) {
+    assignAppProvider(input: $input) { ${ASSIGNMENT_FIELDS} }
+  }
+`;
+export const UNASSIGN_MUTATION = /* GraphQL */ `
+  mutation UnassignAppProvider($id: ID!) {
+    unassignAppProvider(id: $id) { ${ASSIGNMENT_FIELDS} }
+  }
+`;
+export function createAppProviderAssignmentsModule(transport) {
+    return {
+        async list(options) {
+            const data = await transport.graphql({ api: 'admin', query: LIST_QUERY, variables: { kind: options?.kind ?? null } }, options);
+            return data.appProviderAssignments;
+        },
+        async assign(input, options) {
+            const data = await transport.graphql({
+                api: 'admin',
+                query: ASSIGN_MUTATION,
+                variables: {
+                    input: {
+                        installationId: input.installationId,
+                        kind: input.kind,
+                        locationId: input.locationId ?? null,
+                        paymentMethod: input.paymentMethod ?? null,
+                        idempotencyKey: options?.idempotencyKey ?? null,
+                    },
+                },
+            }, options);
+            return data.assignAppProvider;
+        },
+        async unassign(id, options) {
+            const data = await transport.graphql({ api: 'admin', query: UNASSIGN_MUTATION, variables: { id } }, options);
+            return data.unassignAppProvider;
+        },
+    };
+}

package/dist/hooks/index.d.ts

@@ -0,0 +1,97 @@
+import type { Transport } from '@sixtyninecommerce/core';
+import { type AppInstallation } from '../apps/index.js';
+import type { Call } from '../types.js';
+import { type AppProviderAssignmentsModule } from './assignments.js';
+/** The answer to one hook ping. */
+export interface AppHookPing {
+    /** True when the app answered any 2xx within its kind's budget. */
+    ok: boolean;
+    /**
+     * Why not: `timeout`, `network`, `tls`, `redirect`, `http_status`, `private_host`,
+     * `suspended` or `not_configured`. Null when `ok`.
+     */
+    reason: string | null;
+    /** The status the app answered, when it answered one. */
+    httpStatus: number | null;
+    durationMs: number;
+}
+/** One hook kind's health on one installation (spec §8.14, §15.19). */
+export interface AppHookHealth {
+    /** `order.validate` | `shipping.rates` | `tax.calculate` | `payment.provider` | `fulfillment.service`. */
+    kind: string;
+    /**
+     * `healthy` | `unhealthy`. Unhealthy: 20 failures in a row, and the platform
+     * no longer calls the hook until it is re-enabled ({@link HooksModule.reenable}).
+     * A validation, payment or tax hook then keeps checkout CLOSED (tax refuses
+     * placement) until the app is re-enabled or the store suspends the
+     * installation ({@link HooksModule.suspend}); a rates hook falls back to the
+     * platform's methods and a fulfilment request stays pending.
+     */
+    state: string;
+    /** Failures in a row; any answer (including a business "no") resets it. */
+    consecutiveFailures: number;
+    /** ISO-8601 with offset. */
+    lastFailureAt: string | null;
+    /** `timeout` | `network` | `tls` | `redirect` | `http_status` | `invalid_response` | `private_host`. */
+    lastFailureReason: string | null;
+    /** ISO-8601 with offset; accurate to a minute. */
+    lastSuccessAt: string | null;
+    /** ISO-8601 with offset; null while healthy. */
+    suspendedAt: string | null;
+}
+/**
+ * App hooks (spec §8.14, §9.2 `hooks`): the platform calling an installed app
+ * synchronously — validation, rates, tax, payment, fulfilment — signed with the
+ * installation's hook secret, bounded by a budget per kind, never redirected,
+ * and audited (`admin.audit.calls({ integration: 'app_hook' })`).
+ */
+export interface HooksModule {
+    /** Which installation is the store's tax, payment or fulfillment provider. */
+    assignments: AppProviderAssignmentsModule;
+    /**
+     * Send a signed ping to one hook of an installation, as the platform would
+     * call it: same signature, budget, SSRF guard and audit row. Needs
+     * `InstallApps`. Refused `HOOK_NOT_FOUND` when the installation is not on this
+     * store or has no consented hook of `kind`, `HOOK_KIND_INVALID` for an unknown kind.
+     */
+    ping(installationId: string, kind: string, options?: Call): Promise<AppHookPing>;
+    /**
+     * The health of every hook kind the installation consented to. Readable by
+     * the installation itself (its own credential) or an `InstallApps` admin of
+     * its store; any other installation id reads `HOOK_NOT_FOUND`.
+     */
+    health(installationId: string, options?: Call): Promise<AppHookHealth[]>;
+    /**
+     * Re-enable hook kinds suspended for health — each only after a signed ping
+     * of that kind succeeds, so fix the app first. `kind` omitted = every
+     * suspended kind. The installation itself or an `InstallApps` admin.
+     *
+     * Refused `HOOK_STILL_FAILING` (a `BusinessRuleError`, 422) when a ping fails;
+     * its message names each kind and why, and the kinds whose ping passed are
+     * re-enabled anyway. `INSTALLATION_NOT_ACTIVE` when the store has suspended
+     * the installation: {@link HooksModule.resume} it first. Answers the
+     * installation's health. One attempt: it calls the app.
+     */
+    reenable(installationId: string, kind?: string | null, options?: Omit<Call, 'idempotencyKey'>): Promise<AppHookHealth[]>;
+    /**
+     * Suspend an installation on this store — the escape when its hook blocks
+     * checkout (spec §15.19): every token dies, its hooks stop being called, its
+     * event deliveries pause. Grants and settings are kept; {@link resume} undoes
+     * it. `reason` (1-500 characters) goes to the audit trail. Idempotent.
+     * Needs `InstallApps`. Refused `INSTALLATION_NOT_ACTIVE` for an uninstalled
+     * installation, `INSTALLATION_SUSPENSION_REASON_INVALID` (a `ValidationError`)
+     * for a blank or long reason.
+     */
+    suspend(installationId: string, input: {
+        reason: string;
+    }, options?: Call): Promise<AppInstallation>;
+    /**
+     * Resume a suspended installation: back to `active`, or to `needs_consent`
+     * when the app's declarations grew meanwhile. The app mints fresh tokens.
+     * Hook kinds suspended for health stay suspended ({@link reenable}). Refused
+     * `INSTALLATION_NOT_SUSPENDED`. Needs `InstallApps`.
+     */
+    resume(installationId: string, options?: Call): Promise<AppInstallation>;
+}
+export declare function createHooksModule(transport: Transport): HooksModule;
+export type { AppProviderAssignment, AppProviderAssignmentsModule, AppProviderKind, AssignAppProviderInput, } from './assignments.js';

package/dist/hooks/index.js

@@ -0,0 +1,76 @@
+import { INSTALLATION_FIELDS } from '../apps/index.js';
+import { createAppProviderAssignmentsModule, } from './assignments.js';
+const HEALTH_FIELDS = /* GraphQL */ `
+  kind
+  state
+  consecutiveFailures
+  lastFailureAt
+  lastFailureReason
+  lastSuccessAt
+  suspendedAt
+`;
+const HEALTH_QUERY = /* GraphQL */ `
+  query AppHookHealth($installationId: ID!) {
+    appHookHealth(installationId: $installationId) { ${HEALTH_FIELDS} }
+  }
+`;
+const REENABLE_MUTATION = /* GraphQL */ `
+  mutation ReenableAppHooks($installationId: ID!, $kind: String) {
+    reenableAppHooks(installationId: $installationId, kind: $kind) { ${HEALTH_FIELDS} }
+  }
+`;
+const SUSPEND_MUTATION = /* GraphQL */ `
+  mutation SuspendAppInstallation($id: ID!, $reason: String!) {
+    suspendAppInstallation(id: $id, reason: $reason) { ${INSTALLATION_FIELDS} }
+  }
+`;
+const RESUME_MUTATION = /* GraphQL */ `
+  mutation ResumeAppInstallation($id: ID!) {
+    resumeAppInstallation(id: $id) { ${INSTALLATION_FIELDS} }
+  }
+`;
+const PING_MUTATION = /* GraphQL */ `
+  mutation PingAppHook($installationId: ID!, $kind: String!) {
+    pingAppHook(installationId: $installationId, kind: $kind) {
+      ok
+      reason
+      httpStatus
+      durationMs
+    }
+  }
+`;
+export function createHooksModule(transport) {
+    return {
+        assignments: createAppProviderAssignmentsModule(transport),
+        async ping(installationId, kind, options) {
+            const data = await transport.graphql({ api: 'admin', query: PING_MUTATION, variables: { installationId, kind } }, options);
+            return data.pingAppHook;
+        },
+        async health(installationId, options) {
+            const data = await transport.graphql({ api: 'admin', query: HEALTH_QUERY, variables: { installationId } }, options);
+            return data.appHookHealth;
+        },
+        async reenable(installationId, kind, options) {
+            // ONE attempt: each try pings the app (up to 10 s for a payment hook),
+            // and a retry after a lost answer only repeats what already happened.
+            const data = await transport.graphql({
+                api: 'admin',
+                query: REENABLE_MUTATION,
+                variables: { installationId, kind: kind ?? null },
+            }, { ...options, retry: { attempts: 1 } });
+            return data.reenableAppHooks;
+        },
+        async suspend(installationId, input, options) {
+            const data = await transport.graphql({
+                api: 'admin',
+                query: SUSPEND_MUTATION,
+                variables: { id: installationId, reason: input.reason },
+            }, options);
+            return data.suspendAppInstallation;
+        },
+        async resume(installationId, options) {
+            const data = await transport.graphql({ api: 'admin', query: RESUME_MUTATION, variables: { id: installationId } }, options);
+            return data.resumeAppInstallation;
+        },
+    };
+}

package/dist/index.d.ts

@@ -34,22 +34,56 @@ export type { DeprecationNotice, Page, PageMeta, RateLimitInfo, RetryPolicy, } f
  * it without adding a direct dependency on `@sixtyninecommerce/core` — which,
  * being transitive, pnpm would not resolve for them anyway.
  */
-export { APP_MANIFEST_SCHEMA, APP_MANIFEST_SCHEMA_SOURCE, AuthenticationError, BusinessRuleError, ConflictError, type ErrorDetail, NotFoundError, PermissionDeniedError, PlatformError, type ProblemDetails, RateLimitedError, TransportError, UpstreamError, ValidationError, } from '@sixtyninecommerce/core';
+/** Platform events: the webhook handler, the verifier and the payload types, from core. */
+export { APP_MANIFEST_SCHEMA, APP_MANIFEST_SCHEMA_SOURCE, AuthenticationError, BusinessRuleError, ConflictError, createEventHandler, type ErrorDetail, type EventFeedPage, type EventHandlerOptions, type EventHandlers, type EventStream, EventStreamClosedError, type EventStreamCloseReason, type EventStreamOptions, type EventStreamTicket, type EventStreamTicketOptions, type HookRefusalFacts, HookRejectedError, HookUnavailableError, isEventType, NotFoundError, PermissionDeniedError, PlatformError, type PlatformEventEnvelope, type PlatformEventPayloadByTypeV1, type PlatformEventTypeV1, type PollAllOptions, type PollOptions, type ProblemDetails, RateLimitedError, type ReplayOptions, TransportError, type TypedEnvelope, UpstreamError, ValidationError, verifyEventDelivery, } from '@sixtyninecommerce/core';
 export type { ApiTokensModule, CreatedApiToken } from './api-tokens/index.js';
 export type { AppCryptoKey, AppPrivateKey } from './apps/assertion.js';
 export type { AppInstallationConfig, AppInstallationConfigModule } from './apps/config.js';
 export type { AppCredential, AppCredentialConfig } from './apps/credential.js';
-export type { App, AppInstallation, ApproveConsentInput, AppsModule, InstallAppInput, } from './apps/index.js';
+export type { AppEventSubscription, AppEventSubscriptionModule, } from './apps/event-subscription.js';
+export type { AppHookSecret, AppHookSecretModule } from './apps/hook-secret.js';
+export type { App, AppInstallation, ApproveConsentInput, AppsModule, FieldGroupOwnerRef, InstallAppInput, } from './apps/index.js';
 export type { AuditCall, AuditCallFilter, AuditCorrelation, AuditEvent, AuditEventFilter, AuditModule, } from './audit/index.js';
 export type { AuthModule } from './auth/index.js';
+export type { BulkEntity, BulkExportOptions, BulkFile, BulkImportOptions, BulkMode, BulkModule, BulkOperation, BulkOperationStatus, BulkResultsFilter, BulkRow, BulkRowResult, BulkRowStatus, } from './bulk/index.js';
+export type { Asset, AssetDescription, AssetDescriptionsModule, AssetDescriptionsResult, AssetFile, AssetListOptions, AssetsModule, CreateAssetInput, UpdateAssetInput, } from './catalog/assets.js';
+export type { Collection, CollectionListOptions, CollectionsModule, CollectionTranslationInput, CreateCollectionInput, UpdateCollectionInput, } from './catalog/collections.js';
+export type { CreateFacetInput, CreateFacetValueInput, Facet, FacetListOptions, FacetsModule, FacetTranslationInput, FacetValue, UpdateFacetInput, UpdateFacetValueInput, } from './catalog/facets.js';
+export type { CatalogModule } from './catalog/index.js';
+export type { CreateOptionGroupInput, CreateOptionInput, OptionsModule, OptionTranslationInput, ProductOption, ProductOptionGroup, UpdateOptionGroupInput, UpdateOptionInput, } from './catalog/options.js';
+export type { AvailabilityInStoresInput, CreateProductInput, LocalCopyOriginalOutcome, LocalCopyResult, LocalCopySkuInput, OrganizationProductAvailabilityAction, OrganizationProductAvailabilityChange, OrganizationProductStoreAvailability, OrganizationProductStoreState, Product, ProductCollectionNotRemovedReason, ProductCollectionsResult, ProductListFilter, ProductListOptions, ProductOptionGroupRef, ProductOptionRef, ProductsModule, ProductTranslation, ProductTranslationInput, SetAvailabilityInStoresInput, UpdateProductInput, } from './catalog/products.js';
+export { MAX_AVAILABILITY_PRODUCTS, MAX_AVAILABILITY_STORES, MAX_PRODUCT_COLLECTION_IDS, MAX_STORE_EXCLUSION_PRODUCTS, } from './catalog/products.js';
+export type { ProductBulkAction, ProductBulkInput, ProductBulkRun, } from './catalog/products-bulk.js';
+export { MAX_BULK_PRODUCTS, PRODUCT_BULK_ACTIONS } from './catalog/products-bulk.js';
+export type { ContentFacetSyncResult, CreatePropertyGroupInput, CreatePropertyInput, ProductPropertyGroupValues, ProductPropertyValue, PropertiesModule, Property, PropertyConfig, PropertyFieldType, PropertyGroup, SetPropertyValueInput, UpdatePropertyGroupInput, UpdatePropertyInput, } from './catalog/properties.js';
+export type { AssetRef, Availability, AvailabilityInput, CatalogueOwnership, CatalogueOwnershipState, ConfigurableOperation, ConfigurableOperationInput, FacetValueRef, PriceBasis, ProductAvailabilityState, TranslationInput, VariantAvailabilityState, } from './catalog/types.js';
+export type { CreateProductVariantInput, InventoryFlag, ParcelPacking, ProductVariant, StockLevel, StockLevelInput, UpdateProductVariantInput, VariantPriceSource, VariantPriceSourceKind, VariantsModule, VariantTranslationInput, } from './catalog/variants.js';
+export { MAX_REVERT_PRICE_VARIANTS } from './catalog/variants.js';
+export type { ProductVisibility, ProductVisibilityMode, SetProductVisibilityInput, VisibilityModule, } from './catalog/visibility.js';
 export { type AdminClient, type AdminClientConfig, type AppAuthConfig, createAdminClient, type SessionConfig, } from './client.js';
+export type { AcknowledgeComplianceOptions, ComplianceAcknowledgement, ComplianceListOptions, ComplianceModule, ComplianceRequest, ComplianceRequestKind, } from './compliance/index.js';
 export type { Form, FormField, FormFieldInput, FormFieldTranslation, FormFieldTranslationInput, FormInput, FormsModule, FormTranslation, FormTranslationInput, } from './content/forms.js';
 export type { CustomObject, CustomObjectsModule } from './custom-objects/index.js';
-export type { CreateCustomerInput, CreatedCustomer, Customer, CustomerAddress, CustomerAddressesModule, CustomerErasureRecord, CustomerGroupRef, CustomerGroupsModule, CustomerInvitation, CustomerInviteMode, CustomersModule, EraseCustomerOptions, UpdateCustomerInput, } from './customers/index.js';
-export type { CreditNote, DocumentData, DocumentDataIssuer, DocumentDataLine, DocumentDataNumbering, DocumentDataParty, DocumentDataTaxRow, DocumentDataTotals, DocumentExtensionInput, DocumentExtensionSchema, DocumentExtensionsModule, DocumentLineInput, DocumentsModule, DocumentType, GenerateDocumentOptions, Invoice, IssuePartialCreditNoteInput, IssueSupplementaryInvoiceInput, PackingSlip, RegisterDocumentExtensionInput, SendInvoiceEmailInput, } from './documents/index.js';
+export type { ActAsCustomerOptions, CreateCustomerInput, CreatedCustomer, Customer, CustomerAddress, CustomerAddressesModule, CustomerAgentSession, CustomerErasureRecord, CustomerExternalRef, CustomerExternalRefKey, CustomerGroup, CustomerGroupRef, CustomerGroupsModule, CustomerInvitation, CustomerInviteMode, CustomersModule, EndedCustomerAgentSession, EraseCustomerOptions, ExternalKeyedCustomerGroup, InviteB2BCustomersOptions, InviteB2BCustomersResult, ReplacedCustomerGroupMembers, RequestCustomerDataOptions, UpdateCustomerInput, UpsertCustomerByExternalRefInput, UpsertedCustomer, UpsertedCustomerGroup, } from './customers/index.js';
+export { MAX_REPLACE_GROUP_MEMBERS } from './customers/index.js';
+export type { CommitInvoiceCorrectionCall, CreditNote, CreditNoteEmailSend, CustomerDocument, DocumentData, DocumentDataIssuer, DocumentDataLine, DocumentDataNumbering, DocumentDataParty, DocumentDataTaxRow, DocumentDataTotals, DocumentDownloadUrl, DocumentExtensionInput, DocumentExtensionSchema, DocumentExtensionsModule, DocumentLine, DocumentLineInput, DocumentsModule, DocumentType, GenerateDocumentOptions, Invoice, InvoiceAddressCorrection, InvoiceCorrectionCommit, InvoiceCorrectionCommittedDocument, InvoiceCorrectionDocument, InvoiceCorrectionInput, InvoiceCorrectionLedger, InvoiceCorrectionLine, InvoiceCorrectionOutcome, InvoiceCorrectionPlan, InvoiceCorrectionTotals, IssuePartialCreditNoteInput, IssueSupplementaryInvoiceInput, PackingSlip, RegisterDocumentExtensionInput, SendCreditNoteEmailInput, SendInvoiceEmailInput, } from './documents/index.js';
 export { MAX_DOCUMENT_EXTENSIONS } from './documents/index.js';
 export { AdminProjectionError } from './errors.js';
-export type { CreateHeadInput, Head, HeadsModule, UpdateHeadInput, } from './heads/index.js';
+export type { CreatedEventSubscription, EventDelivery, EventRedrive, EventSendTestOptions, EventSendTestResult, EventSubscription, EventSubscriptionInput, EventSubscriptionsModule, EventSubscriptionUpdate, EventsModule, RedriveAnswer, RedriveRequestState, RotatedEventSubscriptionSecret, } from './events/index.js';
+export { MAX_REDRIVE_EVENT_IDS } from './events/index.js';
+/**
+ * Product feeds — the merchandising surface that turns the catalogue into a
+ * Google, Meta, TikTok or Pinterest feed: the configurations, their rule ASTs,
+ * the runs and item issues the generator produces, the Google-taxonomy mapping
+ * and the two AI helpers.
+ */
+export type { BulkStatusUpdateResult, BulkUpdateCategoryMappingStatusInput, CategorySuggestEnqueueResult, CategorySuggestStatus, CreateFeedCategoryMappingInput, CreateFeedConfigInput, CreateFeedInternalFieldInput, CreateFeedLookupTableInput, FeedAiModule, FeedAiSuggestion, FeedAiSuggestionKind, FeedAiSuggestionStatus, FeedCategoryMapping, FeedCategoryMappingSource, FeedCategoryMappingStatus, FeedCategoryMappingsModule, FeedCategoryMatchType, FeedCategorySuggestState, FeedCategorySuggestSummary, FeedCondition, FeedConditionGroup, FeedConditionOperand, FeedConditionOperator, FeedConditionValue, FeedConfig, FeedConfigSettings, FeedConfigsModule, FeedDeliveryMode, FeedDestination, FeedDestinationKey, FeedDestinationTemplateEntry, FeedFieldMapping, FeedFieldRule, FeedFilterSpec, FeedIdentifierFieldSupport, FeedIdentifierFieldsModule, FeedInternalField, FeedInternalFieldRules, FeedInternalFieldSpec, FeedInternalFieldsModule, FeedItemIssue, FeedItemIssueSeverity, FeedLookupEntry, FeedLookupTable, FeedLookupTablesModule, FeedMappingSpec, FeedPerDestinationCategories, FeedPreview, FeedPreviewDraft, FeedPreviewIssue, FeedPreviewItem, FeedRegenerateResult, FeedRegenerateThrottle, FeedRun, FeedRunStats, FeedRunStatus, FeedRunTrigger, FeedsModule, FeedTaxonomyModule, FeedTaxonomyNode, FeedTransformSpec, FeedValueSource, GenerateTitlePresetInput, ListFeedCategoryMappingsOptions, ListFeedConfigsOptions, ListFeedIssuesOptions, ListFeedRunsOptions, RotateFeedTokenResult, SearchTaxonomyOptions, SuggestCategoryMappingsInput, TitlePresetExample, TitlePresetPayload, TitlePresetStatus, UpdateFeedCategoryMappingInput, UpdateFeedConfigInput, UpdateFeedInternalFieldInput, UpdateFeedLookupTableInput, } from './feeds/index.js';
+export { AI_UNAVAILABLE_CODE, DEFAULT_FEED_PAGE_LIMIT, DEFAULT_PREVIEW_SAMPLE_SIZE, DEFAULT_REFRESH_INTERVAL_MINUTES, FEED_CATEGORY_MAPPING_SOURCES, FEED_CATEGORY_MAPPING_STATUSES, FEED_CATEGORY_MATCH_TYPES, FEED_CONDITION_OPERATORS, FEED_DESTINATIONS, FEED_IDENTIFIER_PATTERN, FEED_ITEM_ISSUE_SEVERITIES, FEED_PREVIEW_TIMEOUT_MS, FEED_REGENERATE_THROTTLED, FEED_RUN_STATUSES, FEED_RUN_TRIGGERS, FEED_TRANSFORM_KINDS, FEED_VALUE_SOURCE_KINDS, isAiUnavailable, isFeedConditionGroup, isFeedValueSourceKind, MAX_BULK_STATUS_IDS, MAX_FEED_PAGE_LIMIT, MAX_LOOKUP_ENTRIES, MAX_PREVIEW_SAMPLE_SIZE, MAX_REFRESH_INTERVAL_MINUTES, MIN_REFRESH_INTERVAL_MINUTES, readFeedRegenerateThrottle, TAXONOMY_DEFAULT_LIMIT, TAXONOMY_MAX_LIMIT, TITLE_PRESET_TIMEOUT_MS, VALUELESS_FEED_CONDITION_OPERATORS, } from './feeds/index.js';
+export type { AppFulfillmentReportState, CancelFulfillmentInput, CancelledFulfillment, ChargedParcelCountInput, FulfillmentCancelChoice, FulfillmentCancelOverpayment, FulfillmentCancelPreview, FulfillmentCancelSettlement, FulfillmentLabel, FulfillmentLabelFormat, FulfillmentParcelTracking, FulfillmentsModule, LabelMyparcelParcelsInput, MyparcelParcelsLabelRequest, MyparcelRetractionVerdict, MyparcelUnretractedShipment, OrderFulfillmentParcels, OrderFulfillmentUnretractedShipments, ReportAppFulfillmentInput, ReportedAppFulfillment, WarehouseDemandRouting, } from './fulfillments/index.js';
+export type { CreateHeadInput, Head, HeadPrivateTokensModule, HeadStorefrontToken, HeadsModule, IssuedHeadStorefrontToken, UpdateHeadInput, } from './heads/index.js';
+export type { AppHookHealth, AppHookPing, AppProviderAssignment, AppProviderAssignmentsModule, AppProviderKind, AssignAppProviderInput, HooksModule, } from './hooks/index.js';
+export type { BulkActionItem, BulkActionRun, BulkActionRunStatus, } from './jobs/bulk-action-run.js';
+export { TERMINAL_BULK_ACTION_STATUSES } from './jobs/bulk-action-run.js';
 /**
  * `JobHandle` and `WaitOptions` are exported from here AND from
  * `./platform/provision-store.js`, which re-exports them: they used to live
@@ -63,18 +97,59 @@ export { OPENING_HOURS_DAYS } from './locations/index.js';
 export type { ApiTokenTemplate, JsonSchema, LabelMap, MetaCatalog, MetaCatalogLabels, MetaCatalogPermissions, MetaCatalogPlugins, MetaCatalogTransitions, MetaModule, PermissionGroup, PluginCatalogEntry, RoleTemplate, StatusMetaMap, StatusTone, TransitionMap, } from './meta/index.js';
 export type { Metafield, MetafieldAttachment, MetafieldDefinition, MetafieldDefinitionsModule, MetafieldMoney, MetafieldOwnerType, MetafieldReference, MetafieldScalarType, MetafieldsModule, MetafieldType, MetafieldVisibility, SetMetafieldInput, UpsertMetafieldDefinitionInput, } from './metafields/index.js';
 export { METAFIELD_OWNER_TYPES, METAFIELD_SCALAR_TYPES } from './metafields/index.js';
-export type { OrderSettlement, OrdersModule } from './orders/index.js';
-export type { SurchargeCall, SurchargedOrder, SurchargeInput, SurchargesModule, } from './orders/surcharges.js';
-export type { OrderPaymentPosition, PaidOrder, PaymentsModule, ProviderConnection, ProviderCredentialPath, ProviderOnboardingStart, ProviderReadiness, ProvidersModule, ProviderTerminal, ProviderTerminalsModule, ProvisionTerminalInput, ReadinessOptions, RecordPaymentInput, } from './payments/index.js';
+export type { CommitOrderEditCall, OrderCommitEditModule, OrderEditCommit, OrderEditCommittedOrder, OrderEditCommittedRefund, OrderEditOverpaymentSettlement, } from './orders/commit-edit.js';
+export type { Order, OrderAddress, OrderAfasFields, OrderAsset, OrderCustomer, OrderCustomerAddress, OrderCustomerAfasFields, OrderCustomerParasutFields, OrderCustomerVatFields, OrderCustomFields, OrderDeliveryAdvice, OrderDeliverySelectionSource, OrderDeliveryTerms, OrderDeliveryTermsStatus, OrderFor, OrderFulfillment, OrderFulfillmentDetails, OrderFulfillmentHold, OrderFulfillmentHoldReason, OrderFulfillmentMyparcelFields, OrderGetAnswer, OrderGetModule, OrderGetOptions, OrderHistoryEntry, OrderInclude, OrderLine, OrderLineAllocation, OrderLineCustomFields, OrderLineOutstandingAllocation, OrderLineStockLevel, OrderLineVariant, OrderPackingSlip, OrderParasutFields, OrderPayment, OrderPaymentTerms, OrderPaymentTermsClassification, OrderPaymentTermsFields, OrderPaymentTermsStatus, OrderPriceList, OrderRefund, OrderSurcharge, OrderTaxSummary, } from './orders/get.js';
+export { ORDER_INCLUDES } from './orders/get.js';
+export type { OrderProviderFallback, OrderSettlement, OrdersModule } from './orders/index.js';
+export type { LineNotPurchasableCode, LinePricePreview, LinePricePreviewBase, LinePriceStackingStep, NotPurchasableLinePricePreview, OrderLinePriceBasis, OrderLinePricePreviewModule, OrderLinePriceSource, PreviewLineDiscountType, PreviewLinePriceLine, PreviewLinePriceOverride, PreviewOneTimeDiscount, PurchasableLinePricePreview, } from './orders/line-price-preview.js';
+export type { DiscountPolicy, DiscountPolicyInput, DiscountPolicyModule, DiscountReason, DiscountReasonInput, DiscountReasonsModule, ManualDiscountsModule, OrderManualDiscount, } from './orders/manual-discounts.js';
+export type { LinePriceInput, OneTimeDiscountType, OneTimeLineDiscountInput, OneTimeOrderDiscountInput, OrderManualPricingModule, SetLinePricesInput, SetOneTimeDiscountsInput, } from './orders/manual-pricing.js';
+export type { ExternalLinePriceBasis, ExternalOrder, ExternalOrderAddressInput, ExternalOrderCall, ExternalOrderCatalogLine, ExternalOrderExternalLine, ExternalOrderFulfilment, ExternalOrderInput, ExternalOrderLine, ExternalOrderLineInput, ExternalOrderSurcharge, ExternalOrderSurchargeInput, ExternalOrderTargetState, ExternalOrderTaxLine, OrderEntryModule, } from './orders/order-entry.js';
+export type { OrderParcelCharge, OrderParcelChargeFulfillment, OrderParcelChargeModule, } from './orders/parcel-charge.js';
+export type { OrderEditAddress, OrderEditAddressPatch, OrderEditBlocker, OrderEditBlockerCode, OrderEditDiff, OrderEditDiscount, OrderEditDiscountType, OrderEditNotice, OrderEditNoticeCode, OrderEditOverpayment, OrderEditPayment, OrderEditPlan, OrderEditPreview, OrderEditPriceOverride, OrderEditRefund, OrderEditStep, OrderEditStepKind, OrderEditSurcharge, OrderEditTaxSummaryLine, OrderPlanEditModule, } from './orders/plan-edit.js';
+export type { OrderAllocationBadge, OrderEditBlockCode, OrderLockReason, OrderStatusAction, OrderStatusActionName, OrderStatusModule, OrderStatusProviderFallback, OrderStatusReasonCode, OrderStatusView, } from './orders/status.js';
+export { ORDER_ALLOCATION_BADGES, ORDER_EDIT_BLOCK_CODES, ORDER_LOCK_REASONS, ORDER_STATUS_ACTIONS, ORDER_STATUS_REASON_CODES, } from './orders/status.js';
+export type { OrderOverpaymentChoice, OverpaymentOption, SurchargeCall, SurchargeChange, SurchargeChangePreview, SurchargedOrder, SurchargeInput, SurchargeRemoveCall, SurchargesModule, } from './orders/surcharges.js';
+export type { AccountCreditModule, ApplyUnappliedCashInput, AppPayment, AppPaymentReportState, CreditOverpaymentInput, IssuedRefund, OrderMoneyOnAccount, OrderPaymentPosition, OrderRefundPosition, PaidOrder, PaymentsModule, ProviderConnection, ProviderCredentialPath, ProviderOnboardingStart, ProviderReadiness, ProvidersModule, ProviderTerminal, ProviderTerminalsModule, ProvisionTerminalInput, ReadinessOptions, ReconcileRefundInput, RecordPaymentInput, RefundablePayment, RefundPaymentInput, RefundProviderOutcome, RefundUnappliedCashInput, ReportAppPaymentInput, ReportedAppPayment, UnappliedCash, UnappliedCashRefund, UnreconciledRefund, } from './payments/index.js';
 export type { AppKey, PlatformAppsModule, RegisterAppResult, RegisteredApp, } from './platform/apps.js';
+export type { PlatformCatalogModule, RepairTranslationLanguagesInput, TranslationRepairEntity, TranslationRepairEntityKind, TranslationRepairNameMismatch, TranslationRepairPage, TranslationRepairRemovedRow, TranslationRepairSkipped, TranslationRepairSkipReason, } from './platform/catalog.js';
+export type { PlatformEntitlementSource, PlatformEntitlementsModule, PlatformPluginEntitlement, SetPlatformEntitlementOptions, } from './platform/entitlements.js';
 export { requireHumanSession } from './platform/guard.js';
+export type { CreateLegalEntityInput, LegalEntity, LegalEntityFields, LegalEntityListOptions, LegalEntityStore, PlatformLegalEntitiesModule, UpdateLegalEntityInput, } from './platform/legal-entities.js';
+export type { LegalEntityNumbering, LegalEntityNumberingSeries, LegalEntityNumberingSeriesName, PlatformLegalEntityNumberingModule, TenantLegalEntityNumberingModule, UpdateLegalEntityNumberingInput, } from './platform/legal-entity-numbering.js';
+export type { JoinOrganizationInput, OrganizationMembership, OrganizationMembershipMethods, } from './platform/organization-membership.js';
+export type { OrganizationSettingsMethods, OrganizationSettingsOverride, } from './platform/organization-settings.js';
+export type { OrganizationSettingsKindSwitchOff, OrganizationSettingsSwitchOff, OrganizationSharingKind, OrganizationSharingKindInput, OrganizationSharingKindState, OrganizationSharingModule, SetOrganizationSharingKindInput, } from './platform/organization-sharing.js';
+export type { CreateOrganizationInput, Organization, OrganizationAssortmentMode, OrganizationCustomerPolicy, OrganizationEntitlementsModule, OrganizationPluginEntitlement, PlatformOrganizationsModule, SetOrganizationEntitlementInput, UpdateOrganizationInput, } from './platform/organizations.js';
 export type { PlatformModule, ProvisionProfile, ProvisionRun, ProvisionRunStatus, ProvisionStep, ProvisionStepStatus, ProvisionStoreInput, ProvisionStoreResult, } from './platform/provision-store.js';
 export { PROVISION_PROFILES } from './platform/provision-store.js';
+export type { FleetChannelMetric, FleetReportInput, PlatformReportsModule, } from './platform/reports.js';
+export type { PlatformServerMetricsModule, ServerMetricPoint, ServerMetrics, ServerMetricsInput, ServerMetricsOverview, ServerMetricsRange, } from './platform/server-metrics.js';
+export type { CompletedPosSale, OpenPosSessionInput, PosCall, PosCart, PosCashModule, PosCashMovement, PosCashMovementType, PosDevice, PosDevicesModule, PosModule, PosMoneyCall, PosReceiptNumbering, PosReceiptNumberingModule, PosRefund, PosRefundsModule, PosRegister, PosRegisterSession, PosRegistersModule, PosSaleModule, PosSessionsModule, PosSessionTotals, PosTenderResult, PosTendersModule, PosXReport, } from './pos/index.js';
+export type { ActivePromotion, ActivePromotionsFilter, CreatePromotionInput, DiscountedOrderLine, LocalTime, OrderDiscount, OrderDiscounts, OrderPackage, PricingCouponsModule, PricingModule, PricingPromotion, PricingPromotionsModule, PromotionOperationSummary, PromotionTranslationInput, SetComponent, UpdatePromotionInput, Weekday, } from './pricing/index.js';
+export { promotionActions, promotionConditions } from './pricing/index.js';
+export type { EntityProvenance, ProvenanceActor, ProvenanceEntityType, ProvenanceFieldGroup, ProvenanceManagedBy, ProvenanceModule, } from './provenance/index.js';
+export { PROVENANCE_MAX_IDS } from './provenance/index.js';
+export type { LowStockInput, LowStockVariant, PopularVariant, PopularVariantsInput, ReportDay, ReportExport, ReportExportFilter, ReportExportKind, ReportOverview, ReportOverviewInput, ReportPeriod, ReportsModule, ReportTotals, } from './reports/index.js';
 export type { Redirect, RedirectCreateInput, RedirectsModule, RedirectUpdateInput, } from './seo/redirects.js';
+export type { ParcelCountSuggestion, ParcelCountSuggestionInput, ParcelCountSuggestionItem, ParcelCountSuggestionMethod, } from './shipping/parcel-count-suggestion.js';
+export { PARCEL_SUGGESTION_MAX_ITEMS, PARCEL_SUGGESTION_MAX_QUANTITY, } from './shipping/parcel-count-suggestion.js';
+export type { ParcelRule, ParcelRuleModule, SetParcelRuleInput, ShippingModule, } from './shipping/parcel-rule.js';
+export { PARCEL_CAPACITY_MAX, PARCEL_WEIGHT_GRAMS_MAX } from './shipping/parcel-rule.js';
+export type { AdjustStockInput, ReleasedAllocation, StockAllocationsModule, StockModule, StockMovement, StockMovementFilter, StockMovementType, StockPosition, StockPositionOptions, } from './stock/index.js';
+export type { CloseStockTransferOptions, CreateStockTransferInput, CreateStockTransferReturnInput, ReceiveStockTransferLineInput, ShipStockTransferInput, StockTransfer, StockTransferAddress, StockTransferAddressInput, StockTransferCancellation, StockTransferFilter, StockTransferKind, StockTransferLabel, StockTransferLabelFormat, StockTransferLine, StockTransferLineInput, StockTransferParcel, StockTransferParcels, StockTransferReturnableLine, StockTransferReturnRef, StockTransferReturns, StockTransferShortfall, StockTransferShortfallDisposition, StockTransferShortfallLine, StockTransferShortfallLineInput, StockTransferStaffRef, StockTransferState, StockTransfersModule, UpdateStockTransferInput, } from './stock/transfers.js';
+export type { IssueStoredValueInput, RedeemStoredValueInput, StoredValueAccount, StoredValueEntry, StoredValueLiability, StoredValueModule, StoredValueRedemption, StoredValueStatement, } from './stored-value/index.js';
 export type { TaxClass, TaxClassesModule, TaxClassMapping, TaxClassTaxCategory, TaxMappingsModule, TaxModule, UpsertTaxClassInput, } from './tax/index.js';
 export { TAX_CLASS_FALLBACK_COUNTRY } from './tax/index.js';
 export type { CapabilitiesModule, Capability, CapabilityManifest, } from './tenant/capabilities.js';
 export type { ChannelsModule } from './tenant/channels.js';
+export type { TenantEntitlement, TenantEntitlementSource, TenantEntitlementsReader, } from './tenant/entitlements.js';
+export type { FieldGroupOwnership, FieldGroupOwnersReader, FieldGroupSyncSource, FieldGroupSyncSourcesReader, } from './tenant/field-groups.js';
+export type { LegalEntityModule } from './tenant/legal-entity.js';
+export type { NotificationEventConfig, NotificationRecipientSegment, NotificationRecipients, NotificationSender, NotificationsModule, UpdateNotificationEventConfigInput, } from './tenant/notifications.js';
 export type { ChannelRetention, RetentionHold, RetentionModule, SetRetentionInput, } from './tenant/retention.js';
-export type { ApiToken, Call, ChannelInfo, CreateApiTokenInput, ListOptions, Me, TenantContext, TenantScope, UpdateApiTokenInput, WhoAmI, } from './types.js';
+export type { ChannelSettingsSource, SettingsGroup, SettingsSourceKind, SettingsSourcesModule, } from './tenant/settings-sources.js';
+export { SETTINGS_GROUPS } from './tenant/settings-sources.js';
+export type { ApiToken, Call, ChannelInfo, CreateApiTokenInput, FieldGroupGrantRefusalCode, ListOptions, Me, MeChannel, TenantContext, TenantScope, UpdateApiTokenInput, WhoAmI, } from './types.js';
 export type { ClaimAsAssetInput, StagedUpload, StagedUploadTicket, StageUploadInput, UploadBody, UploadPurpose, UploadStatus, UploadsModule, } from './uploads/index.js';
+export type { EnsureUserInput, EnsureUserOutcome, EnsureUserResult, StaffUser, UpdateUserInput, UserRoleRequest, UsersModule, } from './users/index.js';

package/dist/index.js

@@ -27,13 +27,28 @@
  * it without adding a direct dependency on `@sixtyninecommerce/core` — which,
  * being transitive, pnpm would not resolve for them anyway.
  */
-export { APP_MANIFEST_SCHEMA, APP_MANIFEST_SCHEMA_SOURCE, AuthenticationError, BusinessRuleError, ConflictError, NotFoundError, PermissionDeniedError, PlatformError, RateLimitedError, TransportError, UpstreamError, ValidationError, } from '@sixtyninecommerce/core';
+/** Platform events: the webhook handler, the verifier and the payload types, from core. */
+export { APP_MANIFEST_SCHEMA, APP_MANIFEST_SCHEMA_SOURCE, AuthenticationError, BusinessRuleError, ConflictError, createEventHandler, EventStreamClosedError, HookRejectedError, HookUnavailableError, isEventType, NotFoundError, PermissionDeniedError, PlatformError, RateLimitedError, TransportError, UpstreamError, ValidationError, verifyEventDelivery, } from '@sixtyninecommerce/core';
+export { MAX_AVAILABILITY_PRODUCTS, MAX_AVAILABILITY_STORES, MAX_PRODUCT_COLLECTION_IDS, MAX_STORE_EXCLUSION_PRODUCTS, } from './catalog/products.js';
+export { MAX_BULK_PRODUCTS, PRODUCT_BULK_ACTIONS } from './catalog/products-bulk.js';
+export { MAX_REVERT_PRICE_VARIANTS } from './catalog/variants.js';
 export { createAdminClient, } from './client.js';
+export { MAX_REPLACE_GROUP_MEMBERS } from './customers/index.js';
 export { MAX_DOCUMENT_EXTENSIONS } from './documents/index.js';
 export { AdminProjectionError } from './errors.js';
+export { MAX_REDRIVE_EVENT_IDS } from './events/index.js';
+export { AI_UNAVAILABLE_CODE, DEFAULT_FEED_PAGE_LIMIT, DEFAULT_PREVIEW_SAMPLE_SIZE, DEFAULT_REFRESH_INTERVAL_MINUTES, FEED_CATEGORY_MAPPING_SOURCES, FEED_CATEGORY_MAPPING_STATUSES, FEED_CATEGORY_MATCH_TYPES, FEED_CONDITION_OPERATORS, FEED_DESTINATIONS, FEED_IDENTIFIER_PATTERN, FEED_ITEM_ISSUE_SEVERITIES, FEED_PREVIEW_TIMEOUT_MS, FEED_REGENERATE_THROTTLED, FEED_RUN_STATUSES, FEED_RUN_TRIGGERS, FEED_TRANSFORM_KINDS, FEED_VALUE_SOURCE_KINDS, isAiUnavailable, isFeedConditionGroup, isFeedValueSourceKind, MAX_BULK_STATUS_IDS, MAX_FEED_PAGE_LIMIT, MAX_LOOKUP_ENTRIES, MAX_PREVIEW_SAMPLE_SIZE, MAX_REFRESH_INTERVAL_MINUTES, MIN_REFRESH_INTERVAL_MINUTES, readFeedRegenerateThrottle, TAXONOMY_DEFAULT_LIMIT, TAXONOMY_MAX_LIMIT, TITLE_PRESET_TIMEOUT_MS, VALUELESS_FEED_CONDITION_OPERATORS, } from './feeds/index.js';
+export { TERMINAL_BULK_ACTION_STATUSES } from './jobs/bulk-action-run.js';
 export { TERMINAL_JOB_STATUSES } from './jobs/index.js';
 export { OPENING_HOURS_DAYS } from './locations/index.js';
 export { METAFIELD_OWNER_TYPES, METAFIELD_SCALAR_TYPES } from './metafields/index.js';
+export { ORDER_INCLUDES } from './orders/get.js';
+export { ORDER_ALLOCATION_BADGES, ORDER_EDIT_BLOCK_CODES, ORDER_LOCK_REASONS, ORDER_STATUS_ACTIONS, ORDER_STATUS_REASON_CODES, } from './orders/status.js';
 export { requireHumanSession } from './platform/guard.js';
 export { PROVISION_PROFILES } from './platform/provision-store.js';
+export { promotionActions, promotionConditions } from './pricing/index.js';
+export { PROVENANCE_MAX_IDS } from './provenance/index.js';
+export { PARCEL_SUGGESTION_MAX_ITEMS, PARCEL_SUGGESTION_MAX_QUANTITY, } from './shipping/parcel-count-suggestion.js';
+export { PARCEL_CAPACITY_MAX, PARCEL_WEIGHT_GRAMS_MAX } from './shipping/parcel-rule.js';
 export { TAX_CLASS_FALLBACK_COUNTRY } from './tax/index.js';
+export { SETTINGS_GROUPS } from './tenant/settings-sources.js';

package/dist/jobs/bulk-action-run.d.ts

@@ -0,0 +1,65 @@
+import { type Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+import { type JobHandle } from './index.js';
+/**
+ * A bulk action run (`catalog.products.bulk`, and the orders kind of a later release): one call
+ * that acts on many records of the store as a job, each record through its single door and
+ * reported on its own. Read back through the Admin API's `bulkActionRun`.
+ */
+/**
+ * `QUEUED` → `RUNNING` → `SUCCEEDED` (every item ran and has its own outcome, a `FAILED` item
+ * included), or `FAILED` (the run stopped before every item had an outcome; `items` lists the ones
+ * it reached), or `CANCELLED` (the items after the cancel did not run; `items` lists every one
+ * the run reached, the one running when the cancel landed included). A run cancelled while an item
+ * ran stays `RUNNING` until that item has its outcome. A string on the wire: a newer engine may add
+ * a status.
+ */
+export type BulkActionRunStatus = 'QUEUED' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'CANCELLED';
+/** A run nothing more will happen to. */
+export declare const TERMINAL_BULK_ACTION_STATUSES: readonly string[];
+/** One record's outcome. */
+export interface BulkActionItem {
+    /** The record (a product id for `products.bulk`). */
+    id: string;
+    status: 'OK' | 'FAILED' | (string & {});
+    /**
+     * When `FAILED`: the single door's OWN code, the one a call of that door would have raised:
+     * `ENTITY_NOT_FOUND` (not in this store, another store's included), `SHARED_PRODUCT_NOT_ALLOWED`,
+     * `MANAGED_BY_ORGANIZATION`, `FIELD_GROUP_LOCKED`, `EXTERNAL_LINE_CARRIER_PROTECTED`,
+     * `PRODUCT_NOT_DELETED`, … Null when `OK`.
+     */
+    code: string | null;
+    /** When `FAILED`: the door's sentence. Null when `OK`. */
+    message: string | null;
+    /** What the action made: the new product of a `CLONE`. Null otherwise. */
+    newId: string | null;
+}
+export interface BulkActionRun<Action extends string = string> {
+    /** The run's id: the receipt `bulk()` answered. */
+    id: string;
+    /** `products.bulk`. */
+    kind: string;
+    action: Action | (string & {});
+    status: BulkActionRunStatus | (string & {});
+    /** How many records the run was asked to act on. */
+    total: number;
+    /** How many of them have an outcome. */
+    done: number;
+    /** One outcome per record reached, in the order the records were named. */
+    items: BulkActionItem[];
+    /** Why the RUN stopped early (`FAILED`); each item keeps its own code. Null otherwise. */
+    failure: {
+        code: string;
+        message: string;
+    } | null;
+}
+export declare const BULK_ACTION_RUN_QUERY = "\n  query BulkActionRun($runId: ID!) {\n    bulkActionRun(runId: $runId) {\n      id\n      kind\n      action\n      status\n      total\n      done\n      items {\n        id\n        status\n        code\n        message\n        newId\n      }\n      failure {\n        code\n        message\n      }\n    }\n  }\n";
+/** One read of a run. A run of another store, or one that does not exist, is `NotFoundError`. */
+export declare function readBulkActionRun<Action extends string>(transport: Transport, runId: string, options?: Call): Promise<BulkActionRun<Action>>;
+/**
+ * The handle a bulk submit answers. `wait()` polls the run until it is terminal and resolves with
+ * it WHATEVER the ending (a run whose items all failed still `SUCCEEDED` as a run); it throws only
+ * when waiting itself cannot go on: `JOB_WAIT_TIMEOUT`, an aborted signal, or a read refused for
+ * a reason polling cannot fix.
+ */
+export declare function bulkActionHandle<Action extends string>(transport: Transport, runId: string, options?: Call): JobHandle<BulkActionRun<Action>>;

package/dist/jobs/bulk-action-run.js

@@ -0,0 +1,70 @@
+import { TransportError } from '@sixtyninecommerce/core';
+import { fieldOf } from '../catalog/types.js';
+import { pollUntilTerminal } from './index.js';
+/** A run nothing more will happen to. */
+export const TERMINAL_BULK_ACTION_STATUSES = [
+    'SUCCEEDED',
+    'FAILED',
+    'CANCELLED',
+];
+export const BULK_ACTION_RUN_QUERY = /* GraphQL */ `
+  query BulkActionRun($runId: ID!) {
+    bulkActionRun(runId: $runId) {
+      id
+      kind
+      action
+      status
+      total
+      done
+      items {
+        id
+        status
+        code
+        message
+        newId
+      }
+      failure {
+        code
+        message
+      }
+    }
+  }
+`;
+/** One read of a run. A run of another store, or one that does not exist, is `NotFoundError`. */
+export function readBulkActionRun(transport, runId, options) {
+    return fieldOf(transport, BULK_ACTION_RUN_QUERY, 'bulkActionRun', { runId }, options);
+}
+/**
+ * The handle a bulk submit answers. `wait()` polls the run until it is terminal and resolves with
+ * it WHATEVER the ending (a run whose items all failed still `SUCCEEDED` as a run); it throws only
+ * when waiting itself cannot go on: `JOB_WAIT_TIMEOUT`, an aborted signal, or a read refused for
+ * a reason polling cannot fix.
+ */
+export function bulkActionHandle(transport, runId, options) {
+    return {
+        runId,
+        wait(waitOptions) {
+            return pollUntilTerminal({
+                read: (signal) => readBulkActionRun(transport, runId, {
+                    ...options,
+                    ...(signal ? { signal } : {}),
+                }),
+                isTerminal: (run) => TERMINAL_BULK_ACTION_STATUSES.includes(run.status),
+                onTimeout: (seen) => bulkWaitTimeout(runId, seen),
+                ...waitOptions,
+            });
+        },
+    };
+}
+function bulkWaitTimeout(runId, run) {
+    const at = run
+        ? `while it was ${run.status} (${String(run.done)} of ${String(run.total)} done)`
+        : 'without reading it successfully';
+    return new TransportError({
+        code: 'JOB_WAIT_TIMEOUT',
+        message: `Stopped waiting for bulk run ${runId} ${at}. The run may still be going: read it again with its runId to follow it.`,
+        status: 0,
+        service: 'vendure',
+        retryable: true,
+    });
+}

package/dist/locations/index.d.ts

@@ -81,7 +81,7 @@ export interface LocationProfile {
  *
  * `address` is the one exception, because it writes through to the stock
  * location's own field: omit it to leave that field alone, pass `null` to clear
- * it.
+ * it. An address equal to the stored one writes nothing to that field.
  */
 export interface UpsertLocationProfileInput {
     stockLocationId: string;
@@ -107,7 +107,11 @@ export interface UpsertLocationProfileInput {
  * cannot probe another store's ids; `LOCATION_CODE_TAKEN` (→ `ConflictError`);
  * and `INVALID_LOCATION_CODE` / `INVALID_LOCATION_NAME` /
  * `INVALID_LOCATION_PHONE` / `INVALID_TIMEZONE` / `INVALID_OPENING_HOURS` /
- * `INVALID_ADDRESS` (→ `ValidationError`).
+ * `INVALID_ADDRESS` (→ `ValidationError`); and `LOCATION_NOT_ALLOWED`
+ * (→ `PermissionDeniedError`) when `upsert` changes or clears the `address` of a
+ * location a token or app installation restricted with `locationIds` does not
+ * hold. The address is the location's parcel sender. Sending the stored address
+ * back unchanged passes, and the profile's other fields are not restricted.
  *
  * `LOCATION_NOT_IN_CHANNEL` is NOT one of these: it belongs to the two places
  * that take a location id from outside this surface — `apiTokens.create`/

package/dist/meta/index.d.ts

@@ -24,11 +24,21 @@ export interface MetaCatalogLabels {
     subscriptionStatus: LabelMap;
     quoteStatus: LabelMap;
     settlementMethod: LabelMap;
+    /** What a RETAIL credit note did, keyed by its `kind`. */
     creditNoteKind: LabelMap;
+    /**
+     * The same four kinds on the accounts-receivable ledger, in its own words:
+     * there `return` also covers a settled refund and a manual credit, so the
+     * retail "Return credited" would mislabel it. Pick the map by the note's
+     * ledger. Served by a platform from this release on.
+     */
+    arCreditNoteKind: LabelMap;
     auditService: LabelMap;
     auditCategory: LabelMap;
     auditEventOutcome: LabelMap;
     auditCallOutcome: LabelMap;
+    /** Who sends a notification event's email: `platform` or `none` (`admin.tenant.notifications`). */
+    notificationSender: LabelMap;
     /**
      * A vocabulary added after this SDK release arrives camelised, with its map
      * untouched.
@@ -59,10 +69,32 @@ export interface RoleTemplate {
     permissions: string[];
 }
 export interface ApiTokenTemplate {
+    /**
+     * The preset's stable key, accepted by `admin.apiTokens.create({ templateKeys })`.
+     * Shipped presets: `content`, `forms`, `catalog` (catalogue CRUD — the spec's
+     * "catalog-writer"), `readonly`, `external-tracking`, `platform-events` (event
+     * feed, read-only), `audit`, `pos`, `order-entry` (place and recover orders,
+     * caller-priced lines, find or create the customer), `customers` (customer CRUD
+     * without delete or erasure), `stock` (stock reads, adjustments and transfers
+     * through `AdjustStock`; it cannot edit locations or their settings), `events` (the
+     * event feed plus managing webhook subscriptions: `ReadPlatformEvents` +
+     * `ManageEventSubscriptions`), `full`, `sandbox-full` (for CI against a
+     * sandbox store: Full access plus the event feed and subscriptions, the audit
+     * trail, POS, tracking and stock moves; never user, token or app management)
+     * and `custom`. Read the live list from `meta.catalog()`; this one is
+     * documentation.
+     */
     key: string;
     label: string;
     description: string;
     permissions: string[];
+    /**
+     * `true` on a preset minted on a SANDBOX store only (`sandbox-full`);
+     * `apiTokens.create({ templateKeys })` refuses it elsewhere with
+     * `SANDBOX_ONLY_TEMPLATE`. A picker hides such a preset on a live store.
+     * Absent on every other preset, and on a platform older than this field.
+     */
+    sandbox?: boolean;
 }
 export interface MetaCatalogPermissions {
     /** Every permission name the Admin API registers. */