@ms-cloudpack/common-types 0.24.9 → 0.24.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.
@@ -4,6 +4,7 @@ import type { PackageSettings } from './PackageSettings.js';
4
4
  import type { RemoteCacheConfig } from './RemoteCacheConfig.js';
5
5
  import type { ShorthandRoute } from './Route.js';
6
6
  import type { TelemetryConfig } from './TelemetryConfig.js';
7
+ import type { DefineFlags } from '@ms-cloudpack/common-types-browser';
7
8
  /**
8
9
  * Per-application user-provided configuration for Cloudpack.
9
10
  */
@@ -80,5 +81,9 @@ export interface AppConfig {
80
81
  * - Value is the import specifier (local path or package name) for the capability module.
81
82
  */
82
83
  bundlerCapabilitiesRegistry?: Record<string, string>;
84
+ /**
85
+ * Key value pairs that will be used to define global variables in the runtime.
86
+ */
87
+ define?: DefineFlags;
83
88
  }
84
89
  //# sourceMappingURL=AppConfig.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"AppConfig.d.ts","sourceRoot":"","sources":["../src/AppConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,eAAe,CAAC,EAAE,eAAe,EAAE,CAAC;IAEpC;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAEjC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAEhC;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAE1B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtD"}
1
+ {"version":3,"file":"AppConfig.d.ts","sourceRoot":"","sources":["../src/AppConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,eAAe,CAAC,EAAE,eAAe,EAAE,CAAC;IAEpC;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAEjC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAEhC;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;IAE1B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAErD;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB"}
@@ -1 +1 @@
1
- {"version":3,"file":"AppConfig.js","sourceRoot":"","sources":["../src/AppConfig.ts"],"names":[],"mappings":"","sourcesContent":["import type { ServerConfig } from './ServerConfig.js';\nimport type { Features } from './Features.js';\nimport type { PackageSettings } from './PackageSettings.js';\nimport type { RemoteCacheConfig } from './RemoteCacheConfig.js';\nimport type { ShorthandRoute } from './Route.js';\nimport type { TelemetryConfig } from './TelemetryConfig.js';\n\n/**\n * Per-application user-provided configuration for Cloudpack.\n */\nexport interface AppConfig {\n /**\n * Extend the configuration from another file: either an import path or a relative path\n * (resolved from the config file's location).\n *\n * If an array, later files will take precedence when merging.\n * (The user config always takes precedence over any extended config.)\n *\n * Config merging approach:\n * - Objects will be deeply merged.\n * - Primitive values will be overwritten.\n * - Arrays will be overwritten, EXCEPT for `packageSettings`, which will be concatenated.\n */\n extends?: string | string[];\n\n /**\n * @deprecated - use \"server\" instead.\n */\n devServer?: ServerConfig;\n\n /**\n * Configuration for the dev server.\n */\n server?: ServerConfig;\n\n /**\n * Configuration for telemetry.\n */\n telemetry?: TelemetryConfig;\n\n /**\n * Enable additional Cloudpack features.\n */\n features?: Features;\n\n /**\n * Help message to display when Cloudpack starts up.\n */\n helpMessage?: string;\n\n /**\n * Settings to customize how packages are bundled.\n * Later settings in the array take precedence over earlier ones.\n */\n packageSettings?: PackageSettings[];\n\n /**\n * Commands to execute prior to Cloudpack bundling.\n * Each entry has a command and an array of arguments: `['command', ['arg1', 'arg2']]`.\n */\n dependsOn?: [string, string[]][];\n\n /**\n * Glob pattern to match `patch-package` patch files, relative to the project root\n * (usually the same as the repository root).\n * @default \"patches/*.patch\"\n */\n patchFilesGlobPattern?: string;\n\n /**\n * Azure Blob Storage configuration for remote cache - uploading and downloading packages\n * via `cloudpack sync`. If this is not provided, the remote cache will not be used.\n */\n remoteCache?: RemoteCacheConfig;\n\n /**\n * Defines what routes to support from the app server, and which scripts will be loaded\n * for each.\n */\n routes?: ShorthandRoute[];\n\n /**\n * Ignore these package names when calculating included and excluded dependencies.\n * This is mainly intended for helper packages such as `tslib`.\n *\n * Include `...` to merge with the default list (`tslib` and `@babel/runtime` as of writing).\n */\n neverExcludeDependencies?: string[];\n\n /**\n * Key value pairs of external bundler capabilities that can be enabled in the package settings.\n * - Key is the name of the capability, which will be used in `PackageSettings.bundlerCapabilities`.\n * - Value is the import specifier (local path or package name) for the capability module.\n */\n bundlerCapabilitiesRegistry?: Record<string, string>;\n}\n"]}
1
+ {"version":3,"file":"AppConfig.js","sourceRoot":"","sources":["../src/AppConfig.ts"],"names":[],"mappings":"","sourcesContent":["import type { ServerConfig } from './ServerConfig.js';\nimport type { Features } from './Features.js';\nimport type { PackageSettings } from './PackageSettings.js';\nimport type { RemoteCacheConfig } from './RemoteCacheConfig.js';\nimport type { ShorthandRoute } from './Route.js';\nimport type { TelemetryConfig } from './TelemetryConfig.js';\nimport type { DefineFlags } from '@ms-cloudpack/common-types-browser';\n\n/**\n * Per-application user-provided configuration for Cloudpack.\n */\nexport interface AppConfig {\n /**\n * Extend the configuration from another file: either an import path or a relative path\n * (resolved from the config file's location).\n *\n * If an array, later files will take precedence when merging.\n * (The user config always takes precedence over any extended config.)\n *\n * Config merging approach:\n * - Objects will be deeply merged.\n * - Primitive values will be overwritten.\n * - Arrays will be overwritten, EXCEPT for `packageSettings`, which will be concatenated.\n */\n extends?: string | string[];\n\n /**\n * @deprecated - use \"server\" instead.\n */\n devServer?: ServerConfig;\n\n /**\n * Configuration for the dev server.\n */\n server?: ServerConfig;\n\n /**\n * Configuration for telemetry.\n */\n telemetry?: TelemetryConfig;\n\n /**\n * Enable additional Cloudpack features.\n */\n features?: Features;\n\n /**\n * Help message to display when Cloudpack starts up.\n */\n helpMessage?: string;\n\n /**\n * Settings to customize how packages are bundled.\n * Later settings in the array take precedence over earlier ones.\n */\n packageSettings?: PackageSettings[];\n\n /**\n * Commands to execute prior to Cloudpack bundling.\n * Each entry has a command and an array of arguments: `['command', ['arg1', 'arg2']]`.\n */\n dependsOn?: [string, string[]][];\n\n /**\n * Glob pattern to match `patch-package` patch files, relative to the project root\n * (usually the same as the repository root).\n * @default \"patches/*.patch\"\n */\n patchFilesGlobPattern?: string;\n\n /**\n * Azure Blob Storage configuration for remote cache - uploading and downloading packages\n * via `cloudpack sync`. If this is not provided, the remote cache will not be used.\n */\n remoteCache?: RemoteCacheConfig;\n\n /**\n * Defines what routes to support from the app server, and which scripts will be loaded\n * for each.\n */\n routes?: ShorthandRoute[];\n\n /**\n * Ignore these package names when calculating included and excluded dependencies.\n * This is mainly intended for helper packages such as `tslib`.\n *\n * Include `...` to merge with the default list (`tslib` and `@babel/runtime` as of writing).\n */\n neverExcludeDependencies?: string[];\n\n /**\n * Key value pairs of external bundler capabilities that can be enabled in the package settings.\n * - Key is the name of the capability, which will be used in `PackageSettings.bundlerCapabilities`.\n * - Value is the import specifier (local path or package name) for the capability module.\n */\n bundlerCapabilitiesRegistry?: Record<string, string>;\n\n /**\n * Key value pairs that will be used to define global variables in the runtime.\n */\n define?: DefineFlags;\n}\n"]}
@@ -26,6 +26,8 @@ export interface BundleOptions extends Pick<PackageSettings, 'bundler' | 'bundle
26
26
  * Target environment for the bundle.
27
27
  *
28
28
  * WARNING: `'node'` environment is a work in progress and may not be fully supported.
29
+ * Also, currently it causes package to be bundled in **production mode** since import maps
30
+ * aren't supported in Node yet.
29
31
  */
30
32
  targetEnvironment: TargetEnvironment;
31
33
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"BundleOptions.d.ts","sourceRoot":"","sources":["../src/BundleOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,aACf,SAAQ,IAAI,CACV,eAAe,EACb,SAAS,GACT,gBAAgB,GAChB,gBAAgB,GAChB,wBAAwB,GACxB,qBAAqB,GACrB,sBAAsB,CACzB;IACD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC;;;;OAIG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IAErC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB"}
1
+ {"version":3,"file":"BundleOptions.d.ts","sourceRoot":"","sources":["../src/BundleOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,aACf,SAAQ,IAAI,CACV,eAAe,EACb,SAAS,GACT,gBAAgB,GAChB,gBAAgB,GAChB,wBAAwB,GACxB,qBAAqB,GACrB,sBAAsB,CACzB;IACD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEhC;;;;;;OAMG;IACH,iBAAiB,EAAE,iBAAiB,CAAC;IAErC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB"}
@@ -1 +1 @@
1
- {"version":3,"file":"BundleOptions.js","sourceRoot":"","sources":["../src/BundleOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PackageSettings } from './PackageSettings.js';\nimport type { TargetEnvironment } from './TargetEnvironment.js';\n\n/**\n * Options for creating bundles with a bundler plugin.\n */\nexport interface BundleOptions\n extends Pick<\n PackageSettings,\n | 'bundler'\n | 'bundlerOptions'\n | 'dynamicImports'\n | 'ignoredBundlerWarnings'\n | 'bundlerCapabilities'\n | 'unsafeCjsExportNames'\n > {\n /**\n * The absolute input path for the entry points.\n */\n inputPath: string;\n\n /**\n * Mapping from output file to source file paths.\n * - Key is the output file path, relative to `outputPath` (with forward slashes and leading `./`)\n * and *without* the extension (unless it's non-JS).\n * - Value is the input file path, relative to `inputPath` (with forward slashes and leading `./`)\n * including the extension.\n *\n * For example:\n * `{ './lib/index': './src/index.js' }`\n *\n * Note: Non-javascript extensions, such as `.css` or `.scss`, will not be stripped from the key.\n * This is to ensure the bundler keeps the original extension intact and adds `.js` after it.\n */\n entries: Record<string, string>;\n\n /**\n * Target environment for the bundle.\n *\n * WARNING: `'node'` environment is a work in progress and may not be fully supported.\n */\n targetEnvironment: TargetEnvironment;\n\n /**\n * The output path for bundled files. This can be either relative to `inputPath`, or absolute.\n * Defaults to `inputPath`.\n */\n outputPath?: string;\n\n /**\n * List of dependencies which should be externalized.\n */\n external?: string[];\n\n /**\n * List of dependencies which should be inlined.\n */\n inlined?: string[];\n\n /**\n * If true, minify the output.\n */\n minify?: boolean;\n\n /**\n * If true, will generate sourcemap files for the output. This has a tax on performance.\n * Defaults to true unless the `disableSourceMaps` feature is enabled.\n * (To set a bundler-specific sourcemap option, use `bundlerOptions`.)\n */\n sourcemap?: boolean;\n\n /**\n * If true, the bundler is expected to stay alive and take requests to rebuild on demand. File watching is\n * managed at a higher layer. When we no longer care about incremental bundling, the bundler will receive a call\n * to `dispose` if returned.\n */\n incremental?: boolean;\n}\n"]}
1
+ {"version":3,"file":"BundleOptions.js","sourceRoot":"","sources":["../src/BundleOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PackageSettings } from './PackageSettings.js';\nimport type { TargetEnvironment } from './TargetEnvironment.js';\n\n/**\n * Options for creating bundles with a bundler plugin.\n */\nexport interface BundleOptions\n extends Pick<\n PackageSettings,\n | 'bundler'\n | 'bundlerOptions'\n | 'dynamicImports'\n | 'ignoredBundlerWarnings'\n | 'bundlerCapabilities'\n | 'unsafeCjsExportNames'\n > {\n /**\n * The absolute input path for the entry points.\n */\n inputPath: string;\n\n /**\n * Mapping from output file to source file paths.\n * - Key is the output file path, relative to `outputPath` (with forward slashes and leading `./`)\n * and *without* the extension (unless it's non-JS).\n * - Value is the input file path, relative to `inputPath` (with forward slashes and leading `./`)\n * including the extension.\n *\n * For example:\n * `{ './lib/index': './src/index.js' }`\n *\n * Note: Non-javascript extensions, such as `.css` or `.scss`, will not be stripped from the key.\n * This is to ensure the bundler keeps the original extension intact and adds `.js` after it.\n */\n entries: Record<string, string>;\n\n /**\n * Target environment for the bundle.\n *\n * WARNING: `'node'` environment is a work in progress and may not be fully supported.\n * Also, currently it causes package to be bundled in **production mode** since import maps\n * aren't supported in Node yet.\n */\n targetEnvironment: TargetEnvironment;\n\n /**\n * The output path for bundled files. This can be either relative to `inputPath`, or absolute.\n * Defaults to `inputPath`.\n */\n outputPath?: string;\n\n /**\n * List of dependencies which should be externalized.\n */\n external?: string[];\n\n /**\n * List of dependencies which should be inlined.\n */\n inlined?: string[];\n\n /**\n * If true, minify the output.\n */\n minify?: boolean;\n\n /**\n * If true, will generate sourcemap files for the output. This has a tax on performance.\n * Defaults to true unless the `disableSourceMaps` feature is enabled.\n * (To set a bundler-specific sourcemap option, use `bundlerOptions`.)\n */\n sourcemap?: boolean;\n\n /**\n * If true, the bundler is expected to stay alive and take requests to rebuild on demand. File watching is\n * managed at a higher layer. When we no longer care about incremental bundling, the bundler will receive a call\n * to `dispose` if returned.\n */\n incremental?: boolean;\n}\n"]}
@@ -4,9 +4,9 @@
4
4
  *
5
5
  * - `TConfig` is the type of the bundler's config object. (ie: `WebpackConfiguration`, `OriBuildOptions`, etc)
6
6
  * - `TOptions` is the type of the options object that's passed to the capability. (ie: `{ banner: string }`
7
- * or any other type that the capability needs when enabled)
7
+ * or any other type that the capability needs when enabled) or a boolean to indicate if the capability is enabled.
8
8
  */
