{"_id":"@atlasflow/sdk","_rev":"4-100d50f6fe079fc6926c38e17d8a54bd","name":"@atlasflow/sdk","dist-tags":{"latest":"0.3.0"},"versions":{"0.1.0":{"name":"@atlasflow/sdk","version":"0.1.0","keywords":["api","atlasflow","openapi","sdk"],"license":"Apache-2.0","_id":"@atlasflow/sdk@0.1.0","maintainers":[{"name":"tomhaerter","email":"tom@dokedu.org"}],"homepage":"https://github.com/atlasflowlabs/sdk#readme","bugs":{"url":"https://github.com/atlasflowlabs/sdk/issues"},"dist":{"shasum":"251e3cea696a013d0419cde24f015902f75c47b8","tarball":"https://registry.npmjs.org/@atlasflow/sdk/-/sdk-0.1.0.tgz","fileCount":5,"integrity":"sha512-6srR5vkZdfYF2T07XgYUC7ZinkUZ8RKWGgq1dFv10BAqOx6w9mLfRV30ZYlq1iaEzUsILdfX2qTTA/IZmZoScg==","signatures":[{"sig":"MEUCIQCt/LVOoA1LQKW7/KZXJhm8RSn9jCm/eS0ejxvWWmkIjAIgG+qy04ROZfmvqc8xhxErGE44lWCvyETS00gEdfZ41p4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":117408},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=20"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"b5b43102aad732bd5a00bcd71294022bb5c511ce","scripts":{"test":"vitest run","build":"tsdown","generate":"openapi-ts","typecheck":"tsc --noEmit","prepublishOnly":"npm run build"},"_npmUser":{"name":"tomhaerter","email":"tom@dokedu.org"},"repository":{"url":"git+https://github.com/atlasflowlabs/sdk.git","type":"git"},"_npmVersion":"11.17.0","description":"TypeScript SDK for the Atlasflow REST API, generated from its OpenAPI specification.","directories":{},"sideEffects":false,"_nodeVersion":"26.5.0","publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"tsdown":"^0.22.14","vitest":"^4.1.10","typescript":"^5.9.0","@hey-api/openapi-ts":"0.99.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.0_1785927451997_0.6881429550326168","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@atlasflow/sdk","version":"0.1.1","keywords":["api","atlasflow","openapi","sdk"],"license":"Apache-2.0","_id":"@atlasflow/sdk@0.1.1","maintainers":[{"name":"tomhaerter","email":"tom@dokedu.org"}],"homepage":"https://github.com/atlasflowlabs/sdk#readme","bugs":{"url":"https://github.com/atlasflowlabs/sdk/issues"},"dist":{"shasum":"c8a93ff92597eb855bbfdf7c6d0111b6da5f1cd5","tarball":"https://registry.npmjs.org/@atlasflow/sdk/-/sdk-0.1.1.tgz","fileCount":5,"integrity":"sha512-CBiBCxjS8592lBtQ1ecsHFF/fCZAloQmVuMQoEKKJo5CsO4IobmERcIKMsP3RWfB60/Zm/8exXMXGyYQrz2ghw==","signatures":[{"sig":"MEYCIQDytkQNl/zjr4d10yg9cIb3H6MNSFyRq/LHKxcdUwzwhwIhANUeVQyLvqSAUykQLMC2XEOUshW3A4QvgAGXT6GpuT8+","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@atlasflow%2fsdk@0.1.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":117408},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=20"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"45edbe223e25156d52c5dbe063edabf7b2b61ee4","scripts":{"test":"vitest run","build":"tsdown","generate":"openapi-ts","typecheck":"tsc --noEmit","prepublishOnly":"npm run build"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:a572b6a5-4dbd-452b-ab41-f798a3d59ba9"}},"repository":{"url":"git+https://github.com/atlasflowlabs/sdk.git","type":"git"},"_npmVersion":"12.0.2","description":"TypeScript SDK for the Atlasflow REST API, generated from its OpenAPI specification.","directories":{},"sideEffects":false,"_nodeVersion":"24.18.0","publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"tsdown":"^0.22.14","vitest":"^4.1.10","typescript":"^5.9.0","@hey-api/openapi-ts":"0.99.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.1.1_1785927829403_0.1847788775642878","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@atlasflow/sdk","version":"0.2.0","keywords":["api","atlasflow","openapi","sdk"],"license":"Apache-2.0","_id":"@atlasflow/sdk@0.2.0","maintainers":[{"name":"tomhaerter","email":"tom@dokedu.org"}],"homepage":"https://github.com/atlasflowlabs/sdk#readme","bugs":{"url":"https://github.com/atlasflowlabs/sdk/issues"},"dist":{"shasum":"4c5ef4a1d5cf79e1dc04e5f1b817b1b4231a4ff8","tarball":"https://registry.npmjs.org/@atlasflow/sdk/-/sdk-0.2.0.tgz","fileCount":5,"integrity":"sha512-45/2wNzDIgi/cXLDArzrIFmZSU7xAAZ2m8ihh90QkLir7LAFbQh1Q9oOTnuyzvOIv/tmwGFOy+tDL43rIDTjzg==","signatures":[{"sig":"MEYCIQCY6tzJke4eX9T1jS9WAL4uc5krpIjcL0bX/wFzuP/W4AIhANsrI6zPUhyCqx0rb7yi9JXDhnb0qRgPjcYE9+VoZnBW","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@atlasflow%2fsdk@0.2.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":120592},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=20"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"gitHead":"de17265a46b3c5884e36eb268882fce5f99b666a","scripts":{"test":"vitest run","build":"tsdown","generate":"openapi-ts","typecheck":"tsc --noEmit","prepublishOnly":"npm run build"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:a572b6a5-4dbd-452b-ab41-f798a3d59ba9"}},"repository":{"url":"git+https://github.com/atlasflowlabs/sdk.git","type":"git"},"_npmVersion":"12.0.2","description":"TypeScript SDK for the Atlasflow REST API, generated from its OpenAPI specification.","directories":{},"sideEffects":false,"_nodeVersion":"24.18.0","publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"tsdown":"^0.22.14","vitest":"^4.1.10","typescript":"^5.9.0","@hey-api/openapi-ts":"0.99.0"},"_npmOperationalInternal":{"tmp":"tmp/sdk_0.2.0_1785937535954_0.21882074978753963","host":"s3://npm-registry-packages-npm-production"}},"0.3.0":{"name":"@atlasflow/sdk","version":"0.3.0","description":"TypeScript SDK for the Atlasflow REST API, generated from its OpenAPI specification.","keywords":["api","atlasflow","openapi","sdk"],"license":"Apache-2.0","homepage":"https://github.com/atlasflowlabs/sdk#readme","repository":{"type":"git","url":"git+https://github.com/atlasflowlabs/sdk.git"},"bugs":{"url":"https://github.com/atlasflowlabs/sdk/issues"},"type":"module","sideEffects":false,"main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"publishConfig":{"access":"public","provenance":true},"scripts":{"generate":"openapi-ts","build":"tsdown","prepublishOnly":"npm run build","test":"vitest run","typecheck":"tsc --noEmit"},"devDependencies":{"@hey-api/openapi-ts":"0.99.0","tsdown":"^0.22.14","typescript":"^5.9.0","vitest":"^4.1.10"},"engines":{"node":">=20"},"gitHead":"ffb2f457dcfb61b76aa84767885f89146d57edb2","_id":"@atlasflow/sdk@0.3.0","_nodeVersion":"24.18.0","_npmVersion":"12.0.2","dist":{"integrity":"sha512-jAXYeN8QiPv3x4qa0iR1OjeLm6xKfR3cqbb4hcHAWtm6Dw6+UbOWVRyt06Ifb7GsdE87asQtaEALrtP59KcdOw==","shasum":"5932da622afb2cac4e7d8c8ce0d6ef2c2dc66d43","tarball":"https://registry.npmjs.org/@atlasflow/sdk/-/sdk-0.3.0.tgz","fileCount":5,"unpackedSize":123456,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@atlasflow%2fsdk@0.3.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQD9/m5uZAU9Q6IJmp1re7vjUsjX27REeizBUYtJFCJfowIhAP2HHQdRbrCCkFFD5hJE7i/p3U3AhXFDyyN0Ip4x6hMD"}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:a572b6a5-4dbd-452b-ab41-f798a3d59ba9"}},"directories":{},"maintainers":[{"name":"tomhaerter","email":"tom@dokedu.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sdk_0.3.0_1786010677242_0.23904626423450615"},"_hasShrinkwrap":false}},"time":{"created":"2026-08-05T10:57:31.849Z","modified":"2026-08-06T10:04:37.790Z","0.1.0":"2026-08-05T10:57:32.229Z","0.1.1":"2026-08-05T11:03:49.586Z","0.2.0":"2026-08-05T13:45:36.095Z","0.3.0":"2026-08-06T10:04:37.398Z"},"bugs":{"url":"https://github.com/atlasflowlabs/sdk/issues"},"license":"Apache-2.0","homepage":"https://github.com/atlasflowlabs/sdk#readme","keywords":["api","atlasflow","openapi","sdk"],"repository":{"type":"git","url":"git+https://github.com/atlasflowlabs/sdk.git"},"description":"TypeScript SDK for the Atlasflow REST API, generated from its OpenAPI specification.","maintainers":[{"name":"tomhaerter","email":"tom@dokedu.org"}],"readme":"# @atlasflow/sdk\n\nThe TypeScript SDK for the Atlasflow REST API. The SDK is generated from the\nOpenAPI specification of the API. The package is ESM only.\n\n## Installation\n\n```sh\nnpm install @atlasflow/sdk\n```\n\n## Usage\n\nCreate a client with your API key. Then call the API operations as methods.\n\n```ts\nimport { createClient } from \"@atlasflow/sdk\";\n\nconst atlasflow = createClient({ apiKey: \"af_live_...\" });\n\nconst { data, error } = await atlasflow.listProjects();\nif (error) {\n  console.error(error.title, error.detail);\n} else {\n  console.log(data.projects);\n}\n```\n\nIf you do not set `apiKey`, the SDK reads the `ATLASFLOW_API_KEY` environment\nvariable.\n\n### Options\n\n| Option    | Default                          | Description                            |\n| --------- | -------------------------------- | -------------------------------------- |\n| `apiKey`  | `ATLASFLOW_API_KEY` env variable | The Atlasflow API key (`af_live_...`). |\n| `baseUrl` | `https://api.atlasflow.com/v1`   | The API base URL.                      |\n| `fetch`   | global `fetch`                   | A custom Fetch API implementation.     |\n| `headers` | none                             | Extra headers sent with every request. |\n\n### Errors\n\nEach method returns a result object. On success, `data` holds the parsed\nresponse. On failure, `error` holds the RFC 7807 problem document. Set\n`throwOnError: true` to throw the problem instead.\n\n```ts\nconst project = await atlasflow.getProject({\n  path: { id: \"...\" },\n  throwOnError: true,\n});\n```\n\n## Development\n\nThe SDK is generated from `openapi.yaml`, a committed snapshot of the\npublic spec at <https://api.atlasflow.com/v1/openapi.yaml>. The generated\ncode lives in `src/generated`. Do not edit the snapshot or the generated\ncode by hand.\n\nThe `sync-spec` workflow fetches the deployed spec on a schedule (and on a\n`spec-deployed` repository dispatch) and opens a pull request with the\nregenerated code when the spec changed. To regenerate locally:\n\n```sh\ncurl -fsSL https://api.atlasflow.com/v1/openapi.yaml -o openapi.yaml\nnpm run generate\n```\n\nCI fails when the generated code is stale relative to the committed\nsnapshot.\n\n## Releasing\n\nPushing a `v*` tag builds, tests, and publishes the package to npm with\nprovenance via trusted publishing.\n\n## License\n\n[Apache License 2.0](LICENSE)\n","readmeFilename":"README.md"}