dyno-table 0.1.6 → 0.1.8

package/dist/utils/sort-key-template.cjs

@@ -0,0 +1,19 @@
+'use strict';
+
+// 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.sortKey = sortKey;
+//# sourceMappingURL=sort-key-template.cjs.map
+//# sourceMappingURL=sort-key-template.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/sort-key-template.ts"],"names":[],"mappings":";;;AAqCO,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":"sort-key-template.cjs","sourcesContent":["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.js

@@ -0,0 +1,17 @@
+// 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 { sortKey };
+//# sourceMappingURL=sort-key-template.js.map
+//# sourceMappingURL=sort-key-template.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/sort-key-template.ts"],"names":[],"mappings":";AAqCO,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":"sort-key-template.js","sourcesContent":["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,25 +1,30 @@
 {
   "name": "dyno-table",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "A TypeScript library to simplify working with DynamoDB",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "type": "module",
   "exports": {
     ".": {
-      "import": "./dist/index.d.ts",
-      "require": "./dist/index.js"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm --dts",
+    "build": "tsup src/index.ts --format esm,cjs --dts",
     "clean": "rm -rf dist",
     "test": "vitest run",
     "test:w": "vitest watch",
     "test:int": "vitest --config vitest.integration.ts",
+    "local:setup": "npx tsx -e 'import(\"./tests/setup-test-table.ts\").then(m => m.createTestTable())'",
+    "local:teardown": "npx tsx -e 'import(\"./tests/setup-test-table.ts\").then(m => m.deleteTestTable())'",
     "lint": "biome lint",
     "check-types": "tsc --noEmit",
-    "ddb:start": "docker compose up -d dynamodb"
+    "ddb:start": "docker compose up -d",
+    "circular": "npx madge --circular --ts-config ./tsconfig.json --extensions ts,tsx src/"
   },
   "keywords": ["dynamodb", "aws", "typescript", "database"],
   "author": "Maunder",