@ukwhatn/wikidot 4.0.2 → 4.0.3

package/README.md

@@ -17,30 +17,40 @@ wikidot-tsは、Wikidot APIを操作するためのTypeScriptライブラリで
 ## インストール
 
 ```bash
-bun add wikidot-ts
+bun add @ukwhatn/wikidot
 ```
 
 または
 
 ```bash
-npm install wikidot-ts
+npm install @ukwhatn/wikidot
 ```
 
 ## 基本的な使い方
 
+このライブラリは`neverthrow`のResult型を使用します。すべての非同期メソッドは`WikidotResultAsync<T>`を返し、`isOk()`で成功を確認後、`.value`で値を取得します。
+
 ### クライアントの作成
 
 ```typescript
-import { Client } from 'wikidot-ts';
+import { Client } from '@ukwhatn/wikidot';
 
 // ログインなしでアクセス（公開情報のみ）
-const client = await Client.create();
+const clientResult = await Client.create();
+if (!clientResult.isOk()) {
+  throw new Error('クライアントの作成に失敗しました');
+}
+const client = clientResult.value;
 
 // ログインしてアクセス
-const authenticatedClient = await Client.create({
+const authClientResult = await Client.create({
   username: 'your_username',
   password: 'your_password',
 });
+if (!authClientResult.isOk()) {
+  throw new Error('ログインに失敗しました');
+}
+const authClient = authClientResult.value;
 ```
 
 ### サイトの取得
@@ -48,10 +58,11 @@ const authenticatedClient = await Client.create({
 ```typescript
 // サイトを取得
 const siteResult = await client.site.get('scp-jp');
-if (siteResult.isOk()) {
-  const site = siteResult.value;
-  console.log(`サイト: ${site.title}`);
+if (!siteResult.isOk()) {
+  throw new Error('サイトの取得に失敗しました');
 }
+const site = siteResult.value;
+console.log(`サイト: ${site.title}`);
 ```
 
 ### ページの操作
@@ -59,19 +70,21 @@ if (siteResult.isOk()) {
 ```typescript
 // ページを検索
 const pagesResult = await site.pages.search({ category: 'scp', tags: ['safe'] });
-if (pagesResult.isOk()) {
-  for (const page of pagesResult.value) {
-    console.log(`${page.fullname}: ${page.title}`);
-  }
+if (!pagesResult.isOk()) {
+  throw new Error('ページの検索に失敗しました');
+}
+for (const page of pagesResult.value) {
+  console.log(`${page.fullname}: ${page.title}`);
 }
 
 // 単一ページを取得
 const pageResult = await site.page.get('scp-001');
-if (pageResult.isOk()) {
-  const page = pageResult.value;
-  console.log(`タイトル: ${page.title}`);
-  console.log(`レーティング: ${page.rating}`);
+if (!pageResult.isOk()) {
+  throw new Error('ページの取得に失敗しました');
 }
+const page = pageResult.value;
+console.log(`タイトル: ${page.title}`);
+console.log(`レーティング: ${page.rating}`);
 ```
 
 ### フォーラムの操作
@@ -79,36 +92,39 @@ if (pageResult.isOk()) {
 ```typescript
 // フォーラムカテゴリを取得
 const categoriesResult = await site.forum.getCategories();
-if (categoriesResult.isOk()) {
-  for (const category of categoriesResult.value) {
-    console.log(`カテゴリ: ${category.title}`);
-  }
+if (!categoriesResult.isOk()) {
+  throw new Error('フォーラムカテゴリの取得に失敗しました');
+}
+for (const category of categoriesResult.value) {
+  console.log(`カテゴリ: ${category.title}`);
 }
 
 // スレッドに返信（要ログイン）
 const threadResult = await site.forum.getThread(12345);
-if (threadResult.isOk()) {
-  const thread = threadResult.value;
-  await thread.reply('返信内容', 'Re: タイトル');
+if (!threadResult.isOk()) {
+  throw new Error('スレッドの取得に失敗しました');
 }
+const thread = threadResult.value;
+await thread.reply('返信内容', 'Re: タイトル');
 ```
 
 ### プライベートメッセージ（要ログイン）
 
 ```typescript
 // 受信箱を取得
-const inboxResult = await client.pm.inbox();
-if (inboxResult.isOk()) {
-  for (const message of inboxResult.value) {
-    console.log(`From: ${message.sender.name}, Subject: ${message.subject}`);
-  }
+const inboxResult = await client.privateMessage.inbox();
+if (!inboxResult.isOk()) {
+  throw new Error('受信箱の取得に失敗しました');
+}
+for (const message of inboxResult.value) {
+  console.log(`From: ${message.sender.name}, Subject: ${message.subject}`);
 }
 
 // メッセージを送信
-await client.pm.send(recipientUser, '件名', '本文');
+await client.privateMessage.send(recipientUser, '件名', '本文');
 
 // メッセージを検索
-const searchResult = await client.pm.search('検索クエリ', 'all');
+const searchResult = await client.privateMessage.search('検索クエリ', 'all');
 ```
 
 ## エラーハンドリング