semantic-network
Version:
A utility library for manipulating a list of links that form a semantic interface to a network of resources.
307 lines • 12.8 kB
JavaScript
;
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ResourceMergeFactory = exports.noopResourceResolver = exports.noopResolver = exports.noop = void 0;
var semantic_link_1 = require("semantic-link");
var linkRelation_1 = require("../linkRelation");
var anylogger_1 = __importDefault(require("anylogger"));
var formUtil_1 = require("../utils/formUtil");
var fieldResolverUtil_1 = require("../utils/fieldResolverUtil");
var fieldLinksResolverUtil_1 = require("../utils/fieldLinksResolverUtil");
var noop = function () {
};
exports.noop = noop;
exports.noopResolver = {
resolve: function (_) { return _; },
remove: exports.noop,
add: exports.noop,
update: exports.noop,
};
var noopResourceResolver = function () { return function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
return [2 /*return*/, undefined];
}); }); }; };
exports.noopResourceResolver = noopResourceResolver;
var log = (0, anylogger_1.default)('ResourceMerger');
/**
* Processes difference sets (created, update, delete) for between two client-side collections {@Link CollectionRepresentation}
*
*/
var ResourceMergeFactory = /** @class */ (function () {
function ResourceMergeFactory() {
}
ResourceMergeFactory.createMerge = function (resource, form, options) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.merge(resource, form, options)];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
/**
* A three-way merge between a form resource and existing {@link LinkedRepresentation}
* client-side representation within the api network of data and a new {@Link LinkedRepresentation} document.
*
* Use option {@link EditMergeOptions.undefinedWhenNoUpdateRequired} to return undefined
* when no update is required
*
* The basic merge is:
* 1. remove any fields document representation that are not field items in the form
* 2. merge the document into the client-side representation
* @param resource a clean over-the-wire version
* @param document any updates
* @param form required to specify the merge fields
* @param options
*/
ResourceMergeFactory.editMerge = function (resource, document, form, options) {
return __awaiter(this, void 0, void 0, function () {
var _a, _b, undefinedWhenNoUpdateRequired, defaultFields, newDocument, fieldsToUpdate;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
_a = __assign({}, options), _b = _a.undefinedWhenNoUpdateRequired, undefinedWhenNoUpdateRequired = _b === void 0 ? true : _b, defaultFields = _a.defaultFields;
return [4 /*yield*/, this.merge(document, form, options)];
case 1:
newDocument = _c.sent();
// return undefined if the flag is on and there are no updates
if (undefinedWhenNoUpdateRequired) {
fieldsToUpdate = formUtil_1.FormUtil.fieldsRequiringUpdate(resource, newDocument, form, defaultFields);
if ((fieldsToUpdate === null || fieldsToUpdate === void 0 ? void 0 : fieldsToUpdate.length) > 0) {
log.debug('Update required on \'%s\': [different fields \'%s\']', newDocument.name || semantic_link_1.LinkUtil.getUri(document, linkRelation_1.LinkRelation.Self), fieldsToUpdate.join(','));
return [2 /*return*/, newDocument];
}
else {
return [2 /*return*/, undefined];
}
}
else {
return [2 /*return*/, newDocument];
}
return [2 /*return*/];
}
});
});
};
/**
* Makes the new document with all links and fields resolved.
* @param document
* @param form
* @param {MergeOptions} options?
* @return {Promise.<*>|Promise} containing the document updates to be merged
* @private
*/
ResourceMergeFactory.resolveLinksAndFields = function (document, form, options) {
return __awaiter(this, void 0, void 0, function () {
var resolvedDocument, resolvedLinks;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, fieldResolverUtil_1.FieldResolverUtil.resolveFields(document, form, options)];
case 1:
resolvedDocument = _a.sent();
return [4 /*yield*/, fieldLinksResolverUtil_1.FieldLinksResolverUtil.resolveLinks(document, form, options)];
case 2:
resolvedLinks = _a.sent();
// step : merge all fields together as a document
return [2 /*return*/, __assign(__assign({}, resolvedDocument), resolvedLinks)];
}
});
});
};
/**
* A merge between the a form resource and an existing resource. It merges based on
* both attributes and link relations in a resource
*
* Example One:
*
* form fields:
* 'name', 'job', 'relates'
*
* resource:
* {
* links: [
* { rel: 'Self', href: 'http://example.com/item/1' },
* { rel: 'relates', href: 'http://example.com/job/1' },
* ],
* name: 'this',
* job: 'that'
* type: '1'
* }
*
* result:
* {
* relates: 'http://example.com/job/1',
* name: 'this',
* job: 'that'
* }
*
*
* The resolver will match against fields and return a value. This is used
* for example with the 'relates' attribute to return a href reference to the parent resource
*
* Example Two: '//types/form/collection'
*
* form fields:
* {
*
* "links": [
* {
* "rel": "Self",
* "href": "http://localhost:1080/page/form/edit"
* }
* ],
* "items": [
* {
* "type": "//types/form/text",
* "name": "title",
* "description": "The title of the survey"
* },
* {
* "type": "//types/form/collection",
* "name": "role",
* "description": "An optional list of roles to be granted access to the page"
* }
* ]
*}
*
* resource:
* {
* links: [
* { rel: 'Self', href: 'http://example.com/item/1' },
* { rel: 'role', href: 'http://example.com/role/1' },
* { rel: 'role', href: 'http://example.com/role/2' },
* ],
* title: 'this',
* }
*
* result:
* {
* role: ['http://example.com/role/1', 'http://example.com/role2']
* name: 'this',
* }
* Example Three: '//types/form/group'
*
* form fields:
* {
*
* "links": [
* {
* "rel": "Self",
* "href": "http://localhost:1080/page/form/edit"
* }
* ],
* "items": [
* {
* "type": "//types/form/text",
* "name": "title",
* "description": "The title of the survey"
* },
* {
*
* "type": "//types/form/group",
* "name": "textBox",
* "items": [
* {
* "type": "//types/form/text",
* "name": "height",
* "description": "The height of the text box in lines"
* },
* {
* "type": "//types/form/text",
* "name": "width",
* "description": "The width of the text box in characters"
* }
* ],
* "description": "Dimensions for a text box"
* }
* ]
*}
* resource:
* {
* links: [
* { rel: 'Self', href: 'http://example.com/item/1' },
* ],
* textBox: {
* height: 5,
* width: 20
* }
* }
*
* result:
* {
* textBox: {
* height: 5,
* width: 20
* }
* }
* @param resource
* @param form
* @param options
* @return the resource to be created
*/
ResourceMergeFactory.merge = function (resource, form, options) {
return __awaiter(this, void 0, void 0, function () {
var resolvedDocument;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.resolveLinksAndFields(resource, form, options)];
case 1:
resolvedDocument = _a.sent();
return [2 /*return*/, formUtil_1.FormUtil.fieldsToReturnFromForm(resolvedDocument, form, options)];
}
});
});
};
return ResourceMergeFactory;
}());
exports.ResourceMergeFactory = ResourceMergeFactory;
//# sourceMappingURL=resourceMergeFactory.js.map