firebase-rest-firestore 0.3.0 → 0.3.1

package/README.ja.md

@@ -218,6 +218,77 @@ export default {
 };
 ```
 
+## クイックスタート
+
+```typescript
+import { createFirestoreClient } from "firebase-rest-firestore";
+
+// 設定オブジェクトでクライアントを初期化
+const firestore = createFirestoreClient({
+  projectId: "your-project-id",
+  privateKey: "your-private-key",
+  clientEmail: "your-client-email",
+});
+
+// ドキュメントの追加
+const newDoc = await firestore.add("collection", {
+  name: "テストドキュメント",
+  value: 100,
+});
+
+// ドキュメントの取得
+const doc = await firestore.get("collection", newDoc.id);
+
+// ドキュメントの更新
+await firestore.update("collection", newDoc.id, { value: 200 });
+
+// ドキュメントのクエリ
+const querySnapshot = await firestore
+  .collection("games")
+  .where("score", ">", 50)
+  .where("active", "==", true)
+  .orderBy("score", "desc")
+  .limit(10)
+  .get();
+
+const games = [];
+querySnapshot.forEach(doc => {
+  games.push({
+    id: doc.id,
+    ...doc.data(),
+  });
+});
+console.log("Games with score > 50:", games);
+
+// ドキュメントの削除
+await firestore.delete("collection", newDoc.id);
+```
+
+## 設定
+
+Firestore の権限を持つ Firebase サービスアカウントが必要です：
+
+```typescript
+createFirestoreClient({
+  projectId: "your-project-id",
+  privateKey: "your-private-key", // エスケープされた改行(\\n)を含む場合、自動的にフォーマットされます
+  clientEmail: "your-client-email",
+});
+```
+
+## API リファレンス
+
+### add(collectionName, data)
+
+コレクションに新しいドキュメントを追加します。
+
+パラメータ:
+
+- `collectionName`: コレクション名
+- `data`: 追加するドキュメントデータ
+
+戻り値: 自動生成された ID を持つ追加されたドキュメント。
+
 ## ライセンス
 
 MIT

package/README.md

@@ -19,7 +19,7 @@ Firebase Firestore REST API client for Edge runtime environments like Cloudflare
 npm install firebase-rest-firestore
 ```
 
-## Usage
+## Quick Start
 
 ```typescript
 import { createFirestoreClient } from "firebase-rest-firestore";
@@ -31,33 +31,17 @@ const firestore = createFirestoreClient({
   clientEmail: "your-client-email",
 });
 
-// Create a document with auto-generated ID
-const gameRef = firestore.collection("games").doc();
-await gameRef.set({
-  name: "New Game",
-  createdAt: new Date(),
-  score: 100,
-  active: true,
-});
-console.log("Created game ID:", gameRef.id);
-
-// Create a document with specific ID
-await firestore.collection("games").doc("game123").set({
-  name: "Specific Game",
-  createdAt: new Date(),
+// Add a document
+const newDoc = await firestore.add("collection", {
+  name: "Test Document",
+  value: 100,
 });
 
 // Get a document
-const gameDoc = await firestore.doc("games/game123").get();
-if (gameDoc.exists) {
-  console.log("Fetched game:", gameDoc.data());
-}
+const doc = await firestore.get("collection", newDoc.id);
 
 // Update a document
-await firestore.collection("games").doc("game123").update({
-  name: "Updated Game Name",
-  updatedAt: new Date(),
-});
+await firestore.update("collection", newDoc.id, { value: 200 });
 
 // Query documents
 const querySnapshot = await firestore
@@ -79,19 +63,7 @@ querySnapshot.forEach(doc => {
 console.log("Games with score > 50:", games);
 
 // Delete a document
-await firestore.collection("games").doc("game123").delete();
-
-// Working with subcollections
-const commentRef = firestore
-  .collection("games")
-  .doc("game123")
-  .collection("comments")
-  .doc();
-
-await commentRef.set({
-  text: "Great game!",
-  createdAt: new Date(),
-});
+await firestore.delete("collection", newDoc.id);
 ```
 
 ## Configuration
@@ -151,9 +123,16 @@ Queries documents in a collection with filtering, ordering, and pagination.
 
 Creates a new FirestoreClient instance with the provided configuration.
 
-### loadConfigFromEnv()
+#### add(collectionName, data)
+
+Adds a new document to the specified collection.
+
+Parameters:
+
+- `collectionName`: Name of the collection
+- `data`: Document data to be added
 
-Helper function to load configuration from environment variables.
+Returns: The added document with auto-generated ID.
 
 ## Error Handling
 

package/dist/client.d.ts

@@ -34,12 +34,12 @@ export declare class FirestoreClient {
      */
     doc(path: string): DocumentReference;
     /**
-     * Firestoreにドキュメントを作成
+     * Firestoreにドキュメントを追加
      * @param collectionName コレクション名
-     * @param data 作成するデータ
-     * @returns 作成されたドキュメント
+     * @param data 追加するデータ
+     * @returns 追加されたドキュメント
      */
-    create(collectionName: string, data: Record<string, any>): Promise<Record<string, any> & {
+    add(collectionName: string, data: Record<string, any>): Promise<Record<string, any> & {
         id: string;
     }>;
     /**

package/dist/client.js

@@ -82,12 +82,12 @@ class FirestoreClient {
         return new DocumentReference(this, collectionPath, docId);
     }
     /**
-     * Firestoreにドキュメントを作成
+     * Firestoreにドキュメントを追加
      * @param collectionName コレクション名
-     * @param data 作成するデータ
-     * @returns 作成されたドキュメント
+     * @param data 追加するデータ
+     * @returns 追加されたドキュメント
      */
-    async create(collectionName, data) {
+    async add(collectionName, data) {
         // 操作前に設定をチェック
         this.checkConfig();
         const url = (0, path_1.getFirestoreBasePath)(this.config.projectId, collectionName);
@@ -246,11 +246,10 @@ class FirestoreClient {
             structuredQuery.offset = options.offset;
         }
         const token = await this.getToken();
-        // リクエストボディ
+        // 修正: structuredQueryをラップしたリクエストボディを作成
         const requestBody = {
             structuredQuery: structuredQuery,
         };
-        console.log("クエリURL:", url);
         console.log("クエリリクエスト:", JSON.stringify(requestBody, null, 2));
         try {
             const response = await fetch(url, {
@@ -307,7 +306,7 @@ class CollectionReference {
      * @returns 作成されたドキュメントのリファレンス
      */
     async add(data) {
-        const result = await this.client.create(this.path, data);
+        const result = await this.client.add(this.path, data);
         const docId = result.id;
         return new DocumentReference(this.client, this.path, docId);
     }
@@ -481,7 +480,7 @@ class DocumentReference {
         else {
             // 新規作成
             const newData = { ...data, id: this.docId };
-            await this.client.create(this.collectionPath, newData);
+            await this.client.add(this.collectionPath, newData);
         }
         return new WriteResult();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-rest-firestore",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Firebase Firestore REST API client for Edge runtime environments",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",