@saws/secrets 1.0.11 → 2.0.0-beta.0

package/README.md

@@ -1,122 +0,0 @@
-<div align='center'>
-
-# Secrets
-
-Service and library managing Secrets in AWS SSM Parameter store.
-
-</div>
-
-## Table of Contents
-- [Installation](#installation)
-- [Development](#development)
-- [Deployment](#deployment)
-- [Services](#services)
-  - [SecretsService](#secrets-service)
-- [When used as a dependency](#when-used-as-a-dependency)
-- [Libraries](#libraries)
-  - [SecretsManager](#secrets-manager)
-- [Commands](#commands)
-
-## Installation <a id='installation'>
-
-From the command line run:
-```bash
-npm install @saws/secrets
-```
-
-Then add the [`SecretsService`](#secrets-service) to your `saws.js` file.
-
-## Development <a id='development'>
-
-When running your SAWS application in development, this service will store and retrieve local secrets out of a .gitignored file located at `.saws/.secrets`. This file is in the same format as a `.env` file.
-
-## Deployment <a id='deployment'>
-
-When you deploy a `SecretsService` it will not create any additional AWS resources for you. The way to set secrets in a specific stage would be to use the `@saws/cli` `secrets` command.
-
-## Services <a id='services'>
-
-`@saws/secrets` includes one service, `SecretsService`.
-
-### `SecretsService` <a id='secrets-service'>
-
-You can require the `SecretsService` and use it in your `saws.js` file like so:
-```js
-const { SecretsService } = require('@saws/secrets/secrets-service')
-
-// will almost exclusively be used as a dependency to other services
-const secrets = new SecretsService({
-  name: 'my-secrets',
-})
-```
-
-The `SecretsService` constructor accepts the following options:
-
-#### `name: string`
-The name of your service. This should be unique across all of your services.
-
-#### `dependencies: ServiceDefinition[]`
-An array of all of the other services this service depends on. This will ensure that permissions, environment variables, and execution order are all set up.
-
-## When used as a dependency <a id='when-used-as-a-dependency'>
-
-When a `SecretsService` is used as a dependency, it will not attach any environment variables to the dependant service.
-
-## Libraries <a id='libraries'>
-
-`@saws/secrets` includes a `SecretsManager` class that can be used to get and set secrets in the current stage.
-
-### `SecretsManager` <a id='secrets-manager'>
-
-The `SecretsManager` class can be used as follows:
-
-```ts
-import { SecretsManager } from '@saws/secrets/secrets-manager'
-
-const manager = new SecretsManager()
-
-await manager.get('secret-name')
-
-await manager.set('secret-name', 'value')
-```
-
-#### `get(name: string): Promise<string>`
-This function will get a secret value from either your `.secrets` file when running locally, or from SSM Parameter Store when running in a production environment.
-
-#### `set(name: string, value: string): Promise<void>`
-This function will set a secret value either in your `.secrets` file when running locally, or to SSM Parameter Store when running in a production environment. The secret will be set as an encrypted string in Parameter Store.
-
-## Commands <a id='commands'>
-
-When you have a `SecretsService` in your `saw.js` config file, it will add the following commands to the `saws` cli command:
-
-### `secrets`
-
-The `saws secrets` command is used for managing secrets within the application. It requires a secret name and supports various operations such as setting and getting secrets.
-
-#### Usage
-
-```bash
-saws secrets [options] <name>
-```
-**Arguments**
-<name>: The name of the secret. This is a required argument.
-
-**Options**
---stage <string>: Specifies the stage environment (e.g., local, dev, prod). Default is local.
---set <string>: Sets the secret to the specified value.
---get: Retrieves the current value of the secret.
-
-**Examples**
-
-Set a secret:
-This command sets the value of mySecret in the prod stage to mySecretValue.
-```bash
-saws secrets --stage prod --set "mySecretValue" mySecret
-```
-
-Get a secret:
-This command retrieves the value of mySecret in the dev stage.
-```bash
-saws secrets --stage dev --get mySecret
-```

package/dist/src/SecretsManager.d.ts

@@ -1,10 +0,0 @@
-export interface SecretsManagerInterface {
-    get(name: string): Promise<string>;
-    set(name: string, value: string): Promise<void>;
-}
-export declare class SecretsManager implements SecretsManagerInterface {
-    manager: SecretsManagerInterface;
-    constructor(stage?: string);
-    get(name: string): Promise<string>;
-    set(name: string, value: string): Promise<void>;
-}

package/dist/src/SecretsManager.js

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SecretsManager = void 0;
-const ssm_1 = require("@saws/aws/ssm");
-const constants_1 = require("@saws/utils/constants");
-const node_path_1 = require("node:path");
-const fs_1 = require("fs");
-let cache = {};
-class LocalSecretsManager {
-    secretsFilePath = (0, node_path_1.resolve)(constants_1.SAWS_DIR, ".secrets");
-    async ensureSecretsFileExists() {
-        try {
-            await fs_1.promises.stat(this.secretsFilePath);
-        }
-        catch (err) {
-            await fs_1.promises.writeFile(this.secretsFilePath, "");
-        }
-    }
-    async fillCache() {
-        await this.ensureSecretsFileExists();
-        if (Object.keys(cache).length === 0) {
-            const secretsFile = await fs_1.promises.readFile(this.secretsFilePath, {
-                encoding: "utf-8",
-            });
-            cache = (await import("envfile")).parse(secretsFile);
-        }
-    }
-    async get(name) {
-        await this.fillCache();
-        if (cache[name] == null) {
-            const error = new Error("Missing");
-            error.name = "ParameterNotFound";
-            throw error;
-        }
-        return cache[name];
-    }
-    async set(name, value) {
-        await this.fillCache();
-        cache[name] = value;
-        await fs_1.promises.writeFile(this.secretsFilePath, (await import("envfile")).stringify(cache));
-    }
-}
-class ParameterStoreSecretsManager {
-    stage;
-    ssmClient;
-    constructor(stage) {
-        this.stage = stage ?? process.env.STAGE;
-        this.ssmClient = new ssm_1.SSM();
-    }
-    async get(name) {
-        if (cache[name] != null) {
-            return cache[name];
-        }
-        const value = await this.ssmClient.getParameter(`/${this.stage}/${name}`, true);
-        cache[name] = value;
-        return value;
-    }
-    async set(name, value) {
-        cache[name] = value;
-        await this.ssmClient.putParameter(`/${this.stage}/${name}`, value, true);
-    }
-}
-class SecretsManager {
-    manager;
-    constructor(stage = String(process.env.STAGE)) {
-        this.manager =
-            stage === "local"
-                ? new LocalSecretsManager()
-                : new ParameterStoreSecretsManager(stage);
-    }
-    get(name) {
-        return this.manager.get(name);
-    }
-    set(name, value) {
-        return this.manager.set(name, value);
-    }
-}
-exports.SecretsManager = SecretsManager;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2VjcmV0c01hbmFnZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvU2VjcmV0c01hbmFnZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsdUNBQW9DO0FBQ3BDLHFEQUFpRDtBQUNqRCx5Q0FBb0M7QUFDcEMsMkJBQW9DO0FBT3BDLElBQUksS0FBSyxHQUEyQixFQUFFLENBQUM7QUFFdkMsTUFBTSxtQkFBbUI7SUFDdkIsZUFBZSxHQUFHLElBQUEsbUJBQU8sRUFBQyxvQkFBUSxFQUFFLFVBQVUsQ0FBQyxDQUFDO0lBRWhELEtBQUssQ0FBQyx1QkFBdUI7UUFDM0IsSUFBSSxDQUFDO1lBQ0gsTUFBTSxhQUFFLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQztRQUN0QyxDQUFDO1FBQUMsT0FBTyxHQUFHLEVBQUUsQ0FBQztZQUNiLE1BQU0sYUFBRSxDQUFDLFNBQVMsQ0FBQyxJQUFJLENBQUMsZUFBZSxFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBQy9DLENBQUM7SUFDSCxDQUFDO0lBRUQsS0FBSyxDQUFDLFNBQVM7UUFDYixNQUFNLElBQUksQ0FBQyx1QkFBdUIsRUFBRSxDQUFDO1FBQ3JDLElBQUksTUFBTSxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQyxNQUFNLEtBQUssQ0FBQyxFQUFFLENBQUM7WUFDcEMsTUFBTSxXQUFXLEdBQUcsTUFBTSxhQUFFLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxlQUFlLEVBQUU7Z0JBQzFELFFBQVEsRUFBRSxPQUFPO2FBQ2xCLENBQUMsQ0FBQztZQUNILEtBQUssR0FBRyxDQUFDLE1BQU0sTUFBTSxDQUFDLFNBQVMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLFdBQVcsQ0FBQyxDQUFDO1FBQ3ZELENBQUM7SUFDSCxDQUFDO0lBRUQsS0FBSyxDQUFDLEdBQUcsQ0FBQyxJQUFZO1FBQ3BCLE1BQU0sSUFBSSxDQUFDLFNBQVMsRUFBRSxDQUFDO1FBQ3ZCLElBQUksS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDO1lBQ3hCLE1BQU0sS0FBSyxHQUFHLElBQUksS0FBSyxDQUFDLFNBQVMsQ0FBQyxDQUFDO1lBQ25DLEtBQUssQ0FBQyxJQUFJLEdBQUcsbUJBQW1CLENBQUM7WUFDakMsTUFBTSxLQUFLLENBQUM7UUFDZCxDQUFDO1FBQ0QsT0FBTyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDckIsQ0FBQztJQUVELEtBQUssQ0FBQyxHQUFHLENBQUMsSUFBWSxFQUFFLEtBQWE7UUFDbkMsTUFBTSxJQUFJLENBQUMsU0FBUyxFQUFFLENBQUM7UUFDdkIsS0FBSyxDQUFDLElBQUksQ0FBQyxHQUFHLEtBQUssQ0FBQztRQUNwQixNQUFNLGFBQUUsQ0FBQyxTQUFTLENBQ2hCLElBQUksQ0FBQyxlQUFlLEVBQ3BCLENBQUMsTUFBTSxNQUFNLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLENBQzNDLENBQUM7SUFDSixDQUFDO0NBQ0Y7QUFFRCxNQUFNLDRCQUE0QjtJQUNoQyxLQUFLLENBQVM7SUFDZCxTQUFTLENBQU07SUFFZixZQUFZLEtBQWM7UUFDeEIsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLElBQUssT0FBTyxDQUFDLEdBQUcsQ0FBQyxLQUFnQixDQUFDO1FBQ3BELElBQUksQ0FBQyxTQUFTLEdBQUcsSUFBSSxTQUFHLEVBQUUsQ0FBQztJQUM3QixDQUFDO0lBRUQsS0FBSyxDQUFDLEdBQUcsQ0FBQyxJQUFZO1FBQ3BCLElBQUksS0FBSyxDQUFDLElBQUksQ0FBQyxJQUFJLElBQUksRUFBRSxDQUFDO1lBQ3hCLE9BQU8sS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3JCLENBQUM7UUFFRCxNQUFNLEtBQUssR0FBRyxNQUFNLElBQUksQ0FBQyxTQUFTLENBQUMsWUFBWSxDQUM3QyxJQUFJLElBQUksQ0FBQyxLQUFLLElBQUksSUFBSSxFQUFFLEVBQ3hCLElBQUksQ0FDTCxDQUFDO1FBQ0YsS0FBSyxDQUFDLElBQUksQ0FBQyxHQUFHLEtBQUssQ0FBQztRQUNwQixPQUFPLEtBQUssQ0FBQztJQUNmLENBQUM7SUFFRCxLQUFLLENBQUMsR0FBRyxDQUFDLElBQVksRUFBRSxLQUFhO1FBQ25DLEtBQUssQ0FBQyxJQUFJLENBQUMsR0FBRyxLQUFLLENBQUM7UUFDcEIsTUFBTSxJQUFJLENBQUMsU0FBUyxDQUFDLFlBQVksQ0FBQyxJQUFJLElBQUksQ0FBQyxLQUFLLElBQUksSUFBSSxFQUFFLEVBQUUsS0FBSyxFQUFFLElBQUksQ0FBQyxDQUFDO0lBQzNFLENBQUM7Q0FDRjtBQUVELE1BQWEsY0FBYztJQUN6QixPQUFPLENBQTBCO0lBRWpDLFlBQVksUUFBZ0IsTUFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDO1FBQ25ELElBQUksQ0FBQyxPQUFPO1lBQ1YsS0FBSyxLQUFLLE9BQU87Z0JBQ2YsQ0FBQyxDQUFDLElBQUksbUJBQW1CLEVBQUU7Z0JBQzNCLENBQUMsQ0FBQyxJQUFJLDRCQUE0QixDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ2hELENBQUM7SUFFRCxHQUFHLENBQUMsSUFBWTtRQUNkLE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDaEMsQ0FBQztJQUVELEdBQUcsQ0FBQyxJQUFZLEVBQUUsS0FBYTtRQUM3QixPQUFPLElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxLQUFLLENBQUMsQ0FBQztJQUN2QyxDQUFDO0NBQ0Y7QUFqQkQsd0NBaUJDIn0=

package/dist/src/SecretsService.d.ts

@@ -1,5 +0,0 @@
-import { ServiceDefinition } from "@saws/core";
-import { Command } from "commander";
-export declare class SecretsService extends ServiceDefinition {
-    static getCommands(): Command[];
-}

package/dist/src/SecretsService.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SecretsService = void 0;
-const core_1 = require("@saws/core");
-const SecretsManager_1 = require("./SecretsManager");
-const commander_1 = require("commander");
-class SecretsService extends core_1.ServiceDefinition {
-    static getCommands() {
-        const command = new commander_1.Command("secrets")
-            .option("--stage <string>", "Stage")
-            .option("--set <string>", "Set a secret as value")
-            .option("--get", "Get a secret")
-            .argument("<string>", "The name of the secret")
-            .action(async (name, { stage = 'local', set, get }) => {
-            const secretsManager = new SecretsManager_1.SecretsManager(stage);
-            if (get) {
-                const secret = await secretsManager.get(name);
-                console.log(secret);
-            }
-            else {
-                await secretsManager.set(name, set);
-                console.log("Set secret");
-            }
-        });
-        return [command];
-    }
-}
-exports.SecretsService = SecretsService;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiU2VjcmV0c1NlcnZpY2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvU2VjcmV0c1NlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEscUNBQStDO0FBQy9DLHFEQUFrRDtBQUNsRCx5Q0FBb0M7QUFFcEMsTUFBYSxjQUFlLFNBQVEsd0JBQWlCO0lBQ25ELE1BQU0sQ0FBQyxXQUFXO1FBQ2hCLE1BQU0sT0FBTyxHQUFHLElBQUksbUJBQU8sQ0FBQyxTQUFTLENBQUM7YUFDbkMsTUFBTSxDQUFDLGtCQUFrQixFQUFFLE9BQU8sQ0FBQzthQUNuQyxNQUFNLENBQUMsZ0JBQWdCLEVBQUUsdUJBQXVCLENBQUM7YUFDakQsTUFBTSxDQUFDLE9BQU8sRUFBRSxjQUFjLENBQUM7YUFDL0IsUUFBUSxDQUFDLFVBQVUsRUFBRSx3QkFBd0IsQ0FBQzthQUM5QyxNQUFNLENBQ0wsS0FBSyxFQUNILElBQVksRUFDWixFQUFFLEtBQUssR0FBRyxPQUFPLEVBQUUsR0FBRyxFQUFFLEdBQUcsRUFBZ0QsRUFDM0UsRUFBRTtZQUNGLE1BQU0sY0FBYyxHQUFHLElBQUksK0JBQWMsQ0FBQyxLQUFLLENBQUMsQ0FBQztZQUVqRCxJQUFJLEdBQUcsRUFBRSxDQUFDO2dCQUNSLE1BQU0sTUFBTSxHQUFHLE1BQU0sY0FBYyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsQ0FBQztnQkFDOUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUN0QixDQUFDO2lCQUFNLENBQUM7Z0JBQ04sTUFBTSxjQUFjLENBQUMsR0FBRyxDQUFDLElBQUksRUFBRSxHQUFHLENBQUMsQ0FBQztnQkFDcEMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUMsQ0FBQztZQUM1QixDQUFDO1FBQ0gsQ0FBQyxDQUNGLENBQUM7UUFFSixPQUFPLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDbkIsQ0FBQztDQUNGO0FBMUJELHdDQTBCQyJ9