@atiproto/lexicons 1.0.0 → 2.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/dist/index.d.ts +1 -1
  2. package/dist/index.js +3459 -2459
  3. package/dist/index.js.map +1 -1
  4. package/dist/index.mjs +3456 -2459
  5. package/dist/index.mjs.map +1 -1
  6. package/dist/lexicons/com/atiproto/authCreateCart.d.ts +2 -0
  7. package/dist/lexicons/com/atiproto/authCreateCart.defs.d.ts +5 -0
  8. package/dist/lexicons/com/atiproto/authCreatePayment.d.ts +2 -0
  9. package/dist/lexicons/com/atiproto/authCreatePayment.defs.d.ts +5 -0
  10. package/dist/lexicons/com/atiproto/authReadCart.d.ts +2 -0
  11. package/dist/lexicons/com/atiproto/authReadCart.defs.d.ts +5 -0
  12. package/dist/lexicons/com/atiproto/authReadEntitlements.d.ts +2 -0
  13. package/dist/lexicons/com/atiproto/authReadEntitlements.defs.d.ts +5 -0
  14. package/dist/lexicons/com/atiproto/authReadPayments.d.ts +2 -0
  15. package/dist/lexicons/com/atiproto/authReadPayments.defs.d.ts +5 -0
  16. package/dist/lexicons/com/atiproto/authReadPublic.d.ts +2 -0
  17. package/dist/lexicons/com/atiproto/authReadPublic.defs.d.ts +5 -0
  18. package/dist/lexicons/com/atiproto/authReadRecipient.d.ts +2 -0
  19. package/dist/lexicons/com/atiproto/authReadRecipient.defs.d.ts +5 -0
  20. package/dist/lexicons/com/atiproto/authWriteProfile.d.ts +2 -0
  21. package/dist/lexicons/com/atiproto/authWriteProfile.defs.d.ts +5 -0
  22. package/dist/lexicons/com/atiproto/cart.defs.d.ts +277 -112
  23. package/dist/lexicons/com/atiproto/item.defs.d.ts +97 -202
  24. package/dist/lexicons/com/atiproto/payment/cart/checkout.d.ts +2 -0
  25. package/dist/lexicons/com/atiproto/payment/cart/checkout.defs.d.ts +69 -0
  26. package/dist/lexicons/com/atiproto/payment/cart/create.defs.d.ts +11 -21
  27. package/dist/lexicons/com/atiproto/payment/cart/get.defs.d.ts +7 -39
  28. package/dist/lexicons/com/atiproto/payment/cart/list.defs.d.ts +17 -20
  29. package/dist/lexicons/com/atiproto/payment/cart/put.defs.d.ts +3 -13
  30. package/dist/lexicons/com/atiproto/payment/cart.d.ts +1 -1
  31. package/dist/lexicons/com/atiproto/payment/item/create.defs.d.ts +19 -53
  32. package/dist/lexicons/com/atiproto/payment/item/get.defs.d.ts +5 -17
  33. package/dist/lexicons/com/atiproto/payment/item/list.defs.d.ts +1 -7
  34. package/dist/lexicons/com/atiproto/payment/item/put.defs.d.ts +1 -1
  35. package/dist/lexicons/com/atiproto/payment/item.d.ts +0 -1
  36. package/dist/lexicons/com/atiproto/payment/subscription/cancel.defs.d.ts +1 -7
  37. package/dist/lexicons/com/atiproto/payment/subscription/create.defs.d.ts +22 -45
  38. package/dist/lexicons/com/atiproto/payment/subscription/get.defs.d.ts +5 -11
  39. package/dist/lexicons/com/atiproto/payment/subscription/list.defs.d.ts +7 -1
  40. package/dist/lexicons/com/atiproto/payment/subscription/put.defs.d.ts +1 -1
  41. package/dist/lexicons/com/atiproto/payment/subscription.d.ts +0 -1
  42. package/dist/lexicons/com/atiproto/payment.d.ts +0 -1
  43. package/dist/lexicons/com/atiproto/profile.defs.d.ts +26 -143
  44. package/dist/lexicons/com/atiproto/recipient/payment/cart/get.defs.d.ts +7 -33
  45. package/dist/lexicons/com/atiproto/recipient/payment/cart/list.defs.d.ts +23 -20
  46. package/dist/lexicons/com/atiproto/recipient/payment/item/get.defs.d.ts +5 -17
  47. package/dist/lexicons/com/atiproto/recipient/payment/item/list.defs.d.ts +3 -3
  48. package/dist/lexicons/com/atiproto/recipient/payment/item.d.ts +0 -1
  49. package/dist/lexicons/com/atiproto/recipient/payment/subscription/get.defs.d.ts +5 -11
  50. package/dist/lexicons/com/atiproto/recipient/payment/subscription/list.defs.d.ts +13 -1
  51. package/dist/lexicons/com/atiproto/recipient/payment/subscription.d.ts +0 -1
  52. package/dist/lexicons/com/atiproto/recipient/profile/get.defs.d.ts +39 -19
  53. package/dist/lexicons/com/atiproto/repo/item/count.defs.d.ts +3 -9
  54. package/dist/lexicons/com/atiproto/repo/profile/get.defs.d.ts +6 -0
  55. package/dist/lexicons/com/atiproto/repo/subscription/count.defs.d.ts +5 -5
  56. package/dist/lexicons/com/atiproto/subscription.defs.d.ts +90 -157
  57. package/dist/lexicons/com/atiproto.d.ts +8 -2
  58. package/dist/lexicons/com/atproto/repo/strongRef.d.ts +2 -0
  59. package/dist/lexicons/com/atproto/repo/strongRef.defs.d.ts +56 -0
  60. package/dist/lexicons/com/atproto/repo.d.ts +1 -0
  61. package/dist/lexicons/com/atproto.d.ts +1 -0
  62. package/dist/lexicons/com.d.ts +1 -0
  63. package/dist/lexicons/index.d.ts +1 -0
  64. package/dist/lexicons/network/attested/entitlement.d.ts +2 -0
  65. package/dist/lexicons/network/attested/entitlement.defs.d.ts +185 -0
  66. package/dist/lexicons/network/attested/payment/initiate.d.ts +2 -0
  67. package/dist/lexicons/network/attested/payment/initiate.defs.d.ts +102 -0
  68. package/dist/lexicons/network/attested/payment/status.d.ts +2 -0
  69. package/dist/lexicons/network/attested/payment/status.defs.d.ts +56 -0
  70. package/dist/lexicons/network/attested/payment.d.ts +4 -0
  71. package/dist/lexicons/network/attested/payment.defs.d.ts +156 -0
  72. package/dist/lexicons/network/attested/proof.d.ts +2 -0
  73. package/dist/lexicons/network/attested/proof.defs.d.ts +172 -0
  74. package/dist/lexicons/network/attested/signature.d.ts +2 -0
  75. package/dist/lexicons/network/attested/signature.defs.d.ts +230 -0
  76. package/dist/lexicons/network/attested/verify.d.ts +2 -0
  77. package/dist/lexicons/network/attested/verify.defs.d.ts +41 -0
  78. package/dist/lexicons/network/attested.d.ts +5 -0
  79. package/dist/lexicons/network.d.ts +1 -0
  80. package/dist/schemas.d.ts +2 -0
  81. package/package.json +6 -2
  82. package/dist/lexicons/com/atiproto/payment/cart/clone.d.ts +0 -2
  83. package/dist/lexicons/com/atiproto/payment/cart/clone.defs.d.ts +0 -54
  84. package/dist/lexicons/com/atiproto/payment/item/validate.d.ts +0 -2
  85. package/dist/lexicons/com/atiproto/payment/item/validate.defs.d.ts +0 -50
  86. package/dist/lexicons/com/atiproto/payment/list.d.ts +0 -2
  87. package/dist/lexicons/com/atiproto/payment/list.defs.d.ts +0 -32
  88. package/dist/lexicons/com/atiproto/payment/subscription/validate.d.ts +0 -2
  89. package/dist/lexicons/com/atiproto/payment/subscription/validate.defs.d.ts +0 -44
  90. package/dist/lexicons/com/atiproto/recipient/payment/item/validate.d.ts +0 -2
  91. package/dist/lexicons/com/atiproto/recipient/payment/item/validate.defs.d.ts +0 -50
  92. package/dist/lexicons/com/atiproto/recipient/payment/subscription/validate.d.ts +0 -2
  93. package/dist/lexicons/com/atiproto/recipient/payment/subscription/validate.defs.d.ts +0 -44
