mixi2-js 1.2.1 → 1.3.0

package/dist/helpers/index.d.cts

@@ -1,5 +1,6 @@
-import { E as EventHandler, h as EventType, f as Event, c as Client, I as InitiatePostMediaUploadRequest, v as PostMask, D as PostPublishingType, e as CreatePostRequest, g as EventReason } from '../client-iXbbRxc-.cjs';
+import { L as PostPublishingType, d as EventReason, f as EventType, h as InitiatePostMediaUploadRequest, j as PostMask, l as CreatePostRequest, o as EventHandler, t as Client, u as Event } from "../client-C90Zd_yq.cjs";
 
+//#region src/helpers/address.d.ts
 /**
  * アクセストークン取得用のエンドポイント URL です。
  */
@@ -12,40 +13,91 @@ declare const apiAddress: string;
  * gRPC ストリーミング接続用のサーバーアドレスです。
  */
 declare const streamAddress: string;
-
+//#endregion
+//#region src/helpers/event-deduplicator.d.ts
+interface EventDeduplicatorOptions {
+  /** 記憶する最大イベント数。デフォルト: 1000 */
+  maxSize?: number;
+  /** イベント ID を記憶する最大時間（ミリ秒）。デフォルト: 300000 (5 分) */
+  maxAge?: number;
+}
+/**
+ * 重複したイベントを検出してスキップするミドルウェア。
+ * Webhook 方式のリトライなどで同じイベントが複数回届いた場合に、
+ * 内部ハンドラへの二重処理を防ぐ。
+ *
+ * @example
+ * const dedup = new EventDeduplicator(innerHandler);
+ * const server = new WebhookServer({ handler: dedup, ... });
+ */
+declare class EventDeduplicator implements EventHandler {
+  private readonly inner;
+  private readonly maxSize;
+  private readonly maxAge;
+  private readonly seen;
+  constructor(handler: EventHandler, options?: EventDeduplicatorOptions);
+  handle(event: Event): Promise<void>;
+  private evict;
+}
+//#endregion
+//#region src/helpers/event-logger.d.ts
+interface EventLoggerOptions {
+  /** ログ出力関数。デフォルト: console.log */
+  logger?: (message: string) => void;
+  /** イベントの詳細（eventId・eventType）をログに含めるか。デフォルト: true */
+  verbose?: boolean;
+}
+/**
+ * 受信したイベントをログ出力するデバッグ用ミドルウェア。
+ * 内部ハンドラへの処理はそのまま委譲する。
+ *
+ * @example
+ * const logger = new EventLogger(router);
+ * await watcher.watch(logger);
+ */
+declare class EventLogger implements EventHandler {
+  private readonly inner;
+  private readonly logger;
+  private readonly verbose;
+  constructor(handler: EventHandler, options?: EventLoggerOptions);
+  handle(event: Event): Promise<void>;
+}
+//#endregion
+//#region src/helpers/event-router.d.ts
 type EventListener = (event: Event) => void | Promise<void>;
 /**
  * イベントタイプ別にハンドラを登録できる EventHandler 実装。
  * StreamWatcher.watch() や WebhookServer に直接渡して使用できる。
  */
 declare class EventRouter implements EventHandler {
-    private readonly listeners;
-    /**
-     * 指定したイベントタイプのハンドラを登録する。
-     * 同じイベントタイプに複数のハンドラを登録可能（登録順に実行）。
-     */
-    on(eventType: EventType, listener: EventListener): this;
-    /**
-     * 指定したイベントタイプのハンドラを削除する。
-     * listener を省略した場合、そのイベントタイプのすべてのハンドラを削除する。
-     */
-    off(eventType: EventType, listener?: EventListener): this;
-    /**
-     * EventHandler.handle() の実装。
-     * 登録されたリスナーに対してイベントをルーティングする。
-     */
-    handle(event: Event): Promise<void>;
+  private readonly listeners;
+  /**
+   * 指定したイベントタイプのハンドラを登録する。
+   * 同じイベントタイプに複数のハンドラを登録可能（登録順に実行）。
+   */
+  on(eventType: EventType, listener: EventListener): this;
+  /**
+   * 指定したイベントタイプのハンドラを削除する。
+   * listener を省略した場合、そのイベントタイプのすべてのハンドラを削除する。
+   */
+  off(eventType: EventType, listener?: EventListener): this;
+  /**
+   * EventHandler.handle() の実装。
+   * 登録されたリスナーに対してイベントをルーティングする。
+   */
+  handle(event: Event): Promise<void>;
 }
