@shivaedev/contract 0.28.0 → 0.29.0
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 +23 -0
- package/README.md +38 -4
- package/dist/QueryServerReads.d.ts +5 -0
- package/dist/QueryServerReads.d.ts.map +1 -0
- package/dist/QueryServerReads.js +2 -0
- package/dist/QueryServerReads.js.map +1 -0
- package/dist/WebSocketRequired.d.ts +8 -0
- package/dist/WebSocketRequired.d.ts.map +1 -0
- package/dist/WebSocketRequired.js +4 -0
- package/dist/WebSocketRequired.js.map +1 -0
- package/dist/automaticLive.js +1 -1
- package/dist/automaticLive.js.map +1 -1
- package/dist/internal/automaticQuery.d.ts +1 -1
- package/dist/internal/automaticQuery.d.ts.map +1 -1
- package/dist/internal/automaticQuery.js +21 -4
- package/dist/internal/automaticQuery.js.map +1 -1
- package/dist/internal/operationDeclaration.d.ts +6 -1
- package/dist/internal/operationDeclaration.d.ts.map +1 -1
- package/dist/internal/operationDeclaration.js.map +1 -1
- package/dist/internal/queryReactivity.d.ts.map +1 -1
- package/dist/internal/queryReactivity.js +10 -5
- package/dist/internal/queryReactivity.js.map +1 -1
- package/dist/internal/queryReadKeys.d.ts +5 -0
- package/dist/internal/queryReadKeys.d.ts.map +1 -0
- package/dist/internal/queryReadKeys.js +6 -0
- package/dist/internal/queryReadKeys.js.map +1 -0
- package/dist/internal/resolveQueries.d.ts +8 -0
- package/dist/internal/resolveQueries.d.ts.map +1 -0
- package/dist/internal/resolveQueries.js +8 -0
- package/dist/internal/resolveQueries.js.map +1 -0
- package/dist/internal/retryOnChange.d.ts.map +1 -1
- package/dist/internal/retryOnChange.js +8 -3
- package/dist/internal/retryOnChange.js.map +1 -1
- package/dist/operation.d.ts +6 -6
- package/dist/operation.d.ts.map +1 -1
- package/dist/operation.js +1 -0
- package/dist/operation.js.map +1 -1
- package/dist/publicConfig.d.ts +1 -1
- package/dist/publicConfig.d.ts.map +1 -1
- package/dist/queryKeys.d.ts +9 -0
- package/dist/queryKeys.d.ts.map +1 -0
- package/dist/queryKeys.js +13 -0
- package/dist/queryKeys.js.map +1 -0
- package/dist/querySubscription.d.ts.map +1 -1
- package/dist/querySubscription.js +3 -1
- package/dist/querySubscription.js.map +1 -1
- package/dist/serverMetadata.d.ts +3 -5
- package/dist/serverMetadata.d.ts.map +1 -1
- package/dist/serverMetadata.js +4 -12
- package/dist/serverMetadata.js.map +1 -1
- package/package.json +6 -6
- package/src/QueryServerReads.ts +8 -0
- package/src/WebSocketRequired.ts +3 -0
- package/src/automaticLive.ts +1 -1
- package/src/internal/automaticQuery.ts +21 -5
- package/src/internal/operationDeclaration.ts +7 -1
- package/src/internal/queryReactivity.ts +14 -5
- package/src/internal/queryReadKeys.ts +8 -0
- package/src/internal/resolveQueries.ts +10 -0
- package/src/internal/retryOnChange.ts +10 -3
- package/src/operation.ts +8 -8
- package/src/queryKeys.ts +23 -0
- package/src/querySubscription.ts +3 -1
- package/src/serverMetadata.ts +5 -21
package/dist/operation.js
CHANGED
|
@@ -5,6 +5,7 @@ export function query(name, declaration) {
|
|
|
5
5
|
live: declaration.live,
|
|
6
6
|
readPolicy: declaration.readPolicy,
|
|
7
7
|
reads: declaration.reads,
|
|
8
|
+
...(declaration.serverReads === undefined ? {} : { serverReads: declaration.serverReads }),
|
|
8
9
|
};
|
|
9
10
|
}
|
|
10
11
|
export function command(name, declaration) {
|
package/dist/operation.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"operation.js","sourceRoot":"","sources":["../src/operation.ts"],"names":[],"mappings":"AAGA,OAAO,
|
|
1
|
+
{"version":3,"file":"operation.js","sourceRoot":"","sources":["../src/operation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAgC,SAAS,EAAE,MAAM,mCAAmC,CAAC;AA8F5F,MAAM,UAAU,KAAK,CACpB,IAAY,EACZ,WAKC;IAED,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,WAAW,CAAC,KAAK;QACxB,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"}
|
package/dist/publicConfig.d.ts
CHANGED
|
@@ -22,5 +22,5 @@ export declare function publicConfig<T, E>(schema: Schema.Codec<T, E>): import("
|
|
|
22
22
|
readonly queryIndexes: Schema.optional<Schema.$Array<Schema.Number>>;
|
|
23
23
|
}>, Schema.Struct<{
|
|
24
24
|
readonly _tag: Schema.Literal<"Resync">;
|
|
25
|
-
}>]>, ...never[]]>, Schema.Union<readonly [typeof import("./readPolicyErrors.ts").MissingReadPolicy, typeof import("./readPolicyErrors.ts").QueryReadDenied, ...Schema.Never[]]>>, Schema.Never, never, never>, readonly [], undefined>;
|
|
25
|
+
}>]>, ...never[]]>, Schema.Union<readonly [typeof import("./readPolicyErrors.ts").MissingReadPolicy, typeof import("./readPolicyErrors.ts").QueryReadDenied, typeof import("./WebSocketRequired.ts").WebSocketRequired, ...Schema.Never[]]>>, Schema.Never, never, never>, readonly [], undefined>;
|
|
26
26
|
//# sourceMappingURL=publicConfig.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"publicConfig.d.ts","sourceRoot":"","sources":["../src/publicConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AAI7C,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"publicConfig.d.ts","sourceRoot":"","sources":["../src/publicConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AAI7C,wBAAgB,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;mSAI5D"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { Effect, Option } from "effect";
|
|
2
|
+
import type { Key } from "@shivaedev/changes/keys.ts";
|
|
3
|
+
import type { QueryServices } from "#contract.ts";
|
|
4
|
+
import type { QueryShape } from "#operation.ts";
|
|
5
|
+
import { type Viewer } from "#readPolicy.ts";
|
|
6
|
+
import type { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
|
|
7
|
+
import type { QueryReference } from "#serverMetadata.ts";
|
|
8
|
+
export declare function queryKeys<const TQueries extends readonly QueryShape[]>(queries: TQueries, requested: readonly QueryReference[], viewer?: Option.Option<Viewer>): Effect.Effect<readonly Key[], TQueries[number]["error"]["Type"] | MissingReadPolicy | QueryReadDenied, QueryServices<TQueries[number]>>;
|
|
9
|
+
//# sourceMappingURL=queryKeys.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryKeys.d.ts","sourceRoot":"","sources":["../src/queryKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACxC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAGlD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAc,KAAK,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,wBAAgB,SAAS,CAAC,KAAK,CAAC,QAAQ,SAAS,SAAS,UAAU,EAAE,EACrE,OAAO,EAAE,QAAQ,EACjB,SAAS,EAAE,SAAS,cAAc,EAAE,EACpC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAC5B,MAAM,CAAC,MAAM,CAAC,SAAS,GAAG,EAAE,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,GAAG,iBAAiB,GAAG,eAAe,EAAE,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { Effect, Option } from "effect";
|
|
2
|
+
import { queryReadKeys } from "#internal/queryReadKeys.ts";
|
|
3
|
+
import { resolveQueries } from "#internal/resolveQueries.ts";
|
|
4
|
+
import { checkQuery } from "#readPolicy.ts";
|
|
5
|
+
export function queryKeys(queries, requested, viewer = Option.none()) {
|
|
6
|
+
return Effect.fnUntraced(function* () {
|
|
7
|
+
const resolved = yield* resolveQueries(queries, requested);
|
|
8
|
+
yield* Effect.forEach(resolved, ({ query, payload }) => checkQuery(query, payload, viewer));
|
|
9
|
+
const scopes = yield* Effect.forEach(resolved, ({ query, payload }) => queryReadKeys(query, payload, viewer));
|
|
10
|
+
return scopes.flat();
|
|
11
|
+
})();
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=queryKeys.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"queryKeys.js","sourceRoot":"","sources":["../src/queryKeys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGxC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAe,MAAM,gBAAgB,CAAC;AASzD,MAAM,UAAU,SAAS,CAAC,OAA8B,EAAE,SAAoC,EAAE,MAAM,GAA0B,MAAM,CAAC,IAAI,EAAE;IAC5I,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC;QACjC,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC3D,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;QAC5F,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9G,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC,CAAC,EAAE,CAAC;AACN,CAAC"}
|
|
@@ -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;
|
|
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,6 +1,7 @@
|
|
|
1
1
|
import { Context, Effect } from "effect";
|
|
2
2
|
import { Rpc } from "effect/rpc";
|
|
3
3
|
import { policyContext } from "#internal/policyContext.ts";
|
|
4
|
+
import { queryReadKeys } from "#internal/queryReadKeys.ts";
|
|
4
5
|
import { checkQuery } from "#readPolicy.ts";
|
|
5
6
|
import { ChangesQueries } from "#serverMetadata.ts";
|
|
6
7
|
export function querySubscription(rpc, references, viewer) {
|
|
@@ -11,11 +12,12 @@ export function querySubscription(rpc, references, viewer) {
|
|
|
11
12
|
const context = yield* policyContext(Rpc.make(`${prefix}${query.name}`));
|
|
12
13
|
return {
|
|
13
14
|
check: Effect.provideContext(checkQuery(query, payload, viewer), context),
|
|
15
|
+
keys: queryReadKeys(query, payload, viewer).pipe(Effect.provideContext(context)),
|
|
14
16
|
permitted: Effect.suspend(() => query.readPolicy?.(payload, viewer) ?? Effect.succeed(false)).pipe(Effect.provideContext(context)),
|
|
15
17
|
};
|
|
16
18
|
}));
|
|
17
19
|
yield* Effect.forEach(policies, ({ check }) => check);
|
|
18
|
-
const scopes =
|
|
20
|
+
const scopes = yield* Effect.forEach(policies, ({ keys }) => keys);
|
|
19
21
|
const authorized = Effect.map(Effect.forEach(policies, ({ permitted }) => permitted), (permissions) => permissions.every(Boolean));
|
|
20
22
|
return { authorized, keys: scopes.flat(), queries, scopes };
|
|
21
23
|
})();
|
|
@@ -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,UAAU,EAAoC,MAAM,gBAAgB,CAAC;AAE9E,OAAO,EAAE,cAAc,EAA0C,MAAM,oBAAoB,CAAC;AAoB5F,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,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,
|
|
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;AAoB5F,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,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAgD,CAAC;IAC3G,CAAC,CAAC,EAAE,CAAC;AACN,CAAC"}
|
package/dist/serverMetadata.d.ts
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
import { Context, Effect,
|
|
1
|
+
import { Context, type Effect, Schema } from "effect";
|
|
2
2
|
import { Rpc, type RpcSchema } from "effect/rpc";
|
|
3
|
-
import type { Key } from "@shivaedev/changes/keys.ts";
|
|
4
3
|
import type { QueryServices } from "#contract.ts";
|
|
5
4
|
import { changesSuccess } from "#internal/changesSuccess.ts";
|
|
6
5
|
import type { CommandShape, QueryShape, StreamShape } from "#operation.ts";
|
|
7
|
-
import type { Viewer } from "#readPolicy.ts";
|
|
8
6
|
import { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
|
|
7
|
+
import { WebSocketRequired } from "#WebSocketRequired.ts";
|
|
9
8
|
declare const QueryDefinition_base: Context.ServiceClass<QueryDefinition, "@shivaedev/contract/QueryDefinition", {
|
|
10
9
|
readonly definition: QueryShape;
|
|
11
10
|
}>;
|
|
@@ -37,9 +36,8 @@ type ReferenceSchema<TQuery extends QueryShape> = TQuery extends QueryShape ? Sc
|
|
|
37
36
|
query: Schema.Literal<TQuery["name"]>;
|
|
38
37
|
payload: TQuery["payload"];
|
|
39
38
|
}> : never;
|
|
40
|
-
export declare const queryKeys: (queries: readonly QueryShape<unknown, unknown>[], requested: readonly QueryReference[], viewer?: Option.Option<Viewer> | undefined) => Effect.Effect<readonly Key[], never, never>;
|
|
41
39
|
declare function referenceSchemas<const TQueries extends readonly QueryShape[]>(queries: TQueries): Schema.$Array<Schema.Union<readonly ReferenceSchema<TQueries[number]>[]>>;
|
|
42
|
-
type ChangesError<TQueries extends readonly QueryShape[]> = Schema.Union<readonly [typeof MissingReadPolicy, typeof QueryReadDenied, ...TQueries[number]["error"][]]>;
|
|
40
|
+
type ChangesError<TQueries extends readonly QueryShape[]> = Schema.Union<readonly [typeof MissingReadPolicy, typeof QueryReadDenied, typeof WebSocketRequired, ...TQueries[number]["error"][]]>;
|
|
43
41
|
export declare function changesRpc<const TName extends string, const TQueries extends readonly QueryShape[]>(name: TName, queries: TQueries): Rpc.Rpc<`${TName}.$changes`, Schema.Struct<{
|
|
44
42
|
queries: ReturnType<typeof referenceSchemas<TQueries>>;
|
|
45
43
|
}>, RpcSchema.Stream<ReturnType<typeof changesSuccess<TQueries>>, ChangesError<TQueries>>, Schema.Never, never, QueryServices<TQueries[number]>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"serverMetadata.d.ts","sourceRoot":"","sources":["../src/serverMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"serverMetadata.d.ts","sourceRoot":"","sources":["../src/serverMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,GAAG,EAAE,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;;yBAEmC,UAAU;;AAAvG,qBAAa,eAAgB,SAAQ,oBAA8G;CAAG;AACtJ,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,OAAO;IACrD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CACjC;;sBAImB,SAAS,UAAU,EAAE;sBACrB,CAAC,UAAU,EAAE,SAAS,cAAc,EAAE,KAAK,MAAM,CAAC,MAAM,CAAC,SAAS,YAAY,EAAE,CAAC;;AAJrG,qBAAa,cAAe,SAAQ,mBAMK;CAAG;;0BAE0D,YAAY,CAAC,aAAa,CAAC;;AAAjI,qBAAa,mBAAoB,SAAQ,wBAExC;CAAG;;AAEJ,qBAAa,QAAS,SAAQ,aAAsE;CAAG;AAEvG,MAAM,WAAW,cAAc;IAC9B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED,KAAK,eAAe,CAAC,MAAM,SAAS,UAAU,IAAI,MAAM,SAAS,UAAU,GACxE,MAAM,CAAC,MAAM,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,CAAA;CAAE,CAAC,GACpF,KAAK,CAAC;AAET,iBAAS,gBAAgB,CAAC,KAAK,CAAC,QAAQ,SAAS,SAAS,UAAU,EAAE,EACrE,OAAO,EAAE,QAAQ,GACf,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAK7E,KAAK,YAAY,CAAC,QAAQ,SAAS,SAAS,UAAU,EAAE,IAAI,MAAM,CAAC,KAAK,CACvE,SAAS,CAAC,OAAO,iBAAiB,EAAE,OAAO,eAAe,EAAE,OAAO,iBAAiB,EAAE,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CACrH,CAAC;AAEF,wBAAgB,UAAU,CAAC,KAAK,CAAC,KAAK,SAAS,MAAM,EAAE,KAAK,CAAC,QAAQ,SAAS,SAAS,UAAU,EAAE,EAClG,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,QAAQ,GACf,GAAG,CAAC,GAAG,CACT,GAAG,KAAK,WAAW,EACnB,MAAM,CAAC,MAAM,CAAC;IAAE,OAAO,EAAE,UAAU,CAAC,OAAO,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAA;CAAE,CAAC,EACzE,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,EACrF,MAAM,CAAC,KAAK,EACZ,KAAK,EACL,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAC/B,CAAC;AAUF,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,UAAU,GAAG,YAAY,GAAG,WAAW,EAAE,QAAQ,EAAE,SAAS,GAAG,SAAS,0BAMvH"}
|
package/dist/serverMetadata.js
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
|
-
import { Context,
|
|
1
|
+
import { Context, Schema } from "effect";
|
|
2
2
|
import { Rpc } from "effect/rpc";
|
|
3
3
|
import { changesSuccess } from "#internal/changesSuccess.ts";
|
|
4
|
+
import { resolveQueries } from "#internal/resolveQueries.ts";
|
|
4
5
|
import { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
|
|
6
|
+
import { WebSocketRequired } from "#WebSocketRequired.ts";
|
|
5
7
|
export class QueryDefinition extends Context.Service()("@shivaedev/contract/QueryDefinition") {
|
|
6
8
|
}
|
|
7
9
|
export class ChangesQueries extends Context.Service()("@shivaedev/contract/ChangesQueries") {
|
|
@@ -10,22 +12,12 @@ export class CommandInvalidation extends Context.Service()("@shivaedev/contract/
|
|
|
10
12
|
}
|
|
11
13
|
export class KeyScope extends Context.Service()("@shivaedev/contract/KeyScope") {
|
|
12
14
|
}
|
|
13
|
-
function resolveQueries(queries, requested) {
|
|
14
|
-
return Effect.forEach(requested, (reference) => {
|
|
15
|
-
const query = queries.find((candidate) => candidate.name === reference.query);
|
|
16
|
-
return query === undefined ? Effect.die(new Error(`Unknown query: ${reference.query}`)) : Effect.succeed({ payload: reference.payload, query });
|
|
17
|
-
});
|
|
18
|
-
}
|
|
19
|
-
export const queryKeys = Effect.fnUntraced(function* (queries, requested, viewer = Option.none()) {
|
|
20
|
-
const resolved = yield* resolveQueries(queries, requested);
|
|
21
|
-
return resolved.flatMap(({ query, payload }) => query.reads(payload, viewer));
|
|
22
|
-
});
|
|
23
15
|
function referenceSchemas(queries) {
|
|
24
16
|
return Schema.Array(Schema.Union(queries.map((query) => Schema.Struct({ payload: query.payload, query: Schema.Literal(query.name) }))));
|
|
25
17
|
}
|
|
26
18
|
export function changesRpc(name, queries) {
|
|
27
19
|
return Rpc.make(`${name}.$changes`, {
|
|
28
|
-
error: Schema.Union([MissingReadPolicy, QueryReadDenied, ...queries.map((query) => query.error)]),
|
|
20
|
+
error: Schema.Union([MissingReadPolicy, QueryReadDenied, WebSocketRequired, ...queries.map((query) => query.error)]),
|
|
29
21
|
payload: { queries: referenceSchemas(queries) },
|
|
30
22
|
stream: true,
|
|
31
23
|
success: changesSuccess(queries),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"serverMetadata.js","sourceRoot":"","sources":["../src/serverMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,
|
|
1
|
+
{"version":3,"file":"serverMetadata.js","sourceRoot":"","sources":["../src/serverMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAe,MAAM,EAAE,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,GAAG,EAAkB,MAAM,YAAY,CAAC;AAEjD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE1D,MAAM,OAAO,eAAgB,SAAQ,OAAO,CAAC,OAAO,EAAwD,CAAC,qCAAqC,CAAC;CAAG;AAKtJ,MAAM,OAAO,cAAe,SAAQ,OAAO,CAAC,OAAO,EAMhD,CAAC,oCAAoC,CAAC;CAAG;AAE5C,MAAM,OAAO,mBAAoB,SAAQ,OAAO,CAAC,OAAO,EAA8E,CACrI,yCAAyC,CACzC;CAAG;AAEJ,MAAM,OAAO,QAAS,SAAQ,OAAO,CAAC,OAAO,EAAuB,CAAC,8BAA8B,CAAC;CAAG;AAcvG,SAAS,gBAAgB,CAAC,OAA8B;IACvD,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACzI,CAAC;AAiBD,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,OAA8B;IACtE,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,WAAW,EAAE;QACnC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,eAAe,EAAE,iBAAiB,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QACpH,OAAO,EAAE,EAAE,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,EAAE;QAC/C,MAAM,EAAE,IAAI;QACZ,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;KAChC,CAAC,CAAC,QAAQ,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC;AACxG,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,SAAkD,EAAE,QAA+B;IACvH,MAAM,KAAK,GAAG,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC1F,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,mBAAmB,EAAE,EAAE,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC;IACxF,CAAC;IACD,OAAO,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC5G,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shivaedev/contract",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.29.0",
|
|
4
4
|
"description": "Typed query and command contracts over native Effect RPC and reactivity",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"effect"
|
|
@@ -50,13 +50,13 @@
|
|
|
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.11.
|
|
55
|
-
"@shivaedev/quality": "0.
|
|
56
|
-
"@shivaedev/server": "0.
|
|
53
|
+
"@shivaedev/errors": "0.3.0",
|
|
54
|
+
"@shivaedev/identity": "0.11.1",
|
|
55
|
+
"@shivaedev/quality": "0.50.0",
|
|
56
|
+
"@shivaedev/server": "0.12.0",
|
|
57
57
|
"@shivaedev/test": "0.12.0",
|
|
58
58
|
"@shivaedev/test-sql": "0.15.0",
|
|
59
|
-
"@shivaedev/test-story": "0.
|
|
59
|
+
"@shivaedev/test-story": "0.30.0",
|
|
60
60
|
"@types/node": "24.19.2",
|
|
61
61
|
"effect": "4.0.6",
|
|
62
62
|
"esbuild": "0.28.2",
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { Effect, Option } from "effect";
|
|
2
|
+
import type { Key } from "@shivaedev/changes/keys.ts";
|
|
3
|
+
import type { Viewer } from "#readPolicy.ts";
|
|
4
|
+
|
|
5
|
+
export type QueryServerReads<TPayload, E = never, R = never> = (
|
|
6
|
+
payload: TPayload,
|
|
7
|
+
viewer: Option.Option<Viewer>,
|
|
8
|
+
) => Effect.Effect<readonly Key[], E, R>;
|
package/src/automaticLive.ts
CHANGED
|
@@ -77,7 +77,7 @@ export function automaticLive(
|
|
|
77
77
|
}
|
|
78
78
|
const ready = Atom.make(false);
|
|
79
79
|
const delivery = queryDelivery(atom, decode, paused);
|
|
80
|
-
const source = delivery.atom;
|
|
80
|
+
const source = decode === undefined ? delivery.atom.pipe(Atom.setIdleTTL(0)) : delivery.atom;
|
|
81
81
|
const subscription = live(service.runtime, {
|
|
82
82
|
initialResync: false,
|
|
83
83
|
keyContext: owner?.context,
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type
|
|
1
|
+
import { Cause, type Duration, Option, Predicate } from "effect";
|
|
2
2
|
import * as AsyncResult from "effect/reactivity/AsyncResult";
|
|
3
3
|
import * as Atom from "effect/reactivity/Atom";
|
|
4
4
|
import type { LiveBound, LiveConnection } from "#automaticLive.ts";
|
|
@@ -38,6 +38,9 @@ export function automaticQuery<A, E>({
|
|
|
38
38
|
assertOwner(get);
|
|
39
39
|
const registry = get.registry;
|
|
40
40
|
const dispatcher = registry.schedulerAsync.makeDispatcher();
|
|
41
|
+
let denied = false;
|
|
42
|
+
let stopSource: (() => void) | undefined;
|
|
43
|
+
get.addFinalizer(() => stopSource?.());
|
|
41
44
|
get.set(ready, false);
|
|
42
45
|
get.once(queryCoalesceWindow(gated));
|
|
43
46
|
get.subscribe(queryCoalesceWindow(gated), (value) => get.set(queryCoalesceWindow(atom), value), { immediate: true });
|
|
@@ -50,6 +53,7 @@ export function automaticQuery<A, E>({
|
|
|
50
53
|
}
|
|
51
54
|
}, 0);
|
|
52
55
|
if (value.connection === "live") {
|
|
56
|
+
denied = false;
|
|
53
57
|
registry.set(ready, true);
|
|
54
58
|
}
|
|
55
59
|
}
|
|
@@ -67,15 +71,19 @@ export function automaticQuery<A, E>({
|
|
|
67
71
|
get.addFinalizer(registry.subscribe(coalesceWindow, (value) => registry.set(subscription.coalesceWindow, value), { immediate: true }));
|
|
68
72
|
let started = false;
|
|
69
73
|
function start() {
|
|
70
|
-
if (
|
|
74
|
+
if (stopSource !== undefined) {
|
|
71
75
|
return;
|
|
72
76
|
}
|
|
73
77
|
started = true;
|
|
74
78
|
if (!pushed) {
|
|
75
79
|
get.refresh(source);
|
|
76
80
|
}
|
|
77
|
-
const publish = queryResult<A, E>(equivalent, (value) =>
|
|
78
|
-
|
|
81
|
+
const publish = queryResult<A, E>(equivalent, (value) => {
|
|
82
|
+
if (!denied) {
|
|
83
|
+
get.setSelf(value);
|
|
84
|
+
}
|
|
85
|
+
});
|
|
86
|
+
stopSource = registry.subscribe(source, publish);
|
|
79
87
|
publish(get.once(source));
|
|
80
88
|
}
|
|
81
89
|
get.once(ready);
|
|
@@ -86,7 +94,15 @@ export function automaticQuery<A, E>({
|
|
|
86
94
|
});
|
|
87
95
|
const failed = queryFailure(
|
|
88
96
|
() => started && !pushed,
|
|
89
|
-
(cause) =>
|
|
97
|
+
(cause) => {
|
|
98
|
+
if (Option.exists(Cause.findErrorOption(cause), Predicate.isTagged("QueryReadDenied"))) {
|
|
99
|
+
denied = true;
|
|
100
|
+
registry.set(ready, false);
|
|
101
|
+
stopSource?.();
|
|
102
|
+
stopSource = undefined;
|
|
103
|
+
}
|
|
104
|
+
get.setSelf(AsyncResult.failure(cause));
|
|
105
|
+
},
|
|
90
106
|
);
|
|
91
107
|
get.subscribe(subscription.status, failed);
|
|
92
108
|
get.addFinalizer(registry.subscribe(paused, (value) => registry.set(subscription.paused, value), { immediate: true }));
|
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
import { Schema } from "effect";
|
|
2
2
|
import type { OperationShape } from "#operation.ts";
|
|
3
|
-
import { type RejectionSpecs, rejectionSet } from "#rejection.ts";
|
|
3
|
+
import { type MatchingTags, type RejectionSpecs, rejectionSet } from "#rejection.ts";
|
|
4
|
+
|
|
5
|
+
export interface Declaration<TPayload extends Schema.Top | Schema.Struct.Fields, TSuccess extends Schema.Top, TSpecs extends RejectionSpecs> {
|
|
6
|
+
readonly payload?: TPayload;
|
|
7
|
+
readonly rejections?: TSpecs & MatchingTags<TSpecs>;
|
|
8
|
+
readonly success?: TSuccess;
|
|
9
|
+
}
|
|
4
10
|
|
|
5
11
|
export interface Loose {
|
|
6
12
|
readonly payload?: Schema.Top | Schema.Struct.Fields;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Duration, Effect } from "effect";
|
|
1
|
+
import { Cause, Duration, Effect, Option, Predicate } from "effect";
|
|
2
2
|
import * as AsyncResult from "effect/reactivity/AsyncResult";
|
|
3
3
|
import * as Atom from "effect/reactivity/Atom";
|
|
4
4
|
import type * as AtomRegistry from "effect/reactivity/AtomRegistry";
|
|
@@ -55,6 +55,15 @@ export function queryReactivity<R, E>(runtime: Atom.AtomRuntime<R, E>, queue?: (
|
|
|
55
55
|
pending = undefined;
|
|
56
56
|
dequeue();
|
|
57
57
|
}
|
|
58
|
+
function reread() {
|
|
59
|
+
if (
|
|
60
|
+
!Option.exists(AsyncResult.cause(get.once(source)), (cause) =>
|
|
61
|
+
Option.exists(Cause.findErrorOption(cause), Predicate.isTagged("QueryReadDenied")),
|
|
62
|
+
)
|
|
63
|
+
) {
|
|
64
|
+
get.refresh(source);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
58
67
|
function refresh(active: () => boolean) {
|
|
59
68
|
if (!active()) {
|
|
60
69
|
dequeue();
|
|
@@ -64,7 +73,7 @@ export function queryReactivity<R, E>(runtime: Atom.AtomRuntime<R, E>, queue?: (
|
|
|
64
73
|
pending = active;
|
|
65
74
|
} else {
|
|
66
75
|
pending = undefined;
|
|
67
|
-
|
|
76
|
+
reread();
|
|
68
77
|
dequeue();
|
|
69
78
|
}
|
|
70
79
|
}
|
|
@@ -77,7 +86,7 @@ export function queryReactivity<R, E>(runtime: Atom.AtomRuntime<R, E>, queue?: (
|
|
|
77
86
|
const delay = Duration.toMillis(Duration.fromInputUnsafe(get.once(queryCoalesceWindow(wrapped)) ?? batch.window ?? 0));
|
|
78
87
|
if (delay === 0) {
|
|
79
88
|
clear();
|
|
80
|
-
|
|
89
|
+
reread();
|
|
81
90
|
} else if (!scheduled) {
|
|
82
91
|
queued ??= queue?.();
|
|
83
92
|
scheduled = true;
|
|
@@ -90,7 +99,7 @@ export function queryReactivity<R, E>(runtime: Atom.AtomRuntime<R, E>, queue?: (
|
|
|
90
99
|
reactivity.registerUnsafe(keys, () => {
|
|
91
100
|
if (!liveBatches.has(reactivity)) {
|
|
92
101
|
clear();
|
|
93
|
-
|
|
102
|
+
reread();
|
|
94
103
|
}
|
|
95
104
|
}),
|
|
96
105
|
);
|
|
@@ -100,7 +109,7 @@ export function queryReactivity<R, E>(runtime: Atom.AtomRuntime<R, E>, queue?: (
|
|
|
100
109
|
const active = pending;
|
|
101
110
|
pending = undefined;
|
|
102
111
|
if (active()) {
|
|
103
|
-
|
|
112
|
+
reread();
|
|
104
113
|
}
|
|
105
114
|
dequeue();
|
|
106
115
|
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { Effect, type Option } from "effect";
|
|
2
|
+
import type { QueryShape } from "#operation.ts";
|
|
3
|
+
import type { Viewer } from "#readPolicy.ts";
|
|
4
|
+
|
|
5
|
+
export const queryReadKeys = Effect.fnUntraced(function* <E, R>(query: QueryShape<E, R>, payload: unknown, viewer: Option.Option<Viewer>) {
|
|
6
|
+
const derived = query.serverReads === undefined ? [] : yield* query.serverReads(payload, viewer);
|
|
7
|
+
return [...query.reads(payload, viewer), ...derived];
|
|
8
|
+
});
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { Effect } from "effect";
|
|
2
|
+
import type { QueryShape } from "#operation.ts";
|
|
3
|
+
import type { QueryReference } from "#serverMetadata.ts";
|
|
4
|
+
|
|
5
|
+
export function resolveQueries(queries: readonly QueryShape[], requested: readonly QueryReference[]) {
|
|
6
|
+
return Effect.forEach(requested, (reference) => {
|
|
7
|
+
const query = queries.find((candidate) => candidate.name === reference.query);
|
|
8
|
+
return query === undefined ? Effect.die(new Error(`Unknown query: ${reference.query}`)) : Effect.succeed({ payload: reference.payload, query });
|
|
9
|
+
});
|
|
10
|
+
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Effect } from "effect";
|
|
1
|
+
import { Cause, Effect, Option, Predicate } from "effect";
|
|
2
2
|
import type * as Atom from "effect/reactivity/Atom";
|
|
3
3
|
import * as AtomRegistry from "effect/reactivity/AtomRegistry";
|
|
4
4
|
import * as Reactivity from "effect/reactivity/Reactivity";
|
|
@@ -9,13 +9,20 @@ export const retryOnChange = Effect.fnUntraced(function* <E>(status: Atom.Atom<L
|
|
|
9
9
|
const registry = yield* AtomRegistry.AtomRegistry;
|
|
10
10
|
const dispatcher = registry.schedulerAsync.makeDispatcher();
|
|
11
11
|
let active = true;
|
|
12
|
+
function canRetry() {
|
|
13
|
+
const current = registry.get(status);
|
|
14
|
+
return (
|
|
15
|
+
current.connection === "failed"
|
|
16
|
+
&& !Option.exists(current.failure, (cause) => Option.exists(Cause.findErrorOption(cause), Predicate.isTagged("QueryReadDenied")))
|
|
17
|
+
);
|
|
18
|
+
}
|
|
12
19
|
function retry() {
|
|
13
|
-
if (active &&
|
|
20
|
+
if (active && canRetry()) {
|
|
14
21
|
restart();
|
|
15
22
|
}
|
|
16
23
|
}
|
|
17
24
|
function changed() {
|
|
18
|
-
if (
|
|
25
|
+
if (canRetry()) {
|
|
19
26
|
dispatcher.scheduleTask(retry, 0);
|
|
20
27
|
}
|
|
21
28
|
}
|
package/src/operation.ts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
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 Loose, operation } from "#internal/operationDeclaration.ts";
|
|
4
|
+
import { type Declaration, type Loose, operation } from "#internal/operationDeclaration.ts";
|
|
5
|
+
import type { QueryServerReads } from "#QueryServerReads.ts";
|
|
5
6
|
import type { QueryReadPolicy, Viewer } from "#readPolicy.ts";
|
|
6
|
-
import type {
|
|
7
|
+
import type { Reject, RejectedBy, RejectionSpecs, Rejections, RejectionUnion } from "#rejection.ts";
|
|
7
8
|
|
|
8
9
|
export type PayloadSchema<TPayload extends Schema.Top | Schema.Struct.Fields> = TPayload extends Schema.Struct.Fields
|
|
9
10
|
? Schema.Struct<TPayload>
|
|
@@ -27,6 +28,7 @@ export interface QueryShape<E = unknown, R = unknown> extends OperationShape {
|
|
|
27
28
|
readonly live?: "rerun-and-compare" | undefined;
|
|
28
29
|
readonly readPolicy: Bivariant<QueryReadPolicy<unknown, E, R>>;
|
|
29
30
|
reads: Bivariant<(payload: unknown, viewer: Option.Option<Viewer>) => readonly Key[]>;
|
|
31
|
+
readonly serverReads?: Bivariant<QueryServerReads<unknown, E, R>>;
|
|
30
32
|
}
|
|
31
33
|
|
|
32
34
|
export interface StreamShape extends OperationShape {
|
|
@@ -62,6 +64,7 @@ export interface Query<
|
|
|
62
64
|
readonly live?: TLive;
|
|
63
65
|
readonly readPolicy: QueryReadPolicy<TPayload["Type"], RejectedBy<TSpecs>, R>;
|
|
64
66
|
reads: (payload: TPayload["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
|
|
67
|
+
readonly serverReads?: QueryServerReads<TPayload["Type"], RejectedBy<TSpecs>, R>;
|
|
65
68
|
}
|
|
66
69
|
|
|
67
70
|
export interface Streaming<TName extends string, TPayload extends Schema.Top, TSuccess extends Schema.Top, TSpecs extends RejectionSpecs>
|
|
@@ -76,12 +79,6 @@ export interface Command<TName extends string, TPayload extends Schema.Top, TSuc
|
|
|
76
79
|
readonly kind: "command";
|
|
77
80
|
}
|
|
78
81
|
|
|
79
|
-
interface Declaration<TPayload extends Schema.Top | Schema.Struct.Fields, TSuccess extends Schema.Top, TSpecs extends RejectionSpecs> {
|
|
80
|
-
readonly payload?: TPayload;
|
|
81
|
-
readonly rejections?: TSpecs & MatchingTags<TSpecs>;
|
|
82
|
-
readonly success?: TSuccess;
|
|
83
|
-
}
|
|
84
|
-
|
|
85
82
|
export function query<
|
|
86
83
|
const TName extends string,
|
|
87
84
|
TPayload extends Schema.Top | Schema.Struct.Fields = Schema.Void,
|
|
@@ -95,6 +92,7 @@ export function query<
|
|
|
95
92
|
readonly live?: TLive;
|
|
96
93
|
readonly reads: (payload: PayloadSchema<TPayload>["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
|
|
97
94
|
readonly readPolicy: QueryReadPolicy<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
|
|
95
|
+
readonly serverReads?: QueryServerReads<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
|
|
98
96
|
},
|
|
99
97
|
): NoInfer<Query<TName, PayloadSchema<TPayload>, TSuccess, TSpecs, R, TLive>>;
|
|
100
98
|
export function query(
|
|
@@ -103,6 +101,7 @@ export function query(
|
|
|
103
101
|
readonly live?: "rerun-and-compare" | undefined;
|
|
104
102
|
readonly reads: (payload: unknown, viewer: Option.Option<Viewer>) => readonly Key[];
|
|
105
103
|
readonly readPolicy: QueryReadPolicy<unknown, unknown, unknown>;
|
|
104
|
+
readonly serverReads?: QueryServerReads<unknown, unknown, unknown>;
|
|
106
105
|
},
|
|
107
106
|
): QueryShape {
|
|
108
107
|
return {
|
|
@@ -110,6 +109,7 @@ export function query(
|
|
|
110
109
|
live: declaration.live,
|
|
111
110
|
readPolicy: declaration.readPolicy,
|
|
112
111
|
reads: declaration.reads,
|
|
112
|
+
...(declaration.serverReads === undefined ? {} : { serverReads: declaration.serverReads }),
|
|
113
113
|
};
|
|
114
114
|
}
|
|
115
115
|
|
package/src/queryKeys.ts
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { Effect, Option } from "effect";
|
|
2
|
+
import type { Key } from "@shivaedev/changes/keys.ts";
|
|
3
|
+
import type { QueryServices } from "#contract.ts";
|
|
4
|
+
import { queryReadKeys } from "#internal/queryReadKeys.ts";
|
|
5
|
+
import { resolveQueries } from "#internal/resolveQueries.ts";
|
|
6
|
+
import type { QueryShape } from "#operation.ts";
|
|
7
|
+
import { checkQuery, type Viewer } from "#readPolicy.ts";
|
|
8
|
+
import type { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
|
|
9
|
+
import type { QueryReference } from "#serverMetadata.ts";
|
|
10
|
+
|
|
11
|
+
export function queryKeys<const TQueries extends readonly QueryShape[]>(
|
|
12
|
+
queries: TQueries,
|
|
13
|
+
requested: readonly QueryReference[],
|
|
14
|
+
viewer?: Option.Option<Viewer>,
|
|
15
|
+
): Effect.Effect<readonly Key[], TQueries[number]["error"]["Type"] | MissingReadPolicy | QueryReadDenied, QueryServices<TQueries[number]>>;
|
|
16
|
+
export function queryKeys(queries: readonly QueryShape[], requested: readonly QueryReference[], viewer: Option.Option<Viewer> = Option.none()) {
|
|
17
|
+
return Effect.fnUntraced(function* () {
|
|
18
|
+
const resolved = yield* resolveQueries(queries, requested);
|
|
19
|
+
yield* Effect.forEach(resolved, ({ query, payload }) => checkQuery(query, payload, viewer));
|
|
20
|
+
const scopes = yield* Effect.forEach(resolved, ({ query, payload }) => queryReadKeys(query, payload, viewer));
|
|
21
|
+
return scopes.flat();
|
|
22
|
+
})();
|
|
23
|
+
}
|
package/src/querySubscription.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { Context, Effect, type Option } from "effect";
|
|
|
2
2
|
import { Rpc } from "effect/rpc";
|
|
3
3
|
import type { Key } from "@shivaedev/changes/keys.ts";
|
|
4
4
|
import { policyContext } from "#internal/policyContext.ts";
|
|
5
|
+
import { queryReadKeys } from "#internal/queryReadKeys.ts";
|
|
5
6
|
import { checkQuery, type PolicyChannels, type Viewer } from "#readPolicy.ts";
|
|
6
7
|
import type { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
|
|
7
8
|
import { ChangesQueries, type QueryReference, type QueryRequest } from "#serverMetadata.ts";
|
|
@@ -34,12 +35,13 @@ export function querySubscription(rpc: Rpc.Any, references: readonly QueryRefere
|
|
|
34
35
|
const context = yield* policyContext(Rpc.make(`${prefix}${query.name}`));
|
|
35
36
|
return {
|
|
36
37
|
check: Effect.provideContext(checkQuery(query, payload, viewer), context),
|
|
38
|
+
keys: queryReadKeys(query, payload, viewer).pipe(Effect.provideContext(context)),
|
|
37
39
|
permitted: Effect.suspend(() => query.readPolicy?.(payload, viewer) ?? Effect.succeed(false)).pipe(Effect.provideContext(context)),
|
|
38
40
|
};
|
|
39
41
|
}),
|
|
40
42
|
);
|
|
41
43
|
yield* Effect.forEach(policies, ({ check }) => check);
|
|
42
|
-
const scopes =
|
|
44
|
+
const scopes = yield* Effect.forEach(policies, ({ keys }) => keys);
|
|
43
45
|
const authorized = Effect.map(
|
|
44
46
|
Effect.forEach(policies, ({ permitted }) => permitted),
|
|
45
47
|
(permissions) => permissions.every(Boolean),
|
package/src/serverMetadata.ts
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import { Context, Effect,
|
|
1
|
+
import { Context, type Effect, Schema } from "effect";
|
|
2
2
|
import { Rpc, type RpcSchema } from "effect/rpc";
|
|
3
|
-
import type { Key } from "@shivaedev/changes/keys.ts";
|
|
4
3
|
import type { QueryServices } from "#contract.ts";
|
|
5
4
|
import { changesSuccess } from "#internal/changesSuccess.ts";
|
|
5
|
+
import { resolveQueries } from "#internal/resolveQueries.ts";
|
|
6
6
|
import type { CommandShape, QueryShape, StreamShape } from "#operation.ts";
|
|
7
|
-
import type { Viewer } from "#readPolicy.ts";
|
|
8
7
|
import { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
|
|
8
|
+
import { WebSocketRequired } from "#WebSocketRequired.ts";
|
|
9
9
|
|
|
10
10
|
export class QueryDefinition extends Context.Service<QueryDefinition, { readonly definition: QueryShape }>()("@shivaedev/contract/QueryDefinition") {}
|
|
11
11
|
export interface QueryRequest<E = unknown, R = unknown> {
|
|
@@ -35,22 +35,6 @@ type ReferenceSchema<TQuery extends QueryShape> = TQuery extends QueryShape
|
|
|
35
35
|
? Schema.Struct<{ query: Schema.Literal<TQuery["name"]>; payload: TQuery["payload"] }>
|
|
36
36
|
: never;
|
|
37
37
|
|
|
38
|
-
function resolveQueries(queries: readonly QueryShape[], requested: readonly QueryReference[]) {
|
|
39
|
-
return Effect.forEach(requested, (reference) => {
|
|
40
|
-
const query = queries.find((candidate) => candidate.name === reference.query);
|
|
41
|
-
return query === undefined ? Effect.die(new Error(`Unknown query: ${reference.query}`)) : Effect.succeed({ payload: reference.payload, query });
|
|
42
|
-
});
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
export const queryKeys = Effect.fnUntraced(function* (
|
|
46
|
-
queries: readonly QueryShape[],
|
|
47
|
-
requested: readonly QueryReference[],
|
|
48
|
-
viewer: Option.Option<Viewer> = Option.none(),
|
|
49
|
-
): Effect.fn.Return<readonly Key[]> {
|
|
50
|
-
const resolved = yield* resolveQueries(queries, requested);
|
|
51
|
-
return resolved.flatMap(({ query, payload }) => query.reads(payload, viewer));
|
|
52
|
-
});
|
|
53
|
-
|
|
54
38
|
function referenceSchemas<const TQueries extends readonly QueryShape[]>(
|
|
55
39
|
queries: TQueries,
|
|
56
40
|
): Schema.$Array<Schema.Union<readonly ReferenceSchema<TQueries[number]>[]>>;
|
|
@@ -59,7 +43,7 @@ function referenceSchemas(queries: readonly QueryShape[]) {
|
|
|
59
43
|
}
|
|
60
44
|
|
|
61
45
|
type ChangesError<TQueries extends readonly QueryShape[]> = Schema.Union<
|
|
62
|
-
readonly [typeof MissingReadPolicy, typeof QueryReadDenied, ...TQueries[number]["error"][]]
|
|
46
|
+
readonly [typeof MissingReadPolicy, typeof QueryReadDenied, typeof WebSocketRequired, ...TQueries[number]["error"][]]
|
|
63
47
|
>;
|
|
64
48
|
|
|
65
49
|
export function changesRpc<const TName extends string, const TQueries extends readonly QueryShape[]>(
|
|
@@ -75,7 +59,7 @@ export function changesRpc<const TName extends string, const TQueries extends re
|
|
|
75
59
|
>;
|
|
76
60
|
export function changesRpc(name: string, queries: readonly QueryShape[]) {
|
|
77
61
|
return Rpc.make(`${name}.$changes`, {
|
|
78
|
-
error: Schema.Union([MissingReadPolicy, QueryReadDenied, ...queries.map((query) => query.error)]),
|
|
62
|
+
error: Schema.Union([MissingReadPolicy, QueryReadDenied, WebSocketRequired, ...queries.map((query) => query.error)]),
|
|
79
63
|
payload: { queries: referenceSchemas(queries) },
|
|
80
64
|
stream: true,
|
|
81
65
|
success: changesSuccess(queries),
|