@faasjs/dev 8.0.0-beta.5 → 8.0.0-beta.6

package/README.md

@@ -60,19 +60,19 @@ expect(response.data).toEqual({ message: 'Hello, FaasJS' })
 
 ## API
 
-- Vite: [viteFaasJsServer](functions/viteFaasJsServer.md), [ViteFaasJsServerOptions](type-aliases/ViteFaasJsServerOptions.md)
-- PGlite: [createPgliteKnex](functions/createPgliteKnex.md), [mountFaasKnex](functions/mountFaasKnex.md), [runPgliteSql](functions/runPgliteSql.md), [runPgliteSqlFile](functions/runPgliteSqlFile.md), [unmountFaasKnex](functions/unmountFaasKnex.md), [MountFaasKnexOptions](type-aliases/MountFaasKnexOptions.md)
+- Vite: [viteFaasJsServer](functions/viteFaasJsServer.md)
+- PGlite: [createPgliteKnex](functions/createPgliteKnex.md), [mountFaasKnex](functions/mountFaasKnex.md), [unmountFaasKnex](functions/unmountFaasKnex.md), [MountFaasKnexOptions](type-aliases/MountFaasKnexOptions.md)
 - Test: [test](functions/test.md), [FuncWarper](classes/FuncWarper.md), [streamToString](functions/streamToString.md)
 
 ## Functions
 
 - [createPgliteKnex](functions/createPgliteKnex.md)
 - [defineFunc](functions/defineFunc.md)
+- [generateFaasTypes](functions/generateFaasTypes.md)
+- [isTypegenSourceFile](functions/isTypegenSourceFile.md)
 - [mountFaasKnex](functions/mountFaasKnex.md)
 - [nameFunc](functions/nameFunc.md)
 - [parseFuncFilenameFromStack](functions/parseFuncFilenameFromStack.md)
-- [runPgliteSql](functions/runPgliteSql.md)
-- [runPgliteSqlFile](functions/runPgliteSqlFile.md)
 - [streamToString](functions/streamToString.md)
 - [test](functions/test.md)
 - [unmountFaasKnex](functions/unmountFaasKnex.md)
@@ -85,6 +85,10 @@ expect(response.data).toEqual({ message: 'Hello, FaasJS' })
 - [Func](classes/Func.md)
 - [FuncWarper](classes/FuncWarper.md)
 
+## Interfaces
+
+- [FaasPluginEventMap](interfaces/FaasPluginEventMap.md)
+
 ## Type Aliases
 
 - [Config](type-aliases/Config.md)
@@ -92,12 +96,18 @@ expect(response.data).toEqual({ message: 'Hello, FaasJS' })
 - [FuncConfig](type-aliases/FuncConfig.md)
 - [FuncEventType](type-aliases/FuncEventType.md)
 - [FuncReturnType](type-aliases/FuncReturnType.md)
+- [GenerateFaasTypesOptions](type-aliases/GenerateFaasTypesOptions.md)
+- [GenerateFaasTypesResult](type-aliases/GenerateFaasTypesResult.md)
 - [Handler](type-aliases/Handler.md)
+- [InferPluginEvent](type-aliases/InferPluginEvent.md)
 - [InvokeData](type-aliases/InvokeData.md)
 - [LifeCycleKey](type-aliases/LifeCycleKey.md)
 - [MountData](type-aliases/MountData.md)
 - [MountFaasKnexOptions](type-aliases/MountFaasKnexOptions.md)
 - [Next](type-aliases/Next.md)
+- [NormalizePluginType](type-aliases/NormalizePluginType.md)
 - [Plugin](type-aliases/Plugin.md)
+- [ResolvePluginEvent](type-aliases/ResolvePluginEvent.md)
+- [Simplify](type-aliases/Simplify.md)
+- [UnionToIntersection](type-aliases/UnionToIntersection.md)
 - [UseifyPlugin](type-aliases/UseifyPlugin.md)
