@fishjam-cloud/js-server-sdk 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
-# Fishjam server SDK for JavaScript
+# Fishjam Cloud Server SDK for JavaScript
 
-JavaScript server-side SDK for [Fishjam](https://github.com/fishjam-cloud/fishjam).
+JavaScript server-side SDK for [Fishjam Cloud](https://cloud.fishjam.stream).
 
 ## Installation
 
@@ -10,45 +10,29 @@ You can install the library using `npm`:
 npm install @fishjam-cloud/js-server-sdk
 ```
 
+or `yarn`:
+
+```bash
+yarn add @fishjam-cloud/js-server-sdk
+```
+
 ## Documentation
 
-The documentation for the latest release is available [here](https://fishjam-cloud.github.io/js-server-sdk/latest).
+The documentation for the latest release is available [here](https://fishjam-cloud.github.io/js-server-sdk/).
 To generate it locally, run:
 
 ```bash
-npm run docs
+yarn docs
 ```
 
-For more comprehensive tutorial on the Fishjam Server, its capabilites and production usage, refer to
-[Fishjam docs](https://fishjam-cloud.github.io/fishjam-docs/).
-
 ## Examples
 
 See [examples](https://github.com/fishjam-cloud/js-server-sdk/tree/main/examples) directory.
 
-## Fishjam ecosystem
-
-|                |                                                                                                                                                                                                                                                                                                                                       |
-| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| 📱 Client SDKs | [TypeScript](https://github.com/fishjam-cloud/ts-client-sdk/) <br/> [React](https://github.com/fishjam-cloud/react-client-sdk) <br/> [iOS](https://github.com/fishjam-cloud/ios-client-sdk) <br/> [Android](https://github.com/fishjam-cloud/android-client-sdk) <br/> [React Native](https://github.com/fishjam-cloud/react-native-client-sdk) |
-| ⚙️ Server SDKs | [JavaScript](https://github.com/fishjam-cloud/js-server-sdk) <br/> [Python](https://github.com/fishjam-cloud/python-server-sdk) <br/> [Elixir](https://github.com/fishjam-cloud/elixir_server_sdk)                                                                                                                                          |
-| 📚 Resources   | [Fishjam Docs](https://fishjam-cloud.github.io/fishjam-docs/) <br/> [Membrane Framework](https://membrane.stream/) <br/> [Join Membrane Discord!](https://discord.gg/nwnfVSY)                                                                                                                                                           |
-| 🪼 Services    | [Videoroom](https://github.com/fishjam-cloud/fishjam-videoroom) <br/> A videoconferencing app built on top of Fishjam <br/><br/> [Dashboard](https://github.com/fishjam-cloud/fishjam-dashboard) <br/> An all-around development tool for Fishjam                                                                                         |
-
-## Contributing
-
-We welcome contributions to this SDK. Please report any bugs or issues you find or feel free to make a pull request
-with your own bug fixes or features.
-
-### Releasing new versions
-
-To release a new version of the package, go to `Actions` > `Release package` workflow and trigger it with the chosen release type.
-The workflow will bump the package version in `package.json`, release the package to NPM, create a new git tag and a GitHub release.
-
 ## Copyright and License
 
-Copyright 2024, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)
+Copyright 2024, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam-js-server-sdk)
 
-[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=membrane-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)
+[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=fishjam-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam-js-server-sdk)
 
 Licensed under the [Apache License, Version 2.0](LICENSE)

package/dist/chunk-PVJVFZZS.mjs

@@ -0,0 +1 @@
+import{ServerMessage as s,ServerMessage_AuthRequest as t,ServerMessage_EventType as v}from"@fishjam-cloud/fishjam-proto";export{s as a,t as b,v as c};

package/dist/index.d.mts

@@ -0,0 +1,62 @@
+import { Peer, RoomConfig, PeerOptions } from '@fishjam-cloud/fishjam-openapi';
+export { Peer, PeerOptions, PeerStatus, RoomConfig } from '@fishjam-cloud/fishjam-openapi';
+import TypedEmitter from 'typed-emitter';
+import { ServerMessage } from '@fishjam-cloud/fishjam-proto';
+
+type Room = {
+    id: string;
+    peers: Peer[];
+    config: RoomConfig;
+};
+type FishjamConfig = {
+    fishjamUrl: string;
+    serverToken: string;
+};
+
+declare const allowedNotifications: readonly ["roomCreated", "roomDeleted", "roomCrashed", "peerAdded", "peerDeleted", "peerConnected", "peerDisconnected", "peerMetadataUpdated", "peerCrashed", "trackAdded", "trackRemoved", "trackMetadataUpdated"];
+type ErrorEventHandler = (msg: Error) => void;
+type CloseEventHandler = (code: number, reason: string) => void;
+type NotificationEvents = Record<(typeof allowedNotifications)[number], (message: ServerMessage) => void>;
+declare const FishjamWSNotifier_base: new () => TypedEmitter<NotificationEvents>;
+declare class FishjamWSNotifier extends FishjamWSNotifier_base {
+    private readonly client;
+    constructor(config: FishjamConfig, onError: ErrorEventHandler, onClose: CloseEventHandler, onConnectionFailed: ErrorEventHandler);
+    private dispatchNotification;
+    private setupConnection;
+    private isAllowedNotification;
+}
+
+declare class FishjamClient {
+    private readonly roomApi;
+    constructor(config: FishjamConfig);
+    createPeer(roomId: string, options?: PeerOptions): Promise<{
+        peer: Peer;
+        token: string;
+    }>;
+    createRoom(config?: RoomConfig): Promise<Room>;
+    getAllRooms(): Promise<Room[]>;
+    getRoom(roomId: string): Promise<Room>;
+    deletePeer(roomId: string, peerId: string): Promise<void>;
+    deleteRoom(roomId: string): Promise<void>;
+}
+
+declare class BaseException extends Error {
+    constructor(message: string);
+}
+declare class BadRequestException extends BaseException {
+    constructor();
+}
+declare class UnauthorizedException extends BaseException {
+    constructor();
+}
+declare class RoomNotFoundException extends BaseException {
+    constructor();
+}
+declare class PeerNotFoundException extends BaseException {
+    constructor();
+}
+declare class ServiceUnavailableException extends BaseException {
+    constructor();
+}
+
+export { BadRequestException, FishjamClient, type FishjamConfig, FishjamWSNotifier, PeerNotFoundException, type Room, RoomNotFoundException, ServiceUnavailableException, UnauthorizedException };

package/dist/index.d.ts

@@ -1 +1,62 @@
-export * from "./openapi";
+import { Peer, RoomConfig, PeerOptions } from '@fishjam-cloud/fishjam-openapi';
+export { Peer, PeerOptions, PeerStatus, RoomConfig } from '@fishjam-cloud/fishjam-openapi';
+import TypedEmitter from 'typed-emitter';
+import { ServerMessage } from '@fishjam-cloud/fishjam-proto';
+
+type Room = {
+    id: string;
+    peers: Peer[];
+    config: RoomConfig;
+};
+type FishjamConfig = {
+    fishjamUrl: string;
+    serverToken: string;
+};
+
+declare const allowedNotifications: readonly ["roomCreated", "roomDeleted", "roomCrashed", "peerAdded", "peerDeleted", "peerConnected", "peerDisconnected", "peerMetadataUpdated", "peerCrashed", "trackAdded", "trackRemoved", "trackMetadataUpdated"];
+type ErrorEventHandler = (msg: Error) => void;
+type CloseEventHandler = (code: number, reason: string) => void;
+type NotificationEvents = Record<(typeof allowedNotifications)[number], (message: ServerMessage) => void>;
+declare const FishjamWSNotifier_base: new () => TypedEmitter<NotificationEvents>;
+declare class FishjamWSNotifier extends FishjamWSNotifier_base {
+    private readonly client;
+    constructor(config: FishjamConfig, onError: ErrorEventHandler, onClose: CloseEventHandler, onConnectionFailed: ErrorEventHandler);
+    private dispatchNotification;
+    private setupConnection;
+    private isAllowedNotification;
+}
+
+declare class FishjamClient {
+    private readonly roomApi;
+    constructor(config: FishjamConfig);
+    createPeer(roomId: string, options?: PeerOptions): Promise<{
+        peer: Peer;
+        token: string;
+    }>;
+    createRoom(config?: RoomConfig): Promise<Room>;
+    getAllRooms(): Promise<Room[]>;
+    getRoom(roomId: string): Promise<Room>;
+    deletePeer(roomId: string, peerId: string): Promise<void>;
+    deleteRoom(roomId: string): Promise<void>;
+}
+
+declare class BaseException extends Error {
+    constructor(message: string);
+}
+declare class BadRequestException extends BaseException {
+    constructor();
+}
+declare class UnauthorizedException extends BaseException {
+    constructor();
+}
+declare class RoomNotFoundException extends BaseException {
+    constructor();
+}
+declare class PeerNotFoundException extends BaseException {
+    constructor();
+}
+declare class ServiceUnavailableException extends BaseException {
+    constructor();
+}
+
+export { BadRequestException, FishjamClient, type FishjamConfig, FishjamWSNotifier, PeerNotFoundException, type Room, RoomNotFoundException, ServiceUnavailableException, UnauthorizedException };

package/dist/index.js

@@ -1,17 +1 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./openapi"), exports);
+"use strict";var S=Object.create;var v=Object.defineProperty;var N=Object.getOwnPropertyDescriptor;var T=Object.getOwnPropertyNames;var M=Object.getPrototypeOf,_=Object.prototype.hasOwnProperty;var j=(t,e)=>{for(var o in e)v(t,o,{get:e[o],enumerable:!0})},y=(t,e,o,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of T(e))!_.call(t,s)&&s!==o&&v(t,s,{get:()=>e[s],enumerable:!(r=N(e,s))||r.enumerable});return t};var E=(t,e,o)=>(o=t!=null?S(M(t)):{},y(e||!t||!t.__esModule?v(o,"default",{value:t,enumerable:!0}):o,t)),U=t=>y(v({},"__esModule",{value:!0}),t);var H={};j(H,{BadRequestException:()=>d,FishjamClient:()=>w,FishjamWSNotifier:()=>g,Peer:()=>i.Peer,PeerNotFoundException:()=>f,PeerOptions:()=>i.PeerOptions,PeerStatus:()=>i.PeerStatus,RoomConfig:()=>i.RoomConfig,RoomNotFoundException:()=>u,ServiceUnavailableException:()=>h,UnauthorizedException:()=>l});module.exports=U(H);var i=require("@fishjam-cloud/fishjam-openapi");var x=E(require("websocket")),P=require("events");var n=require("@fishjam-cloud/fishjam-proto");var b=t=>{let e=new URL(t);return e.protocol=e.protocol.replace("http","ws"),e.href};var F=["roomCreated","roomDeleted","roomCrashed","peerAdded","peerDeleted","peerConnected","peerDisconnected","peerMetadataUpdated","peerCrashed","trackAdded","trackRemoved","trackMetadataUpdated"],g=class extends P.EventEmitter{client;constructor(e,o,r,s){super(),this.client=new x.client;let R=`${b(e.fishjamUrl)}/socket/server/websocket`;this.client.on("connectFailed",p=>s(p)),this.client.on("connect",p=>this.setupConnection(p,e.serverToken,o,r)),this.client.connect(R)}dispatchNotification(e){if(e.type=="utf8"){console.warn("UTF-8 is an invalid notification type");return}try{let o=n.ServerMessage.toJSON(n.ServerMessage.decode(e.binaryData)),[r]=Object.keys(o);if(!this.isAllowedNotification(r))return;this.emit(r,o)}catch(o){console.error("Couldn't decode websocket server message."),console.error(o),console.error(e)}}setupConnection(e,o,r,s){let R=n.ServerMessage.encode({authRequest:{token:o}}).finish(),p=n.ServerMessage.encode({subscribeRequest:{eventType:n.ServerMessage_EventType.EVENT_TYPE_SERVER_NOTIFICATION}}).finish();e.send(R),e.send(p),e.on("message",m=>this.dispatchNotification(m)),e.on("error",m=>r(m)),e.on("close",(m,C)=>s(m,C))}isAllowedNotification(e){return F.includes(e)}};var k=E(require("axios")),A=require("@fishjam-cloud/fishjam-openapi");var a=class extends Error{constructor(e){super(e),this.name=this.constructor.name}},d=class extends a{constructor(){super("Invalid request body structure")}},l=class extends a{constructor(){super("Unauthorized")}},u=class extends a{constructor(){super("Room not found")}},f=class extends a{constructor(){super("Peer not found")}},h=class extends a{constructor(){super("Service unavailable")}};var c=(t,e)=>{switch(t){case 400:throw new d;case 401:throw new l;case 404:switch(e){case"peer":throw new f;case"room":throw new u;default:return}case 503:throw new h;default:return}};var w=class{roomApi;constructor(e){let o=k.default.create({validateStatus:r=>[200,201,400,401,404,503].includes(r),headers:{Authorization:`Bearer ${e.serverToken}`}});this.roomApi=new A.RoomApi(void 0,e.fishjamUrl,o)}async createPeer(e,o={}){let r=await this.roomApi.addPeer(e,{type:"webrtc",options:o});c(r.status);let{data:{data:s}}=r;return{peer:s.peer,token:s.token}}async createRoom(e={}){let o=await this.roomApi.createRoom(e);c(o.status);let{data:{data:{room:{components:r,...s}}}}=o;return s}async getAllRooms(){let e=await this.roomApi.getAllRooms();return c(e.status),e.data.data.map(({components:o,...r})=>r)??[]}async getRoom(e){let o=await this.roomApi.getRoom(e);c(o.status,"room");let{components:r,...s}=o.data.data;return s}async deletePeer(e,o){let r=await this.roomApi.deletePeer(e,o);c(r.status,"peer")}async deleteRoom(e){let o=await this.roomApi.deleteRoom(e);c(o.status,"room")}};0&&(module.exports={BadRequestException,FishjamClient,FishjamWSNotifier,Peer,PeerNotFoundException,PeerOptions,PeerStatus,RoomConfig,RoomNotFoundException,ServiceUnavailableException,UnauthorizedException});

package/dist/index.mjs

@@ -0,0 +1 @@
+import{a as p,c as g}from"./chunk-PVJVFZZS.mjs";import{Peer as V,PeerStatus as $,RoomConfig as J,PeerOptions as L}from"@fishjam-cloud/fishjam-openapi";import*as y from"websocket";import{EventEmitter as b}from"events";var R=r=>{let e=new URL(r);return e.protocol=e.protocol.replace("http","ws"),e.href};var x=["roomCreated","roomDeleted","roomCrashed","peerAdded","peerDeleted","peerConnected","peerDisconnected","peerMetadataUpdated","peerCrashed","trackAdded","trackRemoved","trackMetadataUpdated"],v=class extends b{client;constructor(e,o,t,s){super(),this.client=new y.client;let h=`${R(e.fishjamUrl)}/socket/server/websocket`;this.client.on("connectFailed",a=>s(a)),this.client.on("connect",a=>this.setupConnection(a,e.serverToken,o,t)),this.client.connect(h)}dispatchNotification(e){if(e.type=="utf8"){console.warn("UTF-8 is an invalid notification type");return}try{let o=p.toJSON(p.decode(e.binaryData)),[t]=Object.keys(o);if(!this.isAllowedNotification(t))return;this.emit(t,o)}catch(o){console.error("Couldn't decode websocket server message."),console.error(o),console.error(e)}}setupConnection(e,o,t,s){let h=p.encode({authRequest:{token:o}}).finish(),a=p.encode({subscribeRequest:{eventType:g.EVENT_TYPE_SERVER_NOTIFICATION}}).finish();e.send(h),e.send(a),e.on("message",c=>this.dispatchNotification(c)),e.on("error",c=>t(c)),e.on("close",(c,E)=>s(c,E))}isAllowedNotification(e){return x.includes(e)}};import P from"axios";import{RoomApi as k}from"@fishjam-cloud/fishjam-openapi";var n=class extends Error{constructor(e){super(e),this.name=this.constructor.name}},m=class extends n{constructor(){super("Invalid request body structure")}},d=class extends n{constructor(){super("Unauthorized")}},l=class extends n{constructor(){super("Room not found")}},u=class extends n{constructor(){super("Peer not found")}},f=class extends n{constructor(){super("Service unavailable")}};var i=(r,e)=>{switch(r){case 400:throw new m;case 401:throw new d;case 404:switch(e){case"peer":throw new u;case"room":throw new l;default:return}case 503:throw new f;default:return}};var w=class{roomApi;constructor(e){let o=P.create({validateStatus:t=>[200,201,400,401,404,503].includes(t),headers:{Authorization:`Bearer ${e.serverToken}`}});this.roomApi=new k(void 0,e.fishjamUrl,o)}async createPeer(e,o={}){let t=await this.roomApi.addPeer(e,{type:"webrtc",options:o});i(t.status);let{data:{data:s}}=t;return{peer:s.peer,token:s.token}}async createRoom(e={}){let o=await this.roomApi.createRoom(e);i(o.status);let{data:{data:{room:{components:t,...s}}}}=o;return s}async getAllRooms(){let e=await this.roomApi.getAllRooms();return i(e.status),e.data.data.map(({components:o,...t})=>t)??[]}async getRoom(e){let o=await this.roomApi.getRoom(e);i(o.status,"room");let{components:t,...s}=o.data.data;return s}async deletePeer(e,o){let t=await this.roomApi.deletePeer(e,o);i(t.status,"peer")}async deleteRoom(e){let o=await this.roomApi.deleteRoom(e);i(o.status,"room")}};export{m as BadRequestException,w as FishjamClient,v as FishjamWSNotifier,V as Peer,u as PeerNotFoundException,L as PeerOptions,$ as PeerStatus,J as RoomConfig,l as RoomNotFoundException,f as ServiceUnavailableException,d as UnauthorizedException};

package/dist/proto.d.mts

@@ -0,0 +1 @@
+export { ServerMessage, ServerMessage_AuthRequest, ServerMessage_EventType } from '@fishjam-cloud/fishjam-proto';

package/dist/proto.d.ts

@@ -0,0 +1 @@
+export { ServerMessage, ServerMessage_AuthRequest, ServerMessage_EventType } from '@fishjam-cloud/fishjam-proto';

package/dist/proto.js

@@ -0,0 +1 @@
+"use strict";var a=Object.defineProperty;var M=Object.getOwnPropertyDescriptor;var S=Object.getOwnPropertyNames;var o=Object.prototype.hasOwnProperty;var p=(r,e)=>{for(var v in e)a(r,v,{get:e[v],enumerable:!0})},u=(r,e,v,g)=>{if(e&&typeof e=="object"||typeof e=="function")for(let t of S(e))!o.call(r,t)&&t!==v&&a(r,t,{get:()=>e[t],enumerable:!(g=M(e,t))||g.enumerable});return r};var _=r=>u(a({},"__esModule",{value:!0}),r);var f={};p(f,{ServerMessage:()=>s.ServerMessage,ServerMessage_AuthRequest:()=>s.ServerMessage_AuthRequest,ServerMessage_EventType:()=>s.ServerMessage_EventType});module.exports=_(f);var s=require("@fishjam-cloud/fishjam-proto");0&&(module.exports={ServerMessage,ServerMessage_AuthRequest,ServerMessage_EventType});

package/dist/proto.mjs

@@ -0,0 +1 @@
+import{a,b,c}from"./chunk-PVJVFZZS.mjs";export{a as ServerMessage,b as ServerMessage_AuthRequest,c as ServerMessage_EventType};

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@fishjam-cloud/js-server-sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Fishjam server SDK for JavaScript",
   "homepage": "https://github.com/fishjam-cloud/js-server-sdk",
+  "author": "Fishjam Cloud Team",
   "repository": {
     "type": "git",
     "url": "https://github.com/fishjam-cloud/js-server-sdk.git"
@@ -24,28 +25,39 @@
   ],
   "exports": {
     ".": "./dist/index.js",
-    "./proto": "./dist/protos/fishjam/index.js"
+    "./proto": "./dist/proto.js"
   },
   "scripts": {
-    "build": "tsc",
-    "build:check": "tsc --noEmit",
+    "build": "tsup",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
-    "docs": "typedoc src src/protos/fishjam",
-    "gen:proto": "sh codegen/protobuf.sh",
-    "gen:api": "sh codegen/openapi.sh",
-    "prepare": "tsc"
+    "typecheck": "tsc --noEmit"
+  },
+  "tsup": {
+    "entry": [
+      "src/index.ts",
+      "src/proto.ts"
+    ],
+    "dts": true,
+    "minify": true,
+    "format": [
+      "cjs",
+      "esm"
+    ],
+    "outDir": "dist"
   },
   "dependencies": {
-    "axios": "^1.6.8",
-    "protobufjs": "^7.2.6"
+    "@fishjam-cloud/fishjam-openapi": "0.1.2",
+    "@fishjam-cloud/fishjam-proto": "0.1.2",
+    "axios": "^1.7.4",
+    "websocket": "^1.0.35"
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.13.4",
-    "@types/node": "^20.12.7",
-    "prettier": "3.2.5",
-    "ts-proto": "^1.172.0",
-    "typedoc": "^0.25.13",
-    "typescript": "^5.4.5"
+    "@types/node": "^22.4.1",
+    "@types/websocket": "^1.0.10",
+    "prettier": "3.3.3",
+    "tsup": "^8.2.4",
+    "typed-emitter": "^2.1.0"
   }
-}
+}