test-bdk-cli 0.1.20 → 1.0.0

package/dist/commands/create.js

@@ -160,25 +160,28 @@ function registerCreate(program) {
             if (!fs_1.default.existsSync(manifestPath)) {
                 const defaultManifest = {
                     name: appName,
-                    author: {
+                    developer: {
                         name: '',
-                        email: ''
+                        contactEmail: '',
+                        supportEmail: '',
+                        privacyUrl: '',
+                        websiteUrl: '',
+                        termsOfUseUrl: ''
                     },
+                    widgets: [
+                        {
+                            url: 'assets/iframe.html',
+                            name: 'Sample Widget',
+                            location: 'desk.ticket.view.rightpanel'
+                        }
+                    ],
                     defaultLocale: 'en',
+                    domainWhitelist: [],
                     private: true,
-                    location: {
-                        support: {
-                            ticket_sidebar: {
-                                url: 'assets/iframe.html',
-                                flexible: true
-                            }
-                        }
-                    },
+                    product: 'BoldDesk',
                     version: '1.0.0',
                     frameworkVersion: '2.0',
-                    description: '',
-                    main: 'dist/index.html',
-                    permissions: []
+                    description: ''
                 };
                 try {
                     fs_1.default.writeFileSync(manifestPath, JSON.stringify(defaultManifest, null, 2), 'utf8');
@@ -189,15 +192,44 @@ function registerCreate(program) {
             }
             if (fs_1.default.existsSync(manifestPath)) {
                 const manifest = JSON.parse(fs_1.default.readFileSync(manifestPath, 'utf8'));
+                const dev = (manifest.developer && typeof manifest.developer === 'object') ? manifest.developer : {};
                 const dynamicImport = new Function('s', 'return import(s)');
                 const _inquirer = (await dynamicImport('inquirer')).default || (await dynamicImport('inquirer'));
+                // Placeholder sentinel values from the template — treat them as empty
+                const templatePlaceholders = new Set([
+                    'Your Name', 'you@example.com', 'https://example.com/privacy',
+                    'https://example.com', 'https://example.com/terms',
+                    'sample-app', 'A sample BoldDesk app scaffolded by the bdk CLI'
+                ]);
+                const clean = (v) => (v && typeof v === 'string' && !templatePlaceholders.has(v.trim())) ? v : '';
                 const answers = await _inquirer.prompt([
-                    { name: 'name', message: 'App name', default: appName },
-                    { name: 'version', message: 'Version', default: manifest.version || '0.1.0' },
-                    { name: 'author', message: 'Author', default: manifest.author || '' },
-                    { name: 'description', message: 'Description', default: manifest.description || '' }
+                    { name: 'name', message: 'App name', default: clean(manifest.name) || appName },
+                    { name: 'version', message: 'Version', default: manifest.version || '1.0.0' },
+                    { name: 'description', message: 'Description', default: clean(manifest.description) },
+                    // developer fields — always default to '' so pressing Enter stores empty string
+                    { name: 'devName', message: 'Developer name', default: clean(dev.name) },
+                    { name: 'devContactEmail', message: 'Developer contact email', default: clean(dev.contactEmail) },
+                    { name: 'devSupportEmail', message: 'Developer support email', default: clean(dev.supportEmail) },
+                    { name: 'devPrivacyUrl', message: 'Developer privacy URL', default: clean(dev.privacyUrl) },
+                    { name: 'devWebsiteUrl', message: 'Developer website URL', default: clean(dev.websiteUrl) },
+                    { name: 'devTermsUrl', message: 'Developer terms of use URL', default: clean(dev.termsOfUseUrl) }
                 ]);
-                const newManifest = { ...manifest, ...answers };
+                const newManifest = {
+                    ...manifest,
+                    name: answers.name,
+                    version: answers.version,
+                    description: answers.description,
+                    developer: {
+                        name: answers.devName,
+                        contactEmail: answers.devContactEmail,
+                        supportEmail: answers.devSupportEmail,
+                        privacyUrl: answers.devPrivacyUrl,
+                        websiteUrl: answers.devWebsiteUrl,
+                        termsOfUseUrl: answers.devTermsUrl
+                    }
+                };
+                // Remove legacy 'author' field if present
+                delete newManifest.author;
                 fs_1.default.writeFileSync(manifestPath, JSON.stringify(newManifest, null, 2), 'utf8');
                 console.log('Updated manifest.json with provided values.');
             }

package/dist/commands/validate.js

@@ -34,7 +34,6 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerValidate = registerValidate;
-const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const package_1 = require("../lib/package");
 const appPath_1 = require("../lib/appPath");
@@ -47,14 +46,8 @@ function registerValidate(program) {
         try {
             (0, appPath_1.validateAppPath)(appDirectory);
             const appPath = path.resolve(appDirectory);
-            // create package (not used by validatePkg here but kept for parity with legacy CLI flow)
-            const dummyName = path.basename(appPath) || 'app';
-            const pkgPath = await (0, package_1.createAppPkg)(appPath, dummyName).catch(() => null);
             await (0, package_1.validatePkg)(appPath);
             console.log('No validation errors');
-            // clean up
-            if (pkgPath)
-                await fs.promises.rm(pkgPath, { force: true, recursive: true });
         }
         catch (err) {
             console.error(err && err.message ? err.message : err);

package/dist/lib/package.js

@@ -23,21 +23,124 @@ async function createAppPkg(targetDir, appName) {
         archive.finalize();
     });
 }
-const ajv_1 = __importDefault(require("ajv"));
 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 schemaPath = path_1.default.join(__dirname, '../../schemas/manifest.schema.json');
-    if (!fs_1.default.existsSync(schemaPath))
-        throw new Error('Manifest schema not found');
     const manifest = JSON.parse(fs_1.default.readFileSync(manifestPath, 'utf8'));
-    const schema = JSON.parse(fs_1.default.readFileSync(schemaPath, 'utf8'));
-    const ajv = new ajv_1.default({ allErrors: true, allowUnionTypes: true });
-    const validate = ajv.compile(schema);
-    const valid = validate(manifest);
-    if (!valid) {
-        const errs = (validate.errors || []).map((e) => `${(e === null || e === void 0 ? void 0 : e.instancePath) || '/'}: ${e === null || e === void 0 ? void 0 : e.message}`).join('\n');
-        throw new Error(`Validation errors in ${manifestPath}:\n${errs}`);
+    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.`);
+                }
+            });
+        }
+        // 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "test-bdk-cli",
-  "version": "0.1.20",
+  "version": "1.0.0",
   "description": "test CLI",
   "author": "@raisulaslam",
   "bin": {

package/schemas/manifest.schema.json

@@ -2,14 +2,91 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "BoldDesk App Manifest",
   "type": "object",
-  "required": ["name", "version", "author"],
+  "required": ["name", "version", "frameworkVersion", "developer", "widgets", "defaultLocale"],
   "properties": {
-    "name": { "type": "string" },
-    "version": { "type": "string", "pattern": "^\\d+\\.\\d+\\.\\d+(?:[-+][0-9A-Za-z.-]+)?$" },
-    "author": { "type": ["string", "object"] },
-    "description": { "type": "string" },
-    "main": { "type": "string" },
-    "permissions": { "type": "array", "items": { "type": "string" } }
+    "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": true
+  "additionalProperties": false
 }

package/templates/default/manifest.json

@@ -1,22 +1,31 @@
 {
   "name": "sample-app",
-  "author": {
-    "name": "Your Name",
-    "email": ""
+  "developer": {
+    "name": "",
+    "contactEmail": "",
+    "supportEmail": "",
+    "privacyUrl": "",
+    "websiteUrl": "",
+    "termsOfUseUrl": ""
   },
-  "defaultLocale": "en",
-  "private": true,
-  "location": {
-    "support": {
-      "ticket_sidebar": {
-        "url": "assets/iframe.html",
-        "flexible": true
-      }
+  "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": "2.0",
-  "description": "A sample BoldDesk app scaffolded by the bdk CLI",
-  "main": "dist/index.html",
-  "permissions": []
+  "frameworkVersion": "1.0",
+  "description": ""
 }