@mxpicture/gcp-functions 0.1.1 → 0.1.3

package/README.md

@@ -1,6 +1,6 @@
 # gcp-functions-lib
 
-Example Node library using TypeScript and Zod. Produces:
+Typescript Node library Google Cloud Functions / Firebase Functions. Produces:
 
 - CommonJS build at `dist/cjs`
 - ESM build at `dist/esm`

package/dist/cjs/FunctionCollection.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunctionCollection = void 0;
+class FunctionCollection {
+    constructor() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this.funcs = {};
+    }
+    add(name, func) {
+        this.funcs[name] = func;
+        return this;
+    }
+    build() {
+        return this.funcs;
+    }
+}
+exports.FunctionCollection = FunctionCollection;

package/dist/cjs/base/BaseApi.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseApi = void 0;
+const zod_meta_1 = require("@mxpicture/zod-meta");
+class BaseApi {
+    constructor(store, validation, shape) {
+        this.store = store;
+        this.validation = validation;
+        this.shape = shape;
+    }
+    async delete(p) {
+        return this.store.delete(p.id);
+    }
+    async get(p) {
+        return this.store.get(p.id);
+    }
+    async query() {
+        return this.store.query();
+    }
+    async count() {
+        return { count: await this.store.count() };
+    }
+    async exists(p) {
+        return { exists: await this.store.exists(p.id) };
+    }
+    async meta() {
+        return new zod_meta_1.Meta(this.shape).items();
+    }
+    async create(data) {
+        const result = await this.validation.validate(data);
+        return this.store.create(result);
+    }
+    async update(p, data) {
+        const result = await this.validation.validatePartial(data);
+        return this.store.update(p.id, result);
+    }
+}
+exports.BaseApi = BaseApi;

package/dist/cjs/base/BaseFunction.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseFunction = void 0;
+const https_1 = require("firebase-functions/https");
+const ts_transformer_keys_1 = require("ts-transformer-keys");
+class BaseFunction {
+    constructor(http) {
+        this.http = http;
+        this.httpMethods = (0, ts_transformer_keys_1.keys)();
+    }
+    createFunction() {
+        return (0, https_1.onCall)({ cors: [/firebase\.com$/, /web\.app$/] }, async (req) => {
+            if (!this.httpMethods.find((m) => m === req.data.route))
+                throw new https_1.HttpsError("invalid-argument", `Route ${req.data.route} not available`);
+            return {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                doc: await this.http[req.data.route](req.data),
+            };
+        });
+    }
+}
+exports.BaseFunction = BaseFunction;

package/dist/cjs/base/BaseHttp.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseHttp = void 0;
+const https_1 = require("firebase-functions/https");
+class BaseHttp {
+    constructor(api) {
+        this.api = api;
+    }
+    async delete(req) {
+        try {
+            const id = req.keys?.id;
+            if (!id)
+                throw new https_1.HttpsError("invalid-argument", "Id invalid");
+            await this.api.delete({ id });
+        }
+        catch (error) {
+            if (error instanceof https_1.HttpsError)
+                throw error;
+            throw new https_1.HttpsError("not-found", `Id ${req.keys?.id} not found`);
+        }
+    }
+    async get(req) {
+        try {
+            const id = req.keys?.id;
+            if (!id)
+                throw new https_1.HttpsError("invalid-argument", "Id invalid");
+            return this.api.get({ id });
+        }
+        catch (error) {
+            if (error instanceof https_1.HttpsError)
+                throw error;
+            throw new https_1.HttpsError("not-found", `Id ${req.keys?.id} not found`);
+        }
+    }
+    async query() {
+        try {
+            return this.api.query();
+        }
+        catch (error) {
+            if (error instanceof https_1.HttpsError)
+                throw error;
+            throw new https_1.HttpsError("unknown", "Unknown error");
+        }
+    }
+    async count() {
+        try {
+            return this.api.count();
+        }
+        catch (error) {
+            if (error instanceof https_1.HttpsError)
+                throw error;
+            throw new https_1.HttpsError("unknown", "Unknown error");
+        }
+    }
+    async exists(req) {
+        try {
+            const id = req.keys?.id;
+            if (!id)
+                throw new https_1.HttpsError("invalid-argument", "Id invalid");
+            return await this.api.exists({ id });
+        }
+        catch (error) {
+            if (error instanceof https_1.HttpsError)
+                throw error;
+            throw new https_1.HttpsError("unknown", "Unknown error");
+        }
+    }
+    async meta() {
+        try {
+            return this.api.meta();
+        }
+        catch (error) {
+            if (error instanceof https_1.HttpsError)
+                throw error;
+            throw new https_1.HttpsError("unknown", "Unknown error");
+        }
+    }
+    async create(req) {
+        try {
+            if (!req.content)
+                throw new https_1.HttpsError("invalid-argument", "Content is invalid");
+            return this.api.create(req.content);
+        }
+        catch (error) {
+            if (error instanceof https_1.HttpsError)
+                throw error;
+            throw new https_1.HttpsError("unknown", "Unknown error");
+        }
+    }
+    async update(req) {
+        try {
+            const id = req.keys?.id;
+            if (!id)
+                throw new https_1.HttpsError("invalid-argument", "Id invalid");
+            if (!req.content)
+                throw new https_1.HttpsError("invalid-argument", "Content is invalid");
+            return this.api.update({ id }, req.content);
+        }
+        catch (error) {
+            if (error instanceof https_1.HttpsError)
+                throw error;
+            throw new https_1.HttpsError("unknown", "Unknown error");
+        }
+    }
+}
+exports.BaseHttp = BaseHttp;

