@clerk/types - npm Package Compare versions

Comparing version 2.0.0-alpha.0 to 2.0.0-alpha.1

dist/clerk.d.ts

@@ -144,24 +144,12 @@ import { EnvironmentResource } from '.';
      * Redirects to the configured sign in URL. Retrieved from {@link environment}.
-     * @deprecated Use the new {@link Clerk.redirectToSignIn}  instead;
-     * @param returnBack will appends a query string parameter to the sign in URL so the user can be redirected back to the current page. Defaults to false.
-     */
-    redirectToSignIn(returnBack?: boolean): Promise<unknown>;
-    /**
-     * Redirects to the configured sign in URL. Retrieved from {@link environment}.
      *
      * @param opts A {@link RedirectOptions} object
      */
-    redirectToSignIn(opts: RedirectOptions): Promise<unknown>;
+    redirectToSignIn(opts?: RedirectOptions): Promise<unknown>;
     /**
      * Redirects to the configured sign up URL. Retrieved from {@link environment}.
-     * @deprecated Use the new {@link Clerk.redirectToSignIn}  instead;
-     * @param returnBack will appends a query string parameter to the sign in URL so the user can be redirected back to the current page. Defaults to false.
-     */
-    redirectToSignUp(returnBack?: boolean): Promise<unknown>;
-    /**
-     * Redirects to the configured sign up URL. Retrieved from {@link environment}.
      *
      * @param opts A {@link RedirectOptions} object
      */
-    redirectToSignUp(opts: RedirectOptions): Promise<unknown>;
+    redirectToSignUp(opts?: RedirectOptions): Promise<unknown>;
     /**
@@ -218,6 +206,6 @@ * Redirects to the configured user profile URL. Retrieved from {@link environment}.
 export interface ClerkOptions {
-    selectInitialSession?: (client: ClientResource) => ActiveSessionResource | null;
+    authVersion?: 1 | 2;
     navigate?: (to: string) => Promise<unknown> | unknown;
     polling?: boolean;
-    authVersion?: 1 | 2;
+    selectInitialSession?: (client: ClientResource) => ActiveSessionResource | null;
     theme?: ClerkThemeOptions;
@@ -224,0 +212,0 @@ }

package.json

 {
   "name": "@clerk/types",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-alpha.1",
   "license": "MIT",
@@ -5,0 +5,0 @@ "description": "Clerk.dev Types",

src/clerk.ts

@@ -10,5 +10,3 @@ import { EnvironmentResource } from '.';
 export type UnsubscribeCallback = () => void;
-export type BeforeEmitCallback = (
-  session: ActiveSessionResource | null,
-) => void | Promise<any>;
+export type BeforeEmitCallback = (session: ActiveSessionResource | null) => void | Promise<any>;
 export type SignOutCallback = () => void | Promise<any>;
@@ -114,6 +112,3 @@
    */
-  mountUserButton: (
-    targetNode: HTMLDivElement,
-    userButtonProps?: UserButtonProps,
-  ) => void;
+  mountUserButton: (targetNode: HTMLDivElement, userButtonProps?: UserButtonProps) => void;
 
@@ -134,6 +129,3 @@ /**
    */
-  mountUserProfile: (
-    targetNode: HTMLDivElement,
-    userProfileProps?: UserProfileProps,
-  ) => void;
+  mountUserProfile: (targetNode: HTMLDivElement, userProfileProps?: UserProfileProps) => void;
 
@@ -183,27 +175,13 @@ /**
    * Redirects to the configured sign in URL. Retrieved from {@link environment}.
-   * @deprecated Use the new {@link Clerk.redirectToSignIn}  instead;
-   * @param returnBack will appends a query string parameter to the sign in URL so the user can be redirected back to the current page. Defaults to false.
-   */
-  redirectToSignIn(returnBack?: boolean): Promise<unknown>;
-
-  /**
-   * Redirects to the configured sign in URL. Retrieved from {@link environment}.
    *
    * @param opts A {@link RedirectOptions} object
    */
-  redirectToSignIn(opts: RedirectOptions): Promise<unknown>;
+  redirectToSignIn(opts?: RedirectOptions): Promise<unknown>;
 
   /**
    * Redirects to the configured sign up URL. Retrieved from {@link environment}.
-   * @deprecated Use the new {@link Clerk.redirectToSignIn}  instead;
-   * @param returnBack will appends a query string parameter to the sign in URL so the user can be redirected back to the current page. Defaults to false.
-   */
-  redirectToSignUp(returnBack?: boolean): Promise<unknown>;
-
-  /**
-   * Redirects to the configured sign up URL. Retrieved from {@link environment}.
    *
    * @param opts A {@link RedirectOptions} object
    */
-  redirectToSignUp(opts: RedirectOptions): Promise<unknown>;
+  redirectToSignUp(opts?: RedirectOptions): Promise<unknown>;
 
@@ -234,5 +212,3 @@ /**
    */
-  authenticateWithMetamask: (
-    params?: AuthenticateWithMetamaskParams,
-  ) => Promise<unknown>;
+  authenticateWithMetamask: (params?: AuthenticateWithMetamaskParams) => Promise<unknown>;
 
@@ -284,8 +260,6 @@ /**
 export interface ClerkOptions {
-  selectInitialSession?: (
-    client: ClientResource,
-  ) => ActiveSessionResource | null;
+  authVersion?: 1 | 2;
   navigate?: (to: string) => Promise<unknown> | unknown;
   polling?: boolean;
-  authVersion?: 1 | 2;
+  selectInitialSession?: (client: ClientResource) => ActiveSessionResource | null;
   theme?: ClerkThemeOptions;
@@ -292,0 +266,0 @@ }

No alert changes

Worsened metrics

Total package byte prevSize

141392

decreased by-1.22%

Lines of code

2920

decreased by-1.22%

No dependency changes