@dogpile/sdk 0.1.0 → 0.1.2
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/CHANGELOG.md +16 -5
- package/README.md +26 -15
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,22 +1,33 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
## 1.
|
|
3
|
+
## 0.1.2
|
|
4
|
+
|
|
5
|
+
- Cleaned up the README release verification section so the npm package page has readable gate descriptions instead of a single dense paragraph.
|
|
6
|
+
- Prepared the patch release identity for `@dogpile/sdk@0.1.2` and `dogpile-sdk-0.1.2.tgz`.
|
|
7
|
+
|
|
8
|
+
## 0.1.1
|
|
9
|
+
|
|
10
|
+
- Updated npm package metadata after the GitHub repository transfer from `zakkeown/dogpile` to `bubstack/dogpile`.
|
|
11
|
+
- Updated package identity guards and publish documentation for `@dogpile/sdk@0.1.1` and `dogpile-sdk-0.1.1.tgz`.
|
|
12
|
+
- Updated npm Trusted Publisher documentation to use the GitHub organization `bubstack`.
|
|
13
|
+
|
|
14
|
+
## 0.1.0
|
|
4
15
|
|
|
5
16
|
### Production-Readiness Gaps Closed
|
|
6
17
|
|
|
7
18
|
- Gap 1 - Cost accounting proof: `costUsd` is computed from caller-supplied `costEstimator` pricing, including the packed quickstart smoke, and Dogpile does not bundle a model pricing table.
|
|
8
19
|
- Gap 2 - End-to-end cancellation: caller `AbortSignal`, `StreamHandle.cancel()`, and `budget.timeoutMs` abort active provider requests and surface stable `DogpileError` cancellation/timeout codes.
|
|
9
|
-
- Gap 3 - Runtime support proof: Node.js LTS 22 / 24, Bun latest, and browser ESM each have documented validation, and no other runtime targets are claimed for
|
|
20
|
+
- Gap 3 - Runtime support proof: Node.js LTS 22 / 24, Bun latest, and browser ESM each have documented validation, and no other runtime targets are claimed for this release.
|
|
10
21
|
- Gap 4 - Intentional public surface: `@dogpile/sdk` exports only the documented root, browser, runtime, type, and OpenAI-compatible provider entrypoints, with demo, benchmark, deterministic testing, and internal helpers kept repository-only.
|
|
11
22
|
- Gap 5 - Stable typed errors: public validation, registration, provider, abort, timeout, and unknown-failure paths normalize to documented `DogpileError` string codes.
|
|
12
23
|
- Gap 6 - Reproducible release: local and CI gates build, pack, install the tarball, import every public subpath, verify downstream TypeScript type resolution, reject local `workspace:` / `link:` installs, and publish source maps plus original TypeScript sources.
|
|
13
24
|
- Gap 7 - Scope discipline: the SDK ships a dependency-free provider interface plus direct OpenAI-compatible HTTP adapter, avoids bundled pricing data, and keeps protocol hot loops trusting.
|
|
14
25
|
|
|
15
|
-
- Published the
|
|
16
|
-
- Documented the scoped release identity as `@dogpile/sdk@1.0
|
|
26
|
+
- Published the initial SDK under the scoped npm package name `@dogpile/sdk`; there is no bare `dogpile` package alias.
|
|
27
|
+
- Documented the scoped release identity as `@dogpile/sdk@0.1.0` and the local pack tarball name as `dogpile-sdk-0.1.0.tgz`.
|
|
17
28
|
- Added local and CI package identity validation that rejects stale unscoped package install/import references before release.
|
|
18
29
|
- Added a browser ESM bundle at `@dogpile/sdk/browser` and wired the package root `browser` condition to the same `dist/browser/index.js` artifact.
|
|
19
|
-
- Removed demo, benchmark, deterministic testing, and internal helper files from the publishable tarball and from the
|
|
30
|
+
- Removed demo, benchmark, deterministic testing, and internal helper files from the publishable tarball and from the package export map; use the documented root, browser, runtime, type, and OpenAI-compatible provider entrypoints as the supported public surface. Repository-only helper docs now point to the source-only `../src/internal.js` import path.
|
|
20
31
|
- Added the required `Release Validation / Required browser bundle smoke` CI check for the browser bundle build and focused smoke test.
|
|
21
32
|
- Added the required `Release Validation / Required packed-tarball quickstart smoke` CI check for the fresh consumer project import and documented quickstart smoke script on pull requests, `main`, and `release/**` branches.
|
|
22
33
|
- Added the packed-tarball quickstart smoke to `pnpm run verify` and `pnpm run pack:check` through the explicit `pnpm run quickstart:smoke` command so local verification and Node.js CI full-suite jobs install and execute the packed SDK before publish.
|
package/README.md
CHANGED
|
@@ -44,13 +44,13 @@ Dochkina, V. (2026). *Drop the Hierarchy and Roles: How Self-Organizing LLM Agen
|
|
|
44
44
|
- **Live when you need it.** `Dogpile.stream()` yields the same event shapes that land in the final trace.
|
|
45
45
|
- **Replayable by construction.** Completed runs return a JSON-serializable trace with inputs, events, provider calls, transcript, accounting, and final output.
|
|
46
46
|
- **Application-owned effects.** Runtime tools, web search, code execution, credentials, and persistence stay under caller policy.
|
|
47
|
-
- **Small public surface.** The
|
|
47
|
+
- **Small public surface.** The package exports the SDK root, browser entrypoint, runtime subpaths, type subpath, and OpenAI-compatible provider adapter.
|
|
48
48
|
|
|
49
49
|
## Documentation
|
|
50
50
|
|
|
51
|
-
- [Developer usage guide](https://github.com/
|
|
51
|
+
- [Developer usage guide](https://github.com/bubstack/dogpile/blob/main/docs/developer-usage.md): API choices, providers, protocols, streaming, termination, tools, replay, errors, browser usage, and repo commands.
|
|
52
52
|
- [Examples](examples/README.md): repeatable protocol comparison and live OpenAI-compatible execution.
|
|
53
|
-
- [Changelog](CHANGELOG.md):
|
|
53
|
+
- [Changelog](CHANGELOG.md): release notes and public-surface changes.
|
|
54
54
|
|
|
55
55
|
## Choose Your Entry Point
|
|
56
56
|
|
|
@@ -102,22 +102,22 @@ pnpm run build
|
|
|
102
102
|
pnpm pack --pack-destination ./packed
|
|
103
103
|
```
|
|
104
104
|
|
|
105
|
-
The local tarball is named `dogpile-sdk-1.
|
|
106
|
-
`@dogpile/sdk@1.
|
|
105
|
+
The local tarball is named `dogpile-sdk-0.1.2.tgz` for the scoped package
|
|
106
|
+
`@dogpile/sdk@0.1.2`. Install that tarball into a fresh consumer project:
|
|
107
107
|
|
|
108
108
|
```sh
|
|
109
109
|
mkdir ../dogpile-quickstart
|
|
110
110
|
cd ../dogpile-quickstart
|
|
111
111
|
pnpm init
|
|
112
|
-
pnpm add ../dogpile/packed/dogpile-sdk-1.
|
|
112
|
+
pnpm add ../dogpile/packed/dogpile-sdk-0.1.2.tgz
|
|
113
113
|
```
|
|
114
114
|
|
|
115
115
|
Equivalent install commands for other supported package managers are:
|
|
116
116
|
|
|
117
117
|
```sh
|
|
118
|
-
npm install ../dogpile/packed/dogpile-sdk-1.
|
|
119
|
-
yarn add ../dogpile/packed/dogpile-sdk-1.
|
|
120
|
-
bun add ../dogpile/packed/dogpile-sdk-1.
|
|
118
|
+
npm install ../dogpile/packed/dogpile-sdk-0.1.2.tgz
|
|
119
|
+
yarn add ../dogpile/packed/dogpile-sdk-0.1.2.tgz
|
|
120
|
+
bun add ../dogpile/packed/dogpile-sdk-0.1.2.tgz
|
|
121
121
|
```
|
|
122
122
|
|
|
123
123
|
## Versioning and Stability
|
|
@@ -128,7 +128,7 @@ Dogpile follows semantic versioning for published packages:
|
|
|
128
128
|
- Minor releases add backward-compatible APIs, protocols, event fields, or runtime support.
|
|
129
129
|
- Major releases may change public contracts, remove deprecated APIs, or alter protocol semantics.
|
|
130
130
|
|
|
131
|
-
The
|
|
131
|
+
The current public surface includes the package root exports, high-level `Dogpile.pile()`, `run()`, `stream()`, `createEngine()`, the dependency-free OpenAI-compatible provider adapter, protocol and tier discriminated unions, event unions, trace/result types, and runtime portability guarantees for Node.js LTS 22 / 24, Bun latest, and browser ESM runtimes.
|
|
132
132
|
|
|
133
133
|
Dogpile treats documented `dist` entrypoints, their runtime implementation dependencies, JavaScript source maps, declaration maps, original TypeScript sources for shipped runtime/browser/provider files, `README.md`, `CHANGELOG.md`, and `LICENSE` as the publishable package payload. Demo, benchmark, deterministic testing, and internal helper files are repository-only and stay out of the npm tarball. Core runtime code must remain pure TypeScript, storage-free, and free of Node-only dependencies so the same package can run across the supported Node.js, Bun, and browser ESM runtimes.
|
|
134
134
|
|
|
@@ -146,9 +146,19 @@ pnpm run pack:check
|
|
|
146
146
|
pnpm run publish:check
|
|
147
147
|
```
|
|
148
148
|
|
|
149
|
-
|
|
149
|
+
What each gate proves:
|
|
150
150
|
|
|
151
|
-
|
|
151
|
+
- `package:identity` asserts the scoped npm package name `@dogpile/sdk`, the current release identity, required package metadata, and release-facing references in source, docs, tests, and CI.
|
|
152
|
+
- `package:artifacts` verifies that package metadata references only emitted runtime JavaScript and TypeScript declaration files covered by `package.json` `files`.
|
|
153
|
+
- `browser:smoke` rebuilds the browser ESM bundle and imports `@dogpile/sdk` through the package root `browser` condition.
|
|
154
|
+
- `quickstart:smoke` creates a real `pnpm pack` tarball, installs it into a fresh consumer project, and asserts the dependency and lockfile resolve `@dogpile/sdk` from the `.tgz` instead of `workspace:` or `link:` metadata.
|
|
155
|
+
- `quickstart:smoke` also verifies installed entrypoints and `dist` imports do not resolve through local source imports, imports every public package subpath from the installed tarball, runs the marked README quickstart, runs `tsc --noEmit` from the consumer project, verifies private helper files are absent from the installed tarball, and proves private helper subpaths remain blocked by package exports.
|
|
156
|
+
- `consumer:smoke` is kept as the same packed-tarball quickstart smoke command for compatibility.
|
|
157
|
+
- `verify` rebuilds `dist`, runs the package artifact guard, runs the packed-tarball quickstart smoke, runs strict typecheck, and then runs the test suite.
|
|
158
|
+
- `pack:check` runs package identity, rebuilds `dist`, verifies package artifacts, runs the packed-tarball quickstart smoke, checks packed JavaScript source maps and declaration maps, and finishes with `npm pack --dry-run`.
|
|
159
|
+
- `publish:check` runs `verify`, reruns the package artifact guard, and then runs `npm publish --dry-run` so the package metadata, export map, and publishable files are checked without publishing.
|
|
160
|
+
|
|
161
|
+
The release identity is `@dogpile/sdk@0.1.2`. A real `pnpm pack` or `npm pack` for this scoped package produces the local tarball `dogpile-sdk-0.1.2.tgz`; the dry-run package gate must report that tarball filename and the scoped npm package name before publish. See `CHANGELOG.md` for release notes and breaking-change documentation.
|
|
152
162
|
|
|
153
163
|
The browser ESM target is emitted at `dist/browser/index.js` with `dist/browser/index.js.map`; both the package root `browser` condition and the explicit `@dogpile/sdk/browser` subpath resolve to that bundled artifact.
|
|
154
164
|
|
|
@@ -175,7 +185,7 @@ The publish workflow uses npm Trusted Publishing/OIDC rather than a long-lived
|
|
|
175
185
|
npm automation token. Configure the package's trusted publisher on npmjs.com
|
|
176
186
|
with:
|
|
177
187
|
|
|
178
|
-
- Organization or user: `
|
|
188
|
+
- Organization or user: `bubstack`
|
|
179
189
|
- Repository: `dogpile`
|
|
180
190
|
- Workflow filename: `npm-publish.yml`
|
|
181
191
|
- Environment name: `npm`
|
|
@@ -521,7 +531,7 @@ const lookupTool: RuntimeTool<LookupInput> = {
|
|
|
521
531
|
## DogpileError Codes
|
|
522
532
|
|
|
523
533
|
`DogpileError` and `DogpileErrorCode` are exported from `@dogpile/sdk`. The
|
|
524
|
-
string `code` values below are the stable
|
|
534
|
+
string `code` values below are the stable public contract for JavaScript callers,
|
|
525
535
|
TypeScript discriminated-union handling, retry policy, and observability. When
|
|
526
536
|
`retryable` is present, prefer it over a hard-coded policy; the handling column
|
|
527
537
|
describes the default caller posture when provider metadata does not override
|
|
@@ -548,7 +558,8 @@ Use `stream()` or `Dogpile.stream()` when you need a live event log, and `create
|
|
|
548
558
|
## Benchmark Artifacts
|
|
549
559
|
|
|
550
560
|
Benchmark runners and deterministic provider fixtures remain repository test
|
|
551
|
-
harnesses in
|
|
561
|
+
harnesses in this release. They are intentionally not exported from
|
|
562
|
+
`@dogpile/sdk`.
|
|
552
563
|
Repository tests and benchmark harnesses that need those helpers import them
|
|
553
564
|
from the source-only internal path `../internal.js`, which resolves to
|
|
554
565
|
`src/internal.ts` in the TypeScript source tree.
|
package/package.json
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dogpile/sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "TypeScript SDK for running multi-agent LLM coordination protocols.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "git+https://github.com/
|
|
9
|
+
"url": "git+https://github.com/bubstack/dogpile.git"
|
|
10
10
|
},
|
|
11
11
|
"bugs": {
|
|
12
|
-
"url": "https://github.com/
|
|
12
|
+
"url": "https://github.com/bubstack/dogpile/issues"
|
|
13
13
|
},
|
|
14
|
-
"homepage": "https://github.com/
|
|
14
|
+
"homepage": "https://github.com/bubstack/dogpile#readme",
|
|
15
15
|
"keywords": [
|
|
16
16
|
"ai",
|
|
17
17
|
"agents",
|