@segmentstream-cloud/ontology 0.23.0 → 0.24.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/README.md +16 -0
  2. package/dist/index.d.ts +1 -0
  3. package/dist/index.js +1 -0
  4. package/dist/manifest.d.ts +5 -0
  5. package/dist/manifest.js +2 -0
  6. package/dist/migrate/apply.js +2 -1
  7. package/dist/migrate/model.d.ts +2 -0
  8. package/dist/migrate/plan.js +9 -1
  9. package/dist/migrate/storage.d.ts +3 -0
  10. package/dist/migrate/storage.js +10 -0
  11. package/dist/permissions.d.ts +3 -0
  12. package/dist/permissions.js +8 -1
  13. package/dist/runtime/history.d.ts +22 -0
  14. package/dist/runtime/history.js +2 -0
  15. package/dist/runtime/pipeline.js +6 -2
  16. package/dist/runtime/principals.d.ts +4 -1
  17. package/dist/runtime/principals.js +141 -63
  18. package/dist/runtime/reads.js +9 -1
  19. package/dist/runtime/service-binding.js +2 -1
  20. package/dist/runtime/sql-runtime.d.ts +12 -2
  21. package/dist/runtime/sql-runtime.js +33 -0
  22. package/dist/runtime/workload.d.ts +23 -0
  23. package/dist/runtime/workload.js +22 -0
  24. package/dist/runtime/writes.js +7 -1
  25. package/dist/runtime.d.ts +3 -0
  26. package/dist/service/authentication.d.ts +11 -0
  27. package/dist/service/authentication.js +114 -5
  28. package/dist/service/config.d.ts +4 -0
  29. package/dist/service/config.js +11 -0
  30. package/dist/service/handlers.js +2 -1
  31. package/dist/service/mcp/server.js +5 -4
  32. package/dist/service/operations.d.ts +25 -5
  33. package/dist/service/runtime-contract.d.ts +1 -0
  34. package/dist/service/schemas.d.ts +122 -0
  35. package/dist/storage/attachments.js +4 -4
  36. package/dist/storage/authorization.d.ts +1 -1
  37. package/dist/storage/authorization.js +9 -4
  38. package/dist/storage/sessions.js +3 -3
  39. package/dist/storage/writes.js +1 -1
  40. package/package.json +2 -1
@@ -40,6 +40,26 @@ export declare const Validation: Schema.Struct<{
40
40
  }>>;
41
41
  }>;
