@keeper-security/keeper-sdk-javascript 0.1.0

package/dist/src/folders/deleteFolder.js

@@ -0,0 +1,237 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rmdir = exports.resolveRmdirPatternsToFolderUids = exports.deleteFolder = exports.buildFolderDeleteObject = void 0;
+const keeperapi_1 = require("@keeper-security/keeperapi");
+const utils_1 = require("../utils");
+const listFolder_1 = require("./listFolder");
+const changeDirectory_1 = require("./changeDirectory");
+const folderHelpers_1 = require("./folderHelpers");
+const getFolder_1 = require("./getFolder");
+function folderKindOfUid(storage, uid) {
+    if (storage.getByUid(folderHelpers_1.FolderKind.UserFolder, uid))
+        return folderHelpers_1.FolderKind.UserFolder;
+    if (storage.getByUid(folderHelpers_1.FolderKind.SharedFolder, uid))
+        return folderHelpers_1.FolderKind.SharedFolder;
+    if (storage.getByUid(folderHelpers_1.FolderKind.SharedFolderFolder, uid))
+        return folderHelpers_1.FolderKind.SharedFolderFolder;
+    return folderHelpers_1.FolderKind.UserFolder;
+}
+async function listFolderChildrenFolders(storage, parentUid) {
+    const result = await (0, listFolder_1.listFolder)(storage, {
+        folderUid: parentUid === null ? undefined : parentUid,
+        showFolders: true,
+        showRecords: false,
+    });
+    return result.folders;
+}
+function folderDisplayName(storage, uid) {
+    const userFolder = storage.getByUid(folderHelpers_1.FolderKind.UserFolder, uid);
+    if (userFolder)
+        return (0, folderHelpers_1.userFolderName)(userFolder);
+    const sharedFolder = storage.getByUid(folderHelpers_1.FolderKind.SharedFolder, uid);
+    if (sharedFolder)
+        return (0, folderHelpers_1.sharedFolderName)(sharedFolder);
+    const sharedFolderFolder = storage.getByUid(folderHelpers_1.FolderKind.SharedFolderFolder, uid);
+    if (sharedFolderFolder)
+        return (0, folderHelpers_1.sharedFolderFolderName)(sharedFolderFolder);
+    return uid;
+}
+async function buildFolderDeleteObject(storage, folderUid) {
+    const userFolder = storage.getByUid(folderHelpers_1.FolderKind.UserFolder, folderUid);
+    if (userFolder) {
+        const parentUid = await (0, changeDirectory_1.findParentFolderUid)(storage, folderUid);
+        const deleteObject = {
+            delete_resolution: folderHelpers_1.DeleteResolution.Unlink,
+            object_uid: folderUid,
+            object_type: folderHelpers_1.FolderKind.UserFolder,
+            from_type: folderHelpers_1.FolderKind.UserFolder,
+        };
+        if (parentUid) {
+            deleteObject.from_uid = parentUid;
+            deleteObject.from_type = folderKindOfUid(storage, parentUid);
+        }
+        else {
+            deleteObject.from_uid = '';
+        }
+        return deleteObject;
+    }
+    const sharedFolder = storage.getByUid(folderHelpers_1.FolderKind.SharedFolder, folderUid);
+    if (sharedFolder) {
+        const parentUid = await (0, changeDirectory_1.findParentFolderUid)(storage, folderUid);
+        const deleteObject = {
+            delete_resolution: folderHelpers_1.DeleteResolution.Unlink,
+            object_uid: folderUid,
+            object_type: folderHelpers_1.FolderKind.SharedFolder,
+            from_type: folderHelpers_1.FolderKind.UserFolder,
+        };
+        if (parentUid) {
+            deleteObject.from_uid = parentUid;
+            deleteObject.from_type = folderKindOfUid(storage, parentUid);
+        }
+        else {
+            deleteObject.from_uid = '';
+        }
+        return deleteObject;
+    }
+    const sharedFolderFolder = storage.getByUid(folderHelpers_1.FolderKind.SharedFolderFolder, folderUid);
+    if (sharedFolderFolder) {
+        const parentUid = await (0, changeDirectory_1.findParentFolderUid)(storage, folderUid);
+        const deleteObject = {
+            delete_resolution: folderHelpers_1.DeleteResolution.Unlink,
+            object_uid: folderUid,
+            object_type: folderHelpers_1.FolderKind.SharedFolderFolder,
+            from_type: folderHelpers_1.FolderKind.SharedFolder,
+        };
+        if (parentUid) {
+            deleteObject.from_uid = parentUid;
+            deleteObject.from_type = folderKindOfUid(storage, parentUid);
+        }
+        else {
+            deleteObject.from_uid = sharedFolderFolder.sharedFolderUid;
+            deleteObject.from_type = folderHelpers_1.FolderKind.SharedFolder;
+        }
+        return deleteObject;
+    }
+    return null;
+}
+exports.buildFolderDeleteObject = buildFolderDeleteObject;
+async function buildDeleteObjectForFolderRef(storage, ref) {
+    const trimmed = ref.trim();
+    if (!trimmed)
+        return null;
+    const direct = await buildFolderDeleteObject(storage, trimmed);
+    if (direct)
+        return direct;
+    const found = (0, getFolder_1.findFolder)(storage, trimmed);
+    if (!found)
+        return null;
+    return buildFolderDeleteObject(storage, found.folder.uid);
+}
+async function deleteFolder(auth, storage, folderRefs, confirm) {
+    const objects = [];
+    for (const ref of folderRefs) {
+        const deleteObject = await buildDeleteObjectForFolderRef(storage, ref);
+        if (deleteObject)
+            objects.push(deleteObject);
+    }
+    if (objects.length === 0) {
+        throw new utils_1.KeeperSdkError('No folders found to delete (not a folder UID or name).', 'delete_nothing');
+    }
+    const targetUids = objects.map((deleteObject) => deleteObject.object_uid).join(', ');
+    let preResp;
+    try {
+        preResp = await auth.executeRestCommand((0, keeperapi_1.preDeleteCommand)({ objects }));
+    }
+    catch (err) {
+        return {
+            success: false,
+            message: `pre_delete failed for [${targetUids}]: ${(0, utils_1.extractErrorMessage)(err)}`,
+        };
+    }
+    const inner = preResp.pre_delete_response;
+    const token = inner === null || inner === void 0 ? void 0 : inner.pre_delete_token;
+    if (!token) {
+        const reason = preResp.message ||
+            preResp.result_code ||
+            `pre_delete failed for [${targetUids}]: server did not return a pre_delete_token`;
+        return {
+            success: false,
+            message: reason,
+        };
+    }
+    if (confirm) {
+        const wouldDelete = inner === null || inner === void 0 ? void 0 : inner.would_delete;
+        const summaryItems = wouldDelete === null || wouldDelete === void 0 ? void 0 : wouldDelete.deletion_summary;
+        if (Array.isArray(summaryItems) && summaryItems.length > 0) {
+            const summary = summaryItems.join('\n');
+            const confirmed = await confirm(summary);
+            if (!confirmed) {
+                return { success: false, cancelled: true, message: 'Cancelled.' };
+            }
+        }
+    }
+    try {
+        await auth.executeRestCommand((0, keeperapi_1.recordDeleteCommand)({ pre_delete_token: token }));
+    }
+    catch (err) {
+        return {
+            success: false,
+            message: `record_delete failed for [${targetUids}]: ${(0, utils_1.extractErrorMessage)(err)}`,
+        };
+    }
+    return { success: true };
+}
+exports.deleteFolder = deleteFolder;
+async function resolveRmdirPatternsToFolderUids(storage, session, pattern) {
+    const matchedUids = new Set();
+    const trimmedPattern = pattern.trim();
+    if (!trimmedPattern)
+        return matchedUids;
+    const { folderUid: baseUid, remaining } = await (0, changeDirectory_1.tryResolvePath)(storage, session, trimmedPattern);
+    const remainingPattern = remaining.trim();
+    if (!remainingPattern) {
+        if (baseUid !== null) {
+            matchedUids.add(baseUid);
+        }
+        return matchedUids;
+    }
+    const children = await listFolderChildrenFolders(storage, baseUid);
+    const exactChild = children.find((child) => child.uid === remainingPattern);
+    if (exactChild) {
+        matchedUids.add(exactChild.uid);
+        return matchedUids;
+    }
+    const matcher = (0, folderHelpers_1.globToRegex)(remainingPattern);
+    for (const child of children) {
+        if (matcher.test(child.name.trim())) {
+            matchedUids.add(child.uid);
+        }
+    }
+    return matchedUids;
+}
+exports.resolveRmdirPatternsToFolderUids = resolveRmdirPatternsToFolderUids;
+async function dedupeNestedFolderDeletes(storage, folderUids) {
+    for (const folderUid of [...folderUids]) {
+        let current = folderUid;
+        while (true) {
+            const parentUid = await (0, changeDirectory_1.findParentFolderUid)(storage, current);
+            if (!parentUid)
+                break;
+            if (folderUids.has(parentUid)) {
+                folderUids.delete(folderUid);
+                break;
+            }
+            current = parentUid;
+        }
+    }
+}
+async function rmdir(auth, storage, session, patterns, options = {}) {
+    const { force = false, quiet = false, confirm } = options;
+    if (!force && !confirm) {
+        throw new utils_1.KeeperSdkError('Confirmation is required: pass `confirm` or set `force: true`.', 'rmdir_confirm_required');
+    }
+    const folderUids = new Set();
+    for (const pattern of patterns) {
+        const trimmedPattern = pattern.trim();
+        if (!trimmedPattern)
+            continue;
+        const resolved = await resolveRmdirPatternsToFolderUids(storage, session, trimmedPattern);
+        for (const matchedUid of resolved) {
+            folderUids.add(matchedUid);
+        }
+    }
+    if (folderUids.size === 0) {
+        throw new utils_1.KeeperSdkError('Enter name of an existing folder.', 'rmdir_no_match');
+    }
+    await dedupeNestedFolderDeletes(storage, folderUids);
+    const sortedNames = [...folderUids]
+        .map((uid) => folderDisplayName(storage, uid))
+        .sort((nameA, nameB) => nameA.localeCompare(nameB, undefined, { sensitivity: 'base' }));
+    if (!quiet || !force) {
+        utils_1.logger.info(`\nThe following folder(s) will be removed:\n${sortedNames.join(', ')}\n`);
+    }
+    const confirmFn = force ? undefined : confirm;
+    return deleteFolder(auth, storage, [...folderUids], confirmFn);
+}
+exports.rmdir = rmdir;
+//# sourceMappingURL=deleteFolder.js.map

