@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/catalog/recommendations.js

@@ -0,0 +1,237 @@
+/**
+ * Product recommendations (headless spec §9.2 `catalog`: "recommendations"; W10-13): the store's
+ * recommendation groups ("Customers also bought", "Complete the look"), what each one draws its
+ * products from, and the products hand-picked per product for a manual group.
+ *
+ * - **A `DYNAMIC` group's entries are its rules**, read in `position` order: one named product
+ *   (`PRODUCT`), the products of a collection (`COLLECTION`) or with a facet value
+ *   (`FACET_VALUE`), or the viewed product's own collections (`SAME_COLLECTION`) or properties
+ *   (`SAME_PROPERTIES`). The storefront fills the group up to `maxItems` from the first entry on,
+ *   never with the viewed product, a disabled product or one the store hides from the shopper.
+ * - **A `MANUAL` group has no entries**: its products are picked per viewed product
+ *   (`manual.set`), and the storefront shows them in the order picked. A group's mode is chosen
+ *   when it is created and never changes.
+ * - **A disabled group** (`enabled: false`) is kept but never shown on the storefront.
+ * - **Positions** are integers; a group or entry created without one goes after the last.
+ *   `reorder` rewrites them as `0, 1, 2…` in the order given.
+ *
+ * Permissions: reads need `ReadCatalog`, writes `UpdateCatalog`. Every row is the store's own: a
+ * group or entry of another store is never answered and never changed (a read answers `null` or
+ * leaves it out; a write refuses it as unknown), and a rule only ever draws from the store's own
+ * products, collections and facet values.
+ *
+ * Refusals, GraphQL errors mapped by `core`. An unknown id and another store's get the same answer,
+ * so none tells whether another store holds the row:
+ * - `ENTITY_NOT_FOUND` → `NotFoundError` (404): a group or entry the store does not have, and the
+ *   viewed product of `manual.set` when the store does not hold it.
+ * - `RECOMMENDATION_SOURCE_NOT_FOUND` → `NotFoundError` (404): a rule's `sourceId` that is not a
+ *   product, collection or facet value of the store (`entries.create`, `entries.update`).
+ * - `RECOMMENDATION_TARGET_NOT_FOUND` → `NotFoundError` (404): `manual.set` picks the store does
+ *   not hold, each named in the message and in `details` (`field` `/targetProductIds/<index>`).
+ * - `RECOMMENDATION_GROUP_SLUG_TAKEN` → `ConflictError` (409): another of the store's groups holds
+ *   the slug, also when two writes race for one free slug.
+ * - `RECOMMENDATION_MAX_ITEMS_INVALID` → `ValidationError` (400): a group's `maxItems` that is not
+ *   a whole number from 1 to 50 ({@link RECOMMENDATION_MAX_ITEMS_RANGE}), on `groups.create` and
+ *   on a `groups.update` that sends it, `details[0].field` `/input/maxItems`. This SDK refuses it
+ *   before anything is sent, with the same code and detail, so an older platform release (which
+ *   stores any value) never receives one.
+ * - `USER_INPUT_ERROR` → `ValidationError` (400), in the engine's words: a rule that does not fit
+ *   its group or its type (a `MANUAL` group, a `sourceId` missing or sent where none goes), picks
+ *   in a `DYNAMIC` group.
+ * - `FORBIDDEN` → `PermissionDeniedError` (403) without the permission.
+ *
+ * An id that is not a uuid (any id argument, a `sourceId` and each pick included) is refused
+ * before all of these with core's `ENTITY_NOT_FOUND` (`NotFoundError`, 404, no `details`), so
+ * branch on the class for not-found and on the code only to tell which row is missing.
+ *
+ * A platform release older than these codes answers each not-found and a taken slug as
+ * `USER_INPUT_ERROR` (400) in its own words ("Recommendation group not found"), a slug lost in a
+ * race as `DUPLICATE_RECORD`, and takes another store's collection or facet value as a rule's
+ * source.
+ *
+ * No release gate: every operation here is served by every platform release this SDK supports.
+ * No method deduplicates on `idempotencyKey`: repeating a `create` makes a second row.
+ */
+import { ValidationError } from '@sixtyninecommerce/core';
+import { assertDeleted, DELETION_FIELDS, fieldOf } from './types.js';
+/**
+ * The fewest and the most products a group may show (`maxItems`), both included. The platform
+ * refuses any other value with `RECOMMENDATION_MAX_ITEMS_INVALID`, and so does this SDK before
+ * sending.
+ */
+export const RECOMMENDATION_MAX_ITEMS_RANGE = { min: 1, max: 50 };
+/** The source types whose entry names a row (`sourceId`); the others must name none. */
+export const RECOMMENDATION_SOURCE_TYPES_WITH_ID = [
+    'PRODUCT',
+    'COLLECTION',
+    'FACET_VALUE',
+];
+const ENTRY_FIELDS = /* GraphQL */ `
+  id
+  groupId
+  sourceType
+  sourceId
+  position
+  createdAt
+  updatedAt
+`;
+const GROUP_SUMMARY_FIELDS = /* GraphQL */ `
+  id
+  name
+  slug
+  description
+  maxItems
+  position
+  enabled
+  mode
+  createdAt
+  updatedAt
+`;
+const GROUP_FIELDS = /* GraphQL */ `
+  ${GROUP_SUMMARY_FIELDS}
+  entries { ${ENTRY_FIELDS} }
+`;
+export const RECOMMENDATION_GROUPS_QUERY = /* GraphQL */ `
+  query CatalogRecommendationGroups {
+    recommendationGroups { ${GROUP_FIELDS} }
+  }
+`;
+export const RECOMMENDATION_GROUP_QUERY = /* GraphQL */ `
+  query CatalogRecommendationGroup($id: ID!) {
+    recommendationGroup(id: $id) { ${GROUP_FIELDS} }
+  }
+`;
+export const CREATE_RECOMMENDATION_GROUP_MUTATION = /* GraphQL */ `
+  mutation CatalogCreateRecommendationGroup($input: CreateRecommendationGroupInput!) {
+    createRecommendationGroup(input: $input) { ${GROUP_FIELDS} }
+  }
+`;
+export const UPDATE_RECOMMENDATION_GROUP_MUTATION = /* GraphQL */ `
+  mutation CatalogUpdateRecommendationGroup($id: ID!, $input: UpdateRecommendationGroupInput!) {
+    updateRecommendationGroup(id: $id, input: $input) { ${GROUP_FIELDS} }
+  }
+`;
+export const DELETE_RECOMMENDATION_GROUP_MUTATION = /* GraphQL */ `
+  mutation CatalogDeleteRecommendationGroup($id: ID!) {
+    deleteRecommendationGroup(id: $id) { ${DELETION_FIELDS} }
+  }
+`;
+export const REORDER_RECOMMENDATION_GROUPS_MUTATION = /* GraphQL */ `
+  mutation CatalogReorderRecommendationGroups($ids: [ID!]!) {
+    reorderRecommendationGroups(ids: $ids) { ${GROUP_FIELDS} }
+  }
+`;
+export const CREATE_RECOMMENDATION_ENTRY_MUTATION = /* GraphQL */ `
+  mutation CatalogCreateRecommendationEntry($input: CreateRecommendationEntryInput!) {
+    createRecommendationEntry(input: $input) { ${ENTRY_FIELDS} }
+  }
+`;
+export const UPDATE_RECOMMENDATION_ENTRY_MUTATION = /* GraphQL */ `
+  mutation CatalogUpdateRecommendationEntry($id: ID!, $input: UpdateRecommendationEntryInput!) {
+    updateRecommendationEntry(id: $id, input: $input) { ${ENTRY_FIELDS} }
+  }
+`;
+export const DELETE_RECOMMENDATION_ENTRY_MUTATION = /* GraphQL */ `
+  mutation CatalogDeleteRecommendationEntry($id: ID!) {
+    deleteRecommendationEntry(id: $id) { ${DELETION_FIELDS} }
+  }
+`;
+export const REORDER_RECOMMENDATION_ENTRIES_MUTATION = /* GraphQL */ `
+  mutation CatalogReorderRecommendationEntries($groupId: ID!, $ids: [ID!]!) {
+    reorderRecommendationEntries(groupId: $groupId, ids: $ids) { ${ENTRY_FIELDS} }
+  }
+`;
+// The engine does not load `entries` for these groups (a MANUAL group has none), and selecting a
+// non-null field it did not load fails the whole read: never add `entries` here.
+export const PRODUCT_MANUAL_RECOMMENDATIONS_QUERY = /* GraphQL */ `
+  query CatalogProductManualRecommendations($productId: ID!) {
+    productManualRecommendations(productId: $productId) {
+      group { ${GROUP_SUMMARY_FIELDS} }
+      productIds
+    }
+  }
+`;
+export const SET_PRODUCT_MANUAL_RECOMMENDATIONS_MUTATION = /* GraphQL */ `
+  mutation CatalogSetProductManualRecommendations(
+    $productId: ID!
+    $groupId: ID!
+    $targetProductIds: [ID!]!
+  ) {
+    setProductManualRecommendations(
+      productId: $productId
+      groupId: $groupId
+      targetProductIds: $targetProductIds
+    ) { ${GROUP_SUMMARY_FIELDS} }
+  }
+`;
+/**
+ * The platform's `maxItems` rule, checked before sending: a value present and not null must be a
+ * whole number in {@link RECOMMENDATION_MAX_ITEMS_RANGE}. Same code, message and detail as the
+ * engine's refusal, so a caller handles one shape whichever side refused.
+ */
+function assertMaxItems(input) {
+    const maxItems = input?.maxItems;
+    if (maxItems == null)
+        return;
+    const { min, max } = RECOMMENDATION_MAX_ITEMS_RANGE;
+    if (typeof maxItems === 'number' &&
+        Number.isInteger(maxItems) &&
+        maxItems >= min &&
+        maxItems <= max) {
+        return;
+    }
+    const message = `Max items must be a whole number from ${min} to ${max}; got ${JSON.stringify(maxItems)}`;
+    throw new ValidationError({
+        code: 'RECOMMENDATION_MAX_ITEMS_INVALID',
+        message,
+        status: 400,
+        service: 'vendure',
+        details: [{ field: '/input/maxItems', code: 'OUT_OF_RANGE', message }],
+    });
+}
+/** Entries in `position` order, the older first on a tie, as the engine's own entry reads sort. */
+function byPosition(entries) {
+    return [...entries].sort((a, b) => a.position - b.position || a.createdAt.localeCompare(b.createdAt));
+}
+// The engine's group list loads `entries` without an order; only its one-group read sorts them.
+function withSortedEntries(group) {
+    return { ...group, entries: byPosition(group.entries) };
+}
+export function createRecommendationsModule(transport) {
+    const call = (document, field, variables, options) => fieldOf(transport, document, field, variables, options);
+    return {
+        groups: {
+            list: async (options) => (await call(RECOMMENDATION_GROUPS_QUERY, 'recommendationGroups', {}, options)).map(withSortedEntries),
+            async get(id, options) {
+                const group = await call(RECOMMENDATION_GROUP_QUERY, 'recommendationGroup', { id }, options);
+                return group === null ? null : withSortedEntries(group);
+            },
+            create: async (input, options) => {
+                assertMaxItems(input);
+                return withSortedEntries(await call(CREATE_RECOMMENDATION_GROUP_MUTATION, 'createRecommendationGroup', { input }, options));
+            },
+            update: async (id, input, options) => {
+                assertMaxItems(input);
+                return withSortedEntries(await call(UPDATE_RECOMMENDATION_GROUP_MUTATION, 'updateRecommendationGroup', { id, input }, options));
+            },
+            async delete(id, options) {
+                const response = await call(DELETE_RECOMMENDATION_GROUP_MUTATION, 'deleteRecommendationGroup', { id }, options);
+                assertDeleted('RECOMMENDATION_GROUP_NOT_DELETED', [response]);
+            },
+            reorder: async (ids, options) => (await call(REORDER_RECOMMENDATION_GROUPS_MUTATION, 'reorderRecommendationGroups', { ids }, options)).map(withSortedEntries),
+        },
+        entries: {
+            create: (input, options) => call(CREATE_RECOMMENDATION_ENTRY_MUTATION, 'createRecommendationEntry', { input }, options),
+            update: (id, input, options) => call(UPDATE_RECOMMENDATION_ENTRY_MUTATION, 'updateRecommendationEntry', { id, input }, options),
+            async delete(id, options) {
+                const response = await call(DELETE_RECOMMENDATION_ENTRY_MUTATION, 'deleteRecommendationEntry', { id }, options);
+                assertDeleted('RECOMMENDATION_ENTRY_NOT_DELETED', [response]);
+            },
+            reorder: (groupId, ids, options) => call(REORDER_RECOMMENDATION_ENTRIES_MUTATION, 'reorderRecommendationEntries', { groupId, ids }, options),
+        },
+        manual: {
+            get: (productId, options) => call(PRODUCT_MANUAL_RECOMMENDATIONS_QUERY, 'productManualRecommendations', { productId }, options),
+            set: (productId, groupId, productIds, options) => call(SET_PRODUCT_MANUAL_RECOMMENDATIONS_MUTATION, 'setProductManualRecommendations', { productId, groupId, targetProductIds: productIds }, options),
+        },
+    };
+}

