@faable/faable 1.5.15 → 1.5.16

package/dist/api/context.js

@@ -1,12 +1,29 @@
-import { CredentialsStore } from '../lib/CredentialsStore.js';
 import { FaableApi } from './FaableApi.js';
 import { apikey_strategy } from './strategies/apikey.strategy.js';
+import { getIDToken } from '@actions/core';
+import { oidc_strategy } from './strategies/oidc.strategy.js';
 
+// import { CredentialsStore } from "../lib/CredentialsStore";
 const context = async () => {
-    const store = new CredentialsStore();
-    const apikey = process.env.FAABLE_APIKEY || (await store.loadCredentials())?.apikey;
+    let api;
+    if (process.env.FAABLE_APIKEY) {
+        const apikey = process.env.FAABLE_APIKEY;
+        api = FaableApi.create({ authStrategy: apikey_strategy, auth: { apikey } });
+    }
+    //const store = new CredentialsStore();
+    //(await store.loadCredentials())?.apikey
+    // Github actions environment
+    if (process.env.GITHUB_ACTIONS === 'true') {
+        try {
+            const idToken = await getIDToken("https://faable.com");
+            api = FaableApi.create({ authStrategy: oidc_strategy, auth: { idToken } });
+        }
+        catch (_) {
+            console.error("Error fetching token, configure 'permissions: id-token: write'");
+        }
+    }
     return {
-        api: FaableApi.create({ authStrategy: apikey_strategy, auth: { apikey } }),
+        api,
     };
 };
 

package/dist/api/strategies/oidc.strategy.js

@@ -0,0 +1,15 @@
+const oidc_strategy = (config) => {
+    const { idToken } = config;
+    if (!idToken) {
+        throw new Error("Missing idToken.");
+    }
+    return {
+        headers: async () => {
+            return {
+                Authorization: `Bearer ${idToken}`,
+            };
+        },
+    };
+};
+
+export { oidc_strategy };

package/dist/commands/init/index.js

