@azure/provisioning-core 1.0.0-beta.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Release History
+
+## 1.0.0-beta.1 (2026-09-28)
+
+### Features Added
+
+- Initial preview of the Azure Provisioning core authoring primitives. [#39825](https://github.com/Azure/azure-sdk-for-js/pull/39825)

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) Microsoft Corporation.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,40 @@
+# Azure Provisioning core library for JavaScript
+
+`@azure/provisioning-core` provides the shared authoring model for Azure provisioning resource libraries.
+
+## Getting started
+
+Create a deployment stack, then attach resources to the stack or to another provisioning component:
+
+```ts snippet:ignore
+import { ResourceGroup, Stack, fn } from "@azure/provisioning-core";
+
+const stack = new Stack("application");
+
+const resourceGroup = new ResourceGroup(stack, {
+  name: fn.concat("rg-", fn.uniqueString("application")),
+  location: "eastus",
+});
+```
+
+Resource provider packages such as `@azure/provisioning-keyvault` use the same component tree and expression model:
+
+```ts snippet:ignore
+import { ResourceGroup, Stack } from "@azure/provisioning-core";
+import { KeyVault } from "@azure/provisioning-keyvault";
+
+const stack = new Stack("keyvault-deployment");
+const resourceGroup = new ResourceGroup(stack, {
+  name: "rg-keyvault",
+  location: "eastus",
+});
+
+new KeyVault(resourceGroup, {
+  properties: {
+    tenantId: "00000000-0000-0000-0000-000000000000",
+    sku: { family: "A", name: "standard" },
+  },
+});
+```
+
+Provisioning definitions are authored before deployment. Read-only resource properties remain available as expressions for wiring outputs and dependent resources, while only writable properties can be assigned.

package/dist/browser/constructs/built-in-resources/resource-group.d.ts

@@ -0,0 +1,50 @@
+import type { ProvisioningComponent } from "../provisioning-component.js";
+import { type Expression, type ExpressionOrValue, type InputRecord } from "../../expression/expressions.js";
+import type { ResourceNamingRules } from "../../naming/naming-rules.js";
+import type { ExistingResourceProps } from "../resource/resource.js";
+import { Resource } from "../resource/resource.js";
+export interface ResourceGroupProps {
+    name?: ExpressionOrValue<string> | undefined;
+    location: ExpressionOrValue<string>;
+    tags?: Record<string, ExpressionOrValue<string>>;
+    managedBy?: ExpressionOrValue<string>;
+}
+/**
+ * An Azure resource group that establishes a deployment boundary.
+ *
+ * @remarks
+ * Resources created with a `ResourceGroup` as their parent inherit its
+ * location, tags, and naming policy, and deploy at resource-group scope
+ * in the generated Bicep.
+ *
+ * @example
+ * ```typescript snippet:ignore
+ * import { Stack, ResourceGroup } from "@azure/provisioning-core";
+ * import { KeyVault } from "@azure/provisioning-keyvault";
+ *
+ * const stack = new Stack("my-app");
+ * const rg = new ResourceGroup(stack, { location: "eastus" });
+ * const vault = new KeyVault(rg, {
+ *   properties: { tenantId: "...", sku: { family: "A", name: "standard" } },
+ * });
+ * ```
+ */
+export declare class ResourceGroup extends Resource<"Microsoft.Resources/resourceGroups"> {
+    static readonly resourceType: "Microsoft.Resources/resourceGroups";
+    static readonly apiVersion = "2024-03-01";
+    protected static namingRules: ResourceNamingRules;
+    constructor(context: ProvisioningComponent, props: (ResourceGroupProps & {
+        existing?: false;
+    }) | (ExistingResourceProps & {
+        existing: true;
+    }));
+    /** The resource group's location as an expression. */
+    get location(): Expression<string>;
+    set location(value: ExpressionOrValue<string>);
+    get managedBy(): Expression<string>;
+    set managedBy(value: ExpressionOrValue<string> | undefined);
+    get tags(): InputRecord<ExpressionOrValue<string>, Record<string, string>> | undefined;
+    set tags(value: InputRecord<ExpressionOrValue<string>, Record<string, string>> | undefined);
+    add<T extends new (context: ProvisioningComponent, ...args: any[]) => ProvisioningComponent>(ctor: T, ...args: ConstructorParameters<T> extends [any, ...infer Rest] ? Rest : never): InstanceType<T>;
+}
+//# sourceMappingURL=resource-group.d.ts.map

package/dist/browser/constructs/built-in-resources/resource-group.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-group.d.ts","sourceRoot":"","sources":["../../../../src/constructs/built-in-resources/resource-group.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,WAAW,EACjB,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAExE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAgBnD,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IAC7C,QAAQ,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;IACjD,SAAS,CAAC,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,aAAc,SAAQ,QAAQ,CAAC,oCAAoC,CAAC;IAC/E,MAAM,CAAC,QAAQ,CAAC,YAAY,EAAG,oCAAoC,CAAU;IAC7E,MAAM,CAAC,QAAQ,CAAC,UAAU,gBAAgB;IAE1C,SAAS,CAAC,MAAM,CAAC,WAAW,sBAA4B;gBAkBtD,OAAO,EAAE,qBAAqB,EAC9B,KAAK,EACH,CAAC,kBAAkB,GAAG;QAAE,QAAQ,CAAC,EAAE,KAAK,CAAA;KAAE,CAAC,GAAG,CAAC,qBAAqB,GAAG;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,CAAC;IAmB9F,sDAAsD;IACtD,IAAI,QAAQ,IAAI,UAAU,CAAC,MAAM,CAAC,CAEjC;IACD,IAAI,QAAQ,CAAC,KAAK,EAAE,iBAAiB,CAAC,MAAM,CAAC,EAE5C;IAED,IAAI,SAAS,IAAI,UAAU,CAAC,MAAM,CAAC,CAElC;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,iBAAiB,CAAC,MAAM,CAAC,GAAG,SAAS,EAEzD;IAED,IAAI,IAAI,IAAI,WAAW,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,CAIrF;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,EAMzF;IAED,GAAG,CAAC,CAAC,SAAS,KAAK,OAAO,EAAE,qBAAqB,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,qBAAqB,EACzF,IAAI,EAAE,CAAC,EACP,GAAG,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,GAC5E,YAAY,CAAC,CAAC,CAAC;CAGnB"}

package/dist/browser/constructs/built-in-resources/resource-group.js

