ad2app-lib 1.0.0

package/src/types/I_InfluencersLists.ts

@@ -0,0 +1,104 @@
+import { IsString, IsNotEmpty, IsOptional, IsNumber } from "class-validator";
+import { I_Influencer } from "./I_Influencer";
+import { I_PaginatedList } from "./I_PaginatedList";
+import { I_Pagination } from "./I_Pagination";
+
+export class I_InfluencersList {
+  name: string;
+  id: number;
+  influencers: I_PaginatedList<I_Influencer>;
+  unassignedInfluencers?: I_PaginatedList<I_Influencer>;
+
+  constructor(data?: Partial<I_InfluencersList>) {
+    this.id = data?.id;
+    this.name = data?.name || "";
+    this.influencers = data?.influencers || { ...new I_PaginatedList() };
+    this.unassignedInfluencers = data?.unassignedInfluencers || {
+      ...new I_PaginatedList(),
+    };
+  }
+}
+
+export class I_InfluencersListSearchParams {
+  @IsOptional()
+  @IsString()
+  name: string;
+}
+
+export class I_GetInfluencersListDTO {
+  @IsString()
+  @IsOptional()
+  id?: number;
+
+  @IsString()
+  @IsOptional()
+  campaignId?: string;
+}
+
+export class I_InfluencersListCreateDTO {
+  @IsString()
+  @IsNotEmpty()
+  name: string;
+}
+
+export class I_InfluencersListRemoveDTO {
+  name: string;
+
+  @IsNotEmpty()
+  id: number;
+}
+
+export class I_InfluencersListAssignDTO {
+  influencersIds: number[];
+  assignedPagination?: I_Pagination;
+  unassignedPagination?: I_Pagination;
+  listId?: number;
+}
+
+export class I_InfluencersListUnassignResult {
+  payload: {
+    data: {
+      influencers: { pagination: I_Pagination };
+    };
+  };
+}
+
+export class I_InfluencersListAssignResult {
+  payload: {
+    data: {
+      influencers: { pagination: I_Pagination };
+    };
+  };
+}
+
+export class I_InfluencersListUnassignDTO {
+  influencersIds: string[];
+  assignedPagination?: I_Pagination;
+  unassignedPagination?: I_Pagination;
+  listId?: number;
+}
+
+export class I_InfluencersListForCampaign extends I_InfluencersList {
+  ad_mean_views: number;
+  mean_views: number;
+
+  constructor(data?: Partial<I_InfluencersListForCampaign>) {
+    super(data);
+    this.ad_mean_views = data?.ad_mean_views ?? 0;
+    this.mean_views = data?.mean_views ?? 0;
+  }
+}
+
+export class I_InfluencersListForCampaignGenerateDTO {
+  ad_mean_views_from?: number;
+  ad_mean_views_to?: number;
+  influencers?: I_Influencer[];
+}
+
+export class I_FindInfluncersUnassignedToList {
+  @IsNotEmpty()
+  listId: number;
+
+  @IsString()
+  handle: string;
+}

package/src/types/I_InfluencersProperties.ts

