me3-protocol 2.6.0 → 2.7.0

package/dist/index.d.ts

@@ -26,6 +26,26 @@ export interface Me3Post {
     /** Short excerpt for archive/listing (optional) */
     excerpt?: string;
 }
+export interface Me3Product {
+    /** URL-friendly identifier */
+    slug: string;
+    /** Product name */
+    title: string;
+    /** Path to markdown file (relative to me.json) */
+    file: string;
+    /** Product price in cents (e.g., 2999 for $29.99) */
+    price: number;
+    /** Currency code */
+    currency: "USD" | "GBP" | "EUR";
+    /** Product images (URLs) */
+    images?: string[];
+    /** Whether product is available for purchase */
+    available?: boolean;
+    /** ISO publish date (optional) */
+    publishedAt?: string;
+    /** Short excerpt for listings (optional) */
+    excerpt?: string;
+}
 export interface Me3Links {
     website?: string;
     github?: string;
@@ -137,6 +157,20 @@ export interface Me3IntentBook {
     /** Pricing configuration for paid meetings (optional) */
     pricing?: Me3BookingPricing;
 }
+/**
+ * Shop intent.
+ * Declares that the person sells products via a simple shop.
+ */
+export interface Me3IntentShop {
+    /** Whether shop is enabled */
+    enabled: boolean;
+    /** Shop title/name */
+    title?: string;
+    /** Shop description */
+    description?: string;
+    /** Shop currency */
+    currency: "USD" | "GBP" | "EUR";
+}
 /**
  * Intents object - declares what actions visitors/agents can take.
  * This is the machine-readable API contract for interacting with a person.
@@ -146,6 +180,8 @@ export interface Me3Intents {
     subscribe?: Me3IntentSubscribe;
     /** Meeting booking */
     book?: Me3IntentBook;
+    /** Shop intent */
+    shop?: Me3IntentShop;
 }
 export interface Me3Profile {
     /** Protocol version */
@@ -170,6 +206,8 @@ export interface Me3Profile {
     pages?: Me3Page[];
     /** Blog posts (markdown) */
     posts?: Me3Post[];
+    /** Products (markdown) */
+    products?: Me3Product[];
     /**
      * Custom footer configuration.
      * - `undefined`: default footer behavior (renderer-defined)

package/dist/index.js

@@ -24,6 +24,7 @@ const MAX_FOOTER_LINK_TEXT_LENGTH = 60;
 const MAX_INTENT_TITLE_LENGTH = 100;
 const MAX_INTENT_DESCRIPTION_LENGTH = 300;
 const VALID_FREQUENCIES = ["daily", "weekly", "monthly", "irregular"];
+const VALID_CURRENCIES = ["USD", "GBP", "EUR"];
 /**
  * Validate a me3 profile object
  */
@@ -326,6 +327,90 @@ function validateProfile(data) {
             });
         }
     }
+    // Products (optional)
+    if (profile.products !== undefined) {
+        const products = profile.products;
+        if (!Array.isArray(products)) {
+            errors.push({ field: "products", message: "Products must be an array" });
+        }
+        else {
+            products.forEach((product, index) => {
+                if (!product || typeof product !== "object") {
+                    errors.push({
+                        field: `products[${index}]`,
+                        message: "Product must be an object",
+                    });
+                    return;
+                }
+                if (!product.slug || typeof product.slug !== "string") {
+                    errors.push({
+                        field: `products[${index}].slug`,
+                        message: "Product slug is required",
+                    });
+                }
+                if (!product.title || typeof product.title !== "string") {
+                    errors.push({
+                        field: `products[${index}].title`,
+                        message: "Product title is required",
+                    });
+                }
+                if (!product.file || typeof product.file !== "string") {
+                    errors.push({
+                        field: `products[${index}].file`,
+                        message: "Product file is required",
+                    });
+                }
+                if (typeof product.price !== "number") {
+                    errors.push({
+                        field: `products[${index}].price`,
+                        message: "Product price must be a number (in cents)",
+                    });
+                }
+                if (typeof product.currency !== "string" ||
+                    !VALID_CURRENCIES.includes(product.currency)) {
+                    errors.push({
+                        field: `products[${index}].currency`,
+                        message: `Product currency must be one of: ${VALID_CURRENCIES.join(", ")}`,
+                    });
+                }
+                if (product.available !== undefined &&
+                    typeof product.available !== "boolean") {
+                    errors.push({
+                        field: `products[${index}].available`,
+                        message: "Product available must be a boolean",
+                    });
+                }
+                if (product.images !== undefined) {
+                    if (!Array.isArray(product.images)) {
+                        errors.push({
+                            field: `products[${index}].images`,
+                            message: "Product images must be an array of strings",
+                        });
+                    }
+                    else if (product.images.some((img) => typeof img !== "string")) {
+                        errors.push({
+                            field: `products[${index}].images`,
+                            message: "Product images must be an array of strings",
+                        });
+                    }
+                }
+                if (product.publishedAt !== undefined &&
+                    typeof product.publishedAt !== "string") {
+                    errors.push({
+                        field: `products[${index}].publishedAt`,
+                        message: "Product publishedAt must be a string",
+                    });
+                }
+                if (product.excerpt !== undefined &&
+                    typeof product.excerpt !== "string") {
+                    errors.push({
+                        field: `products[${index}].excerpt`,
+                        message: "Product excerpt must be a string",
+                    });
+                }
+            });
+        }
+    }
     // Intents (optional)
     if (profile.intents !== undefined) {
         if (typeof profile.intents !== "object" || profile.intents === null) {
@@ -563,12 +648,11 @@ function validateProfile(data) {
                                         message: "Suggested amount must be at least $5",
                                     });
                                 }
