@xube/kit-aws 0.0.33 → 0.0.35

package/dist/index.d.ts

@@ -2,3 +2,5 @@ export * from "./resources/dynamodb/get";
 export * from "./resources/dynamodb/put";
 export * from "./resources/dynamodb/schema/item";
 export * from "./resources/dynamodb/schema/keys";
+export * from "./resources/dynamodb/query";
+export * from "./resources/dynamodb/transform";

package/dist/index.js

@@ -18,3 +18,5 @@ __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);
+__exportStar(require("./resources/dynamodb/query"), exports);
+__exportStar(require("./resources/dynamodb/transform"), exports);

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

@@ -0,0 +1,5 @@
+import { TableItem } from "./schema/item";
+import { PartialTableKey } from "./schema/keys";
+import { XubeResponse } from "@xube/kit-request";
+import { XubeLog } from "@xube/kit-log";
+export declare const queryItemsFromTable: (tableName: string, keys: PartialTableKey, indexName: string | undefined, log?: XubeLog) => Promise<XubeResponse<TableItem[]>>;

package/dist/resources/dynamodb/query.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.queryItemsFromTable = void 0;
+const lib_dynamodb_1 = require("@aws-sdk/lib-dynamodb");
+const item_1 = require("./schema/item");
+const keys_1 = require("./schema/keys");
+const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
+const kit_request_1 = require("@xube/kit-request");
+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 queryItemsFromTable = async (tableName, keys, indexName, log = kit_log_1.XubeLog.getInstance()) => {
+    let KeyConditionExpression = "#pk = :pkValue";
+    let ExpressionAttributeNames = {
+        "#pk": keys_1.PARTITION_KEY,
+    };
+    let ExpressionAttributeValues = {
+        ":pkValue": keys[keys_1.PARTITION_KEY],
+    };
+    if (keys[keys_1.SORT_KEY]) {
+        KeyConditionExpression += " AND begins_with(#sk, :skPrefix)";
+        ExpressionAttributeNames["#sk"] = keys_1.SORT_KEY;
+        ExpressionAttributeValues[":skPrefix"] = keys[keys_1.SORT_KEY];
+    }
+    const params = {
+        TableName: tableName,
+        IndexName: indexName,
+        KeyConditionExpression,
+        ExpressionAttributeNames,
+        ExpressionAttributeValues,
+    };
+    try {
+        const response = await ddbDocClient.send(new lib_dynamodb_1.QueryCommand(params));
+        if (!response.Items || !response.Items.length) {
+            return new kit_request_1.XubeResponse({
+                statusCode: 404,
+                error: `No items found.`,
+            });
+        }
+        if (!(0, item_1.areTableItems)(response.Items)) {
+            return new kit_request_1.XubeResponse({
+                statusCode: 500,
+                error: `Items returned from DynamoDB are not valid TableItems.`,
+            });
+        }
+        return new kit_request_1.XubeResponse({
+            statusCode: 200,
+            data: response.Items,
+        });
+    }
+    catch (error) {
+        console.error("Error querying DynamoDB:", error);
+        throw error;
+    }
+};
+exports.queryItemsFromTable = queryItemsFromTable;

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

@@ -1,8 +1,8 @@
 import { z } from "zod";
 export declare const TableItemSchema: z.ZodObject<{
+    id: z.ZodString;
     PK: z.ZodString;
     SK: z.ZodString;
-    id: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     id: string;
     PK: string;
@@ -13,3 +13,13 @@ export declare const TableItemSchema: z.ZodObject<{
     SK: string;
 }>;
 export type TableItem = z.infer<typeof TableItemSchema>;
+export declare const isTableItem: (obj: unknown) => obj is {
+    id: string;
+    PK: string;
+    SK: string;
+};
+export declare const areTableItems: (obj: unknown) => obj is {
+    id: string;
+    PK: string;
+    SK: string;
+}[];

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

@@ -1,11 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TableItemSchema = void 0;
+exports.areTableItems = exports.isTableItem = 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(),
+exports.TableItemSchema = zod_1.z
+    .object({
     [fields_1.ID_FIELD]: zod_1.z.string(),
-});
+})
+    .merge(keys_1.TableKeySchema);
+const isTableItem = (obj) => exports.TableItemSchema.passthrough().safeParse(obj).success;
+exports.isTableItem = isTableItem;
+const areTableItems = (obj) => {
+    return zod_1.z.array(exports.TableItemSchema.passthrough()).safeParse(obj).success;
+};
+exports.areTableItems = areTableItems;

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

