@koderlabs/tasks-sdk-types
v0.2.0
Published
Shared TypeScript types for the InstantTasks SDK suite.
Readme
@koderlabs/tasks-sdk-types
Runtime: any. Pure type / constant package — zero runtime dependencies.
Canonical wire-shape types for InstantTasks SDK events. Owned here so the core SDK, the per-platform packages (web-errors, web-network, web-reporter, sdk-rn), and the backend ingest controller all reference the same source of truth.
If you're an application developer you almost never import from this package directly — the runtime SDKs re-export everything you need. Import here when you're:
- Building a custom integration that emits its own event shape.
- Writing a server-side proxy / forwarder.
- Generating typed test fixtures.
Install
npm install @koderlabs/tasks-sdk-types
# or
pnpm add @koderlabs/tasks-sdk-types
# or
yarn add @koderlabs/tasks-sdk-typesSurface
| Module | Exports |
|---|---|
| keys | ProjectId, AccessKey, Serializable — branded primitive types. |
| events | AnyEvent, ErrorEvent, Breadcrumb, BreadcrumbCategory, BreadcrumbLevel, Frame and related wire shapes. |
| scopes | Scope / permission enum constants used by the SDK ingest API. |
Everything is re-exported from the package root:
import type { AnyEvent, ErrorEvent, Breadcrumb, ProjectId } from '@koderlabs/tasks-sdk-types';Caveats
- Types here are the wire shape, not the internal in-memory shape. The web-errors package, for example, builds enriched events from a leaner internal
_sendEventpayload — the type exported here is what lands on the server. - Treat all exports as append-only: removing or narrowing a field is a wire-protocol break. Add new optional fields instead.
- No runtime code.
importof this package compiles to zero bytes after tree-shaking.
Suite overview
Full SDK suite map + platform availability matrix: docs/sdk/overview.md.
License
KoderLabs proprietary. See LICENSE for terms. Use of this package requires a separate signed written agreement with KoderLabs; access alone confers no rights.
Licensing inquiries: [email protected]
