@onyx.dev/onyx-database 1.0.0 → 1.0.3

package/dist/index.cjs

@@ -69,7 +69,7 @@ function readEnv(targetId) {
   return res;
 }
 async function readProjectFile(databaseId) {
-  if (!isNode) return {};
+  if (!isNode) return { config: {} };
   const fs = await nodeImport("node:fs/promises");
   const path = await nodeImport("node:path");
   const cwd = gProcess?.cwd?.() ?? ".";
@@ -78,7 +78,7 @@ async function readProjectFile(databaseId) {
     const sanitized = txt.replace(/[\r\n]+/g, "");
     const json = dropUndefined(JSON.parse(sanitized));
     dbg("project file:", p, "\u2192", mask(json));
-    return json;
+    return { config: json, path: p };
   };
   if (databaseId) {
     const specific = path.resolve(cwd, `onyx-database-${databaseId}.json`);
@@ -93,11 +93,11 @@ async function readProjectFile(databaseId) {
     return await tryRead(fallback);
   } catch {
     dbg("project file not found:", fallback);
-    return {};
+    return { config: {} };
   }
 }
 async function readHomeProfile(databaseId) {
-  if (!isNode) return {};
+  if (!isNode) return { config: {} };
   const fs = await nodeImport("node:fs/promises");
   const os = await nodeImport("node:os");
   const path = await nodeImport("node:path");
@@ -117,7 +117,7 @@ async function readHomeProfile(databaseId) {
       const sanitized = txt.replace(/[\r\n]+/g, "");
       const json = dropUndefined(JSON.parse(sanitized));
       dbg("home profile used:", p, "\u2192", mask(json));
-      return json;
+      return { config: json, path: p };
     } catch (e) {
       const msg = e instanceof Error ? e.message : String(e);
       throw new OnyxConfigError(`Failed to read ${p}: ${msg}`);
@@ -136,7 +136,7 @@ async function readHomeProfile(databaseId) {
   dbg("no home-root fallback:", defaultInHome);
   if (!await fileExists(dir)) {
     dbg("~/.onyx does not exist:", dir);
-    return {};
+    return { config: {} };
   }
   const files = await fs.readdir(dir).catch(() => []);
   const matches2 = files.filter((f) => f.startsWith("onyx-database-") && f.endsWith(".json"));
@@ -150,10 +150,10 @@ async function readHomeProfile(databaseId) {
     );
   }
   dbg("no usable home profiles found in", dir);
-  return {};
+  return { config: {} };
 }
 async function readConfigPath(p) {
-  if (!isNode) return {};
+  if (!isNode) return { config: {} };
   const fs = await nodeImport("node:fs/promises");
   const path = await nodeImport("node:path");
   const cwd = gProcess?.cwd?.() ?? ".";
@@ -163,7 +163,7 @@ async function readConfigPath(p) {
     const sanitized = txt.replace(/[\r\n]+/g, "");
     const json = dropUndefined(JSON.parse(sanitized));
     dbg("config path:", resolved, "\u2192", mask(json));
-    return json;
+    return { config: json, path: resolved };
   } catch (e) {
     const msg = e instanceof Error ? e.message : String(e);
     throw new OnyxConfigError(`Failed to read ${resolved}: ${msg}`);
@@ -174,7 +174,8 @@ async function resolveConfig(input) {
   const env = readEnv(input?.databaseId);
   let cfgPath = {};
   if (configPath) {
-    cfgPath = await readConfigPath(configPath);
+    const cfgRes = await readConfigPath(configPath);
+    cfgPath = cfgRes.config;
   }
   const targetId = input?.databaseId ?? env.databaseId ?? cfgPath.databaseId;
   let haveDbId = !!(input?.databaseId ?? env.databaseId ?? cfgPath.databaseId);
@@ -182,14 +183,16 @@ async function resolveConfig(input) {
   let haveApiSecret = !!(input?.apiSecret ?? env.apiSecret ?? cfgPath.apiSecret);
   let project = {};
   if (!(haveDbId && haveApiKey && haveApiSecret)) {
-    project = await readProjectFile(targetId);
+    const projRes = await readProjectFile(targetId);
+    project = projRes.config;
     if (project.databaseId) haveDbId = true;
     if (project.apiKey) haveApiKey = true;
     if (project.apiSecret) haveApiSecret = true;
   }
   let home = {};
   if (!(haveDbId && haveApiKey && haveApiSecret)) {
-    home = await readHomeProfile(targetId);
+    const homeRes = await readHomeProfile(targetId);
+    home = homeRes.config;
   }
   const merged = {
     baseUrl: DEFAULT_BASE_URL,
@@ -208,6 +211,10 @@ async function resolveConfig(input) {
   const fetchImpl = merged.fetch ?? (typeof gfetch === "function" ? (u, i) => gfetch(u, i) : async () => {
     throw new OnyxConfigError("No fetch available; provide OnyxConfig.fetch");
   });
+  const retryConfig = input?.retry ?? env.retry ?? cfgPath.retry ?? project.retry ?? home.retry ?? {};
+  const retryEnabled = retryConfig.enabled ?? true;
+  const maxRetries = retryConfig.maxRetries ?? 3;
+  const retryInitialDelayMs = retryConfig.initialDelayMs ?? 300;
   const missing = [];
   if (!databaseId) missing.push("databaseId");
   if (!apiKey) missing.push("apiKey");
@@ -230,7 +237,16 @@ async function resolveConfig(input) {
       `Missing required config: ${missing.join(", ")}. Sources: ${sources.join(", ")}`
     );
   }
-  const resolved = { baseUrl, databaseId, apiKey, apiSecret, fetch: fetchImpl };
+  const resolved = {
+    baseUrl,
+    databaseId,
+    apiKey,
+    apiSecret,
+    fetch: fetchImpl,
+    retryEnabled,
+    maxRetries,
+    retryInitialDelayMs
+  };
   const source = {
     databaseId: input?.databaseId ? "explicit config" : env.databaseId ? "env" : cfgPath.databaseId ? "env ONYX_CONFIG_PATH" : project.databaseId ? "project file" : home.databaseId ? "home profile" : "unknown",
     apiKey: input?.apiKey ? "explicit config" : env.apiKey ? "env" : cfgPath.apiKey ? "env ONYX_CONFIG_PATH" : project.apiKey ? "project file" : home.apiKey ? "home profile" : "unknown",
@@ -287,7 +303,7 @@ function parseJsonAllowNaN(txt) {
     return JSON.parse(fixed);
   }
 }
-var HttpClient = class {
+var HttpClient = class _HttpClient {
   baseUrl;
   apiKey;
   apiSecret;
@@ -295,6 +311,25 @@ var HttpClient = class {
   defaults;
   requestLoggingEnabled;
   responseLoggingEnabled;
+  retryEnabled;
+  maxRetries;
+  retryInitialDelayMs;
+  shouldRetry;
+  static parseRetryAfter(header) {
+    if (!header) return null;
+    const trimmed = header.trim();
+    if (trimmed === "") return null;
+    const seconds = Number(trimmed);
+    if (Number.isFinite(seconds)) {
+      return Math.max(0, seconds * 1e3);
+    }
+    const dateMs = Date.parse(trimmed);
+    if (!Number.isNaN(dateMs)) {
+      const now = Date.now();
+      return Math.max(0, dateMs - now);
+    }
+    return null;
+  }
   constructor(opts) {
     if (!opts.baseUrl || opts.baseUrl.trim() === "") {
       throw new OnyxConfigError("baseUrl is required");
@@ -319,6 +354,10 @@ var HttpClient = class {
     const envDebug = globalThis.process?.env?.ONYX_DEBUG === "true";
     this.requestLoggingEnabled = !!opts.requestLoggingEnabled || envDebug;
     this.responseLoggingEnabled = !!opts.responseLoggingEnabled || envDebug;
+    this.retryEnabled = opts.retryEnabled ?? true;
+    this.maxRetries = Math.max(0, opts.maxRetries ?? 2);
+    this.retryInitialDelayMs = Math.max(0, opts.retryInitialDelayMs ?? 100);
+    this.shouldRetry = (method, path) => method === "GET" || path.startsWith("/query/");
   }
   headers(extra) {
     const extras = { ...extra ?? {} };
@@ -359,9 +398,8 @@ var HttpClient = class {
       headers,
       body: payload
     };
-    const isQuery = path.includes("/query/") && !/\/query\/(?:update|delete)\//.test(path);
-    const canRetry = method === "GET" || isQuery;
-    const maxAttempts = canRetry ? 3 : 1;
+    const canRetry = this.retryEnabled && this.shouldRetry(method, path);
+    const maxAttempts = canRetry ? this.maxRetries + 1 : 1;
     for (let attempt = 0; attempt < maxAttempts; attempt++) {
       try {
         const res = await this.fetchImpl(url, init);
@@ -379,7 +417,10 @@ var HttpClient = class {
         if (!res.ok) {
           const msg = typeof data === "object" && data !== null && "error" in data && typeof data.error?.message === "string" ? String(data.error.message) : `${res.status} ${res.statusText}`;
           if (canRetry && res.status >= 500 && attempt + 1 < maxAttempts) {
-            await new Promise((r) => setTimeout(r, 100 * 2 ** attempt));
+            const serverRetry = _HttpClient.parseRetryAfter(res.headers.get("retry-after"));
+            const backoff = this.retryInitialDelayMs * 2 ** attempt;
+            const delay = serverRetry ?? backoff;
+            await new Promise((r) => setTimeout(r, delay));
             continue;
           }
           throw new OnyxHttpError(msg, res.status, res.statusText, data, raw);
@@ -388,7 +429,8 @@ var HttpClient = class {
       } catch (err) {
         const retryable = canRetry && (!(err instanceof OnyxHttpError) || err.status >= 500);
         if (attempt + 1 < maxAttempts && retryable) {
-          await new Promise((r) => setTimeout(r, 100 * 2 ** attempt));
+          const delay = this.retryInitialDelayMs * 2 ** attempt;
+          await new Promise((r) => setTimeout(r, delay));
           continue;
         }
         throw err;
@@ -949,31 +991,196 @@ var CascadeRelationshipBuilder = class {
   }
 };
 
-// src/errors/onyx-error.ts
-var OnyxError = class extends Error {
-  name = "OnyxError";
-  constructor(message) {
-    super(message);
+// src/helpers/schema-diff.ts
+function mapByName(items) {
+  const map = /* @__PURE__ */ new Map();
+  for (const item of items ?? []) {
+    if (!item?.name) continue;
+    map.set(item.name, item);
+  }
+  return map;
+}
+function normalizeEntities(schema) {
+  if (Array.isArray(schema.entities)) {
+    return schema.entities ?? [];
+  }
+  const tables = schema.tables;
+  if (!Array.isArray(tables)) return [];
+  return tables.map((table) => ({
+    name: table.name,
+    attributes: table.attributes ?? []
+  }));
+}
+function normalizePartition(partition) {
+  if (partition == null) return "";
+  const trimmed = partition.trim();
+  return trimmed;
+}
+function identifiersEqual(a, b) {
+  if (!a && !b) return true;
+  if (!a || !b) return false;
+  return a.name === b.name && a.generator === b.generator && a.type === b.type;
+}
+function diffAttributes(apiAttrs, localAttrs) {
+  const apiMap = mapByName(apiAttrs);
+  const localMap = mapByName(localAttrs);
+  const added = [];
+  const removed = [];
+  const changed = [];
+  for (const [name, local] of localMap.entries()) {
+    if (!apiMap.has(name)) {
+      added.push(local);
+      continue;
+    }
+    const api = apiMap.get(name);
+    const apiNull = Boolean(api.isNullable);
+    const localNull = Boolean(local.isNullable);
+    if (api.type !== local.type || apiNull !== localNull) {
+      changed.push({
+        name,
+        from: { type: api.type, isNullable: apiNull },
+        to: { type: local.type, isNullable: localNull }
+      });
+    }
   }
-};
-
-// src/impl/onyx.ts
-var DEFAULT_CACHE_TTL = 5 * 60 * 1e3;
-var cachedCfg = null;
-function resolveConfigWithCache(config) {
-  const ttl = config?.ttl ?? DEFAULT_CACHE_TTL;
-  const now = Date.now();
-  if (cachedCfg && cachedCfg.expires > now) {
-    return cachedCfg.promise;
-  }
-  const { ttl: _ttl, requestLoggingEnabled: _reqLog, responseLoggingEnabled: _resLog, ...rest } = config ?? {};
-  const promise = resolveConfig(rest);
-  cachedCfg = { promise, expires: now + ttl };
-  return promise;
+  for (const name of apiMap.keys()) {
+    if (!localMap.has(name)) removed.push(name);
+  }
+  added.sort((a, b) => a.name.localeCompare(b.name));
+  removed.sort();
+  changed.sort((a, b) => a.name.localeCompare(b.name));
+  if (!added.length && !removed.length && !changed.length) return null;
+  return { added, removed, changed };
 }
-function clearCacheConfig() {
-  cachedCfg = null;
+function diffIndexes(apiIndexes, localIndexes) {
+  const apiMap = mapByName(apiIndexes);
+  const localMap = mapByName(localIndexes);
+  const added = [];
+  const removed = [];
+  const changed = [];
+  for (const [name, local] of localMap.entries()) {
+    if (!apiMap.has(name)) {
+      added.push(local);
+      continue;
+    }
+    const api = apiMap.get(name);
+    const apiType = api.type ?? "DEFAULT";
+    const localType = local.type ?? "DEFAULT";
+    const apiScore = api.minimumScore;
+    const localScore = local.minimumScore;
+    if (apiType !== localType || apiScore !== localScore) {
+      changed.push({ name, from: api, to: local });
+    }
+  }
+  for (const name of apiMap.keys()) {
+    if (!localMap.has(name)) removed.push(name);
+  }
+  added.sort((a, b) => a.name.localeCompare(b.name));
+  removed.sort();
+  changed.sort((a, b) => a.name.localeCompare(b.name));
+  if (!added.length && !removed.length && !changed.length) return null;
+  return { added, removed, changed };
+}
+function diffResolvers(apiResolvers, localResolvers) {
+  const apiMap = mapByName(apiResolvers);
+  const localMap = mapByName(localResolvers);
+  const added = [];
+  const removed = [];
+  const changed = [];
+  for (const [name, local] of localMap.entries()) {
+    if (!apiMap.has(name)) {
+      added.push(local);
+      continue;
+    }
+    const api = apiMap.get(name);
+    if (api.resolver !== local.resolver) {
+      changed.push({ name, from: api, to: local });
+    }
+  }
+  for (const name of apiMap.keys()) {
+    if (!localMap.has(name)) removed.push(name);
+  }
+  added.sort((a, b) => a.name.localeCompare(b.name));
+  removed.sort();
+  changed.sort((a, b) => a.name.localeCompare(b.name));
+  if (!added.length && !removed.length && !changed.length) return null;
+  return { added, removed, changed };
 }
+function diffTriggers(apiTriggers, localTriggers) {
+  const apiMap = mapByName(apiTriggers);
+  const localMap = mapByName(localTriggers);
+  const added = [];
+  const removed = [];
+  const changed = [];
+  for (const [name, local] of localMap.entries()) {
+    if (!apiMap.has(name)) {
+      added.push(local);
+      continue;
+    }
+    const api = apiMap.get(name);
+    if (api.event !== local.event || api.trigger !== local.trigger) {
+      changed.push({ name, from: api, to: local });
+    }
+  }
+  for (const name of apiMap.keys()) {
+    if (!localMap.has(name)) removed.push(name);
+  }
+  added.sort((a, b) => a.name.localeCompare(b.name));
+  removed.sort();
+  changed.sort((a, b) => a.name.localeCompare(b.name));
+  if (!added.length && !removed.length && !changed.length) return null;
+  return { added, removed, changed };
+}
+function computeSchemaDiff(apiSchema, localSchema) {
+  const apiEntities = normalizeEntities(apiSchema);
+  const localEntities = normalizeEntities(localSchema);
+  const apiMap = mapByName(apiEntities);
+  const localMap = mapByName(localEntities);
+  const newTables = [];
+  const removedTables = [];
+  const changedTables = [];
+  for (const [name, localEntity] of localMap.entries()) {
+    if (!apiMap.has(name)) {
+      newTables.push(name);
+      continue;
+    }
+    const apiEntity = apiMap.get(name);
+    const tableDiff = { name };
+    const partitionFrom = normalizePartition(apiEntity.partition);
+    const partitionTo = normalizePartition(localEntity.partition);
+    if (partitionFrom !== partitionTo) {
+      tableDiff.partition = { from: partitionFrom || null, to: partitionTo || null };
+    }
+    if (!identifiersEqual(apiEntity.identifier, localEntity.identifier)) {
+      tableDiff.identifier = {
+        from: apiEntity.identifier ?? null,
+        to: localEntity.identifier ?? null
+      };
+    }
+    const attrs = diffAttributes(apiEntity.attributes, localEntity.attributes);
+    if (attrs) tableDiff.attributes = attrs;
+    const indexes = diffIndexes(apiEntity.indexes, localEntity.indexes);
+    if (indexes) tableDiff.indexes = indexes;
+    const resolvers = diffResolvers(apiEntity.resolvers, localEntity.resolvers);
+    if (resolvers) tableDiff.resolvers = resolvers;
+    const triggers = diffTriggers(apiEntity.triggers, localEntity.triggers);
+    if (triggers) tableDiff.triggers = triggers;
+    const hasChange = tableDiff.partition || tableDiff.identifier || tableDiff.attributes || tableDiff.indexes || tableDiff.resolvers || tableDiff.triggers;
+    if (hasChange) {
+      changedTables.push(tableDiff);
+    }
+  }
+  for (const name of apiMap.keys()) {
+    if (!localMap.has(name)) removedTables.push(name);
+  }
+  newTables.sort();
+  removedTables.sort();
+  changedTables.sort((a, b) => a.name.localeCompare(b.name));
+  return { newTables, removedTables, changedTables };
+}
+
+// src/impl/onyx-core.ts
+var DEFAULT_CACHE_TTL = 5 * 60 * 1e3;
 function toSingleCondition(criteria) {
   return { conditionType: "SingleCondition", criteria };
 }
@@ -1027,7 +1234,20 @@ function normalizeDate(value) {
   return Number.isNaN(ts.getTime()) ? void 0 : ts;
 }
 function normalizeSchemaRevision(input, fallbackDatabaseId) {
-  const { meta, createdAt, publishedAt, revisionId, entityText, ...rest } = input;
+  const {
+    meta,
+    createdAt,
+    publishedAt,
+    revisionId,
+    entityText,
+    databaseId,
+    entities,
+    revisionDescription,
+    ...rest
+  } = input;
+  const dbId = typeof databaseId === "string" ? databaseId : fallbackDatabaseId;
+  const entityList = Array.isArray(entities) ? entities : [];
+  const revisionDesc = typeof revisionDescription === "string" ? revisionDescription : void 0;
   const mergedMeta = {
     revisionId: meta?.revisionId ?? revisionId,
     createdAt: normalizeDate(meta?.createdAt ?? createdAt),
@@ -1035,10 +1255,11 @@ function normalizeSchemaRevision(input, fallbackDatabaseId) {
   };
   const cleanedMeta = mergedMeta.revisionId || mergedMeta.createdAt || mergedMeta.publishedAt ? mergedMeta : void 0;
   return {
-    ...rest,
-    databaseId: input.databaseId ?? fallbackDatabaseId,
+    databaseId: dbId,
+    revisionDescription: revisionDesc,
+    entities: entityList,
     meta: cleanedMeta,
-    entities: input.entities ?? []
+    ...rest
   };
 }
 var OnyxDatabaseImpl = class {
@@ -1049,7 +1270,7 @@ var OnyxDatabaseImpl = class {
   requestLoggingEnabled;
   responseLoggingEnabled;
   defaultPartition;
-  constructor(config) {
+  constructor(config, resolveConfigWithCache) {
     this.requestLoggingEnabled = !!config?.requestLoggingEnabled;
     this.responseLoggingEnabled = !!config?.responseLoggingEnabled;
     this.defaultPartition = config?.partition;
@@ -1066,7 +1287,10 @@ var OnyxDatabaseImpl = class {
         apiSecret: this.resolved.apiSecret,
         fetchImpl: this.resolved.fetch,
         requestLoggingEnabled: this.requestLoggingEnabled,
-        responseLoggingEnabled: this.responseLoggingEnabled
+        responseLoggingEnabled: this.responseLoggingEnabled,
+        retryEnabled: this.resolved.retryEnabled,
+        maxRetries: this.resolved.maxRetries,
+        retryInitialDelayMs: this.resolved.retryInitialDelayMs
       });
     }
     return {
@@ -1150,7 +1374,8 @@ var OnyxDatabaseImpl = class {
     const path = `/data/${encodeURIComponent(databaseId)}/${encodeURIComponent(
       table
     )}/${encodeURIComponent(primaryKey)}${params.toString() ? `?${params.toString()}` : ""}`;
-    return http.request("DELETE", path);
+    await http.request("DELETE", path);
+    return true;
   }
   async saveDocument(doc) {
     const { http, databaseId } = await this.ensureClient();
@@ -1193,6 +1418,10 @@ var OnyxDatabaseImpl = class {
     const res = await http.request("GET", path);
     return Array.isArray(res) ? res.map((entry) => normalizeSchemaRevision(entry, databaseId)) : [];
   }
+  async diffSchema(localSchema) {
+    const apiSchema = await this.getSchema();
+    return computeSchemaDiff(apiSchema, localSchema);
+  }
   async updateSchema(schema, options) {
     const { http, databaseId } = await this.ensureClient();
     const params = new URLSearchParams();
@@ -1526,7 +1755,6 @@ var QueryBuilderImpl = class {
   }
   async firstOrNull() {
     if (this.mode !== "select") throw new Error("Cannot call firstOrNull() in update mode.");
-    if (!this.conditions) throw new OnyxError("firstOrNull() requires a where() clause.");
     this.limitValue = 1;
     const pg = await this.page();
     return Array.isArray(pg.records) && pg.records.length > 0 ? pg.records[0] : null;
@@ -1618,12 +1846,32 @@ var CascadeBuilderImpl = class {
     return this.db.delete(table, primaryKey, opts);
   }
 };
-var onyx = {
-  init(config) {
-    return new OnyxDatabaseImpl(config);
-  },
-  clearCacheConfig
-};
+function createOnyxFacade(resolveConfig2) {
+  let cachedCfg = null;
+  function resolveConfigWithCache(config) {
+    const ttl = config?.ttl ?? DEFAULT_CACHE_TTL;
+    const now = Date.now();
+    if (cachedCfg && cachedCfg.expires > now) {
+      return cachedCfg.promise;
+    }
+    const { ttl: _ttl, requestLoggingEnabled: _reqLog, responseLoggingEnabled: _resLog, ...rest } = config ?? {};
+    const promise = resolveConfig2(rest);
+    cachedCfg = { promise, expires: now + ttl };
+    return promise;
+  }
+  function clearCacheConfig() {
+    cachedCfg = null;
+  }
+  return {
+    init(config) {
+      return new OnyxDatabaseImpl(config, resolveConfigWithCache);
+    },
+    clearCacheConfig
+  };
+}
+
+// src/impl/onyx.ts
+var onyx = createOnyxFacade((config) => resolveConfig(config));
 
 // src/helpers/sort.ts
 var asc = (field) => ({ field, order: "ASC" });