auth0-deploy-cli 7.8.0 → 7.9.0

package/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.9.0] - 2022-04-19
+
+### Added
+
+- Log streams support [#495]
+
+### Fixed
+
+- `##` String keyword replacements now work when nested inside `@@` array replacements [#504]
+
 ## [7.8.0] - 2022-04-14
 
 ### Added
@@ -677,8 +687,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#481]: https://github.com/auth0/auth0-deploy-cli/issues/481
 [#482]: https://github.com/auth0/auth0-deploy-cli/issues/482
 [#485]: https://github.com/auth0/auth0-deploy-cli/issues/485
+[#495]: https://github.com/auth0/auth0-deploy-cli/issues/495
 [#497]: https://github.com/auth0/auth0-deploy-cli/issues/497
-[unreleased]: https://github.com/auth0/auth0-deploy-cli/compare/v7.8.0...HEAD
+[#504]: https://github.com/auth0/auth0-deploy-cli/issues/504
+[unreleased]: https://github.com/auth0/auth0-deploy-cli/compare/v7.9.0...HEAD
+[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
 [7.7.0]: https://github.com/auth0/auth0-deploy-cli/compare/v7.6.0...v7.7.0

package/README.md

@@ -16,7 +16,7 @@ Supported Auth0 Management API resources
 - [x] [Grants](https://auth0.com/docs/api/management/v2#!/Grants/get_grants)
 - [x] [Hooks](https://auth0.com/docs/api/management/v2#!/Hooks/get_hooks)
 - [x] [Hook Secrets](https://auth0.com/docs/api/management/v2/#!/Hooks/get_secrets)
-- [ ] [Log Streams](https://auth0.com/docs/api/management/v2#!/Log_Streams/get_log_streams)
+- [x] [Log Streams](https://auth0.com/docs/api/management/v2#!/Log_Streams/get_log_streams)
 - [ ] [Logs](https://auth0.com/docs/api/management/v2#!/Logs/get_logs)
 - [x] [Organizations](https://auth0.com/docs/api/management/v2#!/Organizations/get_organizations)
 - [ ] [Prompts](https://auth0.com/docs/api/management/v2#!/Prompts/get_prompts)

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

@@ -28,6 +28,7 @@ const organizations_1 = __importDefault(require("./organizations"));
 const triggers_1 = __importDefault(require("./triggers"));
 const attackProtection_1 = __importDefault(require("./attackProtection"));
 const branding_1 = __importDefault(require("./branding"));
+const logStreams_1 = __importDefault(require("./logStreams"));
 const directoryHandlers = {
     rules: rules_1.default,
     rulesConfigs: rulesConfigs_1.default,
@@ -54,5 +55,6 @@ const directoryHandlers = {
     triggers: triggers_1.default,
     attackProtection: attackProtection_1.default,
     branding: branding_1.default,
+    logStreams: logStreams_1.default,
 };
 exports.default = directoryHandlers;

package/lib/context/directory/handlers/logStreams.d.ts

@@ -0,0 +1,7 @@
+import { DirectoryHandler } from '.';
+import { Asset } from '../../../types';
+declare type ParsedLogStreams = {
+    logStreams: Asset[] | undefined;
+};
+declare const logStreamsHandler: DirectoryHandler<ParsedLogStreams>;
+export default logStreamsHandler;

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

@@ -0,0 +1,49 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const tools_1 = require("../../../tools");
+const utils_1 = require("../../../utils");
+function parse(context) {
+    const logStreamsDirectory = path_1.default.join(context.filePath, tools_1.constants.LOG_STREAMS_DIRECTORY);
+    if (!(0, utils_1.existsMustBeDir)(logStreamsDirectory))
+        return { logStreams: undefined }; // Skip
+    const foundFiles = (0, utils_1.getFiles)(logStreamsDirectory, ['.json']);
+    const logStreams = foundFiles
+        .map((f) => (0, utils_1.loadJSON)(f, context.mappings))
+        .filter((p) => Object.keys(p).length > 0); // Filter out empty rulesConfigs
+    return {
+        logStreams,
+    };
+}
+function dump(context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const logStreams = context.assets.logStreams || [];
+        if (!logStreams)
+            return; // Skip, nothing to dump
+        // Create Rules folder
+        const logStreamsDirectory = path_1.default.join(context.filePath, tools_1.constants.LOG_STREAMS_DIRECTORY);
+        fs_extra_1.default.ensureDirSync(logStreamsDirectory);
+        logStreams.forEach((logStream) => {
+            const ruleFile = path_1.default.join(logStreamsDirectory, `${(0, utils_1.sanitize)(logStream.name)}.json`);
+            (0, utils_1.dumpJSON)(ruleFile, logStream);
+        });
+    });
+}
+const logStreamsHandler = {
+    parse,
+    dump,
+};
+exports.default = logStreamsHandler;

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

@@ -28,6 +28,7 @@ const actions_1 = __importDefault(require("./actions"));
 const triggers_1 = __importDefault(require("./triggers"));
 const attackProtection_1 = __importDefault(require("./attackProtection"));
 const branding_1 = __importDefault(require("./branding"));
+const logStreams_1 = __importDefault(require("./logStreams"));
 const yamlHandlers = {
     rules: rules_1.default,
     hooks: hooks_1.default,
@@ -54,5 +55,6 @@ const yamlHandlers = {
     triggers: triggers_1.default,
     attackProtection: attackProtection_1.default,
     branding: branding_1.default,
+    logStreams: logStreams_1.default,
 };
 exports.default = yamlHandlers;

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

@@ -0,0 +1,7 @@
+import { YAMLHandler } from '.';
+import { Asset } from '../../../types';
+declare type ParsedLogStreams = {
+    logStreams: Asset[] | null;
+};
+declare const logStreamsHandler: YAMLHandler<ParsedLogStreams>;
+export default logStreamsHandler;

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

@@ -0,0 +1,23 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+function parseAndDump(context) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return {
+            logStreams: context.assets.logStreams || [],
+        };
+    });
+}
+const logStreamsHandler = {
+    parse: parseAndDump,
+    dump: parseAndDump,
+};
+exports.default = logStreamsHandler;

package/lib/index.d.ts

@@ -76,6 +76,7 @@ declare const _default: {
             DATABASE_SCRIPTS_IMPORT: string[];
             EMAIL_TEMPLATES_NAMES: string[];
             SUPPORTED_BRANDING_TEMPLATES: string[];
+            LOG_STREAMS_DIRECTORY: string;
         };
         deploy: typeof import("./tools").deploy;
         keywordReplace: typeof import("./tools").keywordReplace;

package/lib/tools/auth0/handlers/index.d.ts

@@ -125,5 +125,10 @@ declare const _default: {
         excludeSchema?: any;
         schema: any;
     };
+    logStreams: {
+        default: typeof APIHandler;
+        excludeSchema?: any;
+        schema: any;
+    };
 };
 export default _default;

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

@@ -50,6 +50,7 @@ const actions = __importStar(require("./actions"));
 const triggers = __importStar(require("./triggers"));
 const organizations = __importStar(require("./organizations"));
 const attackProtection = __importStar(require("./attackProtection"));
+const logStreams = __importStar(require("./logStreams"));
 const auth0ApiHandlers = {
     rules,
     rulesConfigs,
@@ -78,5 +79,6 @@ const auth0ApiHandlers = {
     triggers,
     organizations,
     attackProtection,
+    logStreams,
 };
 exports.default = auth0ApiHandlers; // TODO: apply stronger types to schema properties

package/lib/tools/auth0/handlers/logStreams.d.ts

@@ -0,0 +1,40 @@
+import DefaultAPIHandler from './default';
+import { Asset, Assets } from '../../../types';
+export declare const schema: {
+    type: string;
+    items: {
+        type: string;
+        properties: {
+            id: {
+                type: string;
+            };
+            type: {
+                type: string;
+            };
+            name: {
+                type: string;
+            };
+            status: {
+                type: string;
+                enum: string[];
+            };
+            sink: {
+                type: string;
+            };
+            filters: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+        };
+        required: string[];
+    };
+};
+export default class LogStreamsHandler extends DefaultAPIHandler {
+    existing: Asset[] | null;
+    constructor(config: DefaultAPIHandler);
+    objString(item: Asset): string;
+    getType(): Promise<Asset>;
+    processChanges(assets: Assets): Promise<void>;
+}

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

@@ -0,0 +1,77 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = void 0;
+const default_1 = __importDefault(require("./default"));
+exports.schema = {
+    type: 'array',
+    items: {
+        type: 'object',
+        properties: {
+            id: { type: 'string' },
+            type: { type: 'string' },
+            name: { type: 'string' },
+            status: { type: 'string', enum: ['active', 'paused', 'suspended'] },
+            sink: { type: 'object' },
+            filters: {
+                type: 'array',
+                items: {
+                    type: 'object',
+                },
+            },
+        },
+        required: ['name'],
+    },
+};
+class LogStreamsHandler extends default_1.default {
+    constructor(config) {
+        super(Object.assign(Object.assign({}, config), { type: 'logStreams', stripUpdateFields: ['type'], stripCreateFields: ['status', 'sink.awsPartnerEventSource'], sensitiveFieldsToObfuscate: ['sink.httpAuthorization'] }));
+    }
+    objString(item) {
+        return super.objString(item.name);
+    }
+    getType() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.existing) {
+                return this.existing;
+            }
+            const logStreams = yield this.client.logStreams.getAll({ paginate: false });
+            const nonSuspendedLogStreams = logStreams.filter((logStream) => logStream.status !== 'suspended');
+            this.existing = nonSuspendedLogStreams;
+            return nonSuspendedLogStreams;
+        });
+    }
+    processChanges(assets) {
+        const _super = Object.create(null, {
+            processChanges: { get: () => super.processChanges }
+        });
+        return __awaiter(this, void 0, void 0, function* () {
+            const { logStreams } = assets;
+            // Do nothing if not set
+            if (!logStreams)
+                return;
+            // Figure out what needs to be updated vs created
+            const changes = yield this.calcChanges(assets).then((changes) => {
+                return Object.assign(Object.assign({}, changes), { update: changes.update.map((update) => {
+                        if (update.type === 'eventbridge' || update.type === 'eventgrid') {
+                            delete update.sink;
+                        }
+                        return update;
+                    }) });
+            });
+            yield _super.processChanges.call(this, assets, changes);
+        });
+    }
+}
+exports.default = LogStreamsHandler;

package/lib/tools/constants.d.ts

@@ -67,5 +67,6 @@ declare const constants: {
     DATABASE_SCRIPTS_IMPORT: string[];
     EMAIL_TEMPLATES_NAMES: string[];
     SUPPORTED_BRANDING_TEMPLATES: string[];
+    LOG_STREAMS_DIRECTORY: string;
 };
 export default constants;

package/lib/tools/constants.js

@@ -164,5 +164,6 @@ const constants = {
         `${EMAIL_USER_INVITATION}.html`,
     ],
     SUPPORTED_BRANDING_TEMPLATES: [UNIVERSAL_LOGIN_TEMPLATE],
+    LOG_STREAMS_DIRECTORY: 'log-streams',
 };
 exports.default = constants;

package/lib/tools/index.d.ts

@@ -72,6 +72,7 @@ declare const _default: {
         DATABASE_SCRIPTS_IMPORT: string[];
         EMAIL_TEMPLATES_NAMES: string[];
         SUPPORTED_BRANDING_TEMPLATES: string[];
+        LOG_STREAMS_DIRECTORY: string;
     };
     deploy: typeof deploy;
     keywordReplace: typeof keywordReplace;

package/lib/tools/utils.js

@@ -56,8 +56,8 @@ exports.keywordStringReplace = keywordStringReplace;
 function keywordReplace(input, mappings) {
     // Replace keywords with mappings within input.
     if (mappings && Object.keys(mappings).length > 0) {
-        input = keywordStringReplace(input, mappings);
         input = keywordArrayReplace(input, mappings);
+        input = keywordStringReplace(input, mappings);
     }
     return input;
 }

package/lib/types.d.ts

@@ -109,6 +109,7 @@ export declare type BaseAuth0APIClient = {
         }) => Promise<Promise<Asset[]>>;
         addSecrets: (arg0: {}, arg1: Asset) => Promise<void>;
     };
+    logStreams: APIClientBaseFunctions;
     migrations: APIClientBaseFunctions & {
         getMigrations: () => Promise<{
             flags: Asset[];
@@ -228,6 +229,7 @@ export declare type Assets = {
         policies: Asset[];
     };
     hooks: Asset[];
+    logStreams: Asset[];
     migrations: Asset[];
     organizations: Asset[];
     pages: Asset[];
@@ -248,7 +250,7 @@ export declare type CalculatedChanges = {
     conflicts: Asset[];
     create: Asset[];
 };
-export declare type AssetTypes = 'rules' | 'rulesConfigs' | 'hooks' | 'pages' | 'databases' | 'clientGrants' | 'resourceServers' | 'clients' | 'connections' | 'tenant' | 'emailProvider' | 'emailTemplates' | 'guardianFactors' | 'guardianFactorProviders' | 'guardianFactorTemplates' | 'migrations' | 'guardianPhoneFactorMessageTypes' | 'guardianPhoneFactorSelectedProvider' | 'guardianPolicies' | 'roles' | 'actions' | 'organizations' | 'triggers' | 'attackProtection' | 'branding';
+export declare type AssetTypes = 'rules' | 'rulesConfigs' | 'hooks' | 'pages' | 'databases' | 'clientGrants' | 'resourceServers' | 'clients' | 'connections' | 'tenant' | 'emailProvider' | 'emailTemplates' | 'guardianFactors' | 'guardianFactorProviders' | 'guardianFactorTemplates' | 'migrations' | 'guardianPhoneFactorMessageTypes' | 'guardianPhoneFactorSelectedProvider' | 'guardianPolicies' | 'roles' | 'actions' | 'organizations' | 'triggers' | 'attackProtection' | 'branding' | 'logStreams';
 export declare type KeywordMappings = {
     [key: string]: (string | number)[] | string | number;
 };

package/lib/utils.d.ts

@@ -30,6 +30,7 @@ export declare function stripIdentifiers(auth0: Auth0, assets: Assets): {
         policies: Asset[];
     };
     hooks: Asset[];
+    logStreams: Asset[];
     migrations: Asset[];
     organizations: Asset[];
     pages: Asset[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auth0-deploy-cli",
-  "version": "7.8.0",
+  "version": "7.9.0",
   "description": "A command line tool for deploying updates to your Auth0 tenant",
   "main": "lib/index.js",
   "bin": {
@@ -40,20 +40,20 @@
     "global-agent": "^2.1.12",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.20",
-    "mkdirp": "^0.5.1",
+    "mkdirp": "^0.5.6",
     "nconf": "^0.11.4",
     "promise-pool-executor": "^1.1.1",
     "sanitize-filename": "^1.6.1",
     "sinon": "^13.0.1",
     "sinon-chai": "^3.7.0",
-    "winston": "^3.3.0",
+    "winston": "^3.6.0",
     "yargs": "^15.3.1"
   },
   "devDependencies": {
     "@types/expect": "^24.3.0",
     "@types/mocha": "^9.1.0",
     "chai": "^4.3.6",
-    "@typescript-eslint/parser": "^5.16.0",
+    "@typescript-eslint/parser": "^5.17.0",
     "chai-as-promised": "^7.1.1",
     "cross-env": "^3.1.4",
     "eslint": "^7.28.0",
@@ -69,6 +69,6 @@
     "rimraf": "^3.0.2",
     "rmdir-sync": "^1.0.1",
     "ts-mocha": "^9.0.2",
-    "typescript": "^4.6.2"
+    "typescript": "^4.6.3"
   }
 }