@learncard/types 5.18.0 → 5.18.2

package/dist/vc.d.ts

@@ -151,7 +151,7 @@ export declare const CredentialSubjectValidator: z.ZodObject<{
 export type CredentialSubject = z.infer<typeof CredentialSubjectValidator>;
 export declare const CredentialStatusValidator: z.ZodObject<{
     type: z.ZodString;
-    id: z.ZodString;
+    id: z.ZodOptional<z.ZodString>;
 }, z.core.$catchall<z.ZodAny>>;
 export type CredentialStatus = z.infer<typeof CredentialStatusValidator>;
 export declare const CredentialSchemaValidator: z.ZodObject<{
@@ -290,10 +290,10 @@ export declare const UnsignedVCValidator: z.ZodObject<{
     expirationDate: z.ZodOptional<z.ZodString>;
     credentialStatus: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
         type: z.ZodString;
-        id: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
     }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
         type: z.ZodString;
-        id: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
     }, z.core.$catchall<z.ZodAny>>>]>>;
     name: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
@@ -301,10 +301,10 @@ export declare const UnsignedVCValidator: z.ZodObject<{
     validUntil: z.ZodOptional<z.ZodString>;
     status: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
         type: z.ZodString;
-        id: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
     }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
         type: z.ZodString;
-        id: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
     }, z.core.$catchall<z.ZodAny>>>]>>;
     termsOfUse: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
         type: z.ZodString;
@@ -451,10 +451,10 @@ export declare const VCValidator: z.ZodObject<{
     expirationDate: z.ZodOptional<z.ZodString>;
     credentialStatus: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
         type: z.ZodString;
-        id: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
     }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
         type: z.ZodString;
-        id: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
     }, z.core.$catchall<z.ZodAny>>>]>>;
     name: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
@@ -462,10 +462,10 @@ export declare const VCValidator: z.ZodObject<{
     validUntil: z.ZodOptional<z.ZodString>;
     status: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
         type: z.ZodString;
-        id: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
     }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
         type: z.ZodString;
-        id: z.ZodString;
+        id: z.ZodOptional<z.ZodString>;
     }, z.core.$catchall<z.ZodAny>>>]>>;
     termsOfUse: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
         type: z.ZodString;
@@ -624,10 +624,10 @@ export declare const UnsignedVPValidator: z.ZodObject<{
         expirationDate: z.ZodOptional<z.ZodString>;
         credentialStatus: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>>]>>;
         name: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
@@ -635,10 +635,10 @@ export declare const UnsignedVPValidator: z.ZodObject<{
         validUntil: z.ZodOptional<z.ZodString>;
         status: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>>]>>;
         termsOfUse: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
@@ -791,10 +791,10 @@ export declare const UnsignedVPValidator: z.ZodObject<{
         expirationDate: z.ZodOptional<z.ZodString>;
         credentialStatus: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>>]>>;
         name: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
@@ -802,10 +802,10 @@ export declare const UnsignedVPValidator: z.ZodObject<{
         validUntil: z.ZodOptional<z.ZodString>;
         status: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>>]>>;
         termsOfUse: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
@@ -966,10 +966,10 @@ export declare const VPValidator: z.ZodObject<{
         expirationDate: z.ZodOptional<z.ZodString>;
         credentialStatus: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>>]>>;
         name: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
@@ -977,10 +977,10 @@ export declare const VPValidator: z.ZodObject<{
         validUntil: z.ZodOptional<z.ZodString>;
         status: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>>]>>;
         termsOfUse: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
@@ -1133,10 +1133,10 @@ export declare const VPValidator: z.ZodObject<{
         expirationDate: z.ZodOptional<z.ZodString>;
         credentialStatus: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>>]>>;
         name: z.ZodOptional<z.ZodString>;
         description: z.ZodOptional<z.ZodString>;
@@ -1144,10 +1144,10 @@ export declare const VPValidator: z.ZodObject<{
         validUntil: z.ZodOptional<z.ZodString>;
         status: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>, z.ZodArray<z.ZodObject<{
             type: z.ZodString;
-            id: z.ZodString;
+            id: z.ZodOptional<z.ZodString>;
         }, z.core.$catchall<z.ZodAny>>>]>>;
         termsOfUse: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
             type: z.ZodString;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@learncard/types",
-    "version": "5.18.0",
+    "version": "5.18.2",
     "description": "Shared types for learn card",
     "type": "module",
     "main": "./dist/index.cjs",

package/src/bitstring-status-list.ts

@@ -10,7 +10,7 @@ export const BitstringStatusListEntryValidator = z.object({
     id: z.string().optional(),
     type: z.literal('BitstringStatusListEntry'),
     statusPurpose: BitstringStatusPurposeValidator,
-    statusListIndex: z.string(),
+    statusListIndex: z.string().or(z.number().int().nonnegative()),
     statusListCredential: z.string(),
 });
 export type BitstringStatusListEntry = z.infer<typeof BitstringStatusListEntryValidator>;