42
42
  export declare const HistoryEntry: Schema.decodeTo<Schema.Struct<{
43
+ readonly execution: Schema.optionalKey<Schema.Struct<{
44
+ readonly issuer: Schema.String;
45
+ readonly audience: Schema.String;
46
+ readonly organizationId: Schema.String;
47
+ readonly workspaceId: Schema.String;
48
+ readonly subject: Schema.String;
49
+ readonly deploymentId: Schema.String;
50
+ readonly ontologyDeploymentId: Schema.String;
51
+ readonly servingOntologyDeploymentId: Schema.String;
52
+ readonly ontologyOrigin: Schema.String;
53
+ readonly environment: Schema.Literal<"production">;
54
+ readonly jobName: Schema.String;
55
+ readonly runId: Schema.String;
56
+ readonly executionId: Schema.NullOr<Schema.String>;
57
+ readonly attemptId: Schema.String;
58
+ readonly generation: Schema.Number;
59
+ readonly tokenId: Schema.String;
60
+ readonly issuedAt: Schema.Number;
61
+ readonly expiresAt: Schema.Number;
62
+ }>>;
43
63
  readonly id: Schema.String;
44
64
  readonly recordId: Schema.String;
45
65
  readonly action: Schema.String;
@@ -52,6 +72,26 @@ export declare const HistoryEntry: Schema.decodeTo<Schema.Struct<{
52
72
  readonly after: Schema.Codec<Schema.Json, Schema.Json, never, never>;
53
73
  }>>;
54
74
  }>, Schema.Struct<{
75
+ readonly execution: Schema.toEncoded<Schema.optionalKey<Schema.Struct<{
76
+ readonly issuer: Schema.String;
77
+ readonly audience: Schema.String;
78
+ readonly organizationId: Schema.String;
79
+ readonly workspaceId: Schema.String;
80
+ readonly subject: Schema.String;
81
+ readonly deploymentId: Schema.String;
82
+ readonly ontologyDeploymentId: Schema.String;
83
+ readonly servingOntologyDeploymentId: Schema.String;
84
+ readonly ontologyOrigin: Schema.String;
85
+ readonly environment: Schema.Literal<"production">;
86
+ readonly jobName: Schema.String;
87
+ readonly runId: Schema.String;
88
+ readonly executionId: Schema.NullOr<Schema.String>;
89
+ readonly attemptId: Schema.String;
90
+ readonly generation: Schema.Number;
91
+ readonly tokenId: Schema.String;
92
+ readonly issuedAt: Schema.Number;
93
+ readonly expiresAt: Schema.Number;
94
+ }>>>;
55
95
  readonly id: Schema.toEncoded<Schema.String>;
56
96
  readonly record_id: Schema.toEncoded<Schema.String>;
57
97
  readonly action: Schema.toEncoded<Schema.String>;
@@ -66,6 +106,26 @@ export declare const HistoryEntry: Schema.decodeTo<Schema.Struct<{
66
106
  }>, never, never>;
67
107
  export declare const HistoryPage: Schema.decodeTo<Schema.Struct<{
68
108
  readonly items: Schema.$Array<Schema.decodeTo<Schema.Struct<{
109
+ readonly execution: Schema.optionalKey<Schema.Struct<{
110
+ readonly issuer: Schema.String;
111
+ readonly audience: Schema.String;
112
+ readonly organizationId: Schema.String;
113
+ readonly workspaceId: Schema.String;
114
+ readonly subject: Schema.String;
115
+ readonly deploymentId: Schema.String;
116
+ readonly ontologyDeploymentId: Schema.String;
117
+ readonly servingOntologyDeploymentId: Schema.String;
118
+ readonly ontologyOrigin: Schema.String;
119
+ readonly environment: Schema.Literal<"production">;
120
+ readonly jobName: Schema.String;
121
+ readonly runId: Schema.String;
122
+ readonly executionId: Schema.NullOr<Schema.String>;
123
+ readonly attemptId: Schema.String;
124
+ readonly generation: Schema.Number;
125
+ readonly tokenId: Schema.String;
126
+ readonly issuedAt: Schema.Number;
127
+ readonly expiresAt: Schema.Number;
128
+ }>>;
69
129
  readonly id: Schema.String;
70
130
  readonly recordId: Schema.String;
71
131
  readonly action: Schema.String;
@@ -78,6 +138,26 @@ export declare const HistoryPage: Schema.decodeTo<Schema.Struct<{
78
138
  readonly after: Schema.Codec<Schema.Json, Schema.Json, never, never>;
79
139
  }>>;
80
140
  }>, Schema.Struct<{
141
+ readonly execution: Schema.toEncoded<Schema.optionalKey<Schema.Struct<{
142
+ readonly issuer: Schema.String;
143
+ readonly audience: Schema.String;
144
+ readonly organizationId: Schema.String;
145
+ readonly workspaceId: Schema.String;
146
+ readonly subject: Schema.String;
147
+ readonly deploymentId: Schema.String;
148
+ readonly ontologyDeploymentId: Schema.String;
149
+ readonly servingOntologyDeploymentId: Schema.String;
150
+ readonly ontologyOrigin: Schema.String;
151
+ readonly environment: Schema.Literal<"production">;
152
+ readonly jobName: Schema.String;
153
+ readonly runId: Schema.String;
154
+ readonly executionId: Schema.NullOr<Schema.String>;
155
+ readonly attemptId: Schema.String;
156
+ readonly generation: Schema.Number;
157
+ readonly tokenId: Schema.String;
158
+ readonly issuedAt: Schema.Number;
159
+ readonly expiresAt: Schema.Number;
160
+ }>>>;
81
161
  readonly id: Schema.toEncoded<Schema.String>;
82
162
  readonly record_id: Schema.toEncoded<Schema.String>;
83
163
  readonly action: Schema.toEncoded<Schema.String>;
@@ -93,6 +173,26 @@ export declare const HistoryPage: Schema.decodeTo<Schema.Struct<{
93
173
  readonly nextCursor: Schema.NullOr<Schema.String>;
94
174
  }>, Schema.Struct<{
95
175
  readonly items: Schema.toEncoded<Schema.$Array<Schema.decodeTo<Schema.Struct<{
176
+ readonly execution: Schema.optionalKey<Schema.Struct<{
177
+ readonly issuer: Schema.String;
178
+ readonly audience: Schema.String;
179
+ readonly organizationId: Schema.String;
180
+ readonly workspaceId: Schema.String;
181
+ readonly subject: Schema.String;
182
+ readonly deploymentId: Schema.String;
183
+ readonly ontologyDeploymentId: Schema.String;
184
+ readonly servingOntologyDeploymentId: Schema.String;
185
+ readonly ontologyOrigin: Schema.String;
186
+ readonly environment: Schema.Literal<"production">;
187
+ readonly jobName: Schema.String;
188
+ readonly runId: Schema.String;
189
+ readonly executionId: Schema.NullOr<Schema.String>;
190
+ readonly attemptId: Schema.String;
191
+ readonly generation: Schema.Number;
192
+ readonly tokenId: Schema.String;
193
+ readonly issuedAt: Schema.Number;
194
+ readonly expiresAt: Schema.Number;
195
+ }>>;
96
196
  readonly id: Schema.String;
97
197
  readonly recordId: Schema.String;
98
198
  readonly action: Schema.String;
@@ -105,6 +205,26 @@ export declare const HistoryPage: Schema.decodeTo<Schema.Struct<{
105
205
  readonly after: Schema.Codec<Schema.Json, Schema.Json, never, never>;
106
206
  }>>;
107
207
  }>, Schema.Struct<{
208
+ readonly execution: Schema.toEncoded<Schema.optionalKey<Schema.Struct<{
209
+ readonly issuer: Schema.String;
210
+ readonly audience: Schema.String;
211
+ readonly organizationId: Schema.String;
212
+ readonly workspaceId: Schema.String;
213
+ readonly subject: Schema.String;
214
+ readonly deploymentId: Schema.String;
215
+ readonly ontologyDeploymentId: Schema.String;
216
+ readonly servingOntologyDeploymentId: Schema.String;
217
+ readonly ontologyOrigin: Schema.String;
218
+ readonly environment: Schema.Literal<"production">;
219
+ readonly jobName: Schema.String;
220
+ readonly runId: Schema.String;
221
+ readonly executionId: Schema.NullOr<Schema.String>;
222
+ readonly attemptId: Schema.String;
223
+ readonly generation: Schema.Number;
224
+ readonly tokenId: Schema.String;
225
+ readonly issuedAt: Schema.Number;
226
+ readonly expiresAt: Schema.Number;
227
+ }>>>;
108
228
  readonly id: Schema.toEncoded<Schema.String>;
109
229
  readonly record_id: Schema.toEncoded<Schema.String>;
110
230
  readonly action: Schema.toEncoded<Schema.String>;
@@ -259,6 +379,7 @@ export declare const Catalog: Schema.decodeTo<Schema.Struct<{
259
379
  }>, {
260
380
  readonly builtIn: "built_in";
261
381
  }>>;
382
+ readonly runtimeCapabilities: Schema.optionalKey<Schema.$Array<Schema.String>>;
262
383
  readonly version: Schema.Int;
263
384
  readonly hash: Schema.String;
264
385
  readonly signIn: Schema.optionalKey<Schema.Struct<{
@@ -388,6 +509,7 @@ export declare const Catalog: Schema.decodeTo<Schema.Struct<{
388
509
  }>, {
389
510
  readonly builtIn: "built_in";
390
511
  }>>>;
512
+ readonly runtimeCapabilities: Schema.toEncoded<Schema.optionalKey<Schema.$Array<Schema.String>>>;
391
513
  readonly version: Schema.toEncoded<Schema.Int>;
392
514
  readonly hash: Schema.toEncoded<Schema.String>;
393
515
  readonly sign_in: Schema.toEncoded<Schema.optionalKey<Schema.Struct<{
@@ -128,7 +128,7 @@ export function attachmentRuntime(ontology, sql, provider) {
128
128
  ]);
129
129
  }
130
130
  // The member must still be active; a deactivated member's agent reads nothing.
131
- yield* authorizeBlobOperation(ontology, sql, caller.principal.id, []);
131
+ yield* authorizeBlobOperation(ontology, sql, caller.principal.id, [], caller.principal.execution);
132
132
  return row;
133
133
  });
134
134
  /**
@@ -154,7 +154,7 @@ export function attachmentRuntime(ontology, sql, provider) {
154
154
  });
155
155
  }
156
156
  const reserved = yield* sql.withTransaction(Effect.gen(function* () {
157
- yield* authorizeBlobOperation(ontology, sql, caller.principal.id, []);
157
+ yield* authorizeBlobOperation(ontology, sql, caller.principal.id, [], caller.principal.execution);
158
158
  yield* sql.unsafe(`SELECT pg_advisory_xact_lock(818724)`);
159
159
  const [existing] = yield* sql.unsafe(`SELECT id::text FROM "${ATTACHMENTS_TABLE}"
160
160
  WHERE owner_id = $1::uuid AND conversation = $2 AND source_ref = $3`, [caller.principal.id, caller.conversation, input.sourceRef]);
@@ -272,7 +272,7 @@ export function attachmentRuntime(ontology, sql, provider) {
272
272
  });
273
273
  /** The caller's attachments in this chat and session that are still readable, newest first. */
274
274
  const list = (caller) => sql.withTransaction(Effect.gen(function* () {
275
- yield* authorizeBlobOperation(ontology, sql, caller.principal.id, []);
275
+ yield* authorizeBlobOperation(ontology, sql, caller.principal.id, [], caller.principal.execution);
276
276
  const rows = yield* sql.unsafe(`${SELECT} WHERE a.owner_id = $1::uuid AND a.conversation = $2 AND a.branch_id = $3
277
277
  AND a.state IN ('ready', 'promoted') AND a.expires_at > now()
278
278
  AND (a.session_id IS NULL OR a.session_id = $4)
@@ -365,7 +365,7 @@ export function attachmentRuntime(ontology, sql, provider) {
365
365
  `${row.content_type}, ${row.size} bytes.`,
366
366
  });
367
367
  }
368
- yield* authorizeBlobOperation(ontology, sql, caller.principal.id, found.permissions);
368
+ yield* authorizeBlobOperation(ontology, sql, caller.principal.id, found.permissions, caller.principal.execution);
369
369
  const [earlier] = yield* sql.unsafe(`SELECT id::text, promotion FROM "${ATTACHMENTS_TABLE}"
370
370
  WHERE sha256 = $1 AND branch_id = $2 AND state = 'promoted' AND id <> $3::uuid
371
371
  AND promotion->>'action' = $4 AND promotion->>'deduplicated_from' IS NULL
@@ -5,4 +5,4 @@ import { PermissionDenied } from "../errors.js";
5
5
  /** Re-read user and roles in the same transaction that authorizes a storage operation. */
6
6
  export declare function authorizeBlobOperation(ontology: Ontology, sql: {
7
7
  readonly unsafe: (text: string, args: ReadonlyArray<unknown>) => Effect.Effect<ReadonlyArray<Readonly<Record<string, unknown>>>, SqlError>;
8
- }, principalId: string, required: ReadonlyArray<string>): Effect.Effect<undefined, PermissionDenied | SqlError, never>;
8
+ }, principalId: string, required: ReadonlyArray<string>, execution?: import("../runtime/workload.js").WorkloadExecution): Effect.Effect<undefined, PermissionDenied | SqlError, never>;
@@ -2,7 +2,7 @@ import { Effect } from "effect";
2
2
  import { missingPermission, permissionsOf } from "../permissions.js";
3
3
  import { PermissionDenied } from "../errors.js";
4
4
  /** Re-read user and roles in the same transaction that authorizes a storage operation. */
5
- export function authorizeBlobOperation(ontology, sql, principalId, required) {
5
+ export function authorizeBlobOperation(ontology, sql, principalId, required, execution) {
6
6
  return Effect.gen(function* () {
7
7
  const [catalog] = yield* sql.unsafe(`SELECT hash FROM "_ontology" WHERE id = true FOR SHARE`, []);
8
8
  if (catalog?.hash !== ontology.manifest.hash) {
@@ -10,17 +10,22 @@ export function authorizeBlobOperation(ontology, sql, principalId, required) {
10
10
  message: "The deployed ontology no longer matches the database catalog.",
11
11
  });
12
12
  }
13
- const users = yield* sql.unsafe(`SELECT kind::text, active FROM "user" WHERE id = $1::uuid FOR SHARE`, [principalId]);
13
+ const users = yield* sql.unsafe(`SELECT kind::text, active, identity_provider, identity_subject FROM "user" WHERE id = $1::uuid FOR SHARE`, [principalId]);
14
14
  const user = users[0];
15
15
  const roles = yield* sql.unsafe(`SELECT role FROM "_user_roles" WHERE user_id = $1::uuid FOR SHARE`, [principalId]);
16
16
  const held = roles.map((row) => String(row.role));
17
17
  if (user?.kind === "member") {
18
18
  held.push("member");
19
19
  }
20
+ const worker = execution !== undefined &&
21
+ user?.kind === "service" &&
22
+ user.identity_provider === "segmentstream-ontology-workload" &&
23
+ user.identity_subject === `pipeline-workers:${execution.workspaceId}`;
20
24
  const missing = missingPermission(required, {
21
- permissions: permissionsOf(ontology.roles, held),
25
+ ...(worker ? { execution } : {}),
26
+ permissions: worker ? ["*:*"] : permissionsOf(ontology.roles, held),
22
27
  });
23
- if (!user?.active || missing) {
28
+ if (!user?.active || missing || (execution !== undefined && !worker)) {
24
29
  return yield* new PermissionDenied({
25
30
  message: "The member cannot use this file operation.",
26
31
  ...(missing ? { permission: missing } : {}),
@@ -98,7 +98,7 @@ export function blobRuntime(ontology, sql, provider) {
98
98
  if (!found || row.manifest_hash !== ontology.manifest.hash) {
99
99
  return yield* conflict();
100
100
  }
101
- yield* authorizeBlobOperation(ontology, sql, principal.id, found.permissions);
101
+ yield* authorizeBlobOperation(ontology, sql, principal.id, found.permissions, principal.execution);
102
102
  return row;
103
103
  });
104
104
  const begin = (input, principal) => Effect.gen(function* () {
@@ -129,7 +129,7 @@ export function blobRuntime(ontology, sql, provider) {
129
129
  const claim = randomUUID();
130
130
  const key = `revisions/${blobId}`;
131
131
  const reservation = yield* sql.withTransaction(Effect.gen(function* () {
132
- yield* authorizeBlobOperation(ontology, sql, principal.id, found.permissions);
132
+ yield* authorizeBlobOperation(ontology, sql, principal.id, found.permissions, principal.execution);
133
133
  if (input.recordId) {
134
134
  yield* makeOntologyRuntime(ontology, sql).get({
135
135
  entity: input.entity,
@@ -310,7 +310,7 @@ export function blobRuntime(ontology, sql, provider) {
310
310
  });
311
311
  }
312
312
  const blob = yield* sql.withTransaction(Effect.gen(function* () {
313
- yield* authorizeBlobOperation(ontology, sql, principal.id, [`${entityName}:read`]);
313
+ yield* authorizeBlobOperation(ontology, sql, principal.id, [`${entityName}:read`], principal.execution);
314
314
  let revisionId = input.revisionId;
315
315
  if (!revisionId) {
316
316
  const record = yield* makeOntologyRuntime(ontology, sql).get({
@@ -39,7 +39,7 @@ export function resolveBlobWrites(context, entity, recordId, values, creating) {
39
39
  }
40
40
  return context.run(statement, params);
41
41
  },
42
- }, context.scope.principalId, authored ? [authored.permission] : generatedActionPermissions(actionEntity, actionName)).pipe(Effect.catchTag("PermissionDenied", () => Effect.fail(reject())));
42
+ }, context.scope.principalId, authored ? [authored.permission] : generatedActionPermissions(actionEntity, actionName), context.scope.execution).pipe(Effect.catchTag("PermissionDenied", () => Effect.fail(reject())));
43
43
  const params = new Params();
44
44
  const rows = yield* context.run(`SELECT u.*, b.id::text AS blob_id, b.filename, b.content_type, b.size::text AS size,
45
45
  to_char(b.created_at AT TIME ZONE 'UTC', 'YYYY-MM-DD"T"HH24:MI:SS.MS"Z"') AS created_at
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@segmentstream-cloud/ontology",
3
- "version": "0.23.0",
3
+ "version": "0.24.1",
4
4
  "description": "Define a SegmentStream workspace app's ontology: entities, relationships, roles and actions, written with Effect.",
5
5
  "license": "Apache-2.0",
6
6
  "author": "SegmentStream",
@@ -44,6 +44,7 @@
44
44
  "typecheck": "tsc -p tsconfig.json --noEmit",
45
45
  "lint": "eslint src tests --config ../../eslint.config.mjs",
46
46
  "test": "vitest run",
47
+ "test:postgres": "vitest run --config vitest.postgres.config.ts",
47
48
  "prepack": "npm run build"
48
49
  },
49
50
  "dependencies": {