@oxy-hq/sdk 2.1.0 → 2.4.0

package/README.md

@@ -98,6 +98,46 @@ 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.
 
+### Workspace shell (`@oxy-hq/sdk/shell`)
+
+The Oxygen workspace chrome — the 48px icon rail and universal top bar the
+main web-app renders — as reusable components, so your app reads as part of
+the same product. The main web-app consumes these exact components.
+
+```tsx
+import { OxyAppProvider } from "@oxy-hq/sdk";
+import { OxyShell } from "@oxy-hq/sdk/shell";
+import "@oxy-hq/sdk/shell.css";
+
+export function App() {
+  return (
+    <OxyAppProvider>
+      <OxyShell>
+        <Dashboard />
+      </OxyShell>
+    </OxyAppProvider>
+  );
+}
+```
+
+`OxyShell` bootstraps from `GET /api/projects/:id/shell-context` (workspace
+identity, sibling apps, host-aware navigation URLs) and degrades gracefully:
+if the endpoint is unavailable (older server), your app renders unchromed.
+
+| Export | What it does |
+| --- | --- |
+| `OxyShell` | Wired frame: rail + top bar + content column around your app. Slots: `topBarExtra`, `railBottom`, `hideTopBar`, `pageLabel`. |
+| `useShellContext()` | The raw shell bootstrap payload (`{ data, loading, error }`). |
+| `ShellRail`, `RailItem` | Presentational icon rail — props only, router-free. |
+| `TopBar`, `Breadcrumb`, `SystemIndicator`, `WorkspaceClock` | Presentational top bar pieces. |
+| `WorkspaceTile`, `OxyMark`, `OxygenFactoryMark` | Branding primitives. |
+| `workspaceLogoUrl(apiBaseUrl, wsId, version?)` | Workspace logo endpoint URL builder. |
+
+Styling: `shell.css` is namespaced (`oxy-shell-*`) — no Tailwind required, no
+global styles leak into your app. It follows your design tokens when present
+(`--sidebar-background`, `--foreground`, …) and falls back to the Oxygen
+defaults. Dark mode: put a `.dark` class on any ancestor.
+
 ## Docs
 
 - Hands-on dev + deploy guide: `docs/local-development.md` in the

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"}