@typicalday/firegraph 0.10.0 → 0.11.0

package/dist/index.cjs

@@ -159,6 +159,7 @@ var index_exports = {};
 __export(index_exports, {
   BOOTSTRAP_ENTRIES: () => BOOTSTRAP_ENTRIES,
   CrossBackendTransactionError: () => CrossBackendTransactionError,
+  DEFAULT_CORE_INDEXES: () => DEFAULT_CORE_INDEXES,
   DEFAULT_QUERY_LIMIT: () => DEFAULT_QUERY_LIMIT,
   DiscoveryError: () => DiscoveryError,
   DynamicRegistryError: () => DynamicRegistryError,
@@ -573,9 +574,7 @@ async function migrateRecord(record, registry, globalWriteBack = "off") {
   };
 }
 async function migrateRecords(records, registry, globalWriteBack = "off") {
-  return Promise.all(
-    records.map((r) => migrateRecord(r, registry, globalWriteBack))
-  );
+  return Promise.all(records.map((r) => migrateRecord(r, registry, globalWriteBack)));
 }
 
 // src/scope.ts
@@ -783,7 +782,8 @@ function discoveryToEntries(discovery) {
       subtitleField: entity.subtitleField,
       allowedIn: entity.allowedIn,
       migrations: entity.migrations,
-      migrationWriteBack: entity.migrationWriteBack
+      migrationWriteBack: entity.migrationWriteBack,
+      indexes: entity.indexes
     });
   }
   for (const [axbType, entity] of discovery.edges) {
@@ -811,7 +811,8 @@ function discoveryToEntries(discovery) {
           allowedIn: entity.allowedIn,
           targetGraph: resolvedTargetGraph,
           migrations: entity.migrations,
-          migrationWriteBack: entity.migrationWriteBack
+          migrationWriteBack: entity.migrationWriteBack,
+          indexes: entity.indexes
         });
       }
     }
