@palbase/backend 3.0.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{chunk-B7EUJP5W.js → chunk-EG7TTYHY.js} +113 -3
- package/dist/chunk-EG7TTYHY.js.map +1 -0
- package/dist/{chunk-PHAFZGHN.js → chunk-WUQO76NW.js} +26 -19
- package/dist/chunk-WUQO76NW.js.map +1 -0
- package/dist/db/index.cjs +117 -2
- package/dist/db/index.cjs.map +1 -1
- package/dist/db/index.d.cts +2 -2
- package/dist/db/index.d.ts +2 -2
- package/dist/db/index.js +11 -1
- package/dist/{endpoint-DJ98tQd6.d.cts → endpoint-2d_DpASt.d.cts} +92 -56
- package/dist/{endpoint-DJ98tQd6.d.ts → endpoint-2d_DpASt.d.ts} +92 -56
- package/dist/{index-CXUs9iTQ.d.ts → index-DZW9CjiY.d.ts} +210 -41
- package/dist/{index-CZAwpQE1.d.cts → index-DzRFS3Tl.d.cts} +210 -41
- package/dist/index.cjs +371 -42
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +88 -215
- package/dist/index.d.ts +88 -215
- package/dist/index.js +217 -21
- package/dist/index.js.map +1 -1
- package/dist/test/index.cjs +34 -19
- package/dist/test/index.cjs.map +1 -1
- package/dist/test/index.d.cts +1 -1
- package/dist/test/index.d.ts +1 -1
- package/dist/test/index.js +10 -2
- package/dist/test/index.js.map +1 -1
- package/docs/README.md +11 -11
- package/docs/database.md +40 -0
- package/docs/endpoints.md +98 -92
- package/docs/errors.md +37 -30
- package/docs/getting-started.md +24 -20
- package/docs/llms-full.txt +401 -235
- package/docs/routing.md +39 -45
- package/docs/schema.md +134 -23
- package/docs/services.md +14 -10
- package/package.json +2 -2
- package/dist/chunk-B7EUJP5W.js.map +0 -1
- package/dist/chunk-PHAFZGHN.js.map +0 -1
package/dist/db/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { C as ColumnBuilder, a as ColumnDef, b as ColumnMap, c as ColumnType, I as InsertShape, O as OnDeleteAction, R as RowShape, S as SchemaDef,
|
|
1
|
+
export { C as ColumnBuilder, a as ColumnDef, b as ColumnMap, c as ColumnType, d as EXTENSION_DEPENDENCIES, e as EnvServiceDatabase, E as EnvTypedDatabase, I as InsertShape, O as OnDeleteAction, P as PALBASE_EXTENSIONS, i as PalbaseExtension, j as PolicyBuilder, k as PolicyCommand, l as PolicyDef, m as PolicyMode, R as RowShape, S as SchemaDef, n as SchemaInput, T as TableDef, o as TableInput, p as TypedDB, q as TypedTable, r as TypedTx, s as boolean, t as defineSchema, u as enumType, v as integer, w as isPalbaseExtension, x as jsonb, y as makeTypedDB, z as policy, A as text, B as timestamp, D as uuid } from '../index-DZW9CjiY.js';
|
|
2
2
|
import './env.js';
|
|
3
|
-
import '../endpoint-
|
|
3
|
+
import '../endpoint-2d_DpASt.js';
|
|
4
4
|
import 'zod';
|
package/dist/db/index.js
CHANGED
|
@@ -1,21 +1,31 @@
|
|
|
1
1
|
import {
|
|
2
|
+
EXTENSION_DEPENDENCIES,
|
|
3
|
+
PALBASE_EXTENSIONS,
|
|
4
|
+
PolicyBuilder,
|
|
2
5
|
boolean,
|
|
3
6
|
defineSchema,
|
|
4
7
|
enumType,
|
|
5
8
|
integer,
|
|
9
|
+
isPalbaseExtension,
|
|
6
10
|
jsonb,
|
|
7
11
|
makeTypedDB,
|
|
12
|
+
policy,
|
|
8
13
|
text,
|
|
9
14
|
timestamp,
|
|
10
15
|
uuid
|
|
11
|
-
} from "../chunk-
|
|
16
|
+
} from "../chunk-EG7TTYHY.js";
|
|
12
17
|
export {
|
|
18
|
+
EXTENSION_DEPENDENCIES,
|
|
19
|
+
PALBASE_EXTENSIONS,
|
|
20
|
+
PolicyBuilder,
|
|
13
21
|
boolean,
|
|
14
22
|
defineSchema,
|
|
15
23
|
enumType,
|
|
16
24
|
integer,
|
|
25
|
+
isPalbaseExtension,
|
|
17
26
|
jsonb,
|
|
18
27
|
makeTypedDB,
|
|
28
|
+
policy,
|
|
19
29
|
text,
|
|
20
30
|
timestamp,
|
|
21
31
|
uuid
|
|
@@ -49,20 +49,17 @@ declare function defineMiddleware(fn: MiddlewareHandler): MiddlewareHandler;
|
|
|
49
49
|
|
|
50
50
|
/** HTTP error with structured error response format.
|
|
51
51
|
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* `errors` map (`defineHandler`). The endpoint's OpenAPI spec describes
|
|
59
|
-
* each one, and the CLI codegen emits a typed `<Endpoint>.Error` enum so
|
|
60
|
-
* iOS callers can `catch <Endpoint>.Error.<case>` directly.
|
|
52
|
+
* The base class for the throwable error classes (`PalError`, `Conflict`,
|
|
53
|
+
* `NotFound`, …). Construct one directly with `throw new HttpError(404,
|
|
54
|
+
* "todo_not_found", "No such todo")`, or throw a named subclass
|
|
55
|
+
* (`throw new NotFound("todo not found")`). The runtime catches any `HttpError`
|
|
56
|
+
* and emits the standard envelope; on the wire (and to iOS) it surfaces as
|
|
57
|
+
* `BackendError.server(code, status, message, requestId)`.
|
|
61
58
|
*
|
|
62
59
|
* The optional `data` field carries a structured payload alongside the
|
|
63
|
-
* standard envelope —
|
|
64
|
-
* (e.g. `
|
|
65
|
-
* enum's associated value.
|
|
60
|
+
* standard envelope — for errors that need to ship extra context
|
|
61
|
+
* (e.g. `new Conflict("locked", "title_locked", { retryAfter: 30 })`). It rides
|
|
62
|
+
* through to the iOS typed enum's associated value.
|
|
66
63
|
*/
|
|
67
64
|
declare class HttpError extends Error {
|
|
68
65
|
readonly status: number;
|
|
@@ -84,6 +81,46 @@ declare class HttpError extends Error {
|
|
|
84
81
|
data?: unknown;
|
|
85
82
|
};
|
|
86
83
|
}
|
|
84
|
+
/**
|
|
85
|
+
* Throw with a custom HTTP status + wire code. The general-purpose escape hatch
|
|
86
|
+
* when none of the named classes (`Conflict`/`NotFound`/…) fits.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* throw new PalError(418, "teapot", "I'm a teapot");
|
|
90
|
+
*/
|
|
91
|
+
declare class PalError extends HttpError {
|
|
92
|
+
constructor(status: number, code: string, description: string, data?: unknown);
|
|
93
|
+
}
|
|
94
|
+
/** Base for the named status classes. Each subclass fixes its HTTP status; the
|
|
95
|
+
* `code` defaults to the class's canonical wire code (overridable), and the
|
|
96
|
+
* `message` defaults to a human-readable label (overridable). */
|
|
97
|
+
declare abstract class NamedHttpError extends HttpError {
|
|
98
|
+
protected constructor(status: number, defaultCode: string, name: string, message?: string, code?: string, data?: unknown);
|
|
99
|
+
}
|
|
100
|
+
/** 400 — the request was malformed or failed validation. */
|
|
101
|
+
declare class BadRequest extends NamedHttpError {
|
|
102
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
103
|
+
}
|
|
104
|
+
/** 401 — the caller is not authenticated. */
|
|
105
|
+
declare class Unauthorized extends NamedHttpError {
|
|
106
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
107
|
+
}
|
|
108
|
+
/** 403 — the caller is authenticated but not allowed. */
|
|
109
|
+
declare class Forbidden extends NamedHttpError {
|
|
110
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
111
|
+
}
|
|
112
|
+
/** 404 — the requested resource does not exist. */
|
|
113
|
+
declare class NotFound extends NamedHttpError {
|
|
114
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
115
|
+
}
|
|
116
|
+
/** 409 — the request conflicts with the current state. */
|
|
117
|
+
declare class Conflict extends NamedHttpError {
|
|
118
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
119
|
+
}
|
|
120
|
+
/** 429 — the caller has exceeded the rate limit. */
|
|
121
|
+
declare class TooManyRequests extends NamedHttpError {
|
|
122
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
123
|
+
}
|
|
87
124
|
|
|
88
125
|
/**
|
|
89
126
|
* Local typed interfaces for the 9 Palbase module clients injected into
|
|
@@ -1161,10 +1198,9 @@ interface RateLimitConfig {
|
|
|
1161
1198
|
/** Window duration in seconds. */
|
|
1162
1199
|
window: number;
|
|
1163
1200
|
}
|
|
1164
|
-
/** The
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
interface DBClient {
|
|
1201
|
+
/** The six raw string-keyed DB operations shared by `DBClient` and the
|
|
1202
|
+
* transaction-scoped client. */
|
|
1203
|
+
interface DBOps {
|
|
1168
1204
|
/** Run a read-only SQL query (executes in a READ ONLY transaction). */
|
|
1169
1205
|
query(sql: string, params?: unknown[]): Promise<Record<string, unknown>[]>;
|
|
1170
1206
|
insert(table: string, data: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
@@ -1172,12 +1208,27 @@ interface DBClient {
|
|
|
1172
1208
|
delete(table: string, id: string): Promise<void>;
|
|
1173
1209
|
findById(table: string, id: string): Promise<Record<string, unknown> | null>;
|
|
1174
1210
|
findMany(table: string, query?: Record<string, unknown>): Promise<Record<string, unknown>[]>;
|
|
1211
|
+
}
|
|
1212
|
+
/** The transaction-scoped client passed to `db.transaction(fn)` — the raw DB
|
|
1213
|
+
* ops only. No nested transaction and no `asService` (the DB role is fixed once
|
|
1214
|
+
* when the transaction begins; see `Database.asService().transaction(...)`). */
|
|
1215
|
+
type TxClient = DBOps;
|
|
1216
|
+
/** Database client interface injected into endpoint context. */
|
|
1217
|
+
interface DBClient extends DBOps {
|
|
1175
1218
|
/**
|
|
1176
1219
|
* Run an interactive transaction. The callback receives a `tx` with the same
|
|
1177
1220
|
* DB ops as this client; returning normally commits, throwing rolls back.
|
|
1178
1221
|
* Nested transactions are not supported.
|
|
1179
1222
|
*/
|
|
1180
1223
|
transaction<T>(fn: (tx: TxClient) => Promise<T>): Promise<T>;
|
|
1224
|
+
/**
|
|
1225
|
+
* Return a sibling DB client that bypasses Row-Level Security by running as
|
|
1226
|
+
* the `service_role` (BYPASSRLS). Use sparingly and explicitly — the default
|
|
1227
|
+
* `Database.*` path is RLS-enforced. The returned client exposes the same op
|
|
1228
|
+
* surface (`query`/`insert`/.../`transaction`) but never re-exposes
|
|
1229
|
+
* `asService` (no double-bypass).
|
|
1230
|
+
*/
|
|
1231
|
+
asService(): Omit<DBClient, "asService">;
|
|
1181
1232
|
}
|
|
1182
1233
|
/** Logger interface injected into endpoint context. */
|
|
1183
1234
|
interface Logger {
|
|
@@ -1349,21 +1400,29 @@ type ErrorThrowers<TErrors extends ErrorMap | undefined> = TErrors extends Error
|
|
|
1349
1400
|
* error throwers. Services (`Database`, `Documents`, `Cache`, …) are NOT on
|
|
1350
1401
|
* the request: import them directly from `@palbase/backend` as singletons.
|
|
1351
1402
|
*
|
|
1352
|
-
* import {
|
|
1403
|
+
* import { Controller, Get, Req, Database } from "@palbase/backend";
|
|
1353
1404
|
*
|
|
1354
|
-
*
|
|
1355
|
-
*
|
|
1356
|
-
*
|
|
1405
|
+
* \@Controller("/todos")
|
|
1406
|
+
* export class TodosController {
|
|
1407
|
+
* \@Get("") list(\@Req() req: PBRequest): unknown {
|
|
1408
|
+
* return Database.findMany("todos");
|
|
1409
|
+
* }
|
|
1410
|
+
* }
|
|
1411
|
+
*
|
|
1412
|
+
* Most controller methods reach individual request slices via their own
|
|
1413
|
+
* parameter decorator (`@Body`/`@Query`/`@Param`/`@User`/…); `@Req()` is the
|
|
1414
|
+
* escape hatch that injects this whole object.
|
|
1357
1415
|
*
|
|
1358
1416
|
* Generic parameters:
|
|
1359
|
-
* - `TInput` — the validated `input` type (
|
|
1360
|
-
*
|
|
1361
|
-
* `PBRequest<TodoInput>`.
|
|
1417
|
+
* - `TInput` — the validated `input` type (the `@Body` schema's `z.infer`). The
|
|
1418
|
+
* user-facing form is single-generic: `PBRequest<TodoInput>`.
|
|
1362
1419
|
* - `TAuthed` — whether `user` is non-null. DEFAULTS to `true` (the common
|
|
1363
1420
|
* case; the auth pipeline returns 401 before the handler when auth is
|
|
1364
|
-
* required, so a non-null `user` is runtime-honest).
|
|
1365
|
-
*
|
|
1366
|
-
* - `TErrors` — the
|
|
1421
|
+
* required, so a non-null `user` is runtime-honest). A route whose effective
|
|
1422
|
+
* auth is `false` yields `User | null`.
|
|
1423
|
+
* - `TErrors` — RETAINED for back-compat of the `errors` thrower shape; the
|
|
1424
|
+
* class-controller model throws global error classes
|
|
1425
|
+
* (`Conflict`/`NotFound`/…) instead, so `req.errors` is empty in practice.
|
|
1367
1426
|
*/
|
|
1368
1427
|
interface PBRequest<TInput = unknown, TAuthed extends boolean = true, TErrors extends ErrorMap | undefined = undefined> {
|
|
1369
1428
|
/** Validated request input (body for POST/PUT/PATCH; `{}` otherwise). */
|
|
@@ -1375,8 +1434,9 @@ interface PBRequest<TInput = unknown, TAuthed extends boolean = true, TErrors ex
|
|
|
1375
1434
|
/** Request headers (lowercase keys). */
|
|
1376
1435
|
headers: Record<string, string>;
|
|
1377
1436
|
/** Authenticated user. Non-null (`User`) by default; `User | null` only when
|
|
1378
|
-
* the
|
|
1379
|
-
*
|
|
1437
|
+
* the route's effective auth disables enforcement (driven by `TAuthed`, which
|
|
1438
|
+
* the runtime resolves from the route/controller `auth` cascade via
|
|
1439
|
+
* {@link IsAuthed}). */
|
|
1380
1440
|
user: TAuthed extends true ? User : User | null;
|
|
1381
1441
|
/** Calling-client metadata derived from request headers (all nullable). */
|
|
1382
1442
|
client: ClientInfo;
|
|
@@ -1390,8 +1450,9 @@ interface PBRequest<TInput = unknown, TAuthed extends boolean = true, TErrors ex
|
|
|
1390
1450
|
traceId: string;
|
|
1391
1451
|
/** W3C span id for this handler invocation. */
|
|
1392
1452
|
spanId: string;
|
|
1393
|
-
/** Typed throwers for the endpoint's declared errors.
|
|
1394
|
-
* `
|
|
1453
|
+
/** Typed throwers for the endpoint's declared errors. RETAINED for the
|
|
1454
|
+
* `@Req()` escape-hatch shape; the class-controller model throws global error
|
|
1455
|
+
* classes (`Conflict`/`NotFound`/…) instead, so this is empty in practice. */
|
|
1395
1456
|
errors: ErrorThrowers<TErrors>;
|
|
1396
1457
|
}
|
|
1397
1458
|
/** Middleware function signature — uses MiddlewareContext (no input, not yet validated). */
|
|
@@ -1403,30 +1464,5 @@ type Middleware = (ctx: MiddlewareContext, next: () => Promise<void>) => Promise
|
|
|
1403
1464
|
* omitted — which the runtime treats as `required: true` (see {@link IsAuthed}).
|
|
1404
1465
|
*/
|
|
1405
1466
|
type AuthSpec = boolean | Partial<AuthConfig>;
|
|
1406
|
-
/** Compute, at the type level, whether an endpoint authenticates its caller —
|
|
1407
|
-
* i.e. whether `req.user` should be `User` (non-null) instead of `User | null`.
|
|
1408
|
-
*
|
|
1409
|
-
* SECURE BY DEFAULT — mirrors the runtime (loader.go DefaultAuthConfig +
|
|
1410
|
-
* pipeline/auth.go): an endpoint requires auth UNLESS it explicitly opts out.
|
|
1411
|
-
* `req.user` is nullable ONLY for `auth: false` or `auth: { required: false }`.
|
|
1412
|
-
* Omitting `auth` means AUTH REQUIRED (non-null `req.user`), so a handler that
|
|
1413
|
-
* forgets `auth` fails safe (401) instead of silently exposing data.
|
|
1414
|
-
*
|
|
1415
|
-
* | `TAuth` | `IsAuthed<TAuth>` |
|
|
1416
|
-
* |----------------------------------|-------------------|
|
|
1417
|
-
* | omitted (`undefined`) | `true` (secure) |
|
|
1418
|
-
* | `true` | `true` |
|
|
1419
|
-
* | `false` | `false` (public) |
|
|
1420
|
-
* | `{ required: true }` | `true` |
|
|
1421
|
-
* | `{ required: false }` | `false` (public) |
|
|
1422
|
-
* | `{ role: 'admin' }` (no `required`) | `true` |
|
|
1423
|
-
*
|
|
1424
|
-
* Order matters: the `{ required: false }` branch is checked first so the object
|
|
1425
|
-
* case can't swallow it; `true`/`false` literals next; the catch-all (omitted)
|
|
1426
|
-
* resolves to `true` (secure-by-default).
|
|
1427
|
-
*/
|
|
1428
|
-
type IsAuthed<TAuth> = TAuth extends {
|
|
1429
|
-
required: false;
|
|
1430
|
-
} ? false : TAuth extends true ? true : TAuth extends false ? false : TAuth extends object ? true : true;
|
|
1431
1467
|
|
|
1432
|
-
export { type
|
|
1468
|
+
export { type PalbaseDocumentSnapshot as $, type AuthSpec as A, BadRequest as B, type CacheClient as C, type DBClient as D, type ErrorDef as E, type FileContext as F, type PalbaseBucketClient as G, HttpError as H, type PalbaseCmsClient as I, type PalbaseCmsFindOneOptions as J, type PalbaseCmsFindOptions as K, type Logger as L, type Middleware as M, NotFound as N, type PalbaseCohortQueryInput as O, type PBRequest as P, type QueueClient as Q, type RateLimitConfig as R, type PalbaseCohortResult as S, type PalbaseCollectionRef as T, type User as U, type PalbaseCountQueryInput as V, type PalbaseCountResult as W, type PalbaseCreateLinkParams as X, type PalbaseDeviceInfo as Y, type PalbaseDeviceTokenView as Z, type PalbaseDocumentRef as _, type PalbaseModuleClients as a, Unauthorized as a$, type PalbaseEmailClient as a0, type PalbaseEmailSendParams as a1, type PalbaseEmailSendResponse as a2, type PalbaseEventNamesResult as a3, type PalbaseEventsQueryInput as a4, type PalbaseEventsResult as a5, type PalbaseFileObject as a6, type PalbaseFlag as a7, type PalbaseFlagContext as a8, type PalbaseFlagVariant as a9, type PalbasePushSendParams as aA, type PalbasePushSendResponse as aB, type PalbaseQrCodeOptions as aC, type PalbaseQuerySnapshot as aD, type PalbaseRealtimeChannel as aE, type PalbaseRealtimeClient as aF, type PalbaseRealtimeMessage as aG, type PalbaseRegisterDeviceParams as aH, type PalbaseResult as aI, type PalbaseRetentionQueryInput as aJ, type PalbaseRetentionResult as aK, type PalbaseSession as aL, type PalbaseSignedUrlResponse as aM, type PalbaseSmsClient as aN, type PalbaseSmsSendParams as aO, type PalbaseSmsSendResponse as aP, type PalbaseTransformOptions as aQ, type PalbaseUpdateLinkParams as aR, type PalbaseUploadOptions as aS, type PalbaseUser as aT, type PalbaseUserDetailResult as aU, type PalbaseUsersQueryInput as aV, type PalbaseUsersResult as aW, type PalbaseVerifyRequestSignatureParams as aX, type PalbaseWhereOperator as aY, TooManyRequests as aZ, type TxClient as a_, type PalbaseFunctionsClient as aa, type PalbaseFunnelQueryInput as ab, type PalbaseFunnelResult as ac, type PalbaseIdentifyTraits as ad, type PalbaseInboxClient as ae, type PalbaseInboxListOptions as af, type PalbaseInboxListResult as ag, type PalbaseInboxMessage as ah, type PalbaseInboxSendParams as ai, type PalbaseInboxSendResponse as aj, type PalbaseInitialLink as ak, type PalbaseInvokeOptions as al, type PalbaseLink as am, type PalbaseLinkAnalytics as an, type PalbaseLinkDetails as ao, type PalbaseLinksClient as ap, type PalbaseListLinksOptions as aq, type PalbaseListLinksResult as ar, type PalbaseListOptions as as, type PalbaseMatchParams as at, type PalbaseMultiChannelResponse as au, type PalbaseOverviewResult as av, type PalbasePreferences as aw, type PalbasePreferencesClient as ax, type PalbasePublicUrlResponse as ay, type PalbasePushClient as az, type PalbaseDocsClient as b, defineMiddleware as b0, type PalbaseFlagsClient as c, type PalbaseNotificationsClient as d, type PalbaseStorageClient as e, type AuthConfig as f, type ClientInfo as g, Conflict as h, type DBOps as i, type ErrorMap as j, type ErrorThrowers as k, Forbidden as l, type HttpMethod as m, type MiddlewareContext as n, type MiddlewareHandler as o, PalError as p, type PalbaseAnalyticsClient as q, type PalbaseAnalyticsManagementNamespace as r, type PalbaseAnalyticsProperties as s, type PalbaseAnalyticsQueryNamespace as t, type PalbaseAttestAndroidParams as u, type PalbaseAttestAndroidResult as v, type PalbaseAttestiOSParams as w, type PalbaseAttestiOSResult as x, type PalbaseAuthClient as y, type PalbaseBindDeviceParams as z };
|
|
@@ -49,20 +49,17 @@ declare function defineMiddleware(fn: MiddlewareHandler): MiddlewareHandler;
|
|
|
49
49
|
|
|
50
50
|
/** HTTP error with structured error response format.
|
|
51
51
|
*
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* `errors` map (`defineHandler`). The endpoint's OpenAPI spec describes
|
|
59
|
-
* each one, and the CLI codegen emits a typed `<Endpoint>.Error` enum so
|
|
60
|
-
* iOS callers can `catch <Endpoint>.Error.<case>` directly.
|
|
52
|
+
* The base class for the throwable error classes (`PalError`, `Conflict`,
|
|
53
|
+
* `NotFound`, …). Construct one directly with `throw new HttpError(404,
|
|
54
|
+
* "todo_not_found", "No such todo")`, or throw a named subclass
|
|
55
|
+
* (`throw new NotFound("todo not found")`). The runtime catches any `HttpError`
|
|
56
|
+
* and emits the standard envelope; on the wire (and to iOS) it surfaces as
|
|
57
|
+
* `BackendError.server(code, status, message, requestId)`.
|
|
61
58
|
*
|
|
62
59
|
* The optional `data` field carries a structured payload alongside the
|
|
63
|
-
* standard envelope —
|
|
64
|
-
* (e.g. `
|
|
65
|
-
* enum's associated value.
|
|
60
|
+
* standard envelope — for errors that need to ship extra context
|
|
61
|
+
* (e.g. `new Conflict("locked", "title_locked", { retryAfter: 30 })`). It rides
|
|
62
|
+
* through to the iOS typed enum's associated value.
|
|
66
63
|
*/
|
|
67
64
|
declare class HttpError extends Error {
|
|
68
65
|
readonly status: number;
|
|
@@ -84,6 +81,46 @@ declare class HttpError extends Error {
|
|
|
84
81
|
data?: unknown;
|
|
85
82
|
};
|
|
86
83
|
}
|
|
84
|
+
/**
|
|
85
|
+
* Throw with a custom HTTP status + wire code. The general-purpose escape hatch
|
|
86
|
+
* when none of the named classes (`Conflict`/`NotFound`/…) fits.
|
|
87
|
+
*
|
|
88
|
+
* @example
|
|
89
|
+
* throw new PalError(418, "teapot", "I'm a teapot");
|
|
90
|
+
*/
|
|
91
|
+
declare class PalError extends HttpError {
|
|
92
|
+
constructor(status: number, code: string, description: string, data?: unknown);
|
|
93
|
+
}
|
|
94
|
+
/** Base for the named status classes. Each subclass fixes its HTTP status; the
|
|
95
|
+
* `code` defaults to the class's canonical wire code (overridable), and the
|
|
96
|
+
* `message` defaults to a human-readable label (overridable). */
|
|
97
|
+
declare abstract class NamedHttpError extends HttpError {
|
|
98
|
+
protected constructor(status: number, defaultCode: string, name: string, message?: string, code?: string, data?: unknown);
|
|
99
|
+
}
|
|
100
|
+
/** 400 — the request was malformed or failed validation. */
|
|
101
|
+
declare class BadRequest extends NamedHttpError {
|
|
102
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
103
|
+
}
|
|
104
|
+
/** 401 — the caller is not authenticated. */
|
|
105
|
+
declare class Unauthorized extends NamedHttpError {
|
|
106
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
107
|
+
}
|
|
108
|
+
/** 403 — the caller is authenticated but not allowed. */
|
|
109
|
+
declare class Forbidden extends NamedHttpError {
|
|
110
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
111
|
+
}
|
|
112
|
+
/** 404 — the requested resource does not exist. */
|
|
113
|
+
declare class NotFound extends NamedHttpError {
|
|
114
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
115
|
+
}
|
|
116
|
+
/** 409 — the request conflicts with the current state. */
|
|
117
|
+
declare class Conflict extends NamedHttpError {
|
|
118
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
119
|
+
}
|
|
120
|
+
/** 429 — the caller has exceeded the rate limit. */
|
|
121
|
+
declare class TooManyRequests extends NamedHttpError {
|
|
122
|
+
constructor(message?: string, code?: string, data?: unknown);
|
|
123
|
+
}
|
|
87
124
|
|
|
88
125
|
/**
|
|
89
126
|
* Local typed interfaces for the 9 Palbase module clients injected into
|
|
@@ -1161,10 +1198,9 @@ interface RateLimitConfig {
|
|
|
1161
1198
|
/** Window duration in seconds. */
|
|
1162
1199
|
window: number;
|
|
1163
1200
|
}
|
|
1164
|
-
/** The
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
interface DBClient {
|
|
1201
|
+
/** The six raw string-keyed DB operations shared by `DBClient` and the
|
|
1202
|
+
* transaction-scoped client. */
|
|
1203
|
+
interface DBOps {
|
|
1168
1204
|
/** Run a read-only SQL query (executes in a READ ONLY transaction). */
|
|
1169
1205
|
query(sql: string, params?: unknown[]): Promise<Record<string, unknown>[]>;
|
|
1170
1206
|
insert(table: string, data: Record<string, unknown>): Promise<Record<string, unknown>>;
|
|
@@ -1172,12 +1208,27 @@ interface DBClient {
|
|
|
1172
1208
|
delete(table: string, id: string): Promise<void>;
|
|
1173
1209
|
findById(table: string, id: string): Promise<Record<string, unknown> | null>;
|
|
1174
1210
|
findMany(table: string, query?: Record<string, unknown>): Promise<Record<string, unknown>[]>;
|
|
1211
|
+
}
|
|
1212
|
+
/** The transaction-scoped client passed to `db.transaction(fn)` — the raw DB
|
|
1213
|
+
* ops only. No nested transaction and no `asService` (the DB role is fixed once
|
|
1214
|
+
* when the transaction begins; see `Database.asService().transaction(...)`). */
|
|
1215
|
+
type TxClient = DBOps;
|
|
1216
|
+
/** Database client interface injected into endpoint context. */
|
|
1217
|
+
interface DBClient extends DBOps {
|
|
1175
1218
|
/**
|
|
1176
1219
|
* Run an interactive transaction. The callback receives a `tx` with the same
|
|
1177
1220
|
* DB ops as this client; returning normally commits, throwing rolls back.
|
|
1178
1221
|
* Nested transactions are not supported.
|
|
1179
1222
|
*/
|
|
1180
1223
|
transaction<T>(fn: (tx: TxClient) => Promise<T>): Promise<T>;
|
|
1224
|
+
/**
|
|
1225
|
+
* Return a sibling DB client that bypasses Row-Level Security by running as
|
|
1226
|
+
* the `service_role` (BYPASSRLS). Use sparingly and explicitly — the default
|
|
1227
|
+
* `Database.*` path is RLS-enforced. The returned client exposes the same op
|
|
1228
|
+
* surface (`query`/`insert`/.../`transaction`) but never re-exposes
|
|
1229
|
+
* `asService` (no double-bypass).
|
|
1230
|
+
*/
|
|
1231
|
+
asService(): Omit<DBClient, "asService">;
|
|
1181
1232
|
}
|
|
1182
1233
|
/** Logger interface injected into endpoint context. */
|
|
1183
1234
|
interface Logger {
|
|
@@ -1349,21 +1400,29 @@ type ErrorThrowers<TErrors extends ErrorMap | undefined> = TErrors extends Error
|
|
|
1349
1400
|
* error throwers. Services (`Database`, `Documents`, `Cache`, …) are NOT on
|
|
1350
1401
|
* the request: import them directly from `@palbase/backend` as singletons.
|
|
1351
1402
|
*
|
|
1352
|
-
* import {
|
|
1403
|
+
* import { Controller, Get, Req, Database } from "@palbase/backend";
|
|
1353
1404
|
*
|
|
1354
|
-
*
|
|
1355
|
-
*
|
|
1356
|
-
*
|
|
1405
|
+
* \@Controller("/todos")
|
|
1406
|
+
* export class TodosController {
|
|
1407
|
+
* \@Get("") list(\@Req() req: PBRequest): unknown {
|
|
1408
|
+
* return Database.findMany("todos");
|
|
1409
|
+
* }
|
|
1410
|
+
* }
|
|
1411
|
+
*
|
|
1412
|
+
* Most controller methods reach individual request slices via their own
|
|
1413
|
+
* parameter decorator (`@Body`/`@Query`/`@Param`/`@User`/…); `@Req()` is the
|
|
1414
|
+
* escape hatch that injects this whole object.
|
|
1357
1415
|
*
|
|
1358
1416
|
* Generic parameters:
|
|
1359
|
-
* - `TInput` — the validated `input` type (
|
|
1360
|
-
*
|
|
1361
|
-
* `PBRequest<TodoInput>`.
|
|
1417
|
+
* - `TInput` — the validated `input` type (the `@Body` schema's `z.infer`). The
|
|
1418
|
+
* user-facing form is single-generic: `PBRequest<TodoInput>`.
|
|
1362
1419
|
* - `TAuthed` — whether `user` is non-null. DEFAULTS to `true` (the common
|
|
1363
1420
|
* case; the auth pipeline returns 401 before the handler when auth is
|
|
1364
|
-
* required, so a non-null `user` is runtime-honest).
|
|
1365
|
-
*
|
|
1366
|
-
* - `TErrors` — the
|
|
1421
|
+
* required, so a non-null `user` is runtime-honest). A route whose effective
|
|
1422
|
+
* auth is `false` yields `User | null`.
|
|
1423
|
+
* - `TErrors` — RETAINED for back-compat of the `errors` thrower shape; the
|
|
1424
|
+
* class-controller model throws global error classes
|
|
1425
|
+
* (`Conflict`/`NotFound`/…) instead, so `req.errors` is empty in practice.
|
|
1367
1426
|
*/
|
|
1368
1427
|
interface PBRequest<TInput = unknown, TAuthed extends boolean = true, TErrors extends ErrorMap | undefined = undefined> {
|
|
1369
1428
|
/** Validated request input (body for POST/PUT/PATCH; `{}` otherwise). */
|
|
@@ -1375,8 +1434,9 @@ interface PBRequest<TInput = unknown, TAuthed extends boolean = true, TErrors ex
|
|
|
1375
1434
|
/** Request headers (lowercase keys). */
|
|
1376
1435
|
headers: Record<string, string>;
|
|
1377
1436
|
/** Authenticated user. Non-null (`User`) by default; `User | null` only when
|
|
1378
|
-
* the
|
|
1379
|
-
*
|
|
1437
|
+
* the route's effective auth disables enforcement (driven by `TAuthed`, which
|
|
1438
|
+
* the runtime resolves from the route/controller `auth` cascade via
|
|
1439
|
+
* {@link IsAuthed}). */
|
|
1380
1440
|
user: TAuthed extends true ? User : User | null;
|
|
1381
1441
|
/** Calling-client metadata derived from request headers (all nullable). */
|
|
1382
1442
|
client: ClientInfo;
|
|
@@ -1390,8 +1450,9 @@ interface PBRequest<TInput = unknown, TAuthed extends boolean = true, TErrors ex
|
|
|
1390
1450
|
traceId: string;
|
|
1391
1451
|
/** W3C span id for this handler invocation. */
|
|
1392
1452
|
spanId: string;
|
|
1393
|
-
/** Typed throwers for the endpoint's declared errors.
|
|
1394
|
-
* `
|
|
1453
|
+
/** Typed throwers for the endpoint's declared errors. RETAINED for the
|
|
1454
|
+
* `@Req()` escape-hatch shape; the class-controller model throws global error
|
|
1455
|
+
* classes (`Conflict`/`NotFound`/…) instead, so this is empty in practice. */
|
|
1395
1456
|
errors: ErrorThrowers<TErrors>;
|
|
1396
1457
|
}
|
|
1397
1458
|
/** Middleware function signature — uses MiddlewareContext (no input, not yet validated). */
|
|
@@ -1403,30 +1464,5 @@ type Middleware = (ctx: MiddlewareContext, next: () => Promise<void>) => Promise
|
|
|
1403
1464
|
* omitted — which the runtime treats as `required: true` (see {@link IsAuthed}).
|
|
1404
1465
|
*/
|
|
1405
1466
|
type AuthSpec = boolean | Partial<AuthConfig>;
|
|
1406
|
-
/** Compute, at the type level, whether an endpoint authenticates its caller —
|
|
1407
|
-
* i.e. whether `req.user` should be `User` (non-null) instead of `User | null`.
|
|
1408
|
-
*
|
|
1409
|
-
* SECURE BY DEFAULT — mirrors the runtime (loader.go DefaultAuthConfig +
|
|
1410
|
-
* pipeline/auth.go): an endpoint requires auth UNLESS it explicitly opts out.
|
|
1411
|
-
* `req.user` is nullable ONLY for `auth: false` or `auth: { required: false }`.
|
|
1412
|
-
* Omitting `auth` means AUTH REQUIRED (non-null `req.user`), so a handler that
|
|
1413
|
-
* forgets `auth` fails safe (401) instead of silently exposing data.
|
|
1414
|
-
*
|
|
1415
|
-
* | `TAuth` | `IsAuthed<TAuth>` |
|
|
1416
|
-
* |----------------------------------|-------------------|
|
|
1417
|
-
* | omitted (`undefined`) | `true` (secure) |
|
|
1418
|
-
* | `true` | `true` |
|
|
1419
|
-
* | `false` | `false` (public) |
|
|
1420
|
-
* | `{ required: true }` | `true` |
|
|
1421
|
-
* | `{ required: false }` | `false` (public) |
|
|
1422
|
-
* | `{ role: 'admin' }` (no `required`) | `true` |
|
|
1423
|
-
*
|
|
1424
|
-
* Order matters: the `{ required: false }` branch is checked first so the object
|
|
1425
|
-
* case can't swallow it; `true`/`false` literals next; the catch-all (omitted)
|
|
1426
|
-
* resolves to `true` (secure-by-default).
|
|
1427
|
-
*/
|
|
1428
|
-
type IsAuthed<TAuth> = TAuth extends {
|
|
1429
|
-
required: false;
|
|
1430
|
-
} ? false : TAuth extends true ? true : TAuth extends false ? false : TAuth extends object ? true : true;
|
|
1431
1467
|
|
|
1432
|
-
export { type
|
|
1468
|
+
export { type PalbaseDocumentSnapshot as $, type AuthSpec as A, BadRequest as B, type CacheClient as C, type DBClient as D, type ErrorDef as E, type FileContext as F, type PalbaseBucketClient as G, HttpError as H, type PalbaseCmsClient as I, type PalbaseCmsFindOneOptions as J, type PalbaseCmsFindOptions as K, type Logger as L, type Middleware as M, NotFound as N, type PalbaseCohortQueryInput as O, type PBRequest as P, type QueueClient as Q, type RateLimitConfig as R, type PalbaseCohortResult as S, type PalbaseCollectionRef as T, type User as U, type PalbaseCountQueryInput as V, type PalbaseCountResult as W, type PalbaseCreateLinkParams as X, type PalbaseDeviceInfo as Y, type PalbaseDeviceTokenView as Z, type PalbaseDocumentRef as _, type PalbaseModuleClients as a, Unauthorized as a$, type PalbaseEmailClient as a0, type PalbaseEmailSendParams as a1, type PalbaseEmailSendResponse as a2, type PalbaseEventNamesResult as a3, type PalbaseEventsQueryInput as a4, type PalbaseEventsResult as a5, type PalbaseFileObject as a6, type PalbaseFlag as a7, type PalbaseFlagContext as a8, type PalbaseFlagVariant as a9, type PalbasePushSendParams as aA, type PalbasePushSendResponse as aB, type PalbaseQrCodeOptions as aC, type PalbaseQuerySnapshot as aD, type PalbaseRealtimeChannel as aE, type PalbaseRealtimeClient as aF, type PalbaseRealtimeMessage as aG, type PalbaseRegisterDeviceParams as aH, type PalbaseResult as aI, type PalbaseRetentionQueryInput as aJ, type PalbaseRetentionResult as aK, type PalbaseSession as aL, type PalbaseSignedUrlResponse as aM, type PalbaseSmsClient as aN, type PalbaseSmsSendParams as aO, type PalbaseSmsSendResponse as aP, type PalbaseTransformOptions as aQ, type PalbaseUpdateLinkParams as aR, type PalbaseUploadOptions as aS, type PalbaseUser as aT, type PalbaseUserDetailResult as aU, type PalbaseUsersQueryInput as aV, type PalbaseUsersResult as aW, type PalbaseVerifyRequestSignatureParams as aX, type PalbaseWhereOperator as aY, TooManyRequests as aZ, type TxClient as a_, type PalbaseFunctionsClient as aa, type PalbaseFunnelQueryInput as ab, type PalbaseFunnelResult as ac, type PalbaseIdentifyTraits as ad, type PalbaseInboxClient as ae, type PalbaseInboxListOptions as af, type PalbaseInboxListResult as ag, type PalbaseInboxMessage as ah, type PalbaseInboxSendParams as ai, type PalbaseInboxSendResponse as aj, type PalbaseInitialLink as ak, type PalbaseInvokeOptions as al, type PalbaseLink as am, type PalbaseLinkAnalytics as an, type PalbaseLinkDetails as ao, type PalbaseLinksClient as ap, type PalbaseListLinksOptions as aq, type PalbaseListLinksResult as ar, type PalbaseListOptions as as, type PalbaseMatchParams as at, type PalbaseMultiChannelResponse as au, type PalbaseOverviewResult as av, type PalbasePreferences as aw, type PalbasePreferencesClient as ax, type PalbasePublicUrlResponse as ay, type PalbasePushClient as az, type PalbaseDocsClient as b, defineMiddleware as b0, type PalbaseFlagsClient as c, type PalbaseNotificationsClient as d, type PalbaseStorageClient as e, type AuthConfig as f, type ClientInfo as g, Conflict as h, type DBOps as i, type ErrorMap as j, type ErrorThrowers as k, Forbidden as l, type HttpMethod as m, type MiddlewareContext as n, type MiddlewareHandler as o, PalError as p, type PalbaseAnalyticsClient as q, type PalbaseAnalyticsManagementNamespace as r, type PalbaseAnalyticsProperties as s, type PalbaseAnalyticsQueryNamespace as t, type PalbaseAttestAndroidParams as u, type PalbaseAttestAndroidResult as v, type PalbaseAttestiOSParams as w, type PalbaseAttestiOSResult as x, type PalbaseAuthClient as y, type PalbaseBindDeviceParams as z };
|