@ftschopp/dynatable-core 1.0.0 → 1.2.0

package/dist/entity/middleware/factories.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCleanKeysMiddleware = createCleanKeysMiddleware;
+const model_utils_1 = require("../../utils/model-utils");
+/**
+ * Creates middleware configuration for cleaning internal keys
+ */
+function createCleanKeysMiddleware(shouldClean) {
+    if (!shouldClean) {
+        return {};
+    }
+    return {
+        after: (result) => (0, model_utils_1.stripInternalKeys)(result),
+    };
+}

package/dist/entity/middleware/types.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Middleware hooks for builder execution
+ */
+export type ExecutionMiddleware<T = any> = {
+    before?: () => void | Promise<void>;
+    after?: (result: T) => T | Promise<T>;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/entity/middleware/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/entity/middleware/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,GAAG,GAAG,IAAI;IACzC,MAAM,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACvC,CAAC"}

package/dist/entity/middleware/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/entity/middleware/with-middleware.d.ts

@@ -0,0 +1,8 @@
+import { ExecutionMiddleware } from './types';
+/**
+ * Applies middleware hooks to a builder's execute method
+ */
+export declare function withMiddleware<B extends {
+    execute: () => Promise<any>;
+}>(builder: B, middleware: ExecutionMiddleware): B;
+//# sourceMappingURL=with-middleware.d.ts.map

package/dist/entity/middleware/with-middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"with-middleware.d.ts","sourceRoot":"","sources":["../../../src/entity/middleware/with-middleware.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C;;GAEG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS;IAAE,OAAO,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,CAAA;CAAE,EACtE,OAAO,EAAE,CAAC,EACV,UAAU,EAAE,mBAAmB,GAC9B,CAAC,CA2BH"}

package/dist/entity/middleware/with-middleware.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withMiddleware = withMiddleware;
+/**
+ * Applies middleware hooks to a builder's execute method
+ */
+function withMiddleware(builder, middleware) {
+    const { before, after } = middleware;
+    // If no middleware hooks provided, return builder as-is
+    if (!before && !after) {
+        return builder;
+    }
+    return {
+        ...builder,
+        execute: async () => {
+            // Before execution hook
+            if (before) {
+                await before();
+            }
+            // Execute original builder
+            const result = await builder.execute();
+            // After execution hook
+            if (after) {
+                return await after(result);
+            }
+            return result;
+        },
+    };
+}

package/dist/{entity.d.ts → entity/types.d.ts}

@@ -1,18 +1,17 @@
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
-import { InferInput, InferKeyInput, InferModel, ModelDefinition } from './core/types';
-import { GetBuilder, PutBuilder, QueryBuilder, UpdateBuilder, DeleteBuilder, ScanBuilder, BatchGetBuilder, BatchWriteBuilder } from './builders';
-import { DynamoDBLogger } from './utils/dynamodb-logger';
+import { DynamoDBLogger } from '../utils/dynamodb-logger';
+import { GetBuilder, PutBuilder, QueryBuilder, UpdateBuilder, DeleteBuilder, ScanBuilder, BatchGetBuilder, BatchWriteBuilder } from '../builders';
 /**
  * Options for creating the Entity API
  */
 export type EntityAPIOptions = {
     logger?: DynamoDBLogger;
     timestamps?: boolean;
+    cleanInternalKeys?: boolean;
 };
 /**
  * Entity API interface for a model
  */
-export type EntityAPI<Model, Input, KeyInput, ModelDef extends ModelDefinition = any> = {
+export type EntityAPI<Model, Input, KeyInput> = {
     /**
      * Retrieves an item by its key.
      * @param key - Partial or full key object to identify the item
@@ -29,7 +28,7 @@ export type EntityAPI<Model, Input, KeyInput, ModelDef extends ModelDefinition =
      * Queries items using key conditions.
      * @returns QueryBuilder for building and executing the query
      */
-    query: () => QueryBuilder<Model, ModelDef>;
+    query: () => QueryBuilder<Model>;
     /**
      * Scans the entire table or index without key conditions.
      * @returns ScanBuilder for building and executing the scan
@@ -60,14 +59,4 @@ export type EntityAPI<Model, Input, KeyInput, ModelDef extends ModelDefinition =
      */
     batchWrite: (items: Input[]) => BatchWriteBuilder;
 };
-/**
- * Creates an entity API instance with validation, key resolution, and builder creation.
- *
- * @param modelName - The name of the model/entity
- * @param model - The model definition
- * @param client - DynamoDB client instance
- * @param options - Optional configuration (logger, timestamps)
- * @returns EntityAPI with get and put methods
- */
-export declare const createEntityAPI: <Model extends ModelDefinition>(tableName: string, modelName: string, model: Model, client: DynamoDBClient, options?: EntityAPIOptions) => EntityAPI<InferModel<Model>, InferInput<Model>, InferKeyInput<Model>, Model>;
-//# sourceMappingURL=entity.d.ts.map
+//# sourceMappingURL=types.d.ts.map

package/dist/entity/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/entity/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,UAAU,EACV,UAAU,EACV,YAAY,EACZ,aAAa,EACb,aAAa,EACb,WAAW,EACX,eAAe,EACf,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,IAAI;IAC9C;;;;OAIG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,QAAQ,KAAK,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAEpD;;;;OAIG;IACH,GAAG,EAAE,CAAC,IAAI,EAAE,KAAK,KAAK,UAAU,CAAC,KAAK,CAAC,CAAC;IAExC;;;OAGG;IACH,KAAK,EAAE,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC;IAEjC;;;OAGG;IACH,IAAI,EAAE,MAAM,WAAW,CAAC,KAAK,CAAC,CAAC;IAE/B;;;;OAIG;IACH,MAAM,EAAE,CAAC,GAAG,EAAE,QAAQ,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC;IAEhD;;;;OAIG;IACH,MAAM,EAAE,CAAC,GAAG,EAAE,QAAQ,KAAK,aAAa,CAAC,KAAK,CAAC,CAAC;IAEhD;;;;OAIG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,eAAe,CAAC,KAAK,CAAC,CAAC;IAEvD;;;;OAIG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,iBAAiB,CAAC;CACnD,CAAC"}

package/dist/entity/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/entity/validation/key-validation.d.ts

@@ -0,0 +1,7 @@
+import { ModelDefinition } from '../../core/types';
+/**
+ * Validates that all required key fields are present in the key object
+ * @throws Error if any required key fields are missing
+ */
+export declare function validateKeyFields(modelName: string, model: ModelDefinition, key: Record<string, unknown>, operation?: string): void;
+//# sourceMappingURL=key-validation.d.ts.map

package/dist/entity/validation/key-validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"key-validation.d.ts","sourceRoot":"","sources":["../../../src/entity/validation/key-validation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG/C;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,eAAe,EACtB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5B,SAAS,CAAC,EAAE,MAAM,GACjB,IAAI,CAmBN"}

package/dist/entity/validation/key-validation.js

@@ -0,0 +1,25 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateKeyFields = validateKeyFields;
+const model_utils_1 = require("../../utils/model-utils");
+/**
+ * Validates that all required key fields are present in the key object
+ * @throws Error if any required key fields are missing
+ */
+function validateKeyFields(modelName, model, key, operation) {
+    // Extract required fields from key templates
+    const requiredFields = new Set();
+    if (model.key) {
+        for (const keyDef of Object.values(model.key)) {
+            (0, model_utils_1.extractTemplateVars)(keyDef.value).forEach((field) => requiredFields.add(field));
+        }
+    }
+    // Check if all required fields are present
+    const missingFields = Array.from(requiredFields).filter((field) => key[field] === undefined);
+    if (missingFields.length > 0) {
+        const operationSuffix = operation ? ` for ${operation}` : '';
+        throw new Error(`[${modelName}] Missing required key field(s)${operationSuffix}: ${missingFields.join(', ')}. ` +
+            `Required fields: ${Array.from(requiredFields).join(', ')}`);
+    }
+}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export * from './table';
-export { type SchemaDefinition, type ModelDefinition, type PrimaryKeyDefinition, type KeyDefinition, type AttributeDefinition, type IndexDefinition, type IndexesDefinition, type SchemaParams, type InferInput, type InferModel, type InferKeyInput, type InferModelFromSchema, type InferInputFromSchema, type TimestampFields, } from './core/types';
+export { type SchemaDefinition, type ModelDefinition, type PrimaryKeyDefinition, type KeyDefinition, type AttributeDefinition, type IndexDefinition, type IndexesDefinition, type SchemaParams, type InferInput, type InferModel, type InferKeyInput, type InferModelFromSchema, type InferInputFromSchema, type TimestampFields, type ArrayItem, } from './core/types';
 export { createDynamoDBLogger, type DynamoDBLogger, type DynamoDBLoggerConfig, } from './utils/dynamodb-logger';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,eAAe,GACrB,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,oBAAoB,EACpB,KAAK,cAAc,EACnB,KAAK,oBAAoB,GAC1B,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,eAAe,EACpB,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,SAAS,GACf,MAAM,cAAc,CAAC;AACtB,OAAO,EACL,oBAAoB,EACpB,KAAK,cAAc,EACnB,KAAK,oBAAoB,GAC1B,MAAM,yBAAyB,CAAC"}

package/dist/table.d.ts

@@ -17,11 +17,18 @@ export type TableConfig<S extends SchemaDefinition> = {
     /** The schema definition for all models in the table */
     schema: S;
 };
+/**
+ * Helper type to force TypeScript to expand/simplify a type.
+ * This helps with type inference in callbacks by making the type "concrete".
+ */
+type Simplify<T> = {
+    [K in keyof T]: T[K];
+} & {};
 /**
  * Internal helper type to infer all entity APIs from schema definition
  */
 type EntityMap<S extends SchemaDefinition> = {
-    [K in keyof S['models']]: EntityAPI<InferModelFromSchema<S, K>, InferInputFromSchema<S, K>, InferKeyInput<S['models'][K]>>;
+    [K in keyof S['models']]: EntityAPI<Simplify<InferModelFromSchema<S, K>>, Simplify<InferInputFromSchema<S, K>>, Simplify<InferKeyInput<S['models'][K]>>>;
 };
 /**
  * Represents a typed DynamoDB Table with entity APIs

package/dist/table.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../src/table.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAmB,SAAS,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAA8B,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAC7F,OAAO,EAA4B,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,gBAAgB,IAAI;IACpD,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,MAAM,EAAE,cAAc,CAAC;IACvB,uDAAuD;IACvD,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,wDAAwD;IACxD,MAAM,EAAE,CAAC,CAAC;CACX,CAAC;AAEF;;GAEG;AACH,KAAK,SAAS,CAAC,CAAC,SAAS,gBAAgB,IAAI;KAC1C,CAAC,IAAI,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,SAAS,CACjC,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,EAC1B,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,EAC1B,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAC9B;CACF,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,KAAK,CAAC,CAAC,SAAS,gBAAgB;IAC3C,4BAA4B;IAC5B,SAAgB,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAEvC,sBAAsB;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;gBAE5B,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IAsBlC;;;;;;;;;;;;;OAaG;IACH,aAAa,IAAI,oBAAoB;IAIrC;;;;;;;;;;;;;OAaG;IACH,WAAW,IAAI,kBAAkB;CAGlC"}
+{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../src/table.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EACjB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAmB,SAAS,EAAE,MAAM,UAAU,CAAC;AACtD,OAAO,EAA8B,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAC7F,OAAO,EAA4B,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,gBAAgB,IAAI;IACpD,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,MAAM,EAAE,cAAc,CAAC;IACvB,uDAAuD;IACvD,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,wDAAwD;IACxD,MAAM,EAAE,CAAC,CAAC;CACX,CAAC;AAEF;;;GAGG;AACH,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AAEjD;;GAEG;AACH,KAAK,SAAS,CAAC,CAAC,SAAS,gBAAgB,IAAI;KAC1C,CAAC,IAAI,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,SAAS,CACjC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EACpC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EACpC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CACxC;CACF,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,KAAK,CAAC,CAAC,SAAS,gBAAgB;IAC3C,4BAA4B;IAC5B,SAAgB,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAEvC,sBAAsB;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAiB;gBAE5B,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IAuBlC;;;;;;;;;;;;;OAaG;IACH,aAAa,IAAI,oBAAoB;IAIrC;;;;;;;;;;;;;OAaG;IACH,WAAW,IAAI,kBAAkB;CAGlC"}

package/dist/table.js

@@ -27,6 +27,7 @@ class Table {
             rawEntities[modelName] = (0, entity_1.createEntityAPI)(tableName, modelName, model, client, {
                 logger,
                 timestamps: schema.params?.timestamps ?? false,
+                cleanInternalKeys: schema.params?.cleanInternalKeys ?? false,
             });
         }
         this.entities = rawEntities;

package/dist/utils/model-utils.d.ts

@@ -1,4 +1,4 @@
-import { InferModel, ModelDefinition } from '@/core/types';
+import { InferModel, ModelDefinition } from '../core/types';
 /**
  * Extracts all variable names from a template string
  * @param template - Template string with ${variable} syntax
@@ -21,4 +21,10 @@ export declare const applyPostDefaults: <M extends ModelDefinition>(model: M, va
     isUpdate?: boolean;
     timestamps?: boolean;
 }) => InferModel<M>;
+/**
+ * Removes internal DynamoDB keys from an item or array of items
+ * @param data - Single item or array of items from DynamoDB
+ * @returns Data with internal keys removed
+ */
+export declare const stripInternalKeys: <T>(data: T | T[] | undefined) => T | T[] | undefined;
 //# sourceMappingURL=model-utils.d.ts.map

package/dist/utils/model-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"model-utils.d.ts","sourceRoot":"","sources":["../../src/utils/model-utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAiB,eAAe,EAAE,MAAM,cAAc,CAAC;AAG1E;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,UAAU,MAAM,KAAG,MAAM,EAG5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,UAAU,MAAM,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,MAoB7E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,eAAe,EACnD,OAAO,CAAC,EACR,OAAO,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,OAAM,KAAK,GAAG,OAAO,GAAG,MAAc,KACrC,MAAM,CAAC,MAAM,EAAE,MAAM,CAWvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,eAAe,EACzD,OAAO,CAAC,EACR,eAAe,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAClC,UAAU;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,KACrD,UAAU,CAAC,CAAC,CAgCd,CAAC"}
+{"version":3,"file":"model-utils.d.ts","sourceRoot":"","sources":["../../src/utils/model-utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAiB,eAAe,EAAE,MAAM,cAAc,CAAC;AAG1E;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,UAAU,MAAM,KAAG,MAAM,EAG5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,eAAe,GAAI,UAAU,MAAM,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAG,MAoB7E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,eAAe,EACnD,OAAO,CAAC,EACR,OAAO,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,OAAM,KAAK,GAAG,OAAO,GAAG,MAAc,KACrC,MAAM,CAAC,MAAM,EAAE,MAAM,CAWvB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,eAAe,EACzD,OAAO,CAAC,EACR,eAAe,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAClC,UAAU;IAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;IAAC,UAAU,CAAC,EAAE,OAAO,CAAA;CAAE,KACrD,UAAU,CAAC,CAAC,CAiCd,CAAC;AAOF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,GAAG,SAAS,KAAG,CAAC,GAAG,CAAC,EAAE,GAAG,SAoB1E,CAAC"}

package/dist/utils/model-utils.js

@@ -1,7 +1,7 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-explicit-any */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyPostDefaults = exports.resolveKeys = exports.resolveTemplate = exports.extractTemplateVars = void 0;
+exports.stripInternalKeys = exports.applyPostDefaults = exports.resolveKeys = exports.resolveTemplate = exports.extractTemplateVars = void 0;
 const ulid_1 = require("ulid");
 /**
  * Extracts all variable names from a template string
@@ -60,10 +60,11 @@ const applyPostDefaults = (model, validatedItem, options) => {
     const result = { ...validatedItem };
     for (const [key, attr] of Object.entries(model.attributes)) {
         if (result[key] === undefined) {
-            if (attr.generate === 'ulid') {
+            const generate = 'generate' in attr ? attr.generate : undefined;
+            if (generate === 'ulid') {
                 result[key] = (0, ulid_1.ulid)();
             }
-            else if (attr.generate === 'uuid') {
+            else if (generate === 'uuid') {
                 result[key] = crypto.randomUUID();
             }
             else if (attr.default !== undefined) {
@@ -86,3 +87,31 @@ const applyPostDefaults = (model, validatedItem, options) => {
     return result;
 };
 exports.applyPostDefaults = applyPostDefaults;
+/**
+ * Internal DynamoDB keys that should be stripped when cleanInternalKeys is enabled
+ */
+const INTERNAL_KEYS = ['PK', 'SK', '_type'];
+/**
+ * Removes internal DynamoDB keys from an item or array of items
+ * @param data - Single item or array of items from DynamoDB
+ * @returns Data with internal keys removed
+ */
+const stripInternalKeys = (data) => {
+    if (data === undefined || data === null) {
+        return data;
+    }
+    if (Array.isArray(data)) {
+        return data.map((item) => (0, exports.stripInternalKeys)(item));
+    }
+    if (typeof data === 'object') {
+        const cleaned = {};
+        for (const [key, value] of Object.entries(data)) {
+            if (!INTERNAL_KEYS.includes(key)) {
+                cleaned[key] = value;
+            }
+        }
+        return cleaned;
+    }
+    return data;
+};
+exports.stripInternalKeys = stripInternalKeys;

package/dist/utils/zod-utils.d.ts

@@ -1,7 +1,8 @@
-import { AttributeDefinition, ModelDefinition } from '@/core/types';
+import { AttributeDefinition, ModelDefinition } from '../core/types';
 import { ZodObject, ZodType } from 'zod';
 /**
- * Converts an attribute definition to a Zod schema type
+ * Converts an attribute definition to a Zod schema type.
+ * Supports scalars, nested objects (with schema), and arrays (with items).
  */
 export declare const typeToZod: (attr: AttributeDefinition) => ZodType;
 /**

package/dist/utils/zod-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"zod-utils.d.ts","sourceRoot":"","sources":["../../src/utils/zod-utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAK,SAAS,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,mBAAmB,KAAG,OAarD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,eAAe,KAAG,SAAS,CAAC,GAAG,CAMhE,CAAC"}
+{"version":3,"file":"zod-utils.d.ts","sourceRoot":"","sources":["../../src/utils/zod-utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAK,SAAS,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,MAAM,mBAAmB,KAAG,OA+BrD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,eAAe,KAAG,SAAS,CAAC,GAAG,CAMhE,CAAC"}

package/dist/utils/zod-utils.js

@@ -5,18 +5,40 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.modelToZod = exports.typeToZod = void 0;
 const zod_1 = require("zod");
 /**
- * Converts an attribute definition to a Zod schema type
+ * Converts an attribute definition to a Zod schema type.
+ * Supports scalars, nested objects (with schema), and arrays (with items).
  */
 const typeToZod = (attr) => {
-    const zodType = attr.type === String
-        ? zod_1.z.string()
-        : attr.type === Number
-            ? zod_1.z.number()
-            : attr.type === Boolean
-                ? zod_1.z.boolean()
-                : attr.type === Date
-                    ? zod_1.z.date()
-                    : zod_1.z.unknown();
+    let zodType;
+    if (attr.type === Object) {
+        const schema = attr.schema;
+        if (schema) {
+            const shape = {};
+            for (const [key, nestedAttr] of Object.entries(schema)) {
+                shape[key] = (0, exports.typeToZod)(nestedAttr);
+            }
+            zodType = zod_1.z.looseObject(shape);
+        }
+        else {
+            zodType = zod_1.z.record(zod_1.z.string(), zod_1.z.unknown());
+        }
+    }
+    else if (attr.type === Array) {
+        const items = attr.items;
+        zodType = items ? zod_1.z.array((0, exports.typeToZod)(items)) : zod_1.z.array(zod_1.z.unknown());
+    }
+    else {
+        zodType =
+            attr.type === String
+                ? zod_1.z.string()
+                : attr.type === Number
+                    ? zod_1.z.number()
+                    : attr.type === Boolean
+                        ? zod_1.z.boolean()
+                        : attr.type === Date
+                            ? zod_1.z.date()
+                            : zod_1.z.unknown();
+    }
     return attr.required ? zodType : zodType.optional();
 };
 exports.typeToZod = typeToZod;
@@ -30,6 +52,6 @@ const modelToZod = (model) => {
     for (const [key, attr] of Object.entries(model.attributes)) {
         shape[key] = (0, exports.typeToZod)(attr);
     }
-    return zod_1.z.object(shape).passthrough();
+    return zod_1.z.looseObject(shape);
 };
 exports.modelToZod = modelToZod;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ftschopp/dynatable-core",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Core library for DynamoDB single table design",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,7 +8,7 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc && tsc-alias",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist",
     "test": "jest"
   },
@@ -22,6 +22,7 @@
     "jest": "^30.2.0",
     "ts-jest": "^29.4.6",
     "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.16",
     "typescript": "5.9.3"
   },
   "dependencies": {

package/src/builders/README.md

@@ -209,7 +209,33 @@ The `op` parameter in `.where()` provides these operators:
 - `op.gt(attr, value)` - Greater than (>)
 - `op.gte(attr, value)` - Greater than or equal (>=)
 - `op.between(attr, low, high)` - Between two values
-- `op.beginsWith(attr, prefix)` - Begins with a string (for string fields)
+
+**String Operators:**
+
+- `op.beginsWith(attr, prefix)` - Begins with a string prefix (for string/binary fields)
+- `op.contains(attr, value)` - Contains a substring or value (works with strings, sets, and lists)
+
+**Existence Operators:**
+
+- `op.exists(attr)` - Attribute exists
+- `op.notExists(attr)` - Attribute does not exist
+
+**Type Checking:**
+
+- `op.attributeType(attr, type)` - Check the attribute's type
+  - Valid types: `'S'` (String), `'N'` (Number), `'B'` (Binary), `'SS'` (String Set), `'NS'` (Number Set), `'BS'` (Binary Set), `'M'` (Map), `'L'` (List), `'NULL'`, `'BOOL'`
+
+**Advanced Operators:**
+
+- `op.in(attr, values[])` - Attribute value is in the provided array
+- `op.size(attr)` - Get the size of an attribute (string length, number of elements in set/list, etc.)
+  - Returns a `SizeRef` object with comparison methods:
+    - `.eq(n)` - Size equals n
+    - `.ne(n)` - Size not equals n
+    - `.lt(n)` - Size less than n
+    - `.lte(n)` - Size less than or equal to n
+    - `.gt(n)` - Size greater than n
+    - `.gte(n)` - Size greater than or equal to n
 
 **Logical Operators:**
 
@@ -257,6 +283,47 @@ The `op` parameter in `.where()` provides these operators:
 // NOT operator
 .where((attr, op) => op.not(op.eq(attr.status, 'deleted')))
 
+// Existence operators
+.where((attr, op) => op.and(
+  op.eq(attr.username, 'alice'),
+  op.exists(attr.email)              // Has email field
+))
+
+.where((attr, op) => op.notExists(attr.deletedAt))  // Not deleted
+
+// Contains operator (for strings, sets, lists)
+.where((attr, op) => op.and(
+  op.eq(attr.username, 'alice'),
+  op.contains(attr.bio, 'developer')  // Bio contains "developer"
+))
+
+.where((attr, op) => op.contains(attr.tags, 'premium'))  // Has "premium" in tags set/list
+
+// IN operator
+.where((attr, op) => op.in(attr.status, ['active', 'pending', 'verified']))
+
+// Size operator
+.where((attr, op) => op.size(attr.tags).gte(3))        // At least 3 tags
+.where((attr, op) => op.size(attr.username).lt(20))    // Username shorter than 20 chars
+.where((attr, op) => op.size(attr.comments).eq(0))     // No comments
+
+// Attribute type checking
+.where((attr, op) => op.attributeType(attr.metadata, 'M'))  // Is a Map
+.where((attr, op) => op.attributeType(attr.items, 'L'))     // Is a List
+
+// Complex example with new operators
+await table.entities.User.query()
+  .where((attr, op) => op.and(
+    op.eq(attr.status, 'active'),
+    op.exists(attr.email),
+    op.size(attr.followers).gte(10),
+    op.or(
+      op.contains(attr.tags, 'premium'),
+      op.contains(attr.tags, 'verified')
+    )
+  ))
+  .execute();
+
 // Complete example with all features
 await table.entities.Photo.query()
   .where((attr, op) => op.and(

package/src/builders/delete/types.ts

@@ -1,11 +1,17 @@
+import type { DeleteCommandInput } from '@aws-sdk/lib-dynamodb';
 import { OperationBuilder } from '../shared';
 
 /**
  * Builder interface for DynamoDB DeleteItem operations
  */
-export interface DeleteBuilder<Model> extends OperationBuilder<Model> {
+export interface DeleteBuilder<Model> extends Omit<OperationBuilder<Model>, 'dbParams'> {
   /**
    * Configures what values should be returned after the delete operation
    */
   returning(mode: 'NONE' | 'ALL_OLD'): DeleteBuilder<Model>;
+
+  /**
+   * Converts the builder state to DynamoDB DeleteItem parameters
+   */
+  dbParams(): DeleteCommandInput;
 }

package/src/builders/get/types.ts

@@ -1,10 +1,11 @@
+import type { GetCommandInput } from '@aws-sdk/lib-dynamodb';
 import { ExecutableBuilder } from '../shared';
 
 /**
  * Builder for DynamoDB GetItem operations.
  * Supports projection, consistent read, and inspection of the final parameters.
  */
-export interface GetBuilder<KeyInput, Model> extends ExecutableBuilder<Model | undefined> {
+export interface GetBuilder<KeyInput, Model> extends Omit<ExecutableBuilder<Model | undefined>, 'dbParams'> {
   /**
    * Adds a projection expression to only return specific attributes.
    * Returns a new immutable builder.
@@ -27,4 +28,9 @@ export interface GetBuilder<KeyInput, Model> extends ExecutableBuilder<Model | u
    * - NONE: No consumed capacity data returned (default)
    */
   returnConsumedCapacity(mode: 'INDEXES' | 'TOTAL' | 'NONE'): GetBuilder<KeyInput, Model>;
+
+  /**
+   * Converts the builder state to DynamoDB GetItem parameters
+   */
+  dbParams(): GetCommandInput;
 }

package/src/builders/put/types.ts

@@ -1,9 +1,10 @@
+import type { PutCommandInput } from '@aws-sdk/lib-dynamodb';
 import { OperationBuilder } from '../shared';
 
 /**
  * Builder interface for DynamoDB PutItem operations
  */
-export interface PutBuilder<Model> extends OperationBuilder<Model> {
+export interface PutBuilder<Model> extends Omit<OperationBuilder<Model>, 'dbParams'> {
   /**
    * Adds a condition that the item must not exist (checks pk and sk)
    */
@@ -15,4 +16,9 @@ export interface PutBuilder<Model> extends OperationBuilder<Model> {
    * - ALL_OLD: Returns the item as it was before being replaced (if it existed)
    */
   returning(mode: 'NONE' | 'ALL_OLD'): PutBuilder<Model>;
+
+  /**
+   * Converts the builder state to DynamoDB PutItem parameters
+   */
+  dbParams(): PutCommandInput;
 }

package/src/builders/query/create-query-builder.ts

@@ -181,9 +181,7 @@ function buildSimpleAndExpression(conditions: Condition[]): {
 /**
  * Creates the query executor with all query methods
  */
-function createQueryExecutor<Model, M extends ModelDefinition = any>(
-  state: QueryState<Model>
-): QueryExecutor<Model, M> {
+function createQueryExecutor<Model>(state: QueryState<Model>): QueryExecutor<Model> {
   return {
     limit(count) {
       return createQueryExecutor({
@@ -317,12 +315,12 @@ function createQueryExecutor<Model, M extends ModelDefinition = any>(
 /**
  * Creates a QueryBuilder for a table
  */
-export function createQueryBuilder<Model, M extends ModelDefinition = any>(
+export function createQueryBuilder<Model>(
   tableName: string,
   client: DynamoDBClient,
-  model?: M,
+  model?: ModelDefinition,
   logger?: DynamoDBLogger
-): QueryBuilder<Model, M> {
+): QueryBuilder<Model> {
   return {
     where(fn) {
       // Create attribute builder proxy