@ms-cloudpack/config 0.2.0 → 0.3.0

package/lib/config.d.ts

@@ -1,31 +1,31 @@
 import type { CloudpackConfig } from './types.js';
 export declare const configFileName = "cloudpack.config.json";
 /**
- * @param cwd base path of the config file
+ * @param cwd - base path of the config file
  * @returns the path of the config file
  */
 export declare function getConfigPath(cwd?: string): string;
 /**
  * Reads the config file synchronously
- * @param cwd base path of the config file
+ * @param cwd - base path of the config file
  * @returns cloudpack config object or empty object if no config file exists.
  */
 export declare function readConfigSync(cwd?: string): CloudpackConfig;
 /**
  * Reads the config file asynchronously
- * @param cwd base path of the config file
+ * @param cwd - base path of the config file
  * @returns cloudpack config object or empty object if no config file exists.
  */
 export declare function readConfig(cwd?: string): Promise<CloudpackConfig>;
 /**
  * Writes the config file asynchronously
- * @param config updated config object to be written
- * @param cwd base path of the config file
+ * @param config - updated config object to be written
+ * @param cwd - base path of the config file
  */
 export declare function writeConfig(config: CloudpackConfig, cwd?: string): Promise<void>;
 /**
  * Writes the config file synchronously
- * @param config updated config object to be written
- * @param cwd base path of the config file
+ * @param config - updated config object to be written
+ * @param cwd - base path of the config file
  */
 export declare function writeConfigSync(config: CloudpackConfig, cwd?: string): void;

package/lib/config.js

