@learncard/types 5.18.3 → 5.20.0

package/dist/types.esm.js

@@ -138,14 +138,22 @@ var UnsignedVCValidator = z.object({
 }).catchall(z.any());
 var ProofValidator = z.object({
   type: z.string(),
-  created: z.string(),
+  created: z.string().optional(),
   challenge: z.string().optional(),
   domain: z.string().optional(),
   nonce: z.string().optional(),
   proofPurpose: z.string(),
   verificationMethod: z.string(),
   jws: z.string().optional()
-}).catchall(z.any());
+}).catchall(z.any()).superRefine((proof, ctx) => {
+  if (proof.created === void 0 && (proof.type !== "DataIntegrityProof" || proof.cryptosuite !== "ecdsa-rdfc-2019")) {
+    ctx.addIssue({
+      code: "custom",
+      path: ["created"],
+      message: "created is required for this proof suite"
+    });
+  }
+});
 var VCValidator = UnsignedVCValidator.extend({
   proof: ProofValidator.or(ProofValidator.array())
 });
@@ -942,7 +950,10 @@ var SendOptionsValidator = z11.object({
   webhookUrl: z11.string().url().optional().describe("Webhook URL to receive claim notifications"),
   suppressDelivery: z11.boolean().optional().describe("If true, returns claimUrl without sending email/SMS"),
   branding: SendBrandingOptionsValidator.optional().describe("Branding for email/SMS delivery"),
-  guardianEmail: z11.string().email().optional().describe("Guardian email that must approve before student can claim")
+  guardianEmail: z11.string().email().optional().describe("Guardian email that must approve before student can claim"),
+  expiresInDays: z11.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 = z11.object({
   type: z11.literal("boost"),
@@ -1063,15 +1074,6 @@ var ConsentFlowContractDataValidator = z11.object({
 var PaginatedConsentFlowDataValidator = PaginationResponseValidator.extend({
   records: ConsentFlowContractDataValidator.array()
 });
-var ConsentFlowContractDataForDidValidator = z11.object({
-  credentials: z11.object({ category: z11.string(), uri: z11.string() }).array(),
-  personal: z11.record(z11.string(), z11.string()).default({}),
-  date: z11.string(),
-  contractUri: z11.string()
-});
-var PaginatedConsentFlowDataForDidValidator = PaginationResponseValidator.extend({
-  records: ConsentFlowContractDataForDidValidator.array()
-});
 var ConsentFlowTermValidator = z11.object({
   sharing: z11.boolean().optional(),
   shared: z11.string().array().optional(),
@@ -1105,6 +1107,34 @@ var PaginatedConsentFlowTermsValidator = PaginationResponseValidator.extend({
     status: ConsentFlowTermsStatusValidator
   }).array()
 });
+var ConsentFlowGuardianApprovalValidator = z11.object({
+  guardianProfileId: z11.string(),
+  guardianDid: z11.string(),
+  approvedAt: z11.string().datetime(),
+  contractUpdatedAt: z11.string()
+});
+var ConsentFlowContractDataForDidValidator = z11.object({
+  credentials: z11.object({ category: z11.string(), uri: z11.string() }).array(),
+  personal: z11.record(z11.string(), z11.string()).default({}),
+  date: z11.string(),
+  createdAt: z11.string().optional(),
+  contractUpdatedAt: z11.string(),
+  contractExpiresAt: z11.string().optional(),
+  reasonForAccessing: z11.string().optional(),
+  guardian: z11.object({
+    required: z11.boolean(),
+    approved: z11.boolean(),
+    approval: ConsentFlowGuardianApprovalValidator.optional()
+  }),
+  contractUri: z11.string(),
+  termsUri: z11.string(),
+  status: ConsentFlowTermsStatusValidator,
+  expiresAt: z11.string().optional(),
+  terms: ConsentFlowTermsValidator
+});
+var PaginatedConsentFlowDataForDidValidator = PaginationResponseValidator.extend({
+  records: ConsentFlowContractDataForDidValidator.array()
+});
 var ConsentFlowContractQueryValidator = z11.object({
   read: z11.object({
     anonymize: z11.boolean().optional(),
@@ -1165,6 +1195,7 @@ var ConsentFlowTransactionValidator = z11.object({
   expiresAt: z11.string().optional(),
   oneTime: z11.boolean().optional(),
   terms: ConsentFlowTermsValidator.optional(),
+  guardianApproval: ConsentFlowGuardianApprovalValidator.optional(),
   id: z11.string(),
   action: ConsentFlowTransactionActionValidator,
   date: z11.string(),
@@ -1237,7 +1268,8 @@ var LCNNotificationTypeEnumValidator = z11.enum([
   "APP_NOTIFICATION",
   "CREDENTIAL_REVOKED",
   "CREDENTIAL_SUSPENDED",
-  "CREDENTIAL_UNSUSPENDED"
+  "CREDENTIAL_UNSUSPENDED",
+  "CREDENTIAL_REFRESHED"
 ]);
 var LCNNotificationMessageValidator = z11.object({
   title: z11.string().optional(),
@@ -1369,12 +1401,16 @@ var CreateContactMethodSessionResponseValidator = z11.object({
 });
 var InboxCredentialValidator = z11.object({
   id: z11.string(),
-  credential: z11.string(),
+  credential: z11.string().optional(),
   isSigned: z11.boolean(),
   currentStatus: LCNInboxStatusEnumValidator,
   isAccepted: z11.boolean().optional(),
   expiresAt: z11.string(),
   createdAt: z11.string(),
+  finalizedAt: z11.string().optional(),
+  expiredAt: z11.string().optional(),
+  credentialName: z11.string().optional(),
+  achievementType: z11.string().optional(),
   issuerDid: z11.string(),
   webhookUrl: z11.string().optional(),
   boostUri: z11.string().optional(),
@@ -1428,7 +1464,9 @@ var IssueInboxCredentialValidator = z11.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: z11.string().url().optional().describe("The webhook URL to receive credential issuance events."),
-    expiresInDays: z11.number().min(1).max(365).optional().describe("The number of days the credential will be valid for."),
+    expiresInDays: z11.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: z11.record(z11.string(), z11.unknown()).optional().describe(
       "Template data to render into the boost credential template using Mustache syntax. Only used when boostUri is provided."
     ),
@@ -1491,6 +1529,9 @@ var ClaimInboxCredentialValidator = z11.object({
   credential: VCValidator.or(VPValidator).or(UnsignedVCValidator).or(CredentialNameRefValidator).describe("The credential to issue, or a { name } reference to resolve a boost template."),
   configuration: z11.object({
     publishableKey: z11.string(),
+    expiresInDays: z11.number().int().min(1).max(720).optional().describe(
+      "Inbox claim window in days. Defaults to 720; use a shorter window for sensitive records."
+    ),
     signingAuthorityName: z11.string().optional(),
     listingId: z11.string().optional(),
     listingSlug: z11.string().optional()
@@ -2133,6 +2174,194 @@ 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
+import { z as z14 } from "zod/v4";
+var LearnCardRefreshAuthorizationValidator = z14.object({ type: z14.literal("LearnCardDIDAuth") }).catchall(z14.any());
+var ManagedCredentialRefreshServiceValidator = z14.object({
+  id: z14.string().min(1),
+  type: z14.literal("LearnCardCredentialRefresh2026"),
+  authorization: LearnCardRefreshAuthorizationValidator.optional()
+}).catchall(z14.any());
+var StandardCredentialRefreshServiceValidator = z14.object({
+  id: z14.string().min(1),
+  type: z14.literal("1EdTechCredentialRefresh")
+}).catchall(z14.any());
+var SupportedCredentialRefreshServiceValidator = z14.union([
+  ManagedCredentialRefreshServiceValidator,
+  StandardCredentialRefreshServiceValidator
+]);
+var AllocateCredentialRefreshInputValidator = z14.object({
+  holder: z14.object({
+    profileId: z14.string().optional(),
+    did: z14.string().min(1)
+  }),
+  credentialId: z14.string().min(1)
+});
+var AllocateCredentialRefreshResultValidator = z14.object({
+  refreshId: z14.string().min(1),
+  refreshService: ManagedCredentialRefreshServiceValidator.extend({
+    authorization: LearnCardRefreshAuthorizationValidator
+  })
+});
+var CredentialRefreshSigningModeValidator = z14.enum(["issuer-signed", "signing-authority"]);
+var PublishCredentialRefreshBaseFields = {
+  refreshId: z14.string().min(1),
+  notifyHolder: z14.boolean().optional(),
+  updateSummary: z14.string().optional(),
+  idempotencyKey: z14.string().optional()
+};
+var PublishIssuerSignedRefreshValidator = z14.object({
+  ...PublishCredentialRefreshBaseFields,
+  mode: z14.literal("issuer-signed"),
+  signedCredential: VCValidator
+});
+var PublishSigningAuthorityRefreshValidator = z14.object({
+  ...PublishCredentialRefreshBaseFields,
+  mode: z14.literal("signing-authority"),
+  credential: UnsignedVCValidator,
+  signingAuthority: z14.object({
+    type: z14.string().min(1)
+  }).catchall(z14.any())
+});
+var PublishCredentialRefreshInputValidator = z14.object({
+  ...PublishCredentialRefreshBaseFields,
+  mode: CredentialRefreshSigningModeValidator,
+  signedCredential: VCValidator.optional(),
+  credential: UnsignedVCValidator.optional(),
+  signingAuthority: z14.object({
+    type: z14.string().min(1)
+  }).catchall(z14.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 = z14.enum([
+  "queued",
+  "suppressed",
+  "not-applicable",
+  /** Publication succeeded, but the post-commit notification enqueue must be retried. */
+  "delivery-failed"
+]);
+var PublishCredentialRefreshResultValidator = z14.object({
+  refreshId: z14.string().min(1),
+  version: z14.number().int().positive(),
+  publishedAt: z14.string().min(1),
+  notification: PublishCredentialRefreshNotificationValidator
+});
+var CredentialRefreshVersionMetadataValidator = z14.object({
+  version: z14.number().int().positive(),
+  publishedAt: z14.string().min(1),
+  effectiveAt: z14.string().optional(),
+  etag: z14.string().optional(),
+  signingMode: CredentialRefreshSigningModeValidator.optional(),
+  updateSummary: z14.string().optional()
+});
+var GetCredentialRefreshHistoryInputValidator = z14.object({
+  refreshId: z14.string().min(1),
+  cursor: z14.string().optional(),
+  limit: z14.number().int().positive().optional()
+});
+var GetCredentialRefreshHistoryResultValidator = z14.object({
+  records: CredentialRefreshVersionMetadataValidator.array(),
+  hasMore: z14.boolean(),
+  cursor: z14.string().optional()
+});
+var CredentialRefreshChallengeValidator = z14.object({
+  challenge: z14.string().min(1),
+  expiresAt: z14.string().min(1),
+  domain: z14.string().optional(),
+  scheme: z14.literal("LearnCardDIDAuth").optional()
+});
+var PublicCredentialRefreshEnvelopeValidator = z14.object({
+  format: z14.literal("vc"),
+  credential: VCValidator,
+  etag: z14.string().optional()
+});
+var JweCredentialRefreshEnvelopeValidator = z14.object({
+  format: z14.literal("jwe"),
+  jwe: JWEValidator,
+  etag: z14.string().optional(),
+  /** Present on LearnCard-managed endpoints; optional for interoperable JWE services. */
+  version: z14.number().int().positive().optional()
+});
+var CredentialRefreshResponseEnvelopeValidator = z14.discriminatedUnion("format", [
+  PublicCredentialRefreshEnvelopeValidator,
+  JweCredentialRefreshEnvelopeValidator
+]);
+var CredentialRefreshFailureCodeValidator = z14.enum([
+  "UNAVAILABLE",
+  "TIMEOUT",
+  "UNSUPPORTED_SERVICE",
+  "UNAUTHORIZED",
+  "MALFORMED_RESPONSE",
+  "INVALID_PROOF",
+  "ISSUER_MISMATCH",
+  "ID_MISMATCH",
+  "ROLLBACK",
+  "REVOKED",
+  "UNSAFE_ENDPOINT"
+]);
+var CredentialRefreshUpdatedResultValidator = z14.object({
+  status: z14.literal("updated"),
+  credential: VCValidator,
+  etag: z14.string().optional(),
+  managedVersion: z14.number().int().positive().optional()
+});
+var CredentialRefreshUnchangedResultValidator = z14.object({
+  status: z14.literal("unchanged"),
+  checkedAt: z14.string().min(1),
+  etag: z14.string().optional()
+});
+var CredentialRefreshUnsupportedResultValidator = z14.object({
+  status: z14.literal("unsupported")
+});
+var CredentialRefreshFailedResultValidator = z14.object({
+  status: z14.literal("failed"),
+  code: CredentialRefreshFailureCodeValidator,
+  retryable: z14.boolean()
+});
+var CredentialRefreshResultValidator = z14.discriminatedUnion("status", [
+  CredentialRefreshUpdatedResultValidator,
+  CredentialRefreshUnchangedResultValidator,
+  CredentialRefreshUnsupportedResultValidator,
+  CredentialRefreshFailedResultValidator
+]);
 export {
   AUTH_GRANT_AUDIENCE_DOMAIN_PREFIX,
   AchievementCredentialValidator,
@@ -2145,6 +2374,8 @@ export {
   AgeRatingValidator,
   AlignmentTargetTypeValidator,
   AlignmentValidator,
+  AllocateCredentialRefreshInputValidator,
+  AllocateCredentialRefreshResultValidator,
   AllocateCredentialStatusInputValidator,
   AllocatedBitstringStatusListEntryValidator,
   AllowConnectionRequestsEnum,
@@ -2194,6 +2425,7 @@ export {
   ConsentFlowContractValidator,
   ConsentFlowDataForDidQueryValidator,
   ConsentFlowDataQueryValidator,
+  ConsentFlowGuardianApprovalValidator,
   ConsentFlowTermValidator,
   ConsentFlowTermsQueryValidator,
   ConsentFlowTermsStatusValidator,
@@ -2226,6 +2458,16 @@ export {
   CredentialInfoValidator,
   CredentialNameRefValidator,
   CredentialRecordValidator,
+  CredentialRefreshChallengeValidator,
+  CredentialRefreshFailedResultValidator,
+  CredentialRefreshFailureCodeValidator,
+  CredentialRefreshResponseEnvelopeValidator,
+  CredentialRefreshResultValidator,
+  CredentialRefreshSigningModeValidator,
+  CredentialRefreshUnchangedResultValidator,
+  CredentialRefreshUnsupportedResultValidator,
+  CredentialRefreshUpdatedResultValidator,
+  CredentialRefreshVersionMetadataValidator,
   CredentialSchemaValidator,
   CredentialStatusValidator,
   CredentialSubjectValidator,
@@ -2246,6 +2488,8 @@ export {
   GeoCoordinatesValidator,
   GetCounterEventValidator,
   GetCountersEventValidator,
+  GetCredentialRefreshHistoryInputValidator,
+  GetCredentialRefreshHistoryResultValidator,
   GetFullSkillTreeInputValidator,
   GetFullSkillTreeResultValidator,
   GetSkillPathInputValidator,
@@ -2270,6 +2514,7 @@ export {
   JWEValidator,
   JWKValidator,
   JWKWithPrivateKeyValidator,
+  JweCredentialRefreshEnvelopeValidator,
   KnownAchievementTypeValidator,
   LCNAuthedProfileValidator,
   LCNBoostClaimLinkOptionsValidator,
@@ -2307,7 +2552,9 @@ export {
   LCNSigningAuthorityValidator,
   LCNVisibleProfileValidator,
   LaunchTypeValidator,
+  LearnCardRefreshAuthorizationValidator,
   LinkProviderFrameworkInputValidator,
+  ManagedCredentialRefreshServiceValidator,
   PaginatedAppStoreListingsValidator,
   PaginatedBoostRecipientsValidator,
   PaginatedBoostRecipientsWithChildrenValidator,
@@ -2337,6 +2584,12 @@ export {
   ProfileVisibilityEnum,
   PromotionLevelValidator,
   ProofValidator,
+  PublicCredentialRefreshEnvelopeValidator,
+  PublishCredentialRefreshInputValidator,
+  PublishCredentialRefreshNotificationValidator,
+  PublishCredentialRefreshResultValidator,
+  PublishIssuerSignedRefreshValidator,
+  PublishSigningAuthorityRefreshValidator,
   RefreshServiceValidator,
   RegExpValidator,
   RelatedValidator,
@@ -2377,11 +2630,13 @@ export {
   SkillTreeNodeInputValidator,
   SkillTreeNodeValidator,
   SkillValidator,
+  StandardCredentialRefreshServiceValidator,
   StatusCheckEntryValidator,
   StoredCredentialEnvelopeValidator,
   StringQuery,
   SummaryCredentialDataValidator,
   SummaryCredentialKeywordValidator,
+  SupportedCredentialRefreshServiceValidator,
   SyncFrameworkInputValidator,
   TagValidator,
   TemplateRenderMethodValidator,