dag-node / Exports

dag-node

Table of contents

Classes

• AbstractNodeDefinition
• StaticNodeTaskHandlerRegistry
• NodeIoAccessor
• RegisteredNodeLifecycle
• StaticNodeLifecycleFactory
• StaticNodeManifestRegistry
• MediaReference

Interfaces

• IParsedBinaryValue
• IBinaryPortPreset
• IBinaryPortDefinitionInput
• IMediaReferenceCandidate

Variables

• BINARY_PORT_PRESETS
• MediaReferenceSchema

Functions

• parseBinaryValue
• createStaticNodeLifecycleFactory
• buildNodeDefinitionAssembly
• createBinaryPortDefinition
• createMediaReferenceConfigSchema
• buildConfigSchema

Variables

BINARY_PORT_PRESETS

• Const BINARY_PORT_PRESETS: Object

Common binary port presets for image, video, audio, and file ports.

Type declaration

Name	Type
IMAGE_PNG	{ binaryKind: "image" = 'image'; mimeTypes: readonly ["image/png"] }
IMAGE_PNG.binaryKind	"image"
IMAGE_PNG.mimeTypes	readonly ["image/png"]
IMAGE_COMMON	{ binaryKind: "image" = 'image'; mimeTypes: readonly ["image/png", "image/jpeg", "image/webp"] }
IMAGE_COMMON.binaryKind	"image"
IMAGE_COMMON.mimeTypes	readonly ["image/png", "image/jpeg", "image/webp"]
VIDEO_MP4	{ binaryKind: "video" = 'video'; mimeTypes: readonly ["video/mp4"] }
VIDEO_MP4.binaryKind	"video"
VIDEO_MP4.mimeTypes	readonly ["video/mp4"]
AUDIO_MPEG	{ binaryKind: "audio" = 'audio'; mimeTypes: readonly ["audio/mpeg"] }
AUDIO_MPEG.binaryKind	"audio"
AUDIO_MPEG.mimeTypes	readonly ["audio/mpeg"]
FILE_GENERIC	{ binaryKind: "file" = 'file'; mimeTypes: readonly [] = [] }
FILE_GENERIC.binaryKind	"file"
FILE_GENERIC.mimeTypes	readonly []

Defined in

packages/dag-node/src/port-definition-helpers.ts:10

---

MediaReferenceSchema

• Const MediaReferenceSchema: ZodUnion<[ZodObject<{ referenceType: ZodLiteral<"asset"> ; assetId: ZodString = NonEmptyString; mediaType: ZodOptional<ZodString> ; name: ZodOptional<ZodString> ; sizeBytes: ZodOptional<ZodNumber> }, "strip", ZodTypeAny, { referenceType: "asset" ; assetId: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }, { referenceType: "asset" ; assetId: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }>, ZodObject<{ referenceType: ZodLiteral<"uri"> ; uri: ZodString = NonEmptyString; mediaType: ZodOptional<ZodString> ; name: ZodOptional<ZodString> ; sizeBytes: ZodOptional<ZodNumber> }, "strip", ZodTypeAny, { referenceType: "uri" ; uri: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }, { referenceType: "uri" ; uri: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }>]>

Defined in

packages/dag-node/src/schemas/media-reference-schema.ts:22

Functions

parseBinaryValue

▸ parseBinaryValue(rawValue, nodeId, key, kind?): TResult<IParsedBinaryValue, IDagError>

Parses and validates a raw port value as a binary payload object.

Parameters

Name	Type	Description
rawValue	TPortValue	The raw port value to parse.
nodeId	string	The node identifier (for error context).
key	string	The port key name (for error context).
kind?	"image" | "video" | "audio" | "file"	Optional expected binary kind constraint.

Returns

TResult<IParsedBinaryValue, IDagError>

A validated binary value or a validation error.

Defined in

packages/dag-node/src/lifecycle/binary-value-parser.ts:25

---

createStaticNodeLifecycleFactory

▸ createStaticNodeLifecycleFactory(handlersByType): StaticNodeLifecycleFactory

Parameters

Name	Type
handlersByType	Record<string, INodeTaskHandler>

Returns

