pubky-app-specs 0.3.5 → 0.4.0

package/README.md

@@ -1,4 +1,4 @@
-# 🦄 Pubky App Specs (WASM) · `pubky-app-specs`
+# Pubky App Specs · `pubky-app-specs`
 
 A WASM library for building and validating structured JSON models compatible with Pubky.App social powered by [`@synonymdev/pubky`](https://www.npmjs.com/package/@synonymdev/pubky). It handles domain objects like **Users**, **Posts**, **Feeds**, **Bookmarks**, **Tags**, and more. Each object is:
 
@@ -24,27 +24,28 @@ npm install pubky-app-specs
 yarn add pubky-app-specs
 ```
 
-> **Note**: This package uses WASM. Ensure your bundler or environment supports loading WASM modules (e.g. Next.js, Vite, etc.).
+> **Note**: This package uses WASM with embedded bytes for automatic initialization. No manual WASM loading required - just import and use!
 
 ---
 
 ## 🚀 Quick Start
 
-1. **Initialize** the WASM module.
+1. **Import** the library.
 2. **Construct** a `PubkySpecsBuilder(pubkyId)` object.
 3. **Create** validated domain objects (User, Post, Tag, etc.).
 4. **Store** them on the [PubKy homeserver](https://github.com/synonymdev/pubky) or any distributed storage solution you prefer.
 
-### Import & Initialize
+### Import & Usage
 
 ```js
-import init, { PubkySpecsBuilder } from "pubky-app-specs";
+// ES Modules
+import { PubkySpecsBuilder } from "pubky-app-specs";
 
-async function loadSpecs(pubkyId) {
-  // 1. Initialize WASM
-  await init();
+// OR CommonJS
+const { PubkySpecsBuilder } = require("pubky-app-specs/index.cjs");
 
-  // 2. Create a specs builder instance
+function loadSpecs(pubkyId) {
+  // Create a specs builder instance - WASM is already initialized
   const specs = new PubkySpecsBuilder(pubkyId);
   return specs;
 }
@@ -67,7 +68,7 @@ async function createUser(pubkyId) {
   const specs = new PubkySpecsBuilder(pubkyId);
 
   // Create user object with minimal fields
-  const userResult = specs.createUser(
+  const {user, meta} = specs.createUser(
     "Alice", // Name
     "Hello from WASM", // Bio
     null, // Image URL or File
@@ -75,11 +76,11 @@ async function createUser(pubkyId) {
     "active" // Status
   );
 
-  // userResult.meta contains { id, path, url }.
-  // userResult.user is the Rust "PubkyAppUser" object.
+  // meta contains { id, path, url }.
+  // user is the Rust "PubkyAppUser" object.
 
   // We bring the Rust object to JS using the .toJson() method.
-  const userJson = userResult.user.toJson();
+  const userJson = user.toJson();
 
   // Store in homeserver via pubky
   const response = await client.fetch(userResult.meta.url, {
@@ -109,7 +110,7 @@ async function createPost(pubkyId, content) {
   const specs = new PubkySpecsBuilder(pubkyId);
 
   // Create the Post object referencing your (optional) attachment
-  const postResult = specs.createPost(
+  const {post, meta} = specs.createPost(
     content,
     PubkyAppPostKind.Short,
     null, // parent post
@@ -118,14 +119,14 @@ async function createPost(pubkyId, content) {
   );
 
   // Store the post
-  const postJson = postResult.post.toJson();
-  await client.fetch(postResult.meta.url, {
+  const postJson = post.toJson();
+  await client.fetch(meta.url, {
     method: "PUT",
     body: JSON.stringify(postJson),
   });
 
-  console.log("Post stored at:", postResult.meta.url);
-  return postResult;
+  console.log("Post stored at:", meta.url);
+  return {post, meta};
 }
 ```
 
@@ -139,12 +140,12 @@ async function followUser(myPubkyId, userToFollow) {
   const client = new Client();
   const specs = new PubkySpecsBuilder(myPubkyId);
 
-  const followResult = specs.createFollow(userToFollow);
+  const {follow, meta} = specs.createFollow(userToFollow);
 
   // We only need to store the JSON in the homeserver
-  await client.fetch(followResult.meta.url, {
+  await client.fetch(meta.url, {
     method: "PUT",
-    body: JSON.stringify(followResult.follow.toJson()),
+    body: JSON.stringify(follow.toJson()),
   });
 
   console.log(`Successfully followed: ${userToFollow}`);

package/example.js

@@ -0,0 +1,93 @@
+import { PubkyAppPostKind, PubkySpecsBuilder, PubkyAppPostEmbed } from "./index.js";
+
+const OTTO = "8kkppkmiubfq4pxn6f73nqrhhhgkb5xyfprntc9si3np9ydbotto";
+const RIO = "dzswkfy7ek3bqnoc89jxuqqfbzhjrj6mi8qthgbxxcqkdugm3rio";
+
+// 👤 Create a user profile
+console.log("👤 Creating User Profile...");
+const specsBuilder = new PubkySpecsBuilder(OTTO);
+const { user, meta: userMeta } =
+  specsBuilder.createUser("Alice Smith", "Software Developer", null, null, "active");
+console.log("User Profile URL:", userMeta.url);
+console.log("User Data:", JSON.stringify(user.toJson(), null, 2));
+console.log("-".repeat(60));
+
+// 📝 Create different posts
+console.log("📝 Creating First Post...");
+const { post, meta } = specsBuilder.createPost("Hello, Pubky world! This is my first post.", PubkyAppPostKind.Short, null, null, null);
+console.log("Post ID:", meta.id);
+console.log("Post URL:", meta.url);
+console.log("Post Data:", JSON.stringify(post.toJson(), null, 2));
+console.log("-".repeat(60));
+
+console.log("💬 Creating Reply Post...");
+const { post: replyPost, meta: replyMeta } = specsBuilder.createPost("This is a reply to the first post!", PubkyAppPostKind.Short, userMeta.url, null, null);
+console.log("Reply Post ID:", replyMeta.id);
+console.log("Reply Post URL:", replyMeta.url);
+console.log("Reply Data:", JSON.stringify(replyPost.toJson(), null, 2));
+console.log("-".repeat(60));
+
+console.log("🔄 Creating Repost with Embed...");
+let embeed = new PubkyAppPostEmbed(`pubky://${RIO}/pub/pubky.app/posts/0033SREKPC4N0`, PubkyAppPostKind.Video);
+const { post: repost, meta: repostMeta } = specsBuilder.createPost("This is a repost to random post!", PubkyAppPostKind.Short, null, embeed, null);
+console.log("Repost Post ID:", repostMeta.id);
+console.log("Repost Post URL:", repostMeta.url);
+console.log("Repost Data:", JSON.stringify(repost.toJson(), null, 2));
+console.log("-".repeat(60));
+
+console.log("🔖 Creating Bookmark...");
+let { bookmark, meta: bookmarkMeta } = specsBuilder.createBookmark(`pubky://${RIO}/pub/pubky.app/posts/0033SREKPC4N0`);
+console.log("Bookmark ID:", bookmarkMeta.id);
+console.log("Bookmark URL:", bookmarkMeta.url);
+console.log("Bookmark Data:", JSON.stringify(bookmark.toJson(), null, 2));
+console.log("-".repeat(60));
+
+console.log("👥 Creating Follow...");
+let {follow, meta: followMeta} = specsBuilder.createFollow(RIO);
+console.log("Follow ID:", followMeta.id);
+console.log("Follow URL:", followMeta.url);
+console.log("Follow Data:", JSON.stringify(follow.toJson(), null, 2));
+console.log("-".repeat(60));
+
+console.log("🏷️ Creating Tag...");
+let {tag, meta: tagMeta} = specsBuilder.createTag(`pubky://${OTTO}/pub/pubky.app/profile.json`, "otto");
+console.log("Tag ID:", tagMeta.id);
+console.log("Tag URL:", tagMeta.url);
+console.log("Tag Data:", JSON.stringify(tag.toJson(), null, 2));
+console.log("-".repeat(60));
+
+console.log("🔇 Creating Mute...");
+let {mute, meta: muteMeta} = specsBuilder.createMute(RIO);
+console.log("Mute ID:", muteMeta.id);
+console.log("Mute URL:", muteMeta.url);
+console.log("Mute Data:", JSON.stringify(mute.toJson(), null, 2));
+console.log("-".repeat(60));
+
+console.log("📖 Creating Last Read...");
+let {last_read, meta: lastReadMeta} = specsBuilder.createLastRead(RIO);
+console.log("LastRead Timestamp:", lastReadMeta.url);
+console.log("LastRead Data:", JSON.stringify(last_read.toJson(), null, 2));
+console.log("-".repeat(60));
+
+console.log("💾 Creating Blob...");
+let { blob, meta: blobMeta } = specsBuilder.createBlob(Array.from({length: 8}, () => Math.floor(Math.random() * 256)));
+console.log("Blob ID:", blobMeta.id);
+console.log("Blob URL:", blobMeta.url);
+console.log("Blob Data:", JSON.stringify(blob.toJson(), null, 2));
+console.log("-".repeat(60));
+
+console.log("📄 Creating File...");
+let { file, meta: fileMeta } = specsBuilder.createFile("My adventures", blobMeta.url, "application/pdf", 88);
+console.log("File ID:", fileMeta.id);
+console.log("File URL:", fileMeta.url);
+console.log("File Data:", JSON.stringify(file.toJson(), null, 2));
+console.log("-".repeat(60));
+
+console.log("📰 Creating Feed...");
+let { feed, meta: feedMeta } = specsBuilder.createFeed(["mountain","hike"], "all", "columns", "recent", "image", "nature");
+console.log("Feed ID:", feedMeta.id);
+console.log("Feed URL:", feedMeta.url);
+console.log("Feed Data:", JSON.stringify(feed.toJson(), null, 2));
+console.log("=".repeat(60));
+console.log("🎉 All Pubky App Specs examples completed successfully!");
+console.log("=".repeat(60));