@shivaedev/contract 0.23.0 → 0.24.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +2 -2
  3. package/dist/automaticLive.d.ts +12 -5
  4. package/dist/automaticLive.d.ts.map +1 -1
  5. package/dist/automaticLive.js +21 -65
  6. package/dist/automaticLive.js.map +1 -1
  7. package/dist/internal/aggregateLiveStatus.d.ts.map +1 -1
  8. package/dist/internal/aggregateLiveStatus.js +3 -0
  9. package/dist/internal/aggregateLiveStatus.js.map +1 -1
  10. package/dist/internal/automaticQuery.d.ts +21 -0
  11. package/dist/internal/automaticQuery.d.ts.map +1 -0
  12. package/dist/internal/automaticQuery.js +83 -0
  13. package/dist/internal/automaticQuery.js.map +1 -0
  14. package/dist/internal/changesSuccess.d.ts +13 -0
  15. package/dist/internal/changesSuccess.d.ts.map +1 -0
  16. package/dist/internal/changesSuccess.js +16 -0
  17. package/dist/internal/changesSuccess.js.map +1 -0
  18. package/dist/internal/clientOperations.d.ts.map +1 -1
  19. package/dist/internal/clientOperations.js +1 -1
  20. package/dist/internal/clientOperations.js.map +1 -1
  21. package/dist/internal/compareQueries.d.ts +23 -0
  22. package/dist/internal/compareQueries.d.ts.map +1 -0
  23. package/dist/internal/compareQueries.js +56 -0
  24. package/dist/internal/compareQueries.js.map +1 -0
  25. package/dist/internal/liveRetry.d.ts +3 -0
  26. package/dist/internal/liveRetry.d.ts.map +1 -0
  27. package/dist/internal/liveRetry.js +20 -0
  28. package/dist/internal/liveRetry.js.map +1 -0
  29. package/dist/internal/queryDelivery.d.ts +28 -0
  30. package/dist/internal/queryDelivery.d.ts.map +1 -0
  31. package/dist/internal/queryDelivery.js +22 -0
  32. package/dist/internal/queryDelivery.js.map +1 -0
  33. package/dist/internal/queryFailure.d.ts +2 -2
  34. package/dist/internal/queryFailure.d.ts.map +1 -1
  35. package/dist/internal/queryFailure.js +4 -10
  36. package/dist/internal/queryFailure.js.map +1 -1
  37. package/dist/internal/retryOnChange.d.ts +7 -0
  38. package/dist/internal/retryOnChange.d.ts.map +1 -0
  39. package/dist/internal/retryOnChange.js +24 -0
  40. package/dist/internal/retryOnChange.js.map +1 -0
  41. package/dist/live.d.ts +2 -1
  42. package/dist/live.d.ts.map +1 -1
  43. package/dist/live.js +12 -3
  44. package/dist/live.js.map +1 -1
  45. package/dist/makeLiveServer.d.ts +8 -39
  46. package/dist/makeLiveServer.d.ts.map +1 -1
  47. package/dist/makeLiveServer.js +14 -8
  48. package/dist/makeLiveServer.js.map +1 -1
  49. package/dist/operation.d.ts +6 -3
  50. package/dist/operation.d.ts.map +1 -1
  51. package/dist/operation.js +1 -0
  52. package/dist/operation.js.map +1 -1
  53. package/dist/publicConfig.d.ts +3 -3
  54. package/dist/publicConfig.d.ts.map +1 -1
  55. package/dist/querySubscription.d.ts +3 -1
  56. package/dist/querySubscription.d.ts.map +1 -1
  57. package/dist/querySubscription.js +1 -1
  58. package/dist/querySubscription.js.map +1 -1
  59. package/dist/queryUpdate.d.ts +9 -0
  60. package/dist/queryUpdate.d.ts.map +1 -0
  61. package/dist/queryUpdate.js +2 -0
  62. package/dist/queryUpdate.js.map +1 -0
  63. package/dist/serverMetadata.d.ts +2 -2
  64. package/dist/serverMetadata.d.ts.map +1 -1
  65. package/dist/serverMetadata.js +2 -2
  66. package/dist/serverMetadata.js.map +1 -1
  67. package/package.json +6 -6
  68. package/src/automaticLive.ts +36 -73
  69. package/src/internal/aggregateLiveStatus.ts +3 -0
  70. package/src/internal/automaticQuery.ts +117 -0
  71. package/src/internal/changesSuccess.ts +32 -0
  72. package/src/internal/clientOperations.ts +1 -0
  73. package/src/internal/compareQueries.ts +65 -0
  74. package/src/internal/liveRetry.ts +24 -0
  75. package/src/internal/queryDelivery.ts +28 -0
  76. package/src/internal/queryFailure.ts +4 -11
  77. package/src/internal/retryOnChange.ts +30 -0
  78. package/src/live.ts +17 -5
  79. package/src/makeLiveServer.ts +24 -17
  80. package/src/operation.ts +15 -3
  81. package/src/querySubscription.ts +5 -2
  82. package/src/queryUpdate.ts +9 -0
  83. package/src/serverMetadata.ts +3 -3
