create-faas-app 8.0.0-beta.21 → 8.0.0-beta.22

package/dist/index.d.ts

@@ -4,8 +4,8 @@ import { Command } from "commander";
 /**
  * Run the `create-faas-app` CLI with a provided argv array.
  *
- * @param argv - CLI arguments forwarded to Commander.
- * @returns Commander program instance after parsing.
+ * @param {string[]} argv - CLI arguments forwarded to Commander.
+ * @returns {Promise<Command>} Commander program instance after parsing.
  *
  * @example
  * ```ts

package/dist/index.mjs

@@ -1,11 +1,12 @@
 import { Command } from "commander";
 import { execSync } from "node:child_process";
+import { randomBytes } from "node:crypto";
 import { existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from "node:fs";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 import enquirer from "enquirer";
 //#region package.json
-var version = "8.0.0-beta.20";
+var version = "8.0.0-beta.21";
 //#endregion
 //#region src/action.ts
 const prompt = enquirer.prompt;
@@ -28,6 +29,9 @@ function resolveTemplateName(template = "basic") {
 function renderTemplate(content, replacements) {
 	return Object.entries(replacements).reduce((result, [key, value]) => result.replaceAll(`{{${key}}}`, value), content);
 }
+function generateSessionSecret() {
+	return randomBytes(32).toString("hex");
+}
 function copyTemplateDirectory(sourcePath, targetPath, replacements) {
 	mkdirSync(targetPath, { recursive: true });
 	for (const entry of readdirSync(sourcePath, { withFileTypes: true })) {
@@ -44,6 +48,22 @@ function scaffold(rootPath, replacements, templateName) {
 	mkdirSync(rootPath);
 	copyTemplateDirectory(join(templateRoot, templateName), rootPath, replacements);
 }
+/**
+* Scaffold a new FaasJS app from a bundled template and install its dependencies.
+*
+* @param {object} [options] - Optional CLI arguments used to choose the project name and template.
+* @param {string} [options.name] - Target folder name for the generated app.
+* @param {string} [options.template] - Template name such as `basic` or `antd`.
+* @returns {Promise<void>} Resolves after the project is generated and its test command finishes.
+* @throws {Error} When the selected template is unknown.
+* @example
+* ```ts
+* await action({
+*   name: 'faasjs-demo',
+*   template: 'basic',
+* })
+* ```
+*/
 async function action(options = {}) {
 	const templateName = resolveTemplateName(options.template);
 	const answers = Object.assign(options, {});
@@ -56,12 +76,27 @@ async function action(options = {}) {
 	}).then((res) => res.value);
 	if (!answers.name) return;
 	const runtime = process.versions.bun ? "bun" : "npm";
-	scaffold(answers.name, { name: answers.name }, templateName);
+	scaffold(answers.name, {
+		name: answers.name,
+		secret: generateSessionSecret()
+	}, templateName);
 	execSync(`cd ${answers.name} && ${runtime} install`, { stdio: "inherit" });
 	if (runtime === "bun") execSync(`cd ${answers.name} && bun test`, { stdio: "inherit" });
 	else execSync(`cd ${answers.name} && npm run test`, { stdio: "inherit" });
 }
-function action_default(program) {
+/**
+* Register the `create-faas-app` command on a Commander program.
+*
+* @param {Command} program - Commander program instance extended with the generator command.
+* @returns {void} No return value.
+* @example
+* ```ts
+* const program = new Command()
+*
+* registerCreateFaasApp(program)
+* ```
+*/
+function registerCreateFaasApp(program) {
 	program.description("Create a new faas app").on("--help", () => console.log(`Examples:
 npx create-faas-app --name faasjs
 npx create-faas-app --name faasjs-admin --template antd
@@ -91,12 +126,12 @@ ${getTemplateNames().join(", ")}`)).option("--name <name>", "Project name").opti
 */
 const commander = new Command();
 commander.storeOptionsAsProperties(false).allowUnknownOption(true).version(version).name("create-faas-app").exitOverride();
-action_default(commander);
+registerCreateFaasApp(commander);
 /**
 * Run the `create-faas-app` CLI with a provided argv array.
 *
-* @param argv - CLI arguments forwarded to Commander.
-* @returns Commander program instance after parsing.
+* @param {string[]} argv - CLI arguments forwarded to Commander.
+* @returns {Promise<Command>} Commander program instance after parsing.
 *
 * @example
 * ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-faas-app",
-  "version": "8.0.0-beta.21",
+  "version": "8.0.0-beta.22",
   "homepage": "https://faasjs.com/doc/create-faas-app",
   "bugs": {
     "url": "https://github.com/faasjs/faasjs/issues"

package/template/antd/src/faas.yaml

@@ -8,4 +8,4 @@ defaults:
         cookie:
           secure: false
           session:
-            secret: secret
+            secret: '{{secret}}'

package/template/basic/src/faas.yaml

@@ -8,4 +8,4 @@ defaults:
         cookie:
           secure: false
           session:
-            secret: secret
+            secret: '{{secret}}'