@abyss-project/tools 1.0.5 → 1.2.0

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

@@ -1,38 +1,38 @@
-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>>;
-
-export interface ICountOrganizationShortLinkData {
-  total: number;
-  orphan?: number;
-  unshared?: number;
-}
-export type ICountOrganizationShortLinkResponse = IResponse<ICountOrganizationShortLinkData>;
+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>>;
+
+export interface ICountOrganizationShortLinkData {
+  total: number;
+  orphan?: number;
+  unshared?: number;
+}
+export type ICountOrganizationShortLinkResponse = IResponse<ICountOrganizationShortLinkData>;

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

@@ -1,38 +1,38 @@
-import { IResponse } from '../type-message/response';
-import { ITag, IEntityTag, ITagStatEntry } from '../../models/tag.dto';
-
-export interface IListTagData {
-  tags: ITag[];
-}
-export type IListTagResponse = IResponse<IListTagData>;
-
-export interface ICreateTagData {
-  tag: ITag;
-}
-export type ICreateTagResponse = IResponse<ICreateTagData>;
-
-export interface IUpdateTagData {
-  tag: ITag;
-}
-export type IUpdateTagResponse = IResponse<IUpdateTagData>;
-
-export interface IDeleteTagData {}
-export type IDeleteTagResponse = IResponse<IDeleteTagData>;
-
-export interface IAssignTagData {
-  entityTag: IEntityTag;
-}
-export type IAssignTagResponse = IResponse<IAssignTagData>;
-
-export interface IUnassignTagData {}
-export type IUnassignTagResponse = IResponse<IUnassignTagData>;
-
-export interface ITagStatsData {
-  stats: ITagStatEntry[];
-}
-export type ITagStatsResponse = IResponse<ITagStatsData>;
-
-export interface IGetEntityTagsData {
-  entityTags: IEntityTag[];
-}
-export type IGetEntityTagsResponse = IResponse<IGetEntityTagsData>;
+import { IResponse } from '../type-message/response';
+import { ITag, IEntityTag, ITagStatEntry } from '../../models/tag.dto';
+
+export interface IListTagData {
+  tags: ITag[];
+}
+export type IListTagResponse = IResponse<IListTagData>;
+
+export interface ICreateTagData {
+  tag: ITag;
+}
+export type ICreateTagResponse = IResponse<ICreateTagData>;
+
+export interface IUpdateTagData {
+  tag: ITag;
+}
+export type IUpdateTagResponse = IResponse<IUpdateTagData>;
+
+export interface IDeleteTagData {}
+export type IDeleteTagResponse = IResponse<IDeleteTagData>;
+
+export interface IAssignTagData {
+  entityTag: IEntityTag;
+}
+export type IAssignTagResponse = IResponse<IAssignTagData>;
+
+export interface IUnassignTagData {}
+export type IUnassignTagResponse = IResponse<IUnassignTagData>;
+
+export interface ITagStatsData {
+  stats: ITagStatEntry[];
+}
+export type ITagStatsResponse = IResponse<ITagStatsData>;
+
+export interface IGetEntityTagsData {
+  entityTags: IEntityTag[];
+}
+export type IGetEntityTagsResponse = IResponse<IGetEntityTagsData>;

package/src/types/interface/api/responses/transfer.response.ts

