@sd-jwt/sd-jwt-vc 0.18.1 → 0.18.2-next.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.
package/dist/index.d.mts CHANGED
@@ -2,6 +2,13 @@ import { SDJWTConfig, Verifier, kbPayload, kbHeader, DisclosureFrame } from '@sd
2
2
  import { z } from 'zod';
3
3
  import { SdJwtPayload, SDJwtInstance, VerifierOptions } from '@sd-jwt/core';
4
4
 
5
+ declare const BackgroundImageSchema: z.ZodObject<{
6
+ /** REQUIRED. A URI pointing to the background image. */
7
+ uri: z.ZodString;
8
+ /** OPTIONAL. An "integrity metadata" string as described in Section 7. */
9
+ 'uri#integrity': z.ZodOptional<z.ZodString>;
10
+ }, z.core.$loose>;
11
+ type BackgroundImage = z.infer<typeof BackgroundImageSchema>;
5
12
  /**
6
13
  * Logo metadata used in rendering a credential.
7
14
  */
@@ -31,6 +38,13 @@ declare const SimpleRenderingSchema: z.ZodObject<{
31
38
  background_color: z.ZodOptional<z.ZodString>;
32
39
  /** OPTIONAL. RGB color value for the credential text (e.g., "#000000"). */
33
40
  text_color: z.ZodOptional<z.ZodString>;
41
+ /** OPTIONAL. An object containing information about the background image to be displayed for the type. */
42
+ background_image: z.ZodOptional<z.ZodObject<{
43
+ /** REQUIRED. A URI pointing to the background image. */
44
+ uri: z.ZodString;
45
+ /** OPTIONAL. An "integrity metadata" string as described in Section 7. */
46
+ 'uri#integrity': z.ZodOptional<z.ZodString>;
47
+ }, z.core.$loose>>;
34
48
  }, z.core.$loose>;
35
49
  type SimpleRendering = z.infer<typeof SimpleRenderingSchema>;
36
50
  /** Enum of valid values for rendering orientation. */
@@ -100,7 +114,7 @@ type SvgTemplateRendering = z.infer<typeof SvgTemplateRenderingSchema>;
100
114
  /**
101
115
  * Rendering metadata, either simple or SVG-based, for a credential.
102
116
  */
