Skip to content

Add @clearoutio/clearout#75188

Open
max-programming wants to merge 5 commits into
DefinitelyTyped:masterfrom
max-programming:add-clearoutio-clearout
Open

Add @clearoutio/clearout#75188
max-programming wants to merge 5 commits into
DefinitelyTyped:masterfrom
max-programming:add-clearoutio-clearout

Conversation

@max-programming

@max-programming max-programming commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

If adding a new definition:

  • The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
  • If this is for an npm package, match the name. If not, do not conflict with the name of an npm package.
  • Create it with dts-gen --dt, not by basing it on an existing project.
  • Represents shape of module/library correctly
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

Type definitions for @clearoutio/clearout, the official Clearout Node.js SDK for real-time and bulk email verification and email finding.

Notes for reviewers:

  • The package name is scoped, so the folder is clearoutio__clearout.
  • The module export is both callable (require("@clearoutio/clearout")(token, config)) and constructable (new Clearout(token, config)), with a .default for ESM default-import interop; all three forms are typed and exercised in the tests.
  • Hand-written from the SDK source (dts-gen box left unchecked); response shapes were derived from the SDK's bundled OpenAPI spec and cross-checked against the SDK's own test assertions.

@typescript-automation

typescript-automation Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

@max-programming Thank you for submitting this PR!

This is a live comment that I will keep updated.

1 package in this PR

Code Reviews

This PR adds a new definition, so it needs to be reviewed by a DT maintainer before it can be merged.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • 🕐 Only a DT maintainer can approve changes when there are new packages added

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 75188,
  "author": "max-programming",
  "headCommitOid": "f9c455f935dbb2dacb6532bfb59d6da5acda35f0",
  "mergeBaseOid": "d2e57d1f80a85cf26c5acaa63c753bc820ca74b3",
  "lastPushDate": "2026-07-01T05:32:55.000Z",
  "lastActivityDate": "2026-07-03T17:30:07.000Z",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "tooManyCommits": false,
  "tooManyReviews": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "clearoutio__clearout",
      "kind": "add",
      "files": [
        {
          "path": "types/clearoutio__clearout/.npmignore",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/clearoutio__clearout/clearoutio__clearout-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/clearoutio__clearout/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/clearoutio__clearout/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/clearoutio__clearout/tsconfig.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [],
      "addedOwners": [
        "max-programming"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "stale",
      "reviewer": "jakebailey",
      "date": "2026-07-03T17:30:07.000Z",
      "abbrOid": "44bddac"
    }
  ],
  "mainBotCommentID": 4850574182,
  "ciResult": "pass"
}

@typescript-automation typescript-automation Bot added New Definition This PR creates a new definition package. Check Config Changes a module config files labels Jul 1, 2026
@typescript-automation

Copy link
Copy Markdown
Contributor

🔔 @max-programming — you're the only owner, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

@typescript-automation typescript-automation Bot moved this to Waiting for Code Reviews in Pull Request Status Board Jul 1, 2026
@typescript-automation typescript-automation Bot moved this from Waiting for Code Reviews to Needs Maintainer Action in Pull Request Status Board Jul 1, 2026
@typescript-automation typescript-automation Bot moved this from Needs Maintainer Action to Waiting for Code Reviews in Pull Request Status Board Jul 1, 2026
@typescript-automation typescript-automation Bot moved this from Waiting for Code Reviews to Needs Maintainer Action in Pull Request Status Board Jul 1, 2026
@jakebailey

Copy link
Copy Markdown
Member

Why did you replace our PR template?

@max-programming

max-programming commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

@jakebailey i am really sorry, i did not mean to do that, nowadays i just tell claude to use the github cli to create the pr
i will update the pr with the appropriate template

Update: Done

@typescript-automation typescript-automation Bot moved this from Needs Maintainer Action to Waiting for Code Reviews in Pull Request Status Board Jul 1, 2026
@typescript-automation typescript-automation Bot moved this from Waiting for Code Reviews to Needs Maintainer Action in Pull Request Status Board Jul 1, 2026
@jakebailey

Copy link
Copy Markdown
Member

@max-programming

Copy link
Copy Markdown
Contributor Author

@jakebailey yes
image

Comment thread types/clearoutio__clearout/index.d.ts Outdated
max-programming and others added 2 commits July 3, 2026 21:55
- Type emailFinder.getStatus as a union (EmailFinderStatusResult) so the
  progress-only queued payload no longer claims the found-email fields
- Split the shared ProgressStatusResult into BulkVerifyProgressStatus
  (percentile) and BulkFinderProgressStatus (percentage) so neither
  endpoint exposes the other's field
- Use the expected tsconfig form (lib es6, no target)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@typescript-automation typescript-automation Bot removed the Check Config Changes a module config files label Jul 3, 2026
@typescript-automation typescript-automation Bot moved this from Needs Maintainer Action to Waiting for Code Reviews in Pull Request Status Board Jul 3, 2026
@typescript-automation

Copy link
Copy Markdown
Contributor

@jakebailey Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@typescript-automation typescript-automation Bot moved this from Waiting for Code Reviews to Needs Maintainer Action in Pull Request Status Board Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

New Definition This PR creates a new definition package.

Projects

Status: Needs Maintainer Action

Development

Successfully merging this pull request may close these issues.

2 participants