CloudQuery Plugin SDK for JavaScript

This is the high-level package to use for developing CloudQuery plugins in JavaScript.

Prerequisites

Node.js 20 or higher. Install Node.js from here.

Setup

Install dependencies

npm ci

Build

npm run build

Test

npm test

Start a local memory based plugin server

npm run dev -- serve

Package as a Docker image

npm run dev -- package -m test "v1.0.0" . --dist-dir dist-dir

Formatting and Linting

# This is just to check if the code is formatted
npm run format:check

# Automatically format code
npm run format

# Lint
npm run lint

Changelog

0.1.27 (2025-07-01)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.35 (#281) (b73a94a)
• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.36 (#286) (127cd3c)
• deps: Update dependency @grpc/grpc-js to v1.13.4 (#285) (0c893fc)
• deps: Update dependency @tsconfig/node20 to v20.1.6 (#284) (8c81b87)

0.1.26 (2025-05-09)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.34 (#280) (5473220)
• deps: Update dependency prettier to v3.5.3 (#277) (8376dba)
• deps: Update dependency winston-error-format to v3.0.2 (#278) (ba90ab7)

0.1.25 (2025-04-01)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.33 (#274) (ce065cf)
• deps: Update dependency @tsconfig/node20 to v20.1.5 (#271) (500766e)

0.1.24 (2025-03-05)

Bug Fixes

• deps: Update dependency @apache-arrow/esnext-esm to v19.0.1 (#265) (71e723e)
• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.32 (#270) (1dc7d43)
• deps: Update dependency @grpc/grpc-js to v1.12.6 (#266) (c19ff46)
• deps: Update dependency eslint-import-resolver-typescript to v3.8.3 (#268) (9303711)
• deps: Update dependency prettier to v3.5.1 (#269) (5c1ddf8)

0.1.23 (2025-02-03)

Bug Fixes

• deps: Update dependency @apache-arrow/esnext-esm to v19 (#262) (65cf803)
• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.31 (#264) (9bb3fb6)
• deps: Update dependency p-timeout to v6.1.4 (#257) (0019a7c)
• deps: Update dependency typescript to v5.7.3 (#258) (ed0d619)
• deps: Update dependency uuid to v11.0.5 (#260) (7bed538)
• deps: Update eslint packages (#261) (beaf022)

0.1.22 (2025-01-07)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.30 (#256) (4ed12a0)
• deps: Update dependency @grpc/grpc-js to v1.12.5 (#251) (7f14cd1)
• deps: Update dependency execa to v9.5.2 (#252) (e29bc9f)
• deps: Update dependency p-map to v7.0.3 (#254) (2908744)
• deps: Update dependency prettier to v3.4.2 (#255) (f2b747e)

0.1.21 (2024-12-02)

Bug Fixes

• deps: Update dependency @apache-arrow/esnext-esm to v18 (#244) (cf83603)
• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.29 (#248) (abab01a)
• deps: Update dependency path-type to v6 (#245) (ff672a5)
• deps: Update dependency prettier to v3.4.1 (#249) (9f84e4b)
• deps: Update dependency typescript to v5.7.2 (#241) (14289b3)
• deps: Update dependency uuid to v11 (#246) (b5d8e4d)
• deps: Update dependency winston to v3.17.0 (#242) (8f0754c)

0.1.20 (2024-11-04)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.28 (#240) (d194de2)
• deps: Update dependency @grpc/grpc-js to v1.12.2 (#234) (471d4db)
• deps: Update dependency ava to v6.2.0 (#235) (4216ac6)
• deps: Update dependency eslint-plugin-import to v2.31.0 (#236) (dd0a13d)
• deps: Update dependency execa to v9.5.1 (#237) (74a0a32)
• deps: Update dependency p-timeout to v6.1.3 (#231) (dc4e921)
• deps: Update dependency typescript to v5.6.3 (#232) (6b2ea8d)
• deps: Update dependency winston to v3.15.0 (#238) (759fb91)

0.1.19 (2024-10-01)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.26 (#220) (2314963)
• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.27 (#230) (9b1af30)
• deps: Update dependency @grpc/grpc-js to v1.11.3 (#222) (4031d41)
• deps: Update dependency eslint to v8.57.1 (#223) (54f4929)
• deps: Update dependency eslint-plugin-import to v2.30.0 (#224) (90521e6)
• deps: Update dependency eslint-plugin-unicorn to v55 (#228) (60cbdd7)
• deps: Update dependency execa to v9.4.0 (#225) (ec9d3b2)
• deps: Update dependency typescript to v5.6.2 (#226) (aa368f3)

0.1.18 (2024-09-04)

Bug Fixes

• deps: Update dependency @apache-arrow/esnext-esm to v17 (#209) (c454a9c)
• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.25 (#207) (63d7c6d)
• deps: Update dependency @grpc/grpc-js to v1.11.1 (#203) (f719a26)
• deps: Update dependency @types/yargs to v17.0.33 (#212) (5c8eacc)
• deps: Update dependency ajv to v8.17.1 (#204) (3d62083)
• deps: Update dependency eslint-import-resolver-typescript to v3.6.3 (#213) (5cf3ac3)
• deps: Update dependency eslint-plugin-prettier to v5.2.1 (#205) (b4fa967)
• deps: Update dependency eslint-plugin-promise to v6.6.0 (#206) (f194f27)
• deps: Update dependency execa to v9 (#210) (2d381c2)
• deps: Update dependency execa to v9.3.1 (#214) (3ef5567)
• deps: Update dependency luxon to v3.5.0 (#215) (1d8d3e6)
• deps: Update dependency prettier to v3.3.3 (#198) (f8dcf18)
• deps: Update dependency semver to v7.6.3 (#199) (49e6c3b)
• deps: Update dependency typescript to v5.5.4 (#201) (d3af7ed)
• deps: Update dependency uuid to v10 (#211) (a6a5168)
• deps: Update dependency winston to v3.13.1 (#202) (909cd7c)
• deps: Update dependency winston to v3.14.2 (#216) (66bde84)
• deps: Update typescript-eslint monorepo to v7.18.0 (#208) (45196e4)

0.1.17 (2024-07-30)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.24 (#196) (28d61d3)

0.1.16 (2024-07-17)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.22 (#194) (1cc44a7)

0.1.15 (2024-07-08)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.21 (#192) (7985255)
• deps: Update dependency @grpc/grpc-js to v1.10.10 (#183) (df41c3e)
• deps: Update dependency ajv to v8.16.0 (#186) (0254ed4)
• deps: Update dependency dot-prop to v9 (#191) (902618a)
• deps: Update dependency eslint-plugin-promise to v6.4.0 (#188) (f9b989c)
• deps: Update dependency prettier to v3.3.2 (#187) (a332aec)
• deps: Update dependency typescript to v5.5.2 (#189) (1587728)
• deps: Update dependency winston-error-format to v3.0.1 (#184) (4d5427f)
• deps: Update typescript-eslint monorepo to v7.15.0 (#190) (5dead75)

0.1.14 (2024-06-19)

Bug Fixes

• Parent resource is not passed to table resolvers (#181) (d992df5)

0.1.13 (2024-06-11)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.20 (#180) (e80c25f)
• deps: Update dependency @grpc/grpc-js to v1.10.9 [SECURITY] (#178) (9aabab2)

0.1.12 (2024-06-03)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.19 (#177) (a9ec712)
• deps: Update dependency @grpc/grpc-js to v1.10.8 (#168) (5a10335)
• deps: Update dependency ajv to v8.14.0 (#172) (d82278c)
• deps: Update dependency ava to v6.1.3 (#169) (8eca09e)
• deps: Update dependency eslint-plugin-promise to v6.2.0 (#173) (aa2c7cb)
• deps: Update dependency semver to v7.6.2 (#171) (154f3d9)

0.1.11 (2024-05-01)

Bug Fixes

• deps: Update dependency @grpc/grpc-js to v1.10.6 (#159) (04929b4)
• deps: Update dependency ajv to v8.13.0 (#164) (d3d0377)
• deps: Update dependency eslint-plugin-unused-imports to v3.2.0 (#165) (0387ea3)
• deps: Update dependency eslint-plugin-you-dont-need-lodash-underscore to v6.14.0 (#166) (c8d5fce)
• deps: Update dependency modern-errors to v7.0.1 (#160) (df916b5)
• deps: Update dependency p-map to v7.0.2 (#162) (3c41e74)
• deps: Update dependency typescript to v5.4.5 (#163) (22af059)
• deps: Update typescript-eslint monorepo to v7.8.0 (#167) (68a3c39)

0.1.10 (2024-04-11)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.18 (#157) (d5a90b4)

0.1.9 (2024-04-01)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.17 (#155) (d6994f3)

0.1.8 (2024-04-01)

Bug Fixes

• deps: Update dependency @grpc/grpc-js to v1.10.4 (#146) (23f532d)
• deps: Update dependency @tsconfig/node20 to v20.1.4 (#147) (727d75a)
• deps: Update dependency typescript to v5.4.3 (#149) (e33acf6)
• deps: Update dependency winston to v3.13.0 (#150) (7bf728e)

0.1.7 (2024-03-01)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.16 (#145) (165c18a)
• deps: Update dependency @grpc/grpc-js to v1.10.1 (#139) (3fa3bdf)
• deps: Update dependency ava to v6.1.2 (#136) (f347ef9)
• deps: Update dependency eslint to v8.57.0 (#140) (bb3612c)
• deps: Update dependency eslint-plugin-unused-imports to v3.1.0 (#141) (74cdb95)
• deps: Update dependency semver to v7.6.0 (#142) (7e98f6a)
• deps: Update typescript-eslint monorepo to v6.21.0 (#143) (a939d0d)

0.1.6 (2024-02-12)

Features

• Implement GetSpecSchema plugin gRPC API call (#133) (d1568f5)

0.1.5 (2024-02-01)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.14 (#132) (2fd4d80)
• deps: Update dependency @grpc/grpc-js to v1.9.14 (#123) (31069d4)
• deps: Update dependency @types/luxon to v3.4.2 (#128) (1497bf3)
• deps: Update dependency @types/uuid to v9.0.8 (#124) (4678570)
• deps: Update dependency ava to v6.1.1 (#129) (45bccb8)
• deps: Update dependency eslint-plugin-n to v16.6.2 (#126) (70fcc0b)
• deps: Update dependency eslint-plugin-prettier to v5.1.3 (#127) (1b67bba)

0.1.4 (2024-01-03)

Bug Fixes

• Rename registry (#121) (b9f6d6b)

0.1.3 (2024-01-02)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.13 (#119) (e1779b5)

0.1.2 (2024-01-02)

Bug Fixes

• deps: Update actions/setup-node action to v4 (#118) (be808e4)
• deps: Update dependency eslint to v8.56.0 (#113) (6ecdd53)
• deps: Update dependency eslint-plugin-import to v2.29.1 (#110) (4bb02e1)
• deps: Update dependency eslint-plugin-n to v16.6.0 (#114) (7e856e5)
• deps: Update dependency eslint-plugin-prettier to v5.1.2 (#115) (6017ce7)
• deps: Update dependency p-map to v7.0.1 (#111) (dac1c46)
• deps: Update typescript-eslint monorepo to v6.16.0 (#116) (80a2b95)

0.1.1 (2023-12-29)

Bug Fixes

• Add --license placeholder for future use (#108) (0537d45)

0.1.0 (2023-12-18)

⚠ BREAKING CHANGES

• Require Node.js 20

Features

• Add package command (f2f7931)

0.0.9 (2023-12-01)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.11 (#97) (2825c74)
• deps: Update dependency @grpc/grpc-js to v1.9.12 (#98) (b03c60b)
• deps: Update dependency @grpc/grpc-js to v1.9.9 (#88) (677c305)
• deps: Update dependency @types/luxon to v3.3.3 (#89) (d1ddb85)
• deps: Update dependency @types/uuid to v9.0.6 (#91) (97af854)
• deps: Update dependency @types/uuid to v9.0.7 (#99) (7ebb89c)
• deps: Update dependency @types/yargs to v17.0.29 (#92) (f14508e)
• deps: Update dependency @types/yargs to v17.0.32 (#100) (1fde7b1)
• deps: Update dependency eslint to v8.52.0 (#94) (5b33b9a)
• deps: Update dependency eslint to v8.54.0 (#102) (398af79)
• deps: Update dependency eslint-plugin-import to v2.29.0 (#95) (e124ec7)
• deps: Update dependency eslint-plugin-n to v16.2.0 (#96) (2b206d2)
• deps: Update dependency eslint-plugin-n to v16.3.1 (#103) (6750808)
• deps: Update dependency eslint-plugin-prettier to v5.0.1 (#93) (d2095b2)
• deps: Update dependency luxon to v3.4.4 (#101) (8b6d8c3)
• deps: Update dependency prettier to v3.1.0 (#104) (34fd32a)
• deps: Update dependency winston to v3.11.0 (#105) (b2587c8)

0.0.8 (2023-10-12)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.10 (#86) (a04dee8)

0.0.7 (2023-10-02)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.9 (#85) (ce316f2)
• deps: Update dependency @grpc/grpc-js to v1.9.4 (#76) (d5a8346)
• deps: Update dependency @types/yargs to v17.0.26 (#77) (0877451)
• deps: Update dependency eslint to v8.50.0 (#81) (533ce58)
• deps: Update dependency eslint-import-resolver-typescript to v3.6.1 (#82) (ad8ca8d)
• deps: Update dependency eslint-plugin-n to v16.1.0 (#83) (e367fe4)
• deps: Update dependency eslint-plugin-you-dont-need-lodash-underscore to v6.13.0 (#84) (f2aca02)
• deps: Update dependency luxon to v3.4.3 (#79) (7d79311)
• deps: Update dependency uuid to v9.0.1 (#80) (c75ff6a)

0.0.6 (2023-09-01)

Bug Fixes

• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.8 (#74) (1f10c33)

0.0.5 (2023-09-01)

Bug Fixes

• deps: Update dependency @grpc/grpc-js to v1.9.2 (#65) (ec6565e)
• deps: Update dependency @tsconfig/node16 to v16.1.1 (#66) (482939d)
• deps: Update dependency @types/uuid to v9.0.3 (#68) (4a515a4)
• deps: Update dependency eslint to v8.48.0 (#73) (155a557)
• deps: Update dependency eslint-plugin-import to v2.28.1 (#69) (5bc2684)
• deps: Update dependency eslint-plugin-n to v16.0.2 (#70) (1c39e33)
• deps: Update dependency luxon to v3.4.2 (#71) (d9d15f4)
• deps: Update dependency prettier to v3.0.3 (#72) (6e0a720)

0.0.4 (2023-08-17)

Bug Fixes

• Remove date in favor of timestamp, handle interval, pass underlying value to arrow (#62) (239dccb)

0.0.3 (2023-08-16)

Features

• Add addCQIDsColumns util, split MemDB into files (#51) (dd71c60)
• Add arrow dependency (#15) (082213f)
• Add Bool scalar (#17) (80edcd5)
• Add CLI argument parsing (#10) (0d70b25)
• Add CQID and Parent CQID (#53) (fbb7c94)
• Add initial sync, scheduler (#37) (9b41287)
• Add JSON scalar (#55) (7e39769)
• Add multiplexer, round-robin (#48) (00a842a)
• Add String type (#29) (4c07a3d)
• Add table types (#32) (c7b301d)
• Add UUID scalar (#54) (d8474ce)
• Add UUID, JSON types (#56) (45ab919)
• Implement discovery service (#19) (3abe320)
• Implement logger (#21) (43becf1)
• List scalars (#36) (0eb6d62)
• MemDB read (#43) (3429de0), closes #41
• MemDB writes (#42) (8f21f52)
• More scalars (#50) (a9589b6)
• Scaffold plugin server (#27) (f0864eb)
• scalars: Timestamp, float64, int64 (#35) (7fc391c)
• Transform objects (#34) (c14f017), closes #5
• Transformers (#25) (e96adb3)

Bug Fixes

• @grpc/grpc-js dependency (2adf06d)
• deps: Update dependency @cloudquery/plugin-pb-javascript to ^0.0.6 (#14) (92a87a1)
• Encode tables in migrate messages (#38) (f6413d2)
• Error handling, null values in scalars, proper exports (#61) (2b283d1)
• Extension types null values (#58) (e8bb0a0)
• Flatten tables in GetTables gRPC call (#57) (5a8f3c3)
• Implement sync, scheduler, resource encoding (#44) (4a5f9e8)
• Parent CQId resolver (8de14cb)
• Properly encode uuid (#59) (72efa22)
• Support only tcp network (#23) (e138e40)
• Write gRPC call, use for await on write readble stream (#52) (773a0e5)

0.0.2 (2023-08-07)

Bug Fixes

• Package name (644631a)

0.0.1 (2023-08-03)

Features

• Initial commit (56fec12)

Bug Fixes

• Docs (47832f5)

Miscellaneous Chores

• Release 0.0.1 (533a8ff)