package/dist/cjs/common/firebase.js

@@ -1,174 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.round = exports.verifyConnectionToken = exports.sessionLogout = exports.sessionLogin = exports.verifyAuthAll = exports.verifySessionCookie = exports.verifyToken = exports.extractToken = exports.db = exports.app = void 0;
-const auth_1 = require("firebase-admin/auth");
+exports.db = exports.app = void 0;
 const firestore_1 = require("firebase-admin/firestore");
 const app_1 = require("firebase-admin/app");
 exports.app = (0, app_1.initializeApp)();
 exports.db = (0, firestore_1.getFirestore)();
-const extractToken = (request) => {
-    const auth = request.headers["authorization"];
-    if (!auth)
-        return;
-    // Read the ID Token from the Authorization header.
-    if (auth && auth.startsWith("Bearer "))
-        return auth.split("Bearer ")[1];
-    // Read the ID Token from cookie.
-    if (request.cookies)
-        return request.cookies.__session;
-    return;
-};
-exports.extractToken = extractToken;
-// Express middleware that validates Firebase ID Tokens passed in the Authorization HTTP header.
-// The Firebase ID token needs to be passed as a Bearer token in the Authorization HTTP header like this:
-// `Authorization: Bearer <Firebase ID Token>`.
-// when decoded successfully, the ID Token content will be added as `request.user`.
-const verifyToken = (request, response, next) => {
-    const token = (0, exports.extractToken)(request);
-    if (!token) {
-        response
-            .status(401)
-            .json({ status: "unauthorized", message: "Unauthorized" });
-        return;
-    }
-    (0, auth_1.getAuth)()
-        .verifyIdToken(token)
-        .then((decodedIdToken) => {
-        // Only process if the user just signed in in the last 5 minutes.
-        if (Date.now() / 1000 - decodedIdToken.auth_time >= 5 * 60)
-            return response.status(401).json({
-                status: "unauthorized",
-                message: "Recent sign in required!",
-            });
-        request.user = decodedIdToken;
-        request.headers["x-id-token"] = token;
-        return next();
-    }, (error) => {
-        response.status(401).json({
-            status: "unauthorized",
-            message: JSON.stringify(error),
-        });
-    })
-        .catch((error) => {
-        response.status(401).json({
-            status: "unauthorized",
-            message: `Error while verifying Firebase ID token: ${error}`,
-        });
-    });
-};
-exports.verifyToken = verifyToken;
-const verifySessionCookie = (request, response, next) => {
-    const sessionCookie = 
-    // request.cookies.session ||
-    // request.cookies.zsession ||
-    request.cookies.__session || request.headers.zsession || "";
-    // Verify the session cookie. In this case an additional check is added to detect
-    // if the user's Firebase session was revoked, user deleted/disabled, etc.
-    (0, auth_1.getAuth)()
-        .verifySessionCookie(sessionCookie, true /** checkRevoked */)
-        .then(() => {
-        next();
-    }, (error) => {
-        response.status(401).json({
-            status: "unauthorized",
-            message: JSON.stringify(error),
-        });
-    })
-        .catch((error) => {
-        response.status(401).json({
-            status: "unauthorized",
-            message: JSON.stringify(error),
-        });
-    });
-};
-exports.verifySessionCookie = verifySessionCookie;
-const verifyAuthAll = (token) => {
-    return (request, response, next) => {
-        const t = token();
-        // connection token
-        const id = request.headers["x-connection-token"];
-        if (typeof id === "string") {
-            if (id === t)
-                return next();
-            return response.status(401).json({
-                status: "unauthorized",
-                message: "",
-            });
-        }
-        // message connection token
-        if ((0, exports.extractToken)(request))
-            return (0, exports.verifyToken)(request, response, next);
-        // session cookie
-        return (0, exports.verifySessionCookie)(request, response, next);
-    };
-};
-exports.verifyAuthAll = verifyAuthAll;
-const sessionLogin = (request, response) => {
-    // Get the ID token passed and the CSRF token.
-    const idToken = `${request.headers["x-id-token"]}`;
-    // Set session expiration to 5 days.
-    const expiresIn = 60 * 60 * 24 * 5 * 1000;
-    // Create the session cookie. This will also verify the ID token in the process.
-    // The session cookie will have the same claims as the ID token.
-    // To only allow session cookie setting on recent sign-in, auth_time in ID token
-    // can be checked to ensure user was recently signed in before creating a session cookie.
-    (0, auth_1.getAuth)()
-        .createSessionCookie(idToken, { expiresIn })
-        .then((sessionCookie) => {
-        // Set cookie policy for session cookie.
-        // cloud functions will only allow __session (issue only deployed)
-        response.cookie("__session", sessionCookie, {
-            maxAge: expiresIn,
-            httpOnly: true,
-            secure: true,
-        });
-        // const now = new Date();
-        // const zsession =
-        //   "zsession=" +
-        //   sessionCookie +
-        //   "; expires=" +
-        //   now.toUTCString() +
-        //   "; path=/";
-        response.end(JSON.stringify({
-            status: "success",
-            // zsession: zsession,
-        }));
-    }, (error) => {
-        response.status(401).json({
-            status: "unauthorized",
-            message: JSON.stringify(error),
-        });
-    })
-        .catch((error) => {
-        response.status(401).json({
-            status: "unauthorized",
-            message: JSON.stringify(error),
-        });
-    });
-};
-exports.sessionLogin = sessionLogin;
-const sessionLogout = (request, response) => {
-    response.clearCookie("session");
-    response.clearCookie("zsession");
-    response.clearCookie("__session");
-};
-exports.sessionLogout = sessionLogout;
-const verifyConnectionToken = (token) => {
-    return async (request, response, next) => {
-        const id = request.headers["x-connection-token"];
-        if (id === token()) {
-            next();
-            return;
-        }
-        response.status(401).json({
-            status: "unauthorized",
-            message: "",
-        });
-    };
-};
-exports.verifyConnectionToken = verifyConnectionToken;
-const round = (value, digits = 3) => {
-    const factor = Math.pow(10, digits);
-    return Math.round(value * factor) / factor;
-};
-exports.round = round;