9
- export type BundlerCapabilityFunction<TConfig, TOptions extends object> = (config: TConfig, options: TOptions) => TConfig;
9
+ export type BundlerCapabilityFunction<TConfig, TOptions extends object | boolean> = (config: TConfig, options: TOptions) => TConfig;
10
10
  /**
11
11
  * A bundler capability is a feature that can be enabled for a package to modify the bundling process.
12
12
  *
@@ -36,17 +36,22 @@ export type InternalBundlerCapabilities = {
36
36
  /**
37
37
  * Bundler capability to support Density externals.
38
38
  * This is not a real capability, it's just an indicator that a package needs to use density post-bundle task.
39
- * Since there is no actual way to execute post-budle tasks, I'm using this as a workaround.
39
+ * Since there is no actual way to execute post-bundle tasks, I'm using this as a workaround.
40
40
  * This will be removed once we have a proper way to execute post-bundle tasks with the plugins.
41
41
  * Options: object is empty because it's just an indicator. No options are needed.
42
42
  */
43
- density: object;
43
+ density: boolean;
44
44
  /**
45
45
  * Adds aliases to externalized packages.
46
46
  */
47
47
  alias: {
48
48
  [key: string]: string;
49
49
  };
50
+ /**
51
+ * Enables React Native type resolution of .web.ts extensions.
52
+ * Options: object is empty because it's just an indicator. No options are needed.
53
+ */
54
+ 'resolve-web-extensions': boolean;
50
55
  };
51
56
  /**
52
57
  * This is the type that's being used `PackageSettings` to enable/disable bundler capabilities.
@@ -54,9 +59,9 @@ export type InternalBundlerCapabilities = {
54
59
  * - Value: options object to configure the capability, or false to disable it
55
60
  */
56
61
  export type InternalBundlerCapabilitiesOptions = {
57
- [key in keyof InternalBundlerCapabilities]?: InternalBundlerCapabilities[key] | false;
62
+ [key in keyof InternalBundlerCapabilities]?: InternalBundlerCapabilities[key] | boolean;
58
63
  };
