@jaypie/dynamodb 0.1.3 → 0.3.0

package/dist/cjs/types.d.ts

@@ -1,3 +1,4 @@
+import type { FabricModel } from "@jaypie/fabric";
 /**
  * DynamoDB client configuration
  */
@@ -15,7 +16,7 @@ export interface DynamoClientConfig {
     tableName?: string;
 }
 /**
- * Parent reference for calculating OU
+ * Parent reference for calculating scope
  */
 export interface ParentReference {
     id: string;
@@ -37,13 +38,13 @@ export interface BaseQueryOptions {
     startKey?: Record<string, unknown>;
 }
 /**
- * Parameters for queryByOu
+ * Parameters for queryByScope
  */
-export interface QueryByOuParams extends BaseQueryOptions {
+export interface QueryByScopeParams extends BaseQueryOptions {
     /** The entity model name */
     model: string;
-    /** The organizational unit (APEX or "{parent.model}#{parent.id}") */
-    ou: string;
+    /** The scope (APEX or "{parent.model}#{parent.id}") */
+    scope: string;
 }
 /**
  * Parameters for queryByAlias
@@ -57,8 +58,8 @@ export interface QueryByAliasParams {
     deleted?: boolean;
     /** The entity model name */
     model: string;
-    /** The organizational unit */
-    ou: string;
+    /** The scope */
+    scope: string;
 }
 /**
  * Parameters for queryByClass
@@ -66,8 +67,8 @@ export interface QueryByAliasParams {
 export interface QueryByClassParams extends BaseQueryOptions {
     /** The entity model name */
     model: string;
-    /** The organizational unit */
-    ou: string;
+    /** The scope */
+    scope: string;
     /** The category classification */
     recordClass: string;
 }
@@ -77,8 +78,8 @@ export interface QueryByClassParams extends BaseQueryOptions {
 export interface QueryByTypeParams extends BaseQueryOptions {
     /** The entity model name */
     model: string;
-    /** The organizational unit */
-    ou: string;
+    /** The scope */
+    scope: string;
     /** The type classification */
     type: string;
 }
@@ -92,47 +93,44 @@ export interface QueryByXidParams {
     deleted?: boolean;
     /** The entity model name */
     model: string;
-    /** The organizational unit */
-    ou: string;
+    /** The scope */
+    scope: string;
     /** The external ID */
     xid: string;
 }
 /**
  * Result of a query operation
  */
-export interface QueryResult<T = FabricEntity> {
+export interface QueryResult<T = StorableEntity> {
     /** Array of matching entities */
     items: T[];
     /** Pagination cursor for next page (undefined if no more results) */
     lastEvaluatedKey?: Record<string, unknown>;
 }
 /**
- * Base entity interface for DynamoDB single-table design
+ * Entity with required fields for DynamoDB storage.
+ *
+ * Extends FabricModel from @jaypie/fabric with:
+ * - Required storage fields (id, model, name, scope, sequence)
+ * - String timestamps (DynamoDB uses ISO 8601 strings, not Date objects)
+ * - GSI index keys (auto-populated by indexEntity)
  */
-export interface FabricEntity {
+export interface StorableEntity extends Omit<FabricModel, "archivedAt" | "createdAt" | "deletedAt" | "updatedAt"> {
     /** Partition key (e.g., "record", "message") */
     model: string;
     /** Sort key (UUID) */
     id: string;
     /** Human-readable name */
     name: string;
-    /** Organizational unit: APEX ("@") or "{parent.model}#{parent.id}" */
-    ou: string;
+    /** Scope: APEX ("@") or "{parent.model}#{parent.id}" */
+    scope: string;
     /** Timestamp for chronological ordering (Date.now()) */
     sequence: number;
     indexAlias?: string;
     indexClass?: string;
-    indexOu?: string;
+    indexScope?: string;
     indexType?: string;
     indexXid?: string;
-    /** Human-friendly slug/alias */
-    alias?: string;
-    /** Category classification */
-    class?: string;
-    /** Type classification */
-    type?: string;
-    /** External ID for integration with external systems */
-    xid?: string;
     createdAt: string;
     updatedAt: string;
     /** Archive timestamp (for inactive but preserved records) */

package/dist/esm/constants.d.ts

@@ -1,9 +1,6 @@
-export declare const APEX = "@";
-export declare const SEPARATOR = "#";
+export { APEX, ARCHIVED_SUFFIX, DELETED_SUFFIX, SEPARATOR, } from "@jaypie/fabric";
 export declare const INDEX_ALIAS = "indexAlias";
 export declare const INDEX_CLASS = "indexClass";
-export declare const INDEX_OU = "indexOu";
+export declare const INDEX_SCOPE = "indexScope";
 export declare const INDEX_TYPE = "indexType";
 export declare const INDEX_XID = "indexXid";
-export declare const ARCHIVED_SUFFIX = "#archived";
-export declare const DELETED_SUFFIX = "#deleted";

package/dist/esm/entities.d.ts

@@ -1,40 +1,40 @@
-import type { FabricEntity } from "./types.js";
+import type { StorableEntity } from "./types.js";
 /**
  * Get a single entity by primary key
  */
-export declare const getEntity: import("@jaypie/vocabulary").ServiceHandlerFunction<Record<string, unknown>, FabricEntity | null>;
+export declare const getEntity: import("@jaypie/fabric").Service<Record<string, unknown>, StorableEntity | null>;
 /**
  * Put (create or replace) an entity
  * Auto-populates GSI index keys via indexEntity
  *
- * Note: This is a regular async function (not serviceHandler) because it accepts
- * complex FabricEntity objects that can't be coerced by vocabulary's type system.
+ * Note: This is a regular async function (not fabricService) because it accepts
+ * complex StorableEntity objects that can't be coerced by vocabulary's type system.
  */
 export declare function putEntity({ entity, }: {
-    entity: FabricEntity;
-}): Promise<FabricEntity>;
+    entity: StorableEntity;
+}): Promise<StorableEntity>;
 /**
  * Update an existing entity
  * Auto-populates GSI index keys and sets updatedAt
  *
- * Note: This is a regular async function (not serviceHandler) because it accepts
- * complex FabricEntity objects that can't be coerced by vocabulary's type system.
+ * Note: This is a regular async function (not fabricService) because it accepts
+ * complex StorableEntity objects that can't be coerced by vocabulary's type system.
  */
 export declare function updateEntity({ entity, }: {
-    entity: FabricEntity;
-}): Promise<FabricEntity>;
+    entity: StorableEntity;
+}): Promise<StorableEntity>;
 /**
  * Soft delete an entity by setting deletedAt timestamp
  * Re-indexes with appropriate suffix based on archived/deleted state
  */
