directus-template-cli 0.2.0 → 0.3.0-beta.2

package/README.md

@@ -1,19 +1,43 @@
 # Directus Template CLI
 
-A CLI tool to apply Directus "templates" to a blank Directus instance.
+A CLI tool to make applying or extracting Directus "templates" a little easier...well a lot easier.
 
-Note: This is a pre-release. It is recommended for use on POC or demo projects only.
+**Notes:**
+
+- This is a pre-release. It is recommended for use on POC or demo projects only.
+- ⚠️ Known issues with using MySQL currently, please use ONLY PostgreSQL or SQLite for your database provider.
+- Templates are applied / extracted on an all or nothing basis – meaning that all the schema, content, and system settings are extracted or applied. We'd love to support more granular operations in the future. (PRs welcome 🙏)
 
 ## Usage
 
+### Applying a Template
+
+**To avoid potential conflicts and bad outcomes, templates can only be applied to a blank instance currently.**
+
 1. Create a Directus instance on [Directus Cloud](https://directus.cloud) or using self-hosted version.
 2. Login and create a Static Access Token for the admin user.
 3. Copy the static token and your Directus URL.
 4. Run the following command on the terminal and follow the prompts.
+
 ```
 $ npx directus-template-cli apply
 ```
 
+You can choose from our templates bundled with the CLI or you can also choose a template from a local directory.
+
+### Extracting a Template
+
+The CLI can also extract a template from a Directus instance so that it can be applied to other instances.
+
+1. Make sure you remove any sensitive data from the Directus instance you don't want to include in the template.
+2. Login and create a Static Access Token for the admin user.
+3. Copy the static token and your Directus URL.
+4. Run the following command on the terminal and follow the prompts.
+
+```
+$ npx directus-template-cli extract
+```
+
 ## License
 
-This template is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+This tool is licensed under the [MIT License](https://opensource.org/licenses/MIT).

package/dist/commands/apply.d.ts

@@ -1,4 +1,4 @@
-import { Command } from '@oclif/core';
+import { Command } from "@oclif/core";
 export default class ApplyCommand extends Command {
     static description: string;
     static examples: string[];

package/dist/commands/apply.js

@@ -4,50 +4,61 @@ const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const core_2 = require("@oclif/core");
 const inquirer = tslib_1.__importStar(require("inquirer"));
-const read_templates_1 = tslib_1.__importDefault(require("../lib/utils/read-templates"));
-const validate_url_1 = tslib_1.__importDefault(require("../lib/utils/validate-url"));
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
+const read_templates_1 = require("../lib/utils/read-templates");
 const api_1 = require("../lib/api");
 const load_1 = tslib_1.__importDefault(require("../lib/load/"));
-const separator = '------------------';
+const auth_1 = require("../lib/utils/auth");
+const separator = "------------------";
 async function getTemplate() {
-    const TEMPLATE_DIR = node_path_1.default.join(__dirname, '..', '..', 'templates');
-    const templates = await (0, read_templates_1.default)(TEMPLATE_DIR);
-    const templateChoices = templates.map((template) => {
+    const TEMPLATE_DIR = node_path_1.default.join(__dirname, "..", "..", "templates");
+    const templates = await (0, read_templates_1.readAllTemplates)(TEMPLATE_DIR);
+    const officialTemplateChoices = templates.map((template) => {
         return { name: template.templateName, value: template };
     });
-    const template = await inquirer.prompt([{
-            name: 'template',
-            message: 'Select a template.',
-            type: 'list',
-            choices: templateChoices,
-        }]);
-    return template;
-}
-async function getDirectusUrl() {
-    const directusUrl = await core_2.ux.prompt('What is your Directus URL?');
-    // Validate URL
-    if (!(0, validate_url_1.default)(directusUrl)) {
-        core_2.ux.warn('Invalid URL');
-        return getDirectusUrl();
-    }
-    return directusUrl;
-}
-async function getDirectusToken(directusUrl) {
-    const directusToken = await core_2.ux.prompt('What is your Directus Admin Token?');
-    // Validate token
-    try {
-        await api_1.api.get('/users/me', {
-            headers: {
-                Authorization: `Bearer ${directusToken}`,
+    const templateType = await inquirer.prompt([
+        {
+            name: "templateType",
+            message: "What type of template would you like to apply?",
+            type: "list",
+            choices: [
+                {
+                    name: "Official templates",
+                    value: "official",
+                },
+                {
+                    name: "From a local directory",
+                    value: "local",
+                },
+                // {
+                //   name: "From a git repository",
+                //   value: "git",
+                // },
+            ],
+        },
+    ]);
+    let template;
+    if (templateType.templateType === "official") {
+        template = await inquirer.prompt([
+            {
+                name: "template",
+                message: "Select a template.",
+                type: "list",
+                choices: officialTemplateChoices,
             },
-        });
-        return directusToken;
+        ]);
     }
-    catch {
-        core_2.ux.warn('Invalid token');
-        return getDirectusToken(directusUrl);
+    if (templateType.templateType === "local") {
+        const localTemplateDir = await core_2.ux.prompt("What is the local template directory?");
+        if (!node_fs_1.default.existsSync(localTemplateDir)) {
+            core_2.ux.error("Directory does not exist.");
+        }
+        else {
+            template = { template: await (0, read_templates_1.readTemplate)(localTemplateDir) };
+        }
     }
+    return template;
 }
 class ApplyCommand extends core_1.Command {
     async run() {
@@ -55,32 +66,30 @@ class ApplyCommand extends core_1.Command {
         const chosenTemplate = await getTemplate();
         this.log(`You selected ${chosenTemplate.template.templateName}`);
         this.log(separator);
-        const directusUrl = await getDirectusUrl();
+        const directusUrl = await (0, auth_1.getDirectusUrl)();
         api_1.api.setBaseUrl(directusUrl);
-        const directusToken = await getDirectusToken(directusUrl);
+        const directusToken = await (0, auth_1.getDirectusToken)(directusUrl);
         api_1.api.setAuthToken(directusToken);
         this.log(separator);
         // Check if Directus instance is empty, if not, throw error
-        const { data } = await api_1.api.get('/collections');
+        const { data } = await api_1.api.get("/collections");
         // Look for collections that don't start with directus_
         const collections = data.data.filter((collection) => {
-            return !collection.collection.startsWith('directus_');
+            return !collection.collection.startsWith("directus_");
         });
         if (collections.length > 0) {
-            core_2.ux.error('Directus instance is not empty. Please use a blank instance. Copying a template into an existing instance is not supported at this time.');
+            core_2.ux.error("Directus instance is not empty. Please use a blank instance. Copying a template into an existing instance is not supported at this time.");
         }
         // Run load script
         core_2.ux.action.start(`Applying template - ${chosenTemplate.template.templateName}`);
         await (0, load_1.default)(chosenTemplate.template.directoryPath, this);
         core_2.ux.action.stop();
         this.log(separator);
-        this.log('Template applied successfully.');
-        this.exit;
+        this.log("Template applied successfully.");
+        this.exit(0);
     }
 }
 exports.default = ApplyCommand;
-ApplyCommand.description = 'Apply a template to a blank Directus instance.';
-ApplyCommand.examples = [
-    '$ directus-template-cli apply',
-];
+ApplyCommand.description = "Apply a template to a blank Directus instance.";
+ApplyCommand.examples = ["$ directus-template-cli apply"];
 ApplyCommand.flags = {};

package/dist/commands/extract.d.ts

@@ -0,0 +1,7 @@
+import { Command } from "@oclif/core";
+export default class ExtractCommand extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {};
+    run(): Promise<void>;
+}

package/dist/commands/extract.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const core_2 = 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("../lib/api");
+const extract_1 = tslib_1.__importDefault(require("../lib/extract/"));
+const auth_1 = require("../lib/utils/auth");
+const template_defaults_1 = require("../lib/utils/template-defaults");
+const separator = "------------------";
+class ExtractCommand extends core_1.Command {
+    async run() {
+        const { flags } = await this.parse(ExtractCommand);
+        const templateName = await core_2.ux.prompt("What is the name of the template?.");
+        const directory = await core_2.ux.prompt("What directory would you like to extract the template to? If it doesn't exist, it will be created.");
+        this.log(`You selected ${directory}`);
+        try {
+            // Check if directory exists, if not, then create it.
+            if (!node_fs_1.default.existsSync(directory)) {
+                node_fs_1.default.mkdirSync(directory, { recursive: true });
+            }
+            // Create package.json and README.md
+            const packageJSONContent = (0, template_defaults_1.generatePackageJsonContent)(templateName);
+            const readmeContent = (0, template_defaults_1.generateReadmeContent)(templateName);
+            // Write the content to the specified directory
+            const packageJSONPath = node_path_1.default.join(directory, "package.json");
+            const readmePath = node_path_1.default.join(directory, "README.md");
+            node_fs_1.default.writeFileSync(packageJSONPath, packageJSONContent);
+            node_fs_1.default.writeFileSync(readmePath, readmeContent);
+        }
+        catch (error) {
+            console.error(`Failed to create directory or write files: ${error.message}`);
+        }
+        this.log(separator);
+        const directusUrl = await (0, auth_1.getDirectusUrl)();
+        api_1.api.setBaseUrl(directusUrl);
+        const directusToken = await (0, auth_1.getDirectusToken)(directusUrl);
+        api_1.api.setAuthToken(directusToken);
+        this.log(separator);
+        // Run the extract script
+        core_2.ux.action.start(`Extracting template - from ${directusUrl} to ${directory}`);
+        await (0, extract_1.default)(directory, this);
+        core_2.ux.action.stop();
+        this.log(separator);
+        this.log("Template extracted successfully.");
+        this.exit(0);
+    }
+}
+exports.default = ExtractCommand;
+ExtractCommand.description = "Extract a template from a Directus instance.";
+ExtractCommand.examples = ["$ directus-template-cli extract"];
+ExtractCommand.flags = {};

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

@@ -0,0 +1,3 @@
+export declare function getAssetList(): Promise<any>;
+export declare function downloadFile(file: any, dir: string): Promise<unknown>;
+export declare function downloadAllFiles(dir: string): Promise<void>;

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

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadAllFiles = exports.downloadFile = exports.getAssetList = void 0;
+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"));
+const api_1 = require("../api");
+async function getAssetList() {
+    const { data } = await api_1.api.get("/files", {
+        params: {
+            limit: "-1",
+        },
+    });
+    return data.data;
+}
+exports.getAssetList = getAssetList;
+async function downloadFile(file, dir) {
+    const response = await api_1.api.get(`assets/${file.id}`, {
+        responseType: "stream",
+    });
+    // Create assets folder if it doesn't exist
+    const fullPath = node_path_1.default.join(dir, "assets");
+    if (node_path_1.default && !node_fs_1.default.existsSync(fullPath)) {
+        node_fs_1.default.mkdirSync(fullPath, { recursive: true });
+    }
+    const writePath = node_path_1.default.resolve(dir, "assets", file.filename_disk);
+    const writer = node_fs_1.default.createWriteStream(writePath);
+    response.data.pipe(writer);
+    return new Promise((resolve, reject) => {
+        writer.on("finish", () => {
+            // console.log(`Wrote ${file.filename_disk}`);
+            resolve(null);
+        });
+        writer.on("error", reject);
+    });
+}
+exports.downloadFile = downloadFile;
+async function downloadAllFiles(dir) {
+    const fileList = await getAssetList();
+    for (const file of fileList) {
+        try {
+            await downloadFile(file, dir);
+        }
+        catch (error) {
+            console.log(`Error downloading ${file.filename_disk}`, error);
+        }
+    }
+}
+exports.downloadAllFiles = downloadAllFiles;

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

@@ -0,0 +1,3 @@
+export declare function getCollections(): Promise<any>;
+export declare function getDataFromCollection(collection: string, dir: string): Promise<void>;
+export declare function extractContent(dir: string): Promise<void>;

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractContent = exports.getDataFromCollection = exports.getCollections = void 0;
+const tslib_1 = require("tslib");
+const api_1 = require("../api");
+const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
+async function getCollections() {
+    const { data } = await api_1.api.get("/collections");
+    const collections = data.data
+        .filter((item) => !item.collection.startsWith("directus_", 0))
+        .filter((item) => item.schema != null)
+        .map((i) => i.collection);
+    return collections;
+}
+exports.getCollections = getCollections;
+async function getDataFromCollection(collection, dir) {
+    try {
+        const { data } = await api_1.api.get(`items/${collection}`); // ADD limit = -1
+        (0, write_to_file_1.default)(`${collection}`, data.data, `${dir}/content/`);
+    }
+    catch {
+        console.log(`error getting items from ${collection}`);
+        // Errors are thrown for 'folder' collections
+    }
+}
+exports.getDataFromCollection = getDataFromCollection;
+async function extractContent(dir) {
+    const collections = await getCollections();
+    for (const collection of collections) {
+        await getDataFromCollection(collection, dir);
+    }
+}
+exports.extractContent = extractContent;

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

@@ -0,0 +1,4 @@
+/**
+ * Extract files from the API
+ */
+export default function extractFiles(dir: string): Promise<void>;

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

@@ -0,0 +1,48 @@
+"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 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",
+];
+/**
+ * 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);
+    }
+    catch (error) {
+        console.log("Error extracting Files:", error.response.data.errors);
+    }
+}
+exports.default = extractFiles;

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

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

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

@@ -0,0 +1,26 @@
+"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 filter_fields_1 = tslib_1.__importDefault(require("../utils/filter-fields"));
+const systemFields = ["id", "name", "parent"];
+/**
+ * Extract folders from the API
+ */
+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);
+    }
+    catch (error) {
+        console.log("Error extracting Folders:", error.response.data.errors);
+    }
+}
+exports.default = extractFolders;

package/dist/lib/extract/extract-from-endpoint.d.ts

@@ -0,0 +1,4 @@
+/**
+ * [default query an endpoint and write the result to file]
+ */
+export default function extractFromEndpoint(path: string, dir: string): Promise<void>;

package/dist/lib/extract/extract-from-endpoint.js

@@ -0,0 +1,23 @@
+"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"));
+/**
+ * [default query an endpoint and write the result to file]
+ */
+async function extractFromEndpoint(path, dir) {
+    try {
+        const { data } = await api_1.api.get(`/${path}`, {
+            params: {
+                limit: "-1",
+            },
+        });
+        // Use the dynamic dir parameter
+        await (0, write_to_file_1.default)(`${path}`, data.data, dir);
+    }
+    catch (error) {
+        console.log(`Error querying endpoint ${path}:`, error.response.data.errors);
+    }
+}
+exports.default = extractFromEndpoint;

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

@@ -0,0 +1,4 @@
+/**
+ * Extract roles from the API
+ */
+export default function extractRoles(dir: string): Promise<void>;

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

@@ -0,0 +1,36 @@
+"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 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",
+];
+/**
+ * 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);
+    }
+    catch (error) {
+        console.log("Error extracting Roles:", error.response.data.errors);
+    }
+}
+exports.default = extractRoles;

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

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

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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"));
+const api_1 = require("../api");
+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 });
+    }
+    // Get the schema
+    try {
+        const { data } = await api_1.api.get("/schema/snapshot", {
+            params: {
+                limit: "-1",
+            },
+        });
+        // Write the schema to the specified directory
+        await (0, write_to_file_1.default)("schema/snapshot", data.data, dir);
+    }
+    catch (error) {
+        console.log("Error fetching schema snapshot:", error);
+    }
+}
+exports.default = extractSchema;

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

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

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

@@ -0,0 +1,49 @@
+"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 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",
+];
+/**
+ * Extract users from the API
+ */
+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);
+    }
+    catch (error) {
+        console.log("Error extracting Users:", error.response.data.errors);
+    }
+}
+exports.default = extractUsers;

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

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

