@learncard/helpers 1.3.9 → 1.3.11

package/dist/helpers.d.cts

@@ -130,11 +130,11 @@ declare const UnsignedVCValidator: z.ZodObject<{
 	credentialStatus: z.ZodOptional<z.ZodUnion<[
 		z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>,
 		z.ZodArray<z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>>
 	]>>;
 	name: z.ZodOptional<z.ZodString>;
@@ -144,11 +144,11 @@ declare const UnsignedVCValidator: z.ZodObject<{
 	status: z.ZodOptional<z.ZodUnion<[
 		z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>,
 		z.ZodArray<z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>>
 	]>>;
 	termsOfUse: z.ZodOptional<z.ZodUnion<[
@@ -334,11 +334,11 @@ declare const VCValidator: z.ZodObject<{
 	credentialStatus: z.ZodOptional<z.ZodUnion<[
 		z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>,
 		z.ZodArray<z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>>
 	]>>;
 	name: z.ZodOptional<z.ZodString>;
@@ -348,11 +348,11 @@ declare const VCValidator: z.ZodObject<{
 	status: z.ZodOptional<z.ZodUnion<[
 		z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>,
 		z.ZodArray<z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>>
 	]>>;
 	termsOfUse: z.ZodOptional<z.ZodUnion<[
@@ -554,7 +554,10 @@ declare const BitstringStatusListEntryValidator: z.ZodObject<{
 		revocation: "revocation";
 		suspension: "suspension";
 	}>;
-	statusListIndex: z.ZodString;
+	statusListIndex: z.ZodUnion<[
+		z.ZodString,
+		z.ZodNumber
+	]>;
 	statusListCredential: z.ZodString;
 }, z.core.$strip>;
 export type BitstringStatusListEntry = z.infer<typeof BitstringStatusListEntryValidator>;
@@ -943,6 +946,8 @@ export declare const projectEnvelopeToDisplayVc: (envelope: StoredCredentialEnve
  * `read.get` result without branching themselves).
  */
 export declare const resolveStorageReadResult: (value: VC | StoredCredentialEnvelope | undefined) => VC | StoredCredentialEnvelope | undefined;
+/** Generates a did:web for a user given the app domain and profile ID. */
+export declare const getDidWeb: (domain: string, profileId: string) => string;
 /**
  * Determines whether or not a string is a valid hexadecimal string
  *

package/dist/helpers.d.ts

@@ -130,11 +130,11 @@ declare const UnsignedVCValidator: z.ZodObject<{
 	credentialStatus: z.ZodOptional<z.ZodUnion<[
 		z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>,
 		z.ZodArray<z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>>
 	]>>;
 	name: z.ZodOptional<z.ZodString>;
@@ -144,11 +144,11 @@ declare const UnsignedVCValidator: z.ZodObject<{
 	status: z.ZodOptional<z.ZodUnion<[
 		z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>,
 		z.ZodArray<z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>>
 	]>>;
 	termsOfUse: z.ZodOptional<z.ZodUnion<[
@@ -334,11 +334,11 @@ declare const VCValidator: z.ZodObject<{
 	credentialStatus: z.ZodOptional<z.ZodUnion<[
 		z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>,
 		z.ZodArray<z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>>
 	]>>;
 	name: z.ZodOptional<z.ZodString>;
@@ -348,11 +348,11 @@ declare const VCValidator: z.ZodObject<{
 	status: z.ZodOptional<z.ZodUnion<[
 		z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>,
 		z.ZodArray<z.ZodObject<{
 			type: z.ZodString;
-			id: z.ZodString;
+			id: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>>
 	]>>;
 	termsOfUse: z.ZodOptional<z.ZodUnion<[
@@ -554,7 +554,10 @@ declare const BitstringStatusListEntryValidator: z.ZodObject<{
 		revocation: "revocation";
 		suspension: "suspension";
 	}>;
-	statusListIndex: z.ZodString;
+	statusListIndex: z.ZodUnion<[
+		z.ZodString,
+		z.ZodNumber
+	]>;
 	statusListCredential: z.ZodString;
 }, z.core.$strip>;
 export type BitstringStatusListEntry = z.infer<typeof BitstringStatusListEntryValidator>;
@@ -943,6 +946,8 @@ export declare const projectEnvelopeToDisplayVc: (envelope: StoredCredentialEnve
  * `read.get` result without branching themselves).
  */
 export declare const resolveStorageReadResult: (value: VC | StoredCredentialEnvelope | undefined) => VC | StoredCredentialEnvelope | undefined;
+/** Generates a did:web for a user given the app domain and profile ID. */
+export declare const getDidWeb: (domain: string, profileId: string) => string;
 /**
  * Determines whether or not a string is a valid hexadecimal string
  *

package/dist/helpers.esm.js

@@ -153,6 +153,7 @@ var require_types_cjs_development = __commonJS({
       DeleteFrameworkInputValidator: /* @__PURE__ */ __name(() => DeleteFrameworkInputValidator, "DeleteFrameworkInputValidator"),
       DeleteSkillInputValidator: /* @__PURE__ */ __name(() => DeleteSkillInputValidator, "DeleteSkillInputValidator"),
       DidDocumentValidator: /* @__PURE__ */ __name(() => DidDocumentValidator, "DidDocumentValidator"),
+      EMPTY_IN_APP_MESSAGES_FLAG: /* @__PURE__ */ __name(() => EMPTY_IN_APP_MESSAGES_FLAG, "EMPTY_IN_APP_MESSAGES_FLAG"),
       EncryptedCredentialRecordValidator: /* @__PURE__ */ __name(() => EncryptedCredentialRecordValidator, "EncryptedCredentialRecordValidator"),
       EncryptedRecordValidator: /* @__PURE__ */ __name(() => EncryptedRecordValidator, "EncryptedRecordValidator"),
       EndorsementCredentialValidator: /* @__PURE__ */ __name(() => EndorsementCredentialValidator, "EndorsementCredentialValidator"),
@@ -311,7 +312,28 @@ var require_types_cjs_development = __commonJS({
       VerificationMethodValidator: /* @__PURE__ */ __name(() => VerificationMethodValidator, "VerificationMethodValidator"),
       VerificationStatusEnum: /* @__PURE__ */ __name(() => VerificationStatusEnum, "VerificationStatusEnum"),
       VerificationStatusValidator: /* @__PURE__ */ __name(() => VerificationStatusValidator, "VerificationStatusValidator"),
-      isStoredCredentialEnvelope: /* @__PURE__ */ __name(() => isStoredCredentialEnvelope2, "isStoredCredentialEnvelope")
+      appStoreActionValidator: /* @__PURE__ */ __name(() => appStoreActionValidator, "appStoreActionValidator"),
+      capgoUpdateActionValidator: /* @__PURE__ */ __name(() => capgoUpdateActionValidator, "capgoUpdateActionValidator"),
+      dismissActionValidator: /* @__PURE__ */ __name(() => dismissActionValidator, "dismissActionValidator"),
+      externalLinkActionValidator: /* @__PURE__ */ __name(() => externalLinkActionValidator, "externalLinkActionValidator"),
+      inAppMessageActionStyleValidator: /* @__PURE__ */ __name(() => inAppMessageActionStyleValidator, "inAppMessageActionStyleValidator"),
+      inAppMessageActionTargetValidator: /* @__PURE__ */ __name(() => inAppMessageActionTargetValidator, "inAppMessageActionTargetValidator"),
+      inAppMessageActionValidator: /* @__PURE__ */ __name(() => inAppMessageActionValidator, "inAppMessageActionValidator"),
+      inAppMessageFrequencyValidator: /* @__PURE__ */ __name(() => inAppMessageFrequencyValidator, "inAppMessageFrequencyValidator"),
+      inAppMessageMediaValidator: /* @__PURE__ */ __name(() => inAppMessageMediaValidator, "inAppMessageMediaValidator"),
+      inAppMessagePlatformValidator: /* @__PURE__ */ __name(() => inAppMessagePlatformValidator, "inAppMessagePlatformValidator"),
+      inAppMessagePredicateValidator: /* @__PURE__ */ __name(() => inAppMessagePredicateValidator, "inAppMessagePredicateValidator"),
+      inAppMessagePresentationValidator: /* @__PURE__ */ __name(() => inAppMessagePresentationValidator, "inAppMessagePresentationValidator"),
+      inAppMessageValidator: /* @__PURE__ */ __name(() => inAppMessageValidator, "inAppMessageValidator"),
+      inAppMessageVersionOpValidator: /* @__PURE__ */ __name(() => inAppMessageVersionOpValidator, "inAppMessageVersionOpValidator"),
+      inAppMessageVersionSourceValidator: /* @__PURE__ */ __name(() => inAppMessageVersionSourceValidator, "inAppMessageVersionSourceValidator"),
+      inAppMessagesFlagValidator: /* @__PURE__ */ __name(() => inAppMessagesFlagValidator, "inAppMessagesFlagValidator"),
+      internalLinkActionValidator: /* @__PURE__ */ __name(() => internalLinkActionValidator, "internalLinkActionValidator"),
+      isStoredCredentialEnvelope: /* @__PURE__ */ __name(() => isStoredCredentialEnvelope2, "isStoredCredentialEnvelope"),
+      parseInAppMessagesFlag: /* @__PURE__ */ __name(() => parseInAppMessagesFlag, "parseInAppMessagesFlag"),
+      platformPredicateValidator: /* @__PURE__ */ __name(() => platformPredicateValidator, "platformPredicateValidator"),
+      rolePredicateValidator: /* @__PURE__ */ __name(() => rolePredicateValidator, "rolePredicateValidator"),
+      versionPredicateValidator: /* @__PURE__ */ __name(() => versionPredicateValidator, "versionPredicateValidator")
     });
     module.exports = __toCommonJS(index_exports);
     var external_exports = {};
@@ -15653,7 +15675,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       }).catchall(external_exports.any())
     );
     var CredentialSubjectValidator = external_exports.object({ id: external_exports.string().optional() }).catchall(external_exports.any());
-    var CredentialStatusValidator = external_exports.object({ type: external_exports.string(), id: external_exports.string() }).catchall(external_exports.any());
+    var CredentialStatusValidator = external_exports.object({ type: external_exports.string(), id: external_exports.string().optional() }).catchall(external_exports.any());
     var CredentialSchemaValidator = external_exports.object({ id: external_exports.string(), type: external_exports.string() }).catchall(external_exports.any());
     var RefreshServiceValidator = external_exports.object({ id: external_exports.string().optional(), type: external_exports.string() }).catchall(external_exports.any());
     var TermsOfUseValidator = external_exports.object({ type: external_exports.string(), id: external_exports.string().optional() }).catchall(external_exports.any());
@@ -16054,8 +16076,17 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       statusListIndex: external_exports.string().optional()
     });
     var VerificationCheckValidator = external_exports.object({
+      /**
+       * Checks that completed successfully. This does not imply that warnings can be ignored.
+       */
       checks: external_exports.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: external_exports.string().array(),
+      /** Verification failures that prevented one or more requested checks from succeeding. */
       errors: external_exports.string().array(),
       /**
        * Per-entry results for the `credentialStatus` check, populated
@@ -16184,6 +16215,9 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       role: external_exports.string().default("").optional().describe('Role of the profile: e.g. "teacher", "student".'),
       dob: external_exports.string().default("").optional().describe('Date of birth of the profile: e.g. "1990-01-01".'),
       country: external_exports.string().optional().describe("Country for the profile."),
+      locale: external_exports.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: external_exports.boolean().optional().describe("Approval status for the profile.")
     });
     var LCNPublicProfileValidator = LCNProfileValidator.pick({
@@ -16729,7 +16763,10 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       "GUARDIAN_APPROVAL_PENDING",
       "GUARDIAN_APPROVED",
       "GUARDIAN_REJECTED",
-      "APP_NOTIFICATION"
+      "APP_NOTIFICATION",
+      "CREDENTIAL_REVOKED",
+      "CREDENTIAL_SUSPENDED",
+      "CREDENTIAL_UNSUSPENDED"
     ]);
     var LCNNotificationMessageValidator = external_exports.object({
       title: external_exports.string().optional(),
@@ -17510,7 +17547,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       id: external_exports.string().optional(),
       type: external_exports.literal("BitstringStatusListEntry"),
       statusPurpose: BitstringStatusPurposeValidator,
-      statusListIndex: external_exports.string(),
+      statusListIndex: external_exports.string().or(external_exports.number().int().nonnegative()),
       statusListCredential: external_exports.string()
     });
     var AllocatedBitstringStatusListEntryValidator = BitstringStatusListEntryValidator.extend({
@@ -17526,6 +17563,97 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       statusPurposes: external_exports.array(BitstringStatusPurposeValidator).optional(),
       listSize: external_exports.number().int().positive().optional()
     }).default({});
+    var inAppMessagePlatformValidator = external_exports.enum(["ios", "android", "web"]);
+    var inAppMessageVersionSourceValidator = external_exports.enum(["native", "web", "capgo"]);
+    var inAppMessageVersionOpValidator = external_exports.enum(["lt", "lte", "eq", "gte", "gt"]);
+    var platformPredicateValidator = external_exports.object({ platform: external_exports.array(inAppMessagePlatformValidator).nonempty() }).strict();
+    var rolePredicateValidator = external_exports.object({ role: external_exports.array(external_exports.string()).nonempty() }).strict();
+    var versionPredicateValidator = external_exports.object({
+      version: external_exports.object({
+        source: inAppMessageVersionSourceValidator,
+        op: inAppMessageVersionOpValidator,
+        value: external_exports.string()
+      }).strict()
+    }).strict();
+    var inAppMessagePredicateValidator = external_exports.lazy(
+      () => external_exports.union([
+        platformPredicateValidator,
+        rolePredicateValidator,
+        versionPredicateValidator,
+        external_exports.object({ all: external_exports.array(inAppMessagePredicateValidator) }).strict(),
+        external_exports.object({ any: external_exports.array(inAppMessagePredicateValidator) }).strict(),
+        external_exports.object({ not: inAppMessagePredicateValidator }).strict()
+      ])
+    );
+    var inAppMessageActionStyleValidator = external_exports.enum(["primary", "secondary", "positive", "dismiss"]).default("secondary");
+    var internalLinkActionValidator = external_exports.object({ type: external_exports.literal("internalLink"), path: external_exports.string() }).passthrough();
+    var externalLinkActionValidator = external_exports.object({ type: external_exports.literal("externalLink"), url: external_exports.string() }).passthrough();
+    var appStoreActionValidator = external_exports.object({
+      type: external_exports.literal("appStore"),
+      iosUrl: external_exports.string().optional(),
+      androidUrl: external_exports.string().optional(),
+      webUrl: external_exports.string().optional()
+    }).passthrough();
+    var capgoUpdateActionValidator = external_exports.object({ type: external_exports.literal("capgoUpdate") }).passthrough();
+    var dismissActionValidator = external_exports.object({ type: external_exports.literal("dismiss") }).passthrough();
+    var inAppMessageActionTargetValidator = external_exports.union([
+      internalLinkActionValidator,
+      externalLinkActionValidator,
+      appStoreActionValidator,
+      capgoUpdateActionValidator,
+      dismissActionValidator
+    ]);
+    var inAppMessageActionValidator = external_exports.object({
+      label: external_exports.string(),
+      style: inAppMessageActionStyleValidator,
+      action: inAppMessageActionTargetValidator,
+      /** When true, the message closes after this action runs (default true). */
+      closeOnComplete: external_exports.boolean().default(true)
+    }).passthrough();
+    var inAppMessageMediaValidator = external_exports.object({
+      type: external_exports.enum(["youtube", "image", "gif"]),
+      url: external_exports.string(),
+      /** Aspect ratio hint, e.g. "16:9" or "1:1". Defaults to 16:9. */
+      aspect: external_exports.string().default("16:9"),
+      /** Alt text for images/gifs (accessibility). */
+      alt: external_exports.string().optional()
+    }).passthrough();
+    var inAppMessageFrequencyValidator = external_exports.union([
+      external_exports.literal("once"),
+      external_exports.literal("session"),
+      external_exports.literal("always"),
+      external_exports.object({ everyDays: external_exports.number().positive() }).strict()
+    ]).default("once");
+    var inAppMessagePresentationValidator = external_exports.enum(["modal", "banner", "toast"]).default("modal");
+    var inAppMessageValidator = external_exports.object({
+      /** Stable identifier — used to persist dismissal / frequency state. */
+      id: external_exports.string(),
+      /** Higher priority wins when multiple messages match. Default 0. */
+      priority: external_exports.number().default(0),
+      /** When false, the message is required/blocking (no dismiss affordance). */
+      dismissible: external_exports.boolean().default(true),
+      frequency: inAppMessageFrequencyValidator,
+      presentation: inAppMessagePresentationValidator,
+      media: inAppMessageMediaValidator.optional(),
+      /** Optional emoji hero glyph — rendered only when `media` is not set. */
+      emoji: external_exports.string().optional(),
+      title: external_exports.string(),
+      body: external_exports.string().optional(),
+      actions: external_exports.array(inAppMessageActionValidator).default([]),
+      /** Targeting predicate tree. Omitted → matches everyone. */
+      targeting: inAppMessagePredicateValidator.optional(),
+      /** Allow disabling a message without removing it from the flag. */
+      enabled: external_exports.boolean().default(true)
+    }).passthrough();
+    var inAppMessagesFlagValidator = external_exports.object({
+      version: external_exports.number().default(1),
+      messages: external_exports.array(inAppMessageValidator).default([])
+    }).passthrough();
+    var EMPTY_IN_APP_MESSAGES_FLAG = { version: 1, messages: [] };
+    var parseInAppMessagesFlag = /* @__PURE__ */ __name2((raw) => {
+      const result = inAppMessagesFlagValidator.safeParse(raw);
+      return result.success ? result.data : EMPTY_IN_APP_MESSAGES_FLAG;
+    }, "parseInAppMessagesFlag");
   }
 });
 