@@ -0,0 +1,83 @@
+import { IsNotEmpty } from "class-validator";
+import { I_Influencer } from "./I_Influencer";
+
+export class I_InfluencerProperty {
+  propertyKey: I_InfluencerPropertyKey;
+  propertyValue: I_InfluencerPropertyValue;
+  id: string;
+
+  constructor(data?: Partial<I_InfluencerProperty>) {
+    this.id = data?.id;
+    this.propertyKey = data?.propertyKey || null;
+    this.propertyValue = data?.propertyValue || null;
+  }
+}
+
+export class I_InfluencerPropertyKey {
+  name: string;
+  key: string;
+  values: I_InfluencerPropertyValue[];
+
+  constructor(data?: Partial<I_InfluencerPropertyKey>) {
+    this.name = data?.name;
+    this.key = data?.key || "";
+    this.values = data?.values || [];
+  }
+}
+
+export class I_InfluencerPropertyValue {
+  id: string;
+  value: string;
+
+  constructor(data?: Partial<I_InfluencerPropertyValue>) {
+    this.id = data?.id;
+    this.value = data?.value || "";
+  }
+}
+
+export class I_FindInfluencersPropertiesKeysDTO {
+  name: string;
+}
+
+export class I_GetInfluencersPropertyDTO {
+  @IsNotEmpty()
+  key: string;
+}
+
+export class I_CreateInfluencerPropertyKeyDTO {
+  @IsNotEmpty()
+  key: string;
+
+  @IsNotEmpty()
+  name: string;
+}
+
+export class I_GetInfluencerPropertiesDTO {
+  @IsNotEmpty()
+  influencerId: string;
+}
+
+export class I_CreateInfluencerPropertyValueDTO {
+  @IsNotEmpty()
+  key: string;
+
+  @IsNotEmpty()
+  value: string;
+}
+
+export class I_AssignPropertyToInfluencerDTO {
+  @IsNotEmpty()
+  influencerId: string;
+
+  @IsNotEmpty()
+  key: string;
+
+  @IsNotEmpty()
+  value: string;
+
+  constructor(data: Partial<I_AssignPropertyToInfluencerDTO>) {
+    this.influencerId = data?.influencerId;
+    this.key = data?.key;
+    this.value = data?.value;
+  }
+}

package/src/types/I_Item.ts

@@ -0,0 +1,19 @@
+import { I_ResponseMessage } from './I_ResponseMessage';
+import { T_FetchStatus } from './T_FetchStatus';
+
+export class I_Item<T> implements I_ResponseMessage {
+  data: T;
+  status: T_FetchStatus;
+  message?: string;
+
+  constructor(data?: Partial<I_Item<T>>) {
+    this.data = data?.data || null;
+    this.status = data?.status || 'succeeded';
+    this.message = data?.message || '';
+  }
+}
+
+export const itemIsLoading = (item: I_Item<any>) => item.status === 'loading';
+export const itemIsResolving = (item: I_Item<any>) =>
+  item.status === 'initial' || item.status === 'loading';
+export const itemFailed = (item: I_Item<any>) => item.status === 'failed';

package/src/types/I_List.ts

@@ -0,0 +1,14 @@
+import { I_ResponseMessage } from './I_ResponseMessage';
+import { T_FetchStatus } from './T_FetchStatus';
+
+export class I_List<T> implements I_ResponseMessage {
+  items: T[];
+  status: T_FetchStatus;
+  message?: string;
+
+  constructor(data?: Partial<I_List<T>>) {
+    this.items = data?.items || [];
+    this.status = data?.status || 'succeeded';
+    this.message = data?.message || '';
+  }
+}

package/src/types/I_Offer.ts

