@fedify/fedify 1.2.0-dev.464 → 1.2.0-dev.466

package/esm/nodeinfo/client.js

@@ -1,18 +1,6 @@
 import { getLogger } from "@logtape/logtape";
 import { parse } from "../deps/jsr.io/@std/semver/1.0.3/mod.js";
 const logger = getLogger(["fedify", "nodeinfo", "client"]);
-/**
- * Fetches a NodeInfo document from the given URL.
- * @param url The base URL of the server.  If `options.direct` is turned off
- *            (default), the NodeInfo document will be fetched from
- *            the `.well-known` location of this URL (hence the only origin
- *            of the URL is used).  If `options.direct` is turned on,
- *            the NodeInfo document will be fetched from the given URL.
- * @param options Options for fetching the NodeInfo document.
- * @returns The NodeInfo document if it could be fetched successfully.
- *          Otherwise, `null` is returned.
- * @since 1.2.0
- */
 export async function getNodeInfo(url, options = {}) {
     try {
         let nodeInfoUrl = url;
@@ -25,7 +13,7 @@ export async function getNodeInfo(url, options = {}) {
                     status: wellKnownResponse.status,
                     statusText: wellKnownResponse.statusText,
                 });
-                return null;
+                return undefined;
             }
             const wellKnownRd = await wellKnownResponse.json();
             const link = wellKnownRd?.links?.find((link) => link != null &&
@@ -36,7 +24,7 @@ export async function getNodeInfo(url, options = {}) {
                 link.href != null);
             if (link == null) {
                 logger.error("Failed to find a NodeInfo document link from {url}: {resourceDescriptor}", { url: wellKnownUrl.href, resourceDescriptor: wellKnownRd });
-                return null;
+                return undefined;
             }
             nodeInfoUrl = link.href;
         }
@@ -47,17 +35,21 @@ export async function getNodeInfo(url, options = {}) {
                 status: response.status,
                 statusText: response.statusText,
             });
-            return null;
+            return undefined;
         }
         const data = await response.json();
-        return parseNodeInfo(data, options);
+        if (options.parse === "none")
+            return data;
+        return parseNodeInfo(data, {
+            tryBestEffort: options.parse === "best-effort",
+        }) ?? undefined;
     }
     catch (error) {
         logger.error("Failed to fetch NodeInfo document from {url}: {error}", {
             url: url.toString(),
             error,
         });
-        return null;
+        return undefined;
     }
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "1.2.0-dev.464+133bc111",
+  "version": "1.2.0-dev.466+c9309d76",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",

package/types/nodeinfo/client.d.ts

@@ -1,10 +1,10 @@
 /// <reference types="node" />
-import type { InboundService, NodeInfo, OutboundService, Protocol, Services, Software, Usage } from "./types.js";
+import type { InboundService, JsonValue, NodeInfo, OutboundService, Protocol, Services, Software, Usage } from "./types.js";
 /**
  * Options for {@link getNodeInfo} function.
  * @since 1.2.0
  */
