@sneat/dto 0.1.3 → 0.1.6

package/src/lib/dto-commune.ts

@@ -1,158 +0,0 @@
-import { IDemoRecord, ITitledRecord, ITotalsHolder } from './dto-models';
-import { CommuneType, CountryId } from './types';
-
-export const enum SpaceCounter {
-  activities = 'activities',
-  assets = 'assets',
-  assetGroups = 'assetGroups',
-  contacts = 'contacts',
-  documents = 'documents',
-  liabilities = 'liabilities',
-  members = 'members',
-  // membersByRole = 'membersByRole',
-  memberGroups = 'memberGroups',
-  overdues = 'overdues',
-  pupils = 'pupils',
-  regularTasks = 'regularTasks',
-  staff = 'staff',
-  todos = 'todos',
-  upcomings = 'upcomings',
-}
-
-// type TeamCounters = {
-// 	[P in EnumAsUnionOfKeys<typeof TeamCounter>]: number;
-// };
-
-export interface SpaceCounts {
-  [SpaceCounter.activities]?: number;
-  [SpaceCounter.assets]?: number;
-  [SpaceCounter.assetGroups]?: number;
-  [SpaceCounter.contacts]?: number;
-  [SpaceCounter.documents]?: number;
-  [SpaceCounter.regularTasks]?: number;
-  [SpaceCounter.liabilities]?: number;
-  [SpaceCounter.pupils]?: number;
-  [SpaceCounter.staff]?: number;
-  [SpaceCounter.members]?: number;
-  [SpaceCounter.memberGroups]?: number;
-  [SpaceCounter.overdues]?: number;
-  [SpaceCounter.todos]?: number;
-  [SpaceCounter.upcomings]?: number;
-  // [CommuneCounter.membersByRole]?: { [role: string]: number }; this does not make sense here
-}
-
-export function incrementNumberOf<
-  NumberOf,
-  Dbo extends { numberOf?: NumberOf },
->(dto: Dbo, init: () => NumberOf, counter: keyof NumberOf, v = 1): Dbo {
-  const current: number = ((dto.numberOf && dto.numberOf[counter]) ||
-    0) as unknown as number;
-  return {
-    ...dto,
-    numberOf: {
-      ...(dto.numberOf || init()),
-      [counter]: current + v,
-    },
-  };
-}
-
-export function newSpaceCounts(numberOf?: SpaceCounts): SpaceCounts {
-  numberOf = numberOf || {};
-  return {
-    activities: numberOf.activities || 0,
-    assets: numberOf.assets || 0,
-    assetGroups: numberOf.assetGroups || 0,
-    contacts: numberOf.contacts || 0,
-    documents: numberOf.documents || 0,
-    members: numberOf.members || 0,
-    memberGroups: numberOf.memberGroups || 0,
-    liabilities: numberOf.liabilities || 0,
-    overdues: numberOf.overdues || 0,
-    regularTasks: numberOf.regularTasks || 0,
-    todos: numberOf.todos || 0,
-    upcomings: numberOf.upcomings || 0,
-  };
-}
-
-export interface ICommuneDbo extends IDemoRecord, ITitledRecord, ITotalsHolder {
-  readonly countryId?: CountryId;
-  readonly type: CommuneType;
-  readonly desc?: string;
-  readonly userID: string;
-  readonly order?: number;
-  readonly numberOf?: SpaceCounts;
-  readonly membersCountByRole?: Record<string, number>;
-  readonly noContactRoles?: string[];
-  // readonly groups?: ICommuneDtoMemberGroupInfo[];
-  // readonly members?: readonly ITeamMemberInfo[];
-}
-
-export function isCommuneShouldHoldMembersInfo(type: CommuneType): boolean {
-  return type === 'family' || type === 'cohabit';
-}
-
-// export function findCommuneMemberInfo(
-// 	members: readonly ITeamMemberInfo[],
-// 	member: { readonly id?: string; readonly userID?: string },
-// ): ITeamMemberInfo | undefined {
-// 	return (
-// 		members &&
-// 		members.find(
-// 			(m) =>
-// 				(m && !!m.id && m.id === member.id) ||
-// 				(!!m.userID && m.userID === member.userID),
-// 		)
-// 	);
-// }
-
-export const personalCommuneIdPrefix = 'u_';
-
-export function getUserPersonalCommuneID(userID?: string): string {
-  if (!userID) {
-    throw new Error('userID is required parameter');
-  }
-  return personalCommuneIdPrefix + userID;
-}
-
-export function isPersonalCommuneId(id: string): boolean {
-  return !!id && id.startsWith(personalCommuneIdPrefix);
-}
-
-export function isUserPersonalCommune(
-  communeID: string,
-  userID?: string,
-): boolean {
-  return !!userID && communeID === getUserPersonalCommuneID(userID);
-}
-
-// export const CommuneModel = {
-// 	getListInfoByRealId: (dto: ITeamDto, listId: string) => {
-// 		const result =
-// 			dto.listGroups &&
-// 			dto.listGroups
-// 				.map((lg) => lg.lists && lg.lists.find((l) => l.id === listId))
-// 				.find((l) => !!l);
-// 		console.log(
-// 			`CommuneModel.getListInfoByRealId(${listId})`,
-// 			dto.listGroups,
-// 			' => ',
-// 			result,
-// 		);
-// 		return result;
-// 	},
-//
-// 	getListInfoByShortId: (dto: ICommuneDto, shortListId: string) => {
-// 		console.log(
-// 			`CommuneModel.getListInfoByShortId(${shortListId})`,
-// 			dto.listGroups,
-// 		);
-// 		return (
-// 			dto.listGroups &&
-// 			dto.listGroups
-// 				.map(
-// 					(lg) => lg.lists && lg.lists.find((l) => l.shortId === shortListId),
-// 				)
-// 				.find((l) => !!l)
-// 		);
-// 	},
-// };

