Skip to content

Commit 5fceab1

Browse files
committed
Use public typings for release (#5358)
* use public typings for storage * use public typings for database
1 parent 45109a9 commit 5fceab1

File tree

5 files changed

+17
-13
lines changed

5 files changed

+17
-13
lines changed

common/api-review/storage.api.md

+7-11
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,19 @@ export interface FirebaseStorageError extends FirebaseError {
5656
serverResponse: string | null;
5757
}
5858

59-
// @public
59+
// @internal
6060
export class _FirebaseStorageImpl implements FirebaseStorage {
6161
constructor(
6262
app: FirebaseApp, _authProvider: Provider<FirebaseAuthInternalName>,
6363
_appCheckProvider: Provider<AppCheckInternalComponentName>,
6464
_pool: ConnectionPool, _url?: string | undefined, _firebaseVersion?: string | undefined);
6565
readonly app: FirebaseApp;
66-
// @internal (undocumented)
66+
// (undocumented)
6767
readonly _appCheckProvider: Provider<AppCheckInternalComponentName>;
6868
// (undocumented)
6969
protected readonly _appId: string | null;
7070
// (undocumented)
7171
readonly _authProvider: Provider<FirebaseAuthInternalName>;
72-
// Warning: (ae-incompatible-release-tags) The symbol "_bucket" is marked as @public, but its signature references "Location" which is marked as @internal
73-
//
7472
// (undocumented)
7573
_bucket: _Location | null;
7674
_delete(): Promise<void>;
@@ -90,8 +88,6 @@ export class _FirebaseStorageImpl implements FirebaseStorage {
9088
_makeRequest<T>(requestInfo: RequestInfo_2<T>, authToken: string | null, appCheckToken: string | null): Request_2<T>;
9189
// (undocumented)
9290
makeRequestWithTokens<T>(requestInfo: RequestInfo_2<T>): Promise<Request_2<T>>;
93-
// Warning: (ae-incompatible-release-tags) The symbol "_makeStorageReference" is marked as @public, but its signature references "Location" which is marked as @internal
94-
// Warning: (ae-incompatible-release-tags) The symbol "_makeStorageReference" is marked as @public, but its signature references "Reference" which is marked as @internal
9591
_makeStorageReference(loc: _Location): _Reference;
9692
get maxOperationRetryTime(): number;
9793
set maxOperationRetryTime(time: number);
@@ -101,7 +97,7 @@ export class _FirebaseStorageImpl implements FirebaseStorage {
10197
_overrideAuthToken?: string;
10298
// Warning: (ae-forgotten-export) The symbol "ConnectionPool" needs to be exported by the entry point index.d.ts
10399
//
104-
// @internal (undocumented)
100+
// (undocumented)
105101
readonly _pool: ConnectionPool;
106102
// (undocumented)
107103
readonly _url?: string | undefined;
@@ -250,21 +246,21 @@ export const StringFormat: {
250246
// @public
251247
export type TaskEvent = 'state_changed';
252248

253-
// @public
249+
// @internal
254250
export type _TaskEvent = string;
255251

256-
// @public
252+
// @internal
257253
export const _TaskEvent: {
258254
STATE_CHANGED: string;
259255
};
260256

261257
// @public
262258
export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
263259

264-
// @public
260+
// @internal
265261
export type _TaskState = typeof _TaskState[keyof typeof _TaskState];
266262

267-
// @public
263+
// @internal
268264
export const _TaskState: {
269265
readonly RUNNING: "running";
270266
readonly PAUSED: "paused";

packages/database/package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
"test:emulator": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/database-test-runner.ts",
2626
"api-report": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' ts-node ../../repo-scripts/prune-dts/extract-public-api.ts --package database --packageRoot . --typescriptDts ./dist/src/index.d.ts --rollupDts ./dist/private.d.ts --untrimmedRollupDts ./dist/internal.d.ts --publicDts ./dist/public.d.ts && yarn api-report:api-json",
2727
"api-report:api-json": "rm -rf temp && api-extractor run --local --verbose",
28-
"doc": "api-documenter markdown --input temp --output docs"
28+
"doc": "api-documenter markdown --input temp --output docs",
29+
"typings:public": "node ../../scripts/exp/use_typings.js ./dist/public.d.ts"
2930
},
3031
"license": "Apache-2.0",
3132
"peerDependencies": {},

packages/storage/package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
"test:node": "TS_NODE_FILES=true TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file src/index.ts --config ../../config/mocharc.node.js",
2626
"test:debug": "karma start --browser=Chrome",
2727
"prettier": "prettier --write 'src/**/*.ts' 'test/**/*.ts'",
28-
"api-report": "api-extractor run --local --verbose && ts-node-script ../../repo-scripts/prune-dts/prune-dts.ts --input dist/storage-public.d.ts --output dist/storage-public.d.ts"
28+
"api-report": "api-extractor run --local --verbose && ts-node-script ../../repo-scripts/prune-dts/prune-dts.ts --input dist/storage-public.d.ts --output dist/storage-public.d.ts",
29+
"typings:public": "node ../../scripts/exp/use_typings.js ./dist/storage-public.d.ts"
2930
},
3031
"license": "Apache-2.0",
3132
"dependencies": {

packages/storage/src/implementation/taskenums.ts

+4
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,13 @@
2121

2222
/**
2323
* An event that is triggered on a task.
24+
* @internal
2425
*/
2526
export type TaskEvent = string;
2627

2728
/**
2829
* An event that is triggered on a task.
30+
* @internal
2931
*/
3032
export const TaskEvent = {
3133
/**
@@ -58,12 +60,14 @@ export const enum InternalTaskState {
5860

5961
/**
6062
* Represents the current state of a running upload.
63+
* @internal
6164
*/
6265
export type TaskState = typeof TaskState[keyof typeof TaskState];
6366

6467
// type keys = keyof TaskState
6568
/**
6669
* Represents the current state of a running upload.
70+
* @internal
6771
*/
6872
export const TaskState = {
6973
/** The task is currently transferring data. */

packages/storage/src/service.ts

+2
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,8 @@ export function connectStorageEmulator(
149149
/**
150150
* A service that provides Firebase Storage Reference instances.
151151
* @param opt_url - gs:// url to a custom Storage Bucket
152+
*
153+
* @internal
152154
*/
153155
export class FirebaseStorageImpl implements FirebaseStorage {
154156
_bucket: Location | null = null;

0 commit comments

Comments
 (0)