@@ -1,14 +1,14 @@
-import { IResponse } from '../type-message/response';
-import { IDraw } from '../../models/draw.dto';
-import { IBoard } from '../../models/board.dto';
-import { IMemo } from '../../models/memo.dto';
-import { IAtlas } from '../../models/atlas.dto';
-import { IRetrospective } from '../../models/retrospective.dto';
-import { IShortLink } from '../../models/short-link.dto';
-
-export type ITransferDrawResponse = IResponse<{ draw: IDraw }>;
-export type ITransferBoardResponse = IResponse<{ board: IBoard }>;
-export type ITransferMemoResponse = IResponse<{ memo: IMemo }>;
-export type ITransferAtlasResponse = IResponse<{ atlas: IAtlas }>;
-export type ITransferRetrospectiveResponse = IResponse<{ retrospective: IRetrospective }>;
-export type ITransferShortLinkResponse = IResponse<{ shortLink: IShortLink }>;
+import { IResponse } from '../type-message/response';
+import { IDraw } from '../../models/draw.dto';
+import { IBoard } from '../../models/board.dto';
+import { IMemo } from '../../models/memo.dto';
+import { IAtlas } from '../../models/atlas.dto';
+import { IRetrospective } from '../../models/retrospective.dto';
+import { IShortLink } from '../../models/short-link.dto';
+
+export type ITransferDrawResponse = IResponse<{ draw: IDraw }>;
+export type ITransferBoardResponse = IResponse<{ board: IBoard }>;
+export type ITransferMemoResponse = IResponse<{ memo: IMemo }>;
+export type ITransferAtlasResponse = IResponse<{ atlas: IAtlas }>;
+export type ITransferRetrospectiveResponse = IResponse<{ retrospective: IRetrospective }>;
+export type ITransferShortLinkResponse = IResponse<{ shortLink: IShortLink }>;

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

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

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

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

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

package/src/types/interface/index.ts

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

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

@@ -1,22 +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;
-}
+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

@@ -1,21 +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[];
-}
+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

@@ -1,17 +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;
-}
+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

@@ -1,26 +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[];
-}
+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

@@ -1,34 +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 { IEntityTag } from './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;
-  createdByUserId: 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[];
-  entityTags?: IEntityTag[];
-}
-
-export interface IAtlasWithDetails extends IAtlas {
-  atlasGroups: IAtlasGroup[];
-  atlasPages: IAtlasPage[];
-}
+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 { IEntityTag } from './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;
+  createdByUserId: 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[];
+  entityTags?: IEntityTag[];
+}
+
+export interface IAtlasWithDetails extends IAtlas {
+  atlasGroups: IAtlasGroup[];
+  atlasPages: IAtlasPage[];
+}

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

@@ -0,0 +1,67 @@
+import { IOrganization } from './organization.dto';
+import { IUser } from './user.dto';
+import { IProject } from './project.dto';
+import { BeamVisibility } from '../../enum/beam.enum';
+
+export interface IBeamTransfer {
+  id: string;
+  slug: string;
+  // sha256 of the anonymous management token; the plaintext is returned once at
+  // finalize (B5) and never stored.
+  manageTokenHash: string | null;
+  userId: string | null;
+  organizationId: string | null;
+  projectId: string | null;
+  createdByUserId: string | null;
+  visibility: BeamVisibility;
+  passwordHash: string | null;
+  title: string | null;
+  message: string | null;
+  isActive: boolean;
+  expiresAt: Date | null;
+  finalizedAt: Date | null;
+  maxDownloads: number | null;
+  downloadCount: number;
+  lastDownloadedAt: Date | null;
+  totalSizeOctet: number;
+  fileCount: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+  files?: IBeamFile[];
+  recipients?: IBeamRecipient[];
+}
+
+export interface IBeamFile {
+  id: string;
+  transferId: string;
+  // abyss-storage applicationFileId (PRIVATE bucket); resolved at serve time (B4).
+  storageFileId: string;
+  thumbnailStorageFileId: string | null;
+  name: string;
+  mimeType: string | null;
+  sizeOctet: number;
+  isImage: boolean;
+  width: number | null;
+  height: number | null;
+  downloadCount: number;
+  position: number;
+  createdAt?: Date;
+
+  transfer?: IBeamTransfer;
+}
+
+export interface IBeamRecipient {
+  id: string;
+  transferId: string;
+  email: string;
+  locale: string | null;
+  sentAt: Date | null;
+  firstOpenedAt: Date | null;
+  createdAt?: Date;
+
+  transfer?: IBeamTransfer;
+}

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

@@ -1,20 +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;
-};
+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

@@ -1,14 +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;
-}
+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

@@ -1,16 +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[];
-}
+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[];
+}