@abyss-project/tools 1.0.0

package/src/types/interface/api/responses/short-link.response.ts

@@ -0,0 +1,31 @@
+import { BasePaginate } from '../type-message/base-paginate';
+import { IResponse } from '../type-message/response';
+import { IShortLink, IShortLinkWithStats } from '../../models/short-link.dto';
+import { IShortLinkClick } from '../../models/short-link-click.dto';
+
+export interface IGetShortLinkData {
+  shortLink: IShortLink;
+}
+export type IGetShortLinkResponse = IResponse<IGetShortLinkData>;
+
+export type IPaginateShortLinkResponse = IResponse<BasePaginate<IShortLink>>;
+
+export interface ICreateShortLinkData {
+  shortLink: IShortLink;
+}
+export type ICreateShortLinkResponse = IResponse<ICreateShortLinkData>;
+
+export interface IUpdateShortLinkData {
+  shortLink: IShortLink;
+}
+export type IUpdateShortLinkResponse = IResponse<IUpdateShortLinkData>;
+
+export interface IDeleteShortLinkData {}
+export type IDeleteShortLinkResponse = IResponse<IDeleteShortLinkData>;
+
+export interface IGetStatsShortLinkData {
+  shortLink: IShortLinkWithStats;
+}
+export type IGetStatsShortLinkResponse = IResponse<IGetStatsShortLinkData>;
+
+export type IGetClicksShortLinkResponse = IResponse<BasePaginate<IShortLinkClick>>;

package/src/types/interface/api/responses/user-tag.response.ts

@@ -0,0 +1,38 @@
+import { IResponse } from '../type-message/response';
+import { IUserTag, IEntityUserTag, IUserTagStatEntry } from '../../models/user-tag.dto';
+
+export interface IListUserTagData {
+  userTags: IUserTag[];
+}
+export type IListUserTagResponse = IResponse<IListUserTagData>;
+
+export interface ICreateUserTagData {
+  userTag: IUserTag;
+}
+export type ICreateUserTagResponse = IResponse<ICreateUserTagData>;
+
+export interface IUpdateUserTagData {
+  userTag: IUserTag;
+}
+export type IUpdateUserTagResponse = IResponse<IUpdateUserTagData>;
+
+export interface IDeleteUserTagData {}
+export type IDeleteUserTagResponse = IResponse<IDeleteUserTagData>;
+
+export interface IAssignUserTagData {
+  entityUserTag: IEntityUserTag;
+}
+export type IAssignUserTagResponse = IResponse<IAssignUserTagData>;
+
+export interface IUnassignUserTagData {}
+export type IUnassignUserTagResponse = IResponse<IUnassignUserTagData>;
+
+export interface IUserTagStatsData {
+  stats: IUserTagStatEntry[];
+}
+export type IUserTagStatsResponse = IResponse<IUserTagStatsData>;
+
+export interface IGetEntityTagsData {
+  entityUserTags: IEntityUserTag[];
+}
+export type IGetEntityTagsResponse = IResponse<IGetEntityTagsData>;

package/src/types/interface/api/type-message/api-error.ts

@@ -0,0 +1,7 @@
+import { Code, ErrorType } from '../../../enum';
+
+export interface IApiError {
+  code: Code;
+  type: ErrorType;
+  message?: string;
+}

package/src/types/interface/api/type-message/base-paginate.ts

@@ -0,0 +1,11 @@
+export interface BasePaginate<T> {
+  maxPages: number;
+  currentPage: number;
+  data: T[];
+  totalItems: number;
+}
+
+export interface QueryPaginate {
+  page?: number;
+  limit?: number;
+}

package/src/types/interface/api/type-message/response.ts

@@ -0,0 +1,6 @@
+import { IApiError } from './api-error';
+
+export interface IResponse<T> {
+  data: T;
+  error?: IApiError | Error;
+}

package/src/types/interface/index.ts

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

package/src/types/interface/models/atlas-document.dto.ts

