firebase-rest-firestore 1.1.2 → 1.5.0

package/dist/client.d.ts

@@ -1,381 +0,0 @@
-import { FirestoreConfig, QueryOptions } from "./types";
-/**
- * Firestoreクライアントクラス
- */
-export declare class FirestoreClient {
-    private token;
-    private tokenExpiry;
-    private config;
-    private configChecked;
-    /**
-     * コンストラクタ
-     * @param config Firestore設定オブジェクト
-     */
-    constructor(config: FirestoreConfig);
-    /**
-     * 設定パラメータをチェック
-     * @private
-     */
-    private checkConfig;
-    /**
-     * 認証トークンを取得（キャッシュあり）
-     */
-    private getToken;
-    /**
-     * コレクションリファレンスを取得
-     * @param path コレクションパス
-     * @returns CollectionReferenceインスタンス
-     */
-    collection(path: string): CollectionReference;
-    /**
-     * ドキュメントリファレンスを取得
-     * @param path ドキュメントパス
-     * @returns DocumentReferenceインスタンス
-     */
-    doc(path: string): DocumentReference;
-    /**
-     * コレクショングループリファレンスを取得
-     * @param path コレクショングループのID
-     * @returns CollectionGroupインスタンス
-     */
-    collectionGroup(path: string): CollectionGroup;
-    /**
-     * Firestoreにドキュメントを追加
-     * @param collectionName コレクション名
-     * @param data 追加するデータ
-     * @returns 追加されたドキュメント
-     */
-    add(collectionName: string, data: Record<string, any>): Promise<Record<string, any> & {
-        id: string;
-    }>;
-    /**
-     * ドキュメントを取得
-     * @param collectionName コレクション名
-     * @param documentId ドキュメントID
-     * @returns 取得したドキュメント（存在しない場合はnull）
-     */
-    get(collectionName: string, documentId: string): Promise<(Record<string, any> & {
-        id: string;
-    }) | null>;
-    /**
-     * ドキュメントを更新
-     * @param collectionName コレクション名
-     * @param documentId ドキュメントID
-     * @param data 更新するデータ
-     * @returns 更新されたドキュメント
-     */
-    update(collectionName: string, documentId: string, data: Record<string, any>): Promise<Record<string, any> & {
-        id: string;
-    }>;
-    /**
-     * ドキュメントを削除
-     * @param collectionName コレクション名
-     * @param documentId ドキュメントID
-     * @returns 削除成功時はtrue
-     */
-    delete(collectionName: string, documentId: string): Promise<boolean>;
-    /**
-     * コレクションのドキュメントを検索
-     * @param collectionPath コレクションパス
-     * @param options クエリオプション
-     * @param allDescendants 子孫コレクションを含むかどうか
-     * @returns 検索結果のドキュメント配列
-     */
-    query(collectionPath: string, options: QueryOptions | undefined, allDescendants: boolean): Promise<(Record<string, any> & {
-        id: string;
-    })[]>;
-}
-/**
- * コレクションリファレンスクラス
- */
-export declare class CollectionReference {
-    private client;
-    private path;
-    private _queryConstraints;
-    constructor(client: FirestoreClient, path: string);
-    /**
-     * すべての子孫コレクションを含むかどうか
-     */
-    get allDescendants(): boolean;
-    /**
-     * ドキュメントリファレンスを取得
-     * @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 CollectionGroup {
-    private client;
-    private path;
-    private _queryConstraints;
-    constructor(client: FirestoreClient, path: string);
-    /**
-     * すべての子孫コレクションを含むかどうか
-     */
-    get allDescendants(): boolean;
-    /**
-     * フィルター条件を追加
-     * @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 Query {
-    private client;
-    private collectionPath;
-    private allDescendants;
-    _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;
-    }, allDescendants: boolean);
-    /**
-     * フィルター条件を追加
-     * @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設定オブジェクト
- * @returns FirestoreClientインスタンス
- *
- * @example
- * // デフォルトデータベースに接続
- * const db = createFirestoreClient({
- *   projectId: 'your-project-id',
- *   privateKey: 'your-private-key',
- *   clientEmail: 'your-client-email'
- * });
- *
- * // 異なる名前のデータベースに接続
- * const customDb = createFirestoreClient({
- *   projectId: 'your-project-id',
- *   privateKey: 'your-private-key',
- *   clientEmail: 'your-client-email',
- *   databaseId: 'your-database-id'
- * });
- */
-export declare function createFirestoreClient(config: FirestoreConfig): FirestoreClient;