@shivaedev/contract 0.43.5 → 0.45.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 (139) hide show
  1. package/CHANGELOG.md +43 -0
  2. package/README.md +265 -45
  3. package/dist/adapters/activityState.d.ts +3 -2
  4. package/dist/adapters/activityState.d.ts.map +1 -1
  5. package/dist/adapters/activityState.js +11 -1
  6. package/dist/adapters/activityState.js.map +1 -1
  7. package/dist/adapters/clientConnection.d.ts +1 -0
  8. package/dist/adapters/clientConnection.d.ts.map +1 -1
  9. package/dist/adapters/clientConnection.js +18 -10
  10. package/dist/adapters/clientConnection.js.map +1 -1
  11. package/dist/adapters/servedHandlers.d.ts +8 -0
  12. package/dist/adapters/servedHandlers.d.ts.map +1 -0
  13. package/dist/adapters/servedHandlers.js +51 -0
  14. package/dist/adapters/servedHandlers.js.map +1 -0
  15. package/dist/automaticQuery.js +1 -1
  16. package/dist/automaticQuery.js.map +1 -1
  17. package/dist/clientActivities.d.ts +2 -0
  18. package/dist/clientActivities.d.ts.map +1 -1
  19. package/dist/clientActivities.js +7 -3
  20. package/dist/clientActivities.js.map +1 -1
  21. package/dist/clientActivity.d.ts +2 -2
  22. package/dist/clientActivity.d.ts.map +1 -1
  23. package/dist/clientActivity.js +1 -1
  24. package/dist/clientActivity.js.map +1 -1
  25. package/dist/clientContract.d.ts +51 -0
  26. package/dist/clientContract.d.ts.map +1 -0
  27. package/dist/clientContract.js +32 -0
  28. package/dist/clientContract.js.map +1 -0
  29. package/dist/clientMatchesModule.d.ts +18 -0
  30. package/dist/clientMatchesModule.d.ts.map +1 -0
  31. package/dist/clientMatchesModule.js +2 -0
  32. package/dist/clientMatchesModule.js.map +1 -0
  33. package/dist/contract.d.ts +23 -1
  34. package/dist/contract.d.ts.map +1 -1
  35. package/dist/contract.js +9 -6
  36. package/dist/contract.js.map +1 -1
  37. package/dist/declarationError.d.ts +1 -2
  38. package/dist/declarationError.d.ts.map +1 -1
  39. package/dist/declarationError.js +3 -1
  40. package/dist/declarationError.js.map +1 -1
  41. package/dist/defineModule.d.ts +41 -0
  42. package/dist/defineModule.d.ts.map +1 -0
  43. package/dist/defineModule.js +17 -0
  44. package/dist/defineModule.js.map +1 -0
  45. package/dist/live-server/subscribe.d.ts.map +1 -1
  46. package/dist/live-server/subscribe.js +64 -6
  47. package/dist/live-server/subscribe.js.map +1 -1
  48. package/dist/live.d.ts +1 -0
  49. package/dist/live.d.ts.map +1 -1
  50. package/dist/live.js +5 -0
  51. package/dist/live.js.map +1 -1
  52. package/dist/liveAnswers.d.ts +9 -0
  53. package/dist/liveAnswers.d.ts.map +1 -0
  54. package/dist/liveAnswers.js +12 -0
  55. package/dist/liveAnswers.js.map +1 -0
  56. package/dist/moduleHandlers.d.ts +15 -0
  57. package/dist/moduleHandlers.d.ts.map +1 -0
  58. package/dist/moduleHandlers.js +5 -0
  59. package/dist/moduleHandlers.js.map +1 -0
  60. package/dist/moduleProof.d.ts +79 -0
  61. package/dist/moduleProof.d.ts.map +1 -0
  62. package/dist/moduleProof.js +2 -0
  63. package/dist/moduleProof.js.map +1 -0
  64. package/dist/operation.d.ts +14 -12
  65. package/dist/operation.d.ts.map +1 -1
  66. package/dist/operation.js +10 -4
  67. package/dist/operation.js.map +1 -1
  68. package/dist/operationDeclaration.d.ts +9 -1
  69. package/dist/operationDeclaration.d.ts.map +1 -1
  70. package/dist/operationDeclaration.js.map +1 -1
  71. package/dist/queryDelivery.js +1 -1
  72. package/dist/queryDelivery.js.map +1 -1
  73. package/dist/querySubscription.d.ts +1 -1
  74. package/dist/querySubscription.d.ts.map +1 -1
  75. package/dist/querySubscription.js +6 -4
  76. package/dist/querySubscription.js.map +1 -1
  77. package/dist/readPolicy.d.ts +2 -1
  78. package/dist/readPolicy.d.ts.map +1 -1
  79. package/dist/readPolicy.js +9 -5
  80. package/dist/readPolicy.js.map +1 -1
  81. package/dist/retainQuery.d.ts +1 -0
  82. package/dist/retainQuery.d.ts.map +1 -1
  83. package/dist/retainQuery.js +5 -0
  84. package/dist/retainQuery.js.map +1 -1
  85. package/dist/rpcClient.d.ts +1 -0
  86. package/dist/rpcClient.d.ts.map +1 -1
  87. package/dist/runProof.d.ts +69 -0
  88. package/dist/runProof.d.ts.map +1 -0
  89. package/dist/runProof.js +2 -0
  90. package/dist/runProof.js.map +1 -0
  91. package/dist/servedOperation.d.ts +72 -0
  92. package/dist/servedOperation.d.ts.map +1 -0
  93. package/dist/servedOperation.js +11 -0
  94. package/dist/servedOperation.js.map +1 -0
  95. package/dist/servedReadPolicy.d.ts +11 -0
  96. package/dist/servedReadPolicy.d.ts.map +1 -0
  97. package/dist/servedReadPolicy.js +9 -0
  98. package/dist/servedReadPolicy.js.map +1 -0
  99. package/dist/serverMetadata.d.ts +1 -4
  100. package/dist/serverMetadata.d.ts.map +1 -1
  101. package/dist/serverMetadata.js +3 -6
  102. package/dist/serverMetadata.js.map +1 -1
  103. package/dist/successProof.d.ts +51 -0
  104. package/dist/successProof.d.ts.map +1 -0
  105. package/dist/successProof.js +2 -0
  106. package/dist/successProof.js.map +1 -0
  107. package/dist/wire.d.ts +25 -0
  108. package/dist/wire.d.ts.map +1 -0
  109. package/dist/wire.js +13 -0
  110. package/dist/wire.js.map +1 -0
  111. package/package.json +16 -16
  112. package/src/adapters/activityState.ts +12 -3
  113. package/src/adapters/clientConnection.ts +24 -16
  114. package/src/adapters/servedHandlers.ts +69 -0
  115. package/src/automaticQuery.ts +1 -1
  116. package/src/clientActivities.ts +7 -3
  117. package/src/clientActivity.ts +3 -1
  118. package/src/clientContract.ts +128 -0
  119. package/src/clientMatchesModule.ts +24 -0
  120. package/src/contract.ts +24 -17
  121. package/src/declarationError.ts +5 -2
  122. package/src/defineModule.ts +112 -0
  123. package/src/live-server/subscribe.ts +74 -6
  124. package/src/live.ts +7 -0
  125. package/src/liveAnswers.ts +13 -0
  126. package/src/moduleHandlers.ts +23 -0
  127. package/src/moduleProof.ts +101 -0
  128. package/src/operation.ts +47 -33
  129. package/src/operationDeclaration.ts +19 -1
  130. package/src/queryDelivery.ts +1 -1
  131. package/src/querySubscription.ts +6 -4
  132. package/src/readPolicy.ts +15 -5
  133. package/src/retainQuery.ts +7 -0
  134. package/src/runProof.ts +96 -0
  135. package/src/servedOperation.ts +145 -0
  136. package/src/servedReadPolicy.ts +19 -0
  137. package/src/serverMetadata.ts +3 -6
  138. package/src/successProof.ts +120 -0
  139. package/src/wire.ts +45 -0
