iframe.io 0.0.9 → 0.0.10

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+export declare type PeerType = 'WINDOW' | 'IFRAME';
+export declare type CallbackFunction = (error: boolean | string, ...args: any[]) => void;
+export declare type Listener = (payload?: any, callback?: CallbackFunction) => void;
+export declare type Options = {
+    type?: PeerType;
+    debug?: boolean;
+};
+export interface RegisteredEvents {
+    [index: string]: Listener[];
+}
+export declare type Peer = {
+    type: PeerType;
+    source?: Window;
+    origin?: string;
+};
+export declare type MessageData = {
+    _event: string;
+    payload: any;
+    callback: boolean;
+};
+export declare type Message = {
+    origin: string;
+    data: MessageData;
+    source: Window;
+};
+export default class IOF {
+    Events: RegisteredEvents;
+    peer: Peer;
+    options: Options;
+    constructor(options: Options);
+    debug(...args: any[]): void;
+    initiate(contentWindow: MessageEventSource, iframeOrigin: string): this;
+    listen(hostOrigin?: string): this;
+    fire(_event: string, payload?: MessageData['payload'], callback?: boolean): void;
+    emit(_event: string, payload?: MessageData['payload'], fn?: Listener): this;
+    on(_event: string, fn: Listener): this;
+    once(_event: string, fn: Listener): this;
+    off(_event: string, fn: Listener): this;
+    removeListeners(fn: Listener): this;
+}

package/dist/index.js

@@ -23,8 +23,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 function newObject(data) {
     return JSON.parse(JSON.stringify(data));
 }
