@sixtyninecommerce/admin 0.9.0 → 0.11.0

package/dist/integrations/afas.d.ts

@@ -0,0 +1,234 @@
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import type { Call, ListOptions } from '../types.js';
+import { type AfasCustomersModule, type AfasOrdersModule, type AfasStockTransfersModule } from './afas-actions.js';
+import type { AfasAdministration, AfasConfig, AfasConfigSaveResult, AfasConnectionVerification, AfasCorrectionArticleFill, AfasDiscoveredDefaults, AfasPaymentCondition, AfasPaymentTermsStatus, AfasPaymentTermsSyncResult, AfasSyncLog, AfasSyncLogFilter, AfasWarehouse, AfasWarehouseMapping, UpdateAfasConfigInput, UpdateAfasPaymentConditionInput } from './afas-types.js';
+/** The largest page `syncLogs` asks for; the default is 25. */
+export declare const AFAS_SYNC_LOG_PAGE_LIMIT = 100;
+/**
+ * The store's AFAS Profit connection itself (`admin.integrations.afas.config`). Writing it is
+ * the platform SuperAdmin's alone: a store administrator is refused `FORBIDDEN`
+ * (`PermissionDeniedError`, 403).
+ */
+export interface AfasConfigModule {
+    /**
+     * The store's connection, or `null` when it has none. The App Connector token is write-only:
+     * never read back, in any form.
+     *
+     * @effect read
+     * @permission UpdateSettings
+     */
+    get(options?: Call): Promise<AfasConfig | null>;
+    /**
+     * Configure the connection; the first call creates it. A patch: a key left out keeps the
+     * stored value. Answers the saved connection with `correctionArticleFill`: a save that leaves
+     * AFAS on with a token also fills the correction article of each VAT rate of the store that has
+     * none, from AFAS (a detection failure never fails the save; it is reported there). The first
+     * save that turns payment terms on also starts a payment-terms sync in the background.
+     *
+     * A store administrator is refused `FORBIDDEN` (`PermissionDeniedError`, 403). Refused, with
+     * nothing saved:
+     * - `AFAS_CONFIG_INVALID` (`ValidationError`, 400): every problem of the save at once, each in
+     *   `error.details[]` with its `field`: `environmentId` (missing on the first save, blank or
+     *   null on any, or not an AFAS environment id: the number such as `89990`, or the code such as
+     *   `T89990AA`), `token` (missing on the first save, or neither the token envelope nor a bare
+     *   hex blob of 32+ characters), `correctionArticleCodes[n].taxRate` (outside 0-100, or a rate
+     *   listed twice) and `correctionArticleCodes[n].itemCode` (blank, or over 50 characters), n
+     *   being the row's index in the list as sent;
+     * - `ORGANIZATION_WORKSPACE_NOT_A_STORE` (422): switching AFAS on, or storing a token, in an
+     *   organization's workspace.
+     *
+     * The connector and field ids are free text the engine does not check.
+     *
+     * @effect write
+     * @permission SuperAdmin
+     */
+    update(input: UpdateAfasConfigInput, options?: Call): Promise<AfasConfigSaveResult>;
+    /**
+     * [deletes] Remove the store's connection and the token it holds. `true` when one was
+     * removed, `false` when there was none. A store administrator is refused `FORBIDDEN`
+     * (`PermissionDeniedError`, 403).
+     *
+     * @effect destructive
+     * @permission SuperAdmin
+     */
+    delete(options?: Call): Promise<boolean>;
+}
+/**
+ * The store's stock locations paired with AFAS warehouses (`admin.integrations.afas
+ * .warehouseMappings`): the warehouse a location's stock moves are booked on in AFAS.
+ */
+export interface AfasWarehouseMappingsModule {
+    /**
+     * Every mapping of the store.
+     *
+     * @effect read
+     * @permission UpdateSettings
+     */
+    list(options?: Call): Promise<AfasWarehouseMapping[]>;
+    /**
+     * Map a stock location of the store to an AFAS warehouse code, replacing its mapping if it has
+     * one. Answers the saved mapping. Refused, with nothing saved: `AFAS_WAREHOUSE_MAPPING_INVALID`
+     * (`ValidationError`, 400, `details[]` field `afasWarehouse`) for a blank code or one over 15
+     * characters; `ENTITY_NOT_FOUND` (`NotFoundError`, 404) for a location the store does not have.
+     * `INVALID_AFAS_INPUT` (`ValidationError`, 400), before sending: the location id is not a
+     * non-empty string, or the code not a string.
+     *
+     * @effect write
+     * @permission UpdateSettings
+     */
+    upsert(stockLocationId: string, afasWarehouse: string, options?: Call): Promise<AfasWarehouseMapping>;
+    /**
+     * [deletes] Remove a stock location's mapping. `true` when one was removed, `false` when it
+     * had none. `INVALID_AFAS_INPUT` (400), before sending, for a location id that is not a
+     * non-empty string.
+     *
+     * @effect destructive
+     * @permission UpdateSettings
+     */
+    delete(stockLocationId: string, options?: Call): Promise<boolean>;
+}
+/**
+ * The store's AFAS customer payment terms (`admin.integrations.afas.paymentTerms`): the condition
+ * catalog (AFAS code → days), the health of the debtor mirror, the sync, and merchant edits.
+ */
+export interface AfasPaymentTermsModule {
+    /**
+     * The condition catalog, by code.
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    conditions(options?: Call): Promise<AfasPaymentCondition[]>;
+    /**
+     * The health of the mirror and the catalog.
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    status(options?: Call): Promise<AfasPaymentTermsStatus>;
+    /**
+     * Refresh the condition catalog from AFAS and mirror every linked customer's AFAS condition.
+     * A catalog AFAS will not give is reported in `catalogError`, not thrown. A failed debtor read
+     * marks the mirror stale and throws. A store administrator is refused `FORBIDDEN`
+     * (`PermissionDeniedError`, 403). AFAS off is refused `AFAS_NOT_CONFIGURED` (422), payment
+     * terms off `AFAS_PAYMENT_TERMS_DISABLED` (`BusinessRuleError`, 422).
+     *
+     * @effect write
+     * @permission SuperAdmin
+     */
+    sync(options?: Call): Promise<AfasPaymentTermsSyncResult>;
+    /**
+     * Create or change one condition of the catalog (the merchant's own edit, never overwritten by
+     * a sync). Answers the saved row. A store administrator is refused `FORBIDDEN`
+     * (`PermissionDeniedError`, 403); a code that is not 1-20 characters, or days that are not a
+     * whole number in range, are refused `AFAS_PAYMENT_CONDITION_INVALID` (`ValidationError`, 400,
+     * `details[]` field `code` or `days`). `INVALID_AFAS_INPUT` (400), before
+     * sending, when the input has no string `code`.
+     *
+     * @effect write
+     * @permission SuperAdmin
+     */
+    updateCondition(input: UpdateAfasPaymentConditionInput, options?: Call): Promise<AfasPaymentCondition>;
+}
+/**
+ * The store's AFAS Profit connection and its settings (`admin.integrations.afas`): the
+ * connection, its test, the AFAS lists the settings pick from, the warehouse mapping, the payment
+ * terms, and the log of what was sent. 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`.
+ *
+ * A store without the AFAS plugin is refused every method but `config.get`, `config.delete` and
+ * `syncLogs` (`PLUGIN_ACCESS_DENIED`, `PermissionDeniedError`, 403; never for a SuperAdmin). A door
+ * that needs a connection the store does not have answers `AFAS_NOT_CONFIGURED` (422). What is
+ * sent to AFAS for an order, a customer or a stock transfer is under `orders`, `customers` and
+ * `stockTransfers`.
+ */
+export interface AfasModule {
+    /** The connection itself. See {@link AfasConfigModule}. */
+    config: AfasConfigModule;
+    /**
+     * Ask AFAS whether the saved connection works. Never refuses for what it finds: a connection
+     * AFAS refuses answers `connected: false`. A connection that works also fills the correction
+     * article of each VAT rate that has none (`correctionArticles`, saved).
+     *
+     * A store administrator is refused `FORBIDDEN` (`PermissionDeniedError`, 403).
+     * `AFAS_NOT_CONFIGURED` (422): the store has no saved connection.
+     *
+     * @effect write
+     * @permission SuperAdmin
+     */
+    verifyConnection(options?: Call): Promise<AfasConnectionVerification>;
+    /**
+     * "Detect from AFAS": fill the correction article of each VAT rate of the store that has none,
+     * from the AFAS articles without stock, and save. Never replaces an entry.
+     *
+     * A store administrator is refused `FORBIDDEN` (`PermissionDeniedError`, 403). Refused, with
+     * nothing changed: `AFAS_NOT_CONFIGURED` (422, no connection or no token);
+     * `AFAS_READ_FAILED` (AFAS could not be read; the sentence names what to authorise).
+     *
+     * @effect write
+     * @permission SuperAdmin
+     */
+    fillCorrectionArticles(options?: Call): Promise<AfasCorrectionArticleFill>;
+    /**
+     * Values the saved AFAS environment suggests for the settings. Reads only. Never throws for
+     * what AFAS answers: a field AFAS cannot give is null, and every field is null when the store
+     * has no saved connection. A store administrator is refused `FORBIDDEN`
+     * (`PermissionDeniedError`, 403).
+     *
+     * @effect read
+     * @permission SuperAdmin
+     */
+    discoverDefaults(options?: Call): Promise<AfasDiscoveredDefaults>;
+    /**
+     * The attempts to send this store's records to AFAS, newest first, 25 to a page (at most
+     * {@link AFAS_SYNC_LOG_PAGE_LIMIT}).
+     *
+     * @effect read
+     * @permission UpdateSettings
+     */
+    syncLogs(filter?: AfasSyncLogFilter & ListOptions): Promise<Page<AfasSyncLog>>;
+    /**
+     * The administrations of the connected AFAS environment, read live. An AFAS read that fails
+     * answers an empty list. `AFAS_NOT_CONFIGURED` (422): no connection, or AFAS switched off.
+     *
+     * @effect read
+     * @permission UpdateSettings
+     */
+    administrations(options?: Call): Promise<AfasAdministration[]>;
+    /**
+     * The warehouses of the connected AFAS environment, read live. An AFAS read that fails answers
+     * an empty list. `AFAS_NOT_CONFIGURED` (422): no connection, or AFAS switched off.
+     *
+     * @effect read
+     * @permission UpdateSettings
+     */
+    warehouses(options?: Call): Promise<AfasWarehouse[]>;
+    /** Stock locations paired with AFAS warehouses. See {@link AfasWarehouseMappingsModule}. */
+    warehouseMappings: AfasWarehouseMappingsModule;
+    /** The customer payment terms. See {@link AfasPaymentTermsModule}. */
+    paymentTerms: AfasPaymentTermsModule;
+    /** An order's AFAS documents. See {@link AfasOrdersModule}. */
+    orders: AfasOrdersModule;
+    /** A customer's AFAS debtor. See {@link AfasCustomersModule}. */
+    customers: AfasCustomersModule;
+    /** A stock transfer's AFAS document. See {@link AfasStockTransfersModule}. */
+    stockTransfers: AfasStockTransfersModule;
+}
+export declare const AFAS_CONFIG_QUERY = "\n  query AfasConfig {\n    afasConfig { \n  id\n  channelId\n  enabled\n  environmentId\n  environmentType\n  orderConnectorId\n  orgCustomerConnectorId\n  perCustomerConnectorId\n  defaultCurrency\n  defaultPaymentCondition\n  defaultWarehouse\n  defaultAdministration\n  paymentTermsEnabled\n  paymentConditionConnectorId\n  balanceConnectorId\n  balanceDebtorFieldId\n  balanceAmountFieldId\n  invoiceReportConnectorId\n  invoiceReportFilterFieldId\n  debtorVatDuty\n  debtorCollectionAccount\n  shippingItemCode\n  discountItemCode\n  correctionArticleCodes { taxRate itemCode }\n  directInvoiceUnitCode\n  directInvoiceJournalId\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const UPDATE_AFAS_CONFIG_MUTATION = "\n  mutation UpdateAfasConfig($input: UpdateAfasConfigInput!) {\n    updateAfasConfig(input: $input) {\n      \n  id\n  channelId\n  enabled\n  environmentId\n  environmentType\n  orderConnectorId\n  orgCustomerConnectorId\n  perCustomerConnectorId\n  defaultCurrency\n  defaultPaymentCondition\n  defaultWarehouse\n  defaultAdministration\n  paymentTermsEnabled\n  paymentConditionConnectorId\n  balanceConnectorId\n  balanceDebtorFieldId\n  balanceAmountFieldId\n  invoiceReportConnectorId\n  invoiceReportFilterFieldId\n  debtorVatDuty\n  debtorCollectionAccount\n  shippingItemCode\n  discountItemCode\n  correctionArticleCodes { taxRate itemCode }\n  directInvoiceUnitCode\n  directInvoiceJournalId\n  createdAt\n  updatedAt\n\n      correctionArticleFill { \n  storeRates\n  filled { taxRate itemCode description reason }\n  kept\n  unmatchedRates\n  errorCode\n  error\n }\n    }\n  }\n";
+export declare const DELETE_AFAS_CONFIG_MUTATION = "\n  mutation DeleteAfasConfig {\n    deleteAfasConfig\n  }\n";
+export declare const VERIFY_AFAS_CONNECTION_MUTATION = "\n  mutation VerifyAfasConnection {\n    verifyAfasConnection {\n      connected\n      correctionArticles { \n  storeRates\n  filled { taxRate itemCode description reason }\n  kept\n  unmatchedRates\n  errorCode\n  error\n }\n    }\n  }\n";
+export declare const FILL_AFAS_CORRECTION_ARTICLES_MUTATION = "\n  mutation FillAfasCorrectionArticles {\n    fillAfasCorrectionArticles { \n  storeRates\n  filled { taxRate itemCode description reason }\n  kept\n  unmatchedRates\n  errorCode\n  error\n }\n  }\n";
+export declare const DISCOVER_AFAS_DEFAULTS_MUTATION = "\n  mutation DiscoverAfasDefaults {\n    discoverAfasDefaults {\n      administration\n      warehouse\n      currency\n      paymentCondition\n      vatDuty\n      collectionAccount\n    }\n  }\n";
+export declare const AFAS_SYNC_LOGS_QUERY = "\n  query AfasSyncLogs($options: AfasSyncLogListOptions) {\n    afasSyncLogs(options: $options) {\n      items { \n  id\n  channelId\n  entityType\n  entityId\n  externalRef\n  eventType\n  status\n  responseStatus\n  error\n  attempt\n  durationMs\n  createdAt\n }\n      totalItems\n    }\n  }\n";
+export declare const AFAS_ADMINISTRATIONS_QUERY = "\n  query AfasAdministrations {\n    afasAdministrations { adminCd adminNm adminId }\n  }\n";
+export declare const AFAS_WAREHOUSES_QUERY = "\n  query AfasWarehouses {\n    afasWarehouses { code name blocked }\n  }\n";
+export declare const AFAS_WAREHOUSE_MAPPINGS_QUERY = "\n  query AfasWarehouseMappings {\n    afasWarehouseMappings { \n  id\n  channelId\n  stockLocationId\n  stockLocationName\n  afasWarehouse\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const UPSERT_AFAS_WAREHOUSE_MAPPING_MUTATION = "\n  mutation UpsertAfasWarehouseMapping($stockLocationId: ID!, $afasWarehouse: String!) {\n    upsertAfasWarehouseMapping(stockLocationId: $stockLocationId, afasWarehouse: $afasWarehouse) {\n      \n  id\n  channelId\n  stockLocationId\n  stockLocationName\n  afasWarehouse\n  createdAt\n  updatedAt\n\n    }\n  }\n";
+export declare const DELETE_AFAS_WAREHOUSE_MAPPING_MUTATION = "\n  mutation DeleteAfasWarehouseMapping($stockLocationId: ID!) {\n    deleteAfasWarehouseMapping(stockLocationId: $stockLocationId)\n  }\n";
+export declare const AFAS_PAYMENT_CONDITIONS_QUERY = "\n  query AfasPaymentConditions {\n    afasPaymentConditions { \n  id\n  code\n  description\n  days\n  dueImmediately\n  source\n  active\n  lastSyncedAt\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const AFAS_PAYMENT_TERMS_STATUS_QUERY = "\n  query AfasPaymentTermsStatus {\n    afasPaymentTermsStatus {\n      enabled\n      connectorId\n      conditionCount\n      unmappedConditionCount\n      linkedCustomers\n      assigned\n      unassigned\n      unresolved\n      stale\n      lastSyncedAt\n    }\n  }\n";
+export declare const SYNC_AFAS_PAYMENT_TERMS_MUTATION = "\n  mutation SyncAfasPaymentTerms {\n    syncAfasPaymentTerms {\n      catalogConnectorId\n      catalogRows\n      catalogCreated\n      catalogUpdated\n      catalogError\n      customersLinked\n      customersMatched\n      customersUnassigned\n      customersUnresolved\n    }\n  }\n";
+export declare const UPDATE_AFAS_PAYMENT_CONDITION_MUTATION = "\n  mutation UpdateAfasPaymentCondition($input: UpdateAfasPaymentConditionInput!) {\n    updateAfasPaymentCondition(input: $input) { \n  id\n  code\n  description\n  days\n  dueImmediately\n  source\n  active\n  lastSyncedAt\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare function createAfasModule(transport: Transport): AfasModule;

