create-feathersdev 0.11.0

package/CHANGELOG.md

@@ -0,0 +1,107 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [0.11.0](https://github.com/feathersdev/cloud/compare/v0.10.1...v0.11.0) (2025-05-25)
+
+
+### Features
+
+* Move CLI to create-feathersdev and update flows ([#279](https://github.com/feathersdev/cloud/issues/279)) ([3b7cb26](https://github.com/feathersdev/cloud/commit/3b7cb26a7170ceec5138243ca6016eed2cc10643))
+
+
+
+
+
+## [0.10.1](https://github.com/feathersdev/cloud/compare/v0.10.0...v0.10.1) (2025-05-16)
+
+
+### Bug Fixes
+
+* **cli:** Fix feathersdev/auth package reference ([#274](https://github.com/feathersdev/cloud/issues/274)) ([2a0d199](https://github.com/feathersdev/cloud/commit/2a0d199fbb9d4ab9408535f6844bcce0c9ae9563))
+
+
+
+
+
+# [0.10.0](https://github.com/feathersdev/cloud/compare/v0.9.1...v0.10.0) (2025-05-16)
+
+
+### Features
+
+* **auth:** Make type and class naming more consistent ([#273](https://github.com/feathersdev/cloud/issues/273)) ([8e5ce70](https://github.com/feathersdev/cloud/commit/8e5ce708e2ca995b7209cd4888e4a8d1bed29f38))
+
+
+
+
+
+## [0.9.1](https://github.com/feathersdev/cloud/compare/v0.9.0...v0.9.1) (2025-05-15)
+
+
+### Bug Fixes
+
+* Move to feathersdev/cli ([#272](https://github.com/feathersdev/cloud/issues/272)) ([7062262](https://github.com/feathersdev/cloud/commit/706226263db7b7f80f07200793559cf3e1988796))
+
+
+
+
+
+# [0.9.0](https://github.com/feathersdev/cloud/compare/v0.8.0...v0.9.0) (2025-05-15)
+
+
+### Features
+
+* Update to feathers.dev branding ([#270](https://github.com/feathersdev/cloud/issues/270)) ([475f925](https://github.com/feathersdev/cloud/commit/475f925fafe0072d8cdbe33009b5edee96f5a2de))
+
+
+
+
+
+# [0.8.0](https://github.com/feathersdev/cloud/compare/v0.7.3...v0.8.0) (2025-04-26)
+
+
+### Features
+
+* Refactor verification methods into services ([#268](https://github.com/feathersdev/cloud/issues/268)) ([28d05d0](https://github.com/feathersdev/cloud/commit/28d05d02e6e596652c5b32b1273768a43f343223))
+
+
+
+
+
+## [0.7.3](https://github.com/feathersdev/cloud/compare/v0.7.2...v0.7.3) (2024-12-20)
+
+**Note:** Version bump only for package @featherscloud/cli
+
+
+
+
+
+## [0.7.2](https://github.com/feathersdev/cloud/compare/v0.7.1...v0.7.2) (2024-12-16)
+
+
+### Bug Fixes
+
+* **cli:** Fix CLI NodeJS example name ([#244](https://github.com/feathersdev/cloud/issues/244)) ([726b113](https://github.com/feathersdev/cloud/commit/726b113ef925d64b3af8900405dc496c9e8a7565))
+
+
+
+
+
+## [0.7.1](https://github.com/feathersdev/cloud/compare/v0.7.0...v0.7.1) (2024-12-12)
+
+
+### Bug Fixes
+
+* Update CLI package publish config ([7984758](https://github.com/feathersdev/cloud/commit/7984758b661f6680762b34f6bb217111abc2bf71))
+
+
+
+
+
+# [0.7.0](https://github.com/feathersdev/cloud/compare/v0.6.5...v0.7.0) (2024-12-12)
+
+
+### Features
+
+* Feathers Cloud CLI ([#215](https://github.com/feathersdev/cloud/issues/215)) ([18b7010](https://github.com/feathersdev/cloud/commit/18b7010099c0be1e0ab7f2fa2262f87654c6c74b))

package/README.md

@@ -0,0 +1,3 @@
+# create-feathersdev
+
+The feathers.dev CLI

package/bin/feathersdev

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+'use strict'
+
+import chalk from 'chalk'
+import { generate } from '../esm/index.js'
+
+generate({
+  argv: process.argv.slice(2)
+})

package/esm/actions/app.js

@@ -0,0 +1,51 @@
+import { copyFiles, fromFile, prompt, toFile } from '@featherscloud/pinion';
+import chalk from 'chalk';
+import { withApplication } from '../flows/with-application.js';
+import { generateIntegration } from './integrate.js';
+const __dirname = new URL('.', import.meta.url).pathname;
+export function generateApp() {
+    return async (init) => Promise.resolve(init)
+        .then(prompt(ctx => ({
+        framework: {
+            type: 'list',
+            message: 'Which framework do you want to use?',
+            choices: [
+                { name: 'React', value: 'react' },
+                { name: 'Vue', value: 'vue' },
+                { name: 'Svelte', value: 'svelte' },
+                { name: `None (${chalk.gray('or any other framework.')})`, value: 'vanilla' },
+            ],
+            when: !ctx.framework,
+        },
+        folder: {
+            type: 'input',
+            message: 'What folder should the app be created in?',
+            default: ctx.selectedApplication?.name?.toLowerCase(),
+        },
+    })))
+        .then(copyFiles(fromFile(__dirname, '..', '..', 'examples', 'frontend', ctx => ctx.framework), toFile(ctx => ctx.folder)))
+        .then(ctx => ({
+        ...ctx,
+        integrationTypes: ['frontend'],
+        frontendFile: `${ctx.folder}/src/auth.ts`,
+    }))
+        .then(generateIntegration(true));
+}
+export function successMessage(ctx) {
+    return `
+Your feathers.dev app is now set up. 🚀
+
+Go to the ${chalk.gray(ctx.folder)} folder and install the dependencies with your package manager (e.g. ${chalk.gray('npm install')}).
+Then run the ${chalk.gray('dev')} script (e.g. ${chalk.gray('npm run dev')}) to start the development server.
+
+Visit ${chalk.blue.underline('https://app.feathers.dev')} to customize your login page and manage your users.
+`;
+}
+export function app(init) {
+    return Promise.resolve(init)
+        .then(withApplication)
+        .then(generateApp())
+        .then((ctx) => {
+        ctx.pinion.logger.log(successMessage(ctx));
+    });
+}

package/esm/actions/integrate.js

@@ -0,0 +1,80 @@
+import { readFile } from 'node:fs/promises';
+import { fromFile, getCallable, prompt, renderTemplate, toFile, when } from '@featherscloud/pinion';
+import chalk from 'chalk';
+import { withApplication } from '../flows/with-application.js';
+const __dirname = new URL('.', import.meta.url).pathname;
+export function replaceFromFile(file, replacements) {
+    return async (ctx) => {
+        const fileName = await getCallable(file, ctx);
+        const content = (await readFile(fileName)).toString();
+        const replace = await getCallable(replacements, ctx);
+        return Object.keys(replace).reduce((content, key) => content.replace(new RegExp(key, 'g'), replace[key]), content);
+    };
+}
+export function generateIntegration(force = false) {
+    return async (ctx) => Promise.resolve(ctx)
+        .then(prompt(ctx => ({
+        integrationTypes: {
+            type: 'checkbox',
+            message: 'Which integrations would you like to generate?',
+            choices: [
+                {
+                    name: `Frontend - ${chalk.gray('Make authenticated requests from the browser with any framework like React, VueJS, Svelte or Angular etc.')}`,
+                    checked: true,
+                    value: 'frontend',
+                },
+                {
+                    name: `Backend - ${chalk.gray('Verify authenticated requests in a NodeJS, Deno, Bun or Cloudflare Worker server')}`,
+                    checked: true,
+                    value: 'backend',
+                },
+            ],
+            when: !ctx.integrationTypes,
+        },
+    })))
+        .then(prompt((ctx) => ({
+        platform: {
+            type: 'list',
+            message: 'Which backend platform are you using?',
+            choices: [
+                { name: 'NodeJS', value: 'nodejs' },
+                { name: 'Deno', value: 'deno' },
+                { name: 'Bun', value: 'bun' },
+                { name: 'Cloudflare Workers', value: 'cloudflare' },
+                { name: 'Express', value: 'express' },
+            ],
+            when: !ctx.platform && ctx.integrationTypes.includes('backend'),
+        },
+    })))
+        .then(prompt(ctx => ({
+        frontendFile: {
+            type: 'input',
+            message: 'Where should the frontend integration file be saved?',
+            default: 'frontend/src/auth.ts',
+            when: !ctx.frontendFile && ctx.integrationTypes.includes('frontend'),
+        },
+        backendFile: {
+            type: 'input',
+            message: 'Where should the backend server integration file be saved?',
+            default: 'server/src/authenticate.ts',
+            when: !ctx.backendFile && ctx.integrationTypes.includes('backend'),
+        },
+    })))
+        .then(when(ctx => !!ctx.frontendFile, renderTemplate(replaceFromFile(fromFile(__dirname, '..', '..', 'examples', 'frontend', 'auth.ts'), { '<your-app-id>': ctx.selectedApplication.id }), toFile(ctx => ctx.frontendFile), { force })))
+        .then(when(ctx => !!ctx.backendFile, renderTemplate(replaceFromFile(fromFile(__dirname, '..', '..', 'examples', 'server', (ctx) => ctx.platform, 'src', 'authenticate.ts'), { '<your-app-id>': ctx.selectedApplication.id }), toFile(ctx => ctx.backendFile), { force })));
+}
+export const successMessage = `
+Your feathers.dev auth app is now integrated. 🚀
+Make sure to install the ${chalk.gray('@feathersdev/auth')} package using your your package manager.
+Have a look at the generated files for more information on how to use them.
+
+Go to ${chalk.blue.underline('https://app.feathers.dev')} to customize your login page and manage your users.
+`;
+export function integrate(init) {
+    return Promise.resolve(init)
+        .then(withApplication)
+        .then(generateIntegration())
+        .then((ctx) => {
+        ctx.pinion.logger.log(successMessage);
+    });
+}

package/esm/actions/login.js

@@ -0,0 +1,8 @@
+import { checkLogin } from '../flows/check-login.js';
+export function login(init) {
+    return Promise.resolve(init)
+        .then(checkLogin)
+        .then((ctx) => {
+        ctx.pinion.logger.notice('You are now logged in. Thank you for using feathers.dev');
+    });
+}

package/esm/actions/logout.js

@@ -0,0 +1,12 @@
+import { checkLogin } from '../flows/check-login.js';
+export function logout(init) {
+    return Promise.resolve(init)
+        .then(checkLogin)
+        .then(async (ctx) => {
+        await ctx.auth.logoutAndForget();
+        return ctx;
+    })
+        .then((ctx) => {
+        ctx.pinion.logger.notice('You are now logged out.');
+    });
+}

package/esm/actions/server.js

@@ -0,0 +1,52 @@
+import { copyFiles, fromFile, prompt, toFile } from '@featherscloud/pinion';
+import chalk from 'chalk';
+import { withApplication } from '../flows/with-application.js';
+import { generateIntegration } from './integrate.js';
+const __dirname = new URL('.', import.meta.url).pathname;
+export function generateServer() {
+    return async (init) => Promise.resolve(init)
+        .then(prompt(ctx => ({
+        platform: {
+            type: 'list',
+            message: 'Which server platform do you want to use?',
+            when: !ctx.platform,
+            choices: [
+                { name: 'Node', value: 'nodejs' },
+                { name: 'Deno', value: 'deno' },
+                { name: 'Bun', value: 'bun' },
+                { name: 'Cloudflare Workers', value: 'cloudflare' },
+                { name: 'Express', value: 'express' },
+            ],
+        },
+        folder: {
+            type: 'input',
+            message: 'What folder should the server be created in?',
+            default: ctx.selectedApplication?.name?.toLowerCase(),
+        },
+    })))
+        .then(copyFiles(fromFile(__dirname, '..', '..', 'examples', 'server', ctx => ctx.platform), toFile(ctx => ctx.folder)))
+        .then(ctx => ({
+        ...ctx,
+        integrationTypes: ['backend'],
+        backendFile: `${ctx.folder}/src/authenticate.ts`,
+    }))
+        .then(generateIntegration(true));
+}
+export function successMessage(ctx) {
+    return `
+Your example server with feathers.dev auth is now set up. 🚀
+
+Go to the ${chalk.gray(ctx.folder)} folder and install the dependencies with your package manager (e.g. ${chalk.gray('npm install')}).
+Then run the ${chalk.gray('start')} script (e.g. ${chalk.gray('npm start')}) to start the server.
+
+Visit ${chalk.blue.underline('https://app.feathers.dev')} to customize your login page and manage your users.
+`;
+}
+export function server(init) {
+    return Promise.resolve(init)
+        .then(withApplication)
+        .then(generateServer())
+        .then((ctx) => {
+        ctx.pinion.logger.log(successMessage(ctx));
+    });
+}

package/esm/base.js

@@ -0,0 +1,40 @@
+import { readFileSync } from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { getContext } from '@featherscloud/pinion';
+import { createApiClient, createClient } from '@feathersdev/auth';
+const __dirname = new URL('.', import.meta.url).pathname;
+// Read the package.json file
+export const packageJson = JSON.parse(readFileSync(path.join(__dirname, '..', 'package.json'), 'utf8'));
+// Map OS platform to browser-style OS string
+const osMapping = {
+    darwin: () => `Macintosh; Intel Mac OS X ${os.release()}`,
+    win32: () => `Windows NT ${os.release()}`,
+    linux: () => `X11; Linux ${os.arch()}`,
+};
+export function getUserAgent() {
+    const osInfo = osMapping[os.platform()]?.() || 'Unknown';
+    return `cli/${packageJson.version} (${osInfo})`;
+}
+export async function getBaseContext(options, init = {}) {
+    const ctx = getContext(init);
+    const { appId, store, apiUrl, referer } = options;
+    const api = createApiClient(apiUrl, {
+        'User-Agent': getUserAgent(),
+        'Referer': referer,
+    });
+    const auth = createClient({
+        appId,
+        store,
+        api,
+    });
+    const device = await auth.getDevice();
+    const user = await auth.getUser();
+    return {
+        ...ctx,
+        device,
+        auth,
+        user,
+        api,
+    };
+}

package/esm/flows/check-login.js

@@ -0,0 +1,70 @@
+import { prompt } from '@featherscloud/pinion';
+import { LoginRequiredError } from '@feathersdev/auth';
+import chalk from 'chalk';
+export async function performLogin(init) {
+    return Promise.resolve(init)
+        .then(prompt(ctx => ({
+        email: {
+            type: 'input',
+            message: 'What is your email address?',
+            default: ctx.user?.email,
+            when: !ctx.email,
+        },
+    })))
+        .then(async (ctx) => {
+        const credentials = await ctx.device.getCredentials();
+        const { id } = await ctx.api.service('verifications/email').create({
+            email: ctx.email,
+        }, {
+            headers: {
+                Authorization: `Bearer ${credentials}`,
+            },
+        });
+        return {
+            ...ctx,
+            credentials,
+            verificationId: id,
+        };
+    })
+        .then(prompt(ctx => ({
+        code: {
+            type: 'input',
+            message: `Please enter the verification code that was sent to ${chalk.bold(ctx.email)}`,
+            validate: async (code) => {
+                try {
+                    await ctx.api.service('verifications/email').update(ctx.verificationId, { code }, {
+                        headers: {
+                            Authorization: `Bearer ${ctx.credentials}`,
+                        },
+                    });
+                    return true;
+                }
+                catch (error) {
+                    return error.message;
+                }
+            },
+        },
+    })));
+}
+export async function checkLogin(ctx) {
+    try {
+        const authorization = await ctx.auth.getHeader();
+        const user = await ctx.auth.getUser();
+        if (ctx.email && ctx.email !== user?.email) {
+            throw new Error(`You are already logged in as ${user?.email}. Please log out first.`);
+        }
+        return {
+            ...ctx,
+            user,
+            authorization,
+        };
+    }
+    catch (error) {
+        if (error instanceof LoginRequiredError) {
+            return performLogin(ctx).then(checkLogin);
+        }
+        else {
+            throw error;
+        }
+    }
+}

package/esm/flows/with-application.js

@@ -0,0 +1,81 @@
+import { fromFile, loadJSON, prompt } from '@featherscloud/pinion';
+import chalk from 'chalk';
+import { withOrganization } from './with-organization.js';
+export async function createApplication(init) {
+    return Promise.resolve(init)
+        .then(loadJSON(fromFile('package.json'), pkg => ({ pkg }), {}))
+        .then(prompt(ctx => ({
+        appName: {
+            type: 'input',
+            message: 'What is the name of your application?',
+            default: ctx.pkg.name,
+        },
+        referers: {
+            type: 'input',
+            message: 'What are the allowed referers?',
+            suffix: chalk.white(' A comma separated list of URLs where your frontend is running'),
+            default: 'http://localhost:3030',
+        },
+    })))
+        .then(async (ctx) => {
+        const application = await ctx.api.service('applications').create({
+            name: ctx.appName,
+            organizationId: ctx.selectedOrganization.id,
+            referrers: ctx.referers.split(',').map(r => r.trim()),
+        }, {
+            headers: {
+                Authorization: ctx.authorization,
+            },
+        });
+        return {
+            ...ctx,
+            applications: [application],
+            selectedApplication: application,
+        };
+    });
+}
+export async function withApplication(init) {
+    return Promise.resolve(init)
+        .then(withOrganization)
+        .then(async (ctx) => {
+        const { data: applications } = await ctx.api.service('applications').find({
+            query: {
+                organizationId: ctx.selectedOrganization.id,
+            },
+            headers: {
+                Authorization: ctx.authorization,
+            },
+        });
+        return {
+            ...ctx,
+            applications,
+        };
+    })
+        .then(prompt(ctx => ({
+        selectedApplication: {
+            type: 'list',
+            message: 'Which application do you want to use?',
+            when: ctx.applications.length > 0,
+            choices: [
+                {
+                    name: 'Create a new application',
+                    value: '',
+                },
+                ...ctx.applications.map(app => ({
+                    name: app.name,
+                    value: app.id,
+                })),
+            ],
+        },
+    })))
+        .then(async (ctx) => {
+        if (!ctx.selectedApplication) {
+            return createApplication(ctx);
+        }
+        const app = ctx.applications.find(a => a.id === ctx.selectedApplication);
+        return {
+            ...ctx,
+            selectedApplication: app,
+        };
+    });
+}

package/esm/flows/with-organization.js

@@ -0,0 +1,74 @@
+import { prompt } from '@featherscloud/pinion';
+import { checkLogin } from './check-login.js';
+export async function createOrganization(init) {
+    return Promise.resolve(init)
+        .then(prompt(ctx => ({
+        orgName: {
+            type: 'input',
+            message: 'What is the name of your organization?',
+            default: ctx.user?.email && `${ctx.user.email.split('@')[0]}'s organization`,
+        },
+        replyToEmail: {
+            type: 'input',
+            message: 'What is the email address for your organization?',
+            default: ctx.user?.email,
+        },
+    })))
+        .then(async (ctx) => {
+        const { orgName: name, replyToEmail } = ctx;
+        const organization = await ctx.api.service('organizations').create({ name, replyToEmail }, {
+            headers: {
+                Authorization: ctx.authorization,
+            },
+        });
+        return {
+            ...ctx,
+            organizations: [organization],
+            selectedOrganization: organization,
+        };
+    });
+}
+export async function withOrganization(init) {
+    return Promise.resolve(init)
+        .then(checkLogin)
+        .then(async (ctx) => {
+        const { data: organizations } = await ctx.api.service('organizations').find({
+            headers: {
+                Authorization: ctx.authorization,
+            },
+        });
+        return {
+            ...ctx,
+            organizations,
+        };
+    })
+        .then(async (ctx) => {
+        if (ctx.organizations.length === 0) {
+            return createOrganization(ctx);
+        }
+        if (ctx.organizations.length > 1) {
+            return Promise.resolve(ctx)
+                .then(prompt(ctx => ({
+                selectedOrganization: {
+                    type: 'list',
+                    message: 'Which organizations do you want to use?',
+                    choices: ctx.organizations.map(organization => ({
+                        name: organization.name,
+                        value: organization.id,
+                    })),
+                },
+            })))
+                .then((ctx) => {
+                const org = ctx.organizations.find(organization => organization.id === ctx.selectedOrganization);
+                return {
+                    ...ctx,
+                    selectedOrganization: org,
+                };
+            });
+        }
+        return {
+            ...ctx,
+            selectedOrganization: ctx.organizations[0],
+        };
+    });
+}

package/esm/index.js

@@ -0,0 +1,55 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { Command, commander } from '@featherscloud/pinion';
+import { createFileStore } from '@feathersdev/auth';
+import { app } from './actions/app.js';
+import { integrate } from './actions/integrate.js';
+import { login } from './actions/login.js';
+import { logout } from './actions/logout.js';
+import { server } from './actions/server.js';
+import { getBaseContext, packageJson } from './base.js';
+const __dirname = new URL('.', import.meta.url).pathname;
+const apiUrl = 'https://api.feathers.dev';
+const referer = 'https://app.feathers.dev';
+const appId = 'did:key:z6MkheUYC6euEMuZjL84CixXgRmPfciuYXhz51D85WT3fC5T';
+// const apiUrl = 'http://localhost:8787'
+// const referer = 'http://localhost:3000'
+// const appId = ''
+const store = createFileStore(fs, path.join(__dirname, '..', '.auth.json'));
+export const options = {
+    apiUrl,
+    referer,
+    appId,
+    store,
+};
+export function generate(initialContext) {
+    const program = new Command()
+        .description('The feathers.dev CLI')
+        .option('-e, --email <email>', 'Email address to log in with')
+        .option('-p, --platform <platform>', 'The server platform to use (node, deno, bun, cloudflare, express)')
+        .option('-f, --framework <framework>', 'The frontend framework to use (react, vue, svelte, vanilla)')
+        .version(packageJson.version)
+        .showHelpAfterError();
+    const init = getBaseContext(options, initialContext).then(commander(program));
+    program
+        .command('app')
+        .description('Create a new feathers.dev application')
+        .action(() => init.then(app));
+    program
+        .command('server')
+        .description('Create an example NodeJS, Deno, Bun or Cloudflare Worker server')
+        .action(() => init.then(server));
+    program
+        .command('integrate')
+        .description('Integrate feathers.dev into an existing frontend or server')
+        .action(() => init.then(integrate));
+    program
+        .command('login')
+        .description('Log in with your email address')
+        .action(() => init.then(login));
+    program
+        .command('logout')
+        .description('Log out from the CLI')
+        .action(() => init.then(logout));
+    return program;
+}

package/esm/package.json

@@ -0,0 +1 @@
+{ "type": "module" }