Página generada desde el TSDoc de @styx/clients. No se edita a mano: bun run docs:gen la regenera y bun run docs:check falla si difiere.

Function: createStyxClient()Copiar enlace

createStyxClient(baseUrl?, headers?): object

Crea un cliente Eden tipado contra App (catalog-svc).

ParametersCopiar enlace

baseUrl?Copiar enlace

string = CATALOG_SVC_URL

URL del servicio. En server vía env; en cliente vía VITE_.

headers?Copiar enlace

(path) => Record<string, string>

Cabeceras por request (X-Request-ID, authorization, traceparent).

ReturnsCopiar enlace

object

Cliente Eden.

healthCopiar enlace

health: object & object

Type DeclarationCopiar enlace

getCopiar enlace

get: (options?) => Promise<TreatyResponse<{ 200: { status: "ok"; timestamp: number; uptime: number; version: string; }; }>> & object

Type DeclarationCopiar enlace

~pathCopiar enlace

~path: string

Type DeclarationCopiar enlace

~pathCopiar enlace

~path: string

kindsCopiar enlace

kinds: object & object

Type DeclarationCopiar enlace

getCopiar enlace

get: (options?) => Promise<TreatyResponse<{ 200: { kinds: readonly object[]; }; 400: { category: ErrorCategory; code: "CATALOG_INVALID_PATH" | "CATALOG_PERMISSION_DENIED" | "CATALOG_MEDIA_UNSUPPORTED" | "CATALOG_MEDIA_TIMELINE_OUT_OF_RANGE" | "CATALOG_INVALID_INPUT"; detail?: string; instance?: string; retryable: boolean; status: 400; title: string; type: string; }; 404: { category: ErrorCategory; code: "CATALOG_ASSET_NOT_FOUND" | "CATALOG_WORK_NOT_FOUND" | "CATALOG_EDITION_NOT_FOUND"; detail?: string; instance?: string; retryable: boolean; status: 404; title: string; type: string; }; 422: { code: "validation"; detail?: string; on?: string; property?: string; status: 422; title: string; type: string; }; 500: { category: ErrorCategory; code: "CATALOG_INTERNAL"; detail?: string; instance?: string; retryable: boolean; status: 500; title: string; type: string; }; 502: { category: ErrorCategory; code: "CATALOG_PROBE_FAILED"; detail?: string; instance?: string; retryable: boolean; status: 502; title: string; type: string; }; 503: { category: ErrorCategory; code: "CATALOG_DB_WRITE_FAILED" | "CATALOG_DB_READ_FAILED" | "CATALOG_NATS_PUBLISH_FAILED"; detail?: string; instance?: string; retryable: boolean; status: 503; title: string; type: string; }; 504: { category: ErrorCategory; code: "CATALOG_PROBE_TIMEOUT"; detail?: string; instance?: string; retryable: boolean; status: 504; title: string; type: string; }; }>> & object

Type DeclarationCopiar enlace

~pathCopiar enlace

~path: string

Type DeclarationCopiar enlace

~pathCopiar enlace

~path: string

scanCopiar enlace

scan: object & object

Type DeclarationCopiar enlace

postCopiar enlace

