@linktr.ee/create-link-app 1.5.1 → 1.7.3

package/dist/commands/build.js

@@ -19,6 +19,7 @@ class Build extends base_1.default {
                 allowAnyOrigin: flags['allow-any-origin'],
             });
         }
+        this.log('🎉 Build complete');
     }
     async webpack(options) {
         const config = await (0, webpack_config_1.default)('production', options);

package/dist/commands/deploy.js

@@ -23,7 +23,8 @@ class Deploy extends base_1.default {
         const accessToken = (0, access_token_1.getAccessToken)(appConfig.auth.audience);
         const linkTypeServiceUrl = `${flags.endpoint ?? appConfig.link_types_url}/link-types`;
         const isForceUpdate = !!flags['force-update'];
-        const packedFiles = await (0, pack_project_1.default)();
+        const isQa = !!flags.qa;
+        const packedFiles = await (0, pack_project_1.default)(flags.path);
         this.log(`\n===`);
         if (isForceUpdate) {
             this.log('⚠️  "--force-update" flag will impact the existing PUBLISHED Link Apps.\n');
@@ -34,10 +35,12 @@ class Deploy extends base_1.default {
                 this.log(`  - ${file}`);
             });
         }
-        const userConfirmDeploy = await core_1.CliUx.ux.prompt(`❓ Do you want to proceed? (Y/n)`, { required: false });
-        if (userConfirmDeploy?.toLowerCase() !== 'y') {
-            this.log('Aborted!');
-            return;
+        if (!flags['skip-confirm']) {
+            const userConfirmDeploy = await core_1.CliUx.ux.prompt(`❓ ${isQa ? '[QA]' : ''} Do you want to proceed? (Y/n)`, { required: false });
+            if (userConfirmDeploy?.toLowerCase() !== 'y') {
+                this.log('Aborted!');
+                return;
+            }
         }
         const form = (0, create_form_data_1.default)(flags.path);
         let linkTypeErrorCode = null;
@@ -93,7 +96,7 @@ class Deploy extends base_1.default {
         this.log(`\n===`);
         this.log(JSON.stringify(result, null, 2));
         const linkTypeId = result.linkType.linkTypeId;
-        const buildId = result.build.id;
+        const buildId = result.build?.id;
         const linkAppBuildUrl = flags.qa
             ? `https://buildkite.com/linktree/link-types-ci-service/builds/${buildId}`
             : `https://linkapp-ci.replit.app/?linkTypeId=${linkTypeId}&buildId=${buildId}`;
@@ -103,7 +106,9 @@ class Deploy extends base_1.default {
         this.log(`\n===`);
         this.log(`✅ Draft Link App successfully ${flags.update ? 'updated' : 'uploaded'}`);
         this.log(` - Link App ID: ${linkTypeId}`);
-        this.log(` - Check Link App build: ${linkAppBuildUrl}`);
+        if (buildId) {
+            this.log(` - Check Link App build: ${linkAppBuildUrl}`);
+        }
         this.log(` - Create Link App: ${linkAppCreateUrl}`);
     }
 }
@@ -130,4 +135,8 @@ Deploy.flags = {
         description: 'Allow Link Type Admins to push updates to Link Apps in PUBLISHED state. Admin use only.',
         hidden: true,
     }),
+    'skip-confirm': core_1.Flags.boolean({
+        description: 'Skip confirmation prompt',
+        hidden: true,
+    }),
 };

package/dist/lib/deploy/pack-project.js

@@ -32,13 +32,21 @@ const path_1 = __importDefault(require("path"));
 /**
  * Pack the Link App source files into `package.tgz`. This includes the above required/optional directories and files.
  */
