fandom.js 1.0.0 → 1.1.0

package/dist/types/client.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Represents the base URL of a wiki.
+ * @example "https://community.fandom.com"
+ */
+export type WikiHost = string;
+/**
+ * Options for configuring the client.
+ */
+export interface ClientOptions {
+    /**
+     * The base URL of the wiki.
+     */
+    host: WikiHost;
+    /**
+     * The path to the API. Defaults to "/api.php".
+     */
+    apiPath?: string;
+    /**
+     * The user agent to use for requests.
+     */
+    userAgent?: string;
+    /**
+     * The maximum number of retries for failed requests.
+     */
+    maxRetries?: number;
+    /**
+     * The maximum number of items to cache.
+     */
+    cacheSize?: number;
+    /**
+     * Whether to enable polling for recent changes.
+     */
+    polling?: boolean;
+    /**
+     * The interval in milliseconds for polling.
+     */
+    pollingInterval?: number;
+}
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/types/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,QAAQ,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B"}

package/dist/types/client.js

@@ -0,0 +1 @@
+export {};

package/dist/types/events.d.ts

@@ -0,0 +1,141 @@
+import { RCType } from "../enums/index.js";
+/**
+ * Represents a recent change on the wiki.
+ */
+export interface RecentChange {
+    /**
+     * The type of change.
+     */
+    type: RCType;
+    /**
+     * The namespace ID.
+     */
+    ns: number;
+    /**
+     * The title of the page.
+     */
+    title: string;
+    /**
+     * The page ID.
+     */
+    pageid: number;
+    /**
+     * The revision ID.
+     */
+    revid: number;
+    /**
+     * The old revision ID.
+     */
+    old_revid: number;
+    /**
+     * The recent change ID.
+     */
+    rcid: number;
+    /**
+     * The user who made the change.
+     */
+    user: string;
+    /**
+     * The timestamp of the change.
+     */
+    timestamp: string;
+    /**
+     * The comment associated with the change.
+     */
+    comment: string;
+    /**
+     * Whether the change was made by a bot.
+     */
+    bot?: boolean;
+    /**
+     * Whether the page is new.
+     */
+    new?: boolean;
+    /**
+     * Whether the change is minor.
+     */
+    minor?: boolean;
+    /**
+     * The log ID (if applicable).
+     */
+    logid?: number;
+    /**
+     * The log type (if applicable).
+     */
+    logtype?: string;
+    /**
+     * The log action (if applicable).
+     */
+    logaction?: string;
+}
+/**
+ * Represents a log event.
+ */
+export interface LogEvent {
+    /**
+     * The log ID.
+     */
+    logid: number;
+    /**
+     * The namespace ID.
+     */
+    ns: number;
+    /**
+     * The title of the page.
+     */
+    title: string;
+    /**
+     * The page ID.
+     */
+    pageid: number;
+    /**
+     * The log type.
+     */
+    logtype: string;
+    /**
+     * The log action.
+     */
+    logaction: string;
+    /**
+     * The user who performed the action.
+     */
+    user: string;
+    /**
+     * The timestamp of the event.
+     */
+    timestamp: string;
+    /**
+     * The comment associated with the event.
+     */
+    comment: string;
+    /**
+     * Additional parameters for the log event.
+     */
+    params?: Record<string, unknown>;
+}
+/**
+ * Represents a file upload event.
+ */
+export interface FileUploadEvent {
+    /**
+     * The title of the file.
+     */
+    title: string;
+    /**
+     * The user who uploaded the file.
+     */
+    user: string;
+    /**
+     * The timestamp of the upload.
+     */
+    timestamp: string;
+    /**
+     * The comment associated with the upload.
+     */
+    comment: string;
+    /**
+     * The URL of the uploaded file.
+     */
+    url: string;
+}
+//# sourceMappingURL=events.d.ts.map

package/dist/types/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/types/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,GAAG,CAAC,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb"}

package/dist/types/events.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./client.js";
+export * from "./api.js";
+export * from "./revision.js";
+export * from "./page.js";
+export * from "./user.js";
+export * from "./events.js";
+export * from "./site.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,7 @@
+export * from "./client.js";
+export * from "./api.js";
+export * from "./revision.js";
+export * from "./page.js";
+export * from "./user.js";
+export * from "./events.js";
+export * from "./site.js";

package/dist/types/page.d.ts

