Nsf-list and nsf-get commands

KeeperSdk/package.json

@@ -21,7 +21,7 @@
         "prepublishOnly": "npm run build"
     },
     "dependencies": {
-        "@keeper-security/keeperapi": "17.1.3",
+        "@keeper-security/keeperapi": "17.2.6",
         "ts-node": "^10.7.0",
         "typescript": "^4.6.3"
     },

KeeperSdk/src/auth/ConsoleLogin.ts

@@ -342,6 +342,8 @@ async function syncVault(vault: KeeperVault): Promise<KeeperVault> {
     logger.info('Syncing vault...')
     await withSuppressedOutput(() => vault.sync())
     logger.info(`Vault synced. ${vault.getSummary().recordCount} records loaded.\n`)
+    // CLI examples use REST only; close push websocket to avoid async key errors during prompts.
+    vault.releasePushConnection()
     return vault
 }
 

KeeperSdk/src/index.ts

@@ -25,9 +25,12 @@ export {
     extractResultCode,
     SdkDefaults,
     AuthDefaults,
+    NsfErrorCode,
     ResultCodes,
     AuthErrorCode,
     SessionErrorCode,
+    ValidationErrorCode,
+    RoleErrorCode,
     TeamErrorCode,
     UserErrorCode,
     KEEPER_PUBLIC_HOSTS,
@@ -40,6 +43,7 @@ export {
     EMAIL_PATTERN,
     EMAIL_LIST_SEPARATOR_PATTERN,
     isValidEmail,
+    resolveSearchPattern,
 } from './utils'
 export type { ILogger, Nullable, Optional, DeepPartial, Immutable } from './utils'
 
@@ -205,6 +209,9 @@ export type {
     EnterpriseTeamUserLink,
     EnterpriseRoleUserLink,
     EnterpriseRoleTeamLink,
+    EnterpriseRolePrivilegeLink,
+    EnterpriseRoleManagedNodeLink,
+    EnterpriseRoleEnforcementLink,
     EnterpriseQueuedTeamRecord,
     EnterpriseQueuedTeamUserLink,
     EnterpriseUserAliasLink,
@@ -217,6 +224,66 @@ export type {
     NodePathOptions,
 } from './teams/enterpriseData'
 
+export {
+    listRoles,
+    formatRolesTable,
+    renderRolesAsciiTable,
+    RoleColumn,
+    SUPPORTED_ROLE_COLUMNS,
+    DEFAULT_ROLE_COLUMNS,
+    ALL_COLUMNS_WILDCARD,
+    viewRole,
+    formatRoleView,
+    roleViewTable,
+    RoleManager,
+    addRoles,
+    formatAddRoleResult,
+    renderAddRoleAsciiTable,
+    AddRoleStatus,
+    AddRoleSkipReason,
+    updateRoles,
+    formatUpdateRoleResult,
+    renderUpdateRoleAsciiTable,
+    UpdateRoleStatus,
+    deleteRoles,
+    formatDeleteRoleResult,
+    renderDeleteRoleAsciiTable,
+    DeleteRoleStatus,
+} from './roles'
+export type {
+    ListRolesOptions,
+    ListRoleRow,
+    RoleColumnInput,
+    FormattedRolesTable,
+    FormatRolesTableOptions,
+    RoleView,
+    RoleTeamInfo,
+    RoleUserInfo,
+    RoleManagedNodeInfo,
+    RoleEnforcementInfo,
+    FormatRoleViewOptions,
+    FormattedRoleViewTable,
+    FormattedManagedNodePrivilegeTable,
+    RoleViewTableRow,
+    AddRoleInput,
+    AddRoleResult,
+    AddRoleItemResult,
+    AddRoleConfirm,
+    AddRoleConflictPrompt,
+    FormattedAddRoleTable,
+    UpdateRoleInput,
+    UpdateRoleResult,
+    UpdateRoleItemResult,
+    FormattedUpdateRoleTable,
+    DeleteRoleInput,
+    DeleteRoleResult,
+    DeleteRoleItemResult,
+    FormattedDeleteRoleTable,
+    RoleToggleInput,
+    RoleToggle,
+    EnforcementPair,
+} from './roles'
+
 export { viewTeam, formatTeamView, teamViewTable } from './teams/viewTeam'
 export type {
     TeamView,
@@ -377,6 +444,59 @@ export {
 
 export { UserManager } from './users/UserManager'
 
+export {
+    ROOT_FOLDER_UID,
+    KeeperDriveKind,
+    NsfItemType,
+    formatAccessRoleType,
+    formatAccessType,
+    normalizeParentUid,
+    isRootFolderUid,
+    getKeeperDriveFolders,
+    getKeeperDriveRecords,
+    findRecordFolderLocation,
+    buildFolderPath,
+    isSensitiveFieldType,
+    ListNsfFormat,
+    listNestedShareFolders,
+    formatListNsfTable,
+    renderListNsfAsciiTable,
+    formatListNsfCsv,
+    formatListNsfJson,
+    formatListNsfOutput,
+    GetNsfFormat,
+    resolveNsfFolder,
+    resolveNsfRecord,
+    getNestedShareFolder,
+    formatNsfFolderDetail,
+    formatNsfRecordDetail,
+    formatNsfDetail,
+    linkNestedShareRecord,
+    NsfRemoveOperation,
+    removeNestedShareRecords,
+    formatRemoveNsfPreview,
+    NestedShareFolderManager,
+} from './nestedShareFolders'
+export type {
+    ListNsfFormatInput,
+    ListNsfOptions,
+    ListNsfRow,
+    FormattedListNsfTable,
+    GetNsfFormatInput,
+    GetNsfOptions,
+    GetNsfResult,
+    NsfFolderView,
+    NsfRecordView,
+    NsfFolderPermission,
+    NsfFolderAccessRow,
+    NsfRecordPermission,
+    LinkNsfRecordResult,
+    NsfRemoveOperationInput,
+    RemoveNsfRecordInput,
+    NsfRemovePreviewItem,
+    RemoveNsfRecordResult,
+} from './nestedShareFolders'
+
 export type {
     DRecord,
     DRecordMetadata,

KeeperSdk/src/nestedShareFolders/NestedShareFolderManager.ts

@@ -0,0 +1,97 @@
+import type { Auth } from '@keeper-security/keeperapi'
+import type { InMemoryStorage } from '../storage/InMemoryStorage'
+import { KeeperSdkError, ResultCodes } from '../utils'
+import {
+    formatListNsfOutput,
+    formatListNsfTable,
+    listNestedShareFolders,
+    renderListNsfAsciiTable,
+    type FormattedListNsfTable,
+    type ListNsfFormatInput,
+    type ListNsfOptions,
+    type ListNsfRow,
+} from './listNsf'
+import {
+    formatNsfDetail as renderNsfDetail,
+    formatNsfFolderDetail as renderNsfFolderDetail,
+    formatNsfRecordDetail as renderNsfRecordDetail,
+    getNestedShareFolder,
+    type GetNsfOptions,
+    type GetNsfResult,
+    type NsfFolderView,
+    type NsfRecordView,
+} from './getNsf'
+import { linkNestedShareRecord, type LinkNsfRecordResult } from './linkNsfRecord'
+import {
+    formatRemoveNsfPreview,
+    removeNestedShareRecords,
+    type RemoveNsfRecordInput,
+    type RemoveNsfRecordResult,
+} from './removeNsfRecord'
+
+export type AuthProvider = () => Auth
+
+export class NestedShareFolderManager {
+    private readonly storage: InMemoryStorage
+    private readonly authProvider: AuthProvider
+
+    constructor(storage: InMemoryStorage, authProvider: AuthProvider) {
+        this.storage = storage
+        this.authProvider = authProvider
+    }
+
+    private requireAuth(): Auth {
+        const auth = this.authProvider()
+        if (!auth?.sessionToken) {
+            throw new KeeperSdkError('Not logged in. Call login() first.', ResultCodes.NOT_LOGGED_IN)
+        }
+        return auth
+    }
+
+    public listNestedShareFolders(options: ListNsfOptions = {}): ListNsfRow[] {
+        return listNestedShareFolders(this.storage, options)
+    }
+
+    public formatListNsfTable(rows: ListNsfRow[], options: { columnWidth?: number } = {}): FormattedListNsfTable {
+        return formatListNsfTable(rows, options)
+    }
+
+    public renderListNsfAsciiTable(table: FormattedListNsfTable, options: { minColWidth?: number } = {}): string {
+        return renderListNsfAsciiTable(table, options)
+    }
+
+    public formatListNsfOutput(rows: ListNsfRow[], format: ListNsfFormatInput = 'table'): string {
+        return formatListNsfOutput(rows, format)
+    }
+
+    public async getNestedShareFolder(identifier: string, options: GetNsfOptions = {}): Promise<GetNsfResult> {
+        return getNestedShareFolder(this.storage, this.requireAuth(), identifier, options)
+    }
+
+    public formatNsfDetail(result: GetNsfResult, verbose = false): string {
+        return renderNsfDetail(result, verbose)
+    }
+
+    public formatNsfFolderDetail(view: NsfFolderView, verbose = false): string {
+        return renderNsfFolderDetail(view, verbose)
+    }
+
+    public formatNsfRecordDetail(view: NsfRecordView, verbose = false): string {
+        return renderNsfRecordDetail(view, verbose)
+    }
+
+    public async linkNestedShareRecord(
+        recordIdentifier: string,
+        folderIdentifier: string
+    ): Promise<LinkNsfRecordResult> {
+        return linkNestedShareRecord(this.storage, this.requireAuth(), recordIdentifier, folderIdentifier)
+    }
+
+    public async removeNestedShareRecords(input: RemoveNsfRecordInput): Promise<RemoveNsfRecordResult> {
+        return removeNestedShareRecords(this.storage, this.requireAuth(), input)
+    }
+
+    public formatRemoveNsfPreview(preview: RemoveNsfRecordResult['preview']): string {
+        return formatRemoveNsfPreview(preview)
+    }
+}