fluro

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>fluro.types.js - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav > <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FluroAccess.html">FluroAccess</a><ul class='methods'><li data-type='method'><a href="FluroAccess.html#.addEventListener">addEventListener</a></li><li data-type='method'><a href="FluroAccess.html#.can">can</a></li><li data-type='method'><a href="FluroAccess.html#.canDeleteItem">canDeleteItem</a></li><li data-type='method'><a href="FluroAccess.html#.canEditItem">canEditItem</a></li><li data-type='method'><a href="FluroAccess.html#.canViewItem">canViewItem</a></li><li data-type='method'><a href="FluroAccess.html#.has">has</a></li><li data-type='method'><a href="FluroAccess.html#.isAuthor">isAuthor</a></li><li data-type='method'><a href="FluroAccess.html#.removeAllListeners">removeAllListeners</a></li><li data-type='method'><a href="FluroAccess.html#.removeEventListener">removeEventListener</a></li><li data-type='method'><a href="FluroAccess.html#.retrieveActionableRealms">retrieveActionableRealms</a></li><li data-type='method'><a href="FluroAccess.html#.retrieveCurrentSession">retrieveCurrentSession</a></li><li data-type='method'><a href="FluroAccess.html#.setDefaultApplication">setDefaultApplication</a></li></ul></li><li><a href="FluroAPI.html">FluroAPI</a><ul class='methods'><li data-type='method'><a href="FluroAPI.html#.delete">delete</a></li><li data-type='method'><a href="FluroAPI.html#.get">get</a></li><li data-type='method'><a href="FluroAPI.html#.post">post</a></li><li data-type='method'><a href="FluroAPI.html#.put">put</a></li></ul></li><li><a href="FluroAsset.html">FluroAsset</a><ul class='methods'><li data-type='method'><a href="FluroAsset.html#.avatarUrl">avatarUrl</a></li><li data-type='method'><a href="FluroAsset.html#.downloadUrl">downloadUrl</a></li><li data-type='method'><a href="FluroAsset.html#.filesize">filesize</a></li><li data-type='method'><a href="FluroAsset.html#.getUrl">getUrl</a></li><li data-type='method'><a href="FluroAsset.html#.imageUrl">imageUrl</a></li><li data-type='method'><a href="FluroAsset.html#.playerUrl">playerUrl</a></li><li data-type='method'><a href="FluroAsset.html#.posterUrl">posterUrl</a></li></ul></li><li><a href="FluroAuth.html">FluroAuth</a><ul class='methods'><li data-type='method'><a href="FluroAuth.html#.addEventListener">addEventListener</a></li><li data-type='method'><a href="FluroAuth.html#.changeAccount">changeAccount</a></li><li data-type='method'><a href="FluroAuth.html#.getCurrentToken">getCurrentToken</a></li><li data-type='method'><a href="FluroAuth.html#.getCurrentUser">getCurrentUser</a></li><li data-type='method'><a href="FluroAuth.html#.login">login</a></li><li data-type='method'><a href="FluroAuth.html#.logout">logout</a></li><li data-type='method'><a href="FluroAuth.html#.refreshAccessToken">refreshAccessToken</a></li><li data-type='method'><a href="FluroAuth.html#.removeAllListeners">removeAllListeners</a></li><li data-type='method'><a href="FluroAuth.html#.removeEventListener">removeEventListener</a></li><li data-type='method'><a href="FluroAuth.html#.retrieveUserFromResetToken">retrieveUserFromResetToken</a></li><li data-type='method'><a href="FluroAuth.html#.sendResetPasswordRequest">sendResetPasswordRequest</a></li><li data-type='method'><a href="FluroAuth.html#.set">set</a></li><li data-type='method'><a href="FluroAuth.html#.signup">signup</a></li><li data-type='method'><a href="FluroAuth.html#.sync">sync</a></li><li data-type='method'><a href="FluroAuth.html#.updateUserWithToken">updateUserWithToken</a></li></ul></li><li><a href="FluroCache.html">FluroCache</a><ul class='methods'><li data-type='method'><a href="FluroCache.html#.get">get</a></li><li data-type='method'><a href="FluroCache.html#.reset">reset</a></li></ul></li><li><a href="FluroContent.html">FluroContent</a><ul class='methods'><li data-type='method'><a href="FluroContent.html#.external">external</a></li><li data-type='method'><a href="FluroContent.html#.form">form</a></li><li data-type='method'><a href="FluroContent.html#.get">get</a></li><li data-type='method'><a href="FluroContent.html#.keys">keys</a></li><li data-type='method'><a href="FluroContent.html#.query">query</a></li><li data-type='method'><a href="FluroContent.html#.related">related</a></li><li data-type='method'><a href="FluroContent.html#.retrieve">retrieve</a></li><li data-type='method'><a href="FluroContent.html#.slug">slug</a></li><li data-type='method'><a href="FluroContent.html#.submitInteraction">submitInteraction</a></li><li data-type='method'><a href="FluroContent.html#.submitPost">submitPost</a></li><li data-type='method'><a href="FluroContent.html#.thread">thread</a></li><li data-type='method'><a href="FluroContent.html#.values">values</a></li></ul></li><li><a href="FluroCore.html">FluroCore</a></li><li><a href="FluroDate.html">FluroDate</a><ul class='methods'><li data-type='method'><a href="FluroDate.html#.dateFromID">dateFromID</a></li><li data-type='method'><a href="FluroDate.html#.formatDate">formatDate</a></li><li data-type='method'><a href="FluroDate.html#.isMultiDayEvent">isMultiDayEvent</a></li><li data-type='method'><a href="FluroDate.html#.localDate">localDate</a></li><li data-type='method'><a href="FluroDate.html#.readableEventDate">readableEventDate</a></li><li data-type='method'><a href="FluroDate.html#.readableEventTime">readableEventTime</a></li><li data-type='method'><a href="FluroDate.html#.timeago">timeago</a></li><li data-type='method'><a href="FluroDate.html#.timezones">timezones</a></li></ul></li><li><a href="FluroTypes.html">FluroTypes</a><ul class='methods'><li data-type='method'><a href="FluroTypes.html#.all">all</a></li><li data-type='method'><a href="FluroTypes.html#.get">get</a></li><li data-type='method'><a href="FluroTypes.html#.readable">readable</a></li><li data-type='method'><a href="FluroTypes.html#.reloadTerminology">reloadTerminology</a></li><li data-type='method'><a href="FluroTypes.html#.retrieve">retrieve</a></li></ul></li><li><a href="FluroUtils.html">FluroUtils</a><ul class='methods'><li data-type='method'><a href="FluroUtils.html#.arrayIDs">arrayIDs</a></li><li data-type='method'><a href="FluroUtils.html#.comma">comma</a></li><li data-type='method'><a href="FluroUtils.html#.errorMessage">errorMessage</a></li><li data-type='method'><a href="FluroUtils.html#.getDefaultValueForField">getDefaultValueForField</a></li><li data-type='method'><a href="FluroUtils.html#.getStringID">getStringID</a></li><li data-type='method'><a href="FluroUtils.html#.guid">guid</a></li><li data-type='method'><a href="FluroUtils.html#.hash">hash</a></li><li data-type='method'><a href="FluroUtils.html#.mapParameters">mapParameters</a></li><li data-type='method'><a href="FluroUtils.html#.matchInArray">matchInArray</a></li></ul></li></ul> </nav> <div id="main"> <h1 class="page-title">fluro.types.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>import _ from 'lodash'; /////////////////////////////////////////////////////////////////////////////// /** * Creates a new FluroTypes service * This module provides a number of helpful functions for retrieving, translating and understanding types, schemas and definitions * that are defined within Fluro * * @constructor * @param {FluroCore} fluro A reference to the parent instance of the FluroCore module. This module is usually created by a FluroCore instance that passes itself in as the first argument. */ var FluroTypes = function(FluroCore) { var service = {}; ////////////////////////////////// service.icon = function(type, library) { if (!library) { library = 'far'; } var icon; switch (type) { case 'policy': icon = 'id-card'; break; case 'account': icon = 'browser'; break; case 'application': icon = 'layer-group'; break; case 'article': icon = 'file-alt'; break; case 'asset': icon = 'file-archive'; break; case 'audio': icon = 'file-audio'; break; case 'checkin': icon = 'sign-in'; break; case 'capability': icon = 'star'; break; case 'code': icon = 'code'; break; case 'collection': // icon = 'box-full'; icon = 'folder'; break; case 'component': icon = 'tachometer-alt'; break; case 'contact': icon = 'child'; break; case 'definition': icon = 'books-medical'; break; case 'contactdetail': icon = 'file-invoice'; break; case 'eventtrack': icon = 'random'; break; case 'event': icon = 'calendar-star'; break; case 'family': icon = 'home'; break; case 'team': icon = 'users'; break; case 'attendance': icon = 'calendar-check'; break; case 'image': icon = 'image'; break; case 'integration': icon = 'plug'; break; case 'interaction': icon = 'compress'; break; case 'location': icon = 'map-marked-alt'; break; case 'mailout': icon = 'paper-plane'; break; case 'plan': icon = 'clipboard-list'; break; case 'post': icon = 'sticky-note'; break; case 'process': icon = 'exchange'; break; case 'product': icon = 'shopping-cart'; break; case 'purchase': icon = 'file-invoice-dollar'; break; case 'query': icon = 'terminal'; break; case 'reaction': icon = 'bolt'; break; case 'realm': icon = 'bullseye'; break; case 'role': icon = 'user-lock'; break; case 'site': icon = 'sitemap'; break; case 'tag': icon = 'tag'; break; case 'ticket': icon = 'ticket-alt'; break; case 'transaction': icon = 'usd-square'; break; case 'persona': icon = 'user'; break; case 'video': icon = 'video'; break; } if (icon) { return [library, icon]; } } ////////////////////////////////// /** * Retrieves a specified definition or primitive type object * @alias FluroTypes.get * @param {string} definedName The definition or type name you want to retrieve * @param {object} options extra options for the request * @return {promise} An promise that will resolve to the type definition from Fluro */ service.get = function(definedName, options) { if (!options) { options = { // flat:true } } /////////////////////////// return new Promise(function(resolve, reject) { FluroCore.api.get(`/defined/type/${definedName}`, options) .then(function(res) { resolve(res.data); }, reject); }); } ////////////////////////////////// /** * Retrieves all definitions available in the current account. Useful for making one request and caching * @alias FluroTypes.all * @param {object} options extra options for the request * @return {promise} An promise that will resolve to the array of definitions */ service.all = function(options) { if (!options) { options = { // flat:true } } /////////////////////////// return new Promise(function(resolve, reject) { return FluroCore.api.get(`/defined`, options) .then(function(res) { resolve(res.data); }, reject); }); } ////////////////////////////////// /** * Retrieves a glossary of terms for readable definition titles and plurals * @alias FluroTypes.reloadTerminology * @return {promise} An promise that will resolve to the matching basic types or reject with the responding error */ service.reloadTerminology = function(options) { service.terms = {}; if (!options) { options = { // flat:true } } /////////////////////////// return new Promise(function(resolve, reject) { FluroCore.api.get('/defined/terms', options) .then(function(res) { // console.log('GOT ALL THE TYPES', res.data); service.terms = res.data; resolve(service.terms); }, reject); }); } ////////////////////////////////// /** * Input a definition name or basic type and receive the human readable version of that type * @alias FluroTypes.readable * @param {String} definitionName The definition or _type * @param {Boolean} plural Whether to return it's plural version * @return {String} Eg. 'Audio', 'Detail Sheet', or 'Events'... */ service.readable = function(definitionName, plural) { var readable = definitionName; var match = service.terms ? service.terms[readable] : null; if(match) { readable = plural ? match.plural : match.title; } else { readable = plural ? _.startCase(readable) + 's' :_.startCase(readable); } return readable; } ////////////////////////////////// /** * Retrieves a list of specified types and their respective definitions * @alias FluroTypes.retrieve * @param {array} types The names of the basic types you want to retrieve * @return {promise} An promise that will resolve to the matching basic types or reject with the responding error */ service.retrieve = function(types, options) { if (!options) { options = { // flat:true } } options.types = types; /////////////////////////// return new Promise(function(resolve, reject) { FluroCore.api.post('/defined', options) .then(function(res) { // console.log('GOT ALL THE TYPES', res.data); resolve(res.data); }, reject); }); } // ////////////////////////////////// // //Get all sub definitions for an array of primitive types // service.subDefinitions = function(primitiveTypes, options) { // if (!options) { // options = { // // flat:true // } // } // var definitionCache = fluro.cache.get('subDefinitions'); // //////////////////////////////////////////////////////// // var promises = _.map(primitiveTypes, function(type) { // if(definitionCache[type]) { // return Promise.resolve(definitionCache[type]); // } // /////////////////////////////////////////////////// // return new Promise(function(resolve, reject) { // FluroCore.api.get(`/defined/types/${type}`) // .then(function(res) { // definitionCache[type] = res.data; // resolve(definitionCache[type]); // }, reject); // }); // }) // return Promise.all(promises); // } ////////////////////////////////// return service; } /////////////////////////////////////////////////////////////////////////////// export default FluroTypes;</code></pre> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Sep 05 2019 21:42:53 GMT+1000 (Australian Eastern Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme. </footer> <script>prettyPrint();</script> <script src="scripts/polyfill.js"></script> <script src="scripts/linenumber.js"></script> </body> </html>