package/src/lcn.ts

@@ -102,6 +102,47 @@ export const LCNPublicProfileValidator = LCNProfileValidator.pick({
 });
 export type LCNPublicProfile = z.infer<typeof LCNPublicProfileValidator>;
 
+export const LCNConnectionPromptStatusValidator = z.enum(['PENDING', 'SKIPPED', 'CONNECTED']);
+export type LCNConnectionPromptStatus = z.infer<typeof LCNConnectionPromptStatusValidator>;
+
+export const LCNConnectionPromptSurfaceValidator = z.enum(['POST_CLAIM', 'NOTIFICATION']);
+export type LCNConnectionPromptSurface = z.infer<typeof LCNConnectionPromptSurfaceValidator>;
+
+export const LCNConnectionPromptActionStatusValidator = z.enum([
+    'PENDING',
+    'SKIPPED',
+    'CONNECTED',
+    'STALE',
+]);
+export type LCNConnectionPromptActionStatus = z.infer<
+    typeof LCNConnectionPromptActionStatusValidator
+>;
+
+export const LCNConnectionPromptValidator = z.object({
+    promptId: z.string().uuid(),
+    status: LCNConnectionPromptStatusValidator,
+    surface: LCNConnectionPromptSurfaceValidator,
+    triggerId: z.string(),
+    triggeredAt: z.iso.datetime(),
+    updatedAt: z.iso.datetime(),
+    counterpart: LCNPublicProfileValidator,
+});
+export type LCNConnectionPrompt = z.infer<typeof LCNConnectionPromptValidator>;
+
+export const LCNConnectionPromptActionResultValidator = z.object({
+    promptId: z.string().uuid(),
+    status: LCNConnectionPromptActionStatusValidator,
+});
+export type LCNConnectionPromptActionResult = z.infer<
+    typeof LCNConnectionPromptActionResultValidator
+>;
+
+export const LCNConnectionPromptMetadataValidator = z.object({
+    promptId: z.string().uuid(),
+    counterpartProfileId: z.string(),
+});
+export type LCNConnectionPromptMetadata = z.infer<typeof LCNConnectionPromptMetadataValidator>;
+
 export const LCNAuthedProfileValidator = LCNPublicProfileValidator.extend({
     bio: LCNProfileValidator.shape.bio,
     websiteLink: LCNProfileValidator.shape.websiteLink,
@@ -966,13 +1007,20 @@ export const LCNNotificationInboxValidator = z.object({
 
 export type LCNNotificationInbox = z.infer<typeof LCNNotificationInboxValidator>;
 
+export const LCNNotificationMetadataValidator = z
+    .object({
+        connectionPrompt: LCNConnectionPromptMetadataValidator.optional(),
+    })
+    .catchall(z.unknown());
+export type LCNNotificationMetadata = z.infer<typeof LCNNotificationMetadataValidator>;
+
 export const LCNNotificationDataValidator = z
     .object({
         vcUris: z.array(z.string()).optional(),
         vpUris: z.array(z.string()).optional(),
         transaction: ConsentFlowTransactionValidator.optional(),
         inbox: LCNNotificationInboxValidator.optional(),
-        metadata: z.record(z.string(), z.unknown()).optional(),
+        metadata: LCNNotificationMetadataValidator.optional(),
     })
     .loose();
 export type LCNNotificationData = z.infer<typeof LCNNotificationDataValidator>;

package/src/learncard.ts

@@ -44,8 +44,17 @@ export const StatusCheckEntryValidator = z.object({
 export type StatusCheckEntry = z.infer<typeof StatusCheckEntryValidator>;
 
 export const VerificationCheckValidator = z.object({
+    /**
+     * Checks that completed successfully. This does not imply that warnings can be ignored.
+     */
     checks: z.string().array(),
+    /**
+     * Security-relevant conditions that did not prevent the requested cryptographic checks from
+     * completing. In particular, a non-DID issuer warning means the signature is valid but the
+     * named URL issuer's authorization of that signing key was not established.
+     */
     warnings: z.string().array(),
+    /** Verification failures that prevented one or more requested checks from succeeding. */
     errors: z.string().array(),
     /**
      * Per-entry results for the `credentialStatus` check, populated

package/src/vc.ts

@@ -102,7 +102,7 @@ export const CredentialSubjectValidator = z.object({ id: z.string().optional() }
 export type CredentialSubject = z.infer<typeof CredentialSubjectValidator>;
 
 export const CredentialStatusValidator = z
-    .object({ type: z.string(), id: z.string() })
+    .object({ type: z.string(), id: z.string().optional() })
     .catchall(z.any());
 export type CredentialStatus = z.infer<typeof CredentialStatusValidator>;