package/dist/src/folders/deleteFolder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteFolder.js","sourceRoot":"","sources":["../../../src/folders/deleteFolder.ts"],"names":[],"mappings":";;;AACA,0DAAkF;AAGlF,oCAAsE;AACtE,6CAAyC;AAEzC,uDAAgG;AAChG,mDAOwB;AACxB,2CAAwC;AAcxC,SAAS,eAAe,CAAC,OAAwB,EAAE,GAAW;IAC1D,IAAI,OAAO,CAAC,QAAQ,CAAc,0BAAU,CAAC,UAAU,EAAE,GAAG,CAAC;QAAE,OAAO,0BAAU,CAAC,UAAU,CAAA;IAC3F,IAAI,OAAO,CAAC,QAAQ,CAAgB,0BAAU,CAAC,YAAY,EAAE,GAAG,CAAC;QAAE,OAAO,0BAAU,CAAC,YAAY,CAAA;IACjG,IAAI,OAAO,CAAC,QAAQ,CAAsB,0BAAU,CAAC,kBAAkB,EAAE,GAAG,CAAC;QAAE,OAAO,0BAAU,CAAC,kBAAkB,CAAA;IACnH,OAAO,0BAAU,CAAC,UAAU,CAAA;AAChC,CAAC;AAED,KAAK,UAAU,yBAAyB,CACpC,OAAwB,EACxB,SAAwB;IAExB,MAAM,MAAM,GAAG,MAAM,IAAA,uBAAU,EAAC,OAAO,EAAE;QACrC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;QACrD,WAAW,EAAE,IAAI;QACjB,WAAW,EAAE,KAAK;KACrB,CAAC,CAAA;IACF,OAAO,MAAM,CAAC,OAAO,CAAA;AACzB,CAAC;AAED,SAAS,iBAAiB,CAAC,OAAwB,EAAE,GAAW;IAC5D,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAc,0BAAU,CAAC,UAAU,EAAE,GAAG,CAAC,CAAA;IAC5E,IAAI,UAAU;QAAE,OAAO,IAAA,8BAAc,EAAC,UAAU,CAAC,CAAA;IACjD,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAgB,0BAAU,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;IAClF,IAAI,YAAY;QAAE,OAAO,IAAA,gCAAgB,EAAC,YAAY,CAAC,CAAA;IACvD,MAAM,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAsB,0BAAU,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAA;IACpG,IAAI,kBAAkB;QAAE,OAAO,IAAA,sCAAsB,EAAC,kBAAkB,CAAC,CAAA;IACzE,OAAO,GAAG,CAAA;AACd,CAAC;AAEM,KAAK,UAAU,uBAAuB,CACzC,OAAwB,EACxB,SAAiB;IAEjB,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAc,0BAAU,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;IAClF,IAAI,UAAU,EAAE;QACZ,MAAM,SAAS,GAAG,MAAM,IAAA,qCAAmB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAA;QAC/D,MAAM,YAAY,GAAiB;YAC/B,iBAAiB,EAAE,gCAAgB,CAAC,MAAM;YAC1C,UAAU,EAAE,SAAS;YACrB,WAAW,EAAE,0BAAU,CAAC,UAAU;YAClC,SAAS,EAAE,0BAAU,CAAC,UAAU;SACnC,CAAA;QACD,IAAI,SAAS,EAAE;YACX,YAAY,CAAC,QAAQ,GAAG,SAAS,CAAA;YACjC,YAAY,CAAC,SAAS,GAAG,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;SAC/D;aAAM;YACH,YAAY,CAAC,QAAQ,GAAG,EAAE,CAAA;SAC7B;QACD,OAAO,YAAY,CAAA;KACtB;IACD,MAAM,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAgB,0BAAU,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;IACxF,IAAI,YAAY,EAAE;QACd,MAAM,SAAS,GAAG,MAAM,IAAA,qCAAmB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAA;QAC/D,MAAM,YAAY,GAAiB;YAC/B,iBAAiB,EAAE,gCAAgB,CAAC,MAAM;YAC1C,UAAU,EAAE,SAAS;YACrB,WAAW,EAAE,0BAAU,CAAC,YAAY;YACpC,SAAS,EAAE,0BAAU,CAAC,UAAU;SACnC,CAAA;QACD,IAAI,SAAS,EAAE;YACX,YAAY,CAAC,QAAQ,GAAG,SAAS,CAAA;YACjC,YAAY,CAAC,SAAS,GAAG,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;SAC/D;aAAM;YACH,YAAY,CAAC,QAAQ,GAAG,EAAE,CAAA;SAC7B;QACD,OAAO,YAAY,CAAA;KACtB;IACD,MAAM,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAsB,0BAAU,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAA;IAC1G,IAAI,kBAAkB,EAAE;QACpB,MAAM,SAAS,GAAG,MAAM,IAAA,qCAAmB,EAAC,OAAO,EAAE,SAAS,CAAC,CAAA;QAC/D,MAAM,YAAY,GAAiB;YAC/B,iBAAiB,EAAE,gCAAgB,CAAC,MAAM;YAC1C,UAAU,EAAE,SAAS;YACrB,WAAW,EAAE,0BAAU,CAAC,kBAAkB;YAC1C,SAAS,EAAE,0BAAU,CAAC,YAAY;SACrC,CAAA;QACD,IAAI,SAAS,EAAE;YACX,YAAY,CAAC,QAAQ,GAAG,SAAS,CAAA;YACjC,YAAY,CAAC,SAAS,GAAG,eAAe,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;SAC/D;aAAM;YACH,YAAY,CAAC,QAAQ,GAAG,kBAAkB,CAAC,eAAe,CAAA;YAC1D,YAAY,CAAC,SAAS,GAAG,0BAAU,CAAC,YAAY,CAAA;SACnD;QACD,OAAO,YAAY,CAAA;KACtB;IACD,OAAO,IAAI,CAAA;AACf,CAAC;AAzDD,0DAyDC;AAED,KAAK,UAAU,6BAA6B,CACxC,OAAwB,EACxB,GAAW;IAEX,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAA;IAC1B,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAA;IAEzB,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAC9D,IAAI,MAAM;QAAE,OAAO,MAAM,CAAA;IAEzB,MAAM,KAAK,GAAG,IAAA,sBAAU,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAC1C,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAA;IACvB,OAAO,uBAAuB,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;AAC7D,CAAC;AAEM,KAAK,UAAU,YAAY,CAC9B,IAAU,EACV,OAAwB,EACxB,UAAoB,EACpB,OAAyD;IAEzD,MAAM,OAAO,GAAmB,EAAE,CAAA;IAClC,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE;QAC1B,MAAM,YAAY,GAAG,MAAM,6BAA6B,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;QACtE,IAAI,YAAY;YAAE,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;KAC/C;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QACtB,MAAM,IAAI,sBAAc,CACpB,wDAAwD,EACxD,gBAAgB,CACnB,CAAA;KACJ;IAED,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAEpF,IAAI,OAAgC,CAAA;IACpC,IAAI;QACA,OAAO,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAA,4BAAgB,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;KACzE;IAAC,OAAO,GAAG,EAAE;QACV,OAAO;YACH,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,0BAA0B,UAAU,MAAM,IAAA,2BAAmB,EAAC,GAAG,CAAC,EAAE;SAChF,CAAA;KACJ;IAED,MAAM,KAAK,GAAG,OAAO,CAAC,mBAAmB,CAAA;IACzC,MAAM,KAAK,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,gBAAgB,CAAA;IACrC,IAAI,CAAC,KAAK,EAAE;QACR,MAAM,MAAM,GACR,OAAO,CAAC,OAAO;YACf,OAAO,CAAC,WAAW;YACnB,0BAA0B,UAAU,6CAA6C,CAAA;QACrF,OAAO;YACH,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,MAAM;SAClB,CAAA;KACJ;IAED,IAAI,OAAO,EAAE;QACT,MAAM,WAAW,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,CAAA;QACvC,MAAM,YAAY,GAAG,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,gBAAgB,CAAA;QAClD,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YACxD,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;YACvC,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;YACxC,IAAI,CAAC,SAAS,EAAE;gBACZ,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,YAAY,EAAE,CAAA;aACpE;SACJ;KACJ;IAED,IAAI;QACA,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAA,+BAAmB,EAAC,EAAE,gBAAgB,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;KAClF;IAAC,OAAO,GAAG,EAAE;QACV,OAAO;YACH,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,6BAA6B,UAAU,MAAM,IAAA,2BAAmB,EAAC,GAAG,CAAC,EAAE;SACnF,CAAA;KACJ;IAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;AAC5B,CAAC;AAjED,oCAiEC;AAEM,KAAK,UAAU,gCAAgC,CAClD,OAAwB,EACxB,OAA2B,EAC3B,OAAe;IAEf,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAA;IACrC,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,EAAE,CAAA;IACrC,IAAI,CAAC,cAAc;QAAE,OAAO,WAAW,CAAA;IAEvC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,MAAM,IAAA,gCAAc,EAAC,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;IAChG,MAAM,gBAAgB,GAAG,SAAS,CAAC,IAAI,EAAE,CAAA;IAEzC,IAAI,CAAC,gBAAgB,EAAE;QACnB,IAAI,OAAO,KAAK,IAAI,EAAE;YAClB,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;SAC3B;QACD,OAAO,WAAW,CAAA;KACrB;IAED,MAAM,QAAQ,GAAG,MAAM,yBAAyB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IAClE,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,gBAAgB,CAAC,CAAA;IAC3E,IAAI,UAAU,EAAE;QACZ,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;QAC/B,OAAO,WAAW,CAAA;KACrB;IAED,MAAM,OAAO,GAAG,IAAA,2BAAW,EAAC,gBAAgB,CAAC,CAAA;IAC7C,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE;QAC1B,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE;YACjC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;SAC7B;KACJ;IACD,OAAO,WAAW,CAAA;AACtB,CAAC;AAjCD,4EAiCC;AAED,KAAK,UAAU,yBAAyB,CAAC,OAAwB,EAAE,UAAuB;IACtF,KAAK,MAAM,SAAS,IAAI,CAAC,GAAG,UAAU,CAAC,EAAE;QACrC,IAAI,OAAO,GAAG,SAAS,CAAA;QACvB,OAAO,IAAI,EAAE;YACT,MAAM,SAAS,GAAG,MAAM,IAAA,qCAAmB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAC7D,IAAI,CAAC,SAAS;gBAAE,MAAK;YACrB,IAAI,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;gBAC3B,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;gBAC5B,MAAK;aACR;YACD,OAAO,GAAG,SAAS,CAAA;SACtB;KACJ;AACL,CAAC;AAEM,KAAK,UAAU,KAAK,CACvB,IAAU,EACV,OAAwB,EACxB,OAA2B,EAC3B,QAAkB,EAClB,UAAwB,EAAE;IAE1B,MAAM,EAAE,KAAK,GAAG,KAAK,EAAE,KAAK,GAAG,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;IACzD,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,EAAE;QACpB,MAAM,IAAI,sBAAc,CACpB,gEAAgE,EAChE,wBAAwB,CAC3B,CAAA;KACJ;IACD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAA;IAEpC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;QAC5B,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,EAAE,CAAA;QACrC,IAAI,CAAC,cAAc;YAAE,SAAQ;QAC7B,MAAM,QAAQ,GAAG,MAAM,gCAAgC,CAAC,OAAO,EAAE,OAAO,EAAE,cAAc,CAAC,CAAA;QACzF,KAAK,MAAM,UAAU,IAAI,QAAQ,EAAE;YAC/B,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;SAC7B;KACJ;IAED,IAAI,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE;QACvB,MAAM,IAAI,sBAAc,CAAC,mCAAmC,EAAE,gBAAgB,CAAC,CAAA;KAClF;IAED,MAAM,yBAAyB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IAEpD,MAAM,WAAW,GAAG,CAAC,GAAG,UAAU,CAAC;SAC9B,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,iBAAiB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;SAC7C,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;IAE3F,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE;QAClB,cAAM,CAAC,IAAI,CAAC,+CAA+C,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;KACzF;IAED,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAA;IAE7C,OAAO,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,GAAG,UAAU,CAAC,EAAE,SAAS,CAAC,CAAA;AAClE,CAAC;AA1CD,sBA0CC"}

