@oddington/sdk 0.1.10 → 0.1.11

package/dist/browser.js

@@ -726,22 +726,41 @@ function historyProperties(value) {
   let descriptors = Object.getOwnPropertyDescriptors(value);
   return Reflect.ownKeys(value).some((key) => typeof key != "string" || !descriptors[key]?.enumerable || !Object.hasOwn(descriptors[key], "value")) ? invalid() : descriptors;
 }
-function captureHistoryListOptions(value) {
-  if (value === void 0) return {};
-  let descriptors = historyProperties(value), result2 = {};
-  if (Object.keys(descriptors).some((key) => !["limit", "before"].includes(key))) return invalid();
-  if (Object.hasOwn(descriptors, "limit")) {
-    let limit = descriptors.limit.value;
-    if (!Number.isInteger(limit) || limit < 1 || limit > 100) return invalid();
-    result2.limit = limit;
+var historyCollection = (value) => typeof value == "string" && value.length <= 512 && /^[_a-zA-Z0-9][a-zA-Z0-9_-]*$/.test(value), historyCursor = (value) => typeof value == "string" && value.length <= 128 * 1024 && /^history-cursor-v1\.[A-Za-z0-9_-]{1,64}\.[A-Za-z0-9_-]{16}\.[A-Za-z0-9_-]+$/.test(value);
+function historyArray(value) {
+  if (!Array.isArray(value) || Object.getPrototypeOf(value) !== Array.prototype) return invalid();
+  let descriptors = Object.getOwnPropertyDescriptors(value);
+  if (Reflect.ownKeys(value).length !== value.length + 1) return invalid();
+  let result2 = [];
+  for (let i = 0; i < value.length; i++) {
+    let descriptor2 = descriptors[i];
+    if (!descriptor2?.enumerable || !Object.hasOwn(descriptor2, "value")) return invalid();
+    result2.push(descriptor2.value);
   }
-  if (Object.hasOwn(descriptors, "before")) {
-    let before = descriptors.before.value;
-    if (!historyVersion(before)) return invalid();
-    result2.before = before;
+  return result2;
+}
+function captureOptions(value, changes) {
+  if (value === void 0) return {};
+  let descriptors = historyProperties(value), result2 = {}, allowed = changes ? ["collections", "refs", "from", "through", "limit", "after"] : ["limit", "before"];
+  if (Object.keys(descriptors).some((key) => !allowed.includes(key))) return invalid();
+  for (let key of allowed) {
+    if (!Object.hasOwn(descriptors, key)) continue;
+    let scalar = descriptors[key].value;
+    if (key === "collections" || key === "refs") {
+      let values = historyArray(scalar);
+      if (!values.length || values.length > (key === "collections" ? 16 : 100) || !values.every(key === "collections" ? historyCollection : validRecordRef) || new Set(values).size !== values.length) return invalid();
+      result2[key] = values;
+    } else if (key === "limit") {
+      if (!Number.isInteger(scalar) || scalar < 1 || scalar > (changes ? 500 : 100)) return invalid();
+      result2.limit = scalar;
+    } else {
+      if (!(key === "after" ? historyCursor(scalar) : historyVersion(scalar))) return invalid();
+      result2[key] = scalar;
+    }
   }
   return result2;
 }
+var captureHistoryListOptions = (value) => captureOptions(value, !1), captureHistoryChangesOptions = (value) => captureOptions(value, !0);
 function captureHistoryInstant(value) {
   if (!historyText(value) || value.length > 1024) return invalid();
   let match = /^(\d{4})-(\d{2})-(\d{2})[Tt](\d{2}):(\d{2}):(\d{2})(?:\.\d+)?([Zz]|([+-])(\d{2}):(\d{2}))$/.exec(value);
@@ -785,7 +804,11 @@ var DATA_REQUEST_LIMIT = 256 * 1024, invalidChange = () => {
   throw new DataOperationError("invalid_change", !1, "unapplied");
 };
 function mapping(value) {
-  return !value || typeof value != "object" || Array.isArray(value) || ![Object.prototype, null].includes(Object.getPrototypeOf(value)) || Reflect.ownKeys(value).some((key) => typeof key != "string" || !Object.getOwnPropertyDescriptor(value, key)?.enumerable || !Object.hasOwn(Object.getOwnPropertyDescriptor(value, key), "value")) ? invalidChange() : value;
+  try {
+    return historyProperties(value), value;
+  } catch {
+    return invalidChange();
+  }
 }
 function captureValue(value, ancestors = /* @__PURE__ */ new Set(), depth = 0) {
   if (value === null || typeof value == "string" || typeof value == "boolean" || typeof value == "number" && Number.isFinite(value)) return value;
@@ -805,13 +828,18 @@ function captureDataUpdate(record2, set) {
   let identity = captureDataDelete(record2), fields3 = mapping(set);
   return !Object.keys(fields3).length || Object.keys(fields3).some((key) => key.startsWith("$") || ["id", "type"].includes(key)) ? invalidChange() : { ...identity, set: captureValue(fields3) };
 }
-function captureDataUpdates(value, allowEmpty = !1) {
+function captureIdentities(value, update, allowEmpty = !0) {
   if (!Array.isArray(value) || !allowEmpty && !value.length || value.length > 1e4) return invalidChange();
-  let updates = value.map((item) => {
+  let captured = value.map((item) => {
     let row = mapping(item);
-    return Object.keys(row).sort().join(",") !== "expectedVersion,ref,set" ? invalidChange() : captureDataUpdate({ $ref: row.ref, $version: row.expectedVersion }, row.set);
+    if (Object.keys(row).sort().join(",") !== (update ? "expectedVersion,ref,set" : "expectedVersion,ref")) return invalidChange();
+    let identity = { $ref: row.ref, $version: row.expectedVersion };
+    return update ? captureDataUpdate(identity, row.set) : captureDataDelete(identity);
   });
-  return new Set(updates.map((update) => update.ref)).size !== updates.length ? invalidChange() : updates;
+  return new Set(captured.map((item) => item.ref)).size !== captured.length ? invalidChange() : captured;
+}
+function captureDataUpdates(value, allowEmpty = !1) {
+  return captureIdentities(value, !0, allowEmpty);
 }
 function captureDataCreate(value) {
   let row = mapping(value);
@@ -834,12 +862,7 @@ function captureDataChanges(updatesValue, createsValue = [], deletesValue = [])
     if (Object.keys(row).some((key) => !["ref", "fields", "filing"].includes(key)) || !Object.hasOwn(row, "ref") || !Object.hasOwn(row, "fields")) return invalidChange();
     let fields3 = mapping(row.fields);
     return Object.keys(fields3).some((key) => key.startsWith("$")) ? invalidChange() : captureDataCreate({ ...fields3, $ref: row.ref, ...Object.hasOwn(row, "filing") ? { $filing: row.filing } : {} });
-  });
-  if (!Array.isArray(deletesValue) || deletesValue.length > 1e4) return invalidChange();
-  let deletes = deletesValue.map((item) => {
-    let row = mapping(item);
-    return Object.keys(row).sort().join(",") !== "expectedVersion,ref" ? invalidChange() : captureDataDelete({ $ref: row.ref, $version: row.expectedVersion });
-  }), refs = [...updates, ...creates, ...deletes].map((item) => item.ref);
+  }), deletes = captureIdentities(deletesValue, !1), refs = [...updates, ...creates, ...deletes].map((item) => item.ref);
   return !refs.length || refs.length > 1e4 || new Set(refs).size !== refs.length ? invalidChange() : { updates, creates, deletes };
 }
 function checkDataRequestSize(input) {
@@ -1053,15 +1076,14 @@ var data = {
       },
       history: {
         list: async (options) => send2({ operation: "history.list", options: captureHistoryListOptions(options) }),
-        at: async (instant) => send2({ operation: "history.at", instant: captureHistoryInstant(instant) })
+        at: async (instant) => send2({ operation: "history.at", instant: captureHistoryInstant(instant) }),
+        changes: async (options) => send2({ operation: "history.changes", options: captureHistoryChangesOptions(options) })
       },
       changes() {
-        let updates = [], creates = [], deletes = [], publicationId, pending, confirmed, snapshot = () => {
-          let captured = captureDataChanges(updates, creates, deletes), input = {
-            updates: captured.updates,
-            ...captured.creates.length ? { creates: captured.creates } : {},
-            ...captured.deletes.length ? { deletes: captured.deletes } : {}
-          };
+        let updates = [], creates = [], deletes = [], publicationId, pending, confirmed, assertMutable = () => {
+          if (publicationId) throw new DataOperationError("invalid_change", !1, "unapplied");
+        }, snapshot = (nextUpdates = updates, nextCreates = creates, nextDeletes = deletes) => {
+          let { updates: updates2, creates: creates2, deletes: deletes2 } = captureDataChanges(nextUpdates, nextCreates, nextDeletes), input = { updates: updates2, ...creates2.length ? { creates: creates2 } : {}, ...deletes2.length ? { deletes: deletes2 } : {} };
           return checkDataRequestSize({
             repository,
             operation: "changes.publish",
@@ -1071,40 +1093,19 @@ var data = {
         };
         return {
           create(record2) {
-            if (publicationId) throw new DataOperationError("invalid_change", !1, "unapplied");
+            assertMutable();
             let next = [...creates, captureDataCreate(record2)];
-            captureDataChanges(updates, next, deletes), checkDataRequestSize({
-              repository,
-              operation: "changes.publish",
-              updates,
-              creates: next,
-              ...deletes.length ? { deletes } : {},
-              publicationId: "00000000-0000-4000-8000-000000000000"
-            }), creates = next;
+            snapshot(updates, next, deletes), creates = next;
           },
           update(record2, set) {
-            if (publicationId) throw new DataOperationError("invalid_change", !1, "unapplied");
+            assertMutable();
             let next = [...updates, captureDataUpdate(record2, set)];
-            captureDataChanges(next, creates, deletes), checkDataRequestSize({
-              repository,
-              operation: "changes.publish",
-              updates: next,
-              ...creates.length ? { creates } : {},
-              ...deletes.length ? { deletes } : {},
-              publicationId: "00000000-0000-4000-8000-000000000000"
-            }), updates = next;
+            snapshot(next, creates, deletes), updates = next;
           },
           delete(record2) {
-            if (publicationId) throw new DataOperationError("invalid_change", !1, "unapplied");
+            assertMutable();
             let next = [...deletes, captureDataDelete(record2)];
-            captureDataChanges(updates, creates, next), checkDataRequestSize({
-              repository,
-              operation: "changes.publish",
-              updates,
-              deletes: next,
-              ...creates.length ? { creates } : {},
-              publicationId: "00000000-0000-4000-8000-000000000000"
-            }), deletes = next;
+            snapshot(updates, creates, next), deletes = next;
           },
           async validate() {
             await send2({ operation: "changes.validate", ...snapshot() });

package/dist/index.js

@@ -21725,26 +21725,53 @@ function historyProperties(value) {
     return invalid();
   return descriptors;
 }
-function captureHistoryListOptions(value) {
+var historyCollection = (value) => typeof value === "string" && value.length <= 512 && /^[_a-zA-Z0-9][a-zA-Z0-9_-]*$/.test(value);
+var historyCursor = (value) => typeof value === "string" && value.length <= 128 * 1024 && /^history-cursor-v1\.[A-Za-z0-9_-]{1,64}\.[A-Za-z0-9_-]{16}\.[A-Za-z0-9_-]+$/.test(value);
+function historyArray(value) {
+  if (!Array.isArray(value) || Object.getPrototypeOf(value) !== Array.prototype)
+    return invalid();
+  const descriptors = Object.getOwnPropertyDescriptors(value);
+  if (Reflect.ownKeys(value).length !== value.length + 1)
+    return invalid();
+  const result = [];
+  for (let i = 0;i < value.length; i++) {
+    const descriptor = descriptors[i];
+    if (!descriptor?.enumerable || !Object.hasOwn(descriptor, "value"))
+      return invalid();
+    result.push(descriptor.value);
+  }
+  return result;
+}
+function captureOptions(value, changes) {
   if (value === undefined)
     return {};
   const descriptors = historyProperties(value), result = {};
-  if (Object.keys(descriptors).some((key) => !["limit", "before"].includes(key)))
+  const allowed = changes ? ["collections", "refs", "from", "through", "limit", "after"] : ["limit", "before"];
+  if (Object.keys(descriptors).some((key) => !allowed.includes(key)))
     return invalid();
-  if (Object.hasOwn(descriptors, "limit")) {
-    const limit = descriptors.limit.value;
-    if (!Number.isInteger(limit) || limit < 1 || limit > 100)
-      return invalid();
-    result.limit = limit;
-  }
-  if (Object.hasOwn(descriptors, "before")) {
-    const before = descriptors.before.value;
-    if (!historyVersion(before))
-      return invalid();
-    result.before = before;
+  for (const key of allowed) {
+    if (!Object.hasOwn(descriptors, key))
+      continue;
+    const scalar = descriptors[key].value;
+    if (key === "collections" || key === "refs") {
+      const values = historyArray(scalar);
+      if (!values.length || values.length > (key === "collections" ? 16 : 100) || !values.every(key === "collections" ? historyCollection : validRecordRef) || new Set(values).size !== values.length)
+        return invalid();
+      result[key] = values;
+    } else if (key === "limit") {
+      if (!Number.isInteger(scalar) || scalar < 1 || scalar > (changes ? 500 : 100))
+        return invalid();
+      result.limit = scalar;
+    } else {
+      if (!(key === "after" ? historyCursor(scalar) : historyVersion(scalar)))
+        return invalid();
+      result[key] = scalar;
+    }
   }
   return result;
 }
+var captureHistoryListOptions = (value) => captureOptions(value, false);
+var captureHistoryChangesOptions = (value) => captureOptions(value, true);
 function captureHistoryInstant(value) {
   if (!historyText(value) || value.length > 1024)
     return invalid();
@@ -21805,11 +21832,12 @@ var invalidChange = () => {
   throw new DataOperationError("invalid_change", false, "unapplied");
 };
 function mapping(value) {
-  if (!value || typeof value !== "object" || Array.isArray(value) || ![Object.prototype, null].includes(Object.getPrototypeOf(value)))
-    return invalidChange();
-  if (Reflect.ownKeys(value).some((key) => typeof key !== "string" || !Object.getOwnPropertyDescriptor(value, key)?.enumerable || !Object.hasOwn(Object.getOwnPropertyDescriptor(value, key), "value")))
+  try {
+    historyProperties(value);
+    return value;
+  } catch {
     return invalidChange();
-  return value;
+  }
 }
 function captureValue(value, ancestors = new Set, depth = 0) {
   if (value === null || typeof value === "string" || typeof value === "boolean" || typeof value === "number" && Number.isFinite(value))
@@ -21844,18 +21872,22 @@ function captureDataUpdate(record2, set) {
     return invalidChange();
   return { ...identity, set: captureValue(fields3) };
 }
-function captureDataUpdates(value, allowEmpty = false) {
+function captureIdentities(value, update, allowEmpty = true) {
   if (!Array.isArray(value) || !allowEmpty && !value.length || value.length > 1e4)
     return invalidChange();
-  const updates = value.map((item) => {
+  const captured = value.map((item) => {
     const row = mapping(item);
-    if (Object.keys(row).sort().join(",") !== "expectedVersion,ref,set")
+    if (Object.keys(row).sort().join(",") !== (update ? "expectedVersion,ref,set" : "expectedVersion,ref"))
       return invalidChange();
-    return captureDataUpdate({ $ref: row.ref, $version: row.expectedVersion }, row.set);
+    const identity = { $ref: row.ref, $version: row.expectedVersion };
+    return update ? captureDataUpdate(identity, row.set) : captureDataDelete(identity);
   });
-  if (new Set(updates.map((update) => update.ref)).size !== updates.length)
+  if (new Set(captured.map((item) => item.ref)).size !== captured.length)
     return invalidChange();
-  return updates;
+  return captured;
+}
+function captureDataUpdates(value, allowEmpty = false) {
+  return captureIdentities(value, true, allowEmpty);
 }
 function captureDataCreate(value) {
   const row = mapping(value);
@@ -21884,14 +21916,7 @@ function captureDataChanges(updatesValue, createsValue = [], deletesValue = [])
       return invalidChange();
     return captureDataCreate({ ...fields3, $ref: row.ref, ...Object.hasOwn(row, "filing") ? { $filing: row.filing } : {} });
   });
-  if (!Array.isArray(deletesValue) || deletesValue.length > 1e4)
-    return invalidChange();
-  const deletes = deletesValue.map((item) => {
-    const row = mapping(item);
-    if (Object.keys(row).sort().join(",") !== "expectedVersion,ref")
-      return invalidChange();
-    return captureDataDelete({ $ref: row.ref, $version: row.expectedVersion });
-  });
+  const deletes = captureIdentities(deletesValue, false);
   const refs = [...updates, ...creates, ...deletes].map((item) => item.ref);
   if (!refs.length || refs.length > 1e4 || new Set(refs).size !== refs.length)
     return invalidChange();
@@ -22512,18 +22537,19 @@ var data = {
       },
       history: {
         list: async (options) => send({ operation: "history.list", options: captureHistoryListOptions(options) }),
-        at: async (instant) => send({ operation: "history.at", instant: captureHistoryInstant(instant) })
+        at: async (instant) => send({ operation: "history.at", instant: captureHistoryInstant(instant) }),
+        changes: async (options) => send({ operation: "history.changes", options: captureHistoryChangesOptions(options) })
       },
       changes() {
         let updates = [], creates = [], deletes = [], publicationId;
         let pending, confirmed;
-        const snapshot = () => {
-          const captured = captureDataChanges(updates, creates, deletes);
-          const input = {
-            updates: captured.updates,
-            ...captured.creates.length ? { creates: captured.creates } : {},
-            ...captured.deletes.length ? { deletes: captured.deletes } : {}
-          };
+        const assertMutable = () => {
+          if (publicationId)
+            throw new DataOperationError("invalid_change", false, "unapplied");
+        };
+        const snapshot = (nextUpdates = updates, nextCreates = creates, nextDeletes = deletes) => {
+          const { updates: updates2, creates: creates2, deletes: deletes2 } = captureDataChanges(nextUpdates, nextCreates, nextDeletes);
+          const input = { updates: updates2, ...creates2.length ? { creates: creates2 } : {}, ...deletes2.length ? { deletes: deletes2 } : {} };
           checkDataRequestSize({
             repository,
             operation: "changes.publish",
@@ -22534,48 +22560,21 @@ var data = {
         };
         return {
           create(record2) {
-            if (publicationId)
-              throw new DataOperationError("invalid_change", false, "unapplied");
+            assertMutable();
             const next = [...creates, captureDataCreate(record2)];
-            captureDataChanges(updates, next, deletes);
-            checkDataRequestSize({
-              repository,
-              operation: "changes.publish",
-              updates,
-              creates: next,
-              ...deletes.length ? { deletes } : {},
-              publicationId: "00000000-0000-4000-8000-000000000000"
-            });
+            snapshot(updates, next, deletes);
             creates = next;
           },
           update(record2, set) {
-            if (publicationId)
-              throw new DataOperationError("invalid_change", false, "unapplied");
+            assertMutable();
             const next = [...updates, captureDataUpdate(record2, set)];
-            captureDataChanges(next, creates, deletes);
-            checkDataRequestSize({
-              repository,
-              operation: "changes.publish",
-              updates: next,
-              ...creates.length ? { creates } : {},
-              ...deletes.length ? { deletes } : {},
-              publicationId: "00000000-0000-4000-8000-000000000000"
-            });
+            snapshot(next, creates, deletes);
             updates = next;
           },
           delete(record2) {
-            if (publicationId)
-              throw new DataOperationError("invalid_change", false, "unapplied");
+            assertMutable();
             const next = [...deletes, captureDataDelete(record2)];
-            captureDataChanges(updates, creates, next);
-            checkDataRequestSize({
-              repository,
-              operation: "changes.publish",
-              updates,
-              deletes: next,
-              ...creates.length ? { creates } : {},
-              publicationId: "00000000-0000-4000-8000-000000000000"
-            });
+            snapshot(updates, creates, next);
             deletes = next;
           },
           async validate() {

package/dist/types/packages/sdk/src/public.d.ts

@@ -13,7 +13,7 @@ export { AirtableOperationError } from '../../../shared/airtable-contract.js';
 export type { AirtableField, AirtableTable, AirtableRecord, AirtableListInput, AirtableGetInput, AirtableCreateInput, AirtableUpdateInput, AirtableDeleteInput, AirtableReceipt, AirtableWriteResult, AirtableClient, Connections } from '../../../shared/airtable-contract.js';
 export declare const connections: import('../../../shared/airtable-contract.js').Connections;
 export { DataOperationError } from '../../../shared/data-contract.js';
-export type { DataRepository, DataErrorCode, PublicValueDefinition, PublicField, CollectionSummary, CollectionSchema, QueryScalar, SelectionOptions, RecordSelection, RecordsQuery, DataValue, SelectedRecord, SelectionMetadata, RecordsResult, RecordsSearchOptions, RecordsSearchResult, HistoryListOptions, HistoryEntry, RecordIdentity, RecordCreation, RecordUpdateSet, DataPublication, DataChangeSet, DataEffect } from '../../../shared/data-contract.js';
+export type { DataRepository, DataErrorCode, PublicValueDefinition, PublicField, CollectionSummary, CollectionSchema, QueryScalar, SelectionOptions, RecordSelection, RecordsQuery, DataValue, SelectedRecord, SelectionMetadata, RecordsResult, RecordsSearchOptions, RecordsSearchResult, HistoryListOptions, HistoryEntry, HistoryChangesOptions, HistoryChange, HistoryChangesResult, RecordIdentity, RecordCreation, RecordUpdateSet, DataPublication, DataChangeSet, DataEffect } from '../../../shared/data-contract.js';
 export declare const data: {
     repository(name: string): import('../../../shared/data-contract.js').DataRepository;
 };

package/dist/types/shared/data-contract.d.ts

@@ -138,6 +138,14 @@ export type HistoryListOptions = {
     limit?: number;
     before?: string;
 };
+export type HistoryChangesOptions = {
+    collections?: string[];
+    refs?: string[];
+    from?: string;
+    through?: string;
+    limit?: number;
+    after?: string;
+};
 export type HistoryEntry = {
     version: string;
     publishedAt: string;
@@ -156,6 +164,19 @@ export type HistoryEntry = {
     updated: string[];
     deleted: string[];
 };
+export type HistoryChange = Omit<HistoryEntry, 'created' | 'updated' | 'deleted'> & {
+    $ref: string;
+    change: 'created' | 'updated' | 'deleted';
+    before: SelectedRecord | null;
+    after: SelectedRecord | null;
+};
+export type HistoryChangesResult = {
+    $meta: {
+        through: string;
+        next?: string;
+    };
+    changes: HistoryChange[];
+};
 export interface DataChangeSet {
     create(record: RecordCreation): void;
     update(record: RecordIdentity, set: RecordUpdateSet): void;
@@ -175,6 +196,7 @@ export interface DataRepository {
     history: {
         list(options?: HistoryListOptions): Promise<HistoryEntry[]>;
         at(instant: string): Promise<HistoryEntry | null>;
+        changes(options?: HistoryChangesOptions): Promise<HistoryChangesResult>;
     };
     changes(): DataChangeSet;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oddington/sdk",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "description": "Oddington routine and response-handler SDK",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",