moeralib 0.16.8 → 0.17.1

package/lib/node/node.js

@@ -40,6 +40,53 @@ class MoeraNode extends caller_1.Caller {
             });
         });
     }
+    /**
+     * Get a list of previously executed search queries, optionally filtered by the given ``prefix`` and limited by the
+     * given ``limit``. The node may decide to return fewer queries than the given ``limit``. The queries are always
+     * sorted by creation timestamp, descending.
+     *
+     * @param {string | null} prefix - find queries with the specified prefix (case-insensitive)
+     * @param {number | null} limit - maximum number of queries returned
+     * @return {Promise<API.SearchHistoryInfo[]>}
+     */
+    getSearchHistory() {
+        return __awaiter(this, arguments, void 0, function* (prefix = null, limit = null) {
+            const location = (0, util_1.ut) `/activity/search`;
+            const params = { prefix, limit };
+            return yield this.call("getSearchHistory", location, {
+                method: "GET", params, schema: "SearchHistoryInfoArray"
+            });
+        });
+    }
+    /**
+     * Save a search query in the registry.
+     *
+     * @param {API.SearchHistoryText} historyText
+     * @return {Promise<API.SearchHistoryInfo>}
+     */
+    saveToSearchHistory(historyText) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const location = "/activity/search";
+            return yield this.call("saveToSearchHistory", location, {
+                method: "POST", body: historyText, schema: "SearchHistoryInfo"
+            });
+        });
+    }
+    /**
+     * Delete a search query from the registry.
+     *
+     * @param {string} query - the query to be deleted
+     * @return {Promise<API.Result>}
+     */
+    deleteFromSearchHistory(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const location = (0, util_1.ut) `/activity/search`;
+            const params = { query };
+            return yield this.call("deleteFromSearchHistory", location, {
+                method: "DELETE", params, schema: "Result"
+            });
+        });
+    }
     /**
      * Get a slice of the list of all orders sent by the sheriff, delimited by the ``before`` or ``after`` moment and
      * the given ``limit``. If neither ``before`` nor ``after`` are provided, the latest orders are returned. The node
@@ -1067,6 +1114,24 @@ class MoeraNode extends caller_1.Caller {
             });
         });
     }
+    /**
+     * Delete all stories from the feed with optional filtering.
+     *
+     * @param {string} feedName - name of the feed
+     * @param {API.StoryType | null} type - delete only the stories of the given type
+     * @param {string | null} receiver - delete only the stories about postings located at the given node
+     * @param {boolean | null} recommended - delete only the stories about recommended postings
+     * @return {Promise<API.Result>}
+     */
+    deleteFeedStories(feedName_1) {
+        return __awaiter(this, arguments, void 0, function* (feedName, type = null, receiver = null, recommended = null) {
+            const location = (0, util_1.ut) `/feeds/${feedName}/stories`;
+            const params = { type, receiver, recommended };
+            return yield this.call("deleteFeedStories", location, {
+                method: "DELETE", params, schema: "Result"
+            });
+        });
+    }
     /**
      * Get the list of all groups of friends that exist on the node.
      *
@@ -1962,6 +2027,121 @@ class MoeraNode extends caller_1.Caller {
             });
         });
     }
+    /**
+     * Find postings known to the recommendation service and may be of interest to the client. If the client is
+     * authenticated, the service may tune the recommendations for them. \
+     * \
+     * The service may decide to return fewer recommendations than the given ``limit``.
+     *
+     * @param {string | null} sheriff - filter out entries prohibited by the given sheriff
+     * @param {number | null} limit - maximum number of recommendations returned
+     * @return {Promise<API.RecommendedPostingInfo[]>}
+     */
+    getRecommendedPostings() {
+        return __awaiter(this, arguments, void 0, function* (sheriff = null, limit = null) {
+            const location = (0, util_1.ut) `/recommendations/postings`;
+            const params = { sheriff, limit };
+            return yield this.call("getRecommendedPostings", location, {
+                method: "GET", params, schema: "RecommendedPostingInfoArray"
+            });
+        });
+    }
+    /**
+     * Find postings known to the recommendation service and may be of interest to the client to read them. If the
+     * client is authenticated, the service may tune the recommendations for them. \
+     * \
+     * The service may decide to return fewer recommendations than the given ``limit``.
+     *
+     * @param {string | null} sheriff - filter out entries prohibited by the given sheriff
+     * @param {number | null} limit - maximum number of recommendations returned
+     * @return {Promise<API.RecommendedPostingInfo[]>}
+     */
+    getRecommendedPostingsForReading() {
+        return __awaiter(this, arguments, void 0, function* (sheriff = null, limit = null) {
+            const location = (0, util_1.ut) `/recommendations/postings/reading`;
+            const params = { sheriff, limit };
+            return yield this.call("getRecommendedPostingsForReading", location, {
+                method: "GET", params, schema: "RecommendedPostingInfoArray"
+            });
+        });
+    }
+    /**
+     * Find postings known to the recommendation service and may be of interest to the client to take part in the
+     * discussion. If the client is authenticated, the service may tune the recommendations for them. \
+     * \
+     * The service may decide to return fewer recommendations than the given ``limit``.
+     *
+     * @param {string | null} sheriff - filter out entries prohibited by the given sheriff
+     * @param {number | null} limit - maximum number of recommendations returned
+     * @return {Promise<API.RecommendedPostingInfo[]>}
+     */
+    getRecommendedPostingsForCommenting() {
+        return __awaiter(this, arguments, void 0, function* (sheriff = null, limit = null) {
+            const location = (0, util_1.ut) `/recommendations/postings/commenting`;
+            const params = { sheriff, limit };
+            return yield this.call("getRecommendedPostingsForCommenting", location, {
+                method: "GET", params, schema: "RecommendedPostingInfoArray"
+            });
+        });
+    }
+    /**
+     * Inform the recommendation service that the recommended posting was accepted by the client.
+     *
+     * @param {string} remoteNodeName - name of the remote node
+     * @param {string} postingId - ID of the posting on the remote node
+     * @return {Promise<API.Result>}
+     */
+    acceptRecommendedPosting(remoteNodeName, postingId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const location = (0, util_1.ut) `/recommendations/postings/accepted/${remoteNodeName}/${postingId}`;
+            return yield this.call("acceptRecommendedPosting", location, {
+                method: "POST", schema: "Result"
+            });
+        });
+    }
+    /**
+     * Inform the recommendation service that the recommended posting was rejected by the client.
+     *
+     * @param {string} remoteNodeName - name of the remote node
+     * @param {string} postingId - ID of the posting on the remote node
+     * @return {Promise<API.Result>}
+     */
+    rejectRecommendedPosting(remoteNodeName, postingId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const location = (0, util_1.ut) `/recommendations/postings/rejected/${remoteNodeName}/${postingId}`;
+            return yield this.call("rejectRecommendedPosting", location, {
+                method: "POST", schema: "Result"
+            });
+        });
+    }
+    /**
+     * Ask the recommendation service to exclude all content from the given node from future recommendations.
+     *
+     * @param {string} remoteNodeName - name of the remote node
+     * @return {Promise<API.Result>}
+     */
+    excludeNodeFromRecommendations(remoteNodeName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const location = (0, util_1.ut) `/recommendations/nodes/excluded/${remoteNodeName}`;
+            return yield this.call("excludeNodeFromRecommendations", location, {
+                method: "POST", schema: "Result"
+            });
+        });
+    }
+    /**
+     * Allow the recommendation service to include the content from the given node to future recommendations.
+     *
+     * @param {string} remoteNodeName - name of the remote node
+     * @return {Promise<API.Result>}
+     */
+    allowNodeInRecommendations(remoteNodeName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const location = (0, util_1.ut) `/recommendations/nodes/excluded/${remoteNodeName}`;
+            return yield this.call("allowNodeInRecommendations", location, {
+                method: "DELETE", schema: "Result"
+            });
+        });
+    }
     /**
      * Send a request to the remote node.
      *