package/dist/src/folders/folderHelpers.d.ts

@@ -0,0 +1,48 @@
+import type { DSharedFolder, DSharedFolderFolder, DUserFolder } from '@keeper-security/keeperapi';
+import type { InMemoryStorage } from '../storage/InMemoryStorage';
+export declare enum FolderKind {
+    UserFolder = "user_folder",
+    SharedFolder = "shared_folder",
+    SharedFolderFolder = "shared_folder_folder"
+}
+export declare enum ParentFolderKind {
+    VirtualRoot = "virtual_root",
+    UserFolder = "user_folder",
+    SharedFolder = "shared_folder",
+    SharedFolderFolder = "shared_folder_folder"
+}
+export declare enum FolderObjectType {
+    Folder = "folder",
+    SharedFolder = "shared_folder"
+}
+export declare enum DeleteResolution {
+    Unlink = "unlink"
+}
+export declare enum DeleteObjectType {
+    Record = "record",
+    UserFolder = "user_folder",
+    SharedFolder = "shared_folder",
+    SharedFolderFolder = "shared_folder_folder"
+}
+export declare enum FolderResultStatus {
+    Success = "success",
+    Invited = "invited",
+    Unknown = "unknown"
+}
+export declare enum VaultObjectKind {
+    Record = "record",
+    Metadata = "metadata",
+    NonSharedData = "non_shared_data",
+    Team = "team",
+    User = "user",
+    SharedFolderUser = "shared_folder_user",
+    SharedFolderTeam = "shared_folder_team",
+    SharedFolderRecord = "shared_folder_record"
+}
+export type FolderKindOrLiteral = FolderKind | `${FolderKind}`;
+export declare function folderKindFromString(value: string | undefined | null): FolderKind | undefined;
+export declare function userFolderName(folder: DUserFolder): string;
+export declare function sharedFolderFolderName(folder: DSharedFolderFolder): string;
+export declare function sharedFolderName(folder: DSharedFolder): string;
+export declare function globToRegex(pattern: string): RegExp;
+export declare function getUserFolderParentMap(storage: InMemoryStorage): Promise<Map<string, string>>;

