@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/tenant/time-zone.js

@@ -0,0 +1,11 @@
+export const STORE_TIME_ZONE_QUERY = /* GraphQL */ `
+  query StoreTimeZone {
+    storeTimeZone
+  }
+`;
+export function createTenantTimeZoneReader(transport) {
+    return async (call) => {
+        const data = await transport.graphql({ api: 'admin', query: STORE_TIME_ZONE_QUERY }, call);
+        return data.storeTimeZone;
+    };
+}

package/dist/types.d.ts

@@ -5,15 +5,22 @@ export interface Call {
      * Sent as `Idempotency-Key` on a REST write. On a GraphQL one it is sent as
      * an ARGUMENT — the Admin API has no header for it — and only the mutations
      * that declare one act on it. Today those are the money mutations
-     * `payments.record`, `orders.park`, `orders.settle` and all three
+     * `payments.record`, `orders.park`, `orders.settle`, `orders.cancelWithMoney` and all three
      * `orders.surcharges.*`, plus `payments.providers.completeOnboarding`,
      * `payments.providers.terminals.provision`, `stock.adjust`,
      * `hooks.assignments.assign`, `customers.upsertByExternalRef`,
      * `customers.groups.replaceMembers`, `pricing.coupons.apply` / `remove`,
-     * `orders.setLinePrices` / `setOneTimeDiscounts`,
+     * `orders.setLinePrices` / `setOneTimeDiscounts`, `orders.correctFulfillmentQuantities`,
      * `pos.sale.applyCouponCode` / `removeCouponCode`, `storedValue.issue` / `adjust` /
      * `redeem`, `apps.releaseFieldGroup`, `catalog.products.bulk` and `orders.bulk` (both mint
-     * one when omitted), and `catalog.products.save`. Repeating one under the same key
+     * one when omitted), `catalog.products.save`, `orders.drafts.saveAddresses`,
+     * `orders.drafts.place` and `orders.drafts.cloneFrom` (both mint one when omitted),
+     * `fulfillments.create` and `fulfillments.warehouse.append` (both mint one when omitted),
+     * `quotes.convertToOrder` (mints one when omitted), `documents.issuePartialCreditNote` (mints
+     * one when omitted), and the
+     * accounts-receivable money doors `payments.ar.recordPayment` / `recordPrepaidDrawdown` /
+     * `directDebit.collectNow` and `documents.ar.issueCreditNote` / `generateInvoice` /
+     * `generateStatement`, and `returns.settle`. Repeating one under the same key
      * returns the first call's result instead of moving the money again; a
      * DIFFERENT request under the same key is refused with a `ConflictError`
      * (409) coded `IDEMPOTENCY_CONFLICT`, and a repeat that arrives while the
@@ -54,6 +61,46 @@ export interface ListOptions extends Call {
     after?: string;
     limit?: number;
 }