@@ -0,0 +1,22 @@
+import { IAtlasPage } from './atlas-page.dto';
+import { IAtlas } from './atlas.dto';
+
+export interface IAtlasDocument {
+  id: string;
+  atlasPageId: string;
+  atlasId: string;
+  name: string;
+  externalId: string;
+  publicAccessId: string;
+  thumbnailId: string | null;
+  thumbnailPublicAccessId: string | null;
+  sizeOctet: number;
+  mimeType: string;
+  checksum: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+
+  // Relations
+  atlasPage?: IAtlasPage;
+  atlas?: IAtlas;
+}

package/src/types/interface/models/atlas-group.dto.ts

@@ -0,0 +1,21 @@
+import { IAtlasPage } from './atlas-page.dto';
+import { IAtlas } from './atlas.dto';
+
+export interface IAtlasGroup {
+  id: string;
+  atlasId: string;
+  parentAtlasGroupId: string | null;
+  name: string;
+  description: string | null;
+  color: string | null;
+  position: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+  deletedAt?: Date | null;
+
+  // Associations
+  atlas?: IAtlas | null;
+  parentAtlasGroup?: IAtlasGroup | null;
+  atlasGroups?: IAtlasGroup[];
+  atlasPages?: IAtlasPage[];
+}

package/src/types/interface/models/atlas-page-content.dto.ts

@@ -0,0 +1,17 @@
+import { IAtlasPage } from './atlas-page.dto';
+
+export interface IAtlasPageContent {
+  id: string;
+  atlasPageId: string;
+  content: string;
+  contentHash: string;
+  version: number;
+  isActive: boolean;
+  diff: string | null;
+  createdByUserId: string | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+
+  // Associations
+  atlasPage?: IAtlasPage;
+}

package/src/types/interface/models/atlas-page.dto.ts

@@ -0,0 +1,26 @@
+import { IAtlasDocument } from './atlas-document.dto';
+import { IAtlasGroup } from './atlas-group.dto';
+import { IAtlasPageContent } from './atlas-page-content.dto';
+import { IAtlas } from './atlas.dto';
+
+export interface IAtlasPage {
+  id: string;
+  atlasId: string;
+  atlasGroupId: string | null;
+  title: string;
+  slug: string;
+  icon: string | null;
+  color: string | null;
+  position: number;
+  lastModifiedAt: Date | null;
+  lastModifiedByUserId: string | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+  deletedAt?: Date;
+
+  // Associations
+  atlas?: IAtlas;
+  atlasGroup?: IAtlasGroup | null;
+  atlasPageContents?: IAtlasPageContent[];
+  atlasDocuments?: IAtlasDocument[];
+}

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

@@ -0,0 +1,34 @@
+import { IAtlasDocument } from './atlas-document.dto';
+import { IAtlasGroup } from './atlas-group.dto';
+import { IAtlasPage } from './atlas-page.dto';
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IEntityUserTag } from './user-tag.dto';
+import { IUser } from './user.dto';
+
+export interface IAtlas {
+  id: string;
+  title: string;
+  description: string | null;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  publicAccessToken: string | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+  deletedAt?: Date | null;
+
+  // Associations
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  atlasGroups?: IAtlasGroup[];
+  atlasPages?: IAtlasPage[];
+  atlasDocuments?: IAtlasDocument[];
+  entityUserTags?: IEntityUserTag[];
+}
+
+export interface IAtlasWithDetails extends IAtlas {
+  atlasGroups: IAtlasGroup[];
+  atlasPages: IAtlasPage[];
+}

package/src/types/interface/models/board-activity.dto.ts

@@ -0,0 +1,20 @@
+import { BoardActivityData, BoardActivityType } from '../../enum';
+import { IBoardCard } from './board-card.dto';
+import { IBoard } from './board.dto';
+import { IUser } from './user.dto';
+
+export type IBoardActivity = {
+  id: string;
+  type: BoardActivityType;
+  payload: BoardActivityData[keyof BoardActivityData];
+  userId: string | null;
+  boardCardId: string | null;
+  boardId: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+
+  // Association
+  user?: IUser | null;
+  boardCard?: IBoardCard | null;
+  board?: IBoard;
+};

package/src/types/interface/models/board-card-checklist-row.dto.ts

@@ -0,0 +1,14 @@
+import { IBoardCardChecklist } from './board-card-checklist.dto';
+
+export interface IBoardCardChecklistRow {
+  id: string;
+  boardCardChecklistId: string;
+  content: string;
+  completedAt: Date | null;
+  position: number;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCardChecklist: IBoardCardChecklist;
+}