StaticNodeLifecycleFactory

Defined in

packages/dag-node/src/lifecycle/static-node-lifecycle-factory.ts:38

---

buildNodeDefinitionAssembly

▸ buildNodeDefinitionAssembly(nodeDefinitions): TResult<INodeDefinitionAssembly, IDagError>

Build manifests and handler registry from an array of node definitions.

Parameters

Name	Type	Description
nodeDefinitions	IDagNodeDefinition[]	Node definitions to assemble

Returns

TResult<INodeDefinitionAssembly, IDagError>

Assembly of manifests and handlers, or an error if config schema validation fails

Defined in

packages/dag-node/src/node-definition-assembly.ts:9

---

createBinaryPortDefinition

▸ createBinaryPortDefinition(input): IPortDefinition

Create an IPortDefinition for a binary port from a preset-based input.

Parameters

Name	Type	Description
input	IBinaryPortDefinitionInput	Binary port specification including preset, key, and constraints

Returns

IPortDefinition

A fully populated port definition with type 'binary'

Defined in

packages/dag-node/src/port-definition-helpers.ts:36

---

createMediaReferenceConfigSchema

▸ createMediaReferenceConfigSchema(): ZodObject<{ asset: ZodUnion<[ZodObject<{ referenceType: ZodLiteral<"asset"> ; assetId: ZodString = NonEmptyString; mediaType: ZodOptional<ZodString> ; name: ZodOptional<ZodString> ; sizeBytes: ZodOptional<ZodNumber> }, "strip", ZodTypeAny, { referenceType: "asset" ; assetId: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }, { referenceType: "asset" ; assetId: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }>, ZodObject<{ referenceType: ZodLiteral<"uri"> ; uri: ZodString = NonEmptyString; mediaType: ZodOptional<ZodString> ; name: ZodOptional<ZodString> ; sizeBytes: ZodOptional<ZodNumber> }, "strip", ZodTypeAny, { referenceType: "uri" ; uri: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }, { referenceType: "uri" ; uri: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }>]> = MediaReferenceSchema }, "strip", ZodTypeAny, { asset: { referenceType: "asset" ; assetId: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number } | { referenceType: "uri" ; uri: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number } = MediaReferenceSchema }, { asset: { referenceType: "asset" ; assetId: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number } | { referenceType: "uri" ; uri: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number } = MediaReferenceSchema }>

Returns

ZodObject<{ asset: ZodUnion<[ZodObject<{ referenceType: ZodLiteral<"asset"> ; assetId: ZodString = NonEmptyString; mediaType: ZodOptional<ZodString> ; name: ZodOptional<ZodString> ; sizeBytes: ZodOptional<ZodNumber> }, "strip", ZodTypeAny, { referenceType: "asset" ; assetId: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }, { referenceType: "asset" ; assetId: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }>, ZodObject<{ referenceType: ZodLiteral<"uri"> ; uri: ZodString = NonEmptyString; mediaType: ZodOptional<ZodString> ; name: ZodOptional<ZodString> ; sizeBytes: ZodOptional<ZodNumber> }, "strip", ZodTypeAny, { referenceType: "uri" ; uri: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }, { referenceType: "uri" ; uri: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number }>]> = MediaReferenceSchema }, "strip", ZodTypeAny, { asset: { referenceType: "asset" ; assetId: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number } | { referenceType: "uri" ; uri: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number } = MediaReferenceSchema }, { asset: { referenceType: "asset" ; assetId: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number } | { referenceType: "uri" ; uri: string = NonEmptyString; mediaType?: string ; name?: string ; sizeBytes?: number } = MediaReferenceSchema }>

Defined in

packages/dag-node/src/schemas/media-reference-schema.ts:24

---

buildConfigSchema

▸ buildConfigSchema(configSchemaDefinition): TResult<Record<string, unknown>, IDagError>

Convert a zod schema to a JSON Schema representation for node config.

Parameters

Name	Type	Description
configSchemaDefinition	unknown	Must be a zod schema instance

Returns

TResult<Record<string, unknown>, IDagError>

JSON Schema object or validation error

Defined in

packages/dag-node/src/utils/node-descriptor.ts:18