@@ -0,0 +1,105 @@
+import { IsOptional } from "class-validator";
+import { I_Agency } from "./I_Agency";
+import { I_Campaign } from "./I_Campaign";
+import { I_Influencer } from "./I_Influencer";
+
+export class I_Offer {
+  id?: string;
+  agency?: I_Agency;
+  influencer: I_Influencer;
+  price?: number;
+  status?: I_OfferStatus;
+  action?: OfferActions;
+
+  constructor(data?: I_Offer) {
+    this.agency = data?.agency ?? null;
+    this.influencer = data?.influencer ?? null;
+    this.id = data?.id ?? null;
+    this.price = data?.price ?? null;
+    this.status = data?.status ?? null;
+    this.action = data?.action ?? null;
+  }
+}
+
+export type OfferActions =
+  | "create"
+  | "delete"
+  | "confirm"
+  | "reject"
+  | "negotiate"
+  | "accept";
+
+export enum I_OfferStatus {
+  DRAFT = "draft",
+  SENT = "sent",
+  DELETED = "deleted",
+  ACCEPTED = "accepted",
+  REJECTED = "rejected",
+  INFLUENCER_NEGOTIATED = "influencerNegotiated",
+  AGENCY_NEGOTIATED = "agencyNegotiated",
+  CONFIRMED = "confirmed",
+  ALTERNATIVE_SUGGESTED = "alternativeSuggested",
+}
+
+export declare class I_OfferGetDTO {
+  campaignId: string;
+  constructor(data?: Partial<I_SendOfferDTO>);
+}
+
+export class I_GetOffersDTO {
+  @IsOptional()
+  campaignId?: string;
+
+  @IsOptional()
+  influencerId?: string;
+}
+
+export declare class I_OfferRemoveDTO {
+  id: number;
+  constructor(data?: Partial<I_SendOfferDTO>);
+}
+export declare class I_OfferEditDTO {
+  id: number;
+  price: number;
+  constructor(data?: Partial<I_SendOfferDTO>);
+}
+
+export class I_SendOfferDTO {
+  price: number;
+  offerId: I_Offer["id"];
+  constructor(data?: Partial<I_SendOfferDTO>) {
+    this.price = data?.price ?? null;
+    this.offerId = data?.offerId ?? null;
+  }
+}
+
+export class I_CreateDraftOfferDTO {
+  influencerId: I_Influencer["id"];
+  campaignId: I_Campaign["id"];
+
+  constructor(data: I_CreateDraftOfferDTO) {
+    this.influencerId = data.influencerId;
+    this.campaignId = data.campaignId;
+  }
+}
+
+export class I_RejectOfferDTO {
+  offerId: I_Offer["id"];
+  constructor(data?: Partial<I_RejectOfferDTO>) {
+    this.offerId = data?.offerId ?? null;
+  }
+}
+
+export class I_AcceptOfferDTO {
+  offerId: I_Offer["id"];
+  constructor(data?: Partial<I_AcceptOfferDTO>) {
+    this.offerId = data?.offerId ?? null;
+  }
+}
+
+export class I_ConfirmOfferDTO {
+  offerId: I_Offer["id"];
+  constructor(data?: Partial<I_ConfirmOfferDTO>) {
+    this.offerId = data?.offerId ?? null;
+  }
+}

package/src/types/I_PaginatedList.ts

@@ -0,0 +1,17 @@
+import { I_Pagination } from './I_Pagination';
+import { I_ResponseMessage } from './I_ResponseMessage';
+import { T_FetchStatus } from './T_FetchStatus';
+
+export class I_PaginatedList<T> implements I_ResponseMessage {
+  items: T[];
+  pagination: I_Pagination;
+  status: T_FetchStatus;
+  message?: string;
+
+  constructor(data?: Partial<I_PaginatedList<T>>) {
+    this.items = data?.items || [];
+    this.pagination = data?.pagination || { ...new I_Pagination() };
+    this.status = data?.status || 'succeeded';
+    this.message = data?.message || '';
+  }
+}

package/src/types/I_Pagination.ts

@@ -0,0 +1,13 @@
+export class I_Pagination {
+  perPage: number;
+  page: number;
+  skip: number;
+  total: number;
+
+  constructor(data?: Partial<I_Pagination>) {
+    this.perPage = Number(data?.perPage) || 10;
+    this.page = Number(data?.page) || 1;
+    this.skip = this.page * this.perPage - this.perPage;
+    this.total = data?.total || 0;
+  }
+}

package/src/types/I_Queue.ts

@@ -0,0 +1,40 @@
+import { IsNotEmpty } from "class-validator";
+
+export enum QueueItemTypes {
+  TIKTOK_POST,
+  TIKTOK_USER,
+}
+
+export class I_QueueItem {
+  id: string;
+  influencer_handle: string;
+  priority: number;
+  state: number;
+  type: QueueItemTypes;
+  from: Date;
+  to: Date;
+}
+
+export class I_UpdateQueueItemPriorityDTO {
+  @IsNotEmpty()
+  id: string;
+
+  @IsNotEmpty()
+  priority: number;
+}
+
+export class I_QueueItemCreateDTO {
+  @IsNotEmpty()
+  tikTokUserHandle: string;
+
+  @IsNotEmpty()
+  priority: number;
+}
+
+export class I_CreateTikTokHashtagQueueItemDTO {
+  @IsNotEmpty()
+  hashtagId: string;
+
+  @IsNotEmpty()
+  priority: number;
+}

