@types/plupload - npm Package Compare versions

Comparing version 2.0.4 to 2.0.5

plupload/index.d.ts

@@ -21,3 +21,3 @@ // Type definitions for Plupload 2.0
     /** Chunk */
-    chunk_size?: number|string;
+    chunk_size?: number | string;
 
@@ -32,3 +32,3 @@ /** Client-Side Image Resize */
     multi_selection?: boolean;
-    required_features?: string|any;
+    required_features?: string | any;
     unique_names?: boolean;
@@ -49,3 +49,3 @@
     mime_types?: plupload_filters_mime_types[];
-    max_file_size?: number|string;
+    max_file_size?: number | string;
     prevent_duplicates?: boolean;
@@ -79,27 +79,27 @@ }
 interface plupload_event {
-    (uploader: plupload): any;
+    (uploader: plupload.Uploader): any;
 }
 
 interface plupload_event_file {
-    (uploader: plupload, file: any): any;
+    (uploader: plupload.Uploader, file: any): any;
 }
 
 interface plupload_event_files {
-    (uploader: plupload, files: any[]): any;
+    (uploader: plupload.Uploader, files: any[]): any;
 }
 
 interface plupload_event_OptionChanged {
-    (uploader: plupload, name: string, value: any, oldValue: any): any;
+    (uploader: plupload.Uploader, name: string, value: any, oldValue: any): any;
 }
 
 interface plupload_event_FileUploaded {
-    (uploader: plupload, file: any, response: plupload_response): any;
+    (uploader: plupload.Uploader, file: any, response: plupload_response): any;
 }
 
 interface plupload_event_ChunkUploaded {
-    (uploader: plupload, file: any, response: plupload_chunk_response): any;
+    (uploader: plupload.Uploader, file: any, response: plupload_chunk_response): any;
 }
 
 interface plupload_event_Error {
-    (uploader: plupload, error: plupload_error): any;
+    (uploader: plupload.Uploader, error: plupload_error): any;
 }
@@ -144,59 +144,353 @@
 
