auth0-deploy-cli 7.9.0 → 7.10.0

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.10.0] - 2022-04-26
+
+### Added
+
+- Branding support for directory format [#505]
+
+### Fixed
+
+- More comprehensive support for deletions through `AUTH0_ALLOW_DELETE` [#509]
+
 ## [7.9.0] - 2022-04-19
 
 ### Added
@@ -690,7 +700,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#495]: https://github.com/auth0/auth0-deploy-cli/issues/495
 [#497]: https://github.com/auth0/auth0-deploy-cli/issues/497
 [#504]: https://github.com/auth0/auth0-deploy-cli/issues/504
-[unreleased]: https://github.com/auth0/auth0-deploy-cli/compare/v7.9.0...HEAD
+[#505]: https://github.com/auth0/auth0-deploy-cli/issues/505
+[#509]: https://github.com/auth0/auth0-deploy-cli/issues/509
+[unreleased]: https://github.com/auth0/auth0-deploy-cli/compare/v7.10.0...HEAD
+[7.10.0]: https://github.com/auth0/auth0-deploy-cli/compare/v7.9.0...v7.10.0
 [7.9.0]: https://github.com/auth0/auth0-deploy-cli/compare/v7.8.0...v7.9.0
 [7.8.0]: https://github.com/auth0/auth0-deploy-cli/compare/v7.7.1...v7.8.0
 [7.7.1]: https://github.com/auth0/auth0-deploy-cli/compare/v7.7.0...v7.7.1

package/README.md

@@ -7,7 +7,7 @@ The `auth0-deploy-cli` tool supports the importing and exporting of Auth0 Tenant
 Supported Auth0 Management API resources
 
 - [x] [Actions](https://auth0.com/docs/api/management/v2/#!/Actions/get_actions)
-- [ ] [Branding](https://auth0.com/docs/api/management/v2/#!/Branding/get_branding)
+- [x] [Branding](https://auth0.com/docs/api/management/v2/#!/Branding/get_branding)
 - [x] [Clients (Applications)](https://auth0.com/docs/api/management/v2#!/Clients/get_clients)
 - [x] [Client Grants](https://auth0.com/docs/api/management/v2#!/Client_Grants/get_client_grants)
 - [x] [Connections](https://auth0.com/docs/api/management/v2#!/Connections/get_connections)

package/lib/context/directory/handlers/branding.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -17,7 +28,11 @@ const path_1 = __importDefault(require("path"));
 const tools_1 = require("../../../tools");
 const utils_1 = require("../../../utils");
 function parse(context) {
-    const brandingTemplatesFolder = path_1.default.join(context.filePath, tools_1.constants.BRANDING_DIRECTORY, tools_1.constants.BRANDING_TEMPLATES_DIRECTORY);
+    const brandingDirectory = path_1.default.join(context.filePath, tools_1.constants.BRANDING_DIRECTORY);
+    if (!(0, utils_1.existsMustBeDir)(brandingDirectory))
+        return { branding: undefined };
+    const branding = (0, utils_1.loadJSON)(path_1.default.join(brandingDirectory, 'branding.json'), context.mappings);
+    const brandingTemplatesFolder = path_1.default.join(brandingDirectory, tools_1.constants.BRANDING_TEMPLATES_DIRECTORY);
     if (!(0, utils_1.existsMustBeDir)(brandingTemplatesFolder))
         return { branding: context.assets.branding };
     const templatesDefinitionFiles = (0, utils_1.getFiles)(brandingTemplatesFolder, ['.json']);
@@ -27,32 +42,51 @@ function parse(context) {
         return definition;
     }, {});
     return {
-        branding: {
-            templates,
-        },
+        branding: Object.assign(Object.assign({}, branding), { templates }),
     };
 }
 function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { branding } = context.assets;
-        if (!branding || !branding.templates || !branding.templates)
-            return; // Skip, nothing to dump
-        const brandingTemplatesFolder = path_1.default.join(context.filePath, tools_1.constants.BRANDING_DIRECTORY, tools_1.constants.BRANDING_TEMPLATES_DIRECTORY);
-        fs_extra_1.default.ensureDirSync(brandingTemplatesFolder);
-        branding.templates.forEach((templateDefinition) => {
-            const markup = templateDefinition.body;
-            try {
-                fs_extra_1.default.writeFileSync(path_1.default.join(brandingTemplatesFolder, `${templateDefinition.template}.html`), markup);
-            }
-            catch (e) {
-                throw new Error(`Error writing template file: ${templateDefinition.template}, because: ${e.message}`);
-            }
-            // save the location as relative file.
-            templateDefinition.body = `.${path_1.default.sep}${templateDefinition.template}.html`;
-            (0, utils_1.dumpJSON)(path_1.default.join(brandingTemplatesFolder, `${templateDefinition.template}.json`), templateDefinition);
-        });
+        const _a = context.assets.branding, { templates = [] } = _a, branding = __rest(_a, ["templates"]);
+        if (!!branding)
+            dumpBranding(context);
+        if (!!templates)
+            dumpBrandingTemplates(context);
     });
 }
+const dumpBrandingTemplates = ({ filePath, assets }) => {
+    if (!assets || !assets.branding)
+        return;
+    const { branding: { templates = [] }, } = assets;
+    const brandingTemplatesFolder = path_1.default.join(filePath, tools_1.constants.BRANDING_DIRECTORY, tools_1.constants.BRANDING_TEMPLATES_DIRECTORY);
+    fs_extra_1.default.ensureDirSync(brandingTemplatesFolder);
+    templates.forEach((templateDefinition) => {
+        const markup = templateDefinition.body;
+        try {
+            fs_extra_1.default.writeFileSync(path_1.default.join(brandingTemplatesFolder, `${templateDefinition.template}.html`), markup);
+        }
+        catch (e) {
+            throw new Error(`Error writing template file: ${templateDefinition.template}, because: ${e.message}`);
+        }
+        // save the location as relative file.
+        templateDefinition.body = `.${path_1.default.sep}${templateDefinition.template}.html`;
+        (0, utils_1.dumpJSON)(path_1.default.join(brandingTemplatesFolder, `${templateDefinition.template}.json`), templateDefinition);
+    });
+};
+const dumpBranding = ({ filePath, assets }) => {
+    if (!assets || !assets.branding)
+        return;
+    const { branding } = assets;
+    const brandingWithoutTemplates = (() => {
+        const newBranding = Object.assign({}, branding);
+        delete newBranding.templates;
+        return newBranding;
+    })();
+    const brandingDirectory = path_1.default.join(filePath, tools_1.constants.BRANDING_DIRECTORY);
+    fs_extra_1.default.ensureDirSync(brandingDirectory);
+    const brandingFilePath = path_1.default.join(brandingDirectory, 'branding.json');
+    (0, utils_1.dumpJSON)(brandingFilePath, brandingWithoutTemplates);
+};
 const brandingHandler = {
     parse,
     dump,

package/lib/context/yaml/handlers/branding.d.ts

@@ -1,6 +1,13 @@
 import { YAMLHandler } from '.';
+declare type BrandingTemplate = {
+    template: string;
+    body: string;
+};
 declare type ParsedBranding = {
-    branding: unknown;
+    branding: {
+        templates?: BrandingTemplate[];
+        [key: string]: unknown;
+    };
 };
 declare const brandingHandler: YAMLHandler<ParsedBranding>;
 export default brandingHandler;

package/lib/context/yaml/handlers/branding.js

@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -18,24 +29,30 @@ const tools_1 = require("../../../tools");
 function parse(context) {
     return __awaiter(this, void 0, void 0, function* () {
         // Load the HTML file for each page
-        const { branding } = context.assets;
-        if (!branding || !branding.templates)
+        if (!context.assets.branding)
+            return {
+                branding: {
+                    templates: [],
+                },
+            };
+        const _a = context.assets.branding, { templates } = _a, branding = __rest(_a, ["templates"]);
+        if (!branding && !branding['templates'])
             return { branding };
-        const templates = branding.templates.map((templateDefinition) => {
-            const markupFile = path_1.default.join(templateDefinition.body);
+        const parsedTemplates = templates.map((templateDefinition) => {
+            const markupFile = path_1.default.join(context.basePath, templateDefinition.body);
             return {
                 template: templateDefinition.template,
                 body: (0, tools_1.loadFileAndReplaceKeywords)(markupFile, context.mappings),
             };
         });
         return {
-            branding: Object.assign(Object.assign({}, branding), { templates }),
+            branding: Object.assign(Object.assign({}, branding), { templates: parsedTemplates }),
         };
     });
 }
 function dump(context) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { branding } = context.assets || { branding: undefined };
+        const { branding } = context.assets;
         branding.templates = branding.templates || [];
         // create templates folder
         if (branding.templates.length) {

package/lib/tools/auth0/handlers/default.js

@@ -92,6 +92,7 @@ class APIHandler {
             return (0, calculateChanges_1.calculateChanges)({
                 handler: this,
                 assets: typeAssets,
+                allowDelete: !!this.config('AUTH0_ALLOW_DELETE'),
                 //@ts-ignore TODO: investigate what happens when `existing` is null
                 existing,
                 identifiers: this.identifiers,

package/lib/tools/auth0/handlers/organizations.js

@@ -237,7 +237,7 @@ class OrganizationsHandler extends default_1.default {
                 assets: organizations,
                 existing,
                 identifiers: ['id', 'name'],
-                allowDelete: false, //TODO: actually pass in correct allowDelete value
+                allowDelete: !!this.config('AUTH0_ALLOW_DELETE'),
             });
             logger_1.default.debug(`Start processChanges for organizations [delete:${changes.del.length}] [update:${changes.update.length}], [create:${changes.create.length}]`);
             const myChanges = [

package/lib/tools/auth0/handlers/resourceServers.js

@@ -83,7 +83,7 @@ class ResourceServersHandler extends default_1.default {
                 assets: resourceServers,
                 existing,
                 identifiers: ['id', 'identifier'],
-                allowDelete: false, //TODO: actually pass in correct allowDelete value
+                allowDelete: !!this.config('AUTH0_ALLOW_DELETE'),
             });
         });
     }

package/lib/tools/auth0/handlers/roles.js

@@ -210,7 +210,7 @@ class RolesHandler extends default_1.default {
                 assets: roles,
                 existing,
                 identifiers: ['id', 'name'],
-                allowDelete: false, //TODO: actually pass in correct allowDelete value
+                allowDelete: !!this.config('AUTH0_ALLOW_DELETE'),
             });
             logger_1.default.debug(`Start processChanges for roles [delete:${changes.del.length}] [update:${changes.update.length}], [create:${changes.create.length}]`);
             const myChanges = [

package/lib/tools/auth0/handlers/rules.js

@@ -89,7 +89,7 @@ class RulesHandler extends default_1.default {
                 assets: rules,
                 existing,
                 identifiers: ['id', 'name'],
-                allowDelete: false, //TODO: actually pass in correct allowDelete value
+                allowDelete: !!this.config('AUTH0_ALLOW_DELETE'),
             });
             // Figure out the rules that need to be re-ordered
             const futureRules = [...create, ...update];

package/lib/tools/calculateChanges.d.ts

@@ -6,14 +6,14 @@ import { Asset, CalculatedChanges } from '../types';
  * @param {T} desiredAssetState
  * @param {T} currentAssetState
  * @param {string[]} [objectFields=[]]
- * @param {boolean} [allowDelete=false]
+ * @param {boolean} [allowDelete]
  * @returns T
  */
 export declare function processChangedObjectFields({ handler, desiredAssetState, currentAssetState, allowDelete, }: {
     handler: APIHandler;
     desiredAssetState: Asset;
     currentAssetState: Asset;
-    allowDelete?: boolean;
+    allowDelete: boolean;
 }): {
     [x: string]: any;
 };

package/lib/tools/calculateChanges.js

@@ -11,10 +11,10 @@ const logger_1 = __importDefault(require("../logger"));
  * @param {T} desiredAssetState
  * @param {T} currentAssetState
  * @param {string[]} [objectFields=[]]
- * @param {boolean} [allowDelete=false]
+ * @param {boolean} [allowDelete]
  * @returns T
  */
-function processChangedObjectFields({ handler, desiredAssetState, currentAssetState, allowDelete = false, }) {
+function processChangedObjectFields({ handler, desiredAssetState, currentAssetState, allowDelete, }) {
     const desiredAssetStateWithChanges = Object.assign({}, desiredAssetState);
     // eslint-disable-next-line no-restricted-syntax
     for (const fieldName of handler.objectFields) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "7.9.0",
+  "version": "7.10.0",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -53,7 +53,7 @@
     "@types/expect": "^24.3.0",
     "@types/mocha": "^9.1.0",
     "chai": "^4.3.6",
-    "@typescript-eslint/parser": "^5.17.0",
+    "@typescript-eslint/parser": "^5.18.0",
     "chai-as-promised": "^7.1.1",
     "cross-env": "^3.1.4",
     "eslint": "^7.28.0",
@@ -64,7 +64,7 @@
     "kacl": "^1.1.1",
     "mocha": "^9.2.2",
     "nyc": "^15.0.1",
-    "prettier": "^2.6.1",
+    "prettier": "^2.6.2",
     "pretty-quick": "^3.1.3",
     "rimraf": "^3.0.2",
     "rmdir-sync": "^1.0.1",