solid-notification-client
Version:
Client library for Solid Notifications Protocol v0.2.0
123 lines (122 loc) • 6.89 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 };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.WebSocketChannel2023 = void 0;
var solid_client_authn_isomorphic_1 = require("@rubensworks/solid-client-authn-isomorphic");
var community_server_1 = require("@solid/community-server");
var ws_1 = require("ws");
var NotificationUtil_1 = require("./NotificationUtil");
var Util_1 = require("./Util");
var WebSocketChannel2023 = /** @class */ (function () {
function WebSocketChannel2023(session) {
this.session = session !== null && session !== void 0 ? session : new solid_client_authn_isomorphic_1.Session();
}
/**
* Retrieves the Websocket URL by following the {@link https://solidproject.org/TR/notifications-protocol|notification protocol v0.2.0.}
*
* Discovers from the topic resource the storage description resource.
* Using the contents of the storage description resource, a search is executed to find the WebSocketChannel2023 channel URL.
* Finally, a POST request is send to the WebSocketChannel with as content the topic and features.
* @param topic - The resource in the solid pod that you want to subscribe to.
* @param features - Which features should be in the message of the notification channel.
* @returns The websocket URL of the Solid pod for this resource.
*/
WebSocketChannel2023.prototype.subscribe = function (topic, features) {
return __awaiter(this, void 0, void 0, function () {
var subscriptionURL, body, response, store, receiveFrom;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, (0, NotificationUtil_1.fetchSubscriptionUrl)(topic, community_server_1.NOTIFY.WebSocketChannel2023, this.session)
// create body (see 3.3)
];
case 1:
subscriptionURL = _a.sent();
body = __assign({ "@context": [
"https://www.w3.org/ns/solid/notification/v1"
], topic: topic, type: community_server_1.NOTIFY.WebSocketChannel2023 }, features);
return [4 /*yield*/, this.session.fetch(subscriptionURL, {
method: "POST",
headers: {
"content-type": 'application/ld+json',
'accept': 'text/turtle'
},
body: JSON.stringify(body)
})
// Parse resulting response
];
case 2:
response = _a.sent();
return [4 /*yield*/, (0, Util_1.parseResponse)(response)];
case 3:
store = _a.sent();
receiveFrom = store.getQuads(null, community_server_1.NOTIFY.receiveFrom, null, null);
if (receiveFrom.length !== 1)
throw Error("receiveFrom property not found.");
return [2 /*return*/, receiveFrom[0].object.value];
}
});
});
};
WebSocketChannel2023.prototype.webSocket = function (topic, features) {
return __awaiter(this, void 0, void 0, function () {
var webSocketUrl, websocket;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.subscribe(topic, features)];
case 1:
webSocketUrl = _a.sent();
websocket = new ws_1.WebSocket(webSocketUrl);
return [2 /*return*/, websocket];
}
});
});
};
return WebSocketChannel2023;
}());
exports.WebSocketChannel2023 = WebSocketChannel2023;