@learncard/types 5.7.1 → 5.8.1

package/dist/types.esm.js

@@ -506,7 +506,7 @@ var LCNProfileValidator = z9.object({
   bio: z9.string().default("").describe("Longer bio for the profile."),
   did: z9.string().describe("Decentralized Identifier for the profile. (auto-assigned)"),
   isPrivate: z9.boolean().optional().describe("Whether the profile is private or not and shows up in search results."),
-  email: z9.string().optional().describe("Contact email address for the profile."),
+  email: z9.string().optional().describe("Contact email address for the profile. (deprecated)"),
   image: z9.string().optional().describe("Profile image URL for the profile."),
   heroImage: z9.string().optional().describe("Hero image URL for the profile."),
   websiteLink: z9.string().optional().describe("Website link for the profile."),
@@ -675,7 +675,8 @@ var LCNSigningAuthorityForUserValidator = z9.object({
     name: z9.string().max(15).regex(/^[a-z0-9-]+$/, {
       message: "The input string must contain only lowercase letters, numbers, and hyphens."
     }),
-    did: z9.string()
+    did: z9.string(),
+    isPrimary: z9.boolean().optional()
   })
 });
 var AutoBoostConfigValidator = z9.object({
@@ -689,12 +690,12 @@ var ConsentFlowTermsStatusValidator = z9.enum(["live", "stale", "withdrawn"]);
 var ConsentFlowContractValidator = z9.object({
   read: z9.object({
     anonymize: z9.boolean().optional(),
-    credentials: z9.object({ categories: z9.record(z9.object({ required: z9.boolean() })).default({}) }).default({}),
-    personal: z9.record(z9.object({ required: z9.boolean() })).default({})
+    credentials: z9.object({ categories: z9.record(z9.object({ required: z9.boolean(), defaultEnabled: z9.boolean().optional() })).default({}) }).default({}),
+    personal: z9.record(z9.object({ required: z9.boolean(), defaultEnabled: z9.boolean().optional() })).default({})
   }).default({}),
   write: z9.object({
-    credentials: z9.object({ categories: z9.record(z9.object({ required: z9.boolean() })).default({}) }).default({}),
-    personal: z9.record(z9.object({ required: z9.boolean() })).default({})
+    credentials: z9.object({ categories: z9.record(z9.object({ required: z9.boolean(), defaultEnabled: z9.boolean().optional() })).default({}) }).default({}),
+    personal: z9.record(z9.object({ required: z9.boolean(), defaultEnabled: z9.boolean().optional() })).default({})
   }).default({})
 });
 var ConsentFlowContractDetailsValidator = z9.object({
@@ -856,16 +857,33 @@ var LCNNotificationTypeEnumValidator = z9.enum([
   "BOOST_ACCEPTED",
   "PRESENTATION_REQUEST",
   "PRESENTATION_RECEIVED",
-  "CONSENT_FLOW_TRANSACTION"
+  "CONSENT_FLOW_TRANSACTION",
+  "ISSUANCE_CLAIMED",
+  "ISSUANCE_DELIVERED"
 ]);
 var LCNNotificationMessageValidator = z9.object({
   title: z9.string().optional(),
   body: z9.string().optional()
 });
+var LCNInboxContactMethodValidator = z9.object({
+  type: z9.string(),
+  value: z9.string()
+});
+var LCNInboxStatusEnumValidator = z9.enum(["PENDING", "DELIVERED", "CLAIMED", "EXPIRED"]);
+var LCNNotificationInboxValidator = z9.object({
+  issuanceId: z9.string(),
+  status: LCNInboxStatusEnumValidator,
+  recipient: z9.object({
+    contactMethod: LCNInboxContactMethodValidator.optional(),
+    learnCardId: z9.string().optional()
+  }),
+  timestamp: z9.string().datetime().optional()
+});
 var LCNNotificationDataValidator = z9.object({
   vcUris: z9.array(z9.string()).optional(),
   vpUris: z9.array(z9.string()).optional(),
-  transaction: ConsentFlowTransactionValidator.optional()
+  transaction: ConsentFlowTransactionValidator.optional(),
+  inbox: LCNNotificationInboxValidator.optional()
 });
 var LCNNotificationValidator = z9.object({
   type: LCNNotificationTypeEnumValidator,
@@ -873,7 +891,8 @@ var LCNNotificationValidator = z9.object({
   from: LCNProfileValidator.partial().and(z9.object({ did: z9.string() })),
   message: LCNNotificationMessageValidator.optional(),
   data: LCNNotificationDataValidator.optional(),
-  sent: z9.string().datetime().optional()
+  sent: z9.string().datetime().optional(),
+  webhookUrl: z9.string().optional()
 });
 var AUTH_GRANT_AUDIENCE_DOMAIN_PREFIX = "auth-grant:";
 var AuthGrantValidator = z9.object({
@@ -897,6 +916,135 @@ var AuthGrantQueryValidator = z9.object({
   description: StringQuery,
   status: AuthGrantStatusValidator
 }).partial();
+var contactMethodBase = z9.object({
+  id: z9.string(),
+  isVerified: z9.boolean(),
+  verifiedAt: z9.string().optional(),
+  isPrimary: z9.boolean(),
+  createdAt: z9.string()
+});
+var ContactMethodValidator = z9.discriminatedUnion("type", [
+  z9.object({
+    type: z9.literal("email"),
+    value: z9.string().email()
+  }).merge(contactMethodBase),
+  z9.object({
+    type: z9.literal("phone"),
+    value: z9.string()
+    // Can be improved with a regex later
+  }).merge(contactMethodBase)
+]);
+var createContactMethodBase = z9.object({
+  isVerified: z9.boolean().optional(),
+  isPrimary: z9.boolean().optional()
+});
+var ContactMethodCreateValidator = z9.discriminatedUnion("type", [
+  z9.object({
+    type: z9.literal("email"),
+    value: z9.string().email()
+  }).merge(createContactMethodBase),
+  z9.object({
+    type: z9.literal("phone"),
+    value: z9.string()
+  }).merge(createContactMethodBase)
+]);
+var ContactMethodQueryValidator = z9.discriminatedUnion("type", [
+  z9.object({
+    type: z9.literal("email"),
+    value: z9.string().email()
+  }),
+  z9.object({
+    type: z9.literal("phone"),
+    value: z9.string()
+  })
+]);
+var ContactMethodVerificationRequestValidator = z9.object({
+  value: z9.string(),
+  type: z9.enum(["email", "phone"])
+});
+var ContactMethodVerificationValidator = z9.object({
+  token: z9.string()
+});
+var SetPrimaryContactMethodValidator = z9.object({
+  contactMethodId: z9.string()
+});
+var InboxCredentialValidator = z9.object({
+  id: z9.string(),
+  credential: z9.string(),
+  isSigned: z9.boolean(),
+  currentStatus: LCNInboxStatusEnumValidator,
+  expiresAt: z9.string(),
+  createdAt: z9.string(),
+  issuerDid: z9.string(),
+  webhookUrl: z9.string().optional(),
+  "signingAuthority.endpoint": z9.string().optional(),
+  "signingAuthority.name": z9.string().optional()
+});
+var PaginatedInboxCredentialsValidator = z9.object({
+  hasMore: z9.boolean(),
+  records: z9.array(InboxCredentialValidator),
+  cursor: z9.string().optional()
+});
+var InboxCredentialQueryValidator = z9.object({
+  currentStatus: LCNInboxStatusEnumValidator,
+  id: z9.string(),
+  isSigned: z9.boolean(),
+  issuerDid: z9.string()
+}).partial();
+var IssueInboxSigningAuthorityValidator = z9.object({
+  endpoint: z9.string().url(),
+  name: z9.string()
+});
+var IssueInboxCredentialValidator = z9.object({
+  // === CORE DATA (Required) ===
+  // WHAT is being sent and WHO is it for?
+  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."),
+  // === OPTIONAL FEATURES ===
+  // Add major, distinct features at the top level.
+  //consentRequest: ConsentRequestValidator.optional(),
+  // === PROCESS CONFIGURATION (Optional) ===
+  // HOW should this issuance be handled?
+  configuration: z9.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: z9.string().url().optional().describe("The webhook URL to receive credential issuance events."),
+    expiresInDays: z9.number().min(1).max(365).optional().describe("The number of days the credential will be valid for."),
+    // --- For User-Facing Delivery (Email/SMS) ---
+    delivery: z9.object({
+      suppress: z9.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: z9.object({
+        id: z9.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: z9.object({
+          issuer: z9.object({
+            name: z9.string().optional().describe('The name of the organization (e.g., "State University").'),
+            logoUrl: z9.string().url().optional().describe("The URL of the organization's logo.")
+          }).optional(),
+          credential: z9.object({
+            name: z9.string().optional().describe('The name of the credential (e.g., "Bachelor of Science").'),
+            type: z9.string().optional().describe('The type of the credential (e.g., "degree", "certificate").')
+          }).optional(),
+          recipient: z9.object({
+            name: z9.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 = z9.object({
+  issuanceId: z9.string(),
+  status: LCNInboxStatusEnumValidator,
+  recipient: ContactMethodQueryValidator,
+  claimUrl: z9.string().url().optional(),
+  recipientDid: z9.string().optional()
+});
+var ClaimTokenValidator = z9.object({
+  token: z9.string(),
+  contactMethodId: z9.string(),
+  createdAt: z9.string(),
+  expiresAt: z9.string(),
+  used: z9.boolean()
+});
 export {
   AUTH_GRANT_AUDIENCE_DOMAIN_PREFIX,
   AchievementCredentialValidator,
@@ -919,6 +1067,7 @@ export {
   ClaimHookQueryValidator,
   ClaimHookTypeValidator,
   ClaimHookValidator,
+  ClaimTokenValidator,
   ConsentFlowContractDataForDidValidator,
   ConsentFlowContractDataValidator,
   ConsentFlowContractDetailsValidator,
@@ -933,6 +1082,11 @@ export {
   ConsentFlowTransactionActionValidator,
   ConsentFlowTransactionValidator,
   ConsentFlowTransactionsQueryValidator,
+  ContactMethodCreateValidator,
+  ContactMethodQueryValidator,
+  ContactMethodValidator,
+  ContactMethodVerificationRequestValidator,
+  ContactMethodVerificationValidator,
   ContextValidator,
   ContractCredentialValidator,
   CredentialInfoValidator,
@@ -954,6 +1108,11 @@ export {
   IdentifierTypeValidator,
   IdentityObjectValidator,
   ImageValidator,
+  InboxCredentialQueryValidator,
+  InboxCredentialValidator,
+  IssueInboxCredentialResponseValidator,
+  IssueInboxCredentialValidator,
+  IssueInboxSigningAuthorityValidator,
   JWERecipientHeaderValidator,
   JWERecipientValidator,
   JWEValidator,
@@ -963,7 +1122,10 @@ export {
   LCNBoostClaimLinkOptionsValidator,
   LCNBoostClaimLinkSigningAuthorityValidator,
   LCNBoostStatus,
+  LCNInboxContactMethodValidator,
+  LCNInboxStatusEnumValidator,
   LCNNotificationDataValidator,
+  LCNNotificationInboxValidator,
   LCNNotificationMessageValidator,
   LCNNotificationTypeEnumValidator,
   LCNNotificationValidator,
@@ -986,6 +1148,7 @@ export {
   PaginatedContractCredentialsValidator,
   PaginatedEncryptedCredentialRecordsValidator,
   PaginatedEncryptedRecordsValidator,
+  PaginatedInboxCredentialsValidator,
   PaginatedLCNProfileManagersValidator,
   PaginatedLCNProfilesAndManagersValidator,
   PaginatedLCNProfilesValidator,
@@ -1003,6 +1166,7 @@ export {
   RubricCriterionValidator,
   SentCredentialInfoValidator,
   ServiceValidator,
+  SetPrimaryContactMethodValidator,
   StringQuery,
   TermsOfUseValidator,
   UnsignedAchievementCredentialValidator,