tubeless 0.1.0

package/docs/api-reference.md

@@ -0,0 +1,269 @@
+# `tubeless` API reference
+
+Generated from the package's emitted declaration files. Do not edit manually; run `bun run api:generate` from the package root.
+
+Package: `tubeless`
+
+## Public entrypoints
+
+| Entrypoint                  | Declaration                    | Surface hash                                                       | Exported symbols |
+| --------------------------- | ------------------------------ | ------------------------------------------------------------------ | ---------------: |
+| `tubeless`                  | `./dist/pipeline.d.ts`         | `e0c9802d5dcb71b319562d301c452446d74ea1c67d18b3ad76617467127bca71` |               68 |
+| `tubeless/batch`            | `./dist/batch.d.ts`            | `2ae7ccbf0fb6582243d2a395c2d2b0fe561fd19d3850309321b7d270c5a8d015` |                5 |
+| `tubeless/cli`              | `./dist/cli.d.ts`              | `fa8aeac9a22f491ef6b90da82fd15523e87d6185a93efcc57568337dff2086fb` |               36 |
+| `tubeless/node`             | `./dist/node.d.ts`             | `d6f70752eb9e0ea752b8e2bfb9418f5d30bd46d790360504434fdfeb6a6f7414` |                8 |
+| `tubeless/rate-limit`       | `./dist/rate-limit.d.ts`       | `2376474470b4fdc671f45daa90cb47cb0fd94653ba77ee9f03dcd10af7c0b022` |                1 |
+| `tubeless/render`           | `./dist/render.d.ts`           | `1e9e3c4f18d8cf6992ec48c7f793ebbfc3bc43219d8694fb6cee76da83d98479` |                6 |
+| `tubeless/reporter`         | `./dist/reporter-entry.d.ts`   | `c2cf9ffaa7f5f80d1cb936b373782baeb2a33b1f2847fd7dbe3b36d7cc6dc199` |               13 |
+| `tubeless/retry`            | `./dist/retry.d.ts`            | `8b93425242c618f533498fa9d1670d321e69c4bab7bfaa000ab2464c1b755f4a` |                4 |
+| `tubeless/run-store`        | `./dist/run-store.d.ts`        | `2031752bcabe730abce31dacf5d439159e8bb1bfed0ac6793092b6d5968555fe` |               15 |
+| `tubeless/run-store/sqlite` | `./dist/run-store-sqlite.d.ts` | `13a9d5b25010b79c1771f81eb681d990e14288a3cefa2520dde21eb9535328ff` |                2 |
+| `tubeless/workbench/studio` | `./dist/workbench-studio.d.ts` | `2afced697589a4d76527107c9517921512c46ad62c074743264cb415a773539c` |                6 |
+| `tubeless/run-store/ui`     | `./dist/run-store-ui.d.ts`     | `b0c27f8b7d3481709b72912d7cae2ce325bb940315d432e53e3529dde7272e70` |                8 |
+| `tubeless/testing`          | `./dist/testing.d.ts`          | `a6e8a051df80bc56942c195d8fe62e4bb1e9436164c618abe703ffd51c9f1c34` |                7 |
+| `tubeless/tracing`          | `./dist/tracing.d.ts`          | `aaa44ca17255d9da1ae3a2e29c0e62e4fc279de16b3526831023289d6d3c1b12` |                8 |
+| `tubeless/tracing/json`     | `./dist/tracing-json.d.ts`     | `dcd58eb97dc8e08e2a5097a4f5435bf1d87901fb8c2b0bc387fcbce6d4caddc0` |                2 |
+| `tubeless/tracing/otel`     | `./dist/tracing-otel.d.ts`     | `307853d3987eeb64a0ccdfb945933a0c1f016fe4f13b6ad8f3fe1e4045746814` |                4 |
+
+## Symbols
+
+### `tubeless`
+
+- `AnyStep`
+- `createRunId`
+- `createSteps`
+- `defaultPipelineContext`
+- `definePipeline`
+- `formatMappedChildProgressMessage`
+- `FormatMappedChildProgressOptions`
+- `InferSchemaInput`
+- `InferSchemaOutput`
+- `MappedChildProgressDetail`
+- `mappedChildProgressDetails`
+- `MappedChildProgressOptions`
+- `MappedChildProgressSnapshot`
+- `mappedChildProgressUnits`
+- `MappedChildProgressUnits`
+- `Pipeline`
+- `PIPELINE_FINALIZE_STEP_ID`
+- `PipelineContext`
+- `PipelineDefinition`
+- `PipelineDefinitionError`
+- `PipelineError`
+- `PipelineErrorCause`
+- `PipelineErrorCode`
+- `PipelineErrorKind`
+- `PipelineErrorPhase`
+- `PipelineExecutionContext`
+- `PipelineExecutionError`
+- `PipelineHooks`
+- `PipelineLogger`
+- `PipelineMermaidDirection`
+- `PipelineMermaidOptions`
+- `PipelinePlan`
+- `PipelinePlanStep`
+- `PipelineRun`
+- `PipelineRunControls`
+- `PipelineRunOptions`
+- `PipelineRunStatus`
+- `PipelineRuntime`
+- `PipelineStepCancelledEvent`
+- `PipelineStepCancelledReport`
+- `PipelineStepCompleteEvent`
+- `PipelineStepCompleteReport`
+- `PipelineStepContext`
+- `PipelineStepFailedEvent`
+- `PipelineStepFailedReport`
+- `PipelineStepPlannedEvent`
+- `PipelineStepProgress`
+- `PipelineStepProgressDetail`
+- `PipelineStepProgressEvent`
+- `PipelineStepReport`
+- `PipelineStepSelectionReason`
+- `PipelineStepSkippedEvent`
+- `PipelineStepSkippedReport`
+- `PipelineStepSkipReason`
+- `PipelineStepStartEvent`
+- `PipelineStepStatus`
+- `PipelineValidationIssue`
+- `requireOutputs`
+- `RUN_MODEL_VERSION`
+- `StandardSchemaV1`
+- `StandardSchemaV1Issue`
+- `StandardSchemaV1Props`
+- `StandardSchemaV1Result`
+- `Step`
+- `StepFactory`
+- `StepSkipDecision`
+- `toMappedChildStepProgress`
+- `ToMappedChildStepProgressOptions`
+
+### `tubeless/batch`
+
+- `chunk`
+- `ConcurrentWorker`
+- `runBatched`
+- `runConcurrent`
+- `RunConcurrentOptions`
+
+### `tubeless/cli`
+
+- `CliBooleanParam`
+- `CliCheckpointConfig`
+- `CliCommand`
+- `CliCommandConfig`
+- `CliCommandDescriptor`
+- `CliContext`
+- `CliHelpRequested`
+- `CliNumberParam`
+- `CliParam`
+- `CliParameterDescriptor`
+- `CliParams`
+- `CliParamsSchema`
+- `CliParamType`
+- `CliParseResult`
+- `CliPathParam`
+- `CliStringParam`
+- `CliValidationError`
+- `defineCommand`
+- `definePipelineCommand`
+- `DefinePipelineCommandConfig`
+- `MultiSelectChoice`
+- `MultiSelectResult`
+- `normalizeMultiSelectChoices`
+- `parseMultiSelectInput`
+- `ParseMultiSelectInputOptions`
+- `PipelineCliBuiltins`
+- `PipelineCliParseResult`
+- `PipelineCliValues`
+- `PipelineCommand`
+- `PipelineCommandHookConfig`
+- `PipelineCommandHookContext`
+- `PipelineCommandHookSets`
+- `PipelineCommandPlanInput`
+- `promptMultiSelect`
+- `PromptMultiSelectOptions`
+- `TUBELESS_WORKBENCH_EXIT_CODE`
+
+### `tubeless/node`
+
+- `CheckpointStore`
+- `definePaths`
+- `openCheckpoint`
+- `readJson`
+- `requireEnv`
+- `resetDir`
+- `withCheckpointedBatch`
+- `writeJson`
+
+### `tubeless/rate-limit`
+
+- `RateLimiter`
+
+### `tubeless/render`
+
+- `PipelineHumanRenderOptions`
+- `PipelineJsonRenderOptions`
+- `PipelinePlanRenderOptions`
+- `PipelineRenderOptions`
+- `renderPipelineError`
+- `renderPipelinePlan`
+
+### `tubeless/reporter`
+
+- `createPipelineReporter`
+- `createRunReporter`
+- `PipelineReporterConfig`
+- `PipelineReporterController`
+- `PipelineReporterMode`
+- `PipelineReporterOptions`
+- `ReporterColorMode`
+- `ReporterOutput`
+- `ReporterSymbolMode`
+- `ReporterTerminalCapabilities`
+- `ResolvedPipelineReporterMode`
+- `RunReporterConfig`
+- `RunReporterOptions`
+
+### `tubeless/retry`
+
+- `RetryAttemptContext`
+- `RetryOperation`
+- `RetryOptions`
+- `withRetry`
+
+### `tubeless/run-store`
+
+- `createPipelineRunProjector`
+- `PipelineRunEventQuery`
+- `PipelineRunEventStore`
+- `PipelineRunProjector`
+- `PipelineRunStoreSnapshot`
+- `projectPipelineRun`
+- `projectPipelineRunStore`
+- `StoredPipelineAttempt`
+- `StoredPipelineDefinition`
+- `StoredPipelineDefinitionStep`
+- `StoredPipelineEvent`
+- `StoredPipelineLog`
+- `StoredPipelineRun`
+- `StoredPipelineRunStatus`
+- `StoredPipelineStep`
+
+### `tubeless/run-store/sqlite`
+
+- `openSqlitePipelineRunStore`
+- `SqlitePipelineRunStore`
+
+### `tubeless/workbench/studio`
+
+- `definePipelineStudio`
+- `isPipelineStudioConfig`
+- `PIPELINE_STUDIO_CONFIG_VERSION`
+- `PipelineStudioCommandModule`
+- `PipelineStudioConfig`
+- `PipelineStudioConfigInput`
+
+### `tubeless/run-store/ui`
+
+- `PipelineRunStudioCommand`
+- `PipelineRunStudioHistoryMaintenance`
+- `PipelineRunStudioLauncher`
+- `PipelineRunStudioLaunchRequest`
+- `PipelineRunStudioLaunchResult`
+- `PipelineRunStudioOptions`
+- `PipelineRunStudioServer`
+- `startPipelineRunStudio`
+
+### `tubeless/testing`
+
+- `createPipelineTestRuntime`
+- `PipelineTestClock`
+- `PipelineTestLogEntry`
+- `PipelineTestLogLevel`
+- `PipelineTestRuntime`
+- `PipelineTestRuntimeOptions`
+- `PipelineTestSleep`
+
+### `tubeless/tracing`
+
+- `PipelineTraceAttributes`
+- `PipelineTraceAttributeValue`
+- `PipelineTraceContext`
+- `PipelineTraceError`
+- `PipelineTraceEvent`
+- `PipelineTraceEventName`
+- `PipelineTraceExporter`
+- `PipelineTracingOptions`
+
+### `tubeless/tracing/json`
+
+- `createJsonTraceExporter`
+- `JsonTraceExporterOptions`
+
+### `tubeless/tracing/otel`
+
+- `createOpenTelemetryTraceExporter`
+- `OpenTelemetryLikeSpan`
+- `OpenTelemetryLikeTracer`
+- `OpenTelemetryTraceExporterOptions`

