Interfazhost

HandlerContext

Unico parametro de un handler. Firma unica: async function handler(ctx); un segundo parametro esta prohibido (tests/contract.test.mjs y _shared/validate.mjs lo comprueban). Lo que fija el SERVIDOR (fiable): args, env, domain, user, settings, extension, services. Lo que manda el NAVEGADOR (no fiable, validalo): emailContent, subject, to, from, sender, auth, slashArgs, contactId... ([clientContext]).

Firma

host · Interfaz

export interface HandlerContext<Args extends Record<string, any> = Record<string, any>, Env extends HandlerEnv = HandlerEnv> {
    args: Args;
    env: Env;
    domain: HandlerDomain;
    user: HandlerUser | null;
    settings: Record<string, any> & { forUser(key: string, userId: string): unknown; getUserValue(key: string, userId: string): unknown; };
    extension: HandlerExtensionInfo;
    services: HandlerServices;
    libs: HandlerLibs;
    hook: { event: string; eventKey?: string; } | null;
    auth?: { provider?: string; accessToken?: string; [provider: string]: any; };
    emailContent?: string;
    emailId?: string;
    subject?: string;
    to?: string[] | string;
    from?: string;
    sender?: { email?: string; name?: string; };
    [clientContext: string]: any;
}

Parámetros de tipo

Args · Restricción: Record<string, any> · Por defecto: Record<string, any>
Env · Restricción: HandlerEnv · Por defecto: HandlerEnv

Miembros (17)

Miembros
Nombre	Tipo	Descripción
argsobligatorio	`Args`	CALL_BACKEND.args (+ formData de un FORM). SIEMPRE los del RPC; valida cada campo antes de usarlo.
envobligatorio	`Env`	Sin descripción.
domainobligatorio	`HandlerDomain`	Sin descripción.
userobligatorio	`HandlerUser \| null`	Sin descripción.
settingsobligatorio	`Record<string, any> & { forUser(key: string, userId: string): unknown; getUserValue(key: string, userId: string): unknown; }`	Ajustes de la instalacion. Los secretos de dominio llegan por `env`; los secretos POR ELEMENTO (objects) viajan en su elemento y solo existen dentro del sandbox. Campos `user` = id (string), `users` = ids, `userMap` = { [userId]: valor } (solo entradas explicitas). Funciones no enumerables: `settings.forUser(key, userId)` / `settings.getUserValue(key, userId)` resuelven un userMap con su `default`.
extensionobligatorio	`HandlerExtensionInfo`	Sin descripción.
servicesobligatorio	`HandlerServices`	Sin descripción.
libsobligatorio	`HandlerLibs`	SDK de proveedores OAuth (`ctx.libs.google`, `ctx.libs.microsoft`, `ctx.libs.zoom`, `ctx.libs.slack`...): acciones tipadas, sin tokens.
hookobligatorio	`{ event: string; eventKey?: string; } \| null`	Procedencia de hook, FIJADA POR EL SERVIDOR (el cliente no puede enviarla): `{ event, eventKey? }` cuando el handler corre por un intercept de /api/extension/hooks y `null` en cualquier otra llamada (CALL_BACKEND, /execute). Los handlers que actuan sobre eventos (webhooks, altas...) deben exigir `ctx.hook?.event === "..."`: el resto del contexto (`ctx.event`, `ctx.subjectUserId`...) puede venir de un cliente.
authopcional	`{ provider?: string; accessToken?: string; [provider: string]: any; }`	Cuentas vinculadas del usuario: `ctx.auth.google.accessToken`. [INCIERTO: forma exacta segun proveedor]
emailContentopcional	`string`	Sin descripción.
emailIdopcional	`string`	Sin descripción.
subjectopcional	`string`	Sin descripción.
toopcional	`string[] \| string`	Sin descripción.
fromopcional	`string`	Sin descripción.
senderopcional	`{ email?: string; name?: string; }`	Sin descripción.
[clientContext: string]	`any`	Sin descripción.

Ejemplos

export async function greet(ctx) {
    const name = String(ctx.args.name || "").trim();
    if (!name) throw new Error("name es obligatorio");
    return { text: "Hola " + name + " desde " + ctx.domain.name };
}

Handler

Referencia a

Fuente: bloomx-extensions/_shared/sdk/ctx.d.ts:849 · ctx.d.ts

Interfazhost

HandlerContext

Firma

host · Interfaz

