@shivaedev/contract 0.43.5 → 0.44.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 (122) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/README.md +262 -44
  3. package/dist/adapters/servedHandlers.d.ts +8 -0
  4. package/dist/adapters/servedHandlers.d.ts.map +1 -0
  5. package/dist/adapters/servedHandlers.js +51 -0
  6. package/dist/adapters/servedHandlers.js.map +1 -0
  7. package/dist/automaticQuery.js +1 -1
  8. package/dist/automaticQuery.js.map +1 -1
  9. package/dist/clientActivity.d.ts +0 -2
  10. package/dist/clientActivity.d.ts.map +1 -1
  11. package/dist/clientActivity.js +1 -1
  12. package/dist/clientActivity.js.map +1 -1
  13. package/dist/clientContract.d.ts +51 -0
  14. package/dist/clientContract.d.ts.map +1 -0
  15. package/dist/clientContract.js +32 -0
  16. package/dist/clientContract.js.map +1 -0
  17. package/dist/clientMatchesModule.d.ts +18 -0
  18. package/dist/clientMatchesModule.d.ts.map +1 -0
  19. package/dist/clientMatchesModule.js +2 -0
  20. package/dist/clientMatchesModule.js.map +1 -0
  21. package/dist/contract.d.ts +23 -1
  22. package/dist/contract.d.ts.map +1 -1
  23. package/dist/contract.js +9 -6
  24. package/dist/contract.js.map +1 -1
  25. package/dist/declarationError.d.ts +1 -2
  26. package/dist/declarationError.d.ts.map +1 -1
  27. package/dist/declarationError.js +3 -1
  28. package/dist/declarationError.js.map +1 -1
  29. package/dist/defineModule.d.ts +41 -0
  30. package/dist/defineModule.d.ts.map +1 -0
  31. package/dist/defineModule.js +17 -0
  32. package/dist/defineModule.js.map +1 -0
  33. package/dist/live-server/subscribe.d.ts.map +1 -1
  34. package/dist/live-server/subscribe.js +64 -6
  35. package/dist/live-server/subscribe.js.map +1 -1
  36. package/dist/live.d.ts +1 -0
  37. package/dist/live.d.ts.map +1 -1
  38. package/dist/live.js +5 -0
  39. package/dist/live.js.map +1 -1
  40. package/dist/liveAnswers.d.ts +9 -0
  41. package/dist/liveAnswers.d.ts.map +1 -0
  42. package/dist/liveAnswers.js +12 -0
  43. package/dist/liveAnswers.js.map +1 -0
  44. package/dist/moduleHandlers.d.ts +15 -0
  45. package/dist/moduleHandlers.d.ts.map +1 -0
  46. package/dist/moduleHandlers.js +5 -0
  47. package/dist/moduleHandlers.js.map +1 -0
  48. package/dist/moduleProof.d.ts +79 -0
  49. package/dist/moduleProof.d.ts.map +1 -0
  50. package/dist/moduleProof.js +2 -0
  51. package/dist/moduleProof.js.map +1 -0
  52. package/dist/operation.d.ts +14 -12
  53. package/dist/operation.d.ts.map +1 -1
  54. package/dist/operation.js +10 -4
  55. package/dist/operation.js.map +1 -1
  56. package/dist/operationDeclaration.d.ts +9 -1
  57. package/dist/operationDeclaration.d.ts.map +1 -1
  58. package/dist/operationDeclaration.js.map +1 -1
  59. package/dist/queryDelivery.js +1 -1
  60. package/dist/queryDelivery.js.map +1 -1
  61. package/dist/querySubscription.d.ts +1 -1
  62. package/dist/querySubscription.d.ts.map +1 -1
  63. package/dist/querySubscription.js +6 -4
  64. package/dist/querySubscription.js.map +1 -1
  65. package/dist/readPolicy.d.ts +2 -1
  66. package/dist/readPolicy.d.ts.map +1 -1
  67. package/dist/readPolicy.js +9 -5
  68. package/dist/readPolicy.js.map +1 -1
  69. package/dist/retainQuery.d.ts +1 -0
  70. package/dist/retainQuery.d.ts.map +1 -1
  71. package/dist/retainQuery.js +5 -0
  72. package/dist/retainQuery.js.map +1 -1
  73. package/dist/runProof.d.ts +69 -0
  74. package/dist/runProof.d.ts.map +1 -0
  75. package/dist/runProof.js +2 -0
  76. package/dist/runProof.js.map +1 -0
  77. package/dist/servedOperation.d.ts +72 -0
  78. package/dist/servedOperation.d.ts.map +1 -0
  79. package/dist/servedOperation.js +11 -0
  80. package/dist/servedOperation.js.map +1 -0
  81. package/dist/servedReadPolicy.d.ts +11 -0
  82. package/dist/servedReadPolicy.d.ts.map +1 -0
  83. package/dist/servedReadPolicy.js +9 -0
  84. package/dist/servedReadPolicy.js.map +1 -0
  85. package/dist/serverMetadata.d.ts +1 -4
  86. package/dist/serverMetadata.d.ts.map +1 -1
  87. package/dist/serverMetadata.js +3 -6
  88. package/dist/serverMetadata.js.map +1 -1
  89. package/dist/successProof.d.ts +51 -0
  90. package/dist/successProof.d.ts.map +1 -0
  91. package/dist/successProof.js +2 -0
  92. package/dist/successProof.js.map +1 -0
  93. package/dist/wire.d.ts +25 -0
  94. package/dist/wire.d.ts.map +1 -0
  95. package/dist/wire.js +13 -0
  96. package/dist/wire.js.map +1 -0
  97. package/package.json +16 -16
  98. package/src/adapters/servedHandlers.ts +69 -0
  99. package/src/automaticQuery.ts +1 -1
  100. package/src/clientActivity.ts +1 -1
  101. package/src/clientContract.ts +128 -0
  102. package/src/clientMatchesModule.ts +24 -0
  103. package/src/contract.ts +24 -17
  104. package/src/declarationError.ts +5 -2
  105. package/src/defineModule.ts +112 -0
  106. package/src/live-server/subscribe.ts +74 -6
  107. package/src/live.ts +7 -0
  108. package/src/liveAnswers.ts +13 -0
  109. package/src/moduleHandlers.ts +23 -0
  110. package/src/moduleProof.ts +101 -0
  111. package/src/operation.ts +47 -33
  112. package/src/operationDeclaration.ts +19 -1
  113. package/src/queryDelivery.ts +1 -1
  114. package/src/querySubscription.ts +6 -4
  115. package/src/readPolicy.ts +15 -5
  116. package/src/retainQuery.ts +7 -0
  117. package/src/runProof.ts +96 -0
  118. package/src/servedOperation.ts +145 -0
  119. package/src/servedReadPolicy.ts +19 -0
  120. package/src/serverMetadata.ts +3 -6
  121. package/src/successProof.ts +120 -0
  122. package/src/wire.ts +45 -0
