@learncard/types 5.2.8 → 5.3.0

Sign up to get free protection for your applications and to get access to all the features.
package/dist/lcn.d.ts ADDED
@@ -0,0 +1,371 @@
1
+ import { z } from 'zod';
2
+ export declare const LCNProfileValidator: z.ZodObject<{
3
+ profileId: z.ZodString;
4
+ displayName: z.ZodDefault<z.ZodString>;
5
+ did: z.ZodString;
6
+ email: z.ZodOptional<z.ZodString>;
7
+ image: z.ZodOptional<z.ZodString>;
8
+ isServiceProfile: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
9
+ notificationsWebhook: z.ZodOptional<z.ZodString>;
10
+ }, "strip", z.ZodTypeAny, {
11
+ image?: string | undefined;
12
+ email?: string | undefined;
13
+ isServiceProfile?: boolean | undefined;
14
+ notificationsWebhook?: string | undefined;
15
+ profileId: string;
16
+ displayName: string;
17
+ did: string;
18
+ }, {
19
+ image?: string | undefined;
20
+ email?: string | undefined;
21
+ displayName?: string | undefined;
22
+ isServiceProfile?: boolean | undefined;
23
+ notificationsWebhook?: string | undefined;
24
+ profileId: string;
25
+ did: string;
26
+ }>;
27
+ export type LCNProfile = z.infer<typeof LCNProfileValidator>;
28
+ export declare const LCNProfileConnectionStatusEnum: z.ZodEnum<["CONNECTED", "PENDING_REQUEST_SENT", "PENDING_REQUEST_RECEIVED", "NOT_CONNECTED"]>;
29
+ export type LCNProfileConnectionStatusEnum = z.infer<typeof LCNProfileConnectionStatusEnum>;
30
+ export declare const SentCredentialInfoValidator: z.ZodObject<{
31
+ uri: z.ZodString;
32
+ to: z.ZodString;
33
+ from: z.ZodString;
34
+ sent: z.ZodString;
35
+ received: z.ZodOptional<z.ZodString>;
36
+ }, "strip", z.ZodTypeAny, {
37
+ received?: string | undefined;
38
+ uri: string;
39
+ to: string;
40
+ from: string;
41
+ sent: string;
42
+ }, {
43
+ received?: string | undefined;
44
+ uri: string;
45
+ to: string;
46
+ from: string;
47
+ sent: string;
48
+ }>;
49
+ export type SentCredentialInfo = z.infer<typeof SentCredentialInfoValidator>;
50
+ export declare const LCNBoostStatus: z.ZodEnum<["DRAFT", "LIVE"]>;
51
+ export type LCNBoostStatusEnum = z.infer<typeof LCNBoostStatus>;
52
+ export declare const BoostValidator: z.ZodObject<{
53
+ uri: z.ZodString;
54
+ name: z.ZodOptional<z.ZodString>;
55
+ type: z.ZodOptional<z.ZodString>;
56
+ category: z.ZodOptional<z.ZodString>;
57
+ status: z.ZodOptional<z.ZodEnum<["DRAFT", "LIVE"]>>;
58
+ }, "strip", z.ZodTypeAny, {
59
+ type?: string | undefined;
60
+ status?: "DRAFT" | "LIVE" | undefined;
61
+ name?: string | undefined;
62
+ category?: string | undefined;
63
+ uri: string;
64
+ }, {
65
+ type?: string | undefined;
66
+ status?: "DRAFT" | "LIVE" | undefined;
67
+ name?: string | undefined;
68
+ category?: string | undefined;
69
+ uri: string;
70
+ }>;
71
+ export type Boost = z.infer<typeof BoostValidator>;
72
+ export declare const BoostRecipientValidator: z.ZodObject<{
73
+ to: z.ZodObject<{
74
+ profileId: z.ZodString;
75
+ displayName: z.ZodDefault<z.ZodString>;
76
+ did: z.ZodString;
77
+ email: z.ZodOptional<z.ZodString>;
78
+ image: z.ZodOptional<z.ZodString>;
79
+ isServiceProfile: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
80
+ notificationsWebhook: z.ZodOptional<z.ZodString>;
81
+ }, "strip", z.ZodTypeAny, {
82
+ image?: string | undefined;
83
+ email?: string | undefined;
84
+ isServiceProfile?: boolean | undefined;
85
+ notificationsWebhook?: string | undefined;
86
+ profileId: string;
87
+ displayName: string;
88
+ did: string;
89
+ }, {
90
+ image?: string | undefined;
91
+ email?: string | undefined;
92
+ displayName?: string | undefined;
93
+ isServiceProfile?: boolean | undefined;
94
+ notificationsWebhook?: string | undefined;
95
+ profileId: string;
96
+ did: string;
97
+ }>;
98
+ from: z.ZodString;
99
+ received: z.ZodString;
100
+ }, "strip", z.ZodTypeAny, {
101
+ received: string;
102
+ to: {
103
+ image?: string | undefined;
104
+ email?: string | undefined;
105
+ isServiceProfile?: boolean | undefined;
106
+ notificationsWebhook?: string | undefined;
107
+ profileId: string;
108
+ displayName: string;
109
+ did: string;
110
+ };
111
+ from: string;
112
+ }, {
113
+ received: string;
114
+ to: {
115
+ image?: string | undefined;
116
+ email?: string | undefined;
117
+ displayName?: string | undefined;
118
+ isServiceProfile?: boolean | undefined;
119
+ notificationsWebhook?: string | undefined;
120
+ profileId: string;
121
+ did: string;
122
+ };
123
+ from: string;
124
+ }>;
125
+ export type BoostRecipientInfo = z.infer<typeof BoostRecipientValidator>;
126
+ export declare const LCNNotificationTypeEnumValidator: z.ZodEnum<["CONNECTION_REQUEST", "CONNECTION_ACCEPTED", "CREDENTIAL_RECEIVED", "CREDENTIAL_ACCEPTED", "BOOST_RECEIVED", "BOOST_ACCEPTED", "PRESENTATION_REQUEST", "PRESENTATION_RECEIVED"]>;
127
+ export type LCNNotificationTypeEnum = z.infer<typeof LCNNotificationTypeEnumValidator>;
128
+ export declare const LCNNotificationMessageValidator: z.ZodObject<{
129
+ title: z.ZodOptional<z.ZodString>;
130
+ body: z.ZodOptional<z.ZodString>;
131
+ }, "strip", z.ZodTypeAny, {
132
+ title?: string | undefined;
133
+ body?: string | undefined;
134
+ }, {
135
+ title?: string | undefined;
136
+ body?: string | undefined;
137
+ }>;
138
+ export type LCNNotificationMessage = z.infer<typeof LCNNotificationMessageValidator>;
139
+ export declare const LCNNotificationDataValidator: z.ZodObject<{
140
+ vcUris: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
141
+ vpUris: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
142
+ }, "strip", z.ZodTypeAny, {
143
+ vcUris?: string[] | undefined;
144
+ vpUris?: string[] | undefined;
145
+ }, {
146
+ vcUris?: string[] | undefined;
147
+ vpUris?: string[] | undefined;
148
+ }>;
149
+ export type LCNNotificationData = z.infer<typeof LCNNotificationDataValidator>;
150
+ export declare const LCNNotificationValidator: z.ZodObject<{
151
+ type: z.ZodEnum<["CONNECTION_REQUEST", "CONNECTION_ACCEPTED", "CREDENTIAL_RECEIVED", "CREDENTIAL_ACCEPTED", "BOOST_RECEIVED", "BOOST_ACCEPTED", "PRESENTATION_REQUEST", "PRESENTATION_RECEIVED"]>;
152
+ to: z.ZodIntersection<z.ZodObject<{
153
+ profileId: z.ZodOptional<z.ZodString>;
154
+ displayName: z.ZodOptional<z.ZodDefault<z.ZodString>>;
155
+ did: z.ZodOptional<z.ZodString>;
156
+ email: z.ZodOptional<z.ZodOptional<z.ZodString>>;
157
+ image: z.ZodOptional<z.ZodOptional<z.ZodString>>;
158
+ isServiceProfile: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodBoolean>>>;
159
+ notificationsWebhook: z.ZodOptional<z.ZodOptional<z.ZodString>>;
160
+ }, "strip", z.ZodTypeAny, {
161
+ image?: string | undefined;
162
+ email?: string | undefined;
163
+ profileId?: string | undefined;
164
+ displayName?: string | undefined;
165
+ did?: string | undefined;
166
+ isServiceProfile?: boolean | undefined;
167
+ notificationsWebhook?: string | undefined;
168
+ }, {
169
+ image?: string | undefined;
170
+ email?: string | undefined;
171
+ profileId?: string | undefined;
172
+ displayName?: string | undefined;
173
+ did?: string | undefined;
174
+ isServiceProfile?: boolean | undefined;
175
+ notificationsWebhook?: string | undefined;
176
+ }>, z.ZodObject<{
177
+ did: z.ZodString;
178
+ }, "strip", z.ZodTypeAny, {
179
+ did: string;
180
+ }, {
181
+ did: string;
182
+ }>>;
183
+ from: z.ZodIntersection<z.ZodObject<{
184
+ profileId: z.ZodOptional<z.ZodString>;
185
+ displayName: z.ZodOptional<z.ZodDefault<z.ZodString>>;
186
+ did: z.ZodOptional<z.ZodString>;
187
+ email: z.ZodOptional<z.ZodOptional<z.ZodString>>;
188
+ image: z.ZodOptional<z.ZodOptional<z.ZodString>>;
189
+ isServiceProfile: z.ZodOptional<z.ZodOptional<z.ZodDefault<z.ZodBoolean>>>;
190
+ notificationsWebhook: z.ZodOptional<z.ZodOptional<z.ZodString>>;
191
+ }, "strip", z.ZodTypeAny, {
192
+ image?: string | undefined;
193
+ email?: string | undefined;
194
+ profileId?: string | undefined;
195
+ displayName?: string | undefined;
196
+ did?: string | undefined;
197
+ isServiceProfile?: boolean | undefined;
198
+ notificationsWebhook?: string | undefined;
199
+ }, {
200
+ image?: string | undefined;
201
+ email?: string | undefined;
202
+ profileId?: string | undefined;
203
+ displayName?: string | undefined;
204
+ did?: string | undefined;
205
+ isServiceProfile?: boolean | undefined;
206
+ notificationsWebhook?: string | undefined;
207
+ }>, z.ZodObject<{
208
+ did: z.ZodString;
209
+ }, "strip", z.ZodTypeAny, {
210
+ did: string;
211
+ }, {
212
+ did: string;
213
+ }>>;
214
+ message: z.ZodOptional<z.ZodObject<{
215
+ title: z.ZodOptional<z.ZodString>;
216
+ body: z.ZodOptional<z.ZodString>;
217
+ }, "strip", z.ZodTypeAny, {
218
+ title?: string | undefined;
219
+ body?: string | undefined;
220
+ }, {
221
+ title?: string | undefined;
222
+ body?: string | undefined;
223
+ }>>;
224
+ data: z.ZodOptional<z.ZodObject<{
225
+ vcUris: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
226
+ vpUris: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
227
+ }, "strip", z.ZodTypeAny, {
228
+ vcUris?: string[] | undefined;
229
+ vpUris?: string[] | undefined;
230
+ }, {
231
+ vcUris?: string[] | undefined;
232
+ vpUris?: string[] | undefined;
233
+ }>>;
234
+ sent: z.ZodOptional<z.ZodString>;
235
+ }, "strip", z.ZodTypeAny, {
236
+ message?: {
237
+ title?: string | undefined;
238
+ body?: string | undefined;
239
+ } | undefined;
240
+ data?: {
241
+ vcUris?: string[] | undefined;
242
+ vpUris?: string[] | undefined;
243
+ } | undefined;
244
+ sent?: string | undefined;
245
+ type: "CONNECTION_REQUEST" | "CONNECTION_ACCEPTED" | "CREDENTIAL_RECEIVED" | "CREDENTIAL_ACCEPTED" | "BOOST_RECEIVED" | "BOOST_ACCEPTED" | "PRESENTATION_REQUEST" | "PRESENTATION_RECEIVED";
246
+ to: {
247
+ image?: string | undefined;
248
+ email?: string | undefined;
249
+ profileId?: string | undefined;
250
+ displayName?: string | undefined;
251
+ did?: string | undefined;
252
+ isServiceProfile?: boolean | undefined;
253
+ notificationsWebhook?: string | undefined;
254
+ } & {
255
+ did: string;
256
+ };
257
+ from: {
258
+ image?: string | undefined;
259
+ email?: string | undefined;
260
+ profileId?: string | undefined;
261
+ displayName?: string | undefined;
262
+ did?: string | undefined;
263
+ isServiceProfile?: boolean | undefined;
264
+ notificationsWebhook?: string | undefined;
265
+ } & {
266
+ did: string;
267
+ };
268
+ }, {
269
+ message?: {
270
+ title?: string | undefined;
271
+ body?: string | undefined;
272
+ } | undefined;
273
+ data?: {
274
+ vcUris?: string[] | undefined;
275
+ vpUris?: string[] | undefined;
276
+ } | undefined;
277
+ sent?: string | undefined;
278
+ type: "CONNECTION_REQUEST" | "CONNECTION_ACCEPTED" | "CREDENTIAL_RECEIVED" | "CREDENTIAL_ACCEPTED" | "BOOST_RECEIVED" | "BOOST_ACCEPTED" | "PRESENTATION_REQUEST" | "PRESENTATION_RECEIVED";
279
+ to: {
280
+ image?: string | undefined;
281
+ email?: string | undefined;
282
+ profileId?: string | undefined;
283
+ displayName?: string | undefined;
284
+ did?: string | undefined;
285
+ isServiceProfile?: boolean | undefined;
286
+ notificationsWebhook?: string | undefined;
287
+ } & {
288
+ did: string;
289
+ };
290
+ from: {
291
+ image?: string | undefined;
292
+ email?: string | undefined;
293
+ profileId?: string | undefined;
294
+ displayName?: string | undefined;
295
+ did?: string | undefined;
296
+ isServiceProfile?: boolean | undefined;
297
+ notificationsWebhook?: string | undefined;
298
+ } & {
299
+ did: string;
300
+ };
301
+ }>;
302
+ export type LCNNotification = z.infer<typeof LCNNotificationValidator>;
303
+ export declare const LCNBoostClaimLinkSigningAuthorityValidator: z.ZodObject<{
304
+ endpoint: z.ZodString;
305
+ name: z.ZodString;
306
+ did: z.ZodOptional<z.ZodString>;
307
+ }, "strip", z.ZodTypeAny, {
308
+ did?: string | undefined;
309
+ name: string;
310
+ endpoint: string;
311
+ }, {
312
+ did?: string | undefined;
313
+ name: string;
314
+ endpoint: string;
315
+ }>;
316
+ export type LCNBoostClaimLinkSigningAuthorityType = z.infer<typeof LCNBoostClaimLinkSigningAuthorityValidator>;
317
+ export declare const LCNBoostClaimLinkOptionsValidator: z.ZodObject<{
318
+ ttlSeconds: z.ZodOptional<z.ZodNumber>;
319
+ totalUses: z.ZodOptional<z.ZodNumber>;
320
+ }, "strip", z.ZodTypeAny, {
321
+ ttlSeconds?: number | undefined;
322
+ totalUses?: number | undefined;
323
+ }, {
324
+ ttlSeconds?: number | undefined;
325
+ totalUses?: number | undefined;
326
+ }>;
327
+ export type LCNBoostClaimLinkOptionsType = z.infer<typeof LCNBoostClaimLinkOptionsValidator>;
328
+ export declare const LCNSigningAuthorityValidator: z.ZodObject<{
329
+ endpoint: z.ZodString;
330
+ }, "strip", z.ZodTypeAny, {
331
+ endpoint: string;
332
+ }, {
333
+ endpoint: string;
334
+ }>;
335
+ export type LCNSigningAuthorityType = z.infer<typeof LCNSigningAuthorityValidator>;
336
+ export declare const LCNSigningAuthorityForUserValidator: z.ZodObject<{
337
+ signingAuthority: z.ZodObject<{
338
+ endpoint: z.ZodString;
339
+ }, "strip", z.ZodTypeAny, {
340
+ endpoint: string;
341
+ }, {
342
+ endpoint: string;
343
+ }>;
344
+ relationship: z.ZodObject<{
345
+ name: z.ZodString;
346
+ did: z.ZodString;
347
+ }, "strip", z.ZodTypeAny, {
348
+ name: string;
349
+ did: string;
350
+ }, {
351
+ name: string;
352
+ did: string;
353
+ }>;
354
+ }, "strip", z.ZodTypeAny, {
355
+ signingAuthority: {
356
+ endpoint: string;
357
+ };
358
+ relationship: {
359
+ name: string;
360
+ did: string;
361
+ };
362
+ }, {
363
+ signingAuthority: {
364
+ endpoint: string;
365
+ };
366
+ relationship: {
367
+ name: string;
368
+ did: string;
369
+ };
370
+ }>;
371
+ export type LCNSigningAuthorityForUserType = z.infer<typeof LCNSigningAuthorityForUserValidator>;