@abyss-project/tools 1.0.0

package/dist/types/interface/models/index.js

@@ -0,0 +1,44 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./user.dto"), exports);
+__exportStar(require("./organization.dto"), exports);
+__exportStar(require("./project.dto"), exports);
+__exportStar(require("./atlas.dto"), exports);
+__exportStar(require("./atlas-document.dto"), exports);
+__exportStar(require("./atlas-group.dto"), exports);
+__exportStar(require("./atlas-page.dto"), exports);
+__exportStar(require("./atlas-page-content.dto"), exports);
+__exportStar(require("./draw.dto"), exports);
+__exportStar(require("./memo.dto"), exports);
+__exportStar(require("./retrospective.dto"), exports);
+__exportStar(require("./retrospective-section.dto"), exports);
+__exportStar(require("./retrospective-card.dto"), exports);
+__exportStar(require("./retrospective-member.dto"), exports);
+__exportStar(require("./short-link.dto"), exports);
+__exportStar(require("./short-link-click.dto"), exports);
+__exportStar(require("./board.dto"), exports);
+__exportStar(require("./board-activity.dto"), exports);
+__exportStar(require("./board-card.dto"), exports);
+__exportStar(require("./board-card-checklist.dto"), exports);
+__exportStar(require("./board-card-checklist-row.dto"), exports);
+__exportStar(require("./board-card-comment.dto"), exports);
+__exportStar(require("./board-card-document.dto"), exports);
+__exportStar(require("./board-card-label.dto"), exports);
+__exportStar(require("./board-card-member.dto"), exports);
+__exportStar(require("./board-column.dto"), exports);
+__exportStar(require("./board-label.dto"), exports);
+__exportStar(require("./user-tag.dto"), exports);

package/dist/types/interface/models/memo.dto.d.ts

@@ -0,0 +1,19 @@
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IEntityUserTag } from './user-tag.dto';
+import { IUser } from './user.dto';
+export interface IMemo {
+    id: string;
+    title: string;
+    content: string;
+    userId: string | null;
+    projectId: string | null;
+    organizationId: string | null;
+    archivedAt?: Date | null;
+    updatedAt?: Date;
+    createdAt?: Date;
+    user?: IUser | null;
+    project?: IProject | null;
+    organization?: IOrganization | null;
+    entityUserTags?: IEntityUserTag[];
+}

package/dist/types/interface/models/memo.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/organization.dto.d.ts

@@ -0,0 +1,9 @@
+import { IProject } from './project.dto';
+export interface IOrganization {
+    id?: string;
+    name: string;
+    slug: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    projects?: IProject[];
+}

package/dist/types/interface/models/organization.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/project.dto.d.ts

@@ -0,0 +1,22 @@
+import { IAtlas } from './atlas.dto';
+import { IDraw } from './draw.dto';
+import { IMemo } from './memo.dto';
+import { IOrganization } from './organization.dto';
+import { IRetrospective } from './retrospective.dto';
+import { IShortLink } from './short-link.dto';
+import { IUser } from './user.dto';
+export interface IProject {
+    id?: string;
+    name: string;
+    userId: string;
+    organizationId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    organization?: IOrganization;
+    user?: IUser;
+    draws?: IDraw[];
+    retrospectives?: IRetrospective[];
+    atlases?: IAtlas[];
+    memos?: IMemo[];
+    shortLinks?: IShortLink[];
+}

package/dist/types/interface/models/project.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/retrospective-card.dto.d.ts

@@ -0,0 +1,14 @@
+import { IRetrospectiveMember } from './retrospective-member.dto';
+import { IRetrospective } from './retrospective.dto';
+export interface IRetrospectiveCard {
+    id: string;
+    content: string;
+    positionX: number;
+    positionY: number;
+    retrospectiveId: string;
+    retrospectiveMemberId?: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    retrospective?: IRetrospective;
+    retrospectiveMember?: IRetrospectiveMember;
+}

package/dist/types/interface/models/retrospective-card.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/retrospective-member.dto.d.ts

