@shivaedev/contract 0.52.0 → 0.54.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 (125) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +14 -1
  3. package/dist/LiveDispatcher.d.ts.map +1 -0
  4. package/dist/LiveDispatcher.js.map +1 -0
  5. package/dist/QueryStorage.d.ts +18 -0
  6. package/dist/QueryStorage.d.ts.map +1 -0
  7. package/dist/QueryStorage.js +4 -0
  8. package/dist/QueryStorage.js.map +1 -0
  9. package/dist/adapters/activityState.d.ts +2 -2
  10. package/dist/adapters/activityState.d.ts.map +1 -1
  11. package/dist/adapters/activityState.js +12 -12
  12. package/dist/adapters/activityState.js.map +1 -1
  13. package/dist/adapters/browserQueryStorage.d.ts +4 -0
  14. package/dist/adapters/browserQueryStorage.d.ts.map +1 -0
  15. package/dist/adapters/browserQueryStorage.js +12 -0
  16. package/dist/adapters/browserQueryStorage.js.map +1 -0
  17. package/dist/adapters/indexedQueryRows.d.ts +13 -0
  18. package/dist/adapters/indexedQueryRows.d.ts.map +1 -0
  19. package/dist/adapters/indexedQueryRows.js +53 -0
  20. package/dist/adapters/indexedQueryRows.js.map +1 -0
  21. package/dist/adapters/openLiveHints.d.ts +1 -1
  22. package/dist/adapters/openLiveHints.d.ts.map +1 -1
  23. package/dist/adapters/openLiveHints.js +1 -1
  24. package/dist/adapters/openLiveHints.js.map +1 -1
  25. package/dist/adapters/queryPersistence.d.ts +11 -0
  26. package/dist/adapters/queryPersistence.d.ts.map +1 -0
  27. package/dist/adapters/queryPersistence.js +124 -0
  28. package/dist/adapters/queryPersistence.js.map +1 -0
  29. package/dist/adapters/storedQueryAccess.d.ts +16 -0
  30. package/dist/adapters/storedQueryAccess.d.ts.map +1 -0
  31. package/dist/adapters/storedQueryAccess.js +30 -0
  32. package/dist/adapters/storedQueryAccess.js.map +1 -0
  33. package/dist/clientActivities.d.ts +2 -0
  34. package/dist/clientActivities.d.ts.map +1 -1
  35. package/dist/clientActivities.js +15 -10
  36. package/dist/clientActivities.js.map +1 -1
  37. package/dist/clientActivity.d.ts +1 -0
  38. package/dist/clientActivity.d.ts.map +1 -1
  39. package/dist/clientActivity.js.map +1 -1
  40. package/dist/clientOperations.d.ts.map +1 -1
  41. package/dist/clientOperations.js +5 -4
  42. package/dist/clientOperations.js.map +1 -1
  43. package/dist/live-server/layer.js +1 -1
  44. package/dist/live-server/layer.js.map +1 -1
  45. package/dist/live-server/register.d.ts +1 -1
  46. package/dist/live-server/register.d.ts.map +1 -1
  47. package/dist/live-server/register.js +1 -1
  48. package/dist/live-server/register.js.map +1 -1
  49. package/dist/live-server/service.d.ts +1 -1
  50. package/dist/live-server/service.d.ts.map +1 -1
  51. package/dist/live-server/service.js +1 -1
  52. package/dist/live-server/service.js.map +1 -1
  53. package/dist/live-server/stream.d.ts +1 -1
  54. package/dist/live-server/stream.d.ts.map +1 -1
  55. package/dist/live-server/stream.js +1 -1
  56. package/dist/live-server/stream.js.map +1 -1
  57. package/dist/{adapters/liveHintStream.d.ts → liveHintStream.d.ts} +2 -2
  58. package/dist/liveHintStream.d.ts.map +1 -0
  59. package/dist/{adapters/liveHintStream.js → liveHintStream.js} +1 -1
  60. package/dist/liveHintStream.js.map +1 -0
  61. package/dist/moduleHandlers.d.ts.map +1 -1
  62. package/dist/moduleHandlers.js +1 -1
  63. package/dist/moduleHandlers.js.map +1 -1
  64. package/dist/queryRetention.d.ts +1 -0
  65. package/dist/queryRetention.d.ts.map +1 -1
  66. package/dist/queryRetention.js.map +1 -1
  67. package/dist/retainQuery.d.ts +2 -1
  68. package/dist/retainQuery.d.ts.map +1 -1
  69. package/dist/retainQuery.js +20 -2
  70. package/dist/retainQuery.js.map +1 -1
  71. package/dist/rpcClient.d.ts +1 -0
  72. package/dist/rpcClient.d.ts.map +1 -1
  73. package/dist/rpcClient.js +1 -1
  74. package/dist/rpcClient.js.map +1 -1
  75. package/dist/servedHandlers.d.ts.map +1 -0
  76. package/dist/servedHandlers.js.map +1 -0
  77. package/dist/storedQueries.d.ts +17 -0
  78. package/dist/storedQueries.d.ts.map +1 -0
  79. package/dist/storedQueries.js +17 -0
  80. package/dist/storedQueries.js.map +1 -0
  81. package/dist/subjectHeader.d.ts +1 -0
  82. package/dist/subjectHeader.d.ts.map +1 -1
  83. package/dist/subjectHeader.js +4 -1
  84. package/dist/subjectHeader.js.map +1 -1
  85. package/dist/withClientProtocol.d.ts.map +1 -0
  86. package/dist/withClientProtocol.js.map +1 -0
  87. package/package.json +10 -9
  88. package/src/QueryStorage.ts +18 -0
  89. package/src/adapters/activityState.ts +12 -12
  90. package/src/adapters/browserQueryStorage.ts +14 -0
  91. package/src/adapters/indexedQueryRows.ts +66 -0
  92. package/src/adapters/openLiveHints.ts +1 -1
  93. package/src/adapters/queryPersistence.ts +134 -0
  94. package/src/adapters/storedQueryAccess.ts +37 -0
  95. package/src/clientActivities.ts +15 -10
  96. package/src/clientActivity.ts +1 -0
  97. package/src/clientOperations.ts +5 -4
  98. package/src/live-server/layer.ts +1 -1
  99. package/src/live-server/register.ts +1 -1
  100. package/src/live-server/service.ts +1 -1
  101. package/src/live-server/stream.ts +1 -1
  102. package/src/{adapters/liveHintStream.ts → liveHintStream.ts} +1 -1
  103. package/src/moduleHandlers.ts +1 -1
  104. package/src/queryRetention.ts +1 -0
  105. package/src/retainQuery.ts +25 -2
  106. package/src/rpcClient.ts +1 -1
  107. package/src/storedQueries.ts +34 -0
  108. package/src/subjectHeader.ts +5 -1
  109. package/dist/adapters/LiveDispatcher.d.ts.map +0 -1
  110. package/dist/adapters/LiveDispatcher.js.map +0 -1
  111. package/dist/adapters/liveHintStream.d.ts.map +0 -1
  112. package/dist/adapters/liveHintStream.js.map +0 -1
  113. package/dist/adapters/servedHandlers.d.ts.map +0 -1
  114. package/dist/adapters/servedHandlers.js.map +0 -1
  115. package/dist/adapters/withClientProtocol.d.ts.map +0 -1
  116. package/dist/adapters/withClientProtocol.js.map +0 -1
  117. /package/dist/{adapters/LiveDispatcher.d.ts → LiveDispatcher.d.ts} +0 -0
  118. /package/dist/{adapters/LiveDispatcher.js → LiveDispatcher.js} +0 -0
  119. /package/dist/{adapters/servedHandlers.d.ts → servedHandlers.d.ts} +0 -0
  120. /package/dist/{adapters/servedHandlers.js → servedHandlers.js} +0 -0
  121. /package/dist/{adapters/withClientProtocol.d.ts → withClientProtocol.d.ts} +0 -0
  122. /package/dist/{adapters/withClientProtocol.js → withClientProtocol.js} +0 -0
  123. /package/src/{adapters/LiveDispatcher.ts → LiveDispatcher.ts} +0 -0
  124. /package/src/{adapters/servedHandlers.ts → servedHandlers.ts} +0 -0
  125. /package/src/{adapters/withClientProtocol.ts → withClientProtocol.ts} +0 -0