package/dist/integrations/afas.js

@@ -0,0 +1,290 @@
+import { pageFromVendureList, readOffsetCursor, ValidationError, } from '@sixtyninecommerce/core';
+import { fieldOf } from '../catalog/types.js';
+import { createAfasActionsModules, } from './afas-actions.js';
+/** The largest page `syncLogs` asks for; the default is 25. */
+export const AFAS_SYNC_LOG_PAGE_LIMIT = 100;
+const AFAS_SYNC_LOG_PAGE_SIZE = 25;
+const CORRECTION_ARTICLE_FILL_FIELDS = /* GraphQL */ `
+  storeRates
+  filled { taxRate itemCode description reason }
+  kept
+  unmatchedRates
+  errorCode
+  error
+`;
+const CONFIG_FIELDS = /* GraphQL */ `
+  id
+  channelId
+  enabled
+  environmentId
+  environmentType
+  orderConnectorId
+  orgCustomerConnectorId
+  perCustomerConnectorId
+  defaultCurrency
+  defaultPaymentCondition
+  defaultWarehouse
+  defaultAdministration
+  paymentTermsEnabled
+  paymentConditionConnectorId
+  balanceConnectorId
+  balanceDebtorFieldId
+  balanceAmountFieldId
+  invoiceReportConnectorId
+  invoiceReportFilterFieldId
+  debtorVatDuty
+  debtorCollectionAccount
+  shippingItemCode
+  discountItemCode
+  correctionArticleCodes { taxRate itemCode }
+  directInvoiceUnitCode
+  directInvoiceJournalId
+  createdAt
+  updatedAt
+`;
+const SYNC_LOG_FIELDS = /* GraphQL */ `
+  id
+  channelId
+  entityType
+  entityId
+  externalRef
+  eventType
+  status
+  responseStatus
+  error
+  attempt
+  durationMs
+  createdAt
+`;
+const WAREHOUSE_MAPPING_FIELDS = /* GraphQL */ `
+  id
+  channelId
+  stockLocationId
+  stockLocationName
+  afasWarehouse
+  createdAt
+  updatedAt
+`;
+const PAYMENT_CONDITION_FIELDS = /* GraphQL */ `
+  id
+  code
+  description
+  days
+  dueImmediately
+  source
+  active
+  lastSyncedAt
+  createdAt
+  updatedAt
+`;
+export const AFAS_CONFIG_QUERY = /* GraphQL */ `
+  query AfasConfig {
+    afasConfig { ${CONFIG_FIELDS} }
+  }
+`;
+export const UPDATE_AFAS_CONFIG_MUTATION = /* GraphQL */ `
+  mutation UpdateAfasConfig($input: UpdateAfasConfigInput!) {
+    updateAfasConfig(input: $input) {
+      ${CONFIG_FIELDS}
+      correctionArticleFill { ${CORRECTION_ARTICLE_FILL_FIELDS} }
+    }
+  }
+`;
+export const DELETE_AFAS_CONFIG_MUTATION = /* GraphQL */ `
+  mutation DeleteAfasConfig {
+    deleteAfasConfig
+  }
+`;
+export const VERIFY_AFAS_CONNECTION_MUTATION = /* GraphQL */ `
+  mutation VerifyAfasConnection {
+    verifyAfasConnection {
+      connected
+      correctionArticles { ${CORRECTION_ARTICLE_FILL_FIELDS} }
+    }
+  }
+`;
+export const FILL_AFAS_CORRECTION_ARTICLES_MUTATION = /* GraphQL */ `
+  mutation FillAfasCorrectionArticles {
+    fillAfasCorrectionArticles { ${CORRECTION_ARTICLE_FILL_FIELDS} }
+  }
+`;
+export const DISCOVER_AFAS_DEFAULTS_MUTATION = /* GraphQL */ `
+  mutation DiscoverAfasDefaults {
+    discoverAfasDefaults {
+      administration
+      warehouse
+      currency
+      paymentCondition
+      vatDuty
+      collectionAccount
+    }
+  }
+`;
+export const AFAS_SYNC_LOGS_QUERY = /* GraphQL */ `
+  query AfasSyncLogs($options: AfasSyncLogListOptions) {
+    afasSyncLogs(options: $options) {
+      items { ${SYNC_LOG_FIELDS} }
+      totalItems
+    }
+  }
+`;
+export const AFAS_ADMINISTRATIONS_QUERY = /* GraphQL */ `
+  query AfasAdministrations {
+    afasAdministrations { adminCd adminNm adminId }
+  }
+`;
+export const AFAS_WAREHOUSES_QUERY = /* GraphQL */ `
+  query AfasWarehouses {
+    afasWarehouses { code name blocked }
+  }
+`;
+export const AFAS_WAREHOUSE_MAPPINGS_QUERY = /* GraphQL */ `
+  query AfasWarehouseMappings {
+    afasWarehouseMappings { ${WAREHOUSE_MAPPING_FIELDS} }
+  }
+`;
+export const UPSERT_AFAS_WAREHOUSE_MAPPING_MUTATION = /* GraphQL */ `
+  mutation UpsertAfasWarehouseMapping($stockLocationId: ID!, $afasWarehouse: String!) {
+    upsertAfasWarehouseMapping(stockLocationId: $stockLocationId, afasWarehouse: $afasWarehouse) {
+      ${WAREHOUSE_MAPPING_FIELDS}
+    }
+  }
+`;
+export const DELETE_AFAS_WAREHOUSE_MAPPING_MUTATION = /* GraphQL */ `
+  mutation DeleteAfasWarehouseMapping($stockLocationId: ID!) {
+    deleteAfasWarehouseMapping(stockLocationId: $stockLocationId)
+  }
+`;
+export const AFAS_PAYMENT_CONDITIONS_QUERY = /* GraphQL */ `
+  query AfasPaymentConditions {
+    afasPaymentConditions { ${PAYMENT_CONDITION_FIELDS} }
+  }
+`;
+export const AFAS_PAYMENT_TERMS_STATUS_QUERY = /* GraphQL */ `
+  query AfasPaymentTermsStatus {
+    afasPaymentTermsStatus {
+      enabled
+      connectorId
+      conditionCount
+      unmappedConditionCount
+      linkedCustomers
+      assigned
+      unassigned
+      unresolved
+      stale
+      lastSyncedAt
+    }
+  }
+`;
+export const SYNC_AFAS_PAYMENT_TERMS_MUTATION = /* GraphQL */ `
+  mutation SyncAfasPaymentTerms {
+    syncAfasPaymentTerms {
+      catalogConnectorId
+      catalogRows
+      catalogCreated
+      catalogUpdated
+      catalogError
+      customersLinked
+      customersMatched
+      customersUnassigned
+      customersUnresolved
+    }
+  }
+`;
+export const UPDATE_AFAS_PAYMENT_CONDITION_MUTATION = /* GraphQL */ `
+  mutation UpdateAfasPaymentCondition($input: UpdateAfasPaymentConditionInput!) {
+    updateAfasPaymentCondition(input: $input) { ${PAYMENT_CONDITION_FIELDS} }
+  }
+`;
+const invalidInput = (message) => new ValidationError({ code: 'INVALID_AFAS_INPUT', message, status: 400, service: 'vendure' });
+const requireLocationId = (value) => {
+    if (typeof value !== 'string' || value === '') {
+        throw invalidInput('stockLocationId must be the id of a stock location of the store.');
+    }
+    return value;
+};
+const requireObject = (value, method) => {
+    if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+        throw invalidInput(`${method} takes an input object.`);
+    }
+    return value;
+};
+export function createAfasModule(transport) {
+    const read = (document, field, options, variables = {}) => fieldOf(transport, document, field, variables, options);
+    const syncLogPage = async (filter, skip, take, options) => {
+        const list = await read(AFAS_SYNC_LOGS_QUERY, 'afasSyncLogs', options, { options: { ...filter, skip, take } });
+        return pageFromVendureList(list, skip, take, (cursor) => syncLogPage(filter, readOffsetCursor(cursor), take, options));
+    };
+    return {
+        ...createAfasActionsModules(transport),
+        config: {
+            async get(options) {
+                return (await read(AFAS_CONFIG_QUERY, 'afasConfig', options)) ?? null;
+            },
+            async update(input, options) {
+                // Sent as given: an absent key keeps the stored value, and the engine names every field
+                // it refuses (AFAS_CONFIG_INVALID).
+                return read(UPDATE_AFAS_CONFIG_MUTATION, 'updateAfasConfig', options, {
+                    input: requireObject(input, 'config.update'),
+                });
+            },
+            async delete(options) {
+                return ((await read(DELETE_AFAS_CONFIG_MUTATION, 'deleteAfasConfig', options)) === true);
+            },
+        },
+        verifyConnection(options) {
+            return read(VERIFY_AFAS_CONNECTION_MUTATION, 'verifyAfasConnection', options);
+        },
+        fillCorrectionArticles(options) {
+            return read(FILL_AFAS_CORRECTION_ARTICLES_MUTATION, 'fillAfasCorrectionArticles', options);
+        },
+        discoverDefaults(options) {
+            return read(DISCOVER_AFAS_DEFAULTS_MUTATION, 'discoverAfasDefaults', options);
+        },
+        syncLogs(filter) {
+            const { after, limit, entityType, entityId, status, ...options } = filter ?? {};
+            const take = Math.min(Math.max(limit ?? AFAS_SYNC_LOG_PAGE_SIZE, 1), AFAS_SYNC_LOG_PAGE_LIMIT);
+            const skip = after === undefined ? 0 : readOffsetCursor(after);
+            return syncLogPage({ entityType, entityId, status }, skip, take, options);
+        },
+        administrations(options) {
+            return read(AFAS_ADMINISTRATIONS_QUERY, 'afasAdministrations', options);
+        },
+        warehouses(options) {
+            return read(AFAS_WAREHOUSES_QUERY, 'afasWarehouses', options);
+        },
+        warehouseMappings: {
+            list(options) {
+                return read(AFAS_WAREHOUSE_MAPPINGS_QUERY, 'afasWarehouseMappings', options);
+            },
+            async upsert(stockLocationId, afasWarehouse, options) {
+                const location = requireLocationId(stockLocationId);
+                if (typeof afasWarehouse !== 'string') {
+                    throw invalidInput('afasWarehouse must be an AFAS warehouse code.');
+                }
+                // The code goes as typed: the engine trims it and judges its length.
+                return read(UPSERT_AFAS_WAREHOUSE_MAPPING_MUTATION, 'upsertAfasWarehouseMapping', options, { stockLocationId: location, afasWarehouse });
+            },
+            async delete(stockLocationId, options) {
+                return ((await read(DELETE_AFAS_WAREHOUSE_MAPPING_MUTATION, 'deleteAfasWarehouseMapping', options, { stockLocationId: requireLocationId(stockLocationId) })) === true);
+            },
+        },
+        paymentTerms: {
+            conditions(options) {
+                return read(AFAS_PAYMENT_CONDITIONS_QUERY, 'afasPaymentConditions', options);
+            },
+            status(options) {
+                return read(AFAS_PAYMENT_TERMS_STATUS_QUERY, 'afasPaymentTermsStatus', options);
+            },
+            sync(options) {
+                return read(SYNC_AFAS_PAYMENT_TERMS_MUTATION, 'syncAfasPaymentTerms', options);
+            },
+            async updateCondition(input, options) {
+                if (typeof requireObject(input, 'paymentTerms.updateCondition').code !== 'string') {
+                    throw invalidInput('paymentTerms.updateCondition needs the condition code.');
+                }
+                return read(UPDATE_AFAS_PAYMENT_CONDITION_MUTATION, 'updateAfasPaymentCondition', options, { input });
+            },
+        },
+    };
+}

