From 8f85cc688447d2925bbb30b3ba0ed8377e0e8217 Mon Sep 17 00:00:00 2001 From: Kevin Cheung Date: Wed, 16 Nov 2022 14:03:53 -0800 Subject: [PATCH 1/3] Extensions docstring tweaks --- src/extensions/extensions.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/extensions/extensions.ts b/src/extensions/extensions.ts index 6e98f3575c..d6c58741df 100644 --- a/src/extensions/extensions.ts +++ b/src/extensions/extensions.ts @@ -36,8 +36,10 @@ export class Extensions { /** * The runtime() method returns a new Runtime, which provides methods to modify an extension instance's runtime data. + * + * This method will throw an error if called outside an Extensions environment. * - * @returns A new Runtime object. + * @returns A new {@link Runtime} object. */ public runtime(): Runtime { return new Runtime(this.client); From c9e01d9727b4ccd2d0a36b62ffa3491951a9c052 Mon Sep 17 00:00:00 2001 From: Kevin Cheung Date: Wed, 16 Nov 2022 14:36:47 -0800 Subject: [PATCH 2/3] export Runtime --- etc/firebase-admin.extensions.api.md | 8 +++++++- src/extensions/extensions.ts | 2 +- src/extensions/index.ts | 2 +- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/etc/firebase-admin.extensions.api.md b/etc/firebase-admin.extensions.api.md index ed9090aaee..6f42a13c83 100644 --- a/etc/firebase-admin.extensions.api.md +++ b/etc/firebase-admin.extensions.api.md @@ -14,11 +14,17 @@ export class Extensions { // // (undocumented) readonly app: App; - // Warning: (ae-forgotten-export) The symbol "Runtime" needs to be exported by the entry point index.d.ts runtime(): Runtime; } // @public export function getExtensions(app?: App): Extensions; +// @public +export class Runtime { + setFatalError(errorMessage: string): Promise; + // Warning: (ae-forgotten-export) The symbol "SettableProcessingState" needs to be exported by the entry point index.d.ts + setProcessingState(state: SettableProcessingState, detailMessage: string): Promise; +} + ``` diff --git a/src/extensions/extensions.ts b/src/extensions/extensions.ts index d6c58741df..c4f6485539 100644 --- a/src/extensions/extensions.ts +++ b/src/extensions/extensions.ts @@ -49,7 +49,7 @@ export class Extensions { /** * Runtime provides methods to modify an extension instance's runtime data. */ -class Runtime { +export class Runtime { private projectId: string; private extensionInstanceId: string; private readonly client: ExtensionsApiClient; diff --git a/src/extensions/index.ts b/src/extensions/index.ts index 6283e630dc..8289cc5eb7 100644 --- a/src/extensions/index.ts +++ b/src/extensions/index.ts @@ -25,7 +25,7 @@ import { App, getApp } from '../app'; import { FirebaseApp } from '../app/firebase-app'; import { Extensions } from './extensions'; -export { Extensions } from './extensions'; +export { Extensions, Runtime } from './extensions'; /** * Gets the {@link Extensions} service for the default app From 58aa36a504bb3208f3248822944be0ac31f745b8 Mon Sep 17 00:00:00 2001 From: Kevin Cheung Date: Wed, 16 Nov 2022 14:51:46 -0800 Subject: [PATCH 3/3] export SettableProcessingState --- etc/firebase-admin.extensions.api.md | 4 +++- src/extensions/index.ts | 3 ++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/etc/firebase-admin.extensions.api.md b/etc/firebase-admin.extensions.api.md index 6f42a13c83..127754c9c9 100644 --- a/etc/firebase-admin.extensions.api.md +++ b/etc/firebase-admin.extensions.api.md @@ -23,8 +23,10 @@ export function getExtensions(app?: App): Extensions; // @public export class Runtime { setFatalError(errorMessage: string): Promise; - // Warning: (ae-forgotten-export) The symbol "SettableProcessingState" needs to be exported by the entry point index.d.ts setProcessingState(state: SettableProcessingState, detailMessage: string): Promise; } +// @public +export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED'; + ``` diff --git a/src/extensions/index.ts b/src/extensions/index.ts index 8289cc5eb7..486ad645d0 100644 --- a/src/extensions/index.ts +++ b/src/extensions/index.ts @@ -26,7 +26,8 @@ import { FirebaseApp } from '../app/firebase-app'; import { Extensions } from './extensions'; export { Extensions, Runtime } from './extensions'; - +export { SettableProcessingState } from './extensions-api'; + /** * Gets the {@link Extensions} service for the default app * or a given app.