@abyss-project/main 1.0.66 → 1.0.67

package/dist/api/index.d.ts

@@ -41,3 +41,4 @@ export * from './atlas-group.api';
 export * from './atlas-page.api';
 export * from './atlas.public.api';
 export * from './memo.api';
+export * from './short-link.api';

package/dist/api/index.js

@@ -57,3 +57,4 @@ __exportStar(require("./atlas-group.api"), exports);
 __exportStar(require("./atlas-page.api"), exports);
 __exportStar(require("./atlas.public.api"), exports);
 __exportStar(require("./memo.api"), exports);
+__exportStar(require("./short-link.api"), exports);

package/dist/api/short-link.api.d.ts

@@ -0,0 +1,15 @@
+import type { IGetShortLinkParams, IGetShortLinkResponse, IGetShortLinkBySlugParams, IGetShortLinkBySlugResponse, IValidateShortLinkPasswordBody, IValidateShortLinkPasswordResponse, IPaginateShortLinkQuery, IPaginateShortLinkResponse, IPaginateUserShortLinkQuery, IPaginateProjectShortLinkParams, IPaginateProjectShortLinkQuery, ICreateShortLinkBody, ICreateShortLinkResponse, ICreateForProjectShortLinkParams, IUpdateShortLinkParams, IUpdateShortLinkBody, IUpdateShortLinkResponse, IDeleteShortLinkParams, IDeleteShortLinkResponse, IGetShortLinkStatsParams, IGetShortLinkStatsQuery, IGetShortLinkStatsResponse } from '../types';
+export declare const shortLinkApi: {
+    get: (params: IGetShortLinkParams) => Promise<IGetShortLinkResponse>;
+    getBySlug: (params: IGetShortLinkBySlugParams) => Promise<IGetShortLinkBySlugResponse>;
+    validatePassword: (params: IGetShortLinkBySlugParams, body: IValidateShortLinkPasswordBody) => Promise<IValidateShortLinkPasswordResponse>;
+    paginate: (query: IPaginateShortLinkQuery) => Promise<IPaginateShortLinkResponse>;
+    paginateUser: (query: IPaginateUserShortLinkQuery) => Promise<IPaginateShortLinkResponse>;
+    paginateProject: (params: IPaginateProjectShortLinkParams, query: IPaginateProjectShortLinkQuery) => Promise<IPaginateShortLinkResponse>;
+    create: (body: ICreateShortLinkBody) => Promise<ICreateShortLinkResponse>;
+    createAnonymous: (body: ICreateShortLinkBody) => Promise<ICreateShortLinkResponse>;
+    createForProject: (params: ICreateForProjectShortLinkParams, body: ICreateShortLinkBody) => Promise<ICreateShortLinkResponse>;
+    update: (params: IUpdateShortLinkParams, body: IUpdateShortLinkBody) => Promise<IUpdateShortLinkResponse>;
+    delete: (params: IDeleteShortLinkParams) => Promise<IDeleteShortLinkResponse>;
+    getStats: (params: IGetShortLinkStatsParams, query?: IGetShortLinkStatsQuery) => Promise<IGetShortLinkStatsResponse>;
+};

package/dist/api/short-link.api.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shortLinkApi = void 0;
+const index_1 = require("../index");
+exports.shortLinkApi = {
+    get: async (params) => {
+        const response = await index_1.AbyssCore.axios.get(`/short-link/${params.shortLinkId}`);
+        return response.data;
+    },
+    getBySlug: async (params) => {
+        const response = await index_1.AbyssCore.axios.get(`/short-link/slug/${params.slug}`);
+        return response.data;
+    },
+    validatePassword: async (params, body) => {
+        const response = await index_1.AbyssCore.axios.post(`/short-link/slug/${params.slug}/validate-password`, body);
+        return response.data;
+    },
+    paginate: async (query) => {
+        const response = await index_1.AbyssCore.axios.get('/short-link/paginate', { params: query });
+        return response.data;
+    },
+    paginateUser: async (query) => {
+        const response = await index_1.AbyssCore.axios.get('/short-link/user/paginate', { params: query });
+        return response.data;
+    },
+    paginateProject: async (params, query) => {
+        const response = await index_1.AbyssCore.axios.get(`/short-link/project/${params.projectId}/paginate`, {
+            params: query,
+        });
+        return response.data;
+    },
+    create: async (body) => {
+        const response = await index_1.AbyssCore.axios.post('/short-link/create', body);
+        return response.data;
+    },
+    createAnonymous: async (body) => {
+        const response = await index_1.AbyssCore.axios.post('/short-link/create-anonymous', body);
+        return response.data;
+    },
+    createForProject: async (params, body) => {
+        const response = await index_1.AbyssCore.axios.post(`/short-link/project/${params.projectId}/create`, body);
+        return response.data;
+    },
+    update: async (params, body) => {
+        const response = await index_1.AbyssCore.axios.put(`/short-link/${params.shortLinkId}`, body);
+        return response.data;
+    },
+    delete: async (params) => {
+        const response = await index_1.AbyssCore.axios.delete(`/short-link/${params.shortLinkId}`);
+        return response.data;
+    },
+    getStats: async (params, query) => {
+        const response = await index_1.AbyssCore.axios.get(`/short-link/${params.shortLinkId}/stats`, {
+            params: query,
+        });
+        return response.data;
+    },
+};