-- [ViteFaasJsServerOptions](type-aliases/ViteFaasJsServerOptions.md)

package/dist/chunk-3FXFWIBW.mjs

@@ -0,0 +1,221 @@
+import { existsSync } from 'fs';
+import { readFile, mkdir, writeFile, readdir } from 'fs/promises';
+import { resolve, join, dirname, relative } from 'path';
+import { loadConfig } from '@faasjs/load';
+import { Logger } from '@faasjs/logger';
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+function resolveFaasStaging() {
+  return process.env.FaasEnv || "development";
+}
+function resolveServerConfig(root, logger, defaultBase = "/") {
+  const projectRoot = resolve(root);
+  const staging = resolveFaasStaging();
+  const srcRoot = join(projectRoot, "src");
+  const config = loadConfig(
+    srcRoot,
+    join(srcRoot, "index.func.ts"),
+    staging,
+    logger
+  );
+  const server = config && typeof config === "object" ? config.server : void 0;
+  const resolvedRoot = server && typeof server.root === "string" && server.root.length ? resolve(projectRoot, server.root) : projectRoot;
+  const resolvedBase = server && typeof server.base === "string" && server.base.length ? server.base : defaultBase;
+  return {
+    root: resolvedRoot,
+    base: resolvedBase,
+    staging
+  };
+}
+
+// src/typegen.ts
+function normalizeSlashes(path) {
+  return path.replace(/\\/g, "/");
+}
+function normalizeRoute(path) {
+  const normalized = path.replace(/\/+/g, "/");
+  if (!normalized.length || normalized === "/") return "/";
+  return normalized.endsWith("/") ? normalized.slice(0, -1) : normalized;
+}
+function toRoute(srcRoot, file) {
+  const relativePath = normalizeSlashes(relative(srcRoot, file));
+  const noTsPath = relativePath.replace(/\.ts$/, "");
+  if (noTsPath === "index.func") return { route: "/", priority: 2 };
+  if (noTsPath === "default.func") return { route: "/*", priority: 1 };
+  if (noTsPath.endsWith("/index.func"))
+    return {
+      route: normalizeRoute(`/${noTsPath.slice(0, -"/index.func".length)}`),
+      priority: 2
+    };
+  if (noTsPath.endsWith("/default.func"))
+    return {
+      route: normalizeRoute(`/${noTsPath.slice(0, -"/default.func".length)}/*`),
+      priority: 1
+    };
+  if (noTsPath.endsWith(".func"))
+    return {
+      route: normalizeRoute(`/${noTsPath.slice(0, -".func".length)}`),
+      priority: 3
+    };
+  throw Error(`[faas-types] Invalid func filename: ${file}`);
+}
+function toImportPath(fromFile, targetFile) {
+  const fromDir = dirname(fromFile);
+  const importPath = normalizeSlashes(relative(fromDir, targetFile)).replace(
+    /\.ts$/,
+    ""
+  );
+  if (importPath.startsWith(".")) return importPath;
+  return `./${importPath}`;
+}
+function parsePluginTypes(config) {
+  const pluginConfig = config.plugins;
+  if (!pluginConfig || typeof pluginConfig !== "object") return [];
+  const pluginTypes = /* @__PURE__ */ new Set();
+  for (const key in pluginConfig) {
+    const data = pluginConfig[key];
+    if (typeof data === "string" && data.length) {
+      pluginTypes.add(data);
+      continue;
+    }
+    if (data && typeof data === "object") {
+      if (typeof data.type === "string" && data.type.length)
+        pluginTypes.add(data.type);
+      else pluginTypes.add(key);
+      continue;
+    }
+    pluginTypes.add(key);
+  }
+  return Array.from(pluginTypes).sort((a, b) => a.localeCompare(b));
+}
+async function readFuncFiles(dir) {
+  const result = [];
+  async function walk(currentDir) {
+    const entries = await readdir(currentDir, {
+      withFileTypes: true
+    });
+    for (const entry of entries) {
+      if (entry.name === ".faasjs" || entry.name === "node_modules") continue;
+      const filePath = join(currentDir, entry.name);
+      if (entry.isDirectory()) {
+        await walk(filePath);
+        continue;
+      }
+      if (entry.isFile() && entry.name.endsWith(".func.ts"))
+        result.push(filePath);
+    }
+  }
+  await walk(dir);
+  return result.sort((a, b) => a.localeCompare(b));
+}
+function formatTypes(items) {
+  const actionLines = items.map((item) => {
+    return `    ${JSON.stringify(item.route)}: __FaasFuncAction<__FaasModuleFunc<typeof import(${JSON.stringify(item.importPath)})>>`;
+  });
+  const eventLines = items.map((item) => {
+    const plugins = item.pluginTypes.length ? `[${item.pluginTypes.map((type) => JSON.stringify(type)).join(", ")}]` : "[]";
+    return `    ${JSON.stringify(item.route)}: InferPluginEvent<${plugins}>`;
+  });
+  return `/**
+ * Generated by @faasjs/dev.
+ *
+ * Do not edit this file manually.
+ */
+import type { Func, InferPluginEvent } from '@faasjs/func'
+
+type __FaasModuleFunc<TModule> = TModule extends { func: infer TFunc }
+  ? TFunc extends Func
+    ? TFunc
+    : never
+  : TModule extends { default: infer TFunc }
+    ? TFunc extends Func
+      ? TFunc
+      : never
+    : never
+
+type __FaasFuncAction<TFunc extends Func> = {
+  Params: Parameters<ReturnType<TFunc['export']>['handler']>[0]['params']
+  Data: Awaited<ReturnType<ReturnType<TFunc['export']>['handler']>>
+}
+
+declare module '@faasjs/types' {
+  interface FaasActions {
+${actionLines.length ? `${actionLines.join("\n")}
+` : ""}  }
+
+  interface FaasEvents {
+${eventLines.length ? `${eventLines.join("\n")}
+` : ""}  }
+}
+`;
+}
+function isTypegenSourceFile(filePath) {
+  return /\.func\.ts$/.test(filePath) || /(^|[\\/])faas\.ya?ml$/.test(filePath);
+}
+async function generateFaasTypes(options = {}) {
+  const logger = options.logger || new Logger("FaasJs:Typegen");
+  const { root: projectRoot, staging } = resolveServerConfig(
+    options.root || process.cwd(),
+    logger
+  );
+  const srcRoot = join(projectRoot, "src");
+  const output = join(srcRoot, ".faasjs", "types.d.ts");
+  if (!existsSync(srcRoot))
+    throw Error(`[faas-types] Source directory not found: ${srcRoot}`);
+  const files = await readFuncFiles(srcRoot);
+  const routeMap = /* @__PURE__ */ new Map();
+  for (const file of files) {
+    const { route, priority } = toRoute(srcRoot, file);
+    const config = loadConfig(srcRoot, file, staging, logger);
+    const pluginTypes = parsePluginTypes(config);
+    const importPath = toImportPath(output, file);
+    const prev = routeMap.get(route);
+    if (!prev || priority > prev.priority)
+      routeMap.set(route, {
+        route,
+        importPath,
+        pluginTypes,
+        priority
+      });
+  }
+  const items = Array.from(routeMap.values()).sort(
+    (a, b) => a.route.localeCompare(b.route)
+  );
+  const content = formatTypes(items);
+  let changed = true;
+  try {
+    const previous = await readFile(output, "utf8");
+    if (previous === content) changed = false;
+  } catch (_error) {
+  }
+  if (changed) {
+    await mkdir(dirname(output), {
+      recursive: true
+    });
+    await writeFile(output, content);
+  }
+  return {
+    output,
+    changed,
+    fileCount: files.length,
+    routeCount: items.length
+  };
+}
+
+export { __export, __reExport, generateFaasTypes, isTypegenSourceFile, resolveServerConfig };