package/src/lib/dto-constants.spec.ts

@@ -1,7 +0,0 @@
-import { CompoundIndexSeparator } from './dto-constants';
-
-describe('dto constants', () => {
-  it('should have CompoundIndexSeparator defined', () => {
-    expect(CompoundIndexSeparator).toBe(':');
-  });
-});

package/src/lib/dto-models.ts

@@ -1,105 +0,0 @@
-import { Restriction } from './types';
-
-// import {IPersonSize} from '../ui/dto-sizechart';
-
-export interface ITitled {
-  title: string;
-}
-
-export interface ITitledRecord {
-  id?: string;
-  title?: string;
-}
-
-export interface ITitledRecordInfo {
-  id: string;
-  title: string;
-}
-
-// | MemberRoleWork;
-
-export interface DtoTotal {
-  count: number;
-  day?: number;
-  week?: number;
-  month?: number;
-  quarter?: number;
-  year?: number;
-}
-
-export interface IDemoRecord {
-  id?: string;
-  isDemo?: boolean;
-  isLocal?: boolean;
-}
-
-export interface ITotalsHolder {
-  totals?: DtoTotals;
-}
-
-export interface DtoTotals {
-  incomes?: DtoTotal;
-  expenses?: DtoTotal;
-}
-
-// export interface Category extends ITitledRecord {
-//     id: string;
-// }
-
-export interface IWithSpaceIDs {
-  spaceIDs?: string[];
-}
-
-export interface IWithTag {
-  tags?: string[];
-}
-
-export interface IWithAssetIDs {
-  assetIDs?: string[];
-}
-
-export interface IWithMemberIDs {
-  memberIDs?: string[];
-}
-
-export interface IRealEstate {
-  leaseExpires?: string;
-}
-
-export interface IWithRestrictions {
-  restrictions?: Restriction[];
-}
-
-function newTotal(): DtoTotal {
-  return { count: 0, day: 0, week: 0, month: 0, quarter: 0, year: 0 };
-}
-
-export function newTotals(): DtoTotals {
-  // TODO: Rename to ITotalsDto
-  return { incomes: newTotal(), expenses: newTotal() };
-}
-
-export function zeroIfEmptyTotals(totals: DtoTotals): DtoTotals {
-  const f = (t?: DtoTotal) =>
-    t
-      ? {
-          count: t.count || 0,
-          day: t.day || 0,
-          week: t.week || 0,
-          month: t.month || 0,
-          quarter: t.quarter || 0,
-          year: t.year || 0,
-        }
-      : newTotal();
-  totals.incomes = f(totals.incomes);
-  totals.expenses = f(totals.expenses);
-  return totals;
-}
-
-export interface IVerification {
-  isVerified?: boolean;
-  verification?: {
-    confirmedBy?: string[]; // List of ID of users who confirmed validity of the member
-    rejectedBy?: string[]; // List of ID of users who questions validity of the member
-  };
-}

