next-box 1.0.14 → 1.1.1

package/README.md

@@ -4,19 +4,62 @@
 A library for developing extensions, components and working with data in the NextBox platform.
 
 ```javascript
-import { initFileApi } from 'next-box';
-
-initFileApi().then((fileApi) => {
-    // Get file url
-    console.log(fileApi.fileUrl)
-    
-    // Download file
-    fileApi.download().then(response => response.text()).then(data => {
-        document.body.innerHTML = data;
+import { init, ExtensionEvents } from 'next-box';
+
+const app = init();
+
+app.on(ExtensionEvents.Ready, () => {
+    /**
+     * Get file url
+     */
+    console.log(app.fileUrl);
+
+    /**
+     * Download file
+     */
+    app.download()
+        .then((response) => response.text())
+        .then((data) => {
+            document.body.innerHTML = data;
+        });
+
+    /**
+     * Replace file content
+     */
+    app.replace('new content');
+
+    /**
+     * Display change event
+     */
+    app.on(ExtensionEvents.ChangeView, (state) => {
+        console.log(state);
     });
 
-    // Replace file content 
-    fileApi.replace('new content')
+    /**
+     * Display change event
+     */
+    app.on(ExtensionEvents.ChangeView, (state) => {
+        console.log(state);
+    });
+
+    /**
+     * Request to save changes and close the editor
+     */
+    app.on(ExtensionEvents.SaveAndClose, (state) => {
+        console.log(state);
+        app.close();
+    });
+
+    /**
+     * Submit a content change message
+     * In the case when content is written before exiting the application or when writing large files
+     */
+    app.changeContent(true);
+
+    /**
+     * Send an event to close the editor
+     */
+    app.close();
 });
 ```
 

package/app.d.ts

@@ -0,0 +1,43 @@
+import { EventEmitter, EventHandler } from './event-emitter';
+import { AppState, ExtensionEvents } from './interfaces';
+export declare class NextBox extends EventEmitter {
+    state?: AppState;
+    debug: boolean;
+    constructor();
+    on(event: ExtensionEvents, handler: EventHandler): void;
+    off(event: ExtensionEvents, handler: EventHandler): void;
+    /**
+     * Returns the full path to download the file
+     */
+    get fileUrl(): string;
+    /**
+     * Subscribe postMessage and send an initialization event
+     */
+    init(): void;
+    /**
+     * Submit a content change message
+     * In the case when content is written before exiting the application or when writing large files
+     */
+    changeContent(state: boolean): void;
+    /**
+     * Send an event to close the editor
+     */
+    close(state: boolean): void;
+    /**
+     * @deprecated
+     */
+    download(): Promise<Response | Pick<Response, "text">>;
+    /**
+     * Submit a file download request
+     */
+    fileDownload(): Promise<Response | Pick<Response, 'text'>>;
+    /**
+     * @deprecated
+     */
+    replace(body: any): Promise<Response | null>;
+    /**
+     * Submit a file change request
+     */
+    fileReplace(body: any): Promise<Response | null>;
+    private subscribeEvent;
+}

package/event-emitter.d.ts

@@ -0,0 +1,7 @@
+export type EventHandler = (...args: any) => void;
+export declare class EventEmitter {
+    _handlers: Map<string, Set<EventHandler>>;
+    on(event: string, handler: EventHandler): void;
+    off(event: string, handler: EventHandler): void;
+    emit(event: string, ...args: any): void;
+}

package/helpers.d.ts

@@ -0,0 +1,2 @@
+import { TransportEventPayload, AppEvents } from './interfaces';
+export declare function sendEvent(event: AppEvents, payload?: TransportEventPayload): void;

package/index.d.ts

@@ -1,2 +1,5 @@
-export * from './file-api';
 export * from './interfaces';
+export * from './init';
+export * from './event-emitter';
+export * from './helpers';
+export * from './app';

