@oxy-hq/sdk 2.0.1 → 2.3.0

package/README.md

@@ -1,6 +1,6 @@
 # @oxy-hq/sdk
 
-React SDK for building **customer-app bundles** on the [Oxy](https://oxy.tech)
+React SDK for building **customer-app bundles** on the [Oxy](https://oxygen-hq.com)
 platform. A bundle is a normal Vite + React app that reads from its linked oxy
 project — raw SQL, the semantic layer, agents, and procedures — through a
 small set of hooks, plus a couple of drop-in components.
@@ -83,10 +83,17 @@ couldn't already read.
 | `useSemanticQuery({ topic, dimensions, measures, … })` | Semantic-layer query compiled by airlayer. |
 | `useAgentRun({ agentId })` | `.ask(question)` starts an analytics agent run; streams events over SSE; `.cancel()`. |
 | `useProcedureRun({ procedureId })` | Start a long-running procedure, poll, cancel (beta). |
+| `useFunction(name)` | `.invoke(body?)` runs a server-side **Oxy Function** (`functions/<name>.ts`) on oxy's isolate runtime; returns its JSON `Response`. For work the browser shouldn't do — warehouse writes, ELT, external APIs. |
 | `<OxyChat agentId="…" />` | Drop-in chat UI over `useAgentRun`. |
 | `<OxyAnswer … />` | Renders markdown + SQL artifacts + thread link. URL schemes are allowlisted (rejects `javascript:` etc.). |
 | `OxyApiError` | Structured `{ message, code? }` server-error envelope. |
 
+### Metric Tree
+
+Additional exports for programmatic metric-tree analyses (`AnomaliesClient`,
+`MetricTreeClient` and all related types) are available from the package root
+— see [metricTree.ts](src/metricTree.ts) and [anomalies.ts](src/anomalies.ts).
+
 Hooks fail loudly if called outside `<OxyAppProvider>`. The default fetcher
 sends `credentials: "include"` so same-origin (served-by-oxy) calls carry the
 session cookie automatically.
@@ -98,6 +105,7 @@ session cookie automatically.
 - SDK flow reference: `docs/sdk-flow.md` in that repo.
 - Platform internals: `internal-docs/customer-apps.md` in oxygen-internal.
 
+
 ## License
 
 MIT

package/dist/email.cjs

@@ -0,0 +1,14 @@
+// @oxy/sdk - TypeScript SDK for Oxy data platform
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let preact = require("preact");
+let preact_render_to_string = require("preact-render-to-string");
+
+//#region src/email.ts
+/** Render an email template component to an HTML string. */
+function render(Component, props) {
+	return (0, preact_render_to_string.render)((0, preact.h)(Component, props));
+}
+
+//#endregion
+exports.render = render;
+//# sourceMappingURL=email.cjs.map

package/dist/email.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.cjs","names":[],"sources":["../src/email.ts"],"sourcesContent":["// `@oxy-hq/sdk/email` — render an email template to an HTML string for use in\n// an Oxy Function's `ctx.email.send`.\n//\n// You write email templates as plain JSX components (point JSX at preact with\n// `jsxImportSource: \"preact\"` in the template's tsconfig — see the examples),\n// then:\n//\n// ```ts\n// import { render } from \"@oxy-hq/sdk/email\";\n// import { Welcome } from \"../emails/Welcome\";\n// await ctx.email.send({ to, subject, html: render(Welcome, { name }) });\n// ```\n//\n// Rendering uses preact-render-to-string — pure JS, no react-dom/server, no node\n// builtins, no Web Streams — so it bundles under esbuild `--platform=neutral`\n// and runs inside the Oxy Functions isolate (React Email / react-dom cannot).\n// Kept in a separate subpath entry so it never bloats the main SDK bundle.\n\nimport { type ComponentType, h } from \"preact\";\nimport { render as prerender } from \"preact-render-to-string\";\n\n/** Render an email template component to an HTML string. */\nexport function render<P extends Record<string, unknown>>(\n  Component: ComponentType<P>,\n  props: P\n): string {\n  return prerender(h(Component, props));\n}\n"],"mappings":";;;;;;;AAsBA,SAAgB,OACd,WACA,OACQ;CACR,yDAAmB,WAAW,KAAK,CAAC;AACtC"}

package/dist/email.d.cts

@@ -0,0 +1,8 @@
+
+import { ComponentType } from "preact";
+//#region src/email.d.ts
+/** Render an email template component to an HTML string. */
+declare function render<P extends Record<string, unknown>>(Component: ComponentType<P>, props: P): string;
+//#endregion
+export { render };
+//# sourceMappingURL=email.d.cts.map

package/dist/email.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.d.cts","names":[],"sources":["../src/email.ts"],"mappings":";;;;iBAsBgB,OAAO,UAAU,yBAC/B,WAAW,cAAc,IACzB,OAAO"}

package/dist/email.d.mts

@@ -0,0 +1,8 @@
+
+import { ComponentType } from "preact";
+//#region src/email.d.ts
+/** Render an email template component to an HTML string. */
+declare function render<P extends Record<string, unknown>>(Component: ComponentType<P>, props: P): string;
+//#endregion
+export { render };
+//# sourceMappingURL=email.d.mts.map

package/dist/email.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.d.mts","names":[],"sources":["../src/email.ts"],"mappings":";;;;iBAsBgB,OAAO,UAAU,yBAC/B,WAAW,cAAc,IACzB,OAAO"}

package/dist/email.mjs

@@ -0,0 +1,13 @@
+// @oxy/sdk - TypeScript SDK for Oxy data platform
+import { h } from "preact";
+import { render as render$1 } from "preact-render-to-string";
+
+//#region src/email.ts
+/** Render an email template component to an HTML string. */
+function render(Component, props) {
+	return render$1(h(Component, props));
+}
+
+//#endregion
+export { render };
+//# sourceMappingURL=email.mjs.map

package/dist/email.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"email.mjs","names":["prerender"],"sources":["../src/email.ts"],"sourcesContent":["// `@oxy-hq/sdk/email` — render an email template to an HTML string for use in\n// an Oxy Function's `ctx.email.send`.\n//\n// You write email templates as plain JSX components (point JSX at preact with\n// `jsxImportSource: \"preact\"` in the template's tsconfig — see the examples),\n// then:\n//\n// ```ts\n// import { render } from \"@oxy-hq/sdk/email\";\n// import { Welcome } from \"../emails/Welcome\";\n// await ctx.email.send({ to, subject, html: render(Welcome, { name }) });\n// ```\n//\n// Rendering uses preact-render-to-string — pure JS, no react-dom/server, no node\n// builtins, no Web Streams — so it bundles under esbuild `--platform=neutral`\n// and runs inside the Oxy Functions isolate (React Email / react-dom cannot).\n// Kept in a separate subpath entry so it never bloats the main SDK bundle.\n\nimport { type ComponentType, h } from \"preact\";\nimport { render as prerender } from \"preact-render-to-string\";\n\n/** Render an email template component to an HTML string. */\nexport function render<P extends Record<string, unknown>>(\n  Component: ComponentType<P>,\n  props: P\n): string {\n  return prerender(h(Component, props));\n}\n"],"mappings":";;;;;;AAsBA,SAAgB,OACd,WACA,OACQ;CACR,OAAOA,SAAU,EAAE,WAAW,KAAK,CAAC;AACtC"}