@uniformdev/project-map 19.210.4-alpha.0 → 19.211.1-alpha.11

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
@@ -1,4 +1,4 @@
1
- import { ApiClient } from '@uniformdev/context/api';
1
+ import { ApiClient, ClientOptions } from '@uniformdev/context/api';
2
2
  import { RouteGetResponse } from '@uniformdev/canvas';
3
3
 
4
4
  interface paths$1 {
@@ -340,10 +340,18 @@ interface components$1 {
340
340
  /**
341
341
  * @deprecated
342
342
  * @description List of editions available for this composition. The composition is included in the list, it is the edition
343
- * where the editionID equals the node's compositionID.
343
+ * where the editionID equals the node's compositionID. NOTE: this is not sent if only one edition is available
344
344
  *
345
345
  */
346
346
  editions?: components$1["schemas"]["ProjectMapNodeCompositionEditionData"][];
347
+ /**
348
+ * Format: date-time
349
+ * @description Date and time the composition was last modified (or created if never modified).
350
+ * Uses ISO-8859-1 formatting and UTC timezone.
351
+ * 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.
352
+ *
353
+ */
354
+ modified?: string;
347
355
  };
348
356
  /**
349
357
  * @deprecated
@@ -387,7 +395,7 @@ interface components$1 {
387
395
  locales: string[];
388
396
  /**
389
397
  * Format: date-time
390
- * @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
398
+ * @description Date and time the edition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
391
399
  */
392
400
  modified?: string;
393
401
  };
@@ -737,7 +745,7 @@ interface components {
737
745
  locales: string[];
738
746
  /**
739
747
  * Format: date-time
740
- * @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
748
+ * @description Date and time the edition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
741
749
  */
742
750
  modified?: string;
743
751
  };
@@ -787,10 +795,18 @@ interface components {
787
795
  /**
788
796
  * @deprecated
789
797
  * @description List of editions available for this composition. The composition is included in the list, it is the edition
790
- * where the editionID equals the node's compositionID.
798
+ * where the editionID equals the node's compositionID. NOTE: this is not sent if only one edition is available
791
799
  *
792
800
  */
793
801
  editions?: components["schemas"]["ProjectMapNodeCompositionEditionData"][];
802
+ /**
803
+ * Format: date-time
804
+ * @description Date and time the composition was last modified (or created if never modified).
805
+ * Uses ISO-8859-1 formatting and UTC timezone.
806
+ * 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.
807
+ *
808
+ */
809
+ modified?: string;
794
810
  };
