@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/seo/settings.d.ts

@@ -0,0 +1,147 @@
+import { type Transport } from '@sixtyninecommerce/core';
+import type { SettingsSourceKind } from '../tenant/settings-sources.js';
+import type { Call } from '../types.js';
+/**
+ * How a language shows in storefront URLs. Mirrors the meta catalog's `URL_LOCALE_STRATEGIES`
+ * (`packages/shared/src/meta-catalog/plugin-config-schemas.ts`), which the engine enforces,
+ * pinned by `__tests__/seo-settings.spec.ts`.
+ */
+export declare const URL_LOCALE_STRATEGIES: readonly ["path-prefix", "subdomain", "none"];
+export type UrlLocaleStrategy = (typeof URL_LOCALE_STRATEGIES)[number];
+/** What an AI crawler may do with the store's pages. */
+export type AiBotDirective = 'allow' | 'deny';
+/**
+ * The store's SEO defaults: the `settings.seo` group's channel half, which a member store may take
+ * from its organization.
+ */
+export interface SeoDefaults {
+    /** Without the `@`; storefronts emit it as `twitter:site`. Null for none. */
+    twitterHandle: string | null;
+    /** The asset shared as the OpenGraph image when a product has none; null for none. */
+    defaultOgImageId: string | null;
+    /** AI crawler → `allow` or `deny`. A crawler left out follows the storefront's own default. */
+    aiBotDefaults: Record<string, AiBotDirective>;
+    /** The storefront advertises its AI-friendly endpoints at `/llms.txt`. */
+    llmsTxtEnabled: boolean;
+    /** Plain text merged into the store's `robots.txt`; null for none. */
+    robotsTxtCustom: string | null;
+}
+/** Where the SEO defaults storefronts get come from (`settings.seo`). */
+export interface SeoDefaultsSource {
+    /** `channel`: the store's own defaults apply; `organization`: its organization's. */
+    source: SettingsSourceKind | (string & {});
+    /**
+     * The organization locks the group: {@link SeoSettingsModule.set} refuses a changed default with
+     * `MANAGED_BY_ORGANIZATION`, SuperAdmins included.
+     */
+    locked: boolean;
+    /** The organization shares the group without locking it, so the store may override it. */
+    inheritable: boolean;
+    /** The store keeps its own defaults although the organization shares the group. */
+    overridden: boolean;
+    /** The store's organization; null for a store outside any organization. */
+    organizationName: string | null;
+    /** The defaults storefronts get: the store's own while `source` is `channel`, else the organization's. */
+    effective: SeoDefaults;
+}
+/**
+ * The ACTIVE store's SEO settings as its channel stores them. The top-level defaults are the
+ * store's OWN values, which {@link SeoSettingsModule.set} writes; while the store takes
+ * `settings.seo` from its organization, storefronts get `defaultsSource.effective` instead.
+ */
+export interface SeoSettings extends SeoDefaults {
+    /** The store these are the settings of (its channel id). */
+    channelId: string;
+    defaultLanguageCode: string;
+    /** The store's languages, its default included. */
+    availableLanguageCodes: string[];
+    /**
+     * The storefront's address, the base of canonical, hreflang and sitemap URLs; null when none.
+     * Always the store's own. While the store has a default web head, the head's address is copied
+     * over it on every head change.
+     */
+    storefrontUrl: string | null;
+    /**
+     * How a language shows in storefront URLs; `path-prefix` when the store never chose. A string
+     * the engine accepts that this SDK does not name yet passes through. Always the store's own.
+     */
+    urlLocaleStrategy: UrlLocaleStrategy | (string & {});
+    /** The default language carries a prefix too. Always the store's own. */
+    urlLocalePrefixDefault: boolean;
+    defaultsSource: SeoDefaultsSource;
+}
+/**
+ * A patch of {@link SeoSettings}: a key left out is unchanged, `null` clears it. At least one key.
+ * The read-only keys `get` answers (`channelId`, the languages, `defaultsSource`) are ignored, so
+ * `set({ ...settings, urlLocaleStrategy: 'subdomain' })` works.
+ */
+export interface SeoSettingsPatch {
+    /** At most 255 characters; not checked to be a URL. */
+    storefrontUrl?: string | null;
+    /**
+     * One of {@link URL_LOCALE_STRATEGIES}, or null for the default (`path-prefix`). Typed as any
+     * string so a strategy `get` answered (one this SDK may not name yet) can be sent back; the
+     * engine refuses one it does not know (`USER_INPUT_ERROR`).
+     */
+    urlLocaleStrategy?: UrlLocaleStrategy | (string & {}) | null;
+    urlLocalePrefixDefault?: boolean | null;
+    /** At most 50 characters, without the `@`. */
+    twitterHandle?: string | null;
+    defaultOgImageId?: string | null;
+    /** The whole map (it replaces the stored one), as an object: the SDK encodes it. */
+    aiBotDefaults?: Record<string, AiBotDirective> | null;
+    llmsTxtEnabled?: boolean | null;
+    robotsTxtCustom?: string | null;
+}
+/**
+ * `admin.seo.settings`: the ACTIVE store's SEO channel settings (Settings → SEO): the storefront
+ * URL and how languages show in its URLs, and the SEO defaults (share card, AI crawlers,
+ * `llms.txt`, `robots.txt`). Stored as Channel custom fields; written through core `updateChannel`
+ * (typed per domain, ruling G80).
+ *
+ * The other half of the page, the SEO automation (automatic redirects, IndexNow, the audit
+ * schedule), lives on the plugins service: `admin.seo.config`.
+ */
+export interface SeoSettingsModule {
+    /**
+     * The settings, and where the defaults storefronts get come from. Reading needs an
+     * administrator of the store with any permission beyond `Authenticated`.
+     *
+     * @effect read
+     */
+    get(options?: Call): Promise<SeoSettings>;
+    /**
+     * Change the settings `patch` names, and answer them all as the engine now stores them. The
+     * storefront picks the change up on its next read of the store's settings.
+     *
+     * **Coded refusals:**
+     * - `SEO_SETTINGS_INVALID` → `ValidationError` (400), before any request: an empty patch, a
+     *   key that is not an SEO setting, or an `aiBotDefaults` that is not an object (or null). One
+     *   `details[]` entry per key, `field` naming it.
+     * - `CHANNEL_SETTINGS_INVALID` → `ValidationError` (400), from the engine: an `aiBotDefaults`
+     *   the platform's schema refuses (a directive other than `allow` or `deny`).
+     *   `details[].field` is `customFields.aiBotDefaults`.
+     * - `USER_INPUT_ERROR` → `ValidationError` (400): a `urlLocaleStrategy` outside
+     *   {@link URL_LOCALE_STRATEGIES}.
+     * - `MANAGED_BY_ORGANIZATION` → `BusinessRuleError` (422): a changed default while the
+     *   organization locks `settings.seo`.
+     * - `ORGANIZATION_SETTINGS_INHERITED` → `BusinessRuleError` (422): a changed default while the
+     *   store inherits the group; `tenant.settingsSources.override('settings.seo')` it first.
+     *   Sending the stored value back unchanged is accepted and changes nothing.
+     * - `ORGANIZATION_WORKSPACE_NOT_A_STORE` → `BusinessRuleError` (422): a storefront URL for an
+     *   organization's workspace, which has no storefront.
+     * - `FORBIDDEN` → `PermissionDeniedError` (403): the credential lacks `UpdateChannel`.
+     *
+     * @effect write
+     * @permission UpdateChannel
+     */
+    set(patch: SeoSettingsPatch, options?: Call): Promise<SeoSettings>;
+}
+export declare const SEO_SETTINGS_QUERY = "\n  query SeoSettings {\n    activeChannel { \n  id\n  defaultLanguageCode\n  availableLanguageCodes\n  customFields {\n    storefrontUrl\n    urlLocaleStrategy\n    urlLocalePrefixDefault\n    twitterHandle\n    defaultOgImageId\n    aiBotDefaults\n    llmsTxtEnabled\n    robotsTxtCustom\n  }\n }\n    channelSettingsSources { group source locked overridden inheritable organizationName values }\n  }\n";
+export declare const UPDATE_SEO_SETTINGS_MUTATION = "\n  mutation UpdateSeoSettings($input: UpdateChannelInput!) {\n    updateChannel(input: $input) {\n      ... on Channel { \n  id\n  defaultLanguageCode\n  availableLanguageCodes\n  customFields {\n    storefrontUrl\n    urlLocaleStrategy\n    urlLocalePrefixDefault\n    twitterHandle\n    defaultOgImageId\n    aiBotDefaults\n    llmsTxtEnabled\n    robotsTxtCustom\n  }\n }\n      ... on ErrorResult { errorCode message }\n    }\n  }\n";
+/**
+ * `aiBotDefaults` as the column stores it (JSON text) or already decoded (an organization's
+ * `values`); a directive other than `allow` or `deny` is left out, an unreadable value is none.
+ */
+export declare function readAiBotDefaults(raw: unknown): Record<string, AiBotDirective>;
+export declare function createSeoSettingsModule(transport: Transport): SeoSettingsModule;

