@fedify/fedify 1.2.0-dev.450 → 1.2.0-dev.452

package/CHANGES.md

@@ -8,12 +8,24 @@ Version 1.2.0
 
 To be released.
 
+ -  Added NodeInfo client functions.
+
+     -  Added `getNodeInfo()` function.
+     -  Added `GetNodeInfoOptions` interface.
+     -  Added `parseNodeInfo()` function.
+     -  Added `ParseNodeInfoOptions` interface.
+
  -  Re-exported Semantic Versioning-related types and functions:
 
      -  Added `SemVer` type.
      -  Added `formatSemVer()` function.
      -  Added `parseSemVer()` function.
 
+ -  Added more log messages using the [LogTape] library.  Currently the below
+    logger categories are used:
+
+     -  `["fedify", "nodeinfo", "client"]`
+
 
 Version 1.1.0
 -------------

package/FEDERATION.md

@@ -58,6 +58,7 @@ lists the activity types that Fedify provides:
  -  [`Create`](https://jsr.io/@fedify/fedify/doc/vocab/~/Create)
  -  [`Delete`](https://jsr.io/@fedify/fedify/doc/vocab/~/Delete)
  -  [`Dislike`](https://jsr.io/@fedify/fedify/doc/vocab/~/Dislike)
+ -  [`EmojiReact`](https://jsr.io/@fedify/fedify/doc/vocab/~/EmojiReact)
  -  [`Flag`](https://jsr.io/@fedify/fedify/doc/vocab/~/Flag)
  -  [`Follow`](https://jsr.io/@fedify/fedify/doc/vocab/~/Follow)
  -  [`Ignore`](https://jsr.io/@fedify/fedify/doc/vocab/~/Ignore)

package/esm/nodeinfo/client.js

@@ -0,0 +1,365 @@
+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;
+        if (!options.direct) {
+            const wellKnownUrl = new URL("/.well-known/nodeinfo", url);
+            const wellKnownResponse = await fetch(wellKnownUrl);
+            if (!wellKnownResponse.ok) {
+                logger.error("Failed to fetch {url}: {status} {statusText}", {
+                    url: wellKnownUrl.href,
+                    status: wellKnownResponse.status,
+                    statusText: wellKnownResponse.statusText,
+                });
+                return null;
+            }
+            const wellKnownRd = await wellKnownResponse.json();
+            const link = wellKnownRd?.links?.find((link) => link != null &&
+                "rel" in link &&
+                (link.rel === "http://nodeinfo.diaspora.software/ns/schema/2.0" ||
+                    link.rel === "http://nodeinfo.diaspora.software/ns/schema/2.1") &&
+                "href" in link &&
+                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;
+            }
+            nodeInfoUrl = link.href;
+        }
+        const response = await fetch(nodeInfoUrl);
+        if (!response.ok) {
+            logger.error("Failed to fetch NodeInfo document from {url}: {status} {statusText}", {
+                url: nodeInfoUrl.toString(),
+                status: response.status,
+                statusText: response.statusText,
+            });
+            return null;
+        }
+        const data = await response.json();
+        return parseNodeInfo(data, options);
+    }
+    catch (error) {
+        logger.error("Failed to fetch NodeInfo document from {url}: {error}", {
+            url: url.toString(),
+            error,
+        });
+        return null;
+    }
+}
+/**
+ * Parses a NodeInfo document.
+ * @param data A JSON value that complies with the NodeInfo schema.
+ * @param options Options for parsing the NodeInfo document.
+ * @returns The parsed NodeInfo document if it is valid.  Otherwise, `null`
+ *          is returned.
+ * @since 1.2.0
+ */
+export function parseNodeInfo(data, options = {}) {
+    if (typeof data !== "object" || data == null || !("software" in data)) {
+        return null;
+    }
+    const software = parseSoftware(data.software, options);
+    if (software == null)
+        return null;
+    let protocols = [];
+    if ("protocols" in data && Array.isArray(data.protocols)) {
+        const ps = data.protocols.map(parseProtocol);
+        protocols = ps.filter((p) => p != null);
+        if (ps.length != protocols.length && !options.tryBestEffort)
+            return null;
+    }
+    else {
+        if (!options.tryBestEffort)
+            return null;
+    }
+    let services;
+    if ("services" in data) {
+        if (typeof data.services === "object" && data.services != null) {
+            const ss = parseServices(data.services, options);
+            if (ss == null) {
+                if (!options.tryBestEffort)
+                    return null;
+            }
+            else {
+                services = ss;
+            }
+        }
+        else if (!options.tryBestEffort)
+            return null;
+    }
+    let openRegistrations;
+    if ("openRegistrations" in data) {
+        if (typeof data.openRegistrations === "boolean") {
+            openRegistrations = data.openRegistrations;
+        }
+        else {
+            if (!options.tryBestEffort)
+                return null;
+        }
+    }
+    let usage = {
+        users: {},
+        localPosts: 0,
+        localComments: 0,
+    };
+    if ("usage" in data) {
+        const u = parseUsage(data.usage, options);
+        if (u == null) {
+            if (!options.tryBestEffort)
+                return null;
+        }
+        else {
+            usage = u;
+        }
+    }
+    let metadata;
+    if ("metadata" in data) {
+        if (typeof data.metadata === "object" && data.metadata != null) {
+            metadata = Object.fromEntries(Object.entries(data.metadata));
+        }
+        else if (!options.tryBestEffort)
+            return null;
+    }
+    const result = { software, protocols, usage };
+    if (services != null)
+        result.services = services;
+    if (openRegistrations != null)
+        result.openRegistrations = openRegistrations;
+    if (metadata != null)
+        result.metadata = metadata;
+    return result;
+}
+export function parseSoftware(data, options = {}) {
+    if (typeof data !== "object" || data == null) {
+        if (!options.tryBestEffort)
+            data = {};
+        return null;
+    }
+    let name;
+    if ("name" in data && typeof data.name === "string" &&
+        data.name.match(/^\s*[A-Za-z0-9-]+\s*$/)) {
+        if (!data.name.match(/^[a-z0-9-]+$/) && !options.tryBestEffort)
+            return null;
+        name = data.name.trim().toLowerCase();
+    }
+    else {
+        return null;
+    }
+    let version;
+    if ("version" in data && typeof data.version === "string") {
+        try {
+            version = parse(data.version);
+        }
+        catch {
+            if (!options.tryBestEffort)
+                return null;
+            version = { major: 0, minor: 0, patch: 0, build: [], prerelease: [] };
+        }
+    }
+    else {
+        if (!options.tryBestEffort)
+            return null;
+        version = { major: 0, minor: 0, patch: 0, build: [], prerelease: [] };
+    }
+    let repository;
+    if ("repository" in data) {
+        if (typeof data.repository === "string") {
+            try {
+                repository = new URL(data.repository);
+            }
+            catch {
+                if (!options.tryBestEffort)
+                    return null;
+            }
+        }
+        else {
+            if (!options.tryBestEffort)
+                return null;
+        }
+    }
+    let homepage;
+    if ("homepage" in data) {
+        if (typeof data.homepage === "string") {
+            try {
+                homepage = new URL(data.homepage);
+            }
+            catch {
+                if (!options.tryBestEffort)
+                    return null;
+            }
+        }
+        else {
+            if (!options.tryBestEffort)
+                return null;
+        }
+    }
+    const result = { name, version };
+    if (repository != null)
+        result.repository = repository;
+    if (homepage != null)
+        result.homepage = homepage;
+    return result;
+}
+export function parseProtocol(data) {
+    // cSpell: disable
+    if (data === "activitypub" || data === "buddycloud" || data === "dfrn" ||
+        data === "diaspora" || data === "libertree" || data === "ostatus" ||
+        data === "pumpio" || data === "tent" || data === "xmpp" ||
+        data === "zot") {
+        // cSpell: enable
+        return data;
+    }
+    return null;
+}
+export function parseServices(data, options = {}) {
+    if (!(typeof data === "object") || data == null) {
+        if (options.tryBestEffort)
+            return {};
+        return null;
+    }
+    let inbound;
+    if ("inbound" in data && Array.isArray(data.inbound)) {
+        const is = data.inbound.map(parseInboundService);
+        inbound = is.filter((i) => i != null);
+        if (is.length > inbound.length && !options.tryBestEffort)
+            return null;
+    }
+    let outbound;
+    if ("outbound" in data && Array.isArray(data.outbound)) {
+        const os = data.outbound.map(parseOutboundService);
+        outbound = os.filter((o) => o != null);
+        if (os.length > outbound.length && !options.tryBestEffort)
+            return null;
+    }
+    const result = {};
+    if (inbound != null)
+        result.inbound = inbound;
+    if (outbound != null)
+        result.outbound = outbound;
+    return result;
+}
+export function parseInboundService(data) {
+    // cSpell: disable
+    if (data === "atom1.0" || data === "gnusocial" || data === "imap" ||
+        data === "pnut" || data === "pop3" || data === "pumpio" ||
+        data === "rss2.0" || data === "twitter") {
+        // cSpell: enable
+        return data;
+    }
+    return null;
+}
+export function parseOutboundService(data) {
+    // cSpell: disable
+    if (data === "atom1.0" || data === "blogger" || data === "buddycloud" ||
+        data === "diaspora" || data === "dreamwidth" || data === "drupal" ||
+        data === "facebook" || data === "friendica" || data === "gnusocial" ||
+        data === "google" || data === "insanejournal" || data === "libertree" ||
+        data === "linkedin" || data === "livejournal" || data === "mediagoblin" ||
+        data === "myspace" || data === "pinterest" || data === "pnut" ||
+        data === "posterous" || data === "pumpio" || data === "redmatrix" ||
+        data === "rss2.0" || data === "smtp" || data === "tent" ||
+        data === "tumblr" || data === "twitter" || data === "wordpress" ||
+        data === "xmpp") {
+        // cSpell: enable
+        return data;
+    }
+    return null;
+}
+export function parseUsage(data, options = {}) {
+    if (typeof data !== "object" || data == null)
+        return null;
+    const users = {};
+    if ("users" in data && typeof data.users === "object" && data.users != null) {
+        if ("total" in data.users) {
+            if (typeof data.users.total === "number") {
+                users.total = data.users.total;
+            }
+            else {
+                if (!options.tryBestEffort)
+                    return null;
+                if (typeof data.users.total === "string") {
+                    const n = parseInt(data.users.total);
+                    if (!isNaN(n))
+                        users.total = n;
+                }
+            }
+        }
+        if ("activeHalfyear" in data.users) {
+            if (typeof data.users.activeHalfyear === "number") {
+                users.activeHalfyear = data.users.activeHalfyear;
+            }
+            else {
+                if (!options.tryBestEffort)
+                    return null;
+                if (typeof data.users.activeHalfyear === "string") {
+                    const n = parseInt(data.users.activeHalfyear);
+                    if (!isNaN(n))
+                        users.activeHalfyear = n;
+                }
+            }
+        }
+        if ("activeMonth" in data.users) {
+            if (typeof data.users.activeMonth === "number") {
+                users.activeMonth = data.users.activeMonth;
+            }
+            else {
+                if (!options.tryBestEffort)
+                    return null;
+                if (typeof data.users.activeMonth === "string") {
+                    const n = parseInt(data.users.activeMonth);
+                    if (!isNaN(n))
+                        users.activeMonth = n;
+                }
+            }
+        }
+    }
+    else {
+        if (!options.tryBestEffort)
+            return null;
+    }
+    let localPosts = 0;
+    if ("localPosts" in data) {
+        if (typeof data.localPosts === "number") {
+            localPosts = data.localPosts;
+        }
+        else {
+            if (!options.tryBestEffort)
+                return null;
+            if (typeof data.localPosts === "string") {
+                const n = parseInt(data.localPosts);
+                if (!isNaN(n))
+                    localPosts = n;
+            }
+        }
+    }
+    let localComments = 0;
+    if ("localComments" in data) {
+        if (typeof data.localComments === "number") {
+            localComments = data.localComments;
+        }
+        else {
+            if (!options.tryBestEffort)
+                return null;
+            if (typeof data.localComments === "string") {
+                const n = parseInt(data.localComments);
+                if (!isNaN(n))
+                    localComments = n;
+            }
+        }
+    }
+    return { users, localPosts, localComments };
+}

package/esm/nodeinfo/mod.js

@@ -6,4 +6,5 @@
  * @since 0.2.0
  */
 export { format as formatSemVer, parse as parseSemVer, } from "../deps/jsr.io/@std/semver/1.0.3/mod.js";
+export { getNodeInfo, parseNodeInfo, } from "./client.js";
 export * from "./types.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/fedify",
-  "version": "1.2.0-dev.450+58427679",
+  "version": "1.2.0-dev.452+aa5e275d",
   "description": "An ActivityPub server framework",
   "keywords": [
     "ActivityPub",

package/types/nodeinfo/client.d.ts

@@ -0,0 +1,58 @@
+/// <reference types="node" />
+import type { InboundService, NodeInfo, OutboundService, Protocol, Services, Software, Usage } from "./types.js";
+/**
+ * Options for {@link getNodeInfo} function.
+ * @since 1.2.0
+ */
+export interface GetNodeInfoOptions extends ParseNodeInfoOptions {
+    /**
+     * Whether to directly fetch the NodeInfo document from the given URL.
+     * Otherwise, the NodeInfo document will be fetched from the `.well-known`
+     * location of the given URL.
+     *
+     * Turned off by default.
+     */
+    direct?: boolean;
+}
+/**
+ * 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 declare function getNodeInfo(url: URL | string, options?: GetNodeInfoOptions): Promise<NodeInfo | null>;
+/**
+ * Options for {@link parseNodeInfo} function.
+ * @since 1.2.0
+ */
+export interface ParseNodeInfoOptions {
+    /**
+     * Whether to try to parse the NodeInfo document even if it is invalid.
+     * If turned on, the function will return a best-effort result.
+     *
+     * Turned off by default.
+     */
+    tryBestEffort?: boolean;
+}
+/**
+ * Parses a NodeInfo document.
+ * @param data A JSON value that complies with the NodeInfo schema.
+ * @param options Options for parsing the NodeInfo document.
+ * @returns The parsed NodeInfo document if it is valid.  Otherwise, `null`
+ *          is returned.
+ * @since 1.2.0
+ */
+export declare function parseNodeInfo(data: unknown, options?: ParseNodeInfoOptions): NodeInfo | null;
+export declare function parseSoftware(data: unknown, options?: ParseNodeInfoOptions): Software | null;
+export declare function parseProtocol(data: unknown): Protocol | null;
+export declare function parseServices(data: unknown, options?: ParseNodeInfoOptions): Services | null;
+export declare function parseInboundService(data: unknown): InboundService | null;
+export declare function parseOutboundService(data: unknown): OutboundService | null;
+export declare function parseUsage(data: unknown, options?: ParseNodeInfoOptions): Usage | null;
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +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"}

package/types/nodeinfo/mod.d.ts

@@ -6,5 +6,6 @@
  * @since 0.2.0
  */
 export { format as formatSemVer, parse as parseSemVer, type SemVer, } from "../deps/jsr.io/@std/semver/1.0.3/mod.js";
+export { getNodeInfo, type GetNodeInfoOptions, parseNodeInfo, type ParseNodeInfoOptions, } from "./client.js";
 export * from "./types.js";
 //# sourceMappingURL=mod.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/nodeinfo/mod.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EACL,MAAM,IAAI,YAAY,EACtB,KAAK,IAAI,WAAW,EACpB,KAAK,MAAM,GACZ,MAAM,yCAAyC,CAAC;AACjD,cAAc,YAAY,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../../src/nodeinfo/mod.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EACL,MAAM,IAAI,YAAY,EACtB,KAAK,IAAI,WAAW,EACpB,KAAK,MAAM,GACZ,MAAM,yCAAyC,CAAC;AACjD,OAAO,EACL,WAAW,EACX,KAAK,kBAAkB,EACvB,aAAa,EACb,KAAK,oBAAoB,GAC1B,MAAM,aAAa,CAAC;AACrB,cAAc,YAAY,CAAC"}