package/src/types/interface/models/board-card-checklist.dto.ts

@@ -0,0 +1,16 @@
+import { IBoardCardChecklistRow } from './board-card-checklist-row.dto';
+import { IBoardCard } from './board-card.dto';
+
+export interface IBoardCardChecklist {
+  id: string;
+  boardCardId: string;
+  title: string;
+  position: number;
+  maskCompletedRows: boolean;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCard: IBoardCard;
+  boardCardChecklistRows: IBoardCardChecklistRow[];
+}

package/src/types/interface/models/board-card-comment.dto.ts

@@ -0,0 +1,15 @@
+import { IBoardCard } from './board-card.dto';
+import { IUser } from './user.dto';
+
+export interface IBoardCardComment {
+  id: string;
+  boardCardId: string;
+  content: string;
+  userId: string | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCard?: IBoardCard;
+  user?: IUser | null;
+}

package/src/types/interface/models/board-card-document.dto.ts

@@ -0,0 +1,22 @@
+import { IBoardCard } from './board-card.dto';
+import { IBoard } from './board.dto';
+
+export interface IBoardCardDocument {
+  id: string;
+  boardCardId: string;
+  boardId: string;
+  name: string;
+  externalId: string;
+  publicAccessId: string;
+  thumbnailId: string | null;
+  thumbnailPublicAccessId: string | null;
+  checksum: string;
+  mimeType: string;
+  sizeOctet: number;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCard: IBoardCard;
+  board: IBoard;
+}

package/src/types/interface/models/board-card-label.dto.ts

@@ -0,0 +1,14 @@
+import { IBoardCard } from './board-card.dto';
+import { IBoardLabel } from './board-label.dto';
+
+export interface IBoardCardLabel {
+  id: string;
+  boardLabelId: string;
+  boardCardId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardLabel?: IBoardLabel;
+  boardCard?: IBoardCard;
+}

package/src/types/interface/models/board-card-member.dto.ts

@@ -0,0 +1,14 @@
+import { IBoardCard } from './board-card.dto';
+import { IUser } from './user.dto';
+
+export interface IBoardCardMember {
+  id: string;
+  boardCardId: string;
+  userId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardCard: IBoardCard;
+  user: IUser;
+}

package/src/types/interface/models/board-card.dto.ts

@@ -0,0 +1,37 @@
+import { IBoardActivity } from './board-activity.dto';
+import { IBoardCardChecklist } from './board-card-checklist.dto';
+import { IBoardCardComment } from './board-card-comment.dto';
+import { IBoardCardDocument } from './board-card-document.dto';
+import { IBoardCardLabel } from './board-card-label.dto';
+import { IBoardCardMember } from './board-card-member.dto';
+import { IBoardColumn } from './board-column.dto';
+import { IBoard } from './board.dto';
+
+export interface IBoardCard {
+  id: string;
+  slug: string;
+  identifier: number;
+  boardColumnId: string | null;
+  boardId: string;
+  title: string;
+  description: string | null;
+  weight: number | null;
+  position: number;
+  startDate: Date | null;
+  endDate: Date | null;
+  bannerId: string | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+  deletedAt?: Date | null;
+
+  // Association
+  board: IBoard;
+  boardColumn: IBoardColumn;
+  boardActivities: IBoardActivity[];
+  boardCardMembers: IBoardCardMember[];
+  boardCardDocuments: IBoardCardDocument[];
+  boardCardChecklists: IBoardCardChecklist[];
+  boardCardComments?: IBoardCardComment[];
+  boardCardLabels?: IBoardCardLabel[];
+  banner?: IBoardCardDocument | null;
+}

package/src/types/interface/models/board-column.dto.ts

@@ -0,0 +1,17 @@
+import { BoardColumnType } from '../../enum';
+import { IBoardCard } from './board-card.dto';
+import { IBoard } from './board.dto';
+
+export interface IBoardColumn {
+  id: string;
+  title: string;
+  position: number;
+  boardId: string;
+  type: BoardColumnType;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  board: IBoard;
+  boardCards: IBoardCard[];
+}

