local-bdk-cli 1.0.7

package/dist/lib/package.js

@@ -0,0 +1,181 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createAppPkg = createAppPkg;
+exports.validatePkg = validatePkg;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+const archiver_1 = __importDefault(require("archiver"));
+async function createAppPkg(targetDir, appName) {
+    const outName = `${appName.replace(/[^a-z0-9-_]/gi, '-')}-${Date.now()}.zip`;
+    const outPath = path_1.default.join(os_1.default.tmpdir(), outName);
+    return new Promise((resolve, reject) => {
+        const output = fs_1.default.createWriteStream(outPath);
+        const archive = (0, archiver_1.default)('zip', { zlib: { level: 9 } });
+        output.on('close', () => resolve(outPath));
+        output.on('error', (err) => reject(err));
+        archive.on('error', (err) => reject(err));
+        archive.pipe(output);
+        archive.directory(targetDir, false);
+        archive.finalize();
+    });
+}
+async function validatePkg(appPath) {
+    const manifestPath = path_1.default.join(appPath, 'manifest.json');
+    if (!fs_1.default.existsSync(manifestPath))
+        throw new Error(`manifest.json not found in ${appPath}`);
+    const manifest = JSON.parse(fs_1.default.readFileSync(manifestPath, 'utf8'));
+    const errors = [];
+    const isEmpty = (v) => v === undefined ||
+        v === null ||
+        (typeof v === 'string' && v.trim() === '') ||
+        (Array.isArray(v) && v.length === 0) ||
+        (typeof v === 'object' && !Array.isArray(v) && Object.keys(v).length === 0);
+    // ── Top-level required fields ──
+    if (isEmpty(manifest.name)) {
+        errors.push("Missing required field in manifest: 'name'.");
+    }
+    if (isEmpty(manifest.version)) {
+        errors.push("Missing required field in manifest: 'version'.");
+    }
+    else if (!/^\d+\.\d+\.\d+(?:[-+][0-9A-Za-z.-]+)?$/.test(manifest.version)) {
+        errors.push(`Invalid 'version' format: "${manifest.version}". Expected semver (e.g., 1.0.0).`);
+    }
+    if (isEmpty(manifest.frameworkVersion)) {
+        errors.push("Framework version (frameworkVersion) is missing.");
+    }
+    if (isEmpty(manifest.defaultLocale)) {
+        errors.push("Missing required field in manifest: 'defaultLocale'.");
+    }
+    // ── Rule: 'author' field is not allowed (replaced by 'developer') ──
+    if ('author' in manifest) {
+        errors.push("The 'author' field is not allowed. Use the 'developer' block instead.");
+    }
+    // ── Rule: 'location' top-level is no longer valid (location belongs inside each widget) ──
+    if ('location' in manifest && !Array.isArray(manifest.location)) {
+        errors.push("Top-level 'location' field is not allowed. Define 'location' inside each widget under 'widgets'.");
+    }
+    // ── Rule: developer block validation (only 'name' is required) ──
+    if (isEmpty(manifest.developer) || typeof manifest.developer !== 'object') {
+        errors.push("The 'developer' block is missing. Please provide developer information.");
+    }
+    else {
+        if (isEmpty(manifest.developer.name)) {
+            errors.push("Developer validation failed: 'developer.name' is required.");
+        }
+    }
+    // ── Rule: widgets array & widget.location ──
+    if (!('widgets' in manifest)) {
+        errors.push("Missing required field in manifest: 'widgets'.");
+    }
+    else if (!Array.isArray(manifest.widgets) || manifest.widgets.length === 0) {
+        errors.push("'widgets' must be a non-empty array.");
+    }
+    else {
+        manifest.widgets.forEach((widget, index) => {
+            const label = widget && widget.name ? widget.name : `index ${index}`;
+            if (isEmpty(widget === null || widget === void 0 ? void 0 : widget.location)) {
+                errors.push(`Widget "${label}": location value is missing.`);
+            }
+            if (isEmpty(widget === null || widget === void 0 ? void 0 : widget.url)) {
+                errors.push(`Widget "${label}": url value is missing.`);
+            }
+            if (isEmpty(widget === null || widget === void 0 ? void 0 : widget.name)) {
+                errors.push(`Widget at index ${index}: name value is missing.`);
+            }
+        });
+    }
+    // ── Rule: OAuth validations ──
+    // If 'oauth' property is NOT present in manifest → skip entirely
+    // If 'oauth' property IS present (even with empty values) → all fields are required
+    if ('oauth' in manifest) {
+        const oauth = manifest.oauth;
+        if (!oauth || typeof oauth !== 'object') {
+            errors.push("'oauth' must be a valid object.");
+        }
+        else {
+            const oauthFieldMap = {
+                clientId: 'oauth.clientId',
+                redirectUri: 'oauth.redirectUri',
+                authorizeUri: 'oauth.authorizeUri',
+                clientSecret: 'oauth.clientSecret',
+                accessTokenUri: 'oauth.accessTokenUri',
+            };
+            for (const [field, label] of Object.entries(oauthFieldMap)) {
+                if (isEmpty(oauth[field])) {
+                    errors.push(`Missing required field: '${label}'.`);
+                }
+            }
+        }
+    }
+    // ── Rule: settings.fields OAuth type check ──
+    // Only enforce when oauth block has actual values AND settings.fields is non-empty
+    if ('settings' in manifest) {
+        const settings = manifest.settings;
+        if (!settings || typeof settings !== 'object') {
+            errors.push("'settings' must be a valid object.");
+        }
+        else if (Array.isArray(settings.fields) && settings.fields.length > 0) {
+            // Each field object must have 'key' and 'type'
+            settings.fields.forEach((field, index) => {
+                const fieldLabel = field && field.key ? `"${field.key}"` : `index ${index}`;
+                if (isEmpty(field === null || field === void 0 ? void 0 : field.key)) {
+                    errors.push(`settings.fields[${index}]: 'key' is required for each field object.`);
+                }
+                if (isEmpty(field === null || field === void 0 ? void 0 : field.type)) {
+                    errors.push(`settings.fields[${fieldLabel}]: 'type' is required for each field object.`);
+                }
+            });
+            // ── Rule: settings.fields key uniqueness ──
+            const seenKeys = new Map();
+            settings.fields.forEach((field, index) => {
+                if (field && typeof field.key === 'string' && field.key.trim() !== '') {
+                    const key = field.key.trim();
+                    if (seenKeys.has(key)) {
+                        errors.push(`settings.fields: duplicate key "${key}" found at index ${index} (first used at index ${seenKeys.get(key)}). Each field key must be unique.`);
+                    }
+                    else {
+                        seenKeys.set(key, index);
+                    }
+                }
+            });
+        }
+        // ── Rule: enablePermission / enableReadPermission / enableWritePermission ──
+        // If enablePermission is true  → at least one of enableReadPermission or enableWritePermission must be true.
+        // If enablePermission is false → both enableReadPermission and enableWritePermission must be false.
+        if ('enablePermission' in settings) {
+            const enablePermission = settings.enablePermission;
+            const enableReadPermission = settings.enableReadPermission;
+            const enableWritePermission = settings.enableWritePermission;
+            if (enablePermission === true) {
+                if (enableReadPermission !== true && enableWritePermission !== true) {
+                    errors.push("settings: 'enablePermission' is true, so at least one of " +
+                        "'enableReadPermission' or 'enableWritePermission' must also be true.");
+                }
+            }
+            else if (enablePermission === false) {
+                if (enableReadPermission === true) {
+                    errors.push("settings: 'enableReadPermission' must be false when 'enablePermission' is false.");
+                }
+                if (enableWritePermission === true) {
+                    errors.push("settings: 'enableWritePermission' must be false when 'enablePermission' is false.");
+                }
+            }
+        }
+        // If 'oauth' property is present in manifest → settings.fields must have at least one type "OAuth" field
+        if ('oauth' in manifest) {
+            const fields = Array.isArray(settings.fields) ? settings.fields : [];
+            const hasOAuthField = fields.some((field) => field && typeof field.type === 'string' && field.type.toLowerCase() === 'oauth');
+            if (!hasOAuthField) {
+                errors.push("settings.fields must contain at least one field with type 'OAuth' when oauth is configured. " +
+                    'Example: { "key": "token", "type": "OAuth", "secure": true, "required": true, ... }');
+            }
+        }
+    }
+    if (errors.length > 0) {
+        throw new Error(`Validation errors in ${manifestPath}:\n  - ${errors.join('\n  - ')}`);
+    }
+}

