@orthacms/activity-server 0.0.0-reserve.0

package/dist/lib/schema/activity-events.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.activityEvents = void 0;
+const pg_core_1 = require("drizzle-orm/pg-core");
+/**
+ * The append-only audit trail. One row per recorded action.
+ *
+ * Deliberate isolation choices (the audit log must outlive what it records):
+ * - `actorId` is a uuid with **no FK** — the actor may later be deleted, but
+ *   the audit row must remain.
+ * - `actorEmail` is a frozen snapshot of the actor's email at record time, so
+ *   the trail stays readable even after the user row is gone or renamed.
+ * - `subjectId` is **text**, not uuid — subjects are not always users and not
+ *   always uuid-keyed.
+ * - `meta` is an open jsonb payload; each emitting plugin owns its shape.
+ * - `at` is the logical event time (defaults to now); `createdAt` is the
+ *   immutable write time, dropped from the read API.
+ *
+ * Indexed for the three query shapes the read API serves: a subject's history,
+ * an actor's history, and a kind's history — each time-ordered.
+ */
+exports.activityEvents = (0, pg_core_1.pgTable)('activity_events', {
+    id: (0, pg_core_1.uuid)('id').primaryKey().defaultRandom(),
+    kind: (0, pg_core_1.text)('kind').notNull(),
+    subjectType: (0, pg_core_1.text)('subject_type').notNull(),
+    subjectId: (0, pg_core_1.text)('subject_id').notNull(),
+    actorId: (0, pg_core_1.uuid)('actor_id'),
+    actorEmail: (0, pg_core_1.text)('actor_email'),
+    meta: (0, pg_core_1.jsonb)('meta'),
+    at: (0, pg_core_1.timestamp)('at', { withTimezone: true }).notNull().defaultNow(),
+    createdAt: (0, pg_core_1.timestamp)('created_at', { withTimezone: true })
+        .notNull()
+        .defaultNow()
+}, (table) => [
+    (0, pg_core_1.index)('activity_events_subject_idx').on(table.subjectType, table.subjectId, table.at),
+    (0, pg_core_1.index)('activity_events_actor_idx').on(table.actorId, table.at),
+    (0, pg_core_1.index)('activity_events_kind_idx').on(table.kind, table.at)
+]);

package/dist/lib/schema/index.d.ts

@@ -0,0 +1,2 @@
+export { activityEvents } from './activity-events';
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/schema/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/schema/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/lib/schema/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.activityEvents = void 0;
+var activity_events_1 = require("./activity-events");
+Object.defineProperty(exports, "activityEvents", { enumerable: true, get: function () { return activity_events_1.activityEvents; } });

package/dist/lib/utils/activity-plugin.d.ts

@@ -0,0 +1,26 @@
+import type { ServerPlugin } from '@orthacms/bootstrap-server';
+/**
+ * Server plugin for the audit log. A plain {@link ServerPlugin} — the feature
+ * carries no host config.
+ *
+ * Owns the `activity_events` schema and **ships its own migrations**, so the
+ * `migrations` descriptor points the host's `db:migrate` at this package's
+ * committed SQL, tracked under its own table. Conventionally registered
+ * **after** `DatabasePlugin` (whose client it injects) and `IdentityPlugin`
+ * (whose guards gate its read API and whose `activity:read` permission it
+ * relies on).
+ *
+ * @example
+ * ```typescript
+ * createServer({
+ *   plugins: [
+ *     DatabasePlugin({ connectionString: config.database.url }),
+ *     IdentityPlugin(config.plugins.identity),
+ *     ActivityPlugin(),
+ *     UsersPlugin(),
+ *   ],
+ * });
+ * ```
+ */
+export declare function ActivityPlugin(): ServerPlugin;
+//# sourceMappingURL=activity-plugin.d.ts.map

package/dist/lib/utils/activity-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"activity-plugin.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/activity-plugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAG/D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,cAAc,IAAI,YAAY,CAS7C"}

package/dist/lib/utils/activity-plugin.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActivityPlugin = ActivityPlugin;
+const node_path_1 = require("node:path");
+const activity_module_1 = require("../activity.module");
+/**
+ * Server plugin for the audit log. A plain {@link ServerPlugin} — the feature
+ * carries no host config.
+ *
+ * Owns the `activity_events` schema and **ships its own migrations**, so the
+ * `migrations` descriptor points the host's `db:migrate` at this package's
+ * committed SQL, tracked under its own table. Conventionally registered
+ * **after** `DatabasePlugin` (whose client it injects) and `IdentityPlugin`
+ * (whose guards gate its read API and whose `activity:read` permission it
+ * relies on).
+ *
+ * @example
+ * ```typescript
+ * createServer({
+ *   plugins: [
+ *     DatabasePlugin({ connectionString: config.database.url }),
+ *     IdentityPlugin(config.plugins.identity),
+ *     ActivityPlugin(),
+ *     UsersPlugin(),
+ *   ],
+ * });
+ * ```
+ */
+function ActivityPlugin() {
+    return {
+        name: 'activity',
+        module: activity_module_1.ActivityModule.forRoot(),
+        migrations: {
+            dir: () => (0, node_path_1.join)(__dirname, '../../../migrations'),
+            table: '__drizzle_migrations_activity'
+        }
+    };
+}

