@factorearth/recordmiddleware-dataaccesslayer 0.0.1-y.21 → 0.0.1-y.22

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@factorearth/recordmiddleware-dataaccesslayer",
-  "version": "0.0.1-y.21",
+  "version": "0.0.1-y.22",
   "description": "A module for accessing dynamdb efficiently",
   "author": "madtrx <marlin.makori@gmail.com>",
   "homepage": "https://github.com/FactorEarth/RecordMiddleware#readme",
   "license": "ISC",
-  "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/index",
+  "types": "dist/index",
+  "files": [
+    "dist"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/FactorEarth/RecordMiddleware.git"
@@ -29,5 +31,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "009749636b5343aa1c8092435037dc58829b7005"
+  "gitHead": "a259809dbea65ff3fb42b5ead58aa37648c83a02"
 }

package/dist/aws-services.d.ts

@@ -1,2 +0,0 @@
-import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
-export declare const dynamoDbDocClient: DynamoDBDocumentClient;

package/dist/aws-services.js

@@ -1,4 +0,0 @@
-import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
-import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
-const dynamoDbClient = new DynamoDBClient();
-export const dynamoDbDocClient = DynamoDBDocumentClient.from(dynamoDbClient);

package/dist/batchDeleteItems.d.ts

@@ -1,2 +0,0 @@
-import { BatchInput } from "./index.js";
-export declare function batchDeleteItems(items: BatchInput[], tableName: string): Promise<void>;

package/dist/batchDeleteItems.js

@@ -1,29 +0,0 @@
-import { BatchWriteCommand } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-import chunkBatch from "./chunkBatch.js";
-import { MAX_ITEMS_BATCH_OPERATIONS } from "./index.js";
-export async function batchDeleteItems(items, tableName) {
-    const chunks = chunkBatch(items, MAX_ITEMS_BATCH_OPERATIONS);
-    for (const chunk of chunks) {
-        const deleteRequests = chunk.map((id) => {
-            return {
-                DeleteRequest: {
-                    Key: { id }
-                }
-            };
-        });
-        const commandInput = {
-            RequestItems: {
-                [tableName]: deleteRequests
-            }
-        };
-        const command = new BatchWriteCommand(commandInput);
-        try {
-            await dynamoDbDocClient.send(command);
-        }
-        catch (err) {
-            console.error(`ERROR BATCH DELETING FROM TABLE ${tableName}`, err);
-            console.log('IDS', deleteRequests);
-        }
-    }
-}

package/dist/batchGetItems.d.ts

@@ -1,2 +0,0 @@
-import { BatchInput } from "./index.js";
-export declare function batchGetItems(ids: BatchInput[], tableName: string): Promise<Record<string, any>[]>;

package/dist/batchGetItems.js

@@ -1,24 +0,0 @@
-import { BatchGetCommand } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-export async function batchGetItems(ids, tableName) {
-    const commandInput = {
-        RequestItems: {
-            [tableName]: {
-                Keys: ids
-            }
-        }
-    };
-    const command = new BatchGetCommand(commandInput);
-    try {
-        const sendResult = await dynamoDbDocClient.send(command);
-        const items = sendResult.Responses?.[tableName];
-        if (items)
-            return items;
-    }
-    catch (err) {
-        console.error(`ERROR BATCH GETTING ITEMS FROM ${tableName}`);
-        console.error("IDS ", ids);
-        console.error(err);
-    }
-    return [];
-}

package/dist/batchPutItems.d.ts

@@ -1,2 +0,0 @@
-import { BatchInput } from "./index.js";
-export declare function batchPutItems(items: BatchInput[], tableName: string): Promise<void>;

package/dist/batchPutItems.js

@@ -1,29 +0,0 @@
-import { BatchWriteCommand } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-import chunkBatch from "./chunkBatch.js";
-import { MAX_ITEMS_BATCH_OPERATIONS } from "./index.js";
-export async function batchPutItems(items, tableName) {
-    const chunks = chunkBatch(items, MAX_ITEMS_BATCH_OPERATIONS);
-    for (const chunk of chunks) {
-        const putRequests = chunk.map((Item) => {
-            return {
-                PutRequest: {
-                    Item
-                }
-            };
-        });
-        const commandInput = {
-            RequestItems: {
-                [tableName]: putRequests
-            }
-        };
-        const command = new BatchWriteCommand(commandInput);
-        try {
-            await dynamoDbDocClient.send(command);
-        }
-        catch (err) {
-            console.error(`ERROR BATCH PUTTING DOCUMENTS  IN ${tableName}`, err);
-            console.error(`DOCUMENTS `, putRequests);
-        }
-    }
-}