package/dist/seo/settings.js

@@ -0,0 +1,209 @@
+import { errorFromErrorResult, isErrorResult, NotFoundError, ValidationError, } from '@sixtyninecommerce/core';
+/**
+ * How a language shows in storefront URLs. Mirrors the meta catalog's `URL_LOCALE_STRATEGIES`
+ * (`packages/shared/src/meta-catalog/plugin-config-schemas.ts`), which the engine enforces,
+ * pinned by `__tests__/seo-settings.spec.ts`.
+ */
+export const URL_LOCALE_STRATEGIES = ['path-prefix', 'subdomain', 'none'];
+/** The settings group the defaults belong to (multi-region spec §5.3). */
+const SEO_GROUP = 'settings.seo';
+const CHANNEL_FIELDS = /* GraphQL */ `
+  id
+  defaultLanguageCode
+  availableLanguageCodes
+  customFields {
+    storefrontUrl
+    urlLocaleStrategy
+    urlLocalePrefixDefault
+    twitterHandle
+    defaultOgImageId
+    aiBotDefaults
+    llmsTxtEnabled
+    robotsTxtCustom
+  }
+`;
+export const SEO_SETTINGS_QUERY = /* GraphQL */ `
+  query SeoSettings {
+    activeChannel { ${CHANNEL_FIELDS} }
+    channelSettingsSources { group source locked overridden inheritable organizationName values }
+  }
+`;
+export const UPDATE_SEO_SETTINGS_MUTATION = /* GraphQL */ `
+  mutation UpdateSeoSettings($input: UpdateChannelInput!) {
+    updateChannel(input: $input) {
+      ... on Channel { ${CHANNEL_FIELDS} }
+      ... on ErrorResult { errorCode message }
+    }
+  }
+`;
+const INVALID = 'SEO_SETTINGS_INVALID';
+const isRecord = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+const stringOrNull = (value) => (typeof value === 'string' ? value : null);
+/**
+ * `aiBotDefaults` as the column stores it (JSON text) or already decoded (an organization's
+ * `values`); a directive other than `allow` or `deny` is left out, an unreadable value is none.
+ */
+export function readAiBotDefaults(raw) {
+    let parsed = raw;
+    if (typeof raw === 'string') {
+        if (raw === '')
+            return {};
+        try {
+            parsed = JSON.parse(raw);
+        }
+        catch {
+            return {};
+        }
+    }
+    if (!isRecord(parsed))
+        return {};
+    const out = {};
+    for (const [bot, directive] of Object.entries(parsed)) {
+        if (directive === 'allow' || directive === 'deny')
+            out[bot] = directive;
+    }
+    return out;
+}
+function defaultsOf(fields) {
+    return {
+        twitterHandle: stringOrNull(fields.twitterHandle),
+        defaultOgImageId: stringOrNull(fields.defaultOgImageId),
+        aiBotDefaults: readAiBotDefaults(fields.aiBotDefaults),
+        llmsTxtEnabled: fields.llmsTxtEnabled === true,
+        robotsTxtCustom: stringOrNull(fields.robotsTxtCustom),
+    };
+}
+function sourceOf(sources, own) {
+    const group = sources.find((item) => item.group === SEO_GROUP);
+    if (!group) {
+        return {
+            source: 'channel',
+            locked: false,
+            inheritable: false,
+            overridden: false,
+            organizationName: null,
+            effective: own,
+        };
+    }
+    // The store's own defaults when its own apply: after `set` the sources are the ones read BEFORE
+    // the write, so their values would answer the old defaults. The organization's otherwise.
+    return {
+        source: group.source,
+        locked: group.locked,
+        inheritable: group.inheritable,
+        overridden: group.overridden,
+        organizationName: group.organizationName ?? null,
+        effective: group.source !== 'channel' && group.values ? defaultsOf(group.values) : own,
+    };
+}
+function settingsOf(channel, sources) {
+    const fields = channel.customFields ?? {};
+    const own = defaultsOf(fields);
+    return {
+        channelId: channel.id,
+        defaultLanguageCode: channel.defaultLanguageCode,
+        availableLanguageCodes: channel.availableLanguageCodes ?? [channel.defaultLanguageCode],
+        storefrontUrl: stringOrNull(fields.storefrontUrl),
+        urlLocaleStrategy: stringOrNull(fields.urlLocaleStrategy) ?? 'path-prefix',
+        urlLocalePrefixDefault: fields.urlLocalePrefixDefault === true,
+        ...own,
+        defaultsSource: sourceOf(sources, own),
+    };
+}
+const PATCH_KEYS = [
+    'storefrontUrl',
+    'urlLocaleStrategy',
+    'urlLocalePrefixDefault',
+    'twitterHandle',
+    'defaultOgImageId',
+    'aiBotDefaults',
+    'llmsTxtEnabled',
+    'robotsTxtCustom',
+];
+const KNOWN_KEYS = new Set(PATCH_KEYS);
+/** What `get` answers beside the settings: sent back in a spread, never written. */
+const READ_ONLY_KEYS = new Set([
+    'channelId',
+    'defaultLanguageCode',
+    'availableLanguageCodes',
+    'defaultsSource',
+]);
+function problemsOf(patch) {
+    const problems = [];
+    const add = (field, message) => problems.push({ field, code: INVALID, message });
+    if (!isRecord(patch)) {
+        add('patch', "Pass the settings to change as an object, e.g. { urlLocaleStrategy: 'none' }.");
+        return problems;
+    }
+    const named = Object.keys(patch).filter((key) => patch[key] !== undefined && !READ_ONLY_KEYS.has(key));
+    if (named.length === 0) {
+        add('patch', `Name at least one setting to change: ${PATCH_KEYS.join(', ')}.`);
+    }
+    for (const key of named) {
+        if (!KNOWN_KEYS.has(key)) {
+            add(key, `${key} is not an SEO setting; the settings are ${PATCH_KEYS.join(', ')}.`);
+        }
+    }
+    const bots = patch.aiBotDefaults;
+    if (bots !== undefined && bots !== null && !isRecord(bots)) {
+        // A string would be encoded a second time and stored as a JSON string, not a map.
+        add('aiBotDefaults', "aiBotDefaults must be an object of crawler → 'allow' | 'deny' (the SDK encodes it), or null to clear it.");
+    }
+    return problems;
+}
+/** The custom fields `patch` writes: only the keys it names, the bot map as the column's JSON. */
+function customFieldsOf(patch) {
+    const fields = {};
+    for (const key of PATCH_KEYS) {
+        const value = patch[key];
+        if (value === undefined)
+            continue;
+        fields[key] = key === 'aiBotDefaults' && value !== null ? JSON.stringify(value) : value;
+    }
+    return fields;
+}
+export function createSeoSettingsModule(transport) {
+    const read = async (options) => {
+        const data = await transport.graphql({ api: 'admin', query: SEO_SETTINGS_QUERY }, options);
+        if (!data.activeChannel) {
+            throw new NotFoundError({
+                code: 'CHANNEL_NOT_FOUND',
+                message: 'No store is active for this session, so it has no SEO settings to read.',
+                status: 404,
+                service: 'vendure',
+            });
+        }
+        return { channel: data.activeChannel, sources: data.channelSettingsSources ?? [] };
+    };
+    return {
+        async get(options) {
+            const { channel, sources } = await read(options);
+            return settingsOf(channel, sources);
+        },
+        async set(patch, options) {
+            const problems = problemsOf(patch);
+            if (problems.length > 0) {
+                throw new ValidationError({
+                    code: INVALID,
+                    message: problems.map((problem) => problem.message).join(' '),
+                    status: 400,
+                    service: 'vendure',
+                    details: problems,
+                });
+            }
+            // The id `updateChannel` needs, read with the SAME call options, so a per-call tenant
+            // writes its own store rather than the client's.
+            const { channel, sources } = await read(options);
+            const data = await transport.graphql({
+                api: 'admin',
+                query: UPDATE_SEO_SETTINGS_MUTATION,
+                variables: { input: { id: channel.id, customFields: customFieldsOf(patch) } },
+            }, options);
+            if (isErrorResult(data.updateChannel))
+                throw errorFromErrorResult(data.updateChannel);
+            // An SEO settings write never changes where the defaults come from, so the sources read
+            // just before still hold; `sourceOf` takes the new own defaults when the store's apply.
+            return settingsOf(data.updateChannel, sources);
+        },
+    };
+}

