@sorisdk/web-audio 0.1.0 → 0.1.2

package/LICENSE.md

@@ -0,0 +1,50 @@
+Software Use License Agreement
+
+Copyright (c) iPlateia Inc. All rights reserved.
+
+This Software Use License Agreement ("Agreement") is a binding agreement between iPlateia Inc. ("Company") and the person or entity that installs, accesses, or uses this package ("Licensee").
+
+By installing, copying, accessing, or using the package, Licensee agrees to be bound by this Agreement. If Licensee does not agree, Licensee must not install, access, or use the package.
+
+1. Grant of License
+
+Subject to Licensee's full compliance with this Agreement, the Company grants Licensee a limited, non-exclusive, non-transferable, non-sublicensable, revocable license to use the package in object code or compiled form solely for Licensee's internal business use or other use expressly authorized by the Company.
+
+2. Restrictions
+
+Licensee must not, and must not permit any third party to:
+
+- modify, adapt, translate, alter, or create derivative works of the package;
+- reverse engineer, decompile, disassemble, decode, or otherwise attempt to derive the source code, underlying ideas, algorithms, file formats, or trade secrets of the package, except to the limited extent such restriction is prohibited by mandatory law;
+- copy, publish, distribute, transmit, disclose, sublicense, assign, sell, rent, lease, lend, transfer, pledge, or otherwise make the package available to any third party;
+- remove, obscure, or alter any copyright, trademark, confidentiality, or proprietary notice contained in the package;
+- use the package in violation of applicable law, public policy, or the Company's usage conditions;
+- use the package to disclose survey content, logs, technical information, or other service-related information to any third party.
+
+3. Ownership and Reservation of Rights
+
+The package is licensed, not sold. The package, including all intellectual property rights in and to the package, remains the exclusive property of the Company and its licensors. No rights are granted except as expressly stated in this Agreement.
+
+4. Confidentiality
+
+Any non-public information obtained through access to or use of the package, including technical materials, performance information, documentation, data formats, and service-related content, is confidential. Licensee must keep such information strictly confidential and must not disclose it to any third party without the Company's prior written consent.
+
+5. Changes, Suspension, and Termination
+
+The Company may modify, suspend, restrict, or discontinue all or part of the package at any time if reasonably required for operational, technical, security, or business reasons. If Licensee breaches this Agreement, the Company may immediately suspend or terminate this Agreement and Licensee's right to use the package. Upon termination, Licensee must immediately stop using the package and delete all copies in Licensee's possession or control.
+
+6. Disclaimer
+
+To the maximum extent permitted by law, the package is provided on an "as is" and "as available" basis without warranties of any kind, whether express, implied, statutory, or otherwise, including any implied warranties of merchantability, fitness for a particular purpose, title, non-infringement, accuracy, availability, or uninterrupted operation.
+
+7. Limitation of Liability
+
+To the maximum extent permitted by law, the Company will not be liable for any indirect, incidental, special, consequential, exemplary, or punitive damages, or for any loss of profits, revenues, business, goodwill, data, or use, arising out of or related to this Agreement or the package, even if advised of the possibility of such damages.
+
+8. Governing Law
+
+This Agreement is governed by the laws of the Republic of Korea, without regard to conflict of laws principles.
+
+9. Entire Agreement
+
+This Agreement constitutes the entire agreement between Licensee and the Company regarding the package and supersedes all prior or contemporaneous understandings relating to the package.

package/README.md

@@ -1,98 +1,83 @@
 # @sorisdk/web-audio
 
-Browser microphone capture and real-time matching SDK for NADA.
+Web SDK for integrating SORI audio recognition into browser-based services.
 
-## Purpose
+This package provides the browser-side flow needed for web recognition, including authentication bootstrap, pack caching, microphone input, audio fingerprint generation, matching, and campaign events.
 
-This package owns browser-only concerns that do not belong in `@sorisdk/matcher`:
+Public integration guide: https://docs.soriapi.com/ko/integration/web
 
