@doow/track 0.1.4 → 0.1.10

package/dist/types/index.d.ts

@@ -220,5 +220,371 @@ declare class FileOfflineStore implements OfflineStore {
     get directory(): string;
 }
 
-export { DoowTracker, FileOfflineStore };
-export type { BatchPayload, CustomTransport, DoowTrackerOptions, OfflineStore, PartialAcceptResponse, RateLimit, SdkError, SdkErrorKind, SerializedBatch, SerializedEvent, TrackEvent, TransportPayload, TransportResponse };
+/**
+ * Types for SDK Management API (CRUD operations for apps, contracts, licenses, metrics)
+ */
+interface PaginationParams {
+    cursor?: string;
+    limit?: number;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    cursor?: string;
+    has_more: boolean;
+}
+interface CreateAppInput {
+    name: string;
+    description?: string;
+    website?: string;
+    logo_url?: string;
+    categories?: string[];
+}
+interface UpdateAppInput {
+    name?: string;
+    description?: string;
+    website?: string;
+    logo_url?: string;
+    categories?: string[];
+}
+interface App {
+    id: string;
+    name: string;
+    description?: string;
+    website?: string;
+    logo_url?: string;
+    categories?: string[];
+    saas_application_id: string;
+    created_at: string;
+    updated_at: string;
+}
+interface ListAppsParams extends PaginationParams {
+    name?: string;
+}
+type ContractType = 'PAY_AS_YOU_GO' | 'ENTERPRISE' | 'UNKNOWN';
+type CostAmortization = 'PRORATA' | 'MONTHS' | 'QUARTER' | 'YEARS';
+interface Expense {
+    id: string;
+    app_id: string | null;
+    contract_id: string | null;
+    license_id: string | null;
+    total: number;
+    date: string;
+    month: number;
+    year: number;
+    description: string | null;
+    transaction_id: string | null;
+    vendor: string | null;
+    payment_channel: string | null;
+    created_at: string;
+    updated_at: string | null;
+}
+interface ListExpensesParams extends PaginationParams {
+    app_id?: string;
+    contract_id?: string;
+    year?: number;
+    month?: number;
+}
+/**
+ * Input for creating a license inline with a contract.
+ *
+ * SDK only supports USAGE_BASED licenses — SEAT_BASED must be created via UI.
+ * total_cost is optional (calculated from usage metrics).
+ */
+interface LicenseInput {
+    name: string;
+    /** Defaults to USAGE_BASED. SDK only supports USAGE_BASED. */
+    license_type?: LicenseType;
+    seats?: number;
+    price_per_seat?: number;
+    total_cost?: number;
+    discount?: Record<string, unknown>;
+    discount_amount?: number;
+    discounted_cost?: number;
+    original_cost?: number;
+    tenure?: number;
+    seats_included_in_base_plan?: number;
+}
+/**
+ * License in contract response. Uses AllLicenseType since responses may include
+ * UI-created SEAT_BASED licenses.
+ */
+interface LicenseInContract {
+    id: string;
+    name: string;
+    license_type: AllLicenseType;
+    seats?: number;
+    price_per_seat?: number;
+    total_cost?: number;
+    discount?: Record<string, unknown>;
+    discount_amount?: number;
+    discounted_cost?: number;
+    original_cost?: number;
+    tenure?: number;
+    seats_included_in_base_plan?: number;
+}
+interface CreateContractInput {
+    title?: string;
+    contract_type?: ContractType;
+    start_date?: string;
+    end_date?: string;
+    currency?: string;
+    cost?: number;
+    cost_break_down?: Record<string, unknown>;
+    cost_amortization?: CostAmortization;
+    add_ons?: Record<string, unknown>;
+    add_ons_total_cost?: number;
+    total_contract_cost?: number;
+    total_discount_amount?: number;
+    total_original_cost?: number;
+    licenses: LicenseInput[];
+    expense_ids?: string[];
+}
+interface UpdateContractInput {
+    title?: string;
+    contract_type?: ContractType;
+    start_date?: string;
+    end_date?: string;
+    currency?: string;
+    cost?: number;
+    cost_break_down?: Record<string, unknown>;
+    cost_amortization?: CostAmortization;
+    add_ons?: Record<string, unknown>;
+    add_ons_total_cost?: number;
+    total_contract_cost?: number;
+    total_discount_amount?: number;
+    total_original_cost?: number;
+}
+interface Contract {
+    id: string;
+    app_id: string;
+    title: string;
+    contract_type: ContractType;
+    start_date?: string;
+    end_date?: string;
+    currency?: string;
+    cost?: number;
+    cost_break_down?: Record<string, unknown>;
+    cost_amortization?: CostAmortization;
+    add_ons?: Record<string, unknown>;
+    add_ons_total_cost?: number;
+    total_contract_cost?: number;
+    total_discount_amount?: number;
+    total_original_cost?: number;
+    licenses?: LicenseInContract[];
+    expenses?: Expense[];
+    created_at: string;
+    updated_at: string;
+}
+interface ListContractsParams extends PaginationParams {
+    contract_type?: ContractType;
+}
+/**
+ * License types for SDK creation. SDK only supports USAGE_BASED.
+ * SEAT_BASED licenses must be created via the UI.
+ */
+type LicenseType = 'USAGE_BASED';
+/**
+ * All license types (for responses that may include UI-created licenses)
+ */
+type AllLicenseType = 'USAGE_BASED' | 'SEAT_BASED' | 'PREPAID_CREDITS' | 'FLAT_RATE';
+interface CreateLicenseInput {
+    name: string;
+    license_type?: LicenseType;
+    seats?: number;
+    price_per_seat?: number;
+    total_cost?: number;
+    discount?: Record<string, unknown>;
+    discount_amount?: number;
+    discounted_cost?: number;
+    original_cost?: number;
+    tenure?: number;
+    seats_included_in_base_plan?: number;
+}
+interface UpdateLicenseInput {
+    name?: string;
+    license_type?: LicenseType;
+    seats?: number;
+    price_per_seat?: number;
+    total_cost?: number;
+    discount?: Record<string, unknown>;
+    discount_amount?: number;
+    discounted_cost?: number;
+    original_cost?: number;
+    tenure?: number;
+    seats_included_in_base_plan?: number;
+}
+/**
+ * License response. Uses AllLicenseType since responses may include
+ * UI-created SEAT_BASED licenses.
+ */
+interface License {
+    id: string;
+    contract_id: string;
+    name: string;
+    license_type: AllLicenseType;
+    seats?: number;
+    price_per_seat?: number;
+    total_cost?: number;
+    discount?: Record<string, unknown>;
+    discount_amount?: number;
+    discounted_cost?: number;
+    original_cost?: number;
+    tenure?: number;
+    seats_included_in_base_plan?: number;
+}
+interface ListLicensesParams extends PaginationParams {
+    license_type?: AllLicenseType;
+}
+type UsageAggregationType = 'SUM' | 'MAX' | 'CUMULATIVE';
+type RateKind = 'PER_UNIT' | 'FLAT_FEE' | 'PER_SEAT' | 'TIERED' | 'VOLUME';
+type EntitlementPeriod = 'MONTHLY' | 'YEARLY' | 'QUARTERLY' | 'WEEKLY' | 'DAILY' | 'ONE_TIME';
+type CarryoverPolicy = 'EXPIRE_AT_PERIOD_END' | 'ROLLOVER' | 'ROLLOVER_CAPPED';
+interface CreateMetricInput {
+    metric_type: string;
+    usage_aggregation_type?: UsageAggregationType;
+    rate_kind?: RateKind;
+    entitlement_period?: EntitlementPeriod;
+    carryover_policy?: CarryoverPolicy;
+    usage_rate?: number;
+    usage_limit?: number;
+    usage_included?: number;
+    per_unit_cap?: number;
+    usage_rate_is_estimated?: boolean;
+    usage_custom_unit_label?: string;
+    expected_emission_interval_minutes?: number;
+}
+interface UpdateMetricInput {
+    metric_type?: string;
+    usage_aggregation_type?: UsageAggregationType;
+    rate_kind?: RateKind;
+    entitlement_period?: EntitlementPeriod;
+    carryover_policy?: CarryoverPolicy;
+    usage_rate?: number;
+    usage_limit?: number;
+    usage_included?: number;
+    per_unit_cap?: number;
+    usage_rate_is_estimated?: boolean;
+    usage_custom_unit_label?: string;
+    expected_emission_interval_minutes?: number;
+}
+interface Metric {
+    id: string;
+    license_id: string;
+    metric_type: string;
+    usage_aggregation_type: UsageAggregationType;
+    rate_kind: RateKind;
+    entitlement_period: EntitlementPeriod;
+    carryover_policy: CarryoverPolicy;
+    usage_rate?: number;
+    usage_limit?: number;
+    usage_included?: number;
+    per_unit_cap?: number;
+    usage_rate_is_estimated?: boolean;
+    usage_custom_unit_label?: string;
+    expected_emission_interval_minutes?: number;
+    created_at: string;
+    updated_at: string;
+}
+interface ListMetricsParams extends PaginationParams {
+    metric_type?: string;
+}
+interface DoowManagementOptions {
+    /** Server endpoint. Default: https://api.doow.co */
+    endpoint?: string;
+    /** Request timeout in ms. Default: 30000 */
+    timeout?: number;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+interface ApiError {
+    status: number;
+    message: string;
+    code?: string;
+    details?: Record<string, unknown>;
+}
+
+/**
+ * DoowManagement — CRUD operations for apps, contracts, licenses, and metrics
+ *
+ * Usage:
+ *   import { DoowManagement } from '@doow/track';
+ *   const mgmt = new DoowManagement('dk_your_api_key');
+ *
+ *   // Create an app
+ *   const app = await mgmt.apps.create({ name: 'My SaaS' });
+ *
+ *   // Create a contract under the app
+ *   const contract = await mgmt.contracts.create(app.id, { title: 'Enterprise Plan' });
+ *
+ *   // Create a license under the contract
+ *   const license = await mgmt.licenses.create(contract.id, { name: 'API Usage' });
+ *
+ *   // Create a metric under the license
+ *   const metric = await mgmt.metrics.create(license.id, { metric_type: 'api_calls' });
+ */
+
+declare class ManagementApiError extends Error {
+    readonly status: number;
+    readonly code?: string | undefined;
+    readonly details?: Record<string, unknown> | undefined;
+    constructor(error: ApiError);
+}
+declare class DoowManagement {
+    private readonly _apiKey;
+    private readonly _endpoint;
+    private readonly _timeout;
+    private readonly _debug;
+    readonly apps: AppsClient;
+    readonly contracts: ContractsClient;
+    readonly licenses: LicensesClient;
+    readonly metrics: MetricsClient;
+    readonly expenses: ExpensesClient;
+    constructor(apiKey: string, options?: DoowManagementOptions);
+    private log;
+    request<T>(method: string, path: string, body?: Record<string, unknown>, query?: Record<string, string | number | undefined>): Promise<T>;
+}
+declare class AppsClient {
+    private readonly mgmt;
+    constructor(mgmt: DoowManagement);
+    create(input: CreateAppInput): Promise<App>;
+    list(params?: ListAppsParams): Promise<PaginatedResponse<App>>;
+    get(id: string): Promise<App>;
+    update(id: string, input: UpdateAppInput): Promise<App>;
+    delete(id: string): Promise<void>;
+}
+declare class ContractsClient {
+    private readonly mgmt;
+    constructor(mgmt: DoowManagement);
+    create(appId: string, input: CreateContractInput): Promise<Contract>;
+    listByApp(appId: string, params?: ListContractsParams): Promise<PaginatedResponse<Contract>>;
+    get(id: string): Promise<Contract>;
+    update(id: string, input: UpdateContractInput): Promise<Contract>;
+    delete(id: string): Promise<void>;
+}
+declare class LicensesClient {
+    private readonly mgmt;
+    constructor(mgmt: DoowManagement);
+    create(contractId: string, input: CreateLicenseInput): Promise<License>;
+    listByContract(contractId: string, params?: ListLicensesParams): Promise<PaginatedResponse<License>>;
+    get(id: string): Promise<License>;
+    update(id: string, input: UpdateLicenseInput): Promise<License>;
+    delete(id: string): Promise<void>;
+}
+declare class MetricsClient {
+    private readonly mgmt;
+    constructor(mgmt: DoowManagement);
+    create(licenseId: string, input: CreateMetricInput): Promise<Metric>;
+    listByLicense(licenseId: string, params?: ListMetricsParams): Promise<PaginatedResponse<Metric>>;
+    get(id: string): Promise<Metric>;
+    update(id: string, input: UpdateMetricInput): Promise<Metric>;
+    delete(id: string): Promise<void>;
+}
+declare class ExpensesClient {
+    private readonly mgmt;
+    constructor(mgmt: DoowManagement);
+    list(params?: ListExpensesParams): Promise<PaginatedResponse<Expense>>;
+    get(id: string): Promise<Expense>;
+}
+
+export { DoowManagement, DoowTracker, FileOfflineStore, ManagementApiError };
+export type { ApiError, App, BatchPayload, CarryoverPolicy, Contract, ContractType, CostAmortization, CreateAppInput, CreateContractInput, CreateLicenseInput, CreateMetricInput, CustomTransport, DoowManagementOptions, DoowTrackerOptions, EntitlementPeriod, Expense, License, LicenseInContract, LicenseInput, LicenseType, ListAppsParams, ListContractsParams, ListExpensesParams, ListLicensesParams, ListMetricsParams, Metric, OfflineStore, PaginatedResponse, PaginationParams, PartialAcceptResponse, RateKind, RateLimit, SdkError, SdkErrorKind, SerializedBatch, SerializedEvent, TrackEvent, TransportPayload, TransportResponse, UpdateAppInput, UpdateContractInput, UpdateLicenseInput, UpdateMetricInput, UsageAggregationType };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@doow/track",
-  "version": "0.1.4",
+  "version": "0.1.10",
   "description": "Customer-facing SDK for emitting usage telemetry to Doow",
   "license": "MIT",
   "author": "Doow",