@sneat/extension-budgetus-contract 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,7 @@
+# @sneat/extension-budgetus-contract
+
+Budgetus extension contract library.
+
+## Provenance
+
+Migrated from sneat-co/budgetus (npm continuity from @sneat/extension-budgetus-contract@0.1.0).

package/fesm2022/sneat-extension-budgetus-contract.mjs

@@ -1,9 +1,6 @@
 import { InjectionToken } from '@angular/core';
 
-var ListPage;
-(function (ListPage) {
-    ListPage["list"] = "list";
-})(ListPage || (ListPage = {}));
+const BUDGETUS_SERVICE = new InjectionToken('BudgetusService');
 
 class ListItemInfoModel {
     static trackBy = (index, item) => !item
@@ -26,6 +23,12 @@ class ListItemModel {
         });
     }
 }
+
+var ListPage;
+(function (ListPage) {
+    ListPage["list"] = "list";
+})(ListPage || (ListPage = {}));
+
 function getListShortUrlId(communeId, shortId, id) {
     if (shortId) {
         return `${communeId}-${shortId}`;
@@ -64,51 +67,9 @@ function createListInfoFromDto(dto, shortId) {
     }
     return listInfo;
 }
-// export function createListItemInfoFromListInfo(listInfo: IListInfo): IListItemBrief {
-// 	return {
-// 		id: listInfo.id || '',
-// 		title: listInfo.title || '',
-// 		subListType: listInfo.type,
-// 		subListId: listInfo.id || `${listInfo.team && listInfo.team.id}-${listInfo.shortId}`,
-// 		emoji: listInfo.emoji,
-// 		img: listInfo.img,
-// 	};
-// }
-// export function createListItemInfo(listItem: IListItemDto): IListItemBrief {
-// 	const v: IListItemBrief = {
-// 		id: listItem.id,
-// 		title: listItem.title,
-// 	};
-// 	if (listItem.emoji) {
-// 		v.emoji = listItem.emoji;
-// 	}
-// 	if (listItem.done) {
-// 		v.done = true;
-// 	}
-// 	return v;
-// }
-
-// Budget tab read-model types (see backstage roadmap:
-// docs/roadmaps/budget-tab-mvp.md, Section 3 "Data model").
-//
-// IBudgetLineItem is a COMPUTED projection, not a persisted record: it is
-// derived from Assetus asset renewals + Calendarius happenings and re-derived
-// on every read. Only per-line overrides (targetAmount / isSurprise) are
-// persisted (see IBudgetOverridePatch below + the overrides store in
-// @sneat/extension-budgetus).
 function monthISOOf(dateISO) {
     return dateISO.slice(0, 7);
 }
-// Surprise-hiding (Surpriseless mechanic — budget-tab-mvp.md Section 1 and
-// Open Question 5). A gift line item flagged `isSurprise` must not reveal its
-// real title to the person it is a surprise for.
-//
-// This prototype has no recipient-linking yet (Open Question 1 in the plan is
-// still unresolved — there's no "this gift is for user X" edge to compare
-// against the current viewer), so for now it masks every `isSurprise` line
-// uniformly rather than per-viewer. `reveal: true` is a demo-only escape hatch
-// the Budget page uses so a reviewer/owner can see the underlying data
-// without needing a second signed-in user.
 function maskSurpriseLineItems(items, options) {
     if (options?.reveal) {
         return items;
@@ -118,8 +79,6 @@ function maskSurpriseLineItems(items, options) {
         : item);
 }
 
-const BUDGETUS_SERVICE = new InjectionToken('BudgetusService');
-
 /**
  * Generated bundle index. Do not edit.
  */

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

@@ -1 +1 @@
-{"version":3,"file":"sneat-extension-budgetus-contract.mjs","sources":["../../../../../../libs/extensions/budgetus/contract/src/constants.ts","../../../../../../libs/extensions/budgetus/contract/src/dto/list.ts","../../../../../../libs/extensions/budgetus/contract/src/dto/budget.ts","../../../../../../libs/extensions/budgetus/contract/src/services/budgetus-service.ts","../../../../../../libs/extensions/budgetus/contract/src/sneat-extension-budgetus-contract.ts"],"sourcesContent":["import { EnumAsUnionOfKeys } from '@sneat/core';\n\nexport const enum ListPage {\n  list = 'list',\n}\n\nexport type ListPages = EnumAsUnionOfKeys<typeof ListPage>;\n","import { IRecord } from '@sneat/data';\nimport {\n  IShortSpaceInfo,\n  IWithCreated,\n  IWithRestrictions,\n  IWithSpaceIDs,\n  SneatRecordStatus,\n} from '@sneat/dto';\n\nexport type ListStatus = SneatRecordStatus;\n\nexport interface IQuantity {\n  value: number;\n  unit: string;\n}\n\nexport interface IListItemCommon extends IListCommon {\n  subListId?: string;\n  subListType?: ListType;\n  quantity?: IQuantity;\n  category?: string;\n}\n\nexport type IListItemBase = IListItemCommon;\n\nexport type ListItemStatus = 'done' | 'active';\n\nexport interface IListItemBrief extends IListItemBase {\n  id: string;\n  readonly created?: string; // UTC datetime\n  readonly emoji?: string;\n  readonly status?: ListItemStatus;\n  readonly img?: string;\n}\n\nexport interface ListCounts {\n  // TODO: Use some enumerator as IDB library does.\n  active?: number;\n  completed?: number;\n}\n\nexport type ListType =\n  | 'buy'\n  | 'watch'\n  | 'cook'\n  | 'do'\n  | 'other'\n  | 'recipes'\n  | 'rsvp';\n\n// IListCommon is a common base class for a List & ListItem\nexport interface IListCommon {\n  // Do not extend from IWithCreated as it is not applicable for ICreateListItemRequest\n  title: string;\n  img?: string;\n  emoji?: string;\n  isDone?: boolean;\n}\n\nexport interface IListBase extends IListCommon, IWithSpaceIDs {\n  type: ListType;\n  shortId?: string;\n  status?: ListStatus;\n}\n\nexport interface IListDbo extends IListBase, IWithRestrictions, IWithCreated {\n  dtClosed?: number;\n  note?: string; // Is used for example for recipe text\n  numberOf?: ListCounts;\n  items?: IListItemBrief[];\n  commune?: IShortSpaceInfo; // Used just for in-memory columns?\n}\n\nexport class ListItemInfoModel {\n  static trackBy: (\n    index: number,\n    item: IListItemBrief,\n  ) => string | number | undefined = (index, item) =>\n    !item\n      ? index\n      : (!!item.id && `id:${item.id}`) ||\n        (item.subListId && `subList:${item.subListId}`) ||\n        item.title;\n}\n\nexport class ListItemModel {\n  static equalListItems(...items: IListItemBrief[]): boolean {\n    const { id, title, subListId, category, subListType } = items[0];\n    return !items.some((item) => {\n      if (id) {\n        return item.id !== id;\n      }\n      return (\n        (!!title && item.title !== title) ||\n        (!!subListId && item.subListId !== subListId) ||\n        (!!category && item.category !== category) ||\n        (!!subListType && item.subListType !== subListType)\n      );\n    });\n  }\n}\n\nexport interface IListItemDbo extends IListBase, IListItemCommon {\n  listId?: string;\n  score?: number;\n  subListItems?: IListItemBrief[];\n}\n\nexport function getListShortUrlId(\n  communeId: string,\n  shortId?: string,\n  id?: string,\n): string | undefined {\n  if (shortId) {\n    return `${communeId}-${shortId}`;\n  }\n  if (id) {\n    return id;\n  }\n  return undefined;\n}\n\nexport interface IListInfo extends IWithRestrictions {\n  parentListId?: string;\n  parentListType?: ListType;\n  type: ListType;\n  id?: string;\n  shortId?: string;\n  title?: string;\n  hidden?: boolean;\n  space?: IShortSpaceInfo;\n  emoji?: string;\n  img?: string;\n  note?: string;\n  itemsCount?: number;\n}\n\nexport interface IListBrief extends IListBase, IWithCreated {\n  emoji?: string;\n}\n\nexport function isListInfoMatchesListDto(\n  i: IListInfo,\n  l: IRecord<IListDbo>,\n): boolean {\n  return (\n    (!!i.id && i.id === l.id) ||\n    (i.type === l.dbo?.type && !!i.shortId && i.shortId === l.dbo?.shortId)\n  );\n}\n\nexport function createListInfoFromDto(\n  dto: IListDbo,\n  shortId?: string,\n): IListInfo {\n  if (!dto.title) {\n    throw new Error('!title');\n  }\n  const listInfo: IListInfo = {\n    type: dto.type,\n    title: dto.title,\n  };\n  if (shortId) {\n    listInfo.shortId = shortId;\n  }\n  if (dto.items && dto.items.length) {\n    listInfo.itemsCount = dto.items.length;\n  }\n  if (dto.emoji) {\n    listInfo.emoji = dto.emoji;\n  }\n  if (dto.restrictions) {\n    listInfo.restrictions = dto.restrictions;\n  }\n  if (dto.commune) {\n    listInfo.space = dto.commune;\n  }\n  return listInfo;\n}\n\n// export function createListItemInfoFromListInfo(listInfo: IListInfo): IListItemBrief {\n// \treturn {\n// \t\tid: listInfo.id || '',\n// \t\ttitle: listInfo.title || '',\n// \t\tsubListType: listInfo.type,\n// \t\tsubListId: listInfo.id || `${listInfo.team && listInfo.team.id}-${listInfo.shortId}`,\n// \t\temoji: listInfo.emoji,\n// \t\timg: listInfo.img,\n// \t};\n// }\n\n// export function createListItemInfo(listItem: IListItemDto): IListItemBrief {\n// \tconst v: IListItemBrief = {\n// \t\tid: listItem.id,\n// \t\ttitle: listItem.title,\n// \t};\n// \tif (listItem.emoji) {\n// \t\tv.emoji = listItem.emoji;\n// \t}\n// \tif (listItem.done) {\n// \t\tv.done = true;\n// \t}\n// \treturn v;\n// }\n","// Budget tab read-model types (see backstage roadmap:\n// docs/roadmaps/budget-tab-mvp.md, Section 3 \"Data model\").\n//\n// IBudgetLineItem is a COMPUTED projection, not a persisted record: it is\n// derived from Assetus asset renewals + Calendarius happenings and re-derived\n// on every read. Only per-line overrides (targetAmount / isSurprise) are\n// persisted (see IBudgetOverridePatch below + the overrides store in\n// @sneat/extension-budgetus).\n\nexport interface IMoney {\n  currency: string;\n  value: number;\n}\n\n// Where a budget line item was derived from. 'gift' is a specialisation of\n// 'happening' — a yearly happening (birthday/anniversary) tagged as a gift\n// occasion, which is the flagship Surpriseless scenario.\nexport type BudgetLineSource = 'asset-renewal' | 'happening' | 'gift';\n\nexport interface IBudgetLineItem {\n  id: string;\n  title: string;\n  dateISO: string; // ISO date (yyyy-mm-dd) of the next occurrence/due date\n  amount: IMoney;\n  source: BudgetLineSource;\n  sourceRef?: string; // id of the source asset/happening, for drill-through\n  targetAmount?: IMoney; // user-set override (esp. gift lines)\n  isSurprise?: boolean; // Surpriseless \"surprise-hiding\" flag (gift lines)\n}\n\nexport interface IBudgetMonthGroup {\n  monthISO: string; // 'YYYY-MM'\n  total: IMoney;\n  items: IBudgetLineItem[];\n}\n\nexport interface IBudgetRollup {\n  byMonth: IBudgetMonthGroup[];\n  annualTotal: IMoney;\n  mostExpensiveMonthISO: string;\n}\n\n// The only fields a budgetus overrides record may patch onto a computed line\n// item. Kept separate from IBudgetLineItem so the wire/storage shape can't\n// accidentally include projection-only computed fields (title, amount, ...).\nexport interface IBudgetOverridePatch {\n  targetAmount?: IMoney;\n  isSurprise?: boolean;\n}\n\nexport function monthISOOf(dateISO: string): string {\n  return dateISO.slice(0, 7);\n}\n\n// Surprise-hiding (Surpriseless mechanic — budget-tab-mvp.md Section 1 and\n// Open Question 5). A gift line item flagged `isSurprise` must not reveal its\n// real title to the person it is a surprise for.\n//\n// This prototype has no recipient-linking yet (Open Question 1 in the plan is\n// still unresolved — there's no \"this gift is for user X\" edge to compare\n// against the current viewer), so for now it masks every `isSurprise` line\n// uniformly rather than per-viewer. `reveal: true` is a demo-only escape hatch\n// the Budget page uses so a reviewer/owner can see the underlying data\n// without needing a second signed-in user.\nexport function maskSurpriseLineItems(\n  items: IBudgetLineItem[],\n  options?: { reveal?: boolean },\n): IBudgetLineItem[] {\n  if (options?.reveal) {\n    return items;\n  }\n  return items.map((item) =>\n    item.isSurprise\n      ? { ...item, title: '🎁 Hidden surprise', sourceRef: undefined }\n      : item,\n  );\n}\n","import { InjectionToken } from '@angular/core';\nimport { ISpaceContext } from '@sneat/space-models';\nimport { Observable } from 'rxjs';\nimport { IListContext } from '../contexts';\nimport { IBudgetOverridePatch, IBudgetRollup, ListType } from '../dto';\nimport {\n  ICreateListRequest,\n  IDeleteListItemsRequest,\n  IListItemResult,\n  IListItemsCommandParams,\n  IReorderListItemsRequest,\n  ISetListItemsIsComplete,\n} from './interfaces';\n\n// IBudgetusService is the runtime-light contract Budgetus pages and components\n// depend on. Members mirror the concrete ListService public surface used by the\n// UI; the implementation lives in the private runtime and is provided via the\n// BUDGETUS_SERVICE token below. The UI BaseListPage additionally needs the\n// inherited ModuleSpaceItemService surface, so it types the injected token as\n// an intersection with ModuleSpaceItemService<IListBrief, IListDbo>.\nexport interface IBudgetusService {\n  createList(request: ICreateListRequest): Observable<IListContext>;\n  deleteList(space: ISpaceContext, listId: string): Observable<void>;\n  reorderListItems(request: IReorderListItemsRequest): Observable<void>;\n  createListItems(\n    params: IListItemsCommandParams,\n  ): Observable<IListItemResult>;\n  setListItemsIsCompleted(\n    request: ISetListItemsIsComplete,\n  ): Observable<void>;\n  deleteListItems(request: IDeleteListItemsRequest): Observable<void>;\n  getListById(\n    space: ISpaceContext,\n    listType: ListType,\n    listID: string,\n  ): Observable<IListContext>;\n\n  // --- Budget tab (the read-model projection over renewals + happenings; see\n  // budget-tab-mvp.md Section 3/4). Recomputed on every read, not a plain CRUD\n  // collection — hence Observable rather than a one-shot fetch. ---\n\n  /** Watches the derived+overridden budget rollup for a space. */\n  watchBudget(spaceID: string): Observable<IBudgetRollup>;\n\n  /**\n   * Persists a user override (target amount and/or surprise-hide flag) for a\n   * single computed budget line item, keyed by its `IBudgetLineItem.id`.\n   * Triggers a re-emission on the `watchBudget()` observable.\n   */\n  setOverride(\n    spaceID: string,\n    lineItemId: string,\n    patch: IBudgetOverridePatch,\n  ): Promise<void>;\n}\n\nexport const BUDGETUS_SERVICE = new InjectionToken<IBudgetusService>(\n  'BudgetusService',\n);\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;IAEkB;AAAlB,CAAA,UAAkB,QAAQ,EAAA;AACxB,IAAA,QAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACf,CAAC,EAFiB,QAAQ,KAAR,QAAQ,GAAA,EAAA,CAAA,CAAA;;MCuEb,iBAAiB,CAAA;IAC5B,OAAO,OAAO,GAGqB,CAAC,KAAK,EAAE,IAAI,KAC7C,CAAC;AACC,UAAE;AACF,UAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAA,GAAA,EAAM,IAAI,CAAC,EAAE,EAAE;aAC5B,IAAI,CAAC,SAAS,IAAI,WAAW,IAAI,CAAC,SAAS,CAAA,CAAE,CAAC;YAC/C,IAAI,CAAC,KAAK;;MAGL,aAAa,CAAA;AACxB,IAAA,OAAO,cAAc,CAAC,GAAG,KAAuB,EAAA;AAC9C,QAAA,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;QAChE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,KAAI;YAC1B,IAAI,EAAE,EAAE;AACN,gBAAA,OAAO,IAAI,CAAC,EAAE,KAAK,EAAE;YACvB;YACA,QACE,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK;iBAC/B,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC;iBAC5C,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC;iBACzC,CAAC,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,KAAK,WAAW,CAAC;AAEvD,QAAA,CAAC,CAAC;IACJ;AACD;SAQe,iBAAiB,CAC/B,SAAiB,EACjB,OAAgB,EAChB,EAAW,EAAA;IAEX,IAAI,OAAO,EAAE;AACX,QAAA,OAAO,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,OAAO,EAAE;IAClC;IACA,IAAI,EAAE,EAAE;AACN,QAAA,OAAO,EAAE;IACX;AACA,IAAA,OAAO,SAAS;AAClB;AAqBM,SAAU,wBAAwB,CACtC,CAAY,EACZ,CAAoB,EAAA;AAEpB,IAAA,QACE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE;SACvB,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC;AAE3E;AAEM,SAAU,qBAAqB,CACnC,GAAa,EACb,OAAgB,EAAA;AAEhB,IAAA,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE;AACd,QAAA,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC;IAC3B;AACA,IAAA,MAAM,QAAQ,GAAc;QAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,KAAK,EAAE,GAAG,CAAC,KAAK;KACjB;IACD,IAAI,OAAO,EAAE;AACX,QAAA,QAAQ,CAAC,OAAO,GAAG,OAAO;IAC5B;IACA,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE;QACjC,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM;IACxC;AACA,IAAA,IAAI,GAAG,CAAC,KAAK,EAAE;AACb,QAAA,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK;IAC5B;AACA,IAAA,IAAI,GAAG,CAAC,YAAY,EAAE;AACpB,QAAA,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY;IAC1C;AACA,IAAA,IAAI,GAAG,CAAC,OAAO,EAAE;AACf,QAAA,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,OAAO;IAC9B;AACA,IAAA,OAAO,QAAQ;AACjB;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AC3MA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AA2CM,SAAU,UAAU,CAAC,OAAe,EAAA;IACxC,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;AAC5B;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACM,SAAU,qBAAqB,CACnC,KAAwB,EACxB,OAA8B,EAAA;AAE9B,IAAA,IAAI,OAAO,EAAE,MAAM,EAAE;AACnB,QAAA,OAAO,KAAK;IACd;IACA,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KACpB,IAAI,CAAC;AACH,UAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,SAAS,EAAE,SAAS;UAC5D,IAAI,CACT;AACH;;MCpBa,gBAAgB,GAAG,IAAI,cAAc,CAChD,iBAAiB;;ACzDnB;;AAEG;;;;"}
+{"version":3,"file":"sneat-extension-budgetus-contract.mjs","sources":["../../../../libs/budgetus/src/services.ts","../../../../libs/budgetus/src/models.ts","../../../../libs/budgetus/src/enums.ts","../../../../libs/budgetus/src/utils.ts","../../../../libs/budgetus/src/sneat-extension-budgetus-contract.ts"],"sourcesContent":["import { InjectionToken } from '@angular/core';\nimport { Observable } from 'rxjs';\nimport {\n  IListDbo,\n  IListBrief,\n  IListKey,\n  IBudgetRollup,\n  IBudgetOverridePatch,\n  ListType,\n  IListItemBrief,\n  IListContext,\n  ICreateListRequest,\n  IListRequest,\n  ICreateListItemsRequest,\n  IListItemIDsRequest,\n  IReorderListItemsRequest,\n  IDeleteListItemsRequest,\n  ISetListItemsIsComplete,\n  IListItemsCommandParams,\n  IListItemResult,\n} from './dto';\n\nexport interface GetOrCreateCommuneItemIds {\n  id?: string;\n  shortId?: string;\n  communeShortId?: string;\n}\n\nexport interface IProgress {\n  current: number;\n  total: number;\n  state?: string;\n}\n\nexport type ReorderListItemsWorker = (listDto: IListDbo) => void;\n\nexport interface IBudgetusService {\n  createList(request: ICreateListRequest): Observable<IListContext>;\n  deleteList(space: any, listId: string): Observable<void>;\n  reorderListItems(request: IReorderListItemsRequest): Observable<void>;\n  createListItems(params: IListItemsCommandParams): Observable<IListItemResult>;\n  setListItemsIsCompleted(request: ISetListItemsIsComplete): Observable<void>;\n  deleteListItems(request: IDeleteListItemsRequest): Observable<void>;\n  getListById(space: any, listType: ListType, listID: string): Observable<IListContext>;\n  watchBudget(spaceID: string): Observable<IBudgetRollup>;\n  setOverride(spaceID: string, lineItemId: string, patch: IBudgetOverridePatch): Promise<void>;\n}\n\nexport const BUDGETUS_SERVICE = new InjectionToken<IBudgetusService>('BudgetusService');\n","import { IListItemBrief } from './dto/list-item';\n\nexport class ListItemInfoModel {\n  static trackBy = (index: number, item: IListItemBrief | null | undefined): string | number | undefined =>\n    !item\n      ? index\n      : (!!item.id && `id:${item.id}`) ||\n        (item.subListId && `subList:${item.subListId}`) ||\n        item.title;\n}\n\nexport class ListItemModel {\n  static equalListItems(...items: IListItemBrief[]): boolean {\n    const { id, title, subListId, category, subListType } = items[0];\n    return !items.some((item) => {\n      if (id) {\n        return item.id !== id;\n      }\n      return (\n        (!!title && item.title !== title) ||\n        (!!subListId && item.subListId !== subListId) ||\n        (!!category && item.category !== category) ||\n        (!!subListType && item.subListType !== subListType)\n      );\n    });\n  }\n}\n","import { EnumAsUnionOfKeys } from '@sneat/core';\n\nexport const enum ListPage {\n  list = 'list',\n}\nexport type ListPages = EnumAsUnionOfKeys<typeof ListPage>;\n","import { IRecord } from '@sneat/data';\nimport { IListDbo, IListInfo } from './dto/list';\n\nexport function getListShortUrlId(communeId: string, shortId?: string, id?: string): string | undefined {\n  if (shortId) {\n    return `${communeId}-${shortId}`;\n  }\n  if (id) {\n    return id;\n  }\n  return undefined;\n}\n\nexport function isListInfoMatchesListDto(i: IListInfo, l: IRecord<IListDbo>): boolean {\n  return (\n    (!!i.id && i.id === l.id) ||\n    (i.type === l.dbo?.type && !!i.shortId && i.shortId === l.dbo?.shortId)\n  );\n}\n\nexport function createListInfoFromDto(dto: IListDbo, shortId?: string): IListInfo {\n  if (!dto.title) {\n    throw new Error('!title');\n  }\n  const listInfo: IListInfo = {\n    type: dto.type,\n    title: dto.title,\n  };\n  if (shortId) {\n    listInfo.shortId = shortId;\n  }\n  if (dto.items && dto.items.length) {\n    listInfo.itemsCount = dto.items.length;\n  }\n  if (dto.emoji) {\n    listInfo.emoji = dto.emoji;\n  }\n  if (dto.restrictions) {\n    listInfo.restrictions = dto.restrictions;\n  }\n  if (dto.commune) {\n    listInfo.space = dto.commune;\n  }\n  return listInfo;\n}\n\nexport function monthISOOf(dateISO: string): string {\n  return dateISO.slice(0, 7);\n}\n\nexport function maskSurpriseLineItems(\n  items: any[],\n  options?: {\n    reveal?: boolean;\n  }\n): any[] {\n  if (options?.reveal) {\n    return items;\n  }\n  return items.map((item) =>\n    item.isSurprise\n      ? { ...item, title: '🎁 Hidden surprise', sourceRef: undefined }\n      : item\n  );\n}\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;MAgDa,gBAAgB,GAAG,IAAI,cAAc,CAAmB,iBAAiB;;MC9CzE,iBAAiB,CAAA;IAC5B,OAAO,OAAO,GAAG,CAAC,KAAa,EAAE,IAAuC,KACtE,CAAC;AACC,UAAE;AACF,UAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAA,GAAA,EAAM,IAAI,CAAC,EAAE,EAAE;aAC5B,IAAI,CAAC,SAAS,IAAI,WAAW,IAAI,CAAC,SAAS,CAAA,CAAE,CAAC;YAC/C,IAAI,CAAC,KAAK;;MAGL,aAAa,CAAA;AACxB,IAAA,OAAO,cAAc,CAAC,GAAG,KAAuB,EAAA;AAC9C,QAAA,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;QAChE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,KAAI;YAC1B,IAAI,EAAE,EAAE;AACN,gBAAA,OAAO,IAAI,CAAC,EAAE,KAAK,EAAE;YACvB;YACA,QACE,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK;iBAC/B,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC;iBAC5C,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC;iBACzC,CAAC,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,KAAK,WAAW,CAAC;AAEvD,QAAA,CAAC,CAAC;IACJ;AACD;;ICxBiB;AAAlB,CAAA,UAAkB,QAAQ,EAAA;AACxB,IAAA,QAAA,CAAA,MAAA,CAAA,GAAA,MAAa;AACf,CAAC,EAFiB,QAAQ,KAAR,QAAQ,GAAA,EAAA,CAAA,CAAA;;SCCV,iBAAiB,CAAC,SAAiB,EAAE,OAAgB,EAAE,EAAW,EAAA;IAChF,IAAI,OAAO,EAAE;AACX,QAAA,OAAO,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,OAAO,EAAE;IAClC;IACA,IAAI,EAAE,EAAE;AACN,QAAA,OAAO,EAAE;IACX;AACA,IAAA,OAAO,SAAS;AAClB;AAEM,SAAU,wBAAwB,CAAC,CAAY,EAAE,CAAoB,EAAA;AACzE,IAAA,QACE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE;SACvB,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC;AAE3E;AAEM,SAAU,qBAAqB,CAAC,GAAa,EAAE,OAAgB,EAAA;AACnE,IAAA,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE;AACd,QAAA,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC;IAC3B;AACA,IAAA,MAAM,QAAQ,GAAc;QAC1B,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,KAAK,EAAE,GAAG,CAAC,KAAK;KACjB;IACD,IAAI,OAAO,EAAE;AACX,QAAA,QAAQ,CAAC,OAAO,GAAG,OAAO;IAC5B;IACA,IAAI,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE;QACjC,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM;IACxC;AACA,IAAA,IAAI,GAAG,CAAC,KAAK,EAAE;AACb,QAAA,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK;IAC5B;AACA,IAAA,IAAI,GAAG,CAAC,YAAY,EAAE;AACpB,QAAA,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY;IAC1C;AACA,IAAA,IAAI,GAAG,CAAC,OAAO,EAAE;AACf,QAAA,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,OAAO;IAC9B;AACA,IAAA,OAAO,QAAQ;AACjB;AAEM,SAAU,UAAU,CAAC,OAAe,EAAA;IACxC,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;AAC5B;AAEM,SAAU,qBAAqB,CACnC,KAAY,EACZ,OAEC,EAAA;AAED,IAAA,IAAI,OAAO,EAAE,MAAM,EAAE;AACnB,QAAA,OAAO,KAAK;IACd;IACA,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,KACpB,IAAI,CAAC;AACH,UAAE,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,oBAAoB,EAAE,SAAS,EAAE,SAAS;UAC5D,IAAI,CACT;AACH;;AChEA;;AAEG;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sneat/extension-budgetus-contract",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "publishConfig": {
     "access": "public"
   },

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

@@ -1,25 +1,26 @@
-import { EnumAsUnionOfKeys } from '@sneat/core';
-import { ISpaceItemNavContext, ISpaceRequest, ISpaceContext } from '@sneat/space-models';
-import { IRecord } from '@sneat/data';
-import { IWithSpaceIDs, SneatRecordStatus, IWithCreated, IWithRestrictions, IShortSpaceInfo, ICommuneDbo } from '@sneat/dto';
+import { SneatRecordStatus, IWithSpaceIDs, IWithCreated, IWithRestrictions, IShortSpaceInfo } from '@sneat/dto';
+import { ISpaceItemNavContext, ISpaceContext } from '@sneat/space-models';
 import { InjectionToken } from '@angular/core';
 import { Observable } from 'rxjs';
+import { EnumAsUnionOfKeys } from '@sneat/core';
+import { IRecord } from '@sneat/data';
 
-declare const enum ListPage {
-    list = "list"
-}
-type ListPages = EnumAsUnionOfKeys<typeof ListPage>;
+type ListType = 'buy' | 'watch' | 'cook' | 'do' | 'other' | 'recipes' | 'rsvp';
 
 type ListStatus = SneatRecordStatus;
 interface IQuantity {
     value: number;
     unit: string;
 }
-interface IListItemCommon extends IListCommon {
+interface IListItemCommon {
     subListId?: string;
     subListType?: ListType;
     quantity?: IQuantity;
     category?: string;
+    title: string;
+    img?: string;
+    emoji?: string;
+    isDone?: boolean;
 }
 type IListItemBase = IListItemCommon;
 type ListItemStatus = 'done' | 'active';
@@ -34,7 +35,12 @@ interface ListCounts {
     active?: number;
     completed?: number;
 }
-type ListType = 'buy' | 'watch' | 'cook' | 'do' | 'other' | 'recipes' | 'rsvp';
+interface IListItemDbo extends IWithSpaceIDs, IListItemCommon {
+    listId?: string;
+    score?: number;
+    subListItems?: IListItemBrief[];
+}
+
 interface IListCommon {
     title: string;
     img?: string;
@@ -53,18 +59,6 @@ interface IListDbo extends IListBase, IWithRestrictions, IWithCreated {
     items?: IListItemBrief[];
     commune?: IShortSpaceInfo;
 }
-declare class ListItemInfoModel {
-    static trackBy: (index: number, item: IListItemBrief) => string | number | undefined;
-}
-declare class ListItemModel {
-    static equalListItems(...items: IListItemBrief[]): boolean;
-}
-interface IListItemDbo extends IListBase, IListItemCommon {
-    listId?: string;
-    score?: number;
-    subListItems?: IListItemBrief[];
-}
-declare function getListShortUrlId(communeId: string, shortId?: string, id?: string): string | undefined;
 interface IListInfo extends IWithRestrictions {
     parentListId?: string;
     parentListType?: ListType;
@@ -82,9 +76,10 @@ interface IListInfo extends IWithRestrictions {
 interface IListBrief extends IListBase, IWithCreated {
     emoji?: string;
 }
-declare function isListInfoMatchesListDto(i: IListInfo, l: IRecord<IListDbo>): boolean;
-declare function createListInfoFromDto(dto: IListDbo, shortId?: string): IListInfo;
-
+interface IListKey {
+    id: string;
+    type: ListType;
+}
 interface IListGroup {
     id: string;
     title?: string;
@@ -94,9 +89,8 @@ interface IListGroup {
 }
 
 interface IBudgetusSpaceDbo {
-    listGroups?: IListGroup[];
+    listGroups?: any[];
 }
-
 interface IMoney {
     currency: string;
     value: number;
@@ -126,49 +120,20 @@ interface IBudgetOverridePatch {
     targetAmount?: IMoney;
     isSurprise?: boolean;
 }
-declare function monthISOOf(dateISO: string): string;
-declare function maskSurpriseLineItems(items: IBudgetLineItem[], options?: {
-    reveal?: boolean;
-}): IBudgetLineItem[];
 
-interface IListKey {
-    id: string;
+interface IListContext extends ISpaceItemNavContext<IListBrief, any> {
     type: ListType;
 }
-interface IListContext extends ISpaceItemNavContext<IListBrief, IListDbo> {
-    type: ListType;
-}
-
-interface GetOrCreateCommuneItemIds {
+interface ICreateListRequest {
     id?: string;
-    shortId?: string;
-    communeShortId?: string;
-}
-interface IProgress {
-    current: number;
-    total: number;
-    state?: string;
-}
-interface IListItemResult {
-    message?: string;
-    changed?: boolean;
-    success: boolean;
-    listDto: IListDbo;
-    communeDto?: ICommuneDbo;
-    listItemDto?: IListItemDbo;
-}
-interface IListItemsCommandParams {
-    space: ISpaceContext;
-    list: IListContext;
-    items: IListItemBrief[];
-}
-type ReorderListItemsWorker = (listDto: IListDbo) => void;
-interface ICreateListRequest extends ISpaceRequest, IListBrief {
+    title: string;
+    type: ListType;
+    emoji?: string;
 }
-interface IListRequest extends ISpaceRequest {
+interface IListRequest {
     readonly listID: string;
 }
-interface ICreateListItemRequest extends IListItemBase {
+interface ICreateListItemRequest extends IListItemBrief {
     id: string;
 }
 interface ICreateListItemsRequest extends IListRequest {
@@ -187,25 +152,63 @@ type IDeleteListItemsRequest = IListItemIDsRequest;
 interface ISetListItemsIsComplete extends IListItemIDsRequest {
     isDone: boolean;
 }
+interface IListItemsCommandParams {
+    space: ISpaceContext;
+    list: IListContext;
+    items: IListItemBrief[];
+}
+interface IListItemResult {
+    message?: string;
+    changed?: boolean;
+    success: boolean;
+    listDto: any;
+    communeDto?: any;
+    listItemDto?: IListItemDbo;
+}
 
+interface GetOrCreateCommuneItemIds {
+    id?: string;
+    shortId?: string;
+    communeShortId?: string;
+}
+interface IProgress {
+    current: number;
+    total: number;
+    state?: string;
+}
+type ReorderListItemsWorker = (listDto: IListDbo) => void;
 interface IBudgetusService {
     createList(request: ICreateListRequest): Observable<IListContext>;
-    deleteList(space: ISpaceContext, listId: string): Observable<void>;
+    deleteList(space: any, listId: string): Observable<void>;
     reorderListItems(request: IReorderListItemsRequest): Observable<void>;
     createListItems(params: IListItemsCommandParams): Observable<IListItemResult>;
     setListItemsIsCompleted(request: ISetListItemsIsComplete): Observable<void>;
     deleteListItems(request: IDeleteListItemsRequest): Observable<void>;
-    getListById(space: ISpaceContext, listType: ListType, listID: string): Observable<IListContext>;
-    /** Watches the derived+overridden budget rollup for a space. */
+    getListById(space: any, listType: ListType, listID: string): Observable<IListContext>;
     watchBudget(spaceID: string): Observable<IBudgetRollup>;
-    /**
-     * Persists a user override (target amount and/or surprise-hide flag) for a
-     * single computed budget line item, keyed by its `IBudgetLineItem.id`.
-     * Triggers a re-emission on the `watchBudget()` observable.
-     */
     setOverride(spaceID: string, lineItemId: string, patch: IBudgetOverridePatch): Promise<void>;
 }
 declare const BUDGETUS_SERVICE: InjectionToken<IBudgetusService>;
 
+declare class ListItemInfoModel {
+    static trackBy: (index: number, item: IListItemBrief | null | undefined) => string | number | undefined;
+}
+declare class ListItemModel {
+    static equalListItems(...items: IListItemBrief[]): boolean;
+}
+
+declare const enum ListPage {
+    list = "list"
+}
+type ListPages = EnumAsUnionOfKeys<typeof ListPage>;
+
+declare function getListShortUrlId(communeId: string, shortId?: string, id?: string): string | undefined;
+declare function isListInfoMatchesListDto(i: IListInfo, l: IRecord<IListDbo>): boolean;
+declare function createListInfoFromDto(dto: IListDbo, shortId?: string): IListInfo;
+declare function monthISOOf(dateISO: string): string;
+declare function maskSurpriseLineItems(items: any[], options?: {
+    reveal?: boolean;
+}): any[];
+
 export { BUDGETUS_SERVICE, ListItemInfoModel, ListItemModel, ListPage, createListInfoFromDto, getListShortUrlId, isListInfoMatchesListDto, maskSurpriseLineItems, monthISOOf };
 export type { BudgetLineSource, GetOrCreateCommuneItemIds, IBudgetLineItem, IBudgetMonthGroup, IBudgetOverridePatch, IBudgetRollup, IBudgetusService, IBudgetusSpaceDbo, ICreateListItemRequest, ICreateListItemsRequest, ICreateListRequest, IDeleteListItemsRequest, IListBase, IListBrief, IListCommon, IListContext, IListDbo, IListGroup, IListInfo, IListItemBase, IListItemBrief, IListItemCommon, IListItemDbo, IListItemIDsRequest, IListItemRequest, IListItemResult, IListItemsCommandParams, IListKey, IListRequest, IMoney, IProgress, IQuantity, IReorderListItemsRequest, ISetListItemsIsComplete, ListCounts, ListItemStatus, ListPages, ListStatus, ListType, ReorderListItemsWorker };