@linktr.ee/create-link-app 0.1.0

package/README.md

@@ -0,0 +1,171 @@
+# @linktr.ee/create-link-app
+
+CLI tool to create [Link Apps](https://linktr.ee/marketplace) on [Linktr.ee](https://linktr.ee).
+
+## Getting Started
+
+Create a project with either npm:
+
+```sh
+npm init @linktr.ee/create-link-app my-link-app
+```
+
+Or Yarn:
+
+```sh
+yarn create @linktr.ee/create-link-app my-link-app
+```
+
+## Commands
+
+<!-- commands -->
+* [`create-link-app build`](#create-link-app-build)
+* [`create-link-app create NAME`](#create-link-app-create-name)
+* [`create-link-app deploy`](#create-link-app-deploy)
+* [`create-link-app dev`](#create-link-app-dev)
+* [`create-link-app grant-access LINK_APP_ID USERNAME`](#create-link-app-grant-access-link_app_id-username)
+* [`create-link-app help [COMMAND]`](#create-link-app-help-command)
+* [`create-link-app login`](#create-link-app-login)
+* [`create-link-app logout`](#create-link-app-logout)
+
+## `create-link-app build`
+
+Build Link App project to static assets used for production
+
+```
+USAGE
+  $ create-link-app build
+
+DESCRIPTION
+  Build Link App project to static assets used for production
+```
+
+## `create-link-app create NAME`
+
+Initialize a new Link App project
+
+```
+USAGE
+  $ create-link-app create [NAME] [-t react|react-ts] [-p <value>]
+
+ARGUMENTS
+  NAME  Name of the Link App
+
+FLAGS
+  -p, --path=<value>       Path to create the project in
+  -t, --template=<option>  [default: react-ts] Template to use for the project
+                           <options: react|react-ts>
+
+DESCRIPTION
+  Initialize a new Link App project
+
+EXAMPLES
+  $ create-link-app create my-link-app
+
+  $ create-link-app create my-link-app --template react
+
+  $ create-link-app create my-link-app --path my/custom/path
+```
+
+## `create-link-app deploy`
+
+Deploy your Link App and test it on Linktr.ee
+
+```
+USAGE
+  $ create-link-app deploy [-p <value>] [--update]
+
+FLAGS
+  -p, --path=<value>  Specify custom path to project directory
+  --update            Push update for existing Link App
+
+DESCRIPTION
+  Deploy your Link App and test it on Linktr.ee
+```
+
+## `create-link-app dev`
+
+Start development server for Link App project
+
+```
+USAGE
+  $ create-link-app dev [-p <value>] [--https]
+
+FLAGS
+  -p, --port=<value>  [default: 3000] Development server listening port
+  --https             Use HTTPS for development server
+
+DESCRIPTION
+  Start development server for Link App project
+
+EXAMPLES
+  $ create-link-app dev
+
+  $ create-link-app dev --port 8000
+
+  $ create-link-app dev --https
+```
+
+## `create-link-app grant-access LINK_APP_ID USERNAME`
+
+Grant access to other developers to push updates for your Link App
+
+```
+USAGE
+  $ create-link-app grant-access [LINK_APP_ID] [USERNAME]
+
+ARGUMENTS
+  LINK_APP_ID  The Link App's ID you wish to grant access to
+  USERNAME     The Linktree username of the developer you wish to grant access to
+
+DESCRIPTION
+  Grant access to other developers to push updates for your Link App
+
+EXAMPLES
+  $ create-link-app grant-access my-link-app friend
+```
+
+## `create-link-app help [COMMAND]`
+
+Display help for create-link-app.
+
+```
+USAGE
+  $ create-link-app help [COMMAND] [-n]
+
+ARGUMENTS
+  COMMAND  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for create-link-app.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_
+
+## `create-link-app login`
+
+Login using your Linktree credentials to deploy Link Apps
+
+```
+USAGE
+  $ create-link-app login
+
+DESCRIPTION
+  Login using your Linktree credentials to deploy Link Apps
+```
+
+## `create-link-app logout`
+
+Logout and clear browser session
+
+```
+USAGE
+  $ create-link-app logout
+
+DESCRIPTION
+  Logout and clear browser session
+```
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({ project })
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/dist/base.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const fetch_app_config_1 = __importDefault(require("./lib/fetch-app-config"));
+class default_1 extends core_1.Command {
+    async getAppConfig(stage = 'production') {
+        return await (0, fetch_app_config_1.default)(stage);
+    }
+    async init() {
+        core_1.CliUx.ux.styledHeader(`${this.config.name}@${this.config.version}`);
+    }
+}
+exports.default = default_1;

package/dist/commands/build.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const webpack_1 = __importDefault(require("webpack"));
+const base_1 = __importDefault(require("../base"));
+const webpack_config_1 = __importDefault(require("../webpack/webpack.config"));
+class Build extends base_1.default {
+    async run() {
+        const { flags } = await this.parse(Build);
+        (0, webpack_1.default)((0, webpack_config_1.default)('production', {
+            allowAnyOrigin: flags['allow-any-origin'],
+        }), (err, stats) => {
+            if (err) {
+                this.error(err);
+            }
+            else if (stats?.hasErrors()) {
+                this.error(stats.toString());
+            }
+            else if (stats?.hasWarnings()) {
+                this.warn(stats.toString());
+            }
+        });
+    }
+}
+exports.default = Build;
+Build.description = 'Build Link App project to static assets used for production';
+Build.flags = {
+    'allow-any-origin': core_1.Flags.boolean({
+        description: 'Allow Link App iframe to be loadable from non-Linktree origins for debugging',
+        hidden: true,
+    }),
+};

package/dist/commands/create.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const path_1 = __importDefault(require("path"));
+const base_1 = __importDefault(require("../base"));
+const create_project_1 = __importDefault(require("../lib/create/create-project"));
+const install_dependencies_1 = __importDefault(require("../lib/create/install-dependencies"));
+const is_using_yarn_1 = __importDefault(require("../lib/create/is-using-yarn"));
+class Create extends base_1.default {
+    async run() {
+        const { args, flags } = await this.parse(Create);
+        const targetDir = path_1.default.resolve(flags.path ?? process.cwd(), args.name);
+        this.log(`🔗 Creating project in ${targetDir}...`);
+        await (0, create_project_1.default)(flags.template, targetDir);
+        const useYarn = (0, is_using_yarn_1.default)();
+        core_1.CliUx.ux.action.start('🚚 Installing dependencies');
+        (0, install_dependencies_1.default)(targetDir, useYarn);
+        core_1.CliUx.ux.action.stop();
+        const relativeProjectPath = path_1.default.relative(process.cwd(), targetDir);
+        this.log('✅ Project created, to get started:\n');
+        this.log(`    cd ${relativeProjectPath}`);
+        this.log(`    ${useYarn ? 'yarn dev' : 'npm run dev'}\n`);
+    }
+}
+exports.default = Create;
+Create.description = 'Initialize a new Link App project';
+Create.examples = [
+    '$ create-link-app create my-link-app',
+    '$ create-link-app create my-link-app --template react',
+    '$ create-link-app create my-link-app --path my/custom/path',
+];
+Create.args = [
+    {
+        name: 'name',
+        description: 'Name of the Link App',
+        required: true,
+    },
+];
+Create.flags = {
+    template: core_1.Flags.string({
+        char: 't',
+        description: 'Template to use for the project',
+        options: ['react', 'react-ts'],
+        default: 'react-ts',
+    }),
+    path: core_1.Flags.string({
+        char: 'p',
+        description: 'Path to create the project in',
+    }),
+};

package/dist/commands/deploy.js

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const axios_1 = __importDefault(require("axios"));
+const base_1 = __importDefault(require("../base"));
+const access_token_1 = require("../lib/auth/access-token");
+const pack_project_1 = __importDefault(require("../lib/deploy/pack-project"));
+const upload_assets_1 = __importDefault(require("../lib/deploy/upload-assets"));
+const create_form_data_1 = __importDefault(require("../lib/deploy/create-form-data"));
+class Deploy extends base_1.default {
+    async run() {
+        const { flags } = await this.parse(Deploy);
+        const appConfig = await this.getAppConfig(flags.qa ? 'qa' : 'production');
+        const accessToken = (0, access_token_1.getAccessToken)(appConfig.auth.audience);
+        await (0, pack_project_1.default)();
+        const form = (0, create_form_data_1.default)(flags.path);
+        const url = flags.endpoint ?? appConfig.linkTypesUrl;
+        try {
+            const result = await (0, upload_assets_1.default)(url, form, accessToken, flags.update, flags['force-update']);
+            this.log(`Draft Link App successfully ${flags.update ? 'updated' : 'uploaded'}\n`);
+            this.log(JSON.stringify(result, null, 2));
+        }
+        catch (err) {
+            this.log('There was an error while uploading Link App assets\n');
+            if (axios_1.default.isAxiosError(err)) {
+                if (err.response) {
+                    this.error(JSON.stringify(err.response.data, null, 2));
+                }
+                this.error(err.message);
+            }
+            throw err;
+        }
+    }
+}
+exports.default = Deploy;
+Deploy.description = 'Deploy your Link App and test it on Linktr.ee';
+Deploy.flags = {
+    path: core_1.Flags.string({
+        char: 'p',
+        description: 'Specify custom path to project directory',
+    }),
+    update: core_1.Flags.boolean({
+        description: 'Push update for existing Link App',
+    }),
+    endpoint: core_1.Flags.string({
+        description: 'Custom API endpoint to push assets to',
+        hidden: true,
+    }),
+    qa: core_1.Flags.boolean({
+        description: 'Use QA environment',
+        hidden: true,
+    }),
+    'force-update': core_1.Flags.boolean({
+        description: 'Allow Link Type Admins to push updates to Link Apps in PUBLISHED state',
+        hidden: true,
+    }),
+};

package/dist/commands/dev.js

@@ -0,0 +1,37 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const webpack_1 = __importDefault(require("webpack"));
+const webpack_dev_server_1 = __importDefault(require("webpack-dev-server"));
+const base_1 = __importDefault(require("../base"));
+const webpack_config_1 = __importDefault(require("../webpack/webpack.config"));
+class Dev extends base_1.default {
+    async run() {
+        const { flags } = await this.parse(Dev);
+        const devServer = new webpack_dev_server_1.default({
+            client: {
+                overlay: false,
+            },
+            hot: false,
+            https: flags.https,
+            port: flags.port,
+        }, (0, webpack_1.default)((0, webpack_config_1.default)('development')));
+        await devServer.start();
+    }
+}
+exports.default = Dev;
+Dev.description = 'Start development server for Link App project';
+Dev.examples = ['$ create-link-app dev', '$ create-link-app dev --port 8000', '$ create-link-app dev --https'];
+Dev.flags = {
+    port: core_1.Flags.integer({
+        char: 'p',
+        description: 'Development server listening port',
+        default: 3000,
+    }),
+    https: core_1.Flags.boolean({
+        description: 'Use HTTPS for development server',
+    }),
+};

package/dist/commands/grant-access.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const axios_1 = __importDefault(require("axios"));
+const base_1 = __importDefault(require("../base"));
+const access_token_1 = require("../lib/auth/access-token");
+class GrantAccess extends base_1.default {
+    async run() {
+        const { args, flags } = await this.parse(GrantAccess);
+        const appConfig = await this.getAppConfig(flags.qa ? 'qa' : 'production');
+        const accessToken = (0, access_token_1.getAccessToken)(appConfig.auth.audience);
+        const url = `${flags.endpoint ?? appConfig.linkTypesUrl}/${args.link_app_id}/maintainers`;
+        const maintainerDto = {
+            username: args.username,
+            is_owner: false,
+        };
+        const headers = {
+            'Content-Type': 'application/json',
+            Authorization: `Bearer ${accessToken}`,
+        };
+        try {
+            await axios_1.default.post(url, maintainerDto, { headers });
+            this.log(`Successfully granted maintainer access to user '${args.username}'\n`);
+        }
+        catch (err) {
+            this.log('There was an error while attempting to grant access to user\n');
+            if (axios_1.default.isAxiosError(err)) {
+                if (err.response) {
+                    this.error(JSON.stringify(err.response.data, null, 2));
+                }
+                this.error(err.message);
+            }
+            throw err;
+        }
+    }
+}
+exports.default = GrantAccess;
+GrantAccess.description = 'Grant access to other developers to push updates for your Link App';
+GrantAccess.examples = ['$ create-link-app grant-access my-link-app friend'];
+GrantAccess.args = [
+    {
+        name: 'link_app_id',
+        description: "The Link App's ID you wish to grant access to",
+        required: true,
+    },
+    {
+        name: 'username',
+        description: 'The Linktree username of the developer you wish to grant access to',
+        required: true,
+    },
+];
+GrantAccess.flags = {
+    endpoint: core_1.Flags.string({
+        description: 'Custom API endpoint to push assets to',
+        hidden: true,
+    }),
+    qa: core_1.Flags.boolean({
+        description: 'Use QA environment',
+        hidden: true,
+    }),
+};

package/dist/commands/login.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const base_1 = __importDefault(require("../base"));
+const access_token_1 = require("../lib/auth/access-token");
+const device_auth_1 = require("../lib/auth/device-auth");
+class Login extends base_1.default {
+    async run() {
+        const { flags } = await this.parse(Login);
+        const appConfig = await this.getAppConfig(flags.qa ? 'qa' : 'production');
+        const handle = await (0, device_auth_1.initDeviceAuthorization)(appConfig.auth);
+        const { expires_in, user_code, verification_uri_complete } = handle;
+        const expiryTime = expires_in % 60 === 0 ? `${expires_in / 60} minutes` : `${expires_in} seconds`;
+        this.log(`Please login via the opened web browser link. The browser window should display the following code: ${user_code}`);
+        this.log(`If browser does not open automatically, please go to the following link: ${verification_uri_complete}`);
+        this.log(`This link expires in ${expiryTime}. Press Ctrl-C to abort.\n`);
+        core_1.CliUx.ux.open(verification_uri_complete);
+        core_1.CliUx.ux.action.start('Waiting for user to authorize device from browser');
+        const token = await (0, device_auth_1.pollAccessToken)(handle);
+        core_1.CliUx.ux.action.stop();
+        if ((0, access_token_1.isTokenValid)(token)) {
+            (0, access_token_1.saveAccessToken)(token.access_token);
+            this.log('\nDevice has been authorized. Login successful.');
+            if (token.expires_at) {
+                this.log(`Login will expire at ${new Date(token.expires_at * 1000).toString()}\n`);
+            }
+        }
+    }
+}
+exports.default = Login;
+Login.description = 'Login using your Linktree credentials to deploy Link Apps';
+Login.flags = {
+    qa: core_1.Flags.boolean({
+        description: 'Use QA environment',
+        hidden: true,
+    }),
+};

package/dist/commands/logout.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const base_1 = __importDefault(require("../base"));
+const access_token_1 = require("../lib/auth/access-token");
+class Logout extends base_1.default {
+    async run() {
+        const { flags } = await this.parse(Logout);
+        const appConfig = await this.getAppConfig(flags.qa ? 'qa' : 'production');
+        const { auth, logoutUrl } = appConfig;
+        const { domain, client_id, audience } = auth;
+        (0, access_token_1.removeAccessToken)(audience);
+        // clear Auth0 session cookies so user gets prompted to enter credentials again for next login
+        const url = `${domain}/v2/logout?client_id=${client_id}&returnTo=${logoutUrl}`;
+        core_1.CliUx.ux.open(url);
+        this.log('Logout successful.');
+        this.log(`If browser did not open automatically, please go to the following link to logout from the browser: ${url}`);
+    }
+}
+exports.default = Logout;
+Logout.description = 'Logout and clear browser session';
+Logout.flags = {
+    qa: core_1.Flags.boolean({
+        description: 'Use QA environment',
+        hidden: true,
+    }),
+};

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/dist/lib/auth/access-token.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAccessToken = exports.removeAccessToken = exports.saveAccessToken = exports.isTokenValid = void 0;
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const netrc_parser_1 = __importDefault(require("netrc-parser"));
+const TokenExpiryThresholdSeconds = 60; // Used to consider tokens as 'expired' within the last x seconds of its actual expiry to ensure slow requests still use a valid token
+function isTokenValid(token) {
+    if (!token.access_token || token.token_type !== 'Bearer') {
+        throw new Error('Received access token is invalid');
+    }
+    const payload = jsonwebtoken_1.default.decode(token.access_token, { json: true });
+    if (!payload) {
+        throw new Error('There was an error parsing the access token, please try logging in again');
+    }
+    const permissions = payload.permissions ?? [];
+    if (permissions.length === 0) {
+        throw new Error('Login request was successful, but the authenticated user does not have appropriate permissions to view or modify Link Apps');
+    }
+    return true;
+}
+exports.isTokenValid = isTokenValid;
+function saveAccessToken(tokenString) {
+    const token = jsonwebtoken_1.default.decode(tokenString, { json: true });
+    const audience = token?.aud;
+    if (audience && typeof audience === 'string') {
+        netrc_parser_1.default.loadSync();
+        netrc_parser_1.default.machines[audience] = {
+            login: 'authToken',
+            password: tokenString,
+        };
+        netrc_parser_1.default.saveSync();
+    }
+    else {
+        throw new Error('Error whilst trying to save access token, please try logging in again');
+    }
+}
+exports.saveAccessToken = saveAccessToken;
+function removeAccessToken(audience) {
+    netrc_parser_1.default.loadSync();
+    netrc_parser_1.default.machines[audience] = {
+        login: undefined,
+        password: undefined,
+    };
+    netrc_parser_1.default.saveSync();
+}
+exports.removeAccessToken = removeAccessToken;
+function getAccessToken(audience) {
+    netrc_parser_1.default.loadSync();
+    const tokenString = netrc_parser_1.default.machines[audience]?.login === 'authToken' ? netrc_parser_1.default.machines[audience].password : undefined;
+    if (!tokenString) {
+        throw new Error('Not logged in. Please login using command: login');
+    }
+    else {
+        const token = jsonwebtoken_1.default.decode(tokenString, { json: true });
+        if (!token?.exp) {
+            throw new Error('Cached login token is invalid. Please login again using command: login');
+        }
+        else if (token.exp - TokenExpiryThresholdSeconds < Math.floor(Date.now() / 1000)) {
+            throw new Error('Login expired. Please login again using command: login');
+        }
+        return tokenString;
+    }
+}
+exports.getAccessToken = getAccessToken;

package/dist/lib/auth/device-auth.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pollAccessToken = exports.initDeviceAuthorization = void 0;
+const openid_client_1 = require("openid-client");
+async function initDeviceAuthorization(config) {
+    const { domain, client_id, audience } = config;
+    const auth0Issuer = await openid_client_1.Issuer.discover(domain);
+    const client = new auth0Issuer.Client({
+        client_id,
+        token_endpoint_auth_method: 'none',
+    });
+    return await client.deviceAuthorization({ scope: '', audience });
+}
+exports.initDeviceAuthorization = initDeviceAuthorization;
+async function pollAccessToken(handle) {
+    try {
+        return await handle.poll();
+    }
+    catch (err) {
+        if (err instanceof openid_client_1.errors.OPError) {
+            throw new Error(err.error_description);
+        }
+        throw err;
+    }
+}
+exports.pollAccessToken = pollAccessToken;

package/dist/lib/create/create-project.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+// templates path relative to this module
+const BaseTemplatesDir = path_1.default.resolve(__dirname, '..', '..', '..', 'templates');
+const createProject = async (template, targetDir) => {
+    const templateDir = path_1.default.resolve(BaseTemplatesDir, template);
+    const templateCommonDir = path_1.default.resolve(BaseTemplatesDir, 'common');
+    await fs_extra_1.default.copy(templateDir, targetDir);
+    await fs_extra_1.default.copy(templateCommonDir, targetDir);
+    await fs_extra_1.default.move(`${targetDir}/gitignore`, `${targetDir}/.gitignore`);
+};
+exports.default = createProject;