@oceanum/datamesh 0.5.0 → 0.5.2

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 (32) hide show
  1. package/README.md +22 -1
  2. package/dist/README.md +22 -1
  3. package/dist/index.cjs +2 -12
  4. package/dist/index.js +20 -21
  5. package/package.json +1 -1
  6. package/proxy/cloudflare/index.js +2 -1
  7. package/proxy/express/README.md +54 -0
  8. package/proxy/express/index.js +126 -0
  9. package/proxy/guide.md +140 -0
  10. package/src/lib/connector.ts +1 -1
  11. package/src/lib/datamodel.ts +17 -5
  12. package/src/lib/session.ts +7 -5
  13. package/src/lib/zarr.ts +7 -4
  14. package/typedoc.json +2 -1
  15. package/dist/index.d.ts +0 -5
  16. package/dist/index.d.ts.map +0 -1
  17. package/dist/lib/connector.d.ts +0 -142
  18. package/dist/lib/connector.d.ts.map +0 -1
  19. package/dist/lib/datamodel.d.ts +0 -168
  20. package/dist/lib/datamodel.d.ts.map +0 -1
  21. package/dist/lib/datasource.d.ts +0 -117
  22. package/dist/lib/datasource.d.ts.map +0 -1
  23. package/dist/lib/observe.d.ts +0 -3
  24. package/dist/lib/observe.d.ts.map +0 -1
  25. package/dist/lib/query.d.ts +0 -135
  26. package/dist/lib/query.d.ts.map +0 -1
  27. package/dist/lib/session.d.ts +0 -61
  28. package/dist/lib/session.d.ts.map +0 -1
  29. package/dist/lib/zarr.d.ts +0 -33
  30. package/dist/lib/zarr.d.ts.map +0 -1
  31. package/dist/test/fixtures.d.ts +0 -11
  32. package/dist/test/fixtures.d.ts.map +0 -1
package/README.md CHANGED
@@ -28,4 +28,25 @@ const data = await datamesh.query(query);
28
28
  ```
29
29
 
30
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) to learn more.
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.
32
+
33
+ ## Using a Datamesh Proxy
34
+
35
+ If you are building a browser application, we recommend using a reverse proxy to keep your Datamesh token secret and to simplify CORS. This package includes an example Cloudflare Worker you can deploy quickly and configure the `Connector` to use.
36
+
37
+ - See the [proxy guide](./proxy/guide.md) for more information.
38
+
39
+ Quick setup:
40
+
41
+ ```ts
42
+ import { Connector } from "@oceanum/datamesh";
43
+
44
+ const PROXY_URL = "https://your-proxy.workers.dev"; // or your own domain
45
+
46
+ const datamesh = new Connector("proxy", {
47
+ service: PROXY_URL,
48
+ gateway: PROXY_URL,
49
+ });
50
+ ```
51
+
52
+ Deploy the example Worker at `proxy/cloudflare/index.js` and add a secret `DATAMESH_TOKEN` with your Datamesh token in the Worker settings.
package/dist/README.md CHANGED
@@ -28,4 +28,25 @@ const data = await datamesh.query(query);
28
28
  ```
29
29
 
30
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) to learn more.
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.
32
+
33
+ ## Using a Datamesh Proxy
34
+
35
+ If you are building a browser application, we recommend using a reverse proxy to keep your Datamesh token secret and to simplify CORS. This package includes an example Cloudflare Worker you can deploy quickly and configure the `Connector` to use.
36
+
37
+ - See the [proxy guide](./proxy/guide.md) for more information.
38
+
39
+ Quick setup:
40
+
41
+ ```ts
42
+ import { Connector } from "@oceanum/datamesh";
43
+
44
+ const PROXY_URL = "https://your-proxy.workers.dev"; // or your own domain
45
+
46
+ const datamesh = new Connector("proxy", {
47
+ service: PROXY_URL,
48
+ gateway: PROXY_URL,
49
+ });
50
+ ```
51
+
52
+ Deploy the example Worker at `proxy/cloudflare/index.js` and add a secret `DATAMESH_TOKEN` with your Datamesh token in the Worker settings.