@shivaedev/contract 0.31.0 → 0.32.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 (146) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/README.md +81 -12
  3. package/dist/CommandGuard.d.ts +10 -0
  4. package/dist/CommandGuard.d.ts.map +1 -0
  5. package/dist/CommandGuard.js +20 -0
  6. package/dist/CommandGuard.js.map +1 -0
  7. package/dist/LiveServer.d.ts +6 -4
  8. package/dist/LiveServer.d.ts.map +1 -1
  9. package/dist/LiveServer.js +10 -5
  10. package/dist/LiveServer.js.map +1 -1
  11. package/dist/ReadPolicyGuard.d.ts +19 -0
  12. package/dist/ReadPolicyGuard.d.ts.map +1 -0
  13. package/dist/ReadPolicyGuard.js +23 -0
  14. package/dist/ReadPolicyGuard.js.map +1 -0
  15. package/dist/adapters/activityState.d.ts +9 -0
  16. package/dist/adapters/activityState.d.ts.map +1 -0
  17. package/dist/adapters/activityState.js +11 -0
  18. package/dist/adapters/activityState.js.map +1 -0
  19. package/dist/{internal → adapters}/bindingOwner.d.ts +1 -1
  20. package/dist/{internal → adapters}/bindingOwner.d.ts.map +1 -1
  21. package/dist/{internal → adapters}/bindingOwner.js +2 -1
  22. package/dist/adapters/bindingOwner.js.map +1 -0
  23. package/dist/adapters/clientId.d.ts +2 -0
  24. package/dist/adapters/clientId.d.ts.map +1 -0
  25. package/dist/adapters/clientId.js +4 -0
  26. package/dist/adapters/clientId.js.map +1 -0
  27. package/dist/automaticLive.d.ts +1 -1
  28. package/dist/automaticLive.d.ts.map +1 -1
  29. package/dist/automaticLive.js +7 -2
  30. package/dist/automaticLive.js.map +1 -1
  31. package/dist/bind.d.ts.map +1 -1
  32. package/dist/bind.js +1 -1
  33. package/dist/bind.js.map +1 -1
  34. package/dist/changesHandlerLayer.d.ts +19 -0
  35. package/dist/changesHandlerLayer.d.ts.map +1 -0
  36. package/dist/changesHandlerLayer.js +15 -0
  37. package/dist/changesHandlerLayer.js.map +1 -0
  38. package/dist/clientActivity.d.ts +10 -1
  39. package/dist/clientActivity.d.ts.map +1 -1
  40. package/dist/clientActivity.js +7 -0
  41. package/dist/clientActivity.js.map +1 -1
  42. package/dist/clientKeys.d.ts +7 -0
  43. package/dist/clientKeys.d.ts.map +1 -0
  44. package/dist/clientKeys.js +11 -0
  45. package/dist/clientKeys.js.map +1 -0
  46. package/dist/composeBindings.d.ts +8 -0
  47. package/dist/composeBindings.d.ts.map +1 -0
  48. package/dist/composeBindings.js +18 -0
  49. package/dist/composeBindings.js.map +1 -0
  50. package/dist/contract.d.ts +5 -8
  51. package/dist/contract.d.ts.map +1 -1
  52. package/dist/contract.js +11 -7
  53. package/dist/contract.js.map +1 -1
  54. package/dist/internal/automaticQuery.d.ts +3 -1
  55. package/dist/internal/automaticQuery.d.ts.map +1 -1
  56. package/dist/internal/automaticQuery.js +9 -2
  57. package/dist/internal/automaticQuery.js.map +1 -1
  58. package/dist/internal/changesSuccess.d.ts +5 -1
  59. package/dist/internal/changesSuccess.d.ts.map +1 -1
  60. package/dist/internal/changesSuccess.js +10 -6
  61. package/dist/internal/changesSuccess.js.map +1 -1
  62. package/dist/internal/clientActivity.d.ts +5 -6
  63. package/dist/internal/clientActivity.d.ts.map +1 -1
  64. package/dist/internal/clientActivity.js +6 -18
  65. package/dist/internal/clientActivity.js.map +1 -1
  66. package/dist/internal/clientOperations.d.ts +1 -1
  67. package/dist/internal/clientOperations.d.ts.map +1 -1
  68. package/dist/internal/clientOperations.js +7 -4
  69. package/dist/internal/clientOperations.js.map +1 -1
  70. package/dist/internal/compareQueries.d.ts +2 -1
  71. package/dist/internal/compareQueries.d.ts.map +1 -1
  72. package/dist/internal/compareQueries.js +5 -7
  73. package/dist/internal/compareQueries.js.map +1 -1
  74. package/dist/internal/declarationError.d.ts +7 -1
  75. package/dist/internal/declarationError.d.ts.map +1 -1
  76. package/dist/internal/declarationError.js.map +1 -1
  77. package/dist/internal/prependMiddleware.d.ts +10 -0
  78. package/dist/internal/prependMiddleware.d.ts.map +1 -0
  79. package/dist/internal/prependMiddleware.js +12 -0
  80. package/dist/internal/prependMiddleware.js.map +1 -0
  81. package/dist/internal/queryDelivery.d.ts +2 -1
  82. package/dist/internal/queryDelivery.d.ts.map +1 -1
  83. package/dist/internal/queryDelivery.js +8 -1
  84. package/dist/internal/queryDelivery.js.map +1 -1
  85. package/dist/internal/queryReactivity.d.ts.map +1 -1
  86. package/dist/internal/queryReactivity.js +3 -11
  87. package/dist/internal/queryReactivity.js.map +1 -1
  88. package/dist/internal/querySignals.d.ts +8 -0
  89. package/dist/internal/querySignals.d.ts.map +1 -0
  90. package/dist/internal/querySignals.js +42 -0
  91. package/dist/internal/querySignals.js.map +1 -0
  92. package/dist/internal/wrapAtom.d.ts +3 -0
  93. package/dist/internal/wrapAtom.d.ts.map +1 -0
  94. package/dist/internal/wrapAtom.js +15 -0
  95. package/dist/internal/wrapAtom.js.map +1 -0
  96. package/dist/live.d.ts +2 -1
  97. package/dist/live.d.ts.map +1 -1
  98. package/dist/live.js +5 -4
  99. package/dist/live.js.map +1 -1
  100. package/dist/makeLiveServer.d.ts +22 -5
  101. package/dist/makeLiveServer.d.ts.map +1 -1
  102. package/dist/makeLiveServer.js +39 -24
  103. package/dist/makeLiveServer.js.map +1 -1
  104. package/dist/publicConfig.d.ts +19 -3
  105. package/dist/publicConfig.d.ts.map +1 -1
  106. package/dist/querySignals.d.ts +9 -0
  107. package/dist/querySignals.d.ts.map +1 -0
  108. package/dist/querySignals.js +14 -0
  109. package/dist/querySignals.js.map +1 -0
  110. package/dist/querySubscription.d.ts +1 -1
  111. package/dist/querySubscription.d.ts.map +1 -1
  112. package/dist/querySubscription.js +7 -4
  113. package/dist/querySubscription.js.map +1 -1
  114. package/dist/queryUpdate.d.ts +5 -1
  115. package/dist/queryUpdate.d.ts.map +1 -1
  116. package/package.json +10 -10
  117. package/src/CommandGuard.ts +25 -0
  118. package/src/LiveServer.ts +18 -9
  119. package/src/ReadPolicyGuard.ts +31 -0
  120. package/src/adapters/activityState.ts +12 -0
  121. package/src/{internal → adapters}/bindingOwner.ts +3 -2
  122. package/src/adapters/clientId.ts +3 -0
  123. package/src/automaticLive.ts +8 -3
  124. package/src/bind.ts +1 -1
  125. package/src/changesHandlerLayer.ts +51 -0
  126. package/src/clientActivity.ts +8 -1
  127. package/src/clientKeys.ts +17 -0
  128. package/src/composeBindings.ts +27 -0
  129. package/src/contract.ts +14 -20
  130. package/src/internal/automaticQuery.ts +11 -1
  131. package/src/internal/changesSuccess.ts +13 -8
  132. package/src/internal/clientActivity.ts +37 -52
  133. package/src/internal/clientOperations.ts +9 -5
  134. package/src/internal/compareQueries.ts +6 -8
  135. package/src/internal/declarationError.ts +12 -1
  136. package/src/internal/prependMiddleware.ts +15 -0
  137. package/src/internal/queryDelivery.ts +9 -0
  138. package/src/internal/queryReactivity.ts +4 -11
  139. package/src/internal/querySignals.ts +46 -0
  140. package/src/internal/wrapAtom.ts +14 -0
  141. package/src/live.ts +5 -4
  142. package/src/makeLiveServer.ts +64 -57
  143. package/src/querySignals.ts +22 -0
  144. package/src/querySubscription.ts +8 -7
  145. package/src/queryUpdate.ts +5 -1
  146. package/dist/internal/bindingOwner.js.map +0 -1
