directus-template-cli 0.3.6 → 0.4.0

package/dist/lib/extract/extract-dashboards.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractPanels = exports.extractDashboards = 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 filter_fields_1 = tslib_1.__importDefault(require("../utils/filter-fields"));
+const system_fields_1 = require("../utils/system-fields");
+const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+/**
+ * Extract dashboards from the Directus instance
+ */
+async function extractDashboards(dir) {
+    try {
+        const response = await sdk_2.api.client.request((0, sdk_1.readDashboards)({ limit: -1 }));
+        const dashboards = (0, filter_fields_1.default)(response, system_fields_1.directusDashboardFields);
+        await (0, write_to_file_1.default)('dashboards', dashboards, dir);
+        core_1.ux.log('Extracted dashboards');
+    }
+    catch (error) {
+        core_1.ux.warn('Error extracting Dashboards:');
+        core_1.ux.warn(error.message);
+    }
+}
+exports.extractDashboards = extractDashboards;
+/**
+ * Extract panels from the Directus instance
+ */
+async function extractPanels(dir) {
+    try {
+        const response = await sdk_2.api.client.request((0, sdk_1.readPanels)({ limit: -1 }));
+        const panels = (0, filter_fields_1.default)(response, system_fields_1.directusPanelFields);
+        await (0, write_to_file_1.default)('panels', panels, dir);
+        core_1.ux.log('Extracted panels');
+    }
+    catch (error) {
+        core_1.ux.warn('Error extracting Panels:');
+        core_1.ux.warn(error.message);
+    }
+}
+exports.extractPanels = extractPanels;

package/dist/lib/extract/extract-fields.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Extract fields from the Directus instance
+ */
+export default function extractFields(dir: string): Promise<void>;

package/dist/lib/extract/extract-fields.js

@@ -0,0 +1,30 @@
+"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 write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+/**
+ * Extract fields from the Directus instance
+ */
+async function extractFields(dir) {
+    try {
+        const response = await sdk_2.api.client.request((0, sdk_1.readFields)());
+        const fields = response
+            .filter(
+        // @ts-ignore
+        (i) => !i.meta.system)
+            .map(i => {
+            delete i.meta.id;
+            return i;
+        });
+        await (0, write_to_file_1.default)('fields', fields, dir);
+        core_1.ux.log('Extracted fields');
+    }
+    catch (error) {
+        core_1.ux.warn('Error extracting Fields:');
+        core_1.ux.warn(error.message);
+    }
+}
+exports.default = extractFields;

package/dist/lib/extract/extract-files.js

@@ -1,48 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const api_1 = require("../api");
-const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
 const filter_fields_1 = tslib_1.__importDefault(require("../utils/filter-fields"));
-const systemFields = [
-    "id",
-    "storage",
-    "filename_disk",
-    "filename_download",
-    "title",
-    "type",
-    "folder",
-    "uploaded_by",
-    "uploaded_on",
-    "modified_by",
-    "modified_on",
-    "charset",
-    "filesize",
-    "width",
-    "height",
-    "duration",
-    "embed",
-    "description",
-    "location",
-    "tags",
-    "metadata",
-];
+const system_fields_1 = require("../utils/system-fields");
+const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
 /**
  * Extract files from the API
  */
 async function extractFiles(dir) {
     try {
-        const { data } = await api_1.api.get("/files", {
-            params: {
-                limit: "-1",
-            },
-        });
-        const filteredData = (0, filter_fields_1.default)(data.data, systemFields);
-        // Use the dynamic dir parameter
-        await (0, write_to_file_1.default)("files", filteredData, dir);
+        const response = await sdk_2.api.client.request((0, sdk_1.readFiles)({ limit: -1 }));
+        const files = (0, filter_fields_1.default)(response, system_fields_1.directusFileFields);
+        await (0, write_to_file_1.default)('files', files, dir);
+        core_1.ux.log('Extracted files');
     }
     catch (error) {
-        console.log("Error extracting Files:", error.response.data.errors);
+        core_1.ux.warn('Error extracting Files:');
+        core_1.ux.warn(error.message);
     }
 }
 exports.default = extractFiles;

package/dist/lib/extract/extract-flows.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Extract flows from the Directus instance
+ */
+export declare function extractFlows(dir: string): Promise<void>;
+/**
+ * Extract operations from the Directus instance
+ */
+export declare function extractOperations(dir: string): Promise<void>;

