pubky-app-specs 0.3.0-rc.0

package/pubky_app_specs.d.ts

@@ -0,0 +1,527 @@
+/* tslint:disable */
+/* eslint-disable */
+export function baseUriBuilder(user_id: string): string;
+export function userUriBuilder(user_id: string): string;
+export function postUriBuilder(author_id: string, post_id: string): string;
+/**
+ * Enum representing the layout of the feed.
+ */
+export enum PubkyAppFeedLayout {
+  Columns = 0,
+  Wide = 1,
+  Visual = 2,
+}
+/**
+ * Enum representing the reach of the feed.
+ */
+export enum PubkyAppFeedReach {
+  Following = 0,
+  Followers = 1,
+  Friends = 2,
+  All = 3,
+}
+/**
+ * Enum representing the sort order of the feed.
+ */
+export enum PubkyAppFeedSort {
+  Recent = 0,
+  Popularity = 1,
+}
+/**
+ * Represents the type of pubky-app posted data
+ * Used primarily to best display the content in UI
+ */
+export enum PubkyAppPostKind {
+  Short = 0,
+  Long = 1,
+  Image = 2,
+  Video = 3,
+  Link = 4,
+  File = 5,
+}
+export class BlobResult {
+  private constructor();
+  free(): void;
+  readonly blob: PubkyAppBlob;
+  readonly meta: Meta;
+}
+export class BookmarkResult {
+  private constructor();
+  free(): void;
+  readonly bookmark: PubkyAppBookmark;
+  readonly meta: Meta;
+}
+export class FeedResult {
+  private constructor();
+  free(): void;
+  readonly feed: PubkyAppFeed;
+  readonly meta: Meta;
+}
+export class FileResult {
+  private constructor();
+  free(): void;
+  readonly file: PubkyAppFile;
+  readonly meta: Meta;
+}
+export class FollowResult {
+  private constructor();
+  free(): void;
+  readonly follow: PubkyAppFollow;
+  readonly meta: Meta;
+}
+export class LastReadResult {
+  private constructor();
+  free(): void;
+  readonly last_read: PubkyAppLastRead;
+  readonly meta: Meta;
+}
+/**
+ * Each FFI function:
+ * - Accepts minimal fields in a JavaScript-friendly manner (e.g. strings, JSON).
+ * - Creates the Rust model, sanitizes, and validates it.
+ * - Generates the ID (if applicable).
+ * - Generates the path (if applicable).
+ * - Returns { json, id, path, url } or a descriptive error.
+ */
+export class Meta {
+  private constructor();
+  free(): void;
+  readonly id: string;
+  readonly path: string;
+  readonly url: string;
+}
+export class MuteResult {
+  private constructor();
+  free(): void;
+  readonly mute: PubkyAppMute;
+  readonly meta: Meta;
+}
+export class PostResult {
+  private constructor();
+  free(): void;
+  readonly post: PubkyAppPost;
+  readonly meta: Meta;
+}
+/**
+ * Represents a file uploaded by the user.
+ * URI: /pub/pubky.app/files/:file_id
+ */
+export class PubkyAppBlob {
+  private constructor();
+  free(): void;
+  /**
+   * Serialize to JSON for WASM.
+   */
+  toJson(): any;
+  /**
+   * Getter for the blob data as a `Uint8Array`.
+   */
+  readonly data: Uint8Array;
+}
+/**
+ * Represents raw homeserver bookmark with id
+ * URI: /pub/pubky.app/bookmarks/:bookmark_id
+ *
+ * Example URI:
+ *
+ * `/pub/pubky.app/bookmarks/AF7KQ6NEV5XV1EG5DVJ2E74JJ4`
+ *
+ * Where bookmark_id is Crockford-base32(Blake3("{uri_bookmarked}"")[:half])
+ */
+export class PubkyAppBookmark {
+  private constructor();
+  free(): void;
+  /**
+   * Serialize to JSON for WASM.
+   */
+  toJson(): any;
+  created_at: bigint;
+  /**
+   * Getter for `uri`.
+   */
+  readonly uri: string;
+}
+/**
+ * Represents a feed configuration.
+ */
+export class PubkyAppFeed {
+  private constructor();
+  free(): void;
+  /**
+   * Serialize to JSON for WASM.
+   */
+  toJson(): any;
+  created_at: bigint;
+  /**
+   * Getter for `feed`.
+   */
+  readonly feed: PubkyAppFeedConfig;
+  /**
+   * Getter for `name`.
+   */
+  readonly name: string;
+}
+/**
+ * Configuration object for the feed.
+ */
+export class PubkyAppFeedConfig {
+  private constructor();
+  free(): void;
+  /**
+   * Serialize to JSON for WASM.
+   */
+  toJson(): any;
+  /**
+   * Getter for `tags`.
+   */
+  readonly tags: string[] | undefined;
+  /**
+   * Getter for `name`.
+   */
+  readonly reach: PubkyAppFeedReach;
+  /**
+   * Getter for `layout`.
+   */
+  readonly layout: PubkyAppFeedLayout;
+  /**
+   * Getter for `sort`.
+   */
+  readonly sort: PubkyAppFeedSort;
+  /**
+   * Getter for `content`.
+   */
+  readonly content: PubkyAppPostKind | undefined;
+}
+/**
+ * Represents a file uploaded by the user.
+ * URI: /pub/pubky.app/files/:file_id
+ */
+export class PubkyAppFile {
+  private constructor();
+  free(): void;
+  toJson(): any;
+  created_at: bigint;
+  size: bigint;
+  readonly name: string;
+  readonly src: string;
+  readonly content_type: string;
+}
+/**
+ * Represents raw homeserver follow object with timestamp
+ *
+ * On follow objects, the main data is encoded in the path
+ *
+ * URI: /pub/pubky.app/follows/:user_id
+ *
+ * Example URI:
+ *
+ * `/pub/pubky.app/follows/pxnu33x7jtpx9ar1ytsi4yxbp6a5o36gwhffs8zoxmbuptici1jy`
+ */
+export class PubkyAppFollow {
+  private constructor();
+  free(): void;
+  toJson(): any;
+  created_at: bigint;
+}
+/**
+ * Represents the last read timestamp for notifications.
+ * URI: /pub/pubky.app/last_read
+ */
+export class PubkyAppLastRead {
+  private constructor();
+  free(): void;
+  /**
+   * Serialize to JSON for WASM.
+   */
+  toJson(): any;
+  timestamp: bigint;
+}
+/**
+ * Represents raw homeserver Mute object with timestamp
+ * URI: /pub/pubky.app/mutes/:user_id
+ *
+ * Example URI:
+ *
+ * `/pub/pubky.app/mutes/pxnu33x7jtpx9ar1ytsi4yxbp6a5o36gwhffs8zoxmbuptici1jy`
+ */
+export class PubkyAppMute {
+  private constructor();
+  free(): void;
+  toJson(): any;
+  created_at: bigint;
+}
+/**
+ * Represents raw post in homeserver with content and kind
+ * URI: /pub/pubky.app/posts/:post_id
+ * Where post_id is CrockfordBase32 encoding of timestamp
+ *
+ * Example URI:
+ *
+ * `/pub/pubky.app/posts/00321FCW75ZFY`
+ */
+export class PubkyAppPost {
+  free(): void;
+  toJson(): any;
+  /**
+   * Creates a new `PubkyAppPost` instance and sanitizes it.
+   */
+  constructor(content: string, kind: PubkyAppPostKind, parent?: string | null, embed?: PubkyAppPostEmbed | null, attachments?: string[] | null);
+  readonly content: string;
+  readonly kind: PubkyAppPostKind;
+  readonly parent: string | undefined;
+  readonly embed: PubkyAppPostEmbed | undefined;
+  readonly attachments: string[] | undefined;
+}
+/**
+ * Represents embedded content within a post
+ */
+export class PubkyAppPostEmbed {
+  free(): void;
+  constructor(uri: string, kind: PubkyAppPostKind);
+  readonly kind: PubkyAppPostKind;
+  readonly uri: string;
+}
+/**
+ * Represents raw homeserver tag with id
+ * URI: /pub/pubky.app/tags/:tag_id
+ *
+ * Example URI:
+ *
+ * `/pub/pubky.app/tags/FPB0AM9S93Q3M1GFY1KV09GMQM`
+ *
+ * Where tag_id is Crockford-base32(Blake3("{uri_tagged}:{label}")[:half])
+ */
+export class PubkyAppTag {
+  private constructor();
+  free(): void;
+  /**
+   * Serialize to JSON for WASM.
+   */
+  toJson(): any;
+  created_at: bigint;
+  /**
+   * Getter for `uri`.
+   */
+  readonly uri: string;
+  /**
+   * Getter for `label`.
+   */
+  readonly label: string;
+}
+/**
+ * URI: /pub/pubky.app/profile.json
+ */
+export class PubkyAppUser {
+  free(): void;
+  toJson(): any;
+  /**
+   * Creates a new `PubkyAppUser` instance and sanitizes it.
+   */
+  constructor(name: string, bio?: string | null, image?: string | null, links?: PubkyAppUserLink[] | null, status?: string | null);
+  readonly name: string;
+  readonly bio: string | undefined;
+  readonly image: string | undefined;
+  readonly links: PubkyAppUserLink[] | undefined;
+  readonly status: string | undefined;
+}
+/**
+ * Represents a user's single link with a title and URL.
+ */
+export class PubkyAppUserLink {
+  free(): void;
+  /**
+   * Creates a new `PubkyAppUserLink` instance and sanitizes it.
+   */
+  constructor(title: string, url: string);
+  readonly title: string;
+  readonly url: string;
+}
+/**
+ * Represents a user's single link with a title and URL.
+ */
+export class PubkySpecsBuilder {
+  free(): void;
+  /**
+   * Creates a new `PubkyAppBuilder` instance.
+   */
+  constructor(pubky_id: string);
+  createUser(name: string, bio: string | null | undefined, image: string | null | undefined, links: any, status?: string | null): UserResult;
+  createFeed(tags: any, reach: string, layout: string, sort: string, content: string | null | undefined, name: string): FeedResult;
+  createFile(name: string, src: string, content_type: string, size: bigint): FileResult;
+  createPost(content: string, kind: PubkyAppPostKind, parent?: string | null, embed?: PubkyAppPostEmbed | null, attachments?: string[] | null): PostResult;
+  createTag(uri: string, label: string): TagResult;
+  createBookmark(uri: string): BookmarkResult;
+  createFollow(followee_id: string): FollowResult;
+  createMute(mutee_id: string): MuteResult;
+  createLastRead(): LastReadResult;
+  createBlob(blob_data: any): BlobResult;
+}
+export class TagResult {
+  private constructor();
+  free(): void;
+  readonly tag: PubkyAppTag;
+  readonly meta: Meta;
+}
+export class UserResult {
+  private constructor();
+  free(): void;
+  readonly user: PubkyAppUser;
+  readonly meta: Meta;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_pubkyappbookmark_free: (a: number, b: number) => void;
+  readonly __wbg_get_pubkyappbookmark_created_at: (a: number) => bigint;
+  readonly __wbg_set_pubkyappbookmark_created_at: (a: number, b: bigint) => void;
+  readonly pubkyappbookmark_toJson: (a: number) => [number, number, number];
+  readonly pubkyappbookmark_uri: (a: number) => [number, number];
+  readonly __wbg_pubkyappfeedconfig_free: (a: number, b: number) => void;
+  readonly pubkyappfeedconfig_toJson: (a: number) => [number, number, number];
+  readonly pubkyappfeedconfig_tags: (a: number) => [number, number];
+  readonly pubkyappfeedconfig_reach: (a: number) => number;
+  readonly pubkyappfeedconfig_layout: (a: number) => number;
+  readonly pubkyappfeedconfig_sort: (a: number) => number;
+  readonly pubkyappfeedconfig_content: (a: number) => number;
+  readonly __wbg_pubkyappfeed_free: (a: number, b: number) => void;
+  readonly __wbg_get_pubkyappfeed_created_at: (a: number) => bigint;
+  readonly __wbg_set_pubkyappfeed_created_at: (a: number, b: bigint) => void;
+  readonly pubkyappfeed_toJson: (a: number) => [number, number, number];
+  readonly pubkyappfeed_feed: (a: number) => number;
+  readonly pubkyappfeed_name: (a: number) => [number, number];
+  readonly __wbg_pubkyappfile_free: (a: number, b: number) => void;
+  readonly __wbg_get_pubkyappfile_size: (a: number) => bigint;
+  readonly __wbg_set_pubkyappfile_size: (a: number, b: bigint) => void;
+  readonly pubkyappfile_name: (a: number) => [number, number];
+  readonly pubkyappfile_src: (a: number) => [number, number];
+  readonly pubkyappfile_content_type: (a: number) => [number, number];
+  readonly pubkyappfile_toJson: (a: number) => [number, number, number];
+  readonly __wbg_pubkyappblob_free: (a: number, b: number) => void;
+  readonly pubkyappblob_toJson: (a: number) => [number, number, number];
+  readonly pubkyappblob_data: (a: number) => any;
+  readonly __wbg_pubkyappfollow_free: (a: number, b: number) => void;
+  readonly pubkyappfollow_toJson: (a: number) => [number, number, number];
+  readonly pubkyapplastread_toJson: (a: number) => [number, number, number];
+  readonly pubkyappmute_toJson: (a: number) => [number, number, number];
+  readonly __wbg_pubkyapppostembed_free: (a: number, b: number) => void;
+  readonly pubkyapppostembed_new: (a: number, b: number, c: number) => number;
+  readonly pubkyapppostembed_kind: (a: number) => number;
+  readonly pubkyapppostembed_uri: (a: number) => [number, number];
+  readonly __wbg_pubkyapppost_free: (a: number, b: number) => void;
+  readonly pubkyapppost_content: (a: number) => [number, number];
+  readonly pubkyapppost_kind: (a: number) => number;
+  readonly pubkyapppost_parent: (a: number) => [number, number];
+  readonly pubkyapppost_embed: (a: number) => number;
+  readonly pubkyapppost_attachments: (a: number) => [number, number];
+  readonly pubkyapppost_toJson: (a: number) => [number, number, number];
+  readonly pubkyapppost_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
+  readonly __wbg_pubkyapptag_free: (a: number, b: number) => void;
+  readonly pubkyapptag_toJson: (a: number) => [number, number, number];
+  readonly pubkyapptag_uri: (a: number) => [number, number];
+  readonly pubkyapptag_label: (a: number) => [number, number];
+  readonly __wbg_pubkyappuser_free: (a: number, b: number) => void;
+  readonly pubkyappuser_name: (a: number) => [number, number];
+  readonly pubkyappuser_bio: (a: number) => [number, number];
+  readonly pubkyappuser_image: (a: number) => [number, number];
+  readonly pubkyappuser_links: (a: number) => [number, number];
+  readonly pubkyappuser_status: (a: number) => [number, number];
+  readonly pubkyappuser_toJson: (a: number) => [number, number, number];
+  readonly __wbg_pubkyappuserlink_free: (a: number, b: number) => void;
+  readonly pubkyappuserlink_title: (a: number) => [number, number];
+  readonly pubkyappuserlink_url: (a: number) => [number, number];
+  readonly pubkyappuser_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => number;
+  readonly pubkyappuserlink_new: (a: number, b: number, c: number, d: number) => number;
+  readonly baseUriBuilder: (a: number, b: number) => [number, number];
+  readonly userUriBuilder: (a: number, b: number) => [number, number];
+  readonly postUriBuilder: (a: number, b: number, c: number, d: number) => [number, number];
+  readonly __wbg_meta_free: (a: number, b: number) => void;
+  readonly meta_id: (a: number) => [number, number];
+  readonly meta_path: (a: number) => [number, number];
+  readonly meta_url: (a: number) => [number, number];
+  readonly __wbg_userresult_free: (a: number, b: number) => void;
+  readonly userresult_user: (a: number) => number;
+  readonly userresult_meta: (a: number) => number;
+  readonly __wbg_fileresult_free: (a: number, b: number) => void;
+  readonly fileresult_file: (a: number) => number;
+  readonly fileresult_meta: (a: number) => number;
+  readonly __wbg_followresult_free: (a: number, b: number) => void;
+  readonly followresult_follow: (a: number) => number;
+  readonly followresult_meta: (a: number) => number;
+  readonly __wbg_postresult_free: (a: number, b: number) => void;
+  readonly postresult_post: (a: number) => number;
+  readonly postresult_meta: (a: number) => number;
+  readonly __wbg_feedresult_free: (a: number, b: number) => void;
+  readonly feedresult_feed: (a: number) => number;
+  readonly feedresult_meta: (a: number) => number;
+  readonly __wbg_tagresult_free: (a: number, b: number) => void;
+  readonly tagresult_tag: (a: number) => number;
+  readonly tagresult_meta: (a: number) => number;
+  readonly __wbg_bookmarkresult_free: (a: number, b: number) => void;
+  readonly bookmarkresult_bookmark: (a: number) => number;
+  readonly bookmarkresult_meta: (a: number) => number;
+  readonly __wbg_blobresult_free: (a: number, b: number) => void;
+  readonly blobresult_blob: (a: number) => number;
+  readonly blobresult_meta: (a: number) => number;
+  readonly pubkyspecsbuilder_new: (a: number, b: number) => number;
+  readonly pubkyspecsbuilder_createUser: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: any, i: number, j: number) => [number, number, number];
+  readonly pubkyspecsbuilder_createFeed: (a: number, b: any, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number) => [number, number, number];
+  readonly pubkyspecsbuilder_createFile: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: bigint) => [number, number, number];
+  readonly pubkyspecsbuilder_createPost: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => [number, number, number];
+  readonly pubkyspecsbuilder_createTag: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
+  readonly pubkyspecsbuilder_createBookmark: (a: number, b: number, c: number) => [number, number, number];
+  readonly pubkyspecsbuilder_createFollow: (a: number, b: number, c: number) => [number, number, number];
+  readonly pubkyspecsbuilder_createMute: (a: number, b: number, c: number) => [number, number, number];
+  readonly pubkyspecsbuilder_createLastRead: (a: number) => [number, number, number];
+  readonly pubkyspecsbuilder_createBlob: (a: number, b: any) => [number, number, number];
+  readonly __wbg_set_pubkyappfile_created_at: (a: number, b: bigint) => void;
+  readonly __wbg_set_pubkyappfollow_created_at: (a: number, b: bigint) => void;
+  readonly __wbg_set_pubkyapplastread_timestamp: (a: number, b: bigint) => void;
+  readonly __wbg_set_pubkyappmute_created_at: (a: number, b: bigint) => void;
+  readonly __wbg_set_pubkyapptag_created_at: (a: number, b: bigint) => void;
+  readonly __wbg_get_pubkyappmute_created_at: (a: number) => bigint;
+  readonly __wbg_get_pubkyapplastread_timestamp: (a: number) => bigint;
+  readonly __wbg_get_pubkyappfollow_created_at: (a: number) => bigint;
+  readonly __wbg_get_pubkyappfile_created_at: (a: number) => bigint;
+  readonly __wbg_get_pubkyapptag_created_at: (a: number) => bigint;
+  readonly muteresult_mute: (a: number) => number;
+  readonly lastreadresult_last_read: (a: number) => number;
+  readonly __wbg_pubkyspecsbuilder_free: (a: number, b: number) => void;
+  readonly muteresult_meta: (a: number) => number;
+  readonly lastreadresult_meta: (a: number) => number;
+  readonly __wbg_muteresult_free: (a: number, b: number) => void;
+  readonly __wbg_lastreadresult_free: (a: number, b: number) => void;
+  readonly __wbg_pubkyappmute_free: (a: number, b: number) => void;
+  readonly __wbg_pubkyapplastread_free: (a: number, b: number) => void;
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly __externref_table_alloc: () => number;
+  readonly __wbindgen_export_4: WebAssembly.Table;
+  readonly __externref_table_dealloc: (a: number) => void;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly __externref_drop_slice: (a: number, b: number) => void;
+  readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+*
+* @returns {InitOutput}
+*/
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;