@fedify/vocab-tools 2.4.0-pr.934.40 → 2.4.0

package/src/type.ts

@@ -6,8 +6,10 @@ const HEURISTICS_CONTEXTS: string[] = [
   "https://www.w3.org/ns/activitystreams",
   "https://w3id.org/security/v1",
   "https://w3id.org/security/data-integrity/v1",
+  "https://w3id.org/security/data-integrity/v2",
   "https://www.w3.org/ns/did/v1",
   "https://w3id.org/security/multikey/v1",
+  "https://w3id.org/fep/ef61",
 ];
 
 interface ScalarType {
@@ -17,6 +19,12 @@ interface ScalarType {
   compactEncoder?: (variable: string) => string;
   dataCheck(variable: string): string;
   decoder(variable: string, baseUrlVar: string): string;
+  /**
+   * Whether a value that fails `dataCheck()` should be skipped instead of
+   * being handed to `decoder()`.  Set this for types decoded from untrusted
+   * remote input, where one malformed value must not fail the whole object.
+   */
+  skipUnparsable?: boolean;
 }
 
 const scalarTypes: Record<string, ScalarType> = {
@@ -185,7 +193,8 @@ const scalarTypes: Record<string, ScalarType> = {
     dataCheck(v) {
       return `typeof ${v} === "object" && "@language" in ${v} && "@value" in ${v}
         && typeof ${v}["@language"] === "string"
-        && typeof ${v}["@value"] === "string"`;
+        && typeof ${v}["@value"] === "string"
+        && isValidLanguageTag(${v}["@language"])`;
     },
     decoder(v) {
       return `new LanguageString(${v}["@value"], ${v}["@language"])`;
@@ -316,12 +325,35 @@ const scalarTypes: Record<string, ScalarType> = {
       return `formatIri(${v})`;
     },
     dataCheck(v) {
-      return `typeof ${v} === "object" && "@value" in ${v}
-        && typeof ${v}["@value"] === "string"
-        && ${v}["@value"] !== "" && ${v}["@value"] !== "/"`;
+      return `typeof ${v} === "object" &&
+      ((typeof ${v}["@id"] === "string" && canDecodeIri(${v}["@id"])) ||
+       (typeof ${v}["@value"] === "string" && canDecodeIri(${v}["@value"])))`;
+    },
+    decoder(v) {
+      return `decodeIri(typeof ${v}["@id"] === "string" ? ${v}["@id"] : ${v}["@value"])`;
+    },
+    skipUnparsable: true,
+  },
+  "fedify:gatewayUrl": {
+    name: "URL",
+    typeGuard(v) {
+      return `${v} instanceof URL && isGatewayUrl(${v})`;
+    },
+    encoder(v) {
+      return `{ "@id": ${v}.origin }`;
+    },
+    compactEncoder(v) {
+      return `${v}.origin`;
+    },
+    dataCheck(v) {
+      return `${v} != null && typeof ${v} === "object" &&
+        (("@id" in ${v} && typeof ${v}["@id"] === "string" &&
+          ${v}["@id"] !== "" && ${v}["@id"] !== "/") ||
+        ("@value" in ${v} && typeof ${v}["@value"] === "string" &&
+          ${v}["@value"] !== "" && ${v}["@value"] !== "/"))`;
     },
     decoder(v) {
-      return `parseIri(${v}["@value"])`;
+      return `parseGatewayUrl(typeof ${v}["@id"] === "string" ? ${v}["@id"] : ${v}["@value"])`;
     },
   },
   "fedify:publicKey": {
@@ -633,6 +665,10 @@ export function getDecoder(
   throw new Error(`Unknown type: ${typeUri}`);
 }
 
+export function skipsUnparsable(typeUri: string): boolean {
+  return scalarTypes[typeUri]?.skipUnparsable ?? false;
+}
+
 export function getDataCheck(
   typeUri: string,
   types: Record<string, TypeSchema>,