@ms-cloudpack/common-types
Advanced tools
Comparing version 0.3.0 to 0.4.0
import type { GeneratedConfig } from './GeneratedConfig.js'; | ||
import type { UserConfig } from './UserConfig.js'; | ||
import type { AppConfig } from './AppConfig.js'; | ||
/** | ||
* The merged result of user-provided and generated configuration for Cloudpack. | ||
*/ | ||
export type CloudpackConfig = UserConfig & { | ||
export type CloudpackConfig = AppConfig & { | ||
generated: GeneratedConfig; | ||
}; | ||
//# sourceMappingURL=CloudpackConfig.d.ts.map |
@@ -23,3 +23,3 @@ export { allFeatures } from './allFeatures.js'; | ||
export type { TelemetryConfig } from './TelemetryConfig.js'; | ||
export type { UserConfig } from './UserConfig.js'; | ||
export type { AppConfig } from './AppConfig.js'; | ||
//# sourceMappingURL=index.d.ts.map |
@@ -1,77 +0,4 @@ | ||
import type { DevServer } from './DevServer.js'; | ||
import type { Features } from './Features.js'; | ||
import type { PackageSettings } from './PackageSettings.js'; | ||
import type { TelemetryConfig } from './TelemetryConfig.js'; | ||
/** | ||
* Per-application user-provided configuration for Cloudpack. | ||
*/ | ||
export interface UserConfig { | ||
/** | ||
* Extend the configuration from another file: either an import path or a relative path | ||
* (resolved from the config file's location). | ||
* | ||
* If an array, later files will take precedence when merging. | ||
* (The user config always takes precedence over any extended config.) | ||
* | ||
* Config merging approach: | ||
* - Objects will be deeply merged. | ||
* - Primitive values will be overwritten. | ||
* - Arrays will be overwritten, EXCEPT for `packageSettings`, which will be concatenated. | ||
*/ | ||
extends?: string | string[]; | ||
/** | ||
* A set of options for configuring how the dev server works. | ||
*/ | ||
devServer?: DevServer; | ||
/** | ||
* 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?: Features; | ||
/** | ||
* Help message to display when Cloudpack starts up. | ||
*/ | ||
helpMessage?: string; | ||
/** | ||
* An array of PackageSettings objects, used to provide settings for how we bundle packages. | ||
*/ | ||
packageSettings?: PackageSettings[]; | ||
/** | ||
* An optional list of commands (followed by a string array of args for that command) | ||
* to be executed prior to Cloudpack bundle | ||
*/ | ||
dependsOn?: [string, string[]][]; | ||
/** | ||
* Glob pattern to match `patch-package` patch files, relative to the project root | ||
* (usually the same as the repository root). | ||
* @default "patches/*.patch" | ||
*/ | ||
patchFilesGlobPattern?: string; | ||
/** | ||
* Azure Blob Storage configuration for remote cache - uploading and downloading packages. | ||
* If this is not provided, the remote cache will not be used. | ||
*/ | ||
remoteCache?: { | ||
/** | ||
* The name of the Azure Blob Storage account. | ||
*/ | ||
storageAccount: string; | ||
/** | ||
* The name of the container to use for the remote cache. Container must already exist. | ||
*/ | ||
container: string; | ||
/** | ||
* The Microsoft Entra tenant (directory) ID. This will ensure that only users from this tenant can access the remote cache. | ||
*/ | ||
tenantId?: string; | ||
}; | ||
/** | ||
* A list of package names that should never be excluded or included from the bundle. | ||
*/ | ||
neverExcludeDependencies?: string[]; | ||
} | ||
import type { AppConfig } from './AppConfig.js'; | ||
/** @deprecated Use `AppConfig` instead */ | ||
export type UserConfig = AppConfig; | ||
//# sourceMappingURL=UserConfig.d.ts.map |
{ | ||
"name": "@ms-cloudpack/common-types", | ||
"version": "0.3.0", | ||
"version": "0.4.0", | ||
"description": "Common types for Cloudpack.", | ||
@@ -5,0 +5,0 @@ "license": "MIT", |
{ | ||
"$schema": "http://json-schema.org/draft-07/schema#", | ||
"type": "object", | ||
"properties": { | ||
"extends": { | ||
"anyOf": [ | ||
{ | ||
"type": "string" | ||
"$ref": "#/definitions/AppConfig", | ||
"deprecated": "Use `AppConfig` instead", | ||
"definitions": { | ||
"AppConfig": { | ||
"type": "object", | ||
"properties": { | ||
"extends": { | ||
"anyOf": [ | ||
{ | ||
"type": "string" | ||
}, | ||
{ | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
} | ||
} | ||
], | ||
"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." | ||
}, | ||
{ | ||
"devServer": { | ||
"$ref": "#/definitions/DevServer", | ||
"description": "A set of options for configuring how the dev server works." | ||
}, | ||
"telemetry": { | ||
"$ref": "#/definitions/TelemetryConfig", | ||
"description": "A set of options for configuring telemetry" | ||
}, | ||
"features": { | ||
"$ref": "#/definitions/Features", | ||
"description": "A set of options for configuring the experience. Features can be set to true to change the default behavior." | ||
}, | ||
"helpMessage": { | ||
"type": "string", | ||
"description": "Help message to display when Cloudpack starts up." | ||
}, | ||
"packageSettings": { | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
} | ||
} | ||
], | ||
"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." | ||
}, | ||
"devServer": { | ||
"$ref": "#/definitions/DevServer", | ||
"description": "A set of options for configuring how the dev server works." | ||
}, | ||
"telemetry": { | ||
"$ref": "#/definitions/TelemetryConfig", | ||
"description": "A set of options for configuring telemetry" | ||
}, | ||
"features": { | ||
"$ref": "#/definitions/Features", | ||
"description": "A set of options for configuring the experience. Features can be set to true to change the default behavior." | ||
}, | ||
"helpMessage": { | ||
"type": "string", | ||
"description": "Help message to display when Cloudpack starts up." | ||
}, | ||
"packageSettings": { | ||
"type": "array", | ||
"items": { | ||
"$ref": "#/definitions/PackageSettings" | ||
}, | ||
"description": "An array of PackageSettings objects, used to provide settings for how we bundle packages." | ||
}, | ||
"dependsOn": { | ||
"type": "array", | ||
"items": { | ||
"type": "array", | ||
"minItems": 2, | ||
"items": [ | ||
{ | ||
"type": "string" | ||
"$ref": "#/definitions/PackageSettings" | ||
}, | ||
{ | ||
"description": "An array of PackageSettings objects, used to provide settings for how we bundle packages." | ||
}, | ||
"dependsOn": { | ||
"type": "array", | ||
"items": { | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
} | ||
} | ||
], | ||
"maxItems": 2 | ||
}, | ||
"description": "An optional list of commands (followed by a string array of args for that command) to be executed prior to Cloudpack bundle" | ||
}, | ||
"patchFilesGlobPattern": { | ||
"type": "string", | ||
"description": "Glob pattern to match `patch-package` patch files, relative to the project root (usually the same as the repository root).", | ||
"default": "patches/*.patch" | ||
}, | ||
"remoteCache": { | ||
"type": "object", | ||
"properties": { | ||
"storageAccount": { | ||
"type": "string", | ||
"description": "The name of the Azure Blob Storage account." | ||
"minItems": 2, | ||
"items": [ | ||
{ | ||
"type": "string" | ||
}, | ||
{ | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
} | ||
} | ||
], | ||
"maxItems": 2 | ||
}, | ||
"description": "An optional list of commands (followed by a string array of args for that command) to be executed prior to Cloudpack bundle" | ||
}, | ||
"container": { | ||
"patchFilesGlobPattern": { | ||
"type": "string", | ||
"description": "The name of the container to use for the remote cache. Container must already exist." | ||
"description": "Glob pattern to match `patch-package` patch files, relative to the project root (usually the same as the repository root).", | ||
"default": "patches/*.patch" | ||
}, | ||
"tenantId": { | ||
"type": "string", | ||
"description": "The Microsoft Entra tenant (directory) ID. This will ensure that only users from this tenant can access the remote cache." | ||
"remoteCache": { | ||
"type": "object", | ||
"properties": { | ||
"storageAccount": { | ||
"type": "string", | ||
"description": "The name of the Azure Blob Storage account." | ||
}, | ||
"container": { | ||
"type": "string", | ||
"description": "The name of the container to use for the remote cache. Container must already exist." | ||
}, | ||
"tenantId": { | ||
"type": "string", | ||
"description": "The Microsoft Entra tenant (directory) ID. This will ensure that only users from this tenant can access the remote cache." | ||
} | ||
}, | ||
"required": [ | ||
"storageAccount", | ||
"container" | ||
], | ||
"additionalProperties": false, | ||
"description": "Azure Blob Storage configuration for remote cache - uploading and downloading packages. If this is not provided, the remote cache will not be used." | ||
}, | ||
"neverExcludeDependencies": { | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
}, | ||
"description": "A list of package names that should never be excluded or included from the bundle." | ||
} | ||
}, | ||
"required": [ | ||
"storageAccount", | ||
"container" | ||
], | ||
"additionalProperties": false, | ||
"description": "Azure Blob Storage configuration for remote cache - uploading and downloading packages. If this is not provided, the remote cache will not be used." | ||
"description": "Per-application user-provided configuration for Cloudpack." | ||
}, | ||
"neverExcludeDependencies": { | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
}, | ||
"description": "A list of package names that should never be excluded or included from the bundle." | ||
}, | ||
"$schema": { | ||
"type": "string" | ||
} | ||
}, | ||
"additionalProperties": false, | ||
"description": "Per-application user-provided configuration for Cloudpack.", | ||
"definitions": { | ||
"DevServer": { | ||
@@ -682,3 +683,8 @@ "type": "object", | ||
} | ||
}, | ||
"properties": { | ||
"$schema": { | ||
"type": "string" | ||
} | ||
} | ||
} |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
161601
106
2758