@aws-lite/iam-types 0.0.0

package/index.d.ts

@@ -0,0 +1,56 @@
+import {
+  /* ! Do not remove IMPORTS_START / IMPORTS_END ! */
+  // $IMPORTS_START
+  CreateRoleCommandOutput as CreateRoleResponse,
+  DeleteRoleCommandOutput as DeleteRoleResponse,
+  GetRoleCommandOutput as GetRoleResponse,
+  UpdateRoleCommandOutput as UpdateRoleResponse,
+  // $IMPORTS_END
+} from "@aws-sdk/client-iam";
+
+declare interface AwsLiteIAM {
+  /* ! Do not remove METHODS_START / METHODS_END ! */
+  // $METHODS_START
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html IAM: CreateRole}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/iam/readme.md#CreateRole IAM: CreateRole}
+   */
+  CreateRole: (input: { AssumeRolePolicyDocument: string | Record<string, any>, RoleName: string, Description?: string, MaxSessionDuration?: number, Path?: string, PermissionsBoundary?: string, Tags?: any[] }) => Promise<CreateRoleResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/IAM/latest/APIReference/API_DeleteRole.html IAM: DeleteRole}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/iam/readme.md#DeleteRole IAM: DeleteRole}
+   */
+  DeleteRole: (input: { RoleName: string }) => Promise<DeleteRoleResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetRole.html IAM: GetRole}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/iam/readme.md#GetRole IAM: GetRole}
+   */
+  GetRole: (input: { RoleName: string }) => Promise<GetRoleResponse>
+  /**
+   * @description
+   * - AWS docs: {@link https://docs.aws.amazon.com/IAM/latest/APIReference/API_UpdateRole.html IAM: UpdateRole}
+   * - aws-lite docs: {@link https://github.com/architect/aws-lite/blob/main/plugins/iam/readme.md#UpdateRole IAM: UpdateRole}
+   */
+  UpdateRole: (input: { RoleName: string, Description?: string, MaxSessionDuration?: number }) => Promise<UpdateRoleResponse>
+  // $METHODS_END
+}
+
+declare module "@aws-lite/client" {
+  interface AwsLiteClient {
+    IAM: AwsLiteIAM;
+  }
+}
+
+export type {
+  AwsLiteIAM,
+  /* ! Do not remove EXPORT_START / EXPORT_END ! */
+  // $EXPORT_START
+  CreateRoleResponse,
+  DeleteRoleResponse,
+  GetRoleResponse,
+  UpdateRoleResponse,
+  // $EXPORT_END
+}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@aws-lite/iam-types",
+  "version": "0.0.0",
+  "description": "Type definitions for the `@aws-lite/iam` plugin",
+  "homepage": "https://aws-lite.org/services/iam",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/architect/aws-lite.git",
+    "directory": "plugins/iam/types"
+  },
+  "bugs": "https://github.com/architect/aws-lite/issues",
+  "main": "",
+  "engines": {
+    "node": ">=16"
+  },
+  "author": "@architect",
+  "license": "Apache-2.0",
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts"
+  ],
+  "dependencies": {
+    "@aws-sdk/client-iam": "3"
+  },
+  "scripts": {}
+}

package/readme.md

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