lemmy-js-client 0.19.0-rc.13 → 0.19.0-rc.15

package/dist/http.d.ts

@@ -31,11 +31,9 @@ import { CreatePrivateMessageReport } from "./types/CreatePrivateMessageReport";
 import { CreateSite } from "./types/CreateSite";
 import { CustomEmojiResponse } from "./types/CustomEmojiResponse";
 import { DeleteAccount } from "./types/DeleteAccount";
-import { DeleteAccountResponse } from "./types/DeleteAccountResponse";
 import { DeleteComment } from "./types/DeleteComment";
 import { DeleteCommunity } from "./types/DeleteCommunity";
 import { DeleteCustomEmoji } from "./types/DeleteCustomEmoji";
-import { DeleteCustomEmojiResponse } from "./types/DeleteCustomEmojiResponse";
 import { DeletePost } from "./types/DeletePost";
 import { DeletePrivateMessage } from "./types/DeletePrivateMessage";
 import { DistinguishComment } from "./types/DistinguishComment";
@@ -93,7 +91,6 @@ import { MarkPostAsRead } from "./types/MarkPostAsRead";
 import { MarkPrivateMessageAsRead } from "./types/MarkPrivateMessageAsRead";
 import { PasswordChangeAfterReset } from "./types/PasswordChangeAfterReset";
 import { PasswordReset } from "./types/PasswordReset";
-import { PasswordResetResponse } from "./types/PasswordResetResponse";
 import { PersonMentionResponse } from "./types/PersonMentionResponse";
 import { PostReportResponse } from "./types/PostReportResponse";
 import { PostResponse } from "./types/PostResponse";
@@ -102,7 +99,6 @@ import { PrivateMessageResponse } from "./types/PrivateMessageResponse";
 import { PrivateMessagesResponse } from "./types/PrivateMessagesResponse";
 import { PurgeComment } from "./types/PurgeComment";
 import { PurgeCommunity } from "./types/PurgeCommunity";
-import { PurgeItemResponse } from "./types/PurgeItemResponse";
 import { PurgePerson } from "./types/PurgePerson";
 import { PurgePost } from "./types/PurgePost";
 import { Register } from "./types/Register";
@@ -123,14 +119,15 @@ import { SearchResponse } from "./types/SearchResponse";
 import { SiteResponse } from "./types/SiteResponse";
 import { TransferCommunity } from "./types/TransferCommunity";
 import { VerifyEmail } from "./types/VerifyEmail";
-import { VerifyEmailResponse } from "./types/VerifyEmailResponse";
-import { UploadImage, UploadImageResponse } from "./types/others";
+import { DeleteImage, UploadImage, UploadImageResponse } from "./other_types";
 import { HideCommunity } from "./types/HideCommunity";
 import { BlockInstance } from "./types/BlockInstance";
 import { BlockInstanceResponse } from "./types/BlockInstanceResponse";
 import { GenerateTotpSecretResponse } from "./types/GenerateTotpSecretResponse";
 import { UpdateTotp } from "./types/UpdateTotp";
 import { UpdateTotpResponse } from "./types/UpdateTotpResponse";
+import { SuccessResponse } from "./types/SuccessResponse";
+import { LoginToken } from "./types/LoginToken";
 /**
  * Helps build lemmy HTTP requests.
  */
