dyno-table 0.1.8 → 0.2.0-0

package/dist/types.d.cts

@@ -0,0 +1,22 @@
+import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
+
+type DynamoItem = {
+    [key: string]: unknown;
+};
+interface Index {
+    partitionKey: string;
+    sortKey?: string;
+}
+interface IndexConfig {
+    partitionKey: string;
+    sortKey?: string;
+    gsis?: Record<string, Index>;
+}
+interface TableConfig {
+    client: DynamoDBDocument;
+    tableName: string;
+    indexes: IndexConfig;
+}
+type GSINames<T extends TableConfig> = keyof NonNullable<T["indexes"]["gsis"]>;
+
+export type { DynamoItem, GSINames, Index, TableConfig };

package/dist/types.d.ts

@@ -0,0 +1,22 @@
+import { DynamoDBDocument } from '@aws-sdk/lib-dynamodb';
+
+type DynamoItem = {
+    [key: string]: unknown;
+};
+interface Index {
+    partitionKey: string;
+    sortKey?: string;
+}
+interface IndexConfig {
+    partitionKey: string;
+    sortKey?: string;
+    gsis?: Record<string, Index>;
+}
+interface TableConfig {
+    client: DynamoDBDocument;
+    tableName: string;
+    indexes: IndexConfig;
+}
+type GSINames<T extends TableConfig> = keyof NonNullable<T["indexes"]["gsis"]>;
+
+export type { DynamoItem, GSINames, Index, TableConfig };

package/dist/utils/{key-template.cjs → partition-key-template.cjs}

@@ -1,6 +1,6 @@
 'use strict';
 
