@shivaedev/contract 0.29.0 → 0.30.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.
- package/CHANGELOG.md +12 -0
- package/README.md +25 -0
- package/dist/contract.d.ts.map +1 -1
- package/dist/contract.js +6 -5
- package/dist/contract.js.map +1 -1
- package/dist/internal/declarationError.d.ts +3 -0
- package/dist/internal/declarationError.d.ts.map +1 -0
- package/dist/internal/declarationError.js +12 -0
- package/dist/internal/declarationError.js.map +1 -0
- package/dist/internal/operationDeclaration.d.ts +12 -3
- package/dist/internal/operationDeclaration.d.ts.map +1 -1
- package/dist/internal/operationDeclaration.js.map +1 -1
- package/dist/makeLiveServer.d.ts +1 -1
- package/dist/makeLiveServer.d.ts.map +1 -1
- package/dist/makeLiveServer.js +5 -3
- package/dist/makeLiveServer.js.map +1 -1
- package/dist/operation.d.ts +8 -7
- package/dist/operation.d.ts.map +1 -1
- package/dist/operation.js +3 -1
- package/dist/operation.js.map +1 -1
- package/dist/permissionReadPolicy.d.ts +21 -0
- package/dist/permissionReadPolicy.d.ts.map +1 -0
- package/dist/permissionReadPolicy.js +10 -0
- package/dist/permissionReadPolicy.js.map +1 -0
- package/dist/querySubscription.d.ts +1 -0
- package/dist/querySubscription.d.ts.map +1 -1
- package/dist/querySubscription.js +2 -1
- package/dist/querySubscription.js.map +1 -1
- package/dist/readPolicy.d.ts.map +1 -1
- package/dist/readPolicy.js +4 -0
- package/dist/readPolicy.js.map +1 -1
- package/package.json +8 -7
- package/src/contract.ts +6 -5
- package/src/internal/declarationError.ts +15 -0
- package/src/internal/operationDeclaration.ts +20 -3
- package/src/makeLiveServer.ts +5 -3
- package/src/operation.ts +8 -8
- package/src/permissionReadPolicy.ts +28 -0
- package/src/querySubscription.ts +5 -1
- package/src/readPolicy.ts +4 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.30.1 - 2026-11-01
|
|
4
|
+
|
|
5
|
+
### Fixed
|
|
6
|
+
|
|
7
|
+
- Reject untyped `readsCollections` declarations with ordinary member policies when building a contract, with a message requiring `permissionReadPolicy`.
|
|
8
|
+
|
|
9
|
+
## 0.30.0 - 2026-10-31
|
|
10
|
+
|
|
11
|
+
### Added
|
|
12
|
+
|
|
13
|
+
- Queries can declare `readsCollections` with `permissionReadPolicy` to refresh admin lists after any committed repository write, using the existing collection key and NOTIFY payloads, including in session-scoped contracts. Ordinary member policies are refused by TypeScript at declaration time and by the server before reading or subscribing.
|
|
14
|
+
|
|
3
15
|
## 0.29.0 - 2026-10-31
|
|
4
16
|
|
|
5
17
|
### Added
|
package/README.md
CHANGED
|
@@ -481,6 +481,31 @@ const Mine = query("mine", {
|
|
|
481
481
|
});
|
|
482
482
|
```
|
|
483
483
|
|
|
484
|
+
On a repository model, annotate tenant fields with `bucket()` from `@shivaedev/changes/buckets.ts` so writes announce the affected buckets. For an admin page spanning every tenant, declare `readsCollections` beside a permission read policy:
|
|
485
|
+
|
|
486
|
+
```ts
|
|
487
|
+
import { Effect, Schema } from "effect";
|
|
488
|
+
import { permission } from "@shivaedev/access/permission.ts";
|
|
489
|
+
import { collection } from "@shivaedev/changes/keys.ts";
|
|
490
|
+
import { query } from "@shivaedev/contract/operation.ts";
|
|
491
|
+
import { permissionReadPolicy } from "@shivaedev/contract/permissionReadPolicy.ts";
|
|
492
|
+
import { SessionUser } from "@shivaedev/identity/identity.ts";
|
|
493
|
+
import { hasPermission } from "@shivaedev/identity/permission.ts";
|
|
494
|
+
|
|
495
|
+
const notes = collection("notes", Schema.Number);
|
|
496
|
+
const ManageNotes = permission("notes.manage").any;
|
|
497
|
+
const AllNotes = query("allNotes", {
|
|
498
|
+
success: Schema.Array(Schema.String),
|
|
499
|
+
readPolicy: permissionReadPolicy(ManageNotes, (required) => Effect.map(SessionUser, (user) => hasPermission(user, required))),
|
|
500
|
+
reads: () => [],
|
|
501
|
+
readsCollections: [notes],
|
|
502
|
+
});
|
|
503
|
+
```
|
|
504
|
+
|
|
505
|
+
The application supplies the permission checker through `permissionReadPolicy(permission, check)`; `check` receives that permission and the current viewer, and must check the viewer's grant using server services. Its failures and service requirements flow through the query like any other read policy. Supply `SessionUser` with the application's identity middleware. The policy guards both calls and subscriptions, and runs again before changed hints are delivered. `readsCollections` requires this policy at declaration: a `signedIn` or ordinary boolean policy fails TypeScript checking, and building an untyped contract with that declaration throws an error explaining the required permission policy. The server also refuses collection queries changed to an ordinary policy after construction as `QueryReadDenied`. Tenant-facing queries use `notes.bucket.userId(viewerId)` instead.
|
|
506
|
+
|
|
507
|
+
Collection reads reuse the bare repository table key, the same key as `notes.list`, even when the contract uses `keyScope: "session"`; ordinary reads keep their session scope. They add no wildcard matching or write-side work. Every committed repository insert, update, delete, upsert and bulk write already publishes that key. Generated-id inserts also publish the bare collection key alongside their generated record key, so `publishes` stories that check exact published keys must allow the bare key today. For a table named `notes`, that is `"notes"` alongside `"notes:<id>"` and any affected bucket keys. Mounting a collection subscriber adds **zero PostgreSQL NOTIFY messages per write**: it consumes the existing payloads. It adds a normal query subscription and an authorized reread when the collection changes.
|
|
508
|
+
|
|
484
509
|
For dependencies that need server data, add `serverReads(payload, viewer)`, an Effect returning extra keys. Keep `reads` for keys the browser can derive, or return `[]` there. The server checks every referenced query's policy before it runs any `serverReads`, and resolves it with the owning query handler's services. Declare its failures in the query's `rejections`, as with policy failures. A denied subscription never runs the resolver.
|
|
485
510
|
|
|
486
511
|
```ts
|
package/dist/contract.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"contract.d.ts","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AAE/E,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC3F,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAkC,MAAM,oBAAoB,CAAC;AAEhF,MAAM,MAAM,GAAG,CAAC,SAAS,SAAS,MAAM,EAAE,KAAK,SAAS,MAAM,IAAI,GAAG,SAAS,IAAI,KAAK,EAAE,CAAC;AAE1F,MAAM,MAAM,aAAa,CAAC,MAAM,IAAI,MAAM,SAAS,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE5F,KAAK,cAAc,CAAC,UAAU,SAAS,cAAc,IAAI,UAAU,SAAS,UAAU,GACnF,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,OAAO,eAAe,CAAC,CAAC,GACpE,UAAU,CAAC,OAAO,CAAC,CAAC;AAEvB,MAAM,MAAM,YAAY,CAAC,SAAS,SAAS,MAAM,EAAE,UAAU,IAAI,UAAU,SAAS,cAAc,GAC/F,UAAU,SAAS,WAAW,GAC7B,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,GAC9I,GAAG,CAAC,GAAG,CACP,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,EAClC,UAAU,CAAC,SAAS,CAAC,EACrB,UAAU,CAAC,SAAS,CAAC,EACrB,cAAc,CAAC,UAAU,CAAC,EAC1B,KAAK,EACL,aAAa,CAAC,UAAU,CAAC,CACzB,GACD,KAAK,CAAC;AAET,MAAM,WAAW,QAAQ,CACxB,KAAK,SAAS,MAAM,EACpB,QAAQ,SAAS,SAAS,UAAU,EAAE,EACtC,SAAS,SAAS,SAAS,YAAY,EAAE,EACzC,QAAQ,SAAS,SAAS,WAAW,EAAE,GAAG,SAAS,EAAE,EACrD,MAAM,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS;IAEhD,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;CAC3B;AAED,MAAM,WAAW,QAAQ,CACxB,KAAK,SAAS,MAAM,EACpB,QAAQ,SAAS,SAAS,UAAU,EAAE,EACtC,SAAS,SAAS,SAAS,YAAY,EAAE,EACzC,KAAK,SAAS,GAAG,CAAC,GAAG,GAAG,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,EAClI,QAAQ,SAAS,SAAS,WAAW,EAAE,GAAG,SAAS,EAAE,EACrD,MAAM,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,CAC/C,SAAQ,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;IACjC,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,GAAG,KAAK,WAAW,CAAA;KAAE,CAAC,CAAC,CAAC;IAChG,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC7E,UAAU,EAAE,CAAC,EAAE,SAAS,aAAa,CAAC,UAAU,EAC/C,UAAU,EAAE,EAAE,KACV,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;CAC1F;AAED,KAAK,UAAU,CAAC,WAAW,SAAS,SAAS,cAAc,EAAE,EAAE,KAAK,SAAS,MAAM,GAAG,KAAK,IAAI,WAAW,SAAS,SAAS;IAC3H,MAAM,KAAK,SAAS,cAAc;IAClC,GAAG,MAAM,KAAK,SAAS,SAAS,cAAc,EAAE;CAChD,GACE,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,GAChG,KAAK,CAAC;AAET,KAAK,MAAM,CAAC,WAAW,SAAS,SAAS,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACnG,OAAO,GACP,+CAA+C,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;AA8B5E,wBAAgB,QAAQ,CACvB,KAAK,CAAC,KAAK,SAAS,MAAM,EAC1B,KAAK,CAAC,QAAQ,SAAS,SAAS,UAAU,EAAE,GAAG,SAAS,EAAE,EAC1D,KAAK,CAAC,SAAS,SAAS,SAAS,YAAY,EAAE,GAAG,SAAS,EAAE,EAC7D,KAAK,CAAC,QAAQ,SAAS,SAAS,WAAW,EAAE,GAAG,SAAS,EAAE,EAC3D,KAAK,CAAC,MAAM,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EAEtD,IAAI,EAAE,KAAK,EACX,UAAU,EAAE;IACX,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;IAC/C,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,CAAC,GAAG,QAAQ,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC;IACpE,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC,CAAC,GAAG,QAAQ,EAAE,GAAG,SAAS,EAAE,GAAG,QAAQ,CAAC,CAAC,CAAC;CAC/E,GACC,QAAQ,CACV,KAAK,EACL,QAAQ,EACR,SAAS,EACT,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,EAC7H,QAAQ,EACR,MAAM,CACN,CAAC"}
|
package/dist/contract.js
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import { Schema } from "effect";
|
|
2
2
|
import { Rpc, RpcGroup } from "effect/rpc";
|
|
3
|
+
import { declarationError } from "#internal/declarationError.ts";
|
|
3
4
|
import { QueryReadDenied } from "#readPolicyErrors.ts";
|
|
4
5
|
import { changesRpc, KeyScope, operationAnnotations } from "#serverMetadata.ts";
|
|
5
|
-
function
|
|
6
|
-
const
|
|
7
|
-
if (
|
|
8
|
-
throw new Error(
|
|
6
|
+
function assertValid(name, operations) {
|
|
7
|
+
const error = declarationError(name, operations);
|
|
8
|
+
if (error !== undefined) {
|
|
9
|
+
throw new Error(error);
|
|
9
10
|
}
|
|
10
11
|
}
|
|
11
12
|
function withDeclaration(group, application, declaration) {
|
|
@@ -18,7 +19,7 @@ function withDeclaration(group, application, declaration) {
|
|
|
18
19
|
}
|
|
19
20
|
export function contract(name, operations) {
|
|
20
21
|
const { queries = [], commands = [], streams = [], keyScope } = operations;
|
|
21
|
-
|
|
22
|
+
assertValid(name, [...queries, ...commands, ...streams]);
|
|
22
23
|
const rpcs = [...queries, ...commands, ...streams].map((operation) => Rpc.make(`${name}.${operation.name}`, {
|
|
23
24
|
error: operation.kind === "query" ? Schema.Union([operation.error, QueryReadDenied]) : operation.error,
|
|
24
25
|
payload: operation.payload,
|
package/dist/contract.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAsC,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAsC,MAAM,YAAY,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEjE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AA+DhF,SAAS,WAAW,CAAC,IAAY,EAAE,UAAgE;IAClG,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACjD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;AACF,CAAC;AAaD,SAAS,eAAe,CAAC,KAAY,EAAE,WAAkB,EAAE,WAAwB;IAClF,MAAM,gBAAgB,GAAG,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtD,OAAO,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE;QAC3B,WAAW;QACX,WAAW;QACX,UAAU,EAAE,CAAC,UAAoC,EAAE,EAAE,CACpD,eAAe,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC;KAC/F,CAAC,CAAC;AACJ,CAAC;AAwBD,MAAM,UAAU,QAAQ,CACvB,IAAY,EACZ,UAKC;IAED,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,UAAU,CAAC;IAC3E,WAAW,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;IACzD,MAAM,IAAI,GAAG,CAAC,GAAG,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CACpE,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,SAAS,CAAC,IAAI,EAAE,EAAE;QACrC,KAAK,EAAE,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK;QACtG,OAAO,EAAE,SAAS,CAAC,OAAO;QAC1B,MAAM,EAAE,SAAS,CAAC,IAAI,KAAK,QAAQ;QACnC,OAAO,EAAE,SAAS,CAAC,OAAO;KAC1B,CAAC,CAAC,aAAa,CAAC,oBAAoB,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAC3D,CAAC;IACF,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,OAAO,eAAe,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,EAAE,WAAW,EAAE;QAC7H,QAAQ;QACR,QAAQ;QACR,IAAI;QACJ,OAAO;QACP,OAAO;KACP,CAAC,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import type { CommandShape, QueryShape, StreamShape } from "#operation.ts";
|
|
2
|
+
export declare function declarationError(contractName: string, operations: readonly (QueryShape | CommandShape | StreamShape)[]): string | undefined;
|
|
3
|
+
//# sourceMappingURL=declarationError.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"declarationError.d.ts","sourceRoot":"","sources":["../../src/internal/declarationError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG3E,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,CAAC,UAAU,GAAG,YAAY,GAAG,WAAW,CAAC,EAAE,GAAG,MAAM,GAAG,SAAS,CAW3I"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { isPermissionReadPolicy } from "#permissionReadPolicy.ts";
|
|
2
|
+
export function declarationError(contractName, operations) {
|
|
3
|
+
const duplicated = operations.map(({ name }) => name).filter((name, index, names) => names.indexOf(name) !== index);
|
|
4
|
+
if (duplicated.length > 0) {
|
|
5
|
+
return `Operation names must be unique; duplicated: ${[...new Set(duplicated)].join(", ")}`;
|
|
6
|
+
}
|
|
7
|
+
const member = operations.find((operation) => operation.kind === "query" && operation.readsCollections !== undefined && !isPermissionReadPolicy(operation.readPolicy));
|
|
8
|
+
return member === undefined
|
|
9
|
+
? undefined
|
|
10
|
+
: `Collection reads require a permission policy on query ${contractName}.${member.name}; use permissionReadPolicy instead of a member policy`;
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=declarationError.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"declarationError.js","sourceRoot":"","sources":["../../src/internal/declarationError.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,MAAM,UAAU,gBAAgB,CAAC,YAAoB,EAAE,UAAgE;IACtH,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC;IACpH,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,+CAA+C,CAAC,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IAC7F,CAAC;IACD,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAC7B,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,OAAO,IAAI,SAAS,CAAC,gBAAgB,KAAK,SAAS,IAAI,CAAC,sBAAsB,CAAC,SAAS,CAAC,UAAU,CAAC,CACtI,CAAC;IACF,OAAO,MAAM,KAAK,SAAS;QAC1B,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,yDAAyD,YAAY,IAAI,MAAM,CAAC,IAAI,uDAAuD,CAAC;AAChJ,CAAC"}
|
|
@@ -1,11 +1,20 @@
|
|
|
1
|
-
import { Schema } from "effect";
|
|
2
|
-
import type {
|
|
3
|
-
import {
|
|
1
|
+
import { type Option, Schema } from "effect";
|
|
2
|
+
import type { Key } from "@shivaedev/changes/keys.ts";
|
|
3
|
+
import type { OperationShape, PayloadSchema } from "#operation.ts";
|
|
4
|
+
import type { CollectionReads } from "#permissionReadPolicy.ts";
|
|
5
|
+
import type { QueryServerReads } from "#QueryServerReads.ts";
|
|
6
|
+
import type { Viewer } from "#readPolicy.ts";
|
|
7
|
+
import { type MatchingTags, type RejectedBy, type RejectionSpecs } from "#rejection.ts";
|
|
4
8
|
export interface Declaration<TPayload extends Schema.Top | Schema.Struct.Fields, TSuccess extends Schema.Top, TSpecs extends RejectionSpecs> {
|
|
5
9
|
readonly payload?: TPayload;
|
|
6
10
|
readonly rejections?: TSpecs & MatchingTags<TSpecs>;
|
|
7
11
|
readonly success?: TSuccess;
|
|
8
12
|
}
|
|
13
|
+
export type QueryDeclaration<TPayload extends Schema.Top | Schema.Struct.Fields, TSuccess extends Schema.Top, TSpecs extends RejectionSpecs, R, TLive extends "rerun-and-compare" | undefined> = Declaration<TPayload, TSuccess, TSpecs> & CollectionReads<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R> & {
|
|
14
|
+
readonly live?: TLive;
|
|
15
|
+
readonly reads: (payload: PayloadSchema<TPayload>["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
|
|
16
|
+
readonly serverReads?: QueryServerReads<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
|
|
17
|
+
};
|
|
9
18
|
export interface Loose {
|
|
10
19
|
readonly payload?: Schema.Top | Schema.Struct.Fields;
|
|
11
20
|
readonly rejections?: RejectionSpecs;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"operationDeclaration.d.ts","sourceRoot":"","sources":["../../src/internal/operationDeclaration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;
|
|
1
|
+
{"version":3,"file":"operationDeclaration.d.ts","sourceRoot":"","sources":["../../src/internal/operationDeclaration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,UAAU,EAAE,KAAK,cAAc,EAAgB,MAAM,eAAe,CAAC;AAEtG,MAAM,WAAW,WAAW,CAAC,QAAQ,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,SAAS,cAAc;IAC1I,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IACpD,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC;CAC5B;AAED,MAAM,MAAM,gBAAgB,CAC3B,QAAQ,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAClD,QAAQ,SAAS,MAAM,CAAC,GAAG,EAC3B,MAAM,SAAS,cAAc,EAC7B,CAAC,EACD,KAAK,SAAS,mBAAmB,GAAG,SAAS,IAC1C,WAAW,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,GAC1C,eAAe,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;IAClF,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,SAAS,GAAG,EAAE,CAAC;IAC5G,QAAQ,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CACzG,CAAC;AAEH,MAAM,WAAW,KAAK;IACrB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;IACrD,QAAQ,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC;CAC9B;AASD,wBAAgB,SAAS,CAAC,KAAK,SAAS,cAAc,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK;;;;;;;;;EAU5G"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"operationDeclaration.js","sourceRoot":"","sources":["../../src/internal/operationDeclaration.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"operationDeclaration.js","sourceRoot":"","sources":["../../src/internal/operationDeclaration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,MAAM,EAAE,MAAM,QAAQ,CAAC;AAM7C,OAAO,EAA2D,YAAY,EAAE,MAAM,eAAe,CAAC;AA2BtG,SAAS,aAAa,CAAC,OAAyB;IAC/C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,MAAM,CAAC,IAAI,CAAC;IACpB,CAAC;IACD,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AACpE,CAAC;AAED,MAAM,UAAU,SAAS,CAAuC,IAAW,EAAE,IAAY,EAAE,WAAkB;IAC5G,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,WAAW,CAAC;IAC1D,OAAO;QACN,IAAI;QACJ,IAAI;QACJ,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;QAC/B,UAAU;QACV,OAAO,EAAE,OAAO,IAAI,MAAM,CAAC,IAAI;QAC/B,GAAG,YAAY,CAAC,UAAU,CAAC;KAC3B,CAAC;AACH,CAAC"}
|
package/dist/makeLiveServer.d.ts
CHANGED
|
@@ -7,7 +7,7 @@ import type { QueryUpdate } from "#queryUpdate.ts";
|
|
|
7
7
|
import { QueryReadDenied } from "#readPolicyErrors.ts";
|
|
8
8
|
export declare const makeLiveServer: Effect.Effect<{
|
|
9
9
|
resync: Effect.Effect<number, never, never>;
|
|
10
|
-
stream: (keys: readonly Key[], context?: KeyContext) => Stream.Stream<LiveHint>;
|
|
10
|
+
stream: (keys: readonly Key[], context?: KeyContext, globalKeys?: readonly Key[]) => Stream.Stream<LiveHint>;
|
|
11
11
|
subscribe: {
|
|
12
12
|
<E, R>(subscription: QuerySubscription<E, R>, context?: KeyContext): Stream.Stream<LiveHint, E | QueryReadDenied, R>;
|
|
13
13
|
<E, R>(subscription: QuerySubscription<E, R>, context: KeyContext | undefined, read: QueryRerun<E, R>): Stream.Stream<QueryUpdate, E | QueryReadDenied, R>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"makeLiveServer.d.ts","sourceRoot":"","sources":["../src/makeLiveServer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiB,MAAM,EAAE,MAAM,QAAQ,CAAC;AACvD,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,UAAU,EAAY,MAAM,4BAA4B,CAAC;AAGjF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,eAAO,MAAM,cAAc;;mBAIN,SAAS,GAAG,EAAE,YAAY,UAAU,
|
|
1
|
+
{"version":3,"file":"makeLiveServer.d.ts","sourceRoot":"","sources":["../src/makeLiveServer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiB,MAAM,EAAE,MAAM,QAAQ,CAAC;AACvD,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,UAAU,EAAY,MAAM,4BAA4B,CAAC;AAGjF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,eAAO,MAAM,cAAc;;mBAIN,SAAS,GAAG,EAAE,YAAY,UAAU,eAAc,SAAS,GAAG,EAAE,KAAQ,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;;SAwDhG,CAAC,EAAE,CAAC,gBAAgB,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,YAAY,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,eAAe,EAAE,CAAC,CAAC;SACnH,CAAC,EAAE,CAAC,gBACR,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,WAC5B,UAAU,GAAG,SAAS,QACzB,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,GACpB,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,eAAe,EAAE,CAAC,CAAC;;gCAgBpD,CAAC"}
|
package/dist/makeLiveServer.js
CHANGED
|
@@ -8,13 +8,14 @@ export const makeLiveServer = Effect.gen(function* () {
|
|
|
8
8
|
const reactivity = yield* Reactivity.Reactivity;
|
|
9
9
|
let openStreams = 0;
|
|
10
10
|
const resyncKey = `@shivaedev/contract/resync/${yield* Random.nextInt}`;
|
|
11
|
-
function open(keys, context) {
|
|
11
|
+
function open(keys, context, globalKeys = []) {
|
|
12
12
|
return Stream.unwrap(Effect.gen(function* () {
|
|
13
13
|
const { offer, queue } = yield* liveHintQueue;
|
|
14
14
|
const pending = new Map();
|
|
15
15
|
let scheduled = false;
|
|
16
16
|
let resync = false;
|
|
17
17
|
let active = true;
|
|
18
|
+
const global = new Set(readKeys(globalKeys));
|
|
18
19
|
function flush() {
|
|
19
20
|
if (scheduled) {
|
|
20
21
|
return;
|
|
@@ -30,7 +31,8 @@ export const makeLiveServer = Effect.gen(function* () {
|
|
|
30
31
|
});
|
|
31
32
|
}
|
|
32
33
|
const cancel = keys.map((key) => {
|
|
33
|
-
const
|
|
34
|
+
const bare = readKeys([key]);
|
|
35
|
+
const own = global.has(bare[0] ?? "") ? bare : readKeys([key], context);
|
|
34
36
|
return reactivity.registerUnsafe(own, () => {
|
|
35
37
|
pending.set(own[0] ?? "", key);
|
|
36
38
|
flush();
|
|
@@ -65,7 +67,7 @@ export const makeLiveServer = Effect.gen(function* () {
|
|
|
65
67
|
}
|
|
66
68
|
return yield* compare(hint);
|
|
67
69
|
});
|
|
68
|
-
return open(subscription.keys, context).pipe(Stream.mapEffect(next), Stream.flatMap(Stream.fromIterable));
|
|
70
|
+
return open(subscription.keys, context, subscription.globalKeys).pipe(Stream.mapEffect(next), Stream.flatMap(Stream.fromIterable));
|
|
69
71
|
}));
|
|
70
72
|
}
|
|
71
73
|
return { resync, stream: open, subscribe };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"makeLiveServer.js","sourceRoot":"","sources":["../src/makeLiveServer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACvD,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAA6B,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAI3D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IACjD,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;IAChD,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,MAAM,SAAS,GAAG,8BAA8B,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IACxE,SAAS,IAAI,CAAC,IAAoB,EAAE,OAAoB;
|
|
1
|
+
{"version":3,"file":"makeLiveServer.js","sourceRoot":"","sources":["../src/makeLiveServer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACvD,OAAO,KAAK,UAAU,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAA6B,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACjF,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAI3D,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IACjD,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC;IAChD,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,MAAM,SAAS,GAAG,8BAA8B,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;IACxE,SAAS,IAAI,CAAC,IAAoB,EAAE,OAAoB,EAAE,UAAU,GAAmB,EAAE;QACxF,OAAO,MAAM,CAAC,MAAM,CACnB,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACnB,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,CAAC,aAAa,CAAC;YAC9C,MAAM,OAAO,GAAG,IAAI,GAAG,EAAe,CAAC;YACvC,IAAI,SAAS,GAAG,KAAK,CAAC;YACtB,IAAI,MAAM,GAAG,KAAK,CAAC;YACnB,IAAI,MAAM,GAAG,IAAI,CAAC;YAClB,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC;YAC7C,SAAS,KAAK;gBACb,IAAI,SAAS,EAAE,CAAC;oBACf,OAAO;gBACR,CAAC;gBACD,SAAS,GAAG,IAAI,CAAC;gBACjB,cAAc,CAAC,GAAG,EAAE;oBACnB,SAAS,GAAG,KAAK,CAAC;oBAClB,IAAI,MAAM,EAAE,CAAC;wBACZ,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;oBACvF,CAAC;oBACD,OAAO,CAAC,KAAK,EAAE,CAAC;oBAChB,MAAM,GAAG,KAAK,CAAC;gBAChB,CAAC,CAAC,CAAC;YACJ,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC/B,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC7B,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;gBACxE,OAAO,UAAU,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE;oBAC1C,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,GAAG,CAAC,CAAC;oBAC/B,KAAK,EAAE,CAAC;gBACT,CAAC,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CACV,UAAU,CAAC,cAAc,CAAC,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE;gBAC3C,MAAM,GAAG,IAAI,CAAC;gBACd,KAAK,EAAE,CAAC;YACT,CAAC,CAAC,CACF,CAAC;YACF,WAAW,IAAI,CAAC,CAAC;YACjB,KAAK,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,EAAE,CAC/B,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE;gBAChB,MAAM,GAAG,KAAK,CAAC;gBACf,WAAW,IAAI,CAAC,CAAC;gBACjB,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;oBAC3B,IAAI,EAAE,CAAC;gBACR,CAAC;YACF,CAAC,CAAC,CACF,CAAC;YACF,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC9C,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,CAAC,CACF,CAAC;IACH,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE;QAC/B,UAAU,CAAC,gBAAgB,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QACzC,OAAO,WAAW,CAAC;IACpB,CAAC,CAAC,CAAC;IAOH,SAAS,SAAS,CAAO,YAAqC,EAAE,OAAoB,EAAE,IAAuB;QAC5G,OAAO,MAAM,CAAC,MAAM,CACnB,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE;YAChB,MAAM,OAAO,GAAG,cAAc,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAc;gBACvD,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;oBACvC,OAAO,KAAK,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,OAAO,EAAE,+CAA+C,EAAE,CAAC,CAAC;gBACjG,CAAC;gBACD,OAAO,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC,CAAC,CAAC;YACH,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;QACpI,CAAC,CAAC,CACF,CAAC;IACH,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;AAC5C,CAAC,CAAC,CAAC"}
|
package/dist/operation.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { Option, Schema } from "effect";
|
|
2
2
|
import type { Key } from "@shivaedev/changes/keys.ts";
|
|
3
3
|
import type { Bivariant } from "@shivaedev/types/Bivariant.ts";
|
|
4
|
-
import { type Declaration } from "#internal/operationDeclaration.ts";
|
|
4
|
+
import { type Declaration, type QueryDeclaration } from "#internal/operationDeclaration.ts";
|
|
5
5
|
import type { QueryServerReads } from "#QueryServerReads.ts";
|
|
6
6
|
import type { QueryReadPolicy, Viewer } from "#readPolicy.ts";
|
|
7
7
|
import type { Reject, RejectedBy, RejectionSpecs, Rejections, RejectionUnion } from "#rejection.ts";
|
|
@@ -22,6 +22,9 @@ export interface QueryShape<E = unknown, R = unknown> extends OperationShape {
|
|
|
22
22
|
readonly live?: "rerun-and-compare" | undefined;
|
|
23
23
|
readonly readPolicy: Bivariant<QueryReadPolicy<unknown, E, R>>;
|
|
24
24
|
reads: Bivariant<(payload: unknown, viewer: Option.Option<Viewer>) => readonly Key[]>;
|
|
25
|
+
readonly readsCollections?: readonly {
|
|
26
|
+
readonly name: string;
|
|
27
|
+
}[] | undefined;
|
|
25
28
|
readonly serverReads?: Bivariant<QueryServerReads<unknown, E, R>>;
|
|
26
29
|
}
|
|
27
30
|
export interface StreamShape extends OperationShape {
|
|
@@ -46,6 +49,9 @@ export interface Query<TName extends string, TPayload extends Schema.Top, TSucce
|
|
|
46
49
|
readonly live?: TLive;
|
|
47
50
|
readonly readPolicy: QueryReadPolicy<TPayload["Type"], RejectedBy<TSpecs>, R>;
|
|
48
51
|
reads: (payload: TPayload["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
|
|
52
|
+
readonly readsCollections?: readonly {
|
|
53
|
+
readonly name: string;
|
|
54
|
+
}[] | undefined;
|
|
49
55
|
readonly serverReads?: QueryServerReads<TPayload["Type"], RejectedBy<TSpecs>, R>;
|
|
50
56
|
}
|
|
51
57
|
export interface Streaming<TName extends string, TPayload extends Schema.Top, TSuccess extends Schema.Top, TSpecs extends RejectionSpecs> extends Operation<TName, TPayload, TSuccess, TSpecs> {
|
|
@@ -56,12 +62,7 @@ export interface Command<TName extends string, TPayload extends Schema.Top, TSuc
|
|
|
56
62
|
invalidates: (payload: TPayload["Type"], result: TSuccess["Type"], viewer?: Option.Option<Viewer>) => readonly Key[];
|
|
57
63
|
readonly kind: "command";
|
|
58
64
|
}
|
|
59
|
-
export declare function query<const TName extends string, TPayload extends Schema.Top | Schema.Struct.Fields = Schema.Void, TSuccess extends Schema.Top = Schema.Void, const TSpecs extends RejectionSpecs = NoRejections, R = never, const TLive extends "rerun-and-compare" | undefined = undefined>(name: TName, declaration:
|
|
60
|
-
readonly live?: TLive;
|
|
61
|
-
readonly reads: (payload: PayloadSchema<TPayload>["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
|
|
62
|
-
readonly readPolicy: QueryReadPolicy<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
|
|
63
|
-
readonly serverReads?: QueryServerReads<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
|
|
64
|
-
}): NoInfer<Query<TName, PayloadSchema<TPayload>, TSuccess, TSpecs, R, TLive>>;
|
|
65
|
+
export declare function query<const TName extends string, TPayload extends Schema.Top | Schema.Struct.Fields = Schema.Void, TSuccess extends Schema.Top = Schema.Void, const TSpecs extends RejectionSpecs = NoRejections, R = never, const TLive extends "rerun-and-compare" | undefined = undefined>(name: TName, declaration: QueryDeclaration<TPayload, TSuccess, TSpecs, R, TLive>): NoInfer<Query<TName, PayloadSchema<TPayload>, TSuccess, TSpecs, R, TLive>>;
|
|
65
66
|
export declare function command<const TName extends string, TPayload extends Schema.Top | Schema.Struct.Fields = Schema.Void, TSuccess extends Schema.Top = Schema.Void, const TSpecs extends RejectionSpecs = NoRejections>(name: TName, declaration: Declaration<TPayload, TSuccess, TSpecs> & {
|
|
66
67
|
readonly invalidates: (payload: PayloadSchema<TPayload>["Type"], result: TSuccess["Type"], viewer?: Option.Option<Viewer>) => readonly Key[];
|
|
67
68
|
}): NoInfer<Command<TName, PayloadSchema<TPayload>, TSuccess, TSpecs>>;
|
package/dist/operation.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../src/operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,KAAK,WAAW,EAAyB,MAAM,mCAAmC,CAAC;
|
|
1
|
+
{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../src/operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,KAAK,WAAW,EAAyB,KAAK,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACnH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC9D,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEpG,MAAM,MAAM,aAAa,CAAC,QAAQ,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,QAAQ,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,GAClH,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,GACvB,QAAQ,CAAC;AAEZ,KAAK,YAAY,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AAEzC,MAAM,WAAW,cAAc;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC;IAC7B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC;CAC7B;AAED,MAAM,WAAW,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO,CAAE,SAAQ,cAAc;IAC3E,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC;IAChD,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/D,KAAK,EAAE,SAAS,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,SAAS,GAAG,EAAE,CAAC,CAAC;IACtF,QAAQ,CAAC,gBAAgB,CAAC,EAAE,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,SAAS,CAAC;IAC7E,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,WAAY,SAAQ,cAAc;IAClD,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,KAAK,EAAE,SAAS,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,SAAS,GAAG,EAAE,CAAC,CAAC;CACvD;AAED,MAAM,WAAW,YAAa,SAAQ,cAAc;IACnD,WAAW,EAAE,SAAS,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,SAAS,GAAG,EAAE,CAAC,CAAC;IAC9G,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;CACzB;AAED,UAAU,SAAS,CAAC,KAAK,SAAS,MAAM,EAAE,QAAQ,SAAS,MAAM,CAAC,GAAG,EAAE,QAAQ,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,SAAS,cAAc,CAChI,SAAQ,cAAc;IACtB,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACvC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;CAC3B;AAED,MAAM,WAAW,KAAK,CACrB,KAAK,SAAS,MAAM,EACpB,QAAQ,SAAS,MAAM,CAAC,GAAG,EAC3B,QAAQ,SAAS,MAAM,CAAC,GAAG,EAC3B,MAAM,SAAS,cAAc,EAC7B,CAAC,GAAG,KAAK,EACT,KAAK,SAAS,mBAAmB,GAAG,SAAS,GAAG,SAAS,CACxD,SAAQ,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC;IACrD,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9E,KAAK,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,SAAS,GAAG,EAAE,CAAC;IACpF,QAAQ,CAAC,gBAAgB,CAAC,EAAE,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,SAAS,CAAC;IAC7E,QAAQ,CAAC,WAAW,CAAC,EAAE,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;CACjF;AAED,MAAM,WAAW,SAAS,CAAC,KAAK,SAAS,MAAM,EAAE,QAAQ,SAAS,MAAM,CAAC,GAAG,EAAE,QAAQ,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,SAAS,cAAc,CACvI,SAAQ,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC;IACpD,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,KAAK,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK,SAAS,GAAG,EAAE,CAAC;CACrD;AAED,MAAM,WAAW,OAAO,CAAC,KAAK,SAAS,MAAM,EAAE,QAAQ,SAAS,MAAM,CAAC,GAAG,EAAE,QAAQ,SAAS,MAAM,CAAC,GAAG,EAAE,MAAM,SAAS,cAAc,CACrI,SAAQ,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC;IACpD,WAAW,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,SAAS,GAAG,EAAE,CAAC;IACrH,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;CACzB;AAED,wBAAgB,KAAK,CACpB,KAAK,CAAC,KAAK,SAAS,MAAM,EAC1B,QAAQ,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,EAChE,QAAQ,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,EACzC,KAAK,CAAC,MAAM,SAAS,cAAc,GAAG,YAAY,EAClD,CAAC,GAAG,KAAK,EACT,KAAK,CAAC,KAAK,SAAS,mBAAmB,GAAG,SAAS,GAAG,SAAS,EAE/D,IAAI,EAAE,KAAK,EACX,WAAW,EAAE,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,CAAC,GACjE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;AAsB9E,wBAAgB,OAAO,CACtB,KAAK,CAAC,KAAK,SAAS,MAAM,EAC1B,QAAQ,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,EAChE,QAAQ,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,EACzC,KAAK,CAAC,MAAM,SAAS,cAAc,GAAG,YAAY,EAElD,IAAI,EAAE,KAAK,EACX,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG;IACtD,QAAQ,CAAC,WAAW,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,SAAS,GAAG,EAAE,CAAC;CAC7I,GACC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AAQtE,wBAAgB,MAAM,CACrB,KAAK,CAAC,KAAK,SAAS,MAAM,EAC1B,QAAQ,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,EAChE,QAAQ,SAAS,MAAM,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,EACzC,KAAK,CAAC,MAAM,SAAS,cAAc,GAAG,YAAY,EAElD,IAAI,EAAE,KAAK,EACX,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG;IACtD,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3B,QAAQ,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,SAAS,GAAG,EAAE,CAAC;CAC7E,GACC,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC"}
|
package/dist/operation.js
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { operation } from "#internal/operationDeclaration.ts";
|
|
2
2
|
export function query(name, declaration) {
|
|
3
|
+
const collections = declaration.readsCollections?.map((collection) => ({ _tag: "List", collection: collection.name })) ?? [];
|
|
3
4
|
return {
|
|
4
5
|
...operation("query", name, declaration),
|
|
5
6
|
live: declaration.live,
|
|
6
7
|
readPolicy: declaration.readPolicy,
|
|
7
|
-
reads: declaration.reads,
|
|
8
|
+
reads: (payload, viewer) => [...declaration.reads(payload, viewer), ...collections],
|
|
9
|
+
readsCollections: declaration.readsCollections,
|
|
8
10
|
...(declaration.serverReads === undefined ? {} : { serverReads: declaration.serverReads }),
|
|
9
11
|
};
|
|
10
12
|
}
|
package/dist/operation.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"operation.js","sourceRoot":"","sources":["../src/operation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgC,SAAS,
|
|
1
|
+
{"version":3,"file":"operation.js","sourceRoot":"","sources":["../src/operation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgC,SAAS,EAAyB,MAAM,mCAAmC,CAAC;AA2FnH,MAAM,UAAU,KAAK,CACpB,IAAY,EACZ,WAMC;IAED,MAAM,WAAW,GAAmB,WAAW,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7I,OAAO;QACN,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC;QACxC,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,UAAU,EAAE,WAAW,CAAC,UAAU;QAClC,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,GAAG,WAAW,CAAC;QACnF,gBAAgB,EAAE,WAAW,CAAC,gBAAgB;QAC9C,GAAG,CAAC,WAAW,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,EAAE,CAAC;KAC1F,CAAC;AACH,CAAC;AAaD,MAAM,UAAU,OAAO,CACtB,IAAY,EACZ,WAAoI;IAEpI,OAAO,EAAE,GAAG,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,WAAW,EAAE,CAAC;AAC7F,CAAC;AAcD,MAAM,UAAU,MAAM,CAAC,IAAY,EAAE,WAA6E;IACjH,OAAO,EAAE,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,CAAC;AAChF,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { Effect, Option } from "effect";
|
|
2
|
+
import type { QueryReadPolicy, Viewer } from "#readPolicy.ts";
|
|
3
|
+
declare const PermissionReadPolicyId: unique symbol;
|
|
4
|
+
export interface PermissionReadPolicy<TPayload, E = never, R = never> extends QueryReadPolicy<TPayload, E, R> {
|
|
5
|
+
readonly [PermissionReadPolicyId]: true;
|
|
6
|
+
}
|
|
7
|
+
export declare function permissionReadPolicy<TPermission extends {
|
|
8
|
+
readonly name: string;
|
|
9
|
+
}, E, R>(permission: TPermission, check: (permission: TPermission, viewer: Option.Option<Viewer>) => Effect.Effect<boolean, E, R>): PermissionReadPolicy<unknown, E, R>;
|
|
10
|
+
export declare function isPermissionReadPolicy(policy: QueryReadPolicy<unknown, unknown, unknown>): boolean;
|
|
11
|
+
export type CollectionReads<TPayload, E, R> = {
|
|
12
|
+
readonly readsCollections?: never;
|
|
13
|
+
readonly readPolicy: QueryReadPolicy<TPayload, E, R>;
|
|
14
|
+
} | {
|
|
15
|
+
readonly readsCollections: readonly {
|
|
16
|
+
readonly name: string;
|
|
17
|
+
}[];
|
|
18
|
+
readonly readPolicy: PermissionReadPolicy<TPayload, E, R>;
|
|
19
|
+
};
|
|
20
|
+
export {};
|
|
21
|
+
//# sourceMappingURL=permissionReadPolicy.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"permissionReadPolicy.d.ts","sourceRoot":"","sources":["../src/permissionReadPolicy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAE9D,QAAA,MAAM,sBAAsB,eAAyD,CAAC;AAEtF,MAAM,WAAW,oBAAoB,CAAC,QAAQ,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,CAAE,SAAQ,eAAe,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;IAC5G,QAAQ,CAAC,CAAC,sBAAsB,CAAC,EAAE,IAAI,CAAC;CACxC;AAED,wBAAgB,oBAAoB,CAAC,WAAW,SAAS;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,CAAC,EAAE,CAAC,EACvF,UAAU,EAAE,WAAW,EACvB,KAAK,EAAE,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,GAC7F,oBAAoB,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAIrC;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,OAAO,CAElG;AAED,MAAM,MAAM,eAAe,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,IACvC;IAAE,QAAQ,CAAC,gBAAgB,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CAAE,GAC3F;IACA,QAAQ,CAAC,gBAAgB,EAAE,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAChE,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;CACzD,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
const PermissionReadPolicyId = Symbol.for("@shivaedev/contract/PermissionReadPolicy");
|
|
2
|
+
export function permissionReadPolicy(permission, check) {
|
|
3
|
+
return Object.assign((_payload, viewer) => check(permission, viewer), {
|
|
4
|
+
[PermissionReadPolicyId]: true,
|
|
5
|
+
});
|
|
6
|
+
}
|
|
7
|
+
export function isPermissionReadPolicy(policy) {
|
|
8
|
+
return PermissionReadPolicyId in policy;
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=permissionReadPolicy.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"permissionReadPolicy.js","sourceRoot":"","sources":["../src/permissionReadPolicy.ts"],"names":[],"mappings":"AAGA,MAAM,sBAAsB,GAAG,MAAM,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAC;AAMtF,MAAM,UAAU,oBAAoB,CACnC,UAAuB,EACvB,KAA+F;IAE/F,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,QAAiB,EAAE,MAA6B,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE;QACrG,CAAC,sBAAsB,CAAC,EAAE,IAAa;KACvC,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,MAAkD;IACxF,OAAO,sBAAsB,IAAI,MAAM,CAAC;AACzC,CAAC"}
|
|
@@ -7,6 +7,7 @@ import { type QueryReference, type QueryRequest } from "#serverMetadata.ts";
|
|
|
7
7
|
export type QueryRerun<E = unknown, R = never> = (request: QueryRequest) => Effect.Effect<unknown, E, R>;
|
|
8
8
|
export interface QuerySubscription<E = never, R = never> {
|
|
9
9
|
readonly authorized: Effect.Effect<boolean, E, R>;
|
|
10
|
+
readonly globalKeys?: readonly Key[];
|
|
10
11
|
readonly keys: readonly Key[];
|
|
11
12
|
readonly queries?: readonly QueryRequest[];
|
|
12
13
|
readonly scopes: readonly (readonly Key[])[];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"querySubscription.d.ts","sourceRoot":"","sources":["../src/querySubscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,MAAM,EAAE,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AAGtD,OAAO,EAAc,KAAK,cAAc,EAAE,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAAkB,KAAK,cAAc,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE5F,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,OAAO,EAAE,YAAY,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAEzG,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK;IACtD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAClD,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IAC3C,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,CAAC;CAC7C;AAED,wBAAgB,iBAAiB,CAAC,IAAI,SAAS,GAAG,CAAC,GAAG,EACrD,GAAG,EAAE,IAAI,EACT,UAAU,EAAE,SAAS,cAAc,EAAE,EACrC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAC3B,MAAM,CAAC,MAAM,CACf,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,EAClF,cAAc,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,iBAAiB,GAAG,eAAe,EACnE,cAAc,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAChC,CAAC"}
|
|
1
|
+
{"version":3,"file":"querySubscription.d.ts","sourceRoot":"","sources":["../src/querySubscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,MAAM,EAAE,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACjC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AAGtD,OAAO,EAAc,KAAK,cAAc,EAAE,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAAkB,KAAK,cAAc,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE5F,MAAM,MAAM,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,OAAO,EAAE,YAAY,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAEzG,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK;IACtD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAClD,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,GAAG,EAAE,CAAC;IACrC,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IAC3C,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,CAAC;CAC7C;AAED,wBAAgB,iBAAiB,CAAC,IAAI,SAAS,GAAG,CAAC,GAAG,EACrD,GAAG,EAAE,IAAI,EACT,UAAU,EAAE,SAAS,cAAc,EAAE,EACrC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAC3B,MAAM,CAAC,MAAM,CACf,iBAAiB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,EAClF,cAAc,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,iBAAiB,GAAG,eAAe,EACnE,cAAc,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAChC,CAAC"}
|
|
@@ -19,7 +19,8 @@ export function querySubscription(rpc, references, viewer) {
|
|
|
19
19
|
yield* Effect.forEach(policies, ({ check }) => check);
|
|
20
20
|
const scopes = yield* Effect.forEach(policies, ({ keys }) => keys);
|
|
21
21
|
const authorized = Effect.map(Effect.forEach(policies, ({ permitted }) => permitted), (permissions) => permissions.every(Boolean));
|
|
22
|
-
|
|
22
|
+
const globalKeys = queries.flatMap(({ query }) => query.readsCollections?.map((collection) => ({ _tag: "List", collection: collection.name })) ?? []);
|
|
23
|
+
return { authorized, globalKeys, keys: scopes.flat(), queries, scopes };
|
|
23
24
|
})();
|
|
24
25
|
}
|
|
25
26
|
//# sourceMappingURL=querySubscription.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"querySubscription.js","sourceRoot":"","sources":["../src/querySubscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAe,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAoC,MAAM,gBAAgB,CAAC;AAE9E,OAAO,EAAE,cAAc,EAA0C,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"querySubscription.js","sourceRoot":"","sources":["../src/querySubscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAe,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEjC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAoC,MAAM,gBAAgB,CAAC;AAE9E,OAAO,EAAE,cAAc,EAA0C,MAAM,oBAAoB,CAAC;AAqB5F,MAAM,UAAU,iBAAiB,CAAC,GAAY,EAAE,UAAqC,EAAE,MAA6B;IACnH,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;QACjC,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC9F,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CACrC,OAAO,EACP,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE;YAC9C,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YACzE,OAAO;gBACN,KAAK,EAAE,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC;gBACzE,IAAI,EAAE,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBAChF,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;aAClI,CAAC;QACH,CAAC,CAAC,CACF,CAAC;QACF,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAC5B,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,EACtD,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,CAC3C,CAAC;QACF,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CACjC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAC1H,CAAC;QACF,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAgD,CAAC;IACvH,CAAC,CAAC,EAAE,CAAC;AACN,CAAC"}
|
package/dist/readPolicy.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"readPolicy.d.ts","sourceRoot":"","sources":["../src/readPolicy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,MAAM,EAAE,KAAK,KAAK,EAAE,MAAM,QAAQ,CAAC;AAC1E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"readPolicy.d.ts","sourceRoot":"","sources":["../src/readPolicy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,MAAM,EAAE,KAAK,KAAK,EAAE,MAAM,QAAQ,CAAC;AAC1E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAG1E,MAAM,WAAW,MAAM;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACpB;AACD,MAAM,MAAM,eAAe,CAAC,QAAQ,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAEjJ,eAAO,MAAM,aAAa,0CAA+G,CAAC;AAC1I,eAAO,MAAM,QAAQ,EAAE,eAAe,CAAC,OAAO,CAA+D,CAAC;AAE9G,eAAO,MAAM,UAAU,GAAgC,CAAC,EAAE,CAAC,mJAUzD,CAAC;AAGH,MAAM,MAAM,cAAc,CAAC,IAAI,IAAI,IAAI,SAAS;IAC/C,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;IACjD,QAAQ,CAAC,aAAa,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,QAAQ,CAAA;KAAE,CAAC;IAC1D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;CAC9B,GACE;IAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAA;CAAE,GAC/H;IAAE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAA;CAAE,CAAC;AAEjE,wBAAgB,cAAc,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,SAAS,GAAG,CAAC,GAAG,EAC3D,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAC9B,OAAO,EAAE;IAAE,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;CAAE,EAC1D,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,iBAAiB,GAAG,eAAe,EAAE,CAAC,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC"}
|
package/dist/readPolicy.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Context, Effect, Option } from "effect";
|
|
2
2
|
import { policyContext } from "#internal/policyContext.ts";
|
|
3
|
+
import { isPermissionReadPolicy } from "#permissionReadPolicy.ts";
|
|
3
4
|
import { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
|
|
4
5
|
import { QueryDefinition } from "#serverMetadata.ts";
|
|
5
6
|
export const CurrentViewer = Context.Reference("@shivaedev/contract/CurrentViewer", { defaultValue: Option.none });
|
|
@@ -8,6 +9,9 @@ export const checkQuery = Effect.fnUntraced(function* (query, payload, viewer) {
|
|
|
8
9
|
if (query.readPolicy === undefined) {
|
|
9
10
|
return yield* new MissingReadPolicy({ message: `Declare a readPolicy on query ${query.name} before reading it or subscribing` });
|
|
10
11
|
}
|
|
12
|
+
if (query.readsCollections !== undefined && !isPermissionReadPolicy(query.readPolicy)) {
|
|
13
|
+
return yield* new QueryReadDenied({ message: `Collection reads require a permission policy on query ${query.name}` });
|
|
14
|
+
}
|
|
11
15
|
if (!(yield* query.readPolicy(payload, viewer))) {
|
|
12
16
|
return yield* new QueryReadDenied({ message: `Read not allowed for query ${query.name}` });
|
|
13
17
|
}
|
package/dist/readPolicy.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"readPolicy.js","sourceRoot":"","sources":["../src/readPolicy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAA2B,MAAM,QAAQ,CAAC;AAE1E,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAOrD,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAwB,mCAAmC,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AAC1I,MAAM,CAAC,MAAM,QAAQ,GAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAE9G,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAQ,KAAuB,EAAE,OAAgB,EAAE,MAA6B;IACpI,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC,CAAC,IAAI,iBAAiB,CAAC,EAAE,OAAO,EAAE,iCAAiC,KAAK,CAAC,IAAI,mCAAmC,EAAE,CAAC,CAAC;IAClI,CAAC;IACD,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;QACjD,OAAO,KAAK,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,OAAO,EAAE,8BAA8B,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC5F,CAAC;AACF,CAAC,CAAC,CAAC;AAiBH,MAAM,UAAU,cAAc,CAC7B,MAAgD,EAChD,OAA6D,EAC7D,MAA6B;IAE7B,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;QACjC,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;QAC/E,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAClD,KAAK,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9G,CAAC;QACD,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC,CAAC,EAAE,CAAC;AACN,CAAC"}
|
|
1
|
+
{"version":3,"file":"readPolicy.js","sourceRoot":"","sources":["../src/readPolicy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAA2B,MAAM,QAAQ,CAAC;AAE1E,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAE3D,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAOrD,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAwB,mCAAmC,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;AAC1I,MAAM,CAAC,MAAM,QAAQ,GAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAE9G,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAQ,KAAuB,EAAE,OAAgB,EAAE,MAA6B;IACpI,IAAI,KAAK,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC,CAAC,IAAI,iBAAiB,CAAC,EAAE,OAAO,EAAE,iCAAiC,KAAK,CAAC,IAAI,mCAAmC,EAAE,CAAC,CAAC;IAClI,CAAC;IACD,IAAI,KAAK,CAAC,gBAAgB,KAAK,SAAS,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC;QACvF,OAAO,KAAK,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,OAAO,EAAE,yDAAyD,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACvH,CAAC;IACD,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;QACjD,OAAO,KAAK,CAAC,CAAC,IAAI,eAAe,CAAC,EAAE,OAAO,EAAE,8BAA8B,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC5F,CAAC;AACF,CAAC,CAAC,CAAC;AAiBH,MAAM,UAAU,cAAc,CAC7B,MAAgD,EAChD,OAA6D,EAC7D,MAA6B;IAE7B,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;QACjC,MAAM,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;QAC/E,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAClD,KAAK,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;QAC9G,CAAC;QACD,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC,CAAC,EAAE,CAAC;AACN,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shivaedev/contract",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.30.1",
|
|
4
4
|
"description": "Typed query and command contracts over native Effect RPC and reactivity",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"effect"
|
|
@@ -50,13 +50,14 @@
|
|
|
50
50
|
"devDependencies": {
|
|
51
51
|
"@effect/platform-node": "4.0.6",
|
|
52
52
|
"@effect/vitest": "4.0.6",
|
|
53
|
-
"@shivaedev/errors": "0.
|
|
54
|
-
"@shivaedev/identity": "0.
|
|
55
|
-
"@shivaedev/quality": "0.
|
|
56
|
-
"@shivaedev/server": "0.
|
|
53
|
+
"@shivaedev/errors": "0.4.1",
|
|
54
|
+
"@shivaedev/identity": "0.16.0",
|
|
55
|
+
"@shivaedev/quality": "0.53.1",
|
|
56
|
+
"@shivaedev/server": "0.16.1",
|
|
57
|
+
"@shivaedev/sql": "0.30.0",
|
|
57
58
|
"@shivaedev/test": "0.12.0",
|
|
58
|
-
"@shivaedev/test-sql": "0.15.
|
|
59
|
-
"@shivaedev/test-story": "0.
|
|
59
|
+
"@shivaedev/test-sql": "0.15.3",
|
|
60
|
+
"@shivaedev/test-story": "0.31.4",
|
|
60
61
|
"@types/node": "24.19.2",
|
|
61
62
|
"effect": "4.0.6",
|
|
62
63
|
"esbuild": "0.28.2",
|
package/src/contract.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { Schema } from "effect";
|
|
2
2
|
import { Rpc, RpcGroup, type RpcMiddleware, type RpcSchema } from "effect/rpc";
|
|
3
|
+
import { declarationError } from "#internal/declarationError.ts";
|
|
3
4
|
import type { CommandShape, OperationShape, QueryShape, StreamShape } from "#operation.ts";
|
|
4
5
|
import { QueryReadDenied } from "#readPolicyErrors.ts";
|
|
5
6
|
import { changesRpc, KeyScope, operationAnnotations } from "#serverMetadata.ts";
|
|
@@ -65,10 +66,10 @@ type Unique<TOperations extends readonly OperationShape[]> = [Duplicated<TOperat
|
|
|
65
66
|
? unknown
|
|
66
67
|
: `Operation names must be unique; duplicated: ${Duplicated<TOperations>}`;
|
|
67
68
|
|
|
68
|
-
function
|
|
69
|
-
const
|
|
70
|
-
if (
|
|
71
|
-
throw new Error(
|
|
69
|
+
function assertValid(name: string, operations: readonly (QueryShape | CommandShape | StreamShape)[]) {
|
|
70
|
+
const error = declarationError(name, operations);
|
|
71
|
+
if (error !== undefined) {
|
|
72
|
+
throw new Error(error);
|
|
72
73
|
}
|
|
73
74
|
}
|
|
74
75
|
|
|
@@ -125,7 +126,7 @@ export function contract(
|
|
|
125
126
|
},
|
|
126
127
|
): DeclaredGroup {
|
|
127
128
|
const { queries = [], commands = [], streams = [], keyScope } = operations;
|
|
128
|
-
|
|
129
|
+
assertValid(name, [...queries, ...commands, ...streams]);
|
|
129
130
|
const rpcs = [...queries, ...commands, ...streams].map((operation) =>
|
|
130
131
|
Rpc.make(`${name}.${operation.name}`, {
|
|
131
132
|
error: operation.kind === "query" ? Schema.Union([operation.error, QueryReadDenied]) : operation.error,
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { CommandShape, QueryShape, StreamShape } from "#operation.ts";
|
|
2
|
+
import { isPermissionReadPolicy } from "#permissionReadPolicy.ts";
|
|
3
|
+
|
|
4
|
+
export function declarationError(contractName: string, operations: readonly (QueryShape | CommandShape | StreamShape)[]): string | undefined {
|
|
5
|
+
const duplicated = operations.map(({ name }) => name).filter((name, index, names) => names.indexOf(name) !== index);
|
|
6
|
+
if (duplicated.length > 0) {
|
|
7
|
+
return `Operation names must be unique; duplicated: ${[...new Set(duplicated)].join(", ")}`;
|
|
8
|
+
}
|
|
9
|
+
const member = operations.find(
|
|
10
|
+
(operation) => operation.kind === "query" && operation.readsCollections !== undefined && !isPermissionReadPolicy(operation.readPolicy),
|
|
11
|
+
);
|
|
12
|
+
return member === undefined
|
|
13
|
+
? undefined
|
|
14
|
+
: `Collection reads require a permission policy on query ${contractName}.${member.name}; use permissionReadPolicy instead of a member policy`;
|
|
15
|
+
}
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
-
import { Schema } from "effect";
|
|
2
|
-
import type {
|
|
3
|
-
import
|
|
1
|
+
import { type Option, Schema } from "effect";
|
|
2
|
+
import type { Key } from "@shivaedev/changes/keys.ts";
|
|
3
|
+
import type { OperationShape, PayloadSchema } from "#operation.ts";
|
|
4
|
+
import type { CollectionReads } from "#permissionReadPolicy.ts";
|
|
5
|
+
import type { QueryServerReads } from "#QueryServerReads.ts";
|
|
6
|
+
import type { Viewer } from "#readPolicy.ts";
|
|
7
|
+
import { type MatchingTags, type RejectedBy, type RejectionSpecs, rejectionSet } from "#rejection.ts";
|
|
4
8
|
|
|
5
9
|
export interface Declaration<TPayload extends Schema.Top | Schema.Struct.Fields, TSuccess extends Schema.Top, TSpecs extends RejectionSpecs> {
|
|
6
10
|
readonly payload?: TPayload;
|
|
@@ -8,6 +12,19 @@ export interface Declaration<TPayload extends Schema.Top | Schema.Struct.Fields,
|
|
|
8
12
|
readonly success?: TSuccess;
|
|
9
13
|
}
|
|
10
14
|
|
|
15
|
+
export type QueryDeclaration<
|
|
16
|
+
TPayload extends Schema.Top | Schema.Struct.Fields,
|
|
17
|
+
TSuccess extends Schema.Top,
|
|
18
|
+
TSpecs extends RejectionSpecs,
|
|
19
|
+
R,
|
|
20
|
+
TLive extends "rerun-and-compare" | undefined,
|
|
21
|
+
> = Declaration<TPayload, TSuccess, TSpecs> &
|
|
22
|
+
CollectionReads<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R> & {
|
|
23
|
+
readonly live?: TLive;
|
|
24
|
+
readonly reads: (payload: PayloadSchema<TPayload>["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
|
|
25
|
+
readonly serverReads?: QueryServerReads<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
|
|
26
|
+
};
|
|
27
|
+
|
|
11
28
|
export interface Loose {
|
|
12
29
|
readonly payload?: Schema.Top | Schema.Struct.Fields;
|
|
13
30
|
readonly rejections?: RejectionSpecs;
|
package/src/makeLiveServer.ts
CHANGED
|
@@ -12,7 +12,7 @@ export const makeLiveServer = Effect.gen(function* () {
|
|
|
12
12
|
const reactivity = yield* Reactivity.Reactivity;
|
|
13
13
|
let openStreams = 0;
|
|
14
14
|
const resyncKey = `@shivaedev/contract/resync/${yield* Random.nextInt}`;
|
|
15
|
-
function open(keys: readonly Key[], context?: KeyContext): Stream.Stream<LiveHint> {
|
|
15
|
+
function open(keys: readonly Key[], context?: KeyContext, globalKeys: readonly Key[] = []): Stream.Stream<LiveHint> {
|
|
16
16
|
return Stream.unwrap(
|
|
17
17
|
Effect.gen(function* () {
|
|
18
18
|
const { offer, queue } = yield* liveHintQueue;
|
|
@@ -20,6 +20,7 @@ export const makeLiveServer = Effect.gen(function* () {
|
|
|
20
20
|
let scheduled = false;
|
|
21
21
|
let resync = false;
|
|
22
22
|
let active = true;
|
|
23
|
+
const global = new Set(readKeys(globalKeys));
|
|
23
24
|
function flush() {
|
|
24
25
|
if (scheduled) {
|
|
25
26
|
return;
|
|
@@ -35,7 +36,8 @@ export const makeLiveServer = Effect.gen(function* () {
|
|
|
35
36
|
});
|
|
36
37
|
}
|
|
37
38
|
const cancel = keys.map((key) => {
|
|
38
|
-
const
|
|
39
|
+
const bare = readKeys([key]);
|
|
40
|
+
const own = global.has(bare[0] ?? "") ? bare : readKeys([key], context);
|
|
39
41
|
return reactivity.registerUnsafe(own, () => {
|
|
40
42
|
pending.set(own[0] ?? "", key);
|
|
41
43
|
flush();
|
|
@@ -82,7 +84,7 @@ export const makeLiveServer = Effect.gen(function* () {
|
|
|
82
84
|
}
|
|
83
85
|
return yield* compare(hint);
|
|
84
86
|
});
|
|
85
|
-
return open(subscription.keys, context).pipe(Stream.mapEffect(next), Stream.flatMap(Stream.fromIterable));
|
|
87
|
+
return open(subscription.keys, context, subscription.globalKeys).pipe(Stream.mapEffect(next), Stream.flatMap(Stream.fromIterable));
|
|
86
88
|
}),
|
|
87
89
|
);
|
|
88
90
|
}
|
package/src/operation.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { Option, Schema } from "effect";
|
|
2
2
|
import type { Key } from "@shivaedev/changes/keys.ts";
|
|
3
3
|
import type { Bivariant } from "@shivaedev/types/Bivariant.ts";
|
|
4
|
-
import { type Declaration, type Loose, operation } from "#internal/operationDeclaration.ts";
|
|
4
|
+
import { type Declaration, type Loose, operation, type QueryDeclaration } from "#internal/operationDeclaration.ts";
|
|
5
5
|
import type { QueryServerReads } from "#QueryServerReads.ts";
|
|
6
6
|
import type { QueryReadPolicy, Viewer } from "#readPolicy.ts";
|
|
7
7
|
import type { Reject, RejectedBy, RejectionSpecs, Rejections, RejectionUnion } from "#rejection.ts";
|
|
@@ -28,6 +28,7 @@ export interface QueryShape<E = unknown, R = unknown> extends OperationShape {
|
|
|
28
28
|
readonly live?: "rerun-and-compare" | undefined;
|
|
29
29
|
readonly readPolicy: Bivariant<QueryReadPolicy<unknown, E, R>>;
|
|
30
30
|
reads: Bivariant<(payload: unknown, viewer: Option.Option<Viewer>) => readonly Key[]>;
|
|
31
|
+
readonly readsCollections?: readonly { readonly name: string }[] | undefined;
|
|
31
32
|
readonly serverReads?: Bivariant<QueryServerReads<unknown, E, R>>;
|
|
32
33
|
}
|
|
33
34
|
|
|
@@ -64,6 +65,7 @@ export interface Query<
|
|
|
64
65
|
readonly live?: TLive;
|
|
65
66
|
readonly readPolicy: QueryReadPolicy<TPayload["Type"], RejectedBy<TSpecs>, R>;
|
|
66
67
|
reads: (payload: TPayload["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
|
|
68
|
+
readonly readsCollections?: readonly { readonly name: string }[] | undefined;
|
|
67
69
|
readonly serverReads?: QueryServerReads<TPayload["Type"], RejectedBy<TSpecs>, R>;
|
|
68
70
|
}
|
|
69
71
|
|
|
@@ -88,12 +90,7 @@ export function query<
|
|
|
88
90
|
const TLive extends "rerun-and-compare" | undefined = undefined,
|
|
89
91
|
>(
|
|
90
92
|
name: TName,
|
|
91
|
-
declaration:
|
|
92
|
-
readonly live?: TLive;
|
|
93
|
-
readonly reads: (payload: PayloadSchema<TPayload>["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
|
|
94
|
-
readonly readPolicy: QueryReadPolicy<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
|
|
95
|
-
readonly serverReads?: QueryServerReads<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
|
|
96
|
-
},
|
|
93
|
+
declaration: QueryDeclaration<TPayload, TSuccess, TSpecs, R, TLive>,
|
|
97
94
|
): NoInfer<Query<TName, PayloadSchema<TPayload>, TSuccess, TSpecs, R, TLive>>;
|
|
98
95
|
export function query(
|
|
99
96
|
name: string,
|
|
@@ -101,14 +98,17 @@ export function query(
|
|
|
101
98
|
readonly live?: "rerun-and-compare" | undefined;
|
|
102
99
|
readonly reads: (payload: unknown, viewer: Option.Option<Viewer>) => readonly Key[];
|
|
103
100
|
readonly readPolicy: QueryReadPolicy<unknown, unknown, unknown>;
|
|
101
|
+
readonly readsCollections?: readonly { readonly name: string }[];
|
|
104
102
|
readonly serverReads?: QueryServerReads<unknown, unknown, unknown>;
|
|
105
103
|
},
|
|
106
104
|
): QueryShape {
|
|
105
|
+
const collections: readonly Key[] = declaration.readsCollections?.map((collection) => ({ _tag: "List", collection: collection.name })) ?? [];
|
|
107
106
|
return {
|
|
108
107
|
...operation("query", name, declaration),
|
|
109
108
|
live: declaration.live,
|
|
110
109
|
readPolicy: declaration.readPolicy,
|
|
111
|
-
reads: declaration.reads,
|
|
110
|
+
reads: (payload, viewer) => [...declaration.reads(payload, viewer), ...collections],
|
|
111
|
+
readsCollections: declaration.readsCollections,
|
|
112
112
|
...(declaration.serverReads === undefined ? {} : { serverReads: declaration.serverReads }),
|
|
113
113
|
};
|
|
114
114
|
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { Effect, Option } from "effect";
|
|
2
|
+
import type { QueryReadPolicy, Viewer } from "#readPolicy.ts";
|
|
3
|
+
|
|
4
|
+
const PermissionReadPolicyId = Symbol.for("@shivaedev/contract/PermissionReadPolicy");
|
|
5
|
+
|
|
6
|
+
export interface PermissionReadPolicy<TPayload, E = never, R = never> extends QueryReadPolicy<TPayload, E, R> {
|
|
7
|
+
readonly [PermissionReadPolicyId]: true;
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
export function permissionReadPolicy<TPermission extends { readonly name: string }, E, R>(
|
|
11
|
+
permission: TPermission,
|
|
12
|
+
check: (permission: TPermission, viewer: Option.Option<Viewer>) => Effect.Effect<boolean, E, R>,
|
|
13
|
+
): PermissionReadPolicy<unknown, E, R> {
|
|
14
|
+
return Object.assign((_payload: unknown, viewer: Option.Option<Viewer>) => check(permission, viewer), {
|
|
15
|
+
[PermissionReadPolicyId]: true as const,
|
|
16
|
+
});
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export function isPermissionReadPolicy(policy: QueryReadPolicy<unknown, unknown, unknown>): boolean {
|
|
20
|
+
return PermissionReadPolicyId in policy;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export type CollectionReads<TPayload, E, R> =
|
|
24
|
+
| { readonly readsCollections?: never; readonly readPolicy: QueryReadPolicy<TPayload, E, R> }
|
|
25
|
+
| {
|
|
26
|
+
readonly readsCollections: readonly { readonly name: string }[];
|
|
27
|
+
readonly readPolicy: PermissionReadPolicy<TPayload, E, R>;
|
|
28
|
+
};
|
package/src/querySubscription.ts
CHANGED
|
@@ -11,6 +11,7 @@ export type QueryRerun<E = unknown, R = never> = (request: QueryRequest) => Effe
|
|
|
11
11
|
|
|
12
12
|
export interface QuerySubscription<E = never, R = never> {
|
|
13
13
|
readonly authorized: Effect.Effect<boolean, E, R>;
|
|
14
|
+
readonly globalKeys?: readonly Key[];
|
|
14
15
|
readonly keys: readonly Key[];
|
|
15
16
|
readonly queries?: readonly QueryRequest[];
|
|
16
17
|
readonly scopes: readonly (readonly Key[])[];
|
|
@@ -46,6 +47,9 @@ export function querySubscription(rpc: Rpc.Any, references: readonly QueryRefere
|
|
|
46
47
|
Effect.forEach(policies, ({ permitted }) => permitted),
|
|
47
48
|
(permissions) => permissions.every(Boolean),
|
|
48
49
|
);
|
|
49
|
-
|
|
50
|
+
const globalKeys = queries.flatMap(
|
|
51
|
+
({ query }) => query.readsCollections?.map((collection) => ({ _tag: "List" as const, collection: collection.name })) ?? [],
|
|
52
|
+
);
|
|
53
|
+
return { authorized, globalKeys, keys: scopes.flat(), queries, scopes } satisfies QuerySubscription<unknown, unknown>;
|
|
50
54
|
})();
|
|
51
55
|
}
|
package/src/readPolicy.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { Context, Effect, Option, type Stream, type Types } from "effect";
|
|
|
2
2
|
import type { Rpc } from "effect/rpc";
|
|
3
3
|
import { policyContext } from "#internal/policyContext.ts";
|
|
4
4
|
import type { QueryShape } from "#operation.ts";
|
|
5
|
+
import { isPermissionReadPolicy } from "#permissionReadPolicy.ts";
|
|
5
6
|
import { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
|
|
6
7
|
import { QueryDefinition } from "#serverMetadata.ts";
|
|
7
8
|
|
|
@@ -17,6 +18,9 @@ export const checkQuery = Effect.fnUntraced(function* <E, R>(query: QueryShape<E
|
|
|
17
18
|
if (query.readPolicy === undefined) {
|
|
18
19
|
return yield* new MissingReadPolicy({ message: `Declare a readPolicy on query ${query.name} before reading it or subscribing` });
|
|
19
20
|
}
|
|
21
|
+
if (query.readsCollections !== undefined && !isPermissionReadPolicy(query.readPolicy)) {
|
|
22
|
+
return yield* new QueryReadDenied({ message: `Collection reads require a permission policy on query ${query.name}` });
|
|
23
|
+
}
|
|
20
24
|
if (!(yield* query.readPolicy(payload, viewer))) {
|
|
21
25
|
return yield* new QueryReadDenied({ message: `Read not allowed for query ${query.name}` });
|
|
22
26
|
}
|