@uniformdev/project-map 19.158.0 → 19.159.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.
Files changed (3) hide show
  1. package/dist/index.d.mts +25 -25
  2. package/dist/index.d.ts +25 -25
  3. package/package.json +4 -4
package/dist/index.d.mts CHANGED
@@ -97,7 +97,7 @@ interface paths$1 {
97
97
  };
98
98
  };
99
99
  };
100
- /** Handles preflight requests. This endpoint allows CORS. */
100
+ /** Handles preflight requests. This endpoint allows CORS */
101
101
  options: {
102
102
  responses: {
103
103
  /** OK */
@@ -186,12 +186,12 @@ interface paths {
186
186
  * - When unspecified, composition data is fetched from base.
187
187
  * - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
188
188
  *
189
- * 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 not be defined.
189
+ * 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 not be defined
190
190
  */
191
191
  releaseId?: string;
192
- /** The id of the node to retrieve, cannot have both this parameter and Path */
192
+ /** The id of the node to retrieve, cannot have both this parameter and `path` */
193
193
  id?: string;
194
- /** The path of the root node to retrieve, cannot have both this parameter and Id */
194
+ /** The path of the root node to retrieve, cannot have both this parameter and `id` */
195
195
  path?: string;
196
196
  /** Composition id to find associated sitemap nodes for */
197
197
  compositionId?: string;
@@ -199,9 +199,9 @@ interface paths {
199
199
  limit?: number;
200
200
  /** Number of records to skip before returning nodes */
201
201
  offset?: number;
202
- /** Depth of the tree to fetch. Only applies when fetching by path. */
202
+ /** Depth of the tree to fetch. This only applies when fetching by path */
203
203
  depth?: number;
204
- /** State of compositions to fetch. 0 = draft, 64 = published. */
204
+ /** State of compositions to fetch. 0 = draft, 64 = published */
205
205
  state?: number;
206
206
  /** should the data be returned as a json tree object (or a flat array) */
207
207
  tree?: boolean;
@@ -209,19 +209,19 @@ interface paths {
209
209
  search?: string;
210
210
  /**
211
211
  * Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
212
- * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated.
212
+ * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
213
213
  */
214
214
  includeAncestors?: boolean;
215
- /** include expanded helper computed properties, includes isLeaf, parentPath, pathSegment */
215
+ /** include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
216
216
  expanded?: boolean;
217
- /** include basic composition information. ID, type, state, name, and definition id. */
217
+ /** include basic composition information. ID, type, state, name, and definition id */
218
218
  withCompositionData?: boolean;
219
219
  /**
220
220
  * @deprecated Returns the UI status string of the composition.
221
- * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
221
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
222
222
  */
223
223
  withCompositionUIStatus?: boolean;
224
- /** Include basic redirect information. */
224
+ /** Include basic redirect information */
225
225
  withRedirectData?: boolean;
226
226
  };
227
227
  };
@@ -331,7 +331,7 @@ interface paths {
331
331
  };
332
332
  };
333
333
  };
334
- /** Handles preflight requests. This endpoint allows CORS. */
334
+ /** Handles preflight requests. This endpoint allows CORS */
335
335
  options: {
336
336
  responses: {
337
337
  /** OK */
@@ -350,7 +350,7 @@ interface components {
350
350
  id: string;
351
351
  /** @description Path representing the path to the current node */
352
352
  path: string;
353
- /** @description Ordering of the node, higher numbers go after lower numbers. */
353
+ /** @description Ordering of the node, higher numbers go after lower numbers */
354
354
  order?: number;
355
355
  data?: components["schemas"]["ProjectMapNodeData"];
356
356
  /** @description The name of the projectMap entry */
@@ -388,13 +388,13 @@ interface components {
388
388
  /** @description Last segment of the url in this locale */
389
389
  pathSegment: string;
390
390
  /**
391
- * @description When false, the node explicitly defines a locale specific path segment.
391
+ * @description When false, the node explicitly defines a locale-specific path segment.
392
392
  *
393
- * When true, an ancestor defines a locale specific path segment,
393
+ * When true, an ancestor defines a locale-specific path segment,
394
394
  * which makes its descendants resolvable using that segment.
395
- * This node does not define a locale specific path segment.
395
+ * This node does not define a locale-specific path segment.
396
396
  *
397
- * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response.
397
+ * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
398
398
  */
399
399
  inherited?: boolean;
400
400
  };
@@ -412,22 +412,22 @@ interface components {
412
412
  */
413
413
  id?: string;
414
414
  }[];
415
- /** @description Basic information about a composition from the context of a project map node. */
415
+ /** @description Basic information about a composition from the context of a project map node */
416
416
  ProjectMapNodeCompositionData: {
417
417
  /** @description Type of the composition instance (public_id of its definition) */
418
418
  type: string;
419
419
  /**
420
420
  * Format: uuid
421
- * @description The public UUID of the composition.
421
+ * @description The public UUID of the composition
422
422
  */
423
423
  id: string;
424
- /** @description Slug pattern of this composition. */
424
+ /** @description Slug pattern of this composition */
425
425
  slug?: string | null;
426
- /** @description Friendly name of this composition. */
426
+ /** @description Friendly name of this composition */
427
427
  name: string;
428
428
  /**
429
429
  * @deprecated
430
- * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true.
430
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
431
431
  * @enum {string}
432
432
  */
433
433
  uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
@@ -438,7 +438,7 @@ interface components {
438
438
  icon?: string;
439
439
  /** @description Friendly name of this Composition's Definition */
440
440
  typeName?: string;
441
- /** @description List of locales that the composition is available in. If empty, available in all locales. */
441
+ /** @description List of locales that the composition is available in. If empty, available in all locales */
442
442
  locales: string[];
443
443
  };
444
444
  ProjectMapNodeUpdate: {
@@ -449,7 +449,7 @@ interface components {
449
449
  id?: string;
450
450
  /** @description Path representing the path to the current node */
451
451
  path: string;
452
- /** @description Ordering of the node, higher numbers go after lower numbers. */
452
+ /** @description Ordering of the node, higher numbers go after lower numbers */
453
453
  order?: number;
454
454
  data?: components["schemas"]["ProjectMapNodeData"];
455
455
  /** @description The name of the projectMap entry */
@@ -484,7 +484,7 @@ interface components {
484
484
  /**
485
485
  * @description For dynamic nodes, this is the preview value for the dynamic value.
486
486
  * The preview value is used when editing a connected composition, and is the default
487
- * dynamic node value unless the author has explicitly chosen a different value.
487
+ * dynamic node value unless the author has explicitly chosen a different value
488
488
  */
489
489
  previewValue?: string;
490
490
  };
package/dist/index.d.ts CHANGED
@@ -97,7 +97,7 @@ interface paths$1 {
97
97
  };
98
98
  };
99
99
  };
100
- /** Handles preflight requests. This endpoint allows CORS. */
100
+ /** Handles preflight requests. This endpoint allows CORS */
101
101
  options: {
102
102
  responses: {
103
103
  /** OK */
@@ -186,12 +186,12 @@ interface paths {
186
186
  * - When unspecified, composition data is fetched from base.
187
187
  * - When specified, all content is returned as it would appear in the release if it was released now. This includes both content copied to the release and changed, as well as content that is not part of the release.
188
188
  *
189
- * 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 not be defined.
189
+ * 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 not be defined
190
190
  */
191
191
  releaseId?: string;
192
- /** The id of the node to retrieve, cannot have both this parameter and Path */
192
+ /** The id of the node to retrieve, cannot have both this parameter and `path` */
193
193
  id?: string;
194
- /** The path of the root node to retrieve, cannot have both this parameter and Id */
194
+ /** The path of the root node to retrieve, cannot have both this parameter and `id` */
195
195
  path?: string;
196
196
  /** Composition id to find associated sitemap nodes for */
197
197
  compositionId?: string;
@@ -199,9 +199,9 @@ interface paths {
199
199
  limit?: number;
200
200
  /** Number of records to skip before returning nodes */
201
201
  offset?: number;
202
- /** Depth of the tree to fetch. Only applies when fetching by path. */
202
+ /** Depth of the tree to fetch. This only applies when fetching by path */
203
203
  depth?: number;
204
- /** State of compositions to fetch. 0 = draft, 64 = published. */
204
+ /** State of compositions to fetch. 0 = draft, 64 = published */
205
205
  state?: number;
206
206
  /** should the data be returned as a json tree object (or a flat array) */
207
207
  tree?: boolean;
@@ -209,19 +209,19 @@ interface paths {
209
209
  search?: string;
210
210
  /**
211
211
  * Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
212
- * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated.
212
+ * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
213
213
  */
214
214
  includeAncestors?: boolean;
215
- /** include expanded helper computed properties, includes isLeaf, parentPath, pathSegment */
215
+ /** include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
216
216
  expanded?: boolean;
217
- /** include basic composition information. ID, type, state, name, and definition id. */
217
+ /** include basic composition information. ID, type, state, name, and definition id */
218
218
  withCompositionData?: boolean;
219
219
  /**
220
220
  * @deprecated Returns the UI status string of the composition.
221
- * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
221
+ * This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
222
222
  */
223
223
  withCompositionUIStatus?: boolean;
224
- /** Include basic redirect information. */
224
+ /** Include basic redirect information */
225
225
  withRedirectData?: boolean;
226
226
  };
227
227
  };
@@ -331,7 +331,7 @@ interface paths {
331
331
  };
332
332
  };
333
333
  };
334
- /** Handles preflight requests. This endpoint allows CORS. */
334
+ /** Handles preflight requests. This endpoint allows CORS */
335
335
  options: {
336
336
  responses: {
337
337
  /** OK */
@@ -350,7 +350,7 @@ interface components {
350
350
  id: string;
351
351
  /** @description Path representing the path to the current node */
352
352
  path: string;
353
- /** @description Ordering of the node, higher numbers go after lower numbers. */
353
+ /** @description Ordering of the node, higher numbers go after lower numbers */
354
354
  order?: number;
355
355
  data?: components["schemas"]["ProjectMapNodeData"];
356
356
  /** @description The name of the projectMap entry */
@@ -388,13 +388,13 @@ interface components {
388
388
  /** @description Last segment of the url in this locale */
389
389
  pathSegment: string;
390
390
  /**
391
- * @description When false, the node explicitly defines a locale specific path segment.
391
+ * @description When false, the node explicitly defines a locale-specific path segment.
392
392
  *
393
- * When true, an ancestor defines a locale specific path segment,
393
+ * When true, an ancestor defines a locale-specific path segment,
394
394
  * which makes its descendants resolvable using that segment.
395
- * This node does not define a locale specific path segment.
395
+ * This node does not define a locale-specific path segment.
396
396
  *
397
- * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response.
397
+ * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
398
398
  */
399
399
  inherited?: boolean;
400
400
  };
@@ -412,22 +412,22 @@ interface components {
412
412
  */
413
413
  id?: string;
414
414
  }[];
415
- /** @description Basic information about a composition from the context of a project map node. */
415
+ /** @description Basic information about a composition from the context of a project map node */
416
416
  ProjectMapNodeCompositionData: {
417
417
  /** @description Type of the composition instance (public_id of its definition) */
418
418
  type: string;
419
419
  /**
420
420
  * Format: uuid
421
- * @description The public UUID of the composition.
421
+ * @description The public UUID of the composition
422
422
  */
423
423
  id: string;
424
- /** @description Slug pattern of this composition. */
424
+ /** @description Slug pattern of this composition */
425
425
  slug?: string | null;
426
- /** @description Friendly name of this composition. */
426
+ /** @description Friendly name of this composition */
427
427
  name: string;
428
428
  /**
429
429
  * @deprecated
430
- * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true.
430
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withCompositionUIStatus` option is true
431
431
  * @enum {string}
432
432
  */
433
433
  uiStatus?: "Draft" | "Modified" | "Published" | "Orphan";
@@ -438,7 +438,7 @@ interface components {
438
438
  icon?: string;
439
439
  /** @description Friendly name of this Composition's Definition */
440
440
  typeName?: string;
441
- /** @description List of locales that the composition is available in. If empty, available in all locales. */
441
+ /** @description List of locales that the composition is available in. If empty, available in all locales */
442
442
  locales: string[];
443
443
  };
444
444
  ProjectMapNodeUpdate: {
@@ -449,7 +449,7 @@ interface components {
449
449
  id?: string;
450
450
  /** @description Path representing the path to the current node */
451
451
  path: string;
452
- /** @description Ordering of the node, higher numbers go after lower numbers. */
452
+ /** @description Ordering of the node, higher numbers go after lower numbers */
453
453
  order?: number;
454
454
  data?: components["schemas"]["ProjectMapNodeData"];
455
455
  /** @description The name of the projectMap entry */
@@ -484,7 +484,7 @@ interface components {
484
484
  /**
485
485
  * @description For dynamic nodes, this is the preview value for the dynamic value.
486
486
  * The preview value is used when editing a connected composition, and is the default
487
- * dynamic node value unless the author has explicitly chosen a different value.
487
+ * dynamic node value unless the author has explicitly chosen a different value
488
488
  */
489
489
  previewValue?: string;
490
490
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/project-map",
3
- "version": "19.158.0",
3
+ "version": "19.159.0",
4
4
  "description": "Uniform Project Map",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -33,11 +33,11 @@
33
33
  "/dist"
34
34
  ],
35
35
  "dependencies": {
36
- "@uniformdev/canvas": "19.158.0",
37
- "@uniformdev/context": "19.158.0"
36
+ "@uniformdev/canvas": "19.159.0",
37
+ "@uniformdev/context": "19.159.0"
38
38
  },
39
39
  "publishConfig": {
40
40
  "access": "public"
41
41
  },
42
- "gitHead": "f0be15ed3518c8d3d02e320d9b9a2f5175d30d1b"
42
+ "gitHead": "49ed8744113d885f24c96d819a6e1dd1896b6ce0"
43
43
  }