@linktr.ee/create-link-app 0.1.0 → 0.2.1

package/README.md

@@ -24,7 +24,7 @@ yarn create @linktr.ee/create-link-app my-link-app
 * [`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 help [COMMANDS]`](#create-link-app-help-commands)
 * [`create-link-app login`](#create-link-app-login)
 * [`create-link-app logout`](#create-link-app-logout)
 
@@ -46,7 +46,7 @@ Initialize a new Link App project
 
 ```
 USAGE
-  $ create-link-app create [NAME] [-t react|react-ts] [-p <value>]
+  $ create-link-app create NAME [-t react|react-ts] [-p <value>]
 
 ARGUMENTS
   NAME  Name of the Link App
@@ -112,7 +112,7 @@ Grant access to other developers to push updates for your Link App
 
 ```
 USAGE
-  $ create-link-app grant-access [LINK_APP_ID] [USERNAME]
+  $ create-link-app grant-access LINK_APP_ID USERNAME
 
 ARGUMENTS
   LINK_APP_ID  The Link App's ID you wish to grant access to
@@ -125,16 +125,16 @@ EXAMPLES
   $ create-link-app grant-access my-link-app friend
 ```
 
-## `create-link-app help [COMMAND]`
+## `create-link-app help [COMMANDS]`
 
 Display help for create-link-app.
 
 ```
 USAGE
-  $ create-link-app help [COMMAND] [-n]
+  $ create-link-app help [COMMANDS] [-n]
 
 ARGUMENTS
-  COMMAND  Command to show help for.
+  COMMANDS  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -143,7 +143,7 @@ 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)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
 
 ## `create-link-app login`
 

package/dist/commands/deploy.js

@@ -17,7 +17,7 @@ class Deploy extends base_1.default {
         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;
+        const url = `${flags.endpoint ?? appConfig.link_types_url}/link-types`;
         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`);

package/dist/commands/grant-access.js

@@ -12,7 +12,7 @@ class GrantAccess extends base_1.default {
         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 url = `${flags.endpoint ?? appConfig.link_types_url}/link-types/${args.link_app_id}/maintainers`;
         const maintainerDto = {
             username: args.username,
             is_owner: false,

package/dist/commands/logout.js

@@ -10,11 +10,11 @@ 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 { auth, logout_redirect_url } = 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}`;
+        const url = `${domain}/v2/logout?client_id=${client_id}&returnTo=${logout_redirect_url}`;
         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}`);

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

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
+const project_name_to_title_1 = __importDefault(require("./project-name-to-title"));
 // templates path relative to this module
 const BaseTemplatesDir = path_1.default.resolve(__dirname, '..', '..', '..', 'templates');
 const createProject = async (template, targetDir) => {
@@ -13,5 +14,9 @@ const createProject = async (template, targetDir) => {
     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`);
+    // update `name` field in project manifest
+    const manifest = await fs_extra_1.default.readJson(`${targetDir}/manifest.json`);
+    manifest.name = (0, project_name_to_title_1.default)(path_1.default.basename(targetDir));
+    await fs_extra_1.default.writeJson(`${targetDir}/manifest.json`, manifest, { spaces: 2 });
 };
 exports.default = createProject;

package/dist/lib/create/project-name-to-title.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Transforms hyphen or underscore separated name to title, e.g. 'cool-link' to 'Cool Link'.
+ */
+const projectNameToTitle = (name) => {
+    const words = name.split(/[-_]/);
+    const title = words.map((word) => `${word[0].toUpperCase()}${word.slice(1).toLowerCase()}`);
+    return title.join(' ');
+};
+exports.default = projectNameToTitle;

