@stackframe/stack-shared 1.0.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Stackframe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/helpers/fetch-token.d.ts

@@ -0,0 +1 @@
+export declare const fetchTokenPrefix = "#stack-auth--if-you-see-this-you-probably-forgot-to-add-an-auth-provider----";

package/dist/helpers/fetch-token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-token.d.ts","sourceRoot":"","sources":["../../src/helpers/fetch-token.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,iFAAiF,CAAC"}

package/dist/helpers/fetch-token.js

@@ -0,0 +1 @@
+export const fetchTokenPrefix = "#stack-auth--if-you-see-this-you-probably-forgot-to-add-an-auth-provider----";

package/dist/helpers/password.d.ts

@@ -0,0 +1 @@
+export declare function getPasswordError(password: string): string | null;

package/dist/helpers/password.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"password.d.ts","sourceRoot":"","sources":["../../src/helpers/password.ts"],"names":[],"mappings":"AAoBA,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAsBhE"}

package/dist/helpers/password.js

@@ -0,0 +1,33 @@
+function checkPasswordTooShort(password) {
+    return password.length >= 8;
+}
+function checkPasswordTooLong(password) {
+    return password.length <= 64;
+}
+function checkPasswordCharacters(password) {
+    return /^[a-zA-Z0-9!@#$%^&*()_+?]+$/.test(password);
+}
+function checkPasswordContainsLetter(password) {
+    return /[a-zA-Z]/.test(password);
+}
+function checkPasswordContainsNumber(password) {
+    return /[0-9]/.test(password);
+}
+export function getPasswordError(password) {
+    if (!checkPasswordTooShort(password)) {
+        return "password must be at least 8 characters long";
+    }
+    if (!checkPasswordTooLong(password)) {
+        return "password must be at most 64 characters long";
+    }
+    if (!checkPasswordCharacters(password)) {
+        return "password must contain only letters, numbers, and the following special characters: !@#$%^&*()_+?";
+    }
+    if (!checkPasswordContainsLetter(password)) {
+        return "password must contain at least one letter";
+    }
+    if (!checkPasswordContainsNumber(password)) {
+        return "password must contain at least one number";
+    }
+    return null;
+}

package/dist/hooks/use-async-external-store.d.ts

@@ -0,0 +1,4 @@
+import { AsyncResult } from "../utils/results";
+export declare function useAsyncExternalStore<T>(subscribe: (callback: (t: T) => void) => (() => void)): AsyncResult<T, never> & {
+    status: "ok" | "pending";
+};

package/dist/hooks/use-async-external-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-async-external-store.d.ts","sourceRoot":"","sources":["../../src/hooks/use-async-external-store.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,IAAI,CAAC,GACpD,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG;IAAE,MAAM,EAAE,IAAI,GAAG,SAAS,CAAA;CAAE,CAkBtD"}

package/dist/hooks/use-async-external-store.js

@@ -0,0 +1,20 @@
+import { useEffect, useState } from "react";
+import { AsyncResult } from "../utils/results";
+export function useAsyncExternalStore(subscribe) {
+    // sure, the "sync" in useSyncExternalStore refers to "synchronize a store" and not "sync/async", but it's too good of a name to pass up on
+    const [isAvailable, setIsAvailable] = useState(false);
+    const [value, setValue] = useState();
+    useEffect(() => {
+        const unsubscribe = subscribe((value) => {
+            setValue(() => value);
+            setIsAvailable(() => true);
+        });
+        return unsubscribe;
+    }, [subscribe]);
+    if (isAvailable) {
+        return AsyncResult.ok(value);
+    }
+    else {
+        return AsyncResult.pending();
+    }
+}

package/dist/hooks/use-strict-memo.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Like memo, but minimizes recomputation of the value at all costs (instead of useMemo which recomputes whenever the renderer feels like it).
+ *
+ * The most recent value will be kept from garbage collection until one of the dependencies becomes unreachable. This may be true even after the component no longer renders. Be wary of memory leaks.
+ */
+export declare function useStrictMemo<T>(callback: () => T, dependencies: any[]): T;

package/dist/hooks/use-strict-memo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-strict-memo.d.ts","sourceRoot":"","sources":["../../src/hooks/use-strict-memo.tsx"],"names":[],"mappings":"AA8CA;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,YAAY,EAAE,GAAG,EAAE,GAAG,CAAC,CAkB1E"}

package/dist/hooks/use-strict-memo.js

@@ -0,0 +1,64 @@
+import { useId, useInsertionEffect } from "react";
+import { Result } from "../utils/results";
+const cached = new Map();
+function unwrapFromInner(dependencies, inner) {
+    if ((dependencies.length === 0) !== ("isNotNestedMap" in inner)) {
+        return Result.error(undefined);
+    }
+    if ("isNotNestedMap" in inner) {
+        if (dependencies.length === 0) {
+            return Result.ok(inner.value);
+        }
+        else {
+            return Result.error(undefined);
+        }
+    }
+    else {
+        if (dependencies.length === 0) {
+            return Result.error(undefined);
+        }
+        else {
+            const [key, ...rest] = dependencies;
+            const newInner = inner.get(key);
+            if (!newInner) {
+                return Result.error(undefined);
+            }
+            return unwrapFromInner(rest, newInner);
+        }
+    }
+}
+function wrapToInner(dependencies, value) {
+    if (dependencies.length === 0) {
+        return { isNotNestedMap: true, value };
+    }
+    const [key, ...rest] = dependencies;
+    const inner = wrapToInner(rest, value);
+    const isObject = (typeof key === "object" && key !== null);
+    const isUnregisteredSymbol = (typeof key === "symbol" && Symbol.keyFor(key) === undefined);
+    const isWeak = isObject || isUnregisteredSymbol;
+    const mapType = isWeak ? WeakMap : Map;
+    return new mapType([[key, inner]]);
+}
+/**
+ * Like memo, but minimizes recomputation of the value at all costs (instead of useMemo which recomputes whenever the renderer feels like it).
+ *
+ * The most recent value will be kept from garbage collection until one of the dependencies becomes unreachable. This may be true even after the component no longer renders. Be wary of memory leaks.
+ */
+export function useStrictMemo(callback, dependencies) {
+    const id = useId();
+    useInsertionEffect(() => {
+        return () => {
+            cached.delete(id);
+        };
+    }, [id]);
+    const c = cached.get(id);
+    if (c) {
+        const unwrapped = unwrapFromInner(dependencies, c);
+        if (unwrapped.status === "ok") {
+            return unwrapped.data;
+        }
+    }
+    const value = callback();
+    cached.set(id, wrapToInner(dependencies, value));
+    return value;
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { StackClientInterface, UserJson as UserJson, UserCustomizableJson, ClientProjectJson, ProjectJson, OauthProviderConfigJson, getProductionModeErrors, } from "./interface/clientInterface";
+export { StackServerInterface, ServerUserJson, ServerUserCustomizableJson, } from "./interface/serverInterface";
+export { StackAdminInterface, ApiKeySetBase, ApiKeySetBaseJson, ApiKeySetFirstView, ApiKeySetFirstViewJson, ApiKeySetSummary, ApiKeySetSummaryJson, } from "./interface/adminInterface";
+export { fetchTokenPrefix } from "./helpers/fetch-token";

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,QAAQ,IAAI,QAAQ,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,WAAW,EACX,uBAAuB,EACvB,uBAAuB,GACxB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,oBAAoB,EACpB,cAAc,EACd,0BAA0B,GAC3B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { StackClientInterface, getProductionModeErrors, } from "./interface/clientInterface";
+export { StackServerInterface, } from "./interface/serverInterface";
+export { StackAdminInterface, } from "./interface/adminInterface";
+export { fetchTokenPrefix } from "./helpers/fetch-token";

package/dist/interface/adminInterface.d.ts

@@ -0,0 +1,88 @@
+import { ServerAuthApplicationOptions, StackServerInterface } from "./serverInterface";
+import { AsyncValueCache } from "../utils/caches";
+import { ProjectJson, TokenStore } from "./clientInterface";
+export type AdminAuthApplicationOptions = Readonly<ServerAuthApplicationOptions & ({
+    superSecretAdminKey: string;
+} | {
+    internalAdminAccessToken: string;
+})>;
+export type ApiKeySetBase = Readonly<{
+    id: string;
+    description: string;
+    expiresAt: Date;
+    manuallyRevokedAt: Date | null;
+    createdAt: Date;
+    isValid(): boolean;
+    whyInvalid(): "expired" | "manually-revoked" | null;
+}>;
+export type ApiKeySetBaseJson = Readonly<{
+    id: string;
+    description: string;
+    expiresAtMillis: number;
+    manuallyRevokedAtMillis: number | null;
+    createdAtMillis: number;
+}>;
+export type ApiKeySetFirstView = Readonly<ApiKeySetBase & {
+    publishableClientKey?: string;
+    secretServerKey?: string;
+    superSecretAdminKey?: string;
+}>;
+export type ApiKeySetFirstViewJson = Readonly<ApiKeySetBaseJson & {
+    publishableClientKey?: string;
+    secretServerKey?: string;
+    superSecretAdminKey?: string;
+}>;
+export type ApiKeySetSummary = Readonly<ApiKeySetBase & {
+    publishableClientKey: null | {
+        lastFour: string;
+    };
+    secretServerKey: null | {
+        lastFour: string;
+    };
+    superSecretAdminKey: null | {
+        lastFour: string;
+    };
+}>;
+export type ApiKeySetSummaryJson = Readonly<ApiKeySetBaseJson & {
+    publishableClientKey: null | {
+        lastFour: string;
+    };
+    secretServerKey: null | {
+        lastFour: string;
+    };
+    superSecretAdminKey: null | {
+        lastFour: string;
+    };
+}>;
+export declare class StackAdminInterface extends StackServerInterface {
+    readonly options: AdminAuthApplicationOptions;
+    readonly projectCache: AsyncValueCache<ProjectJson>;
+    constructor(options: AdminAuthApplicationOptions);
+    protected sendAdminRequest(path: string, options: RequestInit, tokenStore: TokenStore | null): Promise<Response & {
+        usedTokens: Readonly<{
+            refreshToken: string | null;
+            accessToken: string | null;
+        }>;
+    }>;
+    refreshProject(): Promise<void>;
+    getProject(): Promise<ProjectJson>;
+    updateProject(update: {
+        isProductionMode?: boolean;
+        config?: {
+            domains?: {
+                domain: string;
+                handlerPath: string;
+            }[];
+        };
+    }): Promise<ProjectJson>;
+    createApiKeySet(options: {
+        hasPublishableClientKey: boolean;
+        hasSecretServerKey: boolean;
+        hasSuperSecretAdminKey: boolean;
+        expiresAt: Date;
+        description: string;
+    }): Promise<ApiKeySetFirstView>;
+    listApiKeySets(): Promise<ApiKeySetSummary[]>;
+    revokeApiKeySetById(id: string): Promise<void>;
+    getApiKeySet(id: string, tokenStore: TokenStore): Promise<ApiKeySetSummary>;
+}

package/dist/interface/adminInterface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adminInterface.d.ts","sourceRoot":"","sources":["../../src/interface/adminInterface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACvF,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAG5D,MAAM,MAAM,2BAA2B,GAAG,QAAQ,CAChD,4BAA4B,GAC5B,CACI;IACA,mBAAmB,EAAE,MAAM,CAAC;CAC7B,GACC;IACA,wBAAwB,EAAE,MAAM,CAAC;CAClC,CACF,CACF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,IAAI,CAAC;IAChB,iBAAiB,EAAE,IAAI,GAAG,IAAI,CAAC;IAC/B,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,IAAI,OAAO,CAAC;IACnB,UAAU,IAAI,SAAS,GAAG,kBAAkB,GAAG,IAAI,CAAC;CACrD,CAAC,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC,CAAA;AAEF,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CACvC,aAAa,GAAG;IACd,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CACF,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,QAAQ,CAC3C,iBAAiB,GAAG;IAClB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CACF,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CACrC,aAAa,GAAG;IACd,oBAAoB,EAAE,IAAI,GAAG;QAC3B,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,eAAe,EAAE,IAAI,GAAG;QACtB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,mBAAmB,EAAE,IAAI,GAAG;QAC1B,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CACzC,iBAAiB,GAAG;IAClB,oBAAoB,EAAE,IAAI,GAAG;QAC3B,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,eAAe,EAAE,IAAI,GAAG;QACtB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,mBAAmB,EAAE,IAAI,GAAG;QAC1B,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH,CACF,CAAA;AAED,qBAAa,mBAAoB,SAAQ,oBAAoB;aAG/B,OAAO,EAAE,2BAA2B;IAFhE,SAAgB,YAAY,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;gBAE/B,OAAO,EAAE,2BAA2B;cAOhD,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,GAAG,IAAI;;;;;;IAe5F,cAAc;IAOd,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC;IASlC,aAAa,CACjB,MAAM,EAAE;QACN,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,MAAM,CAAC,EAAE;YACP,OAAO,CAAC,EAAE;gBACR,MAAM,EAAE,MAAM,CAAC;gBACf,WAAW,EAAE,MAAM,CAAC;aACrB,EAAE,CAAC;SACL,CAAC;KACH,GACA,OAAO,CAAC,WAAW,CAAC;IAgBjB,eAAe,CACnB,OAAO,EAAE;QACP,uBAAuB,EAAE,OAAO,CAAC;QACjC,kBAAkB,EAAE,OAAO,CAAC;QAC5B,sBAAsB,EAAE,OAAO,CAAC;QAChC,SAAS,EAAE,IAAI,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;KACrB,GACA,OAAO,CAAC,kBAAkB,CAAC;IAexB,cAAc,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAM7C,mBAAmB,CAAC,EAAE,EAAE,MAAM;IAe9B,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAIlF"}

package/dist/interface/adminInterface.js

@@ -0,0 +1,109 @@
+import { StackServerInterface } from "./serverInterface";
+import { AsyncValueCache } from "../utils/caches";
+import { throwErr } from "../utils/errors";
+export class StackAdminInterface extends StackServerInterface {
+    options;
+    projectCache;
+    constructor(options) {
+        super(options);
+        this.options = options;
+        this.projectCache = new AsyncValueCache(async () => {
+            return await this.getProject() ?? throwErr("Can't fetch project because it was not found");
+        });
+    }
+    async sendAdminRequest(path, options, tokenStore) {
+        return await this.sendServerRequest(path, {
+            ...options,
+            headers: {
+                "x-stack-super-secret-admin-key": "superSecretAdminKey" in this.options ? this.options.superSecretAdminKey : "",
+                ...options.headers,
+            },
+        }, tokenStore);
+    }
+    async refreshProject() {
+        await Promise.all([
+            super.refreshProject(),
+            this.projectCache.refresh(),
+        ]);
+    }
+    async getProject() {
+        const response = await this.sendAdminRequest("/projects/" + encodeURIComponent(this.projectId), {}, null);
+        return await response.json();
+    }
+    async updateProject(update) {
+        const response = await this.sendAdminRequest("/projects/" + encodeURIComponent(this.projectId), {
+            method: "PUT",
+            headers: {
+                "content-type": "application/json",
+            },
+            body: JSON.stringify(update),
+        }, null);
+        await this.refreshProject();
+        return await response.json();
+    }
+    async createApiKeySet(options) {
+        const response = await this.sendServerRequest("/api-keys", {
+            method: "POST",
+            headers: {
+                "content-type": "application/json",
+            },
+            body: JSON.stringify(options),
+        }, null);
+        return createApiKeySetFirstViewFromJson(await response.json());
+    }
+    async listApiKeySets() {
+        const response = await this.sendAdminRequest("/api-keys", {}, null);
+        const json = await response.json();
+        return json.map((k) => createApiKeySetSummaryFromJson(k));
+    }
+    async revokeApiKeySetById(id) {
+        await this.sendAdminRequest(`/api-keys/${id}`, {
+            method: "PUT",
+            headers: {
+                "content-type": "application/json",
+            },
+            body: JSON.stringify({
+                revoke: true,
+            }),
+        }, null);
+    }
+    async getApiKeySet(id, tokenStore) {
+        const response = await this.sendAdminRequest(`/api-keys/${id}`, {}, tokenStore);
+        return await response.json();
+    }
+}
+function createApiKeySetBaseFromJson(data) {
+    return {
+        id: data.id,
+        description: data.description,
+        expiresAt: new Date(data.expiresAtMillis),
+        manuallyRevokedAt: data.manuallyRevokedAtMillis ? new Date(data.manuallyRevokedAtMillis) : null,
+        createdAt: new Date(data.createdAtMillis),
+        isValid() {
+            return this.whyInvalid() === null;
+        },
+        whyInvalid() {
+            if (this.expiresAt.getTime() < Date.now())
+                return "expired";
+            if (this.manuallyRevokedAt)
+                return "manually-revoked";
+            return null;
+        },
+    };
+}
+function createApiKeySetSummaryFromJson(data) {
+    return {
+        ...createApiKeySetBaseFromJson(data),
+        publishableClientKey: data.publishableClientKey ? { lastFour: data.publishableClientKey.lastFour } : null,
+        secretServerKey: data.secretServerKey ? { lastFour: data.secretServerKey.lastFour } : null,
+        superSecretAdminKey: data.superSecretAdminKey ? { lastFour: data.superSecretAdminKey.lastFour } : null,
+    };
+}
+function createApiKeySetFirstViewFromJson(data) {
+    return {
+        ...createApiKeySetBaseFromJson(data),
+        publishableClientKey: data.publishableClientKey,
+        secretServerKey: data.secretServerKey,
+        superSecretAdminKey: data.superSecretAdminKey,
+    };
+}

package/dist/interface/clientInterface.d.ts

@@ -0,0 +1,134 @@
+import { ReadonlyJson, SignInErrorCode, SignUpErrorCode, EmailVerificationLinkErrorCode, PasswordResetLinkErrorCode } from "../utils/types";
+import { Result } from "../utils/results";
+import { AsyncCache, AsyncValueCache } from '../utils/caches';
+import { AsyncStore } from '../utils/stores';
+export type UserCustomizableJson = {
+    readonly projectId: string;
+    readonly displayName: string | null;
+    readonly clientMetadata: ReadonlyJson;
+};
+export type UserJson = UserCustomizableJson & {
+    readonly id: string;
+    readonly primaryEmail: string | null;
+    readonly primaryEmailVerified: boolean;
+    readonly displayName: string | null;
+    readonly clientMetadata: ReadonlyJson;
+    readonly profileImageUrl: string | null;
+    readonly signedUpAtMillis: number;
+};
+export type ClientProjectJson = {
+    readonly id: string;
+    readonly oauthProviders: readonly {
+        id: string;
+    }[];
+};
+export type ClientInterfaceOptions = {
+    readonly baseUrl: string;
+    readonly projectId: string;
+} & ({
+    readonly publishableClientKey: string;
+} | {
+    readonly internalAdminAccessToken: string;
+});
+export type TokenStore = AsyncStore<TokenObject>;
+export type TokenObject = Readonly<{
+    refreshToken: string | null;
+    accessToken: string | null;
+}>;
+export type ProjectJson = Readonly<{
+    id: string;
+    displayName: string;
+    description?: string;
+    createdAtMillis: number;
+    userCount: number;
+    isProductionMode: boolean;
+    evaluatedConfig: {
+        id: string;
+        allowLocalhost: boolean;
+        oauthProviders: OauthProviderConfigJson[];
+        emailConfig?: EmailConfigJson;
+        domains: DomainConfigJson[];
+    };
+}>;
+export type OauthProviderConfigJson = {
+    id: string;
+} & ({
+    type: "shared-github" | "shared-google" | "shared-facebook" | "shared-slack" | "shared-twitter" | "shared-linkedin" | "shared-microsoft";
+} | {
+    type: "github" | "facebook" | "slack" | "twitter" | "linkedin" | "google" | "microsoft";
+    clientId: string;
+    clientSecret: string;
+    tenantId?: string;
+});
+export type EmailConfigJson = ({
+    type: "standard";
+    senderName: string;
+    senderEmail: string;
+    host: string;
+    port: number;
+    username: string;
+    password: string;
+} | {
+    type: "shared";
+    senderName: string;
+});
+export type DomainConfigJson = {
+    domain: string;
+    handlerPath: string;
+};
+export declare class StackClientInterface {
+    readonly options: ClientInterfaceOptions;
+    readonly currentUserCache: AsyncCache<TokenStore, UserJson | null>;
+    readonly clientProjectCache: AsyncValueCache<ClientProjectJson>;
+    constructor(options: ClientInterfaceOptions);
+    get projectId(): string;
+    getSessionCookieName(): string;
+    getApiUrl(): string;
+    refreshUser(tokenStore: TokenStore): Promise<void>;
+    refreshProject(): Promise<void>;
+    protected refreshAccessToken(tokenStore: TokenStore): Promise<void>;
+    protected sendClientRequest(path: string, requestOptions: RequestInit, tokenStoreOrNull: TokenStore | null): Promise<Response & {
+        usedTokens: Readonly<{
+            refreshToken: string | null;
+            accessToken: string | null;
+        }>;
+    }>;
+    protected sendClientRequestAndCatchKnownError<E>(path: string, requestOptions: RequestInit, tokenStoreOrNull: TokenStore | null, errorCodes: string[]): Promise<({
+        status: "ok";
+        data: Response & {
+            usedTokens: Readonly<{
+                refreshToken: string | null;
+                accessToken: string | null;
+            }>;
+        };
+    } & {
+        status: "ok";
+    }) | ({
+        status: "error";
+        error: E;
+    } & {
+        status: "error";
+    })>;
+    private sendClientRequestInner;
+    sendForgotPasswordEmail(email: string, redirectUrl: string): Promise<PasswordResetLinkErrorCode | undefined>;
+    resetPassword(options: {
+        password: string;
+        code: string;
+    }): Promise<PasswordResetLinkErrorCode | undefined>;
+    verifyPasswordResetCode(code: string): Promise<PasswordResetLinkErrorCode | undefined>;
+    verifyEmail(code: string): Promise<EmailVerificationLinkErrorCode | undefined>;
+    signInWithCredential(email: string, password: string, tokenStore: TokenStore): Promise<SignInErrorCode | undefined>;
+    signUpWithCredential(email: string, password: string, emailVerificationRedirectUrl: string, tokenStore: TokenStore): Promise<SignUpErrorCode | undefined>;
+    getOauthUrl(provider: string, redirectUrl: string, codeChallenge: string, state: string): Promise<string>;
+    callOauthCallback(oauthParams: URLSearchParams, redirectUri: string, codeVerifier: string, state: string, tokenStore: TokenStore): Promise<void>;
+    signOut(tokenStore: TokenStore): Promise<void>;
+    getClientUserByToken(tokenStore: TokenStore): Promise<Result<UserJson>>;
+    getClientProject(): Promise<Result<ClientProjectJson>>;
+    setClientUserCustomizableData(update: Partial<UserCustomizableJson>, tokenStore: TokenStore): Promise<void>;
+    listProjects(tokenStore: TokenStore): Promise<ProjectJson[]>;
+    createProject(project: Pick<ProjectJson, "displayName" | "description">, tokenStore: TokenStore): Promise<ProjectJson>;
+}
+export declare function getProductionModeErrors(project: ProjectJson): {
+    errorMessage: string;
+    fixUrlRelative: string;
+}[];

package/dist/interface/clientInterface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientInterface.d.ts","sourceRoot":"","sources":["../../src/interface/clientInterface.ts"],"names":[],"mappings":"AAGA,OAAO,EAEL,YAAY,EAEZ,eAAe,EACf,eAAe,EAKf,8BAA8B,EAG9B,0BAA0B,EAC3B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAE9D,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,cAAc,EAAE,YAAY,CAAC;CACvC,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,oBAAoB,GAAG;IAC5C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC;IACvC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,QAAQ,CAAC,cAAc,EAAE,YAAY,CAAC;IACtC,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,cAAc,EAAE,SAAS;QAChC,EAAE,EAAE,MAAM,CAAC;KACZ,EAAE,CAAC;CACL,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B,GAAG,CAAC;IACH,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACvC,GAAG;IACF,QAAQ,CAAC,wBAAwB,EAAE,MAAM,CAAC;CAC3C,CAAC,CAAC;AAOH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;AAEjD,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC;IACjC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAC,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,eAAe,EAAE;QACf,EAAE,EAAE,MAAM,CAAC;QACX,cAAc,EAAE,OAAO,CAAC;QACxB,cAAc,EAAE,uBAAuB,EAAE,CAAC;QAC1C,WAAW,CAAC,EAAE,eAAe,CAAC;QAC9B,OAAO,EAAE,gBAAgB,EAAE,CAAC;KAC7B,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;CACZ,GAAG,CACA;IACA,IAAI,EACA,eAAe,GACf,eAAe,GACf,iBAAiB,GACjB,cAAc,GACd,gBAAgB,GAChB,iBAAiB,GACjB,kBAAkB,CAAC;CACxB,GACC;IACA,IAAI,EACA,QAAQ,GACR,UAAU,GACV,OAAO,GACP,SAAS,GACT,UAAU,GACV,QAAQ,GACR,WAAW,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CACF,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,CAC5B;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB,GACC;IACA,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB,CACF,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAA;AAED,qBAAa,oBAAoB;aAMH,OAAO,EAAE,sBAAsB;IAH3D,SAAgB,gBAAgB,EAAE,UAAU,CAAC,UAAU,EAAE,QAAQ,GAAG,IAAI,CAAC,CAAC;IAC1E,SAAgB,kBAAkB,EAAE,eAAe,CAAC,iBAAiB,CAAC,CAAC;gBAE3C,OAAO,EAAE,sBAAsB;IAgB3D,IAAI,SAAS,WAEZ;IAED,oBAAoB;IAIpB,SAAS;IAIH,WAAW,CAAC,UAAU,EAAE,UAAU;IAIlC,cAAc;cAIJ,kBAAkB,CAAC,UAAU,EAAE,UAAU;cAoEzC,iBAAiB,CAC/B,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,WAAW,EAC3B,gBAAgB,EAAE,UAAU,GAAG,IAAI;;;;;;cAgBrB,mCAAmC,CAAC,CAAC,EACnD,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,WAAW,EAC3B,gBAAgB,EAAE,UAAU,GAAG,IAAI,EACnC,UAAU,EAAE,MAAM,EAAE;;;;;;;;;;;;;;;;YAYR,sBAAsB;IAuE9B,uBAAuB,CAC3B,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC;IAuB5C,aAAa,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC;IAmB3G,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC;IAsBtF,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,8BAA8B,GAAG,SAAS,CAAC;IAqB9E,oBAAoB,CACxB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IA6BjC,oBAAoB,CACxB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,4BAA4B,EAAE,MAAM,EACpC,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,eAAe,GAAG,SAAS,CAAC;IA8BjC,WAAW,CACf,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC;IA0BZ,iBAAiB,CACrB,WAAW,EAAE,eAAe,EAC5B,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,UAAU;IAiDlB,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAuB9C,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAWvE,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAOtD,6BAA6B,CAAC,MAAM,EAAE,OAAO,CAAC,oBAAoB,CAAC,EAAE,UAAU,EAAE,UAAU;IAe3F,YAAY,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAU5D,aAAa,CACjB,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,aAAa,CAAC,EACzD,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,WAAW,CAAC;CAmBxB;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,WAAW,GAAG;IAAE,YAAY,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAAE,EAAE,CAqChH"}