package/dist/lib/extract/index.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+const extract_assets_1 = require("./extract-assets");
+const extract_schema_1 = tslib_1.__importDefault(require("./extract-schema"));
+const extract_from_endpoint_1 = tslib_1.__importDefault(require("./extract-from-endpoint"));
+const public_permissions_1 = tslib_1.__importDefault(require("./public-permissions"));
+const extract_content_1 = require("./extract-content");
+const extract_folders_1 = tslib_1.__importDefault(require("./extract-folders"));
+const extract_users_1 = tslib_1.__importDefault(require("./extract-users"));
+const extract_roles_1 = tslib_1.__importDefault(require("./extract-roles"));
+const extract_files_1 = tslib_1.__importDefault(require("./extract-files"));
+const endpoints = [
+    // "folders",
+    // "fields",
+    // "users",
+    // "roles",
+    // "files",
+    "operations",
+    "permissions",
+    "collections",
+    "flows",
+    "dashboards",
+    "panels",
+    "presets",
+    "settings",
+];
+async function extract(dir, cli) {
+    // Get the destination directory for the actual files
+    const destination = dir + "/src";
+    // Check if directory exists, if not, then create it.
+    if (!node_fs_1.default.existsSync(destination)) {
+        console.log(`Attempting to create directory at: ${destination}`);
+        node_fs_1.default.mkdirSync(destination, { recursive: true });
+    }
+    // Extract the schema
+    await (0, extract_schema_1.default)(destination);
+    await (0, extract_folders_1.default)(destination);
+    await (0, extract_users_1.default)(destination);
+    await (0, extract_roles_1.default)(destination);
+    await (0, extract_files_1.default)(destination);
+    // Iterate through the endpoints
+    for (const endpoint of endpoints) {
+        await (0, extract_from_endpoint_1.default)(endpoint, destination);
+    }
+    // Extract public permissions
+    await (0, public_permissions_1.default)(destination);
+    // Extract content
+    await (0, extract_content_1.extractContent)(destination);
+    // Extract assets
+    await (0, extract_assets_1.downloadAllFiles)(destination);
+    return {};
+}
+exports.default = extract;

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

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

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