59
- type ExternalBundlerCapabilitiesOptions = Record<string, object | false>;
64
+ type ExternalBundlerCapabilitiesOptions = Record<string, object | boolean>;
60
65
  /**
61
66
  * Options used in `PackageSettings` to configure or disable bundler capabilities.
62
67
  * - Key: capability name, either internal (Cloudpack-provided) or external (as specified in
@@ -1 +1 @@
1
- {"version":3,"file":"BundlerCapability.d.ts","sourceRoot":"","sources":["../src/BundlerCapability.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,yBAAyB,CAAC,OAAO,EAAE,QAAQ,SAAS,MAAM,IAAI,CACxE,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,QAAQ,KACd,OAAO,CAAC;AAEb;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAAC,QAAQ,SAAS,MAAM,IAAI;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE;QACf,CAAC,OAAO,EAAE,MAAM,GAAG,yBAAyB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;KACjE,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;OAGG;IACH,cAAc,EAAE;QAAE,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAEzC;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG;KAC9C,GAAG,IAAI,MAAM,2BAA2B,CAAC,CAAC,EAAE,2BAA2B,CAAC,GAAG,CAAC,GAAG,KAAK;CACtF,CAAC;AAEF,KAAK,kCAAkC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,KAAK,CAAC,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,GAAG,kCAAkC,GAAG,kCAAkC,CAAC;AAEjH;;;;GAIG;AACH,MAAM,MAAM,mCAAmC,GAAG;KAC/C,GAAG,IAAI,MAAM,2BAA2B,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;CAC3F,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wCAAwC,CAAC,OAAO,IAAI;KAC7D,GAAG,IAAI,MAAM,2BAA2B,GAAG,yBAAyB,CAAC,OAAO,EAAE,2BAA2B,CAAC,GAAG,CAAC,CAAC;CACjH,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,+BAA+B,CAAC,OAAO,SAAS,MAAM,IAAI;IACpE,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;CACrC,CAAC"}
1
+ {"version":3,"file":"BundlerCapability.d.ts","sourceRoot":"","sources":["../src/BundlerCapability.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,yBAAyB,CAAC,OAAO,EAAE,QAAQ,SAAS,MAAM,GAAG,OAAO,IAAI,CAClF,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,QAAQ,KACd,OAAO,CAAC;AAEb;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,CAAC,QAAQ,SAAS,MAAM,IAAI;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE;QACf,CAAC,OAAO,EAAE,MAAM,GAAG,yBAAyB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;KACjE,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;OAGG;IACH,cAAc,EAAE;QAAE,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAEzC;;;;;;OAMG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE;QACL,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KACvB,CAAC;IAEF;;;OAGG;IACH,wBAAwB,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG;KAC9C,GAAG,IAAI,MAAM,2BAA2B,CAAC,CAAC,EAAE,2BAA2B,CAAC,GAAG,CAAC,GAAG,OAAO;CACxF,CAAC;AAEF,KAAK,kCAAkC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC;AAE3E;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,GAAG,kCAAkC,GAAG,kCAAkC,CAAC;AAEjH;;;;GAIG;AACH,MAAM,MAAM,mCAAmC,GAAG;KAC/C,GAAG,IAAI,MAAM,2BAA2B,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;CAC3F,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wCAAwC,CAAC,OAAO,IAAI;KAC7D,GAAG,IAAI,MAAM,2BAA2B,GAAG,yBAAyB,CAAC,OAAO,EAAE,2BAA2B,CAAC,GAAG,CAAC,CAAC;CACjH,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,+BAA+B,CAAC,OAAO,SAAS,MAAM,IAAI;IACpE,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;CACrC,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"BundlerCapability.js","sourceRoot":"","sources":["../src/BundlerCapability.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A function that takes a config object and options object and returns a new config object.\n * This is used to implement a bundler capability.\n *\n * - `TConfig` is the type of the bundler's config object. (ie: `WebpackConfiguration`, `OriBuildOptions`, etc)\n * - `TOptions` is the type of the options object that's passed to the capability. (ie: `{ banner: string }`\n * or any other type that the capability needs when enabled)\n */\nexport type BundlerCapabilityFunction<TConfig, TOptions extends object> = (\n config: TConfig,\n options: TOptions,\n) => TConfig;\n\n/**\n * A bundler capability is a feature that can be enabled for a package to modify the bundling process.\n *\n * `TOptions` is the type of the options object that's passed to the capability. (ie: `{ banner: string }`\n * or any other type that the capability needs when enabled)\n */\nexport type BundlerCapability<TOptions extends object> = {\n name: string;\n description: string;\n implementations: {\n [bundler: string]: BundlerCapabilityFunction<unknown, TOptions>;\n };\n};\n\n/**\n * This is the list of the bundler capabilities that cloudpack provides.\n * - key: The name of the capability which will be used in the cloudpack config to enable the capability\n * - value: Options object which will be passed to the capability function\n */\nexport type InternalBundlerCapabilities = {\n /**\n * Inlines assets into the bundle.\n * Options: List of file extensions to inline. Do not include the leading dot.\n */\n 'asset-inline': { extensions: string[] };\n\n /**\n * Bundler capability to support Density externals.\n * This is not a real capability, it's just an indicator that a package needs to use density post-bundle task.\n * Since there is no actual way to execute post-budle tasks, I'm using this as a workaround.\n * This will be removed once we have a proper way to execute post-bundle tasks with the plugins.\n * Options: object is empty because it's just an indicator. No options are needed.\n */\n density: object;\n\n /**\n * Adds aliases to externalized packages.\n */\n alias: {\n [key: string]: string;\n };\n};\n\n/**\n * This is the type that's being used `PackageSettings` to enable/disable bundler capabilities.\n * - Key: internal capability name\n * - Value: options object to configure the capability, or false to disable it\n */\nexport type InternalBundlerCapabilitiesOptions = {\n [key in keyof InternalBundlerCapabilities]?: InternalBundlerCapabilities[key] | false;\n};\n\ntype ExternalBundlerCapabilitiesOptions = Record<string, object | false>;\n\n/**\n * Options used in `PackageSettings` to configure or disable bundler capabilities.\n * - Key: capability name, either internal (Cloudpack-provided) or external (as specified in\n * `AppConfig.bundlerCapabilitiesRegistry`)\n * - Value: options object to configure the capability, or false to disable it.\n */\nexport type BundlerCapabilitiesOptions = InternalBundlerCapabilitiesOptions & ExternalBundlerCapabilitiesOptions;\n\n/**\n * Metadata for the bundler capabilities that cloudpack provides.\n * - Key: capability name\n * - Value: metadata object with description\n */\nexport type InternalBundlerCapabilitiesMetaData = {\n [key in keyof InternalBundlerCapabilities]: Pick<BundlerCapability<object>, 'description'>;\n};\n\n/**\n * This is a bundler specific implementation of the internal bundler capabilities.\n * It's a mapping from the capability name to the capability function.\n *\n * `TConfig` is the type of the bundler's config object. (ie: `WebpackConfiguration`, `OriBuildOptions`, etc)\n */\nexport type InternalBundlerCapabilityImplementations<TConfig> = {\n [key in keyof InternalBundlerCapabilities]: BundlerCapabilityFunction<TConfig, InternalBundlerCapabilities[key]>;\n};\n\n/**\n * This is the type of the external bundler capability module that's being imported.\n *\n * `TConfig` is the type of the bundler's config object. (ie: `WebpackConfiguration`, `OriBuildOptions`, etc)\n */\nexport type ExternalBundlerCapabilityModule<TConfig extends object> = {\n default: BundlerCapability<TConfig>;\n};\n"]}
1
+ {"version":3,"file":"BundlerCapability.js","sourceRoot":"","sources":["../src/BundlerCapability.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A function that takes a config object and options object and returns a new config object.\n * This is used to implement a bundler capability.\n *\n * - `TConfig` is the type of the bundler's config object. (ie: `WebpackConfiguration`, `OriBuildOptions`, etc)\n * - `TOptions` is the type of the options object that's passed to the capability. (ie: `{ banner: string }`\n * or any other type that the capability needs when enabled) or a boolean to indicate if the capability is enabled.\n */\nexport type BundlerCapabilityFunction<TConfig, TOptions extends object | boolean> = (\n config: TConfig,\n options: TOptions,\n) => TConfig;\n\n/**\n * A bundler capability is a feature that can be enabled for a package to modify the bundling process.\n *\n * `TOptions` is the type of the options object that's passed to the capability. (ie: `{ banner: string }`\n * or any other type that the capability needs when enabled)\n */\nexport type BundlerCapability<TOptions extends object> = {\n name: string;\n description: string;\n implementations: {\n [bundler: string]: BundlerCapabilityFunction<unknown, TOptions>;\n };\n};\n\n/**\n * This is the list of the bundler capabilities that cloudpack provides.\n * - key: The name of the capability which will be used in the cloudpack config to enable the capability\n * - value: Options object which will be passed to the capability function\n */\nexport type InternalBundlerCapabilities = {\n /**\n * Inlines assets into the bundle.\n * Options: List of file extensions to inline. Do not include the leading dot.\n */\n 'asset-inline': { extensions: string[] };\n\n /**\n * Bundler capability to support Density externals.\n * This is not a real capability, it's just an indicator that a package needs to use density post-bundle task.\n * Since there is no actual way to execute post-bundle tasks, I'm using this as a workaround.\n * This will be removed once we have a proper way to execute post-bundle tasks with the plugins.\n * Options: object is empty because it's just an indicator. No options are needed.\n */\n density: boolean;\n\n /**\n * Adds aliases to externalized packages.\n */\n alias: {\n [key: string]: string;\n };\n\n /**\n * Enables React Native type resolution of .web.ts extensions.\n * Options: object is empty because it's just an indicator. No options are needed.\n */\n 'resolve-web-extensions': boolean;\n};\n\n/**\n * This is the type that's being used `PackageSettings` to enable/disable bundler capabilities.\n * - Key: internal capability name\n * - Value: options object to configure the capability, or false to disable it\n */\nexport type InternalBundlerCapabilitiesOptions = {\n [key in keyof InternalBundlerCapabilities]?: InternalBundlerCapabilities[key] | boolean;\n};\n\ntype ExternalBundlerCapabilitiesOptions = Record<string, object | boolean>;\n\n/**\n * Options used in `PackageSettings` to configure or disable bundler capabilities.\n * - Key: capability name, either internal (Cloudpack-provided) or external (as specified in\n * `AppConfig.bundlerCapabilitiesRegistry`)\n * - Value: options object to configure the capability, or false to disable it.\n */\nexport type BundlerCapabilitiesOptions = InternalBundlerCapabilitiesOptions & ExternalBundlerCapabilitiesOptions;\n\n/**\n * Metadata for the bundler capabilities that cloudpack provides.\n * - Key: capability name\n * - Value: metadata object with description\n */\nexport type InternalBundlerCapabilitiesMetaData = {\n [key in keyof InternalBundlerCapabilities]: Pick<BundlerCapability<object>, 'description'>;\n};\n\n/**\n * This is a bundler specific implementation of the internal bundler capabilities.\n * It's a mapping from the capability name to the capability function.\n *\n * `TConfig` is the type of the bundler's config object. (ie: `WebpackConfiguration`, `OriBuildOptions`, etc)\n */\nexport type InternalBundlerCapabilityImplementations<TConfig> = {\n [key in keyof InternalBundlerCapabilities]: BundlerCapabilityFunction<TConfig, InternalBundlerCapabilities[key]>;\n};\n\n/**\n * This is the type of the external bundler capability module that's being imported.\n *\n * `TConfig` is the type of the bundler's config object. (ie: `WebpackConfiguration`, `OriBuildOptions`, etc)\n */\nexport type ExternalBundlerCapabilityModule<TConfig extends object> = {\n default: BundlerCapability<TConfig>;\n};\n"]}
@@ -8,7 +8,7 @@ import type { Session } from './Session.js';
8
8
  */
