business-as-code 2.3.0 → 2.4.0

package/dist/finance/proof-predicate.js

@@ -0,0 +1,80 @@
+/**
+ * ProofPredicate — composable predicates that gate outcome-based settlement.
+ *
+ * Stripe's MPP Sessions ship escrow but no outcome-predicate-driven release —
+ * this module is the gap-filler. SaS's Service.outcomeContract.predicate
+ * uses these to express "definition of done."
+ *
+ * Seven leaf predicates + AND/OR composition:
+ *   - schema-match            : output matches schema
+ *   - evaluator-pass          : EvaluatorPanel approves at threshold
+ *   - human-sign              : human with signerRoles signs
+ *   - external                : external verifier (e.g. github CI + merged) approves
+ *   - load-bearing-pass       : a named subset of rubric items all pass (sb killThreshold)
+ *   - overall-floor           : N of total rubric items pass (sb killThreshold)
+ *   - unmet-requirements-pass : no `severity: 'blocking'` UnmetRequirements remain
+ *                               (sb-n7d open-blocking gate); when `categories` is
+ *                               supplied, only those categories are checked.
+ */
+export const SchemaMatch = (schema) => ({
+    kind: 'schema-match',
+    schema,
+});
+export const EvaluatorPass = (opts) => ({
+    kind: 'evaluator-pass',
+    panelRef: opts.panelRef,
+    minScore: opts.minScore,
+});
+export const HumanSign = (opts) => {
+    if (opts.when !== undefined) {
+        return { kind: 'human-sign', signerRoles: opts.signerRoles, when: opts.when };
+    }
+    return { kind: 'human-sign', signerRoles: opts.signerRoles };
+};
+export const External = (opts) => ({
+    kind: 'external',
+    verifier: opts.verifier,
+    spec: opts.spec,
+});
+export const LoadBearingPass = (itemSet) => ({
+    kind: 'load-bearing-pass',
+    itemSet,
+});
+export const OverallFloor = (opts) => ({
+    kind: 'overall-floor',
+    minPasses: opts.minPasses,
+    outOfTotal: opts.outOfTotal,
+});
+/**
+ * `UnmetRequirementsPass` — sb-n7d's open-blocking gate as a first-class
+ * predicate.
+ *
+ * Passes iff no `severity: 'blocking'` UnmetRequirement is present in the
+ * verify-time evaluation context. `severity: 'warning'` items are ignored.
+ *
+ * When `categories` is supplied, only requirements whose `category` matches
+ * one of the listed values are considered (others are ignored regardless of
+ * severity). When omitted, ALL categories are inspected.
+ *
+ * @example
+ *   // Any blocking unmet requirement fails the predicate.
+ *   UnmetRequirementsPass()
+ *
+ *   // Only blocking items in the 'compliance' or 'security' buckets fail.
+ *   UnmetRequirementsPass({ categories: ['compliance', 'security'] })
+ */
+export const UnmetRequirementsPass = (opts) => {
+    if (opts?.categories !== undefined) {
+        return { kind: 'unmet-requirements-pass', categories: opts.categories };
+    }
+    return { kind: 'unmet-requirements-pass' };
+};
+export const AND = (...predicates) => ({
+    kind: 'and',
+    predicates,
+});
+export const OR = (...predicates) => ({
+    kind: 'or',
+    predicates,
+});
+//# sourceMappingURL=proof-predicate.js.map

