primo-explore-dom
v0.0.10
Published
A simple Domain Object Model for Primo 5
Downloads
44
Maintainers
Readme
This is a pre-release: you can help us make it better.
Current version 0.0.10
- can retrieve controller without scope()
Current version 0.0.9
- extracted ui to its own project primo-explore-dom-ui
- added user.loans
- add Helper.loadScript()
- Primo.version now displays library version and Primo version & hot fix
- Possibility to drill down on a service in the UI
- Better check if reloadWithDebugInfo() was ran
- explorer UI pops up automatically when Primo UI is loaded with angular.reloadWithDebugInfo()
- some general refactoring
- fixed an issue that would prevent explore.ui.toggle() from running twice
version 0.0.8
- refactoring of ui
- better component ctrl discovery
- ui component property display
- unhandle promise
version 0.0.7
- user fines
- better ctrl discovery
- removed angularLoad reference
version 0.0.5
- refactored: user, view, records, facets, ui
- added user.email
- added view.interfaceLanguage
- user, view, records, facets returns a promise
- removed Primo.explore.session.id
Watch my EPUG-UKI AGM 2017 presentation to get an idea of what it is and what it can do.
Why do we need a Domain Object Model?
A domain object model according to Tim Howard is a logical container of domain information. You might assume that a model is present in every component and that is kind of true. When you examine a component you get a long list of context(component) specific information and there is no obvious way to access the most common(session, user, record, facet) information from within this component. And if you use an newUI service Ex Libris does not garentee that this service will still be present in the next newUI release.
I'm not saying that we need an SDK but we definitely need something that will withstand the test of time and maybe even is AngularJS agnostic. Currently the newUI is written using AngularJS 1 but plans are in place to upgrade to a future AngularJS and when this happens everybody who has written custom newUI code has to rewrite it for that AngularJS version.
TODO:write more documentation
Install
This package will extend the newUI through a "Template Package" or "Central Package".
- Install and configure primo-explore-devenv
- Download a "Template Package" or "Central Package" from the Primo Back Office
- Extract the downloaded package to
primo-explore-devenv/primo-explore/custom
- Rename the "Template Package" directory to reflect your view code for example to
YOUR_VIEW_CODE
- Create a
package.json
file inside your package directory *cd YOUR_VIEW_CODE
*npm init -y
- Install and store a reference to this package
*
npm install primo-explore-dom --save-dev
- Test.
*
gulp run --view YOUR_VIEW_CODE --proxy http://my.primo.com
* Open your web browser and go to http://localhost:8003/primo-explore/search?vid=YOUR_VIEW_CODE
PS: YOUR_VIEW_CODE must be replaced with the code you use for your view.
If you haven't installed primo-explore-devenv but do want to explore you can load primo-explore-dom from your web browser console.
//enable debug information. Wait for the screen to reload.
angular.reloadWithDebugInfo();
//When screen is reloaded
//Get a pointer to AngularJs and angularLoad
var appInjector = angular.injector(['ng','angularLoad']);
//Get a reference to angularLoad
var angularLoad = appInjector.get('angularLoad');
//Load the script;
angularLoad.loadScript('https://npmcdn.com/primo-explore-dom/js/primo-explore-dom.js').then(function(){
console.log('script loaded');
});
Quick links
General
If you are using this library to understand the newUI always load debug info first.
angular.reloadWithDebugInfo();
For now it is not possible to access the $scope and $ctrl without the debug info. The library will throw an error if this is the case and try an alternative method but this does not work for component access. (± will mark methods that absolutely need $scope access)
Check if the library is loaded with debug info enabled
Primo.isDebugEnabled()
This is an artifact. Should not be used!
Primo.isPrimoAvailable()
Get the library version
Primo.version
User
Primo.user
returns a promise
Get user ID
Primo.user.then(user => console.log(user.id));
Get user name
Primo.user.then(user => console.log(user.name));
Get user email
Primo.user.then(user => console.log(user.email));
Is user logged in
Primo.user.then(user => console.log(user.isLoggedIn()));
is user on campus
Primo.user.then(user => console.log(user.isOnCampus()));
Print number of fines for user
Primo.user.then(user => console.log(user.fines.length));
Print total of all fines
Primo.user.then(user => console.log(user.fines.map(f => parseFloat(f.finesum)).reduce((p,c)=> p+c)))
Print number of loans for user
Primo.user.then(user => console.log(user.loans.length))
view
Primo.view
returns a promise
Get VID
Primo.view.then(view => console.log(view.code));
Get institution code
Primo.view.then(view => console.log(view.institution.code));
Get institution name
Primo.view.then(view => console.log(view.institution.name));
Get interface language
Primo.view.then(view => console.log(view.interfaceLanguage));
ip
Get IP address of your Primo view
Primo.view.then(view => console.log(view.ip.address));
Records
Primo.records
returns a promise
This is a pointer to the new UI result set
Getting access to all records
Primo.records.then(records => console.log(records));
Mapping all recordid's into a list
Primo.records.then(records => console.log(records.map((m) => m.pnx.control.recordid[0])));
This is just a glimpse of what can be done.
Facets
Primo.facets
returns a promise
This is a pointer to the new UI facet set
Getting access to all facets
Primo.facets.then(facets => console.log(facets));
Examining a facet
Getting the facet name
Primo.facets.then(facets => console.log(facets[0].name));
Getting facet count
Primo.facets.then(facets => console.log(facets[0].count));
Getting facet values
Primo.facets.then(facets => console.log(facets[0].values));
This is just a glimpse of what can be done.
Components
Getting available components
The components list changes over time. Some components are only available in certain situations
Primo.explore.components.keys();
Getting the 'prm-icon' component
var prmIcons = Primo.explore.components.get('prm-icon');
Examining the prmIcon component
Get component name
primIcons[0].name
Get DOM element
primIcons[0].element
Find out css path to component
primIcons[0].cssPath
Get $scope for component (±)
primIcons[0].scope()
Get $ctrl form component (±)
primIcons[0].ctrl()
Make component blink on screen
primIcons[0].blink()
Helper
Same as Primo.isDebugEnabled()
Primo.explore.helper.isDebugEnabled();
Same as Primo.isPrimoAvailable()
Primo.explore.helper.isPrimoAvailable();
Get all rendered components
Primo.explore.helper.componentNames
Same as document.querySelectorAll but return an Array instead of a NodeList
Primo.explore.helper.querySelectorAll(selector)
PrimoExplore injector
Primo.explore.helper.injector()
Reference to AngularJS $http
Primo.explore.helper.http
Reference to angular-load. Returns a promise
Primo.explore.helper.loadScript()
Reference to PrimoExplore rootScope
Primo.explore.helper.rootScope()
Reference to userSessionManagerService
Primo.explore.helper.userSessionManagerService()
Reference to json web token data
Primo.explore.helper.jwtData()
Returns a promise to userDetails
Primo.explore.helper.userDetails()
Primo.explore.helper.userDetailsHTTP()
Returns a promise to userFines
Primo.explore.helper.userFinesHTTP()
Returns a promise to userLoans
Primo.explore.helper.userLoansHTTP()
Make a component blink
Primo.explore.helper.blink(component, numberOfBlinks = 4)
UI
Activate the UI
Primo.explore.ui.toggle()
Examples
Display the user name after the logo
app.component('prmLogoAfter', {
bindings: {
parentCtrl : '<'
},
template: '<div>{{$ctrl.user}}</div>',
controller: function(){
let ctrl = this;
ctrl.user = '';
Primo.user.then(u => ctrl.user = u.name);
}
});