dotsec 4.0.0-alpha.2 → 4.0.0-alpha.4

package/dist/cli/index.d.ts

@@ -0,0 +1,2 @@
+
+export { }

package/dist/index.d.ts

@@ -0,0 +1,210 @@
+import prompts from 'prompts';
+import Ajv from 'ajv';
+import { Command } from 'commander';
+export { default as Table } from 'cli-table';
+
+type DotsecCliPluginHandler<HandlerArgs extends Record<string, unknown>, HandlerResult, T extends Record<string, unknown> = Record<string, unknown>> = {
+    encryptionEngineName?: string;
+    triggerOptionValue: string;
+    usage?: string;
+    description?: string;
+    summary?: string;
+    options?: {
+        [key in keyof T]: DotsecCliOption;
+    };
+    requiredOptions?: {
+        [key in keyof T]: DotsecCliOption;
+    };
+    handler: (options: HandlerArgs & T) => Promise<HandlerResult>;
+};
+type DotsecCliPluginEncryptHandler<HandlerPluginArgs extends Record<string, unknown> = Record<string, unknown>> = DotsecCliPluginHandler<{
+    plaintext: string;
+}, string, HandlerPluginArgs>;
+type DotsecCliPluginDecryptHandler<HandlerPluginArgs extends Record<string, unknown> = Record<string, unknown>> = DotsecCliPluginHandler<{
+    ciphertext: string;
+}, string, HandlerPluginArgs>;
+type DotsecCliPluginRunHandler<HandlerPluginArgs extends Record<string, unknown> = Record<string, unknown>> = DotsecCliPluginHandler<{
+    ciphertext: string;
+}, string, HandlerPluginArgs>;
+type DotsecCliPluginPushHandler<HandlerPluginArgs extends Record<string, unknown> = Record<string, unknown>> = DotsecCliPluginHandler<{
+    push: Record<string, string>;
+    yes?: boolean;
+}, string, HandlerPluginArgs>;
+type DotsecCliOption = [
+    flags: string,
+    description?: string,
+    defaultValue?: string | boolean | string[]
+] | {
+    flags: string;
+    description?: string;
+    defaultValue?: string | boolean | string[];
+    choices?: string[];
+    fn?: (value: string, previous: unknown) => unknown;
+    regexp?: RegExp;
+    env?: string;
+};
+type DotsecPluginConfig = {
+    name?: string;
+    config?: {
+        [key: string]: unknown;
+    };
+    push?: {
+        [key: string]: unknown;
+    };
+};
+type DotsecPlugins = {
+    plugins: DotsecPluginUserConfigWithNamespace;
+};
+type Meh<T extends DotsecPluginModuleConfig> = T extends DotsecPluginModuleConfig ? T : never;
+type DotsecPluginModuleConfig = {
+    plugin: DotsecPluginUserConfigWithNamespace;
+    api?: Record<string, unknown>;
+    cliHandlersOptions?: {
+        encrypt?: Record<string, unknown>;
+        decrypt?: Record<string, unknown>;
+        run?: Record<string, unknown>;
+        push?: Record<string, unknown>;
+    };
+};
+type DotsecPluginModuleBuilderConfig = {
+    [key: string]: {
+        userConfig: DotsecPluginConfig;
+        api?: Record<string, unknown>;
+        cliHandlersOptions?: {
+            encrypt?: Record<string, unknown>;
+            decrypt?: Record<string, unknown>;
+            run?: Record<string, unknown>;
+            push?: Record<string, unknown>;
+        };
+    };
+};
+type DotsecPluginModule<T extends DotsecPluginModuleConfig = DotsecPluginModuleConfig> = (options: {
+    dotsecConfig: DotsecConfig<{
+        plugins: T["plugin"];
+    }>;
+    ajv: Ajv;
+    configFile: string;
+}) => Promise<{
+    name: keyof T["plugin"] | string;
+    encryptionEngineName?: string;
+    api?: T["api"] extends Record<string, unknown> ? T["api"] : never;
+    addCliCommand?: (options: {
+        program: Command;
+    }) => Promise<void>;
+    cliHandlers?: {
+        encrypt?: DotsecCliPluginEncryptHandler<T["cliHandlersOptions"] extends {
+            encrypt: Record<string, unknown>;
+        } ? T["cliHandlersOptions"]["encrypt"] : Record<string, unknown>>;
+        decrypt?: DotsecCliPluginDecryptHandler<T["cliHandlersOptions"] extends {
+            decrypt: Record<string, unknown>;
+        } ? T["cliHandlersOptions"]["decrypt"] : Record<string, unknown>>;
+        run?: DotsecCliPluginRunHandler<T["cliHandlersOptions"] extends {
+            run: Record<string, unknown>;
+        } ? T["cliHandlersOptions"]["run"] : Record<string, unknown>>;
+        push?: DotsecCliPluginPushHandler<T["cliHandlersOptions"] extends {
+            push: Record<string, unknown>;
+        } ? T["cliHandlersOptions"]["push"] : Record<string, unknown>>;
+    };
+}>;
+type DotsecPluginModuleBuilder<T extends DotsecPluginModuleBuilderConfig = DotsecPluginModuleBuilderConfig> = {
+    [pluginName: string]: {
+        userConfig: T[keyof T]["userConfig"];
+        module: (options: {
+            dotsecConfig: DotsecConfig<{
+                plugins: {
+                    [key in keyof T]: T[keyof T]["userConfig"];
+                };
+            }>;
+            ajv: Ajv;
+            configFile: string;
+        }) => Promise<{
+            name: keyof T["userConfig"] | string;
+            encryptionEngineName?: string;
+            api?: T["api"] extends Record<string, unknown> ? T["api"] : never;
+            addCliCommand?: (options: {
+                program: Command;
+            }) => Promise<void>;
+            cliHandlers?: {
+                encrypt?: DotsecCliPluginEncryptHandler<T["cliHandlersOptions"] extends {
+                    encrypt: Record<string, unknown>;
+                } ? T["cliHandlersOptions"]["encrypt"] : Record<string, unknown>>;
+                decrypt?: DotsecCliPluginDecryptHandler<T["cliHandlersOptions"] extends {
+                    decrypt: Record<string, unknown>;
+                } ? T["cliHandlersOptions"]["decrypt"] : Record<string, unknown>>;
+                run?: DotsecCliPluginRunHandler<T["cliHandlersOptions"] extends {
+                    run: Record<string, unknown>;
+                } ? T["cliHandlersOptions"]["run"] : Record<string, unknown>>;
+                push?: DotsecCliPluginPushHandler<T["cliHandlersOptions"] extends {
+                    push: Record<string, unknown>;
+                } ? T["cliHandlersOptions"]["push"] : Record<string, unknown>>;
+            };
+        }>;
+    };
+};
+type DotsecPluginUserConfigWithNamespace<T extends {
+    [key: string]: DotsecPluginConfig;
+} = {
+    [key: string]: DotsecPluginConfig;
+}> = T;
+
+type DotsecConfig<T extends DotsecPlugins = DotsecPlugins> = {
+    plugins?: Array<keyof T["plugins"]>;
+    defaults?: {
+        encryptionEngine?: keyof T["plugins"];
+        plugins?: {
+            [PluginKey in keyof T["plugins"]]?: {
+                name?: T["plugins"][PluginKey]["name"];
+            } & T["plugins"][PluginKey]["config"];
+        };
+        options?: {
+            envFile?: string;
+            secFile?: string;
+        };
+    };
+    push?: {
+        [key: string]: {
+            [PluginKey in keyof T["plugins"]]?: T["plugins"][PluginKey]["push"];
+        };
+    };
+};
+
+type DotsecEncryptionEngineFactoryProps = {
+    verbose?: boolean;
+};
+type DotsecEncryptionEngine<T = Record<string, unknown>> = {
+    encrypt(plaintext: string): Promise<string>;
+    decrypt(ciphertext: string): Promise<string>;
+} & T;
+type DotsecEncryptionEngineFactory<T = Record<string, unknown>, V extends Record<string, unknown> = Record<string, unknown>> = {
+    (options: DotsecEncryptionEngineFactoryProps & T): Promise<DotsecEncryptionEngine<V>>;
+};
+
+type FromEnv<T extends string = string> = T | {
+    fromEnv: string;
+    required?: boolean;
+};
+
+declare const promptExecute: ({ skip, message, execute, }: {
+    skip?: boolean | undefined;
+    message: string;
+    execute: () => unknown | Promise<unknown>;
+}) => Promise<void>;
+
+declare const resolveFromEnv: (options: {
+    fromEnvValue?: string;
+    env: NodeJS.ProcessEnv;
+    variables: Record<string, string>;
+}) => string | undefined;
+
+declare const readContentsFromFile: (filePath: string) => Promise<string>;
+declare const writeContentsToFile: (filePath: string, contents: string) => Promise<void>;
+declare const promptOverwriteIfFileExists: ({ filePath, skip, }: {
+    filePath: string;
+    skip?: boolean | undefined;
+}) => Promise<prompts.Answers<"overwrite"> | undefined>;
+
+declare const writeLine: (str: string) => void;
+declare const emphasis: (str: string) => string;
+declare const strong: (str: string) => string;
+
+export { DotsecConfig, DotsecEncryptionEngine, DotsecEncryptionEngineFactory, DotsecEncryptionEngineFactoryProps, DotsecPluginModule, DotsecPluginModuleBuilder, DotsecPluginModuleBuilderConfig, DotsecPluginUserConfigWithNamespace, FromEnv, Meh, emphasis, promptExecute, promptOverwriteIfFileExists, readContentsFromFile, resolveFromEnv, strong, writeContentsToFile, writeLine };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "dotsec",
-    "version": "4.0.0-alpha.2",
+    "version": "4.0.0-alpha.4",
     "description": "",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -62,5 +62,5 @@
         "typescript": "~4.9.3",
         "yargs-parser": "^21.1.1"
     },
-    "gitHead": "f96cd7947eb5b39c8cda32afb350f90360109455"
+    "gitHead": "7424686ad3816cc16d138a3417533f33134d3b87"
 }