@@ -0,0 +1,12 @@
+import { IRetrospective } from './retrospective.dto';
+export interface IRetrospectiveMember {
+    id: string;
+    alias: string | null;
+    userId: string | null;
+    externalUserId: string | null;
+    unmaskedAt: Date | null;
+    retrospectiveId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    retrospective?: IRetrospective;
+}

package/dist/types/interface/models/retrospective-member.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/retrospective-section.dto.d.ts

@@ -0,0 +1,13 @@
+import { IRetrospective } from './retrospective.dto';
+export interface IRetrospectiveSection {
+    id: string;
+    title: string;
+    description: string;
+    color: string;
+    positionX: number;
+    positionY: number;
+    retrospectiveId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    retrospective?: IRetrospective;
+}

package/dist/types/interface/models/retrospective-section.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/retrospective.dto.d.ts

@@ -0,0 +1,29 @@
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IRetrospectiveCard } from './retrospective-card.dto';
+import { IRetrospectiveMember } from './retrospective-member.dto';
+import { IRetrospectiveSection } from './retrospective-section.dto';
+import { IEntityUserTag } from './user-tag.dto';
+import { IUser } from './user.dto';
+export interface IRetrospective {
+    id: string;
+    title: string;
+    description: string;
+    startDate: Date | null;
+    endDate: Date | null;
+    completedAt: Date | null;
+    userId: string | null;
+    projectId: string | null;
+    organizationId: string | null;
+    archivedAt: Date | null;
+    publicAccessToken: string | null;
+    updatedAt?: Date;
+    createdAt?: Date;
+    user?: IUser | null;
+    project?: IProject | null;
+    organization?: IOrganization | null;
+    retrospectiveSections?: IRetrospectiveSection[];
+    retrospectiveCards?: IRetrospectiveCard[];
+    retrospectiveMembers?: IRetrospectiveMember[];
+    entityUserTags?: IEntityUserTag[];
+}

package/dist/types/interface/models/retrospective.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/short-link-click.dto.d.ts

@@ -0,0 +1,30 @@
+import { IShortLink } from './short-link.dto';
+export interface IShortLinkClick {
+    id: string;
+    shortLinkId: string;
+    ipAddress: string | null;
+    ipHash: string;
+    userAgent: string | null;
+    referer: string | null;
+    refererDomain: string | null;
+    countryCodeIso: string | null;
+    countryCode: string | null;
+    countryName: string | null;
+    continentCode: string | null;
+    city: string | null;
+    device: string | null;
+    browser: string | null;
+    os: string | null;
+    language: string | null;
+    utmSource: string | null;
+    utmMedium: string | null;
+    utmCampaign: string | null;
+    utmTerm: string | null;
+    utmContent: string | null;
+    isBotLikely: boolean;
+    isReturningVisitor: boolean;
+    clickedAt: Date;
+    createdAt?: Date;
+    updatedAt?: Date;
+    shortLink?: IShortLink;
+}

package/dist/types/interface/models/short-link-click.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/short-link.dto.d.ts

@@ -0,0 +1,71 @@
+import { IOrganization } from './organization.dto';
+import { IUser } from './user.dto';
+import { IProject } from './project.dto';
+import { IShortLinkClick } from './short-link-click.dto';
+import { IEntityUserTag } from './user-tag.dto';
+export interface IShortLink {
+    id: string;
+    slug: string;
+    originalUrl: string;
+    title: string | null;
+    description: string | null;
+    userId: string | null;
+    projectId: string | null;
+    organizationId: string | null;
+    isActive: boolean;
+    clickCount: number;
+    uniqueClickCount: number;
+    lastClickedAt: Date | null;
+    expiresAt: Date | null;
+    maxClicks: number | null;
+    password: string | null;
+    createdAt?: Date;
+    updatedAt?: Date;
+    deletedAt?: Date | null;
+    user?: IUser | null;
+    project?: IProject | null;
+    organization?: IOrganization | null;
+    shortLinkClicks?: IShortLinkClick[];
+    entityUserTags?: IEntityUserTag[];
+}
+export interface IShortLinkWithStats extends IShortLink {
+    stats?: {
+        clicksByDay: {
+            date: string;
+            clicks: number;
+            uniqueClicks: number;
+        }[];
+        clicksByCountry: {
+            country: string;
+            clicks: number;
+            countryName: string;
+        }[];
+        clicksByDevice: {
+            device: string;
+            clicks: number;
+        }[];
+        clicksByBrowser: {
+            browser: string;
+            clicks: number;
+        }[];
+        clicksByReferer: {
+            referer: string;
+            clicks: number;
+        }[];
+        clicksByUtmSource: {
+            utmSource: string;
+            clicks: number;
+        }[];
+        clicksByLanguage: {
+            language: string;
+            clicks: number;
+        }[];
+        clicksByRefererDomain: {
+            refererDomain: string;
+            clicks: number;
+        }[];
+        clicksLast24h: number;
+        returningVisitorsCount: number;
+        botClicksCount: number;
+    };
+}