@@ -0,0 +1,100 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import * as fn from "../../fn.js";
+import { deref } from "../resource/resource-proxy.js";
+import { Resource } from "../resource/resource.js";
+import { createFlatModelShape, createRecordShape, createStringShape } from "../../shape/shape.js";
+const resourceGroupNamingRules = {
+    abbreviation: "rg",
+    minLength: 1,
+    maxLength: 90,
+    validCharacters: {
+        uppercase: true,
+        hyphens: true,
+        underscores: true,
+        periods: true,
+    },
+    scope: "subscription",
+};
+/**
+ * An Azure resource group that establishes a deployment boundary.
+ *
+ * @remarks
+ * Resources created with a `ResourceGroup` as their parent inherit its
+ * location, tags, and naming policy, and deploy at resource-group scope
+ * in the generated Bicep.
+ *
+ * @example
+ * ```typescript snippet:ignore
+ * import { Stack, ResourceGroup } from "@azure/provisioning-core";
+ * import { KeyVault } from "@azure/provisioning-keyvault";
+ *
+ * const stack = new Stack("my-app");
+ * const rg = new ResourceGroup(stack, { location: "eastus" });
+ * const vault = new KeyVault(rg, {
+ *   properties: { tenantId: "...", sku: { family: "A", name: "standard" } },
+ * });
+ * ```
+ */
+export class ResourceGroup extends Resource {
+    static resourceType = "Microsoft.Resources/resourceGroups";
+    static apiVersion = "2024-03-01";
+    static namingRules = resourceGroupNamingRules;
+    static {
+        this.registerShape(createFlatModelShape({
+            name: { armPath: ["name"], value: createStringShape() },
+            location: { armPath: ["location"], value: createStringShape() },
+            tags: {
+                armPath: ["tags"],
+                value: createRecordShape(createStringShape()),
+            },
+            managedBy: { armPath: ["managedBy"], value: createStringShape() },
+        }));
+        this.register();
+    }
+    constructor(context, props) {
+        super(context, {
+            ...props,
+            type: ResourceGroup.resourceType,
+            apiVersion: ResourceGroup.apiVersion,
+        });
+        this._localDeploymentContext = {
+            // Resources inside this RG deploy at RG scope, so the canonical
+            // default is the Bicep runtime expression `resourceGroup().location`
+            // (i.e. the actual location of whichever RG hosts the deployment).
+            // This is correct whether the RG is authored locally or referenced
+            // as `existing`.
+            location: fn.resourceGroup().location,
+            tags: deref(this.tags),
+        };
+    }
+    /** The resource group's location as an expression. */
+    get location() {
+        return this.expr("location");
+    }
+    set location(value) {
+        this.setProperty("location", value);
+    }
+    get managedBy() {
+        return this.expr("managedBy");
+    }
+    set managedBy(value) {
+        this.setProperty("managedBy", value);
+    }
+    get tags() {
+        return this.state.tags === undefined
+            ? undefined
+            : this.expr("tags");
+    }
+    set tags(value) {
+        this.setProperty("tags", value);
+        this._localDeploymentContext = {
+            ...this._localDeploymentContext,
+            tags: deref(this.tags),
+        };
+    }
+    add(ctor, ...args) {
+        return new ctor(this.self, ...args);
+    }
+}
+//# sourceMappingURL=resource-group.js.map