-- microphone permission and `getUserMedia`
-- Web Audio graph setup
-- PCM chunk capture
-- rolling fingerprint generation with `@sorisdk/afpgen`
-- rolling query matching with `@sorisdk/matcher`
+## Requirements
 
-## API
+- A secure context such as `https://` or `http://localhost`
+- A modern browser with `AudioContext` and `MediaDevices.getUserMedia()`
+- An ephemeral key issued by your server
+- Microphone permission granted by the user
 
-```ts
-import { AudioRecognizer } from "@sorisdk/web-audio";
-
-const recognizer = new AudioRecognizer({
-  appId: "app-1",
-  ephemeralKeyEndpoint: "https://site.example.com/api/ephemeral-key"
-});
-
-recognizer.on("campaign", (event) => {
-  console.log(event.campaign);
-});
+## Installation
 
-await recognizer.start();
-await recognizer.stop();
-await recognizer.destroy();
+```bash
+npm install @sorisdk/web-audio
 ```
 
-By default, `AudioRecognizer` uses the SORI API prefix `https://console.soriapi.com/api`
-and derives:
-
-- auth: `/auth`
-- activity: `/activity/`
-
-So direct ephemeral key usage can be as small as:
+Vite-based apps need `vite-plugin-wasm`.
 
 ```ts
-const recognizer = new AudioRecognizer({
-  appId: "app-1",
-  ephemeralKey: "ek-..."
-});
-```
+import wasm from "vite-plugin-wasm";
 
-## Notes
+export default {
+  plugins: [wasm()]
+};
+```
 
-- This package is browser-only.
-- It uses `AudioWorkletNode` when available and falls back to `ScriptProcessorNode`.
-- Matching window size and matching-quality-sensitive runtime tuning stay internal to the SDK.
+## Minimal example
 
-## Session Utility
+```ts
+import { AudioRecognizer } from "@sorisdk/web-audio";
 
-When you need direct control over the browser session identifier, use the built-in
-session manager instead of handling `localStorage` yourself:
+const recognizer = new AudioRecognizer({
+  appId: "YOUR_APP_ID",
+  ephemeralKey: async () => {
+    const response = await fetch("/api/ephemeral-key", {
+      method: "POST"
+    });
+
+    if (!response.ok) {
+      throw new Error(`Ephemeral key request failed: HTTP ${response.status}`);
+    }
+
+    const { ephemeral_key } = await response.json();
+    return ephemeral_key;
+  }
+});
 
-```ts
-import { createLocalStorageSessionManager } from "@sorisdk/web-audio";
+recognizer.on("campaign", (event) => {
+  console.log(event.campaign);
+});
 
-const sessions = createLocalStorageSessionManager({
-  key: "sorisdk:web-audio:session:app-1"
+recognizer.on("error", ({ error }) => {
+  console.error(error);
 });
 
-const sessionId = sessions.getSessionId();
+await recognizer.start();
 ```
 
-## Low-Level Auth Cache Helper
-
-When `/api/auth` requires a `v` value, the browser package can keep the last successful
-`version + packUrl` metadata in `localStorage` while leaving the actual audiopack bytes to
-the browser HTTP cache:
+Call `stop()` or `destroy()` when recognition should end or when the page is being cleaned up.
 
 ```ts
-import {
-  authenticateAndLoadAudioPack,
-  createLocalStorageAudioPackStore
-} from "@sorisdk/web-audio";
+await recognizer.stop();
+await recognizer.destroy();
+```
 
-const store = createLocalStorageAudioPackStore({
-  key: "sorisdk:matcher:app-1"
-});
+## Integration flow
 
-const result = await authenticateAndLoadAudioPack({
-  loader: microphoneMatcher,
-  auth: {
-    endpoint: "https://console.example.com/api/auth",
-    appId: "app-1",
-    ephemeralKey: "ek-...",
-    sessionId: "browser-device-1"
-  },
-  store
-});
+1. Prepare your `appId` and ephemeral key flow.
+2. Create an `AudioRecognizer`.
+3. Subscribe to the events you need, such as `campaign`, `match`, and `error`.
+4. Call `start()` to begin recognition.
+5. Call `stop()` or `destroy()` when leaving the page or stopping capture.
 
