@uniformdev/canvas 20.84.0 → 20.86.0

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.
package/dist/index.d.mts CHANGED
@@ -2234,6 +2234,12 @@ interface components$p {
2234
2234
  * The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
2235
2235
  */
2236
2236
  workflowStageId?: string;
2237
+ /**
2238
+ * Format: uuid
2239
+ * The workflow that entries created from this pattern start in. This is not the workflow
2240
+ * the pattern itself is in, which is `workflowId`. Only ever set on entry patterns.
2241
+ */
2242
+ instanceWorkflowId?: string;
2237
2243
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
2238
2244
  workflowDefinition?: components$p["schemas"]["WorkflowDefinition"];
2239
2245
  /**
@@ -3537,6 +3543,15 @@ interface paths$l {
3537
3543
  * The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
3538
3544
  */
3539
3545
  workflowStageId?: string;
3546
+ /**
3547
+ * Format: uuid
3548
+ * The workflow that entries created from this pattern start in. This is not the
3549
+ * workflow the pattern itself is in, which comes from its content type.
3550
+ * When null, creation falls back to the content type's workflow.
3551
+ * Entry patterns only; sending it on anything else is a 400.
3552
+ * @defaultValue null
3553
+ */
3554
+ instanceWorkflowId?: string | null;
3540
3555
  /**
3541
3556
  * Format: uuid
3542
3557
  * The edition ID. When set, this is a child edition of the entry in _id.
@@ -4162,6 +4177,12 @@ interface components$n {
4162
4177
  * The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
4163
4178
  */
4164
4179
  workflowStageId?: string;
4180
+ /**
4181
+ * Format: uuid
4182
+ * The workflow that entries created from this pattern start in. This is not the workflow
4183
+ * the pattern itself is in, which is `workflowId`. Only ever set on entry patterns.
4184
+ */
4185
+ instanceWorkflowId?: string;
4165
4186
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
4166
4187
  workflowDefinition?: components$n["schemas"]["WorkflowDefinition"];
4167
4188
  /**
@@ -7045,6 +7066,12 @@ interface components$e {
7045
7066
  * The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
7046
7067
  */
7047
7068
  workflowStageId?: string;
7069
+ /**
7070
+ * Format: uuid
7071
+ * The workflow that compositions created from this pattern start in. This is not the
7072
+ * workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
7073
+ */
7074
+ instanceWorkflowId?: string;
7048
7075
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
7049
7076
  workflowDefinition?: components$e["schemas"]["WorkflowDefinition"];
7050
7077
  /**
@@ -7630,6 +7657,15 @@ interface paths$c {
7630
7657
  * The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
7631
7658
  */
7632
7659
  workflowStageId?: string;
7660
+ /**
7661
+ * Format: uuid
7662
+ * The workflow that compositions created from this pattern start in. This is not the
7663
+ * workflow the pattern itself is in, which comes from its component definition.
7664
+ * When null, creation falls back to the component definition's workflow.
7665
+ * Composition patterns only; sending it on anything else is a 400.
7666
+ * @defaultValue null
7667
+ */
7668
+ instanceWorkflowId?: string | null;
7633
7669
  /**
7634
7670
  * Format: uuid
7635
7671
  * The edition ID. When set, this is a child edition of the composition in _id.
@@ -7820,6 +7856,12 @@ interface components$d {
7820
7856
  * The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
7821
7857
  */
7822
7858
  workflowStageId?: string;
7859
+ /**
7860
+ * Format: uuid
7861
+ * The workflow that compositions created from this pattern start in. This is not the
7862
+ * workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
7863
+ */
7864
+ instanceWorkflowId?: string;
7823
7865
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
7824
7866
  workflowDefinition?: components$d["schemas"]["WorkflowDefinition"];
7825
7867
  /**
@@ -9579,6 +9621,12 @@ interface components$b {
9579
9621
  * The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
9580
9622
  */
9581
9623
  workflowStageId?: string;
9624
+ /**
9625
+ * Format: uuid
9626
+ * The workflow that compositions created from this pattern start in. This is not the
9627
+ * workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
9628
+ */
9629
+ instanceWorkflowId?: string;
9582
9630
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
9583
9631
  workflowDefinition?: components$b["schemas"]["WorkflowDefinition"];
9584
9632
  /**
@@ -9794,6 +9842,12 @@ interface components$b {
9794
9842
  * The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
9795
9843
  */
9796
9844
  workflowStageId?: string;
9845
+ /**
9846
+ * Format: uuid
9847
+ * The workflow that entries created from this pattern start in. This is not the workflow
9848
+ * the pattern itself is in, which is `workflowId`. Only ever set on entry patterns.
9849
+ */
9850
+ instanceWorkflowId?: string;
9797
9851
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
9798
9852
  workflowDefinition?: components$b["schemas"]["WorkflowDefinition"];
9799
9853
  /**
@@ -11063,6 +11117,12 @@ interface components$a {
11063
11117
  * The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
11064
11118
  */
11065
11119
  workflowStageId?: string;
11120
+ /**
11121
+ * Format: uuid
11122
+ * The workflow that compositions created from this pattern start in. This is not the
11123
+ * workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
11124
+ */
11125
+ instanceWorkflowId?: string;
11066
11126
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
11067
11127
  workflowDefinition?: components$a["schemas"]["WorkflowDefinition"];
11068
11128
  /**
@@ -12500,6 +12560,8 @@ interface paths$7 {
12500
12560
  icon: string;
12501
12561
  /** Width in pixels */
12502
12562
  width: number;
12563
+ /** Present and true only on the default viewport, which the editor opens the preview at when the editor has not picked one. At most one viewport per project is the default. */
12564
+ isDefault?: boolean;
12503
12565
  }[];