export interface HandlerContext<Args extends Record<string, any> = Record<string, any>, Env extends HandlerEnv = HandlerEnv> {
    args: Args;
    env: Env;
    domain: HandlerDomain;
    user: HandlerUser | null;
    settings: Record<string, any> & { forUser(key: string, userId: string): unknown; getUserValue(key: string, userId: string): unknown; };
    extension: HandlerExtensionInfo;
    services: HandlerServices;
    libs: HandlerLibs;
    hook: { event: string; eventKey?: string; } | null;
    auth?: { provider?: string; accessToken?: string; [provider: string]: any; };
    emailContent?: string;
    emailId?: string;
    subject?: string;
    to?: string[] | string;
    from?: string;
    sender?: { email?: string; name?: string; };
    [clientContext: string]: any;
}

Parámetros de tipo

Args · Restricción: Record<string, any> · Por defecto: Record<string, any>
Env · Restricción: HandlerEnv · Por defecto: HandlerEnv

Miembros (17)

Miembros
Nombre	Tipo	Descripción
argsobligatorio	`Args`	CALL_BACKEND.args (+ formData de un FORM). SIEMPRE los del RPC; valida cada campo antes de usarlo.
envobligatorio	`Env`	Sin descripción.
domainobligatorio	`HandlerDomain`	Sin descripción.
userobligatorio	`HandlerUser \| null`	Sin descripción.
settingsobligatorio	`Record<string, any> & { forUser(key: string, userId: string): unknown; getUserValue(key: string, userId: string): unknown; }`	Ajustes de la instalacion. Los secretos de dominio llegan por `env`; los secretos POR ELEMENTO (objects) viajan en su elemento y solo existen dentro del sandbox. Campos `user` = id (string), `users` = ids, `userMap` = { [userId]: valor } (solo entradas explicitas). Funciones no enumerables: `settings.forUser(key, userId)` / `settings.getUserValue(key, userId)` resuelven un userMap con su `default`.
extensionobligatorio	`HandlerExtensionInfo`	Sin descripción.
servicesobligatorio	`HandlerServices`	Sin descripción.
libsobligatorio	`HandlerLibs`	SDK de proveedores OAuth (`ctx.libs.google`, `ctx.libs.microsoft`, `ctx.libs.zoom`, `ctx.libs.slack`...): acciones tipadas, sin tokens.
hookobligatorio	`{ event: string; eventKey?: string; } \| null`	Procedencia de hook, FIJADA POR EL SERVIDOR (el cliente no puede enviarla): `{ event, eventKey? }` cuando el handler corre por un intercept de /api/extension/hooks y `null` en cualquier otra llamada (CALL_BACKEND, /execute). Los handlers que actuan sobre eventos (webhooks, altas...) deben exigir `ctx.hook?.event === "..."`: el resto del contexto (`ctx.event`, `ctx.subjectUserId`...) puede venir de un cliente.
authopcional	`{ provider?: string; accessToken?: string; [provider: string]: any; }`	Cuentas vinculadas del usuario: `ctx.auth.google.accessToken`. [INCIERTO: forma exacta segun proveedor]
emailContentopcional	`string`	Sin descripción.
emailIdopcional	`string`	Sin descripción.
subjectopcional	`string`	Sin descripción.
toopcional	`string[] \| string`	Sin descripción.
fromopcional	`string`	Sin descripción.
senderopcional	`{ email?: string; name?: string; }`	Sin descripción.
[clientContext: string]	`any`	Sin descripción.

Ejemplos

export async function greet(ctx) {
    const name = String(ctx.args.name || "").trim();
    if (!name) throw new Error("name es obligatorio");
    return { text: "Hola " + name + " desde " + ctx.domain.name };
}

Handler

Referencia a

Fuente: bloomx-extensions/_shared/sdk/ctx.d.ts:849 · ctx.d.ts

Estructura

Texto

Acciones

Entradas y formularios

Datos

Navegación

Estado y avisos

Superpuestos

Gráficos

Lógica

HandlerContext

Firma

Parámetros de tipo

Miembros (17)

Ejemplos

Referencia a

Estructura

Texto

Acciones

Entradas y formularios

Datos

Navegación

Estado y avisos

Superpuestos

Gráficos

Lógica

HandlerContext

Firma

Parámetros de tipo

Miembros (17)

Ejemplos

Referencia a

Firma

Parámetros de tipo

Miembros (17)

Ejemplos

Usado en / Referenciado por

Referencia a

Firma

Parámetros de tipo

Miembros (17)

Ejemplos

Usado en / Referenciado por

Referencia a