@aws-lite/sns-types 0.0.1

package/index.d.ts

@@ -0,0 +1,24 @@
+import {
+  /* ! Do not remove IMPORTS_START / IMPORTS_END ! */
+  // $IMPORTS_START
+  PublishCommandOutput as PublishResponse,
+  // $IMPORTS_END
+} from "@aws-sdk/client-sns";
+
+declare interface AwsLiteSNS {
+  /* ! Do not remove METHODS_START / METHODS_END ! */
+  // $METHODS_START
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/sns/latest/api/API_Publish.html SNS: Publish}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/sns/readme.md#Publish SNS: Publish}
+   */
+  Publish: (input: { Message: string, MessageAttributes?: string, MessageDeduplicationId?: string, MessageGroupId?: string, MessageStructure?: string, PhoneNumber?: string, Subject?: string, TargetArn?: string, TopicArn?: string }) => Promise<PublishResponse>
+  // $METHODS_END
+}
+
+declare module "@aws-lite/client" {
+  interface AwsLiteClient {
+    SNS: AwsLiteSNS;
+  }
+}

package/package.json

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

package/readme.md

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