Skip to content

Commit 938dc1a

Browse files
hsubox76hsubox76
authored
Remove storage-types/exp (#4507)
1 parent 145c62b commit 938dc1a

File tree

8 files changed

+125
-69
lines changed

8 files changed

+125
-69
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: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,10 @@ import {
4545
ListOptions,
4646
ListResult,
4747
UploadTask,
48-
FirebaseStorageError,
49-
TaskEvent,
50-
TaskState,
51-
StorageObserver,
5248
SettableMetadata,
5349
UploadMetadata,
5450
FullMetadata
55-
} from '@firebase/storage-types/exp';
51+
} from './public-types';
5652
import { Metadata as MetadataInternal } from '../src/metadata';
5753
import {
5854
uploadBytes as uploadBytesInternal,
@@ -70,21 +66,7 @@ import {
7066
/**
7167
* Public types.
7268
*/
73-
export {
74-
StorageReference,
75-
StorageService,
76-
UploadMetadata,
77-
SettableMetadata,
78-
FullMetadata,
79-
UploadResult,
80-
ListOptions,
81-
ListResult,
82-
UploadTask,
83-
FirebaseStorageError,
84-
TaskEvent,
85-
TaskState,
86-
StorageObserver
87-
};
69+
export * from './public-types';
8870

8971
/**
9072
* Uploads data to this object's location.

‎packages/storage-types/exp/index.d.ts renamed to ‎packages/storage/exp/public-types.ts

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,15 @@
1515
* limitations under the License.
1616
*/
1717

18-
import { FirebaseApp, _FirebaseService } from '@firebase/app-types-exp';
19-
import { CompleteFn, FirebaseError, NextFn, Unsubscribe } from '@firebase/util';
18+
// eslint-disable-next-line import/no-extraneous-dependencies
19+
import { FirebaseApp } from '@firebase/app-exp';
20+
import {
21+
CompleteFn,
22+
FirebaseError,
23+
NextFn,
24+
Subscribe,
25+
Unsubscribe
26+
} from '@firebase/util';
2027

2128
/**
2229
* A Firebase Storage instance.
@@ -245,7 +252,7 @@ export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
245252
* An error returned by the Firebase Storage SDK.
246253
* @public
247254
*/
248-
interface FirebaseStorageError extends FirebaseError {
255+
export interface FirebaseStorageError extends FirebaseError {
249256
/**
250257
* A server response message for the error, if applicable.
251258
*/
@@ -276,7 +283,7 @@ export interface UploadTask {
276283
/**
277284
* Equivalent to calling `then(null, onRejected)`.
278285
*/
279-
catch(onRejected: (error: FirebaseStorageError) => any): Promise<any>;
286+
catch(onRejected: (error: FirebaseStorageError) => unknown): Promise<unknown>;
280287
/**
281288
* Listens for events on this task.
282289
*
@@ -391,10 +398,10 @@ export interface UploadTask {
391398
nextOrObserver?:
392399
| StorageObserver<UploadTaskSnapshot>
393400
| null
394-
| ((snapshot: UploadTaskSnapshot) => any),
395-
error?: ((a: FirebaseStorageError) => any) | null,
401+
| ((snapshot: UploadTaskSnapshot) => unknown),
402+
error?: ((a: FirebaseStorageError) => unknown) | null,
396403
complete?: Unsubscribe | null
397-
): Function;
404+
): Unsubscribe | Subscribe<UploadTaskSnapshot>;
398405

399406
/**
400407
* Pauses a currently running task. Has no effect on a paused or failed task.
@@ -419,9 +426,9 @@ export interface UploadTask {
419426
* @param onRejected - The rejection callback.
420427
*/
421428
then(
422-
onFulfilled?: ((snapshot: UploadTaskSnapshot) => any) | null,
423-
onRejected?: ((error: FirebaseStorageError) => any) | null
424-
): Promise<any>;
429+
onFulfilled?: ((snapshot: UploadTaskSnapshot) => unknown) | null,
430+
onRejected?: ((error: FirebaseStorageError) => unknown) | null
431+
): Promise<unknown>;
425432
}
426433

427434
/**

‎packages/storage/src/metadata.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* limitations under the License.
1616
*/
1717

18-
import { FullMetadata } from '@firebase/storage-types/exp';
18+
import { FullMetadata } from '../exp/public-types';
1919

2020
/**
2121
* @fileoverview Documentation for the metadata format.

‎packages/storage/src/reference.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ import {
3131
deleteObject as requestsDeleteObject,
3232
multipartUpload
3333
} from './implementation/requests';
34-
import { ListOptions } from '@firebase/storage-types/exp';
34+
import { ListOptions } from '../exp/public-types';
3535
import { StringFormat, dataFromString } from './implementation/string';
3636
import { Metadata } from './metadata';
3737
import { StorageService } from './service';

‎packages/storage/test/integration/integration.exp.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ import {
3434

3535
import { use, expect } from 'chai';
3636
import * as chaiAsPromised from 'chai-as-promised';
37-
import * as types from '@firebase/storage-types/exp';
37+
import * as types from '../../exp/public-types';
3838

3939
use(chaiAsPromised);
4040

‎scripts/exp/prepare-storage-for-exp-release.ts

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,7 @@ export async function prepare() {
3737
// Update package.json
3838
const packageJson = await readPackageJson(packagePath);
3939
const expPackageJson = await readPackageJson(`${packagePath}/exp`);
40-
const typesPackageJson = await readPackageJson(`${packagePath}-types`);
4140
packageJson.version = '0.0.900';
42-
typesPackageJson.version = '0.0.900';
43-
typesPackageJson.files = `['exp/index.d.ts']`;
4441

4542
packageJson.peerDependencies = {
4643
'@firebase/app-exp': '0.x'
@@ -62,9 +59,4 @@ export async function prepare() {
6259
`${JSON.stringify(packageJson, null, 2)}\n`,
6360
{ encoding: 'utf-8' }
6461
);
65-
await writeFile(
66-
`${packagePath}-types/package.json`,
67-
`${JSON.stringify(typesPackageJson, null, 2)}\n`,
68-
{ encoding: 'utf-8' }
69-
);
7062
}

‎scripts/exp/release.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ async function publishExpPackages({ dryRun }: { dryRun: boolean }) {
7575

7676
packagePaths.push(`${projectRoot}/packages/firestore`);
7777
packagePaths.push(`${projectRoot}/packages/storage`);
78-
packagePaths.push(`${projectRoot}/packages/storage-types`);
7978
packagePaths.push(`${projectRoot}/packages/database`);
8079

8180
/**

0 commit comments

Comments
 (0)