package/dist/shipping/definitions.d.ts

@@ -0,0 +1,29 @@
+import { type Transport } from '@sixtyninecommerce/core';
+import type { Call, ConfigurableOperationDefinition } from '../types.js';
+/** What a shipping method's three operations may be, each with the arguments it takes. */
+export interface ShippingDefinitions {
+    /** What a method's `calculator` may be: how it prices an order. */
+    calculators: ConfigurableOperationDefinition[];
+    /** What a method's `checker` may be: which orders it is offered for. */
+    eligibilityCheckers: ConfigurableOperationDefinition[];
+    /** What a method's `fulfillmentHandler` may be (`manual-fulfillment`, a carrier's handler). */
+    fulfillmentHandlers: ConfigurableOperationDefinition[];
+}
+/** `admin.shipping.definitions`. */
+export interface ShippingDefinitionsModule {
+    /**
+     * The calculators, eligibility checkers and fulfillment handlers the engine has registered, in
+     * one request: the same whichever store the client is on (a handler whose plugin the store does
+     * not hold is listed, and refused `PLUGIN_ACCESS_DENIED` when a method picks it). Labels and
+     * descriptions are in the language of the request. Needs `ReadSettings`, `ReadOrder` or
+     * `ReadShippingMethod` (any one).
+     *
+     * `args[].required` is NOT the enforced rule (see `ConfigArgDefinition.required`); never gate
+     * a form on it.
+     *
+     * @effect read
+     */
+    get(options?: Call): Promise<ShippingDefinitions>;
+}
+export declare const SHIPPING_DEFINITIONS_QUERY = "\n  query ShippingDefinitions {\n    shippingCalculators { \n  code\n  description\n  args {\n    name\n    type\n    list\n    required\n    defaultValue\n    label\n    description\n    ui\n  }\n }\n    shippingEligibilityCheckers { \n  code\n  description\n  args {\n    name\n    type\n    list\n    required\n    defaultValue\n    label\n    description\n    ui\n  }\n }\n    fulfillmentHandlers { \n  code\n  description\n  args {\n    name\n    type\n    list\n    required\n    defaultValue\n    label\n    description\n    ui\n  }\n }\n  }\n";
+export declare function createShippingDefinitionsModule(transport: Transport): ShippingDefinitionsModule;