9
9
  export type RenderFunction = (options: RenderFunctionOptions) => Promise<RenderFunctionResult> | RenderFunctionResult;
10
10
  /**
11
- * Input for a `renderScript` custom server render function.
11
+ * Input for a `serverEntry`/`renderScript` custom server render function.
12
12
  */
13
13
  export interface RenderFunctionOptions {
14
14
  /** Info about the current app session */
@@ -33,7 +33,7 @@ export interface RenderFunctionOptions {
33
33
  res: Response;
34
34
  }
35
35
  /**
36
- * The complete expected result of the `renderScript` custom server render function.
36
+ * The complete expected result of the `serverEntry`/`renderScript` custom server render function.
37
37
  */
38
38
  export interface ExpandedRenderFunctionResult {
39
39
  /** Response body */
@@ -44,7 +44,7 @@ export interface ExpandedRenderFunctionResult {
44
44
  contentType: string;
45
45
  }
46
46
  /**
47
- * The expected result of the `renderScript` custom server render function.
47
+ * The expected result of the `serverEntry`/`renderScript` custom server render function.
48
48
  *
49
49
  * - If a string, it's assumed to be the HTML content.
50
50
  * - If an object and the `content` is non-HTML, `contentType` must be set.
@@ -55,7 +55,7 @@ export type RenderFunctionResult = string | null | ({
55
55
  content: string;
56
56
  } & Partial<ExpandedRenderFunctionResult>);
57
57
  /**
58
- * The expected shape of the `renderScript` custom server render function JS file.
58
+ * The expected shape of the `serverEntry`/`renderScript` custom server render function JS file.
59
59
  */
60
60
  export type RenderFunctionScript = {
61
61
  default: RenderFunction;
@@ -1 +1 @@
1
- {"version":3,"file":"RenderFunction.js","sourceRoot":"","sources":["../src/RenderFunction.ts"],"names":[],"mappings":"","sourcesContent":["import type { Request, Response } from 'express';\nimport type { ImportMap } from './ImportMap.js';\nimport type { PackageJson } from './PackageJson.js';\nimport type { RenderedRoute } from './Route.js';\nimport type { Session } from './Session.js';\n\n/**\n * A custom server render function that can be used to override the default HTML response.\n */\nexport type RenderFunction = (options: RenderFunctionOptions) => Promise<RenderFunctionResult> | RenderFunctionResult;\n\n/**\n * Input for a `renderScript` custom server render function.\n */\nexport interface RenderFunctionOptions {\n /** Info about the current app session */\n session: Session;\n /** Processed route being rendered */\n route: RenderedRoute;\n /** Base URL of the app server, including port */\n baseUrl: string;\n /** `package.json` for the app */\n definition: PackageJson;\n /** Import map that will be used by the app at runtime (will be injected into a returned HTML response) */\n importMap: ImportMap;\n /** URL for the Cloudpack overlay script bundle (will be injected into a returned HTML response) */\n overlayScript?: string;\n /** Additional script bundle URLs from `route.entry` (will be injected into a returned HTML response) */\n entryScripts?: string[];\n /** Inline script tag contents used for Cloudpack initialization (will be injected into a returned HTML response) */\n inlineScripts?: string[];\n /** Current request */\n req: Request;\n /** Current response */\n res: Response;\n}\n\n/**\n * The complete expected result of the `renderScript` custom server render function.\n */\nexport interface ExpandedRenderFunctionResult {\n /** Response body */\n content: string;\n /** Standard HTTP status code - https://developer.mozilla.org/en-US/docs/Web/HTTP/Status */\n statusCode: number;\n /** MIME type for the response - https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types */\n contentType: string;\n}\n\n/**\n * The expected result of the `renderScript` custom server render function.\n *\n * - If a string, it's assumed to be the HTML content.\n * - If an object and the `content` is non-HTML, `contentType` must be set.\n * - If null, this means the function fully handled the request (sent a response using\n * `options.res.send('...')` or other methods).\n */\nexport type RenderFunctionResult = string | null | ({ content: string } & Partial<ExpandedRenderFunctionResult>);\n\n/**\n * The expected shape of the `renderScript` custom server render function JS file.\n */\nexport type RenderFunctionScript = { default: RenderFunction };\n"]}
1
+ {"version":3,"file":"RenderFunction.js","sourceRoot":"","sources":["../src/RenderFunction.ts"],"names":[],"mappings":"","sourcesContent":["import type { Request, Response } from 'express';\nimport type { ImportMap } from './ImportMap.js';\nimport type { PackageJson } from './PackageJson.js';\nimport type { RenderedRoute } from './Route.js';\nimport type { Session } from './Session.js';\n\n/**\n * A custom server render function that can be used to override the default HTML response.\n */\nexport type RenderFunction = (options: RenderFunctionOptions) => Promise<RenderFunctionResult> | RenderFunctionResult;\n\n/**\n * Input for a `serverEntry`/`renderScript` custom server render function.\n */\nexport interface RenderFunctionOptions {\n /** Info about the current app session */\n session: Session;\n /** Processed route being rendered */\n route: RenderedRoute;\n /** Base URL of the app server, including port */\n baseUrl: string;\n /** `package.json` for the app */\n definition: PackageJson;\n /** Import map that will be used by the app at runtime (will be injected into a returned HTML response) */\n importMap: ImportMap;\n /** URL for the Cloudpack overlay script bundle (will be injected into a returned HTML response) */\n overlayScript?: string;\n /** Additional script bundle URLs from `route.entry` (will be injected into a returned HTML response) */\n entryScripts?: string[];\n /** Inline script tag contents used for Cloudpack initialization (will be injected into a returned HTML response) */\n inlineScripts?: string[];\n /** Current request */\n req: Request;\n /** Current response */\n res: Response;\n}\n\n/**\n * The complete expected result of the `serverEntry`/`renderScript` custom server render function.\n */\nexport interface ExpandedRenderFunctionResult {\n /** Response body */\n content: string;\n /** Standard HTTP status code - https://developer.mozilla.org/en-US/docs/Web/HTTP/Status */\n statusCode: number;\n /** MIME type for the response - https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types */\n contentType: string;\n}\n\n/**\n * The expected result of the `serverEntry`/`renderScript` custom server render function.\n *\n * - If a string, it's assumed to be the HTML content.\n * - If an object and the `content` is non-HTML, `contentType` must be set.\n * - If null, this means the function fully handled the request (sent a response using\n * `options.res.send('...')` or other methods).\n */\nexport type RenderFunctionResult = string | null | ({ content: string } & Partial<ExpandedRenderFunctionResult>);\n\n/**\n * The expected shape of the `serverEntry`/`renderScript` custom server render function JS file.\n */\nexport type RenderFunctionScript = { default: RenderFunction };\n"]}
package/lib/Route.d.ts CHANGED
@@ -30,6 +30,8 @@ export interface ShorthandRenderedRoute extends SharedRouteOptions {
30
30
  * Path to a .js or .html file (relative to the app path) for rendering the route.
31
31
  *
32
32
  * If a .js file, it must export a default function implementing `RenderFunction` from `@ms-cloudpack/common-types`.
33
+ * @deprecated Use `serverEntry` instead. (Please talk to the team if you have a scenario where
34
+ * bundling the script causes a problem.)
33
35
  */
34
36
  renderScript?: string;
35
37
  /**
@@ -44,16 +46,32 @@ export interface ShorthandRenderedRoute extends SharedRouteOptions {
44
46
  * Usually this should be an actual source path, though it could also be an exports map key if necessary.
45
47
  */
46
48
  entry?: string | string[];
49
+ /**
50
+ * Path to a TS, JS, or HTML file (relative to the app path) for rendering the route on the server.
51
+ * (Also supports export map keys.) If a JS or TS file, it will be bundled before rendering.
52
+ *
53
+ * If JS or TS, it must export a default function implementing `RenderRouteFunction` defined in
54
+ * `@ms-cloudpack/app-server`.
55
+ */
56
+ serverEntry?: string;
47
57
  }
48
58
  /**
49
59
  * A server-rendered route with full `entry` info (used in the processed `CloudpackConfig`).
50
60
  * The route is rendered by a custom server script in Cloudpack.
51
61
  */
52
- export type RenderedRoute = Omit<ShorthandRenderedRoute, 'exportEntry' | 'entry'> & {
62
+ export type RenderedRoute = Omit<ShorthandRenderedRoute, 'exportEntry' | 'entry' | 'serverEntry'> & {
53
63
  /**
54
64
  * The source entry or entries to be included on the page for this route.
55
65
  */
56
66
  entry?: ExpandedSourcePath[];
67
+ /**
68
+ * Path to a TS, JS, or HTML file (relative to the app path) for rendering the route on the server.
69
+ * If a JS or TS file, it will be bundled before rendering.
70
+ *
71
+ * If JS or TS, it must export a default function implementing `RenderRouteFunction` defined in
72
+ * `@ms-cloudpack/app-server`.
73
+ */
74
+ serverEntry?: ExpandedSourcePath;
57
75
  };
58
76
  /**
59
77
  * A route with a staticPath property serves static files from the specified path.
@@ -67,13 +85,13 @@ export interface StaticRoute extends SharedRouteOptions {
67
85
  /**
68
86
  * A route that serves a bootstrap script.
69
87
  */
70
- export interface ShorthandBootstrapRoute extends SharedRouteOptions, Pick<ShorthandRenderedRoute, 'entry' | 'exportEntry'> {
88
+ export interface ShorthandBootstrapRoute extends SharedRouteOptions, Pick<ShorthandRenderedRoute, 'entry' | 'serverEntry' | 'exportEntry'> {
71
89
  type: 'bootstrap';
72
90
  }
73
91
  /**
74
92
  * A route that serves a bootstrap script.
75
93
  */
76
- export interface BootstrapRoute extends Omit<ShorthandBootstrapRoute, 'entry'>, Pick<RenderedRoute, 'entry'> {
94
+ export interface BootstrapRoute extends Omit<ShorthandBootstrapRoute, 'entry' | 'serverEntry'>, Pick<RenderedRoute, 'entry' | 'serverEntry'> {
77
95
  }
78
96
  /**
79
97
  * A route that redirects to another url.
@@ -1 +1 @@
1
- {"version":3,"file":"Route.d.ts","sourceRoot":"","sources":["../src/Route.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpE,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB;IAChE;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,sBAAsB,EAAE,aAAa,GAAG,OAAO,CAAC,GAAG;IAClF;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBACf,SAAQ,kBAAkB,EACxB,IAAI,CAAC,sBAAsB,EAAE,OAAO,GAAG,aAAa,CAAC;IACvD,IAAI,EAAE,WAAW,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,uBAAuB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC;CAAG;AAE/G;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACvD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,kBAAkB;IACpD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED;;GAEG;AAEH,MAAM,MAAM,cAAc,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,WAAW,GACX,aAAa,GACb,UAAU,CAAC;AAEf;;GAEG;AAEH,MAAM,MAAM,KAAK,GAAG,aAAa,GAAG,cAAc,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,CAAC;AAE9F;;GAEG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,GAAG,KAAK,IAAI,WAAW,CAEjF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,IAAI,cAAc,CAEtE;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,uBAAuB,CAEjG;AAKD,wBAAgB,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,IAAI,aAAa,CAGpE;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,sBAAsB,CAE/F;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,GAAG,KAAK,IAAI,aAAa,CAErF;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,GAAG,KAAK,IAAI,UAAU,CAE/E"}
1
+ {"version":3,"file":"Route.d.ts","sourceRoot":"","sources":["../src/Route.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpE,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB;IAChE;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE1B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,sBAAsB,EAAE,aAAa,GAAG,OAAO,GAAG,aAAa,CAAC,GAAG;IAClG;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAE7B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBACf,SAAQ,kBAAkB,EACxB,IAAI,CAAC,sBAAsB,EAAE,OAAO,GAAG,aAAa,GAAG,aAAa,CAAC;IACvE,IAAI,EAAE,WAAW,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cACf,SAAQ,IAAI,CAAC,uBAAuB,EAAE,OAAO,GAAG,aAAa,CAAC,EAC5D,IAAI,CAAC,aAAa,EAAE,OAAO,GAAG,aAAa,CAAC;CAAG;AAEnD;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACvD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,kBAAkB;IACpD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED;;GAEG;AAEH,MAAM,MAAM,cAAc,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,WAAW,GACX,aAAa,GACb,UAAU,CAAC;AAEf;;GAEG;AAEH,MAAM,MAAM,KAAK,GAAG,aAAa,GAAG,cAAc,GAAG,WAAW,GAAG,aAAa,GAAG,UAAU,CAAC;AAE9F;;GAEG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,GAAG,KAAK,IAAI,WAAW,CAEjF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,IAAI,cAAc,CAEtE;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,uBAAuB,CAEjG;AAKD,wBAAgB,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,IAAI,aAAa,CAOpE;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,cAAc,GAAG,KAAK,IAAI,sBAAsB,CAE/F;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,GAAG,KAAK,IAAI,aAAa,CAErF;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,KAAK,GAAG,cAAc,GAAG,KAAK,IAAI,UAAU,CAE/E"}
package/lib/Route.js CHANGED
@@ -21,7 +21,9 @@ export function isShorthandBootstrapRoute(route) {
21
21
  */
22
22
  export function isRenderedRoute(route) {
23
23
  const maybeRenderedRoute = route;
24
- return !isBootstrapRoute(route) && !!(maybeRenderedRoute.renderScript || maybeRenderedRoute.entry);
24
+ return (!isBootstrapRoute(route) &&
25
+ // eslint-disable-next-line etc/no-deprecated
26
+ !!(maybeRenderedRoute.renderScript || maybeRenderedRoute.entry || maybeRenderedRoute.serverEntry));
25
27
  }
26
28
  /**
27
29
  * Type guard to check if a route is a shorthand rendered route.
package/lib/Route.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Route.js","sourceRoot":"","sources":["../src/Route.ts"],"names":[],"mappings":"AAoIA;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,KAA6B;IACzD,OAAO,YAAY,IAAI,KAAK,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAY;IAC3C,OAAO,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAqB;IAC7D,OAAO,gBAAgB,CAAC,KAAc,CAAC,CAAC;AAC1C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,KAAY;IAC1C,MAAM,kBAAkB,GAAG,KAAsB,CAAC;IAClD,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,YAAY,IAAI,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACrG,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAqB;IAC5D,OAAO,eAAe,CAAC,KAAc,CAAC,IAAI,aAAa,IAAI,KAAK,CAAC;AACnE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,KAA6B;IAC3D,OAAO,YAAY,IAAI,KAAK,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,KAA6B;IACxD,OAAO,SAAS,IAAI,KAAK,CAAC;AAC5B,CAAC","sourcesContent":["import type { ExpandedSourcePath } from './ExpandedSourcePath.js';\n\n/**\n * A route match can be a string path or an object with a path and domain.\n */\nexport type RouteMatch = string | { path: string; domain?: string };\n\nexport interface SharedRouteOptions {\n /**\n * The URL path to match. Paths should usually start with a slash, e.g. `'/my-route'`.\n * You can also use wildcards (`*`), e.g. `'/my-route/*'` to match all paths starting with `'/my-route'`.\n *\n * See the [Express docs](https://expressjs.com/en/guide/routing.html#route-paths) for the full\n * supported routing syntax.\n *\n * If you need a route to match on a specific domain, you can pass an object (path, domain) in where\n * the domain is a string which can have wildcards (`*`). e.g. `'word.*'` will match `word.com`, `word.net`, etc.\n *\n * Use an array to handle multiple paths with the same route handler.\n */\n match: RouteMatch | RouteMatch[];\n}\n\n/**\n * A server-rendered route with optional shorthand `entry` info (as specified in `AppConfig`/`cloudpack.config.json`).\n * The route is rendered by a custom server script in Cloudpack.\n */\nexport interface ShorthandRenderedRoute extends SharedRouteOptions {\n /**\n * Path to a .js or .html file (relative to the app path) for rendering the route.\n *\n * If a .js file, it must export a default function implementing `RenderFunction` from `@ms-cloudpack/common-types`.\n */\n renderScript?: string;\n\n /**\n * The key in the exports map which represents the entry point app script for this route.\n * @deprecated Use `entry` instead.\n */\n exportEntry?: string;\n\n /**\n * Additional source file path(s) to bundle and include in the HTML.\n * This **overwrites** any original exports map for the package.\n *\n * Usually this should be an actual source path, though it could also be an exports map key if necessary.\n */\n entry?: string | string[];\n}\n\n/**\n * A server-rendered route with full `entry` info (used in the processed `CloudpackConfig`).\n * The route is rendered by a custom server script in Cloudpack.\n */\nexport type RenderedRoute = Omit<ShorthandRenderedRoute, 'exportEntry' | 'entry'> & {\n /**\n * The source entry or entries to be included on the page for this route.\n */\n entry?: ExpandedSourcePath[];\n};\n\n/**\n * A route with a staticPath property serves static files from the specified path.\n */\nexport interface StaticRoute extends SharedRouteOptions {\n /**\n * The path relative to the app root to static assets.\n */\n staticPath: string;\n}\n\n/**\n * A route that serves a bootstrap script.\n */\nexport interface ShorthandBootstrapRoute\n extends SharedRouteOptions,\n Pick<ShorthandRenderedRoute, 'entry' | 'exportEntry'> {\n type: 'bootstrap';\n}\n\n/**\n * A route that serves a bootstrap script.\n */\nexport interface BootstrapRoute extends Omit<ShorthandBootstrapRoute, 'entry'>, Pick<RenderedRoute, 'entry'> {}\n\n/**\n * A route that redirects to another url.\n */\nexport interface RedirectRoute extends SharedRouteOptions {\n /**\n * The url to redirect to.\n */\n redirectTo: string;\n}\n\n/**\n * A route that proxies requests to another server.\n * This is handled by https://github.com/chimurai/http-proxy-middleware.\n */\nexport interface ProxyRoute extends SharedRouteOptions {\n /**\n * The target host to proxy to. (protocol + host).\n */\n proxyTo: string;\n\n /**\n * For virtual hosted sites.\n */\n changeOrigin?: boolean;\n /**\n * Rewrite target's url path. Object-keys will be used as RegExp to match paths.\n */\n pathRewrite?: Record<string, string>;\n}\n\n/**\n * Route as specified in `AppConfig` (`cloudpack.config.json`).\n */\n// WARNING: Be sure to add new route types to Route as well!\nexport type ShorthandRoute =\n | ShorthandRenderedRoute\n | ShorthandBootstrapRoute\n | StaticRoute\n | RedirectRoute\n | ProxyRoute;\n\n/**\n * Processed route as used in the processed `CloudpackConfig`.\n */\n// WARNING: Be sure to add new route types to ShorthandRoute as well!\nexport type Route = RenderedRoute | BootstrapRoute | StaticRoute | RedirectRoute | ProxyRoute;\n\n/**\n * Type guard to check if a route is a static route.\n */\nexport function isStaticRoute(route: Route | ShorthandRoute): route is StaticRoute {\n return 'staticPath' in route;\n}\n\n/**\n * Type guard to check if a route is a bootstrap route.\n */\nexport function isBootstrapRoute(route: Route): route is BootstrapRoute {\n return 'type' in route && route.type === 'bootstrap';\n}\n\n/**\n * Type guard to check if a route is a shorthand bootstrap route.\n */\nexport function isShorthandBootstrapRoute(route: ShorthandRoute): route is ShorthandBootstrapRoute {\n return isBootstrapRoute(route as Route);\n}\n\n/*\n * Type guard to check if a route is a rendered route.\n */\nexport function isRenderedRoute(route: Route): route is RenderedRoute {\n const maybeRenderedRoute = route as RenderedRoute;\n return !isBootstrapRoute(route) && !!(maybeRenderedRoute.renderScript || maybeRenderedRoute.entry);\n}\n\n/**\n * Type guard to check if a route is a shorthand rendered route.\n */\nexport function isShorthandRenderedRoute(route: ShorthandRoute): route is ShorthandRenderedRoute {\n return isRenderedRoute(route as Route) || 'exportEntry' in route;\n}\n\n/**\n * Type guard to check if a route is a redirect route.\n */\nexport function isRedirectRoute(route: Route | ShorthandRoute): route is RedirectRoute {\n return 'redirectTo' in route;\n}\n\n/**\n * Type guard to check if a route is a proxy route.\n */\nexport function isProxyRoute(route: Route | ShorthandRoute): route is ProxyRoute {\n return 'proxyTo' in route;\n}\n"]}
1
+ {"version":3,"file":"Route.js","sourceRoot":"","sources":["../src/Route.ts"],"names":[],"mappings":"AA0JA;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,KAA6B;IACzD,OAAO,YAAY,IAAI,KAAK,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAY;IAC3C,OAAO,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,KAAqB;IAC7D,OAAO,gBAAgB,CAAC,KAAc,CAAC,CAAC;AAC1C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,KAAY;IAC1C,MAAM,kBAAkB,GAAG,KAAsB,CAAC;IAClD,OAAO,CACL,CAAC,gBAAgB,CAAC,KAAK,CAAC;QACxB,6CAA6C;QAC7C,CAAC,CAAC,CAAC,kBAAkB,CAAC,YAAY,IAAI,kBAAkB,CAAC,KAAK,IAAI,kBAAkB,CAAC,WAAW,CAAC,CAClG,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,KAAqB;IAC5D,OAAO,eAAe,CAAC,KAAc,CAAC,IAAI,aAAa,IAAI,KAAK,CAAC;AACnE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,KAA6B;IAC3D,OAAO,YAAY,IAAI,KAAK,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,KAA6B;IACxD,OAAO,SAAS,IAAI,KAAK,CAAC;AAC5B,CAAC","sourcesContent":["import type { ExpandedSourcePath } from './ExpandedSourcePath.js';\n\n/**\n * A route match can be a string path or an object with a path and domain.\n */\nexport type RouteMatch = string | { path: string; domain?: string };\n\nexport interface SharedRouteOptions {\n /**\n * The URL path to match. Paths should usually start with a slash, e.g. `'/my-route'`.\n * You can also use wildcards (`*`), e.g. `'/my-route/*'` to match all paths starting with `'/my-route'`.\n *\n * See the [Express docs](https://expressjs.com/en/guide/routing.html#route-paths) for the full\n * supported routing syntax.\n *\n * If you need a route to match on a specific domain, you can pass an object (path, domain) in where\n * the domain is a string which can have wildcards (`*`). e.g. `'word.*'` will match `word.com`, `word.net`, etc.\n *\n * Use an array to handle multiple paths with the same route handler.\n */\n match: RouteMatch | RouteMatch[];\n}\n\n/**\n * A server-rendered route with optional shorthand `entry` info (as specified in `AppConfig`/`cloudpack.config.json`).\n * The route is rendered by a custom server script in Cloudpack.\n */\nexport interface ShorthandRenderedRoute extends SharedRouteOptions {\n /**\n * Path to a .js or .html file (relative to the app path) for rendering the route.\n *\n * If a .js file, it must export a default function implementing `RenderFunction` from `@ms-cloudpack/common-types`.\n * @deprecated Use `serverEntry` instead. (Please talk to the team if you have a scenario where\n * bundling the script causes a problem.)\n */\n renderScript?: string;\n\n /**\n * The key in the exports map which represents the entry point app script for this route.\n * @deprecated Use `entry` instead.\n */\n exportEntry?: string;\n\n /**\n * Additional source file path(s) to bundle and include in the HTML.\n * This **overwrites** any original exports map for the package.\n *\n * Usually this should be an actual source path, though it could also be an exports map key if necessary.\n */\n entry?: string | string[];\n\n /**\n * Path to a TS, JS, or HTML file (relative to the app path) for rendering the route on the server.\n * (Also supports export map keys.) If a JS or TS file, it will be bundled before rendering.\n *\n * If JS or TS, it must export a default function implementing `RenderRouteFunction` defined in\n * `@ms-cloudpack/app-server`.\n */\n serverEntry?: string;\n}\n\n/**\n * A server-rendered route with full `entry` info (used in the processed `CloudpackConfig`).\n * The route is rendered by a custom server script in Cloudpack.\n */\nexport type RenderedRoute = Omit<ShorthandRenderedRoute, 'exportEntry' | 'entry' | 'serverEntry'> & {\n /**\n * The source entry or entries to be included on the page for this route.\n */\n entry?: ExpandedSourcePath[];\n\n /**\n * Path to a TS, JS, or HTML file (relative to the app path) for rendering the route on the server.\n * If a JS or TS file, it will be bundled before rendering.\n *\n * If JS or TS, it must export a default function implementing `RenderRouteFunction` defined in\n * `@ms-cloudpack/app-server`.\n */\n serverEntry?: ExpandedSourcePath;\n};\n\n/**\n * A route with a staticPath property serves static files from the specified path.\n */\nexport interface StaticRoute extends SharedRouteOptions {\n /**\n * The path relative to the app root to static assets.\n */\n staticPath: string;\n}\n\n/**\n * A route that serves a bootstrap script.\n */\nexport interface ShorthandBootstrapRoute\n extends SharedRouteOptions,\n Pick<ShorthandRenderedRoute, 'entry' | 'serverEntry' | 'exportEntry'> {\n type: 'bootstrap';\n}\n\n/**\n * A route that serves a bootstrap script.\n */\nexport interface BootstrapRoute\n extends Omit<ShorthandBootstrapRoute, 'entry' | 'serverEntry'>,\n Pick<RenderedRoute, 'entry' | 'serverEntry'> {}\n\n/**\n * A route that redirects to another url.\n */\nexport interface RedirectRoute extends SharedRouteOptions {\n /**\n * The url to redirect to.\n */\n redirectTo: string;\n}\n\n/**\n * A route that proxies requests to another server.\n * This is handled by https://github.com/chimurai/http-proxy-middleware.\n */\nexport interface ProxyRoute extends SharedRouteOptions {\n /**\n * The target host to proxy to. (protocol + host).\n */\n proxyTo: string;\n\n /**\n * For virtual hosted sites.\n */\n changeOrigin?: boolean;\n /**\n * Rewrite target's url path. Object-keys will be used as RegExp to match paths.\n */\n pathRewrite?: Record<string, string>;\n}\n\n/**\n * Route as specified in `AppConfig` (`cloudpack.config.json`).\n */\n// WARNING: Be sure to add new route types to Route as well!\nexport type ShorthandRoute =\n | ShorthandRenderedRoute\n | ShorthandBootstrapRoute\n | StaticRoute\n | RedirectRoute\n | ProxyRoute;\n\n/**\n * Processed route as used in the processed `CloudpackConfig`.\n */\n// WARNING: Be sure to add new route types to ShorthandRoute as well!\nexport type Route = RenderedRoute | BootstrapRoute | StaticRoute | RedirectRoute | ProxyRoute;\n\n/**\n * Type guard to check if a route is a static route.\n */\nexport function isStaticRoute(route: Route | ShorthandRoute): route is StaticRoute {\n return 'staticPath' in route;\n}\n\n/**\n * Type guard to check if a route is a bootstrap route.\n */\nexport function isBootstrapRoute(route: Route): route is BootstrapRoute {\n return 'type' in route && route.type === 'bootstrap';\n}\n\n/**\n * Type guard to check if a route is a shorthand bootstrap route.\n */\nexport function isShorthandBootstrapRoute(route: ShorthandRoute): route is ShorthandBootstrapRoute {\n return isBootstrapRoute(route as Route);\n}\n\n/*\n * Type guard to check if a route is a rendered route.\n */\nexport function isRenderedRoute(route: Route): route is RenderedRoute {\n const maybeRenderedRoute = route as RenderedRoute;\n return (\n !isBootstrapRoute(route) &&\n // eslint-disable-next-line etc/no-deprecated\n !!(maybeRenderedRoute.renderScript || maybeRenderedRoute.entry || maybeRenderedRoute.serverEntry)\n );\n}\n\n/**\n * Type guard to check if a route is a shorthand rendered route.\n */\nexport function isShorthandRenderedRoute(route: ShorthandRoute): route is ShorthandRenderedRoute {\n return isRenderedRoute(route as Route) || 'exportEntry' in route;\n}\n\n/**\n * Type guard to check if a route is a redirect route.\n */\nexport function isRedirectRoute(route: Route | ShorthandRoute): route is RedirectRoute {\n return 'redirectTo' in route;\n}\n\n/**\n * Type guard to check if a route is a proxy route.\n */\nexport function isProxyRoute(route: Route | ShorthandRoute): route is ProxyRoute {\n return 'proxyTo' in route;\n}\n"]}
@@ -34,7 +34,7 @@ export declare const allFeatures: {
34
34
  optimizeDependencies: Feature;
35
35
  /** Creates null entries for unused exports in generated config so that they are not included when bundling. */
36
36
  removeUnusedExports: Feature;
37
- /** Enables React Native type resolution of .web.ts extensions. */
37
+ /** @deprecated Removed in favor of `resolve-web-extensions` bundler capability. Enables React Native type resolution of .web.ts extensions. */
38
38
  resolveWebExtensions: Feature;
39
39
  /** Enables the syncing of bundles. */
40
40
  syncBundles: Feature;
@@ -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;;;GAGG;AACH,eAAO,MAAM,WAAW;IAGtB,mGAAmG;uBAG9F,OAAO;IAEZ,2DAA2D;uBACmC,OAAO;IAErG,mEAAmE;yBACoC,OAAO;IAE9G,uCAAuC;uBACoC,OAAO;IAElF;;;OAGG;yBAIE,OAAO;IAEZ;;OAEG;gCAGE,OAAO;IAEZ,sGAAsG;4BAGjG,OAAO;IAEZ,sEAAsE;yBACqC,OAAO;IAElH,6FAA6F;4BAGxF,OAAO;IAEZ;;;OAGG;0BAKE,OAAO;IAEZ,+GAA+G;yBAI1G,OAAO;IAEZ,kEAAkE;0BACsC,OAAO;IAE/G,sCAAsC;iBAC6B,OAAO;IAE1E,gDAAgD;0BACsC,OAAO;IAE7F,2DAA2D;wBACoC,OAAO;IAEtG,uDAAuD;mBAC+B,OAAO;CAI9F,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;;;GAGG;AACH,eAAO,MAAM,WAAW;IAGtB,mGAAmG;uBAG9F,OAAO;IAEZ,2DAA2D;uBACmC,OAAO;IAErG,mEAAmE;yBACoC,OAAO;IAE9G,uCAAuC;uBACoC,OAAO;IAElF;;;OAGG;yBAIE,OAAO;IAEZ;;OAEG;gCAGE,OAAO;IAEZ,sGAAsG;4BAGjG,OAAO;IAEZ,sEAAsE;yBACqC,OAAO;IAElH,6FAA6F;4BAGxF,OAAO;IAEZ;;;OAGG;0BAKE,OAAO;IAEZ,+GAA+G;yBAI1G,OAAO;IAEZ,+IAA+I;0BACvC,OAAO;IAE/G,sCAAsC;iBAC6B,OAAO;IAE1E,gDAAgD;0BACsC,OAAO;IAE7F,2DAA2D;wBACoC,OAAO;IAEtG,uDAAuD;mBAC+B,OAAO;CAI9F,CAAC"}
@@ -50,7 +50,7 @@ export const allFeatures = {
50
50
  removeUnusedExports: {
51
51
  description: 'Creates null entries for unused exports in generated config so that they are not included when bundling.',
52
52
  },
53
- /** Enables React Native type resolution of .web.ts extensions. */
53
+ /** @deprecated Removed in favor of `resolve-web-extensions` bundler capability. Enables React Native type resolution of .web.ts extensions. */
54
54
  resolveWebExtensions: { description: 'Enables React Native type resolution of .web.ts extensions.' },
55
55
  /** Enables the syncing of bundles. */
56
56
  syncBundles: { description: 'Enables the syncing of bundles.' },
@@ -1 +1 @@
1
- {"version":3,"file":"allFeatures.js","sourceRoot":"","sources":["../src/allFeatures.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,8FAA8F;IAE9F,mGAAmG;IACnG,iBAAiB,EAAE;QACjB,WAAW,EAAE,8FAA8F;KACjG;IAEZ,2DAA2D;IAC3D,iBAAiB,EAAE,EAAE,WAAW,EAAE,sDAAsD,EAAa;IAErG,mEAAmE;IACnE,mBAAmB,EAAE,EAAE,WAAW,EAAE,6DAA6D,EAAa;IAE9G,uCAAuC;IACvC,iBAAiB,EAAE,EAAE,WAAW,EAAE,mCAAmC,EAAa;IAElF;;;OAGG;IACH,mBAAmB,EAAE;QACnB,WAAW,EACT,4HAA4H;KACpH;IAEZ;;OAEG;IACH,0BAA0B,EAAE;QAC1B,WAAW,EAAE,oEAAoE;KACvE;IAEZ,sGAAsG;IACtG,sBAAsB,EAAE;QACtB,WAAW,EAAE,iGAAiG;KACpG;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,+GAA+G;IAC/G,mBAAmB,EAAE;QACnB,WAAW,EACT,0GAA0G;KAClG;IAEZ,kEAAkE;IAClE,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,2DAA2D;IAC3D,kBAAkB,EAAE,EAAE,WAAW,EAAE,sDAAsD,EAAa;IAEtG,uDAAuD;IACvD,aAAa,EAAE,EAAE,WAAW,EAAE,kDAAkD,EAAa;IAE7F,iDAAiD;IACjD,oDAAoD;CACrD,CAAC","sourcesContent":["import type { Feature } from './Feature.js';\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. */\n autoUpdateEntries: {\n description: 'Automatically updates the generated config when an unknown import path is used during start.',\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 /** Enables the file watcher to be spawned in a forked process. */\n enableWatcherInFork: { description: 'Enables the file watcher to be spawned in a forked process.' } 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.\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.',\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 /** Enables relative resource paths to be used in import map paths when useSingleWebServer is true. */\n relativeImportMapPaths: {\n description: 'Enables relative resource paths to be used in import map paths when useSingleWebServer is 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 /** 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 /** 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. */\n useSingleWebServer: { description: 'Use a single server for both bundles and app assets.' } 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"]}
1
+ {"version":3,"file":"allFeatures.js","sourceRoot":"","sources":["../src/allFeatures.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,8FAA8F;IAE9F,mGAAmG;IACnG,iBAAiB,EAAE;QACjB,WAAW,EAAE,8FAA8F;KACjG;IAEZ,2DAA2D;IAC3D,iBAAiB,EAAE,EAAE,WAAW,EAAE,sDAAsD,EAAa;IAErG,mEAAmE;IACnE,mBAAmB,EAAE,EAAE,WAAW,EAAE,6DAA6D,EAAa;IAE9G,uCAAuC;IACvC,iBAAiB,EAAE,EAAE,WAAW,EAAE,mCAAmC,EAAa;IAElF;;;OAGG;IACH,mBAAmB,EAAE;QACnB,WAAW,EACT,4HAA4H;KACpH;IAEZ;;OAEG;IACH,0BAA0B,EAAE;QAC1B,WAAW,EAAE,oEAAoE;KACvE;IAEZ,sGAAsG;IACtG,sBAAsB,EAAE;QACtB,WAAW,EAAE,iGAAiG;KACpG;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,+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,2DAA2D;IAC3D,kBAAkB,EAAE,EAAE,WAAW,EAAE,sDAAsD,EAAa;IAEtG,uDAAuD;IACvD,aAAa,EAAE,EAAE,WAAW,EAAE,kDAAkD,EAAa;IAE7F,iDAAiD;IACjD,oDAAoD;CACrD,CAAC","sourcesContent":["import type { Feature } from './Feature.js';\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. */\n autoUpdateEntries: {\n description: 'Automatically updates the generated config when an unknown import path is used during start.',\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 /** Enables the file watcher to be spawned in a forked process. */\n enableWatcherInFork: { description: 'Enables the file watcher to be spawned in a forked process.' } 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.\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.',\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 /** Enables relative resource paths to be used in import map paths when useSingleWebServer is true. */\n relativeImportMapPaths: {\n description: 'Enables relative resource paths to be used in import map paths when useSingleWebServer is 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 /** 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. */\n useSingleWebServer: { description: 'Use a single server for both bundles and app assets.' } 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"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ms-cloudpack/common-types",
3
- "version": "0.24.9",
3
+ "version": "0.24.11",
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.5.4",
17
+ "@ms-cloudpack/common-types-browser": "^0.5.5",
18
18
  "@types/express": "^4.17.16"
19
19
  },
20
20
  "devDependencies": {
@@ -93,6 +93,10 @@
93
93
  },
94
94
  "description": "Key value pairs of external bundler capabilities that can be enabled in the package settings.\n- Key is the name of the capability, which will be used in `PackageSettings.bundlerCapabilities`.\n- Value is the import specifier (local path or package name) for the capability module."
95
95
  },
96
+ "define": {
97
+ "$ref": "#/definitions/DefineFlags",
98
+ "description": "Key value pairs that will be used to define global variables in the runtime."
99
+ },
96
100
  "$schema": {
97
101
  "type": "string"
98
102
  }
@@ -539,7 +543,8 @@
539
543
  },
540
544
  "renderScript": {
541
545
  "type": "string",
542
- "description": "Path to a .js or .html file (relative to the app path) for rendering the route.\n\nIf a .js file, it must export a default function implementing `RenderFunction` from `@ms-cloudpack/common-types`."
546
+ "description": "Path to a .js or .html file (relative to the app path) for rendering the route.\n\nIf a .js file, it must export a default function implementing `RenderFunction` from `@ms-cloudpack/common-types`.",
547
+ "deprecated": "Use `serverEntry` instead. (Please talk to the team if you have a scenario where\nbundling the script causes a problem.)"
543
548
  },
544
549
  "exportEntry": {
545
550
  "type": "string",
@@ -559,6 +564,10 @@
559
564
  }
560
565
  ],
561
566
  "description": "Additional source file path(s) to bundle and include in the HTML. This **overwrites** any original exports map for the package.\n\nUsually this should be an actual source path, though it could also be an exports map key if necessary."
567
+ },
568
+ "serverEntry": {
569
+ "type": "string",
570
+ "description": "Path to a TS, JS, or HTML file (relative to the app path) for rendering the route on the server. (Also supports export map keys.) If a JS or TS file, it will be bundled before rendering.\n\nIf JS or TS, it must export a default function implementing `RenderRouteFunction` defined in `@ms-cloudpack/app-server`."
562
571
  }
563
572
  },
564
573
  "additionalProperties": false,
@@ -607,6 +616,10 @@
607
616
  ],
608
617
  "description": "Additional source file path(s) to bundle and include in the HTML. This **overwrites** any original exports map for the package.\n\nUsually this should be an actual source path, though it could also be an exports map key if necessary."
609
618
  },
619
+ "serverEntry": {
620
+ "type": "string",
621
+ "description": "Path to a TS, JS, or HTML file (relative to the app path) for rendering the route on the server. (Also supports export map keys.) If a JS or TS file, it will be bundled before rendering.\n\nIf JS or TS, it must export a default function implementing `RenderRouteFunction` defined in `@ms-cloudpack/app-server`."
622
+ },
610
623
  "exportEntry": {
611
624
  "type": "string",
612
625
  "description": "The key in the exports map which represents the entry point app script for this route.",
@@ -1103,21 +1116,12 @@
1103
1116
  "description": "Inlines assets into the bundle. Options: List of file extensions to inline. Do not include the leading dot."
1104
1117
  },
1105
1118
  {
1106
- "type": "boolean",
1107
- "const": false
1119
+ "type": "boolean"
1108
1120
  }
1109
1121
  ]
1110
1122
  },
1111
1123
  "density": {
1112
- "anyOf": [
1113
- {
1114
- "type": "object"
1115
- },
1116
- {
1117
- "type": "boolean",
1118
- "const": false
1119
- }
1120
- ]
1124
+ "type": "boolean"
1121
1125
  },
1122
1126
  "alias": {
1123
1127
  "anyOf": [
@@ -1128,9 +1132,19 @@
1128
1132
  },
1129
1133
  "description": "Adds aliases to externalized packages."
1130
1134
  },
1135
+ {
1136
+ "type": "boolean"
1137
+ }
1138
+ ]
1139
+ },
1140
+ "resolve-web-extensions": {
1141
+ "anyOf": [
1131
1142
  {
1132
1143
  "type": "boolean",
1133
- "const": false
1144
+ "description": "Enables React Native type resolution of .web.ts extensions. Options: object is empty because it's just an indicator. No options are needed."
1145
+ },
1146
+ {
1147
+ "type": "boolean"
1134
1148
  }
1135
1149
  ]
1136
1150
  }
