Skip to content

feat: add TypeScript typings for AlgoScope SDK#781

Open
harsharajkumar-273 wants to merge 1 commit into
algoscope-hq:mainfrom
harsharajkumar-273:feat/typescript-typings
Open

feat: add TypeScript typings for AlgoScope SDK#781
harsharajkumar-273 wants to merge 1 commit into
algoscope-hq:mainfrom
harsharajkumar-273:feat/typescript-typings

Conversation

@harsharajkumar-273

Copy link
Copy Markdown

Pull Request Summary

Title: feat: add TypeScript typings for AlgoScope SDK

What changed?

This pull request adds full TypeScript type definition files for the public AlgoScope utilities:

  • Added a library root entry point index.js which exports modules from src/lib/ (utils, favorites, testCaseStore, version).
  • Created index.d.ts which declares the TypeScript types, helper function signatures, parameter interfaces, and return types for the exported helpers.
  • Added tsconfig.json defining compiler settings for type-checking.
  • Updated package.json to configure "main": "index.js", publish typings via "types": "index.d.ts", add a "type-check" script, and add typescript as a devDependency.
  • Integrated a Run Type Checker (TypeScript) check step into the CI workflow (.github/workflows/pipelines.yml) under the code-quality job to automatically validate type safety for incoming PRs.

Why is this needed?

TypeScript consumer projects importing AlgoScope modules currently lack proper typings, leading to missing autocomplete/IntelliSense in modern IDEs and compiler type resolution warnings. This PR resolves #633.

Closes #633

Type of Change

  • feat - New user-facing feature or algorithm capability
  • build - Build system, dependency, or packaging change
  • ci - GitHub Actions, Docker, Vercel, or release automation change

Release Notes

Release note category:

  • Added

Release note entry:

  • Added TypeScript typings (index.d.ts) for public utility functions and index entry points, integrating type checks into the CI pipeline.

Testing and Verification

  • npm ci or npm install
  • npm run build
  • Manual browser testing at http://localhost:5173
  • No new console errors or warnings

Additional testing notes:

  • Ran npm run type-check (tsc check) locally which compiles cleanly with zero typing declaration errors.

UI Evidence

Not applicable (non-visual code structure/SDK change).

CI/CD and Deployment Impact

  • Updates GitHub Actions or release automation (added type check step to pipelines.yml)
  • Adds, removes, or updates npm dependencies (added devDependency typescript)

@vercel

vercel Bot commented Jul 13, 2026

Copy link
Copy Markdown

Someone is attempting to deploy a commit to the adityapaul2603-gmailcom's projects Team on Vercel.

A member of the Team first needs to authorize it.

@netlify

netlify Bot commented Jul 13, 2026

Copy link
Copy Markdown

Deploy Preview for astounding-nougat-da0f6a ready!

Name Link
🔨 Latest commit c72221a
🔍 Latest deploy log https://app.netlify.com/projects/astounding-nougat-da0f6a/deploys/6a5519b311e63a0008fd526c
😎 Deploy Preview https://deploy-preview-781--astounding-nougat-da0f6a.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@harsharajkumar-273, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 51 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro Plus

Run ID: c9880927-3e7a-46dd-9da7-1b0174ce7643

📥 Commits

Reviewing files that changed from the base of the PR and between de62999 and c72221a.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (5)
  • .github/workflows/pipelines.yml
  • index.d.ts
  • index.js
  • package.json
  • tsconfig.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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.

Add TypeScript typings for the AlgoScope SDK

1 participant