103
- declare const RenderingSchema: z.ZodObject<{
117
+ declare const RenderingSchema: z.ZodPipe<z.ZodObject<{
104
118
  /** OPTIONAL. Simple rendering metadata. */
105
119
  simple: z.ZodOptional<z.ZodObject<{
106
120
  /** OPTIONAL. Logo metadata to display for the credential. */
@@ -116,8 +130,43 @@ declare const RenderingSchema: z.ZodObject<{
116
130
  background_color: z.ZodOptional<z.ZodString>;
117
131
  /** OPTIONAL. RGB color value for the credential text (e.g., "#000000"). */
118
132
  text_color: z.ZodOptional<z.ZodString>;
133
+ /** OPTIONAL. An object containing information about the background image to be displayed for the type. */
134
+ background_image: z.ZodOptional<z.ZodObject<{
135
+ /** REQUIRED. A URI pointing to the background image. */
136
+ uri: z.ZodString;
137
+ /** OPTIONAL. An "integrity metadata" string as described in Section 7. */
138
+ 'uri#integrity': z.ZodOptional<z.ZodString>;
139
+ }, z.core.$loose>>;
119
140
  }, z.core.$loose>>;
120
141
  /** OPTIONAL. Array of SVG template rendering objects. */
142
+ svg_templates: z.ZodOptional<z.ZodArray<z.ZodObject<{
143
+ /** REQUIRED. A URI pointing to the SVG template. */
144
+ uri: z.ZodString;
145
+ /** OPTIONAL. An "integrity metadata" string as described in Section 7. */
146
+ 'uri#integrity': z.ZodOptional<z.ZodString>;
147
+ /** REQUIRED if more than one SVG template is present. */
148
+ properties: z.ZodOptional<z.ZodObject<{
149
+ /** OPTIONAL. Orientation optimized for the template. */
150
+ orientation: z.ZodOptional<z.ZodEnum<{
151
+ portrait: "portrait";
152
+ landscape: "landscape";
153
+ }>>;
154
+ /** OPTIONAL. Color scheme optimized for the template. */
155
+ color_scheme: z.ZodOptional<z.ZodEnum<{
156
+ light: "light";
157
+ dark: "dark";
158
+ }>>;
159
+ /** OPTIONAL. Contrast level optimized for the template. */
160
+ contrast: z.ZodOptional<z.ZodEnum<{
161
+ normal: "normal";
162
+ high: "high";
163
+ }>>;
164
+ }, z.core.$loose>>;
165
+ }, z.core.$loose>>>;
166
+ /**
167
+ * OPTIONAL. Array of SVG template rendering objects.
168
+ * @deprecated use `svg_templates` (plural) instead.
169
+ */
121
170
  svg_template: z.ZodOptional<z.ZodArray<z.ZodObject<{
122
171
  /** REQUIRED. A URI pointing to the SVG template. */
123
172
  uri: z.ZodString;
@@ -142,20 +191,96 @@ declare const RenderingSchema: z.ZodObject<{
142
191
  }>>;
143
192
  }, z.core.$loose>>;
144
193
  }, z.core.$loose>>>;
145
- }, z.core.$loose>;
194
+ }, z.core.$loose>, z.ZodTransform<{
195
+ svg_templates: {
196
+ [x: string]: unknown;
197
+ uri: string;
198
+ 'uri#integrity'?: string | undefined;
199
+ properties?: {
200
+ [x: string]: unknown;
201
+ orientation?: "portrait" | "landscape" | undefined;
202
+ color_scheme?: "light" | "dark" | undefined;
203
+ contrast?: "normal" | "high" | undefined;
204
+ } | undefined;
205
+ }[] | undefined;
206
+ simple?: {
207
+ [x: string]: unknown;
208
+ logo?: {
209
+ [x: string]: unknown;
210
+ uri: string;
211
+ 'uri#integrity'?: string | undefined;
212
+ alt_text?: string | undefined;
213
+ } | undefined;
214
+ background_color?: string | undefined;
215
+ text_color?: string | undefined;
216
+ background_image?: {
217
+ [x: string]: unknown;
218
+ uri: string;
219
+ 'uri#integrity'?: string | undefined;
220
+ } | undefined;
221
+ } | undefined;
222
+ }, {
223
+ [x: string]: unknown;
224
+ simple?: {
225
+ [x: string]: unknown;
226
+ logo?: {
227
+ [x: string]: unknown;
228
+ uri: string;
229
+ 'uri#integrity'?: string | undefined;
230
+ alt_text?: string | undefined;
231
+ } | undefined;
232
+ background_color?: string | undefined;
233
+ text_color?: string | undefined;
234
+ background_image?: {
235
+ [x: string]: unknown;
236
+ uri: string;
237
+ 'uri#integrity'?: string | undefined;
238
+ } | undefined;
239
+ } | undefined;
240
+ svg_templates?: {
241
+ [x: string]: unknown;
242
+ uri: string;
243
+ 'uri#integrity'?: string | undefined;
244
+ properties?: {
245
+ [x: string]: unknown;
246
+ orientation?: "portrait" | "landscape" | undefined;
247
+ color_scheme?: "light" | "dark" | undefined;
248
+ contrast?: "normal" | "high" | undefined;
249
+ } | undefined;
250
+ }[] | undefined;
251
+ svg_template?: {
252
+ [x: string]: unknown;
253
+ uri: string;
254
+ 'uri#integrity'?: string | undefined;
255
+ properties?: {
256
+ [x: string]: unknown;
257
+ orientation?: "portrait" | "landscape" | undefined;
258
+ color_scheme?: "light" | "dark" | undefined;
259
+ contrast?: "normal" | "high" | undefined;
260
+ } | undefined;
261
+ }[] | undefined;
262
+ }>>;
146
263
  type Rendering = z.infer<typeof RenderingSchema>;
147
264
  /**
148
265
  * Display metadata associated with a credential type.
149
266
  */