package/dist/browser/constructs/built-in-resources/resource-group.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-group.js","sourceRoot":"","sources":["../../../../src/constructs/built-in-resources/resource-group.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,KAAK,EAAE,MAAM,aAAa,CAAC;AAOlC,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AAEtD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAElG,MAAM,wBAAwB,GAAwB;IACpD,YAAY,EAAE,IAAI;IAClB,SAAS,EAAE,CAAC;IACZ,SAAS,EAAE,EAAE;IACb,eAAe,EAAE;QACf,SAAS,EAAE,IAAI;QACf,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,IAAI;QACjB,OAAO,EAAE,IAAI;KACd;IACD,KAAK,EAAE,cAAc;CACtB,CAAC;AASF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,aAAc,SAAQ,QAA8C;IAC/E,MAAM,CAAU,YAAY,GAAG,oCAA6C,CAAC;IAC7E,MAAM,CAAU,UAAU,GAAG,YAAY,CAAC;IAEhC,MAAM,CAAC,WAAW,GAAG,wBAAwB,CAAC;IAExD;QACE,IAAI,CAAC,aAAa,CAChB,oBAAoB,CAAC;YACnB,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,EAAE;YACvD,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,EAAE;YAC/D,IAAI,EAAE;gBACJ,OAAO,EAAE,CAAC,MAAM,CAAC;gBACjB,KAAK,EAAE,iBAAiB,CAAC,iBAAiB,EAAE,CAAC;aAC9C;YACD,SAAS,EAAE,EAAE,OAAO,EAAE,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,iBAAiB,EAAE,EAAE;SAClE,CAAC,CACH,CAAC;QACF,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAED,YACE,OAA8B,EAC9B,KAC4F;QAE5F,KAAK,CAAC,OAAO,EAAE;YACb,GAAG,KAAK;YACR,IAAI,EAAE,aAAa,CAAC,YAAY;YAChC,UAAU,EAAE,aAAa,CAAC,UAAU;SACrC,CAAC,CAAC;QAEH,IAAI,CAAC,uBAAuB,GAAG;YAC7B,gEAAgE;YAChE,qEAAqE;YACrE,mEAAmE;YACnE,mEAAmE;YACnE,iBAAiB;YACjB,QAAQ,EAAE,EAAE,CAAC,aAAa,EAAE,CAAC,QAAQ;YACrC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;SACvB,CAAC;IACJ,CAAC;IAED,sDAAsD;IACtD,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,QAAQ,CAAC,KAAgC;QAC3C,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAChC,CAAC;IACD,IAAI,SAAS,CAAC,KAA4C;QACxD,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS;YAClC,CAAC,CAAC,SAAS;YACX,CAAC,CAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAoE,CAAC;IAC5F,CAAC;IACD,IAAI,IAAI,CAAC,KAAiF;QACxF,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,uBAAuB,GAAG;YAC7B,GAAG,IAAI,CAAC,uBAAuB;YAC/B,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;SACvB,CAAC;IACJ,CAAC;IAED,GAAG,CACD,IAAO,EACP,GAAG,IAA0E;QAE7E,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAoB,CAAC;IACzD,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ProvisioningComponent } from \"../provisioning-component.js\";\nimport * as fn from \"../../fn.js\";\nimport {\n  type Expression,\n  type ExpressionOrValue,\n  type InputRecord,\n} from \"../../expression/expressions.js\";\nimport type { ResourceNamingRules } from \"../../naming/naming-rules.js\";\nimport { deref } from \"../resource/resource-proxy.js\";\nimport type { ExistingResourceProps } from \"../resource/resource.js\";\nimport { Resource } from \"../resource/resource.js\";\nimport { createFlatModelShape, createRecordShape, createStringShape } from \"../../shape/shape.js\";\n\nconst resourceGroupNamingRules: ResourceNamingRules = {\n  abbreviation: \"rg\",\n  minLength: 1,\n  maxLength: 90,\n  validCharacters: {\n    uppercase: true,\n    hyphens: true,\n    underscores: true,\n    periods: true,\n  },\n  scope: \"subscription\",\n};\n\nexport interface ResourceGroupProps {\n  name?: ExpressionOrValue<string> | undefined;\n  location: ExpressionOrValue<string>;\n  tags?: Record<string, ExpressionOrValue<string>>;\n  managedBy?: ExpressionOrValue<string>;\n}\n\n/**\n * An Azure resource group that establishes a deployment boundary.\n *\n * @remarks\n * Resources created with a `ResourceGroup` as their parent inherit its\n * location, tags, and naming policy, and deploy at resource-group scope\n * in the generated Bicep.\n *\n * @example\n * ```typescript snippet:ignore\n * import { Stack, ResourceGroup } from \"@azure/provisioning-core\";\n * import { KeyVault } from \"@azure/provisioning-keyvault\";\n *\n * const stack = new Stack(\"my-app\");\n * const rg = new ResourceGroup(stack, { location: \"eastus\" });\n * const vault = new KeyVault(rg, {\n *   properties: { tenantId: \"...\", sku: { family: \"A\", name: \"standard\" } },\n * });\n * ```\n */\nexport class ResourceGroup extends Resource<\"Microsoft.Resources/resourceGroups\"> {\n  static readonly resourceType = \"Microsoft.Resources/resourceGroups\" as const;\n  static readonly apiVersion = \"2024-03-01\";\n\n  protected static namingRules = resourceGroupNamingRules;\n\n  static {\n    this.registerShape(\n      createFlatModelShape({\n        name: { armPath: [\"name\"], value: createStringShape() },\n        location: { armPath: [\"location\"], value: createStringShape() },\n        tags: {\n          armPath: [\"tags\"],\n          value: createRecordShape(createStringShape()),\n        },\n        managedBy: { armPath: [\"managedBy\"], value: createStringShape() },\n      }),\n    );\n    this.register();\n  }\n\n  constructor(\n    context: ProvisioningComponent,\n    props:\n      (ResourceGroupProps & { existing?: false }) | (ExistingResourceProps & { existing: true }),\n  ) {\n    super(context, {\n      ...props,\n      type: ResourceGroup.resourceType,\n      apiVersion: ResourceGroup.apiVersion,\n    });\n\n    this._localDeploymentContext = {\n      // Resources inside this RG deploy at RG scope, so the canonical\n      // default is the Bicep runtime expression `resourceGroup().location`\n      // (i.e. the actual location of whichever RG hosts the deployment).\n      // This is correct whether the RG is authored locally or referenced\n      // as `existing`.\n      location: fn.resourceGroup().location,\n      tags: deref(this.tags),\n    };\n  }\n\n  /** The resource group's location as an expression. */\n  get location(): Expression<string> {\n    return this.expr(\"location\");\n  }\n  set location(value: ExpressionOrValue<string>) {\n    this.setProperty(\"location\", value);\n  }\n\n  get managedBy(): Expression<string> {\n    return this.expr(\"managedBy\");\n  }\n  set managedBy(value: ExpressionOrValue<string> | undefined) {\n    this.setProperty(\"managedBy\", value);\n  }\n\n  get tags(): InputRecord<ExpressionOrValue<string>, Record<string, string>> | undefined {\n    return this.state.tags === undefined\n      ? undefined\n      : (this.expr(\"tags\") as InputRecord<ExpressionOrValue<string>, Record<string, string>>);\n  }\n  set tags(value: InputRecord<ExpressionOrValue<string>, Record<string, string>> | undefined) {\n    this.setProperty(\"tags\", value);\n    this._localDeploymentContext = {\n      ...this._localDeploymentContext,\n      tags: deref(this.tags),\n    };\n  }\n\n  add<T extends new (context: ProvisioningComponent, ...args: any[]) => ProvisioningComponent>(\n    ctor: T,\n    ...args: ConstructorParameters<T> extends [any, ...infer Rest] ? Rest : never\n  ): InstanceType<T> {\n    return new ctor(this.self, ...args) as InstanceType<T>;\n  }\n}\n"]}

package/dist/browser/constructs/output.d.ts

