nexusframework 0.3.0-beta.72 → 0.3.0-beta.74

package/scripts/index.d.ts

@@ -1,251 +1,259 @@
-/// <reference types="socket.io-client" />
-/// <reference types="jquery" />
-
-declare interface NexusFrameworkResource {
-    name: string;
-    type: string;
-    source: string;
-    inline?: boolean;
-    integrity?: string;
-    dependencies: string[];
-}
-declare interface NexusFrameworkLoaderData {
-    [0]: string[];
-    [1]: NexusFrameworkResource[];
-}
-declare interface NexusFrameworkLoader {
-    load(data: NexusFrameworkLoaderData, onsuccess?: () => void): void;
-    /**
-     * Loads a resource.
-     * Downloads the file asynchroniously and reads any header for @ tags.
-     * After that, queues it for download, and returns an info object for the script when complete.
-     *
-     * @param type The type, script or style
-     * @param name The name of the resource
-     * @param source The source of the resource
-     * @param cb The callback
-     * @param deps The dependencies
-     * @param inlineOrVersion True or String, inline or version.
-     */
-    loadResource(type: string, script: string, cb?: (err?: Error) => void, deps?: string[], inlineOrIntegrity?: boolean | string, name?: string): void;
-    /**
-     * Queries the list of requested resources.
-     * Each resource is listed as `type:name`.
-     */
-    requestedResources(): string[];
-    /**
-     * Get the source for a given resource.
-     */
-    resourceSource(key: string): string;
-    /**
-     * Show the specified error to the user.
-     */
-    showError(err: Error): HTMLElement | HTMLCollection;
-    /**
-     * Clear the error screen.
-     */
-    resetError(): void;
-    /**
-     * Show the specified error to the user.
-     */
-    showProgress(cb?: () => void, title?: string, message?: string): HTMLElement | HTMLCollection;
-    /**
-     * Clear the error screen.
-     */
-    resetProgress(): void;
-}
-declare interface NexusFrameworkTransportResponse {
-    /**
-     * The response url.
-     */
-    readonly url: string;
-    /**
-     * The response code;
-     */
-    readonly code: number;
-    /**
-     * Parses a JSON representation from the response string or throws an error.
-     */
-    readonly contentFromJSON: any;
-    /**
-     * The content as a String.
-     */
-    readonly contentAsString: string;
-    /**
-      * The length in bytes of
-      */
-    readonly contentLength: number;
-    /**
-     * A map of response headers, each header can occur more than once.
-     */
-    readonly headers: {[index: string]: string[]};
-    /**
-      * Whether or not this request posted data.
-      */
-    readonly hadData?: boolean;
-}
-declare interface NexusFrameworkPageSystemResponse {
-    data: any;
-    code: number;
-    headers: {[index: string]: string[]};
-}
-declare interface NexusFrameworkPageSystemOptions {
-    /**
-     * Override the built in way of handling page responses.
-     *
-     * @returns True when handled correctly, false to reload the page to the request url.
-     */
-    handler?: (res: NexusFrameworkTransportResponse, contentReady: (err?: Error) => void) => void;
-    /**
-     * Method to call before attempting to make a page request.
-     *
-     * @returns True to continue, False to abort.
-     */
-    prerequest?: (path: string) => boolean;
-    /**
-     * Disables using the loader-progress elements.
-     */
-    noprogress?: boolean;
-    /**
-     * Disables using SocketIO for the Page System.
-     * The Page System over SocketIO cannot pass some HttpOnly cookies,
-     * as such this might be required for some websites.
-     */
-    nopagesysio?: boolean;
-    /**
-     * The timing in milliseconds the page transition animation will take.
-     * Defaults to 500.
-     */
-    animationTiming?: number;
-    /**
-      * The size in bytes worth of data to allow storing for caching page history.
-      * Defaults to 25000000 (25mb)
-      */
-    pageHistoryCacheSize?: number;
-    /**
-     * Disables using SocketIO, which would be used otherwise, when available
-     */
-    noio?: boolean;
-}
-declare interface NexusFrameworkEvents {
-  /**
-   * Add an event listener for when pages are loaded via the dynamic page system.
-   */
-  on(event: "page", cb: (baseurl: string, path: string) => void): void;
-  /**
-   * Add an event listener for a specific event.
-   */
-  on(event: string, cb: (...args: any[]) => void): void;
-  /**
-   * Remove a event listener for when pages are loaded via the dynamic page system.
-   */
-  off(event: "page", cb: (baseurl: string, path: string) => void): void;
-  /**
-   * Remove n event listener for a specific event.
-   */
-  off(event: string, cb: (...args: any[]) => void): void;
-}
-/*declare interface NexusFrameworkComponentHelper extends NexusFrameworkEvents {
-
-}*/
-declare interface NexusFrameworkComponent {
-    create(element: HTMLElement/*, createHelper: () => NexusFrameworkComponentHelper*/): void;
-    destroy(): void;
-
-    restore(data: any): void;
-    save(): any;
-}
-declare interface NexusFrameworkComponentFactory {
-    new (): NexusFrameworkComponent;
-}
-declare interface NexusFrameworkAnalyticsAdapter {
-    reportError(err: Error): void;
-    reportPage(path?: string): void;
-    reportEvent(category: string, action: string, label?: string, value?: number): void;
-}
-declare interface NexusFrameworkClient extends NexusFrameworkEvents {
-    /**
-     * The Socket.IO instance, if enabled and available.
-     */
-    readonly io: SocketIOClient.Socket;
-    /**
-     * The base URL for this client.
-     */
-    readonly url: string;
-    /**
-     * The analytics adapter.
-     */
-    analytics: NexusFrameworkAnalyticsAdapter;
-
-    /**
-     * Initialize the page system.
-     */
-    initPageSystem(opts?: NexusFrameworkPageSystemOptions): void;
-    /**
-     * Loads a page, relative to the root URL for the website.
-     */
-    requestPage(path: string, post?: any): void;
-
-    /**
-     * Register a component by selector.
-     */
-    registerComponent(selector: string, impl: NexusFrameworkComponentFactory): void;
-    /**
-     * Unregister a component by selector.
-     */
-    unregisterComponent(selector: string, impl: NexusFrameworkComponentFactory): void;
-    /**
-     * Initialize and create all components within root
-     */
-    createComponents(root: HTMLElement): void;
-    /**
-     * Destroy all components within root
-     */
-    destroyComponents(root: HTMLElement): void;
-    /**
-     * Save components in root into a state object
-     */
-    saveComponents(root: HTMLElement): Object;
-    /**
-     * Restore components in root from a state object
-     */
-    restoreComponents(root: HTMLElement, state: Object): void;
-
-    /**
-     * Disable an element and its children.
-     *
-     * @param root The root element, by default document.body
-     */
-    disableAll(root?: HTMLElement): void;
-    /**
-     * Enable an element and its children.
-     *
-     * @param root The root element, by default document.body
-     */
-    enableAll(root?: HTMLElement): void;
-
-    /**
-     * Remove a event listener for when pages are loaded via the dynamic page system.
-     */
-    emit(event: string, ...args: any[]): void;
-}
-declare interface NexusFrameworkTransport {
-    get(url: string, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number) => void): void;
-    head(url: string, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number) => void): void;
-    put(url: string, data: any, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number) => void): void;
-    post(url: string, data: any, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number) => void): void;
-    execute(method: string, url: string, data: any, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number) => void): void;
-    del(url: string, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number) => void): void;
-}
-declare interface GoogleAnalytics {
-    (cmd: string, ...args: any[]): void;
-}
-declare interface Window {
-    NexusFrameworkImpl?: any;
-    NexusFrameworkLoader?: NexusFrameworkLoader;
-    NexusFrameworkTransport?: NexusFrameworkTransport;
-    NexusFrameworkClient?: NexusFrameworkClient;
-    io?: SocketIOClientStatic;
-    jQuery?: JQueryStatic;
-    ga?: GoogleAnalytics;
-}
+/// <reference types="socket.io-client" />
+/// <reference types="jquery" />
+
+declare interface NexusFrameworkResource {
+    name: string;
+    type: string;
+    source: string;
+    inline?: boolean;
+    integrity?: string;
+    dependencies: string[];
+}
+declare interface NexusFrameworkLoaderData {
+    [0]: string[];
+    [1]: NexusFrameworkResource[];
+}
+declare interface NexusFrameworkLoader {
+    load(data: NexusFrameworkLoaderData, onsuccess?: () => void): void;
+    /**
+     * Loads a resource.
+     * Downloads the file asynchroniously and reads any header for @ tags.
+     * After that, queues it for download, and returns an info object for the script when complete.
+     *
+     * @param type The type, script or style
+     * @param name The name of the resource
+     * @param source The source of the resource
+     * @param cb The callback
+     * @param deps The dependencies
+     * @param inlineOrVersion True or String, inline or version.
+     */
+    loadResource(type: string, script: string, cb?: (err?: Error) => void, deps?: string[], inlineOrIntegrity?: boolean | string, name?: string): void;
+    /**
+     * Queries the list of requested resources.
+     * Each resource is listed as `type:name`.
+     */
+    requestedResources(): string[];
+    /**
+     * Get the source for a given resource.
+     */
+    resourceSource(key: string): string;
+    /**
+     * Show the specified error to the user.
+     */
+    showError(err: Error): HTMLElement | HTMLCollection;
+    /**
+     * Clear the error screen.
+     */
+    resetError(): void;
+    /**
+     * Show the specified error to the user.
+     */
+    showProgress(cb?: () => void, title?: string, message?: string): HTMLElement | HTMLCollection;
+    /**
+     * Clear the error screen.
+     */
+    resetProgress(): void;
+}
+declare interface NexusFrameworkTransportResponse {
+    /**
+     * The response url.
+     */
+    readonly url: string;
+    /**
+     * The response code;
+     */
+    readonly code: number;
+    /**
+     * Parses a JSON representation from the response string or throws an error.
+     */
+    readonly contentFromJSON: any;
+    /**
+     * Parses a BSON representation from the response string or throws an error.
+     */
+    readonly contentFromBSON: any;
+    /**
+     * The content as a String.
+     */
+    readonly contentAsString: string;
+    /**
+     * The content as an ArrayBuffer.
+     */
+    readonly contentAsArrayBuffer: ArrayBuffer;
+    /**
+      * The length in bytes of
+      */
+    readonly contentLength: number;
+    /**
+     * A map of response headers, each header can occur more than once.
+     */
+    readonly headers: {[index: string]: string[]};
+    /**
+      * Whether or not this request posted data.
+      */
+    readonly hadData?: boolean;
+}
+declare interface NexusFrameworkPageSystemResponse {
+    data: any;
+    code: number;
+    headers: {[index: string]: string[]};
+}
+declare interface NexusFrameworkPageSystemOptions {
+    /**
+     * Override the built in way of handling page responses.
+     *
+     * @returns True when handled correctly, false to reload the page to the request url.
+     */
+    handler?: (res: NexusFrameworkTransportResponse, contentReady: (err?: Error) => void) => void;
+    /**
+     * Method to call before attempting to make a page request.
+     *
+     * @returns True to continue, False to abort.
+     */
+    prerequest?: (path: string) => boolean;
+    /**
+     * Disables using the loader-progress elements.
+     */
+    noprogress?: boolean;
+    /**
+     * The timing in milliseconds the page transition animation will take.
+     * Defaults to 500.
+     */
+    animationTiming?: number;
+    /**
+      * The size in bytes worth of data to allow storing for caching page history.
+      * Defaults to 25000000 (25mb)
+      */
+    pageHistoryCacheSize?: number;
+    /**
+     * Disables using SocketIO for the Page System.
+     * The Page System over SocketIO cannot pass some HttpOnly cookies,
+     * as such this might be required for some websites.
+     */
+    noio?: boolean;
+}
+declare interface NexusFrameworkEvents {
+  /**
+   * Add an event listener for when pages are loaded via the dynamic page system.
+   */
+  on(event: "page", cb: (baseurl: string, path: string) => void): void;
+  /**
+   * Add an event listener for a specific event.
+   */
+  on(event: string, cb: (...args: any[]) => void): void;
+  /**
+   * Remove a event listener for when pages are loaded via the dynamic page system.
+   */
+  off(event: "page", cb: (baseurl: string, path: string) => void): void;
+  /**
+   * Remove n event listener for a specific event.
+   */
+  off(event: string, cb: (...args: any[]) => void): void;
+}
+/*declare interface NexusFrameworkComponentHelper extends NexusFrameworkEvents {
+
+}*/
+declare interface NexusFrameworkComponent {
+    create(element: HTMLElement/*, createHelper: () => NexusFrameworkComponentHelper*/): void;
+    destroy(): void;
+
+    restore(data: any): void;
+    save(): any;
+}
+declare interface NexusFrameworkComponentFactory {
+    new (): NexusFrameworkComponent;
+}
+declare interface NexusFrameworkAnalyticsAdapter {
+    reportError(err: Error): void;
+    reportPage(path?: string): void;
+    reportEvent(category: string, action: string, label?: string, value?: number): void;
+}
+declare interface NexusFrameworkClient extends NexusFrameworkEvents {
+    /**
+     * The Socket.IO instance, if enabled and available.
+     */
+    readonly io: SocketIOClient.Socket;
+    /**
+     * The base URL for this client.
+     */
+    readonly url: string;
+    /**
+      * The ID of the current user, if any.
+      */
+    readonly currentUser: string | undefined;
+    /**
+     * The analytics adapter.
+     */
+    analytics: NexusFrameworkAnalyticsAdapter;
+
+    /**
+     * Initialize the page system.
+     */
+    initPageSystem(opts?: NexusFrameworkPageSystemOptions): void;
+    /**
+     * Loads a page, relative to the root URL for the website.
+     */
+    requestPage(path: string, post?: any): void;
+
+    /**
+     * Register a component by selector.
+     */
+    registerComponent(selector: string, impl: NexusFrameworkComponentFactory): void;
+    /**
+     * Unregister a component by selector.
+     */
+    unregisterComponent(selector: string, impl: NexusFrameworkComponentFactory): void;
+    /**
+     * Initialize and create all components within root
+     */
+    createComponents(root: HTMLElement): void;
+    /**
+     * Destroy all components within root
+     */
+    destroyComponents(root: HTMLElement): void;
+    /**
+     * Save components in root into a state object
+     */
+    saveComponents(root: HTMLElement): Object;
+    /**
+     * Restore components in root from a state object
+     */
+    restoreComponents(root: HTMLElement, state: Object): void;
+
+    /**
+     * Disable an element and its children.
+     *
+     * @param root The root element, by default document.body
+     */
+    disableAll(root?: HTMLElement): void;
+    /**
+     * Enable an element and its children.
+     *
+     * @param root The root element, by default document.body
+     */
+    enableAll(root?: HTMLElement): void;
+
+    /**
+     * Remove a event listener for when pages are loaded via the dynamic page system.
+     */
+    emit(event: string, ...args: any[]): void;
+}
+declare interface NexusFrameworkTransport {
+    get(url: string, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number) => void, wantsBinary?: boolean): void;
+    head(url: string, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number) => void, wantsBinary?: boolean): void;
+    put(url: string, data: any, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number) => void, wantsBinary?: boolean): void;
+    post(url: string, data: any, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number) => void, wantsBinary?: boolean): void;
+    execute(method: string, url: string, data: any, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number, wantsBinary?: boolean) => void): void;
+    del(url: string, cb: (res: NexusFrameworkTransportResponse) => void, extraHeaders?: {[index: string]: string}, progcb?: (complete: number, total: number, wantsBinary?: boolean) => void): void;
+}
+declare interface GoogleAnalytics {
+    (cmd: string, ...args: any[]): void;
+}
+declare interface Window {
+    NexusFrameworkImpl?: any;
+    NexusFrameworkLoader?: NexusFrameworkLoader;
+    NexusFrameworkTransport?: NexusFrameworkTransport;
+    NexusFrameworkClient?: NexusFrameworkClient;
+    io?: SocketIOClientStatic;
+    jQuery?: JQueryStatic;
+    ga?: GoogleAnalytics;
+}