150
- declare const DisplaySchema: z.ZodObject<{
151
- /** REQUIRED. Language tag according to RFC 5646 (e.g., "en", "de"). */
152
- lang: z.ZodString;
267
+ declare const DisplaySchema: z.ZodPipe<z.ZodObject<{
268
+ /**
269
+ * Language tag according to RFC 5646 (e.g., "en", "de").
270
+ * @deprecated - use `locale` instead
271
+ */
272
+ lang: z.ZodOptional<z.ZodString>;
273
+ /**
274
+ * REQUIRED (preferred). Language tag according to RFC 5646.
275
+ * Alias for `lang` - either `lang` or `locale` must be provided.
276
+ */
277
+ locale: z.ZodOptional<z.ZodString>;
153
278
  /** REQUIRED. Human-readable name for the credential type. */
154
279
  name: z.ZodString;
155
280
  /** OPTIONAL. Description of the credential type for end users. */
156
281
  description: z.ZodOptional<z.ZodString>;
157
282
  /** OPTIONAL. Rendering information (simple or SVG) for the credential. */
158
- rendering: z.ZodOptional<z.ZodObject<{
283
+ rendering: z.ZodOptional<z.ZodPipe<z.ZodObject<{
159
284
  /** OPTIONAL. Simple rendering metadata. */
160
285
  simple: z.ZodOptional<z.ZodObject<{
161
286
  /** OPTIONAL. Logo metadata to display for the credential. */
@@ -171,8 +296,43 @@ declare const DisplaySchema: z.ZodObject<{
171
296
  background_color: z.ZodOptional<z.ZodString>;
172
297
  /** OPTIONAL. RGB color value for the credential text (e.g., "#000000"). */
173
298
  text_color: z.ZodOptional<z.ZodString>;
299
+ /** OPTIONAL. An object containing information about the background image to be displayed for the type. */
300
+ background_image: z.ZodOptional<z.ZodObject<{
301
+ /** REQUIRED. A URI pointing to the background image. */
302
+ uri: z.ZodString;
303
+ /** OPTIONAL. An "integrity metadata" string as described in Section 7. */
304
+ 'uri#integrity': z.ZodOptional<z.ZodString>;
305
+ }, z.core.$loose>>;
174
306
  }, z.core.$loose>>;
175
307
  /** OPTIONAL. Array of SVG template rendering objects. */
308
+ svg_templates: z.ZodOptional<z.ZodArray<z.ZodObject<{
309
+ /** REQUIRED. A URI pointing to the SVG template. */
310
+ uri: z.ZodString;
311
+ /** OPTIONAL. An "integrity metadata" string as described in Section 7. */
312
+ 'uri#integrity': z.ZodOptional<z.ZodString>;
313
+ /** REQUIRED if more than one SVG template is present. */
314
+ properties: z.ZodOptional<z.ZodObject<{
315
+ /** OPTIONAL. Orientation optimized for the template. */
316
+ orientation: z.ZodOptional<z.ZodEnum<{
317
+ portrait: "portrait";
318
+ landscape: "landscape";
319
+ }>>;
320
+ /** OPTIONAL. Color scheme optimized for the template. */
321
+ color_scheme: z.ZodOptional<z.ZodEnum<{
322
+ light: "light";
323
+ dark: "dark";
324
+ }>>;
325
+ /** OPTIONAL. Contrast level optimized for the template. */
326
+ contrast: z.ZodOptional<z.ZodEnum<{
327
+ normal: "normal";
328
+ high: "high";
329
+ }>>;
330
+ }, z.core.$loose>>;
331
+ }, z.core.$loose>>>;
332
+ /**
333
+ * OPTIONAL. Array of SVG template rendering objects.
334
+ * @deprecated use `svg_templates` (plural) instead.
335
+ */
176
336
  svg_template: z.ZodOptional<z.ZodArray<z.ZodObject<{
177
337
  /** REQUIRED. A URI pointing to the SVG template. */
178
338
  uri: z.ZodString;
@@ -197,8 +357,144 @@ declare const DisplaySchema: z.ZodObject<{
197
357
  }>>;
198
358
  }, z.core.$loose>>;
199
359
  }, z.core.$loose>>>;
200
- }, z.core.$loose>>;
201
- }, z.core.$loose>;
360
+ }, z.core.$loose>, z.ZodTransform<{
361
+ svg_templates: {
362
+ [x: string]: unknown;
363
+ uri: string;
364
+ 'uri#integrity'?: string | undefined;
365
+ properties?: {
366
+ [x: string]: unknown;
367
+ orientation?: "portrait" | "landscape" | undefined;
368
+ color_scheme?: "light" | "dark" | undefined;
369
+ contrast?: "normal" | "high" | undefined;
370
+ } | undefined;
371
+ }[] | undefined;
372
+ simple?: {
373
+ [x: string]: unknown;
374
+ logo?: {
375
+ [x: string]: unknown;
376
+ uri: string;
377
+ 'uri#integrity'?: string | undefined;
378
+ alt_text?: string | undefined;
379
+ } | undefined;
380
+ background_color?: string | undefined;
381
+ text_color?: string | undefined;
382
+ background_image?: {
383
+ [x: string]: unknown;
384
+ uri: string;
385
+ 'uri#integrity'?: string | undefined;
386
+ } | undefined;
387
+ } | undefined;
388
+ }, {
389
+ [x: string]: unknown;
390
+ simple?: {
391
+ [x: string]: unknown;
392
+ logo?: {
393
+ [x: string]: unknown;
394
+ uri: string;
395
+ 'uri#integrity'?: string | undefined;
396
+ alt_text?: string | undefined;
397
+ } | undefined;
398
+ background_color?: string | undefined;
399
+ text_color?: string | undefined;
400
+ background_image?: {
401
+ [x: string]: unknown;
402
+ uri: string;
403
+ 'uri#integrity'?: string | undefined;
404
+ } | undefined;
405
+ } | undefined;
406
+ svg_templates?: {
407
+ [x: string]: unknown;
408
+ uri: string;
409
+ 'uri#integrity'?: string | undefined;
410
+ properties?: {
411
+ [x: string]: unknown;
412
+ orientation?: "portrait" | "landscape" | undefined;
413
+ color_scheme?: "light" | "dark" | undefined;
414
+ contrast?: "normal" | "high" | undefined;
415
+ } | undefined;
416
+ }[] | undefined;
417
+ svg_template?: {
418
+ [x: string]: unknown;
419
+ uri: string;
420
+ 'uri#integrity'?: string | undefined;
421
+ properties?: {
422
+ [x: string]: unknown;
423
+ orientation?: "portrait" | "landscape" | undefined;
424
+ color_scheme?: "light" | "dark" | undefined;
425
+ contrast?: "normal" | "high" | undefined;
426
+ } | undefined;
427
+ }[] | undefined;
428
+ }>>>;
429
+ }, z.core.$loose>, z.ZodTransform<{
430
+ locale: string | undefined;
431
+ name: string;
432
+ description?: string | undefined;
433
+ rendering?: {
434
+ svg_templates: {
435
+ [x: string]: unknown;
436
+ uri: string;
437
+ 'uri#integrity'?: string | undefined;
438
+ properties?: {
439
+ [x: string]: unknown;
440
+ orientation?: "portrait" | "landscape" | undefined;
441
+ color_scheme?: "light" | "dark" | undefined;
442
+ contrast?: "normal" | "high" | undefined;
443
+ } | undefined;
444
+ }[] | undefined;
445
+ simple?: {
446
+ [x: string]: unknown;
447
+ logo?: {
448
+ [x: string]: unknown;
449
+ uri: string;
450
+ 'uri#integrity'?: string | undefined;
451
+ alt_text?: string | undefined;
452
+ } | undefined;
453
+ background_color?: string | undefined;
454
+ text_color?: string | undefined;
455
+ background_image?: {
456
+ [x: string]: unknown;
457
+ uri: string;
458
+ 'uri#integrity'?: string | undefined;
459
+ } | undefined;
460
+ } | undefined;
461
+ } | undefined;
462
+ }, {
463
+ [x: string]: unknown;
464
+ name: string;
465
+ lang?: string | undefined;
466
+ locale?: string | undefined;
467
+ description?: string | undefined;
468
+ rendering?: {
469
+ svg_templates: {
470
+ [x: string]: unknown;
471
+ uri: string;
472
+ 'uri#integrity'?: string | undefined;
473
+ properties?: {
474
+ [x: string]: unknown;
475
+ orientation?: "portrait" | "landscape" | undefined;
476
+ color_scheme?: "light" | "dark" | undefined;
477
+ contrast?: "normal" | "high" | undefined;
478
+ } | undefined;
479
+ }[] | undefined;
480
+ simple?: {
481
+ [x: string]: unknown;
482
+ logo?: {
483
+ [x: string]: unknown;
484
+ uri: string;
485
+ 'uri#integrity'?: string | undefined;
486
+ alt_text?: string | undefined;
487
+ } | undefined;
488
+ background_color?: string | undefined;
489
+ text_color?: string | undefined;
490
+ background_image?: {
491
+ [x: string]: unknown;
492
+ uri: string;
493
+ 'uri#integrity'?: string | undefined;
494
+ } | undefined;
495
+ } | undefined;
496
+ } | undefined;
497
+ }>>;
202
498
  type Display = z.infer<typeof DisplaySchema>;
