@oceanum/datamesh 0.1.1 → 0.2.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 (57) hide show
  1. package/README.md +4 -3
  2. package/dist/README.md +31 -0
  3. package/dist/blosc-CeItQ6qj.cjs +17 -0
  4. package/dist/blosc-DaK8KnI4.js +719 -0
  5. package/dist/browser-BDe_cnOJ.cjs +1 -0
  6. package/dist/browser-CJIXy_XB.js +524 -0
  7. package/dist/chunk-INHXZS53-DiyuLb3Z.js +14 -0
  8. package/dist/chunk-INHXZS53-z3BpFH8p.cjs +1 -0
  9. package/dist/gzip-DfmsOCZR.cjs +1 -0
  10. package/dist/gzip-TMN4LZ5e.js +24 -0
  11. package/dist/index.cjs +9 -0
  12. package/dist/index.d.ts +4 -2
  13. package/dist/index.d.ts.map +1 -1
  14. package/dist/index.js +11341 -0
  15. package/dist/lib/connector.d.ts +13 -17
  16. package/dist/lib/connector.d.ts.map +1 -1
  17. package/dist/lib/datamodel.d.ts +53 -24
  18. package/dist/lib/datamodel.d.ts.map +1 -1
  19. package/dist/lib/datasource.d.ts +8 -30
  20. package/dist/lib/datasource.d.ts.map +1 -1
  21. package/dist/lib/observe.d.ts +3 -0
  22. package/dist/lib/observe.d.ts.map +1 -0
  23. package/dist/lib/query.d.ts +30 -56
  24. package/dist/lib/query.d.ts.map +1 -1
  25. package/dist/lib/zarr.d.ts +2 -2
  26. package/dist/lz4-CssV0LoA.js +643 -0
  27. package/dist/lz4-PFaIsPAh.cjs +15 -0
  28. package/dist/test/fixtures.d.ts +9 -5
  29. package/dist/test/fixtures.d.ts.map +1 -1
  30. package/dist/zlib-C-RQJQaC.cjs +1 -0
  31. package/dist/zlib-DrihHfbK.js +24 -0
  32. package/dist/zstd-Cqadn9HA.js +610 -0
  33. package/dist/zstd-_xUhkGOV.cjs +15 -0
  34. package/package.json +8 -4
  35. package/src/docs/reverse_proxy.md +0 -0
  36. package/src/index.js +20 -0
  37. package/src/index.ts +2 -0
  38. package/src/lib/connector.ts +33 -23
  39. package/src/lib/datamodel.ts +165 -25
  40. package/src/lib/datasource.ts +20 -24
  41. package/src/lib/observe.ts +21 -0
  42. package/src/lib/query.ts +26 -50
  43. package/src/lib/workers/README.md +3 -0
  44. package/src/test/dataframe.test.ts +108 -0
  45. package/src/test/dataset.test.ts +1 -1
  46. package/src/test/datasource.test.ts +1 -1
  47. package/src/test/fixtures.ts +132 -7
  48. package/src/test/query.test.ts +1 -1
  49. package/tsconfig.lib.json +2 -1
  50. package/tsconfig.vitest-temp.json +50 -0
  51. package/typedoc.json +5 -1
  52. package/vite.config.ts +11 -1
  53. package/vite.config.ts.timestamp-1734584068599-c5119713c3c4e.mjs +67 -0
  54. package/dist/tsconfig.lib.tsbuildinfo +0 -1
  55. package/src/lib/workers/sw.js +0 -44
  56. package/vitest.config.ts +0 -10
  57. /package/{eslint.config.js → eslint.config.cjs} +0 -0
package/README.md CHANGED
@@ -4,7 +4,7 @@ A typescript library for interacting with the Oceanum.io Datamesh.
4
4
 
5
5
  ## Installation
6
6
 
7
- You can use this library in Node.js, Deno or browser code
7
+ You can use this library in Node.js, Deno or browser code (with the caveat below)
8
8
 
9
9
  ```sh
10
10
  npm install @oceanum/datamesh
@@ -16,7 +16,7 @@ npm install @oceanum/datamesh
16
16
  import { Connector } from "@oceanum/datamesh";
17
17
 
18
18
  //Instatiate the Datamesh Connector
19
- const datamesh=Connector("my_datamesh_token"); //Get you datamesh token from your Oceanum.io account
19
+ const datamesh=Connector("my_datamesh_token"); //Get your datamesh token from your Oceanum.io account
20
20
 
21
21
  //Define a datamesh query
22
22
  const query={
@@ -27,4 +27,5 @@ const query={
27
27
  const data=await datamesh.query(query);
28
28
  ```
29
29
 
30
- DO NOT put your Datamesh token directly into browser code. For use in an SPA, you can either forward your Datamesh request through a proxy or implement a token exchange. Read the [library documentation](https://oceanum-js.oceanum.io/) to learn more.
30
+ [!WARNING]
31
+ DO NOT put your Datamesh token directly into browser code. For use in an SPA, you should forward your Datamesh request through a reverse proxy to conceal your token. Read the [library documentation](https://oceanum-js.oceanum.io/datamesh/reverse_proxy) to learn more.
package/dist/README.md ADDED
@@ -0,0 +1,31 @@
1
+ # @oceanum/datamesh
2
+
3
+ A typescript library for interacting with the Oceanum.io Datamesh.
4
+
5
+ ## Installation
6
+
7
+ You can use this library in Node.js, Deno or browser code (with the caveat below)
8
+
9
+ ```sh
10
+ npm install @oceanum/datamesh
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ ```javascript
16
+ import { Connector } from "@oceanum/datamesh";
17
+
18
+ //Instatiate the Datamesh Connector
19
+ const datamesh=Connector("my_datamesh_token"); //Get your datamesh token from your Oceanum.io account
20
+
21
+ //Define a datamesh query
22
+ const query={
23
+ "datasource":"oceanum-sizing_giants"
24
+ }
25
+
26
+ //Get the data
27
+ const data=await datamesh.query(query);
28
+ ```
29
+
30
+ [!WARNING]
31
+ DO NOT put your Datamesh token directly into browser code. For use in an SPA, you should forward your Datamesh request through a reverse proxy to conceal your token. Read the [library documentation](https://oceanum-js.oceanum.io/datamesh/reverse_proxy) to learn more.