Interface ISambaManager

interface ISambaManager {
    addShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>;
    editGlobal(globalConfig: SambaGlobalConfig): neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>;
    editShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>;
    exportConfig(): neverthrow.ResultAsync<string, ProcessError>;
    getGlobalConfig(): neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>;
    getShare(shareName: string): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>;
    getShares(): neverthrow.ResultAsync<SambaShareConfig[], ParsingError | ProcessError>;
    importConfig(config: string): neverthrow.ResultAsync<ISambaManager, ProcessError>;
    listShareNames(): neverthrow.ResultAsync<string[], ParsingError | ProcessError>;
    parseConfig(config: string): neverthrow.Result<SambaConfig, ParsingError>;
    parseGlobalConfig(globalConfig: string): neverthrow.Result<SambaGlobalConfig, ParsingError>;
    parseShareConfig(shareConfig: string): neverthrow.Result<SambaShareConfig, ParsingError>;
    recommendedGlobalDefaults(): neverthrow.Result<SambaGlobalConfig, ParsingError>;
    recommendedShareDefaults(): neverthrow.Result<SambaShareConfig, ParsingError>;
    removeShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>;
    renameShare(oldName: string, newName: string): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>;
    setUserPassword(user: string, passwd: string): neverthrow.ResultAsync<void, ProcessError>;
    unparseConfig(config: SambaConfig): neverthrow.Result<string, ParsingError>;
}

Implemented by

Index

Methods

addShare editGlobal editShare exportConfig getGlobalConfig getShare getShares importConfig listShareNames parseConfig parseGlobalConfig parseShareConfig recommendedGlobalDefaults recommendedShareDefaults removeShare renameShare setUserPassword unparseConfig

Methods

addShare

addShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Add a new share configuration
Parameters
- share: SambaShareConfig
  share configuration to add
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:80

editGlobal

editGlobal(globalConfig: SambaGlobalConfig): neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>
Update current global configuration
Parameters
- globalConfig: SambaGlobalConfig
  New global configuration
Returns neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:56

editShare

editShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Update an existing share configuration NOTE: cannot simply update share name. see ()
Parameters
- share: SambaShareConfig
  new share configuration
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:87

exportConfig

exportConfig(): neverthrow.ResultAsync<string, ProcessError>
Dump configuration to smb.conf format as string

Returns neverthrow.ResultAsync<string, ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:98

getGlobalConfig

getGlobalConfig(): neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>
Get current global configuration

Returns neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:50

getShare

getShare(shareName: string): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Get share configuration by name
Parameters
- shareName: string
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:69

getShares

getShares(): neverthrow.ResultAsync<SambaShareConfig[], ParsingError | ProcessError>
Get all share configurations

Returns neverthrow.ResultAsync<SambaShareConfig[], ParsingError | ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:74

importConfig

importConfig(config: string): neverthrow.ResultAsync<ISambaManager, ProcessError>
Import configuration from smb.conf format string
Parameters
- config: string
  smb.conf format string
Returns neverthrow.ResultAsync<ISambaManager, ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:104

listShareNames

listShareNames(): neverthrow.ResultAsync<string[], ParsingError | ProcessError>
Get list of all share names

Returns neverthrow.ResultAsync<string[], ParsingError | ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:63

parseConfig

parseConfig(config: string): neverthrow.Result<SambaConfig, ParsingError>
Parse complete samba configuration text (e.g. contents of smb.conf) into configuration object
Parameters
- config: string
  Complete configuration text
Returns neverthrow.Result<SambaConfig, ParsingError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:39

parseGlobalConfig

parseGlobalConfig(globalConfig: string): neverthrow.Result<SambaGlobalConfig, ParsingError>
Parse global configuration text into global config object
Parameters
- globalConfig: string
  Global configuration text, including '[global]' header
Returns neverthrow.Result<SambaGlobalConfig, ParsingError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:33

parseShareConfig

parseShareConfig(shareConfig: string): neverthrow.Result<SambaShareConfig, ParsingError>
Parse configuration text into a share object
Parameters
- shareConfig: string
  Share configuration text, including '[share name]' header
Returns neverthrow.Result<SambaShareConfig, ParsingError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:27

recommendedGlobalDefaults

recommendedGlobalDefaults(): neverthrow.Result<SambaGlobalConfig, ParsingError>
Recommended defaults for global configuration. Maintained in ./recommended-defaults.conf

Returns neverthrow.Result<SambaGlobalConfig, ParsingError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:114

recommendedShareDefaults

recommendedShareDefaults(): neverthrow.Result<SambaShareConfig, ParsingError>
Recommended defaults for a new share. Maintained in ./recommended-defaults.conf

Returns neverthrow.Result<SambaShareConfig, ParsingError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:109

removeShare

removeShare(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Remove an existing share configuration
Parameters
- share: SambaShareConfig
  share to remove
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:93

renameShare

renameShare(oldName: string, newName: string): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
Rename a share
Parameters
- oldName: string
- newName: string
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:121

setUserPassword

setUserPassword(user: string, passwd: string): neverthrow.ResultAsync<void, ProcessError>
Add samba user with specific passwd
Parameters
- user: string
- passwd: string
Returns neverthrow.ResultAsync<void, ProcessError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:131

unparseConfig

unparseConfig(config: SambaConfig): neverthrow.Result<string, ParsingError>
Unparse comlete samba configuration object back into smbd.conf format text
Parameters
- config: SambaConfig
Returns neverthrow.Result<string, ParsingError>
- Defined in houston-common-lib/lib/managers/samba/manager.ts:45