package/dist/lib/extract/extract-flows.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractOperations = exports.extractFlows = 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 filter_fields_1 = tslib_1.__importDefault(require("../utils/filter-fields"));
+const system_fields_1 = require("../utils/system-fields");
+const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+/**
+ * Extract flows from the Directus instance
+ */
+async function extractFlows(dir) {
+    try {
+        const response = await sdk_2.api.client.request((0, sdk_1.readFlows)({ limit: -1 }));
+        const flows = (0, filter_fields_1.default)(response, system_fields_1.directusFlowFields);
+        await (0, write_to_file_1.default)('flows', flows, dir);
+        core_1.ux.log('Extracted flows');
+    }
+    catch (error) {
+        core_1.ux.warn('Error extracting Flows:');
+        core_1.ux.warn(error.message);
+    }
+}
+exports.extractFlows = extractFlows;
+/**
+ * Extract operations from the Directus instance
+ */
+async function extractOperations(dir) {
+    try {
+        const response = await sdk_2.api.client.request((0, sdk_1.readOperations)({ limit: -1 }));
+        const operations = (0, filter_fields_1.default)(response, system_fields_1.directusOperationFields);
+        await (0, write_to_file_1.default)('operations', operations, dir);
+        core_1.ux.log('Extracted operations');
+    }
+    catch (error) {
+        core_1.ux.warn('Error extracting Operations:');
+        core_1.ux.warn(error.message);
+    }
+}
+exports.extractOperations = extractOperations;

package/dist/lib/extract/extract-folders.d.ts

@@ -1,4 +1,4 @@
 /**
- * Extract folders from the API
+ * Extract folders from the Directus instance
  */
 export default function extractFolders(dir: string): Promise<void>;

package/dist/lib/extract/extract-folders.js

@@ -1,26 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const api_1 = require("../api");
-const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
 const filter_fields_1 = tslib_1.__importDefault(require("../utils/filter-fields"));
-const systemFields = ["id", "name", "parent"];
+const system_fields_1 = require("../utils/system-fields");
+const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
 /**
- * Extract folders from the API
+ * Extract folders from the Directus instance
  */
 async function extractFolders(dir) {
     try {
-        const { data } = await api_1.api.get("/folders", {
-            params: {
-                limit: "-1",
-            },
-        });
-        const filteredData = (0, filter_fields_1.default)(data.data, systemFields);
-        // Use the dynamic dir parameter
-        await (0, write_to_file_1.default)("folders", filteredData, dir);
+        const response = await sdk_2.api.client.request((0, sdk_1.readFolders)({ limit: -1 }));
+        const folders = (0, filter_fields_1.default)(response, system_fields_1.directusFolderFields);
+        await (0, write_to_file_1.default)('folders', folders, dir);
+        core_1.ux.log('Extracted folders');
     }
     catch (error) {
-        console.log("Error extracting Folders:", error.response.data.errors);
+        core_1.ux.warn('Error extracting Folders:');
+        core_1.ux.warn(error.message);
     }
 }
 exports.default = extractFolders;

package/dist/lib/extract/extract-permissions.d.ts

@@ -1 +1 @@
-export declare function extractPermissions(dir: string): Promise<void>;
+export default function extractPermissions(dir: string): Promise<void>;

package/dist/lib/extract/extract-permissions.js

@@ -1,25 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractPermissions = void 0;
 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 write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
 async function extractPermissions(dir) {
     try {
-        const { data } = await api_1.api.get("permissions", {
-            params: {
-                limit: "-1",
-            },
-        });
+        const response = await sdk_2.api.client.request((0, sdk_1.readPermissions)({
+            limit: -1,
+        }));
         // Delete the id field from the permissions so we don't have to reset the autoincrement on the db
-        data.data.forEach((permission) => {
+        for (const permission of response) {
             delete permission.id;
-        });
-        // Write the public permissions to the specified directory
-        await (0, write_to_file_1.default)("permissions", data.data, dir);
+        }
+        await (0, write_to_file_1.default)('permissions', response, dir);
+        core_1.ux.log('Extracted permissions');
     }
     catch (error) {
-        console.log("Error fetching permissions:", error);
+        core_1.ux.warn('Error extracting permissions:');
+        core_1.ux.warn(error.message);
     }
 }
-exports.extractPermissions = extractPermissions;
+exports.default = extractPermissions;

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

