型

@nodaro/sdk は、大半のメソッドの入力と出力に対して TypeScript の型をエクスポートしており、ヘルパー関数と定数もいくつかエクスポートしています。型は import type でインポートすれば、バンドルには何も追加されません。

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

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

型は、API の通信形式に従っています。Job は output_data や created_at のような snake_case のフィールドを使います。API がその形でデータを送るためです。Workflow と WorkflowExecution は camelCase を使います。オブジェクトの型である Object は、JavaScript のグローバルと同じ名前なので、両方が必要な場合は別の名前でインポートしてください。import type { Object as NodaroObject } from "@nodaro/sdk" のようにします。

メソッドが使う型の中には、エクスポートされていないものもあります。PipelineInput や CommunityFullDetail のように @nodaro/shared で定義されている型は、そちらからインポートします。@nodaro/shared は、SDK が使うのと同じバージョン範囲で、自分の依存関係に追加してください。そうすれば、インストールされるコピーは 1 つだけになります。PipelineRecord など、それ以外の型は、その型を返すメソッドから導出します。

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

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

クライアント、認証、エラー

ワークフロー、実行、ノード

メディア、ボイス、編集

アセット

プロダクション

アカウントとカタログ

ヘルパー関数と定数

これらは型ではなく値なので、type を付けずにインポートします。

WorkflowsResource や NodesResource のような各リソースのクラスも、高度な型付けのためにエクスポートされています。通常は必要ありません。createClient が、すべてのリソースを代わりに組み立てます。