@abyss-project/link 1.0.0 → 1.1.0

package/src/types/interface/api/responses/link.admin.response.ts

@@ -0,0 +1,56 @@
+import { ILink, ILinkStats, ILinkVisit } from '../../models/link.dto';
+import { ILinkCampaignStatsRow } from '../../models/link-list.dto';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IResponse } from '../type-message/response';
+
+export type IPaginateLinkAdminData = BasePaginate<ILink>;
+export type IPaginateLinkAdminResponse = IResponse<IPaginateLinkAdminData>;
+
+export interface IGetLinkAdminData {
+  link: ILink;
+}
+export type IGetLinkAdminResponse = IResponse<IGetLinkAdminData>;
+
+export type IGetVisitsLinkAdminData = BasePaginate<ILinkVisit>;
+export type IGetVisitsLinkAdminResponse = IResponse<IGetVisitsLinkAdminData>;
+
+export interface IGetCampaignStatsLinkAdminData {
+  rows: ILinkCampaignStatsRow[];
+}
+export type IGetCampaignStatsLinkAdminResponse = IResponse<IGetCampaignStatsLinkAdminData>;
+
+export interface ISetProtectionLinkAdminData {
+  link: ILink;
+}
+export type ISetProtectionLinkAdminResponse = IResponse<ISetProtectionLinkAdminData>;
+
+export interface IUpdateLinkAdminData {
+  link: ILink;
+}
+export type IUpdateLinkAdminResponse = IResponse<IUpdateLinkAdminData>;
+
+export type IDeleteLinkAdminResponse = IResponse<Record<string, never>>;
+
+export interface ICreateLinkAdminData {
+  link: ILink;
+}
+export type ICreateLinkAdminResponse = IResponse<ICreateLinkAdminData>;
+
+export interface IGetByOriginLinkAdminData {
+  link: ILink;
+}
+export type IGetByOriginLinkAdminResponse = IResponse<IGetByOriginLinkAdminData>;
+
+export interface IGetStatsByOriginLinkAdminData {
+  stats: ILinkStats;
+}
+export type IGetStatsByOriginLinkAdminResponse = IResponse<IGetStatsByOriginLinkAdminData>;
+
+export type IRecordCampaignViewLinkAdminResponse = IResponse<Record<string, never>>;
+
+export interface IListCampaignTokensLinkAdminData {
+  links: ILink[];
+}
+export type IListCampaignTokensLinkAdminResponse = IResponse<IListCampaignTokensLinkAdminData>;
+
+export type IDeleteCampaignTokenLinkAdminResponse = IResponse<Record<string, never>>;

package/src/types/interface/api/responses/link.public.response.ts

@@ -0,0 +1,7 @@
+import { IResponse } from '../type-message/response';
+
+export interface IUnlockLinkPublicData {
+  /** The destination, with the campaign parameters forwarded when the link asks for it. */
+  url: string;
+}
+export type IUnlockLinkPublicResponse = IResponse<IUnlockLinkPublicData>;

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

@@ -0,0 +1,55 @@
+import { ILink, ILinkStats, ILinkVisit } from '../../models/link.dto';
+import { ILinkListItem } from '../../models/link-list.dto';
+import { BasePaginate } from '../type-message/base-paginate';
+import { IResponse } from '../type-message/response';
+
+export interface IGetLinkData {
+  link: ILink;
+}
+export type IGetLinkResponse = IResponse<IGetLinkData>;
+
+export type IPaginateLinkData = BasePaginate<ILinkListItem>;
+export type IPaginateLinkResponse = IResponse<IPaginateLinkData>;
+
+/** `orphan` and `unshared` are given to an organization administrator in `adminView` only. */
+export interface ICountOrganizationLinkData {
+  total: number;
+  orphan?: number;
+  unshared?: number;
+}
+export type ICountOrganizationLinkResponse = IResponse<ICountOrganizationLinkData>;
+
+export interface ICreateLinkData {
+  link: ILink;
+}
+export type ICreateLinkResponse = IResponse<ICreateLinkData>;
+
+export interface IUpdateLinkData {
+  link: ILink;
+}
+export type IUpdateLinkResponse = IResponse<IUpdateLinkData>;
+
+export type IDeleteLinkResponse = IResponse<Record<string, never>>;
+
+export interface ITransferLinkData {
+  link: ILink;
+}
+export type ITransferLinkResponse = IResponse<ITransferLinkData>;
+
+export interface IGetLinkStatsData {
+  stats: ILinkStats;
+}
+export type IGetLinkStatsResponse = IResponse<IGetLinkStatsData>;
+
+export type IGetLinkVisitsData = BasePaginate<ILinkVisit>;
+export type IGetLinkVisitsResponse = IResponse<IGetLinkVisitsData>;
+
+export interface IGetByOriginLinkData {
+  link: ILink;
+}
+export type IGetByOriginLinkResponse = IResponse<IGetByOriginLinkData>;
+
+export interface IGetStatsByOriginLinkData {
+  stats: ILinkStats;
+}
+export type IGetStatsByOriginLinkResponse = IResponse<IGetStatsByOriginLinkData>;

package/src/types/interface/models/index.ts

@@ -2,3 +2,4 @@ export * from './user.dto';
 export * from './organization.dto';
 export * from './project.dto';
 export * from './link.dto';
+export * from './link-list.dto';

package/src/types/interface/models/link-list.dto.ts

@@ -0,0 +1,28 @@
+import { LinkSharePermission } from '../../enum/link-share.enum';
+import { ILink } from './link.dto';
+
+/** A content share of a link, as abyss-main holds it (the fields the Links screen shows). */
+export interface ILinkContentShare {
+  id: string;
+  /** `USER`, `TEAM`, `ORGANIZATION`, `PROJECT` or `PUBLIC` on abyss-main's side. */
+  targetType: string;
+  targetId: string | null;
+  permission: LinkSharePermission;
+  expiresAt: string | null;
+  createdByUserId: string | null;
+}
+
+/** A link of a list, with the caller's permission on it and its shares. */
+export interface ILinkListItem extends ILink {
+  permission: LinkSharePermission;
+  shares: ILinkContentShare[];
+}
+
+/** One row of the campaign statistics of a link: human visits grouped by campaign and medium. */
+export interface ILinkCampaignStatsRow {
+  utmCampaign: string | null;
+  utmMedium: string | null;
+  visits: number;
+  /** Sum over the days of the distinct visitors of each day (the visitor hash lives one day). */
+  uniqueVisitors: number;
+}

package/src/types/tests/link-enums.spec.ts

@@ -1,4 +1,5 @@
 import {
+  CAMPAIGN_TOKEN_QUERY_PARAM,
   LINK_CAMPAIGN_TOKEN_LENGTH,
   LINK_CAMPAIGN_TOKENS_PER_PROJECT,
   LINK_RESOURCE_CODE_LENGTH,
@@ -41,6 +42,7 @@ describe('link limits', () => {
     expect(LINK_RESOURCE_CODE_LENGTH).toBe(10);
     expect(LINK_CAMPAIGN_TOKEN_LENGTH).toBe(12);
     expect(LINK_CAMPAIGN_TOKENS_PER_PROJECT).toBe(50);
+    expect(CAMPAIGN_TOKEN_QUERY_PARAM).toBe('lnk');
     expect(LINK_VISIT_RETENTION_DAYS).toBe(90);
   });
 });