microlinkhq / microlink / 40959679108

82%

push

github

fix(types): describe the mql CommonJS export with export = (#82)

* fix(types): describe the mql CommonJS export with export =

@microlink/mql is CommonJS (module.exports = mql) but its declarations
said `export default`, so TypeScript saw a `.default` property that does
not exist at runtime, and the named exports the ESM entry provides
(arrayBuffer, buffer, extend, fetchFromApi, getApiUrl, mapRules, stream)
were missing from the types.

Move the declarations next to src/index.js, declare the main export with
`export =` and the public types and members in a namespace merged with
it. extend() now returns the bare client it creates at runtime.
@microlink/function imports mql with `import = require`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* fix(types): match empty stream and fetchFromApi to runtime

An empty stream or embed stays JSON, and fetchFromApi requires responseType because a missing one throws. The type tests now cover those branches and the members an extended client does not have.

Co-authored-by: Cursor <cursoragent@cursor.com>

* fix(types): narrow fetchFromApi when responseType is literal

A json body is the payload and an arrayBuffer body is the raw response. A general string still allows either, which is what getApiUrl returns.

Co-authored-by: Cursor <cursoragent@cursor.com>

* test(mql): lock MicrolinkError name and message as readonly

Error already declares both as writable strings, so dropping the class fields stayed green. Assigning to them is now a type error.

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Cursor <cursoragent@cursor.com>

897 of 1142 branches covered (78.55%)

Branch coverage included in aggregate %.

5175 of 6263 relevant lines covered (82.63%)

28.25 hits per line