package/dist/finance/proof-predicate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proof-predicate.js","sourceRoot":"","sources":["../../src/finance/proof-predicate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAiBH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAe,EAAkB,EAAE,CAAC,CAAC;IAC/D,IAAI,EAAE,cAAc;IACpB,MAAM;CACP,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAG7B,EAAkB,EAAE,CAAC,CAAC;IACrB,IAAI,EAAE,gBAAgB;IACtB,QAAQ,EAAE,IAAI,CAAC,QAAQ;IACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;CACxB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,IAA8C,EAAkB,EAAE;IAC1F,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAA;IAC/E,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAA;AAC9D,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAyC,EAAkB,EAAE,CAAC,CAAC;IACtF,IAAI,EAAE,UAAU;IAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;IACvB,IAAI,EAAE,IAAI,CAAC,IAAI;CAChB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAiB,EAAkB,EAAE,CAAC,CAAC;IACrE,IAAI,EAAE,mBAAmB;IACzB,OAAO;CACR,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAA+C,EAAkB,EAAE,CAAC,CAAC;IAChG,IAAI,EAAE,eAAe;IACrB,SAAS,EAAE,IAAI,CAAC,SAAS;IACzB,UAAU,EAAE,IAAI,CAAC,UAAU;CAC5B,CAAC,CAAA;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,IAAgC,EAAkB,EAAE;IACxF,IAAI,IAAI,EAAE,UAAU,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,EAAE,IAAI,EAAE,yBAAyB,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAA;IACzE,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,yBAAyB,EAAE,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,GAAG,UAA4B,EAAkB,EAAE,CAAC,CAAC;IACvE,IAAI,EAAE,KAAK;IACX,UAAU;CACX,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,UAA4B,EAAkB,EAAE,CAAC,CAAC;IACtE,IAAI,EAAE,IAAI;IACV,UAAU;CACX,CAAC,CAAA"}

package/dist/finance/refund.d.ts

@@ -0,0 +1,44 @@
+/**
+ * RefundContract — typed refund machinery. The 7-pattern catalog (per startup-builder
+ * SERVICES.md) defines the contractual templates a Service can bind to.
+ *
+ * Stripe's Smart Disputes are consumer-chargeback-shaped; this is B2B SLA-shape.
+ */
+export type RefundContractRef = 'no-charge-if-not-qualified' | 'quality-floor-fail' | 'sla-credit-on-late-delivery' | 'sla-credit-on-late-close' | 'partial-credit-on-partial-delivery' | 'time-bounded-money-back' | 'escalate-to-dispute' | (string & {
+    __brand?: 'RefundContractRef';
+});
+/**
+ * Catalog of canonical refund contracts. Consumers reference by id; substrate
+ * resolves the contract semantics at settlement time.
+ */
+export declare const RefundContracts: {
+    readonly 'no-charge-if-not-qualified': {
+        readonly description: "No charge unless EvaluatorPass + downstream verification confirms work delivered.";
+        readonly triggersAt: "pre-charge";
+    };
+    readonly 'quality-floor-fail': {
+        readonly description: "Full refund when EvaluatorPanel rejects below quality floor.";
+        readonly triggersAt: "post-quality-review";
+    };
+    readonly 'sla-credit-on-late-delivery': {
+        readonly description: "Credit equal to N% of invoice when delivery exceeds OutcomeContract.expiresAt.";
+        readonly triggersAt: "on-timeout";
+    };
+    readonly 'sla-credit-on-late-close': {
+        readonly description: "Credit on monthly subscription when SLA target (e.g. close-by-day-5) breached.";
+        readonly triggersAt: "sla-breach";
+    };
+    readonly 'partial-credit-on-partial-delivery': {
+        readonly description: "Pro-rata credit when fraction of work-units delivered (e.g. tickets resolved).";
+        readonly triggersAt: "post-delivery";
+    };
+    readonly 'time-bounded-money-back': {
+        readonly description: "Full refund within N days of acceptance, no questions asked.";
+        readonly triggersAt: "on-customer-request";
+    };
+    readonly 'escalate-to-dispute': {
+        readonly description: "Route to ESCALATED_TO_HUMAN_REVIEW state; manual resolution.";
+        readonly triggersAt: "on-customer-dispute";
+    };
+};
+//# sourceMappingURL=refund.d.ts.map

package/dist/finance/refund.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refund.d.ts","sourceRoot":"","sources":["../../src/finance/refund.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,MAAM,iBAAiB,GACzB,4BAA4B,GAC5B,oBAAoB,GACpB,6BAA6B,GAC7B,0BAA0B,GAC1B,oCAAoC,GACpC,yBAAyB,GACzB,qBAAqB,GACrB,CAAC,MAAM,GAAG;IAAE,OAAO,CAAC,EAAE,mBAAmB,CAAA;CAAE,CAAC,CAAA;AAEhD;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BlB,CAAA"}