package/migrations/0000_init.sql

@@ -0,0 +1,15 @@
+CREATE TABLE "activity_events" (
+	"id" uuid PRIMARY KEY DEFAULT gen_random_uuid() NOT NULL,
+	"kind" text NOT NULL,
+	"subject_type" text NOT NULL,
+	"subject_id" text NOT NULL,
+	"actor_id" uuid,
+	"actor_email" text,
+	"meta" jsonb,
+	"at" timestamp with time zone DEFAULT now() NOT NULL,
+	"created_at" timestamp with time zone DEFAULT now() NOT NULL
+);
+--> statement-breakpoint
+CREATE INDEX "activity_events_subject_idx" ON "activity_events" USING btree ("subject_type","subject_id","at");--> statement-breakpoint
+CREATE INDEX "activity_events_actor_idx" ON "activity_events" USING btree ("actor_id","at");--> statement-breakpoint
+CREATE INDEX "activity_events_kind_idx" ON "activity_events" USING btree ("kind","at");

package/migrations/meta/0000_snapshot.json

@@ -0,0 +1,159 @@
+{
+  "id": "307cf643-5557-4bda-8d14-b999159984bd",
+  "prevId": "00000000-0000-0000-0000-000000000000",
+  "version": "7",
+  "dialect": "postgresql",
+  "tables": {
+    "public.activity_events": {
+      "name": "activity_events",
+      "schema": "",
+      "columns": {
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true,
+          "default": "gen_random_uuid()"
+        },
+        "kind": {
+          "name": "kind",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "subject_type": {
+          "name": "subject_type",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "subject_id": {
+          "name": "subject_id",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": true
+        },
+        "actor_id": {
+          "name": "actor_id",
+          "type": "uuid",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "actor_email": {
+          "name": "actor_email",
+          "type": "text",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "meta": {
+          "name": "meta",
+          "type": "jsonb",
+          "primaryKey": false,
+          "notNull": false
+        },
+        "at": {
+          "name": "at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        },
+        "created_at": {
+          "name": "created_at",
+          "type": "timestamp with time zone",
+          "primaryKey": false,
+          "notNull": true,
+          "default": "now()"
+        }
+      },
+      "indexes": {
+        "activity_events_subject_idx": {
+          "name": "activity_events_subject_idx",
+          "columns": [
+            {
+              "expression": "subject_type",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "subject_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "activity_events_actor_idx": {
+          "name": "activity_events_actor_idx",
+          "columns": [
+            {
+              "expression": "actor_id",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        },
+        "activity_events_kind_idx": {
+          "name": "activity_events_kind_idx",
+          "columns": [
+            {
+              "expression": "kind",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            },
+            {
+              "expression": "at",
+              "isExpression": false,
+              "asc": true,
+              "nulls": "last"
+            }
+          ],
+          "isUnique": false,
+          "concurrently": false,
+          "method": "btree",
+          "with": {}
+        }
+      },
+      "foreignKeys": {},
+      "compositePrimaryKeys": {},
+      "uniqueConstraints": {},
+      "policies": {},
+      "checkConstraints": {},
+      "isRLSEnabled": false
+    }
+  },
+  "enums": {},
+  "schemas": {},
+  "sequences": {},
+  "roles": {},
+  "policies": {},
+  "views": {},
+  "_meta": {
+    "columns": {},
+    "schemas": {},
+    "tables": {}
+  }
+}

package/migrations/meta/_journal.json

@@ -0,0 +1,13 @@
+{
+  "version": "7",
+  "dialect": "postgresql",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "7",
+      "when": 1784474337845,
+      "tag": "0000_init",
+      "breakpoints": true
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+    "name": "@orthacms/activity-server",
+    "version": "0.0.0-reserve.0",
+    "description": "@orthacms/activity-server — part of Ortha CMS.",
+    "license": "MIT",
+    "homepage": "https://github.com/ortha-source/ortha-cms/tree/main/packages/activity/server",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/ortha-source/ortha-cms.git",
+        "directory": "packages/activity/server"
+    },
+    "bugs": {
+        "url": "https://github.com/ortha-source/ortha-cms/issues"
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "files": [
+        "dist",
+        "migrations"
+    ],
+    "dependencies": {
+        "@nestjs/common": "^11.0.0",
+        "@nestjs/swagger": "^11.4.6",
+        "@orthacms/bootstrap-server": "^0.0.1",
+        "@orthacms/copilot-domain": "^0.0.1",
+        "@orthacms/copilot-server": "^0.0.1",
+        "@orthacms/database": "^0.0.1",
+        "@orthacms/identity-server": "^0.0.1",
+        "@orthacms/tools-server": "^0.0.1",
+        "@orthacms/utils-server": "^0.0.1",
+        "class-transformer": "^0.5.1",
+        "class-validator": "^0.15.1",
+        "drizzle-orm": "^0.45.0",
+        "tslib": "^2.3.0"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}