@stoker-platform/node-client 0.2.1

package/dist/types/initializeStoker.d.ts

@@ -0,0 +1,5 @@
+import { CollectionCustomization, CollectionsSchema, GlobalConfig, NodeUtilities, VersionInfo } from "@stoker-platform/types";
+export declare const initializeStoker: (modeEnv: "development" | "production", configFilePath: string, customizationFilesPath: string, gcp?: boolean) => Promise<NodeUtilities>;
+export declare const getMode: () => "development" | "production", getTimezone: () => string, getGlobalConfigModule: () => GlobalConfig, getCustomizationFile: (collection: string, schema: CollectionsSchema) => CollectionCustomization, getVersionInfo: () => VersionInfo | undefined, getMaintenanceInfo: () => {
+    active: boolean;
+} | undefined;

package/dist/types/main.d.ts

@@ -0,0 +1,28 @@
+export { runChildProcess } from "./utils/runChildProcess.js";
+export { initializeFirebase } from "./utils/initializeFirebase.js";
+export { initializeStoker } from "./initializeStoker.js";
+export { fetchCurrentSchema, fetchLastSchema } from "./utils/fetchSchema.js";
+export { getCollectionRefs } from "./read/getCollectionRefs.js";
+export { getDocumentRefs } from "./read/getDocumentRefs.js";
+export { getOne } from "./read/getOne.js";
+export { getSome } from "./read/getSome.js";
+export { addRecord } from "./write/addRecord.js";
+export { updateRecord } from "./write/updateRecord.js";
+export { deleteRecord } from "./write/deleteRecord.js";
+export { writeLog } from "./write/writeLog.js";
+export { sendMail } from "./utils/sendMail.js";
+export { sendMessage } from "./utils/sendMessage.js";
+export { getFirestorePathRef } from "./utils/getFirestorePathRef.js";
+export { serializeTimestamps } from "./utils/serializeTimestamps.js";
+export { deserializeTimestamps, deserializeTimestampsWithoutUnderscores } from "./utils/deserializeTimestamps.js";
+export { deserializeDeleteSentinels } from "./utils/deserializeDeleteSentinels.js";
+export { getCustomizationFiles } from "./utils/getCustomizationFiles.js";
+export { getUser } from "./utils/getUser.js";
+export { addUser } from "./write/addUser.js";
+export { updateUser } from "./write/updateUser.js";
+export { deleteUser } from "./write/deleteUser.js";
+export { validateSoftDelete } from "./write/validateSoftDelete.js";
+export { validateRelations } from "./write/validateRelations.js";
+export { convertTimestampToTimezone, convertDateToTimezone, keepTimezone, removeTimezone, displayDate, } from "./utils/convertToTimezone.js";
+export { tryPromise, getCachedConfigValue, getSchema as getZodSchema, getInputSchema, isDeleteSentinel, } from "@stoker-platform/utils";
+export type { GetOneOptions } from "./read/getOne.js";

package/dist/types/read/getCollectionRefs.d.ts

@@ -0,0 +1,3 @@
+import { CollectionsSchema, StokerPermissions } from "@stoker-platform/types";
+import { Query } from "firebase-admin/firestore";
+export declare const getCollectionRefs: (path: string[], schema: CollectionsSchema, userId?: string, permissions?: StokerPermissions) => Query[];

package/dist/types/read/getDocumentRefs.d.ts

@@ -0,0 +1,3 @@
+import { CollectionsSchema, StokerPermissions } from "@stoker-platform/types";
+import { DocumentReference } from "firebase-admin/firestore";
+export declare const getDocumentRefs: (path: string[], docId: string, schema: CollectionsSchema, permissions?: StokerPermissions) => DocumentReference[];

package/dist/types/read/getOne.d.ts

@@ -0,0 +1,23 @@
+import { CollectionField, StokerCollection, StokerRecord } from "@stoker-platform/types";
+import { Transaction } from "firebase-admin/firestore";
+export interface GetOneOptions {
+    user?: string;
+    subcollections?: {
+        collections?: StokerCollection[];
+        depth: number;
+        constraints?: [string, string, unknown][];
+        limit?: {
+            number: number;
+            orderByField: string;
+            orderByDirection: "asc" | "desc";
+        };
+    };
+    relations?: {
+        fields?: (string | CollectionField)[];
+        depth: number;
+    };
+    providedTransaction?: Transaction;
+    noComputedFields?: boolean;
+    noEmbeddingFields?: boolean;
+}
+export declare const getOne: (path: string[], docId: string, options?: GetOneOptions) => Promise<StokerRecord>;

