Space SDK Package

Space SDK Package

  • Users
  • Storage
  • Space Docs

@spacehq/sdk

sdk package

Classes

ClassDescription
BrowserStorageBrowserStorage is an IdentityStorage implementation that works in the browser.
DirEntryNotFoundError
FileNotFoundError
FileStorageFileStorage is an IdentityStorage implementation that works in the browser.NOTE: This is experimental, you might want to roll your own IdentityStorage of early.
GundbMetadataStoreA Users Storage Metadata store backed by gundsdb.This is the default MetadataStore used by UserStorage.
SpaceVaultServiceSpaceVaultService implements Vault interface. It interacts to space's vault service to retrieve and store vault items.
UnauthenticatedError
UsersUsers a client wrapper for interacting with the Textile Users API.This API has the ability to:- Create new identity- Authenticate via identity against ws challenge
UserStorageUserStorage performs storage actions on behalf of the user provided.
ValidationError

Enumerations

EnumerationDescription
InvitationStatusInvitationStatus represents the different statuses a file invitation could have
NotificationType
ShareKeyType
VaultBackupType
VaultItemType
VkVersion

Interfaces

InterfaceDescription
AcceptInvitationResponse
AddItemFile
AddItemsRequest
AddItemsResponse
AddItemsResultSummary
AddItemsStatus
BucketMetadataThis is equivalent to the BucketSchema struct of the space-daemon. It contains information about a users bucket schema.
CreateFolderRequest
DirectoryEntryRepresents an item stored in a storages directory
FileMemberRepresents a member on a shared file
FileMetadataRepresents metadata information about a file stored in users storage
FullPathFullPath represents full path information to a file. dbId is optional and only required for when re-sharing files in another db.
GetFilesSharedByMeResponse
GetFilesSharedWithMeResponse
GetNotificationsResponse
GetRecentlySharedWithResponse
IdentityIdentity represents an entity capable of signing a message. This is a simple "private key" interface that must be capable of returning the associated "public key" for verification. In many cases, the Identity will just be a private key.
IdentityStorageAn IdentityStorage handles persistence of Identity for the Users class.The sdk provides two implementation for this. See BrowserStorage and FileStorage.
InvitationInvitation represents a file invitation invitationID is the same as the underlying message ID from Textile
ListDirectoryRequest
ListDirectoryResponse
MakeFilePublicRequest
MovePathsResponse
MovePathsResultSummary
MovePathsStatus
Notification_2
NotificationSubscribeEvent
NotificationSubscribeResponse
OpenFileRequest
OpenFileResponse
OpenUuidFileRequest
OpenUuidFileResponse
PublicPublic is any entity associated with a given Identity that is capable of verifying a signature produced by said identity. In most cases, a public key will be obtained as a property of an object implementing the Identity key interface.
SharedFileMetadataRepresents files that were shared with the current store user
SharedWithMeFilesSharedWithMeFiles Represents a file created for the user
SharePublicKeyInputData object to represent public key of a user to share information with
SharePublicKeyOutputData object to represent public key of a user to share information with
ShareUserMetadata
ShareViaPublicKeyRequest
ShareViaPublicKeyResponse
SpaceUserRepresents an authenticated KeyPair identity with valid API session token.
TxlSubscribeBucketEvent
TxlSubscribeResponse
UserMetadataStoreMetadata Store manages storing and retrieval of a particular users bucket schema information.
UsersConfigConfiguration option provided to the Users class.
UserStorageConfig
VaultVault interface is used by the Users class to perform secure storage and retrieval of sensitive credentials.
VaultItemObject representing item stored or retrieved from the vault.
VaultServiceConfig

Variables

VariableDescription
GetAddressFromPublicKey

Type Aliases

Type AliasDescription
AddItemDataType
AddItemsEventData
AddItemsEventType
AddItemsListener
MovePathsEventData
MovePathsEventType
MovePathsListener
NotificationSubscribeEventData
NotificationSubscribeEventType
NotificationSubscribeListener
TxlSubscribeEventData
TxlSubscribeEventType
TxlSubscribeListener
  • sdk package
  • Classes
  • Enumerations
  • Interfaces
  • Variables
  • Type Aliases
Space SDK Package
Docs
Getting StartedUsersStorage
Resources
All DocumentationProject SlackBlog
More
GitHubStar
Follow @spacestorage