@@ -0,0 +1,80 @@
+import type { PrimitiveTypeMap, PrimitiveTypeName } from "../serialization/contract/index.js";
+import type { ExpressionOrValue, InputOf } from "../expression/expressions.js";
+import type { Resource } from "./resource/resource.js";
+import type { Stack } from "./stack.js";
+/**
+ * A value accepted as a deployment output's value: any JSON literal (scalar,
+ * `null`, array, object — recursively), an `Expression`, a resource view
+ * (`InputOf<unknown>`), or a {@link Resource} handle. The literal members are
+ * required so plain object/array literals are accepted (a bare
+ * `InputOf<unknown>` is a weak type and would reject them).
+ */
+export type OutputValue = string | number | boolean | null | readonly OutputValue[] | {
+    readonly [key: string]: OutputValue;
+} | InputOf<unknown> | Resource;
+/** Primitive Bicep type names supported by deployment outputs. */
+export type OutputType = PrimitiveTypeName;
+export type ScalarOutputType = "string" | "int" | "bool";
+export type OutputValueFor<T extends OutputType> = T extends ScalarOutputType ? ExpressionOrValue<PrimitiveTypeMap[T]> : OutputValue;
+export type OutputOptions = {
+    readonly description?: string | undefined;
+    readonly secure?: boolean | undefined;
+    readonly minValue?: number | undefined;
+    readonly maxValue?: number | undefined;
+    readonly minLength?: number | undefined;
+    readonly maxLength?: number | undefined;
+    readonly metadata?: Record<string, unknown> | undefined;
+    readonly discriminator?: string | undefined;
+    readonly sealed?: boolean | undefined;
+};
+/**
+ * Pure declaration data for a deployment output. Stored on the stack and read
+ * by the serializer at emit time. An output is a terminal sink — it has no
+ * expression handle.
+ */
+export interface OutputMetadata extends OutputOptions {
+    readonly name: string;
+    readonly type: OutputType;
+    readonly value: OutputValue;
+}
+/**
+ * Authoring-time collection of a stack's deployment outputs. Backed by an
+ * ordered private array; supports add/get/delete/iteration. Outputs are
+ * terminal sinks (no expression handle), so iteration yields metadata.
+ */
+export declare class OutputCollection {
+    #private;
+    /** Add an output. Throws on duplicate name. Returns the stored metadata. */
+    add<T extends OutputType>(name: string, type: T, value: OutputValueFor<NoInfer<T>>, options?: OutputOptions): OutputMetadata;
+    /** The declaration metadata for an output, or `undefined`. */
+    get(name: string): OutputMetadata | undefined;
+    /** All output metadata, in insertion order. */
+    list(): readonly OutputMetadata[];
+    has(name: string): boolean;
+    /** Remove an output by name. Returns whether one was removed. */
+    delete(name: string): boolean;
+    get size(): number;
+    [Symbol.iterator](): IterableIterator<OutputMetadata>;
+}
+/**
+ * A deployment output, compiled to a Bicep `output` declaration.
+ *
+ * @example
+ * ```typescript snippet:ignore
+ * import { Stack } from "@azure/provisioning-core";
+ * import { KeyVault } from "@azure/provisioning-keyvault";
+ *
+ * const stack = new Stack("my-app", { targetScope: "resourceGroup" });
+ * const vault = new KeyVault(stack, {
+ *   name: "kv-my-app",
+ *   location: "eastus",
+ *   properties: {
+ *     tenantId: "11111111-1111-1111-1111-111111111111",
+ *     sku: { family: "A", name: "standard" },
+ *   },
+ * });
+ * stack.outputs.add("vaultUri", "string", vault.properties.vaultUri);
+ * ```
+ */
+export declare function createOutput<T extends OutputType>(stack: Stack, name: string, type: T, value: OutputValueFor<NoInfer<T>>, options?: OutputOptions): OutputMetadata;
+//# sourceMappingURL=output.d.ts.map

package/dist/browser/constructs/output.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.d.ts","sourceRoot":"","sources":["../../../src/constructs/output.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AAC9F,OAAO,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAC/E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGxC;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GACnB,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,WAAW,EAAE,GACtB;IAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,WAAW,CAAA;CAAE,GACvC,OAAO,CAAC,OAAO,CAAC,GAChB,QAAQ,CAAC;AAEb,kEAAkE;AAClE,MAAM,MAAM,UAAU,GAAG,iBAAiB,CAAC;AAE3C,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;AACzD,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,UAAU,IAAI,CAAC,SAAS,gBAAgB,GACzE,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GACtC,WAAW,CAAC;AAEhB,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACxD,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;CAC7B;AAED;;;;GAIG;AACH,qBAAa,gBAAgB;;IAG3B,4EAA4E;IAC5E,GAAG,CAAC,CAAC,SAAS,UAAU,EACtB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EACjC,OAAO,CAAC,EAAE,aAAa,GACtB,cAAc;IAcjB,8DAA8D;IAC9D,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAI7C,+CAA+C;IAC/C,IAAI,IAAI,SAAS,cAAc,EAAE;IAIjC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B,iEAAiE;IACjE,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAO7B,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,cAAc,CAAC;CAGtD;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,UAAU,EAC/C,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EACjC,OAAO,CAAC,EAAE,aAAa,GACtB,cAAc,CAEhB"}

package/dist/browser/constructs/output.js

@@ -0,0 +1,75 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { isResource } from "./resource/resource-utils.js";
+import { assertBicepIdentifier, assertValueAssignableToType } from "../util.js";
+/**
+ * Authoring-time collection of a stack's deployment outputs. Backed by an
+ * ordered private array; supports add/get/delete/iteration. Outputs are
+ * terminal sinks (no expression handle), so iteration yields metadata.
+ */
+export class OutputCollection {
+    #entries = [];
+    /** Add an output. Throws on duplicate name. Returns the stored metadata. */
+    add(name, type, value, options) {
+        assertBicepIdentifier(name, "Deployment output");
+        if (this.has(name)) {
+            throw new Error(`Duplicate deployment output name: ${name}`);
+        }
+        if ((type === "string" || type === "int" || type === "bool") && isResource(value)) {
+            throw new Error(`Deployment output "${name}" expected type "${type}" but got resource.`);
+        }
+        assertValueAssignableToType(value, type, `Deployment output "${name}"`);
+        const metadata = { name, type, value, ...options };
+        this.#entries.push(metadata);
+        return metadata;
+    }
+    /** The declaration metadata for an output, or `undefined`. */
+    get(name) {
+        return this.#entries.find((e) => e.name === name);
+    }
+    /** All output metadata, in insertion order. */
+    list() {
+        return this.#entries;
+    }
+    has(name) {
+        return this.get(name) !== undefined;
+    }
+    /** Remove an output by name. Returns whether one was removed. */
+    delete(name) {
+        const i = this.#entries.findIndex((e) => e.name === name);
+        if (i === -1)
+            return false;
+        this.#entries.splice(i, 1);
+        return true;
+    }
+    get size() {
+        return this.#entries.length;
+    }
+    [Symbol.iterator]() {
+        return this.#entries[Symbol.iterator]();
+    }
+}
+/**
+ * A deployment output, compiled to a Bicep `output` declaration.
+ *
+ * @example
+ * ```typescript snippet:ignore
+ * import { Stack } from "@azure/provisioning-core";
+ * import { KeyVault } from "@azure/provisioning-keyvault";
+ *
+ * const stack = new Stack("my-app", { targetScope: "resourceGroup" });
+ * const vault = new KeyVault(stack, {
+ *   name: "kv-my-app",
+ *   location: "eastus",
+ *   properties: {
+ *     tenantId: "11111111-1111-1111-1111-111111111111",
+ *     sku: { family: "A", name: "standard" },
+ *   },
+ * });
+ * stack.outputs.add("vaultUri", "string", vault.properties.vaultUri);
+ * ```
+ */
+export function createOutput(stack, name, type, value, options) {
+    return stack.outputs.add(name, type, value, options);
+}
+//# sourceMappingURL=output.js.map