package/dist/types/read/getSome.d.ts

@@ -0,0 +1,38 @@
+import { CollectionField, StokerCollection, StokerRecord } from "@stoker-platform/types";
+import { DocumentSnapshot, Transaction } from "firebase-admin/firestore";
+export type Cursor = {
+    first: Map<number, DocumentSnapshot>;
+    last: Map<number, DocumentSnapshot>;
+};
+export interface GetSomeOptions {
+    user?: string;
+    relations?: {
+        fields?: (string | CollectionField)[];
+        depth: number;
+    };
+    subcollections?: {
+        collections?: StokerCollection[];
+        depth: number;
+        constraints?: [string, string, unknown][];
+        limit?: {
+            number: number;
+            orderByField: string;
+            orderByDirection: "asc" | "desc";
+        };
+    };
+    pagination?: {
+        number: number;
+        orderByField?: string;
+        orderByDirection?: "asc" | "desc";
+        startAfter?: Cursor;
+        endBefore?: Cursor;
+    };
+    transactional?: boolean;
+    providedTransaction?: Transaction;
+    noEmbeddingFields?: boolean;
+}
+export declare const getSome: (path: string[], constraints?: [string, string, unknown][], options?: GetSomeOptions) => Promise<{
+    cursor: Cursor;
+    pages: number;
+    docs: StokerRecord[];
+}>;

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

@@ -0,0 +1,7 @@
+import { FieldValue, Timestamp } from "firebase-admin/firestore";
+import { DateTime } from "luxon";
+export declare const convertDateToTimezone: (date: Date) => DateTime<true> | DateTime<false>;
+export declare const convertTimestampToTimezone: (timestamp: Timestamp) => DateTime<true> | DateTime<false>;
+export declare const keepTimezone: (date: Date, timezone: string) => Date;
+export declare const removeTimezone: (date: Date, timezone: string) => Date;
+export declare const displayDate: (timestamp: Timestamp | FieldValue) => string;

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

@@ -0,0 +1,2 @@
+import { StokerRecord } from "@stoker-platform/types";
+export declare const deserializeDeleteSentinels: (record: Partial<StokerRecord>) => void;

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

@@ -0,0 +1,3 @@
+import { StokerRecord } from "@stoker-platform/types";
+export declare const deserializeTimestampsWithoutUnderscores: (record: Partial<StokerRecord>) => void;
+export declare const deserializeTimestamps: (record: Partial<StokerRecord>) => void;

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

@@ -0,0 +1,3 @@
+import type { CollectionsSchema } from "@stoker-platform/types";
+export declare const fetchCurrentSchema: (includeComputedFields?: boolean) => Promise<CollectionsSchema>;
+export declare const fetchLastSchema: () => Promise<CollectionsSchema | undefined>;

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

@@ -0,0 +1,2 @@
+import { StokerCollection } from "@stoker-platform/types";
+export declare const getCustomizationFiles: (path: string, collections: StokerCollection[]) => Promise<any>;

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

@@ -0,0 +1,2 @@
+import { Firestore } from "firebase-admin/firestore";
+export declare const getFirestorePathRef: (db: Firestore, path: string[]) => any;

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

@@ -0,0 +1,3 @@
+import { CollectionSchema, StokerPermissions } from "@stoker-platform/types";
+import { Transaction } from "firebase-admin/firestore";
+export declare const getRecordAccess: (transaction: Transaction, collection: CollectionSchema, id: string, user: string, permissions: StokerPermissions) => Promise<boolean>;

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

@@ -0,0 +1 @@
+export declare const getUser: (id: string) => Promise<import("firebase-admin/auth").UserRecord>;

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

@@ -0,0 +1 @@
+export declare const initializeFirebase: () => Promise<import("firebase-admin/app").App>;

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

@@ -0,0 +1 @@
+export declare const runChildProcess: (command: string, args: string[], cwd?: string, env?: NodeJS.ProcessEnv) => Promise<string>;

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

@@ -0,0 +1,5 @@
+export declare const sendMail: (to: string | string[], subject: string, text?: string, html?: string, cc?: string | string[], bcc?: string | string[], replyTo?: string, attachments?: {
+    filename: string;
+    content: Buffer;
+    contentType: string;
+}[], from?: string) => Promise<void>;

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

@@ -0,0 +1 @@
+export declare const sendMessage: (to: string, body: string) => Promise<void>;

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

