@ms-cloudpack/common-types 0.27.3 → 0.27.4

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.
@@ -4,6 +4,7 @@ export interface ServerConfig {
4
4
  /**
5
5
  * The domain name of the server. If multiple domains are specified, the first one will be
6
6
  * used as the primary domain used when opening the browser.
7
+ * @default 'localhost'
7
8
  */
8
9
  domain?: string | string[];
9
10
  /**
@@ -22,7 +23,8 @@ export interface ServerConfig {
22
23
  */
23
24
  port?: number | number[];
24
25
  /**
25
- * The default path to use when opening the browser.
26
+ * The default path under the domain to use when opening the browser.
27
+ * @default ''
26
28
  */
27
29
  defaultPath?: string;
28
30
  /**
@@ -32,6 +34,14 @@ export interface ServerConfig {
32
34
  * If not provided, the server will use http.
33
35
  */
34
36
  https?: true | HttpsConfig;
37
+ /**
38
+ * Whether to show the Cloudpack overlay (status badge and dialog) in the app UI.
39
+ *
40
+ * It's not recommended to change this unless the overlay is interfering with UI elements or tests
41
+ * (and if it's only needed in a specific case, use the `--show-overlay <when>` CLI option).
42
+ * @default 'always'
43
+ */
44
+ showOverlay?: 'always' | 'errors-only' | 'never';
35
45
  /**
36
46
  * @deprecated Moved to the root of the config.
37
47
  */
@@ -1 +1 @@
1
- {"version":3,"file":"ServerConfig.d.ts","sourceRoot":"","sources":["../src/ServerConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE3B;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,GAAG,WAAW,CAAC;IAE3B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;CAC3B"}
1
+ {"version":3,"file":"ServerConfig.d.ts","sourceRoot":"","sources":["../src/ServerConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE3B;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,IAAI,GAAG,WAAW,CAAC;IAE3B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,QAAQ,GAAG,aAAa,GAAG,OAAO,CAAC;IAEjD;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;CAC3B"}
@@ -1 +1 @@
1
- {"version":3,"file":"ServerConfig.js","sourceRoot":"","sources":["../src/ServerConfig.ts"],"names":[],"mappings":"","sourcesContent":["import type { HttpsConfig } from './HttpsConfig.js';\nimport type { ShorthandRoute } from './Route.js';\n\nexport interface ServerConfig {\n /**\n * The domain name of the server. If multiple domains are specified, the first one will be\n * used as the primary domain used when opening the browser.\n */\n domain?: string | string[];\n\n /**\n * Additional header key/value pairs to be added to every response.\n *\n * NOTE: The following header values from Cloudpack will \"win\" against by a user's config:\n * - `'Cache-Control': 'no-cache'`\n * - `'Access-Control-Allow-Origin': '*'`\n */\n requestHeaders?: Record<string, string>;\n\n /**\n * Port(s) to try when starting the server. If provided, an error will be thrown if none of\n * the ports are available.\n *\n * If no ports are provided, the server will attempt to find an available port.\n */\n port?: number | number[];\n\n /**\n * The default path to use when opening the browser.\n */\n defaultPath?: string;\n\n /**\n * The config settings for the https server.\n * Paths to files are accepted for 'ca', 'cert', 'key', and 'pfx' settings.\n * Everything else is passed directly to the https.createServer() method.\n * If not provided, the server will use http.\n */\n https?: true | HttpsConfig;\n\n /**\n * @deprecated Moved to the root of the config.\n */\n routes?: ShorthandRoute[];\n}\n"]}
1
+ {"version":3,"file":"ServerConfig.js","sourceRoot":"","sources":["../src/ServerConfig.ts"],"names":[],"mappings":"","sourcesContent":["import type { HttpsConfig } from './HttpsConfig.js';\nimport type { ShorthandRoute } from './Route.js';\n\nexport interface ServerConfig {\n /**\n * The domain name of the server. If multiple domains are specified, the first one will be\n * used as the primary domain used when opening the browser.\n * @default 'localhost'\n */\n domain?: string | string[];\n\n /**\n * Additional header key/value pairs to be added to every response.\n *\n * NOTE: The following header values from Cloudpack will \"win\" against by a user's config:\n * - `'Cache-Control': 'no-cache'`\n * - `'Access-Control-Allow-Origin': '*'`\n */\n requestHeaders?: Record<string, string>;\n\n /**\n * Port(s) to try when starting the server. If provided, an error will be thrown if none of\n * the ports are available.\n *\n * If no ports are provided, the server will attempt to find an available port.\n */\n port?: number | number[];\n\n /**\n * The default path under the domain to use when opening the browser.\n * @default ''\n */\n defaultPath?: string;\n\n /**\n * The config settings for the https server.\n * Paths to files are accepted for 'ca', 'cert', 'key', and 'pfx' settings.\n * Everything else is passed directly to the https.createServer() method.\n * If not provided, the server will use http.\n */\n https?: true | HttpsConfig;\n\n /**\n * Whether to show the Cloudpack overlay (status badge and dialog) in the app UI.\n *\n * It's not recommended to change this unless the overlay is interfering with UI elements or tests\n * (and if it's only needed in a specific case, use the `--show-overlay <when>` CLI option).\n * @default 'always'\n */\n showOverlay?: 'always' | 'errors-only' | 'never';\n\n /**\n * @deprecated Moved to the root of the config.\n */\n routes?: ShorthandRoute[];\n}\n"]}
@@ -5,6 +5,10 @@ import type { Feature } from './Feature.js';
5
5
  export type Features = {
6
6
  [key in keyof typeof allFeatures]?: boolean;
7
7
  };
8
+ /**
9
+ * All valid feature names.
10
+ */
11
+ export type FeatureName = keyof typeof allFeatures;
8
12
  /**
9
13
  * A set of options for configuring the experience.
10
14
  * Features can be set to true to change the default behavior.
@@ -1 +1 @@
1
- {"version":3,"file":"allFeatures.d.ts","sourceRoot":"","sources":["../src/allFeatures.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;KAAG,GAAG,IAAI,MAAM,OAAO,WAAW,CAAC,CAAC,EAAE,OAAO;CAAE,CAAC;AAEvE;;;GAGG;AACH,eAAO,MAAM,WAAW;IAGtB,mHAAmH;uBAK9G,OAAO;IAEZ,2DAA2D;uBACmC,OAAO;IAErG,uCAAuC;uBACoC,OAAO;IAElF;;;OAGG;yBAKE,OAAO;IAEZ,8EAA8E;yBAIzE,OAAO;IAEZ;;OAEG;gCAGE,OAAO;IAEZ;;;OAGG;eAIE,OAAO;IAEZ,mFAAmF;yBAI9E,OAAO;IAEZ,sEAAsE;yBACqC,OAAO;IAElH,6FAA6F;4BAGxF,OAAO;IAEZ;;;OAGG;0BAKE,OAAO;IAEZ,sHAAsH;4BAKjH,OAAO;IAEZ,+GAA+G;yBAI1G,OAAO;IAEZ,+IAA+I;0BACvC,OAAO;IAE/G,sCAAsC;iBAC6B,OAAO;IAE1E,gDAAgD;0BACsC,OAAO;IAE7F,2EAA2E;wBAItE,OAAO;IAEZ,uDAAuD;mBAC+B,OAAO;CAI9F,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,EAIvB,QAAQ,CAAC"}
1
+ {"version":3,"file":"allFeatures.d.ts","sourceRoot":"","sources":["../src/allFeatures.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAE5C;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;KAAG,GAAG,IAAI,MAAM,OAAO,WAAW,CAAC,CAAC,EAAE,OAAO;CAAE,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,OAAO,WAAW,CAAC;AAEnD;;;GAGG;AACH,eAAO,MAAM,WAAW;IAGtB,mHAAmH;uBAK9G,OAAO;IAEZ,2DAA2D;uBACmC,OAAO;IAErG,uCAAuC;uBACoC,OAAO;IAElF;;;OAGG;yBAKE,OAAO;IAEZ,8EAA8E;yBAIzE,OAAO;IAEZ;;OAEG;gCAGE,OAAO;IAEZ;;;OAGG;eAIE,OAAO;IAEZ,mFAAmF;yBAI9E,OAAO;IAEZ,sEAAsE;yBACqC,OAAO;IAElH,6FAA6F;4BAGxF,OAAO;IAEZ;;;OAGG;0BAKE,OAAO;IAEZ,sHAAsH;4BAKjH,OAAO;IAEZ,+GAA+G;yBAI1G,OAAO;IAEZ,+IAA+I;0BACvC,OAAO;IAE/G,sCAAsC;iBAC6B,OAAO;IAE1E,gDAAgD;0BACsC,OAAO;IAE7F,2EAA2E;wBAItE,OAAO;IAEZ,uDAAuD;mBAC+B,OAAO;CAI9F,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,EAIvB,QAAQ,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"allFeatures.js","sourceRoot":"","sources":["../src/allFeatures.ts"],"names":[],"mappings":"AAOA;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,8FAA8F;IAE9F,mHAAmH;IACnH,iBAAiB,EAAE;QACjB,WAAW,EACT,8GAA8G;QAChH,OAAO,EAAE,IAAI;KACH;IAEZ,2DAA2D;IAC3D,iBAAiB,EAAE,EAAE,WAAW,EAAE,sDAAsD,EAAa;IAErG,uCAAuC;IACvC,iBAAiB,EAAE,EAAE,WAAW,EAAE,mCAAmC,EAAa;IAElF;;;OAGG;IACH,mBAAmB,EAAE;QACnB,WAAW,EACT,4IAA4I;QAC9I,OAAO,EAAE,IAAI;KACH;IAEZ,8EAA8E;IAC9E,mBAAmB,EAAE;QACnB,WAAW,EAAE,uEAAuE;QACpF,OAAO,EAAE,IAAI;KACH;IAEZ;;OAEG;IACH,0BAA0B,EAAE;QAC1B,WAAW,EAAE,oEAAoE;KACvE;IAEZ;;;OAGG;IACH,SAAS,EAAE;QACT,WAAW,EACT,iJAAiJ;KACzI;IAEZ,mFAAmF;IACnF,mBAAmB,EAAE;QACnB,WAAW,EAAE,6EAA6E;QAC1F,OAAO,EAAE,IAAI;KACH;IAEZ,sEAAsE;IACtE,mBAAmB,EAAE,EAAE,WAAW,EAAE,iEAAiE,EAAa;IAElH,6FAA6F;IAC7F,sBAAsB,EAAE;QACtB,WAAW,EAAE,wFAAwF;KAC3F;IAEZ;;;OAGG;IACH,oBAAoB,EAAE;QACpB,WAAW;QACT,0EAA0E;QAC1E,iKAAiK;KACzJ;IAEZ,sHAAsH;IACtH,sBAAsB,EAAE;QACtB,WAAW,EACT,iHAAiH;QACnH,OAAO,EAAE,IAAI;KACH;IAEZ,+GAA+G;IAC/G,mBAAmB,EAAE;QACnB,WAAW,EACT,0GAA0G;KAClG;IAEZ,+IAA+I;IAC/I,oBAAoB,EAAE,EAAE,WAAW,EAAE,6DAA6D,EAAa;IAE/G,sCAAsC;IACtC,WAAW,EAAE,EAAE,WAAW,EAAE,iCAAiC,EAAa;IAE1E,gDAAgD;IAChD,oBAAoB,EAAE,EAAE,WAAW,EAAE,2CAA2C,EAAa;IAE7F,2EAA2E;IAC3E,kBAAkB,EAAE;QAClB,WAAW,EAAE,sEAAsE;QACnF,OAAO,EAAE,IAAI;KACH;IAEZ,uDAAuD;IACvD,aAAa,EAAE,EAAE,WAAW,EAAE,kDAAkD,EAAa;IAE7F,iDAAiD;IACjD,oDAAoD;CACrD,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,WAAW,CAC/C,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC;KACxB,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;KACzC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CACrB,CAAC","sourcesContent":["import type { Feature } from './Feature.js';\n\n/**\n * Represents all features that can be enabled or disabled for Cloudpack.\n */\nexport type Features = { [key in keyof typeof allFeatures]?: boolean };\n\n/**\n * A set of options for configuring the experience.\n * Features can be set to true to change the default behavior.\n */\nexport const allFeatures = {\n // The comments provide intellisense, and the description strings are used in the help output.\n\n /** Automatically updates the generated config when an unknown import path is used during start (default: true). */\n autoUpdateEntries: {\n description:\n 'Automatically updates the generated config when an unknown import path is used during start (default: true).',\n default: true,\n } as Feature,\n\n /** Disables the generation of source-maps during build. */\n disableSourceMaps: { description: 'Disables the generation of source-maps during build.' } as Feature,\n\n /** Enabled cloud-hosted application */\n enableCloudHosted: { description: 'Enables cloud-hosted application.' } as Feature,\n\n /**\n * Enables support of import maps for workers.\n * To use this feature, the package with the worker must be bundled with webpack (default: true).\n */\n enableModuleWorkers: {\n description:\n 'Enables support of import maps for workers. To use this feature, the package with the worker must be bundled with webpack (default: true).',\n default: true,\n } as Feature,\n\n /** Enables the use of `@parcel/watcher` for file watching (default: true). */\n enableParcelWatcher: {\n description: 'Enables the use of @parcel/watcher for file watching (default: true).',\n default: true,\n } as Feature,\n\n /**\n * Enables downloading bundles from remote cache instead of bundling.\n */\n enableRemoteCacheDownloads: {\n description: 'Enables downloading bundles from remote cache instead of bundling.',\n } as Feature,\n\n /**\n * Enables server-side rendering (SSR) for the application, including Node import map support.\n * This is experimental and may not work in all cases.\n */\n enableSSR: {\n description:\n 'Enables server-side rendering (SSR) for the application, including Node import map support. This is experimental and may not work in all cases.',\n } as Feature,\n\n /** Enables the file watcher to be spawned in a forked process (default: true). */\n enableWatcherInFork: {\n description: 'Enables the file watcher to be spawned in a forked process (default: true).',\n default: true,\n } as Feature,\n\n /** Enables the preemptive enqueueing of dependencies during build. */\n enqueueDependencies: { description: 'Enables the preemptive enqueueing of dependencies during build.' } as Feature,\n\n /** Check for dynamic (async) imports with non-literal paths in bundle output during init. */\n evaluateDynamicImports: {\n description: 'Check for dynamic (async) imports with non-literal paths in bundle output during init.',\n } as Feature,\n\n /**\n * Excludes unused dependencies in the generated config during an init run.\n * This helps trim the dependency graph, reduce the import map, and speed up performance.\n */\n optimizeDependencies: {\n description:\n // breaking up this string causes an exception in ts-json-schema-generator\n 'Excludes unused dependencies in the generated config during an init run. This helps trim the dependency graph, reduce the import map, and speed up performance.',\n } as Feature,\n\n /** Enables relative resource paths to be used in import map paths when useSingleWebServer is true. (default: true) */\n relativeImportMapPaths: {\n description:\n 'Enables relative resource paths to be used in import map paths when useSingleWebServer is true. (default: true)',\n default: true,\n } as Feature,\n\n /** Creates null entries for unused exports in generated config so that they are not included when bundling. */\n removeUnusedExports: {\n description:\n 'Creates null entries for unused exports in generated config so that they are not included when bundling.',\n } as Feature,\n\n /** @deprecated Removed in favor of `resolve-web-extensions` bundler capability. Enables React Native type resolution of .web.ts extensions. */\n resolveWebExtensions: { description: 'Enables React Native type resolution of .web.ts extensions.' } as Feature,\n\n /** Enables the syncing of bundles. */\n syncBundles: { description: 'Enables the syncing of bundles.' } as Feature,\n\n /** Enables the syncing of internal packages. */\n syncInternalPackages: { description: 'Enables the syncing of internal packages.' } as Feature,\n\n /** Use a single server for both bundles and app assets (default: true). */\n useSingleWebServer: {\n description: 'Use a single server for both bundles and app assets (default: true).',\n default: true,\n } as Feature,\n\n /** Enables the verification of exports during init. */\n verifyExports: { description: 'Enables the verification of exports during init.' } as Feature,\n\n // Please add new features in alphabetical order!\n // Don't forget to add them to the doc site as well!\n};\n\n/**\n * Record of features that are enabled by default.\n */\nexport const defaultFeatures = Object.fromEntries(\n Object.entries(allFeatures)\n .filter(([_, feature]) => feature.default)\n .map(([name]) => [name, true]),\n) as Features;\n"]}
1
+ {"version":3,"file":"allFeatures.js","sourceRoot":"","sources":["../src/allFeatures.ts"],"names":[],"mappings":"AAYA;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,8FAA8F;IAE9F,mHAAmH;IACnH,iBAAiB,EAAE;QACjB,WAAW,EACT,8GAA8G;QAChH,OAAO,EAAE,IAAI;KACH;IAEZ,2DAA2D;IAC3D,iBAAiB,EAAE,EAAE,WAAW,EAAE,sDAAsD,EAAa;IAErG,uCAAuC;IACvC,iBAAiB,EAAE,EAAE,WAAW,EAAE,mCAAmC,EAAa;IAElF;;;OAGG;IACH,mBAAmB,EAAE;QACnB,WAAW,EACT,4IAA4I;QAC9I,OAAO,EAAE,IAAI;KACH;IAEZ,8EAA8E;IAC9E,mBAAmB,EAAE;QACnB,WAAW,EAAE,uEAAuE;QACpF,OAAO,EAAE,IAAI;KACH;IAEZ;;OAEG;IACH,0BAA0B,EAAE;QAC1B,WAAW,EAAE,oEAAoE;KACvE;IAEZ;;;OAGG;IACH,SAAS,EAAE;QACT,WAAW,EACT,iJAAiJ;KACzI;IAEZ,mFAAmF;IACnF,mBAAmB,EAAE;QACnB,WAAW,EAAE,6EAA6E;QAC1F,OAAO,EAAE,IAAI;KACH;IAEZ,sEAAsE;IACtE,mBAAmB,EAAE,EAAE,WAAW,EAAE,iEAAiE,EAAa;IAElH,6FAA6F;IAC7F,sBAAsB,EAAE;QACtB,WAAW,EAAE,wFAAwF;KAC3F;IAEZ;;;OAGG;IACH,oBAAoB,EAAE;QACpB,WAAW;QACT,0EAA0E;QAC1E,iKAAiK;KACzJ;IAEZ,sHAAsH;IACtH,sBAAsB,EAAE;QACtB,WAAW,EACT,iHAAiH;QACnH,OAAO,EAAE,IAAI;KACH;IAEZ,+GAA+G;IAC/G,mBAAmB,EAAE;QACnB,WAAW,EACT,0GAA0G;KAClG;IAEZ,+IAA+I;IAC/I,oBAAoB,EAAE,EAAE,WAAW,EAAE,6DAA6D,EAAa;IAE/G,sCAAsC;IACtC,WAAW,EAAE,EAAE,WAAW,EAAE,iCAAiC,EAAa;IAE1E,gDAAgD;IAChD,oBAAoB,EAAE,EAAE,WAAW,EAAE,2CAA2C,EAAa;IAE7F,2EAA2E;IAC3E,kBAAkB,EAAE;QAClB,WAAW,EAAE,sEAAsE;QACnF,OAAO,EAAE,IAAI;KACH;IAEZ,uDAAuD;IACvD,aAAa,EAAE,EAAE,WAAW,EAAE,kDAAkD,EAAa;IAE7F,iDAAiD;IACjD,oDAAoD;CACrD,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,WAAW,CAC/C,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC;KACxB,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC;KACzC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CACrB,CAAC","sourcesContent":["import type { Feature } from './Feature.js';\n\n/**\n * Represents all features that can be enabled or disabled for Cloudpack.\n */\nexport type Features = { [key in keyof typeof allFeatures]?: boolean };\n\n/**\n * All valid feature names.\n */\nexport type FeatureName = keyof typeof allFeatures;\n\n/**\n * A set of options for configuring the experience.\n * Features can be set to true to change the default behavior.\n */\nexport const allFeatures = {\n // The comments provide intellisense, and the description strings are used in the help output.\n\n /** Automatically updates the generated config when an unknown import path is used during start (default: true). */\n autoUpdateEntries: {\n description:\n 'Automatically updates the generated config when an unknown import path is used during start (default: true).',\n default: true,\n } as Feature,\n\n /** Disables the generation of source-maps during build. */\n disableSourceMaps: { description: 'Disables the generation of source-maps during build.' } as Feature,\n\n /** Enabled cloud-hosted application */\n enableCloudHosted: { description: 'Enables cloud-hosted application.' } as Feature,\n\n /**\n * Enables support of import maps for workers.\n * To use this feature, the package with the worker must be bundled with webpack (default: true).\n */\n enableModuleWorkers: {\n description:\n 'Enables support of import maps for workers. To use this feature, the package with the worker must be bundled with webpack (default: true).',\n default: true,\n } as Feature,\n\n /** Enables the use of `@parcel/watcher` for file watching (default: true). */\n enableParcelWatcher: {\n description: 'Enables the use of @parcel/watcher for file watching (default: true).',\n default: true,\n } as Feature,\n\n /**\n * Enables downloading bundles from remote cache instead of bundling.\n */\n enableRemoteCacheDownloads: {\n description: 'Enables downloading bundles from remote cache instead of bundling.',\n } as Feature,\n\n /**\n * Enables server-side rendering (SSR) for the application, including Node import map support.\n * This is experimental and may not work in all cases.\n */\n enableSSR: {\n description:\n 'Enables server-side rendering (SSR) for the application, including Node import map support. This is experimental and may not work in all cases.',\n } as Feature,\n\n /** Enables the file watcher to be spawned in a forked process (default: true). */\n enableWatcherInFork: {\n description: 'Enables the file watcher to be spawned in a forked process (default: true).',\n default: true,\n } as Feature,\n\n /** Enables the preemptive enqueueing of dependencies during build. */\n enqueueDependencies: { description: 'Enables the preemptive enqueueing of dependencies during build.' } as Feature,\n\n /** Check for dynamic (async) imports with non-literal paths in bundle output during init. */\n evaluateDynamicImports: {\n description: 'Check for dynamic (async) imports with non-literal paths in bundle output during init.',\n } as Feature,\n\n /**\n * Excludes unused dependencies in the generated config during an init run.\n * This helps trim the dependency graph, reduce the import map, and speed up performance.\n */\n optimizeDependencies: {\n description:\n // breaking up this string causes an exception in ts-json-schema-generator\n 'Excludes unused dependencies in the generated config during an init run. This helps trim the dependency graph, reduce the import map, and speed up performance.',\n } as Feature,\n\n /** Enables relative resource paths to be used in import map paths when useSingleWebServer is true. (default: true) */\n relativeImportMapPaths: {\n description:\n 'Enables relative resource paths to be used in import map paths when useSingleWebServer is true. (default: true)',\n default: true,\n } as Feature,\n\n /** Creates null entries for unused exports in generated config so that they are not included when bundling. */\n removeUnusedExports: {\n description:\n 'Creates null entries for unused exports in generated config so that they are not included when bundling.',\n } as Feature,\n\n /** @deprecated Removed in favor of `resolve-web-extensions` bundler capability. Enables React Native type resolution of .web.ts extensions. */\n resolveWebExtensions: { description: 'Enables React Native type resolution of .web.ts extensions.' } as Feature,\n\n /** Enables the syncing of bundles. */\n syncBundles: { description: 'Enables the syncing of bundles.' } as Feature,\n\n /** Enables the syncing of internal packages. */\n syncInternalPackages: { description: 'Enables the syncing of internal packages.' } as Feature,\n\n /** Use a single server for both bundles and app assets (default: true). */\n useSingleWebServer: {\n description: 'Use a single server for both bundles and app assets (default: true).',\n default: true,\n } as Feature,\n\n /** Enables the verification of exports during init. */\n verifyExports: { description: 'Enables the verification of exports during init.' } as Feature,\n\n // Please add new features in alphabetical order!\n // Don't forget to add them to the doc site as well!\n};\n\n/**\n * Record of features that are enabled by default.\n */\nexport const defaultFeatures = Object.fromEntries(\n Object.entries(allFeatures)\n .filter(([_, feature]) => feature.default)\n .map(([name]) => [name, true]),\n) as Features;\n"]}
package/lib/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { allFeatures, defaultFeatures, type Features } from './allFeatures.js';
1
+ export { allFeatures, defaultFeatures, type Features, type FeatureName } from './allFeatures.js';
2
2
  export type { GetPackageDefinitionOptions, PackageDefinitionTransform, PackageDefinitionTransformFactory, PackageDefinitionsCache, PackageImporterContext, SerializablePackageDefinitionsCache, } from './PackageDefinitionsCache.js';
3
3
  export type { LiteralOrString, PackageJson, PackageJsonCloudpackMeta, PackageJsonDependencies, PackageJsonExportCondition, PackageJsonExports, PackageJsonExportsObject, GeneratedExports, PackageJsonExportsValue, } from './PackageJson.js';
4
4
  export type { BundleContext } from './BundleContext.js';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC/E,YAAY,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,iCAAiC,EACjC,uBAAuB,EACvB,sBAAsB,EACtB,mCAAmC,GACpC,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,eAAe,EACf,WAAW,EACX,wBAAwB,EACxB,uBAAuB,EACvB,0BAA0B,EAC1B,kBAAkB,EAClB,wBAAwB,EACxB,gBAAgB,EAChB,uBAAuB,GACxB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,YAAY,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AACjF,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,YAAY,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,8BAA8B,EAAE,MAAM,yBAAyB,CAAC;AACtH,YAAY,EACV,eAAe,EACf,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,GACzB,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,cAAc,EACd,UAAU,EACV,aAAa,EACb,aAAa,EACb,KAAK,EACL,UAAU,EACV,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,cAAc,EACd,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,YAAY,EACV,iBAAiB,EACjB,wCAAwC,EACxC,mCAAmC,EACnC,0BAA0B,EAC1B,+BAA+B,EAC/B,yBAAyB,GAC1B,MAAM,wBAAwB,CAAC;AAChC,YAAY,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,oBAAoB,EACpB,4BAA4B,EAC5B,WAAW,EACX,mBAAmB,EACnB,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACjE,YAAY,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACjG,YAAY,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,iCAAiC,EACjC,uBAAuB,EACvB,sBAAsB,EACtB,mCAAmC,GACpC,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,eAAe,EACf,WAAW,EACX,wBAAwB,EACxB,uBAAuB,EACvB,0BAA0B,EAC1B,kBAAkB,EAClB,wBAAwB,EACxB,gBAAgB,EAChB,uBAAuB,GACxB,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,YAAY,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AACjF,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,YAAY,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,8BAA8B,EAAE,MAAM,yBAAyB,CAAC;AACtH,YAAY,EACV,eAAe,EACf,oBAAoB,EACpB,0BAA0B,EAC1B,wBAAwB,GACzB,MAAM,sBAAsB,CAAC;AAC9B,YAAY,EACV,cAAc,EACd,UAAU,EACV,aAAa,EACb,aAAa,EACb,KAAK,EACL,UAAU,EACV,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,cAAc,EACd,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,YAAY,EACV,iBAAiB,EACjB,wCAAwC,EACxC,mCAAmC,EACnC,0BAA0B,EAC1B,+BAA+B,EAC/B,yBAAyB,GAC1B,MAAM,wBAAwB,CAAC;AAChC,YAAY,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,YAAY,EACV,cAAc,EACd,qBAAqB,EACrB,oBAAoB,EACpB,4BAA4B,EAC5B,WAAW,EACX,mBAAmB,EACnB,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACjE,YAAY,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,YAAY,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAiB,MAAM,kBAAkB,CAAC;AA0D/E,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,YAAY,CAAC","sourcesContent":["export { allFeatures, defaultFeatures, type Features } from './allFeatures.js';\nexport type {\n GetPackageDefinitionOptions,\n PackageDefinitionTransform,\n PackageDefinitionTransformFactory,\n PackageDefinitionsCache,\n PackageImporterContext,\n SerializablePackageDefinitionsCache,\n} from './PackageDefinitionsCache.js';\nexport type {\n LiteralOrString,\n PackageJson,\n PackageJsonCloudpackMeta,\n PackageJsonDependencies,\n PackageJsonExportCondition,\n PackageJsonExports,\n PackageJsonExportsObject,\n GeneratedExports,\n PackageJsonExportsValue,\n} from './PackageJson.js';\nexport type { BundleContext } from './BundleContext.js';\nexport type { BundleMessage } from './BundleMessage.js';\nexport type { BundleMessageLocation } from './BundleMessageLocation.js';\nexport type { BundleMessageNote } from './BundleMessageNote.js';\nexport type { BundleMode } from './BundleMode.js';\nexport type { BundleOptions } from './BundleOptions.js';\nexport type { BundleOutputFile } from './BundleOutputFile.js';\nexport type { BundleResult } from './BundleResult.js';\nexport type { BundlerResult } from './BundlerResult.js';\nexport type { Bundler } from './Bundler.js';\nexport type { CloudpackConfig, CloudpackLinkConfig } from './CloudpackConfig.js';\nexport type { ServerConfig } from './ServerConfig.js';\nexport type { ExpandedSourcePath } from './ExpandedSourcePath.js';\nexport type { Feature } from './Feature.js';\nexport type { GeneratedConfig } from './GeneratedConfig.js';\nexport type { HttpsConfig } from './HttpsConfig.js';\nexport type { LinkOptions } from './LinkOptions.js';\nexport type { ModuleType } from './ModuleType.js';\nexport type { PackageHashesCache, PackageHashOptions, SerializablePackageHashesCache } from './PackageHashesCache.js';\nexport type {\n PackageSettings,\n PackageSettingsMatch,\n PackageSettingsMatchObject,\n GeneratedPackageSettings,\n} from './PackageSettings.js';\nexport type {\n BootstrapRoute,\n ProxyRoute,\n RedirectRoute,\n RenderedRoute,\n Route,\n RouteMatch,\n SharedRouteOptions,\n ShorthandRenderedRoute,\n ShorthandBootstrapRoute,\n ShorthandRoute,\n StaticRoute,\n} from './Route.js';\nexport {\n isBootstrapRoute,\n isProxyRoute,\n isRenderedRoute,\n isStaticRoute,\n isRedirectRoute,\n isShorthandBootstrapRoute,\n isShorthandRenderedRoute,\n} from './Route.js';\nexport type { TelemetryConfig } from './TelemetryConfig.js';\nexport type { AppConfig } from './AppConfig.js';\nexport type {\n BundlerCapability,\n InternalBundlerCapabilityImplementations,\n InternalBundlerCapabilitiesMetaData,\n BundlerCapabilitiesOptions,\n ExternalBundlerCapabilityModule,\n BundlerCapabilityFunction,\n} from './BundlerCapability.js';\nexport type { RemoteCacheConfig } from './RemoteCacheConfig.js';\nexport type {\n RenderFunction,\n RenderFunctionOptions,\n RenderFunctionResult,\n ExpandedRenderFunctionResult,\n RequestInfo,\n ServerEntryFunction,\n ServerEntryFunctionOptions,\n ServerEntryFunctionResult,\n} from './RenderFunction.js';\nexport type { Request, Response, RequestHandler } from 'express';\nexport type { Session } from './Session.js';\nexport type { ResolveMap } from './ResolveMap.js';\nexport type { ResolveMapEntry } from './ResolveMapEntry.js';\nexport type { LinkedPath } from './LinkedPath.js';\nexport type { ImportMap } from './ImportMap.js';\nexport type { UserPreferences } from './UserPreferences.js';\nexport type { TargetEnvironment } from './TargetEnvironment.js';\nexport type { NestedPartial } from './NestedPartial.js';\nexport type { WithOptional } from './WithOptional.js';\nexport type { WithRequired } from './WithRequired.js';\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAmC,MAAM,kBAAkB,CAAC;AA0DjG,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,aAAa,EACb,eAAe,EACf,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,YAAY,CAAC","sourcesContent":["export { allFeatures, defaultFeatures, type Features, type FeatureName } from './allFeatures.js';\nexport type {\n GetPackageDefinitionOptions,\n PackageDefinitionTransform,\n PackageDefinitionTransformFactory,\n PackageDefinitionsCache,\n PackageImporterContext,\n SerializablePackageDefinitionsCache,\n} from './PackageDefinitionsCache.js';\nexport type {\n LiteralOrString,\n PackageJson,\n PackageJsonCloudpackMeta,\n PackageJsonDependencies,\n PackageJsonExportCondition,\n PackageJsonExports,\n PackageJsonExportsObject,\n GeneratedExports,\n PackageJsonExportsValue,\n} from './PackageJson.js';\nexport type { BundleContext } from './BundleContext.js';\nexport type { BundleMessage } from './BundleMessage.js';\nexport type { BundleMessageLocation } from './BundleMessageLocation.js';\nexport type { BundleMessageNote } from './BundleMessageNote.js';\nexport type { BundleMode } from './BundleMode.js';\nexport type { BundleOptions } from './BundleOptions.js';\nexport type { BundleOutputFile } from './BundleOutputFile.js';\nexport type { BundleResult } from './BundleResult.js';\nexport type { BundlerResult } from './BundlerResult.js';\nexport type { Bundler } from './Bundler.js';\nexport type { CloudpackConfig, CloudpackLinkConfig } from './CloudpackConfig.js';\nexport type { ServerConfig } from './ServerConfig.js';\nexport type { ExpandedSourcePath } from './ExpandedSourcePath.js';\nexport type { Feature } from './Feature.js';\nexport type { GeneratedConfig } from './GeneratedConfig.js';\nexport type { HttpsConfig } from './HttpsConfig.js';\nexport type { LinkOptions } from './LinkOptions.js';\nexport type { ModuleType } from './ModuleType.js';\nexport type { PackageHashesCache, PackageHashOptions, SerializablePackageHashesCache } from './PackageHashesCache.js';\nexport type {\n PackageSettings,\n PackageSettingsMatch,\n PackageSettingsMatchObject,\n GeneratedPackageSettings,\n} from './PackageSettings.js';\nexport type {\n BootstrapRoute,\n ProxyRoute,\n RedirectRoute,\n RenderedRoute,\n Route,\n RouteMatch,\n SharedRouteOptions,\n ShorthandRenderedRoute,\n ShorthandBootstrapRoute,\n ShorthandRoute,\n StaticRoute,\n} from './Route.js';\nexport {\n isBootstrapRoute,\n isProxyRoute,\n isRenderedRoute,\n isStaticRoute,\n isRedirectRoute,\n isShorthandBootstrapRoute,\n isShorthandRenderedRoute,\n} from './Route.js';\nexport type { TelemetryConfig } from './TelemetryConfig.js';\nexport type { AppConfig } from './AppConfig.js';\nexport type {\n BundlerCapability,\n InternalBundlerCapabilityImplementations,\n InternalBundlerCapabilitiesMetaData,\n BundlerCapabilitiesOptions,\n ExternalBundlerCapabilityModule,\n BundlerCapabilityFunction,\n} from './BundlerCapability.js';\nexport type { RemoteCacheConfig } from './RemoteCacheConfig.js';\nexport type {\n RenderFunction,\n RenderFunctionOptions,\n RenderFunctionResult,\n ExpandedRenderFunctionResult,\n RequestInfo,\n ServerEntryFunction,\n ServerEntryFunctionOptions,\n ServerEntryFunctionResult,\n} from './RenderFunction.js';\nexport type { Request, Response, RequestHandler } from 'express';\nexport type { Session } from './Session.js';\nexport type { ResolveMap } from './ResolveMap.js';\nexport type { ResolveMapEntry } from './ResolveMapEntry.js';\nexport type { LinkedPath } from './LinkedPath.js';\nexport type { ImportMap } from './ImportMap.js';\nexport type { UserPreferences } from './UserPreferences.js';\nexport type { TargetEnvironment } from './TargetEnvironment.js';\nexport type { NestedPartial } from './NestedPartial.js';\nexport type { WithOptional } from './WithOptional.js';\nexport type { WithRequired } from './WithRequired.js';\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ms-cloudpack/common-types",
3
- "version": "0.27.3",
3
+ "version": "0.27.4",
4
4
  "description": "Common types for Cloudpack.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -14,7 +14,7 @@
14
14
  }
15
15
  },
16
16
  "dependencies": {
17
- "@ms-cloudpack/common-types-browser": "^0.6.2",
17
+ "@ms-cloudpack/common-types-browser": "^0.6.3",
18
18
  "@types/express": "^4.17.16"
19
19
  },
20
20
  "devDependencies": {
@@ -124,7 +124,8 @@
124
124
  }
125
125
  }
126
126
  ],
