@uniformdev/canvas 19.175.1-alpha.38 → 19.175.1-alpha.41

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.
Files changed (3) hide show
  1. package/dist/index.d.mts +75 -37
  2. package/dist/index.d.ts +75 -37
  3. package/package.json +4 -4
package/dist/index.d.mts CHANGED
@@ -591,7 +591,7 @@ interface components$8 {
591
591
  */
592
592
  optionalPatternParameter?: boolean;
593
593
  /** @description Resolve this data resource with draft mode content. TBD */
594
- isDraft?: boolean;
594
+ includeUnpublishedData?: boolean;
595
595
  variables?: components$8["schemas"]["DataResourceVariables"];
596
596
  };
597
597
  /** @description Variable values for a data resource */
@@ -1898,7 +1898,7 @@ interface external$i {
1898
1898
  */
1899
1899
  optionalPatternParameter?: boolean;
1900
1900
  /** @description Resolve this data resource with draft mode content. TBD */
1901
- isDraft?: boolean;
1901
+ includeUnpublishedData?: boolean;
1902
1902
  variables?: external$i["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1903
1903
  };
1904
1904
  /** @description Variable values for a data resource */
@@ -3204,7 +3204,7 @@ interface external$h {
3204
3204
  */
3205
3205
  optionalPatternParameter?: boolean;
3206
3206
  /** @description Resolve this data resource with draft mode content. TBD */
3207
- isDraft?: boolean;
3207
+ includeUnpublishedData?: boolean;
3208
3208
  variables?: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
3209
3209
  };
3210
3210
  /** @description Variable values for a data resource */
@@ -4599,7 +4599,7 @@ interface external$g {
4599
4599
  */
4600
4600
  optionalPatternParameter?: boolean;
4601
4601
  /** @description Resolve this data resource with draft mode content. TBD */
4602
- isDraft?: boolean;
4602
+ includeUnpublishedData?: boolean;
4603
4603
  variables?: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
4604
4604
  };
4605
4605
  /** @description Variable values for a data resource */
@@ -6328,7 +6328,7 @@ interface external$f {
6328
6328
  */
6329
6329
  optionalPatternParameter?: boolean;
6330
6330
  /** @description Resolve this data resource with draft mode content. TBD */
6331
- isDraft?: boolean;
6331
+ includeUnpublishedData?: boolean;
6332
6332
  variables?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
6333
6333
  };
6334
6334
  /** @description Variable values for a data resource */
@@ -7564,7 +7564,7 @@ interface external$e {
7564
7564
  */
7565
7565
  optionalPatternParameter?: boolean;
7566
7566
  /** @description Resolve this data resource with draft mode content. TBD */
7567
- isDraft?: boolean;
7567
+ includeUnpublishedData?: boolean;
7568
7568
  variables?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
7569
7569
  };
7570
7570
  /** @description Variable values for a data resource */
@@ -8857,7 +8857,7 @@ interface external$d {
8857
8857
  */
8858
8858
  optionalPatternParameter?: boolean;
8859
8859
  /** @description Resolve this data resource with draft mode content. TBD */
8860
- isDraft?: boolean;
8860
+ includeUnpublishedData?: boolean;
8861
8861
  variables?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
8862
8862
  };
8863
8863
  /** @description Variable values for a data resource */
@@ -10087,7 +10087,7 @@ interface external$c {
10087
10087
  */
10088
10088
  optionalPatternParameter?: boolean;
10089
10089
  /** @description Resolve this data resource with draft mode content. TBD */
10090
- isDraft?: boolean;
10090
+ includeUnpublishedData?: boolean;
10091
10091
  variables?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
10092
10092
  };
10093
10093
  /** @description Variable values for a data resource */
@@ -11352,7 +11352,7 @@ interface external$b {
11352
11352
  */
11353
11353
  optionalPatternParameter?: boolean;
11354
11354
  /** @description Resolve this data resource with draft mode content. TBD */
11355
- isDraft?: boolean;
11355
+ includeUnpublishedData?: boolean;
11356
11356
  variables?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
11357
11357
  };
11358
11358
  /** @description Variable values for a data resource */
@@ -12617,7 +12617,7 @@ interface external$a {
12617
12617
  */
12618
12618
  optionalPatternParameter?: boolean;
12619
12619
  /** @description Resolve this data resource with draft mode content. TBD */
12620
- isDraft?: boolean;
12620
+ includeUnpublishedData?: boolean;
12621
12621
  variables?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
12622
12622
  };
12623
12623
  /** @description Variable values for a data resource */
@@ -13472,6 +13472,8 @@ interface paths$7 {
13472
13472
  * * `composition` - Returns only composition patterns
13473
13473
  */
13474
13474
  patternType?: components$5["parameters"]["patternType"];
13475
+ /** @deprecated Includes the `patternType` attribute in the response */
13476
+ withPatternType?: components$5["parameters"]["withPatternType"];
13475
13477
  /** The project the composition(s) belong to */
13476
13478
  projectId: components$5["parameters"]["projectId"];
13477
13479
  /**
@@ -13768,6 +13770,11 @@ interface components$5 {
13768
13770
  previewImageUrl?: string;
13769
13771
  /** @description Indicates if the composition is a pattern that can be referenced in other compositions */
13770
13772
  pattern: boolean;
13773
+ /**
13774
+ * @description If the instance is a pattern, this indicates if it's a component pattern or a composition pattern
13775
+ * @enum {string}
13776
+ */
13777
+ patternType?: "component" | "composition";
13771
13778
  /**
13772
13779
  * Format: uuid
13773
13780
  * @description The release this composition belongs to. If not set, it belongs to the base
@@ -13909,6 +13916,11 @@ interface components$5 {
13909
13916
  * * `composition` - Returns only composition patterns
13910
13917
  */
13911
13918
  patternType: "all" | "component" | "composition";
13919
+ /**
13920
+ * @deprecated
13921
+ * @description Includes the `patternType` attribute in the response
13922
+ */
13923
+ withPatternType: boolean;
13912
13924
  /**
13913
13925
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
13914
13926
  * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
@@ -14619,7 +14631,7 @@ interface external$8 {
14619
14631
  */
14620
14632
  optionalPatternParameter?: boolean;
14621
14633
  /** @description Resolve this data resource with draft mode content. TBD */
14622
- isDraft?: boolean;
14634
+ includeUnpublishedData?: boolean;
14623
14635
  variables?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
14624
14636
  };
14625
14637
  /** @description Variable values for a data resource */
@@ -15855,7 +15867,7 @@ interface external$7 {
15855
15867
  */
15856
15868
  optionalPatternParameter?: boolean;
15857
15869
  /** @description Resolve this data resource with draft mode content. TBD */
15858
- isDraft?: boolean;
15870
+ includeUnpublishedData?: boolean;
15859
15871
  variables?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
15860
15872
  };
15861
15873
  /** @description Variable values for a data resource */
@@ -17231,7 +17243,7 @@ interface external$6 {
17231
17243
  */
17232
17244
  optionalPatternParameter?: boolean;
17233
17245
  /** @description Resolve this data resource with draft mode content. TBD */
17234
- isDraft?: boolean;
17246
+ includeUnpublishedData?: boolean;
17235
17247
  variables?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
17236
17248
  };
17237
17249
  /** @description Variable values for a data resource */
@@ -17519,6 +17531,8 @@ interface external$6 {
17519
17531
  * * `composition` - Returns only composition patterns
17520
17532
  */
17521
17533
  patternType?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["patternType"];
17534
+ /** @deprecated Includes the `patternType` attribute in the response */
17535
+ withPatternType?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withPatternType"];
17522
17536
  /** The project the composition(s) belong to */
17523
17537
  projectId: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
17524
17538
  /**
@@ -17815,6 +17829,11 @@ interface external$6 {
17815
17829
  previewImageUrl?: string;
17816
17830
  /** @description Indicates if the composition is a pattern that can be referenced in other compositions */
17817
17831
  pattern: boolean;
17832
+ /**
17833
+ * @description If the instance is a pattern, this indicates if it's a component pattern or a composition pattern
17834
+ * @enum {string}
17835
+ */
17836
+ patternType?: "component" | "composition";
17818
17837
  /**
17819
17838
  * Format: uuid
17820
17839
  * @description The release this composition belongs to. If not set, it belongs to the base
@@ -17956,6 +17975,11 @@ interface external$6 {
17956
17975
  * * `composition` - Returns only composition patterns
17957
17976
  */
17958
17977
  patternType: "all" | "component" | "composition";
17978
+ /**
17979
+ * @deprecated
17980
+ * @description Includes the `patternType` attribute in the response
17981
+ */
17982
+ withPatternType: boolean;
17959
17983
  /**
17960
17984
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
17961
17985
  * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
@@ -19180,8 +19204,8 @@ interface external$6 {
19180
19204
  * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
19181
19205
  */
19182
19206
  releaseId?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["releaseId"];
19183
- /** If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
19184
- isDraft?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["isDraft"];
19207
+ /** TBD */
19208
+ dataResourcesEnvironment?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["dataResourcesEnvironment"];
19185
19209
  };
19186
19210
  };