@@ -0,0 +1,51 @@
1
+ import type { Option, Schema } from "effect";
2
+ export interface SuccessDiffersFromRun<TOperation extends string, TRun, TDeclared> {
3
+ readonly operation: TOperation;
4
+ readonly runReturns: TRun;
5
+ readonly successDeclares: TDeclared;
6
+ }
7
+ export interface ArrayMutabilityDiffers<TOperation extends string, TFix extends string> {
8
+ readonly fix: TFix;
9
+ readonly operation: TOperation;
10
+ }
11
+ export interface SuccessClassNotReturned<TOperation extends string, TRun, TClass> {
12
+ readonly operation: TOperation;
13
+ readonly runReturns: TRun;
14
+ readonly successClass: TClass;
15
+ }
16
+ type Same<TLeft, TRight> = [TLeft] extends [TRight] ? ([TRight] extends [TLeft] ? true : false) : false;
17
+ export type Identical<TLeft, TRight> = (<T>() => T extends TLeft ? 1 : 2) extends <T>() => (T extends TRight ? 1 : 2) ? true : false;
18
+ type ReadonlyArrays<T> = T extends readonly (infer TItem)[] ? readonly ReadonlyArrays<TItem>[] : T extends (...args: never) => unknown ? T : T extends object ? {
19
+ readonly [TKey in keyof T]: ReadonlyArrays<T[TKey]>;
20
+ } : T;
21
+ type Fields<TName extends string, TFields, TReturn> = {
22
+ readonly [TKey in keyof TFields]: NotEncodedAsReturned<TName, TFields[TKey], TKey extends keyof TReturn ? TReturn[TKey] : never>;
23
+ }[keyof TFields];
24
+ type Elements<TName extends string, TElements extends readonly unknown[], TReturn> = {
25
+ readonly [TIndex in keyof TElements]: NotEncodedAsReturned<TName, TElements[TIndex], TIndex extends keyof TReturn ? TReturn[TIndex] : never>;
26
+ }[number];
27
+ type Members<TName extends string, TMembers extends readonly unknown[], TReturn> = {
28
+ readonly [TIndex in keyof TMembers]: TMembers[TIndex] extends Schema.Top ? NotEncodedAsReturned<TName, TMembers[TIndex], Extract<TReturn, TMembers[TIndex]["Type"]>> : never;
29
+ }[number];
30
+ type Matches<TReturn, TMembers extends readonly unknown[]> = true extends {
31
+ readonly [TIndex in keyof TMembers]: TMembers[TIndex] extends Schema.Top ? (TReturn extends TMembers[TIndex]["Type"] ? true : false) : false;
32
+ }[number] ? true : false;
33
+ type Covered<TName extends string, TMembers extends readonly unknown[], TReturn> = {
34
+ readonly [TIndex in keyof TMembers]: TMembers[TIndex] extends Schema.Struct<infer TFields> ? Schema.Struct<TFields>["Type"] extends TReturn ? {
35
+ readonly fields: Fields<TName, TFields, TReturn>;
36
+ readonly type: Schema.Struct<TFields>["Type"];
37
+ } : never : never;
38
+ }[number];
39
+ type Unmatched<TName extends string, TMembers extends readonly unknown[], TReturn> = TReturn extends unknown ? Matches<TReturn, TMembers> extends true ? never : Covered<TName, TMembers, TReturn> extends infer TCovered extends {
40
+ readonly fields: unknown;
41
+ readonly type: unknown;
42
+ } ? [TCovered] extends [never] ? never : TCovered["fields"] | KeysDiffer<TName, TCovered["type"], TReturn> : never : never;
43
+ type InCollection<TName extends string, TSchema, TReturn> = TSchema extends Schema.Union<infer TMembers> ? Members<TName, TMembers, TReturn> | Unmatched<TName, TMembers, TReturn> : TSchema extends Schema.$Record<infer _TKey, infer TValue> ? NotEncodedAsReturned<TName, TValue, TReturn[keyof TReturn]> : TSchema extends Schema.Option<infer TValue> ? NotEncodedAsReturned<TName, TValue, TReturn extends Option.Option<infer TReturned> ? TReturned : never> : never;
44
+ type KeysOf<T> = T extends unknown ? keyof T : never;
45
+ type KeysDiffer<TName extends string, TType, TReturn> = [TReturn] extends [never] ? never : Same<KeysOf<TType>, KeysOf<TReturn>> extends true ? never : SuccessDiffersFromRun<TName, TReturn, TType>;
46
+ type InComposite<TName extends string, TSchema, TReturn> = TSchema extends Schema.Struct<infer TFields> ? Fields<TName, TFields, TReturn> | KeysDiffer<TName, Schema.Struct<TFields>["Type"], TReturn> : TSchema extends Schema.Tuple<infer TElements> ? Elements<TName, TElements, TReturn> : InCollection<TName, TSchema, TReturn>;
47
+ type InContainer<TName extends string, TSchema, TReturn> = TSchema extends Schema.$Array<infer TItem> | Schema.NonEmptyArray<infer TItem> ? NotEncodedAsReturned<TName, TItem, TReturn extends readonly (infer TReturned)[] ? TReturned : never> : TSchema extends Schema.mutable<infer TInner> ? NotEncodedAsReturned<TName, TInner, TReturn> : TSchema extends Schema.mutableKey<infer TInner> ? NotEncodedAsReturned<TName, TInner, TReturn> : TSchema extends Schema.optionalKey<infer TInner> ? NotEncodedAsReturned<TName, TInner, Exclude<TReturn, undefined>> : InComposite<TName, TSchema, TReturn>;
48
+ type NotEncodedAsReturned<TName extends string, TSchema, TReturn> = TSchema extends Schema.Class<infer TClass, infer _TStruct, infer _TInherited> ? Identical<TClass, TReturn> extends true ? never : SuccessClassNotReturned<TName, TReturn, TClass> : InContainer<TName, TSchema, TReturn>;
49
+ export type SuccessProblem<TName extends string, TSuccess, TReturn> = TSuccess extends Schema.Top ? Same<TSuccess["Type"], TReturn> extends true ? NotEncodedAsReturned<TName, TSuccess, TReturn> : TSuccess extends Schema.Class<infer TClass, infer _TStruct, infer _TInherited> ? SuccessClassNotReturned<TName, TReturn, TClass> : Same<ReadonlyArrays<TSuccess["Type"]>, ReadonlyArrays<TReturn>> extends true ? ArrayMutabilityDiffers<TName, "return a readonly array, or declare Schema.mutable for a mutable one"> : SuccessDiffersFromRun<TName, TReturn, TSuccess["Type"]> : never;
50
+ export {};
51
+ //# sourceMappingURL=successProof.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"successProof.d.ts","sourceRoot":"","sources":["../src/successProof.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAE7C,MAAM,WAAW,qBAAqB,CAAC,UAAU,SAAS,MAAM,EAAE,IAAI,EAAE,SAAS;IAChF,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAC/B,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;IAC1B,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC;CACpC;AAED,MAAM,WAAW,sBAAsB,CAAC,UAAU,SAAS,MAAM,EAAE,IAAI,SAAS,MAAM;IACrF,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC;IACnB,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,uBAAuB,CAAC,UAAU,SAAS,MAAM,EAAE,IAAI,EAAE,MAAM;IAC/E,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAC/B,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC9B;AAED,KAAK,IAAI,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC;AACxG,MAAM,MAAM,SAAS,CAAC,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,QAAO,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,CAAC,CAAA,GAAG,IAAI,GAAG,KAAK,CAAC;AACnI,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,GACxD,SAAS,cAAc,CAAC,KAAK,CAAC,EAAE,GAChC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,GACpC,CAAC,GACD,CAAC,SAAS,MAAM,GACf;IAAE,QAAQ,EAAE,IAAI,IAAI,MAAM,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;CAAE,GACvD,CAAC,CAAC;AAEP,KAAK,MAAM,CAAC,KAAK,SAAS,MAAM,EAAE,OAAO,EAAE,OAAO,IAAI;IACrD,QAAQ,EAAE,IAAI,IAAI,MAAM,OAAO,GAAG,oBAAoB,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,SAAS,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;CAChI,CAAC,MAAM,OAAO,CAAC,CAAC;AAEjB,KAAK,QAAQ,CAAC,KAAK,SAAS,MAAM,EAAE,SAAS,SAAS,SAAS,OAAO,EAAE,EAAE,OAAO,IAAI;IACpF,QAAQ,EAAE,MAAM,IAAI,MAAM,SAAS,GAAG,oBAAoB,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,SAAS,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;CAC5I,CAAC,MAAM,CAAC,CAAC;AAEV,KAAK,OAAO,CAAC,KAAK,SAAS,MAAM,EAAE,QAAQ,SAAS,SAAS,OAAO,EAAE,EAAE,OAAO,IAAI;IAClF,QAAQ,EAAE,MAAM,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAAG,GACrE,oBAAoB,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GACzF,KAAK;CACR,CAAC,MAAM,CAAC,CAAC;AAEV,KAAK,OAAO,CAAC,OAAO,EAAE,QAAQ,SAAS,SAAS,OAAO,EAAE,IAAI,IAAI,SAAS;IACzE,QAAQ,EAAE,MAAM,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,SAAS,QAAQ,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,GAAG,KAAK;CAC5I,CAAC,MAAM,CAAC,GACN,IAAI,GACJ,KAAK,CAAC;AAET,KAAK,OAAO,CAAC,KAAK,SAAS,MAAM,EAAE,QAAQ,SAAS,SAAS,OAAO,EAAE,EAAE,OAAO,IAAI;IAClF,QAAQ,EAAE,MAAM,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,OAAO,CAAC,GACvF,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,SAAS,OAAO,GAC7C;QAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAA;KAAE,GACnG,KAAK,GACN,KAAK;CACR,CAAC,MAAM,CAAC,CAAC;AAGV,KAAK,SAAS,CAAC,KAAK,SAAS,MAAM,EAAE,QAAQ,SAAS,SAAS,OAAO,EAAE,EAAE,OAAO,IAAI,OAAO,SAAS,OAAO,GACzG,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,SAAS,IAAI,GACtC,KAAK,GACL,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,SAAS,MAAM,QAAQ,SAAS;IAAE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACpH,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,GACzB,KAAK,GACL,QAAQ,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,GAClE,KAAK,GACP,KAAK,CAAC;AAET,KAAK,YAAY,CAAC,KAAK,SAAS,MAAM,EAAE,OAAO,EAAE,OAAO,IACvD,OAAO,SAAS,MAAM,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,GACzC,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,GACvE,OAAO,SAAS,MAAM,CAAC,OAAO,CAAC,MAAM,KAAK,EAAE,MAAM,MAAM,CAAC,GACxD,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,OAAO,CAAC,CAAC,GAC3D,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,MAAM,CAAC,GAC1C,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,SAAS,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC,GACvG,KAAK,CAAC;AAEZ,KAAK,MAAM,CAAC,CAAC,IAAI,CAAC,SAAS,OAAO,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC;AAErD,KAAK,UAAU,CAAC,KAAK,SAAS,MAAM,EAAE,KAAK,EAAE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,GAC9E,KAAK,GACL,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,IAAI,GAChD,KAAK,GACL,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;AAEjD,KAAK,WAAW,CAAC,KAAK,SAAS,MAAM,EAAE,OAAO,EAAE,OAAO,IACtD,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,OAAO,CAAC,GACzC,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,GAC5F,OAAO,SAAS,MAAM,CAAC,KAAK,CAAC,MAAM,SAAS,CAAC,GAC5C,QAAQ,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,GACnC,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAE3C,KAAK,WAAW,CAAC,KAAK,SAAS,MAAM,EAAE,OAAO,EAAE,OAAO,IAAI,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,GACtI,oBAAoB,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,SAAS,SAAS,CAAC,MAAM,SAAS,CAAC,EAAE,GAAG,SAAS,GAAG,KAAK,CAAC,GACpG,OAAO,SAAS,MAAM,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC,GAC3C,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,GAC5C,OAAO,SAAS,MAAM,CAAC,UAAU,CAAC,MAAM,MAAM,CAAC,GAC9C,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,GAC5C,OAAO,SAAS,MAAM,CAAC,WAAW,CAAC,MAAM,MAAM,CAAC,GAC/C,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,GAChE,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAI3C,KAAK,oBAAoB,CAAC,KAAK,SAAS,MAAM,EAAE,OAAO,EAAE,OAAO,IAC/D,OAAO,SAAS,MAAM,CAAC,KAAK,CAAC,MAAM,MAAM,EAAE,MAAM,QAAQ,EAAE,MAAM,WAAW,CAAC,GAC1E,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,IAAI,GACtC,KAAK,GACL,uBAAuB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,GAChD,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAEzC,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,MAAM,EAAE,QAAQ,EAAE,OAAO,IAAI,QAAQ,SAAS,MAAM,CAAC,GAAG,GAC9F,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,SAAS,IAAI,GAC3C,oBAAoB,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,GAC9C,QAAQ,SAAS,MAAM,CAAC,KAAK,CAAC,MAAM,MAAM,EAAE,MAAM,QAAQ,EAAE,MAAM,WAAW,CAAC,GAC7E,uBAAuB,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,GAC/C,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,SAAS,IAAI,GAC3E,sBAAsB,CAAC,KAAK,EAAE,sEAAsE,CAAC,GACrG,qBAAqB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,GAC1D,KAAK,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=successProof.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"successProof.js","sourceRoot":"","sources":["../src/successProof.ts"],"names":[],"mappings":""}
package/dist/wire.d.ts ADDED
@@ -0,0 +1,25 @@
1
+ import type { Schema } from "effect";
2
+ import { InternalServerError, ServiceUnavailable } from "@shivaedev/errors/taxonomy.ts";
3
+ import type { CommandShape, QueryShape } from "#operation.ts";
4
+ import type { ClassRejections, SpecsOf } from "#runProof.ts";
5
+ import type { ServedCommand, ServedQuery } from "#servedOperation.ts";
6
+ export interface WireEntry {
7
+ readonly rejections: ClassRejections;
8
+ readonly success: Schema.Top;
9
+ }
10
+ export interface Wire {
11
+ readonly [operation: string]: WireEntry;
12
+ }
13
+ export type WireEntryOf<TWire, TName> = TName extends keyof TWire ? (TWire[TName] extends WireEntry ? TWire[TName] : undefined) : undefined;
14
+ export type Wired<TOperation, TEntry> = TEntry extends WireEntry ? TOperation extends ServedQuery<infer TName, infer TPayload, infer _TSuccess, infer _TSpecs, infer TPolicyError, infer TPolicyServices, infer TRun> ? ServedQuery<TName, TPayload, TEntry["success"], SpecsOf<TEntry["rejections"]>, TPolicyError, TPolicyServices, TRun> : TOperation extends ServedCommand<infer TName, infer TPayload, infer _TSuccess, infer _TSpecs, infer TRun> ? ServedCommand<TName, TPayload, TEntry["success"], SpecsOf<TEntry["rejections"]>, TRun> : TOperation : TOperation;
15
+ export type WiredAll<TOperations extends readonly unknown[], TWire> = {
16
+ readonly [TIndex in keyof TOperations]: Wired<TOperations[TIndex], WireEntryOf<TWire, TOperations[TIndex] extends {
17
+ readonly name: infer TName;
18
+ } ? TName : never>>;
19
+ };
20
+ export declare function wireRejections(rejections: ClassRejections): {
21
+ InternalServerError: typeof InternalServerError;
22
+ ServiceUnavailable: typeof ServiceUnavailable;
23
+ };
24
+ export declare function wired(operation: QueryShape | CommandShape, entry: WireEntry | undefined): QueryShape | CommandShape;
25
+ //# sourceMappingURL=wire.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"wire.d.ts","sourceRoot":"","sources":["../src/wire.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxF,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE9D,OAAO,KAAK,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGtE,MAAM,WAAW,SAAS;IACzB,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC;CAC7B;AAED,MAAM,WAAW,IAAI;IACpB,QAAQ,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CACxC;AAED,MAAM,MAAM,WAAW,CAAC,KAAK,EAAE,KAAK,IAAI,KAAK,SAAS,MAAM,KAAK,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;AAE5I,MAAM,MAAM,KAAK,CAAC,UAAU,EAAE,MAAM,IAAI,MAAM,SAAS,SAAS,GAC7D,UAAU,SAAS,WAAW,CAAC,MAAM,KAAK,EAAE,MAAM,QAAQ,EAAE,MAAM,SAAS,EAAE,MAAM,OAAO,EAAE,MAAM,YAAY,EAAE,MAAM,eAAe,EAAE,MAAM,IAAI,CAAC,GACjJ,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,YAAY,EAAE,eAAe,EAAE,IAAI,CAAC,GACnH,UAAU,SAAS,aAAa,CAAC,MAAM,KAAK,EAAE,MAAM,QAAQ,EAAE,MAAM,SAAS,EAAE,MAAM,OAAO,EAAE,MAAM,IAAI,CAAC,GACxG,aAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,CAAC,GACtF,UAAU,GACZ,UAAU,CAAC;AAEd,MAAM,MAAM,QAAQ,CAAC,WAAW,SAAS,SAAS,OAAO,EAAE,EAAE,KAAK,IAAI;IACrE,QAAQ,EAAE,MAAM,IAAI,MAAM,WAAW,GAAG,KAAK,CAC5C,WAAW,CAAC,MAAM,CAAC,EACnB,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC,SAAS;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,KAAK,CAAA;KAAE,GAAG,KAAK,GAAG,KAAK,CAAC,CAC9F;CACD,CAAC;AAEF,wBAAgB,cAAc,CAAC,UAAU,EAAE,eAAe;;;EAEzD;AAED,wBAAgB,KAAK,CAAC,SAAS,EAAE,UAAU,GAAG,YAAY,EAAE,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,YAAY,CAMnH"}
package/dist/wire.js ADDED
@@ -0,0 +1,13 @@
1
+ import { InternalServerError, ServiceUnavailable } from "@shivaedev/errors/taxonomy.ts";
2
+ import { rejectionSet } from "#rejection.ts";
3
+ export function wireRejections(rejections) {
4
+ return { ...rejections, InternalServerError, ServiceUnavailable };
5
+ }
6
+ export function wired(operation, entry) {
7
+ if (entry === undefined) {
8
+ return operation;
9
+ }
10
+ const rejections = wireRejections(entry.rejections);
11
+ return { ...operation, rejections, success: entry.success, ...rejectionSet(rejections) };
12
+ }
13
+ //# sourceMappingURL=wire.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"wire.js","sourceRoot":"","sources":["../src/wire.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAExF,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AA+B7C,MAAM,UAAU,cAAc,CAAC,UAA2B;IACzD,OAAO,EAAE,GAAG,UAAU,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,SAAoC,EAAE,KAA4B;IACvF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACzB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACpD,OAAO,EAAE,GAAG,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,YAAY,CAAC,UAAU,CAAC,EAAE,CAAC;AAC1F,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shivaedev/contract",
3
- "version": "0.43.5",
3
+ "version": "0.45.0",
4
4
  "description": "Typed query and command contracts over native Effect RPC and reactivity",
