@abyss-project/spotlight 1.0.11 → 1.0.13

package/dist/api/analytics.api.d.ts

@@ -0,0 +1,11 @@
+import { IGetProjectAnalyticsQuery, IGetProjectAnalyticsResponse, ITrackProjectAnalyticsBody, ITrackProjectAnalyticsResponse } from '..';
+export declare const trackAnalyticsEvent: (body: ITrackProjectAnalyticsBody) => Promise<ITrackProjectAnalyticsResponse>;
+export declare const getProjectAnalytics: (projectId: string, query?: IGetProjectAnalyticsQuery) => Promise<IGetProjectAnalyticsResponse>;
+export declare const getPostViews: (projectPostId: string) => Promise<{
+    success: boolean;
+    message: string;
+    data: {
+        total: number;
+        unique: number;
+    };
+}>;

package/dist/api/analytics.api.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPostViews = exports.getProjectAnalytics = exports.trackAnalyticsEvent = void 0;
+const __1 = require("..");
+const trackAnalyticsEvent = async (body) => {
+    return (await __1.AbyssSpotlightCore.axios.post(`analytics/track`, body)).data;
+};
+exports.trackAnalyticsEvent = trackAnalyticsEvent;
+const getProjectAnalytics = async (projectId, query) => {
+    return (await __1.AbyssSpotlightCore.axios.get(`analytics/${projectId}`, {
+        params: query,
+    })).data;
+};
+exports.getProjectAnalytics = getProjectAnalytics;
+const getPostViews = async (projectPostId) => {
+    return (await __1.AbyssSpotlightCore.axios.get(`analytics/post/${projectPostId}/views`)).data;
+};
+exports.getPostViews = getPostViews;

package/dist/api/index.d.ts

@@ -2,6 +2,7 @@ export * from './abyss.admin.api';
 export * from './user.admin.api';
 export * from './user.api';
 export * from './monitor.api';
+export * from './project-analytics.api';
 export * from './project.admin.api';
 export * from './project.public.api';
 export * from './project.api';

package/dist/api/index.js

@@ -18,6 +18,7 @@ __exportStar(require("./abyss.admin.api"), exports);
 __exportStar(require("./user.admin.api"), exports);
 __exportStar(require("./user.api"), exports);
 __exportStar(require("./monitor.api"), exports);
+__exportStar(require("./project-analytics.api"), exports);
 __exportStar(require("./project.admin.api"), exports);
 __exportStar(require("./project.public.api"), exports);
 __exportStar(require("./project.api"), exports);

package/dist/api/project-analytics.api.d.ts

@@ -0,0 +1,7 @@
+import { ITrackProjectAnalyticsParams, ITrackProjectAnalyticsBody, ITrackProjectAnalyticsResponse, IGetProjectAnalyticsParams, IGetProjectAnalyticsResponse, IGetProjectPostAnalyticsParams, IGetProjectPostAnalyticsResponse } from '..';
+export declare const trackProjectAnalytics: (params: ITrackProjectAnalyticsParams, body: ITrackProjectAnalyticsBody) => Promise<ITrackProjectAnalyticsResponse>;
+export declare const getProjectAnalyticsStats: (params: IGetProjectAnalyticsParams, query?: {
+    startDate?: string;
+    endDate?: string;
+}) => Promise<IGetProjectAnalyticsResponse>;
+export declare const getProjectPostAnalyticsStats: (params: IGetProjectPostAnalyticsParams) => Promise<IGetProjectPostAnalyticsResponse>;

