mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-16 12:37:20 +00:00
* initial refactor * fixes * test secrets extraction * updated lock * fix secret schema * updated schemas, fixed tests, skipping flow tests for now * added validator for rjsf, hook form via standard schema * removed @sinclair/typebox * remove unneeded vite dep * fix jsonv literal on Field.tsx * fix schema import path * fix schema modals * fix schema modals * fix json field form, replaced auth form * initial waku * finalize waku example * fix jsonv-ts version * fix schema updates with falsy values * fix media api to respect options' init, improve types * checking media controller test * checking media controller test * checking media controller test * clean up mediacontroller test * added cookie option `partitioned`, as well as cors `origin` to be array, option to enable `credentials` (#214) * added cookie option `partitioned`, as well as cors `origin` to be array, option to enable `credentials` * fix server test * fix data api (updated jsonv-ts) * enhance cloudflare image optimization plugin with new options and explain endpoint (#215) * feat: add ability to serve static by using dynamic imports (#197) * feat: add ability to serve static by using dynamic imports * serveStaticViaImport: make manifest optional * serveStaticViaImport: add error log * refactor/imports (#217) * refactored core and core/utils imports * refactored core and core/utils imports * refactored media imports * refactored auth imports * refactored data imports * updated package json exports, fixed mm config * fix tests * feat/deno (#219) * update bun version * fix module manager's em reference * add basic deno example * finalize * docs: fumadocs migration (#185) * feat(docs): initialize documentation structure with Fumadocs * feat(docs): remove home route and move /docs route to /route * feat(docs): add redirect to /start page * feat(docs): migrate Getting Started chapters * feat(docs): migrate Usage and Extending chapters * feat(callout): add CalloutCaution, CalloutDanger, CalloutInfo, and CalloutPositive * feat(layout): add Discord and GitHub links to documentation layout * feat(docs): add integration chapters draft * feat(docs): add modules chapters draft * refactor(mdx-components): remove unused Icon import * refactor(StackBlitz): enhance type safety by using unknown instead of any * refactor(layout): update navigation mode to 'top' in layout configuration * feat(docs): add @iconify/react package * docs(mdx-components): add Icon component to MDX components list * feat(docs): update Next.js integration guide * feat(docs): update React Router integration guide * feat(docs): update Astro integration guide * feat(docs): update Vite integration guide * fix(docs): update package manager initialization commands * feat(docs): migrate Modules chapters * chore(docs): update package.json with new devDependencies * feat(docs): migrate Integration Runtimes chapters * feat(docs): update Database usage chapter * feat(docs): restructure documentation paths * chore(docs): clean up unused imports and files in documentation * style(layout): revert navigation mode to previous state * fix(docs): routing for documentation structure * feat(openapi): add API documentation generation from OpenAPI schema * feat(docs): add icons to documentation pages * chore(dependencies): remove unused content-collections packages * fix(types): fix type error for attachFile in source.ts * feat(redirects): update root redirect destination to '/start' * feat(search): add static search functionality * chore(dependencies): update fumadocs-core and fumadocs-ui to latest versions * feat(search): add Powered by Orama link * feat(generate-openapi): add error handling for missing OpenAPI schema * feat(scripts): add OpenAPI generation to build process * feat(config): enable dynamic redirects and rewrites in development mode * feat(layout): add GitHub token support for improved API rate limits * feat(redirects): add 301 redirects for cloudflare pages * feat(docs): add Vercel redirects configuration * feat(config): enable standalone output for development environment * chore(layout): adjust layout settings * refactor(package): clean up ajv dependency versions * feat(docs): add twoslash support * refactor(layout): update DocsLayout import and navigation configuration * chore(layout): clean up layout.tsx by commenting out GithubInfo * fix(Search): add locale to search initialization * chore(package): update fumadocs and orama to latest versions * docs: add menu items descriptions * feat(layout): add GitHub URL to the layout component * feat(docs): add AutoTypeTable component to MDX components * feat(app): implement AutoTypeTable rendering for AppEvents type * docs(layout): switch callouts back to default components * fix(config): use __filename and __dirname for module paths * docs: add note about node.js 22 requirement * feat(styles): add custom color variables for light and dark themes * docs: add S3 setup instructions for media module * docs: fix typos and indentation in media module docs * docs: add local media adapter example for Node.js * docs(media): add S3/R2 URL format examples and fix typo * docs: add cross-links to initial config and seeding sections * indent numbered lists content, clarified media serve locations * fix mediacontroller tests * feat(layout): add AnimatedGridPattern component for dynamic background * style(layout): configure fancy ToC style ('clerk') * fix(AnimatedGridPattern): correct strokeDasharray type * docs: actualize docs * feat: add favicon * style(cloudflare): format code examples * feat(layout): add Github and Discord footer icons * feat(footer): add SVG social media icons for GitHub and Discord * docs: adjusted auto type table, added llm functions * added static deployment to cloudflare workers * docs: change cf redirects to proxy *.mdx instead of redirecting --------- Co-authored-by: dswbx <dennis.senn@gmx.ch> Co-authored-by: cameronapak <cameronandrewpak@gmail.com> * build: improve build script * add missing exports, fix EntityTypescript imports * media: Dropzone: add programmatic upload, additional events, loading state * schema object: disable extended defaults to allow empty config values * Feat/new docs deploy (#224) * test * try fixing pm * try fixing pm * fix docs on imports, export events correctly --------- Co-authored-by: Tim Seriakov <59409712+timseriakov@users.noreply.github.com> Co-authored-by: cameronapak <cameronandrewpak@gmail.com>
290 lines
7.5 KiB
TypeScript
290 lines
7.5 KiB
TypeScript
import type { SafeUser } from "bknd";
|
|
import { AuthApi, type AuthApiOptions } from "auth/api/AuthApi";
|
|
import { DataApi, type DataApiOptions } from "data/api/DataApi";
|
|
import { decode } from "hono/jwt";
|
|
import { MediaApi, type MediaApiOptions } from "media/api/MediaApi";
|
|
import { SystemApi } from "modules/SystemApi";
|
|
import { omitKeys } from "core/utils";
|
|
import type { BaseModuleApiOptions } from "modules";
|
|
|
|
export type TApiUser = SafeUser;
|
|
|
|
export type ApiFetcher = (
|
|
input: RequestInfo | URL,
|
|
init?: RequestInit,
|
|
) => Response | Promise<Response>;
|
|
|
|
declare global {
|
|
interface Window {
|
|
__BKND__: {
|
|
user?: TApiUser;
|
|
};
|
|
}
|
|
}
|
|
|
|
type SubApiOptions<T extends BaseModuleApiOptions> = Omit<T, keyof BaseModuleApiOptions>;
|
|
|
|
export type ApiOptions = {
|
|
host?: string;
|
|
headers?: Headers;
|
|
key?: string;
|
|
storage?: {
|
|
getItem: (key: string) => string | undefined | null | Promise<string | undefined | null>;
|
|
setItem: (key: string, value: string) => void | Promise<void>;
|
|
removeItem: (key: string) => void | Promise<void>;
|
|
};
|
|
onAuthStateChange?: (state: AuthState) => void;
|
|
fetcher?: ApiFetcher;
|
|
verbose?: boolean;
|
|
verified?: boolean;
|
|
data?: SubApiOptions<DataApiOptions>;
|
|
auth?: SubApiOptions<AuthApiOptions>;
|
|
media?: SubApiOptions<MediaApiOptions>;
|
|
} & (
|
|
| {
|
|
token?: string;
|
|
user?: TApiUser;
|
|
}
|
|
| {
|
|
request: Request;
|
|
}
|
|
);
|
|
|
|
export type AuthState = {
|
|
token?: string;
|
|
user?: TApiUser;
|
|
verified: boolean;
|
|
};
|
|
|
|
export class Api {
|
|
private token?: string;
|
|
private user?: TApiUser;
|
|
private verified = false;
|
|
private token_transport: "header" | "cookie" | "none" = "header";
|
|
|
|
public system!: SystemApi;
|
|
public data!: DataApi;
|
|
public auth!: AuthApi;
|
|
public media!: MediaApi;
|
|
|
|
constructor(private options: ApiOptions = {}) {
|
|
// only mark verified if forced
|
|
this.verified = options.verified === true;
|
|
|
|
// prefer request if given
|
|
if ("request" in options && options.request) {
|
|
this.options.host = options.host ?? new URL(options.request.url).origin;
|
|
this.options.headers = options.headers ?? options.request.headers;
|
|
this.extractToken();
|
|
|
|
// then check for a token
|
|
} else if ("token" in options && options.token) {
|
|
this.token_transport = "header";
|
|
this.updateToken(options.token, { trigger: false });
|
|
|
|
// then check for an user object
|
|
} else if ("user" in options && options.user) {
|
|
this.token_transport = "none";
|
|
this.user = options.user;
|
|
this.verified = options.verified !== false;
|
|
} else {
|
|
this.extractToken();
|
|
}
|
|
|
|
this.buildApis();
|
|
}
|
|
|
|
get fetcher() {
|
|
return this.options.fetcher ?? fetch;
|
|
}
|
|
|
|
get baseUrl() {
|
|
return this.options.host ?? "http://localhost";
|
|
}
|
|
|
|
get tokenKey() {
|
|
return this.options.key ?? "auth";
|
|
}
|
|
|
|
private extractToken() {
|
|
// if token has to be extracted, it's never verified
|
|
this.verified = false;
|
|
|
|
if (this.options.headers) {
|
|
// try cookies
|
|
const cookieToken = getCookieValue(this.options.headers.get("cookie"), "auth");
|
|
if (cookieToken) {
|
|
this.token_transport = "cookie";
|
|
this.updateToken(cookieToken);
|
|
return;
|
|
}
|
|
|
|
// try authorization header
|
|
const headerToken = this.options.headers.get("authorization")?.replace("Bearer ", "");
|
|
if (headerToken) {
|
|
this.token_transport = "header";
|
|
this.updateToken(headerToken);
|
|
return;
|
|
}
|
|
} else if (this.storage) {
|
|
this.storage.getItem(this.tokenKey).then((token) => {
|
|
this.token_transport = "header";
|
|
this.updateToken(token ? String(token) : undefined);
|
|
});
|
|
}
|
|
}
|
|
|
|
private get storage() {
|
|
if (!this.options.storage) return null;
|
|
return {
|
|
getItem: async (key: string) => {
|
|
return await this.options.storage!.getItem(key);
|
|
},
|
|
setItem: async (key: string, value: string) => {
|
|
return await this.options.storage!.setItem(key, value);
|
|
},
|
|
removeItem: async (key: string) => {
|
|
return await this.options.storage!.removeItem(key);
|
|
},
|
|
};
|
|
}
|
|
|
|
updateToken(token?: string, opts?: { rebuild?: boolean; trigger?: boolean }) {
|
|
this.token = token;
|
|
this.verified = false;
|
|
|
|
if (token) {
|
|
this.user = omitKeys(decode(token).payload as any, ["iat", "iss", "exp"]) as any;
|
|
} else {
|
|
this.user = undefined;
|
|
}
|
|
|
|
if (this.storage) {
|
|
const key = this.tokenKey;
|
|
|
|
if (token) {
|
|
this.storage.setItem(key, token).then(() => {
|
|
this.options.onAuthStateChange?.(this.getAuthState());
|
|
});
|
|
} else {
|
|
this.storage.removeItem(key).then(() => {
|
|
this.options.onAuthStateChange?.(this.getAuthState());
|
|
});
|
|
}
|
|
} else {
|
|
if (opts?.trigger !== false) {
|
|
this.options.onAuthStateChange?.(this.getAuthState());
|
|
}
|
|
}
|
|
|
|
if (opts?.rebuild) this.buildApis();
|
|
}
|
|
|
|
private markAuthVerified(verfied: boolean) {
|
|
this.verified = verfied;
|
|
return this;
|
|
}
|
|
|
|
isAuthVerified(): boolean {
|
|
return this.verified;
|
|
}
|
|
|
|
getAuthState(): AuthState {
|
|
return {
|
|
token: this.token,
|
|
user: this.user,
|
|
verified: this.verified,
|
|
};
|
|
}
|
|
|
|
isAuthenticated(): boolean {
|
|
const { token, user } = this.getAuthState();
|
|
return !!token && !!user;
|
|
}
|
|
|
|
async getVerifiedAuthState(): Promise<AuthState> {
|
|
await this.verifyAuth();
|
|
return this.getAuthState();
|
|
}
|
|
|
|
async verifyAuth() {
|
|
if (!this.token) {
|
|
this.markAuthVerified(false);
|
|
return;
|
|
}
|
|
|
|
try {
|
|
const { ok, data } = await this.auth.me();
|
|
const user = data?.user;
|
|
if (!ok || !user) {
|
|
throw new Error();
|
|
}
|
|
|
|
this.user = user;
|
|
this.markAuthVerified(true);
|
|
} catch (e) {
|
|
this.markAuthVerified(false);
|
|
this.updateToken(undefined);
|
|
}
|
|
}
|
|
|
|
getUser(): TApiUser | null {
|
|
return this.user || null;
|
|
}
|
|
|
|
getParams() {
|
|
return Object.freeze({
|
|
host: this.baseUrl,
|
|
token: this.token,
|
|
headers: this.options.headers,
|
|
token_transport: this.token_transport,
|
|
verbose: this.options.verbose,
|
|
});
|
|
}
|
|
|
|
private buildApis() {
|
|
const baseParams = this.getParams();
|
|
const fetcher = this.options.fetcher;
|
|
|
|
this.system = new SystemApi(baseParams, fetcher);
|
|
this.data = new DataApi(
|
|
{
|
|
...baseParams,
|
|
...this.options.data,
|
|
},
|
|
fetcher,
|
|
);
|
|
this.auth = new AuthApi(
|
|
{
|
|
...baseParams,
|
|
credentials: this.options.storage ? "omit" : "include",
|
|
...this.options.auth,
|
|
onTokenUpdate: (token) => {
|
|
this.updateToken(token, { rebuild: true });
|
|
this.options.auth?.onTokenUpdate?.(token);
|
|
},
|
|
},
|
|
fetcher,
|
|
);
|
|
this.media = new MediaApi(
|
|
{
|
|
...baseParams,
|
|
...this.options.media,
|
|
},
|
|
fetcher,
|
|
);
|
|
}
|
|
}
|
|
|
|
function getCookieValue(cookies: string | null, name: string) {
|
|
if (!cookies) return null;
|
|
|
|
for (const cookie of cookies.split("; ")) {
|
|
const [key, value] = cookie.split("=");
|
|
if (key === name && value) {
|
|
return decodeURIComponent(value);
|
|
}
|
|
}
|
|
return null;
|
|
}
|