package/src/lib/dto-pricing.ts

@@ -1,5 +0,0 @@
-export interface IPrice {
-  title?: string;
-  amount: number;
-  currency?: 'EUR' | 'RUB' | 'USD';
-}

package/src/lib/dto-team-brief.ts

@@ -1,20 +0,0 @@
-import { SpaceType } from '@sneat/core';
-
-export interface ISpaceBrief {
-  readonly title: string;
-  readonly type: SpaceType;
-  readonly parentSpaceID?: string;
-  readonly roles?: string[];
-}
-
-export const equalSpaceBriefs = (
-  v1?: ISpaceBrief | null | undefined,
-  v2?: ISpaceBrief | null | undefined,
-): boolean => {
-  if (v1 === v2) return true;
-  return v1?.parentSpaceID === v2?.parentSpaceID && v1?.title === v2?.title;
-};
-
-export const isSpaceSupportsMemberGroups = (t: SpaceType): boolean => {
-  return t === 'educator' || t === 'sport_club' || t === 'cohabit';
-};

package/src/lib/dto-team-info.ts

@@ -1,15 +0,0 @@
-import { SpaceType } from '@sneat/core';
-import { IUserCommuneInfo } from './dto-user';
-
-export interface IShortSpaceInfo {
-  type: SpaceType;
-  id?: string;
-  // shortId?: CommuneShortId;
-  title?: string;
-}
-
-export function createShortCommuneInfoFromUserCommuneInfo(
-  v: IUserCommuneInfo,
-): IShortSpaceInfo {
-  return { id: v.id, title: v.title, /*shortId: v.shortId,*/ type: v.type };
-}

package/src/lib/dto-team-meeting.ts

@@ -1,6 +0,0 @@
-export interface IMeetingInfo {
-  id: string;
-  stage: string;
-  started?: string;
-  finished?: string;
-}

package/src/lib/dto-team-metric.ts

@@ -1,29 +0,0 @@
-export type MetricColor =
-  | 'primary'
-  | 'secondary'
-  | 'tertiary'
-  | 'success'
-  | 'danger'
-  | 'warning';
-
-export interface IBoolMetricVal {
-  label: string;
-  color: MetricColor;
-}
-
-export interface IBoolMetric {
-  true: IBoolMetricVal;
-  false: IBoolMetricVal;
-}
-
-export interface ISpaceMetric {
-  id?: string;
-  title: string;
-  colorTrue?: MetricColor;
-  colorFalse?: MetricColor;
-  type: 'bool' | 'integer' | 'options';
-  mode: 'personal' | 'team';
-  bool?: IBoolMetric;
-  min?: number;
-  max?: number;
-}

package/src/lib/dto-team.ts

@@ -1,27 +0,0 @@
-import { ITotalsHolder } from './dto-models';
-import { ISpaceBrief } from './dto-team-brief';
-import { ISpaceMetric } from './dto-team-metric';
-
-// export interface ITeamMeetings {
-// 	scrum?: IMemberBrief;
-// 	retrospective?: IMeetingInfo;
-// }
-
-export interface ISpaceDbo extends ISpaceBrief, ITotalsHolder {
-  readonly countryID: string;
-  readonly userIDs: string[];
-  // readonly members?: IMemberBrief[];
-  // readonly assets?: IAssetBrief[];
-  // readonly contacts?: IContactBrief[];
-  // readonly numberOf?: TeamCounts;
-  // readonly recurringHappenings?: { [id: string]: IHappeningBrief }; // TODO: Move to ISchedulusTeamDto
-
-  metrics: ISpaceMetric[];
-  // active?: ITeamMeetings;
-  // last?: ITeamMeetings;
-  upcomingRetro?: {
-    itemsByUserAndType?: Record<string, Record<string, number>>;
-  };
-
-  noContactRoles?: string[]; // lists roles that have no contacts. For example families that have no plumber contacts.
-}

package/src/lib/dto-user.ts

