@xube/kit-aws 0.0.22

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./resources/dynamodb/get";
+export * from "./resources/dynamodb/put";
+export * from "./resources/dynamodb/schema/item";
+export * from "./resources/dynamodb/schema/keys";

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resources/dynamodb/get"), exports);
+__exportStar(require("./resources/dynamodb/put"), exports);
+__exportStar(require("./resources/dynamodb/schema/item"), exports);
+__exportStar(require("./resources/dynamodb/schema/keys"), exports);

package/dist/resources/dynamodb/get.d.ts

@@ -0,0 +1,4 @@
+export declare const getItemFromTable: (tableName: string, key: {
+    PK: string;
+    SK: string;
+}) => Promise<Record<string, any> | undefined>;

package/dist/resources/dynamodb/get.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getItemFromTable = void 0;
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
+const ddbClient = new client_dynamodb_1.DynamoDBClient({
+    region: process.env.AWS_REGION,
+});
+const ddbDocClient = lib_dynamodb_1.DynamoDBDocumentClient.from(ddbClient);
+const getItemFromTable = async (tableName, key) => {
+    const params = {
+        TableName: tableName,
+        Key: key,
+    };
+    const result = await ddbDocClient.send(new lib_dynamodb_1.GetCommand(params));
+    return result.Item;
+};
+exports.getItemFromTable = getItemFromTable;

package/dist/resources/dynamodb/put.d.ts

@@ -0,0 +1,7 @@
+import { XubeResponse } from "@xube/kit-request";
+import { XubeLog } from "@xube/kit-log";
+export declare const putItemInTable: <TItem extends {
+    id: string;
+    PK: string;
+    SK: string;
+}>(table: string, item: TItem, log?: XubeLog) => Promise<XubeResponse<boolean>>;

package/dist/resources/dynamodb/put.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.putItemInTable = void 0;
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
+const kit_request_1 = require("@xube/kit-request");
+const kit_constants_1 = require("@xube/kit-constants");
+const kit_log_1 = require("@xube/kit-log");
+const ddbClient = new client_dynamodb_1.DynamoDBClient({
+    region: process.env.AWS_REGION,
+});
+const ddbDocClient = lib_dynamodb_1.DynamoDBDocumentClient.from(ddbClient);
+const putItemInTable = async (table, item, log = kit_log_1.XubeLog.getInstance()) => {
+    const params = {
+        TableName: table,
+        Item: item,
+    };
+    const putItemCommand = new lib_dynamodb_1.PutCommand(params);
+    try {
+        const result = await ddbDocClient.send(putItemCommand);
+        return new kit_request_1.XubeResponse({
+            statusCode: kit_constants_1.StatusCode.OK,
+            data: true,
+        });
+    }
+    catch (e) {
+        log.error(`Error occurred when adding item to table.\n${JSON.stringify(e, null, 2)}`);
+    }
+    return new kit_request_1.XubeResponse({
+        statusCode: kit_constants_1.StatusCode.InternalError,
+        error: `Error occurred when adding item to table`,
+    });
+};
+exports.putItemInTable = putItemInTable;

package/dist/resources/dynamodb/schema/fields.d.ts

@@ -0,0 +1 @@
+export declare const ID_FIELD = "id";

package/dist/resources/dynamodb/schema/fields.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ID_FIELD = void 0;
+exports.ID_FIELD = "id";

package/dist/resources/dynamodb/schema/item.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+export declare const TableItemSchema: z.ZodObject<{
+    PK: z.ZodString;
+    SK: z.ZodString;
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    PK: string;
+    SK: string;
+}, {
+    id: string;
+    PK: string;
+    SK: string;
+}>;
+export type TableItem = z.infer<typeof TableItemSchema>;

package/dist/resources/dynamodb/schema/item.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TableItemSchema = void 0;
+const fields_1 = require("./fields");
+const keys_1 = require("./keys");
+const zod_1 = require("zod");
+exports.TableItemSchema = zod_1.z.object({
+    [keys_1.PARTITION_KEY]: zod_1.z.string(),
+    [keys_1.SORT_KEY]: zod_1.z.string(),
+    [fields_1.ID_FIELD]: zod_1.z.string(),
+});

package/dist/resources/dynamodb/schema/keys.d.ts

@@ -0,0 +1,2 @@
+export declare const PARTITION_KEY = "PK";
+export declare const SORT_KEY = "SK";

