NSF sharing, permissions , shortcut and transfer functionalities (#210)

Author: sgaddala-ks

KeeperSdk/package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@keeper-security/keeper-sdk-javascript",
-    "version": "1.1.0",
+    "version": "1.1.1",
     "description": "High-level wrapper for Keeper Security JavaScript SDK",
     "repository": {
         "type": "git",
@@ -21,7 +21,7 @@
         "prepublishOnly": "npm run build"
     },
     "dependencies": {
-        "@keeper-security/keeperapi": "17.2.7",
+        "@keeper-security/keeperapi": "^18.0.4",
         "ts-node": "^10.7.0",
         "typescript": "^4.6.3"
     },

KeeperSdk/package.json

@@ -557,6 +557,50 @@ export {
     resolveNsfFieldValue,
     clearNsfRecordTypeCache,
     checkRecordEditPermission,
+    updateNestedShareFolder,
+    shareNestedShareFolder,
+    shareNestedShareRecord,
+    formatNsfRecordSharePlan,
+    formatNsfRecordShareResults,
+    formatNsfFolderShareResults,
+    parseShareExpiration,
+    parseShareExpirationValue,
+    validateShareExpirationTimestamp,
+    isShareExpirationNoop,
+    fetchNsfTeamPublicKeys,
+    encryptNsfFolderKeyForTeam,
+    resolveNsfShareRecipient,
+    MIN_SHARE_EXPIRATION_MS,
+    TeamGetKeysResponseKeyType,
+    getNsfRecordShortcuts,
+    listNsfShortcuts,
+    keepNsfShortcut,
+    formatNsfShortcutOutput,
+    formatKeepNsfShortcutPlan,
+    transferNestedShareRecords,
+    formatTransferNestedShareRecordResults,
+    NSF_RECORD_PERMISSION_ROLES,
+    NSFShareRoleName,
+    NsfShareCommandName,
+    NSF_SHARE_EXPIRATION_NEVER,
+    NsfFolderShareAction,
+    NsfFolderShareActionTaken,
+    NsfRecordShareAction,
+    NsfRecordShareActionTaken,
+    NsfRecordPermissionAction,
+    NsfResultStatus,
+    NsfTransferApiStatus,
+    NsfPermissionFailureCode,
+    collectNsfRecordUidsInFolder,
+    updateNestedShareRecordPermissions,
+    buildNsfRecordPermissionPlan,
+    formatNsfRecordPermissionPlan,
+    formatNsfRecordPermissionRequestHeader,
+    formatNsfRecordPermissionFailures,
+    resolveNsfRoleName,
+    getNsfAccessRoleLabel,
+    normalizeNsfRecordPermissionRole,
+    getFolderPermissionsForRole,
     NestedShareFolderManager,
 } from './nestedShareFolders'
 export type {
@@ -607,6 +651,36 @@ export type {
     FolderCreatePayload,
     ParsedNsfFields,
     RecordFieldEntry,
+    UpdateNsfFolderInput,
+    UpdateNsfFolderResult,
+    NsfFolderShareActionInput,
+    ShareNestedShareFolderInput,
+    ShareNestedShareFolderResult,
+    NsfFolderShareResultItem,
+    NsfRecordShareActionInput,
+    ShareNestedShareRecordInput,
+    ShareNestedShareRecordResult,
+    NsfRecordSharePlanItem,
+    NsfRecordShareResultItem,
+    NsfShortcutRow,
+    ListNsfShortcutsOptions,
+    KeepNsfShortcutInput,
+    KeepNsfShortcutPlanItem,
+    KeepNsfShortcutResult,
+    KeepNsfShortcutResultItem,
+    TransferNestedShareRecordInput,
+    TransferNestedShareRecordResult,
+    TransferNestedShareRecordResultItem,
+    NsfRecordPermissionRole,
+    NsfRecordPermissionActionInput,
+    UpdateNsfRecordPermissionInput,
+    UpdateNsfRecordPermissionResult,
+    NsfRecordPermissionPlan,
+    NsfRecordPermissionPlanItem,
+    NsfRecordPermissionFailure,
+    ParseShareExpirationInput,
+    NsfTeamPublicKeys,
+    NsfResolvedShareRecipient,
 } from './nestedShareFolders'
 
 export type {

KeeperSdk/src/index.ts

@@ -10,6 +10,11 @@ import { removeNestedShareFolders } from './removeNsfFolder'
 import { getNestedShareRecordDetails } from './getNsfRecordDetails'
 import { updateNestedShareRecords, updateNestedShareRecord } from './updateNsfRecord'
 import { addNestedShareRecord, addNestedShareRecords } from './addNsfRecord'
+import { shareNestedShareFolder, shareNestedShareRecord } from './nsfShare'
+import { listNsfShortcuts, keepNsfShortcut } from './nsfShortcut'
+import { transferNestedShareRecords } from './nsfTransferRecord'
+import { updateNestedShareRecordPermissions } from './nsfRecordPermission'
+import { updateNestedShareFolder } from './updateNsfFolder'
 import type {
     AddNsfRecordInput,
     AddNsfRecordResult,
@@ -19,18 +24,32 @@ import type {
     GetNsfResult,
     GetNsfRecordDetailsInput,
     GetNsfRecordDetailsResult,
+    KeepNsfShortcutInput,
+    KeepNsfShortcutResult,
     LinkNsfRecordResult,
     ListNsfOptions,
     ListNsfRow,
+    ListNsfShortcutsOptions,
     MkdirNsfInput,
     MkdirNsfResult,
+    NsfShortcutRow,
     RemoveNsfFolderInput,
     RemoveNsfFolderResult,
     RemoveNsfRecordInput,
     RemoveNsfRecordResult,
+    ShareNestedShareFolderInput,
+    ShareNestedShareFolderResult,
+    ShareNestedShareRecordInput,
+    ShareNestedShareRecordResult,
+    TransferNestedShareRecordInput,
+    TransferNestedShareRecordResult,
+    UpdateNsfFolderInput,
+    UpdateNsfFolderResult,
     UpdateNsfRecordInput,
     UpdateNsfRecordItemInput,
     UpdateNsfRecordsInput,
+    UpdateNsfRecordPermissionInput,
+    UpdateNsfRecordPermissionResult,
     UpdateNsfRecordResult,
     UpdateNsfRecordResultItem,
 } from './nsfTypes'
@@ -104,4 +123,43 @@ export class NestedShareFolderManager {
     public async addNestedShareRecord(input: AddNsfRecordInput): Promise<AddNsfRecordResult> {
         return addNestedShareRecord(this.storage, this.requireAuth(), input)
     }
+
+    public async updateNestedShareFolder(input: UpdateNsfFolderInput): Promise<UpdateNsfFolderResult> {
+        return updateNestedShareFolder(this.storage, this.requireAuth(), input)
+    }
+
+    public async shareNestedShareFolder(
+        input: ShareNestedShareFolderInput
+    ): Promise<ShareNestedShareFolderResult> {
+        return shareNestedShareFolder(this.storage, this.requireAuth(), input)
+    }
+
+    public async shareNestedShareRecord(
+        input: ShareNestedShareRecordInput
+    ): Promise<ShareNestedShareRecordResult> {
+        return shareNestedShareRecord(this.storage, this.requireAuth(), input)
+    }
+
+    public listNsfShortcuts(options: ListNsfShortcutsOptions = {}): NsfShortcutRow[] {
+        return listNsfShortcuts(this.storage, options)
+    }
+
+    public async keepNsfShortcut(
+        input: KeepNsfShortcutInput,
+        defaultFolderUid?: string
+    ): Promise<KeepNsfShortcutResult> {
+        return keepNsfShortcut(this.storage, this.requireAuth(), input, defaultFolderUid)
+    }
+
+    public async transferNestedShareRecords(
+        input: TransferNestedShareRecordInput
+    ): Promise<TransferNestedShareRecordResult> {
+        return transferNestedShareRecords(this.storage, this.requireAuth(), input)
+    }
+
+    public async updateNestedShareRecordPermissions(
+        input: UpdateNsfRecordPermissionInput
+    ): Promise<UpdateNsfRecordPermissionResult> {
+        return updateNestedShareRecordPermissions(this.storage, this.requireAuth(), input)
+    }
 }

KeeperSdk/src/nestedShareFolders/NestedShareFolderManager.ts

@@ -27,6 +27,13 @@ export {
     checkFolderDeletePermission,
     parseNsfPath,
     findExistingChildFolder,
+    resolveNsfRoleName,
+    getNsfAccessRoleLabel,
+    normalizeNsfRecordPermissionRole,
+    parseShareExpiration,
+    parseShareExpirationValue,
+    validateShareExpirationTimestamp,
+    isShareExpirationNoop,
 } from './nsfHelpers'
 
 export {
@@ -58,6 +65,14 @@ export {
     NsfRemoveOperation,
     NsfRemoveFolderOperation,
     GetNsfRecordDetailsFormat,
+    NsfFolderShareAction,
+    NsfFolderShareActionTaken,
+    NsfRecordShareAction,
+    NsfRecordShareActionTaken,
+    NsfRecordPermissionAction,
+    NsfResultStatus,
+    NsfTransferApiStatus,
+    NsfPermissionFailureCode,
     NSF_ACCESS_ROLE_LABELS,
     resolveRecordPermissionRole,
     toNsfAccessRoleLabel,
@@ -108,8 +123,45 @@ export type {
     GetNsfRecordDetailsInput,
     GetNsfRecordDetailsResult,
     NsfRecordDetailsItem,
+    NsfFolderShareActionInput,
+    ShareNestedShareFolderInput,
+    ShareNestedShareFolderResult,
+    NsfFolderShareResultItem,
+    NsfRecordShareActionInput,
+    ShareNestedShareRecordInput,
+    ShareNestedShareRecordResult,
+    NsfRecordSharePlanItem,
+    NsfRecordShareResultItem,
+    NsfRecordPermissionActionInput,
+    UpdateNsfRecordPermissionInput,
+    UpdateNsfRecordPermissionResult,
+    NsfRecordPermissionPlan,
+    NsfRecordPermissionPlanItem,
+    NsfRecordPermissionFailure,
+    NsfShortcutRow,
+    ListNsfShortcutsOptions,
+    KeepNsfShortcutInput,
+    KeepNsfShortcutPlanItem,
+    KeepNsfShortcutResult,
+    KeepNsfShortcutResultItem,
+    TransferNestedShareRecordInput,
+    TransferNestedShareRecordResult,
+    TransferNestedShareRecordResultItem,
+    UpdateNsfFolderInput,
+    UpdateNsfFolderResult,
+    ParseShareExpirationInput,
+    NsfTeamPublicKeys,
+    NsfResolvedShareRecipient,
 } from './nsfTypes'
 
+export {
+    fetchNsfTeamPublicKeys,
+    encryptNsfFolderKeyForTeam,
+    resolveNsfShareRecipient,
+} from './nsfTeamShare'
+
+export type { UserShareKeys } from './nsfShareKeys'
+
 export { linkNestedShareRecord } from './linkNsfRecord'
 
 export {
@@ -119,7 +171,15 @@ export {
 } from './removeNsfRecord'
 
 export { mkdirNestedShareFolder } from './mkdirNsf'
-export { NSF_FOLDER_COLORS, NSF_MAX_RECORD_BATCH } from './nsfConstants'
+export {
+    NSF_FOLDER_COLORS,
+    NSF_MAX_RECORD_BATCH,
+    MIN_SHARE_EXPIRATION_MS,
+    NSF_SHARE_EXPIRATION_NEVER,
+    TeamGetKeysResponseKeyType,
+    NSFShareRoleName,
+    NsfShareCommandName,
+} from './nsfConstants'
 export type { NsfFolderColor } from './nsfConstants'
 
 export {
@@ -149,3 +209,41 @@ export {
 } from './nsfRecordData'
 
 export { NestedShareFolderManager } from './NestedShareFolderManager'
+
+export {
+    shareNestedShareFolder,
+    shareNestedShareRecord,
+    formatNsfRecordSharePlan,
+    formatNsfRecordShareResults,
+    formatNsfFolderShareResults,
+} from './nsfShare'
+
+export {
+    collectNsfRecordUidsInFolder,
+    updateNestedShareRecordPermissions,
+    buildNsfRecordPermissionPlan,
+    formatNsfRecordPermissionPlan,
+    formatNsfRecordPermissionRequestHeader,
+    formatNsfRecordPermissionFailures,
+} from './nsfRecordPermission'
+
+export {
+    getNsfRecordShortcuts,
+    listNsfShortcuts,
+    keepNsfShortcut,
+    formatNsfShortcutOutput,
+    formatKeepNsfShortcutPlan,
+} from './nsfShortcut'
+
+export {
+    transferNestedShareRecords,
+    formatTransferNestedShareRecordResults,
+} from './nsfTransferRecord'
+
+export { updateNestedShareFolder } from './updateNsfFolder'
+
+export {
+    NSF_RECORD_PERMISSION_ROLES,
+    getFolderPermissionsForRole,
+} from './nsfConstants'
+export type { NsfRecordPermissionRole } from './nsfConstants'