@uniformdev/canvas 17.1.1-alpha.152 → 17.2.0

package/dist/{createEventBus-b9cdb6ff.d.ts → createEventBus-3f3f7633.d.ts}

@@ -214,11 +214,11 @@ interface external$1 {
                     roleId: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
                     /**
                      * @description Permission type for this permission ComponentDefinition:
-                     * read | write | delete
+                     * read | write | create | delete
                      *
                      * @enum {string}
                      */
-                    permission: "read" | "write" | "delete";
+                    permission: "read" | "write" | "create" | "delete";
                     /** @description State of the component that this permission applies to */
                     state: number;
                 };
@@ -370,23 +370,23 @@ interface external$1 {
                  * @description An instance of an integration data connector (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.
                  */
                 DataConnection: {
-                    /** @description Public ID of the data connector */
+                    /** @description Public ID of the data connection */
                     id: string;
-                    /** @description Display name of the data connector */
+                    /** @description Display name of the data connection */
                     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 connector. No trailing slash. */
+                    /** @description Base resource URL of the data connection. No trailing slash. */
                     baseUrl: string;
-                    /** @description HTTP headers to pass with requests to the data connector */
+                    /** @description HTTP headers to pass with requests to the data connection */
                     headers?: {
                         [key: string]: string;
                     };
-                    /** @description Query String parameters to pass with requests to the data connector */
+                    /** @description Query String parameters to pass with requests to the data connection */
                     parameters?: {
                         [key: string]: string;
                     };
-                    /** @description Variables needed to make calls to the data connector */
+                    /** @description Variables needed to make calls to the data connection */
                     variables?: {
                         [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
                     };
@@ -400,11 +400,11 @@ interface external$1 {
                  * @description A specific type of data that a Data Connection 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 connector */
+                    /** @description Public ID of the data type */
                     id: string;
-                    /** @description Display name of the data connector */
+                    /** @description Display name of the data type */
                     displayName: string;
-                    /** @description Public ID of the associated data connector */
+                    /** @description Public ID of the associated data connection */
                     connectionId: string;
                     /**
                      * @description A connector-specific archetype for this data type; used to select UI as well as perform any
@@ -412,25 +412,26 @@ interface external$1 {
                      * no special UI or processing is required.
                      */
                     archetype?: string;
+                    allowedOnComponents?: string[];
                     /** @description Resource path, appended to the data connection'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 HTTP headers to pass with requests to the data connector */
+                    /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
                     headers?: {
                         [key: string]: string;
                     };
-                    /** @description Query String parameters to pass with requests to the data connector */
+                    /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
                     parameters?: {
                         [key: string]: string;
                     };
-                    /** @description Body to pass with requests to the data connector */
+                    /** @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 connector.
+                     * @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 connector */
+                    /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
                     variables?: {
                         [key: string]: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
                     };
@@ -564,11 +565,11 @@ interface components$1 {
             roleId: components$1["schemas"]["PublicIdProperty"];
             /**
              * @description Permission type for this permission ComponentDefinition:
-             * read | write | delete
+             * read | write | create | delete
              *
              * @enum {string}
              */
-            permission: "read" | "write" | "delete";
+            permission: "read" | "write" | "create" | "delete";
             /** @description State of the component that this permission applies to */
             state: number;
         };
@@ -720,23 +721,23 @@ interface components$1 {
          * @description An instance of an integration data connector (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.
          */
         DataConnection: {
-            /** @description Public ID of the data connector */
+            /** @description Public ID of the data connection */
             id: string;
-            /** @description Display name of the data connector */
+            /** @description Display name of the data connection */
             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 connector. No trailing slash. */
+            /** @description Base resource URL of the data connection. No trailing slash. */
             baseUrl: string;
-            /** @description HTTP headers to pass with requests to the data connector */
+            /** @description HTTP headers to pass with requests to the data connection */
             headers?: {
                 [key: string]: string;
             };
-            /** @description Query String parameters to pass with requests to the data connector */
+            /** @description Query String parameters to pass with requests to the data connection */
             parameters?: {
                 [key: string]: string;
             };
-            /** @description Variables needed to make calls to the data connector */
+            /** @description Variables needed to make calls to the data connection */
             variables?: {
                 [key: string]: components$1["schemas"]["DataVariable"];
             };
@@ -750,11 +751,11 @@ interface components$1 {
          * @description A specific type of data that a Data Connection 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 connector */
+            /** @description Public ID of the data type */
             id: string;
-            /** @description Display name of the data connector */
+            /** @description Display name of the data type */
             displayName: string;
-            /** @description Public ID of the associated data connector */
+            /** @description Public ID of the associated data connection */
             connectionId: string;
             /**
              * @description A connector-specific archetype for this data type; used to select UI as well as perform any
@@ -762,25 +763,26 @@ interface components$1 {
              * no special UI or processing is required.
              */
             archetype?: string;
+            allowedOnComponents?: string[];
             /** @description Resource path, appended to the data connection'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 HTTP headers to pass with requests to the data connector */
+            /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
             headers?: {
                 [key: string]: string;
             };
-            /** @description Query String parameters to pass with requests to the data connector */
+            /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
             parameters?: {
                 [key: string]: string;
             };
-            /** @description Body to pass with requests to the data connector */
+            /** @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 connector.
+             * @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 connector */
+            /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
             variables?: {
                 [key: string]: components$1["schemas"]["DataVariable"];
             };
@@ -1192,11 +1194,11 @@ interface external {
                     roleId: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["PublicIdProperty"];
                     /**
                      * @description Permission type for this permission ComponentDefinition:
-                     * read | write | delete
+                     * read | write | create | delete
                      *
                      * @enum {string}
                      */
-                    permission: "read" | "write" | "delete";
+                    permission: "read" | "write" | "create" | "delete";
                     /** @description State of the component that this permission applies to */
                     state: number;
                 };
@@ -1348,23 +1350,23 @@ interface external {
                  * @description An instance of an integration data connector (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.
                  */
                 DataConnection: {
-                    /** @description Public ID of the data connector */
+                    /** @description Public ID of the data connection */
                     id: string;
-                    /** @description Display name of the data connector */
+                    /** @description Display name of the data connection */
                     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 connector. No trailing slash. */
+                    /** @description Base resource URL of the data connection. No trailing slash. */
                     baseUrl: string;
-                    /** @description HTTP headers to pass with requests to the data connector */
+                    /** @description HTTP headers to pass with requests to the data connection */
                     headers?: {
                         [key: string]: string;
                     };
-                    /** @description Query String parameters to pass with requests to the data connector */
+                    /** @description Query String parameters to pass with requests to the data connection */
                     parameters?: {
                         [key: string]: string;
                     };
-                    /** @description Variables needed to make calls to the data connector */
+                    /** @description Variables needed to make calls to the data connection */
                     variables?: {
                         [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
                     };
@@ -1378,11 +1380,11 @@ interface external {
                  * @description A specific type of data that a Data Connection 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 connector */
+                    /** @description Public ID of the data type */
                     id: string;
-                    /** @description Display name of the data connector */
+                    /** @description Display name of the data type */
                     displayName: string;
-                    /** @description Public ID of the associated data connector */
+                    /** @description Public ID of the associated data connection */
                     connectionId: string;
                     /**
                      * @description A connector-specific archetype for this data type; used to select UI as well as perform any
@@ -1390,25 +1392,26 @@ interface external {
                      * no special UI or processing is required.
                      */
                     archetype?: string;
+                    allowedOnComponents?: string[];
                     /** @description Resource path, appended to the data connection'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 HTTP headers to pass with requests to the data connector */
+                    /** @description HTTP headers to pass with requests to the data type. Merged with headers from the data connection, overriding identical keys. */
                     headers?: {
                         [key: string]: string;
                     };
-                    /** @description Query String parameters to pass with requests to the data connector */
+                    /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data connection, overriding identical keys. */
                     parameters?: {
                         [key: string]: string;
                     };
-                    /** @description Body to pass with requests to the data connector */
+                    /** @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 connector.
+                     * @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 connector */
+                    /** @description Variables needed to make calls to the data type. Merged with variables from the data connection, overriding identical keys. */
                     variables?: {
                         [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariable"];
                     };
@@ -1546,4 +1549,4 @@ declare global {
  */
 declare function createEventBus(): Promise<PreviewEventBus | undefined>;
 
-export { CompositionListAPIResponse as A, CompositionAPIOptions as B, ComponentInstance as C, ComponentParameterBinding as D, CompositionDataVariables as E, CompositionDataDefinitions as F, CompositionDataDefinition as G, CanvasDefinitions as H, ChannelSubscription as I, createEventBus as J, PreviewEventBus as P, RootComponentInstance as R, ComponentParameter as a, CompositionGetParameters as b, components$1 as c, CompositionPutParameters as d, CompositionDeleteParameters as e, ComponentDefinitionGetParameters as f, ComponentDefinitionPutParameters as g, ComponentDefinitionDeleteParameters as h, ComponentDefinitionGetResponse as i, ComponentDefinitionAPIResponse as j, ComponentDefinitionAPIPutRequest as k, ComponentDefinitionAPIDeleteRequest as l, ComponentDefinitionListAPIOptions as m, ComponentDefinitionParameter as n, ComponentDefinitionVariant as o, ComponentDefinitionSlugSettings as p, ComponentDefinitionSlot as q, ComponentDefinitionPermission as r, ComponentDefinition as s, CreatingComponentDefinition as t, CompositionGetOrderBy as u, CompositionGetResponse as v, CompositionUIStatus as w, CompositionGetListResponse as x, CompositionAPIResponse as y, CompositionAPIDeleteRequest as z };
+export { CompositionListAPIResponse as A, CompositionAPIOptions as B, ComponentInstance as C, ComponentParameterBinding as D, CompositionDataVariables as E, CompositionDataDefinitions as F, CompositionDataDefinition as G, CanvasDefinitions as H, ChannelSubscription as I, createEventBus as J, PreviewEventBus as P, RootComponentInstance as R, ComponentParameter as a, CompositionGetParameters as b, components$1 as c, CompositionPutParameters as d, CompositionDeleteParameters as e, ComponentDefinitionGetParameters as f, ComponentDefinitionPutParameters as g, ComponentDefinitionDeleteParameters as h, CompositionGetResponse as i, ComponentDefinitionGetResponse as j, ComponentDefinitionAPIResponse as k, ComponentDefinitionAPIPutRequest as l, ComponentDefinitionAPIDeleteRequest as m, ComponentDefinitionListAPIOptions as n, ComponentDefinitionParameter as o, ComponentDefinitionVariant as p, ComponentDefinitionSlugSettings as q, ComponentDefinitionSlot as r, ComponentDefinitionPermission as s, ComponentDefinition as t, CreatingComponentDefinition as u, CompositionGetOrderBy as v, CompositionUIStatus as w, CompositionGetListResponse as x, CompositionAPIResponse as y, CompositionAPIDeleteRequest as z };