pubky-app-specs 0.3.5 → 0.4.0

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "pubky-app-specs",
-  "type": "module",
   "description": "Pubky.app Data Model Specifications",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "license": "MIT",
   "collaborators": [
     "SHAcollision"
@@ -13,13 +12,28 @@
   },
   "files": [
     "pubky_app_specs_bg.wasm",
-    "pubky_app_specs.js",
-    "pubky_app_specs.d.ts"
+    "pubky_app_specs.d.ts",
+    "index.cjs",
+    "index.js",
+    "example.js"
   ],
-  "main": "pubky_app_specs.js",
-  "homepage": "https://pubky.app",
+  "type": "module",
+  "main": "index.cjs",  
+  "module": "index.js",
   "types": "pubky_app_specs.d.ts",
-  "sideEffects": [
-    "./snippets/*"
+  "homepage": "https://pubky.app",
+  "sideEffects": false,
+  "devDependencies": {
+    "mocha": "^10.2.0"
+  },
+  "scripts": {
+    "build": "cargo run --bin bundle_specs_npm",
+    "example": "node example.js",
+    "test": "mocha test.js"
+  },
+  "keywords": [
+    "pubky-app",
+    "pubky-nexus",
+    "specs"
   ]
 }

package/pubky_app_specs.d.ts

@@ -1,8 +1,46 @@
 /* tslint:disable */
 /* eslint-disable */
 export function baseUriBuilder(user_id: string): string;
+/**
+ * Builds an User URI of the form "pubky://<user_pubky_id>/pub/pubky.app/profile.json"
+ */
 export function userUriBuilder(user_id: string): string;
+/**
+ * Builds a Post URI of the form "pubky://<author_id>/pub/pubky.app/posts/<post_id>"
+ */
 export function postUriBuilder(author_id: string, post_id: string): string;