+/**
+ * One argument a configurable operation takes, as the engine publishes its definition: a
+ * payment handler's `apiKey`, an eligibility checker's `customerGroupIds`.
+ */
+export interface ConfigArgDefinition {
+    name: string;
+    /** The value's type as the engine names it: `string`, `int`, `float`, `boolean`, `datetime`, `ID`. */
+    type: string;
+    /** A list is sent as one JSON-encoded string, like every argument value. */
+    list: boolean;
+    /**
+     * NOT the enforced rule, in either direction. The engine publishes `true` for every argument
+     * whose declaration merely omits the flag, including ones nothing enforces, and can publish
+     * `false` for one a write then refuses. Never gate a form or a request on it: send what you
+     * have and read the engine's refusal.
+     */
+    required: boolean;
+    /** The declared default as JSON, or `null` when the argument has none. */
+    defaultValue: unknown;
+    /** In the language of the request; `null` when the declaration gives none. */
+    label: string | null;
+    /** In the language of the request; `null` when the declaration gives none. */
+    description: string | null;
+    /**
+     * How a form should render the argument, as declared: `{ component: 'password-form-input' }`
+     * marks a credential, `options` a fixed choice. `null` when nothing is declared.
+     */
+    ui: Record<string, unknown> | null;
+}
+/**
+ * A configurable operation the engine has registered (a payment handler, an eligibility
+ * checker, a shipping calculator, a promotion action): the `code` a stored operation names, and
+ * the arguments it takes.
+ */
+export interface ConfigurableOperationDefinition {
+    code: string;
+    /** What the operation does, in the language of the request. */
+    description: string;
+    args: ConfigArgDefinition[];
+}
 /** One channel the signed-in principal holds a role on. */
 export interface MeChannel {
     id: string;

package/dist/users/index.d.ts

@@ -1,5 +1,6 @@
 import type { Transport } from '@sixtyninecommerce/core';
 import type { Call } from '../types.js';
+import { type UserWarehousesModule } from './warehouses.js';
 /**
  * What `users.ensure` did. A newer engine may name an outcome this SDK does not know yet; it is
  * passed through, lower-cased, rather than dropped.
@@ -98,6 +99,8 @@ export interface UsersModule {
      * Someone outside the active store answers `ENTITY_NOT_FOUND`.
      */
     update(input: UpdateUserInput, call?: Call): Promise<StaffUser>;
+    /** Which of the store's warehouses a staff member works in. See {@link UserWarehousesModule}. */
+    warehouses: UserWarehousesModule;
 }
 export declare const ENSURE_ADMINISTRATOR_MUTATION = "\n  mutation EnsureAdministrator($input: EnsureAdministratorInput!) {\n    ensureAdministrator(input: $input) {\n      outcome\n      invitationSent\n      administrator { \n  id\n  firstName\n  lastName\n  emailAddress\n  user {\n    roles {\n      id\n      code\n    }\n  }\n }\n    }\n  }\n";
 export declare const UPDATE_ADMINISTRATOR_MUTATION = "\n  mutation UpdateStaffUser($input: UpdateAdministratorInput!) {\n    updateAdministrator(input: $input) { \n  id\n  firstName\n  lastName\n  emailAddress\n  user {\n    roles {\n      id\n      code\n    }\n  }\n }\n  }\n";

package/dist/users/index.js