@@ -1159,6 +1173,33 @@
1159
1173
  ],
1160
1174
  "additionalProperties": false,
1161
1175
  "description": "Azure Blob Storage configuration for remote cache - uploading and downloading packages via `cloudpack sync`."
1176
+ },
1177
+ "DefineFlags": {
1178
+ "type": "object",
1179
+ "additionalProperties": {
1180
+ "anyOf": [
1181
+ {
1182
+ "type": "string"
1183
+ },
1184
+ {
1185
+ "type": "number"
1186
+ },
1187
+ {
1188
+ "type": "boolean"
1189
+ },
1190
+ {
1191
+ "type": "array",
1192
+ "items": {
1193
+ "type": [
1194
+ "string",
1195
+ "number",
1196
+ "boolean"
1197
+ ]
1198
+ }
1199
+ }
1200
+ ]
1201
+ },
1202
+ "description": "DefineFlags is an interface that represents a collection of global variables that will be defined on the window object. Each define flag is represented by a key-value pair"
1162
1203
  }
1163
1204
  }
1164
1205
  }
@@ -96,6 +96,10 @@
96
96
  "type": "string"
97
97
  },
98
98
  "description": "Key value pairs of external bundler capabilities that can be enabled in the package settings.\n- Key is the name of the capability, which will be used in `PackageSettings.bundlerCapabilities`.\n- Value is the import specifier (local path or package name) for the capability module."