package/dist/src/folders/folderHelpers.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserFolderParentMap = exports.globToRegex = exports.sharedFolderName = exports.sharedFolderFolderName = exports.userFolderName = exports.folderKindFromString = exports.VaultObjectKind = exports.FolderResultStatus = exports.DeleteObjectType = exports.DeleteResolution = exports.FolderObjectType = exports.ParentFolderKind = exports.FolderKind = void 0;
+const utils_1 = require("../utils");
+var FolderKind;
+(function (FolderKind) {
+    FolderKind["UserFolder"] = "user_folder";
+    FolderKind["SharedFolder"] = "shared_folder";
+    FolderKind["SharedFolderFolder"] = "shared_folder_folder";
+})(FolderKind = exports.FolderKind || (exports.FolderKind = {}));
+var ParentFolderKind;
+(function (ParentFolderKind) {
+    ParentFolderKind["VirtualRoot"] = "virtual_root";
+    ParentFolderKind["UserFolder"] = "user_folder";
+    ParentFolderKind["SharedFolder"] = "shared_folder";
+    ParentFolderKind["SharedFolderFolder"] = "shared_folder_folder";
+})(ParentFolderKind = exports.ParentFolderKind || (exports.ParentFolderKind = {}));
+var FolderObjectType;
+(function (FolderObjectType) {
+    FolderObjectType["Folder"] = "folder";
+    FolderObjectType["SharedFolder"] = "shared_folder";
+})(FolderObjectType = exports.FolderObjectType || (exports.FolderObjectType = {}));
+var DeleteResolution;
+(function (DeleteResolution) {
+    DeleteResolution["Unlink"] = "unlink";
+})(DeleteResolution = exports.DeleteResolution || (exports.DeleteResolution = {}));
+var DeleteObjectType;
+(function (DeleteObjectType) {
+    DeleteObjectType["Record"] = "record";
+    DeleteObjectType["UserFolder"] = "user_folder";
+    DeleteObjectType["SharedFolder"] = "shared_folder";
+    DeleteObjectType["SharedFolderFolder"] = "shared_folder_folder";
+})(DeleteObjectType = exports.DeleteObjectType || (exports.DeleteObjectType = {}));
+var FolderResultStatus;
+(function (FolderResultStatus) {
+    FolderResultStatus["Success"] = "success";
+    FolderResultStatus["Invited"] = "invited";
+    FolderResultStatus["Unknown"] = "unknown";
+})(FolderResultStatus = exports.FolderResultStatus || (exports.FolderResultStatus = {}));
+var VaultObjectKind;
+(function (VaultObjectKind) {
+    VaultObjectKind["Record"] = "record";
+    VaultObjectKind["Metadata"] = "metadata";
+    VaultObjectKind["NonSharedData"] = "non_shared_data";
+    VaultObjectKind["Team"] = "team";
+    VaultObjectKind["User"] = "user";
+    VaultObjectKind["SharedFolderUser"] = "shared_folder_user";
+    VaultObjectKind["SharedFolderTeam"] = "shared_folder_team";
+    VaultObjectKind["SharedFolderRecord"] = "shared_folder_record";
+})(VaultObjectKind = exports.VaultObjectKind || (exports.VaultObjectKind = {}));
+function folderKindFromString(value) {
+    if (!value)
+        return undefined;
+    switch (value) {
+        case FolderKind.UserFolder:
+            return FolderKind.UserFolder;
+        case FolderKind.SharedFolder:
+            return FolderKind.SharedFolder;
+        case FolderKind.SharedFolderFolder:
+            return FolderKind.SharedFolderFolder;
+        default:
+            return undefined;
+    }
+}
+exports.folderKindFromString = folderKindFromString;
+function userFolderName(folder) {
+    const data = folder.data;
+    return ((data === null || data === void 0 ? void 0 : data.title) || (data === null || data === void 0 ? void 0 : data.name) || folder.uid).trim() || folder.uid;
+}
+exports.userFolderName = userFolderName;
+function sharedFolderFolderName(folder) {
+    const data = folder.data;
+    return ((data === null || data === void 0 ? void 0 : data.title) || (data === null || data === void 0 ? void 0 : data.name) || folder.uid).trim() || folder.uid;
+}
+exports.sharedFolderFolderName = sharedFolderFolderName;
+function sharedFolderName(folder) {
+    return (folder.name || folder.uid).trim() || folder.uid;
+}
+exports.sharedFolderName = sharedFolderName;
+function globToRegex(pattern) {
+    const escapedPattern = (0, utils_1.escapeRegExp)(pattern);
+    const regexBody = escapedPattern.replace(/\*/g, '.*').replace(/\?/g, '.');
+    return new RegExp(`^${regexBody}$`, 'i');
+}
+exports.globToRegex = globToRegex;
+async function getUserFolderParentMap(storage) {
+    const userFolders = storage.getAll(FolderKind.UserFolder);
+    const childToParent = new Map();
+    for (const userFolder of userFolders) {
+        const dependencies = (await storage.getDependencies(userFolder.uid)) || [];
+        for (const dependency of dependencies) {
+            if (dependency.kind === FolderKind.UserFolder) {
+                childToParent.set(dependency.uid, userFolder.uid);
+            }
+        }
+    }
+    return childToParent;
+}
+exports.getUserFolderParentMap = getUserFolderParentMap;
+//# sourceMappingURL=folderHelpers.js.map