12504
12566
  };
12505
12567
  };
@@ -12535,6 +12597,8 @@ interface paths$7 {
12535
12597
  icon: string;
12536
12598
  /** Width in pixels */
12537
12599
  width: number;
12600
+ /** Makes this the default viewport and clears the flag on the other viewports of the project. When omitted, the viewport is not the default. */
12601
+ isDefault?: boolean;
12538
12602
  };
12539
12603
  };
12540
12604
  };
@@ -12571,6 +12635,13 @@ interface paths$7 {
12571
12635
  };
12572
12636
  content?: never;
12573
12637
  };
12638
+ /** Conflict: a concurrent request made another viewport the default. Reload the viewports and retry. */
12639
+ 409: {
12640
+ headers: {
12641
+ [name: string]: unknown;
12642
+ };
12643
+ content?: never;
12644
+ };
12574
12645
  429: components$7["responses"]["RateLimitError"];
12575
12646
  500: components$7["responses"]["InternalServerError"];
12576
12647
  };
@@ -15009,6 +15080,7 @@ declare class PreviewClient extends ApiClient {
15009
15080
  name: string;
15010
15081
  icon: string;
15011
15082
  width: number;
15083
+ isDefault?: boolean;
15012
15084
  }>;
15013
15085
  /** Fetches all preview viewports for a project */
15014
15086
  getPreviewViewports(options?: ExceptProject<PreviewViewportsGetParameters>): Promise<{
@@ -15017,6 +15089,7 @@ declare class PreviewClient extends ApiClient {
15017
15089
  name: string;
15018
15090
  icon: string;
15019
15091
  width: number;
15092
+ isDefault?: boolean;
15020
15093
  }[];
15021
15094
  }>;
15022
15095
  /** Creates or updates a preview viewport */
@@ -16138,7 +16211,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
16138
16211
  */
16139
16212
  declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable', offset: number) => void | false): number;
16140
16213
 
16141
- declare const version = "20.84.0";
16214
+ declare const version = "20.86.0";
16142
16215
 
16143
16216
  /** API client to enable managing workflow definitions */