99
+ },
100
+ "define": {
101
+ "$ref": "#/definitions/DefineFlags",
102
+ "description": "Key value pairs that will be used to define global variables in the runtime."
99
103
  }
100
104
  },
101
105
  "additionalProperties": false,
@@ -540,7 +544,8 @@
540
544
  },
541
545
  "renderScript": {
542
546
  "type": "string",
543
- "description": "Path to a .js or .html file (relative to the app path) for rendering the route.\n\nIf a .js file, it must export a default function implementing `RenderFunction` from `@ms-cloudpack/common-types`."
547
+ "description": "Path to a .js or .html file (relative to the app path) for rendering the route.\n\nIf a .js file, it must export a default function implementing `RenderFunction` from `@ms-cloudpack/common-types`.",
548
+ "deprecated": "Use `serverEntry` instead. (Please talk to the team if you have a scenario where\nbundling the script causes a problem.)"
544
549
  },
545
550
  "exportEntry": {
546
551
  "type": "string",
@@ -560,6 +565,10 @@
560
565
  }
561
566
  ],
562
567
  "description": "Additional source file path(s) to bundle and include in the HTML. This **overwrites** any original exports map for the package.\n\nUsually this should be an actual source path, though it could also be an exports map key if necessary."
568
+ },
569
+ "serverEntry": {
570
+ "type": "string",
571
+ "description": "Path to a TS, JS, or HTML file (relative to the app path) for rendering the route on the server. (Also supports export map keys.) If a JS or TS file, it will be bundled before rendering.\n\nIf JS or TS, it must export a default function implementing `RenderRouteFunction` defined in `@ms-cloudpack/app-server`."
563
572
  }
