@uniformdev/canvas 20.63.0 → 20.63.1-alpha.18

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { ApiClient, ExceptProject, ClientOptions, ApiClientError } from '@uniformdev/context/api';
+import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@uniformdev/context/api';
 export { ApiClientError } from '@uniformdev/context/api';
 import { AssetGetResponseSingle, AssetDefinitionType, AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
 export { AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
@@ -6,7 +6,7 @@ import { EndpointOut, EndpointHeadersOut, EndpointTransformationOut } from 'svix
 import { Quirks, StorageCommands, PersonalizedVariant, VariationMatchMetadata, TestVariant } from '@uniformdev/context';
 import { Options as Options$1 } from 'p-retry';
 import { Options } from 'p-throttle';
-import { RichTextBuiltInFormat as RichTextBuiltInFormat$1, RichTextBuiltInElement as RichTextBuiltInElement$1, RichTextParamConfiguration as RichTextParamConfiguration$1, ParameterRichTextValue } from '@uniformdev/richtext';
+import { RichTextBuiltInElement as RichTextBuiltInElement$1, RichTextBuiltInFormat as RichTextBuiltInFormat$1, RichTextParamConfiguration as RichTextParamConfiguration$1, ParameterRichTextValue } from '@uniformdev/richtext';
 
 interface paths$n {
     "/api/v1/canvas-definitions": {
@@ -2560,9 +2560,10 @@ interface components$o {
         skipParameterResolution: boolean;
         /** @description Matches entries based on whether they are pattern entries or regular entries.
          *     If true, only pattern entries will be returned.
-         *     If false (default), only regular entries will be returned
+         *     If false (default), only regular entries will be returned.
+         *     If 'any', both pattern and regular entries will be returned (useful for ID lookups).
          *      */
-        pattern: boolean;
+        pattern: boolean | "any";
         /** @description One or more locales to filter and localize by.
          *     Only entries that enable one of the specified locales _or enable no locales_ will be returned.
          *     The response will be localized to include only the first matching locale's data.
@@ -2584,10 +2585,21 @@ interface components$o {
          *      */
         releaseId: string;
         /** @description Search on textual fields of an entry.
-         *     Note: for long text fields the tail of the text is not guaranteed to be searchable.
+         *     Matches against fully rendered content including resolved pattern content.
+         *     Use this for "where does this content appear" queries.
+         *     Note: For long text fields, the tail of the text is not guaranteed to be searchable.
          *     Example: ?search=hello
          *      */
         search: string;
+        /**
+         * @deprecated
+         * @description BETA: Semantic search using vector similarity to find content by meaning.
+         *     Matches against source content only - pattern base content matches the pattern itself, not consumers.
+         *     Use this for "where is this content defined" queries.
+         *     Requires AI credits.
+         *
+         */
+        searchSemantic: string;
         /** @description Controls the edition resolution behavior.
          *
          *     auto: (default) Editions are evaluated automatically and the best matching edition is returned.
@@ -2987,7 +2999,8 @@ interface paths$k {
                     facetBy?: components$m["parameters"]["facetBy"];
                     /** @description Matches entries based on whether they are pattern entries or regular entries.
                      *     If true, only pattern entries will be returned.
-                     *     If false (default), only regular entries will be returned
+                     *     If false (default), only regular entries will be returned.
+                     *     If 'any', both pattern and regular entries will be returned (useful for ID lookups).
                      *      */
                     pattern?: components$m["parameters"]["pattern"];
                     /** @description The project the entry/entries are on */
@@ -3063,10 +3076,21 @@ interface paths$k {
                      *      */
                     releaseId?: components$m["parameters"]["releaseId"];
                     /** @description Search on textual fields of an entry.
-                     *     Note: for long text fields the tail of the text is not guaranteed to be searchable.
+                     *     Matches against fully rendered content including resolved pattern content.
+                     *     Use this for "where does this content appear" queries.
+                     *     Note: For long text fields, the tail of the text is not guaranteed to be searchable.
                      *     Example: ?search=hello
                      *      */
                     search?: components$m["parameters"]["search"];
+                    /**
+                     * @deprecated
+                     * @description BETA: Semantic search using vector similarity to find content by meaning.
+                     *     Matches against source content only - pattern base content matches the pattern itself, not consumers.
+                     *     Use this for "where is this content defined" queries.
+                     *     Requires AI credits.
+                     *
+                     */
+                    searchSemantic?: components$m["parameters"]["searchSemantic"];
                     /** @description Controls the edition resolution behavior.
                      *
                      *     auto: (default) Editions are evaluated automatically and the best matching edition is returned.
@@ -3932,9 +3956,10 @@ interface components$m {
         facetBy: string;
         /** @description Matches entries based on whether they are pattern entries or regular entries.
          *     If true, only pattern entries will be returned.
-         *     If false (default), only regular entries will be returned
+         *     If false (default), only regular entries will be returned.
+         *     If 'any', both pattern and regular entries will be returned (useful for ID lookups).
          *      */
-        pattern: boolean;
+        pattern: boolean | "any";
         /** @description The project the entry/entries are on */
         projectId: string;
         /** @description Publishing state to fetch. 0 = draft, 64 = published */
@@ -4008,10 +4033,21 @@ interface components$m {
          *      */
         releaseId: string;
         /** @description Search on textual fields of an entry.
-         *     Note: for long text fields the tail of the text is not guaranteed to be searchable.
+         *     Matches against fully rendered content including resolved pattern content.
+         *     Use this for "where does this content appear" queries.
+         *     Note: For long text fields, the tail of the text is not guaranteed to be searchable.
          *     Example: ?search=hello
          *      */
         search: string;
+        /**
+         * @deprecated
+         * @description BETA: Semantic search using vector similarity to find content by meaning.
+         *     Matches against source content only - pattern base content matches the pattern itself, not consumers.
+         *     Use this for "where is this content defined" queries.
+         *     Requires AI credits.
+         *
+         */
+        searchSemantic: string;
         /** @description Controls the edition resolution behavior.
          *
          *     auto: (default) Editions are evaluated automatically and the best matching edition is returned.
@@ -5133,13 +5169,21 @@ interface paths$e {
         get: {
             parameters: {
                 query: {
+                    /** @description The project ID to get labels for */
                     projectId: string;
+                    /** @description Number of records to skip */
                     offset?: number | null;
+                    /** @description Maximum number of records to return */
                     limit?: number;
+                    /** @description Comma-separated list of label public IDs */
                     labelIds?: string;
+                    /** @description Public ID of the parent group label */
                     groupId?: string;
+                    /** @description Filter to only group labels */
                     isGroup?: boolean | null;
+                    /** @description Filter labels with public ID prefix */
                     idPrefix?: string;
+                    /** @description Filter labels with display name prefix (case insensitive) */
                     namePrefix?: string;
                 };
                 header?: never;
@@ -5156,7 +5200,6 @@ interface paths$e {
                     content: {
                         "application/json": {
                             labels: {
-                                /** Format: uuid */
                                 projectId: string;
                                 label: {
                                     /** @description Public ID of the label (cannot be changed after creation) */
@@ -5206,7 +5249,6 @@ interface paths$e {
             requestBody: {
                 content: {
                     "application/json": {
-                        /** Format: uuid */
                         projectId: string;
                         label: {
                             /** @description Public ID of the label */
@@ -5255,10 +5297,7 @@ interface paths$e {
             requestBody: {
                 content: {
                     "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description The project ID
-                         */
+                        /** @description The project ID */
                         projectId: string;
                         /** @description Public ID of the label to delete */
                         labelId: string;
@@ -6377,7 +6416,7 @@ interface paths$c {
                     /** @description Matches compositions based on whether they are a pattern composition or a regular composition.
                      *     If true, only pattern compositions will be returned.
                      *     If false, only regular compositions will be returned.
-                     *     If omitted, both pattern and regular compositions will be returned.
+                     *     If omitted or 'any', both pattern and regular compositions will be returned.
                      *     This is a list query parameter and cannot be used with any primary query parameters
                      *      */
                     pattern?: components$d["parameters"]["pattern"];
@@ -6509,10 +6548,21 @@ interface paths$c {
                      *      */
                     releaseId?: components$d["parameters"]["releaseId"];
                     /** @description Search on textual fields of a composition.
-                     *     Note: For long text fields, the tail of the text is not guaranteed to be searchable
+                     *     Matches against fully rendered content including resolved pattern content.
+                     *     Use this for "where does this content appear" queries.
+                     *     Note: For long text fields, the tail of the text is not guaranteed to be searchable.
                      *     Example: ?search=hello
                      *      */
                     search?: components$d["parameters"]["search"];
+                    /**
+                     * @deprecated
+                     * @description BETA: Semantic search using vector similarity to find content by meaning.
+                     *     Matches against source content only - pattern base content matches the pattern itself, not consumers.
+                     *     Use this for "where is this content defined" queries.
+                     *     Requires AI credits.
+                     *
+                     */
+                    searchSemantic?: components$d["parameters"]["searchSemantic"];
                     /** @description Controls the edition resolution behavior.
                      *
                      *     auto: (default) Editions are evaluated automatically and the best matching edition is returned.
@@ -7467,10 +7517,10 @@ interface components$d {
         /** @description Matches compositions based on whether they are a pattern composition or a regular composition.
          *     If true, only pattern compositions will be returned.
          *     If false, only regular compositions will be returned.
-         *     If omitted, both pattern and regular compositions will be returned.
+         *     If omitted or 'any', both pattern and regular compositions will be returned.
          *     This is a list query parameter and cannot be used with any primary query parameters
          *      */
-        pattern: boolean;
+        pattern: boolean | "any";
         /** @description This specifies which type of patterns to return. This query parameter has no effect when `pattern` is false.
          *     * `all` - Returns all pattern instances
          *     * `component` - Returns only component patterns
@@ -7557,10 +7607,21 @@ interface components$d {
          *      */
         releaseId: string;
         /** @description Search on textual fields of a composition.
-         *     Note: For long text fields, the tail of the text is not guaranteed to be searchable
+         *     Matches against fully rendered content including resolved pattern content.
+         *     Use this for "where does this content appear" queries.
+         *     Note: For long text fields, the tail of the text is not guaranteed to be searchable.
          *     Example: ?search=hello
          *      */
         search: string;
+        /**
+         * @deprecated
+         * @description BETA: Semantic search using vector similarity to find content by meaning.
+         *     Matches against source content only - pattern base content matches the pattern itself, not consumers.
+         *     Use this for "where is this content defined" queries.
+         *     Requires AI credits.
+         *
+         */
+        searchSemantic: string;
         /** @description Controls the edition resolution behavior.
          *
          *     auto: (default) Editions are evaluated automatically and the best matching edition is returned.
@@ -7594,11 +7655,8 @@ interface paths$b {
                 query: {
                     /** @description Specify the composition ID to get history for */
                     compositionId: string;
-                    /**
-                     * @deprecated
-                     * @description The edition ID. When set, gets history for a child edition of the compositionId.
-                     *
-                     */
+                    /** @description The edition ID. When set, gets history for a child edition of the compositionId.
+                     *      */
                     editionId?: string;
                     /** @description The project the composition(s) are on */
                     projectId: string;
@@ -8770,10 +8828,10 @@ interface components$b {
         /** @description Matches compositions based on whether they are a pattern composition or a regular composition.
          *     If true, only pattern compositions will be returned.
          *     If false, only regular compositions will be returned.
-         *     If omitted, both pattern and regular compositions will be returned.
+         *     If omitted or 'any', both pattern and regular compositions will be returned.
          *     This is a list query parameter and cannot be used with any primary query parameters
          *      */
-        pattern: boolean;
+        pattern: boolean | "any";
         /** @description The project the composition(s) belong to */
         projectId: string;
         /** @description Specify a project map ID to fetch by path or node ID from.
@@ -8868,7 +8926,9 @@ interface components$b {
          *      */
         releaseId: string;
         /** @description Search on textual fields of an entry.
-         *     Note: for long text fields the tail of the text is not guaranteed to be searchable.
+         *     Matches against fully rendered content including resolved pattern content.
+         *     Use this for "where does this content appear" queries.
+         *     Note: For long text fields, the tail of the text is not guaranteed to be searchable.
          *     Example: ?search=hello
          *      */
         search: string;
@@ -10401,6 +10461,7 @@ interface paths$9 {
         get: {
             parameters: {
                 query: {
+                    /** @description The team ID */
                     teamId: string;
                 };
                 header?: never;
@@ -10419,17 +10480,24 @@ interface paths$9 {
                             /** @description A map of property types to a map of hook names to integration details */
                             propertyEditors: {
                                 [key: string]: {
-                                    [key: string]: {
+                                    createAIEdit?: {
                                         /** @description Internal unique identifier for the editor */
                                         id: string;
                                         /** @description The integration type */
                                         integrationType: string;
                                         /** @description Whether this is a public integration */
                                         isPublic: boolean;
-                                        /**
-                                         * Format: uuid
-                                         * @description The team ID for public integrations. Omitted for private integrations.
-                                         */
+                                        /** @description The team ID for public integrations. Omitted for private integrations. */
+                                        teamId?: string;
+                                    };
+                                    afterAIEdit?: {
+                                        /** @description Internal unique identifier for the editor */
+                                        id: string;
+                                        /** @description The integration type */
+                                        integrationType: string;
+                                        /** @description Whether this is a public integration */
+                                        isPublic: boolean;
+                                        /** @description The team ID for public integrations. Omitted for private integrations. */
                                         teamId?: string;
                                     };
                                 };
@@ -10462,10 +10530,7 @@ interface paths$9 {
             requestBody: {
                 content: {
                     "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description The team ID
-                         */
+                        /** @description The team ID */
                         teamId: string;
                         /** @description The property type to attach the editor to */
                         propertyType: string;
@@ -10522,10 +10587,7 @@ interface paths$9 {
             requestBody: {
                 content: {
                     "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description The team ID
-                         */
+                        /** @description The team ID */
                         teamId: string;
                         /** @description The property type to remove the editor from */
                         propertyType: string;
@@ -10797,7 +10859,6 @@ interface paths$8 {
                     content: {
                         "application/json": {
                             previewUrls: {
-                                /** Format: uuid */
                                 id: string;
                                 name: string;
                                 url: string;
@@ -10832,9 +10893,7 @@ interface paths$8 {
             requestBody: {
                 content: {
                     "application/json": {
-                        /** Format: uuid */
                         id?: string;
-                        /** Format: uuid */
                         projectId: string;
                         name: string;
                         url: string;
@@ -10851,7 +10910,6 @@ interface paths$8 {
                     };
                     content: {
                         "application/json": {
-                            /** Format: uuid */
                             id: string;
                         };
                     };
@@ -10863,7 +10921,6 @@ interface paths$8 {
                     };
                     content: {
                         "application/json": {
-                            /** Format: uuid */
                             id: string;
                         };
                     };
@@ -10894,9 +10951,7 @@ interface paths$8 {
             requestBody: {
                 content: {
                     "application/json": {
-                        /** Format: uuid */
                         id: string;
-                        /** Format: uuid */
                         projectId: string;
                     };
                 };
@@ -10909,7 +10964,6 @@ interface paths$8 {
                     };
                     content: {
                         "application/json": {
-                            /** Format: uuid */
                             id: string;
                         };
                     };
@@ -10998,10 +11052,7 @@ interface paths$7 {
             path?: never;
             cookie?: never;
         };
-        /**
-         * @deprecated
-         * @description Gets all preview viewports
-         */
+        /** @description Gets all preview viewports */
         get: {
             parameters: {
                 query: {
@@ -11022,7 +11073,6 @@ interface paths$7 {
                     content: {
                         "application/json": {
                             previewViewports: {
-                                /** Format: uuid */
                                 id: string;
                                 name: string;
                                 icon: string;
@@ -11046,10 +11096,7 @@ interface paths$7 {
                 500: components$7["responses"]["InternalServerError"];
             };
         };
-        /**
-         * @deprecated
-         * @description Upserts a preview viewport
-         */
+        /** @description Upserts a preview viewport */
         put: {
             parameters: {
                 query?: never;
@@ -11060,9 +11107,7 @@ interface paths$7 {
             requestBody: {
                 content: {
                     "application/json": {
-                        /** Format: uuid */
                         id?: string;
-                        /** Format: uuid */
                         projectId: string;
                         name: string;
                         icon: string;
@@ -11079,7 +11124,6 @@ interface paths$7 {
                     };
                     content: {
                         "application/json": {
-                            /** Format: uuid */
                             id: string;
                         };
                     };
@@ -11091,7 +11135,6 @@ interface paths$7 {
                     };
                     content: {
                         "application/json": {
-                            /** Format: uuid */
                             id: string;
                         };
                     };
@@ -11111,10 +11154,7 @@ interface paths$7 {
             };
         };
         post?: never;
-        /**
-         * @deprecated
-         * @description Deletes a preview viewport
-         */
+        /** @description Deletes a preview viewport */
         delete: {
             parameters: {
                 query?: never;
@@ -11125,9 +11165,7 @@ interface paths$7 {
             requestBody: {
                 content: {
                     "application/json": {
-                        /** Format: uuid */
                         id: string;
-                        /** Format: uuid */
                         projectId: string;
                     };
                 };
@@ -11140,7 +11178,6 @@ interface paths$7 {
                     };
                     content: {
                         "application/json": {
-                            /** Format: uuid */
                             id: string;
                         };
                     };
@@ -11931,7 +11968,6 @@ interface paths$3 {
             path?: never;
             cookie?: never;
         };
-        /** @deprecated */
         get: {
             parameters: {
                 query: {
@@ -11972,7 +12008,6 @@ interface paths$3 {
                 500: components$3["responses"]["InternalServerError"];
             };
         };
-        /** @deprecated */
         put: {
             parameters: {
                 query?: never;
@@ -12005,7 +12040,6 @@ interface paths$3 {
             };
         };
         post?: never;
-        /** @deprecated */
         delete: {
             parameters: {
                 query?: never;
@@ -12574,6 +12608,11 @@ type WalkNodeTreeOptions<TContext> = {
      * When false/unspecified, invalid block values will be ignored and traversal continues through valid data.
      */
     throwForInvalidBlockValues?: boolean;
+    /**
+     * Traversal order: 'dfs' (depth-first, default) or 'bfs' (breadth-first).
+     * DFS visits children before siblings; BFS visits siblings before children.
+     */
+    order?: 'dfs' | 'bfs';
 };
 /** Walks a composition's content tree, visiting each component in a slot or block parameter/field depth-first, in order. */
 declare function walkNodeTree<TContext = unknown>(node: ComponentInstance | EntryData | Array<NodeLocationReference>, visitor: (info: TreeNodeInfoTypes<TContext>) => void, options?: WalkNodeTreeOptions<TContext>): void;
@@ -13550,7 +13589,9 @@ interface paths$1 {
         get: {
             parameters: {
                 query?: {
+                    /** @description If provided, only return the specified team and its projects. If omitted, return all accessible teams. */
                     teamId?: string;
+                    /** @description Sort order for projects within each team. Defaults to name_ASC. */
                     orderBy?: "name_ASC" | "name_DESC" | "createdAt_ASC" | "createdAt_DESC";
                 };
                 header?: never;
@@ -13567,17 +13608,14 @@ interface paths$1 {
                     content: {
                         "application/json": {
                             teams: {
-                                /** Format: uuid */
                                 id: string;
                                 name: string;
                                 isPaid: boolean;
                                 /** @description The caller's role in this team (e.g. "Admin" or "User") */
                                 teamRole: string;
                                 projects: {
-                                    /** Format: uuid */
                                     id: string;
                                     name: string;
-                                    /** Format: uuid */
                                     projectTypeId: string;
                                     previewUrl: string;
                                     createdAt: string;
@@ -13745,9 +13783,13 @@ interface paths {
                 query: {
                     projectId: string;
                     type: "component" | "contentType" | "blockType" | "asset" | "componentPattern" | "entryPattern" | "compositionPattern" | "entry" | "dataType" | "dataSource" | "test";
+                    /** @description Entity IDs */
                     ids: string[];
+                    /** @description Whether to include a list of related instances in the response. Only supported when a single entity ID is provided */
                     withInstances?: boolean | null;
+                    /** @description Use this to paginate over the instances when "whenInstances" is true */
                     limit?: number;
+                    /** @description Use this to paginate over the instances when "whenInstances" is true */
                     offset?: number | null;
                 };
                 header?: never;
@@ -13770,14 +13812,12 @@ interface paths {
                                 publishedOnly: boolean;
                                 icon?: string;
                                 instance: {
-                                    /** Format: uuid */
                                     _id: string;
                                     _name: string;
                                     _pattern?: string;
                                 };
                                 /** @description When set, this is a child edition of the instance in _id */
                                 edition?: {
-                                    /** Format: uuid */
                                     id: string;
                                     name: string;
                                 };
@@ -13789,7 +13829,6 @@ interface paths {
                                     name: string;
                                 };
                                 release?: {
-                                    /** Format: uuid */
                                     id: string;
                                     name: string;
                                 };