package/src/types/I_ResponseMessage.ts

@@ -0,0 +1,11 @@
+import { T_FetchStatus } from './T_FetchStatus';
+
+export class I_ResponseMessage {
+  status: T_FetchStatus;
+  message?: string;
+
+  constructor(data?: Partial<I_ResponseMessage>) {
+    this.status = data?.status || 'initial';
+    this.message = data?.message || '';
+  }
+}

package/src/types/I_SM_Platform.ts

@@ -0,0 +1,4 @@
+export enum SMPlatform {
+  TIKTOK = "tiktok",
+  INSTAGRAM = "instagram",
+}

package/src/types/I_ScrapperLog.ts

@@ -0,0 +1,17 @@
+import { SMPlatform } from "./I_SM_Platform";
+
+export class I_ScrapperLog {
+  handle: string;
+  platform: SMPlatform;
+  postsScrappedQuantity: number;
+  postsPlannedToScrapQuantity: number;
+  existingPostsFoundQuantity: number;
+  from: Date;
+  to: Date;
+  canScrapFurther: boolean;
+  createdAt: Date;
+}
+
+export class I_FindScrapperLogsDTO {
+  handle: string;
+}

package/src/types/I_Scrappers.ts

@@ -0,0 +1,34 @@
+import { Timespan } from "./global";
+import { I_ScrappingAccount } from "./I_ScrappingAccount";
+import { I_ScrappingMachine } from "./I_ScrappingMachine";
+
+export enum ScrapType {
+  TT_USERS,
+  TT_POSTS,
+  CONFIGURE,
+  TT_USERS_LOCAL,
+  TT_POSTS_BY_HASHTAG,
+}
+
+export type TikTokPostsScrapperArgs = [
+  influencer: { handle: string },
+  job: {
+    queueItemId: string;
+    scrappingMachine: I_ScrappingMachine;
+  },
+  {
+    timespan: Timespan;
+    scrappingAccounts: I_ScrappingAccount[];
+  }
+];
+
+export type TikTokHashtagScrapperArgs = [
+  hashtag: { hashtag: string },
+  job: {
+    queueItemId: string;
+    scrappingMachine: I_ScrappingMachine;
+  },
+  {
+    scrappingAccounts: I_ScrappingAccount[];
+  }
+];

package/src/types/I_ScrappingAccount.ts

@@ -0,0 +1,11 @@
+import { SMPlatform } from "./I_SM_Platform";
+
+export class I_ScrappingAccount {
+  id: string;
+  login: string;
+  password: string;
+  banned: boolean;
+  platform: SMPlatform;
+  createdAt: Date;
+  updatedAt: Date;
+}

package/src/types/I_ScrappingMachine.ts