@@ -1,32 +1,20 @@
1
1
  import { l } from '@atproto/lex';
2
2
  declare const $nsid = "com.atiproto.profile";
3
3
  export { $nsid };
4
- /** A record representing a user's tipping/subscription settings */
5
4
  type Main = {
6
5
  $type: 'com.atiproto.profile';
7
6
  /**
8
- * Whether user accepts items (default: true)
7
+ * Whether the user accepts one-time items (default: true).
9
8
  */
10
9
  acceptsItems?: boolean;
11
10
  /**
12
- * Whether user accepts subscriptions (default: true)
11
+ * Whether the user accepts subscriptions (default: true).
13
12
  */
14
13
  acceptsSubscriptions?: boolean;
15
- /**
16
- * Opt out of payment receipt DMs (default: false)
17
- */
18
- disableReceiptNotifications?: boolean;
19
- /**
20
- * Creation timestamp
21
- */
22
14
  createdAt: l.DatetimeString;
23
- /**
24
- * Last update timestamp
25
- */
26
15
  updatedAt?: l.DatetimeString;
27
16
  };
28
17
  export type { Main };
29
- /** A record representing a user's tipping/subscription settings */
30
18
  declare const main: l.RecordSchema<"literal:self", "com.atiproto.profile", l.Validator<Omit<Main, "$type">, Omit<Main, "$type">>>;
31
19
  export { main };
