firebase-rest-firestore 1.2.0 → 1.6.0

package/dist/esm/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/esm/field-value.js

@@ -0,0 +1,27 @@
+/**
+ * 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 class FieldValue {
+    constructor(methodName) {
+        this.methodName = methodName;
+    }
+    /**
+     * 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() {
+        return new FieldValue("serverTimestamp");
+    }
+    /**
+     * Whether this sentinel represents the same transform as another.
+     */
+    isEqual(other) {
+        return other instanceof FieldValue && other.methodName === this.methodName;
+    }
+}

package/dist/esm/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/esm/index.js

@@ -0,0 +1,13 @@
+// 型定義のエクスポート
+export * from "./types";
+// クライアントのエクスポート
+import { FirestoreClient, createFirestoreClient, CollectionReference, DocumentReference, CollectionGroup, Query, QuerySnapshot, DocumentSnapshot, WriteResult, } from "./client";
+// FieldValue センチネルのエクスポート
+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/esm/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/esm/types.js

@@ -0,0 +1,70 @@
+/**
+ * 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 class LiteralDocumentReference {
+    constructor(options) {
+        this.referenceValue = options.referenceValue;
+    }
+    parse() {
+        const match = LiteralDocumentReference.pattern.exec(this.referenceValue);
+        if (!match) {
+            throw new Error("Invalid document path. Path does not match pattern.");
+        }
+        const [, project_id, database_id, document_path] = match;
+        return { project_id, database_id, document_path };
+    }
+    /**
+     * Get Project ID
+     */
+    get project_id() {
+        return this.parse().project_id;
+    }
+    /**
+     * Get Database ID
+     * Ex: `(default)`
+     */
+    get database_id() {
+        return this.parse().database_id;
+    }
+    /**
+     * Get document ID
+     */
+    get id() {
+        const path = this.parse().document_path;
+        const parts = path.split("/");
+        const docId = parts[parts.length - 1];
+        return docId;
+    }
+    /**
+     * Get the collection ID
+     */
+    get collectionPath() {
+        const path = this.parse().document_path;
+        const parts = path.split("/");
+        const collectionPath = parts.slice(0, parts.length - 1).join("/");
+        return collectionPath;
+    }
+    /**
+     * Get document path
+     */
+    get path() {
+        return this.parse().document_path;
+    }
+}
+/**
+ * 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.
+ */
+LiteralDocumentReference.pattern = /^projects\/([^/]+)\/databases\/([^/]+)\/documents\/(.+)$/;
+/**
+ * A geo point value representing a point on the surface of Earth.
+ */
+export class LiteralGeoPointValue {
+    constructor(options) {
+        this.geoPointValue = options.geoPointValue;
+    }
+}

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,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/esm/utils/converter.js

@@ -0,0 +1,216 @@
+import { DocumentReference } from "../client";
+import { FieldValue } from "../field-value";
+import { LiteralDocumentReference, LiteralGeoPointValue, } from "../types";
+import { getDocumentId } from "./path";
+/**
+ * JSの値をFirestore形式に変換する
+ * @param value 変換する値
+ * @returns Firestore形式の値
+ */
+export function convertToFirestoreValue(value) {
+    if (value instanceof FieldValue) {
+        // Sentinels (e.g. serverTimestamp) must be extracted into field transforms
+        // before conversion. Reaching here means one was used where Firestore
+        // cannot express a transform (such as inside an array).
+        throw new Error("FieldValue (e.g. serverTimestamp()) can only be used as a top-level or nested document field value, not inside an array.");
+    }
+    if (value instanceof Date) {
+        return { timestampValue: value.toISOString() };
+    }
+    else if (value instanceof DocumentReference) {
+        return { referenceValue: value.referenceValue };
+    }
+    else if (value instanceof LiteralDocumentReference) {
+        return { referenceValue: value.referenceValue };
+    }
+    else if (value instanceof LiteralGeoPointValue) {
+        return { geoPointValue: value.geoPointValue };
+    }
+    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 ("geoPointValue" in firestoreValue) {
+        return new LiteralGeoPointValue(firestoreValue);
+    }
+    else if ("referenceValue" in firestoreValue) {
+        return new LiteralDocumentReference(firestoreValue);
+    }
+    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) {
+        // The `values` field can be undefined, meaning that this is an empty array
+        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),
+        }), {}),
+    };
+}
+/**
+ * Whether a value is a plain JS object (`{}` / `Object.create(null)`), as
+ * opposed to a class instance such as `Date`, `DocumentReference`,
+ * `LiteralGeoPointValue`, `LiteralDocumentReference`, `FieldValue`, or an array.
+ * Only plain objects are recursed into when extracting field transforms.
+ */
+function isPlainObject(value) {
+    if (value === null || typeof value !== "object")
+        return false;
+    const proto = Object.getPrototypeOf(value);
+    return proto === Object.prototype || proto === null;
+}
+/**
+ * Escape a single field name for use in a Firestore field path. Simple names
+ * (`[A-Za-z_][A-Za-z0-9_]*`) are used as-is; anything else (dashes, dots,
+ * leading digits, spaces, ...) is wrapped in backticks with `\` and `` ` ``
+ * escaped, so a literal dot in a key is treated as part of the name rather than
+ * a path separator.
+ * See: https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.documents#Document
+ */
+function escapeFieldPathSegment(segment) {
+    if (/^[A-Za-z_][A-Za-z0-9_]*$/.test(segment)) {
+        return segment;
+    }
+    return "`" + segment.replace(/\\/g, "\\\\").replace(/`/g, "\\`") + "`";
+}
+/**
+ * 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 function extractFieldTransforms(data, prefix = "") {
+    const fields = {};
+    const transforms = [];
+    for (const [key, value] of Object.entries(data)) {
+        const escapedKey = escapeFieldPathSegment(key);
+        const fieldPath = prefix ? `${prefix}.${escapedKey}` : escapedKey;
+        if (value instanceof FieldValue) {
+            if (value.methodName === "serverTimestamp") {
+                transforms.push({ fieldPath, setToServerValue: "REQUEST_TIME" });
+            }
+            else {
+                throw new Error(`Unsupported FieldValue: ${value.methodName}`);
+            }
+        }
+        else if (isPlainObject(value)) {
+            const nested = extractFieldTransforms(value, fieldPath);
+            fields[key] = nested.fields;
+            transforms.push(...nested.transforms);
+        }
+        else {
+            fields[key] = value;
+        }
+    }
+    return { fields, transforms };
+}
+/**
+ * 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 function buildCommitWrite(documentName, fields, transforms, currentDocument) {
+    const write = {
+        update: { name: documentName, fields },
+    };
+    if (transforms.length > 0) {
+        write.updateTransforms = transforms;
+    }
+    if (currentDocument) {
+        write.currentDocument = currentDocument;
+    }
+    return write;
+}
+/**
+ * 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),
+    };
+}