@oxyhq/contracts 0.13.1 → 0.14.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.
- package/dist/cjs/.tsbuildinfo +1 -1
- package/dist/cjs/accountGraph.js +48 -0
- package/dist/cjs/index.js +6 -2
- package/dist/cjs/userResponse.js +20 -3
- package/dist/esm/.tsbuildinfo +1 -1
- package/dist/esm/accountGraph.js +45 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/userResponse.js +20 -3
- package/dist/types/.tsbuildinfo +1 -1
- package/dist/types/accountGraph.d.ts +83 -0
- package/dist/types/identity.d.ts +4 -4
- package/dist/types/index.d.ts +2 -0
- package/dist/types/sessionStatus.d.ts +6 -6
- package/dist/types/userResponse.d.ts +225 -32
- package/package.json +1 -1
|
@@ -74,7 +74,7 @@ export declare const userNameSchema: z.ZodType<UserNameResponse>;
|
|
|
74
74
|
*
|
|
75
75
|
* `.passthrough()` keeps the large tail of profile fields
|
|
76
76
|
* (`privacySettings`, `locations`, `links`, `linksMetadata`, `bio`,
|
|
77
|
-
* `description`, `
|
|
77
|
+
* `description`, `languages`, `verified`, timestamps, …) available to callers
|
|
78
78
|
* that need them without enumerating every nested shape here — the load-bearing
|
|
79
79
|
* identity/display fields are the ones we pin precisely.
|
|
80
80
|
*/
|
|
@@ -95,7 +95,13 @@ export declare const userResponseSchema: z.ZodObject<{
|
|
|
95
95
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
96
96
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
97
97
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
98
|
-
|
|
98
|
+
/**
|
|
99
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
100
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
101
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
102
|
+
* `language` field.
|
|
103
|
+
*/
|
|
104
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
99
105
|
/**
|
|
100
106
|
* The account's self-sovereign identifier
|
|
101
107
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -107,6 +113,11 @@ export declare const userResponseSchema: z.ZodObject<{
|
|
|
107
113
|
* entry; present only when the account has verified at least one domain.
|
|
108
114
|
*/
|
|
109
115
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
116
|
+
/**
|
|
117
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
118
|
+
* Absent on personal, project, and bot accounts.
|
|
119
|
+
*/
|
|
120
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
110
121
|
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
111
122
|
/** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
|
|
112
123
|
id: z.ZodOptional<z.ZodString>;
|
|
@@ -124,7 +135,13 @@ export declare const userResponseSchema: z.ZodObject<{
|
|
|
124
135
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
125
136
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
126
137
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
127
|
-
|
|
138
|
+
/**
|
|
139
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
140
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
141
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
142
|
+
* `language` field.
|
|
143
|
+
*/
|
|
144
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
128
145
|
/**
|
|
129
146
|
* The account's self-sovereign identifier
|
|
130
147
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -136,6 +153,11 @@ export declare const userResponseSchema: z.ZodObject<{
|
|
|
136
153
|
* entry; present only when the account has verified at least one domain.
|
|
137
154
|
*/
|
|
138
155
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
156
|
+
/**
|
|
157
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
158
|
+
* Absent on personal, project, and bot accounts.
|
|
159
|
+
*/
|
|
160
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
139
161
|
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
140
162
|
/** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
|
|
141
163
|
id: z.ZodOptional<z.ZodString>;
|
|
@@ -153,7 +175,13 @@ export declare const userResponseSchema: z.ZodObject<{
|
|
|
153
175
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
154
176
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
155
177
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
156
|
-
|
|
178
|
+
/**
|
|
179
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
180
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
181
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
182
|
+
* `language` field.
|
|
183
|
+
*/
|
|
184
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
157
185
|
/**
|
|
158
186
|
* The account's self-sovereign identifier
|
|
159
187
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -165,6 +193,11 @@ export declare const userResponseSchema: z.ZodObject<{
|
|
|
165
193
|
* entry; present only when the account has verified at least one domain.
|
|
166
194
|
*/
|
|
167
195
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
196
|
+
/**
|
|
197
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
198
|
+
* Absent on personal, project, and bot accounts.
|
|
199
|
+
*/
|
|
200
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
168
201
|
}, z.ZodTypeAny, "passthrough">>;
|
|
169
202
|
export type UserResponse = z.infer<typeof userResponseSchema>;
|
|
170
203
|
export declare const userProfileUpdateSchema: z.ZodObject<{
|
|
@@ -197,18 +230,23 @@ export declare const userProfileUpdateSchema: z.ZodObject<{
|
|
|
197
230
|
id: z.ZodOptional<z.ZodString>;
|
|
198
231
|
}, "strip", z.ZodTypeAny, {
|
|
199
232
|
url: string;
|
|
200
|
-
id?: string | undefined;
|
|
201
233
|
description?: string | undefined;
|
|
234
|
+
id?: string | undefined;
|
|
202
235
|
title?: string | undefined;
|
|
203
236
|
image?: string | undefined;
|
|
204
237
|
}, {
|
|
205
238
|
url: string;
|
|
206
|
-
id?: string | undefined;
|
|
207
239
|
description?: string | undefined;
|
|
240
|
+
id?: string | undefined;
|
|
208
241
|
title?: string | undefined;
|
|
209
242
|
image?: string | undefined;
|
|
210
243
|
}>, "many">>;
|
|
211
|
-
|
|
244
|
+
/**
|
|
245
|
+
* Ordered account locales (`language-REGION`), primary first. Replaces
|
|
246
|
+
* the eliminated singular `language`; `languages[0]` is the primary UI
|
|
247
|
+
* locale.
|
|
248
|
+
*/
|
|
249
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
212
250
|
accountExpiresAfterInactivityDays: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
213
251
|
notificationPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
214
252
|
userPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
@@ -243,18 +281,23 @@ export declare const userProfileUpdateSchema: z.ZodObject<{
|
|
|
243
281
|
id: z.ZodOptional<z.ZodString>;
|
|
244
282
|
}, "strip", z.ZodTypeAny, {
|
|
245
283
|
url: string;
|
|
246
|
-
id?: string | undefined;
|
|
247
284
|
description?: string | undefined;
|
|
285
|
+
id?: string | undefined;
|
|
248
286
|
title?: string | undefined;
|
|
249
287
|
image?: string | undefined;
|
|
250
288
|
}, {
|
|
251
289
|
url: string;
|
|
252
|
-
id?: string | undefined;
|
|
253
290
|
description?: string | undefined;
|
|
291
|
+
id?: string | undefined;
|
|
254
292
|
title?: string | undefined;
|
|
255
293
|
image?: string | undefined;
|
|
256
294
|
}>, "many">>;
|
|
257
|
-
|
|
295
|
+
/**
|
|
296
|
+
* Ordered account locales (`language-REGION`), primary first. Replaces
|
|
297
|
+
* the eliminated singular `language`; `languages[0]` is the primary UI
|
|
298
|
+
* locale.
|
|
299
|
+
*/
|
|
300
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
258
301
|
accountExpiresAfterInactivityDays: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
259
302
|
notificationPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
260
303
|
userPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
@@ -289,18 +332,23 @@ export declare const userProfileUpdateSchema: z.ZodObject<{
|
|
|
289
332
|
id: z.ZodOptional<z.ZodString>;
|
|
290
333
|
}, "strip", z.ZodTypeAny, {
|
|
291
334
|
url: string;
|
|
292
|
-
id?: string | undefined;
|
|
293
335
|
description?: string | undefined;
|
|
336
|
+
id?: string | undefined;
|
|
294
337
|
title?: string | undefined;
|
|
295
338
|
image?: string | undefined;
|
|
296
339
|
}, {
|
|
297
340
|
url: string;
|
|
298
|
-
id?: string | undefined;
|
|
299
341
|
description?: string | undefined;
|
|
342
|
+
id?: string | undefined;
|
|
300
343
|
title?: string | undefined;
|
|
301
344
|
image?: string | undefined;
|
|
302
345
|
}>, "many">>;
|
|
303
|
-
|
|
346
|
+
/**
|
|
347
|
+
* Ordered account locales (`language-REGION`), primary first. Replaces
|
|
348
|
+
* the eliminated singular `language`; `languages[0]` is the primary UI
|
|
349
|
+
* locale.
|
|
350
|
+
*/
|
|
351
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
304
352
|
accountExpiresAfterInactivityDays: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
305
353
|
notificationPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
306
354
|
userPreferences: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
@@ -336,7 +384,13 @@ export declare const currentUserResponseSchema: z.ZodObject<{
|
|
|
336
384
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
337
385
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
338
386
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
339
|
-
|
|
387
|
+
/**
|
|
388
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
389
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
390
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
391
|
+
* `language` field.
|
|
392
|
+
*/
|
|
393
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
340
394
|
/**
|
|
341
395
|
* The account's self-sovereign identifier
|
|
342
396
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -348,6 +402,11 @@ export declare const currentUserResponseSchema: z.ZodObject<{
|
|
|
348
402
|
* entry; present only when the account has verified at least one domain.
|
|
349
403
|
*/
|
|
350
404
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
405
|
+
/**
|
|
406
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
407
|
+
* Absent on personal, project, and bot accounts.
|
|
408
|
+
*/
|
|
409
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
351
410
|
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
352
411
|
/** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
|
|
353
412
|
id: z.ZodOptional<z.ZodString>;
|
|
@@ -365,7 +424,13 @@ export declare const currentUserResponseSchema: z.ZodObject<{
|
|
|
365
424
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
366
425
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
367
426
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
368
|
-
|
|
427
|
+
/**
|
|
428
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
429
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
430
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
431
|
+
* `language` field.
|
|
432
|
+
*/
|
|
433
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
369
434
|
/**
|
|
370
435
|
* The account's self-sovereign identifier
|
|
371
436
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -377,6 +442,11 @@ export declare const currentUserResponseSchema: z.ZodObject<{
|
|
|
377
442
|
* entry; present only when the account has verified at least one domain.
|
|
378
443
|
*/
|
|
379
444
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
445
|
+
/**
|
|
446
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
447
|
+
* Absent on personal, project, and bot accounts.
|
|
448
|
+
*/
|
|
449
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
380
450
|
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
381
451
|
/** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
|
|
382
452
|
id: z.ZodOptional<z.ZodString>;
|
|
@@ -394,7 +464,13 @@ export declare const currentUserResponseSchema: z.ZodObject<{
|
|
|
394
464
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
395
465
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
396
466
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
397
|
-
|
|
467
|
+
/**
|
|
468
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
469
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
470
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
471
|
+
* `language` field.
|
|
472
|
+
*/
|
|
473
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
398
474
|
/**
|
|
399
475
|
* The account's self-sovereign identifier
|
|
400
476
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -406,44 +482,51 @@ export declare const currentUserResponseSchema: z.ZodObject<{
|
|
|
406
482
|
* entry; present only when the account has verified at least one domain.
|
|
407
483
|
*/
|
|
408
484
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
485
|
+
/**
|
|
486
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
487
|
+
* Absent on personal, project, and bot accounts.
|
|
488
|
+
*/
|
|
489
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
409
490
|
}, z.ZodTypeAny, "passthrough">>;
|
|
410
491
|
}, "strip", z.ZodTypeAny, {
|
|
411
492
|
data: {
|
|
412
493
|
name: UserNameResponse;
|
|
494
|
+
username?: string | undefined;
|
|
495
|
+
avatar?: string | null | undefined;
|
|
496
|
+
organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
|
|
413
497
|
id?: string | undefined;
|
|
414
498
|
publicKey?: string | undefined;
|
|
415
499
|
did?: string | undefined;
|
|
416
500
|
verifiedDomains?: import("./identity").VerifiedDomain[] | undefined;
|
|
417
501
|
verified?: boolean | undefined;
|
|
418
|
-
username?: string | undefined;
|
|
419
|
-
avatar?: string | null | undefined;
|
|
420
502
|
_id?: string | undefined;
|
|
421
503
|
email?: string | undefined;
|
|
422
504
|
phone?: string | undefined;
|
|
423
505
|
address?: string | undefined;
|
|
424
506
|
birthday?: string | undefined;
|
|
425
507
|
color?: string | null | undefined;
|
|
426
|
-
|
|
508
|
+
languages?: string[] | undefined;
|
|
427
509
|
} & {
|
|
428
510
|
[k: string]: unknown;
|
|
429
511
|
};
|
|
430
512
|
}, {
|
|
431
513
|
data: {
|
|
432
514
|
name: UserNameResponse;
|
|
515
|
+
username?: string | undefined;
|
|
516
|
+
avatar?: string | null | undefined;
|
|
517
|
+
organizationCategory?: "agency" | "cooperative" | "landlord" | "other" | undefined;
|
|
433
518
|
id?: string | undefined;
|
|
434
519
|
publicKey?: string | undefined;
|
|
435
520
|
did?: string | undefined;
|
|
436
521
|
verifiedDomains?: import("./identity").VerifiedDomain[] | undefined;
|
|
437
522
|
verified?: boolean | undefined;
|
|
438
|
-
username?: string | undefined;
|
|
439
|
-
avatar?: string | null | undefined;
|
|
440
523
|
_id?: string | undefined;
|
|
441
524
|
email?: string | undefined;
|
|
442
525
|
phone?: string | undefined;
|
|
443
526
|
address?: string | undefined;
|
|
444
527
|
birthday?: string | undefined;
|
|
445
528
|
color?: string | null | undefined;
|
|
446
|
-
|
|
529
|
+
languages?: string[] | undefined;
|
|
447
530
|
} & {
|
|
448
531
|
[k: string]: unknown;
|
|
449
532
|
};
|
|
@@ -475,7 +558,13 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
|
|
|
475
558
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
476
559
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
477
560
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
478
|
-
|
|
561
|
+
/**
|
|
562
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
563
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
564
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
565
|
+
* `language` field.
|
|
566
|
+
*/
|
|
567
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
479
568
|
/**
|
|
480
569
|
* The account's self-sovereign identifier
|
|
481
570
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -487,6 +576,11 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
|
|
|
487
576
|
* entry; present only when the account has verified at least one domain.
|
|
488
577
|
*/
|
|
489
578
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
579
|
+
/**
|
|
580
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
581
|
+
* Absent on personal, project, and bot accounts.
|
|
582
|
+
*/
|
|
583
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
490
584
|
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
491
585
|
/** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
|
|
492
586
|
id: z.ZodOptional<z.ZodString>;
|
|
@@ -504,7 +598,13 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
|
|
|
504
598
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
505
599
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
506
600
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
507
|
-
|
|
601
|
+
/**
|
|
602
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
603
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
604
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
605
|
+
* `language` field.
|
|
606
|
+
*/
|
|
607
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
508
608
|
/**
|
|
509
609
|
* The account's self-sovereign identifier
|
|
510
610
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -516,6 +616,11 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
|
|
|
516
616
|
* entry; present only when the account has verified at least one domain.
|
|
517
617
|
*/
|
|
518
618
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
619
|
+
/**
|
|
620
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
621
|
+
* Absent on personal, project, and bot accounts.
|
|
622
|
+
*/
|
|
623
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
519
624
|
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
520
625
|
/** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
|
|
521
626
|
id: z.ZodOptional<z.ZodString>;
|
|
@@ -533,7 +638,13 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
|
|
|
533
638
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
534
639
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
535
640
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
536
|
-
|
|
641
|
+
/**
|
|
642
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
643
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
644
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
645
|
+
* `language` field.
|
|
646
|
+
*/
|
|
647
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
537
648
|
/**
|
|
538
649
|
* The account's self-sovereign identifier
|
|
539
650
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -545,6 +656,11 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
|
|
|
545
656
|
* entry; present only when the account has verified at least one domain.
|
|
546
657
|
*/
|
|
547
658
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
659
|
+
/**
|
|
660
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
661
|
+
* Absent on personal, project, and bot accounts.
|
|
662
|
+
*/
|
|
663
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
548
664
|
}, z.ZodTypeAny, "passthrough">>>>;
|
|
549
665
|
}, "strip", z.ZodTypeAny, {
|
|
550
666
|
sessionId: string;
|
|
@@ -565,7 +681,13 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
|
|
|
565
681
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
566
682
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
567
683
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
568
|
-
|
|
684
|
+
/**
|
|
685
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
686
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
687
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
688
|
+
* `language` field.
|
|
689
|
+
*/
|
|
690
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
569
691
|
/**
|
|
570
692
|
* The account's self-sovereign identifier
|
|
571
693
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -577,6 +699,11 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
|
|
|
577
699
|
* entry; present only when the account has verified at least one domain.
|
|
578
700
|
*/
|
|
579
701
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
702
|
+
/**
|
|
703
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
704
|
+
* Absent on personal, project, and bot accounts.
|
|
705
|
+
*/
|
|
706
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
580
707
|
}, z.ZodTypeAny, "passthrough"> | null | undefined;
|
|
581
708
|
isCurrent?: boolean | undefined;
|
|
582
709
|
}, {
|
|
@@ -598,7 +725,13 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
|
|
|
598
725
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
599
726
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
600
727
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
601
|
-
|
|
728
|
+
/**
|
|
729
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
730
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
731
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
732
|
+
* `language` field.
|
|
733
|
+
*/
|
|
734
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
602
735
|
/**
|
|
603
736
|
* The account's self-sovereign identifier
|
|
604
737
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -610,6 +743,11 @@ export declare const deviceLinkedSessionSchema: z.ZodObject<{
|
|
|
610
743
|
* entry; present only when the account has verified at least one domain.
|
|
611
744
|
*/
|
|
612
745
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
746
|
+
/**
|
|
747
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
748
|
+
* Absent on personal, project, and bot accounts.
|
|
749
|
+
*/
|
|
750
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
613
751
|
}, z.ZodTypeAny, "passthrough"> | null | undefined;
|
|
614
752
|
isCurrent?: boolean | undefined;
|
|
615
753
|
}>;
|
|
@@ -635,7 +773,13 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
|
|
|
635
773
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
636
774
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
637
775
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
638
|
-
|
|
776
|
+
/**
|
|
777
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
778
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
779
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
780
|
+
* `language` field.
|
|
781
|
+
*/
|
|
782
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
639
783
|
/**
|
|
640
784
|
* The account's self-sovereign identifier
|
|
641
785
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -647,6 +791,11 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
|
|
|
647
791
|
* entry; present only when the account has verified at least one domain.
|
|
648
792
|
*/
|
|
649
793
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
794
|
+
/**
|
|
795
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
796
|
+
* Absent on personal, project, and bot accounts.
|
|
797
|
+
*/
|
|
798
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
650
799
|
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
651
800
|
/** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
|
|
652
801
|
id: z.ZodOptional<z.ZodString>;
|
|
@@ -664,7 +813,13 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
|
|
|
664
813
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
665
814
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
666
815
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
667
|
-
|
|
816
|
+
/**
|
|
817
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
818
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
819
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
820
|
+
* `language` field.
|
|
821
|
+
*/
|
|
822
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
668
823
|
/**
|
|
669
824
|
* The account's self-sovereign identifier
|
|
670
825
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -676,6 +831,11 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
|
|
|
676
831
|
* entry; present only when the account has verified at least one domain.
|
|
677
832
|
*/
|
|
678
833
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
834
|
+
/**
|
|
835
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
836
|
+
* Absent on personal, project, and bot accounts.
|
|
837
|
+
*/
|
|
838
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
679
839
|
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
680
840
|
/** MongoDB ObjectId as a string. Present on `formatUserResponse` output. */
|
|
681
841
|
id: z.ZodOptional<z.ZodString>;
|
|
@@ -693,7 +853,13 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
|
|
|
693
853
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
694
854
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
695
855
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
696
|
-
|
|
856
|
+
/**
|
|
857
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
858
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
859
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
860
|
+
* `language` field.
|
|
861
|
+
*/
|
|
862
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
697
863
|
/**
|
|
698
864
|
* The account's self-sovereign identifier
|
|
699
865
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -705,6 +871,11 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
|
|
|
705
871
|
* entry; present only when the account has verified at least one domain.
|
|
706
872
|
*/
|
|
707
873
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
874
|
+
/**
|
|
875
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
876
|
+
* Absent on personal, project, and bot accounts.
|
|
877
|
+
*/
|
|
878
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
708
879
|
}, z.ZodTypeAny, "passthrough">>>>;
|
|
709
880
|
}, "strip", z.ZodTypeAny, {
|
|
710
881
|
sessionId: string;
|
|
@@ -725,7 +896,13 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
|
|
|
725
896
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
726
897
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
727
898
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
728
|
-
|
|
899
|
+
/**
|
|
900
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
901
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
902
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
903
|
+
* `language` field.
|
|
904
|
+
*/
|
|
905
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
729
906
|
/**
|
|
730
907
|
* The account's self-sovereign identifier
|
|
731
908
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -737,6 +914,11 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
|
|
|
737
914
|
* entry; present only when the account has verified at least one domain.
|
|
738
915
|
*/
|
|
739
916
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
917
|
+
/**
|
|
918
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
919
|
+
* Absent on personal, project, and bot accounts.
|
|
920
|
+
*/
|
|
921
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
740
922
|
}, z.ZodTypeAny, "passthrough"> | null | undefined;
|
|
741
923
|
isCurrent?: boolean | undefined;
|
|
742
924
|
}, {
|
|
@@ -758,7 +940,13 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
|
|
|
758
940
|
color: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
759
941
|
name: z.ZodType<UserNameResponse, z.ZodTypeDef, UserNameResponse>;
|
|
760
942
|
verified: z.ZodOptional<z.ZodBoolean>;
|
|
761
|
-
|
|
943
|
+
/**
|
|
944
|
+
* The account's languages as full BCP-47 locales (`language-REGION`,
|
|
945
|
+
* e.g. `es-ES`, `en-US`, `pt-BR`), ordered with the PRIMARY (UI) locale
|
|
946
|
+
* first. `languages[0]` is the primary locale — there is no singular
|
|
947
|
+
* `language` field.
|
|
948
|
+
*/
|
|
949
|
+
languages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
762
950
|
/**
|
|
763
951
|
* The account's self-sovereign identifier
|
|
764
952
|
* (`did:web:<FEDERATION_DOMAIN>:u:<userId>`). Surfaced as a `User`
|
|
@@ -770,6 +958,11 @@ export declare const deviceLinkedSessionsResponseSchema: z.ZodArray<z.ZodObject<
|
|
|
770
958
|
* entry; present only when the account has verified at least one domain.
|
|
771
959
|
*/
|
|
772
960
|
verifiedDomains: z.ZodOptional<z.ZodArray<z.ZodType<import("./identity").VerifiedDomain, z.ZodTypeDef, import("./identity").VerifiedDomain>, "many">>;
|
|
961
|
+
/**
|
|
962
|
+
* Real-estate / team taxonomy for `kind: 'organization'` accounts.
|
|
963
|
+
* Absent on personal, project, and bot accounts.
|
|
964
|
+
*/
|
|
965
|
+
organizationCategory: z.ZodOptional<z.ZodEnum<["agency", "cooperative", "landlord", "other"]>>;
|
|
773
966
|
}, z.ZodTypeAny, "passthrough"> | null | undefined;
|
|
774
967
|
isCurrent?: boolean | undefined;
|
|
775
968
|
}>, "many">;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@oxyhq/contracts",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.14.0",
|
|
4
4
|
"description": "OxyHQ API contracts — single source of truth for request/response Zod schemas and inferred types, shared by the backend and the client SDKs",
|
|
5
5
|
"main": "dist/cjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|