@@ -1,10 +1,11 @@
1
1
  import { Effect, Queue, Stream } from "effect";
2
2
  import * as Reactivity from "effect/reactivity/Reactivity";
3
3
  import { type Key, type KeyContext, readKeys } from "@shivaedev/changes/keys.ts";
4
+ import { compareQueries } from "#internal/compareQueries.ts";
4
5
  import { liveHintQueue } from "#internal/liveHintQueue.ts";
5
- import { changedHint } from "#internal/queryHints.ts";
6
6
  import type { LiveHint } from "#live.ts";
7
- import type { QuerySubscription } from "#querySubscription.ts";
7
+ import type { QueryRerun, QuerySubscription } from "#querySubscription.ts";
8
+ import type { QueryUpdate } from "#queryUpdate.ts";
8
9
  import { QueryReadDenied } from "#readPolicyErrors.ts";
9
10
 
10
11
  export const makeLiveServer = Effect.gen(function* () {
@@ -65,19 +66,25 @@ export const makeLiveServer = Effect.gen(function* () {
65
66
  reactivity.invalidateUnsafe([resyncKey]);
66
67
  return openStreams;
67
68
  });
68
- return {
69
- resync,
70
- stream: (keys: readonly Key[], context?: KeyContext) => open(keys, context),
71
- subscribe: <E, R>(subscription: QuerySubscription<E, R>, context?: KeyContext) =>
72
- open(subscription.keys, context).pipe(
73
- Stream.mapEffect((hint) =>
74
- Effect.flatMap(subscription.authorized, (allowed) =>
75
- allowed
76
- ? Effect.succeed(hint._tag === "Resync" ? hint : changedHint(hint.keys, subscription.scopes))
77
- : Effect.fail(new QueryReadDenied({ message: "Read no longer allowed for subscribed queries" })),
78
- ),
79
- ),
80
- Stream.filter((hint) => hint._tag === "Resync" || hint.keys.length > 0),
81
- ),
82
- };
69
+ function subscribe<E, R>(subscription: QuerySubscription<E, R>, context?: KeyContext): Stream.Stream<LiveHint, E | QueryReadDenied, R>;
70
+ function subscribe<E, R>(
71
+ subscription: QuerySubscription<E, R>,
72
+ context: KeyContext | undefined,
73
+ read: QueryRerun<E, R>,
74
+ ): Stream.Stream<QueryUpdate, E | QueryReadDenied, R>;
75
+ function subscribe<E, R>(subscription: QuerySubscription<E, R>, context?: KeyContext, read?: QueryRerun<E, R>) {
76
+ return Stream.unwrap(
77
+ Effect.sync(() => {
78
+ const compare = compareQueries(subscription, read);
79
+ const next = Effect.fnUntraced(function* (hint: LiveHint) {
80
+ if (!(yield* subscription.authorized)) {
81
+ return yield* new QueryReadDenied({ message: "Read no longer allowed for subscribed queries" });
82
+ }
83
+ return yield* compare(hint);
84
+ });
85
+ return open(subscription.keys, context).pipe(Stream.mapEffect(next), Stream.flatMap(Stream.fromIterable));
86
+ }),
87
+ );
88
+ }
89
+ return { resync, stream: open, subscribe };
83
90
  });