@@ -0,0 +1,21 @@
+"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"));
+async function extractPublicPermissions(dir) {
+    try {
+        const { data } = await api_1.api.get("permissions", {
+            params: {
+                limit: "-1",
+                "filter[role][_null]": true,
+            },
+        });
+        // Write the public permissions to the specified directory
+        await (0, write_to_file_1.default)("public-permissions", data.data, dir);
+    }
+    catch (error) {
+        console.log("Error fetching public permissions:", error);
+    }
+}
+exports.default = extractPublicPermissions;

package/dist/lib/load/index.js

@@ -7,43 +7,46 @@ const load_schema_1 = tslib_1.__importDefault(require("./load-schema"));
 const load_roles_1 = tslib_1.__importDefault(require("./load-roles"));
 const load_dashboards_1 = tslib_1.__importDefault(require("./load-dashboards"));
 const load_files_1 = tslib_1.__importDefault(require("./load-files"));
+const load_folders_1 = tslib_1.__importDefault(require("./load-folders"));
 const load_users_1 = tslib_1.__importDefault(require("./load-users"));
 const load_flows_1 = tslib_1.__importDefault(require("./load-flows"));
 const load_operations_1 = tslib_1.__importDefault(require("./load-operations"));
 const load_data_1 = tslib_1.__importDefault(require("./load-data"));
 const load_presets_1 = tslib_1.__importDefault(require("./load-presets"));
 const load_settings_1 = tslib_1.__importDefault(require("./load-settings"));