package/dist/browser/constructs/output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"output.js","sourceRoot":"","sources":["../../../src/constructs/output.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAKlC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,OAAO,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAkDhF;;;;GAIG;AACH,MAAM,OAAO,gBAAgB;IAC3B,QAAQ,GAAqB,EAAE,CAAC;IAEhC,4EAA4E;IAC5E,GAAG,CACD,IAAY,EACZ,IAAO,EACP,KAAiC,EACjC,OAAuB;QAEvB,qBAAqB,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;QACjD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,qCAAqC,IAAI,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,MAAM,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAClF,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,oBAAoB,IAAI,qBAAqB,CAAC,CAAC;QAC3F,CAAC;QACD,2BAA2B,CAAC,KAAK,EAAE,IAAI,EAAE,sBAAsB,IAAI,GAAG,CAAC,CAAC;QACxE,MAAM,QAAQ,GAAmB,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC;QACnE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,8DAA8D;IAC9D,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,+CAA+C;IAC/C,IAAI;QACF,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC;IACtC,CAAC;IAED,iEAAiE;IACjE,MAAM,CAAC,IAAY;QACjB,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC1D,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QAC3B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC1C,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAY,EACZ,IAAY,EACZ,IAAO,EACP,KAAiC,EACjC,OAAuB;IAEvB,OAAO,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PrimitiveTypeMap, PrimitiveTypeName } from \"../serialization/contract/index.js\";\nimport type { ExpressionOrValue, InputOf } from \"../expression/expressions.js\";\nimport type { Resource } from \"./resource/resource.js\";\nimport { isResource } from \"./resource/resource-utils.js\";\nimport type { Stack } from \"./stack.js\";\nimport { assertBicepIdentifier, assertValueAssignableToType } from \"../util.js\";\n\n/**\n * A value accepted as a deployment output's value: any JSON literal (scalar,\n * `null`, array, object — recursively), an `Expression`, a resource view\n * (`InputOf<unknown>`), or a {@link Resource} handle. The literal members are\n * required so plain object/array literals are accepted (a bare\n * `InputOf<unknown>` is a weak type and would reject them).\n */\nexport type OutputValue =\n  | string\n  | number\n  | boolean\n  | null\n  | readonly OutputValue[]\n  | { readonly [key: string]: OutputValue }\n  | InputOf<unknown>\n  | Resource;\n\n/** Primitive Bicep type names supported by deployment outputs. */\nexport type OutputType = PrimitiveTypeName;\n\nexport type ScalarOutputType = \"string\" | \"int\" | \"bool\";\nexport type OutputValueFor<T extends OutputType> = T extends ScalarOutputType\n  ? ExpressionOrValue<PrimitiveTypeMap[T]>\n  : OutputValue;\n\nexport type OutputOptions = {\n  readonly description?: string | undefined;\n  readonly secure?: boolean | undefined;\n  readonly minValue?: number | undefined;\n  readonly maxValue?: number | undefined;\n  readonly minLength?: number | undefined;\n  readonly maxLength?: number | undefined;\n  readonly metadata?: Record<string, unknown> | undefined;\n  readonly discriminator?: string | undefined;\n  readonly sealed?: boolean | undefined;\n};\n\n/**\n * Pure declaration data for a deployment output. Stored on the stack and read\n * by the serializer at emit time. An output is a terminal sink — it has no\n * expression handle.\n */\nexport interface OutputMetadata extends OutputOptions {\n  readonly name: string;\n  readonly type: OutputType;\n  readonly value: OutputValue;\n}\n\n/**\n * Authoring-time collection of a stack's deployment outputs. Backed by an\n * ordered private array; supports add/get/delete/iteration. Outputs are\n * terminal sinks (no expression handle), so iteration yields metadata.\n */\nexport class OutputCollection {\n  #entries: OutputMetadata[] = [];\n\n  /** Add an output. Throws on duplicate name. Returns the stored metadata. */\n  add<T extends OutputType>(\n    name: string,\n    type: T,\n    value: OutputValueFor<NoInfer<T>>,\n    options?: OutputOptions,\n  ): OutputMetadata {\n    assertBicepIdentifier(name, \"Deployment output\");\n    if (this.has(name)) {\n      throw new Error(`Duplicate deployment output name: ${name}`);\n    }\n    if ((type === \"string\" || type === \"int\" || type === \"bool\") && isResource(value)) {\n      throw new Error(`Deployment output \"${name}\" expected type \"${type}\" but got resource.`);\n    }\n    assertValueAssignableToType(value, type, `Deployment output \"${name}\"`);\n    const metadata: OutputMetadata = { name, type, value, ...options };\n    this.#entries.push(metadata);\n    return metadata;\n  }\n\n  /** The declaration metadata for an output, or `undefined`. */\n  get(name: string): OutputMetadata | undefined {\n    return this.#entries.find((e) => e.name === name);\n  }\n\n  /** All output metadata, in insertion order. */\n  list(): readonly OutputMetadata[] {\n    return this.#entries;\n  }\n\n  has(name: string): boolean {\n    return this.get(name) !== undefined;\n  }\n\n  /** Remove an output by name. Returns whether one was removed. */\n  delete(name: string): boolean {\n    const i = this.#entries.findIndex((e) => e.name === name);\n    if (i === -1) return false;\n    this.#entries.splice(i, 1);\n    return true;\n  }\n\n  get size(): number {\n    return this.#entries.length;\n  }\n\n  [Symbol.iterator](): IterableIterator<OutputMetadata> {\n    return this.#entries[Symbol.iterator]();\n  }\n}\n\n/**\n * A deployment output, compiled to a Bicep `output` declaration.\n *\n * @example\n * ```typescript snippet:ignore\n * import { Stack } from \"@azure/provisioning-core\";\n * import { KeyVault } from \"@azure/provisioning-keyvault\";\n *\n * const stack = new Stack(\"my-app\", { targetScope: \"resourceGroup\" });\n * const vault = new KeyVault(stack, {\n *   name: \"kv-my-app\",\n *   location: \"eastus\",\n *   properties: {\n *     tenantId: \"11111111-1111-1111-1111-111111111111\",\n *     sku: { family: \"A\", name: \"standard\" },\n *   },\n * });\n * stack.outputs.add(\"vaultUri\", \"string\", vault.properties.vaultUri);\n * ```\n */\nexport function createOutput<T extends OutputType>(\n  stack: Stack,\n  name: string,\n  type: T,\n  value: OutputValueFor<NoInfer<T>>,\n  options?: OutputOptions,\n): OutputMetadata {\n  return stack.outputs.add(name, type, value, options);\n}\n"]}

