@sst-community/sst 4.20.0 → 5.0.0-alpha.1

package/platform/types/components/parts.d.ts

@@ -0,0 +1,194 @@
+import type { CustomResourceOptions, Input, Output } from "@pulumi/pulumi";
+import type { PartTransform, PartialArgs } from "./transform";
+/**
+ * The resources a component is made of, by name. Each one is the class of a
+ * Pulumi resource or of another component.
+ *
+ * ```ts
+ * const parts = {
+ *   queue: aws.sqs.Queue,
+ *   policy: aws.sqs.QueuePolicy,
+ * };
+ * ```
+ *
+ * Inside SST, a part that is another component has to be declared in a
+ * function, `const parts = () => ({ ... })`. The components import each
+ * other, so the class may not exist yet when the file that declares the parts
+ * loads.
+ */
+export type Parts = Record<string, UnnamedPart | NamedPart>;
+type UnnamedPart = PartClass | DeferredPart | ManyPart | OptionalPart;
+export type PartClass = new (name: string, args: any, opts?: any) => any;
+/** A part declared with `deferred()`. */
+export interface DeferredPart<C extends PartClass = PartClass> {
+    deferred: C;
+}
+/**
+ * Declare a part that is created later, or not at all. A subscriber's
+ * function is one: it's created once the definition is known, and it isn't
+ * created when the user passes the ARN of a function they already have.
+ *
+ * The part's entry in `nodes` is an `Output` of the resource. Create the
+ * function with `functionPart()`.
+ *
+ * ```ts
+ * const parts = () => ({
+ *   subscriber: deferred(Function),
+ *   eventSourceMapping: aws.lambda.EventSourceMapping,
+ * });
+ *
+ * functionPart(this, "subscriber", "src/subscriber.handler", {});
+ * ```
+ */
+export declare function deferred<C extends PartClass>(cls: C): DeferredPart<C>;
+/** A part declared with `optional()`. */
+export interface OptionalPart<C extends PartClass = PartClass> {
+    optional: C;
+}
+/**
+ * Declare a part the component only creates sometimes, like a dead-letter
+ * queue that exists only when it's configured. Its entry in `nodes` may be
+ * `undefined`.
+ *
+ * ```ts
+ * const parts = {
+ *   queue: aws.sqs.Queue,
+ *   deadLetters: optional(aws.sqs.Queue),
+ * };
+ * ```
+ */
+export declare function optional<C extends PartClass>(cls: C): OptionalPart<C>;
+/** A part declared with `many()`. */
+export interface ManyPart<T extends PartClass | DeferredPart = PartClass | DeferredPart> {
+    many: T;
+}
+/**
+ * Declare a part the component creates several of, like one subnet per zone
+ * or one listener per port. Each one is created with an id:
+ *
+ * ```ts
+ * const parts = {
+ *   vpc: aws.ec2.Vpc,
+ *   subnet: many(aws.ec2.Subnet),
+ * };
+ *
+ * this.part("subnet", "1", { ... }); // named MyVpcSubnet1
+ * this.part("subnet", "2", { ... }); // named MyVpcSubnet2
+ * ```
+ *
+ * The part's `transform` applies to each one; its function form is also given
+ * the id. Its entry in `nodes` holds them by id.
+ *
+ * Wrap a deferred part to have several of those, like one function per
+ * subscriber: `many(deferred(Function))`.
+ */
+export declare function many<T extends PartClass | DeferredPart>(part: T): ManyPart<T>;
+/** A part declared with `named()`. */
+export interface NamedPart<T extends UnnamedPart = UnnamedPart> {
+    named: string;
+    part: T;
+}
+/**
+ * Declare a part whose resource isn't named after its key. A resource is
+ * named after the component and the part, `MyQueue` and `policy` giving
+ * `MyQueuePolicy`, and that name is how a deployed app knows the resource.
+ * With `named()` the key can change, or differ from the name, and the
+ * resource stays the one that's deployed:
+ *
+ * ```ts
+ * const parts = {
+ *   // Named MyVpcNatInstanceSecurityGroup
+ *   natSecurityGroup: named(aws.ec2.SecurityGroup, "NatInstanceSecurityGroup"),
+ * };
+ * ```
+ *
+ * It wraps the other markers: `named(optional(aws.ec2.SecurityGroup), "...")`.
+ * For a `many()` part the id is added to the name, as it is to the key.
+ *
+ * The name is permanent. Changing it later renames the resource, which
+ * replaces it unless it's given an alias.
+ */
+export declare function named<T extends UnnamedPart>(part: T, name: string): NamedPart<T>;
+/** A part as it's declared, without the name `named()` gives it. */
+export type Unnamed<T> = T extends NamedPart<infer U> ? U : T;
+export type PartClassOf<T> = T extends NamedPart<infer U> ? PartClassOf<U> : T extends DeferredPart<infer C> ? C : T extends ManyPart<infer M> ? PartClassOf<M> : T extends OptionalPart<infer C> ? C : T extends PartClass ? T : never;
+export declare function partClass(part: Parts[string] | DeferredPart): PartClass;
+/** Whether a part's resources are created later, or not at all. */
+export declare function isDeferred(part: Parts[string] | DeferredPart): boolean;
+export declare function isMany(part: Parts[string]): boolean;
+/** The name a part was given with `named()`, in place of its key. */
+export declare function nameGiven(part: Parts[string]): string | undefined;
+/** The args a part's resource is created with. */
+export type PartArgs<T extends Parts[string]> = NonNullable<ConstructorParameters<PartClassOf<T>>[1]>;
+/**
+ * The transform for a part the component creates several of. The function
+ * form is called for each one, with its id as the last argument.
+ */
+export type ManyTransform<T> = PartialArgs<T> | ((args: T, opts: CustomResourceOptions, name: string, id: string) => undefined);
+/** The `transform` option for a component: one optional transform per part. */
+export type Transforms<P extends Parts> = {
+    [K in keyof P]?: Unnamed<P[K]> extends ManyPart ? ManyTransform<PartArgs<P[K]>> : PartTransform<PartArgs<P[K]>>;
+};
+/**
+ * The `nodes` of a component: the resource created for each part. A deferred
+ * part is an `Output` of its resource, and a `many` part holds its resources
+ * by id.
+ */
+export type Nodes<P extends Parts> = {
+    [K in keyof P]: Unnamed<P[K]> extends DeferredPart<infer C> ? Output<InstanceType<C>> : Unnamed<P[K]> extends ManyPart<infer M> ? Record<string, M extends DeferredPart<infer C> ? Output<InstanceType<C>> : InstanceType<PartClassOf<M>>> : Unnamed<P[K]> extends OptionalPart<infer C> ? InstanceType<C> | undefined : InstanceType<PartClassOf<P[K]>>;
+};
+/**
+ * The `existing` option for a component: resources to use in place of ones
+ * the component would create. Each is the resource itself, or the id to look
+ * it up by. A `many` part takes them by id.
+ */
+export type Existing<P extends Parts> = {
+    [K in keyof P]?: Unnamed<P[K]> extends ManyPart ? Record<string, InstanceType<PartClassOf<P[K]>> | Input<string>> : InstanceType<PartClassOf<P[K]>> | Input<string>;
+};
+/** A parts map, or the function that returns it. */
+type PartsOf<T> = T extends () => infer P ? P : T;
+export type V5Args<Original, P extends Parts | (() => Parts)> = Omit<Original, "transform"> & ComponentArgs<P>;
+/**
+ * The args every component built from parts accepts. Extend it in your
+ * component's args.
+ *
+ * ```ts
+ * interface UploadsArgs extends sst.ComponentArgs<typeof parts> {
+ *   teams: string[];
+ * }
+ * ```
+ */
+export interface ComponentArgs<P extends Parts | (() => Parts)> {
+    /**
+     * [Transform](/docs/components#transform) how this component creates its underlying
+     * resources.
+     */
+    transform?: Transforms<PartsOf<P>>;
+    /**
+     * Use resources you already have in place of ones this component would
+     * create. Pass the resource, or the id to look it up by.
+     *
+     * @example
+     * ```ts
+     * {
+     *   existing: {
+     *     queue: "https://sqs.us-east-1.amazonaws.com/123456789012/my-queue"
+     *   }
+     * }
+     * ```
+     */
+    existing?: Existing<PartsOf<P>>;
+}
+export type ManyKeys<P extends Parts> = {
+    [K in keyof P]: Unnamed<P[K]> extends ManyPart ? K : never;
+}[keyof P] & string;
+export type SingleKeys<P extends Parts> = Exclude<keyof P & string, ManyKeys<P>>;
+/**
+ * The parts `this.part()` creates. A deferred part is left out: it's created
+ * with `functionPart()`, which makes its `nodes` entry an `Output`.
+ */
+export type CreatedKeys<P extends Parts> = {
+    [K in keyof P]: Unnamed<P[K]> extends DeferredPart | ManyPart<DeferredPart> ? never : K;
+}[keyof P] & string;
+export {};
+//# sourceMappingURL=parts.d.ts.map