-const load_public_permissions_1 = tslib_1.__importDefault(require("./load-public-permissions"));
+const load_public_permissions_1 = require("./load-public-permissions");
 async function apply(dir, cli) {
     // Get the source directory for the actual files
-    const source = dir + '/src';
+    const source = dir + "/src";
     // Load the template files into the destination
-    await (0, load_schema_1.default)(source + '/schema');
-    cli.log('Loaded Schema');
-    await (0, load_roles_1.default)((0, read_file_1.default)('roles', source));
-    cli.log('Loaded Roles');
-    await (0, load_to_destination_1.default)('folders', (0, read_file_1.default)('folders', source));
-    cli.log('Loaded Folders');
-    await (0, load_dashboards_1.default)((0, read_file_1.default)('dashboards', source));
-    cli.log('Loaded Dashboards');
-    await (0, load_to_destination_1.default)('panels', (0, read_file_1.default)('panels', source)); // Comes after dashboards
-    cli.log('Loaded Panels');
-    await (0, load_files_1.default)((0, read_file_1.default)('files', source), source); // Comes after folders
-    cli.log('Loaded Files');
-    await (0, load_users_1.default)((0, read_file_1.default)('users', source)); // Comes after roles, files
-    cli.log('Loaded Users');
-    await (0, load_flows_1.default)((0, read_file_1.default)('flows', source));
-    cli.log('Loaded Flows');
-    await (0, load_operations_1.default)((0, read_file_1.default)('operations', source)); // Comes after flows
-    cli.log('Loaded Operations');
-    await (0, load_data_1.default)((0, read_file_1.default)('collections', source), source);
-    cli.log('Loaded Data');
-    await (0, load_presets_1.default)((0, read_file_1.default)('presets', source));
-    cli.log('Loaded Presets');
-    await (0, load_settings_1.default)((0, read_file_1.default)('settings', source));
-    cli.log('Loaded Settings');
-    await (0, load_public_permissions_1.default)((0, read_file_1.default)('public-permissions', source));
-    cli.log('Loaded Public Permissions');
+    await (0, load_schema_1.default)(source + "/schema");
+    cli.log("Loaded Schema");
+    await (0, load_roles_1.default)((0, read_file_1.default)("roles", source));
+    cli.log("Loaded Roles");
+    await (0, load_files_1.default)((0, read_file_1.default)("files", source), source); // Comes after folders
+    cli.log("Loaded Files");
+    await (0, load_users_1.default)((0, read_file_1.default)("users", source)); // Comes after roles, files
+    cli.log("Loaded Users");
+    await (0, load_folders_1.default)(source);
+    cli.log("Loaded Folders");
+    await (0, load_dashboards_1.default)((0, read_file_1.default)("dashboards", source));
+    cli.log("Loaded Dashboards");
+    await (0, load_to_destination_1.default)("panels", (0, read_file_1.default)("panels", source)); // Comes after dashboards
+    cli.log("Loaded Panels");
+    await (0, load_flows_1.default)((0, read_file_1.default)("flows", source));
+    cli.log("Loaded Flows");
+    await (0, load_operations_1.default)((0, read_file_1.default)("operations", source)); // Comes after flows
+    cli.log("Loaded Operations");
+    await (0, load_data_1.default)((0, read_file_1.default)("collections", source), source);
+    cli.log("Loaded Data");
+    await (0, load_presets_1.default)((0, read_file_1.default)("presets", source));
+    cli.log("Loaded Presets");
+    await (0, load_settings_1.default)((0, read_file_1.default)("settings", source));
+    cli.log("Loaded Settings");
+    await (0, load_public_permissions_1.loadPublicPermissions)((0, read_file_1.default)("public-permissions", source));
+    cli.log("Loaded Public Permissions");
+    await (0, load_public_permissions_1.loadPermissions)((0, read_file_1.default)("permissions", source));
+    cli.log("Loaded Permissions");
     return {};
 }
 exports.default = apply;

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

