@magentrix-corp/magentrix-cli 1.3.16 → 1.3.17

package/utils/magentrix/api/createEntity.js

@@ -1,61 +1,61 @@
-import { fetchMagentrix } from "../fetch.js";
-
-/**
- * Creates a new ActiveClass or ActivePage entity in Magentrix via the REST API.
- *
- * @async
- * @function createEntity
- * @param {string} instanceUrl - The base URL of the Magentrix instance.
- * @param {string} token - The OAuth2 bearer token for authentication.
- * @param {string} entityName - The Magentrix entity type. Allowed: 'ActiveClass' or 'ActivePage' (case-insensitive).
- * @param {Object} data - The entity data to create. Must include 'Name' and 'Type'.
- * @returns {Promise<Object>} The response data from Magentrix API if successful.
- * @throws {Error} Throws if required parameters are missing, entityName is invalid, or if required fields in data are missing.
- *
- * @example
- * const entity = await createEntity('https://your.magentrix.com', 'yourToken', 'ActiveClass', {
- *   Name: "MyNewClass",
- *   Body: "...",
- *   Description: "A test class",
- *   Type: "Class"
- * });
- */
-export const createEntity = async (instanceUrl, token, entityName, data) => {
-    // --- Validate required parameters ---
-    if (!instanceUrl || !token) {
-        throw new Error('Missing required Magentrix instanceUrl or token');
-    }
-    if (!entityName || typeof entityName !== 'string') {
-        throw new Error("Missing required 'entityName' (must be 'ActiveClass' or 'ActivePage')");
-    }
-
-    // Allowed entity types
-    const allowedEntities = ['activeclass', 'activepage'];
-    const entity = entityName.trim().toLowerCase();
-    if (!allowedEntities.includes(entity)) {
-        throw new Error("Invalid 'entityName'. Allowed values: 'ActiveClass' or 'ActivePage'");
-    }
-
-    // Validate data object and required fields
-    if (!data || typeof data !== 'object') {
-        throw new Error('Missing required data object for entity creation');
-    }
-    if (!data.Name) {
-        throw new Error("Missing required field: 'Name' in data");
-    }
-    if (!data.Type) {
-        throw new Error("Missing required field: 'Type' in data");
-    }
-
-    const response = await fetchMagentrix({
-        instanceUrl,
-        token,
-        path: `/api/3.0/entity/${entity}`,
-        method: "POST",
-        body: data,
-        returnErrorObject: true
-    });
-
-    // --- Success: return parsed response ---
-    return response;
-};
+import { fetchMagentrix } from "../fetch.js";
+
+/**
+ * Creates a new ActiveClass or ActivePage entity in Magentrix via the REST API.
+ *
+ * @async
+ * @function createEntity
+ * @param {string} instanceUrl - The base URL of the Magentrix instance.
+ * @param {string} token - The OAuth2 bearer token for authentication.
+ * @param {string} entityName - The Magentrix entity type. Allowed: 'ActiveClass' or 'ActivePage' (case-insensitive).
+ * @param {Object} data - The entity data to create. Must include 'Name' and 'Type'.
+ * @returns {Promise<Object>} The response data from Magentrix API if successful.
+ * @throws {Error} Throws if required parameters are missing, entityName is invalid, or if required fields in data are missing.
+ *
+ * @example
+ * const entity = await createEntity('https://your.magentrix.com', 'yourToken', 'ActiveClass', {
+ *   Name: "MyNewClass",
+ *   Body: "...",
+ *   Description: "A test class",
+ *   Type: "Class"
+ * });
+ */
+export const createEntity = async (instanceUrl, token, entityName, data) => {
+    // --- Validate required parameters ---
+    if (!instanceUrl || !token) {
+        throw new Error('Missing required Magentrix instanceUrl or token');
+    }
+    if (!entityName || typeof entityName !== 'string') {
+        throw new Error("Missing required 'entityName' (must be 'ActiveClass' or 'ActivePage')");
+    }
+
+    // Allowed entity types
+    const allowedEntities = ['activeclass', 'activepage'];
+    const entity = entityName.trim().toLowerCase();
+    if (!allowedEntities.includes(entity)) {
+        throw new Error("Invalid 'entityName'. Allowed values: 'ActiveClass' or 'ActivePage'");
+    }
+
+    // Validate data object and required fields
+    if (!data || typeof data !== 'object') {
+        throw new Error('Missing required data object for entity creation');
+    }
+    if (!data.Name) {
+        throw new Error("Missing required field: 'Name' in data");
+    }
+    if (!data.Type) {
+        throw new Error("Missing required field: 'Type' in data");
+    }
+
+    const response = await fetchMagentrix({
+        instanceUrl,
+        token,
+        path: `/api/3.0/entity/${entity}`,
+        method: "POST",
+        body: data,
+        returnErrorObject: true
+    });
+
+    // --- Success: return parsed response ---
+    return response;
+};

