@munchi_oy/license-sdk 0.2.1 → 0.4.0

package/README.md

@@ -30,3 +30,5 @@ const snapshot = await license.entitlements(venueId); // full snapshot, null = u
 | `mode: "enforce"` | `can()` returns `false` for features the venue doesn't have, or while it is suspended |
 
 Call `invalidate(venueId)` when you receive a `license.changed` event.
+
+It also exports the shared names: `PRODUCTS` and `PLANS` (catalog codes), `USAGE_METRICS` (what usage can cost money) and `REQUESTABLE_PRODUCTS` (what a store asks Munchi for in the dashboard: `ari`, `business_account`, `capital`).

package/dist/index.cjs

@@ -21,10 +21,44 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  LicenseClient: () => LicenseClient
+  LicenseClient: () => LicenseClient,
+  PLANS: () => PLANS,
+  PRODUCTS: () => PRODUCTS,
+  REQUESTABLE_PRODUCTS: () => REQUESTABLE_PRODUCTS,
+  USAGE_METRICS: () => USAGE_METRICS,
+  USAGE_METRIC_NAMES: () => USAGE_METRIC_NAMES
 });
 module.exports = __toCommonJS(index_exports);
 
+// ../license-core/src/catalog/products.ts
+var PRODUCTS = {
+  start: "MUN-START",
+  one: "MUN-ONE",
+  kiosk: "MUN-ADD-KIOSK",
+  mobileApp: "MUN-ADD-APP",
+  mobileAppSetup: "MUN-SETUP-APP",
+  sms: "MUN-SMS",
+  loyaltyOverage: "MUN-OVR-LOYALTY"
+};
+var PLANS = [
+  PRODUCTS.start,
+  PRODUCTS.one
+];
+
+// ../license-core/src/requestable-products.ts
+var REQUESTABLE_PRODUCTS = [
+  "ari",
+  "business_account",
+  "capital"
+];
+
+// ../license-core/src/usage-metrics.ts
+var USAGE_METRICS = {
+  sms: "sum",
+  loyaltyMembers: "peak"
+};
+var USAGE_METRIC_NAMES = Object.keys(USAGE_METRICS);
+
 // src/license-client.ts
 var UNREACHABLE = /* @__PURE__ */ Symbol("unreachable");
 var LicenseClient = class {
@@ -165,5 +199,10 @@ var LicenseClient = class {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  LicenseClient
+  LicenseClient,
+  PLANS,
+  PRODUCTS,
+  REQUESTABLE_PRODUCTS,
+  USAGE_METRICS,
+  USAGE_METRIC_NAMES
 });

package/dist/index.d.cts

@@ -1,3 +1,41 @@
+/**
+ * Munchi's product codes, for code that names one (apps, the dashboard). Codes are immutable and
+ * never reused; a catalog may still carry products added later, so this is not the full list.
+ */
+declare const PRODUCTS: {
+    readonly start: "MUN-START";
+    readonly one: "MUN-ONE";
+    readonly kiosk: "MUN-ADD-KIOSK";
+    readonly mobileApp: "MUN-ADD-APP";
+    readonly mobileAppSetup: "MUN-SETUP-APP";
+    readonly sms: "MUN-SMS";
+    readonly loyaltyOverage: "MUN-OVR-LOYALTY";
+};
+type KnownProductCode = (typeof PRODUCTS)[keyof typeof PRODUCTS];
+/** The plans, cheapest first. */
+declare const PLANS: readonly ["MUN-START", "MUN-ONE"];
+type PlanCode = (typeof PLANS)[number];
+
+/**
+ * Products a store asks Munchi for in the dashboard because they can't be bought online
+ * (ADR 0022). These are the dashboard's product ids, not catalog codes (`MUN-*`); the mobile app
+ * has its own request flow (ADR 0021). A new one is added here first.
+ */
+declare const REQUESTABLE_PRODUCTS: readonly ["ari", "business_account", "capital"];
+type RequestableProduct = (typeof REQUESTABLE_PRODUCTS)[number];
+
+/**
+ * What the apps report and the monthly bill can charge for: reminder SMS segments sent (added
+ * up), and loyalty members (the month's highest count, since Start includes 150 and each one
+ * above is charged once a month). A new billable usage is added here first.
+ */
+declare const USAGE_METRICS: {
+    readonly sms: "sum";
+    readonly loyaltyMembers: "peak";
+};
+type UsageMetric = keyof typeof USAGE_METRICS;
+declare const USAGE_METRIC_NAMES: [UsageMetric, ...UsageMetric[]];
+
 type ProductCode = string;
 type FeatureCode = string;
 
@@ -5,7 +43,8 @@ type LicenseState = "trial" | "active" | "grace" | "start" | "suspended" | "term
 type PaymentMethodStatus = "ok" | "missing" | "failing";
 type PaymentsMode = "munchi" | "external";
 type PaymentsStatus = "not_started" | "submitted" | "pre_check" | "in_review" | "action_required" | "approved" | "live" | "rejected" | "restricted";