package/dist/browser/constructs/parameter.d.ts

@@ -0,0 +1,77 @@
+import type { PrimitiveTypeMap } from "../serialization/contract/index.js";
+import type { Expression, ExpressionOrValue } from "../expression/expressions.js";
+import type { Stack } from "./stack.js";
+export type InferParamType<T extends keyof PrimitiveTypeMap, A> = A extends readonly (infer E)[] ? E : PrimitiveTypeMap[T];
+/**
+ * A value accepted as a parameter's `defaultValue`: a literal of the declared
+ * type or an `Expression` of it. Resource views are intentionally excluded —
+ * a Bicep `param` default cannot reference resources.
+ */
+export type ParameterValue<T extends keyof PrimitiveTypeMap = keyof PrimitiveTypeMap> = ExpressionOrValue<PrimitiveTypeMap[T]>;
+export type ParameterOptions<T extends keyof PrimitiveTypeMap = keyof PrimitiveTypeMap, A extends readonly PrimitiveTypeMap[T][] | undefined = undefined> = {
+    readonly defaultValue?: ExpressionOrValue<InferParamType<T, A>> | undefined;
+    readonly description?: string | undefined;
+    readonly secure?: boolean | undefined;
+    readonly minValue?: number | undefined;
+    readonly maxValue?: number | undefined;
+    readonly minLength?: number | undefined;
+    readonly maxLength?: number | undefined;
+    readonly metadata?: Record<string, unknown> | undefined;
+    readonly allowed?: A;
+    readonly discriminator?: string | undefined;
+    readonly sealed?: boolean | undefined;
+};
+/**
+ * Pure declaration data for a deployment parameter. Stored on the stack
+ * (paired with the returned expression handle in {@link ParameterEntry});
+ * read by the serializer at emit time. Not part of the value-level handle.
+ */
+export interface ParameterMetadata extends ParameterOptions<keyof PrimitiveTypeMap, readonly PrimitiveTypeMap[keyof PrimitiveTypeMap][] | undefined> {
+    readonly name: string;
+    readonly type: keyof PrimitiveTypeMap;
+}
+export type Parameter<T extends keyof PrimitiveTypeMap = keyof PrimitiveTypeMap, A extends readonly PrimitiveTypeMap[T][] | undefined = undefined> = Expression<InferParamType<T, A>>;
+/**
+ * Authoring-time collection of a stack's deployment parameters. Backed by an
+ * ordered private array; supports add/get/delete/iteration. Look parameters up
+ * by name via {@link ParameterCollection.get}.
+ */
+export declare class ParameterCollection {
+    #private;
+    /** Add a parameter; returns its expression handle. Throws on duplicate name. */
+    add<T extends keyof PrimitiveTypeMap = keyof PrimitiveTypeMap, const A extends readonly PrimitiveTypeMap[T][] | undefined = undefined>(name: string, type: T, options?: ParameterOptions<T, A>): Parameter<T, A>;
+    /** The expression handle for a parameter, or `undefined`. */
+    get(name: string): Parameter | undefined;
+    /** The declaration metadata for a parameter, or `undefined`. */
+    getMetadata(name: string): ParameterMetadata | undefined;
+    /** All parameter handles, in insertion order. */
+    list(): readonly Parameter[];
+    /** All declaration metadata, in insertion order. */
+    listMetadata(): readonly ParameterMetadata[];
+    has(name: string): boolean;
+    /** Remove a parameter by name. Returns whether one was removed. */
+    delete(name: string): boolean;
+    get size(): number;
+    [Symbol.iterator](): IterableIterator<Parameter>;
+}
+/**
+ * A deploy-time input to a stack, compiled to a Bicep `param` declaration.
+ *
+ * @remarks
+ * The returned value is an `Expression` that can be passed to resource
+ * properties. At deploy time, the user supplies the actual value. The
+ * declaration metadata is stored separately on the stack, keyed by name.
+ *
+ * @example
+ * ```typescript snippet:ignore
+ * import { Stack, createParameter } from "@azure/provisioning-core";
+ *
+ * const stack = new Stack("my-app", { targetScope: "resourceGroup" });
+ * const env = createParameter(stack, "env", "string", {
+ *   allowed: ["dev", "staging", "prod"] as const,
+ *   defaultValue: "dev",
+ * });
+ * ```
+ */
+export declare function createParameter<T extends keyof PrimitiveTypeMap = keyof PrimitiveTypeMap, const A extends readonly PrimitiveTypeMap[T][] | undefined = undefined>(stack: Stack, name: string, type: T, options?: ParameterOptions<T, A>): Parameter<T, A>;
+//# sourceMappingURL=parameter.d.ts.map

package/dist/browser/constructs/parameter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameter.d.ts","sourceRoot":"","sources":["../../../src/constructs/parameter.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAIlF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGxC,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,gBAAgB,EAAE,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAC5F,CAAC,GACD,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAExB;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,IAClF,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEzC,MAAM,MAAM,gBAAgB,CAC1B,CAAC,SAAS,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,EACzD,CAAC,SAAS,SAAS,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,GAAG,SAAS,IAC9D;IACF,QAAQ,CAAC,YAAY,CAAC,EAAE,iBAAiB,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAC5E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;IACxD,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrB,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB,CACzD,MAAM,gBAAgB,EACtB,SAAS,gBAAgB,CAAC,MAAM,gBAAgB,CAAC,EAAE,GAAG,SAAS,CAChE;IACC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,gBAAgB,CAAC;CACvC;AAYD,MAAM,MAAM,SAAS,CACnB,CAAC,SAAS,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,EACzD,CAAC,SAAS,SAAS,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,GAAG,SAAS,IAC9D,UAAU,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAErC;;;;GAIG;AACH,qBAAa,mBAAmB;;IAG9B,gFAAgF;IAChF,GAAG,CACD,CAAC,SAAS,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,EACzD,KAAK,CAAC,CAAC,SAAS,SAAS,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,GAAG,SAAS,EACtE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC;IA0B3E,6DAA6D;IAC7D,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAIxC,gEAAgE;IAChE,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS;IAIxD,iDAAiD;IACjD,IAAI,IAAI,SAAS,SAAS,EAAE;IAI5B,oDAAoD;IACpD,YAAY,IAAI,SAAS,iBAAiB,EAAE;IAI5C,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B,mEAAmE;IACnE,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAO7B,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,SAAS,CAAC;CAOjD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,eAAe,CAC7B,CAAC,SAAS,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,EACzD,KAAK,CAAC,CAAC,SAAS,SAAS,gBAAgB,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,GAAG,SAAS,EACtE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAExF"}