package/platform/types/components/parts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parts.d.ts","sourceRoot":"","sources":["../../../src/components/parts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC3E,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE9D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,CAAC,CAAC;AAE5D,KAAK,WAAW,GAAG,SAAS,GAAG,YAAY,GAAG,QAAQ,GAAG,YAAY,CAAC;AAEtE,MAAM,MAAM,SAAS,GAAG,KAAK,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,KAAK,GAAG,CAAC;AAEzE,yCAAyC;AACzC,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC3D,QAAQ,EAAE,CAAC,CAAC;CACb;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAErE;AAED,yCAAyC;AACzC,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC3D,QAAQ,EAAE,CAAC,CAAC;CACb;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,SAAS,EAAE,GAAG,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAErE;AAED,qCAAqC;AACrC,MAAM,WAAW,QAAQ,CACvB,CAAC,SAAS,SAAS,GAAG,YAAY,GAAG,SAAS,GAAG,YAAY;IAE7D,IAAI,EAAE,CAAC,CAAC;CACT;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,SAAS,GAAG,YAAY,EAAE,IAAI,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAE7E;AAED,sCAAsC;AACtC,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,CAAC,CAAC;CACT;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,WAAW,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAEhF;AAED,oEAAoE;AACpE,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAE9D,MAAM,MAAM,WAAW,CAAC,CAAC,IACvB,CAAC,SAAS,SAAS,CAAC,MAAM,CAAC,CAAC,GACxB,WAAW,CAAC,CAAC,CAAC,GACd,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAC7B,CAAC,GACD,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GACzB,WAAW,CAAC,CAAC,CAAC,GACd,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAC7B,CAAC,GACD,CAAC,SAAS,SAAS,GACjB,CAAC,GACD,KAAK,CAAC;AAMpB,wBAAgB,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,YAAY,GAAG,SAAS,CAKvE;AAED,mEAAmE;AACnE,wBAAgB,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,YAAY,GAAG,OAAO,CAItE;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAGnD;AAED,qEAAqE;AACrE,wBAAgB,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,GAAG,SAAS,CAEjE;AAED,kDAAkD;AAClD,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,IAAI,WAAW,CACzD,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACzC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IACvB,WAAW,CAAC,CAAC,CAAC,GACd,CAAC,CACC,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,qBAAqB,EAC3B,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,KACP,SAAS,CAAC,CAAC;AAEpB,+EAA+E;AAC/E,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,KAAK,IAAI;KACvC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAC3C,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAC7B,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAClC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,KAAK,IAAI;KAClC,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GACvD,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GACvB,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,GACrC,MAAM,CACJ,MAAM,EACN,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GAC3B,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GACvB,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CACjC,GACD,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,CAAC,MAAM,CAAC,CAAC,GACzC,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,GAC3B,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACxC,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,KAAK,IAAI;KACrC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAC3C,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,GAC/D,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;CACpD,CAAC;AAEF,oDAAoD;AACpD,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAUlD,MAAM,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC,SAAS,KAAK,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAClE,QAAQ,EACR,WAAW,CACZ,GACC,aAAa,CAAC,CAAC,CAAC,CAAC;AAEnB;;;;;;;;;GASG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,KAAK,GAAG,CAAC,MAAM,KAAK,CAAC;IAC5D;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACnC;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;CACjC;AAED,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,KAAK,IAAI;KACrC,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,QAAQ,GAAG,CAAC,GAAG,KAAK;CAC3D,CAAC,MAAM,CAAC,CAAC,GACR,MAAM,CAAC;AAET,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjF;;;GAGG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,KAAK,IAAI;KACxC,CAAC,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC,GACvE,KAAK,GACL,CAAC;CACN,CAAC,MAAM,CAAC,CAAC,GACR,MAAM,CAAC"}

