@digitalsamba/embedded-sdk 0.0.1 → 0.0.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@digitalsamba/embedded-sdk",
   "packageManager": "yarn@3.1.0",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license" : "BSD-2-Clause",
   "scripts": {
     "build": "npm run build:cjs && npm run build:esm && npm run build:umd && npm run build:types",
@@ -14,6 +14,8 @@
   "module": "dist/esm/index.js",
   "umd:main": "dist/umd/index.js",
   "types": "dist/types/index.d.js",
+  "files": ["dist"],
+  "unpkg": "dist/umd/index.js",
   "devDependencies": {
     "ts-loader": "^9.4.1",
     "typescript": "^4.8.3",

package/.editorconfig

@@ -1,10 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-[*.{js,json,yml}]
-charset = utf-8
-indent_style = space
-indent_size = 2

package/.github/workflows/main.yml

@@ -1,32 +0,0 @@
-name: Publish Package to npmjs
-
-on:
-  push:
-    branches:
-      - release
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Clone repository
-      uses: actions/checkout@v3
-
-    - name: Setup .npmrc file to publish to npm
-      uses: actions/setup-node@v3
-      with:
-        node-version: '16'
-        registry-url: 'https://registry.npmjs.org'
-
-    - name: Setup git identity
-      run: |
-        git config --global user.email "github@digitalsamba.com"
-        git config --global user.name "Digital Samba"
-
-    - name: execute yarn
-      run: yarn
-
-    - name: yarn publish
-      run: yarn publish
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.EMBEDDED_SDK_NPM_TOKEN }}

package/config/tsconfig.cjs.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../tsconfig",
-  "compilerOptions": {
-    "module": "commonjs",
-    "outDir": "../dist/cjs"
-  }
-}

package/config/tsconfig.esm.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../tsconfig",
-  "compilerOptions": {
-    "module": "ESNext",
-    "outDir": "../dist/esm"
-  }
-}

package/config/tsconfig.types.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../tsconfig",
-  "compilerOptions": {
-    "declaration": true,
-    "emitDeclarationOnly": true,
-    "outDir": "../dist/types"
-  }
-}

package/config/tsconfig.umd.json

@@ -1,7 +0,0 @@
-{
-  "extends": "../tsconfig",
-  "compilerOptions": {
-    "module": "commonjs",
-    "declaration": false
-  }
-}

package/config/webpack.config.js

@@ -1,30 +0,0 @@
-const path = require("path");
-
-module.exports = {
-  mode: "production",
-  entry: "./src/umd.ts",
-  output: {
-    path: path.resolve(__dirname, "../dist/umd"),
-    filename: "index.js",
-    library: "DigitalSambaEmbedded",
-    libraryTarget: "umd",
-    globalObject: "this",
-  },
-  module: {
-    rules: [
-      {
-        test: /\.ts(x*)?$/,
-        exclude: /node_modules/,
-        use: {
-          loader: "ts-loader",
-          options: {
-            configFile: "config/tsconfig.umd.json",
-          },
-        },
-      },
-    ],
-  },
-  resolve: {
-    extensions: [".ts", ".js", ".tsx", ".jsx"],
-  },
-};

package/src/index.ts

