@pulumi/command 0.0.1-alpha.100

package/local/run.d.ts

@@ -0,0 +1,391 @@
+import * as pulumi from "@pulumi/pulumi";
+import * as enums from "../types/enums";
+/**
+ * A local command to be executed.
+ * This command will always be run on any preview or deployment. Use `local.Command` to avoid duplicating executions.
+ */
+export declare function run(args: RunArgs, opts?: pulumi.InvokeOptions): Promise<RunResult>;
+export interface RunArgs {
+    /**
+     * If the previous command's stdout and stderr (as generated by the prior create/update) is
+     * injected into the environment of the next run as PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR.
+     * Defaults to true.
+     */
+    addPreviousOutputInEnv?: boolean;
+    /**
+     * A list of path globs to return as a single archive asset after the command completes.
+     *
+     * When specifying glob patterns the following rules apply:
+     * - We only include files not directories for assets and archives.
+     * - Path separators are `/` on all platforms - including Windows.
+     * - Patterns starting with `!` are 'exclude' rules.
+     * - Rules are evaluated in order, so exclude rules should be after inclusion rules.
+     * - `*` matches anything except `/`
+     * - `**` matches anything, _including_ `/`
+     * - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
+     * - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
+     *
+     * #### Example
+     *
+     * Given the rules:
+     * ```yaml
+     * - "assets/**"
+     * - "src/**.js"
+     * - "!**secret.*"
+     * ```
+     *
+     * When evaluating against this folder:
+     *
+     * ```yaml
+     * - assets/
+     *   - logos/
+     *     - logo.svg
+     * - src/
+     *   - index.js
+     *   - secret.js
+     * ```
+     *
+     * The following paths will be returned:
+     *
+     * ```yaml
+     * - assets/logos/logo.svg
+     * - src/index.js
+     * ```
+     */
+    archivePaths?: string[];
+    /**
+     * A list of path globs to read after the command completes.
+     *
+     * When specifying glob patterns the following rules apply:
+     * - We only include files not directories for assets and archives.
+     * - Path separators are `/` on all platforms - including Windows.
+     * - Patterns starting with `!` are 'exclude' rules.
+     * - Rules are evaluated in order, so exclude rules should be after inclusion rules.
+     * - `*` matches anything except `/`
+     * - `**` matches anything, _including_ `/`
+     * - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
+     * - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
+     *
+     * #### Example
+     *
+     * Given the rules:
+     * ```yaml
+     * - "assets/**"
+     * - "src/**.js"
+     * - "!**secret.*"
+     * ```
+     *
+     * When evaluating against this folder:
+     *
+     * ```yaml
+     * - assets/
+     *   - logos/
+     *     - logo.svg
+     * - src/
+     *   - index.js
+     *   - secret.js
+     * ```
+     *
+     * The following paths will be returned:
+     *
+     * ```yaml
+     * - assets/logos/logo.svg
+     * - src/index.js
+     * ```
+     */
+    assetPaths?: string[];
+    /**
+     * The command to run.
+     */
+    command: string;
+    /**
+     * The directory from which to run the command from. If `dir` does not exist, then
+     * `Command` will fail.
+     */
+    dir?: string;
+    /**
+     * Additional environment variables available to the command's process.
+     */
+    environment?: {
+        [key: string]: string;
+    };
+    /**
+     * The program and arguments to run the command.
+     * On Linux and macOS, defaults to: `["/bin/sh", "-c"]`. On Windows, defaults to: `["cmd", "/C"]`
+     */
+    interpreter?: string[];
+    /**
+     * If the command's stdout and stderr should be logged. This doesn't affect the capturing of
+     * stdout and stderr as outputs. If there might be secrets in the output, you can disable logging here and mark the
+     * outputs as secret via 'additionalSecretOutputs'. Defaults to logging both stdout and stderr.
+     */
+    logging?: enums.local.Logging;
+    /**
+     * Pass a string to the command's process as standard in
+     */
+    stdin?: string;
+}
+export interface RunResult {
+    /**
+     * If the previous command's stdout and stderr (as generated by the prior create/update) is
+     * injected into the environment of the next run as PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR.
+     * Defaults to true.
+     */
+    readonly addPreviousOutputInEnv?: boolean;
+    /**
+     * An archive asset containing files found after running the command.
+     */
+    readonly archive?: pulumi.asset.Archive;
+    /**
+     * A list of path globs to return as a single archive asset after the command completes.
+     *
+     * When specifying glob patterns the following rules apply:
+     * - We only include files not directories for assets and archives.
+     * - Path separators are `/` on all platforms - including Windows.
+     * - Patterns starting with `!` are 'exclude' rules.
+     * - Rules are evaluated in order, so exclude rules should be after inclusion rules.
+     * - `*` matches anything except `/`
+     * - `**` matches anything, _including_ `/`
+     * - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
+     * - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
+     *
+     * #### Example
+     *
+     * Given the rules:
+     * ```yaml
+     * - "assets/**"
+     * - "src/**.js"
+     * - "!**secret.*"
+     * ```
+     *
+     * When evaluating against this folder:
+     *
+     * ```yaml
+     * - assets/
+     *   - logos/
+     *     - logo.svg
+     * - src/
+     *   - index.js
+     *   - secret.js
+     * ```
+     *
+     * The following paths will be returned:
+     *
+     * ```yaml
+     * - assets/logos/logo.svg
+     * - src/index.js
+     * ```
+     */
+    readonly archivePaths?: string[];
+    /**
+     * A list of path globs to read after the command completes.
+     *
+     * When specifying glob patterns the following rules apply:
+     * - We only include files not directories for assets and archives.
+     * - Path separators are `/` on all platforms - including Windows.
+     * - Patterns starting with `!` are 'exclude' rules.
+     * - Rules are evaluated in order, so exclude rules should be after inclusion rules.
+     * - `*` matches anything except `/`
+     * - `**` matches anything, _including_ `/`
+     * - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
+     * - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
+     *
+     * #### Example
+     *
+     * Given the rules:
+     * ```yaml
+     * - "assets/**"
+     * - "src/**.js"
+     * - "!**secret.*"
+     * ```
+     *
+     * When evaluating against this folder:
+     *
+     * ```yaml
+     * - assets/
+     *   - logos/
+     *     - logo.svg
+     * - src/
+     *   - index.js
+     *   - secret.js
+     * ```
+     *
+     * The following paths will be returned:
+     *
+     * ```yaml
+     * - assets/logos/logo.svg
+     * - src/index.js
+     * ```
+     */
+    readonly assetPaths?: string[];
+    /**
+     * A map of assets found after running the command.
+     * The key is the relative path from the command dir
+     */
+    readonly assets?: {
+        [key: string]: pulumi.asset.Asset | pulumi.asset.Archive;
+    };
+    /**
+     * The command to run.
+     */
+    readonly command: string;
+    /**
+     * The directory from which to run the command from. If `dir` does not exist, then
+     * `Command` will fail.
+     */
+    readonly dir?: string;
+    /**
+     * Additional environment variables available to the command's process.
+     */
+    readonly environment?: {
+        [key: string]: string;
+    };
+    /**
+     * The program and arguments to run the command.
+     * On Linux and macOS, defaults to: `["/bin/sh", "-c"]`. On Windows, defaults to: `["cmd", "/C"]`
+     */
+    readonly interpreter?: string[];
+    /**
+     * If the command's stdout and stderr should be logged. This doesn't affect the capturing of
+     * stdout and stderr as outputs. If there might be secrets in the output, you can disable logging here and mark the
+     * outputs as secret via 'additionalSecretOutputs'. Defaults to logging both stdout and stderr.
+     */
+    readonly logging?: enums.local.Logging;
+    /**
+     * The standard error of the command's process
+     */
+    readonly stderr: string;
+    /**
+     * Pass a string to the command's process as standard in
+     */
+    readonly stdin?: string;
+    /**
+     * The standard output of the command's process
+     */
+    readonly stdout: string;
+}
+/**
+ * A local command to be executed.
+ * This command will always be run on any preview or deployment. Use `local.Command` to avoid duplicating executions.
+ */
+export declare function runOutput(args: RunOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<RunResult>;
+export interface RunOutputArgs {
+    /**
+     * If the previous command's stdout and stderr (as generated by the prior create/update) is
+     * injected into the environment of the next run as PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR.
+     * Defaults to true.
+     */
+    addPreviousOutputInEnv?: pulumi.Input<boolean>;
+    /**
+     * A list of path globs to return as a single archive asset after the command completes.
+     *
+     * When specifying glob patterns the following rules apply:
+     * - We only include files not directories for assets and archives.
+     * - Path separators are `/` on all platforms - including Windows.
+     * - Patterns starting with `!` are 'exclude' rules.
+     * - Rules are evaluated in order, so exclude rules should be after inclusion rules.
+     * - `*` matches anything except `/`
+     * - `**` matches anything, _including_ `/`
+     * - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
+     * - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
+     *
+     * #### Example
+     *
+     * Given the rules:
+     * ```yaml
+     * - "assets/**"
+     * - "src/**.js"
+     * - "!**secret.*"
+     * ```
+     *
+     * When evaluating against this folder:
+     *
+     * ```yaml
+     * - assets/
+     *   - logos/
+     *     - logo.svg
+     * - src/
+     *   - index.js
+     *   - secret.js
+     * ```
+     *
+     * The following paths will be returned:
+     *
+     * ```yaml
+     * - assets/logos/logo.svg
+     * - src/index.js
+     * ```
+     */
+    archivePaths?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * A list of path globs to read after the command completes.
+     *
+     * When specifying glob patterns the following rules apply:
+     * - We only include files not directories for assets and archives.
+     * - Path separators are `/` on all platforms - including Windows.
+     * - Patterns starting with `!` are 'exclude' rules.
+     * - Rules are evaluated in order, so exclude rules should be after inclusion rules.
+     * - `*` matches anything except `/`
+     * - `**` matches anything, _including_ `/`
+     * - All returned paths are relative to the working directory (without leading `./`) e.g. `file.text` or `subfolder/file.txt`.
+     * - For full details of the globbing syntax, see [github.com/gobwas/glob](https://github.com/gobwas/glob)
+     *
+     * #### Example
+     *
+     * Given the rules:
+     * ```yaml
+     * - "assets/**"
+     * - "src/**.js"
+     * - "!**secret.*"
+     * ```
+     *
+     * When evaluating against this folder:
+     *
+     * ```yaml
+     * - assets/
+     *   - logos/
+     *     - logo.svg
+     * - src/
+     *   - index.js
+     *   - secret.js
+     * ```
+     *
+     * The following paths will be returned:
+     *
+     * ```yaml
+     * - assets/logos/logo.svg
+     * - src/index.js
+     * ```
+     */
+    assetPaths?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * The command to run.
+     */
+    command: pulumi.Input<string>;
+    /**
+     * The directory from which to run the command from. If `dir` does not exist, then
+     * `Command` will fail.
+     */
+    dir?: pulumi.Input<string>;
+    /**
+     * Additional environment variables available to the command's process.
+     */
+    environment?: pulumi.Input<{
+        [key: string]: pulumi.Input<string>;
+    }>;
+    /**
+     * The program and arguments to run the command.
+     * On Linux and macOS, defaults to: `["/bin/sh", "-c"]`. On Windows, defaults to: `["cmd", "/C"]`
+     */
+    interpreter?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * If the command's stdout and stderr should be logged. This doesn't affect the capturing of
+     * stdout and stderr as outputs. If there might be secrets in the output, you can disable logging here and mark the
+     * outputs as secret via 'additionalSecretOutputs'. Defaults to logging both stdout and stderr.
+     */
+    logging?: pulumi.Input<enums.local.Logging>;
+    /**
+     * Pass a string to the command's process as standard in
+     */
+    stdin?: pulumi.Input<string>;
+}

package/local/run.js

@@ -0,0 +1,46 @@
+"use strict";
+// *** WARNING: this file was generated by pulumi-language-nodejs. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runOutput = exports.run = void 0;
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("../utilities");
+/**
+ * A local command to be executed.
+ * This command will always be run on any preview or deployment. Use `local.Command` to avoid duplicating executions.
+ */
+function run(args, opts) {
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
+    return pulumi.runtime.invoke("command:local:run", {
+        "addPreviousOutputInEnv": args.addPreviousOutputInEnv,
+        "archivePaths": args.archivePaths,
+        "assetPaths": args.assetPaths,
+        "command": args.command,
+        "dir": args.dir,
+        "environment": args.environment,
+        "interpreter": args.interpreter,
+        "logging": args.logging,
+        "stdin": args.stdin,
+    }, opts);
+}
+exports.run = run;
+/**
+ * A local command to be executed.
+ * This command will always be run on any preview or deployment. Use `local.Command` to avoid duplicating executions.
+ */
+function runOutput(args, opts) {
+    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
+    return pulumi.runtime.invokeOutput("command:local:run", {
+        "addPreviousOutputInEnv": args.addPreviousOutputInEnv,
+        "archivePaths": args.archivePaths,
+        "assetPaths": args.assetPaths,
+        "command": args.command,
+        "dir": args.dir,
+        "environment": args.environment,
+        "interpreter": args.interpreter,
+        "logging": args.logging,
+        "stdin": args.stdin,
+    }, opts);
+}
+exports.runOutput = runOutput;
+//# sourceMappingURL=run.js.map

package/local/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../local/run.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAIzC,0CAA0C;AAE1C;;;GAGG;AACH,SAAgB,GAAG,CAAC,IAAa,EAAE,IAA2B;IAC1D,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,mBAAmB,EAAE;QAC9C,wBAAwB,EAAE,IAAI,CAAC,sBAAsB;QACrD,cAAc,EAAE,IAAI,CAAC,YAAY;QACjC,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,KAAK,EAAE,IAAI,CAAC,GAAG;QACf,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,OAAO,EAAE,IAAI,CAAC,KAAK;KACtB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAbD,kBAaC;AAgQD;;;GAGG;AACH,SAAgB,SAAS,CAAC,IAAmB,EAAE,IAAiC;IAC5E,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,mBAAmB,EAAE;QACpD,wBAAwB,EAAE,IAAI,CAAC,sBAAsB;QACrD,cAAc,EAAE,IAAI,CAAC,YAAY;QACjC,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,KAAK,EAAE,IAAI,CAAC,GAAG;QACf,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,OAAO,EAAE,IAAI,CAAC,KAAK;KACtB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAbD,8BAaC"}

package/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@pulumi/command",
+    "version": "0.0.1-alpha.100",
+    "keywords": [
+        "pulumi",
+        "command",
+        "category/utility",
+        "kind/native"
+    ],
+    "homepage": "https://pulumi.com",
+    "repository": "https://github.com/pulumi/pulumi-command",
+    "license": "Apache-2.0",
+    "scripts": {
+        "build": "tsc",
+        "install": "node scripts/install-pulumi-plugin.js resource command 0.0.1-alpha.100"
+    },
+    "dependencies": {
+        "@pulumi/pulumi": "^3.136.0"
+    },
+    "devDependencies": {
+        "@types/node": "^14",
+        "typescript": "^4.3.5"
+    },
+    "pulumi": {
+        "resource": true,
+        "name": "command",
+        "version": "0.0.1-alpha.100"
+    }
+}

package/package.json.dev

@@ -0,0 +1,28 @@
+{
+    "name": "@pulumi/command",
+    "version": "0.0.1-alpha.100",
+    "keywords": [
+        "pulumi",
+        "command",
+        "category/utility",
+        "kind/native"
+    ],
+    "homepage": "https://pulumi.com",
+    "repository": "https://github.com/pulumi/pulumi-command",
+    "license": "Apache-2.0",
+    "scripts": {
+        "build": "tsc"
+    },
+    "dependencies": {
+        "@pulumi/pulumi": "^3.136.0"
+    },
+    "devDependencies": {
+        "@types/node": "^14",
+        "typescript": "^4.3.5"
+    },
+    "pulumi": {
+        "resource": true,
+        "name": "command",
+        "version": "0.0.1-alpha.100"
+    }
+}

package/provider.d.ts

@@ -0,0 +1,21 @@
+import * as pulumi from "@pulumi/pulumi";
+export declare class Provider extends pulumi.ProviderResource {
+    /**
+     * Returns true if the given object is an instance of Provider.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj: any): obj is Provider;
+    /**
+     * Create a Provider 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?: ProviderArgs, opts?: pulumi.ResourceOptions);
+}
+/**
+ * The set of arguments for constructing a Provider resource.
+ */
+export interface ProviderArgs {
+}

package/provider.js

@@ -0,0 +1,38 @@
+"use strict";
+// *** WARNING: this file was generated by pulumi-language-nodejs. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Provider = void 0;
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+class Provider extends pulumi.ProviderResource {
+    /**
+     * Returns true if the given object is an instance of Provider.  This is designed to work even
+     * when multiple copies of the Pulumi SDK have been loaded into the same process.
+     */
+    static isInstance(obj) {
+        if (obj === undefined || obj === null) {
+            return false;
+        }
+        return obj['__pulumiType'] === "pulumi:providers:" + Provider.__pulumiType;
+    }
+    /**
+     * Create a Provider 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, args, opts) {
+        let resourceInputs = {};
+        opts = opts || {};
+        {
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        super(Provider.__pulumiType, name, resourceInputs, opts);
+    }
+}
+exports.Provider = Provider;
+/** @internal */
+Provider.__pulumiType = 'command';
+//# sourceMappingURL=provider.js.map

package/provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../provider.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC,MAAa,QAAS,SAAQ,MAAM,CAAC,gBAAgB;IAIjD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,mBAAmB,GAAG,QAAQ,CAAC,YAAY,CAAC;IAC/E,CAAC;IAGD;;;;;;OAMG;IACH,YAAY,IAAY,EAAE,IAAmB,EAAE,IAA6B;QACxE,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB;SACC;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,QAAQ,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;;AA9BL,4BA+BC;AA9BG,gBAAgB;AACO,qBAAY,GAAG,SAAS,CAAC"}