firebase-rest-firestore 1.2.0 → 1.6.0

package/dist/types/field-value.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Sentinel values for special write behaviors, mirroring the native Firebase
+ * SDK's `FieldValue`. Currently only `serverTimestamp()` is supported.
+ *
+ * A `FieldValue` is not a real field value: when used as a field in a write it
+ * is translated into a Firestore field transform (applied server-side) rather
+ * than serialized as data. Using one anywhere else (e.g. inside an array) is an
+ * error.
+ */
+export declare class FieldValue {
+    readonly methodName: "serverTimestamp";
+    private constructor();
+    /**
+     * Returns a sentinel that sets the field to the server's request timestamp at
+     * write time, e.g. `client.add("posts", { createdAt: FieldValue.serverTimestamp() })`.
+     */
+    static serverTimestamp(): FieldValue;
+    /**
+     * Whether this sentinel represents the same transform as another.
+     */
+    isEqual(other: FieldValue): boolean;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./types";
+import { FirestoreClient, createFirestoreClient, CollectionReference, DocumentReference, CollectionGroup, Query, QuerySnapshot, DocumentSnapshot, WriteResult } from "./client";
+export { FieldValue } from "./field-value";
+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/types/types.d.ts

@@ -0,0 +1,146 @@
+/**
+ * Firestoreクライアントの設定インターフェース
+ */
+export interface FirestoreConfig {
+    projectId: string;
+    privateKey: string;
+    clientEmail: string;
+    databaseId?: string;
+    debug?: boolean;
+    useEmulator?: boolean;
+    emulatorHost?: string;
+    emulatorPort?: number;
+}
+/**
+ * A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
+ * Used to represent document references globally and not connected to any particular client.
+ */
+export declare class LiteralDocumentReference {
+    referenceValue: string;
+    constructor(options: Pick<LiteralDocumentReference, "referenceValue">);
+    /**
+     * Globally unique Firestore document reference paths look like:
+     *   projects/{project_id}/databases/{database_id}/documents/{document_path}
+     * The database id (e.g. `(default)`) never contains a slash, while the
+     * document path may contain many. A single anchored regex parses this
+     * without pulling in a URLPattern polyfill.
+     */
+    private static readonly pattern;
+    private parse;
+    /**
+     * Get Project ID
+     */
+    get project_id(): string;
+    /**
+     * Get Database ID
+     * Ex: `(default)`
+     */
+    get database_id(): string;
+    /**
+     * Get document ID
+     */
+    get id(): string;
+    /**
+     * Get the collection ID
+     */
+    get collectionPath(): string;
+    /**
+     * Get document path
+     */
+    get path(): string;
+}
+/**
+ * A geo point value representing a point on the surface of Earth.
+ */
+export declare class LiteralGeoPointValue {
+    geoPointValue: {
+        /**
+         * The latitude in degrees. It must be in the range [-90.0, +90.0].
+         */
+        latitude: number;
+        /**
+         * The longitude in degrees. It must be in the range [-180.0, +180.0].
+         */
+        longitude: number;
+    };
+    constructor(options: Pick<LiteralGeoPointValue, "geoPointValue">);
+}
+/**
+ * Firestoreの値型定義
+ * See: https://github.com/googleapis/google-api-nodejs-client/blob/5870dfe31f4885eebc82c19f7471c50403308f26/src/apis/firestore/v1.ts#L2246
+ */
+export type FirestoreFieldValue = {
+    stringValue: string;
+} | {
+    integerValue: number;
+} | {
+    doubleValue: number;
+} | {
+    booleanValue: boolean;
+} | {
+    nullValue: null;
+} | {
+    timestampValue: string;
+} | Pick<LiteralGeoPointValue, 'geoPointValue'> | Pick<LiteralDocumentReference, 'referenceValue'> | {
+    mapValue: {
+        fields: Record<string, FirestoreFieldValue>;
+    };
+} | {
+    arrayValue: {
+        values: FirestoreFieldValue[];
+    };
+};
+/**
+ * A Firestore field transform applied server-side during a commit write.
+ * See: https://firebase.google.com/docs/firestore/reference/rest/v1/Write#FieldTransform
+ */
+export interface FieldTransform {
+    fieldPath: string;
+    setToServerValue: "REQUEST_TIME";
+}
+/**
+ * A single write in a `documents:commit` request.
+ */
+export interface CommitWrite {
+    update: {
+        name: string;
+        fields: Record<string, FirestoreFieldValue>;
+    };
+    updateTransforms?: FieldTransform[];
+    currentDocument?: {
+        exists?: boolean;
+        updateTime?: string;
+    };
+}
+/**
+ * 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/types/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/types/utils/config.d.ts

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

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

@@ -0,0 +1,57 @@
+import { CommitWrite, FieldTransform, 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;
+/**
+ * Split write data into plain field values and Firestore field transforms.
+ *
+ * `FieldValue` sentinels (e.g. `serverTimestamp()`) are pulled out into
+ * transforms keyed by their (escaped, dot-separated) field path; everything
+ * else is left untouched in `fields`. Recursion only descends into plain
+ * objects, so class instances (Date / references / geo points) are treated as
+ * leaves.
+ *
+ * @param data Write data (JS values, may contain FieldValue sentinels)
+ * @param prefix Field-path prefix used while recursing (internal, pre-escaped)
+ */
+export declare function extractFieldTransforms(data: Record<string, any>, prefix?: string): {
+    fields: Record<string, any>;
+    transforms: FieldTransform[];
+};
+/**
+ * Build a single `documents:commit` write that updates a document and applies
+ * field transforms. `updateTransforms` / `currentDocument` are only included
+ * when relevant.
+ *
+ * @param documentName Full resource name (projects/.../documents/<path>)
+ * @param fields Already-converted Firestore field values
+ * @param transforms Field transforms to apply after the update
+ * @param currentDocument Optional precondition (e.g. `{ exists: false }`)
+ */
+export declare function buildCommitWrite(documentName: string, fields: Record<string, FirestoreFieldValue>, transforms: FieldTransform[], currentDocument?: {
+    exists?: boolean;
+    updateTime?: string;
+}): CommitWrite;
+/**
+ * Firestoreドキュメントをオブジェクトに変換
+ * @param doc Firestoreレスポンス
+ * @returns 変換されたオブジェクト（idプロパティ付き）
+ */
+export declare function convertFromFirestoreDocument(doc: FirestoreResponse): Record<string, any> & {
+    id: string;
+};

package/dist/types/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/package.json

@@ -1,17 +1,30 @@
 {
   "name": "firebase-rest-firestore",
-  "version": "1.2.0",
+  "version": "1.6.0",
   "description": "Firebase Firestore REST API client for Edge runtime environments",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
   "files": [
     "dist",
     "README.md"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "npm run build:esm && npm run build:cjs && npm run build:types",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:types": "tsc -p tsconfig.json --emitDeclarationOnly --declarationDir dist/types",
+    "watch": "concurrently \"npm run watch:esm\" \"npm run watch:cjs\" \"npm run watch:types\"",
+    "watch:esm": "tsc -p tsconfig.esm.json --watch",
+    "watch:cjs": "tsc -p tsconfig.cjs.json --watch",
+    "watch:types": "tsc -p tsconfig.json --emitDeclarationOnly --declarationDir dist/types --watch",
     "prepublishOnly": "npm run build",
-    "test": "vitest"
+    "setup:local:env": "cp .env.local.example .env && echo 'Created .env file from local example.'",
+    "emulator:start": "cd test/emulator && firebase emulators:start -P demo-test-project",
+    "emulator:stop": "npx kill-port -y 4089 8089 9089",
+    "test": "vitest",
+    "test:unit": "vitest run test/converter.test.ts test/references.test.ts test/field-value.test.ts",
+    "test:emulator": "bash test/scripts/test-with-emulator.sh"
   },
   "keywords": [
     "firebase",
@@ -32,6 +45,7 @@
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@types/node": "^18.16.0",
+    "concurrently": "^8.2.2",
     "dotenv": "^16.4.7",
     "semantic-release": "^24.2.3",
     "typescript": "^5.0.4",