-console.log(result.token, result.loadedPackUrl, result.persistedVersion);
-```
+## Recommendations
+
+- Do not hardcode ephemeral keys in the browser. Issue them from your server.
+- Show clear UI while the microphone is active.
+- Use the public documentation for full setup details and caveats.

package/dist/generated/window_bg.js

@@ -51,11 +51,11 @@ export class WasmFingerprintMatchWindow {
     }
 }
 if (Symbol.dispose) WasmFingerprintMatchWindow.prototype[Symbol.dispose] = WasmFingerprintMatchWindow.prototype.free;
-export function __wbg_Error_83742b46f01ce22d(arg0, arg1) {
+export function __wbg_Error_2e59b1b37a9a34c3(arg0, arg1) {
     const ret = Error(getStringFromWasm0(arg0, arg1));
     return ret;
 }
-export function __wbg_Number_a5a435bd7bbec835(arg0) {
+export function __wbg_Number_e6ffdb596c888833(arg0) {
     const ret = Number(arg0);
     return ret;
 }
@@ -66,46 +66,46 @@ export function __wbg_String_8564e559799eccda(arg0, arg1) {
     getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
     getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
 }
-export function __wbg___wbindgen_boolean_get_c0f3f60bac5a78d1(arg0) {
+export function __wbg___wbindgen_boolean_get_a86c216575a75c30(arg0) {
     const v = arg0;
     const ret = typeof(v) === 'boolean' ? v : undefined;
     return isLikeNone(ret) ? 0xFFFFFF : ret ? 1 : 0;
 }
-export function __wbg___wbindgen_debug_string_5398f5bb970e0daa(arg0, arg1) {
+export function __wbg___wbindgen_debug_string_dd5d2d07ce9e6c57(arg0, arg1) {
     const ret = debugString(arg1);
     const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len1 = WASM_VECTOR_LEN;
     getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
     getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
 }
-export function __wbg___wbindgen_in_41dbb8413020e076(arg0, arg1) {
+export function __wbg___wbindgen_in_4bd7a57e54337366(arg0, arg1) {
     const ret = arg0 in arg1;
     return ret;
 }
-export function __wbg___wbindgen_is_null_0b605fc6b167c56f(arg0) {
+export function __wbg___wbindgen_is_null_344c8750a8525473(arg0) {
     const ret = arg0 === null;
     return ret;
 }
-export function __wbg___wbindgen_is_object_781bc9f159099513(arg0) {
+export function __wbg___wbindgen_is_object_40c5a80572e8f9d3(arg0) {
     const val = arg0;
     const ret = typeof(val) === 'object' && val !== null;
     return ret;
 }
-export function __wbg___wbindgen_is_undefined_52709e72fb9f179c(arg0) {
+export function __wbg___wbindgen_is_undefined_c0cca72b82b86f4d(arg0) {
     const ret = arg0 === undefined;
     return ret;
 }
-export function __wbg___wbindgen_jsval_loose_eq_5bcc3bed3c69e72b(arg0, arg1) {
+export function __wbg___wbindgen_jsval_loose_eq_3a72ae764d46d944(arg0, arg1) {
     const ret = arg0 == arg1;
     return ret;
 }
-export function __wbg___wbindgen_number_get_34bb9d9dcfa21373(arg0, arg1) {
+export function __wbg___wbindgen_number_get_7579aab02a8a620c(arg0, arg1) {
     const obj = arg1;
     const ret = typeof(obj) === 'number' ? obj : undefined;
     getDataViewMemory0().setFloat64(arg0 + 8 * 1, isLikeNone(ret) ? 0 : ret, true);
     getDataViewMemory0().setInt32(arg0 + 4 * 0, !isLikeNone(ret), true);
 }
-export function __wbg___wbindgen_string_get_395e606bd0ee4427(arg0, arg1) {
+export function __wbg___wbindgen_string_get_914df97fcfa788f2(arg0, arg1) {
     const obj = arg1;
     const ret = typeof(obj) === 'string' ? obj : undefined;
     var ptr1 = isLikeNone(ret) ? 0 : passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
@@ -113,14 +113,14 @@ export function __wbg___wbindgen_string_get_395e606bd0ee4427(arg0, arg1) {
     getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
     getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
 }
-export function __wbg___wbindgen_throw_6ddd609b62940d55(arg0, arg1) {
+export function __wbg___wbindgen_throw_81fc77679af83bc6(arg0, arg1) {
     throw new Error(getStringFromWasm0(arg0, arg1));
 }
 export function __wbg_get_with_ref_key_6412cf3094599694(arg0, arg1) {
     const ret = arg0[arg1];
     return ret;
 }
-export function __wbg_instanceof_ArrayBuffer_101e2bf31071a9f6(arg0) {
+export function __wbg_instanceof_ArrayBuffer_ff7c1337a5e3b33a(arg0) {
     let result;
     try {
         result = arg0 instanceof ArrayBuffer;
@@ -130,7 +130,7 @@ export function __wbg_instanceof_ArrayBuffer_101e2bf31071a9f6(arg0) {
     const ret = result;
     return ret;
 }
-export function __wbg_instanceof_Uint8Array_740438561a5b956d(arg0) {
+export function __wbg_instanceof_Uint8Array_4b8da683deb25d72(arg0) {
     let result;
     try {
         result = arg0 instanceof Uint8Array;
@@ -140,23 +140,23 @@ export function __wbg_instanceof_Uint8Array_740438561a5b956d(arg0) {
     const ret = result;
     return ret;
 }
-export function __wbg_isSafeInteger_ecd6a7f9c3e053cd(arg0) {
+export function __wbg_isSafeInteger_ea83862ba994770c(arg0) {
     const ret = Number.isSafeInteger(arg0);
     return ret;
 }
-export function __wbg_length_ea16607d7b61445b(arg0) {
+export function __wbg_length_0c32cb8543c8e4c8(arg0) {
     const ret = arg0.length;
     return ret;
 }
-export function __wbg_new_5f486cdf45a04d78(arg0) {
+export function __wbg_new_a560378ea1240b14(arg0) {
     const ret = new Uint8Array(arg0);
     return ret;
 }
-export function __wbg_new_from_slice_22da9388ac046e50(arg0, arg1) {
+export function __wbg_new_from_slice_2580ff33d0d10520(arg0, arg1) {
     const ret = new Uint8Array(getArrayU8FromWasm0(arg0, arg1));
     return ret;
 }
-export function __wbg_prototypesetcall_d62e5099504357e6(arg0, arg1, arg2) {
+export function __wbg_prototypesetcall_3e05eb9545565046(arg0, arg1, arg2) {
     Uint8Array.prototype.set.call(getArrayU8FromWasm0(arg0, arg1), arg2);
 }
 export function __wbindgen_cast_0000000000000001(arg0, arg1) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sorisdk/web-audio",
-  "version": "0.1.0",
-  "description": "Browser microphone capture and real-time matching SDK for NADA",
+  "version": "0.1.2",
+  "description": "Web SDK for browser-based audio recognition with SORI API",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -31,19 +31,11 @@
     "matcher"
   ],
   "author": "comfuture",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/iplateia/nada.git",
-    "directory": "packages/web-audio"
-  },
-  "homepage": "https://github.com/iplateia/nada/tree/main/packages/web-audio",
-  "bugs": {
-    "url": "https://github.com/iplateia/nada/issues"
-  },
+  "license": "SEE LICENSE IN LICENSE.md",
+  "homepage": "https://docs.soriapi.com/ko/integration/web",
   "dependencies": {
-    "@sorisdk/afpgen": "0.1.0",
-    "@sorisdk/matcher": "0.1.0"
+    "@sorisdk/afpgen": "0.1.2",
+    "@sorisdk/matcher": "0.1.2"
   },
   "devDependencies": {
     "tsup": "^8.5.1",