pubky-app-specs 0.3.0-rc.0 → 0.3.0-rc2

package/README.md

@@ -165,3 +165,30 @@ This library supports many more domain objects beyond `User` and `Post`. Here ar
 - **LastRead**: `createLastRead(...)`
 
 Each has a `meta` field for storing relevant IDs/paths and a typed data object.
+
+## 📌 Parsing a Pubky URI
+
+The `parse_uri()` function converts a Pubky URI string into a strongly typed object.
+
+**Usage:**
+
+```js
+import { parse_uri } from "pubky-app-specs";
+
+try {
+  const result = parse_uri("pubky://userID/pub/pubky.app/posts/postID");
+  console.log(result.user_id); // "userID"
+  console.log(result.resource); // e.g. "posts"
+  console.log(result.resource_id); // "postID" or null
+} catch (error) {
+  console.error("URI parse error:", error);
+}
+```
+
+**Returns:**
+
+A `ParsedUriResult` object with:
+
+- **user_id:** The parsed user identifier.
+- **resource:** A string indicating the resource type.
+- **resource_id:** An optional resource identifier.

package/package.json

@@ -2,7 +2,7 @@
   "name": "pubky-app-specs",
   "type": "module",
   "description": "Pubky.app Data Model Specifications",
-  "version": "0.3.0-rc.0",
+  "version": "0.3.0-rc2",
   "license": "MIT",
   "collaborators": [
     "SHAcollision"

package/pubky_app_specs.d.ts

@@ -3,6 +3,42 @@
 export function baseUriBuilder(user_id: string): string;
 export function userUriBuilder(user_id: string): string;
 export function postUriBuilder(author_id: string, post_id: string): string;
+/**
+ * Parses a Pubky URI and returns a strongly typed `ParsedUriResult`.
+ *
+ * This function wraps the internal ParsedUri ust parsing logic. It converts the result into a
+ * strongly typed object that is easier to use in TypeScript.
+ *
+ * # Parameters
+ *
+ * - `uri`: A string slice representing the Pubky URI. The URI should follow the format:
+ *   `pubky://<user_id>/pub/pubky.app/<resource>[/<id>]`.
+ *
+ * # Returns
+ *
+ * On success, returns a `ParsedUriResult` with:
+ * - `user_id`: the parsed user ID,
+ * - `resource`: a string (derived from the Display implementation of internal `Resource` enum),
+ * - `resource_id`: an optional resource identifier (if applicable).
+ *
+ * On failure, returns a JavaScript error (`String`) containing an error message.
+ *
+ * # Example (TypeScript)
+ *
+ * ```typescript
+ * import { parse_uri } from "pubky-app-specs";
+ *
+ * try {
+ *   const result = parse_uri("pubky://user123/pub/pubky.app/posts/abc123");
+ *   console.log(result.user_id);        // e.g. "user123"
+ *   console.log(result.resource);    // e.g. "posts"
+ *   console.log(result.resource_id);      // e.g. "abc123" or null
+ * } catch (error) {
+ *   console.error("Error parsing URI:", error);
+ * }
+ * ```
+ */
+export function parse_uri(uri: string): ParsedUriResult;
 /**
  * Enum representing the layout of the feed.
  */
@@ -96,6 +132,28 @@ export class MuteResult {
   readonly mute: PubkyAppMute;
   readonly meta: Meta;
 }
+/**
+ * This object represents the result of parsing a Pubky URI. It contains:
+ * - `user_id`: the parsed user ID as a string.
+ * - `resource`: a string representing the kind of resource (derived from internal `Resource` enum Display).
+ * - `resource_id`: an optional resource identifier (if applicable).
+ */
+export class ParsedUriResult {
+  private constructor();
+  free(): void;
+  /**
+   * Returns the user ID.
+   */
+  readonly user_id: string;
+  /**
+   * Returns the resource kind.
+   */
+  readonly resource: string;
+  /**
+   * Returns the resource ID if present.
+   */
+  readonly resource_id: string | undefined;
+}
 export class PostResult {
   private constructor();
   free(): void;
@@ -336,6 +394,13 @@ export class PubkyAppUserLink {
   readonly title: string;
   readonly url: string;
 }
+/**
+ * Represents user data with name, bio, image, links, and status.
+ */
+export class PubkyId {
+  private constructor();
+  free(): void;
+}
 /**
  * Represents a user's single link with a title and URL.
  */
@@ -349,6 +414,10 @@ export class PubkySpecsBuilder {
   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;
+  /**
+   * Edits an existing post by updating its content while preserving its original ID and timestamp.
+   */
+  editPost(original_post: PubkyAppPost, post_id: string, new_content: string): PostResult;
   createTag(uri: string, label: string): TagResult;
   createBookmark(uri: string): BookmarkResult;
   createFollow(followee_id: string): FollowResult;
@@ -373,6 +442,9 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 
 export interface InitOutput {
   readonly memory: WebAssembly.Memory;
+  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_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;
@@ -398,9 +470,6 @@ export interface InitOutput {
   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];
@@ -464,36 +533,43 @@ export interface InitOutput {
   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_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: 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_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_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 __wbg_get_pubkyappmute_created_at: (a: number) => bigint;
+  readonly __wbg_get_pubkyappfile_created_at: (a: number) => bigint;
+  readonly __wbg_get_pubkyapplastread_timestamp: (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 __wbg_pubkyid_free: (a: number, b: number) => void;
   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_muteresult_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 muteresult_meta: (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;

package/pubky_app_specs.js

@@ -259,6 +259,53 @@ export function postUriBuilder(author_id, post_id) {
     }
 }
 
+/**
+ * Parses a Pubky URI and returns a strongly typed `ParsedUriResult`.
+ *
+ * This function wraps the internal ParsedUri ust parsing logic. It converts the result into a
+ * strongly typed object that is easier to use in TypeScript.
+ *
+ * # Parameters
+ *
+ * - `uri`: A string slice representing the Pubky URI. The URI should follow the format:
+ *   `pubky://<user_id>/pub/pubky.app/<resource>[/<id>]`.
+ *
+ * # Returns
+ *
+ * On success, returns a `ParsedUriResult` with:
+ * - `user_id`: the parsed user ID,
+ * - `resource`: a string (derived from the Display implementation of internal `Resource` enum),
+ * - `resource_id`: an optional resource identifier (if applicable).
+ *
+ * On failure, returns a JavaScript error (`String`) containing an error message.
+ *
+ * # Example (TypeScript)
+ *
+ * ```typescript
+ * import { parse_uri } from "pubky-app-specs";
+ *
+ * try {
+ *   const result = parse_uri("pubky://user123/pub/pubky.app/posts/abc123");
+ *   console.log(result.user_id);        // e.g. "user123"
+ *   console.log(result.resource);    // e.g. "posts"
+ *   console.log(result.resource_id);      // e.g. "abc123" or null
+ * } catch (error) {
+ *   console.error("Error parsing URI:", error);
+ * }
+ * ```
+ * @param {string} uri
+ * @returns {ParsedUriResult}
+ */
+export function parse_uri(uri) {
+    const ptr0 = passStringToWasm0(uri, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.parse_uri(ptr0, len0);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return ParsedUriResult.__wrap(ret[0]);
+}
+
 /**
  * Enum representing the layout of the feed.
  * @enum {0 | 1 | 2}
@@ -666,6 +713,83 @@ export class MuteResult {
     }
 }
 
+const ParsedUriResultFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_parseduriresult_free(ptr >>> 0, 1));
+/**
+ * This object represents the result of parsing a Pubky URI. It contains:
+ * - `user_id`: the parsed user ID as a string.
+ * - `resource`: a string representing the kind of resource (derived from internal `Resource` enum Display).
+ * - `resource_id`: an optional resource identifier (if applicable).
+ */
+export class ParsedUriResult {
+
+    static __wrap(ptr) {
+        ptr = ptr >>> 0;
+        const obj = Object.create(ParsedUriResult.prototype);
+        obj.__wbg_ptr = ptr;
+        ParsedUriResultFinalization.register(obj, obj.__wbg_ptr, obj);
+        return obj;
+    }
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        ParsedUriResultFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_parseduriresult_free(ptr, 0);
+    }
+    /**
+     * Returns the user ID.
+     * @returns {string}
+     */
+    get user_id() {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const ret = wasm.parseduriresult_user_id(this.__wbg_ptr);
+            deferred1_0 = ret[0];
+            deferred1_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+        }
+    }
+    /**
+     * Returns the resource kind.
+     * @returns {string}
+     */
+    get resource() {
+        let deferred1_0;
+        let deferred1_1;
+        try {
+            const ret = wasm.parseduriresult_resource(this.__wbg_ptr);
+            deferred1_0 = ret[0];
+            deferred1_1 = ret[1];
+            return getStringFromWasm0(ret[0], ret[1]);
+        } finally {
+            wasm.__wbindgen_free(deferred1_0, deferred1_1, 1);
+        }
+    }
+    /**
+     * Returns the resource ID if present.
+     * @returns {string | undefined}
+     */
+    get resource_id() {
+        const ret = wasm.parseduriresult_resource_id(this.__wbg_ptr);
+        let v1;
+        if (ret[0] !== 0) {
+            v1 = getStringFromWasm0(ret[0], ret[1]).slice();
+            wasm.__wbindgen_free(ret[0], ret[1] * 1, 1);
+        }
+        return v1;
+    }
+}
+
 const PostResultFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_postresult_free(ptr >>> 0, 1));
@@ -1761,6 +1885,27 @@ export class PubkyAppUserLink {
     }
 }
 
+const PubkyIdFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_pubkyid_free(ptr >>> 0, 1));
+/**
+ * Represents user data with name, bio, image, links, and status.
+ */
+export class PubkyId {
+
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        PubkyIdFinalization.unregister(this);
+        return ptr;
+    }
+
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_pubkyid_free(ptr, 0);
+    }
+}
+
 const PubkySpecsBuilderFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_pubkyspecsbuilder_free(ptr >>> 0, 1));