package/dist/catalog/reviews.d.ts

@@ -0,0 +1,381 @@
+/**
+ * Product reviews (headless spec §9.2 `catalog`: "reviews moderation"; W10-117): the reviews the
+ * store's customers wrote, moderating them (what the storefront shows under the store's name),
+ * the store's reply to one, the review statistics, and the review attributes (the questions a
+ * review form asks: "Quality", "Fit", …).
+ *
+ * - **What the storefront shows**: only `APPROVED` reviews, with the reviewer's display name,
+ *   rating, title, text, attribute answers and the store's reply. `PENDING` (waiting), `FLAGGED`
+ *   (the automatic checks or a shopper's report asked for a look) and `REJECTED` reviews are never
+ *   shown. Approving publishes the review; rejecting, flagging or re-opening it (`PENDING`) takes it
+ *   off. Each moderation is recorded in the review's moderation log with the staff member and the
+ *   reason given.
+ * - **The reply** is the store's own text, shown under an approved review on the storefront.
+ *
+ * Customer data (headless spec §6.3): an app installation below `customerData: full` reads every
+ * review with what the customer typed blanked: `title`, `body`, `attributeValues` (ratings and
+ * self-declared details such as an age band) and `ipAddressHash`, the edit history's previous
+ * texts and the moderation log's reasons and AI analysis answer `null`, and so does
+ * `customerDisplayName` below `identity`. Every record of such an answer carries `redacted: true`,
+ * so a blanked field never reads as "the customer wrote none". A `search` below `full` is refused
+ * `CUSTOMER_DATA_NOT_GRANTED` (`PermissionDeniedError`, 403). The answers of the writes are
+ * blanked the same way.
+ *
+ * Publishing needs `full` (user decision O6): approving a review (`moderate`, or `bulkModerate`
+ * with `APPROVED`) and `reply.set` publish under the store's name next to text a caller below
+ * `full` reads blanked, so an app installation below it (or a request narrowed below it) is
+ * refused them with `CUSTOMER_DATA_NOT_GRANTED` (`PermissionDeniedError`, 403; `bulkModerate`
+ * reports it on each review). It may still reject, flag or re-open a review and remove the
+ * store's reply. A staff session and a personal API token act at `full`.
+ *
+ * Permissions: reads need `ReadCatalog`, writes `UpdateCatalog`. Every row is the store's own: a
+ * review or attribute of another store is never answered and never changed.
+ *
+ * Refusals, GraphQL errors mapped by `core`. An unknown id and another store's get the same
+ * answer, so none tells whether another store holds the row:
+ * - `ENTITY_NOT_FOUND` → `NotFoundError` (404): a review or attribute the store does not have. An
+ *   id that is not a uuid gets it too, before anything is read.
+ * - `REVIEW_ATTRIBUTE_SLUG_TAKEN` → `ConflictError` (409): another of the store's attributes holds
+ *   the slug, the one derived from the label included, also when two writes race for it.
+ * - `REVIEW_ATTRIBUTE_COLLECTION_NOT_FOUND` → `NotFoundError` (404): `attributes.setCollections`
+ *   named a collection the store does not hold, each in `details` (`field` `/collectionIds/<i>`).
+ * - `BULK_ACTION_INPUT_INVALID` → `ValidationError` (400): a `bulkModerate` selection of no
+ *   review, more than {@link MAX_BULK_REVIEWS} or one twice, refused before anything is sent.
+ * - `USER_INPUT_ERROR` → `ValidationError` (400), in the engine's words: a reply over 2,000
+ *   characters, an attribute type other than `rating` / `selection`, a selection with fewer than
+ *   two options.
+ * - `FORBIDDEN` → `PermissionDeniedError` (403) without the permission.
+ *
+ * Release: `bulkModerate` needs a platform release with `moderateReviews` (deploy vendure-server
+ * first: an older one refuses the document). Every other method is served by every release this
+ * SDK supports; an older release answers each not-found and a taken slug as `USER_INPUT_ERROR`
+ * (400), a taken slug as an uncoded database error, and takes another store's collection in
+ * `setCollections`. No method deduplicates on `idempotencyKey`.
+ */
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+export type ReviewStatus = 'PENDING' | 'APPROVED' | 'REJECTED' | 'FLAGGED';
+export declare const REVIEW_STATUSES: readonly ReviewStatus[];
+/** The admin list's orders; ties go to the newer review. */
+export type ReviewSortKey = 'NEWEST' | 'OLDEST' | 'HIGHEST_RATING' | 'LOWEST_RATING' | 'MOST_HELPFUL';
+/** How many reviews one list page holds at most: the engine answers no more. */
+export declare const MAX_REVIEW_PAGE_SIZE = 50;
+/** How many reviews one `bulkModerate` call may name. */
+export declare const MAX_BULK_REVIEWS = 100;
+/** A review as the list and the writes answer it. */
+export interface ProductReviewSummary {
+    id: string;
+    channelId: string;
+    customerId: string;
+    productId: string;
+    /** The product's name in the request's language (any language when it has none); null when gone. */
+    productName: string | null;
+    variantId: string | null;
+    /** 1 to 5; null when the store asks for no rating. */
+    rating: number | null;
+    title: string | null;
+    body: string | null;
+    status: ReviewStatus;
+    /** True when the customer had an order with this product when they wrote it. */
+    isVerifiedPurchase: boolean;
+    /** ISO-8601 UTC. */
+    purchaseDate: string | null;
+    /** ISO-8601 UTC. */
+    deliveryDate: string | null;
+    isEdited: boolean;
+    editCount: number;
+    /** The reviewer's first and last name as the storefront shows them; null when none. */
+    customerDisplayName: string | null;
+    imageAssetIds: string[] | null;
+    videoAssetIds: string[] | null;
+    /** The answers to the review attributes, keyed by attribute id: a 1–5 rating or an option. */
+    attributeValues: Record<string, number | string> | null;
+    helpfulCount: number;
+    notHelpfulCount: number;
+    /** The store's reply, shown under the review once it is approved. */
+    merchantReply: string | null;
+    /** ISO-8601 UTC. */
+    merchantReplyAt: string | null;
+    /** A hash of the address the review was sent from (spam checks). */
+    ipAddressHash: string | null;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+    /** ISO-8601 UTC. */
+    updatedAt: string;
+    /**
+     * Set when the caller's customer-data level blanked part of the answer (an app installation
+     * below `customerData: full`): read a `null` text or name as "not granted", never as "none".
+     */
+    redacted?: true;
+}
+export interface ReviewEditHistoryEntry {
+    id: string;
+    previousRating: number | null;
+    previousTitle: string | null;
+    previousBody: string | null;
+    previousAttributeValues: Record<string, number | string> | null;
+    /** ISO-8601 UTC. */
+    editedAt: string;
+    /** True when the edit sent the review back to moderation. */
+    reEnteredModeration: boolean;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+}
+export interface ReviewModerationLogEntry {
+    id: string;
+    /** `profanity`, `spam`, `ai`, `manual` (staff) or `customer_report`. */
+    step: string;
+    /** `approved`, `rejected`, `flagged` or `skipped`. */
+    action: string;
+    reason: string | null;
+    /** The AI check's confidence, 0 to 1. */
+    confidence: number | null;
+    aiAnalysis: Record<string, unknown> | null;
+    /** The staff user (a User id) for a `manual` step. */
+    performedBy: string | null;
+    tokenUsage: {
+        inputTokens: number;
+        outputTokens: number;
+    } | null;
+    /** ISO-8601 UTC. */
+    createdAt: string;
+}
+/** One review with its edit history and moderation log, as `get` answers it. */
+export interface ProductReview extends ProductReviewSummary {
+    editHistory: ReviewEditHistoryEntry[];
+    moderationLogs: ReviewModerationLogEntry[];
+}
+export interface ReviewStats {
+    /** Every review of the store, whatever its status. */
+    totalReviews: number;
+    pendingCount: number;
+    approvedCount: number;
+    rejectedCount: number;
+    flaggedCount: number;
+    /** Over the approved reviews with a rating; null when there is none. */
+    averageRating: number | null;
+    /** Reviews of any status written in the last 7 days, counted back from now (not the calendar week). */
+    ratingsThisWeek: number;
+    /** Reviews of any status written in the last 30 days, counted back from now. */
+    ratingsThisMonth: number;
+}
+export interface ReviewListOptions extends Call {
+    status?: ReviewStatus;
+    productId?: string;
+    customerId?: string;
+    /**
+     * Matches the title or the text, any case (`%` and `_` are literal). Refused
+     * `CUSTOMER_DATA_NOT_GRANTED` below `customerData: full`: it searches what the customer typed.
+     */
+    search?: string;
+    /** 1 to 5. The engine filters nothing on any other value. */
+    rating?: number;
+    /** Defaults to `NEWEST`. */
+    sort?: ReviewSortKey;
+    /** 1 to {@link MAX_REVIEW_PAGE_SIZE}; 25 when left out. */
+    limit?: number;
+    /** The cursor from the previous page. */
+    after?: string;
+}
+/** A moderation: the status the review takes, and the reason recorded with it. */
+export interface ReviewModerationInput {
+    action: ReviewStatus;
+    /** Recorded in the review's moderation log; not shown on the storefront. */
+    reason?: string;
+}
+export interface ReviewBulkModerationInput extends ReviewModerationInput {
+    /** 1 to {@link MAX_BULK_REVIEWS} reviews of the store, each named once. */
+    ids: readonly string[];
+}
+/** One review's outcome in a `bulkModerate` call. */
+export interface ReviewModerationOutcome {
+    id: string;
+    /** `OK`, or `FAILED` (a string on the wire: read anything else as not done). */
+    status: 'OK' | 'FAILED' | (string & {});
+    /**
+     * When FAILED: the single door's own code: `ENTITY_NOT_FOUND` (no such review in this store),
+     * …; `INTERNAL_SERVER_ERROR` for a fault the engine logged.
+     */
+    code: string | null;
+    /** When FAILED: the door's sentence. */
+    message: string | null;
+}
+export type ReviewAttributeInputType = 'rating' | 'selection';
+export type ReviewAttributeSection = 'product' | 'demographic';
+/** A question the store's review form asks. */
+export interface ReviewAttribute {
+    id: string;
+    /** Unique within the store. */
+    slug: string;
+    label: string;
+    /** `rating` (1 to 5) or `selection` (one of `options`). A string on the wire. */
+    inputType: ReviewAttributeInputType | (string & {});
+    /** The choices of a `selection`; null for a `rating`. */
+    options: string[] | null;
+    isRequired: boolean;
+    /** A disabled attribute is kept but never asked. */
+    enabled: boolean;
+    /** `product` (feedback on the product) or `demographic` (about the reviewer). */
+    section: ReviewAttributeSection | (string & {});
+    position: number;
+    /**
+     * The store's collections the attribute is asked for: it applies to a product in any of them.
+     * Empty: it applies to every product.
+     */
+    collectionIds: string[];
+    /** ISO-8601 UTC. */
+    createdAt: string;
+    /** ISO-8601 UTC. */
+    updatedAt: string;
+}
+export interface CreateReviewAttributeInput {
+    label: string;
+    inputType: ReviewAttributeInputType;
+    /** Defaults to the label, lower-cased, every run of other characters than `a-z0-9` a `-`. */
+    slug?: string;
+    /** Required for a `selection`: at least two. */
+    options?: string[];
+    /** Defaults to false. */
+    isRequired?: boolean;
+    /** Defaults to true. */
+    enabled?: boolean;
+    /** Defaults to `product`. */
+    section?: ReviewAttributeSection;
+}
+/** Only the fields named change. */
+export interface UpdateReviewAttributeInput {
+    label?: string;
+    slug?: string;
+    inputType?: ReviewAttributeInputType;
+    options?: string[];
+    isRequired?: boolean;
+    enabled?: boolean;
+    section?: ReviewAttributeSection;
+}
+export interface ReviewsModule {
+    /**
+     * One page of the store's reviews, every status unless `status` is given, in `sort` order.
+     * `total` counts every match.
+     *
+     * @effect read
+     */
+    list(options?: ReviewListOptions): Promise<Page<ProductReviewSummary>>;
+    /**
+     * One review with its edit history and moderation log; `null` when the store has none with
+     * that id.
+     *
+     * @effect read
+     */
+    get(id: string, options?: Call): Promise<ProductReview | null>;
+    /** @effect read */
+    stats(options?: Call): Promise<ReviewStats>;
+    /**
+     * Give one review a status: `APPROVED` publishes it on the storefront; `REJECTED`, `FLAGGED`
+     * and `PENDING` take it off. Recorded in its moderation log with `reason`. The product's
+     * average rating follows within seconds. Refused (`ENTITY_NOT_FOUND`) for a review the store
+     * does not have. `APPROVED` is refused `CUSTOMER_DATA_NOT_GRANTED` (`PermissionDeniedError`) to
+     * a caller below `customerData: full`, whatever the review; the other statuses are open at every
+     * level.
+     *
+     * @effect write
+     */
+    moderate(id: string, input: ReviewModerationInput, options?: Call): Promise<ProductReviewSummary>;
+    /**
+     * Moderate many reviews in one call. Each goes through `moderate`'s rules in a transaction of
+     * its own and is reported on its own, in the order named: a refused review
+     * (`ENTITY_NOT_FOUND`) changes nothing, and the others still go through. A selection of no
+     * review, more than {@link MAX_BULK_REVIEWS} or one twice is refused
+     * `BULK_ACTION_INPUT_INVALID` (400) before anything is sent. Not keyed: a repeat moderates
+     * again (and logs again). Needs a platform release with `moderateReviews`. `APPROVED` below
+     * `customerData: full` reports every review `FAILED` with code `CUSTOMER_DATA_NOT_GRANTED` and
+     * changes none; the call itself succeeds.
+     *
+     * @effect write
+     */
+    bulkModerate(input: ReviewBulkModerationInput, options?: Call): Promise<ReviewModerationOutcome[]>;
+    /** The store's reply under a review. */
+    reply: {
+        /**
+         * Set (or replace) the store's reply, trimmed; shown under the review on the storefront once
+         * it is approved. Over 2,000 characters is refused (`USER_INPUT_ERROR`). An empty reply is
+         * stored as one: use `remove` to take a reply away. Refused `CUSTOMER_DATA_NOT_GRANTED`
+         * (`PermissionDeniedError`) below `customerData: full`: the reply is published under the
+         * store's name.
+         *
+         * @effect write
+         */
+        set(reviewId: string, reply: string, options?: Call): Promise<ProductReviewSummary>;
+        /**
+         * Take the store's reply away. Open at every customer-data level: it publishes nothing.
+         *
+         * @effect destructive
+         */
+        remove(reviewId: string, options?: Call): Promise<ProductReviewSummary>;
+    };
+    /** The questions the store's review form asks. */
+    attributes: {
+        /**
+         * Every attribute of the store, disabled ones included, in `position` order (ties: the
+         * older first). The engine answers them all at once; there are no pages.
+         *
+         * @effect read
+         */
+        list(options?: Call): Promise<ReviewAttribute[]>;
+        /**
+         * Created after the store's last attribute. Refused: a taken slug
+         * (`REVIEW_ATTRIBUTE_SLUG_TAKEN`), an unknown type or a selection with fewer than two
+         * options (`USER_INPUT_ERROR`).
+         *
+         * @effect write
+         */
+        create(input: CreateReviewAttributeInput, options?: Call): Promise<ReviewAttribute>;
+        /**
+         * Refused: an attribute the store does not have (`ENTITY_NOT_FOUND`), a slug another of its
+         * attributes holds (`REVIEW_ATTRIBUTE_SLUG_TAKEN`), a change to an unknown type or to a
+         * selection with fewer than two options (`USER_INPUT_ERROR`). Answers given before keep the
+         * attribute id they named; a review's answers are not rewritten.
+         *
+         * @effect write
+         */
+        update(id: string, input: UpdateReviewAttributeInput, options?: Call): Promise<ReviewAttribute>;
+        /**
+         * Deletes the attribute and its collection scoping. Reviews keep the answers given to it,
+         * no longer labelled. Refused (`ENTITY_NOT_FOUND`) for an attribute the store does not have.
+         *
+         * @effect destructive
+         */
+        delete(id: string, options?: Call): Promise<void>;
+        /**
+         * Gives the named attributes the positions `0, 1, 2…` in the order given, and answers every
+         * attribute as `list` does. An id the store does not hold is skipped without a word; an
+         * attribute left out keeps its position, which may then equal a named one's: name them all.
+         *
+         * @effect write
+         */
+        reorder(ids: string[], options?: Call): Promise<ReviewAttribute[]>;
+        /**
+         * Replace the collections the attribute is asked for (`[]`: every product). Repeats are
+         * dropped. A collection the store does not hold refuses the whole call and changes nothing
+         * (`REVIEW_ATTRIBUTE_COLLECTION_NOT_FOUND`, each in `details`), except one the attribute is
+         * already scoped to that the store no longer holds (deleted since), which is dropped: sending
+         * the attribute's `collectionIds` back always saves.
+         *
+         * @effect write
+         */
+        setCollections(attributeId: string, collectionIds: string[], options?: Call): Promise<ReviewAttribute>;
+    };
+}
+export declare const PRODUCT_REVIEWS_QUERY = "\n  query CatalogProductReviews($options: AdminReviewListOptions) {\n    adminProductReviews(options: $options) {\n      items { \n  id\n  channelId\n  customerId\n  productId\n  productName\n  variantId\n  rating\n  title\n  body\n  status\n  isVerifiedPurchase\n  purchaseDate\n  deliveryDate\n  isEdited\n  editCount\n  customerDisplayName\n  imageAssetIds\n  videoAssetIds\n  attributeValues\n  helpfulCount\n  notHelpfulCount\n  merchantReply\n  merchantReplyAt\n  ipAddressHash\n  createdAt\n  updatedAt\n }\n      totalItems\n    }\n  }\n";
+export declare const PRODUCT_REVIEW_QUERY = "\n  query CatalogProductReview($id: ID!) {\n    adminProductReview(id: $id) { \n  \n  id\n  channelId\n  customerId\n  productId\n  productName\n  variantId\n  rating\n  title\n  body\n  status\n  isVerifiedPurchase\n  purchaseDate\n  deliveryDate\n  isEdited\n  editCount\n  customerDisplayName\n  imageAssetIds\n  videoAssetIds\n  attributeValues\n  helpfulCount\n  notHelpfulCount\n  merchantReply\n  merchantReplyAt\n  ipAddressHash\n  createdAt\n  updatedAt\n\n  editHistory {\n    id\n    previousRating\n    previousTitle\n    previousBody\n    previousAttributeValues\n    editedAt\n    reEnteredModeration\n    createdAt\n  }\n  moderationLogs {\n    id\n    step\n    action\n    reason\n    confidence\n    aiAnalysis\n    performedBy\n    tokenUsage\n    createdAt\n  }\n }\n  }\n";
+export declare const REVIEW_STATS_QUERY = "\n  query CatalogReviewStats {\n    reviewStats {\n      totalReviews\n      pendingCount\n      approvedCount\n      rejectedCount\n      flaggedCount\n      averageRating\n      ratingsThisWeek\n      ratingsThisMonth\n    }\n  }\n";
+export declare const MODERATE_REVIEW_MUTATION = "\n  mutation CatalogModerateReview($id: ID!, $action: ReviewStatus!, $reason: String) {\n    moderateReview(id: $id, action: $action, reason: $reason) { \n  id\n  channelId\n  customerId\n  productId\n  productName\n  variantId\n  rating\n  title\n  body\n  status\n  isVerifiedPurchase\n  purchaseDate\n  deliveryDate\n  isEdited\n  editCount\n  customerDisplayName\n  imageAssetIds\n  videoAssetIds\n  attributeValues\n  helpfulCount\n  notHelpfulCount\n  merchantReply\n  merchantReplyAt\n  ipAddressHash\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const MODERATE_REVIEWS_MUTATION = "\n  mutation CatalogModerateReviews($input: ModerateReviewsInput!) {\n    moderateReviews(input: $input) {\n      items { id status code message }\n    }\n  }\n";
+export declare const SET_MERCHANT_REPLY_MUTATION = "\n  mutation CatalogSetMerchantReply($reviewId: ID!, $reply: String!) {\n    setMerchantReply(reviewId: $reviewId, reply: $reply) { \n  id\n  channelId\n  customerId\n  productId\n  productName\n  variantId\n  rating\n  title\n  body\n  status\n  isVerifiedPurchase\n  purchaseDate\n  deliveryDate\n  isEdited\n  editCount\n  customerDisplayName\n  imageAssetIds\n  videoAssetIds\n  attributeValues\n  helpfulCount\n  notHelpfulCount\n  merchantReply\n  merchantReplyAt\n  ipAddressHash\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const REMOVE_MERCHANT_REPLY_MUTATION = "\n  mutation CatalogRemoveMerchantReply($reviewId: ID!) {\n    removeMerchantReply(reviewId: $reviewId) { \n  id\n  channelId\n  customerId\n  productId\n  productName\n  variantId\n  rating\n  title\n  body\n  status\n  isVerifiedPurchase\n  purchaseDate\n  deliveryDate\n  isEdited\n  editCount\n  customerDisplayName\n  imageAssetIds\n  videoAssetIds\n  attributeValues\n  helpfulCount\n  notHelpfulCount\n  merchantReply\n  merchantReplyAt\n  ipAddressHash\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const REVIEW_ATTRIBUTES_QUERY = "\n  query CatalogReviewAttributes {\n    adminReviewAttributes { \n  id\n  slug\n  label\n  inputType\n  options\n  isRequired\n  enabled\n  section\n  position\n  collectionIds\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const CREATE_REVIEW_ATTRIBUTE_MUTATION = "\n  mutation CatalogCreateReviewAttribute($input: AdminReviewAttributeInput!) {\n    createReviewAttribute(input: $input) { \n  id\n  slug\n  label\n  inputType\n  options\n  isRequired\n  enabled\n  section\n  position\n  collectionIds\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const UPDATE_REVIEW_ATTRIBUTE_MUTATION = "\n  mutation CatalogUpdateReviewAttribute($id: ID!, $input: UpdateReviewAttributeInput!) {\n    updateReviewAttribute(id: $id, input: $input) { \n  id\n  slug\n  label\n  inputType\n  options\n  isRequired\n  enabled\n  section\n  position\n  collectionIds\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const DELETE_REVIEW_ATTRIBUTE_MUTATION = "\n  mutation CatalogDeleteReviewAttribute($id: ID!) {\n    deleteReviewAttribute(id: $id) { \n  result\n  message\n }\n  }\n";
+export declare const REORDER_REVIEW_ATTRIBUTES_MUTATION = "\n  mutation CatalogReorderReviewAttributes($ids: [ID!]!) {\n    reorderReviewAttributes(ids: $ids) { \n  id\n  slug\n  label\n  inputType\n  options\n  isRequired\n  enabled\n  section\n  position\n  collectionIds\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const SET_REVIEW_ATTRIBUTE_COLLECTIONS_MUTATION = "\n  mutation CatalogSetReviewAttributeCollections($attributeId: ID!, $collectionIds: [ID!]!) {\n    setReviewAttributeCollections(attributeId: $attributeId, collectionIds: $collectionIds) {\n      \n  id\n  slug\n  label\n  inputType\n  options\n  isRequired\n  enabled\n  section\n  position\n  collectionIds\n  createdAt\n  updatedAt\n\n    }\n  }\n";
+export declare function createReviewsModule(transport: Transport): ReviewsModule;