Registry / web-framework / fathom-typescript

fathom-typescript

library0.0.37jsnpmunverified

The `fathom-typescript` package is Fathom's official TypeScript SDK, providing programmatic access to the Fathom External API. It allows developers to interact with Fathom meetings, teams, and team members, including operations like listing meetings, retrieving recording summaries and transcripts, and managing webhooks. The current stable version is 0.0.37. As an official SDK, it is actively maintained and designed to stay in sync with the Fathom API, though semantic versioning might not be strictly followed before a 1.0 release. It offers both CommonJS and ES Modules support, making it versatile for various JavaScript environments. Key differentiators include its direct integration with the Fathom platform and type-safe access to API resources, reducing common development errors through its comprehensive TypeScript definitions.

web-framework llm-agents

npm install fathom-typescript

package ↗homepage ↗

INSTALL

IMPORT

SIG · FATHOM-TYPESCRIPT

fathom-typescript

web-frameworkjavascriptv0.0.37

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Fathom

✓ import { Fathom } from 'fathom-typescript';

✗ const Fathom = require('fathom-typescript');

The primary SDK client class. Supports both CommonJS and ES Modules environments.

ListMeetingsResponse

✓ import type { ListMeetingsResponse } from 'fathom-typescript/dist/sdk/models/operations';

Example of importing a specific type for an API operation's response for enhanced type safety. The exact path to specific types might vary based on SDK structure.

MeetingType

✓ import type { MeetingType } from 'fathom-typescript/dist/sdk/models/shared';

Example of importing an enum type used for request parameters, ensuring type-safe API calls. The exact path to shared types might vary.

Initializes the Fathom SDK client with an API key and demonstrates how to list meetings, iterating through potentially paginated results securely.

import { Fathom } from "fathom-typescript"; const fathom = new Fathom({ security: { apiKeyAuth: process.env.FATHOM_API_KEY ?? 'YOUR_API_KEY_HERE', }, }); async function run() { try { const result = await fathom.listMeetings({ calendarInviteesDomains: [ "acme.com", "client.com" ], meetingType: "all", recordedBy: [ "ceo@acme.com", "pm@acme.com" ], teams: [ "Sales", "Engineering" ] }); if (result) { for await (const page of result) { console.log("Retrieved meetings for page:", page); } } else { console.log("No meetings found or an empty result was returned."); } } catch (error) { console.error("Error listing meetings:", error); } } run();

Debug

Known issues

breakingAs a pre-1.0 release, minor versions (`0.x.0` to `0.y.0`) and even patch versions (`0.0.x` to `0.0.y`) of `fathom-typescript` may introduce breaking API changes without strictly adhering to semantic versioning.

fix

Always consult the changelog for each update. Consider pinning exact versions in `package.json` (e.g., `"fathom-typescript": "~0.0.37"` instead of `"^0.0.37"`) and manually review before upgrading to avoid unexpected behavior.

affects: >=0.0.1

gotchaHardcoding API keys directly in source code or committing them to version control (like in the quickstart example) is a significant security risk.

fix

Always use environment variables (e.g., `process.env.FATHOM_API_KEY`), a secure configuration management system, or a secret manager to handle sensitive credentials. Replace `<YOUR_API_KEY_HERE>` with a dynamically loaded secret.

affects: >=0.0.1

gotchaAPI operations that return multiple results (e.g., `listMeetings`) often implement pagination. Incorrectly handling pagination (e.g., forgetting to iterate or access subsequent pages) can lead to incomplete data retrieval.

fix

Utilize the provided asynchronous iterator pattern (e.g., `for await (const page of result)`) to ensure all available pages of data are fetched correctly for paginated responses.

affects: >=0.0.1

Errors

Common errors & fixes

TypeError: fathom.listMeetings is not a function

The `Fathom` client instance was not correctly initialized or the import path for the SDK is wrong, leading to an undefined or incorrect object.

fix

Ensure `import { Fathom } from "fathom-typescript";` is present and the `fathom` object is correctly instantiated with `const fathom = new Fathom({...});`.

Error: Missing required authentication scheme `apiKeyAuth` or `bearerAuth` for security.

The `security` object was not provided or was incomplete during the `Fathom` client initialization, preventing proper API authentication.

fix

Pass a valid `security` object with either `apiKeyAuth` or `bearerAuth` when creating the `Fathom` instance: `new Fathom({ security: { apiKeyAuth: process.env.FATHOM_API_KEY ?? '' } })`.

Property 'someInvalidProperty' does not exist on type 'ListMeetingsRequest'.

Attempting to pass an unknown or mistyped property to an API request object, indicating a mismatch with the SDK's type definitions.

fix

Consult the SDK's type definitions or the Fathom API documentation to ensure all request parameters are correctly named and typed according to the API specification for the specific operation.

Upgrade

Version history

0.0.37latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

34 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://www.npmjs.com/package/fathom-typescript ↗

homepagehttps://fathom.video ↗