@learncard/types 5.18.2 → 5.19.0

package/dist/types.cjs.development.cjs

@@ -32,6 +32,8 @@ __export(index_exports, {
   AgeRatingValidator: () => AgeRatingValidator,
   AlignmentTargetTypeValidator: () => AlignmentTargetTypeValidator,
   AlignmentValidator: () => AlignmentValidator,
+  AllocateCredentialRefreshInputValidator: () => AllocateCredentialRefreshInputValidator,
+  AllocateCredentialRefreshResultValidator: () => AllocateCredentialRefreshResultValidator,
   AllocateCredentialStatusInputValidator: () => AllocateCredentialStatusInputValidator,
   AllocatedBitstringStatusListEntryValidator: () => AllocatedBitstringStatusListEntryValidator,
   AllowConnectionRequestsEnum: () => AllowConnectionRequestsEnum,
@@ -113,6 +115,16 @@ __export(index_exports, {
   CredentialInfoValidator: () => CredentialInfoValidator,
   CredentialNameRefValidator: () => CredentialNameRefValidator,
   CredentialRecordValidator: () => CredentialRecordValidator,
+  CredentialRefreshChallengeValidator: () => CredentialRefreshChallengeValidator,
+  CredentialRefreshFailedResultValidator: () => CredentialRefreshFailedResultValidator,
+  CredentialRefreshFailureCodeValidator: () => CredentialRefreshFailureCodeValidator,
+  CredentialRefreshResponseEnvelopeValidator: () => CredentialRefreshResponseEnvelopeValidator,
+  CredentialRefreshResultValidator: () => CredentialRefreshResultValidator,
+  CredentialRefreshSigningModeValidator: () => CredentialRefreshSigningModeValidator,
+  CredentialRefreshUnchangedResultValidator: () => CredentialRefreshUnchangedResultValidator,
+  CredentialRefreshUnsupportedResultValidator: () => CredentialRefreshUnsupportedResultValidator,
+  CredentialRefreshUpdatedResultValidator: () => CredentialRefreshUpdatedResultValidator,
+  CredentialRefreshVersionMetadataValidator: () => CredentialRefreshVersionMetadataValidator,
   CredentialSchemaValidator: () => CredentialSchemaValidator,
   CredentialStatusValidator: () => CredentialStatusValidator,
   CredentialSubjectValidator: () => CredentialSubjectValidator,
@@ -133,6 +145,8 @@ __export(index_exports, {
   GeoCoordinatesValidator: () => GeoCoordinatesValidator,
   GetCounterEventValidator: () => GetCounterEventValidator,
   GetCountersEventValidator: () => GetCountersEventValidator,
+  GetCredentialRefreshHistoryInputValidator: () => GetCredentialRefreshHistoryInputValidator,
+  GetCredentialRefreshHistoryResultValidator: () => GetCredentialRefreshHistoryResultValidator,
   GetFullSkillTreeInputValidator: () => GetFullSkillTreeInputValidator,
   GetFullSkillTreeResultValidator: () => GetFullSkillTreeResultValidator,
   GetSkillPathInputValidator: () => GetSkillPathInputValidator,
@@ -157,6 +171,7 @@ __export(index_exports, {
   JWEValidator: () => JWEValidator,
   JWKValidator: () => JWKValidator,
   JWKWithPrivateKeyValidator: () => JWKWithPrivateKeyValidator,
+  JweCredentialRefreshEnvelopeValidator: () => JweCredentialRefreshEnvelopeValidator,
   KnownAchievementTypeValidator: () => KnownAchievementTypeValidator,
   LCNAuthedProfileValidator: () => LCNAuthedProfileValidator,
   LCNBoostClaimLinkOptionsValidator: () => LCNBoostClaimLinkOptionsValidator,
@@ -194,7 +209,9 @@ __export(index_exports, {
   LCNSigningAuthorityValidator: () => LCNSigningAuthorityValidator,
   LCNVisibleProfileValidator: () => LCNVisibleProfileValidator,
   LaunchTypeValidator: () => LaunchTypeValidator,
+  LearnCardRefreshAuthorizationValidator: () => LearnCardRefreshAuthorizationValidator,
   LinkProviderFrameworkInputValidator: () => LinkProviderFrameworkInputValidator,
+  ManagedCredentialRefreshServiceValidator: () => ManagedCredentialRefreshServiceValidator,
   PaginatedAppStoreListingsValidator: () => PaginatedAppStoreListingsValidator,
   PaginatedBoostRecipientsValidator: () => PaginatedBoostRecipientsValidator,
   PaginatedBoostRecipientsWithChildrenValidator: () => PaginatedBoostRecipientsWithChildrenValidator,
@@ -224,6 +241,12 @@ __export(index_exports, {
   ProfileVisibilityEnum: () => ProfileVisibilityEnum,
   PromotionLevelValidator: () => PromotionLevelValidator,
   ProofValidator: () => ProofValidator,
+  PublicCredentialRefreshEnvelopeValidator: () => PublicCredentialRefreshEnvelopeValidator,
+  PublishCredentialRefreshInputValidator: () => PublishCredentialRefreshInputValidator,
+  PublishCredentialRefreshNotificationValidator: () => PublishCredentialRefreshNotificationValidator,
+  PublishCredentialRefreshResultValidator: () => PublishCredentialRefreshResultValidator,
+  PublishIssuerSignedRefreshValidator: () => PublishIssuerSignedRefreshValidator,
+  PublishSigningAuthorityRefreshValidator: () => PublishSigningAuthorityRefreshValidator,
   RefreshServiceValidator: () => RefreshServiceValidator,
   RegExpValidator: () => RegExpValidator,
   RelatedValidator: () => RelatedValidator,
@@ -264,11 +287,13 @@ __export(index_exports, {
   SkillTreeNodeInputValidator: () => SkillTreeNodeInputValidator,
   SkillTreeNodeValidator: () => SkillTreeNodeValidator,
   SkillValidator: () => SkillValidator,
+  StandardCredentialRefreshServiceValidator: () => StandardCredentialRefreshServiceValidator,
   StatusCheckEntryValidator: () => StatusCheckEntryValidator,
   StoredCredentialEnvelopeValidator: () => StoredCredentialEnvelopeValidator,
   StringQuery: () => StringQuery,
   SummaryCredentialDataValidator: () => SummaryCredentialDataValidator,
   SummaryCredentialKeywordValidator: () => SummaryCredentialKeywordValidator,
+  SupportedCredentialRefreshServiceValidator: () => SupportedCredentialRefreshServiceValidator,
   SyncFrameworkInputValidator: () => SyncFrameworkInputValidator,
   TagValidator: () => TagValidator,
   TemplateRenderMethodValidator: () => TemplateRenderMethodValidator,
@@ -15968,7 +15993,8 @@ var LCNAuthedProfileValidator = LCNPublicProfileValidator.extend({
   did: LCNProfileValidator.shape.did
 });
 var LCNConnectionProfileValidator = LCNAuthedProfileValidator.extend({
-  email: LCNProfileValidator.shape.email
+  email: LCNProfileValidator.shape.email,
+  connectedAt: external_exports.iso.datetime().optional().describe("When the viewer and this profile became connected.")
 });
 var LCNVisibleProfileValidator = external_exports.union([
   LCNConnectionProfileValidator.strict(),
@@ -16201,7 +16227,10 @@ 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"),
-  guardianEmail: external_exports.string().email().optional().describe("Guardian email that must approve before student can claim")
+  guardianEmail: external_exports.string().email().optional().describe("Guardian email that must approve before student can claim"),
+  expiresInDays: external_exports.number().int().min(1).max(720).optional().describe(
+    "How many days the credential stays claimable in the Universal Inbox (default 30). Does not change the credential validity period."
+  )
 });
 var SendBoostInputValidator = external_exports.object({
   type: external_exports.literal("boost"),
@@ -16496,7 +16525,8 @@ var LCNNotificationTypeEnumValidator = external_exports.enum([
   "APP_NOTIFICATION",
   "CREDENTIAL_REVOKED",
   "CREDENTIAL_SUSPENDED",
-  "CREDENTIAL_UNSUSPENDED"
+  "CREDENTIAL_UNSUSPENDED",
+  "CREDENTIAL_REFRESHED"
 ]);
 var LCNNotificationMessageValidator = external_exports.object({
   title: external_exports.string().optional(),
@@ -16628,12 +16658,16 @@ var CreateContactMethodSessionResponseValidator = external_exports.object({
 });
 var InboxCredentialValidator = external_exports.object({
   id: external_exports.string(),
-  credential: external_exports.string(),
+  credential: external_exports.string().optional(),
   isSigned: external_exports.boolean(),
   currentStatus: LCNInboxStatusEnumValidator,
   isAccepted: external_exports.boolean().optional(),
   expiresAt: external_exports.string(),
   createdAt: external_exports.string(),
+  finalizedAt: external_exports.string().optional(),
+  expiredAt: external_exports.string().optional(),
+  credentialName: external_exports.string().optional(),
+  achievementType: external_exports.string().optional(),
   issuerDid: external_exports.string(),
   webhookUrl: external_exports.string().optional(),
   boostUri: external_exports.string().optional(),
@@ -16687,7 +16721,9 @@ var IssueInboxCredentialValidator = external_exports.object({
       "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: 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."),
+    expiresInDays: external_exports.number().int().min(1).max(720).optional().describe(
+      "How many days the encrypted inbox payload remains claimable. This does not change the credential validity period."
+    ),
     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."
     ),
@@ -16750,6 +16786,9 @@ var ClaimInboxCredentialValidator = external_exports.object({
   credential: VCValidator.or(VPValidator).or(UnsignedVCValidator).or(CredentialNameRefValidator).describe("The credential to issue, or a { name } reference to resolve a boost template."),
   configuration: external_exports.object({
     publishableKey: external_exports.string(),
+    expiresInDays: external_exports.number().int().min(1).max(720).optional().describe(
+      "Inbox claim window in days. Defaults to 720; use a shorter window for sensitive records."
+    ),
     signingAuthorityName: external_exports.string().optional(),
     listingId: external_exports.string().optional(),
     listingSlug: external_exports.string().optional()
@@ -17390,3 +17429,190 @@ var parseInAppMessagesFlag = /* @__PURE__ */ __name((raw) => {
   const result = inAppMessagesFlagValidator.safeParse(raw);
   return result.success ? result.data : EMPTY_IN_APP_MESSAGES_FLAG;
 }, "parseInAppMessagesFlag");
+
+// src/credential-refresh.ts
+var LearnCardRefreshAuthorizationValidator = external_exports.object({ type: external_exports.literal("LearnCardDIDAuth") }).catchall(external_exports.any());
+var ManagedCredentialRefreshServiceValidator = external_exports.object({
+  id: external_exports.string().min(1),
+  type: external_exports.literal("LearnCardCredentialRefresh2026"),
+  authorization: LearnCardRefreshAuthorizationValidator.optional()
+}).catchall(external_exports.any());
+var StandardCredentialRefreshServiceValidator = external_exports.object({
+  id: external_exports.string().min(1),
+  type: external_exports.literal("1EdTechCredentialRefresh")
+}).catchall(external_exports.any());
+var SupportedCredentialRefreshServiceValidator = external_exports.union([
+  ManagedCredentialRefreshServiceValidator,
+  StandardCredentialRefreshServiceValidator
+]);
+var AllocateCredentialRefreshInputValidator = external_exports.object({
+  holder: external_exports.object({
+    profileId: external_exports.string().optional(),
+    did: external_exports.string().min(1)
+  }),
+  credentialId: external_exports.string().min(1)
+});
+var AllocateCredentialRefreshResultValidator = external_exports.object({
+  refreshId: external_exports.string().min(1),
+  refreshService: ManagedCredentialRefreshServiceValidator.extend({
+    authorization: LearnCardRefreshAuthorizationValidator
+  })
+});
+var CredentialRefreshSigningModeValidator = external_exports.enum(["issuer-signed", "signing-authority"]);
+var PublishCredentialRefreshBaseFields = {
+  refreshId: external_exports.string().min(1),
+  notifyHolder: external_exports.boolean().optional(),
+  updateSummary: external_exports.string().optional(),
+  idempotencyKey: external_exports.string().optional()
+};
+var PublishIssuerSignedRefreshValidator = external_exports.object({
+  ...PublishCredentialRefreshBaseFields,
+  mode: external_exports.literal("issuer-signed"),
+  signedCredential: VCValidator
+});
+var PublishSigningAuthorityRefreshValidator = external_exports.object({
+  ...PublishCredentialRefreshBaseFields,
+  mode: external_exports.literal("signing-authority"),
+  credential: UnsignedVCValidator,
+  signingAuthority: external_exports.object({
+    type: external_exports.string().min(1)
+  }).catchall(external_exports.any())
+});
+var PublishCredentialRefreshInputValidator = external_exports.object({
+  ...PublishCredentialRefreshBaseFields,
+  mode: CredentialRefreshSigningModeValidator,
+  signedCredential: VCValidator.optional(),
+  credential: UnsignedVCValidator.optional(),
+  signingAuthority: external_exports.object({
+    type: external_exports.string().min(1)
+  }).catchall(external_exports.any()).optional()
+}).superRefine((input, ctx) => {
+  if (input.mode === "issuer-signed" && !input.signedCredential) {
+    ctx.addIssue({
+      code: "custom",
+      path: ["signedCredential"],
+      message: "signedCredential is required for issuer-signed publication"
+    });
+  }
+  if (input.mode === "issuer-signed" && (input.credential !== void 0 || input.signingAuthority !== void 0)) {
+    ctx.addIssue({
+      code: "custom",
+      path: ["mode"],
+      message: "issuer-signed publication cannot include signing-authority fields"
+    });
+  }
+  if (input.mode === "signing-authority") {
+    if (input.signedCredential !== void 0) {
+      ctx.addIssue({
+        code: "custom",
+        path: ["signedCredential"],
+        message: "signing-authority publication cannot include signedCredential"
+      });
+    }
+    if (!input.credential) {
+      ctx.addIssue({
+        code: "custom",
+        path: ["credential"],
+        message: "credential is required for signing-authority publication"
+      });
+    }
+    if (!input.signingAuthority) {
+      ctx.addIssue({
+        code: "custom",
+        path: ["signingAuthority"],
+        message: "signingAuthority is required for signing-authority publication"
+      });
+    }
+  }
+});
+var PublishCredentialRefreshNotificationValidator = external_exports.enum([
+  "queued",
+  "suppressed",
+  "not-applicable",
+  /** Publication succeeded, but the post-commit notification enqueue must be retried. */
+  "delivery-failed"
+]);
+var PublishCredentialRefreshResultValidator = external_exports.object({
+  refreshId: external_exports.string().min(1),
+  version: external_exports.number().int().positive(),
+  publishedAt: external_exports.string().min(1),
+  notification: PublishCredentialRefreshNotificationValidator
+});
+var CredentialRefreshVersionMetadataValidator = external_exports.object({
+  version: external_exports.number().int().positive(),
+  publishedAt: external_exports.string().min(1),
+  effectiveAt: external_exports.string().optional(),
+  etag: external_exports.string().optional(),
+  signingMode: CredentialRefreshSigningModeValidator.optional(),
+  updateSummary: external_exports.string().optional()
+});
+var GetCredentialRefreshHistoryInputValidator = external_exports.object({
+  refreshId: external_exports.string().min(1),
+  cursor: external_exports.string().optional(),
+  limit: external_exports.number().int().positive().optional()
+});
+var GetCredentialRefreshHistoryResultValidator = external_exports.object({
+  records: CredentialRefreshVersionMetadataValidator.array(),
+  hasMore: external_exports.boolean(),
+  cursor: external_exports.string().optional()
+});
+var CredentialRefreshChallengeValidator = external_exports.object({
+  challenge: external_exports.string().min(1),
+  expiresAt: external_exports.string().min(1),
+  domain: external_exports.string().optional(),
+  scheme: external_exports.literal("LearnCardDIDAuth").optional()
+});
+var PublicCredentialRefreshEnvelopeValidator = external_exports.object({
+  format: external_exports.literal("vc"),
+  credential: VCValidator,
+  etag: external_exports.string().optional()
+});
+var JweCredentialRefreshEnvelopeValidator = external_exports.object({
+  format: external_exports.literal("jwe"),
+  jwe: JWEValidator,
+  etag: external_exports.string().optional(),
+  /** Present on LearnCard-managed endpoints; optional for interoperable JWE services. */
+  version: external_exports.number().int().positive().optional()
+});
+var CredentialRefreshResponseEnvelopeValidator = external_exports.discriminatedUnion("format", [
+  PublicCredentialRefreshEnvelopeValidator,
+  JweCredentialRefreshEnvelopeValidator
+]);
+var CredentialRefreshFailureCodeValidator = external_exports.enum([
+  "UNAVAILABLE",
+  "TIMEOUT",
+  "UNSUPPORTED_SERVICE",
+  "UNAUTHORIZED",
+  "MALFORMED_RESPONSE",
+  "INVALID_PROOF",
+  "ISSUER_MISMATCH",
+  "ID_MISMATCH",
+  "ROLLBACK",
+  "REVOKED",
+  "UNSAFE_ENDPOINT"
+]);
+var CredentialRefreshUpdatedResultValidator = external_exports.object({
+  status: external_exports.literal("updated"),
+  credential: VCValidator,
+  etag: external_exports.string().optional(),
+  managedVersion: external_exports.number().int().positive().optional()
+});
+var CredentialRefreshUnchangedResultValidator = external_exports.object({
+  status: external_exports.literal("unchanged"),
+  checkedAt: external_exports.string().min(1),
+  etag: external_exports.string().optional()
+});
+var CredentialRefreshUnsupportedResultValidator = external_exports.object({
+  status: external_exports.literal("unsupported")
+});
+var CredentialRefreshFailedResultValidator = external_exports.object({
+  status: external_exports.literal("failed"),
+  code: CredentialRefreshFailureCodeValidator,
+  retryable: external_exports.boolean()
+});
+var CredentialRefreshResultValidator = external_exports.discriminatedUnion("status", [
+  CredentialRefreshUpdatedResultValidator,
+  CredentialRefreshUnchangedResultValidator,
+  CredentialRefreshUnsupportedResultValidator,
+  CredentialRefreshFailedResultValidator
+]);