16144
16217
  declare class WorkflowClient extends ApiClient {
package/dist/index.d.ts CHANGED
@@ -2234,6 +2234,12 @@ interface components$p {
2234
2234
  * The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
2235
2235
  */
2236
2236
  workflowStageId?: string;
2237
+ /**
2238
+ * Format: uuid
2239
+ * The workflow that entries created from this pattern start in. This is not the workflow
2240
+ * the pattern itself is in, which is `workflowId`. Only ever set on entry patterns.
2241
+ */
2242
+ instanceWorkflowId?: string;
2237
2243
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
2238
2244
  workflowDefinition?: components$p["schemas"]["WorkflowDefinition"];
2239
2245
  /**
@@ -3537,6 +3543,15 @@ interface paths$l {
3537
3543
  * The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
3538
3544
  */
3539
3545
  workflowStageId?: string;
3546
+ /**
3547
+ * Format: uuid
3548
+ * The workflow that entries created from this pattern start in. This is not the
3549
+ * workflow the pattern itself is in, which comes from its content type.
3550
+ * When null, creation falls back to the content type's workflow.
3551
+ * Entry patterns only; sending it on anything else is a 400.
3552
+ * @defaultValue null
3553
+ */
3554
+ instanceWorkflowId?: string | null;
3540
3555
  /**
3541
3556
  * Format: uuid
3542
3557
  * The edition ID. When set, this is a child edition of the entry in _id.
@@ -4162,6 +4177,12 @@ interface components$n {
4162
4177
  * The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
4163
4178
  */
4164
4179
  workflowStageId?: string;
4180
+ /**
4181
+ * Format: uuid
4182
+ * The workflow that entries created from this pattern start in. This is not the workflow
4183
+ * the pattern itself is in, which is `workflowId`. Only ever set on entry patterns.
4184
+ */
4185
+ instanceWorkflowId?: string;
4165
4186
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
4166
4187
  workflowDefinition?: components$n["schemas"]["WorkflowDefinition"];
4167
4188
  /**
@@ -7045,6 +7066,12 @@ interface components$e {
7045
7066
  * The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
7046
7067
  */
7047
7068
  workflowStageId?: string;
7069
+ /**
7070
+ * Format: uuid
7071
+ * The workflow that compositions created from this pattern start in. This is not the
7072
+ * workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
7073
+ */
7074
+ instanceWorkflowId?: string;
7048
7075
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
7049
7076
  workflowDefinition?: components$e["schemas"]["WorkflowDefinition"];
7050
7077
  /**
@@ -7630,6 +7657,15 @@ interface paths$c {
7630
7657
  * The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
7631
7658
  */
7632
7659
  workflowStageId?: string;
7660
+ /**
7661
+ * Format: uuid
7662
+ * The workflow that compositions created from this pattern start in. This is not the
7663
+ * workflow the pattern itself is in, which comes from its component definition.
7664
+ * When null, creation falls back to the component definition's workflow.
7665
+ * Composition patterns only; sending it on anything else is a 400.
7666
+ * @defaultValue null
7667
+ */
7668
+ instanceWorkflowId?: string | null;
7633
7669
  /**
7634
7670
  * Format: uuid
7635
7671
  * The edition ID. When set, this is a child edition of the composition in _id.
@@ -7820,6 +7856,12 @@ interface components$d {
7820
7856
  * The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
7821
7857
  */
7822
7858
  workflowStageId?: string;
7859
+ /**
7860
+ * Format: uuid
7861
+ * The workflow that compositions created from this pattern start in. This is not the
7862
+ * workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
7863
+ */
7864
+ instanceWorkflowId?: string;
7823
7865
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
7824
7866
  workflowDefinition?: components$d["schemas"]["WorkflowDefinition"];
7825
7867
  /**
@@ -9579,6 +9621,12 @@ interface components$b {
9579
9621
  * The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
9580
9622
  */
9581
9623
  workflowStageId?: string;
9624
+ /**
9625
+ * Format: uuid
9626
+ * The workflow that compositions created from this pattern start in. This is not the
9627
+ * workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
9628
+ */
9629
+ instanceWorkflowId?: string;
9582
9630
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
9583
9631
  workflowDefinition?: components$b["schemas"]["WorkflowDefinition"];
9584
9632
  /**
@@ -9794,6 +9842,12 @@ interface components$b {
9794
9842
  * The stage ID the entry is in on its assigned workflow. When undefined, it is implicitly in the initial stage of the workflow
9795
9843
  */
9796
9844
  workflowStageId?: string;
9845
+ /**
9846
+ * Format: uuid
9847
+ * The workflow that entries created from this pattern start in. This is not the workflow
9848
+ * the pattern itself is in, which is `workflowId`. Only ever set on entry patterns.
9849
+ */
9850
+ instanceWorkflowId?: string;
9797
9851
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
9798
9852
  workflowDefinition?: components$b["schemas"]["WorkflowDefinition"];
9799
9853
  /**
@@ -11063,6 +11117,12 @@ interface components$a {
11063
11117
  * The stage ID the composition is in within its assigned workflow. If undefined, it is implicitly in the initial stage of the workflow
11064
11118
  */
11065
11119
  workflowStageId?: string;
11120
+ /**
11121
+ * Format: uuid
11122
+ * The workflow that compositions created from this pattern start in. This is not the
11123
+ * workflow the pattern itself is in, which is `workflowId`. Only ever set on composition patterns.
11124
+ */
11125
+ instanceWorkflowId?: string;
11066
11126
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Returned only when `withWorkflowDefinition` is true */
11067
11127
  workflowDefinition?: components$a["schemas"]["WorkflowDefinition"];
11068
11128
  /**
@@ -12500,6 +12560,8 @@ interface paths$7 {
12500
12560
  icon: string;
12501
12561
  /** Width in pixels */
12502
12562
  width: number;
12563
+ /** Present and true only on the default viewport, which the editor opens the preview at when the editor has not picked one. At most one viewport per project is the default. */
12564
+ isDefault?: boolean;
12503
12565
  }[];
12504
12566
  };