package/docs/api-report.json

@@ -0,0 +1,298 @@
+{
+  "modules": [
+    {
+      "declaration": "./dist/pipeline.d.ts",
+      "exports": [
+        "AnyStep",
+        "createRunId",
+        "createSteps",
+        "defaultPipelineContext",
+        "definePipeline",
+        "formatMappedChildProgressMessage",
+        "FormatMappedChildProgressOptions",
+        "InferSchemaInput",
+        "InferSchemaOutput",
+        "MappedChildProgressDetail",
+        "mappedChildProgressDetails",
+        "MappedChildProgressOptions",
+        "MappedChildProgressSnapshot",
+        "mappedChildProgressUnits",
+        "MappedChildProgressUnits",
+        "Pipeline",
+        "PIPELINE_FINALIZE_STEP_ID",
+        "PipelineContext",
+        "PipelineDefinition",
+        "PipelineDefinitionError",
+        "PipelineError",
+        "PipelineErrorCause",
+        "PipelineErrorCode",
+        "PipelineErrorKind",
+        "PipelineErrorPhase",
+        "PipelineExecutionContext",
+        "PipelineExecutionError",
+        "PipelineHooks",
+        "PipelineLogger",
+        "PipelineMermaidDirection",
+        "PipelineMermaidOptions",
+        "PipelinePlan",
+        "PipelinePlanStep",
+        "PipelineRun",
+        "PipelineRunControls",
+        "PipelineRunOptions",
+        "PipelineRunStatus",
+        "PipelineRuntime",
+        "PipelineStepCancelledEvent",
+        "PipelineStepCancelledReport",
+        "PipelineStepCompleteEvent",
+        "PipelineStepCompleteReport",
+        "PipelineStepContext",
+        "PipelineStepFailedEvent",
+        "PipelineStepFailedReport",
+        "PipelineStepPlannedEvent",
+        "PipelineStepProgress",
+        "PipelineStepProgressDetail",
+        "PipelineStepProgressEvent",
+        "PipelineStepReport",
+        "PipelineStepSelectionReason",
+        "PipelineStepSkippedEvent",
+        "PipelineStepSkippedReport",
+        "PipelineStepSkipReason",
+        "PipelineStepStartEvent",
+        "PipelineStepStatus",
+        "PipelineValidationIssue",
+        "requireOutputs",
+        "RUN_MODEL_VERSION",
+        "StandardSchemaV1",
+        "StandardSchemaV1Issue",
+        "StandardSchemaV1Props",
+        "StandardSchemaV1Result",
+        "Step",
+        "StepFactory",
+        "StepSkipDecision",
+        "toMappedChildStepProgress",
+        "ToMappedChildStepProgressOptions"
+      ],
+      "sha256": "e0c9802d5dcb71b319562d301c452446d74ea1c67d18b3ad76617467127bca71",
+      "specifier": "tubeless"
+    },
+    {
+      "declaration": "./dist/batch.d.ts",
+      "exports": [
+        "chunk",
+        "ConcurrentWorker",
+        "runBatched",
+        "runConcurrent",
+        "RunConcurrentOptions"
+      ],
+      "sha256": "2ae7ccbf0fb6582243d2a395c2d2b0fe561fd19d3850309321b7d270c5a8d015",
+      "specifier": "tubeless/batch"
+    },
+    {
+      "declaration": "./dist/cli.d.ts",
+      "exports": [
+        "CliBooleanParam",
+        "CliCheckpointConfig",
+        "CliCommand",
+        "CliCommandConfig",
+        "CliCommandDescriptor",
+        "CliContext",
+        "CliHelpRequested",
+        "CliNumberParam",
+        "CliParam",
+        "CliParameterDescriptor",
+        "CliParams",
+        "CliParamsSchema",
+        "CliParamType",
+        "CliParseResult",
+        "CliPathParam",
+        "CliStringParam",
+        "CliValidationError",
+        "defineCommand",
+        "definePipelineCommand",
+        "DefinePipelineCommandConfig",
+        "MultiSelectChoice",
+        "MultiSelectResult",
+        "normalizeMultiSelectChoices",
+        "parseMultiSelectInput",
+        "ParseMultiSelectInputOptions",
+        "PipelineCliBuiltins",
+        "PipelineCliParseResult",
+        "PipelineCliValues",
+        "PipelineCommand",
+        "PipelineCommandHookConfig",
+        "PipelineCommandHookContext",
+        "PipelineCommandHookSets",
+        "PipelineCommandPlanInput",
+        "promptMultiSelect",
+        "PromptMultiSelectOptions",
+        "TUBELESS_WORKBENCH_EXIT_CODE"
+      ],
+      "sha256": "fa8aeac9a22f491ef6b90da82fd15523e87d6185a93efcc57568337dff2086fb",
+      "specifier": "tubeless/cli"
+    },
+    {
+      "declaration": "./dist/node.d.ts",
+      "exports": [
+        "CheckpointStore",
+        "definePaths",
+        "openCheckpoint",
+        "readJson",
+        "requireEnv",
+        "resetDir",
+        "withCheckpointedBatch",
+        "writeJson"
+      ],
+      "sha256": "d6f70752eb9e0ea752b8e2bfb9418f5d30bd46d790360504434fdfeb6a6f7414",
+      "specifier": "tubeless/node"
+    },
+    {
+      "declaration": "./dist/rate-limit.d.ts",
+      "exports": ["RateLimiter"],
+      "sha256": "2376474470b4fdc671f45daa90cb47cb0fd94653ba77ee9f03dcd10af7c0b022",
+      "specifier": "tubeless/rate-limit"
+    },
+    {
+      "declaration": "./dist/render.d.ts",
+      "exports": [
+        "PipelineHumanRenderOptions",
+        "PipelineJsonRenderOptions",
+        "PipelinePlanRenderOptions",
+        "PipelineRenderOptions",
+        "renderPipelineError",
+        "renderPipelinePlan"
+      ],
+      "sha256": "1e9e3c4f18d8cf6992ec48c7f793ebbfc3bc43219d8694fb6cee76da83d98479",
+      "specifier": "tubeless/render"
+    },
+    {
+      "declaration": "./dist/reporter-entry.d.ts",
+      "exports": [
+        "createPipelineReporter",
+        "createRunReporter",
+        "PipelineReporterConfig",
+        "PipelineReporterController",
+        "PipelineReporterMode",
+        "PipelineReporterOptions",
+        "ReporterColorMode",
+        "ReporterOutput",
+        "ReporterSymbolMode",
+        "ReporterTerminalCapabilities",
+        "ResolvedPipelineReporterMode",
+        "RunReporterConfig",
+        "RunReporterOptions"
+      ],
+      "sha256": "c2cf9ffaa7f5f80d1cb936b373782baeb2a33b1f2847fd7dbe3b36d7cc6dc199",
+      "specifier": "tubeless/reporter"
+    },
+    {
+      "declaration": "./dist/retry.d.ts",
+      "exports": ["RetryAttemptContext", "RetryOperation", "RetryOptions", "withRetry"],
+      "sha256": "8b93425242c618f533498fa9d1670d321e69c4bab7bfaa000ab2464c1b755f4a",
+      "specifier": "tubeless/retry"
+    },
+    {
+      "declaration": "./dist/run-store.d.ts",
+      "exports": [
+        "createPipelineRunProjector",
+        "PipelineRunEventQuery",
+        "PipelineRunEventStore",
+        "PipelineRunProjector",
+        "PipelineRunStoreSnapshot",
+        "projectPipelineRun",
+        "projectPipelineRunStore",
+        "StoredPipelineAttempt",
+        "StoredPipelineDefinition",
+        "StoredPipelineDefinitionStep",
+        "StoredPipelineEvent",
+        "StoredPipelineLog",
+        "StoredPipelineRun",
+        "StoredPipelineRunStatus",
+        "StoredPipelineStep"
+      ],
+      "sha256": "2031752bcabe730abce31dacf5d439159e8bb1bfed0ac6793092b6d5968555fe",
+      "specifier": "tubeless/run-store"
+    },
+    {
+      "declaration": "./dist/run-store-sqlite.d.ts",
+      "exports": ["openSqlitePipelineRunStore", "SqlitePipelineRunStore"],
+      "sha256": "13a9d5b25010b79c1771f81eb681d990e14288a3cefa2520dde21eb9535328ff",
+      "specifier": "tubeless/run-store/sqlite"
+    },
+    {
+      "declaration": "./dist/workbench-studio.d.ts",
+      "exports": [
+        "definePipelineStudio",
+        "isPipelineStudioConfig",
+        "PIPELINE_STUDIO_CONFIG_VERSION",
+        "PipelineStudioCommandModule",
+        "PipelineStudioConfig",
+        "PipelineStudioConfigInput"
+      ],
+      "sha256": "2afced697589a4d76527107c9517921512c46ad62c074743264cb415a773539c",
+      "specifier": "tubeless/workbench/studio"
+    },
+    {
+      "declaration": "./dist/run-store-ui.d.ts",
+      "exports": [
+        "PipelineRunStudioCommand",
+        "PipelineRunStudioHistoryMaintenance",
+        "PipelineRunStudioLauncher",
+        "PipelineRunStudioLaunchRequest",
+        "PipelineRunStudioLaunchResult",
+        "PipelineRunStudioOptions",
+        "PipelineRunStudioServer",
+        "startPipelineRunStudio"
+      ],
+      "sha256": "b0c27f8b7d3481709b72912d7cae2ce325bb940315d432e53e3529dde7272e70",
+      "specifier": "tubeless/run-store/ui"
+    },
+    {
+      "declaration": "./dist/testing.d.ts",
+      "exports": [
+        "createPipelineTestRuntime",
+        "PipelineTestClock",
+        "PipelineTestLogEntry",
+        "PipelineTestLogLevel",
+        "PipelineTestRuntime",
+        "PipelineTestRuntimeOptions",
+        "PipelineTestSleep"
+      ],
+      "sha256": "a6e8a051df80bc56942c195d8fe62e4bb1e9436164c618abe703ffd51c9f1c34",
+      "specifier": "tubeless/testing"
+    },
+    {
+      "declaration": "./dist/tracing.d.ts",
+      "exports": [
+        "PipelineTraceAttributes",
+        "PipelineTraceAttributeValue",
+        "PipelineTraceContext",
+        "PipelineTraceError",
+        "PipelineTraceEvent",
+        "PipelineTraceEventName",
+        "PipelineTraceExporter",
+        "PipelineTracingOptions"
+      ],
+      "sha256": "aaa44ca17255d9da1ae3a2e29c0e62e4fc279de16b3526831023289d6d3c1b12",
+      "specifier": "tubeless/tracing"
+    },
+    {
+      "declaration": "./dist/tracing-json.d.ts",
+      "exports": ["createJsonTraceExporter", "JsonTraceExporterOptions"],
+      "sha256": "dcd58eb97dc8e08e2a5097a4f5435bf1d87901fb8c2b0bc387fcbce6d4caddc0",
+      "specifier": "tubeless/tracing/json"
+    },
+    {
+      "declaration": "./dist/tracing-otel.d.ts",
+      "exports": [
+        "createOpenTelemetryTraceExporter",
+        "OpenTelemetryLikeSpan",
+        "OpenTelemetryLikeTracer",
+        "OpenTelemetryTraceExporterOptions"
+      ],
+      "sha256": "307853d3987eeb64a0ccdfb945933a0c1f016fe4f13b6ad8f3fe1e4045746814",
+      "specifier": "tubeless/tracing/otel"
+    }
+  ],
+  "packageName": "tubeless",
+  "schemaVersion": 1
+}