203
499
  /**
204
500
  * Claim path within the credential's JSON structure.
@@ -209,14 +505,32 @@ type ClaimPath = z.infer<typeof ClaimPathSchema>;
209
505
  /**
210
506
  * Display metadata for a specific claim.
211
507
  */
212
- declare const ClaimDisplaySchema: z.ZodObject<{
213
- /** REQUIRED. Language tag according to RFC 5646. */
214
- lang: z.ZodString;
508
+ declare const ClaimDisplaySchema: z.ZodPipe<z.ZodObject<{
509
+ /**
510
+ * Language tag according to RFC 5646.
511
+ * @deprecated - use `locale` instead
512
+ */
513
+ lang: z.ZodOptional<z.ZodString>;
514
+ /**
515
+ * REQUIRED (preferred). Language tag according to RFC 5646.
516
+ * Alias for `lang` - either `lang` or `locale` must be provided.
517
+ */
518
+ locale: z.ZodOptional<z.ZodString>;
215
519
  /** REQUIRED. Human-readable label for the claim. */
216
520
  label: z.ZodString;
217
521
  /** OPTIONAL. Description of the claim for end users. */
218
522
  description: z.ZodOptional<z.ZodString>;
219
- }, z.core.$loose>;
523
+ }, z.core.$loose>, z.ZodTransform<{
524
+ locale: string | undefined;
525
+ label: string;
526
+ description?: string | undefined;
527
+ }, {
528
+ [x: string]: unknown;
529
+ label: string;
530
+ lang?: string | undefined;
531
+ locale?: string | undefined;
532
+ description?: string | undefined;
533
+ }>>;
220
534
  type ClaimDisplay = z.infer<typeof ClaimDisplaySchema>;
