Skip to content

fix(types): Added some missing type exports - #489

Merged
szanata merged 3 commits into
mainfrom
fix/typedocs_warnings
Oct 31, 2026
Merged

szanata merged 3 commits into
mainfrom
fix/typedocs_warnings

Conversation

@szanata

@szanata szanata commented Oct 30, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Export missing public types for HTTP fetch, workflow definitions, credential provider contexts, LLM calls, and eval verification
  • Rename credential context types to avoid collision with the workflow WorkflowContext
  • Ensure every public TypeDoc signature resolves to documented types
  • Document the credential context exports

Validation

  • pnpm --filter @outputai/core build
  • pnpm run docs:validate - 0 errors and 0 warnings

@szanata szanata changed the title fix(types): Fixed typedocs warnings and added some missing type exports fix(types): Fixed typedoc warnings and added some missing type exports Oct 30, 2026
Comment thread sdk/core/src/credentials/index.ts Outdated
resolveWorkflowKeyEnvVar
} from './paths.js';
export type { CredentialsProvider } from './types.js';
export type { CredentialsProvider, GlobalContext, WorkflowContext } from './types.js';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice-to-have (Quality): WorkflowContext collides by name with the unrelated WorkflowContext already exported from @outputai/core (src/interface/workflow.d.ts). Consider CredentialsWorkflowContext / CredentialsGlobalContext before these become public.

Comment thread typedoc.json Resolved
@github-actions

This comment was marked as outdated.

@mintlify

mintlify Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
outputai 🟢 Ready View Preview Oct 30, 2026, 11:13 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

This comment was marked as outdated.

@szanata szanata changed the title fix(types): Fixed typedoc warnings and added some missing type exports fix(types): Added some missing type exports Oct 31, 2026
/** Stop conditions accepted by text generation calls. */
export type StopWhen<Tools extends ToolSet = ToolSet> =
StopCondition<NoInfer<Tools>, Record<string, unknown>> |
Array<StopCondition<NoInfer<Tools>, Record<string, unknown>>>;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice-to-have (Quality): DefaultRuntimeContext was removed and Record<string, unknown> is now inlined in 7 public signatures. Exporting the alias (as was done for AnyAiOutput) would keep the runtime-context slot named and single-sourced.

@github-actions

Copy link
Copy Markdown
Contributor

PR review

Verdict

✅ PASS

Findings

  1. Nice-to-have (Quality): To satisfy TypeDoc, DefaultRuntimeContext and WithoutToolSchemaBrands were deleted and inlined instead of exported: Record<string, unknown> is now repeated across 7 public signatures in sdk/core/src/llm/index.d.ts (StopWhen, ExtractedSource, GenerateTextResult, streamText, Agent.stream, ...), and CompatibleTool grew an inline extends infer Tool conditional. Exporting the aliases — the approach taken for AnyAiOutput in the same diff — would keep them named and single-sourced.

  2. Nice-to-have (Documentation): The PR says it documents the credential context exports, but docs/guides/packages/core/credentials.mdx only adds CredentialsGlobalContext/CredentialsWorkflowContext to the API-Reference import line — no example or table row uses them, and the Custom Providers section still relies on inline destructuring. The v0.14→v0.15 migration guide also still points users at Parameters<CredentialsProvider['loadGlobal']>[0] now that named types exist.

Categories

  • Design: ✅ PASS
  • Quality: ✅ PASS
  • Correctness: ✅ PASS
  • Documentation: ✅ PASS
  • Changeset: ✅ PASS
  • Tests: ✅ PASS
  • Security: ✅ PASS
  • Compatibility: ✅ PASS

@szanata
szanata merged commit 91027b1 into main Oct 31, 2026
11 checks passed
@szanata
szanata deleted the fix/typedocs_warnings branch October 31, 2026 00:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant