@learncard/types 5.17.6 → 5.18.1

package/dist/types.esm.js

@@ -84,7 +84,7 @@ var ProfileValidator = z.string().or(
   }).catchall(z.any())
 );
 var CredentialSubjectValidator = z.object({ id: z.string().optional() }).catchall(z.any());
-var CredentialStatusValidator = z.object({ type: z.string(), id: z.string() }).catchall(z.any());
+var CredentialStatusValidator = z.object({ type: z.string(), id: z.string().optional() }).catchall(z.any());
 var CredentialSchemaValidator = z.object({ id: z.string(), type: z.string() }).catchall(z.any());
 var RefreshServiceValidator = z.object({ id: z.string().optional(), type: z.string() }).catchall(z.any());
 var TermsOfUseValidator = z.object({ type: z.string(), id: z.string().optional() }).catchall(z.any());
@@ -505,8 +505,17 @@ var StatusCheckEntryValidator = z7.object({
   statusListIndex: z7.string().optional()
 });
 var VerificationCheckValidator = z7.object({
+  /**
+   * Checks that completed successfully. This does not imply that warnings can be ignored.
+   */
   checks: z7.string().array(),
+  /**
+   * Security-relevant conditions that did not prevent the requested cryptographic checks from
+   * completing. In particular, a non-DID issuer warning means the signature is valid but the
+   * named URL issuer's authorization of that signing key was not established.
+   */
   warnings: z7.string().array(),
+  /** Verification failures that prevented one or more requested checks from succeeding. */
   errors: z7.string().array(),
   /**
    * Per-entry results for the `credentialStatus` check, populated
@@ -651,6 +660,9 @@ var LCNProfileValidator = z11.object({
   role: z11.string().default("").optional().describe('Role of the profile: e.g. "teacher", "student".'),
   dob: z11.string().default("").optional().describe('Date of birth of the profile: e.g. "1990-01-01".'),
   country: z11.string().optional().describe("Country for the profile."),
+  locale: z11.string().optional().describe(
+    "BCP-47 language tag (e.g. 'es', 'fr', 'ar') \u2014 the user's preferred language for server-sent notifications and emails."
+  ),
   approved: z11.boolean().optional().describe("Approval status for the profile.")
 });
 var LCNPublicProfileValidator = LCNProfileValidator.pick({
@@ -1196,7 +1208,10 @@ var LCNNotificationTypeEnumValidator = z11.enum([
   "GUARDIAN_APPROVAL_PENDING",
   "GUARDIAN_APPROVED",
   "GUARDIAN_REJECTED",
-  "APP_NOTIFICATION"
+  "APP_NOTIFICATION",
+  "CREDENTIAL_REVOKED",
+  "CREDENTIAL_SUSPENDED",
+  "CREDENTIAL_UNSUSPENDED"
 ]);
 var LCNNotificationMessageValidator = z11.object({
   title: z11.string().optional(),
@@ -1979,7 +1994,7 @@ var BitstringStatusListEntryValidator = z12.object({
   id: z12.string().optional(),
   type: z12.literal("BitstringStatusListEntry"),
   statusPurpose: BitstringStatusPurposeValidator,
-  statusListIndex: z12.string(),
+  statusListIndex: z12.string().or(z12.number().int().nonnegative()),
   statusListCredential: z12.string()
 });
 var AllocatedBitstringStatusListEntryValidator = BitstringStatusListEntryValidator.extend({
@@ -1995,6 +2010,100 @@ var AllocateCredentialStatusInputValidator = z12.object({
   statusPurposes: z12.array(BitstringStatusPurposeValidator).optional(),
   listSize: z12.number().int().positive().optional()
 }).default({});
+
+// src/inAppMessages.ts
+import { z as z13 } from "zod";
+var inAppMessagePlatformValidator = z13.enum(["ios", "android", "web"]);
+var inAppMessageVersionSourceValidator = z13.enum(["native", "web", "capgo"]);
+var inAppMessageVersionOpValidator = z13.enum(["lt", "lte", "eq", "gte", "gt"]);
+var platformPredicateValidator = z13.object({ platform: z13.array(inAppMessagePlatformValidator).nonempty() }).strict();
+var rolePredicateValidator = z13.object({ role: z13.array(z13.string()).nonempty() }).strict();
+var versionPredicateValidator = z13.object({
+  version: z13.object({
+    source: inAppMessageVersionSourceValidator,
+    op: inAppMessageVersionOpValidator,
+    value: z13.string()
+  }).strict()
+}).strict();
+var inAppMessagePredicateValidator = z13.lazy(
+  () => z13.union([
+    platformPredicateValidator,
+    rolePredicateValidator,
+    versionPredicateValidator,
+    z13.object({ all: z13.array(inAppMessagePredicateValidator) }).strict(),
+    z13.object({ any: z13.array(inAppMessagePredicateValidator) }).strict(),
+    z13.object({ not: inAppMessagePredicateValidator }).strict()
+  ])
+);
+var inAppMessageActionStyleValidator = z13.enum(["primary", "secondary", "positive", "dismiss"]).default("secondary");
+var internalLinkActionValidator = z13.object({ type: z13.literal("internalLink"), path: z13.string() }).passthrough();
+var externalLinkActionValidator = z13.object({ type: z13.literal("externalLink"), url: z13.string() }).passthrough();
+var appStoreActionValidator = z13.object({
+  type: z13.literal("appStore"),
+  iosUrl: z13.string().optional(),
+  androidUrl: z13.string().optional(),
+  webUrl: z13.string().optional()
+}).passthrough();
+var capgoUpdateActionValidator = z13.object({ type: z13.literal("capgoUpdate") }).passthrough();
+var dismissActionValidator = z13.object({ type: z13.literal("dismiss") }).passthrough();
+var inAppMessageActionTargetValidator = z13.union([
+  internalLinkActionValidator,
+  externalLinkActionValidator,
+  appStoreActionValidator,
+  capgoUpdateActionValidator,
+  dismissActionValidator
+]);
+var inAppMessageActionValidator = z13.object({
+  label: z13.string(),
+  style: inAppMessageActionStyleValidator,
+  action: inAppMessageActionTargetValidator,
+  /** When true, the message closes after this action runs (default true). */
+  closeOnComplete: z13.boolean().default(true)
+}).passthrough();
+var inAppMessageMediaValidator = z13.object({
+  type: z13.enum(["youtube", "image", "gif"]),
+  url: z13.string(),
+  /** Aspect ratio hint, e.g. "16:9" or "1:1". Defaults to 16:9. */
+  aspect: z13.string().default("16:9"),
+  /** Alt text for images/gifs (accessibility). */
+  alt: z13.string().optional()
+}).passthrough();
+var inAppMessageFrequencyValidator = z13.union([
+  z13.literal("once"),
+  z13.literal("session"),
+  z13.literal("always"),
+  z13.object({ everyDays: z13.number().positive() }).strict()
+]).default("once");
+var inAppMessagePresentationValidator = z13.enum(["modal", "banner", "toast"]).default("modal");
+var inAppMessageValidator = z13.object({
+  /** Stable identifier — used to persist dismissal / frequency state. */
+  id: z13.string(),
+  /** Higher priority wins when multiple messages match. Default 0. */
+  priority: z13.number().default(0),
+  /** When false, the message is required/blocking (no dismiss affordance). */
+  dismissible: z13.boolean().default(true),
+  frequency: inAppMessageFrequencyValidator,
+  presentation: inAppMessagePresentationValidator,
+  media: inAppMessageMediaValidator.optional(),
+  /** Optional emoji hero glyph — rendered only when `media` is not set. */
+  emoji: z13.string().optional(),
+  title: z13.string(),
+  body: z13.string().optional(),
+  actions: z13.array(inAppMessageActionValidator).default([]),
+  /** Targeting predicate tree. Omitted → matches everyone. */
+  targeting: inAppMessagePredicateValidator.optional(),
+  /** Allow disabling a message without removing it from the flag. */
+  enabled: z13.boolean().default(true)
+}).passthrough();
+var inAppMessagesFlagValidator = z13.object({
+  version: z13.number().default(1),
+  messages: z13.array(inAppMessageValidator).default([])
+}).passthrough();
+var EMPTY_IN_APP_MESSAGES_FLAG = { version: 1, messages: [] };
+var parseInAppMessagesFlag = /* @__PURE__ */ __name((raw) => {
+  const result = inAppMessagesFlagValidator.safeParse(raw);
+  return result.success ? result.data : EMPTY_IN_APP_MESSAGES_FLAG;
+}, "parseInAppMessagesFlag");
 export {
   AUTH_GRANT_AUDIENCE_DOMAIN_PREFIX,
   AchievementCredentialValidator,
@@ -2096,6 +2205,7 @@ export {
   DeleteFrameworkInputValidator,
   DeleteSkillInputValidator,
   DidDocumentValidator,
+  EMPTY_IN_APP_MESSAGES_FLAG,
   EncryptedCredentialRecordValidator,
   EncryptedRecordValidator,
   EndorsementCredentialValidator,
@@ -2254,5 +2364,26 @@ export {
   VerificationMethodValidator,
   VerificationStatusEnum,
   VerificationStatusValidator,
-  isStoredCredentialEnvelope
+  appStoreActionValidator,
+  capgoUpdateActionValidator,
+  dismissActionValidator,
+  externalLinkActionValidator,
+  inAppMessageActionStyleValidator,
+  inAppMessageActionTargetValidator,
+  inAppMessageActionValidator,
+  inAppMessageFrequencyValidator,
+  inAppMessageMediaValidator,
+  inAppMessagePlatformValidator,
+  inAppMessagePredicateValidator,
+  inAppMessagePresentationValidator,
+  inAppMessageValidator,
+  inAppMessageVersionOpValidator,
+  inAppMessageVersionSourceValidator,
+  inAppMessagesFlagValidator,
+  internalLinkActionValidator,
+  isStoredCredentialEnvelope,
+  parseInAppMessagesFlag,
+  platformPredicateValidator,
+  rolePredicateValidator,
+  versionPredicateValidator
 };