221
535
  /**
222
536
  * Indicates whether a claim is selectively disclosable.
@@ -237,20 +551,43 @@ declare const ClaimSchema: z.ZodObject<{
237
551
  */
238
552
  path: z.ZodArray<z.ZodNullable<z.ZodString>>;
239
553
  /** OPTIONAL. Display metadata in multiple languages. */
240
- display: z.ZodOptional<z.ZodArray<z.ZodObject<{
241
- /** REQUIRED. Language tag according to RFC 5646. */
242
- lang: z.ZodString;
554
+ display: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodObject<{
555
+ /**
556
+ * Language tag according to RFC 5646.
557
+ * @deprecated - use `locale` instead
558
+ */
559
+ lang: z.ZodOptional<z.ZodString>;
560
+ /**
561
+ * REQUIRED (preferred). Language tag according to RFC 5646.
562
+ * Alias for `lang` - either `lang` or `locale` must be provided.
563
+ */
564
+ locale: z.ZodOptional<z.ZodString>;
243
565
  /** REQUIRED. Human-readable label for the claim. */
244
566
  label: z.ZodString;
245
567
  /** OPTIONAL. Description of the claim for end users. */
246
568
  description: z.ZodOptional<z.ZodString>;
247
- }, z.core.$loose>>>;
569
+ }, z.core.$loose>, z.ZodTransform<{
570
+ locale: string | undefined;
571
+ label: string;
572
+ description?: string | undefined;
573
+ }, {
574
+ [x: string]: unknown;
575
+ label: string;
576
+ lang?: string | undefined;
577
+ locale?: string | undefined;
578
+ description?: string | undefined;
579
+ }>>>>;
248
580
  /** OPTIONAL. Controls whether the claim must, may, or must not be selectively disclosed. */
249
581
  sd: z.ZodOptional<z.ZodEnum<{
250
582
  never: "never";
251
583
  always: "always";
252
584
  allowed: "allowed";
253
585
  }>>;
586
+ /**
587
+ * OPTIONAL. A boolean indicating whether the claim must be present in the Unsecured Payload
588
+ * of the SD-JWT VC. Default is false if not specified.
589
+ */
590
+ mandatory: z.ZodOptional<z.ZodBoolean>;
254
591
  /**
255
592
  * OPTIONAL. Unique string identifier for referencing the claim in an SVG template.
256
593
  * Must consist of alphanumeric characters or underscores and must not start with a digit.
@@ -260,7 +597,7 @@ declare const ClaimSchema: z.ZodObject<{
260
597
  type Claim = z.infer<typeof ClaimSchema>;
261
598
  /**
262
599
  * Type metadata for a specific Verifiable Credential (VC) type.
263
- * Reference: https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-09.html#name-type-metadata-format
600
+ * Reference: https://www.ietf.org/archive/id/draft-ietf-oauth-sd-jwt-vc-13.html#name-type-metadata-format
264
601
  */