19187
19211
  responses: {
@@ -19228,10 +19252,11 @@ interface external$6 {
19228
19252
  matchedRoute: string;
19229
19253
  dynamicInputs?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteDynamicInputs"];
19230
19254
  /**
19231
- * @description If true, the response includes draft/unpublished/modified content.
19232
- * If false, such content is excluded.
19255
+ * @description TBD
19256
+ *
19257
+ * @enum {string}
19233
19258
  */
19234
- isDraft?: boolean;
19259
+ dataResourcesEnvironment?: "unpublishedData";
19235
19260
  /** @enum {string} */
19236
19261
  type: "composition";
19237
19262
  compositionApiResponse: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
@@ -19312,8 +19337,8 @@ interface external$6 {
19312
19337
  * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
19313
19338
  */
19314
19339
  releaseId: string;
19315
- /** @description If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
19316
- isDraft: boolean;
19340
+ /** @description TBD */
19341
+ dataResourcesEnvironment: "unpublishedData";
19317
19342
  };
19318
19343
  };
19319
19344
  operations: {};
@@ -19389,8 +19414,8 @@ interface paths$5 {
19389
19414
  * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
19390
19415
  */
19391
19416
  releaseId?: components$3["parameters"]["releaseId"];
19392
- /** If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
19393
- isDraft?: components$3["parameters"]["isDraft"];
19417
+ /** TBD */
19418
+ dataResourcesEnvironment?: components$3["parameters"]["dataResourcesEnvironment"];
19394
19419
  };
19395
19420
  };