-
+//#endregion
+//#region src/helpers/media-uploader.d.ts
 interface MediaUploaderOptions {
-    /** ポーリング間隔（ミリ秒）。デフォルト: 1000 */
-    pollInterval?: number;
-    /** タイムアウト（ミリ秒）。デフォルト: 60000 */
-    timeout?: number;
+  /** ポーリング間隔（ミリ秒）。デフォルト: 1000 */
+  pollInterval?: number;
+  /** タイムアウト（ミリ秒）。デフォルト: 60000 */
+  timeout?: number;
 }
 interface UploadedMedia {
-    mediaId: string;
-    uploadUrl: string;
+  mediaId: string;
+  uploadUrl: string;
 }
 /**
  * メディアアップロードの開始 → データ送信 → 処理完了待機を簡略化するヘルパー。
@@ -54,21 +106,22 @@ interface UploadedMedia {
  * このクラスで waitForReady() を呼ぶだけで完了まで待機できる。
  */
 declare class MediaUploader {
-    private readonly client;
-    private readonly pollInterval;
-    private readonly timeout;
-    constructor(client: Client, options?: MediaUploaderOptions);
-    /**
-     * メディアアップロードを開始し、uploadUrl と mediaId を返す。
-     */
-    initiate(request: InitiatePostMediaUploadRequest): Promise<UploadedMedia>;
-    /**
-     * メディアの処理が完了するまでポーリングして待機する。
-     * 完了時に mediaId を返す。失敗時はエラーをスローする。
-     */
-    waitForReady(mediaId: string): Promise<string>;
+  private readonly client;
+  private readonly pollInterval;
+  private readonly timeout;
+  constructor(client: Client, options?: MediaUploaderOptions);
+  /**
+   * メディアアップロードを開始し、uploadUrl と mediaId を返す。
+   */
+  initiate(request: InitiatePostMediaUploadRequest): Promise<UploadedMedia>;
+  /**
+   * メディアの処理が完了するまでポーリングして待機する。
+   * 完了時に mediaId を返す。失敗時はエラーをスローする。
+   */
+  waitForReady(mediaId: string): Promise<string>;
 }
-
+//#endregion
+//#region src/helpers/post-builder.d.ts
 /**
  * ポスト作成リクエストをメソッドチェーンで組み立てるビルダー。
  *
@@ -80,26 +133,27 @@ declare class MediaUploader {
  *   .build();
  */
 declare class PostBuilder {
-    private readonly request;
-    constructor(text: string);
-    /** 返信先ポスト ID を設定する。 */
-    reply(postId: string): this;
-    /** 引用対象ポスト ID を設定する。 */
-    quote(postId: string): this;
-    /** 添付メディア ID を設定する（最大 4 件）。 */
-    media(mediaIdList: string[]): this;
-    /** センシティブマスクを設定する。 */
-    sensitive(caption?: string): this;
-    /** ネタバレマスクを設定する。 */
-    spoiler(caption?: string): this;
-    /** カスタムマスクを設定する。 */
-    mask(postMask: PostMask): this;
-    /** 配信設定を設定する。 */
-    publishing(type: PostPublishingType): this;
-    /** CreatePostRequest オブジェクトを構築する。 */
-    build(): CreatePostRequest;
+  private readonly request;
+  constructor(text: string);
+  /** 返信先ポスト ID を設定する。 */
+  reply(postId: string): this;
+  /** 引用対象ポスト ID を設定する。 */
+  quote(postId: string): this;
+  /** 添付メディア ID を設定する（最大 4 件）。 */
+  media(mediaIdList: string[]): this;
+  /** センシティブマスクを設定する。 */
+  sensitive(caption?: string): this;
+  /** ネタバレマスクを設定する。 */
+  spoiler(caption?: string): this;
+  /** カスタムマスクを設定する。 */
+  mask(postMask: PostMask): this;
+  /** 配信設定を設定する。 */
+  publishing(type: PostPublishingType): this;
+  /** CreatePostRequest オブジェクトを構築する。 */
+  build(): CreatePostRequest;
 }