265
602
  declare const TypeMetadataFormatSchema: z.ZodObject<{
266
603
  /** REQUIRED. A URI uniquely identifying the credential type. */
@@ -274,15 +611,23 @@ declare const TypeMetadataFormatSchema: z.ZodObject<{
274
611
  /** OPTIONAL. Integrity metadata for the 'extends' field. */
275
612
  'extends#integrity': z.ZodOptional<z.ZodString>;
276
613
  /** OPTIONAL. Array of localized display metadata for the type. */
277
- display: z.ZodOptional<z.ZodArray<z.ZodObject<{
278
- /** REQUIRED. Language tag according to RFC 5646 (e.g., "en", "de"). */
279
- lang: z.ZodString;
614
+ display: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodObject<{
615
+ /**
616
+ * Language tag according to RFC 5646 (e.g., "en", "de").
617
+ * @deprecated - use `locale` instead
618
+ */
619
+ lang: z.ZodOptional<z.ZodString>;
620
+ /**
621
+ * REQUIRED (preferred). Language tag according to RFC 5646.
622
+ * Alias for `lang` - either `lang` or `locale` must be provided.
623
+ */
624
+ locale: z.ZodOptional<z.ZodString>;
280
625
  /** REQUIRED. Human-readable name for the credential type. */
281
626
  name: z.ZodString;
282
627
  /** OPTIONAL. Description of the credential type for end users. */
283
628
  description: z.ZodOptional<z.ZodString>;
284
629
  /** OPTIONAL. Rendering information (simple or SVG) for the credential. */
285
- rendering: z.ZodOptional<z.ZodObject<{
630
+ rendering: z.ZodOptional<z.ZodPipe<z.ZodObject<{
286
631
  /** OPTIONAL. Simple rendering metadata. */
287
632
  simple: z.ZodOptional<z.ZodObject<{
288
633
  /** OPTIONAL. Logo metadata to display for the credential. */
@@ -298,8 +643,43 @@ declare const TypeMetadataFormatSchema: z.ZodObject<{
298
643
  background_color: z.ZodOptional<z.ZodString>;
299
644
  /** OPTIONAL. RGB color value for the credential text (e.g., "#000000"). */
300
645
  text_color: z.ZodOptional<z.ZodString>;
646
+ /** OPTIONAL. An object containing information about the background image to be displayed for the type. */
647
+ background_image: z.ZodOptional<z.ZodObject<{
648
+ /** REQUIRED. A URI pointing to the background image. */
649
+ uri: z.ZodString;
650
+ /** OPTIONAL. An "integrity metadata" string as described in Section 7. */
651
+ 'uri#integrity': z.ZodOptional<z.ZodString>;
652
+ }, z.core.$loose>>;
301
653
  }, z.core.$loose>>;
302
654
  /** OPTIONAL. Array of SVG template rendering objects. */
655
+ svg_templates: z.ZodOptional<z.ZodArray<z.ZodObject<{
656
+ /** REQUIRED. A URI pointing to the SVG template. */
657
+ uri: z.ZodString;
658
+ /** OPTIONAL. An "integrity metadata" string as described in Section 7. */
659
+ 'uri#integrity': z.ZodOptional<z.ZodString>;
660
+ /** REQUIRED if more than one SVG template is present. */
661
+ properties: z.ZodOptional<z.ZodObject<{
662
+ /** OPTIONAL. Orientation optimized for the template. */
663
+ orientation: z.ZodOptional<z.ZodEnum<{
664
+ portrait: "portrait";
665
+ landscape: "landscape";
666
+ }>>;
667
+ /** OPTIONAL. Color scheme optimized for the template. */
668
+ color_scheme: z.ZodOptional<z.ZodEnum<{
669
+ light: "light";
670
+ dark: "dark";
671
+ }>>;
672
+ /** OPTIONAL. Contrast level optimized for the template. */
673
+ contrast: z.ZodOptional<z.ZodEnum<{
674
+ normal: "normal";
675
+ high: "high";
676
+ }>>;
677
+ }, z.core.$loose>>;
678
+ }, z.core.$loose>>>;
679
+ /**
680
+ * OPTIONAL. Array of SVG template rendering objects.
681
+ * @deprecated use `svg_templates` (plural) instead.
682
+ */
303
683
  svg_template: z.ZodOptional<z.ZodArray<z.ZodObject<{
304
684
  /** REQUIRED. A URI pointing to the SVG template. */
305
685
  uri: z.ZodString;
@@ -324,8 +704,144 @@ declare const TypeMetadataFormatSchema: z.ZodObject<{
324
704
  }>>;
325
705
  }, z.core.$loose>>;
326
706
  }, z.core.$loose>>>;
327
- }, z.core.$loose>>;
328
- }, z.core.$loose>>>;
707
+ }, z.core.$loose>, z.ZodTransform<{
708
+ svg_templates: {
709
+ [x: string]: unknown;
710
+ uri: string;
711
+ 'uri#integrity'?: string | undefined;
712
+ properties?: {
713
+ [x: string]: unknown;
714
+ orientation?: "portrait" | "landscape" | undefined;
715
+ color_scheme?: "light" | "dark" | undefined;
716
+ contrast?: "normal" | "high" | undefined;
717
+ } | undefined;
718
+ }[] | undefined;
719
+ simple?: {
720
+ [x: string]: unknown;
721
+ logo?: {
722
+ [x: string]: unknown;
723
+ uri: string;
724
+ 'uri#integrity'?: string | undefined;
725
+ alt_text?: string | undefined;
726
+ } | undefined;
727
+ background_color?: string | undefined;
728
+ text_color?: string | undefined;
729
+ background_image?: {
730
+ [x: string]: unknown;
731
+ uri: string;
732
+ 'uri#integrity'?: string | undefined;
733
+ } | undefined;
734
+ } | undefined;
735
+ }, {
736
+ [x: string]: unknown;
737
+ simple?: {
738
+ [x: string]: unknown;
739
+ logo?: {
740
+ [x: string]: unknown;
741
+ uri: string;
742
+ 'uri#integrity'?: string | undefined;
743
+ alt_text?: string | undefined;
744
+ } | undefined;
745
+ background_color?: string | undefined;
746
+ text_color?: string | undefined;
747
+ background_image?: {
748
+ [x: string]: unknown;
749
+ uri: string;
750
+ 'uri#integrity'?: string | undefined;
751
+ } | undefined;
752
+ } | undefined;
753
+ svg_templates?: {
754
+ [x: string]: unknown;
755
+ uri: string;
756
+ 'uri#integrity'?: string | undefined;
757
+ properties?: {
758
+ [x: string]: unknown;
759
+ orientation?: "portrait" | "landscape" | undefined;
760
+ color_scheme?: "light" | "dark" | undefined;
761
+ contrast?: "normal" | "high" | undefined;
762
+ } | undefined;
763
+ }[] | undefined;
764
+ svg_template?: {
765
+ [x: string]: unknown;
766
+ uri: string;
767
+ 'uri#integrity'?: string | undefined;
768
+ properties?: {
769
+ [x: string]: unknown;
770
+ orientation?: "portrait" | "landscape" | undefined;
771
+ color_scheme?: "light" | "dark" | undefined;
772
+ contrast?: "normal" | "high" | undefined;
773
+ } | undefined;
774
+ }[] | undefined;
775
+ }>>>;
776
+ }, z.core.$loose>, z.ZodTransform<{
777
+ locale: string | undefined;
778
+ name: string;
779
+ description?: string | undefined;
780
+ rendering?: {
781
+ svg_templates: {
782
+ [x: string]: unknown;
783
+ uri: string;
784
+ 'uri#integrity'?: string | undefined;
785
+ properties?: {
786
+ [x: string]: unknown;
787
+ orientation?: "portrait" | "landscape" | undefined;
788
+ color_scheme?: "light" | "dark" | undefined;
789
+ contrast?: "normal" | "high" | undefined;
790
+ } | undefined;
791
+ }[] | undefined;
792
+ simple?: {
793
+ [x: string]: unknown;
794
+ logo?: {
795
+ [x: string]: unknown;
796
+ uri: string;
797
+ 'uri#integrity'?: string | undefined;
798
+ alt_text?: string | undefined;
799
+ } | undefined;
800
+ background_color?: string | undefined;
801
+ text_color?: string | undefined;
802
+ background_image?: {
803
+ [x: string]: unknown;
804
+ uri: string;
805
+ 'uri#integrity'?: string | undefined;
806
+ } | undefined;
807
+ } | undefined;
808
+ } | undefined;
809
+ }, {
810
+ [x: string]: unknown;
811
+ name: string;
812
+ lang?: string | undefined;
813
+ locale?: string | undefined;
814
+ description?: string | undefined;
815
+ rendering?: {
816
+ svg_templates: {
817
+ [x: string]: unknown;
818
+ uri: string;
819
+ 'uri#integrity'?: string | undefined;
820
+ properties?: {
821
+ [x: string]: unknown;
822
+ orientation?: "portrait" | "landscape" | undefined;
823
+ color_scheme?: "light" | "dark" | undefined;
824
+ contrast?: "normal" | "high" | undefined;
825
+ } | undefined;
826
+ }[] | undefined;
827
+ simple?: {
828
+ [x: string]: unknown;
829
+ logo?: {
830
+ [x: string]: unknown;
831
+ uri: string;
832
+ 'uri#integrity'?: string | undefined;
833
+ alt_text?: string | undefined;
834
+ } | undefined;
835
+ background_color?: string | undefined;
836
+ text_color?: string | undefined;
837
+ background_image?: {
838
+ [x: string]: unknown;
839
+ uri: string;
840
+ 'uri#integrity'?: string | undefined;
841
+ } | undefined;
842
+ } | undefined;
843
+ } | undefined;
844
+ }>>>>;
329
845
  /** OPTIONAL. Array of claim metadata. */
330
846
  claims: z.ZodOptional<z.ZodArray<z.ZodObject<{
331
847
  /**
@@ -334,20 +850,43 @@ declare const TypeMetadataFormatSchema: z.ZodObject<{
334
850
  */
335
851
  path: z.ZodArray<z.ZodNullable<z.ZodString>>;
336
852
  /** OPTIONAL. Display metadata in multiple languages. */
337
- display: z.ZodOptional<z.ZodArray<z.ZodObject<{
338
- /** REQUIRED. Language tag according to RFC 5646. */
339
- lang: z.ZodString;
853
+ display: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodObject<{
854
+ /**
855
+ * Language tag according to RFC 5646.
856
+ * @deprecated - use `locale` instead
857
+ */
858
+ lang: z.ZodOptional<z.ZodString>;
859
+ /**
860
+ * REQUIRED (preferred). Language tag according to RFC 5646.
861
+ * Alias for `lang` - either `lang` or `locale` must be provided.
862
+ */
863
+ locale: z.ZodOptional<z.ZodString>;
340
864
  /** REQUIRED. Human-readable label for the claim. */
341
865
  label: z.ZodString;
342
866
  /** OPTIONAL. Description of the claim for end users. */
343
867
  description: z.ZodOptional<z.ZodString>;
344
- }, z.core.$loose>>>;
868
+ }, z.core.$loose>, z.ZodTransform<{
869
+ locale: string | undefined;
870
+ label: string;
871
+ description?: string | undefined;
872
+ }, {
873
+ [x: string]: unknown;
874
+ label: string;
875
+ lang?: string | undefined;
876
+ locale?: string | undefined;
877
+ description?: string | undefined;
878
+ }>>>>;
345
879
  /** OPTIONAL. Controls whether the claim must, may, or must not be selectively disclosed. */
346
880
  sd: z.ZodOptional<z.ZodEnum<{
347
881
  never: "never";
348
882
  always: "always";
349
883
  allowed: "allowed";
350
884
  }>>;
885
+ /**
886
+ * OPTIONAL. A boolean indicating whether the claim must be present in the Unsecured Payload
887
+ * of the SD-JWT VC. Default is false if not specified.
888
+ */
889
+ mandatory: z.ZodOptional<z.ZodBoolean>;
351
890
  /**
352
891
  * OPTIONAL. Unique string identifier for referencing the claim in an SVG template.
353
892
  * Must consist of alphanumeric characters or underscores and must not start with a digit.
@@ -536,4 +1075,4 @@ declare class SDJwtVcInstance extends SDJwtInstance<SdJwtVcPayload> {
536
1075
  private verifyStatus;
537
1076
  }
538
1077
 
539
- export { type Claim, type ClaimDisplay, ClaimDisplaySchema, type ClaimPath, ClaimPathSchema, ClaimSchema, type ClaimSelectiveDisclosure, ClaimSelectiveDisclosureSchema, ColorSchemeSchema, ContrastSchema, type Display, DisplaySchema, type Logo, LogoSchema, OrientationSchema, type Rendering, RenderingSchema, type ResolvedTypeMetadata, type SDJWTVCConfig, type SDJWTVCStatusReference, SDJwtVcInstance, type SdJwtVcPayload, type SimpleRendering, SimpleRenderingSchema, type StatusListFetcher, type StatusValidator, type SvgTemplateProperties, SvgTemplatePropertiesSchema, type SvgTemplateRendering, SvgTemplateRenderingSchema, type TypeMetadataFormat, TypeMetadataFormatSchema, type VcTFetcher, type VerificationResult };
1078
+ export { type BackgroundImage, BackgroundImageSchema, type Claim, type ClaimDisplay, ClaimDisplaySchema, type ClaimPath, ClaimPathSchema, ClaimSchema, type ClaimSelectiveDisclosure, ClaimSelectiveDisclosureSchema, ColorSchemeSchema, ContrastSchema, type Display, DisplaySchema, type Logo, LogoSchema, OrientationSchema, type Rendering, RenderingSchema, type ResolvedTypeMetadata, type SDJWTVCConfig, type SDJWTVCStatusReference, SDJwtVcInstance, type SdJwtVcPayload, type SimpleRendering, SimpleRenderingSchema, type StatusListFetcher, type StatusValidator, type SvgTemplateProperties, SvgTemplatePropertiesSchema, type SvgTemplateRendering, SvgTemplateRenderingSchema, type TypeMetadataFormat, TypeMetadataFormatSchema, type VcTFetcher, type VerificationResult };