fix(types): expose core SDK types for external developer integration by murdore · Pull Request #181 · juspay/neurolink

murdore · 2025-09-21T10:52:05Z

Add comprehensive type exports via @juspay/neurolink/types
Create src/lib/types/sdkTypes.ts with 110+ essential types
Update package.json exports to include ./types path
Enable external developers to import StreamResult, ToolExecutionEvent, NeuroLinkConfig, ConversationMemoryConfig and other core types
Maintain existing type names and avoid breaking changes
Support maximum TypeScript integration across NeuroLink ecosystem

Pull Request

Description

Type of Change

🐛 Bug fix (non-breaking change which fixes an issue)
✨ New feature (non-breaking change which adds functionality)
💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
📚 Documentation update
🧹 Code refactoring (no functional changes)
⚡ Performance improvement
🧪 Test coverage improvement
🔧 Build/CI configuration change

Related Issues

Fixes #
Related to #

Changes Made

AI Provider Impact

Component Impact

Testing

Test Environment

OS:
Node.js version:
Package manager:

Performance Impact

No performance impact
Performance improvement
Minor performance impact (acceptable)
Significant performance impact (needs discussion)

Breaking Changes

Screenshots/Demo

Checklist

My code follows the project's style guidelines
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published

Additional Notes

Summary by CodeRabbit

New Features
- Added a dedicated types export, allowing consumers to import SDK types without pulling the main runtime.
- Expanded and centralized public type surface for providers and core SDK, offering a single entry point for type imports.
Refactor
- Internal cleanup and formatting improvements with no behavior changes.
Documentation
- Updated guidance to reflect the new centralized type imports and consolidated provider typings.
Tests
- Minor test setup adjustment with no impact on functionality.

- Add comprehensive type exports via @juspay/neurolink/types - Create src/lib/types/sdkTypes.ts with 110+ essential types - Update package.json exports to include ./types path - Enable external developers to import StreamResult, ToolExecutionEvent, NeuroLinkConfig, ConversationMemoryConfig and other core types - Maintain existing type names and avoid breaking changes - Support maximum TypeScript integration across NeuroLink ecosystem

coderabbitai · 2025-09-21T10:52:13Z

Caution

Review failed

The pull request is closed.

Walkthrough

Adds a new public ./types export in package.json and introduces src/lib/types/sdkTypes.ts as a consolidated type re-export surface. Updates src/lib/types/index.ts to re-export from sdkTypes. Minor formatting change in HITL manager. Small test setup tweak (let→const). Adds a refactor plan doc for provider types centralization.

Changes

Cohort / File(s)	Summary of Changes
Packaging: public types subpath `package.json`	Adds `exports["./types"]` with `types`, `import`, and `default` pointing to `./dist/types/sdkTypes.*` to expose SDK types as a separate entrypoint.
Types: central aggregation and re-exports `src/lib/types/index.ts`, `src/lib/types/sdkTypes.ts`	Introduces `sdkTypes.ts` that re-exports public types from multiple modules; updates `index.ts` to `export * from "./sdkTypes.js"`. No runtime logic added.
HITL formatting `src/lib/hitl/hitlManager.ts`	Reflows line breaks around `allowArgumentModification` defaulting; no behavioral change.
Tests setup minor tweak `test/environment-setup.js`	Changes `let availableProviders` to `const` while still mutating the array; no functional change.
Docs: providers types refactor plan `todos/refactor/03-providers-module.md`	Documents planned centralization of provider-related types, new `src/lib/providers/types.ts`, and updates to provider imports/metadata types.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant App as App (Consumer)
  participant Pkg as package.json (exports)
  participant Types as src/lib/types/sdkTypes.ts

  App->>Pkg: import { SomeType } from "package/types"
  Note over Pkg: Resolve "./types" subpath
  Pkg-->>App: points to dist/types/sdkTypes.js/.d.ts
  App->>Types: Load aggregated type exports
  Types-->>App: Re-exported SDK/provider types

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

refactor(types): restore centralized type system architecture #166 — Centralizes and reshapes public type exports, similar to adding sdkTypes and a dedicated types subpath.
chore(refactor): add comprehensive TypeScript compliance refactor plans #81 — Extends src/lib/types surface with consolidated exports, aligning with this PR’s sdkTypes entry.
refactor(types): complete provider and CLI module type consolidation #171 — Consolidates SDK/provider types into centralized src/lib/types/*, akin to this PR’s type aggregation.

Poem

A twitch of ears, a tap-tap type,
I bundled names both lean and ripe.
A fresh subpath, the types now sing,
One hop to find most everything.
With consts that stay and lines that flow—
The meadow’s tidy. Onward we go! 🐇✨

