index.d.ts

// Type definitions for aws-credstash
//
// Forked from node-credtash v2.0.0 types:
// Project: https://github.com/DavidTanner/nodecredstash
// Definitions by: Mike Cook <https://github.com/migstopheles>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node"/>
import * as AWS from "aws-sdk";

interface CredstashConfig {
  table?: string;
  awsOpts?: AWS.KMS.ClientConfiguration;
  dynamoOpts?: AWS.DynamoDB.ClientConfiguration;
  kmsKey?: string;
  kmsOpts?: AWS.KMS.ClientConfiguration;
}

interface CredstashContext {
  [key: string]: string;
}

interface PutSecretOptions {
  name: string;
  secret: string;
  context?: CredstashContext;
  digest?: string;
  version?: number;
}

interface Credstash {
  getHighestVersion: (options: {
    name: string;
  }) => Promise<AWS.DynamoDB.AttributeMap>;
  incrementVersion: (options: { name: string }) => Promise<string>;
  putSecret: (
    options: PutSecretOptions
  ) => Promise<AWS.DynamoDB.DocumentClient.PutItemOutput>;
  decryptStash: (
    stash: { key: string },
    context?: CredstashContext
  ) => Promise<AWS.KMS.DecryptResponse>;
  getAllVersions: (options: {
    name: string;
    context?: CredstashContext;
    limit?: number;
  }) => Promise<Array<{ version: string; secret: string }>>;
  getSecret: (options: {
    name: string;
    context?: CredstashContext;
    version?: number;
  }) => Promise<string>;
  deleteSecrets: (options: {
    name: string;
  }) => Promise<AWS.DynamoDB.DocumentClient.DeleteItemOutput[]>;
  deleteSecret: (options: {
    name: string;
    version: number;
  }) => Promise<AWS.DynamoDB.DocumentClient.DeleteItemOutput>;
  listSecrets: () => Promise<string[]>;
  getAllSecrets: (options: {
    version?: number;
    context?: CredstashContext;
    startsWith?: string;
  }) => Promise<{ [key: string]: string }>;
  createDdbTable: () => Promise<void>;
}

declare function Credstash(config: CredstashConfig): Credstash;

export = Credstash;