package/dist/types/interface/models/short-link.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/user-tag.dto.d.ts

@@ -0,0 +1,22 @@
+export interface IUserTag {
+    id: string;
+    name: string;
+    color: string;
+    userId: string;
+    organizationId: string | null;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface IEntityUserTag {
+    id: string;
+    entityId: string;
+    entityType: string;
+    userTagId: string;
+    createdAt?: Date;
+    userTag?: IUserTag | null;
+}
+export interface IUserTagStatEntry {
+    userTagId: string;
+    entityType: string;
+    count: number;
+}

package/dist/types/interface/models/user-tag.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/models/user.dto.d.ts

@@ -0,0 +1,23 @@
+import { IAtlas } from './atlas.dto';
+import { IBoard } from './board.dto';
+import { IBoardCardComment } from './board-card-comment.dto';
+import { IDraw } from './draw.dto';
+import { IMemo } from './memo.dto';
+import { IProject } from './project.dto';
+import { IRetrospective } from './retrospective.dto';
+import { IShortLink } from './short-link.dto';
+export interface IUser {
+    id?: string;
+    apiKey: string;
+    isAdmin: boolean;
+    updatedAt?: Date;
+    createdAt?: Date;
+    projects?: IProject[];
+    boards?: IBoard[];
+    draws?: IDraw[];
+    retrospectives?: IRetrospective[];
+    atlases?: IAtlas[];
+    memos?: IMemo[];
+    shortLinks?: IShortLink[];
+    boardCardComments?: IBoardCardComment[];
+}

package/dist/types/interface/models/user.dto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/board.utils.d.ts

@@ -0,0 +1,5 @@
+import { BoardColumnType, IBoardCard } from '../types';
+export declare const isCardStartDateLate: (boardCard: IBoardCard, boardColumnType: BoardColumnType) => boolean;
+export declare const isAlmostCardStartDateLate: (boardCard: IBoardCard, boardColumnType: BoardColumnType) => boolean;
+export declare const isCardEndDateLate: (boardCard: IBoardCard, boardColumnType: BoardColumnType) => boolean;
+export declare const isAlmostCardEndDateLate: (boardCard: IBoardCard, boardColumnType: BoardColumnType) => boolean;

package/dist/utils/board.utils.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAlmostCardEndDateLate = exports.isCardEndDateLate = exports.isAlmostCardStartDateLate = exports.isCardStartDateLate = void 0;
+const date_fns_1 = require("date-fns");
+const types_1 = require("../types");
+const BOARD_COLUMN_TYPE_STARTED = [types_1.BoardColumnType.DOING, types_1.BoardColumnType.DONE];
+const BOARD_COLUMN_TYPE_DONE = [types_1.BoardColumnType.DONE];
+const isCardStartDateLate = (boardCard, boardColumnType) => {
+    if (!boardCard.startDate) {
+        return false;
+    }
+    return ((0, date_fns_1.isBefore)(new Date(boardCard.startDate), new Date()) &&
+        !BOARD_COLUMN_TYPE_STARTED.includes(boardColumnType));
+};
+exports.isCardStartDateLate = isCardStartDateLate;
+const isAlmostCardStartDateLate = (boardCard, boardColumnType) => {
+    if (!boardCard.startDate) {
+        return false;
+    }
+    return (!(0, exports.isCardStartDateLate)(boardCard, boardColumnType) &&
+        (0, date_fns_1.differenceInCalendarDays)(new Date(boardCard.startDate), new Date()) <= 2);
+};
+exports.isAlmostCardStartDateLate = isAlmostCardStartDateLate;
+const isCardEndDateLate = (boardCard, boardColumnType) => {
+    if (!boardCard.endDate) {
+        return false;
+    }
+    return ((0, date_fns_1.isBefore)(new Date(boardCard.endDate), new Date()) &&
+        !BOARD_COLUMN_TYPE_DONE.includes(boardColumnType));
+};
+exports.isCardEndDateLate = isCardEndDateLate;
+const isAlmostCardEndDateLate = (boardCard, boardColumnType) => {
+    if (!boardCard.endDate) {
+        return false;
+    }
+    return (!(0, exports.isCardEndDateLate)(boardCard, boardColumnType) &&
+        Math.abs((0, date_fns_1.differenceInCalendarDays)(new Date(boardCard.endDate), new Date())) <= 2);
+};
+exports.isAlmostCardEndDateLate = isAlmostCardEndDateLate;

package/dist/utils/enum.utils.d.ts

@@ -0,0 +1 @@
+export declare const enumToArray: (enums: any) => string[];

package/dist/utils/enum.utils.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enumToArray = void 0;
+const enumToArray = (enums) => {
+    return Object.keys(enums).map((type) => {
+        return enums[type];
+    });
+};
+exports.enumToArray = enumToArray;

package/dist/utils/error.utils.d.ts

@@ -0,0 +1,15 @@
+import { Code, ErrorType } from '../types';
+type ErrorParams = {
+    code: Code;
+    type: ErrorType;
+    message?: string;
+};
+export declare class ServiceException extends Error {
+    private readonly code;
+    private readonly type;
+    getCode(): Code;
+    getType(): ErrorType;
+    constructor(params: ErrorParams);
+}
+export declare const handleError: (error: Error | ErrorParams, _params?: ErrorParams) => Error;
+export {};

package/dist/utils/error.utils.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleError = exports.ServiceException = void 0;
+class ServiceException extends Error {
+    getCode() {
+        return this.code;
+    }
+    getType() {
+        return this.type;
+    }
+    constructor(params) {
+        super(params.message);
+        this.code = params.code;
+        this.type = params.type;
+    }
+}
+exports.ServiceException = ServiceException;
+const handleError = (error, _params) => {
+    if (error instanceof Error) {
+        return error;
+    }
+    return new ServiceException(error);
+};
+exports.handleError = handleError;

package/dist/utils/icons.utils.d.ts

@@ -0,0 +1,75 @@
+export declare const ICON_LIBRARY: {
+    database: string;
+    server: string;
+    cloud: string;
+    network: string;
+    router: string;
+    security: string;
+    warning: string;
+    error: string;
+    success: string;
+    info: string;
+    diamond: string;
+    gear: string;
+    tool: string;
+    wrench: string;
+    arrowUp: string;
+    arrowDown: string;
+    arrowLeft: string;
+    arrowRight: string;
+    arrowUpRight: string;
+    arrowDownRight: string;
+    arrowDownLeft: string;
+    arrowUpLeft: string;
+    start: string;
+    stop: string;
+    pause: string;
+    play: string;
+    process: string;
+    email: string;
+    phone: string;
+    message: string;
+    notification: string;
+    document: string;
+    folder: string;
+    file: string;
+    pdf: string;
+    image: string;
+    user: string;
+    users: string;
+    team: string;
+    admin: string;
+    add: string;
+    remove: string;
+    edit: string;
+    search: string;
+    filter: string;
+    sort: string;
+    online: string;
+    offline: string;
+    pending: string;
+    unknown: string;
+    circle: string;
+    square: string;
+    triangle: string;
+    star: string;
+    heart: string;
+    settings: string;
+    power: string;
+    battery: string;
+    wifi: string;
+    bluetooth: string;
+};
+export declare const ICON_CATEGORIES: {
+    technical: string[];
+    status: string[];
+    arrows: string[];
+    process: string[];
+    communication: string[];
+    files: string[];
+    users: string[];
+    actions: string[];
+    shapes: string[];
+    system: string[];
+};
+export type IconType = keyof typeof ICON_LIBRARY;

package/dist/utils/icons.utils.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ICON_CATEGORIES = exports.ICON_LIBRARY = void 0;
+exports.ICON_LIBRARY = {
+    database: '🗄️',
+    server: '🖥️',
+    cloud: '☁️',
+    network: '🌐',
+    router: '📡',
+    security: '🔒',
+    warning: '⚠️',
+    error: '❌',
+    success: '✅',
+    info: 'ℹ️',
+    diamond: '💎',
+    gear: '⚙️',
+    tool: '🔧',
+    wrench: '🔨',
+    arrowUp: '⬆️',
+    arrowDown: '⬇️',
+    arrowLeft: '⬅️',
+    arrowRight: '➡️',
+    arrowUpRight: '↗️',
+    arrowDownRight: '↘️',
+    arrowDownLeft: '↙️',
+    arrowUpLeft: '↖️',
+    start: '🚀',
+    stop: '🛑',
+    pause: '⏸️',
+    play: '▶️',
+    process: '⚡',
+    email: '📧',
+    phone: '📞',
+    message: '💬',
+    notification: '🔔',
+    document: '📄',
+    folder: '📁',
+    file: '📋',
+    pdf: '📕',
+    image: '🖼️',
+    user: '👤',
+    users: '👥',
+    team: '👪',
+    admin: '👨‍💼',
+    add: '➕',
+    remove: '➖',
+    edit: '✏️',
+    search: '🔍',
+    filter: '🔽',
+    sort: '📊',
+    online: '🟢',
+    offline: '🔴',
+    pending: '🟡',
+    unknown: '⚪',
+    circle: '⭕',
+    square: '⬜',
+    triangle: '🔺',
+    star: '⭐',
+    heart: '❤️',
+    settings: '⚙️',
+    power: '🔌',
+    battery: '🔋',
+    wifi: '📶',
+    bluetooth: '📲',
+};
+exports.ICON_CATEGORIES = {
+    technical: ['database', 'server', 'cloud', 'network', 'router', 'security'],
+    status: ['warning', 'error', 'success', 'info', 'online', 'offline', 'pending', 'unknown'],
+    arrows: [
+        'arrowUp',
+        'arrowDown',
+        'arrowLeft',
+        'arrowRight',
+        'arrowUpRight',
+        'arrowDownRight',
+        'arrowDownLeft',
+        'arrowUpLeft',
+    ],
+    process: ['start', 'stop', 'pause', 'play', 'process', 'gear', 'tool', 'wrench'],
+    communication: ['email', 'phone', 'message', 'notification'],
+    files: ['document', 'folder', 'file', 'pdf', 'image'],
+    users: ['user', 'users', 'team', 'admin'],
+    actions: ['add', 'remove', 'edit', 'search', 'filter', 'sort'],
+    shapes: ['circle', 'square', 'triangle', 'star', 'heart', 'diamond'],
+    system: ['settings', 'power', 'battery', 'wifi', 'bluetooth'],
+};

package/dist/utils/index.d.ts

@@ -0,0 +1,5 @@
+export * from './error.utils';
+export * from './board.utils';
+export * from './shape.utils';
+export * from './icons.utils';
+export * from './enum.utils';

package/dist/utils/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./error.utils"), exports);
+__exportStar(require("./board.utils"), exports);
+__exportStar(require("./shape.utils"), exports);
+__exportStar(require("./icons.utils"), exports);
+__exportStar(require("./enum.utils"), exports);