-var IFrameIO = /** @class */ (function () {
-    function IFrameIO(options) {
+var IOF = /** @class */ (function () {
+    function IOF(options) {
         if (options && typeof options !== 'object')
             throw new Error('Invalid Options');
         this.options = options;
@@ -33,14 +33,14 @@ var IFrameIO = /** @class */ (function () {
         if (options.type)
             this.peer.type = options.type.toUpperCase();
     }
-    IFrameIO.prototype.debug = function () {
+    IOF.prototype.debug = function () {
         var args = [];
         for (var _i = 0; _i < arguments.length; _i++) {
             args[_i] = arguments[_i];
         }
         this.options && this.options.debug && console.log.apply(console, args);
     };
-    IFrameIO.prototype.initiate = function (contentWindow, iframeOrigin) {
+    IOF.prototype.initiate = function (contentWindow, iframeOrigin) {
         var _this = this;
         // Establish a connection with an iframe containing in the current window
         if (!contentWindow || !iframeOrigin)
@@ -72,7 +72,7 @@ var IFrameIO = /** @class */ (function () {
         this.emit('ping');
         return this;
     };
-    IFrameIO.prototype.listen = function (hostOrigin) {
+    IOF.prototype.listen = function (hostOrigin) {
         // Listening to connection from the content window
         var _this = this;
         this.peer.type = 'IFRAME'; // iframe.io connection listener is automatically set as IFRAME
@@ -109,7 +109,7 @@ var IFrameIO = /** @class */ (function () {
         }, false);
         return this;
     };
-    IFrameIO.prototype.fire = function (_event, payload, callback) {
+    IOF.prototype.fire = function (_event, payload, callback) {
         var _this = this;
         // Volatile event
         if (!this.Events[_event]
@@ -137,7 +137,7 @@ var IFrameIO = /** @class */ (function () {
         // Fire listeners
         listeners.map(function (fn) { return payload ? fn(payload, callbackFn) : fn(callbackFn); });
     };
-    IFrameIO.prototype.emit = function (_event, payload, fn) {
+    IOF.prototype.emit = function (_event, payload, fn) {
         if (!this.peer.source)
             throw new Error('No Connection initiated');
         if (typeof payload == 'function') {
@@ -157,7 +157,7 @@ var IFrameIO = /** @class */ (function () {
         this.peer.source.postMessage(newObject({ _event: _event, payload: payload, callback: hasCallback }), this.peer.origin);
         return this;
     };
-    IFrameIO.prototype.on = function (_event, fn) {
+    IOF.prototype.on = function (_event, fn) {
         // Add Event listener
         if (!this.Events[_event])
             this.Events[_event] = [];
@@ -165,7 +165,7 @@ var IFrameIO = /** @class */ (function () {
         this.debug("[".concat(this.peer.type, "] New <").concat(_event, "> listener on"));
         return this;
     };
-    IFrameIO.prototype.once = function (_event, fn) {
+    IOF.prototype.once = function (_event, fn) {
         // Add Once Event listener
         _event += '--@once';
         if (!this.Events[_event])
@@ -174,20 +174,20 @@ var IFrameIO = /** @class */ (function () {
         this.debug("[".concat(this.peer.type, "] New <").concat(_event, " once> listener on"));
         return this;
     };
-    IFrameIO.prototype.off = function (_event, fn) {
+    IOF.prototype.off = function (_event, fn) {
         // Remove Event listener
         delete this.Events[_event];
         typeof fn == 'function' && fn();
         this.debug("[".concat(this.peer.type, "] <").concat(_event, "> listener off"));
         return this;
     };
-    IFrameIO.prototype.removeListeners = function (fn) {
+    IOF.prototype.removeListeners = function (fn) {
         // Clear all event listeners
         this.Events = {};
         typeof fn == 'function' && fn();
         this.debug("[".concat(this.peer.type, "] All listeners removed"));
         return this;
     };
-    return IFrameIO;
+    return IOF;
 }());
-exports.default = IFrameIO;
+exports.default = IOF;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "iframe.io",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "Easy and friendly API to connect and interact between content window and its containing iframe",
   "main": "./dist/index.js",
-  "types": "./src/types/*.d.ts",
+  "types": "./dist/index.d.ts",
   "private": false,
   "scripts": {
     "compile": "rimraf ./dist && tsc",

package/src/index.ts

@@ -1,20 +1,41 @@
 
-import type {
-  Options, 
-  RegisteredEvents, 
-  Peer, 
-  PeerType,
-  Message, 
-  MessageData, 
-  Listener,
-  CallbackFunction
-} from './types'
+export type PeerType = 'WINDOW' | 'IFRAME'
+
+export type CallbackFunction = ( error: boolean | string, ...args: any[] ) => void
+export type Listener = ( payload?: any, callback?: CallbackFunction ) => void
+
+export type Options = {
+  type?: PeerType
+  debug?: boolean
+}
+
+export interface RegisteredEvents {
+  [index: string]: Listener[]
+}
+
+export type Peer = {
+  type: PeerType
+  source?: Window
+  origin?: string
+}
+
+export type MessageData = {
+  _event: string
+  payload: any
+  callback: boolean
+}
+
+export type Message = {
+  origin: string
+  data: MessageData,
+  source: Window
+}
 
 function newObject( data: object ){
   return JSON.parse( JSON.stringify( data ) )
 }
 
-export default class IFrameIO {
+export default class IOF {
 
   Events: RegisteredEvents
   peer: Peer

package/src/types/index.d.ts

@@ -1,52 +0,0 @@
-
-export type * as IFrameIOTop from '..'
-
-export type PeerType = 'WINDOW' | 'IFRAME'
-
-export type CallbackFunction = ( error: boolean | string, ...args: any[] ) => void
-export type Listener = ( payload?: any, callback?: CallbackFunction ) => void
-
-export type Options = {
-  type?: PeerType
-  debug?: boolean
-}
-
-export interface RegisteredEvents {
-  [index: string]: Listener[]
-}
-
-export type Peer = {
-  type: PeerType
-  source?: Window
-  origin?: string
-}
-
-export type MessageData = {
-  _event: string
-  payload: any
-  callback: boolean
-}
-
-export type Message = {
-  origin: string
-  data: MessageData,
-  source: Window
-}
-
-
-export interface IFrameIOClass {
-  Events: RegisteredEvents
-  peer: Peer
-  options: Options
-
-  // constructor: ( options: Options ) => void
-  debug: ( ...args: any[] ) => void
-  initiate: ( contentWindow: MessageEventSource, iframeOrigin: string ) => this
-  listen: ( hostOrigin?: string ) => this
-  fire: ( _event: string, payload?: MessageData['payload'], callback?: boolean ) => void 
-  emit: ( _event: string, payload?: MessageData['payload'], fn?: Listener ) => void
-  on: ( _event: string, fn: Listener ) => void
-  once: ( _event: string, fn: Listener ) => void
-	off: ( _event: string, fn: Listener ) => void
-	removeListeners: ( fn: Listener ) => void
-}