@sneat/space-models 0.1.1

package/eslint.config.js

@@ -0,0 +1,7 @@
+const baseConfig = require('../../../eslint.config.js');
+const { sneatLibConfig } = require('../../../eslint.lib.config.js');
+
+module.exports = [
+  ...baseConfig,
+  ...sneatLibConfig(__dirname),
+];

package/ng-package.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../../dist/libs/space/models",
+  "lib": {
+    "entryFile": "src/index.ts"
+  }
+}

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "@sneat/space-models",
+  "version": "0.1.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@angular/common": ">=21.0.0",
+    "@angular/core": ">=21.0.0"
+  },
+  "dependencies": {
+    "tslib": "2.8.1"
+  }
+}

package/project.json

@@ -0,0 +1,38 @@
+{
+  "name": "space-models",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "library",
+  "sourceRoot": "libs/space/models/src",
+  "prefix": "sneat",
+  "targets": {
+    "build": {
+      "executor": "@nx/angular:ng-packagr-lite",
+      "outputs": [
+        "{workspaceRoot}/dist/libs/space/models"
+      ],
+      "options": {
+        "project": "libs/space/models/ng-package.json",
+        "tsConfig": "libs/space/models/tsconfig.lib.json"
+      },
+      "configurations": {
+        "production": {
+          "tsConfig": "libs/space/models/tsconfig.lib.prod.json"
+        },
+        "development": {}
+      },
+      "defaultConfiguration": "production"
+    },
+    "test": {
+      "executor": "@nx/vitest:test",
+      "outputs": [
+        "{workspaceRoot}/coverage/libs/space/models"
+      ],
+      "options": {
+        "tsConfig": "libs/space/models/tsconfig.spec.json"
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export * from './lib';

package/src/lib/dto-models.ts

@@ -0,0 +1,13 @@
+import { SpaceType } from '@sneat/core';
+import { IRecord } from '@sneat/data';
+import { ISpaceDbo } from '@sneat/dto';
+
+export interface ICreateSpaceRequest {
+  type: SpaceType;
+  // memberType: MemberType;
+  title?: string;
+}
+
+export interface ICreateSpaceResponse {
+  space: IRecord<ISpaceDbo>;
+}

package/src/lib/index.ts

@@ -0,0 +1,5 @@
+export * from './uimodels';
+export * from './models';
+export * from './dto-models';
+export * from './space-context';
+export * from './space-item-context';

package/src/lib/invite-models.ts

@@ -0,0 +1 @@
+export const empty = {};

package/src/lib/member-context.ts

@@ -0,0 +1 @@
+export const empty = {};

package/src/lib/models.ts

@@ -0,0 +1,72 @@
+import { SpaceType } from '@sneat/core';
+import { ISpaceModuleItemRef } from '@sneat/dto';
+
+export interface ISpaceRequest {
+  readonly spaceID: string;
+}
+
+export interface ISpaceItemRequest extends ISpaceRequest {
+  readonly id: string;
+}
+
+export interface ISpaceMemberRequest extends ISpaceRequest {
+  readonly memberID: string;
+}
+
+export interface ILeaveSpaceRequest extends ISpaceRequest {
+  readonly message?: string;
+}
+
+export interface IAcceptInviteResponse {
+  readonly id: string;
+}
+
+export interface IInviteSpace {
+  readonly id: string;
+  readonly type: SpaceType;
+  readonly title: string;
+}
+
+export interface IRejectPersonalInviteRequest extends ISpaceRequest {
+  readonly inviteID: string;
+  readonly pin: string;
+}
+
+export type SpaceMemberStatus = 'active' | 'archived';
+
+export interface ITaskRequest extends ISpaceMemberRequest {
+  readonly type: string;
+  readonly task: string;
+}
+
+export interface IReorderTaskRequest extends ITaskRequest {
+  readonly len: number;
+  readonly from: number;
+  readonly to: number;
+  readonly after?: string;
+  readonly before?: string;
+}
+
+export interface IModuleCollectionRef {
+  readonly moduleID: string;
+  readonly collection: string;
+}
+
+export interface IRelatedRolesRequest {
+  readonly rolesOfItem?: string[];
+  readonly rolesToItem?: string[];
+}
+
+export interface IRelatedChange {
+  readonly add?: IRelatedRolesRequest;
+  readonly remove?: IRelatedRolesRequest;
+}
+
+export interface IRelatedItemChange extends IRelatedChange {
+  readonly itemRef: ISpaceModuleItemRef;
+}
+
+export interface IUpdateRelatedRequest
+  extends ISpaceItemRequest, IModuleCollectionRef {
+  readonly related?: IRelatedItemChange[];
+}

package/src/lib/sanity.spec.ts

@@ -0,0 +1,5 @@
+describe('libs/space/models sanity', () => {
+  it('should pass sanity check', () => {
+    expect(true).toBe(true);
+  });
+});

package/src/lib/space-context.ts

@@ -0,0 +1,71 @@
+import { computed, Signal } from '@angular/core';
+import {
+  IIdAndBrief,
+  IIdAndBriefWithSpaceRef,
+  INavContext,
+  ISpaceRef,
+} from '@sneat/core';
+import { IShortSpaceInfo, ISpaceBrief, ISpaceDbo } from '@sneat/dto';
+
+export function zipMapBriefsWithIDs<Brief>(
+  briefs?: Readonly<Record<string, Brief>>,
+): readonly IIdAndBrief<Brief>[] {
+  return briefs
+    ? Object.entries(briefs).map(([id, brief]) => ({ id, brief }))
+    : [];
+}
+
+export function zipMapBriefsWithIDsAndSpaceRef<Brief>(
+  space: ISpaceRef,
+  briefs?: Readonly<Record<string, Brief>>,
+): readonly IIdAndBriefWithSpaceRef<Brief>[] {
+  return briefs
+    ? Object.entries(briefs).map(([id, brief]) => ({ id, brief, space }))
+    : [];
+}
+
+export interface ISpaceContext
+  extends ISpaceRef, INavContext<ISpaceBrief, ISpaceDbo> {
+  // readonly type?: SpaceType;
+  // readonly assets?: IAssetContext[]; // TODO: this should not be here
+  // readonly contacts?: IContactContext[]; // TODO: this should not be here
+}
+
+export function computeSpaceRefFromSpaceContext(
+  $space: Signal<ISpaceContext | undefined>,
+) {
+  return computed<ISpaceRef>(() => {
+    const space = $space();
+    return space?.type
+      ? { type: space?.type, id: space.id }
+      : { id: space?.id || '' };
+  });
+}
+
+export function computeSpaceIdFromSpaceRef($spaceRef: () => ISpaceRef) {
+  return computed<string>(() => $spaceRef().id);
+}
+
+export const spaceContextFromBrief = (
+  id: string,
+  brief: ISpaceBrief,
+): ISpaceContext => ({ id, type: brief.type, brief });
+
+// export interface IContactContextWithBrief
+// 	extends ITeamItemNavContext<IContactBrief, IContactDto> {
+// 	brief: IContactBrief;
+// 	parentContact?: IContactContext;
+// }
+
+export function createShortSpaceInfoFromDbo(
+  space: ISpaceContext,
+): IShortSpaceInfo {
+  if (!space.type) {
+    throw new Error('!team.type');
+  }
+  return {
+    id: space.id,
+    type: space.type,
+    title: space?.dbo?.title || space.brief?.title,
+  };
+}

package/src/lib/space-item-context.ts

@@ -0,0 +1,21 @@
+import {
+  IIdAndOptionalBriefAndOptionalDbo,
+  IIdAndOptionalDbo,
+  ISpaceRef,
+} from '@sneat/core';
+
+export interface ISpaceItemWithOptionalBriefAndOptionalDbo<
+  Brief,
+  Dbo extends Brief,
+> extends IIdAndOptionalBriefAndOptionalDbo<Brief, Dbo> {
+  readonly space: ISpaceRef;
+}
+
+export interface ISpaceItemWithOptionalDbo<Dbo> extends IIdAndOptionalDbo<Dbo> {
+  readonly space: ISpaceRef;
+}
+
+export type ISpaceItemNavContext<
+  Brief,
+  Dbo extends Brief,
+> = ISpaceItemWithOptionalBriefAndOptionalDbo<Brief, Dbo>;

package/src/lib/uimodels/index.ts

@@ -0,0 +1 @@
+export * from './ui-models';

package/src/lib/uimodels/ui-models.ts

@@ -0,0 +1,265 @@
+import { SpaceType } from '@sneat/core';
+import { DtoTotal, DtoTotals, Period } from '@sneat/dto';
+import { ISpaceContext } from '../space-context';
+
+export class Total {
+  constructor(public readonly dto?: DtoTotal) {
+    if (!dto) {
+      this.dto = { count: 0 };
+    }
+  }
+
+  public get count(): number {
+    return this.dto ? this.dto.count : 0;
+  }
+
+  public per(period: Period): number {
+    switch (period) {
+      case 'month':
+        return this.perMonth();
+      case 'year':
+        return this.perYear();
+      case 'quarter':
+        return this.perQuarter();
+      case 'week':
+        return this.perWeek();
+      case 'day':
+        return this.perDay();
+      default:
+        throw new Error(`unknown period: ${period}`);
+    }
+  }
+
+  public perDay(): number {
+    if (!this.dto) {
+      return 0;
+    }
+    let result = 0;
+    if (this.dto.day !== undefined) {
+      result += this.dto.day;
+    }
+    if (this.dto.week !== undefined) {
+      result += Math.round(this.dto.week / 7);
+    }
+    if (this.dto.month !== undefined) {
+      result += Math.round(this.dto.month / 30);
+    }
+    if (this.dto.quarter !== undefined) {
+      result += Math.round(this.dto.quarter / 61);
+    }
+    if (this.dto.year !== undefined) {
+      result += Math.round(this.dto.year / 365);
+    }
+    return result;
+  }
+
+  public perWeek(): number {
+    if (!this.dto) {
+      return 0;
+    }
+    let result = 0;
+    if (this.dto.week !== undefined) {
+      result += this.dto.week;
+    }
+    if (this.dto.month !== undefined) {
+      result += Math.round(this.dto.month / 4.33);
+    }
+    if (this.dto.day !== undefined) {
+      result += this.dto.day * 7;
+    }
+    if (this.dto.quarter !== undefined) {
+      result += Math.round(this.dto.quarter / 13);
+    }
+    if (this.dto.year !== undefined) {
+      result += Math.round(this.dto.year / 52);
+    }
+    return result;
+  }
+
+  public perMonth(): number {
+    if (!this.dto) {
+      return 0;
+    }
+    let result = 0;
+    if (this.dto.month !== undefined) {
+      result += this.dto.month;
+    }
+    if (this.dto.day !== undefined) {
+      result += this.dto.day * 30;
+    }
+    if (this.dto.week !== undefined) {
+      result += this.dto.week * 4.33;
+    }
+    if (this.dto.year !== undefined) {
+      result += Math.round(this.dto.year / 12);
+    }
+    if (this.dto.quarter !== undefined) {
+      result += Math.round(this.dto.quarter / 3);
+    }
+    return result;
+  }
+
+  public perQuarter(): number {
+    if (!this.dto) {
+      return 0;
+    }
+    let result = 0;
+    if (this.dto.quarter !== undefined) {
+      result += this.dto.quarter;
+    }
+    if (this.dto.day !== undefined) {
+      result += this.dto.day * 61;
+    }
+    if (this.dto.week !== undefined) {
+      result += this.dto.week * 13;
+    }
+    if (this.dto.month !== undefined) {
+      result += this.dto.month * 3;
+    }
+    if (this.dto.year !== undefined) {
+      result += Math.round(this.dto.year / 4);
+    }
+    return result;
+  }
+
+  public perYear(): number {
+    if (!this.dto) {
+      return 0;
+    }
+    let result = 0;
+    if (this.dto.year !== undefined) {
+      result += this.dto.year;
+    }
+    if (this.dto.day !== undefined) {
+      result += this.dto.day * 365;
+    }
+    if (this.dto.week !== undefined) {
+      result += this.dto.week * 52;
+    }
+    if (this.dto.month !== undefined) {
+      result += this.dto.month * 12;
+    }
+    if (this.dto.quarter !== undefined) {
+      result += this.dto.quarter * 4;
+    }
+    return result;
+  }
+}
+
+export class Totals {
+  readonly incomes: Total;
+  readonly expenses: Total;
+
+  constructor(dtoTotals?: DtoTotals) {
+    this.incomes = new Total(dtoTotals ? dtoTotals.incomes : undefined);
+    this.expenses = new Total(dtoTotals ? dtoTotals.expenses : undefined);
+  }
+
+  get count(): number {
+    return this.incomes.count + this.expenses.count;
+  }
+
+  isPositive(period: Period): boolean {
+    return this.per(period, true, true) > 0;
+  }
+
+  isNegative(period: Period): boolean {
+    return this.per(period, true, true) < 0;
+  }
+
+  per(period: Period, incomes = true, expense = true): number {
+    if (incomes && expense) {
+      return this.incomes.per(period) - this.expenses.per(period);
+    }
+    if (incomes) {
+      return this.incomes.per(period);
+    }
+    if (expense) {
+      return -this.expenses.per(period);
+    }
+    return 0;
+  }
+
+  balance(per: 'month' | 'day'): number {
+    switch (per) {
+      case 'month':
+        return (
+          Math.round(
+            (this.incomes.perMonth() - this.expenses.perMonth()) * 100,
+          ) / 100
+        );
+      case 'day':
+        return (
+          Math.round((this.incomes.perDay() - this.expenses.perDay()) * 100) /
+          100
+        );
+      default:
+        throw new Error(`Unknown parameter value: ${per}`);
+    }
+  }
+}
+
+export class Commune implements ISpaceContext {
+  public readonly totals: Totals;
+
+  constructor(
+    public readonly space: ISpaceContext,
+    public readonly shortId?: string,
+  ) {
+    this.totals = new Totals(space.dbo?.totals);
+  }
+
+  public get id(): string {
+    return this.space.id;
+  }
+
+  public get type(): SpaceType | undefined {
+    return this.space.dbo?.type;
+  }
+
+  public get title(): string | undefined {
+    return this.space.dbo?.title;
+  }
+
+  // public get isSupportingMemberGroups(): boolean {
+  // 	const t = this.team.type;
+  // 	return t === 'educator' || t === 'sport_club' || t === 'cohabit';
+  // }
+
+  // public get numberOf(): TeamCounts {
+  // 	if (this.team.dto?.numberOf) {
+  // 		return this.team.dto.numberOf;
+  // 	}
+  // 	return newTeamCounts(this.team.dto?.numberOf);
+  // }
+
+  private _membersCountByRole?: { role: string; count: number }[];
+
+  public get membersCountByRole(): { role: string; count: number }[] {
+    throw new Error('Not implemented yet - disabled');
+    // if (!this._membersCountByRole) {
+    // 	const byRole = this.numberOf.membersByRole;
+    // 	if (!byRole) {
+    // 		return [];
+    // 	}
+    // 	this._membersCountByRole = Object.entries(byRole)
+    // 		.map(item => ({ role: item[0], count: item[1] as number }));
+    // }
+    // return this._membersCountByRole;
+  }
+
+  public supports(v: 'staff' | 'pupils'): boolean {
+    if (!v) {
+      return false;
+    }
+    switch (v) {
+      case 'staff':
+        return this.type === 'educator' || this.type === 'realtor';
+      case 'pupils':
+        return this.type === 'educator';
+      default:
+        break;
+    }
+    return false;
+  }
+}

package/src/test-setup.ts

@@ -0,0 +1 @@
+import '@sneat/core/testing-light';

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../../tsconfig.angular.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,19 @@
+{
+  "extends": "../../../tsconfig.lib.base.json",
+  "exclude": [
+    "vite.config.ts",
+    "vite.config.mts",
+    "vitest.config.ts",
+    "vitest.config.mts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/test-setup.ts",
+    "src/lib/testing/**/*"
+  ]
+}

package/tsconfig.lib.prod.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.lib.json",
+  "compilerOptions": {
+    "declarationMap": false
+  },
+  "angularCompilerOptions": {}
+}

package/tsconfig.spec.json

@@ -0,0 +1,31 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "types": [
+      "vitest/globals",
+      "vitest/importMeta",
+      "vite/client",
+      "node",
+      "vitest"
+    ]
+  },
+  "include": [
+    "vite.config.ts",
+    "vite.config.mts",
+    "vitest.config.ts",
+    "vitest.config.mts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/**/*.d.ts"
+  ],
+  "files": [
+    "src/test-setup.ts"
+  ]
+}

package/vite.config.mts

@@ -0,0 +1,10 @@
+/// <reference types='vitest' />
+import { defineConfig } from 'vitest/config';
+import { createBaseViteConfig } from '../../../vite.config.base';
+
+export default defineConfig(() =>
+	createBaseViteConfig({
+		dirname: __dirname,
+		name: 'space-models',
+	}),
+);