-export declare const deleteEntity: import("@jaypie/vocabulary").ServiceHandlerFunction<Record<string, unknown>, boolean>;
+export declare const deleteEntity: import("@jaypie/fabric").Service<Record<string, unknown>, boolean>;
 /**
  * Archive an entity by setting archivedAt timestamp
  * Re-indexes with appropriate suffix based on archived/deleted state
  */
-export declare const archiveEntity: import("@jaypie/vocabulary").ServiceHandlerFunction<Record<string, unknown>, boolean>;
+export declare const archiveEntity: import("@jaypie/fabric").Service<Record<string, unknown>, boolean>;
 /**
  * Hard delete an entity (permanently removes from table)
  * Use with caution - prefer deleteEntity for soft delete
  */
-export declare const destroyEntity: import("@jaypie/vocabulary").ServiceHandlerFunction<Record<string, unknown>, boolean>;
+export declare const destroyEntity: import("@jaypie/fabric").Service<Record<string, unknown>, boolean>;

package/dist/esm/index.d.ts

@@ -1,8 +1,10 @@
 export { getDocClient, getTableName, initClient, isInitialized, resetClient, } from "./client.js";
-export { APEX, ARCHIVED_SUFFIX, DELETED_SUFFIX, INDEX_ALIAS, INDEX_CLASS, INDEX_OU, INDEX_TYPE, INDEX_XID, SEPARATOR, } from "./constants.js";
+export { APEX, ARCHIVED_SUFFIX, DELETED_SUFFIX, INDEX_ALIAS, INDEX_CLASS, INDEX_SCOPE, INDEX_TYPE, INDEX_XID, SEPARATOR, } from "./constants.js";
 export { archiveEntity, deleteEntity, destroyEntity, getEntity, putEntity, updateEntity, } from "./entities.js";
-export { buildIndexAlias, buildIndexClass, buildIndexOu, buildIndexType, buildIndexXid, calculateOu, indexEntity, } from "./keyBuilders.js";
-export { queryByAlias, queryByClass, queryByOu, queryByType, queryByXid, } from "./queries.js";
+export { buildCompositeKey, buildIndexAlias, buildIndexClass, buildIndexScope, buildIndexType, buildIndexXid, calculateScope, DEFAULT_INDEXES, indexEntity, } from "./keyBuilders.js";
+export { queryByAlias, queryByClass, queryByScope, queryByType, queryByXid, } from "./queries.js";
+export { query } from "./query.js";
+export type { QueryParams } from "./query.js";
 export { exportEntities, exportEntitiesToJson, seedEntities, seedEntityIfNotExists, } from "./seedExport.js";
-export type { BaseQueryOptions, DynamoClientConfig, FabricEntity, ParentReference, QueryResult, } from "./types.js";
+export type { BaseQueryOptions, DynamoClientConfig, ParentReference, QueryResult, StorableEntity, } from "./types.js";
 export type { ExportResult, SeedOptions, SeedResult } from "./seedExport.js";