package/dist/shipping/definitions.js

@@ -0,0 +1,47 @@
+import { UpstreamError } from '@sixtyninecommerce/core';
+const DEFINITION_FIELDS = /* GraphQL */ `
+  code
+  description
+  args {
+    name
+    type
+    list
+    required
+    defaultValue
+    label
+    description
+    ui
+  }
+`;
+export const SHIPPING_DEFINITIONS_QUERY = /* GraphQL */ `
+  query ShippingDefinitions {
+    shippingCalculators { ${DEFINITION_FIELDS} }
+    shippingEligibilityCheckers { ${DEFINITION_FIELDS} }
+    fulfillmentHandlers { ${DEFINITION_FIELDS} }
+  }
+`;
+export function createShippingDefinitionsModule(transport) {
+    return {
+        async get(options) {
+            const data = await transport.graphql({ api: 'admin', query: SHIPPING_DEFINITIONS_QUERY, variables: {} }, options);
+            // Each list is read by name, so a response missing one is refused, never answered empty.
+            const list = (field) => {
+                const value = data?.[field];
+                if (!Array.isArray(value)) {
+                    throw new UpstreamError({
+                        code: 'UNEXPECTED_RESPONSE',
+                        message: `The engine answered without "${field}".`,
+                        status: 502,
+                        service: 'vendure',
+                    });
+                }
+                return value;
+            };
+            return {
+                calculators: list('shippingCalculators'),
+                eligibilityCheckers: list('shippingEligibilityCheckers'),
+                fulfillmentHandlers: list('fulfillmentHandlers'),
+            };
+        },
+    };
+}

