@learncard/helpers 1.2.17 → 1.3.1

package/dist/helpers.d.ts

@@ -181,6 +181,32 @@ declare const UnsignedVCValidator: z.ZodObject<{
 			audience: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>>
 	]>>;
+	renderMethod: z.ZodOptional<z.ZodUnion<readonly [
+		z.ZodUnion<readonly [
+			z.ZodObject<{
+				type: z.ZodLiteral<"TemplateRenderMethod">;
+				renderSuite: z.ZodString;
+				template: z.ZodString;
+				renderProperty: z.ZodOptional<z.ZodArray<z.ZodString>>;
+				outputPreference: z.ZodOptional<z.ZodObject<{
+					mediaType: z.ZodString;
+				}, z.core.$strip>>;
+			}, z.core.$strip>,
+			z.ZodRecord<z.ZodString, z.ZodAny>
+		]>,
+		z.ZodArray<z.ZodUnion<readonly [
+			z.ZodObject<{
+				type: z.ZodLiteral<"TemplateRenderMethod">;
+				renderSuite: z.ZodString;
+				template: z.ZodString;
+				renderProperty: z.ZodOptional<z.ZodArray<z.ZodString>>;
+				outputPreference: z.ZodOptional<z.ZodObject<{
+					mediaType: z.ZodString;
+				}, z.core.$strip>>;
+			}, z.core.$strip>,
+			z.ZodRecord<z.ZodString, z.ZodAny>
+		]>>
+	]>>;
 }, z.core.$catchall<z.ZodAny>>;
 export type UnsignedVC = z.infer<typeof UnsignedVCValidator>;
 declare const VCValidator: z.ZodObject<{
@@ -359,6 +385,32 @@ declare const VCValidator: z.ZodObject<{
 			audience: z.ZodOptional<z.ZodString>;
 		}, z.core.$catchall<z.ZodAny>>>
 	]>>;
