{"_id":"@camunda8/hub-api-client","_rev":"4-bbbbea891f0ff12d3ffe07eb316e5d69","name":"@camunda8/hub-api-client","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"@camunda8/hub-api-client","version":"0.1.0","author":{"name":"Camunda Services GmbH","email":"https://camunda.com"},"license":"Camunda-1.0","_id":"@camunda8/hub-api-client@0.1.0","maintainers":[{"name":"vobu","email":"vobu+npmjs@posteo.de"},{"name":"sitapati","email":"josh@magikcraft.io"},{"name":"emilyoram","email":"emily.oram@camunda.com"}],"homepage":"https://github.com/camunda/hub-public-api-client#readme","bugs":{"url":"https://github.com/camunda/hub-public-api-client/issues"},"dist":{"shasum":"3bb8062638b6c4f2bc54b09b4d9391b5c96c17d9","tarball":"https://registry.npmjs.org/@camunda8/hub-api-client/-/hub-api-client-0.1.0.tgz","fileCount":15,"integrity":"sha512-JVgypkqzfpotYiNSpQnhDXADWZoxjrNaYoolJhPQxk42q0AtyOhrXqdYcRlg953CEHzdAEqKnUrFX21UM9QrGw==","signatures":[{"sig":"MEQCIDpEB5caYPZbRJ4rVBJ9p27qTVoCAU6jZXUABkmDHEfHAiBINjQX4QfoCrFVO6N0hJdgNmnm7pdEuH84rY8mbCJ3bQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":158598},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","engines":{"node":">=22.14.0"},"exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"gitHead":"da3f760268feb58668998fedbccea8af85d952c8","scripts":{"tsc":"tsc --noEmit","lint":"eslint src/","build":"npm run clean && npm run generate && tsc","clean":"rimraf dist src/generated","pretsc":"npm run generate","prepack":"npm run build","generate":"node scripts/generate.mjs","fetch-spec":"git clone --depth 1 --filter=blob:none --sparse https://github.com/camunda/camunda-hub .spec-src && git -C .spec-src sparse-checkout set restapi/public-api/src/main/resources/openapi/v2"},"_npmUser":{"name":"emilyoram","email":"emily.oram@camunda.com"},"repository":{"url":"git+https://github.com/camunda/hub-public-api-client.git","type":"git"},"_npmVersion":"11.13.0","description":"Typed TypeScript client for the Camunda Hub public API v2, generated from its OpenAPI specification.","directories":{},"_nodeVersion":"26.2.0","dependencies":{"openapi-fetch":"0.14.0"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"eslint":"9.39.4","rimraf":"6.1.3","globals":"17.6.0","prettier":"3.6.2","@eslint/js":"9.39.4","typescript":"5.9.3","typescript-eslint":"8.61.1","openapi-typescript":"7.13.0","eslint-config-prettier":"10.1.8","eslint-plugin-prettier":"5.5.6","eslint-plugin-license-header":"0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/hub-api-client_0.1.0_1782442812647_0.41931798786693775","host":"s3://npm-registry-packages-npm-production"}},"0.2.0":{"name":"@camunda8/hub-api-client","version":"0.2.0","author":{"name":"Camunda Services GmbH","email":"https://camunda.com"},"license":"Camunda-1.0","_id":"@camunda8/hub-api-client@0.2.0","maintainers":[{"name":"vobu","email":"vobu+npmjs@posteo.de"},{"name":"sitapati","email":"josh@magikcraft.io"},{"name":"emilyoram","email":"emily.oram@camunda.com"}],"homepage":"https://github.com/camunda/hub-public-api-client#readme","bugs":{"url":"https://github.com/camunda/hub-public-api-client/issues"},"dist":{"shasum":"5b1a2f269b6e3f04d2e787f7b3cc55de0453f250","tarball":"https://registry.npmjs.org/@camunda8/hub-api-client/-/hub-api-client-0.2.0.tgz","fileCount":15,"integrity":"sha512-RUqO/MAxGH4aoADyfgsLTeJIo+SliJjp8YllByF24hg83V/qUMSWAbD2SnblqDHcTt5JJm9UIplj4dQFSXFbmQ==","signatures":[{"sig":"MEYCIQDHV4X2fseDFFcMMq4AsNmKikiRT0/v3MFSKOnD8R2Y6wIhAKzZIXmf3K9lvR0Vee3CxZ52G4YSTFE2tF/ynZ5iUuwN","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@camunda8%2fhub-api-client@0.2.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":199707},"main":"dist/index.js","type":"module","types":"dist/index.d.ts","engines":{"node":">=22.14.0"},"exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"gitHead":"ad4f8fb62e31221103a4dfe20185eca14e7ee4af","scripts":{"tsc":"tsc --noEmit","lint":"eslint src/","build":"npm run clean && npm run generate && tsc","clean":"rimraf dist src/generated","pretsc":"npm run generate","prepack":"npm run build","generate":"node scripts/generate.mjs","fetch-spec":"git clone --depth 1 --filter=blob:none --sparse https://github.com/camunda/camunda-hub .spec-src && git -C .spec-src sparse-checkout set restapi/public-api/src/main/resources/openapi/v2"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:59fe12a1-5dae-4abf-b0bb-2a64596429d8"}},"repository":{"url":"git+https://github.com/camunda/hub-public-api-client.git","type":"git"},"_npmVersion":"11.16.0","description":"Typed TypeScript client for the Camunda Hub public API v2, generated from its OpenAPI specification.","directories":{},"_nodeVersion":"24.18.0","dependencies":{"openapi-fetch":"0.14.0"},"publishConfig":{"access":"public","provenance":true},"_hasShrinkwrap":false,"devDependencies":{"eslint":"9.39.4","rimraf":"6.1.3","globals":"17.6.0","prettier":"3.6.2","@eslint/js":"9.39.4","typescript":"5.9.3","typescript-eslint":"8.61.1","openapi-typescript":"7.13.0","eslint-config-prettier":"10.1.8","eslint-plugin-prettier":"5.5.6","eslint-plugin-license-header":"0.9.0"},"_npmOperationalInternal":{"tmp":"tmp/hub-api-client_0.2.0_1782973196086_0.7058317010744313","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2026-06-26T03:00:12.450Z","modified":"2026-09-16T06:30:08.150Z","0.1.0":"2026-06-26T03:00:12.811Z","0.2.0":"2026-07-02T06:19:56.355Z"},"bugs":{"url":"https://github.com/camunda/hub-public-api-client/issues"},"author":{"name":"Camunda Services GmbH","email":"https://camunda.com"},"license":"Camunda-1.0","homepage":"https://github.com/camunda/hub-public-api-client#readme","repository":{"url":"git+https://github.com/camunda/hub-public-api-client.git","type":"git"},"description":"Typed TypeScript client for the Camunda Hub public API v2, generated from its OpenAPI specification.","maintainers":[{"email":"vobu+npmjs@posteo.de","name":"vobu"},{"email":"josh@magikcraft.io","name":"sitapati"},{"email":"emily.oram@camunda.com","name":"emilyoram"},{"email":"jan.ladleif@camunda.com","name":"camunda-jan"},{"email":"pablocabrera1985@gmail.com","name":"pcab"}],"readme":"# @camunda8/hub-api-client\n\nA typed TypeScript client for the **Camunda Hub public API v2**.\n\nGenerated from the Camunda Hub public API v2 OpenAPI contract, so request,\nresponse, and model types always match the published spec. Built on\n[`openapi-fetch`](https://openapi-ts.dev/openapi-fetch/) for a small, typed\n`fetch` client.\n\n## Installation\n\n```bash\nnpm install @camunda8/hub-api-client\n```\n\n## Usage\n\nCreate a client with the API base URL (including the `/api/v2` segment) and a\nbearer token, then call endpoints by path and method. Request bodies, query\nparameters, path parameters, and responses are all fully typed from the spec.\n\n```ts\nimport { createHubApiClient } from '@camunda8/hub-api-client';\n\nconst client = createHubApiClient({\n  baseUrl: 'https://modeler.camunda.io/api/v2',\n  // A static token, or a (possibly async) function returning a fresh one.\n  token: async () => fetchAccessToken()\n});\n\n// Typed path + body. `data` is the typed response, `error` the typed problem detail.\nconst { data, error } = await client.POST('/projects', {\n  body: { name: 'My project', workspaceKey: 'my-workspace-key' }\n});\n\nif (error) {\n  throw new Error(`Request failed: ${error.detail}`);\n}\n\nconsole.log(data.projectKey);\n\n// Path parameters are typed too. Every call returns `{ data, error }`.\nconst { data: project } = await client.GET('/projects/{projectKey}', {\n  params: { path: { projectKey: data.projectKey } }\n});\n```\n\n### Authentication\n\n`token` may be a string or a function returning a string (sync or async). When\nprovided, an `Authorization: Bearer <token>` header is attached to every\nrequest. The function form is resolved on each request, so it can return a\nfreshly refreshed token. Omit `token` to handle authentication yourself (e.g.\nvia a custom `fetch` or default `headers`, both forwarded to `openapi-fetch`).\n\n### Using the model types\n\nThe generated models are exported for reuse in your own code:\n\n```ts\nimport type { Schemas } from '@camunda8/hub-api-client';\n\ntype Project = Schemas['ProjectResult'];\n```\n\nThe lower-level `paths`, `operations`, and `components` types are also exported\nfor advanced use cases.\n\n## Contributing\n\nThe client is generated from the Camunda Hub public API v2 OpenAPI spec and is\nnot committed. See [CONTRIBUTING.md](./CONTRIBUTING.md) for how to fetch the\nspec, regenerate, and publish.\n","readmeFilename":"README.md"}