@ms-cloudpack/common-types 0.2.5 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -109,6 +109,13 @@
109
109
  }
110
110
  ],
111
111
  "description": "Controls the behavior of the `verifyExports` feature when checking consumed exports from this package:\n- If true, don't check this package's exports at all.\n- If an object, this is a mapping from package import paths to export names to ignore. Examples: - To ignore top-level exports: `{ \".\": [\"badName\"] }` - To ignore exports from another path: `{ \"./lib/foo\": [\"badName\"] }`"
112
+ },
113
+ "dynamicImports": {
114
+ "type": "array",
115
+ "items": {
116
+ "type": "string"
117
+ },
118
+ "description": "Paths to files that include dynamic imports. These are used by ori to determine which files should be processed by the dynamic-imports plugin."
112
119
  }
113
120
  },
114
121
  "required": [
@@ -1,106 +1,107 @@
1
1
  {
2
2
  "$schema": "http://json-schema.org/draft-07/schema#",
3
- "type": "object",
4
- "properties": {
5
- "extends": {
6
- "anyOf": [
7
- {
8
- "type": "string"
3
+ "$ref": "#/definitions/AppConfig",
4
+ "deprecated": "Use `AppConfig` instead",
5
+ "definitions": {
6
+ "AppConfig": {
7
+ "type": "object",
8
+ "properties": {
9
+ "extends": {
10
+ "anyOf": [
11
+ {
12
+ "type": "string"
13
+ },
14
+ {
15
+ "type": "array",
16
+ "items": {
17
+ "type": "string"
18
+ }
19
+ }
20
+ ],
21
+ "description": "Extend the configuration from another file: either an import path or a relative path (resolved from the config file's location).\n\nIf an array, later files will take precedence when merging. (The user config always takes precedence over any extended config.)\n\nConfig 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."
9
22
  },
10
- {
23
+ "devServer": {
24
+ "$ref": "#/definitions/DevServer",
25
+ "description": "A set of options for configuring how the dev server works."
26
+ },
27
+ "telemetry": {
28
+ "$ref": "#/definitions/TelemetryConfig",
29
+ "description": "A set of options for configuring telemetry"
30
+ },
31
+ "features": {
32
+ "$ref": "#/definitions/Features",
33
+ "description": "A set of options for configuring the experience. Features can be set to true to change the default behavior."
34
+ },
35
+ "helpMessage": {
36
+ "type": "string",
37
+ "description": "Help message to display when Cloudpack starts up."
38
+ },
39
+ "packageSettings": {
11
40
  "type": "array",
12
41
  "items": {
13
- "type": "string"
14
- }
15
- }
16
- ],
17
- "description": "Extend the configuration from another file: either an import path or a relative path (resolved from the config file's location).\n\nIf an array, later files will take precedence when merging. (The user config always takes precedence over any extended config.)\n\nConfig 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."
18
- },
19
- "devServer": {
20
- "$ref": "#/definitions/DevServer",
21
- "description": "A set of options for configuring how the dev server works."
22
- },
23
- "telemetry": {
24
- "$ref": "#/definitions/TelemetryConfig",
25
- "description": "A set of options for configuring telemetry"
26
- },
27
- "features": {
28
- "$ref": "#/definitions/Features",
29
- "description": "A set of options for configuring the experience. Features can be set to true to change the default behavior."
30
- },
31
- "helpMessage": {
32
- "type": "string",
33
- "description": "Help message to display when Cloudpack starts up."
34
- },
35
- "packageSettings": {
36
- "type": "array",
37
- "items": {
38
- "$ref": "#/definitions/PackageSettings"
39
- },
40
- "description": "An array of PackageSettings objects, used to provide settings for how we bundle packages."
41
- },
42
- "dependsOn": {
43
- "type": "array",
44
- "items": {
45
- "type": "array",
46
- "minItems": 2,
47
- "items": [
48
- {
49
- "type": "string"
42
+ "$ref": "#/definitions/PackageSettings"
50
43
  },
51
- {
44
+ "description": "An array of PackageSettings objects, used to provide settings for how we bundle packages."
45
+ },
46
+ "dependsOn": {
47
+ "type": "array",
48
+ "items": {
52
49
  "type": "array",
53
- "items": {
54
- "type": "string"
55
- }
56
- }
57
- ],
58
- "maxItems": 2
59
- },
60
- "description": "An optional list of commands (followed by a string array of args for that command) to be executed prior to Cloudpack bundle"
61
- },
62
- "patchFilesGlobPattern": {
63
- "type": "string",
64
- "description": "Glob pattern to match `patch-package` patch files, relative to the project root (usually the same as the repository root).",
65
- "default": "patches/*.patch"
66
- },
67
- "remoteCache": {
68
- "type": "object",
69
- "properties": {
70
- "storageAccount": {
71
- "type": "string",
72
- "description": "The name of the Azure Blob Storage account."
50
+ "minItems": 2,
51
+ "items": [
52
+ {
53
+ "type": "string"
54
+ },
55
+ {
56
+ "type": "array",
57
+ "items": {
58
+ "type": "string"
59
+ }
60
+ }
61
+ ],
62
+ "maxItems": 2
63
+ },
64
+ "description": "An optional list of commands (followed by a string array of args for that command) to be executed prior to Cloudpack bundle"
73
65
  },
74
- "container": {
66
+ "patchFilesGlobPattern": {
75
67
  "type": "string",
76
- "description": "The name of the container to use for the remote cache. Container must already exist."
68
+ "description": "Glob pattern to match `patch-package` patch files, relative to the project root (usually the same as the repository root).",
69
+ "default": "patches/*.patch"
77
70
  },
78
- "tenantId": {
79
- "type": "string",
80
- "description": "The Microsoft Entra tenant (directory) ID. This will ensure that only users from this tenant can access the remote cache."
71
+ "remoteCache": {
72
+ "type": "object",
73
+ "properties": {
74
+ "storageAccount": {
75
+ "type": "string",
76
+ "description": "The name of the Azure Blob Storage account."
77
+ },
78
+ "container": {
79
+ "type": "string",
80
+ "description": "The name of the container to use for the remote cache. Container must already exist."
81
+ },
82
+ "tenantId": {
83
+ "type": "string",
84
+ "description": "The Microsoft Entra tenant (directory) ID. This will ensure that only users from this tenant can access the remote cache."
85
+ }
86
+ },
87
+ "required": [
88
+ "storageAccount",
89
+ "container"
90
+ ],
91
+ "additionalProperties": false,
92
+ "description": "Azure Blob Storage configuration for remote cache - uploading and downloading packages. If this is not provided, the remote cache will not be used."
93
+ },
94
+ "neverExcludeDependencies": {
95
+ "type": "array",
96
+ "items": {
97
+ "type": "string"
98
+ },
99
+ "description": "A list of package names that should never be excluded or included from the bundle."
81
100
  }
82
101
  },
83
- "required": [
84
- "storageAccount",
85
- "container"
86
- ],
87
102
  "additionalProperties": false,
88
- "description": "Azure Blob Storage configuration for remote cache - uploading and downloading packages. If this is not provided, the remote cache will not be used."
89
- },
90
- "neverExcludeDependencies": {
91
- "type": "array",
92
- "items": {
93
- "type": "string"
94
- },
95
- "description": "A list of package names that should never be excluded or included from the bundle."
103
+ "description": "Per-application user-provided configuration for Cloudpack."
96
104
  },
97
- "$schema": {
98
- "type": "string"
99
- }
100
- },
101
- "additionalProperties": false,
102
- "description": "Per-application user-provided configuration for Cloudpack.",
103
- "definitions": {
104
105
  "DevServer": {
105
106
  "type": "object",
106
107
  "properties": {
@@ -137,10 +138,6 @@
137
138
  "$ref": "#/definitions/HttpsConfig",
138
139
  "description": "The config settings for the https server. Paths to files are accepted for 'ca', 'cert', 'key', and 'pfx' settings. Everything else is passed directly to the https.createServer() method. If not provided, the server will use http."
139
140
  },
140
- "publicPath": {
141
- "type": "string",
142
- "description": "If provided, will override where the publicDir is located, relative to the app package folder. Defaults to `./public`. The same thing can be achieved with `routes`, using route: '*' and staticPath: './public', so the `publicPath` setting may be removed in the future."
143
- },
144
141
  "routes": {
145
142
  "type": "array",
146
143
  "items": {
@@ -447,7 +444,7 @@
447
444
  },
448
445
  "renderScript": {
449
446
  "type": "string",
450
- "description": "Path to a .js or .html file used for rendering the route. If a script is provided, it must export a default function implementing `CreateHtmlFunction` defined in `@ms-cloudpack/cli`."
447
+ "description": "Path to a .js or .html file used for rendering the route. If a script is provided, it must export a default function implementing `RenderRouteFunction` defined in `@ms-cloudpack/app-server`."
451
448
  },
452
449
  "exportEntry": {
453
450
  "type": "string",
@@ -495,6 +492,9 @@
495
492
  },
496
493
  "syncBundles": {
497
494
  "type": "boolean"
495
+ },
496
+ "builtinDynamicImports": {
497
+ "type": "boolean"
498
498
  }
499
499
  },
500
500
  "additionalProperties": false,
@@ -586,6 +586,13 @@
586
586
  }
587
587
  ],
588
588
  "description": "Controls the behavior of the `verifyExports` feature when checking consumed exports from this package:\n- If true, don't check this package's exports at all.\n- If an object, this is a mapping from package import paths to export names to ignore. Examples: - To ignore top-level exports: `{ \".\": [\"badName\"] }` - To ignore exports from another path: `{ \"./lib/foo\": [\"badName\"] }`"
589
+ },
590
+ "dynamicImports": {
591
+ "type": "array",
592
+ "items": {
593
+ "type": "string"
594
+ },
595
+ "description": "Paths to files that include dynamic imports. These are used by ori to determine which files should be processed by the dynamic-imports plugin."
589
596
  }
590
597
  },
591
598
  "required": [
@@ -673,5 +680,10 @@
673
680
  },
674
681
  "description": "Definition of the root exports object. Keys can be either conditions or import paths."
675
682
  }
683
+ },
684
+ "properties": {
685
+ "$schema": {
686
+ "type": "string"
687
+ }
676
688
  }
677
689
  }