anixartjs 0.1.8 → 1.0.0

package/dist/api/article/article.d.ts

@@ -0,0 +1,422 @@
+import type { IRequestOptions } from "../../core/http/httpTypes";
+import { Anixart } from "../../core/anixartClient";
+import { ArticleCreateEditResult, ArticleDeleteResult, ArticleEditPinnedResult, ArticleMuteResult, EmbedType, IArticle, IArticleCreateEditRequest, IArticleEmbedResponse, IArticleEventRequest, IArticleResponse, IArticleUploadFileResponse, IPageableResponse, IProfile, IResponse, VoteType } from "../../models";
+export declare class Article {
+    private readonly _client;
+    constructor(_client: Anixart);
+    private generateTempFileName;
+    /**
+     * Получить статью по ID.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * Коды результата: {@link CommonResult}, {@link ArticleResult}.
+     *
+     * @param articleId - ID статьи.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Статья — {@link IArticleResponse}.
+     *
+     * @example
+     * import { Anixart } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const articleId = 123;
+     *
+     * const result = await client.endpoints.article.get(
+     *   articleId,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.article);
+     */
+    get(articleId: number, options?: IRequestOptions): Promise<IArticleResponse>;
+    /**
+     * Создать статью в канале.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * Коды результата: {@link CommonResult}, {@link ArticleCreateEditResult}.
+     *
+     * @param channelId - ID канала.
+     * @param data - Данные запроса — {@link IArticleCreateEditRequest}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Статья — {@link IArticleResponse} с кодами {@link ArticleCreateEditResult}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart } from "anixartjs";
+     * import type { IArticleCreateEditRequest } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const channelId = 123;
+     * const article: IArticleCreateEditRequest = {
+     *   is_signed: true,
+     *   repost_article_id: null,
+     *   payload: {
+     *     time: Date.now(),
+     *     version: "2.0.0",
+     *     blocks: [
+     *       {
+     *         id: "intro",
+     *         type: "paragraph",
+     *         name: "paragraph",
+     *         data: { text: "Привет!", text_length: 7 },
+     *       },
+     *     ],
+     *     block_count: 1,
+     *   },
+     * };
+     *
+     * const result = await client.endpoints.article.create(
+     *   channelId,
+     *   article,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result);
+     */
+    create(channelId: number, data: IArticleCreateEditRequest, options?: IRequestOptions): Promise<IArticleResponse<ArticleCreateEditResult>>;
+    /**
+     * Удалить статью.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * Коды результата: {@link CommonResult}, {@link ArticleDeleteResult}.
+     *
+     * @param articleId - ID статьи.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse} с кодами {@link ArticleDeleteResult}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const articleId = 123;
+     *
+     * const result = await client.endpoints.article.delete(
+     *   articleId,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    delete(articleId: number, options?: IRequestOptions): Promise<IResponse<ArticleDeleteResult>>;
+    /**
+     * Изменить содержимое статьи.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * Коды результата: {@link CommonResult}, {@link ArticleCreateEditResult}.
+     *
+     * @param articleId - ID статьи.
+     * @param data - Данные запроса — {@link IArticleCreateEditRequest}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Статья — {@link IArticleResponse} с кодами {@link ArticleCreateEditResult}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart } from "anixartjs";
+     * import type { IArticleCreateEditRequest } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const articleId = 123;
+     * const article: IArticleCreateEditRequest = {
+     *   is_signed: true,
+     *   repost_article_id: null,
+     *   payload: {
+     *     time: Date.now(),
+     *     version: "2.0.0",
+     *     blocks: [
+     *       {
+     *         id: "intro",
+     *         type: "paragraph",
+     *         name: "paragraph",
+     *         data: { text: "Привет!", text_length: 7 },
+     *       },
+     *     ],
+     *     block_count: 1,
+     *   },
+     * };
+     *
+     * const result = await client.endpoints.article.edit(
+     *   articleId,
+     *   article,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result);
+     */
+    edit(articleId: number, data: IArticleCreateEditRequest, options?: IRequestOptions): Promise<IArticleResponse<ArticleCreateEditResult>>;
+    /**
+     * Закрепить статью в канале или снять закрепление.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * Коды результата: {@link CommonResult}, {@link ArticleEditPinnedResult}.
+     *
+     * @param articleId - ID статьи.
+     * @param isPinned - Закрепить статью при true, снять закрепление при false.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse} с кодами {@link ArticleEditPinnedResult}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const articleId = 123;
+     * const isPinned = false;
+     *
+     * const result = await client.endpoints.article.editIsPinned(
+     *   articleId,
+     *   isPinned,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    editIsPinned(articleId: number, isPinned: boolean, options?: IRequestOptions): Promise<IResponse<ArticleEditPinnedResult>>;
+    /**
+     * Отправить событие просмотра, открытия или чтения статей.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param data - Данные запроса — {@link IArticleEventRequest}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse}.
+     *
+     * @example
+     * import { Anixart, ArticleEventType, ArticleEventEntryPoint } from "anixartjs";
+     * import type { IArticleEventRequest } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const event: IArticleEventRequest = {
+     *   type: ArticleEventType.View,
+     *   entry_point: ArticleEventEntryPoint.Unknown,
+     *   articles: [123],
+     * };
+     *
+     * const result = await client.endpoints.article.event(
+     *   event,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    event(data: IArticleEventRequest, options?: IRequestOptions): Promise<IResponse>;
+    /**
+     * Скрыть статью.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * Коды результата: {@link CommonResult}, {@link ArticleMuteResult}.
+     *
+     * @param articleId - ID статьи.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse} с кодами {@link ArticleMuteResult}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const articleId = 123;
+     *
+     * const result = await client.endpoints.article.mute(
+     *   articleId,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    mute(articleId: number, options?: IRequestOptions): Promise<IResponse<ArticleMuteResult>>;
+    /**
+     * Получить страницу репостов статьи.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param articleId - ID статьи.
+     * @param page - Номер страницы, начиная с 0. По умолчанию: 0.
+     * @param sort - Порядок сортировки.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Страница результатов — {@link IPageableResponse} с элементами {@link IArticle}.
+     *
+     * @example
+     * import { Anixart } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const articleId = 123;
+     * const page = 0;
+     * const sort = 0;
+     *
+     * const result = await client.endpoints.article.reposts(
+     *   articleId,
+     *   page,
+     *   sort,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.content);
+     */
+    reposts(articleId: number, page: number | undefined, sort: number, options?: IRequestOptions): Promise<IPageableResponse<IArticle>>;
+    /**
+     * Отменить скрытие статьи.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * Коды результата: {@link CommonResult}, {@link ArticleMuteResult}.
+     *
+     * @param articleId - ID статьи.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse} с кодами {@link ArticleMuteResult}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const articleId = 123;
+     *
+     * const result = await client.endpoints.article.unmute(
+     *   articleId,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    unmute(articleId: number, options?: IRequestOptions): Promise<IResponse<ArticleMuteResult>>;
+    /**
+     * Оценить статью.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param articleId - ID статьи.
+     * @param vote - Оценка комментария или статьи — {@link VoteType}.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Ответ API — {@link IResponse}.
+     *
+     * @remarks
+     
+     *
+     * @example
+     * import { Anixart, VoteType } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const articleId = 123;
+     * const vote = VoteType.Like;
+     *
+     * const result = await client.endpoints.article.vote(
+     *   articleId,
+     *   vote,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.code);
+     */
+    vote(articleId: number, vote: VoteType, options?: IRequestOptions): Promise<IResponse>;
+    /**
+     * Получить страницу профилей, оценивших статью.
+     *
+     * Токен клиента передаётся в query, если задан.
+     *
+     * @param articleId - ID статьи.
+     * @param page - Номер страницы, начиная с 0. По умолчанию: 0.
+     * @param sort - Порядок сортировки. По умолчанию: 0.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Страница результатов — {@link IPageableResponse} с элементами {@link IProfile}.
+     *
+     * @example
+     * import { Anixart } from "anixartjs";
+     *
+     * const client = new Anixart({ token: "YOUR_ANIXART_TOKEN" });
+     *
+     * const articleId = 123;
+     * const page = 0;
+     * const sort = 0;
+     *
+     * const result = await client.endpoints.article.votes(
+     *   articleId,
+     *   page,
+     *   sort,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result.content);
+     */
+    votes(articleId: number, page?: number, sort?: number, options?: IRequestOptions): Promise<IPageableResponse<IProfile>>;
+    /**
+     * Загрузить изображение для содержимого статьи.
+     *
+     * Авторизация: Bearer-токен редактора.
+     *
+     * @param mediaToken - Токен загрузки медиа, полученный через channel.editorAvaliable(). Это не токен аккаунта.
+     * @param file - Содержимое изображения в Buffer.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Результат загрузки и данные файла — {@link IArticleUploadFileResponse}.
+     *
+     * @remarks
+     * Используется отдельный media_upload_token редактора, а не токен аккаунта.
+     *
+     * @example
+     * import { readFile } from "node:fs/promises";
+     * import { Anixart } from "anixartjs";
+     *
+     * const client = new Anixart({});
+     *
+     * const mediaToken = "MEDIA_UPLOAD_TOKEN";
+     * const file = await readFile("./cover.jpg");
+     *
+     * const result = await client.endpoints.article.uploadArticleImage(
+     *   mediaToken,
+     *   file,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result);
+     */
+    uploadArticleImage(mediaToken: string, file: Buffer, options?: IRequestOptions): Promise<IArticleUploadFileResponse>;
+    /**
+     * Получить данные для вставки внешней ссылки в статью.
+     *
+     * Авторизация: Bearer-токен редактора.
+     *
+     * @param type - Тип вставки: youtube, vk или link.
+     * @param mediaToken - Токен загрузки медиа, полученный через channel.editorAvaliable(). Это не токен аккаунта.
+     * @param link - URL внешнего ресурса для вставки в статью.
+     * @param options - Параметры запроса: таймаут, сигнал отмены, версия API и обработка ошибок.
+     * @returns Данные для встраивания внешнего ресурса — {@link IArticleEmbedResponse}.
+     *
+     * @remarks
+     * Используется отдельный media_upload_token редактора, а не токен аккаунта.
+     *
+     * @example
+     * import { Anixart } from "anixartjs";
+     *
+     * const client = new Anixart({});
+     *
+     * const type = "link";
+     * const mediaToken = "MEDIA_UPLOAD_TOKEN";
+     * const link = "https://example.com/article";
+     *
+     * const result = await client.endpoints.article.generateEmbedData(
+     *   type,
+     *   mediaToken,
+     *   link,
+     *   { timeoutMs: 15_000 },
+     * );
+     * console.log(result);
+     */
+    generateEmbedData(type: EmbedType, mediaToken: string, link: string, options?: IRequestOptions): Promise<IArticleEmbedResponse>;
+}
+//# sourceMappingURL=article.d.ts.map

