@sixtyninecommerce/admin 0.9.0 → 0.11.0

package/dist/customers/delivery-preferences.js

@@ -0,0 +1,97 @@
+import { assertDeleted, fieldOf } from '../catalog/types.js';
+import { customerDataField } from './wire.js';
+export const DELIVERY_PREFERENCE_FIELDS = /* GraphQL */ `
+  id
+  createdAt
+  updatedAt
+  fulfillmentHandlerCode
+  name
+  values
+  isDefault
+`;
+export const DELIVERY_PREFERENCES_QUERY = /* GraphQL */ `
+  query CustomerDeliveryPreferences($id: ID!, $fulfillmentHandlerCode: String) {
+    customer(id: $id) {
+      id
+      deliveryPreferences(fulfillmentHandlerCode: $fulfillmentHandlerCode) {
+        ${DELIVERY_PREFERENCE_FIELDS}
+      }
+    }
+  }
+`;
+export const DELIVERY_PREFERENCE_SCHEMAS_QUERY = /* GraphQL */ `
+  query DeliveryPreferenceSchemas {
+    deliveryPreferenceSchemas {
+      handlerCode
+      fields {
+        name
+        type
+        uiComponent
+        label
+        options {
+          value
+          label
+        }
+        defaultValue
+      }
+    }
+  }
+`;
+export const CREATE_DELIVERY_PREFERENCE_MUTATION = /* GraphQL */ `
+  mutation CreateCustomerDeliveryPreference($input: CreateCustomerDeliveryPreferenceInput!) {
+    createCustomerDeliveryPreference(input: $input) {
+      ${DELIVERY_PREFERENCE_FIELDS}
+    }
+  }
+`;
+export const UPDATE_DELIVERY_PREFERENCE_MUTATION = /* GraphQL */ `
+  mutation UpdateCustomerDeliveryPreference($input: UpdateCustomerDeliveryPreferenceInput!) {
+    updateCustomerDeliveryPreference(input: $input) {
+      ${DELIVERY_PREFERENCE_FIELDS}
+    }
+  }
+`;
+export const DELETE_DELIVERY_PREFERENCE_MUTATION = /* GraphQL */ `
+  mutation DeleteCustomerDeliveryPreference($id: ID!) {
+    deleteCustomerDeliveryPreference(id: $id) {
+      result
+      message
+    }
+  }
+`;
+export function createCustomerDeliveryPreferencesModule(transport) {
+    return {
+        async list(customerId, options) {
+            const { value: customer, mark } = await customerDataField(transport, DELIVERY_PREFERENCES_QUERY, 'customer', 
+            // `undefined`, never an explicit null: without a handler the argument stays off the wire.
+            { id: customerId, fulfillmentHandlerCode: options?.handlerCode }, options);
+            return (customer?.deliveryPreferences ?? []).map(mark);
+        },
+        schemas(options) {
+            return fieldOf(transport, DELIVERY_PREFERENCE_SCHEMAS_QUERY, 'deliveryPreferenceSchemas', {}, options);
+        },
+        async create(input, options) {
+            const { value, mark } = await customerDataField(transport, CREATE_DELIVERY_PREFERENCE_MUTATION, 'createCustomerDeliveryPreference', {
+                input: {
+                    customerId: input.customerId,
+                    fulfillmentHandlerCode: input.fulfillmentHandlerCode,
+                    name: input.name,
+                    values: input.values,
+                    isDefault: input.isDefault,
+                },
+            }, options);
+            return mark(value);
+        },
+        async update(id, input, options) {
+            const { value, mark } = await customerDataField(transport, UPDATE_DELIVERY_PREFERENCE_MUTATION, 'updateCustomerDeliveryPreference', 
+            // `undefined`, never an explicit null: what is left out stays off the wire, and kept.
+            { input: { id, name: input.name, values: input.values, isDefault: input.isDefault } }, options);
+            return mark(value);
+        },
+        async delete(id, options) {
+            assertDeleted('CUSTOMER_DELIVERY_PREFERENCE_NOT_DELETED', [
+                await fieldOf(transport, DELETE_DELIVERY_PREFERENCE_MUTATION, 'deleteCustomerDeliveryPreference', { id }, options),
+            ]);
+        },
+    };
+}

