fluro
Version:
Promise based HTTP Fluro client for the browser and node.js
314 lines (254 loc) • 8.73 kB
JavaScript
// if (process.browser) {
import FluroAPI from './fluro.api';
import FluroAuth from './fluro.auth';
import FluroComponents from './fluro.components';
import FluroAsset from './fluro.asset';
import FluroUtils from './fluro.utils';
import FluroCache from './fluro.cache';
import FluroDate from './fluro.date';
import FluroStats from './fluro.stats';
import FluroTypes from './fluro.types';
import FluroContent from './fluro.content';
import FluroAccess from './fluro.access';
import FluroVideo from './fluro.video';
import FluroDevice from './fluro.device';
import { EventDispatcher } from './fluro.utils';
// } else {
// const esmImport = require('esm')(module);
// const FluroAPI = esmImport('./fluro.api');
// const FluroAuth = esmImport('./fluro.auth');
// const FluroAsset = esmImport('./fluro.asset');
// const FluroUtils = esmImport('./fluro.utils');
// const FluroCache = esmImport('./fluro.cache');
// const FluroDate = esmImport('./fluro.date');
// const FluroStats = esmImport('./fluro.stats');
// const FluroTypes = esmImport('./fluro.types');
// const FluroContent = esmImport('./fluro.content');
// const FluroAccess = esmImport('./fluro.access');
// const EventDispatcher = FluroUtils.EventDispatcher;
// }
///////////////////////////////////////
/**
* Creates a new FluroCore instance including all of the default sub modules
* @alias fluro
* @constructor
* @param {Object} options
* @param {String} options.apiURL The remote URL of the Fluro API you want to connect to. Options are 'staging', 'production' or you may set a specific URL eg. 'https://api.fluro.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 Fluro instance here.
* @example
*
* //Import the Fluro package
* import Fluro from 'fluro';
*
* //Create a new Fluro instance
* var fluro = new Fluro();
*
* //Request the current user session endpoint from the Fluro API
* fluro.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 FluroAsset package to generate an image url
* var link = fluro.asset.imageUrl('5ca3d64dd2bb085eb9d450db', 1920, 1080)
*/
var FluroCore = function(options) {
if (!options) {
options = {
// apiURL,
// applicationToken,
// api:{}
};
}
///////////////////////////////////////
///////////////////////////////////////
if (!options.apiURL || !options.apiURL.length) {
options.apiURL = 'production';
}
///////////////////////////////////////
switch (String(options.apiURL).toLowerCase()) {
case 'production':
options.apiURL = 'https://api.fluro.io';
break;
case 'staging':
options.apiURL = 'https://api.staging.fluro.io';
break;
case 'local':
options.apiURL = 'http://api.fluro.localhost:3000';
break;
}
///////////////////////////////////////
///////////////////////////////////////
var core = Object.assign(options, {
//apiURL: options.apiURL,
//applicationToken: options.applicationToken,
domain: options.domain || '',
//withCredentials:options.withCredentials,
global:{},
resetCache() {
// console.log('Fluro - Reset Global Cache')
FluroCache.reset();
dispatcher.dispatch('cache.reset')
}
})
///////////////////////////////////////
/**
* Provides a cache service, used for creating, clearing
* and storing API requests and other information in memory
* @type {FluroCache}
*/
var cache = FluroCache;
Object.defineProperty(core, 'cache', {
value: cache,
writable: false,
});
///////////////////////////////////////
/**
* Provides helper functions for working
* with Fluro data
* @type {FluroUtils}
*/
var utils = FluroUtils;
Object.defineProperty(core, 'utils', {
value: utils,
writable: false,
});
///////////////////////////////////////
/**
* Provides helper functions for understanding the users device
* @type {FluroDevice}
*/
var device = FluroDevice;
Object.defineProperty(core, 'device', {
value: device,
writable: false,
});
///////////////////////////////////////
//Create a new global dispatcher so we can trigger events
var 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});
}
///////////////////////////////////////
/**
* Provides date functions, filters and utilities
* for working with dates and timezones
* @type {FluroDate}
*/
var date = FluroDate;
Object.defineProperty(core, 'date', {
value: date,
writable: false,
});
/**
* The default service for interacting with
* the Fluro REST API, it's a wrapper around the axios library
* that works in conjunction with the other Fluro modules
* @type {FluroAPI}
*/
var api = new FluroAPI(core);
Object.defineProperty(core, 'api', {
value: api,
writable: false,
});
var appContextAPI = new FluroAPI(core, true);
Object.defineProperty(core, 'appContextAPI', {
value: appContextAPI,
writable: false,
});
/**
* A helper service for CRUD operations that wraps around the fluro.api service
* @type {FluroContent}
*/
var content = new FluroContent(core);
Object.defineProperty(core, 'content', {
value: content,
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 {FluroAuth}
*/
var auth = new FluroAuth(core);
Object.defineProperty(core, 'auth', {
value: auth,
writable: false,
});
/**
* Provides helper functions for working with Fluro Components
* @type {FluroComponents}
*/
var components = new FluroComponents(core);
Object.defineProperty(core, 'components', {
value: components,
writable: false,
});
///////////////////////////////////////
/**
* Provides helper functions for working
* with Fluro Video data
* @type {FluroVideo}
*/
var video = FluroVideo;
Object.defineProperty(core, 'video', {
value: video,
writable: false,
});
/**
* The default service for managing, rendering and handling files and media from Fluro.
* It contains helper functions for managing connecting to image, audio, asset and video api endpoints.
* @type {FluroAsset}
*/
var asset = new FluroAsset(core);
Object.defineProperty(core, 'asset', {
value: asset,
writable: false,
});
/**
* The default service for handling a user's 'stats' eg. (likes, views, favorites, downvotes etc...)
* This service creates and syncs user's stats when they 'stat' items from Fluro.
* @type {FluroStats}
*/
var stats = new FluroStats(core)
Object.defineProperty(core, 'stats', {
value: new FluroStats(core),
writable: false,
});
/**
* A helper service for retrieving, translating and rendering content types and definitions
* defined within Fluro.
* @type {FluroTypes}
*/
var types = new FluroTypes(core);
Object.defineProperty(core, 'types', {
value: types,
writable: false,
});
/**
* A helper service for understanding a user's access permissions
* @type {FluroAccess}
*/
var access = new FluroAccess(core);
Object.defineProperty(core, 'access', {
value: access,
writable: false,
});
///////////////////////////////////////
return core;
}
///////////////////////////////////////
///////////////////////////////////////
///////////////////////////////////////
///////////////////////////////////////
export default FluroCore;