firebase-rest-firestore 1.2.0 → 1.5.0

package/dist/{index.d.ts → cjs/index.d.ts}

@@ -3,5 +3,5 @@ import { FirestoreClient, createFirestoreClient, CollectionReference, DocumentRe
 export { getFirestoreToken } from "./utils/auth";
 export { convertToFirestoreValue, convertFromFirestoreValue, convertToFirestoreDocument, convertFromFirestoreDocument, } from "./utils/converter";
 export { getFirestoreBasePath, getDocumentId } from "./utils/path";
-export { formatPrivateKey, formatConfig } from "./utils/config";
+export { formatPrivateKey } from "./utils/config";
 export { FirestoreClient, createFirestoreClient, CollectionReference, DocumentReference, CollectionGroup, Query, QuerySnapshot, DocumentSnapshot, WriteResult, };

package/dist/{index.js → cjs/index.js}

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WriteResult = exports.DocumentSnapshot = exports.QuerySnapshot = exports.Query = exports.CollectionGroup = exports.DocumentReference = exports.CollectionReference = exports.createFirestoreClient = exports.FirestoreClient = exports.formatConfig = exports.formatPrivateKey = exports.getDocumentId = exports.getFirestoreBasePath = exports.convertFromFirestoreDocument = exports.convertToFirestoreDocument = exports.convertFromFirestoreValue = exports.convertToFirestoreValue = exports.getFirestoreToken = void 0;
+exports.WriteResult = exports.DocumentSnapshot = exports.QuerySnapshot = exports.Query = exports.CollectionGroup = exports.DocumentReference = exports.CollectionReference = exports.createFirestoreClient = exports.FirestoreClient = exports.formatPrivateKey = exports.getDocumentId = exports.getFirestoreBasePath = exports.convertFromFirestoreDocument = exports.convertToFirestoreDocument = exports.convertFromFirestoreValue = exports.convertToFirestoreValue = exports.getFirestoreToken = void 0;
 // 型定義のエクスポート
 __exportStar(require("./types"), exports);
 // クライアントのエクスポート
@@ -41,4 +41,3 @@ Object.defineProperty(exports, "getFirestoreBasePath", { enumerable: true, get:
 Object.defineProperty(exports, "getDocumentId", { enumerable: true, get: function () { return path_1.getDocumentId; } });
 var config_1 = require("./utils/config");
 Object.defineProperty(exports, "formatPrivateKey", { enumerable: true, get: function () { return config_1.formatPrivateKey; } });
-Object.defineProperty(exports, "formatConfig", { enumerable: true, get: function () { return config_1.formatConfig; } });

package/dist/{types.d.ts → cjs/types.d.ts}

@@ -6,6 +6,10 @@ export interface FirestoreConfig {
     privateKey: string;
     clientEmail: string;
     databaseId?: string;
+    debug?: boolean;
+    useEmulator?: boolean;
+    emulatorHost?: string;
+    emulatorPort?: number;
 }
 /**
  * Firestoreの値型定義

package/dist/cjs/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/{utils → cjs/utils}/auth.js

@@ -37,9 +37,9 @@ exports.createJWT = createJWT;
 exports.getFirestoreToken = getFirestoreToken;
 const jose = __importStar(require("jose"));
 /**
- * JWT（JSON Web Token）を作成する関数
- * @param config Firestore設定
- * @returns JWT文字列
+ * Function to create a JWT (JSON Web Token)
+ * @param config Firestore configuration
+ * @returns JWT string
  */
 async function createJWT(config) {
     const now = Math.floor(Date.now() / 1000);
@@ -48,13 +48,13 @@ async function createJWT(config) {
         sub: config.clientEmail,
         aud: "https://oauth2.googleapis.com/token",
         iat: now,
-        exp: now + 3600, // 1時間後に期限切れ
+        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");
-        // JWTを作成
+        // Create JWT
         const token = await new jose.SignJWT(payload)
             .setProtectedHeader({
             alg: "RS256",
@@ -69,12 +69,16 @@ async function createJWT(config) {
     }
 }
 /**
- * Firestoreの認証トークンを取得する関数
- * @param config Firestore設定
- * @returns アクセストークン
+ * Function to get Firestore authentication token
+ * @param config Firestore configuration
+ * @returns Access token
  */
 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: {

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

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

package/dist/{utils → cjs/utils}/config.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.formatPrivateKey = formatPrivateKey;
-exports.formatConfig = formatConfig;
 /**
  * 秘密鍵の文字列内にある改行コードのエスケープシーケンスを実際の改行に変換する
  * @param privateKey 変換する秘密鍵文字列
@@ -13,14 +12,3 @@ function formatPrivateKey(privateKey) {
     }
     return privateKey;
 }
-/**
- * FirestoreConfigオブジェクトの秘密鍵をフォーマットする
- * @param config 元のconfigオブジェクト
- * @returns 秘密鍵をフォーマットしたconfigオブジェクト
- */
-function formatConfig(config) {
-    return {
-        ...config,
-        privateKey: formatPrivateKey(config.privateKey),
-    };
-}

package/dist/cjs/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/cjs/utils/path.js

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FirestorePath = void 0;
+exports.createFirestorePath = createFirestorePath;
+exports.getFirestoreBasePath = getFirestoreBasePath;
+exports.getDocumentId = getDocumentId;
+/**
+ * Utility class for constructing Firestore URIs
+ * Consistently handles different types of paths and operations
+ */
+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;
+    }
+}
+exports.FirestorePath = FirestorePath;
+/**
+ * Create an instance of FirestorePath class
+ * @param config Firestore configuration
+ * @param debug Debug mode
+ */
+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)
+ */
+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
+ */
+function getDocumentId(path) {
+    const parts = path.split("/");
+    return parts[parts.length - 1];
+}