@@ -1788,7 +1933,10 @@ export class PubkySpecsBuilder {
         const ptr0 = passStringToWasm0(pubky_id, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
         const len0 = WASM_VECTOR_LEN;
         const ret = wasm.pubkyspecsbuilder_new(ptr0, len0);
-        this.__wbg_ptr = ret >>> 0;
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        this.__wbg_ptr = ret[0] >>> 0;
         PubkySpecsBuilderFinalization.register(this, this.__wbg_ptr, this);
         return this;
     }
@@ -1887,6 +2035,26 @@ export class PubkySpecsBuilder {
         }
         return PostResult.__wrap(ret[0]);
     }
+    /**
+     * Edits an existing post by updating its content while preserving its original ID and timestamp.
+     * @param {PubkyAppPost} original_post
+     * @param {string} post_id
+     * @param {string} new_content
+     * @returns {PostResult}
+     */
+    editPost(original_post, post_id, new_content) {
+        _assertClass(original_post, PubkyAppPost);
+        var ptr0 = original_post.__destroy_into_raw();
+        const ptr1 = passStringToWasm0(post_id, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ptr2 = passStringToWasm0(new_content, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len2 = WASM_VECTOR_LEN;
+        const ret = wasm.pubkyspecsbuilder_editPost(this.__wbg_ptr, ptr0, ptr1, len1, ptr2, len2);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return PostResult.__wrap(ret[0]);
+    }
     /**
      * @param {string} uri
      * @param {string} label