@abyss-project/tools 1.0.0

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

@@ -0,0 +1,33 @@
+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;
+  /** Code pays ISO-3 (ex: "FRA", "USA", "DEU") */
+  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/src/types/interface/models/short-link.dto.ts

@@ -0,0 +1,48 @@
+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/src/types/interface/models/user-tag.dto.ts

@@ -0,0 +1,26 @@
+export interface IUserTag {
+  id: string;
+  name: string;
+  color: string;
+  userId: string;
+  organizationId: string | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+// Junction type for entity-tag relationships
+export interface IEntityUserTag {
+  id: string;
+  entityId: string;
+  entityType: string;
+  userTagId: string;
+  createdAt?: Date;
+  userTag?: IUserTag | null;
+}
+
+// Stats entry for tag usage counts
+export interface IUserTagStatEntry {
+  userTagId: string;
+  entityType: string;
+  count: number;
+}

package/src/types/interface/models/user.dto.ts

@@ -0,0 +1,26 @@
+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;
+
+  // Associations
+  projects?: IProject[];
+  boards?: IBoard[];
+  draws?: IDraw[];
+  retrospectives?: IRetrospective[];
+  atlases?: IAtlas[];
+  memos?: IMemo[];
+  shortLinks?: IShortLink[];
+  boardCardComments?: IBoardCardComment[];
+}

package/src/utils/board.utils.ts

@@ -0,0 +1,57 @@
+import { differenceInCalendarDays, isBefore } from 'date-fns';
+import { BoardColumnType, IBoardCard } from '../types';
+
+const BOARD_COLUMN_TYPE_STARTED = [BoardColumnType.DOING, BoardColumnType.DONE];
+const BOARD_COLUMN_TYPE_DONE = [BoardColumnType.DONE];
+
+export const isCardStartDateLate = (
+  boardCard: IBoardCard,
+  boardColumnType: BoardColumnType,
+): boolean => {
+  if (!boardCard.startDate) {
+    return false;
+  }
+  return (
+    isBefore(new Date(boardCard.startDate), new Date()) &&
+    !BOARD_COLUMN_TYPE_STARTED.includes(boardColumnType)
+  );
+};
+
+export const isAlmostCardStartDateLate = (
+  boardCard: IBoardCard,
+  boardColumnType: BoardColumnType,
+): boolean => {
+  if (!boardCard.startDate) {
+    return false;
+  }
+  return (
+    !isCardStartDateLate(boardCard, boardColumnType) &&
+    differenceInCalendarDays(new Date(boardCard.startDate), new Date()) <= 2
+  );
+};
+
+export const isCardEndDateLate = (
+  boardCard: IBoardCard,
+  boardColumnType: BoardColumnType,
+): boolean => {
+  if (!boardCard.endDate) {
+    return false;
+  }
+  return (
+    isBefore(new Date(boardCard.endDate), new Date()) &&
+    !BOARD_COLUMN_TYPE_DONE.includes(boardColumnType)
+  );
+};
+
+export const isAlmostCardEndDateLate = (
+  boardCard: IBoardCard,
+  boardColumnType: BoardColumnType,
+): boolean => {
+  if (!boardCard.endDate) {
+    return false;
+  }
+  return (
+    !isCardEndDateLate(boardCard, boardColumnType) &&
+    Math.abs(differenceInCalendarDays(new Date(boardCard.endDate), new Date())) <= 2
+  );
+};

package/src/utils/enum.utils.ts

@@ -0,0 +1,6 @@
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+export const enumToArray = (enums: any): string[] => {
+  return Object.keys(enums).map((type) => {
+    return enums[type];
+  });
+};

package/src/utils/error.utils.ts

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

package/src/utils/icons.utils.ts

@@ -0,0 +1,96 @@
+export const 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: '📲',
+};
+
+export const 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'],
+};
+
+export type IconType = keyof typeof ICON_LIBRARY;

package/src/utils/index.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/src/utils/shape.utils.ts