@@ -24,8 +24,6 @@ export class CommandInvalidation extends Context.Service<CommandInvalidation, {
24
24
  "@shivaedev/contract/CommandInvalidation",
25
25
  ) {}
26
26
 
27
- export class KeyScope extends Context.Service<KeyScope, "session">()("@shivaedev/contract/KeyScope") {}
28
-
29
27
  export interface QueryReference {
30
28
  readonly payload: unknown;
31
29
  readonly query: string;
@@ -66,10 +64,9 @@ export function changesRpc(name: string, queries: readonly QueryShape[]) {
66
64
  }).annotate(ChangesQueries, { queries, resolve: (references) => resolveQueries(queries, references) });
67
65
  }
68
66
 
69
- export function operationAnnotations(operation: QueryShape | CommandShape | StreamShape, keyScope: "session" | undefined) {
70
- const scope = keyScope === undefined ? Context.empty() : Context.make(KeyScope, keyScope);
67
+ export function operationAnnotations(operation: QueryShape | CommandShape | StreamShape) {
71
68
  if (operation.kind === "command") {
72
- return Context.add(scope, CommandInvalidation, { invalidates: operation.invalidates });
69
+ return Context.make(CommandInvalidation, { invalidates: operation.invalidates });
73
70
  }
74
- return operation.kind === "query" ? Context.add(scope, QueryDefinition, { definition: operation }) : scope;
71
+ return operation.kind === "query" ? Context.make(QueryDefinition, { definition: operation }) : Context.empty();
75
72
  }
@@ -0,0 +1,120 @@
1
+ import type { Option, Schema } from "effect";
2
+
3
+ export interface SuccessDiffersFromRun<TOperation extends string, TRun, TDeclared> {
4
+ readonly operation: TOperation;
5
+ readonly runReturns: TRun;
6
+ readonly successDeclares: TDeclared;
7
+ }
8
+
9
+ export interface ArrayMutabilityDiffers<TOperation extends string, TFix extends string> {
10
+ readonly fix: TFix;
11
+ readonly operation: TOperation;
12
+ }
13
+
14
+ export interface SuccessClassNotReturned<TOperation extends string, TRun, TClass> {
15
+ readonly operation: TOperation;
16
+ readonly runReturns: TRun;
17
+ readonly successClass: TClass;
18
+ }
19
+
20
+ type Same<TLeft, TRight> = [TLeft] extends [TRight] ? ([TRight] extends [TLeft] ? true : false) : false;
21
+ export type Identical<TLeft, TRight> = (<T>() => T extends TLeft ? 1 : 2) extends <T>() => T extends TRight ? 1 : 2 ? true : false;
22
+ type ReadonlyArrays<T> = T extends readonly (infer TItem)[]
23
+ ? readonly ReadonlyArrays<TItem>[]
24
+ : T extends (...args: never) => unknown
25
+ ? T
26
+ : T extends object
27
+ ? { readonly [TKey in keyof T]: ReadonlyArrays<T[TKey]> }
28
+ : T;
29
+
30
+ type Fields<TName extends string, TFields, TReturn> = {
31
+ readonly [TKey in keyof TFields]: NotEncodedAsReturned<TName, TFields[TKey], TKey extends keyof TReturn ? TReturn[TKey] : never>;
32
+ }[keyof TFields];
33
+
34
+ type Elements<TName extends string, TElements extends readonly unknown[], TReturn> = {
35
+ readonly [TIndex in keyof TElements]: NotEncodedAsReturned<TName, TElements[TIndex], TIndex extends keyof TReturn ? TReturn[TIndex] : never>;
36
+ }[number];
37
+
38
+ type Members<TName extends string, TMembers extends readonly unknown[], TReturn> = {
39
+ readonly [TIndex in keyof TMembers]: TMembers[TIndex] extends Schema.Top
40
+ ? NotEncodedAsReturned<TName, TMembers[TIndex], Extract<TReturn, TMembers[TIndex]["Type"]>>
41
+ : never;
42
+ }[number];
43
+
44
+ type Matches<TReturn, TMembers extends readonly unknown[]> = true extends {
45
+ readonly [TIndex in keyof TMembers]: TMembers[TIndex] extends Schema.Top ? (TReturn extends TMembers[TIndex]["Type"] ? true : false) : false;
46
+ }[number]
47
+ ? true
48
+ : false;
49
+
50
+ type Covered<TName extends string, TMembers extends readonly unknown[], TReturn> = {
51
+ readonly [TIndex in keyof TMembers]: TMembers[TIndex] extends Schema.Struct<infer TFields>
52
+ ? Schema.Struct<TFields>["Type"] extends TReturn
53
+ ? { readonly fields: Fields<TName, TFields, TReturn>; readonly type: Schema.Struct<TFields>["Type"] }
54
+ : never
55
+ : never;
56
+ }[number];
57
+
58
+ // A returned member whose discriminant is itself a union extends no single member, so it is compared with the members it covers.
59
+ type Unmatched<TName extends string, TMembers extends readonly unknown[], TReturn> = TReturn extends unknown
60
+ ? Matches<TReturn, TMembers> extends true
61
+ ? never
62
+ : Covered<TName, TMembers, TReturn> extends infer TCovered extends { readonly fields: unknown; readonly type: unknown }
63
+ ? [TCovered] extends [never]
64
+ ? never
65
+ : TCovered["fields"] | KeysDiffer<TName, TCovered["type"], TReturn>
66
+ : never
67
+ : never;
68
+
69
+ type InCollection<TName extends string, TSchema, TReturn> =
70
+ TSchema extends Schema.Union<infer TMembers>
71
+ ? Members<TName, TMembers, TReturn> | Unmatched<TName, TMembers, TReturn>
72
+ : TSchema extends Schema.$Record<infer _TKey, infer TValue>
73
+ ? NotEncodedAsReturned<TName, TValue, TReturn[keyof TReturn]>
74
+ : TSchema extends Schema.Option<infer TValue>
75
+ ? NotEncodedAsReturned<TName, TValue, TReturn extends Option.Option<infer TReturned> ? TReturned : never>
76
+ : never;
77
+
78
+ type KeysOf<T> = T extends unknown ? keyof T : never;
79
+
80
+ type KeysDiffer<TName extends string, TType, TReturn> = [TReturn] extends [never]
81
+ ? never
82
+ : Same<KeysOf<TType>, KeysOf<TReturn>> extends true
83
+ ? never
84
+ : SuccessDiffersFromRun<TName, TReturn, TType>;
85
+
86
+ type InComposite<TName extends string, TSchema, TReturn> =
87
+ TSchema extends Schema.Struct<infer TFields>
88
+ ? Fields<TName, TFields, TReturn> | KeysDiffer<TName, Schema.Struct<TFields>["Type"], TReturn>
89
+ : TSchema extends Schema.Tuple<infer TElements>
90
+ ? Elements<TName, TElements, TReturn>
91
+ : InCollection<TName, TSchema, TReturn>;
92
+
93
+ type InContainer<TName extends string, TSchema, TReturn> = TSchema extends Schema.$Array<infer TItem> | Schema.NonEmptyArray<infer TItem>
94
+ ? NotEncodedAsReturned<TName, TItem, TReturn extends readonly (infer TReturned)[] ? TReturned : never>
95
+ : TSchema extends Schema.mutable<infer TInner>
96
+ ? NotEncodedAsReturned<TName, TInner, TReturn>
97
+ : TSchema extends Schema.mutableKey<infer TInner>
98
+ ? NotEncodedAsReturned<TName, TInner, TReturn>
99
+ : TSchema extends Schema.optionalKey<infer TInner>
100
+ ? NotEncodedAsReturned<TName, TInner, Exclude<TReturn, undefined>>
101
+ : InComposite<TName, TSchema, TReturn>;
102
+
103
+ // Mutual assignability passed, yet encoding still depends on what each position holds: a class position must carry exactly
104
+ // that class, or encoding it fails, and a struct position exactly its keys, since an optional key may sit on one side only.
105
+ type NotEncodedAsReturned<TName extends string, TSchema, TReturn> =
106
+ TSchema extends Schema.Class<infer TClass, infer _TStruct, infer _TInherited>
107
+ ? Identical<TClass, TReturn> extends true
108
+ ? never
109
+ : SuccessClassNotReturned<TName, TReturn, TClass>
110
+ : InContainer<TName, TSchema, TReturn>;
111
+
112
+ export type SuccessProblem<TName extends string, TSuccess, TReturn> = TSuccess extends Schema.Top
113
+ ? Same<TSuccess["Type"], TReturn> extends true
114
+ ? NotEncodedAsReturned<TName, TSuccess, TReturn>
115
+ : TSuccess extends Schema.Class<infer TClass, infer _TStruct, infer _TInherited>
116
+ ? SuccessClassNotReturned<TName, TReturn, TClass>
117
+ : Same<ReadonlyArrays<TSuccess["Type"]>, ReadonlyArrays<TReturn>> extends true
118
+ ? ArrayMutabilityDiffers<TName, "return a readonly array, or declare Schema.mutable for a mutable one">
119
+ : SuccessDiffersFromRun<TName, TReturn, TSuccess["Type"]>
120
+ : never;
package/src/wire.ts ADDED
@@ -0,0 +1,45 @@
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 { rejectionSet } from "#rejection.ts";
5
+ import type { ClassRejections, SpecsOf } from "#runProof.ts";
6
+ import type { ServedCommand, ServedQuery } from "#servedOperation.ts";
7
+
8
+ // The schemas an operation's run implies, as values: types are erased, so the server encodes and the browser decodes with these.
9
+ export interface WireEntry {
10
+ readonly rejections: ClassRejections;
11
+ readonly success: Schema.Top;
12
+ }
13
+
14
+ export interface Wire {
15
+ readonly [operation: string]: WireEntry;
16
+ }
17
+
18
+ export type WireEntryOf<TWire, TName> = TName extends keyof TWire ? (TWire[TName] extends WireEntry ? TWire[TName] : undefined) : undefined;
19
+
20
+ export type Wired<TOperation, TEntry> = TEntry extends WireEntry
21
+ ? TOperation extends ServedQuery<infer TName, infer TPayload, infer _TSuccess, infer _TSpecs, infer TPolicyError, infer TPolicyServices, infer TRun>
22
+ ? ServedQuery<TName, TPayload, TEntry["success"], SpecsOf<TEntry["rejections"]>, TPolicyError, TPolicyServices, TRun>
23
+ : TOperation extends ServedCommand<infer TName, infer TPayload, infer _TSuccess, infer _TSpecs, infer TRun>
24
+ ? ServedCommand<TName, TPayload, TEntry["success"], SpecsOf<TEntry["rejections"]>, TRun>
25
+ : TOperation
26
+ : TOperation;
27
+
28
+ export type WiredAll<TOperations extends readonly unknown[], TWire> = {
29
+ readonly [TIndex in keyof TOperations]: Wired<
30
+ TOperations[TIndex],
31
+ WireEntryOf<TWire, TOperations[TIndex] extends { readonly name: infer TName } ? TName : never>
32
+ >;
33
+ };
34
+
35
+ export function wireRejections(rejections: ClassRejections) {
36
+ return { ...rejections, InternalServerError, ServiceUnavailable };
37
+ }
38
+
39
+ export function wired(operation: QueryShape | CommandShape, entry: WireEntry | undefined): QueryShape | CommandShape {
40
+ if (entry === undefined) {
41
+ return operation;
42
+ }
43
+ const rejections = wireRejections(entry.rejections);
44
+ return { ...operation, rejections, success: entry.success, ...rejectionSet(rejections) };
45
+ }