@qikdev/sdk 0.1.169 → 0.1.180

package/src/api/qik.core.js

@@ -0,0 +1,246 @@
+// if (process.browser) {
+
+import QikAPI from './qik.api.js';
+import QikAuth from './qik.auth.js';
+import QikUtils from './qik.utils.js';
+import QikFilter from './qik.filter.js';
+import QikFiles from './qik.files.js';
+import QikCache from './qik.cache.js';
+import QikAccess from './qik.access.js';
+import QikContent from './qik.content.js';
+import QikSystem from './qik.system.js';
+import QikGeo from './qik.geo.js';
+import QikSocket from './qik.socket.js';
+import { EventDispatcher } from './qik.utils.js';
+
+///////////////////////////////////////
+
+/**
+ * Creates a new QikCore instance including all of the default sub modules
+ * @alias qik
+ * @constructor
+ * @param {Object} options 
+ * @param {String} options.apiURL    The remote URL of the Qik API you want to connect to. Options are 'staging', 'production' or you may set a specific URL eg. 'https://api.qik.io' (do not include trailing slash). If no value is provided, will default to 'production'.
+ * @param {String} options.applicationToken When running as a static application, (for example a website) you may set the application's access token before you initialize the Qik instance here.  
+ * @example
+ *
+ * //Import the Qik package
+ * import Qik from '@qikdev/sdk';
+ *
+ * //Create a new Qik instance
+ * var qik = new Qik();
+ *
+ * //Request the current user session endpoint from the Qik API
+ * qik.api.get('/session').then(function(res) {
+ *   console.log('User session is ', res.data);
+ * })
+ * .catch(function(err) {
+ *     console.log('There was an error', err);
+ * });
+ *
+ * //Use the QikAsset package to generate an image url
+ * var link = qik.asset.imageUrl('5ca3d64dd2bb085eb9d450db', 1920, 1080)
+ */
+
+import { version } from '../version.js';
+
+export default function(options) {
+    if (!options) {
+        options = {
+            // apiURL,
+            // applicationToken,
+            // api:{}
+        }
+    }
+
+    ///////////////////////////////////////
+
+    if (!options.apiURL || !options.apiURL.length) {
+        options.apiURL = 'staging';
+    }
+
+    ///////////////////////////////////////
+
+    switch (String(options.apiURL).toLowerCase()) {
+        case 'production':
+            options.apiURL = 'https://api.qik.dev';
+            break;
+        case 'staging':
+            options.apiURL = 'https://api.staging.qik.dev';
+            break;
+        case 'local':
+            options.apiURL = 'http://api.qik.localhost:4001';
+            break;
+    }
+
+    ///////////////////////////////////////
+
+    const core = Object.assign(options, {
+        //Other options
+        // domain:'',
+        version,
+        global:{},
+    })
+
+
+    ///////////////////////////////////////
+
+    /**
+     * Provides a cache service, used for creating, clearing 
+     * and storing API requests and other information in memory
+     * @type {QikCache}
+     */
+    const cache = QikCache;
+    Object.defineProperty(core, 'cache', {
+        value: cache,
+        writable: false,
+    });
+    
+    ///////////////////////////////////////
+
+    /**
+     * Provides helper functions for working
+     * with Qik data
+     * @type {QikUtils}
+     */
+    const utils = QikUtils;
+    Object.defineProperty(core, 'utils', {
+        value: utils,
+        writable: false,
+    });
+
+    ///////////////////////////////////////
+
+    /**
+     * Provides helper functions for working
+     * with Qik filters
+     * @type {QikFilter}
+     */
+    const filter = QikFilter;
+    Object.defineProperty(core, 'filter', {
+        value: filter,
+        writable: false,
+    });
+
+
+
+    ///////////////////////////////////////
+
+    /**
+     * Provides helper functions for working
+     * with Qik files
+     * @type {QikFiles}
+     */
+    const files = new QikFiles(core);
+    Object.defineProperty(core, 'files', {
+        value: files,
+        writable: false,
+    });
+
+    ///////////////////////////////////////
+
+    //Create a new global dispatcher so we can trigger events
+    const dispatcher = new EventDispatcher();
+    dispatcher.bootstrap(core);
+
+    //Set the function
+    core.error = function(err) {
+        //Dispatch an error event
+        return core.dispatch('error', utils.errorMessage(err));
+    }
+
+    //And enable notifications with a short message
+    core.notify = function(message, options) {
+        return core.dispatch('notification', { message, options });
+    }
+
+    ///////////////////////////////////////
+
+    /**
+     * The default service for interacting with
+     * the Qik REST API, it's a wrapper around the axios library
+     * that works in conjunction with the other Qik modules
+     * @type {QikAPI}
+     */
+    const api = new QikAPI(core);
+    Object.defineProperty(core, 'api', {
+        value: api,
+        writable: false,
+    });
+
+    /**
+     * The default service for managing authentication
+     * handles automatic refreshing of access tokens, and provides login, logout
+     * and other user/application specific functionality
+     * @type {QikAuth}
+     */
+    const auth = new QikAuth(core);
+    Object.defineProperty(core, 'auth', {
+        value: auth,
+        writable: false,
+    });
+
+    /**
+     * The default service for connecting, subscribing and unsubscribing sockets
+     * @type {QikSocket}
+     */
+    const socket = new QikSocket(core);
+    Object.defineProperty(core, 'socket', {
+        value: socket,
+        writable: false,
+    });
+
+    ///////////////////////////////////////
+
+    /**
+     * A helper service for understanding a user's access permissions
+     * @type {QikAccess}
+     */
+    const access = new QikAccess(core);
+    Object.defineProperty(core, 'access', {
+        value: access,
+        writable: false,
+    });
+
+    ///////////////////////////////////////
+
+    /**
+     * A helper service for system functions and features
+     * @type {QikSystem}
+     */
+    const system = new QikSystem(core);
+    Object.defineProperty(core, 'system', {
+        value: system,
+        writable: false,
+    });
+
+    ///////////////////////////////////////
+
+    /**
+     * A helper service for geolocation features
+     * @type {QikGeo}
+     */
+    const geo = new QikGeo(core);
+    Object.defineProperty(core, 'geo', {
+        value: geo,
+        writable: false,
+    });
+
+
+    ///////////////////////////////////////
+
+    /**
+     * A helper service for content create, update, read and delete operations.
+     * @type {QikContent}
+     */
+    const content = new QikContent(core);
+    Object.defineProperty(core, 'content', {
+        value: content,
+        writable: false,
+    });
+
+    ///////////////////////////////////////
+
+    return core;
+
+}