@@ -1,85 +0,0 @@
-// import { MemberRelationship } from './dto-member';
-import { ITitledRecord } from './dto-models';
-import { ICommuneDbo } from './dto-commune';
-import { CommuneType, CountryId } from './types';
-
-export interface IUserCommuneInfo {
-  id?: string;
-  shortId?: string;
-  title?: string;
-  type: CommuneType;
-  // members?: {
-  // 	[id: string]: {
-  // 		relatedAs: MemberRelationship;
-  // 		// title?: string;
-  // 	};
-  // };
-}
-
-export function createUserCommuneInfoFromCommuneDto(
-  communeDto: ICommuneDbo,
-  shortId?: string,
-): IUserCommuneInfo {
-  return {
-    id: communeDto.id,
-    shortId,
-    title: communeDto.title,
-    type: communeDto.type,
-  };
-}
-
-export interface IUserDbo extends ITitledRecord {
-  countryIds?: CountryId[];
-  created: {
-    hostOrApp: string;
-    at: string;
-  };
-  readonly communes?: readonly IUserCommuneInfo[]; // Returns real ID and Title, find by shortId
-  communesCount?: number;
-  isAnonymous: boolean;
-  isDemo?: boolean;
-  autogeneratedPassword?: string;
-  emailVerified?: boolean;
-  email?: string;
-  emailOriginal?: string;
-  gender?: 'male' | 'female' | 'undisclosed';
-}
-
-export function addCommuneToUserDto(
-  userDto: IUserDbo,
-  communeInfo: IUserCommuneInfo,
-): IUserDbo {
-  const communes = userDto.communes || [];
-  if (
-    communeInfo.id &&
-    communes.find((c) => !!c.id && !!communeInfo.id && c.id === communeInfo.id)
-  ) {
-    throw new Error(`Can't add commune with duplicate id: ${communeInfo.id}`);
-  }
-  return {
-    ...userDto,
-    communes: [...communes, communeInfo],
-    communesCount: communes.length + 1,
-  };
-}
-
-export class UserModel {
-  public static getCommuneInfoByShortId(
-    id: string,
-    communes?: readonly IUserCommuneInfo[],
-  ): IUserCommuneInfo | undefined {
-    return communes && communes.find((c) => c.shortId === id);
-  }
-
-  public static getCommuneInfoById(
-    id: string,
-    communes: readonly IUserCommuneInfo[],
-  ): IUserCommuneInfo | undefined {
-    const ci =
-      communes && communes.find((c) => c.shortId === id || c.id === id);
-    if (!ci && id === 'family') {
-      return { type: 'family', shortId: 'family', title: 'Family' };
-    }
-    return ci;
-  }
-}

package/src/lib/dto-with-modified.ts

@@ -1,32 +0,0 @@
-export interface timestamp {
-  seconds: number;
-  nanoseconds: number;
-}
-export const emptyTimestamp: timestamp = { seconds: 0, nanoseconds: 0 };
-
-export interface IWithCreatedShort {
-  readonly at: string;
-  readonly by: string;
-}
-
-export interface IWithCreatedOn {
-  readonly createdOn: string;
-}
-
-export interface IWithCreated {
-  readonly createdAt: timestamp;
-  readonly createdBy: string;
-}
-
-export interface IWithUpdated {
-  readonly updatedAt: timestamp;
-  readonly updatedBy: string;
-}
-
-export interface IWithDeleted {
-  readonly deletedAt?: timestamp;
-  readonly deletedBy?: string;
-}
-
-export interface IWithModified
-  extends IWithCreated, IWithUpdated, IWithDeleted {}

package/src/lib/types.ts

@@ -1,34 +0,0 @@
-import { SpaceType } from '@sneat/core';
-
-export { SpaceMemberType } from '@sneat/auth-models';
-
-export type Restriction = 'adults_only' | 'personal' | string;
-
-export type SneatRecordStatus = 'active' | 'archived' | 'deleted';
-
-export type CommuneType = SpaceType;
-
-export type CountryId =
-  | 'IE'
-  | 'US'
-  | 'UK'
-  | 'RU'
-  | 'FR'
-  | 'ES'
-  | 'AU'
-  | 'ZA'
-  | string;
-
-export type CommuneItemCounter =
-  | 'activities'
-  | 'assets'
-  | 'assetGroups'
-  | 'contacts'
-  | 'documents'
-  | 'liabilities'
-  | 'members'
-  | 'memberGroups'
-  | 'overdues'
-  | 'regularTasks'
-  | 'todos'
-  | 'upcomings';

package/src/lib/ui-state.ts

@@ -1,5 +0,0 @@
-export interface UiState {
-  readonly isAdding?: boolean;
-  readonly isDeleting?: boolean;
-  readonly isReordering?: boolean;
-}