package/dist/integrations/connections.d.ts

@@ -0,0 +1,103 @@
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import type { Call, ListOptions } from '../types.js';
+import type { CreatePipelineConnectionInput, DetectPipelineConnectionConfigInput, PipelineConnection, PipelineConnector, PipelineSiteAnalysis, TestPipelineConnectionInput, UpdatePipelineConnectionInput } from './types.js';
+/**
+ * The draft set plus a probe's `entityCounts`, keyed by the source's own entity names (a WordPress
+ * post type such as `product_brand`). `test` and `retest` answer the analysis at the top level,
+ * where no passthrough key covers it.
+ */
+export declare const PIPELINE_CONNECTION_PRESERVE_KEYS: ReadonlySet<string>;
+/**
+ * The store's source connections: the login to another system (a WooCommerce shop, a BluJay WMS
+ * SFTP server) that its import and export pipelines run over (headless spec §9.2).
+ *
+ * - **Credentials are write-only.** `create`, `update`, `test` and `detectConfig` take them; no
+ *   answer carries a secret. `publicCredentials` holds the fields the connector does not mark
+ *   `password` ({@link PipelineConnector.credentialFields}).
+ * - **Every write that sends credentials or changes where they go probes the source first**, and a
+ *   failed probe saves nothing: `ValidationError` (400) coded `PIPELINE_CONNECTION_TEST_FAILED`
+ *   with a readable reason (unreachable, refused, timed out), or `CONNECTION_CONFIG_INVALID` when
+ *   the connector itself refuses a setting (`details[].field` names it). A connector type the
+ *   deployment does not offer is `CONNECTOR_TYPE_UNKNOWN`.
+ * - **A stored secret stays with its recipient** (`PipelineConnector.credentialBinding`): an
+ *   `update` that moves the source URL or the SFTP login must carry every required secret again,
+ *   or it is refused `PIPELINE_HOST_CHANGE_REQUIRES_CREDENTIALS` (422) before anything is sent.
+ * - **Organization workspaces are not stores**: every door that tests, creates or changes a
+ *   connection answers `ORGANIZATION_WORKSPACE_NOT_A_STORE` (422) there.
+ * - **Apps:** an app installation is refused every door that sends, tests or writes credentials
+ *   (`APP_CREDENTIAL_NOT_ALLOWED`, 403), and an app below `customerData: full` every door
+ *   (`CUSTOMER_DATA_NOT_GRANTED`).
+ * - Reads need `ReadCatalog`; writes, probes and `delete` need `UpdateCatalog`. Another store's
+ *   connection is not found (`get` answers `null`, a write a `NotFoundError`).
+ */
+export interface PipelineConnectionsModule {
+    /**
+     * The store's connections, newest first, each with the pipelines that run over it. Includes the
+     * ones whose last probe failed (`status: 'error'`): fix or delete them here.
+     *
+     * @effect read
+     */
+    list(options?: ListOptions): Promise<Page<PipelineConnection>>;
+    /**
+     * One connection, or `null` when the store has none with that id (deleted, or another store's).
+     *
+     * @effect read
+     */
+    get(id: string, options?: Call): Promise<PipelineConnection | null>;
+    /**
+     * Probe the source with `credentials`, then store the connection with them encrypted. A failed
+     * probe stores nothing. Up to a minute on a slow source.
+     *
+     * @effect write
+     */
+    create(input: CreatePipelineConnectionInput, options?: Call): Promise<PipelineConnection>;
+    /**
+     * Change a connection. A field left out stays as stored. A rename, a throttle or the legacy
+     * hosts save without a probe, so they work while the source is down; new credentials or a new
+     * source URL are probed first and saved only if the probe succeeds. Two overlapping saves that
+     * both change the source are answered `PIPELINE_CONNECTION_CHANGED` (409) for the later one:
+     * read it again and save again. The new settings apply to every pipeline over it from its next
+     * run on, scheduled ones included.
+     *
+     * @effect write
+     */
+    update(id: string, input: UpdatePipelineConnectionInput, options?: Call): Promise<PipelineConnection>;
+    /**
+     * Delete a connection and the credentials stored with it. Refused with a `ConflictError` coded
+     * `PIPELINE_CONNECTION_IN_USE` (409), deleting nothing, while a pipeline or an unfinished set-up
+     * (`pipelines.drafts`) still uses it: the message names them, and `details[]` lists each one's
+     * id (`field` `pipeline_id` or `draft_id`). Delete those pipelines, and finish or discard those
+     * set-ups, first. The credentials cannot be recovered: a connection made again needs them
+     * typed again.
+     *
+     * @effect destructive
+     */
+    delete(id: string, options?: Call): Promise<void>;
+    /**
+     * Probe a source with credentials that are not saved anywhere, and answer what it reported.
+     * Nothing is stored. Up to a minute on a slow source.
+     *
+     * @effect read
+     */
+    test(input: TestPipelineConnectionInput, options?: Call): Promise<PipelineSiteAnalysis>;
+    /**
+     * Probe a saved connection with its stored credentials. The outcome is recorded either way: a
+     * success sets `status: 'connected'` and the new `siteAnalysis`, a failure `status: 'error'`
+     * (and is then refused `PIPELINE_CONNECTION_TEST_FAILED`). Both stamp `lastTestedAt`.
+     *
+     * @effect write
+     */
+    retest(id: string, options?: Call): Promise<PipelineSiteAnalysis>;
+    /**
+     * Ask the source for the settings a connector can find itself (BluJay WMS: the upload and stock
+     * file paths and the transmitter code), from the login in `credentials`. Answers the credential
+     * fields it found, by `key`, to put in the form; nothing is stored. A connector that cannot
+     * detect anything answers a `ValidationError` (400).
+     *
+     * @effect read
+     */
+    detectConfig(input: DetectPipelineConnectionConfigInput, options?: Call): Promise<Record<string, string>>;
+}
+export declare function createPipelineConnectionsModule(transport: Transport): PipelineConnectionsModule;
+/** The connectors this deployment offers, `coming_soon` ones included. */
+export declare function listPipelineConnectors(transport: Transport, options?: Call): Promise<PipelineConnector[]>;