@sixtyninecommerce/admin 0.9.0 → 0.11.0

package/dist/integrations/exact-online.d.ts

@@ -0,0 +1,248 @@
+import { type Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+import type { ExactAccountStructure, ExactCatalogueStructure, ExactOnlineAccountPreview, ExactOnlineConfig, ExactOnlineItemPreview, ExactPricingStructure, ExactSyncEstimate, ExactSyncScheduleInput, ExactWebhookStatus, SetExactOnlineCredentialsInput, UpdateExactOnlineConfigInput } from './exact-online-types.js';
+/**
+ * The store's Exact Online connection itself (`admin.integrations.exactOnline.config`).
+ */
+export interface ExactOnlineConfigModule {
+    /**
+     * The store's connection and settings, or `null` when it never had one. Every section reads
+     * resolved: a section the store never saved reads the engine's defaults. The client secret,
+     * the webhook secret and the OAuth tokens are never read back.
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    get(options?: Call): Promise<ExactOnlineConfig | null>;
+    /**
+     * Change the settings; the first call creates the store's row (switched off). Answers the saved
+     * connection. Every key is optional and one left out keeps the stored value; the sections are
+     * judged again when sent (the payment-method mappings, the delivery defaults and readiness), so
+     * send only what changed. Sent as the engine's inline arguments, one per key.
+     *
+     * Refused, with nothing saved:
+     * - `INVALID_EXACT_ONLINE_INPUT` (`ValidationError`, 400), before sending: not an input object,
+     *   a key that is no setting (GraphQL would drop it unread), or an explicit `null` for `region`,
+     *   `enabled`, `shippingItemCode`, `discountItemCode`, `paymentTerms` or `deliveryTerms` (the
+     *   engine cannot store one: a database or type error); the key in `error.details[]`;
+     * - `PLUGIN_ACCESS_DENIED` (`PermissionDeniedError`, 403): the store has no Exact Online plugin
+     *   (never for a SuperAdmin);
+     * - `FIELD_GROUP_LOCKED` (`BusinessRuleError`, 422): the save switches Exact, or its customer
+     *   sync, on while an app or API token owns a field group of the store (prices, stock, product
+     *   or customer details), which Exact would write; `error.details[]` names each owner. The owner
+     *   releases the group in Settings → Apps first;
+     * - `ORGANIZATION_WORKSPACE_NOT_A_STORE` (422): switching Exact on in an organization's
+     *   workspace;
+     * - `USER_INPUT_ERROR` (`ValidationError`, 400): an external-line or surcharge item code over
+     *   60 characters once trimmed.
+     *
+     * The engine's other refusals are not coded yet and arrive as an uncoded error
+     * (`GRAPHQL_ERROR`, 500): an unknown `region`, a shipping or discount item code over 60
+     * characters, a new-account payment condition missing from the synchronised catalog, a payment
+     * method that is not the store's or is mapped twice, the delivery defaults (an Incoterm without
+     * a version, a lead time or advice out of range) and operational delivery terms the schedule or
+     * the switch cannot serve.
+     *
+     * @effect write
+     * @permission UpdateSettings
+     */
+    update(input: UpdateExactOnlineConfigInput, options?: Call): Promise<ExactOnlineConfig>;
+}
+/** The store's own Exact app (`admin.integrations.exactOnline.credentials`). */
+export interface ExactOnlineCredentialsModule {
+    /**
+     * Store the store's own Exact app: its client id and, write-only, its client secret and webhook
+     * secret (a secret left out, or blank, keeps the stored one). Needed before connecting; kept
+     * across a disconnect. Answers the connection (`hasCustomCredentials` once both id and secret
+     * are stored); the first call creates the store's row.
+     *
+     * Refused: `PLUGIN_ACCESS_DENIED` (403); `ORGANIZATION_WORKSPACE_NOT_A_STORE` (422) in an
+     * organization's workspace; `INVALID_EXACT_ONLINE_INPUT` (400), before sending, when `clientId`
+     * is not a string.
+     *
+     * @effect write
+     * @permission UpdateSettings
+     */
+    set(input: SetExactOnlineCredentialsInput, options?: Call): Promise<ExactOnlineConfig>;
+}
+/** Live samples of the connected division (`admin.integrations.exactOnline.samples`). */
+export interface ExactOnlineSamplesModule {
+    /**
+     * A few CRM Accounts of the connected division, read live from Exact (5 unless `limit` says).
+     * Refused `PLUGIN_ACCESS_DENIED` (403); a store that is not connected, or an Exact read that
+     * fails, answers an uncoded error (`GRAPHQL_ERROR`, 500; not coded yet).
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    accounts(options?: {
+        limit?: number;
+    } & Call): Promise<ExactOnlineAccountPreview[]>;
+    /**
+     * A few logistics Items of the connected division, read live from Exact (5 unless `limit`
+     * says). Refusals as {@link accounts}.
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    items(options?: {
+        limit?: number;
+    } & Call): Promise<ExactOnlineItemPreview[]>;
+}
+/**
+ * Read-only probes of how the connected division is organised, for designing the import rules
+ * (`admin.integrations.exactOnline.structure`). Each reads Exact live, page by page: slow on a
+ * large division. Refused `PLUGIN_ACCESS_DENIED` (403); a store that is not connected, or an
+ * Exact read that fails, answers an uncoded error (`GRAPHQL_ERROR`, 500; not coded yet).
+ */
+export interface ExactOnlineStructureModule {
+    /**
+     * How the items group (item groups, classification fields), over the first `sample` items
+     * (200 unless said).
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    catalogue(options?: {
+        sample?: number;
+    } & Call): Promise<ExactCatalogueStructure>;
+    /**
+     * How the Accounts group (classification dimensions, price lists, resellers), over the first
+     * `sample` Accounts (1,000 unless said).
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    customers(options?: {
+        sample?: number;
+    } & Call): Promise<ExactAccountStructure>;
+    /**
+     * Named price lists against per-customer item prices in the division.
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    pricing(options?: Call): Promise<ExactPricingStructure>;
+}
+/** The store's Exact webhook subscriptions (`admin.integrations.exactOnline.webhooks`). */
+export interface ExactOnlineWebhooksModule {
+    /**
+     * The subscriptions live in Exact for the store, read live. A failed Exact read answers
+     * `error` with a best-effort rest, never a throw. Refused `PLUGIN_ACCESS_DENIED` (403).
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    status(options?: Call): Promise<ExactWebhookStatus>;
+    /**
+     * Register (or refresh) the store's subscriptions in Exact. Safe to repeat. Refused
+     * `PLUGIN_ACCESS_DENIED` (403) and `FIELD_GROUP_LOCKED` (422) while an app or API token owns a
+     * field group of the store; a store that is not connected, or an Exact write that fails,
+     * answers an uncoded error (`GRAPHQL_ERROR`, 500; not coded yet).
+     *
+     * @effect write
+     * @permission UpdateSettings
+     */
+    sync(options?: Call): Promise<boolean>;
+}
+/**
+ * The store's Exact Online connection, its settings and its import structure
+ * (`admin.integrations.exactOnline`). Always the store the client is scoped to; a SuperAdmin acts
+ * on ANOTHER store with `admin.withTenant({ scope: { kind: 'channel', code } })`, or a per-call
+ * `tenant`.
+ *
+ * The connection is OAuth: `authorizationUrl` gives the consent page of the region's Exact host,
+ * and Exact's callback stores the division. A store without the Exact Online plugin is refused
+ * every method but `config.get` and `disconnect` (`PLUGIN_ACCESS_DENIED`, 403; never for a
+ * SuperAdmin). The sync runs, the logs and the shipping-method mapping follow in their own
+ * modules.
+ */
+export interface ExactOnlineModule {
+    /** The connection's settings. See {@link ExactOnlineConfigModule}. */
+    config: ExactOnlineConfigModule;
+    /** The store's own Exact app. See {@link ExactOnlineCredentialsModule}. */
+    credentials: ExactOnlineCredentialsModule;
+    /**
+     * The Exact consent page to send the merchant to (open it in a popup): the region's Exact host
+     * with the store's own app and an encrypted state. Nothing is stored; the connection is made
+     * when Exact calls back. `region` defaults to the engine's (`nl`).
+     *
+     * Refused: `PLUGIN_ACCESS_DENIED` (403); `ORGANIZATION_WORKSPACE_NOT_A_STORE` (422);
+     * `FIELD_GROUP_LOCKED` (422) while an app or API token owns a field group of the store (the URL
+     * is withheld). The store has no app credentials yet, or the region is unknown: an uncoded
+     * error (`GRAPHQL_ERROR`, 500; not coded yet).
+     *
+     * @effect read
+     * @permission UpdateSettings
+     */
+    authorizationUrl(region?: string, options?: Call): Promise<string>;
+    /**
+     * [deletes] Disconnect the store from Exact: the OAuth tokens, the division and the connection
+     * are cleared and Exact is switched off. The app credentials and every setting stay, so a
+     * reconnect needs only the consent. Answers `true`, or `false` when the store never had a row.
+     * Allowed without the plugin (it only removes access).
+     *
+     * Before clearing, it removes the store's Exact webhook subscriptions while the token still
+     * works and marks the store's synced delivery terms stale; either one failing is NOT reported
+     * (the engine ignores it), so a subscription can outlive the disconnect in Exact.
+     *
+     * @effect destructive
+     * @permission UpdateSettings
+     */
+    disconnect(options?: Call): Promise<boolean>;
+    /** Live samples of the connected division. See {@link ExactOnlineSamplesModule}. */
+    samples: ExactOnlineSamplesModule;
+    /** How the connected division is organised. See {@link ExactOnlineStructureModule}. */
+    structure: ExactOnlineStructureModule;
+    /** The store's webhook subscriptions. See {@link ExactOnlineWebhooksModule}. */
+    webhooks: ExactOnlineWebhooksModule;
+    /**
+     * The Exact API calls a day `schedule` would make, sweep by sweep, and whether that passes the
+     * advisory budget. Advice only: nothing is capped by it. The schedule is read as a save would
+     * store it: merged over the store's stored schedule (a window left out keeps the stored one)
+     * and every interval rounded and clamped to its bounds, which the answer names
+     * (`minIntervalMinutes`, `maxIntervalMinutes`). It is never refused for an interval out of
+     * bounds. Makes no Exact call.
+     *
+     * Intervals and the budget are whole numbers (the engine refuses a fraction `BAD_USER_INPUT`,
+     * 400). Refused `PLUGIN_ACCESS_DENIED` (403).
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    syncEstimate(schedule: ExactSyncScheduleInput, options?: Call): Promise<ExactSyncEstimate>;
+}
+/**
+ * `updateExactOnlineConfig`'s inline arguments, each with its GraphQL type: the SDK takes one
+ * object, the wire keeps the arguments (adding an input type would be a second door to keep).
+ */
+export declare const EXACT_ONLINE_CONFIG_ARGUMENTS: {
+    readonly region: "String";
+    readonly enabled: "Boolean";
+    readonly shippingItemCode: "String";
+    readonly discountItemCode: "String";
+    readonly externalLineItemCode: "String";
+    readonly pushSurcharges: "Boolean";
+    readonly surchargeItemCode: "String";
+    readonly negativeSurchargeItemCode: "String";
+    readonly autoPush: "ExactAutoPushConfigInput";
+    readonly customerSync: "ExactCustomerSyncConfigInput";
+    readonly paymentTerms: "ExactPaymentTermsConfigInput";
+    readonly deliveryTerms: "ExactDeliveryTermsConfigInput";
+    readonly syncSchedule: "ExactSyncScheduleInput";
+    readonly catalogueImportPolicy: "ExactCatalogueImportPolicyInput";
+};
+export declare const EXACT_ONLINE_CONFIG_QUERY = "\n  query ExactOnlineConfig {\n    exactOnlineConfig { \n  id\n  enabled\n  connected\n  region\n  division\n  companyName\n  clientId\n  hasCustomCredentials\n  hasWebhookSecret\n  lastConnectedAt\n  lastRefreshedAt\n  accessTokenExpiresAt\n  shippingItemCode\n  discountItemCode\n  externalLineItemCode\n  pushSurcharges\n  surchargeItemCode\n  negativeSurchargeItemCode\n  pushSurchargesWarning\n  autoPush { enabled defaultTrigger rules { customerGroupId trigger } }\n  customerSync {\n    enabled\n    webhookEnabled\n    pushEnabled\n    accountFilter\n    overwritePolicy\n    fields { name email address }\n  }\n  paymentTerms {\n    enabled\n    synchronizationEnabled\n    newAccountPaymentConditionCode\n    paymentMethodConditions { paymentMethodId conditionCode }\n  }\n  deliveryTerms {\n    enabled\n    synchronizationEnabled\n    forwardRequestedDeliveryDate\n    sendDeliveryAddress\n    newAccountShippingMethodId\n    newAccountIncotermCode\n    newAccountIncotermVersion\n    newAccountIncotermAddress\n    newAccountShippingLeadDays\n    newAccountDeliveryAdvice\n  }\n  syncSchedule {\n    delta { enabled intervalMinutes }\n    full { enabled intervalMinutes }\n    order { enabled intervalMinutes }\n    purchaseOrders { enabled intervalMinutes }\n    purchaseOrdersReconcile { enabled intervalMinutes }\n    customers { enabled intervalMinutes }\n    priceLists { enabled intervalMinutes }\n    dailyCallBudget\n  }\n  catalogueImportPolicy {\n    requireWebshopFlag\n    nonStockItems\n    unpricedItems\n    priceBasis\n    pictures\n    stockBasis\n  }\n  deltaLastEnqueuedAt\n  fullLastEnqueuedAt\n  orderLastEnqueuedAt\n  purchaseOrderLastEnqueuedAt\n  purchaseOrderReconcileLastEnqueuedAt\n  customerLastEnqueuedAt\n  priceListLastEnqueuedAt\n }\n  }\n";
+export declare const UPDATE_EXACT_ONLINE_CONFIG_MUTATION = "\n  mutation UpdateExactOnlineConfig(\n    $region: String\n    $enabled: Boolean\n    $shippingItemCode: String\n    $discountItemCode: String\n    $externalLineItemCode: String\n    $pushSurcharges: Boolean\n    $surchargeItemCode: String\n    $negativeSurchargeItemCode: String\n    $autoPush: ExactAutoPushConfigInput\n    $customerSync: ExactCustomerSyncConfigInput\n    $paymentTerms: ExactPaymentTermsConfigInput\n    $deliveryTerms: ExactDeliveryTermsConfigInput\n    $syncSchedule: ExactSyncScheduleInput\n    $catalogueImportPolicy: ExactCatalogueImportPolicyInput\n  ) {\n    updateExactOnlineConfig(\n      region: $region\n      enabled: $enabled\n      shippingItemCode: $shippingItemCode\n      discountItemCode: $discountItemCode\n      externalLineItemCode: $externalLineItemCode\n      pushSurcharges: $pushSurcharges\n      surchargeItemCode: $surchargeItemCode\n      negativeSurchargeItemCode: $negativeSurchargeItemCode\n      autoPush: $autoPush\n      customerSync: $customerSync\n      paymentTerms: $paymentTerms\n      deliveryTerms: $deliveryTerms\n      syncSchedule: $syncSchedule\n      catalogueImportPolicy: $catalogueImportPolicy\n    ) {\n      \n  id\n  enabled\n  connected\n  region\n  division\n  companyName\n  clientId\n  hasCustomCredentials\n  hasWebhookSecret\n  lastConnectedAt\n  lastRefreshedAt\n  accessTokenExpiresAt\n  shippingItemCode\n  discountItemCode\n  externalLineItemCode\n  pushSurcharges\n  surchargeItemCode\n  negativeSurchargeItemCode\n  pushSurchargesWarning\n  autoPush { enabled defaultTrigger rules { customerGroupId trigger } }\n  customerSync {\n    enabled\n    webhookEnabled\n    pushEnabled\n    accountFilter\n    overwritePolicy\n    fields { name email address }\n  }\n  paymentTerms {\n    enabled\n    synchronizationEnabled\n    newAccountPaymentConditionCode\n    paymentMethodConditions { paymentMethodId conditionCode }\n  }\n  deliveryTerms {\n    enabled\n    synchronizationEnabled\n    forwardRequestedDeliveryDate\n    sendDeliveryAddress\n    newAccountShippingMethodId\n    newAccountIncotermCode\n    newAccountIncotermVersion\n    newAccountIncotermAddress\n    newAccountShippingLeadDays\n    newAccountDeliveryAdvice\n  }\n  syncSchedule {\n    delta { enabled intervalMinutes }\n    full { enabled intervalMinutes }\n    order { enabled intervalMinutes }\n    purchaseOrders { enabled intervalMinutes }\n    purchaseOrdersReconcile { enabled intervalMinutes }\n    customers { enabled intervalMinutes }\n    priceLists { enabled intervalMinutes }\n    dailyCallBudget\n  }\n  catalogueImportPolicy {\n    requireWebshopFlag\n    nonStockItems\n    unpricedItems\n    priceBasis\n    pictures\n    stockBasis\n  }\n  deltaLastEnqueuedAt\n  fullLastEnqueuedAt\n  orderLastEnqueuedAt\n  purchaseOrderLastEnqueuedAt\n  purchaseOrderReconcileLastEnqueuedAt\n  customerLastEnqueuedAt\n  priceListLastEnqueuedAt\n\n    }\n  }\n";
+export declare const SET_EXACT_ONLINE_CREDENTIALS_MUTATION = "\n  mutation SetExactOnlineCredentials(\n    $clientId: String!\n    $clientSecret: String\n    $webhookSecret: String\n  ) {\n    setExactOnlineCredentials(\n      clientId: $clientId\n      clientSecret: $clientSecret\n      webhookSecret: $webhookSecret\n    ) {\n      \n  id\n  enabled\n  connected\n  region\n  division\n  companyName\n  clientId\n  hasCustomCredentials\n  hasWebhookSecret\n  lastConnectedAt\n  lastRefreshedAt\n  accessTokenExpiresAt\n  shippingItemCode\n  discountItemCode\n  externalLineItemCode\n  pushSurcharges\n  surchargeItemCode\n  negativeSurchargeItemCode\n  pushSurchargesWarning\n  autoPush { enabled defaultTrigger rules { customerGroupId trigger } }\n  customerSync {\n    enabled\n    webhookEnabled\n    pushEnabled\n    accountFilter\n    overwritePolicy\n    fields { name email address }\n  }\n  paymentTerms {\n    enabled\n    synchronizationEnabled\n    newAccountPaymentConditionCode\n    paymentMethodConditions { paymentMethodId conditionCode }\n  }\n  deliveryTerms {\n    enabled\n    synchronizationEnabled\n    forwardRequestedDeliveryDate\n    sendDeliveryAddress\n    newAccountShippingMethodId\n    newAccountIncotermCode\n    newAccountIncotermVersion\n    newAccountIncotermAddress\n    newAccountShippingLeadDays\n    newAccountDeliveryAdvice\n  }\n  syncSchedule {\n    delta { enabled intervalMinutes }\n    full { enabled intervalMinutes }\n    order { enabled intervalMinutes }\n    purchaseOrders { enabled intervalMinutes }\n    purchaseOrdersReconcile { enabled intervalMinutes }\n    customers { enabled intervalMinutes }\n    priceLists { enabled intervalMinutes }\n    dailyCallBudget\n  }\n  catalogueImportPolicy {\n    requireWebshopFlag\n    nonStockItems\n    unpricedItems\n    priceBasis\n    pictures\n    stockBasis\n  }\n  deltaLastEnqueuedAt\n  fullLastEnqueuedAt\n  orderLastEnqueuedAt\n  purchaseOrderLastEnqueuedAt\n  purchaseOrderReconcileLastEnqueuedAt\n  customerLastEnqueuedAt\n  priceListLastEnqueuedAt\n\n    }\n  }\n";
+export declare const EXACT_ONLINE_AUTHORIZATION_URL_MUTATION = "\n  mutation ExactOnlineAuthorizationUrl($region: String) {\n    exactOnlineAuthorizationUrl(region: $region)\n  }\n";
+export declare const DISCONNECT_EXACT_ONLINE_MUTATION = "\n  mutation DisconnectExactOnline {\n    disconnectExactOnline\n  }\n";
+export declare const EXACT_ONLINE_SAMPLE_ACCOUNTS_QUERY = "\n  query ExactOnlineSampleAccounts($limit: Int) {\n    exactOnlineSampleAccounts(limit: $limit) { id code name city country email status }\n  }\n";
+export declare const EXACT_ONLINE_SAMPLE_ITEMS_QUERY = "\n  query ExactOnlineSampleItems($limit: Int) {\n    exactOnlineSampleItems(limit: $limit) { id code description isSalesItem isStockItem }\n  }\n";
+export declare const EXACT_ONLINE_CATALOGUE_STRUCTURE_QUERY = "\n  query ExactOnlineCatalogueStructure($sample: Int) {\n    exactOnlineCatalogueStructure(sample: $sample) {\n      sampledCount\n      distinctItemGroupCount\n      topItemGroups { code description itemCount }\n      classFields { field nonEmptyCount distinctCount }\n      rows { code description itemGroup }\n    }\n  }\n";
+export declare const EXACT_ONLINE_CUSTOMER_STRUCTURE_QUERY = "\n  query ExactOnlineCustomerStructure($sample: Int) {\n    exactOnlineCustomerStructure(sample: $sample) {\n      sampledCount\n      withEmail\n      withoutEmail\n      withAddress\n      resellerCount\n      dimensions {\n        sequence\n        name\n        slotField\n        populatedCount\n        distinctCount\n        values { id code description accountCount }\n      }\n      priceLists { id code description accountCount }\n      rows { code name email city country isReseller classifications priceList }\n    }\n  }\n";
+export declare const EXACT_ONLINE_PRICING_STRUCTURE_QUERY = "\n  query ExactOnlinePricingStructure {\n    exactOnlinePricingStructure {\n      priceLists { id code description currency }\n      priceListItemPriceCount\n      priceListItemSamples {\n        itemCode\n        itemDescription\n        quantity\n        newPrice\n        discount\n        entryMethod\n        basePrice\n      }\n      accountsWithDefaultPriceList\n      customerPriceCount\n      customerPriceDistinctAccounts\n      customerPriceDistinctItems\n      customerPriceSamples { itemCode accountName price quantity currency }\n      sampled\n    }\n  }\n";
+export declare const EXACT_ONLINE_WEBHOOK_STATUS_QUERY = "\n  query ExactOnlineWebhookStatus {\n    exactOnlineWebhookStatus {\n      supported\n      registered\n      subscriptions { topic subscriptionId callbackUrl }\n      checkedAt\n      error\n    }\n  }\n";
+export declare const SYNC_EXACT_ONLINE_WEBHOOKS_MUTATION = "\n  mutation SyncExactOnlineWebhooks {\n    syncExactOnlineWebhooks\n  }\n";
+export declare const EXACT_ONLINE_SYNC_ESTIMATE_QUERY = "\n  query ExactOnlineSyncEstimate($schedule: ExactSyncScheduleInput!) {\n    exactOnlineSyncEstimate(schedule: $schedule) {\n      delta { \n  enabled\n  intervalMinutes\n  minIntervalMinutes\n  maxIntervalMinutes\n  callsPerRun\n  runsPerDay\n  callsPerDay\n }\n      full { \n  enabled\n  intervalMinutes\n  minIntervalMinutes\n  maxIntervalMinutes\n  callsPerRun\n  runsPerDay\n  callsPerDay\n }\n      order { \n  enabled\n  intervalMinutes\n  minIntervalMinutes\n  maxIntervalMinutes\n  callsPerRun\n  runsPerDay\n  callsPerDay\n }\n      purchaseOrders { \n  enabled\n  intervalMinutes\n  minIntervalMinutes\n  maxIntervalMinutes\n  callsPerRun\n  runsPerDay\n  callsPerDay\n }\n      purchaseOrdersReconcile { \n  enabled\n  intervalMinutes\n  minIntervalMinutes\n  maxIntervalMinutes\n  callsPerRun\n  runsPerDay\n  callsPerDay\n }\n      customers { \n  enabled\n  intervalMinutes\n  minIntervalMinutes\n  maxIntervalMinutes\n  callsPerRun\n  runsPerDay\n  callsPerDay\n }\n      priceLists { \n  enabled\n  intervalMinutes\n  minIntervalMinutes\n  maxIntervalMinutes\n  callsPerRun\n  runsPerDay\n  callsPerDay\n }\n      total\n      dailyCallBudget\n      overBudget\n    }\n  }\n";
+export declare function createExactOnlineModule(transport: Transport): ExactOnlineModule;

package/dist/integrations/exact-online.js

@@ -0,0 +1,376 @@
+import { ValidationError } from '@sixtyninecommerce/core';
+import { fieldOf } from '../catalog/types.js';
+const SYNC_WINDOW_FIELDS = /* GraphQL */ `enabled intervalMinutes`;
+const CONFIG_FIELDS = /* GraphQL */ `
+  id
+  enabled
+  connected
+  region
+  division
+  companyName
+  clientId
+  hasCustomCredentials
+  hasWebhookSecret
+  lastConnectedAt
+  lastRefreshedAt
+  accessTokenExpiresAt
+  shippingItemCode
+  discountItemCode
+  externalLineItemCode
+  pushSurcharges
+  surchargeItemCode
+  negativeSurchargeItemCode
+  pushSurchargesWarning
+  autoPush { enabled defaultTrigger rules { customerGroupId trigger } }
+  customerSync {
+    enabled
+    webhookEnabled
+    pushEnabled
+    accountFilter
+    overwritePolicy
+    fields { name email address }
+  }
+  paymentTerms {
+    enabled
+    synchronizationEnabled
+    newAccountPaymentConditionCode
+    paymentMethodConditions { paymentMethodId conditionCode }
+  }
+  deliveryTerms {
+    enabled
+    synchronizationEnabled
+    forwardRequestedDeliveryDate
+    sendDeliveryAddress
+    newAccountShippingMethodId
+    newAccountIncotermCode
+    newAccountIncotermVersion
+    newAccountIncotermAddress
+    newAccountShippingLeadDays
+    newAccountDeliveryAdvice
+  }
+  syncSchedule {
+    delta { ${SYNC_WINDOW_FIELDS} }
+    full { ${SYNC_WINDOW_FIELDS} }
+    order { ${SYNC_WINDOW_FIELDS} }
+    purchaseOrders { ${SYNC_WINDOW_FIELDS} }
+    purchaseOrdersReconcile { ${SYNC_WINDOW_FIELDS} }
+    customers { ${SYNC_WINDOW_FIELDS} }
+    priceLists { ${SYNC_WINDOW_FIELDS} }
+    dailyCallBudget
+  }
+  catalogueImportPolicy {
+    requireWebshopFlag
+    nonStockItems
+    unpricedItems
+    priceBasis
+    pictures
+    stockBasis
+  }
+  deltaLastEnqueuedAt
+  fullLastEnqueuedAt
+  orderLastEnqueuedAt
+  purchaseOrderLastEnqueuedAt
+  purchaseOrderReconcileLastEnqueuedAt
+  customerLastEnqueuedAt
+  priceListLastEnqueuedAt
+`;
+/**
+ * `updateExactOnlineConfig`'s inline arguments, each with its GraphQL type: the SDK takes one
+ * object, the wire keeps the arguments (adding an input type would be a second door to keep).
+ */
+export const EXACT_ONLINE_CONFIG_ARGUMENTS = {
+    region: 'String',
+    enabled: 'Boolean',
+    shippingItemCode: 'String',
+    discountItemCode: 'String',
+    externalLineItemCode: 'String',
+    pushSurcharges: 'Boolean',
+    surchargeItemCode: 'String',
+    negativeSurchargeItemCode: 'String',
+    autoPush: 'ExactAutoPushConfigInput',
+    customerSync: 'ExactCustomerSyncConfigInput',
+    paymentTerms: 'ExactPaymentTermsConfigInput',
+    deliveryTerms: 'ExactDeliveryTermsConfigInput',
+    syncSchedule: 'ExactSyncScheduleInput',
+    catalogueImportPolicy: 'ExactCatalogueImportPolicyInput',
+};
+/** The keys the engine cannot store as `null` (a not-null column, a `.trim()`, a section read). */
+const NEVER_NULL_CONFIG_KEYS = [
+    'region',
+    'enabled',
+    'shippingItemCode',
+    'discountItemCode',
+    'paymentTerms',
+    'deliveryTerms',
+];
+export const EXACT_ONLINE_CONFIG_QUERY = /* GraphQL */ `
+  query ExactOnlineConfig {
+    exactOnlineConfig { ${CONFIG_FIELDS} }
+  }
+`;
+// The variable list and the arguments are written out, never spliced in from
+// EXACT_ONLINE_CONFIG_ARGUMENTS: the package's coverage specs parse every document literal with
+// each `${…}` read as a field name, so an interpolated variable list fails them. The SDK spec
+// pins the variables against the map and the engine's arguments.
+export const UPDATE_EXACT_ONLINE_CONFIG_MUTATION = /* GraphQL */ `
+  mutation UpdateExactOnlineConfig(
+    $region: String
+    $enabled: Boolean
+    $shippingItemCode: String
+    $discountItemCode: String
+    $externalLineItemCode: String
+    $pushSurcharges: Boolean
+    $surchargeItemCode: String
+    $negativeSurchargeItemCode: String
+    $autoPush: ExactAutoPushConfigInput
+    $customerSync: ExactCustomerSyncConfigInput
+    $paymentTerms: ExactPaymentTermsConfigInput
+    $deliveryTerms: ExactDeliveryTermsConfigInput
+    $syncSchedule: ExactSyncScheduleInput
+    $catalogueImportPolicy: ExactCatalogueImportPolicyInput
+  ) {
+    updateExactOnlineConfig(
+      region: $region
+      enabled: $enabled
+      shippingItemCode: $shippingItemCode
+      discountItemCode: $discountItemCode
+      externalLineItemCode: $externalLineItemCode
+      pushSurcharges: $pushSurcharges
+      surchargeItemCode: $surchargeItemCode
+      negativeSurchargeItemCode: $negativeSurchargeItemCode
+      autoPush: $autoPush
+      customerSync: $customerSync
+      paymentTerms: $paymentTerms
+      deliveryTerms: $deliveryTerms
+      syncSchedule: $syncSchedule
+      catalogueImportPolicy: $catalogueImportPolicy
+    ) {
+      ${CONFIG_FIELDS}
+    }
+  }
+`;
+export const SET_EXACT_ONLINE_CREDENTIALS_MUTATION = /* GraphQL */ `
+  mutation SetExactOnlineCredentials(
+    $clientId: String!
+    $clientSecret: String
+    $webhookSecret: String
+  ) {
+    setExactOnlineCredentials(
+      clientId: $clientId
+      clientSecret: $clientSecret
+      webhookSecret: $webhookSecret
+    ) {
+      ${CONFIG_FIELDS}
+    }
+  }
+`;
+export const EXACT_ONLINE_AUTHORIZATION_URL_MUTATION = /* GraphQL */ `
+  mutation ExactOnlineAuthorizationUrl($region: String) {
+    exactOnlineAuthorizationUrl(region: $region)
+  }
+`;
+export const DISCONNECT_EXACT_ONLINE_MUTATION = /* GraphQL */ `
+  mutation DisconnectExactOnline {
+    disconnectExactOnline
+  }
+`;
+export const EXACT_ONLINE_SAMPLE_ACCOUNTS_QUERY = /* GraphQL */ `
+  query ExactOnlineSampleAccounts($limit: Int) {
+    exactOnlineSampleAccounts(limit: $limit) { id code name city country email status }
+  }
+`;
+export const EXACT_ONLINE_SAMPLE_ITEMS_QUERY = /* GraphQL */ `
+  query ExactOnlineSampleItems($limit: Int) {
+    exactOnlineSampleItems(limit: $limit) { id code description isSalesItem isStockItem }
+  }
+`;
+export const EXACT_ONLINE_CATALOGUE_STRUCTURE_QUERY = /* GraphQL */ `
+  query ExactOnlineCatalogueStructure($sample: Int) {
+    exactOnlineCatalogueStructure(sample: $sample) {
+      sampledCount
+      distinctItemGroupCount
+      topItemGroups { code description itemCount }
+      classFields { field nonEmptyCount distinctCount }
+      rows { code description itemGroup }
+    }
+  }
+`;
+export const EXACT_ONLINE_CUSTOMER_STRUCTURE_QUERY = /* GraphQL */ `
+  query ExactOnlineCustomerStructure($sample: Int) {
+    exactOnlineCustomerStructure(sample: $sample) {
+      sampledCount
+      withEmail
+      withoutEmail
+      withAddress
+      resellerCount
+      dimensions {
+        sequence
+        name
+        slotField
+        populatedCount
+        distinctCount
+        values { id code description accountCount }
+      }
+      priceLists { id code description accountCount }
+      rows { code name email city country isReseller classifications priceList }
+    }
+  }
+`;
+export const EXACT_ONLINE_PRICING_STRUCTURE_QUERY = /* GraphQL */ `
+  query ExactOnlinePricingStructure {
+    exactOnlinePricingStructure {
+      priceLists { id code description currency }
+      priceListItemPriceCount
+      priceListItemSamples {
+        itemCode
+        itemDescription
+        quantity
+        newPrice
+        discount
+        entryMethod
+        basePrice
+      }
+      accountsWithDefaultPriceList
+      customerPriceCount
+      customerPriceDistinctAccounts
+      customerPriceDistinctItems
+      customerPriceSamples { itemCode accountName price quantity currency }
+      sampled
+    }
+  }
+`;
+export const EXACT_ONLINE_WEBHOOK_STATUS_QUERY = /* GraphQL */ `
+  query ExactOnlineWebhookStatus {
+    exactOnlineWebhookStatus {
+      supported
+      registered
+      subscriptions { topic subscriptionId callbackUrl }
+      checkedAt
+      error
+    }
+  }
+`;
+export const SYNC_EXACT_ONLINE_WEBHOOKS_MUTATION = /* GraphQL */ `
+  mutation SyncExactOnlineWebhooks {
+    syncExactOnlineWebhooks
+  }
+`;
+const SWEEP_ESTIMATE_FIELDS = /* GraphQL */ `
+  enabled
+  intervalMinutes
+  minIntervalMinutes
+  maxIntervalMinutes
+  callsPerRun
+  runsPerDay
+  callsPerDay
+`;
+export const EXACT_ONLINE_SYNC_ESTIMATE_QUERY = /* GraphQL */ `
+  query ExactOnlineSyncEstimate($schedule: ExactSyncScheduleInput!) {
+    exactOnlineSyncEstimate(schedule: $schedule) {
+      delta { ${SWEEP_ESTIMATE_FIELDS} }
+      full { ${SWEEP_ESTIMATE_FIELDS} }
+      order { ${SWEEP_ESTIMATE_FIELDS} }
+      purchaseOrders { ${SWEEP_ESTIMATE_FIELDS} }
+      purchaseOrdersReconcile { ${SWEEP_ESTIMATE_FIELDS} }
+      customers { ${SWEEP_ESTIMATE_FIELDS} }
+      priceLists { ${SWEEP_ESTIMATE_FIELDS} }
+      total
+      dailyCallBudget
+      overBudget
+    }
+  }
+`;
+const invalidInput = (message, field) => new ValidationError({
+    code: 'INVALID_EXACT_ONLINE_INPUT',
+    message,
+    status: 400,
+    service: 'vendure',
+    ...(field ? { details: [{ field, code: 'INVALID_EXACT_ONLINE_INPUT', message }] } : {}),
+});
+const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+function requireObject(value, method) {
+    if (!isObject(value))
+        throw invalidInput(`${method} takes an input object.`);
+    return value;
+}
+/**
+ * The input as the mutation's variables, as given: a key left out stays out, so the engine keeps
+ * the stored value. A key the engine has no argument for is refused here: GraphQL ignores a
+ * variable the operation does not declare, so it would otherwise be dropped silently.
+ */
+function configVariables(input) {
+    const variables = requireObject(input, 'config.update');
+    for (const key of Object.keys(variables)) {
+        if (!Object.hasOwn(EXACT_ONLINE_CONFIG_ARGUMENTS, key)) {
+            throw invalidInput(`${key} is not an Exact Online setting.`, key);
+        }
+    }
+    for (const key of NEVER_NULL_CONFIG_KEYS) {
+        if (Object.hasOwn(variables, key) && variables[key] === null) {
+            throw invalidInput(`${key} cannot be null: leave it out to keep the stored value.`, key);
+        }
+    }
+    return variables;
+}
+export function createExactOnlineModule(transport) {
+    const read = (document, field, options, variables = {}) => fieldOf(transport, document, field, variables, options);
+    return {
+        config: {
+            async get(options) {
+                return ((await read(EXACT_ONLINE_CONFIG_QUERY, 'exactOnlineConfig', options)) ?? null);
+            },
+            async update(input, options) {
+                return read(UPDATE_EXACT_ONLINE_CONFIG_MUTATION, 'updateExactOnlineConfig', options, configVariables(input));
+            },
+        },
+        credentials: {
+            async set(input, options) {
+                const { clientId, clientSecret, webhookSecret } = requireObject(input, 'credentials.set');
+                if (typeof clientId !== 'string') {
+                    throw invalidInput('credentials.set needs the Exact app client id.', 'clientId');
+                }
+                return read(SET_EXACT_ONLINE_CREDENTIALS_MUTATION, 'setExactOnlineCredentials', options, { clientId, clientSecret, webhookSecret });
+            },
+        },
+        authorizationUrl(region, options) {
+            return read(EXACT_ONLINE_AUTHORIZATION_URL_MUTATION, 'exactOnlineAuthorizationUrl', options, region === undefined ? {} : { region });
+        },
+        async disconnect(options) {
+            return ((await read(DISCONNECT_EXACT_ONLINE_MUTATION, 'disconnectExactOnline', options)) === true);
+        },
+        samples: {
+            accounts(options) {
+                const { limit, ...call } = options ?? {};
+                return read(EXACT_ONLINE_SAMPLE_ACCOUNTS_QUERY, 'exactOnlineSampleAccounts', call, limit === undefined ? {} : { limit });
+            },
+            items(options) {
+                const { limit, ...call } = options ?? {};
+                return read(EXACT_ONLINE_SAMPLE_ITEMS_QUERY, 'exactOnlineSampleItems', call, limit === undefined ? {} : { limit });
+            },
+        },
+        structure: {
+            catalogue(options) {
+                const { sample, ...call } = options ?? {};
+                return read(EXACT_ONLINE_CATALOGUE_STRUCTURE_QUERY, 'exactOnlineCatalogueStructure', call, sample === undefined ? {} : { sample });
+            },
+            customers(options) {
+                const { sample, ...call } = options ?? {};
+                return read(EXACT_ONLINE_CUSTOMER_STRUCTURE_QUERY, 'exactOnlineCustomerStructure', call, sample === undefined ? {} : { sample });
+            },
+            pricing(options) {
+                return read(EXACT_ONLINE_PRICING_STRUCTURE_QUERY, 'exactOnlinePricingStructure', options);
+            },
+        },
+        webhooks: {
+            status(options) {
+                return read(EXACT_ONLINE_WEBHOOK_STATUS_QUERY, 'exactOnlineWebhookStatus', options);
+            },
+            async sync(options) {
+                return ((await read(SYNC_EXACT_ONLINE_WEBHOOKS_MUTATION, 'syncExactOnlineWebhooks', options)) === true);
+            },
+        },
+        async syncEstimate(schedule, options) {
+            return read(EXACT_ONLINE_SYNC_ESTIMATE_QUERY, 'exactOnlineSyncEstimate', options, { schedule: requireObject(schedule, 'syncEstimate') });
+        },
+    };
+}

package/dist/integrations/index.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Integrations (headless spec §9.2): the store's connections to other systems. The data
+ * pipelines' source connections, connectors and import and export set-ups, the e-mail marketing
+ * connection (`esp`), the AFAS Profit connection with what is sent to it (`afas`) and the Exact
+ * Online connection with its settings (`exactOnline`); the pipelines themselves, their runs and
+ * their progress streams follow in phase 7.
+ */
+import type { Transport } from '@sixtyninecommerce/core';
+import { type AfasModule } from './afas.js';
+import { type EspModule } from './esp.js';
+import { type ExactOnlineModule } from './exact-online.js';
+import { type IntegrationPipelinesModule } from './pipelines.js';
+export type { AfasConfigModule, AfasModule, AfasPaymentTermsModule, AfasWarehouseMappingsModule, } from './afas.js';
+export { AFAS_SYNC_LOG_PAGE_LIMIT } from './afas.js';
+export type { AfasCustomersModule, AfasOrdersModule, AfasStockTransfersModule, } from './afas-actions.js';
+export { AFAS_CUSTOMER_SEARCH_LIMIT } from './afas-actions.js';
+export type * from './afas-types.js';
+export type { PipelineConnectionsModule } from './connections.js';
+export { PIPELINE_CONNECTION_PRESERVE_KEYS } from './connections.js';
+export type { ConnectEspWithTokenInput, EspBackfillResource, EspConnection, EspConnectionTestResult, EspConnectMetadata, EspCredentialsPushState, EspInboundWebhookState, EspModule, EspSyncLog, EspSyncLogFilter, UpdateEspConnectionInput, } from './esp.js';
+export { ESP_BACKFILL_RESOURCES, ESP_SYNC_LOG_PAGE_LIMIT } from './esp.js';
+export type { ExactOnlineConfigModule, ExactOnlineCredentialsModule, ExactOnlineModule, ExactOnlineSamplesModule, ExactOnlineStructureModule, ExactOnlineWebhooksModule, } from './exact-online.js';
+export type * from './exact-online-types.js';
+export type { IntegrationPipelinesModule, PipelineDraftsModule } from './pipelines.js';
+export { PIPELINE_DRAFT_PRESERVE_KEYS, PIPELINE_DRAFT_SLOW_TIMEOUT_MS } from './pipelines.js';
+export type * from './types.js';
+export interface IntegrationsModule {
+    /**
+     * Data pipelines: the source connections (`connections`), the connectors, and the import and
+     * export set-ups kept on the server (`drafts`).
+     */
+    pipelines: IntegrationPipelinesModule;
+    /** The store's e-mail marketing connection (sixtynine.email). See {@link EspModule}. */
+    esp: EspModule;
+    /** The store's AFAS Profit connection and its settings. See {@link AfasModule}. */
+    afas: AfasModule;
+    /** The store's Exact Online connection and its settings. See {@link ExactOnlineModule}. */
+    exactOnline: ExactOnlineModule;
+}
+export declare function createIntegrationsModule(transport: Transport): IntegrationsModule;