@xapps-platform/xapp-manifest 0.2.0 → 0.2.2

package/dist/index.js

@@ -8086,6 +8086,168 @@ var xappManifestJsonSchema = {
         proxy_policy: { type: "object" }
       }
     },
+    monetization: {
+      type: "object",
+      additionalProperties: false,
+      properties: {
+        products: {
+          type: "array",
+          maxItems: 200,
+          items: {
+            type: "object",
+            required: ["slug", "product_family"],
+            additionalProperties: false,
+            properties: {
+              slug: { type: "string", minLength: 1, maxLength: 100 },
+              title: localizedTextSchema(200),
+              description: localizedTextSchema(2e3),
+              product_family: { type: "string", minLength: 1, maxLength: 100 },
+              status: { type: "string", enum: ["draft", "active", "archived"] },
+              metadata: { type: "object" }
+            }
+          }
+        },
+        offerings: {
+          type: "array",
+          maxItems: 200,
+          items: {
+            type: "object",
+            required: ["slug"],
+            additionalProperties: false,
+            properties: {
+              slug: { type: "string", minLength: 1, maxLength: 100 },
+              title: localizedTextSchema(200),
+              description: localizedTextSchema(2e3),
+              placement: { type: "string", minLength: 1, maxLength: 100 },
+              status: { type: "string", enum: ["draft", "active", "archived"] },
+              targeting_rules: { type: "object" },
+              metadata: { type: "object" }
+            }
+          }
+        },
+        packages: {
+          type: "array",
+          maxItems: 500,
+          items: {
+            type: "object",
+            required: ["slug", "product_ref", "offering_ref"],
+            additionalProperties: false,
+            properties: {
+              slug: { type: "string", minLength: 1, maxLength: 100 },
+              product_ref: { type: "string", minLength: 1, maxLength: 100 },
+              offering_ref: { type: "string", minLength: 1, maxLength: 100 },
+              package_kind: {
+                type: "string",
+                enum: ["standard", "one_time_unlock", "credit_pack", "subscription"]
+              },
+              display_order: { type: "integer", minimum: 0, maximum: 1e6 },
+              status: { type: "string", enum: ["draft", "active", "archived"] },
+              metadata: { type: "object" }
+            }
+          }
+        },
+        prices: {
+          type: "array",
+          maxItems: 1e3,
+          items: {
+            type: "object",
+            required: ["slug", "package_ref", "currency", "amount"],
+            additionalProperties: false,
+            properties: {
+              slug: { type: "string", minLength: 1, maxLength: 100 },
+              package_ref: { type: "string", minLength: 1, maxLength: 100 },
+              currency: { type: "string", minLength: 1, maxLength: 16 },
+              amount: { type: "number", minimum: 0 },
+              billing_period: { type: "string", enum: ["day", "week", "month", "year"] },
+              billing_period_count: { type: "integer", minimum: 1, maximum: 1e6 },
+              trial_policy: { type: "object" },
+              intro_policy: { type: "object" },
+              country_rules: { type: "object" },
+              status: { type: "string", enum: ["draft", "active", "archived"] },
+              metadata: { type: "object" }
+            }
+          }
+        },
+        paywalls: {
+          type: "array",
+          maxItems: 200,
+          items: {
+            type: "object",
+            required: ["slug", "offering_refs"],
+            additionalProperties: false,
+            properties: {
+              slug: { type: "string", minLength: 1, maxLength: 100 },
+              title: localizedTextSchema(200),
+              description: localizedTextSchema(2e3),
+              placement: { type: "string", minLength: 1, maxLength: 100 },
+              offering_refs: {
+                type: "array",
+                minItems: 1,
+                maxItems: 50,
+                items: { type: "string", minLength: 1, maxLength: 100 }
+              },
+              package_refs: {
+                type: "array",
+                minItems: 1,
+                maxItems: 200,
+                items: { type: "string", minLength: 1, maxLength: 100 }
+              },
+              default_package_ref: { type: "string", minLength: 1, maxLength: 100 },
+              status: { type: "string", enum: ["draft", "active", "archived"] },
+              targeting_rules: { type: "object" },
+              metadata: { type: "object" }
+            }
+          }
+        },
+        usage_policies: {
+          type: "array",
+          maxItems: 200,
+          items: {
+            type: "object",
+            required: ["tool_name", "credit_cost"],
+            additionalProperties: false,
+            properties: {
+              tool_name: { type: "string", minLength: 1, maxLength: 100 },
+              unit: { type: "string", minLength: 1, maxLength: 100 },
+              credit_cost: { type: "number", minimum: 0 },
+              status: { type: "string", enum: ["draft", "active", "archived"] },
+              metadata: { type: "object" }
+            }
+          }
+        },
+        hooks: {
+          type: "object",
+          additionalProperties: false,
+          properties: {
+            after_payment_completed: {
+              type: "object",
+              additionalProperties: true,
+              properties: {
+                enabled: { type: "boolean" },
+                guard_slug: { type: "string", minLength: 1, maxLength: 200 },
+                guardSlug: { type: "string", minLength: 1, maxLength: 200 },
+                invoice_ref: { type: "string", minLength: 1, maxLength: 200 },
+                invoiceRef: { type: "string", minLength: 1, maxLength: 200 },
+                by_payment_guard_ref: {
+                  type: "object",
+                  additionalProperties: {
+                    type: "object",
+                    additionalProperties: true
+                  }
+                },
+                byPaymentGuardRef: {
+                  type: "object",
+                  additionalProperties: {
+                    type: "object",
+                    additionalProperties: true
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     payment_guard_definitions: {
       type: "array",
       maxItems: 50,
@@ -8317,6 +8479,23 @@ var validate = ajv.compile(xappManifestJsonSchema);
 function isRecord(value) {
   return Boolean(value) && typeof value === "object" && !Array.isArray(value);
 }
+function readMonetizationEntries(value) {
+  return Array.isArray(value) ? value : [];
+}
+function requireUniqueSlug(entries, label) {
+  const slugs = /* @__PURE__ */ new Set();
+  for (const entry of entries) {
+    const slug = String(entry?.slug ?? "").trim();
+    if (!slug) {
+      throw Object.assign(new Error(`${label} entries require non-empty slug`), { status: 400 });
+    }
+    if (slugs.has(slug)) {
+      throw Object.assign(new Error(`Duplicate ${label} slug: ${slug}`), { status: 400 });
+    }
+    slugs.add(slug);
+  }
+  return slugs;
+}
 function isTemplatedUrl(value) {
   return /^__[A-Z0-9_]+__(?:[/?#].*)?$/.test(String(value || "").trim());
 }
@@ -8733,6 +8912,13 @@ function parseXappManifest(input, options) {
     });
   }
   const manifest = input;
+  const monetization = isRecord(manifest.monetization) ? manifest.monetization : null;
+  const monetizationProducts = readMonetizationEntries(monetization?.products);
+  const monetizationOfferings = readMonetizationEntries(monetization?.offerings);
+  const monetizationPackages = readMonetizationEntries(monetization?.packages);
+  const monetizationPrices = readMonetizationEntries(monetization?.prices);
+  const monetizationPaywalls = readMonetizationEntries(monetization?.paywalls);
+  const monetizationUsagePolicies = Array.isArray(monetization?.usage_policies) ? monetization.usage_policies : [];
   const paymentDefinitions = Array.isArray(manifest.payment_guard_definitions) ? manifest.payment_guard_definitions : [];
   const subjectProfileDefinitions = Array.isArray(manifest.subject_profile_guard_definitions) ? manifest.subject_profile_guard_definitions : [];
   const notificationDefinitions = Array.isArray(manifest.notification_definitions) ? manifest.notification_definitions : [];
@@ -8745,6 +8931,14 @@ function parseXappManifest(input, options) {
   const notificationTemplateNames = /* @__PURE__ */ new Set();
   const invoiceDefinitionNames = /* @__PURE__ */ new Set();
   const invoiceTemplateNames = /* @__PURE__ */ new Set();
+  const monetizationProductSlugs = requireUniqueSlug(monetizationProducts, "monetization.products");
+  const monetizationOfferingSlugs = requireUniqueSlug(
+    monetizationOfferings,
+    "monetization.offerings"
+  );
+  const monetizationPackageSlugs = requireUniqueSlug(monetizationPackages, "monetization.packages");
+  requireUniqueSlug(monetizationPrices, "monetization.prices");
+  requireUniqueSlug(monetizationPaywalls, "monetization.paywalls");
   for (const list of [
     [paymentDefinitions, paymentDefinitionNames, "payment_guard_definitions"],
     [subjectProfileDefinitions, subjectProfileDefinitionNames, "subject_profile_guard_definitions"],
@@ -8789,6 +8983,30 @@ function parseXappManifest(input, options) {
   const knownToolNames = new Set(
     (manifest.tools ?? []).map((tool) => String(tool.tool_name || "").trim())
   );
+  const monetizationUsagePolicyTools = /* @__PURE__ */ new Set();
+  for (const usagePolicy of monetizationUsagePolicies) {
+    const toolName = String(usagePolicy?.tool_name ?? "").trim();
+    const creditCost = Number(usagePolicy?.credit_cost);
+    if (!knownToolNames.has(toolName)) {
+      throw Object.assign(
+        new Error(`monetization.usage_policies entry references unknown tool_name: ${toolName}`),
+        { status: 400 }
+      );
+    }
+    if (!Number.isFinite(creditCost)) {
+      throw Object.assign(
+        new Error(`monetization.usage_policies entry requires numeric credit_cost: ${toolName}`),
+        { status: 400 }
+      );
+    }
+    if (monetizationUsagePolicyTools.has(toolName)) {
+      throw Object.assign(
+        new Error(`monetization.usage_policies has duplicate tool_name: ${toolName}`),
+        { status: 400 }
+      );
+    }
+    monetizationUsagePolicyTools.add(toolName);
+  }
   const referencedPaymentDefinitionNames = /* @__PURE__ */ new Set();
   const referencedSubjectProfileDefinitionNames = /* @__PURE__ */ new Set();
   const notificationDefinitionRegistry = buildNotificationDefinitionRegistry(
@@ -8839,6 +9057,133 @@ function parseXappManifest(input, options) {
     validateWidgetPublisherRuntimeMode(widget);
     validateWidgetPublisherBootstrapTransport(widget);
   }
+  for (const monetizationPackage of monetizationPackages) {
+    const productRef = String(monetizationPackage.product_ref ?? "").trim();
+    if (!monetizationProductSlugs.has(productRef)) {
+      throw Object.assign(
+        new Error(
+          `monetization.packages entry ${String(monetizationPackage.slug ?? "unknown")} references unknown product_ref: ${productRef}`
+        ),
+        { status: 400 }
+      );
+    }
+    const offeringRef = String(monetizationPackage.offering_ref ?? "").trim();
+    if (!monetizationOfferingSlugs.has(offeringRef)) {
+      throw Object.assign(
+        new Error(
+          `monetization.packages entry ${String(monetizationPackage.slug ?? "unknown")} references unknown offering_ref: ${offeringRef}`
+        ),
+        { status: 400 }
+      );
+    }
+  }
+  for (const monetizationPrice of monetizationPrices) {
+    const packageRef = String(monetizationPrice.package_ref ?? "").trim();
+    if (!monetizationPackageSlugs.has(packageRef)) {
+      throw Object.assign(
+        new Error(
+          `monetization.prices entry ${String(monetizationPrice.slug ?? "unknown")} references unknown package_ref: ${packageRef}`
+        ),
+        { status: 400 }
+      );
+    }
+  }
+  const packageOfferingBySlug = /* @__PURE__ */ new Map();
+  for (const monetizationPackage of monetizationPackages) {
+    const packageSlug = String(monetizationPackage.slug ?? "").trim();
+    const offeringRef = String(monetizationPackage.offering_ref ?? "").trim();
+    if (packageSlug && offeringRef) {
+      packageOfferingBySlug.set(packageSlug, offeringRef);
+    }
+  }
+  for (const monetizationPaywall of monetizationPaywalls) {
+    const paywallSlug = String(monetizationPaywall.slug ?? "unknown").trim() || "unknown";
+    const offeringRefs = Array.isArray(monetizationPaywall.offering_refs) ? monetizationPaywall.offering_refs.map((value) => String(value ?? "").trim()).filter(Boolean) : [];
+    if (!offeringRefs.length) {
+      throw Object.assign(
+        new Error(`monetization.paywalls entry ${paywallSlug} requires at least one offering_ref`),
+        { status: 400 }
+      );
+    }
+    const offeringRefSet = /* @__PURE__ */ new Set();
+    for (const offeringRef of offeringRefs) {
+      if (!monetizationOfferingSlugs.has(offeringRef)) {
+        throw Object.assign(
+          new Error(
+            `monetization.paywalls entry ${paywallSlug} references unknown offering_ref: ${offeringRef}`
+          ),
+          { status: 400 }
+        );
+      }
+      if (offeringRefSet.has(offeringRef)) {
+        throw Object.assign(
+          new Error(
+            `monetization.paywalls entry ${paywallSlug} has duplicate offering_ref: ${offeringRef}`
+          ),
+          { status: 400 }
+        );
+      }
+      offeringRefSet.add(offeringRef);
+    }
+    const packageRefs = Array.isArray(monetizationPaywall.package_refs) ? monetizationPaywall.package_refs.map((value) => String(value ?? "").trim()).filter(Boolean) : [];
+    const packageRefSet = /* @__PURE__ */ new Set();
+    for (const packageRef of packageRefs) {
+      if (!monetizationPackageSlugs.has(packageRef)) {
+        throw Object.assign(
+          new Error(
+            `monetization.paywalls entry ${paywallSlug} references unknown package_ref: ${packageRef}`
+          ),
+          { status: 400 }
+        );
+      }
+      if (packageRefSet.has(packageRef)) {
+        throw Object.assign(
+          new Error(
+            `monetization.paywalls entry ${paywallSlug} has duplicate package_ref: ${packageRef}`
+          ),
+          { status: 400 }
+        );
+      }
+      packageRefSet.add(packageRef);
+      const packageOfferingRef = String(packageOfferingBySlug.get(packageRef) ?? "").trim();
+      if (packageOfferingRef && !offeringRefSet.has(packageOfferingRef)) {
+        throw Object.assign(
+          new Error(
+            `monetization.paywalls entry ${paywallSlug} package_ref ${packageRef} is not inside paywall offering_refs`
+          ),
+          { status: 400 }
+        );
+      }
+    }
+    const defaultPackageRef = String(monetizationPaywall.default_package_ref ?? "").trim();
+    if (defaultPackageRef) {
+      if (!monetizationPackageSlugs.has(defaultPackageRef)) {
+        throw Object.assign(
+          new Error(
+            `monetization.paywalls entry ${paywallSlug} references unknown default_package_ref: ${defaultPackageRef}`
+          ),
+          { status: 400 }
+        );
+      }
+      if (packageRefSet.size > 0 && !packageRefSet.has(defaultPackageRef)) {
+        throw Object.assign(
+          new Error(
+            `monetization.paywalls entry ${paywallSlug} default_package_ref must also exist in package_refs when package_refs are declared`
+          ),
+          { status: 400 }
+        );
+      }
+      const defaultOfferingRef = String(packageOfferingBySlug.get(defaultPackageRef) ?? "").trim();
+      if (defaultOfferingRef && !offeringRefSet.has(defaultOfferingRef)) {
+        throw Object.assign(
+          new Error(
+            `monetization.paywalls entry ${paywallSlug} default_package_ref ${defaultPackageRef} is not inside paywall offering_refs`
+          ),
+          { status: 400 }
+        );
+      }
+    }
+  }
   for (const tool of manifest.tools ?? []) {
     validateAdapterShape(tool);
     const policy = tool.dispatch_policy;