pubky-app-specs 0.4.2 → 0.4.4

package/README.md

@@ -71,12 +71,12 @@ async function createUser(pubkyId) {
   const specs = new PubkySpecsBuilder(pubkyId);
 
   // Create user object with minimal fields
-  const {user, meta} = specs.createUser(
+  const { user, meta } = specs.createUser(
     "Alice", // Name
     "Hello from WASM", // Bio
     null, // Image URL or File
     null, // Links
-    "active" // Status
+    "active", // Status
   );
 
   // meta contains { id, path, url }.
@@ -112,12 +112,12 @@ async function createPost(pubkyId, content) {
   const specs = new PubkySpecsBuilder(pubkyId);
 
   // Create the Post object
-  const {post, meta} = specs.createPost(
+  const { post, meta } = specs.createPost(
     content,
     PubkyAppPostKind.Short,
     null, // parent post URI (for replies)
     null, // embed object (for reposts)
-    null  // attachments (array of file URLs, max 3)
+    null, // attachments (array of file URLs, max 3)
   );
 
   // Store the post
@@ -128,7 +128,7 @@ async function createPost(pubkyId, content) {
   });
 
   console.log("Post stored at:", meta.url);
-  return {post, meta};
+  return { post, meta };
 }
 ```
 
@@ -143,12 +143,12 @@ async function createPostWithAttachments(pubkyId, content, fileUrls) {
   const specs = new PubkySpecsBuilder(pubkyId);
 
   // Create post with attachments (max 3 allowed)
-  const {post, meta} = specs.createPost(
+  const { post, meta } = specs.createPost(
     content,
     PubkyAppPostKind.Image,
     null, // parent
     null, // embed
-    fileUrls // e.g. ["pubky://user/pub/pubky.app/files/abc123"]
+    fileUrls, // e.g. ["pubky://user/pub/pubky.app/files/abc123"]
   );
 
   const postJson = post.toJson();
@@ -160,7 +160,7 @@ async function createPostWithAttachments(pubkyId, content, fileUrls) {
   });
 
   console.log("Post with attachments stored at:", meta.url);
-  return {post, meta};
+  return { post, meta };
 }
 ```
 
@@ -174,7 +174,7 @@ async function followUser(myPubkyId, userToFollow) {
   const client = new Client();
   const specs = new PubkySpecsBuilder(myPubkyId);
 
-  const {follow, meta} = specs.createFollow(userToFollow);
+  const { follow, meta } = specs.createFollow(userToFollow);
 
   // We only need to store the JSON in the homeserver
   await client.fetch(meta.url, {
@@ -215,7 +215,7 @@ async function uploadFile(pubkyId, fileData, fileName, contentType, fileSize) {
 
   // First, create and store the blob (raw binary data)
   const { blob, meta: blobMeta } = specs.createBlob(fileData);
-  
+
   await client.fetch(blobMeta.url, {
     method: "PUT",
     body: JSON.stringify(blob.toJson()),
@@ -223,10 +223,10 @@ async function uploadFile(pubkyId, fileData, fileName, contentType, fileSize) {
 
   // Then create the file metadata pointing to the blob
   const { file, meta: fileMeta } = specs.createFile(
-    fileName,       // e.g. "vacation-photo.jpg"
-    blobMeta.url,   // Reference to the blob
-    contentType,    // e.g. "image/jpeg"
-    fileSize        // Size in bytes
+    fileName, // e.g. "vacation-photo.jpg"
+    blobMeta.url, // Reference to the blob
+    contentType, // e.g. "image/jpeg"
+    fileSize, // Size in bytes
   );
 
   await client.fetch(fileMeta.url, {
@@ -287,16 +287,16 @@ const userId = "8kkppkmiubfq4pxn6f73nqrhhhgkb5xyfprntc9si3np9ydbotto";
 const targetUserId = "dzswkfy7ek3bqnoc89jxuqqfbzhjrj6mi8qthgbxxcqkdugm3rio";
 
 // Build URIs for different resources
-userUriBuilder(userId);                    // pubky://{userId}/pub/pubky.app/profile.json
-postUriBuilder(userId, "0033SSE3B1FQ0");   // pubky://{userId}/pub/pubky.app/posts/{postId}
-bookmarkUriBuilder(userId, "ABC123");      // pubky://{userId}/pub/pubky.app/bookmarks/{bookmarkId}
-followUriBuilder(userId, targetUserId);    // pubky://{userId}/pub/pubky.app/follows/{targetUserId}
-tagUriBuilder(userId, "XYZ789");           // pubky://{userId}/pub/pubky.app/tags/{tagId}
-muteUriBuilder(userId, targetUserId);      // pubky://{userId}/pub/pubky.app/mutes/{targetUserId}
-lastReadUriBuilder(userId);                // pubky://{userId}/pub/pubky.app/last_read
-blobUriBuilder(userId, "BLOB123");         // pubky://{userId}/pub/pubky.app/blobs/{blobId}
-fileUriBuilder(userId, "FILE456");         // pubky://{userId}/pub/pubky.app/files/{fileId}
-feedUriBuilder(userId, "FEED789");         // pubky://{userId}/pub/pubky.app/feeds/{feedId}
+userUriBuilder(userId); // pubky://{userId}/pub/pubky.app/profile.json
+postUriBuilder(userId, "0033SSE3B1FQ0"); // pubky://{userId}/pub/pubky.app/posts/{postId}
+bookmarkUriBuilder(userId, "ABC123"); // pubky://{userId}/pub/pubky.app/bookmarks/{bookmarkId}
+followUriBuilder(userId, targetUserId); // pubky://{userId}/pub/pubky.app/follows/{targetUserId}
+tagUriBuilder(userId, "XYZ789"); // pubky://{userId}/pub/pubky.app/tags/{tagId}
+muteUriBuilder(userId, targetUserId); // pubky://{userId}/pub/pubky.app/mutes/{targetUserId}
+lastReadUriBuilder(userId); // pubky://{userId}/pub/pubky.app/last_read
+blobUriBuilder(userId, "BLOB123"); // pubky://{userId}/pub/pubky.app/blobs/{blobId}
+fileUriBuilder(userId, "FILE456"); // pubky://{userId}/pub/pubky.app/files/{fileId}
+feedUriBuilder(userId, "FEED789"); // pubky://{userId}/pub/pubky.app/feeds/{feedId}
 ```
 
 ---
@@ -330,6 +330,80 @@ A `ParsedUriResult` object with:
 
 ---
 
+## Validation limits
+
+Validation limits are published as JSON so UIs and tests can reuse the
+canonical rules without WASM, plus optional WASM accessors when needed.
+
+### ✅ Recommended (no WASM)
+
+**Named export from the package root:**
+
+```js
+import { validationLimits, getValidationLimits } from "pubky-app-specs";
+
+console.log(validationLimits);
+const copy = getValidationLimits();
+```
+
+**Direct subpath import (ESM):**
+
+```js
+import limits from "pubky-app-specs/validationLimits";
+// or
+import limitsJson from "pubky-app-specs/validationLimits.json";
+```
+
+**Direct subpath import (CJS):**
+
+```js
+const { validationLimits, getValidationLimits } = require("pubky-app-specs");
+// or
+const limits = require("pubky-app-specs/validationLimits");
+```
+
+### WASM accessors
+
+```js
+import { PubkySpecsBuilder, getValidationLimits } from "pubky-app-specs";
+
+const limitsFromWasm = getValidationLimits();
+
+const builder = new PubkySpecsBuilder("pubky_id_here");
+const limitsFromBuilder = builder.validationLimits;
+```
+
+Example output shape:
+
+```json
+{
+  "maxBlobSizeBytes": 104857600,
+  "maxFileSizeBytes": 104857600,
+  "tagLabelMinLength": 1,
+  "tagLabelMaxLength": 20,
+  "tagInvalidChars": [",", ":", " ", "\t", "\n", "\r"],
+  "userNameMinLength": 3,
+  "userNameMaxLength": 50,
+  "userBioMaxLength": 160,
+  "userImageUrlMaxLength": 300,
+  "userLinksMaxCount": 5,
+  "userLinkTitleMaxLength": 100,
+  "userLinkUrlMaxLength": 300,
+  "userStatusMaxLength": 50,
+  "postShortContentMaxLength": 2000,
+  "postLongContentMaxLength": 50000,
+  "postAttachmentsMaxCount": 4,
+  "postAttachmentUrlMaxLength": 200,
+  "postAllowedAttachmentProtocols": ["pubky", "http", "https"],
+  "fileNameMinLength": 1,
+  "fileNameMaxLength": 255,
+  "fileSrcMaxLength": 1024,
+  "feedTagsMaxCount": 5
+}
+```
+
+---
+
 ## 📄 License
 
 MIT

package/index.cjs

@@ -446,6 +446,24 @@ module.exports.lastReadUriBuilder = function(author_id) {
     }
 };
 
+/**
+ * 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.
+ * Returns validation limits as a JSON value for client-side use without a builder.
+ * @returns {any}
+ */
+module.exports.getValidationLimits = function() {
+    const ret = wasm.getValidationLimits();
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+};
+
 /**
  * Returns the list of valid MIME types for file attachments.
  *
@@ -815,14 +833,7 @@ module.exports.LastReadResult = LastReadResult;
 const MetaFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
     : new FinalizationRegistry(ptr => wasm.__wbg_meta_free(ptr >>> 0, 1));
-/**
- * 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.
- */
+
 class Meta {
 
     static __wrap(ptr) {
@@ -2311,6 +2322,17 @@ class PubkySpecsBuilder {
         PubkySpecsBuilderFinalization.register(this, this.__wbg_ptr, this);
         return this;
     }
+    /**
+     * Returns validation limits as a JSON value for client-side use.
+     * @returns {any}
+     */
+    get validationLimits() {
+        const ret = wasm.pubkyspecsbuilder_validationLimits(this.__wbg_ptr);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        return takeFromExternrefTable0(ret[0]);
+    }
     /**
      * @param {string} name
      * @param {string | null | undefined} bio
@@ -2617,6 +2639,11 @@ module.exports.__wbg_entries_3265d4158b33e5dc = function(arg0) {
     return ret;
 };
 
+module.exports.__wbg_fromCodePoint_f37c25c172f2e8b5 = function() { return handleError(function (arg0) {
+    const ret = String.fromCodePoint(arg0 >>> 0);
+    return ret;
+}, arguments) };
+
 module.exports.__wbg_get_67b2ba62fc30de12 = function() { return handleError(function (arg0, arg1) {
     const ret = Reflect.get(arg0, arg1);
     return ret;