-declare class plupload {
-    static Uploader(settings: plupload_settings):void;
+declare namespace plupload {
 
-    static VERSION: string;
+    class Uploader {
 
-    static STOPPED: number;
-    static STARTED: number;
-    static QUEUED: number;
-    static UPLOADING: number;
-    static FAILED: number;
-    static DONE: number;
-    static GENERIC_ERROR: number;
-    static HTTP_ERROR: number;
-    static IO_ERROR: number;
-    static SECURITY_ERROR: number;
-    static INIT_ERROR: number;
-    static FILE_SIZE_ERROR: number;
-    static FILE_EXTENSION_ERROR: number;
-    static FILE_DUPLICATE_ERROR: number;
-    static IMAGE_FORMAT_ERROR: number;
-    static MEMORY_ERROR: number;
-    static IMAGE_DIMENSIONS_ERROR: number;
+        constructor(settings: plupload_settings);
 
-    static mimeTypes: any;
-    static ua: any;
+        /** Properties */
+        id: string;
+        state: number;
+        features: string;
+        runtime: string;
+        files: any;
+        settings: any;
+        total: plupload_queue_progress;
 
-    static typeOf(o: any): string;
-    static extend(target: any): any;
-    static guid(guid: string): string;
+        /** Methods */
+        init(): any;
+        setOption(option: string | any, value?: any): any;
+        getOption(option?: string): any;
+        refresh(): any;
+        start(): any;
+        stop(): any;
+        disableBrowse(disable: boolean): any;
+        getFile(id: string): any;
+        addFile(file: any, fileName?: string): any;
+        removeFile(file: any): any;
+        splice(start?: number, length?: number): any;
+        trigger(name: string, Multiple: any): any;
+        hasEventListener(name: string): any;
+        bind(name: string, func: any, scope?: any): any;
+        unbind(name: string, func: any): any;
+        unbindAll(): any;
+        destroy(): any;
+    }
 
-    /** Properties */
-    id: string;
-    state: number;
-    features: string;
-    runtime: string;
-    files: any;
-    settings: any;
-    total: plupload_queue_progress;
+    export const VERSION: string;
 
-    /** Methods */
-    init(): any;
-    setOption(option: string|any, value?: any): any;
-    getOption(option?: string): any;
-    refresh(): any;
-    start(): any;
-    stop(): any;
-    disableBrowse(disable: boolean): any;
-    getFile(id: string): any;
-    addFile(file: any, fileName?: string): any;
-    removeFile(file: any): any;
-    splice(start?: number, length?: number): any;
-    trigger(name: string, Multiple: any): any;
-    hasEventListener(name: string): any;
-    bind(name: string, func: any, scope: any): any;
-    unbind(name: string, func: any): any;
-    unbindAll(): any;
-    destroy(): any;
+    export const STOPPED: number;
+    export const STARTED: number;
+    export const QUEUED: number;
+    export const UPLOADING: number;
+    export const FAILED: number;
+    export const DONE: number;
+    export const GENERIC_ERROR: number;
+    export const HTTP_ERROR: number;
+    export const IO_ERROR: number;
+    export const SECURITY_ERROR: number;
+    export const INIT_ERROR: number;
+    export const FILE_SIZE_ERROR: number;
+    export const FILE_EXTENSION_ERROR: number;
+    export const FILE_DUPLICATE_ERROR: number;
+    export const IMAGE_FORMAT_ERROR: number;
+    export const MEMORY_ERROR: number;
+    export const IMAGE_DIMENSIONS_ERROR: number;
+
+    export const mimeTypes: any;
+    export const ua: any;
+
+    /**
+     * Gets the true type of the built-in object (better version of typeof).
+     * @credits Angus Croll (http://javascriptweblog.wordpress.com/)
+     *
+     * @method typeOf
+     * @static
+     * @param {Object} o Object to check.
+     * @return {String} Object [[Class]]
+     */
+    function typeOf(o: any): string;
+
+    /**
+     * Extends the specified object with another object.
+     *
+     * @method extend
+     * @static
+     * @param {Object} target Object to extend.
+     * @param {Object..} obj Multiple objects to extend with.
+     * @return {Object} Same as target, the extended object.
+     */
+    function extend(target: any): any;
+
+    /**
+     * Generates an unique ID. This is 99.99% unique since it takes the current time and 5 random numbers.
+     * The only way a user would be able to get the same ID is if the two persons at the same exact millisecond manages
+     * to get 5 the same random numbers between 0-65535 it also uses a counter so each call will be guaranteed to be page unique.
+     * It's more probable for the earth to be hit with an asteriod. You can also if you want to be 100% sure set the plupload.guidPrefix property
+     * to an user unique key.
+     *
+     * @method guid
+     * @static
+     * @return {String} Virtually unique id.
+     */
+    function guid(guid: string): string;
+
+    /** Utility methods **/
+
+    /**
+     * Executes the callback function for each item in array/object. If you return false in the
+     * callback it will break the loop.
+     *
+     * @method each
+     * @static
+     * @param {Object} obj Object to iterate.
+     * @param {function} callback Callback function to execute for each item.
+     */
+    function each(obj: any, callback: Function): void;
+
+    /**
+     * Returns the absolute x, y position of an Element. The position will be returned in a object with x, y fields.
+     *
+     * @method getPos
+     * @static
+     * @param {Element} node HTML element or element id to get x, y position from.
+     * @param {Element} root Optional root element to stop calculations at.
+     * @return {object} Absolute position of the specified element object with x, y fields.
+     */
+    function getPos(node: Element, root: Element): any;
+
+    /**
+     * Returns the size of the specified node in pixels.
+     *
+     * @method getSize
+     * @static
+     * @param {Node} node Node to get the size of.
+     * @return {Object} Object with a w and h property.
+     */
+    function getSize(node: Node): any;
+
+    /**
+     * Encodes the specified string.
+     *
+     * @method xmlEncode
+     * @static
+     * @param {String} s String to encode.
+     * @return {String} Encoded string.
+     */
+    function xmlEncode(str: string): string;
+
+    /**
+     * Forces anything into an array.
+     *
+     * @method toArray
+     * @static
+     * @param {Object} obj Object with length field.
+     * @return {Array} Array object containing all items.
+     */
+    function toArray(obj: any): Array<any>;
+
+    /**
+     * Find an element in array and return its index if present, otherwise return -1.
+     *
+     * @method inArray
+     * @static
+     * @param {mixed} needle Element to find
+     * @param {Array} array
+     * @return {Int} Index of the element, or -1 if not found
+     */
+    function inArray(needle: any, array: Array<any>): number;
+
+    /**
+    Recieve an array of functions (usually async) to call in sequence, each  function
+    receives a callback as first argument that it should call, when it completes. Finally,
+    after everything is complete, main callback is called. Passing truthy value to the
+    callback as a first argument will interrupt the sequence and invoke main callback
+    immediately.
+    @method inSeries
+    @static
+    @param {Array} queue Array of functions to call in sequence
+    @param {Function} cb Main callback that is called in the end, or in case of error
+    */
+    function inSeries(queue: Array<any>, callback: Function): void;
+
+    /**
+     * Extends the language pack object with new items.
+     *
+     * @method addI18n
+     * @static
+     * @param {Object} pack Language pack items to add.
+     * @return {Object} Extended language pack object.
+     */
+    function addI18n(pack: any): any;
+
+    /**
+     * Translates the specified string by checking for the english string in the language pack lookup.
+     *
+     * @method translate
+     * @static
+     * @param {String} str String to look for.
+     * @return {String} Translated string or the input string if it wasn't found.
+     */
+    function translate(str: string): string;
+
+    /**
+     * Pseudo sprintf implementation - simple way to replace tokens with specified values.
+     *
+     * @param {String} str String with tokens
+     * @return {String} String with replaced tokens
+     */
+    function sprintf(str: string): string;
+
+    /**
+     * Checks if object is empty.
+     *
+     * @method isEmptyObj
+     * @static
+     * @param {Object} obj Object to check.
+     * @return {Boolean}
+     */
+    function isEmptyObj(obj: any): boolean;
+
+    /**
+     * Checks if specified DOM element has specified class.
+     *
+     * @method hasClass
+     * @static
+     * @param {Object} obj DOM element like object to add handler to.
+     * @param {String} name Class name
+     */
+    function hasClass(obj: any, name: string): any;
+
+    /**
+     * Adds specified className to specified DOM element.
+     *
+     * @method addClass
+     * @static
+     * @param {Object} obj DOM element like object to add handler to.
+     * @param {String} name Class name
+     */
+    function addClass(obj: any, name: string): any;
+
+    /**
+     * Removes specified className from specified DOM element.
+     *
+     * @method removeClass
+     * @static
+     * @param {Object} obj DOM element like object to add handler to.
+     * @param {String} name Class name
+     */
+    function removeClass(obj: any, name: string): any;
+
+    /**
+     * Returns a given computed style of a DOM element.
+     *
+     * @method getStyle
+     * @static
+     * @param {Object} obj DOM element like object.
+     * @param {String} name Style you want to get from the DOM element
+     */
+    function getStyle(obj: any, name: string): any;
+
+    /**
+     * Adds an event handler to the specified object and store reference to the handler
+     * in objects internal Plupload registry (@see removeEvent).
+     *
+     * @method addEvent
+     * @static
+     * @param {Object} obj DOM element like object to add handler to.
+     * @param {String} name Name to add event listener to.
+     * @param {Function} callback Function to call when event occurs.
+     * @param {String} (optional) key that might be used to add specifity to the event record.
+     */
+    function addEvent(obj: any, name: string, callback: Function, key?: string): any;
+
+    /**
+     * Remove event handler from the specified object. If third argument (callback)
+     * is not specified remove all events with the specified name.
+     *
+     * @method removeEvent
+     * @static
+     * @param {Object} obj DOM element to remove event listener(s) from.
+     * @param {String} name Name of event listener to remove.
+     * @param {Function|String} (optional) might be a callback or unique key to match.
+     */
+    function removeEvent(obj: any, name: string, optional?: Function | string): any;
+
+    /**
+     * Remove all kind of events from the specified object
+     *
+     * @method removeAllEvents
+     * @static
+     * @param {Object} obj DOM element to remove event listeners from.
+     * @param {String} (optional) unique key to match, when removing events.
+     */
+    function removeAllEvents(obj: any, key?: string): any;
+
+    /**
+     * Cleans the specified name from national characters (diacritics). The result will be a name with only a-z, 0-9 and _.
+     *
+     * @method cleanName
+     * @static
+     * @param {String} s String to clean up.
+     * @return {String} Cleaned string.
+     */
+    function cleanName(name: string): string;
+
+    /**
+     * Builds a full url out of a base URL and an object with items to append as query string items.
+     *
+     * @method buildUrl
+     * @static
+     * @param {String} url Base URL to append query string items to.
+     * @param {Object} items Name/value object to serialize as a querystring.
+     * @return {String} String with url + serialized query string items.
+     */
+    function buildUrl(url: string, items: any): string;
+
+    /**
+     * Formats the specified number as a size string for example 1024 becomes 1 KB.
+     *
+     * @method formatSize
+     * @static
+     * @param {Number} size Size to format as string.
+     * @return {String} Formatted size string.
+     */
+    function formatSize(size: number): string;
+
+    /**
+     * Parses the specified size string into a byte value. For example 10kb becomes 10240.
+     *
+     * @method parseSize
+     * @static
+     * @param {String|Number} size String to parse or number to just pass through.
+     * @return {Number} Size in bytes.
+     */
+    function parseSize(size: number | string): number;
+
+
+    /**
+     * A way to predict what runtime will be choosen in the current environment with the
+     * specified settings.
+     *
+     * @method predictRuntime
+     * @static
+     * @param {Object|String} config Plupload settings to check
+     * @param {String} [runtimes] Comma-separated list of runtimes to check against
+     * @return {String} Type of compatible runtime
+     */
+    function predictRuntime(config: any, runtimes: string): string;
+
+    /**
+     * Registers a filter that will be executed for each file added to the queue.
+     * If callback returns false, file will not be added.
+     *
+     * Callback receives two arguments: a value for the filter as it was specified in settings.filters
+     * and a file to be filtered. Callback is executed in the context of uploader instance.
+     *
+     * @method addFileFilter
+     * @static
+     * @param {String} name Name of the filter by which it can be referenced in settings.filters
+     * @param {String} cb Callback - the actual routine that every added file must pass
+     */
+    function addFileFilter(name: string, cb: Function): void;
 }

plupload/package.json

 {
     "name": "@types/plupload",
-    "version": "2.0.4",
+    "version": "2.0.5",
     "description": "TypeScript definitions for Plupload",
@@ -9,3 +9,4 @@ "license": "MIT",
             "name": "Patrick Bußmann",
-            "url": "https://github.com/patrickbussmann"
+            "url": "https://github.com/patrickbussmann",
+            "githubUsername": "patrickbussmann"
         }
@@ -20,4 +21,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "7baab984198fa5cbd971b55120c6cd3df15efb991c5b77586e642da82753d71b",
+    "typesPublisherContentHash": "4d7283e2337442f602fc464983b3a5143d7159072185953f30a1884b06a35080",
     "typeScriptVersion": "2.0"
 }

plupload/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Mon, 21 Aug 2017 21:59:27 GMT
+ * Last updated: Thu, 05 Apr 2018 19:55:58 GMT
  * Dependencies: none
@@ -14,0 +14,0 @@ * Global values: plupload

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18032

increased by153.01%

Lines of code

430

increased by159.04%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes