Tipos

@nodaro/sdk exporta um tipo TypeScript para as entradas e as saídas da maioria dos métodos, além de algumas funções auxiliares e constantes. Importe os tipos com import type, para que eles não acrescentem nada ao seu bundle:

import type { Workflow, Job, NodeJobOutput, WorkflowExecution } from "@nodaro/sdk"

const { data }: { data: Workflow } = await client.workflows.get(id)

Os tipos seguem o formato de transmissão da API. Um Job usa campos em snake_case, como output_data e created_at, porque a API os envia assim. Um Workflow e um WorkflowExecution usam camelCase. Object, o tipo de objeto, tem o mesmo nome do objeto global do JavaScript, então importe-o com outro nome quando precisar dos dois: import type { Object as NodaroObject } from "@nodaro/sdk".

Alguns tipos que os métodos usam não são exportados. Um tipo definido em @nodaro/shared, como PipelineInput ou CommunityFullDetail, é importado de lá. Adicione @nodaro/shared às suas próprias dependências, na faixa de versões que o SDK usa, para que só uma cópia seja instalada. Derive qualquer outro tipo, como PipelineRecord, do método que o retorna:

import type { NodaroClient } from "@nodaro/sdk"
import type { PipelineInput, CommunityFullDetail } from "@nodaro/shared"

type PipelineRecord = Awaited<ReturnType<NodaroClient["pipelines"]["get"]>>

Cliente, autenticação e erros

Workflows, execuções e nós

Mídia, vozes e edição

Entidades

Produções

Conta e catálogos

Funções auxiliares e constantes

Estes são valores, não tipos, então importe-os sem type.

Toda classe de recurso, como WorkflowsResource ou NodesResource, também é exportada, para tipagem avançada. Você raramente precisa delas: createClient monta todos os recursos para você.