@magentrix-corp/magentrix-cli 1.3.15 → 1.3.17

package/utils/magentrix/api/iris.js

@@ -1,251 +1,251 @@
-import { fetchMagentrix } from "../fetch.js";
-import { File } from "node:buffer";
-
-/**
- * List all deployed Iris applications.
- * @param {string} instanceUrl - Magentrix instance base URL
- * @param {string} token - OAuth2 bearer token
- * @returns {Promise<{success: boolean, apps: Array<{folderName: string, uploadedOn: string, modifiedOn: string, size: number}>}>}
- */
-export const listApps = async (instanceUrl, token) => {
-    if (!instanceUrl || !token) {
-        throw new Error('Missing required Magentrix instanceUrl or token');
-    }
-
-    const response = await fetchMagentrix({
-        instanceUrl,
-        token,
-        path: '/iris/listapps',
-        method: 'GET',
-        returnErrorObject: true
-    });
-
-    return response;
-};
-
-/**
- * Publish (upload) an Iris Vue.js application.
- * @param {string} instanceUrl - Magentrix instance base URL
- * @param {string} token - OAuth2 bearer token
- * @param {Buffer} zipBuffer - The zip file as a Buffer
- * @param {string} filename - The filename for the zip (e.g., "my-app.zip")
- * @param {string} appName - The user-friendly display name (required for navigation)
- * @param {Object} options - Optional parameters
- * @param {string} [options.appDescription] - App description
- * @param {string} [options.appIconId] - App icon ID
- * @returns {Promise<{success: boolean, message: string, folderName: string}>}
- */
-export const publishApp = async (instanceUrl, token, zipBuffer, filename, appName, options = {}) => {
-    if (!instanceUrl || !token) {
-        throw new Error('Missing required Magentrix instanceUrl or token');
-    }
-
-    if (!zipBuffer || !Buffer.isBuffer(zipBuffer)) {
-        throw new Error('zipBuffer must be a valid Buffer');
-    }
-
-    if (!filename) {
-        throw new Error('filename is required');
-    }
-
-    // Create a File object from the buffer for FormData
-    const file = new File([zipBuffer], filename, { type: 'application/zip' });
-
-    const formData = new FormData();
-    formData.append('file', file);
-
-    // Build query parameters
-    // Note: app-name is only sent when provided (required for creates, optional for updates)
-    // Sending app-name on updates can trigger a rename attempt that fails if the user
-    // lacks metadata-edit permissions on the server
-    const params = new URLSearchParams();
-
-    if (appName) {
-        params.append('app-name', appName);
-    }
-
-    if (options.appDescription) {
-        params.append('app-description', options.appDescription);
-    }
-
-    if (options.appIconId) {
-        params.append('app-icon-id', options.appIconId);
-    }
-
-    const response = await fetchMagentrix({
-        instanceUrl,
-        token,
-        path: `/iris/publishapp?${params.toString()}`,
-        method: 'POST',
-        body: formData,
-        ignoreContentType: true,
-        returnErrorObject: true
-    });
-
-    return response;
-};
-
-/**
- * Delete an Iris application.
- * @param {string} instanceUrl - Magentrix instance base URL
- * @param {string} token - OAuth2 bearer token
- * @param {string} folderName - The folder name of the app to delete
- * @returns {Promise<{success: boolean, message: string}>}
- */
-export const deleteApp = async (instanceUrl, token, folderName) => {
-    if (!instanceUrl || !token) {
-        throw new Error('Missing required Magentrix instanceUrl or token');
-    }
-
-    if (!folderName) {
-        throw new Error('folderName is required');
-    }
-
-    const response = await fetchMagentrix({
-        instanceUrl,
-        token,
-        path: `/iris/deleteapp?folderName=${encodeURIComponent(folderName)}`,
-        method: 'POST',
-        returnErrorObject: true
-    });
-
-    return response;
-};
-
-/**
- * Download a single Iris application as a buffer.
- * @param {string} instanceUrl - Magentrix instance base URL
- * @param {string} token - OAuth2 bearer token
- * @param {string} folderName - The folder name of the app to download
- * @returns {Promise<{buffer: Buffer, filename: string}>}
- */
-export const downloadApp = async (instanceUrl, token, folderName) => {
-    if (!instanceUrl || !token) {
-        throw new Error('Missing required Magentrix instanceUrl or token');
-    }
-
-    if (!folderName) {
-        throw new Error('folderName is required');
-    }
-
-    const url = `${instanceUrl.replace(/\/$/, '')}/iris/downloadapp?folderName=${encodeURIComponent(folderName)}`;
-
-    const response = await fetch(url, {
-        method: 'GET',
-        headers: {
-            'Authorization': `Bearer ${token}`
-        }
-    });
-
-    if (!response.ok) {
-        let errorMessage = `Download failed (${response.status})`;
-        try {
-            const errorData = await response.json();
-            if (errorData.message) {
-                errorMessage = errorData.message;
-            }
-        } catch {
-            errorMessage = `Download failed: ${response.statusText}`;
-        }
-        throw new Error(errorMessage);
-    }
-
-    // Get filename from Content-Disposition header
-    const contentDisposition = response.headers.get('content-disposition') || '';
-    const filenameMatch = /filename\*?=(?:UTF-8'')?["']?([^"';]+)["']?/i.exec(contentDisposition);
-    const filename = filenameMatch ? decodeURIComponent(filenameMatch[1]) : `${folderName}.zip`;
-
-    const arrayBuffer = await response.arrayBuffer();
-    const buffer = Buffer.from(arrayBuffer);
-
-    return { buffer, filename };
-};
-
-/**
- * Download all Iris applications as a single zip buffer.
- * @param {string} instanceUrl - Magentrix instance base URL
- * @param {string} token - OAuth2 bearer token
- * @returns {Promise<{buffer: Buffer, filename: string}>}
- */
-export const downloadAllApps = async (instanceUrl, token) => {
-    if (!instanceUrl || !token) {
-        throw new Error('Missing required Magentrix instanceUrl or token');
-    }
-
-    const url = `${instanceUrl.replace(/\/$/, '')}/iris/downloadallapps`;
-
-    const response = await fetch(url, {
-        method: 'GET',
-        headers: {
-            'Authorization': `Bearer ${token}`
-        }
-    });
-
-    if (!response.ok) {
-        let errorMessage = `Download failed (${response.status})`;
-        try {
-            const errorData = await response.json();
-            if (errorData.message) {
-                errorMessage = errorData.message;
-            }
-        } catch {
-            errorMessage = `Download failed: ${response.statusText}`;
-        }
-        throw new Error(errorMessage);
-    }
-
-    // Get filename from Content-Disposition header
-    const contentDisposition = response.headers.get('content-disposition') || '';
-    const filenameMatch = /filename\*?=(?:UTF-8'')?["']?([^"';]+)["']?/i.exec(contentDisposition);
-    const timestamp = new Date().toISOString().replace(/[:.]/g, '-').slice(0, 19);
-    const filename = filenameMatch ? decodeURIComponent(filenameMatch[1]) : `iris-apps_${timestamp}.zip`;
-
-    const arrayBuffer = await response.arrayBuffer();
-    const buffer = Buffer.from(arrayBuffer);
-
-    return { buffer, filename };
-};
-
-/**
- * Get platform assets for local development (CSS, fonts, etc.).
- * @param {string} siteUrl - Magentrix instance base URL (from Vue config.ts)
- * @param {string} token - OAuth2 bearer token
- * @returns {Promise<{success: boolean, assets: string[]}>}
- */
-export const getIrisAssets = async (siteUrl, token) => {
-    if (!siteUrl) {
-        throw new Error('Missing required siteUrl');
-    }
-
-    const url = `${siteUrl.replace(/\/$/, '')}/iris/getirisassets`;
-
-    const headers = {
-        'Accept': 'application/json'
-    };
-
-    // Token is optional for this endpoint (might be public)
-    if (token) {
-        headers['Authorization'] = `Bearer ${token}`;
-    }
-
-    const response = await fetch(url, {
-        method: 'GET',
-        headers
-    });
-
-    if (!response.ok) {
-        let errorMessage = `Failed to fetch Iris assets (${response.status})`;
-        try {
-            const errorData = await response.json();
-            if (errorData.message) {
-                errorMessage = errorData.message;
-            }
-        } catch {
-            errorMessage = `Failed to fetch Iris assets: ${response.statusText}`;
-        }
-        throw new Error(errorMessage);
-    }
-
-    const data = await response.json();
-    return data;
-};
+import { fetchMagentrix } from "../fetch.js";
+import { File } from "node:buffer";
+
+/**
+ * List all deployed Iris applications.
+ * @param {string} instanceUrl - Magentrix instance base URL
+ * @param {string} token - OAuth2 bearer token
+ * @returns {Promise<{success: boolean, apps: Array<{folderName: string, uploadedOn: string, modifiedOn: string, size: number}>}>}
+ */
+export const listApps = async (instanceUrl, token) => {
+    if (!instanceUrl || !token) {
+        throw new Error('Missing required Magentrix instanceUrl or token');
+    }
+
+    const response = await fetchMagentrix({
+        instanceUrl,
+        token,
+        path: '/iris/listapps',
+        method: 'GET',
+        returnErrorObject: true
+    });
+
+    return response;
+};
+
+/**
+ * Publish (upload) an Iris Vue.js application.
+ * @param {string} instanceUrl - Magentrix instance base URL
+ * @param {string} token - OAuth2 bearer token
+ * @param {Buffer} zipBuffer - The zip file as a Buffer
+ * @param {string} filename - The filename for the zip (e.g., "my-app.zip")
+ * @param {string} appName - The user-friendly display name (required for navigation)
+ * @param {Object} options - Optional parameters
+ * @param {string} [options.appDescription] - App description
+ * @param {string} [options.appIconId] - App icon ID
+ * @returns {Promise<{success: boolean, message: string, folderName: string}>}
+ */
+export const publishApp = async (instanceUrl, token, zipBuffer, filename, appName, options = {}) => {
+    if (!instanceUrl || !token) {
+        throw new Error('Missing required Magentrix instanceUrl or token');
+    }
+
+    if (!zipBuffer || !Buffer.isBuffer(zipBuffer)) {
+        throw new Error('zipBuffer must be a valid Buffer');
+    }
+
+    if (!filename) {
+        throw new Error('filename is required');
+    }
+
+    // Create a File object from the buffer for FormData
+    const file = new File([zipBuffer], filename, { type: 'application/zip' });
+
+    const formData = new FormData();
+    formData.append('file', file);
+
+    // Build query parameters
+    // Note: app-name is only sent when provided (required for creates, optional for updates)
+    // Sending app-name on updates can trigger a rename attempt that fails if the user
+    // lacks metadata-edit permissions on the server
+    const params = new URLSearchParams();
+
+    if (appName) {
+        params.append('app-name', appName);
+    }
+
+    if (options.appDescription) {
+        params.append('app-description', options.appDescription);
+    }
+
+    if (options.appIconId) {
+        params.append('app-icon-id', options.appIconId);
+    }
+
+    const response = await fetchMagentrix({
+        instanceUrl,
+        token,
+        path: `/iris/publishapp?${params.toString()}`,
+        method: 'POST',
+        body: formData,
+        ignoreContentType: true,
+        returnErrorObject: true
+    });
+
+    return response;
+};
+
+/**
+ * Delete an Iris application.
+ * @param {string} instanceUrl - Magentrix instance base URL
+ * @param {string} token - OAuth2 bearer token
+ * @param {string} folderName - The folder name of the app to delete
+ * @returns {Promise<{success: boolean, message: string}>}
+ */
+export const deleteApp = async (instanceUrl, token, folderName) => {
+    if (!instanceUrl || !token) {
+        throw new Error('Missing required Magentrix instanceUrl or token');
+    }
+
+    if (!folderName) {
+        throw new Error('folderName is required');
+    }
+
+    const response = await fetchMagentrix({
+        instanceUrl,
+        token,
+        path: `/iris/deleteapp?folderName=${encodeURIComponent(folderName)}`,
+        method: 'POST',
+        returnErrorObject: true
+    });
+
+    return response;
+};
+
+/**
+ * Download a single Iris application as a buffer.
+ * @param {string} instanceUrl - Magentrix instance base URL
+ * @param {string} token - OAuth2 bearer token
+ * @param {string} folderName - The folder name of the app to download
+ * @returns {Promise<{buffer: Buffer, filename: string}>}
+ */
+export const downloadApp = async (instanceUrl, token, folderName) => {
+    if (!instanceUrl || !token) {
+        throw new Error('Missing required Magentrix instanceUrl or token');
+    }
+
+    if (!folderName) {
+        throw new Error('folderName is required');
+    }
+
+    const url = `${instanceUrl.replace(/\/$/, '')}/iris/downloadapp?folderName=${encodeURIComponent(folderName)}`;
+
+    const response = await fetch(url, {
+        method: 'GET',
+        headers: {
+            'Authorization': `Bearer ${token}`
+        }
+    });
+
+    if (!response.ok) {
+        let errorMessage = `Download failed (${response.status})`;
+        try {
+            const errorData = await response.json();
+            if (errorData.message) {
+                errorMessage = errorData.message;
+            }
+        } catch {
+            errorMessage = `Download failed: ${response.statusText}`;
+        }
+        throw new Error(errorMessage);
+    }
+
+    // Get filename from Content-Disposition header
+    const contentDisposition = response.headers.get('content-disposition') || '';
+    const filenameMatch = /filename\*?=(?:UTF-8'')?["']?([^"';]+)["']?/i.exec(contentDisposition);
+    const filename = filenameMatch ? decodeURIComponent(filenameMatch[1]) : `${folderName}.zip`;
+
+    const arrayBuffer = await response.arrayBuffer();
+    const buffer = Buffer.from(arrayBuffer);
+
+    return { buffer, filename };
+};
+
+/**
+ * Download all Iris applications as a single zip buffer.
+ * @param {string} instanceUrl - Magentrix instance base URL
+ * @param {string} token - OAuth2 bearer token
+ * @returns {Promise<{buffer: Buffer, filename: string}>}
+ */
+export const downloadAllApps = async (instanceUrl, token) => {
+    if (!instanceUrl || !token) {
+        throw new Error('Missing required Magentrix instanceUrl or token');
+    }
+
+    const url = `${instanceUrl.replace(/\/$/, '')}/iris/downloadallapps`;
+
+    const response = await fetch(url, {
+        method: 'GET',
+        headers: {
+            'Authorization': `Bearer ${token}`
+        }
+    });
+
+    if (!response.ok) {
+        let errorMessage = `Download failed (${response.status})`;
+        try {
+            const errorData = await response.json();
+            if (errorData.message) {
+                errorMessage = errorData.message;
+            }
+        } catch {
+            errorMessage = `Download failed: ${response.statusText}`;
+        }
+        throw new Error(errorMessage);
+    }
+
+    // Get filename from Content-Disposition header
+    const contentDisposition = response.headers.get('content-disposition') || '';
+    const filenameMatch = /filename\*?=(?:UTF-8'')?["']?([^"';]+)["']?/i.exec(contentDisposition);
+    const timestamp = new Date().toISOString().replace(/[:.]/g, '-').slice(0, 19);
+    const filename = filenameMatch ? decodeURIComponent(filenameMatch[1]) : `iris-apps_${timestamp}.zip`;
+
+    const arrayBuffer = await response.arrayBuffer();
+    const buffer = Buffer.from(arrayBuffer);
+
+    return { buffer, filename };
+};
+
+/**
+ * Get platform assets for local development (CSS, fonts, etc.).
+ * @param {string} siteUrl - Magentrix instance base URL (from Vue config.ts)
+ * @param {string} token - OAuth2 bearer token
+ * @returns {Promise<{success: boolean, assets: string[]}>}
+ */
+export const getIrisAssets = async (siteUrl, token) => {
+    if (!siteUrl) {
+        throw new Error('Missing required siteUrl');
+    }
+
+    const url = `${siteUrl.replace(/\/$/, '')}/iris/getirisassets`;
+
+    const headers = {
+        'Accept': 'application/json'
+    };
+
+    // Token is optional for this endpoint (might be public)
+    if (token) {
+        headers['Authorization'] = `Bearer ${token}`;
+    }
+
+    const response = await fetch(url, {
+        method: 'GET',
+        headers
+    });
+
+    if (!response.ok) {
+        let errorMessage = `Failed to fetch Iris assets (${response.status})`;
+        try {
+            const errorData = await response.json();
+            if (errorData.message) {
+                errorMessage = errorData.message;
+            }
+        } catch {
+            errorMessage = `Failed to fetch Iris assets: ${response.statusText}`;
+        }
+        throw new Error(errorMessage);
+    }
+
+    const data = await response.json();
+    return data;
+};

