@jaypie/fabric 0.2.3 → 0.2.4

package/README.md

@@ -591,9 +591,9 @@ const message: FabricMessage = {
 When persisting models to DynamoDB, use index utilities to build GSI keys:
 
 ```typescript
-import { APEX, calculateScope, populateIndexKeys, registerModel } from "@jaypie/fabric";
+import { APEX, calculateScope, DEFAULT_INDEXES, populateIndexKeys, registerModel } from "@jaypie/fabric";
 
-// Register model indexes
+// Register custom model indexes (recommended)
 registerModel({
   model: "record",
   indexes: [
@@ -619,16 +619,16 @@ const message = {
   // ...other fields
 };
 
-// Auto-populate GSI keys (uses registered indexes)
-const indexes = [
-  { name: "indexScope", pk: ["scope", "model"], sk: ["sequence"] },
-  { name: "indexAlias", pk: ["scope", "model", "alias"], sk: ["sequence"], sparse: true },
-];
-const indexed = populateIndexKeys(record, indexes);
+// Auto-populate GSI keys
+const indexed = populateIndexKeys(record, DEFAULT_INDEXES);
 // indexed.indexScope = "@#record"
 // indexed.indexAlias = "@#record#2026-12-12"
 ```
 
+> **Deprecated:** `DEFAULT_INDEXES` is restored in 0.2.4 to unblock consumers
+> and is scheduled for removal in 0.3.0. Register model indexes explicitly with
+> `registerModel()` instead.
+
 ## API
 
 ### Main Export (`@jaypie/fabric`)
@@ -655,6 +655,7 @@ const indexed = populateIndexKeys(record, indexes);
 | `populateIndexKeys` | Populate GSI keys on an entity |
 | `buildCompositeKey` | Build composite key from fields |
 | `calculateScope` | Calculate scope |
+| `DEFAULT_INDEXES` | Default GSI definitions (deprecated, removal targeted for 0.3.0) |
 | `APEX` | Root-level marker (`"@"`) |
 | `SEPARATOR` | Composite key separator (`"#"`) |
 | `ARCHIVED_SUFFIX` | Suffix for archived entities |

package/dist/cjs/index/index.d.ts

@@ -3,6 +3,6 @@
  *
  * Exports all index-related types, functions, and constants.
  */
-export { ARCHIVED_SUFFIX, DEFAULT_SORT_KEY, DELETED_SUFFIX, type IndexDefinition, type IndexField, type ModelSchema, } from "./types.js";
+export { ARCHIVED_SUFFIX, DEFAULT_INDEXES, DEFAULT_SORT_KEY, DELETED_SUFFIX, type IndexDefinition, type IndexField, type ModelSchema, } from "./types.js";
 export { buildCompositeKey, calculateIndexSuffix, calculateScope, generateIndexName, type IndexableModel, populateIndexKeys, tryBuildCompositeKey, } from "./keyBuilder.js";
 export { clearRegistry, getAllRegisteredIndexes, getModelIndexes, getModelSchema, getRegisteredModels, isModelRegistered, registerModel, } from "./registry.js";

package/dist/cjs/index/registry.d.ts

@@ -22,7 +22,10 @@ export declare function getModelSchema(model: string): ModelSchema | undefined;
  * Get index definitions for a model
  *
  * Returns the model's custom indexes if registered,
- * otherwise returns an empty array.
+ * otherwise returns DEFAULT_INDEXES.
+ *
+ * @deprecated The fallback to DEFAULT_INDEXES will be removed in 0.3.0.
+ * Register model indexes explicitly with `registerModel()`.
  *
  * @param model - Model name to get indexes for
  * @returns Array of index definitions

package/dist/cjs/index/types.d.ts

@@ -32,9 +32,17 @@ export interface IndexDefinition {
 export interface ModelSchema {
     /** The model name (e.g., "record", "message", "chat") */
     model: string;
-    /** Custom indexes for this model (empty array if not specified) */
+    /** Custom indexes for this model (uses DEFAULT_INDEXES if not specified) */
     indexes?: IndexDefinition[];
 }
+/**
+ * Default indexes for the DynamoDB GSI pattern.
+ * These are used when a model does not specify custom indexes.
+ *
+ * @deprecated Restored in 0.2.4 to unblock consumers. Will be removed in
+ * 0.3.0 — register model indexes explicitly with `registerModel()` instead.
+ */
+export declare const DEFAULT_INDEXES: IndexDefinition[];
 /**
  * Default sort key fields when sk is not specified
  */

package/dist/cjs/index.cjs

@@ -776,6 +776,43 @@ function computeResolvedName(model) {
  * GSIs and auto-detect which index to use for queries.
  */
 // =============================================================================
+// Default Indexes
+// =============================================================================
+/**
+ * Default indexes for the DynamoDB GSI pattern.
+ * These are used when a model does not specify custom indexes.
+ *
+ * @deprecated Restored in 0.2.4 to unblock consumers. Will be removed in
+ * 0.3.0 — register model indexes explicitly with `registerModel()` instead.
+ */
+const DEFAULT_INDEXES = [
+    { name: "indexScope", pk: ["scope", "model"], sk: ["sequence"] },
+    {
+        name: "indexAlias",
+        pk: ["scope", "model", "alias"],
+        sk: ["sequence"],
+        sparse: true,
+    },
+    {
+        name: "indexCategory",
+        pk: ["scope", "model", "category"],
+        sk: ["sequence"],
+        sparse: true,
+    },
+    {
+        name: "indexType",
+        pk: ["scope", "model", "type"],
+        sk: ["sequence"],
+        sparse: true,
+    },
+    {
+        name: "indexXid",
+        pk: ["scope", "model", "xid"],
+        sk: ["sequence"],
+        sparse: true,
+    },
+];
+// =============================================================================
 // Constants
 // =============================================================================
 /**
@@ -951,14 +988,17 @@ function getModelSchema(model) {
  * Get index definitions for a model
  *
  * Returns the model's custom indexes if registered,
- * otherwise returns an empty array.
+ * otherwise returns DEFAULT_INDEXES.
+ *
+ * @deprecated The fallback to DEFAULT_INDEXES will be removed in 0.3.0.
+ * Register model indexes explicitly with `registerModel()`.
  *
  * @param model - Model name to get indexes for
  * @returns Array of index definitions
  */
 function getModelIndexes(model) {
     const schema = MODEL_REGISTRY.get(model);
-    return schema?.indexes ?? [];
+    return schema?.indexes ?? DEFAULT_INDEXES;
 }
 /**
  * Get all registered models
@@ -1754,6 +1794,7 @@ exports.ARCHIVED_SUFFIX = ARCHIVED_SUFFIX;
 exports.BOOLEAN_TYPE = BOOLEAN_TYPE;
 exports.DATETIME_TYPE = DATETIME_TYPE;
 exports.DATE_TYPE = DATE_TYPE;
+exports.DEFAULT_INDEXES = DEFAULT_INDEXES;
 exports.DEFAULT_SORT_KEY = DEFAULT_SORT_KEY;
 exports.DELETED_SUFFIX = DELETED_SUFFIX;
 exports.DOLLARS_TYPE = DOLLARS_TYPE;