@thezelijah/majik-subscription 1.0.0 → 1.0.2

package/dist/enums.d.ts

@@ -1,32 +1,38 @@
-export declare enum SubscriptionStatus {
-    ACTIVE = "Active",
-    INACTIVE = "Inactive",
-    SUSPENDED = "Suspended",
-    CANCELLED = "Cancelled"
-}
-export declare enum SubscriptionType {
-    RECURRING = "Recurring",
-    ONE_TIME = "One-Time",
-    TRIAL = "Trial"
-}
-export declare enum SubscriptionVisibility {
-    PUBLIC = "Public",
-    PRIVATE = "Private"
-}
-export declare enum BillingCycle {
-    DAILY = "Daily",
-    WEEKLY = "Weekly",
-    MONTHLY = "Monthly",
-    QUARTERLY = "Quarterly",
-    YEARLY = "Yearly"
-}
-export declare enum RateUnit {
-    PER_SUBSCRIBER = "Per Subscriber",
-    PER_ACCOUNT = "Per Account",
-    PER_USER = "Per User",
-    PER_MONTH = "Per Month"
-}
-export declare enum CapacityPeriodResizeMode {
-    DEFAULT = "default",// trim or pad, keep per-month units
-    DISTRIBUTE = "distribute"
-}
+export declare const SubscriptionStatus: {
+    readonly ACTIVE: "Active";
+    readonly INACTIVE: "Inactive";
+    readonly SUSPENDED: "Suspended";
+    readonly CANCELLED: "Cancelled";
+};
+export type SubscriptionStatus = (typeof SubscriptionStatus)[keyof typeof SubscriptionStatus];
+export declare const SubscriptionType: {
+    readonly RECURRING: "Recurring";
+    readonly ONE_TIME: "One-Time";
+    readonly TRIAL: "Trial";
+};
+export type SubscriptionType = (typeof SubscriptionType)[keyof typeof SubscriptionType];
+export declare const SubscriptionVisibility: {
+    readonly PUBLIC: "Public";
+    readonly PRIVATE: "Private";
+};
+export type SubscriptionVisibility = (typeof SubscriptionVisibility)[keyof typeof SubscriptionVisibility];
+export declare const BillingCycle: {
+    readonly DAILY: "Daily";
+    readonly WEEKLY: "Weekly";
+    readonly MONTHLY: "Monthly";
+    readonly QUARTERLY: "Quarterly";
+    readonly YEARLY: "Yearly";
+};
+export type BillingCycle = (typeof BillingCycle)[keyof typeof BillingCycle];
+export declare const RateUnit: {
+    readonly PER_SUBSCRIBER: "Per Subscriber";
+    readonly PER_ACCOUNT: "Per Account";
+    readonly PER_USER: "Per User";
+    readonly PER_MONTH: "Per Month";
+};
+export type RateUnit = (typeof RateUnit)[keyof typeof RateUnit];
+export declare const CapacityPeriodResizeMode: {
+    readonly DEFAULT: "default";
+    readonly DISTRIBUTE: "distribute";
+};
+export type CapacityPeriodResizeMode = (typeof CapacityPeriodResizeMode)[keyof typeof CapacityPeriodResizeMode];

package/dist/enums.js