package/platform/types/components/path.d.ts

@@ -0,0 +1,2 @@
+export declare function toPosix(p: string): string;
+//# sourceMappingURL=path.d.ts.map

package/platform/types/components/path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../../src/components/path.ts"],"names":[],"mappings":"AAEA,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,UAEhC"}

package/platform/types/components/rpc/rpc.d.ts

@@ -0,0 +1,19 @@
+import { dynamic } from "@pulumi/pulumi";
+export declare namespace rpc {
+    class MethodNotFoundError extends Error {
+        method: string;
+        constructor(method: string);
+    }
+    function call<T = any>(method: string, args: any): Promise<T>;
+    class Provider implements dynamic.ResourceProvider {
+        private type;
+        constructor(type: string);
+        private name;
+        create(inputs: any): Promise<dynamic.CreateResult<any>>;
+        delete(id: string, outs: any): Promise<void>;
+        update(id: string, olds: any, news: any): Promise<any>;
+        read(id: string, props: any): Promise<dynamic.ReadResult>;
+        diff(id: string, olds: any, news: any): Promise<dynamic.DiffResult>;
+    }
+}
+//# sourceMappingURL=rpc.d.ts.map

package/platform/types/components/rpc/rpc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rpc.d.ts","sourceRoot":"","sources":["../../../../src/components/rpc/rpc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC,yBAAiB,GAAG,CAAC;IACnB,MAAa,mBAAoB,SAAQ,KAAK;QACzB,MAAM,EAAE,MAAM;oBAAd,MAAM,EAAE,MAAM;KAGlC;IACD,SAAsB,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,cA0D5D;IAED,MAAa,QAAS,YAAW,OAAO,CAAC,gBAAgB;QAC3C,OAAO,CAAC,IAAI;oBAAJ,IAAI,EAAE,MAAM;QAChC,OAAO,CAAC,IAAI;QAGN,MAAM,CAAC,MAAM,EAAE,GAAG;QAIlB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;QAO5C,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG;QAUvC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;QAOzD,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;KAM1E;CACF"}

