From 4574838800ee208ed7ba67f7ba53cba3f29cc48f Mon Sep 17 00:00:00 2001 From: Tyler Stark Date: Mon, 9 May 2022 12:06:28 -0500 Subject: [PATCH 1/5] Update docs for identity Update docs for identity (resolving warnings) --- src/v2/providers/identity.ts | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/src/v2/providers/identity.ts b/src/v2/providers/identity.ts index 798a39212..2b8eb7edc 100644 --- a/src/v2/providers/identity.ts +++ b/src/v2/providers/identity.ts @@ -11,7 +11,7 @@ import * as options from '../options'; export { HttpsError }; -/** Internally used when parsing the options. */ +/** @internal Internally used when parsing the options. */ interface InternalOptions { opts: options.GlobalOptions; idToken: boolean; @@ -20,7 +20,7 @@ interface InternalOptions { } /** - * All function options plus idToken, accessToken, and refreshToken. + * @beta All function options plus idToken, accessToken, and refreshToken. */ export interface BlockingOptions extends options.GlobalOptions { idToken?: boolean; @@ -28,9 +28,7 @@ export interface BlockingOptions extends options.GlobalOptions { refreshToken?: boolean; } -/** - * Handle an event that is triggered before a user is created. - */ +/** @beta Handle an event that is triggered before a user is created. */ export function beforeUserCreated( handler: ( event: AuthBlockingEvent @@ -40,6 +38,8 @@ export function beforeUserCreated( | void | Promise ): BlockingFunction; + +/** @beta Handle an event that is triggered before a user is created. */ export function beforeUserCreated( opts: BlockingOptions, handler: ( @@ -50,6 +50,8 @@ export function beforeUserCreated( | void | Promise ): BlockingFunction; + +/** @beta Handle an event that is triggered before a user is created. */ export function beforeUserCreated( optsOrHandler: | BlockingOptions @@ -71,9 +73,7 @@ export function beforeUserCreated( return beforeOperation('beforeCreate', optsOrHandler, handler); } -/** - * Handle an event that is triggered before a user is signed in. - */ +/** @beta Handle an event that is triggered before a user is signed in. */ export function beforeUserSignedIn( handler: ( event: AuthBlockingEvent @@ -83,6 +83,8 @@ export function beforeUserSignedIn( | void | Promise ): BlockingFunction; + +/** @beta Handle an event that is triggered before a user is signed in. */ export function beforeUserSignedIn( opts: BlockingOptions, handler: ( @@ -93,6 +95,8 @@ export function beforeUserSignedIn( | void | Promise ): BlockingFunction; + +/** @beta Handle an event that is triggered before a user is signed in. */ export function beforeUserSignedIn( optsOrHandler: | BlockingOptions From c4841b1dc402c7d6e68f7b2537ec4d8bf7467733 Mon Sep 17 00:00:00 2001 From: Tyler Stark Date: Mon, 9 May 2022 12:36:52 -0500 Subject: [PATCH 2/5] Change internal -> hidden --- src/v2/providers/identity.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/v2/providers/identity.ts b/src/v2/providers/identity.ts index 2b8eb7edc..de1a171e0 100644 --- a/src/v2/providers/identity.ts +++ b/src/v2/providers/identity.ts @@ -11,7 +11,7 @@ import * as options from '../options'; export { HttpsError }; -/** @internal Internally used when parsing the options. */ +/** @hidden Internally used when parsing the options. */ interface InternalOptions { opts: options.GlobalOptions; idToken: boolean; @@ -118,7 +118,7 @@ export function beforeUserSignedIn( return beforeOperation('beforeSignIn', optsOrHandler, handler); } -/** @internal */ +/** @hidden */ export function beforeOperation( eventType: AuthBlockingEventType, optsOrHandler: @@ -201,7 +201,7 @@ export function beforeOperation( return func; } -/** @internal */ +/** @hidden */ export function getOpts(blockingOptions: BlockingOptions): InternalOptions { const accessToken = blockingOptions.accessToken || false; const idToken = blockingOptions.idToken || false; From fa98620634b6c9b7a9d55b2d3fb1010eb86d6602 Mon Sep 17 00:00:00 2001 From: Tyler Stark Date: Mon, 9 May 2022 15:05:11 -0500 Subject: [PATCH 3/5] Remove @beta from identity provider --- src/v2/providers/identity.ts | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/v2/providers/identity.ts b/src/v2/providers/identity.ts index de1a171e0..d996f2de6 100644 --- a/src/v2/providers/identity.ts +++ b/src/v2/providers/identity.ts @@ -20,7 +20,7 @@ interface InternalOptions { } /** - * @beta All function options plus idToken, accessToken, and refreshToken. + * All function options plus idToken, accessToken, and refreshToken. */ export interface BlockingOptions extends options.GlobalOptions { idToken?: boolean; @@ -28,7 +28,7 @@ export interface BlockingOptions extends options.GlobalOptions { refreshToken?: boolean; } -/** @beta Handle an event that is triggered before a user is created. */ +/** Handle an event that is triggered before a user is created. */ export function beforeUserCreated( handler: ( event: AuthBlockingEvent @@ -39,7 +39,7 @@ export function beforeUserCreated( | Promise ): BlockingFunction; -/** @beta Handle an event that is triggered before a user is created. */ +/** Handle an event that is triggered before a user is created. */ export function beforeUserCreated( opts: BlockingOptions, handler: ( @@ -51,7 +51,7 @@ export function beforeUserCreated( | Promise ): BlockingFunction; -/** @beta Handle an event that is triggered before a user is created. */ +/** Handle an event that is triggered before a user is created. */ export function beforeUserCreated( optsOrHandler: | BlockingOptions @@ -73,7 +73,7 @@ export function beforeUserCreated( return beforeOperation('beforeCreate', optsOrHandler, handler); } -/** @beta Handle an event that is triggered before a user is signed in. */ +/** Handle an event that is triggered before a user is signed in. */ export function beforeUserSignedIn( handler: ( event: AuthBlockingEvent @@ -84,7 +84,7 @@ export function beforeUserSignedIn( | Promise ): BlockingFunction; -/** @beta Handle an event that is triggered before a user is signed in. */ +/** Handle an event that is triggered before a user is signed in. */ export function beforeUserSignedIn( opts: BlockingOptions, handler: ( @@ -96,7 +96,7 @@ export function beforeUserSignedIn( | Promise ): BlockingFunction; -/** @beta Handle an event that is triggered before a user is signed in. */ +/** Handle an event that is triggered before a user is signed in. */ export function beforeUserSignedIn( optsOrHandler: | BlockingOptions From 0de77396d7f562e9db5e451b4a3bbdc8d5b26249 Mon Sep 17 00:00:00 2001 From: Tyler Stark Date: Mon, 9 May 2022 15:28:56 -0500 Subject: [PATCH 4/5] Update indentity docs --- src/v2/providers/identity.ts | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/src/v2/providers/identity.ts b/src/v2/providers/identity.ts index d996f2de6..e2d5a54e1 100644 --- a/src/v2/providers/identity.ts +++ b/src/v2/providers/identity.ts @@ -28,7 +28,10 @@ export interface BlockingOptions extends options.GlobalOptions { refreshToken?: boolean; } -/** Handle an event that is triggered before a user is created. */ +/** + * Handles an event that is triggered before a user is created. + * @param handler - Event handler which is run every time before a user is created + */ export function beforeUserCreated( handler: ( event: AuthBlockingEvent @@ -39,7 +42,11 @@ export function beforeUserCreated( | Promise ): BlockingFunction; -/** Handle an event that is triggered before a user is created. */ +/** + * Handles an event that is triggered before a user is created. + * @param opts - Object containing Function options + * @param handler - Event handler which is run every time before a user is created + */ export function beforeUserCreated( opts: BlockingOptions, handler: ( @@ -51,7 +58,11 @@ export function beforeUserCreated( | Promise ): BlockingFunction; -/** Handle an event that is triggered before a user is created. */ +/** + * Handles an event that is triggered before a user is created + * @param optsOrHandler - Either an object containing Function options, or an event handler (run before user creation) + * @param handler? - If defined, an wvent handler which is run every time before a user is created + */ export function beforeUserCreated( optsOrHandler: | BlockingOptions @@ -73,7 +84,10 @@ export function beforeUserCreated( return beforeOperation('beforeCreate', optsOrHandler, handler); } -/** Handle an event that is triggered before a user is signed in. */ +/** + * Handles an event that is triggered before a user is signed in. + * @param handler - Event handler which is run every time before a user is signed in + */ export function beforeUserSignedIn( handler: ( event: AuthBlockingEvent @@ -84,7 +98,11 @@ export function beforeUserSignedIn( | Promise ): BlockingFunction; -/** Handle an event that is triggered before a user is signed in. */ +/** + * Handles an event that is triggered before a user is signed in. + * @param opts - Object containing Function options + * @param handler - Event handler which is run every time before a user is signed in + */ export function beforeUserSignedIn( opts: BlockingOptions, handler: ( @@ -96,7 +114,11 @@ export function beforeUserSignedIn( | Promise ): BlockingFunction; -/** Handle an event that is triggered before a user is signed in. */ +/** + * Handles an event that is triggered before a user is signed in. + * @param optsOrHandler - Either an object containing Function options, or an event handler (run before user signin) + * @param handler - Event handler which is run every time before a user is signed in + */ export function beforeUserSignedIn( optsOrHandler: | BlockingOptions From b83a7532518840d9afae0bcfc3088456a9c9c378 Mon Sep 17 00:00:00 2001 From: Tyler Stark Date: Tue, 10 May 2022 10:15:04 -0500 Subject: [PATCH 5/5] Update docs per pr feedback --- src/v2/providers/identity.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/v2/providers/identity.ts b/src/v2/providers/identity.ts index e2d5a54e1..e59db6590 100644 --- a/src/v2/providers/identity.ts +++ b/src/v2/providers/identity.ts @@ -44,7 +44,7 @@ export function beforeUserCreated( /** * Handles an event that is triggered before a user is created. - * @param opts - Object containing Function options + * @param opts - Object containing function options * @param handler - Event handler which is run every time before a user is created */ export function beforeUserCreated( @@ -60,8 +60,8 @@ export function beforeUserCreated( /** * Handles an event that is triggered before a user is created - * @param optsOrHandler - Either an object containing Function options, or an event handler (run before user creation) - * @param handler? - If defined, an wvent handler which is run every time before a user is created + * @param optsOrHandler - Either an object containing function options, or an event handler (run before user creation) + * @param handler? - If defined, an event handler which is run every time before a user is created */ export function beforeUserCreated( optsOrHandler: @@ -100,7 +100,7 @@ export function beforeUserSignedIn( /** * Handles an event that is triggered before a user is signed in. - * @param opts - Object containing Function options + * @param opts - Object containing function options * @param handler - Event handler which is run every time before a user is signed in */ export function beforeUserSignedIn( @@ -116,7 +116,7 @@ export function beforeUserSignedIn( /** * Handles an event that is triggered before a user is signed in. - * @param optsOrHandler - Either an object containing Function options, or an event handler (run before user signin) + * @param optsOrHandler - Either an object containing function options, or an event handler (run before user signin) * @param handler - Event handler which is run every time before a user is signed in */ export function beforeUserSignedIn(