@@ -1,41 +1,32 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CapacityPeriodResizeMode = exports.RateUnit = exports.BillingCycle = exports.SubscriptionVisibility = exports.SubscriptionType = exports.SubscriptionStatus = void 0;
-var SubscriptionStatus;
-(function (SubscriptionStatus) {
-    SubscriptionStatus["ACTIVE"] = "Active";
-    SubscriptionStatus["INACTIVE"] = "Inactive";
-    SubscriptionStatus["SUSPENDED"] = "Suspended";
-    SubscriptionStatus["CANCELLED"] = "Cancelled";
-})(SubscriptionStatus || (exports.SubscriptionStatus = SubscriptionStatus = {}));
-var SubscriptionType;
-(function (SubscriptionType) {
-    SubscriptionType["RECURRING"] = "Recurring";
-    SubscriptionType["ONE_TIME"] = "One-Time";
-    SubscriptionType["TRIAL"] = "Trial";
-})(SubscriptionType || (exports.SubscriptionType = SubscriptionType = {}));
-var SubscriptionVisibility;
-(function (SubscriptionVisibility) {
-    SubscriptionVisibility["PUBLIC"] = "Public";
-    SubscriptionVisibility["PRIVATE"] = "Private";
-})(SubscriptionVisibility || (exports.SubscriptionVisibility = SubscriptionVisibility = {}));
-var BillingCycle;
-(function (BillingCycle) {
-    BillingCycle["DAILY"] = "Daily";
-    BillingCycle["WEEKLY"] = "Weekly";
-    BillingCycle["MONTHLY"] = "Monthly";
-    BillingCycle["QUARTERLY"] = "Quarterly";
-    BillingCycle["YEARLY"] = "Yearly";
-})(BillingCycle || (exports.BillingCycle = BillingCycle = {}));
-var RateUnit;
-(function (RateUnit) {
-    RateUnit["PER_SUBSCRIBER"] = "Per Subscriber";
-    RateUnit["PER_ACCOUNT"] = "Per Account";
-    RateUnit["PER_USER"] = "Per User";
-    RateUnit["PER_MONTH"] = "Per Month";
-})(RateUnit || (exports.RateUnit = RateUnit = {}));
-var CapacityPeriodResizeMode;
-(function (CapacityPeriodResizeMode) {
-    CapacityPeriodResizeMode["DEFAULT"] = "default";
-    CapacityPeriodResizeMode["DISTRIBUTE"] = "distribute";
-})(CapacityPeriodResizeMode || (exports.CapacityPeriodResizeMode = CapacityPeriodResizeMode = {}));
+export const SubscriptionStatus = {
+    ACTIVE: "Active",
+    INACTIVE: "Inactive",
+    SUSPENDED: "Suspended",
+    CANCELLED: "Cancelled",
+};
+export const SubscriptionType = {
+    RECURRING: "Recurring",
+    ONE_TIME: "One-Time",
+    TRIAL: "Trial",
+};
+export const SubscriptionVisibility = {
+    PUBLIC: "Public",
+    PRIVATE: "Private",
+};
+export const BillingCycle = {
+    DAILY: "Daily",
+    WEEKLY: "Weekly",
+    MONTHLY: "Monthly",
+    QUARTERLY: "Quarterly",
+    YEARLY: "Yearly",
+};
+export const RateUnit = {
+    PER_SUBSCRIBER: "Per Subscriber",
+    PER_ACCOUNT: "Per Account",
+    PER_USER: "Per User",
+    PER_MONTH: "Per Month",
+};
+export const CapacityPeriodResizeMode = {
+    DEFAULT: "default",
+    DISTRIBUTE: "distribute",
+};

package/dist/index.js

@@ -1,20 +1,4 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./majik-subscription"), exports);
-__exportStar(require("./utils"), exports);
-__exportStar(require("./enums"), exports);
-__exportStar(require("./types"), exports);
+export * from "./majik-subscription";
+export * from "./utils";
+export * from "./enums";
+export * from "./types";

package/dist/majik-subscription.d.ts

@@ -1,6 +1,6 @@
 import { MajikMoney } from "@thezelijah/majik-money";
-import { COSItem, ISODateString, MonthlyCapacity, ObjectType, StartDateInput, SubscriptionID, SubscriptionMetadata, SubscriptionRate, SubscriptionSettings, YYYYMM } from "./types";
-import { CapacityPeriodResizeMode, RateUnit, SubscriptionStatus, SubscriptionType } from "./enums";
+import { COSItem, ISODateString, MajikSubscriptionJSON, MonthlyCapacity, ObjectType, StartDateInput, SubscriptionID, SubscriptionMetadata, SubscriptionRate, SubscriptionSettings, YYYYMM } from "./types";
+import { BillingCycle, CapacityPeriodResizeMode, RateUnit, SubscriptionStatus, SubscriptionType } from "./enums";
 /**
  * Represents a subscription in the Majik system.
  * Handles metadata, capacity, COS, and finance calculations (revenue, COS, profit, margins) for recurring subscriptions.
@@ -70,6 +70,12 @@ export declare class MajikSubscription {
      * @throws Will throw an error if amount is non-positive.
      */
     setRateAmount(amount: number): this;