package/platform/types/components/secret.d.ts

@@ -0,0 +1,123 @@
+import { VisibleError } from "./error";
+import { Output } from "@pulumi/pulumi";
+import { Link } from "./link";
+import { Component } from "./component";
+import { Input } from "./input";
+export declare class SecretMissingError extends VisibleError {
+    readonly secretName: string;
+    constructor(secretName: string);
+}
+/**
+ * The `Secret` component lets you create secrets in your app.
+ *
+ * Secrets are encrypted and stored in an S3 Bucket in your AWS account. If used in
+ * your app config, they'll be encrypted in your state file as well. If used in
+ * your function code, they are encrypted and included in the bundle. They are
+ * then decrypted synchronously when your function starts up by the SST SDK.
+ *
+ * @example
+ *
+ * #### Create a secret
+ *
+ * The name of a secret follows the same rules as a component name. It must start with a capital letter and contain only letters and numbers.
+ *
+ * :::note
+ * Secret names must start with a capital letter and contain only letters and numbers.
+ * :::
+ *
+ * ```ts title="sst.config.ts"
+ * const secret = new sst.Secret("MySecret");
+ * ```
+ *
+ * #### Set a placeholder
+ *
+ * You can optionally set a `placeholder`.
+ *
+ * :::tip
+ * Useful for cases where you might use a secret for values that aren't sensitive, so you can just set them in code.
+ * :::
+ *
+ * ```ts title="sst.config.ts"
+ * const secret = new sst.Secret("MySecret", "my-secret-placeholder-value");
+ * ```
+ *
+ * #### Set the value of the secret
+ *
+ * You can then set the value of a secret using the [CLI](/docs/reference/cli/).
+ *
+ * ```sh title="Terminal"
+ * sst secret set MySecret my-secret-value
+ * ```
+ *
+ * :::note
+ * If you are not running `sst dev`, you'll need to `sst deploy` to apply the secret.
+ * :::
+ *
+ * #### Set a fallback for the secret
+ *
+ * You can set a _fallback_ value for the secret with the `--fallback` flag. If the secret is
+ * not set for a stage, it'll use the fallback value instead.
+ *
+ * ```sh title="Terminal"
+ * sst secret set MySecret my-fallback-value --fallback
+ * ```
+ *
+ * This is useful for PR environments that are auto-deployed.
+ *
+ * #### Use the secret in your app config
+ *
+ * You can now use the secret in your app config.
+ *
+ * ```ts title="sst.config.ts"
+ * console.log(mySecret.value);
+ * ```
+ *
+ * This is an [Output](/docs/components#outputs) that can be used as an Input to other components.
+ *
+ * #### Link the secret to a resource
+ *
+ * You can link the secret to other resources, like a function or your Next.js app.
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.Nextjs("MyWeb", {
+ *   link: [secret]
+ * });
+ * ```
+ *
+ * Once linked, you can use the secret in your function code.
+ *
+ * ```ts title="app/page.tsx"
+ * import { Resource } from "sst";
+ *
+ * console.log(Resource.MySecret.value);
+ * ```
+ */
+export declare class Secret extends Component implements Link.Linkable {
+    private _value;
+    private _name;
+    private _placeholder?;
+    /**
+     * @param placeholder A placeholder value of the secret. This can be useful for cases where you might not be storing sensitive values.
+  
+     */
+    constructor(name: string, placeholder?: Input<string>);
+    /**
+     * The name of the secret.
+     */
+    get name(): Output<string>;
+    /**
+     * The value of the secret. It'll be `undefined` if the secret has not been set through the CLI or if the `placeholder` hasn't been set.
+     */
+    get value(): Output<string>;
+    /**
+     * The placeholder value of the secret.
+     */
+    get placeholder(): Output<string> | undefined;
+    /** @internal */
+    getSSTLink(): {
+        properties: {
+            value: Output<string>;
+        };
+    };
+}
+//# sourceMappingURL=secret.d.ts.map

