@uniformdev/project-map 20.70.0 → 20.70.1-alpha.10

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 (4) hide show
  1. package/dist/index.d.mts +36 -29
  2. package/dist/index.d.ts +36 -29
  3. package/dist/index.js +3 -3
  4. package/package.json +4 -4
package/dist/index.d.mts CHANGED
@@ -294,14 +294,15 @@ interface components$1 {
294
294
  path?: string;
295
295
  /** @description Last segment of the url in this locale */
296
296
  pathSegment: string;
297
- /** @description When false, the node explicitly defines a locale-specific path segment.
297
+ /**
298
+ * @description When false, the node explicitly defines a locale-specific path segment.
298
299
  *
299
300
  * When true, an ancestor defines a locale-specific path segment,
300
301
  * which makes its descendants resolvable using that segment.
301
302
  * This node does not define a locale-specific path segment.
302
303
  *
303
304
  * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
304
- * */
305
+ */
305
306
  inherited?: boolean;
306
307
  };
307
308
  ProjectMapSourceRedirectData: {
@@ -318,9 +319,10 @@ interface components$1 {
318
319
  */
319
320
  id?: string;
320
321
  }[];
321
- /** @description Basic information about the linked composition from the context of a project map node.
322
+ /**
323
+ * @description Basic information about the linked composition from the context of a project map node.
322
324
  * If the linked composition has editions, the editions are included in the `editions` property.
323
- * */
325
+ */
324
326
  ProjectMapNodeCompositionData: {
325
327
  /** @description Type of the linked composition (id of its definition) */
326
328
  type: string;
@@ -333,7 +335,6 @@ interface components$1 {
333
335
  * Format: uuid
334
336
  * @description The edition UUID underneath the linked composition
335
337
  * This is only present if the composition has not been published, but an edition has
336
- *
337
338
  */
338
339
  editionId?: string;
339
340
  /** @description Slug pattern of the linked composition or edition */
@@ -353,24 +354,25 @@ interface components$1 {
353
354
  icon?: string;
354
355
  /** @description Friendly name of this Composition's Definition */
355
356
  typeName?: string;
356
- /** @description List of locales that the composition _or any of its editions_ is available in.
357
+ /**
358
+ * @description List of locales that the composition _or any of its editions_ is available in.
357
359
  * If empty, available in all locales.
358
- * */
360
+ */
359
361
  locales: string[];
360
362
  /** @description Priority of the composition relative to any editions */
361
363
  editionPriority?: number;
362
364
  /** @description Friendly name of the edition */
363
365
  editionName?: string;
364
- /** @description List of editions available for this composition. The composition is included in the list, it is the edition
366
+ /**
367
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
365
368
  * where the editionID equals the node's compositionID. NOTE: this is not sent if only one edition is available
366
- * */
369
+ */
367
370
  editions?: components$1["schemas"]["ProjectMapNodeCompositionEditionData"][];
368
371
  /**
369
372
  * Format: date-time
370
373
  * @description Date and time the composition was last modified (or created if never modified).
371
374
  * Uses ISO-8859-1 formatting and UTC timezone.
372
375
  * IMPORTANT: if the composition has more than one edition, this is the modified date of the default edition. Each edition has its own modified date in the `editions` array.
373
- *
374
376
  */
375
377
  modified?: string;
376
378
  };
@@ -457,10 +459,11 @@ interface components$1 {
457
459
  isSearchHit?: boolean;
458
460
  /** @description Query strings that are allowed to be passed to the node */
459
461
  queryStrings?: components$1["schemas"]["ProjectMapNodeAllowedQueryString"][];
460
- /** @description For dynamic nodes, this is the preview value for the dynamic value.
462
+ /**
463
+ * @description For dynamic nodes, this is the preview value for the dynamic value.
461
464
  * The preview value is used when editing a connected composition, and is the default
462
465
  * dynamic node value unless the author has explicitly chosen a different value
463
- * */
466
+ */
464
467
  previewValue?: string;
465
468
  };
466
469
  ProjectMapNodeAllowedQueryString: {
@@ -509,13 +512,14 @@ interface paths {
509
512
  projectMapId?: string;
510
513
  /** @description The project id that contains the project map tree that this node belongs to */
511
514
  projectId: string;
512
- /** @description The ID of a release to fetch the composition data for.
515
+ /**
516
+ * @description The ID of a release to fetch the composition data for.
513
517
  *
514
518
  * - When unspecified, composition data is fetched from base.
515
519
  * - 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.
516
520
  *
517
521
  * 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
518
- * */
522
+ */
519
523
  releaseId?: string;
520
524
  /** @description The id of the node to retrieve, cannot have both this parameter and `path` */
521
525
  id?: string;
@@ -535,9 +539,10 @@ interface paths {
535
539
  tree?: boolean;
536
540
  /** @description text search filter */
537
541
  search?: string;
538
- /** @description Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
542
+ /**
543
+ * @description Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
539
544
  * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
540
- * */
545
+ */
541
546
  includeAncestors?: boolean;
542
547
  /** @description include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
543
548
  expanded?: boolean;
@@ -547,7 +552,6 @@ interface paths {
547
552
  * @deprecated
548
553
  * @description Returns the UI status string of the composition.
549
554
  * This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
550
- *
551
555
  */
552
556
  withCompositionUIStatus?: boolean;
553
557
  /** @description Include basic redirect information */
@@ -743,10 +747,11 @@ interface components {
743
747
  isSearchHit?: boolean;
744
748
  /** @description Query strings that are allowed to be passed to the node */
745
749
  queryStrings?: components["schemas"]["ProjectMapNodeAllowedQueryString"][];
746
- /** @description For dynamic nodes, this is the preview value for the dynamic value.
750
+ /**
751
+ * @description For dynamic nodes, this is the preview value for the dynamic value.
747
752
  * The preview value is used when editing a connected composition, and is the default
748
753
  * dynamic node value unless the author has explicitly chosen a different value
749
- * */
754
+ */
750
755
  previewValue?: string;
751
756
  };
752
757
  /** @description Basic information about a composition edition from the context of a project map node */
@@ -792,9 +797,10 @@ interface components {
792
797
  */
793
798
  modified?: string;
794
799
  };
795
- /** @description Basic information about the linked composition from the context of a project map node.
800
+ /**
801
+ * @description Basic information about the linked composition from the context of a project map node.
796
802
  * If the linked composition has editions, the editions are included in the `editions` property.
797
- * */
803
+ */
798
804
  ProjectMapNodeCompositionData: {
799
805
  /** @description Type of the linked composition (id of its definition) */
800
806
  type: string;
@@ -807,7 +813,6 @@ interface components {
807
813
  * Format: uuid
808
814
  * @description The edition UUID underneath the linked composition
809
815
  * This is only present if the composition has not been published, but an edition has
810
- *
811
816
  */
812
817
  editionId?: string;
813
818
  /** @description Slug pattern of the linked composition or edition */
@@ -827,24 +832,25 @@ interface components {
827
832
  icon?: string;
828
833
  /** @description Friendly name of this Composition's Definition */
829
834
  typeName?: string;
830
- /** @description List of locales that the composition _or any of its editions_ is available in.
835
+ /**
836
+ * @description List of locales that the composition _or any of its editions_ is available in.
831
837
  * If empty, available in all locales.
832
- * */
838
+ */
833
839
  locales: string[];
834
840
  /** @description Priority of the composition relative to any editions */
835
841
  editionPriority?: number;
836
842
  /** @description Friendly name of the edition */
837
843
  editionName?: string;
838
- /** @description List of editions available for this composition. The composition is included in the list, it is the edition
844
+ /**
845
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
839
846
  * where the editionID equals the node's compositionID. NOTE: this is not sent if only one edition is available
840
- * */
847
+ */
841
848
  editions?: components["schemas"]["ProjectMapNodeCompositionEditionData"][];
842
849
  /**
843
850
  * Format: date-time
844
851
  * @description Date and time the composition was last modified (or created if never modified).
845
852
  * Uses ISO-8859-1 formatting and UTC timezone.
846
853
  * IMPORTANT: if the composition has more than one edition, this is the modified date of the default edition. Each edition has its own modified date in the `editions` array.
847
- *
848
854
  */
849
855
  modified?: string;
850
856
  };
@@ -869,14 +875,15 @@ interface components {
869
875
  path?: string;
870
876
  /** @description Last segment of the url in this locale */
871
877
  pathSegment: string;
872
- /** @description When false, the node explicitly defines a locale-specific path segment.
878
+ /**
879
+ * @description When false, the node explicitly defines a locale-specific path segment.
873
880
  *
874
881
  * When true, an ancestor defines a locale-specific path segment,
875
882
  * which makes its descendants resolvable using that segment.
876
883
  * This node does not define a locale-specific path segment.
877
884
  *
878
885
  * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
879
- * */
886
+ */
880
887
  inherited?: boolean;
881
888
  };
882
889
  ProjectMapNodeDefinition: {
package/dist/index.d.ts CHANGED
@@ -294,14 +294,15 @@ interface components$1 {
294
294
  path?: string;
295
295
  /** @description Last segment of the url in this locale */
296
296
  pathSegment: string;
297
- /** @description When false, the node explicitly defines a locale-specific path segment.
297
+ /**
298
+ * @description When false, the node explicitly defines a locale-specific path segment.
298
299
  *
299
300
  * When true, an ancestor defines a locale-specific path segment,
300
301
  * which makes its descendants resolvable using that segment.
301
302
  * This node does not define a locale-specific path segment.
302
303
  *
303
304
  * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
304
- * */
305
+ */
305
306
  inherited?: boolean;
306
307
  };
307
308
  ProjectMapSourceRedirectData: {
@@ -318,9 +319,10 @@ interface components$1 {
318
319
  */
319
320
  id?: string;
320
321
  }[];
321
- /** @description Basic information about the linked composition from the context of a project map node.
322
+ /**
323
+ * @description Basic information about the linked composition from the context of a project map node.
322
324
  * If the linked composition has editions, the editions are included in the `editions` property.
323
- * */
325
+ */
324
326
  ProjectMapNodeCompositionData: {
325
327
  /** @description Type of the linked composition (id of its definition) */
326
328
  type: string;
@@ -333,7 +335,6 @@ interface components$1 {
333
335
  * Format: uuid
334
336
  * @description The edition UUID underneath the linked composition
335
337
  * This is only present if the composition has not been published, but an edition has
336
- *
337
338
  */
338
339
  editionId?: string;
339
340
  /** @description Slug pattern of the linked composition or edition */
@@ -353,24 +354,25 @@ interface components$1 {
353
354
  icon?: string;
354
355
  /** @description Friendly name of this Composition's Definition */
355
356
  typeName?: string;
356
- /** @description List of locales that the composition _or any of its editions_ is available in.
357
+ /**
358
+ * @description List of locales that the composition _or any of its editions_ is available in.
357
359
  * If empty, available in all locales.
358
- * */
360
+ */
359
361
  locales: string[];
360
362
  /** @description Priority of the composition relative to any editions */
361
363
  editionPriority?: number;
362
364
  /** @description Friendly name of the edition */
363
365
  editionName?: string;
364
- /** @description List of editions available for this composition. The composition is included in the list, it is the edition
366
+ /**
367
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
365
368
  * where the editionID equals the node's compositionID. NOTE: this is not sent if only one edition is available
366
- * */
369
+ */
367
370
  editions?: components$1["schemas"]["ProjectMapNodeCompositionEditionData"][];
368
371
  /**
369
372
  * Format: date-time
370
373
  * @description Date and time the composition was last modified (or created if never modified).
371
374
  * Uses ISO-8859-1 formatting and UTC timezone.
372
375
  * IMPORTANT: if the composition has more than one edition, this is the modified date of the default edition. Each edition has its own modified date in the `editions` array.
373
- *
374
376
  */
375
377
  modified?: string;
376
378
  };
@@ -457,10 +459,11 @@ interface components$1 {
457
459
  isSearchHit?: boolean;
458
460
  /** @description Query strings that are allowed to be passed to the node */
459
461
  queryStrings?: components$1["schemas"]["ProjectMapNodeAllowedQueryString"][];
460
- /** @description For dynamic nodes, this is the preview value for the dynamic value.
462
+ /**
463
+ * @description For dynamic nodes, this is the preview value for the dynamic value.
461
464
  * The preview value is used when editing a connected composition, and is the default
462
465
  * dynamic node value unless the author has explicitly chosen a different value
463
- * */
466
+ */
464
467
  previewValue?: string;
465
468
  };
466
469
  ProjectMapNodeAllowedQueryString: {
@@ -509,13 +512,14 @@ interface paths {
509
512
  projectMapId?: string;
510
513
  /** @description The project id that contains the project map tree that this node belongs to */
511
514
  projectId: string;
512
- /** @description The ID of a release to fetch the composition data for.
515
+ /**
516
+ * @description The ID of a release to fetch the composition data for.
513
517
  *
514
518
  * - When unspecified, composition data is fetched from base.
515
519
  * - 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.
516
520
  *
517
521
  * 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
518
- * */
522
+ */
519
523
  releaseId?: string;
520
524
  /** @description The id of the node to retrieve, cannot have both this parameter and `path` */
521
525
  id?: string;
@@ -535,9 +539,10 @@ interface paths {
535
539
  tree?: boolean;
536
540
  /** @description text search filter */
537
541
  search?: string;
538
- /** @description Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
542
+ /**
543
+ * @description Modifies the results to include all ancestors of matched nodes, in addition to the nodes themselves.
539
544
  * Results are sorted by path. If multiple nodes are selected, ancestors are not duplicated
540
- * */
545
+ */
541
546
  includeAncestors?: boolean;
542
547
  /** @description include expanded helper computed properties, including `isLeaf`, `parentPath`, `pathSegment` etc */
543
548
  expanded?: boolean;
@@ -547,7 +552,6 @@ interface paths {
547
552
  * @deprecated
548
553
  * @description Returns the UI status string of the composition.
549
554
  * This internal status is subject to change without notice and is thus marked deprecated to discourage the use of internal data
550
- *
551
555
  */
552
556
  withCompositionUIStatus?: boolean;
553
557
  /** @description Include basic redirect information */
@@ -743,10 +747,11 @@ interface components {
743
747
  isSearchHit?: boolean;
744
748
  /** @description Query strings that are allowed to be passed to the node */
745
749
  queryStrings?: components["schemas"]["ProjectMapNodeAllowedQueryString"][];
746
- /** @description For dynamic nodes, this is the preview value for the dynamic value.
750
+ /**
751
+ * @description For dynamic nodes, this is the preview value for the dynamic value.
747
752
  * The preview value is used when editing a connected composition, and is the default
748
753
  * dynamic node value unless the author has explicitly chosen a different value
749
- * */
754
+ */
750
755
  previewValue?: string;
751
756
  };
752
757
  /** @description Basic information about a composition edition from the context of a project map node */
@@ -792,9 +797,10 @@ interface components {
792
797
  */
793
798
  modified?: string;
794
799
  };
795
- /** @description Basic information about the linked composition from the context of a project map node.
800
+ /**
801
+ * @description Basic information about the linked composition from the context of a project map node.
796
802
  * If the linked composition has editions, the editions are included in the `editions` property.
797
- * */
803
+ */
798
804
  ProjectMapNodeCompositionData: {
799
805
  /** @description Type of the linked composition (id of its definition) */
800
806
  type: string;
@@ -807,7 +813,6 @@ interface components {
807
813
  * Format: uuid
808
814
  * @description The edition UUID underneath the linked composition
809
815
  * This is only present if the composition has not been published, but an edition has
810
- *
811
816
  */
812
817
  editionId?: string;
813
818
  /** @description Slug pattern of the linked composition or edition */
@@ -827,24 +832,25 @@ interface components {
827
832
  icon?: string;
828
833
  /** @description Friendly name of this Composition's Definition */
829
834
  typeName?: string;
830
- /** @description List of locales that the composition _or any of its editions_ is available in.
835
+ /**
836
+ * @description List of locales that the composition _or any of its editions_ is available in.
831
837
  * If empty, available in all locales.
832
- * */
838
+ */
833
839
  locales: string[];
834
840
  /** @description Priority of the composition relative to any editions */
835
841
  editionPriority?: number;
836
842
  /** @description Friendly name of the edition */
837
843
  editionName?: string;
838
- /** @description List of editions available for this composition. The composition is included in the list, it is the edition
844
+ /**
845
+ * @description List of editions available for this composition. The composition is included in the list, it is the edition
839
846
  * where the editionID equals the node's compositionID. NOTE: this is not sent if only one edition is available
840
- * */
847
+ */
841
848
  editions?: components["schemas"]["ProjectMapNodeCompositionEditionData"][];
842
849
  /**
843
850
  * Format: date-time
844
851
  * @description Date and time the composition was last modified (or created if never modified).
845
852
  * Uses ISO-8859-1 formatting and UTC timezone.
846
853
  * IMPORTANT: if the composition has more than one edition, this is the modified date of the default edition. Each edition has its own modified date in the `editions` array.
847
- *
848
854
  */
849
855
  modified?: string;
850
856
  };
@@ -869,14 +875,15 @@ interface components {
869
875
  path?: string;
870
876
  /** @description Last segment of the url in this locale */
871
877
  pathSegment: string;
872
- /** @description When false, the node explicitly defines a locale-specific path segment.
878
+ /**
879
+ * @description When false, the node explicitly defines a locale-specific path segment.
873
880
  *
874
881
  * When true, an ancestor defines a locale-specific path segment,
875
882
  * which makes its descendants resolvable using that segment.
876
883
  * This node does not define a locale-specific path segment.
877
884
  *
878
885
  * Only included if requested with the expanded flag. Without the expanded flag, inherited locales are not included in the response
879
- * */
886
+ */
880
887
  inherited?: boolean;
881
888
  };
882
889
  ProjectMapNodeDefinition: {
package/dist/index.js CHANGED
@@ -26,8 +26,8 @@ var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "
26
26
  var __privateMethod = (obj, member, method) => (__accessCheck(obj, member, "access private method"), method);
27
27
 
28
28
  // src/index.ts
29
- var src_exports = {};
30
- __export(src_exports, {
29
+ var index_exports = {};
30
+ __export(index_exports, {
31
31
  ProjectMapClient: () => ProjectMapClient,
32
32
  ROOT_NODE_PATH: () => ROOT_NODE_PATH,
33
33
  Route: () => Route,
@@ -38,7 +38,7 @@ __export(src_exports, {
38
38
  getNodeLocalePath: () => getNodeLocalePath,
39
39
  getRouteAlternateLocalesUrls: () => getRouteAlternateLocalesUrls
40
40
  });
41
- module.exports = __toCommonJS(src_exports);
41
+ module.exports = __toCommonJS(index_exports);
42
42
 
43
43
  // src/projectMapClient.ts
44
44
  var import_api = require("@uniformdev/context/api");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/project-map",
3
- "version": "20.70.0",
3
+ "version": "20.70.1-alpha.10+6e0ecaf156",
4
4
  "description": "Uniform Project Map",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -32,11 +32,11 @@
32
32
  "/dist"
33
33
  ],
34
34
  "dependencies": {
35
- "@uniformdev/canvas": "20.70.0",
36
- "@uniformdev/context": "20.70.0"
35
+ "@uniformdev/canvas": "20.70.1-alpha.10+6e0ecaf156",
36
+ "@uniformdev/context": "20.70.1-alpha.10+6e0ecaf156"
37
37
  },
38
38
  "publishConfig": {
39
39
  "access": "public"
40
40
  },
41
- "gitHead": "3f8f572b37fc7ea5d2f37b1425451973556f3392"
41
+ "gitHead": "6e0ecaf15691da45ddab84cc3ca11c4d048bbbdd"
42
42
  }