@@ -1,2 +1,26 @@
+import { z } from "zod";
 export declare const PARTITION_KEY = "PK";
 export declare const SORT_KEY = "SK";
+export declare const TableKeySchema: z.ZodObject<{
+    PK: z.ZodString;
+    SK: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    PK: string;
+    SK: string;
+}, {
+    PK: string;
+    SK: string;
+}>;
+export type TableKey = z.infer<typeof TableKeySchema>;
+export declare const PartialTableKey: z.ZodObject<{
+    PK: z.ZodString;
+    SK: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    PK: string;
+    SK?: string | undefined;
+}, {
+    PK: string;
+    SK?: string | undefined;
+}>;
+export type PartialTableKey = z.infer<typeof PartialTableKey>;
+export declare const getAggregateKeyFromTableKey: (tableKey: TableKey) => string;

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

@@ -1,5 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SORT_KEY = exports.PARTITION_KEY = void 0;
+exports.getAggregateKeyFromTableKey = exports.PartialTableKey = exports.TableKeySchema = exports.SORT_KEY = exports.PARTITION_KEY = void 0;
+const zod_1 = require("zod");
 exports.PARTITION_KEY = "PK";
 exports.SORT_KEY = "SK";
+exports.TableKeySchema = zod_1.z.object({
+    [exports.PARTITION_KEY]: zod_1.z.string(),
+    [exports.SORT_KEY]: zod_1.z.string(),
+});
+exports.PartialTableKey = zod_1.z.object({
+    [exports.PARTITION_KEY]: zod_1.z.string(),
+    [exports.SORT_KEY]: zod_1.z.string().optional(),
+});
+const getAggregateKeyFromTableKey = (tableKey) => {
+    return `${tableKey[exports.PARTITION_KEY]}##${tableKey[exports.SORT_KEY]}`;
+};
+exports.getAggregateKeyFromTableKey = getAggregateKeyFromTableKey;

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

@@ -0,0 +1 @@
+export declare const unmarshallItem: (item: Record<string, any>) => Record<string, any>;

package/dist/resources/dynamodb/transform.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unmarshallItem = void 0;
+const util_dynamodb_1 = require("@aws-sdk/util-dynamodb");
+const unmarshallItem = (item) => {
+    return (0, util_dynamodb_1.unmarshall)(item);
+};
+exports.unmarshallItem = unmarshallItem;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xube/kit-aws",
-  "version": "0.0.33",
+  "version": "0.0.35",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -18,13 +18,14 @@
   "homepage": "https://github.com/XubeLtd/dev-kit#readme",
   "devDependencies": {
     "@types/aws-lambda": "^8.10.119",
-    "@xube/kit-build": "^0.0.33"
+    "@xube/kit-build": "^0.0.35"
   },
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.427.0",
     "@aws-sdk/lib-dynamodb": "^3.427.0",
-    "@xube/kit-log": "^0.0.33",
-    "@xube/kit-request": "^0.0.33",
+    "@aws-sdk/util-dynamodb": "^3.427.0",
+    "@xube/kit-log": "^0.0.35",
+    "@xube/kit-request": "^0.0.35",
     "zod": "^3.22.4"
   }
 }

package/src/index.ts

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

package/src/resources/dynamodb/query.ts