package/platform/types/components/secret.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"secret.d.ts","sourceRoot":"","sources":["../../../src/components/secret.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,MAAM,EAAkB,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAY,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,qBAAa,kBAAmB,SAAQ,YAAY;aACtB,UAAU,EAAE,MAAM;gBAAlB,UAAU,EAAE,MAAM;CAK/C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoFG;AACH,qBAAa,MAAO,SAAQ,SAAU,YAAW,IAAI,CAAC,QAAQ;IAC5D,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,YAAY,CAAC,CAAiB;IAEtC;;;OAGG;gBACS,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC;IAqBrD;;OAEG;IACH,IAAW,IAAI,mBAEd;IAED;;OAEG;IACH,IAAW,KAAK,mBAEf;IAED;;OAEG;IACH,IAAW,WAAW,+BAErB;IAED,gBAAgB;IACT,UAAU;;;;;CAOlB"}

package/platform/types/components/size.d.ts

@@ -0,0 +1,5 @@
+export type Size = `${number} ${"MB" | "GB"}`;
+export type SizeGbTb = `${number} ${"GB" | "TB"}`;
+export declare function toMBs(size: Size | SizeGbTb): number;
+export declare function toGBs(size: Size | SizeGbTb): number;
+//# sourceMappingURL=size.d.ts.map

package/platform/types/components/size.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"size.d.ts","sourceRoot":"","sources":["../../../src/components/size.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,IAAI,GAAG,GAAG,MAAM,IAAI,IAAI,GAAG,IAAI,EAAE,CAAC;AAC9C,MAAM,MAAM,QAAQ,GAAG,GAAG,MAAM,IAAI,IAAI,GAAG,IAAI,EAAE,CAAC;AAElD,wBAAgB,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,UAW1C;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,UAW1C"}

package/platform/types/components/takeover.d.ts

