@koderlabs/tasks-sdk-types 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +45 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,9 +1,49 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @koderlabs/tasks-sdk-types
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> Runtime: any. Pure type / constant package — zero runtime dependencies.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
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.
|
|
6
|
+
|
|
7
|
+
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:
|
|
8
|
+
|
|
9
|
+
- Building a custom integration that emits its own event shape.
|
|
10
|
+
- Writing a server-side proxy / forwarder.
|
|
11
|
+
- Generating typed test fixtures.
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
pnpm add @koderlabs/tasks-sdk-types
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Surface
|
|
20
|
+
|
|
21
|
+
| Module | Exports |
|
|
22
|
+
|---|---|
|
|
23
|
+
| `keys` | `ProjectId`, `AccessKey`, `Serializable` — branded primitive types. |
|
|
24
|
+
| `events` | `AnyEvent`, `ErrorEvent`, `Breadcrumb`, `BreadcrumbCategory`, `BreadcrumbLevel`, `Frame` and related wire shapes. |
|
|
25
|
+
| `scopes` | Scope / permission enum constants used by the SDK ingest API. |
|
|
26
|
+
|
|
27
|
+
Everything is re-exported from the package root:
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import type { AnyEvent, ErrorEvent, Breadcrumb, ProjectId } from '@koderlabs/tasks-sdk-types';
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Caveats
|
|
34
|
+
|
|
35
|
+
- 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 `_sendEvent` payload — the type exported here is what lands on the server.
|
|
36
|
+
- Treat all exports as **append-only**: removing or narrowing a field is a wire-protocol break. Add new optional fields instead.
|
|
37
|
+
- No runtime code. `import` of this package compiles to zero bytes after tree-shaking.
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Suite overview
|
|
42
|
+
|
|
43
|
+
Full SDK suite map + platform availability matrix: [docs/sdk/overview.md](https://github.com/jawaidgadiwala/instant-tasks/blob/main/docs/sdk/overview.md).
|
|
44
|
+
|
|
45
|
+
## License
|
|
46
|
+
|
|
47
|
+
KoderLabs proprietary. See [`LICENSE`](./LICENSE) for terms. Use of this package requires a separate signed written agreement with KoderLabs; access alone confers no rights.
|
|
8
48
|
|
|
9
49
|
Licensing inquiries: jawaidgadiwala@gmail.com
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@koderlabs/tasks-sdk-types",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Shared TypeScript types for the InstantTasks SDK suite.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"instanttasks",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"node": ">=20"
|
|
47
47
|
},
|
|
48
48
|
"publishConfig": {
|
|
49
|
-
"access": "
|
|
49
|
+
"access": "public"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
52
|
"build": "tsup src/index.ts --format esm,cjs --dts --clean",
|