package/dist/customers/groups.d.ts

@@ -0,0 +1,207 @@
+/**
+ * Customer groups: the store's list, one group with a page of its members, create, change and
+ * delete, and which groups the store treats as trade (headless spec §9.2 `customers` "groups";
+ * W10-34). The membership doors (`add`, `remove`) and the customer master's external keys are
+ * wired beside these in `index.ts`.
+ *
+ * A group is the store's own row, or its organization's (`catalogueOwnership`): one row for every
+ * store that holds it. Its members are always the store's own customers.
+ */
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import { type CatalogueOwnership } from '../catalog/types.js';
+import type { Call, ListOptions } from '../types.js';
+import { type CustomerAddressSummary } from './wire.js';
+/** One of the store's customer groups, as `get`, `create` and `update` answer it. */
+export interface CustomerGroup {
+    id: string;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+    /** ISO-8601 UTC. */
+    updatedAt: string;
+    name: string;
+    /** This store's key for the group in the customer master, or `null` when no master keys it. */
+    externalKey: string | null;
+    /** Members see incoming (planned) stock on the storefront, where the store shows stock at all. */
+    canViewIncomingStock: boolean;
+    /** Members may order more than is in stock, within the store's or the variant's backorder policy. */
+    canBackorder: boolean;
+    /**
+     * The store's own group, or its organization's (shared while the organization shares
+     * `customer_groups`); see {@link CatalogueOwnership}. `editableHere` false: rename it, change
+     * its flags or delete it in the workspace.
+     */
+    catalogueOwnership: CatalogueOwnership;
+}
+/** One member of a group: a customer of the store. */
+export interface CustomerGroupMember {
+    id: string;
+    /** When the CUSTOMER was created, ISO-8601 UTC. The engine does not record when they joined. */
+    createdAt: string;
+    firstName: string;
+    lastName: string;
+    emailAddress: string;
+    /** The company flags of every address in the customer's book. */
+    addresses: CustomerAddressSummary[];
+    /**
+     * The customer's company: the default billing address's, else the default shipping address's,
+     * else the first address that names one; `null` when none does.
+     */
+    company: string | null;
+    /**
+     * Set when the caller's customer-data level blanked fields of this member (an app installation
+     * below `customerData: full`): `""` and `null` then mean "not granted".
+     */
+    redacted?: true;
+}
+/** A group read with `members`. */
+export interface CustomerGroupWithMembers extends CustomerGroup {
+    /**
+     * One page of the group's members in this store (`items`), and how many members the group has
+     * here in all, or how many of `filter.ids` are members (`total`). The members come in one fixed
+     * order (by id, not by name), so the pages of a walk never repeat or skip one.
+     */
+    members: {
+        items: CustomerGroupMember[];
+        total: number;
+    };
+}
+/** The engine's `adminListQueryLimit`: a larger page is refused. */
+export declare const MAX_CUSTOMER_GROUP_LIST_TAKE = 1000;
+/** Which page of a group's members `get` reads. */
+export interface CustomerGroupMembersOptions {
+    /** Members to skip, 0 when omitted. */
+    skip?: number;
+    /** Members per page, 1 to {@link MAX_CUSTOMER_GROUP_LIST_TAKE}; 25 when omitted. */
+    take?: number;
+    /**
+     * `ids`: only these customers. The answer then holds those of them that ARE members, which is
+     * how to ask "which of these are already in the group". An empty list matches nothing.
+     */
+    filter?: {
+        ids?: readonly string[];
+    };
+}
+/** One group as `list` answers it. */
+export interface CustomerGroupListItem {
+    id: string;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+    /** ISO-8601 UTC. */
+    updatedAt: string;
+    name: string;
+    canViewIncomingStock: boolean;
+    canBackorder: boolean;
+    /**
+     * How many of the store's customers are in the group, present only when the call asked for
+     * `include: ['memberCount']`.
+     */
+    memberCount?: number;
+}
+/** What a group list can be narrowed by. Several keys combine with AND. */
+export interface CustomerGroupListFilter {
+    /** These groups only. An empty list matches nothing. */
+    ids?: readonly string[];
+    /**
+     * The name contains this, ignoring case. The engine trims it, and reads `%` and `_` in it as
+     * wildcards.
+     */
+    name?: string;
+}
+export declare const CUSTOMER_GROUP_LIST_SORT_FIELDS: readonly ["name", "createdAt", "updatedAt"];
+export type CustomerGroupListSortField = (typeof CUSTOMER_GROUP_LIST_SORT_FIELDS)[number];
+export interface CustomerGroupListSort {
+    field: CustomerGroupListSortField;
+    direction: 'ASC' | 'DESC';
+}
+/** The blocks a list row can add: `memberCount`, how many of the store's customers are in it. */
+export declare const CUSTOMER_GROUP_LIST_INCLUDES: readonly ["memberCount"];
+export type CustomerGroupListInclude = (typeof CUSTOMER_GROUP_LIST_INCLUDES)[number];
+export interface CustomerGroupListOptions extends ListOptions {
+    filter?: CustomerGroupListFilter;
+    /** By name, A to Z, when omitted. */
+    sort?: CustomerGroupListSort;
+    /** Rows to skip, 0 when omitted. Not together with `after`. */
+    skip?: number;
+    /** Rows per page, 1 to {@link MAX_CUSTOMER_GROUP_LIST_TAKE}; `limit`, else 25, when omitted. */
+    take?: number;
+    include?: readonly CustomerGroupListInclude[];
+}
+export interface CreateCustomerGroupInput {
+    name: string;
+    /** Customers of the store to put in the group at once. One the store does not hold is left out. */
+    customerIds?: readonly string[];
+    /** See {@link CustomerGroup.canViewIncomingStock}. Off when omitted. */
+    canViewIncomingStock?: boolean;
+    /** See {@link CustomerGroup.canBackorder}. Off when omitted. */
+    canBackorder?: boolean;
+}
+/** A PATCH: an absent field keeps what the group has. */
+export interface UpdateCustomerGroupInput {
+    name?: string;
+    canViewIncomingStock?: boolean;
+    canBackorder?: boolean;
+}
+/** A group by id and name. */
+export interface CustomerGroupRef {
+    id: string;
+    name: string;
+}
+export interface CustomerB2BGroupsModule {
+    /**
+     * The groups this store treats as trade (B2B). A customer in one of them is a trade customer
+     * of the store: the storefront answers `isB2B` for them, and quote requests and B2B tax display
+     * follow it. Needs `ReadCustomerGroup`. `[]` when the store marked none.
+     *
+     * @effect read
+     */
+    list(options?: Call): Promise<CustomerGroupRef[]>;
+    /**
+     * REPLACE the store's trade groups with exactly these, and answer the new set. Read
+     * {@link list} first and send what should stay: a group left out stops being a trade group,
+     * and its members stop being trade customers. `[]` clears the set. Needs `UpdateCustomerGroup`.
+     *
+     * A group the store does not hold is a `NotFoundError` (`ENTITY_NOT_FOUND`), and nothing is
+     * changed.
+     *
+     * @effect write
+     */
+    set(groupIds: readonly string[], options?: Call): Promise<CustomerGroupRef[]>;
+}
+/** A customer group as `get`, `create` and `update` read it. */
+export declare const CUSTOMER_GROUP_FIELDS = "\n  id\n  createdAt\n  updatedAt\n  name\n  externalKey\n  \n  customFields {\n    canViewIncomingStock\n    canBackorder\n  }\n\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n";
+export declare const CUSTOMER_GROUP_QUERY = "\n  query CustomerGroup($id: ID!) {\n    customerGroup(id: $id) { \n  id\n  createdAt\n  updatedAt\n  name\n  externalKey\n  \n  customFields {\n    canViewIncomingStock\n    canBackorder\n  }\n\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n }\n  }\n";
+export declare const CUSTOMER_GROUP_MEMBERS_QUERY = "\n  query CustomerGroupWithMembers($id: ID!, $members: CustomerListOptions) {\n    customerGroup(id: $id) {\n      \n  id\n  createdAt\n  updatedAt\n  name\n  externalKey\n  \n  customFields {\n    canViewIncomingStock\n    canBackorder\n  }\n\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n\n      customers(options: $members) {\n        items {\n          id\n          createdAt\n          firstName\n          lastName\n          emailAddress\n          addresses {\n            company\n            defaultBillingAddress\n            defaultShippingAddress\n          }\n        }\n        totalItems\n      }\n    }\n  }\n";
+/**
+ * The list document for a set of blocks. The member count is the `totalItems` of a one-row page
+ * of the group's customers: a `take` of 0 would make that page every member.
+ *
+ * The count is still not a one-row read on the engine. channel-customer's `customerGroups` and
+ * `customerGroup` resolvers carry core's bare `@Relations(CustomerGroup)`, so for a document that
+ * selects `customers` under a group they also hand the service the `customers` relation, and it
+ * loads every member of each answered group before the field resolver counts or pages them (read
+ * in the plugin and core 3.6.3, not measured; the dashboard's documents before this module had
+ * the same shape). So `memberCount` is an `include`, asked for only where a count is shown. The
+ * fix is `omit: ['customers']` on those two resolvers, which this package cannot make.
+ */
+export declare function customerGroupListQuery(include: readonly CustomerGroupListInclude[]): string;
+export declare const CREATE_CUSTOMER_GROUP_MUTATION = "\n  mutation CreateCustomerGroup($input: CreateCustomerGroupInput!) {\n    createCustomerGroup(input: $input) { \n  id\n  createdAt\n  updatedAt\n  name\n  externalKey\n  \n  customFields {\n    canViewIncomingStock\n    canBackorder\n  }\n\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n }\n  }\n";
+export declare const UPDATE_CUSTOMER_GROUP_MUTATION = "\n  mutation UpdateCustomerGroup($input: UpdateCustomerGroupInput!) {\n    updateCustomerGroup(input: $input) { \n  id\n  createdAt\n  updatedAt\n  name\n  externalKey\n  \n  customFields {\n    canViewIncomingStock\n    canBackorder\n  }\n\n  \n  catalogueOwnership {\n    state\n    organizationName\n    editableHere\n  }\n\n }\n  }\n";
+export declare const DELETE_CUSTOMER_GROUP_MUTATION = "\n  mutation DeleteCustomerGroup($id: ID!) {\n    deleteCustomerGroup(id: $id) { \n  result\n  message\n }\n  }\n";
+export declare const DELETE_CUSTOMER_GROUPS_MUTATION = "\n  mutation DeleteCustomerGroups($ids: [ID!]!) {\n    deleteCustomerGroups(ids: $ids) { \n  result\n  message\n }\n  }\n";
+export declare const B2B_CUSTOMER_GROUPS_QUERY = "\n  query CustomerGroupRefs {\n    b2bCustomerGroups {\n      id\n      name\n    }\n  }\n";
+export declare const SET_B2B_CUSTOMER_GROUPS_MUTATION = "\n  mutation SetCustomerGroupRefs($groupIds: [ID!]!) {\n    setB2BCustomerGroups(groupIds: $groupIds) {\n      id\n      name\n    }\n  }\n";
+/** `customers.groups.get`. */
+export declare function readCustomerGroup(transport: Transport, id: string, options?: Call & {
+    members?: CustomerGroupMembersOptions;
+}): Promise<CustomerGroup | CustomerGroupWithMembers | null>;
+/** `customers.groups.list`. A refused option rejects the promise, like an engine refusal. */
+export declare function listCustomerGroups(transport: Transport, options?: CustomerGroupListOptions): Promise<Page<CustomerGroupListItem>>;
+/** `customers.groups.create`. */
+export declare function createCustomerGroup(transport: Transport, input: CreateCustomerGroupInput, options?: Call): Promise<CustomerGroup>;
+/** `customers.groups.update`. */
+export declare function updateCustomerGroup(transport: Transport, id: string, input: UpdateCustomerGroupInput, options?: Call): Promise<CustomerGroup>;
+/** `customers.groups.delete`. */
+export declare function deleteCustomerGroup(transport: Transport, id: string, options?: Call): Promise<void>;
+/** `customers.groups.deleteMany`. */
+export declare function deleteCustomerGroups(transport: Transport, ids: readonly string[], options?: Call): Promise<void>;
+export declare function createCustomerB2BGroupsModule(transport: Transport): CustomerB2BGroupsModule;