@shivaedev/contract 0.27.0 → 0.28.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.
Files changed (68) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/README.md +135 -20
  3. package/dist/LiveServer.d.ts +30 -0
  4. package/dist/LiveServer.d.ts.map +1 -0
  5. package/dist/LiveServer.js +16 -0
  6. package/dist/LiveServer.js.map +1 -0
  7. package/dist/bind.d.ts +1 -2
  8. package/dist/bind.d.ts.map +1 -1
  9. package/dist/bind.js.map +1 -1
  10. package/dist/clientOptions.d.ts +1 -0
  11. package/dist/clientOptions.d.ts.map +1 -1
  12. package/dist/internal/clientOperations.d.ts.map +1 -1
  13. package/dist/internal/clientOperations.js +0 -4
  14. package/dist/internal/clientOperations.js.map +1 -1
  15. package/dist/internal/policyContext.d.ts +4 -0
  16. package/dist/internal/policyContext.d.ts.map +1 -0
  17. package/dist/internal/policyContext.js +7 -0
  18. package/dist/internal/policyContext.js.map +1 -0
  19. package/dist/internal/rpcClient.d.ts.map +1 -1
  20. package/dist/internal/rpcClient.js +11 -1
  21. package/dist/internal/rpcClient.js.map +1 -1
  22. package/dist/operation.d.ts +3 -3
  23. package/dist/operation.d.ts.map +1 -1
  24. package/dist/operation.js +1 -1
  25. package/dist/operation.js.map +1 -1
  26. package/dist/querySubscription.d.ts +1 -1
  27. package/dist/querySubscription.d.ts.map +1 -1
  28. package/dist/querySubscription.js +12 -2
  29. package/dist/querySubscription.js.map +1 -1
  30. package/dist/readPolicy.d.ts +1 -0
  31. package/dist/readPolicy.d.ts.map +1 -1
  32. package/dist/readPolicy.js +6 -3
  33. package/dist/readPolicy.js.map +1 -1
  34. package/dist/readPolicyErrors.d.ts +6 -0
  35. package/dist/readPolicyErrors.d.ts.map +1 -1
  36. package/dist/readPolicyErrors.js +5 -0
  37. package/dist/readPolicyErrors.js.map +1 -1
  38. package/dist/serverMetadata.d.ts +1 -0
  39. package/dist/serverMetadata.d.ts.map +1 -1
  40. package/dist/serverMetadata.js +1 -1
  41. package/dist/serverMetadata.js.map +1 -1
  42. package/dist/socketAuthentication.d.ts +18 -0
  43. package/dist/socketAuthentication.d.ts.map +1 -0
  44. package/dist/socketAuthentication.js +27 -0
  45. package/dist/socketAuthentication.js.map +1 -0
  46. package/dist/testing.d.ts +4 -2
  47. package/dist/testing.d.ts.map +1 -1
  48. package/dist/testing.js +35 -1
  49. package/dist/testing.js.map +1 -1
  50. package/dist/validateReadPolicies.d.ts +5 -0
  51. package/dist/validateReadPolicies.d.ts.map +1 -0
  52. package/dist/validateReadPolicies.js +25 -0
  53. package/dist/validateReadPolicies.js.map +1 -0
  54. package/package.json +7 -3
  55. package/src/LiveServer.ts +20 -0
  56. package/src/bind.ts +1 -5
  57. package/src/clientOptions.ts +1 -0
  58. package/src/internal/clientOperations.ts +0 -6
  59. package/src/internal/policyContext.ts +8 -0
  60. package/src/internal/rpcClient.ts +14 -5
  61. package/src/operation.ts +5 -5
  62. package/src/querySubscription.ts +15 -3
  63. package/src/readPolicy.ts +7 -3
  64. package/src/readPolicyErrors.ts +5 -0
  65. package/src/serverMetadata.ts +2 -1
  66. package/src/socketAuthentication.ts +28 -0
  67. package/src/testing.ts +42 -2
  68. package/src/validateReadPolicies.ts +26 -0