package/src/operation.ts CHANGED
@@ -24,6 +24,7 @@ export interface OperationShape {
24
24
 
25
25
  export interface QueryShape<E = unknown, R = unknown> extends OperationShape {
26
26
  readonly kind: "query";
27
+ readonly live?: "rerun-and-compare" | undefined;
27
28
  readonly readPolicy?: Bivariant<QueryReadPolicy<unknown, E, R>>;
28
29
  reads: Bivariant<(payload: unknown, viewer: Option.Option<Viewer>) => readonly Key[]>;
29
30
  }
@@ -49,9 +50,16 @@ interface Operation<TName extends string, TPayload extends Schema.Top, TSuccess
49
50
  readonly success: TSuccess;
50
51
  }
51
52
 
52
- export interface Query<TName extends string, TPayload extends Schema.Top, TSuccess extends Schema.Top, TSpecs extends RejectionSpecs, R = never>
53
- extends Operation<TName, TPayload, TSuccess, TSpecs> {
53
+ export interface Query<
54
+ TName extends string,
55
+ TPayload extends Schema.Top,
56
+ TSuccess extends Schema.Top,
57
+ TSpecs extends RejectionSpecs,
58
+ R = never,
59
+ TLive extends "rerun-and-compare" | undefined = undefined,
60
+ > extends Operation<TName, TPayload, TSuccess, TSpecs> {
54
61
  readonly kind: "query";
62
+ readonly live?: TLive;
55
63
  readonly readPolicy?: QueryReadPolicy<TPayload["Type"], RejectedBy<TSpecs>, R>;
56
64
  reads: (payload: TPayload["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
57
65
  }
@@ -80,22 +88,26 @@ export function query<
80
88
  TSuccess extends Schema.Top = Schema.Void,
81
89
  const TSpecs extends RejectionSpecs = NoRejections,
82
90
  R = never,
91
+ const TLive extends "rerun-and-compare" | undefined = undefined,
83
92
  >(
84
93
  name: TName,
85
94
  declaration: Declaration<TPayload, TSuccess, TSpecs> & {
95
+ readonly live?: TLive;
86
96
  readonly reads: (payload: PayloadSchema<TPayload>["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
87
97
  readonly readPolicy?: QueryReadPolicy<PayloadSchema<TPayload>["Type"], NoInfer<RejectedBy<TSpecs>>, R>;
88
98
  },
89
- ): NoInfer<Query<TName, PayloadSchema<TPayload>, TSuccess, TSpecs, R>>;
99
+ ): NoInfer<Query<TName, PayloadSchema<TPayload>, TSuccess, TSpecs, R, TLive>>;
90
100
  export function query(
91
101
  name: string,
92
102
  declaration: Loose & {
103
+ readonly live?: "rerun-and-compare" | undefined;
93
104
  readonly reads: (payload: unknown, viewer: Option.Option<Viewer>) => readonly Key[];
94
105
  readonly readPolicy?: QueryReadPolicy<unknown, unknown, unknown>;
95
106
  },
96
107
  ): QueryShape {
97
108
  return {
98
109
  ...operation("query", name, declaration),
110
+ live: declaration.live,
99
111
  reads: declaration.reads,
100
112
  ...(declaration.readPolicy === undefined ? {} : { readPolicy: declaration.readPolicy }),
101
113
  };
@@ -3,11 +3,14 @@ import type { Rpc } from "effect/rpc";
3
3
  import type { Key } from "@shivaedev/changes/keys.ts";
4
4
  import { checkQuery, type PolicyChannels, type Viewer } from "#readPolicy.ts";
5
5
  import type { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
6
- import { ChangesQueries, type QueryReference } from "#serverMetadata.ts";
6
+ import { ChangesQueries, type QueryReference, type QueryRequest } from "#serverMetadata.ts";
7
+
8
+ export type QueryRerun<E = unknown, R = never> = (request: QueryRequest) => Effect.Effect<unknown, E, R>;
7
9
 
8
10
  export interface QuerySubscription<E = never, R = never> {
9
11
  readonly authorized: Effect.Effect<boolean, E, R>;
10
12
  readonly keys: readonly Key[];
13
+ readonly queries?: readonly QueryRequest[];
11
14
  readonly scopes: readonly (readonly Key[])[];
12
15
  }
13
16
 
@@ -29,6 +32,6 @@ export function querySubscription(rpc: Rpc.Any, references: readonly QueryRefere
29
32
  Effect.forEach(queries, ({ query, payload }) => query.readPolicy?.(payload, viewer) ?? Effect.succeed(false)),
30
33
  (permissions) => permissions.every(Boolean),
31
34
  );
32
- return { authorized, keys: scopes.flat(), scopes } satisfies QuerySubscription<unknown, unknown>;
35
+ return { authorized, keys: scopes.flat(), queries, scopes } satisfies QuerySubscription<unknown, unknown>;
33
36
  })();
34
37
  }
@@ -0,0 +1,9 @@
1
+ import type { LiveHint } from "#live.ts";
2
+
3
+ export interface QueryResult {
4
+ readonly _tag: "Result";
5
+ readonly query: string;
6
+ readonly queryIndex: number;
7
+ readonly value: unknown;
8
+ }
9
+ export type QueryUpdate = LiveHint | QueryResult;
@@ -2,7 +2,7 @@ import { Context, Effect, Option, Schema } from "effect";
2
2
  import { Rpc, type RpcSchema } from "effect/rpc";
3
3
  import type { Key } from "@shivaedev/changes/keys.ts";
4
4
  import type { QueryServices } from "#contract.ts";
5
- import { LiveHint } from "#live.ts";
5
+ import { changesSuccess } from "#internal/changesSuccess.ts";
6
6
  import type { CommandShape, QueryShape, StreamShape } from "#operation.ts";
7
7
  import type { Viewer } from "#readPolicy.ts";
8
8
  import { MissingReadPolicy, QueryReadDenied } from "#readPolicyErrors.ts";
@@ -67,7 +67,7 @@ export function changesRpc<const TName extends string, const TQueries extends re
67
67
  ): Rpc.Rpc<
68
68
  `${TName}.$changes`,
69
69
  Schema.Struct<{ queries: ReturnType<typeof referenceSchemas<TQueries>> }>,
70
- RpcSchema.Stream<typeof LiveHint, ChangesError<TQueries>>,
70
+ RpcSchema.Stream<ReturnType<typeof changesSuccess<TQueries>>, ChangesError<TQueries>>,
71
71
  Schema.Never,
72
72
  never,
73
73
  QueryServices<TQueries[number]>
@@ -77,7 +77,7 @@ export function changesRpc(name: string, queries: readonly QueryShape[]) {
77
77
  error: Schema.Union([MissingReadPolicy, QueryReadDenied, ...queries.map((query) => query.error)]),
78
78
  payload: { queries: referenceSchemas(queries) },
79
79
  stream: true,
80
- success: LiveHint,
80
+ success: changesSuccess(queries),
81
81
  }).annotate(ChangesQueries, { resolve: (references) => resolveQueries(queries, references) });
82
82
  }
83
83