+	renderMethod: z.ZodOptional<z.ZodUnion<readonly [
+		z.ZodUnion<readonly [
+			z.ZodObject<{
+				type: z.ZodLiteral<"TemplateRenderMethod">;
+				renderSuite: z.ZodString;
+				template: z.ZodString;
+				renderProperty: z.ZodOptional<z.ZodArray<z.ZodString>>;
+				outputPreference: z.ZodOptional<z.ZodObject<{
+					mediaType: z.ZodString;
+				}, z.core.$strip>>;
+			}, z.core.$strip>,
+			z.ZodRecord<z.ZodString, z.ZodAny>
+		]>,
+		z.ZodArray<z.ZodUnion<readonly [
+			z.ZodObject<{
+				type: z.ZodLiteral<"TemplateRenderMethod">;
+				renderSuite: z.ZodString;
+				template: z.ZodString;
+				renderProperty: z.ZodOptional<z.ZodArray<z.ZodString>>;
+				outputPreference: z.ZodOptional<z.ZodObject<{
+					mediaType: z.ZodString;
+				}, z.core.$strip>>;
+			}, z.core.$strip>,
+			z.ZodRecord<z.ZodString, z.ZodAny>
+		]>>
+	]>>;
 	proof: z.ZodUnion<[
 		z.ZodObject<{
 			type: z.ZodString;
@@ -410,6 +462,22 @@ declare const JWEValidator: z.ZodObject<{
 	}, z.core.$strip>>>;
 }, z.core.$strip>;
 export type JWE = z.infer<typeof JWEValidator>;
+declare const BitstringStatusPurposeValidator: z.ZodEnum<{
+	revocation: "revocation";
+	suspension: "suspension";
+}>;
+export type BitstringStatusPurpose = z.infer<typeof BitstringStatusPurposeValidator>;
+declare const BitstringStatusListEntryValidator: z.ZodObject<{
+	id: z.ZodOptional<z.ZodString>;
+	type: z.ZodLiteral<"BitstringStatusListEntry">;
+	statusPurpose: z.ZodEnum<{
+		revocation: "revocation";
+		suspension: "suspension";
+	}>;
+	statusListIndex: z.ZodString;
+	statusListCredential: z.ZodString;
+}, z.core.$strip>;
+export type BitstringStatusListEntry = z.infer<typeof BitstringStatusListEntryValidator>;
 declare const Providers: {
 	filestack: typeof filestack;
 	unsplash: typeof unsplash;
@@ -574,6 +642,12 @@ export type ImmerArraySlice = {
 	<State>(setState: Updater<State[]>, index: number, value: State): void;
 };
 export declare const immerArraySlice: ImmerArraySlice;
+export declare const getCredentialStatusArray: (credential: unknown) => Record<string, unknown>[];
+export declare const isBitstringStatusListEntry: (status: unknown) => status is BitstringStatusListEntry;
+export declare const getBitstringStatusListEntries: (credential: unknown) => BitstringStatusListEntry[];
+export declare const getBitstringStatusListEntryForPurpose: (credential: unknown, statusPurpose: BitstringStatusPurpose) => BitstringStatusListEntry | undefined;
+export declare const getBitstringStatusListBit: (bitstring: Uint8Array, index: number) => boolean;
+export declare const setBitstringStatusListBit: (bitstring: Uint8Array, index: number, value: boolean) => void;
 export declare const ImageResizingValidator: z.ZodObject<{
 	type: z.ZodLiteral<"resizing">;
 }, z.core.$strip>;

package/dist/helpers.esm.js

@@ -64,6 +64,8 @@ var require_types_cjs_development = __commonJS({
       AgeRatingValidator: /* @__PURE__ */ __name(() => AgeRatingValidator, "AgeRatingValidator"),
       AlignmentTargetTypeValidator: /* @__PURE__ */ __name(() => AlignmentTargetTypeValidator, "AlignmentTargetTypeValidator"),
       AlignmentValidator: /* @__PURE__ */ __name(() => AlignmentValidator, "AlignmentValidator"),
+      AllocateCredentialStatusInputValidator: /* @__PURE__ */ __name(() => AllocateCredentialStatusInputValidator, "AllocateCredentialStatusInputValidator"),
+      AllocatedBitstringStatusListEntryValidator: /* @__PURE__ */ __name(() => AllocatedBitstringStatusListEntryValidator, "AllocatedBitstringStatusListEntryValidator"),
       AllowConnectionRequestsEnum: /* @__PURE__ */ __name(() => AllowConnectionRequestsEnum, "AllowConnectionRequestsEnum"),
       AppBoostValidator: /* @__PURE__ */ __name(() => AppBoostValidator, "AppBoostValidator"),
       AppEventInputValidator: /* @__PURE__ */ __name(() => AppEventInputValidator, "AppEventInputValidator"),
@@ -81,6 +83,10 @@ var require_types_cjs_development = __commonJS({
       AuthGrantValidator: /* @__PURE__ */ __name(() => AuthGrantValidator, "AuthGrantValidator"),
       AuthSessionError: /* @__PURE__ */ __name(() => AuthSessionError, "AuthSessionError"),
       AutoBoostConfigValidator: /* @__PURE__ */ __name(() => AutoBoostConfigValidator, "AutoBoostConfigValidator"),
+      BITSTRING_STATUS_PURPOSES: /* @__PURE__ */ __name(() => BITSTRING_STATUS_PURPOSES, "BITSTRING_STATUS_PURPOSES"),
+      BitstringStatusListCredentialSubjectValidator: /* @__PURE__ */ __name(() => BitstringStatusListCredentialSubjectValidator, "BitstringStatusListCredentialSubjectValidator"),
+      BitstringStatusListEntryValidator: /* @__PURE__ */ __name(() => BitstringStatusListEntryValidator, "BitstringStatusListEntryValidator"),
+      BitstringStatusPurposeValidator: /* @__PURE__ */ __name(() => BitstringStatusPurposeValidator, "BitstringStatusPurposeValidator"),
       BoostPermissionsQueryValidator: /* @__PURE__ */ __name(() => BoostPermissionsQueryValidator, "BoostPermissionsQueryValidator"),
       BoostPermissionsValidator: /* @__PURE__ */ __name(() => BoostPermissionsValidator, "BoostPermissionsValidator"),
       BoostQueryValidator: /* @__PURE__ */ __name(() => BoostQueryValidator, "BoostQueryValidator"),
@@ -142,6 +148,7 @@ var require_types_cjs_development = __commonJS({
       CredentialStatusValidator: /* @__PURE__ */ __name(() => CredentialStatusValidator, "CredentialStatusValidator"),
       CredentialSubjectValidator: /* @__PURE__ */ __name(() => CredentialSubjectValidator, "CredentialSubjectValidator"),
       CriteriaValidator: /* @__PURE__ */ __name(() => CriteriaValidator, "CriteriaValidator"),
+      DEFAULT_BITSTRING_STATUS_LIST_SIZE: /* @__PURE__ */ __name(() => DEFAULT_BITSTRING_STATUS_LIST_SIZE, "DEFAULT_BITSTRING_STATUS_LIST_SIZE"),
       DeleteFrameworkInputValidator: /* @__PURE__ */ __name(() => DeleteFrameworkInputValidator, "DeleteFrameworkInputValidator"),
       DeleteSkillInputValidator: /* @__PURE__ */ __name(() => DeleteSkillInputValidator, "DeleteSkillInputValidator"),
       DidDocumentValidator: /* @__PURE__ */ __name(() => DidDocumentValidator, "DidDocumentValidator"),
@@ -241,6 +248,7 @@ var require_types_cjs_development = __commonJS({
       RefreshServiceValidator: /* @__PURE__ */ __name(() => RefreshServiceValidator, "RefreshServiceValidator"),
       RegExpValidator: /* @__PURE__ */ __name(() => RegExpValidator, "RegExpValidator"),
       RelatedValidator: /* @__PURE__ */ __name(() => RelatedValidator, "RelatedValidator"),
+      RenderMethodValidator: /* @__PURE__ */ __name(() => RenderMethodValidator, "RenderMethodValidator"),
       ReplaceSkillFrameworkSkillsInputValidator: /* @__PURE__ */ __name(() => ReplaceSkillFrameworkSkillsInputValidator, "ReplaceSkillFrameworkSkillsInputValidator"),
       ReplaceSkillFrameworkSkillsResultValidator: /* @__PURE__ */ __name(() => ReplaceSkillFrameworkSkillsResultValidator, "ReplaceSkillFrameworkSkillsResultValidator"),
       RequestLearnerContextEventValidator: /* @__PURE__ */ __name(() => RequestLearnerContextEventValidator, "RequestLearnerContextEventValidator"),
@@ -277,11 +285,13 @@ var require_types_cjs_development = __commonJS({
       SkillTreeNodeInputValidator: /* @__PURE__ */ __name(() => SkillTreeNodeInputValidator, "SkillTreeNodeInputValidator"),
       SkillTreeNodeValidator: /* @__PURE__ */ __name(() => SkillTreeNodeValidator, "SkillTreeNodeValidator"),
       SkillValidator: /* @__PURE__ */ __name(() => SkillValidator, "SkillValidator"),
+      StatusCheckEntryValidator: /* @__PURE__ */ __name(() => StatusCheckEntryValidator, "StatusCheckEntryValidator"),
       StringQuery: /* @__PURE__ */ __name(() => StringQuery, "StringQuery"),
       SummaryCredentialDataValidator: /* @__PURE__ */ __name(() => SummaryCredentialDataValidator, "SummaryCredentialDataValidator"),
       SummaryCredentialKeywordValidator: /* @__PURE__ */ __name(() => SummaryCredentialKeywordValidator, "SummaryCredentialKeywordValidator"),
       SyncFrameworkInputValidator: /* @__PURE__ */ __name(() => SyncFrameworkInputValidator, "SyncFrameworkInputValidator"),
       TagValidator: /* @__PURE__ */ __name(() => TagValidator, "TagValidator"),
+      TemplateRenderMethodValidator: /* @__PURE__ */ __name(() => TemplateRenderMethodValidator, "TemplateRenderMethodValidator"),
       TermsOfUseValidator: /* @__PURE__ */ __name(() => TermsOfUseValidator, "TermsOfUseValidator"),
       UnsignedAchievementCredentialValidator: /* @__PURE__ */ __name(() => UnsignedAchievementCredentialValidator, "UnsignedAchievementCredentialValidator"),
       UnsignedClrCredentialValidator: /* @__PURE__ */ __name(() => UnsignedClrCredentialValidator, "UnsignedClrCredentialValidator"),
@@ -13761,6 +13771,19 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       genre: external_exports.string().optional(),
       audience: external_exports.string().optional()
     }).catchall(external_exports.any());
+    var TemplateRenderMethodValidator = external_exports.object({
+      type: external_exports.literal("TemplateRenderMethod"),
+      renderSuite: external_exports.string(),
+      template: external_exports.string(),
+      renderProperty: external_exports.array(external_exports.string()).optional(),
+      outputPreference: external_exports.object({
+        mediaType: external_exports.string()
+      }).optional()
+    });
+    var RenderMethodValidator = external_exports.union([
+      TemplateRenderMethodValidator,
+      external_exports.record(external_exports.string(), external_exports.any())
+    ]);
     var UnsignedVCValidator = external_exports.object({
       "@context": ContextValidator,
       id: external_exports.string().optional(),
@@ -13784,7 +13807,8 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       validUntil: external_exports.string().optional(),
       status: CredentialStatusValidator.or(CredentialStatusValidator.array()).optional(),
       termsOfUse: TermsOfUseValidator.or(TermsOfUseValidator.array()).optional(),
-      evidence: external_exports.union([VC2EvidenceValidator, external_exports.array(VC2EvidenceValidator)]).optional()
+      evidence: external_exports.union([VC2EvidenceValidator, external_exports.array(VC2EvidenceValidator)]).optional(),
+      renderMethod: external_exports.union([RenderMethodValidator, external_exports.array(RenderMethodValidator)]).optional()
     }).catchall(external_exports.any());
     var ProofValidator = external_exports.object({
       type: external_exports.string(),
@@ -14092,10 +14116,45 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
     var ClrCredentialValidator = UnsignedClrCredentialValidator.extend({
       proof: ProofValidator.or(ProofValidator.array())
     });
+    var StatusCheckEntryValidator = external_exports.object({
+      /**
+       * The `credentialStatus.type` as it appeared on the credential.
+       * One of `BitstringStatusListEntry`, `StatusList2021Entry`,
+       * `RevocationList2020Status`, or any future custom status type.
+       */
+      entryType: external_exports.string(),
+      /**
+       * The claimed purpose of the entry. Standard values are
+       * `"revocation"` and `"suspension"`; the spec allows arbitrary
+       * strings.
+       */
+      statusPurpose: external_exports.string(),
+      /**
+       * Whether the bit at the credential's index in the status list
+       * bitstring was set.
+       */
+      isSet: external_exports.boolean(),
+      /** URL of the status list credential, when known. */
+      statusListCredential: external_exports.string().optional(),
+      /** Original (string) index within the status list. */
+      statusListIndex: external_exports.string().optional()
+    });
     var VerificationCheckValidator = external_exports.object({
       checks: external_exports.string().array(),
       warnings: external_exports.string().array(),
-      errors: external_exports.string().array()
+      errors: external_exports.string().array(),
+      /**
+       * Per-entry results for the `credentialStatus` check, populated
+       * by `@learncard/didkit-plugin` when the verified credential
+       * carries one or more `credentialStatus` entries. Empty / absent
+       * for credentials without a status entry.
+       *
+       * Marked `.optional()` because the underlying `ssi-ldp`
+       * serializer omits the field when empty (`skip_serializing_if`),
+       * so older WASM builds that pre-date the structured-status
+       * change still validate against this schema.
+       */
+      status: StatusCheckEntryValidator.array().optional()
     });
     var VerificationStatusValidator = external_exports.enum(["Success", "Failed", "Error"]);
     var VerificationStatusEnum = VerificationStatusValidator.enum;
@@ -15503,6 +15562,29 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
         __name2(this, "AuthSessionError");
       }
     };
+    var BITSTRING_STATUS_PURPOSES = ["revocation", "suspension"];
+    var DEFAULT_BITSTRING_STATUS_LIST_SIZE = 131072;
+    var BitstringStatusPurposeValidator = external_exports.enum(BITSTRING_STATUS_PURPOSES);
+    var BitstringStatusListEntryValidator = external_exports.object({
+      id: external_exports.string().optional(),
+      type: external_exports.literal("BitstringStatusListEntry"),
+      statusPurpose: BitstringStatusPurposeValidator,
+      statusListIndex: external_exports.string(),
+      statusListCredential: external_exports.string()
+    });
+    var AllocatedBitstringStatusListEntryValidator = BitstringStatusListEntryValidator.extend({
+      id: external_exports.string()
+    });
+    var BitstringStatusListCredentialSubjectValidator = external_exports.object({
+      id: external_exports.string().optional(),
+      type: external_exports.literal("BitstringStatusList"),
+      statusPurpose: BitstringStatusPurposeValidator,
+      encodedList: external_exports.string()
+    });
+    var AllocateCredentialStatusInputValidator = external_exports.object({
+      statusPurposes: external_exports.array(BitstringStatusPurposeValidator).optional(),
+      listSize: external_exports.number().int().positive().optional()
+    }).default({});
   }
 });
 
@@ -16319,6 +16401,45 @@ var immerArraySlice = /* @__PURE__ */ __name(((setState, index, value) => {
   return updateSlice(index, value);
 }), "immerArraySlice");
 
+// src/bitstring-status-list/index.ts
+var getCredentialStatusArray = /* @__PURE__ */ __name((credential) => {
+  if (!credential || typeof credential !== "object" || Array.isArray(credential)) return [];
+  const status = credential.credentialStatus;
+  if (!status) return [];
+  return Array.isArray(status) ? status : [status];
+}, "getCredentialStatusArray");
+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";
+}, "isBitstringStatusListEntry");
+var getBitstringStatusListEntries = /* @__PURE__ */ __name((credential) => {
+  if (!credential || typeof credential !== "object" || Array.isArray(credential)) return [];
+  const record = credential;
+  const statuses = getCredentialStatusArray(record);
+  return [
+    ...statuses.filter(isBitstringStatusListEntry),
+    ...getBitstringStatusListEntries(record.boostCredential)
+  ];
+}, "getBitstringStatusListEntries");
+var getBitstringStatusListEntryForPurpose = /* @__PURE__ */ __name((credential, statusPurpose) => getBitstringStatusListEntries(credential).find((entry) => entry.statusPurpose === statusPurpose), "getBitstringStatusListEntryForPurpose");
+var getBitstringStatusListBit = /* @__PURE__ */ __name((bitstring, index) => {
+  if (!Number.isInteger(index) || index < 0) {
+    throw new Error("Bitstring status list index is out of range");
+  }
+  const byte = bitstring[Math.floor(index / 8)] ?? 0;
+  return (byte & 1 << index % 8) !== 0;
+}, "getBitstringStatusListBit");
+var setBitstringStatusListBit = /* @__PURE__ */ __name((bitstring, index, value) => {
+  if (!Number.isInteger(index) || index < 0 || index >= bitstring.length * 8) {
+    throw new Error("Bitstring status list index is out of range");
+  }
+  const byteIndex = Math.floor(index / 8);
+  const mask = 1 << index % 8;
+  const current = bitstring[byteIndex] ?? 0;
+  bitstring[byteIndex] = value ? current | mask : current & ~mask;
+}, "setBitstringStatusListBit");
+
 // src/Utilities.ts
 import { z } from "zod";
 var ImageResizingValidator = z.object({ type: z.literal("resizing") });
@@ -16487,6 +16608,10 @@ export {
   fixUrl4 as fixUrl,
   formatNumber,
   generateSrcSet4 as generateSrcSet,
+  getBitstringStatusListBit,
+  getBitstringStatusListEntries,
+  getBitstringStatusListEntryForPurpose,
+  getCredentialStatusArray,
   getProvider,
   getUrlsFromSrcSet,
   immerArraySlice,
@@ -16495,6 +16620,7 @@ export {
   innerReactOuterImmer,
   innerReactOuterReact,
   isAppDidWeb,
+  isBitstringStatusListEntry,
   isEncrypted,
   isHex,
   isNotMaybe,
@@ -16502,5 +16628,6 @@ export {
   isVC2Format,
   quantizeValue,
   resizeAndChangeQuality4 as resizeAndChangeQuality,
+  setBitstringStatusListBit,
   unwrapBoostCredential
 };