@uniformdev/canvas 19.35.2 → 19.36.0

package/dist/index.d.ts

@@ -105,7 +105,7 @@ interface components$4 {
             /** @description Friendly name of the component definition */
             name: string;
             /**
-             * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+             * @description Icon name for the component definition (e.g. 'screen')
              * @default screen
              */
             icon?: string;
@@ -123,6 +123,22 @@ interface components$4 {
             canBeComposition?: boolean;
             /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
             parameters?: components$4["schemas"]["ComponentDefinitionParameter"][];
+            /**
+             * Format: uuid
+             * @description Reference to the category this component definition belongs to
+             * @default null
+             */
+            categoryId?: string | null;
+            /**
+             * @description Description of the component definition
+             * @default null
+             */
+            description?: string;
+            /**
+             * @description Description of the component definition
+             * @default null
+             */
+            previewImageUrl?: string;
             /**
              * @description if this component uses team permissions or custom permissions
              * @default true
@@ -466,6 +482,21 @@ interface components$4 {
         DataResourceVariables: {
             [key: string]: string;
         };
+        /** @description Category for tagging canvas entities */
+        Category: {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the category
+             */
+            id: string;
+            /** @description Display name of the category */
+            name: string;
+            /**
+             * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
+             * @default 0
+             */
+            order?: number;
+        };
         /** @description Project map node information related to a component. */
         CompositionProjectMapNodeInfo: {
             /**
@@ -484,25 +515,696 @@ interface components$4 {
     };
 }
 
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths$9 {
+    "/api/v1/canvas-definitions": {
+        get: {
+            parameters: {
+                query: {
+                    /** The project ID to get component definitions for. */
+                    projectId: string;
+                    /** Limit list to one result by ID (response remains an array). */
+                    componentId?: string;
+                    /** Number of records to skip */
+                    offset?: number;
+                    /** Max number of records to return */
+                    limit?: number;
+                    /** Whether to fetch system meta-component definitions (personalize, test, etc) */
+                    includeSystem?: boolean;
+                    /** Filtration by category ID */
+                    categories?: string[];
+                };
+            };
+            responses: {
+                /** OK */
+                200: {
+                    content: {
+                        "application/json": {
+                            /** @description Component definitions that match the query */
+                            componentDefinitions: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
+                        };
+                    };
+                };
+                400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+        };
+        /** Upserts a component definition */
+        put: {
+            responses: {
+                /** OK */
+                204: never;
+                400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description The project ID to upsert the component definition to
+                         */
+                        projectId: string;
+                        componentDefinition: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
+                    };
+                };
+            };
+        };
+        /** Deletes a component definition */
+        delete: {
+            responses: {
+                /** OK */
+                204: never;
+                400: external$a["swagger.yml"]["components"]["responses"]["BadRequestError"];
+                401: external$a["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
+                403: external$a["swagger.yml"]["components"]["responses"]["ForbiddenError"];
+                429: external$a["swagger.yml"]["components"]["responses"]["RateLimitError"];
+                500: external$a["swagger.yml"]["components"]["responses"]["InternalServerError"];
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        /** @description The public ID of the component definition to delete */
+                        componentId: string;
+                        /**
+                         * Format: uuid
+                         * @description The ID of the project the composition to delete belongs to
+                         */
+                        projectId: string;
+                    };
+                };
+            };
+        };
+        /** Handles preflight requests. This endpoint allows CORS. */
+        options: {
+            responses: {
+                /** OK */
+                204: never;
+            };
+        };
+    };
+}
+interface external$a {
+    "swagger.yml": {
+        paths: {};
+        components: {
+            schemas: {
+                Error: {
+                    /** @description Error message(s) that occurred while processing the request */
+                    errorMessage?: string[] | string;
+                };
+            };
+            responses: {
+                /** Request input validation failed */
+                BadRequestError: {
+                    content: {
+                        "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** API key or token was not valid */
+                UnauthorizedError: {
+                    content: {
+                        "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Permission was denied */
+                ForbiddenError: {
+                    content: {
+                        "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Resource not found */
+                NotFoundError: {
+                    content: {
+                        "application/json": external$a["swagger.yml"]["components"]["schemas"]["Error"];
+                    };
+                };
+                /** Too many requests in allowed time period */
+                RateLimitError: unknown;
+                /** Execution error occurred */
+                InternalServerError: unknown;
+            };
+        };
+        operations: {};
+    };
+    "uniform-canvas-types.swagger.yml": {
+        paths: {};
+        components: {
+            schemas: {
+                /** @description Public ID (used in code). Do not change after creation. */
+                PublicIdProperty: string;
+                /** @description The definition of a component parameter */
+                ComponentDefinitionParameter: {
+                    id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the parameter */
+                    name: string;
+                    /** @description Appears next to the parameter in the Composition editor */
+                    helpText?: string;
+                    /** @description Type name of the parameter (provided by a Uniform integration) */
+                    type: string;
+                    /** @description The configuration object for the type (type-specific) */
+                    typeConfig?: unknown;
+                };
+                /** @description The definition of a named component slot that can contain other components */
+                ComponentDefinitionSlot: {
+                    id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the slot */
+                    name: string;
+                    /** @description A list of component definition public IDs that are allowed in this named slot */
+                    allowedComponents: string[];
+                    /**
+                     * @description Whether this slot inherits its allowed components from the parent slot it lives in. If true, allowedComponents is irrelevant.
+                     * If allowAllComponents is true, this value is ignored.
+                     *
+                     * @default false
+                     */
+                    inheritAllowedComponents: boolean;
+                    /**
+                     * @description When false or not defined, only components in allowedComponents may be added to this slot - and if allowedComponents is empty, nothing can be added.
+                     * When true, every component and pattern that is defined may be added to this slot regardless of any other setting including inheritAllowedComponents.
+                     */
+                    allowAllComponents?: boolean;
+                    /**
+                     * @description When not defined, or false: all patterns for components listed in allowedComponents are automatically allowed in the slot.
+                     * When true: patterns for components listed in allowedComponents are not allowed in the slot unless explicitly added to allowedComponents as `$p:<patternid>`
+                     */
+                    patternsInAllowedComponents?: boolean;
+                    /** @description Minimum valid number of components in this slot */
+                    minComponents?: number;
+                    /** @description Maximum valid number of components in this slot */
+                    maxComponents?: number;
+                };
+                /** @description The definition of a composition's slug settings */
+                ComponentDefinitionSlugSettings: {
+                    /**
+                     * @description Whether the slug is required
+                     * no: slug is optional
+                     * yes: slug is required
+                     * disabled: slug is disabled and will not be shown in the editor
+                     *
+                     * @default no
+                     * @enum {string}
+                     */
+                    required?: "no" | "yes" | "disabled";
+                    /**
+                     * @description Slug uniqueness configuration.
+                     * no = no unique constraint
+                     * local = must be unique within this component type
+                     * global = must be unique across all component types
+                     *
+                     * @enum {string}
+                     */
+                    unique?: "no" | "local" | "global";
+                    /** @description Regular expression slugs must match */
+                    regularExpression?: string;
+                    /**
+                     * @description Custom error message when regular expression validation fails.
+                     * Has no effect if `regularExpression` is not set.
+                     */
+                    regularExpressionMessage?: string;
+                };
+                /** @description The definition of a component variant */
+                ComponentDefinitionVariant: {
+                    id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the variant */
+                    name: string;
+                };
+                /** @description Permission set for a component defintion */
+                ComponentDefinitionPermission: {
+                    roleId: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /**
+                     * @description Permission type for this permission ComponentDefinition:
+                     * read | write | create | delete
+                     *
+                     * @enum {string}
+                     */
+                    permission: "read" | "write" | "create" | "delete";
+                    /** @description State of the component that this permission applies to */
+                    state: number;
+                };
+                /** @description Defines a component type that can live on a Composition */
+                ComponentDefinition: {
+                    id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the component definition */
+                    name: string;
+                    /**
+                     * @description Icon name for the component definition (e.g. 'screen')
+                     * @default screen
+                     */
+                    icon?: string;
+                    /**
+                     * @description The public ID of the parameter whose value should be used to create a display title for this component in the UI.
+                     * The parameter type must support being used as a title parameter for this to work.
+                     *
+                     * @default null
+                     */
+                    titleParameter?: string | null;
+                    /**
+                     * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
+                     * @default false
+                     */
+                    canBeComposition?: boolean;
+                    /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
+                    parameters?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
+                    /**
+                     * @description if this component uses team permissions or custom permissions
+                     * @default true
+                     */
+                    useTeamPermissions?: boolean;
+                    /** @description Custom role permissions for this component definition */
+                    permissions?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
+                    /** @description The named slots for this component; placement areas where arrays of other components can be added. */
+                    slots?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlot"][];
+                    slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
+                    /** @description Default component instance value */
+                    defaults?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"] | null;
+                    /** @description Named variants for this component; enables creation of visual variants that use the same parameter data */
+                    variants?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionVariant"][];
+                    /** @description Created date string for this definition (ignored for writes) */
+                    created?: string;
+                    /** @description Last modified date string for this definition (ignored for writes) */
+                    updated?: string;
+                };
+                /** @description Defines a content type */
+                ContentType: {
+                    id: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
+                    /** @description Friendly name of the content type */
+                    name: string;
+                    /**
+                     * @description The public ID of the field whose value should be used to create a display name for entries of this content type in the UI.
+                     * The field type must support being used as an entry name for this to work.
+                     */
+                    entryName?: string | null;
+                    /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
+                    fields?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /** @description Created date string for this content type (ignored for writes) */
+                    created?: string;
+                    /** @description Last modified date string for this content type (ignored for writes) */
+                    updated?: string;
+                };
+                /** @description Defines an editable parameter on a component. */
+                ComponentParameter: {
+                    /** @description The value of the parameter. Any JSON-serializable value is acceptable. */
+                    value: unknown;
+                    /** @description The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
+                    type: string;
+                    connectedData?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataElementConnectionDefinition"];
+                };
+                /**
+                 * @description Defines a connection to a data element on a data resource.
+                 *
+                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
+                 * Future updates that do not break the edgehanced/data-bound state of a composition may be made without notice.
+                 */
+                DataElementConnectionDefinition: {
+                    /** @description A JSON Pointer expression that defines the data element to connect the parameter to. */
+                    pointer: string;
+                    /**
+                     * @description The syntax used to select the data element to bind to
+                     * @enum {string}
+                     */
+                    syntax: "jptr";
+                };
+                /** @description Defines the shape of a component instance served by the composition API. */
+                ComponentInstance: {
+                    /** @description Type of the component instance (public_id of its definition) */
+                    type: string;
+                    /** @description Component parameter values for the component instance */
+                    parameters?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
+                    };
+                    /** @description Public ID of alternate visual appearance for this component, if any selected */
+                    variant?: string;
+                    /** @description Slots containing any child components */
+                    slots?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
+                    };
+                    /**
+                     * @description Unique identifier of the component within the composition.
+                     * No assumptions should be made about the format of this value other than "it will be unique."
+                     * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
+                     * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
+                     */
+                    _id?: string;
+                    /** @description Indicates this component instance should be sourced from a pattern library pattern. */
+                    _pattern?: string;
+                    _dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
+                    /**
+                     * @description Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
+                     * Means nothing for PUTs; it will be ignored.
+                     */
+                    _patternDataResources?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
+                    };
+                    /**
+                     * @description Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
+                     * CYCLIC: A cyclic pattern graph was detected, which could not be resolved because it would cause an infinite loop.
+                     * NOTFOUND: The pattern ID referenced could not be found. It may have been deleted, or not be published yet.
+                     * Means nothing for PUTs; it will be ignored.
+                     *
+                     * @enum {string}
+                     */
+                    _patternError?: "NOTFOUND" | "CYCLIC";
+                    /**
+                     * @description Defines patch overrides to component IDs that live in the composition.
+                     * This can be used to override parameters that are defined on patterns,
+                     * including nested patterns, with values that are specific to this composition.
+                     * The keys in this object are component IDs.
+                     * Overrides are applied from the top down, so for example if both the composition
+                     * and a pattern on the composition define an override on a nested pattern,
+                     * the composition's override replaces the pattern's.
+                     *
+                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
+                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                     */
+                    _overrides?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
+                    };
+                    /**
+                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * by consumers of the pattern.
+                     *
+                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
+                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                     */
+                    _overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
+                };
+                /** @description Defines the shape of the root component in a composition */
+                RootComponentInstance: {
+                    /** @description Type of the component instance (public_id of its definition) */
+                    type: string;
+                    /** @description Component parameter values for the component instance */
+                    parameters?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
+                    };
+                    /** @description Public ID of alternate visual appearance for this component, if any selected */
+                    variant?: string;
+                    /** @description Project map nodes associated with this component.  Must pass withProjectMapNodes parameter to be populated. */
+                    projectMapNodes?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["CompositionProjectMapNodeInfo"][];
+                    /** @description Slots containing any child components */
+                    slots?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentInstance"][];
+                    };
+                    /** @description The public UUID of the composition. */
+                    _id: string;
+                    /** @description Slug pattern of this component. */
+                    _slug?: string | null;
+                    /** @description Friendly name of this component. */
+                    _name: string;
+                    _dataResources?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
+                    /**
+                     * @description Defines patch overrides to component IDs that live in the composition.
+                     * This can be used to override parameters that are defined on patterns,
+                     * including nested patterns, with values that are specific to this composition.
+                     * The keys in this object are component IDs.
+                     * Overrides are applied from the top down, so for example if both the composition
+                     * and a pattern on the composition define an override on a nested pattern,
+                     * the composition's override replaces the pattern's.
+                     *
+                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
+                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                     */
+                    _overrides?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverride"];
+                    };
+                    /**
+                     * @description When used on a pattern, defines how the pattern's parameters may be overridden
+                     * by consumers of the pattern.
+                     *
+                     * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
+                     * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                     */
+                    _overridability?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentOverridability"];
+                };
+                /**
+                 * @description Defines how to override a specific component.
+                 *
+                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
+                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 */
+                ComponentOverride: {
+                    parameters?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
+                    };
+                    variant?: string;
+                };
+                /**
+                 * @description Defines how a component on a pattern may have its values overridden.
+                 * NOTE: Data resources' overridability is defined in the data resource definition, not here.
+                 *
+                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
+                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 */
+                ComponentOverridability: {
+                    /** @description Defines component parameter value overrides. Keys are the parameter public ID. */
+                    parameters?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["OverrideOptions"];
+                    };
+                    /** @description Allows overriding a display variant is allowed, if it is defined on the component the pattern is derived from. Default = false. */
+                    variants?: boolean;
+                };
+                /**
+                 * @description Whether a parameter is overridable
+                 *
+                 * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
+                 * Future updates that do not break the overrides-applied state of a composition may be made without notice.
+                 *
+                 * @enum {string}
+                 */
+                OverrideOptions: "yes" | "no";
+                /**
+                 * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
+                 * These are created in the UI and shared across a whole project.
+                 * NOTE: if you acquire a list of data sources or do not have manage permissions, you will receive "SECRET"
+                 * for all header, parameter, and variable values to obscure the actual encrypted secret value.
+                 */
+                DataSource: {
+                    /** @description Public ID of the data source */
+                    id: string;
+                    /** @description Display name of the data source */
+                    displayName: string;
+                    /** @description The type of data connector this connects to (e.g. 'cms-items', provided by an intalled integration) */
+                    connectorType: string;
+                    /** @description Base resource URL of the data source. No trailing slash. */
+                    baseUrl: string;
+                    /** @description HTTP headers to pass with requests to the data source */
+                    headers?: {
+                        key: string;
+                        value: string;
+                    }[];
+                    /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
+                    parameters?: {
+                        key: string;
+                        value: string;
+                    }[];
+                    /** @description Variables needed to make calls to the data source */
+                    variables?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
+                    };
+                    /** @description Custom configuration specific to the data source being defined (used to maintain UI state for custom integrations) */
+                    custom?: {
+                        [key: string]: unknown;
+                    };
+                };
+                /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project. */
+                DataType: {
+                    /** @description Public ID of the data type */
+                    id: string;
+                    /** @description Display name of the data type */
+                    displayName: string;
+                    /** @description Public ID of the associated data source */
+                    dataSourceId: string;
+                    /**
+                     * @description A connector-specific archetype for this data type; used to select UI as well as perform any
+                     * necessary post-processing on the response. e.g. 'cms-entry', 'cms-query'. Can be undefined if
+                     * no special UI or processing is required.
+                     */
+                    archetype?: string;
+                    allowedOnComponents?: string[];
+                    /** @description Resource path, appended to the data source's baseUrl (e.g. baseUrl = https://base.url, path = /v1/endpoint -> final URL https://base.url/v1/endpoint). Must have leading slash. */
+                    path: string;
+                    /** @description Time-to-live (in seconds) for the primary resource data cache. */
+                    ttl?: number;
+                    /** @description Long term data resource cache configuration. */
+                    longTermCache?: {
+                        /** @description A flag to turn the long term cache on. */
+                        enabled: boolean;
+                        /** @description Time-to-live (in hours) for the long term resource data cache. */
+                        ttlInHours?: number;
+                    };
+                    /** @description A key for the resource data cache purging. */
+                    purgeKey?: string;
+                    /** @description URL to a custom badge icon for the Uniform dashboard for this data type. If not set falls back to the data connector or integration icons. */
+                    badgeIconUrl?: string;
+                    /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data source, overriding identical keys. */
+                    headers?: {
+                        key: string;
+                        value: string;
+                    }[];
+                    /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys. */
+                    parameters?: {
+                        key: string;
+                        value: string;
+                    }[];
+                    /** @description Body to pass with requests to the data type (ignored unless method is POST) */
+                    body?: string;
+                    /**
+                     * @description HTTP method to use with requests to the data type.
+                     * @default GET
+                     * @enum {string}
+                     */
+                    method: "GET" | "POST" | "HEAD";
+                    /** @description Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys. */
+                    variables?: {
+                        [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
+                    };
+                    /** @description Custom configuration specific to the data source being defined */
+                    custom?: {
+                        [key: string]: unknown;
+                    };
+                };
+                /** @description Defines the shape of a data variable on a Data Source or Data Type */
+                DataVariableDefinition: {
+                    /** @description Display name of the data variable */
+                    displayName?: string;
+                    /** @description Explanatory text that is provided to the data resource editor to explain what this variable does. */
+                    helpText?: string;
+                    /**
+                     * @description Type of the data variable. Optionally used as a point of reference for custom integrations to decide how to render an editor for a variable.
+                     * @default text
+                     */
+                    type?: string;
+                    /** @description Default value of the data variable */
+                    default: string;
+                    /** @description Sets the order of the variable when displayed in a list with other variables. If not set, the order defaults to alphabetical with any explicitly set orders first in the list. */
+                    order?: number;
+                    /**
+                     * @description An optional arbitrary human readable source identifier to describe where this variable is from.
+                     * Some user interfaces may group variables by source value, for example 'From URL' or 'My Integration'.
+                     */
+                    source?: string;
+                };
+                /**
+                 * @description Data definitions attached to this component. The property name is the key of the data in the data document.
+                 * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key).
+                 */
+                DataResourceDefinitions: {
+                    [key: string]: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinition"];
+                };
+                /** @description Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
+                DataResourceDefinition: {
+                    /** @description Public ID of the data type that provides this data */
+                    type: string;
+                    /** @description Whether this data is a pattern data resource that can be overridden when a pattern is referenced on another composition. If this is not a pattern composition, this has no meaning and should not be used. If unspecified, the default is false. */
+                    isPatternParameter?: boolean;
+                    /**
+                     * @description When true, the default data resource of a pattern data parameter (isPatternParameter=true) will be ignored when the pattern is referenced.
+                     * Unless specifically overridden, the pattern data parameter will be provided with a null default value - leaving any data connections to it unresolvable.
+                     * If isPatternParameter is false or undefined, this has no meaning.
+                     */
+                    ignorePatternParameterDefault?: boolean;
+                    variables?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
+                };
+                /** @description Variable values for a data resource. */
+                DataResourceVariables: {
+                    [key: string]: string;
+                };
+                /** @description Category for tagging canvas entities */
+                Category: {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the category
+                     */
+                    id: string;
+                    /** @description Display name of the category */
+                    name: string;
+                    /**
+                     * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
+                     * @default 0
+                     */
+                    order?: number;
+                };
+                /** @description Project map node information related to a component. */
+                CompositionProjectMapNodeInfo: {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the project map node
+                     */
+                    id: string;
+                    /** @description Path of the project map node */
+                    path: string;
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the project map that this node belongs to.
+                     */
+                    projectMapId: string;
+                };
+            };
+        };
+        operations: {};
+    };
+}
+
+type SharedComponents$2 = components$4['schemas'];
+type Api$2 = paths$9['/api/v1/canvas-definitions'];
+/** Shape of the GET response from /api/v1/canvas-definitions */
+type ComponentDefinitionGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
+/** Shape of the PUT request body for /api/v1/canvas-definitions */
+type ComponentDefinitionPutParameters = Api$2['put']['requestBody']['content']['application/json'];
+/** Shape of the DELETE request body for /api/v1/canvas-definitions */
+type ComponentDefinitionDeleteParameters = Api$2['delete']['requestBody']['content']['application/json'];
+/** Query parameter options for GET /api/v1/canvas-definitions */
+type ComponentDefinitionGetParameters = Api$2['get']['parameters']['query'];
+/** The definition of a component parameter */
+type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$4['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
+    typeConfig?: TConfig;
+};
+/** The definition of a component visual variant */
+type ComponentDefinitionVariant = SharedComponents$2['ComponentDefinitionVariant'];
+/** The definition of a composition's slug settings */
+type ComponentDefinitionSlugSettings = SharedComponents$2['ComponentDefinitionSlugSettings'];
+/** The definition of a named component slot that can contain other components */
+type ComponentDefinitionSlot = SharedComponents$2['ComponentDefinitionSlot'];
+/** Permission set for a component defintion */
+type ComponentDefinitionPermission = SharedComponents$2['ComponentDefinitionPermission'];
+/** Defines a component type that can live on a Composition */
+type ComponentDefinition = SharedComponents$2['ComponentDefinition'];
+
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
 interface paths$8 {
-    "/api/v1/canvas-definitions": {
+    "/api/v1/categories": {
         get: {
             parameters: {
                 query: {
-                    /** The project ID to get component definitions for. */
                     projectId: string;
-                    /** Limit list to one result by ID (response remains an array). */
-                    componentId?: string;
-                    /** Number of records to skip */
-                    offset?: number;
-                    /** Max number of records to return */
-                    limit?: number;
-                    /** Whether to fetch system meta-component definitions (personalize, test, etc) */
-                    includeSystem?: boolean;
                 };
             };
             responses: {
@@ -510,8 +1212,7 @@ interface paths$8 {
                 200: {
                     content: {
                         "application/json": {
-                            /** @description Component definitions that match the query */
-                            componentDefinitions: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"][];
+                            categories: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
                         };
                     };
                 };
@@ -522,7 +1223,6 @@ interface paths$8 {
                 500: external$9["swagger.yml"]["components"]["responses"]["InternalServerError"];
             };
         };
-        /** Upserts a component definition */
         put: {
             responses: {
                 /** OK */
@@ -536,17 +1236,13 @@ interface paths$8 {
             requestBody: {
                 content: {
                     "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description The project ID to upsert the component definition to
-                         */
+                        /** Format: uuid */
                         projectId: string;
-                        componentDefinition: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinition"];
+                        categories: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["Category"][];
                     };
                 };
             };
         };
-        /** Deletes a component definition */
         delete: {
             responses: {
                 /** OK */
@@ -560,24 +1256,14 @@ interface paths$8 {
             requestBody: {
                 content: {
                     "application/json": {
-                        /** @description The public ID of the component definition to delete */
-                        componentId: string;
-                        /**
-                         * Format: uuid
-                         * @description The ID of the project the composition to delete belongs to
-                         */
+                        /** Format: uuid */
+                        categoryId: string;
+                        /** Format: uuid */
                         projectId: string;
                     };
                 };
             };
         };
-        /** Handles preflight requests. This endpoint allows CORS. */
-        options: {
-            responses: {
-                /** OK */
-                204: never;
-            };
-        };
     };
 }
 interface external$9 {
@@ -724,7 +1410,7 @@ interface external$9 {
                     /** @description Friendly name of the component definition */
                     name: string;
                     /**
-                     * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+                     * @description Icon name for the component definition (e.g. 'screen')
                      * @default screen
                      */
                     icon?: string;
@@ -742,6 +1428,22 @@ interface external$9 {
                     canBeComposition?: boolean;
                     /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
                     parameters?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /**
                      * @description if this component uses team permissions or custom permissions
                      * @default true
@@ -1085,6 +1787,21 @@ interface external$9 {
                 DataResourceVariables: {
                     [key: string]: string;
                 };
+                /** @description Category for tagging canvas entities */
+                Category: {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the category
+                     */
+                    id: string;
+                    /** @description Display name of the category */
+                    name: string;
+                    /**
+                     * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
+                     * @default 0
+                     */
+                    order?: number;
+                };
                 /** @description Project map node information related to a component. */
                 CompositionProjectMapNodeInfo: {
                     /**
@@ -1107,29 +1824,17 @@ interface external$9 {
 }
 
 type SharedComponents$1 = components$4['schemas'];
-type Api$1 = paths$8['/api/v1/canvas-definitions'];
-/** Shape of the GET response from /api/v1/canvas-definitions */
-type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
-/** Shape of the PUT request body for /api/v1/canvas-definitions */
-type ComponentDefinitionPutParameters = Api$1['put']['requestBody']['content']['application/json'];
-/** Shape of the DELETE request body for /api/v1/canvas-definitions */
-type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
-/** Query parameter options for GET /api/v1/canvas-definitions */
-type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
-/** The definition of a component parameter */
-type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$4['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
-    typeConfig?: TConfig;
-};
-/** The definition of a component visual variant */
-type ComponentDefinitionVariant = SharedComponents$1['ComponentDefinitionVariant'];
-/** The definition of a composition's slug settings */
-type ComponentDefinitionSlugSettings = SharedComponents$1['ComponentDefinitionSlugSettings'];
-/** The definition of a named component slot that can contain other components */
-type ComponentDefinitionSlot = SharedComponents$1['ComponentDefinitionSlot'];
-/** Permission set for a component defintion */
-type ComponentDefinitionPermission = SharedComponents$1['ComponentDefinitionPermission'];
+type Api$1 = paths$8['/api/v1/categories'];
+/** Shape of the GET response from /api/v1/category */
+type CategoriesGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
+/** Shape of the PUT request body for /api/v1/category */
+type CategoriesPutParameters = Api$1['put']['requestBody']['content']['application/json'];
+/** Shape of the DELETE request body for /api/v1/category */
+type CategoriesDeleteParameters = Api$1['delete']['requestBody']['content']['application/json'];
+/** Query parameter options for GET /api/v1/category */
+type CategoriesGetParameters = Api$1['get']['parameters']['query'];
 /** Defines a component type that can live on a Composition */
-type ComponentDefinition = SharedComponents$1['ComponentDefinition'];
+type Category = SharedComponents$1['Category'];
 
 /**
  * This file was auto-generated by openapi-typescript.
@@ -1354,7 +2059,7 @@ interface external$8 {
                     /** @description Friendly name of the component definition */
                     name: string;
                     /**
-                     * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+                     * @description Icon name for the component definition (e.g. 'screen')
                      * @default screen
                      */
                     icon?: string;
@@ -1372,6 +2077,22 @@ interface external$8 {
                     canBeComposition?: boolean;
                     /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
                     parameters?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /**
                      * @description if this component uses team permissions or custom permissions
                      * @default true
@@ -1715,6 +2436,21 @@ interface external$8 {
                 DataResourceVariables: {
                     [key: string]: string;
                 };
+                /** @description Category for tagging canvas entities */
+                Category: {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the category
+                     */
+                    id: string;
+                    /** @description Display name of the category */
+                    name: string;
+                    /**
+                     * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
+                     * @default 0
+                     */
+                    order?: number;
+                };
                 /** @description Project map node information related to a component. */
                 CompositionProjectMapNodeInfo: {
                     /**
@@ -1915,7 +2651,7 @@ interface external$7 {
                     /** @description Friendly name of the component definition */
                     name: string;
                     /**
-                     * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+                     * @description Icon name for the component definition (e.g. 'screen')
                      * @default screen
                      */
                     icon?: string;
@@ -1933,6 +2669,22 @@ interface external$7 {
                     canBeComposition?: boolean;
                     /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
                     parameters?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /**
                      * @description if this component uses team permissions or custom permissions
                      * @default true
@@ -2276,6 +3028,21 @@ interface external$7 {
                 DataResourceVariables: {
                     [key: string]: string;
                 };
+                /** @description Category for tagging canvas entities */
+                Category: {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the category
+                     */
+                    id: string;
+                    /** @description Display name of the category */
+                    name: string;
+                    /**
+                     * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
+                     * @default 0
+                     */
+                    order?: number;
+                };
                 /** @description Project map node information related to a component. */
                 CompositionProjectMapNodeInfo: {
                     /**
@@ -2511,7 +3278,7 @@ interface external$6 {
                     /** @description Friendly name of the component definition */
                     name: string;
                     /**
-                     * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+                     * @description Icon name for the component definition (e.g. 'screen')
                      * @default screen
                      */
                     icon?: string;
@@ -2529,6 +3296,22 @@ interface external$6 {
                     canBeComposition?: boolean;
                     /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
                     parameters?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /**
                      * @description if this component uses team permissions or custom permissions
                      * @default true
@@ -2872,6 +3655,21 @@ interface external$6 {
                 DataResourceVariables: {
                     [key: string]: string;
                 };
+                /** @description Category for tagging canvas entities */
+                Category: {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the category
+                     */
+                    id: string;
+                    /** @description Display name of the category */
+                    name: string;
+                    /**
+                     * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
+                     * @default 0
+                     */
+                    order?: number;
+                };
                 /** @description Project map node information related to a component. */
                 CompositionProjectMapNodeInfo: {
                     /**
@@ -3021,6 +3819,8 @@ interface paths$4 {
                      * This is a primary query parameter, and cannot be used with any other primary query parameters.
                      */
                     slug?: components$3["parameters"]["slug"];
+                    /** Filtration by category ID */
+                    categories?: components$3["parameters"]["categories"];
                     /**
                      * Publishing state to fetch. 0 = draft, 64 = published.
                      * This is a list query parameter, and cannot be used with any primary query parameters.
@@ -3120,6 +3920,22 @@ interface paths$4 {
                         created?: string;
                         /** @description Ignored if present */
                         modified?: string;
+                        /**
+                         * Format: uuid
+                         * @description Reference to the category this component definition belongs to
+                         * @default null
+                         */
+                        categoryId?: string | null;
+                        /**
+                         * @description Description of the component definition
+                         * @default null
+                         */
+                        description?: string | null;
+                        /**
+                         * @description Description of the component definition
+                         * @default null
+                         */
+                        previewImageUrl?: string | null;
                     };
                 };
             };
@@ -3189,6 +4005,15 @@ interface components$3 {
              * @description Modified date string for this definition
              */
             modified: string;
+            /**
+             * Format: uuid
+             * @description Reference to the category this component definition belongs to
+             */
+            categoryId?: string;
+            /** @description Description of the component definition */
+            description?: string;
+            /** @description Description of the component definition */
+            previewImageUrl?: string;
             /** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
             pattern: boolean;
             composition: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
@@ -3258,6 +4083,8 @@ interface components$3 {
          * This is a list query parameter, and cannot be used with any primary query parameters.
          */
         limit: number;
+        /** @description Filtration by category ID */
+        categories: string[];
         /**
          * @deprecated
          * @description Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
@@ -3493,7 +4320,7 @@ interface external$5 {
                     /** @description Friendly name of the component definition */
                     name: string;
                     /**
-                     * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+                     * @description Icon name for the component definition (e.g. 'screen')
                      * @default screen
                      */
                     icon?: string;
@@ -3511,6 +4338,22 @@ interface external$5 {
                     canBeComposition?: boolean;
                     /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
                     parameters?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /**
                      * @description if this component uses team permissions or custom permissions
                      * @default true
@@ -3854,6 +4697,21 @@ interface external$5 {
                 DataResourceVariables: {
                     [key: string]: string;
                 };
+                /** @description Category for tagging canvas entities */
+                Category: {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the category
+                     */
+                    id: string;
+                    /** @description Display name of the category */
+                    name: string;
+                    /**
+                     * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
+                     * @default 0
+                     */
+                    order?: number;
+                };
                 /** @description Project map node information related to a component. */
                 CompositionProjectMapNodeInfo: {
                     /**
@@ -4305,7 +5163,7 @@ interface external$3 {
                     /** @description Friendly name of the component definition */
                     name: string;
                     /**
-                     * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+                     * @description Icon name for the component definition (e.g. 'screen')
                      * @default screen
                      */
                     icon?: string;
@@ -4323,6 +5181,22 @@ interface external$3 {
                     canBeComposition?: boolean;
                     /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
                     parameters?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /**
                      * @description if this component uses team permissions or custom permissions
                      * @default true
@@ -4666,6 +5540,21 @@ interface external$3 {
                 DataResourceVariables: {
                     [key: string]: string;
                 };
+                /** @description Category for tagging canvas entities */
+                Category: {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the category
+                     */
+                    id: string;
+                    /** @description Display name of the category */
+                    name: string;
+                    /**
+                     * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
+                     * @default 0
+                     */
+                    order?: number;
+                };
                 /** @description Project map node information related to a component. */
                 CompositionProjectMapNodeInfo: {
                     /**
@@ -4783,6 +5672,8 @@ interface external$3 {
                              * This is a primary query parameter, and cannot be used with any other primary query parameters.
                              */
                             slug?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
+                            /** Filtration by category ID */
+                            categories?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["categories"];
                             /**
                              * Publishing state to fetch. 0 = draft, 64 = published.
                              * This is a list query parameter, and cannot be used with any primary query parameters.
@@ -4882,6 +5773,22 @@ interface external$3 {
                                 created?: string;
                                 /** @description Ignored if present */
                                 modified?: string;
+                                /**
+                                 * Format: uuid
+                                 * @description Reference to the category this component definition belongs to
+                                 * @default null
+                                 */
+                                categoryId?: string | null;
+                                /**
+                                 * @description Description of the component definition
+                                 * @default null
+                                 */
+                                description?: string | null;
+                                /**
+                                 * @description Description of the component definition
+                                 * @default null
+                                 */
+                                previewImageUrl?: string | null;
                             };
                         };
                     };
@@ -4951,6 +5858,15 @@ interface external$3 {
                      * @description Modified date string for this definition
                      */
                     modified: string;
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     */
+                    categoryId?: string;
+                    /** @description Description of the component definition */
+                    description?: string;
+                    /** @description Description of the component definition */
+                    previewImageUrl?: string;
                     /** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
                     pattern: boolean;
                     composition: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
@@ -5020,6 +5936,8 @@ interface external$3 {
                  * This is a list query parameter, and cannot be used with any primary query parameters.
                  */
                 limit: number;
+                /** @description Filtration by category ID */
+                categories: string[];
                 /**
                  * @deprecated
                  * @description Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
@@ -5744,7 +6662,7 @@ interface external$2 {
                     /** @description Friendly name of the component definition */
                     name: string;
                     /**
-                     * @description Icon name or URL for the component definition (e.g. 'screen' or 'https://s3/my-component.jpg')
+                     * @description Icon name for the component definition (e.g. 'screen')
                      * @default screen
                      */
                     icon?: string;
@@ -5762,6 +6680,22 @@ interface external$2 {
                     canBeComposition?: boolean;
                     /** @description The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries. */
                     parameters?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     * @default null
+                     */
+                    categoryId?: string | null;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    description?: string;
+                    /**
+                     * @description Description of the component definition
+                     * @default null
+                     */
+                    previewImageUrl?: string;
                     /**
                      * @description if this component uses team permissions or custom permissions
                      * @default true
@@ -6105,6 +7039,21 @@ interface external$2 {
                 DataResourceVariables: {
                     [key: string]: string;
                 };
+                /** @description Category for tagging canvas entities */
+                Category: {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the category
+                     */
+                    id: string;
+                    /** @description Display name of the category */
+                    name: string;
+                    /**
+                     * @description Sets the order of the category when displayed in a list with other categories. If not set, the order defaults to alphabetical with any explicitly set orders first in the list.
+                     * @default 0
+                     */
+                    order?: number;
+                };
                 /** @description Project map node information related to a component. */
                 CompositionProjectMapNodeInfo: {
                     /**
@@ -6222,6 +7171,8 @@ interface external$2 {
                              * This is a primary query parameter, and cannot be used with any other primary query parameters.
                              */
                             slug?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["slug"];
+                            /** Filtration by category ID */
+                            categories?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["categories"];
                             /**
                              * Publishing state to fetch. 0 = draft, 64 = published.
                              * This is a list query parameter, and cannot be used with any primary query parameters.
@@ -6321,6 +7272,22 @@ interface external$2 {
                                 created?: string;
                                 /** @description Ignored if present */
                                 modified?: string;
+                                /**
+                                 * Format: uuid
+                                 * @description Reference to the category this component definition belongs to
+                                 * @default null
+                                 */
+                                categoryId?: string | null;
+                                /**
+                                 * @description Description of the component definition
+                                 * @default null
+                                 */
+                                description?: string | null;
+                                /**
+                                 * @description Description of the component definition
+                                 * @default null
+                                 */
+                                previewImageUrl?: string | null;
                             };
                         };
                     };
@@ -6390,6 +7357,15 @@ interface external$2 {
                      * @description Modified date string for this definition
                      */
                     modified: string;
+                    /**
+                     * Format: uuid
+                     * @description Reference to the category this component definition belongs to
+                     */
+                    categoryId?: string;
+                    /** @description Description of the component definition */
+                    description?: string;
+                    /** @description Description of the component definition */
+                    previewImageUrl?: string;
                     /** @description Whether this composition is a pattern (can be referenced by other compositions, not treated as a composition) */
                     pattern: boolean;
                     composition: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["RootComponentInstance"];
@@ -6459,6 +7435,8 @@ interface external$2 {
                  * This is a list query parameter, and cannot be used with any primary query parameters.
                  */
                 limit: number;
+                /** @description Filtration by category ID */
+                categories: string[];
                 /**
                  * @deprecated
                  * @description Signals an enhancer proxy to skip processing enhancements to the data and return raw data only.
@@ -6829,6 +7807,7 @@ type CanvasDefinitions = {
     components?: Array<ComponentDefinition>;
     compositions?: Array<CompositionGetResponse>;
     dataTypes?: Array<DataType>;
+    categories?: Array<Category>;
 };
 /** Defines shared parameters for requests getting a single composition */
 type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId'>;
@@ -6924,6 +7903,9 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
             projectId: string;
             created: string;
             modified: string;
+            categoryId?: string | undefined;
+            description?: string | undefined;
+            previewImageUrl?: string | undefined;
             pattern: boolean;
             composition: {
                 type: string;
@@ -7092,6 +8074,9 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
                 type: string;
                 typeConfig?: unknown;
             }[] | undefined;
+            categoryId?: string | null | undefined;
+            description?: string | undefined;
+            previewImageUrl?: string | undefined;
             useTeamPermissions?: boolean | undefined;
             permissions?: {
                 roleId: string;
@@ -7192,6 +8177,25 @@ declare class UncachedCanvasClient extends CanvasClient {
     constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
 }
 
+declare class CategoryClient extends ApiClient {
+    constructor(options: ClientOptions);
+    /** Fetches all categories created in given project */
+    getCategories(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
+        categories: {
+            id: string;
+            name: string;
+            order?: number | undefined;
+        }[];
+    }>;
+    /** Updates or creates a category, also used to re-order them */
+    upsertCategories(categories: CategoriesPutParameters['categories']): Promise<unknown>;
+    /** Deletes a category */
+    removeCategory(options: Omit<CategoriesDeleteParameters, 'projectId'>): Promise<unknown>;
+}
+declare class UncachedCategoryClient extends CategoryClient {
+    constructor(options: Omit<ClientOptions, 'bypassCache'>);
+}
+
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
@@ -8288,8 +9292,7 @@ type GetParameterAttributesProps = {
 /**
  * Returns the attributes needed to annotate a Uniform parameter for inline editing.
  * Supports only text parameters at the moment.
- * @deprecated Unstable, and not ready for production usage.
- **/
+ */
 declare const getParameterAttributes: ({ id, component, placeholder, isMultiline, }: GetParameterAttributesProps) => Record<string, string | boolean | undefined>;
 
 declare const generateHash: ({ composition, secret, }: {
@@ -8314,4 +9317,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
 
 declare const CanvasClientError: typeof ApiClientError;
 
-export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
+export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };