firebase-rest-firestore 1.2.0 → 1.5.0

package/dist/esm/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./types";
+import { FirestoreClient, createFirestoreClient, CollectionReference, DocumentReference, CollectionGroup, 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 { formatPrivateKey } from "./utils/config";
+export { FirestoreClient, createFirestoreClient, CollectionReference, DocumentReference, CollectionGroup, Query, QuerySnapshot, DocumentSnapshot, WriteResult, };

package/dist/esm/index.js

@@ -0,0 +1,11 @@
+// 型定義のエクスポート
+export * from "./types";
+// クライアントのエクスポート
+import { FirestoreClient, createFirestoreClient, CollectionReference, DocumentReference, CollectionGroup, 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 { formatPrivateKey } from "./utils/config";
+// クライアント関連のエクスポート
+export { FirestoreClient, createFirestoreClient, CollectionReference, DocumentReference, CollectionGroup, Query, QuerySnapshot, DocumentSnapshot, WriteResult, };

package/dist/esm/types.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Firestoreクライアントの設定インターフェース
+ */
+export interface FirestoreConfig {
+    projectId: string;
+    privateKey: string;
+    clientEmail: string;
+    databaseId?: string;
+    debug?: boolean;
+    useEmulator?: boolean;
+    emulatorHost?: string;
+    emulatorPort?: number;
+}
+/**
+ * Firestoreの値型定義
+ */
+export type FirestoreFieldValue = {
+    stringValue: string;
+} | {
+    integerValue: number;
+} | {
+    doubleValue: number;
+} | {
+    booleanValue: boolean;
+} | {
+    nullValue: null;
+} | {
+    timestampValue: string;
+} | {
+    mapValue: {
+        fields: Record<string, FirestoreFieldValue>;
+    };
+} | {
+    arrayValue: {
+        values: FirestoreFieldValue[];
+    };
+};
+/**
+ * Firestoreドキュメント型
+ */
+export interface FirestoreDocument {
+    name?: string;
+    fields: Record<string, FirestoreFieldValue>;
+    createTime?: string;
+    updateTime?: string;
+}
+/**
+ * Firestoreレスポンス型
+ */
+export interface FirestoreResponse {
+    name: string;
+    fields?: Record<string, FirestoreFieldValue>;
+    createTime?: string;
+    updateTime?: string;
+}
+/**
+ * クエリオプション型
+ */
+export interface QueryOptions {
+    where?: Array<{
+        field: string;
+        op: string;
+        value: any;
+    }>;
+    orderBy?: string;
+    orderDirection?: string;
+    limit?: number;
+    offset?: number;
+}

package/dist/esm/types.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/utils/auth.d.ts

@@ -0,0 +1,13 @@
+import { FirestoreConfig } from "../types";
+/**
+ * Function to create a JWT (JSON Web Token)
+ * @param config Firestore configuration
+ * @returns JWT string
+ */
+export declare function createJWT(config: FirestoreConfig): Promise<string>;
+/**
+ * Function to get Firestore authentication token
+ * @param config Firestore configuration
+ * @returns Access token
+ */
+export declare function getFirestoreToken(config: FirestoreConfig): Promise<string>;

package/dist/esm/utils/auth.js

@@ -0,0 +1,57 @@
+import * as jose from "jose";
+/**
+ * Function to create a JWT (JSON Web Token)
+ * @param config Firestore configuration
+ * @returns JWT string
+ */
+export async function createJWT(config) {
+    const now = Math.floor(Date.now() / 1000);
+    const payload = {
+        iss: config.clientEmail,
+        sub: config.clientEmail,
+        aud: "https://oauth2.googleapis.com/token",
+        iat: now,
+        exp: now + 3600, // Expires in 1 hour
+        scope: "https://www.googleapis.com/auth/datastore",
+    };
+    try {
+        // Import the private key
+        const privateKey = await jose.importPKCS8(config.privateKey, "RS256");
+        // Create JWT
+        const token = await new jose.SignJWT(payload)
+            .setProtectedHeader({
+            alg: "RS256",
+            typ: "JWT",
+        })
+            .sign(privateKey);
+        return token;
+    }
+    catch (error) {
+        console.error("Error creating JWT:", error);
+        throw error;
+    }
+}
+/**
+ * Function to get Firestore authentication token
+ * @param config Firestore configuration
+ * @returns Access token
+ */
+export async function getFirestoreToken(config) {
+    // No authentication in emulator mode (returns a dummy token)
+    if (config.useEmulator) {
+        return "firebase-emulator-auth-token";
+    }
+    // Normal authentication process
+    const response = await fetch("https://oauth2.googleapis.com/token", {
+        method: "POST",
+        headers: {
+            "Content-Type": "application/json",
+        },
+        body: JSON.stringify({
+            grant_type: "urn:ietf:params:oauth:grant-type:jwt-bearer",
+            assertion: await createJWT(config),
+        }),
+    });
+    const data = (await response.json());
+    return data.access_token;
+}

package/dist/esm/utils/config.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 秘密鍵の文字列内にある改行コードのエスケープシーケンスを実際の改行に変換する
+ * @param privateKey 変換する秘密鍵文字列
+ * @returns 変換後の秘密鍵文字列
+ */
+export declare function formatPrivateKey(privateKey: string): string;

package/dist/esm/utils/config.js

@@ -0,0 +1,11 @@
+/**
+ * 秘密鍵の文字列内にある改行コードのエスケープシーケンスを実際の改行に変換する
+ * @param privateKey 変換する秘密鍵文字列
+ * @returns 変換後の秘密鍵文字列
+ */
+export function formatPrivateKey(privateKey) {
+    if (privateKey.includes("\\n")) {
+        return privateKey.replace(/\\n/g, "\n");
+    }
+    return privateKey;
+}

package/dist/esm/utils/converter.d.ts

@@ -0,0 +1,27 @@
+import { FirestoreDocument, FirestoreFieldValue, FirestoreResponse } from "../types";
+/**
+ * JSの値をFirestore形式に変換する
+ * @param value 変換する値
+ * @returns Firestore形式の値
+ */
+export declare function convertToFirestoreValue(value: any): FirestoreFieldValue;
+/**
+ * Firestore形式からJSの値に変換する
+ * @param firestoreValue Firestore形式の値
+ * @returns JS形式の値
+ */
+export declare function convertFromFirestoreValue(firestoreValue: FirestoreFieldValue): any;
+/**
+ * オブジェクトをFirestoreドキュメント形式に変換
+ * @param data 変換するオブジェクト
+ * @returns Firestoreドキュメント
+ */
+export declare function convertToFirestoreDocument(data: Record<string, any>): FirestoreDocument;
+/**
+ * Firestoreドキュメントをオブジェクトに変換
+ * @param doc Firestoreレスポンス
+ * @returns 変換されたオブジェクト（idプロパティ付き）
+ */
+export declare function convertFromFirestoreDocument(doc: FirestoreResponse): Record<string, any> & {
+    id: string;
+};

package/dist/esm/utils/converter.js

@@ -0,0 +1,107 @@
+import { getDocumentId } from "./path";
+/**
+ * JSの値をFirestore形式に変換する
+ * @param value 変換する値
+ * @returns Firestore形式の値
+ */
+export function convertToFirestoreValue(value) {
+    if (value instanceof Date) {
+        return { timestampValue: value.toISOString() };
+    }
+    else if (typeof value === "string") {
+        return { stringValue: value };
+    }
+    else if (typeof value === "number") {
+        return Number.isInteger(value)
+            ? { integerValue: value }
+            : { doubleValue: value };
+    }
+    else if (typeof value === "boolean") {
+        return { booleanValue: value };
+    }
+    else if (value === null || value === undefined) {
+        return { nullValue: null };
+    }
+    else if (Array.isArray(value)) {
+        return {
+            arrayValue: {
+                values: value.map(item => convertToFirestoreValue(item)),
+            },
+        };
+    }
+    else if (typeof value === "object") {
+        const fields = Object.entries(value).reduce((acc, [key, val]) => ({
+            ...acc,
+            [key]: convertToFirestoreValue(val),
+        }), {});
+        return { mapValue: { fields } };
+    }
+    // デフォルトは文字列化
+    return { stringValue: String(value) };
+}
+/**
+ * Firestore形式からJSの値に変換する
+ * @param firestoreValue Firestore形式の値
+ * @returns JS形式の値
+ */
+export function convertFromFirestoreValue(firestoreValue) {
+    if ("stringValue" in firestoreValue) {
+        return firestoreValue.stringValue;
+    }
+    else if ("integerValue" in firestoreValue) {
+        return Number(firestoreValue.integerValue);
+    }
+    else if ("doubleValue" in firestoreValue) {
+        return firestoreValue.doubleValue;
+    }
+    else if ("booleanValue" in firestoreValue) {
+        return firestoreValue.booleanValue;
+    }
+    else if ("nullValue" in firestoreValue) {
+        return null;
+    }
+    else if ("timestampValue" in firestoreValue) {
+        return new Date(firestoreValue.timestampValue);
+    }
+    else if ("mapValue" in firestoreValue && firestoreValue.mapValue.fields) {
+        return Object.entries(firestoreValue.mapValue.fields).reduce((acc, [key, val]) => ({
+            ...acc,
+            [key]: convertFromFirestoreValue(val),
+        }), {});
+    }
+    else if ("arrayValue" in firestoreValue &&
+        firestoreValue.arrayValue.values) {
+        return firestoreValue.arrayValue.values.map(convertFromFirestoreValue);
+    }
+    return null;
+}
+/**
+ * オブジェクトをFirestoreドキュメント形式に変換
+ * @param data 変換するオブジェクト
+ * @returns Firestoreドキュメント
+ */
+export function convertToFirestoreDocument(data) {
+    return {
+        fields: Object.entries(data).reduce((acc, [key, value]) => ({
+            ...acc,
+            [key]: convertToFirestoreValue(value),
+        }), {}),
+    };
+}
+/**
+ * Firestoreドキュメントをオブジェクトに変換
+ * @param doc Firestoreレスポンス
+ * @returns 変換されたオブジェクト（idプロパティ付き）
+ */
+export function convertFromFirestoreDocument(doc) {
+    if (!doc.fields)
+        return { id: getDocumentId(doc.name) };
+    const result = Object.entries(doc.fields).reduce((acc, [key, value]) => ({
+        ...acc,
+        [key]: convertFromFirestoreValue(value),
+    }), {});
+    return {
+        ...result,
+        id: getDocumentId(doc.name),
+    };
+}

package/dist/esm/utils/path.d.ts

@@ -0,0 +1,73 @@
+import { FirestoreConfig } from "../types";
+/**
+ * Utility class for constructing Firestore URIs
+ * Consistently handles different types of paths and operations
+ */
+export declare class FirestorePath {
+    private projectId;
+    private databaseId;
+    private useEmulator;
+    private emulatorHost;
+    private emulatorPort;
+    private debug;
+    /**
+     * Constructor
+     */
+    constructor(config: FirestoreConfig, debug?: boolean);
+    /**
+     * Get Firestore base URL (without document path)
+     */
+    getBasePath(): string;
+    /**
+     * Get base URL + collection path for a collection root
+     * @param path Collection path (ex: "users" or "users/uid/posts")
+     */
+    getCollectionPath(path: string): string;
+    /**
+     * Get the complete URL for a document
+     * @param collectionPath Collection path
+     * @param documentId Document ID
+     */
+    getDocumentPath(collectionPath: string, documentId: string): string;
+    /**
+     * Get URL for query execution
+     * @param path Collection path (ex: "users" or "users/uid/posts")
+     * @returns URL for query execution, collection ID, and parent path (if needed)
+     */
+    getQueryPath(path: string): {
+        url: string;
+        collectionId: string;
+        parentPath?: string;
+    };
+    /**
+     * Get reference path for parent document (for query construction)
+     * @param parentPath Parent document path
+     */
+    getParentReference(parentPath: string): string;
+    /**
+     * Get URL for runQuery
+     * @param collectionPath Collection path
+     * @returns URL for executing runQuery
+     */
+    getRunQueryPath(collectionPath: string): string;
+}
+/**
+ * Create an instance of FirestorePath class
+ * @param config Firestore configuration
+ * @param debug Debug mode
+ */
+export declare function createFirestorePath(config: FirestoreConfig, debug?: boolean): FirestorePath;
+/**
+ * Get Firestore base path URL (without path)
+ * @param projectId Project ID
+ * @param databaseId Database ID (defaults to default)
+ * @param config Firestore configuration (for emulator settings)
+ * @returns Firestore base path URL (without path)
+ */
+export declare function getFirestoreBasePath(projectId: string, databaseId?: string, config?: FirestoreConfig): string;
+/**
+ * Extract document ID from document path
+ * @param path Document path
+ * @returns Document ID
+ */
+export declare function getDocumentId(path: string): string;

package/dist/esm/utils/path.js

@@ -0,0 +1,169 @@
+/**
+ * Utility class for constructing Firestore URIs
+ * Consistently handles different types of paths and operations
+ */
+export class FirestorePath {
+    /**
+     * Constructor
+     */
+    constructor(config, debug = false) {
+        this.useEmulator = false;
+        this.emulatorHost = "localhost";
+        this.emulatorPort = 8080;
+        this.debug = false;
+        this.projectId = config.projectId;
+        this.databaseId = config.databaseId || "(default)";
+        this.debug = debug;
+        if (config.useEmulator) {
+            this.useEmulator = true;
+            this.emulatorHost = config.emulatorHost || "localhost";
+            this.emulatorPort = config.emulatorPort || 8080;
+        }
+    }
+    /**
+     * Get Firestore base URL (without document path)
+     */
+    getBasePath() {
+        const baseUrl = this.useEmulator
+            ? `http://${this.emulatorHost}:${this.emulatorPort}/v1`
+            : "https://firestore.googleapis.com/v1";
+        const path = `${baseUrl}/projects/${this.projectId}/databases/${this.databaseId}/documents`;
+        if (this.debug) {
+            console.log(`Generated base path: ${path}`);
+        }
+        return path;
+    }
+    /**
+     * Get base URL + collection path for a collection root
+     * @param path Collection path (ex: "users" or "users/uid/posts")
+     */
+    getCollectionPath(path) {
+        // Remove leading and trailing slashes
+        const cleanPath = path.replace(/^\/+|\/+$/g, '');
+        const fullPath = `${this.getBasePath()}/${cleanPath}`;
+        if (this.debug) {
+            console.log(`Generated collection path: ${fullPath}`);
+        }
+        return fullPath;
+    }
+    /**
+     * Get the complete URL for a document
+     * @param collectionPath Collection path
+     * @param documentId Document ID
+     */
+    getDocumentPath(collectionPath, documentId) {
+        const cleanCollectionPath = collectionPath.replace(/^\/+|\/+$/g, '');
+        const path = `${this.getBasePath()}/${cleanCollectionPath}/${documentId}`;
+        if (this.debug) {
+            console.log(`Generated document path: ${path}`);
+        }
+        return path;
+    }
+    /**
+     * Get URL for query execution
+     * @param path Collection path (ex: "users" or "users/uid/posts")
+     * @returns URL for query execution, collection ID, and parent path (if needed)
+     */
+    getQueryPath(path) {
+        // パスをセグメントに分割
+        const segments = path.replace(/^\/+|\/+$/g, '').split('/');
+        // 単一コレクションの場合
+        if (segments.length === 1) {
+            const url = `${this.getBasePath()}:runQuery`;
+            if (this.debug) {
+                console.log(`Generated query URL (single collection): ${url}`);
+                console.log(`Collection ID: ${segments[0]}`);
+            }
+            return {
+                url,
+                collectionId: segments[0]
+            };
+        }
+        // ネストしたコレクションパスの場合 (例: "users/uid/posts")
+        const collectionId = segments[segments.length - 1];
+        const parentSegments = segments.slice(0, -1);
+        const parentPath = parentSegments.join('/');
+        // ベースURLでネストしたドキュメントまでのパスを取得
+        const url = `${this.getBasePath()}:runQuery`;
+        if (this.debug) {
+            console.log(`Generated query URL (nested collection): ${url}`);
+            console.log(`Collection ID: ${collectionId}`);
+            console.log(`Parent path: ${parentPath}`);
+        }
+        return {
+            url,
+            collectionId,
+            parentPath
+        };
+    }
+    /**
+     * Get reference path for parent document (for query construction)
+     * @param parentPath Parent document path
+     */
+    getParentReference(parentPath) {
+        return `projects/${this.projectId}/databases/${this.databaseId}/documents/${parentPath}`;
+    }
+    /**
+     * Get URL for runQuery
+     * @param collectionPath Collection path
+     * @returns URL for executing runQuery
+     */
+    getRunQueryPath(collectionPath) {
+        // コレクションパス情報を取得
+        const { collectionId, parentPath } = this.getQueryPath(collectionPath);
+        // parentPathがある場合は、親ドキュメントパスを使用してURLを作成
+        if (parentPath) {
+            // getBasePathからベースURLを取得
+            const baseUrl = this.getBasePath().replace(/\/documents$/, '');
+            // 親ドキュメントパスを含むrunQueryのURL
+            const runQueryUrl = `${baseUrl}/documents/${parentPath}:runQuery`;
+            if (this.debug) {
+                console.log(`Generated runQuery URL for nested collection: ${runQueryUrl}`);
+                console.log(`Collection ID: ${collectionId}`);
+            }
+            return runQueryUrl;
+        }
+        // トップレベルコレクションの場合は、ベースパスを使用
+        const baseUrl = this.getBasePath();
+        const runQueryUrl = `${baseUrl}:runQuery`;
+        if (this.debug) {
+            console.log(`Generated runQuery URL for top-level collection: ${runQueryUrl}`);
+            console.log(`Collection ID: ${collectionId}`);
+        }
+        return runQueryUrl;
+    }
+}
+/**
+ * Create an instance of FirestorePath class
+ * @param config Firestore configuration
+ * @param debug Debug mode
+ */
+export function createFirestorePath(config, debug = false) {
+    return new FirestorePath(config, debug);
+}
+/**
+ * Get Firestore base path URL (without path)
+ * @param projectId Project ID
+ * @param databaseId Database ID (defaults to default)
+ * @param config Firestore configuration (for emulator settings)
+ * @returns Firestore base path URL (without path)
+ */
+export function getFirestoreBasePath(projectId, databaseId, config) {
+    // Use emulator URL for emulator mode
+    if (config?.useEmulator) {
+        const host = config.emulatorHost || "127.0.0.1";
+        const port = config.emulatorPort || 8080;
+        return `http://${host}:${port}/v1/projects/${projectId}/databases/${databaseId || "(default)"}/documents`;
+    }
+    // Use normal production environment URL
+    return `https://firestore.googleapis.com/v1/projects/${projectId}/databases/${databaseId || "(default)"}/documents`;
+}
+/**
+ * Extract document ID from document path
+ * @param path Document path
+ * @returns Document ID
+ */
+export function getDocumentId(path) {
+    const parts = path.split("/");
+    return parts[parts.length - 1];
+}