@ohm_studio/sdk-react-native 0.1.0

package/README.md

@@ -0,0 +1,71 @@
+# @ohm_studio/sdk-react-native
+
+OHM Studio SDK for **React Native / Expo** — voice-to-structured-JSON clinical extraction inside your mobile app. Multi-language STT, FHIR-shaped outputs, formulary-aware prescriptions.
+
+> For web / Node, install [`@ohm_studio/sdk`](https://www.npmjs.com/package/@ohm_studio/sdk) instead.
+
+## Install
+
+```bash
+npm install @ohm_studio/sdk-react-native
+# or
+pnpm add @ohm_studio/sdk-react-native
+# or
+yarn add @ohm_studio/sdk-react-native
+```
+
+## Quickstart
+
+```ts
+import { OHM } from "@ohm_studio/sdk-react-native";
+
+// IMPORTANT: live keys (ohms_live_*) MUST NOT ship in your bundle.
+// Use ohms_test_* for local dev, or proxy through your backend.
+const ohm = new OHM({
+  apiKey: TEST_KEY,                          // ohms_test_*
+  baseUrl: "https://api.ohm.doctor",
+  acknowledgeBundledKey: true,                // dev-only override
+});
+
+// Audio → structured JSON in one call
+const { transcript, data } = await ohm.audio.extract({
+  apiSlug: "opd-clinic",
+  file: { uri: localUri, name: "rec.m4a", type: "audio/mp4" },
+});
+```
+
+## Capturing audio
+
+`@ohm_studio/sdk-react-native` doesn't ship a recorder — pair with whichever you prefer:
+
+| Library                              | Notes                                            |
+|--------------------------------------|--------------------------------------------------|
+| [`expo-av`](https://docs.expo.dev/versions/latest/sdk/av/) | Easiest in Expo apps. Returns a local URI.       |
+| [`react-native-audio-recorder-player`](https://www.npmjs.com/package/react-native-audio-recorder-player) | Bare RN. Configurable codec / bitrate.           |
+
+Whichever you use, pass the resulting `{ uri, name, type }` to `ohm.audio.extract`.
+
+## React hooks
+
+```tsx
+import { OHM } from "@ohm_studio/sdk-react-native";
+import { OhmProvider, useOhmAudioExtract } from "@ohm_studio/sdk-react-native/react";
+
+const ohm = new OHM({ apiKey: TEST_KEY, acknowledgeBundledKey: true });
+
+export default function App() {
+  return (
+    <OhmProvider client={ohm}>
+      <Recorder />
+    </OhmProvider>
+  );
+}
+```
+
+## Production: proxy your backend
+
+Don't ship live keys. Run a tiny proxy on your backend that holds the live key and forwards requests from your RN app (authenticated with your existing session token). Documented at [docs.ohm.doctor/security/rn-key-handling](https://docs.ohm.doctor/security/rn-key-handling).
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import { OHMCoreClient } from "@ohm_studio/sdk-core";
+import type { OHMClientOptions } from "@ohm_studio/sdk-core";
+export * from "@ohm_studio/sdk-core";
+/**
+ * OHM Studio SDK for React Native.
+ *
+ * Differs from `@ohm_studio/sdk` in two places:
+ *   1. Audio uploads use the React Native `FormData` shape:
+ *      `{ uri, name, type }` rather than a Blob/File.
+ *   2. Live keys (`ohms_live_*`) are blocked by default in RN bundles —
+ *      pass `acknowledgeBundledKey: true` only if you know what you're
+ *      doing. See: https://docs.ohm.doctor/security/rn-key-handling
+ *
+ * @example
+ *   const ohm = new OHM({
+ *     apiKey: TEST_KEY,                  // ohms_test_*
+ *     baseUrl: 'https://api.ohm.doctor',
+ *     acknowledgeBundledKey: true,        // dev-only override
+ *   });
+ *
+ *   const { transcript, data } = await ohm.audio.extract({
+ *     apiSlug: 'opd',
+ *     file: { uri: localUri, name: 'rec.m4a', type: 'audio/mp4' },
+ *   });
+ */
+export declare class OHM extends OHMCoreClient {
+    constructor(opts: OHMClientOptions);
+    protected runMultipart<T>(opts: {
+        path: string;
+        file: any;
+        fields?: Record<string, string>;
+    }): Promise<T>;
+}
+export default OHM;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAE7D,cAAc,sBAAsB,CAAC;AAYrC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,GAAI,SAAQ,aAAa;gBACxB,IAAI,EAAE,gBAAgB;cAclB,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE;QACpC,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,GAAG,CAAC;QACV,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACjC,GAAG,OAAO,CAAC,CAAC,CAAC;CA2Bf;AAED,eAAe,GAAG,CAAC"}

package/dist/index.js

@@ -0,0 +1,71 @@
+import { OHMConfigError, OHMCoreClient } from "@ohm_studio/sdk-core";
+export * from "@ohm_studio/sdk-core";
+/** Detect React Native runtime — used to gate the bundled-key safeguard. */
+function isReactNative() {
+    return (
+    // @ts-ignore — RN-only globals
+    typeof navigator !== "undefined" &&
+        // @ts-ignore
+        navigator.product === "ReactNative");
+}
+/**
+ * OHM Studio SDK for React Native.
+ *
+ * Differs from `@ohm_studio/sdk` in two places:
+ *   1. Audio uploads use the React Native `FormData` shape:
+ *      `{ uri, name, type }` rather than a Blob/File.
+ *   2. Live keys (`ohms_live_*`) are blocked by default in RN bundles —
+ *      pass `acknowledgeBundledKey: true` only if you know what you're
+ *      doing. See: https://docs.ohm.doctor/security/rn-key-handling
+ *
+ * @example
+ *   const ohm = new OHM({
+ *     apiKey: TEST_KEY,                  // ohms_test_*
+ *     baseUrl: 'https://api.ohm.doctor',
+ *     acknowledgeBundledKey: true,        // dev-only override
+ *   });
+ *
+ *   const { transcript, data } = await ohm.audio.extract({
+ *     apiSlug: 'opd',
+ *     file: { uri: localUri, name: 'rec.m4a', type: 'audio/mp4' },
+ *   });
+ */
+export class OHM extends OHMCoreClient {
+    constructor(opts) {
+        if (isReactNative() &&
+            opts.apiKey?.startsWith("ohms_live_") &&
+            !opts.acknowledgeBundledKey) {
+            throw new OHMConfigError({
+                message: "Live OHM keys (ohms_live_*) must NOT ship in React Native bundles — anyone can decompile your app and steal them. Use ohms_test_* for local dev, or set up a backend proxy. See https://docs.ohm.doctor/security/rn-key-handling",
+            });
+        }
+        super(opts);
+    }
+    async runMultipart(opts) {
+        const fd = new FormData();
+        if (opts.file &&
+            typeof opts.file === "object" &&
+            "uri" in opts.file) {
+            // RN FormData accepts this shape directly.
+            // @ts-ignore — RN's FormData type isn't standard.
+            fd.append("file", {
+                uri: opts.file.uri,
+                name: opts.file.name || "audio.m4a",
+                type: opts.file.type || "audio/mp4",
+            });
+        }
+        else if (typeof Blob !== "undefined" && opts.file instanceof Blob) {
+            // Some RN polyfills support Blob.
+            fd.append("file", opts.file, "audio.bin");
+        }
+        else {
+            throw new Error("Unsupported file input on React Native — pass `{ uri, name, type }`");
+        }
+        for (const [k, v] of Object.entries(opts.fields || {})) {
+            fd.append(k, v);
+        }
+        return this.requestRaw("POST", opts.path, { body: fd });
+    }
+}
+export default OHM;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAGrE,cAAc,sBAAsB,CAAC;AAErC,4EAA4E;AAC5E,SAAS,aAAa;IACpB,OAAO;IACL,+BAA+B;IAC/B,OAAO,SAAS,KAAK,WAAW;QAChC,aAAa;QACb,SAAS,CAAC,OAAO,KAAK,aAAa,CACpC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,GAAI,SAAQ,aAAa;IACpC,YAAY,IAAsB;QAChC,IACE,aAAa,EAAE;YACf,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,YAAY,CAAC;YACrC,CAAC,IAAI,CAAC,qBAAqB,EAC3B,CAAC;YACD,MAAM,IAAI,cAAc,CAAC;gBACvB,OAAO,EACL,kOAAkO;aACrO,CAAC,CAAC;QACL,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAES,KAAK,CAAC,YAAY,CAAI,IAI/B;QACC,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC1B,IACE,IAAI,CAAC,IAAI;YACT,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ;YAC7B,KAAK,IAAI,IAAI,CAAC,IAAI,EAClB,CAAC;YACD,2CAA2C;YAC3C,kDAAkD;YAClD,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE;gBAChB,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG;gBAClB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,WAAW;gBACnC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,WAAW;aACpC,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,OAAO,IAAI,KAAK,WAAW,IAAI,IAAI,CAAC,IAAI,YAAY,IAAI,EAAE,CAAC;YACpE,kCAAkC;YAClC,EAAE,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAW,EAAE,WAAW,CAAC,CAAC;QACnD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CACb,qEAAqE,CACtE,CAAC;QACJ,CAAC;QACD,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,CAAC;YACvD,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClB,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAI,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,EAAS,EAAE,CAAC,CAAC;IACpE,CAAC;CACF;AAED,eAAe,GAAG,CAAC"}

package/dist/react/index.d.ts

@@ -0,0 +1,36 @@
+import { type ReactNode } from "react";
+import type { AudioExtractInput, AudioExtractResult, ExtractInput, ExtractResult, SummarizeInput, SummarizeResult } from "@ohm_studio/sdk-core";
+import { OHM } from "../index";
+export declare function OhmProvider({ client, children, }: {
+    client: OHM;
+    children: ReactNode;
+}): import("react").FunctionComponentElement<import("react").ProviderProps<OHM | null>>;
+export declare function useOhmExtract<T = Record<string, unknown>>(opts: {
+    apiSlug: string;
+}): {
+    mutateAsync: (input: Omit<ExtractInput, "apiSlug">) => Promise<ExtractResult<T>>;
+    mutate: (input: Omit<ExtractInput, "apiSlug">) => void;
+    reset: () => void;
+    data: ExtractResult<T> | null;
+    error: Error | null;
+    isPending: boolean;
+};
+export declare function useOhmAudioExtract<T = Record<string, unknown>>(opts: {
+    apiSlug: string;
+}): {
+    mutateAsync: (input: Omit<AudioExtractInput, "apiSlug">) => Promise<AudioExtractResult<T>>;
+    mutate: (input: Omit<AudioExtractInput, "apiSlug">) => void;
+    reset: () => void;
+    data: AudioExtractResult<T> | null;
+    error: Error | null;
+    isPending: boolean;
+};
+export declare function useOhmSummarize(): {
+    mutateAsync: (input: SummarizeInput) => Promise<SummarizeResult>;
+    mutate: (input: SummarizeInput) => void;
+    reset: () => void;
+    data: SummarizeResult | null;
+    error: Error | null;
+    isPending: boolean;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/react/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EACV,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAa/B,wBAAgB,WAAW,CAAC,EAC1B,MAAM,EACN,QAAQ,GACT,EAAE;IACD,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,SAAS,CAAC;CACrB,uFAEA;AAoDD,wBAAgB,aAAa,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE;IAC/D,OAAO,EAAE,MAAM,CAAC;CACjB;;;;;WAxCQ,KAAK,GAAG,IAAI;eACR,OAAO;EA4CnB;AAED,wBAAgB,kBAAkB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,EAAE;IACpE,OAAO,EAAE,MAAM,CAAC;CACjB;;;;;WAjDQ,KAAK,GAAG,IAAI;eACR,OAAO;EAqDnB;AAED,wBAAgB,eAAe;;;;;WAxDtB,KAAK,GAAG,IAAI;eACR,OAAO;EA2DnB"}

package/dist/react/index.js

@@ -0,0 +1,58 @@
+import { createContext, createElement, useCallback, useContext, useState, } from "react";
+/**
+ * React hooks for @ohm_studio/sdk. Mirrors `@ohm_studio/sdk-react-native/react` so a
+ * snippet copies cleanly between web and mobile codebases.
+ *
+ * The hooks are thin and DEPENDENCY-FREE — no TanStack Query required.
+ * If you'd rather use Query, the underlying `client.extract` /
+ * `client.audio.extract` calls slot into `useMutation` directly.
+ */
+const OhmContext = createContext(null);
+export function OhmProvider({ client, children, }) {
+    return createElement(OhmContext.Provider, { value: client }, children);
+}
+function useClient() {
+    const c = useContext(OhmContext);
+    if (!c) {
+        throw new Error("useOhm hooks must be wrapped in <OhmProvider client={ohm}>");
+    }
+    return c;
+}
+function useOhmMutation(fn) {
+    const client = useClient();
+    const [state, setState] = useState({
+        data: null,
+        error: null,
+        isPending: false,
+    });
+    const mutateAsync = useCallback(async (input) => {
+        setState({ data: null, error: null, isPending: true });
+        try {
+            const data = await fn(client, input);
+            setState({ data, error: null, isPending: false });
+            return data;
+        }
+        catch (err) {
+            setState({ data: null, error: err, isPending: false });
+            throw err;
+        }
+    }, [client, fn]);
+    return {
+        ...state,
+        mutateAsync,
+        mutate: (input) => {
+            void mutateAsync(input);
+        },
+        reset: () => setState({ data: null, error: null, isPending: false }),
+    };
+}
+export function useOhmExtract(opts) {
+    return useOhmMutation((c, input) => c.extract({ ...input, apiSlug: opts.apiSlug }));
+}
+export function useOhmAudioExtract(opts) {
+    return useOhmMutation((c, input) => c.audio.extract({ ...input, apiSlug: opts.apiSlug }));
+}
+export function useOhmSummarize() {
+    return useOhmMutation((c, input) => c.summarize(input));
+}
+//# sourceMappingURL=index.js.map

package/dist/react/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/react/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,aAAa,EACb,WAAW,EACX,UAAU,EACV,QAAQ,GAET,MAAM,OAAO,CAAC;AAWf;;;;;;;GAOG;AAEH,MAAM,UAAU,GAAG,aAAa,CAAa,IAAI,CAAC,CAAC;AAEnD,MAAM,UAAU,WAAW,CAAC,EAC1B,MAAM,EACN,QAAQ,GAIT;IACC,OAAO,aAAa,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,QAAQ,CAAC,CAAC;AACzE,CAAC;AAED,SAAS,SAAS;IAChB,MAAM,CAAC,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;IACjC,IAAI,CAAC,CAAC,EAAE,CAAC;QACP,MAAM,IAAI,KAAK,CACb,4DAA4D,CAC7D,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAQD,SAAS,cAAc,CACrB,EAAoD;IAEpD,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAyB;QACzD,IAAI,EAAE,IAAI;QACV,KAAK,EAAE,IAAI;QACX,SAAS,EAAE,KAAK;KACjB,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,WAAW,CAC7B,KAAK,EAAE,KAAa,EAAE,EAAE;QACtB,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YACrC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YAClD,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;YACvD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC,EACD,CAAC,MAAM,EAAE,EAAE,CAAC,CACb,CAAC;IACF,OAAO;QACL,GAAG,KAAK;QACR,WAAW;QACX,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE;YACxB,KAAK,WAAW,CAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;QACD,KAAK,EAAE,GAAG,EAAE,CACV,QAAQ,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;KAC1D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAA8B,IAE1D;IACC,OAAO,cAAc,CAGnB,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAI,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,kBAAkB,CAA8B,IAE/D;IACC,OAAO,cAAc,CAGnB,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAI,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,eAAe;IAC7B,OAAO,cAAc,CAAkC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAClE,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CACnB,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@ohm_studio/sdk-react-native",
+  "version": "0.1.0",
+  "description": "OHM Studio SDK for React Native. Voice-to-structured-JSON clinical extraction APIs in your mobile app.",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "react-native": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "ohm",
+    "react-native",
+    "expo",
+    "clinical",
+    "ehr",
+    "fhir",
+    "stt",
+    "extraction"
+  ],
+  "homepage": "https://docs.ohm.doctor",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aivfkesavan/OHM_Products",
+    "directory": "packages/sdk-react-native"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@ohm_studio/sdk-core": "0.1.0"
+  },
+  "peerDependencies": {
+    "react": ">=17",
+    "react-native": ">=0.71"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-native": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/react": "^18.3.23",
+    "react": "^18.3.1",
+    "typescript": "^5.8.3"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}