@learncard/helpers 1.6.2 → 1.7.0

package/dist/helpers.esm.js

@@ -203,6 +203,7 @@ var require_types_cjs_development = __commonJS({
       FlatAuthGrantValidator: /* @__PURE__ */ __name(() => FlatAuthGrantValidator, "FlatAuthGrantValidator"),
       FrameworkWithSkillsValidator: /* @__PURE__ */ __name(() => FrameworkWithSkillsValidator, "FrameworkWithSkillsValidator"),
       FullClaimHookValidator: /* @__PURE__ */ __name(() => FullClaimHookValidator, "FullClaimHookValidator"),
+      GenerateSkillIconsInputValidator: /* @__PURE__ */ __name(() => GenerateSkillIconsInputValidator, "GenerateSkillIconsInputValidator"),
       GeoCoordinatesValidator: /* @__PURE__ */ __name(() => GeoCoordinatesValidator, "GeoCoordinatesValidator"),
       GetCounterEventValidator: /* @__PURE__ */ __name(() => GetCounterEventValidator, "GetCounterEventValidator"),
       GetCountersEventValidator: /* @__PURE__ */ __name(() => GetCountersEventValidator, "GetCountersEventValidator"),
@@ -363,6 +364,8 @@ var require_types_cjs_development = __commonJS({
       SHARE_RECOVERY_PROTOCOL: /* @__PURE__ */ __name(() => SHARE_RECOVERY_PROTOCOL, "SHARE_RECOVERY_PROTOCOL"),
       SHARE_TAG_BYTES: /* @__PURE__ */ __name(() => SHARE_TAG_BYTES, "SHARE_TAG_BYTES"),
       SHARE_VIEW_RECEIPT_TTL_SECONDS: /* @__PURE__ */ __name(() => SHARE_VIEW_RECEIPT_TTL_SECONDS, "SHARE_VIEW_RECEIPT_TTL_SECONDS"),
+      SKILL_ICON_MAX_CHARACTERS_PER_REQUEST: /* @__PURE__ */ __name(() => SKILL_ICON_MAX_CHARACTERS_PER_REQUEST, "SKILL_ICON_MAX_CHARACTERS_PER_REQUEST"),
+      SKILL_ICON_MAX_NAMES_PER_REQUEST: /* @__PURE__ */ __name(() => SKILL_ICON_MAX_NAMES_PER_REQUEST, "SKILL_ICON_MAX_NAMES_PER_REQUEST"),
       SendAiSessionCredentialEventValidator: /* @__PURE__ */ __name(() => SendAiSessionCredentialEventValidator, "SendAiSessionCredentialEventValidator"),
       SendBoostInputValidator: /* @__PURE__ */ __name(() => SendBoostInputValidator, "SendBoostInputValidator"),
       SendBoostResponseValidator: /* @__PURE__ */ __name(() => SendBoostResponseValidator, "SendBoostResponseValidator"),
@@ -415,6 +418,7 @@ var require_types_cjs_development = __commonJS({
       SkillFrameworkQueryValidator: /* @__PURE__ */ __name(() => SkillFrameworkQueryValidator, "SkillFrameworkQueryValidator"),
       SkillFrameworkStatusEnum: /* @__PURE__ */ __name(() => SkillFrameworkStatusEnum, "SkillFrameworkStatusEnum"),
       SkillFrameworkValidator: /* @__PURE__ */ __name(() => SkillFrameworkValidator, "SkillFrameworkValidator"),
+      SkillIconNamesValidator: /* @__PURE__ */ __name(() => SkillIconNamesValidator, "SkillIconNamesValidator"),
       SkillQueryValidator: /* @__PURE__ */ __name(() => SkillQueryValidator, "SkillQueryValidator"),
       SkillSemanticSearchInputValidator: /* @__PURE__ */ __name(() => SkillSemanticSearchInputValidator, "SkillSemanticSearchInputValidator"),
       SkillSemanticSearchResultItemValidator: /* @__PURE__ */ __name(() => SkillSemanticSearchResultItemValidator, "SkillSemanticSearchResultItemValidator"),
@@ -662,7 +666,7 @@ var require_types_cjs_development = __commonJS({
       nullable: /* @__PURE__ */ __name(() => nullable, "nullable"),
       nullish: /* @__PURE__ */ __name(() => nullish2, "nullish"),
       number: /* @__PURE__ */ __name(() => number2, "number"),
-      object: /* @__PURE__ */ __name(() => object, "object"),
+      object: /* @__PURE__ */ __name(() => object2, "object"),
       optional: /* @__PURE__ */ __name(() => optional, "optional"),
       overwrite: /* @__PURE__ */ __name(() => _overwrite, "overwrite"),
       parse: /* @__PURE__ */ __name(() => parse2, "parse"),
@@ -1248,9 +1252,9 @@ var require_types_cjs_development = __commonJS({
     __name(floatSafeRemainder, "floatSafeRemainder");
     __name2(floatSafeRemainder, "floatSafeRemainder");
     var EVALUATING = /* @__PURE__ */ Symbol("evaluating");
-    function defineLazy(object2, key, getter) {
+    function defineLazy(object22, key, getter) {
       let value = void 0;
-      Object.defineProperty(object2, key, {
+      Object.defineProperty(object22, key, {
         get() {
           if (value === EVALUATING) {
             return void 0;
@@ -1262,7 +1266,7 @@ var require_types_cjs_development = __commonJS({
           return value;
         },
         set(v) {
-          Object.defineProperty(object2, key, {
+          Object.defineProperty(object22, key, {
             value: v
             // configurable: true,
           });
@@ -13552,7 +13556,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       nullable: /* @__PURE__ */ __name(() => nullable, "nullable"),
       nullish: /* @__PURE__ */ __name(() => nullish2, "nullish"),
       number: /* @__PURE__ */ __name(() => number2, "number"),
-      object: /* @__PURE__ */ __name(() => object, "object"),
+      object: /* @__PURE__ */ __name(() => object2, "object"),
       optional: /* @__PURE__ */ __name(() => optional, "optional"),
       partialRecord: /* @__PURE__ */ __name(() => partialRecord, "partialRecord"),
       pipe: /* @__PURE__ */ __name(() => pipe, "pipe"),
@@ -14525,7 +14529,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
         }
       });
     });
-    function object(shape, params) {
+    function object2(shape, params) {
       const def = {
         type: "object",
         shape: shape ?? {},
@@ -14533,8 +14537,8 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       };
       return new ZodObject(def);
     }
-    __name(object, "object");
-    __name2(object, "object");
+    __name(object2, "object");
+    __name2(object2, "object");
     function strictObject(shape, params) {
       return new ZodObject({
         type: "object",
@@ -15884,7 +15888,18 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       verificationMethod: external_exports.string(),
       jws: external_exports.string().optional()
     }).catchall(external_exports.any()).superRefine((proof, ctx) => {
-      if (proof.created === void 0 && (proof.type !== "DataIntegrityProof" || proof.cryptosuite !== "ecdsa-rdfc-2019")) {
+      if (proof.created === void 0 && // These standardized Data Integrity suites make created optional.
+      // Keep the prior requirement for legacy and unknown proof suites.
+      // https://www.w3.org/TR/vc-di-eddsa/#proof-configuration-eddsa-jcs-2022
+      // https://www.w3.org/TR/vc-di-bbs/#proof-configuration
+      (proof.type !== "DataIntegrityProof" || ![
+        "ecdsa-rdfc-2019",
+        "ecdsa-jcs-2019",
+        "ecdsa-sd-2023",
+        "eddsa-rdfc-2022",
+        "eddsa-jcs-2022",
+        "bbs-2023"
+      ].includes(proof.cryptosuite))) {
         ctx.addIssue({
           code: "custom",
           path: ["created"],
@@ -16141,6 +16156,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       term: external_exports.string().optional()
     }).catchall(external_exports.any());
     var UnsignedAchievementCredentialValidator = UnsignedVCValidator.extend({
+      awardedDate: external_exports.string().optional(),
       name: external_exports.string().optional(),
       description: external_exports.string().optional(),
       image: ImageValidator.optional(),
@@ -18997,6 +19013,17 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
       contentUrl: external_exports.string(),
       receipt: external_exports.string().min(22).max(128).regex(/^[A-Za-z0-9_-]+$/)
     }).strict();
+    var SKILL_ICON_MAX_NAMES_PER_REQUEST = 100;
+    var SKILL_ICON_MAX_CHARACTERS_PER_REQUEST = 2500;
+    var SkillIconNamesValidator = external_exports.array(external_exports.string().nonempty()).min(1).max(SKILL_ICON_MAX_NAMES_PER_REQUEST, {
+      message: `A maximum of ${SKILL_ICON_MAX_NAMES_PER_REQUEST} skill names can be sent per request`
+    }).refine(
+      (names) => names.reduce((total, name) => total + name.length, 0) <= SKILL_ICON_MAX_CHARACTERS_PER_REQUEST,
+      {
+        message: `Skill names may total at most ${SKILL_ICON_MAX_CHARACTERS_PER_REQUEST} characters per request`
+      }
+    );
+    var GenerateSkillIconsInputValidator = external_exports.object({ names: SkillIconNamesValidator });
   }
 });
 
@@ -20189,21 +20216,94 @@ var canonicalizeShareContentRequestBody = /* @__PURE__ */ __name((body, options
   return serialized;
 }, "canonicalizeShareContentRequestBody");
 
+// src/credential-materialization.ts
+var CredentialFieldError = class extends Error {
+  constructor(field) {
+    super(`Invalid standard credential field: ${field}`);
+    this.field = field;
+    this.name = "CredentialFieldError";
+  }
+  static {
+    __name(this, "CredentialFieldError");
+  }
+};
+var parseCredentialNumber = /* @__PURE__ */ __name((value) => {
+  if (typeof value === "number" && Number.isFinite(value)) return value;
+  if (typeof value !== "string" || !/^[+-]?(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?$/i.test(value.trim()))
+    throw new Error("Expected a finite decimal");
+  const number = Number(value.trim());
+  if (!Number.isFinite(number)) throw new Error("Expected a finite decimal");
+  return number;
+}, "parseCredentialNumber");
+var normalizeCredentialAwardDate = /* @__PURE__ */ __name((value) => {
+  const text = value.trim();
+  const calendar = /^(\d{4})-(\d{2})-(\d{2})/.exec(text);
+  if (!calendar || !/^\d{4}-\d{2}-\d{2}(?:T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|[+-]\d{2}:\d{2}))?$/i.test(
+    text
+  ))
+    throw new CredentialFieldError("awardedDate");
+  const day = /* @__PURE__ */ new Date(`${calendar[0]}T00:00:00Z`);
+  if (!Number.isFinite(day.getTime()) || day.getUTCFullYear() !== Number(calendar[1]) || day.getUTCMonth() + 1 !== Number(calendar[2]) || day.getUTCDate() !== Number(calendar[3]))
+    throw new CredentialFieldError("awardedDate");
+  const instant = text.length === 10 ? day : new Date(text);
+  if (!Number.isFinite(instant.getTime())) throw new CredentialFieldError("awardedDate");
+  const fraction = /\.(\d+)(?:Z|[+-]\d{2}:\d{2})$/i.exec(text)?.[1];
+  const iso = instant.toISOString();
+  return fraction && fraction.length > 3 ? iso.replace(/\.\d{3}Z$/, `.${fraction}Z`) : iso;
+}, "normalizeCredentialAwardDate");
+var object = /* @__PURE__ */ __name((value) => Boolean(value && typeof value === "object" && !Array.isArray(value)), "object");
+var materializeCredentialFields = /* @__PURE__ */ __name((credential) => {
+  if (credential.proof) return credential;
+  const types = Array.isArray(credential.type) ? credential.type : [credential.type];
+  if (!types.some(
+    (type) => ["OpenBadgeCredential", "AchievementCredential", "ClrCredential"].includes(String(type))
+  ))
+    return credential;
+  const result = structuredClone(credential);
+  const numeric = /* @__PURE__ */ __name((container, field) => {
+    if (container[field] === void 0) return;
+    if (typeof container[field] === "string" && !container[field].trim()) {
+      delete container[field];
+      return;
+    }
+    try {
+      container[field] = parseCredentialNumber(container[field]);
+    } catch {
+      throw new CredentialFieldError(field);
+    }
+  }, "numeric");
+  const subject = /* @__PURE__ */ __name((value) => {
+    if (!object(value)) return;
+    numeric(value, "creditsEarned");
+    for (const achievement of Array.isArray(value.achievement) ? value.achievement : [value.achievement]) {
+      if (object(achievement)) numeric(achievement, "creditsAvailable");
+    }
+  }, "subject");
+  for (const value of Array.isArray(result.credentialSubject) ? result.credentialSubject : [result.credentialSubject])
+    subject(value);
+  if (result.awardedDate !== void 0) {
+    if (typeof result.awardedDate !== "string") throw new CredentialFieldError("awardedDate");
+    if (!result.awardedDate.trim()) delete result.awardedDate;
+    else result.awardedDate = normalizeCredentialAwardDate(result.awardedDate);
+  }
+  return result;
+}, "materializeCredentialFields");
+
 // src/index.ts
 var isHex = /* @__PURE__ */ __name((str) => /^[0-9a-f]+$/i.test(str), "isHex");
 var isEncrypted = /* @__PURE__ */ __name((item) => {
   return import_types3.JWEValidator.safeParse(item).success;
 }, "isEncrypted");
 var RegExpTransformer = {
-  serialize(object) {
-    return JSON.stringify(object, (_key, value) => {
+  serialize(object2) {
+    return JSON.stringify(object2, (_key, value) => {
       if (value instanceof RegExp) return value.toString();
       return value;
     });
   },
-  deserialize(object) {
-    if (typeof object !== "string") return object;
-    return JSON.parse(object, (_key, value) => {
+  deserialize(object2) {
+    if (typeof object2 !== "string") return object2;
+    return JSON.parse(object2, (_key, value) => {
       if (typeof value === "string") {
         const match = value.match(/^\/(.*)\/([gimsuy]*)$/);
         if (match) {
@@ -20238,6 +20338,7 @@ var isAppDidWeb = /* @__PURE__ */ __name((did) => {
 }, "isAppDidWeb");
 export {
   AGE_RATING_TO_MIN_AGE,
+  CredentialFieldError,
   DEFAULT_MAX_CANONICAL_BYTES,
   DEFAULT_MAX_CANONICAL_DEPTH,
   DEFAULT_RESOLUTIONS,
@@ -20300,10 +20401,13 @@ export {
   isNotMaybe,
   isNotUndefined,
   isVC2Format,
+  materializeCredentialFields,
+  normalizeCredentialAwardDate,
   optionalEnvironmentBoolean,
   optionalEnvironmentPort,
   optionalEnvironmentString,
   optionalEnvironmentUrl,
+  parseCredentialNumber,
   parseEnvironment,
   prepareManagedRefreshContext,
   projectEnvelopeToDisplayVc,