@fedify/fedify/types/nodeinfo/types.d.ts

An ActivityPub server framework

import { type SemVer } from "../deps/jsr.io/@std/semver/1.0.4/mod.js";
/**
 * The type of the result of parsing JSON.
 */
export type JsonValue = {
    [key: string]: JsonValue | undefined;
} | JsonValue[] | string | number | boolean | null;
/**
 * A NodeInfo object as defined in the NodeInfo 2.1 schema.
 */
export interface NodeInfo {
    /**
     * Metadata about server software in use.
     */
    software: Software;
    /**
     * The protocols supported on this server.  At least one protocol must be
     * supported.
     */
    protocols: Protocol[];
    /**
     * The third party sites this server can connect to via their application API.
     */
    services?: Services;
    /**
     * Whether this server allows open self-registration.  Defaults to `false`.
     */
    openRegistrations?: boolean;
    /**
     * Usage statistics for this server.
     */
    usage: Usage;
    /**
     * Free form key value pairs for software specific values.
     * Clients should not rely on any specific key present.
     */
    metadata?: Record<string, JsonValue>;
}
/**
 * Metadata about server software in use.
 */
export interface Software {
    /**
     * The canonical name of this server software.  This must comply with
     * pattern `/^[a-z0-9-]+$/`.
     */
    name: string;
    /**
     * The version of this server software.
     * @see {@link parseSemVer}
     */
    version: SemVer;
    /**
     * The URL of the source code repository of this server software.
     */
    repository?: URL;
    /**
     * The URL of the homepage of this server software.
     */
    homepage?: URL;
}
/**
 * The protocols supported on this server.
 */
export type Protocol = "activitypub" | "buddycloud" | "dfrn" | "diaspora" | "libertree" | "ostatus" | "pumpio" | "tent" | "xmpp" | "zot";
/**
 * The third party sites this server can connect to via their application API.
 */
export interface Services {
    /**
     * The third party sites this server can retrieve messages from for combined
     * display with regular traffic.
     */
    inbound?: InboundService[];
    /**
     * The third party sites this server can publish messages to on the behalf
     * of a user.
     */
    outbound?: OutboundService[];
}
/**
 * The third party sites this server can retrieve messages from for combined
 * display with regular traffic.
 */
export type InboundService = "atom1.0" | "gnusocial" | "imap" | "pnut" | "pop3" | "pumpio" | "rss2.0" | "twitter";
/**
 * The third party sites this server can publish messages to on the behalf
 * of a user.
 */
export type OutboundService = "atom1.0" | "blogger" | "buddycloud" | "diaspora" | "dreamwidth" | "drupal" | "facebook" | "friendica" | "gnusocial" | "google" | "insanejournal" | "libertree" | "linkedin" | "livejournal" | "mediagoblin" | "myspace" | "pinterest" | "pnut" | "posterous" | "pumpio" | "redmatrix" | "rss2.0" | "smtp" | "tent" | "tumblr" | "twitter" | "wordpress" | "xmpp";
/**
 * Usage statistics for this server.
 */
export interface Usage {
    /**
     * Statistics about the users of this server.
     */
    users: {
        /**
         * The total amount of on this server registered users.  This number
         * has to be an integer greater than or equal to zero.
         */
        total?: number;
        /**
         * The amount of users that signed in at least once in the last 180 days.
         * This number has to be an integer greater than or equal to zero.
         */
        activeHalfyear?: number;
        /**
         * The amount of users that signed in at least once in the last 30 days.
         * This number has to be an integer greater than or equal to zero.
         */
        activeMonth?: number;
    };
    /**
     * The amount of posts that were made by users that are registered on this
     * server.  This number has to be an integer greater than or equal to zero.
     */
    localPosts: number;
    /**
     * The amount of comments that were made by users that are registered on this
     * server.  This number has to be an integer greater than or equal to zero.
     */
    localComments: number;
}
/**
 * Converts a {@link NodeInfo} object to a JSON value.
 * @param nodeInfo The {@link NodeInfo} object to convert.
 * @returns The JSON value that complies with the NodeInfo schema.
 * @throws {TypeError} If the {@link NodeInfo} object is invalid.
 */
export declare function nodeInfoToJson(nodeInfo: NodeInfo): JsonValue;
//# sourceMappingURL=types.d.ts.map