-                                const validCurrencies = ["USD", "GBP", "EUR"];
                                 if (typeof pricing.currency !== "string" ||
-                                    !validCurrencies.includes(pricing.currency)) {
+                                    !VALID_CURRENCIES.includes(pricing.currency)) {
                                     errors.push({
                                         field: "intents.book.pricing.currency",
-                                        message: `Currency must be one of: ${validCurrencies.join(", ")}`,
+                                        message: `Currency must be one of: ${VALID_CURRENCIES.join(", ")}`,
                                     });
                                 }
                                 if (pricing.minimumAmount !== 5) {
@@ -588,6 +672,59 @@ function validateProfile(data) {
                     }
                 }
             }
+            // Validate shop intent
+            if (intents.shop !== undefined) {
+                if (typeof intents.shop !== "object" || intents.shop === null) {
+                    errors.push({
+                        field: "intents.shop",
+                        message: "Shop intent must be an object",
+                    });
+                }
+                else {
+                    const shop = intents.shop;
+                    if (typeof shop.enabled !== "boolean") {
+                        errors.push({
+                            field: "intents.shop.enabled",
+                            message: "Shop enabled must be a boolean",
+                        });
+                    }
+                    if (shop.title !== undefined) {
+                        if (typeof shop.title !== "string") {
+                            errors.push({
+                                field: "intents.shop.title",
+                                message: "Shop title must be a string",
+                            });
+                        }
+                        else if (shop.title.length > MAX_INTENT_TITLE_LENGTH) {
+                            errors.push({
+                                field: "intents.shop.title",
+                                message: `Shop title must be ${MAX_INTENT_TITLE_LENGTH} characters or less`,
+                            });
+                        }
+                    }
+                    if (shop.description !== undefined) {
+                        if (typeof shop.description !== "string") {
+                            errors.push({
+                                field: "intents.shop.description",
+                                message: "Shop description must be a string",
+                            });
+                        }
+                        else if (shop.description.length > MAX_INTENT_DESCRIPTION_LENGTH) {
+                            errors.push({
+                                field: "intents.shop.description",
+                                message: `Shop description must be ${MAX_INTENT_DESCRIPTION_LENGTH} characters or less`,
+                            });
+                        }
+                    }
+                    if (typeof shop.currency !== "string" ||
+                        !VALID_CURRENCIES.includes(shop.currency)) {
+                        errors.push({
+                            field: "intents.shop.currency",
+                            message: `Shop currency must be one of: ${VALID_CURRENCIES.join(", ")}`,
+                        });
+                    }
+                }
+            }
         }
     }
     if (errors.length > 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "me3-protocol",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/schema.json

@@ -211,6 +211,38 @@
       ],
       "type": "object"
     },
+    "Me3IntentShop": {
+      "additionalProperties": false,
+      "description": "Shop intent. Declares that the person sells products via a simple shop.",
+      "properties": {
+        "currency": {
+          "description": "Shop currency",
+          "enum": [
+            "USD",
+            "GBP",
+            "EUR"
+          ],
+          "type": "string"
+        },
+        "description": {
+          "description": "Shop description",
+          "type": "string"
+        },
+        "enabled": {
+          "description": "Whether shop is enabled",
+          "type": "boolean"
+        },
+        "title": {
+          "description": "Shop title/name",
+          "type": "string"
+        }
+      },
+      "required": [
+        "enabled",
+        "currency"
+      ],
+      "type": "object"
+    },
     "Me3IntentSubscribe": {
       "additionalProperties": false,
       "description": "Newsletter subscription intent. When enabled, the site accepts email subscriptions via POST /api/subscribe",
@@ -251,6 +283,10 @@
           "$ref": "#/definitions/Me3IntentBook",
           "description": "Meeting booking"
         },
+        "shop": {
+          "$ref": "#/definitions/Me3IntentShop",
+          "description": "Shop intent"
+        },
         "subscribe": {
           "$ref": "#/definitions/Me3IntentSubscribe",
           "description": "Newsletter subscription"
@@ -357,6 +393,63 @@
       ],
       "type": "object"
     },
+    "Me3Product": {
+      "additionalProperties": false,
+      "properties": {
+        "available": {
+          "description": "Whether product is available for purchase",
+          "type": "boolean"
+        },
+        "currency": {
+          "description": "Currency code",
+          "enum": [
+            "USD",
+            "GBP",
+            "EUR"
+          ],
+          "type": "string"
+        },
+        "excerpt": {
+          "description": "Short excerpt for listings (optional)",
+          "type": "string"
+        },
+        "file": {
+          "description": "Path to markdown file (relative to me.json)",
+          "type": "string"
+        },
+        "images": {
+          "description": "Product images (URLs)",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "price": {
+          "description": "Product price in cents (e.g., 2999 for $29.99)",
+          "type": "number"
+        },
+        "publishedAt": {
+          "description": "ISO publish date (optional)",
+          "type": "string"
+        },
+        "slug": {
+          "description": "URL-friendly identifier",
+          "type": "string"
+        },
+        "title": {
+          "description": "Product name",
+          "type": "string"
+        }
+      },
+      "required": [
+        "slug",
+        "title",
+        "file",
+        "price",
+        "currency"
+      ],
+      "type": "object"
+    },
     "Me3Profile": {
       "additionalProperties": false,
       "properties": {
@@ -425,6 +518,13 @@
           },
           "type": "array"
         },
+        "products": {
+          "description": "Products (markdown)",
+          "items": {
+            "$ref": "#/definitions/Me3Product"
+          },
+          "type": "array"
+        },
         "verification": {
           "$ref": "#/definitions/Me3Verification",
           "description": "Human verification status (populated from account, not editable per-site)"