package/dist/finance/refund.js

@@ -0,0 +1,41 @@
+/**
+ * RefundContract — typed refund machinery. The 7-pattern catalog (per startup-builder
+ * SERVICES.md) defines the contractual templates a Service can bind to.
+ *
+ * Stripe's Smart Disputes are consumer-chargeback-shaped; this is B2B SLA-shape.
+ */
+/**
+ * Catalog of canonical refund contracts. Consumers reference by id; substrate
+ * resolves the contract semantics at settlement time.
+ */
+export const RefundContracts = {
+    'no-charge-if-not-qualified': {
+        description: 'No charge unless EvaluatorPass + downstream verification confirms work delivered.',
+        triggersAt: 'pre-charge',
+    },
+    'quality-floor-fail': {
+        description: 'Full refund when EvaluatorPanel rejects below quality floor.',
+        triggersAt: 'post-quality-review',
+    },
+    'sla-credit-on-late-delivery': {
+        description: 'Credit equal to N% of invoice when delivery exceeds OutcomeContract.expiresAt.',
+        triggersAt: 'on-timeout',
+    },
+    'sla-credit-on-late-close': {
+        description: 'Credit on monthly subscription when SLA target (e.g. close-by-day-5) breached.',
+        triggersAt: 'sla-breach',
+    },
+    'partial-credit-on-partial-delivery': {
+        description: 'Pro-rata credit when fraction of work-units delivered (e.g. tickets resolved).',
+        triggersAt: 'post-delivery',
+    },
+    'time-bounded-money-back': {
+        description: 'Full refund within N days of acceptance, no questions asked.',
+        triggersAt: 'on-customer-request',
+    },
+    'escalate-to-dispute': {
+        description: 'Route to ESCALATED_TO_HUMAN_REVIEW state; manual resolution.',
+        triggersAt: 'on-customer-dispute',
+    },
+};
+//# sourceMappingURL=refund.js.map

package/dist/finance/refund.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"refund.js","sourceRoot":"","sources":["../../src/finance/refund.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAYH;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,4BAA4B,EAAE;QAC5B,WAAW,EACT,mFAAmF;QACrF,UAAU,EAAE,YAAY;KACzB;IACD,oBAAoB,EAAE;QACpB,WAAW,EAAE,8DAA8D;QAC3E,UAAU,EAAE,qBAAqB;KAClC;IACD,6BAA6B,EAAE;QAC7B,WAAW,EAAE,gFAAgF;QAC7F,UAAU,EAAE,YAAY;KACzB;IACD,0BAA0B,EAAE;QAC1B,WAAW,EAAE,gFAAgF;QAC7F,UAAU,EAAE,YAAY;KACzB;IACD,oCAAoC,EAAE;QACpC,WAAW,EAAE,gFAAgF;QAC7F,UAAU,EAAE,eAAe;KAC5B;IACD,yBAAyB,EAAE;QACzB,WAAW,EAAE,8DAA8D;QAC3E,UAAU,EAAE,qBAAqB;KAClC;IACD,qBAAqB,EAAE;QACrB,WAAW,EAAE,8DAA8D;QAC3E,UAAU,EAAE,qBAAqB;KAClC;CACO,CAAA"}

package/dist/finance/sla.d.ts

@@ -0,0 +1,25 @@
+/**
+ * SLAPolicy — service-level agreement with auto-credit / auto-refund / escalate
+ * on breach. The SaS book's "outcome-pricing requires you to stand behind quality"
+ * substrate.
+ */
+export interface SLATarget {
+    metric: 'latency-ms' | 'accuracy' | 'on-time' | 'completeness' | 'first-contact-resolution' | 'csat' | string;
+    /** Threshold value or expression (e.g. 'day-5', 0.95, 1000). */
+    threshold: number | string;
+}
+export interface SLAPolicy {
+    $id: string;
+    $type: 'SLAPolicy';
+    serviceRef: string;
+    targets: SLATarget[];
+    onBreach: {
+        /** Percent of charge to credit back (0-100). */
+        creditPercent?: number;
+        /** Percent of charge to refund (0-100). */
+        refundPercent?: number;
+        /** Worker (Person/Agent/Role) to escalate to. */
+        escalateTo?: string;
+    };
+}
+//# sourceMappingURL=sla.d.ts.map