12505
12567
  };
@@ -12535,6 +12597,8 @@ interface paths$7 {
12535
12597
  icon: string;
12536
12598
  /** Width in pixels */
12537
12599
  width: number;
12600
+ /** Makes this the default viewport and clears the flag on the other viewports of the project. When omitted, the viewport is not the default. */
12601
+ isDefault?: boolean;
12538
12602
  };
12539
12603
  };
12540
12604
  };
@@ -12571,6 +12635,13 @@ interface paths$7 {
12571
12635
  };
12572
12636
  content?: never;
12573
12637
  };
12638
+ /** Conflict: a concurrent request made another viewport the default. Reload the viewports and retry. */
12639
+ 409: {
12640
+ headers: {
12641
+ [name: string]: unknown;
12642
+ };
12643
+ content?: never;
12644
+ };
12574
12645
  429: components$7["responses"]["RateLimitError"];
12575
12646
  500: components$7["responses"]["InternalServerError"];
12576
12647
  };
@@ -15009,6 +15080,7 @@ declare class PreviewClient extends ApiClient {
15009
15080
  name: string;
15010
15081
  icon: string;
15011
15082
  width: number;
15083
+ isDefault?: boolean;
15012
15084
  }>;
15013
15085
  /** Fetches all preview viewports for a project */
15014
15086
  getPreviewViewports(options?: ExceptProject<PreviewViewportsGetParameters>): Promise<{
@@ -15017,6 +15089,7 @@ declare class PreviewClient extends ApiClient {
15017
15089
  name: string;
15018
15090
  icon: string;
15019
15091
  width: number;
15092
+ isDefault?: boolean;
15020
15093
  }[];
15021
15094
  }>;
15022
15095
  /** Creates or updates a preview viewport */
@@ -16138,7 +16211,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
16138
16211
  */
16139
16212
  declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable', offset: number) => void | false): number;
16140
16213
 
16141
- declare const version = "20.84.0";
16214
+ declare const version = "20.86.0";
16142
16215
 
16143
16216
  /** API client to enable managing workflow definitions */