-
+//#endregion
+//#region src/helpers/reason-filter.d.ts
 /**
  * EventReason に基づいてイベントをフィルタリングするミドルウェア。
  * 指定した理由に一致するイベントのみを内部のハンドラに渡す。
@@ -112,11 +166,42 @@ declare class PostBuilder {
  * await watcher.watch(filter);
  */
 declare class ReasonFilter implements EventHandler {
-    private readonly inner;
-    private readonly allowedReasons;
-    constructor(handler: EventHandler, reasons: EventReason[]);
-    handle(event: Event): Promise<void>;
-    private getReasons;
+  private readonly inner;
+  private readonly allowedReasons;
+  constructor(handler: EventHandler, reasons: EventReason[]);
+  handle(event: Event): Promise<void>;
+  private getReasons;
 }
-
-export { EventRouter, MediaUploader, type MediaUploaderOptions, PostBuilder, ReasonFilter, type UploadedMedia, apiAddress, streamAddress, tokenUrl };
+//#endregion
+//#region src/helpers/text-splitter.d.ts
+/** mixi2 の 1 ポストあたりの最大文字数 */
+declare const maxPostLength = 149;
+interface TextSplitterOptions {
+  /** 1 ポストあたりの最大文字数。デフォルト: 149 */
+  maxLength?: number;
+  /** 単語境界（スペース・句読点）で分割を試みるか。デフォルト: true */
+  splitOnWord?: boolean;
+}
+/**
+ * 長いテキストを mixi2 の文字数制限内に収まる複数チャンクに分割するヘルパー。
+ * デフォルトは 149 文字制限（mixi2 のポスト本文上限）に準拠。
+ *
+ * @example
+ * const splitter = new TextSplitter();
+ * const chunks = splitter.split('長いテキスト...');
+ * for (const chunk of chunks) {
+ *   await client.createPost({ text: chunk });
+ * }
+ */
+declare class TextSplitter {
+  private readonly maxLength;
+  private readonly splitOnWord;
+  constructor(options?: TextSplitterOptions);
+  /**
+   * テキストを maxLength 以内の複数チャンクに分割して返す。
+   * テキストが maxLength 以内の場合は 1 要素の配列を返す。
+   */
+  split(text: string): string[];
+}
+//#endregion
+export { EventDeduplicator, type EventDeduplicatorOptions, EventLogger, type EventLoggerOptions, EventRouter, MediaUploader, type MediaUploaderOptions, PostBuilder, ReasonFilter, TextSplitter, type TextSplitterOptions, type UploadedMedia, apiAddress, maxPostLength, streamAddress, tokenUrl };

package/dist/helpers/index.d.mts