package/dist/src/folders/folderHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"folderHelpers.js","sourceRoot":"","sources":["../../../src/folders/folderHelpers.ts"],"names":[],"mappings":";;;AAEA,oCAAuC;AAEvC,IAAY,UAIX;AAJD,WAAY,UAAU;IAClB,wCAA0B,CAAA;IAC1B,4CAA8B,CAAA;IAC9B,yDAA2C,CAAA;AAC/C,CAAC,EAJW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAIrB;AAED,IAAY,gBAKX;AALD,WAAY,gBAAgB;IACxB,gDAA4B,CAAA;IAC5B,8CAA0B,CAAA;IAC1B,kDAA8B,CAAA;IAC9B,+DAA2C,CAAA;AAC/C,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IACxB,qCAAiB,CAAA;IACjB,kDAA8B,CAAA;AAClC,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAED,IAAY,gBAEX;AAFD,WAAY,gBAAgB;IACxB,qCAAiB,CAAA;AACrB,CAAC,EAFW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAE3B;AAED,IAAY,gBAKX;AALD,WAAY,gBAAgB;IACxB,qCAAiB,CAAA;IACjB,8CAA0B,CAAA;IAC1B,kDAA8B,CAAA;IAC9B,+DAA2C,CAAA;AAC/C,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B;AAED,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;AACvB,CAAC,EAJW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAI7B;AAED,IAAY,eASX;AATD,WAAY,eAAe;IACvB,oCAAiB,CAAA;IACjB,wCAAqB,CAAA;IACrB,oDAAiC,CAAA;IACjC,gCAAa,CAAA;IACb,gCAAa,CAAA;IACb,0DAAuC,CAAA;IACvC,0DAAuC,CAAA;IACvC,8DAA2C,CAAA;AAC/C,CAAC,EATW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAS1B;AAID,SAAgB,oBAAoB,CAAC,KAAgC;IACjE,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAA;IAC5B,QAAQ,KAAK,EAAE;QACX,KAAK,UAAU,CAAC,UAAU;YACtB,OAAO,UAAU,CAAC,UAAU,CAAA;QAChC,KAAK,UAAU,CAAC,YAAY;YACxB,OAAO,UAAU,CAAC,YAAY,CAAA;QAClC,KAAK,UAAU,CAAC,kBAAkB;YAC9B,OAAO,UAAU,CAAC,kBAAkB,CAAA;QACxC;YACI,OAAO,SAAS,CAAA;KACvB;AACL,CAAC;AAZD,oDAYC;AAED,SAAgB,cAAc,CAAC,MAAmB;IAC9C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAqD,CAAA;IACzE,OAAO,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,MAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,GAAG,CAAA;AACzE,CAAC;AAHD,wCAGC;AAED,SAAgB,sBAAsB,CAAC,MAA2B;IAC9D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAqD,CAAA;IACzE,OAAO,CAAC,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,MAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,IAAI,CAAA,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,GAAG,CAAA;AACzE,CAAC;AAHD,wDAGC;AAED,SAAgB,gBAAgB,CAAC,MAAqB;IAClD,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,MAAM,CAAC,GAAG,CAAA;AAC3D,CAAC;AAFD,4CAEC;AAED,SAAgB,WAAW,CAAC,OAAe;IACvC,MAAM,cAAc,GAAG,IAAA,oBAAY,EAAC,OAAO,CAAC,CAAA;IAC5C,MAAM,SAAS,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;IACzE,OAAO,IAAI,MAAM,CAAC,IAAI,SAAS,GAAG,EAAE,GAAG,CAAC,CAAA;AAC5C,CAAC;AAJD,kCAIC;AAEM,KAAK,UAAU,sBAAsB,CAAC,OAAwB;IACjE,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAc,UAAU,CAAC,UAAU,CAAC,CAAA;IACtE,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkB,CAAA;IAC/C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QAClC,MAAM,YAAY,GAAG,CAAC,MAAM,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;QAC1E,KAAK,MAAM,UAAU,IAAI,YAAY,EAAE;YACnC,IAAI,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,UAAU,EAAE;gBAC3C,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,GAAG,CAAC,CAAA;aACpD;SACJ;KACJ;IACD,OAAO,aAAa,CAAA;AACxB,CAAC;AAZD,wDAYC"}