32
20
  export declare const $isTypeOf: <TValue extends {
@@ -36,19 +24,10 @@ export declare const $isTypeOf: <TValue extends {
36
24
  createdAt: l.DatetimeString;
37
25
  acceptsItems?: boolean
38
26
  /**
39
- * Whether user accepts subscriptions (default: true)
40
- */
41
- | undefined;
42
- acceptsSubscriptions?: boolean
43
- /**
44
- * Opt out of payment receipt DMs (default: false)
45
- */
46
- | undefined;
47
- disableReceiptNotifications?: boolean
48
- /**
49
- * Creation timestamp
27
+ * Whether the user accepts subscriptions (default: true).
50
28
  */
51
29
  | undefined;
30
+ acceptsSubscriptions?: boolean | undefined;
52
31
  updatedAt?: l.DatetimeString | undefined;
53
32
  $type: "com.atiproto.profile";
54
33
  };
@@ -56,19 +35,10 @@ export declare const $isTypeOf: <TValue extends {
56
35
  createdAt: l.DatetimeString;
57
36
  acceptsItems?: boolean
58
37
  /**
59
- * Whether user accepts subscriptions (default: true)
60
- */
61
- | undefined;
62
- acceptsSubscriptions?: boolean
63
- /**
64
- * Opt out of payment receipt DMs (default: false)
65
- */
66
- | undefined;
67
- disableReceiptNotifications?: boolean
68
- /**
69
- * Creation timestamp
38
+ * Whether the user accepts subscriptions (default: true).
70
39
  */
71
40
  | undefined;
41
+ acceptsSubscriptions?: boolean | undefined;
72
42
  updatedAt?: l.DatetimeString | undefined;
73
43
  $type: "com.atiproto.profile";
74
44
  };
@@ -77,184 +47,97 @@ export declare const $assert: (input: unknown, options?: l.ValidateOptions) => a
77
47
  createdAt: l.DatetimeString;
78
48
  acceptsItems?: boolean
79
49
  /**
80
- * Whether user accepts subscriptions (default: true)
81
- */
82
- | undefined;
83
- acceptsSubscriptions?: boolean
84
- /**
85
- * Opt out of payment receipt DMs (default: false)
86
- */
87
- | undefined;
88
- disableReceiptNotifications?: boolean
89
- /**
90
- * Creation timestamp
50
+ * Whether the user accepts subscriptions (default: true).
91
51
  */
92
52
  | undefined;
53
+ acceptsSubscriptions?: boolean | undefined;
93
54
  updatedAt?: l.DatetimeString | undefined;
94
55
  $type: "com.atiproto.profile";
95
56
  }, $check: (input: unknown, options?: l.ValidateOptions) => void, $cast: <I>(input: I, options?: l.ValidateOptions) => I & {
96
57
  createdAt: l.DatetimeString;
97
58
  acceptsItems?: boolean
98
59
  /**
99
- * Whether user accepts subscriptions (default: true)
100
- */
101
- | undefined;
102
- acceptsSubscriptions?: boolean
103
- /**
104
- * Opt out of payment receipt DMs (default: false)
105
- */
106
- | undefined;
107
- disableReceiptNotifications?: boolean
108
- /**
109
- * Creation timestamp
60
+ * Whether the user accepts subscriptions (default: true).
110
61
  */
111
62
  | undefined;
63
+ acceptsSubscriptions?: boolean | undefined;
112
64
  updatedAt?: l.DatetimeString | undefined;
113
65
  $type: "com.atiproto.profile";
114
66
  }, $ifMatches: <I>(input: I, options?: l.ValidateOptions) => (I & {
115
67
  createdAt: l.DatetimeString;
116
68
  acceptsItems?: boolean
117
69
  /**
118
- * Whether user accepts subscriptions (default: true)
119
- */
120
- | undefined;
121
- acceptsSubscriptions?: boolean
122
- /**
123
- * Opt out of payment receipt DMs (default: false)
124
- */
125
- | undefined;
126
- disableReceiptNotifications?: boolean
127
- /**
128
- * Creation timestamp
70
+ * Whether the user accepts subscriptions (default: true).
129
71
  */
130
72
  | undefined;
73
+ acceptsSubscriptions?: boolean | undefined;
131
74
  updatedAt?: l.DatetimeString | undefined;
132
75
  $type: "com.atiproto.profile";
133
76
  }) | undefined, $matches: <I>(input: I, options?: l.ValidateOptions) => input is I & {
134
77
  createdAt: l.DatetimeString;
135
78
  acceptsItems?: boolean
136
79
  /**
137
- * Whether user accepts subscriptions (default: true)
138
- */
139
- | undefined;
140
- acceptsSubscriptions?: boolean
141
- /**
142
- * Opt out of payment receipt DMs (default: false)
143
- */
144
- | undefined;
145
- disableReceiptNotifications?: boolean
146
- /**
147
- * Creation timestamp
80
+ * Whether the user accepts subscriptions (default: true).
148
81
  */
149
82
  | undefined;
83
+ acceptsSubscriptions?: boolean | undefined;
150
84
  updatedAt?: l.DatetimeString | undefined;
151
85
  $type: "com.atiproto.profile";
152
86
  }, $parse: (input: unknown, options?: l.ParseOptions) => {
153
87
  createdAt: l.DatetimeString;
154
88
  acceptsItems?: boolean
155
89
  /**
156
- * Whether user accepts subscriptions (default: true)
157
- */
158
- | undefined;
159
- acceptsSubscriptions?: boolean
160
- /**
161
- * Opt out of payment receipt DMs (default: false)
162
- */
163
- | undefined;
164
- disableReceiptNotifications?: boolean
165
- /**
166
- * Creation timestamp
90
+ * Whether the user accepts subscriptions (default: true).
167
91
  */
168
92
  | undefined;
93
+ acceptsSubscriptions?: boolean | undefined;
169
94
  updatedAt?: l.DatetimeString | undefined;
170
95
  $type: "com.atiproto.profile";
171
96
  }, $safeParse: (input: unknown, options?: l.ParseOptions) => l.ValidationResult<{
172
97
  createdAt: l.DatetimeString;
173
98
  acceptsItems?: boolean
174
99
  /**
175
- * Whether user accepts subscriptions (default: true)
176
- */
177
- | undefined;
178
- acceptsSubscriptions?: boolean
179
- /**
180
- * Opt out of payment receipt DMs (default: false)
181
- */
182
- | undefined;
183
- disableReceiptNotifications?: boolean
184
- /**
185
- * Creation timestamp
100
+ * Whether the user accepts subscriptions (default: true).
186
101
  */
187
102
  | undefined;
103
+ acceptsSubscriptions?: boolean | undefined;
188
104
  updatedAt?: l.DatetimeString | undefined;
189
105
  $type: "com.atiproto.profile";
190
106
  }>, $validate: <I>(input: I, options?: l.ValidateOptions) => I & {
191
107
  createdAt: l.DatetimeString;
192
108
  acceptsItems?: boolean
193
109
  /**
194
- * Whether user accepts subscriptions (default: true)
195
- */
196
- | undefined;
197
- acceptsSubscriptions?: boolean
198
- /**
199
- * Opt out of payment receipt DMs (default: false)
200
- */
201
- | undefined;
202
- disableReceiptNotifications?: boolean
203
- /**
204
- * Creation timestamp
110
+ * Whether the user accepts subscriptions (default: true).
205
111
  */
206
112
  | undefined;
113
+ acceptsSubscriptions?: boolean | undefined;
207
114
  updatedAt?: l.DatetimeString | undefined;
208
115
  $type: "com.atiproto.profile";
209
116
  }, $safeValidate: <I>(input: I, options?: l.ValidateOptions) => l.ValidationResult<I & {
210
117
  createdAt: l.DatetimeString;
211
118
  acceptsItems?: boolean
212
119
  /**
213
- * Whether user accepts subscriptions (default: true)
214
- */
215
- | undefined;
216
- acceptsSubscriptions?: boolean
217
- /**
218
- * Opt out of payment receipt DMs (default: false)
219
- */
220
- | undefined;
221
- disableReceiptNotifications?: boolean
222
- /**
223
- * Creation timestamp
120
+ * Whether the user accepts subscriptions (default: true).
224
121
  */
225
122
  | undefined;
123
+ acceptsSubscriptions?: boolean | undefined;
226
124
  updatedAt?: l.DatetimeString | undefined;
227
125
  $type: "com.atiproto.profile";
228
126
  }>;