package/src/operation.ts CHANGED
@@ -25,7 +25,7 @@ export interface OperationShape {
25
25
  export interface QueryShape<E = unknown, R = unknown> extends OperationShape {
26
26
  readonly kind: "query";
27
27
  readonly live?: "rerun-and-compare" | undefined;
28
- readonly readPolicy?: Bivariant<QueryReadPolicy<unknown, E, R>>;
28
+ readonly readPolicy: Bivariant<QueryReadPolicy<unknown, E, R>>;
29
29
  reads: Bivariant<(payload: unknown, viewer: Option.Option<Viewer>) => readonly Key[]>;
30
30
  }
31
31
 
@@ -60,7 +60,7 @@ export interface Query<
60
60
  > extends Operation<TName, TPayload, TSuccess, TSpecs> {
61
61
  readonly kind: "query";
62
62
  readonly live?: TLive;
63
- readonly readPolicy?: QueryReadPolicy<TPayload["Type"], RejectedBy<TSpecs>, R>;
63
+ readonly readPolicy: QueryReadPolicy<TPayload["Type"], RejectedBy<TSpecs>, R>;
64
64
  reads: (payload: TPayload["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
65
65
  }
66
66
 
@@ -94,7 +94,7 @@ export function query<
94
94
  declaration: Declaration<TPayload, TSuccess, TSpecs> & {
95
95
  readonly live?: TLive;
96
96
  readonly reads: (payload: PayloadSchema<TPayload>["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
97
- readonly readPolicy?: QueryReadPolicy<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
97
+ readonly readPolicy: QueryReadPolicy<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
98
98
  },
99
99
  ): NoInfer<Query<TName, PayloadSchema<TPayload>, TSuccess, TSpecs, R, TLive>>;
100
100
  export function query(
@@ -102,14 +102,14 @@ export function query(
102
102
  declaration: Loose & {
103
103
  readonly live?: "rerun-and-compare" | undefined;
104
104
  readonly reads: (payload: unknown, viewer: Option.Option<Viewer>) => readonly Key[];
105
- readonly readPolicy?: QueryReadPolicy<unknown, unknown, unknown>;
105
+ readonly readPolicy: QueryReadPolicy<unknown, unknown, unknown>;
106
106
  },
107
107
  ): QueryShape {
108
108
  return {
109
109
  ...operation("query", name, declaration),
110
110
  live: declaration.live,
111
+ readPolicy: declaration.readPolicy,
111
112
  reads: declaration.reads,
112
- ...(declaration.readPolicy === undefined ? {} : { readPolicy: declaration.readPolicy }),
113
113
  };
114
114
  }
115
115
 
@@ -1,6 +1,7 @@
1
1
  import { Context, Effect, type Option } from "effect";
2
- import type { Rpc } from "effect/rpc";
2
+ import { Rpc } from "effect/rpc";
3
3
  import type { Key } from "@shivaedev/changes/keys.ts";
4
+ import { policyContext } from "#internal/policyContext.ts";
4
5
  import { checkQuery, type PolicyChannels, type Viewer } from "#readPolicy.ts";
5
6
  import type { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
6
7
  import { ChangesQueries, type QueryReference, type QueryRequest } from "#serverMetadata.ts";
@@ -26,10 +27,21 @@ export function querySubscription<TRpc extends Rpc.Any>(
26
27
  export function querySubscription(rpc: Rpc.Any, references: readonly QueryReference[], viewer: Option.Option<Viewer>) {
27
28
  return Effect.fnUntraced(function* () {
28
29
  const queries = yield* Context.getUnsafe(rpc.annotations, ChangesQueries).resolve(references);
29
- yield* Effect.forEach(queries, ({ query, payload }) => checkQuery(query, payload, viewer));
30
+ const prefix = rpc._tag.slice(0, -"$changes".length);
31
+ const policies = yield* Effect.forEach(
32
+ queries,
33
+ Effect.fnUntraced(function* ({ query, payload }) {
34
+ const context = yield* policyContext(Rpc.make(`${prefix}${query.name}`));
35
+ return {
36
+ check: Effect.provideContext(checkQuery(query, payload, viewer), context),
37
+ permitted: Effect.suspend(() => query.readPolicy?.(payload, viewer) ?? Effect.succeed(false)).pipe(Effect.provideContext(context)),
38
+ };
39
+ }),
40
+ );
41
+ yield* Effect.forEach(policies, ({ check }) => check);
30
42
  const scopes = queries.map(({ query, payload }) => query.reads(payload, viewer));
31
43
  const authorized = Effect.map(
32
- Effect.forEach(queries, ({ query, payload }) => query.readPolicy?.(payload, viewer) ?? Effect.succeed(false)),
44
+ Effect.forEach(policies, ({ permitted }) => permitted),
33
45
  (permissions) => permissions.every(Boolean),
34
46
  );
35
47
  return { authorized, keys: scopes.flat(), queries, scopes } satisfies QuerySubscription<unknown, unknown>;
package/src/readPolicy.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import { Context, Effect, Option, type Stream, type Types } from "effect";
2
2
  import type { Rpc } from "effect/rpc";
3
+ import { policyContext } from "#internal/policyContext.ts";
3
4
  import type { QueryShape } from "#operation.ts";
4
5
  import { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
5
6
  import { QueryDefinition } from "#serverMetadata.ts";
@@ -10,9 +11,11 @@ export interface Viewer {
10
11
  export type QueryReadPolicy<TPayload, E = never, R = never> = (payload: TPayload, viewer: Option.Option<Viewer>) => Effect.Effect<boolean, E, R>;
11
12
 
12
13
  export const CurrentViewer = Context.Reference<Option.Option<Viewer>>("@shivaedev/contract/CurrentViewer", { defaultValue: Option.none });
14
+ export const signedIn: QueryReadPolicy<unknown> = (_payload, viewer) => Effect.succeed(Option.isSome(viewer));
15
+
13
16
  export const checkQuery = Effect.fnUntraced(function* <E, R>(query: QueryShape<E, R>, payload: unknown, viewer: Option.Option<Viewer>) {
14
17
  if (query.readPolicy === undefined) {
15
- return yield* new MissingReadPolicy({ message: `Declare a readPolicy on query ${query.name} before running it live or subscribing` });
18
+ return yield* new MissingReadPolicy({ message: `Declare a readPolicy on query ${query.name} before reading it or subscribing` });
16
19
  }
17
20
  if (!(yield* query.readPolicy(payload, viewer))) {
18
21
  return yield* new QueryReadDenied({ message: `Read not allowed for query ${query.name}` });
@@ -41,8 +44,9 @@ export function authorizeReads(
41
44
  ) {
42
45
  return Effect.fnUntraced(function* () {
43
46
  const definition = Context.getOption(request.rpc.annotations, QueryDefinition);
44
- if (Option.isSome(definition) && definition.value.definition.readPolicy !== undefined) {
45
- yield* checkQuery(definition.value.definition, request.payload, viewer);
47
+ if (Option.isSome(definition)) {
48
+ const context = yield* policyContext(request.rpc);
49
+ yield* checkQuery(definition.value.definition, request.payload, viewer).pipe(Effect.provideContext(context));
46
50
  }
47
51
  return yield* Effect.provideService(effect, CurrentViewer, viewer);
48
52
  })();
@@ -2,3 +2,8 @@ import { Schema } from "effect";
2
2
 
3
3
  export class MissingReadPolicy extends Schema.TaggedError<MissingReadPolicy>()("MissingReadPolicy", { message: Schema.String }) {}
4
4
  export class QueryReadDenied extends Schema.TaggedError<QueryReadDenied>()("QueryReadDenied", { message: Schema.String }) {}
5
+
6
+ export class MissingReadPolicies extends Schema.TaggedError<MissingReadPolicies>()("MissingReadPolicies", {
7
+ message: Schema.String,
8
+ queries: Schema.Array(Schema.String),
9
+ }) {}
@@ -15,6 +15,7 @@ export interface QueryRequest<E = unknown, R = unknown> {
15
15
  export class ChangesQueries extends Context.Service<
16
16
  ChangesQueries,
17
17
  {
18
+ readonly queries: readonly QueryShape[];
18
19
  readonly resolve: (references: readonly QueryReference[]) => Effect.Effect<readonly QueryRequest[]>;
19
20
  }
20
21
  >()("@shivaedev/contract/ChangesQueries") {}
@@ -78,7 +79,7 @@ export function changesRpc(name: string, queries: readonly QueryShape[]) {
78
79
  payload: { queries: referenceSchemas(queries) },
79
80
  stream: true,
80
81
  success: changesSuccess(queries),
81
- }).annotate(ChangesQueries, { resolve: (references) => resolveQueries(queries, references) });
82
+ }).annotate(ChangesQueries, { queries, resolve: (references) => resolveQueries(queries, references) });
82
83
  }
83
84
 
84
85
  export function operationAnnotations(operation: QueryShape | CommandShape | StreamShape, keyScope: "session" | undefined) {
@@ -0,0 +1,28 @@
1
+ import { Effect, Latch, Schema } from "effect";
2
+ import * as Socket from "effect/socket/Socket";
3
+
4
+ export const SocketAuthentication = Schema.Struct({
5
+ _tag: Schema.Literal("Authenticate"),
6
+ token: Schema.String.check(Schema.isPattern(/^[\x21-\x7e]+$/u)),
7
+ });
8
+
9
+ export const authenticateSocket = Effect.fnUntraced(function* (token: string) {
10
+ const socket = yield* Socket.Socket;
11
+ const ready = yield* Latch.make(false);
12
+ const writer = yield* Effect.map(socket.writer, (nativeWriter) => ({
13
+ write: (chunk: Parameters<typeof nativeWriter.write>[0]) => ready.await.pipe(Effect.andThen(nativeWriter.write(chunk))),
14
+ writeAll: (chunks: Parameters<typeof nativeWriter.writeAll>[0]) => ready.await.pipe(Effect.andThen(nativeWriter.writeAll(chunks))),
15
+ }));
16
+ return {
17
+ ...socket,
18
+ reader: Effect.gen(function* () {
19
+ yield* ready.close;
20
+ const reader = yield* socket.reader;
21
+ const raw = yield* socket.writer;
22
+ yield* raw.write(JSON.stringify({ _tag: "Authenticate", token }));
23
+ yield* ready.open;
24
+ return { ...reader, pull: reader.pull.pipe(Effect.onError(() => ready.close)) };
25
+ }),
26
+ writer: Effect.succeed(writer),
27
+ };
28
+ });
package/src/testing.ts CHANGED
@@ -1,6 +1,7 @@
1
- import { Deferred, type Duration, Effect, Fiber, Stream, SubscriptionRef } from "effect";
1
+ import { Deferred, type Duration, Effect, Fiber, Layer, Queue, Stream, SubscriptionRef } from "effect";
2
+ import { type Rpc, RpcClient, type RpcGroup, type RpcMessage, RpcSerialization, RpcServer } from "effect/rpc";
2
3
  import type { Key } from "@shivaedev/changes/keys.ts";
3
- import type { LiveHint } from "./live.ts";
4
+ import type { LiveHint } from "#live.ts";
4
5
 
5
6
  export interface HintViewer<E> {
6
7
  readonly finished: Effect.Effect<void, E>;
@@ -39,3 +40,42 @@ export const heard = Effect.fn("Live.heard")(function* <E>(
39
40
  function namesKeys(hint: LiveHint, keys: readonly Key[]): boolean {
40
41
  return hint._tag === "Changed" && keys.every((key) => hint.keys.some((actual) => JSON.stringify(actual) === JSON.stringify(key)));
41
42
  }
43
+
44
+ export function layerMemoryProtocol<TRpcs extends Rpc.Any>(group: RpcGroup.RpcGroup<TRpcs>) {
45
+ return Layer.effect(
46
+ RpcClient.Protocol,
47
+ Effect.gen(function* () {
48
+ const requests = yield* Queue.unbounded<readonly [number, RpcMessage.FromClientEncoded]>();
49
+ const disconnects = yield* Queue.unbounded<number>();
50
+ const { codecFor } = yield* RpcSerialization.RpcSerialization;
51
+ const protocol = yield* RpcClient.Protocol.make((send, clientIds) =>
52
+ Effect.gen(function* () {
53
+ const server = RpcServer.Protocol.of({
54
+ clientIds: Effect.sync(() => clientIds),
55
+ codecFor,
56
+ disconnects,
57
+ end: () => Effect.void,
58
+ initialMessage: Effect.succeedNone,
59
+ run: (receive) => Effect.forever(Effect.flatMap(Queue.take(requests), ([id, message]) => receive(id, message))),
60
+ send,
61
+ supportsAck: true,
62
+ supportsNotifications: true,
63
+ supportsSpanPropagation: true,
64
+ supportsTransferables: false,
65
+ });
66
+ yield* RpcServer.make(group).pipe(Effect.provideService(RpcServer.Protocol, server), Effect.forkScoped);
67
+ return {
68
+ codecFor,
69
+ send: (clientId, request) => Queue.offer(requests, [clientId, request]).pipe(Effect.asVoid),
70
+ supportsAck: true,
71
+ supportsTransferables: false,
72
+ };
73
+ }),
74
+ );
75
+ return {
76
+ ...protocol,
77
+ run: (clientId, receive) => protocol.run(clientId, receive).pipe(Effect.ensuring(Queue.offer(disconnects, clientId))),
78
+ } satisfies RpcClient.Protocol["Service"];
79
+ }),
80
+ ).pipe(Layer.provide(RpcSerialization.layerNdjson));
81
+ }
@@ -0,0 +1,26 @@
1
+ import { Context, Effect, Option } from "effect";
2
+ import type { Rpc, RpcGroup } from "effect/rpc";
3
+ import { MissingReadPolicies } from "#readPolicyErrors.ts";
4
+ import { ChangesQueries, QueryDefinition } from "#serverMetadata.ts";
5
+
6
+ export const validateReadPolicies = Effect.fnUntraced(function* <R extends Rpc.Any>(group: RpcGroup.RpcGroup<R>) {
7
+ const missing = new Set<string>();
8
+ for (const rpc of group.requests.values()) {
9
+ const query = Context.getOption(rpc.annotations, QueryDefinition);
10
+ if (Option.isSome(query) && query.value.definition.readPolicy === undefined) {
11
+ missing.add(rpc._tag);
12
+ }
13
+ const changes = Context.getOption(rpc.annotations, ChangesQueries);
14
+ if (Option.isSome(changes)) {
15
+ for (const definition of changes.value.queries) {
16
+ if (definition.readPolicy === undefined) {
17
+ missing.add(`${rpc._tag.slice(0, -"$changes".length)}${definition.name}`);
18
+ }
19
+ }
20
+ }
21
+ }
22
+ if (missing.size > 0) {
23
+ const queries = [...missing].sort((left, right) => left.localeCompare(right));
24
+ return yield* new MissingReadPolicies({ message: `Declare a readPolicy on queries: ${queries.join(", ")}`, queries });
25
+ }
26
+ });