@@ -179,6 +176,31 @@ export declare class LemmyHttp {
      * `HTTP.POST /user/totp/generate`
      */
     generateTotpSecret(): Promise<GenerateTotpSecretResponse>;
+    /**
+     * Export a backup of your user settings, including your saved content,
+     * followed communities, and blocks.
+     *
+     * `HTTP.GET /user/export_settings`
+     */
+    exportSettings(): Promise<any>;
+    /**
+     * Import a backup of your user settings.
+     *
+     * `HTTP.POST /user/import_settings`
+     */
+    importSettings(form: any): Promise<SuccessResponse>;
+    /**
+     * List login tokens for your user
+     *
+     * `HTTP.GET /user/list_logins`
+     */
+    listLogins(): Promise<LoginToken[]>;
+    /**
+     * Returns an error message if your auth token is invalid
+     *
+     * `HTTP.GET /user/validate_auth`
+     */
+    validateAuth(): Promise<SuccessResponse>;
     /**
      * Enable / Disable TOTP / two-factor authentication.
      *
@@ -250,11 +272,11 @@ export declare class LemmyHttp {
      */
     deleteCommunity(form: DeleteCommunity): Promise<CommunityResponse>;
     /**
-     * Hide a community from public view.
+     * Hide a community from public / "All" view. Admins only.
      *
      * `HTTP.PUT /community/hide`
      */
-    hideCommunity(form: HideCommunity): Promise<CommunityResponse>;
+    hideCommunity(form: HideCommunity): Promise<SuccessResponse>;
     /**
      * A moderator remove for a community.
      *
@@ -314,7 +336,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /post/mark_as_read`
      */
-    markPostAsRead(form: MarkPostAsRead): Promise<PostResponse>;
+    markPostAsRead(form: MarkPostAsRead): Promise<SuccessResponse>;
     /**
      * A moderator can lock a post ( IE disable new comments ).
      *
@@ -507,6 +529,7 @@ export declare class LemmyHttp {
      * `HTTP.POST /user/login`
      */
     login(form: Login): Promise<LoginResponse>;
+    logout(): Promise<SuccessResponse>;
     /**
      * Get the details for a person.
      *
@@ -560,19 +583,19 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /user/delete_account`
      */
-    deleteAccount(form: DeleteAccount): Promise<DeleteAccountResponse>;
+    deleteAccount(form: DeleteAccount): Promise<SuccessResponse>;
     /**
      * Reset your password.
      *
      * `HTTP.POST /user/password_reset`
      */
-    passwordReset(form: PasswordReset): Promise<PasswordResetResponse>;
+    passwordReset(form: PasswordReset): Promise<SuccessResponse>;
     /**
      * Change your password from an email / token based reset.
      *
      * `HTTP.POST /user/password_change`
      */
-    passwordChangeAfterReset(form: PasswordChangeAfterReset): Promise<LoginResponse>;
+    passwordChangeAfterReset(form: PasswordChangeAfterReset): Promise<SuccessResponse>;
     /**
      * Mark all replies as read.
      *
@@ -584,7 +607,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.PUT /user/save_user_settings`
      */
-    saveUserSettings(form: SaveUserSettings): Promise<LoginResponse>;
+    saveUserSettings(form: SaveUserSettings): Promise<SuccessResponse>;
     /**
      * Change your user password.
      *
@@ -608,7 +631,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /user/verify_email`
      */
-    verifyEmail(form: VerifyEmail): Promise<VerifyEmailResponse>;
+    verifyEmail(form: VerifyEmail): Promise<SuccessResponse>;
     /**
      * Add an admin to your site.
      *
@@ -638,25 +661,25 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /admin/purge/person`
      */
-    purgePerson(form: PurgePerson): Promise<PurgeItemResponse>;
+    purgePerson(form: PurgePerson): Promise<SuccessResponse>;
     /**
      * Purge / Delete a community from the database.
      *
      * `HTTP.POST /admin/purge/community`
      */
-    purgeCommunity(form: PurgeCommunity): Promise<PurgeItemResponse>;
+    purgeCommunity(form: PurgeCommunity): Promise<SuccessResponse>;
     /**
      * Purge / Delete a post from the database.
      *
      * `HTTP.POST /admin/purge/post`
      */
-    purgePost(form: PurgePost): Promise<PurgeItemResponse>;
+    purgePost(form: PurgePost): Promise<SuccessResponse>;
     /**
      * Purge / Delete a comment from the database.
      *
      * `HTTP.POST /admin/purge/comment`
      */
-    purgeComment(form: PurgeComment): Promise<PurgeItemResponse>;
+    purgeComment(form: PurgeComment): Promise<SuccessResponse>;
     /**
      * Create a new custom emoji
      *
@@ -674,7 +697,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.Post /custom_emoji/delete`
      */
-    deleteCustomEmoji(form: DeleteCustomEmoji): Promise<DeleteCustomEmojiResponse>;
+    deleteCustomEmoji(form: DeleteCustomEmoji): Promise<SuccessResponse>;
     /**
      * Fetch federated instances.
      *
@@ -690,7 +713,11 @@ export declare class LemmyHttp {
     /**
      * Upload an image to the server.
      */
-    uploadImage({ image, auth, }: UploadImage): Promise<UploadImageResponse>;
+    uploadImage({ image }: UploadImage): Promise<UploadImageResponse>;
+    /**
+     * Delete a pictrs image
+     */
+    deleteImage({ token, filename }: DeleteImage): Promise<boolean>;
     /**
      * Set the headers (can be used to set the auth header)
      */

package/dist/http.js

@@ -27,7 +27,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LemmyHttp = void 0;
 const cross_fetch_1 = __importDefault(require("cross-fetch"));
 const form_data_1 = __importDefault(require("form-data"));
-const others_1 = require("./types/others");
+const other_types_1 = require("./other_types");
 var HttpType;
 (function (HttpType) {
     HttpType["Get"] = "GET";
@@ -49,7 +49,7 @@ class LemmyHttp {
         _LemmyHttp_headers.set(this, {});
         _LemmyHttp_pictrsUrl.set(this, void 0);
         _LemmyHttp_fetchFunction.set(this, cross_fetch_1.default);
-        __classPrivateFieldSet(this, _LemmyHttp_apiUrl, `${baseUrl.replace(/\/+$/, "")}/api/${others_1.VERSION}`, "f");
+        __classPrivateFieldSet(this, _LemmyHttp_apiUrl, `${baseUrl.replace(/\/+$/, "")}/api/${other_types_1.VERSION}`, "f");
         __classPrivateFieldSet(this, _LemmyHttp_pictrsUrl, `${baseUrl}/pictrs/image`, "f");
         if (options === null || options === void 0 ? void 0 : options.headers) {
             __classPrivateFieldSet(this, _LemmyHttp_headers, options.headers, "f");
@@ -100,6 +100,39 @@ class LemmyHttp {
     generateTotpSecret() {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/user/totp/generate", {});
     }
+    /**
+     * Export a backup of your user settings, including your saved content,
+     * followed communities, and blocks.
+     *
+     * `HTTP.GET /user/export_settings`
+     */
+    exportSettings() {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/user/export_settings", {});
+    }
+    /**
+     * Import a backup of your user settings.
+     *
+     * `HTTP.POST /user/import_settings`
+     */
+    importSettings(form) {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/user/import_settings", form);
+    }
+    /**
+     * List login tokens for your user
+     *
+     * `HTTP.GET /user/list_logins`
+     */
+    listLogins() {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/user/list_logins", {});
+    }
+    /**
+     * Returns an error message if your auth token is invalid
+     *
+     * `HTTP.GET /user/validate_auth`
+     */
+    validateAuth() {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/user/validate_auth", {});
+    }
     /**
      * Enable / Disable TOTP / two-factor authentication.
      *
@@ -193,7 +226,7 @@ class LemmyHttp {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/community/delete", form);
     }
     /**
-     * Hide a community from public view.
+     * Hide a community from public / "All" view. Admins only.
      *
      * `HTTP.PUT /community/hide`
      */
@@ -536,6 +569,9 @@ class LemmyHttp {
     login(form) {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/user/login", form);
     }
+    logout() {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/user/logout", {});
+    }
     /**
      * Get the details for a person.
      *
@@ -779,22 +815,15 @@ class LemmyHttp {
     /**
      * Upload an image to the server.
      */
-    uploadImage({ image, auth, }) {
-        var _a, _b, _c, _d;
+    uploadImage({ image }) {
         return __awaiter(this, void 0, void 0, function* () {
             const formData = createFormData(image);
-            // If auth cookie not already set by browser, set it with passed in auth
-            const headers = {};
-            if (!((_b = (_a = globalThis === null || globalThis === void 0 ? void 0 : globalThis.document) === null || _a === void 0 ? void 0 : _a.cookie) === null || _b === void 0 ? void 0 : _b.includes("auth=")) &&
-                !((_d = (_c = __classPrivateFieldGet(this, _LemmyHttp_headers, "f")) === null || _c === void 0 ? void 0 : _c.Cookie) === null || _d === void 0 ? void 0 : _d.includes("auth="))) {
-                headers.Cookie = `auth=${auth}`;
-            }
             let url = undefined;
             let delete_url = undefined;
             const response = yield __classPrivateFieldGet(this, _LemmyHttp_fetchFunction, "f").call(this, __classPrivateFieldGet(this, _LemmyHttp_pictrsUrl, "f"), {
                 method: HttpType.Post,
                 body: formData,
-                headers: Object.assign(Object.assign({}, __classPrivateFieldGet(this, _LemmyHttp_headers, "f")), headers),
+                headers: __classPrivateFieldGet(this, _LemmyHttp_headers, "f"),
             });
             if (response.status === 413) {
                 return { msg: "too_large" };
@@ -809,6 +838,19 @@ class LemmyHttp {
                 delete_url });
         });
     }
+    /**
+     * Delete a pictrs image
+     */
+    deleteImage({ token, filename }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const deleteUrl = `${__classPrivateFieldGet(this, _LemmyHttp_pictrsUrl, "f")}/delete/${token}/${filename}`;
+            const response = yield __classPrivateFieldGet(this, _LemmyHttp_fetchFunction, "f").call(this, deleteUrl, {
+                method: HttpType.Get,
+                headers: __classPrivateFieldGet(this, _LemmyHttp_headers, "f"),
+            });
+            return (yield response.status) == 204;
+        });
+    }
     /**
      * Set the headers (can be used to set the auth header)
      */
@@ -842,10 +884,10 @@ _LemmyHttp_apiUrl = new WeakMap(), _LemmyHttp_headers = new WeakMap(), _LemmyHtt
             json = yield response.json();
         }
         catch (error) {
-            throw response.statusText;
+            throw new Error(response.statusText);
         }
         if (!response.ok) {
-            throw (_a = json["error"]) !== null && _a !== void 0 ? _a : response.statusText;
+            throw new Error((_a = json["error"]) !== null && _a !== void 0 ? _a : response.statusText);
         }
         else {
             return json;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./http";
+export { ActivityId } from "./types/ActivityId";
 export { AddAdmin } from "./types/AddAdmin";
 export { AddAdminResponse } from "./types/AddAdminResponse";
 export { AddModToCommunity } from "./types/AddModToCommunity";
@@ -41,7 +42,6 @@ export { CommentSortType } from "./types/CommentSortType";
 export { CommentView } from "./types/CommentView";
 export { Community } from "./types/Community";
 export { CommunityAggregates } from "./types/CommunityAggregates";
-export { CommunityBlockId } from "./types/CommunityBlockId";
 export { CommunityBlockView } from "./types/CommunityBlockView";
 export { CommunityFollowerView } from "./types/CommunityFollowerView";
 export { CommunityId } from "./types/CommunityId";
@@ -65,11 +65,9 @@ export { CustomEmojiKeyword } from "./types/CustomEmojiKeyword";
 export { CustomEmojiResponse } from "./types/CustomEmojiResponse";
 export { CustomEmojiView } from "./types/CustomEmojiView";
 export { DeleteAccount } from "./types/DeleteAccount";
-export { DeleteAccountResponse } from "./types/DeleteAccountResponse";
 export { DeleteComment } from "./types/DeleteComment";
 export { DeleteCommunity } from "./types/DeleteCommunity";
 export { DeleteCustomEmoji } from "./types/DeleteCustomEmoji";
-export { DeleteCustomEmojiResponse } from "./types/DeleteCustomEmojiResponse";
 export { DeletePost } from "./types/DeletePost";
 export { DeletePrivateMessage } from "./types/DeletePrivateMessage";
 export { DistinguishComment } from "./types/DistinguishComment";
@@ -112,10 +110,10 @@ export { GetUnreadCountResponse } from "./types/GetUnreadCountResponse";
 export { GetUnreadRegistrationApplicationCountResponse } from "./types/GetUnreadRegistrationApplicationCountResponse";
 export { HideCommunity } from "./types/HideCommunity";
 export { ImageUpload } from "./types/ImageUpload";
-export { ImageUploadId } from "./types/ImageUploadId";
 export { Instance } from "./types/Instance";
 export { InstanceBlockView } from "./types/InstanceBlockView";
 export { InstanceId } from "./types/InstanceId";
+export { InstanceWithFederationState } from "./types/InstanceWithFederationState";
 export { Language } from "./types/Language";
 export { LanguageId } from "./types/LanguageId";
 export { LemmyErrorType } from "./types/LemmyErrorType";
@@ -139,6 +137,7 @@ export { LocalUserView } from "./types/LocalUserView";
 export { LockPost } from "./types/LockPost";
 export { Login } from "./types/Login";
 export { LoginResponse } from "./types/LoginResponse";
+export { LoginToken } from "./types/LoginToken";
 export { MarkCommentReplyAsRead } from "./types/MarkCommentReplyAsRead";
 export { MarkPersonMentionAsRead } from "./types/MarkPersonMentionAsRead";
 export { MarkPostAsRead } from "./types/MarkPostAsRead";
@@ -171,7 +170,6 @@ export { MyUserInfo } from "./types/MyUserInfo";
 export { PaginationCursor } from "./types/PaginationCursor";
 export { PasswordChangeAfterReset } from "./types/PasswordChangeAfterReset";
 export { PasswordReset } from "./types/PasswordReset";
-export { PasswordResetResponse } from "./types/PasswordResetResponse";
 export { Person } from "./types/Person";
 export { PersonAggregates } from "./types/PersonAggregates";
 export { PersonBlockId } from "./types/PersonBlockId";
@@ -181,7 +179,6 @@ export { PersonMention } from "./types/PersonMention";
 export { PersonMentionId } from "./types/PersonMentionId";
 export { PersonMentionResponse } from "./types/PersonMentionResponse";
 export { PersonMentionView } from "./types/PersonMentionView";
-export { PersonSortType } from "./types/PersonSortType";
 export { PersonView } from "./types/PersonView";
 export { Post } from "./types/Post";
 export { PostAggregates } from "./types/PostAggregates";
@@ -205,9 +202,9 @@ export { PrivateMessageView } from "./types/PrivateMessageView";
 export { PrivateMessagesResponse } from "./types/PrivateMessagesResponse";
 export { PurgeComment } from "./types/PurgeComment";
 export { PurgeCommunity } from "./types/PurgeCommunity";
-export { PurgeItemResponse } from "./types/PurgeItemResponse";
 export { PurgePerson } from "./types/PurgePerson";
 export { PurgePost } from "./types/PurgePost";
+export { ReadableFederationState } from "./types/ReadableFederationState";
 export { Register } from "./types/Register";
 export { RegistrationApplication } from "./types/RegistrationApplication";
 export { RegistrationApplicationResponse } from "./types/RegistrationApplicationResponse";
@@ -235,10 +232,10 @@ export { SiteResponse } from "./types/SiteResponse";
 export { SiteView } from "./types/SiteView";
 export { SortType } from "./types/SortType";
 export { SubscribedType } from "./types/SubscribedType";
+export { SuccessResponse } from "./types/SuccessResponse";
 export { Tagline } from "./types/Tagline";
 export { TransferCommunity } from "./types/TransferCommunity";
 export { UpdateTotp } from "./types/UpdateTotp";
 export { UpdateTotpResponse } from "./types/UpdateTotpResponse";
 export { VerifyEmail } from "./types/VerifyEmail";
-export { VerifyEmailResponse } from "./types/VerifyEmailResponse";
-export { UploadImage, UploadImageResponse, ImageFile } from "./types/others";
+export { UploadImage, UploadImageResponse, ImageFile, DeleteImage, } from "./other_types";

package/dist/{types/others.d.ts → other_types.d.ts}

@@ -2,10 +2,6 @@
 export declare const VERSION = "v3";
 export interface UploadImage {
     image: File | Buffer;
-    /**
-     * Optional if cookie with jwt set is already present. Otherwise, auth is required.
-     */
-    auth?: string;
 }
 export interface UploadImageResponse {
     /**
@@ -20,3 +16,7 @@ export interface ImageFile {
     file: string;
     delete_token: string;
 }
+export interface DeleteImage {
+    token: string;
+    filename: string;
+}

package/dist/types/ActivityId.d.ts

@@ -0,0 +1 @@
+export type ActivityId = number;

package/dist/types/CommentAggregates.d.ts

@@ -1,12 +1,9 @@
 import type { CommentId } from "./CommentId";
 export interface CommentAggregates {
-    id: number;
     comment_id: CommentId;
     score: number;
     upvotes: number;
     downvotes: number;
     published: string;
     child_count: number;
-    hot_rank: number;
-    controversy_rank: number;
 }

package/dist/types/CommentReplyView.d.ts

@@ -14,6 +14,8 @@ export interface CommentReplyView {
     recipient: Person;
     counts: CommentAggregates;
     creator_banned_from_community: boolean;
+    creator_is_moderator: boolean;
+    creator_is_admin: boolean;
     subscribed: SubscribedType;
     saved: boolean;
     creator_blocked: boolean;

package/dist/types/CommentView.d.ts

@@ -11,6 +11,8 @@ export interface CommentView {
     community: Community;
     counts: CommentAggregates;
     creator_banned_from_community: boolean;
+    creator_is_moderator: boolean;
+    creator_is_admin: boolean;
     subscribed: SubscribedType;
     saved: boolean;
     creator_blocked: boolean;

package/dist/types/CommunityAggregates.d.ts

@@ -1,6 +1,5 @@
 import type { CommunityId } from "./CommunityId";
 export interface CommunityAggregates {
-    id: number;
     community_id: CommunityId;
     subscribers: number;
     posts: number;
@@ -10,5 +9,4 @@ export interface CommunityAggregates {
     users_active_week: number;
     users_active_month: number;
     users_active_half_year: number;
-    hot_rank: number;
 }

package/dist/types/CustomEmojiKeyword.d.ts

@@ -1,6 +1,5 @@
 import type { CustomEmojiId } from "./CustomEmojiId";
 export interface CustomEmojiKeyword {
-    id: number;
     custom_emoji_id: CustomEmojiId;
     keyword: string;
 }

package/dist/types/FederatedInstances.d.ts

@@ -1,6 +1,6 @@
-import type { Instance } from "./Instance";
+import type { InstanceWithFederationState } from "./InstanceWithFederationState";
 export interface FederatedInstances {
-    linked: Array<Instance>;
-    allowed: Array<Instance>;
-    blocked: Array<Instance>;
+    linked: Array<InstanceWithFederationState>;
+    allowed: Array<InstanceWithFederationState>;
+    blocked: Array<InstanceWithFederationState>;
 }

package/dist/types/ImageUpload.d.ts

@@ -1,7 +1,5 @@
-import type { ImageUploadId } from "./ImageUploadId";
 import type { LocalUserId } from "./LocalUserId";
 export interface ImageUpload {
-    id: ImageUploadId;
     local_user_id: LocalUserId;
     pictrs_alias: string;
     pictrs_delete_token: string;

package/dist/types/InstanceWithFederationState.d.ts

@@ -0,0 +1,11 @@
+import type { InstanceId } from "./InstanceId";
+import type { ReadableFederationState } from "./ReadableFederationState";
+export interface InstanceWithFederationState {
+    id: InstanceId;
+    domain: string;
+    published: string;
+    updated?: string;
+    software?: string;
+    version?: string;
+    federation_state?: ReadableFederationState;
+}