@@ -0,0 +1,105 @@
+import { APIRevision, RevisionData } from "./revision.js";
+/**
+ * Represents category data for a page.
+ */
+export interface CategoryData {
+    /**
+     * The namespace ID of the category.
+     */
+    ns: number;
+    /**
+     * The title of the category.
+     */
+    title: string;
+}
+/**
+ * Represents a page object returned by the API.
+ */
+export interface APIPage {
+    /**
+     * The ID of the page.
+     */
+    pageid: number;
+    /**
+     * The namespace ID of the page.
+     */
+    ns: number;
+    /**
+     * The title of the page.
+     */
+    title: string;
+    /**
+     * The extract (summary) of the page.
+     */
+    extract?: string;
+    /**
+     * The revisions of the page.
+     */
+    revisions?: APIRevision[];
+    /**
+     * The categories the page belongs to.
+     */
+    categories?: CategoryData[];
+    /**
+     * The ID of the last revision.
+     */
+    lastrevid?: number;
+    /**
+     * The length of the page content.
+     */
+    length?: number;
+    /**
+     * The timestamp when the page was last touched.
+     */
+    touched?: string;
+    /**
+     * Allow other properties from the API.
+     */
+    [key: string]: unknown;
+}
+/**
+ * Represents a summary of a page.
+ */
+export interface PageSummary {
+    /**
+     * The ID of the page.
+     */
+    pageid: number;
+    /**
+     * The namespace ID of the page.
+     */
+    ns: number;
+    /**
+     * The title of the page.
+     */
+    title: string;
+    /**
+     * The extract (summary) of the page.
+     */
+    extract?: string;
+    /**
+     * The revisions of the page.
+     */
+    revisions?: RevisionData[];
+    /**
+     * The categories the page belongs to.
+     */
+    categories?: CategoryData[];
+    /**
+     * The ID of the last revision.
+     */
+    lastrevid?: number;
+    /**
+     * The length of the page content.
+     */
+    length?: number;
+    /**
+     * The timestamp when the page was last touched.
+     */
+    touched?: string;
+    /**
+     * Allow other properties.
+     */
+    [key: string]: unknown;
+}
+//# sourceMappingURL=page.d.ts.map

package/dist/types/page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page.d.ts","sourceRoot":"","sources":["../../src/types/page.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,WAAW,EAAE,CAAC;IAC1B;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB"}

package/dist/types/page.js

@@ -0,0 +1 @@
+export {};

package/dist/types/revision.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Represents a revision object returned by the API.
+ */
+export interface APIRevision {
+    /**
+     * The ID of the revision.
+     */
+    revid: number;
+    /**
+     * The ID of the parent revision.
+     */
+    parentid: number;
+    /**
+     * The user who created the revision.
+     */
+    user: string;
+    /**
+     * The timestamp of the revision.
+     */
+    timestamp: string;
+    /**
+     * The comment associated with the revision.
+     */
+    comment: string;
+    /**
+     * The content of the revision (legacy format).
+     */
+    "*"?: string;
+    /**
+     * The title of the page.
+     */
+    title?: string;
+    /**
+     * The slots of the revision (modern format).
+     */
+    slots?: {
+        main?: {
+            "*"?: string;
+        };
+        Main?: {
+            "*"?: string;
+        };
+        [key: string]: unknown;
+    };
+    /**
+     * Whether the revision is minor.
+     */
+    minor?: boolean;
+}
+/**
+ * Represents processed revision data.
+ */
+export interface RevisionData {
+    /**
+     * The ID of the revision.
+     */
+    revid: number;
+    /**
+     * The ID of the parent revision.
+     */
+    parentid: number;
+    /**
+     * The user who created the revision.
+     */
+    user: string;
+    /**
+     * The timestamp of the revision.
+     */
+    timestamp: string;
+    /**
+     * The comment associated with the revision.
+     */
+    comment: string;
+    /**
+     * The content of the revision.
+     */
+    content?: string;
+    /**
+     * Whether the revision is minor.
+     */
+    minor?: boolean;
+}
+//# sourceMappingURL=revision.d.ts.map

package/dist/types/revision.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"revision.d.ts","sourceRoot":"","sources":["../../src/types/revision.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,IAAI,CAAC,EAAE;YACL,GAAG,CAAC,EAAE,MAAM,CAAC;SACd,CAAC;QACF,IAAI,CAAC,EAAE;YACL,GAAG,CAAC,EAAE,MAAM,CAAC;SACd,CAAC;QACF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB"}

package/dist/types/revision.js

@@ -0,0 +1 @@
+export {};

package/dist/types/site.d.ts

