@faable/auth-js 1.3.0 → 1.3.1

package/dist/lock/locks.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Provide your own global lock implementation instead of the default
+ * implementation. The function should acquire a lock for the duration of the
+ * `fn` async function, such that no other client instances will be able to
+ * hold it at the same time.
+ *
+ * @experimental
+ *
+ * @param name Name of the lock to be acquired.
+ * @param acquireTimeout If negative, no timeout should occur. If positive it
+ *                       should throw an Error with an `isAcquireTimeout`
+ *                       property set to true if the operation fails to be
+ *                       acquired after this much time (ms).
+ * @param fn The operation to execute when the lock is acquired.
+ */
+export type LockFunc = <R>(name: string, acquireTimeout: number, fn: () => Promise<R>) => Promise<R>;
+/**
+ * @experimental
+ */
+export declare const internals: {
+    /**
+     * @experimental
+     */
+    debug: boolean;
+};
+/**
+ * An error thrown when a lock cannot be acquired after some amount of time.
+ *
+ * Use the {@link #isAcquireTimeout} property instead of checking with `instanceof`.
+ */
+export declare abstract class LockAcquireTimeoutError extends Error {
+    readonly isAcquireTimeout = true;
+    constructor(message: string);
+}
+export declare class NavigatorLockAcquireTimeoutError extends LockAcquireTimeoutError {
+}
+/**
+ * Implements a global exclusive lock using the Navigator LockManager API. It
+ * is available on all browsers released after 2022-03-15 with Safari being the
+ * last one to release support. If the API is not available, this function will
+ * throw. Make sure you check availablility before configuring {@link
+ * GoTrueClient}.
+ *
+ * You can turn on debugging by setting the `supabase.gotrue-js.locks.debug`
+ * local storage item to `true`.
+ *
+ * Internals:
+ *
+ * Since the LockManager API does not preserve stack traces for the async
+ * function passed in the `request` method, a trick is used where acquiring the
+ * lock releases a previously started promise to run the operation in the `fn`
+ * function. The lock waits for that promise to finish (with or without error),
+ * while the function will finally wait for the result anyway.
+ *
+ * @param name Name of the lock to be acquired.
+ * @param acquireTimeout If negative, no timeout. If 0 an error is thrown if
+ *                       the lock can't be acquired without waiting. If positive, the lock acquire
+ *                       will time out after so many milliseconds. An error is
+ *                       a timeout if it has `isAcquireTimeout` set to true.
+ * @param fn The operation to run once the lock is acquired.
+ */
+export declare function navigatorLock<R>(name: string, acquireTimeout: number, fn: () => Promise<R>): Promise<R>;
+export declare function lockNoOp<R>(name: string, acquireTimeout: number, fn: () => Promise<R>): Promise<R>;

package/dist/utils.d.ts

@@ -0,0 +1,17 @@
+import { AuthenticationResult } from "./lib/types";
+export declare const parseAuthenticationResult: (queryString: string) => AuthenticationResult;
+export declare const createQueryParams: ({ clientId: client_id, ...params }: any) => string;
+/**
+ * @ignore
+ */
+export declare const getTokenIssuer: (issuer: string | undefined, domainUrl: string) => string;
+export declare const getDomain: (domainUrl: string) => string;
+export declare const encode: (value: string) => string;
+export declare const decode: (value: string) => string;
+export declare const urlDecodeB64: (input: string) => string;
+export declare const bufferToBase64UrlEncoded: (input: number[] | Uint8Array) => string;
+export declare const parseNumber: (value: any) => number | undefined;
+/**
+ * @ignore
+ */
+export declare const buildIsAuthenticatedCookieName: (clientId: string) => string;

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@faable/auth-js",
-  "main": "dist/index.js",
-  "version": "1.3.0",
+  "main": "dist/faableauth.js",
+  "types": "dist/entrypints/faableauth.d.ts",
+  "version": "1.3.1",
   "type": "module",
   "license": "SEE LICENSE.md",
   "author": "Marc Pomar <marc@faable.com>",