Stately

    schema

    Files plugin schema extensions.

    This module defines the RelativePath node type for handling file paths in Stately schemas. The node type is automatically registered when you add the files plugin to your schema.

    Interfaces

    RelativePathNode

    Defined in: files/src/schema.ts:70

    Schema node for relative file paths.

    Used in schemas to represent paths relative to a storage directory. The path can be either a simple string or an object with dir/path properties.

    Examples

    ConfigPath:
  type: string
  x-stately-node: relativePath
    // Simple string path
const path1: RelativePath = "configs/pipeline.yaml";

// Object with directory
const path2: RelativePath = { dir: "upload", path: "configs/pipeline.yaml" };

    Extends

    Properties

    description?

    optional description: string

    Defined in: schema/dist/nodes.d.ts:30

    Optional description from the OpenAPI schema.

    Inherited from

    BaseNode.description

    nodeType

    nodeType: "relativePath"

    Defined in: files/src/schema.ts:71

    Discriminator identifying the node type (e.g., 'object', 'string', 'array').

    Overrides

    BaseNode.nodeType

    Type Aliases

    FilesData

    FilesData = DefineData

    Defined in: files/src/schema.ts:35

    Runtime data for the files plugin.

    Currently empty - no runtime caches or registries are needed.

    FilesNodeMap

    FilesNodeMap = object

    Defined in: files/src/schema.ts:79

    Node map for files plugin augmentation.

    Maps node type identifiers to their node definitions for the plugin system.

    Properties

    relativePath

    relativePath: RelativePathNode

    Defined in: files/src/schema.ts:79

    FilesTypes

    FilesTypes = DefineTypes<{ FileEntryType: FileEntryType; FileInfo: FileInfo; FileSaveRequest: FileSaveRequest; FileVersion: FileVersion; }>

    Defined in: files/src/schema.ts:19

    Type definitions provided by the files plugin.

    These types are available in your schema when the files plugin is installed.

    TFilesNodeType

    TFilesNodeType = typeof FilesNodeType[keyof typeof FilesNodeType]

    Defined in: files/src/schema.ts:46

    Union type of all files plugin node types

    Variables

    FilesNodeType

    const FilesNodeType: object

    Defined in: files/src/schema.ts:40

    Node type identifiers for the files plugin.

    Type Declaration

    RelativePath

    readonly RelativePath: "relativePath" = 'relativePath'

    Represents a path relative to a storage directory