@@ -1,22 +1,21 @@
-import { ConfigurationHelper } from './ConfigurationHelper.js';
+import { writeGithubAction } from './writeGithubAction.js';
 
 const init = {
     command: ["initialize", "$0"],
     describe: "Initialize Faable",
     builder: (yargs) => {
         return yargs
-            .option("force", {
-            alias: "f",
+            .option("overwrite", {
+            alias: "o",
             type: "boolean",
-            description: "Force initialization",
+            description: "Overwrite generated file",
             default: false,
         })
             .showHelpOnFail(false);
     },
     handler: async (args) => {
-        const { force } = args;
-        const helper = new ConfigurationHelper();
-        await helper.initializeGithubAction(force);
+        const { overwrite } = args;
+        await writeGithubAction({ overwrite });
     },
 };
 

package/dist/commands/init/writeGithubAction.js

@@ -0,0 +1,108 @@
+import path__default from 'path';
+import fs from 'fs-extra';
+import { log } from '../../log.js';
+import prompts from 'prompts';
+import { CredentialsStore } from '../../lib/CredentialsStore.js';
+import yaml from 'yaml';
+
+const store = new CredentialsStore();
+const get_workflows_dir = () => {
+    return path__default.join(process.cwd(), ".github", "workflows");
+};
+const get_default_action = () => {
+    return path__default.join(get_workflows_dir(), "deploy.yml");
+};
+const demandConfig = async (force = false) => {
+    const creds = await store.loadCredentials();
+    if (creds?.apikey) {
+        return;
+    }
+    const { apikey } = await prompts([
+        {
+            type: "text",
+            name: "apikey",
+            message: "What is your Faable ApiKey?",
+        },
+    ]);
+    await store.saveApiKey({ apikey });
+};
+const tentativeName = async () => {
+    try {
+        const pkg = path__default.join(process.cwd(), "package.json");
+        const { name } = await fs.readJSON(pkg);
+        return name;
+    }
+    catch (error) {
+        return;
+    }
+};
+const checkPackageManager = async () => {
+    if (fs.existsSync(path__default.join(process.cwd(), "package-lock.json"))) {
+        return "npm";
+    }
+    if (fs.existsSync(path__default.join(process.cwd(), "yarn.lock"))) {
+        return "yarn";
+    }
+    throw new Error("No package-lock.json or yarn.lock file found");
+};
+const writeGithubAction = async (params = {}) => {
+    const { overwrite } = params;
+    await demandConfig();
+    const gh_action_file = get_default_action();
+    // Already configured
+    if (!overwrite && fs.pathExistsSync(gh_action_file)) {
+        log.info(`Github action is already configured.`);
+        return;
+    }
+    const onCancel = (prompt) => {
+        log.info("Cancel");
+        process.exit(0);
+    };
+    const { app_name } = await prompts([
+        {
+            type: "text",
+            name: "app_name",
+            initial: await tentativeName(),
+            message: "Which app are you deploying",
+        },
+    ], { onCancel });
+    const manager = await checkPackageManager();
+    const action = {
+        name: "Deploy to Faable",
+        on: {
+            push: {
+                branches: ["main"],
+            },
+        },
+        permissions: {
+            "id-token": "write",
+            "contents": "read"
+        },
+        jobs: {
+            deploy: {
+                "runs-on": "ubuntu-latest",
+                steps: [
+                    { uses: "actions/checkout@v2" },
+                    {
+                        uses: "actions/setup-node@v4",
+                        with: {
+                            "node-version": "lts/*",
+                        },
+                    },
+                    ...(manager == "npm" ? [{ run: "npm ci" }] : []),
+                    ...(manager == "yarn"
+                        ? [{ run: "yarn install --frozen-lockfile" }]
+                        : []),
+                    {
+                        name: "Deploy to Faable",
+                        run: `npx @faable/faable deploy ${app_name}`,
+                    },
+                ],
+            },
+        },
+    };
+    await fs.writeFile(gh_action_file, yaml.stringify(action));
+    log.info(`Written ${gh_action_file}`);
+};
+
+export { writeGithubAction };

package/package.json

@@ -2,6 +2,7 @@
   "name": "@faable/faable",
   "main": "dist/index.js",
   "dependencies": {
+    "@actions/core": "^3.0.0",
     "axios": "^1.13.2",
     "fs-extra": "^11.3.2",
     "handlebars": "^4.7.8",
@@ -14,7 +15,7 @@
     "yaml": "^2.8.2",
     "yargs": "^18.0.0"
   },
-  "version": "1.5.15",
+  "version": "1.5.16",
   "bin": {
     "faable": "bin/faable.js"
   },

package/dist/commands/init/ConfigurationHelper.js

@@ -1,113 +0,0 @@
-import path__default from 'path';
-import fs from 'fs-extra';
-import { log } from '../../log.js';
-import prompts from 'prompts';
-import { CredentialsStore } from '../../lib/CredentialsStore.js';
-import yaml from 'yaml';
-
-class ConfigurationHelper {
-    store;
-    constructor() {
-        this.store = new CredentialsStore();
-    }
-    get workflows_dir() {
-        return path__default.join(process.cwd(), ".github", "workflows");
-    }
-    get default_action() {
-        return path__default.join(this.workflows_dir, "deploy.yml");
-    }
-    async demandConfig(force = false) {
-        const creds = await this.store.loadCredentials();
-        if (creds?.apikey) {
-            return;
-        }
-        const { apikey } = await prompts([
-            {
-                type: "text",
-                name: "apikey",
-                message: "What is your Faable ApiKey?",
-            },
-        ]);
-        await this.store.saveApiKey({ apikey });
-    }
-    async tentativeName() {
-        try {
-            const pkg = path__default.join(process.cwd(), "package.json");
-            const { name } = await fs.readJSON(pkg);
-            return name;
-        }
-        catch (error) {
-            return;
-        }
-    }
-    async checkPackageManager() {
-        if (fs.existsSync(path__default.join(process.cwd(), "package-lock.json"))) {
-            return "npm";
-        }
-        if (fs.existsSync(path__default.join(process.cwd(), "yarn.lock"))) {
-            return "yarn";
-        }
-        throw new Error("No package-lock.json or yarn.lock file found");
-    }
-    async initializeGithubAction(force = false) {
-        await this.demandConfig();
-        // Already configured
-        if (!force && fs.pathExistsSync(this.default_action)) {
-            log.info(`Github action is already configured.`);
-            return;
-        }
-        const onCancel = (prompt) => {
-            log.info("Cancel");
-            process.exit(0);
-        };
-        const { app_name } = await prompts([
-            {
-                type: "text",
-                name: "app_name",
-                initial: await this.tentativeName(),
-                message: "Which app are you deploying",
-            },
-        ], { onCancel });
-        const manager = await this.checkPackageManager();
-        const action = {
-            name: "Deploy to Faable",
-            on: {
-                push: {
-                    branches: ["main"],
-                },
-            },
-            env: {
-                FAABLE_APIKEY: "${{ secrets.FAABLE_APIKEY }}",
-            },
-            jobs: {
-                deploy: {
-                    "runs-on": "ubuntu-latest",
-                    steps: [
-                        { uses: "actions/checkout@v2" },
-                        { name: "Prepare CLI", run: "npm i -g @faable/faable" },
-                        {
-                            uses: "actions/setup-node@v3",
-                            with: {
-                                "node-version": "18",
-                                cache: manager,
-                            },
-                        },
-                        ...(manager == "npm" ? [{ run: "npm ci" }] : []),
-                        ...(manager == "yarn"
-                            ? [{ run: "yarn install --frozen-lockfile" }]
-                            : []),
-                        {
-                            name: "Deploy to Faable",
-                            run: `faable deploy ${app_name}`,
-                        },
-                    ],
-                },
-            },
-        };
-        await fs.writeFile(this.default_action, yaml.stringify(action));
-        log.info(`Written ${this.default_action}`);
-        log.info(`Remember to create FAABLE_APIKEY on Github repo secrets`);
-    }
-}
-
-export { ConfigurationHelper };