@mdbase-dev/connect-protocol 0.1.0-beta.120 → 0.1.0-beta.123

package/dist/change-events.generated.d.ts

@@ -0,0 +1,48 @@
+import type { CollectionFileDescriptor } from "./files.js";
+export declare const CHANGE_EVENT_KINDS: {
+    readonly "mdbase.record.created": "record.created";
+    readonly "mdbase.record.modified": "record.updated";
+    readonly "mdbase.record.deleted": "record.deleted";
+    readonly "mdbase.record.renamed": "record.renamed";
+    readonly "mdbase.type.changed": "schema.changed";
+    readonly "mdbase.config.changed": "config.changed";
+    readonly "mdbase.contract.changed": "contract.changed";
+    readonly "mdbase.view.changed": "view.changed";
+    readonly "mdbase.view_source.changed": "view.changed";
+    readonly "mdbase.resource.changed": "file.changed";
+    readonly "mdbase.file.put": "file.put";
+    readonly "mdbase.file.remove": "file.removed";
+    readonly file_put: "file.put";
+    readonly file_remove: "file.removed";
+    readonly "mdbase.collection.invalidated": "gap";
+};
+export type KnownCollectionChangeType = keyof typeof CHANGE_EVENT_KINDS;
+/** Optional metadata: older authorities may omit fields; null means unavailable. */
+export interface RecordChangePayload {
+    path?: string | null;
+    from?: string | null;
+    to?: string | null;
+    previous_revision?: string | null;
+    revision?: string | null;
+    previous_types?: string[] | null;
+    types?: string[] | null;
+    changed_fields?: string[] | null;
+    body_changed?: boolean | null;
+    before?: Record<string, unknown> | null;
+    after?: Record<string, unknown> | null;
+}
+/** Optional metadata: older authorities may omit fields; null means unavailable. */
+export interface ResourceChangePayload {
+    name?: string | null;
+    path?: string | null;
+    previous_revision?: string | null;
+    revision?: string | null;
+    reason?: string | null;
+}
+/** Optional metadata: older authorities may omit fields; null means unavailable. */
+export interface FileChangePayload {
+    file?: CollectionFileDescriptor | null;
+    file_id?: string | null;
+    previous_path?: string | null;
+    revision?: string | null;
+}

package/dist/change-events.generated.js

@@ -0,0 +1,18 @@
+// Generated by scripts/generate-change-events.mjs. Do not edit directly.
+export const CHANGE_EVENT_KINDS = {
+    "mdbase.record.created": "record.created",
+    "mdbase.record.modified": "record.updated",
+    "mdbase.record.deleted": "record.deleted",
+    "mdbase.record.renamed": "record.renamed",
+    "mdbase.type.changed": "schema.changed",
+    "mdbase.config.changed": "config.changed",
+    "mdbase.contract.changed": "contract.changed",
+    "mdbase.view.changed": "view.changed",
+    "mdbase.view_source.changed": "view.changed",
+    "mdbase.resource.changed": "file.changed",
+    "mdbase.file.put": "file.put",
+    "mdbase.file.remove": "file.removed",
+    "file_put": "file.put",
+    "file_remove": "file.removed",
+    "mdbase.collection.invalidated": "gap"
+};

package/dist/index.d.ts

@@ -8,6 +8,7 @@ import type { ApplicationAuthorizationProof } from "./application-authorization.
 export * from "./connect-problems.generated.js";
 export * from "./files.js";
 export * from "./operations.js";
+export * from "./change-events.generated.js";
 export * from "./mutation-fingerprint.js";
 export * from "./compatibility.js";
 export * from "./capabilities.js";

package/dist/index.js

@@ -3,6 +3,7 @@ import { YAML_DOCUMENT_RECORDS_CAPABILITY } from "./collection-setup.js";
 export * from "./connect-problems.generated.js";
 export * from "./files.js";
 export * from "./operations.js";
+export * from "./change-events.generated.js";
 export * from "./mutation-fingerprint.js";
 export * from "./compatibility.js";
 export * from "./capabilities.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdbase-dev/connect-protocol",
-  "version": "0.1.0-beta.120",
+  "version": "0.1.0-beta.123",
   "private": false,
   "type": "module",
   "license": "MIT",
@@ -36,7 +36,7 @@
   },
   "scripts": {
     "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.json",
-    "test": "node --test test/*.test.mjs && node ../../scripts/generate-connect-problems.mjs --check && node ../../scripts/generate-operation-catalog.mjs --check && node ../../scripts/generate-application-capabilities.mjs --check",
+    "test": "node --test test/*.test.mjs && node ../../scripts/generate-change-events.mjs --check && node ../../scripts/generate-connect-problems.mjs --check && node ../../scripts/generate-operation-catalog.mjs --check && node ../../scripts/generate-application-capabilities.mjs --check",
     "typecheck": "tsc -p tsconfig.json --noEmit"
   }
 }

package/schemas/change-events.v1.json

@@ -0,0 +1,48 @@
+{
+  "version": 1,
+  "events": {
+    "mdbase.record.created": "record.created",
+    "mdbase.record.modified": "record.updated",
+    "mdbase.record.deleted": "record.deleted",
+    "mdbase.record.renamed": "record.renamed",
+    "mdbase.type.changed": "schema.changed",
+    "mdbase.config.changed": "config.changed",
+    "mdbase.contract.changed": "contract.changed",
+    "mdbase.view.changed": "view.changed",
+    "mdbase.view_source.changed": "view.changed",
+    "mdbase.resource.changed": "file.changed",
+    "mdbase.file.put": "file.put",
+    "mdbase.file.remove": "file.removed",
+    "file_put": "file.put",
+    "file_remove": "file.removed",
+    "mdbase.collection.invalidated": "gap"
+  },
+  "payloads": {
+    "RecordChangePayload": {
+      "path": "string",
+      "from": "string",
+      "to": "string",
+      "previous_revision": "string",
+      "revision": "string",
+      "previous_types": "strings",
+      "types": "strings",
+      "changed_fields": "strings",
+      "body_changed": "boolean",
+      "before": "object",
+      "after": "object"
+    },
+    "ResourceChangePayload": {
+      "name": "string",
+      "path": "string",
+      "previous_revision": "string",
+      "revision": "string",
+      "reason": "string"
+    },
+    "FileChangePayload": {
+      "file": "file",
+      "file_id": "string",
+      "previous_path": "string",
+      "revision": "string"
+    }
+  }
+}