package/dist/cjs/demo/User.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserStore = exports.UserHttp = exports.UserFunction = exports.UserApi = exports.userSchema = exports.userShape = void 0;
+const zod_1 = require("zod");
+const BaseApi_1 = require("../base/BaseApi");
+const BaseFunction_1 = require("../base/BaseFunction");
+const BaseHttp_1 = require("../base/BaseHttp");
+const Store_1 = require("../store/Store");
+const Validation_1 = require("../validation/Validation");
+exports.userShape = {
+    name: zod_1.z.string(),
+};
+exports.userSchema = zod_1.z.object(exports.userShape);
+class UserApi extends BaseApi_1.BaseApi {
+    constructor(store, validation) {
+        super(store, validation ?? new Validation_1.Validation(store, exports.userShape), exports.userShape);
+    }
+}
+exports.UserApi = UserApi;
+class UserFunction extends BaseFunction_1.BaseFunction {
+}
+exports.UserFunction = UserFunction;
+class UserHttp extends BaseHttp_1.BaseHttp {
+}
+exports.UserHttp = UserHttp;
+class UserStore extends Store_1.Store {
+    constructor(converter) {
+        super("users", converter);
+    }
+}
+exports.UserStore = UserStore;

package/dist/cjs/lib.js

@@ -14,12 +14,13 @@ 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 });
-__exportStar(require("./FunctionHandlers"), exports);
-__exportStar(require("./handler/IHttpHandlerItem"), exports);
-__exportStar(require("./handler/HttpHandler"), exports);
-__exportStar(require("./common/firebase"), exports);
-__exportStar(require("./common/http"), exports);
-__exportStar(require("./common/types.common"), exports);
-__exportStar(require("./api/IApi"), exports);
-__exportStar(require("./store/IStore"), exports);
-__exportStar(require("./store/types.store"), exports);
+__exportStar(require("./types/types.common.js"), exports);
+__exportStar(require("./types/types.function.js"), exports);
+__exportStar(require("./types/types.apiRoutes.js"), exports);
+__exportStar(require("./common/firebase.js"), exports);
+__exportStar(require("./lib.js"), exports);
+__exportStar(require("./index.js"), exports);
+__exportStar(require("./validation/Validation.js"), exports);
+__exportStar(require("./package.js"), exports);
+__exportStar(require("./store/types.store.js"), exports);
+__exportStar(require("./store/Store.js"), exports);