@@ -0,0 +1,88 @@
+import { Input, Resource } from "@pulumi/pulumi";
+import type { Parts } from "./parts";
+/**
+ * Where a resource lived before, when that isn't where it lives now.
+ */
+export interface OldAddress {
+    /** The name the resource had. */
+    name: Input<string>;
+    /**
+     * The component it was in, when that was a different component from the one
+     * it's in now. `false` when it wasn't in a component at all: it was created
+     * at the top of the app, beside the component.
+     */
+    parent?: false | {
+        type: string;
+        name: Input<string>;
+        /**
+         * The component that one was created next to, under the same parent.
+         * Leave it out when it was at the top of the app whatever it was
+         * created for.
+         */
+        beside?: Resource;
+    };
+}
+/**
+ * How a component takes over from the one it replaces, so that switching to
+ * it keeps the resources that are already deployed.
+ *
+ * A deployed component with the same type and name becomes this component.
+ * Each of its resources is matched to the part with the same key. List a part
+ * under `moved` when it used to have a different key, or lived in a different
+ * component.
+ */
+export interface Takeover<P extends Parts, C = unknown> {
+    /**
+     * The type of the component this one takes over from, when that isn't this
+     * component's own type.
+     */
+    from?: string;
+    moved?: {
+        [K in keyof P]?: string | ((component: C, 
+        /** The component's name, and the part's id for a `many` part. */
+        part: {
+            name: string;
+            id?: string;
+        }) => OldAddress | OldAddress[] | undefined);
+    };
+}
+/**
+ * Say how a component takes over from the one it replaces. This lives apart
+ * from the component, so the component's own code doesn't carry the layout of
+ * what came before it.
+ *
+ * @example
+ * ```ts
+ * takeover(Redis, {
+ *   moved: {
+ *     // The key this part had
+ *     secret: "proxySecret",
+ *   },
+ * });
+ * ```
+ *
+ * @param component The component that takes over.
+ * @param how The parts that moved, and the type it takes over from when that's another type.
+ */
+export declare function takeover<P extends Parts, C>(component: {
+    new (...args: any[]): C;
+    readonly __pulumiType: string;
+    readonly __parts?: P;
+}, how: Takeover<P, C>): void;
+/**
+ * How a component's class takes over, or the class it extends.
+ * @internal
+ */
+export declare function takeoverOf(component: Function | undefined): Takeover<Parts, any> | undefined;
+/** The Pulumi alias for an old address. */
+export declare function aliasOf(old: OldAddress): {
+    name: Input<string>;
+    parent: Resource;
+} | {
+    name: Input<string>;
+    parent?: undefined;
+} | {
+    name: Input<string>;
+    parent: import("@pulumi/pulumi").Output<string>;
+};
+//# sourceMappingURL=takeover.d.ts.map

package/platform/types/components/takeover.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"takeover.d.ts","sourceRoot":"","sources":["../../../src/components/takeover.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,QAAQ,EAMT,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,iCAAiC;IACjC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB;;;;OAIG;IACH,MAAM,CAAC,EACH,KAAK,GACL;QACE,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACpB;;;;WAIG;QACH,MAAM,CAAC,EAAE,QAAQ,CAAC;KACnB,CAAC;CACP;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,KAAK,EAAE,CAAC,GAAG,OAAO;IACpD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE;SACL,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EACX,MAAM,GACN,CAAC,CACC,SAAS,EAAE,CAAC;QACZ,iEAAiE;QACjE,IAAI,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,EAAE,CAAC,EAAE,MAAM,CAAA;SAAE,KAChC,UAAU,GAAG,UAAU,EAAE,GAAG,SAAS,CAAC;KAChD,CAAC;CACH;AAMD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,KAAK,EAAE,CAAC,EACzC,SAAS,EAAE;IACT,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;CACtB,EACD,GAAG,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,QAGpB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CACxB,SAAS,EAAE,QAAQ,GAAG,SAAS,GAC9B,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,SAAS,CAKlC;AAED,2CAA2C;AAC3C,wBAAgB,OAAO,CAAC,GAAG,EAAE,UAAU;;;;;;;;;EAqBtC"}

package/platform/types/components/transform.d.ts