795
811
  ProjectMapSourceRedirectData: {
796
812
  /**
@@ -987,20 +1003,6 @@ type ProjectMapNodeData = components$1['schemas']['ProjectMapNodeData'];
987
1003
  type ProjectMapNodeAllowedQueryString = components$1['schemas']['ProjectMapNodeAllowedQueryString'];
988
1004
 
989
1005
  declare const ROOT_NODE_PATH = "/";
990
- type ProjectMapClientOptions = {
991
- /** The Uniform API host to use. Internal use. */
992
- apiHost?: string;
993
- /** The Uniform API key to use when sending API requests. This or bearer token must be specified. */
994
- apiKey?: string | undefined;
995
- /** The Uniform bearer token to use. Internal use. */
996
- bearerToken?: string | undefined;
997
- /** The Uniform project ID to connect to */
998
- projectId?: string | null;
999
- /** Specify a fetch implementation to use when fetching data. Useful if you want to only polyfill selectively. */
1000
- fetch?: typeof fetch;
1001
- /** Specify whether caching is disabled. */
1002
- bypassCache?: boolean;
1003
- };
1004
1006
  type ProjectMapSubtree = ProjectMapNode & {
1005
1007
  children?: Array<ProjectMapSubtree> | undefined;
1006
1008
  parent?: ProjectMapSubtree | undefined;
@@ -1010,8 +1012,8 @@ type ProjectMapSubtree = ProjectMapNode & {
1010
1012
  type WithoutProjectId<T extends {
1011
1013
  projectId: string;
1012
1014
  }> = Omit<T, 'projectId'>;
1013
- declare class ProjectMapClient extends ApiClient<ProjectMapClientOptions> {
1014
- constructor(options: ProjectMapClientOptions);
1015
+ declare class ProjectMapClient extends ApiClient {
1016
+ constructor(options: ClientOptions);
1015
1017
  /**
1016
1018
  * Get available project map defintions
1017
1019
  */
@@ -1052,7 +1054,7 @@ declare class ProjectMapClient extends ApiClient<ProjectMapClientOptions> {
1052
1054
  private cleanProjectMapNode;
1053
1055
  }
1054
1056
  declare class UncachedProjectMapClient extends ProjectMapClient {
1055
- constructor(options: Omit<ProjectMapClientOptions, 'bypassCache'>);
1057
+ constructor(options: Omit<ClientOptions, 'bypassCache'>);
1056
1058
  }
1057
1059
  /**
1058
1060
  * Internal use only.
@@ -1174,4 +1176,4 @@ declare class Route {
1174
1176
  static dynamicSegmentPrefix: string;
1175
1177
  }
1176
1178
 
1177
- export { type AlternateLocaleUrls, type ExpandOptions, type GetActiveEditionOptions, type LocalePathNode, type MatchedRoute, type NodeType, type ObjectWithEditionMetadata, ProjectMapClient, type ProjectMapClientOptions, type ProjectMapDefinition, type ProjectMapDefinitionWithId, type ProjectMapDefinitions, type ProjectMapDeleteRequest, type ProjectMapGetRequest, type ProjectMapGetResponse, type ProjectMapNode, type ProjectMapNodeAllowedQueryString, type ProjectMapNodeCompositionData, type ProjectMapNodeCompositionEditionData, type ProjectMapNodeData, type ProjectMapNodeDeleteRequest, type ProjectMapNodeGetRequest, type ProjectMapNodeGetResponse, type ProjectMapNodeLocale, type ProjectMapNodeUpsertRequest, type ProjectMapNodeUpsertRequestNode, type ProjectMapNodeUpsertRequestNodeLocale, type ProjectMapNodeWithId, type ProjectMapNodeWithProjectMapReference, type ProjectMapSubtree, type ProjectMapUpsertRequest, type ProjectMapUpsertResponse, ROOT_NODE_PATH, Route, UncachedProjectMapClient, type UnmatchedRoute, __INTERNAL_MISSING_PARENT_NODE_ERROR, getActiveEdition, getNodeActiveCompositionEdition, getNodeLocalePath, getRouteAlternateLocalesUrls };
1179
+ export { type AlternateLocaleUrls, type ExpandOptions, type GetActiveEditionOptions, type LocalePathNode, type MatchedRoute, type NodeType, type ObjectWithEditionMetadata, ProjectMapClient, type ProjectMapDefinition, type ProjectMapDefinitionWithId, type ProjectMapDefinitions, type ProjectMapDeleteRequest, type ProjectMapGetRequest, type ProjectMapGetResponse, type ProjectMapNode, type ProjectMapNodeAllowedQueryString, type ProjectMapNodeCompositionData, type ProjectMapNodeCompositionEditionData, type ProjectMapNodeData, type ProjectMapNodeDeleteRequest, type ProjectMapNodeGetRequest, type ProjectMapNodeGetResponse, type ProjectMapNodeLocale, type ProjectMapNodeUpsertRequest, type ProjectMapNodeUpsertRequestNode, type ProjectMapNodeUpsertRequestNodeLocale, type ProjectMapNodeWithId, type ProjectMapNodeWithProjectMapReference, type ProjectMapSubtree, type ProjectMapUpsertRequest, type ProjectMapUpsertResponse, ROOT_NODE_PATH, Route, UncachedProjectMapClient, type UnmatchedRoute, __INTERNAL_MISSING_PARENT_NODE_ERROR, getActiveEdition, getNodeActiveCompositionEdition, getNodeLocalePath, getRouteAlternateLocalesUrls };
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ApiClient } from '@uniformdev/context/api';
1
+ import { ApiClient, ClientOptions } from '@uniformdev/context/api';
2
2
  import { RouteGetResponse } from '@uniformdev/canvas';
3
3
 
4
4
  interface paths$1 {
@@ -340,10 +340,18 @@ interface components$1 {
340
340
  /**
341
341
  * @deprecated
342
342
  * @description List of editions available for this composition. The composition is included in the list, it is the edition
343
- * where the editionID equals the node's compositionID.
343
+ * where the editionID equals the node's compositionID. NOTE: this is not sent if only one edition is available
344
344
  *
345
345
  */
346
346
  editions?: components$1["schemas"]["ProjectMapNodeCompositionEditionData"][];
347
+ /**
348
+ * Format: date-time
349
+ * @description Date and time the composition was last modified (or created if never modified).
350
+ * Uses ISO-8859-1 formatting and UTC timezone.
351
+ * 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.
352
+ *
353
+ */
354
+ modified?: string;
347
355
  };
348
356
  /**
349
357
  * @deprecated
@@ -387,7 +395,7 @@ interface components$1 {
387
395
  locales: string[];
388
396
  /**
389
397
  * Format: date-time
390
- * @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
398
+ * @description Date and time the edition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
391
399
  */
392
400
  modified?: string;
393
401
  };
@@ -737,7 +745,7 @@ interface components {
737
745
  locales: string[];
738
746
  /**
739
747
  * Format: date-time
740
- * @description Date and time the composition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
748
+ * @description Date and time the edition was last modified (or created if never modified). Uses ISO-8859-1 formatting and UTC timezone.
741
749
  */
742
750
  modified?: string;
743
751
  };
@@ -787,10 +795,18 @@ interface components {
787
795
  /**
788
796
  * @deprecated
789
797
  * @description List of editions available for this composition. The composition is included in the list, it is the edition
790
- * where the editionID equals the node's compositionID.
798
+ * where the editionID equals the node's compositionID. NOTE: this is not sent if only one edition is available
791
799
  *
792
800
  */
793
801
  editions?: components["schemas"]["ProjectMapNodeCompositionEditionData"][];
802
+ /**
803
+ * Format: date-time
804
+ * @description Date and time the composition was last modified (or created if never modified).
805
+ * Uses ISO-8859-1 formatting and UTC timezone.
806
+ * 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.
807
+ *
808
+ */
809
+ modified?: string;
794
810
  };
795
811
  ProjectMapSourceRedirectData: {
796
812
  /**
@@ -987,20 +1003,6 @@ type ProjectMapNodeData = components$1['schemas']['ProjectMapNodeData'];
987
1003
  type ProjectMapNodeAllowedQueryString = components$1['schemas']['ProjectMapNodeAllowedQueryString'];
988
1004
 
989
1005
  declare const ROOT_NODE_PATH = "/";
990
- type ProjectMapClientOptions = {
991
- /** The Uniform API host to use. Internal use. */
992
- apiHost?: string;
993
- /** The Uniform API key to use when sending API requests. This or bearer token must be specified. */
994
- apiKey?: string | undefined;
995
- /** The Uniform bearer token to use. Internal use. */
996
- bearerToken?: string | undefined;
997
- /** The Uniform project ID to connect to */
998
- projectId?: string | null;
999
- /** Specify a fetch implementation to use when fetching data. Useful if you want to only polyfill selectively. */
1000
- fetch?: typeof fetch;
1001
- /** Specify whether caching is disabled. */
1002
- bypassCache?: boolean;
1003
- };
1004
1006
  type ProjectMapSubtree = ProjectMapNode & {
1005
1007
  children?: Array<ProjectMapSubtree> | undefined;
1006
1008
  parent?: ProjectMapSubtree | undefined;
@@ -1010,8 +1012,8 @@ type ProjectMapSubtree = ProjectMapNode & {
1010
1012
  type WithoutProjectId<T extends {
1011
1013
  projectId: string;
1012
1014
  }> = Omit<T, 'projectId'>;
1013
- declare class ProjectMapClient extends ApiClient<ProjectMapClientOptions> {
1014
- constructor(options: ProjectMapClientOptions);
1015
+ declare class ProjectMapClient extends ApiClient {
1016
+ constructor(options: ClientOptions);
1015
1017
  /**
1016
1018
  * Get available project map defintions
1017
1019
  */
@@ -1052,7 +1054,7 @@ declare class ProjectMapClient extends ApiClient<ProjectMapClientOptions> {
1052
1054
  private cleanProjectMapNode;
1053
1055
  }
1054
1056
  declare class UncachedProjectMapClient extends ProjectMapClient {
1055
- constructor(options: Omit<ProjectMapClientOptions, 'bypassCache'>);
1057
+ constructor(options: Omit<ClientOptions, 'bypassCache'>);
1056
1058
  }
1057
1059
  /**
1058
1060
  * Internal use only.
@@ -1174,4 +1176,4 @@ declare class Route {
1174
1176
  static dynamicSegmentPrefix: string;
1175
1177
  }
1176
1178
 
1177
- export { type AlternateLocaleUrls, type ExpandOptions, type GetActiveEditionOptions, type LocalePathNode, type MatchedRoute, type NodeType, type ObjectWithEditionMetadata, ProjectMapClient, type ProjectMapClientOptions, type ProjectMapDefinition, type ProjectMapDefinitionWithId, type ProjectMapDefinitions, type ProjectMapDeleteRequest, type ProjectMapGetRequest, type ProjectMapGetResponse, type ProjectMapNode, type ProjectMapNodeAllowedQueryString, type ProjectMapNodeCompositionData, type ProjectMapNodeCompositionEditionData, type ProjectMapNodeData, type ProjectMapNodeDeleteRequest, type ProjectMapNodeGetRequest, type ProjectMapNodeGetResponse, type ProjectMapNodeLocale, type ProjectMapNodeUpsertRequest, type ProjectMapNodeUpsertRequestNode, type ProjectMapNodeUpsertRequestNodeLocale, type ProjectMapNodeWithId, type ProjectMapNodeWithProjectMapReference, type ProjectMapSubtree, type ProjectMapUpsertRequest, type ProjectMapUpsertResponse, ROOT_NODE_PATH, Route, UncachedProjectMapClient, type UnmatchedRoute, __INTERNAL_MISSING_PARENT_NODE_ERROR, getActiveEdition, getNodeActiveCompositionEdition, getNodeLocalePath, getRouteAlternateLocalesUrls };
1179
+ export { type AlternateLocaleUrls, type ExpandOptions, type GetActiveEditionOptions, type LocalePathNode, type MatchedRoute, type NodeType, type ObjectWithEditionMetadata, ProjectMapClient, type ProjectMapDefinition, type ProjectMapDefinitionWithId, type ProjectMapDefinitions, type ProjectMapDeleteRequest, type ProjectMapGetRequest, type ProjectMapGetResponse, type ProjectMapNode, type ProjectMapNodeAllowedQueryString, type ProjectMapNodeCompositionData, type ProjectMapNodeCompositionEditionData, type ProjectMapNodeData, type ProjectMapNodeDeleteRequest, type ProjectMapNodeGetRequest, type ProjectMapNodeGetResponse, type ProjectMapNodeLocale, type ProjectMapNodeUpsertRequest, type ProjectMapNodeUpsertRequestNode, type ProjectMapNodeUpsertRequestNodeLocale, type ProjectMapNodeWithId, type ProjectMapNodeWithProjectMapReference, type ProjectMapSubtree, type ProjectMapUpsertRequest, type ProjectMapUpsertResponse, ROOT_NODE_PATH, Route, UncachedProjectMapClient, type UnmatchedRoute, __INTERNAL_MISSING_PARENT_NODE_ERROR, getActiveEdition, getNodeActiveCompositionEdition, getNodeLocalePath, getRouteAlternateLocalesUrls };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/project-map",
3
- "version": "19.210.4-alpha.0+2ff265809b",
3
+ "version": "19.211.1-alpha.11+2c4b5ab595",
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.210.4-alpha.0+2ff265809b",
37
- "@uniformdev/context": "19.210.4-alpha.0+2ff265809b"
36
+ "@uniformdev/canvas": "19.211.1-alpha.11+2c4b5ab595",
37
+ "@uniformdev/context": "19.211.1-alpha.11+2c4b5ab595"
38
38
  },
39
39
  "publishConfig": {
40
40
  "access": "public"
41
41
  },
42
- "gitHead": "2ff265809b85f61d950748aaea35beaf1c4fe443"
42
+ "gitHead": "2c4b5ab595e333d324808dc75d5291cc62ee8039"
43
43
  }