package/dist/finance/sla.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sla.d.ts","sourceRoot":"","sources":["../../src/finance/sla.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,SAAS;IACxB,MAAM,EACF,YAAY,GACZ,UAAU,GACV,SAAS,GACT,cAAc,GACd,0BAA0B,GAC1B,MAAM,GACN,MAAM,CAAA;IACV,gEAAgE;IAChE,SAAS,EAAE,MAAM,GAAG,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,WAAW,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,SAAS,EAAE,CAAA;IACpB,QAAQ,EAAE;QACR,gDAAgD;QAChD,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,2CAA2C;QAC3C,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,iDAAiD;QACjD,UAAU,CAAC,EAAE,MAAM,CAAA;KACpB,CAAA;CACF"}

package/dist/finance/sla.js

@@ -0,0 +1,7 @@
+/**
+ * SLAPolicy — service-level agreement with auto-credit / auto-refund / escalate
+ * on breach. The SaS book's "outcome-pricing requires you to stand behind quality"
+ * substrate.
+ */
+export {};
+//# sourceMappingURL=sla.js.map

package/dist/finance/sla.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sla.js","sourceRoot":"","sources":["../../src/finance/sla.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/dist/finance/types.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Core value types — Money, Cost, Budget, SpendControl, CostModel.
+ *
+ * Money uses bigint in smallest currency unit (cents/satoshis/wei) for precision.
+ * Refs use plain string with brand comment; cross-package nominal types deferred.
+ */
+export type FiatCurrency = 'USD' | 'EUR' | 'GBP' | 'JPY' | 'CAD' | 'AUD' | string;
+export type StablecoinCurrency = 'USDC' | 'PYUSD' | 'USDT' | 'USDG' | 'USDSui' | 'CASH' | string;
+export type CryptoCurrency = 'BTC' | 'ETH' | 'SOL';
+export type Currency = FiatCurrency | StablecoinCurrency | CryptoCurrency;
+export interface Money {
+    amount: bigint;
+    currency: Currency;
+}
+/** Cost incurred by an Action — every cascade Function call captures one. */
+export interface Cost {
+    $id: string;
+    $type: 'Cost';
+    /** Reference to the underlying Action (digital-objects ActionRef shape). */
+    actionRef: string;
+    amount: Money;
+    /** Provider that incurred the cost: 'openai' | 'anthropic' | 'stripe' | ... */
+    provider: string;
+    category: 'inference' | 'compute' | 'storage' | 'api' | 'human' | 'rail-fee' | 'other';
+    /** ISO-8601 timestamp. */
+    capturedAt: string;
+}
+/** Where a Budget applies. */
+export type BudgetScope = {
+    kind: 'worker';
+    ref: string;
+} | {
+    kind: 'function';
+    ref: string;
+} | {
+    kind: 'goal';
+    ref: string;
+} | {
+    kind: 'experiment';
+    ref: string;
+} | {
+    kind: 'tenant';
+    ref: string;
+};
+export interface Budget {
+    $id: string;
+    $type: 'Budget';
+    scope: BudgetScope;
+    cap: Money;
+    period: 'daily' | 'weekly' | 'monthly' | 'one-time';
+    /** ISO-8601 timestamp; absent for one-time budgets. */
+    resetAt?: string;
+}
+export interface SpendControl {
+    budgetRef: string;
+    /** 0-1 fraction of cap — warn when soft threshold crossed. */
+    soft?: number;
+    /** 0-1 fraction of cap — block/escalate when hard threshold crossed. */
+    hard: number;
+    onBreach: 'block' | 'escalate' | 'warn';
+    /** Worker to escalate to (Person/Agent/Role); ThingRef shape. */
+    escalateTo?: string;
+}
+/** Declared cost model on a Function or Service. */
+export interface CostModel {
+    /** Per-invocation flat cost (cents in smallest unit). */
+    perInvocation?: bigint;
+    /** Per-transaction cost (e.g. per-token, per-row). */
+    perTx?: bigint;
+    /** Per round of agent execution (e.g. per-dev-agent-round). */
+    perAgentRound?: bigint;
+    /** Per external API call. */
+    perApiCall?: bigint;
+    /** Per-symbol or per-unit-of-output. */
+    perUnit?: bigint;
+    /** Hourly rate for human work. */
+    perHour?: bigint;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/finance/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/finance/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,MAAM,YAAY,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,CAAA;AACjF,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAA;AAChG,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAA;AAClD,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,kBAAkB,GAAG,cAAc,CAAA;AAEzE,MAAM,WAAW,KAAK;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,QAAQ,CAAA;CACnB;AAED,6EAA6E;AAC7E,MAAM,WAAW,IAAI;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,KAAK,CAAA;IACb,+EAA+E;IAC/E,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,KAAK,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,CAAA;IACtF,0BAA0B;IAC1B,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,8BAA8B;AAC9B,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GACjC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAC7B;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAA;AAEnC,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,QAAQ,CAAA;IACf,KAAK,EAAE,WAAW,CAAA;IAClB,GAAG,EAAE,KAAK,CAAA;IACV,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAA;IACnD,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,wEAAwE;IACxE,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,GAAG,UAAU,GAAG,MAAM,CAAA;IACvC,iEAAiE;IACjE,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,oDAAoD;AACpD,MAAM,WAAW,SAAS;IACxB,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+DAA+D;IAC/D,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB"}

package/dist/finance/types.js

@@ -0,0 +1,8 @@
+/**
+ * Core value types — Money, Cost, Budget, SpendControl, CostModel.
+ *
+ * Money uses bigint in smallest currency unit (cents/satoshis/wei) for precision.
+ * Refs use plain string with brand comment; cross-package nominal types deferred.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/finance/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/finance/types.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/financials.d.ts

@@ -0,0 +1,130 @@
+/**
+ * Financial metrics and calculations
+ */
+import type { FinancialMetrics, FinancialStatement, Currency } from './types.js';
+/**
+ * Calculate financial metrics from basic inputs
+ *
+ * @example
+ * ```ts
+ * const metrics = financials({
+ *   revenue: 1000000,
+ *   cogs: 300000,
+ *   operatingExpenses: 500000,
+ *   currency: 'USD',
+ *   period: 'monthly',
+ * })
+ *
+ * console.log(metrics.grossMargin) // 70%
+ * console.log(metrics.operatingMargin) // 20%
+ * console.log(metrics.netMargin) // 20%
+ * ```
+ */
+export declare function financials(metrics: Partial<FinancialMetrics>): FinancialMetrics;
+/**
+ * Calculate gross margin
+ */
+export declare function calculateGrossMargin(revenue: number, cogs: number): number;
+/**
+ * Calculate operating margin
+ */
+export declare function calculateOperatingMargin(revenue: number, cogs: number, operatingExpenses: number): number;
+/**
+ * Calculate net margin
+ */
+export declare function calculateNetMargin(revenue: number, netIncome: number): number;
+/**
+ * Calculate EBITDA margin
+ */
+export declare function calculateEBITDAMargin(revenue: number, ebitda: number): number;
+/**
+ * Calculate burn rate (monthly cash burn)
+ */
+export declare function calculateBurnRate(cashStart: number, cashEnd: number, months: number): number;
+/**
+ * Calculate runway (months until cash runs out)
+ */
+export declare function calculateRunway(cash: number, monthlyBurnRate: number): number;
+/**
+ * Calculate customer acquisition cost (CAC)
+ */
+export declare function calculateCAC(marketingSpend: number, newCustomers: number): number;
+/**
+ * Calculate customer lifetime value (LTV)
+ */
+export declare function calculateLTV(averageRevenuePerCustomer: number, averageCustomerLifetimeMonths: number, grossMarginPercent: number): number;
+/**
+ * Calculate LTV:CAC ratio
+ */
+export declare function calculateLTVtoCAC(ltv: number, cac: number): number;
+/**
+ * Calculate payback period (months to recover CAC)
+ */
+export declare function calculatePaybackPeriod(cac: number, monthlyRevPerCustomer: number): number;
+/**
+ * Calculate annual recurring revenue (ARR)
+ */
+export declare function calculateARR(mrr: number): number;
+/**
+ * Calculate monthly recurring revenue (MRR)
+ */
+export declare function calculateMRR(arr: number): number;
+/**
+ * Calculate revenue growth rate
+ */
+export declare function calculateGrowthRate(currentRevenue: number, previousRevenue: number): number;
+/**
+ * Calculate compound annual growth rate (CAGR)
+ */
+export declare function calculateCAGR(beginningValue: number, endingValue: number, years: number): number;
+/**
+ * Calculate return on investment (ROI)
+ */
+export declare function calculateROI(gain: number, cost: number): number;
+/**
+ * Calculate return on equity (ROE)
+ */
+export declare function calculateROE(netIncome: number, shareholderEquity: number): number;
+/**
+ * Calculate return on assets (ROA)
+ */
+export declare function calculateROA(netIncome: number, totalAssets: number): number;
+/**
+ * Calculate quick ratio (liquidity)
+ */
+export declare function calculateQuickRatio(currentAssets: number, inventory: number, currentLiabilities: number): number;
+/**
+ * Calculate current ratio (liquidity)
+ */
+export declare function calculateCurrentRatio(currentAssets: number, currentLiabilities: number): number;
+/**
+ * Calculate debt-to-equity ratio
+ */
+export declare function calculateDebtToEquity(totalDebt: number, totalEquity: number): number;
+/**
+ * Format currency value
+ */
+export declare function formatCurrency(amount: number, currency?: Currency): string;
+/**
+ * Create a financial statement
+ */
+export declare function createStatement(type: FinancialStatement['type'], period: string, lineItems: Record<string, number>, currency?: Currency): FinancialStatement;
+/**
+ * Get line item from financial statement
+ */
+export declare function getLineItem(statement: FinancialStatement, name: string): number;
+/**
+ * Compare financial metrics between periods
+ */
+export declare function compareMetrics(current: FinancialMetrics, previous: FinancialMetrics): Record<string, {
+    change: number;
+    changePercent: number;
+}>;
+/**
+ * Validate financial metrics
+ */
+export declare function validateFinancials(metrics: FinancialMetrics): {
+    valid: boolean;
+    errors: string[];
+};
+//# sourceMappingURL=financials.d.ts.map

package/dist/financials.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"financials.d.ts","sourceRoot":"","sources":["../src/financials.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,QAAQ,EAAc,MAAM,YAAY,CAAA;AAE5F;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAAG,gBAAgB,CAmC/E;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAG1E;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,iBAAiB,EAAE,MAAM,GACxB,MAAM,CAIR;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAG7E;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAG7E;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,MAAM,CAGR;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM,CAI7E;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAGjF;AAED;;GAEG;AACH,wBAAgB,YAAY,CAC1B,yBAAyB,EAAE,MAAM,EACjC,6BAA6B,EAAE,MAAM,EACrC,kBAAkB,EAAE,MAAM,GACzB,MAAM,CAER;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAGlE;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,GAAG,MAAM,CAGzF;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM,CAG3F;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,cAAc,EAAE,MAAM,EACtB,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,MAAM,GACZ,MAAM,CAGR;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAG/D;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAGjF;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAG3E;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,kBAAkB,EAAE,MAAM,GACzB,MAAM,CAGR;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,aAAa,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,MAAM,CAG/F;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAGpF;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAE,QAAgB,GAAG,MAAM,CASjF;AAkBD;;GAEG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAChC,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACjC,QAAQ,GAAE,QAAgB,GACzB,kBAAkB,CAOpB;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,kBAAkB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE/E;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,gBAAgB,EACzB,QAAQ,EAAE,gBAAgB,GACzB,MAAM,CAAC,MAAM,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE,CAAC,CAqB3D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,EAAE,gBAAgB,GACxB;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CAuBtC"}