@enonic-types/lib-admin 8.0.4 → 8.1.0-B1

package/admin.d.ts

@@ -73,3 +73,40 @@ export interface ExtensionUrlParams {
  * @returns {string} URL.
  */
 export declare function extensionUrl(params: ExtensionUrlParams): string;
+export interface SetTopicParams {
+    name: string;
+    allow: string | string[];
+}
+/**
+ * Sets the state of an admin events topic owned by this application.
+ *
+ * The topic's canonical name is `<application-key>:<name>`. Subscribers address the topic by the
+ * canonical name over the `admin:events` websocket API. A non-empty `allow` registers the topic
+ * or updates its `allow`; the principals in `allow` and `role:system.admin` may subscribe, and
+ * updating re-evaluates current subscribers against the new list. An empty `allow` clears the
+ * registration, with the same
+ * effect as the application stopping: publishing fails and new subscriptions are denied, while
+ * existing subscriptions persist and resume when the topic is set again.
+ *
+ * @param {object} params JSON with the parameters.
+ * @param {string} params.name Local topic name: 1-255 characters, no `:`, no whitespace.
+ * @param {string|string[]} params.allow Principal key, or keys, allowed to subscribe, in addition
+ * to `role:system.admin`. An empty array clears the topic registration.
+ *
+ * @returns {string} The canonical topic name.
+ */
+export declare function setTopic(params: SetTopicParams): string;
+/**
+ * Publishes a message to an admin events topic owned by this application.
+ *
+ * The message is delivered to the sockets on this node holding an acknowledged subscription to the
+ * topic, stamped with a per-topic sequence number. Delivery is best effort.
+ *
+ * The message is not distributed over the cluster. Subscribers on other nodes receive it only if
+ * the application publishes on those nodes too.
+ *
+ * @param {string} name Local topic name, as passed to `setTopic`.
+ * @param {*} [message] Message data: an object, an array or a primitive value. Must be
+ * serializable to JSON and must not contain null values.
+ */
+export declare function sendToTopic(name: string, message?: object | string | number | boolean): void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/lib-admin",
-    "version": "8.0.4",
+    "version": "8.1.0-B1",
     "description": "Type definitions for lib-admin.",
     "types": "admin.d.ts",
     "files": [
@@ -27,7 +27,7 @@
     },
     "homepage": "https://github.com/enonic/xp/tree/master#readme",
     "dependencies": {
-        "@enonic-types/core": "8.0.4"
+        "@enonic-types/core": "8.1.0-B1"
     },
     "publishConfig": {
         "access": "public"