Files
supabase/apps/docs/features/helpers.fn.ts
Charis e46ab9c1a2 refactor: reading markdown docs files (#37774)
* refactor: reading markdown docs files

Refactor how Markdown docs files are read:
- Reuses the same logic across search index generation & page generation
- Improves the indexed content for search:
  - Stops removing MDX components, which often contain useful
    information like Admonitions
  - Denormalizes Partials and CodeSamples for more complete content

This is a prerequisite step for implementing the "Copy docs as Markdown"
functionality.

Only touches regular guides for now, not federated ones.

* fix: tailwind build error (#37728)

We changed to default to ESM imports a while ago, which means local
builds are now breaking because the Tailwind uses a require. Changed to
CJS for Tailwind config file. (I have no idea how this has been working
on Vercel all this time.)

* style: prettier
2025-08-13 11:37:14 -04:00

231 lines
6.2 KiB
TypeScript

import { extractMessageFromAnyError, MultiError } from '~/app/api/utils'
const EMPTY_ARRAY = new Array(0)
export function getEmptyArray() {
return EMPTY_ARRAY
}
export function deepFilterRec<T extends object>(
arr: Array<T>,
recKey: string,
filterFn: (item: T) => boolean
): Array<T> {
return arr.reduce((acc, elem) => {
if (!filterFn(elem)) return acc
if (recKey in elem && elem[recKey as keyof T]) {
const newSubitems = deepFilterRec(elem[recKey as keyof T] as Array<T>, recKey, filterFn)
const newElem = { ...elem, [recKey]: newSubitems }
if (newSubitems.length > 0 || filterFn(elem)) acc.push(newElem)
} else {
acc.push(elem)
}
return acc
}, [] as Array<T>)
}
export async function pluckPromise<T, K extends keyof T>(promise: Promise<T>, key: K) {
const data = await promise
return data[key]
}
export class Result<Ok, Error> {
constructor(private internal: { data: Ok; error: null } | { data: null; error: Error }) {}
static ok<Error = unknown, Ok = unknown>(data: Ok): Result<Ok, Error> {
return new Result<Ok, Error>({ data, error: null })
}
static error<Ok = unknown, Error = unknown>(error: Error): Result<Ok, Error> {
return new Result<Ok, Error>({ data: null, error })
}
static tryCatchSync<Ok, Error, Args extends Array<unknown>>(
fn: (...args: Args) => Ok,
onError: (error: unknown) => Error,
...args: Args
): Result<Ok, Error> {
try {
return Result.ok(fn(...args))
} catch (error: unknown) {
return Result.error(onError(error))
}
}
static async tryCatch<Ok, Error, Args extends Array<unknown>>(
fn: (...args: Args) => Promise<Ok>,
onError: (error: unknown) => Error,
...args: Args
): Promise<Result<Ok, Error>> {
try {
return Result.ok(await fn(...args))
} catch (error: unknown) {
return Result.error(onError(error))
}
}
static async tryCatchFlat<
Ok,
Args extends Array<unknown> = [],
OuterError = unknown,
InnerError = unknown,
>(
fn: (...args: Args) => Promise<Result<Ok, InnerError>>,
onError: (error: unknown) => OuterError | InnerError,
...args: Args
): Promise<Result<Ok, OuterError | InnerError>> {
try {
return await fn(...args)
} catch (error: unknown) {
return Result.error(onError(error))
}
}
static transposeArray<Ok, Error>(
array: Array<Result<Ok, Error>>
): Result<Array<Ok>, MultiError<Error>> {
let data: Array<Ok> = new Array(array.length)
let error: MultiError | null = null
for (const result of array) {
if (result.isOk()) {
data.push(result.internal.data!)
} else {
;(error ??= new MultiError('MultiError:')).appendError(
extractMessageFromAnyError(error),
result.internal.error
)
}
}
if (error) return Result.error(error)
return Result.ok(data)
}
isOk(): this is Result<Ok, never> {
return this.internal.error == null
}
map<Mapped>(fn: (data: Ok) => Mapped): Result<Mapped, Error> {
if (this.isOk()) return Result.ok(fn(this.internal.data!))
return this as unknown as Result<Mapped, Error>
}
async mapAsync<Mapped>(fn: (data: Ok) => Promise<Mapped>): Promise<Result<Mapped, Error>> {
if (this.isOk()) return Result.ok(await fn(this.internal.data!))
return this as unknown as Result<Mapped, Error>
}
mapError<MappedError>(fn: (error: Error) => MappedError): Result<Ok, MappedError> {
if (this.isOk()) return this as unknown as Result<Ok, MappedError>
return Result.error(fn(this.internal.error!))
}
flatMap<Mapped>(fn: (data: Ok) => Result<Mapped, Error>): Result<Mapped, Error> {
if (this.isOk()) return fn(this.internal.data!)
return this as unknown as Result<Mapped, Error>
}
flatMapAsync<Mapped>(
fn: (data: Ok) => Promise<Result<Mapped, Error>>
): Promise<Result<Mapped, Error>> {
if (this.isOk()) return fn(this.internal.data!)
return Promise.resolve(this as unknown as Result<Mapped, Error>)
}
match<Mapped, MappedError>(
onOk: (data: Ok) => Mapped,
onError: (error: Error) => MappedError
): Mapped | MappedError {
if (this.isOk()) return onOk(this.internal.data!)
return onError(this.internal.error!)
}
unwrap(): Ok {
if (!this.isOk()) {
throw new Error(`Unwrap called on Err: ${this.internal.error}`, {
cause: this.internal.error,
})
}
return this.internal.data!
}
unwrapOr(deflt: () => Ok): Ok {
if (this.isOk()) return this.internal.data!
return deflt()
}
unwrapError(): Error {
if (this.isOk()) {
throw new Error(`UnwrapError called on Ok`)
}
return this.internal.error!
}
unwrapErrorSafe(): Error | null {
return this.internal.error
}
unwrapEither(): Ok | Error {
if (this.isOk()) return this.unwrap()
return this.unwrapError()
}
join<OtherOk, OtherError>(
other: Result<OtherOk, OtherError>
): Result<[Ok, OtherOk], [Error, OtherError]> {
if (!this.isOk() || !other.isOk())
return Result.error([this.internal.error, other.internal.error]) as Result<
[Ok, OtherOk],
[Error, OtherError]
>
return Result.ok([this.internal.data!, other.internal.data!])
}
}
export class Both<Left, Right> {
private internal: {
left: Left
right: Right
}
constructor(left: Left, right: Right) {
this.internal = {
left,
right,
}
}
mapLeft<NewLeft>(fn: (left: Left) => NewLeft): Both<NewLeft, Right> {
return new Both(fn(this.internal.left), this.internal.right)
}
mapRight<NewRight>(fn: (right: Right) => NewRight): Both<Left, NewRight> {
return new Both(this.internal.left, fn(this.internal.right))
}
async mapLeftAsync<NewLeft>(fn: (left: Left) => Promise<NewLeft>): Promise<Both<NewLeft, Right>> {
const res = await fn(this.internal.left)
return new Both(res, this.internal.right)
}
unwrapLeft(): Left {
return this.internal.left
}
unwrapRight(): Right {
return this.internal.right
}
combine<Output>(fn: (left: Left, right: Right) => Output): Output {
return fn(this.internal.left, this.internal.right)
}
intoResult(): Result<Left, Right> {
if (this.internal.right) return Result.error(this.internal.right)
return Result.ok(this.internal.left)
}
}