564
573
  },
565
574
  "additionalProperties": false,
@@ -608,6 +617,10 @@
608
617
  ],
609
618
  "description": "Additional source file path(s) to bundle and include in the HTML. This **overwrites** any original exports map for the package.\n\nUsually this should be an actual source path, though it could also be an exports map key if necessary."
610
619
  },
620
+ "serverEntry": {
621
+ "type": "string",
622
+ "description": "Path to a TS, JS, or HTML file (relative to the app path) for rendering the route on the server. (Also supports export map keys.) If a JS or TS file, it will be bundled before rendering.\n\nIf JS or TS, it must export a default function implementing `RenderRouteFunction` defined in `@ms-cloudpack/app-server`."
623
+ },
611
624
  "exportEntry": {
612
625
  "type": "string",
613
626
  "description": "The key in the exports map which represents the entry point app script for this route.",
@@ -1104,21 +1117,12 @@
1104
1117
  "description": "Inlines assets into the bundle. Options: List of file extensions to inline. Do not include the leading dot."
1105
1118
  },
1106
1119
  {
1107
- "type": "boolean",
1108
- "const": false
1120
+ "type": "boolean"
1109
1121
  }
1110
1122
  ]
1111
1123
  },
1112
1124
  "density": {
1113
- "anyOf": [
1114
- {
1115
- "type": "object"
1116
- },
1117
- {
1118
- "type": "boolean",
1119
- "const": false
1120
- }
1121
- ]
1125
+ "type": "boolean"
1122
1126
  },
