dinah 0.1.3 → 0.3.0

package/README.md

@@ -203,26 +203,30 @@ await userRepo.trxWrite(
 );
 ```
 
-### Lifecycle Hooks
+### Default Values
 
-Tables support `beforePut` and `beforeUpdate` hooks for setting defaults like timestamps:
+To attach defaults like timestamps to every write, subclass `AbstractRepo` and override `defaultPutData` and/or `defaultUpdateData`:
 
 ```typescript
-const UserTable = new Table(schema, {
-  name: "users",
-  partitionKey: "userId",
-  beforePut: (item) => ({
-    createdAt: Date.now(),
-    ...item,
-    updatedAt: Date.now(),
-  }),
-  beforeUpdate: (update) => ({
-    ...update,
-    updatedAt: Date.now(),
-  }),
-});
+import { AbstractRepo } from "dinah";
+
+class UserRepo extends AbstractRepo<typeof UserTable> {
+  readonly table = UserTable;
+
+  override get defaultPutData() {
+    return { createdAt: Date.now() };
+  }
+
+  override get defaultUpdateData() {
+    return { updatedAt: Date.now() };
+  }
+}
+
+const userRepo = new UserRepo(db);
 ```
 
+`defaultPutData` is merged under every `put` / `create` / `batchWrite` put / `trxPut` / `trxCreate`. `defaultUpdateData` is merged under every `update` / `trxUpdate`. Caller-provided values always win on conflict.
+
 ## License
 
 [MIT](LICENSE)

package/dist/cdk.cjs

@@ -0,0 +1,33 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_util = require("./util-zAG7brd9.cjs");
+let aws_cdk_lib_aws_dynamodb = require("aws-cdk-lib/aws-dynamodb");
+aws_cdk_lib_aws_dynamodb = require_util.__toESM(aws_cdk_lib_aws_dynamodb);
+//#region src/cdk.ts
+const resolveAttrs = (schema, attrNames) => {
+	const names = attrNames.filter((name) => name !== void 0);
+	if (!names.length) return void 0;
+	return names.map((name) => ({
+		name,
+		type: require_util.resolveAttrType(schema, name) === "S" ? aws_cdk_lib_aws_dynamodb.AttributeType.STRING : aws_cdk_lib_aws_dynamodb.AttributeType.NUMBER
+	}));
+};
+const extractTableCdkConfig = (table) => {
+	const { schema, def } = table;
+	const globalSecondaryIndexes = def.gsis ? Object.entries(def.gsis).map(([indexName, gsi]) => ({
+		indexName,
+		partitionKeys: resolveAttrs(schema, [gsi.partitionKey].flat()),
+		sortKeys: resolveAttrs(schema, [gsi.sortKey].flat())
+	})) : void 0;
+	return {
+		tableName: def.name,
+		partitionKey: resolveAttrs(schema, [def.partitionKey])?.at(0),
+		sortKey: resolveAttrs(schema, [def.sortKey])?.at(0),
+		timeToLiveAttribute: def.ttlAttribute,
+		globalSecondaryIndexes
+	};
+};
+//#endregion
+exports.extractTableCdkConfig = extractTableCdkConfig;
+exports.resolveAttrs = resolveAttrs;
+
+//# sourceMappingURL=cdk.cjs.map

package/dist/cdk.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cdk.cjs","names":["resolveAttrType","cdk"],"sources":["../src/cdk.ts"],"sourcesContent":["import type { Table } from \"./table\";\nimport * as cdk from \"aws-cdk-lib/aws-dynamodb\";\nimport { resolveAttrType } from \"./util\";\nimport type { TSchema } from \"typebox\";\n\nexport const resolveAttrs = (\n  schema: TSchema,\n  attrNames: (string | undefined)[],\n): cdk.Attribute[] | undefined => {\n  const names = attrNames.filter((name) => name !== undefined);\n  if (!names.length) return undefined;\n  return names.map((name) => ({\n    name,\n    type:\n      resolveAttrType(schema, name) === \"S\" ? cdk.AttributeType.STRING : cdk.AttributeType.NUMBER,\n  }));\n};\n\nexport const extractTableCdkConfig = (\n  table: Table,\n): Pick<\n  cdk.TablePropsV2,\n  \"tableName\" | \"partitionKey\" | \"sortKey\" | \"timeToLiveAttribute\" | \"globalSecondaryIndexes\"\n> => {\n  const { schema, def } = table;\n\n  const globalSecondaryIndexes = def.gsis\n    ? Object.entries(def.gsis).map(([indexName, gsi]) => ({\n        indexName,\n        partitionKeys: resolveAttrs(schema, [gsi.partitionKey].flat()),\n        sortKeys: resolveAttrs(schema, [gsi.sortKey].flat()),\n      }))\n    : undefined;\n\n  return {\n    tableName: def.name,\n    partitionKey: resolveAttrs(schema, [def.partitionKey])?.at(0)!,\n    sortKey: resolveAttrs(schema, [def.sortKey])?.at(0),\n    timeToLiveAttribute: def.ttlAttribute,\n    //billing: def.billingMode as cdk.BillingMode,\n    // stream: def.stream as cdk.StreamViewType,\n    globalSecondaryIndexes,\n  };\n};\n"],"mappings":";;;;;AAKA,MAAa,gBACX,QACA,cACgC;CAChC,MAAM,QAAQ,UAAU,QAAQ,SAAS,SAAS,KAAA,EAAU;AAC5D,KAAI,CAAC,MAAM,OAAQ,QAAO,KAAA;AAC1B,QAAO,MAAM,KAAK,UAAU;EAC1B;EACA,MACEA,aAAAA,gBAAgB,QAAQ,KAAK,KAAK,MAAMC,yBAAI,cAAc,SAASA,yBAAI,cAAc;EACxF,EAAE;;AAGL,MAAa,yBACX,UAIG;CACH,MAAM,EAAE,QAAQ,QAAQ;CAExB,MAAM,yBAAyB,IAAI,OAC/B,OAAO,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,WAAW,UAAU;EAClD;EACA,eAAe,aAAa,QAAQ,CAAC,IAAI,aAAa,CAAC,MAAM,CAAC;EAC9D,UAAU,aAAa,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC;EACrD,EAAE,GACH,KAAA;AAEJ,QAAO;EACL,WAAW,IAAI;EACf,cAAc,aAAa,QAAQ,CAAC,IAAI,aAAa,CAAC,EAAE,GAAG,EAAE;EAC7D,SAAS,aAAa,QAAQ,CAAC,IAAI,QAAQ,CAAC,EAAE,GAAG,EAAE;EACnD,qBAAqB,IAAI;EAGzB;EACD"}

package/dist/cdk.d.cts

@@ -0,0 +1,10 @@
+import { t as Table } from "./table-DBf8kWHl.cjs";
+import { TSchema } from "typebox";
+import * as cdk from "aws-cdk-lib/aws-dynamodb";
+
+//#region src/cdk.d.ts
+declare const resolveAttrs: (schema: TSchema, attrNames: (string | undefined)[]) => cdk.Attribute[] | undefined;
+declare const extractTableCdkConfig: (table: Table) => Pick<cdk.TablePropsV2, "tableName" | "partitionKey" | "sortKey" | "timeToLiveAttribute" | "globalSecondaryIndexes">;
+//#endregion
+export { extractTableCdkConfig, resolveAttrs };
+//# sourceMappingURL=cdk.d.cts.map

package/dist/cdk.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cdk.d.cts","names":[],"sources":["../src/cdk.ts"],"mappings":";;;;;cAKa,YAAA,GAAY,MAAA,EACf,OAAA,EAAO,SAAA,6BAEd,GAAA,CAAI,SAAA;AAAA,cAUM,qBAAA,GAAqB,KAAA,EACzB,KAAA,KACN,IAAA,CACD,GAAA,CAAI,YAAA"}

package/dist/cdk.d.mts

@@ -0,0 +1,10 @@
+import { t as Table } from "./table-DqJt-sXI.mjs";
+import { TSchema } from "typebox";
+import * as cdk from "aws-cdk-lib/aws-dynamodb";
+
+//#region src/cdk.d.ts
+declare const resolveAttrs: (schema: TSchema, attrNames: (string | undefined)[]) => cdk.Attribute[] | undefined;
+declare const extractTableCdkConfig: (table: Table) => Pick<cdk.TablePropsV2, "tableName" | "partitionKey" | "sortKey" | "timeToLiveAttribute" | "globalSecondaryIndexes">;
+//#endregion
+export { extractTableCdkConfig, resolveAttrs };
+//# sourceMappingURL=cdk.d.mts.map

package/dist/cdk.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cdk.d.mts","names":[],"sources":["../src/cdk.ts"],"mappings":";;;;;cAKa,YAAA,GAAY,MAAA,EACf,OAAA,EAAO,SAAA,6BAEd,GAAA,CAAI,SAAA;AAAA,cAUM,qBAAA,GAAqB,KAAA,EACzB,KAAA,KACN,IAAA,CACD,GAAA,CAAI,YAAA"}

package/dist/cdk.mjs

@@ -0,0 +1,30 @@
+import { i as resolveAttrType } from "./util-DDOj_NRD.mjs";
+import * as cdk from "aws-cdk-lib/aws-dynamodb";
+//#region src/cdk.ts
+const resolveAttrs = (schema, attrNames) => {
+	const names = attrNames.filter((name) => name !== void 0);
+	if (!names.length) return void 0;
+	return names.map((name) => ({
+		name,
+		type: resolveAttrType(schema, name) === "S" ? cdk.AttributeType.STRING : cdk.AttributeType.NUMBER
+	}));
+};
+const extractTableCdkConfig = (table) => {
+	const { schema, def } = table;
+	const globalSecondaryIndexes = def.gsis ? Object.entries(def.gsis).map(([indexName, gsi]) => ({
+		indexName,
+		partitionKeys: resolveAttrs(schema, [gsi.partitionKey].flat()),
+		sortKeys: resolveAttrs(schema, [gsi.sortKey].flat())
+	})) : void 0;
+	return {
+		tableName: def.name,
+		partitionKey: resolveAttrs(schema, [def.partitionKey])?.at(0),
+		sortKey: resolveAttrs(schema, [def.sortKey])?.at(0),
+		timeToLiveAttribute: def.ttlAttribute,
+		globalSecondaryIndexes
+	};
+};
+//#endregion
+export { extractTableCdkConfig, resolveAttrs };
+
+//# sourceMappingURL=cdk.mjs.map

package/dist/cdk.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cdk.mjs","names":[],"sources":["../src/cdk.ts"],"sourcesContent":["import type { Table } from \"./table\";\nimport * as cdk from \"aws-cdk-lib/aws-dynamodb\";\nimport { resolveAttrType } from \"./util\";\nimport type { TSchema } from \"typebox\";\n\nexport const resolveAttrs = (\n  schema: TSchema,\n  attrNames: (string | undefined)[],\n): cdk.Attribute[] | undefined => {\n  const names = attrNames.filter((name) => name !== undefined);\n  if (!names.length) return undefined;\n  return names.map((name) => ({\n    name,\n    type:\n      resolveAttrType(schema, name) === \"S\" ? cdk.AttributeType.STRING : cdk.AttributeType.NUMBER,\n  }));\n};\n\nexport const extractTableCdkConfig = (\n  table: Table,\n): Pick<\n  cdk.TablePropsV2,\n  \"tableName\" | \"partitionKey\" | \"sortKey\" | \"timeToLiveAttribute\" | \"globalSecondaryIndexes\"\n> => {\n  const { schema, def } = table;\n\n  const globalSecondaryIndexes = def.gsis\n    ? Object.entries(def.gsis).map(([indexName, gsi]) => ({\n        indexName,\n        partitionKeys: resolveAttrs(schema, [gsi.partitionKey].flat()),\n        sortKeys: resolveAttrs(schema, [gsi.sortKey].flat()),\n      }))\n    : undefined;\n\n  return {\n    tableName: def.name,\n    partitionKey: resolveAttrs(schema, [def.partitionKey])?.at(0)!,\n    sortKey: resolveAttrs(schema, [def.sortKey])?.at(0),\n    timeToLiveAttribute: def.ttlAttribute,\n    //billing: def.billingMode as cdk.BillingMode,\n    // stream: def.stream as cdk.StreamViewType,\n    globalSecondaryIndexes,\n  };\n};\n"],"mappings":";;;AAKA,MAAa,gBACX,QACA,cACgC;CAChC,MAAM,QAAQ,UAAU,QAAQ,SAAS,SAAS,KAAA,EAAU;AAC5D,KAAI,CAAC,MAAM,OAAQ,QAAO,KAAA;AAC1B,QAAO,MAAM,KAAK,UAAU;EAC1B;EACA,MACE,gBAAgB,QAAQ,KAAK,KAAK,MAAM,IAAI,cAAc,SAAS,IAAI,cAAc;EACxF,EAAE;;AAGL,MAAa,yBACX,UAIG;CACH,MAAM,EAAE,QAAQ,QAAQ;CAExB,MAAM,yBAAyB,IAAI,OAC/B,OAAO,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,WAAW,UAAU;EAClD;EACA,eAAe,aAAa,QAAQ,CAAC,IAAI,aAAa,CAAC,MAAM,CAAC;EAC9D,UAAU,aAAa,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC;EACrD,EAAE,GACH,KAAA;AAEJ,QAAO;EACL,WAAW,IAAI;EACf,cAAc,aAAa,QAAQ,CAAC,IAAI,aAAa,CAAC,EAAE,GAAG,EAAE;EAC7D,SAAS,aAAa,QAAQ,CAAC,IAAI,QAAQ,CAAC,EAAE,GAAG,EAAE;EACnD,qBAAqB,IAAI;EAGzB;EACD"}