package/dist/browser/constructs/parameter.js

@@ -0,0 +1,93 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { wrapExpression } from "../expression/expressions.js";
+import { isExpression } from "../expression/expressions.js";
+import { symbolicValueExpressionNode } from "../expression/ast-nodes.js";
+import { assertBicepIdentifier, assertValueAssignableToType } from "../util.js";
+/**
+ * Authoring-time collection of a stack's deployment parameters. Backed by an
+ * ordered private array; supports add/get/delete/iteration. Look parameters up
+ * by name via {@link ParameterCollection.get}.
+ */
+export class ParameterCollection {
+    #entries = [];
+    /** Add a parameter; returns its expression handle. Throws on duplicate name. */
+    add(name, type, options) {
+        assertBicepIdentifier(name, "Deployment parameter");
+        if (this.has(name)) {
+            throw new Error(`Duplicate deployment parameter name: ${name}`);
+        }
+        assertValueAssignableToType(options?.defaultValue, type, `Deployment parameter "${name}"`);
+        if (options?.defaultValue !== undefined &&
+            !isExpression(options.defaultValue) &&
+            options.allowed !== undefined &&
+            !options.allowed.includes(options.defaultValue)) {
+            throw new Error(`Deployment parameter "${name}" default value must be one of its allowed values.`);
+        }
+        const param = wrapExpression(symbolicValueExpressionNode(name));
+        this.#entries.push({
+            metadata: { name, type, ...options },
+            parameter: param,
+        });
+        return param;
+    }
+    /** The expression handle for a parameter, or `undefined`. */
+    get(name) {
+        return this.#find(name)?.parameter;
+    }
+    /** The declaration metadata for a parameter, or `undefined`. */
+    getMetadata(name) {
+        return this.#find(name)?.metadata;
+    }
+    /** All parameter handles, in insertion order. */
+    list() {
+        return this.#entries.map((e) => e.parameter);
+    }
+    /** All declaration metadata, in insertion order. */
+    listMetadata() {
+        return this.#entries.map((e) => e.metadata);
+    }
+    has(name) {
+        return this.#find(name) !== undefined;
+    }
+    /** Remove a parameter by name. Returns whether one was removed. */
+    delete(name) {
+        const i = this.#entries.findIndex((e) => e.metadata.name === name);
+        if (i === -1)
+            return false;
+        this.#entries.splice(i, 1);
+        return true;
+    }
+    get size() {
+        return this.#entries.length;
+    }
+    [Symbol.iterator]() {
+        return this.#entries.map((e) => e.parameter)[Symbol.iterator]();
+    }
+    #find(name) {
+        return this.#entries.find((e) => e.metadata.name === name);
+    }
+}
+/**
+ * A deploy-time input to a stack, compiled to a Bicep `param` declaration.
+ *
+ * @remarks
+ * The returned value is an `Expression` that can be passed to resource
+ * properties. At deploy time, the user supplies the actual value. The
+ * declaration metadata is stored separately on the stack, keyed by name.
+ *
+ * @example
+ * ```typescript snippet:ignore
+ * import { Stack, createParameter } from "@azure/provisioning-core";
+ *
+ * const stack = new Stack("my-app", { targetScope: "resourceGroup" });
+ * const env = createParameter(stack, "env", "string", {
+ *   allowed: ["dev", "staging", "prod"] as const,
+ *   defaultValue: "dev",
+ * });
+ * ```
+ */
+export function createParameter(stack, name, type, options) {
+    return stack.parameters.add(name, type, options);
+}
+//# sourceMappingURL=parameter.js.map

