@l-v-yonsama/multi-platform-database-drivers 0.1.213 → 0.1.214

package/built/src/drivers/Auth0Driver.js

@@ -0,0 +1,669 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Auth0Driver = void 0;
+const tslib_1 = require("tslib");
+const BaseDriver_1 = require("./BaseDriver");
+const resource_1 = require("../resource");
+const types_1 = require("../types");
+const utils_1 = require("../utils");
+const auth0_1 = require("auth0");
+const pluralize_1 = tslib_1.__importDefault(require("pluralize"));
+class Auth0Driver extends BaseDriver_1.BaseDriver {
+    constructor(conRes) {
+        super(conRes);
+    }
+    connectSub() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            try {
+                this.cachedAccessToken = undefined;
+            }
+            catch (e) {
+                console.error(e);
+                return `failed to connect:${e.message}`;
+            }
+            return '';
+        });
+    }
+    test(with_connect = false) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            let errorReason = '';
+            try {
+                if (with_connect) {
+                    const con_result = yield this.connect();
+                    if (con_result) {
+                        return con_result;
+                    }
+                }
+                yield this.getAvailableAccessToken();
+                if (with_connect) {
+                    yield this.disconnect();
+                }
+            }
+            catch (e) {
+                errorReason = e.message;
+            }
+            return errorReason;
+        });
+    }
+    getClients(params) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const list = [];
+            let page = 0;
+            let total = 0;
+            let sum = 0;
+            const { keyword, limit } = params !== null && params !== void 0 ? params : {};
+            const mngClient = yield this.getManagementClient();
+            do {
+                const r = yield mngClient.getClients({
+                    include_totals: true,
+                    page: page++,
+                });
+                total = r.total;
+                sum += r.clients.length;
+                if (keyword) {
+                    list.push(...r.clients.filter((it) => (0, utils_1.containsIgnoreCase)(keyword, [it.description, it.name])));
+                }
+                else {
+                    list.push(...r.clients);
+                }
+                if (limit !== undefined && list.length > limit) {
+                    return list.slice(0, limit);
+                }
+            } while (sum < total);
+            return list;
+        });
+    }
+    getClient({ tenant, name, clientId, }) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            let page = 0;
+            let total = 0;
+            let sum = 0;
+            let client = undefined;
+            if (tenant === undefined && name === undefined && clientId === undefined) {
+                throw new Error('tenant or name or clientId must be defined.');
+            }
+            const mngClient = yield this.getManagementClient();
+            do {
+                const r = yield mngClient.getClients({
+                    include_totals: true,
+                    page: page++,
+                });
+                total = r.total;
+                sum += r.clients.length;
+                client = r.clients.find((it) => (tenant !== undefined && (0, utils_1.equalsIgnoreCase)(it.tenant, tenant)) ||
+                    (clientId !== undefined &&
+                        (0, utils_1.equalsIgnoreCase)(it.client_id, clientId)) ||
+                    (name !== undefined && (0, utils_1.equalsIgnoreCase)(it.name, name)));
+            } while (sum < total);
+            return client;
+        });
+    }
+    createClientGrants(data) {
+        var _a, _b;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mngClient = yield this.getManagementClient();
+            const audience = (_a = data.audience) !== null && _a !== void 0 ? _a : this.getDefaultAudience();
+            const scope = (_b = data.scope) !== null && _b !== void 0 ? _b : this.getDefaultClientGrantScopes();
+            return yield mngClient.createClientGrant({
+                client_id: data.client_id,
+                audience,
+                scope,
+            });
+        });
+    }
+    createClient(data) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mngClient = yield this.getManagementClient();
+            return yield mngClient.createClient(Object.assign({ app_type: 'non_interactive', is_first_party: true, oidc_conformant: true, jwt_configuration: {
+                    alg: 'RS256',
+                    lifetime_in_seconds: 36000,
+                }, token_endpoint_auth_method: 'client_secret_post', grant_types: ['client_credentials'] }, data));
+        });
+    }
+    countOrganizations() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mngClient = yield this.getManagementClient();
+            const { total } = yield mngClient.organizations.getAll({
+                include_totals: true,
+                page: 0,
+                per_page: 1,
+            });
+            return total;
+        });
+    }
+    createOrganization(payload) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mngClient = yield this.getManagementClient();
+            return yield mngClient.organizations.create(payload);
+        });
+    }
+    updateOrganization(payload) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { id } = payload, data = tslib_1.__rest(payload, ["id"]);
+            const mngClient = yield this.getManagementClient();
+            return yield mngClient.organizations.update({ id }, data);
+        });
+    }
+    getOrganizations(params) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const list = [];
+            let page = 0;
+            let total = 0;
+            let sum = 0;
+            const { keyword, limit } = params !== null && params !== void 0 ? params : {};
+            const mngClient = yield this.getManagementClient();
+            do {
+                const r = yield mngClient.organizations.getAll({
+                    include_totals: true,
+                    page: page++,
+                });
+                total = r.total;
+                sum += r.organizations.length;
+                if (keyword) {
+                    list.push(...r.organizations.filter((it) => (0, utils_1.containsIgnoreCase)(keyword, [it.display_name, it.name])));
+                }
+                else {
+                    list.push(...r.organizations);
+                }
+                if (limit !== undefined && list.length > limit) {
+                    return list.slice(0, limit);
+                }
+            } while (sum < total);
+            return list;
+        });
+    }
+    getOrganization({ id, name, }) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (name === undefined && id === undefined) {
+                throw new Error('name or id must be defined.');
+            }
+            const mngClient = yield this.getManagementClient();
+            if (id !== undefined) {
+                return yield mngClient.organizations.getByID({ id });
+            }
+            if (name !== undefined) {
+                return yield mngClient.organizations.getByName({ name });
+            }
+            return undefined;
+        });
+    }
+    countRoles() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mngClient = yield this.getManagementClient();
+            const { total } = yield mngClient.getRoles({
+                include_totals: true,
+                page: 0,
+                per_page: 1,
+            });
+            return total;
+        });
+    }
+    createRole(payload) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mngClient = yield this.getManagementClient();
+            return yield mngClient.createRole(payload);
+        });
+    }
+    updateRole(payload) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { id } = payload, data = tslib_1.__rest(payload, ["id"]);
+            const mngClient = yield this.getManagementClient();
+            return yield mngClient.updateRole({ id }, data);
+        });
+    }
+    getRoles(params) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const list = [];
+            let page = 0;
+            let total = 0;
+            let sum = 0;
+            const { keyword, limit } = params !== null && params !== void 0 ? params : {};
+            const mngClient = yield this.getManagementClient();
+            do {
+                const r = yield mngClient.getRoles({
+                    name_filter: keyword,
+                    include_totals: true,
+                    page: page++,
+                });
+                total = r.total;
+                sum += r.roles.length;
+                list.push(...r.roles);
+                if (limit !== undefined && list.length > limit) {
+                    return list.slice(0, limit);
+                }
+            } while (sum < total);
+            return list;
+        });
+    }
+    getRole({ id, name }) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (id === undefined && name === undefined) {
+                throw new Error('id or name must be defined.');
+            }
+            if (id !== undefined) {
+                const mngClient = yield this.getManagementClient();
+                return yield mngClient.getRole({ id });
+            }
+            if (name !== undefined) {
+                const roles = this.getRoles({ keyword: name });
+                return (yield roles).find((it) => (0, utils_1.equalsIgnoreCase)(it.name, name));
+            }
+            return undefined;
+        });
+    }
+    countUsers() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mngClient = yield this.getManagementClient();
+            const { total } = yield mngClient.getUsers({
+                include_totals: true,
+                page: 0,
+                per_page: 1,
+            });
+            return total;
+        });
+    }
+    getUsers(params) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const list = [];
+            let page = 0;
+            let total = 0;
+            let sum = 0;
+            const { keyword, limit } = params !== null && params !== void 0 ? params : {};
+            const mngClient = yield this.getManagementClient();
+            do {
+                const r = yield mngClient.getUsers({
+                    q: (keyword !== null && keyword !== void 0 ? keyword : '').length > 0
+                        ? `name:*${keyword}* OR email:*${keyword}*`
+                        : undefined,
+                    include_totals: true,
+                    page: page++,
+                });
+                total = r.total;
+                sum += r.users.length;
+                list.push(...r.users);
+                if (limit !== undefined && list.length > limit) {
+                    return list.slice(0, limit);
+                }
+            } while (sum < total);
+            return list;
+        });
+    }
+    getMembers(orgId, params) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const list = [];
+            let page = 0;
+            let total = 0;
+            let sum = 0;
+            const { keyword, limit } = params !== null && params !== void 0 ? params : {};
+            const mngClient = yield this.getManagementClient();
+            do {
+                const r = yield mngClient.organizations.getMembers({
+                    id: orgId,
+                    include_totals: true,
+                    page: page++,
+                });
+                total = r.total;
+                sum += r.members.length;
+                if (keyword) {
+                    list.push(...r.members.filter((it) => (0, utils_1.containsIgnoreCase)(keyword, [it.name, it.email])));
+                }
+                else {
+                    list.push(...r.members);
+                }
+                if (limit !== undefined && list.length > limit) {
+                    return list.slice(0, limit);
+                }
+            } while (sum < total);
+            return list;
+        });
+    }
+    createUser(payload) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mngClient = yield this.getManagementClient();
+            return yield mngClient.createUser(Object.assign({ connection: 'Username-Password-Authentication' }, payload));
+        });
+    }
+    assignRolestoUser(userId, payload) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mngClient = yield this.getManagementClient();
+            yield mngClient.assignRolestoUser({ id: userId }, payload);
+        });
+    }
+    addMembers(orgId, payload) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const mngClient = yield this.getManagementClient();
+            yield mngClient.organizations.addMembers({ id: orgId }, payload);
+        });
+    }
+    scan(params) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { targetResourceType, parentTarget, keyword, limit } = params;
+            switch (targetResourceType) {
+                case 'IamClient': {
+                    const clients = yield this.getClients({
+                        keyword,
+                        limit,
+                    });
+                    const rdb = new resource_1.ResultSetDataBuilder([
+                        (0, resource_1.createRdhKey)({ name: 'client_id', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({ name: 'name', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({ name: 'description', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({ name: 'tenant', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({ name: 'client_secret', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({ name: 'app_type', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({ name: 'logo_uri', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({
+                            name: 'is_first_party',
+                            type: types_1.GeneralColumnType.BOOLEAN,
+                        }),
+                        (0, resource_1.createRdhKey)({
+                            name: 'oidc_conformant',
+                            type: types_1.GeneralColumnType.BOOLEAN,
+                        }),
+                        (0, resource_1.createRdhKey)({ name: 'grant_types', type: types_1.GeneralColumnType.JSON }),
+                        (0, resource_1.createRdhKey)({
+                            name: 'custom_login_page_on',
+                            type: types_1.GeneralColumnType.BOOLEAN,
+                        }),
+                    ]);
+                    clients.forEach((client) => {
+                        rdb.addRow({
+                            client_id: client.client_id,
+                            name: client.name,
+                            description: client.description,
+                            tenant: client.tenant,
+                            client_secret: client.client_secret,
+                            app_type: client.app_type,
+                            logo_uri: client.logo_uri,
+                            is_first_party: client.is_first_party,
+                            oidc_conformant: client.oidc_conformant,
+                            grant_types: JSON.stringify(client.grant_types),
+                            custom_login_page_on: client.custom_login_page_on,
+                        });
+                    });
+                    return rdb.build();
+                }
+                case 'IamUser': {
+                    if (parentTarget) {
+                        const members = yield this.getMembers(parentTarget, {
+                            limit,
+                            keyword,
+                        });
+                        const rdb = new resource_1.ResultSetDataBuilder([
+                            (0, resource_1.createRdhKey)({ name: 'user_id', type: types_1.GeneralColumnType.TEXT }),
+                            (0, resource_1.createRdhKey)({ name: 'name', type: types_1.GeneralColumnType.TEXT }),
+                            (0, resource_1.createRdhKey)({ name: 'email', type: types_1.GeneralColumnType.TEXT }),
+                            (0, resource_1.createRdhKey)({ name: 'picture', type: types_1.GeneralColumnType.TEXT }),
+                        ]);
+                        members.forEach((user) => {
+                            rdb.addRow({
+                                user_id: user.user_id,
+                                name: user.name,
+                                email: user.email,
+                                picture: user.picture,
+                            });
+                        });
+                        return rdb.build();
+                    }
+                    else {
+                        const users = yield this.getUsers({
+                            keyword,
+                            limit,
+                        });
+                        const rdb = new resource_1.ResultSetDataBuilder([
+                            (0, resource_1.createRdhKey)({ name: 'user_id', type: types_1.GeneralColumnType.TEXT }),
+                            (0, resource_1.createRdhKey)({ name: 'name', type: types_1.GeneralColumnType.TEXT }),
+                            (0, resource_1.createRdhKey)({ name: 'email', type: types_1.GeneralColumnType.TEXT }),
+                            (0, resource_1.createRdhKey)({
+                                name: 'created_at',
+                                type: types_1.GeneralColumnType.TIMESTAMP,
+                            }),
+                            (0, resource_1.createRdhKey)({ name: 'last_login', type: types_1.GeneralColumnType.TEXT }),
+                            (0, resource_1.createRdhKey)({
+                                name: 'last_password_reset',
+                                type: types_1.GeneralColumnType.TEXT,
+                            }),
+                            (0, resource_1.createRdhKey)({
+                                name: 'logins_count',
+                                type: types_1.GeneralColumnType.INTEGER,
+                            }),
+                            (0, resource_1.createRdhKey)({ name: 'blocked', type: types_1.GeneralColumnType.BOOLEAN }),
+                            (0, resource_1.createRdhKey)({
+                                name: 'email_verified',
+                                type: types_1.GeneralColumnType.BOOLEAN,
+                            }),
+                            (0, resource_1.createRdhKey)({
+                                name: 'app_metadata',
+                                type: types_1.GeneralColumnType.JSON,
+                            }),
+                            (0, resource_1.createRdhKey)({
+                                name: 'user_metadata',
+                                type: types_1.GeneralColumnType.JSON,
+                            }),
+                        ]);
+                        users.forEach((user) => {
+                            rdb.addRow({
+                                user_id: user.user_id,
+                                username: user.name,
+                                email: user.email,
+                                createdTimestamp: (0, utils_1.toDate)(user.created_at),
+                                last_login: user.last_login,
+                                last_password_reset: user.last_password_reset,
+                                logins_count: user.logins_count,
+                                blocked: user.blocked,
+                                email_verified: user.email_verified,
+                                app_metadata: JSON.stringify(user.app_metadata),
+                                user_metadata: JSON.stringify(user.user_metadata),
+                            });
+                        });
+                        return rdb.build();
+                    }
+                }
+                case 'IamOrganization': {
+                    const orgs = yield this.getOrganizations({
+                        keyword,
+                        limit,
+                    });
+                    const rdb = new resource_1.ResultSetDataBuilder([
+                        (0, resource_1.createRdhKey)({ name: 'id', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({ name: 'name', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({ name: 'display_name', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({
+                            name: 'branding_logo_url',
+                            type: types_1.GeneralColumnType.TEXT,
+                        }),
+                        (0, resource_1.createRdhKey)({ name: 'metadata', type: types_1.GeneralColumnType.JSON }),
+                    ]);
+                    orgs.forEach((org) => {
+                        var _a;
+                        rdb.addRow({
+                            id: org.id,
+                            name: org.name,
+                            display_name: org.display_name,
+                            branding_logo_url: (_a = org.branding) === null || _a === void 0 ? void 0 : _a.logo_url,
+                            metadata: JSON.stringify(org.metadata),
+                        });
+                    });
+                    return rdb.build();
+                }
+                case 'IamRole': {
+                    const roles = yield this.getRoles({
+                        keyword,
+                        limit,
+                    });
+                    const rdb = new resource_1.ResultSetDataBuilder([
+                        (0, resource_1.createRdhKey)({ name: 'id', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({ name: 'name', type: types_1.GeneralColumnType.TEXT }),
+                        (0, resource_1.createRdhKey)({ name: 'description', type: types_1.GeneralColumnType.TEXT }),
+                    ]);
+                    roles.forEach((role) => {
+                        rdb.addRow({
+                            id: role.id,
+                            name: role.name,
+                            description: role.description,
+                        });
+                    });
+                    return rdb.build();
+                }
+                default:
+                    throw new Error(`Not supported resource type ${targetResourceType}`);
+            }
+        });
+    }
+    getInfomationSchemasSub() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (!this.conRes) {
+                return [];
+            }
+            const dbResources = new Array();
+            const db = new resource_1.Auth0Database('Auth0');
+            const promises = [];
+            const setUserCount = (res) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                res.numOfUsers = yield this.countUsers();
+            });
+            const setOrganizationCount = (res) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                res.numOfOrganizations = yield this.countOrganizations();
+            });
+            const setOrganizationRes = (res) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                const organizations = yield this.getOrganizations({});
+                for (const organization of organizations) {
+                    const orgRes = new resource_1.IamOrganization(organization.name);
+                    orgRes['id'] = organization.id;
+                    orgRes.comment = organization.display_name;
+                    res.addChild(orgRes);
+                }
+            });
+            promises.push(setUserCount(db));
+            promises.push(setOrganizationCount(db));
+            promises.push(setOrganizationRes(db));
+            yield Promise.all(promises);
+            db.comment = `${db.numOfOrganizations} ${(0, pluralize_1.default)('organization', db.numOfOrganizations)}, ${db.numOfUsers} ${(0, pluralize_1.default)('user', db.numOfUsers)}`;
+            dbResources.push(db);
+            return dbResources;
+        });
+    }
+    closeSub() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            this.cachedAccessToken = undefined;
+            return '';
+        });
+    }
+    getManagementClient() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { host, iamSolution } = this.conRes;
+            const { clientId, clientSecret } = iamSolution;
+            const token = yield this.getAvailableAccessToken();
+            const client = new auth0_1.ManagementClient({
+                domain: host,
+                clientId,
+                clientSecret,
+                token,
+            });
+            return client;
+        });
+    }
+    getAvailableAccessToken() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (this.cachedAccessToken) {
+                const payload = (0, utils_1.decodeToken)(this.cachedAccessToken);
+                if (payload.exp - 60 > Math.floor(new Date().getTime() / 1000)) {
+                    return this.cachedAccessToken;
+                }
+            }
+            const { host, iamSolution } = this.conRes;
+            const { clientId, clientSecret } = iamSolution;
+            const client = new auth0_1.ManagementClient({
+                domain: host,
+                clientId,
+                clientSecret,
+            });
+            this.cachedAccessToken = yield client.getAccessToken();
+            return this.cachedAccessToken;
+        });
+    }
+    getDefaultAudience() {
+        return `https://${this.conRes.host}/api/v2/`;
+    }
+    getDefaultClientGrantScopes() {
+        return [
+            'read:client_grants',
+            'create:client_grants',
+            'delete:client_grants',
+            'update:client_grants',
+            'read:users',
+            'update:users',
+            'delete:users',
+            'create:users',
+            'read:users_app_metadata',
+            'update:users_app_metadata',
+            'delete:users_app_metadata',
+            'create:users_app_metadata',
+            'read:user_custom_blocks',
+            'create:user_custom_blocks',
+            'delete:user_custom_blocks',
+            'create:user_tickets',
+            'read:clients',
+            'update:clients',
+            'delete:clients',
+            'create:clients',
+            'read:connections',
+            'update:connections',
+            'delete:connections',
+            'create:connections',
+            'read:stats',
+            'read:insights',
+            'read:tenant_settings',
+            'update:tenant_settings',
+            'read:custom_domains',
+            'delete:custom_domains',
+            'create:custom_domains',
+            'update:custom_domains',
+            'read:email_templates',
+            'create:email_templates',
+            'update:email_templates',
+            'read:roles',
+            'create:roles',
+            'delete:roles',
+            'update:roles',
+            'read:branding',
+            'update:branding',
+            'delete:branding',
+            'create:signing_keys',
+            'read:signing_keys',
+            'update:signing_keys',
+            'read:limits',
+            'update:limits',
+            'create:role_members',
+            'read:role_members',
+            'delete:role_members',
+            'read:organizations_summary',
+            'create:authentication_methods',
+            'read:authentication_methods',
+            'update:authentication_methods',
+            'delete:authentication_methods',
+            'read:organizations',
+            'update:organizations',
+            'create:organizations',
+            'delete:organizations',
+            'create:organization_members',
+            'read:organization_members',
+            'delete:organization_members',
+            'create:organization_connections',
+            'read:organization_connections',
+            'update:organization_connections',
+            'delete:organization_connections',
+            'create:organization_member_roles',
+            'read:organization_member_roles',
+            'delete:organization_member_roles',
+            'create:organization_invitations',
+            'read:organization_invitations',
+            'delete:organization_invitations',
+            'read:client_credentials',
+            'create:client_credentials',
+            'update:client_credentials',
+            'delete:client_credentials',
+        ];
+    }
+}
+exports.Auth0Driver = Auth0Driver;
+//# sourceMappingURL=Auth0Driver.js.map