package/dist/api/article/article.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"article.d.ts","sourceRoot":"","sources":["../../../src/api/article/article.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,EACL,uBAAuB,EACvB,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EAEjB,SAAS,EACT,QAAQ,EACR,yBAAyB,EACzB,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EAChB,0BAA0B,EAC1B,iBAAiB,EACjB,QAAQ,EACR,SAAS,EACT,QAAQ,EACT,MAAM,cAAc,CAAC;AAEtB,qBAAa,OAAO;IACC,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,OAAO;IAEpD,OAAO,CAAC,oBAAoB;IAS5B;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,GAAG,CACd,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,gBAAgB,CAAC;IAY5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACU,MAAM,CACjB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IAkBrD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,MAAM,CACjB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAY1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACU,IAAI,CACf,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,yBAAyB,EAC/B,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IAkBrD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACU,YAAY,CACvB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,OAAO,EACjB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;IAe9C;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,KAAK,CAChB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,SAAS,CAAC;IAerB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,IAAI,CACf,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAYxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,OAAO,CAClB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,YAAI,EAChB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAcvC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACU,MAAM,CACjB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAYxC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,IAAI,CACf,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,QAAQ,EACd,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,SAAS,CAAC;IAWrB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACU,KAAK,CAChB,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,MAAU,EAChB,IAAI,GAAE,MAAU,EAChB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAcvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACU,kBAAkB,CAC7B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,0BAA0B,CAAC;IAuBtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACU,iBAAiB,CAC5B,IAAI,EAAE,SAAS,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,qBAAqB,CAAC;CAqBlC"}