229
- /** View of a user's profile settings for use in API responses */
127
+ /** Profile view for API responses. `brokers` and `acceptingPayments` are server-derived from the user's DID document; they are not stored on the record. */
230
128
  type View = {
231
129
  $type?: 'com.atiproto.profile#view';
232
- /**
233
- * AT-URI of the profile record
234
- */
235
130
  uri: l.AtUriString;
236
- /**
237
- * Whether user accepts items (default: true)
238
- */
239
131
  acceptsItems?: boolean;
240
- /**
241
- * Whether user accepts subscriptions (default: true)
242
- */
243
132
  acceptsSubscriptions?: boolean;
244
133
  /**
245
- * Opt out of payment receipt DMs (default: false)
246
- */
247
- disableReceiptNotifications?: boolean;
248
- /**
249
- * Creation timestamp
134
+ * True when the user's DID document advertises at least one `PaymentBroker` service entry. For v2, the mere presence of a broker is taken as readiness.
250
135
  */
136
+ acceptingPayments?: boolean;
251
137
  createdAt: l.DatetimeString;
252
- /**
253
- * Last update timestamp
254
- */
255
138
  updatedAt?: l.DatetimeString;
256
139
  };
257
140
  export type { View };
258
- /** View of a user's profile settings for use in API responses */
141
+ /** Profile view for API responses. `brokers` and `acceptingPayments` are server-derived from the user's DID document; they are not stored on the record. */
259
142
  declare const view: l.TypedObjectSchema<"com.atiproto.profile#view", l.Validator<View, View>>;
260
143
  export { view };
@@ -4,50 +4,24 @@ import * as AtiprotoItem from '../../../item.defs.js';
4
4
  import * as AtiprotoSubscription from '../../../subscription.defs.js';
5
5
  declare const $nsid = "com.atiproto.recipient.payment.cart.get";
6
6
  export { $nsid };
