-
- Overview
-
- Overview
- collection
- collection/client
- collection/schemas
- manifest/context
- manifest/parse
- manifest/types
- remote
- remote/collection\_wire\_schemas
- remote/sveltekit-guard.server
- runtime/binding
- scope/types
- seed/authoring
- seed/execute
- seed/manifest
- seed/plan
- storage/minio
- system/collections
- system/column\_names
- system/types
- system/workspace-schema
- tenant\_db/bootstrap
- tenant\_db/neon-branch-utils
- tenant\_db/neon-provider
- tenant\_db/provider
- tenant\_db/schema
- tenant\_workspace
- tenant\_workspace/build-output
- tenant\_workspace/migrations/apply
- tenant\_workspace/migrations/errors
- tenant\_workspace/migrations/generate
- tenant\_workspace/migrations/read
- tenant\_workspace/source
runtime/binding
runtime/binding
Type Aliases
AiChatInput
type AiChatInput = object;Defined in: platform-utils/src/runtime/binding.ts:61
Properties
AiInferInput
type AiInferInput = object;Defined in: platform-utils/src/runtime/binding.ts:49
Properties
AiInferResult
type AiInferResult = object;Defined in: platform-utils/src/runtime/binding.ts:56
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
text |
readonly |
string |
platform-utils/src/runtime/binding.ts:57 |
usage? |
readonly |
unknown |
platform-utils/src/runtime/binding.ts:58 |
DbQueryConfig
type DbQueryConfig = object;Defined in: platform-utils/src/runtime/binding.ts:7
Serializable query payload for the host db binding (no driver callbacks).
Properties
DbQueryInput
type DbQueryInput =
| string
| DbQueryConfig;Defined in: platform-utils/src/runtime/binding.ts:13
DbQueryResult
type DbQueryResult = object;Defined in: platform-utils/src/runtime/binding.ts:1
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
rowCount |
readonly |
number |
platform-utils/src/runtime/binding.ts:3 |
rows |
readonly |
readonly unknown[] |
platform-utils/src/runtime/binding.ts:2 |
GeolocationSuggestion
type GeolocationSuggestion = object;Defined in: platform-utils/src/runtime/binding.ts:129
Properties
HostAiBinding
type HostAiBinding = object;Defined in: platform-utils/src/runtime/binding.ts:70
Methods
chat()
chat(input): Promise<AiInferResult>;Defined in: platform-utils/src/runtime/binding.ts:72
Parameters
| Parameter | Type |
|---|---|
input |
AiChatInput |
Returns
Promise<AiInferResult>
infer()
infer(input): Promise<AiInferResult>;Defined in: platform-utils/src/runtime/binding.ts:71
Parameters
| Parameter | Type |
|---|---|
input |
AiInferInput |
Returns
Promise<AiInferResult>
HostDbBinding
type HostDbBinding = object;Defined in: platform-utils/src/runtime/binding.ts:15
Methods
begin()
begin(): Promise<string>;Defined in: platform-utils/src/runtime/binding.ts:17
Returns
Promise<string>
commit()
commit(txId): Promise<void>;Defined in: platform-utils/src/runtime/binding.ts:19
Parameters
| Parameter | Type |
|---|---|
txId |
string |
Returns
Promise<void>
query()
query(sql, params?): Promise<DbQueryResult>;Defined in: platform-utils/src/runtime/binding.ts:16
Parameters
| Parameter | Type |
|---|---|
sql |
DbQueryInput |
params? |
readonly unknown[] |
Returns
Promise<DbQueryResult>
rollback()
rollback(txId): Promise<void>;Defined in: platform-utils/src/runtime/binding.ts:20
Parameters
| Parameter | Type |
|---|---|
txId |
string |
Returns
Promise<void>
txQuery()
txQuery(
txId,
sql,
params?): Promise<DbQueryResult>;Defined in: platform-utils/src/runtime/binding.ts:18
Parameters
| Parameter | Type |
|---|---|
txId |
string |
sql |
DbQueryInput |
params? |
readonly unknown[] |
Returns
Promise<DbQueryResult>
HostFileStorageBinding
type HostFileStorageBinding = object;Defined in: platform-utils/src/runtime/binding.ts:41
File bytes cross the isolate boundary as raw Uint8Array. The V8 isolate marshals binding args/returns
with v8.serialize (structured clone), which supports typed arrays natively, so base64 would only
add overhead.
Methods
delete()
delete(key): Promise<void>;Defined in: platform-utils/src/runtime/binding.ts:44
Parameters
| Parameter | Type |
|---|---|
key |
string |
Returns
Promise<void>
get()
get(key): Promise<Uint8Array<ArrayBufferLike> | null>;Defined in: platform-utils/src/runtime/binding.ts:43
Parameters
| Parameter | Type |
|---|---|
key |
string |
Returns
Promise<Uint8Array<ArrayBufferLike> | null>
presignGet()
presignGet(key, ttlSeconds): Promise<PresignResult>;Defined in: platform-utils/src/runtime/binding.ts:46
Parameters
| Parameter | Type |
|---|---|
key |
string |
ttlSeconds |
number |
Returns
Promise<PresignResult>
presignPut()
presignPut(key, ttlSeconds): Promise<PresignResult>;Defined in: platform-utils/src/runtime/binding.ts:45
Parameters
| Parameter | Type |
|---|---|
key |
string |
ttlSeconds |
number |
Returns
Promise<PresignResult>
put()
put(
key,
body,
contentType?): Promise<void>;Defined in: platform-utils/src/runtime/binding.ts:42
Parameters
| Parameter | Type |
|---|---|
key |
string |
body |
Uint8Array |
contentType? |
string |
Returns
Promise<void>
HostMapsBinding
type HostMapsBinding = object;Defined in: platform-utils/src/runtime/binding.ts:139
Maps operations execute in the trusted host. Tenant runtimes receive only derived place data or rendered image bytes, never provider credentials.
Methods
autocompleteGeolocation()
autocompleteGeolocation(query): Promise<readonly GeolocationSuggestion[]>;Defined in: platform-utils/src/runtime/binding.ts:141
Parameters
| Parameter | Type |
|---|---|
query |
string |
Returns
Promise<readonly GeolocationSuggestion[]>
renderStaticMap()
renderStaticMap(input): Promise<StaticMapRenderResult>;Defined in: platform-utils/src/runtime/binding.ts:140
Parameters
| Parameter | Type |
|---|---|
input |
{ markers: object[]; } |
input.markers |
object[] |
Returns
Promise<StaticMapRenderResult>
HostNotificationsBinding
type HostNotificationsBinding = object;Defined in: platform-utils/src/runtime/binding.ts:90
Methods
send()
send(input): Promise<NotificationDeliveryResult>;Defined in: platform-utils/src/runtime/binding.ts:91
Parameters
| Parameter | Type |
|---|---|
input |
NotificationDeliveryInput |
Returns
Promise<NotificationDeliveryResult>
NotificationChannel
type NotificationChannel = "email" | "telegram" | "whatsapp" | "web";Defined in: platform-utils/src/runtime/binding.ts:75
NotificationDeliveryInput
type NotificationDeliveryInput = object;Defined in: platform-utils/src/runtime/binding.ts:77
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
channels |
readonly |
readonly NotificationChannel[] |
platform-utils/src/runtime/binding.ts:82 |
cta? |
readonly |
| { label: string; url: string; } | null |
platform-utils/src/runtime/binding.ts:83 |
message |
readonly |
string |
platform-utils/src/runtime/binding.ts:81 |
organizationId |
readonly |
string |
platform-utils/src/runtime/binding.ts:78 |
recipientUserId |
readonly |
string |
platform-utils/src/runtime/binding.ts:79 |
subject |
readonly |
string |
platform-utils/src/runtime/binding.ts:80 |
NotificationDeliveryResult
type NotificationDeliveryResult = object;Defined in: platform-utils/src/runtime/binding.ts:86
Index Signature
[channel: string]: objectPresignResult
type PresignResult = object;Defined in: platform-utils/src/runtime/binding.ts:23
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
expiresAt |
readonly |
string |
platform-utils/src/runtime/binding.ts:25 |
url |
readonly |
string |
platform-utils/src/runtime/binding.ts:24 |
RuntimeFacilityBindings
type RuntimeFacilityBindings = object;Defined in: platform-utils/src/runtime/binding.ts:149
Capabilities supplied by whichever platform hosts a tenant runtime. The runtime owns this contract; hosts own the implementations and credentials. Optional capabilities fail at their point of use, allowing the same build to run on platforms with different facility sets.
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
ai? |
readonly |
HostAiBinding |
platform-utils/src/runtime/binding.ts:152 |
db |
readonly |
HostDbBinding |
platform-utils/src/runtime/binding.ts:150 |
fileStorage? |
readonly |
HostFileStorageBinding |
platform-utils/src/runtime/binding.ts:151 |
maps? |
readonly |
HostMapsBinding |
platform-utils/src/runtime/binding.ts:154 |
notifications? |
readonly |
HostNotificationsBinding |
platform-utils/src/runtime/binding.ts:153 |
StaticMapInput
type StaticMapInput = z.infer<typeof StaticMapInputSchema>;Defined in: platform-utils/src/runtime/binding.ts:118
StaticMapMarker
type StaticMapMarker = object;Defined in: platform-utils/src/runtime/binding.ts:94
Properties
StaticMapRenderResult
type StaticMapRenderResult = object;Defined in: platform-utils/src/runtime/binding.ts:120
Properties
WorkspaceBillingSummary
type WorkspaceBillingSummary = object;Defined in: platform-utils/src/runtime/binding.ts:30
Properties
Variables
NORBITAL_BILLING_HEADER
const NORBITAL_BILLING_HEADER: "x-norbital-billing-json" = 'x-norbital-billing-json';Defined in: platform-utils/src/runtime/binding.ts:28
StaticMapInputSchema
const StaticMapInputSchema: ZodObject<{
markers: ZodArray<ZodObject<{
label: ZodOptional<ZodString>;
latitude: ZodNumber;
longitude: ZodNumber;
tone: ZodOptional<ZodEnum<{
alert: "alert";
default: "default";
}>>;
}, $strip>>;
}, $strip>;Defined in: platform-utils/src/runtime/binding.ts:101