@lightdash/cli 2.270.0 → 2.271.0

package/dist/handlers/contentAsCode/registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/handlers/contentAsCode/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,KAAK,yBAAyB,EACjC,MAAM,mBAAmB,CAAC;AAe3B,MAAM,MAAM,wBAAwB,GAAG;IACnC,IAAI,EAAE,yBAAyB,CAAC;IAChC,YAAY,EAAE,SAAS,yBAAyB,EAAE,CAAC;CACtD,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,SAAS,wBAAwB,EAMtE,CAAC;AAEN,eAAO,MAAM,sBAAsB,EAAE,SAAS,wBAAwB,EAyBrE,CAAC;AAEF,eAAO,MAAM,iCAAiC,cAC/B,SAAS,wBAAwB,EAAE,KAC/C,IAeF,CAAC"}
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../../src/handlers/contentAsCode/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,KAAK,yBAAyB,EACjC,MAAM,mBAAmB,CAAC;AAgB3B,MAAM,MAAM,wBAAwB,GAAG;IACnC,IAAI,EAAE,yBAAyB,CAAC;IAChC,YAAY,EAAE,SAAS,yBAAyB,EAAE,CAAC;CACtD,CAAC;AAEF,eAAO,MAAM,2BAA2B,EAAE,SAAS,wBAAwB,EAOtE,CAAC;AAEN,eAAO,MAAM,sBAAsB,EAAE,SAAS,wBAAwB,EAyBrE,CAAC;AAEF,eAAO,MAAM,iCAAiC,cAC/B,SAAS,wBAAwB,EAAE,KAC/C,IAeF,CAAC"}

package/dist/handlers/contentAsCode/registry.js

@@ -5,12 +5,14 @@ const common_1 = require("@lightdash/common");
 const customRoles_1 = require("../organizationContent/customRoles");
 const groups_1 = require("../organizationContent/groups");
 const themes_1 = require("../organizationContent/themes");