package/src/types/interface/models/board-label.dto.ts

@@ -0,0 +1,13 @@
+import { IBoard } from './board.dto';
+
+export interface IBoardLabel {
+  id: string;
+  name: string;
+  color: string;
+  boardId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  board: IBoard;
+}

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

@@ -0,0 +1,32 @@
+import { IBoardActivity } from './board-activity.dto';
+import { IBoardCardDocument } from './board-card-document.dto';
+import { IBoardCard } from './board-card.dto';
+import { IBoardColumn } from './board-column.dto';
+import { IBoardLabel } from './board-label.dto';
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IEntityUserTag } from './user-tag.dto';
+import { IUser } from './user.dto';
+
+export interface IBoard {
+  id: string;
+  slug: string;
+  title: string;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  archivedAt: Date | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  boardColumns?: IBoardColumn[];
+  boardActivities?: IBoardActivity[];
+  boardCards?: IBoardCard[];
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  boardLabels?: IBoardLabel[];
+  boardCardDocuments?: IBoardCardDocument[];
+  entityUserTags?: IEntityUserTag[];
+}

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

@@ -0,0 +1,28 @@
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IEntityUserTag } from './user-tag.dto';
+import { IUser } from './user.dto';
+
+export interface IDraw {
+  id: string;
+  title: string;
+  content: string;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  publicReadAccess: string | null;
+  publicWriteAccess: string | null;
+  fileId: string | null;
+  filePublicAccessId: string | null;
+  thumbnailId: string | null;
+  thumbnailPublicAccessId: string | null;
+  archivedAt?: Date | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Association
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  entityUserTags?: IEntityUserTag[];
+}

package/src/types/interface/models/index.ts

@@ -0,0 +1,28 @@
+export * from './user.dto';
+export * from './organization.dto';
+export * from './project.dto';
+export * from './atlas.dto';
+export * from './atlas-document.dto';
+export * from './atlas-group.dto';
+export * from './atlas-page.dto';
+export * from './atlas-page-content.dto';
+export * from './draw.dto';
+export * from './memo.dto';
+export * from './retrospective.dto';
+export * from './retrospective-section.dto';
+export * from './retrospective-card.dto';
+export * from './retrospective-member.dto';
+export * from './short-link.dto';
+export * from './short-link-click.dto';
+export * from './board.dto';
+export * from './board-activity.dto';
+export * from './board-card.dto';
+export * from './board-card-checklist.dto';
+export * from './board-card-checklist-row.dto';
+export * from './board-card-comment.dto';
+export * from './board-card-document.dto';
+export * from './board-card-label.dto';
+export * from './board-card-member.dto';
+export * from './board-column.dto';
+export * from './board-label.dto';
+export * from './user-tag.dto';

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

@@ -0,0 +1,22 @@
+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;
+
+  // Association
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  entityUserTags?: IEntityUserTag[];
+}

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

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

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

@@ -0,0 +1,25 @@
+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;
+
+  // Associations
+  organization?: IOrganization;
+  user?: IUser;
+  draws?: IDraw[];
+  retrospectives?: IRetrospective[];
+  atlases?: IAtlas[];
+  memos?: IMemo[];
+  shortLinks?: IShortLink[];
+}

package/src/types/interface/models/retrospective-card.dto.ts

@@ -0,0 +1,17 @@
+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;
+
+  // Association
+  retrospective?: IRetrospective;
+  retrospectiveMember?: IRetrospectiveMember;
+}

package/src/types/interface/models/retrospective-member.dto.ts

@@ -0,0 +1,15 @@
+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;
+
+  // Association
+  retrospective?: IRetrospective;
+}

package/src/types/interface/models/retrospective-section.dto.ts

@@ -0,0 +1,16 @@
+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;
+
+  // Association
+  retrospective?: IRetrospective;
+}

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

@@ -0,0 +1,32 @@
+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;
+
+  // Association
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  retrospectiveSections?: IRetrospectiveSection[];
+  retrospectiveCards?: IRetrospectiveCard[];
+  retrospectiveMembers?: IRetrospectiveMember[];
+  entityUserTags?: IEntityUserTag[];
+}