@aws-lite/rds-data-types 0.0.2

package/index.d.ts

@@ -0,0 +1,55 @@
+import {
+  /* ! Do not remove IMPORTS_START / IMPORTS_END ! */
+  // $IMPORTS_START
+  BatchExecuteStatementCommandOutput as BatchExecuteStatementResponse,
+  BeginTransactionCommandOutput as BeginTransactionResponse,
+  CommitTransactionCommandOutput as CommitTransactionResponse,
+  ExecuteStatementCommandOutput as ExecuteStatementResponse,
+  RollbackTransactionCommandOutput as RollbackTransactionResponse,
+  ExecuteSqlCommandOutput as ExecuteSqlResponse,
+  // $IMPORTS_END
+} from "@aws-sdk/client-rds-data";
+
+declare interface AwsLiteRDSData {
+  /* ! Do not remove METHODS_START / METHODS_END ! */
+  // $METHODS_START
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/rdsdataservice/latest/APIReference/API_BatchExecuteStatement.html RDS Data Service: BatchExecuteStatement}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/rds-data/readme.md#BatchExecuteStatement RDS Data Service: BatchExecuteStatement}
+   */
+  BatchExecuteStatement: (input: { database?: string, parameterSets?: any[], resourceArn: string, schema?: string, secretArn: string, sql: string, transactionId?: string }) => Promise<BatchExecuteStatementResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/rdsdataservice/latest/APIReference/API_BeginTransaction.html RDS Data Service: BeginTransaction}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/rds-data/readme.md#BeginTransaction RDS Data Service: BeginTransaction}
+   */
+  BeginTransaction: (input: { database?: string, resourceArn: string, schema?: string, secretArn: string }) => Promise<BeginTransactionResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/rdsdataservice/latest/APIReference/API_CommitTransaction.html RDS Data Service: CommitTransaction}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/rds-data/readme.md#CommitTransaction RDS Data Service: CommitTransaction}
+   */
+  CommitTransaction: (input: { resourceArn: string, secretArn: string, transactionId: string }) => Promise<CommitTransactionResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/rdsdataservice/latest/APIReference/API_ExecuteStatement.html RDS Data Service: ExecuteStatement}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/rds-data/readme.md#ExecuteStatement RDS Data Service: ExecuteStatement}
+   */
+  ExecuteStatement: (input: { continueAfterTimeout?: boolean, database?: string, formatRecordsAs?: string, includeResultMetadata?: boolean, parameters?: any[], resourceArn: string, resultSetOptions?: Record<string, any>, schema?: string, secretArn: string, sql: string, transactionId?: string }) => Promise<ExecuteStatementResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/rdsdataservice/latest/APIReference/API_RollbackTransaction.html RDS Data Service: RollbackTransaction}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/rds-data/readme.md#RollbackTransaction RDS Data Service: RollbackTransaction}
+   */
+  RollbackTransaction: (input: { resourceArn: string, secretArn: string, transactionId: string }) => Promise<RollbackTransactionResponse>
+  /** @description aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/rds-data/readme.md#ExecuteSql RDS Data Service: ExecuteSql} */
+  ExecuteSql: () => Promise<ExecuteSqlResponse>
+  // $METHODS_END
+}
+
+declare module "@aws-lite/client" {
+  interface AwsLiteClient {
+    RDSData: AwsLiteRDSData;
+  }
+}

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@aws-lite/rds-data-types",
+  "description": "Type definitions for the @aws-lite/rds-data plugin",
+  "version": "0.0.2",
+  "main": "",
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts"
+  ],
+  "dependencies": {
+    "@aws-sdk/client-rds-data": "3"
+  }
+}

package/readme.md

@@ -0,0 +1,46 @@
+## Install
+
+Add to `devDependencies` in `package.json`:
+
+```
+npm i -D @aws-lite/rds-data-types
+```
+
+<small>Be sure you also have `@aws-lite/rds-data` installed.</small>
+
+## Usage and Config
+
+### Javascript VSCode Intellisense
+
+In a Javascript project, the ambient types will be automatically loaded.
+
+### TypeScript `tsconfig`
+
+#### Add this package to `compilerOptions.types`
+
+Example:
+
+```json
+{
+  "extends": "@tsconfig/node-lts/tsconfig.json",
+  "compilerOptions": {
+    "types": [
+      "@aws-lite/rds-data-types"
+    ]
+  }
+}
+```
+
+#### Or use reference types
+
+Either in individual files or in an `index.d.ts` file.
+
+```ts
+/// <reference types="@aws-lite/rds-data-types" />
+```
+
+ymmv
+
+```ts
+/// <reference path="./node_modules/@aws-lite/rds-data-types/index.d.ts" />
+```