package/dist/shipping/fulfillment-profiles.d.ts

@@ -0,0 +1,174 @@
+import type { Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+/**
+ * A store's fulfillment profile: a named binding of a warehouse, a fulfillment handler, a
+ * shipping method and a minimum order. A fulfilment created with a profile is judged against its
+ * minimum and charged its shipping method's delivery cost (`fulfillments.profileChargePreview`
+ * prices it beforehand).
+ */
+export interface FulfillmentProfile {
+    id: string;
+    /** Stable per store; unique within the store. */
+    code: string;
+    name: string;
+    /** A disabled profile is not offered when fulfilling an order. */
+    enabled: boolean;
+    /** The warehouse (stock location) the profile ships from. */
+    stockLocationId: string;
+    /** The fulfillment handler (carrier) code, e.g. `manual-fulfillment`. */
+    defaultHandlerCode: string;
+    /** The shipping method whose price is the profile's delivery charge. */
+    shippingMethodId: string;
+    /**
+     * The minimum a fulfilment's selected lines must reach, in MINOR units of the store's default
+     * currency, NET of tax. `0` is no minimum.
+     */
+    minOrder: number;
+    /** True for the store's default profile, the one storefront checkout applies. */
+    isDefault: boolean;
+    /** ISO-8601, UTC. */
+    createdAt: string;
+    /** ISO-8601, UTC. */
+    updatedAt: string;
+}
+export interface CreateFulfillmentProfileInput {
+    name: string;
+    code: string;
+    /** Default `true`. */
+    enabled?: boolean;
+    /** One of the store's own stock locations. */
+    stockLocationId: string;
+    defaultHandlerCode: string;
+    /** One of the store's own shipping methods. */
+    shippingMethodId: string;
+    /** Minor units, net, in the store's default currency. Default `0`. */
+    minOrder?: number;
+}
+/** A PATCH: a key left out keeps the stored value. */
+export interface UpdateFulfillmentProfileInput {
+    name?: string;
+    code?: string;
+    enabled?: boolean;
+    stockLocationId?: string;
+    defaultHandlerCode?: string;
+    shippingMethodId?: string;
+    minOrder?: number;
+}
+/**
+ * Who is emailed when a fulfilment is created with a handler, in this store. One record per
+ * handler; a handler with no record notifies nobody.
+ */
+export interface FulfillmentHandlerNotification {
+    id: string;
+    handlerCode: string;
+    /** Off pauses the mails without forgetting the recipients. */
+    enabled: boolean;
+    /** Trimmed, de-duplicated (case-insensitive) addresses, at most 25. */
+    emails: string[];
+    /** ISO-8601, UTC. */
+    createdAt: string;
+    /** ISO-8601, UTC. */
+    updatedAt: string;
+}
+export interface SetFulfillmentHandlerNotificationInput {
+    handlerCode: string;
+    /** Left out: `true` for a new record, unchanged for an existing one. */
+    enabled?: boolean;
+    /** The WHOLE list: it replaces the stored one. `[]` clears it. */
+    emails: string[];
+}
+/** `admin.shipping.fulfillmentProfiles.handlerNotifications`. */
+export interface FulfillmentHandlerNotificationsModule {
+    /**
+     * Every handler's recipients in the store, by handler code. Needs `ReadShippingMethod`.
+     *
+     * @effect read
+     * @permission ReadShippingMethod
+     */
+    list(options?: Call): Promise<FulfillmentHandlerNotification[]>;
+    /**
+     * Create or replace one handler's recipients. Needs `UpdateShippingMethod`. Refused, with
+     * nothing saved, for a blank handler code, an address that is not one, or more than 25
+     * addresses (`USER_INPUT_ERROR`, a `ValidationError`). The handler code is not checked against
+     * the store's handlers: a record for a handler nothing uses is kept and never mails.
+     *
+     * @effect write
+     * @permission UpdateShippingMethod
+     */
+    set(input: SetFulfillmentHandlerNotificationInput, options?: Call): Promise<FulfillmentHandlerNotification>;
+}
+/**
+ * `admin.shipping.fulfillmentProfiles`: the fulfillment profiles of the store the client is
+ * scoped to. There is no channel argument; another store is addressed with
+ * `admin.withTenant(...)`.
+ *
+ * A well-formed profile id the store does not have (another store's, or none at all) is refused
+ * on every write with `FULFILLMENT_PROFILE_NOT_FOUND` (`NotFoundError`, 404), worded the same
+ * either way, and `get` answers `null` for it. An id that is not a uuid is refused by the engine
+ * before any of that, on every method `get` included, with `ENTITY_NOT_FOUND` (`NotFoundError`).
+ */
+export interface FulfillmentProfilesModule {
+    /**
+     * Every profile of the store, oldest first. Needs `ReadShippingMethod`.
+     *
+     * @effect read
+     * @permission ReadShippingMethod
+     */
+    list(options?: Call): Promise<FulfillmentProfile[]>;
+    /**
+     * One profile, or `null` when the store has none with that id.
+     *
+     * @effect read
+     * @permission ReadShippingMethod
+     */
+    get(id: string, options?: Call): Promise<FulfillmentProfile | null>;
+    /**
+     * Create a profile. Needs `UpdateShippingMethod`. A warehouse or shipping method the store
+     * does not have is refused `ENTITY_NOT_FOUND` (`NotFoundError`), the same for another store's
+     * id as for one that exists nowhere.
+     *
+     * @effect write
+     * @permission UpdateShippingMethod
+     */
+    create(input: CreateFulfillmentProfileInput, options?: Call): Promise<FulfillmentProfile>;
+    /**
+     * Change a profile; a key left out keeps its value. Needs `UpdateShippingMethod`. Refused
+     * `FULFILLMENT_PROFILE_NOT_FOUND` for a profile the store does not have, and
+     * `ENTITY_NOT_FOUND` for a warehouse or shipping method it does not have. A changed minimum
+     * binds the next fulfilment; fulfilments already created keep what they were charged.
+     *
+     * @effect write
+     * @permission UpdateShippingMethod
+     */
+    update(id: string, input: UpdateFulfillmentProfileInput, options?: Call): Promise<FulfillmentProfile>;
+    /**
+     * Delete a profile for good. When it was the store's default the store is left with NO
+     * default profile, so checkout applies no profile minimum until another is set. Fulfilments
+     * already created with it are unchanged. Needs `UpdateShippingMethod`; refused
+     * `FULFILLMENT_PROFILE_NOT_FOUND` for a profile the store does not have.
+     *
+     * @effect destructive
+     * @permission UpdateShippingMethod
+     */
+    delete(id: string, options?: Call): Promise<void>;
+    /**
+     * Make a profile the store's default (the one storefront checkout applies); answers it.
+     * Needs `UpdateShippingMethod`; refused `FULFILLMENT_PROFILE_NOT_FOUND` for a profile the
+     * store does not have.
+     *
+     * @effect write
+     * @permission UpdateShippingMethod
+     */
+    setDefault(id: string, options?: Call): Promise<FulfillmentProfile>;
+    /** Who is emailed when a fulfilment is created with a handler. */
+    handlerNotifications: FulfillmentHandlerNotificationsModule;
+}
+export declare const FULFILLMENT_PROFILES_QUERY = "\n  query FulfillmentProfiles {\n    fulfillmentProfiles { \n  id\n  code\n  name\n  enabled\n  stockLocationId\n  defaultHandlerCode\n  shippingMethodId\n  minOrder\n  isDefault\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const FULFILLMENT_PROFILE_QUERY = "\n  query FulfillmentProfile($id: ID!) {\n    fulfillmentProfile(id: $id) { \n  id\n  code\n  name\n  enabled\n  stockLocationId\n  defaultHandlerCode\n  shippingMethodId\n  minOrder\n  isDefault\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const CREATE_FULFILLMENT_PROFILE_MUTATION = "\n  mutation CreateFulfillmentProfile($input: CreateFulfillmentProfileInput!) {\n    createFulfillmentProfile(input: $input) { \n  id\n  code\n  name\n  enabled\n  stockLocationId\n  defaultHandlerCode\n  shippingMethodId\n  minOrder\n  isDefault\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const UPDATE_FULFILLMENT_PROFILE_MUTATION = "\n  mutation UpdateFulfillmentProfile($input: UpdateFulfillmentProfileInput!) {\n    updateFulfillmentProfile(input: $input) { \n  id\n  code\n  name\n  enabled\n  stockLocationId\n  defaultHandlerCode\n  shippingMethodId\n  minOrder\n  isDefault\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const DELETE_FULFILLMENT_PROFILE_MUTATION = "\n  mutation DeleteFulfillmentProfile($id: ID!) {\n    deleteFulfillmentProfile(id: $id) { result message }\n  }\n";
+export declare const SET_DEFAULT_FULFILLMENT_PROFILE_MUTATION = "\n  mutation SetDefaultFulfillmentProfile($id: ID!) {\n    setDefaultFulfillmentProfile(id: $id) { \n  id\n  code\n  name\n  enabled\n  stockLocationId\n  defaultHandlerCode\n  shippingMethodId\n  minOrder\n  isDefault\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const FULFILLMENT_HANDLER_NOTIFICATIONS_QUERY = "\n  query FulfillmentHandlerNotifications {\n    fulfillmentHandlerNotifications { \n  id\n  handlerCode\n  enabled\n  emails\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const SET_FULFILLMENT_HANDLER_NOTIFICATION_MUTATION = "\n  mutation SetFulfillmentHandlerNotification($input: SetFulfillmentHandlerNotificationInput!) {\n    setFulfillmentHandlerNotification(input: $input) { \n  id\n  handlerCode\n  enabled\n  emails\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare function createFulfillmentProfilesModule(transport: Transport): FulfillmentProfilesModule;