package/dist/cli.cjs

@@ -0,0 +1,335 @@
+'use strict';
+
+var fs = require('fs');
+var promises = require('fs/promises');
+var path = require('path');
+var load = require('@faasjs/load');
+var logger = require('@faasjs/logger');
+
+// package.json
+var package_default = {
+  name: "@faasjs/dev",
+  version: "v8.0.0-beta.5",
+  license: "MIT",
+  type: "module",
+  main: "dist/index.cjs",
+  module: "dist/index.mjs",
+  types: "dist/index.d.ts",
+  bin: {
+    "faas-types": "faas-types.mjs"
+  },
+  exports: {
+    ".": {
+      types: "./dist/index.d.ts",
+      import: "./dist/index.mjs",
+      require: "./dist/index.cjs"
+    }
+  },
+  homepage: "https://faasjs.com/doc/dev",
+  repository: {
+    type: "git",
+    url: "git+https://github.com/faasjs/faasjs.git",
+    directory: "packages/dev"
+  },
+  bugs: {
+    url: "https://github.com/faasjs/faasjs/issues"
+  },
+  funding: "https://github.com/sponsors/faasjs",
+  scripts: {
+    build: "tsup-node --entry src/index.ts --entry src/cli.ts --config ../../tsup.config.ts"
+  },
+  files: [
+    "dist",
+    "faas-types.mjs"
+  ],
+  peerDependencies: {
+    "@electric-sql/pglite": "*",
+    "@faasjs/deep_merge": ">=v8.0.0-beta.5",
+    "@faasjs/func": ">=v8.0.0-beta.5",
+    "@faasjs/http": ">=v8.0.0-beta.5",
+    "@faasjs/server": ">=v8.0.0-beta.5",
+    "@faasjs/knex": ">=v8.0.0-beta.5",
+    "@faasjs/load": ">=v8.0.0-beta.5",
+    "@faasjs/logger": ">=v8.0.0-beta.5",
+    "@types/node": "*",
+    knex: "*",
+    vite: "*",
+    vitest: "*",
+    "knex-pglite": "*"
+  },
+  devDependencies: {
+    "@electric-sql/pglite": "*",
+    "@faasjs/deep_merge": ">=v8.0.0-beta.5",
+    "@faasjs/func": ">=v8.0.0-beta.5",
+    "@faasjs/http": ">=v8.0.0-beta.5",
+    "@faasjs/server": ">=v8.0.0-beta.5",
+    "@faasjs/knex": ">=v8.0.0-beta.5",
+    "@faasjs/load": ">=v8.0.0-beta.5",
+    "@faasjs/logger": ">=v8.0.0-beta.5",
+    "@types/node": "*",
+    knex: "*",
+    vite: "*",
+    vitest: "*",
+    "knex-pglite": "*"
+  },
+  engines: {
+    node: ">=24.0.0",
+    npm: ">=11.0.0"
+  }
+};
+function resolveFaasStaging() {
+  return process.env.FaasEnv || "development";
+}
+function resolveServerConfig(root, logger, defaultBase = "/") {
+  const projectRoot = path.resolve(root);
+  const staging = resolveFaasStaging();
+  const srcRoot = path.join(projectRoot, "src");
+  const config = load.loadConfig(
+    srcRoot,
+    path.join(srcRoot, "index.func.ts"),
+    staging,
+    logger
+  );
+  const server = config && typeof config === "object" ? config.server : void 0;
+  const resolvedRoot = server && typeof server.root === "string" && server.root.length ? path.resolve(projectRoot, server.root) : projectRoot;
+  const resolvedBase = server && typeof server.base === "string" && server.base.length ? server.base : defaultBase;
+  return {
+    root: resolvedRoot,
+    base: resolvedBase,
+    staging
+  };
+}
+
+// src/typegen.ts
+function normalizeSlashes(path) {
+  return path.replace(/\\/g, "/");
+}
+function normalizeRoute(path) {
+  const normalized = path.replace(/\/+/g, "/");
+  if (!normalized.length || normalized === "/") return "/";
+  return normalized.endsWith("/") ? normalized.slice(0, -1) : normalized;
+}
+function toRoute(srcRoot, file) {
+  const relativePath = normalizeSlashes(path.relative(srcRoot, file));
+  const noTsPath = relativePath.replace(/\.ts$/, "");
+  if (noTsPath === "index.func") return { route: "/", priority: 2 };
+  if (noTsPath === "default.func") return { route: "/*", priority: 1 };
+  if (noTsPath.endsWith("/index.func"))
+    return {
+      route: normalizeRoute(`/${noTsPath.slice(0, -"/index.func".length)}`),
+      priority: 2
+    };
+  if (noTsPath.endsWith("/default.func"))
+    return {
+      route: normalizeRoute(`/${noTsPath.slice(0, -"/default.func".length)}/*`),
+      priority: 1
+    };
+  if (noTsPath.endsWith(".func"))
+    return {
+      route: normalizeRoute(`/${noTsPath.slice(0, -".func".length)}`),
+      priority: 3
+    };
+  throw Error(`[faas-types] Invalid func filename: ${file}`);
+}
+function toImportPath(fromFile, targetFile) {
+  const fromDir = path.dirname(fromFile);
+  const importPath = normalizeSlashes(path.relative(fromDir, targetFile)).replace(
+    /\.ts$/,
+    ""
+  );
+  if (importPath.startsWith(".")) return importPath;
+  return `./${importPath}`;
+}
+function parsePluginTypes(config) {
+  const pluginConfig = config.plugins;
+  if (!pluginConfig || typeof pluginConfig !== "object") return [];
+  const pluginTypes = /* @__PURE__ */ new Set();
+  for (const key in pluginConfig) {
+    const data = pluginConfig[key];
+    if (typeof data === "string" && data.length) {
+      pluginTypes.add(data);
+      continue;
+    }
+    if (data && typeof data === "object") {
+      if (typeof data.type === "string" && data.type.length)
+        pluginTypes.add(data.type);
+      else pluginTypes.add(key);
+      continue;
+    }
+    pluginTypes.add(key);
+  }
+  return Array.from(pluginTypes).sort((a, b) => a.localeCompare(b));
+}
+async function readFuncFiles(dir) {
+  const result = [];
+  async function walk(currentDir) {
+    const entries = await promises.readdir(currentDir, {
+      withFileTypes: true
+    });
+    for (const entry of entries) {
+      if (entry.name === ".faasjs" || entry.name === "node_modules") continue;
+      const filePath = path.join(currentDir, entry.name);
+      if (entry.isDirectory()) {
+        await walk(filePath);
+        continue;
+      }
+      if (entry.isFile() && entry.name.endsWith(".func.ts"))
+        result.push(filePath);
+    }
+  }
+  await walk(dir);
+  return result.sort((a, b) => a.localeCompare(b));
+}
+function formatTypes(items) {
+  const actionLines = items.map((item) => {
+    return `    ${JSON.stringify(item.route)}: __FaasFuncAction<__FaasModuleFunc<typeof import(${JSON.stringify(item.importPath)})>>`;
+  });
+  const eventLines = items.map((item) => {
+    const plugins = item.pluginTypes.length ? `[${item.pluginTypes.map((type) => JSON.stringify(type)).join(", ")}]` : "[]";
+    return `    ${JSON.stringify(item.route)}: InferPluginEvent<${plugins}>`;
+  });
+  return `/**
+ * Generated by @faasjs/dev.
+ *
+ * Do not edit this file manually.
+ */
+import type { Func, InferPluginEvent } from '@faasjs/func'
+
+type __FaasModuleFunc<TModule> = TModule extends { func: infer TFunc }
+  ? TFunc extends Func
+    ? TFunc
+    : never
+  : TModule extends { default: infer TFunc }
+    ? TFunc extends Func
+      ? TFunc
+      : never
+    : never
+
+type __FaasFuncAction<TFunc extends Func> = {
+  Params: Parameters<ReturnType<TFunc['export']>['handler']>[0]['params']
+  Data: Awaited<ReturnType<ReturnType<TFunc['export']>['handler']>>
+}
+
+declare module '@faasjs/types' {
+  interface FaasActions {
+${actionLines.length ? `${actionLines.join("\n")}
+` : ""}  }
+
+  interface FaasEvents {
+${eventLines.length ? `${eventLines.join("\n")}
+` : ""}  }
+}
+`;
+}
+async function generateFaasTypes(options = {}) {
+  const logger$1 = options.logger || new logger.Logger("FaasJs:Typegen");
+  const { root: projectRoot, staging } = resolveServerConfig(
+    options.root || process.cwd(),
+    logger$1
+  );
+  const srcRoot = path.join(projectRoot, "src");
+  const output = path.join(srcRoot, ".faasjs", "types.d.ts");
+  if (!fs.existsSync(srcRoot))
+    throw Error(`[faas-types] Source directory not found: ${srcRoot}`);
+  const files = await readFuncFiles(srcRoot);
+  const routeMap = /* @__PURE__ */ new Map();
+  for (const file of files) {
+    const { route, priority } = toRoute(srcRoot, file);
+    const config = load.loadConfig(srcRoot, file, staging, logger$1);
+    const pluginTypes = parsePluginTypes(config);
+    const importPath = toImportPath(output, file);
+    const prev = routeMap.get(route);
+    if (!prev || priority > prev.priority)
+      routeMap.set(route, {
+        route,
+        importPath,
+        pluginTypes,
+        priority
+      });
+  }
+  const items = Array.from(routeMap.values()).sort(
+    (a, b) => a.route.localeCompare(b.route)
+  );
+  const content = formatTypes(items);
+  let changed = true;
+  try {
+    const previous = await promises.readFile(output, "utf8");
+    if (previous === content) changed = false;
+  } catch (_error) {
+  }
+  if (changed) {
+    await promises.mkdir(path.dirname(output), {
+      recursive: true
+    });
+    await promises.writeFile(output, content);
+  }
+  return {
+    output,
+    changed,
+    fileCount: files.length,
+    routeCount: items.length
+  };
+}
+
+// src/cli.ts
+var HelpText = `Generate FaasJS API/event type declarations.
+
+Usage:
+  faas-types [options]
+
+Options:
+  --root <path>      Project root path (default: process.cwd())
+  -h, --help         Show help
+  -v, --version      Show version
+`;
+function parseCliArgs(argv) {
+  const args = argv.slice(2);
+  const options = {};
+  const readValue = (index, name) => {
+    const value = args[index + 1];
+    if (!value || value.startsWith("-"))
+      throw Error(`[faas-types] Missing value for ${name}`);
+    return value;
+  };
+  for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+    if (arg === "-h" || arg === "--help") return { showHelp: true, options };
+    if (arg === "-v" || arg === "--version")
+      return {
+        showVersion: true,
+        options
+      };
+    if (arg === "--root") {
+      options.root = readValue(i, arg);
+      i++;
+      continue;
+    }
+    throw Error(`[faas-types] Unknown option: ${arg}`);
+  }
+  return {
+    options
+  };
+}
+async function main(argv = process.argv) {
+  try {
+    const parsed = parseCliArgs(argv);
+    if (parsed.showHelp) {
+      console.log(HelpText);
+      return 0;
+    }
+    if (parsed.showVersion) {
+      console.log(package_default.version);
+      return 0;
+    }
+    const result = await generateFaasTypes(parsed.options);
+    console.log(
+      `[faas-types] ${result.changed ? "Generated" : "Up to date"} ${result.output} (${result.routeCount} routes from ${result.fileCount} files)`
+    );
+    return 0;
+  } catch (error) {
+    console.error(error?.message || error);
+    return 1;
+  }
+}
+
+exports.main = main;

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+declare function main(argv?: string[]): Promise<number>;
+
+export { main };