package/scripts/src/compat.ts

@@ -0,0 +1,62 @@
+/// <reference path="../index.d.ts" />
+(function(window) {
+  var Buffer;
+  const TextDecoder: {new (encoding: string): TextDecoder} = window['TextDecoder'];
+  const TextEncoder: {new (encoding: string): TextEncoder} = window['TextEncoder'];
+  class BufferBase extends Uint8Array {
+    static isBuffer(object: any) {
+      return object instanceof Buffer;
+    }
+    slice(start = 0, end = this.length) {
+      return new Buffer(this.buffer.slice(start, end));
+    }
+    write(index: number, val: number) {
+      this[index] = val;
+    }
+    copy(from: Uint8Array, offset = 0, start = 0, end = from.length) {
+      const copylen = end - start + offset;
+      for(var i=offset; i<copylen; i++)
+        this[offset] = from[start + i];
+    }
+  }
+  if (TextDecoder && TextEncoder) {
+    class BufferImpl extends BufferBase {
+      toString(encoding?: string, start = 0, end = this.length) {
+        const decoder = new TextDecoder(encoding);
+        if (start > 0 || end < this.length)
+          return decoder.decode(this.slice(start, end));
+        return decoder.decode(this);
+      }
+    }
+    ((Buffer = BufferImpl) as any)['from'] = function(data, encoding = "utf8") {
+      const encoder = new TextEncoder(encoding);
+      const encoded = encoder.encode(data);
+      const buffer = new Buffer(encoded.length);
+      buffer.copy(encoded);
+      return buffer;
+    };
+  } else {
+    class BufferImpl extends BufferBase {
+      toString(encoding?: string, start = 0, end = this.length) {
+        var str = "";
+        for(var i=start; i<end; i++)
+          str += String.fromCharCode(this[i]);
+        return str;
+      }
+    }
+    ((Buffer = BufferImpl) as any)['from'] = function(data, encoding = "utf8") {
+      if (encoding === "utf8") {
+        data = "" + data;
+        const len = data.length;
+        const buff = new Buffer(len);
+        for(var i=0; i<len; i++)
+          buff[i] = data.charCodeAt(i) & 0xFF;
+        console.log(buff);
+        return buff;
+      } else
+        return new Buffer(data);
+    };
+  }
+  window['Buffer'] = Buffer;
+  window['global'] = window;
+})(window);