package/dist/types/enum/abyss-application-event.enum.d.ts

@@ -21,6 +21,9 @@ export declare enum AbyssApplicationEvent {
     SERVER_SENT_EVENTS_ATLAS_OPEN = "server-sent-events.atlas.open",
     SERVER_SENT_EVENTS_ATLAS_CLOSE = "server-sent-events.atlas.close",
     SERVER_SENT_EVENTS_ATLAS_SEND = "server-sent-events.atlas.send",
+    SERVER_SENT_EVENTS_CLOUD_OPEN = "server-sent-events.cloud.open",
+    SERVER_SENT_EVENTS_CLOUD_CLOSE = "server-sent-events.cloud.close",
+    SERVER_SENT_EVENTS_CLOUD_SEND = "server-sent-events.cloud.send",
     BOARD_CREATE = "board.create",
     BOARD_UPDATE = "board.update",
     BOARD_DELETE = "board.delete",

package/dist/types/enum/abyss-application-event.enum.js

@@ -25,6 +25,9 @@ var AbyssApplicationEvent;
     AbyssApplicationEvent["SERVER_SENT_EVENTS_ATLAS_OPEN"] = "server-sent-events.atlas.open";
     AbyssApplicationEvent["SERVER_SENT_EVENTS_ATLAS_CLOSE"] = "server-sent-events.atlas.close";
     AbyssApplicationEvent["SERVER_SENT_EVENTS_ATLAS_SEND"] = "server-sent-events.atlas.send";
+    AbyssApplicationEvent["SERVER_SENT_EVENTS_CLOUD_OPEN"] = "server-sent-events.cloud.open";
+    AbyssApplicationEvent["SERVER_SENT_EVENTS_CLOUD_CLOSE"] = "server-sent-events.cloud.close";
+    AbyssApplicationEvent["SERVER_SENT_EVENTS_CLOUD_SEND"] = "server-sent-events.cloud.send";
     AbyssApplicationEvent["BOARD_CREATE"] = "board.create";
     AbyssApplicationEvent["BOARD_UPDATE"] = "board.update";
     AbyssApplicationEvent["BOARD_DELETE"] = "board.delete";

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

@@ -43,6 +43,8 @@ export * from './requests/atlas-page.request';
 export * from './requests/atlas-group.request';
 export * from './requests/atlas.public.request';
 export * from './requests/memo.request';
+export * from './requests/short-link.request';
+export * from './requests/short-link.admin.request';
 export * from './responses/auth.response';
 export * from './responses/user.response';
 export * from './responses/user.admin.response';
@@ -86,3 +88,5 @@ export * from './responses/atlas-page.response';
 export * from './responses/atlas-group.response';
 export * from './responses/atlas.public.response';
 export * from './responses/memo.response';
+export * from './responses/short-link.response';
+export * from './responses/short-link.admin.response';

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

@@ -59,6 +59,8 @@ __exportStar(require("./requests/atlas-page.request"), exports);
 __exportStar(require("./requests/atlas-group.request"), exports);
 __exportStar(require("./requests/atlas.public.request"), exports);
 __exportStar(require("./requests/memo.request"), exports);
+__exportStar(require("./requests/short-link.request"), exports);
+__exportStar(require("./requests/short-link.admin.request"), exports);
 __exportStar(require("./responses/auth.response"), exports);
 __exportStar(require("./responses/user.response"), exports);
 __exportStar(require("./responses/user.admin.response"), exports);
@@ -102,3 +104,5 @@ __exportStar(require("./responses/atlas-page.response"), exports);
 __exportStar(require("./responses/atlas-group.response"), exports);
 __exportStar(require("./responses/atlas.public.response"), exports);
 __exportStar(require("./responses/memo.response"), exports);
+__exportStar(require("./responses/short-link.response"), exports);
+__exportStar(require("./responses/short-link.admin.response"), exports);

package/dist/types/interface/api/requests/short-link.admin.request.d.ts

@@ -0,0 +1,26 @@
+import { QueryPaginate } from '../type-message/base-paginate';
+export type IPaginateShortLinkAdminQuery = {
+    title?: string;
+    userId?: string;
+    projectId?: string;
+    isActive?: boolean;
+} & QueryPaginate;
+export type IGetShortLinkAdminParams = {
+    shortLinkId: string;
+};
+export type IDeleteShortLinkAdminParams = {
+    shortLinkId: string;
+};
+export type IUpdateShortLinkAdminParams = {
+    shortLinkId: string;
+};
+export type IUpdateShortLinkAdminBody = {
+    originalUrl?: string;
+    slug?: string;
+    title?: string;
+    description?: string;
+    isActive?: boolean;
+    expiresAt?: Date | null;
+    maxClicks?: number | null;
+    password?: string | null;
+};

package/dist/types/interface/api/requests/short-link.admin.request.js

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

package/dist/types/interface/api/requests/short-link.request.d.ts

@@ -0,0 +1,66 @@
+import { QueryPaginate } from '../type-message/base-paginate';
+export type IGetShortLinkParams = {
+    shortLinkId: string;
+};
+export type IGetShortLinkBySlugParams = {
+    slug: string;
+};
+export type IValidateShortLinkPasswordBody = {
+    password: string;
+};
+export type IPaginateShortLinkQuery = {
+    title?: string;
+    userId?: string;
+    projectId?: string;
+    isActive?: boolean;
+} & QueryPaginate;
+export type IPaginateUserShortLinkQuery = {
+    title?: string;
+    isActive?: boolean;
+} & QueryPaginate;
+export type IPaginateProjectShortLinkParams = {
+    projectId: string;
+};
+export type IPaginateProjectShortLinkQuery = {
+    title?: string;
+    isActive?: boolean;
+} & QueryPaginate;
+export type ICreateShortLinkBody = {
+    originalUrl: string;
+    slug?: string;
+    title?: string;
+    description?: string;
+    expiresAt?: Date;
+    maxClicks?: number;
+    password?: string;
+};
+export type ICreateForProjectShortLinkParams = {
+    projectId: string;
+};
+export type IUpdateShortLinkParams = {
+    shortLinkId: string;
+};
+export type IUpdateShortLinkBody = {
+    originalUrl?: string;
+    slug?: string;
+    title?: string;
+    description?: string;
+    isActive?: boolean;
+    expiresAt?: Date | null;
+    maxClicks?: number | null;
+    password?: string | null;
+};
+export type IDeleteShortLinkParams = {
+    shortLinkId: string;
+};
+export type IGetShortLinkStatsParams = {
+    shortLinkId: string;
+};
+export type IGetShortLinkStatsQuery = {
+    startDate?: string;
+    endDate?: string;
+    groupBy?: 'day' | 'week' | 'month';
+};
+export type IRedirectShortLinkParams = {
+    slug: string;
+};

package/dist/types/interface/api/requests/short-link.request.js

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

package/dist/types/interface/api/responses/short-link.admin.response.d.ts

@@ -0,0 +1,14 @@
+import { BasePaginate, IResponse } from '..';
+import { IShortLink } from '../../models/short-link.model';
+export type IPaginateShortLinkAdminResponse = IResponse<BasePaginate<IShortLink>>;
+export interface IGetShortLinkAdminData {
+    shortLink: IShortLink;
+}
+export type IGetShortLinkAdminResponse = IResponse<IGetShortLinkAdminData>;
+export interface IDeleteShortLinkAdminData {
+}
+export type IDeleteShortLinkAdminResponse = IResponse<IDeleteShortLinkAdminData>;
+export interface IUpdateShortLinkAdminData {
+    shortLink: IShortLink;
+}
+export type IUpdateShortLinkAdminResponse = IResponse<IUpdateShortLinkAdminData>;

package/dist/types/interface/api/responses/short-link.admin.response.js

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

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

@@ -0,0 +1,35 @@
+import { BasePaginate, IResponse } from '..';
+import { IShortLink, IShortLinkWithStats } from '../../models/short-link.model';
+export interface IGetShortLinkData {
+    shortLink: IShortLink;
+}
+export type IGetShortLinkResponse = IResponse<IGetShortLinkData>;
+export interface IGetShortLinkBySlugData {
+    shortLink: IShortLink;
+    requiresPassword: boolean;
+}
+export type IGetShortLinkBySlugResponse = IResponse<IGetShortLinkBySlugData>;
+export interface IValidateShortLinkPasswordData {
+    valid: boolean;
+}
+export type IValidateShortLinkPasswordResponse = IResponse<IValidateShortLinkPasswordData>;
+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 IGetShortLinkStatsData {
+    shortLink: IShortLinkWithStats;
+}
+export type IGetShortLinkStatsResponse = IResponse<IGetShortLinkStatsData>;
+export interface IRedirectShortLinkData {
+    url: string;
+}
+export type IRedirectShortLinkResponse = IResponse<IRedirectShortLinkData>;

package/dist/types/interface/api/responses/short-link.response.js

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

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

@@ -40,3 +40,5 @@ export * from './models/atlas-group.model';
 export * from './models/atlas-page.model';
 export * from './models/atlas-page-content.model';
 export * from './models/memo.model';
+export * from './models/short-link.model';
+export * from './models/short-link-click.model';

package/dist/types/interface/index.js

@@ -56,3 +56,5 @@ __exportStar(require("./models/atlas-group.model"), exports);
 __exportStar(require("./models/atlas-page.model"), exports);
 __exportStar(require("./models/atlas-page-content.model"), exports);
 __exportStar(require("./models/memo.model"), exports);
+__exportStar(require("./models/short-link.model"), exports);
+__exportStar(require("./models/short-link-click.model"), exports);

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

@@ -9,6 +9,7 @@ import { IDraw } from './draw.model';
 import { IAtlas } from './atlas.model';
 import { IRetrospective } from './retrospective.model';
 import { IMemo } from './memo.model';
+import { IShortLink } from './short-link.model';
 export interface IProject {
     id?: string;
     name: string;
@@ -29,4 +30,5 @@ export interface IProject {
     retrospective?: IRetrospective[];
     atlas?: IAtlas[];
     memo?: IMemo[];
+    shortLink?: IShortLink[];
 }

package/dist/types/interface/models/short-link-click.model.d.ts

@@ -0,0 +1,18 @@
+import { IShortLink } from './short-link.model';
+export interface IShortLinkClick {
+    id: string;
+    shortLinkId: string;
+    ipAddress: string | null;
+    ipHash: string;
+    userAgent: string | null;
+    referer: string | null;
+    country: string | null;
+    city: string | null;
+    device: string | null;
+    browser: string | null;
+    os: string | null;
+    clickedAt: Date;
+    createdAt?: Date;
+    updatedAt?: Date;
+    shortLink?: IShortLink;
+}

package/dist/types/interface/models/short-link-click.model.js

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

package/dist/types/interface/models/short-link.model.d.ts

@@ -0,0 +1,50 @@
+import { IUser } from './user.model';
+import { IProject } from './project.model';
+import { IShortLinkClick } from './short-link-click.model';
+export interface IShortLink {
+    id: string;
+    slug: string;
+    originalUrl: string;
+    title: string | null;
+    description: string | null;
+    userId: string | null;
+    projectId: string | null;
+    isActive: boolean;
+    clickCount: number;
+    uniqueClickCount: number;
+    lastClickedAt: Date | null;
+    expiresAt: Date | null;
+    maxClicks: number | null;
+    password: string | null;
+    createdAt?: Date;
+    updatedAt?: Date;
+    deletedAt?: Date | null;
+    user?: IUser | null;
+    project?: IProject | null;
+    shortLinkClick?: IShortLinkClick[];
+}
+export interface IShortLinkWithStats extends IShortLink {
+    stats?: {
+        clicksByDay: {
+            date: string;
+            clicks: number;
+            uniqueClicks: number;
+        }[];
+        clicksByCountry: {
+            country: string;
+            clicks: number;
+        }[];
+        clicksByDevice: {
+            device: string;
+            clicks: number;
+        }[];
+        clicksByBrowser: {
+            browser: string;
+            clicks: number;
+        }[];
+        clicksByReferer: {
+            referer: string;
+            clicks: number;
+        }[];
+    };
+}

package/dist/types/interface/models/short-link.model.js

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

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

@@ -1,4 +1,4 @@
-import { IAtlas, IBoard, IGiftCodeActivation, IMemo, IOAuthAccount, IProject, IRetrospective, IUserTransaction } from '..';
+import { IAtlas, IBoard, IGiftCodeActivation, IMemo, IOAuthAccount, IProject, IRetrospective, IShortLink, IUserTransaction } from '..';
 import { AbyssService, OnboardingSteps, UserCreditPurchaseCurrency, UserLanguage, UserType } from '../../enum';
 import { OnboardingData } from '../../utils';
 import { IBoardCardComment } from './board-card-comment.model';
@@ -46,6 +46,7 @@ export interface IUser {
     retrospective?: IRetrospective[];
     atlas?: IAtlas[];
     memo?: IMemo[];
+    shortLink?: IShortLink[];
 }
 export type UserOnboardingStatus = {
     completedAt?: Date | null;

package/package.json

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