js-bao 0.3.0 → 0.3.1

package/dist/node.js

@@ -1163,6 +1163,19 @@ var init_DocumentQueryTranslator = __esm({
 
 // src/models/metaSync.ts
 import * as Y from "yjs";
+function inferFieldType(value) {
+  if (value instanceof Y.Map) return "stringset";
+  switch (typeof value) {
+    case "string":
+      return "string";
+    case "number":
+      return "number";
+    case "boolean":
+      return "boolean";
+    default:
+      return null;
+  }
+}
 function registerFunctionDefault(fn, name) {
   KNOWN_FUNCTION_DEFAULTS.set(fn, name);
 }
@@ -1174,6 +1187,11 @@ function encodeDefault(value) {
   }
   return value;
 }
+function clearMetaSyncCache(yDoc) {
+  if (yDoc) {
+    _syncedCache.delete(yDoc);
+  }
+}
 function syncModelMeta(yDoc, modelName, schema) {
   let synced = _syncedCache.get(yDoc);
   if (synced?.has(modelName)) return;
@@ -1249,6 +1267,23 @@ function syncRelationshipMeta(relsMap, relName, relConfig) {
     }
   }
 }
+function syncInferredMeta(yDoc, modelName, recordData) {
+  const meta = yDoc.getMap(`_meta_${modelName}`);
+  for (const [fieldName, value] of Object.entries(recordData)) {
+    if (fieldName.startsWith("_")) continue;
+    let fieldMeta = meta.get(fieldName);
+    if (!fieldMeta) {
+      fieldMeta = new Y.Map();
+      meta.set(fieldName, fieldMeta);
+    }
+    if (!fieldMeta.has("type")) {
+      const inferredType = inferFieldType(value);
+      if (inferredType) {
+        fieldMeta.set("type", inferredType);
+      }
+    }
+  }
+}
 function setIfChanged(map, key, value) {
   if (map.get(key) !== value) {
     map.set(key, value);
@@ -7127,17 +7162,344 @@ function attachAndRegisterModel(modelClass, schema) {
   autoRegisterModel(modelClass, runtimeShape);
 }
 
-// src/utils/yDocDump.ts
+// src/utils/yDocSchema.ts
 import * as Y3 from "yjs";
+function discoverSchema(yDoc) {
+  const models = {};
+  const metaNames = /* @__PURE__ */ new Set();
+  for (const key of yDoc.share.keys()) {
+    if (!key.startsWith("_meta_")) continue;
+    const map = materializeMap(yDoc, key);
+    if (!map) continue;
+    const modelName = key.slice("_meta_".length);
+    metaNames.add(modelName);
+    models[modelName] = readModelMeta(map);
+  }
+  for (const key of yDoc.share.keys()) {
+    if (key.startsWith("_")) continue;
+    if (metaNames.has(key)) continue;
+    const map = materializeMap(yDoc, key);
+    if (!map || map.size === 0) continue;
+    const inferred = inferModelFromData(map);
+    if (inferred) models[key] = inferred;
+  }
+  return { models };
+}
+function discoverModelNames(yDoc) {
+  const names = [];
+  for (const key of yDoc.share.keys()) {
+    if (key.startsWith("_")) continue;
+    const map = materializeMap(yDoc, key);
+    if (map) names.push(key);
+  }
+  return names.sort();
+}
+function materializeMap(yDoc, key) {
+  try {
+    const map = yDoc.getMap(key);
+    return map instanceof Y3.Map ? map : null;
+  } catch {
+    return null;
+  }
+}
+function readModelMeta(metaMap) {
+  const fields = {};
+  let constraints;
+  let relationships;
+  for (const [key, value] of metaMap.entries()) {
+    if (key === "_constraints" && value instanceof Y3.Map) {
+      constraints = readConstraints(value);
+    } else if (key === "_relationships" && value instanceof Y3.Map) {
+      relationships = readRelationships(value);
+    } else if (value instanceof Y3.Map) {
+      fields[key] = readFieldMeta(value);
+    }
+  }
+  const model = { fields };
+  if (constraints && Object.keys(constraints).length > 0) {
+    model.constraints = constraints;
+  }
+  if (relationships && Object.keys(relationships).length > 0) {
+    model.relationships = relationships;
+  }
+  return model;
+}
+function readFieldMeta(fieldMap) {
+  const field = { type: fieldMap.get("type") ?? "unknown" };
+  if (fieldMap.get("indexed") === true) field.indexed = true;
+  if (fieldMap.get("unique") === true) field.unique = true;
+  if (fieldMap.get("required") === true) field.required = true;
+  if (fieldMap.get("autoAssign") === true) field.autoAssign = true;
+  const def = fieldMap.get("default");
+  if (def !== void 0) field.default = def;
+  const maxLength = fieldMap.get("maxLength");
+  if (maxLength !== void 0) field.maxLength = maxLength;
+  const maxCount = fieldMap.get("maxCount");
+  if (maxCount !== void 0) field.maxCount = maxCount;
+  return field;
+}
+function inferModelFromData(dataMap) {
+  const fields = {};
+  let sampled = 0;
+  for (const [_recordId, recordValue] of dataMap.entries()) {
+    if (!(recordValue instanceof Y3.Map)) continue;
+    if (++sampled > 5) break;
+    for (const [fieldName, value] of recordValue.entries()) {
+      if (fieldName.startsWith("_")) continue;
+      if (fields[fieldName]) continue;
+      const type = inferTypeFromValue(value);
+      if (type) fields[fieldName] = { type };
+    }
+  }
+  if (Object.keys(fields).length === 0) return null;
+  return { fields };
+}
+function inferTypeFromValue(value) {
+  if (value instanceof Y3.Map) return "stringset";
+  switch (typeof value) {
+    case "string":
+      return "string";
+    case "number":
+      return "number";
+    case "boolean":
+      return "boolean";
+    default:
+      return null;
+  }
+}
+function readConstraints(constraintsMap) {
+  const out = {};
+  for (const [name, value] of constraintsMap.entries()) {
+    if (!(value instanceof Y3.Map)) continue;
+    let fields = [];
+    const rawFields = value.get("fields");
+    if (typeof rawFields === "string") {
+      try {
+        fields = JSON.parse(rawFields);
+      } catch {
+      }
+    }
+    out[name] = {
+      type: value.get("type") ?? "unknown",
+      fields
+    };
+  }
+  return out;
+}
+function readRelationships(relsMap) {
+  const out = {};
+  for (const [name, value] of relsMap.entries()) {
+    if (!(value instanceof Y3.Map)) continue;
+    const rel = {};
+    for (const [k, v] of value.entries()) {
+      rel[k] = v;
+    }
+    out[name] = rel;
+  }
+  return out;
+}
+var CAMEL_TO_SNAKE = {
+  autoAssign: "auto_assign",
+  maxLength: "max_length",
+  maxCount: "max_count",
+  relatedIdField: "related_id_field",
+  joinModel: "join_model",
+  joinModelLocalField: "join_model_local_field",
+  joinModelRelatedField: "join_model_related_field",
+  joinModelOrderByField: "join_model_order_by_field",
+  joinModelOrderDirection: "join_model_order_direction",
+  orderByField: "order_by_field",
+  orderDirection: "order_direction"
+};
+function toSnake(key) {
+  return CAMEL_TO_SNAKE[key] ?? key;
+}
+function tomlValue(v) {
+  if (typeof v === "string") {
+    return `"${v.replace(/\\/g, "\\\\").replace(/"/g, '\\"').replace(/\n/g, "\\n").replace(/\r/g, "\\r").replace(/\t/g, "\\t")}"`;
+  }
+  return String(v);
+}
+function schemaToToml(schema) {
+  const lines = [];
+  for (const [modelName, model] of Object.entries(schema.models)) {
+    if (lines.length > 0) lines.push("", "");
+    lines.push(`[models.${modelName}]`);
+    for (const [fieldName, field] of Object.entries(model.fields)) {
+      lines.push("");
+      lines.push(`[models.${modelName}.fields.${fieldName}]`);
+      lines.push(`type = ${tomlValue(field.type)}`);
+      if (field.autoAssign) lines.push("auto_assign = true");
+      if (field.indexed) lines.push("indexed = true");
+      if (field.unique) lines.push("unique = true");
+      if (field.required) lines.push("required = true");
+      if (field.maxLength !== void 0) lines.push(`max_length = ${field.maxLength}`);
+      if (field.maxCount !== void 0) lines.push(`max_count = ${field.maxCount}`);
+      if (field.default !== void 0) lines.push(`default = ${tomlValue(field.default)}`);
+    }
+    if (model.relationships) {
+      for (const [relName, rel] of Object.entries(model.relationships)) {
+        lines.push("");
+        lines.push(`[models.${modelName}.relationships.${relName}]`);
+        for (const [k, v] of Object.entries(rel)) {
+          if (v === void 0) continue;
+          lines.push(`${toSnake(k)} = ${tomlValue(v)}`);
+        }
+      }
+    }
+    if (model.constraints) {
+      for (const [cName, c] of Object.entries(model.constraints)) {
+        lines.push("");
+        lines.push(`[[models.${modelName}.unique_constraints]]`);
+        lines.push(`name = ${tomlValue(cName)}`);
+        lines.push(`fields = [${c.fields.map((f) => tomlValue(f)).join(", ")}]`);
+      }
+    }
+  }
+  lines.push("");
+  return lines.join("\n");
+}
+
+// src/models/tomlLoader.ts
+import { parse as parseToml } from "smol-toml";
+var VALID_FIELD_TYPES = /* @__PURE__ */ new Set([
+  "string",
+  "number",
+  "boolean",
+  "date",
+  "id",
+  "stringset"
+]);
+function parseFieldOptions(raw) {
+  if (!raw.type || !VALID_FIELD_TYPES.has(raw.type)) {
+    throw new Error(
+      `Invalid field type "${raw.type}". Must be one of: ${[...VALID_FIELD_TYPES].join(", ")}`
+    );
+  }
+  const opts = { type: raw.type };
+  if (raw.indexed === true) opts.indexed = true;
+  if (raw.unique === true) opts.unique = true;
+  if (raw.required === true) opts.required = true;
+  if (raw.auto_assign === true) opts.autoAssign = true;
+  if (raw.max_length !== void 0) opts.maxLength = raw.max_length;
+  if (raw.max_count !== void 0) opts.maxCount = raw.max_count;
+  if (raw.default !== void 0) opts.default = raw.default;
+  return opts;
+}
+function requireField(raw, field, context) {
+  if (!raw[field]) {
+    throw new Error(`Relationship ${context}: missing required field "${field}"`);
+  }
+}
+function parseRelationship(raw) {
+  const type = raw.type;
+  if (type === "refersTo") {
+    requireField(raw, "model", "refersTo");
+    requireField(raw, "related_id_field", "refersTo");
+    return {
+      type: "refersTo",
+      model: raw.model,
+      relatedIdField: raw.related_id_field
+    };
+  }
+  if (type === "hasMany") {
+    requireField(raw, "model", "hasMany");
+    requireField(raw, "related_id_field", "hasMany");
+    const rel = {
+      type: "hasMany",
+      model: raw.model,
+      relatedIdField: raw.related_id_field
+    };
+    if (raw.order_by_field) rel.orderByField = raw.order_by_field;
+    if (raw.order_direction) rel.orderDirection = raw.order_direction;
+    return rel;
+  }
+  if (type === "hasManyThrough") {
+    requireField(raw, "model", "hasManyThrough");
+    requireField(raw, "join_model", "hasManyThrough");
+    requireField(raw, "join_model_local_field", "hasManyThrough");
+    requireField(raw, "join_model_related_field", "hasManyThrough");
+    const rel = {
+      type: "hasManyThrough",
+      model: raw.model,
+      joinModel: raw.join_model,
+      joinModelLocalField: raw.join_model_local_field,
+      joinModelRelatedField: raw.join_model_related_field
+    };
+    if (raw.join_model_order_by_field)
+      rel.joinModelOrderByField = raw.join_model_order_by_field;
+    if (raw.join_model_order_direction)
+      rel.joinModelOrderDirection = raw.join_model_order_direction;
+    return rel;
+  }
+  throw new Error(`Unknown relationship type: ${type}`);
+}
+function loadSchemaFromTomlString(tomlString) {
+  const parsed = parseToml(tomlString);
+  const models = parsed.models;
+  if (!models || typeof models !== "object") {
+    throw new Error("TOML schema must have a [models] section");
+  }
+  const schemas = [];
+  for (const [modelName, modelDef] of Object.entries(models)) {
+    const fields = {};
+    if (modelDef.fields) {
+      for (const [fieldName, fieldDef] of Object.entries(modelDef.fields)) {
+        fields[fieldName] = parseFieldOptions(fieldDef);
+      }
+    }
+    let relationships;
+    if (modelDef.relationships) {
+      relationships = {};
+      for (const [relName, relDef] of Object.entries(
+        modelDef.relationships
+      )) {
+        relationships[relName] = parseRelationship(relDef);
+      }
+    }
+    let uniqueConstraints;
+    if (modelDef.unique_constraints) {
+      uniqueConstraints = [];
+      for (const raw of modelDef.unique_constraints) {
+        uniqueConstraints.push({
+          name: raw.name,
+          fields: [...raw.fields]
+        });
+      }
+    }
+    schemas.push(
+      defineModelSchema({
+        name: modelName,
+        fields,
+        options: {
+          uniqueConstraints,
+          relationships
+        }
+      })
+    );
+  }
+  return schemas;
+}
+async function loadSchemaFromToml(filePath) {
+  const { readFile } = await import("fs/promises");
+  const content = await readFile(filePath, "utf-8");
+  return loadSchemaFromTomlString(content);
+}
+
+// src/node.ts
+init_metaSync();
+
+// src/utils/yDocDump.ts
+import * as Y4 from "yjs";
 function toPlain(value) {
-  if (value instanceof Y3.Map) {
+  if (value instanceof Y4.Map) {
     const obj = {};
     value.forEach((v, k) => {
       obj[k] = toPlain(v);
     });
     return obj;
   }
-  if (value instanceof Y3.Array) {
+  if (value instanceof Y4.Array) {
     return value.toArray().map((item) => toPlain(item));
   }
   return value;
@@ -7146,7 +7508,7 @@ function dumpYDocToPlain(yDoc, options = {}) {
   const result = {};
   const includeIndexes = !!options.includeIndexes;
   yDoc.share.forEach((type, name) => {
-    if (!(type instanceof Y3.Map)) return;
+    if (!(type instanceof Y4.Map)) return;
     if (!includeIndexes && name.startsWith("_uniqueIdx_")) return;
     const records = {};
     type.forEach((recordValue, recordId) => {
@@ -7211,18 +7573,28 @@ export {
   attachAndRegisterModel,
   attachSchemaToClass,
   autoRegisterModel,
+  clearMetaSyncCache,
   constants,
   createModelClass,
   defineModelSchema,
   detectEnvironment,
+  discoverModelNames,
+  discoverSchema,
   dumpYDocToPlain,
   features,
   generateULID,
   getRecommendedNodeEngine,
+  inferFieldType,
   initJsBao,
   isBrowser,
   isNode,
   isNodeModuleAvailable,
+  loadSchemaFromToml,
+  loadSchemaFromTomlString,
+  registerFunctionDefault,
   resetJsBao,
-  summarizePlainYDoc
+  schemaToToml,
+  summarizePlainYDoc,
+  syncInferredMeta,
+  syncModelMeta
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-bao",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "A library providing data modeling capabilities which support live updates and queries.",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -56,17 +56,17 @@
   "scripts": {
     "build": "pnpm build:cli && pnpm codegen && rm -f dist/index.* dist/node.* dist/browser.* dist/cloudflare.* dist/cloudflare-do.* dist/client.* && pnpm build:main",
     "build:main": "pnpm build:browser && pnpm build:node && pnpm build:universal && pnpm build:cloudflare && pnpm build:cloudflare-do && pnpm build:client",
-    "build:browser": "tsup src/browser.ts --format esm,cjs --dts --platform browser --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --no-splitting",
+    "build:browser": "tsup src/browser.ts --format esm,cjs --dts --platform browser --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --external fs --no-splitting",
     "build:node": "tsup src/node.ts --format esm,cjs --dts --platform node --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --no-splitting",
     "build:universal": "tsup src/index.ts --format esm,cjs --dts --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --no-splitting",
-    "build:cloudflare": "tsup src/cloudflare.ts --format esm,cjs --dts --platform browser --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --no-splitting",
-    "build:cloudflare-do": "tsup src/cloudflare-do.ts --format esm,cjs --dts --platform neutral --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --no-splitting",
-    "build:client": "tsup src/client.ts --format esm,cjs --dts --platform browser --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --no-splitting",
+    "build:cloudflare": "tsup src/cloudflare.ts --format esm,cjs --dts --platform browser --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --external fs --no-splitting",
+    "build:cloudflare-do": "tsup src/cloudflare-do.ts --format esm,cjs --dts --platform neutral --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --external fs --no-splitting",
+    "build:client": "tsup src/client.ts --format esm,cjs --dts --platform browser --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --external fs --no-splitting",
     "build:cli": "tsup src/cli/codegen.ts --format cjs --dts --platform node --target node18 --external commander --external typescript --external fs --external path --external util --no-splitting",
     "dev": "pnpm build:cli && concurrently \"pnpm codegen:watch\" \"pnpm dev:main\"",
     "dev:main": "concurrently \"pnpm build:browser:dev --watch\" \"pnpm build:node:dev --watch\" \"pnpm build:universal:dev --watch\"",
     "dev:simple": "pnpm build:cli && pnpm codegen && pnpm build:main --watch",
-    "build:browser:dev": "tsup src/browser.ts --format esm,cjs --dts --sourcemap --platform browser --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs",
+    "build:browser:dev": "tsup src/browser.ts --format esm,cjs --dts --sourcemap --platform browser --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs --external fs",
     "build:node:dev": "tsup src/node.ts --format esm,cjs --dts --sourcemap --platform node --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs",
     "build:universal:dev": "tsup src/index.ts --format esm,cjs --dts --sourcemap --external better-sqlite3 --external sql.js --external async-mutex --external ulid --external yjs",
     "codegen": "./dist/codegen.cjs --config js-bao.config.cjs || echo 'Codegen skipped (likely in consumer project)'",