diff --git a/etc/sdk.api.md b/etc/sdk.api.md index 322de88..8e83eba 100644 --- a/etc/sdk.api.md +++ b/etc/sdk.api.md @@ -5,7 +5,6 @@ ```ts import { Buckets } from '@textile/hub'; -import { IGunChainReference } from 'gun/types/chain'; import { UserAuth } from '@textile/hub'; // @public (undocumented) @@ -70,13 +69,6 @@ export class BrowserStorage { remove(key: string): Promise; } -// @public -export interface BucketMetadata { - dbId: string; - encryptionKey: Uint8Array; - slug: string; -} - // @public (undocumented) export interface CreateFolderRequest { bucket: string; @@ -86,17 +78,33 @@ export interface CreateFolderRequest { // @public export interface DirectoryEntry { // (undocumented) - cid: string; + backupCount: number; + // (undocumented) + created: Date; + // (undocumented) + fileExtension: string; + // (undocumented) + ipfsHash: string; + // (undocumented) + isBackupInProgress: boolean; // (undocumented) isDir: boolean; // (undocumented) + isLocallyAvailable: boolean; + // (undocumented) + isRestoreInProgress: boolean; + // (undocumented) items?: DirectoryEntry[]; // (undocumented) + members: FileMember[]; + // (undocumented) name: string; // (undocumented) path: string; // (undocumented) - size: number; + sizeInBytes: number; + // (undocumented) + updated: Date; } // @public (undocumented) @@ -104,6 +112,14 @@ export class DirEntryNotFoundError extends Error { constructor(filePath: string, bucket: string); } +// @public +export interface FileMember { + // (undocumented) + address?: string; + // (undocumented) + publicKey: string; +} + // @public export class FileStorage { constructor(filename: string); @@ -115,16 +131,6 @@ export class FileStorage { remove(key: string): Promise; } -// @public -export class GunsdbMetadataStore implements UserMetadataStore { - createBucket(bucketSlug: string, dbId: string): Promise; - findBucket(bucketSlug: string, dbId: string): Promise; - // Warning: (ae-forgotten-export) The symbol "GunChainReference" needs to be exported by the entry point index.d.ts - // Warning: (ae-forgotten-export) The symbol "GunDataState" needs to be exported by the entry point index.d.ts - static fromIdentity(identity: Identity, gunOrServer?: GunChainReference | string): Promise; - listBuckets(): Promise; - } - // Warning: (ae-internal-missing-underscore) The name "HubAuthResponse" should be prefixed with an underscore because the declaration is marked as @internal // // @internal @@ -137,7 +143,6 @@ export interface HubAuthResponse { // @public export interface Identity { - privKey: Uint8Array; public: Public; sign(data: Uint8Array): Promise; } @@ -221,13 +226,6 @@ export class UnauthenticatedError extends Error { constructor(); } -// @public -export interface UserMetadataStore { - createBucket: (bucketSlug: string, dbId: string) => Promise; - findBucket: (bucketSlug: string, dbId: string) => Promise; - listBuckets: () => Promise; -} - // @public export class Users { constructor(config: UsersConfig, storage?: IdentityStorage); @@ -264,8 +262,6 @@ export class UserStorage { export interface UserStorageConfig { bucketsInit?: (auth: UserAuth) => Buckets; // (undocumented) - metadataStoreInit?: (identity: Identity) => Promise; - // (undocumented) textileHubAddress?: string; } diff --git a/package.json b/package.json index c768b07..8792b4f 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "serve:docs": "npm run docs && cd website && npm run start", "build:docs": "npm run docs && cd website && npm install && npm run build", "bootstrap": "lerna bootstrap", - "bumpversion": "npm run build:docs && lerna version --no-push --no-git-tag-version", + "bumpversion": "npm run build && npm run build:docs && lerna version --no-push --no-git-tag-version", "publish": "lerna publish", "publish:from": "lerna publish from-package", "clean": "lerna clean && lerna run clean",