package/dist/chunkBatch.d.ts

@@ -1,7 +0,0 @@
-/**
- * Given an array of items, this module chunks them out into smaller arrays of {@link itemMax} length
- * @param array An array of items that we want to divide into a subset of arrays
- * @param itemMax The maximum number of items that can be in each array
- * @returns An array of item arrays
- */
-export default function chunkBatch<T>(array: T[], itemMax: number): T[][];

package/dist/chunkBatch.js

@@ -1,25 +0,0 @@
-/**
- * Given an array of items, this module chunks them out into smaller arrays of {@link itemMax} length
- * @param array An array of items that we want to divide into a subset of arrays
- * @param itemMax The maximum number of items that can be in each array
- * @returns An array of item arrays
- */
-export default function chunkBatch(array, itemMax) {
-    const final = [];
-    let chunk = [];
-    for (let i = 0; i < array.length; i++) {
-        const element = array[i];
-        if (i !== 0 && (i % itemMax === 0)) {
-            // Its the beginning of the next one
-            final.push(chunk);
-            chunk = [element];
-        }
-        else {
-            chunk.push(element);
-        }
-    }
-    if (chunk.length > 0) {
-        final.push(chunk);
-    }
-    return final;
-}

package/dist/deleteItem.d.ts

@@ -1 +0,0 @@
-export declare function deleteItem(id: string, tableName: string): Promise<void>;

package/dist/deleteItem.js

@@ -1,18 +0,0 @@
-import { DeleteCommand } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-export async function deleteItem(id, tableName) {
-    const commandInput = {
-        TableName: tableName,
-        Key: {
-            id
-        }
-    };
-    const command = new DeleteCommand(commandInput);
-    try {
-        await dynamoDbDocClient.send(command);
-    }
-    catch (err) {
-        console.error(`ERROR DELETING DOCUMENT ${id} in ${tableName}`);
-        console.error(err);
-    }
-}

package/dist/getItem.d.ts

@@ -1,2 +0,0 @@
-export declare const getItem: (id: string, tableName: string) => Promise<Record<string, any> | null | undefined>;
-export declare const getItemsByIndex: (indexName: string, tableName: string, attributeValue: string, attribute: string, columns?: string[]) => Promise<Record<string, any>[]>;

package/dist/getItem.js

@@ -1,42 +0,0 @@
-import { dynamoDbDocClient } from "./aws-services.js";
-import { GetCommand, QueryCommand } from "@aws-sdk/lib-dynamodb";
-import { _columnsAndAttributeToReturn } from "./utils.js";
-export const getItem = async (id, tableName) => {
-    const params = {
-        TableName: tableName,
-        Key: {
-            id
-        }
-    };
-    try {
-        const data = await dynamoDbDocClient.send(new GetCommand(params));
-        return data.Item;
-    }
-    catch (err) {
-        console.error("Error", err);
-        return null;
-    }
-};
-export const getItemsByIndex = async (indexName, tableName, attributeValue, attribute, columns) => {
-    const { expressionAttributeNames, columnsToReturn } = _columnsAndAttributeToReturn({ attribute, columns });
-    const params = {
-        TableName: tableName,
-        IndexName: indexName,
-        KeyConditionExpression: `#fk = :fkval`,
-        ExpressionAttributeNames: expressionAttributeNames,
-        ExpressionAttributeValues: {
-            ":fkval": attributeValue
-        }
-    };
-    if (columnsToReturn) {
-        params.ProjectionExpression = columnsToReturn;
-    }
-    try {
-        const data = await dynamoDbDocClient.send(new QueryCommand(params));
-        return data.Items || [];
-    }
-    catch (err) {
-        console.error("Error", err);
-        return [];
-    }
-};

package/dist/index.d.ts