package/dist/browser/constructs/parameter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameter.js","sourceRoot":"","sources":["../../../src/constructs/parameter.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AAEzE,OAAO,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AA2DhF;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAC9B,QAAQ,GAAqB,EAAE,CAAC;IAEhC,gFAAgF;IAChF,GAAG,CAGD,IAAY,EAAE,IAAO,EAAE,OAAgC;QACvD,qBAAqB,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,wCAAwC,IAAI,EAAE,CAAC,CAAC;QAClE,CAAC;QACD,2BAA2B,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,yBAAyB,IAAI,GAAG,CAAC,CAAC;QAC3F,IACE,OAAO,EAAE,YAAY,KAAK,SAAS;YACnC,CAAC,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC;YACnC,OAAO,CAAC,OAAO,KAAK,SAAS;YAC7B,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAmC,CAAC,EACtE,CAAC;YACD,MAAM,IAAI,KAAK,CACb,yBAAyB,IAAI,oDAAoD,CAClF,CAAC;QACJ,CAAC;QACD,MAAM,KAAK,GAAG,cAAc,CAC1B,2BAA2B,CAA+B,IAAI,CAAC,CAChE,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YACjB,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE;YACpC,SAAS,EAAE,KAAK;SACjB,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACf,CAAC;IAED,6DAA6D;IAC7D,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;IACrC,CAAC;IAED,gEAAgE;IAChE,WAAW,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACpC,CAAC;IAED,iDAAiD;IACjD,IAAI;QACF,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED,oDAAoD;IACpD,YAAY;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAED,GAAG,CAAC,IAAY;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC;IACxC,CAAC;IAED,mEAAmE;IACnE,MAAM,CAAC,IAAY;QACjB,MAAM,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACnE,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QAC3B,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,IAAY;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAC7D,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,eAAe,CAG7B,KAAY,EAAE,IAAY,EAAE,IAAO,EAAE,OAAgC;IACrE,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACnD,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PrimitiveTypeMap } from \"../serialization/contract/index.js\";\nimport type { Expression, ExpressionOrValue } from \"../expression/expressions.js\";\nimport { wrapExpression } from \"../expression/expressions.js\";\nimport { isExpression } from \"../expression/expressions.js\";\nimport { symbolicValueExpressionNode } from \"../expression/ast-nodes.js\";\nimport type { Stack } from \"./stack.js\";\nimport { assertBicepIdentifier, assertValueAssignableToType } from \"../util.js\";\n\nexport type InferParamType<T extends keyof PrimitiveTypeMap, A> = A extends readonly (infer E)[]\n  ? E\n  : PrimitiveTypeMap[T];\n\n/**\n * A value accepted as a parameter's `defaultValue`: a literal of the declared\n * type or an `Expression` of it. Resource views are intentionally excluded —\n * a Bicep `param` default cannot reference resources.\n */\nexport type ParameterValue<T extends keyof PrimitiveTypeMap = keyof PrimitiveTypeMap> =\n  ExpressionOrValue<PrimitiveTypeMap[T]>;\n\nexport type ParameterOptions<\n  T extends keyof PrimitiveTypeMap = keyof PrimitiveTypeMap,\n  A extends readonly PrimitiveTypeMap[T][] | undefined = undefined,\n> = {\n  readonly defaultValue?: ExpressionOrValue<InferParamType<T, A>> | undefined;\n  readonly description?: string | undefined;\n  readonly secure?: boolean | undefined;\n  readonly minValue?: number | undefined;\n  readonly maxValue?: number | undefined;\n  readonly minLength?: number | undefined;\n  readonly maxLength?: number | undefined;\n  readonly metadata?: Record<string, unknown> | undefined;\n  readonly allowed?: A;\n  readonly discriminator?: string | undefined;\n  readonly sealed?: boolean | undefined;\n};\n\n/**\n * Pure declaration data for a deployment parameter. Stored on the stack\n * (paired with the returned expression handle in {@link ParameterEntry});\n * read by the serializer at emit time. Not part of the value-level handle.\n */\nexport interface ParameterMetadata extends ParameterOptions<\n  keyof PrimitiveTypeMap,\n  readonly PrimitiveTypeMap[keyof PrimitiveTypeMap][] | undefined\n> {\n  readonly name: string;\n  readonly type: keyof PrimitiveTypeMap;\n}\n\n/**\n * A stack entry pairing a parameter's declaration metadata with the\n * expression handle returned to the user. Internal; metadata is exposed via\n * {@link ParameterCollection.getMetadata} / {@link ParameterCollection.listMetadata}.\n */\ninterface ParameterEntry {\n  readonly metadata: ParameterMetadata;\n  readonly parameter: Expression<unknown>;\n}\n\nexport type Parameter<\n  T extends keyof PrimitiveTypeMap = keyof PrimitiveTypeMap,\n  A extends readonly PrimitiveTypeMap[T][] | undefined = undefined,\n> = Expression<InferParamType<T, A>>;\n\n/**\n * Authoring-time collection of a stack's deployment parameters. Backed by an\n * ordered private array; supports add/get/delete/iteration. Look parameters up\n * by name via {@link ParameterCollection.get}.\n */\nexport class ParameterCollection {\n  #entries: ParameterEntry[] = [];\n\n  /** Add a parameter; returns its expression handle. Throws on duplicate name. */\n  add<\n    T extends keyof PrimitiveTypeMap = keyof PrimitiveTypeMap,\n    const A extends readonly PrimitiveTypeMap[T][] | undefined = undefined,\n  >(name: string, type: T, options?: ParameterOptions<T, A>): Parameter<T, A> {\n    assertBicepIdentifier(name, \"Deployment parameter\");\n    if (this.has(name)) {\n      throw new Error(`Duplicate deployment parameter name: ${name}`);\n    }\n    assertValueAssignableToType(options?.defaultValue, type, `Deployment parameter \"${name}\"`);\n    if (\n      options?.defaultValue !== undefined &&\n      !isExpression(options.defaultValue) &&\n      options.allowed !== undefined &&\n      !options.allowed.includes(options.defaultValue as PrimitiveTypeMap[T])\n    ) {\n      throw new Error(\n        `Deployment parameter \"${name}\" default value must be one of its allowed values.`,\n      );\n    }\n    const param = wrapExpression<InferParamType<T, A>>(\n      symbolicValueExpressionNode<InferParamType<T, A>, string>(name),\n    );\n    this.#entries.push({\n      metadata: { name, type, ...options },\n      parameter: param,\n    });\n    return param;\n  }\n\n  /** The expression handle for a parameter, or `undefined`. */\n  get(name: string): Parameter | undefined {\n    return this.#find(name)?.parameter;\n  }\n\n  /** The declaration metadata for a parameter, or `undefined`. */\n  getMetadata(name: string): ParameterMetadata | undefined {\n    return this.#find(name)?.metadata;\n  }\n\n  /** All parameter handles, in insertion order. */\n  list(): readonly Parameter[] {\n    return this.#entries.map((e) => e.parameter);\n  }\n\n  /** All declaration metadata, in insertion order. */\n  listMetadata(): readonly ParameterMetadata[] {\n    return this.#entries.map((e) => e.metadata);\n  }\n\n  has(name: string): boolean {\n    return this.#find(name) !== undefined;\n  }\n\n  /** Remove a parameter by name. Returns whether one was removed. */\n  delete(name: string): boolean {\n    const i = this.#entries.findIndex((e) => e.metadata.name === name);\n    if (i === -1) return false;\n    this.#entries.splice(i, 1);\n    return true;\n  }\n\n  get size(): number {\n    return this.#entries.length;\n  }\n\n  [Symbol.iterator](): IterableIterator<Parameter> {\n    return this.#entries.map((e) => e.parameter)[Symbol.iterator]();\n  }\n\n  #find(name: string): ParameterEntry | undefined {\n    return this.#entries.find((e) => e.metadata.name === name);\n  }\n}\n\n/**\n * A deploy-time input to a stack, compiled to a Bicep `param` declaration.\n *\n * @remarks\n * The returned value is an `Expression` that can be passed to resource\n * properties. At deploy time, the user supplies the actual value. The\n * declaration metadata is stored separately on the stack, keyed by name.\n *\n * @example\n * ```typescript snippet:ignore\n * import { Stack, createParameter } from \"@azure/provisioning-core\";\n *\n * const stack = new Stack(\"my-app\", { targetScope: \"resourceGroup\" });\n * const env = createParameter(stack, \"env\", \"string\", {\n *   allowed: [\"dev\", \"staging\", \"prod\"] as const,\n *   defaultValue: \"dev\",\n * });\n * ```\n */\nexport function createParameter<\n  T extends keyof PrimitiveTypeMap = keyof PrimitiveTypeMap,\n  const A extends readonly PrimitiveTypeMap[T][] | undefined = undefined,\n>(stack: Stack, name: string, type: T, options?: ParameterOptions<T, A>): Parameter<T, A> {\n  return stack.parameters.add(name, type, options);\n}\n"]}