@@ -0,0 +1,69 @@
+import { DynamoDBDocumentClient, QueryCommand } from "@aws-sdk/lib-dynamodb";
+import { TableItem, areTableItems } from "./schema/item";
+import {
+  PARTITION_KEY,
+  PartialTableKey,
+  SORT_KEY,
+  TableKey,
+} from "./schema/keys";
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { XubeResponse } from "@xube/kit-request";
+import { XubeLog } from "@xube/kit-log";
+
+const ddbClient = new DynamoDBClient({ region: process.env.AWS_REGION });
+const ddbDocClient = DynamoDBDocumentClient.from(ddbClient);
+
+export const queryItemsFromTable = async (
+  tableName: string,
+  keys: PartialTableKey,
+  indexName: string | undefined,
+  log: XubeLog = XubeLog.getInstance()
+): Promise<XubeResponse<TableItem[]>> => {
+  let KeyConditionExpression = "#pk = :pkValue";
+  let ExpressionAttributeNames: { [key: string]: string } = {
+    "#pk": PARTITION_KEY,
+  };
+  let ExpressionAttributeValues: { [key: string]: string } = {
+    ":pkValue": keys[PARTITION_KEY],
+  };
+
+  if (keys[SORT_KEY]) {
+    KeyConditionExpression += " AND begins_with(#sk, :skPrefix)";
+    ExpressionAttributeNames["#sk"] = SORT_KEY;
+    ExpressionAttributeValues[":skPrefix"] = keys[SORT_KEY];
+  }
+
+  const params = {
+    TableName: tableName,
+    IndexName: indexName,
+    KeyConditionExpression,
+    ExpressionAttributeNames,
+    ExpressionAttributeValues,
+  };
+
+  try {
+    const response = await ddbDocClient.send(new QueryCommand(params));
+
+    if (!response.Items || !response.Items.length) {
+      return new XubeResponse({
+        statusCode: 404,
+        error: `No items found.`,
+      });
+    }
+
+    if (!areTableItems(response.Items)) {
+      return new XubeResponse({
+        statusCode: 500,
+        error: `Items returned from DynamoDB are not valid TableItems.`,
+      });
+    }
+
+    return new XubeResponse({
+      statusCode: 200,
+      data: response.Items,
+    });
+  } catch (error) {
+    console.error("Error querying DynamoDB:", error);
+    throw error;
+  }
+};

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

@@ -1,10 +1,16 @@
 import { ID_FIELD } from "./fields";
-import { PARTITION_KEY, SORT_KEY } from "./keys";
+import { PARTITION_KEY, SORT_KEY, TableKeySchema } 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>;
+export const TableItemSchema = z
+  .object({
+    [ID_FIELD]: z.string(),
+  })
+  .merge(TableKeySchema);
+export type TableItem = z.infer<typeof TableItemSchema>;
+export const isTableItem = (obj: unknown): obj is TableItem =>
+  TableItemSchema.passthrough().safeParse(obj).success;
+
+export const areTableItems = (obj: unknown): obj is TableItem[] => {
+  return z.array(TableItemSchema.passthrough()).safeParse(obj).success;
+};

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

@@ -1,2 +1,20 @@
+import { z } from "zod";
+
 export const PARTITION_KEY = "PK";
-export const SORT_KEY = "SK";
+export const SORT_KEY = "SK";
+
+export const TableKeySchema = z.object({
+  [PARTITION_KEY]: z.string(),
+  [SORT_KEY]: z.string(),
+});
+export type TableKey = z.infer<typeof TableKeySchema>;
+
+export const PartialTableKey = z.object({
+  [PARTITION_KEY]: z.string(),
+  [SORT_KEY]: z.string().optional(),
+});
+export type PartialTableKey = z.infer<typeof PartialTableKey>;
+
+export const getAggregateKeyFromTableKey = (tableKey: TableKey) => {
+  return `${tableKey[PARTITION_KEY]}##${tableKey[SORT_KEY]}`;
+};

package/src/resources/dynamodb/transform.ts

@@ -0,0 +1,5 @@
+import { unmarshall } from "@aws-sdk/util-dynamodb";
+
+export const unmarshallItem = (item: Record<string, any>) => {
+  return unmarshall(item);
+}