5
5
  "keywords": [
6
6
  "effect"
@@ -43,29 +43,29 @@
43
43
  "README.md"
44
44
  ],
45
45
  "dependencies": {
46
- "@shivaedev/changes": "0.11.1",
47
- "@shivaedev/service": "0.9.0",
46
+ "@shivaedev/changes": "0.12.0",
47
+ "@shivaedev/errors": "0.12.0",
48
+ "@shivaedev/service": "0.9.1",
48
49
  "@shivaedev/types": "0.4.0"
49
50
  },
50
51
  "devDependencies": {
51
- "@effect/platform-node": "4.1.1",
52
- "@effect/vitest": "4.1.1",
53
- "@shivaedev/errors": "0.11.0",
54
- "@shivaedev/identity": "0.31.1",
55
- "@shivaedev/quality": "0.76.0",
56
- "@shivaedev/server": "0.33.4",
57
- "@shivaedev/sql": "0.46.4",
58
- "@shivaedev/test-kits": "0.11.1",
59
- "@shivaedev/test-sql": "0.24.8",
60
- "@shivaedev/test-story": "0.46.1",
52
+ "@effect/platform-node": "4.1.2",
53
+ "@effect/vitest": "4.1.2",
54
+ "@shivaedev/identity": "0.32.1",
55
+ "@shivaedev/quality": "0.78.1",
56
+ "@shivaedev/server": "0.34.2",
57
+ "@shivaedev/sql": "0.48.0",
58
+ "@shivaedev/test-kits": "0.13.0",
59
+ "@shivaedev/test-sql": "0.25.1",
60
+ "@shivaedev/test-story": "0.47.2",
61
61
  "@types/node": "24.19.2",
62
- "effect": "4.1.1",
62
+ "effect": "4.1.2",
63
63
  "happy-dom": "21.0.4",
64
64
  "typescript": "7.0.2",
65
- "vitest": "5.0.5"
65
+ "vitest": "5.1.0"
66
66
  },