package/dist/api/project-analytics.api.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectPostAnalyticsStats = exports.getProjectAnalyticsStats = exports.trackProjectAnalytics = void 0;
+const __1 = require("..");
+const trackProjectAnalytics = async (params, body) => {
+    return (await __1.AbyssSpotlightCore.axios.post(`project-analytics/${params.projectId}/track`, body)).data;
+};
+exports.trackProjectAnalytics = trackProjectAnalytics;
+const getProjectAnalyticsStats = async (params, query) => {
+    return (await __1.AbyssSpotlightCore.axios.get(`project-analytics/${params.projectId}/stats`, { params: query })).data;
+};
+exports.getProjectAnalyticsStats = getProjectAnalyticsStats;
+const getProjectPostAnalyticsStats = async (params) => {
+    return (await __1.AbyssSpotlightCore.axios.get(`project-analytics/${params.projectId}/posts/${params.projectPostId}/stats`)).data;
+};
+exports.getProjectPostAnalyticsStats = getProjectPostAnalyticsStats;

package/dist/api/project-event.api.d.ts

@@ -1,6 +1,7 @@
-import { IGetProjectEventParams, IGetProjectEventResponse, IDeleteProjectEventResponse, IDeleteProjectEventParams, IUpdateProjectEventParams, IUpdateProjectEventBody, IUpdateProjectEventResponse, ICreateProjectEventParams, ICreateProjectEventBody, ICreateProjectEventResponse, IPaginateProjectEventParams, IPaginateProjectEventQuery, IPaginateProjectEventResponse } from '..';
+import { IGetProjectEventParams, IGetProjectEventResponse, IDeleteProjectEventResponse, IDeleteProjectEventParams, IUpdateProjectEventParams, IUpdateProjectEventBody, IUpdateProjectEventResponse, ICreateProjectEventParams, ICreateProjectEventBody, ICreateProjectEventResponse, IPaginateProjectEventParams, IPaginateProjectEventQuery, IPaginateProjectEventResponse, IPaginatePublishedProjectEventPublicParams, IPaginatePublishedProjectEventPublicQuery, IPaginatePublishedProjectEventPublicResponse } from '..';
 export declare const getProjectEvent: (params: IGetProjectEventParams) => Promise<IGetProjectEventResponse>;
 export declare const paginateProjectEvent: (params: IPaginateProjectEventParams, query: IPaginateProjectEventQuery) => Promise<IPaginateProjectEventResponse>;
 export declare const deleteProjectEvent: (params: IDeleteProjectEventParams) => Promise<IDeleteProjectEventResponse>;
 export declare const updateProjectEvent: (params: IUpdateProjectEventParams, body: IUpdateProjectEventBody) => Promise<IUpdateProjectEventResponse>;
 export declare const createProjectEvent: (params: ICreateProjectEventParams, body: ICreateProjectEventBody) => Promise<ICreateProjectEventResponse>;
+export declare const paginatePublishedProjectEvent: (params: IPaginatePublishedProjectEventPublicParams, query: IPaginatePublishedProjectEventPublicQuery) => Promise<IPaginatePublishedProjectEventPublicResponse>;