package/utils/magentrix/api/meqlQuery.js

@@ -1,36 +1,36 @@
-import { fetchMagentrix } from "../fetch.js";
-import debug from '../../debug.js';
-
-/**
- * Executes a Magentrix Entity Query Language (MEQL) query via the REST API v3.
- *
- * @async
- * @param {string} instanceUrl - Base URL of the Magentrix instance.
- * @param {string} token - Bearer token string.
- * @param {string} query - MEQL query string.
- * @returns {Promise<object>} The API response data.
- * @throws {Error} On HTTP or API-level error.
- */
-export const meqlQuery = async (instanceUrl, token, query = '') => {
-    if (!instanceUrl || !token) {
-        throw new Error('Missing required Magentrix instanceUrl or token');
-    }
-    if (!query.trim()) {
-        throw new Error('MEQL query string is required');
-    }
-
-    debug.log('MEQL', `Query: ${query}`);
-
-    const data = await fetchMagentrix({
-        instanceUrl,
-        token,
-        method: "POST",
-        path: '/api/3.0/query',
-        body: query
-    })
-
-    debug.log('MEQL', `Result: ${data?.Records?.length ?? 0} records returned`);
-
-    // --- Success ---
-    return data;
-};
+import { fetchMagentrix } from "../fetch.js";
+import debug from '../../debug.js';
+
+/**
+ * Executes a Magentrix Entity Query Language (MEQL) query via the REST API v3.
+ *
+ * @async
+ * @param {string} instanceUrl - Base URL of the Magentrix instance.
+ * @param {string} token - Bearer token string.
+ * @param {string} query - MEQL query string.
+ * @returns {Promise<object>} The API response data.
+ * @throws {Error} On HTTP or API-level error.
+ */
+export const meqlQuery = async (instanceUrl, token, query = '') => {
+    if (!instanceUrl || !token) {
+        throw new Error('Missing required Magentrix instanceUrl or token');
+    }
+    if (!query.trim()) {
+        throw new Error('MEQL query string is required');
+    }
+
+    debug.log('MEQL', `Query: ${query}`);
+
+    const data = await fetchMagentrix({
+        instanceUrl,
+        token,
+        method: "POST",
+        path: '/api/3.0/query',
+        body: query
+    })
+
+    debug.log('MEQL', `Result: ${data?.Records?.length ?? 0} records returned`);
+
+    // --- Success ---
+    return data;
+};