@lightdash/cli 0.3405.1 → 0.3406.1

package/dist/handlers/organizationContent/users.js

@@ -1,16 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.downloadUsers = exports.uploadUsers = exports.readUserFiles = exports.formatUserUploadSummary = exports.getUsersFolder = void 0;
+exports.downloadUsers = exports.uploadUsers = exports.readUserFiles = exports.formatUserUploadSummary = exports.getUsersFolder = exports.USER_CODE_RESOURCE = void 0;
 const tslib_1 = require("tslib");
 /* eslint-disable no-await-in-loop */
 const common_1 = require("@lightdash/common");
-const fs_1 = require("fs");
-const yaml = tslib_1.__importStar(require("js-yaml"));
-const groupBy_1 = tslib_1.__importDefault(require("lodash/groupBy"));
 const path = tslib_1.__importStar(require("path"));
+const resource_1 = require("../contentAsCode/resource");
 const apiClient_1 = require("../dbt/apiClient");
-const fileNames_1 = require("./fileNames");
-const getUsersFolder = (organizationContentPath) => path.join(organizationContentPath, 'users');
+exports.USER_CODE_RESOURCE = {
+    kind: 'user',
+    displayLabel: 'user',
+    identityLabel: 'email',
+    scope: 'organization',
+    folderName: 'users',
+    acceptedExtensions: ['.yml'],
+    fileName: {
+        strategy: 'normalizedDisplayName',
+        fallbackPrefix: 'user',
+        extension: '.yml',
+    },
+    dependencies: ['custom_role'],
+    identity: ({ email }) => email,
+    normalizeIdentity: (email) => email.toLowerCase(),
+    displayName: ({ email }) => email.toLowerCase(),
+    parse: common_1.parseUserAsCode,
+    sort: (left, right) => left.email.localeCompare(right.email),
+};
+const getUsersFolder = (organizationContentPath) => path.join(organizationContentPath, exports.USER_CODE_RESOURCE.folderName);
 exports.getUsersFolder = getUsersFolder;
 const formatUserUploadSummary = (summary) => {
     const invitationSummary = [
@@ -19,126 +35,49 @@ const formatUserUploadSummary = (summary) => {
             summary.skippedDisabled +
             summary.skippedValidInvite} invitation-skipped`,
     ];
-    return `${summary.created} created, ${summary.updated} updated, ${summary.unchanged} unchanged, ${summary.awaitingAuthentication} awaiting authentication, ${invitationSummary.join(', ')}, ${summary.failed} failed`;
+    return [
+        `${summary.created} created`,
+        `${summary.updated} updated`,
+        `${summary.unchanged} unchanged`,
+        `${summary.awaitingAuthentication} awaiting authentication`,
+        invitationSummary.join(', '),
+        `${summary.failed} failed`,
+    ].join(', ');
 };
 exports.formatUserUploadSummary = formatUserUploadSummary;
-const getUserEmail = (user) => {
-    if (typeof user !== 'object' || user === null || Array.isArray(user)) {
-        return undefined;
-    }
-    const { email } = user;
-    return typeof email === 'string' ? email.toLowerCase() : undefined;
-};
-const asUserAsCode = (user) => {
-    if (typeof user !== 'object' || user === null || Array.isArray(user)) {
-        return undefined;
-    }
-    const record = user;
-    if (typeof record.email !== 'string' ||
-        typeof record.disabled !== 'boolean' ||
-        typeof record.role !== 'object' ||
-        record.role === null ||
-        Array.isArray(record.role)) {
-        return undefined;
-    }
-    const role = record.role;
-    if ((role.type !== 'system' && role.type !== 'custom') ||
-        typeof role.name !== 'string') {
-        return undefined;
-    }
-    return user;
-};
-const readUserFileResults = async (organizationContentPath) => {
-    const folder = (0, exports.getUsersFolder)(organizationContentPath);
-    let entries;
-    try {
-        entries = await fs_1.promises.readdir(folder, { withFileTypes: true });
-    }
-    catch (error) {
-        if (error.code === 'ENOENT') {
-            return { userFiles: [], failures: [] };
-        }
-        throw error;
-    }
-    const files = entries
-        .filter((entry) => entry.isFile() && entry.name.endsWith('.yml'))
-        .sort((left, right) => left.name.localeCompare(right.name));
-    const results = await Promise.all(files.map(async (file) => {
-        const filePath = path.join(folder, file.name);
-        try {
-            return {
-                kind: 'user',
-                userFile: {
-                    filePath,
-                    user: yaml.load(await fs_1.promises.readFile(filePath, 'utf8')),
-                },
-            };
-        }
-        catch (error) {
-            return {
-                kind: 'failure',
-                failure: {
-                    message: `Unable to parse user file "${filePath}": ${(0, common_1.getErrorMessage)(error)}`,
-                },
-            };
-        }
-    }));
-    const parsedUserFiles = results.flatMap((result) => result.kind === 'user' ? [result.userFile] : []);
-    const failures = results.flatMap((result) => result.kind === 'failure' ? [result.failure] : []);
-    const emailFiles = parsedUserFiles.flatMap((userFile) => {
-        const email = getUserEmail(userFile.user);
-        return email === undefined ? [] : [{ email, userFile }];
-    });
-    const filesByEmail = (0, groupBy_1.default)(emailFiles, ({ email }) => email);
-    const duplicateEmails = new Set(Object.entries(filesByEmail)
-        .filter(([, matchingFiles]) => matchingFiles.length > 1)
-        .map(([email]) => email));
-    for (const duplicateEmail of [...duplicateEmails].sort()) {
-        for (const { userFile } of filesByEmail[duplicateEmail]) {
-            failures.push({
-                message: `Duplicate user email "${duplicateEmail}" in "${userFile.filePath}"`,
-            });
-        }
-    }
-    return {
-        userFiles: parsedUserFiles.filter(({ user }) => !duplicateEmails.has(getUserEmail(user) ?? '')),
-        failures,
-    };
-};
 const readUserFiles = async (organizationContentPath) => {
-    const { userFiles, failures } = await readUserFileResults(organizationContentPath);
-    if (failures.length > 0) {
-        throw new common_1.ParameterError(failures.map(({ message }) => message).join('\n'));
-    }
-    return userFiles.map(({ user }) => user);
+    const result = await (0, resource_1.readCodeResourceFiles)({
+        definition: exports.USER_CODE_RESOURCE,
+        basePath: organizationContentPath,
+    });
+    (0, resource_1.assertCodeResourceFilesValid)(result);
+    return result.files.map(({ document }) => document);
 };
 exports.readUserFiles = readUserFiles;
 const isSystemAdmin = (user) => user.role.type === 'system' &&
     user.role.name === common_1.OrganizationMemberRole.ADMIN;
 const orderUserFiles = (userFiles, currentUsers) => {
     const currentByEmail = new Map(currentUsers.map((user) => [user.email.toLowerCase(), user]));
-    return [...userFiles].sort((left, right) => {
-        const getPriority = (userFile) => {
-            const desired = asUserAsCode(userFile.user);
-            if (!desired)
-                return 1;
-            const current = currentByEmail.get(desired.email.toLowerCase());
-            if (isSystemAdmin(desired) && !desired.disabled)
-                return 0;
-            if (current &&
-                isSystemAdmin(current) &&
-                !current.disabled &&
-                (!isSystemAdmin(desired) || desired.disabled)) {
-                return 2;
-            }
-            return 1;
-        };
-        return (getPriority(left) - getPriority(right) ||
-            left.filePath.localeCompare(right.filePath));
-    });
+    const getPriority = ({ document: desired }) => {
+        const current = currentByEmail.get(desired.email.toLowerCase());
+        if (isSystemAdmin(desired) && !desired.disabled)
+            return 0;
+        if (current &&
+            isSystemAdmin(current) &&
+            !current.disabled &&
+            (!isSystemAdmin(desired) || desired.disabled)) {
+            return 2;
+        }
+        return 1;
+    };
+    return [...userFiles].sort((left, right) => getPriority(left) - getPriority(right) ||
+        left.filePath.localeCompare(right.filePath));
 };
 const uploadUsers = async (organizationUuid, organizationContentPath, sendInvites = false) => {
-    const { userFiles, failures } = await readUserFileResults(organizationContentPath);
+    const { files, failures } = await (0, resource_1.readCodeResourceFiles)({
+        definition: exports.USER_CODE_RESOURCE,
+        basePath: organizationContentPath,
+    });
     const summary = {
         created: 0,
         updated: 0,
@@ -151,21 +90,21 @@ const uploadUsers = async (organizationUuid, organizationContentPath, sendInvite
         failed: 0,
         failures,
     };
-    if (userFiles.length === 0) {
-        summary.failed = summary.failures.length;
+    if (files.length === 0) {
+        summary.failed = failures.length;
         return summary;
     }
     const { users: currentUsers } = await (0, apiClient_1.lightdashApi)({
         method: 'GET',
-        url: `/api/v2/orgs/${organizationUuid}/users/code`,
+        url: `/api/v2/orgs/${organizationUuid}/code/users`,
         body: undefined,
     });
-    for (const { filePath, user } of orderUserFiles(userFiles, currentUsers)) {
+    for (const { filePath, document } of orderUserFiles(files, currentUsers)) {
         try {
             const result = await (0, apiClient_1.lightdashApi)({
                 method: 'POST',
-                url: `/api/v2/orgs/${organizationUuid}/users/code${sendInvites ? '?sendInvite=true' : ''}`,
-                body: JSON.stringify(user),
+                url: `/api/v2/orgs/${organizationUuid}/code/users${sendInvites ? '?sendInvite=true' : ''}`,
+                body: JSON.stringify(document),
             });
             switch (result.action) {
                 case common_1.PromotionAction.CREATE:
@@ -178,7 +117,7 @@ const uploadUsers = async (organizationUuid, organizationContentPath, sendInvite
                     summary.unchanged += 1;
                     break;
                 default:
-                    throw new common_1.ParameterError(`Unsupported user promotion action: ${result.action}`);
+                    (0, common_1.assertUnreachable)(result.action, 'Unsupported user promotion action');
             }
             switch (result.lifecycle) {
                 case common_1.UserAsCodeLifecycleStatus.READY:
@@ -187,7 +126,7 @@ const uploadUsers = async (organizationUuid, organizationContentPath, sendInvite
                     summary.awaitingAuthentication += 1;
                     break;
                 default:
-                    return (0, common_1.assertUnreachable)(result.lifecycle, 'Unsupported user lifecycle status');
+                    (0, common_1.assertUnreachable)(result.lifecycle, 'Unsupported user lifecycle status');
             }
             switch (result.invitation) {
                 case common_1.UserAsCodeInvitationStatus.NOT_REQUESTED:
@@ -205,7 +144,7 @@ const uploadUsers = async (organizationUuid, organizationContentPath, sendInvite
                     summary.skippedValidInvite += 1;
                     break;
                 default:
-                    return (0, common_1.assertUnreachable)(result.invitation, 'Unsupported user invitation status');
+                    (0, common_1.assertUnreachable)(result.invitation, 'Unsupported user invitation status');
             }
         }
         catch (error) {
@@ -218,26 +157,16 @@ const uploadUsers = async (organizationUuid, organizationContentPath, sendInvite
     return summary;
 };
 exports.uploadUsers = uploadUsers;
-const downloadUsers = async (organizationUuid, organizationContentPath) => {
-    const { users } = await (0, apiClient_1.lightdashApi)({
-        method: 'GET',
-        url: `/api/v2/orgs/${organizationUuid}/users/code`,
-        body: undefined,
-    });
-    const folder = (0, exports.getUsersFolder)(organizationContentPath);
-    await fs_1.promises.mkdir(folder, { recursive: true });
-    const existingFiles = await fs_1.promises.readdir(folder, { withFileTypes: true });
-    await Promise.all(existingFiles
-        .filter((entry) => entry.isFile() && entry.name.endsWith('.yml'))
-        .map((entry) => fs_1.promises.unlink(path.join(folder, entry.name))));
-    const sortedUsers = [...users].sort((left, right) => left.email.localeCompare(right.email));
-    const filenames = (0, fileNames_1.getOrganizationContentFileNames)({
-        values: sortedUsers.map(({ email }) => email.toLowerCase()),
-        fallbackPrefix: 'user',
-    });
-    await Promise.all(sortedUsers.map(async (user, index) => {
-        await fs_1.promises.writeFile(path.join(folder, filenames[index]), yaml.dump(user, { quotingType: '"', sortKeys: true }));
-    }));
-    return sortedUsers.length;
-};
+const downloadUsers = async (organizationUuid, organizationContentPath) => (0, resource_1.downloadCodeResource)({
+    definition: exports.USER_CODE_RESOURCE,
+    basePath: organizationContentPath,
+    list: async () => {
+        const { users } = await (0, apiClient_1.lightdashApi)({
+            method: 'GET',
+            url: `/api/v2/orgs/${organizationUuid}/code/users`,
+            body: undefined,
+        });
+        return users;
+    },
+});
 exports.downloadUsers = downloadUsers;

package/dist/handlers/organizationContent/users.test.js

@@ -35,7 +35,7 @@ describe('users as code', () => {
         vitest_1.vi.restoreAllMocks();
         await fs_1.promises.rm(tmpDir, { recursive: true, force: true });
     });
-    it('downloads deterministic portable users and removes stale YAML', async () => {
+    it('downloads deterministic portable users and preserves unknown YAML', async () => {
         const folder = (0, users_1.getUsersFolder)(tmpDir);
         await fs_1.promises.mkdir(folder, { recursive: true });
         await fs_1.promises.writeFile(path.join(folder, 'stale.yml'), 'stale: true');
@@ -51,6 +51,7 @@ describe('users as code', () => {
         await expect((0, users_1.downloadUsers)('organization-uuid', tmpDir)).resolves.toBe(2);
         expect((await fs_1.promises.readdir(folder)).sort()).toStrictEqual([
             'a-example-com.yml',
+            'stale.yml',
             'z-example-com.yml',
         ]);
         expect(yaml.load(await fs_1.promises.readFile(path.join(folder, 'z-example-com.yml'), 'utf8'))).toStrictEqual({
@@ -93,7 +94,7 @@ describe('users as code', () => {
         });
         expect(apiClient_1.lightdashApi).toHaveBeenNthCalledWith(2, {
             method: 'POST',
-            url: '/api/v2/orgs/organization-uuid/users/code',
+            url: '/api/v2/orgs/organization-uuid/code/users',
             body: expect.any(String),
         });
     });
@@ -110,7 +111,7 @@ describe('users as code', () => {
         expect(summary.invited).toBe(1);
         expect(apiClient_1.lightdashApi).toHaveBeenNthCalledWith(2, {
             method: 'POST',
-            url: '/api/v2/orgs/organization-uuid/users/code?sendInvite=true',
+            url: '/api/v2/orgs/organization-uuid/code/users?sendInvite=true',
             body: expect.any(String),
         });
     });

package/dist/handlers/spacesAsCode.d.ts

@@ -10,7 +10,7 @@ export declare const validateSpaceIdentity: (parsed: unknown, filePath: string)
 export declare const assertUniqueSpacePaths: (files: SpaceCodeFile[]) => void;
 export declare const sortSpaceFilesParentFirst: (files: SpaceCodeFile[]) => SpaceCodeFile[];
 export declare const getUniqueExistingSpaceFilePathsBySlug: (baseDir: string) => Promise<Map<string, string[]>>;
-/** Writes first-class space YAML files returned by GET /spaces/code. */
+/** Writes first-class space YAML files returned by GET /code/spaces. */
 export declare const writeSpaceFiles: (spaces: SpaceAsCode[], projectName: string, customPath?: string, folderScheme?: FolderScheme, flatSpaceLayout?: FlatSpaceLayout, preserveExistingPolicy?: boolean) => Promise<void>;
 export declare const readSpaceFiles: (customPath?: string) => Promise<SpaceCodeFile[]>;
 /** Reads legacy identity fields without validating unrelated access policy. */

package/dist/handlers/spacesAsCode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"spacesAsCode.d.ts","sourceRoot":"","sources":["../../src/handlers/spacesAsCode.ts"],"names":[],"mappings":"AAEA,OAAO,EAUH,cAAc,EAId,KAAK,WAAW,EACnB,MAAM,mBAAmB,CAAC;AAW3B,KAAK,YAAY,GAAG,MAAM,GAAG,QAAQ,CAAC;AACtC,KAAK,eAAe,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEzC,MAAM,MAAM,aAAa,GAAG;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,WAAW,CAAC;CACtB,CAAC;AAyDF,eAAO,MAAM,qBAAqB,GAAI,QAAQ,WAAW,EAAE,KAAG,MAAM,EAiBnE,CAAC;AAuBF,eAAO,MAAM,qBAAqB,GAC9B,QAAQ,OAAO,EACf,UAAU,MAAM,KACjB,WAgMF,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,OAAO,aAAa,EAAE,KAAG,IAyB/D,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAClC,OAAO,aAAa,EAAE,KACvB,aAAa,EAQV,CAAC;AA4EP,eAAO,MAAM,qCAAqC,GAC9C,SAAS,MAAM,KAChB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAY/B,CAAC;AAyDF,wEAAwE;AACxE,eAAO,MAAM,eAAe,GACxB,QAAQ,WAAW,EAAE,EACrB,aAAa,MAAM,EACnB,aAAa,MAAM,EACnB,eAAc,YAAqB,EACnC,kBAAiB,eAA0B,EAC3C,yBAAwB,OAAe,KACxC,OAAO,CAAC,IAAI,CAoHd,CAAC;AAEF,eAAO,MAAM,cAAc,GACvB,aAAa,MAAM,KACpB,OAAO,CAAC,aAAa,EAAE,CA0BzB,CAAC;AAEF,+EAA+E;AAC/E,eAAO,MAAM,cAAc,GACvB,aAAa,MAAM,KACpB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA8BhC,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,OAAO,aAAa,EAAE,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CACG,CAAC;AAqBhF,eAAO,MAAM,8BAA8B,GACvC,SAAS,MAAM,KAChB,cAIF,CAAC;AAEF,eAAO,MAAM,0BAA0B,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,KACS,CAAC;AAU/E,eAAO,MAAM,uBAAuB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,KACS,CAAC;AAE5E,eAAO,MAAM,8BAA8B,GACvC,OAAO,OAAO,EACd,YAAY,OAAO,GAAG,SAAS,KAChC,OAAgE,CAAC;AAEpE,eAAO,MAAM,cAAc,GACvB,WAAW,MAAM,EACjB,aAAa,MAAM,EACnB,aAAa,MAAM,EACnB,SAAQ,OAAe,EACvB,aAAY,OAAe,KAC5B,OAAO,CAAC,MAAM,CAmDhB,CAAC;AAIF,eAAO,MAAM,4BAA4B,GACrC,SAAS,MAAM,KAChB,cAIF,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,KACS,CAAC;AAE7E,eAAO,MAAM,gBAAgB,GAAI,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SAY/D,CAAC;AAEF,eAAO,MAAM,YAAY,GACrB,WAAW,MAAM,EACjB,OAAO,aAAa,EAAE,EACtB,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC/B,iBAAiB,OAAO,EACxB,mBAAmB,OAAO,KAC3B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAgGhC,CAAC"}
+{"version":3,"file":"spacesAsCode.d.ts","sourceRoot":"","sources":["../../src/handlers/spacesAsCode.ts"],"names":[],"mappings":"AAEA,OAAO,EASH,cAAc,EAId,KAAK,WAAW,EACnB,MAAM,mBAAmB,CAAC;AAgB3B,KAAK,YAAY,GAAG,MAAM,GAAG,QAAQ,CAAC;AACtC,KAAK,eAAe,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEzC,MAAM,MAAM,aAAa,GAAG;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,WAAW,CAAC;CACtB,CAAC;AAsDF,eAAO,MAAM,qBAAqB,GAAI,QAAQ,WAAW,EAAE,KAAG,MAAM,EAS9D,CAAC;AAuBP,eAAO,MAAM,qBAAqB,GAC9B,QAAQ,OAAO,EACf,UAAU,MAAM,KACjB,WAgMF,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,OAAO,aAAa,EAAE,KAAG,IAyB/D,CAAC;AAEF,eAAO,MAAM,yBAAyB,GAClC,OAAO,aAAa,EAAE,KACvB,aAAa,EAQV,CAAC;AA4EP,eAAO,MAAM,qCAAqC,GAC9C,SAAS,MAAM,KAChB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAY/B,CAAC;AAyDF,wEAAwE;AACxE,eAAO,MAAM,eAAe,GACxB,QAAQ,WAAW,EAAE,EACrB,aAAa,MAAM,EACnB,aAAa,MAAM,EACnB,eAAc,YAAqB,EACnC,kBAAiB,eAA0B,EAC3C,yBAAwB,OAAe,KACxC,OAAO,CAAC,IAAI,CAoHd,CAAC;AAEF,eAAO,MAAM,cAAc,GACvB,aAAa,MAAM,KACpB,OAAO,CAAC,aAAa,EAAE,CA0BzB,CAAC;AAEF,+EAA+E;AAC/E,eAAO,MAAM,cAAc,GACvB,aAAa,MAAM,KACpB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA8BhC,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,OAAO,aAAa,EAAE,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CACG,CAAC;AAqBhF,eAAO,MAAM,8BAA8B,GACvC,SAAS,MAAM,KAChB,cAIF,CAAC;AAEF,eAAO,MAAM,0BAA0B,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,KACS,CAAC;AAU/E,eAAO,MAAM,uBAAuB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,KACS,CAAC;AAE5E,eAAO,MAAM,8BAA8B,GACvC,OAAO,OAAO,EACd,YAAY,OAAO,GAAG,SAAS,KAChC,OAAgE,CAAC;AAEpE,eAAO,MAAM,cAAc,GACvB,WAAW,MAAM,EACjB,aAAa,MAAM,EACnB,aAAa,MAAM,EACnB,SAAQ,OAAe,EACvB,aAAY,OAAe,KAC5B,OAAO,CAAC,MAAM,CAmDhB,CAAC;AAIF,eAAO,MAAM,4BAA4B,GACrC,SAAS,MAAM,KAChB,cAIF,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,KACS,CAAC;AAE7E,eAAO,MAAM,gBAAgB,GAAI,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,SAY/D,CAAC;AAEF,eAAO,MAAM,YAAY,GACrB,WAAW,MAAM,EACjB,OAAO,aAAa,EAAE,EACtB,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC/B,iBAAiB,OAAO,EACxB,mBAAmB,OAAO,KAC3B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAgGhC,CAAC"}

package/dist/handlers/spacesAsCode.js

@@ -5,16 +5,16 @@ const tslib_1 = require("tslib");
 /* eslint-disable no-await-in-loop */
 /* eslint-disable no-param-reassign */
 const common_1 = require("@lightdash/common");
-const crypto_1 = require("crypto");
 const fs_1 = require("fs");
 const yaml = tslib_1.__importStar(require("js-yaml"));
 const path = tslib_1.__importStar(require("path"));
 const globalState_1 = tslib_1.__importDefault(require("../globalState"));
 const styles = tslib_1.__importStar(require("../styles"));
 const appsDownload_1 = require("./apps/appsDownload");
+const fileNames_1 = require("./contentAsCode/fileNames");
 const contentAsCodePaths_1 = require("./contentAsCodePaths");
 const apiClient_1 = require("./dbt/apiClient");
-const SPACE_FILENAME_MAX_LENGTH = 200;
+const SPACE_FILENAME_MAX_LENGTH = fileNames_1.CODE_FILENAME_MAX_STEM_LENGTH;
 const SPACE_FILENAME_HASH_LENGTH = 8;
 const isSpaceIdentity = (value) => typeof value === 'object' &&
     value !== null &&
@@ -40,27 +40,22 @@ const hasRootSpaceFile = async (baseDir) => {
         throw error;
     }
 };
-const getStableSpaceHash = (value, length = SPACE_FILENAME_HASH_LENGTH) => (0, crypto_1.createHash)('sha256').update(value).digest('hex').slice(0, length);
-const getSpaceFilenameBase = (space) => {
-    const normalizedName = space.spaceName
-        .normalize('NFKD')
-        .replace(/[\u0300-\u036f]/g, '');
-    const base = /[a-z0-9]/i.test(normalizedName)
-        ? (0, common_1.generateSlug)(normalizedName)
-        : `space-${getStableSpaceHash(space.slug)}`;
-    return base.slice(0, SPACE_FILENAME_MAX_LENGTH);
-};
-const getFlatSpaceFileNames = (spaces) => {
-    const bases = spaces.map(getSpaceFilenameBase);
-    const counts = bases.reduce((result, base) => result.set(base, (result.get(base) ?? 0) + 1), new Map());
-    return spaces.map((space, index) => {
-        const base = bases[index];
-        if ((counts.get(base) ?? 0) === 1)
-            return `${base}.space.yml`;
-        const suffix = `-${getStableSpaceHash(space.slug)}`;
-        return `${base.slice(0, SPACE_FILENAME_MAX_LENGTH - suffix.length)}${suffix}.space.yml`;
-    });
-};
+const getStableSpaceHash = (value, length = SPACE_FILENAME_HASH_LENGTH) => (0, fileNames_1.getStableCodeHash)(value, length);
+const getSpaceFilenameBase = (space) => (0, fileNames_1.getContentFileNameStem)({
+    value: space.spaceName,
+    fallbackPrefix: 'space',
+    fallbackHashValue: space.slug,
+    maxLength: SPACE_FILENAME_MAX_LENGTH,
+});
+const getFlatSpaceFileNames = (spaces) => (0, fileNames_1.allocateContentFileNames)({
+    items: spaces.map((space) => ({
+        identity: space.slug,
+        displayName: space.spaceName,
+    })),
+    fallbackPrefix: 'space',
+    extension: '.space.yml',
+    maxStemLength: SPACE_FILENAME_MAX_LENGTH,
+});
 exports.getFlatSpaceFileNames = getFlatSpaceFileNames;
 const assertKnownKeys = (value, allowedKeys, field, filePath) => {
     const unknownKeys = Object.keys(value).filter((key) => !allowedKeys.includes(key));
@@ -309,7 +304,7 @@ const allocateSpaceFileNames = async (spaces, outputDir, preferredFileNames) =>
         return fileName;
     });
 };
-/** Writes first-class space YAML files returned by GET /spaces/code. */
+/** Writes first-class space YAML files returned by GET /code/spaces. */
 const writeSpaceFiles = async (spaces, projectName, customPath, folderScheme = 'flat', flatSpaceLayout = 'folder', preserveExistingPolicy = false) => {
     const baseDir = (0, contentAsCodePaths_1.getDownloadFolder)(customPath);
     if (spaces.length === 0)
@@ -493,7 +488,7 @@ const downloadSpaces = async (projectId, projectName, customPath, nested = false
         try {
             results = await (0, apiClient_1.lightdashApi)({
                 method: 'GET',
-                url: `/api/v1/projects/${projectId}/spaces/code`,
+                url: `/api/v1/projects/${projectId}/code/spaces`,
                 body: undefined,
             });
         }
@@ -565,7 +560,7 @@ const upsertSpaces = async (projectId, files, changes, skipSpaceCreate, publicSp
                 });
                 const result = await (0, apiClient_1.lightdashApi)({
                     method: 'POST',
-                    url: `/api/v1/projects/${projectId}/spaces/code?${params.toString()}`,
+                    url: `/api/v1/projects/${projectId}/code/spaces?${params.toString()}`,
                     body: JSON.stringify(space),
                 });
                 const action = getSpacePromoteAction(result.action);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/cli",
-  "version": "0.3405.1",
+  "version": "0.3406.1",
   "description": "Lightdash CLI tool",
   "license": "MIT",
   "repository": {
@@ -41,8 +41,8 @@
     "unique-names-generator": "4.7.1",
     "uuid": "11.1.1",
     "yaml": "2.8.3",
-    "@lightdash/common": "0.3405.1",
-    "@lightdash/warehouses": "0.3405.1"
+    "@lightdash/common": "0.3406.1",
+    "@lightdash/warehouses": "0.3406.1"
   },
   "devDependencies": {
     "@types/inquirer": "8.2.4",