@@ -1 +1 @@
1
- {"version":3,"file":"subjectHeader.d.ts","sourceRoot":"","sources":["../src/subjectHeader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAItC,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,GAAG,MAAM,GAAG,SAAS,CAE1E;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAEtH;AAGD,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAGvH"}
1
+ {"version":3,"file":"subjectHeader.d.ts","sourceRoot":"","sources":["../src/subjectHeader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAItC,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,GAAG,MAAM,GAAG,SAAS,CAE1E;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,KAAK,GAAG,SAAS,CAEtH;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAEnF;AAGD,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,KAAK,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAGvH"}
@@ -6,9 +6,12 @@ export function subjectHeader(headers) {
6
6
  export function withSubject(headers, subject) {
7
7
  return subject === undefined ? headers : Headers.set(Headers.fromInput(headers), HEADER, subject);
8
8
  }
9
+ export function inputSubject(headers) {
10
+ return headers === undefined ? undefined : subjectHeader(Headers.fromInput(headers));
11
+ }
9
12
  // Effect keys a serialized query by its tag and this key alone, so a subject that the key leaves out would hydrate into another subject's query.
10
13
  export function subjectSerializationKey(key, headers) {
11
- const subject = headers === undefined ? undefined : subjectHeader(Headers.fromInput(headers));
14
+ const subject = inputSubject(headers);
12
15
  return key === undefined || subject === undefined ? key : `${key}:subject:${subject}`;
13
16
  }
14
17
  //# sourceMappingURL=subjectHeader.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"subjectHeader.js","sourceRoot":"","sources":["../src/subjectHeader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC,MAAM,MAAM,GAAG,oBAAoB,CAAC;AAEpC,MAAM,UAAU,aAAa,CAAC,OAAwB;IACrD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAkC,EAAE,OAA2B;IAC1F,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACnG,CAAC;AAED,iJAAiJ;AACjJ,MAAM,UAAU,uBAAuB,CAAC,GAAuB,EAAE,OAAkC;IAClG,MAAM,OAAO,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9F,OAAO,GAAG,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,YAAY,OAAO,EAAE,CAAC;AACvF,CAAC"}
1
+ {"version":3,"file":"subjectHeader.js","sourceRoot":"","sources":["../src/subjectHeader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEtC,MAAM,MAAM,GAAG,oBAAoB,CAAC;AAEpC,MAAM,UAAU,aAAa,CAAC,OAAwB;IACrD,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AACxB,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,OAAkC,EAAE,OAA2B;IAC1F,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACnG,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,OAAkC;IAC9D,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;AACtF,CAAC;AAED,iJAAiJ;AACjJ,MAAM,UAAU,uBAAuB,CAAC,GAAuB,EAAE,OAAkC;IAClG,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACtC,OAAO,GAAG,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,YAAY,OAAO,EAAE,CAAC;AACvF,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"withClientProtocol.d.ts","sourceRoot":"","sources":["../src/withClientProtocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,eAAO,MAAM,kBAAkB,GAAwD,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,UAAU,EAAE,iBAAiB,gOAM3H,CAAC"}
@@ -0,0 +1 @@
1
+ {"version":3,"file":"withClientProtocol.js","sourceRoot":"","sources":["../src/withClientProtocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAGvC,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,EAAE,CAAC,8BAA8B,CAAC,CAAC,QAAQ,CAAC,EACpF,QAA+C,EAC/C,IAAqD;IAErD,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7C,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shivaedev/contract",
3
- "version": "0.52.0",
3
+ "version": "0.54.0",
4
4
  "description": "Typed query and command contracts over native Effect RPC and reactivity",
5
5
  "keywords": [
6
6
  "effect"
@@ -44,22 +44,23 @@
44
44
  ],
45
45
  "dependencies": {
46
46
  "@shivaedev/changes": "0.14.1",
47
- "@shivaedev/errors": "0.14.0",
47
+ "@shivaedev/errors": "0.14.1",
48
48
  "@shivaedev/service": "0.9.2",
49
49
  "@shivaedev/types": "0.4.0"
50
50
  },
51
51
  "devDependencies": {
52
52
  "@effect/platform-node": "4.1.4",
53
53
  "@effect/vitest": "4.1.4",
54
- "@shivaedev/identity": "0.35.0",
55
- "@shivaedev/quality": "0.80.0",
56
- "@shivaedev/server": "0.38.2",
57
- "@shivaedev/sql": "0.52.0",
58
- "@shivaedev/test-kits": "0.13.7",
59
- "@shivaedev/test-sql": "0.25.5",
60
- "@shivaedev/test-story": "0.50.1",
54
+ "@shivaedev/identity": "0.37.0",
55
+ "@shivaedev/quality": "0.82.0",
56
+ "@shivaedev/server": "0.39.0",
57
+ "@shivaedev/sql": "0.54.0",
58
+ "@shivaedev/test-kits": "0.15.0",
59
+ "@shivaedev/test-sql": "0.26.0",
60
+ "@shivaedev/test-story": "0.51.0",
61
61
  "@types/node": "24.19.2",
62
62
  "effect": "4.1.4",
63
+ "fake-indexeddb": "6.2.8",
63
64
  "happy-dom": "21.0.4",
64
65
  "typescript": "7.0.2",
65
66
  "vitest": "5.1.0"
@@ -0,0 +1,18 @@
1
+ import { Context, type Effect } from "effect";
2
+
3
+ export type QueryStorageOperation<A> = A | Effect.Effect<A, unknown>;
4
+
5
+ export interface StoredQuery {
6
+ readonly key: string;
7
+ readonly used: number;
8
+ readonly value: string;
9
+ }
10
+
11
+ export interface QueryStorage {
12
+ readonly clear: (user?: string) => QueryStorageOperation<void>;
13
+ readonly getAll: (user: string) => QueryStorageOperation<readonly StoredQuery[]>;
14
+ readonly removeItems: (user: string, keys: readonly string[]) => QueryStorageOperation<void>;
15
+ readonly setItems: (user: string, entries: readonly StoredQuery[]) => QueryStorageOperation<void>;
16
+ }
17
+
18
+ export class QueryStorageProvider extends Context.Service<QueryStorageProvider, () => QueryStorage>()("@shivaedev/contract/QueryStorageProvider") {}
@@ -3,8 +3,8 @@ import { type ClientActivityState, type ConnectionStatus, isClientSettled } from
3
3
 
4
4
  export function activityState() {
5
5
  let held = 0;
6
- let warmWaiting = 0;
7
- let answered = false;
6
+ let excused = 0;
7
+ let screenRendered = false;
8
8
  let connection: ConnectionStatus = "live";
9
9
  const state = Effect.runSync(
10
10
  SubscriptionRef.make<ClientActivityState>({
@@ -25,18 +25,18 @@ export function activityState() {
25
25
  );
26
26
  }
27
27
  function latched(current: ClientActivityState): ClientActivityState {
28
- const settled = isClientSettled({ ...current, initialQueries: current.initialQueries - warmWaiting });
29
- return answered && !current.firstSettled && settled ? { ...current, firstSettled: true } : current;
28
+ const settled = isClientSettled({ ...current, initialQueries: current.initialQueries - excused });
29
+ return screenRendered && !current.firstSettled && settled ? { ...current, firstSettled: true } : current;
30
30
  }
31
31
  return {
32
32
  activity: Object.assign(SubscriptionRef.changes(state), { current: SubscriptionRef.get(state) }),
33
- answered: () => {
34
- answered = true;
35
- Effect.runSync(SubscriptionRef.update(state, latched));
36
- },
37
33
  change: (key: Exclude<keyof ClientActivityState, "connectionStatus" | "firstSettled">, delta: number) => {
38
34
  Effect.runSync(SubscriptionRef.update(state, (current) => latched({ ...current, [key]: current[key] + delta })));
39
35
  },
36
+ excuse: (delta: number) => {
37
+ excused += delta;
38
+ Effect.runSync(SubscriptionRef.update(state, latched));
39
+ },
40
40
  hold: () => {
41
41
  held += 1;
42
42
  publish();
@@ -45,13 +45,13 @@ export function activityState() {
45
45
  publish();
46
46
  };
47
47
  },
48
+ rendered: Effect.suspend(() => {
49
+ screenRendered = true;
50
+ return SubscriptionRef.update(state, latched);
51
+ }),
48
52
  setConnection: (connectionStatus: ConnectionStatus) => {
49
53
  connection = connectionStatus;
50
54
  publish();
51
55
  },
52
- warming: (delta: number) => {
53
- warmWaiting += delta;
54
- Effect.runSync(SubscriptionRef.update(state, latched));
55
- },
56
56
  };
57
57
  }
@@ -0,0 +1,14 @@
1
+ import { Effect, Layer } from "effect";
2
+ import { indexedQueryRows } from "#adapters/indexedQueryRows.ts";
3
+ import { type QueryStorage, QueryStorageProvider } from "#QueryStorage.ts";
4
+
5
+ const rows = indexedQueryRows(() => ({ factory: globalThis.indexedDB, keyRange: globalThis.IDBKeyRange }));
6
+
7
+ const storage: QueryStorage = {
8
+ clear: (user) => Effect.tryPromise(() => rows.clear(user)),
9
+ getAll: (user) => Effect.tryPromise(() => rows.getAll(user)),
10
+ removeItems: (user, keys) => Effect.tryPromise(() => rows.removeItems(user, keys)),
11
+ setItems: (user, entries) => Effect.tryPromise(() => rows.setItems(user, entries)),
12
+ };
13
+
14
+ export const browserQueryStorage = Layer.succeed(QueryStorageProvider, () => storage);
@@ -0,0 +1,66 @@
1
+ import type { StoredQuery } from "#QueryStorage.ts";
2
+
3
+ const DATABASE = "@shivaedev/contract/queries";
4
+ const RESULTS = "results";
5
+
6
+ interface StoredRow extends StoredQuery {
7
+ readonly user: string;
8
+ }
9
+
10
+ interface IndexedHost {
11
+ readonly factory: IDBFactory;
12
+ readonly keyRange: typeof IDBKeyRange;
13
+ }
14
+
15
+ export function indexedQueryRows(host: () => IndexedHost) {
16
+ let opened: Promise<IDBDatabase> | undefined;
17
+ function database(): Promise<IDBDatabase> {
18
+ opened ??= new Promise<IDBDatabase>((resolve, reject) => {
19
+ const request = host().factory.open(DATABASE, 1);
20
+ request.onupgradeneeded = () => {
21
+ request.result.createObjectStore(RESULTS, { keyPath: ["user", "key"] });
22
+ };
23
+ request.onsuccess = () => resolve(request.result);
24
+ request.onerror = () => reject(request.error);
25
+ }).catch((error: unknown) => {
26
+ opened = undefined;
27
+ throw error;
28
+ });
29
+ return opened;
30
+ }
31
+ async function results<A>(mode: IDBTransactionMode, run: (store: IDBObjectStore) => IDBRequest<A> | undefined) {
32
+ const db = await database();
33
+ return new Promise<A | undefined>((resolve, reject) => {
34
+ const transaction = db.transaction(RESULTS, mode);
35
+ const request = run(transaction.objectStore(RESULTS));
36
+ transaction.oncomplete = () => resolve(request?.result);
37
+ transaction.onerror = () => reject(transaction.error);
38
+ transaction.onabort = () => reject(transaction.error);
39
+ });
40
+ }
41
+ // Rows are keyed [user, key]; an array sorts after every string, so [user, []] closes the range of one user's rows.
42
+ function userRows(user: string) {
43
+ return host().keyRange.bound([user], [user, []]);
44
+ }
45
+ return {
46
+ clear: (user?: string) => results("readwrite", (store) => (user === undefined ? store.clear() : store.delete(userRows(user)))),
47
+ getAll: async (user: string): Promise<StoredQuery[]> => {
48
+ const rows = await results<StoredRow[]>("readonly", (store) => store.getAll(userRows(user)));
49
+ return (rows ?? []).map(({ key, used, value }) => ({ key, used, value }));
50
+ },
51
+ removeItems: (user: string, keys: readonly string[]) =>
52
+ results("readwrite", (store) => {
53
+ for (const key of keys) {
54
+ store.delete([user, key]);
55
+ }
56
+ return undefined;
57
+ }),
58
+ setItems: (user: string, entries: readonly StoredQuery[]) =>
59
+ results("readwrite", (store) => {
60
+ for (const entry of entries) {
61
+ store.put({ ...entry, user });
62
+ }
63
+ return undefined;
64
+ }),
65
+ };
66
+ }
@@ -1,7 +1,7 @@
1
1
  import { Effect, Queue, Ref, Stream } from "effect";
2
2
  import * as Reactivity from "effect/reactivity/Reactivity";
3
3
  import { type Key, readKeys } from "@shivaedev/changes/keys.ts";
4
- import { LiveDispatcher } from "#adapters/LiveDispatcher.ts";
4
+ import { LiveDispatcher } from "#LiveDispatcher.ts";
5
5
  import type { initialize } from "#live-server/initialize.ts";
6
6
  import { liveHintQueue } from "#liveHintQueue.ts";
7
7
 
@@ -0,0 +1,134 @@
1
+ import { Effect, Exit, Option } from "effect";
2
+ import * as AsyncResult from "effect/reactivity/AsyncResult";
3
+ import * as Atom from "effect/reactivity/Atom";
4
+ import { storageOperation, storageQueue } from "#adapters/storedQueryAccess.ts";
5
+ import type { StoredQuery } from "#QueryStorage.ts";
6
+ import { queryRetention } from "#queryRetention.ts";
7
+ import { type StoredForm, storedQueries } from "#storedQueries.ts";
8
+
9
+ export const STORED_WRITE_WINDOW = "1 second";
10
+ const STORED_BYTES = 5_000_000;
11
+ const utf8 = new TextEncoder();
12
+
13
+ function storedBytes(key: string, value: string) {
14
+ return utf8.encode(key).byteLength + utf8.encode(value).byteLength;
15
+ }
16
+
17
+ export const queryPersistence = Atom.keepAlive(
18
+ Atom.make((get) => {
19
+ const opened = get(storedQueries);
20
+ if (opened === undefined) {
21
+ return undefined;
22
+ }
23
+ const { storage, user } = opened;
24
+ const registry = get.registry;
25
+ const seeds = new Map(opened.entries.map((entry) => [entry.key, entry.value]));
26
+ const kept = new Map<string, number>();
27
+ let used = 0;
28
+ for (const entry of [...opened.entries].sort((left, right) => left.used - right.used)) {
29
+ kept.set(entry.key, storedBytes(entry.key, entry.value));
30
+ used = Math.max(used, entry.used);
31
+ }
32
+ const written = new Map<string, StoredQuery>();
33
+ const removed = new Set<string>();
34
+ let active = true;
35
+ let stop: (() => void) | undefined;
36
+ get.addFinalizer(() => {
37
+ active = false;
38
+ stop?.();
39
+ });
40
+ function flush() {
41
+ stop?.();
42
+ stop = undefined;
43
+ const entries = [...written.values()];
44
+ const keys = [...removed];
45
+ written.clear();
46
+ removed.clear();
47
+ if (!active || (entries.length === 0 && keys.length === 0)) {
48
+ return;
49
+ }
50
+ Effect.runFork(
51
+ storageQueue(storage)(
52
+ Effect.all([
53
+ entries.length === 0 ? Effect.void : storageOperation(() => storage.setItems(user, entries)),
54
+ keys.length === 0 ? Effect.void : storageOperation(() => storage.removeItems(user, keys)),
55
+ ]),
56
+ ).pipe(Effect.catchTag("QueryStorageUnavailable", () => Effect.void)),
57
+ );
58
+ }
59
+ function forget(key: string) {
60
+ kept.delete(key);
61
+ written.delete(key);
62
+ removed.add(key);
63
+ }
64
+ function schedule(runtime: Atom.AtomRuntime<unknown, unknown>) {
65
+ if (stop !== undefined) {
66
+ return;
67
+ }
68
+ const timer = Atom.make((context) => {
69
+ const services = context(runtime);
70
+ if (AsyncResult.isSuccess(services)) {
71
+ context.addFinalizer(Effect.runCallbackWith(services.value)(Effect.sleep(STORED_WRITE_WINDOW).pipe(Effect.andThen(Effect.sync(flush)))));
72
+ }
73
+ }).pipe(Atom.setIdleTTL(0));
74
+ stop = registry.mount(timer);
75
+ }
76
+ function evict() {
77
+ const { capacity = 100, storedBytes: byteCap = STORED_BYTES } = registry.get(queryRetention);
78
+ let bytes = [...kept.values()].reduce((total, size) => total + size, 0);
79
+ for (const [key, size] of kept) {
80
+ if (kept.size <= capacity && bytes <= byteCap) {
81
+ break;
82
+ }
83
+ bytes -= size;
84
+ forget(key);
85
+ }
86
+ }
87
+ function run<A>(runtime: Atom.AtomRuntime<unknown, unknown>, effect: Effect.Effect<A, unknown, unknown>): Option.Option<A> {
88
+ const services = registry.get(runtime);
89
+ if (!AsyncResult.isSuccess(services)) {
90
+ return Option.none();
91
+ }
92
+ const exit = Effect.runSyncExitWith(services.value)(effect);
93
+ return Exit.isSuccess(exit) ? Option.some(exit.value) : Option.none();
94
+ }
95
+ function drop(key: string, runtime: Atom.AtomRuntime<unknown, unknown>) {
96
+ seeds.delete(key);
97
+ if (kept.has(key) || written.has(key)) {
98
+ forget(key);
99
+ schedule(runtime);
100
+ }
101
+ }
102
+ return {
103
+ drop: <A>(form: StoredForm<A>, runtime: Atom.AtomRuntime<unknown, unknown>) => {
104
+ Option.map(run(runtime, form.key), (key) => drop(key, runtime));
105
+ },
106
+ flush,
107
+ restore: <A>(form: StoredForm<A>, runtime: Atom.AtomRuntime<unknown, unknown>): Option.Option<A> =>
108
+ Option.flatMap(run(runtime, form.key), (key) => {
109
+ const raw = seeds.get(key);
110
+ seeds.delete(key);
111
+ if (raw === undefined) {
112
+ return Option.none();
113
+ }
114
+ const decoded = run(runtime, form.decode(raw));
115
+ if (Option.isNone(decoded)) {
116
+ drop(key, runtime);
117
+ }
118
+ return decoded;
119
+ }),
120
+ save: <A>(form: StoredForm<A>, value: A, runtime: Atom.AtomRuntime<unknown, unknown>) => {
121
+ const stored = Option.all({ encoded: run(runtime, form.encode(value)), key: run(runtime, form.key) });
122
+ Option.map(stored, ({ encoded, key }) => {
123
+ used += 1;
124
+ kept.delete(key);
125
+ kept.set(key, storedBytes(key, encoded));
126
+ written.set(key, { key, used, value: encoded });
127
+ removed.delete(key);
128
+ evict();
129
+ schedule(runtime);
130
+ });
131
+ },
132
+ };
133
+ }),
134
+ );
@@ -0,0 +1,37 @@
1
+ import { Data, Effect, Semaphore } from "effect";
2
+ import { type QueryStorage, type QueryStorageOperation, QueryStorageProvider } from "#QueryStorage.ts";
3
+ import type { OpenedQueryStorage } from "#storedQueries.ts";
4
+
5
+ export class QueryStorageUnavailable extends Data.TaggedError("QueryStorageUnavailable")<{ readonly cause: unknown }> {}
6
+
7
+ export function storageOperation<A>(run: () => QueryStorageOperation<A>): Effect.Effect<A, QueryStorageUnavailable> {
8
+ return Effect.suspend(() => {
9
+ const value = run();
10
+ return Effect.isEffect(value) ? value : Effect.succeed(value);
11
+ }).pipe(Effect.catchCause((cause) => Effect.fail(new QueryStorageUnavailable({ cause }))));
12
+ }
13
+
14
+ // Writes from one generation, the next generation's read and a wipe reach the same storage, so they run in the order they were asked for.
15
+ const queues = new WeakMap<QueryStorage, Semaphore.Semaphore>();
16
+ export function storageQueue(storage: QueryStorage) {
17
+ let queue = queues.get(storage);
18
+ if (queue === undefined) {
19
+ queue = Semaphore.makeUnsafe(1);
20
+ queues.set(storage, queue);
21
+ }
22
+ return queue.withPermit;
23
+ }
24
+
25
+ // Storage the browser refuses leaves this generation without stored results rather than failing it.
26
+ export const openStoredQueries = Effect.fn("Contract.openStoredQueries")(function* (user: string) {
27
+ const storage = (yield* QueryStorageProvider)();
28
+ return yield* storageQueue(storage)(storageOperation(() => storage.getAll(user))).pipe(
29
+ Effect.map((entries): OpenedQueryStorage | undefined => ({ entries, storage, user })),
30
+ Effect.catchTag("QueryStorageUnavailable", () => Effect.succeed(undefined)),
31
+ );
32
+ });
33
+
34
+ export const clearStoredQueries = Effect.fn("Contract.clearStoredQueries")(function* (user?: string) {
35
+ const storage = (yield* QueryStorageProvider)();
36
+ yield* storageQueue(storage)(storageOperation(() => storage.clear(user))).pipe(Effect.catchTag("QueryStorageUnavailable", () => Effect.void));
37
+ });
@@ -3,13 +3,14 @@ import * as AsyncResult from "effect/reactivity/AsyncResult";
3
3
  import type * as Atom from "effect/reactivity/Atom";
4
4
  import { activityState } from "#adapters/activityState.ts";
5
5
  import { clientConnection } from "#adapters/clientConnection.ts";
6
+ import { querySignals, shareQuerySignals } from "#querySignals.ts";
6
7
  import { wrapAtom } from "#wrapAtom.ts";
7
8
 
8
9
  type ActivityTracker = ReturnType<typeof makeActivity>;
9
10
  export const clientActivities = new WeakMap<object, ActivityTracker>();
10
11
 
11
12
  export function makeActivity(factory: Atom.RuntimeFactory) {
12
- const { activity, answered, change, hold, setConnection, warming } = activityState();
13
+ const { activity, change, excuse, hold, rendered, setConnection } = activityState();
13
14
  const connection = clientConnection(factory, setConnection, activity);
14
15
  function begin(key: "rpcCalls" | "commands" | "unreflectedCommands") {
15
16
  change(key, 1);
@@ -44,7 +45,9 @@ export function makeActivity(factory: Atom.RuntimeFactory) {
44
45
  get.mount(connection.status);
45
46
  const refreshing = counter((delta) => change("refreshingAtoms", delta));
46
47
  const initial = counter((delta) => change("initialQueries", delta));
47
- const warmInitial = counter(warming);
48
+ // A warm query no screen reads, or one that shows a stored or retained result, does not hold back the first reveal.
49
+ const excused = counter(excuse);
50
+ const signals = querySignals(atom);
48
51
  let received = false;
49
52
  let active = true;
50
53
  let published = false;
@@ -52,19 +55,20 @@ export function makeActivity(factory: Atom.RuntimeFactory) {
52
55
  if (!active) {
53
56
  return;
54
57
  }
55
- const first = !(received || AsyncResult.isInitial(result));
56
- received ||= first;
58
+ received ||= !AsyncResult.isInitial(result);
57
59
  initial.set(!received);
58
- warmInitial.set(!received && warm(get));
60
+ excused.set(!received && (warm(get) || get.once(signals).retained === true));
59
61
  refreshing.set(result.waiting || AsyncResult.isInitial(result));
60
- if (first) {
61
- answered();
62
- }
63
62
  }
63
+ get.subscribe(signals, ({ retained }) => {
64
+ if (active) {
65
+ excused.set(!received && (warm(get) || retained === true));
66
+ }
67
+ });
64
68
  get.addFinalizer(() => {
65
69
  active = false;
66
70
  refreshing.release();
67
- warmInitial.release();
71
+ excused.release();
68
72
  initial.release();
69
73
  });
70
74
  function publish(result: AsyncResult.AsyncResult<A, E>) {
@@ -80,10 +84,11 @@ export function makeActivity(factory: Atom.RuntimeFactory) {
80
84
  }
81
85
  return value;
82
86
  });
87
+ shareQuerySignals(watched, atom);
83
88
  return watched;
84
89
  }
85
90
  return {
86
- activity: Object.assign(activity, { connectionStatus: connection.status, firstSettled: connection.firstSettled }),
91
+ activity: Object.assign(activity, { connectionStatus: connection.status, firstSettled: connection.firstSettled, rendered }),
87
92
  hint: () => change("liveHints", 1),
88
93
  hold: <A, E, R>(effect: Effect.Effect<A, E, R>) =>
89
94
  track(
@@ -18,6 +18,7 @@ export type ClientActivity = Stream.Stream<ClientActivityState> & {
18
18
  readonly connectionStatus: Atom.Atom<ConnectionStatus>;
19
19
  readonly current: Effect.Effect<ClientActivityState>;
20
20
  readonly firstSettled: Atom.Atom<boolean>;
21
+ readonly rendered: Effect.Effect<void>;
21
22
  };
22
23
 
23
24
  export const Activity = Symbol.for("@shivaedev/contract/ClientActivity");
@@ -17,10 +17,10 @@ import { CommandSignal, untilReflected } from "#commandSignal.ts";
17
17
  import { waitForConnection } from "#connectionReadiness.ts";
18
18
  import { LIVE_SYNC } from "#liveSyncRpc.ts";
19
19
  import type { CommandShape, QueryShape } from "#operation.ts";
20
- import { shareQuerySignals } from "#querySignals.ts";
21
20
  import { type CommandObserver, reflectCommand } from "#reflectCommand.ts";
22
21
  import { retainQuery } from "#retainQuery.ts";
23
- import { subjectSerializationKey, withSubject } from "#subjectHeader.ts";
22
+ import { storedForm } from "#storedQueries.ts";
23
+ import { inputSubject, subjectSerializationKey, withSubject } from "#subjectHeader.ts";
24
24
  import { warmQueries } from "#warmQueries.ts";
25
25
 
26
26
  // `runtime.fn(api.save.run)` passes its function context as the second argument, so only an options object selects a subject.
@@ -46,6 +46,7 @@ export function clientOperations(
46
46
 
47
47
  function boundQuery(tag: string, query: QueryShape) {
48
48
  const cached = new WeakMap<ReturnType<typeof ordinaryClient.query>, ReturnType<typeof ordinaryClient.query>>();
49
+ const stored = storedForm(tag, query);
49
50
  return {
50
51
  query: (payload: unknown, { headers: given, serializationKey, subject }: QueryOptions = {}) => {
51
52
  const headers = withSubject(given, subject);
@@ -75,8 +76,8 @@ export function clientOperations(
75
76
  function warm(get: Atom.AtomContext): boolean {
76
77
  return get.once(warmQueries).has(tracked);
77
78
  }
78
- const tracked = retainQuery(ordinaryClient.runtime, clientActivities.get(ordinaryClient)?.watch(result, warm) ?? result);
79
- shareQuerySignals(tracked, result);
79
+ const watched = clientActivities.get(ordinaryClient)?.watch(result, warm) ?? result;
80
+ const tracked = retainQuery(ordinaryClient.runtime, watched, stored(payload, inputSubject(headers)));
80
81
  cached.set(atom, tracked);
81
82
  return tracked;
82
83
  },
@@ -1,5 +1,5 @@
1
1
  import { Layer } from "effect";
2
- import { LiveDispatcher } from "#adapters/LiveDispatcher.ts";
2
+ import { LiveDispatcher } from "#LiveDispatcher.ts";
3
3
  import { LiveServer } from "#live-server/service.ts";
4
4
 
5
5
  export const liveServerLayer = LiveServer.layer.pipe(Layer.provide(LiveDispatcher.layer));
@@ -1,7 +1,7 @@
1
1
  import { Effect } from "effect";
2
2
  import type { Key } from "@shivaedev/changes/keys.ts";
3
- import { liveHintStream } from "#adapters/liveHintStream.ts";
4
3
  import type { initialize } from "#live-server/initialize.ts";
4
+ import { liveHintStream } from "#liveHintStream.ts";
5
5
 
6
6
  export function register(state: Effect.Success<typeof initialize>) {
7
7
  return Effect.fn("LiveServer.register")(function* (keys: readonly Key[], syncClient?: string) {
@@ -1,7 +1,7 @@
1
1
  import { Random } from "effect";
2
2
  import * as Reactivity from "effect/reactivity/Reactivity";
3
3
  import { defineService } from "@shivaedev/service/defineService.ts";
4
- import { LiveDispatcher } from "#adapters/LiveDispatcher.ts";
4
+ import { LiveDispatcher } from "#LiveDispatcher.ts";
5
5
  import { initialize } from "#live-server/initialize.ts";
6
6
  import { register } from "#live-server/register.ts";
7
7
  import { resync } from "#live-server/resync.ts";
@@ -1,7 +1,7 @@
1
1
  import { Effect, Stream } from "effect";
2
2
  import type { Key } from "@shivaedev/changes/keys.ts";
3
- import { liveHintStream } from "#adapters/liveHintStream.ts";
4
3
  import type { initialize } from "#live-server/initialize.ts";
4
+ import { liveHintStream } from "#liveHintStream.ts";
5
5
 
6
6
  export function stream(state: Effect.Success<typeof initialize>) {
7
7
  return Effect.fn("LiveServer.stream")(function* (keys: readonly Key[], syncClient?: string) {
@@ -1,8 +1,8 @@
1
1
  import { Effect, Stream } from "effect";
2
2
  import * as Reactivity from "effect/reactivity/Reactivity";
3
3
  import type { Key } from "@shivaedev/changes/keys.ts";
4
- import { LiveDispatcher } from "#adapters/LiveDispatcher.ts";
5
4
  import { openLiveHints } from "#adapters/openLiveHints.ts";
5
+ import { LiveDispatcher } from "#LiveDispatcher.ts";
6
6
  import type { initialize } from "#live-server/initialize.ts";
7
7
 
8
8
  export const liveHintStream = Effect.fn("LiveServer.liveHintStream")(function* (
@@ -1,9 +1,9 @@
1
1
  import type { Layer } from "effect";
2
2
  import type { Rpc, RpcGroup } from "effect/rpc";
3
- import { servedHandlers } from "#adapters/servedHandlers.ts";
4
3
  import type { Declared } from "#contract.ts";
5
4
  import type { ModuleServices } from "#moduleProof.ts";
6
5
  import type { CommandShape, QueryShape, StreamShape } from "#operation.ts";
6
+ import { servedHandlers } from "#servedHandlers.ts";
7
7
 
8
8
  export interface AnyModule {
9
9
  readonly "~requires": ModuleServices;
@@ -3,6 +3,7 @@ import * as Atom from "effect/reactivity/Atom";
3
3
 
4
4
  export interface QueryRetentionOptions {
5
5
  readonly capacity?: number;
6
+ readonly storedBytes?: number;
6
7
  readonly timeToLive?: Duration.Input;
7
8
  }
8
9
 
@@ -1,8 +1,10 @@
1
- import { Option } from "effect";
1
+ import { Cause, Option, Predicate } from "effect";
2
2
  import * as AsyncResult from "effect/reactivity/AsyncResult";
3
3
  import * as Atom from "effect/reactivity/Atom";
4
+ import { queryPersistence } from "#adapters/queryPersistence.ts";
4
5
  import { retainedQueries } from "#adapters/retainedQueries.ts";
5
6
  import { querySignals, shareQuerySignals } from "#querySignals.ts";
7
+ import type { StoredForm } from "#storedQueries.ts";
6
8
  import { wrapAtom } from "#wrapAtom.ts";
7
9
 
8
10
  const runtimes = new WeakMap<Atom.Atom<unknown>, Atom.AtomRuntime<unknown, unknown>>();
@@ -11,22 +13,43 @@ export function queryRuntime(query: Atom.Atom<unknown>): Atom.AtomRuntime<unknow
11
13
  return runtimes.get(query);
12
14
  }
13
15
 
14
- export function retainQuery<A, E>(runtime: Atom.AtomRuntime<unknown, unknown>, atom: Atom.Atom<AsyncResult.AsyncResult<A, E>>) {
16
+ const gone = Predicate.or(Predicate.isTagged("QueryReadDenied"), Predicate.isTagged("NotFound"));
17
+
18
+ export function retainQuery<A, E>(
19
+ runtime: Atom.AtomRuntime<unknown, unknown>,
20
+ atom: Atom.Atom<AsyncResult.AsyncResult<A, E>>,
21
+ stored?: StoredForm<A>,
22
+ ) {
15
23
  const snapshot = Atom.make<Option.Option<AsyncResult.Success<A, E>>>(Option.none()).pipe(Atom.setIdleTTL(0));
16
24
  const signals = querySignals(atom);
17
25
  const retained = wrapAtom(atom, (get) => {
18
26
  get.mount(snapshot);
19
27
  const owner = get.once(retainedQueries);
28
+ const persistence = stored === undefined ? undefined : get.once(queryPersistence);
20
29
  owner.take(retained);
21
30
  get.addFinalizer(() => {
22
31
  if (get.registry.getNodes().has(snapshot) && Option.isSome(get.registry.get(snapshot))) {
23
32
  owner.keep(retained, snapshot, runtime);
24
33
  }
25
34
  });
35
+ if (stored !== undefined && persistence !== undefined && Option.isNone(get.once(snapshot))) {
36
+ Option.map(persistence.restore(stored, runtime), (value) => get.set(snapshot, Option.some(AsyncResult.success<A, E>(value))));
37
+ }
38
+ function persist(result: AsyncResult.AsyncResult<A, E>) {
39
+ if (stored === undefined || persistence === undefined || result.waiting) {
40
+ return;
41
+ }
42
+ if (AsyncResult.isSuccess(result)) {
43
+ persistence.save(stored, result.value, runtime);
44
+ } else if (AsyncResult.isFailure(result) && Option.exists(Cause.findErrorOption(result.cause), gone)) {
45
+ persistence.drop(stored, runtime);
46
+ }
47
+ }
26
48
  function display(result: AsyncResult.AsyncResult<A, E>) {
27
49
  if (AsyncResult.isSuccess(result) && !result.waiting) {
28
50
  get.set(snapshot, Option.some(result));
29
51
  }
52
+ persist(result);
30
53
  const kept = AsyncResult.isInitial(result) ? get.once(snapshot) : Option.none<AsyncResult.Success<A, E>>();
31
54
  get.set(signals, { ...get.once(signals), retained: Option.isSome(kept) });
32
55
  return Option.match(kept, { onNone: () => result, onSome: AsyncResult.waiting });