open-vault/ui/app/lib/attach-capabilities.js
Matthew Irish 887e2febf8
UI - dynamic related capabilities (#7013)
* lay groundwork for application serializer to setup capabilities relationships

* add api path util and tests, and attach-capabilites fn

* make attach-capabilities work with array responses, add tests
2019-06-28 16:07:45 -05:00

83 lines
2.3 KiB
JavaScript

import DS from 'ember-data';
import { assert, debug } from '@ember/debug';
import { typeOf } from '@ember/utils';
import { isArray } from '@ember/array';
const { belongsTo } = DS;
/*
*
* attachCapabilities
*
* @param modelClass = An Ember Data model class
* @param capabilities - an Object whose keys will added to the model class as related 'capabilities' models
* and whose values should be functions that return the id of the related capabilites model
*
* definition of capabilities be done shorthand with the apiPath tagged template funtion
*
*
* @usage
*
* let Model = DS.Model.extend({
* backend: attr(),
* scope: attr(),
* });
*
* export default attachCapabilities(Model, {
* updatePath: apiPath`${'backend'}/scope/${'scope'}/role/${'id'}`,
* });
*
*/
export default function attachCapabilities(modelClass, capabilities) {
let capabilityKeys = Object.keys(capabilities);
let newRelationships = capabilityKeys.reduce((ret, key) => {
ret[key] = belongsTo('capabilities');
return ret;
}, {});
debug(`adding new relationships: ${capabilityKeys.join(', ')} to ${modelClass.toString()}`);
modelClass.reopen(newRelationships);
modelClass.reopenClass({
// relatedCapabilities is called in the application serializer's
// normalizeResponse hook to add the capabilities relationships to the
// JSON-API document used by Ember Data
relatedCapabilities(jsonAPIDoc) {
let { data, included } = jsonAPIDoc;
if (!data) {
data = jsonAPIDoc;
}
if (isArray(data)) {
let newData = data.map(this.relatedCapabilities);
return {
data: newData,
included,
};
}
let context = {
id: data.id,
...data.attributes,
};
for (let newCapability of capabilityKeys) {
let templateFn = capabilities[newCapability];
let type = typeOf(templateFn);
assert(`expected value of ${newCapability} to be a function but found ${type}.`, type === 'function');
data.relationships[newCapability] = {
data: {
type: 'capabilities',
id: templateFn(context),
},
};
}
if (included) {
return {
data,
included,
};
} else {
return data;
}
},
});
return modelClass;
}