✨ Finishing touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix/expose-required-types

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c3d5bb4 and b4f5922.

📒 Files selected for processing (6)

package.json (1 hunks)
src/lib/hitl/hitlManager.ts (2 hunks)
src/lib/types/index.ts (1 hunks)
src/lib/types/sdkTypes.ts (1 hunks)
test/environment-setup.js (1 hunks)
todos/refactor/03-providers-module.md (4 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2025-09-21T10:52:19Z

✅ Single Commit Policy - COMPLIANT

Status: Policy requirements met • 1 commit • Valid format • Ready for merge

📊 View validation details

📝 Commit Details

Hash: b4f59226862cc54343587d1b88928611902673a9
Message: fix(types): expose core SDK types for external developer integration
Author: Sachin Sharma

✅ Validation Results

Single commit requirement met
No merge commits in branch
Semantic commit message format verified
Ready for squash merge to release branch

🤖 Automated validation by NeuroLink Single Commit Enforcement

Copilot

Pull Request Overview

This PR exposes core SDK types for external developer integration by creating a comprehensive type export system. The changes enable developers to import essential NeuroLink types like StreamResult, ToolExecutionEvent, NeuroLinkConfig, and other core interfaces through a dedicated types entry point.

Creates a new sdkTypes.ts file with 110+ essential type exports organized by priority
Adds ./types export path to package.json for external type access
Updates type index to include the new SDK types module

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/lib/types/sdkTypes.ts	Creates comprehensive type export module with 110+ essential types organized by priority for external developers
src/lib/types/index.ts	Adds export for the new SDK types module
package.json	Adds ./types export path for external type access
src/lib/hitl/hitlManager.ts	Refactors long lines for better readability
test/environment-setup.js	Changes variable declaration from let to const
todos/refactor/03-providers-module.md	Adds blank lines for better markdown formatting

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

github-actions · 2025-09-21T10:53:03Z

🤖 AI Review & Build Compliance ✅

Status: AI analysis complete • Build rules validated • Ready for review

📊 View detailed analysis results

🛡️ Analysis Complete

✅ Security scan (vulnerabilities, API keys)
✅ TypeScript safety & code quality
✅ Error handling & best practices
✅ Build rule enforcement validated
✅ Commit format & compliance checks

📋 Ready for Merge When

All CI checks passing
Manual review approved
Any AI-flagged issues resolved

🤖 AI analysis complete - check individual code comments for specific feedback

murdore requested a review from Copilot September 21, 2025 10:52

Copilot AI reviewed Sep 21, 2025

View reviewed changes

murdore merged commit 66199c9 into release Sep 21, 2025
10 of 11 checks passed

murdore deleted the fix/expose-required-types branch September 21, 2025 11:05

This was referenced Dec 26, 2025

VIDEO-036: FFmpeg Type System Foundation #723

Closed

feat(types): Add video output types (VIDEO-GEN-001) #729

Merged

coderabbitai Bot mentioned this pull request Jan 14, 2026

fix(dependancy): add back text-to-speech to dependencies and added ty… #775

Merged

69 tasks

This was referenced Mar 22, 2026

feat(auth): pluggable authentication providers system #892

Merged

feat(client): add client SDKs with HTTP client, React hooks, and AI SDK adapter #896

Merged

coderabbitai Bot mentioned this pull request Apr 3, 2026

refactor(types): consolidate type system — resolve collisions, break circular deps, absorb server types #921

Merged

6 of 7 tasks

Navigation Menu

Repository navigation

fix(types): expose core SDK types for external developer integration - #181

fix(types): expose core SDK types for external developer integration#181
murdore merged 1 commit into
releasefrom
fix/expose-required-types

murdore commented Sep 21, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Sep 21, 2025 •

edited

Loading

Review failed

Uh oh!

github-actions Bot commented Sep 21, 2025

📝 Commit Details

✅ Validation Results

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Sep 21, 2025

🛡️ Analysis Complete

📋 Ready for Merge When

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

murdore commented Sep 21, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

Description

Type of Change

Related Issues

Changes Made

AI Provider Impact

Component Impact

Testing

Test Environment

Performance Impact

Breaking Changes

Screenshots/Demo

Checklist

Additional Notes

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Sep 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Poem

Uh oh!

github-actions Bot commented Sep 21, 2025

✅ Single Commit Policy - COMPLIANT

📝 Commit Details

✅ Validation Results

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

github-actions Bot commented Sep 21, 2025

🤖 AI Review & Build Compliance ✅

🛡️ Analysis Complete

📋 Ready for Merge When

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

murdore commented Sep 21, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Sep 21, 2025 •

edited

Loading