package/utils/magentrix/api/deleteEntity.js

@@ -1,55 +1,55 @@
-import { fetchMagentrix } from "../fetch.js";
-
-/**
- * Deletes an existing ActiveClass or ActivePage entity in Magentrix via the REST API.
- *
- * @async
- * @function deleteEntity
- * @param {string} instanceUrl - The base URL of the Magentrix instance (e.g. "https://your.magentrix.com").
- * @param {string} token - The OAuth2 bearer token for authentication.
- * @param {string} entityName - The Magentrix entity type. Allowed: "ActiveClass" or "ActivePage" (case-insensitive).
- * @param {string} recordId - The unique Magentrix record ID of the entity to delete.
- * @returns {Promise<Object>} The API response object, or an error object if the deletion fails.
- * @throws {Error} If required parameters are missing or invalid.
- *
- * @example
- * const deleted = await deleteEntity(
- *   "https://your.magentrix.com",
- *   "yourToken",
- *   "ActiveClass",
- *   "06bdc45e-8222-44f5-9ed2-40f5a7bc6cb3"
- * );
- */
-export const deleteEntity = async (instanceUrl, token, entityName, recordId) => {
-    // --- Validate required parameters ---
-    if (!instanceUrl || typeof instanceUrl !== 'string') {
-        throw new Error('Missing or invalid Magentrix instanceUrl');
-    }
-    if (!token || typeof token !== 'string') {
-        throw new Error('Missing or invalid Magentrix token');
-    }
-    if (!entityName || typeof entityName !== 'string') {
-        throw new Error("Missing or invalid 'entityName' (must be 'ActiveClass' or 'ActivePage')");
-    }
-    if (!recordId || typeof recordId !== 'string') {
-        throw new Error("Missing or invalid 'recordId' (must be a Magentrix record GUID string)");
-    }
-
-    // --- Validate entity type ---
-    const allowedEntities = ['activeclass', 'activepage'];
-    const entity = entityName.trim().toLowerCase();
-    if (!allowedEntities.includes(entity)) {
-        throw new Error("Invalid 'entityName'. Allowed: 'ActiveClass' or 'ActivePage'");
-    }
-
-    // --- Make DELETE request to Magentrix API ---
-    const response = await fetchMagentrix({
-        instanceUrl,
-        token,
-        path: `/api/3.0/entity/${entity}/${recordId}`,
-        method: "DELETE",
-        returnErrorObject: true
-    });
-
-    return response;
-};
+import { fetchMagentrix } from "../fetch.js";
+
+/**
+ * Deletes an existing ActiveClass or ActivePage entity in Magentrix via the REST API.
+ *
+ * @async
+ * @function deleteEntity
+ * @param {string} instanceUrl - The base URL of the Magentrix instance (e.g. "https://your.magentrix.com").
+ * @param {string} token - The OAuth2 bearer token for authentication.
+ * @param {string} entityName - The Magentrix entity type. Allowed: "ActiveClass" or "ActivePage" (case-insensitive).
+ * @param {string} recordId - The unique Magentrix record ID of the entity to delete.
+ * @returns {Promise<Object>} The API response object, or an error object if the deletion fails.
+ * @throws {Error} If required parameters are missing or invalid.
+ *
+ * @example
+ * const deleted = await deleteEntity(
+ *   "https://your.magentrix.com",
+ *   "yourToken",
+ *   "ActiveClass",
+ *   "06bdc45e-8222-44f5-9ed2-40f5a7bc6cb3"
+ * );
+ */
+export const deleteEntity = async (instanceUrl, token, entityName, recordId) => {
+    // --- Validate required parameters ---
+    if (!instanceUrl || typeof instanceUrl !== 'string') {
+        throw new Error('Missing or invalid Magentrix instanceUrl');
+    }
+    if (!token || typeof token !== 'string') {
+        throw new Error('Missing or invalid Magentrix token');
+    }
+    if (!entityName || typeof entityName !== 'string') {
+        throw new Error("Missing or invalid 'entityName' (must be 'ActiveClass' or 'ActivePage')");
+    }
+    if (!recordId || typeof recordId !== 'string') {
+        throw new Error("Missing or invalid 'recordId' (must be a Magentrix record GUID string)");
+    }
+
+    // --- Validate entity type ---
+    const allowedEntities = ['activeclass', 'activepage'];
+    const entity = entityName.trim().toLowerCase();
+    if (!allowedEntities.includes(entity)) {
+        throw new Error("Invalid 'entityName'. Allowed: 'ActiveClass' or 'ActivePage'");
+    }
+
+    // --- Make DELETE request to Magentrix API ---
+    const response = await fetchMagentrix({
+        instanceUrl,
+        token,
+        path: `/api/3.0/entity/${entity}/${recordId}`,
+        method: "DELETE",
+        returnErrorObject: true
+    });
+
+    return response;
+};