@learncard/helpers 1.2.1 → 1.2.4

package/dist/helpers.esm.js

@@ -63,6 +63,10 @@ var require_types_cjs_development = __commonJS({
       AddressValidator: /* @__PURE__ */ __name(() => AddressValidator, "AddressValidator"),
       AlignmentTargetTypeValidator: /* @__PURE__ */ __name(() => AlignmentTargetTypeValidator, "AlignmentTargetTypeValidator"),
       AlignmentValidator: /* @__PURE__ */ __name(() => AlignmentValidator, "AlignmentValidator"),
+      AppBoostValidator: /* @__PURE__ */ __name(() => AppBoostValidator, "AppBoostValidator"),
+      AppEventInputValidator: /* @__PURE__ */ __name(() => AppEventInputValidator, "AppEventInputValidator"),
+      AppEventResponseValidator: /* @__PURE__ */ __name(() => AppEventResponseValidator, "AppEventResponseValidator"),
+      AppEventValidator: /* @__PURE__ */ __name(() => AppEventValidator, "AppEventValidator"),
       AppListingStatusValidator: /* @__PURE__ */ __name(() => AppListingStatusValidator, "AppListingStatusValidator"),
       AppStoreListingCreateValidator: /* @__PURE__ */ __name(() => AppStoreListingCreateValidator, "AppStoreListingCreateValidator"),
       AppStoreListingUpdateValidator: /* @__PURE__ */ __name(() => AppStoreListingUpdateValidator, "AppStoreListingUpdateValidator"),
@@ -111,6 +115,12 @@ var require_types_cjs_development = __commonJS({
       CreateManagedFrameworkInputValidator: /* @__PURE__ */ __name(() => CreateManagedFrameworkInputValidator, "CreateManagedFrameworkInputValidator"),
       CreateSkillInputValidator: /* @__PURE__ */ __name(() => CreateSkillInputValidator, "CreateSkillInputValidator"),
       CreateSkillsBatchInputValidator: /* @__PURE__ */ __name(() => CreateSkillsBatchInputValidator, "CreateSkillsBatchInputValidator"),
+      CredentialActivityEventTypeValidator: /* @__PURE__ */ __name(() => CredentialActivityEventTypeValidator, "CredentialActivityEventTypeValidator"),
+      CredentialActivityRecipientTypeValidator: /* @__PURE__ */ __name(() => CredentialActivityRecipientTypeValidator, "CredentialActivityRecipientTypeValidator"),
+      CredentialActivitySourceTypeValidator: /* @__PURE__ */ __name(() => CredentialActivitySourceTypeValidator, "CredentialActivitySourceTypeValidator"),
+      CredentialActivityStatsValidator: /* @__PURE__ */ __name(() => CredentialActivityStatsValidator, "CredentialActivityStatsValidator"),
+      CredentialActivityValidator: /* @__PURE__ */ __name(() => CredentialActivityValidator, "CredentialActivityValidator"),
+      CredentialActivityWithDetailsValidator: /* @__PURE__ */ __name(() => CredentialActivityWithDetailsValidator, "CredentialActivityWithDetailsValidator"),
       CredentialInfoValidator: /* @__PURE__ */ __name(() => CredentialInfoValidator, "CredentialInfoValidator"),
       CredentialRecordValidator: /* @__PURE__ */ __name(() => CredentialRecordValidator, "CredentialRecordValidator"),
       CredentialSchemaValidator: /* @__PURE__ */ __name(() => CredentialSchemaValidator, "CredentialSchemaValidator"),
@@ -157,6 +167,7 @@ var require_types_cjs_development = __commonJS({
       LCNInboxStatusEnumValidator: /* @__PURE__ */ __name(() => LCNInboxStatusEnumValidator, "LCNInboxStatusEnumValidator"),
       LCNIntegrationCreateValidator: /* @__PURE__ */ __name(() => LCNIntegrationCreateValidator, "LCNIntegrationCreateValidator"),
       LCNIntegrationQueryValidator: /* @__PURE__ */ __name(() => LCNIntegrationQueryValidator, "LCNIntegrationQueryValidator"),
+      LCNIntegrationStatusEnum: /* @__PURE__ */ __name(() => LCNIntegrationStatusEnum, "LCNIntegrationStatusEnum"),
       LCNIntegrationUpdateValidator: /* @__PURE__ */ __name(() => LCNIntegrationUpdateValidator, "LCNIntegrationUpdateValidator"),
       LCNIntegrationValidator: /* @__PURE__ */ __name(() => LCNIntegrationValidator, "LCNIntegrationValidator"),
       LCNNotificationDataValidator: /* @__PURE__ */ __name(() => LCNNotificationDataValidator, "LCNNotificationDataValidator"),
@@ -185,6 +196,7 @@ var require_types_cjs_development = __commonJS({
       PaginatedConsentFlowTermsValidator: /* @__PURE__ */ __name(() => PaginatedConsentFlowTermsValidator, "PaginatedConsentFlowTermsValidator"),
       PaginatedConsentFlowTransactionsValidator: /* @__PURE__ */ __name(() => PaginatedConsentFlowTransactionsValidator, "PaginatedConsentFlowTransactionsValidator"),
       PaginatedContractCredentialsValidator: /* @__PURE__ */ __name(() => PaginatedContractCredentialsValidator, "PaginatedContractCredentialsValidator"),
+      PaginatedCredentialActivitiesValidator: /* @__PURE__ */ __name(() => PaginatedCredentialActivitiesValidator, "PaginatedCredentialActivitiesValidator"),
       PaginatedEncryptedCredentialRecordsValidator: /* @__PURE__ */ __name(() => PaginatedEncryptedCredentialRecordsValidator, "PaginatedEncryptedCredentialRecordsValidator"),
       PaginatedEncryptedRecordsValidator: /* @__PURE__ */ __name(() => PaginatedEncryptedRecordsValidator, "PaginatedEncryptedRecordsValidator"),
       PaginatedInboxCredentialsValidator: /* @__PURE__ */ __name(() => PaginatedInboxCredentialsValidator, "PaginatedInboxCredentialsValidator"),
@@ -212,7 +224,11 @@ var require_types_cjs_development = __commonJS({
       RubricCriterionValidator: /* @__PURE__ */ __name(() => RubricCriterionValidator, "RubricCriterionValidator"),
       SendBoostInputValidator: /* @__PURE__ */ __name(() => SendBoostInputValidator, "SendBoostInputValidator"),
       SendBoostResponseValidator: /* @__PURE__ */ __name(() => SendBoostResponseValidator, "SendBoostResponseValidator"),
+      SendBrandingOptionsValidator: /* @__PURE__ */ __name(() => SendBrandingOptionsValidator, "SendBrandingOptionsValidator"),
+      SendCredentialEventValidator: /* @__PURE__ */ __name(() => SendCredentialEventValidator, "SendCredentialEventValidator"),
+      SendInboxResponseValidator: /* @__PURE__ */ __name(() => SendInboxResponseValidator, "SendInboxResponseValidator"),
       SendInputValidator: /* @__PURE__ */ __name(() => SendInputValidator, "SendInputValidator"),
+      SendOptionsValidator: /* @__PURE__ */ __name(() => SendOptionsValidator, "SendOptionsValidator"),
       SendResponseValidator: /* @__PURE__ */ __name(() => SendResponseValidator, "SendResponseValidator"),
       SentCredentialInfoValidator: /* @__PURE__ */ __name(() => SentCredentialInfoValidator, "SentCredentialInfoValidator"),
       ServiceValidator: /* @__PURE__ */ __name(() => ServiceValidator, "ServiceValidator"),
@@ -14224,7 +14240,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
     var PaginatedClaimHooksValidator = PaginationResponseValidator.extend({
       records: FullClaimHookValidator.array()
     });
-    var LCNBoostStatus = external_exports.enum(["DRAFT", "LIVE"]);
+    var LCNBoostStatus = external_exports.enum(["DRAFT", "PROVISIONAL", "LIVE"]);
     var BoostValidator = external_exports.object({
       uri: external_exports.string(),
       name: external_exports.string().optional(),
@@ -14308,21 +14324,46 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       claimPermissions: BoostPermissionsValidator.partial().optional(),
       skills: external_exports.array(external_exports.object({ frameworkId: external_exports.string(), id: external_exports.string() })).min(1).optional()
     });
+    var SendBrandingOptionsValidator = external_exports.object({
+      issuerName: external_exports.string().optional().describe("Name of the issuing organization"),
+      issuerLogoUrl: external_exports.string().url().optional().describe("Logo URL of the issuing organization"),
+      credentialName: external_exports.string().optional().describe("Display name for the credential"),
+      recipientName: external_exports.string().optional().describe("Name of the recipient for personalization")
+    });
+    var SendOptionsValidator = external_exports.object({
+      webhookUrl: external_exports.string().url().optional().describe("Webhook URL to receive claim notifications"),
+      suppressDelivery: external_exports.boolean().optional().describe("If true, returns claimUrl without sending email/SMS"),
+      branding: SendBrandingOptionsValidator.optional().describe("Branding for email/SMS delivery")
+    });
     var SendBoostInputValidator = external_exports.object({
       type: external_exports.literal("boost"),
-      recipient: external_exports.string(),
+      recipient: external_exports.string().describe("Profile ID, DID, email, or phone number (auto-detected)"),
       contractUri: external_exports.string().optional(),
       templateUri: external_exports.string().optional(),
       template: SendBoostTemplateValidator.optional(),
-      signedCredential: VCValidator.optional()
+      signedCredential: VCValidator.optional(),
+      options: SendOptionsValidator.optional().describe(
+        "Options for email/phone recipients (Universal Inbox)"
+      ),
+      templateData: external_exports.record(external_exports.string(), external_exports.unknown()).optional(),
+      integrationId: external_exports.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 = external_exports.object({
+      issuanceId: external_exports.string(),
+      status: external_exports.enum(["PENDING", "ISSUED", "EXPIRED", "DELIVERED", "CLAIMED"]),
+      claimUrl: external_exports.string().url().optional().describe("Present when suppressDelivery=true")
+    });
     var SendBoostResponseValidator = external_exports.object({
       type: external_exports.literal("boost"),
       credentialUri: external_exports.string(),
-      uri: external_exports.string()
+      uri: external_exports.string(),
+      activityId: external_exports.string().describe("Links to the activity lifecycle for this issuance"),
+      inbox: SendInboxResponseValidator.optional().describe(
+        "Present when sent via email/phone (Universal Inbox)"
+      )
     });
     var SendInputValidator = external_exports.discriminatedUnion("type", [SendBoostInputValidator]);
     var SendResponseValidator = external_exports.discriminatedUnion("type", [SendBoostResponseValidator]);
@@ -14674,6 +14715,8 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       createdAt: external_exports.string(),
       issuerDid: external_exports.string(),
       webhookUrl: external_exports.string().optional(),
+      boostUri: external_exports.string().optional(),
+      activityId: external_exports.string().optional(),
       signingAuthority: external_exports.object({
         endpoint: external_exports.string().optional(),
         name: external_exports.string().optional()
@@ -14689,7 +14732,8 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       id: external_exports.string(),
       isSigned: external_exports.boolean(),
       isAccepted: external_exports.boolean().optional(),
-      issuerDid: external_exports.string()
+      issuerDid: external_exports.string(),
+      boostUri: external_exports.string()
     }).partial();
     var IssueInboxSigningAuthorityValidator = external_exports.object({
       endpoint: external_exports.string().url(),
@@ -14699,9 +14743,13 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       // === 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: external_exports.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(),
@@ -14713,6 +14761,9 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
         ),
         webhookUrl: external_exports.string().url().optional().describe("The webhook URL to receive credential issuance events."),
         expiresInDays: external_exports.number().min(1).max(365).optional().describe("The number of days the credential will be valid for."),
+        templateData: external_exports.record(external_exports.string(), external_exports.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: external_exports.object({
           suppress: external_exports.boolean().optional().default(false).describe(
@@ -14727,7 +14778,9 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
                 name: external_exports.string().optional().describe(
                   'The name of the organization (e.g., "State University").'
                 ),
-                logoUrl: external_exports.string().url().optional().describe("The URL of the organization's logo.")
+                logoUrl: external_exports.string().url().optional().describe(
+                  "The URL of the organization's logo."
+                )
               }).optional(),
               credential: external_exports.object({
                 name: external_exports.string().optional().describe(
@@ -14754,6 +14807,9 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       }).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 = external_exports.object({
       issuanceId: external_exports.string(),
@@ -14781,28 +14837,43 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
         { message: "Must be a valid http(s) origin" }
       )
     ]);
+    var LCNIntegrationStatusEnum = external_exports.enum(["setup", "active", "paused"]);
     var LCNIntegrationValidator = external_exports.object({
       id: external_exports.string(),
       name: external_exports.string(),
       description: external_exports.string().optional(),
       publishableKey: external_exports.string(),
-      whitelistedDomains: external_exports.array(LCNDomainOrOriginValidator).default([])
+      whitelistedDomains: external_exports.array(LCNDomainOrOriginValidator).default([]),
+      // Setup/onboarding status
+      status: LCNIntegrationStatusEnum.default("setup"),
+      guideType: external_exports.string().optional(),
+      guideState: external_exports.record(external_exports.string(), external_exports.any()).optional(),
+      // Timestamps
+      createdAt: external_exports.string().optional(),
+      updatedAt: external_exports.string().optional()
     });
     var LCNIntegrationCreateValidator = external_exports.object({
       name: external_exports.string(),
       description: external_exports.string().optional(),
-      whitelistedDomains: external_exports.array(LCNDomainOrOriginValidator).default([])
+      whitelistedDomains: external_exports.array(LCNDomainOrOriginValidator).default([]),
+      guideType: external_exports.string().optional()
     });
     var LCNIntegrationUpdateValidator = external_exports.object({
       name: external_exports.string().optional(),
       description: external_exports.string().optional(),
       whitelistedDomains: external_exports.array(LCNDomainOrOriginValidator).optional(),
-      rotatePublishableKey: external_exports.boolean().optional()
+      rotatePublishableKey: external_exports.boolean().optional(),
+      // Setup/onboarding updates
+      status: LCNIntegrationStatusEnum.optional(),
+      guideType: external_exports.string().optional(),
+      guideState: external_exports.record(external_exports.string(), external_exports.any()).optional()
     });
     var LCNIntegrationQueryValidator = external_exports.object({
       id: StringQuery,
       name: StringQuery,
-      description: StringQuery
+      description: StringQuery,
+      status: StringQuery,
+      guideType: StringQuery
     }).partial();
     var PaginatedLCNIntegrationsValidator = PaginationResponseValidator.extend({
       records: LCNIntegrationValidator.array()
@@ -15017,6 +15088,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
     ]);
     var AppStoreListingValidator = external_exports.object({
       listing_id: external_exports.string(),
+      slug: external_exports.string().optional(),
       display_name: external_exports.string(),
       tagline: external_exports.string(),
       full_description: external_exports.string(),
@@ -15054,6 +15126,77 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
     var PaginatedInstalledAppsValidator = PaginationResponseValidator.extend({
       records: InstalledAppValidator.array()
     });
+    var AppBoostValidator = external_exports.object({
+      templateAlias: external_exports.string().min(1).max(50).regex(/^[a-z0-9-]+$/),
+      boostUri: external_exports.string()
+    });
+    var SendCredentialEventValidator = external_exports.object({
+      type: external_exports.literal("send-credential"),
+      templateAlias: external_exports.string(),
+      templateData: external_exports.record(external_exports.string(), external_exports.unknown()).optional()
+    });
+    var AppEventValidator = external_exports.discriminatedUnion("type", [SendCredentialEventValidator]);
+    var AppEventInputValidator = external_exports.object({
+      listingId: external_exports.string(),
+      event: AppEventValidator
+    });
+    var AppEventResponseValidator = external_exports.record(external_exports.string(), external_exports.unknown());
+    var CredentialActivityEventTypeValidator = external_exports.enum([
+      "CREATED",
+      "DELIVERED",
+      "CLAIMED",
+      "EXPIRED",
+      "FAILED"
+    ]);
+    var CredentialActivityRecipientTypeValidator = external_exports.enum(["profile", "email", "phone"]);
+    var CredentialActivitySourceTypeValidator = external_exports.enum([
+      "send",
+      "sendBoost",
+      "sendCredential",
+      "contract",
+      "claim",
+      "inbox",
+      "claimLink",
+      "acceptCredential"
+    ]);
+    var CredentialActivityValidator = external_exports.object({
+      id: external_exports.string(),
+      activityId: external_exports.string(),
+      eventType: CredentialActivityEventTypeValidator,
+      timestamp: external_exports.string(),
+      actorProfileId: external_exports.string(),
+      recipientType: CredentialActivityRecipientTypeValidator,
+      recipientIdentifier: external_exports.string(),
+      boostUri: external_exports.string().optional(),
+      credentialUri: external_exports.string().optional(),
+      inboxCredentialId: external_exports.string().optional(),
+      integrationId: external_exports.string().optional(),
+      source: CredentialActivitySourceTypeValidator,
+      metadata: external_exports.record(external_exports.string(), external_exports.unknown()).optional()
+    });
+    var CredentialActivityWithDetailsValidator = CredentialActivityValidator.extend({
+      boost: external_exports.object({
+        id: external_exports.string(),
+        name: external_exports.string().optional(),
+        category: external_exports.string().optional()
+      }).optional(),
+      recipientProfile: external_exports.object({
+        profileId: external_exports.string(),
+        displayName: external_exports.string().optional()
+      }).optional()
+    });
+    var PaginatedCredentialActivitiesValidator = PaginationResponseValidator.extend({
+      records: CredentialActivityWithDetailsValidator.array()
+    });
+    var CredentialActivityStatsValidator = external_exports.object({
+      total: external_exports.number(),
+      created: external_exports.number(),
+      delivered: external_exports.number(),
+      claimed: external_exports.number(),
+      expired: external_exports.number(),
+      failed: external_exports.number(),
+      claimRate: external_exports.number()
+    });
   }
 });