directus-template-cli 0.3.6 → 0.4.0

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/path.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Resolves a given path to an absolute path and checks if it exists.
+ * @param inputPath The path to resolve.
+ * @param checkExistence Whether to check if the resolved path exists.
+ * @returns The resolved absolute path if it exists, or null if it doesn't.
+ */
+export default function resolvePathAndCheckExistence(inputPath: string, checkExistence?: boolean): null | string;

package/dist/lib/utils/path.js

@@ -0,0 +1,20 @@
+"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 node_process_1 = require("node:process");
+/**
+ * Resolves a given path to an absolute path and checks if it exists.
+ * @param inputPath The path to resolve.
+ * @param checkExistence Whether to check if the resolved path exists.
+ * @returns The resolved absolute path if it exists, or null if it doesn't.
+ */
+function resolvePathAndCheckExistence(inputPath, checkExistence = true) {
+    const resolvedPath = node_path_1.default.isAbsolute(inputPath) ? inputPath : node_path_1.default.resolve((0, node_process_1.cwd)(), inputPath);
+    if (!checkExistence || node_fs_1.default.existsSync(resolvedPath)) {
+        return resolvedPath;
+    }
+    return null;
+}
+exports.default = resolvePathAndCheckExistence;

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

@@ -1,2 +1 @@
 export default function readFile(file: string, dir: string): any[];
-export declare function readJsonFile(path: string): any[];

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

@@ -1,17 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readJsonFile = 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"));
 function readFile(file, dir) {
-    const f = node_fs_1.default.readFileSync(`${dir}/${file}.json`, 'utf8');
-    const obj = JSON.parse(f);
+    const filePath = node_path_1.default.join(dir, `${file}.json`); // Use path.join for proper path resolution
+    if (!node_fs_1.default.existsSync(filePath)) {
+        throw new Error(`File not found: ${filePath}`); // Improved error handling
+    }
+    const fileContents = node_fs_1.default.readFileSync(filePath, 'utf8');
+    const obj = JSON.parse(fileContents);
     return obj;
 }
 exports.default = readFile;
-function readJsonFile(path) {
-    const f = node_fs_1.default.readFileSync(`${path}.json`, 'utf8');
-    const obj = JSON.parse(f);
-    return obj;
-}
-exports.readJsonFile = readJsonFile;

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[];
+};

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

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.systemFields = exports.directusSettingsFields = exports.directusPanelFields = exports.directusDashboardFields = exports.directusOperationFields = exports.directusFlowFields = exports.directusFolderFields = exports.directusFileFields = exports.directusRoleFields = exports.directusUserFields = void 0;
+exports.directusUserFields = [
+    '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',
+];
+exports.directusRoleFields = [
+    'id',
+    'name',
+    'description',
+    'icon',
+    'enforce_tfa',
+    'external_id',
+    'ip_whitelist',
+    'app_access',
+    'admin_access',
+];
+exports.directusFileFields = [
+    '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',
+];
+exports.directusFolderFields = [
+    'id',
+    'name',
+    'parent',
+];
+exports.directusFlowFields = [
+    'id',
+    'name',
+    'icon',
+    'color',
+    'description',
+    'status',
+    'trigger',
+    'accountability',
+    'options',
+    'operation',
+    'date_created',
+    'user_created',
+];
+exports.directusOperationFields = [
+    'id',
+    'name',
+    'key',
+    'type',
+    'position_x',
+    'position_y',
+    'options',
+    'resolve',
+    'reject',
+    'flow',
+    'date_created',
+    'user_created',
+];
+exports.directusDashboardFields = [
+    'id',
+    'name',
+    'icon',
+    'note',
+    'date_created',
+    'user_created',
+    'color',
+];
+exports.directusPanelFields = [
+    'id',
+    'dashboard',
+    'name',
+    'icon',
+    'color',
+    'show_header',
+    'note',
+    'type',
+    'position_x',
+    'position_y',
+    'width',
+    'height',
+    'options',
+    'date_created',
+    'user_created',
+];
+exports.directusSettingsFields = [
+    'id',
+    'project_name',
+    'project_url',
+    'project_color',
+    'project_logo',
+    'public_foreground',
+    'public_background',
+    'public_note',
+    'auth_login_attempts',
+    'auth_password_policy',
+    'storage_asset_transform',
+    'storage_asset_presets',
+    'custom_css',
+    'storage_default_folder',
+    'basemaps',
+    'mapbox_key',
+    'module_bar',
+    'project_descriptor',
+    'default_language',
+    'custom_aspect_ratios',
+    'public_favicon',
+    'default_appearance',
+    'default_theme_light',
+    'theme_light_overrides',
+    'default_theme_dark',
+    'theme_dark_overrides',
+];
+exports.systemFields = {
+    directus_dashboards: exports.directusDashboardFields,
+    directus_files: exports.directusFileFields,
+    directus_flows: exports.directusFlowFields,
+    directus_folders: exports.directusFolderFields,
+    directus_operations: exports.directusOperationFields,
+    directus_panels: exports.directusPanelFields,
+    directus_roles: exports.directusRoleFields,
+    directus_settings: exports.directusSettingsFields,
+    directus_users: exports.directusUserFields,
+};

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

