@uniformdev/canvas 18.12.0 → 18.12.1-alpha.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -490,9 +490,15 @@ var CanvasClient = class extends ApiClient {
490
490
  const fetchUri = this.createUrl(CANVAS_URL, { ...options, projectId });
491
491
  return await this.apiClient(fetchUri);
492
492
  }
493
+ getCompositionByNodePath(options) {
494
+ return this.getOneComposition(options);
495
+ }
493
496
  unstable_getCompositionByNodePath(options) {
494
497
  return this.getOneComposition(options);
495
498
  }
499
+ getCompositionByNodeId(options) {
500
+ return this.getOneComposition(options);
501
+ }
496
502
  unstable_getCompositionByNodeId(options) {
497
503
  return this.getOneComposition(options);
498
504
  }
package/dist/cli/cli.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { UniformCLIPlugin } from '@uniformdev/cli';
2
2
  import { UniformPackage } from '@uniformdev/cli/sync';
3
- import { ah as CanvasDefinitions } from '../createEventBus-60ff8dc4.js';
3
+ import { ah as CanvasDefinitions } from '../createEventBus-db3535cb.js';
4
4
  import 'pusher-js';
5
5
 
6
6
  type CanvasPackage = UniformPackage & CanvasDefinitions;
package/dist/cli/cli.js CHANGED
@@ -18559,9 +18559,15 @@ var CanvasClient = class extends import_api.ApiClient {
18559
18559
  const fetchUri = this.createUrl(CANVAS_URL, { ...options, projectId });
18560
18560
  return await this.apiClient(fetchUri);
18561
18561
  }
18562
+ getCompositionByNodePath(options) {
18563
+ return this.getOneComposition(options);
18564
+ }
18562
18565
  unstable_getCompositionByNodePath(options) {
18563
18566
  return this.getOneComposition(options);
18564
18567
  }
18568
+ getCompositionByNodeId(options) {
18569
+ return this.getOneComposition(options);
18570
+ }
18565
18571
  unstable_getCompositionByNodeId(options) {
18566
18572
  return this.getOneComposition(options);
18567
18573
  }
package/dist/cli/cli.mjs CHANGED
@@ -14,7 +14,7 @@ import {
14
14
  __require,
15
15
  __toCommonJS,
16
16
  __toESM
17
- } from "../chunk-QNNQJB7F.mjs";
17
+ } from "../chunk-5UA6AKAR.mjs";
18
18
 
19
19
  // ../../node_modules/.pnpm/ms@2.1.2/node_modules/ms/index.js