package/dist/src/folders/folderTree.d.ts

@@ -0,0 +1,29 @@
+import { InMemoryStorage } from '../storage/InMemoryStorage';
+import { type VaultFolderSession } from './changeDirectory';
+export type FolderTreeBuildOptions = {
+    folderPath?: string | null;
+    verbose?: boolean;
+    showRecords?: boolean;
+    showShares?: boolean;
+    hideSharesKey?: boolean;
+    title?: string | null;
+};
+export type FolderTreeNode = {
+    displayName: string;
+    children: FolderTreeNode[];
+    permissions?: {
+        display: string;
+    }[];
+    records?: {
+        display: string;
+    }[];
+};
+export type FolderTreeResult = {
+    title?: string | null;
+    root: FolderTreeNode;
+};
+export declare function userPermissionToText(manageUsers: boolean, manageRecords: boolean): string;
+export declare function recordPermissionToText(canEdit: boolean, canShare: boolean): string;
+export declare function buildFolderTree(storage: InMemoryStorage, session: VaultFolderSession, options?: FolderTreeBuildOptions): Promise<FolderTreeResult>;
+export declare function renderFolderTreeAscii(result: FolderTreeResult): string;
+export declare function folderTreeAscii(storage: InMemoryStorage, session: VaultFolderSession, options?: FolderTreeBuildOptions): Promise<string>;