@@ -1,14 +0,0 @@
-export * from "./aws-services.js";
-export * from "./batchDeleteItems.js";
-export * from "./batchGetItems.js";
-export * from "./batchPutItems.js";
-export * from "./chunkBatch.js";
-export * from "./deleteItem.js";
-export * from "./getItem.js";
-export * from "./putItem.js";
-export * from "./updateItem.js";
-export * from "./utils.js";
-export declare const MAX_ITEMS_BATCH_OPERATIONS = 25;
-export interface BatchInput {
-    id: string;
-}

package/dist/index.js

@@ -1,11 +0,0 @@
-export * from "./aws-services.js";
-export * from "./batchDeleteItems.js";
-export * from "./batchGetItems.js";
-export * from "./batchPutItems.js";
-export * from "./chunkBatch.js";
-export * from "./deleteItem.js";
-export * from "./getItem.js";
-export * from "./putItem.js";
-export * from "./updateItem.js";
-export * from "./utils.js";
-export const MAX_ITEMS_BATCH_OPERATIONS = 25;

package/dist/putItem.d.ts

@@ -1 +0,0 @@
-export declare function putItem(item: Record<string, any>, tableName: string): Promise<void>;

package/dist/putItem.js

@@ -1,17 +0,0 @@
-import { PutCommand } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-export async function putItem(item, tableName) {
-    const commandInput = {
-        Item: item,
-        TableName: tableName
-    };
-    const command = new PutCommand(commandInput);
-    try {
-        await dynamoDbDocClient.send(command);
-    }
-    catch (err) {
-        console.error(`ERROR PUTTING ITEM IN ${tableName}`);
-        console.error("ITEM: ", item);
-        console.error(err);
-    }
-}

package/dist/updateItem.d.ts

@@ -1 +0,0 @@
-export declare function updateItem(item: Record<string, any>, tableName: string): Promise<void>;

package/dist/updateItem.js

@@ -1,17 +0,0 @@
-import { UpdateCommand } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-export async function updateItem(item, tableName) {
-    const commandInput = {
-        TableName: tableName,
-        Key: item
-    };
-    const command = new UpdateCommand(commandInput);
-    try {
-        await dynamoDbDocClient.send(command);
-    }
-    catch (err) {
-        console.error(`ERROR UPDATING ITEM IN TABLE ${tableName}`);
-        console.error(`ITEM: `, item);
-        console.error(err);
-    }
-}

package/dist/utils.d.ts

@@ -1,9 +0,0 @@
-export declare const _columnsAndAttributeToReturn: ({ attribute, columns, }: {
-    attribute: string;
-    columns?: string[];
-}) => {
-    expressionAttributeNames: {
-        [key: string]: string;
-    };
-    columnsToReturn: string | undefined;
-};

package/dist/utils.js

@@ -1,13 +0,0 @@
-export const _columnsAndAttributeToReturn = ({ attribute, columns, }) => {
-    const expressionAttributeNames = {
-        "#fk": `${attribute}`,
-    };
-    const columnsToReturn = columns
-        ?.map((col, index) => {
-        const placeholder = `#col${index}`;
-        expressionAttributeNames[placeholder] = col;
-        return placeholder;
-    })
-        .join(", ");
-    return { expressionAttributeNames, columnsToReturn };
-};

package/lib/aws-services.ts

@@ -1,5 +0,0 @@
-import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
-import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
-
-const dynamoDbClient = new DynamoDBClient();
-export const dynamoDbDocClient = DynamoDBDocumentClient.from(dynamoDbClient);

package/lib/batchDeleteItems.ts

@@ -1,29 +0,0 @@
-import { BatchWriteCommand, BatchWriteCommandInput } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-import chunkBatch from "./chunkBatch.js";
-import { BatchInput, MAX_ITEMS_BATCH_OPERATIONS } from "./index.js";
-
-export async function batchDeleteItems(items: BatchInput[], tableName: string) {
-	const chunks = chunkBatch(items, MAX_ITEMS_BATCH_OPERATIONS);
-	for (const chunk of chunks) {
-		const deleteRequests = chunk.map((id) => {
-			return {
-				DeleteRequest: {
-					Key: { id }
-				}
-			};
-		});
-		const commandInput: BatchWriteCommandInput = {
-			RequestItems: {
-				[tableName]: deleteRequests
-			}
-		};
-		const command: BatchWriteCommand = new BatchWriteCommand(commandInput);
-		try {
-			await dynamoDbDocClient.send(command);
-		} catch (err) {
-			console.error(`ERROR BATCH DELETING FROM TABLE ${tableName}`, err);
-			console.log('IDS', deleteRequests);
-		}
-	}
-}