@@ -0,0 +1,34 @@
+import { type CustomResourceOptions, type OutputInstance, type Resource } from "@pulumi/pulumi";
+export type Transform<T> = Partial<T> | ((args: T, opts: CustomResourceOptions, name: string) => undefined);
+export declare function transform<T extends object>(transform: Transform<T> | undefined, name: string, args: T, opts: CustomResourceOptions): readonly [string, T, CustomResourceOptions];
+/**
+ * A part's args with every level optional: what the object form of a part's
+ * transform takes. It follows how `mergeArgs()` merges. A nested object is
+ * merged key by key, so it can be given in part. Anything else is replaced,
+ * so it's given whole.
+ */
+export type PartialArgs<T> = T extends Whole ? T : T extends object ? {
+    [K in keyof T]?: PartialArgs<T[K]>;
+} : T;
+type Whole = readonly any[] | ((...args: any[]) => any) | Promise<any> | OutputInstance<any> | Resource;
+/**
+ * The transform for one of a component's parts: args to merge into the
+ * defaults, or a function that changes the args and options.
+ */
+export type PartTransform<T> = PartialArgs<T> | ((args: T, opts: CustomResourceOptions, name: string) => undefined);
+/**
+ * Applies a transform to one of a component's parts. Unlike `transform()`,
+ * the object form is merged into nested defaults instead of replacing them.
+ */
+export declare function transformPart<T extends object>(transform: PartTransform<T> | undefined, name: string, args: T, opts: CustomResourceOptions): readonly [string, T, CustomResourceOptions];
+/**
+ * Merges the object form of a transform into a resource's default args.
+ *
+ * Nested objects are merged key by key, so setting one nested value keeps its
+ * siblings. Everything else replaces the default: arrays, strings, numbers,
+ * outputs, assets and resources. To replace a nested object outright, use the
+ * function form of the transform.
+ */
+export declare function mergeArgs<T>(base: T, patch: PartialArgs<T> | undefined): T;
+export {};
+//# sourceMappingURL=transform.d.ts.map

package/platform/types/components/transform.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../../src/components/transform.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,qBAAqB,EAC1B,KAAK,cAAc,EACnB,KAAK,QAAQ,EAGd,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,SAAS,CAAC,CAAC,IACnB,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC;AAExE,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,EACxC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,EACnC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,qBAAqB,+CAW5B;AAED;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,GACxC,CAAC,GACD,CAAC,SAAS,MAAM,GACd;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACtC,CAAC,CAAC;AAIR,KAAK,KAAK,GACN,SAAS,GAAG,EAAE,GACd,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC,GACzB,OAAO,CAAC,GAAG,CAAC,GACZ,cAAc,CAAC,GAAG,CAAC,GACnB,QAAQ,CAAC;AAEb;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IACvB,WAAW,CAAC,CAAC,CAAC,GACd,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC;AAExE;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5C,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS,EACvC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,qBAAqB,+CAO5B;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,CAAC,CAiB1E"}

package/platform/types/components/vercel/account-id.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_TEAM_ID: string;
+//# sourceMappingURL=account-id.d.ts.map

package/platform/types/components/vercel/account-id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"account-id.d.ts","sourceRoot":"","sources":["../../../../src/components/vercel/account-id.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe,QAA8B,CAAC"}

package/platform/types/components/vercel/dns.d.ts