+/**
+ * Builds a Follow URI of the form "pubky://<author_id>/pub/pubky.app/follows/<follow_id>"
+ */
+export function followUriBuilder(author_id: string, follow_id: string): string;
+/**
+ * Builds a Mute URI of the form "pubky://<author_id>/pub/pubky.app/mutes/<mute_id>"
+ */
+export function muteUriBuilder(author_id: string, mute_id: string): string;
+/**
+ * Builds a Bookmark URI of the form "pubky://<author_id>/pub/pubky.app/bookmarks/<bookmark_id>"
+ */
+export function bookmarkUriBuilder(author_id: string, bookmark_id: string): string;
+/**
+ * Builds a Tag URI of the form "pubky://<author_id>/pub/pubky.app/tags/<tag_id>"
+ */
+export function tagUriBuilder(author_id: string, tag_id: string): string;
+/**
+ * Builds a File URI of the form "pubky://<author_id>/pub/pubky.app/files/<file_id>"
+ */
+export function fileUriBuilder(author_id: string, file_id: string): string;
+/**
+ * Builds a Blob URI of the form "pubky://<author_id>/pub/pubky.app/blobs/<blob_id>"
+ */
+export function blobUriBuilder(author_id: string, blob_id: string): string;
+/**
+ * Builds a Feed URI of the form "pubky://<author_id>/pub/pubky.app/feeds/<feed_id>"
+ */
+export function feedUriBuilder(author_id: string, feed_id: string): string;
+/**
+ * Builds a LastRead URI of the form "pubky://<author_id>/pub/pubky.app/last_read"
+ */
+export function lastReadUriBuilder(author_id: string): string;
 /**
  * Parses a Pubky URI and returns a strongly typed `ParsedUriResult`.
  *
@@ -161,8 +199,8 @@ export class PostResult {
   readonly meta: Meta;
 }
 /**
- * Represents a file uploaded by the user.
- * URI: /pub/pubky.app/files/:file_id
+ * Represents a blob, which backs a file uploaded by the user.
+ * URI: /pub/pubky.app/blobs/:blob_id
  */
 export class PubkyAppBlob {
   private constructor();
@@ -325,7 +363,7 @@ export class PubkyAppPost {
    */
   constructor(content: string, kind: PubkyAppPostKind, parent?: string | null, embed?: PubkyAppPostEmbed | null, attachments?: string[] | null);
   readonly content: string;
-  readonly kind: PubkyAppPostKind;
+  readonly kind: string;
   readonly parent: string | undefined;
   readonly embed: PubkyAppPostEmbed | undefined;
   readonly attachments: string[] | undefined;
@@ -336,7 +374,7 @@ export class PubkyAppPost {
 export class PubkyAppPostEmbed {
   free(): void;
   constructor(uri: string, kind: PubkyAppPostKind);
-  readonly kind: PubkyAppPostKind;
+  readonly kind: string;
   readonly uri: string;
 }
 /**
@@ -439,178 +477,3 @@ export class UserResult {
   readonly user: PubkyAppUser;
   readonly meta: Meta;
 }
-
-export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
-
-export interface InitOutput {
-  readonly memory: WebAssembly.Memory;
-  readonly __wbg_pubkyappblob_free: (a: number, b: number) => void;
-  readonly pubkyappblob_fromJson: (a: any) => [number, number, number];
-  readonly pubkyappblob_toJson: (a: number) => [number, number, number];
-  readonly pubkyappblob_data: (a: number) => any;
-  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_fromJson: (a: any) => [number, number, number];
-  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_fromJson: (a: any) => [number, number, number];
-  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_fromJson: (a: any) => [number, number, number];
-  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) => number;
-  readonly __wbg_set_pubkyappfile_size: (a: number, b: number) => 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_fromJson: (a: any) => [number, number, number];
-  readonly pubkyappfile_toJson: (a: number) => [number, number, number];
-  readonly __wbg_pubkyappfollow_free: (a: number, b: number) => void;
-  readonly pubkyappfollow_fromJson: (a: any) => [number, number, number];
-  readonly pubkyappfollow_toJson: (a: number) => [number, number, number];
-  readonly pubkyapplastread_fromJson: (a: any) => [number, number, number];
-  readonly pubkyapplastread_toJson: (a: number) => [number, number, number];
-  readonly pubkyappmute_fromJson: (a: any) => [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_fromJson: (a: any) => [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_fromJson: (a: any) => [number, number, number];
-  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_fromJson: (a: any) => [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 __wbg_pubkyid_free: (a: number, b: number) => void;
-  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, 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: number) => [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_editPost: (a: number, b: number, c: number, d: number, e: number, f: 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_parseduriresult_free: (a: number, b: number) => void;
-  readonly parseduriresult_user_id: (a: number) => [number, number];
-  readonly parseduriresult_resource: (a: number) => [number, number];
-  readonly parseduriresult_resource_id: (a: number) => [number, number];
-  readonly parse_uri: (a: number, b: number) => [number, number, number];
-  readonly __wbg_set_pubkyapplastread_timestamp: (a: number, b: bigint) => void;
-  readonly __wbg_set_pubkyapptag_created_at: (a: number, b: bigint) => void;
-  readonly __wbg_set_pubkyappfollow_created_at: (a: number, b: bigint) => void;
-  readonly __wbg_set_pubkyappfile_created_at: (a: number, b: bigint) => void;
-  readonly __wbg_set_pubkyappmute_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_pubkyapptag_created_at: (a: number) => bigint;
-  readonly __wbg_get_pubkyappfile_created_at: (a: number) => bigint;
-  readonly __wbg_get_pubkyappfollow_created_at: (a: number) => bigint;
-  readonly __wbg_pubkyappmute_free: (a: number, b: number) => void;
-  readonly __wbg_pubkyapplastread_free: (a: number, b: number) => void;
-  readonly __wbg_muteresult_free: (a: number, b: number) => void;
-  readonly __wbg_pubkyspecsbuilder_free: (a: number, b: number) => void;
-  readonly __wbg_lastreadresult_free: (a: number, b: number) => void;
-  readonly muteresult_meta: (a: number) => number;
-  readonly muteresult_mute: (a: number) => number;
-  readonly lastreadresult_meta: (a: number) => number;
-  readonly lastreadresult_last_read: (a: number) => number;
-  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>;

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2024
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.