+    /**
+     * Updates the billing cycle.
+     * @param {BillingCycle} cycle - New billing cycle (e.g., monthly, quarterly). use Enum `BillingCycle`.
+     * @returns {MajikSubscription} - Returns self for chaining.
+     */
+    setBillingCycle(cycle: BillingCycle): this;
     /**
      * Updates the subscription category.
      * @param {string} category - New category name.
@@ -337,6 +343,7 @@ export declare class MajikSubscription {
      * @returns {readonly COSItem[]} - Array of COS items.
      */
     get cos(): readonly COSItem[];
+    get costBreakdown(): readonly COSItem[];
     /**
      * Returns COS for a specific month.
      * @param {YYYYMM} month - Month in YYYY-MM format.
@@ -403,16 +410,16 @@ export declare class MajikSubscription {
     finalize(): object;
     /**
      * Converts the subscription instance to a plain JSON object.
-     * @returns {object} - Plain object representation.
+     * @returns {MajikSubscriptionJSON} - Plain object representation.
      */
-    toJSON(): object;
+    toJSON(): MajikSubscriptionJSON;
     /**
      * Parses a plain object or JSON string into a MajikSubscription instance.
-     * @param {string | object} json - JSON string or object.
+     * @param {string | MajikSubscriptionJSON} json - JSON string or object.
      * @returns {MajikSubscription} - Parsed subscription instance.
      * @throws {Error} - Throws if required properties are missing.
      */
-    static parseFromJSON(json: string | object): MajikSubscription;
+    static parseFromJSON(json: string | MajikSubscriptionJSON): MajikSubscription;
     /**
      * Updates the last_update timestamp to current time.
      * Should be called whenever a property is modified.
@@ -427,5 +434,5 @@ export declare class MajikSubscription {
      */
     private assertCurrency;
 }
-export declare function isMajikSubscriptionClass(item: MajikSubscription): boolean;
-export declare function isMajikSubscriptionJSON(item: MajikSubscription): boolean;
+export declare function isMajikSubscriptionClass(item: MajikSubscription | MajikSubscriptionJSON): boolean;
+export declare function isMajikSubscriptionJSON(item: MajikSubscription | MajikSubscriptionJSON): boolean;

package/dist/majik-subscription.js

@@ -1,16 +1,25 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MajikSubscription = void 0;
-exports.isMajikSubscriptionClass = isMajikSubscriptionClass;
-exports.isMajikSubscriptionJSON = isMajikSubscriptionJSON;
-const majik_money_1 = require("@thezelijah/majik-money");
-const utils_1 = require("./utils");
-const enums_1 = require("./enums");
+import { deserializeMoney, MajikMoney, serializeMoney, } from "@thezelijah/majik-money";
+import { autogenerateID, createEmptySubscriptionFinance, monthsInPeriod, generateSlug, isValidYYYYMM, normalizeStartDate, offsetMonthsToYYYYMM, dateToYYYYMM, } from "./utils";
+import { CapacityPeriodResizeMode, SubscriptionStatus, SubscriptionType, SubscriptionVisibility, } from "./enums";
 /**
  * Represents a subscription in the Majik system.
  * Handles metadata, capacity, COS, and finance calculations (revenue, COS, profit, margins) for recurring subscriptions.
  */
