directus-template-cli 0.3.5 → 0.4.0-beta.0

package/dist/lib/load/load-presets.js

@@ -1,28 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const api_1 = require("../api");
-exports.default = async (presets) => {
-    await deleteAllPresets();
-    const cleanPresets = presets.map((preset) => {
+const tslib_1 = require("tslib");
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
+const log_error_1 = tslib_1.__importDefault(require("../utils/log-error"));
+const read_file_1 = tslib_1.__importDefault(require("../utils/read-file"));
+async function loadPresets(dir) {
+    const presets = (0, read_file_1.default)('presets', dir);
+    core_1.ux.action.start(`Loading ${presets.length} presets`);
+    const cleanPresets = presets.map(preset => {
         preset.user = null;
         return preset;
     });
     try {
-        await api_1.api.post("presets", cleanPresets);
+        await sdk_2.api.client.request((0, sdk_1.createPresets)(cleanPresets));
     }
     catch (error) {
-        console.log("Error uploading preset", error.response.data.errors);
+        (0, log_error_1.default)(error);
     }
-};
-const deleteAllPresets = async () => {
-    try {
-        const { data: presets } = await api_1.api.get("presets");
-        const ids = presets.data.map((preset) => preset.id);
-        await api_1.api.delete("presets", {
-            data: ids,
-        });
-    }
-    catch (error) {
-        console.log("Error removing existing presets", error.response.data.errors);
-    }
-};
+    core_1.ux.action.stop();
+    core_1.ux.log('Loaded presets');
+}
+exports.default = loadPresets;

package/dist/lib/load/load-relations.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Load relationships into the Directus instance
+ */
+export default function loadRelations(dir: string): Promise<void>;

package/dist/lib/load/load-relations.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
+const log_error_1 = tslib_1.__importDefault(require("../utils/log-error"));
+const read_file_1 = tslib_1.__importDefault(require("../utils/read-file"));
+/**
+ * Load relationships into the Directus instance
+ */
+async function loadRelations(dir) {
+    const relations = (0, read_file_1.default)('relations', dir);
+    core_1.ux.action.start(`Loading ${relations.length} relations`);
+    const relationsToAdd = relations.map(i => {
+        delete i.meta.id;
+        return i;
+    });
+    await addRelations(relationsToAdd);
+    core_1.ux.action.stop();
+    core_1.ux.log('Loaded relations');
+}
+exports.default = loadRelations;
+async function addRelations(relations) {
+    for await (const relation of relations) {
+        try {
+            await sdk_2.api.client.request((0, sdk_1.createRelation)(relation));
+        }
+        catch (error) {
+            (0, log_error_1.default)(error);
+        }
+    }
+}

package/dist/lib/load/load-roles.d.ts

@@ -1 +1 @@
-export default function loadRoles(roles: any): Promise<void>;
+export default function loadRoles(dir: string): Promise<void>;

package/dist/lib/load/load-roles.js

@@ -1,21 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const api_1 = require("../api");
-async function loadRoles(roles) {
-    const cleanedUpRoles = roles.map((role) => {
+const tslib_1 = require("tslib");
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
+const log_error_1 = tslib_1.__importDefault(require("../utils/log-error"));
+const read_file_1 = tslib_1.__importDefault(require("../utils/read-file"));
+async function loadRoles(dir) {
+    const roles = (0, read_file_1.default)('roles', dir);
+    core_1.ux.action.start(`Loading ${roles.length} roles`);
+    const cleanedUpRoles = roles.map(role => {
         delete role.users;
         return role;
     });
-    const adminRole = cleanedUpRoles.find((role) => role.name === "Administrator");
+    const adminRole = cleanedUpRoles.find(role => role.name === 'Administrator');
     // Admin role isn't touched.
-    const customRoles = cleanedUpRoles.filter((role) => role.name !== "Administrator");
+    const customRoles = cleanedUpRoles.filter(role => role.name !== 'Administrator');
     try {
-        const { data } = await api_1.api.post("roles", customRoles);
+        // Create the custom roles aside from public and admin
+        await sdk_2.api.client.request((0, sdk_1.createRoles)(customRoles));
+        // Update the admin role
+        await sdk_2.api.client.request((0, sdk_1.updateRole)(adminRole.id, adminRole));
     }
-    catch {
-        // maybe the roles already exist
+    catch (error) {
+        (0, log_error_1.default)(error);
     }
-    const adminUpdate = await api_1.api.patch(`roles/${adminRole.id}`, adminRole);
-    console.log("Seeded Roles");
+    core_1.ux.action.stop();
+    core_1.ux.log('Loaded roles');
 }
 exports.default = loadRoles;

package/dist/lib/load/load-schema.js

@@ -1,20 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const api_1 = require("../api");
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
+const log_error_1 = tslib_1.__importDefault(require("../utils/log-error"));
 const read_file_1 = tslib_1.__importDefault(require("../utils/read-file"));
 exports.default = async (dir) => {
+    core_1.ux.log('Loading schema • collections, fields, and relations...');
     const schema = (0, read_file_1.default)('snapshot', dir);
-    const { data } = await api_1.api.post('schema/diff?force', schema);
-    if (!data.data) {
-        console.log('No schema changes to apply');
+    // @ts-ignore
+    const data = await sdk_2.api.client.request((0, sdk_1.schemaDiff)(schema, true));
+    if (!data) {
+        core_1.ux.log('No schema to apply');
         return;
     }
     try {
-        await api_1.api.post('schema/apply', data.data);
-        // console.log('Schema Loaded')
+        await sdk_2.api.client.request((0, sdk_1.schemaApply)(data));
+        core_1.ux.log('Loaded schema');
     }
     catch (error) {
-        console.log('Error Applying schema', error.response.data.errors);
+        (0, log_error_1.default)(error);
     }
 };

package/dist/lib/load/load-settings.d.ts

@@ -1 +1 @@
-export default function loadSettings(settingsObj: any): Promise<void>;
+export default function loadSettings(dir: string): Promise<void>;

package/dist/lib/load/load-settings.js

@@ -1,12 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const api_1 = require("../api");
-async function loadSettings(settingsObj) {
+const tslib_1 = require("tslib");
+const sdk_1 = require("@directus/sdk");
+const sdk_2 = require("../sdk");
+const log_error_1 = tslib_1.__importDefault(require("../utils/log-error"));
+const read_file_1 = tslib_1.__importDefault(require("../utils/read-file"));
+async function loadSettings(dir) {
+    const settings = (0, read_file_1.default)('settings', dir);
     try {
-        const { data } = await api_1.api.patch('settings', settingsObj);
+        // @ts-ignore
+        await sdk_2.api.client.request((0, sdk_1.updateSettings)(settings));
     }
     catch (error) {
-        console.log('Error loading settings', error.response.data.errors);
+        (0, log_error_1.default)(error);
     }
 }
 exports.default = loadSettings;

package/dist/lib/load/load-translations.d.ts

@@ -0,0 +1 @@
+export default function loadTranslations(dir: string): Promise<void>;

package/dist/lib/load/load-translations.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
+const log_error_1 = tslib_1.__importDefault(require("../utils/log-error"));
+const read_file_1 = tslib_1.__importDefault(require("../utils/read-file"));
+async function loadTranslations(dir) {
+    core_1.ux.action.start('Loading translations');
+    const translations = (0, read_file_1.default)('translations', dir);
+    try {
+        await sdk_2.api.client.request((0, sdk_1.createTranslations)(translations));
+    }
+    catch (error) {
+        (0, log_error_1.default)(error);
+    }
+    core_1.ux.action.stop();
+    core_1.ux.log('Loaded translations');
+}
+exports.default = loadTranslations;

package/dist/lib/load/load-users.d.ts

@@ -1,2 +1 @@
-declare const _default: (users: any[], legacyAdminRoleId: string | number, newAdminRoleId: string | number) => Promise<void>;
-export default _default;
+export default function loadUsers(dir: string): Promise<void>;

package/dist/lib/load/load-users.js

@@ -1,8 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const api_1 = require("../api");
-exports.default = async (users, legacyAdminRoleId, newAdminRoleId) => {
-    const cleanedUpUsers = users.map((user) => {
+const tslib_1 = require("tslib");
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
+const get_role_ids_1 = tslib_1.__importDefault(require("../utils/get-role-ids"));
+const log_error_1 = tslib_1.__importDefault(require("../utils/log-error"));
+const read_file_1 = tslib_1.__importDefault(require("../utils/read-file"));
+async function loadUsers(dir) {
+    const users = (0, read_file_1.default)('users', dir);
+    core_1.ux.action.start(`Loading ${users.length} users`);
+    const { legacyAdminRoleId, newAdminRoleId } = await (0, get_role_ids_1.default)(dir);
+    const filteredUsers = users.map(user => {
         // If the user is an admin, we need to change their role to the new admin role
         const isAdmin = user.role === legacyAdminRoleId;
         user.role = isAdmin ? newAdminRoleId : user.role;
@@ -11,13 +20,15 @@ exports.default = async (users, legacyAdminRoleId, newAdminRoleId) => {
         delete user.token;
         return user;
     });
-    for (const user of cleanedUpUsers) {
+    for (const user of filteredUsers) {
         try {
-            await api_1.api.post("users", user);
-            // console.log('Uploaded User' + user.email)
+            await sdk_2.api.client.request((0, sdk_1.createUser)(user));
         }
         catch (error) {
-            console.log("Error uploading user.", error.response.data.errors);
+            (0, log_error_1.default)(error);
         }
     }
-};
+    core_1.ux.action.stop();
+    core_1.ux.log('Loaded users');
+}
+exports.default = loadUsers;

package/dist/lib/sdk.d.ts

@@ -0,0 +1,13 @@
+import type { AuthenticationClient, RestClient } from '@directus/sdk';
+export interface Schema {
+    any: any;
+}
+declare class Api {
+    client: RestClient<Schema> & AuthenticationClient<Schema> | undefined;
+    private limiter;
+    constructor();
+    initialize(url: string): void;
+    setAuthToken(token: string): void;
+}
+declare const api: Api;
+export { api };

package/dist/lib/sdk.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.api = void 0;
+const tslib_1 = require("tslib");
+const sdk_1 = require("@directus/sdk");
+const bottleneck_1 = tslib_1.__importDefault(require("bottleneck"));
+class Api {
+    constructor() {
+        this.limiter = new bottleneck_1.default({
+            minTime: 100, // Set min time between tasks here (1000 ms = 1 second)
+            // You can set other options here as well.
+        });
+    }
+    initialize(url) {
+        this.client = (0, sdk_1.createDirectus)(url, {
+            globals: {
+                fetch: (...args) => this.limiter.schedule(() => fetch(...args)),
+            },
+        }).with((0, sdk_1.rest)()).with((0, sdk_1.authentication)());
+    }
+    setAuthToken(token) {
+        this.client.setToken(token);
+    }
+}
+const api = new Api();
+exports.api = api;

package/dist/lib/utils/auth.d.ts

@@ -1,2 +1,2 @@
-export declare function getDirectusUrl(): any;
-export declare function getDirectusToken(directusUrl: string): any;
+export declare function getDirectusUrl(): Promise<string>;
+export declare function getDirectusToken(directusUrl: string): Promise<string>;

package/dist/lib/utils/auth.js

@@ -2,32 +2,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDirectusToken = exports.getDirectusUrl = void 0;
 const tslib_1 = require("tslib");
+const sdk_1 = require("@directus/sdk");
 const core_1 = require("@oclif/core");
-const api_1 = require("../api");
+const sdk_2 = require("../sdk");
 const validate_url_1 = tslib_1.__importDefault(require("./validate-url"));
 async function getDirectusUrl() {
-    const directusUrl = await core_1.ux.prompt("What is your Directus URL?");
+    const directusUrl = await core_1.ux.prompt('What is your Directus URL?', { default: 'http://localhost:8055' });
     // Validate URL
     if (!(0, validate_url_1.default)(directusUrl)) {
-        core_1.ux.warn("Invalid URL");
+        core_1.ux.warn('Invalid URL');
         return getDirectusUrl();
     }
+    sdk_2.api.initialize(directusUrl);
     return directusUrl;
 }
 exports.getDirectusUrl = getDirectusUrl;
 async function getDirectusToken(directusUrl) {
-    const directusToken = await core_1.ux.prompt("What is your Directus Admin Token?");
+    const directusToken = await core_1.ux.prompt('What is your Directus Admin Token?');
     // Validate token
     try {
-        await api_1.api.get("/users/me", {
-            headers: {
-                Authorization: `Bearer ${directusToken}`,
-            },
-        });
+        sdk_2.api.setAuthToken(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 {
-        core_1.ux.warn("Invalid token");
+    catch (error) {
+        console.log(error);
+        core_1.ux.warn('Invalid token. Please try again.');
         return getDirectusToken(directusUrl);
     }
 }

package/dist/lib/utils/check-template.d.ts

@@ -0,0 +1,4 @@
+export default function checkTemplate(dir: string): Promise<{
+    collections: boolean;
+    schema: boolean;
+}>;

package/dist/lib/utils/check-template.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const read_file_1 = tslib_1.__importDefault(require("../utils/read-file"));
+async function checkTemplate(dir) {
+    // Check for the schema file and the collections,fields, and relations files
+    const schemaDir = node_path_1.default.join(dir, 'schema');
+    const schema = (0, read_file_1.default)('snapshot', schemaDir);
+    const isSchemaOk = checkSchema(schema);
+    const collections = (0, read_file_1.default)('collections', dir);
+    const fields = (0, read_file_1.default)('fields', dir);
+    const relations = (0, read_file_1.default)('relations', dir);
+    const isCollectionsOk = collections.length > 0 && fields.length > 0 && relations.length > 0;
+    // There are two ways to load the schema. 1. Using the schema file and endpoints which will overwrite the schema. 2. Using the collections, fields, and relations files which will add to the schema. Older templates only supported the schema file and didn't extract the collections, fields, and relations files. Newer templates support both methods.
+    return {
+        collections: isCollectionsOk,
+        schema: isSchemaOk,
+    };
+}
+exports.default = checkTemplate;
+const requiredSchemaKeys = ['version', 'collections', 'fields', 'relations', 'directus'];
+function checkSchema(schema) {
+    if (!schema) {
+        return false;
+    }
+    const schemaKeys = Object.keys(schema);
+    for (const key of requiredSchemaKeys) {
+        if (!schemaKeys.includes(key)) {
+            return false;
+        }
+    }
+    return true;
+}

package/dist/lib/utils/filter-fields.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// Utility function to filter out non-system fields
+// Utility function to remove relationship data (arrays of integers or UUIDs) from system collection data. Used for when custom fields are added to system collections. The relational data should be populated when the actual data is loaded.
 function filterFields(dataArray, systemFields) {
-    return dataArray.map((item) => {
+    return dataArray.map(item => {
         for (const key of Object.keys(item)) {
             if (!systemFields.includes(key)) {
                 const value = item[key];
                 if (Array.isArray(value)) {
-                    const isArrayOfIntegers = value.every((v) => Number.isInteger(v));
-                    const isArrayOfUUIDs = value.every((v) => typeof v === "string" &&
-                        /[\dA-Fa-f]{8}(?:-[\dA-Fa-f]{4}){3}-[\dA-Fa-f]{12}/.test(v));
+                    const isArrayOfIntegers = value.every(v => Number.isInteger(v));
+                    const isArrayOfUUIDs = value.every(v => typeof v === 'string'
+                        && /[\dA-Fa-f]{8}(?:-[\dA-Fa-f]{4}){3}-[\dA-Fa-f]{12}/.test(v));
                     if (isArrayOfIntegers || isArrayOfUUIDs) {
                         item[key] = null; // or item[key] = [];
                     }

package/dist/lib/utils/get-role-ids.d.ts

@@ -0,0 +1,55 @@
+export default function getRoleIds(dir: string): Promise<{
+    legacyAdminRoleId: any;
+    newAdminRoleId: string | {
+        id: string;
+        name: string;
+        icon: string;
+        description: string;
+        ip_access: string;
+        enforce_tfa: boolean;
+        admin_access: boolean;
+        app_access: boolean;
+    } | import("@directus/sdk/dist/types-ZBNrmR-A").ax<import("@directus/sdk/dist/types-ZBNrmR-A").a8<{
+        id: string;
+        name: string;
+        icon: string;
+        description: string;
+        ip_access: string;
+        enforce_tfa: boolean;
+        admin_access: boolean;
+        app_access: boolean;
+    }, "name" | "description" | "id" | "icon" | "ip_access" | "enforce_tfa" | "admin_access" | "app_access", import("@directus/sdk/dist/types-ZBNrmR-A").aI<import("../sdk").Schema, {
+        id: string;
+        name: string;
+        icon: string;
+        description: string;
+        ip_access: string;
+        enforce_tfa: boolean;
+        admin_access: boolean;
+        app_access: boolean;
+    }>>, {
+        [x: string]: never;
+        [x: number]: never;
+    }, import("@directus/sdk/dist/types-ZBNrmR-A").a8<{
+        id: string;
+        name: string;
+        icon: string;
+        description: string;
+        ip_access: string;
+        enforce_tfa: boolean;
+        admin_access: boolean;
+        app_access: boolean;
+    }, "name" | "description" | "id" | "icon" | "ip_access" | "enforce_tfa" | "admin_access" | "app_access", import("@directus/sdk/dist/types-ZBNrmR-A").aI<import("../sdk").Schema, {
+        id: string;
+        name: string;
+        icon: string;
+        description: string;
+        ip_access: string;
+        enforce_tfa: boolean;
+        admin_access: boolean;
+        app_access: boolean;
+    }>>, {
+        [x: string]: never;
+        [x: number]: never;
+    }>;
+}>;

package/dist/lib/utils/get-role-ids.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const sdk_1 = require("@directus/sdk");
+const sdk_2 = require("../sdk");
+const read_file_1 = tslib_1.__importDefault(require("./read-file"));
+async function getRoleIds(dir) {
+    const roles = (0, read_file_1.default)('roles', dir);
+    const legacyAdminRoleId = roles.find(role => role.name === 'Administrator').id;
+    const currentUser = await sdk_2.api.client.request((0, sdk_1.readMe)());
+    const newAdminRoleId = currentUser.role;
+    return { legacyAdminRoleId, newAdminRoleId };
+}
+exports.default = getRoleIds;

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

@@ -0,0 +1,14 @@
+interface Error {
+    errors: {
+        message: string;
+    }[];
+    response: {
+        status: number;
+    };
+}
+interface Options {
+    fatal?: boolean;
+    logToFile?: boolean;
+}
+export default function logError(error: Error, options?: Options): void;
+export {};

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+const node_path_1 = tslib_1.__importDefault(require("node:path"));
+function logError(error, options = {}) {
+    const errorMessage = `Status ${error.response.status} • ${error.errors[0].message}\n`;
+    if (options.fatal) {
+        core_1.ux.error(errorMessage);
+    }
+    else {
+        core_1.ux.warn(errorMessage);
+    }
+    if (options.logToFile) {
+        const logFilePath = node_path_1.default.join(__dirname, 'error.log');
+        try {
+            node_fs_1.default.appendFileSync(logFilePath, `${new Date().toISOString()} - ${errorMessage}`);
+        }
+        catch (fileError) {
+            console.error('Error writing to log file:', fileError);
+        }
+    }
+}
+exports.default = logError;

package/dist/lib/utils/read-templates.js

@@ -5,9 +5,9 @@ const tslib_1 = require("tslib");
 const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 async function readTemplate(directoryPath) {
-    const packageFilePath = node_path_1.default.join(directoryPath, "package.json");
+    const packageFilePath = node_path_1.default.join(directoryPath, 'package.json');
     try {
-        const packageData = await node_fs_1.default.promises.readFile(packageFilePath, "utf-8");
+        const packageData = await node_fs_1.default.promises.readFile(packageFilePath, 'utf8');
         const packageJson = JSON.parse(packageData);
         if (packageJson.templateName) {
             return {

package/dist/lib/utils/system-fields.d.ts

@@ -0,0 +1,20 @@
+export declare const directusUserFields: string[];
+export declare const directusRoleFields: string[];
+export declare const directusFileFields: string[];
+export declare const directusFolderFields: string[];
+export declare const directusFlowFields: string[];
+export declare const directusOperationFields: string[];
+export declare const directusDashboardFields: string[];
+export declare const directusPanelFields: string[];
+export declare const directusSettingsFields: string[];
+export declare const systemFields: {
+    directus_dashboards: string[];
+    directus_files: string[];
+    directus_flows: string[];
+    directus_folders: string[];
+    directus_operations: string[];
+    directus_panels: string[];
+    directus_roles: string[];
+    directus_settings: string[];
+    directus_users: string[];
+};