package/dist/{esm/store/IStore.js → cjs/store/Store.js}

@@ -33,36 +33,35 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IStore = exports.convertDocObject = void 0;
+exports.Store = void 0;
 const firebase_js_1 = require("../common/firebase.js");
 const uuid = __importStar(require("short-uuid"));
-const convertDocObject = (doc) => {
-    if (typeof doc.data !== "function")
-        return doc;
-    return {
-        ...doc.data(),
-        createTime: doc.createTime,
-        updateTime: doc.updateTime,
-        id: doc.id,
-    };
-};
-exports.convertDocObject = convertDocObject;
-class IStore {
-    constructor(collectionName) {
+class Store {
+    constructor(collectionName, converter, namespace = "picpad") {
         this.collectionName = collectionName;
+        this.converter = converter;
+        this.namespace = namespace;
     }
     db() {
         if (!this._db)
-            this._db = firebase_js_1.db
-                .collection(`picpad.${this.collectionName}`)
-                .withConverter(this.createConverter());
+            if (this.converter)
+                this._db = firebase_js_1.db
+                    .collection(`${this.namespace}.${this.collectionName}`)
+                    .withConverter(this.converter);
+            else
+                this._db = firebase_js_1.db.collection(`${this.namespace}.${this.collectionName}`);
         return this._db;
     }
     async query(p) {
         const snapshot = p && p.parentId
             ? await this.refByParent(p.parentId).get()
             : await this.db().get();
-        return snapshot.docs.map((exports.convertDocObject));
+        return snapshot.docs.map((doc) => ({
+            ...doc.data(),
+            id: doc.id,
+            createTime: doc.createTime.toDate(),
+            updateTime: doc.updateTime.toDate(),
+        }));
     }
     async count(p) {
         const snapshot = p && p.parentId
@@ -77,16 +76,22 @@ class IStore {
         const snapshot = await this.ref(id).get();
         if (!snapshot.exists)
             throw new Error(`Id ${id} does not exist`);
-        return (0, exports.convertDocObject)(snapshot);
+        const data = snapshot.data();
+        if (!data)
+            throw new Error(`Id ${id}: data invalid`);
+        data.id = snapshot.id;
+        data.updateTime = snapshot.updateTime?.toDate();
+        data.createTime = snapshot.createTime?.toDate();
+        return data;
     }
     async exists(id) {
         return (await this.ref(id).get()).exists;
     }
     async create(doc) {
-        doc.id = uuid.generate();
-        const ref = this.ref(doc.id);
+        const id = uuid.generate();
+        const ref = this.ref(id);
         await ref.set(doc);
-        return this.get(doc.id);
+        return this.get(id);
     }
     async update(id, doc) {
         const entry = this.ref(id);
@@ -104,4 +109,4 @@ class IStore {
         return this.db().where("parentId", "==", parentId);
     }
 }
-exports.IStore = IStore;
+exports.Store = Store;

package/dist/cjs/store/types.store.js

@@ -1,15 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.storePersistSchema = exports.storeBaseSchema = exports.storePersistSchemaShape = exports.storeBaseSchemaShape = void 0;
+exports.storeSchema = exports.storeSchemaShape = void 0;
 const zod_1 = require("zod");
-exports.storeBaseSchemaShape = {
+exports.storeSchemaShape = {
     id: zod_1.z.string().optional(),
     createTime: zod_1.z.date().optional(),
     updateTime: zod_1.z.date().optional(),
 };
-exports.storePersistSchemaShape = {
-    ...exports.storeBaseSchemaShape,
-    id: zod_1.z.string(),
-};
-exports.storeBaseSchema = zod_1.z.object(exports.storeBaseSchemaShape);
-exports.storePersistSchema = zod_1.z.object(exports.storePersistSchemaShape);
+exports.storeSchema = zod_1.z.object(exports.storeSchemaShape);

package/dist/cjs/types/types.apiRoutes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/types.common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/types.function.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/types/types.httpHandler.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/validation/Validation.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Validation = void 0;
+const zod_1 = require("zod");
+const https_1 = require("firebase-functions/https");
+class Validation {
+    constructor(store, shape) {
+        this.store = store;
+        this.shape = shape;
+        this.createSchema = zod_1.z.object(shape);
+        this.updateSchema = this.createSchema.partial();
+    }
+    async validate(doc) {
+        const result = this.createSchema.safeParse(doc);
+        if (!result.success)
+            throw new https_1.HttpsError("invalid-argument", "Invalid request data", {
+                fields: this.issuesToFieldErrors(result.error.issues),
+            });
+        return result.data;
+    }
+    async validatePartial(doc) {
+        const result = this.updateSchema.safeParse(doc);
+        if (!result.success)
+            throw new https_1.HttpsError("invalid-argument", "Invalid request data", {
+                fields: this.issuesToFieldErrors(result.error.issues),
+            });
+        return result.data;
+    }
+    issuesToFieldErrors(issues) {
+        const fields = {};
+        for (const issue of issues) {
+            const path = issue.path.length ? issue.path.join(".") : "_form";
+            (fields[path] ?? (fields[path] = [])).push(issue.message);
+        }
+        return fields;
+    }
+}
+exports.Validation = Validation;

package/dist/esm/FunctionCollection.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunctionCollection = void 0;
+class FunctionCollection {
+    constructor() {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this.funcs = {};
+    }
+    add(name, func) {
+        this.funcs[name] = func;
+        return this;
+    }
+    build() {
+        return this.funcs;
+    }
+}
+exports.FunctionCollection = FunctionCollection;

package/dist/esm/base/BaseApi.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseApi = void 0;
+const zod_meta_1 = require("@mxpicture/zod-meta");
+class BaseApi {
+    constructor(store, validation, shape) {
+        this.store = store;
+        this.validation = validation;
+        this.shape = shape;
+    }
+    async delete(p) {
+        return this.store.delete(p.id);
+    }
+    async get(p) {
+        return this.store.get(p.id);
+    }
+    async query() {
+        return this.store.query();
+    }
+    async count() {
+        return { count: await this.store.count() };
+    }
+    async exists(p) {
+        return { exists: await this.store.exists(p.id) };
+    }
+    async meta() {
+        return new zod_meta_1.Meta(this.shape).items();
+    }
+    async create(data) {
+        const result = await this.validation.validate(data);
+        return this.store.create(result);
+    }
+    async update(p, data) {
+        const result = await this.validation.validatePartial(data);
+        return this.store.update(p.id, result);
+    }
+}
+exports.BaseApi = BaseApi;

package/dist/esm/base/BaseFunction.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseFunction = void 0;
+const https_1 = require("firebase-functions/https");
+const ts_transformer_keys_1 = require("ts-transformer-keys");
+class BaseFunction {
+    constructor(http) {
+        this.http = http;
+        this.httpMethods = (0, ts_transformer_keys_1.keys)();
+    }
+    createFunction() {
+        return (0, https_1.onCall)({ cors: [/firebase\.com$/, /web\.app$/] }, async (req) => {
+            if (!this.httpMethods.find((m) => m === req.data.route))
+                throw new https_1.HttpsError("invalid-argument", `Route ${req.data.route} not available`);
+            return {
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                doc: await this.http[req.data.route](req.data),
+            };
+        });
+    }
+}
+exports.BaseFunction = BaseFunction;