@carto/api-client 0.0.1-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +24 -0
  2. package/build/api-client.cjs +1202 -0
  3. package/build/api-client.cjs.map +1 -0
  4. package/build/api-client.modern.js +1089 -0
  5. package/build/api-client.modern.js.map +1 -0
  6. package/build/client.d.ts +4 -0
  7. package/build/constants-internal.d.ts +21 -0
  8. package/build/constants.d.ts +33 -0
  9. package/build/index.d.ts +5 -0
  10. package/build/models/common.d.ts +25 -0
  11. package/build/models/index.d.ts +3 -0
  12. package/build/models/model.d.ts +17 -0
  13. package/build/sources/index.d.ts +5 -0
  14. package/build/sources/types.d.ts +80 -0
  15. package/build/sources/widget-base-source.d.ts +32 -0
  16. package/build/sources/widget-query-source.d.ts +8 -0
  17. package/build/sources/widget-table-source.d.ts +8 -0
  18. package/build/sources/wrappers.d.ts +47 -0
  19. package/build/types-internal.d.ts +7 -0
  20. package/build/types.d.ts +73 -0
  21. package/build/utils.d.ts +27 -0
  22. package/package.json +89 -0
  23. package/src/client.ts +17 -0
  24. package/src/constants-internal.ts +24 -0
  25. package/src/constants.ts +37 -0
  26. package/src/index.ts +5 -0
  27. package/src/models/common.ts +93 -0
  28. package/src/models/index.ts +3 -0
  29. package/src/models/model.ts +112 -0
  30. package/src/sources/index.ts +5 -0
  31. package/src/sources/types.ts +90 -0
  32. package/src/sources/widget-base-source.ts +255 -0
  33. package/src/sources/widget-query-source.ts +25 -0
  34. package/src/sources/widget-table-source.ts +25 -0
  35. package/src/sources/wrappers.ts +114 -0
  36. package/src/types-internal.ts +9 -0
  37. package/src/types.ts +76 -0
  38. package/src/utils.ts +84 -0
package/README.md ADDED
@@ -0,0 +1,24 @@
1
+ # `@carto/api-client`
2
+
3
+ ## References
4
+
5
+ - [Product feature brief](https://docs.google.com/document/d/1ZWiVB_rgXf1WAEF1TjJgEHxp92kREYQrWG3O8jYV0Zk/edit)
6
+ - [Architecture document](https://app.shortcut.com/cartoteam/write/IkRvYyI6I3V1aWQgIjY2MzE1NDU0LTIyZTAtNDI4YS04NzMzLTc3YzZjN2I2MjVjYSI=?commentId=e509d33c6cdedf90599a5d3a937336d8e&commentThreadId=e7dbf03c9bd7b0fd3de40ebacbea67ee9)
7
+
8
+ ## Quickstart
9
+
10
+ ```bash
11
+ # install dependencies
12
+ yarn
13
+
14
+ # build package once
15
+ yarn build
16
+
17
+ # build package and watch for changes
18
+ yarn build --watch
19
+
20
+ # build package, watch for changes, and start a local server for examples
21
+ yarn dev
22
+ ```
23
+
24
+ After running `yarn dev`, a browser window should open with links to examples. Unless a different port number is required, the local URL will be `localhost:5173`.