-// src/utils/key-template.ts
+// src/utils/partition-key-template.ts
 function partitionKey(strings, ...keys) {
   return (params) => {
     let result = strings[0] ?? "";
@@ -15,5 +15,5 @@ function partitionKey(strings, ...keys) {
 }
 
 exports.partitionKey = partitionKey;
-//# sourceMappingURL=key-template.cjs.map
-//# sourceMappingURL=key-template.cjs.map
+//# sourceMappingURL=partition-key-template.cjs.map
+//# sourceMappingURL=partition-key-template.cjs.map

package/dist/utils/partition-key-template.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/partition-key-template.ts"],"names":[],"mappings":";;;AA8BO,SAAS,YAAA,CACd,YACG,IACwC,EAAA;AAC3C,EAAA,OAAO,CAAC,MAAW,KAAA;AACjB,IAAI,IAAA,MAAA,GAAS,OAAQ,CAAA,CAAC,CAAK,IAAA,EAAA;AAE3B,IAAA,KAAA,IAAS,CAAI,GAAA,CAAA,EAAG,CAAI,GAAA,IAAA,CAAK,QAAQ,CAAK,EAAA,EAAA;AACpC,MAAM,MAAA,GAAA,GAAM,KAAK,CAAC,CAAA;AAClB,MAAA,IAAI,GAAK,EAAA;AACP,QAAA,MAAA,IAAU,OAAO,GAAgB,CAAA,IAAK,OAAQ,CAAA,CAAA,GAAI,CAAC,CAAK,IAAA,EAAA,CAAA;AAAA;AAC1D;AAGF,IAAO,OAAA,MAAA;AAAA,GACT;AACF","file":"partition-key-template.cjs","sourcesContent":["export type StrictGenerateType<T extends readonly string[]> = {\n  [K in T[number]]: string;\n};\n\n/**\n * Creates a template function for generating DynamoDB partition keys with dynamic values.\n * Use this function when you need to:\n * - Create consistent partition key patterns with variable parts\n * - Generate partition keys that follow a specific format\n * - Ensure type safety for partition key parameters\n * - Require all parameters to be provided\n *\n * @example\n * ```ts\n * // Define a partition key template\n * const pk = partitionKey`country#${\"country\"}#enclosure#${\"enclosure\"}`;\n *\n * // Generate a partition key (all parameters required)\n * const key = pk({ country: \"NZ\", enclosure: \"A1\" });\n * // Result: \"country#NZ#enclosure#A1\"\n *\n * // Type checking ensures all parameters are provided\n * const invalidKey = pk({ country: \"NZ\" }); // TypeScript error\n * ```\n *\n * @param strings - The static parts of the template string\n * @param keys - The dynamic parts of the template string that will be replaced with values\n *\n * @returns A function that accepts an object with the dynamic values and returns the formatted partition key\n */\nexport function partitionKey<T extends readonly string[]>(\n  strings: TemplateStringsArray,\n  ...keys: T\n): (params: StrictGenerateType<T>) => string {\n  return (params) => {\n    let result = strings[0] ?? \"\";\n\n    for (let i = 0; i < keys.length; i++) {\n      const key = keys[i];\n      if (key) {\n        result += params[key as T[number]] + (strings[i + 1] ?? \"\");\n      }\n    }\n\n    return result;\n  };\n}\n"]}

package/dist/utils/partition-key-template.d.cts

@@ -0,0 +1,32 @@
+type StrictGenerateType<T extends readonly string[]> = {
+    [K in T[number]]: string;
+};
+/**
+ * Creates a template function for generating DynamoDB partition keys with dynamic values.
+ * Use this function when you need to:
+ * - Create consistent partition key patterns with variable parts
+ * - Generate partition keys that follow a specific format
+ * - Ensure type safety for partition key parameters
+ * - Require all parameters to be provided
+ *
+ * @example
+ * ```ts
+ * // Define a partition key template
+ * const pk = partitionKey`country#${"country"}#enclosure#${"enclosure"}`;
+ *
+ * // Generate a partition key (all parameters required)
+ * const key = pk({ country: "NZ", enclosure: "A1" });
+ * // Result: "country#NZ#enclosure#A1"
+ *
+ * // Type checking ensures all parameters are provided
+ * const invalidKey = pk({ country: "NZ" }); // TypeScript error
+ * ```
+ *
+ * @param strings - The static parts of the template string
+ * @param keys - The dynamic parts of the template string that will be replaced with values
+ *
+ * @returns A function that accepts an object with the dynamic values and returns the formatted partition key
+ */
+declare function partitionKey<T extends readonly string[]>(strings: TemplateStringsArray, ...keys: T): (params: StrictGenerateType<T>) => string;
+
+export { type StrictGenerateType, partitionKey };

package/dist/utils/partition-key-template.d.ts

@@ -0,0 +1,32 @@
+type StrictGenerateType<T extends readonly string[]> = {
+    [K in T[number]]: string;
+};
+/**
+ * Creates a template function for generating DynamoDB partition keys with dynamic values.
+ * Use this function when you need to:
+ * - Create consistent partition key patterns with variable parts
+ * - Generate partition keys that follow a specific format
+ * - Ensure type safety for partition key parameters
+ * - Require all parameters to be provided
+ *
+ * @example
+ * ```ts
+ * // Define a partition key template
+ * const pk = partitionKey`country#${"country"}#enclosure#${"enclosure"}`;
+ *
+ * // Generate a partition key (all parameters required)
+ * const key = pk({ country: "NZ", enclosure: "A1" });
+ * // Result: "country#NZ#enclosure#A1"
+ *
+ * // Type checking ensures all parameters are provided
+ * const invalidKey = pk({ country: "NZ" }); // TypeScript error
+ * ```
+ *
+ * @param strings - The static parts of the template string
+ * @param keys - The dynamic parts of the template string that will be replaced with values
+ *
+ * @returns A function that accepts an object with the dynamic values and returns the formatted partition key
+ */
+declare function partitionKey<T extends readonly string[]>(strings: TemplateStringsArray, ...keys: T): (params: StrictGenerateType<T>) => string;
+
+export { type StrictGenerateType, partitionKey };

package/dist/utils/{key-template.js → partition-key-template.js}

@@ -1,4 +1,4 @@
-// src/utils/key-template.ts
+// src/utils/partition-key-template.ts
 function partitionKey(strings, ...keys) {
   return (params) => {
     let result = strings[0] ?? "";
@@ -13,5 +13,5 @@ function partitionKey(strings, ...keys) {
 }
 
 export { partitionKey };
-//# sourceMappingURL=key-template.js.map
-//# sourceMappingURL=key-template.js.map
+//# sourceMappingURL=partition-key-template.js.map
+//# sourceMappingURL=partition-key-template.js.map

package/dist/utils/partition-key-template.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/partition-key-template.ts"],"names":[],"mappings":";AA8BO,SAAS,YAAA,CACd,YACG,IACwC,EAAA;AAC3C,EAAA,OAAO,CAAC,MAAW,KAAA;AACjB,IAAI,IAAA,MAAA,GAAS,OAAQ,CAAA,CAAC,CAAK,IAAA,EAAA;AAE3B,IAAA,KAAA,IAAS,CAAI,GAAA,CAAA,EAAG,CAAI,GAAA,IAAA,CAAK,QAAQ,CAAK,EAAA,EAAA;AACpC,MAAM,MAAA,GAAA,GAAM,KAAK,CAAC,CAAA;AAClB,MAAA,IAAI,GAAK,EAAA;AACP,QAAA,MAAA,IAAU,OAAO,GAAgB,CAAA,IAAK,OAAQ,CAAA,CAAA,GAAI,CAAC,CAAK,IAAA,EAAA,CAAA;AAAA;AAC1D;AAGF,IAAO,OAAA,MAAA;AAAA,GACT;AACF","file":"partition-key-template.js","sourcesContent":["export type StrictGenerateType<T extends readonly string[]> = {\n  [K in T[number]]: string;\n};\n\n/**\n * Creates a template function for generating DynamoDB partition keys with dynamic values.\n * Use this function when you need to:\n * - Create consistent partition key patterns with variable parts\n * - Generate partition keys that follow a specific format\n * - Ensure type safety for partition key parameters\n * - Require all parameters to be provided\n *\n * @example\n * ```ts\n * // Define a partition key template\n * const pk = partitionKey`country#${\"country\"}#enclosure#${\"enclosure\"}`;\n *\n * // Generate a partition key (all parameters required)\n * const key = pk({ country: \"NZ\", enclosure: \"A1\" });\n * // Result: \"country#NZ#enclosure#A1\"\n *\n * // Type checking ensures all parameters are provided\n * const invalidKey = pk({ country: \"NZ\" }); // TypeScript error\n * ```\n *\n * @param strings - The static parts of the template string\n * @param keys - The dynamic parts of the template string that will be replaced with values\n *\n * @returns A function that accepts an object with the dynamic values and returns the formatted partition key\n */\nexport function partitionKey<T extends readonly string[]>(\n  strings: TemplateStringsArray,\n  ...keys: T\n): (params: StrictGenerateType<T>) => string {\n  return (params) => {\n    let result = strings[0] ?? \"\";\n\n    for (let i = 0; i < keys.length; i++) {\n      const key = keys[i];\n      if (key) {\n        result += params[key as T[number]] + (strings[i + 1] ?? \"\");\n      }\n    }\n\n    return result;\n  };\n}\n"]}

package/dist/utils/sort-key-template.d.cts

@@ -0,0 +1,35 @@
+type GenerateType<T extends readonly string[], U extends string = never> = T extends [infer F, ...infer R] ? F extends string ? R extends string[] ? ({
+    [K in F | U]: string | number;
+} & Partial<Record<Exclude<T[number], F | U>, never>>) | GenerateType<R, F | U> : never : never : never;
+/**
+ * Creates a template function for generating DynamoDB sort keys with dynamic values.
+ * Use this function when you need to:
+ * - Create consistent sort key patterns with variable parts
+ * - Generate sort keys that follow a specific format
+ * - Ensure type safety for sort key parameters
+ *
+ * @example
+ * ```ts
+ * // Define a sort key template
+ * const sk = sortKey`country#${"country"}#enclosure#${"enclosure"}#diet#${"diet"}`;
+ *
+ * // Generate a sort key with partial parameters
+ * const templatedString = sk({ country: "NZ", enclosure: "A1" });
+ * // Result: "country#NZ#enclosure#A1#diet#"
+ *
+ * // Generate a complete sort key
+ * const fullKey = sk({ country: "NZ", enclosure: "A1", diet: "carnivore" });
+ * // Result: "country#NZ#enclosure#A1#diet#carnivore"
+ *
+ * // Type checking ensures only valid parameters are used
+ * const invalidKey = sk({ country: "NZ", invalid: "value" }); // TypeScript error
+ * ```
+ *
+ * @param strings - The static parts of the template string
+ * @param keys - The dynamic parts of the template string that will be replaced with values
+ *
+ * @returns A function that accepts an object with the dynamic values and returns the formatted sort key
+ */
+declare function sortKey<T extends readonly string[]>(strings: TemplateStringsArray, ...keys: T): (params: GenerateType<T>) => string;
+
+export { type GenerateType, sortKey };

package/dist/utils/sort-key-template.d.ts

@@ -0,0 +1,35 @@
+type GenerateType<T extends readonly string[], U extends string = never> = T extends [infer F, ...infer R] ? F extends string ? R extends string[] ? ({
+    [K in F | U]: string | number;
+} & Partial<Record<Exclude<T[number], F | U>, never>>) | GenerateType<R, F | U> : never : never : never;
+/**
+ * Creates a template function for generating DynamoDB sort keys with dynamic values.
+ * Use this function when you need to:
+ * - Create consistent sort key patterns with variable parts
+ * - Generate sort keys that follow a specific format
+ * - Ensure type safety for sort key parameters
+ *
+ * @example
+ * ```ts
+ * // Define a sort key template
+ * const sk = sortKey`country#${"country"}#enclosure#${"enclosure"}#diet#${"diet"}`;
+ *
+ * // Generate a sort key with partial parameters
+ * const templatedString = sk({ country: "NZ", enclosure: "A1" });
+ * // Result: "country#NZ#enclosure#A1#diet#"
+ *
+ * // Generate a complete sort key
+ * const fullKey = sk({ country: "NZ", enclosure: "A1", diet: "carnivore" });
+ * // Result: "country#NZ#enclosure#A1#diet#carnivore"
+ *
+ * // Type checking ensures only valid parameters are used
+ * const invalidKey = sk({ country: "NZ", invalid: "value" }); // TypeScript error
+ * ```
+ *
+ * @param strings - The static parts of the template string
+ * @param keys - The dynamic parts of the template string that will be replaced with values
+ *
+ * @returns A function that accepts an object with the dynamic values and returns the formatted sort key
+ */
+declare function sortKey<T extends readonly string[]>(strings: TemplateStringsArray, ...keys: T): (params: GenerateType<T>) => string;
+
+export { type GenerateType, sortKey };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dyno-table",
-  "version": "0.1.8",
+  "version": "0.2.0-0",
   "description": "A TypeScript library to simplify working with DynamoDB",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -11,10 +11,80 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
+    },
+    "./table": {
+      "types": "./dist/table.d.ts",
+      "import": "./dist/table.js",
+      "require": "./dist/table.cjs"
+    },
+    "./entity": {
+      "types": "./dist/entity.d.ts",
+      "import": "./dist/entity.js",
+      "require": "./dist/entity.cjs"
+    },
+    "./conditions": {
+      "types": "./dist/conditions.d.ts",
+      "import": "./dist/conditions.js",
+      "require": "./dist/conditions.cjs"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.js",
+      "require": "./dist/types.cjs"
+    },
+    "./standard-schema": {
+      "types": "./dist/standard-schema.d.ts",
+      "import": "./dist/standard-schema.js",
+      "require": "./dist/standard-schema.cjs"
+    },
+    "./utils/partition-key-template": {
+      "types": "./dist/utils/partition-key-template.d.ts",
+      "import": "./dist/utils/partition-key-template.js",
+      "require": "./dist/utils/partition-key-template.cjs"
+    },
+    "./utils/sort-key-template": {
+      "types": "./dist/utils/sort-key-template.d.ts",
+      "import": "./dist/utils/sort-key-template.js",
+      "require": "./dist/utils/sort-key-template.cjs"
+    },
+    "./builders/query-builder": {
+      "types": "./dist/builders/query-builder.d.ts",
+      "import": "./dist/builders/query-builder.js",
+      "require": "./dist/builders/query-builder.cjs"
+    },
+    "./builders/paginator": {
+      "types": "./dist/builders/paginator.d.ts",
+      "import": "./dist/builders/paginator.js",
+      "require": "./dist/builders/paginator.cjs"
+    },
+    "./builders/put-builder": {
+      "types": "./dist/builders/put-builder.d.ts",
+      "import": "./dist/builders/put-builder.js",
+      "require": "./dist/builders/put-builder.cjs"
+    },
+    "./builders/update-builder": {
+      "types": "./dist/builders/update-builder.d.ts",
+      "import": "./dist/builders/update-builder.js",
+      "require": "./dist/builders/update-builder.cjs"
+    },
+    "./builders/delete-builder": {
+      "types": "./dist/builders/delete-builder.d.ts",
+      "import": "./dist/builders/delete-builder.js",
+      "require": "./dist/builders/delete-builder.cjs"
+    },
+    "./builders/transaction-builder": {
+      "types": "./dist/builders/transaction-builder.d.ts",
+      "import": "./dist/builders/transaction-builder.js",
+      "require": "./dist/builders/transaction-builder.cjs"
+    },
+    "./builders/condition-check-builder": {
+      "types": "./dist/builders/condition-check-builder.d.ts",
+      "import": "./dist/builders/condition-check-builder.js",
+      "require": "./dist/builders/condition-check-builder.cjs"
     }
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "build": "tsup --config tsup.config.ts",
     "clean": "rm -rf dist",
     "test": "vitest run",
     "test:w": "vitest watch",
@@ -26,7 +96,12 @@
     "ddb:start": "docker compose up -d",
     "circular": "npx madge --circular --ts-config ./tsconfig.json --extensions ts,tsx src/"
   },
-  "keywords": ["dynamodb", "aws", "typescript", "database"],
+  "keywords": [
+    "dynamodb",
+    "aws",
+    "typescript",
+    "database"
+  ],
   "author": "Maunder",
   "license": "ISC",
   "repository": {
@@ -36,16 +111,18 @@
   "devDependencies": {
     "@babel/preset-typescript": "^7.26.0",
     "@biomejs/biome": "1.9.4",
-    "@types/node": "^20.0.0",
-    "rimraf": "^5.0.0",
-    "tsup": "^8.0.0",
-    "typescript": "^5.0.0",
-    "vitest": "^2.1.8"
+    "@types/node": "^20.17.11",
+    "rimraf": "^5.0.10",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "vitest": "3.0.5"
   },
   "peerDependencies": {
     "@aws-sdk/client-dynamodb": "^3.0.0",
     "@aws-sdk/lib-dynamodb": "^3.0.0"
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "packageManager": "pnpm@10.5.2"
 }