UNPKG

semantic-network

Version:

A utility library for manipulating a list of links that form a semantic interface to a network of resources.

229 lines 11.3 kB
"use strict"; 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.sync = void 0; var semantic_link_1 = require("semantic-link"); var instanceOfResourceSync_1 = require("../utils/instanceOf/instanceOfResourceSync"); var instanceOfCollection_1 = require("../utils/instanceOf/instanceOfCollection"); var syncResource_1 = require("./syncResource"); var linkRelConvertUtil_1 = require("../utils/linkRelConvertUtil"); var instanceOfUriList_1 = require("../utils/instanceOf/instanceOfUriList"); var representationUtil_1 = require("../utils/representationUtil"); var anylogger_1 = __importDefault(require("anylogger")); var linkRelation_1 = require("../linkRelation"); var log = (0, anylogger_1.default)('sync'); /** * Retrieves a resource (singleton or collection, either directly or through a link relation) and synchronises from * the given document. It then will recurse through all provides `strategies`. * * @example * * ```sync({resource, document})``` * * Resource Document * * sync * +-----+ +-----+ * | | <-----------+ | | * | | | | * +-----+ +-----+ * * @example * * ```sync({resource: collection, document})``` * * resource * Collection Document * * +-----+ * | | * | | * +-----+ sync * X +---+ * X <-----------+ | x | * X +---+ * items * * @example * * ```sync(resource: parentResource, rel, document})``` * * parent resource * Resource Collection Document * * +----------+ * | | * | +-----+ * | Named| | * | | | * | +-----+ sync * | | X +---+ * | | X <-----------+ | x | * +----------+ X +---+ * items * * @example * * ```sync({resource: parentResource, rel, document: parentDocument}) * * parent singleton singleton parent * Resource Resource Document Document * * +----------+ +---------+ * | | sync | | * | +-----+ +-----+ | * | Named| | <-----------+ | |Named | * | | | | | | * | +-----+ +-----+ | * | | | | * | | ^ | | * +----------+ | +---------+ * | * + * looks for * * @example * * ```sync({resource: parentResource, rel, document: parentDocument})``` * * parent resource document parent * Resource Collection Collection Document * * +----------+ +----------+ * | | sync | | * | +-----+ +-----+ | * | Named| | <-----------+ | | | * | | | | | | * | +-----+ +-----+ | * | | X X | | * | | X items items X | | * +----------+ X X +----------+ * * * @param syncAction */ function sync(syncAction) { return __awaiter(this, void 0, void 0, function () { var resource, document, _a, strategies, _b, options, rel, uri, _c, name_1, namedDocument; return __generator(this, function (_d) { switch (_d.label) { case 0: resource = syncAction.resource, document = syncAction.document, _a = syncAction.strategies, strategies = _a === void 0 ? [] : _a, _b = syncAction.options, options = _b === void 0 ? {} : _b, rel = syncAction.rel; uri = semantic_link_1.LinkUtil.getUri(resource, linkRelation_1.LinkRelation.Self); log.debug('sync: start [\'%s\']', uri); if (!(0, instanceOfResourceSync_1.instanceOfResourceSync)(syncAction)) return [3 /*break*/, 5]; if (!(0, instanceOfCollection_1.instanceOfCollection)(resource)) return [3 /*break*/, 2]; log.debug('sync: on collection'); return [4 /*yield*/, (0, syncResource_1.syncResource)(resource, document, strategies, options)]; case 1: _d.sent(); return [3 /*break*/, 4]; case 2: if ((0, instanceOfCollection_1.instanceOfCollection)(document)) { throw new Error('Not Implemented: a document collection cannot be synchronised onto a singleton'); } log.debug('sync: on singleton'); return [4 /*yield*/, (0, syncResource_1.syncResource)(resource, document, strategies, options)]; case 3: _d.sent(); _d.label = 4; case 4: return [3 /*break*/, 15]; case 5: _c = syncAction.name, name_1 = _c === void 0 ? linkRelConvertUtil_1.LinkRelConvertUtil.relTypeToCamel(rel) : _c; if (!rel) { throw new Error('Sync of a named resource must have a rel specified in the options'); } if ((0, instanceOfUriList_1.instanceOfUriList)(document)) { if (strategies) { log.warn('Strategies not available for uri-list'); } throw new Error('Not implemented'); } if (!document) return [3 /*break*/, 14]; namedDocument = representationUtil_1.RepresentationUtil.getProperty(document, name_1); if (!namedDocument) return [3 /*break*/, 12]; if (!(0, instanceOfCollection_1.instanceOfCollection)(namedDocument)) return [3 /*break*/, 7]; log.debug('sync: named document collection [\'%s\' with rel \'%s\']', name_1, rel); return [4 /*yield*/, (0, syncResource_1.syncResource)(resource, namedDocument, strategies, __assign(__assign({}, options), { rel: rel }))]; case 6: _d.sent(); return [3 /*break*/, 11]; case 7: if (!(0, instanceOfCollection_1.instanceOfCollection)(resource)) return [3 /*break*/, 9]; log.debug('sync: collection [\'%s\' with rel \'%s\']', name_1, rel); return [4 /*yield*/, (0, syncResource_1.syncResource)(resource, document, strategies, __assign(__assign({}, options), { rel: rel }))]; case 8: _d.sent(); return [3 /*break*/, 11]; case 9: log.debug('sync: named singleton [\'%s\' with rel \'%s\']', name_1, rel); return [4 /*yield*/, (0, syncResource_1.syncResource)(resource, document, strategies, __assign(__assign({}, options), { rel: rel, relOnDocument: rel }))]; case 10: _d.sent(); _d.label = 11; case 11: return [3 /*break*/, 13]; case 12: log.debug('sync: named document not found'); _d.label = 13; case 13: return [3 /*break*/, 15]; case 14: log.warn('sync: matching document does not exist on rel \'%s\' for %s', rel, semantic_link_1.LinkUtil.getUri(resource, 'self')); _d.label = 15; case 15: log.debug('sync: end [\'%s\']', uri); return [2 /*return*/]; } }); }); } exports.sync = sync; //# sourceMappingURL=sync.js.map