@sneat/dto 0.1.3 → 0.1.6

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

@@ -0,0 +1,9 @@
+import { SpaceType } from '@sneat/core';
+export interface ISpaceBrief {
+    readonly title: string;
+    readonly type: SpaceType;
+    readonly parentSpaceID?: string;
+    readonly roles?: string[];
+}
+export declare const equalSpaceBriefs: (v1?: ISpaceBrief | null | undefined, v2?: ISpaceBrief | null | undefined) => boolean;
+export declare const isSpaceSupportsMemberGroups: (t: SpaceType) => boolean;

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

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

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

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

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

@@ -0,0 +1,20 @@
+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/lib/dto-team.d.ts

@@ -0,0 +1,12 @@
+import { ITotalsHolder } from './dto-models';
+import { ISpaceBrief } from './dto-team-brief';
+import { ISpaceMetric } from './dto-team-metric';
+export interface ISpaceDbo extends ISpaceBrief, ITotalsHolder {
+    readonly countryID: string;
+    readonly userIDs: string[];
+    metrics: ISpaceMetric[];
+    upcomingRetro?: {
+        itemsByUserAndType?: Record<string, Record<string, number>>;
+    };
+    noContactRoles?: string[];
+}

package/lib/dto-user.d.ts

@@ -0,0 +1,31 @@
+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;
+}
+export declare function createUserCommuneInfoFromCommuneDto(communeDto: ICommuneDbo, shortId?: string): IUserCommuneInfo;
+export interface IUserDbo extends ITitledRecord {
+    countryIds?: CountryId[];
+    created: {
+        hostOrApp: string;
+        at: string;
+    };
+    readonly communes?: readonly IUserCommuneInfo[];
+    communesCount?: number;
+    isAnonymous: boolean;
+    isDemo?: boolean;
+    autogeneratedPassword?: string;
+    emailVerified?: boolean;
+    email?: string;
+    emailOriginal?: string;
+    gender?: 'male' | 'female' | 'undisclosed';
+}
+export declare function addCommuneToUserDto(userDto: IUserDbo, communeInfo: IUserCommuneInfo): IUserDbo;
+export declare class UserModel {
+    static getCommuneInfoByShortId(id: string, communes?: readonly IUserCommuneInfo[]): IUserCommuneInfo | undefined;
+    static getCommuneInfoById(id: string, communes: readonly IUserCommuneInfo[]): IUserCommuneInfo | undefined;
+}

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

@@ -0,0 +1,26 @@
+export interface timestamp {
+    seconds: number;
+    nanoseconds: number;
+}
+export declare const emptyTimestamp: timestamp;
+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/lib/types.d.ts

@@ -0,0 +1,7 @@
+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/lib/ui-state.d.ts

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

package/lib/with-related.d.ts

@@ -0,0 +1,42 @@
+import { IWithCreatedShort } from './dto-with-modified';
+export interface IRelatedItemKey {
+    readonly itemID: string;
+    readonly spaceID?: string;
+}
+export interface ISpaceModuleItemRef {
+    readonly module: string;
+    readonly collection: string;
+    readonly spaceID: string;
+    readonly itemID: string;
+}
+export interface IRelationshipRole {
+    readonly created: IWithCreatedShort;
+}
+export type WritableRelationshipRoles = Record<string, IRelationshipRole>;
+export type IRelationshipRoles = Readonly<WritableRelationshipRoles>;
+export interface IRelatedItem {
+    readonly rolesOfItem?: IRelationshipRoles;
+    readonly rolesToItem?: IRelationshipRoles;
+}
+export type IRelatedItems = Readonly<Record<string, IRelatedItem>>;
+export type IRelatedCollections = Readonly<Record<string, IRelatedItems>>;
+export type IRelatedModules = Readonly<Record<string, IRelatedCollections>>;
+export interface IRelatedTo extends IWithRelatedOnly {
+    readonly key: ISpaceModuleItemRef;
+    readonly title: string;
+}
+export declare function getRelatedItems(moduleId: string, collectionId: string, related?: IRelatedModules): IRelatedItems;
+export interface IWithRelatedOnly {
+    readonly related?: IRelatedModules;
+}
+export declare function validateRelated(related?: IRelatedModules): void;
+export interface IWithRelatedAndRelatedIDs extends IWithRelatedOnly {
+    readonly relatedIDs?: readonly string[];
+}
+export declare const addRelatedItem: (related: IRelatedModules | undefined, key: ISpaceModuleItemRef, rolesOfItem?: IRelationshipRoles) => Readonly<Record<string, Readonly<Record<string, Readonly<Record<string, IRelatedItem>>>>>>;
+export declare const removeRelatedItem: (related: IRelatedModules | undefined, key: ISpaceModuleItemRef) => Readonly<Record<string, Readonly<Record<string, Readonly<Record<string, IRelatedItem>>>>>> | undefined;
+export declare const getLongRelatedItemID: (itemID: string, spaceID: string) => string;
+export declare const getRelatedItemByIDs: (relatedItems: Readonly<Record<string, IRelatedItem>> | undefined, itemID: string, spaceID?: string) => IRelatedItem | undefined;
+export declare const getRelatedItemByKey: (related: IRelatedModules | undefined, key: ISpaceModuleItemRef) => IRelatedItem | undefined;
+export declare const getRelatedItemIDs: (related: IRelatedModules | undefined, module: string, collection: string, spaceID?: string) => readonly string[];
+export declare const hasRelated: (related: IRelatedModules | undefined, key: ISpaceModuleItemRef) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sneat/dto",
-  "version": "0.1.3",
+  "version": "0.1.6",
   "publishConfig": {
     "access": "public"
   },
@@ -10,5 +10,17 @@
   },
   "dependencies": {
     "tslib": "2.8.1"
-  }
+  },
+  "module": "esm2022/sneat-dto.js",
+  "typings": "sneat-dto.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./sneat-dto.d.ts",
+      "default": "./esm2022/sneat-dto.js"
+    }
+  },
+  "sideEffects": false
 }

package/sneat-dto.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Generated bundle index. Do not edit.
+ */
+/// <amd-module name="@sneat/dto" />
+export * from './index';