package/dist/utils/appConfig.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.getAllConfigs = getAllConfigs;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+function getAllConfigs(appPath) {
+    // Look for a config file (config.json or app.config.json). Return parsed object or empty.
+    const candidates = ['config.json', 'app.config.json'];
+    for (const c of candidates) {
+        const p = path_1.default.join(appPath, c);
+        if (fs_1.default.existsSync(p)) {
+            try {
+                return JSON.parse(fs_1.default.readFileSync(p, 'utf8'));
+            }
+            catch (e) {
+                return {};
+            }
+        }
+    }
+    return {};
+}

package/dist/utils/createApp.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadAppPkg = uploadAppPkg;
+exports.deployApp = deployApp;
+exports.createProductInstallation = createProductInstallation;
+const fs_1 = __importDefault(require("fs"));
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const form_data_1 = __importDefault(require("form-data"));
+async function uploadAppPkg(apiUrl, apiToken, pkgPath) {
+    const form = new form_data_1.default();
+    form.append('file', fs_1.default.createReadStream(pkgPath));
+    const headers = form.getHeaders();
+    headers['Authorization'] = `Bearer ${apiToken}`;
+    const res = await (0, node_fetch_1.default)(`${apiUrl.replace(/\/+$/, '')}/apps/upload`, {
+        method: 'POST',
+        headers,
+        body: form
+    });
+    if (!res.ok)
+        throw new Error(`Upload failed: ${res.status} ${res.statusText}`);
+    return res.json();
+}
+async function deployApp(apiUrl, apiToken, uploadId, name) {
+    const res = await (0, node_fetch_1.default)(`${apiUrl.replace(/\/+$/, '')}/apps/deploy`, {
+        method: 'POST',
+        headers: {
+            'Content-Type': 'application/json',
+            'Authorization': `Bearer ${apiToken}`
+        },
+        body: JSON.stringify({ upload_id: uploadId, name })
+    });
+    if (!res.ok)
+        throw new Error(`Deploy request failed: ${res.status} ${res.statusText}`);
+    return res.json();
+}
+async function createProductInstallation(apiUrl, apiToken, settings, manifest, appId, product) {
+    const url = `${apiUrl.replace(/\/+$/, '')}/products/${encodeURIComponent(product)}/installations`;
+    const res = await (0, node_fetch_1.default)(url, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer ${apiToken}` },
+        body: JSON.stringify({ app_id: appId, settings, manifest })
+    });
+    return res.ok;
+}

package/dist/utils/getAppSettings.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppSettings = getAppSettings;
+async function getAppSettings(manifest, configParams = {}) {
+    const params = manifest.parameters || {};
+    const settings = {};
+    for (const [k, v] of Object.entries(params)) {
+        // prefer configParams value, otherwise manifest default, otherwise empty string
+        // @ts-ignore
+        settings[k] = (configParams && configParams[k] !== undefined) ? configParams[k] : ((v && v.default) ? v.default : '');
+    }
+    return settings;
+}

package/dist/utils/manifest.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getManifestFile = getManifestFile;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+function getManifestFile(appPath) {
+    const manifestPath = path_1.default.resolve(appPath, 'manifest.json');
+    if (!fs_1.default.existsSync(manifestPath))
+        throw new Error(`manifest.json not found in ${appPath}`);
+    return JSON.parse(fs_1.default.readFileSync(manifestPath, 'utf8'));
+}

package/dist/utils/uploadApp.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUploadJobStatus = getUploadJobStatus;
+async function getUploadJobStatus(apiUrl, apiToken, jobId, timeoutMs = 2 * 60 * 1000) {
+    const start = Date.now();
+    while (true) {
+        const res = await fetch(`${apiUrl.replace(/\/+$/, '')}/jobs/${jobId}`, {
+            method: 'GET',
+            headers: { 'Authorization': `Bearer ${apiToken}` }
+        });
+        if (!res.ok)
+            throw new Error(`Job status request failed: ${res.status} ${res.statusText}`);
+        const body = await res.json();
+        const status = body.status || body.state || '';
+        if (status === 'success' || status === 'completed' || status === 'ok') {
+            return body;
+        }
+        if (status === 'failed' || status === 'error') {
+            throw new Error(`Job failed: ${JSON.stringify(body)}`);
+        }
+        if (Date.now() - start > timeoutMs)
+            throw new Error('Timed out waiting for job to complete');
+        await new Promise((r) => setTimeout(r, 2000));
+    }
+}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "local-bdk-cli",
+  "version": "1.0.7",
+  "description": "Local BoldDesk CLI for app development and testing",
+  "author": "@BoldDesk",
+  "bin": {
+    "bdk": "dist/index.js"
+  },
+  "npmRegistry": "https://registry.npmjs.org",
+  "license": "MIT",
+  "scripts": {
+    "build": "npx tsc -p tsconfig.json",
+    "dev": "ts-node src/index.ts",
+    "start": "node dist/index.js",
+    "test": "jest"
+  },
+  "dependencies": {
+    "ajv": "^8.12.0",
+    "archiver": "^5.3.1",
+    "chokidar": "^3.5.3",
+    "commander": "^10.0.0",
+    "form-data": "^4.0.0",
+    "inquirer": "^9.0.0",
+    "node-fetch": "^2.6.7"
+  },
+  "devDependencies": {
+    "@types/archiver": "^7.0.0",
+    "@types/commander": "^2.12.2",
+    "@types/inquirer": "^9.0.9",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^18.0.0",
+    "@types/node-fetch": "^2.6.13",
+    "jest": "^29.0.0",
+    "ts-jest": "^29.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.0"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "schemas",
+    "templates",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "roots": [
+      "<rootDir>/__tests__"
+    ],
+    "testMatch": [
+      "**/__tests__/**/*.test.ts"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/",
+      "/dist/",
+      "/src/commands/",
+      "/src/"
+    ],
+    "transform": {
+      "^.+\\.tsx?$": ["ts-jest", {}]
+    }
+  }
+}

package/schemas/manifest.schema.json

@@ -0,0 +1,92 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "BoldDesk App Manifest",
+  "type": "object",
+  "required": ["name", "version", "frameworkVersion", "developer", "widgets", "defaultLocale"],
+  "properties": {
+    "name": { "type": "string", "minLength": 1 },
+    "version": {
+      "type": "string",
+      "pattern": "^\\d+\\.\\d+\\.\\d+(?:[-+][0-9A-Za-z.-]+)?$"
+    },
+    "frameworkVersion": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Framework version is required"
+    },
+    "developer": {
+      "type": "object",
+      "required": ["name"],
+      "properties": {
+        "name":         { "type": "string", "minLength": 1 },
+        "contactEmail": { "type": "string" },
+        "supportEmail": { "type": "string" },
+        "privacyUrl":   { "type": "string" },
+        "websiteUrl":   { "type": "string" },
+        "termsOfUseUrl":{ "type": "string" }
+      },
+      "additionalProperties": false
+    },
+    "widgets": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": ["url", "name", "location"],
+        "properties": {
+          "url":      { "type": "string", "minLength": 1 },
+          "name":     { "type": "string", "minLength": 1 },
+          "location": { "type": "string", "minLength": 1 }
+        },
+        "additionalProperties": true
+      }
+    },
+    "oauth": {
+      "type": "object",
+      "required": ["clientId", "redirectUri", "authorizeUri", "clientSecret", "accessTokenUri"],
+      "properties": {
+        "clientId":       { "type": "string", "minLength": 1 },
+        "redirectUri":    { "type": "string", "minLength": 1 },
+        "authorizeUri":   { "type": "string", "minLength": 1 },
+        "clientSecret":   { "type": "string", "minLength": 1 },
+        "accessTokenUri": { "type": "string", "minLength": 1 }
+      },
+      "additionalProperties": false
+    },
+    "settings": {
+      "type": "object",
+      "properties": {
+        "fields": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["key", "type"],
+            "properties": {
+              "key":          { "type": "string", "minLength": 1 },
+              "type":         { "type": "string", "enum": ["text", "password", "number", "textarea", "radio", "checkbox", "dropdown", "email", "url", "hidden", "OAuth"] },
+              "label":        { "type": "string" },
+              "secure":       { "type": "boolean" },
+              "options":      { "type": "array" },
+              "required":     { "type": "boolean" },
+              "maxLength":    { "type": "number" },
+              "placeholder":  { "type": "string" },
+              "defaultValue": { "type": "string" },
+              "helpText":     { "type": "string" }
+            },
+            "additionalProperties": false
+          }
+        },
+        "enablePermission":      { "type": "boolean" },
+        "enableReadPermission":  { "type": "boolean" },
+        "enableWritePermission": { "type": "boolean" }
+      },
+      "additionalProperties": false
+    },
+    "defaultLocale":   { "type": "string", "minLength": 1 },
+    "domainWhitelist": { "type": "array", "items": { "type": "string" } },
+    "private":         { "type": "boolean" },
+    "product":         { "type": "string" },
+    "description":     { "type": "string" }
+  },
+  "additionalProperties": false
+}

package/templates/default/README.md

@@ -0,0 +1,18 @@
+# App name
+
+Short description: What this BoldDesk app does.
+
+## Setup
+
+1. Install dependencies: `npm install`
+2. Build the app: `npm run build`
+3. Run locally: `bdk run . --open`
+
+## Publishing
+
+Use `bdk pack` to create an archive and `bdk publish` to upload to the BoldDesk marketplace.
+
+Please submit bug reports to the project repository. Pull requests are welcome.
+
+### Screenshot(s)
+Place screenshots of your app here.

package/templates/default/assets/iframe.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width,initial-scale=1" />
+    <title>Sample Iframe</title>
+    <style>body{font-family:Arial,Helvetica,sans-serif;padding:20px}</style>
+  </head>
+  <body>
+    <h1>Hello from the app iframe</h1>
+    <p>This placeholder iframe is created by the bdk CLI — customize it for your BoldDesk app.</p>
+  </body>
+</html>

package/templates/default/assets/logo-small.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="64" height="64" viewBox="0 0 64 64">
+  <rect width="64" height="64" rx="8" fill="#0b6c6c" />
+  <rect x="12" y="12" width="40" height="40" rx="6" fill="#fff" />
+</svg>

package/templates/default/assets/logo.svg

@@ -0,0 +1,6 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="240" height="240" viewBox="0 0 240 240">
+  <rect width="240" height="240" rx="24" fill="#0b6c6c" />
+  <g fill="#fff" transform="translate(40,40)">
+    <rect x="0" y="0" width="160" height="160" rx="12" />
+  </g>
+</svg>

package/templates/default/manifest.json

@@ -0,0 +1,31 @@
+{
+  "name": "sample-app",
+  "developer": {
+    "name": "",
+    "contactEmail": "",
+    "supportEmail": "",
+    "privacyUrl": "",
+    "websiteUrl": "",
+    "termsOfUseUrl": ""
+  },
+  "widgets": [
+    {
+      "url": "assets/iframe.html",
+      "name": "Sample Widget",
+      "location": "desk.ticket.view.rightpanel"
+    }
+  ],
+  "settings": {
+    "fields": [],
+    "enablePermission": false,
+    "enableReadPermission": false,
+    "enableWritePermission": false
+  },
+  "defaultLocale": "en",
+  "domainWhitelist": [],
+  "private": false,
+  "product": "BoldDesk",
+  "version": "1.0.0",
+  "frameworkVersion": "1.0",
+  "description": ""
+}

package/templates/default/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "sample-app",
+  "version": "0.1.0",
+  "description": "Sample app scaffolded by bdk",
+  "scripts": {
+    "start": "echo Starting app...",
+    "build": "echo Building app...",
+    "test": "echo Running tests..."
+  },
+  "author": "",
+  "license": "MIT"
+}

package/templates/default/translations/en.json

@@ -0,0 +1,8 @@
+{
+  "app": {
+    "name": "Bold Tunes",
+    "short_description": "Play the famous Bold tunes in your help desk.",
+    "long_description": "Play the famous Bold tunes in your help desk and \n listen to the beats it has to offer.",
+    "installation_instructions": "Simply click install."
+  }
+}