directus-template-cli 0.5.0-beta.9 → 0.5.0

package/dist/lib/utils/auth.js

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDirectusToken = exports.getDirectusUrl = void 0;
+exports.validateAuthFlags = exports.initializeDirectusApi = exports.getDirectusToken = exports.getDirectusUrl = void 0;
 const tslib_1 = require("tslib");
 const sdk_1 = require("@directus/sdk");
 const core_1 = require("@oclif/core");
 const sdk_2 = require("../sdk");
 const catch_error_1 = tslib_1.__importDefault(require("./catch-error"));
 const validate_url_1 = tslib_1.__importDefault(require("./validate-url"));
+/**
+ * Get the Directus URL from the user
+ * @returns The Directus URL
+ */
 async function getDirectusUrl() {
     const directusUrl = await core_1.ux.prompt('What is your Directus URL?', { default: 'http://localhost:8055' });
     // Validate URL
@@ -18,13 +22,17 @@ async function getDirectusUrl() {
     return directusUrl;
 }
 exports.getDirectusUrl = getDirectusUrl;
+/**
+ * Get the Directus token from the user
+ * @param directusUrl - The Directus URL
+ * @returns The Directus token
+ */
 async function getDirectusToken(directusUrl) {
     const directusToken = await core_1.ux.prompt('What is your Directus Admin Token?');
-    // Validate token
+    // Validate token by fetching the user
     try {
-        sdk_2.api.setAuthToken(directusToken);
+        await sdk_2.api.loginWithToken(directusToken);
         const response = await sdk_2.api.client.request((0, sdk_1.readMe)());
-        core_1.ux.log(`-- Logged in as ${response.first_name} ${response.last_name}`);
         return directusToken;
     }
     catch (error) {
@@ -39,3 +47,39 @@ async function getDirectusToken(directusUrl) {
     }
 }
 exports.getDirectusToken = getDirectusToken;
+/**
+   * Initialize the Directus API with the provided flags
+   * @param flags - The validated ApplyFlags
+   */
+async function initializeDirectusApi(flags) {
+    sdk_2.api.initialize(flags.directusUrl);
+    try {
+        if (flags.directusToken) {
+            await sdk_2.api.loginWithToken(flags.directusToken);
+        }
+        else if (flags.userEmail && flags.userPassword) {
+            await sdk_2.api.login(flags.userEmail, flags.userPassword);
+        }
+        const response = await sdk_2.api.client.request((0, sdk_1.readMe)());
+        core_1.ux.log(`-- Logged in as ${response.first_name} ${response.last_name}`);
+    }
+    catch {
+        (0, catch_error_1.default)('-- Unable to authenticate with the provided credentials. Please check your credentials.', {
+            fatal: true,
+        });
+    }
+}
+exports.initializeDirectusApi = initializeDirectusApi;
+/**
+ * Validate the authentication flags
+ * @param flags - The AuthFlags
+ */
+function validateAuthFlags(flags) {
+    if (!flags.directusUrl) {
+        core_1.ux.error('Directus URL is required.');
+    }
+    if (!flags.directusToken && (!flags.userEmail || !flags.userPassword)) {
+        core_1.ux.error('Either Directus token or email and password are required.');
+    }
+}
+exports.validateAuthFlags = validateAuthFlags;

package/dist/lib/utils/catch-error.d.ts

@@ -1,6 +1,19 @@
-interface Options {
+/**
+ * Options for configuring the error handler behavior.
+ */
+interface ErrorHandlerOptions {
+    /** Additional context to be included in the error log. */
     context?: Record<string, any>;
+    /** If true, the error will be treated as fatal and the process will exit. */
     fatal?: boolean;
+    /** If true, the error will be logged to a file. */
+    logToFile?: boolean;
 }
-export default function catchError(error: unknown, options?: Options, logToFile?: boolean): void;
+/**
+ * Handles errors by formatting them and optionally logging to console and file.
+ * @param error - The error to be handled.
+ * @param options - Configuration options for error handling.
+ * @returns void
+ */
+export default function catchError(error: unknown, options?: ErrorHandlerOptions): void;
 export {};

package/dist/lib/utils/catch-error.js

@@ -1,35 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
-const logger_1 = require("./logger");
-function catchError(error, options = {}, logToFile = true) {
-    const errorMessage = isDirectusError(error) ? formatDirectusError(error)
-        : (error instanceof Error ? formatGenericError(error)
-            : `${JSON.stringify(error)}`);
-    const contextString = options.context
-        ? Object.entries(options.context)
-            .map(([key, value]) => `${key}: ${JSON.stringify(value)}`)
-            .join(', ') : '';
+const sdk_1 = require("../sdk");
+const logger_1 = require("../utils/logger");
+/**
+ * Handles errors by formatting them and optionally logging to console and file.
+ * @param error - The error to be handled.
+ * @param options - Configuration options for error handling.
+ * @returns void
+ */
+function catchError(error, options = {}) {
+    const { context = {}, fatal = false, logToFile = true } = options;
+    let errorMessage;
+    if (error instanceof sdk_1.DirectusError) {
+        errorMessage = error.message;
+    }
+    else if (error instanceof Error) {
+        errorMessage = `Error: ${error.message}`;
+    }
+    else {
+        errorMessage = `Unknown error: ${JSON.stringify(error)}`;
+    }
+    // Format the error message with context if provided
     const formattedMessage = [
         errorMessage,
-        contextString && `Context: ${contextString}`,
+        Object.keys(context).length > 0 && `Context: ${JSON.stringify(context)}`,
     ].filter(Boolean).join('\n');
-    options.fatal ? core_1.ux.error(formattedMessage) : core_1.ux.warn(formattedMessage);
+    // Log the error message to the console with the appropriate color
+    if (fatal) {
+        // ux.error exits the process with a non-zero code
+        core_1.ux.error(formattedMessage);
+    }
+    else {
+        core_1.ux.warn(formattedMessage);
+    }
     if (logToFile) {
-        logger_1.logger.log('error', errorMessage, options.context);
+        logger_1.logger.log('error', errorMessage, context);
     }
 }
 exports.default = catchError;
-function isDirectusError(error) {
-    // @ts-ignore
-    return error && Array.isArray(error.errors) && error.errors.length > 0;
-}
-function formatDirectusError(error) {
-    var _a;
-    const status = ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) || 'Unknown';
-    const { extensions, message } = error.errors[0];
-    return `Directus Error: ${message.trim()}${extensions ? ` (${JSON.stringify(extensions)})` : ''} (Status: ${status})`;
-}
-function formatGenericError(error) {
-    return `Error: ${error.message}`;
-}

package/oclif.manifest.json

@@ -13,15 +13,6 @@
         "content": {
           "description": "Load Content (data)",
           "name": "content",
-          "relationships": [
-            {
-              "flags": [
-                "schema",
-                "files"
-              ],
-              "type": "all"
-            }
-          ],
           "allowNo": true,
           "type": "boolean"
         },
@@ -33,15 +24,19 @@
         },
         "directusToken": {
           "description": "Token to use for the Directus instance",
-          "env": "TARGET_DIRECTUS_TOKEN",
+          "env": "DIRECTUS_TOKEN",
+          "exclusive": [
+            "userEmail",
+            "userPassword"
+          ],
           "name": "directusToken",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "directusUrl": {
-          "description": "URL of the Directus instance to apply the template to",
-          "env": "TARGET_DIRECTUS_URL",
+          "description": "URL of the Directus instance",
+          "env": "DIRECTUS_URL",
           "name": "directusUrl",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -104,10 +99,9 @@
         },
         "templateLocation": {
           "dependsOn": [
-            "programmatic",
-            "templateType"
+            "programmatic"
           ],
-          "description": "Location of the template to apply",
+          "description": "Location of the template",
           "env": "TEMPLATE_LOCATION",
           "name": "templateLocation",
           "hasDynamicHelp": false,
@@ -132,17 +126,37 @@
           ],
           "type": "option"
         },
+        "userEmail": {
+          "dependsOn": [
+            "userPassword"
+          ],
+          "description": "Email for Directus authentication",
+          "env": "DIRECTUS_EMAIL",
+          "exclusive": [
+            "directusToken"
+          ],
+          "name": "userEmail",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "userPassword": {
+          "dependsOn": [
+            "userEmail"
+          ],
+          "description": "Password for Directus authentication",
+          "env": "DIRECTUS_PASSWORD",
+          "exclusive": [
+            "directusToken"
+          ],
+          "name": "userPassword",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "users": {
           "description": "Load users",
           "name": "users",
-          "relationships": [
-            {
-              "flags": [
-                "permissions"
-              ],
-              "type": "all"
-            }
-          ],
           "allowNo": true,
           "type": "boolean"
         }
@@ -173,15 +187,19 @@
       "flags": {
         "directusToken": {
           "description": "Token to use for the Directus instance",
-          "env": "SOURCE_DIRECTUS_TOKEN",
+          "env": "DIRECTUS_TOKEN",
+          "exclusive": [
+            "userEmail",
+            "userPassword"
+          ],
           "name": "directusToken",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
         "directusUrl": {
-          "description": "URL of the Directus instance to extract the template from",
-          "env": "SOURCE_DIRECTUS_URL",
+          "description": "URL of the Directus instance",
+          "env": "DIRECTUS_URL",
           "name": "directusUrl",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -199,7 +217,7 @@
           "dependsOn": [
             "programmatic"
           ],
-          "description": "Directory to extract the template to",
+          "description": "Location of the template",
           "env": "TEMPLATE_LOCATION",
           "name": "templateLocation",
           "hasDynamicHelp": false,
@@ -216,6 +234,34 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "userEmail": {
+          "dependsOn": [
+            "userPassword"
+          ],
+          "description": "Email for Directus authentication",
+          "env": "DIRECTUS_EMAIL",
+          "exclusive": [
+            "directusToken"
+          ],
+          "name": "userEmail",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "userPassword": {
+          "dependsOn": [
+            "userEmail"
+          ],
+          "description": "Password for Directus authentication",
+          "env": "DIRECTUS_PASSWORD",
+          "exclusive": [
+            "directusToken"
+          ],
+          "name": "userPassword",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -234,5 +280,5 @@
       ]
     }
   },
-  "version": "0.5.0-beta.9"
+  "version": "0.5.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "directus-template-cli",
-  "version": "0.5.0-beta.9",
+  "version": "0.5.0",
   "description": "CLI Utility for applying templates to a Directus instance.",
   "author": "bryantgillespie @bryantgillespie",
   "bin": {
@@ -18,7 +18,6 @@
   ],
   "dependencies": {
     "@directus/sdk": "^17.0.1",
-    "@directus/types": "^12.0.1",
     "@oclif/core": "^3.18.1",
     "@oclif/plugin-help": "^6.0.12",
     "@oclif/plugin-plugins": "^4.1.22",
@@ -31,6 +30,7 @@
     "slugify": "^1.6.6"
   },
   "devDependencies": {
+    "@directus/types": "^12.0.1",
     "@oclif/test": "^3.1.13",
     "@types/chai": "^4.3.11",
     "@types/mocha": "^10.0.6",

package/dist/lib/interfaces.d.ts

@@ -1,8 +0,0 @@
-export interface Diff {
-    diff: {
-        collections: any[];
-        fields: any[];
-        relations: any[];
-    };
-    hash: string;
-}

package/dist/lib/interfaces.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });