ad2app-lib 1.0.0

package/dist/utils/variable.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNumberOrUndefined = exports.getTargetValueOrNull = void 0;
+const getTargetValueOrNull = (value, targetValue) => {
+    return (!!value && targetValue) || undefined;
+};
+exports.getTargetValueOrNull = getTargetValueOrNull;
+const getNumberOrUndefined = (value) => {
+    return value ? Number(value) : undefined;
+};
+exports.getNumberOrUndefined = getNumberOrUndefined;

package/index.ts

@@ -0,0 +1,5 @@
+import * as types from './src/types';
+import * as utils from './src/utils';
+import * as api from './src/api/apiDriver';
+
+export { types, utils, api };

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "ad2app-lib",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "exports": {
+    "./utils": "./dist/utils/index.js",
+    "./types": "./dist/types/index.js",
+    "./api": "./dist/api/index.js"
+  },
+  "typesVersions": {
+    "*": {
+      "utils": [
+        "dist/utils/index.d.ts"
+      ],
+      "types": [
+        "dist/types/index.d.ts"
+      ],
+      "api": [
+        "dist/api/index.d.ts"
+      ],
+      "*": [
+        "dist/index.d.ts"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "npx tsc"
+  },
+  "keywords": [],
+  "author": "Maciej Górski@ad2.app",
+  "license": "ISC",
+  "description": "Package to share types and utils across the ad2app projects",
+  "dependencies": {
+    "class-validator": "^0.14.1",
+    "date-fns": "^3.5.0",
+    "date-fns-tz": "^3.2.0",
+    "typescript": "^5.8.3"
+  }
+}

package/src/api/apiDriver.ts

@@ -0,0 +1,65 @@
+import { FetchParams } from '../types';
+import { concatApiPaths, createQueryString, insertParams } from './utils';
+
+type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete';
+
+interface DriverConfig {
+  apiUrl: string;
+  getHeaders?: () => HeadersInit;
+}
+
+let CONFIG: DriverConfig;
+
+export function configureApiDriver(config: DriverConfig) {
+  CONFIG = config;
+}
+
+export async function fetchCall<T, Q>(
+  path: string,
+  fetchParams?: FetchParams<Q>,
+  method: HttpMethod = 'get'
+): Promise<T> {
+  const headers: HeadersInit = CONFIG.getHeaders?.() || {};
+
+  const query: Q = {} as Q;
+  Object.entries(fetchParams?.query || {}).forEach(([key, val]) => {
+    query[key] = Array.isArray(val) ? JSON.stringify(val) : val;
+  });
+
+  const queryString = createQueryString({ ...fetchParams, query });
+  const fullPath = insertParams(
+    concatApiPaths(CONFIG.apiUrl, path) + queryString,
+    fetchParams?.params
+  );
+
+  const init: RequestInit = {
+    method,
+    headers,
+  };
+
+  if (fetchParams?.body) {
+    init.body = JSON.stringify(fetchParams.body);
+    headers['Content-Type'] = 'application/json';
+  }
+
+  const res = await fetch(fullPath, init);
+
+  if (!res.ok) throw new Error(JSON.stringify(await res.json()));
+
+  return res.json() as Promise<T>;
+}
+
+export function apiDriver() {
+  return {
+    get: <T, Q>(path: string, params?: FetchParams<Q>) =>
+      fetchCall<T, Q>(path, params, 'get'),
+    post: <T, Q>(path: string, params?: FetchParams<Q>) =>
+      fetchCall<T, Q>(path, params, 'post'),
+    put: <T, Q>(path: string, params?: FetchParams<Q>) =>
+      fetchCall<T, Q>(path, params, 'put'),
+    patch: <T, Q>(path: string, params?: FetchParams<Q>) =>
+      fetchCall<T, Q>(path, params, 'patch'),
+    delete: <T, Q>(path: string, params?: FetchParams<Q>) =>
+      fetchCall<T, Q>(path, params, 'delete'),
+  };
+}

package/src/api/index.ts

@@ -0,0 +1,2 @@
+export * from './apiDriver';
+export * from './utils';

package/src/api/utils.ts

@@ -0,0 +1,38 @@
+import { FetchParams } from '../types';
+
+export const concatApiPaths = (apiUrl: string, endpoint: string) =>
+  apiUrl + '/' + endpoint;
+
+export const createQueryString = <T>(fetchParams?: FetchParams<T>) => {
+  return fetchParams?.query
+    ? '?' + new URLSearchParams(fetchParams.query as URLSearchParams).toString()
+    : '';
+};
+
+export const extractParams = (path: string): string[] => {
+  return path
+    .split('/')
+    .filter((segment) => segment.startsWith(':'))
+    .map((segment) => segment.substring(1));
+};
+
+export const insertParams = (
+  path: string,
+  params?: { [key: string]: string | number }
+): string => {
+  if (!params) {
+    return path;
+  }
+
+  const paramNames = extractParams(path);
+
+  paramNames.forEach((paramName) => {
+    if (params[paramName] !== undefined) {
+      path = path.replace(`:${paramName}`, String(params[paramName]));
+    } else {
+      throw new Error(`Missing value for parameter: ${paramName}`);
+    }
+  });
+
+  return path;
+};

package/src/types/I_Agency.ts

@@ -0,0 +1,16 @@
+import { I_Offer } from "./I_Offer";
+import { I_User } from "./I_User";
+
+export class I_Agency {
+  id: string;
+  name: string;
+  offers?: I_Offer[];
+  users?: I_User[];
+
+  constructor(data?: Partial<I_Agency>) {
+    this.id = data?.id ?? null;
+    this.name = data?.name ?? null;
+    this.offers = data?.offers ?? null;
+    this.users = data?.users ?? null;
+  }
+}

package/src/types/I_Campaign.ts

@@ -0,0 +1,171 @@
+import { IsArray, IsNotEmpty, IsNumber, IsString } from "class-validator";
+import { I_CampaignGoal } from "./I_CampaignGoal";
+import { I_CampaignCollaborationMethod } from "./I_CampaignCollaborationMethod";
+import { I_Influencer } from "./I_Influencer";
+import { I_InfluencersList } from "./I_InfluencersLists";
+import { I_CampaignDeadline } from "./I_CampaignDeadline";
+
+class I_Brief {
+  brand: string;
+  campaignTags: string;
+  budgetFrom: number;
+  budgetTo: number;
+  viewsFrom: number;
+  viewsTo: number;
+  maxInfluencersQuantity: number;
+  minInfluencersQuantity: number;
+  campaignCollaborationMethods: I_CampaignCollaborationMethod[];
+  campaignGoals: I_CampaignGoal[];
+
+  constructor(data?: Partial<I_Brief>) {
+    this.brand = data?.brand ?? null;
+    this.campaignTags = data?.campaignTags ?? null;
+    this.budgetFrom = data?.budgetFrom ?? null;
+    this.budgetTo = data?.budgetTo ?? null;
+    this.viewsFrom = data?.viewsFrom ?? null;
+    this.viewsTo = data?.viewsTo ?? null;
+    this.maxInfluencersQuantity = data?.maxInfluencersQuantity ?? null;
+    this.minInfluencersQuantity = data?.minInfluencersQuantity ?? null;
+    this.campaignGoals = data?.campaignGoals ?? null;
+    this.campaignCollaborationMethods =
+      data?.campaignCollaborationMethods ?? null;
+  }
+}
+
+export class I_Campaign {
+  id: string;
+  name: string;
+  brief: I_Brief;
+  influencersList: {
+    id: I_InfluencersList["id"];
+    name: I_InfluencersList["name"];
+    influencers: I_Influencer[];
+  };
+  deadlines: I_CampaignDeadline[];
+  startDate: Date;
+  endDate: Date;
+  isDraft: boolean;
+
+  constructor(data?: Partial<I_Campaign>) {
+    this.id = data?.id ?? null;
+    this.name = data?.name ?? null;
+    this.brief = data?.brief ?? null;
+    this.influencersList = data?.influencersList ?? null;
+    this.deadlines = data?.deadlines ?? [];
+    this.startDate = data?.startDate ?? null;
+    this.endDate = data?.endDate ?? null;
+    this.isDraft = data?.isDraft ?? null;
+  }
+}
+
+export class I_CreateCampaignDTO {
+  name: string;
+}
+
+export class I_CreateInfluencersListForCampaignDTO {
+  @IsNotEmpty()
+  campaignId: string;
+
+  @IsNotEmpty()
+  @IsArray()
+  influencers: I_Influencer[];
+}
+
+export class I_GetCampaignDTO {
+  @IsNotEmpty()
+  id: string;
+
+  constructor(data: Partial<I_GetCampaignDTO>) {
+    this.id = data?.id ?? "";
+  }
+}
+
+export class I_GetAgencyCampaignsDTO {}
+
+export class I_FindCampaignsDTO {
+  name: string;
+}
+
+export class I_EditCampaignDTO {
+  @IsNotEmpty()
+  id: string;
+
+  @IsString()
+  name: string;
+
+  @IsNotEmpty()
+  brand: string;
+
+  @IsNotEmpty()
+  @IsNumber()
+  budgetFrom: number;
+
+  @IsNotEmpty()
+  @IsNumber()
+  budgetTo: number;
+
+  @IsNotEmpty()
+  @IsNumber()
+  viewsFrom: number;
+
+  @IsNotEmpty()
+  @IsNumber()
+  viewsTo: number;
+
+  @IsNotEmpty()
+  @IsString()
+  campaignTags: string;
+
+  @IsArray()
+  campaignGoals: I_CampaignGoal[];
+
+  @IsArray()
+  campaignCollaborationMethods: I_CampaignCollaborationMethod[];
+
+  @IsNotEmpty()
+  @IsNumber()
+  minInfluencersQuantity: number;
+
+  @IsNotEmpty()
+  @IsNumber()
+  maxInfluencersQuantity: number;
+
+  @IsNotEmpty()
+  startDate: Date;
+
+  @IsNotEmpty()
+  endDate: Date;
+
+  constructor(data?: Partial<I_EditCampaignDTO>) {
+    this.id = data?.id ?? null;
+    this.name = data?.name ?? null;
+    this.campaignGoals = data?.campaignGoals ?? [];
+    this.brand = data?.brand ?? null;
+    this.budgetFrom = Number(data?.budgetFrom) ?? null;
+    this.budgetTo = Number(data?.budgetTo) ?? null;
+    this.viewsFrom = Number(data?.viewsFrom) ?? null;
+    this.viewsTo = Number(data?.viewsTo) ?? null;
+    this.campaignTags = data?.campaignTags ?? null;
+    this.campaignCollaborationMethods =
+      data?.campaignCollaborationMethods ?? [];
+    this.minInfluencersQuantity = Number(data?.minInfluencersQuantity) ?? null;
+    this.maxInfluencersQuantity = Number(data?.maxInfluencersQuantity) ?? null;
+    this.startDate = data?.startDate ?? null;
+    this.endDate = data?.endDate ?? null;
+  }
+}
+
+export class I_GenerateInfluencersListForCampaignDTO {
+  @IsNotEmpty()
+  campaignId: string;
+}
+
+export class I_RegenerateInfluencersListForCampaignDTO {
+  @IsNotEmpty()
+  campaignId: string;
+}
+
+export class I_MarkCampaignAsReadyDTO {
+  @IsNotEmpty()
+  campaignId: string;
+}

package/src/types/I_CampaignCollaborationMethod.ts

@@ -0,0 +1,20 @@
+import { IsNotEmpty } from "class-validator";
+
+export class I_CampaignCollaborationMethod {
+  id: string;
+  value: string;
+
+  constructor(data?: Partial<I_CampaignCollaborationMethod>) {
+    this.id = data?.id ?? "";
+    this.value = data?.value ?? "";
+  }
+}
+
+export class I_CreateCampaignCollaborationMethodDTO {
+  @IsNotEmpty()
+  value: string;
+}
+
+export class I_FindCampaignCollaborationMethodDTO {
+  value: string;
+}

package/src/types/I_CampaignDeadline.ts

@@ -0,0 +1,65 @@
+import { IsNotEmpty, IsOptional, IsString } from "class-validator";
+import { I_OfferStatus } from "./I_Offer";
+
+export class I_CampaignDeadline {
+  id: string;
+  name: string;
+  date: Date;
+  isConfirmed: boolean;
+  isReadyToConfirm: boolean;
+
+  constructor(data?: Partial<I_CampaignDeadline>) {
+    this.id = data?.id ?? null;
+    this.name = data?.name ?? null;
+    this.date = data?.date ?? null;
+    this.isConfirmed = data?.isConfirmed ?? null;
+    this.isReadyToConfirm = data?.isReadyToConfirm ?? null;
+  }
+}
+
+export class I_CreateCampaignDeadlineDTO {
+  @IsNotEmpty()
+  name: string;
+
+  @IsNotEmpty()
+  campaignId: string;
+
+  @IsOptional()
+  ruleType?: I_OfferStatus;
+}
+
+export class I_GetCampaignDeadlinesDTO {
+  @IsNotEmpty()
+  campaignId: string;
+}
+
+export class I_GetCampaignDeadlineDTO {
+  @IsNotEmpty()
+  deadlineId: string;
+}
+
+export class I_EditCampaignDeadlineDTO {
+  @IsNotEmpty()
+  deadlineId: string;
+
+  @IsNotEmpty()
+  date: Date;
+}
+
+export class I_EditCampaignDeadlinesDTO {
+  [key: string]: Date | string;
+
+  @IsString()
+  @IsNotEmpty()
+  campaignId: string;
+
+  constructor(data?: Partial<I_EditCampaignDeadlinesDTO>) {
+    this.campaignId = data?.campaignId ?? null;
+
+    Object.entries(data || {}).forEach(([key, value]) => {
+      if (key !== "startDate" && key !== "endDate") {
+        this[key] = value;
+      }
+    });
+  }
+}

package/src/types/I_CampaignGoal.ts

@@ -0,0 +1,20 @@
+import { IsNotEmpty } from "class-validator";
+
+export class I_CampaignGoal {
+  id: string;
+  value: string;
+
+  constructor(data?: Partial<I_CampaignGoal>) {
+    this.id = data?.id ?? "";
+    this.value = data?.value ?? "";
+  }
+}
+
+export class I_CreateCampaignGoalDTO {
+  @IsNotEmpty()
+  value: string;
+}
+
+export class I_FindCampaignGoalsDTO {
+  value: string;
+}

package/src/types/I_Influencer.ts

@@ -0,0 +1,93 @@
+import { IsNotEmpty, IsOptional } from "class-validator";
+import { I_InfluencersCategory } from "./I_InfluencersCategories";
+import { I_InfluencerProperty } from "./I_InfluencersProperties";
+
+// TODO: Move to util.
+const getMaxInteger = (value: string | number) => {
+  return Number(value) || 10 ** 9;
+};
+
+export class I_Influencer {
+  id: string;
+  handle_tt: string;
+  followers_tt: number;
+  tt_posts_count: number;
+  is_verified_tt: boolean;
+  categories: I_InfluencersCategory[];
+  properties: I_InfluencerProperty[];
+
+  constructor(data?: Partial<I_Influencer>) {
+    this.id = data?.id ?? null;
+    this.handle_tt = data?.handle_tt || "";
+    this.followers_tt = data?.followers_tt || 0;
+    this.tt_posts_count = data?.tt_posts_count || 0;
+    this.is_verified_tt = data?.is_verified_tt || false;
+    this.categories = data?.categories || [];
+    this.properties = data?.properties || [];
+  }
+}
+
+export class I_InfluencersSearchParams {
+  handle: string;
+  followers_from: number;
+  followers_to: number;
+  verified: boolean;
+  languages: string[];
+  ad_mean_views_from: number;
+  ad_mean_views_to: number;
+  id?: number[];
+  categories: string[];
+
+  constructor(data?: Partial<I_InfluencersSearchParams>) {
+    this.handle = data?.handle || "";
+    this.followers_from = data?.followers_from || 0;
+    this.followers_to = getMaxInteger(data?.followers_to);
+    this.verified = !!data?.verified;
+    this.languages = parseLanguages(this.languages);
+    this.ad_mean_views_from = data?.ad_mean_views_from;
+    this.ad_mean_views_to = getMaxInteger(data?.ad_mean_views_to);
+    this.id = data?.id || [];
+    this.categories = data?.categories || [];
+  }
+}
+
+export class I_InfluencerSearchParams {
+  handle?: string;
+  ids?: number[];
+}
+
+export class I_InfluencersAddParamsDTO {
+  @IsOptional()
+  followers_from: number;
+
+  @IsOptional()
+  verified: boolean;
+
+  @IsOptional()
+  languages: string[];
+
+  constructor(data?: Partial<I_InfluencersAddParamsDTO>) {
+    this.followers_from = data?.followers_from || 0;
+    this.verified = !!data?.verified;
+    this.languages = parseLanguages(this.languages);
+  }
+}
+
+export class I_InfluencerCreateFromSocialMediaUser {
+  @IsNotEmpty()
+  handle_tt: string;
+}
+
+const parseLanguages = (languages: any): string[] => {
+  if (Array.isArray(languages)) {
+    return languages;
+  }
+  if (typeof languages === "string") {
+    try {
+      return JSON.parse(languages);
+    } catch {
+      return [];
+    }
+  }
+  return [];
+};

package/src/types/I_InfluencersCategories.ts

@@ -0,0 +1,52 @@
+import { IsString, IsNotEmpty, IsNumber } from "class-validator";
+import { I_Influencer } from "./I_Influencer";
+
+export class I_InfluencersCategory {
+  name: string;
+  id: number;
+  influencers: I_Influencer[];
+
+  constructor(data?: Partial<I_InfluencersCategory>) {
+    this.id = data?.id;
+    this.name = data?.name || "";
+    this.influencers = data?.influencers || [];
+  }
+}
+
+export class I_InfluencersCategoriesSearchParams {
+  @IsString()
+  @IsNotEmpty()
+  name: string;
+}
+
+export class I_InfluencersCategoriesGetDTO {
+  @IsString()
+  @IsNotEmpty()
+  id: number;
+}
+
+export class I_GetInfluencerCategoriesDTO {
+  @IsString()
+  @IsNotEmpty()
+  handle: string;
+}
+
+export class I_InfluencersCategoriesCreateDTO {
+  @IsString()
+  @IsNotEmpty()
+  name: string;
+}
+
+export class I_InfluencersCategoriesAssignDTO {
+  @IsString()
+  @IsNotEmpty()
+  influencerHandle: string;
+
+  @IsNotEmpty()
+  categoryId: number;
+}
+
+export class I_InfluencersCategoriesAddToScrappingQueueDTO {
+  @IsNotEmpty()
+  categoryId: number;
+}