1123
1127
  "alias": {
1124
1128
  "anyOf": [
@@ -1129,9 +1133,19 @@
1129
1133
  },
1130
1134
  "description": "Adds aliases to externalized packages."
1131
1135
  },
1136
+ {
1137
+ "type": "boolean"
1138
+ }
1139
+ ]
1140
+ },
1141
+ "resolve-web-extensions": {
1142
+ "anyOf": [
1132
1143
  {
1133
1144
  "type": "boolean",
1134
- "const": false
1145
+ "description": "Enables React Native type resolution of .web.ts extensions. Options: object is empty because it's just an indicator. No options are needed."
1146
+ },
1147
+ {
1148
+ "type": "boolean"
1135
1149
  }
1136
1150
  ]
1137
1151
  }
@@ -1160,6 +1174,33 @@
1160
1174
  ],
1161
1175
  "additionalProperties": false,
1162
1176
  "description": "Azure Blob Storage configuration for remote cache - uploading and downloading packages via `cloudpack sync`."
1177
+ },
1178
+ "DefineFlags": {
1179
+ "type": "object",
1180
+ "additionalProperties": {
1181
+ "anyOf": [
1182
+ {
1183
+ "type": "string"
1184
+ },
1185
+ {
1186
+ "type": "number"
1187
+ },
1188
+ {
1189
+ "type": "boolean"
1190
+ },
1191
+ {
1192
+ "type": "array",
1193
+ "items": {
1194
+ "type": [
1195
+ "string",
1196
+ "number",
1197
+ "boolean"
1198
+ ]
1199
+ }
1200
+ }
1201
+ ]
1202
+ },
1203
+ "description": "DefineFlags is an interface that represents a collection of global variables that will be defined on the window object. Each define flag is represented by a key-value pair"
1163
1204
  }
1164
1205
  },
1165
1206
  "properties": {