@@ -0,0 +1,2 @@
+import { StokerRecord } from "@stoker-platform/types";
+export declare const serializeTimestamps: (record: Partial<StokerRecord>) => void;

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

@@ -0,0 +1,2 @@
+import { CollectionSchema } from "@stoker-platform/types";
+export declare const validateCollectionPath: (path: string[], collectionSchema: CollectionSchema) => Promise<void>;

package/dist/types/write/addRecord.d.ts

@@ -0,0 +1,20 @@
+import { FieldValue } from "firebase-admin/firestore";
+import { StokerRecord, StokerPermissions } from "@stoker-platform/types";
+export declare const addRecord: (path: string[], data: Partial<StokerRecord>, user?: {
+    password: string;
+    permissions?: StokerPermissions;
+}, userId?: string, options?: {
+    noTwoWay?: boolean;
+}, context?: any, id?: string) => Promise<{
+    Collection_Path: string[];
+    Last_Write_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Last_Save_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Last_Write_By: string;
+    Last_Write_App: string;
+    Last_Write_Connection_Status: "Online" | "Offline";
+    Last_Write_Version: number;
+    Created_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Saved_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Created_By: string;
+    id: any;
+}>;

package/dist/types/write/addUser.d.ts

@@ -0,0 +1,2 @@
+import { GlobalConfig, StokerCollection, StokerPermissions, StokerRecord } from "@stoker-platform/types";
+export declare const addUser: (docId: string, globalConfig: GlobalConfig, collection: StokerCollection, record: StokerRecord, permissions: StokerPermissions, password: string) => Promise<string>;

package/dist/types/write/deleteRecord.d.ts

@@ -0,0 +1,16 @@
+import { FieldValue } from "firebase-admin/firestore";
+export declare const deleteRecord: (path: string[], docId: string, userId?: string, options?: {
+    force?: boolean;
+}, context?: any) => Promise<{
+    Collection_Path: string[];
+    Last_Write_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Last_Save_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Last_Write_By: string;
+    Last_Write_App: string;
+    Last_Write_Connection_Status: "Online" | "Offline";
+    Last_Write_Version: number;
+    Created_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Saved_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Created_By: string;
+    id: string;
+}>;

package/dist/types/write/deleteUser.d.ts

@@ -0,0 +1,2 @@
+import { StokerRecord } from "@stoker-platform/types";
+export declare const deleteUser: (record: StokerRecord) => Promise<void>;

package/dist/types/write/entityRestrictionAccess.d.ts

@@ -0,0 +1,5 @@
+import { CollectionsSchema, StokerPermissions } from "@stoker-platform/types";
+import { Transaction } from "firebase-admin/firestore";
+export declare const entityRestrictionAccess: (transaction: Transaction, userPermissions: StokerPermissions, userId: string, currentUserPermissions: StokerPermissions, schema: CollectionsSchema, originalPermissions?: StokerPermissions, batchSize?: {
+    size: number;
+}) => Promise<void>;

package/dist/types/write/lockRecord.d.ts

@@ -0,0 +1,3 @@
+import { Transaction } from "firebase-admin/firestore";
+export declare const lockRecord: (transaction: Transaction, docId: string, userId: string) => Promise<void>;
+export declare const unlockRecord: (docId: string, userId: string) => Promise<void>;

package/dist/types/write/rollbackUser.d.ts

@@ -0,0 +1,3 @@
+import { UserRecord } from "firebase-admin/auth";
+import { StokerPermissions } from "@stoker-platform/types";
+export declare const rollbackUser: (id: string, originalUser: UserRecord, originalPermissions: StokerPermissions, message: string) => Promise<void>;

package/dist/types/write/uniqueValidation.d.ts

@@ -0,0 +1,2 @@
+import { CollectionSchema, CollectionsSchema, StokerPermissions, StokerRecord } from "@stoker-platform/types";
+export declare const uniqueValidation: (operation: "create" | "update", docId: string, data: StokerRecord, collectionSchema: CollectionSchema, schema: CollectionsSchema, user?: string, permissions?: StokerPermissions) => Promise<void>;

package/dist/types/write/updateRecord.d.ts