@@ -5,12 +5,20 @@ const api_1 = require("../api");
 const read_file_1 = tslib_1.__importDefault(require("../utils/read-file"));
 async function loadFolders(dir) {
     try {
-        const folders = await (0, read_file_1.default)('folders', dir);
-        const { data } = await api_1.api.post('/folders', folders);
-        console.log('Folder creation', data);
+        const folders = await (0, read_file_1.default)("folders", dir);
+        const folderSkeleton = folders.map((folder) => {
+            return { id: folder.id, name: folder.name };
+        });
+        // Create the folders
+        const { data } = await api_1.api.post("/folders", folderSkeleton);
+        // Loop through the folders and update them with relationships
+        folders.forEach(async (folder) => {
+            const { id, ...rest } = folder;
+            await api_1.api.patch(`/folders/${id}`, rest);
+        });
     }
     catch (error) {
-        console.log('Error loading Folders', error.response.data.errors);
+        console.log("Error loading Folders", error.response.data.errors);
     }
 }
 exports.default = loadFolders;

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

@@ -2,16 +2,27 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const api_1 = require("../api");
 exports.default = async (presets) => {
-    const cleanPresets = presets.map(preset => {
+    await deleteAllPresets();
+    const cleanPresets = presets.map((preset) => {
         preset.user = null;
         return preset;
     });
-    for (const preset of cleanPresets) {
-        try {
-            await api_1.api.post('presets', preset);
-        }
-        catch (error) {
-            console.log('Error uploading preset', error.response.data.errors);
-        }
+    try {
+        await api_1.api.post("presets", cleanPresets);
+    }
+    catch (error) {
+        console.log("Error uploading preset", error.response.data.errors);
+    }
+};
+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);
     }
 };