@@ -17927,7 +18055,8 @@ var getCredentialStatusArray = /* @__PURE__ */ __name((credential) => {
 var isBitstringStatusListEntry = /* @__PURE__ */ __name((status) => {
   if (!status || typeof status !== "object") return false;
   const record = status;
-  return record.type === "BitstringStatusListEntry" && (record.statusPurpose === "revocation" || record.statusPurpose === "suspension") && typeof record.statusListIndex === "string" && typeof record.statusListCredential === "string";
+  const statusListIndex = record.statusListIndex;
+  return record.type === "BitstringStatusListEntry" && (record.statusPurpose === "revocation" || record.statusPurpose === "suspension") && (typeof statusListIndex === "string" || typeof statusListIndex === "number" && Number.isInteger(statusListIndex) && statusListIndex >= 0) && typeof record.statusListCredential === "string";
 }, "isBitstringStatusListEntry");
 var getBitstringStatusListEntries = /* @__PURE__ */ __name((credential) => {
   if (!credential || typeof credential !== "object" || Array.isArray(credential)) return [];
@@ -18353,6 +18482,16 @@ var inferW3cVersionFromContext = /* @__PURE__ */ __name((vc) => {
   return isV2 ? "w3c-vc-2.0" : "w3c-vc-1.1";
 }, "inferW3cVersionFromContext");
 
+// src/did.ts
+var getDidWeb = /* @__PURE__ */ __name((domain, profileId) => {
+  let decodedDomain = domain;
+  try {
+    decodedDomain = decodeURIComponent(domain);
+  } catch {
+  }
+  return `did:web:${encodeURIComponent(decodedDomain)}:users:${profileId}`;
+}, "getDidWeb");
+
 // src/index.ts
 var isHex = /* @__PURE__ */ __name((str) => /^[0-9a-f]+$/i.test(str), "isHex");
 var isEncrypted = /* @__PURE__ */ __name((item) => {
@@ -18433,6 +18572,7 @@ export {
   getBitstringStatusListEntries,
   getBitstringStatusListEntryForPurpose,
   getCredentialStatusArray,
+  getDidWeb,
   getProvider,
   getUrlsFromSrcSet,
   immerArraySlice,