dyno-table 1.3.1 → 1.5.0

package/dist/utils.cjs

@@ -0,0 +1,34 @@
+'use strict';
+
+// src/utils/partition-key-template.ts
+function partitionKey(strings, ...keys) {
+  return (params) => {
+    let result = strings[0] ?? "";
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      if (key) {
+        result += params[key] + (strings[i + 1] ?? "");
+      }
+    }
+    return result;
+  };
+}
+
+// src/utils/sort-key-template.ts
+function sortKey(strings, ...keys) {
+  return (params) => {
+    let result = strings[0] ?? "";
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      if (key && params && key in params) {
+        result += params[key] + (strings[i + 1] ?? "");
+      }
+    }
+    return result;
+  };
+}
+
+exports.partitionKey = partitionKey;
+exports.sortKey = sortKey;
+//# sourceMappingURL=utils.cjs.map
+//# sourceMappingURL=utils.cjs.map

package/dist/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils/partition-key-template.ts","../src/utils/sort-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;;;ACTO,SAAS,OAAA,CACd,YACG,IACkC,EAAA;AACrC,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;AAElB,MAAI,IAAA,GAAA,IAAO,MAAU,IAAA,GAAA,IAAO,MAAQ,EAAA;AAClC,QAAA,MAAA,IAAU,OAAO,GAAG,CAAA,IAAK,OAAQ,CAAA,CAAA,GAAI,CAAC,CAAK,IAAA,EAAA,CAAA;AAAA;AAC7C;AAGF,IAAO,OAAA,MAAA;AAAA,GACT;AACF","file":"utils.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","export type GenerateType<T extends readonly string[], U extends string = never> = T extends [infer F, ...infer R]\n  ? F extends string\n    ? R extends string[]\n      ? ({ [K in F | U]: string | number } & Partial<Record<Exclude<T[number], F | U>, never>>) | GenerateType<R, F | U>\n      : never\n    : never\n  : never;\n\n/**\n * Creates a template function for generating DynamoDB sort keys with dynamic values.\n * Use this function when you need to:\n * - Create consistent sort key patterns with variable parts\n * - Generate sort keys that follow a specific format\n * - Ensure type safety for sort key parameters\n *\n * @example\n * ```ts\n * // Define a sort key template\n * const sk = sortKey`country#${\"country\"}#enclosure#${\"enclosure\"}#diet#${\"diet\"}`;\n *\n * // Generate a sort key with partial parameters\n * const templatedString = sk({ country: \"NZ\", enclosure: \"A1\" });\n * // Result: \"country#NZ#enclosure#A1#diet#\"\n *\n * // Generate a complete sort key\n * const fullKey = sk({ country: \"NZ\", enclosure: \"A1\", diet: \"carnivore\" });\n * // Result: \"country#NZ#enclosure#A1#diet#carnivore\"\n *\n * // Type checking ensures only valid parameters are used\n * const invalidKey = sk({ country: \"NZ\", invalid: \"value\" }); // 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 sort key\n */\nexport function sortKey<T extends readonly string[]>(\n  strings: TemplateStringsArray,\n  ...keys: T\n): (params: GenerateType<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\n      if (key && params && key in params) {\n        result += params[key] + (strings[i + 1] ?? \"\");\n      }\n    }\n\n    return result;\n  };\n}\n"]}

package/dist/{utils/sort-key-template.d.cts → utils.d.cts}

@@ -1,3 +1,34 @@
+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;
+
 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;
@@ -32,4 +63,4 @@ type GenerateType<T extends readonly string[], U extends string = never> = T ext
  */
 declare function sortKey<T extends readonly string[]>(strings: TemplateStringsArray, ...keys: T): (params: GenerateType<T>) => string;
 
-export { type GenerateType, sortKey };
+export { partitionKey, sortKey };

package/dist/{utils/sort-key-template.d.ts → utils.d.ts}

@@ -1,3 +1,34 @@
+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;
+
 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;
@@ -32,4 +63,4 @@ type GenerateType<T extends readonly string[], U extends string = never> = T ext
  */
 declare function sortKey<T extends readonly string[]>(strings: TemplateStringsArray, ...keys: T): (params: GenerateType<T>) => string;
 
-export { type GenerateType, sortKey };
+export { partitionKey, sortKey };

package/dist/utils.js

@@ -0,0 +1,31 @@
+// src/utils/partition-key-template.ts
+function partitionKey(strings, ...keys) {
+  return (params) => {
+    let result = strings[0] ?? "";
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      if (key) {
+        result += params[key] + (strings[i + 1] ?? "");
+      }
+    }
+    return result;
+  };
+}
+
+// src/utils/sort-key-template.ts
+function sortKey(strings, ...keys) {
+  return (params) => {
+    let result = strings[0] ?? "";
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      if (key && params && key in params) {
+        result += params[key] + (strings[i + 1] ?? "");
+      }
+    }
+    return result;
+  };
+}
+
+export { partitionKey, sortKey };
+//# sourceMappingURL=utils.js.map
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils/partition-key-template.ts","../src/utils/sort-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;;;ACTO,SAAS,OAAA,CACd,YACG,IACkC,EAAA;AACrC,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;AAElB,MAAI,IAAA,GAAA,IAAO,MAAU,IAAA,GAAA,IAAO,MAAQ,EAAA;AAClC,QAAA,MAAA,IAAU,OAAO,GAAG,CAAA,IAAK,OAAQ,CAAA,CAAA,GAAI,CAAC,CAAK,IAAA,EAAA,CAAA;AAAA;AAC7C;AAGF,IAAO,OAAA,MAAA;AAAA,GACT;AACF","file":"utils.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","export type GenerateType<T extends readonly string[], U extends string = never> = T extends [infer F, ...infer R]\n  ? F extends string\n    ? R extends string[]\n      ? ({ [K in F | U]: string | number } & Partial<Record<Exclude<T[number], F | U>, never>>) | GenerateType<R, F | U>\n      : never\n    : never\n  : never;\n\n/**\n * Creates a template function for generating DynamoDB sort keys with dynamic values.\n * Use this function when you need to:\n * - Create consistent sort key patterns with variable parts\n * - Generate sort keys that follow a specific format\n * - Ensure type safety for sort key parameters\n *\n * @example\n * ```ts\n * // Define a sort key template\n * const sk = sortKey`country#${\"country\"}#enclosure#${\"enclosure\"}#diet#${\"diet\"}`;\n *\n * // Generate a sort key with partial parameters\n * const templatedString = sk({ country: \"NZ\", enclosure: \"A1\" });\n * // Result: \"country#NZ#enclosure#A1#diet#\"\n *\n * // Generate a complete sort key\n * const fullKey = sk({ country: \"NZ\", enclosure: \"A1\", diet: \"carnivore\" });\n * // Result: \"country#NZ#enclosure#A1#diet#carnivore\"\n *\n * // Type checking ensures only valid parameters are used\n * const invalidKey = sk({ country: \"NZ\", invalid: \"value\" }); // 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 sort key\n */\nexport function sortKey<T extends readonly string[]>(\n  strings: TemplateStringsArray,\n  ...keys: T\n): (params: GenerateType<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\n      if (key && params && key in params) {\n        result += params[key] + (strings[i + 1] ?? \"\");\n      }\n    }\n\n    return result;\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dyno-table",
-  "version": "1.3.1",
+  "version": "1.5.0",
   "description": "A TypeScript library to simplify working with DynamoDB",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -8,79 +8,144 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     },
     "./table": {
-      "types": "./dist/table.d.ts",
-      "import": "./dist/table.js",
-      "require": "./dist/table.cjs"
+      "import": {
+        "types": "./dist/table.d.ts",
+        "default": "./dist/table.js"
+      },
+      "require": {
+        "types": "./dist/table.d.cts",
+        "default": "./dist/table.cjs"
+      }
     },
     "./entity": {
-      "types": "./dist/entity.d.ts",
-      "import": "./dist/entity.js",
-      "require": "./dist/entity.cjs"
+      "import": {
+        "types": "./dist/entity.d.ts",
+        "default": "./dist/entity.js"
+      },
+      "require": {
+        "types": "./dist/entity.d.cts",
+        "default": "./dist/entity.cjs"
+      }
     },
     "./conditions": {
-      "types": "./dist/conditions.d.ts",
-      "import": "./dist/conditions.js",
-      "require": "./dist/conditions.cjs"
+      "import": {
+        "types": "./dist/conditions.d.ts",
+        "default": "./dist/conditions.js"
+      },
+      "require": {
+        "types": "./dist/conditions.d.cts",
+        "default": "./dist/conditions.cjs"
+      }
     },
     "./types": {
-      "types": "./dist/types.d.ts",
-      "import": "./dist/types.js",
-      "require": "./dist/types.cjs"
+      "import": {
+        "types": "./dist/types.d.ts",
+        "default": "./dist/types.js"
+      },
+      "require": {
+        "types": "./dist/types.d.cts",
+        "default": "./dist/types.cjs"
+      }
     },
     "./standard-schema": {
-      "types": "./dist/standard-schema.d.ts",
-      "import": "./dist/standard-schema.js",
-      "require": "./dist/standard-schema.cjs"
+      "import": {
+        "types": "./dist/standard-schema.d.ts",
+        "default": "./dist/standard-schema.js"
+      },
+      "require": {
+        "types": "./dist/standard-schema.d.cts",
+        "default": "./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"
+    "./utils": {
+      "import": {
+        "types": "./dist/utils.d.ts",
+        "default": "./dist/utils.js"
+      },
+      "require": {
+        "types": "./dist/utils.d.cts",
+        "default": "./dist/utils.cjs"
+      }
     },
     "./builders/query-builder": {
-      "types": "./dist/builders/query-builder.d.ts",
-      "import": "./dist/builders/query-builder.js",
-      "require": "./dist/builders/query-builder.cjs"
+      "import": {
+        "types": "./dist/builders/query-builder.d.ts",
+        "default": "./dist/builders/query-builder.js"
+      },
+      "require": {
+        "types": "./dist/builders/query-builder.d.cts",
+        "default": "./dist/builders/query-builder.cjs"
+      }
     },
     "./builders/paginator": {
-      "types": "./dist/builders/paginator.d.ts",
-      "import": "./dist/builders/paginator.js",
-      "require": "./dist/builders/paginator.cjs"
+      "import": {
+        "types": "./dist/builders/paginator.d.ts",
+        "default": "./dist/builders/paginator.js"
+      },
+      "require": {
+        "types": "./dist/builders/paginator.d.cts",
+        "default": "./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"
+      "import": {
+        "types": "./dist/builders/put-builder.d.ts",
+        "default": "./dist/builders/put-builder.js"
+      },
+      "require": {
+        "types": "./dist/builders/put-builder.d.cts",
+        "default": "./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"
+      "import": {
+        "types": "./dist/builders/update-builder.d.ts",
+        "default": "./dist/builders/update-builder.js"
+      },
+      "require": {
+        "types": "./dist/builders/update-builder.d.cts",
+        "default": "./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"
+      "import": {
+        "types": "./dist/builders/delete-builder.d.ts",
+        "default": "./dist/builders/delete-builder.js"
+      },
+      "require": {
+        "types": "./dist/builders/delete-builder.d.cts",
+        "default": "./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"
+      "import": {
+        "types": "./dist/builders/transaction-builder.d.ts",
+        "default": "./dist/builders/transaction-builder.js"
+      },
+      "require": {
+        "types": "./dist/builders/transaction-builder.d.cts",
+        "default": "./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"
+      "import": {
+        "types": "./dist/builders/condition-check-builder.d.ts",
+        "default": "./dist/builders/condition-check-builder.js"
+      },
+      "require": {
+        "types": "./dist/builders/condition-check-builder.d.cts",
+        "default": "./dist/builders/condition-check-builder.cjs"
+      }
     }
   },
   "scripts": {