package/lib/batchGetItems.ts

@@ -1,24 +0,0 @@
-import { BatchGetCommand, BatchGetCommandInput } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-import { BatchInput } from "./index.js";
-
-export async function batchGetItems(ids: BatchInput[], tableName: string) {
-	const commandInput: BatchGetCommandInput = {
-		RequestItems: {
-			[tableName]: {
-				Keys: ids
-			}
-		}
-	};
-	const command: BatchGetCommand = new BatchGetCommand(commandInput);
-	try {
-		const sendResult = await dynamoDbDocClient.send(command);
-		const items = sendResult.Responses?.[tableName];
-		if (items) return items;
-	} catch (err) {
-		console.error(`ERROR BATCH GETTING ITEMS FROM ${tableName}`);
-		console.error("IDS ", ids);
-		console.error(err);
-	}
-	return [];
-}

package/lib/batchPutItems.ts

@@ -1,29 +0,0 @@
-import { BatchWriteCommand, BatchWriteCommandInput } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-import chunkBatch from "./chunkBatch.js";
-import { BatchInput, MAX_ITEMS_BATCH_OPERATIONS } from "./index.js";
-
-export async function batchPutItems(items: BatchInput[], tableName: string) {
-	const chunks = chunkBatch(items, MAX_ITEMS_BATCH_OPERATIONS);
-	for (const chunk of chunks) {
-		const putRequests = chunk.map((Item) => {
-			return {
-				PutRequest: {
-					Item
-				}
-			};
-		});
-		const commandInput: BatchWriteCommandInput = {
-			RequestItems: {
-				[tableName]: putRequests
-			}
-		};
-		const command: BatchWriteCommand = new BatchWriteCommand(commandInput);
-		try {
-			await dynamoDbDocClient.send(command);
-		} catch (err) {
-			console.error(`ERROR BATCH PUTTING DOCUMENTS  IN ${tableName}`, err);
-			console.error(`DOCUMENTS `, putRequests);
-		}
-	}
-}

package/lib/chunkBatch.ts

@@ -1,27 +0,0 @@
-/**
- * Given an array of items, this module chunks them out into smaller arrays of {@link itemMax} length
- * @param array An array of items that we want to divide into a subset of arrays
- * @param itemMax The maximum number of items that can be in each array
- * @returns An array of item arrays
- */
-export default function chunkBatch<T>(array: T[], itemMax: number): T[][] {
-	const final: T[][] = [];
-	let chunk: T[] = [];
-	for (let i = 0; i < array.length; i++) {
-		const element = array[i];
-		if (i !== 0 && (i % itemMax === 0)) {
-			// Its the beginning of the next one
-			final.push(chunk);
-			chunk = [element];
-
-		} else {
-			chunk.push(element);
-		}
-	}
-
-	if (chunk.length > 0) {
-		final.push(chunk);
-	}
-
-	return final;
-}

package/lib/deleteItem.ts

@@ -1,18 +0,0 @@
-import { DeleteCommand, DeleteCommandInput } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-
-export async function deleteItem(id: string, tableName: string) {
-	const commandInput: DeleteCommandInput = {
-		TableName: tableName,
-		Key: {
-			id
-		}
-	};
-	const command: DeleteCommand = new DeleteCommand(commandInput);
-	try {
-		await dynamoDbDocClient.send(command);
-	} catch (err) {
-		console.error(`ERROR DELETING DOCUMENT ${id} in ${tableName}`);
-		console.error(err);
-	}
-}

package/lib/getItem.ts