@@ -0,0 +1,47 @@
+import { IsNotEmpty } from "class-validator";
+import { I_ScrappingMachineProcess } from "./I_ScrappingMachineProcess";
+import { getNumberOrUndefined } from "../utils";
+
+export enum ScrappingMachineState {
+  BUSY = "busy",
+  PAUSED = "paused",
+  IDLE = "idle",
+}
+
+export class I_ScrappingMachine {
+  id: string;
+  state: ScrappingMachineState;
+  tikTokUserLocal: number;
+  tikTokPosts: number;
+  tikTokUsersFromFollowers: number;
+  tikTokPostsByTags: number;
+  processes: I_ScrappingMachineProcess[];
+  activeJob: string;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export class I_ChangeScrappingMachineConfigurationDTO {
+  constructor(data: Partial<I_ChangeScrappingMachineConfigurationDTO>) {
+    if (!data) return;
+    this.scrappingMachine = data.scrappingMachine;
+    this.tikTokUserLocal = getNumberOrUndefined(data.tikTokUserLocal);
+    this.tikTokPosts = getNumberOrUndefined(data.tikTokPosts);
+    this.tikTokUsersFromFollowers = getNumberOrUndefined(
+      data.tikTokUsersFromFollowers
+    );
+    this.tikTokPostsByTags = getNumberOrUndefined(data.tikTokPostsByTags);
+  }
+
+  @IsNotEmpty()
+  scrappingMachine: I_ScrappingMachine;
+  tikTokUserLocal?: number;
+  tikTokPosts?: number;
+  tikTokUsersFromFollowers?: number;
+  tikTokPostsByTags?: number;
+}
+
+export class T_GetScrappingMachineDTO {
+  @IsNotEmpty()
+  scrappingMachine: I_ScrappingMachine;
+}

package/src/types/I_ScrappingMachineProcess.ts

@@ -0,0 +1,36 @@
+import { IsNotEmpty } from "class-validator";
+import { ScrapType } from "./I_Scrappers";
+import { I_ScrappingMachine } from "./I_ScrappingMachine";
+
+export class I_ScrappingMachineProcess {
+  id: string;
+  jobId: string;
+  processType: ScrapType;
+  createdAt: Date;
+  updatedAt: Date;
+}
+
+export class I_CreateScrappingMachineProcessDTO {
+  jobId: string;
+
+  @IsNotEmpty()
+  scrappingMachine: I_ScrappingMachine;
+
+  processType: number;
+}
+
+export class I_DeleteScrappingMachineProcessDTO {
+  @IsNotEmpty()
+  jobId: string;
+
+  @IsNotEmpty()
+  processType: number;
+}
+
+export class I_UpdateScrappingMachineProcessDTO {
+  @IsNotEmpty()
+  jobId: string;
+
+  @IsNotEmpty()
+  processType: number;
+}

package/src/types/I_ScrappingServiceMessages.ts

@@ -0,0 +1,38 @@
+import { I_TikTokPost } from "./I_TikTokPost";
+import { I_TikTokUser } from "./I_TikTokUser";
+
+export type T_OnStartMessageInput = {
+  queueItemId: string;
+};
+
+export type T_OnTikTokScrappingFinishMessageInput = {
+  queueItemId: string;
+  handle: string;
+  postsScrappedQuantity: number;
+  postsPlannedToScrapQuantity: number;
+  existingPostsFoundQuantity: number;
+  firstPost: I_TikTokPost;
+  lastPost: I_TikTokPost;
+  noMorePosts: boolean;
+};
+
+export type T_OnTikTokPostsScrappingStartMessageInput = {
+  queueItemId: string;
+};
+
+export type T_ProcessScrappedTikTokUserMessageInput = {
+  tikTokUser: I_TikTokUser;
+};
+
+export type T_ProcessScrappedTikTokPostMessageInput = {
+  tikTokUser: I_TikTokUser;
+  tikTokPost: I_TikTokPost;
+};
+
+export type T_ProcessScrappedTikTokPostCommentsMessageInput = {
+  tikTokPost: I_TikTokPost;
+};
+
+export type T_OnTikTokPostsByHashtagScrappingFinishMessageInput = {
+  queueItemId: string;
+};

package/src/types/I_TIkTokRaports.ts

@@ -0,0 +1,20 @@
+import { IsNotEmpty, IsOptional, IsString } from 'class-validator';
+
+export class I_GetPDFTikTokRaportDTO {
+  @IsString()
+  html: string;
+}
+
+export class I_TikTokRaportGetCustomReportDataDTO {
+  @IsNotEmpty()
+  @IsString()
+  category: string;
+
+  @IsOptional()
+  @IsString()
+  propertyKey?: string;
+
+  @IsOptional()
+  @IsString()
+  propertyValue?: string;
+}

package/src/types/I_Tag.ts

@@ -0,0 +1,12 @@
+export class I_Tag {
+  id: string;
+  tag: string;
+}
+
+export class I_TagSearchDTO {
+  tag: string;
+}
+
+export class I_GetTagDTO {
+  tagId: number;
+}