@@ -2,7 +2,7 @@ import path from 'path';
 import { readJson, readJsonSync, writeJson, writeJsonSync } from '@ms-cloudpack/json-utilities';
 export const configFileName = 'cloudpack.config.json';
 /**
- * @param cwd base path of the config file
+ * @param cwd - base path of the config file
  * @returns the path of the config file
  */
 export function getConfigPath(cwd) {
@@ -11,7 +11,7 @@ export function getConfigPath(cwd) {
 }
 /**
  * Reads the config file synchronously
- * @param cwd base path of the config file
+ * @param cwd - base path of the config file
  * @returns cloudpack config object or empty object if no config file exists.
  */
 export function readConfigSync(cwd) {
@@ -21,7 +21,7 @@ export function readConfigSync(cwd) {
 }
 /**
  * Reads the config file asynchronously
- * @param cwd base path of the config file
+ * @param cwd - base path of the config file
  * @returns cloudpack config object or empty object if no config file exists.
  */
 export async function readConfig(cwd) {
@@ -31,8 +31,8 @@ export async function readConfig(cwd) {
 }
 /**
  * Writes the config file asynchronously
- * @param config updated config object to be written
- * @param cwd base path of the config file
+ * @param config - updated config object to be written
+ * @param cwd - base path of the config file
  */
 export async function writeConfig(config, cwd) {
     const filePath = getConfigPath(cwd);
@@ -42,8 +42,8 @@ export async function writeConfig(config, cwd) {
 }
 /**
  * Writes the config file synchronously
- * @param config updated config object to be written
- * @param cwd base path of the config file
+ * @param config - updated config object to be written
+ * @param cwd - base path of the config file
  */
 export function writeConfigSync(config, cwd) {
     const filePath = getConfigPath(cwd);

package/lib/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAEhG,MAAM,CAAC,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAEtD;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,MAAM,QAAQ,GAAG,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACtC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;AAC7C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,MAAM,GAAoB,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE7D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,GAAY;IAC3C,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,MAAM,GAAoB,CAAC,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;IAEjE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAAuB,EAAE,GAAY;IACrE,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IAEpC,OAAO,SAAS,CAAC,QAAQ,EAAE;QACzB,GAAG,MAAM;KACV,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,MAAuB,EAAE,GAAY;IACnE,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IAEpC,OAAO,aAAa,CAAC,QAAQ,EAAE;QAC7B,GAAG,MAAM;KACV,CAAC,CAAC;AACL,CAAC","sourcesContent":["import path from 'path';\nimport type { CloudpackConfig } from './types.js';\nimport { readJson, readJsonSync, writeJson, writeJsonSync } from '@ms-cloudpack/json-utilities';\n\nexport const configFileName = 'cloudpack.config.json';\n\n/**\n * @param cwd base path of the config file\n * @returns the path of the config file\n */\nexport function getConfigPath(cwd?: string) {\n  const basePath = cwd || process.cwd();\n  return path.join(basePath, configFileName);\n}\n\n/**\n * Reads the config file synchronously\n * @param cwd base path of the config file\n * @returns cloudpack config object or empty object if no config file exists.\n */\nexport function readConfigSync(cwd?: string) {\n  const filePath = getConfigPath(cwd);\n  const config: CloudpackConfig = readJsonSync(filePath) || {};\n\n  return config;\n}\n\n/**\n * Reads the config file asynchronously\n * @param cwd base path of the config file\n * @returns cloudpack config object or empty object if no config file exists.\n */\nexport async function readConfig(cwd?: string) {\n  const filePath = getConfigPath(cwd);\n  const config: CloudpackConfig = (await readJson(filePath)) || {};\n\n  return config;\n}\n\n/**\n * Writes the config file asynchronously\n * @param config updated config object to be written\n * @param cwd base path of the config file\n */\nexport async function writeConfig(config: CloudpackConfig, cwd?: string) {\n  const filePath = getConfigPath(cwd);\n\n  return writeJson(filePath, {\n    ...config,\n  });\n}\n\n/**\n * Writes the config file synchronously\n * @param config updated config object to be written\n * @param cwd base path of the config file\n */\nexport function writeConfigSync(config: CloudpackConfig, cwd?: string) {\n  const filePath = getConfigPath(cwd);\n\n  return writeJsonSync(filePath, {\n    ...config,\n  });\n}\n"]}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAEhG,MAAM,CAAC,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAEtD;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,GAAY;IACxC,MAAM,QAAQ,GAAG,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACtC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;AAC7C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,MAAM,GAAoB,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE7D,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,GAAY;IAC3C,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,MAAM,GAAoB,CAAC,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;IAEjE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,MAAuB,EAAE,GAAY;IACrE,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IAEpC,OAAO,SAAS,CAAC,QAAQ,EAAE;QACzB,GAAG,MAAM;KACV,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,MAAuB,EAAE,GAAY;IACnE,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IAEpC,OAAO,aAAa,CAAC,QAAQ,EAAE;QAC7B,GAAG,MAAM;KACV,CAAC,CAAC;AACL,CAAC","sourcesContent":["import path from 'path';\nimport type { CloudpackConfig } from './types.js';\nimport { readJson, readJsonSync, writeJson, writeJsonSync } from '@ms-cloudpack/json-utilities';\n\nexport const configFileName = 'cloudpack.config.json';\n\n/**\n * @param cwd - base path of the config file\n * @returns the path of the config file\n */\nexport function getConfigPath(cwd?: string) {\n  const basePath = cwd || process.cwd();\n  return path.join(basePath, configFileName);\n}\n\n/**\n * Reads the config file synchronously\n * @param cwd - base path of the config file\n * @returns cloudpack config object or empty object if no config file exists.\n */\nexport function readConfigSync(cwd?: string) {\n  const filePath = getConfigPath(cwd);\n  const config: CloudpackConfig = readJsonSync(filePath) || {};\n\n  return config;\n}\n\n/**\n * Reads the config file asynchronously\n * @param cwd - base path of the config file\n * @returns cloudpack config object or empty object if no config file exists.\n */\nexport async function readConfig(cwd?: string) {\n  const filePath = getConfigPath(cwd);\n  const config: CloudpackConfig = (await readJson(filePath)) || {};\n\n  return config;\n}\n\n/**\n * Writes the config file asynchronously\n * @param config - updated config object to be written\n * @param cwd - base path of the config file\n */\nexport async function writeConfig(config: CloudpackConfig, cwd?: string) {\n  const filePath = getConfigPath(cwd);\n\n  return writeJson(filePath, {\n    ...config,\n  });\n}\n\n/**\n * Writes the config file synchronously\n * @param config - updated config object to be written\n * @param cwd - base path of the config file\n */\nexport function writeConfigSync(config: CloudpackConfig, cwd?: string) {\n  const filePath = getConfigPath(cwd);\n\n  return writeJsonSync(filePath, {\n    ...config,\n  });\n}\n"]}

package/lib/index.d.ts

@@ -1,3 +1,3 @@
 export { configTemplate } from './configTemplate.js';
 export { configFileName, getConfigPath, readConfig, readConfigSync, writeConfig, writeConfigSync } from './config.js';
-export type { CloudpackConfig, TelemetryConfig } from './types.js';
+export type { CloudpackConfig, DevServer, PackageOverride, Route, TelemetryConfig } from './types.js';

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC","sourcesContent":["export { configTemplate } from './configTemplate.js';\nexport { configFileName, getConfigPath, readConfig, readConfigSync, writeConfig, writeConfigSync } from './config.js';\nexport type { CloudpackConfig, TelemetryConfig } from './types.js';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC","sourcesContent":["export { configTemplate } from './configTemplate.js';\nexport { configFileName, getConfigPath, readConfig, readConfigSync, writeConfig, writeConfigSync } from './config.js';\nexport type { CloudpackConfig, DevServer, PackageOverride, Route, TelemetryConfig } from './types.js';\n"]}

package/lib/types.d.ts

@@ -81,4 +81,15 @@ export interface CloudpackConfig {
      * A set of options for configuring telemetry
      */
     telemetry?: TelemetryConfig;
+    /**
+     * A set of options for configuring the experience. Features can be set to true to change the default
+     * behavior.
+     */
+    features?: {
+        /**
+         * If true, no source maps will be generated for any bundles produced. This might be useful if sourcemap
+         * generation causes performance issues.
+         */
+        disableSourceMaps?: boolean;
+    };
 }

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { PackageJson } from '@ms-cloudpack/bundler-types';\nimport type { HttpsConfig } from '@ms-cloudpack/create-express-app';\n\nexport interface PackageOverride {\n  name: string;\n  versionRequirement: string;\n  isInternal?: boolean;\n  overrides: PackageJson;\n}\n\nexport interface Route {\n  /**\n   * The url path part to match. Start paths with a leading slash, e.g. `'/my-route'`. You can also\n   * use wildcards (`*`), e.g. `'/my-route/*'` to match all paths starting with `'/my-route'`.\n   */\n  match: string;\n\n  /**\n   * The path relative to the app root to static assets. If this is provided, renderScript/exportEntry\n   * will be ignored.\n   */\n  staticPath?: string;\n\n  /**\n   * Path to a .js or .html file used for rendering the route. If a script is provided, it must\n   * export a default function implementing `CreateHtmlFunction` defined in `@ms-cloudpack/cli`.\n   */\n  renderScript?: string;\n\n  /**\n   * The key in the exports map which represents the entry point app script for this route.\n   * Default is '.', meaning the main package export key.\n   */\n  exportEntry?: string;\n}\n\nexport interface DevServer {\n  /**\n   * The domain name of the server.\n   */\n  domain?: string;\n\n  /**\n   * The ports to be used by the server.\n   * It can be a number or an array of numbers.\n   * If ports are provided, an error will be thrown if none are available.\n   * If no ports are provided, the server will attempt to find an available port.\n   */\n  port?: number | number[];\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?: HttpsConfig;\n\n  /**\n   * If provided, will override where the publicDir is located, relative to the app package folder.\n   * Defaults to `./public`. The same thing can be achieved with `routes`, using route: '*' and\n   * staticPath: './public', so the `publicPath` setting may be removed in the future.\n   */\n  publicPath?: string;\n\n  /**\n   * If provided, will register routes with the dev server to host various pages.\n   */\n  routes?: Route[];\n}\n\nexport interface TelemetryConfig {\n  /**\n   * Application Insights instrumentation key.\n   */\n  instrumentationKey: string;\n}\n\n/**\n * Per-application configuration for Cloudpack.\n */\nexport interface CloudpackConfig {\n  /**\n   * An array of PackageOverride objects, used to provide overrides for packages without modifying their\n   * definitions directly. This is primarily used for providing exports maps for packages that don't have them.\n   */\n  packageOverrides?: PackageOverride[];\n\n  /**\n   * A set of options for configuring how the dev server works.\n   */\n  devServer?: DevServer;\n\n  /**\n   * A set of options for configuring telemetry\n   */\n  telemetry?: TelemetryConfig;\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import type { PackageJson } from '@ms-cloudpack/bundler-types';\nimport type { HttpsConfig } from '@ms-cloudpack/create-express-app';\n\nexport interface PackageOverride {\n  name: string;\n  versionRequirement: string;\n  isInternal?: boolean;\n  overrides: PackageJson;\n}\n\nexport interface Route {\n  /**\n   * The url path part to match. Start paths with a leading slash, e.g. `'/my-route'`. You can also\n   * use wildcards (`*`), e.g. `'/my-route/*'` to match all paths starting with `'/my-route'`.\n   */\n  match: string;\n\n  /**\n   * The path relative to the app root to static assets. If this is provided, renderScript/exportEntry\n   * will be ignored.\n   */\n  staticPath?: string;\n\n  /**\n   * Path to a .js or .html file used for rendering the route. If a script is provided, it must\n   * export a default function implementing `CreateHtmlFunction` defined in `@ms-cloudpack/cli`.\n   */\n  renderScript?: string;\n\n  /**\n   * The key in the exports map which represents the entry point app script for this route.\n   * Default is '.', meaning the main package export key.\n   */\n  exportEntry?: string;\n}\n\nexport interface DevServer {\n  /**\n   * The domain name of the server.\n   */\n  domain?: string;\n\n  /**\n   * The ports to be used by the server.\n   * It can be a number or an array of numbers.\n   * If ports are provided, an error will be thrown if none are available.\n   * If no ports are provided, the server will attempt to find an available port.\n   */\n  port?: number | number[];\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?: HttpsConfig;\n\n  /**\n   * If provided, will override where the publicDir is located, relative to the app package folder.\n   * Defaults to `./public`. The same thing can be achieved with `routes`, using route: '*' and\n   * staticPath: './public', so the `publicPath` setting may be removed in the future.\n   */\n  publicPath?: string;\n\n  /**\n   * If provided, will register routes with the dev server to host various pages.\n   */\n  routes?: Route[];\n}\n\nexport interface TelemetryConfig {\n  /**\n   * Application Insights instrumentation key.\n   */\n  instrumentationKey: string;\n}\n\n/**\n * Per-application configuration for Cloudpack.\n */\nexport interface CloudpackConfig {\n  /**\n   * An array of PackageOverride objects, used to provide overrides for packages without modifying their\n   * definitions directly. This is primarily used for providing exports maps for packages that don't have them.\n   */\n  packageOverrides?: PackageOverride[];\n\n  /**\n   * A set of options for configuring how the dev server works.\n   */\n  devServer?: DevServer;\n\n  /**\n   * A set of options for configuring telemetry\n   */\n  telemetry?: TelemetryConfig;\n\n  /**\n   * A set of options for configuring the experience. Features can be set to true to change the default\n   * behavior.\n   */\n  features?: {\n    /**\n     * If true, no source maps will be generated for any bundles produced. This might be useful if sourcemap\n     * generation causes performance issues.\n     */\n    disableSourceMaps?: boolean;\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/config",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Configuration handling for cloudpack.",
   "license": "MIT",
   "type": "module",
@@ -13,7 +13,7 @@
     }
   },
   "dependencies": {
-    "@ms-cloudpack/bundler-types": "^0.11.0",
+    "@ms-cloudpack/bundler-types": "^0.12.0",
     "@ms-cloudpack/create-express-app": "^1.3.0",
     "@ms-cloudpack/json-utilities": "^0.0.5"
   },