@01.software/sdk 0.33.0 → 0.34.0

package/dist/{payload-types-dkeQyrDC.d.cts → payload-types-C7tb7Xbs.d.cts}

@@ -102,6 +102,7 @@ interface Config {
         'reaction-types': ReactionType;
         bookmarks: Bookmark;
         'post-categories': PostCategory;
+        'post-tags': PostTag;
         reports: Report;
         'community-bans': CommunityBan;
         'event-calendars': EventCalendar;
@@ -270,6 +271,7 @@ interface Config {
         'reaction-types': ReactionTypesSelect<false> | ReactionTypesSelect<true>;
         bookmarks: BookmarksSelect<false> | BookmarksSelect<true>;
         'post-categories': PostCategoriesSelect<false> | PostCategoriesSelect<true>;
+        'post-tags': PostTagsSelect<false> | PostTagsSelect<true>;
         reports: ReportsSelect<false> | ReportsSelect<true>;
         'community-bans': CommunityBansSelect<false> | CommunityBansSelect<true>;
         'event-calendars': EventCalendarsSelect<false> | EventCalendarsSelect<true>;
@@ -549,6 +551,10 @@ interface Tenant {
          * Allow customer email sends for this event.
          */
         orderPaid?: boolean | null;
+        /**
+         * Allow customer email sends for this event.
+         */
+        orderCanceled?: boolean | null;
         /**
          * Allow customer email sends for this event.
          */
@@ -710,7 +716,7 @@ interface SystemMedia {
 interface FieldConfig {
     id: string;
     tenant?: (string | null) | Tenant;
-    collectionSlug: 'products' | 'product-variants' | 'product-options' | 'product-option-values' | 'product-collections' | 'product-categories' | 'product-tags' | 'brands' | 'discounts' | 'shipping-policies' | 'orders' | 'carts' | 'transactions' | 'fulfillments' | 'returns' | 'customers' | 'customer-groups' | 'customer-profiles' | 'customer-profile-lists' | 'article-authors' | 'articles' | 'article-categories' | 'article-tags' | 'documents' | 'document-categories' | 'document-types' | 'playlists' | 'playlist-categories' | 'playlist-tags' | 'tracks' | 'track-categories' | 'track-tags' | 'galleries' | 'gallery-categories' | 'gallery-tags' | 'gallery-items' | 'links' | 'link-categories' | 'link-tags' | 'canvases' | 'canvas-categories' | 'canvas-tags' | 'canvas-node-types' | 'canvas-edge-types' | 'videos' | 'video-categories' | 'video-tags' | 'live-streams' | 'forms' | 'posts' | 'comments' | 'reactions' | 'reaction-types' | 'bookmarks' | 'post-categories' | 'event-calendars' | 'events' | 'event-categories' | 'event-tags' | 'event-occurrences' | 'event-registrations';
+    collectionSlug: 'products' | 'product-variants' | 'product-options' | 'product-option-values' | 'product-collections' | 'product-categories' | 'product-tags' | 'brands' | 'discounts' | 'shipping-policies' | 'orders' | 'carts' | 'transactions' | 'fulfillments' | 'returns' | 'customers' | 'customer-groups' | 'customer-profiles' | 'customer-profile-lists' | 'article-authors' | 'articles' | 'article-categories' | 'article-tags' | 'documents' | 'document-categories' | 'document-types' | 'playlists' | 'playlist-categories' | 'playlist-tags' | 'tracks' | 'track-categories' | 'track-tags' | 'galleries' | 'gallery-categories' | 'gallery-tags' | 'gallery-items' | 'links' | 'link-categories' | 'link-tags' | 'canvases' | 'canvas-categories' | 'canvas-tags' | 'canvas-node-types' | 'canvas-edge-types' | 'videos' | 'video-categories' | 'video-tags' | 'live-streams' | 'forms' | 'posts' | 'comments' | 'reactions' | 'reaction-types' | 'bookmarks' | 'post-categories' | 'post-tags' | 'event-calendars' | 'events' | 'event-categories' | 'event-tags' | 'event-occurrences' | 'event-registrations';
     isHidden?: boolean | null;
     hiddenFields?: {
         [k: string]: unknown;
@@ -779,7 +785,7 @@ interface EmailLog {
      * Commerce notification send audit metadata. Consent classification remains owned by recipientConsent.
      */
     commerceNotification?: {
-        event?: ('orderPaid' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnCompleted') | null;
+        event?: ('orderPaid' | 'orderCanceled' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnCompleted') | null;
         intent?: (string | null) | CommerceNotificationIntent;
         dedupeKey?: string | null;
         order?: (string | null) | Order;
@@ -801,7 +807,7 @@ interface CommerceNotificationIntent {
      * Stable key that prevents duplicate notification intents within a tenant.
      */
     dedupeKey: string;
-    event: 'orderPaid' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnCompleted';
+    event: 'orderPaid' | 'orderCanceled' | 'fulfillmentShipped' | 'orderDelivered' | 'returnRequested' | 'returnCompleted';
     status: 'queued' | 'processing' | 'sent' | 'failed' | 'canceled';
     /**
      * Customer email address targeted by this notification.
@@ -1302,6 +1308,10 @@ interface Product {
      * Product detail gallery images. Order them in storefront display order.
      */
     images?: (string | Image)[] | null;
+    /**
+     * Optional primary image pointer from product media pool (images[]).
+     */
+    primaryMediaItemId?: (string | null) | Image;
     /**
      * Links this content to videos from the Mux-backed videos collection.
      */
@@ -1337,7 +1347,7 @@ interface Product {
     categories?: (string | ProductCategory)[] | null;
     tags?: (string | ProductTag)[] | null;
     /**
-     * Canonical storefront brand used for brand filtering and brand pages. Preserve external supplier names in the sidebar Vendor field.
+     * Canonical brand used for storefront brand filtering.
      */
     brand?: (string | null) | Brand;
     /**
@@ -1348,6 +1358,14 @@ interface Product {
      * Integer weight in grams. For example, enter 2500 for 2.5 kg.
      */
     weight?: number | null;
+    /**
+     * Supplier name imported from external systems, separate from the brand relationship.
+     */
+    vendor?: string | null;
+    /**
+     * External catalog product type, separate from categories.
+     */
+    productType?: string | null;
     /**
      * Collection memberships for this product. Managed from the collection edit view.
      */
@@ -1357,53 +1375,65 @@ interface Product {
         totalDocs?: number;
     };
     /**
-     * Minimum order quantity
+     * Minimum order quantity for this product.
      */
     minOrderQuantity?: number | null;
     /**
-     * Maximum order quantity
+     * Maximum order quantity for this product.
      */
     maxOrderQuantity?: number | null;
     /**
-     * Operator-selected primary option. Save the product, then add options to make this selectable. When selected, product cards/search expand this product by option value (for example, Color).
+     * Primary option used to expand this product into option-value cards.
      */
     listingPrimaryOption?: (string | null) | ProductOption;
     /**
-     * Automatically derived listing projection for product cards and search. Operators do not edit these fields directly.
+     * Automatically computed values for product cards and search.
      */
     listing?: {
         /**
-         * Variant prioritized for product cards. Automatically derived from sellable variants, active variants, and sort order. Storefront product cards use this as the option hint.
+         * Variant prioritized for product cards. Automatically derived.
          */
         selectionHintVariant?: (string | null) | ProductVariant;
         /**
-         * Primary image rendered by storefront product cards and search results. Product thumbnail/gallery media is preferred, then variant media is used as fallback.
+         * Primary image for product cards and search. Automatically derived.
          */
         primaryImage?: (string | null) | Image;
         /**
-         * Lowest active variant price. Automatically recalculated when variants change. Storefront cards and filters use this price.
+         * Lowest active variant price. Automatically derived.
          */
         minPrice?: number | null;
         /**
-         * Highest active variant price. Automatically recalculated when variants change. Storefront cards and filters use this price.
+         * Highest active variant price. Automatically derived.
          */
         maxPrice?: number | null;
         /**
-         * Lowest compare-at price across active variants. Automatically recalculated when variants change. Storefront discount displays use this value.
+         * Lowest compare-at price across active variants. Automatically derived.
          */
         minCompareAtPrice?: number | null;
         /**
-         * Highest compare-at price across active variants. Automatically recalculated when variants change. Storefront discount displays use this value.
+         * Highest compare-at price across active variants. Automatically derived.
          */
         maxCompareAtPrice?: number | null;
         /**
-         * Automatically enabled when the minimum and maximum active variant prices differ. Storefront cards use this to decide whether to show a price range.
+         * Automatically enabled when min and max prices differ.
          */
         isPriceRange?: boolean | null;
         /**
-         * Automatically enabled when at least one active variant is sellable. Storefront grids and filters use this to render and filter in-stock products.
+         * Enabled when at least one variant is sellable.
          */
         availableForSale?: boolean | null;
+        /**
+         * Automatically derived from the primary option setting.
+         */
+        groupingState?: ('grouped' | 'no_primary_option' | 'empty') | null;
+        /**
+         * Shown when grouping produces zero cards. Visible before publish.
+         */
+        groupingEmptyReason?: ('primary_option_not_linked' | 'primary_option_has_no_values' | 'no_variants_for_primary_option') | null;
+        /**
+         * Number of expandable option-value cards.
+         */
+        groupingCount?: number | null;
     };
     seo?: {
         /**
@@ -1438,7 +1468,7 @@ interface Product {
         };
     };
     /**
-     * Preferred thumbnail for product lists. When empty, list media or the first gallery image is used.
+     * Preferred thumbnail for product lists. Falls back to the first gallery image when empty.
      */
     thumbnail?: (string | null) | Image;
     /**
@@ -1454,25 +1484,17 @@ interface Product {
      */
     status?: ('draft' | 'published' | 'archived') | null;
     /**
-     * Automatically enabled when no active variant is sellable. A variant is sellable when it is active and either unlimited or has stock minus reserved stock greater than 0.
+     * Automatically enabled when no variant is sellable.
      */
     isSoldOut?: boolean | null;
     isFeatured?: boolean | null;
     /**
-     * Automatically stamped the first time a draft is published when empty. This is not used as a scheduled publish time.
+     * Automatically stamped the first time a draft is published.
      */
     publishedAt?: string | null;
     metadata?: {
         [k: string]: unknown;
     } | unknown[] | string | number | boolean | null;
-    /**
-     * Supplier name imported from external systems, separate from the brand relationship.
-     */
-    vendor?: string | null;
-    /**
-     * External catalog product type, separate from categories.
-     */
-    productType?: string | null;
     updatedAt: string;
     createdAt: string;
     deletedAt?: string | null;
@@ -1754,10 +1776,9 @@ interface ProductVariant {
      */
     product: string | Product;
     /**
-     * Leave blank to auto-generate from option values. Manual display labels are preserved.
+     * Auto-generated from option value combination.
      */
     title?: string | null;
-    thumbnail?: (string | null) | Image;
     images?: (string | Image)[] | null;
     /**
      * Variant-specific SKU
@@ -1776,13 +1797,21 @@ interface ProductVariant {
      */
     isUnlimited?: boolean | null;
     /**
-     * Tracked inventory. Available quantity is stock - reservedStock; isUnlimited bypasses stock tracking.
+     * Available quantity is stock minus reserved stock.
      */
     stock?: number | null;
     /**
-     * Server-owned reserved stock derived from held inventory-reservations. Only payment, cancellation, delivery, and inventory reservation reconcile paths update it.
+     * Reserved stock increased automatically during order processing.
      */
     reservedStock?: number | null;
+    /**
+     * Minimum quantity before low-stock alerts.
+     */
+    safetyStockThreshold?: number | null;
+    /**
+     * Inventory alert summary. Automatically derived.
+     */
+    inventoryAlertState?: ('untracked' | 'inactive' | 'out_of_stock' | 'low_stock' | 'ok') | null;
     /**
      * Variant-specific barcode
      */
@@ -1834,9 +1863,22 @@ interface ProductOptionValue {
      */
     value: string;
     /**
-     * Hex color swatch for this option value (for example #111111)
+     * Single visual swatch for this option value. Use either a color or one image from the product media pool.
      */
-    swatchColor?: string | null;
+    swatch?: {
+        /**
+         * How this option-value swatch is rendered.
+         */
+        type?: ('color' | 'media') | null;
+        /**
+         * Hex color swatch for this option value (for example #111111)
+         */
+        color?: string | null;
+        /**
+         * One image from the product media pool used as this option-value swatch.
+         */
+        mediaItemId?: (string | null) | Image;
+    };
     /**
      * When enabled, the slug will auto-generate from the title field on save and autosave.
      */
@@ -1845,14 +1887,6 @@ interface ProductOptionValue {
      * Compatibility URL token generated from the option-value label on create. It is fixed after creation.
      */
     slug: string;
-    /**
-     * Representative image for this option value. Listing group media uses variant media first, then option-value media, and finally product media.
-     */
-    thumbnail?: (string | null) | Image;
-    /**
-     * Reusable supporting images for this option value; used after variant media is missing, then followed by product media.
-     */
-    images?: (string | Image)[] | null;
     metadata?: {
         [k: string]: unknown;
     } | unknown[] | string | number | boolean | null;
@@ -1874,7 +1908,7 @@ interface ProductOption {
      */
     product: string | Product;
     /**
-     * Editable option display name for Admin and storefront copy. Changing it after creation does not change the public slug. (e.g. Color, Size)
+     * Option display name in Admin and storefront. (e.g. Color, Size)
      */
     title: string;
     /**
@@ -2734,9 +2768,21 @@ interface Webhook {
      */
     url: string;
     /**
-     * HMAC signing secret (immutable once set)
+     * HMAC signing secret (encrypted at rest, never returned on read). Reveal or rotate in Admin.
      */
     secret: string;
+    /**
+     * When the signing secret was first revealed to a tenant-admin (one time).
+     */
+    secretRevealedAt?: string | null;
+    /**
+     * Last webhook signing secret rotation time.
+     */
+    secretRotatedAt?: string | null;
+    /**
+     * User who last rotated the webhook signing secret.
+     */
+    secretRotatedBy?: (string | null) | User;
     /**
      * Collections to subscribe to. Leave empty to receive every supported collection event.
      */
@@ -2903,6 +2949,36 @@ interface TenantMetadatum {
          */
         twitterImage?: (string | null) | Image;
     };
+    /**
+     * Reusable option name and value lists for the Product Editor. Up to 20 presets.
+     */
+    optionPresets?: {
+        /**
+         * Name to identify this preset (e.g. Basic Clothing Sizes)
+         */
+        name: string;
+        /**
+         * Options included in this preset. Up to 10.
+         */
+        options?: {
+            /**
+             * Option name (e.g. Color, Size)
+             */
+            title?: string | null;
+            /**
+             * Values for this option. Up to 30.
+             */
+            values?: {
+                /**
+                 * Option value (e.g. Red, S)
+                 */
+                value?: string | null;
+                id?: string | null;
+            }[] | null;
+            id?: string | null;
+        }[] | null;
+        id?: string | null;
+    }[] | null;
     pwa?: {
         /**
          * Short name for PWA (12 characters max)
@@ -4842,6 +4918,7 @@ interface CanvasNodeType {
      * Optional #RRGGBB display color for Admin surfaces.
      */
     color?: string | null;
+    editorIntent?: ('text' | 'image') | null;
     defaultSize?: {
         width?: number | null;
         height?: number | null;
@@ -4910,6 +4987,7 @@ interface CanvasEdgeType {
      * Optional #RRGGBB display color for Admin surfaces.
      */
     color?: string | null;
+    isDefaultEdge?: boolean | null;
     strokeWidth?: number | null;
     isAnimated?: boolean | null;
     lineStyle?: ('default' | 'step' | 'smoothstep' | 'bezier') | null;
@@ -5021,6 +5099,7 @@ interface Post {
         [k: string]: unknown;
     } | null;
     categories?: (string | PostCategory)[] | null;
+    tags?: (string | PostTag)[] | null;
     /**
      * Comments on this post. Author and status are managed in the comments collection.
      */
@@ -5066,14 +5145,16 @@ interface Post {
      */
     isPinned?: boolean | null;
     /**
-     * Controls whether new comments can be created for this post.
+     * Author/operator discussion toggle. When false, new comments are blocked.
      */
     allowsComments?: boolean | null;
     visibility?: ('visible' | 'hidden') | null;
     /**
-     * Lock comments
+     * Moderator lock. When true, new comments are blocked regardless of allowsComments.
      */
     isLocked?: boolean | null;
+    editedAt?: string | null;
+    isEdited?: boolean | null;
     /**
      * Last comment or activity timestamp. Updated server-side for sorting and activity indicators.
      */
@@ -5122,6 +5203,37 @@ interface PostCategory {
     createdAt: string;
     deletedAt?: string | null;
 }
+/**
+ * Post tags are flat labels for search and loose topic grouping.
+ *
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "post-tags".
+ */
+interface PostTag {
+    id: string;
+    _order?: string | null;
+    title?: string | null;
+    /**
+     * When enabled, the slug will auto-generate from the title field on save and autosave.
+     */
+    generateSlug?: boolean | null;
+    slug?: string | null;
+    /**
+     * Short summary for listing/cards
+     */
+    description?: string | null;
+    /**
+     * Single representative taxonomy image. Add domain-specific fields for multiple images such as thumbnail and hero variants.
+     */
+    image?: (string | null) | Image;
+    /**
+     * Optional #RRGGBB hex color for taxonomy badges or filter UI. This does not replace the representative image.
+     */
+    color?: string | null;
+    updatedAt: string;
+    createdAt: string;
+    deletedAt?: string | null;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "comments".
@@ -6417,6 +6529,7 @@ interface TenantsSelect<T extends boolean = true> {
     };
     commerceNotifications?: T | {
         orderPaid?: T;
+        orderCanceled?: T;
         fulfillmentShipped?: T;
         orderDelivered?: T;
         returnRequested?: T;
@@ -6483,6 +6596,18 @@ interface TenantMetadataSelect<T extends boolean = true> {
         twitterDescription?: T;
         twitterImage?: T;
     };
+    optionPresets?: T | {
+        name?: T;
+        options?: T | {
+            title?: T;
+            values?: T | {
+                value?: T;
+                id?: T;
+            };
+            id?: T;
+        };
+        id?: T;
+    };
     pwa?: T | {
         shortName?: T;
         backgroundColor?: T;
@@ -6616,6 +6741,9 @@ interface WebhooksSelect<T extends boolean = true> {
     name?: T;
     url?: T;
     secret?: T;
+    secretRevealedAt?: T;
+    secretRotatedAt?: T;
+    secretRotatedBy?: T;
     subscriptions?: T | {
         collection?: T;
         id?: T;
@@ -6877,6 +7005,7 @@ interface ProductsSelect<T extends boolean = true> {
     subtitle?: T;
     description?: T;
     images?: T;
+    primaryMediaItemId?: T;
     videos?: T;
     content?: T;
     variants?: T;
@@ -6886,6 +7015,8 @@ interface ProductsSelect<T extends boolean = true> {
     brand?: T;
     shippingPolicy?: T;
     weight?: T;
+    vendor?: T;
+    productType?: T;
     collectionItems?: T;
     minOrderQuantity?: T;
     maxOrderQuantity?: T;
@@ -6899,6 +7030,9 @@ interface ProductsSelect<T extends boolean = true> {
         maxCompareAtPrice?: T;
         isPriceRange?: T;
         availableForSale?: T;
+        groupingState?: T;
+        groupingEmptyReason?: T;
+        groupingCount?: T;
     };
     seo?: T | {
         title?: T;
@@ -6919,8 +7053,6 @@ interface ProductsSelect<T extends boolean = true> {
     isFeatured?: T;
     publishedAt?: T;
     metadata?: T;
-    vendor?: T;
-    productType?: T;
     updatedAt?: T;
     createdAt?: T;
     deletedAt?: T;
@@ -6935,7 +7067,6 @@ interface ProductVariantsSelect<T extends boolean = true> {
     tenant?: T;
     product?: T;
     title?: T;
-    thumbnail?: T;
     images?: T;
     sku?: T;
     price?: T;
@@ -6943,6 +7074,8 @@ interface ProductVariantsSelect<T extends boolean = true> {
     isUnlimited?: T;
     stock?: T;
     reservedStock?: T;
+    safetyStockThreshold?: T;
+    inventoryAlertState?: T;
     barcode?: T;
     weight?: T;
     requiresShipping?: T;
@@ -6983,11 +7116,13 @@ interface ProductOptionValuesSelect<T extends boolean = true> {
     option?: T;
     displayLabel?: T;
     value?: T;
-    swatchColor?: T;
+    swatch?: T | {
+        type?: T;
+        color?: T;
+        mediaItemId?: T;
+    };
     generateSlug?: T;
     slug?: T;
-    thumbnail?: T;
-    images?: T;
     metadata?: T;
     updatedAt?: T;
     createdAt?: T;
@@ -8307,6 +8442,7 @@ interface CanvasNodeTypesSelect<T extends boolean = true> {
     slug?: T;
     description?: T;
     color?: T;
+    editorIntent?: T;
     defaultSize?: T | {
         width?: T;
         height?: T;
@@ -8344,6 +8480,7 @@ interface CanvasEdgeTypesSelect<T extends boolean = true> {
     slug?: T;
     description?: T;
     color?: T;
+    isDefaultEdge?: T;
     strokeWidth?: T;
     isAnimated?: T;
     lineStyle?: T;
@@ -8568,6 +8705,7 @@ interface PostsSelect<T extends boolean = true> {
     title?: T;
     content?: T;
     categories?: T;
+    tags?: T;
     comments?: T;
     displayTitle?: T;
     status?: T;
@@ -8590,6 +8728,8 @@ interface PostsSelect<T extends boolean = true> {
     allowsComments?: T;
     visibility?: T;
     isLocked?: T;
+    editedAt?: T;
+    isEdited?: T;
     lastActivityAt?: T;
     lastCommentByProfile?: T;
     isFeatured?: T;
@@ -8691,6 +8831,22 @@ interface PostCategoriesSelect<T extends boolean = true> {
     createdAt?: T;
     deletedAt?: T;
 }
+/**
+ * This interface was referenced by `Config`'s JSON-Schema
+ * via the `definition` "post-tags_select".
+ */
+interface PostTagsSelect<T extends boolean = true> {
+    _order?: T;
+    title?: T;
+    generateSlug?: T;
+    slug?: T;
+    description?: T;
+    image?: T;
+    color?: T;
+    updatedAt?: T;
+    createdAt?: T;
+    deletedAt?: T;
+}
 /**
  * This interface was referenced by `Config`'s JSON-Schema
  * via the `definition` "reports_select".
@@ -9181,4 +9337,4 @@ declare module 'payload' {
     }
 }
 
-export type { Article as A, CustomerProfile as C, Document as D, Form as F, Image as I, Order as O, Product as P, Reaction as R, Tenant as T, Video as V, CustomerProfileList as a, ProductCollection as b, Post as c, Comment as d, Config as e, ArticleAuthor as f, ArticleCategory as g, ArticleTag as h, Cart as i, CartItem as j, PostCategory as k, ProductVariant as l, Transaction as m, Fulfillment as n, Return as o };
+export type { Article as A, CustomerProfile as C, Document as D, Form as F, Image as I, Order as O, Product as P, Reaction as R, Tenant as T, Video as V, Webhook as W, CustomerProfileList as a, ProductCollection as b, Post as c, Comment as d, Config as e, ArticleAuthor as f, ArticleCategory as g, ArticleTag as h, Cart as i, CartItem as j, PostCategory as k, ProductVariant as l, Transaction as m, Fulfillment as n, Return as o };