@sneat/extension-splitus-contract 0.0.1 → 0.2.0

package/fesm2022/sneat-extension-splitus-contract.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"sneat-extension-splitus-contract.mjs","sources":["../../../../../../libs/extensions/splitus/contract/src/lib/services/splitus-service.ts","../../../../../../libs/extensions/splitus/contract/src/sneat-extension-splitus-contract.ts"],"sourcesContent":["import { InjectionToken } from '@angular/core';\nimport { Observable } from 'rxjs';\n\nexport type CurrencyCode = 'EUR' | 'USD';\n\nexport interface ICreateSplitRecordRequest {\n  spaceID: string;\n  contactID: string;\n  currency: CurrencyCode;\n  amount: number;\n}\n\n// ISplitusService is the runtime-light contract the splitus components depend on.\n// Members mirror the concrete SplitusService's public surface exactly; the\n// implementation lives in the -internal lib and is provided via the\n// SPLITUS_SERVICE token below.\nexport interface ISplitusService {\n  createSplitRecord(request: ICreateSplitRecordRequest): Observable<string>;\n}\n\nexport const SPLITUS_SERVICE = new InjectionToken<ISplitusService>('SplitusService');\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;MAoBa,eAAe,GAAG,IAAI,cAAc,CAAkB,gBAAgB;;ACpBnF;;AAEG;;;;"}
+{"version":3,"file":"sneat-extension-splitus-contract.mjs","sources":["../../../../../../libs/extensions/splitus/contract/src/lib/services/splitus-service.ts","../../../../../../libs/extensions/splitus/contract/src/sneat-extension-splitus-contract.ts"],"sourcesContent":["import { InjectionToken } from '@angular/core';\nimport { Observable } from 'rxjs';\nimport type {\n  ICreateSplitRequest,\n  ICreateSplitResponse,\n  ISplit,\n  ISplitListItem,\n} from '../models/splitus-models';\n\nexport type CurrencyCode = 'EUR' | 'USD';\n\n// ISplitusService is the runtime-light contract the splitus components\n// depend on. Members mirror the concrete SplitusService's public surface\n// exactly; the implementation lives in the -internal lib and is provided via\n// the SPLITUS_SERVICE token below.\n//\n// Splitus persists no balance of its own — the payer/participants/shares\n// given to createSplit are posted to the real backend (POST\n// /api4splitus/create-split), which records the expense and posts Debtus\n// transfers as the only who-owes-what records. getSplit/getSplits read the\n// settled state back verbatim from that same API — there is no client-side\n// settled cache (see ISplitParticipant.status in splitus-models.ts).\nexport interface ISplitusService {\n  /** REAL: POST /api4splitus/create-split. Payer is the authenticated user. */\n  createSplit(request: ICreateSplitRequest): Observable<ICreateSplitResponse>;\n\n  /** REAL: GET /api4splitus/split?spaceID=&id= */\n  getSplit(spaceID: string, id: string): Observable<ISplit>;\n\n  /** REAL: GET /api4splitus/splits?spaceID= */\n  getSplits(spaceID: string): Observable<ISplitListItem[]>;\n}\n\nexport const SPLITUS_SERVICE = new InjectionToken<ISplitusService>('SplitusService');\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;MAiCa,eAAe,GAAG,IAAI,cAAc,CAAkB,gBAAgB;;ACjCnF;;AAEG;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sneat/extension-splitus-contract",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "peerDependencies": {
     "@angular/core": "^21.0.0",
     "rxjs": "^7.0.0"

package/types/sneat-extension-splitus-contract.d.ts

@@ -1,17 +1,89 @@
 import { InjectionToken } from '@angular/core';
 import { Observable } from 'rxjs';
 
-type CurrencyCode = 'EUR' | 'USD';
-interface ICreateSplitRecordRequest {
-    spaceID: string;
-    contactID: string;
-    currency: CurrencyCode;
-    amount: number;
+/** Mirrors models4splitus.SplitMode (backend/splitus/models4splitus). */
+type SplitMode = 'equally' | 'exact-amount' | 'percentage';
+/**
+ * One participant's custom share for `exact-amount` / `percentage` split
+ * modes. An omitted/empty `contactID` denotes the payer's own share. Ignored
+ * (and may be omitted) for `equally`, which the backend computes itself.
+ */
+interface ISplitShare {
+    readonly contactID?: string;
+    /** Decimal string, e.g. "35.00" — required for `exact-amount`. */
+    readonly amount?: string;
+    /** Decimal string, e.g. "33.34" — required for `percentage`. */
+    readonly percent?: string;
+}
+interface ICreateSplitRequest {
+    readonly spaceID: string;
+    readonly title?: string;
+    readonly currency: CurrencyCode;
+    /** Decimal string, e.g. "90.00" — the total expense. */
+    readonly amount: string;
+    /** Defaults to `equally` server-side when omitted. */
+    readonly splitMode?: SplitMode;
+    /**
+     * contactus contact IDs of the space. The payer (the authenticated user)
+     * is always a participant and must NOT be listed here.
+     */
+    readonly participantContactIDs: string[];
+    /** Required for `exact-amount` / `percentage`; ignored for `equally`. */
+    readonly shares?: ISplitShare[];
+}
+interface ICreateSplitTransfer {
+    readonly id: string;
+    readonly contactID: string;
+    readonly amount: number;
+}
+interface ICreateSplitResponse {
+    readonly id: string;
+    /**
+     * The Debtus transfers holding the balances — the only who-owes-what
+     * records for this split. Splitus itself persists no balance.
+     */
+    readonly transfers: ICreateSplitTransfer[];
+}
+/**
+ * "settled" or "outstanding", derived server-side by reading the linked
+ * Debtus transfers — never computed or cached on the client.
+ */
+type SplitShareStatus = 'settled' | 'outstanding';
+interface ISplitParticipant {
+    readonly contactID?: string;
+    readonly userID?: string;
+    readonly name: string;
+    readonly share: number;
+    readonly isPayer?: boolean;
+    readonly status: SplitShareStatus;
 }
+interface ISplit {
+    readonly id: string;
+    readonly title?: string;
+    readonly currency: CurrencyCode;
+    readonly amount: number;
+    readonly status: string;
+    readonly participants: ISplitParticipant[];
+}
+interface ISplitListItem {
+    readonly id: string;
+    readonly title?: string;
+    readonly amount: number;
+    readonly currency: CurrencyCode;
+    readonly status: string;
+    readonly membersCount: number;
+}
+
+type CurrencyCode = 'EUR' | 'USD';
 interface ISplitusService {
-    createSplitRecord(request: ICreateSplitRecordRequest): Observable<string>;
+    /** REAL: POST /api4splitus/create-split. Payer is the authenticated user. */
+    createSplit(request: ICreateSplitRequest): Observable<ICreateSplitResponse>;
+    /** REAL: GET /api4splitus/split?spaceID=&id= */
+    getSplit(spaceID: string, id: string): Observable<ISplit>;
+    /** REAL: GET /api4splitus/splits?spaceID= */
+    getSplits(spaceID: string): Observable<ISplitListItem[]>;
 }
 declare const SPLITUS_SERVICE: InjectionToken<ISplitusService>;
 
 export { SPLITUS_SERVICE };
-export type { CurrencyCode, ICreateSplitRecordRequest, ISplitusService };
+export type { CurrencyCode, ICreateSplitRequest, ICreateSplitResponse, ICreateSplitTransfer, ISplit, ISplitListItem, ISplitParticipant, ISplitShare, ISplitusService, SplitMode, SplitShareStatus };