7
- /** Get a cart that pays the authenticated user — a cart whose items target this user. Look up by cart URI, by a contained item record URI, or by a contained subscription record URI. One of `uri`, `itemUri`, or `subscriptionUri` is required. */
7
+ /** Hydrate an incoming cart by uri (a cart whose items target the authenticated user). Includes the resolved item and subscription records that target this user. */
8
8
  declare const main: l.Query<"com.atiproto.recipient.payment.cart.get", l.ParamsSchema<{
9
- readonly uri: l.OptionalSchema<l.StringSchema<{
10
- readonly format: "at-uri";
11
- }>>;
12
- readonly itemUri: l.OptionalSchema<l.StringSchema<{
13
- readonly format: "at-uri";
14
- }>>;
15
- readonly subscriptionUri: l.OptionalSchema<l.StringSchema<{
16
- readonly format: "at-uri";
17
- }>>;
18
- }>, l.Payload<"application/json", l.ObjectSchema<{
19
- uri: l.StringSchema<{
9
+ readonly uri: l.StringSchema<{
20
10
  readonly format: "at-uri";
21
11
  }>;
22
- cid: l.OptionalSchema<l.StringSchema<{
23
- readonly format: "cid";
24
- }>>;
12
+ }>, l.Payload<"application/json", l.ObjectSchema<{
25
13
  cart: l.RefSchema<l.Validator<AtiprotoCart.View, AtiprotoCart.View>>;
26
- items: l.ArraySchema<l.RefSchema<l.Validator<AtiprotoItem.View, AtiprotoItem.View>>>;
27
- subscriptions: l.ArraySchema<l.RefSchema<l.Validator<AtiprotoSubscription.View, AtiprotoSubscription.View>>>;
14
+ items: l.ArraySchema<l.TypedUnionSchema<readonly [l.TypedRefSchema<l.TypedObjectValidator<AtiprotoItem.View, AtiprotoItem.View>>, l.TypedRefSchema<l.TypedObjectValidator<AtiprotoSubscription.View, AtiprotoSubscription.View>>], false>>;
28
15
  }>>, undefined>;
29
16
  export { main };
30
17
  export type $Params = l.InferMethodParams<typeof main>;
31
18
  export type $Output<B = l.BinaryData> = l.InferMethodOutput<typeof main, B>;
32
19
  export type $OutputBody<B = l.BinaryData> = l.InferMethodOutputBody<typeof main, B>;
33
20
  export declare const $lxm: "com.atiproto.recipient.payment.cart.get", $params: l.ParamsSchema<{
34
- readonly uri: l.OptionalSchema<l.StringSchema<{
35
- readonly format: "at-uri";
36
- }>>;
37
- readonly itemUri: l.OptionalSchema<l.StringSchema<{
38
- readonly format: "at-uri";
39
- }>>;
40
- readonly subscriptionUri: l.OptionalSchema<l.StringSchema<{
41
- readonly format: "at-uri";
42
- }>>;
43
- }>, $output: l.Payload<"application/json", l.ObjectSchema<{
44
- uri: l.StringSchema<{
21
+ readonly uri: l.StringSchema<{
45
22
  readonly format: "at-uri";
46
23
  }>;
47
- cid: l.OptionalSchema<l.StringSchema<{
48
- readonly format: "cid";
49
- }>>;
24
+ }>, $output: l.Payload<"application/json", l.ObjectSchema<{
50
25
  cart: l.RefSchema<l.Validator<AtiprotoCart.View, AtiprotoCart.View>>;
51
- items: l.ArraySchema<l.RefSchema<l.Validator<AtiprotoItem.View, AtiprotoItem.View>>>;
52
- subscriptions: l.ArraySchema<l.RefSchema<l.Validator<AtiprotoSubscription.View, AtiprotoSubscription.View>>>;
26
+ items: l.ArraySchema<l.TypedUnionSchema<readonly [l.TypedRefSchema<l.TypedObjectValidator<AtiprotoItem.View, AtiprotoItem.View>>, l.TypedRefSchema<l.TypedObjectValidator<AtiprotoSubscription.View, AtiprotoSubscription.View>>], false>>;
53
27
  }>>;
@@ -2,18 +2,27 @@ import { l } from '@atproto/lex';
2
2
  import * as AtiprotoCart from '../../../cart.defs.js';
3
3
  declare const $nsid = "com.atiproto.recipient.payment.cart.list";
4
4
  export { $nsid };
5
- /** List carts whose items pay the authenticated user — i.e. carts targeting this user as a payment recipient. Read-only, no PDS writes. */
5
+ /** List carts whose items pay the authenticated user (carts targeting this user as a payment recipient). Read-only, no PDS writes. */
6
6
  declare const main: l.Query<"com.atiproto.recipient.payment.cart.list", l.ParamsSchema<{
7
7
  readonly sender: l.OptionalSchema<l.StringSchema<{
8
8
  readonly format: "did";
9
9
  }>>;
10
- readonly status: l.OptionalSchema<l.EnumSchema<"open" | "completed" | "expired" | "abandoned">>;
10
+ readonly status: l.OptionalSchema<l.StringSchema<{
11
+ maxLength: 64;
12
+ knownValues: ["open", "expired", "abandoned", "pending", "completed", "failed", "refunded", "cancelled", "fulfilled"];
13
+ }>>;
14
+ readonly startDate: l.OptionalSchema<l.StringSchema<{
15
+ readonly format: "datetime";
16
+ }>>;
17
+ readonly endDate: l.OptionalSchema<l.StringSchema<{
18
+ readonly format: "datetime";
19
+ }>>;
11
20
  readonly cursor: l.OptionalSchema<l.StringSchema<{
12
21
  readonly maxLength: 512;
13
22
  }>>;
14
23
  readonly limit: l.OptionalSchema<l.WithDefaultSchema<l.IntegerSchema>>;
15
24
  }>, l.Payload<"application/json", l.ObjectSchema<{
16
- carts: l.ArraySchema<l.RefSchema<l.Validator<CartResponse, CartResponse>>>;
25
+ carts: l.ArraySchema<l.RefSchema<l.Validator<AtiprotoCart.View, AtiprotoCart.View>>>;
17
26
  cursor: l.OptionalSchema<l.StringSchema<{
18
27
  readonly maxLength: 512;
19
28
  }>>;
@@ -26,29 +35,23 @@ export declare const $lxm: "com.atiproto.recipient.payment.cart.list", $params:
26
35
  readonly sender: l.OptionalSchema<l.StringSchema<{
27
36
  readonly format: "did";
28
37
  }>>;
29
- readonly status: l.OptionalSchema<l.EnumSchema<"open" | "completed" | "expired" | "abandoned">>;
38
+ readonly status: l.OptionalSchema<l.StringSchema<{
39
+ maxLength: 64;
40
+ knownValues: ["open", "expired", "abandoned", "pending", "completed", "failed", "refunded", "cancelled", "fulfilled"];
41
+ }>>;
42
+ readonly startDate: l.OptionalSchema<l.StringSchema<{
43
+ readonly format: "datetime";
44
+ }>>;
45
+ readonly endDate: l.OptionalSchema<l.StringSchema<{
46
+ readonly format: "datetime";
47
+ }>>;
30
48
  readonly cursor: l.OptionalSchema<l.StringSchema<{
31
49
  readonly maxLength: 512;
32
50
  }>>;
33
51
  readonly limit: l.OptionalSchema<l.WithDefaultSchema<l.IntegerSchema>>;
34
52
  }>, $output: l.Payload<"application/json", l.ObjectSchema<{
35
- carts: l.ArraySchema<l.RefSchema<l.Validator<CartResponse, CartResponse>>>;
53
+ carts: l.ArraySchema<l.RefSchema<l.Validator<AtiprotoCart.View, AtiprotoCart.View>>>;
36
54
  cursor: l.OptionalSchema<l.StringSchema<{
37
55
  readonly maxLength: 512;
38
56
  }>>;
39
57
  }>>;
40
- type CartResponse = {
41
- $type?: 'com.atiproto.recipient.payment.cart.list#cartResponse';
42
- /**
43
- * AT-URI of the cart record
44
- */
45
- uri: l.AtUriString;
46
- /**
47
- * CID of the cart record
48
- */
49
- cid: l.CidString;
50
- record: AtiprotoCart.View;
51
- };
52
- export type { CartResponse };
53
- declare const cartResponse: l.TypedObjectSchema<"com.atiproto.recipient.payment.cart.list#cartResponse", l.Validator<CartResponse, CartResponse>>;
54
- export { cartResponse };
@@ -2,17 +2,11 @@ import { l } from '@atproto/lex';
2
2
  import * as AtiprotoItem from '../../../item.defs.js';
3
3
  declare const $nsid = "com.atiproto.recipient.payment.item.get";
4
4
  export { $nsid };
5
- /** Get a specific item received by the authenticated user (as the recipient/subject). Looks up by item record uri, sender DID, or record uri. These are mutually exclusive and resolved in that order. */
5
+ /** Hydrate an incoming item record by uri (the authenticated user must be the recipient/subject). Search filters that were previously on this endpoint live on `recipient.payment.item.list`. */
6
6
  declare const main: l.Query<"com.atiproto.recipient.payment.item.get", l.ParamsSchema<{
7
- readonly uri: l.OptionalSchema<l.StringSchema<{
7
+ readonly uri: l.StringSchema<{
8
8
  readonly format: "at-uri";
9
- }>>;
10
- readonly sender: l.OptionalSchema<l.StringSchema<{
11
- readonly format: "did";
12
- }>>;
13
- readonly recordUri: l.OptionalSchema<l.StringSchema<{
14
- readonly format: "at-uri";
15
- }>>;
9
+ }>;
16
10
  }>, l.Payload<"application/json", l.ObjectSchema<{
17
11
  item: l.RefSchema<l.Validator<AtiprotoItem.View, AtiprotoItem.View>>;
18
12
  }>>, undefined>;
@@ -21,15 +15,9 @@ export type $Params = l.InferMethodParams<typeof main>;
21
15
  export type $Output<B = l.BinaryData> = l.InferMethodOutput<typeof main, B>;
22
16
  export type $OutputBody<B = l.BinaryData> = l.InferMethodOutputBody<typeof main, B>;
23
17
  export declare const $lxm: "com.atiproto.recipient.payment.item.get", $params: l.ParamsSchema<{
24
- readonly uri: l.OptionalSchema<l.StringSchema<{
25
- readonly format: "at-uri";
26
- }>>;
27
- readonly sender: l.OptionalSchema<l.StringSchema<{
28
- readonly format: "did";
29
- }>>;
30
- readonly recordUri: l.OptionalSchema<l.StringSchema<{
18
+ readonly uri: l.StringSchema<{
31
19
  readonly format: "at-uri";
32
- }>>;
20
+ }>;
33
21
  }>, $output: l.Payload<"application/json", l.ObjectSchema<{
34
22
  item: l.RefSchema<l.Validator<AtiprotoItem.View, AtiprotoItem.View>>;
35
23
  }>>;
@@ -2,12 +2,12 @@ import { l } from '@atproto/lex';
2
2
  import * as AtiprotoItem from '../../../item.defs.js';
3
3
  declare const $nsid = "com.atiproto.recipient.payment.item.list";
4
4
  export { $nsid };
5
- /** List items received by the authenticated user (items where the authed user is the recipient/subject). Includes items marked private, which are only stored in atiproto's database. */
5
+ /** List items received by the authenticated user (items whose `subject` is the authed user, or whose `record` points at a record the authed user owns). Includes items marked private, which are retained server-side. */
6
6
  declare const main: l.Query<"com.atiproto.recipient.payment.item.list", l.ParamsSchema<{
7
7
  readonly sender: l.OptionalSchema<l.StringSchema<{
8
8
  readonly format: "did";
9
9
  }>>;
10
- readonly recordUri: l.OptionalSchema<l.StringSchema<{
10
+ readonly record: l.OptionalSchema<l.StringSchema<{
11
11
  readonly format: "at-uri";
12
12
  }>>;
13
13
  readonly cursor: l.OptionalSchema<l.StringSchema<{
@@ -28,7 +28,7 @@ export declare const $lxm: "com.atiproto.recipient.payment.item.list", $params:
28
28
  readonly sender: l.OptionalSchema<l.StringSchema<{
29
29
  readonly format: "did";
30
30
  }>>;
31
- readonly recordUri: l.OptionalSchema<l.StringSchema<{
31
+ readonly record: l.OptionalSchema<l.StringSchema<{
32
32
  readonly format: "at-uri";
33
33
  }>>;
34
34
  readonly cursor: l.OptionalSchema<l.StringSchema<{
@@ -1,3 +1,2 @@
1
1
  export * as 'get' from './item/get.js';
2
2
  export * as list from './item/list.js';
3
- export * as validate from './item/validate.js';
@@ -2,14 +2,11 @@ import { l } from '@atproto/lex';
2
2
  import * as AtiprotoSubscription from '../../../subscription.defs.js';
3
3
  declare const $nsid = "com.atiproto.recipient.payment.subscription.get";
4
4
  export { $nsid };
5
- /** Get a specific subscription received by the authenticated user (as the recipient/subject). Looks up by subscription record uri or sender DID. These are mutually exclusive; uri takes precedence. */
5
+ /** Hydrate an incoming subscription record by uri (the authenticated user must be the recipient/subject). Search filters that were previously on this endpoint live on `recipient.payment.subscription.list`. */
6
6
  declare const main: l.Query<"com.atiproto.recipient.payment.subscription.get", l.ParamsSchema<{
7
- readonly uri: l.OptionalSchema<l.StringSchema<{
7
+ readonly uri: l.StringSchema<{
8
8
  readonly format: "at-uri";
9
- }>>;
10
- readonly sender: l.OptionalSchema<l.StringSchema<{
11
- readonly format: "did";
12
- }>>;
9
+ }>;
13
10
  }>, l.Payload<"application/json", l.ObjectSchema<{
14
11
  subscription: l.RefSchema<l.Validator<AtiprotoSubscription.View, AtiprotoSubscription.View>>;
15
12
  }>>, undefined>;
@@ -18,12 +15,9 @@ export type $Params = l.InferMethodParams<typeof main>;
18
15
  export type $Output<B = l.BinaryData> = l.InferMethodOutput<typeof main, B>;
19
16
  export type $OutputBody<B = l.BinaryData> = l.InferMethodOutputBody<typeof main, B>;
20
17
  export declare const $lxm: "com.atiproto.recipient.payment.subscription.get", $params: l.ParamsSchema<{
21
- readonly uri: l.OptionalSchema<l.StringSchema<{
18
+ readonly uri: l.StringSchema<{
22
19
  readonly format: "at-uri";
23
- }>>;
24
- readonly sender: l.OptionalSchema<l.StringSchema<{
25
- readonly format: "did";
26
- }>>;
20
+ }>;
27
21
  }>, $output: l.Payload<"application/json", l.ObjectSchema<{
28
22
  subscription: l.RefSchema<l.Validator<AtiprotoSubscription.View, AtiprotoSubscription.View>>;
29
23
  }>>;
@@ -2,8 +2,14 @@ import { l } from '@atproto/lex';
2
2
  import * as AtiprotoSubscription from '../../../subscription.defs.js';
3
3
  declare const $nsid = "com.atiproto.recipient.payment.subscription.list";
4
4
  export { $nsid };
5
- /** List subscriptions received by the authenticated user (subscriptions where the authed user is the recipient/subject). Includes subscriptions marked private, which are only stored in atiproto's database. */
5
+ /** List subscriptions received by the authenticated user (subscriptions whose `subject` is the authed user, or whose `record` points at a record the authed user owns). Includes subscriptions marked private, which are retained server-side. */
6
6
  declare const main: l.Query<"com.atiproto.recipient.payment.subscription.list", l.ParamsSchema<{
7
+ readonly sender: l.OptionalSchema<l.StringSchema<{
8
+ readonly format: "did";
9
+ }>>;
10
+ readonly record: l.OptionalSchema<l.StringSchema<{
11
+ readonly format: "at-uri";
12
+ }>>;
7
13
  readonly cursor: l.OptionalSchema<l.StringSchema<{
8
14
  readonly maxLength: 512;
9
15
  }>>;
@@ -19,6 +25,12 @@ export type $Params = l.InferMethodParams<typeof main>;
19
25
  export type $Output<B = l.BinaryData> = l.InferMethodOutput<typeof main, B>;
20
26
  export type $OutputBody<B = l.BinaryData> = l.InferMethodOutputBody<typeof main, B>;
21
27
  export declare const $lxm: "com.atiproto.recipient.payment.subscription.list", $params: l.ParamsSchema<{
28
+ readonly sender: l.OptionalSchema<l.StringSchema<{
29
+ readonly format: "did";
30
+ }>>;
31
+ readonly record: l.OptionalSchema<l.StringSchema<{
32
+ readonly format: "at-uri";
33
+ }>>;
22
34
  readonly cursor: l.OptionalSchema<l.StringSchema<{
23
35
  readonly maxLength: 512;
24
36
  }>>;
@@ -1,3 +1,2 @@
1
1
  export * as 'get' from './subscription/get.js';
2
2
  export * as list from './subscription/list.js';
3
- export * as validate from './subscription/validate.js';
@@ -2,30 +2,50 @@ import { l } from '@atproto/lex';
2
2
  import * as AtiprotoProfile from '../../profile.defs.js';
3
3
  declare const $nsid = "com.atiproto.recipient.profile.get";
4
4
  export { $nsid };
5
- /** Get the authenticated user's profile settings. Returns defaults if no profile exists. */
6
- declare const main: l.Query<"com.atiproto.recipient.profile.get", l.ParamsSchema<{}>, l.Payload<"application/json", l.ObjectSchema<{
7
- uri: l.OptionalSchema<l.StringSchema<{
8
- readonly format: "at-uri";
5
+ /** Get the authenticated user's payment-related state. The PoS variant returns the user's profile and their broker list (the same list `repo.profile.get` would surface). The broker variant returns a `brokerView` describing this user's onboarding state with that broker plus a fresh onboarding link. */
6
+ declare const main: l.Query<"com.atiproto.recipient.profile.get", l.ParamsSchema<{
7
+ readonly redirectUrl: l.OptionalSchema<l.StringSchema<{
8
+ readonly format: "uri";
9
9
  }>>;
10
- cid: l.OptionalSchema<l.StringSchema<{
11
- readonly format: "cid";
12
- }>>;
13
- profile: l.RefSchema<l.Validator<AtiprotoProfile.View, AtiprotoProfile.View>>;
14
- hasProfile: l.BooleanSchema;
15
- readyForPayment: l.BooleanSchema;
10
+ }>, l.Payload<"application/json", l.ObjectSchema<{
11
+ profile: l.OptionalSchema<l.RefSchema<l.Validator<AtiprotoProfile.View, AtiprotoProfile.View>>>;
12
+ brokers: l.OptionalSchema<l.ArraySchema<l.StringSchema<{
13
+ readonly format: "did";
14
+ }>>>;
15
+ broker: l.OptionalSchema<l.RefSchema<l.Validator<BrokerView, BrokerView>>>;
16
16
  }>>, undefined>;
17
17
  export { main };
18
18
  export type $Params = l.InferMethodParams<typeof main>;
19
19
  export type $Output<B = l.BinaryData> = l.InferMethodOutput<typeof main, B>;
20
20
  export type $OutputBody<B = l.BinaryData> = l.InferMethodOutputBody<typeof main, B>;
21
- export declare const $lxm: "com.atiproto.recipient.profile.get", $params: l.ParamsSchema<{}>, $output: l.Payload<"application/json", l.ObjectSchema<{
22
- uri: l.OptionalSchema<l.StringSchema<{
23
- readonly format: "at-uri";
24
- }>>;
25
- cid: l.OptionalSchema<l.StringSchema<{
26
- readonly format: "cid";
21
+ export declare const $lxm: "com.atiproto.recipient.profile.get", $params: l.ParamsSchema<{
22
+ readonly redirectUrl: l.OptionalSchema<l.StringSchema<{
23
+ readonly format: "uri";
27
24
  }>>;
28
- profile: l.RefSchema<l.Validator<AtiprotoProfile.View, AtiprotoProfile.View>>;
29
- hasProfile: l.BooleanSchema;
30
- readyForPayment: l.BooleanSchema;
25
+ }>, $output: l.Payload<"application/json", l.ObjectSchema<{
26
+ profile: l.OptionalSchema<l.RefSchema<l.Validator<AtiprotoProfile.View, AtiprotoProfile.View>>>;
27
+ brokers: l.OptionalSchema<l.ArraySchema<l.StringSchema<{
28
+ readonly format: "did";
29
+ }>>>;
30
+ broker: l.OptionalSchema<l.RefSchema<l.Validator<BrokerView, BrokerView>>>;
31
31
  }>>;
32
+ /** Broker-side view of the authed user's account. Returned only when `recipient.profile.get` is called on a broker (rather than a PoS). */
33
+ type BrokerView = {
34
+ $type?: 'com.atiproto.recipient.profile.get#brokerView';
35
+ /**
36
+ * DID of the broker answering the request.
37
+ */
38
+ did: l.DidString;
39
+ /**
40
+ * Broker-defined onboarding state for the authed user. `ready` means the user can receive payouts; the other values indicate where onboarding is and whether action is needed.
41
+ */
42
+ status: 'none' | 'pending' | 'needs_info' | 'ready' | 'restricted' | 'disabled' | l.UnknownString;
43
+ /**
44
+ * Optional. Fresh broker-hosted onboarding link. Clients should redirect the user here to complete (or update) their account. When `redirectUrl` was supplied on the request, the broker embeds it so the user lands back at the caller after onboarding.
45
+ */
46
+ onboardingUrl?: l.UriString;
47
+ };
48
+ export type { BrokerView };
49
+ /** Broker-side view of the authed user's account. Returned only when `recipient.profile.get` is called on a broker (rather than a PoS). */
50
+ declare const brokerView: l.TypedObjectSchema<"com.atiproto.recipient.profile.get#brokerView", l.Validator<BrokerView, BrokerView>>;
51
+ export { brokerView };
@@ -1,14 +1,11 @@
1
1
  import { l } from '@atproto/lex';
2
2
  declare const $nsid = "com.atiproto.repo.item.count";
3
3
  export { $nsid };
4
- /** Count active (completed) items. If recordUri is provided, counts items for that record. If subject is provided, counts items received by that DID. If neither is provided, counts items sent by the authenticated user. Optionally filtered by a start/end datetime window. When the authenticated user is the subject/owner of the target, the response also includes the sum of amounts. */
4
+ /** Count active (completed) items. When `record` is provided, counts items targeting that at-uri (either a specific record or, when the at-uri is repo-level like `at://did:plc:...`, all items received by that user). When omitted, counts items sent by the authenticated user. Optionally filtered by a start/end datetime window. When the authenticated caller is the subject/owner of the target (or counting their own sent items), the response also includes the sum of amounts. */
5
5
  declare const main: l.Query<"com.atiproto.repo.item.count", l.ParamsSchema<{
6
- readonly recordUri: l.OptionalSchema<l.StringSchema<{
6
+ readonly record: l.OptionalSchema<l.StringSchema<{
7
7
  readonly format: "at-uri";
8
8
  }>>;
9
- readonly subject: l.OptionalSchema<l.StringSchema<{
10
- readonly format: "did";
11
- }>>;
12
9
  readonly startDate: l.OptionalSchema<l.StringSchema<{
13
10
  readonly format: "datetime";
14
11
  }>>;
@@ -27,12 +24,9 @@ export type $Params = l.InferMethodParams<typeof main>;
27
24
  export type $Output<B = l.BinaryData> = l.InferMethodOutput<typeof main, B>;
28
25
  export type $OutputBody<B = l.BinaryData> = l.InferMethodOutputBody<typeof main, B>;
29
26
  export declare const $lxm: "com.atiproto.repo.item.count", $params: l.ParamsSchema<{
30
- readonly recordUri: l.OptionalSchema<l.StringSchema<{
27
+ readonly record: l.OptionalSchema<l.StringSchema<{
31
28
  readonly format: "at-uri";
32
29
  }>>;
33
- readonly subject: l.OptionalSchema<l.StringSchema<{
34
- readonly format: "did";
35
- }>>;
36
30
  readonly startDate: l.OptionalSchema<l.StringSchema<{
37
31
  readonly format: "datetime";
38
32
  }>>;