@uniformdev/canvas 17.4.1-alpha.1 → 17.4.1-alpha.230

package/dist/{createEventBus-a8e85b6e.d.ts → createEventBus-ab14af4c.d.ts}

@@ -423,12 +423,16 @@ interface external$4 {
                     ttl?: 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]: string;
                     } | {
                         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]: string;
                     } | {
@@ -454,23 +458,22 @@ interface external$4 {
                 };
                 /**
                  * @deprecated
-                 * @description Defines the shape of a data variable on a Data Connector or Data Type
+                 * @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
+                     * @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;
+                    type?: string;
                     /** @description Default value of the data variable */
                     default: string;
-                    /**
-                     * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
-                     * @enum {string}
-                     */
-                    setBy: "static" | "dynamic";
+                    /** @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;
                 };
                 /**
                  * @deprecated
@@ -786,12 +789,16 @@ interface components$1 {
             ttl?: 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]: string;
             } | {
                 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]: string;
             } | {
@@ -817,23 +824,22 @@ interface components$1 {
         };
         /**
          * @deprecated
-         * @description Defines the shape of a data variable on a Data Connector or Data Type
+         * @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
+             * @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;
+            type?: string;
             /** @description Default value of the data variable */
             default: string;
-            /**
-             * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
-             * @enum {string}
-             */
-            setBy: "static" | "dynamic";
+            /** @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;
         };
         /**
          * @deprecated
@@ -1440,12 +1446,16 @@ interface external$3 {
                     ttl?: 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]: string;
                     } | {
                         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]: string;
                     } | {
@@ -1471,23 +1481,22 @@ interface external$3 {
                 };
                 /**
                  * @deprecated
-                 * @description Defines the shape of a data variable on a Data Connector or Data Type
+                 * @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
+                     * @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;
+                    type?: string;
                     /** @description Default value of the data variable */
                     default: string;
-                    /**
-                     * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
-                     * @enum {string}
-                     */
-                    setBy: "static" | "dynamic";
+                    /** @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;
                 };
                 /**
                  * @deprecated
@@ -1576,6 +1585,101 @@ declare type CanvasDefinitions = {
     compositions?: Array<CompositionGetResponse>;
     dataTypes?: Array<DataType>;
 };
+/** Defines shared parameters for requests getting a single composition */
+declare type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>;
+/** Defines exact parameters for specific requests getting a single composition */
+declare type CompositionGetByNodePathParameters = CompositionGetOneSharedParameters & Pick<CompositionGetParameters, 'projectMapNodePath' | 'projectMapId'>;
+declare type CompositionGetByNodeIdParameters = CompositionGetOneSharedParameters & Pick<CompositionGetParameters, 'projectMapNodeId' | 'projectMapId'>;
+declare type CompositionGetBySlugParameters = CompositionGetOneSharedParameters & Pick<CompositionGetParameters, 'slug'>;
+declare type CompositionGetByIdParameters = CompositionGetOneSharedParameters & Pick<CompositionGetParameters, 'compositionId'>;
+/** Switches for data resolution */
+declare type DataResolutionOption = {
+    unstable_resolveData?: boolean;
+};
+declare type DataResolutionOptionNegative = {
+    unstable_resolveData?: false;
+};
+declare type DataResolutionOptionPositive = {
+    unstable_resolveData: true;
+};
+declare type DataResolutionParameters = {
+    /**
+     * Adds additional diagnostics (`dataDiagnostics`) to the response containing timings and resolved datas for the composition.
+     * Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
+     */
+    unstable_dataDiagnostics?: boolean;
+    /**
+     * Pass dynamic variables to the composition that are required for resolving bindings and datas,
+     * such as language, detail page ID, etc.
+     */
+    unstable_dynamicVariables?: Record<string, string>;
+};
+/** Types of issue that can occur when fetching composition data */
+declare type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DataResourceVariableIssue | DataResolutionConfigIssue;
+declare type CompositionIssueCore = {
+    componentPath: string;
+    componentType: string;
+    message: string;
+};
+/** An error that occured resolving a pattern that is referenced on the composition */
+declare type CompositionPatternIssue = CompositionIssueCore & {
+    type: 'pattern';
+    code: NonNullable<ComponentInstance['_patternError']>;
+};
+/** An error while binding a data element from a data resource to a component parameter (i.e. a missing property in the data resource) */
+declare type DataElementBindingIssue = CompositionIssueCore & {
+    type: 'binding';
+    parameterName: string;
+};
+/** An error that occurred fetching a data defined on the composition or a pattern within */
+declare type DataResourceIssue = CompositionIssueCore & {
+    type: 'data';
+    dataName: string;
+    dataType: string;
+};
+/** An issue that occurred while binding dynamic variables to composition data resources */
+declare type DataResourceVariableIssue = CompositionIssueCore & {
+    type: 'variable';
+    variableName: string;
+};
+declare type DataResolutionConfigIssue = {
+    message: string;
+    type: 'config';
+};
+/** Diagnostic data about the load performance of attached composition datas */
+declare type CompositionDataDiagnostic = {
+    componentPath: string;
+    dataType: string;
+    dataName: string;
+    performance: {
+        cacheHit: boolean;
+        total: number;
+        retryCount: number;
+        retryDelay: number;
+    };
+    data: unknown;
+};
+/** Response as it comes from the data resolution endpoint */
+declare type CompositionResolvedGetResponse = CompositionGetResponse & {
+    /**
+     * Copies of resolved data and how long it took to resolve each data.
+     * Only set when dataDiagnostics=true is passed to the options.
+     */
+    dataDiagnostics?: Array<CompositionDataDiagnostic>;
+    /**
+     * Any failures to bind to data that occured on bindings marked 'must exist'.
+     * If no failures occurred, this will be undefined.
+     * NOTE: No exception will be thrown if this type of error occurs. You must inspect this property if you care to cause client errors.
+     */
+    errors?: Array<CompositionIssue>;
+    /**
+     * Any failures to bind to data that occurred on optional bindings. In most cases, these are only informational (i.e. data is bound to a property that does not always exist)
+     * If no failures occurred, this will be undefined.
+     */
+    warnings?: Array<CompositionIssue>;
+};
+/** All valid response types */
+declare type CompositionGetValidResponses = CompositionGetResponse | CompositionResolvedGetResponse;
 
 /**
  * This file was auto-generated by openapi-typescript.
@@ -1974,12 +2078,16 @@ interface external$2 {
                     ttl?: 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]: string;
                     } | {
                         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]: string;
                     } | {
@@ -2005,23 +2113,22 @@ interface external$2 {
                 };
                 /**
                  * @deprecated
-                 * @description Defines the shape of a data variable on a Data Connector or Data Type
+                 * @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
+                     * @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;
+                    type?: string;
                     /** @description Default value of the data variable */
                     default: string;
-                    /**
-                     * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
-                     * @enum {string}
-                     */
-                    setBy: "static" | "dynamic";
+                    /** @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;
                 };
                 /**
                  * @deprecated
@@ -2455,12 +2562,16 @@ interface external$1 {
                     ttl?: 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]: string;
                     } | {
                         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]: string;
                     } | {
@@ -2486,23 +2597,22 @@ interface external$1 {
                 };
                 /**
                  * @deprecated
-                 * @description Defines the shape of a data variable on a Data Connector or Data Type
+                 * @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
+                     * @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;
+                    type?: string;
                     /** @description Default value of the data variable */
                     default: string;
-                    /**
-                     * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
-                     * @enum {string}
-                     */
-                    setBy: "static" | "dynamic";
+                    /** @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;
                 };
                 /**
                  * @deprecated
@@ -2893,12 +3003,16 @@ interface external {
                     ttl?: 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]: string;
                     } | {
                         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]: string;
                     } | {
@@ -2924,23 +3038,22 @@ interface external {
                 };
                 /**
                  * @deprecated
-                 * @description Defines the shape of a data variable on a Data Connector or Data Type
+                 * @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
+                     * @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;
+                    type?: string;
                     /** @description Default value of the data variable */
                     default: string;
-                    /**
-                     * @description Where the variable value is set. Static = set to static value by the author. Dynamic = set to a dynamic value by a runtime API request from the frontend (default is used in the editor).
-                     * @enum {string}
-                     */
-                    setBy: "static" | "dynamic";
+                    /** @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;
                 };
                 /**
                  * @deprecated
@@ -3027,4 +3140,4 @@ declare global {
  */
 declare function createEventBus(): Promise<PreviewEventBus | undefined>;
 
-export { CreatingComponentDefinition as A, CompositionGetOrderBy as B, ComponentInstance as C, DataSourceGetParameters as D, CompositionUIStatus as E, CompositionGetListResponse as F, CompositionAPIResponse as G, CompositionAPIDeleteRequest as H, CompositionListAPIResponse as I, CompositionAPIOptions as J, DataElementConnectionDefinition as K, DataResourceVariables as L, DataResourceDefinitions as M, DataResourceDefinition as N, CanvasDefinitions as O, PreviewEventBus as P, DataSourceGetResponse as Q, RootComponentInstance as R, DataSourcesGetResponse as S, DataType as T, DataSource as U, DataSourceInfo as V, DataVariableDefinition as W, ChannelSubscription as X, createEventBus as Y, ComponentParameter as a, CompositionGetParameters as b, CompositionPutParameters as c, CompositionDeleteParameters as d, ComponentDefinitionGetParameters as e, ComponentDefinitionPutParameters as f, ComponentDefinitionDeleteParameters as g, DataSourcesGetParameters as h, DataSourcePutParameters as i, DataSourceDeleteParameters as j, DataTypeGetParameters as k, DataTypeGetResponse as l, DataTypePutParameters as m, DataTypeDeleteParameters as n, CompositionGetResponse as o, ComponentDefinitionGetResponse as p, ComponentDefinitionAPIResponse as q, ComponentDefinitionAPIPutRequest as r, ComponentDefinitionAPIDeleteRequest as s, ComponentDefinitionListAPIOptions as t, ComponentDefinitionParameter as u, ComponentDefinitionVariant as v, ComponentDefinitionSlugSettings as w, ComponentDefinitionSlot as x, ComponentDefinitionPermission as y, ComponentDefinition as z };
+export { CompositionIssue as $, ComponentDefinitionAPIResponse as A, ComponentDefinitionAPIPutRequest as B, ComponentInstance as C, DataResolutionOptionNegative as D, ComponentDefinitionAPIDeleteRequest as E, ComponentDefinitionListAPIOptions as F, ComponentDefinitionParameter as G, ComponentDefinitionVariant as H, ComponentDefinitionSlugSettings as I, ComponentDefinitionSlot as J, ComponentDefinitionPermission as K, ComponentDefinition as L, CreatingComponentDefinition as M, CompositionGetOrderBy as N, CompositionUIStatus as O, PreviewEventBus as P, CompositionGetListResponse as Q, RootComponentInstance as R, CompositionAPIResponse as S, CompositionAPIDeleteRequest as T, CompositionListAPIResponse as U, CompositionAPIOptions as V, DataElementConnectionDefinition as W, DataResourceVariables as X, DataResourceDefinitions as Y, DataResourceDefinition as Z, CanvasDefinitions as _, ComponentParameter as a, CompositionPatternIssue as a0, DataElementBindingIssue as a1, DataResourceIssue as a2, DataResourceVariableIssue as a3, DataResolutionConfigIssue as a4, CompositionDataDiagnostic as a5, DataSourceGetResponse as a6, DataSourcesGetResponse as a7, DataType as a8, DataSource as a9, DataSourceInfo as aa, DataVariableDefinition as ab, ChannelSubscription as ac, createEventBus as ad, CompositionGetParameters as b, CompositionGetByNodePathParameters as c, CompositionGetResponse as d, DataResolutionOptionPositive as e, DataResolutionParameters as f, CompositionResolvedGetResponse as g, CompositionGetValidResponses as h, DataResolutionOption as i, CompositionGetByNodeIdParameters as j, CompositionGetBySlugParameters as k, CompositionGetByIdParameters as l, CompositionPutParameters as m, CompositionDeleteParameters as n, ComponentDefinitionGetParameters as o, ComponentDefinitionPutParameters as p, ComponentDefinitionDeleteParameters as q, DataSourceGetParameters as r, DataSourcesGetParameters as s, DataSourcePutParameters as t, DataSourceDeleteParameters as u, DataTypeGetParameters as v, DataTypeGetResponse as w, DataTypePutParameters as x, DataTypeDeleteParameters as y, ComponentDefinitionGetResponse as z };