19396
19421
  responses: {
@@ -19437,10 +19462,11 @@ interface components$3 {
19437
19462
  matchedRoute: string;
19438
19463
  dynamicInputs?: components$3["schemas"]["RouteDynamicInputs"];
19439
19464
  /**
19440
- * @description If true, the response includes draft/unpublished/modified content.
19441
- * If false, such content is excluded.
19465
+ * @description TBD
19466
+ *
19467
+ * @enum {string}
19442
19468
  */
19443
- isDraft?: boolean;
19469
+ dataResourcesEnvironment?: "unpublishedData";
19444
19470
  /** @enum {string} */
19445
19471
  type: "composition";
19446
19472
  compositionApiResponse: external$5["v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
@@ -19521,8 +19547,8 @@ interface components$3 {
19521
19547
  * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
19522
19548
  */
19523
19549
  releaseId: string;
19524
- /** @description If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
19525
- isDraft: boolean;
19550
+ /** @description TBD */
19551
+ dataResourcesEnvironment: "unpublishedData";
19526
19552
  };
19527
19553
  }
19528
19554
  interface external$5 {
@@ -20154,7 +20180,7 @@ interface external$5 {
20154
20180
  */
20155
20181
  optionalPatternParameter?: boolean;
20156
20182
  /** @description Resolve this data resource with draft mode content. TBD */
20157
- isDraft?: boolean;
20183
+ includeUnpublishedData?: boolean;
20158
20184
  variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
20159
20185
  };
20160
20186
  /** @description Variable values for a data resource */
@@ -20442,6 +20468,8 @@ interface external$5 {
20442
20468
  * * `composition` - Returns only composition patterns
20443
20469
  */
20444
20470
  patternType?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["patternType"];
20471
+ /** @deprecated Includes the `patternType` attribute in the response */
20472
+ withPatternType?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["withPatternType"];
20445
20473
  /** The project the composition(s) belong to */
20446
20474
  projectId: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
20447
20475
  /**
@@ -20738,6 +20766,11 @@ interface external$5 {
20738
20766
  previewImageUrl?: string;
20739
20767
  /** @description Indicates if the composition is a pattern that can be referenced in other compositions */
20740
20768
  pattern: boolean;
20769
+ /**
20770
+ * @description If the instance is a pattern, this indicates if it's a component pattern or a composition pattern
20771
+ * @enum {string}
20772
+ */
20773
+ patternType?: "component" | "composition";
20741
20774
  /**
20742
20775
  * Format: uuid
20743
20776
  * @description The release this composition belongs to. If not set, it belongs to the base
@@ -20879,6 +20912,11 @@ interface external$5 {
20879
20912
  * * `composition` - Returns only composition patterns
20880
20913
  */
20881
20914
  patternType: "all" | "component" | "composition";
20915
+ /**
20916
+ * @deprecated
20917
+ * @description Includes the `patternType` attribute in the response
20918
+ */
20919
+ withPatternType: boolean;
20882
20920
  /**
20883
20921
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
20884
20922
  * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
@@ -21666,7 +21704,7 @@ type DataResolutionParameters = {
21666
21704
  * Controls how many levels deep content references should be resolved.
21667
21705
  */
21668
21706
  resolutionDepth?: number;
21669
- isDraft?: boolean;
21707
+ includeUnpublishedData?: boolean;
21670
21708
  };
21671
21709
  /** Types of issue that can occur when fetching composition data */
21672
21710
  type DataResolutionIssue = PatternIssue | DataResourceIssue | MaxDepthExceededIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
@@ -22944,7 +22982,7 @@ interface external$3 {
22944
22982
  */
22945
22983
  optionalPatternParameter?: boolean;
22946
22984
  /** @description Resolve this data resource with draft mode content. TBD */
22947
- isDraft?: boolean;
22985
+ includeUnpublishedData?: boolean;
22948
22986
  variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
22949
22987
  };
22950
22988
  /** @description Variable values for a data resource */
@@ -24466,7 +24504,7 @@ interface external$1 {
24466
24504
  */
24467
24505
  optionalPatternParameter?: boolean;
24468
24506
  /** @description Resolve this data resource with draft mode content. TBD */
24469
- isDraft?: boolean;
24507
+ includeUnpublishedData?: boolean;
24470
24508
  variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
24471
24509
  };
24472
24510
  /** @description Variable values for a data resource */
@@ -25174,7 +25212,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
25174
25212
  isPatternParameter?: boolean | undefined;
25175
25213
  ignorePatternParameterDefault?: boolean | undefined;
25176
25214
  optionalPatternParameter?: boolean | undefined;
25177
- isDraft?: boolean | undefined;
25215
+ includeUnpublishedData?: boolean | undefined;
25178
25216
  variables?: {
25179
25217
  [key: string]: string;
25180
25218
  } | undefined;
@@ -25186,7 +25224,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
25186
25224
  isPatternParameter?: boolean | undefined;
25187
25225
  ignorePatternParameterDefault?: boolean | undefined;
25188
25226
  optionalPatternParameter?: boolean | undefined;
25189
- isDraft?: boolean | undefined;
25227
+ includeUnpublishedData?: boolean | undefined;
25190
25228
  variables?: {
25191
25229
  [key: string]: string;
25192
25230
  } | undefined;
@@ -26404,7 +26442,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
26404
26442
  isPatternParameter?: boolean | undefined;
26405
26443
  ignorePatternParameterDefault?: boolean | undefined;
26406
26444
  optionalPatternParameter?: boolean | undefined;
26407
- isDraft?: boolean | undefined;
26445
+ includeUnpublishedData?: boolean | undefined;
26408
26446
  variables?: {
26409
26447
  [key: string]: string;
26410
26448
  } | undefined;
@@ -26416,7 +26454,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
26416
26454
  isPatternParameter?: boolean | undefined;
26417
26455
  ignorePatternParameterDefault?: boolean | undefined;
26418
26456
  optionalPatternParameter?: boolean | undefined;
26419
- isDraft?: boolean | undefined;
26457
+ includeUnpublishedData?: boolean | undefined;
26420
26458
  variables?: {
26421
26459
  [key: string]: string;
26422
26460
  } | undefined;
@@ -26471,7 +26509,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
26471
26509
  isPatternParameter?: boolean | undefined;
26472
26510
  ignorePatternParameterDefault?: boolean | undefined;
26473
26511
  optionalPatternParameter?: boolean | undefined;
26474
- isDraft?: boolean | undefined;
26512
+ includeUnpublishedData?: boolean | undefined;
26475
26513
  variables?: {
26476
26514
  [key: string]: string;
26477
26515
  } | undefined;
@@ -26483,7 +26521,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
26483
26521
  isPatternParameter?: boolean | undefined;
26484
26522
  ignorePatternParameterDefault?: boolean | undefined;
26485
26523
  optionalPatternParameter?: boolean | undefined;
26486
- isDraft?: boolean | undefined;
26524
+ includeUnpublishedData?: boolean | undefined;
26487
26525
  variables?: {
26488
26526
  [key: string]: string;
26489
26527
  } | undefined;
package/dist/index.d.ts CHANGED
@@ -591,7 +591,7 @@ interface components$8 {
591
591
  */
592
592
  optionalPatternParameter?: boolean;
593
593
  /** @description Resolve this data resource with draft mode content. TBD */
594
- isDraft?: boolean;
594
+ includeUnpublishedData?: boolean;
595
595
  variables?: components$8["schemas"]["DataResourceVariables"];
596
596
  };
597
597
  /** @description Variable values for a data resource */
@@ -1898,7 +1898,7 @@ interface external$i {
1898
1898
  */
1899
1899
  optionalPatternParameter?: boolean;
1900
1900
  /** @description Resolve this data resource with draft mode content. TBD */
1901
- isDraft?: boolean;
1901
+ includeUnpublishedData?: boolean;
1902
1902
  variables?: external$i["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1903
1903
  };
1904
1904
  /** @description Variable values for a data resource */
@@ -3204,7 +3204,7 @@ interface external$h {
3204
3204
  */
3205
3205
  optionalPatternParameter?: boolean;
3206
3206
  /** @description Resolve this data resource with draft mode content. TBD */
3207
- isDraft?: boolean;
3207
+ includeUnpublishedData?: boolean;
3208
3208
  variables?: external$h["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
3209
3209
  };
3210
3210
  /** @description Variable values for a data resource */
@@ -4599,7 +4599,7 @@ interface external$g {
4599
4599
  */
4600
4600
  optionalPatternParameter?: boolean;
4601
4601
  /** @description Resolve this data resource with draft mode content. TBD */
4602
- isDraft?: boolean;
4602
+ includeUnpublishedData?: boolean;
4603
4603
  variables?: external$g["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
4604
4604
  };
4605
4605
  /** @description Variable values for a data resource */
@@ -6328,7 +6328,7 @@ interface external$f {
6328
6328
  */
6329
6329
  optionalPatternParameter?: boolean;
6330
6330
  /** @description Resolve this data resource with draft mode content. TBD */
6331
- isDraft?: boolean;
6331
+ includeUnpublishedData?: boolean;
6332
6332
  variables?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
6333
6333
  };
6334
6334
  /** @description Variable values for a data resource */
@@ -7564,7 +7564,7 @@ interface external$e {
7564
7564
  */
7565
7565
  optionalPatternParameter?: boolean;
7566
7566
  /** @description Resolve this data resource with draft mode content. TBD */
7567
- isDraft?: boolean;
7567
+ includeUnpublishedData?: boolean;
7568
7568
  variables?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
7569
7569
  };
7570
7570
  /** @description Variable values for a data resource */
@@ -8857,7 +8857,7 @@ interface external$d {
8857
8857
  */
8858
8858
  optionalPatternParameter?: boolean;
8859
8859
  /** @description Resolve this data resource with draft mode content. TBD */
8860
- isDraft?: boolean;
8860
+ includeUnpublishedData?: boolean;
8861
8861
  variables?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
8862
8862
  };
8863
8863
  /** @description Variable values for a data resource */
@@ -10087,7 +10087,7 @@ interface external$c {
10087
10087
  */
10088
10088
  optionalPatternParameter?: boolean;
10089
10089
  /** @description Resolve this data resource with draft mode content. TBD */
10090
- isDraft?: boolean;
10090
+ includeUnpublishedData?: boolean;
10091
10091
  variables?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
10092
10092
  };
10093
10093
  /** @description Variable values for a data resource */
@@ -11352,7 +11352,7 @@ interface external$b {
11352
11352
  */
11353
11353
  optionalPatternParameter?: boolean;
11354
11354
  /** @description Resolve this data resource with draft mode content. TBD */
11355
- isDraft?: boolean;
11355
+ includeUnpublishedData?: boolean;
11356
11356
  variables?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
11357
11357
  };
11358
11358
  /** @description Variable values for a data resource */
@@ -12617,7 +12617,7 @@ interface external$a {
12617
12617
  */
12618
12618
  optionalPatternParameter?: boolean;
12619
12619
  /** @description Resolve this data resource with draft mode content. TBD */
12620
- isDraft?: boolean;
12620
+ includeUnpublishedData?: boolean;
12621
12621
  variables?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
12622
12622
  };
12623
12623
  /** @description Variable values for a data resource */
@@ -13472,6 +13472,8 @@ interface paths$7 {
13472
13472
  * * `composition` - Returns only composition patterns
13473
13473
  */
13474
13474
  patternType?: components$5["parameters"]["patternType"];
13475
+ /** @deprecated Includes the `patternType` attribute in the response */
13476
+ withPatternType?: components$5["parameters"]["withPatternType"];
13475
13477
  /** The project the composition(s) belong to */
13476
13478
  projectId: components$5["parameters"]["projectId"];
13477
13479
  /**
@@ -13768,6 +13770,11 @@ interface components$5 {
13768
13770
  previewImageUrl?: string;
13769
13771
  /** @description Indicates if the composition is a pattern that can be referenced in other compositions */
13770
13772
  pattern: boolean;
13773
+ /**
13774
+ * @description If the instance is a pattern, this indicates if it's a component pattern or a composition pattern
13775
+ * @enum {string}
13776
+ */
13777
+ patternType?: "component" | "composition";
13771
13778
  /**
13772
13779
  * Format: uuid
13773
13780
  * @description The release this composition belongs to. If not set, it belongs to the base
@@ -13909,6 +13916,11 @@ interface components$5 {
13909
13916
  * * `composition` - Returns only composition patterns
13910
13917
  */
13911
13918
  patternType: "all" | "component" | "composition";
13919
+ /**
13920
+ * @deprecated
13921
+ * @description Includes the `patternType` attribute in the response
13922
+ */
13923
+ withPatternType: boolean;
13912
13924
  /**
13913
13925
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
13914
13926
  * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
@@ -14619,7 +14631,7 @@ interface external$8 {
14619
14631
  */
14620
14632
  optionalPatternParameter?: boolean;
14621
14633
  /** @description Resolve this data resource with draft mode content. TBD */
14622
- isDraft?: boolean;
14634
+ includeUnpublishedData?: boolean;
14623
14635
  variables?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
14624
14636
  };
14625
14637
  /** @description Variable values for a data resource */
@@ -15855,7 +15867,7 @@ interface external$7 {
15855
15867
  */
15856
15868
  optionalPatternParameter?: boolean;
15857
15869
  /** @description Resolve this data resource with draft mode content. TBD */
15858
- isDraft?: boolean;
15870
+ includeUnpublishedData?: boolean;
15859
15871
  variables?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
15860
15872
  };
15861
15873
  /** @description Variable values for a data resource */
@@ -17231,7 +17243,7 @@ interface external$6 {
17231
17243
  */
17232
17244
  optionalPatternParameter?: boolean;
17233
17245
  /** @description Resolve this data resource with draft mode content. TBD */
17234
- isDraft?: boolean;
17246
+ includeUnpublishedData?: boolean;
17235
17247
  variables?: external$6["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
17236
17248
  };
17237
17249
  /** @description Variable values for a data resource */
@@ -17519,6 +17531,8 @@ interface external$6 {
17519
17531
  * * `composition` - Returns only composition patterns
17520
17532
  */
17521
17533
  patternType?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["patternType"];
17534
+ /** @deprecated Includes the `patternType` attribute in the response */
17535
+ withPatternType?: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["withPatternType"];
17522
17536
  /** The project the composition(s) belong to */
17523
17537
  projectId: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
17524
17538
  /**
@@ -17815,6 +17829,11 @@ interface external$6 {
17815
17829
  previewImageUrl?: string;
17816
17830
  /** @description Indicates if the composition is a pattern that can be referenced in other compositions */
17817
17831
  pattern: boolean;
17832
+ /**
17833
+ * @description If the instance is a pattern, this indicates if it's a component pattern or a composition pattern
17834
+ * @enum {string}
17835
+ */
17836
+ patternType?: "component" | "composition";
17818
17837
  /**
17819
17838
  * Format: uuid
17820
17839
  * @description The release this composition belongs to. If not set, it belongs to the base
@@ -17956,6 +17975,11 @@ interface external$6 {
17956
17975
  * * `composition` - Returns only composition patterns
17957
17976
  */
17958
17977
  patternType: "all" | "component" | "composition";
17978
+ /**
17979
+ * @deprecated
17980
+ * @description Includes the `patternType` attribute in the response
17981
+ */
17982
+ withPatternType: boolean;
17959
17983
  /**
17960
17984
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
17961
17985
  * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
@@ -19180,8 +19204,8 @@ interface external$6 {
19180
19204
  * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
19181
19205
  */
19182
19206
  releaseId?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["releaseId"];
19183
- /** If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
19184
- isDraft?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["isDraft"];
19207
+ /** TBD */
19208
+ dataResourcesEnvironment?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["parameters"]["dataResourcesEnvironment"];
19185
19209
  };
19186
19210
  };
19187
19211
  responses: {
@@ -19228,10 +19252,11 @@ interface external$6 {
19228
19252
  matchedRoute: string;
19229
19253
  dynamicInputs?: external$6["../../../lambda/functions/v1-route.swagger.yml"]["components"]["schemas"]["RouteDynamicInputs"];
19230
19254
  /**
19231
- * @description If true, the response includes draft/unpublished/modified content.
19232
- * If false, such content is excluded.
19255
+ * @description TBD
19256
+ *
19257
+ * @enum {string}
19233
19258
  */
19234
- isDraft?: boolean;
19259
+ dataResourcesEnvironment?: "unpublishedData";
19235
19260
  /** @enum {string} */
19236
19261
  type: "composition";
19237
19262
  compositionApiResponse: external$6["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
@@ -19312,8 +19337,8 @@ interface external$6 {
19312
19337
  * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
19313
19338
  */
19314
19339
  releaseId: string;
19315
- /** @description If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
19316
- isDraft: boolean;
19340
+ /** @description TBD */
19341
+ dataResourcesEnvironment: "unpublishedData";
19317
19342
  };
19318
19343
  };
19319
19344
  operations: {};
@@ -19389,8 +19414,8 @@ interface paths$5 {
19389
19414
  * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
19390
19415
  */
19391
19416
  releaseId?: components$3["parameters"]["releaseId"];
19392
- /** If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
19393
- isDraft?: components$3["parameters"]["isDraft"];
19417
+ /** TBD */
19418
+ dataResourcesEnvironment?: components$3["parameters"]["dataResourcesEnvironment"];
19394
19419
  };
19395
19420
  };
19396
19421
  responses: {
@@ -19437,10 +19462,11 @@ interface components$3 {
19437
19462
  matchedRoute: string;
19438
19463
  dynamicInputs?: components$3["schemas"]["RouteDynamicInputs"];
19439
19464
  /**
19440
- * @description If true, the response includes draft/unpublished/modified content.
19441
- * If false, such content is excluded.
19465
+ * @description TBD
19466
+ *
19467
+ * @enum {string}
19442
19468
  */
19443
- isDraft?: boolean;
19469
+ dataResourcesEnvironment?: "unpublishedData";
19444
19470
  /** @enum {string} */
19445
19471
  type: "composition";
19446
19472
  compositionApiResponse: external$5["v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
@@ -19521,8 +19547,8 @@ interface components$3 {
19521
19547
  * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
19522
19548
  */
19523
19549
  releaseId: string;
19524
- /** @description If true, the response will include draft/unpublished/modified content. If false, such content will be excluded. */
19525
- isDraft: boolean;
19550
+ /** @description TBD */
19551
+ dataResourcesEnvironment: "unpublishedData";
19526
19552
  };
19527
19553
  }
19528
19554
  interface external$5 {
@@ -20154,7 +20180,7 @@ interface external$5 {
20154
20180
  */
20155
20181
  optionalPatternParameter?: boolean;
20156
20182
  /** @description Resolve this data resource with draft mode content. TBD */
20157
- isDraft?: boolean;
20183
+ includeUnpublishedData?: boolean;
20158
20184
  variables?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
20159
20185
  };
20160
20186
  /** @description Variable values for a data resource */
@@ -20442,6 +20468,8 @@ interface external$5 {
20442
20468
  * * `composition` - Returns only composition patterns
20443
20469
  */
20444
20470
  patternType?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["patternType"];
20471
+ /** @deprecated Includes the `patternType` attribute in the response */
20472
+ withPatternType?: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["withPatternType"];
20445
20473
  /** The project the composition(s) belong to */
20446
20474
  projectId: external$5["v1-canvas.swagger.yml"]["components"]["parameters"]["projectId"];
20447
20475
  /**
@@ -20738,6 +20766,11 @@ interface external$5 {
20738
20766
  previewImageUrl?: string;
20739
20767
  /** @description Indicates if the composition is a pattern that can be referenced in other compositions */
20740
20768
  pattern: boolean;
20769
+ /**
20770
+ * @description If the instance is a pattern, this indicates if it's a component pattern or a composition pattern
20771
+ * @enum {string}
20772
+ */
20773
+ patternType?: "component" | "composition";
20741
20774
  /**
20742
20775
  * Format: uuid
20743
20776
  * @description The release this composition belongs to. If not set, it belongs to the base
@@ -20879,6 +20912,11 @@ interface external$5 {
20879
20912
  * * `composition` - Returns only composition patterns
20880
20913
  */
20881
20914
  patternType: "all" | "component" | "composition";
20915
+ /**
20916
+ * @deprecated
20917
+ * @description Includes the `patternType` attribute in the response
20918
+ */
20919
+ withPatternType: boolean;
20882
20920
  /**
20883
20921
  * @description Sets the sorting of the results. If unspecified, results are sorted by name ascending.
20884
20922
  * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC,
@@ -21666,7 +21704,7 @@ type DataResolutionParameters = {
21666
21704
  * Controls how many levels deep content references should be resolved.
21667
21705
  */
21668
21706
  resolutionDepth?: number;
21669
- isDraft?: boolean;
21707
+ includeUnpublishedData?: boolean;
21670
21708
  };
21671
21709
  /** Types of issue that can occur when fetching composition data */
21672
21710
  type DataResolutionIssue = PatternIssue | DataResourceIssue | MaxDepthExceededIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
@@ -22944,7 +22982,7 @@ interface external$3 {
22944
22982
  */
22945
22983
  optionalPatternParameter?: boolean;
22946
22984
  /** @description Resolve this data resource with draft mode content. TBD */
22947
- isDraft?: boolean;
22985
+ includeUnpublishedData?: boolean;
22948
22986
  variables?: external$3["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
22949
22987
  };
22950
22988
  /** @description Variable values for a data resource */
@@ -24466,7 +24504,7 @@ interface external$1 {
24466
24504
  */
24467
24505
  optionalPatternParameter?: boolean;
24468
24506
  /** @description Resolve this data resource with draft mode content. TBD */
24469
- isDraft?: boolean;
24507
+ includeUnpublishedData?: boolean;
24470
24508
  variables?: external$1["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
24471
24509
  };
24472
24510
  /** @description Variable values for a data resource */
@@ -25174,7 +25212,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
25174
25212
  isPatternParameter?: boolean | undefined;
25175
25213
  ignorePatternParameterDefault?: boolean | undefined;
25176
25214
  optionalPatternParameter?: boolean | undefined;
25177
- isDraft?: boolean | undefined;
25215
+ includeUnpublishedData?: boolean | undefined;
25178
25216
  variables?: {
25179
25217
  [key: string]: string;
25180
25218
  } | undefined;
@@ -25186,7 +25224,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
25186
25224
  isPatternParameter?: boolean | undefined;
25187
25225
  ignorePatternParameterDefault?: boolean | undefined;
25188
25226
  optionalPatternParameter?: boolean | undefined;
25189
- isDraft?: boolean | undefined;
25227
+ includeUnpublishedData?: boolean | undefined;
25190
25228
  variables?: {
25191
25229
  [key: string]: string;
25192
25230
  } | undefined;
@@ -26404,7 +26442,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
26404
26442
  isPatternParameter?: boolean | undefined;
26405
26443
  ignorePatternParameterDefault?: boolean | undefined;
26406
26444
  optionalPatternParameter?: boolean | undefined;
26407
- isDraft?: boolean | undefined;
26445
+ includeUnpublishedData?: boolean | undefined;
26408
26446
  variables?: {
26409
26447
  [key: string]: string;
26410
26448
  } | undefined;
@@ -26416,7 +26454,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
26416
26454
  isPatternParameter?: boolean | undefined;
26417
26455
  ignorePatternParameterDefault?: boolean | undefined;
26418
26456
  optionalPatternParameter?: boolean | undefined;
26419
- isDraft?: boolean | undefined;
26457
+ includeUnpublishedData?: boolean | undefined;
26420
26458
  variables?: {
26421
26459
  [key: string]: string;
26422
26460
  } | undefined;
@@ -26471,7 +26509,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
26471
26509
  isPatternParameter?: boolean | undefined;
26472
26510
  ignorePatternParameterDefault?: boolean | undefined;
26473
26511
  optionalPatternParameter?: boolean | undefined;
26474
- isDraft?: boolean | undefined;
26512
+ includeUnpublishedData?: boolean | undefined;
26475
26513
  variables?: {
26476
26514
  [key: string]: string;
26477
26515
  } | undefined;
@@ -26483,7 +26521,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
26483
26521
  isPatternParameter?: boolean | undefined;
26484
26522
  ignorePatternParameterDefault?: boolean | undefined;
26485
26523
  optionalPatternParameter?: boolean | undefined;
26486
- isDraft?: boolean | undefined;
26524
+ includeUnpublishedData?: boolean | undefined;
26487
26525
  variables?: {
26488
26526
  [key: string]: string;
26489
26527
  } | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "19.175.1-alpha.38+ca3abeec93",
3
+ "version": "19.175.1-alpha.41+ed05e78371",
4
4
  "description": "Common functionality and types for Uniform Canvas",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -38,8 +38,8 @@
38
38
  "pusher-js": "8.2.0"
39
39
  },
40
40
  "dependencies": {
41
- "@uniformdev/assets": "19.175.1-alpha.38+ca3abeec93",
42
- "@uniformdev/context": "19.175.1-alpha.38+ca3abeec93",
41
+ "@uniformdev/assets": "19.175.1-alpha.41+ed05e78371",
42
+ "@uniformdev/context": "19.175.1-alpha.41+ed05e78371",
43
43
  "immer": "10.1.1"
44
44
  },
45
45
  "files": [
@@ -48,5 +48,5 @@
48
48
  "publishConfig": {
49
49
  "access": "public"
50
50
  },
51
- "gitHead": "ca3abeec93f47369bac47716c568b46d8de6420a"
51
+ "gitHead": "ed05e78371bf8cebba36bf0f9814717dcf57e5b2"
52
52
  }