dotsec 2.0.0-alpha.1 → 4.0.0-alpha.0

package/dist/index.d.ts

@@ -1,148 +0,0 @@
-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;
-    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[];
-    fn?: (value: string, previous: unknown) => unknown;
-    regexp?: RegExp;
-    env?: string;
-};
-type DotsecPluginConfig = {
-    module?: string;
-    config?: {
-        [key: string]: unknown;
-    };
-    push?: {
-        [key: string]: unknown;
-    };
-};
-type DotsecPlugins = {
-    plugins: DotsecPlugin;
-};
-type Meh<T extends DotsecPluginModuleConfig> = T extends DotsecPluginModuleConfig ? T : never;
-type DotsecPluginModuleConfig = {
-    plugin: DotsecPlugin;
-    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;
-    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 DotsecPlugin<T extends {
-    [key: string]: DotsecPluginConfig;
-} = {
-    [key: string]: DotsecPluginConfig;
-}> = T;
-
-type DotsecConfig<T extends DotsecPlugins = DotsecPlugins> = {
-    defaults?: {
-        encryptionEngine?: keyof T["plugins"] | string;
-        plugins?: {
-            [PluginKey in keyof T["plugins"]]?: {
-                module?: T["plugins"][PluginKey]["module"];
-            } & 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 writeLine: (str: string) => void;
-declare const emphasis: (str: string) => string;
-declare const strong: (str: string) => string;
-
-export { DotsecConfig, DotsecEncryptionEngine, DotsecEncryptionEngineFactory, DotsecEncryptionEngineFactoryProps, DotsecPlugin, DotsecPluginModule, FromEnv, Meh, emphasis, promptExecute, resolveFromEnv, strong, writeLine };