package/index.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.PolymaticaApi=t():e.PolymaticaApi=t()}(globalThis,(()=>(()=>{"use strict";var e={437:(e,t,n)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.initFileApi=void 0;var o=n(679);t.initFileApi=function(){return new Promise((function(e){parent!==window?(parent.postMessage({event:o.TransportEventType.Init},window.location.origin),window.addEventListener("message",(function(t){t.data.event===o.TransportEventType.Ready&&e(new r(t.data.payload))}))):e(new r)}))};var r=function(){function e(e){this.payload=e}return Object.defineProperty(e.prototype,"fileUrl",{get:function(){var e;return(null===(e=this.payload)||void 0===e?void 0:e.file_download_uri)||""},enumerable:!1,configurable:!0}),e.prototype.download=function(){return this.payload?fetch(this.payload.file_download_uri,{method:this.payload.file_download_method}):new Promise((function(e){return{text:function(){return""}}}))},e.prototype.replace=function(e){return this.payload?fetch(this.payload.file_replace_uri,{method:this.payload.file_replace_method,body:e}):new Promise((function(e){e(null)}))},e}()},607:function(e,t,n){var o=this&&this.__createBinding||(Object.create?function(e,t,n,o){void 0===o&&(o=n);var r=Object.getOwnPropertyDescriptor(t,n);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[n]}}),Object.defineProperty(e,o,r)}:function(e,t,n,o){void 0===o&&(o=n),e[o]=t[n]}),r=this&&this.__exportStar||function(e,t){for(var n in e)"default"===n||Object.prototype.hasOwnProperty.call(t,n)||o(t,e,n)};Object.defineProperty(t,"__esModule",{value:!0}),r(n(437),t),r(n(679),t)},679:(e,t)=>{var n,o;Object.defineProperty(t,"__esModule",{value:!0}),t.State=t.TransportEventType=void 0,(o=t.TransportEventType||(t.TransportEventType={})).Init="init",o.Ready="ready",o.ChangeState="change-state",o.ChangeContent="change-content",(n=t.State||(t.State={})).view="view",n.edit="edit"}},t={};return function n(o){var r=t[o];if(void 0!==r)return r.exports;var i=t[o]={exports:{}};return e[o].call(i.exports,i,i.exports,n),i.exports}(607)})()));
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.PolymaticaApi=t():e.PolymaticaApi=t()}(globalThis,(()=>(()=>{"use strict";var e={752:function(e,t,n){var o,i=this&&this.__extends||(o=function(e,t){return o=Object.setPrototypeOf||{__proto__:[]}instanceof Array&&function(e,t){e.__proto__=t}||function(e,t){for(var n in t)Object.prototype.hasOwnProperty.call(t,n)&&(e[n]=t[n])},o(e,t)},function(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Class extends value "+String(t)+" is not a constructor or null");function n(){this.constructor=e}o(e,t),e.prototype=null===t?Object.create(t):(n.prototype=t.prototype,new n)});Object.defineProperty(t,"__esModule",{value:!0}),t.NextBox=void 0;var r=n(139),s=n(382),a=n(679),u=function(e){function t(){var t=e.call(this)||this;return t.debug=!1,t}return i(t,e),t.prototype.on=function(t,n){return e.prototype.on.call(this,t,n)},t.prototype.off=function(t,n){return e.prototype.off.call(this,t,n)},Object.defineProperty(t.prototype,"fileUrl",{get:function(){var e;return(null===(e=this.state)||void 0===e?void 0:e.file_download_uri)||""},enumerable:!1,configurable:!0}),t.prototype.init=function(){this.subscribeEvent(),(0,s.sendEvent)(a.AppEvents.Init)},t.prototype.changeContent=function(e){(0,s.sendEvent)(a.AppEvents.ChangeContent,e)},t.prototype.close=function(e){(0,s.sendEvent)(a.AppEvents.Close,e)},t.prototype.download=function(){return this.fileDownload()},t.prototype.fileDownload=function(){return this.state?fetch(this.state.file_download_uri,{method:this.state.file_download_method}):new Promise((function(e){return{text:function(){return""}}}))},t.prototype.replace=function(e){return this.fileReplace(e)},t.prototype.fileReplace=function(e){return this.state?fetch(this.state.file_replace_uri,{method:this.state.file_replace_method,body:e}):new Promise((function(e){e(null)}))},t.prototype.subscribeEvent=function(){var e=this;window.addEventListener("message",(function(t){var n=t.data.event,o=t.data.payload;switch(e.debug&&console.log("frame.message",t.data),n){case a.ExtensionEvents.Ready:e.debug=o.debug,e.emit(a.ExtensionEvents.Ready);break;case a.ExtensionEvents.ChangeView:e.state&&(e.state.view=o)}}))},t}(r.EventEmitter);t.NextBox=u},139:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.EventEmitter=void 0;var n=function(){function e(){this._handlers=new Map}return e.prototype.on=function(e,t){var n;this._handlers.has(e)||this._handlers.set(e,new Set),null===(n=this._handlers.get(e))||void 0===n||n.add(t)},e.prototype.off=function(e,t){var n;null===(n=this._handlers.get(e))||void 0===n||n.delete(t)},e.prototype.emit=function(e){for(var t=[],n=1;n<arguments.length;n++)t[n-1]=arguments[n];this._handlers.get(e)},e}();t.EventEmitter=n},382:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.sendEvent=void 0,t.sendEvent=function(e,t){parent!==window&&parent.postMessage({event:e,payload:t},window.location.origin)}},607:function(e,t,n){var o=this&&this.__createBinding||(Object.create?function(e,t,n,o){void 0===o&&(o=n);var i=Object.getOwnPropertyDescriptor(t,n);i&&!("get"in i?!t.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return t[n]}}),Object.defineProperty(e,o,i)}:function(e,t,n,o){void 0===o&&(o=n),e[o]=t[n]}),i=this&&this.__exportStar||function(e,t){for(var n in e)"default"===n||Object.prototype.hasOwnProperty.call(t,n)||o(t,e,n)};Object.defineProperty(t,"__esModule",{value:!0}),i(n(679),t),i(n(178),t),i(n(139),t),i(n(382),t),i(n(752),t)},178:(e,t,n)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.initFileApi=t.init=void 0;var o=n(752),i=n(679);function r(){var e=new o.NextBox;return e.init(),e}t.init=r,t.initFileApi=function(){return new Promise((function(e){var t=r();t.on(i.ExtensionEvents.Ready,(function(){e(t)}))}))}},679:(e,t)=>{var n,o,i;Object.defineProperty(t,"__esModule",{value:!0}),t.ViewState=t.ExtensionEvents=t.AppEvents=void 0,(i=t.AppEvents||(t.AppEvents={})).Init="init",i.ChangeContent="change-content",i.Close="close",(o=t.ExtensionEvents||(t.ExtensionEvents={})).Ready="ready",o.ChangeView="change-view",o.SaveAndClose="save-and-close",(n=t.ViewState||(t.ViewState={})).view="view",n.edit="edit"}},t={};return function n(o){var i=t[o];if(void 0!==i)return i.exports;var r=t[o]={exports:{}};return e[o].call(r.exports,r,r.exports,n),r.exports}(607)})()));

package/init.d.ts

@@ -0,0 +1,6 @@
+import { NextBox } from './app';
+export declare function init(): NextBox;
+/**
+ * @deprecated
+ */
+export declare function initFileApi(): Promise<NextBox>;

package/interfaces.d.ts

@@ -1,21 +1,26 @@
-export declare enum TransportEventType {
+export declare enum AppEvents {
     Init = "init",
+    ChangeContent = "change-content",
+    Close = "close"
+}
+export declare enum ExtensionEvents {
     Ready = "ready",
-    ChangeState = "change-state",
-    ChangeContent = "change-content"
+    ChangeView = "change-view",
+    SaveAndClose = "save-and-close"
 }
 export interface TransportEvent {
     uid?: string;
-    event: TransportEventType;
+    event: AppEvents | ExtensionEvents;
     payload?: TransportEventPayload;
 }
-export type TransportEventPayload = PayloadReady | State | any;
-export declare enum State {
+export declare enum ViewState {
     view = "view",
     edit = "edit"
 }
-export interface PayloadReady {
-    state: State;
+export type TransportEventPayload = AppState | ViewState | any;
+export interface AppState {
+    debug: boolean;
+    view: ViewState;
     file_download_uri: string;
     file_download_method: string;
     file_replace_uri: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "next-box",
-    "version": "1.0.14",
+    "version": "1.1.1",
     "description": "",
     "main": "index.js",
     "types": "index.d.ts",

package/file-api.d.ts

@@ -1,13 +0,0 @@
-import { PayloadReady } from './interfaces';
-export declare function initFileApi(): Promise<FileApi>;
-declare class FileApi {
-    private payload?;
-    constructor(payload?: PayloadReady);
-    get fileUrl(): string;
-    download(): Promise<Response | downloadResponse>;
-    replace(body: any): Promise<Response | null>;
-}
-interface downloadResponse {
-    text: () => string;
-}
-export {};