@uniformdev/project-map 19.210.1-alpha.7 → 19.210.4-alpha.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
@@ -1,4 +1,4 @@
1
- import { ApiClient, ClientOptions } from '@uniformdev/context/api';
1
+ import { ApiClient } from '@uniformdev/context/api';
2
2
  import { RouteGetResponse } from '@uniformdev/canvas';
3
3
 
4
4
  interface paths$1 {
@@ -987,6 +987,20 @@ type ProjectMapNodeData = components$1['schemas']['ProjectMapNodeData'];
987
987
  type ProjectMapNodeAllowedQueryString = components$1['schemas']['ProjectMapNodeAllowedQueryString'];
988
988
 
989
989
  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
+ };
990
1004
  type ProjectMapSubtree = ProjectMapNode & {
991
1005
  children?: Array<ProjectMapSubtree> | undefined;
992
1006
  parent?: ProjectMapSubtree | undefined;
@@ -996,8 +1010,8 @@ type ProjectMapSubtree = ProjectMapNode & {
996
1010
  type WithoutProjectId<T extends {
997
1011
  projectId: string;
998
1012
  }> = Omit<T, 'projectId'>;
999
- declare class ProjectMapClient extends ApiClient {
1000
- constructor(options: ClientOptions);
1013
+ declare class ProjectMapClient extends ApiClient<ProjectMapClientOptions> {
1014
+ constructor(options: ProjectMapClientOptions);
1001
1015
  /**
1002
1016
  * Get available project map defintions
1003
1017
  */
@@ -1038,7 +1052,7 @@ declare class ProjectMapClient extends ApiClient {
1038
1052
  private cleanProjectMapNode;
1039
1053
  }
1040
1054
  declare class UncachedProjectMapClient extends ProjectMapClient {
1041
- constructor(options: Omit<ClientOptions, 'bypassCache'>);
1055
+ constructor(options: Omit<ProjectMapClientOptions, 'bypassCache'>);
1042
1056
  }
1043
1057
  /**
1044
1058
  * Internal use only.
@@ -1160,4 +1174,4 @@ declare class Route {
1160
1174
  static dynamicSegmentPrefix: string;
1161
1175
  }
1162
1176
 
1163
- 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 };
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 };
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ApiClient, ClientOptions } from '@uniformdev/context/api';
1
+ import { ApiClient } from '@uniformdev/context/api';
2
2
  import { RouteGetResponse } from '@uniformdev/canvas';
3
3
 
4
4
  interface paths$1 {
@@ -987,6 +987,20 @@ type ProjectMapNodeData = components$1['schemas']['ProjectMapNodeData'];
987
987
  type ProjectMapNodeAllowedQueryString = components$1['schemas']['ProjectMapNodeAllowedQueryString'];
988
988
 
989
989
  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
+ };
990
1004
  type ProjectMapSubtree = ProjectMapNode & {
991
1005
  children?: Array<ProjectMapSubtree> | undefined;
992
1006
  parent?: ProjectMapSubtree | undefined;
@@ -996,8 +1010,8 @@ type ProjectMapSubtree = ProjectMapNode & {
996
1010
  type WithoutProjectId<T extends {
997
1011
  projectId: string;
998
1012
  }> = Omit<T, 'projectId'>;
999
- declare class ProjectMapClient extends ApiClient {
1000
- constructor(options: ClientOptions);
1013
+ declare class ProjectMapClient extends ApiClient<ProjectMapClientOptions> {
1014
+ constructor(options: ProjectMapClientOptions);
1001
1015
  /**
1002
1016
  * Get available project map defintions
1003
1017
  */
@@ -1038,7 +1052,7 @@ declare class ProjectMapClient extends ApiClient {
1038
1052
  private cleanProjectMapNode;
1039
1053
  }
1040
1054
  declare class UncachedProjectMapClient extends ProjectMapClient {
1041
- constructor(options: Omit<ClientOptions, 'bypassCache'>);
1055
+ constructor(options: Omit<ProjectMapClientOptions, 'bypassCache'>);
1042
1056
  }
1043
1057
  /**
1044
1058
  * Internal use only.
@@ -1160,4 +1174,4 @@ declare class Route {
1160
1174
  static dynamicSegmentPrefix: string;
1161
1175
  }
1162
1176
 
1163
- 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 };
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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/project-map",
3
- "version": "19.210.1-alpha.7+5402269e8e",
3
+ "version": "19.210.4-alpha.0+2ff265809b",
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.1-alpha.7+5402269e8e",
37
- "@uniformdev/context": "19.210.1-alpha.7+5402269e8e"
36
+ "@uniformdev/canvas": "19.210.4-alpha.0+2ff265809b",
37
+ "@uniformdev/context": "19.210.4-alpha.0+2ff265809b"
38
38
  },
39
39
  "publishConfig": {
40
40
  "access": "public"
41
41
  },
42
- "gitHead": "5402269e8e1d1f8d955c4c2bb30ab7ac1a96e66b"
42
+ "gitHead": "2ff265809b85f61d950748aaea35beaf1c4fe443"
43
43
  }