npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@clientcasa/sdk

v0.1.2

Published

Official TypeScript SDK for the [ClientCasa](https://www.clientcasa.com) REST API.

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

allandelmareallandelmare

Keywords

Readme

@clientcasa/sdk

Official TypeScript SDK for the ClientCasa REST API.

npm install @clientcasa/sdk
# or
pnpm add @clientcasa/sdk
# or
yarn add @clientcasa/sdk

Works in Node.js 18+, modern browsers, Edge runtimes, Cloudflare Workers, and Deno.

Quick start

Get an API key from Settings → API Keys in your dashboard.

import { ClientCasa } from '@clientcasa/sdk'

const cc = new ClientCasa({
  apiKey: process.env.CLIENTCASA_API_KEY!,
})

// List clients
const { data, error } = await cc.clients.list({
  query: { pageSize: 25 },
})
if (error) throw new Error(error.error.message)
for (const client of data.data) {
  console.log(client.name, client.status)
}

// Create a client
const { data: created } = await cc.clients.create({
  body: { name: 'Acme Inc.', status: 'active' },
})

// Get one by ID
const { data: fetched } = await cc.clients.get({
  path: { id: created!.id },
})

// Update
await cc.clients.update({
  path: { id: created!.id },
  body: { notes: 'Updated via SDK' },
})

// Delete
await cc.clients.delete({ path: { id: created!.id } })

OAuth (third-party apps)

If you're building a third-party app that acts on behalf of a user, use the access token from your OAuth flow:

const cc = new ClientCasa({
  accessToken: 'eyJhbGc...', // from /api/auth/oauth2/token
})

See the OAuth Apps guide for the full authorization-code-with-PKCE flow.

Resources

The client exposes one accessor per v1 resource:

| Accessor | Methods | Notes | |---|---|---| | cc.clients | list, create, get, update, delete | | | cc.contacts | list, create, get, update, delete | | | cc.projects | list, create, get, update, delete | | | cc.invoices | list, create, get, update, delete | Status is payment-derived; only draft, sent, void writable | | cc.proposals | list, create, get, update, delete | Tiptap content not editable via API | | cc.contracts | list, create, get, update, delete | Create makes drafts only; signing is dashboard-managed | | cc.payments | list, create, get, update | Immutable — no delete. Refunds are negative-amount entries with kind=refund | | cc.payouts | list, get | Read-only — Stripe-managed | | cc.timeEntries | list, create, get, update, delete | | | cc.milestones | list, create, get, update, delete | Polymorphic parent (parentType: 'projects' | 'proposals') | | cc.calendarEvents | list, create, get, update, delete | Externally-synced events are read-only | | cc.inquiries | list, create, get, update, delete | New inquiries land in status: 'new'; converted is set by the dashboard | | cc.transactions | list, create, get, update, delete | | | cc.catalogItems | list, create, get, update, delete | | | cc.webhooks | list, create, get, update, delete | Secret is write-only |

Error handling

Every method returns { data, error }:

const { data, error } = await cc.clients.get({ path: { id: 'bad-id' } })
if (error) {
  console.error(error.error.code)      // 'not_found' | 'unauthorized' | …
  console.error(error.error.message)
  console.error(error.error.requestId) // for support tickets
  return
}
console.log(data.name) // type-narrowed

Idempotency

Pass an Idempotency-Key header on writes to safely retry:

await cc.invoices.create({
  body: { /* … */ },
  headers: { 'Idempotency-Key': '7c9e6679-7425-40de-944b-e07fc1f90ae7' },
})

The same key replayed within 24h returns the cached response. See Idempotency for details.

Configuration

new ClientCasa({
  apiKey: '…',           // or accessToken
  accessToken: '…',      // OAuth Bearer
  baseUrl: '…',          // override (defaults to https://www.clientcasa.com)
  fetch: customFetch,    // BYO fetch (undici, cross-fetch, etc.)
})

TypeScript

All DTOs are exported as types:

import type { ClientDTO, InvoiceCreate, PaginationMeta } from '@clientcasa/sdk'

Development

The SDK is generated from the live OpenAPI spec at /api/v1/openapi.json. To regenerate after API changes:

# From repo root: dump the current spec
pnpm --filter @clientcasa/app generate:openapi-spec

# Regenerate the SDK client + types
pnpm --filter @clientcasa/sdk gen

# Build
pnpm --filter @clientcasa/sdk build

The CI build fails if the committed openapi.json or src/generated/ are out of sync with the registry, so contributors can't forget to run gen.

Versioning

The SDK follows the API's v1 contract. Breaking changes go in a major version bump; new resources and new optional fields are minor versions.

License

MIT

Summary

ClientCasa API: REST API for ClientCasa — proposals, contracts, time tracking, expenses, invoicing, payments, and CRM for solo operators and small teams.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @clientcasa/sdk

PNPM

pnpm add @clientcasa/sdk

Bun

bun add @clientcasa/sdk

Yarn

yarn add @clientcasa/sdk

[!NOTE] This package is published as an ES Module (ESM) only. For applications using CommonJS, use await import("@clientcasa/sdk") to import and use this package.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { ClientCasa } from "@clientcasa/sdk";

const clientCasa = new ClientCasa();

async function run() {
  const result = await clientCasa.clients.listClients({
    apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
  }, {});

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------- | ------ | ------- | -------------------- | | apiKey | apiKey | API key | CLIENTCASA_API_KEY |

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { ClientCasa } from "@clientcasa/sdk";

const clientCasa = new ClientCasa();

async function run() {
  const result = await clientCasa.clients.listClients({}, {});

  console.log(result);
}

run();

Available Resources and Operations

CalendarEvents

CatalogItems

Clients

Contacts

Contracts

Inquiries

Invoices

Milestones

Payments

Payouts

Projects

Proposals

TimeEntries

Transactions

Webhooks

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { ClientCasa } from "@clientcasa/sdk";

const clientCasa = new ClientCasa();

async function run() {
  const result = await clientCasa.clients.listClients(
    {
      apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
    },
    {},
    {
      retries: {
        strategy: "backoff",
        backoff: {
          initialInterval: 1,
          maxInterval: 50,
          exponent: 1.1,
          maxElapsedTime: 100,
        },
        retryConnectionErrors: false,
      },
    },
  );

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { ClientCasa } from "@clientcasa/sdk";

const clientCasa = new ClientCasa({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await clientCasa.clients.listClients({
    apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
  }, {});

  console.log(result);
}

run();

Error Handling

ClientCasaError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | ------------------------------------------------------ | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response |

Example

import { ClientCasa } from "@clientcasa/sdk";
import * as errors from "@clientcasa/sdk/models/errors";

const clientCasa = new ClientCasa();

async function run() {
  try {
    const result = await clientCasa.clients.listClients({
      apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
    }, {});

    console.log(result);
  } catch (error) {
    if (error instanceof errors.ClientCasaError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

Network errors:

Inherit from ClientCasaError:

  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { ClientCasa } from "@clientcasa/sdk";

const clientCasa = new ClientCasa({
  serverURL: "https://www.clientcasa.com",
});

async function run() {
  const result = await clientCasa.clients.listClients({
    apiKey: process.env["CLIENTCASA_API_KEY"] ?? "",
  }, {});

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { ClientCasa } from "@clientcasa/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@clientcasa/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new ClientCasa({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { ClientCasa } from "@clientcasa/sdk";

const sdk = new ClientCasa({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable CLIENTCASA_DEBUG to true.