@@ -0,0 +1,296 @@
+import { ICON_LIBRARY } from './icons.utils';
+import {
+  Id,
+  Point,
+  DrawSize,
+  DrawStyle,
+  DrawShapeType,
+  DrawShapeToJsonResult,
+} from '../types/draw.type';
+
+export type Endpoint = {
+  style: DrawArrowEndpointStyle;
+} & (
+  | { kind: 'free'; x: number; y: number }
+  | { kind: 'anchor'; shapeId: Id; relativeX: number; relativeY: number }
+);
+
+export type DrawArrowEndpointStyle = 'arrow' | 'circle' | 'square' | 'diamond' | 'none';
+
+export type CurvePoint = Point & {
+  type: 'straight' | 'curved'; // type de courbure: angle droit ou arrondi
+};
+
+export const rectangleToSvg = (position: Point, size: DrawSize, style: DrawStyle): string => {
+  const x = position.x - size.width / 2;
+  const y = position.y - size.height / 2;
+  const width = size.width;
+  const height = size.height;
+  const fillColor = style.fillColor === 'none' ? 'none' : style.fillColor;
+  const strokeColor = style.strokeColor === 'none' ? 'none' : style.strokeColor;
+  const centerX = position.x;
+  const centerY = position.y;
+
+  return `<rect x="${x}" y="${y}" width="${width}" height="${height}" fill="${fillColor}" stroke="${strokeColor}" stroke-width="${
+    style.strokeWidth
+  }" opacity="${style.opacity}" rx="${style.cornerRadius}" ry="${
+    style.cornerRadius
+  }" stroke-dasharray="${style.lineDash || 'none'}" transform="rotate(${
+    style.rotation
+  } ${centerX} ${centerY})" />`;
+};
+
+export const diamondToSvg = (position: Point, size: DrawSize, style: DrawStyle): string => {
+  const cx = position.x;
+  const cy = position.y;
+  const halfWidth = size.width / 2;
+  const halfHeight = size.height / 2;
+  const fillColor = style.fillColor === 'none' ? 'none' : style.fillColor;
+  const strokeColor = style.strokeColor === 'none' ? 'none' : style.strokeColor;
+
+  const points = [
+    `${cx},${cy - halfHeight}`, // Top
+    `${cx + halfWidth},${cy}`, // Right
+    `${cx},${cy + halfHeight}`, // Bottom
+    `${cx - halfWidth},${cy}`, // Left
+  ].join(' ');
+
+  return `<polygon points="${points}" fill="${fillColor}" stroke="${strokeColor}" stroke-width="${
+    style.strokeWidth
+  }" stroke-dasharray="${style.lineDash || 'none'}" opacity="${style.opacity}" transform="rotate(${
+    style.rotation
+  } ${cx} ${cy})" />`;
+};
+
+export const ellipseToSvg = (position: Point, size: DrawSize, style: DrawStyle): string => {
+  const cx = position.x;
+  const cy = position.y;
+  const radiusX = size.width / 2;
+  const radiusY = size.height / 2;
+  const fillColor = style.fillColor === 'none' ? 'none' : style.fillColor;
+  const strokeColor = style.strokeColor === 'none' ? 'none' : style.strokeColor;
+
+  return `<ellipse cx="${cx}" cy="${cy}" rx="${radiusX}" ry="${radiusY}" fill="${fillColor}" stroke="${strokeColor}" stroke-width="${
+    style.strokeWidth
+  }" opacity="${style.opacity}" stroke-dasharray="${style.lineDash || 'none'}" transform="rotate(${
+    style.rotation
+  } ${cx} ${cy})" />`;
+};
+
+export const textToSvg = (position: Point, style: DrawStyle, text: string): string => {
+  const x = position.x;
+  const y = position.y;
+  const fillColor = style.fillColor === 'none' ? 'none' : style.fillColor;
+  const strokeColor = style.strokeColor === 'none' ? 'none' : style.strokeColor;
+
+  return `<text x="${x}" y="${y}" fill="${fillColor}" stroke="${strokeColor}" stroke-width="${
+    style.strokeWidth
+  }" opacity="${style.opacity}" font-size="${style.fontSize}" font-family="${style.fontFamily}"
+  stroke-dasharray="${
+    style.lineDash || 'none'
+  }" text-anchor="middle" dominant-baseline="middle" transform="rotate(${
+    style.rotation
+  } ${x} ${y})">${text}</text>`;
+};
+
+export const iconToSvg = (
+  position: Point,
+  size: DrawSize,
+  style: DrawStyle,
+  iconSymbol: string,
+): string => {
+  const x = position.x;
+  const y = position.y;
+  const fillColor = style.fillColor === 'none' ? 'none' : style.fillColor;
+  const strokeColor = style.strokeColor === 'none' ? 'none' : style.strokeColor;
+  const fontSize = Math.min(size.width, size.height) * 0.8;
+
+  return `<text x="${x}" y="${y}" fill="${fillColor}" stroke="${strokeColor}" stroke-width="${style.strokeWidth}" opacity="${style.opacity}" font-size="${fontSize}" font-family="Arial" text-anchor="middle" dominant-baseline="middle" transform="rotate(${style.rotation} ${x} ${y})">${iconSymbol}</text>`;
+};
+
+export const imageToSvg = (
+  position: Point,
+  size: DrawSize,
+  style: DrawStyle,
+  src: string,
+): string => {
+  const x = position.x - size.width / 2;
+  const y = position.y - size.height / 2;
+  const width = size.width;
+  const height = size.height;
+  const strokeColor = style.strokeColor === 'none' ? 'none' : style.strokeColor;
+  const centerX = position.x;
+  const centerY = position.y;
+
+  return `<image x="${x}" y="${y}" width="${width}" height="${height}" href="${src}" opacity="${style.opacity}" stroke="${strokeColor}" stroke-width="${style.strokeWidth}" rx="${style.cornerRadius}" ry="${style.cornerRadius}" transform="rotate(${style.rotation} ${centerX} ${centerY})" />`;
+};
+
+export const commentToSvg = (
+  position: Point,
+  size: DrawSize,
+  style: DrawStyle,
+  id: string,
+): string => {
+  const cx = position.x;
+  const cy = position.y;
+  const radius = size.width / 2;
+  const fillColor = style.fillColor === 'none' ? 'transparent' : style.fillColor;
+  const strokeColor = style.strokeColor === 'none' ? 'none' : style.strokeColor;
+  const fontSize = size.width * 0.6;
+
+  // Calculate text position to center the "!" character
+  const textX = cx;
+  const textY = cy + fontSize * 0.35; // Adjust for vertical centering
+
+  return `
+    <g opacity="${style.opacity}" transform="rotate(${style.rotation} ${cx} ${cy})">
+      <defs>
+        <filter id="comment-shadow-${id}" x="-50%" y="-50%" width="200%" height="200%">
+          <feDropShadow dx="2" dy="2" stdDeviation="5" flood-color="black" flood-opacity="0.3"/>
+        </filter>
+      </defs>
+      <circle cx="${cx}" cy="${cy}" r="${radius}" fill="${fillColor}" stroke="${strokeColor}" stroke-width="${style.strokeWidth}" filter="url(#comment-shadow-${id})" />
+      <text x="${textX}" y="${textY}" fill="white" font-size="${fontSize}" font-family="Arial" text-anchor="middle" dominant-baseline="middle" font-weight="bold">!</text>
+    </g>`;
+};
+
+const renderEndpointStyleSvg = (
+  x: number,
+  y: number,
+  style: DrawArrowEndpointStyle,
+  angle: number,
+  strokeColor: string,
+  fillColor: string,
+  strokeWidth: number,
+): string => {
+  switch (style) {
+    case 'circle':
+      return `<circle cx="${x}" cy="${y}" r="6" fill="${fillColor}" stroke="${strokeColor}" stroke-width="${strokeWidth}" />`;
+
+    case 'square':
+      const squareX = x - 6;
+      const squareY = y - 6;
+      return `<rect x="${squareX}" y="${squareY}" width="12" height="12" fill="${fillColor}" stroke="${strokeColor}" stroke-width="${strokeWidth}" transform="rotate(${
+        angle * (180 / Math.PI)
+      } ${x} ${y})" />`;
+
+    case 'diamond':
+      return `<polygon points="${x},${y - 6} ${x + 6},${y} ${x},${y + 6} ${
+        x - 6
+      },${y}" fill="${fillColor}" stroke="${strokeColor}" stroke-width="${strokeWidth}" transform="rotate(${
+        angle * (180 / Math.PI)
+      } ${x} ${y})" />`;
+
+    case 'arrow':
+      const arrowSize = 8;
+      const x1 = x - arrowSize * Math.cos(angle - Math.PI / 6);
+      const y1 = y - arrowSize * Math.sin(angle - Math.PI / 6);
+      const x2 = x - arrowSize * Math.cos(angle + Math.PI / 6);
+      const y2 = y - arrowSize * Math.sin(angle + Math.PI / 6);
+      return `<polygon points="${x},${y} ${x1},${y1} ${x2},${y2}" fill="${fillColor}" stroke="${strokeColor}" stroke-width="${strokeWidth}" />`;
+
+    case 'none':
+    default:
+      return '';
+  }
+};
+
+export const arrowToSvg = (
+  style: DrawStyle,
+  startEndpoint: Endpoint,
+  endEndpoint: Endpoint,
+  fromPos: Point,
+  toPos: Point,
+): string => {
+  const angle = Math.atan2(toPos.y - fromPos.y, toPos.x - fromPos.x);
+
+  let svg = `<g opacity="${style.opacity}">`;
+
+  svg += `<line x1="${fromPos.x}" y1="${fromPos.y}" x2="${toPos.x}" y2="${toPos.y}" stroke="${style.strokeColor}" stroke-width="${style.strokeWidth}" />`;
+
+  svg += renderEndpointStyleSvg(
+    fromPos.x,
+    fromPos.y,
+    startEndpoint.style as DrawArrowEndpointStyle,
+    angle + Math.PI,
+    style.strokeColor,
+    style.fillColor,
+    style.strokeWidth,
+  );
+
+  svg += renderEndpointStyleSvg(
+    toPos.x,
+    toPos.y,
+    endEndpoint.style as DrawArrowEndpointStyle,
+    angle,
+    style.strokeColor,
+    style.fillColor,
+    style.strokeWidth,
+  );
+
+  svg += '</g>';
+
+  return svg;
+};
+
+export const sceneToSVG = (
+  shapes: DrawShapeToJsonResult[],
+  width: number,
+  height: number,
+): string => {
+  const shapeEls = shapes
+    .sort((a, b) => (a.zIndex || 0) - (b.zIndex || 0))
+    .map((s) => {
+      switch (s.type) {
+        case DrawShapeType.RECTANGLE:
+          return rectangleToSvg(s.position, s.size, s.style);
+        case DrawShapeType.DIAMOND:
+          return diamondToSvg(s.position, s.size, s.style);
+        case DrawShapeType.ELLIPSE:
+          return ellipseToSvg(s.position, s.size, s.style);
+        case DrawShapeType.TEXT:
+          return textToSvg(s.position, s.style, s.text || '');
+        case DrawShapeType.ICON:
+          const iconSymbol = ICON_LIBRARY[s.iconType] || '';
+          return iconToSvg(s.position, s.size, s.style, iconSymbol);
+        case DrawShapeType.IMAGE:
+          return imageToSvg(s.position, s.size, s.style, s.src);
+        case DrawShapeType.COMMENT:
+          return commentToSvg(s.position, s.size, s.style, s.id);
+        case DrawShapeType.ARROW:
+          if (s.startEndpoint && s.endEndpoint) {
+            const fromPos =
+              s.startEndpoint.kind === 'anchor'
+                ? shapes.find((shape) => shape.id === (s.startEndpoint as any)?.shapeId)?.position
+                : {
+                    x: (s.startEndpoint as any).x,
+                    y: (s.startEndpoint as any).y,
+                  };
+            const toPos =
+              s.endEndpoint.kind === 'anchor'
+                ? shapes.find((shape) => shape.id === (s.endEndpoint as any)?.shapeId)?.position
+                : {
+                    x: (s.endEndpoint as any).x,
+                    y: (s.endEndpoint as any).y,
+                  };
+            if (!fromPos || !toPos) return '';
+            return arrowToSvg(s.style, s.startEndpoint, s.endEndpoint, fromPos, toPos);
+          }
+          return '';
+        default:
+          return '';
+      }
+    });
+
+  const defs = `
+<defs>
+  <marker id="arrow" markerWidth="10" markerHeight="10" refX="10" refY="5" orient="auto-start-reverse">
+    <path d="M0,0 L10,5 L0,10 z" fill="currentColor"/>
+  </marker>
+</defs>`;
+
+  return `<svg xmlns="http://www.w3.org/2000/svg" width="${width}" height="${height}">
+  ${defs}
+  ${shapeEls.join('\n')}
+</svg>`;
+};

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "incremental": false,
+    "target": "es2019",
+    "lib": ["dom", "ES2019"],
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "module": "commonjs",
+    "rootDir": "./src",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "declaration": true,
+    "outDir": "./dist",
+    "removeComments": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "strictPropertyInitialization": false,
+    "skipLibCheck": true
+  },
+  "exclude": ["./dist/**/*"]
+}