@@ -1,307 +0,0 @@
-import {
-  ALLOW_ATTRIBUTE_MISSING,
-  INVALID_CONFIG,
-  INVALID_URL,
-  RichError,
-  UNKNOWN_TARGET,
-} from "./utils/errors";
-
-export interface InitOptions {
-  root: HTMLElement;
-  frame: HTMLIFrameElement;
-
-  url: string;
-  team: string;
-  room: string;
-  token?: string;
-}
-
-export type FrameAttributes = {
-  align: string;
-  allow: string;
-  allowFullscreen: boolean;
-  frameBorder: string;
-  height: string;
-  longDesc: string;
-  marginHeight: string;
-  marginWidth: string;
-  name: string;
-  referrerPolicy: ReferrerPolicy;
-  scrolling: string;
-  src: string;
-  srcdoc: string;
-  width: string;
-} & HTMLElement;
-
-export interface InstanceProperties {
-  frameAttributes?: Partial<FrameAttributes>;
-  reportErrors?: boolean;
-}
-
-const CONNECT_TIMEOUT = 5000;
-
-export type SendMessageType =
-  | "connect"
-  | "enableVideo"
-  | "enableAudio"
-  | "disableVideo"
-  | "disableAudio"
-  | "toggleVideo"
-  | "toggleAudio"
-  | "startScreenshare"
-  | "stopScreenshare";
-
-export type ReceiveMessageType =
-  | "connected"
-  | "userJoined"
-  | "userLeft"
-  | "videoEnabled"
-  | "videoDisabled"
-  | "audioEnabled"
-  | "audioDisabled"
-  | "screenshareStarted"
-  | "screenshareStopped";
-
-export interface SendMessage<P> {
-  type: SendMessageType;
-  payload?: P;
-}
-
-export interface ReceiveMessage {
-  type: ReceiveMessageType;
-  payload: unknown;
-}
-
-function isFunction(func: any): func is (payload: any) => void {
-  return func instanceof Function;
-}
-
-export class DigitalSambaEmbedded {
-  initOptions: Partial<InitOptions>;
-
-  savedIframeSrc: string = "";
-
-  allowedOrigin: string = "*";
-
-  connected: boolean = false;
-
-  frame: HTMLIFrameElement = document.createElement("iframe");
-
-  eventHandlers: Partial<
-    Record<ReceiveMessageType | "*", (payload: any) => void>
-  > = {};
-
-  reportErrors: boolean = false;
-
-  constructor(
-    options: Partial<InitOptions> = {},
-    instanceProperties: Partial<InstanceProperties> = {},
-    loadImmediately = true
-  ) {
-    this.initOptions = options;
-
-    this.frame.allow = "camera; microphone; display-capture; autoplay;";
-    this.frame.setAttribute("allowFullscreen", "true");
-
-    this.mountFrame(loadImmediately);
-
-    if (loadImmediately) {
-      this.load(instanceProperties);
-    } else {
-      this.frame.style.display = "none";
-    }
-
-    window.addEventListener("message", this.onMessage);
-  }
-
-  static createControl = (initOptions: InitOptions) => {
-    return new this(initOptions, {}, false);
-  };
-
-  private mountFrame = (loadImmediately: boolean) => {
-    const { url, frame, root } = this.initOptions;
-
-    if (root) {
-      root.appendChild(this.frame);
-    } else if (frame) {
-      this.frame = frame;
-
-      if (!frame.allow) {
-        this.logError(ALLOW_ATTRIBUTE_MISSING);
-      }
-    } else {
-      document.body.appendChild(this.frame);
-    }
-
-    if (url) {
-      try {
-        const frameSrc = new URL(url).toString();
-
-        this.frame.src = frameSrc;
-        this.savedIframeSrc = frameSrc;
-      } catch {
-        this.logError(INVALID_URL);
-      }
-    }
-
-    if (!loadImmediately) {
-      this.savedIframeSrc = this.frame.src;
-      this.frame.src = "";
-    }
-  };
-
-  load = (instanceProperties: InstanceProperties = {}) => {
-    this.reportErrors = instanceProperties.reportErrors || false;
-
-    this.setFrameSrc();
-
-    this.applyFrameProperties(instanceProperties);
-
-    this.frame.style.display = "block";
-  };
-
-  on = (type: ReceiveMessageType, handler: (payload: any) => void) => {
-    this.eventHandlers[type] = handler;
-  };
-
-  private onMessage = (event: MessageEvent<ReceiveMessage>) => {
-    //     if (event.origin !== this.allowedOrigin) {
-    //       // ignore messages from other sources;
-    //       return;
-    //     }
-
-    if (typeof this.eventHandlers["*"] === "function") {
-      this.eventHandlers["*"](event.data);
-    }
-
-    if (event.data.type) {
-      const callback = this.eventHandlers[event.data.type];
-
-      if (isFunction(callback)) {
-        callback(event.data);
-      }
-    }
-  };
-
-  private setFrameSrc = () => {
-    let url = this.savedIframeSrc;
-    const { team, room, token } = this.initOptions;
-
-    if (team && room) {
-      url = `https://${team}.digitalsamba.com/${room}`;
-      if (token) {
-        const params = new URLSearchParams({ token });
-
-        url = `${url}?${params}`;
-      }
-
-      this.frame.src = url;
-    } else {
-      this.logError(INVALID_CONFIG);
-      return;
-    }
-
-    const allowedURL = new URL(this.frame.src);
-
-    this.allowedOrigin = allowedURL.origin;
-
-    this.frame.onload = () => this.checkTarget();
-  };
-
-  private checkTarget() {
-    this.sendMessage({ type: "connect" });
-
-    const confirmationTimeout = window.setTimeout(() => {
-      this.logError(UNKNOWN_TARGET);
-    }, CONNECT_TIMEOUT);
-
-    this.on("connected", () => {
-      this.connected = true;
-      clearTimeout(confirmationTimeout);
-    });
-  }
-
-  private sendMessage<G>(message: SendMessage<G>) {
-    if (this.frame.contentWindow) {
-      this.frame.contentWindow.postMessage(message, {
-        targetOrigin: this.allowedOrigin,
-      });
-    }
-  }
-
-  private logError = (error: RichError) => {
-    if (this.reportErrors) {
-      throw error;
-    }
-  };
-
-  private applyFrameProperties = (
-    instanceProperties: Partial<InstanceProperties>
-  ) => {
-    if (instanceProperties.frameAttributes) {
-      // TODO: only allow specific attrs here; This is a heck to support
-      Object.entries(instanceProperties.frameAttributes).forEach(
-        ([attr, value]) => {
-          if (value !== null && typeof value !== "undefined") {
-            this.frame.setAttribute(attr, value.toString());
-          } else {
-            this.frame.removeAttribute(attr);
-          }
-        }
-      );
-    }
-
-    if (instanceProperties.reportErrors) {
-      this.reportErrors = true;
-    }
-  };
-
-  // commands
-  enableVideo = () => {
-    this.sendMessage({ type: "enableVideo" });
-  };
-
-  disableVideo = () => {
-    this.sendMessage({ type: "disableVideo" });
-  };
-
-  toggleVideo = (enable?: boolean) => {
-    if (typeof enable === "undefined") {
-      this.sendMessage({ type: "toggleVideo" });
-    } else {
-      if (enable) {
-        this.enableVideo();
-      } else {
-        this.disableVideo();
-      }
-    }
-  };
-
-  enableAudio = () => {
-    this.sendMessage({ type: "enableAudio" });
-  };
-
-  disableAudio = () => {
-    this.sendMessage({ type: "disableAudio" });
-  };
-
-  toggleAudio = (enable?: boolean) => {
-    if (typeof enable === "undefined") {
-      this.sendMessage({ type: "toggleAudio" });
-    } else {
-      if (enable) {
-        this.enableAudio();
-      } else {
-        this.disableAudio();
-      }
-    }
-  };
-
-  startScreenshare = () => {
-    this.sendMessage({ type: "startScreenshare" });
-  };
-
-  stopScreenshare = () => {
-    this.sendMessage({ type: "stopScreenshare" });
-  };
-}

