@learncard/helpers 1.1.18 → 1.1.20

package/dist/helpers.cjs.development.js

@@ -71,6 +71,7 @@ var require_types_cjs_development = __commonJS({
       ClaimHookQueryValidator: () => ClaimHookQueryValidator,
       ClaimHookTypeValidator: () => ClaimHookTypeValidator,
       ClaimHookValidator: () => ClaimHookValidator,
+      ClaimTokenValidator: () => ClaimTokenValidator,
       ConsentFlowContractDataForDidValidator: () => ConsentFlowContractDataForDidValidator,
       ConsentFlowContractDataValidator: () => ConsentFlowContractDataValidator,
       ConsentFlowContractDetailsValidator: () => ConsentFlowContractDetailsValidator,
@@ -85,6 +86,11 @@ var require_types_cjs_development = __commonJS({
       ConsentFlowTransactionActionValidator: () => ConsentFlowTransactionActionValidator,
       ConsentFlowTransactionValidator: () => ConsentFlowTransactionValidator,
       ConsentFlowTransactionsQueryValidator: () => ConsentFlowTransactionsQueryValidator,
+      ContactMethodCreateValidator: () => ContactMethodCreateValidator,
+      ContactMethodQueryValidator: () => ContactMethodQueryValidator,
+      ContactMethodValidator: () => ContactMethodValidator,
+      ContactMethodVerificationRequestValidator: () => ContactMethodVerificationRequestValidator,
+      ContactMethodVerificationValidator: () => ContactMethodVerificationValidator,
       ContextValidator: () => ContextValidator,
       ContractCredentialValidator: () => ContractCredentialValidator,
       CredentialInfoValidator: () => CredentialInfoValidator,
@@ -106,6 +112,11 @@ var require_types_cjs_development = __commonJS({
       IdentifierTypeValidator: () => IdentifierTypeValidator,
       IdentityObjectValidator: () => IdentityObjectValidator,
       ImageValidator: () => ImageValidator,
+      InboxCredentialQueryValidator: () => InboxCredentialQueryValidator,
+      InboxCredentialValidator: () => InboxCredentialValidator,
+      IssueInboxCredentialResponseValidator: () => IssueInboxCredentialResponseValidator,
+      IssueInboxCredentialValidator: () => IssueInboxCredentialValidator,
+      IssueInboxSigningAuthorityValidator: () => IssueInboxSigningAuthorityValidator,
       JWERecipientHeaderValidator: () => JWERecipientHeaderValidator,
       JWERecipientValidator: () => JWERecipientValidator,
       JWEValidator: () => JWEValidator2,
@@ -115,7 +126,10 @@ var require_types_cjs_development = __commonJS({
       LCNBoostClaimLinkOptionsValidator: () => LCNBoostClaimLinkOptionsValidator,
       LCNBoostClaimLinkSigningAuthorityValidator: () => LCNBoostClaimLinkSigningAuthorityValidator,
       LCNBoostStatus: () => LCNBoostStatus,
+      LCNInboxContactMethodValidator: () => LCNInboxContactMethodValidator,
+      LCNInboxStatusEnumValidator: () => LCNInboxStatusEnumValidator,
       LCNNotificationDataValidator: () => LCNNotificationDataValidator,
+      LCNNotificationInboxValidator: () => LCNNotificationInboxValidator,
       LCNNotificationMessageValidator: () => LCNNotificationMessageValidator,
       LCNNotificationTypeEnumValidator: () => LCNNotificationTypeEnumValidator,
       LCNNotificationValidator: () => LCNNotificationValidator,
@@ -138,6 +152,7 @@ var require_types_cjs_development = __commonJS({
       PaginatedContractCredentialsValidator: () => PaginatedContractCredentialsValidator,
       PaginatedEncryptedCredentialRecordsValidator: () => PaginatedEncryptedCredentialRecordsValidator,
       PaginatedEncryptedRecordsValidator: () => PaginatedEncryptedRecordsValidator,
+      PaginatedInboxCredentialsValidator: () => PaginatedInboxCredentialsValidator,
       PaginatedLCNProfileManagersValidator: () => PaginatedLCNProfileManagersValidator,
       PaginatedLCNProfilesAndManagersValidator: () => PaginatedLCNProfilesAndManagersValidator,
       PaginatedLCNProfilesValidator: () => PaginatedLCNProfilesValidator,
@@ -155,6 +170,7 @@ var require_types_cjs_development = __commonJS({
       RubricCriterionValidator: () => RubricCriterionValidator,
       SentCredentialInfoValidator: () => SentCredentialInfoValidator,
       ServiceValidator: () => ServiceValidator,
+      SetPrimaryContactMethodValidator: () => SetPrimaryContactMethodValidator,
       StringQuery: () => StringQuery,
       TermsOfUseValidator: () => TermsOfUseValidator,
       UnsignedAchievementCredentialValidator: () => UnsignedAchievementCredentialValidator,
@@ -4639,7 +4655,7 @@ var require_types_cjs_development = __commonJS({
       bio: z.string().default("").describe("Longer bio for the profile."),
       did: z.string().describe("Decentralized Identifier for the profile. (auto-assigned)"),
       isPrivate: z.boolean().optional().describe("Whether the profile is private or not and shows up in search results."),
-      email: z.string().optional().describe("Contact email address for the profile."),
+      email: z.string().optional().describe("Contact email address for the profile. (deprecated)"),
       image: z.string().optional().describe("Profile image URL for the profile."),
       heroImage: z.string().optional().describe("Hero image URL for the profile."),
       websiteLink: z.string().optional().describe("Website link for the profile."),
@@ -4808,7 +4824,8 @@ var require_types_cjs_development = __commonJS({
         name: z.string().max(15).regex(/^[a-z0-9-]+$/, {
           message: "The input string must contain only lowercase letters, numbers, and hyphens."
         }),
-        did: z.string()
+        did: z.string(),
+        isPrimary: z.boolean().optional()
       })
     });
     var AutoBoostConfigValidator = z.object({
@@ -4989,16 +5006,33 @@ var require_types_cjs_development = __commonJS({
       "BOOST_ACCEPTED",
       "PRESENTATION_REQUEST",
       "PRESENTATION_RECEIVED",
-      "CONSENT_FLOW_TRANSACTION"
+      "CONSENT_FLOW_TRANSACTION",
+      "ISSUANCE_CLAIMED",
+      "ISSUANCE_DELIVERED"
     ]);
     var LCNNotificationMessageValidator = z.object({
       title: z.string().optional(),
       body: z.string().optional()
     });
+    var LCNInboxContactMethodValidator = z.object({
+      type: z.string(),
+      value: z.string()
+    });
+    var LCNInboxStatusEnumValidator = z.enum(["PENDING", "DELIVERED", "CLAIMED", "EXPIRED"]);
+    var LCNNotificationInboxValidator = z.object({
+      issuanceId: z.string(),
+      status: LCNInboxStatusEnumValidator,
+      recipient: z.object({
+        contactMethod: LCNInboxContactMethodValidator.optional(),
+        learnCardId: z.string().optional()
+      }),
+      timestamp: z.string().datetime().optional()
+    });
     var LCNNotificationDataValidator = z.object({
       vcUris: z.array(z.string()).optional(),
       vpUris: z.array(z.string()).optional(),
-      transaction: ConsentFlowTransactionValidator.optional()
+      transaction: ConsentFlowTransactionValidator.optional(),
+      inbox: LCNNotificationInboxValidator.optional()
     });
     var LCNNotificationValidator = z.object({
       type: LCNNotificationTypeEnumValidator,
@@ -5006,7 +5040,8 @@ var require_types_cjs_development = __commonJS({
       from: LCNProfileValidator.partial().and(z.object({ did: z.string() })),
       message: LCNNotificationMessageValidator.optional(),
       data: LCNNotificationDataValidator.optional(),
-      sent: z.string().datetime().optional()
+      sent: z.string().datetime().optional(),
+      webhookUrl: z.string().optional()
     });
     var AUTH_GRANT_AUDIENCE_DOMAIN_PREFIX = "auth-grant:";
     var AuthGrantValidator = z.object({
@@ -5030,6 +5065,126 @@ var require_types_cjs_development = __commonJS({
       description: StringQuery,
       status: AuthGrantStatusValidator
     }).partial();
+    var contactMethodBase = z.object({
+      id: z.string(),
+      isVerified: z.boolean(),
+      verifiedAt: z.string().optional(),
+      isPrimary: z.boolean(),
+      createdAt: z.string()
+    });
+    var ContactMethodValidator = z.discriminatedUnion("type", [
+      z.object({
+        type: z.literal("email"),
+        value: z.string().email()
+      }).merge(contactMethodBase),
+      z.object({
+        type: z.literal("phone"),
+        value: z.string()
+      }).merge(contactMethodBase)
+    ]);
+    var createContactMethodBase = z.object({
+      isVerified: z.boolean().optional(),
+      isPrimary: z.boolean().optional()
+    });
+    var ContactMethodCreateValidator = z.discriminatedUnion("type", [
+      z.object({
+        type: z.literal("email"),
+        value: z.string().email()
+      }).merge(createContactMethodBase),
+      z.object({
+        type: z.literal("phone"),
+        value: z.string()
+      }).merge(createContactMethodBase)
+    ]);
+    var ContactMethodQueryValidator = z.discriminatedUnion("type", [
+      z.object({
+        type: z.literal("email"),
+        value: z.string().email()
+      }),
+      z.object({
+        type: z.literal("phone"),
+        value: z.string()
+      })
+    ]);
+    var ContactMethodVerificationRequestValidator = z.object({
+      value: z.string(),
+      type: z.enum(["email", "phone"])
+    });
+    var ContactMethodVerificationValidator = z.object({
+      token: z.string()
+    });
+    var SetPrimaryContactMethodValidator = z.object({
+      contactMethodId: z.string()
+    });
+    var InboxCredentialValidator = z.object({
+      id: z.string(),
+      credential: z.string(),
+      isSigned: z.boolean(),
+      currentStatus: LCNInboxStatusEnumValidator,
+      expiresAt: z.string(),
+      createdAt: z.string(),
+      issuerDid: z.string(),
+      webhookUrl: z.string().optional(),
+      "signingAuthority.endpoint": z.string().optional(),
+      "signingAuthority.name": z.string().optional()
+    });
+    var PaginatedInboxCredentialsValidator = z.object({
+      hasMore: z.boolean(),
+      records: z.array(InboxCredentialValidator),
+      cursor: z.string().optional()
+    });
+    var InboxCredentialQueryValidator = z.object({
+      currentStatus: LCNInboxStatusEnumValidator,
+      id: z.string(),
+      isSigned: z.boolean(),
+      issuerDid: z.string()
+    }).partial();
+    var IssueInboxSigningAuthorityValidator = z.object({
+      endpoint: z.string().url(),
+      name: z.string()
+    });
+    var IssueInboxCredentialValidator = z.object({
+      recipient: ContactMethodQueryValidator.describe("The recipient of the credential"),
+      credential: VCValidator.passthrough().or(VPValidator.passthrough()).or(UnsignedVCValidator.passthrough()).describe("The credential to issue. If not signed, the users default signing authority will be used, or the specified signing authority in the configuration."),
+      configuration: z.object({
+        signingAuthority: IssueInboxSigningAuthorityValidator.optional().describe("The signing authority to use for the credential. If not provided, the users default signing authority will be used if the credential is not signed."),
+        webhookUrl: z.string().url().optional().describe("The webhook URL to receive credential issuance events."),
+        expiresInDays: z.number().min(1).max(365).optional().describe("The number of days the credential will be valid for."),
+        delivery: z.object({
+          suppress: z.boolean().optional().default(false).describe("Whether to suppress delivery of the credential to the recipient. If true, the email/sms will not be sent to the recipient. Useful if you would like to manually send claim link to your users."),
+          template: z.object({
+            id: z.enum(["universal-inbox-claim"]).optional().describe("The template ID to use for the credential delivery. If not provided, the default template will be used."),
+            model: z.object({
+              issuer: z.object({
+                name: z.string().optional().describe('The name of the organization (e.g., "State University").'),
+                logoUrl: z.string().url().optional().describe("The URL of the organization's logo.")
+              }).optional(),
+              credential: z.object({
+                name: z.string().optional().describe('The name of the credential (e.g., "Bachelor of Science").'),
+                type: z.string().optional().describe('The type of the credential (e.g., "degree", "certificate").')
+              }).optional(),
+              recipient: z.object({
+                name: z.string().optional().describe('The name of the recipient (e.g., "John Doe").')
+              }).optional()
+            }).describe("The template model to use for the credential delivery. Injects via template variables into email/sms templates. If not provided, the default template will be used.")
+          }).optional().describe("The template to use for the credential delivery. If not provided, the default template will be used.")
+        }).optional().describe("Configuration for the credential delivery i.e. email or SMS. When credentials are sent to a user who has a verified email or phone associated with their account, delivery is skipped, and the credential will be sent using in-app notifications. If not provided, the default configuration will be used.")
+      }).optional().describe("Configuration for the credential issuance. If not provided, the default configuration will be used.")
+    });
+    var IssueInboxCredentialResponseValidator = z.object({
+      issuanceId: z.string(),
+      status: LCNInboxStatusEnumValidator,
+      recipient: ContactMethodQueryValidator,
+      claimUrl: z.string().url().optional(),
+      recipientDid: z.string().optional()
+    });
+    var ClaimTokenValidator = z.object({
+      token: z.string(),
+      contactMethodId: z.string(),
+      createdAt: z.string(),
+      expiresAt: z.string(),
+      used: z.boolean()
+    });
   }
 });
 
@@ -5050,7 +5205,8 @@ var src_exports = {};
 __export(src_exports, {
   RegExpTransformer: () => RegExpTransformer,
   isEncrypted: () => isEncrypted,
-  isHex: () => isHex
+  isHex: () => isHex,
+  isVC2Format: () => isVC2Format
 });
 module.exports = __toCommonJS(src_exports);
 var import_types = __toESM(require_dist());
@@ -5085,3 +5241,9 @@ var RegExpTransformer = {
     });
   }
 };
+var isVC2Format = /* @__PURE__ */ __name((credential) => {
+  if (!credential["@context"] || !Array.isArray(credential["@context"])) {
+    return false;
+  }
+  return credential["@context"].includes("https://www.w3.org/ns/credentials/v2");
+}, "isVC2Format");