-class MajikSubscription {
+export class MajikSubscription {
+    __type = "MajikSubscription";
+    __object = "class";
+    id;
+    slug;
+    name;
+    category;
+    rate;
+    status;
+    type;
+    timestamp;
+    last_update;
+    metadata;
+    settings;
+    financeDirty = true;
     /**
      * Creates a new `MajikSubscription` instance.
      * @param {SubscriptionID | undefined} id - Optional subscription ID. Auto-generated if undefined.
@@ -22,16 +31,13 @@ class MajikSubscription {
      * @param {ISODateString} [last_update=new Date().toISOString()] - Optional last update timestamp.
      */
     constructor(id, slug, name, metadata, settings, timestamp = new Date().toISOString(), last_update = new Date().toISOString()) {
-        this.__type = "MajikSubscription";
-        this.__object = "class";
-        this.financeDirty = true;
-        this.id = id || (0, utils_1.autogenerateID)("mjksub");
-        this.slug = slug || (0, utils_1.generateSlug)(name);
+        this.id = id || autogenerateID("mjksub");
+        this.slug = slug || generateSlug(name);
         this.name = name;
         this.metadata = metadata;
         this.settings = settings ?? {
-            status: enums_1.SubscriptionStatus.ACTIVE,
-            visibility: enums_1.SubscriptionVisibility.PRIVATE,
+            status: SubscriptionStatus.ACTIVE,
+            visibility: SubscriptionVisibility.PRIVATE,
             system: { isRestricted: false },
         };
         this.type = this.metadata.type;
@@ -52,14 +58,14 @@ class MajikSubscription {
      */
     DEFAULT_ZERO(currencyCode) {
         const code = currencyCode || this.rate?.amount?.currency?.code || "PHP";
-        return majik_money_1.MajikMoney.fromMinor(0, code);
+        return MajikMoney.fromMinor(0, code);
     }
     /**
      * Initializes and creates a new `MajikSubscription` with default and null values.
      * @param type - The type of service to initialize. Defaults to `TIME_BASED`. Use Enum `ServiceType`.
      * @returns A new `MajikSubscription` instance.
      */
-    static initialize(name, type = enums_1.SubscriptionType.RECURRING, rate, category = "Other", descriptionText, skuID) {
+    static initialize(name, type = SubscriptionType.RECURRING, rate, category = "Other", descriptionText, skuID) {
         if (!name || typeof name !== "string" || name.trim() === "") {
             throw new Error("Name must be a valid non-empty string.");
         }
@@ -76,11 +82,11 @@ class MajikSubscription {
             rate: rate,
             sku: skuID || undefined,
             cos: [],
-            finance: (0, utils_1.createEmptySubscriptionFinance)(rate.amount.currency.code),
+            finance: createEmptySubscriptionFinance(rate.amount.currency.code),
         };
         const defaultSettings = {
-            visibility: enums_1.SubscriptionVisibility.PRIVATE,
-            status: enums_1.SubscriptionStatus.ACTIVE,
+            visibility: SubscriptionVisibility.PRIVATE,
+            status: SubscriptionStatus.ACTIVE,
             system: {
                 isRestricted: false,
             },
@@ -95,7 +101,7 @@ class MajikSubscription {
      */
     setName(name) {
         this.name = name;
-        this.slug = (0, utils_1.generateSlug)(name);
+        this.slug = generateSlug(name);
         this.updateTimestamp();
         return this;
     }
@@ -132,8 +138,20 @@ class MajikSubscription {
     setRateAmount(amount) {
         if (amount <= 0)
             throw new Error("Rate Amount must be positive");
-        this.rate.amount = majik_money_1.MajikMoney.fromMajor(amount, this.rate.amount.currency.code);
-        this.metadata.rate.amount = majik_money_1.MajikMoney.fromMajor(amount, this.metadata.rate.amount.currency.code);
+        this.rate.amount = MajikMoney.fromMajor(amount, this.rate.amount.currency.code);
+        this.metadata.rate.amount = MajikMoney.fromMajor(amount, this.metadata.rate.amount.currency.code);
+        this.updateTimestamp();
+        this.markFinanceDirty();
+        return this;
+    }
+    /**
+     * Updates the billing cycle.
+     * @param {BillingCycle} cycle - New billing cycle (e.g., monthly, quarterly). use Enum `BillingCycle`.
+     * @returns {MajikSubscription} - Returns self for chaining.
+     */
+    setBillingCycle(cycle) {
+        this.rate.billingCycle = cycle;
+        this.metadata.rate.billingCycle = cycle;
         this.updateTimestamp();
         this.markFinanceDirty();
         return this;
@@ -213,7 +231,7 @@ class MajikSubscription {
      * @throws Will throw an error if the `type` is not provided or is not a string.
      */
     setType(type) {
-        if (!Object.values(enums_1.SubscriptionType).includes(type)) {
+        if (!Object.values(SubscriptionType).includes(type)) {
             throw new Error("Invalid Subscription type.");
         }
         this.metadata.type = type;
@@ -252,7 +270,7 @@ class MajikSubscription {
             throw new Error("COS quantity must be greater than zero");
         this.assertCurrency(unitCost);
         const newItem = {
-            id: (0, utils_1.autogenerateID)("mjksubcost"),
+            id: autogenerateID("mjksubcost"),
             item: name,
             quantity,
             unitCost,
@@ -450,7 +468,7 @@ class MajikSubscription {
         if (growthRate < 0) {
             throw new Error("Growth rate cannot be negative");
         }
-        const start = (0, utils_1.normalizeStartDate)(startDate);
+        const start = normalizeStartDate(startDate);
         const supplyPlan = [];
         let currentUnits = amount;
         for (let i = 0; i < months; i++) {
@@ -496,8 +514,8 @@ class MajikSubscription {
         this.markFinanceDirty();
         return this;
     }
-    recomputeCapacityPeriod(start, end, mode = enums_1.CapacityPeriodResizeMode.DEFAULT) {
-        if (!(0, utils_1.isValidYYYYMM)(start) || !(0, utils_1.isValidYYYYMM)(end)) {
+    recomputeCapacityPeriod(start, end, mode = CapacityPeriodResizeMode.DEFAULT) {
+        if (!isValidYYYYMM(start) || !isValidYYYYMM(end)) {
             throw new Error("Invalid YYYYMM period");
         }
         if (!this.hasCapacity()) {
@@ -506,21 +524,21 @@ class MajikSubscription {
         if (start > end) {
             throw new Error("Start month must be <= end month");
         }
-        const newLength = (0, utils_1.monthsInPeriod)(start, end);
+        const newLength = monthsInPeriod(start, end);
         const oldPlan = [...this.metadata.capacityPlan];
         const oldLength = oldPlan.length;
         const newPlan = [];
-        if (mode === enums_1.CapacityPeriodResizeMode.DEFAULT) {
+        if (mode === CapacityPeriodResizeMode.DEFAULT) {
             for (let i = 0; i < newLength; i++) {
                 const source = i < oldLength ? oldPlan[i] : oldPlan[oldLength - 1]; // extend using last known value
                 newPlan.push({
-                    month: (0, utils_1.offsetMonthsToYYYYMM)(start, i),
+                    month: offsetMonthsToYYYYMM(start, i),
                     capacity: source.capacity,
                     adjustment: source.adjustment,
                 });
             }
         }
-        if (mode === enums_1.CapacityPeriodResizeMode.DISTRIBUTE) {
+        if (mode === CapacityPeriodResizeMode.DISTRIBUTE) {
             const total = this.totalCapacity;
             const base = Math.floor(total / newLength);
             let remainder = total % newLength;
@@ -528,7 +546,7 @@ class MajikSubscription {
                 const extra = remainder > 0 ? 1 : 0;
                 remainder--;
                 newPlan.push({
-                    month: (0, utils_1.offsetMonthsToYYYYMM)(start, i),
+                    month: offsetMonthsToYYYYMM(start, i),
                     capacity: base + extra,
                 });
             }
@@ -546,7 +564,7 @@ class MajikSubscription {
      */
     setCapacity(capacityPlan) {
         capacityPlan.forEach((s) => {
-            if (!(0, utils_1.isValidYYYYMM)(s.month))
+            if (!isValidYYYYMM(s.month))
                 throw new Error(`Invalid month: ${s.month}`);
             if (typeof s.capacity !== "number")
                 throw new Error("Capacity must be a number");
@@ -565,10 +583,9 @@ class MajikSubscription {
      * @throws Will throw an error if month already exists.
      */
     addCapacity(month, units, adjustment) {
-        var _a;
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
-        (_a = this.metadata).capacityPlan ?? (_a.capacityPlan = []);
+        this.metadata.capacityPlan ??= [];
         if (this.metadata.capacityPlan.some((s) => s.month === month)) {
             throw new Error(`Month ${month} already exists. Use updateCapacityUnits or updateCapacityAdjustment`);
         }
@@ -585,7 +602,7 @@ class MajikSubscription {
      * @throws Will throw an error if month does not exist.
      */
     updateCapacityUnits(month, units) {
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
         const plan = this.metadata.capacityPlan?.find((s) => s.month === month);
         if (!plan)
@@ -603,7 +620,7 @@ class MajikSubscription {
      * @throws Will throw an error if month does not exist.
      */
     updateCapacityAdjustment(month, adjustment) {
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
         const plan = this.metadata.capacityPlan?.find((s) => s.month === month);
         if (!plan)
@@ -620,7 +637,7 @@ class MajikSubscription {
      * @throws Will throw an error if month does not exist.
      */
     removeCapacity(month) {
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
         const index = this.metadata.capacityPlan?.findIndex((s) => s.month === month);
         if (index === undefined || index === -1)
@@ -772,7 +789,7 @@ class MajikSubscription {
      * @returns {MajikMoney} Net Revenue
      */
     getNetRevenue(month, discounts, returns, allowances) {
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
         let net = this.getRevenue(month);
         if (discounts)
@@ -794,7 +811,7 @@ class MajikSubscription {
      * @returns {MajikMoney} Net Profit
      */
     getNetProfit(month, operatingExpenses, taxes, discounts, returns, allowances) {
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
         let netRev = this.getNetRevenue(month, discounts, returns, allowances);
         if (operatingExpenses)
@@ -807,7 +824,7 @@ class MajikSubscription {
      * Alias for getNetProfit, same as Net Income
      */
     getNetIncome(month, operatingExpenses, taxes, discounts, returns, allowances) {
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
         return this.getNetProfit(month, operatingExpenses, taxes, discounts, returns, allowances);
     }
@@ -818,7 +835,7 @@ class MajikSubscription {
      * @returns {MajikMoney} - Monthly revenue.
      */
     getRevenue(month) {
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
         const plan = this.metadata.capacityPlan?.find((s) => s.month === month);
         if (!plan)
@@ -832,13 +849,16 @@ class MajikSubscription {
     get cos() {
         return this.metadata.cos;
     }
+    get costBreakdown() {
+        return this.cos;
+    }
     /**
      * Returns COS for a specific month.
      * @param {YYYYMM} month - Month in YYYY-MM format.
      * @returns {MajikMoney} - Monthly COS.
      */
     getCOS(month) {
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
         const plan = this.metadata.capacityPlan?.find((s) => s.month === month);
         if (!plan)
@@ -860,7 +880,7 @@ class MajikSubscription {
      * @returns {MajikMoney} - Monthly profit.
      */
     getProfit(month) {
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
         return this.getRevenue(month).subtract(this.getCOS(month));
     }
@@ -870,7 +890,7 @@ class MajikSubscription {
      * @returns {number} - Profit margin (0–1).
      */
     getMargin(month) {
-        if (!(0, utils_1.isValidYYYYMM)(month))
+        if (!isValidYYYYMM(month))
             throw new Error("Invalid month");
         const revenue = this.getRevenue(month);
         return revenue.isZero()
@@ -948,7 +968,7 @@ class MajikSubscription {
     /** Monthly Recurring Revenue (MRR) for a specific month or current month if not provided */
     getMRR(month) {
         if (!month) {
-            month = (0, utils_1.dateToYYYYMM)(new Date());
+            month = dateToYYYYMM(new Date());
         }
         return this.getRevenue(month);
     }
@@ -990,11 +1010,11 @@ class MajikSubscription {
      * @returns {object} - Serialized subscription.
      */
     finalize() {
-        return { ...this.toJSON(), id: (0, utils_1.autogenerateID)("mjksub") };
+        return { ...this.toJSON(), id: autogenerateID("mjksub") };
     }
     /**
      * Converts the subscription instance to a plain JSON object.
-     * @returns {object} - Plain object representation.
+     * @returns {MajikSubscriptionJSON} - Plain object representation.
      */
     toJSON() {
         const preJSON = {
@@ -1012,17 +1032,17 @@ class MajikSubscription {
             metadata: this.metadata,
             settings: this.settings,
         };
-        return (0, majik_money_1.serializeMoney)(preJSON);
+        return serializeMoney(preJSON);
     }
     /**
      * Parses a plain object or JSON string into a MajikSubscription instance.
-     * @param {string | object} json - JSON string or object.
+     * @param {string | MajikSubscriptionJSON} json - JSON string or object.
      * @returns {MajikSubscription} - Parsed subscription instance.
      * @throws {Error} - Throws if required properties are missing.
      */
     static parseFromJSON(json) {
         const rawParse = typeof json === "string" ? JSON.parse(json) : structuredClone(json);
-        const parsedData = (0, majik_money_1.deserializeMoney)(rawParse);
+        const parsedData = deserializeMoney(rawParse);
         if (!parsedData.id)
             throw new Error("Missing required property: 'id'");
         if (!parsedData.timestamp)
@@ -1053,10 +1073,9 @@ class MajikSubscription {
         }
     }
 }
-exports.MajikSubscription = MajikSubscription;
-function isMajikSubscriptionClass(item) {
+export function isMajikSubscriptionClass(item) {
     return item.__object === "class";
 }
-function isMajikSubscriptionJSON(item) {
+export function isMajikSubscriptionJSON(item) {
     return item.__object === "json";
 }

package/dist/types.d.ts

@@ -93,3 +93,18 @@ export interface SubscriptionSettings {
         restrictedUntil?: ISODateString;
     };
 }
+export interface MajikSubscriptionJSON {
+    __type: "MajikSubscription";
+    __object: "json";
+    id: SubscriptionID;
+    slug: string;
+    name: string;
+    category: string;
+    rate: SubscriptionRate;
+    status: SubscriptionStatus;
+    type: SubscriptionType;
+    timestamp: ISODateString;
+    last_update: ISODateString;
+    metadata: SubscriptionMetadata;
+    settings: SubscriptionSettings;
+}

package/dist/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/dist/utils.js

@@ -1,19 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateSlug = generateSlug;
-exports.autogenerateID = autogenerateID;
-exports.isValidYYYYMM = isValidYYYYMM;
-exports.createZeroValueRatio = createZeroValueRatio;
-exports.createEmptySubscriptionFinance = createEmptySubscriptionFinance;
-exports.isoToYYYYMM = isoToYYYYMM;
-exports.yyyyMMToISO = yyyyMMToISO;
-exports.dateToYYYYMM = dateToYYYYMM;
-exports.yyyyMMToDate = yyyyMMToDate;
-exports.offsetMonthsToYYYYMM = offsetMonthsToYYYYMM;
-exports.monthsInPeriod = monthsInPeriod;
-exports.normalizeStartDate = normalizeStartDate;
-const nanoid_1 = require("nanoid");
-const majik_money_1 = require("@thezelijah/majik-money");
+import { customAlphabet } from "nanoid";
+import { MajikMoney } from "@thezelijah/majik-money";
 /**
  * Generates a URL-friendly slug from the name,
  * appending a Unix timestamp to ensure uniqueness.
@@ -21,9 +7,9 @@ const majik_money_1 = require("@thezelijah/majik-money");
  * @param name - The name to base the slug on.
  * @returns A unique slug string.
  */
-function generateSlug(name) {
+export function generateSlug(name) {
     // Create the generator function ONCE with your custom alphabet and length
-    const generateSlugID = (0, nanoid_1.customAlphabet)("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 6);
+    const generateSlugID = customAlphabet("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 6);
     const genUID = generateSlugID(); // e.g., 'X4tF9z'
     const slugText = name
         .toLowerCase()
@@ -37,24 +23,24 @@ function generateSlug(name) {
  * @param prefix - The prefix string name to add.
  * @returns A unique ID string prefixed.
  */
-function autogenerateID(prefix = "majik") {
+export function autogenerateID(prefix = "majik") {
     // Create the generator function ONCE with your custom alphabet and length
-    const generateID = (0, nanoid_1.customAlphabet)("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 8);
+    const generateID = customAlphabet("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz", 8);
     // Call the generator function to produce the actual ID string
     const genUID = generateID(); // Example output: 'G7K2aZp9'
     return `${prefix}-${genUID}`;
 }
-function isValidYYYYMM(month) {
+export function isValidYYYYMM(month) {
     return /^\d{4}-0[1-9]|1[0-2]$/.test(month);
 }
-function createZeroValueRatio(currencyCode) {
-    const zero = majik_money_1.MajikMoney.fromMinor(0, currencyCode);
+export function createZeroValueRatio(currencyCode) {
+    const zero = MajikMoney.fromMinor(0, currencyCode);
     return {
         value: zero,
         marginRatio: 0,
     };
 }
-function createEmptySubscriptionFinance(currencyCode) {
+export function createEmptySubscriptionFinance(currencyCode) {
     return {
         revenue: {
             gross: createZeroValueRatio(currencyCode),
@@ -74,7 +60,7 @@ function createEmptySubscriptionFinance(currencyCode) {
         },
     };
 }
-function isoToYYYYMM(isoDate) {
+export function isoToYYYYMM(isoDate) {
     const date = new Date(isoDate);
     if (isNaN(date.getTime())) {
         throw new Error("Invalid ISO date");
@@ -84,12 +70,12 @@ function isoToYYYYMM(isoDate) {
     const month = String(date.getUTCMonth() + 1).padStart(2, "0");
     return `${year}-${month}`;
 }
-function yyyyMMToISO(yyyyMM) {
+export function yyyyMMToISO(yyyyMM) {
     const [year, month] = yyyyMM.split("-").map(Number);
     // Construct as UTC Midnight
     return new Date(Date.UTC(year, month - 1, 1)).toISOString();
 }
-function dateToYYYYMM(date) {
+export function dateToYYYYMM(date) {
     if (isNaN(date.getTime())) {
         throw new Error("Invalid Date object");
     }
@@ -97,11 +83,11 @@ function dateToYYYYMM(date) {
     const month = String(date.getUTCMonth() + 1).padStart(2, "0");
     return `${year}-${month}`;
 }
-function yyyyMMToDate(yyyyMM) {
+export function yyyyMMToDate(yyyyMM) {
     const [year, month] = yyyyMM.split("-").map(Number);
     return new Date(Date.UTC(year, month - 1, 1));
 }
-function offsetMonthsToYYYYMM(input, offsetMonths) {
+export function offsetMonthsToYYYYMM(input, offsetMonths) {
     const date = normalizeStartDate(input);
     // Since normalizeStartDate now returns a UTC date,
     // we can safely use UTC methods here.
@@ -110,7 +96,7 @@ function offsetMonthsToYYYYMM(input, offsetMonths) {
     const result = new Date(Date.UTC(year, month, 1));
     return dateToYYYYMM(result);
 }
-function monthsInPeriod(earlier, later) {
+export function monthsInPeriod(earlier, later) {
     const start = yyyyMMToDate(earlier);
     const end = yyyyMMToDate(later);
     const startYear = start.getUTCFullYear();
@@ -119,7 +105,7 @@ function monthsInPeriod(earlier, later) {
     const endMonth = end.getUTCMonth();
     return (endYear - startYear) * 12 + (endMonth - startMonth) + 1;
 }
-function normalizeStartDate(input) {
+export function normalizeStartDate(input) {
     if (!input) {
         const now = new Date();
         // Return UTC version of the first of the current month

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thezelijah/majik-subscription",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Majik Subscription is a fully-featured class representing a subscription-based offering in the Majik system, designed for recurring revenue modeling, cost tracking, and subscriber capacity planning. It provides utilities for computing MRR, ARR, revenue, profit, margins, Cost of Subscription (COS), and net income on a per-period basis. Chainable setter methods make it easy to construct and update subscriptions fluently.",
   "license": "ISC",
   "author": "Zelijah",
@@ -15,30 +15,30 @@
     "type": "git",
     "url": "git+https://github.com/jedlsf/majik-subscription.git"
   },
- "keywords": [
-  "majik",
-  "majik-subscription",
-  "subscription-management",
-  "subscription-finance",
-  "cost-of-subscription",
-  "COS",
-  "revenue-calculation",
-  "profit-calculation",
-  "financial-modeling",
-  "capacity-planning",
-  "resource-planning",
-  "timesheet",
-  "billing",
-  "pricing",
-  "business-tools",
-  "typescript",
-  "javascript",
-  "enterprise-tools",
-  "monetary-calculation",
-  "majik-money",
-  "subscription-analytics",
-  "forecasting"
-],
+  "keywords": [
+    "majik",
+    "majik-subscription",
+    "subscription-management",
+    "subscription-finance",
+    "cost-of-subscription",
+    "COS",
+    "revenue-calculation",
+    "profit-calculation",
+    "financial-modeling",
+    "capacity-planning",
+    "resource-planning",
+    "timesheet",
+    "billing",
+    "pricing",
+    "business-tools",
+    "typescript",
+    "javascript",
+    "enterprise-tools",
+    "monetary-calculation",
+    "majik-money",
+    "subscription-analytics",
+    "forecasting"
+  ],
   "homepage": "https://github.com/jedlsf/majik-subscription#readme",
   "bugs": {
     "url": "https://github.com/jedlsf/majik-subscription/issues"
@@ -49,7 +49,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@thezelijah/majik-money": "^1.0.3",
+    "@thezelijah/majik-money": "^1.0.4",
     "nanoid": "^5.1.6",
     "typescript": "^5.9.3"
   }