@ms-cloudpack/common-types 0.24.4 → 0.24.6

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.
@@ -16,9 +16,14 @@ export type CloudpackConfig = Omit<AppConfig, 'routes' | 'server' | 'bundlerCapa
16
16
  */
17
17
  server?: Omit<ServerConfig, 'routes'>;
18
18
  /**
19
- * Mode to run the app in.
19
+ * Mode to run the app in. This is set via the CLI and defaults to `'library'`.
20
20
  */
21
21
  mode: BundleMode;
22
+ /**
23
+ * If true, write `bundle-info.json`, `[bundler]-input.json`, and [bundler]-output.json`
24
+ * files to the output folder.
25
+ */
26
+ logBundleInfo?: boolean;
22
27
  /**
23
28
  * Generated config settings.
24
29
  */
@@ -1 +1 @@
1
- {"version":3,"file":"CloudpackConfig.d.ts","sourceRoot":"","sources":["../src/CloudpackConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;GAEG;AAEH,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,GAAG,QAAQ,GAAG,6BAA6B,CAAC,GAAG;IACnG;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAE9C;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IAEjB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtD,CAAC"}
1
+ {"version":3,"file":"CloudpackConfig.d.ts","sourceRoot":"","sources":["../src/CloudpackConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;GAEG;AAEH,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,EAAE,QAAQ,GAAG,QAAQ,GAAG,6BAA6B,CAAC,GAAG;IACnG;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAEtC;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;IAE9C;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IAEjB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"CloudpackConfig.js","sourceRoot":"","sources":["../src/CloudpackConfig.ts"],"names":[],"mappings":"","sourcesContent":["import type { GeneratedConfig } from './GeneratedConfig.js';\nimport type { AppConfig } from './AppConfig.js';\nimport type { BundleMode } from './BundleMode.js';\nimport type { Route } from './Route.js';\nimport type { ServerConfig } from './ServerConfig.js';\n\n/**\n * The merged result of user-provided and generated configuration for Cloudpack.\n */\n\nexport type CloudpackConfig = Omit<AppConfig, 'routes' | 'server' | 'bundlerCapabilitiesRegistry'> & {\n /**\n * The path to the app's package.\n */\n appPath: string;\n\n /**\n * Dev server settings.\n */\n server?: Omit<ServerConfig, 'routes'>;\n\n /**\n * Mode to run the app in.\n */\n mode: BundleMode;\n\n /**\n * Generated config settings.\n */\n generated: GeneratedConfig;\n\n /**\n * An immutable snapshot of the generated config as it is when start or init commands first begin\n */\n generatedSnapshot?: Readonly<GeneratedConfig>;\n\n /**\n * Routes which have been expanded from shorthand entries.\n */\n routes?: Route[];\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 absolute file URL of the capability implementation (resolved by `readAppConfig`).\n */\n bundlerCapabilitiesRegistry?: Record<string, string>;\n};\n"]}
1
+ {"version":3,"file":"CloudpackConfig.js","sourceRoot":"","sources":["../src/CloudpackConfig.ts"],"names":[],"mappings":"","sourcesContent":["import type { GeneratedConfig } from './GeneratedConfig.js';\nimport type { AppConfig } from './AppConfig.js';\nimport type { BundleMode } from './BundleMode.js';\nimport type { Route } from './Route.js';\nimport type { ServerConfig } from './ServerConfig.js';\n\n/**\n * The merged result of user-provided and generated configuration for Cloudpack.\n */\n\nexport type CloudpackConfig = Omit<AppConfig, 'routes' | 'server' | 'bundlerCapabilitiesRegistry'> & {\n /**\n * The path to the app's package.\n */\n appPath: string;\n\n /**\n * Dev server settings.\n */\n server?: Omit<ServerConfig, 'routes'>;\n\n /**\n * Mode to run the app in. This is set via the CLI and defaults to `'library'`.\n */\n mode: BundleMode;\n\n /**\n * If true, write `bundle-info.json`, `[bundler]-input.json`, and [bundler]-output.json`\n * files to the output folder.\n */\n logBundleInfo?: boolean;\n\n /**\n * Generated config settings.\n */\n generated: GeneratedConfig;\n\n /**\n * An immutable snapshot of the generated config as it is when start or init commands first begin\n */\n generatedSnapshot?: Readonly<GeneratedConfig>;\n\n /**\n * Routes which have been expanded from shorthand entries.\n */\n routes?: Route[];\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 absolute file URL of the capability implementation (resolved by `readAppConfig`).\n */\n bundlerCapabilitiesRegistry?: Record<string, string>;\n};\n"]}
@@ -1,7 +1,12 @@
1
+ import type { PageLoadTimePerformanceEntry } from '@ms-cloudpack/common-types-browser';
1
2
  export interface TelemetryConfig {
2
3
  /**
3
4
  * Application Insights connection string.
4
5
  */
5
- connectionString: string;
6
+ connectionString?: string;
7
+ /**
8
+ * Cloudpack will query this performance entry to determine the page load time.
9
+ */
10
+ pageLoadTimePerformanceEntry?: PageLoadTimePerformanceEntry;
6
11
  }
7
12
  //# sourceMappingURL=TelemetryConfig.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"TelemetryConfig.d.ts","sourceRoot":"","sources":["../src/TelemetryConfig.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;CAC1B"}
1
+ {"version":3,"file":"TelemetryConfig.d.ts","sourceRoot":"","sources":["../src/TelemetryConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,oCAAoC,CAAC;AAEvF,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,4BAA4B,CAAC,EAAE,4BAA4B,CAAC;CAC7D"}
@@ -1 +1 @@
1
- {"version":3,"file":"TelemetryConfig.js","sourceRoot":"","sources":["../src/TelemetryConfig.ts"],"names":[],"mappings":"","sourcesContent":["export interface TelemetryConfig {\n /**\n * Application Insights connection string.\n */\n connectionString: string;\n}\n"]}
1
+ {"version":3,"file":"TelemetryConfig.js","sourceRoot":"","sources":["../src/TelemetryConfig.ts"],"names":[],"mappings":"","sourcesContent":["import type { PageLoadTimePerformanceEntry } from '@ms-cloudpack/common-types-browser';\n\nexport interface TelemetryConfig {\n /**\n * Application Insights connection string.\n */\n connectionString?: string;\n\n /**\n * Cloudpack will query this performance entry to determine the page load time.\n */\n pageLoadTimePerformanceEntry?: PageLoadTimePerformanceEntry;\n}\n"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ms-cloudpack/common-types",
3
- "version": "0.24.4",
3
+ "version": "0.24.6",
4
4
  "description": "Common types for Cloudpack.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -14,6 +14,7 @@
14
14
  }
15
15
  },
16
16
  "dependencies": {
17
+ "@ms-cloudpack/common-types-browser": "^0.5.4",
17
18
  "@types/express": "^4.17.16"
18
19
  },
19
20
  "devDependencies": {
@@ -742,12 +742,41 @@
742
742
  "connectionString": {
743
743
  "type": "string",
744
744
  "description": "Application Insights connection string."
745
+ },
746
+ "pageLoadTimePerformanceEntry": {
747
+ "$ref": "#/definitions/PageLoadTimePerformanceEntry",
748
+ "description": "Cloudpack will query this performance entry to determine the page load time."
749
+ }
750
+ },
751
+ "additionalProperties": false
752
+ },
753
+ "PageLoadTimePerformanceEntry": {
754
+ "type": "object",
755
+ "properties": {
756
+ "name": {
757
+ "type": "string",
758
+ "description": "The name of the performance mark/measure to query."
759
+ },
760
+ "type": {
761
+ "type": "string",
762
+ "enum": [
763
+ "mark",
764
+ "measure"
765
+ ],
766
+ "description": "The type of performance entry to query.",
767
+ "default": "mark"
768
+ },
769
+ "timeout": {
770
+ "type": "number",
771
+ "description": "The maximum time in milliseconds to wait for the performance mark to be set.",
772
+ "default": "5 mins"
745
773
  }
746
774
  },
747
775
  "required": [
748
- "connectionString"
776
+ "name"
749
777
  ],
750
- "additionalProperties": false
778
+ "additionalProperties": false,
779
+ "description": "Client and server side object for Cloudpack to detect app-specific page load time entry"
751
780
  },
752
781
  "Features": {
753
782
  "type": "object",
@@ -743,12 +743,41 @@
743
743
  "connectionString": {
744
744
  "type": "string",
745
745
  "description": "Application Insights connection string."
746
+ },
747
+ "pageLoadTimePerformanceEntry": {
748
+ "$ref": "#/definitions/PageLoadTimePerformanceEntry",
749
+ "description": "Cloudpack will query this performance entry to determine the page load time."
750
+ }
751
+ },
752
+ "additionalProperties": false
753
+ },
754
+ "PageLoadTimePerformanceEntry": {
755
+ "type": "object",
756
+ "properties": {
757
+ "name": {
758
+ "type": "string",
759
+ "description": "The name of the performance mark/measure to query."
760
+ },
761
+ "type": {
762
+ "type": "string",
763
+ "enum": [
764
+ "mark",
765
+ "measure"
766
+ ],
767
+ "description": "The type of performance entry to query.",
768
+ "default": "mark"
769
+ },
770
+ "timeout": {
771
+ "type": "number",
772
+ "description": "The maximum time in milliseconds to wait for the performance mark to be set.",
773
+ "default": "5 mins"
746
774
  }
747
775
  },
748
776
  "required": [
749
- "connectionString"
777
+ "name"
750
778
  ],
751
- "additionalProperties": false
779
+ "additionalProperties": false,
780
+ "description": "Client and server side object for Cloudpack to detect app-specific page load time entry"
752
781
  },
753
782
  "Features": {
754
783
  "type": "object",