67
67
  "peerDependencies": {
68
- "effect": "4.1.1"
68
+ "effect": "4.1.2"
69
69
  },
70
70
  "engines": {
71
71
  "node": ">=24"
@@ -1,13 +1,15 @@
1
1
  import { Effect, SubscriptionRef } from "effect";
2
- import type { ClientActivityState, ConnectionStatus } from "#clientActivity.ts";
2
+ import { type ClientActivityState, type ConnectionStatus, isClientSettled } from "#clientActivity.ts";
3
3
 
4
4
  export function activityState() {
5
5
  let held = 0;
6
+ let answered = false;
6
7
  let connection: ConnectionStatus = "live";
7
8
  const state = Effect.runSync(
8
9
  SubscriptionRef.make<ClientActivityState>({
9
10
  commands: 0,
10
11
  connectionStatus: "live",
12
+ firstSettled: false,
11
13
  initialQueries: 0,
12
14
  liveHints: 0,
13
15
  refreshingAtoms: 0,
@@ -20,10 +22,17 @@ export function activityState() {
20
22
  SubscriptionRef.update(state, (current) => (current.connectionStatus === connectionStatus ? current : { ...current, connectionStatus })),
21
23
  );
22
24
  }
25
+ function latched(current: ClientActivityState): ClientActivityState {
26
+ return answered && !current.firstSettled && isClientSettled(current) ? { ...current, firstSettled: true } : current;
27
+ }
23
28
  return {
24
29
  activity: Object.assign(SubscriptionRef.changes(state), { current: SubscriptionRef.get(state) }),
25
- change: (key: Exclude<keyof ClientActivityState, "connectionStatus">, delta: number) => {
26
- Effect.runSync(SubscriptionRef.update(state, (current) => ({ ...current, [key]: current[key] + delta })));
30
+ answered: () => {
31
+ answered = true;
32
+ Effect.runSync(SubscriptionRef.update(state, latched));
33
+ },
34
+ change: (key: Exclude<keyof ClientActivityState, "connectionStatus" | "firstSettled">, delta: number) => {
35
+ Effect.runSync(SubscriptionRef.update(state, (current) => latched({ ...current, [key]: current[key] + delta })));
27
36
  },
28
37
  hold: () => {
29
38
  held += 1;
@@ -37,20 +37,28 @@ export function clientConnection(
37
37
  get.addFinalizer(cancel);
38
38
  return "live";
39
39
  });
40
- const status = Atom.make((get): ConnectionStatus => {
41
- get.mount(debounced);
42
- const context = AsyncResult.value(get(runtime));
43
- if (Option.isSome(context)) {
44
- const cancel = Effect.runCallbackWith(context.value)(
45
- activity.pipe(
46
- Stream.map((state) => state.connectionStatus),
47
- Stream.changes,
48
- Stream.runForEach((value) => Effect.sync(() => get.setSelf(value))),
49
- ),
50
- );
51
- get.addFinalizer(cancel);
52
- }
53
- return Effect.runSync(activity.current).connectionStatus;
54
- });
55
- return { status, statuses };
40
+ function follow<A>(select: (state: ClientActivityState) => A, mounts: readonly Atom.Atom<unknown>[] = []) {
41
+ return Atom.make((get): A => {
42
+ for (const mounted of mounts) {
43
+ get.mount(mounted);
44
+ }
45
+ const context = AsyncResult.value(get(runtime));
46
+ if (Option.isSome(context)) {
47
+ const cancel = Effect.runCallbackWith(context.value)(
48
+ activity.pipe(
49
+ Stream.map(select),
50
+ Stream.changes,
51
+ Stream.runForEach((value) => Effect.sync(() => get.setSelf(value))),
52
+ ),
53
+ );
54
+ get.addFinalizer(cancel);
55
+ }
56
+ return select(Effect.runSync(activity.current));
57
+ });
58
+ }
59
+ return {
60
+ firstSettled: follow((state) => state.firstSettled),
61
+ status: follow((state) => state.connectionStatus, [debounced]),
62
+ statuses,
63
+ };
56
64
  }
@@ -0,0 +1,69 @@
1
+ import { Effect, Layer, type Schema } from "effect";
2
+ import { Rpc, RpcGroup, RpcSchema } from "effect/rpc";
3
+ import { ReadRecorder } from "@shivaedev/changes/readRecorder.ts";
4
+ import { rpcBoundary } from "@shivaedev/errors/boundary.ts";
5
+ import { InternalServerError } from "@shivaedev/errors/taxonomy.ts";
6
+ import type { Declared } from "#contract.ts";
7
+ import type { CommandShape, QueryShape, StreamShape } from "#operation.ts";
8
+ import { CurrentViewer, checkPolicy, type QueryReadPolicy } from "#readPolicy.ts";
9
+ import { ServedReadPolicy } from "#servedReadPolicy.ts";
10
+
11
+ type Runnable = (payload: unknown) => Effect.Effect<unknown, unknown, unknown>;
12
+
13
+ function runOf(operation: QueryShape | CommandShape): Runnable | undefined {
14
+ const run: unknown = Reflect.get(operation, "run");
15
+ return typeof run === "function" ? (payload) => Reflect.apply(run, operation, [payload]) : undefined;
16
+ }
17
+
18
+ function spanOwner(name: string) {
19
+ return `${name.charAt(0).toUpperCase()}${name.slice(1)}`;
20
+ }
21
+
22
+ function guarded(rpc: Rpc.AnyWithProps) {
23
+ return rpcBoundary(rpc.errorSchema, { unexpected: (message) => new InternalServerError({ message }) });
24
+ }
25
+
26
+ function served(rpc: Rpc.AnyWithProps, operation: QueryShape | CommandShape, run: Runnable, span: string) {
27
+ const boundary = guarded(rpc);
28
+ return (payload: unknown) =>
29
+ Effect.gen(function* () {
30
+ if (operation.kind === "query") {
31
+ yield* checkPolicy(operation, operation.readPolicy, payload, yield* CurrentViewer).pipe(
32
+ Effect.provideService(ReadRecorder, ReadRecorder.defaultValue()),
33
+ );
34
+ }
35
+ return yield* run(payload);
36
+ }).pipe(Effect.withSpan(span), boundary);
37
+ }
38
+
39
+ // Live subscriptions check the policy outside the handler, so the policy carries the handler's failure mapping.
40
+ function servedPolicy(rpc: Rpc.AnyWithProps, policy: QueryReadPolicy<unknown, unknown, unknown>): QueryReadPolicy<unknown, unknown, unknown> {
41
+ const boundary = guarded(rpc);
42
+ return (payload, viewer) => boundary(Effect.suspend(() => policy(payload, viewer)));
43
+ }
44
+
45
+ type EffectRpc = Rpc.Rpc<string, Schema.Top, Schema.Top, Schema.Top>;
46
+
47
+ // An erased Rpc's `any` success schema selects the stream branch of Rpc.ResultFrom, which an Effect handler cannot satisfy.
48
+ function isEffectRpc(rpc: Rpc.Any | undefined): rpc is EffectRpc {
49
+ return Rpc.isRpc(rpc) && !RpcSchema.isStreamSchema(rpc.successSchema);
50
+ }
51
+
52
+ export function servedHandlers(
53
+ application: { readonly requests: ReadonlyMap<string, Rpc.Any> },
54
+ declaration: Declared<string, readonly QueryShape[], readonly CommandShape[], readonly StreamShape[], "session" | undefined>,
55
+ ): Layer.Layer<Rpc.Handler<string>, never, unknown> {
56
+ const layers = [...declaration.queries, ...declaration.commands].map((operation): Layer.Layer<Rpc.Handler<string>, never, unknown> => {
57
+ const tag = `${declaration.name}.${operation.name}`;
58
+ const rpc = application.requests.get(tag);
59
+ const run = runOf(operation);
60
+ if (!isEffectRpc(rpc) || run === undefined) {
61
+ return Layer.effectContext(Effect.die(new Error(`Module ${declaration.name} cannot serve ${tag}: it has no RPC or no run`)));
62
+ }
63
+ const handler = RpcGroup.make(rpc).toLayerHandler(tag, served(rpc, operation, run, `${spanOwner(declaration.name)}.${operation.name}`));
64
+ return operation.kind === "query" && operation.readPolicy !== undefined
65
+ ? handler.pipe(Layer.provide(Layer.succeed(ServedReadPolicy, { check: servedPolicy(rpc, operation.readPolicy) })))
66
+ : handler;
67
+ });
68
+ return Layer.mergeAll(Layer.empty, ...layers);
69
+ }
@@ -123,7 +123,7 @@ export function automaticQuery<A, E>({
123
123
  start();
124
124
  return get.once(source);
125
125
  }
126
- return AsyncResult.initial();
126
+ return AsyncResult.initial(true);
127
127
  },
128
128
  (refresh) => {
129
129
  refresh(ready);
@@ -9,7 +9,7 @@ type ActivityTracker = ReturnType<typeof makeActivity>;
9
9
  export const clientActivities = new WeakMap<object, ActivityTracker>();
10
10
 
11
11
  export function makeActivity(factory: Atom.RuntimeFactory) {
12
- const { activity, change, hold, setConnection } = activityState();
12
+ const { activity, answered, change, hold, setConnection } = activityState();
13
13
  const connection = clientConnection(factory, setConnection, activity);
14
14
  function begin(key: "rpcCalls" | "commands") {
15
15
  change(key, 1);
@@ -51,9 +51,13 @@ export function makeActivity(factory: Atom.RuntimeFactory) {
51
51
  if (!active) {
52
52
  return;
53
53
  }
54
- received ||= !AsyncResult.isInitial(result);
54
+ const first = !(received || AsyncResult.isInitial(result));
55
+ received ||= first;
55
56
  initial.set(!received);
56
57
  refreshing.set(result.waiting || AsyncResult.isInitial(result));
58
+ if (first) {
59
+ answered();
60
+ }
57
61
  }
58
62
  get.addFinalizer(() => {
59
63
  active = false;
@@ -76,7 +80,7 @@ export function makeActivity(factory: Atom.RuntimeFactory) {
76
80
  return watched;
77
81
  }
78
82
  return {
79
- activity: Object.assign(activity, { connectionStatus: connection.status }),
83
+ activity: Object.assign(activity, { connectionStatus: connection.status, firstSettled: connection.firstSettled }),
80
84
  hint: () => change("liveHints", 1),
81
85
  hold: <A, E, R>(effect: Effect.Effect<A, E, R>) =>
82
86
  track(
@@ -6,6 +6,7 @@ export type ConnectionStatus = "live" | "reconnecting" | "waiting-for-connection
6
6
  export interface ClientActivityState {
7
7
  readonly commands: number;
8
8
  readonly connectionStatus: ConnectionStatus;
9
+ readonly firstSettled: boolean;
9
10
  readonly initialQueries: number;
10
11
  readonly liveHints: number;
11
12
  readonly refreshingAtoms: number;
@@ -15,6 +16,7 @@ export interface ClientActivityState {
15
16
  export type ClientActivity = Stream.Stream<ClientActivityState> & {
16
17
  readonly connectionStatus: Atom.Atom<ConnectionStatus>;
17
18
  readonly current: Effect.Effect<ClientActivityState>;
19
+ readonly firstSettled: Atom.Atom<boolean>;
18
20
  };
19
21
 
20
22
  export const Activity = Symbol.for("@shivaedev/contract/ClientActivity");
@@ -37,7 +39,7 @@ export function isClientSettled(state: ClientActivityState): boolean {
37
39
 
38
40
  export function activityScreenSignal(activity: ClientActivity, settled = isClientSettled) {
39
41
  function screenState(state: ClientActivityState) {
40
- return { connectionStatus: state.connectionStatus, hints: state.liveHints, pending: !settled(state) };
42
+ return { connectionStatus: state.connectionStatus, pending: !settled(state) };
41
43
  }
42
44
  return Object.assign(Stream.map(activity, screenState), { current: Effect.map(activity.current, screenState) });
43
45
  }
@@ -0,0 +1,128 @@
1
+ import type { Option, Schema } from "effect";
2
+ import type { RpcMiddleware } from "effect/rpc";
3
+ import type { Key } from "@shivaedev/changes/keys.ts";
4
+ import { declaredGroup } from "#contract.ts";
5
+ import type { ModuleContract } from "#defineModule.ts";
6
+ import type { Command, Operation, PayloadSchema } from "#operation.ts";
7
+ import { operation } from "#operationDeclaration.ts";
8
+ import type { Viewer } from "#readPolicy.ts";
9
+ import type { RejectionSpecs } from "#rejection.ts";
10
+ import type { SpecsOf } from "#runProof.ts";
11
+ import type { SubjectDeclaration } from "#subject.ts";
12
+ import { type Wire, type WireEntry, wireRejections } from "#wire.ts";
13
+
14
+ export interface ClientQuery<TName extends string, TPayload extends Schema.Top, TSuccess extends Schema.Top, TSpecs extends RejectionSpecs>
15
+ extends Operation<TName, TPayload, TSuccess, TSpecs> {
16
+ readonly kind: "query";
17
+ reads: (payload: TPayload["Type"], viewer: Option.Option<Viewer>) => readonly Key[];
18
+ }
19
+
20
+ type Payloads<TWire> = { readonly [TOperation in keyof TWire]?: Schema.Top | Schema.Struct.Fields };
21
+ type PayloadOf<TPayloads, TOperation> = PayloadSchema<TOperation extends keyof TPayloads ? NonNullable<TPayloads[TOperation]> : Schema.Void>;
22
+ type EntryOf<TWire, TOperation> = TOperation extends keyof TWire ? (TWire[TOperation] extends WireEntry ? TWire[TOperation] : never) : never;
23
+
24
+ interface QueryKeys<TPayload> {
25
+ readonly reads: (payload: TPayload, viewer: Option.Option<Viewer>) => readonly Key[];
26
+ readonly readsCollections?: readonly { readonly name: string }[];
27
+ }
28
+
29
+ interface CommandKeys<TPayload, TResult> {
30
+ readonly invalidates?: (payload: TPayload, result: TResult, viewer?: Option.Option<Viewer>) => readonly Key[];
31
+ }
32
+
33
+ type ClientQueries<TWire, TPayloads, TQueries extends string> = {
34
+ readonly [TOperation in TQueries]: ClientQuery<
35
+ TOperation,
36
+ PayloadOf<TPayloads, TOperation>,
37
+ EntryOf<TWire, TOperation>["success"],
38
+ SpecsOf<EntryOf<TWire, TOperation>["rejections"]>
39
+ >;
40
+ }[TQueries];
41
+
42
+ type ClientCommands<TWire, TPayloads, TCommands extends string> = {
43
+ readonly [TOperation in TCommands]: Command<
44
+ TOperation,
45
+ PayloadOf<TPayloads, TOperation>,
46
+ EntryOf<TWire, TOperation>["success"],
47
+ SpecsOf<EntryOf<TWire, TOperation>["rejections"]>
48
+ >;
49
+ }[TCommands];
50
+
51
+ export interface ClientContractDefinition<
52
+ TName extends string,
53
+ TWire extends Wire,
54
+ TPayloads extends Payloads<TWire>,
55
+ TQueries extends keyof TWire & string,
56
+ TCommands extends keyof TWire & string,
57
+ TMiddleware extends RpcMiddleware.AnyService,
58
+ TSubject extends SubjectDeclaration | undefined,
59
+ TScope extends "session" | undefined,
60
+ > {
61
+ readonly commands?: {
62
+ readonly [TOperation in TCommands]: CommandKeys<PayloadOf<TPayloads, TOperation>["Type"], EntryOf<TWire, TOperation>["success"]["Type"]>;
63
+ };
64
+ readonly keyScope?: TScope;
65
+ readonly middleware?: TMiddleware;
66
+ readonly name: TName;
67
+ readonly payloads?: TPayloads;
68
+ readonly queries?: { readonly [TOperation in TQueries]: QueryKeys<PayloadOf<TPayloads, TOperation>["Type"]> };
69
+ readonly subject?: TSubject;
70
+ readonly wire: TWire;
71
+ }
72
+
73
+ // Written by the generator: what the browser needs of a module as values, without its run, read policy or services.
74
+ export function clientContract<
75
+ const TName extends string,
76
+ const TWire extends Wire,
77
+ const TPayloads extends Payloads<TWire> = Record<never, never>,
78
+ TQueries extends keyof TWire & string = never,
79
+ TCommands extends keyof TWire & string = never,
80
+ TMiddleware extends RpcMiddleware.AnyService = never,
81
+ const TSubject extends SubjectDeclaration | undefined = undefined,
82
+ const TScope extends "session" | undefined = undefined,
83
+ >(
84
+ definition: ClientContractDefinition<TName, TWire, TPayloads, TQueries, TCommands, TMiddleware, TSubject, TScope>,
85
+ ): ModuleContract<
86
+ TName,
87
+ readonly (ClientQueries<TWire, TPayloads, TQueries> | ClientCommands<TWire, TPayloads, TCommands>)[],
88
+ TMiddleware,
89
+ TSubject,
90
+ TScope
91
+ >;
92
+ export function clientContract(definition: {
93
+ readonly commands?: { readonly [operation: string]: CommandKeys<unknown, unknown> };
94
+ readonly keyScope?: "session";
95
+ readonly middleware?: RpcMiddleware.AnyService;
96
+ readonly name: string;
97
+ readonly payloads?: { readonly [operation: string]: Schema.Top | Schema.Struct.Fields | undefined };
98
+ readonly queries?: { readonly [operation: string]: QueryKeys<unknown> };
99
+ readonly subject?: SubjectDeclaration;
100
+ readonly wire: Wire;
101
+ }): unknown {
102
+ function declared(name: string) {
103
+ const entry = definition.wire[name];
104
+ const payload = definition.payloads?.[name];
105
+ return {
106
+ ...(payload === undefined ? {} : { payload }),
107
+ ...(entry === undefined ? {} : { rejections: wireRejections(entry.rejections), success: entry.success }),
108
+ };
109
+ }
110
+ const queries = Object.entries(definition.queries ?? {}).map(([name, { reads, readsCollections = [] }]) => {
111
+ const collections: readonly Key[] = readsCollections.map((collection) => ({ _tag: "List", collection: collection.name }));
112
+ return {
113
+ ...operation("query", name, declared(name)),
114
+ reads: (payload: unknown, viewer: Option.Option<Viewer>) => [...reads(payload, viewer), ...collections],
115
+ };
116
+ });
117
+ const commands = Object.entries(definition.commands ?? {}).map(([name, { invalidates }]) => ({
118
+ ...operation("command", name, declared(name)),
119
+ invalidates: invalidates ?? (() => []),
120
+ }));
121
+ const group = declaredGroup(definition.name, {
122
+ commands,
123
+ queries,
124
+ ...(definition.keyScope === undefined ? {} : { keyScope: definition.keyScope }),
125
+ ...(definition.subject === undefined ? {} : { subject: definition.subject }),
126
+ });
127
+ return definition.middleware?.key === undefined ? group : group.middleware(definition.middleware);
128
+ }
@@ -0,0 +1,24 @@
1
+ import type { RpcGroup } from "effect/rpc";
2
+
3
+ type Rpcs<TGroup> = TGroup extends RpcGroup.RpcGroup<infer TRpcs> ? TRpcs : never;
4
+ type Same<TLeft, TRight> = [TLeft] extends [TRight] ? ([TRight] extends [TLeft] ? true : false) : false;
5
+ type OperationOf<TTag> = TTag extends `${string}.${infer TOperation}` ? TOperation : TTag;
6
+
7
+ type Differing<TClient, TModule> = {
8
+ readonly [TTag in Rpcs<TClient>["_tag"] | Rpcs<TModule>["_tag"]]: Same<
9
+ Extract<Rpcs<TClient>, { readonly _tag: TTag }>,
10
+ Extract<Rpcs<TModule>, { readonly _tag: TTag }>
11
+ > extends true
12
+ ? never
13
+ : OperationOf<TTag>;
14
+ }[Rpcs<TClient>["_tag"] | Rpcs<TModule>["_tag"]];
15
+
16
+ export interface ClientDiffersFromModule<TOperations, TFix extends string> {
17
+ readonly fix: TFix;
18
+ readonly operations: TOperations;
19
+ }
20
+
21
+ // A generated file ends with `export const matches: ClientMatchesModule<typeof Client, typeof Module> = true;`.
22
+ export type ClientMatchesModule<TClient, TModule> = [Differing<TClient, TModule>] extends [never]
23
+ ? true
24
+ : ClientDiffersFromModule<Differing<TClient, TModule>, "the generated file is stale; run pnpm generate">;
package/src/contract.ts CHANGED
@@ -1,11 +1,11 @@
1
- import { Schema } from "effect";
1
+ import { Context, Schema } from "effect";
2
2
  import { Rpc, RpcGroup, type RpcMiddleware } from "effect/rpc";
3
3
  import { DeclarationError, declarationError, type Unique } from "#declarationError.ts";
4
4
  import type { CommandShape, QueryShape, StreamShape } from "#operation.ts";
5
5
  import type { OperationRpc } from "#operationRpc.ts";
6
6
  import { ReadPolicyGuard } from "#ReadPolicyGuard.ts";
7
7
  import { QueryReadDenied } from "#readPolicyErrors.ts";
8
- import { changesRpc, KeyScope, operationAnnotations } from "#serverMetadata.ts";
8
+ import { changesRpc, operationAnnotations } from "#serverMetadata.ts";
9
9
  import type { SubjectDeclaration, WithSubject } from "#subject.ts";
10
10
  import { subjectMiddleware } from "#subjectMiddleware.ts";
11
11
 
@@ -67,9 +67,12 @@ function withDeclaration(group: Group, application: Group, declaration: AnyDecla
67
67
  });
68
68
  }
69
69
 
70
+ // A host refuses a query without a read policy, so a contract written for the host requires one; only the browser's contract has none.
71
+ type PolicedQuery = QueryShape & { readonly readPolicy: NonNullable<QueryShape["readPolicy"]> };
72
+
70
73
  export function contract<
71
74
  const TName extends string,
72
- const TQueries extends readonly QueryShape[] = readonly [],
75
+ const TQueries extends readonly PolicedQuery[] = readonly [],
73
76
  const TCommands extends readonly CommandShape[] = readonly [],
74
77
  const TStreams extends readonly StreamShape[] = readonly [],
75
78
  const TScope extends "session" | undefined = undefined,
@@ -95,17 +98,21 @@ export function contract<
95
98
  TStreams,
96
99
  TScope
97
100
  >;
98
- export function contract(
99
- name: string,
100
- operations: {
101
- readonly keyScope?: "session";
102
- readonly subject?: SubjectDeclaration;
103
- readonly queries?: readonly QueryShape[];
104
- readonly commands?: readonly CommandShape[];
105
- readonly streams?: readonly StreamShape[];
106
- },
107
- ): DeclaredGroup {
108
- const { queries = [], commands = [], streams = [], keyScope } = operations;
101
+ export function contract(name: string, operations: Operations): DeclaredGroup {
102
+ return declaredGroup(name, operations);
103
+ }
104
+
105
+ interface Operations {
106
+ readonly annotations?: Context.Context<never>;
107
+ readonly commands?: readonly CommandShape[];
108
+ readonly keyScope?: "session";
109
+ readonly queries?: readonly QueryShape[];
110
+ readonly streams?: readonly StreamShape[];
111
+ readonly subject?: SubjectDeclaration;
112
+ }
113
+
114
+ export function declaredGroup(name: string, operations: Operations): DeclaredGroup {
115
+ const { queries = [], commands = [], streams = [], keyScope, annotations = Context.empty() } = operations;
109
116
  const error = assertValid(name, [...queries, ...commands, ...streams]);
110
117
  const rpcs = [...queries, ...commands, ...streams].map((operation) => {
111
118
  const rpc = Rpc.make(`${name}.${operation.name}`, {
@@ -113,14 +120,14 @@ export function contract(
113
120
  payload: operation.payload,
114
121
  stream: operation.kind === "stream",
115
122
  success: operation.success,
116
- }).annotateMerge(operationAnnotations(operation, keyScope));
123
+ }).annotateMerge(Context.merge(operationAnnotations(operation), annotations));
117
124
  const guarded = operation.kind === "query" ? rpc.middleware(ReadPolicyGuard) : rpc;
118
125
  return operations.subject === undefined ? guarded : guarded.middleware(subjectMiddleware(`${name}.${operation.name}`, operations.subject));
119
126
  });
120
127
  const application = RpcGroup.make(...rpcs);
121
- const changes = changesRpc(name, queries).middleware(ReadPolicyGuard);
128
+ const changes = changesRpc(name, queries).annotateMerge(annotations).middleware(ReadPolicyGuard);
122
129
  const subjectChanges = operations.subject === undefined ? changes : changes.middleware(subjectMiddleware(`${name}.$changes`, operations.subject));
123
- const built = application.add(keyScope === undefined ? subjectChanges : subjectChanges.annotate(KeyScope, keyScope));
130
+ const built = application.add(subjectChanges);
124
131
  const group = error === undefined ? built : built.annotate(DeclarationError, error);
125
132
  return withDeclaration(group, application, {
126
133
  commands,