-async function packProject() {
-    const requiredDirs = ['src'];
-    const requiredFiles = ['package.json', 'manifest.json'];
-    const optionalFiles = ['package-lock.json', 'yarn.lock', 'tsconfig.json', 'url-match-rules.json', 'settings.json', 'icon.svg'];
+async function packProject(givenPath) {
+    const requiredFiles = ['manifest.json'];
+    const optionalDirs = ['src']; // For legacy LinkApp, it could have no src code.
+    const optionalFiles = [
+        'package.json',
+        'package-lock.json',
+        'yarn.lock',
+        'tsconfig.json',
+        'url_match_rules.json',
+        'settings.json',
+        'icon.svg',
+    ];
     const packedFiles = [];
     await new Promise((resolve, reject) => {
-        const outputPath = resolveProjPath('package.tgz');
+        const outputPath = resolveProjPath(givenPath, 'package.tgz');
         const outputWriteStream = fs_1.default.createWriteStream(outputPath);
         const handleSuccess = () => resolve();
         const handleFailure = (err) => {
@@ -59,29 +67,28 @@ async function packProject() {
         });
         archive.pipe(outputWriteStream);
         requiredFiles.forEach((fileName) => {
-            if (!fs_1.default.existsSync(resolveProjPath(fileName))) {
+            if (!fs_1.default.existsSync(resolveProjPath(givenPath, fileName))) {
                 handleFailure(new archiver_1.ArchiverError(`File ${fileName} does not exist`, 'ENOENT'));
             }
-            archive.file(resolveProjPath(fileName), { name: fileName });
+            archive.file(resolveProjPath(givenPath, fileName), { name: fileName });
             packedFiles.push(fileName);
         });
         optionalFiles.forEach((fileName) => {
-            if (fs_1.default.existsSync(resolveProjPath(fileName))) {
-                archive.file(resolveProjPath(fileName), { name: fileName });
+            if (fs_1.default.existsSync(resolveProjPath(givenPath, fileName))) {
+                archive.file(resolveProjPath(givenPath, fileName), { name: fileName });
                 packedFiles.push(fileName);
             }
         });
-        requiredDirs.forEach((dirName) => {
-            if (!fs_1.default.existsSync(resolveProjPath(dirName)) || !fs_1.default.statSync(resolveProjPath(dirName)).isDirectory()) {
-                handleFailure(new archiver_1.ArchiverError(`Directory ${dirName} does not exist`, 'ENOENT'));
+        optionalDirs.forEach((dirName) => {
+            if (fs_1.default.existsSync(resolveProjPath(givenPath, dirName)) && fs_1.default.statSync(resolveProjPath(givenPath, dirName)).isDirectory()) {
+                archive.directory(resolveProjPath(givenPath, `${dirName}/`), dirName);
+                packedFiles.push(`${dirName}/`);
             }
-            archive.directory(resolveProjPath(`${dirName}/`), dirName);
-            packedFiles.push(`${dirName}/`);
         });
         archive.finalize();
     });
     packedFiles.sort();
     return packedFiles;
 }
-const resolveProjPath = (relativePath) => path_1.default.resolve(process.cwd(), relativePath);
+const resolveProjPath = (givenPath, relativePath) => path_1.default.resolve(givenPath ?? process.cwd(), relativePath);
 exports.default = packProject;

package/dist/lib/schema/validate.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateJSON = void 0;
+const ajv_1 = __importDefault(require("ajv"));
+const ajv = new ajv_1.default();
+/**
+ * Validates a JSON object against a given schema.
+ * @param data - The JSON data to validate.
+ * @param schema - The JSON schema to validate against.
+ * @returns True if the data is valid, otherwise false.
+ */
+function validateJSON(filename, data, schema) {
+    const validate = ajv.compile(schema);
+    const valid = validate(data);
+    if (!valid) {
+        console.error(`❌ Failed to validate ${filename}`);
+        console.error(validate.errors);
+    }
+    return valid;
+}
+exports.validateJSON = validateJSON;

package/dist/schema/manifest.schema.json

@@ -0,0 +1,121 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Manifest",
+    "type": "object",
+    "properties": {
+        "name": {
+            "type": "string",
+            "description": "The name of the link type.",
+            "minLength": 3,
+            "maxLength": 50
+        },
+        "tagline": {
+            "type": "string",
+            "description": "A short tagline for the link type.",
+            "minLength": 3,
+            "maxLength": 200
+        },
+        "description": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "version": {
+            "type": "string",
+            "description": "The version of the link type.",
+            "pattern": "^\\d+\\.\\d+\\.\\d+$"
+        },
+        "supporting_links": {
+            "type": "object",
+            "properties": {
+                "terms_of_service": {
+                    "type": "string",
+                    "description": "The URL of the terms of service."
+                },
+                "privacy_policy": {
+                    "type": "string",
+                    "description": "The URL of the privacy policy."
+                }
+            }
+        },
+        "category": {
+            "type": "string",
+            "description": "The category of the link type.",
+            "enum": [
+                "grow",
+                "share",
+                "sell",
+                "other"
+            ]
+        },
+        "search_terms": {
+            "type": "array",
+            "description": "The search terms for the link type.",
+            "items": {
+                "type": "string"
+            }
+        },
+        "url_match_urls": {
+            "type": "object",
+            "properties": {
+                "hostnames": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "patterns": {
+                    "type": "array",
+                    "items": {
+                        "type": "object"
+                    }
+                },
+                "notPatterns": {
+                    "type": "array",
+                    "items": {
+                        "type": "object"
+                    }
+                }
+            }
+        },
+        "author": {
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string",
+                    "description": "The name of the author."
+                },
+                "accounts": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "contact": {
+                    "type": "object",
+                    "properties": {
+                        "url": {
+                            "type": "string",
+                            "description": "The URL of the contact."
+                        },
+                        "email": {
+                            "type": "string",
+                            "description": "The email of the contact."
+                        }
+                    }
+                }
+            },
+            "required": [
+                "name"
+            ]
+        }
+    },
+    "required": [
+        "name",
+        "tagline",
+        "version",
+        "author"
+    ],
+    "additionalProperties": true
+}

package/dist/storybook/main.js

@@ -10,7 +10,7 @@ const postcss_config_1 = require("../postcss/postcss.config");
 const linkTypeSlug = 'test-id';
 const linkTypeId = 'testId';
 const config = {
-    stories: [`${process.cwd()}/stories/*.stories.@(js|jsx|ts|tsx)`],
+    stories: [`${process.cwd()}/stories/**/*.stories.@(js|jsx|ts|tsx)`],
     addons: [
         '@storybook/addon-links',
         '@storybook/addon-essentials',

package/dist/webpack/webpack.config.js

@@ -15,6 +15,8 @@ require("webpack-dev-server");
 const camelcase_1 = __importDefault(require("camelcase"));
 const slugify_1 = __importDefault(require("slugify"));
 const compile_1 = __importDefault(require("../lib/schema/compile"));
+const validate_1 = require("../lib/schema/validate");
+const manifest_schema_json_1 = __importDefault(require("../schema/manifest.schema.json"));
 const postcss_config_1 = require("../postcss/postcss.config");
 const { ModuleFederationPlugin } = webpack_1.container;
 function toVirtualModule(code) {
@@ -39,6 +41,7 @@ async function default_1(env, options) {
     const useEditorEntry = hasEntrypoint(appDir, 'Editor.tsx');
     const appEntry = useAppEntry ? path_1.default.resolve(appDir, 'src/App') : path_1.default.resolve(appDir, 'src');
     const manifestJson = JSON.parse(fs_1.default.readFileSync(path_1.default.resolve(appDir, 'manifest.json'), 'utf8'));
+    (0, validate_1.validateJSON)('manifest.json', manifestJson, manifest_schema_json_1.default);
     const linkTypeName = manifestJson.name.replace(/[^A-Za-z0-9 ]/g, '');
     const linkTypeSlug = (0, slugify_1.default)(linkTypeName, { lower: true });
     const linkTypeId = (0, camelcase_1.default)(linkTypeSlug, { pascalCase: true });

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.1",
+  "version": "1.7.3",
   "commands": {
     "build": {
       "id": "build",
@@ -119,6 +119,13 @@
           "description": "Allow Link Type Admins to push updates to Link Apps in PUBLISHED state. Admin use only.",
           "hidden": true,
           "allowNo": false
+        },
+        "skip-confirm": {
+          "name": "skip-confirm",
+          "type": "boolean",
+          "description": "Skip confirmation prompt",
+          "hidden": true,
+          "allowNo": false
         }
       },
       "args": {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linktr.ee/create-link-app",
-  "version": "1.5.1",
+  "version": "1.7.3",
   "description": "Create a Link App on Linktr.ee.",
   "license": "UNLICENSED",
   "author": "Linktree",

package/templates/common/manifest.json

@@ -5,7 +5,6 @@
     "The simple greeting link is an example link type which enables a user to to show a simple greeting on their linktr.ee profile.",
     "This example code acts as a base for experimenting with link type capabilities"
   ],
-  "manifest_version": "1.0.0",
   "version": "1.0.0",
   "supporting_links": {
     "terms_of_service": "https://example.com/terms-of-service",

package/templates/stories/LinkApp.stories.tsx

@@ -1,18 +1,18 @@
-import { ComponentMeta, ComponentStory } from "@storybook/react";
-import React from "react";
-import fixture from "../fixtures/props-data.json";
-import manifest from "../manifest.json";
+import { ComponentMeta, ComponentStory } from '@storybook/react'
+import React from 'react'
+import fixture from '../fixtures/props-data.json'
+import manifest from '../manifest.json'
 
-import LinkApp from "../src/App";
+import LinkApp from '../src/App'
 
-import "./tailwind.sb.css";
+import './tailwind.sb.css'
 
 export default {
   title: `Link App/${manifest.name}`,
   component: LinkApp,
-  tags: ["autodocs"],
+  tags: ['autodocs'],
   parameters: {
-    layout: "fullscreen",
+    layout: 'fullscreen',
   },
   args: {
     ...fixture,
@@ -25,68 +25,68 @@ export default {
       },
     },
   },
-} as ComponentMeta<typeof LinkApp>;
+} as ComponentMeta<typeof LinkApp>
 
 export const Stack: ComponentStory<typeof LinkApp> = (args) => (
   <div
     data-link-type-id={manifest.name}
     style={{
-      margin: "0.5rem",
+      margin: '0.5rem',
       width: 374,
       height: 80,
     }}
   >
     <LinkApp {...args} />
   </div>
-);
+)
 Stack.args = {
-  __layout: "STACK",
-};
+  __layout: 'STACK',
+}
 
 export const Grid: ComponentStory<typeof LinkApp> = (args) => (
   <div
     data-link-type-id={manifest.name}
     style={{
-      margin: "0.5rem",
+      margin: '0.5rem',
       width: 183,
       height: 240,
     }}
   >
     <LinkApp {...args} />
   </div>
-);
+)
 Grid.args = {
-  __layout: "GRID",
-};
+  __layout: 'GRID',
+}
 
 export const Carousel: ComponentStory<typeof LinkApp> = (args) => (
   <div
     data-link-type-id={manifest.name}
     style={{
-      margin: "0.5rem",
+      margin: '0.5rem',
       width: 224,
       height: 296,
     }}
   >
     <LinkApp {...args} />
   </div>
-);
+)
 Carousel.args = {
-  __layout: "CAROUSEL",
-};
+  __layout: 'CAROUSEL',
+}
 
 export const Featured: ComponentStory<typeof LinkApp> = (args) => (
   <div
     data-link-type-id={manifest.name}
     style={{
-      margin: "0.5rem",
+      margin: '0.5rem',
       width: 374,
       height: 374,
     }}
   >
     <LinkApp {...args} />
   </div>
-);
+)
 Featured.args = {
-  __layout: "FEATURED",
-};
+  __layout: 'FEATURED',
+}