package/src/api/qik.files.js

@@ -0,0 +1,150 @@
+
+/**
+ * Creates a new Files Module instance.
+ * This module provides a number of helper functions for interacting with binary file and media content via the REST API
+ * @alias files
+ * @constructor
+ * @hideconstructor
+ * @param {QikCore} qik A reference to the parent instance of the QikCore module. This module is usually created by a QikCore instance that passes itself in as the first argument.
+ */
+export default function(qik) {
+
+
+    ///////////////////////
+
+    var service = {};
+
+    ///////////////////////
+
+    /**
+     * 
+     * Get a valid download url for a specified record
+     * @alias files.downloadUrl
+     * @param  {String} type The type or definition of the item we want to generate the url for
+     * @param  {(Object|String)} id The id or object with an _id property that we want to generate the url for
+     * @param  {Object} params Additional parameters and options for the url
+     * @example
+     * const url = sdk.files.downloadUrl('image', '61eca4746971e75c1fc670cf', {w:100, h:100});
+     * // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&h=100&download=true
+     * 
+     * const url = sdk.files.downloadUrl('image', {_id:'61eca4746971e75c1fc670cf'...}, {f:'png'});
+     * // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&h=100&download=true
+     */
+    service.downloadUrl = function(type, id, params, options) {
+        options = options || {}
+        params = params || {}
+        params.download = true;
+        id = qik.utils.id(id);
+        return qik.api.generateEndpointURL(`/${type}/${id}`, params, options);
+    }
+
+    /**
+     * 
+     * Get a valid media url for a specified image, video or audio item
+     * @alias files.mediaUrl
+     * @param  {String} type The type or definition of the item we want to generate the url for
+     * @param  {(Object|String)} id The id or object with an _id property that we want to generate the url for
+     * @param  {Object} params Additional parameters and options for the url
+     * @example
+     * const url = sdk.files.mediaUrl('image', '61eca4746971e75c1fc670cf', {w:100, h:100});
+     * // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&h=100&download=true
+     * 
+     * const url = sdk.files.mediaUrl('image', {_id:'61eca4746971e75c1fc670cf'...}, {f:'png'});
+     * // https://api.qik.dev/image/61eca4746971e75c1fc670cf?w=100&h=100&download=true
+     */
+    service.mediaUrl = function(type, id, params, options) {
+        options = options || {}
+        params = params || {}
+        id = qik.utils.id(id);
+        return qik.api.generateEndpointURL(`/${type}/${id}`, params, options);
+    }
+
+    ///////////////////////
+
+    /**
+     * 
+     * Convert bytes to a human readable file size
+     * @alias files.filesize
+     * @param  {Integer} bytes The number of bytes
+     * @example
+     * const size = sdk.files.filesize(1500);
+     * // 1.5kb
+     */
+    service.filesize = function(bytes, decimals) {
+        if(bytes == 0) return '0 Bytes';
+       var k = 1024,
+           dm = decimals || 2,
+           sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'],
+           i = Math.floor(Math.log(bytes) / Math.log(k));
+       return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i];
+    }
+
+    ///////////////////////
+
+    /**
+     * 
+     * Get the basic primitive type of a file from it's mime type value
+     * @alias files.getBinaryTypeFromMime
+     * @param  {String} fileMime The mime type of the file
+     * @example
+     * const type = sdk.files.getBinaryTypeFromMime('image/svg+xml');
+     * // 'image'
+     *
+     * const type = sdk.files.getBinaryTypeFromMime('video/webm');
+     * // 'video'
+     */
+    service.getBinaryTypeFromMime = function(fileMime) {
+
+        if (!fileMime) {
+            return 'file';
+        }
+
+        ////////////////////////////////
+
+        switch (fileMime) {
+            case 'image/jpeg':
+            case 'image/png':
+            case 'image/gif':
+            case 'image/bmp':
+            case 'image/tiff':
+            case 'image/svg+xml':
+                return 'image';
+                break;
+            case 'video/mp4':
+            case 'video/quicktime':
+            case 'video/ogg':
+            case 'video/webm':
+                return 'video'
+                break;
+            case 'audio/aac':
+            case 'audio/aiff':
+            case 'audio/mp3':
+            case 'audio/x-m4a':
+            case 'audio/mpeg':
+            case 'audio/ogg':
+            case 'audio/wav':
+            case 'audio/webm':
+                return 'audio'
+                break;
+            default:
+                //See if we can guess it from the first part of the mimetype
+                var prefix = fileMime.split('/')[0];
+                switch (prefix) {
+                    case 'image':
+                    case 'video':
+                    case 'audio':
+                        return prefix;
+                        break;
+                    default:
+                        return 'file';
+                        break;
+                }
+                break;
+        }
+    }
+
+    ////////////////////////////////
+
+    return service;
+
+}