{"_id":"@camunda8/operate","_rev":"6-7a255fd8d01132e30c3254e835bba148","name":"@camunda8/operate","dist-tags":{"latest":"8.4.0","alpha":"8.4.0"},"versions":{"8.4.0":{"name":"@camunda8/operate","version":"8.4.0","keywords":["Camunda"],"author":{"name":"josh.wulf@camunda.com"},"license":"ISC","_id":"@camunda8/operate@8.4.0","maintainers":[{"name":"sitapati","email":"josh@magikcraft.io"}],"homepage":"https://github.com/camunda-community-hub/camunda-8-js-sdk#readme","bugs":{"url":"https://github.com/camunda-community-hub/camunda-8-js-sdk/issues"},"dist":{"shasum":"719e9070fa35b4d20f92b8fa5390e4cc3e419daf","tarball":"https://registry.npmjs.org/@camunda8/operate/-/operate-8.4.0.tgz","fileCount":24,"integrity":"sha512-rlDoZCZ2LTkzmIEZU7z9TPbZRRjnSg3QvD0JUocHNGaZnPnRVk7oD+igA6aVtnqpN1DC0/3wnlWcdX+hMr+TZA==","signatures":[{"sig":"MEUCIDcpVPY0ZjCez0YeruqUum/GutlYSJ58KwP+sfvpTRqAAiEAx/eNlwdD5N2hxfkVEibdbgu4veIMIqUZck8koaANMqc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":83957},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"45b1f93347bbe930d5782287d6821efec95e9a63","private":false,"scripts":{"docs":"typedoc src/index.ts","lint":"eslint . --ext .ts,.tsx --fix","test":"jest --detectOpenHandles","build":"npm run clean && npm run compile","clean":"rm -rf ./dist && rm -f ./tsconfig.tsbuildinfo","compile":"tsc","prettify":"prettier --write 'src/**/*.ts'"},"_npmUser":{"name":"sitapati","email":"josh@magikcraft.io"},"deprecated":"This package is deprecated. Please use the official SDK package @camunda8/sdk. See: https://github.com/camunda/camunda-8-js-sdk","repository":{"url":"git+https://github.com/camunda-community-hub/camunda-8-js-sdk.git","type":"git"},"_npmVersion":"lerna/7.4.2/node@v18.17.1+arm64 (darwin)","description":"A Node.js client for interacting with the Camunda 8 Operate API","directories":{},"_nodeVersion":"18.17.1","dependencies":{"got":"^11.8.5","@camunda8/oauth":"^8.4.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"typedoc":"^0.23.21"},"_npmOperationalInternal":{"tmp":"tmp/operate_8.4.0_1706754889593_0.21545032434770417","host":"s3://npm-registry-packages"}}},"time":{"created":"2024-02-01T02:34:49.488Z","modified":"2026-09-16T06:30:08.793Z","8.4.0":"2024-02-01T02:34:49.773Z"},"bugs":{"url":"https://github.com/camunda-community-hub/camunda-8-js-sdk/issues"},"author":{"name":"josh.wulf@camunda.com"},"license":"ISC","homepage":"https://github.com/camunda-community-hub/camunda-8-js-sdk#readme","keywords":["Camunda"],"repository":{"url":"git+https://github.com/camunda-community-hub/camunda-8-js-sdk.git","type":"git"},"description":"A Node.js client for interacting with the Camunda 8 Operate API","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":"# Operate API Client for Node.js\n\n [![NPM](https://nodei.co/npm/operate-api-client.png)](https://npmjs.org/package/operate-api-client) \n\n![Community Extension](https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-FF4700)\n\n![Lifecycle](https://img.shields.io/badge/Lifecycle-Stable-brightgreen)\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\nA Node.js client for interacting with the [Camunda 8 Operate REST API](https://docs.camunda.io/docs/apis-clients/operate-api/) in Camunda 8 SaaS.\n\nUses [camunda-saas-oauth-nodejs](https://github.com/camunda-community-hub/camunda-saas-oauth-nodejs) to use client credentials from the environment for authentication.\n\n## Installation\n\n```\nnpm i operate-api-client\n```\n\n## Usage\n\nSet the credentials for Camunda SaaS in the environment, then:\n\n```typescript\nimport { OperateApiClient } from 'operate-api-client'\n\nconst operate = new OperateApiClient()\n\noperate.searchProcessInstances({\n    filter: {\n        state: \"ACTIVE\"\n    },\n    size: 50\n}).then(instances => {\n    console.log(instances)\n})\n```\n## Advanced Usage\n\nIf you want to create multiple instances of the client in an application - for example, to address different clusters - then you can hydrate the client manually using an `OAuthProviderImpl` like so:\n\n```typescript\nimport { OperateApiClient } from 'operate-api-client'\nimport { OAuthProviderImpl } from \"camunda-saas-oauth\"\n\nconst oauthProvider1 = new OAuthProviderImpl({\n    audience: 'zeebe.camunda.io',\n    authServerUrl: 'https://login.cloud.camunda.io/oauth/token',\n    clientId: process.env.ZEEBE_CLIENT_ID_1, \n    clientSecret: process.env.ZEEBE_CLIENT_SECRET_1,\n    userAgentString: 'operate-client-nodejs'\n})\n\nconst client_1 = new OperateApiClient({\n    oauthProvider,\n    baseUrl: process.env.CAMUNDA_OPERATE_BASE_URL_1\n});\n\nconst oauthProvider2 = new OAuthProviderImpl({\n    audience: 'zeebe.camunda.io',\n    authServerUrl: 'https://login.cloud.camunda.io/oauth/token',\n    clientId: process.env.ZEEBE_CLIENT_ID_2, \n    clientSecret: process.env.ZEEBE_CLIENT_SECRET_2,\n    userAgentString: 'operate-client-nodejs'\n})\n\nconst client_2 = new OperateApiClient({\n    oauthProvider,\n    baseUrl: process.env.CAMUNDA_OPERATE_BASE_URL_2\n});\n```\n","readmeFilename":"README.md"}