-export interface GetNodeInfoOptions extends ParseNodeInfoOptions {
+export interface GetNodeInfoOptions {
     /**
      * Whether to directly fetch the NodeInfo document from the given URL.
      * Otherwise, the NodeInfo document will be fetched from the `.well-known`
@@ -13,6 +13,17 @@ export interface GetNodeInfoOptions extends ParseNodeInfoOptions {
      * Turned off by default.
      */
     direct?: boolean;
+    /**
+     * How strictly to parse the NodeInfo document.
+     *
+     *  -  `"strict"`: Parse the NodeInfo document strictly.  If the document is
+     *     invalid, `undefined` is returned.  This is the default.
+     *  -  `"best-effort"`: Try to parse the NodeInfo document even if it is
+     *     invalid.
+     *  -  `"none"`: Do not parse the NodeInfo document.  The function will return
+     *     the raw JSON value.
+     */
+    parse?: "strict" | "best-effort" | "none";
 }
 /**
  * Fetches a NodeInfo document from the given URL.
@@ -23,10 +34,27 @@ export interface GetNodeInfoOptions extends ParseNodeInfoOptions {
  *            the NodeInfo document will be fetched from the given URL.
  * @param options Options for fetching the NodeInfo document.
  * @returns The NodeInfo document if it could be fetched successfully.
- *          Otherwise, `null` is returned.
+ *          Otherwise, `undefined` is returned.
+ * @since 1.2.0
+ */
+export declare function getNodeInfo(url: URL | string, options?: GetNodeInfoOptions & {
+    parse?: "strict" | "best-effort";
+}): Promise<NodeInfo | undefined>;
+/**
+ * Fetches a NodeInfo document from the given URL.
+ * @param url The base URL of the server.  If `options.direct` is turned off
+ *            (default), the NodeInfo document will be fetched from
+ *            the `.well-known` location of this URL (hence the only origin
+ *            of the URL is used).  If `options.direct` is turned on,
+ *            the NodeInfo document will be fetched from the given URL.
+ * @param options Options for fetching the NodeInfo document.
+ * @returns The NodeInfo document if it could be fetched successfully.
+ *          Otherwise, `undefined` is returned.
  * @since 1.2.0
  */
-export declare function getNodeInfo(url: URL | string, options?: GetNodeInfoOptions): Promise<NodeInfo | null>;
+export declare function getNodeInfo(url: URL | string, options: GetNodeInfoOptions & {
+    parse: "none";
+}): Promise<JsonValue | undefined>;
 /**
  * Options for {@link parseNodeInfo} function.
  * @since 1.2.0

package/types/nodeinfo/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/nodeinfo/client.ts"],"names":[],"mappings":";AAGA,OAAO,KAAK,EACV,cAAc,EAEd,QAAQ,EACR,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,KAAK,EACN,MAAM,YAAY,CAAC;AAIpB;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,WAAW,CAC/B,GAAG,EAAE,GAAG,GAAG,MAAM,EACjB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAqD1B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,oBAAyB,GACjC,QAAQ,GAAG,IAAI,CAyDjB;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,oBAAyB,GACjC,QAAQ,GAAG,IAAI,CAuDjB;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,IAAI,CAY5D;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,oBAAyB,GACjC,QAAQ,GAAG,IAAI,CAqBjB;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,IAAI,CAWxE;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,eAAe,GAAG,IAAI,CAkB1E;AAED,wBAAgB,UAAU,CACxB,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,oBAAyB,GACjC,KAAK,GAAG,IAAI,CAiEd"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/nodeinfo/client.ts"],"names":[],"mappings":";AAGA,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,QAAQ,EACR,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,QAAQ,EACR,KAAK,EACN,MAAM,YAAY,CAAC;AAIpB;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,aAAa,GAAG,MAAM,CAAC;CAC3C;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,WAAW,CAC/B,GAAG,EAAE,GAAG,GAAG,MAAM,EACjB,OAAO,CAAC,EAAE,kBAAkB,GAAG;IAAE,KAAK,CAAC,EAAE,QAAQ,GAAG,aAAa,CAAA;CAAE,GAClE,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;AAEjC;;;;;;;;;;;GAWG;AACH,wBAAsB,WAAW,CAC/B,GAAG,EAAE,GAAG,GAAG,MAAM,EACjB,OAAO,EAAE,kBAAkB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAC9C,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;AA+DlC;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,oBAAyB,GACjC,QAAQ,GAAG,IAAI,CAyDjB;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,oBAAyB,GACjC,QAAQ,GAAG,IAAI,CAuDjB;AAED,wBAAgB,aAAa,CAAC,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,IAAI,CAY5D;AAED,wBAAgB,aAAa,CAC3B,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,oBAAyB,GACjC,QAAQ,GAAG,IAAI,CAqBjB;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,OAAO,GAAG,cAAc,GAAG,IAAI,CAWxE;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,OAAO,GAAG,eAAe,GAAG,IAAI,CAkB1E;AAED,wBAAgB,UAAU,CACxB,IAAI,EAAE,OAAO,EACb,OAAO,GAAE,oBAAyB,GACjC,KAAK,GAAG,IAAI,CAiEd"}