package/src/umd.ts

@@ -1,4 +0,0 @@
-import {DigitalSambaEmbedded} from './index';
-
-// compatibility with script tag
-module.exports = DigitalSambaEmbedded

package/src/utils/errors.ts

@@ -1,30 +0,0 @@
-export class RichError extends Error {
-  constructor(error: { name: string; message: string }) {
-    super(error.message);
-
-    this.name = error.name;
-  }
-}
-
-export const UNKNOWN_TARGET = new RichError({
-  name: "UNKNOWN_TARGET",
-  message:
-    "Could not verify the identity of target frame. Commands may not work",
-});
-
-export const INVALID_CONFIG = new RichError({
-  name: "INVALID_INIT_CONFIG",
-  message: "Initializations options are invalid. Missing team name or room ID",
-});
-
-export const ALLOW_ATTRIBUTE_MISSING = new RichError({
-  name: "ALLOW_ATTRIBUTE_MISSING",
-  message:
-    "You've provided a frame that is mising 'allow' attribute. Some functionality may not work.",
-});
-
-
-export const INVALID_URL = new RichError({
-    name: "INVALID_URL",
-    message: "Invalid frame url specified"
-})

package/tools/cleanup.js

@@ -1,29 +0,0 @@
-/* eslint-disable */
-const fs = require("fs");
-const Path = require("path");
-/* eslint-enable */
-
-const deleteFolderRecursive = (path) => {
-  if (fs.existsSync(path)) {
-    fs.readdirSync(path).forEach((file) => {
-      const curPath = Path.join(path, file);
-      if (fs.lstatSync(curPath).isDirectory()) {
-        deleteFolderRecursive(curPath);
-      } else {
-        fs.unlinkSync(curPath);
-      }
-    });
-    fs.rmdirSync(path);
-  }
-};
-
-const folder = process.argv.slice(2)[0];
-
-if (folder) {
-  deleteFolderRecursive(Path.join(__dirname, "../dist", folder));
-} else {
-  deleteFolderRecursive(Path.join(__dirname, "../dist/cjs"));
-  deleteFolderRecursive(Path.join(__dirname, "../dist/esm"));
-  deleteFolderRecursive(Path.join(__dirname, "../dist/umd"));
-  deleteFolderRecursive(Path.join(__dirname, "../dist/types"));
-}

package/tsconfig.json

@@ -1,21 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es5",
-    "declaration": true,
-    "allowJs": true,
-    "incremental": true,
-    "downlevelIteration": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "commonjs",
-    "resolveJsonModule": true,
-    "isolatedModules": false,
-    "jsx": "react-jsx",
-    "noImplicitAny": true,
-    "outDir": "./dist",
-    "esModuleInterop": true,
-    "moduleResolution": "node",
-  },
-  "include": ["./src/**/*"],
-  "exclude": ["node_modules"]
-}