package/dist/resources/dynamodb/schema/keys.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SORT_KEY = exports.PARTITION_KEY = void 0;
+exports.PARTITION_KEY = "PK";
+exports.SORT_KEY = "SK";

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@xube/kit-aws",
+  "version": "0.0.22",
+  "description": "",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/XubeLtd/dev-kit.git"
+  },
+  "author": "Xube Pty Ltd",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/XubeLtd/dev-kit/issues"
+  },
+  "homepage": "https://github.com/XubeLtd/dev-kit#readme",
+  "devDependencies": {
+    "@types/aws-lambda": "^8.10.119",
+    "@xube/kit-build": "^0.0.22"
+  },
+  "dependencies": {
+    "@aws-sdk/client-dynamodb": "^3.427.0",
+    "@aws-sdk/lib-dynamodb": "^3.427.0",
+    "@xube/kit-log": "^0.0.22",
+    "@xube/kit-request": "^0.0.22",
+    "zod": "^3.22.4"
+  }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from "./resources/dynamodb/get"
+export * from "./resources/dynamodb/put"
+export * from "./resources/dynamodb/schema/item"
+export * from "./resources/dynamodb/schema/keys"

package/src/resources/dynamodb/get.ts

@@ -0,0 +1,24 @@
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient, GetCommand } from "@aws-sdk/lib-dynamodb";
+
+const ddbClient = new DynamoDBClient({
+  region: process.env.AWS_REGION,
+});
+
+const ddbDocClient = DynamoDBDocumentClient.from(ddbClient);
+
+export const getItemFromTable = async (
+  tableName: string,
+  key: {
+    PK: string;
+    SK: string;
+  }
+): Promise<Record<string, any> | undefined> => {
+  const params = {
+    TableName: tableName,
+    Key: key,
+  };
+
+  const result = await ddbDocClient.send(new GetCommand(params));
+  return result.Item;
+};

package/src/resources/dynamodb/put.ts

@@ -0,0 +1,47 @@
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import {
+  DynamoDBDocumentClient,
+  PutCommand,
+  PutCommandOutput,
+} from "@aws-sdk/lib-dynamodb";
+import { XubeResponse } from "@xube/kit-request";
+import { TableItem } from "./schema/item";
+import { StatusCode } from "@xube/kit-constants";
+import { XubeLog } from "@xube/kit-log";
+
+const ddbClient = new DynamoDBClient({
+  region: process.env.AWS_REGION,
+});
+
+const ddbDocClient = DynamoDBDocumentClient.from(ddbClient);
+
+export const putItemInTable = async <TItem extends TableItem>(
+  table: string,
+  item: TItem,
+  log: XubeLog = XubeLog.getInstance()
+): Promise<XubeResponse<boolean>> => {
+  const params = {
+    TableName: table,
+    Item: item,
+  };
+
+  const putItemCommand: PutCommand = new PutCommand(params);
+
+  try {
+    const result: PutCommandOutput = await ddbDocClient.send(putItemCommand);
+
+    return new XubeResponse({
+      statusCode: StatusCode.OK,
+      data: true,
+    });
+  } catch (e) {
+    log.error(
+      `Error occurred when adding item to table.\n${JSON.stringify(e, null, 2)}`
+    );
+  }
+
+  return new XubeResponse({
+    statusCode: StatusCode.InternalError,
+    error: `Error occurred when adding item to table`,
+  });
+};

package/src/resources/dynamodb/schema/fields.ts

@@ -0,0 +1 @@
+export const ID_FIELD = "id"

package/src/resources/dynamodb/schema/item.ts

@@ -0,0 +1,10 @@
+import { ID_FIELD } from "./fields";
+import { PARTITION_KEY, SORT_KEY } from "./keys";
+import { z } from "zod";
+
+export const TableItemSchema = z.object({
+  [PARTITION_KEY]: z.string(),
+  [SORT_KEY]: z.string(),
+  [ID_FIELD]: z.string(),
+});
+export type TableItem = z.infer<typeof TableItemSchema>;

package/src/resources/dynamodb/schema/keys.ts

@@ -0,0 +1,2 @@
+export const PARTITION_KEY = "PK";
+export const SORT_KEY = "SK";

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "extends": "../kit-build/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist"
+  },
+  "exclude": ["**/*.test.ts", "**/*.mock.ts", "dist"],
+  "references": [
+    {
+      "path": "../kit-constants"
+    },
+    {
+      "path": "../kit-log"
+    },
+    {
+      "path": "../kit-request"
+    }
+  ]
+}