@@ -0,0 +1,21 @@
+import { FieldValue } from "firebase-admin/firestore";
+import { StokerRecord, StokerPermissions } from "@stoker-platform/types";
+export declare const updateRecord: (path: string[], docId: string, data: Partial<StokerRecord>, user?: {
+    operation: "create" | "update" | "delete";
+    password?: string;
+    permissions?: StokerPermissions;
+}, userId?: string, options?: {
+    noTwoWay?: boolean;
+}, context?: any) => Promise<{
+    Collection_Path: string[];
+    Last_Write_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Last_Save_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Last_Write_By: string;
+    Last_Write_App: string;
+    Last_Write_Connection_Status: "Online" | "Offline";
+    Last_Write_Version: number;
+    Created_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Saved_At: import("@firebase/firestore").Timestamp | FieldValue;
+    Created_By: string;
+    id: string;
+}>;

package/dist/types/write/updateUser.d.ts

@@ -0,0 +1,3 @@
+import { GlobalConfig, StokerCollection, StokerPermissions, StokerRecord } from "@stoker-platform/types";
+import { UserRecord } from "firebase-admin/auth";
+export declare const updateUser: (operation: "create" | "update" | "delete", docId: string, globalConfig: GlobalConfig, collection: StokerCollection, record: StokerRecord, originalRecord: StokerRecord, originalUser?: UserRecord, permissions?: StokerPermissions, originalPermissions?: StokerPermissions, password?: string) => Promise<string | undefined>;

package/dist/types/write/validateRelations.d.ts

@@ -0,0 +1,8 @@
+import { CollectionField, CollectionSchema, CollectionsSchema, StokerPermissions, StokerRecord } from "@stoker-platform/types";
+import { Transaction } from "firebase-admin/firestore";
+export declare const validateRelationHierarchy: (collection: CollectionSchema, field: CollectionField, record: StokerRecord, transaction: Transaction, batchSize: {
+    size: number;
+}, isRelationCheck?: boolean) => Promise<void>;
+export declare const validateRelations: (operation: "Create" | "Update", docId: string, record: StokerRecord, partial: Partial<StokerRecord>, collectionSchema: CollectionSchema, schema: CollectionsSchema, transaction: Transaction, batchSize: {
+    size: number;
+}, userId?: string, permissions?: StokerPermissions, originalRecord?: StokerRecord) => Promise<Map<string, string[]>>;

package/dist/types/write/validateSoftDelete.d.ts

@@ -0,0 +1,2 @@
+import { CollectionSchema, StokerRecord } from "@stoker-platform/types";
+export declare const validateSoftDelete: (operation: "create" | "update", collection: CollectionSchema, record: StokerRecord, originalRecord?: StokerRecord) => void;

package/dist/types/write/validateSystemFields.d.ts

@@ -0,0 +1,2 @@
+import { StokerRecord } from "@stoker-platform/types";
+export declare const validateSystemFields: (operation: "create" | "update", data: Partial<StokerRecord>, originalSystemFields: Partial<StokerRecord>) => void;

package/dist/types/write/writeLog.d.ts

@@ -0,0 +1,2 @@
+import { CollectionSchema, StokerRecord } from "@stoker-platform/types";
+export declare const writeLog: (operation: "create" | "update" | "delete", status: "started" | "written" | "success" | "failed", data: StokerRecord, path: string[], docId: string, collectionSchema: CollectionSchema, error?: unknown, originalRecord?: StokerRecord) => Promise<void>;

package/package.json

@@ -0,0 +1,45 @@
+{
+    "name": "@stoker-platform/node-client",
+    "publishConfig": {
+        "access": "restricted"
+    },
+    "version": "0.2.1",
+    "type": "module",
+    "license": "UNLICENSED",
+    "files": [
+        "dist"
+    ],
+    "main": "./dist/bundle.cjs",
+    "module": "./dist/bundle.js",
+    "exports": {
+        ".": {
+            "import": "./dist/bundle.js",
+            "require": "./dist/bundle.cjs"
+        }
+    },
+    "types": "./dist/types/main.d.ts",
+    "scripts": {
+        "dev": "vite build --watch",
+        "lint": "tsc",
+        "build": "vite build"
+    },
+    "dependencies": {
+        "@google-cloud/storage": "^7.18.0",
+        "@stoker-platform/types": "0.2.1",
+        "@stoker-platform/utils": "0.2.1",
+        "@types/luxon": "^3.7.1",
+        "firebase-admin": "^13.6.0",
+        "lodash": "^4.17.21",
+        "luxon": "^3.7.2"
+    },
+    "devDependencies": {
+        "@rollup/plugin-typescript": "^12.3.0",
+        "eslint-config-custom": "*",
+        "tsconfig": "*",
+        "vite-plugin-eslint": "^1.8.1"
+    },
+    "engines": {
+        "node": "22",
+        "npm": "11"
+    }
+}