phonic 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Phonic, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,99 @@
 # Phonic Node.js SDK
 
-Coming soon, stay tuned!
+Node.js library for the Phonic API.
+
+- [Installation](#installation)
+- [Setup](#setup)
+- [Usage](#usage)
+  - [Get voices](#get-voices)
+  - [Get voice by id](#get-voice-by-id)
+  - [Text-to-speech via WebSocket](#text-to-speech-via-websocket)
+
+## Installation
+
+```bash
+npm i phonic
+```
+
+## Setup
+
+Grab an API key from [Phonic settings](https://phonic.co/settings) and pass it to the Phonic constructor.
+
+```js
+import { Phonic } from "phonic";
+
+const phonic = new Phonic("ph_...");
+```
+
+## Usage
+
+### Get voices
+
+```js
+const { data, error } = await phonic.voices.list();
+
+if (error === null) {
+  console.log(data.voices);
+}
+```
+
+
+### Get voice by id
+
+```js
+const { data, error } = await phonic.voices.get("australian-man");
+
+if (error === null) {
+  console.log(data.voice);
+}
+```
+
+### Text-to-speech via WebSocket
+
+```js
+const { data, error } = await phonic.tts.websocket();
+
+if (error === null) {
+  const { phonicWebSocket } = data;
+  const stream = phonicWebSocket.send({
+    type: "generate",
+    script: "How can I help you today?", // 600 characters max
+    output_format: "mulaw_8000", // or "pcm_44100"
+  });
+
+  for await (const data of stream) {
+    if (data instanceof Buffer) {
+      // Do something with the audio chunk,
+      // e.g. send `data.toString("base64")` to Twilio.
+    }
+  }
+
+  phonicWebSocket.close();
+}
+```
+
+To perform other work while receiving chunks, use:
+
+```js
+phonicWebSocket.onMessage((data) => {
+  if (data instanceof Buffer) {
+    // Do something with the audio chunk,
+    // e.g. send `data.toString("base64")` to Twilio.
+  }
+});
+
+phonicWebSocket.send({
+  type: "generate",
+  script: "How can I help you today?",
+  output_format: "mulaw_8000",
+});
+
+// Perform other work here
+
+await phonicWebSocket.streamEnded; // This Promise will be resolved once the last chunk is received
+```
+
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,91 @@
+import WebSocket from 'ws';
+
+type PhonicConfigBaseUrl = `http://${string}` | `https://${string}`;
+type PhonicConfig = {
+    baseUrl?: PhonicConfigBaseUrl;
+};
+type FetchOptions = {
+    method: "GET";
+};
+type ErrorResponse = {
+    message: string;
+    code?: string;
+};
+type DataOrError<T> = Promise<{
+    data: T;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+}>;
+
+type PhonicWebSocketMessage = {
+    type: "generate";
+    script: string;
+    output_format: "pcm_44100" | "mulaw_8000";
+};
+type PhonicWebSocketResponseMessage = {
+    type: "stream-ended";
+    error?: {
+        message: string;
+        code?: string;
+    };
+};
+type OnMessageCallback = (data: PhonicWebSocketResponseMessage | Buffer) => void;
+
+declare class PhonicWebSocket {
+    private readonly ws;
+    private onMessageCallback;
+    private streamEndedResolve;
+    readonly streamEnded: Promise<void>;
+    private streamController;
+    constructor(ws: WebSocket);
+    onMessage(callback: OnMessageCallback): void;
+    send(message: PhonicWebSocketMessage): ReadableStream<any>;
+    close(): void;
+}
+
+declare class TextToSpeech {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    websocket(): DataOrError<{
+        phonicWebSocket: PhonicWebSocket;
+    }>;
+}
+
+type Voice = {
+    id: string;
+    name: string;
+};
+type VoicesSuccessResponse = {
+    voices: Array<Voice>;
+};
+type VoiceSuccessResponse = {
+    voice: Voice;
+};
+
+declare class Voices {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    list(): DataOrError<VoicesSuccessResponse>;
+    get(id: string): DataOrError<VoiceSuccessResponse>;
+}
+
+declare class Phonic {
+    readonly apiKey: string;
+    readonly baseUrl: string;
+    private readonly headers;
+    readonly voices: Voices;
+    readonly tts: TextToSpeech;
+    constructor(apiKey: string, config?: PhonicConfig);
+    fetchRequest<T>(path: string, options: FetchOptions): DataOrError<T>;
+    get<T>(path: string): Promise<{
+        data: null;
+        error: ErrorResponse;
+    } | {
+        data: T;
+        error: null;
+    }>;
+}
+
+export { Phonic };

package/dist/index.d.ts

@@ -0,0 +1,91 @@
+import WebSocket from 'ws';
+
+type PhonicConfigBaseUrl = `http://${string}` | `https://${string}`;
+type PhonicConfig = {
+    baseUrl?: PhonicConfigBaseUrl;
+};
+type FetchOptions = {
+    method: "GET";
+};
+type ErrorResponse = {
+    message: string;
+    code?: string;
+};
+type DataOrError<T> = Promise<{
+    data: T;
+    error: null;
+} | {
+    data: null;
+    error: ErrorResponse;
+}>;
+
+type PhonicWebSocketMessage = {
+    type: "generate";
+    script: string;
+    output_format: "pcm_44100" | "mulaw_8000";
+};
+type PhonicWebSocketResponseMessage = {
+    type: "stream-ended";
+    error?: {
+        message: string;
+        code?: string;
+    };
+};
+type OnMessageCallback = (data: PhonicWebSocketResponseMessage | Buffer) => void;
+
+declare class PhonicWebSocket {
+    private readonly ws;
+    private onMessageCallback;
+    private streamEndedResolve;
+    readonly streamEnded: Promise<void>;
+    private streamController;
+    constructor(ws: WebSocket);
+    onMessage(callback: OnMessageCallback): void;
+    send(message: PhonicWebSocketMessage): ReadableStream<any>;
+    close(): void;
+}
+
+declare class TextToSpeech {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    websocket(): DataOrError<{
+        phonicWebSocket: PhonicWebSocket;
+    }>;
+}
+
+type Voice = {
+    id: string;
+    name: string;
+};
+type VoicesSuccessResponse = {
+    voices: Array<Voice>;
+};
+type VoiceSuccessResponse = {
+    voice: Voice;
+};
+
+declare class Voices {
+    private readonly phonic;
+    constructor(phonic: Phonic);
+    list(): DataOrError<VoicesSuccessResponse>;
+    get(id: string): DataOrError<VoiceSuccessResponse>;
+}
+
+declare class Phonic {
+    readonly apiKey: string;
+    readonly baseUrl: string;
+    private readonly headers;
+    readonly voices: Voices;
+    readonly tts: TextToSpeech;
+    constructor(apiKey: string, config?: PhonicConfig);
+    fetchRequest<T>(path: string, options: FetchOptions): DataOrError<T>;
+    get<T>(path: string): Promise<{
+        data: null;
+        error: ErrorResponse;
+    } | {
+        data: T;
+        error: null;
+    }>;
+}
+
+export { Phonic };

package/dist/index.js

@@ -0,0 +1,198 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Phonic: () => Phonic
+});
+module.exports = __toCommonJS(src_exports);
+
+// package.json
+var version = "0.1.0";
+
+// src/tts/index.ts
+var import_ws = __toESM(require("ws"));
+
+// src/tts/websocket.ts
+var PhonicWebSocket = class {
+  constructor(ws) {
+    this.ws = ws;
+    this.ws.onmessage = (event) => {
+      if (typeof event.data === "string") {
+        const dataObj = JSON.parse(
+          event.data
+        );
+        this.onMessageCallback?.(dataObj);
+        if (dataObj.type === "stream-ended") {
+          this.streamEndedResolve();
+          this.streamController?.close();
+        } else {
+          this.streamController?.enqueue(dataObj);
+        }
+      } else if (event.data instanceof Buffer) {
+        this.onMessageCallback?.(event.data);
+        this.streamController?.enqueue(event.data);
+      }
+    };
+  }
+  onMessageCallback = null;
+  streamEndedResolve = () => {
+  };
+  streamEnded = new Promise((resolve) => {
+    this.streamEndedResolve = resolve;
+  });
+  streamController = null;
+  onMessage(callback) {
+    this.onMessageCallback = callback;
+  }
+  send(message) {
+    const self = this;
+    self.streamController?.close();
+    this.ws.send(JSON.stringify(message));
+    return new ReadableStream({
+      start(controller) {
+        self.streamController = controller;
+      }
+    });
+  }
+  close() {
+    this.ws.close();
+  }
+};
+
+// src/tts/index.ts
+var TextToSpeech = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  async websocket() {
+    return new Promise((resolve) => {
+      const wsBaseUrl = this.phonic.baseUrl.replace(/^http/, "ws");
+      const ws = new import_ws.default(`${wsBaseUrl}/v1/generate/audio/ws`, {
+        headers: {
+          Authorization: `Bearer ${this.phonic.apiKey}`
+        }
+      });
+      ws.onopen = () => {
+        const phonicWebSocket = new PhonicWebSocket(ws);
+        resolve({ data: { phonicWebSocket }, error: null });
+      };
+      ws.onerror = (error) => {
+        resolve({
+          data: null,
+          error: {
+            message: error.message
+          }
+        });
+      };
+    });
+  }
+};
+
+// src/voices/index.ts
+var Voices = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  async list() {
+    const response = await this.phonic.get("/voices");
+    return response;
+  }
+  async get(id) {
+    const response = await this.phonic.get(
+      `/voices/${id}`
+    );
+    return response;
+  }
+};
+
+// src/phonic.ts
+var defaultBaseUrl = "https://api.phonic.co";
+var defaultUserAgent = `phonic-node:${version}`;
+var Phonic = class {
+  constructor(apiKey, config) {
+    this.apiKey = apiKey;
+    if (typeof process === "undefined") {
+      throw new Error(
+        "Phonic SDK is intended to be used in Node.js environment."
+      );
+    }
+    if (!this.apiKey) {
+      throw new Error(
+        'API key is missing. Pass it to the constructor: `new Phonic("ph_...")`'
+      );
+    }
+    this.baseUrl = config?.baseUrl ?? defaultBaseUrl;
+    this.headers = new Headers({
+      Authorization: `Bearer ${this.apiKey}`,
+      "User-Agent": process.env.PHONIC_USER_AGENT || defaultUserAgent,
+      "Content-Type": "application/json"
+    });
+  }
+  baseUrl;
+  headers;
+  voices = new Voices(this);
+  tts = new TextToSpeech(this);
+  async fetchRequest(path, options) {
+    try {
+      const response = await fetch(`${this.baseUrl}/v1${path}`, {
+        headers: this.headers,
+        ...options
+      });
+      if (!response.ok) {
+        const statusText = await response.text();
+        console.error(response);
+        return {
+          data: null,
+          error: {
+            message: statusText
+          }
+        };
+      }
+      const data = await response.json();
+      return { data, error: null };
+    } catch (error) {
+      console.error(error);
+      return {
+        data: null,
+        error: {
+          message: "Fetch request failed"
+        }
+      };
+    }
+  }
+  async get(path) {
+    return this.fetchRequest(path, { method: "GET" });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Phonic
+});

package/dist/index.mjs

@@ -0,0 +1,161 @@
+// package.json
+var version = "0.1.0";
+
+// src/tts/index.ts
+import WebSocket from "ws";
+
+// src/tts/websocket.ts
+var PhonicWebSocket = class {
+  constructor(ws) {
+    this.ws = ws;
+    this.ws.onmessage = (event) => {
+      if (typeof event.data === "string") {
+        const dataObj = JSON.parse(
+          event.data
+        );
+        this.onMessageCallback?.(dataObj);
+        if (dataObj.type === "stream-ended") {
+          this.streamEndedResolve();
+          this.streamController?.close();
+        } else {
+          this.streamController?.enqueue(dataObj);
+        }
+      } else if (event.data instanceof Buffer) {
+        this.onMessageCallback?.(event.data);
+        this.streamController?.enqueue(event.data);
+      }
+    };
+  }
+  onMessageCallback = null;
+  streamEndedResolve = () => {
+  };
+  streamEnded = new Promise((resolve) => {
+    this.streamEndedResolve = resolve;
+  });
+  streamController = null;
+  onMessage(callback) {
+    this.onMessageCallback = callback;
+  }
+  send(message) {
+    const self = this;
+    self.streamController?.close();
+    this.ws.send(JSON.stringify(message));
+    return new ReadableStream({
+      start(controller) {
+        self.streamController = controller;
+      }
+    });
+  }
+  close() {
+    this.ws.close();
+  }
+};
+
+// src/tts/index.ts
+var TextToSpeech = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  async websocket() {
+    return new Promise((resolve) => {
+      const wsBaseUrl = this.phonic.baseUrl.replace(/^http/, "ws");
+      const ws = new WebSocket(`${wsBaseUrl}/v1/generate/audio/ws`, {
+        headers: {
+          Authorization: `Bearer ${this.phonic.apiKey}`
+        }
+      });
+      ws.onopen = () => {
+        const phonicWebSocket = new PhonicWebSocket(ws);
+        resolve({ data: { phonicWebSocket }, error: null });
+      };
+      ws.onerror = (error) => {
+        resolve({
+          data: null,
+          error: {
+            message: error.message
+          }
+        });
+      };
+    });
+  }
+};
+
+// src/voices/index.ts
+var Voices = class {
+  constructor(phonic) {
+    this.phonic = phonic;
+  }
+  async list() {
+    const response = await this.phonic.get("/voices");
+    return response;
+  }
+  async get(id) {
+    const response = await this.phonic.get(
+      `/voices/${id}`
+    );
+    return response;
+  }
+};
+
+// src/phonic.ts
+var defaultBaseUrl = "https://api.phonic.co";
+var defaultUserAgent = `phonic-node:${version}`;
+var Phonic = class {
+  constructor(apiKey, config) {
+    this.apiKey = apiKey;
+    if (typeof process === "undefined") {
+      throw new Error(
+        "Phonic SDK is intended to be used in Node.js environment."
+      );
+    }
+    if (!this.apiKey) {
+      throw new Error(
+        'API key is missing. Pass it to the constructor: `new Phonic("ph_...")`'
+      );
+    }
+    this.baseUrl = config?.baseUrl ?? defaultBaseUrl;
+    this.headers = new Headers({
+      Authorization: `Bearer ${this.apiKey}`,
+      "User-Agent": process.env.PHONIC_USER_AGENT || defaultUserAgent,
+      "Content-Type": "application/json"
+    });
+  }
+  baseUrl;
+  headers;
+  voices = new Voices(this);
+  tts = new TextToSpeech(this);
+  async fetchRequest(path, options) {
+    try {
+      const response = await fetch(`${this.baseUrl}/v1${path}`, {
+        headers: this.headers,
+        ...options
+      });
+      if (!response.ok) {
+        const statusText = await response.text();
+        console.error(response);
+        return {
+          data: null,
+          error: {
+            message: statusText
+          }
+        };
+      }
+      const data = await response.json();
+      return { data, error: null };
+    } catch (error) {
+      console.error(error);
+      return {
+        data: null,
+        error: {
+          message: "Fetch request failed"
+        }
+      };
+    }
+  }
+  async get(path) {
+    return this.fetchRequest(path, { method: "GET" });
+  }
+};
+export {
+  Phonic
+};

package/package.json

@@ -1,16 +1,62 @@
 {
   "name": "phonic",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "description": "Phonic Node.js SDK",
-  "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "tsup",
+    "check": "biome check --write",
+    "ci": "bun tsc && biome ci && bun test",
+    "release": "bun run build && changeset publish"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Phonic-Co/phonic-node.git"
   },
-  "keywords": [],
-  "author": "Misha Moroshko <misha@phonic.co>",
+  "homepage": "https://github.com/Phonic-Co/phonic-node#readme",
+  "bugs": {
+    "url": "https://github.com/Phonic-Co/phonic-node/issues"
+  },
+  "dependencies": {
+    "ws": "8.18.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@changesets/cli": "2.27.9",
+    "@types/bun": "1.1.13",
+    "tsup": "8.3.5",
+    "typescript": "5.6.3",
+    "zod": "3.23.8"
+  },
+  "files": ["dist/**"],
+  "author": {
+    "name": "Phonic",
+    "url": "https://phonic.co"
+  },
+  "keywords": [
+    "phonic",
+    "text-to-speech",
+    "tts",
+    "javascript",
+    "typescript",
+    "ai",
+    "voice",
+    "audio",
+    "sdk"
+  ],
   "license": "MIT"
 }