package/dist/api/project-event.api.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProjectEvent = exports.updateProjectEvent = exports.deleteProjectEvent = exports.paginateProjectEvent = exports.getProjectEvent = void 0;
+exports.paginatePublishedProjectEvent = exports.createProjectEvent = exports.updateProjectEvent = exports.deleteProjectEvent = exports.paginateProjectEvent = exports.getProjectEvent = void 0;
 const __1 = require("..");
 const getProjectEvent = async (params) => {
     return (await __1.AbyssSpotlightCore.axios.get(`project-event/${params.projectId}/event/${params.projectEventId}`)).data;
@@ -22,3 +22,7 @@ const createProjectEvent = async (params, body) => {
     return (await __1.AbyssSpotlightCore.axios.post(`project-event/${params.projectId}/event`, body)).data;
 };
 exports.createProjectEvent = createProjectEvent;
+const paginatePublishedProjectEvent = async (params, query) => {
+    return (await __1.AbyssSpotlightCore.axios.get(`project/public/published/${params.projectId}/event/paginate`, { params: query })).data;
+};
+exports.paginatePublishedProjectEvent = paginatePublishedProjectEvent;

package/dist/api/project.api.d.ts

@@ -1,4 +1,4 @@
-import { IGetProjectParams, IGetProjectResponse, IUpdateProjectParams, IUpdateProjectResponse, IUpdateProjectBody, IPaginateProjectResponse, IPaginateProjectQuery, ICreateProjectResponse, ICreateProjectBody, IDeleteProjectResponse, IDeleteProjectParams, IGetBySlugProjectParams, IGetBySlugProjectResponse, ILinkToAbyssProjectParams, ILinkToAbyssProjectBody, ILinkToAbyssApplicationProjectResponse, ILinkToAbyssApplicationProjectBody, ILinkToAbyssApplicationProjectParams, IListByAbyssProjectIdProjectParams, IListByAbyssProjectIdProjectResponse, ITransferProjectParams, ITransferProjectBody, ITransferProjectResponse } from '..';
+import { IGetProjectParams, IGetProjectResponse, IUpdateProjectParams, IUpdateProjectResponse, IUpdateProjectBody, IPaginateProjectResponse, IPaginateProjectQuery, ICreateProjectResponse, ICreateProjectBody, IDeleteProjectResponse, IDeleteProjectParams, IGetBySlugProjectParams, IGetBySlugProjectResponse, ILinkToAbyssProjectParams, ILinkToAbyssProjectBody, ILinkToAbyssApplicationProjectResponse, ILinkToAbyssApplicationProjectBody, ILinkToAbyssApplicationProjectParams, IListByAbyssProjectIdProjectParams, IListByAbyssProjectIdProjectResponse, ITransferProjectParams, ITransferProjectBody, ITransferProjectResponse, IGlobalUserMetricsResponse, IListAllAccessibleProjectsResponse } from '..';
 export declare const getProject: (params: IGetProjectParams) => Promise<IGetProjectResponse>;
 export declare const listByAbyssProjectIdProject: (params: IListByAbyssProjectIdProjectParams) => Promise<IListByAbyssProjectIdProjectResponse>;
 export declare const getBySlugProject: (params: IGetBySlugProjectParams) => Promise<IGetBySlugProjectResponse>;
@@ -9,3 +9,5 @@ export declare const linkToAbyssProject: (params: ILinkToAbyssProjectParams, bod
 export declare const linkToAbyssApplicationProject: (params: ILinkToAbyssApplicationProjectParams, body: ILinkToAbyssApplicationProjectBody) => Promise<ILinkToAbyssApplicationProjectResponse>;
 export declare const createProject: (body: ICreateProjectBody) => Promise<ICreateProjectResponse>;
 export declare const transferProject: (params: ITransferProjectParams, body: ITransferProjectBody) => Promise<ITransferProjectResponse>;
+export declare const getGlobalUserMetrics: () => Promise<IGlobalUserMetricsResponse>;
+export declare const listAllAccessibleProjects: () => Promise<IListAllAccessibleProjectsResponse>;

package/dist/api/project.api.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.transferProject = exports.createProject = exports.linkToAbyssApplicationProject = exports.linkToAbyssProject = exports.updateProject = exports.paginateProject = exports.deleteProject = exports.getBySlugProject = exports.listByAbyssProjectIdProject = exports.getProject = void 0;
+exports.listAllAccessibleProjects = exports.getGlobalUserMetrics = exports.transferProject = exports.createProject = exports.linkToAbyssApplicationProject = exports.linkToAbyssProject = exports.updateProject = exports.paginateProject = exports.deleteProject = exports.getBySlugProject = exports.listByAbyssProjectIdProject = exports.getProject = void 0;
 const __1 = require("..");
 const getProject = async (params) => {
     return (await __1.AbyssSpotlightCore.axios.get(`project/${params.projectId}`))
@@ -45,3 +45,12 @@ const transferProject = async (params, body) => {
     return (await __1.AbyssSpotlightCore.axios.post(`project/${params.projectId}/transfer`, body)).data;
 };
 exports.transferProject = transferProject;
+const getGlobalUserMetrics = async () => {
+    return (await __1.AbyssSpotlightCore.axios.get(`project/global-metrics`))
+        .data;
+};
+exports.getGlobalUserMetrics = getGlobalUserMetrics;
+const listAllAccessibleProjects = async () => {
+    return (await __1.AbyssSpotlightCore.axios.get(`project/accessible`)).data;
+};
+exports.listAllAccessibleProjects = listAllAccessibleProjects;

package/dist/api/project.public.api.d.ts

@@ -1,4 +1,4 @@
-import { IPaginatePublishedProjectPublicResponse, IPaginatePublishedProjectPublicQuery, IGetPublishedProjectPublicResponse, IGetPublishedProjectPublicParams, IGetPublishedBySlugProjectPublicResponse, IGetPublishedBySlugProjectPublicParams, IGetPopularProjectPublicResponse, IPaginatePostProjectPublicParams, IPaginatePostProjectPublicQuery, IPaginatePostProjectPublicResponse, IGeneratePresentationProjectPublicBody, IGeneratePresentationProjectPublicResponse, IGeneratePostProjectPublicResponse, IGeneratePostProjectPublicBody, IRecordViewProjectPublicParams, IRecordViewProjectPublicResponse } from '..';
+import { IPaginatePublishedProjectPublicResponse, IPaginatePublishedProjectPublicQuery, IGetPublishedProjectPublicResponse, IGetPublishedProjectPublicParams, IGetPublishedBySlugProjectPublicResponse, IGetPublishedBySlugProjectPublicParams, IGetPopularProjectPublicResponse, IPaginatePostProjectPublicParams, IPaginatePostProjectPublicQuery, IPaginatePostProjectPublicResponse, IGeneratePresentationProjectPublicBody, IGeneratePresentationProjectPublicResponse, IGeneratePostProjectPublicResponse, IGeneratePostProjectPublicBody } from '..';
 export declare const getPublishedProjectPublic: (params: IGetPublishedProjectPublicParams) => Promise<IGetPublishedProjectPublicResponse>;
 export declare const paginatePostProjectPublic: (params: IPaginatePostProjectPublicParams, query: IPaginatePostProjectPublicQuery) => Promise<IPaginatePostProjectPublicResponse>;
 export declare const getPublishedBySlugProjectPublic: (params: IGetPublishedBySlugProjectPublicParams) => Promise<IGetPublishedBySlugProjectPublicResponse>;
@@ -6,4 +6,3 @@ export declare const paginatePublishedProjectPublic: (query: IPaginatePublishedP
 export declare const getPopularProjectPublic: () => Promise<IGetPopularProjectPublicResponse>;
 export declare const generatePresentationProjectPublic: (body: IGeneratePresentationProjectPublicBody) => Promise<IGeneratePresentationProjectPublicResponse>;
 export declare const generatePostProjectPublic: (body: IGeneratePostProjectPublicBody) => Promise<IGeneratePostProjectPublicResponse>;
-export declare const recordProjectView: (params: IRecordViewProjectPublicParams) => Promise<IRecordViewProjectPublicResponse>;

package/dist/api/project.public.api.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.recordProjectView = exports.generatePostProjectPublic = exports.generatePresentationProjectPublic = exports.getPopularProjectPublic = exports.paginatePublishedProjectPublic = exports.getPublishedBySlugProjectPublic = exports.paginatePostProjectPublic = exports.getPublishedProjectPublic = void 0;
+exports.generatePostProjectPublic = exports.generatePresentationProjectPublic = exports.getPopularProjectPublic = exports.paginatePublishedProjectPublic = exports.getPublishedBySlugProjectPublic = exports.paginatePostProjectPublic = exports.getPublishedProjectPublic = void 0;
 const __1 = require("..");
 const getPublishedProjectPublic = async (params) => {
     return (await __1.AbyssSpotlightCore.axios.get(`project/public/published/${params.projectId}`)).data;
@@ -30,7 +30,3 @@ const generatePostProjectPublic = async (body) => {
     return (await __1.AbyssSpotlightCore.axios.post(`project/public/generate-post`, body)).data;
 };
 exports.generatePostProjectPublic = generatePostProjectPublic;
-const recordProjectView = async (params) => {
-    return (await __1.AbyssSpotlightCore.axios.post(`project/public/published/${params.projectId}/record-view`)).data;
-};
-exports.recordProjectView = recordProjectView;

package/dist/index.d.ts

@@ -5,11 +5,13 @@ export * from './api';
 export * from './constants';
 export declare const API_KEY_HEADER = "abyss-spotlight-api-key";
 export declare const ADMIN_TOKEN_HEADER = "abyss-admin-token";
+export declare const ABYSS_USER_ANONYMOUS_IDENTIFIER = "abyss_user_anonymous_identifier";
 type CoreConfig = {
     token?: string;
     apiKey?: string;
     adminToken?: string;
     baseURL?: string;
+    abyssUserAnonymousIdentifier?: string;
 };
 export declare class AbyssSpotlightCore {
     private static config;

package/dist/index.js

@@ -30,7 +30,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AbyssSpotlightCore = exports.ADMIN_TOKEN_HEADER = exports.API_KEY_HEADER = void 0;
+exports.AbyssSpotlightCore = exports.ABYSS_USER_ANONYMOUS_IDENTIFIER = exports.ADMIN_TOKEN_HEADER = exports.API_KEY_HEADER = void 0;
 const axios_1 = __importDefault(require("axios"));
 const axios_retry_1 = __importStar(require("axios-retry"));
 __exportStar(require("./types"), exports);
@@ -40,6 +40,7 @@ __exportStar(require("./constants"), exports);
 const DEFAULT_BASE_URL = 'https://spotlight-api.abyss-project.fr/api/';
 exports.API_KEY_HEADER = 'abyss-spotlight-api-key';
 exports.ADMIN_TOKEN_HEADER = 'abyss-admin-token';
+exports.ABYSS_USER_ANONYMOUS_IDENTIFIER = 'abyss_user_anonymous_identifier';
 const NUMBER_RETRY_API = 10;
 const BASE_DELAY_BETWEEN_RETRY = 5000;
 const RETRY_CODES = [
@@ -73,6 +74,9 @@ class AbyssSpotlightCore {
         if (config.adminToken) {
             _a.axios.defaults.headers.common[exports.ADMIN_TOKEN_HEADER] = `${config.adminToken}`;
         }
+        if (config.abyssUserAnonymousIdentifier) {
+            _a.axios.defaults.headers.common[exports.ABYSS_USER_ANONYMOUS_IDENTIFIER] = `${config.abyssUserAnonymousIdentifier}`;
+        }
     }
     static getConfig() {
         return _a.config;
@@ -87,5 +91,6 @@ AbyssSpotlightCore.config = {
     applicationId: '',
     adminToken: '',
     baseURL: DEFAULT_BASE_URL,
+    abyssUserAnonymousIdentifier: '',
 };
 AbyssSpotlightCore.axios = axios_1.default.create({ baseURL: _a.config.baseURL });

package/dist/types/interface/api/index.d.ts

@@ -22,6 +22,7 @@ export * from './requests/project-post.request';
 export * from './requests/project-event.request';
 export * from './requests/project-follower.admin.request';
 export * from './requests/project-follower.request';
+export * from './requests/project-analytics.request';
 export * from './responses/abyss.admin.response';
 export * from './responses/monitor.response';
 export * from './responses/storage.admin.response';
@@ -43,3 +44,4 @@ export * from './responses/project-post.response';
 export * from './responses/project-event.response';
 export * from './responses/project-follower.admin.response';
 export * from './responses/project-follower.response';
+export * from './responses/project-analytics.response';

package/dist/types/interface/api/index.js

@@ -38,6 +38,7 @@ __exportStar(require("./requests/project-post.request"), exports);
 __exportStar(require("./requests/project-event.request"), exports);
 __exportStar(require("./requests/project-follower.admin.request"), exports);
 __exportStar(require("./requests/project-follower.request"), exports);
+__exportStar(require("./requests/project-analytics.request"), exports);
 __exportStar(require("./responses/abyss.admin.response"), exports);
 __exportStar(require("./responses/monitor.response"), exports);
 __exportStar(require("./responses/storage.admin.response"), exports);
@@ -59,3 +60,4 @@ __exportStar(require("./responses/project-post.response"), exports);
 __exportStar(require("./responses/project-event.response"), exports);
 __exportStar(require("./responses/project-follower.admin.response"), exports);
 __exportStar(require("./responses/project-follower.response"), exports);
+__exportStar(require("./responses/project-analytics.response"), exports);

package/dist/types/interface/api/requests/project-analytics.request.d.ts

@@ -0,0 +1,19 @@
+import { ProjectAnalyticsEventType } from '../..';
+export interface ITrackProjectAnalyticsParams {
+    projectId: string;
+}
+export interface ITrackProjectAnalyticsBody {
+    eventType: ProjectAnalyticsEventType | string;
+    projectPostId?: string;
+}
+export interface IGetProjectAnalyticsParams {
+    projectId: string;
+}
+export interface IGetProjectAnalyticsQuery {
+    startDate?: string;
+    endDate?: string;
+}
+export interface IGetProjectPostAnalyticsParams {
+    projectId: string;
+    projectPostId: string;
+}

package/dist/types/interface/api/requests/project-analytics.request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/api/requests/project-post-analytics.request.d.ts

@@ -0,0 +1,4 @@
+export interface IGetProjectPostAnalyticsParams {
+    projectId: string;
+    projectPostId: string;
+}

package/dist/types/interface/api/requests/project-post-analytics.request.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/api/requests/project.public.request.d.ts

@@ -32,6 +32,7 @@ export interface IGeneratePostProjectPublicBody {
         url: string;
     }[];
 }
-export interface IRecordViewProjectPublicParams {
+export interface IPaginatePublishedProjectEventPublicParams {
     projectId: string;
 }
+export type IPaginatePublishedProjectEventPublicQuery = QueryPaginate;

package/dist/types/interface/api/responses/project-analytics.response.d.ts

@@ -0,0 +1,77 @@
+import { IResponse } from '../..';
+export interface ITrackProjectAnalyticsData {
+}
+export type ITrackProjectAnalyticsResponse = IResponse<ITrackProjectAnalyticsData>;
+export interface IProjectPostAnalytics {
+    period: {
+        startDate: string;
+        endDate: string;
+    };
+    totals: {
+        views: number;
+        uniqueViews: number;
+        prints: number;
+    };
+    trends: {
+        last7Days: {
+            views: number;
+            uniqueViews: number;
+            prints: number;
+        };
+        last30Days: {
+            views: number;
+            uniqueViews: number;
+            prints: number;
+        };
+    };
+    timeSeries: Array<{
+        date: string;
+        views: number;
+        uniqueViews: number;
+        prints: number;
+    }>;
+}
+export interface IGetProjectPostAnalyticsData {
+    analytics: IProjectPostAnalytics;
+}
+export type IGetProjectPostAnalyticsResponse = IResponse<IGetProjectPostAnalyticsData>;
+export interface IProjectAnalyticsStats {
+    period: {
+        startDate: string;
+        endDate: string;
+    };
+    metrics: {
+        contactClicks: number;
+        joinClicks: number;
+        accessClicks: number;
+        postViews: number;
+        starsAdded: number;
+        starsRemoved: number;
+        followersAdded: number;
+        followersRemoved: number;
+        view: number;
+        uniqView: number;
+        prints: number;
+    };
+    timeSeries: Array<{
+        date: string;
+        contactClicks: number;
+        joinClicks: number;
+        accessClicks: number;
+        postViews: number;
+        view: number;
+        uniqView: number;
+        prints: number;
+        starsAdded: number;
+        starsRemoved: number;
+        followersAdded: number;
+        followersRemoved: number;
+        stars: number;
+        followers: number;
+        posts: number;
+    }>;
+}
+export interface IGetProjectAnalyticsData {
+    current: IProjectAnalyticsStats;
+}
+export type IGetProjectAnalyticsResponse = IResponse<IGetProjectAnalyticsData>;

package/dist/types/interface/api/responses/project-analytics.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/api/responses/project-post-analytics.response.d.ts

@@ -0,0 +1,34 @@
+import { IResponse } from '../..';
+export interface IProjectPostAnalytics {
+    period: {
+        startDate: string;
+        endDate: string;
+    };
+    totals: {
+        views: number;
+        uniqueViews: number;
+        prints: number;
+    };
+    trends: {
+        last7Days: {
+            views: number;
+            uniqueViews: number;
+            prints: number;
+        };
+        last30Days: {
+            views: number;
+            uniqueViews: number;
+            prints: number;
+        };
+    };
+    timeSeries: Array<{
+        date: string;
+        views: number;
+        uniqueViews: number;
+        prints: number;
+    }>;
+}
+export interface IGetProjectPostAnalyticsData {
+    analytics: IProjectPostAnalytics;
+}
+export type IGetProjectPostAnalyticsResponse = IResponse<IGetProjectPostAnalyticsData>;

package/dist/types/interface/api/responses/project-post-analytics.response.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/interface/api/responses/project.public.response.d.ts

@@ -1,4 +1,4 @@
-import { BasePaginate, IProject, IProjectPost, IResponse, ProjectMetrics, ProjectWithMetrics } from '../..';
+import { BasePaginate, IProject, IProjectEvent, IProjectPost, IResponse, ProjectMetrics, ProjectWithMetrics } from '../..';
 import { ProjectCategory, ProjectLanguage, ProjectStatus } from '../../../enum';
 export interface IGetPublishedProjectPublicData {
     project: IProject;
@@ -43,6 +43,4 @@ export interface IGeneratePostProjectPublicData {
     content: string;
 }
 export type IGeneratePostProjectPublicResponse = IResponse<IGeneratePostProjectPublicData>;
-export interface IRecordViewProjectPublicData {
-}
-export type IRecordViewProjectPublicResponse = IResponse<IRecordViewProjectPublicData>;
+export type IPaginatePublishedProjectEventPublicResponse = IResponse<BasePaginate<IProjectEvent>>;

package/dist/types/interface/api/responses/project.response.d.ts

@@ -9,6 +9,15 @@ export type ProjectMetrics = {
         lastFollowedAt: Date | null;
     };
     view: {
+        total: number;
+        uniqTotal: number;
+        totalPrint: number;
+        history: {
+            date: string;
+            count: number;
+        }[];
+    };
+    post: {
         total: number;
         history: {
             date: string;
@@ -54,3 +63,14 @@ export interface ITransferProjectData {
     project: IProject;
 }
 export type ITransferProjectResponse = IResponse<ITransferProjectData>;
+export interface IGlobalUserMetricsData {
+    totalPosts: number;
+    totalViews: number;
+    totalFollowers: number;
+    totalStars: number;
+}
+export type IGlobalUserMetricsResponse = IResponse<IGlobalUserMetricsData>;
+export interface IListAllAccessibleProjectsData {
+    projects: ProjectWithMetrics[];
+}
+export type IListAllAccessibleProjectsResponse = IResponse<IListAllAccessibleProjectsData>;

package/dist/types/interface/index.d.ts

@@ -8,12 +8,14 @@ export * from './models/project-follower.model';
 export * from './models/project-document.model';
 export * from './models/project-star.model';
 export * from './models/project-social-network.model';
-export * from './models/project-view.model';
+export * from './models/project-analytics.model';
 export * from './api';
 export type ProjectWithMetrics = IProject & {
     starCount: number;
     viewCount: number;
+    uniqViewCount: number;
     followerCount: number;
+    postCount: number;
     userIsFollowing: boolean;
     userHasStarred: boolean;
 };

package/dist/types/interface/index.js

@@ -23,5 +23,5 @@ __exportStar(require("./models/project-follower.model"), exports);
 __exportStar(require("./models/project-document.model"), exports);
 __exportStar(require("./models/project-star.model"), exports);
 __exportStar(require("./models/project-social-network.model"), exports);
-__exportStar(require("./models/project-view.model"), exports);
+__exportStar(require("./models/project-analytics.model"), exports);
 __exportStar(require("./api"), exports);

package/dist/types/interface/models/project-analytics.model.d.ts

@@ -0,0 +1,28 @@
+import { IProject } from './project.model';
+import { IUser } from './user.model';
+import { IProjectPost } from './project-post.model';
+export declare enum ProjectAnalyticsEventType {
+    CONTACT_CLICK = "contact_click",
+    JOIN_CLICK = "join_click",
+    ACCESS_CLICK = "access_click",
+    STAR_ADD = "star_add",
+    STAR_REMOVE = "star_remove",
+    FOLLOWER_ADD = "follower_add",
+    FOLLOWER_REMOVE = "follower_remove",
+    POST_VIEW = "post_view",
+    PROJECT_VIEW = "project_view"
+}
+export interface IProjectAnalytics {
+    id: string;
+    projectId: string;
+    userId: string | null;
+    anonymousId: string;
+    eventType: ProjectAnalyticsEventType | string;
+    projectPostId: string | null;
+    metadata: Record<string, any> | null;
+    createdAt?: Date;
+    updatedAt?: Date;
+    project?: IProject;
+    user?: IUser | null;
+    projectPost?: IProjectPost | null;
+}

package/dist/types/interface/models/project-analytics.model.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProjectAnalyticsEventType = void 0;
+var ProjectAnalyticsEventType;
+(function (ProjectAnalyticsEventType) {
+    ProjectAnalyticsEventType["CONTACT_CLICK"] = "contact_click";
+    ProjectAnalyticsEventType["JOIN_CLICK"] = "join_click";
+    ProjectAnalyticsEventType["ACCESS_CLICK"] = "access_click";
+    ProjectAnalyticsEventType["STAR_ADD"] = "star_add";
+    ProjectAnalyticsEventType["STAR_REMOVE"] = "star_remove";
+    ProjectAnalyticsEventType["FOLLOWER_ADD"] = "follower_add";
+    ProjectAnalyticsEventType["FOLLOWER_REMOVE"] = "follower_remove";
+    ProjectAnalyticsEventType["POST_VIEW"] = "post_view";
+    ProjectAnalyticsEventType["PROJECT_VIEW"] = "project_view";
+})(ProjectAnalyticsEventType || (exports.ProjectAnalyticsEventType = ProjectAnalyticsEventType = {}));

package/dist/types/interface/models/project.model.d.ts

@@ -7,7 +7,6 @@ import { IProjectPost } from './project-post.model';
 import { IProjectPresentation } from './project-presentation.model';
 import { IProjectSocialNetwork } from './project-social-network.model';
 import { IProjectStar } from './project-star.model';
-import { IProjectView } from './project-view.model';
 import { IUser } from './user.model';
 export interface IProject {
     id?: string;
@@ -34,6 +33,5 @@ export interface IProject {
     projectFollower?: IProjectFollower[];
     projectDocument?: IProjectDocument[];
     projectStar?: IProjectStar[];
-    projectView?: IProjectView[];
     projectSocialNetwork?: IProjectSocialNetwork[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abyss-project/spotlight",
-  "version": "1.0.11",
+  "version": "1.0.13",
   "description": "Core package to interact with Abyss-Spotlight",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",