post: (body, options?) => Promise<TreatyResponse<{ 200: { asset: { container?: ... | ...; createdAt: number; editionId: ... & ...; fastHash?: ... | ...; id: ... & ...; identification?: ... | ... | ...; kind: "logical-composition"; layout?: ... | ... | ... | ...; path: string; sizeBytes: number; updatedAt: number; }; index?: { assetId: ...; bitrateBps: ...; capabilities: ...; container: ...; createdAt: ...; durationMs: ...; id: ...; indexVersion: ...; keyframesMs?: ...; streams: ...; }; indexed: boolean; }; 400: { code: "parse"; detail?: ... | ...; status: 400; title: string; type: string; } | { category: ErrorCategory; code: ... | ... | ... | ... | ...; detail?: ... | ...; instance?: ... | ...; retryable: boolean; status: 400; title: string; type: string; }; 401: { code: "unauthenticated" | "reauth-required"; detail?: string; status: 401; title: string; type: string; }; 403: { code: "forbidden"; detail?: string; status: 403; title: string; type: string; }; 404: { category: ErrorCategory; code: "CATALOG_ASSET_NOT_FOUND" | "CATALOG_WORK_NOT_FOUND" | "CATALOG_EDITION_NOT_FOUND"; detail?: string; instance?: string; retryable: boolean; status: 404; title: string; type: string; }; 422: { code: "validation"; detail?: string; on?: string; property?: string; status: 422; title: string; type: string; }; 429: { code: "rate-limited"; detail?: string; status: 429; title: string; type: string; }; 500: { category: ErrorCategory; code: "CATALOG_INTERNAL"; detail?: string; instance?: string; retryable: boolean; status: 500; title: string; type: string; }; 502: { category: ErrorCategory; code: "CATALOG_PROBE_FAILED"; detail?: string; instance?: string; retryable: boolean; status: 502; title: string; type: string; }; 503: { category: ErrorCategory; code: "CATALOG_DB_WRITE_FAILED" | "CATALOG_DB_READ_FAILED" | "CATALOG_NATS_PUBLISH_FAILED"; detail?: string; instance?: string; retryable: boolean; status: 503; title: string; type: string; }; 504: { category: ErrorCategory; code: "CATALOG_PROBE_TIMEOUT"; detail?: string; instance?: string; retryable: boolean; status: 504; title: string; type: string; }; }>> & object

Type DeclarationCopiar enlace

~pathCopiar enlace

~path: string

Type DeclarationCopiar enlace

~pathCopiar enlace

~path: string

versionCopiar enlace

version: object & object

Type DeclarationCopiar enlace

getCopiar enlace

get: (options?) => Promise<TreatyResponse<{ 200: { commit: string; component: string; train: string; version: string; }; }>> & object

Type DeclarationCopiar enlace

~pathCopiar enlace

~path: string

Type DeclarationCopiar enlace

~pathCopiar enlace

~path: string

worksCopiar enlace

works: (params) => object & object & object & object

Type DeclarationCopiar enlace

getCopiar enlace

get: (options?) => Promise<TreatyResponse<{ 200: { total: number; works: readonly object[]; }; 400: { category: ErrorCategory; code: "CATALOG_INVALID_PATH" | "CATALOG_PERMISSION_DENIED" | "CATALOG_MEDIA_UNSUPPORTED" | "CATALOG_MEDIA_TIMELINE_OUT_OF_RANGE" | "CATALOG_INVALID_INPUT"; detail?: string; instance?: string; retryable: boolean; status: 400; title: string; type: string; }; 404: { category: ErrorCategory; code: "CATALOG_ASSET_NOT_FOUND" | "CATALOG_WORK_NOT_FOUND" | "CATALOG_EDITION_NOT_FOUND"; detail?: string; instance?: string; retryable: boolean; status: 404; title: string; type: string; }; 422: { code: "validation"; detail?: string; on?: string; property?: string; status: 422; title: string; type: string; }; 500: { category: ErrorCategory; code: "CATALOG_INTERNAL"; detail?: string; instance?: string; retryable: boolean; status: 500; title: string; type: string; }; 502: { category: ErrorCategory; code: "CATALOG_PROBE_FAILED"; detail?: string; instance?: string; retryable: boolean; status: 502; title: string; type: string; }; 503: { category: ErrorCategory; code: "CATALOG_DB_WRITE_FAILED" | "CATALOG_DB_READ_FAILED" | "CATALOG_NATS_PUBLISH_FAILED"; detail?: string; instance?: string; retryable: boolean; status: 503; title: string; type: string; }; 504: { category: ErrorCategory; code: "CATALOG_PROBE_TIMEOUT"; detail?: string; instance?: string; retryable: boolean; status: 504; title: string; type: string; }; }>> & object

Type DeclarationCopiar enlace

~pathCopiar enlace

~path: string

Type DeclarationCopiar enlace

~pathCopiar enlace

~path: string