20
20
  var require_ms = __commonJS({
@@ -2520,9 +2520,12 @@ type CanvasDefinitions = {
2520
2520
  /** Defines shared parameters for requests getting a single composition */
2521
2521
  type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withTotalCount'>;
2522
2522
  type CompositionGetBy<RequiredParameters extends keyof CompositionGetParameters> = CompositionGetOneSharedParameters & Required<Pick<CompositionGetParameters, RequiredParameters>>;
2523
+ type SpecificProjectMap = {
2524
+ projectMapId?: string;
2525
+ };
2523
2526
  /** Defines exact parameters for specific requests getting a single composition */
2524
- type CompositionGetByNodePathParameters = CompositionGetBy<'projectMapNodePath' | 'projectMapId'>;
2525
- type CompositionGetByNodeIdParameters = CompositionGetBy<'projectMapNodeId' | 'projectMapId'>;
2527
+ type CompositionGetByNodePathParameters = CompositionGetBy<'projectMapNodePath'> & SpecificProjectMap;
2528
+ type CompositionGetByNodeIdParameters = CompositionGetBy<'projectMapNodeId'> & SpecificProjectMap;
2526
2529
  type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
2527
2530
  type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
2528
2531
  /** Switches for data resolution */
@@ -4151,4 +4154,4 @@ declare global {
4151
4154
  */
4152
4155
  declare function createEventBus(): Promise<PreviewEventBus | undefined>;
4153
4156
 
4154
- export { ComponentDefinitionParameter as $, ReadyMessage as A, AddComponentMessage as B, CompositionGetParameters as C, DataResolutionOptionNegative as D, DismissPlaceholderMessage as E, ChannelMessage as F, isSelectComponentMessage as G, isReadyMessage as H, isUpdateCompositionMessage as I, isAddComponentMessage as J, isMovingComponentMessage as K, isDismissPlaceholderMessage as L, MoveComponentMessage as M, MessageHandler as N, Channel as O, PreviewEventBus as P, createCanvasChannel as Q, RootComponentInstance as R, SelectComponentMessage as S, ChannelSubscription as T, UpdateCompositionMessage as U, createEventBus as V, ComponentDefinitionGetResponse as W, ComponentDefinitionAPIResponse as X, ComponentDefinitionAPIPutRequest as Y, ComponentDefinitionAPIDeleteRequest as Z, ComponentDefinitionListAPIOptions as _, CompositionGetByNodePathParameters as a, ComponentDefinitionVariant as a0, ComponentDefinitionSlugSettings as a1, ComponentDefinitionSlot as a2, ComponentDefinitionPermission as a3, ComponentDefinition as a4, CreatingComponentDefinition as a5, CompositionGetOrderBy as a6, CompositionUIStatus as a7, CompositionGetListResponse as a8, CompositionAPIResponse as a9, CompositionAPIDeleteRequest as aa, CompositionListAPIResponse as ab, CompositionAPIOptions as ac, DataElementConnectionDefinition as ad, DataResourceVariables as ae, DataResourceDefinitions as af, DataResourceDefinition as ag, CanvasDefinitions as ah, CompositionIssue as ai, CompositionPatternIssue as aj, DataElementBindingIssue as ak, DataResourceIssue as al, DataResourceVariableIssue as am, DataResolutionConfigIssue as an, CompositionDataDiagnostic as ao, DataSourceGetResponse as ap, DataSourcesGetResponse as aq, DataType as ar, DataSource as as, DataVariableDefinition as at, CompositionGetResponse as b, DataResolutionOptionPositive as c, DataResolutionParameters as d, CompositionResolvedGetResponse as e, CompositionGetValidResponses as f, DataResolutionOption as g, CompositionGetByNodeIdParameters as h, CompositionGetBySlugParameters as i, CompositionGetByIdParameters as j, CompositionPutParameters as k, CompositionDeleteParameters as l, ComponentDefinitionGetParameters as m, ComponentDefinitionPutParameters as n, ComponentDefinitionDeleteParameters as o, ComponentInstance as p, ComponentParameter as q, components as r, DataSourceGetParameters as s, DataSourcesGetParameters as t, DataSourcePutParameters as u, DataSourceDeleteParameters as v, DataTypeGetParameters as w, DataTypeGetResponse as x, DataTypePutParameters as y, DataTypeDeleteParameters as z };
4157
+ export { ComponentDefinitionParameter as $, ReadyMessage as A, AddComponentMessage as B, CompositionGetParameters as C, DataResolutionOptionNegative as D, DismissPlaceholderMessage as E, ChannelMessage as F, isSelectComponentMessage as G, isReadyMessage as H, isUpdateCompositionMessage as I, isAddComponentMessage as J, isMovingComponentMessage as K, isDismissPlaceholderMessage as L, MoveComponentMessage as M, MessageHandler as N, Channel as O, PreviewEventBus as P, createCanvasChannel as Q, RootComponentInstance as R, SelectComponentMessage as S, ChannelSubscription as T, UpdateCompositionMessage as U, createEventBus as V, ComponentDefinitionGetResponse as W, ComponentDefinitionAPIResponse as X, ComponentDefinitionAPIPutRequest as Y, ComponentDefinitionAPIDeleteRequest as Z, ComponentDefinitionListAPIOptions as _, CompositionGetByNodePathParameters as a, ComponentDefinitionVariant as a0, ComponentDefinitionSlugSettings as a1, ComponentDefinitionSlot as a2, ComponentDefinitionPermission as a3, ComponentDefinition as a4, CreatingComponentDefinition as a5, CompositionGetOrderBy as a6, CompositionUIStatus as a7, CompositionGetListResponse as a8, CompositionAPIResponse as a9, CompositionAPIDeleteRequest as aa, CompositionListAPIResponse as ab, CompositionAPIOptions as ac, DataElementConnectionDefinition as ad, DataResourceVariables as ae, DataResourceDefinitions as af, DataResourceDefinition as ag, CanvasDefinitions as ah, SpecificProjectMap as ai, CompositionIssue as aj, CompositionPatternIssue as ak, DataElementBindingIssue as al, DataResourceIssue as am, DataResourceVariableIssue as an, DataResolutionConfigIssue as ao, CompositionDataDiagnostic as ap, DataSourceGetResponse as aq, DataSourcesGetResponse as ar, DataType as as, DataSource as at, DataVariableDefinition as au, CompositionGetResponse as b, DataResolutionOptionPositive as c, DataResolutionParameters as d, CompositionResolvedGetResponse as e, CompositionGetValidResponses as f, DataResolutionOption as g, CompositionGetByNodeIdParameters as h, CompositionGetBySlugParameters as i, CompositionGetByIdParameters as j, CompositionPutParameters as k, CompositionDeleteParameters as l, ComponentDefinitionGetParameters as m, ComponentDefinitionPutParameters as n, ComponentDefinitionDeleteParameters as o, ComponentInstance as p, ComponentParameter as q, components as r, DataSourceGetParameters as s, DataSourcesGetParameters as t, DataSourcePutParameters as u, DataSourceDeleteParameters as v, DataTypeGetParameters as w, DataTypeGetResponse as x, DataTypePutParameters as y, DataTypeDeleteParameters as z };
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@uniformdev/context/api';
2
2
  export { ApiClientError } from '@uniformdev/context/api';
3
- import { C as CompositionGetParameters, a as CompositionGetByNodePathParameters, D as DataResolutionOptionNegative, b as CompositionGetResponse, c as DataResolutionOptionPositive, d as DataResolutionParameters, e as CompositionResolvedGetResponse, f as CompositionGetValidResponses, g as DataResolutionOption, h as CompositionGetByNodeIdParameters, i as CompositionGetBySlugParameters, j as CompositionGetByIdParameters, k as CompositionPutParameters, l as CompositionDeleteParameters, m as ComponentDefinitionGetParameters, n as ComponentDefinitionPutParameters, o as ComponentDefinitionDeleteParameters, p as ComponentInstance, q as ComponentParameter, r as components, s as DataSourceGetParameters, t as DataSourcesGetParameters, u as DataSourcePutParameters, v as DataSourceDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, z as DataTypeDeleteParameters, P as PreviewEventBus, U as UpdateCompositionMessage, R as RootComponentInstance } from './createEventBus-60ff8dc4.js';
4
- export { B as AddComponentMessage, ah as CanvasDefinitions, O as Channel, F as ChannelMessage, T as ChannelSubscription, a4 as ComponentDefinition, Z as ComponentDefinitionAPIDeleteRequest, Y as ComponentDefinitionAPIPutRequest, X as ComponentDefinitionAPIResponse, W as ComponentDefinitionGetResponse, _ as ComponentDefinitionListAPIOptions, $ as ComponentDefinitionParameter, a3 as ComponentDefinitionPermission, a2 as ComponentDefinitionSlot, a1 as ComponentDefinitionSlugSettings, a0 as ComponentDefinitionVariant, aa as CompositionAPIDeleteRequest, ac as CompositionAPIOptions, a9 as CompositionAPIResponse, ao as CompositionDataDiagnostic, a8 as CompositionGetListResponse, a6 as CompositionGetOrderBy, ai as CompositionIssue, ab as CompositionListAPIResponse, aj as CompositionPatternIssue, a7 as CompositionUIStatus, a5 as CreatingComponentDefinition, ak as DataElementBindingIssue, ad as DataElementConnectionDefinition, an as DataResolutionConfigIssue, ag as DataResourceDefinition, af as DataResourceDefinitions, al as DataResourceIssue, am as DataResourceVariableIssue, ae as DataResourceVariables, as as DataSource, ap as DataSourceGetResponse, aq as DataSourcesGetResponse, ar as DataType, at as DataVariableDefinition, E as DismissPlaceholderMessage, N as MessageHandler, M as MoveComponentMessage, A as ReadyMessage, S as SelectComponentMessage, Q as createCanvasChannel, V as createEventBus, J as isAddComponentMessage, L as isDismissPlaceholderMessage, K as isMovingComponentMessage, H as isReadyMessage, G as isSelectComponentMessage, I as isUpdateCompositionMessage } from './createEventBus-60ff8dc4.js';
3
+ import { C as CompositionGetParameters, a as CompositionGetByNodePathParameters, D as DataResolutionOptionNegative, b as CompositionGetResponse, c as DataResolutionOptionPositive, d as DataResolutionParameters, e as CompositionResolvedGetResponse, f as CompositionGetValidResponses, g as DataResolutionOption, h as CompositionGetByNodeIdParameters, i as CompositionGetBySlugParameters, j as CompositionGetByIdParameters, k as CompositionPutParameters, l as CompositionDeleteParameters, m as ComponentDefinitionGetParameters, n as ComponentDefinitionPutParameters, o as ComponentDefinitionDeleteParameters, p as ComponentInstance, q as ComponentParameter, r as components, s as DataSourceGetParameters, t as DataSourcesGetParameters, u as DataSourcePutParameters, v as DataSourceDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, z as DataTypeDeleteParameters, P as PreviewEventBus, U as UpdateCompositionMessage, R as RootComponentInstance } from './createEventBus-db3535cb.js';
4
+ export { B as AddComponentMessage, ah as CanvasDefinitions, O as Channel, F as ChannelMessage, T as ChannelSubscription, a4 as ComponentDefinition, Z as ComponentDefinitionAPIDeleteRequest, Y as ComponentDefinitionAPIPutRequest, X as ComponentDefinitionAPIResponse, W as ComponentDefinitionGetResponse, _ as ComponentDefinitionListAPIOptions, $ as ComponentDefinitionParameter, a3 as ComponentDefinitionPermission, a2 as ComponentDefinitionSlot, a1 as ComponentDefinitionSlugSettings, a0 as ComponentDefinitionVariant, aa as CompositionAPIDeleteRequest, ac as CompositionAPIOptions, a9 as CompositionAPIResponse, ap as CompositionDataDiagnostic, a8 as CompositionGetListResponse, a6 as CompositionGetOrderBy, aj as CompositionIssue, ab as CompositionListAPIResponse, ak as CompositionPatternIssue, a7 as CompositionUIStatus, a5 as CreatingComponentDefinition, al as DataElementBindingIssue, ad as DataElementConnectionDefinition, ao as DataResolutionConfigIssue, ag as DataResourceDefinition, af as DataResourceDefinitions, am as DataResourceIssue, an as DataResourceVariableIssue, ae as DataResourceVariables, at as DataSource, aq as DataSourceGetResponse, ar as DataSourcesGetResponse, as as DataType, au as DataVariableDefinition, E as DismissPlaceholderMessage, N as MessageHandler, M as MoveComponentMessage, A as ReadyMessage, S as SelectComponentMessage, ai as SpecificProjectMap, Q as createCanvasChannel, V as createEventBus, J as isAddComponentMessage, L as isDismissPlaceholderMessage, K as isMovingComponentMessage, H as isReadyMessage, G as isSelectComponentMessage, I as isUpdateCompositionMessage } from './createEventBus-db3535cb.js';
5
5
  import { Options as Options$1 } from 'p-retry';
6
6
  import { Options } from 'p-throttle';
7
7
  import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
@@ -99,13 +99,17 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
99
99
  totalCount?: number | undefined;
100
100
  }>;
101
101
  /** Fetches one composition by its project map node path */
102
- unstable_getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
103
- unstable_getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
104
- unstable_getCompositionByNodePath<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
102
+ getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
103
+ getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
104
+ getCompositionByNodePath<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
105
+ /** @deprecated use getCompositionByNodePath instead */
106
+ unstable_getCompositionByNodePath(options: CompositionGetByNodePathParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
105
107
  /** Fetches one composition by its project map node ID */
106
- unstable_getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
107
- unstable_getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
108
- unstable_getCompositionByNodeId<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
108
+ getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
109
+ getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
110
+ getCompositionByNodeId<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
111
+ /** @deprecated Use getCompositionByNodeId instead */
112
+ unstable_getCompositionByNodeId(options: CompositionGetByNodeIdParameters & DataResolutionOption & DataResolutionParameters): Promise<unknown>;
109
113
  /** Fetches one composition by its slug */
110
114
  getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
111
115
  getCompositionBySlug(options: CompositionGetBySlugParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
@@ -143,7 +147,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
143
147
  slots?: {
144
148
  id: string;
145
149
  name: string;
146
- allowedComponents: string[];
150
+ allowedComponents: string[]; /** Deletes a Canvas component definition */
147
151
  inheritAllowedComponents: boolean;
148
152
  minComponents?: number | undefined;
149
153
  maxComponents?: number | undefined;
package/dist/index.esm.js CHANGED
@@ -58,7 +58,7 @@ import {
58
58
  nullLimitPolicy,
59
59
  subscribeToComposition,
60
60
  walkComponentTree
61
- } from "./chunk-QNNQJB7F.mjs";
61
+ } from "./chunk-5UA6AKAR.mjs";
62
62
  export {
63
63
  ApiClientError,
64
64
  BatchEntry,
package/dist/index.js CHANGED
@@ -528,9 +528,15 @@ var CanvasClient = class extends import_api.ApiClient {
528
528
  const fetchUri = this.createUrl(CANVAS_URL, { ...options, projectId });
529
529
  return await this.apiClient(fetchUri);
530
530
  }
531
+ getCompositionByNodePath(options) {
532
+ return this.getOneComposition(options);
533
+ }
531
534
  unstable_getCompositionByNodePath(options) {
532
535
  return this.getOneComposition(options);
533
536
  }
537
+ getCompositionByNodeId(options) {
538
+ return this.getOneComposition(options);
539
+ }
534
540
  unstable_getCompositionByNodeId(options) {
535
541
  return this.getOneComposition(options);
536
542
  }
package/dist/index.mjs CHANGED
@@ -58,7 +58,7 @@ import {
58
58
  nullLimitPolicy,
59
59
  subscribeToComposition,
60
60
  walkComponentTree
61
- } from "./chunk-QNNQJB7F.mjs";
61
+ } from "./chunk-5UA6AKAR.mjs";
62
62
  export {
63
63
  ApiClientError,
64
64
  BatchEntry,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "18.12.0",
3
+ "version": "18.12.1-alpha.18+19edda8b5",
4
4
  "description": "Common functionality and types for Uniform Canvas",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -49,7 +49,7 @@
49
49
  "devDependencies": {
50
50
  "@types/retry": "0.12.1",
51
51
  "@types/yargs": "17.0.22",
52
- "@uniformdev/cli": "18.12.0",
52
+ "@uniformdev/cli": "18.12.1-alpha.18+19edda8b5",
53
53
  "p-limit": "4.0.0",
54
54
  "p-retry": "5.1.2",
55
55
  "p-throttle": "5.0.0",
@@ -57,7 +57,7 @@
57
57
  "yargs": "17.6.2"
58
58
  },
59
59
  "dependencies": {
60
- "@uniformdev/context": "18.12.0"
60
+ "@uniformdev/context": "18.12.1-alpha.18+19edda8b5"
61
61
  },
62
62
  "files": [
63
63
  "/dist"
@@ -65,5 +65,5 @@
65
65
  "publishConfig": {
66
66
  "access": "public"
67
67
  },
68
- "gitHead": "80d99ef272482848ca9a2508937fd19cc0f23508"
68
+ "gitHead": "19edda8b549122f979543430d69de751df221ccf"
69
69
  }