@@ -0,0 +1,73 @@
+/**
+ * The Vercel DNS Adapter is used to create DNS records to manage domains hosted on [Vercel](https://vercel.com/docs/projects/domains/working-with-domains).
+ *
+ * :::note
+ * You need to [add the Vercel provider](/docs/all-providers#directory) to use this adapter.
+ * :::
+ *
+ * This adapter is passed in as `domain.dns` when setting a custom domain; where `example.com`
+ * is hosted on Vercel.
+ *
+ * ```ts
+ * {
+ *   domain: {
+ *     name: "example.com",
+ *     dns: sst.vercel.dns({
+ *       domain: "example.com"
+ *     })
+ *   }
+ * }
+ * ```
+ *
+ * #### Configure provider
+ *
+ * 1. To use this component, add the `vercel` provider to your app.
+ *
+ *    ```bash
+ *    sst add vercel
+ *    ```
+ *
+ * 2. If you don't already have a Vercel Access Token, [follow this guide](https://vercel.com/guides/how-do-i-use-a-vercel-api-access-token#creating-an-access-token) to create one.
+ *
+ * 3. Add a `VERCEL_API_TOKEN` environment variable with the access token value. If the domain
+ * belongs to a team, also add a `VERCEL_TEAM_ID` environment variable with the Team ID. You can
+ * find your Team ID inside your team's general project settings in the Vercel dashboard.
+ *
+ * @packageDocumentation
+ */
+import { DnsRecordArgs } from "@pulumiverse/vercel";
+import { DnsRecord as OverridableDnsRecord } from "./providers/dns-record";
+import { AliasRecord, Record } from "../dns";
+import { ComponentResourceOptions } from "@pulumi/pulumi";
+import { Transform } from "../component";
+import { Input } from "../input";
+export interface DnsArgs {
+    /**
+     * The domain name in your Vercel account to create the record in.
+     *
+     * @example
+     * ```js
+     * {
+     *   domain: "example.com"
+     * }
+     * ```
+     */
+    domain: Input<string>;
+    /**
+     * [Transform](/docs/components#transform) how this component creates its underlying
+     * resources.
+     */
+    transform?: {
+        /**
+         * Transform the Vercel record resource.
+         */
+        record?: Transform<DnsRecordArgs>;
+    };
+}
+export declare function dns(args: DnsArgs): {
+    provider: "vercel";
+    createAlias: (namePrefix: string, record: AliasRecord, opts: ComponentResourceOptions) => import("@pulumi/pulumi").Output<import("@pulumiverse/vercel/dnsRecord").DnsRecord>;
+    createCaa: (namePrefix: string, recordName: string, opts: ComponentResourceOptions) => OverridableDnsRecord[];
+    createRecord: (namePrefix: string, record: Record, opts: ComponentResourceOptions) => import("@pulumi/pulumi").Output<import("@pulumiverse/vercel/dnsRecord").DnsRecord>;
+};
+//# sourceMappingURL=dns.d.ts.map

package/platform/types/components/vercel/dns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dns.d.ts","sourceRoot":"","sources":["../../../../src/components/vercel/dns.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,OAAO,EAAa,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,SAAS,IAAI,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAO,MAAM,EAAE,MAAM,QAAQ,CAAC;AAElD,OAAO,EAAE,wBAAwB,EAAO,MAAM,gBAAgB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAa,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAGjC,MAAM,WAAW,OAAO;IACtB;;;;;;;;;OASG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB;;;OAGG;IACH,SAAS,CAAC,EAAE;QACV;;WAEG;QACH,MAAM,CAAC,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC;KACnC,CAAC;CACH;AAED,wBAAgB,GAAG,CAAC,IAAI,EAAE,OAAO;;8BASjB,MAAM,UACV,WAAW,QACb,wBAAwB;4BAiBlB,MAAM,cACN,MAAM,QACZ,wBAAwB;+BA8BlB,MAAM,UACV,MAAM,QACR,wBAAwB;EAqCjC"}

package/platform/types/components/vercel/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./account-id";
+export * from "./dns";
+//# sourceMappingURL=index.d.ts.map

package/platform/types/components/vercel/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/vercel/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,OAAO,CAAC"}

package/platform/types/components/vercel/providers/dns-record.d.ts

@@ -0,0 +1,15 @@
+import { CustomResourceOptions, Input, Output, dynamic } from "@pulumi/pulumi";
+export interface DnsRecordInputs {
+    domain: Input<string>;
+    type: Input<string>;
+    name: Input<string>;
+    value: Input<string>;
+    mxPriority?: Input<number>;
+}
+export interface DnsRecord {
+    recordId: Output<string>;
+}
+export declare class DnsRecord extends dynamic.Resource {
+    constructor(name: string, args: DnsRecordInputs, opts?: CustomResourceOptions);
+}
+//# sourceMappingURL=dns-record.d.ts.map

package/platform/types/components/vercel/providers/dns-record.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dns-record.d.ts","sourceRoot":"","sources":["../../../../../src/components/vercel/providers/dns-record.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAG/E,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACrB,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC5B;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,qBAAa,SAAU,SAAQ,OAAO,CAAC,QAAQ;gBAE3C,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,eAAe,EACrB,IAAI,CAAC,EAAE,qBAAqB;CAc/B"}