+const userAttributes_1 = require("../organizationContent/userAttributes");
 const users_1 = require("../organizationContent/users");
 const projectResources_1 = require("./projectResources");
 exports.ORGANIZATION_CODE_RESOURCES = [
     customRoles_1.CUSTOM_ROLE_CODE_RESOURCE,
     users_1.USER_CODE_RESOURCE,
     groups_1.GROUP_CODE_RESOURCE,
+    userAttributes_1.USER_ATTRIBUTE_CODE_RESOURCE,
     themes_1.THEME_CODE_RESOURCE,
 ];
 exports.PROJECT_CODE_RESOURCES = [

package/dist/handlers/organizationContent/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAgC3C,KAAK,0BAA0B,GAAG;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAqBF,eAAO,MAAM,4BAA4B,gBAAiB,MAAM,KAAG,MAClC,CAAC;AAElC,eAAO,MAAM,2BAA2B,4BAGrC,0BAA0B,KAAG,OAAO,CAAC,IAAI,CAiG3C,CAAC;AAEF,eAAO,MAAM,yBAAyB,yCAInC,0BAA0B,KAAG,OAAO,CAAC,IAAI,CA+K3C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAqC3C,KAAK,0BAA0B,GAAG;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB,CAAC;AAqBF,eAAO,MAAM,4BAA4B,gBAAiB,MAAM,KAAG,MAClC,CAAC;AAElC,eAAO,MAAM,2BAA2B,4BAGrC,0BAA0B,KAAG,OAAO,CAAC,IAAI,CA2G3C,CAAC;AAEF,eAAO,MAAM,yBAAyB,yCAInC,0BAA0B,KAAG,OAAO,CAAC,IAAI,CAoM3C,CAAC"}

package/dist/handlers/organizationContent/index.js

@@ -13,6 +13,7 @@ const contentAsCodePaths_1 = require("../contentAsCodePaths");
 const customRoles_1 = require("./customRoles");
 const groups_1 = require("./groups");
 const themes_1 = require("./themes");
+const userAttributes_1 = require("./userAttributes");
 const users_1 = require("./users");
 const createCustomRolePartialUploadError = (message) => new resource_1.CodeResourcePhaseError('custom_role', message);
 const createUserPartialUploadError = (message) => new resource_1.CodeResourcePhaseError('user', message);
@@ -67,6 +68,11 @@ const downloadOrganizationContent = async ({ customPath, config, }) => {
             output.completeItem('service unavailable', 'warning');
             globalState_1.default.debug('> Warning: groups were not downloaded because the group service is not enabled');
         }
+        const userAttributesTotal = await output.runItem({
+            label: 'User attributes',
+            action: () => (0, userAttributes_1.downloadUserAttributes)(organizationUuid, organizationContentPath),
+            detail: (total) => `${total} downloaded`,
+        });
         const themesTotal = await output.runItem({
             label: 'Themes',
             action: () => (0, themes_1.downloadThemes)(organizationContentPath),
@@ -86,6 +92,7 @@ const downloadOrganizationContent = async ({ customPath, config, }) => {
                 usersNum: usersTotal,
                 groupsNum: groupsTotal,
                 themesNum: themesTotal,
+                userAttributesNum: userAttributesTotal,
                 timeToCompleted: (Date.now() - start) / 1000,
             },
         });
@@ -161,6 +168,15 @@ const uploadOrganizationContent = async ({ customPath, config, sendInvites = fal
             throw createGroupPartialUploadError(`Processed groups: ${groupSummaryMessage}`);
         }
         output.completeItem(groupSummaryMessage);
+        output.startItem('User attributes');
+        const userAttributeSummary = await (0, userAttributes_1.uploadUserAttributes)(organizationUuid, organizationContentPath);
+        const userAttributeSummaryMessage = (0, userAttributes_1.formatUserAttributeUploadSummary)(userAttributeSummary);
+        if (userAttributeSummary.failed > 0) {
+            userAttributeSummary.failures.forEach(({ message }) => globalState_1.default.log(styles.error(message)));
+            output.prepareForFailureDetails();
+            throw new resource_1.CodeResourcePhaseError('user_attribute', `Processed user attributes: ${userAttributeSummaryMessage}`);
+        }
+        output.completeItem(userAttributeSummaryMessage);
         output.startItem('Themes');
         const themeSummary = await (0, themes_1.uploadThemes)(preparedThemes);
         const themeSummaryMessage = (0, themes_1.formatThemeUploadSummary)(themeSummary);
@@ -194,6 +210,9 @@ const uploadOrganizationContent = async ({ customPath, config, sendInvites = fal
                 groupsCreated: groupSummary.created,
                 groupsUpdated: groupSummary.updated,
                 groupsUnchanged: groupSummary.unchanged,
+                userAttributesCreated: userAttributeSummary.created,
+                userAttributesUpdated: userAttributeSummary.updated,
+                userAttributesUnchanged: userAttributeSummary.unchanged,
                 themesCreated: themeSummary.created,
                 themesUpdated: themeSummary.updated,
                 themesUnchanged: themeSummary.unchanged,

package/dist/handlers/organizationContent/userAttributes.d.ts

@@ -0,0 +1,7 @@
+import { type UserAttributeAsCode } from '@lightdash/common';
+import { type CodeResourceDefinition, type CodeResourceUploadSummary } from '../contentAsCode/resource';
+export declare const USER_ATTRIBUTE_CODE_RESOURCE: CodeResourceDefinition<UserAttributeAsCode>;
+export declare const formatUserAttributeUploadSummary: (summary: CodeResourceUploadSummary) => string;
+export declare const downloadUserAttributes: (organizationUuid: string, organizationContentPath: string) => Promise<number>;
+export declare const uploadUserAttributes: (organizationUuid: string, organizationContentPath: string) => Promise<CodeResourceUploadSummary>;
+//# sourceMappingURL=userAttributes.d.ts.map

package/dist/handlers/organizationContent/userAttributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userAttributes.d.ts","sourceRoot":"","sources":["../../../src/handlers/organizationContent/userAttributes.ts"],"names":[],"mappings":"AAAA,OAAO,EAIH,KAAK,mBAAmB,EAC3B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAGH,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EACjC,MAAM,2BAA2B,CAAC;AAGnC,eAAO,MAAM,4BAA4B,EAAE,sBAAsB,CAAC,mBAAmB,CAkBhF,CAAC;AAEN,eAAO,MAAM,gCAAgC,YAChC,yBAAyB,KACnC,MACmH,CAAC;AAEvH,eAAO,MAAM,sBAAsB,qBACb,MAAM,2BACC,MAAM,KAChC,OAAO,CAAC,MAAM,CAcX,CAAC;AAEP,eAAO,MAAM,oBAAoB,qBACX,MAAM,2BACC,MAAM,KAChC,OAAO,CAAC,yBAAyB,CAc9B,CAAC"}

package/dist/handlers/organizationContent/userAttributes.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadUserAttributes = exports.downloadUserAttributes = exports.formatUserAttributeUploadSummary = exports.USER_ATTRIBUTE_CODE_RESOURCE = void 0;
+const common_1 = require("@lightdash/common");
+const resource_1 = require("../contentAsCode/resource");
+const apiClient_1 = require("../dbt/apiClient");
+exports.USER_ATTRIBUTE_CODE_RESOURCE = {
+    kind: 'user_attribute',
+    displayLabel: 'user attribute',
+    identityLabel: 'name',
+    scope: 'organization',
+    folderName: 'user_attributes',
+    acceptedExtensions: ['.yml', '.yaml'],
+    fileName: {
+        strategy: 'uriEncodedIdentity',
+        fallbackPrefix: 'user-attribute',
+        extension: '.yml',
+    },
+    dependencies: ['user', 'group'],
+    identity: ({ name }) => name,
+    displayName: ({ name }) => name,
+    parse: common_1.parseUserAttributeAsCode,
+    sort: (a, b) => a.name.localeCompare(b.name),
+};
+const formatUserAttributeUploadSummary = (summary) => `${summary.created} created, ${summary.updated} updated, ${summary.unchanged} unchanged, ${summary.failed} failed`;
+exports.formatUserAttributeUploadSummary = formatUserAttributeUploadSummary;
+const downloadUserAttributes = async (organizationUuid, organizationContentPath) => (0, resource_1.downloadCodeResource)({
+    definition: exports.USER_ATTRIBUTE_CODE_RESOURCE,
+    basePath: organizationContentPath,
+    list: async () => {
+        const { userAttributes } = await (0, apiClient_1.lightdashApi)({
+            method: 'GET',
+            url: `/api/v2/orgs/${organizationUuid}/code/userAttributes`,
+            body: undefined,
+        });
+        return userAttributes;
+    },
+});
+exports.downloadUserAttributes = downloadUserAttributes;
+const uploadUserAttributes = async (organizationUuid, organizationContentPath) => (0, resource_1.uploadCodeResource)({
+    definition: exports.USER_ATTRIBUTE_CODE_RESOURCE,
+    basePath: organizationContentPath,
+    upsert: async (document) => {
+        const result = await (0, apiClient_1.lightdashApi)({
+            method: 'POST',
+            url: `/api/v2/orgs/${organizationUuid}/code/userAttributes`,
+            body: JSON.stringify(document),
+        });
+        return result.action;
+    },
+});
+exports.uploadUserAttributes = uploadUserAttributes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "2.270.0",
+  "version": "2.271.0",
   "description": "Lightdash CLI tool",
   "license": "MIT",
   "repository": {
@@ -22,8 +22,8 @@
     "@actions/core": "1.11.1",
     "@aws-sdk/credential-providers": "3.995.0",
     "@casl/ability": "6.8.0",
-    "@lightdash/common": "2.270.0",
-    "@lightdash/warehouses": "2.270.0",
+    "@lightdash/common": "2.271.0",
+    "@lightdash/warehouses": "2.271.0",
     "@sidvind/better-ajv-errors": "7.0.0",
     "@types/columnify": "1.5.1",
     "ajv": "8.18.0",