Skip to content

Commit a0f8429

Browse files
hsubox76hsubox76
committed
Fix some bugs
1 parent 6c0f61b commit a0f8429

File tree

3 files changed

+108
-30
lines changed

3 files changed

+108
-30
lines changed

‎common/api-review/storage.api.md

Lines changed: 103 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,34 @@
44
55
```ts
66

7-
import { FirebaseApp } from '@firebase/app-types';
8-
import { FirebaseStorageError } from '@firebase/storage-types/exp';
9-
import { FullMetadata } from '@firebase/storage-types/exp';
10-
import { ListOptions } from '@firebase/storage-types/exp';
11-
import { ListResult } from '@firebase/storage-types/exp';
12-
import { SettableMetadata } from '@firebase/storage-types/exp';
13-
import { StorageObserver } from '@firebase/storage-types/exp';
14-
import { StorageReference } from '@firebase/storage-types/exp';
15-
import { StorageService } from '@firebase/storage-types/exp';
16-
import { TaskEvent } from '@firebase/storage-types/exp';
17-
import { TaskState } from '@firebase/storage-types/exp';
18-
import { UploadMetadata } from '@firebase/storage-types/exp';
19-
import { UploadResult } from '@firebase/storage-types/exp';
20-
import { UploadTask } from '@firebase/storage-types/exp';
7+
import { CompleteFn } from '@firebase/util';
8+
import { FirebaseApp } from '@firebase/app';
9+
import { FirebaseError } from '@firebase/util';
10+
import { NextFn } from '@firebase/util';
11+
import { Subscribe } from '@firebase/util';
12+
import { Unsubscribe } from '@firebase/util';
2113

2214
// @public
2315
export function deleteObject(ref: StorageReference): Promise<void>;
2416

25-
export { FirebaseStorageError }
17+
// @public
18+
export interface FirebaseStorageError extends FirebaseError {
19+
serverResponse: string | null;
20+
}
2621

27-
export { FullMetadata }
22+
// @public
23+
export interface FullMetadata extends UploadMetadata {
24+
bucket: string;
25+
downloadTokens: string[] | undefined;
26+
fullPath: string;
27+
generation: string;
28+
metageneration: string;
29+
name: string;
30+
ref?: StorageReference | undefined;
31+
size: number;
32+
timeCreated: string;
33+
updated: string;
34+
}
2835

2936
// @public
3037
export function getDownloadURL(ref: StorageReference): Promise<string>;
@@ -41,23 +48,64 @@ export function list(ref: StorageReference, options?: ListOptions): Promise<List
4148
// @public
4249
export function listAll(ref: StorageReference): Promise<ListResult>;
4350

44-
export { ListOptions }
51+
// @public
52+
export interface ListOptions {
53+
maxResults?: number | null;
54+
pageToken?: string | null;
55+
}
4556

46-
export { ListResult }
57+
// @public
58+
export interface ListResult {
59+
items: StorageReference[];
60+
nextPageToken?: string;
61+
prefixes: StorageReference[];
62+
}
4763

4864
// @public
4965
export function ref(storage: StorageService, url?: string): StorageReference;
5066

5167
// @public
5268
export function ref(storageOrRef: StorageService | StorageReference, path?: string): StorageReference;
5369

54-
export { SettableMetadata }
70+
// @public
71+
export interface SettableMetadata {
72+
cacheControl?: string | undefined;
73+
contentDisposition?: string | undefined;
74+
contentEncoding?: string | undefined;
75+
contentLanguage?: string | undefined;
76+
contentType?: string | undefined;
77+
customMetadata?: {
78+
[key: string]: string;
79+
} | undefined;
80+
}
5581

56-
export { StorageObserver }
82+
// @public
83+
export interface StorageObserver<T> {
84+
// (undocumented)
85+
complete?: CompleteFn | null;
86+
// (undocumented)
87+
error?: (error: FirebaseStorageError) => void | null;
88+
// (undocumented)
89+
next?: NextFn<T> | null;
90+
}
5791

58-
export { StorageReference }
92+
// @public
93+
export interface StorageReference {
94+
bucket: string;
95+
fullPath: string;
96+
name: string;
97+
parent: StorageReference | null;
98+
root: StorageReference;
99+
storage: StorageService;
100+
toString(): string;
101+
}
59102

60-
export { StorageService }
103+
// @public
104+
export interface StorageService {
105+
readonly app: FirebaseApp;
106+
maxOperationRetryTime: number;
107+
maxUploadRetryTime: number;
108+
}
61109

62110
// @public
63111
export type StringFormat = string;
@@ -70,9 +118,11 @@ export const StringFormat: {
70118
DATA_URL: string;
71119
};
72120

73-
export { TaskEvent }
121+
// @public
122+
export type TaskEvent = 'state_changed';
74123

75-
export { TaskState }
124+
// @public
125+
export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
76126

77127
// @public
78128
export function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
@@ -83,14 +133,40 @@ export function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | Arr
83133
// @public
84134
export function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;
85135

86-
export { UploadMetadata }
136+
// @public
137+
export interface UploadMetadata extends SettableMetadata {
138+
md5Hash?: string | undefined;
139+
}
87140

88-
export { UploadResult }
141+
// @public
142+
export interface UploadResult {
143+
readonly metadata: FullMetadata;
144+
readonly ref: StorageReference;
145+
}
89146

90147
// @public
91148
export function uploadString(ref: StorageReference, value: string, format?: string, metadata?: UploadMetadata): Promise<UploadResult>;
92149

93-
export { UploadTask }
150+
// @public
151+
export interface UploadTask {
152+
cancel(): boolean;
153+
catch(onRejected: (error: FirebaseStorageError) => unknown): Promise<unknown>;
154+
on(event: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: FirebaseStorageError) => unknown) | null, complete?: Unsubscribe | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;
155+
pause(): boolean;
156+
resume(): boolean;
157+
snapshot: UploadTaskSnapshot;
158+
then(onFulfilled?: ((snapshot: UploadTaskSnapshot) => unknown) | null, onRejected?: ((error: FirebaseStorageError) => unknown) | null): Promise<unknown>;
159+
}
160+
161+
// @public
162+
export interface UploadTaskSnapshot {
163+
bytesTransferred: number;
164+
metadata: FullMetadata;
165+
ref: StorageReference;
166+
state: TaskState;
167+
task: UploadTask;
168+
totalBytes: number;
169+
}
94170

95171

96172
// (No @packageDocumentation comment for this package)

‎packages/storage/exp/index.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ import {
5151
StorageObserver,
5252
SettableMetadata,
5353
UploadMetadata,
54-
FullMetadata
54+
FullMetadata,
55+
UploadTaskSnapshot
5556
} from './public-types';
5657
import { Metadata as MetadataInternal } from '../src/metadata';
5758
import {
@@ -83,7 +84,8 @@ export {
8384
FirebaseStorageError,
8485
TaskEvent,
8586
TaskState,
86-
StorageObserver
87+
StorageObserver,
88+
UploadTaskSnapshot
8789
};
8890

8991
/**

‎packages/storage/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
1616
"lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
1717
"build": "rollup -c rollup.config.compat.js && yarn build:exp",
18-
"build:exp": "rollup -c rollup.config.exp.js ; yarn api-report",
18+
"build:exp": "rollup -c rollup.config.exp.js && yarn api-report",
1919
"build:deps": "lerna run --scope @firebase/storage --include-dependencies build",
2020
"dev": "rollup -c -w",
2121
"test": "run-p test:browser lint",

0 commit comments

Comments
 (0)