@@ -0,0 +1,207 @@
+import { L as PostPublishingType, d as EventReason, f as EventType, h as InitiatePostMediaUploadRequest, j as PostMask, l as CreatePostRequest, o as EventHandler, t as Client, u as Event } from "../client-DPeVTCYr.mjs";
+
+//#region src/helpers/address.d.ts
+/**
+ * アクセストークン取得用のエンドポイント URL です。
+ */
+declare const tokenUrl: string;
+/**
+ * API サーバーアドレスです。
+ */
+declare const apiAddress: string;
+/**
+ * gRPC ストリーミング接続用のサーバーアドレスです。
+ */
+declare const streamAddress: string;
+//#endregion
+//#region src/helpers/event-deduplicator.d.ts
+interface EventDeduplicatorOptions {
+  /** 記憶する最大イベント数。デフォルト: 1000 */
+  maxSize?: number;
+  /** イベント ID を記憶する最大時間（ミリ秒）。デフォルト: 300000 (5 分) */
+  maxAge?: number;
+}
+/**
+ * 重複したイベントを検出してスキップするミドルウェア。
+ * Webhook 方式のリトライなどで同じイベントが複数回届いた場合に、
+ * 内部ハンドラへの二重処理を防ぐ。
+ *
+ * @example
+ * const dedup = new EventDeduplicator(innerHandler);
+ * const server = new WebhookServer({ handler: dedup, ... });
+ */
+declare class EventDeduplicator implements EventHandler {
+  private readonly inner;
+  private readonly maxSize;
+  private readonly maxAge;
+  private readonly seen;
+  constructor(handler: EventHandler, options?: EventDeduplicatorOptions);
+  handle(event: Event): Promise<void>;
+  private evict;
+}
+//#endregion
+//#region src/helpers/event-logger.d.ts
+interface EventLoggerOptions {
+  /** ログ出力関数。デフォルト: console.log */
+  logger?: (message: string) => void;
+  /** イベントの詳細（eventId・eventType）をログに含めるか。デフォルト: true */
+  verbose?: boolean;
+}
+/**
+ * 受信したイベントをログ出力するデバッグ用ミドルウェア。
+ * 内部ハンドラへの処理はそのまま委譲する。
+ *
+ * @example
+ * const logger = new EventLogger(router);
+ * await watcher.watch(logger);
+ */
+declare class EventLogger implements EventHandler {
+  private readonly inner;
+  private readonly logger;
+  private readonly verbose;
+  constructor(handler: EventHandler, options?: EventLoggerOptions);
+  handle(event: Event): Promise<void>;
+}
+//#endregion
+//#region src/helpers/event-router.d.ts
+type EventListener = (event: Event) => void | Promise<void>;
+/**
+ * イベントタイプ別にハンドラを登録できる EventHandler 実装。
+ * StreamWatcher.watch() や WebhookServer に直接渡して使用できる。
+ */
+declare class EventRouter implements EventHandler {
+  private readonly listeners;
+  /**
+   * 指定したイベントタイプのハンドラを登録する。
+   * 同じイベントタイプに複数のハンドラを登録可能（登録順に実行）。
+   */
+  on(eventType: EventType, listener: EventListener): this;
+  /**
+   * 指定したイベントタイプのハンドラを削除する。
+   * listener を省略した場合、そのイベントタイプのすべてのハンドラを削除する。
+   */
+  off(eventType: EventType, listener?: EventListener): this;
+  /**
+   * EventHandler.handle() の実装。
+   * 登録されたリスナーに対してイベントをルーティングする。
+   */
+  handle(event: Event): Promise<void>;
+}
+//#endregion
+//#region src/helpers/media-uploader.d.ts
+interface MediaUploaderOptions {
+  /** ポーリング間隔（ミリ秒）。デフォルト: 1000 */
+  pollInterval?: number;
+  /** タイムアウト（ミリ秒）。デフォルト: 60000 */
+  timeout?: number;
+}
+interface UploadedMedia {
+  mediaId: string;
+  uploadUrl: string;
+}
+/**
+ * メディアアップロードの開始 → データ送信 → 処理完了待機を簡略化するヘルパー。
+ *
+ * 通常は initiatePostMediaUpload → HTTP POST → getPostMediaStatus のポーリングが必要だが、
+ * このクラスで waitForReady() を呼ぶだけで完了まで待機できる。
+ */
+declare class MediaUploader {
+  private readonly client;
+  private readonly pollInterval;
+  private readonly timeout;
+  constructor(client: Client, options?: MediaUploaderOptions);
+  /**
+   * メディアアップロードを開始し、uploadUrl と mediaId を返す。
+   */
+  initiate(request: InitiatePostMediaUploadRequest): Promise<UploadedMedia>;
+  /**
+   * メディアの処理が完了するまでポーリングして待機する。
+   * 完了時に mediaId を返す。失敗時はエラーをスローする。
+   */
+  waitForReady(mediaId: string): Promise<string>;
+}
+//#endregion
+//#region src/helpers/post-builder.d.ts
+/**
+ * ポスト作成リクエストをメソッドチェーンで組み立てるビルダー。
+ *
+ * @example
+ * const request = new PostBuilder('Hello mixi2!')
+ *   .reply('post-id')
+ *   .media(['media-id-1'])
+ *   .sensitive()
+ *   .build();
+ */
+declare class PostBuilder {
+  private readonly request;
+  constructor(text: string);
+  /** 返信先ポスト ID を設定する。 */
+  reply(postId: string): this;
+  /** 引用対象ポスト ID を設定する。 */
+  quote(postId: string): this;
+  /** 添付メディア ID を設定する（最大 4 件）。 */
+  media(mediaIdList: string[]): this;
+  /** センシティブマスクを設定する。 */
+  sensitive(caption?: string): this;
+  /** ネタバレマスクを設定する。 */
+  spoiler(caption?: string): this;
+  /** カスタムマスクを設定する。 */
+  mask(postMask: PostMask): this;
+  /** 配信設定を設定する。 */
+  publishing(type: PostPublishingType): this;
+  /** CreatePostRequest オブジェクトを構築する。 */
+  build(): CreatePostRequest;
+}
+//#endregion
+//#region src/helpers/reason-filter.d.ts
+/**
+ * EventReason に基づいてイベントをフィルタリングするミドルウェア。
+ * 指定した理由に一致するイベントのみを内部のハンドラに渡す。
+ *
+ * @example
+ * const filter = new ReasonFilter(innerHandler, [
+ *   EventReason.POST_REPLY,
+ *   EventReason.POST_MENTIONED,
+ * ]);
+ * await watcher.watch(filter);
+ */
+declare class ReasonFilter implements EventHandler {
+  private readonly inner;
+  private readonly allowedReasons;
+  constructor(handler: EventHandler, reasons: EventReason[]);
+  handle(event: Event): Promise<void>;
+  private getReasons;
+}
+//#endregion
+//#region src/helpers/text-splitter.d.ts
+/** mixi2 の 1 ポストあたりの最大文字数 */
+declare const maxPostLength = 149;
+interface TextSplitterOptions {
+  /** 1 ポストあたりの最大文字数。デフォルト: 149 */
+  maxLength?: number;
+  /** 単語境界（スペース・句読点）で分割を試みるか。デフォルト: true */
+  splitOnWord?: boolean;
+}
+/**
+ * 長いテキストを mixi2 の文字数制限内に収まる複数チャンクに分割するヘルパー。
+ * デフォルトは 149 文字制限（mixi2 のポスト本文上限）に準拠。
+ *
+ * @example
+ * const splitter = new TextSplitter();
+ * const chunks = splitter.split('長いテキスト...');
+ * for (const chunk of chunks) {
+ *   await client.createPost({ text: chunk });
+ * }
+ */
+declare class TextSplitter {
+  private readonly maxLength;
+  private readonly splitOnWord;
+  constructor(options?: TextSplitterOptions);
+  /**
+   * テキストを maxLength 以内の複数チャンクに分割して返す。
+   * テキストが maxLength 以内の場合は 1 要素の配列を返す。
+   */
+  split(text: string): string[];
+}
+//#endregion
+export { EventDeduplicator, type EventDeduplicatorOptions, EventLogger, type EventLoggerOptions, EventRouter, MediaUploader, type MediaUploaderOptions, PostBuilder, ReasonFilter, TextSplitter, type TextSplitterOptions, type UploadedMedia, apiAddress, maxPostLength, streamAddress, tokenUrl };