@aws-lite/apigatewaymanagementapi-types 0.0.2

package/index.d.ts

@@ -0,0 +1,38 @@
+import {
+  /* ! Do not remove IMPORTS_START / IMPORTS_END ! */
+  // $IMPORTS_START
+  PostToConnectionCommandOutput as PostToConnectionResponse,
+  DeleteConnectionCommandOutput as DeleteConnectionResponse,
+  GetConnectionCommandOutput as GetConnectionResponse,
+  // $IMPORTS_END
+} from "@aws-sdk/client-apigatewaymanagementapi";
+
+declare interface AwsLiteApiGatewayManagementApi {
+  /* ! Do not remove METHODS_START / METHODS_END ! */
+  // $METHODS_START
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html API Gateway WebSocket Management API: PostToConnection}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/apigatewaymanagementapi/readme.md#PostToConnection API Gateway WebSocket Management API: PostToConnection}
+   */
+  PostToConnection: (input: { ApiUrl?: string, ApiId?: string, Stage?: string, ConnectionId: string, Data?: string,object }) => Promise<PostToConnectionResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html API Gateway WebSocket Management API: DeleteConnection}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/apigatewaymanagementapi/readme.md#DeleteConnection API Gateway WebSocket Management API: DeleteConnection}
+   */
+  DeleteConnection: (input: { ApiUrl?: string, ApiId?: string, Stage?: string, ConnectionId: string }) => Promise<DeleteConnectionResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html API Gateway WebSocket Management API: GetConnection}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/apigatewaymanagementapi/readme.md#GetConnection API Gateway WebSocket Management API: GetConnection}
+   */
+  GetConnection: (input: { ApiUrl?: string, ApiId?: string, Stage?: string, ConnectionId: string }) => Promise<GetConnectionResponse>
+  // $METHODS_END
+}
+
+declare module "@aws-lite/client" {
+  interface AwsLiteClient {
+    ApiGatewayManagementApi: AwsLiteApiGatewayManagementApi;
+  }
+}

package/package.json

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

package/readme.md

@@ -0,0 +1,46 @@
+## Install
+
+Add to `devDependencies` in `package.json`:
+
+```
+npm i -D @aws-lite/apigatewaymanagementapi-types
+```
+
+<small>Be sure you also have `@aws-lite/apigatewaymanagementapi` 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/apigatewaymanagementapi-types"
+    ]
+  }
+}
+```
+
+#### Or use reference types
+
+Either in individual files or in an `index.d.ts` file.
+
+```ts
+/// <reference types="@aws-lite/apigatewaymanagementapi-types" />
+```
+
+ymmv
+
+```ts
+/// <reference path="./node_modules/@aws-lite/apigatewaymanagementapi-types/index.d.ts" />
+```