@ukwhatn/wikidot 4.0.7 → 4.1.0

package/dist/index.d.cts

@@ -467,6 +467,24 @@ interface ForumThreadRef {
 	readonly category?: ForumCategoryRef | null;
 }
 /**
+* Forum post reference interface
+* Used to avoid direct dependency on ForumPost type
+*/
+interface ForumPostRef {
+	/**
+	* Post ID
+	*/
+	readonly id: number;
+	/**
+	* Post title
+	*/
+	readonly title: string;
+	/**
+	* Thread reference
+	*/
+	readonly thread: ForumThreadRef;
+}
+/**
 * Page reference interface
 * Used to avoid direct dependency on Page type
 */
@@ -789,6 +807,86 @@ declare class PrivateMessageSentBox extends PrivateMessageCollection {
 }
 import { Element } from "domhandler";
 /**
+* Forum post revision data
+*/
+interface ForumPostRevisionData {
+	post: ForumPostRef;
+	id: number;
+	revNo: number;
+	createdBy: AbstractUser;
+	createdAt: Date;
+}
+/**
+* Forum post revision (version in edit history)
+*/
+declare class ForumPostRevision {
+	/** Post this revision belongs to */
+	readonly post: ForumPostRef;
+	/** Revision ID */
+	readonly id: number;
+	/** Revision number (0 = initial version) */
+	readonly revNo: number;
+	/** Revision creator */
+	readonly createdBy: AbstractUser;
+	/** Revision creation date */
+	readonly createdAt: Date;
+	/** HTML content (internal cache) */
+	private _html;
+	constructor(data: ForumPostRevisionData);
+	/**
+	* Whether HTML content has been acquired
+	*/
+	isHtmlAcquired(): boolean;
+	/**
+	* Get HTML content (cached)
+	*/
+	get html(): string | null;
+	/**
+	* Set HTML content
+	*/
+	set html(value: string | null);
+	/**
+	* Get revision HTML content
+	* @returns HTML string
+	*/
+	getHtml(): WikidotResultAsync<string>;
+	toString(): string;
+}
+/**
+* Forum post revision collection
+*/
+declare class ForumPostRevisionCollection extends Array<ForumPostRevision> {
+	readonly post: ForumPostRef;
+	constructor(post: ForumPostRef, revisions?: ForumPostRevision[]);
+	/**
+	* Find by ID
+	* @param id - Revision ID
+	* @returns Revision (undefined if not found)
+	*/
+	findById(id: number): ForumPostRevision | undefined;
+	/**
+	* Find by revision number
+	* @param revNo - Revision number
+	* @returns Revision (undefined if not found)
+	*/
+	findByRevNo(revNo: number): ForumPostRevision | undefined;
+	/**
+	* Get HTML for all revisions
+	* @returns Array of HTML strings
+	*/
+	getHtmls(): WikidotResultAsync<string[]>;
+	/**
+	* Parse revisions from HTML (internal method)
+	*/
+	private static _parse;
+	/**
+	* Get all revisions for a post
+	* @param post - Forum post reference
+	* @returns Revision collection
+	*/
+	static acquireAll(post: ForumPostRef): WikidotResultAsync<ForumPostRevisionCollection>;
+}
+/**
 * Forum post data
 */
 interface ForumPostData {
@@ -818,6 +916,7 @@ declare class ForumPost {
 	readonly editedAt: Date | null;
 	private _parentId;
 	private _source;
+	private _revisions;
 	constructor(data: ForumPostData);
 	/**
 	* Parent post ID
@@ -833,6 +932,15 @@ declare class ForumPost {
 	* @param title - New title (keeps current title if omitted)
 	*/
 	edit(source: string, title?: string): WikidotResultAsync<void>;
+	/**
+	* Whether the post has been edited (has revisions)
+	*/
+	get hasRevisions(): boolean;
+	/**
+	* Get post revisions (edit history)
+	* @returns Revision collection
+	*/
+	getRevisions(): WikidotResultAsync<ForumPostRevisionCollection>;
 	toString(): string;
 }
 /**
@@ -872,7 +980,7 @@ interface ForumThreadData {
 /**
 * Forum thread
 */
-declare class ForumThread2 {
+declare class ForumThread {
 	readonly site: Site;
 	readonly id: number;
 	readonly title: string;
@@ -894,23 +1002,23 @@ declare class ForumThread2 {
 	/**
 	* Reply to thread
 	*/
-	reply(source: string, title?: string, parentPostId?: number | null): WikidotResultAsync<ForumThread2>;
+	reply(source: string, title?: string, parentPostId?: number | null): WikidotResultAsync<ForumThread>;
 	toString(): string;
 	/**
 	* Get thread by ID
 	*/
-	static getFromId(site: Site, threadId: number, category?: ForumCategory | null): WikidotResultAsync<ForumThread2>;
+	static getFromId(site: Site, threadId: number, category?: ForumCategory | null): WikidotResultAsync<ForumThread>;
 }
 /**
 * Forum thread collection
 */
-declare class ForumThreadCollection extends Array<ForumThread2> {
+declare class ForumThreadCollection extends Array<ForumThread> {
 	readonly site: Site;
-	constructor(site: Site, threads?: ForumThread2[]);
+	constructor(site: Site, threads?: ForumThread[]);
 	/**
 	* Find by ID
 	*/
-	findById(id: number): ForumThread2 | undefined;
+	findById(id: number): ForumThread | undefined;
 	/**
 	* Get all threads in category
 	*/
@@ -920,7 +1028,7 @@ declare class ForumThreadCollection extends Array<ForumThread2> {
 	* @param site - Site instance
 	* @param threadId - Thread ID
 	*/
-	static fromId(site: Site, threadId: number): WikidotResultAsync<ForumThread2>;
+	static fromId(site: Site, threadId: number): WikidotResultAsync<ForumThread>;
 	/**
 	* Get threads by thread IDs
 	*/
@@ -960,7 +1068,7 @@ declare class ForumCategory {
 	/**
 	* Create thread
 	*/
-	createThread(title: string, description: string, source: string): WikidotResultAsync<ForumThread2>;
+	createThread(title: string, description: string, source: string): WikidotResultAsync<ForumThread>;
 	toString(): string;
 }
 /**
@@ -1648,7 +1756,7 @@ declare class Page {
 	/**
 	* Get the discussion thread for the page
 	*/
-	getDiscussion(): WikidotResultAsync<import("../forum").ForumThread | null>;
+	getDiscussion(): WikidotResultAsync<ForumThread | null>;
 	/**
 	* Get the list of meta tags for the page
 	* @returns Meta tag collection
@@ -1941,7 +2049,7 @@ declare class ForumAccessor {
 	* @param threadId - Thread ID
 	* @returns Thread
 	*/
-	getThread(threadId: number): WikidotResultAsync<ForumThread2>;
+	getThread(threadId: number): WikidotResultAsync<ForumThread>;
 	/**
 	* Get multiple threads
 	* @param threadIds - Array of thread IDs
@@ -2170,4 +2278,4 @@ declare function parseUser2(client: ClientRef, elem: cheerio2.Cheerio<AnyNode2>)
 * @returns Parsed Date, or null on parse failure
 */
 declare function parseOdate(elem: cheerio2.Cheerio<AnyNode2>): Date | null;
-export { wdOkAsync, wdOk, wdErrAsync, wdErr, userLookup, setupConsoleHandler, parseUser2 as parseUser, parseOdate, pageLookup, nullHandler, memberLookup, maskSensitiveData, logout, login, logger, isSuccessResponse, getLogger, fromPromise, consoleHandler, combineResults, amcResponseSchema, WikidotUser, WikidotStatusError, WikidotResultAsync, WikidotResult, WikidotError, UserType, UserIdentifier, UserData, UserCollection, UserAccessor, User, UnexpectedError, TargetExistsError, TargetError, SiteUnixName, SiteRef, SiteMemberData, SiteMember, SiteData, SiteChangeData, SiteChangeCollection, SiteChange, SiteApplicationData, SiteApplication, SiteAccessor, Site, SessionError, SessionCreateError, SearchPagesQueryParams, SearchPagesQuery, ResponseDataError, QuickModuleName, QuickModule, QMCUser, QMCPage, PrivateMessageSentBox, PrivateMessageInbox, PrivateMessageData, PrivateMessageCollection, PrivateMessageAccessor, PrivateMessage, PagesAccessor, PageVoteData, PageVoteCollection, PageVote, PageSourceData, PageSource, PageRevisionData, PageRevisionCollection, PageRevision, PageRef, PageMetaData, PageMetaCollection, PageMeta, PageFullname, PageFileData, PageFileCollection, PageFile, PageData, PageCollection, PageAccessor, Page, NotFoundException, NoElementError, MemberAccessor, LoginRequiredError, Logger, LogLevel, LogHandler, GuestUser, GetUserOptions, ForumThreadRef, ForumThreadData, ForumThreadCollection, ForumThread2 as ForumThread, ForumPostData, ForumPostCollection, ForumPost, ForumCategoryRef, ForumCategoryData, ForumCategoryCollection, ForumCategory, ForumAccessor, ForbiddenError, DeletedUser, DateTimeString, DEFAULT_PER_PAGE, DEFAULT_MODULE_BODY, DEFAULT_AMC_CONFIG, ClientRef, ClientOptions, Client, AuthClientContext, AnonymousUser, AbstractUser, AMCSuccessResponse, AMCResponse, AMCRequestOptions, AMCRequestBody, AMCHttpError, AMCHeaderRef, AMCHeader, AMCError, AMCConfig, AMCClientRef, AMCClient };
+export { wdOkAsync, wdOk, wdErrAsync, wdErr, userLookup, setupConsoleHandler, parseUser2 as parseUser, parseOdate, pageLookup, nullHandler, memberLookup, maskSensitiveData, logout, login, logger, isSuccessResponse, getLogger, fromPromise, consoleHandler, combineResults, amcResponseSchema, WikidotUser, WikidotStatusError, WikidotResultAsync, WikidotResult, WikidotError, UserType, UserIdentifier, UserData, UserCollection, UserAccessor, User, UnexpectedError, TargetExistsError, TargetError, SiteUnixName, SiteRef, SiteMemberData, SiteMember, SiteData, SiteChangeData, SiteChangeCollection, SiteChange, SiteApplicationData, SiteApplication, SiteAccessor, Site, SessionError, SessionCreateError, SearchPagesQueryParams, SearchPagesQuery, ResponseDataError, QuickModuleName, QuickModule, QMCUser, QMCPage, PrivateMessageSentBox, PrivateMessageInbox, PrivateMessageData, PrivateMessageCollection, PrivateMessageAccessor, PrivateMessage, PagesAccessor, PageVoteData, PageVoteCollection, PageVote, PageSourceData, PageSource, PageRevisionData, PageRevisionCollection, PageRevision, PageRef, PageMetaData, PageMetaCollection, PageMeta, PageFullname, PageFileData, PageFileCollection, PageFile, PageData, PageCollection, PageAccessor, Page, NotFoundException, NoElementError, MemberAccessor, LoginRequiredError, Logger, LogLevel, LogHandler, GuestUser, GetUserOptions, ForumThreadRef, ForumThreadData, ForumThreadCollection, ForumThread, ForumPostRevisionData, ForumPostRevisionCollection, ForumPostRevision, ForumPostRef, ForumPostData, ForumPostCollection, ForumPost, ForumCategoryRef, ForumCategoryData, ForumCategoryCollection, ForumCategory, ForumAccessor, ForbiddenError, DeletedUser, DateTimeString, DEFAULT_PER_PAGE, DEFAULT_MODULE_BODY, DEFAULT_AMC_CONFIG, ClientRef, ClientOptions, Client, AuthClientContext, AnonymousUser, AbstractUser, AMCSuccessResponse, AMCResponse, AMCRequestOptions, AMCRequestBody, AMCHttpError, AMCHeaderRef, AMCHeader, AMCError, AMCConfig, AMCClientRef, AMCClient };

package/dist/index.d.ts

@@ -467,6 +467,24 @@ interface ForumThreadRef {
 	readonly category?: ForumCategoryRef | null;
 }
 /**
+* Forum post reference interface
+* Used to avoid direct dependency on ForumPost type
+*/
+interface ForumPostRef {
+	/**
+	* Post ID
+	*/
+	readonly id: number;
+	/**
+	* Post title
+	*/
+	readonly title: string;
+	/**
+	* Thread reference
+	*/
+	readonly thread: ForumThreadRef;
+}
+/**
 * Page reference interface
 * Used to avoid direct dependency on Page type
 */
@@ -789,6 +807,86 @@ declare class PrivateMessageSentBox extends PrivateMessageCollection {
 }
 import { Element } from "domhandler";
 /**
+* Forum post revision data
+*/
+interface ForumPostRevisionData {
+	post: ForumPostRef;
+	id: number;
+	revNo: number;
+	createdBy: AbstractUser;
+	createdAt: Date;
+}
+/**
+* Forum post revision (version in edit history)
+*/
+declare class ForumPostRevision {
+	/** Post this revision belongs to */
+	readonly post: ForumPostRef;
+	/** Revision ID */
+	readonly id: number;
+	/** Revision number (0 = initial version) */
+	readonly revNo: number;
+	/** Revision creator */
+	readonly createdBy: AbstractUser;
+	/** Revision creation date */
+	readonly createdAt: Date;
+	/** HTML content (internal cache) */
+	private _html;
+	constructor(data: ForumPostRevisionData);
+	/**
+	* Whether HTML content has been acquired
+	*/
+	isHtmlAcquired(): boolean;
+	/**
+	* Get HTML content (cached)
+	*/
+	get html(): string | null;
+	/**
+	* Set HTML content
+	*/
+	set html(value: string | null);
+	/**
+	* Get revision HTML content
+	* @returns HTML string
+	*/
+	getHtml(): WikidotResultAsync<string>;
+	toString(): string;
+}
+/**
+* Forum post revision collection
+*/
+declare class ForumPostRevisionCollection extends Array<ForumPostRevision> {
+	readonly post: ForumPostRef;
+	constructor(post: ForumPostRef, revisions?: ForumPostRevision[]);
+	/**
+	* Find by ID
+	* @param id - Revision ID
+	* @returns Revision (undefined if not found)
+	*/
+	findById(id: number): ForumPostRevision | undefined;
+	/**
+	* Find by revision number
+	* @param revNo - Revision number
+	* @returns Revision (undefined if not found)
+	*/
+	findByRevNo(revNo: number): ForumPostRevision | undefined;
+	/**
+	* Get HTML for all revisions
+	* @returns Array of HTML strings
+	*/
+	getHtmls(): WikidotResultAsync<string[]>;
+	/**
+	* Parse revisions from HTML (internal method)
+	*/
+	private static _parse;
+	/**
+	* Get all revisions for a post
+	* @param post - Forum post reference
+	* @returns Revision collection
+	*/
+	static acquireAll(post: ForumPostRef): WikidotResultAsync<ForumPostRevisionCollection>;
+}
+/**
 * Forum post data
 */
 interface ForumPostData {
@@ -818,6 +916,7 @@ declare class ForumPost {
 	readonly editedAt: Date | null;
 	private _parentId;
 	private _source;
+	private _revisions;
 	constructor(data: ForumPostData);
 	/**
 	* Parent post ID
@@ -833,6 +932,15 @@ declare class ForumPost {
 	* @param title - New title (keeps current title if omitted)
 	*/
 	edit(source: string, title?: string): WikidotResultAsync<void>;
+	/**
+	* Whether the post has been edited (has revisions)
+	*/
+	get hasRevisions(): boolean;
+	/**
+	* Get post revisions (edit history)
+	* @returns Revision collection
+	*/
+	getRevisions(): WikidotResultAsync<ForumPostRevisionCollection>;
 	toString(): string;
 }
 /**
@@ -872,7 +980,7 @@ interface ForumThreadData {
 /**
 * Forum thread
 */
-declare class ForumThread2 {
+declare class ForumThread {
 	readonly site: Site;
 	readonly id: number;
 	readonly title: string;
@@ -894,23 +1002,23 @@ declare class ForumThread2 {
 	/**
 	* Reply to thread
 	*/
-	reply(source: string, title?: string, parentPostId?: number | null): WikidotResultAsync<ForumThread2>;
+	reply(source: string, title?: string, parentPostId?: number | null): WikidotResultAsync<ForumThread>;
 	toString(): string;
 	/**
 	* Get thread by ID
 	*/
-	static getFromId(site: Site, threadId: number, category?: ForumCategory | null): WikidotResultAsync<ForumThread2>;
+	static getFromId(site: Site, threadId: number, category?: ForumCategory | null): WikidotResultAsync<ForumThread>;
 }
 /**
 * Forum thread collection
 */
-declare class ForumThreadCollection extends Array<ForumThread2> {
+declare class ForumThreadCollection extends Array<ForumThread> {
 	readonly site: Site;
-	constructor(site: Site, threads?: ForumThread2[]);
+	constructor(site: Site, threads?: ForumThread[]);
 	/**
 	* Find by ID
 	*/
-	findById(id: number): ForumThread2 | undefined;
+	findById(id: number): ForumThread | undefined;
 	/**
 	* Get all threads in category
 	*/
@@ -920,7 +1028,7 @@ declare class ForumThreadCollection extends Array<ForumThread2> {
 	* @param site - Site instance
 	* @param threadId - Thread ID
 	*/
-	static fromId(site: Site, threadId: number): WikidotResultAsync<ForumThread2>;
+	static fromId(site: Site, threadId: number): WikidotResultAsync<ForumThread>;
 	/**
 	* Get threads by thread IDs
 	*/
@@ -960,7 +1068,7 @@ declare class ForumCategory {
 	/**
 	* Create thread
 	*/
-	createThread(title: string, description: string, source: string): WikidotResultAsync<ForumThread2>;
+	createThread(title: string, description: string, source: string): WikidotResultAsync<ForumThread>;
 	toString(): string;
 }
 /**
@@ -1648,7 +1756,7 @@ declare class Page {
 	/**
 	* Get the discussion thread for the page
 	*/
-	getDiscussion(): WikidotResultAsync<import("../forum").ForumThread | null>;
+	getDiscussion(): WikidotResultAsync<ForumThread | null>;
 	/**
 	* Get the list of meta tags for the page
 	* @returns Meta tag collection
@@ -1941,7 +2049,7 @@ declare class ForumAccessor {
 	* @param threadId - Thread ID
 	* @returns Thread
 	*/
-	getThread(threadId: number): WikidotResultAsync<ForumThread2>;
+	getThread(threadId: number): WikidotResultAsync<ForumThread>;
 	/**
 	* Get multiple threads
 	* @param threadIds - Array of thread IDs
@@ -2170,4 +2278,4 @@ declare function parseUser2(client: ClientRef, elem: cheerio2.Cheerio<AnyNode2>)
 * @returns Parsed Date, or null on parse failure
 */
 declare function parseOdate(elem: cheerio2.Cheerio<AnyNode2>): Date | null;
-export { wdOkAsync, wdOk, wdErrAsync, wdErr, userLookup, setupConsoleHandler, parseUser2 as parseUser, parseOdate, pageLookup, nullHandler, memberLookup, maskSensitiveData, logout, login, logger, isSuccessResponse, getLogger, fromPromise, consoleHandler, combineResults, amcResponseSchema, WikidotUser, WikidotStatusError, WikidotResultAsync, WikidotResult, WikidotError, UserType, UserIdentifier, UserData, UserCollection, UserAccessor, User, UnexpectedError, TargetExistsError, TargetError, SiteUnixName, SiteRef, SiteMemberData, SiteMember, SiteData, SiteChangeData, SiteChangeCollection, SiteChange, SiteApplicationData, SiteApplication, SiteAccessor, Site, SessionError, SessionCreateError, SearchPagesQueryParams, SearchPagesQuery, ResponseDataError, QuickModuleName, QuickModule, QMCUser, QMCPage, PrivateMessageSentBox, PrivateMessageInbox, PrivateMessageData, PrivateMessageCollection, PrivateMessageAccessor, PrivateMessage, PagesAccessor, PageVoteData, PageVoteCollection, PageVote, PageSourceData, PageSource, PageRevisionData, PageRevisionCollection, PageRevision, PageRef, PageMetaData, PageMetaCollection, PageMeta, PageFullname, PageFileData, PageFileCollection, PageFile, PageData, PageCollection, PageAccessor, Page, NotFoundException, NoElementError, MemberAccessor, LoginRequiredError, Logger, LogLevel, LogHandler, GuestUser, GetUserOptions, ForumThreadRef, ForumThreadData, ForumThreadCollection, ForumThread2 as ForumThread, ForumPostData, ForumPostCollection, ForumPost, ForumCategoryRef, ForumCategoryData, ForumCategoryCollection, ForumCategory, ForumAccessor, ForbiddenError, DeletedUser, DateTimeString, DEFAULT_PER_PAGE, DEFAULT_MODULE_BODY, DEFAULT_AMC_CONFIG, ClientRef, ClientOptions, Client, AuthClientContext, AnonymousUser, AbstractUser, AMCSuccessResponse, AMCResponse, AMCRequestOptions, AMCRequestBody, AMCHttpError, AMCHeaderRef, AMCHeader, AMCError, AMCConfig, AMCClientRef, AMCClient };
+export { wdOkAsync, wdOk, wdErrAsync, wdErr, userLookup, setupConsoleHandler, parseUser2 as parseUser, parseOdate, pageLookup, nullHandler, memberLookup, maskSensitiveData, logout, login, logger, isSuccessResponse, getLogger, fromPromise, consoleHandler, combineResults, amcResponseSchema, WikidotUser, WikidotStatusError, WikidotResultAsync, WikidotResult, WikidotError, UserType, UserIdentifier, UserData, UserCollection, UserAccessor, User, UnexpectedError, TargetExistsError, TargetError, SiteUnixName, SiteRef, SiteMemberData, SiteMember, SiteData, SiteChangeData, SiteChangeCollection, SiteChange, SiteApplicationData, SiteApplication, SiteAccessor, Site, SessionError, SessionCreateError, SearchPagesQueryParams, SearchPagesQuery, ResponseDataError, QuickModuleName, QuickModule, QMCUser, QMCPage, PrivateMessageSentBox, PrivateMessageInbox, PrivateMessageData, PrivateMessageCollection, PrivateMessageAccessor, PrivateMessage, PagesAccessor, PageVoteData, PageVoteCollection, PageVote, PageSourceData, PageSource, PageRevisionData, PageRevisionCollection, PageRevision, PageRef, PageMetaData, PageMetaCollection, PageMeta, PageFullname, PageFileData, PageFileCollection, PageFile, PageData, PageCollection, PageAccessor, Page, NotFoundException, NoElementError, MemberAccessor, LoginRequiredError, Logger, LogLevel, LogHandler, GuestUser, GetUserOptions, ForumThreadRef, ForumThreadData, ForumThreadCollection, ForumThread, ForumPostRevisionData, ForumPostRevisionCollection, ForumPostRevision, ForumPostRef, ForumPostData, ForumPostCollection, ForumPost, ForumCategoryRef, ForumCategoryData, ForumCategoryCollection, ForumCategory, ForumAccessor, ForbiddenError, DeletedUser, DateTimeString, DEFAULT_PER_PAGE, DEFAULT_MODULE_BODY, DEFAULT_AMC_CONFIG, ClientRef, ClientOptions, Client, AuthClientContext, AnonymousUser, AbstractUser, AMCSuccessResponse, AMCResponse, AMCRequestOptions, AMCRequestBody, AMCHttpError, AMCHeaderRef, AMCHeader, AMCError, AMCConfig, AMCClientRef, AMCClient };