firebase-rest-firestore 0.1.0 → 0.2.0

package/dist/client.d.ts

@@ -15,6 +15,18 @@ export declare class FirestoreClient {
      * 認証トークンを取得（キャッシュあり）
      */
     private getToken;
+    /**
+     * コレクションリファレンスを取得
+     * @param path コレクションパス
+     * @returns CollectionReferenceインスタンス
+     */
+    collection(path: string): CollectionReference;
+    /**
+     * ドキュメントリファレンスを取得
+     * @param path ドキュメントパス
+     * @returns DocumentReferenceインスタンス
+     */
+    doc(path: string): DocumentReference;
     /**
      * Firestoreにドキュメントを作成
      * @param collectionName コレクション名
@@ -60,6 +72,228 @@ export declare class FirestoreClient {
         id: string;
     })[]>;
 }
+/**
+ * コレクションリファレンスクラス
+ */
+export declare class CollectionReference {
+    private client;
+    private path;
+    private _queryConstraints;
+    constructor(client: FirestoreClient, path: string);
+    /**
+     * ドキュメントリファレンスを取得
+     * @param documentPath ドキュメントID（省略時は自動生成）
+     * @returns DocumentReferenceインスタンス
+     */
+    doc(documentPath?: string): DocumentReference;
+    /**
+     * ドキュメントを追加（IDは自動生成）
+     * @param data ドキュメントデータ
+     * @returns 作成されたドキュメントのリファレンス
+     */
+    add(data: Record<string, any>): Promise<DocumentReference>;
+    /**
+     * フィルター条件を追加
+     * @param fieldPath フィールドパス
+     * @param opStr 演算子
+     * @param value 値
+     * @returns Queryインスタンス
+     */
+    where(fieldPath: string, opStr: string, value: any): Query;
+    /**
+     * 並べ替え条件を追加
+     * @param fieldPath フィールドパス
+     * @param directionStr 並べ替え方向（'asc'または'desc'）
+     * @returns Queryインスタンス
+     */
+    orderBy(fieldPath: string, directionStr?: "asc" | "desc"): Query;
+    /**
+     * 取得件数の制限を設定
+     * @param limit 最大件数
+     * @returns Queryインスタンス
+     */
+    limit(limit: number): Query;
+    /**
+     * スキップ件数を設定
+     * @param offset スキップ件数
+     * @returns Queryインスタンス
+     */
+    offset(offset: number): Query;
+    /**
+     * クエリを実行
+     * @returns QuerySnapshotインスタンス
+     */
+    get(): Promise<QuerySnapshot>;
+    /**
+     * ランダムなIDを生成
+     * @returns ランダムなID
+     */
+    private _generateId;
+}
+/**
+ * ドキュメントリファレンスクラス
+ */
+export declare class DocumentReference {
+    private client;
+    private collectionPath;
+    private docId;
+    constructor(client: FirestoreClient, collectionPath: string, docId: string);
+    /**
+     * ドキュメントIDを取得
+     */
+    get id(): string;
+    /**
+     * ドキュメントのパスを取得
+     */
+    get path(): string;
+    /**
+     * サブコレクションを取得
+     * @param collectionPath サブコレクション名
+     * @returns CollectionReferenceインスタンス
+     */
+    collection(collectionPath: string): CollectionReference;
+    /**
+     * ドキュメントを取得
+     * @returns DocumentSnapshotインスタンス
+     */
+    get(): Promise<DocumentSnapshot>;
+    /**
+     * ドキュメントを作成または上書き
+     * @param data ドキュメントデータ
+     * @param options オプション（mergeは現在サポートされていません）
+     * @returns WriteResultインスタンス
+     */
+    set(data: Record<string, any>, options?: {
+        merge?: boolean;
+    }): Promise<WriteResult>;
+    /**
+     * ドキュメントを更新
+     * @param data 更新データ
+     * @returns WriteResultインスタンス
+     */
+    update(data: Record<string, any>): Promise<WriteResult>;
+    /**
+     * ドキュメントを削除
+     * @returns WriteResultインスタンス
+     */
+    delete(): Promise<WriteResult>;
+}
+/**
+ * クエリクラス
+ */
+export declare class Query {
+    private client;
+    private collectionPath;
+    _queryConstraints: {
+        where: Array<{
+            field: string;
+            op: string;
+            value: any;
+        }>;
+        orderBy?: string;
+        orderDirection?: string;
+        limit?: number;
+        offset?: number;
+    };
+    constructor(client: FirestoreClient, collectionPath: string, constraints: {
+        where: Array<{
+            field: string;
+            op: string;
+            value: any;
+        }>;
+        orderBy?: string;
+        orderDirection?: string;
+        limit?: number;
+        offset?: number;
+    });
+    /**
+     * フィルター条件を追加
+     * @param fieldPath フィールドパス
+     * @param opStr 演算子
+     * @param value 値
+     * @returns Queryインスタンス
+     */
+    where(fieldPath: string, opStr: string, value: any): Query;
+    /**
+     * 並べ替え条件を追加
+     * @param fieldPath フィールドパス
+     * @param directionStr 並べ替え方向（'asc'または'desc'）
+     * @returns Queryインスタンス
+     */
+    orderBy(fieldPath: string, directionStr?: "asc" | "desc"): Query;
+    /**
+     * 取得件数の制限を設定
+     * @param limit 最大件数
+     * @returns Queryインスタンス
+     */
+    limit(limit: number): Query;
+    /**
+     * スキップ件数を設定
+     * @param offset スキップ件数
+     * @returns Queryインスタンス
+     */
+    offset(offset: number): Query;
+    /**
+     * クエリを実行
+     * @returns QuerySnapshotインスタンス
+     */
+    get(): Promise<QuerySnapshot>;
+}
+/**
+ * クエリ結果クラス
+ */
+export declare class QuerySnapshot {
+    private _docs;
+    constructor(results: Array<Record<string, any>>);
+    /**
+     * 結果のドキュメント配列
+     */
+    get docs(): DocumentSnapshot[];
+    /**
+     * 結果が空かどうか
+     */
+    get empty(): boolean;
+    /**
+     * 結果の件数
+     */
+    get size(): number;
+    /**
+     * 各ドキュメントに対してコールバックを実行
+     * @param callback 各ドキュメントに対して実行するコールバック関数
+     */
+    forEach(callback: (result: DocumentSnapshot) => void): void;
+}
+/**
+ * ドキュメントスナップショットクラス
+ */
+export declare class DocumentSnapshot {
+    private _id;
+    private _data;
+    constructor(id: string, data: Record<string, any> | null);
+    /**
+     * ドキュメントID
+     */
+    get id(): string;
+    /**
+     * ドキュメントが存在するかどうか
+     */
+    get exists(): boolean;
+    /**
+     * ドキュメントデータを取得
+     * @returns ドキュメントデータ（存在しない場合はundefined）
+     */
+    data(): Record<string, any> | undefined;
+}
+/**
+ * 書き込み結果クラス
+ */
+export declare class WriteResult {
+    /**
+     * 書き込み時刻
+     */
+    readonly writeTime: Date;
+    constructor();
+}
 /**
  * 新しいFirestoreクライアントインスタンスを作成
  * @param config Firestore設定オブジェクト

package/dist/client.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FirestoreClient = void 0;
+exports.WriteResult = exports.DocumentSnapshot = exports.QuerySnapshot = exports.Query = exports.DocumentReference = exports.CollectionReference = exports.FirestoreClient = void 0;
 exports.createFirestoreClient = createFirestoreClient;
 const auth_1 = require("./utils/auth");
 const converter_1 = require("./utils/converter");
@@ -41,6 +41,28 @@ class FirestoreClient {
         }
         return this.token;
     }
+    /**
+     * コレクションリファレンスを取得
+     * @param path コレクションパス
+     * @returns CollectionReferenceインスタンス
+     */
+    collection(path) {
+        return new CollectionReference(this, path);
+    }
+    /**
+     * ドキュメントリファレンスを取得
+     * @param path ドキュメントパス
+     * @returns DocumentReferenceインスタンス
+     */
+    doc(path) {
+        const parts = path.split("/");
+        if (parts.length % 2 === 0) {
+            throw new Error("Invalid document path. Document path must point to a document, not a collection.");
+        }
+        const collectionPath = parts.slice(0, parts.length - 1).join("/");
+        const docId = parts[parts.length - 1];
+        return new DocumentReference(this, collectionPath, docId);
+    }
     /**
      * Firestoreにドキュメントを作成
      * @param collectionName コレクション名
@@ -166,7 +188,7 @@ class FirestoreClient {
             structuredQuery.orderBy = [
                 {
                     field: { fieldPath: options.orderBy },
-                    direction: "ASCENDING",
+                    direction: options.orderDirection || "ASCENDING",
                 },
             ];
         }
@@ -199,6 +221,416 @@ class FirestoreClient {
     }
 }
 exports.FirestoreClient = FirestoreClient;
+/**
+ * コレクションリファレンスクラス
+ */
+class CollectionReference {
+    constructor(client, path) {
+        this.client = client;
+        this.path = path;
+        this._queryConstraints = {
+            where: [],
+        };
+    }
+    /**
+     * ドキュメントリファレンスを取得
+     * @param documentPath ドキュメントID（省略時は自動生成）
+     * @returns DocumentReferenceインスタンス
+     */
+    doc(documentPath) {
+        const docId = documentPath || this._generateId();
+        return new DocumentReference(this.client, this.path, docId);
+    }
+    /**
+     * ドキュメントを追加（IDは自動生成）
+     * @param data ドキュメントデータ
+     * @returns 作成されたドキュメントのリファレンス
+     */
+    async add(data) {
+        const result = await this.client.create(this.path, data);
+        const docId = result.id;
+        return new DocumentReference(this.client, this.path, docId);
+    }
+    /**
+     * フィルター条件を追加
+     * @param fieldPath フィールドパス
+     * @param opStr 演算子
+     * @param value 値
+     * @returns Queryインスタンス
+     */
+    where(fieldPath, opStr, value) {
+        const query = new Query(this.client, this.path, {
+            ...this._queryConstraints,
+        });
+        // 演算子の変換
+        let firestoreOp;
+        switch (opStr) {
+            case "==":
+                firestoreOp = "EQUAL";
+                break;
+            case "!=":
+                firestoreOp = "NOT_EQUAL";
+                break;
+            case "<":
+                firestoreOp = "LESS_THAN";
+                break;
+            case "<=":
+                firestoreOp = "LESS_THAN_OR_EQUAL";
+                break;
+            case ">":
+                firestoreOp = "GREATER_THAN";
+                break;
+            case ">=":
+                firestoreOp = "GREATER_THAN_OR_EQUAL";
+                break;
+            case "array-contains":
+                firestoreOp = "ARRAY_CONTAINS";
+                break;
+            case "in":
+                firestoreOp = "IN";
+                break;
+            case "array-contains-any":
+                firestoreOp = "ARRAY_CONTAINS_ANY";
+                break;
+            case "not-in":
+                firestoreOp = "NOT_IN";
+                break;
+            default:
+                firestoreOp = opStr;
+        }
+        query._queryConstraints.where.push({
+            field: fieldPath,
+            op: firestoreOp,
+            value,
+        });
+        return query;
+    }
+    /**
+     * 並べ替え条件を追加
+     * @param fieldPath フィールドパス
+     * @param directionStr 並べ替え方向（'asc'または'desc'）
+     * @returns Queryインスタンス
+     */
+    orderBy(fieldPath, directionStr = "asc") {
+        const query = new Query(this.client, this.path, {
+            ...this._queryConstraints,
+        });
+        query._queryConstraints.orderBy = fieldPath;
+        query._queryConstraints.orderDirection =
+            directionStr === "asc" ? "ASCENDING" : "DESCENDING";
+        return query;
+    }
+    /**
+     * 取得件数の制限を設定
+     * @param limit 最大件数
+     * @returns Queryインスタンス
+     */
+    limit(limit) {
+        const query = new Query(this.client, this.path, {
+            ...this._queryConstraints,
+        });
+        query._queryConstraints.limit = limit;
+        return query;
+    }
+    /**
+     * スキップ件数を設定
+     * @param offset スキップ件数
+     * @returns Queryインスタンス
+     */
+    offset(offset) {
+        const query = new Query(this.client, this.path, {
+            ...this._queryConstraints,
+        });
+        query._queryConstraints.offset = offset;
+        return query;
+    }
+    /**
+     * クエリを実行
+     * @returns QuerySnapshotインスタンス
+     */
+    async get() {
+        const results = await this.client.query(this.path, this._queryConstraints);
+        return new QuerySnapshot(results);
+    }
+    /**
+     * ランダムなIDを生成
+     * @returns ランダムなID
+     */
+    _generateId() {
+        // 20文字のランダムなIDを生成
+        const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+        let id = "";
+        for (let i = 0; i < 20; i++) {
+            id += chars.charAt(Math.floor(Math.random() * chars.length));
+        }
+        return id;
+    }
+}
+exports.CollectionReference = CollectionReference;
+/**
+ * ドキュメントリファレンスクラス
+ */
+class DocumentReference {
+    constructor(client, collectionPath, docId) {
+        this.client = client;
+        this.collectionPath = collectionPath;
+        this.docId = docId;
+    }
+    /**
+     * ドキュメントIDを取得
+     */
+    get id() {
+        return this.docId;
+    }
+    /**
+     * ドキュメントのパスを取得
+     */
+    get path() {
+        return `${this.collectionPath}/${this.docId}`;
+    }
+    /**
+     * サブコレクションを取得
+     * @param collectionPath サブコレクション名
+     * @returns CollectionReferenceインスタンス
+     */
+    collection(collectionPath) {
+        return new CollectionReference(this.client, `${this.path}/${collectionPath}`);
+    }
+    /**
+     * ドキュメントを取得
+     * @returns DocumentSnapshotインスタンス
+     */
+    async get() {
+        const data = await this.client.get(this.collectionPath, this.docId);
+        return new DocumentSnapshot(this.docId, data);
+    }
+    /**
+     * ドキュメントを作成または上書き
+     * @param data ドキュメントデータ
+     * @param options オプション（mergeは現在サポートされていません）
+     * @returns WriteResultインスタンス
+     */
+    async set(data, options) {
+        // 既存のドキュメントを取得
+        const existingDoc = await this.client.get(this.collectionPath, this.docId);
+        if (existingDoc) {
+            // 既存のドキュメントがある場合は更新
+            const mergedData = options?.merge ? { ...existingDoc, ...data } : data;
+            await this.client.update(this.collectionPath, this.docId, mergedData);
+        }
+        else {
+            // 新規作成
+            const newData = { ...data, id: this.docId };
+            await this.client.create(this.collectionPath, newData);
+        }
+        return new WriteResult();
+    }
+    /**
+     * ドキュメントを更新
+     * @param data 更新データ
+     * @returns WriteResultインスタンス
+     */
+    async update(data) {
+        await this.client.update(this.collectionPath, this.docId, data);
+        return new WriteResult();
+    }
+    /**
+     * ドキュメントを削除
+     * @returns WriteResultインスタンス
+     */
+    async delete() {
+        await this.client.delete(this.collectionPath, this.docId);
+        return new WriteResult();
+    }
+}
+exports.DocumentReference = DocumentReference;
+/**
+ * クエリクラス
+ */
+class Query {
+    constructor(client, collectionPath, constraints) {
+        this.client = client;
+        this.collectionPath = collectionPath;
+        this._queryConstraints = constraints;
+    }
+    /**
+     * フィルター条件を追加
+     * @param fieldPath フィールドパス
+     * @param opStr 演算子
+     * @param value 値
+     * @returns Queryインスタンス
+     */
+    where(fieldPath, opStr, value) {
+        const query = new Query(this.client, this.collectionPath, {
+            ...this._queryConstraints,
+        });
+        // 演算子の変換
+        let firestoreOp;
+        switch (opStr) {
+            case "==":
+                firestoreOp = "EQUAL";
+                break;
+            case "!=":
+                firestoreOp = "NOT_EQUAL";
+                break;
+            case "<":
+                firestoreOp = "LESS_THAN";
+                break;
+            case "<=":
+                firestoreOp = "LESS_THAN_OR_EQUAL";
+                break;
+            case ">":
+                firestoreOp = "GREATER_THAN";
+                break;
+            case ">=":
+                firestoreOp = "GREATER_THAN_OR_EQUAL";
+                break;
+            case "array-contains":
+                firestoreOp = "ARRAY_CONTAINS";
+                break;
+            case "in":
+                firestoreOp = "IN";
+                break;
+            case "array-contains-any":
+                firestoreOp = "ARRAY_CONTAINS_ANY";
+                break;
+            case "not-in":
+                firestoreOp = "NOT_IN";
+                break;
+            default:
+                firestoreOp = opStr;
+        }
+        query._queryConstraints.where.push({
+            field: fieldPath,
+            op: firestoreOp,
+            value,
+        });
+        return query;
+    }
+    /**
+     * 並べ替え条件を追加
+     * @param fieldPath フィールドパス
+     * @param directionStr 並べ替え方向（'asc'または'desc'）
+     * @returns Queryインスタンス
+     */
+    orderBy(fieldPath, directionStr = "asc") {
+        const query = new Query(this.client, this.collectionPath, {
+            ...this._queryConstraints,
+        });
+        query._queryConstraints.orderBy = fieldPath;
+        query._queryConstraints.orderDirection =
+            directionStr === "asc" ? "ASCENDING" : "DESCENDING";
+        return query;
+    }
+    /**
+     * 取得件数の制限を設定
+     * @param limit 最大件数
+     * @returns Queryインスタンス
+     */
+    limit(limit) {
+        const query = new Query(this.client, this.collectionPath, {
+            ...this._queryConstraints,
+        });
+        query._queryConstraints.limit = limit;
+        return query;
+    }
+    /**
+     * スキップ件数を設定
+     * @param offset スキップ件数
+     * @returns Queryインスタンス
+     */
+    offset(offset) {
+        const query = new Query(this.client, this.collectionPath, {
+            ...this._queryConstraints,
+        });
+        query._queryConstraints.offset = offset;
+        return query;
+    }
+    /**
+     * クエリを実行
+     * @returns QuerySnapshotインスタンス
+     */
+    async get() {
+        const results = await this.client.query(this.collectionPath, this._queryConstraints);
+        return new QuerySnapshot(results);
+    }
+}
+exports.Query = Query;
+/**
+ * クエリ結果クラス
+ */
+class QuerySnapshot {
+    constructor(results) {
+        this._docs = results.map(doc => {
+            const { id, ...data } = doc;
+            return new DocumentSnapshot(id, data);
+        });
+    }
+    /**
+     * 結果のドキュメント配列
+     */
+    get docs() {
+        return this._docs;
+    }
+    /**
+     * 結果が空かどうか
+     */
+    get empty() {
+        return this._docs.length === 0;
+    }
+    /**
+     * 結果の件数
+     */
+    get size() {
+        return this._docs.length;
+    }
+    /**
+     * 各ドキュメントに対してコールバックを実行
+     * @param callback 各ドキュメントに対して実行するコールバック関数
+     */
+    forEach(callback) {
+        this._docs.forEach(callback);
+    }
+}
+exports.QuerySnapshot = QuerySnapshot;
+/**
+ * ドキュメントスナップショットクラス
+ */
+class DocumentSnapshot {
+    constructor(id, data) {
+        this._id = id;
+        this._data = data;
+    }
+    /**
+     * ドキュメントID
+     */
+    get id() {
+        return this._id;
+    }
+    /**
+     * ドキュメントが存在するかどうか
+     */
+    get exists() {
+        return this._data !== null;
+    }
+    /**
+     * ドキュメントデータを取得
+     * @returns ドキュメントデータ（存在しない場合はundefined）
+     */
+    data() {
+        return this._data || undefined;
+    }
+}
+exports.DocumentSnapshot = DocumentSnapshot;
+/**
+ * 書き込み結果クラス
+ */
+class WriteResult {
+    constructor() {
+        this.writeTime = new Date();
+    }
+}
+exports.WriteResult = WriteResult;
 /**
  * 新しいFirestoreクライアントインスタンスを作成
  * @param config Firestore設定オブジェクト

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./types";
-import { FirestoreClient, createFirestoreClient } from "./client";
+import { FirestoreClient, createFirestoreClient, CollectionReference, DocumentReference, Query, QuerySnapshot, DocumentSnapshot, WriteResult } from "./client";
 export { getFirestoreToken } from "./utils/auth";
 export { convertToFirestoreValue, convertFromFirestoreValue, convertToFirestoreDocument, convertFromFirestoreDocument, } from "./utils/converter";
 export { getFirestoreBasePath, getDocumentId } from "./utils/path";
-export { FirestoreClient, createFirestoreClient };
+export { FirestoreClient, createFirestoreClient, CollectionReference, DocumentReference, Query, QuerySnapshot, DocumentSnapshot, WriteResult, };