directus-template-cli 0.3.0-beta.3 → 0.3.0-beta.4

package/README.md

@@ -7,6 +7,7 @@ A CLI tool to make applying or extracting Directus "templates" a little easier..
 - 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 🙏)
+- If you are extracting or applying from a remote source, the script can take quite a while depedning on the "size" of your instance (how many collections, how many items in each collection, number and size of assets, etc). The script applies a strict rate limit of 10 requests per second using bottleneck.
 
 ## Usage
 

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

@@ -15,7 +15,11 @@ async function getCollections() {
 exports.getCollections = getCollections;
 async function getDataFromCollection(collection, dir) {
     try {
-        const { data } = await api_1.api.get(`items/${collection}`); // ADD limit = -1
+        const { data } = await api_1.api.get(`items/${collection}`, {
+            params: {
+                limit: -1,
+            },
+        });
         (0, write_to_file_1.default)(`${collection}`, data.data, `${dir}/content/`);
     }
     catch {

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

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

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

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractPermissions = exports.extractPublicPermissions = 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 extractPublicPermissions(dir) {
+    try {
+        const { data } = await api_1.api.get("permissions", {
+            params: {
+                limit: "-1",
+                "filter[role][_null]": true,
+            },
+        });
+        // Delete the id field from the permissions so we don't have to reset the autoincrement on the db
+        data.data.forEach((permission) => {
+            delete permission.id;
+        });
+        // 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.extractPublicPermissions = extractPublicPermissions;
+async function extractPermissions(dir) {
+    try {
+        const { data } = await api_1.api.get("permissions", {
+            params: {
+                limit: "-1",
+                "filter[role][_null]": true,
+            },
+        });
+        // Delete the id field from the permissions so we don't have to reset the autoincrement on the db
+        data.data.forEach((permission) => {
+            delete permission.id;
+        });
+        // Write the public permissions to the specified directory
+        await (0, write_to_file_1.default)("permissions", data.data, dir);
+    }
+    catch (error) {
+        console.log("Error fetching permissions:", error);
+    }
+}
+exports.extractPermissions = extractPermissions;

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

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

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

@@ -0,0 +1,29 @@
+"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"));
+/**
+ * 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,
+            },
+        });
+        // 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) => {
+            delete preset.id;
+            return preset;
+        });
+        await (0, write_to_file_1.default)("presets", filteredData, dir);
+    }
+    catch (error) {
+        console.log("Error extracting Users:", error.response.data.errors);
+    }
+}
+exports.default = extractPresets;

package/dist/lib/extract/index.js

@@ -5,12 +5,13 @@ 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_permissions_1 = require("./extract-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 extract_presets_1 = tslib_1.__importDefault(require("./extract-presets"));
 const endpoints = [
     // "folders",
     // "fields",
@@ -18,12 +19,12 @@ const endpoints = [
     // "roles",
     // "files",
     "operations",
-    "permissions",
+    // "permissions",
     "collections",
     "flows",
     "dashboards",
     "panels",
-    "presets",
+    // "presets",
     "settings",
 ];
 async function extract(dir, cli) {
@@ -34,18 +35,20 @@ async function extract(dir, cli) {
         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);
+    await (0, extract_presets_1.default)(destination);
+    await (0, extract_permissions_1.extractPermissions)(destination);
+    await (0, extract_permissions_1.extractPermissions)(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);
+    await (0, extract_permissions_1.extractPublicPermissions)(destination);
     // Extract content
     await (0, extract_content_1.extractContent)(destination);
     // Extract assets

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

@@ -1 +1 @@
-export declare function loadPermissions(roles: any): Promise<void>;
+export declare function loadPermissions(permissions: any): Promise<void>;

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

@@ -14,8 +14,8 @@ async function removeallPublicPermissions() {
         data: ids,
     });
 }
-async function loadPermissions(roles) {
+async function loadPermissions(permissions) {
     await removeallPublicPermissions();
-    await (0, load_to_destination_1.default)("permissions", roles);
+    await (0, load_to_destination_1.default)("permissions", permissions);
 }
 exports.loadPermissions = loadPermissions;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.3.0-beta.3",
+  "version": "0.3.0-beta.4",
   "commands": {
     "apply": {
       "id": "apply",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "directus-template-cli",
-  "version": "0.3.0-beta.3",
+  "version": "0.3.0-beta.4",
   "description": "CLI Utility for applying templates to a Directus instance.",
   "author": "bryantgillespie @bryantgillespie",
   "bin": {

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

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

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

@@ -1,21 +0,0 @@
-"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;