@@ -1,45 +0,0 @@
-import { dynamoDbDocClient } from "./aws-services.js";
-import { GetCommand, GetCommandInput, QueryCommand, QueryCommandInput } from "@aws-sdk/lib-dynamodb";
-import { _columnsAndAttributeToReturn } from "./utils.js";
-
-export const getItem = async (id: string, tableName: string ) => {
-	const params: GetCommandInput = {
-		TableName: tableName,
-		Key: {
-			id
-		}
-	};
-	try {
-		const data = await dynamoDbDocClient.send(new GetCommand(params));
-		return data.Item;
-	} catch (err) {
-		console.error("Error", err);
-		return null;
-	}
-}
-
-export const getItemsByIndex = async (indexName: string, tableName: string, attributeValue:string, attribute: string, columns?: string[]) => {
-	const { expressionAttributeNames, columnsToReturn } = _columnsAndAttributeToReturn({attribute, columns});
- 
-	const params: QueryCommandInput = {
-		TableName: tableName,
-		IndexName: indexName,
-		KeyConditionExpression: `#fk = :fkval`,
-		ExpressionAttributeNames: expressionAttributeNames,
-		ExpressionAttributeValues: {
-			":fkval": attributeValue
-		}
-	};
-
-	if (columnsToReturn) {
-		params.ProjectionExpression = columnsToReturn;
-	}
-
-	try {
-		const data = await dynamoDbDocClient.send(new QueryCommand(params));
-		return data.Items || [];
-	} catch (err) {
-		console.error("Error", err);
-		return [];
-	}
-}

package/lib/index.ts

@@ -1,16 +0,0 @@
-export * from "./aws-services.js";
-export * from "./batchDeleteItems.js";
-export * from "./batchGetItems.js";
-export * from "./batchPutItems.js";
-export * from "./chunkBatch.js";
-export * from "./deleteItem.js";
-export * from "./getItem.js";
-export * from "./putItem.js";
-export * from "./updateItem.js";
-export * from "./utils.js";
-
-export const MAX_ITEMS_BATCH_OPERATIONS = 25;
-
-export interface BatchInput {
-	id: string;
-}

package/lib/putItem.ts

@@ -1,17 +0,0 @@
-import { PutCommand, PutCommandInput } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-
-export async function putItem(item: Record<string, any>, tableName: string) {
-	const commandInput: PutCommandInput = {
-		Item: item,
-		TableName: tableName
-	};
-	const command: PutCommand = new PutCommand(commandInput);
-	try {
-		await dynamoDbDocClient.send(command);
-	} catch (err) {
-		console.error(`ERROR PUTTING ITEM IN ${tableName}`);
-		console.error("ITEM: ", item);
-		console.error(err);
-	}
-}

package/lib/updateItem.ts

@@ -1,17 +0,0 @@
-import { UpdateCommand, UpdateCommandInput } from "@aws-sdk/lib-dynamodb";
-import { dynamoDbDocClient } from "./aws-services.js";
-
-export async function updateItem(item: Record<string, any>, tableName: string) {
-	const commandInput: UpdateCommandInput = {
-		TableName: tableName,
-		Key: item
-	};
-	const command: UpdateCommand = new UpdateCommand(commandInput);
-	try {
-		await dynamoDbDocClient.send(command);
-	} catch (err) {
-		console.error(`ERROR UPDATING ITEM IN TABLE ${tableName}`);
-		console.error(`ITEM: `, item);
-		console.error(err);
-	}
-}

package/lib/utils.ts

@@ -1,21 +0,0 @@
-export const _columnsAndAttributeToReturn = ({
-	attribute,
-	columns,
-}: {
-	attribute: string;
-	columns?: string[];
-}) => {
-	const expressionAttributeNames: { [key: string]: string } = {
-		"#fk": `${attribute}`,
-	};
-
-	const columnsToReturn = columns
-		?.map((col, index) => {
-			const placeholder = `#col${index}`;
-			expressionAttributeNames[placeholder] = col;
-			return placeholder;
-		})
-		.join(", ");
-
-	return { expressionAttributeNames, columnsToReturn };
-};

package/tsconfig.json

@@ -1,33 +0,0 @@
-{
-	"compilerOptions": {
-		"baseUrl": "lib",
-		"rootDir": "lib",
-		"outDir": "dist",
-		"target": "ESNext",
-		"types": [
-			"node"
-		],
-		"lib": [
-			"ESNext",
-			"DOM",
-			"DOM.Iterable"
-		],
-		"module": "ESNext",
-		"moduleResolution": "node",
-		"skipLibCheck": true,
-		"strict": true,
-		"esModuleInterop": true,
-		"forceConsistentCasingInFileNames": true,
-		"declaration": true,
-		"allowJs": true, 
-		"resolveJsonModule": true,
-	},
-	"include": [
-		"lib/**/*.d.ts",
-		"lib/**/*.ts",
-		"lib/**/*.tsx"
-	],
-	"exclude": [
-		"./**/*.test.tsx"
-	],
-}