@@ -1,6 +1,6 @@
1
- import { Effect, Queue, Random, Stream } from "effect";
1
+ import { Effect, Queue, Random, Scheduler, Stream } from "effect";
2
2
  import * as Reactivity from "effect/reactivity/Reactivity";
3
- import { type Key, type KeyContext, readKeys } from "@shivaedev/changes/keys.ts";
3
+ import { type Key, readKeys } from "@shivaedev/changes/keys.ts";
4
4
  import { compareQueries } from "#internal/compareQueries.ts";
5
5
  import { liveHintQueue } from "#internal/liveHintQueue.ts";
6
6
  import type { LiveHint } from "#live.ts";
@@ -10,82 +10,89 @@ import { QueryReadDenied } from "#readPolicyErrors.ts";
10
10
 
11
11
  export const makeLiveServer = Effect.gen(function* () {
12
12
  const reactivity = yield* Reactivity.Reactivity;
13
+ const dispatcher = (yield* Scheduler.Scheduler).makeDispatcher();
13
14
  let openStreams = 0;
14
15
  const resyncKey = `@shivaedev/contract/resync/${yield* Random.nextInt}`;
15
- function open(keys: readonly Key[], context?: KeyContext, globalKeys: readonly Key[] = []): Stream.Stream<LiveHint> {
16
- return Stream.unwrap(
17
- Effect.gen(function* () {
18
- const { offer, queue } = yield* liveHintQueue;
19
- const pending = new Map<string, Key>();
20
- let scheduled = false;
21
- let resync = false;
22
- let active = true;
23
- const global = new Set(readKeys(globalKeys));
24
- function flush() {
25
- if (scheduled) {
26
- return;
16
+ function open(keys: readonly Key[]) {
17
+ return Effect.gen(function* () {
18
+ const { offer, queue } = yield* liveHintQueue;
19
+ const pending = new Map<string, Key>();
20
+ let scheduled = false;
21
+ let resync = false;
22
+ let active = true;
23
+ function flush() {
24
+ if (scheduled) {
25
+ return;
26
+ }
27
+ scheduled = true;
28
+ dispatcher.scheduleTask(() => {
29
+ scheduled = false;
30
+ if (active) {
31
+ offer(resync ? { _tag: "Resync" } : { _tag: "Changed", keys: [...pending.values()] });
27
32
  }
28
- scheduled = true;
29
- queueMicrotask(() => {
30
- scheduled = false;
31
- if (active) {
32
- offer(resync ? { _tag: "Resync" } : { _tag: "Changed", keys: [...pending.values()] });
33
- }
34
- pending.clear();
35
- resync = false;
36
- });
33
+ pending.clear();
34
+ resync = false;
35
+ }, 0);
36
+ }
37
+ let cancelKeys: (() => void)[] = [];
38
+ function replaceKeys(current: readonly Key[]) {
39
+ for (const stop of cancelKeys) {
40
+ stop();
37
41
  }
38
- const cancel = keys.map((key) => {
39
- const bare = readKeys([key]);
40
- const own = global.has(bare[0] ?? "") ? bare : readKeys([key], context);
42
+ cancelKeys = current.map((key) => {
43
+ const own = readKeys([key]);
41
44
  return reactivity.registerUnsafe(own, () => {
42
45
  pending.set(own[0] ?? "", key);
43
46
  flush();
44
47
  });
45
48
  });
46
- cancel.push(
47
- reactivity.registerUnsafe([resyncKey], () => {
48
- resync = true;
49
- flush();
50
- }),
51
- );
52
- openStreams += 1;
53
- yield* Effect.addFinalizer(() =>
54
- Effect.sync(() => {
55
- active = false;
56
- openStreams -= 1;
57
- for (const stop of cancel) {
58
- stop();
59
- }
60
- }),
61
- );
62
- yield* Queue.offer(queue, { _tag: "Resync" });
63
- return Stream.fromQueue(queue);
64
- }),
65
- );
49
+ }
50
+ replaceKeys(keys);
51
+ const cancel = [
52
+ reactivity.registerUnsafe([resyncKey], () => {
53
+ resync = true;
54
+ flush();
55
+ }),
56
+ ];
57
+ openStreams += 1;
58
+ yield* Effect.addFinalizer(() =>
59
+ Effect.sync(() => {
60
+ active = false;
61
+ openStreams -= 1;
62
+ for (const stop of [...cancelKeys, ...cancel]) {
63
+ stop();
64
+ }
65
+ }),
66
+ );
67
+ yield* Queue.offer(queue, { _tag: "Resync" });
68
+ return { replaceKeys, stream: Stream.fromQueue(queue) };
69
+ });
66
70
  }
67
71
  const resync = Effect.sync(() => {
68
72
  reactivity.invalidateUnsafe([resyncKey]);
69
73
  return openStreams;
70
74
  });
71
- function subscribe<E, R>(subscription: QuerySubscription<E, R>, context?: KeyContext): Stream.Stream<SubscriptionHint, E | QueryReadDenied, R>;
72
- function subscribe<E, R>(
73
- subscription: QuerySubscription<E, R>,
74
- context: KeyContext | undefined,
75
- read: QueryRerun<E, R>,
76
- ): Stream.Stream<QueryUpdate, E | QueryReadDenied, R>;
77
- function subscribe<E, R>(subscription: QuerySubscription<E, R>, context?: KeyContext, read?: QueryRerun<E, R>) {
75
+ function subscribe<E, R>(subscription: QuerySubscription<E, R>): Stream.Stream<SubscriptionHint, E | QueryReadDenied, R>;
76
+ function subscribe<E, R>(subscription: QuerySubscription<E, R>, read: QueryRerun<E, R>): Stream.Stream<QueryUpdate, E | QueryReadDenied, R>;
77
+ function subscribe<E, R>(subscription: QuerySubscription<E, R>, read?: QueryRerun<E, R>) {
78
78
  return Stream.unwrap(
79
- Effect.sync(() => {
79
+ Effect.gen(function* () {
80
+ const registration = yield* open(subscription.keys);
81
+ let scopes = subscription.scopes;
80
82
  let compare = compareQueries(subscription, read);
81
83
  const next = Effect.fnUntraced(function* (hint: LiveHint) {
82
84
  if (!(yield* subscription.authorized)) {
83
85
  compare = compareQueries(subscription, read);
84
86
  return [new QueryReadDenied({ message: "Read no longer allowed for subscribed queries" })];
85
87
  }
86
- return yield* compare(hint);
88
+ const updates = yield* compare(hint, scopes);
89
+ if (subscription.readScopes !== undefined) {
90
+ scopes = yield* subscription.readScopes;
91
+ registration.replaceKeys(scopes.flat());
92
+ }
93
+ return updates;
87
94
  });
88
- return open(subscription.keys, context, subscription.globalKeys).pipe(
95
+ return registration.stream.pipe(
89
96
  Stream.mapEffect((hint) =>
90
97
  Effect.flatMap(subscription.refresh ?? Effect.context<never>(), (current) => Effect.provideContext(next(hint), current)),
91
98
  ),
@@ -94,5 +101,5 @@ export const makeLiveServer = Effect.gen(function* () {
94
101
  }),
95
102
  );
96
103
  }
97
- return { resync, stream: open, subscribe };
104
+ return { resync, stream: (keys: readonly Key[]) => Stream.unwrap(Effect.map(open(keys), ({ stream }) => stream)), subscribe };
98
105
  });
@@ -0,0 +1,22 @@
1
+ import * as Atom from "effect/reactivity/Atom";
2
+
3
+ export interface QuerySignals {
4
+ readonly completed: number;
5
+ readonly pending: boolean;
6
+ readonly subscription: "disabled" | "opening" | "open" | "refused";
7
+ }
8
+
9
+ const states = new WeakMap<Atom.Atom<unknown>, Atom.Writable<QuerySignals>>();
10
+
11
+ export function querySignals(query: Atom.Atom<unknown>): Atom.Writable<QuerySignals> {
12
+ let state = states.get(query);
13
+ if (state === undefined) {
14
+ state = Atom.make<QuerySignals>({ completed: 0, pending: true, subscription: "disabled" });
15
+ states.set(query, state);
16
+ }
17
+ return state;
18
+ }
19
+
20
+ export function shareQuerySignals(query: Atom.Atom<unknown>, source: Atom.Atom<unknown>) {
21
+ states.set(query, querySignals(source));
22
+ }
@@ -11,9 +11,9 @@ 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[];
15
14
  readonly keys: readonly Key[];
16
15
  readonly queries?: readonly QueryRequest[];
16
+ readonly readScopes?: Effect.Effect<readonly (readonly Key[])[], E, R>;
17
17
  readonly refresh?: Effect.Effect<Context.Context<never>, E, R>;
18
18
  readonly scopes: readonly (readonly Key[])[];
19
19
  }
@@ -37,7 +37,10 @@ export function querySubscription(rpc: Rpc.Any, references: readonly QueryRefere
37
37
  const context = yield* policyContext(Rpc.make(`${prefix}${query.name}`));
38
38
  return {
39
39
  check: Effect.provideContext(checkQuery(query, payload, viewer), context),
40
- keys: queryReadKeys(query, payload, viewer).pipe(Effect.provideContext(context)),
40
+ keys: Effect.gen(function* () {
41
+ const current = yield* policyContext(Rpc.make(`${prefix}${query.name}`));
42
+ return yield* queryReadKeys(query, payload, viewer).pipe(Effect.provideContext(current));
43
+ }),
41
44
  permitted: Effect.gen(function* () {
42
45
  const current = yield* policyContext(Rpc.make(`${prefix}${query.name}`));
43
46
  return yield* Effect.suspend(() => query.readPolicy?.(payload, viewer) ?? Effect.succeed(false)).pipe(Effect.provideContext(current));
@@ -46,14 +49,12 @@ export function querySubscription(rpc: Rpc.Any, references: readonly QueryRefere
46
49
  }),
47
50
  );
48
51
  yield* Effect.forEach(policies, ({ check }) => check);
49
- const scopes = yield* Effect.forEach(policies, ({ keys }) => keys);
52
+ const readScopes = Effect.forEach(policies, ({ keys }) => keys);
53
+ const scopes = yield* readScopes;
50
54
  const authorized = Effect.map(
51
55
  Effect.forEach(policies, ({ permitted }) => permitted),
52
56
  (permissions) => permissions.every(Boolean),
53
57
  );
54
- const globalKeys = queries.flatMap(
55
- ({ query }) => query.readsCollections?.map((collection) => ({ _tag: "List" as const, collection: collection.name })) ?? [],
56
- );
57
- return { authorized, globalKeys, keys: scopes.flat(), queries, scopes } satisfies QuerySubscription<unknown, unknown>;
58
+ return { authorized, keys: scopes.flat(), queries, readScopes, scopes } satisfies QuerySubscription<unknown, unknown>;
58
59
  })();
59
60
  }
@@ -7,5 +7,9 @@ export interface QueryResult {
7
7
  readonly queryIndex: number;
8
8
  readonly value: unknown;
9
9
  }
10
+ export interface QueryUnchanged {
11
+ readonly _tag: "Unchanged";
12
+ readonly queryIndex: number;
13
+ }
10
14
  export type SubscriptionHint = LiveHint | QueryReadDenied;
11
- export type QueryUpdate = SubscriptionHint | QueryResult;
15
+ export type QueryUpdate = SubscriptionHint | QueryResult | QueryUnchanged;
@@ -1 +0,0 @@
1
- {"version":3,"file":"bindingOwner.js","sourceRoot":"","sources":["../../src/internal/bindingOwner.ts"],"names":[],"mappings":"AAQA,MAAM,QAAQ,GAAG,IAAI,OAAO,EAAyC,CAAC;AAEtE,MAAM,UAAU,YAAY,CAAC,KAA4B,EAAE,QAAoC;IAC9F,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QACzC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;AAC9B,CAAC"}