16144
16217
  declare class WorkflowClient extends ApiClient {
package/dist/index.esm.js CHANGED
@@ -3759,6 +3759,7 @@ function convertEntryToPutEntry(entry) {
3759
3759
  releaseId: entry.releaseId,
3760
3760
  workflowId: entry.workflowId,
3761
3761
  workflowStageId: entry.workflowStageId,
3762
+ instanceWorkflowId: entry.instanceWorkflowId,
3762
3763
  editionId: entry.editionId,
3763
3764
  editionName: entry.editionName,
3764
3765
  editionPriority: entry.editionPriority
@@ -4062,7 +4063,7 @@ function handleRichTextNodeBinding(object, options) {
4062
4063
  import { ApiClientError as ApiClientError5 } from "@uniformdev/context/api";
4063
4064
 
4064
4065
  // src/.version.ts
4065
- var version = "20.84.0";
4066
+ var version = "20.86.0";
4066
4067
 
4067
4068
  // src/WorkflowClient.ts
4068
4069
  import { ApiClient as ApiClient18 } from "@uniformdev/context/api";
package/dist/index.js CHANGED
@@ -3974,6 +3974,7 @@ function convertEntryToPutEntry(entry) {
3974
3974
  releaseId: entry.releaseId,
3975
3975
  workflowId: entry.workflowId,
3976
3976
  workflowStageId: entry.workflowStageId,
3977
+ instanceWorkflowId: entry.instanceWorkflowId,
3977
3978
  editionId: entry.editionId,
3978
3979
  editionName: entry.editionName,
3979
3980
  editionPriority: entry.editionPriority
@@ -4277,7 +4278,7 @@ function handleRichTextNodeBinding(object, options) {
4277
4278
  var import_api27 = require("@uniformdev/context/api");
4278
4279
 
4279
4280
  // src/.version.ts
4280
- var version = "20.84.0";
4281
+ var version = "20.86.0";
4281
4282
 
4282
4283
  // src/WorkflowClient.ts
4283
4284
  var import_api26 = require("@uniformdev/context/api");
package/dist/index.mjs CHANGED
@@ -3759,6 +3759,7 @@ function convertEntryToPutEntry(entry) {
3759
3759
  releaseId: entry.releaseId,
3760
3760
  workflowId: entry.workflowId,
3761
3761
  workflowStageId: entry.workflowStageId,
3762
+ instanceWorkflowId: entry.instanceWorkflowId,
3762
3763
  editionId: entry.editionId,
3763
3764
  editionName: entry.editionName,
3764
3765
  editionPriority: entry.editionPriority
@@ -4062,7 +4063,7 @@ function handleRichTextNodeBinding(object, options) {
4062
4063
  import { ApiClientError as ApiClientError5 } from "@uniformdev/context/api";
4063
4064
 
4064
4065
  // src/.version.ts
4065
- var version = "20.84.0";
4066
+ var version = "20.86.0";
4066
4067
 
4067
4068
  // src/WorkflowClient.ts
4068
4069
  import { ApiClient as ApiClient18 } from "@uniformdev/context/api";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "20.84.0",
3
+ "version": "20.86.0",
4
4
  "description": "Common functionality and types for Uniform Canvas",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -36,9 +36,9 @@
36
36
  "svix": "1.96.0"
37
37
  },
38
38
  "dependencies": {
39
- "@uniformdev/assets": "20.84.0",
40
- "@uniformdev/context": "20.84.0",
41
- "@uniformdev/richtext": "20.84.0",
39
+ "@uniformdev/assets": "20.86.0",
40
+ "@uniformdev/context": "20.86.0",
41
+ "@uniformdev/richtext": "20.86.0",
42
42
  "immer": "10.2.0",
43
43
  "p-limit": "6.2.0",
44
44
  "p-retry": "6.2.1",
@@ -50,5 +50,5 @@
50
50
  "publishConfig": {
51
51
  "access": "public"
52
52
  },
53
- "gitHead": "aed567f635f70f4ba169010c0a1bcaebfe23d0f9"
53
+ "gitHead": "f0e4c0eb0eac24eb1e38a5bd536832f0261b003b"
54
54
  }