@faasjs/core 8.0.0-beta.7

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-present, Zhu Feng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# @faasjs/core
+
+FaasJS core package.
+
+[![License: MIT](https://img.shields.io/npm/l/@faasjs/core.svg)](https://github.com/faasjs/faasjs/blob/main/packages/core/LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/@faasjs/core.svg)](https://www.npmjs.com/package/@faasjs/core)
+
+## Install
+
+```sh
+npm install @faasjs/core
+```
+
+## Functions
+
+- [defineFunc](functions/defineFunc.md)
+
+## Type Aliases
+
+- [DefineFuncData](type-aliases/DefineFuncData.md)
+- [DefineFuncOptions](type-aliases/DefineFuncOptions.md)

package/dist/index.cjs

@@ -0,0 +1,167 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+let _faasjs_func = require("@faasjs/func");
+let _faasjs_http = require("@faasjs/http");
+let zod = require("zod");
+zod = __toESM(zod);
+
+//#region src/index.ts
+function formatPluginModuleName(type) {
+	if (type.startsWith("npm:")) return type.slice(4);
+	if (type.startsWith("@") || type.startsWith(".") || type.startsWith("/") || type.includes(":")) return type;
+	return `@faasjs/${type}`;
+}
+function formatPluginClassName(type) {
+	return type.replace(/^@[^/]+\//, "").split(/[^A-Za-z0-9]+/).filter(Boolean).map((item) => item.slice(0, 1).toUpperCase() + item.slice(1)).join("");
+}
+function isPluginConstructor(value) {
+	if (typeof value !== "function") return false;
+	const prototype = value.prototype;
+	if (!prototype || typeof prototype !== "object") return false;
+	return typeof prototype.onMount === "function" || typeof prototype.onInvoke === "function";
+}
+function normalizeIssueMessage(message) {
+	return message.replace(": expected", ", expected").replace(/>=\s+/g, ">=").replace(/<=\s+/g, "<=");
+}
+function formatZodErrorMessage(error) {
+	const lines = ["Invalid params"];
+	for (const issue of error.issues) {
+		const path = issue.path.length ? issue.path.map((item) => String(item)).join(".") : "<root>";
+		lines.push(`${path}: ${normalizeIssueMessage(issue.message)}`);
+	}
+	return lines.join("\n");
+}
+function findPluginByType(func, type) {
+	return func.plugins.find((plugin) => plugin.type === type);
+}
+var CoreFunc = class extends _faasjs_func.Func {
+	loadedConfigPlugins = false;
+	insertPluginBeforeRunHandler(plugin) {
+		const index = this.plugins.findIndex((item) => item.type === "handler" && item.name === "handler");
+		if (index === -1) this.plugins.push(plugin);
+		else this.plugins.splice(index, 0, plugin);
+	}
+	async resolvePluginConstructor(moduleName, className, pluginName) {
+		let mod;
+		try {
+			mod = await import(moduleName);
+		} catch (error) {
+			throw Error(`[defineFunc] Failed to load plugin "${pluginName}" from "${moduleName}": ${error.message}`);
+		}
+		if (className && isPluginConstructor(mod[className])) return mod[className];
+		if (isPluginConstructor(mod.default)) return mod.default;
+		throw Error(`[defineFunc] Failed to resolve plugin class "${className}" from "${moduleName}" for plugin "${pluginName}". Supported exports are named class "${className}" or default class export.`);
+	}
+	async loadPluginsFromConfig(config) {
+		const pluginConfigs = config.plugins || Object.create(null);
+		for (const [key, rawConfig] of Object.entries(pluginConfigs)) {
+			const configValue = rawConfig && typeof rawConfig === "object" ? Object.assign(Object.create(null), rawConfig) : Object.create(null);
+			const pluginName = typeof configValue.name === "string" && configValue.name.length ? configValue.name : key;
+			if (this.plugins.find((plugin) => plugin.name === pluginName)) continue;
+			const pluginType = typeof configValue.type === "string" && configValue.type || typeof rawConfig === "string" && rawConfig || key;
+			const moduleName = formatPluginModuleName(pluginType);
+			const className = formatPluginClassName(pluginType);
+			const PluginConstructor = await this.resolvePluginConstructor(moduleName, className, pluginName);
+			let plugin;
+			try {
+				plugin = new PluginConstructor({
+					...configValue,
+					name: pluginName,
+					type: pluginType
+				});
+			} catch (error) {
+				throw Error(`[defineFunc] Failed to initialize plugin "${pluginName}" from "${moduleName}": ${error.message}`);
+			}
+			if (!plugin || typeof plugin !== "object") throw Error(`[defineFunc] Invalid plugin instance for "${pluginName}" from "${moduleName}".`);
+			this.insertPluginBeforeRunHandler(plugin);
+		}
+		this.loadedConfigPlugins = true;
+	}
+	async mount(data = {
+		event: Object.create(null),
+		context: Object.create(null)
+	}) {
+		if (!data.config) data.config = this.config;
+		if (!this.loadedConfigPlugins) await this.loadPluginsFromConfig(data.config);
+		await super.mount(data);
+	}
+};
+/**
+* Create a cloud function with optional Zod validation.
+*
+* Plugins are always auto-loaded from `func.config.plugins`.
+* Plugin module exports must be either a named class (normalized from
+* plugin type) or a default class export.
+*/
+function defineFunc(options) {
+	let func;
+	let pluginRefsResolved = false;
+	let hasHttp = false;
+	let knexQuery;
+	const resolvePluginRefs = () => {
+		if (pluginRefsResolved) return;
+		hasHttp = !!findPluginByType(func, "http");
+		knexQuery = findPluginByType(func, "knex")?.query;
+		pluginRefsResolved = true;
+	};
+	const parseParams = async (event) => {
+		if (!hasHttp) return void 0;
+		if (!options.schema) return {};
+		const result = await options.schema.safeParseAsync(event?.params ?? {});
+		if (!result.success) throw new _faasjs_http.HttpError({
+			statusCode: 400,
+			message: formatZodErrorMessage(result.error)
+		});
+		return result.data;
+	};
+	const invokeHandler = async (data) => {
+		resolvePluginRefs();
+		const params = await parseParams(data.event);
+		const invokeData = {
+			...data,
+			params,
+			knex: knexQuery
+		};
+		return options.handler(invokeData);
+	};
+	func = new CoreFunc({
+		plugins: [],
+		handler: invokeHandler
+	});
+	return func;
+}
+
+//#endregion
+exports.defineFunc = defineFunc;
+Object.defineProperty(exports, 'z', {
+  enumerable: true,
+  get: function () {
+    return zod;
+  }
+});

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+import { Func, InvokeData } from "@faasjs/func";
+import { Knex } from "@faasjs/knex";
+import * as z from "zod";
+import { ZodTypeAny, output } from "zod";
+
+//#region src/index.d.ts
+type ZodSchema = ZodTypeAny;
+type KnexQuery = Knex['query'];
+type DefineFuncData<TSchema extends ZodSchema | undefined = undefined, TEvent = any, TContext = any, TResult = any> = InvokeData<TEvent, TContext, TResult> & {
+  params: (TSchema extends ZodSchema ? output<NonNullable<TSchema>> : Record<string, never>) | undefined;
+  knex: KnexQuery | undefined;
+};
+type DefineFuncOptions<TSchema extends ZodSchema | undefined = undefined, TEvent = any, TContext = any, TResult = any> = {
+  schema?: TSchema;
+  handler: (data: DefineFuncData<TSchema, TEvent, TContext, TResult>) => Promise<TResult>;
+};
+/**
+ * Create a cloud function with optional Zod validation.
+ *
+ * Plugins are always auto-loaded from `func.config.plugins`.
+ * Plugin module exports must be either a named class (normalized from
+ * plugin type) or a default class export.
+ */
+declare function defineFunc<TSchema extends ZodSchema | undefined = undefined, TEvent = any, TContext = any, TResult = any>(options: DefineFuncOptions<TSchema, TEvent, TContext, TResult>): Func<TEvent, TContext, TResult>;
+//#endregion
+export { DefineFuncData, DefineFuncOptions, defineFunc, z };

package/dist/index.mjs

@@ -0,0 +1,132 @@
+import { Func } from "@faasjs/func";
+import { HttpError } from "@faasjs/http";
+import * as z from "zod";
+
+//#region src/index.ts
+function formatPluginModuleName(type) {
+	if (type.startsWith("npm:")) return type.slice(4);
+	if (type.startsWith("@") || type.startsWith(".") || type.startsWith("/") || type.includes(":")) return type;
+	return `@faasjs/${type}`;
+}
+function formatPluginClassName(type) {
+	return type.replace(/^@[^/]+\//, "").split(/[^A-Za-z0-9]+/).filter(Boolean).map((item) => item.slice(0, 1).toUpperCase() + item.slice(1)).join("");
+}
+function isPluginConstructor(value) {
+	if (typeof value !== "function") return false;
+	const prototype = value.prototype;
+	if (!prototype || typeof prototype !== "object") return false;
+	return typeof prototype.onMount === "function" || typeof prototype.onInvoke === "function";
+}
+function normalizeIssueMessage(message) {
+	return message.replace(": expected", ", expected").replace(/>=\s+/g, ">=").replace(/<=\s+/g, "<=");
+}
+function formatZodErrorMessage(error) {
+	const lines = ["Invalid params"];
+	for (const issue of error.issues) {
+		const path = issue.path.length ? issue.path.map((item) => String(item)).join(".") : "<root>";
+		lines.push(`${path}: ${normalizeIssueMessage(issue.message)}`);
+	}
+	return lines.join("\n");
+}
+function findPluginByType(func, type) {
+	return func.plugins.find((plugin) => plugin.type === type);
+}
+var CoreFunc = class extends Func {
+	loadedConfigPlugins = false;
+	insertPluginBeforeRunHandler(plugin) {
+		const index = this.plugins.findIndex((item) => item.type === "handler" && item.name === "handler");
+		if (index === -1) this.plugins.push(plugin);
+		else this.plugins.splice(index, 0, plugin);
+	}
+	async resolvePluginConstructor(moduleName, className, pluginName) {
+		let mod;
+		try {
+			mod = await import(moduleName);
+		} catch (error) {
+			throw Error(`[defineFunc] Failed to load plugin "${pluginName}" from "${moduleName}": ${error.message}`);
+		}
+		if (className && isPluginConstructor(mod[className])) return mod[className];
+		if (isPluginConstructor(mod.default)) return mod.default;
+		throw Error(`[defineFunc] Failed to resolve plugin class "${className}" from "${moduleName}" for plugin "${pluginName}". Supported exports are named class "${className}" or default class export.`);
+	}
+	async loadPluginsFromConfig(config) {
+		const pluginConfigs = config.plugins || Object.create(null);
+		for (const [key, rawConfig] of Object.entries(pluginConfigs)) {
+			const configValue = rawConfig && typeof rawConfig === "object" ? Object.assign(Object.create(null), rawConfig) : Object.create(null);
+			const pluginName = typeof configValue.name === "string" && configValue.name.length ? configValue.name : key;
+			if (this.plugins.find((plugin) => plugin.name === pluginName)) continue;
+			const pluginType = typeof configValue.type === "string" && configValue.type || typeof rawConfig === "string" && rawConfig || key;
+			const moduleName = formatPluginModuleName(pluginType);
+			const className = formatPluginClassName(pluginType);
+			const PluginConstructor = await this.resolvePluginConstructor(moduleName, className, pluginName);
+			let plugin;
+			try {
+				plugin = new PluginConstructor({
+					...configValue,
+					name: pluginName,
+					type: pluginType
+				});
+			} catch (error) {
+				throw Error(`[defineFunc] Failed to initialize plugin "${pluginName}" from "${moduleName}": ${error.message}`);
+			}
+			if (!plugin || typeof plugin !== "object") throw Error(`[defineFunc] Invalid plugin instance for "${pluginName}" from "${moduleName}".`);
+			this.insertPluginBeforeRunHandler(plugin);
+		}
+		this.loadedConfigPlugins = true;
+	}
+	async mount(data = {
+		event: Object.create(null),
+		context: Object.create(null)
+	}) {
+		if (!data.config) data.config = this.config;
+		if (!this.loadedConfigPlugins) await this.loadPluginsFromConfig(data.config);
+		await super.mount(data);
+	}
+};
+/**
+* Create a cloud function with optional Zod validation.
+*
+* Plugins are always auto-loaded from `func.config.plugins`.
+* Plugin module exports must be either a named class (normalized from
+* plugin type) or a default class export.
+*/
+function defineFunc(options) {
+	let func;
+	let pluginRefsResolved = false;
+	let hasHttp = false;
+	let knexQuery;
+	const resolvePluginRefs = () => {
+		if (pluginRefsResolved) return;
+		hasHttp = !!findPluginByType(func, "http");
+		knexQuery = findPluginByType(func, "knex")?.query;
+		pluginRefsResolved = true;
+	};
+	const parseParams = async (event) => {
+		if (!hasHttp) return void 0;
+		if (!options.schema) return {};
+		const result = await options.schema.safeParseAsync(event?.params ?? {});
+		if (!result.success) throw new HttpError({
+			statusCode: 400,
+			message: formatZodErrorMessage(result.error)
+		});
+		return result.data;
+	};
+	const invokeHandler = async (data) => {
+		resolvePluginRefs();
+		const params = await parseParams(data.event);
+		const invokeData = {
+			...data,
+			params,
+			knex: knexQuery
+		};
+		return options.handler(invokeData);
+	};
+	func = new CoreFunc({
+		plugins: [],
+		handler: invokeHandler
+	});
+	return func;
+}
+
+//#endregion
+export { defineFunc, z };

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@faasjs/core",
+  "version": "8.0.0-beta.7",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "homepage": "https://faasjs.com/doc/core",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/faasjs/faasjs.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/faasjs/faasjs/issues"
+  },
+  "funding": "https://github.com/sponsors/faasjs",
+  "scripts": {
+    "build": "tsdown src/index.ts --config ../../tsdown.config.ts"
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@faasjs/types": ">=8.0.0-beta.7",
+    "@faasjs/func": ">=8.0.0-beta.7",
+    "@faasjs/http": ">=8.0.0-beta.7",
+    "@faasjs/knex": ">=8.0.0-beta.7",
+    "zod": ">=4.0.0"
+  },
+  "devDependencies": {
+    "@faasjs/types": ">=8.0.0-beta.7",
+    "@faasjs/func": ">=8.0.0-beta.7",
+    "@faasjs/http": ">=8.0.0-beta.7",
+    "@faasjs/knex": ">=8.0.0-beta.7",
+    "zod": ">=4.0.0"
+  },
+  "engines": {
+    "node": ">=24.0.0",
+    "npm": ">=11.0.0"
+  }
+}