@@ -1,29 +1,33 @@
 "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 write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
 /**
  * Extract Presets from the API
  */
 async function extractPresets(dir) {
     try {
-        const { data } = await api_1.api.get("/presets", {
-            params: {
-                limit: "-1",
-                // Only get the global presets
-                "filter[user][_null]": true,
-            },
-        });
+        const response = await sdk_2.api.client.request((0, sdk_1.readPresets)({
+            // Only get the global presets
+            filter: { user: {
+                    _null: true,
+                } },
+            limit: -1,
+        }));
         // Remove the id field from the presets so we don't have to reset the autoincrement on the db
-        const filteredData = data.data.map((preset) => {
+        const presets = response.map((preset) => {
             delete preset.id;
             return preset;
         });
-        await (0, write_to_file_1.default)("presets", filteredData, dir);
+        await (0, write_to_file_1.default)('presets', presets, dir);
+        core_1.ux.log('Extracted presets');
     }
     catch (error) {
-        console.log("Error extracting Users:", error.response.data.errors);
+        core_1.ux.warn('Error extracting Users:');
+        core_1.ux.warn(error.message);
     }
 }
 exports.default = extractPresets;

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

@@ -0,0 +1,4 @@
+/**
+ * Extract relations from the Directus instance
+ */
+export default function extractRelations(dir: string): Promise<void>;

package/dist/lib/extract/extract-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 write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+/**
+ * Extract relations from the Directus instance
+ */
+async function extractRelations(dir) {
+    try {
+        const response = await sdk_2.api.client.request((0, sdk_1.readRelations)());
+        // Fetching fields to filter out system fields while retaining custom fields on system collections
+        const fields = await sdk_2.api.client.request((0, sdk_1.readFields)());
+        const customFields = fields.filter((i) => !i.meta.system);
+        const relations = response
+            // Filter out relations where the collection starts with 'directus_' && the field is not within the customFields array
+            .filter((i) => !i.collection.startsWith('directus_', 0)
+            || customFields.some((f) => f.collection === i.collection && f.field === i.field))
+            .map(i => {
+            delete i.meta.id;
+            return i;
+        });
+        await (0, write_to_file_1.default)('relations', relations, dir);
+        core_1.ux.log('Extracted relations');
+    }
+    catch (error) {
+        core_1.ux.warn('Error extracting Relations:');
+        core_1.ux.warn(error.message);
+    }
+}
+exports.default = extractRelations;

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

@@ -1,36 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const api_1 = require("../api");
-const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
 const filter_fields_1 = tslib_1.__importDefault(require("../utils/filter-fields"));
-const systemFields = [
-    "id",
-    "name",
-    "description",
-    "icon",
-    "enforce_tfa",
-    "external_id",
-    "ip_whitelist",
-    "app_access",
-    "admin_access",
-];
+const system_fields_1 = require("../utils/system-fields");
+const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
 /**
  * Extract roles from the API
  */
 async function extractRoles(dir) {
     try {
-        const { data } = await api_1.api.get("/roles", {
-            params: {
-                limit: "-1",
-            },
-        });
-        const filteredData = (0, filter_fields_1.default)(data.data, systemFields);
-        // Use the dynamic dir parameter
-        await (0, write_to_file_1.default)("roles", filteredData, dir);
+        const response = await sdk_2.api.client.request((0, sdk_1.readRoles)({ limit: -1 }));
+        const roles = (0, filter_fields_1.default)(response, system_fields_1.directusRoleFields);
+        await (0, write_to_file_1.default)('roles', roles, dir);
+        core_1.ux.log('Extracted roles');
     }
     catch (error) {
-        console.log("Error extracting Roles:", error.response.data.errors);
+        core_1.ux.warn('Error extracting Roles:');
+        core_1.ux.warn(error.message);
     }
 }
 exports.default = extractRoles;

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

@@ -1,29 +1,29 @@
 "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 node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const api_1 = require("../api");
+const sdk_2 = require("../sdk");
 const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
 async function extractSchema(dir) {
-    const schemaDir = node_path_1.default.join(dir, "schema");
-    // Check if directory for schema exists, if not, then create it.
-    if (!node_fs_1.default.existsSync(schemaDir)) {
-        console.log(`Attempting to create directory at: ${schemaDir}`);
-        node_fs_1.default.mkdirSync(schemaDir, { recursive: true });
-    }
+    const schemaDir = node_path_1.default.join(dir, 'schema');
     // Get the schema
     try {
-        const { data } = await api_1.api.get("/schema/snapshot", {
-            params: {
-                limit: "-1",
-            },
-        });
+        // Check if directory for schema exists, if not, then create it.
+        if (!node_fs_1.default.existsSync(schemaDir)) {
+            console.log(`Attempting to create directory at: ${schemaDir}`);
+            node_fs_1.default.mkdirSync(schemaDir, { recursive: true });
+        }
+        const schema = await sdk_2.api.client.request((0, sdk_1.schemaSnapshot)());
         // Write the schema to the specified directory
-        await (0, write_to_file_1.default)("schema/snapshot", data.data, dir);
+        await (0, write_to_file_1.default)('schema/snapshot', schema, dir);
+        core_1.ux.log('Extracted schema snapshot');
     }
     catch (error) {
-        console.log("Error fetching schema snapshot:", error);
+        core_1.ux.warn('Error extracting Schema Snapshot:');
+        core_1.ux.warn(error.message);
     }
 }
 exports.default = extractSchema;

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

@@ -0,0 +1,4 @@
+/**
+ * Extract settings from the Directus instance
+ */
+export default function extractSettings(dir: string): Promise<void>;

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

@@ -0,0 +1,22 @@
+"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 write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+/**
+ * Extract settings from the Directus instance
+ */
+async function extractSettings(dir) {
+    try {
+        const settings = await sdk_2.api.client.request((0, sdk_1.readSettings)({ limit: -1 }));
+        await (0, write_to_file_1.default)('settings', settings, dir);
+        core_1.ux.log('Extracted settings');
+    }
+    catch (error) {
+        core_1.ux.warn('Error extracting Settings:');
+        core_1.ux.warn(error.message);
+    }
+}
+exports.default = extractSettings;

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

@@ -0,0 +1,4 @@
+/**
+ * Extract translations from the Directus instance
+ */
+export default function extractTranslations(dir: string): Promise<void>;

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

@@ -0,0 +1,24 @@
+"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 write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+/**
+ * Extract translations from the Directus instance
+ */
+async function extractTranslations(dir) {
+    try {
+        const translations = await sdk_2.api.client.request((0, sdk_1.readTranslations)({
+            limit: -1,
+        }));
+        await (0, write_to_file_1.default)('translations', translations, dir);
+        core_1.ux.log('Extracted translations');
+    }
+    catch (error) {
+        core_1.ux.warn('Error extracting Translations:');
+        core_1.ux.warn(error.message);
+    }
+}
+exports.default = extractTranslations;

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

@@ -1,4 +1,4 @@
 /**
- * Extract users from the API
+ * Extract users from the Directus instance
  */
 export default function extractUsers(dir: string): Promise<void>;

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

@@ -1,49 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-const api_1 = require("../api");
-const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+const sdk_1 = require("@directus/sdk");
+const core_1 = require("@oclif/core");
+const sdk_2 = require("../sdk");
 const filter_fields_1 = tslib_1.__importDefault(require("../utils/filter-fields"));
-const systemFields = [
-    "id",
-    "status",
-    "first_name",
-    "last_name",
-    "email",
-    "password",
-    "token",
-    "last_access",
-    "last_page",
-    "external_identifier",
-    "tfa_secret",
-    "auth_data",
-    "provider",
-    "theme",
-    "role",
-    "language",
-    "avatar",
-    "title",
-    "description",
-    "location",
-    "tags",
-    "email_notifications",
-];
+const system_fields_1 = require("../utils/system-fields");
+const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
 /**
- * Extract users from the API
+ * Extract users from the Directus instance
  */
 async function extractUsers(dir) {
     try {
-        const { data } = await api_1.api.get("/users", {
-            params: {
-                limit: "-1",
-            },
-        });
-        const filteredData = (0, filter_fields_1.default)(data.data, systemFields);
-        // Use the dynamic dir parameter
-        await (0, write_to_file_1.default)("users", filteredData, dir);
+        const response = await sdk_2.api.client.request((0, sdk_1.readUsers)({
+            limit: -1,
+        }));
+        const users = (0, filter_fields_1.default)(response, system_fields_1.directusUserFields);
+        await (0, write_to_file_1.default)('users', users, dir);
+        core_1.ux.log('Extracted users');
     }
     catch (error) {
-        console.log("Error extracting Users:", error.response.data.errors);
+        core_1.ux.warn('Error extracting Users:');
+        core_1.ux.warn(error.message);
     }
 }
 exports.default = extractUsers;

package/dist/lib/extract/index.d.ts

@@ -1 +1 @@
-export default function extract(dir: string, cli: any): Promise<{}>;
+export default function extract(dir: string): Promise<{}>;