@@ -1,3 +1,4 @@
+import { createUserWarehousesModule } from './warehouses.js';
 const STAFF_USER_FIELDS = /* GraphQL */ `
   id
   firstName
@@ -76,5 +77,6 @@ export function createUsersModule(transport) {
             }, call);
             return staffUserOf(data.updateAdministrator);
         },
+        warehouses: createUserWarehousesModule(transport),
     };
 }

package/dist/users/warehouses.d.ts

@@ -0,0 +1,50 @@
+import { type Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+/** A warehouse (stock location) a staff member is assigned to, by name. */
+export interface AssignedWarehouse {
+    id: string;
+    name: string;
+}
+/**
+ * `admin.users.warehouses`: which of the store's warehouses a staff member works in (spec §12.3,
+ * Settings → Team → a user → Warehouses). A user on the Warehouse role sees and ships only from
+ * the warehouses assigned here, and from none without any; a user who manages orders sees every
+ * warehouse whatever is assigned.
+ *
+ * Needs the store's `warehouse` entitlement: without it every method is refused
+ * `WAREHOUSE_NOT_ENABLED` (`BusinessRuleError`). Needs `ManageWarehouseAssignments` or
+ * `UpdateAdministrator` (either one, so no `@permission` tag: the tag can only say "all of
+ * these").
+ *
+ * Per store: the assignments of the store the client is on, never another store's. A staff member
+ * who holds no role in this store, a deleted one and a malformed id are refused alike, as a
+ * `ValidationError` naming the user.
+ *
+ * A credential restricted with `locationIds` (an API token or app) manages only those
+ * locations: `get` lists only the assigned warehouses among them, and `set` keeps the person's
+ * assignments at the store's other warehouses as they are.
+ */
+export interface UserWarehousesModule {
+    /**
+     * The warehouses the staff member is assigned to in this store, by name.
+     *
+     * @effect read
+     */
+    get(administratorId: string, options?: Call): Promise<AssignedWarehouse[]>;
+    /**
+     * Assign exactly these warehouses (an empty list: none), replacing the person's assignments in
+     * this store, and answer them. Repeating the call changes nothing.
+     *
+     * Refused before anything is written:
+     * - a warehouse that is not one of this store's (deleted, another store's, a malformed id) as a
+     *   `ValidationError` naming it; for a credential restricted with `locationIds`, any id outside
+     *   its locations is `LOCATION_OUT_OF_SCOPE` (`BusinessRuleError`) instead;
+     * - more than 200 warehouses (`ValidationError`).
+     *
+     * @effect write
+     */
+    set(administratorId: string, stockLocationIds: readonly string[], options?: Call): Promise<AssignedWarehouse[]>;
+}
+export declare const ADMINISTRATOR_WAREHOUSES_QUERY = "\n  query AdministratorWarehouses($administratorId: ID!) {\n    administratorWarehouses(administratorId: $administratorId) {\n      id\n      name\n    }\n  }\n";
+export declare const SET_ADMINISTRATOR_WAREHOUSES_MUTATION = "\n  mutation SetAdministratorWarehouses($administratorId: ID!, $stockLocationIds: [ID!]!) {\n    setAdministratorWarehouses(administratorId: $administratorId, stockLocationIds: $stockLocationIds) {\n      id\n      name\n    }\n  }\n";
+export declare function createUserWarehousesModule(transport: Transport): UserWarehousesModule;

package/dist/users/warehouses.js

@@ -0,0 +1,51 @@
+import { ValidationError } from '@sixtyninecommerce/core';
+import { fieldOf } from '../catalog/types.js';
+export const ADMINISTRATOR_WAREHOUSES_QUERY = /* GraphQL */ `
+  query AdministratorWarehouses($administratorId: ID!) {
+    administratorWarehouses(administratorId: $administratorId) {
+      id
+      name
+    }
+  }
+`;
+export const SET_ADMINISTRATOR_WAREHOUSES_MUTATION = /* GraphQL */ `
+  mutation SetAdministratorWarehouses($administratorId: ID!, $stockLocationIds: [ID!]!) {
+    setAdministratorWarehouses(administratorId: $administratorId, stockLocationIds: $stockLocationIds) {
+      id
+      name
+    }
+  }
+`;
+const invalidInput = (message) => new ValidationError({
+    code: 'USER_WAREHOUSES_INPUT_INVALID',
+    message,
+    status: 400,
+    service: 'vendure',
+});
+function assertAdministratorId(administratorId) {
+    if (typeof administratorId !== 'string' || administratorId.trim() === '') {
+        throw invalidInput('administratorId must be a staff member id.');
+    }
+}
+const toWarehouse = (wire) => ({
+    id: wire.id,
+    name: wire.name,
+});
+export function createUserWarehousesModule(transport) {
+    return {
+        async get(administratorId, options) {
+            assertAdministratorId(administratorId);
+            const rows = await fieldOf(transport, ADMINISTRATOR_WAREHOUSES_QUERY, 'administratorWarehouses', { administratorId }, options);
+            return rows.map(toWarehouse);
+        },
+        async set(administratorId, stockLocationIds, options) {
+            assertAdministratorId(administratorId);
+            if (!Array.isArray(stockLocationIds) ||
+                !stockLocationIds.every((id) => typeof id === 'string' && id.trim() !== '')) {
+                throw invalidInput('stockLocationIds must be a list of stock location ids.');
+            }
+            const rows = await fieldOf(transport, SET_ADMINISTRATOR_WAREHOUSES_MUTATION, 'setAdministratorWarehouses', { administratorId, stockLocationIds: [...stockLocationIds] }, options);
+            return rows.map(toWarehouse);
+        },
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sixtyninecommerce/admin",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Back-office SDK for sixtynine-commerce: every capability of the platform as a method",
   "homepage": "https://github.com/SIXTYNINE-digital/sixtynine-commerce-engine/tree/main/packages/admin-client#readme",
   "repository": {
@@ -33,7 +33,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@sixtyninecommerce/core": "^0.5.0"
+    "@sixtyninecommerce/core": "^0.7.0"
   },
   "devDependencies": {
     "@types/node": "22.19.7",