solid-notification-client
Version:
Client library for Solid Notifications Protocol v0.2.0
254 lines (253 loc) • 14.4 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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
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.WebHookSubscription2021 = void 0;
var context_entries_1 = require("@comunica/context-entries");
var solid_client_authn_isomorphic_1 = require("@rubensworks/solid-client-authn-isomorphic");
var community_server_1 = require("@solid/community-server");
var n3_1 = require("n3");
var path = __importStar(require("path"));
var rdf_parse_1 = __importDefault(require("rdf-parse"));
var rdf_store_stream_1 = require("rdf-store-stream");
var WebHookSubscription2021 = /** @class */ (function () {
function WebHookSubscription2021(session) {
this.session = session !== null && session !== void 0 ? session : new solid_client_authn_isomorphic_1.Session();
}
/**
* Looks up the storageDescription URL of a solid pod by looking for the `http://www.w3.org/ns/solid#storageDescription` Link value.
*
* @param url - the URL of the solid pod. (any resource in the pod is fine; all resources MUST advertise this Link header when the solid pod is a Resource Server. See 2.1 Discovery of the spec )
*/
WebHookSubscription2021.prototype.lookupStorageDescription = function (url) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var response, linkHeaders, parsedLinkHeaders, storageDescription, _i, parsedLinkHeaders_1, _b, target, parameters;
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, this.session.fetch(url, { method: 'HEAD' })
// parse link header and look for rel=`http://www.w3.org/ns/solid#storageDescription`
];
case 1:
response = _c.sent();
linkHeaders = (_a = response.headers.get('Link')) !== null && _a !== void 0 ? _a : "";
parsedLinkHeaders = (0, community_server_1.parseLinkHeader)(linkHeaders);
for (_i = 0, parsedLinkHeaders_1 = parsedLinkHeaders; _i < parsedLinkHeaders_1.length; _i++) {
_b = parsedLinkHeaders_1[_i], target = _b.target, parameters = _b.parameters;
if (parameters.rel === community_server_1.SOLID.storageDescription) {
storageDescription = target;
}
}
// throw error if not found
if (!storageDescription) {
throw Error("No storage description found in Link Header");
}
// return value if found
return [2 /*return*/, storageDescription];
}
});
});
};
/**
* Fetches the subscription URL of a Resource Server by first fetching the solid:StorageDescription URL and then extracting the WebSocketChannel2023 from the body.
* @param url - the Url of the solid pod.
* @returns
*/
WebHookSubscription2021.prototype.fetchSubscriptionUrl = function (url) {
return __awaiter(this, void 0, void 0, function () {
var storageDescriptionUrl, response, store, notificationChannels, webSocketChannel, _i, notificationChannels_1, notificationChannel;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.lookupStorageDescription(url)];
case 1:
storageDescriptionUrl = _a.sent();
return [4 /*yield*/, this.session.fetch(storageDescriptionUrl)];
case 2:
response = _a.sent();
return [4 /*yield*/, parseResponse(response)];
case 3:
store = _a.sent();
notificationChannels = store.getObjects(storageDescriptionUrl, community_server_1.NOTIFY.terms.subscription, null);
for (_i = 0, notificationChannels_1 = notificationChannels; _i < notificationChannels_1.length; _i++) {
notificationChannel = notificationChannels_1[_i];
if (store.getQuads(notificationChannel, community_server_1.NOTIFY.channelType, community_server_1.NOTIFY.WebhookChannel2023, null).length === 1) {
webSocketChannel = store.getQuads(notificationChannel, community_server_1.NOTIFY.channelType, community_server_1.NOTIFY.WebhookChannel2023, null)[0].subject.value;
}
}
// throw error if not found
if (!webSocketChannel) {
throw Error("No WebSocketChannel found in the storage description resource.");
}
// return value if found
return [2 /*return*/, webSocketChannel];
}
});
});
};
/**
* 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 WebHookSubscription2021 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.
*/
WebHookSubscription2021.prototype.subscribe = function (topic, webId, 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*/, this.fetchSubscriptionUrl(topic)
// 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.WebhookChannel2023 }, features);
return [4 /*yield*/, this.session.fetch(subscriptionURL, {
method: "POST",
headers: {
authorization: "WebID ".concat(webId),
"content-type": 'application/ld+json',
'accept': 'text/turtle' // note: this doesn't work -> bug in CSS
},
body: JSON.stringify(body)
})
// Parse resulting response
];
case 2:
response = _a.sent();
return [4 /*yield*/, parseResponse(response)];
case 3:
store = _a.sent();
console.log(new n3_1.Writer().quadsToString(store.getQuads(null, null, null, null)));
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
// let webSocketUrl = store.getQuads()
// {
// "@context": [
// "https://www.w3.org/ns/solid/notification/v1"
// ],
// "id": "https://channel.example/ac748712",
// "type": "WebSocketChannel2023",
// "topic": "https://example.org/guinan/profile",
// "receiveFrom": "wss://websocket.example/d4cf3f19",
// "startAt": "2023-01-01T07:00:00.000Z",
// "endAt": "2023-01-01T09:00:00.000Z",
// "rate": "PT5M",
// "state": "e75-TFJH"
// }
];
}
});
});
};
return WebHookSubscription2021;
}());
exports.WebHookSubscription2021 = WebHookSubscription2021;
// util function to parse response as store
function parseResponse(response) {
var _a;
return __awaiter(this, void 0, void 0, function () {
var contentType, text, textStream, documentLoader, quadStream, store;
var _b;
return __generator(this, function (_c) {
switch (_c.label) {
case 0:
contentType = (0, community_server_1.parseContentType)((_a = response.headers.get("content-type")) !== null && _a !== void 0 ? _a : "").value;
return [4 /*yield*/, response.text()];
case 1:
text = _c.sent();
textStream = require('streamify-string')(text);
documentLoader = new community_server_1.ContextDocumentLoader({
'https://www.w3.org/ns/solid/notification/v1': path.join(__dirname, '../config/contexts/notification.jsonld')
});
quadStream = rdf_parse_1.default.parse(textStream, (_b = {
contentType: contentType
},
_b[context_entries_1.KeysRdfParseJsonLd.documentLoader.name] = documentLoader,
_b));
return [4 /*yield*/, (0, rdf_store_stream_1.storeStream)(quadStream)];
case 2:
store = (_c.sent());
return [2 /*return*/, store];
}
});
});
}