@@ -5,23 +5,22 @@ 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,
+        lower: true, // Convert to lowercase
         strict: true, // Remove special characters
     });
     const packageName = `directus-template-${slugifiedName}`;
     return JSON.stringify({
+        author: '',
+        description: '',
+        directusTemplate: true,
+        files: ['src'],
         name: packageName,
-        templateName: templateName,
-        version: "1.0.0",
-        description: "",
-        author: "",
-        license: "MIT",
-        files: ["src"],
+        templateName,
+        version: '1.0.0',
     }, null, 2);
 };
 exports.generatePackageJsonContent = generatePackageJsonContent;
-const generateReadmeContent = (templateName) => {
-    return `# ${templateName} Template
+const generateReadmeContent = (templateName) => `# ${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.
 
@@ -31,7 +30,5 @@ This is a template for [Directus](https://directus.io/) - an open-source headles
 
 ## License
 
-This template is licensed under the [MIT License](https://opensource.org/licenses/MIT).
 `;
-};
 exports.generateReadmeContent = generateReadmeContent;

package/dist/lib/utils/transform-github-url.d.ts

@@ -0,0 +1 @@
+export declare function transformGitHubUrl(url: string): string;

package/dist/lib/utils/transform-github-url.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformGitHubUrl = void 0;
+function transformGitHubUrl(url) {
+    // Regular expression to capture the repository name and any subsequent path after the 'tree'
+    const regex = /github\.com\/([^/]+\/[^/]+)(?:\/tree\/[^/]+\/(.*))?$/;
+    const match = url.match(regex);
+    if (match) {
+        const repo = match[1];
+        const subpath = match[2] ? match[2] : '';
+        return `github:${repo}/${subpath}`;
+    }
+    return 'Invalid URL';
+}
+exports.transformGitHubUrl = transformGitHubUrl;

package/dist/lib/utils/validate-url.js

@@ -5,7 +5,7 @@ function validateUrl(url) {
         new URL(url);
         return true;
     }
-    catch (err) {
+    catch {
         return false;
     }
 }

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

@@ -1,12 +1,12 @@
 "use strict";
 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 node_path_1 = tslib_1.__importDefault(require("node:path"));
 exports.default = async (fileName, data, dir) => {
-    const folders = fileName.split("/");
+    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);
     // Check if the directory exists. Create if it doesn't.
@@ -21,6 +21,6 @@ exports.default = async (fileName, data, dir) => {
         // console.log(`Wrote ${fullFilePath}`);
     }
     catch (error) {
-        console.log("Error writing to file", error.data.errors);
+        console.log('Error writing to file', error.data.errors);
     }
 };

package/oclif.manifest.json

@@ -1,33 +1,51 @@
 {
-  "version": "0.3.6",
   "commands": {
     "apply": {
-      "id": "apply",
-      "description": "Apply a template to a blank Directus instance.",
-      "strict": true,
-      "pluginName": "directus-template-cli",
-      "pluginAlias": "directus-template-cli",
-      "pluginType": "core",
       "aliases": [],
+      "args": {},
+      "description": "Apply a template to a blank Directus instance.",
       "examples": [
         "$ directus-template-cli apply"
       ],
       "flags": {},
-      "args": {}
-    },
-    "extract": {
-      "id": "extract",
-      "description": "Extract a template from a Directus instance.",
-      "strict": true,
-      "pluginName": "directus-template-cli",
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "apply",
       "pluginAlias": "directus-template-cli",
+      "pluginName": "directus-template-cli",
       "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "apply.js"
+      ]
+    },
+    "extract": {
       "aliases": [],
+      "args": {},
+      "description": "Extract a template from a Directus instance.",
       "examples": [
         "$ directus-template-cli extract"
       ],
       "flags": {},
-      "args": {}
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "extract",
+      "pluginAlias": "directus-template-cli",
+      "pluginName": "directus-template-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "dist",
+        "commands",
+        "extract.js"
+      ]
     }
-  }
+  },
+  "version": "0.4.0"
 }

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "directus-template-cli",
-  "version": "0.3.6",
+  "version": "0.4.0",
   "description": "CLI Utility for applying templates to a Directus instance.",
   "author": "bryantgillespie @bryantgillespie",
   "bin": {
-    "directus-template-util": "./bin/run"
+    "directus-template-cli": "./bin/run"
   },
   "homepage": "https://github.com/directus-community/directus-template-cli",
   "license": "MIT",
@@ -18,32 +18,34 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@oclif/core": "^2",
-    "@oclif/plugin-help": "^5",
-    "@oclif/plugin-plugins": "^2.4.6",
-    "axios": "^1.3.4",
+    "@directus/sdk": "^14.0.0",
+    "@directus/types": "^11.0.3",
+    "@oclif/core": "^3.18.1",
+    "@oclif/plugin-help": "^6.0.12",
+    "@oclif/plugin-plugins": "^4.1.22",
+    "axios": "^1.6.7",
     "bottleneck": "^2.19.5",
-    "dotenv": "^16.0.3",
-    "formdata-node": "^5.0.0",
-    "generate-password": "^1.7.0",
+    "dotenv": "^16.4.1",
+    "formdata-node": "^6.0.3",
+    "giget": "^1.2.1",
     "inquirer": "^8.2.5",
     "slugify": "^1.6.6"
   },
   "devDependencies": {
-    "@oclif/test": "^2.3.16",
-    "@types/chai": "^4",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^16.18.24",
-    "chai": "^4",
-    "eslint": "^7.32.0",
-    "eslint-config-oclif": "^4",
-    "eslint-config-oclif-typescript": "^1.0.3",
-    "mocha": "^9",
-    "oclif": "^3",
+    "@oclif/test": "^3.1.13",
+    "@types/chai": "^4.3.11",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "^20.11.10",
+    "chai": "^5.0.3",
+    "eslint": "^8.56.0",
+    "eslint-config-oclif": "^5.0.0",
+    "eslint-config-oclif-typescript": "^3.0.41",
+    "mocha": "^10.2.0",
+    "oclif": "^4.4.2",
     "shx": "^0.3.3",
-    "ts-node": "^10.9.1",
-    "tslib": "^2.5.0",
-    "typescript": "^4.9.5"
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3"
   },
   "oclif": {
     "bin": "directus-template-cli",
@@ -66,7 +68,7 @@
     "version": "oclif readme && git add README.md"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=18.0.0"
   },
   "bugs": "https://github.com/directus-community/directus-template-cli/issues",
   "keywords": [

package/dist/lib/api.d.ts

@@ -1,15 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-declare class Api {
-    private instance;
-    private limiter;
-    constructor();
-    setBaseUrl(url: string): void;
-    setAuthToken(token: string): void;
-    get<T>(url: string, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
-    post<T>(url: string, data?: any, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
-    put<T>(url: string, data?: any, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
-    patch<T>(url: string, data?: any, config?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
-    delete(url: string, config?: AxiosRequestConfig): Promise<AxiosResponse>;
-}
-export declare const api: Api;
-export {};

package/dist/lib/api.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.api = void 0;
-const tslib_1 = require("tslib");
-const axios_1 = tslib_1.__importDefault(require("axios"));
-const bottleneck_1 = tslib_1.__importDefault(require("bottleneck"));
-class Api {
-    constructor() {
-        this.instance = axios_1.default.create();
-        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.
-        });
-    }
-    setBaseUrl(url) {
-        this.instance.defaults.baseURL = url;
-    }
-    setAuthToken(token) {
-        this.instance.defaults.headers.common.Authorization = `Bearer ${token}`;
-    }
-    get(url, config) {
-        return this.limiter.schedule(() => this.instance.get(url, config));
-    }
-    post(url, data, config) {
-        return this.limiter.schedule(() => this.instance.post(url, data, config));
-    }
-    put(url, data, config) {
-        return this.limiter.schedule(() => this.instance.put(url, data, config));
-    }
-    patch(url, data, config) {
-        return this.limiter.schedule(() => this.instance.patch(url, data, config));
-    }
-    delete(url, config) {
-        return this.limiter.schedule(() => this.instance.delete(url, config));
-    }
-}
-exports.api = new Api();

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

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