@@ -1896,26 +1897,17 @@ function createGraphClientFromBackend(backend, options, metaBackend) {
 
 // src/codegen/index.ts
 function pascalCase(s) {
-  return s.replace(
-    /(^|[^a-zA-Z0-9])([a-zA-Z])/g,
-    (_, _sep, ch) => ch.toUpperCase()
-  );
+  return s.replace(/(^|[^a-zA-Z0-9])([a-zA-Z])/g, (_, _sep, ch) => ch.toUpperCase());
 }
 async function generateTypes(discovery, options = {}) {
   const { compile } = await import("json-schema-to-typescript");
   const { banner = true } = options;
   const chunks = [];
   if (banner) {
-    chunks.push(
-      "// Auto-generated by firegraph codegen \u2014 do not edit manually\n"
-    );
+    chunks.push("// Auto-generated by firegraph codegen \u2014 do not edit manually\n");
   }
-  const sortedNodes = [...discovery.nodes.entries()].sort(
-    ([a], [b]) => a.localeCompare(b)
-  );
-  const sortedEdges = [...discovery.edges.entries()].sort(
-    ([a], [b]) => a.localeCompare(b)
-  );
+  const sortedNodes = [...discovery.nodes.entries()].sort(([a], [b]) => a.localeCompare(b));
+  const sortedEdges = [...discovery.edges.entries()].sort(([a], [b]) => a.localeCompare(b));
   for (const [name, entity] of sortedNodes) {
     const typeName = `${pascalCase(name)}Data`;
     const ts = await compile(entity.schema, typeName, {
@@ -1970,6 +1962,18 @@ function isAncestorUid(collectionPath, uid) {
   return resolveAncestorCollection(collectionPath, uid) !== null;
 }
 
+// src/default-indexes.ts
+var DEFAULT_CORE_INDEXES = Object.freeze([
+  { fields: ["aUid"] },
+  { fields: ["bUid"] },
+  { fields: ["aType"] },
+  { fields: ["bType"] },
+  { fields: ["aUid", "axbType"] },
+  { fields: ["axbType", "bUid"] },
+  { fields: ["aType", "axbType"] },
+  { fields: ["axbType", "bType"] }
+]);
+
 // src/discover.ts
 var import_node_fs = require("fs");
 var import_node_module = require("module");
@@ -2091,7 +2095,8 @@ function loadNodeEntity(dir, name) {
     sampleData,
     allowedIn: meta?.allowedIn,
     migrations,
-    migrationWriteBack: meta?.migrationWriteBack
+    migrationWriteBack: meta?.migrationWriteBack,
+    indexes: meta?.indexes
   };
 }
 function loadEdgeEntity(dir, name) {
@@ -2128,7 +2133,8 @@ function loadEdgeEntity(dir, name) {
     allowedIn: meta?.allowedIn,
     targetGraph: topology.targetGraph ?? meta?.targetGraph,
     migrations,
-    migrationWriteBack: meta?.migrationWriteBack
+    migrationWriteBack: meta?.migrationWriteBack,
+    indexes: meta?.indexes
   };
 }
 function getSubdirectories(dir) {
@@ -2658,124 +2664,74 @@ function generateId() {
 }
 
 // src/indexes.ts
-function baseIndexes(collection) {
-  return [
-    {
-      collectionGroup: collection,
-      queryScope: "COLLECTION",
-      fields: [
-        { fieldPath: "aUid", order: "ASCENDING" },
-        { fieldPath: "axbType", order: "ASCENDING" }
-      ]
-    },
-    {
-      collectionGroup: collection,
-      queryScope: "COLLECTION",
-      fields: [
-        { fieldPath: "axbType", order: "ASCENDING" },
-        { fieldPath: "bUid", order: "ASCENDING" }
-      ]
-    },
-    {
-      collectionGroup: collection,
-      queryScope: "COLLECTION",
-      fields: [
-        { fieldPath: "aType", order: "ASCENDING" },
-        { fieldPath: "axbType", order: "ASCENDING" }
-      ]
-    },
-    {
-      collectionGroup: collection,
-      queryScope: "COLLECTION",
-      fields: [
-        { fieldPath: "axbType", order: "ASCENDING" },
-        { fieldPath: "bType", order: "ASCENDING" }
-      ]
-    }
-  ];
+function normalizeField(f) {
+  return typeof f === "string" ? { path: f, desc: false } : { path: f.path, desc: !!f.desc };
 }
-function extractSchemaFields(schema) {
-  const s = schema;
-  if (s.type !== "object" || !s.properties) return [];
-  return Object.keys(s.properties);
-}
-function collectionGroupIndexes(collectionName) {
-  return [
-    {
-      collectionGroup: collectionName,
-      queryScope: "COLLECTION_GROUP",
-      fields: [
-        { fieldPath: "aUid", order: "ASCENDING" },
-        { fieldPath: "axbType", order: "ASCENDING" }
-      ]
-    },
-    {
-      collectionGroup: collectionName,
-      queryScope: "COLLECTION_GROUP",
-      fields: [
-        { fieldPath: "axbType", order: "ASCENDING" },
-        { fieldPath: "bUid", order: "ASCENDING" }
-      ]
-    },
-    {
-      collectionGroup: collectionName,
-      queryScope: "COLLECTION_GROUP",
-      fields: [
-        { fieldPath: "aType", order: "ASCENDING" },
-        { fieldPath: "axbType", order: "ASCENDING" }
-      ]
-    },
-    {
-      collectionGroup: collectionName,
-      queryScope: "COLLECTION_GROUP",
-      fields: [
-        { fieldPath: "axbType", order: "ASCENDING" },
-        { fieldPath: "bType", order: "ASCENDING" }
-      ]
-    }
-  ];
+function specFingerprint(spec, scope) {
+  const normalized = spec.fields.map(normalizeField);
+  return `${scope}::${JSON.stringify(normalized)}`;
 }
-function generateIndexConfig(collection, entities, registryEntries) {
-  const indexes = baseIndexes(collection);
-  if (entities) {
-    for (const [, entity] of entities.nodes) {
-      const fields = extractSchemaFields(entity.schema);
-      for (const field of fields) {
-        indexes.push({
-          collectionGroup: collection,
-          queryScope: "COLLECTION",
-          fields: [
-            { fieldPath: "aType", order: "ASCENDING" },
-            { fieldPath: "axbType", order: "ASCENDING" },
-            { fieldPath: `data.${field}`, order: "ASCENDING" }
-          ]
-        });
-      }
-    }
-    for (const [, entity] of entities.edges) {
-      const fields = extractSchemaFields(entity.schema);
-      for (const field of fields) {
-        indexes.push({
-          collectionGroup: collection,
-          queryScope: "COLLECTION",
-          fields: [
-            { fieldPath: "aUid", order: "ASCENDING" },
-            { fieldPath: "axbType", order: "ASCENDING" },
-            { fieldPath: `data.${field}`, order: "ASCENDING" }
-          ]
-        });
-      }
+function toFirestoreFields(spec) {
+  return spec.fields.map((f) => {
+    const n = normalizeField(f);
+    return {
+      fieldPath: n.path,
+      order: n.desc ? "DESCENDING" : "ASCENDING"
+    };
+  });
+}
+var warnedOnPartialIndex = false;
+function generateIndexConfig(collection, options = {}) {
+  const core = options.coreIndexes ?? [...DEFAULT_CORE_INDEXES];
+  const fromEntries = (options.registryEntries ?? []).flatMap((e) => {
+    if (!e.indexes) return [];
+    return e.indexes;
+  });
+  const targetGraphNames = /* @__PURE__ */ new Set();
+  for (const entry of options.registryEntries ?? []) {
+    if (entry.targetGraph) targetGraphNames.add(entry.targetGraph);
+  }
+  if (options.entities) {
+    for (const [, entity] of options.entities.edges) {
+      const tg = entity.targetGraph ?? entity.topology?.targetGraph;
+      if (tg) targetGraphNames.add(tg);
     }
   }
-  if (registryEntries) {
-    const targetGraphNames = /* @__PURE__ */ new Set();
-    for (const entry of registryEntries) {
-      if (entry.targetGraph) {
-        targetGraphNames.add(entry.targetGraph);
+  const allSpecs = [...core, ...fromEntries];
+  const seen = /* @__PURE__ */ new Set();
+  const indexes = [];
+  for (const spec of allSpecs) {
+    if (!spec.fields || spec.fields.length < 2) {
+      continue;
+    }
+    if (spec.where) {
+      if (!warnedOnPartialIndex) {
+        warnedOnPartialIndex = true;
+        console.warn(
+          "firegraph: IndexSpec.where is ignored by the Firestore generator \u2014 Firestore composite indexes do not support predicates. The SQLite backends will still honor `where`."
+        );
       }
+      continue;
     }
-    for (const name of targetGraphNames) {
-      indexes.push(...collectionGroupIndexes(name));
+    const fields = toFirestoreFields(spec);
+    const colKey = specFingerprint(spec, `col:${collection}`);
+    if (!seen.has(colKey)) {
+      seen.add(colKey);
+      indexes.push({
+        collectionGroup: collection,
+        queryScope: "COLLECTION",
+        fields
+      });
+    }
+    for (const tg of targetGraphNames) {
+      const cgKey = specFingerprint(spec, `cg:${tg}`);
+      if (seen.has(cgKey)) continue;
+      seen.add(cgKey);
+      indexes.push({
+        collectionGroup: tg,
+        queryScope: "COLLECTION_GROUP",
+        fields
+      });
     }
   }
   return { indexes, fieldOverrides: [] };
@@ -3433,6 +3389,7 @@ function defineViews(input) {
 0 && (module.exports = {
   BOOTSTRAP_ENTRIES,
   CrossBackendTransactionError,
+  DEFAULT_CORE_INDEXES,
   DEFAULT_QUERY_LIMIT,
   DiscoveryError,
   DynamicRegistryError,