package/dist/lib/fetch-app-config.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 const fetchAppConfig = async (stage = 'production') => {
-    const configUrl = `https://link-types-assets.${stage}.linktr.ee/application-config/create-link-cli.json`;
+    const configUrl = `https://link-types-config.${stage}.linktr.ee/create-link-app.json`;
     try {
         const response = await axios_1.default.get(configUrl);
         return response.data;

package/dist/webpack/webpack.config.js

@@ -22,7 +22,9 @@ function default_1(env, options) {
         output: {
             publicPath: '',
             path: path_1.default.resolve(appDir, 'dist'),
-            assetModuleFilename: 'images/[hash][ext][query]',
+            assetModuleFilename: 'images/[hash].[contenthash][ext][query]',
+            chunkFilename: '[id].[contenthash].js',
+            filename: '[name].[contenthash].js',
         },
         module: {
             rules: [
@@ -40,8 +42,8 @@ function default_1(env, options) {
                     },
                 },
                 {
-                    test: /\.(png|jpe?g|gif)$/i,
-                    type: 'asset/resource',
+                    test: /\.(png|jpe?g|gif|svg)$/i,
+                    type: 'asset/inline', // <-- this builds all images into data URLs, is that what you want?
                 },
             ],
         },

package/oclif.manifest.json

@@ -1 +1,221 @@
-{"version":"0.1.0","commands":{"build":{"id":"build","description":"Build Link App project to static assets used for production","strict":true,"pluginName":"@linktr.ee/create-link-app","pluginAlias":"@linktr.ee/create-link-app","pluginType":"core","aliases":[],"flags":{"allow-any-origin":{"name":"allow-any-origin","type":"boolean","description":"Allow Link App iframe to be loadable from non-Linktree origins for debugging","hidden":true,"allowNo":false}},"args":[],"_globalFlags":{}},"create":{"id":"create","description":"Initialize a new Link App project","strict":true,"pluginName":"@linktr.ee/create-link-app","pluginAlias":"@linktr.ee/create-link-app","pluginType":"core","aliases":[],"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"],"flags":{"template":{"name":"template","type":"option","char":"t","description":"Template to use for the project","multiple":false,"options":["react","react-ts"],"default":"react-ts"},"path":{"name":"path","type":"option","char":"p","description":"Path to create the project in","multiple":false}},"args":[{"name":"name","description":"Name of the Link App","required":true}],"_globalFlags":{}},"deploy":{"id":"deploy","description":"Deploy your Link App and test it on Linktr.ee","strict":true,"pluginName":"@linktr.ee/create-link-app","pluginAlias":"@linktr.ee/create-link-app","pluginType":"core","aliases":[],"flags":{"path":{"name":"path","type":"option","char":"p","description":"Specify custom path to project directory","multiple":false},"update":{"name":"update","type":"boolean","description":"Push update for existing Link App","allowNo":false},"endpoint":{"name":"endpoint","type":"option","description":"Custom API endpoint to push assets to","hidden":true,"multiple":false},"qa":{"name":"qa","type":"boolean","description":"Use QA environment","hidden":true,"allowNo":false},"force-update":{"name":"force-update","type":"boolean","description":"Allow Link Type Admins to push updates to Link Apps in PUBLISHED state","hidden":true,"allowNo":false}},"args":[],"_globalFlags":{}},"dev":{"id":"dev","description":"Start development server for Link App project","strict":true,"pluginName":"@linktr.ee/create-link-app","pluginAlias":"@linktr.ee/create-link-app","pluginType":"core","aliases":[],"examples":["$ create-link-app dev","$ create-link-app dev --port 8000","$ create-link-app dev --https"],"flags":{"port":{"name":"port","type":"option","char":"p","description":"Development server listening port","multiple":false,"default":3000},"https":{"name":"https","type":"boolean","description":"Use HTTPS for development server","allowNo":false}},"args":[],"_globalFlags":{}},"grant-access":{"id":"grant-access","description":"Grant access to other developers to push updates for your Link App","strict":true,"pluginName":"@linktr.ee/create-link-app","pluginAlias":"@linktr.ee/create-link-app","pluginType":"core","aliases":[],"examples":["$ create-link-app grant-access my-link-app friend"],"flags":{"endpoint":{"name":"endpoint","type":"option","description":"Custom API endpoint to push assets to","hidden":true,"multiple":false},"qa":{"name":"qa","type":"boolean","description":"Use QA environment","hidden":true,"allowNo":false}},"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}],"_globalFlags":{}},"login":{"id":"login","description":"Login using your Linktree credentials to deploy Link Apps","strict":true,"pluginName":"@linktr.ee/create-link-app","pluginAlias":"@linktr.ee/create-link-app","pluginType":"core","aliases":[],"flags":{"qa":{"name":"qa","type":"boolean","description":"Use QA environment","hidden":true,"allowNo":false}},"args":[],"_globalFlags":{}},"logout":{"id":"logout","description":"Logout and clear browser session","strict":true,"pluginName":"@linktr.ee/create-link-app","pluginAlias":"@linktr.ee/create-link-app","pluginType":"core","aliases":[],"flags":{"qa":{"name":"qa","type":"boolean","description":"Use QA environment","hidden":true,"allowNo":false}},"args":[],"_globalFlags":{}}}}
+{
+  "version": "0.2.1",
+  "commands": {
+    "build": {
+      "id": "build",
+      "description": "Build Link App project to static assets used for production",
+      "strict": true,
+      "pluginName": "@linktr.ee/create-link-app",
+      "pluginAlias": "@linktr.ee/create-link-app",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "allow-any-origin": {
+          "name": "allow-any-origin",
+          "type": "boolean",
+          "description": "Allow Link App iframe to be loadable from non-Linktree origins for debugging",
+          "hidden": true,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "create": {
+      "id": "create",
+      "description": "Initialize a new Link App project",
+      "strict": true,
+      "pluginName": "@linktr.ee/create-link-app",
+      "pluginAlias": "@linktr.ee/create-link-app",
+      "pluginType": "core",
+      "aliases": [],
+      "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"
+      ],
+      "flags": {
+        "template": {
+          "name": "template",
+          "type": "option",
+          "char": "t",
+          "description": "Template to use for the project",
+          "multiple": false,
+          "options": [
+            "react",
+            "react-ts"
+          ],
+          "default": "react-ts"
+        },
+        "path": {
+          "name": "path",
+          "type": "option",
+          "char": "p",
+          "description": "Path to create the project in",
+          "multiple": false
+        }
+      },
+      "args": {
+        "name": {
+          "name": "name",
+          "description": "Name of the Link App",
+          "required": true
+        }
+      }
+    },
+    "deploy": {
+      "id": "deploy",
+      "description": "Deploy your Link App and test it on Linktr.ee",
+      "strict": true,
+      "pluginName": "@linktr.ee/create-link-app",
+      "pluginAlias": "@linktr.ee/create-link-app",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "path": {
+          "name": "path",
+          "type": "option",
+          "char": "p",
+          "description": "Specify custom path to project directory",
+          "multiple": false
+        },
+        "update": {
+          "name": "update",
+          "type": "boolean",
+          "description": "Push update for existing Link App",
+          "allowNo": false
+        },
+        "endpoint": {
+          "name": "endpoint",
+          "type": "option",
+          "description": "Custom API endpoint to push assets to",
+          "hidden": true,
+          "multiple": false
+        },
+        "qa": {
+          "name": "qa",
+          "type": "boolean",
+          "description": "Use QA environment",
+          "hidden": true,
+          "allowNo": false
+        },
+        "force-update": {
+          "name": "force-update",
+          "type": "boolean",
+          "description": "Allow Link Type Admins to push updates to Link Apps in PUBLISHED state",
+          "hidden": true,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "dev": {
+      "id": "dev",
+      "description": "Start development server for Link App project",
+      "strict": true,
+      "pluginName": "@linktr.ee/create-link-app",
+      "pluginAlias": "@linktr.ee/create-link-app",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ create-link-app dev",
+        "$ create-link-app dev --port 8000",
+        "$ create-link-app dev --https"
+      ],
+      "flags": {
+        "port": {
+          "name": "port",
+          "type": "option",
+          "char": "p",
+          "description": "Development server listening port",
+          "multiple": false,
+          "default": 3000
+        },
+        "https": {
+          "name": "https",
+          "type": "boolean",
+          "description": "Use HTTPS for development server",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "grant-access": {
+      "id": "grant-access",
+      "description": "Grant access to other developers to push updates for your Link App",
+      "strict": true,
+      "pluginName": "@linktr.ee/create-link-app",
+      "pluginAlias": "@linktr.ee/create-link-app",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ create-link-app grant-access my-link-app friend"
+      ],
+      "flags": {
+        "endpoint": {
+          "name": "endpoint",
+          "type": "option",
+          "description": "Custom API endpoint to push assets to",
+          "hidden": true,
+          "multiple": false
+        },
+        "qa": {
+          "name": "qa",
+          "type": "boolean",
+          "description": "Use QA environment",
+          "hidden": true,
+          "allowNo": false
+        }
+      },
+      "args": {
+        "link_app_id": {
+          "name": "link_app_id",
+          "description": "The Link App's ID you wish to grant access to",
+          "required": true
+        },
+        "username": {
+          "name": "username",
+          "description": "The Linktree username of the developer you wish to grant access to",
+          "required": true
+        }
+      }
+    },
+    "login": {
+      "id": "login",
+      "description": "Login using your Linktree credentials to deploy Link Apps",
+      "strict": true,
+      "pluginName": "@linktr.ee/create-link-app",
+      "pluginAlias": "@linktr.ee/create-link-app",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "qa": {
+          "name": "qa",
+          "type": "boolean",
+          "description": "Use QA environment",
+          "hidden": true,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "logout": {
+      "id": "logout",
+      "description": "Logout and clear browser session",
+      "strict": true,
+      "pluginName": "@linktr.ee/create-link-app",
+      "pluginAlias": "@linktr.ee/create-link-app",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "qa": {
+          "name": "qa",
+          "type": "boolean",
+          "description": "Use QA environment",
+          "hidden": true,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linktr.ee/create-link-app",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Create a Link App on Linktr.ee.",
   "license": "UNLICENSED",
   "author": "Linktree",
@@ -51,8 +51,8 @@
     "react-dom": "^17.0.2",
     "styled-components": "^5.3.5",
     "typescript": "^4.7.3",
-    "webpack": "^5.73.0",
-    "webpack-dev-server": "^4.9.2"
+    "webpack": "^5.75.0",
+    "webpack-dev-server": "^4.11.1"
   },
   "devDependencies": {
     "@oclif/test": "^2.1.0",

package/templates/react/src/index.jsx

@@ -1,17 +1,17 @@
-import React from 'react'
-import { Contact } from '@linktr.ee/ui-link-kit'
+import { Container, Description, Header } from '@linktr.ee/ui-link-kit'
+
+import logo from './images/logo.png'
 
 function App({ toggle, your_name, __linkUrl }) {
   return (
-    <Contact
-      loading={false}
-      heading={`Hello ${your_name}!`}
-      secondaryHeading="Congratulations, you now have a Linktree link!"
-      content=""
+    <Container
       primaryCta={toggle ? { label: 'Visit our UI docs for more info', href: 'https://blstrco.github.io/ui-link-kit/' } : null}
       secondaryCta={toggle ? { label: 'Original url for your Linktree link', href: __linkUrl } : null}
-      logo=""
-    />
+      logo={logo}
+    >
+      <Header heading={`Hello ${your_name}!`} secondaryHeading="Congratulations, you now have a Linktree link!" layout="hero" />
+      <Description>{your_name}</Description>
+    </Container>
   )
 }
 

package/templates/react-ts/src/index.tsx

@@ -10,7 +10,7 @@ function App({ toggle, your_name, __linkUrl }: SettingsData) {
       secondaryCta={toggle ? { label: 'Original url for your Linktree link', href: __linkUrl } : null}
       logo={logo}
     >
-      <Header heading={`Hello ${your_name}!`} secondaryHeading="Congratulations, you now have a Linktree link!" layout="banner" />
+      <Header heading={`Hello ${your_name}!`} secondaryHeading="Congratulations, you now have a Linktree link!" layout="hero" />
       <Description>{your_name}</Description>
     </Container>
   )

package/templates/react-ts/src/types/global.d.ts

@@ -2,3 +2,4 @@ declare module '*.jpg'
 declare module '*.png'
 declare module '*.jpeg'
 declare module '*.gif'
+declare module '*.svg'