127
- "description": "The domain name of the server. If multiple domains are specified, the first one will be used as the primary domain used when opening the browser."
127
+ "description": "The domain name of the server. If multiple domains are specified, the first one will be used as the primary domain used when opening the browser.",
128
+ "default": "localhost"
128
129
  },
129
130
  "requestHeaders": {
130
131
  "type": "object",
@@ -149,7 +150,8 @@
149
150
  },
150
151
  "defaultPath": {
151
152
  "type": "string",
152
- "description": "The default path to use when opening the browser."
153
+ "description": "The default path under the domain to use when opening the browser.",
154
+ "default": ""
153
155
  },
154
156
  "https": {
155
157
  "anyOf": [
@@ -163,6 +165,16 @@
163
165
  ],
164
166
  "description": "The config settings for the https server. Paths to files are accepted for 'ca', 'cert', 'key', and 'pfx' settings. Everything else is passed directly to the https.createServer() method. If not provided, the server will use http."
165
167
  },
168
+ "showOverlay": {
169
+ "type": "string",
170
+ "enum": [
171
+ "always",
172
+ "errors-only",
173
+ "never"
174
+ ],
175
+ "description": "Whether to show the Cloudpack overlay (status badge and dialog) in the app UI.\n\nIt's not recommended to change this unless the overlay is interfering with UI elements or tests (and if it's only needed in a specific case, use the `--show-overlay <when>` CLI option).",
176
+ "default": "always"
177
+ },
166
178
  "routes": {
167
179
  "type": "array",
168
180
  "items": {
@@ -125,7 +125,8 @@
125
125
  }
126
126
  }