@@ -0,0 +1,290 @@
+/**
+ * Represents general site information.
+ */
+export interface GeneralSiteInfo {
+    /**
+     * The main page of the wiki.
+     */
+    mainpage: string;
+    /**
+     * The base URL of the wiki.
+     */
+    base: string;
+    /**
+     * The name of the site.
+     */
+    sitename: string;
+    /**
+     * The URL of the logo.
+     */
+    logo: string;
+    /**
+     * The generator used by the wiki.
+     */
+    generator: string;
+    /**
+     * The PHP version.
+     */
+    phpversion: string;
+    /**
+     * The PHP SAPI.
+     */
+    phpsapi: string;
+    /**
+     * The database type.
+     */
+    dbtype: string;
+    /**
+     * The database version.
+     */
+    dbversion: string;
+    /**
+     * Whether image whitelist is enabled.
+     */
+    imagewhitelistenabled: string;
+    /**
+     * Language conversion settings.
+     */
+    langconversion: string;
+    /**
+     * Title conversion settings.
+     */
+    titleconversion: string;
+    /**
+     * Link prefix charset.
+     */
+    linkprefixcharset: string;
+    /**
+     * Link prefix.
+     */
+    linkprefix: string;
+    /**
+     * Link trail.
+     */
+    linktrail: string;
+    /**
+     * Legal title characters.
+     */
+    legaltitlechars: string;
+    /**
+     * Invalid username characters.
+     */
+    invalidusernamechars: string;
+    /**
+     * Fix Arabic unicode.
+     */
+    fixarabicunicode: string;
+    /**
+     * Fix Malayalam unicode.
+     */
+    fixmalayalamunicode: string;
+    /**
+     * Case sensitivity.
+     */
+    case: string;
+    /**
+     * Language code.
+     */
+    lang: string;
+    /**
+     * Fallback languages.
+     */
+    fallback: {
+        code: string;
+    }[];
+    /**
+     * Fallback 8-bit encoding.
+     */
+    fallback8bitEncoding: string;
+    /**
+     * Whether write API is enabled.
+     */
+    writeapi: string;
+    /**
+     * Maximum article size.
+     */
+    maxarticlesize: number;
+    /**
+     * Timezone.
+     */
+    timezone: string;
+    /**
+     * Time offset.
+     */
+    timeoffset: number;
+    /**
+     * Article path.
+     */
+    articlepath: string;
+    /**
+     * Script path.
+     */
+    scriptpath: string;
+    /**
+     * Script URL.
+     */
+    script: string;
+    /**
+     * Variant article path.
+     */
+    variantarticlepath: string;
+    /**
+     * Server URL.
+     */
+    server: string;
+    /**
+     * Server name.
+     */
+    servername: string;
+    /**
+     * Wiki ID.
+     */
+    wikiid: string;
+    /**
+     * Current time.
+     */
+    time: string;
+    /**
+     * Miser mode.
+     */
+    misermode: string;
+    /**
+     * Whether uploads are enabled.
+     */
+    uploadsenabled: string;
+    /**
+     * Maximum upload size.
+     */
+    maxuploadsize: number;
+    /**
+     * Minimum upload chunk size.
+     */
+    minuploadchunksize: number;
+    /**
+     * Gallery options.
+     */
+    galleryoptions: {
+        imagesPerRow: number;
+        imageWidth: number;
+        imageHeight: number;
+        captionLength: number;
+        showBytes: string;
+        showDimensions: string;
+        mode: string;
+    };
+    /**
+     * Thumbnail limits.
+     */
+    thumblimits: number[];
+    /**
+     * Image limits.
+     */
+    imagelimits: {
+        width: number;
+        height: number;
+    }[];
+    /**
+     * Favicon URL.
+     */
+    favicon: string;
+    /**
+     * Central ID.
+     */
+    centralid: string;
+    /**
+     * All central IDs.
+     */
+    allcentralids: Record<string, string>;
+}
+/**
+ * Represents namespace information.
+ */
+export interface NamespaceInfo {
+    /**
+     * The ID of the namespace.
+     */
+    id: number;
+    /**
+     * Case sensitivity.
+     */
+    case: string;
+    /**
+     * Canonical name.
+     */
+    canonical?: string;
+    /**
+     * Local name.
+     */
+    "*": string;
+    /**
+     * Subpages enabled.
+     */
+    subpages?: string;
+    /**
+     * Content namespace.
+     */
+    content?: string;
+    /**
+     * Non-includable.
+     */
+    nonincludable?: string;
+}
+/**
+ * Represents site statistics.
+ */
+export interface SiteStatistics {
+    /**
+     * Total pages.
+     */
+    pages: number;
+    /**
+     * Total articles.
+     */
+    articles: number;
+    /**
+     * Total edits.
+     */
+    edits: number;
+    /**
+     * Total images.
+     */
+    images: number;
+    /**
+     * Total users.
+     */
+    users: number;
+    /**
+     * Active users.
+     */
+    activeusers: number;
+    /**
+     * Admins.
+     */
+    admins: number;
+    /**
+     * Job queue length.
+     */
+    jobs: number;
+}
+/**
+ * Represents site information.
+ */
+export interface SiteInfo {
+    /**
+     * General site information.
+     */
+    general: GeneralSiteInfo;
+    /**
+     * Namespace information.
+     */
+    namespaces: Record<string, NamespaceInfo>;
+    /**
+     * Site statistics.
+     */
+    statistics: SiteStatistics;
+    /**
+     * Allow other properties.
+     */
+    [key: string]: unknown;
+}
+//# sourceMappingURL=site.d.ts.map