@mstuercke/pulumi-modules 1.2.4 → 1.4.0

package/sdks/clerk/user.ts

@@ -0,0 +1,458 @@
+// *** WARNING: this file was generated by pulumi-language-nodejs. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import * as pulumi from "@pulumi/pulumi";
+import * as utilities from "./utilities";
+
+export class User extends pulumi.CustomResource {
+    /**
+     * Get an existing User resource's state with the given name, ID, and optional extra
+     * properties used to qualify the lookup.
+     *
+     * @param name The _unique_ name of the resulting resource.
+     * @param id The _unique_ provider ID of the resource to lookup.
+     * @param state Any extra arguments used during the lookup.
+     * @param opts Optional settings to control the behavior of the CustomResource.
+     */
+    public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User {
+        return new User(name, <any>state, { ...opts, id: id });
+    }
+
+    /** @internal */
+    public static readonly __pulumiType = 'clerk:index/user:User';
+
+    /**
+     * Returns true if the given object is an instance of User.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    public static isInstance(obj: any): obj is User {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === User.__pulumiType;
+    }
+
+    /**
+     * Backup codes to seed for the user. Write-only; never returned by the API.
+     */
+    declare public readonly backupCodes: pulumi.Output<string[] | undefined>;
+    /**
+     * Whether the user is banned.
+     */
+    declare public /*out*/ readonly banned: pulumi.Output<boolean>;
+    /**
+     * Whether the user is allowed to create organizations.
+     */
+    declare public readonly createOrganizationEnabled: pulumi.Output<boolean>;
+    /**
+     * The maximum number of organizations the user can create.
+     */
+    declare public readonly createOrganizationsLimit: pulumi.Output<number | undefined>;
+    /**
+     * Timestamp (RFC3339) when the user was created. Set explicitly to backdate a seeded user; backdating forces a new user.
+     */
+    declare public readonly createdAt: pulumi.Output<string>;
+    /**
+     * Whether the user is allowed to delete their own account.
+     */
+    declare public readonly deleteSelfEnabled: pulumi.Output<boolean>;
+    /**
+     * Email addresses to associate with the user at creation. The first is treated as primary. Changing this set forces a new
+     * user (identifiers are managed via dedicated APIs after creation).
+     */
+    declare public readonly emailAddresses: pulumi.Output<string[] | undefined>;
+    /**
+     * A unique identifier for the user in an external system.
+     */
+    declare public readonly externalId: pulumi.Output<string | undefined>;
+    /**
+     * First name of the user.
+     */
+    declare public readonly firstName: pulumi.Output<string | undefined>;
+    /**
+     * Last name of the user.
+     */
+    declare public readonly lastName: pulumi.Output<string | undefined>;
+    /**
+     * Timestamp (RFC3339) when the user accepted legal requirements. Write-only.
+     */
+    declare public readonly legalAcceptedAt: pulumi.Output<string | undefined>;
+    /**
+     * The user's locale in BCP-47 format.
+     */
+    declare public readonly locale: pulumi.Output<string>;
+    /**
+     * Whether the user is locked.
+     */
+    declare public /*out*/ readonly locked: pulumi.Output<boolean>;
+    /**
+     * Plaintext password for the user. Write-only; never returned by the API.
+     */
+    declare public readonly password: pulumi.Output<string | undefined>;
+    /**
+     * Pre-hashed password for migration-style seeding. Pair with password_hasher. Write-only.
+     */
+    declare public readonly passwordDigest: pulumi.Output<string | undefined>;
+    /**
+     * Hashing algorithm used for password_digest (e.g. bcrypt, argon2i, pbkdf2_sha256). Write-only.
+     */
+    declare public readonly passwordHasher: pulumi.Output<string | undefined>;
+    /**
+     * Phone numbers to associate with the user at creation. Changing this set forces a new user.
+     */
+    declare public readonly phoneNumbers: pulumi.Output<string[] | undefined>;
+    /**
+     * ID of the user's primary email address.
+     */
+    declare public /*out*/ readonly primaryEmailAddressId: pulumi.Output<string>;
+    /**
+     * ID of the user's primary phone number.
+     */
+    declare public /*out*/ readonly primaryPhoneNumberId: pulumi.Output<string>;
+    /**
+     * Private metadata as a JSON string. Only accessible from the backend.
+     */
+    declare public readonly privateMetadata: pulumi.Output<string | undefined>;
+    /**
+     * Public metadata as a JSON string. Accessible from both the frontend and backend.
+     */
+    declare public readonly publicMetadata: pulumi.Output<string | undefined>;
+    /**
+     * When true, legal acceptance validation is skipped. Write-only.
+     */
+    declare public readonly skipLegalChecks: pulumi.Output<boolean | undefined>;
+    /**
+     * When true, password strength validation is skipped. Write-only.
+     */
+    declare public readonly skipPasswordChecks: pulumi.Output<boolean | undefined>;
+    /**
+     * When true, the user can be created without a password. Write-only.
+     */
+    declare public readonly skipPasswordRequirement: pulumi.Output<boolean | undefined>;
+    /**
+     * TOTP secret to seed for the user. Write-only.
+     */
+    declare public readonly totpSecret: pulumi.Output<string | undefined>;
+    /**
+     * Unsafe metadata as a JSON string. Writable from the frontend; do not store sensitive data here.
+     */
+    declare public readonly unsafeMetadata: pulumi.Output<string | undefined>;
+    /**
+     * Timestamp (RFC3339) when the user was last updated.
+     */
+    declare public /*out*/ readonly updatedAt: pulumi.Output<string>;
+    /**
+     * Username for the user. Requires usernames to be enabled in the Clerk Dashboard.
+     */
+    declare public readonly username: pulumi.Output<string>;
+    /**
+     * Web3 wallet addresses to associate with the user at creation. Changing this set forces a new user.
+     */
+    declare public readonly web3Wallets: pulumi.Output<string[] | undefined>;
+
+    /**
+     * Create a User resource with the given unique name, arguments, and options.
+     *
+     * @param name The _unique_ name of the resource.
+     * @param args The arguments to use to populate this resource's properties.
+     * @param opts A bag of options that control this resource's behavior.
+     */
+    constructor(name: string, args?: UserArgs, opts?: pulumi.CustomResourceOptions)
+    constructor(name: string, argsOrState?: UserArgs | UserState, opts?: pulumi.CustomResourceOptions) {
+        let resourceInputs: pulumi.Inputs = {};
+        opts = opts || {};
+        if (opts.id) {
+            const state = argsOrState as UserState | undefined;
+            resourceInputs["backupCodes"] = state?.backupCodes;
+            resourceInputs["banned"] = state?.banned;
+            resourceInputs["createOrganizationEnabled"] = state?.createOrganizationEnabled;
+            resourceInputs["createOrganizationsLimit"] = state?.createOrganizationsLimit;
+            resourceInputs["createdAt"] = state?.createdAt;
+            resourceInputs["deleteSelfEnabled"] = state?.deleteSelfEnabled;
+            resourceInputs["emailAddresses"] = state?.emailAddresses;
+            resourceInputs["externalId"] = state?.externalId;
+            resourceInputs["firstName"] = state?.firstName;
+            resourceInputs["lastName"] = state?.lastName;
+            resourceInputs["legalAcceptedAt"] = state?.legalAcceptedAt;
+            resourceInputs["locale"] = state?.locale;
+            resourceInputs["locked"] = state?.locked;
+            resourceInputs["password"] = state?.password;
+            resourceInputs["passwordDigest"] = state?.passwordDigest;
+            resourceInputs["passwordHasher"] = state?.passwordHasher;
+            resourceInputs["phoneNumbers"] = state?.phoneNumbers;
+            resourceInputs["primaryEmailAddressId"] = state?.primaryEmailAddressId;
+            resourceInputs["primaryPhoneNumberId"] = state?.primaryPhoneNumberId;
+            resourceInputs["privateMetadata"] = state?.privateMetadata;
+            resourceInputs["publicMetadata"] = state?.publicMetadata;
+            resourceInputs["skipLegalChecks"] = state?.skipLegalChecks;
+            resourceInputs["skipPasswordChecks"] = state?.skipPasswordChecks;
+            resourceInputs["skipPasswordRequirement"] = state?.skipPasswordRequirement;
+            resourceInputs["totpSecret"] = state?.totpSecret;
+            resourceInputs["unsafeMetadata"] = state?.unsafeMetadata;
+            resourceInputs["updatedAt"] = state?.updatedAt;
+            resourceInputs["username"] = state?.username;
+            resourceInputs["web3Wallets"] = state?.web3Wallets;
+        } else {
+            const args = argsOrState as UserArgs | undefined;
+            resourceInputs["backupCodes"] = args?.backupCodes ? pulumi.secret(args.backupCodes) : undefined;
+            resourceInputs["createOrganizationEnabled"] = args?.createOrganizationEnabled;
+            resourceInputs["createOrganizationsLimit"] = args?.createOrganizationsLimit;
+            resourceInputs["createdAt"] = args?.createdAt;
+            resourceInputs["deleteSelfEnabled"] = args?.deleteSelfEnabled;
+            resourceInputs["emailAddresses"] = args?.emailAddresses;
+            resourceInputs["externalId"] = args?.externalId;
+            resourceInputs["firstName"] = args?.firstName;
+            resourceInputs["lastName"] = args?.lastName;
+            resourceInputs["legalAcceptedAt"] = args?.legalAcceptedAt;
+            resourceInputs["locale"] = args?.locale;
+            resourceInputs["password"] = args?.password ? pulumi.secret(args.password) : undefined;
+            resourceInputs["passwordDigest"] = args?.passwordDigest ? pulumi.secret(args.passwordDigest) : undefined;
+            resourceInputs["passwordHasher"] = args?.passwordHasher;
+            resourceInputs["phoneNumbers"] = args?.phoneNumbers;
+            resourceInputs["privateMetadata"] = args?.privateMetadata ? pulumi.secret(args.privateMetadata) : undefined;
+            resourceInputs["publicMetadata"] = args?.publicMetadata;
+            resourceInputs["skipLegalChecks"] = args?.skipLegalChecks;
+            resourceInputs["skipPasswordChecks"] = args?.skipPasswordChecks;
+            resourceInputs["skipPasswordRequirement"] = args?.skipPasswordRequirement;
+            resourceInputs["totpSecret"] = args?.totpSecret ? pulumi.secret(args.totpSecret) : undefined;
+            resourceInputs["unsafeMetadata"] = args?.unsafeMetadata;
+            resourceInputs["username"] = args?.username;
+            resourceInputs["web3Wallets"] = args?.web3Wallets;
+            resourceInputs["banned"] = undefined /*out*/;
+            resourceInputs["locked"] = undefined /*out*/;
+            resourceInputs["primaryEmailAddressId"] = undefined /*out*/;
+            resourceInputs["primaryPhoneNumberId"] = undefined /*out*/;
+            resourceInputs["updatedAt"] = undefined /*out*/;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        const secretOpts = { additionalSecretOutputs: ["backupCodes", "password", "passwordDigest", "privateMetadata", "totpSecret"] };
+        opts = pulumi.mergeOptions(opts, secretOpts);
+        super(User.__pulumiType, name, resourceInputs, opts, false /*dependency*/, utilities.getPackage());
+    }
+}
+
+/**
+ * Input properties used for looking up and filtering User resources.
+ */
+export interface UserState {
+    /**
+     * Backup codes to seed for the user. Write-only; never returned by the API.
+     */
+    backupCodes?: pulumi.Input<pulumi.Input<string>[] | undefined>;
+    /**
+     * Whether the user is banned.
+     */
+    banned?: pulumi.Input<boolean | undefined>;
+    /**
+     * Whether the user is allowed to create organizations.
+     */
+    createOrganizationEnabled?: pulumi.Input<boolean | undefined>;
+    /**
+     * The maximum number of organizations the user can create.
+     */
+    createOrganizationsLimit?: pulumi.Input<number | undefined>;
+    /**
+     * Timestamp (RFC3339) when the user was created. Set explicitly to backdate a seeded user; backdating forces a new user.
+     */
+    createdAt?: pulumi.Input<string | undefined>;
+    /**
+     * Whether the user is allowed to delete their own account.
+     */
+    deleteSelfEnabled?: pulumi.Input<boolean | undefined>;
+    /**
+     * Email addresses to associate with the user at creation. The first is treated as primary. Changing this set forces a new
+     * user (identifiers are managed via dedicated APIs after creation).
+     */
+    emailAddresses?: pulumi.Input<pulumi.Input<string>[] | undefined>;
+    /**
+     * A unique identifier for the user in an external system.
+     */
+    externalId?: pulumi.Input<string | undefined>;
+    /**
+     * First name of the user.
+     */
+    firstName?: pulumi.Input<string | undefined>;
+    /**
+     * Last name of the user.
+     */
+    lastName?: pulumi.Input<string | undefined>;
+    /**
+     * Timestamp (RFC3339) when the user accepted legal requirements. Write-only.
+     */
+    legalAcceptedAt?: pulumi.Input<string | undefined>;
+    /**
+     * The user's locale in BCP-47 format.
+     */
+    locale?: pulumi.Input<string | undefined>;
+    /**
+     * Whether the user is locked.
+     */
+    locked?: pulumi.Input<boolean | undefined>;
+    /**
+     * Plaintext password for the user. Write-only; never returned by the API.
+     */
+    password?: pulumi.Input<string | undefined>;
+    /**
+     * Pre-hashed password for migration-style seeding. Pair with password_hasher. Write-only.
+     */
+    passwordDigest?: pulumi.Input<string | undefined>;
+    /**
+     * Hashing algorithm used for password_digest (e.g. bcrypt, argon2i, pbkdf2_sha256). Write-only.
+     */
+    passwordHasher?: pulumi.Input<string | undefined>;
+    /**
+     * Phone numbers to associate with the user at creation. Changing this set forces a new user.
+     */
+    phoneNumbers?: pulumi.Input<pulumi.Input<string>[] | undefined>;
+    /**
+     * ID of the user's primary email address.
+     */
+    primaryEmailAddressId?: pulumi.Input<string | undefined>;
+    /**
+     * ID of the user's primary phone number.
+     */
+    primaryPhoneNumberId?: pulumi.Input<string | undefined>;
+    /**
+     * Private metadata as a JSON string. Only accessible from the backend.
+     */
+    privateMetadata?: pulumi.Input<string | undefined>;
+    /**
+     * Public metadata as a JSON string. Accessible from both the frontend and backend.
+     */
+    publicMetadata?: pulumi.Input<string | undefined>;
+    /**
+     * When true, legal acceptance validation is skipped. Write-only.
+     */
+    skipLegalChecks?: pulumi.Input<boolean | undefined>;
+    /**
+     * When true, password strength validation is skipped. Write-only.
+     */
+    skipPasswordChecks?: pulumi.Input<boolean | undefined>;
+    /**
+     * When true, the user can be created without a password. Write-only.
+     */
+    skipPasswordRequirement?: pulumi.Input<boolean | undefined>;
+    /**
+     * TOTP secret to seed for the user. Write-only.
+     */
+    totpSecret?: pulumi.Input<string | undefined>;
+    /**
+     * Unsafe metadata as a JSON string. Writable from the frontend; do not store sensitive data here.
+     */
+    unsafeMetadata?: pulumi.Input<string | undefined>;
+    /**
+     * Timestamp (RFC3339) when the user was last updated.
+     */
+    updatedAt?: pulumi.Input<string | undefined>;
+    /**
+     * Username for the user. Requires usernames to be enabled in the Clerk Dashboard.
+     */
+    username?: pulumi.Input<string | undefined>;
+    /**
+     * Web3 wallet addresses to associate with the user at creation. Changing this set forces a new user.
+     */
+    web3Wallets?: pulumi.Input<pulumi.Input<string>[] | undefined>;
+}
+
+/**
+ * The set of arguments for constructing a User resource.
+ */
+export interface UserArgs {
+    /**
+     * Backup codes to seed for the user. Write-only; never returned by the API.
+     */
+    backupCodes?: pulumi.Input<pulumi.Input<string>[] | undefined>;
+    /**
+     * Whether the user is allowed to create organizations.
+     */
+    createOrganizationEnabled?: pulumi.Input<boolean | undefined>;
+    /**
+     * The maximum number of organizations the user can create.
+     */
+    createOrganizationsLimit?: pulumi.Input<number | undefined>;
+    /**
+     * Timestamp (RFC3339) when the user was created. Set explicitly to backdate a seeded user; backdating forces a new user.
+     */
+    createdAt?: pulumi.Input<string | undefined>;
+    /**
+     * Whether the user is allowed to delete their own account.
+     */
+    deleteSelfEnabled?: pulumi.Input<boolean | undefined>;
+    /**
+     * Email addresses to associate with the user at creation. The first is treated as primary. Changing this set forces a new
+     * user (identifiers are managed via dedicated APIs after creation).
+     */
+    emailAddresses?: pulumi.Input<pulumi.Input<string>[] | undefined>;
+    /**
+     * A unique identifier for the user in an external system.
+     */
+    externalId?: pulumi.Input<string | undefined>;
+    /**
+     * First name of the user.
+     */
+    firstName?: pulumi.Input<string | undefined>;
+    /**
+     * Last name of the user.
+     */
+    lastName?: pulumi.Input<string | undefined>;
+    /**
+     * Timestamp (RFC3339) when the user accepted legal requirements. Write-only.
+     */
+    legalAcceptedAt?: pulumi.Input<string | undefined>;
+    /**
+     * The user's locale in BCP-47 format.
+     */
+    locale?: pulumi.Input<string | undefined>;
+    /**
+     * Plaintext password for the user. Write-only; never returned by the API.
+     */
+    password?: pulumi.Input<string | undefined>;
+    /**
+     * Pre-hashed password for migration-style seeding. Pair with password_hasher. Write-only.
+     */
+    passwordDigest?: pulumi.Input<string | undefined>;
+    /**
+     * Hashing algorithm used for password_digest (e.g. bcrypt, argon2i, pbkdf2_sha256). Write-only.
+     */
+    passwordHasher?: pulumi.Input<string | undefined>;
+    /**
+     * Phone numbers to associate with the user at creation. Changing this set forces a new user.
+     */
+    phoneNumbers?: pulumi.Input<pulumi.Input<string>[] | undefined>;
+    /**
+     * Private metadata as a JSON string. Only accessible from the backend.
+     */
+    privateMetadata?: pulumi.Input<string | undefined>;
+    /**
+     * Public metadata as a JSON string. Accessible from both the frontend and backend.
+     */
+    publicMetadata?: pulumi.Input<string | undefined>;
+    /**
+     * When true, legal acceptance validation is skipped. Write-only.
+     */
+    skipLegalChecks?: pulumi.Input<boolean | undefined>;
+    /**
+     * When true, password strength validation is skipped. Write-only.
+     */
+    skipPasswordChecks?: pulumi.Input<boolean | undefined>;
+    /**
+     * When true, the user can be created without a password. Write-only.
+     */
+    skipPasswordRequirement?: pulumi.Input<boolean | undefined>;
+    /**
+     * TOTP secret to seed for the user. Write-only.
+     */
+    totpSecret?: pulumi.Input<string | undefined>;
+    /**
+     * Unsafe metadata as a JSON string. Writable from the frontend; do not store sensitive data here.
+     */
+    unsafeMetadata?: pulumi.Input<string | undefined>;
+    /**
+     * Username for the user. Requires usernames to be enabled in the Clerk Dashboard.
+     */
+    username?: pulumi.Input<string | undefined>;
+    /**
+     * Web3 wallet addresses to associate with the user at creation. Changing this set forces a new user.
+     */
+    web3Wallets?: pulumi.Input<pulumi.Input<string>[] | undefined>;
+}

package/sdks/clerk/utilities.ts

@@ -0,0 +1,107 @@
+// *** WARNING: this file was generated by pulumi-language-nodejs. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+
+import * as runtime from "@pulumi/pulumi/runtime";
+import * as pulumi from "@pulumi/pulumi";
+
+export function getEnv(...vars: string[]): string | undefined {
+    for (const v of vars) {
+        const value = process.env[v];
+        if (value) {
+            return value;
+        }
+    }
+    return undefined;
+}
+
+export function getEnvBoolean(...vars: string[]): boolean | undefined {
+    const s = getEnv(...vars);
+    if (s !== undefined) {
+        // NOTE: these values are taken from https://golang.org/src/strconv/atob.go?s=351:391#L1, which is what
+        // Terraform uses internally when parsing boolean values.
+        if (["1", "t", "T", "true", "TRUE", "True"].find(v => v === s) !== undefined) {
+            return true;
+        }
+        if (["0", "f", "F", "false", "FALSE", "False"].find(v => v === s) !== undefined) {
+            return false;
+        }
+    }
+    return undefined;
+}
+
+export function getEnvNumber(...vars: string[]): number | undefined {
+    const s = getEnv(...vars);
+    if (s !== undefined) {
+        const f = parseFloat(s);
+        if (!isNaN(f)) {
+            return f;
+        }
+    }
+    return undefined;
+}
+
+export function getVersion(): string {
+    let version = require('./package.json').version;
+    // Node allows for the version to be prefixed by a "v", while semver doesn't.
+    // If there is a v, strip it off.
+    if (version.indexOf('v') === 0) {
+        version = version.slice(1);
+    }
+    return version;
+}
+
+/** @internal */
+export function resourceOptsDefaults(): any {
+    return { version: getVersion() };
+}
+
+/** @internal */
+export function lazyLoad(exports: any, props: string[], loadModule: any) {
+    for (let property of props) {
+        Object.defineProperty(exports, property, {
+            enumerable: true,
+            get: function() {
+                return loadModule()[property];
+            },
+        });
+    }
+}
+
+/** @internal */
+export async function callAsync<T>(
+    tok: string,
+    props: pulumi.Inputs,
+    res?: pulumi.Resource,
+    opts?: {property?: string},
+): Promise<T> {
+    const o: any = runtime.call<T>(tok, props, res);
+    const value = await o.promise(true /*withUnknowns*/);
+    const isKnown = await o.isKnown;
+    const isSecret = await o.isSecret;
+    const problem: string|undefined =
+        !isKnown ? "an unknown value"
+        : isSecret ? "a secret value"
+        : undefined;
+    // Ingoring o.resources silently. They are typically non-empty, r.f() calls include r as a dependency.
+    if (problem) {
+        throw new Error(`Plain resource method "${tok}" incorrectly returned ${problem}. ` +
+            "This is an error in the provider, please report this to the provider developer.");
+    }
+    // Extract a single property if requested.
+    if (opts && opts.property) {
+        return value[opts.property];
+    }
+    return value;
+}
+
+export async function getPackage(): Promise<string | undefined> {
+	return runtime.registerPackage({
+		baseProviderName: "terraform-provider",
+		baseProviderVersion: "0.8.1",
+		baseProviderDownloadUrl: "",
+		packageName: "clerk",
+		packageVersion: "0.7.2",
+		base64Parameter: "eyJyZW1vdGUiOnsidXJsIjoicmVnaXN0cnkub3BlbnRvZnUub3JnL2J1aWxkd2l0aGRlY2svY2xlcmsiLCJ2ZXJzaW9uIjoiMC43LjIifX0=",
+	});
+}