127
127
  ],
128
- "description": "The domain name of the server. If multiple domains are specified, the first one will be used as the primary domain used when opening the browser."
128
+ "description": "The domain name of the server. If multiple domains are specified, the first one will be used as the primary domain used when opening the browser.",
129
+ "default": "localhost"
129
130
  },
130
131
  "requestHeaders": {
131
132
  "type": "object",
@@ -150,7 +151,8 @@
150
151
  },
151
152
  "defaultPath": {
152
153
  "type": "string",
153
- "description": "The default path to use when opening the browser."
154
+ "description": "The default path under the domain to use when opening the browser.",
155
+ "default": ""
154
156
  },
155
157
  "https": {
156
158
  "anyOf": [
@@ -164,6 +166,16 @@
164
166
  ],
165
167
  "description": "The config settings for the https server. Paths to files are accepted for 'ca', 'cert', 'key', and 'pfx' settings. Everything else is passed directly to the https.createServer() method. If not provided, the server will use http."
166
168
  },
169
+ "showOverlay": {
170
+ "type": "string",
171
+ "enum": [
172
+ "always",
173
+ "errors-only",
174
+ "never"
175
+ ],
176
+ "description": "Whether to show the Cloudpack overlay (status badge and dialog) in the app UI.\n\nIt's not recommended to change this unless the overlay is interfering with UI elements or tests (and if it's only needed in a specific case, use the `--show-overlay <when>` CLI option).",
177
+ "default": "always"
178
+ },
167
179
  "routes": {
168
180
  "type": "array",
169
181
  "items": {