@owostack/types 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Owostack
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,33 @@
+# @owostack/types
+
+Shared TypeScript types for the Owostack billing infrastructure. This package provides the type definitions used across the Owostack ecosystem, including the Core SDK, CLI, and API.
+
+## Installation
+
+```bash
+npm install @owostack/types
+```
+
+## Features
+
+- **Core Configuration**: Types for SDK initialization and environment settings.
+- **API Parameters & Results**: Request and response types for all Owostack endpoints (attach, check, track, etc.).
+- **Catalog Definitions**: Types for declarative plan and feature configuration.
+- **Database Models**: Interfaces for customers, subscriptions, entitlements, and usage records.
+- **Shared Constants**: Type unions for currencies, billing intervals, and reset periods.
+
+## Usage
+
+You generally do not need to install this package directly if you are using `owostack`, as it is included as a dependency. However, it can be useful for shared utility functions or when building custom integrations.
+
+```ts
+import type {
+  OwostackConfig,
+  AttachParams,
+  CheckResult,
+} from "@owostack/types";
+```
+
+## License
+
+Apache-2.0

package/dist/index.d.ts

@@ -0,0 +1,806 @@
+/**
+ * Core configuration types
+ */
+interface OwostackConfig {
+    /** API secret key */
+    secretKey: string;
+    /** Optional: Default provider for all plans (e.g., "paystack", "dodo") */
+    provider?: string;
+    /** Optional: Environment mode (sandbox or live) */
+    mode?: "sandbox" | "live";
+    /** Optional: Custom API URL for self-hosted deployments (takes precedence over mode) */
+    apiUrl?: string;
+    /** Optional: Enable debug mode */
+    debug?: boolean;
+    /** Optional: Declarative catalog of plans and features */
+    catalog?: CatalogEntry[];
+}
+/**
+ * CustomerData - Passed to auto-create/update a customer on any endpoint.
+ * Email is always required because billing providers need it.
+ */
+interface CustomerData {
+    /** Customer email (required for billing providers) */
+    email: string;
+    /** Customer display name */
+    name?: string;
+    /** Custom metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * attach() - Checkout & Subscription Management
+ */
+interface AttachParams {
+    /** Customer ID or email */
+    customer: string;
+    /** Product/plan slug or ID to purchase or upgrade to */
+    product: string;
+    /** Optional: Auto-create or update the customer */
+    customerData?: CustomerData;
+    /** Optional: Custom metadata */
+    metadata?: Record<string, unknown>;
+    /** Optional: Payment channels to enable */
+    channels?: PaymentChannel[];
+    /** Optional: Currency (auto-detected if not provided) */
+    currency?: Currency;
+    /** Optional: Redirect URL after successful payment */
+    callbackUrl?: string;
+}
+interface AttachResult {
+    /** Checkout URL to redirect user */
+    checkoutUrl: string;
+    /** Payment reference for tracking */
+    reference: string;
+    /** Access code for inline checkout */
+    accessCode: string;
+    /** Resolved internal customer ID */
+    customerId: string;
+    /** Switch type if customer already had a subscription */
+    type: "new" | "upgrade" | "downgrade" | "lateral";
+}
+/**
+ * check() - Feature Gating & Access Control
+ */
+interface CheckParams {
+    /** Customer ID or email */
+    customer: string;
+    /** Feature slug or ID to check access for */
+    feature: string;
+    /** Units to check against limit (default: 1) */
+    value?: number;
+    /** Optional: Auto-create customer if not found */
+    customerData?: CustomerData;
+    /** Optional: Atomically track usage if allowed (check + track in one call) */
+    sendEvent?: boolean;
+    /** Optional: Entity ID to scope usage to (e.g. seat, workspace) */
+    entity?: string;
+}
+/** Machine-readable codes returned by check() */
+type CheckCode = "access_granted" | "overage_allowed" | "addon_credits_used" | "limit_exceeded" | "insufficient_credits" | "customer_not_found" | "feature_not_found" | "no_active_subscription" | "feature_not_in_plan" | "unknown_feature_type";
+/** Machine-readable codes returned by track() */
+type TrackCode = "tracked" | "tracked_overage" | "addon_credits_used" | "limit_exceeded" | "customer_not_found" | "feature_not_found" | "no_active_subscription" | "feature_not_in_plan" | "internal_error";
+/** Overage billing details included when usage exceeds the plan limit */
+interface OverageDetails {
+    /** Overage handling type */
+    type: "charge" | "notify" | "block";
+    /** Whether this overage will be billed */
+    willBeBilled: boolean;
+    /** Price per overage unit in minor currency units (e.g. kobo) */
+    pricePerUnit?: number | null;
+    /** Number of units per billing increment */
+    billingUnits?: number | null;
+}
+/**
+ * Contextual details object returned alongside standard check/track fields.
+ * Contains all optional/situational information that isn't part of the
+ * core response shape (trial status, plan info, overage billing, etc.).
+ */
+interface ResponseDetails {
+    /** Human-readable explanation of the result */
+    message: string;
+    /** Name of the plan granting access */
+    planName?: string;
+    /** Whether access is via a free trial */
+    trial?: boolean;
+    /** ISO timestamp when the trial ends */
+    trialEndsAt?: string | null;
+    /** Credit system slug (when feature resolved via credit system) */
+    creditSystem?: string;
+    /** Credit cost per unit of the child feature */
+    creditCostPerUnit?: number;
+    /** Overage billing details (present when usage exceeds plan limit) */
+    overage?: OverageDetails;
+    /** Number of add-on credits used in this request */
+    addonCreditsUsed?: number;
+    /** Remaining add-on credits after this request */
+    addonCreditsRemaining?: number;
+}
+/** Plan credit breakdown for credit system features */
+interface PlanCredits {
+    /** Credits used this period */
+    used: number;
+    /** Plan credit limit */
+    limit: number | null;
+    /** ISO timestamp when plan credits reset */
+    resetsAt: string;
+}
+interface CheckResult {
+    /** Whether access is allowed */
+    allowed: boolean;
+    /** Machine-readable code */
+    code: CheckCode | string;
+    /** Current usage this period (null for boolean features) */
+    usage: number | null;
+    /** Plan limit (null = unlimited) */
+    limit: number | null;
+    /** Remaining plan units: limit - usage (null = unlimited) */
+    balance: number | null;
+    /** ISO timestamp when usage resets (null for boolean/non-resetting) */
+    resetsAt: string | null;
+    /** Reset interval (null for boolean features) */
+    resetInterval: string | null;
+    /** Add-on credit balance for this credit system (only for credit system features) */
+    addonCredits?: number;
+    /** Plan credit breakdown (only for credit system features) */
+    planCredits?: PlanCredits;
+    /** Contextual details (trial info, plan name, overage, human message) */
+    details: ResponseDetails;
+}
+/**
+ * track() - Usage Metering & Billing
+ */
+interface TrackParams {
+    /** Customer ID or email */
+    customer: string;
+    /** Feature slug or ID to track usage for */
+    feature: string;
+    /** Amount to track (default: 1) */
+    value?: number;
+    /** Optional: Auto-create customer if not found */
+    customerData?: CustomerData;
+    /** Optional: Entity ID to scope usage to (e.g. seat, workspace) */
+    entity?: string;
+    /** Optional: Event metadata */
+    metadata?: Record<string, unknown>;
+}
+interface TrackResult {
+    /** Whether tracking was successful */
+    success: boolean;
+    /** Whether the tracked usage was within limits */
+    allowed: boolean;
+    /** Machine-readable code */
+    code: TrackCode | string;
+    /** Current usage this period after tracking (null for unlimited) */
+    usage: number | null;
+    /** Plan limit (null = unlimited) */
+    limit: number | null;
+    /** Remaining plan units after tracking: limit - usage (null = unlimited) */
+    balance: number | null;
+    /** ISO timestamp when usage resets */
+    resetsAt: string | null;
+    /** Reset interval */
+    resetInterval: string | null;
+    /** Add-on credit balance for this credit system (only for credit system features) */
+    addonCredits?: number;
+    /** Plan credit breakdown (only for credit system features) */
+    planCredits?: PlanCredits;
+    /** Contextual details (trial info, plan name, overage, human message) */
+    details: ResponseDetails;
+}
+/**
+ * billing.usage() - Get Unbilled Overage Usage
+ */
+interface BillingUsageParams {
+    /** Customer ID or email */
+    customer: string;
+}
+interface BillingFeatureUsage {
+    /** Feature ID */
+    featureId: string;
+    /** Human-readable feature name */
+    featureName: string;
+    /** Total usage this period */
+    usage: number;
+    /** Included in plan (null = unlimited) */
+    included: number | null;
+    /** Billable overage units */
+    billableQuantity: number;
+    /** Estimated overage charge in minor currency units */
+    estimatedAmount: number;
+    /** Usage billing model */
+    usageModel: string;
+}
+interface BillingUsageResult {
+    /** Whether the request succeeded */
+    success: boolean;
+    /** Total estimated overage amount in minor currency units */
+    totalEstimated: number;
+    /** Currency code */
+    currency: string;
+    /** Per-feature breakdown */
+    features: BillingFeatureUsage[];
+}
+/**
+ * billing.invoice() - Generate an Invoice
+ */
+interface InvoiceParams {
+    /** Customer ID or email */
+    customer: string;
+}
+interface InvoiceLineItem {
+    /** Feature or item description */
+    description: string;
+    /** Quantity */
+    quantity: number;
+    /** Unit price in minor currency units */
+    unitPrice: number;
+    /** Line total in minor currency units */
+    amount: number;
+}
+interface Invoice {
+    /** Invoice ID */
+    id: string;
+    /** Human-readable invoice number */
+    number: string;
+    /** Total amount in minor currency units */
+    total: number;
+    /** Currency code */
+    currency: string;
+    /** Invoice status */
+    status: "draft" | "open" | "paid" | "void";
+    /** Line items */
+    lineItems?: InvoiceLineItem[];
+    /** ISO timestamp */
+    createdAt: string;
+}
+interface InvoiceResult {
+    /** Whether the request succeeded */
+    success: boolean;
+    /** Generated invoice */
+    invoice: Invoice;
+}
+/**
+ * billing.pay() - Pay an Invoice
+ */
+interface PayInvoiceParams {
+    /** Invoice ID */
+    invoiceId: string;
+    /** URL to redirect to after checkout payment (used when auto-charge fails) */
+    callbackUrl?: string;
+}
+interface PayInvoiceResult {
+    /** Whether the request succeeded */
+    success: boolean;
+    /** Whether the invoice was auto-charged (true) or needs manual checkout (false) */
+    paid: boolean;
+    /** Checkout URL — present when paid=false (customer must pay manually) */
+    checkoutUrl?: string;
+    /** The invoice */
+    invoice: Invoice;
+}
+/**
+ * billing.invoices() - List Invoices
+ */
+interface InvoicesParams {
+    /** Customer ID or email */
+    customer: string;
+}
+interface InvoicesResult {
+    /** Whether the request succeeded */
+    success: boolean;
+    /** List of invoices */
+    invoices: Invoice[];
+}
+/**
+ * addon() - Purchase Add-on Credit Pack
+ */
+interface AddonParams {
+    /** Customer ID or email */
+    customer: string;
+    /** Credit pack slug or ID */
+    pack: string;
+    /** Number of packs to buy (default: 1) */
+    quantity?: number;
+    /** Optional: Currency override */
+    currency?: string;
+    /** Optional: Redirect URL after checkout */
+    callbackUrl?: string;
+    /** Optional: Custom metadata */
+    metadata?: Record<string, unknown>;
+}
+interface AddonResult {
+    /** Whether the purchase succeeded immediately */
+    success: boolean;
+    /** Whether the customer needs to complete a checkout */
+    requiresCheckout: boolean;
+    /** Total credits added (only if immediate charge succeeded) */
+    credits?: number;
+    /** Updated scoped balance (only if immediate charge succeeded) */
+    balance?: number;
+    /** Credit system the credits were added to */
+    creditSystemId?: string;
+    /** Checkout URL (only if requiresCheckout is true) */
+    checkoutUrl?: string;
+    /** Payment reference */
+    reference?: string;
+    /** Human-readable message */
+    message?: string;
+}
+/**
+ * Shared types
+ */
+type PaymentChannel = "card" | "bank" | "bank_transfer" | "ussd" | "mobile_money" | "qr";
+type Currency = "NGN" | "GHS" | "ZAR" | "KES" | "USD" | "CAD" | "EUR" | "GBP" | "CHF" | "SEK" | "NOK" | "DKK" | "PLN" | "CZK" | "JPY" | "CNY" | "INR" | "SGD" | "HKD" | "AUD" | "NZD" | "BRL" | "MXN" | "ARS" | "COP" | "AED" | "SAR" | "EGP" | (string & {});
+type PlanInterval = "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
+type ResetInterval = "never" | "5min" | "15min" | "30min" | "hourly" | "daily" | "weekly" | "monthly" | "quarterly" | "yearly";
+type SubscriptionStatus = "active" | "canceled" | "expired" | "incomplete" | "incomplete_expired" | "past_due" | "trialing" | "unpaid";
+/**
+ * Plan and feature definitions
+ */
+interface Plan {
+    id: string;
+    name: string;
+    description?: string;
+    price: number;
+    currency: Currency;
+    interval: PlanInterval;
+    features: Record<string, FeatureLimit>;
+    metadata?: Record<string, unknown>;
+}
+interface FeatureLimit {
+    /** Usage limit (null = unlimited) */
+    limit: number | null;
+    /** Reset interval */
+    reset: ResetInterval;
+    /** Overage behavior */
+    overage?: "block" | "charge";
+    /** Overage price per unit */
+    overagePrice?: number;
+}
+interface Feature {
+    id: string;
+    name: string;
+    description?: string;
+    type: "metered" | "boolean" | "seats";
+    unit?: string;
+}
+/**
+ * Database models
+ */
+interface Customer {
+    id: string;
+    providerId?: string;
+    providerCustomerId?: string;
+    providerAuthorizationCode?: string;
+    providerMetadata?: Record<string, unknown>;
+    paystackCustomerId?: string;
+    paystackAuthorizationCode?: string;
+    email: string;
+    name?: string;
+    metadata?: Record<string, unknown>;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface Subscription {
+    id: string;
+    customerId: string;
+    providerId?: string;
+    providerSubscriptionId?: string;
+    providerSubscriptionCode?: string;
+    providerMetadata?: Record<string, unknown>;
+    paystackSubscriptionId?: string;
+    paystackSubscriptionCode?: string;
+    planId: string;
+    status: SubscriptionStatus;
+    currentPeriodStart: Date;
+    currentPeriodEnd: Date;
+    cancelAt?: Date;
+    metadata?: Record<string, unknown>;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface Entitlement {
+    id: string;
+    customerId: string;
+    featureId: string;
+    limit: number | null;
+    resetInterval: ResetInterval;
+    lastResetAt?: Date;
+    expiresAt?: Date;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface UsageRecord {
+    id: string;
+    customerId: string;
+    featureId: string;
+    amount: number;
+    periodStart: Date;
+    periodEnd: Date;
+    metadata?: Record<string, unknown>;
+    createdAt: Date;
+}
+/**
+ * Catalog Builder Types
+ * Used by metered(), boolean(), and plan() builder functions.
+ */
+/** Union of all catalog entries passed to OwostackConfig.catalog */
+type CatalogEntry = PlanDefinition | CreditSystemDefinition;
+/** Configuration for a metered feature within a plan */
+interface MeteredFeatureConfig {
+    /** Limit for this plan (null = unlimited) */
+    limit?: number | null;
+    /** Reset interval (default: "monthly") */
+    reset?: ResetInterval;
+    /** Overage behavior (default: "block") */
+    overage?: "block" | "charge";
+    /** Price per overage unit in minor currency units */
+    overagePrice?: number;
+    /** Max overage units per period */
+    maxOverageUnits?: number;
+    /** Billing units for overage */
+    billingUnits?: number;
+    /** Credit cost for credit systems */
+    creditCost?: number;
+    /** Whether feature is enabled (default: true) */
+    enabled?: boolean;
+}
+/** Configuration for a boolean feature within a plan */
+interface BooleanFeatureConfig {
+    /** Whether feature is included in this plan (default: true) */
+    enabled?: boolean;
+}
+/** A feature entry inside a plan's features array */
+interface PlanFeatureEntry {
+    /** @internal */
+    _type: "plan_feature";
+    /** Feature slug */
+    slug: string;
+    /** Feature type */
+    featureType: "metered" | "boolean";
+    /** Human-readable name (auto-generated from slug if omitted) */
+    name?: string;
+    /** Whether feature is included in this plan */
+    enabled: boolean;
+    /** Metered config (only for metered features) */
+    config?: MeteredFeatureConfig;
+}
+/** A plan definition in the catalog */
+interface PlanDefinition {
+    /** @internal */
+    _type: "plan";
+    /** Plan slug (used as unique identifier) */
+    slug: string;
+    /** Human-readable plan name */
+    name: string;
+    /** Plan description */
+    description?: string;
+    /** Price in minor currency units (e.g. kobo) */
+    price: number;
+    /** Currency code */
+    currency: Currency;
+    /** Billing interval */
+    interval: PlanInterval;
+    /** Features included in this plan */
+    features: PlanFeatureEntry[];
+    /** Plan group for upgrade/downgrade logic */
+    planGroup?: string;
+    /** Trial period in days */
+    trialDays?: number;
+    /** Provider for this plan (overrides default) */
+    provider?: string;
+    /** Custom metadata */
+    metadata?: Record<string, unknown>;
+}
+/** A feature entry within a credit system */
+interface CreditSystemFeatureEntry {
+    /** Feature slug */
+    feature: string;
+    /** Credit cost per unit of this feature */
+    creditCost: number;
+}
+/** A credit system definition in the catalog */
+interface CreditSystemDefinition {
+    /** @internal */
+    _type: "credit_system";
+    /** Credit system slug (used as unique identifier) */
+    slug: string;
+    /** Human-readable credit system name */
+    name: string;
+    /** Credit system description */
+    description?: string;
+    /** Features that consume credits from this system with their credit costs */
+    features: CreditSystemFeatureEntry[];
+}
+/**
+ * wallet() - Payment Methods
+ */
+interface CardInfo {
+    /** Card ID (payment method ID) */
+    id: string;
+    /** Last 4 digits */
+    last4: string;
+    /** Card brand (visa, mastercard, verve) */
+    brand: string;
+    /** Expiry as "MM/YY" */
+    exp: string;
+    /** Provider that captured this card */
+    provider: string;
+}
+interface PaymentMethodInfo {
+    /** Payment method ID */
+    id: string;
+    /** Type: card (Paystack/Stripe) or provider_managed (Dodo) */
+    type: "card" | "provider_managed";
+    /** Provider ID */
+    provider: string;
+    /** Whether this is the default payment method */
+    isDefault: boolean;
+    /** Whether the token is still valid for charging */
+    isValid: boolean;
+    /** Card details (null for provider_managed) */
+    card: CardInfo | null;
+}
+interface WalletResult {
+    /** Whether the customer has a chargeable payment method */
+    hasCard: boolean;
+    /** Default card details (shortcut for the default method's card) */
+    card: CardInfo | null;
+    /** All stored payment methods */
+    methods: PaymentMethodInfo[];
+}
+interface WalletSetupParams {
+    /** Customer ID or email */
+    customer: string;
+    /** Optional: Redirect URL after card setup */
+    callbackUrl?: string;
+    /** Optional: Override provider */
+    provider?: string;
+}
+interface WalletSetupResult {
+    /** Checkout URL to redirect user for card capture */
+    url: string;
+    /** Payment reference */
+    reference: string;
+}
+interface WalletRemoveResult {
+    /** Whether the removal succeeded */
+    success: boolean;
+}
+/**
+ * plans() - List Plans
+ */
+interface PlansParams {
+    /** Optional: Filter by plan group */
+    group?: string;
+    /** Optional: Filter by billing interval */
+    interval?: PlanInterval;
+    /** Optional: Filter by currency */
+    currency?: string;
+    /** Optional: Include inactive plans (default: false) */
+    includeInactive?: boolean;
+}
+/** A plan feature as returned by the public API */
+interface PublicPlanFeature {
+    /** Feature slug */
+    slug: string;
+    /** Human-readable feature name */
+    name: string;
+    /** Feature type */
+    type: "metered" | "boolean" | "static";
+    /** Whether this feature is enabled in this plan */
+    enabled: boolean;
+    /** Usage limit (null = unlimited) */
+    limit: number | null;
+    /** Reset interval */
+    resetInterval: string | null;
+    /** Unit label (e.g. "call", "message", "GB") */
+    unit: string | null;
+    /** Overage behavior */
+    overage?: "block" | "charge";
+    /** Overage price per unit in minor currency units */
+    overagePrice?: number | null;
+}
+/** A plan as returned by the public API — safe for client-side consumption */
+interface PublicPlan {
+    /** Plan ID */
+    id: string;
+    /** URL-safe slug */
+    slug: string;
+    /** Human-readable name */
+    name: string;
+    /** Description */
+    description: string | null;
+    /** Price in minor currency units */
+    price: number;
+    /** Currency code */
+    currency: string;
+    /** Billing interval */
+    interval: PlanInterval;
+    /** "free" or "paid" */
+    type: string;
+    /** Whether this is a recurring or one-time plan */
+    billingType: string;
+    /** Whether this is an add-on plan */
+    isAddon: boolean;
+    /** Plan group (for upgrade/downgrade) */
+    planGroup: string | null;
+    /** Trial period in days (0 = no trial) */
+    trialDays: number;
+    /** Features included in this plan */
+    features: PublicPlanFeature[];
+}
+interface PlansResult {
+    /** Whether the request succeeded */
+    success: boolean;
+    /** List of plans */
+    plans: PublicPlan[];
+}
+/** Serialized catalog sent to POST /api/sync */
+interface SyncPayload {
+    /** Optional: Default provider for all plans */
+    defaultProvider?: string;
+    features: Array<{
+        slug: string;
+        type: "metered" | "boolean";
+        name: string;
+    }>;
+    creditSystems: Array<{
+        slug: string;
+        name: string;
+        description?: string;
+        features: Array<{
+            feature: string;
+            creditCost: number;
+        }>;
+    }>;
+    plans: Array<{
+        slug: string;
+        name: string;
+        description?: string;
+        price: number;
+        currency: Currency;
+        interval: PlanInterval;
+        planGroup?: string;
+        trialDays?: number;
+        provider?: string;
+        metadata?: Record<string, unknown>;
+        features: Array<{
+            slug: string;
+            enabled: boolean;
+            limit?: number | null;
+            reset?: ResetInterval;
+            overage?: "block" | "charge";
+            overagePrice?: number;
+            maxOverageUnits?: number;
+            billingUnits?: number;
+            creditCost?: number;
+        }>;
+    }>;
+}
+/** Changes reported for a single resource type */
+interface SyncChanges {
+    created: string[];
+    updated: string[];
+    unchanged: string[];
+}
+/** Result returned by owo.sync() */
+interface SyncResult {
+    success: boolean;
+    features: SyncChanges;
+    creditSystems: SyncChanges;
+    plans: SyncChanges;
+    warnings: string[];
+}
+/**
+ * customer() - Create or resolve a customer
+ */
+interface CustomerParams {
+    /** Customer ID (optional - auto-generated if not provided) */
+    id?: string;
+    /** Customer email (required) */
+    email: string;
+    /** Customer display name */
+    name?: string;
+    /** Custom metadata */
+    metadata?: Record<string, unknown>;
+}
+interface CustomerResult {
+    /** Customer ID */
+    id: string;
+    /** Customer email */
+    email: string;
+    /** Customer display name */
+    name?: string;
+    /** Custom metadata */
+    metadata?: Record<string, unknown>;
+    /** ISO timestamp when created */
+    createdAt: string;
+    /** ISO timestamp when last updated */
+    updatedAt: string;
+}
+/**
+ * addEntity() - Add a feature entity (e.g., seat)
+ */
+interface AddEntityParams {
+    /** Customer ID or email */
+    customer: string;
+    /** Feature slug that this entity consumes (e.g., "seats") */
+    feature: string;
+    /** Entity ID (unique per feature) */
+    entity: string;
+    /** Display name for the entity */
+    name?: string;
+    /** Email for the entity */
+    email?: string;
+    /** Custom metadata */
+    metadata?: Record<string, unknown>;
+}
+interface AddEntityResult {
+    /** Whether the entity was created successfully */
+    success: boolean;
+    /** The entity ID */
+    entityId: string;
+    /** The feature slug */
+    featureId: string;
+    /** Current count of entities for this feature */
+    count: number;
+    /** Limit for this feature (null = unlimited) */
+    limit: number | null;
+    /** Remaining slots (null = unlimited) */
+    remaining: number | null;
+}
+/**
+ * removeEntity() - Remove a feature entity
+ */
+interface RemoveEntityParams {
+    /** Customer ID or email */
+    customer: string;
+    /** Feature slug */
+    feature: string;
+    /** Entity ID to remove */
+    entity: string;
+}
+interface RemoveEntityResult {
+    /** Whether the entity was removed successfully */
+    success: boolean;
+    /** The entity ID that was removed */
+    entityId: string;
+    /** Current count of entities for this feature after removal */
+    count: number;
+}
+/**
+ * listEntities() - List feature entities
+ */
+interface ListEntitiesParams {
+    /** Customer ID or email */
+    customer: string;
+    /** Feature slug (optional - lists all entities if not provided) */
+    feature?: string;
+}
+interface Entity {
+    /** Entity ID */
+    id: string;
+    /** Feature slug */
+    featureId: string;
+    /** Display name */
+    name?: string;
+    /** Email */
+    email?: string;
+    /** Custom metadata */
+    metadata?: Record<string, unknown>;
+    /** Entity status */
+    status: "active" | "pending_removal";
+    /** ISO timestamp when created */
+    createdAt: string;
+}
+interface ListEntitiesResult {
+    /** Whether the request succeeded */
+    success: boolean;
+    /** List of entities */
+    entities: Entity[];
+    /** Total count */
+    total: number;
+}
+
+export type { AddEntityParams, AddEntityResult, AddonParams, AddonResult, AttachParams, AttachResult, BillingFeatureUsage, BillingUsageParams, BillingUsageResult, BooleanFeatureConfig, CardInfo, CatalogEntry, CheckCode, CheckParams, CheckResult, CreditSystemDefinition, CreditSystemFeatureEntry, Currency, Customer, CustomerData, CustomerParams, CustomerResult, Entitlement, Entity, Feature, FeatureLimit, Invoice, InvoiceLineItem, InvoiceParams, InvoiceResult, InvoicesParams, InvoicesResult, ListEntitiesParams, ListEntitiesResult, MeteredFeatureConfig, OverageDetails, OwostackConfig, PayInvoiceParams, PayInvoiceResult, PaymentChannel, PaymentMethodInfo, Plan, PlanCredits, PlanDefinition, PlanFeatureEntry, PlanInterval, PlansParams, PlansResult, PublicPlan, PublicPlanFeature, RemoveEntityParams, RemoveEntityResult, ResetInterval, ResponseDetails, Subscription, SubscriptionStatus, SyncChanges, SyncPayload, SyncResult, TrackCode, TrackParams, TrackResult, UsageRecord, WalletRemoveResult, WalletResult, WalletSetupParams, WalletSetupResult };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@owostack/types",
+  "version": "0.1.0",
+  "description": "Shared TypeScript types for Owostack",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Abdulmumin1/owostack.git",
+    "directory": "packages/types"
+  },
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "dev": "tsup src/index.ts --format esm --dts --watch"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}