package/dist/lib/load/load-public-permissions.d.ts

@@ -1 +1,2 @@
-export default function loadPublicPermissions(roles: any): Promise<void>;
+export declare function loadPublicPermissions(roles: any): Promise<void>;
+export declare function loadPermissions(roles: any): Promise<void>;

package/dist/lib/load/load-public-permissions.js

@@ -1,19 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadPermissions = exports.loadPublicPermissions = void 0;
 const tslib_1 = require("tslib");
 const api_1 = require("../api");
 const load_to_destination_1 = tslib_1.__importDefault(require("../utils/load-to-destination"));
 async function removeallPublicPermissions() {
-    const { data } = await api_1.api.get('permissions?filter[role][_null]=true&limit=-1');
-    const ids = data.data.map(i => i.id);
+    const { data } = await api_1.api.get("permissions?filter[role][_null]=true&limit=-1");
+    console.log("Removing all public permissions", data.data);
+    const ids = data.data.map((i) => i.id);
     if (!ids)
         return;
-    await api_1.api.delete('permissions', {
+    await api_1.api.delete("permissions", {
         data: ids,
     });
 }
 async function loadPublicPermissions(roles) {
     await removeallPublicPermissions();
-    await (0, load_to_destination_1.default)('permissions', roles);
+    await (0, load_to_destination_1.default)("permissions", roles);
 }
-exports.default = loadPublicPermissions;
+exports.loadPublicPermissions = loadPublicPermissions;
+async function loadPermissions(roles) {
+    await (0, load_to_destination_1.default)("permissions", roles);
+}
+exports.loadPermissions = loadPermissions;

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

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

package/dist/lib/utils/auth.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDirectusToken = exports.getDirectusUrl = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const api_1 = require("../api");
+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?");
+    // Validate URL
+    if (!(0, validate_url_1.default)(directusUrl)) {
+        core_1.ux.warn("Invalid URL");
+        return getDirectusUrl();
+    }
+    return directusUrl;
+}
+exports.getDirectusUrl = getDirectusUrl;
+async function getDirectusToken(directusUrl) {
+    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}`,
+            },
+        });
+        return directusToken;
+    }
+    catch {
+        core_1.ux.warn("Invalid token");
+        return getDirectusToken(directusUrl);
+    }
+}
+exports.getDirectusToken = getDirectusToken;

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

@@ -0,0 +1 @@
+export default function filterFields(dataArray: any, systemFields: any): any;

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// Utility function to filter out non-system fields
+function filterFields(dataArray, systemFields) {
+    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));
+                    if (isArrayOfIntegers || isArrayOfUUIDs) {
+                        item[key] = null; // or item[key] = [];
+                    }
+                }
+            }
+        }
+        return item;
+    });
+}
+exports.default = filterFields;

package/dist/lib/utils/read-templates.d.ts

@@ -2,5 +2,6 @@ interface Template {
     directoryPath: string;
     templateName: string;
 }
-export default function readTemplates(directoryPath: string): Promise<Template[]>;
+export declare function readTemplate(directoryPath: string): Promise<Template | null>;
+export declare function readAllTemplates(directoryPath: string): Promise<Template[]>;
 export {};

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

@@ -1,36 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.readAllTemplates = exports.readTemplate = void 0;
 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 readTemplates(directoryPath) {
+async function readTemplate(directoryPath) {
+    const packageFilePath = node_path_1.default.join(directoryPath, "package.json");
+    try {
+        const packageData = await node_fs_1.default.promises.readFile(packageFilePath, "utf-8");
+        const packageJson = JSON.parse(packageData);
+        if (packageJson.templateName) {
+            return {
+                directoryPath,
+                templateName: packageJson.templateName,
+            };
+        }
+        return null;
+    }
+    catch (error) {
+        console.error(`Failed to read package.json file in directory ${directoryPath}: ${error}`);
+        return null;
+    }
+}
+exports.readTemplate = readTemplate;
+async function readAllTemplates(directoryPath) {
     const templates = [];
-    // Read the contents of the directory
     const files = await node_fs_1.default.promises.readdir(directoryPath);
-    // Loop through each file in the directory
     for (const file of files) {
-        // Check if the file is a directory
         const filePath = node_path_1.default.join(directoryPath, file);
         const stats = await node_fs_1.default.promises.stat(filePath);
         if (stats.isDirectory()) {
-            // Read the contents of the package.json file in the directory
-            const packageFilePath = node_path_1.default.join(filePath, 'package.json');
-            try {
-                const packageData = await node_fs_1.default.promises.readFile(packageFilePath, 'utf-8');
-                const packageJson = JSON.parse(packageData);
-                if (packageJson.templateName) {
-                    const template = {
-                        directoryPath: filePath,
-                        templateName: packageJson.templateName,
-                    };
-                    templates.push(template);
-                }
-            }
-            catch (error) {
-                console.error(`Failed to read package.json file in directory ${filePath}: ${error}`);
+            const template = await readTemplate(filePath);
+            if (template) {
+                templates.push(template);
             }
         }
     }
     return templates;
 }
-exports.default = readTemplates;
+exports.readAllTemplates = readAllTemplates;

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

@@ -0,0 +1,2 @@
+export declare const generatePackageJsonContent: (templateName: string) => string;
+export declare const generateReadmeContent: (templateName: string) => string;

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

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateReadmeContent = exports.generatePackageJsonContent = void 0;
+const tslib_1 = require("tslib");
+const slugify_1 = tslib_1.__importDefault(require("slugify"));
+const generatePackageJsonContent = (templateName) => {
+    const slugifiedName = (0, slugify_1.default)(templateName, {
+        lower: true,
+        strict: true, // Remove special characters
+    });
+    const packageName = `directus-template-${slugifiedName}`;
+    return JSON.stringify({
+        name: packageName,
+        templateName: templateName,
+        version: "1.0.0",
+        description: "",
+        author: "",
+        license: "MIT",
+        files: ["src"],
+    }, null, 2);
+};
+exports.generatePackageJsonContent = generatePackageJsonContent;
+const generateReadmeContent = (templateName) => {
+    return `# ${templateName} Template
+
+This is a template for [Directus](https://directus.io/) - an open-source headless CMS and API. Use the template-cli to load / apply this template to a blank instance.
+
+## Why
+
+## What
+
+## License
+
+This template is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+`;
+};
+exports.generateReadmeContent = generateReadmeContent;

package/dist/lib/utils/write-to-file.d.ts

@@ -1,2 +1,2 @@
-declare const _default: (fileName: string, data: any) => Promise<void>;
+declare const _default: (fileName: string, data: any, dir: string) => Promise<void>;
 export default _default;

package/dist/lib/utils/write-to-file.js

@@ -3,20 +3,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
-const dir = node_path_1.default.join(__dirname, '..', 'source');
-exports.default = async (fileName, data) => {
-    const folders = fileName.split('/');
+exports.default = async (fileName, data, dir) => {
+    const folders = fileName.split("/");
     const endFileName = folders.pop();
-    const folderPath = folders.join('/');
+    const folderPath = folders.join("/");
+    // Generate the full path where you want to write the file
     const fullPath = node_path_1.default.join(dir, folderPath);
-    if (node_path_1.default && !node_fs_1.default.existsSync(fullPath)) {
-        node_fs_1.default.mkdirSync(fullPath);
+    // Check if the directory exists. Create if it doesn't.
+    if (!node_fs_1.default.existsSync(fullPath)) {
+        node_fs_1.default.mkdirSync(fullPath, { recursive: true });
     }
+    // Construct the full file path
+    const fullFilePath = node_path_1.default.join(fullPath, `${endFileName}.json`);
     try {
-        await node_fs_1.default.promises.writeFile(`${dir}/${fileName}.json`, JSON.stringify(data, null, 2));
-        console.log(`Wrote ${fileName}`);
+        // Write the file
+        await node_fs_1.default.promises.writeFile(fullFilePath, JSON.stringify(data, null, 2));
+        // console.log(`Wrote ${fullFilePath}`);
     }
     catch (error) {
-        console.log('error writing to file', error);
+        console.log("Error writing to file", error.data.errors);
     }
 };

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.2.0",
+  "version": "0.3.0-beta.2",
   "commands": {
     "apply": {
       "id": "apply",
@@ -14,6 +14,20 @@
       ],
       "flags": {},
       "args": {}
+    },
+    "extract": {
+      "id": "extract",
+      "description": "Extract a template from a Directus instance.",
+      "strict": true,
+      "pluginName": "directus-template-cli",
+      "pluginAlias": "directus-template-cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ directus-template-cli extract"
+      ],
+      "flags": {},
+      "args": {}
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "directus-template-cli",
-  "version": "0.2.0",
+  "version": "0.3.0-beta.2",
   "description": "CLI Utility for applying templates to a Directus instance.",
   "author": "bryantgillespie @bryantgillespie",
   "bin": {
@@ -26,7 +26,8 @@
     "dotenv": "^16.0.3",
     "formdata-node": "^5.0.0",
     "generate-password": "^1.7.0",
-    "inquirer": "^8.2.5"
+    "inquirer": "^8.2.5",
+    "slugify": "^1.6.6"
   },
   "devDependencies": {
     "@oclif/test": "^2.3.16",