![](\"https://storage.googleapis.com/acho-prod-assets/acho-website-assets/logo/acho_logo_dark.svg\"){kind=logo}
\n \n
Acho JavaScript SDK for Node.js
\n\n\n Website \n
\n\n[](https://www.npmjs.com/package/@acho-inc/acho-js)\n[](https://www.npmjs.com/package/@acho-inc/acho-js)\n[](https://www.npmjs.com/package/@acho-inc/acho-js)\n\n## What is this repository for?\n\n- SDK for Acho Studio API\n\n## Features\n\n- Get data from Acho Resource by page\n- Run data sync for Acho Resource\n- Download data from Acho Resource\n- Query Acho Resource for data\n- Get Acho Resource Schema\n- Create Node.js Readable Stream from Acho Resource\n- Create Node.js Writable Stream from Acho Resource\n- Get data from Acho Project view\n- Get a list of Configured OAuth Client IDs for current organization\n- Use an OAuth Client ID to issue a Bearer Token\n- Connect to an Acho Published APP's instance\n- Join / leave the Acho Published APP instance's socket room\n- Send Event to the Acho Published APP instance\n\n## Installing\n\n**Package Manager**\n\n```\n$ npm install @acho-inc/acho-js\n```\n\nIf you want to use it as a dependency in your project that needs to be built and deployed\n\n```\n$ npm install @acho-inc/acho-js --save\n```\n\nAfter the package is installed in your **package.json**\n\n```js\nimport { Acho } from '@acho-inc/acho-js';\n```\n\n## Example\n\n**Initializing the Acho Client**\n\n```js\nconst AchoInstance = new Acho();\n```\n\nThe SDK will use the environment variables from your system\n\n**_ACHO_TOKEN_**: The Acho develoepr API token\n\n- If you are a current subscriber, retrieve it from your profile page\n- If you want to try out the SDK without an active subscription, please [contact us](https://calendly.com/contact_acho/discovery-call)\n\n**_ACHO_API_ENDPOINT_**: The service backend you are connecting to\n\n- Default to https://kube.acho.io\n- This setting is irrelevant unless you subscribe to on-premise or dedicated server\n\nIf you prefer convenience in testing, you could also initialize the instance by passing in the variables in constructor\n\n```js\nconst AchoInstance = new Acho({\n apiToken: 'eyEi3oldsi....',\n endpoint: 'https://kube.acho.io'\n});\n```\n\n> **Note:** It is not recommended to expose your API token in the code base, especially on production\\\n> We highly recommend dotenv for conveniently modifying environment variables during testing\\\n> If you suspect your token might be leaked, you can invalidate the token in your profile page, or report to [contact@acho.io](mailto:contact@acho.io)\n\n**Working with Resource Endpoints**\n\nCreate a new resource\n\n```js\nconst resourceResp = await AchoInstance.ResourceEndpoints.create({ name: 'test' });\n\n/* resourceResp: { \n resId: number,\n assetId: number,\n resource: {\n id: number,\n res_name: string,\n res_display_name: string,\n res_type: 'integration',\n is_ready: 1,\n create_time: unix_timestamp (UTC),\n user_id: number,\n update_time: unix_timestamp (UTC),\n asset_id: number\n }\n }\n*/\n```\n\n---\n\nCreate a table in a resource\n\n```js\nconst resourceTableResp = await AchoInstance.ResourceEndpoints.createTable({\n resId: testResId,\n tableName: 'test',\n schema: { col1: 'STRING', col2: 'INTEGER' }\n});\n\n/* resourceTableResp: {\n resource: {\n id: number,\n res_name: string,\n ...\n }\n tableName: string\n }\n*/\n```\n\n---\n\nStream data into a table\n\n```js\n// JSON flavor\nconst writableStream = await AchoInstance.ResourceEndpoints.createWriteStream({\n resId: testResId,\n tableId: 'test',\n dataType: 'json'\n});\nconst testArray = [\n { col1: 'JSON_1', col2: 1 },\n { col1: 'JSON_2', col2: 2 },\n { col1: 'JSON_3', col2: 3 },\n { col1: 'JSON_4', col2: 4 }\n];\nawait new Promise((resolve) => {\n testArray.forEach((row) => {\n writableStream.write(JSON.stringify(row) + '\\n');\n });\n writableStream.end();\n writableStream.on('response', (res) => {\n // expect(res.statusCode).toBe(200);\n resolve('done');\n });\n});\n\n// CSV flavor\nconst writableStream = await AchoInstance.ResourceEndpoints.createWriteStream({\n resId: testResId,\n tableId: 'test',\n dataType: 'csv'\n});\nconst testCSV = 'CSV_1,1\\nCSV_2,2\\nCSV_3,3\\nCSV_4,4\\n';\nawait new Promise((resolve) => {\n writableStream.write(testCSV);\n writableStream.end();\n writableStream.on('response', (res) => {\n // expect(res.statusCode).toBe(200);\n resolve('done');\n });\n});\n```\n\n> **Note:** You can also pipe readable stream into the writableStream created from a resource table\\\n> The supported formats are CSV and NDJSON.\n\n---\n\nStream data out from the table\n\n```js\n// create readable stream\nconst readableStream = await AchoInstance.ResourceEndpoints.createReadStream({\n resId: testResId,\n tableId: 'test'\n});\n\nreadableStream\n .on('data', (data) => {\n // do something here with the data\n // data: object\n })\n .on('end', () => {\n readableStream.destroy();\n });\n```\n\n---\n\n## Use Cases\n\n**Create a Resource and a table in the Resource, then insert data into the table**\n\nCreate a new resource and a resource table first\n\n```js\nconst createResourceTable = async () => {\n const resourceResp = await AchoInstance.ResourceEndpoints.create({\n name: 'Test Resource'\n });\n\n const { resId } = resourceResp;\n\n // please make sure you capture the resId here if you want to do the process in two steps\n console.log(resId);\n\n const resourceTableResp = await AchoInstance.ResourceEndpoints.createTable({\n resId: resId,\n tableName: 'Test Table',\n schema: { name: 'STRING', age: 'INTEGER' }\n });\n};\n```\n\nWrite data to the resource table (in this example we are using JSON)\n\n```js\nconst writeData = async () => {\n const writableStream = await AchoInstance.ResourceEndpoints.createWriteStream({\n // replace 1234 with the id you captured earlier\n resId: 1234,\n tableId: 'Test Table',\n dataType: 'json'\n });\n\n const testArray = [\n { name: 'Adam', age: 28 },\n { name: 'Dan', age: 33 },\n { name: 'Jason', age: 35 },\n { name: 'Zach', age: 40 }\n ];\n\n await new Promise((resolve) => {\n testArray.forEach((row) => {\n writableStream.write(JSON.stringify(row) + '\\n');\n });\n writableStream.end();\n writableStream.on('response', (res) => {\n resolve('done');\n });\n });\n};\n```\n\nAfter finishing the previous steps, if you add \"Test Table\" from Resource \"Test Resource\" to a Project on Acho, here is what you will get.\n\n![](\"\nhttps://storage.googleapis.com/acho-prod-assets/sdk/write_data_example_result.png\")
\n\n---\n\n**Working with Project Endpoints**\n\nGet view data from a project by viewId\n\n```js\nconst viewData = await AchoInstance.ProjectEndpoints.getViewData({\n viewId: 7869,\n pageSize: 10,\n page: 0\n});\n\n/* viewData: {\n data: Array