@learncard/types 5.11.0 → 5.11.3

package/dist/types.esm.js

@@ -641,7 +641,7 @@ var FullClaimHookValidator = z9.object({ id: z9.string(), createdAt: z9.string()
 var PaginatedClaimHooksValidator = PaginationResponseValidator.extend({
   records: FullClaimHookValidator.array()
 });
-var LCNBoostStatus = z9.enum(["DRAFT", "LIVE"]);
+var LCNBoostStatus = z9.enum(["DRAFT", "PROVISIONAL", "LIVE"]);
 var BoostValidator = z9.object({
   uri: z9.string(),
   name: z9.string().optional(),
@@ -725,21 +725,46 @@ var SendBoostTemplateValidator = BoostValidator.partial().omit({ uri: true, clai
   claimPermissions: BoostPermissionsValidator.partial().optional(),
   skills: z9.array(z9.object({ frameworkId: z9.string(), id: z9.string() })).min(1).optional()
 });
+var SendBrandingOptionsValidator = z9.object({
+  issuerName: z9.string().optional().describe("Name of the issuing organization"),
+  issuerLogoUrl: z9.string().url().optional().describe("Logo URL of the issuing organization"),
+  credentialName: z9.string().optional().describe("Display name for the credential"),
+  recipientName: z9.string().optional().describe("Name of the recipient for personalization")
+});
+var SendOptionsValidator = z9.object({
+  webhookUrl: z9.string().url().optional().describe("Webhook URL to receive claim notifications"),
+  suppressDelivery: z9.boolean().optional().describe("If true, returns claimUrl without sending email/SMS"),
+  branding: SendBrandingOptionsValidator.optional().describe("Branding for email/SMS delivery")
+});
 var SendBoostInputValidator = z9.object({
   type: z9.literal("boost"),
-  recipient: z9.string(),
+  recipient: z9.string().describe("Profile ID, DID, email, or phone number (auto-detected)"),
   contractUri: z9.string().optional(),
   templateUri: z9.string().optional(),
   template: SendBoostTemplateValidator.optional(),
-  signedCredential: VCValidator.optional()
+  signedCredential: VCValidator.optional(),
+  options: SendOptionsValidator.optional().describe(
+    "Options for email/phone recipients (Universal Inbox)"
+  ),
+  templateData: z9.record(z9.string(), z9.unknown()).optional(),
+  integrationId: z9.string().optional().describe("Integration ID for activity tracking")
 }).refine((data) => data.templateUri || data.template, {
   message: "Either templateUri or template creation data must be provided.",
   path: ["templateUri"]
 });
+var SendInboxResponseValidator = z9.object({
+  issuanceId: z9.string(),
+  status: z9.enum(["PENDING", "ISSUED", "EXPIRED", "DELIVERED", "CLAIMED"]),
+  claimUrl: z9.string().url().optional().describe("Present when suppressDelivery=true")
+});
 var SendBoostResponseValidator = z9.object({
   type: z9.literal("boost"),
   credentialUri: z9.string(),
-  uri: z9.string()
+  uri: z9.string(),
+  activityId: z9.string().describe("Links to the activity lifecycle for this issuance"),
+  inbox: SendInboxResponseValidator.optional().describe(
+    "Present when sent via email/phone (Universal Inbox)"
+  )
 });
 var SendInputValidator = z9.discriminatedUnion("type", [SendBoostInputValidator]);
 var SendResponseValidator = z9.discriminatedUnion("type", [SendBoostResponseValidator]);
@@ -1091,6 +1116,8 @@ var InboxCredentialValidator = z9.object({
   createdAt: z9.string(),
   issuerDid: z9.string(),
   webhookUrl: z9.string().optional(),
+  boostUri: z9.string().optional(),
+  activityId: z9.string().optional(),
   signingAuthority: z9.object({
     endpoint: z9.string().optional(),
     name: z9.string().optional()
@@ -1106,7 +1133,8 @@ var InboxCredentialQueryValidator = z9.object({
   id: z9.string(),
   isSigned: z9.boolean(),
   isAccepted: z9.boolean().optional(),
-  issuerDid: z9.string()
+  issuerDid: z9.string(),
+  boostUri: z9.string()
 }).partial();
 var IssueInboxSigningAuthorityValidator = z9.object({
   endpoint: z9.string().url(),
@@ -1116,9 +1144,13 @@ 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.or(VPValidator).or(UnsignedVCValidator).describe(
+  // Either credential OR templateUri must be provided
+  credential: VCValidator.or(VPValidator).or(UnsignedVCValidator).optional().describe(
     "The credential to issue. If not signed, the users default signing authority will be used, or the specified signing authority in the configuration."
   ),
+  templateUri: z9.string().optional().describe(
+    "URI of a boost template to use for issuance. The boost credential will be resolved and used. Mutually exclusive with credential field."
+  ),
   // === OPTIONAL FEATURES ===
   // Add major, distinct features at the top level.
   //consentRequest: ConsentRequestValidator.optional(),
@@ -1130,6 +1162,9 @@ var IssueInboxCredentialValidator = z9.object({
     ),
     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."),
+    templateData: z9.record(z9.string(), z9.unknown()).optional().describe(
+      "Template data to render into the boost credential template using Mustache syntax. Only used when boostUri is provided."
+    ),
     // --- For User-Facing Delivery (Email/SMS) ---
     delivery: z9.object({
       suppress: z9.boolean().optional().default(false).describe(
@@ -1144,7 +1179,9 @@ var IssueInboxCredentialValidator = 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.")
+            logoUrl: z9.string().url().optional().describe(
+              "The URL of the organization's logo."
+            )
           }).optional(),
           credential: z9.object({
             name: z9.string().optional().describe(
@@ -1171,6 +1208,9 @@ var IssueInboxCredentialValidator = z9.object({
   }).optional().describe(
     "Configuration for the credential issuance. If not provided, the default configuration will be used."
   )
+}).refine((data) => data.credential || data.templateUri, {
+  message: "Either credential or templateUri must be provided.",
+  path: ["credential"]
 });
 var IssueInboxCredentialResponseValidator = z9.object({
   issuanceId: z9.string(),
@@ -1198,28 +1238,43 @@ var LCNDomainOrOriginValidator = z9.union([
     { message: "Must be a valid http(s) origin" }
   )
 ]);
+var LCNIntegrationStatusEnum = z9.enum(["setup", "active", "paused"]);
 var LCNIntegrationValidator = z9.object({
   id: z9.string(),
   name: z9.string(),
   description: z9.string().optional(),
   publishableKey: z9.string(),
-  whitelistedDomains: z9.array(LCNDomainOrOriginValidator).default([])
+  whitelistedDomains: z9.array(LCNDomainOrOriginValidator).default([]),
+  // Setup/onboarding status
+  status: LCNIntegrationStatusEnum.default("setup"),
+  guideType: z9.string().optional(),
+  guideState: z9.record(z9.string(), z9.any()).optional(),
+  // Timestamps
+  createdAt: z9.string().optional(),
+  updatedAt: z9.string().optional()
 });
 var LCNIntegrationCreateValidator = z9.object({
   name: z9.string(),
   description: z9.string().optional(),
-  whitelistedDomains: z9.array(LCNDomainOrOriginValidator).default([])
+  whitelistedDomains: z9.array(LCNDomainOrOriginValidator).default([]),
+  guideType: z9.string().optional()
 });
 var LCNIntegrationUpdateValidator = z9.object({
   name: z9.string().optional(),
   description: z9.string().optional(),
   whitelistedDomains: z9.array(LCNDomainOrOriginValidator).optional(),
-  rotatePublishableKey: z9.boolean().optional()
+  rotatePublishableKey: z9.boolean().optional(),
+  // Setup/onboarding updates
+  status: LCNIntegrationStatusEnum.optional(),
+  guideType: z9.string().optional(),
+  guideState: z9.record(z9.string(), z9.any()).optional()
 });
 var LCNIntegrationQueryValidator = z9.object({
   id: StringQuery,
   name: StringQuery,
-  description: StringQuery
+  description: StringQuery,
+  status: StringQuery,
+  guideType: StringQuery
 }).partial();
 var PaginatedLCNIntegrationsValidator = PaginationResponseValidator.extend({
   records: LCNIntegrationValidator.array()
@@ -1434,6 +1489,7 @@ var PromotionLevelValidator = z9.enum([
 ]);
 var AppStoreListingValidator = z9.object({
   listing_id: z9.string(),
+  slug: z9.string().optional(),
   display_name: z9.string(),
   tagline: z9.string(),
   full_description: z9.string(),
@@ -1471,6 +1527,77 @@ var PaginatedAppStoreListingsValidator = PaginationResponseValidator.extend({
 var PaginatedInstalledAppsValidator = PaginationResponseValidator.extend({
   records: InstalledAppValidator.array()
 });
+var AppBoostValidator = z9.object({
+  templateAlias: z9.string().min(1).max(50).regex(/^[a-z0-9-]+$/),
+  boostUri: z9.string()
+});
+var SendCredentialEventValidator = z9.object({
+  type: z9.literal("send-credential"),
+  templateAlias: z9.string(),
+  templateData: z9.record(z9.string(), z9.unknown()).optional()
+});
+var AppEventValidator = z9.discriminatedUnion("type", [SendCredentialEventValidator]);
+var AppEventInputValidator = z9.object({
+  listingId: z9.string(),
+  event: AppEventValidator
+});
+var AppEventResponseValidator = z9.record(z9.string(), z9.unknown());
+var CredentialActivityEventTypeValidator = z9.enum([
+  "CREATED",
+  "DELIVERED",
+  "CLAIMED",
+  "EXPIRED",
+  "FAILED"
+]);
+var CredentialActivityRecipientTypeValidator = z9.enum(["profile", "email", "phone"]);
+var CredentialActivitySourceTypeValidator = z9.enum([
+  "send",
+  "sendBoost",
+  "sendCredential",
+  "contract",
+  "claim",
+  "inbox",
+  "claimLink",
+  "acceptCredential"
+]);
+var CredentialActivityValidator = z9.object({
+  id: z9.string(),
+  activityId: z9.string(),
+  eventType: CredentialActivityEventTypeValidator,
+  timestamp: z9.string(),
+  actorProfileId: z9.string(),
+  recipientType: CredentialActivityRecipientTypeValidator,
+  recipientIdentifier: z9.string(),
+  boostUri: z9.string().optional(),
+  credentialUri: z9.string().optional(),
+  inboxCredentialId: z9.string().optional(),
+  integrationId: z9.string().optional(),
+  source: CredentialActivitySourceTypeValidator,
+  metadata: z9.record(z9.string(), z9.unknown()).optional()
+});
+var CredentialActivityWithDetailsValidator = CredentialActivityValidator.extend({
+  boost: z9.object({
+    id: z9.string(),
+    name: z9.string().optional(),
+    category: z9.string().optional()
+  }).optional(),
+  recipientProfile: z9.object({
+    profileId: z9.string(),
+    displayName: z9.string().optional()
+  }).optional()
+});
+var PaginatedCredentialActivitiesValidator = PaginationResponseValidator.extend({
+  records: CredentialActivityWithDetailsValidator.array()
+});
+var CredentialActivityStatsValidator = z9.object({
+  total: z9.number(),
+  created: z9.number(),
+  delivered: z9.number(),
+  claimed: z9.number(),
+  expired: z9.number(),
+  failed: z9.number(),
+  claimRate: z9.number()
+});
 export {
   AUTH_GRANT_AUDIENCE_DOMAIN_PREFIX,
   AchievementCredentialValidator,
@@ -1482,6 +1609,10 @@ export {
   AddressValidator,
   AlignmentTargetTypeValidator,
   AlignmentValidator,
+  AppBoostValidator,
+  AppEventInputValidator,
+  AppEventResponseValidator,
+  AppEventValidator,
   AppListingStatusValidator,
   AppStoreListingCreateValidator,
   AppStoreListingUpdateValidator,
@@ -1530,6 +1661,12 @@ export {
   CreateManagedFrameworkInputValidator,
   CreateSkillInputValidator,
   CreateSkillsBatchInputValidator,
+  CredentialActivityEventTypeValidator,
+  CredentialActivityRecipientTypeValidator,
+  CredentialActivitySourceTypeValidator,
+  CredentialActivityStatsValidator,
+  CredentialActivityValidator,
+  CredentialActivityWithDetailsValidator,
   CredentialInfoValidator,
   CredentialRecordValidator,
   CredentialSchemaValidator,
@@ -1576,6 +1713,7 @@ export {
   LCNInboxStatusEnumValidator,
   LCNIntegrationCreateValidator,
   LCNIntegrationQueryValidator,
+  LCNIntegrationStatusEnum,
   LCNIntegrationUpdateValidator,
   LCNIntegrationValidator,
   LCNNotificationDataValidator,
@@ -1604,6 +1742,7 @@ export {
   PaginatedConsentFlowTermsValidator,
   PaginatedConsentFlowTransactionsValidator,
   PaginatedContractCredentialsValidator,
+  PaginatedCredentialActivitiesValidator,
   PaginatedEncryptedCredentialRecordsValidator,
   PaginatedEncryptedRecordsValidator,
   PaginatedInboxCredentialsValidator,
@@ -1631,7 +1770,11 @@ export {
   RubricCriterionValidator,
   SendBoostInputValidator,
   SendBoostResponseValidator,
+  SendBrandingOptionsValidator,
+  SendCredentialEventValidator,
+  SendInboxResponseValidator,
   SendInputValidator,
+  SendOptionsValidator,
   SendResponseValidator,
   SentCredentialInfoValidator,
   ServiceValidator,