-type SuspensionReason = "misconduct" | "fraud_suspected" | "chargebacks" | "legal_request" | "terms_breach" | "customer_request" | "other";
+declare const SUSPENSION_REASONS: readonly ["misconduct", "fraud_suspected", "chargebacks", "legal_request", "terms_breach", "customer_request", "trial_ended", "payment_overdue", "other"];
+type SuspensionReason = (typeof SUSPENSION_REASONS)[number];
 interface Suspension {
     reason: SuspensionReason;
     mode: "read_only" | "off";
@@ -135,4 +174,4 @@ declare class LicenseClient {
     private report;
 }
 
-export { type DeniedEvent, LicenseClient, type LicenseClientOptions, type Snapshot };
+export { type DeniedEvent, type KnownProductCode, LicenseClient, type LicenseClientOptions, PLANS, PRODUCTS, type PlanCode, REQUESTABLE_PRODUCTS, type RequestableProduct, type Snapshot, USAGE_METRICS, USAGE_METRIC_NAMES, type UsageMetric };

package/dist/index.d.ts

@@ -1,3 +1,41 @@
+/**
+ * Munchi's product codes, for code that names one (apps, the dashboard). Codes are immutable and
+ * never reused; a catalog may still carry products added later, so this is not the full list.
+ */
+declare const PRODUCTS: {
+    readonly start: "MUN-START";
+    readonly one: "MUN-ONE";
+    readonly kiosk: "MUN-ADD-KIOSK";
+    readonly mobileApp: "MUN-ADD-APP";
+    readonly mobileAppSetup: "MUN-SETUP-APP";
+    readonly sms: "MUN-SMS";
+    readonly loyaltyOverage: "MUN-OVR-LOYALTY";
+};
+type KnownProductCode = (typeof PRODUCTS)[keyof typeof PRODUCTS];
+/** The plans, cheapest first. */
+declare const PLANS: readonly ["MUN-START", "MUN-ONE"];
+type PlanCode = (typeof PLANS)[number];
+
+/**
+ * Products a store asks Munchi for in the dashboard because they can't be bought online
+ * (ADR 0022). These are the dashboard's product ids, not catalog codes (`MUN-*`); the mobile app
+ * has its own request flow (ADR 0021). A new one is added here first.
+ */
+declare const REQUESTABLE_PRODUCTS: readonly ["ari", "business_account", "capital"];
+type RequestableProduct = (typeof REQUESTABLE_PRODUCTS)[number];
+
+/**
+ * What the apps report and the monthly bill can charge for: reminder SMS segments sent (added
+ * up), and loyalty members (the month's highest count, since Start includes 150 and each one
+ * above is charged once a month). A new billable usage is added here first.
+ */
+declare const USAGE_METRICS: {
+    readonly sms: "sum";
+    readonly loyaltyMembers: "peak";
+};
+type UsageMetric = keyof typeof USAGE_METRICS;
+declare const USAGE_METRIC_NAMES: [UsageMetric, ...UsageMetric[]];
+
 type ProductCode = string;
 type FeatureCode = string;
 
@@ -5,7 +43,8 @@ type LicenseState = "trial" | "active" | "grace" | "start" | "suspended" | "term
 type PaymentMethodStatus = "ok" | "missing" | "failing";
 type PaymentsMode = "munchi" | "external";
 type PaymentsStatus = "not_started" | "submitted" | "pre_check" | "in_review" | "action_required" | "approved" | "live" | "rejected" | "restricted";
-type SuspensionReason = "misconduct" | "fraud_suspected" | "chargebacks" | "legal_request" | "terms_breach" | "customer_request" | "other";
+declare const SUSPENSION_REASONS: readonly ["misconduct", "fraud_suspected", "chargebacks", "legal_request", "terms_breach", "customer_request", "trial_ended", "payment_overdue", "other"];
+type SuspensionReason = (typeof SUSPENSION_REASONS)[number];
 interface Suspension {
     reason: SuspensionReason;
     mode: "read_only" | "off";
@@ -135,4 +174,4 @@ declare class LicenseClient {
     private report;
 }
 
-export { type DeniedEvent, LicenseClient, type LicenseClientOptions, type Snapshot };
+export { type DeniedEvent, type KnownProductCode, LicenseClient, type LicenseClientOptions, PLANS, PRODUCTS, type PlanCode, REQUESTABLE_PRODUCTS, type RequestableProduct, type Snapshot, USAGE_METRICS, USAGE_METRIC_NAMES, type UsageMetric };

package/dist/index.js

@@ -1,6 +1,35 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
+// ../license-core/src/catalog/products.ts
+var PRODUCTS = {
+  start: "MUN-START",
+  one: "MUN-ONE",
+  kiosk: "MUN-ADD-KIOSK",
+  mobileApp: "MUN-ADD-APP",
+  mobileAppSetup: "MUN-SETUP-APP",
+  sms: "MUN-SMS",
+  loyaltyOverage: "MUN-OVR-LOYALTY"
+};
+var PLANS = [
+  PRODUCTS.start,
+  PRODUCTS.one
+];
+
+// ../license-core/src/requestable-products.ts
+var REQUESTABLE_PRODUCTS = [
+  "ari",
+  "business_account",
+  "capital"
+];
+
+// ../license-core/src/usage-metrics.ts
+var USAGE_METRICS = {
+  sms: "sum",
+  loyaltyMembers: "peak"
+};
+var USAGE_METRIC_NAMES = Object.keys(USAGE_METRICS);
+
 // src/license-client.ts
 var UNREACHABLE = /* @__PURE__ */ Symbol("unreachable");
 var LicenseClient = class {
@@ -140,5 +169,10 @@ var LicenseClient = class {
   }
 };
 export {
-  LicenseClient
+  LicenseClient,
+  PLANS,
+  PRODUCTS,
+  REQUESTABLE_PRODUCTS,
+  USAGE_METRICS,
+  USAGE_METRIC_NAMES
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@munchi_oy/license-sdk",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "Client for the Munchi license service: cached entitlements and feature checks per venue",
   "type": "module",
   "main": "./dist/index.cjs",