@abyss-project/link 1.0.0 → 1.1.0

package/dist/types/interface/api/requests/link.public.request.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=link.public.request.js.map

package/dist/types/interface/api/requests/link.public.request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link.public.request.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/requests/link.public.request.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,74 @@
+import { LinkShareScope } from '../../../enum/link-share.enum';
+import { LinkStatsGranularity } from '../../../enum/link-stats.enum';
+import { ILinkOrigin } from '../../models/link.dto';
+import { QueryPaginate } from '../type-message/base-paginate';
+export interface ILinkIdParams {
+    linkId: string;
+}
+export type IGetLinkParams = ILinkIdParams;
+export type IUpdateLinkParams = ILinkIdParams;
+export type IDeleteLinkParams = ILinkIdParams;
+export type ITransferLinkParams = ILinkIdParams;
+export type IGetLinkStatsParams = ILinkIdParams;
+export type IGetLinkVisitsParams = ILinkIdParams;
+export interface IPaginateLinkQuery extends QueryPaginate {
+    search?: string;
+    isActive?: boolean;
+}
+export interface IPaginateProjectLinkParams {
+    projectId: string;
+}
+export interface IPaginateOrganizationLinkParams {
+    organizationId: string;
+}
+export interface IPaginateOrganizationLinkQuery extends IPaginateLinkQuery {
+    scope?: LinkShareScope;
+    teamId?: string;
+    projectId?: string;
+    adminView?: boolean;
+}
+export interface ICountOrganizationLinkParams {
+    organizationId: string;
+}
+export interface ICountOrganizationLinkQuery {
+    adminView?: boolean;
+}
+export interface ICreateLinkBody {
+    targetUrl: string;
+    slug?: string;
+    password?: string;
+    title?: string;
+    description?: string;
+    expiresAt?: Date | string;
+    maxClicks?: number;
+    forwardCampaignParams?: boolean;
+}
+export interface ICreateForOrganizationLinkParams {
+    organizationId: string;
+}
+export interface ICreateForOrganizationLinkBody extends ICreateLinkBody {
+    projectId?: string;
+    scope?: 'USER';
+}
+export interface IUpdateLinkBody {
+    targetUrl?: string;
+    slug?: string;
+    password?: string | null;
+    title?: string | null;
+    description?: string | null;
+    isActive?: boolean;
+    expiresAt?: Date | string | null;
+    maxClicks?: number | null;
+    forwardCampaignParams?: boolean;
+}
+export interface ITransferLinkBody {
+    newOwnerId: string;
+}
+export interface IGetLinkStatsQuery {
+    from?: Date | string;
+    to?: Date | string;
+    granularity?: LinkStatsGranularity;
+}
+export type IGetLinkVisitsQuery = QueryPaginate;
+export type IGetByOriginLinkQuery = ILinkOrigin;
+export type IGetStatsByOriginLinkQuery = ILinkOrigin & IGetLinkStatsQuery;

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=link.request.js.map

package/dist/types/interface/api/requests/link.request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link.request.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/requests/link.request.ts"],"names":[],"mappings":""}

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

@@ -1 +1,4 @@
 export * from './abyss.admin.response';
+export * from './link.response';
+export * from './link.admin.response';
+export * from './link.public.response';

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

@@ -15,4 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./abyss.admin.response"), exports);
+__exportStar(require("./link.response"), exports);
+__exportStar(require("./link.admin.response"), exports);
+__exportStar(require("./link.public.response"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/responses/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/responses/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,kDAAgC;AAChC,wDAAsC;AACtC,yDAAuC"}

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

@@ -0,0 +1,43 @@
+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/dist/types/interface/api/responses/link.admin.response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=link.admin.response.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"link.admin.response.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/responses/link.admin.response.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,5 @@
+import { IResponse } from '../type-message/response';
+export interface IUnlockLinkPublicData {
+    url: string;
+}
+export type IUnlockLinkPublicResponse = IResponse<IUnlockLinkPublicData>;

package/dist/types/interface/api/responses/link.public.response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=link.public.response.js.map

package/dist/types/interface/api/responses/link.public.response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link.public.response.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/responses/link.public.response.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,43 @@
+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>;
+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/dist/types/interface/api/responses/link.response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=link.response.js.map

package/dist/types/interface/api/responses/link.response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link.response.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/responses/link.response.ts"],"names":[],"mappings":""}

package/dist/types/interface/models/index.d.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/dist/types/interface/models/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./user.dto"), exports);
 __exportStar(require("./organization.dto"), exports);
 __exportStar(require("./project.dto"), exports);
 __exportStar(require("./link.dto"), exports);
+__exportStar(require("./link-list.dto"), exports);
 //# sourceMappingURL=index.js.map

package/dist/types/interface/models/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/interface/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/interface/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,6CAA2B;AAC3B,kDAAgC"}

package/dist/types/interface/models/link-list.dto.d.ts

@@ -0,0 +1,20 @@
+import { LinkSharePermission } from '../../enum/link-share.enum';
+import { ILink } from './link.dto';
+export interface ILinkContentShare {
+    id: string;
+    targetType: string;
+    targetId: string | null;
+    permission: LinkSharePermission;
+    expiresAt: string | null;
+    createdByUserId: string | null;
+}
+export interface ILinkListItem extends ILink {
+    permission: LinkSharePermission;
+    shares: ILinkContentShare[];
+}
+export interface ILinkCampaignStatsRow {
+    utmCampaign: string | null;
+    utmMedium: string | null;
+    visits: number;
+    uniqueVisitors: number;
+}

package/dist/types/interface/models/link-list.dto.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=link-list.dto.js.map

package/dist/types/interface/models/link-list.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link-list.dto.js","sourceRoot":"","sources":["../../../../src/types/interface/models/link-list.dto.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,9 +1,22 @@
 {
   "name": "@abyss-project/link",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Core package to interact with AbyssLink",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "publishConfig": {
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts"
+  },
+  "scripts": {
+    "lint": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --fix",
+    "lint:check": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --max-warnings 0",
+    "tsc": "tsc",
+    "build": "tsc",
+    "test": "jest",
+    "prepublishOnly": "tsc && node ../../scripts/check-sdk-surface.cjs",
+    "dev": "tsc --watch"
+  },
   "repository": {
     "type": "git",
     "url": "https://gitlab.com/abyss-group/abyss-link.git"
@@ -47,13 +60,5 @@
     "ts-jest": "^29.4.15",
     "tsc-watch": "^4.6.2",
     "typescript": "5.9.3"
-  },
-  "scripts": {
-    "lint": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --fix",
-    "lint:check": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --max-warnings 0",
-    "tsc": "tsc",
-    "build": "tsc",
-    "test": "jest",
-    "dev": "tsc --watch"
   }
-}
+}

package/src/api/index.ts

@@ -1 +1,4 @@
 export * from './abyss.admin.api';
+export * from './link.api';
+export * from './link.admin.api';
+export * from './link.public.api';

package/src/api/link.admin.api.ts

@@ -0,0 +1,168 @@
+import {
+  AbyssLinkCore,
+  ICreateLinkAdminBody,
+  ICreateLinkAdminResponse,
+  IDeleteCampaignTokenLinkAdminParams,
+  IDeleteCampaignTokenLinkAdminResponse,
+  IDeleteLinkAdminParams,
+  IDeleteLinkAdminResponse,
+  IGetByOriginLinkAdminQuery,
+  IGetByOriginLinkAdminResponse,
+  IGetCampaignStatsLinkAdminParams,
+  IGetCampaignStatsLinkAdminQuery,
+  IGetCampaignStatsLinkAdminResponse,
+  IGetLinkAdminParams,
+  IGetLinkAdminResponse,
+  IGetLinkStatsQuery,
+  IGetStatsByOriginLinkAdminResponse,
+  IGetVisitsLinkAdminParams,
+  IGetVisitsLinkAdminQuery,
+  IGetVisitsLinkAdminResponse,
+  IListCampaignTokensLinkAdminQuery,
+  IListCampaignTokensLinkAdminResponse,
+  ILinkOrigin,
+  IPaginateLinkAdminQuery,
+  IPaginateLinkAdminResponse,
+  IRecordCampaignViewLinkAdminBody,
+  IRecordCampaignViewLinkAdminResponse,
+  ISetProtectionLinkAdminBody,
+  ISetProtectionLinkAdminParams,
+  ISetProtectionLinkAdminResponse,
+  IUpdateLinkAdminBody,
+  IUpdateLinkAdminParams,
+  IUpdateLinkAdminResponse,
+} from '..';
+
+export const paginateLinkAdmin = async (
+  query: IPaginateLinkAdminQuery,
+): Promise<IPaginateLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IPaginateLinkAdminResponse>(`admin/link/paginate`, {
+      params: query,
+    })
+  ).data;
+};
+
+export const getLinkAdmin = async (params: IGetLinkAdminParams): Promise<IGetLinkAdminResponse> => {
+  return (await AbyssLinkCore.axios.get<IGetLinkAdminResponse>(`admin/link/${params.linkId}`)).data;
+};
+
+export const getVisitsLinkAdmin = async (
+  params: IGetVisitsLinkAdminParams,
+  query: IGetVisitsLinkAdminQuery = {},
+): Promise<IGetVisitsLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetVisitsLinkAdminResponse>(
+      `admin/link/${params.linkId}/visits`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const getCampaignStatsLinkAdmin = async (
+  params: IGetCampaignStatsLinkAdminParams,
+  query: IGetCampaignStatsLinkAdminQuery,
+): Promise<IGetCampaignStatsLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetCampaignStatsLinkAdminResponse>(
+      `admin/link/${params.linkId}/campaign-stats`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const setProtectionLinkAdmin = async (
+  params: ISetProtectionLinkAdminParams,
+  body: ISetProtectionLinkAdminBody,
+): Promise<ISetProtectionLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.put<ISetProtectionLinkAdminResponse>(
+      `admin/link/${params.linkId}/protection`,
+      body,
+    )
+  ).data;
+};
+
+export const updateLinkAdmin = async (
+  params: IUpdateLinkAdminParams,
+  body: IUpdateLinkAdminBody,
+): Promise<IUpdateLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.put<IUpdateLinkAdminResponse>(`admin/link/${params.linkId}`, body)
+  ).data;
+};
+
+export const deleteLinkAdmin = async (
+  params: IDeleteLinkAdminParams,
+): Promise<IDeleteLinkAdminResponse> => {
+  return (await AbyssLinkCore.axios.delete<IDeleteLinkAdminResponse>(`admin/link/${params.linkId}`))
+    .data;
+};
+
+/**
+ * A RESOURCE address or a campaign token for a product resource, free on Link's lines. A RESOURCE
+ * is one per origin: a second call returns the same link.
+ */
+export const createLinkAdmin = async (
+  body: ICreateLinkAdminBody,
+): Promise<ICreateLinkAdminResponse> => {
+  return (await AbyssLinkCore.axios.post<ICreateLinkAdminResponse>(`admin/link`, body)).data;
+};
+
+/** The RESOURCE address of a product resource; 404 when the product minted none. */
+export const getByOriginLinkAdmin = async (
+  origin: IGetByOriginLinkAdminQuery,
+): Promise<IGetByOriginLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetByOriginLinkAdminResponse>(`admin/link/origin`, {
+      params: origin,
+    })
+  ).data;
+};
+
+/** The statistics of a product resource's RESOURCE address over `range` (30 days by default). */
+export const getStatsByOriginLinkAdmin = async (
+  origin: ILinkOrigin,
+  range: IGetLinkStatsQuery = {},
+): Promise<IGetStatsByOriginLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetStatsByOriginLinkAdminResponse>(`admin/link/origin/stats`, {
+      params: { ...origin, ...range },
+    })
+  ).data;
+};
+
+/** Records a page view attributed to a campaign token; 404 for an unknown token. */
+export const recordCampaignViewLinkAdmin = async (
+  body: IRecordCampaignViewLinkAdminBody,
+): Promise<IRecordCampaignViewLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<IRecordCampaignViewLinkAdminResponse>(
+      `admin/link/campaign-view`,
+      body,
+    )
+  ).data;
+};
+
+/** The campaign tokens of a product resource, oldest first. */
+export const listCampaignTokensLinkAdmin = async (
+  origin: IListCampaignTokensLinkAdminQuery,
+): Promise<IListCampaignTokensLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IListCampaignTokensLinkAdminResponse>(
+      `admin/link/campaign-token`,
+      { params: origin },
+    )
+  ).data;
+};
+
+/** Deletes a campaign token; 404 for any other link. */
+export const deleteCampaignTokenLinkAdmin = async (
+  params: IDeleteCampaignTokenLinkAdminParams,
+): Promise<IDeleteCampaignTokenLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.delete<IDeleteCampaignTokenLinkAdminResponse>(
+      `admin/link/campaign-token/${params.linkId}`,
+    )
+  ).data;
+};

package/src/api/link.api.ts

@@ -0,0 +1,158 @@
+import {
+  AbyssLinkCore,
+  ICountOrganizationLinkParams,
+  ICountOrganizationLinkQuery,
+  ICountOrganizationLinkResponse,
+  ICreateForOrganizationLinkBody,
+  ICreateForOrganizationLinkParams,
+  ICreateLinkBody,
+  ICreateLinkResponse,
+  IDeleteLinkParams,
+  IDeleteLinkResponse,
+  IGetByOriginLinkQuery,
+  IGetByOriginLinkResponse,
+  IGetLinkParams,
+  IGetLinkResponse,
+  IGetLinkStatsParams,
+  IGetLinkStatsQuery,
+  IGetLinkStatsResponse,
+  IGetLinkVisitsParams,
+  IGetLinkVisitsQuery,
+  IGetLinkVisitsResponse,
+  IGetStatsByOriginLinkQuery,
+  IGetStatsByOriginLinkResponse,
+  IPaginateLinkQuery,
+  IPaginateLinkResponse,
+  IPaginateOrganizationLinkParams,
+  IPaginateOrganizationLinkQuery,
+  IPaginateProjectLinkParams,
+  ITransferLinkBody,
+  ITransferLinkParams,
+  ITransferLinkResponse,
+  IUpdateLinkBody,
+  IUpdateLinkParams,
+  IUpdateLinkResponse,
+} from '..';
+
+/** The caller's own SHORTENED links. */
+export const paginateLink = async (query: IPaginateLinkQuery): Promise<IPaginateLinkResponse> => {
+  return (await AbyssLinkCore.axios.get<IPaginateLinkResponse>(`link/paginate`, { params: query }))
+    .data;
+};
+
+export const paginateProjectLink = async (
+  params: IPaginateProjectLinkParams,
+  query: IPaginateLinkQuery,
+): Promise<IPaginateLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IPaginateLinkResponse>(
+      `link/project/${params.projectId}/paginate`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const paginateOrganizationLink = async (
+  params: IPaginateOrganizationLinkParams,
+  query: IPaginateOrganizationLinkQuery,
+): Promise<IPaginateLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IPaginateLinkResponse>(
+      `link/organization/${params.organizationId}/paginate`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const countOrganizationLink = async (
+  params: ICountOrganizationLinkParams,
+  query: ICountOrganizationLinkQuery = {},
+): Promise<ICountOrganizationLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<ICountOrganizationLinkResponse>(
+      `link/organization/${params.organizationId}/count`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const getLink = async (params: IGetLinkParams): Promise<IGetLinkResponse> => {
+  return (await AbyssLinkCore.axios.get<IGetLinkResponse>(`link/${params.linkId}`)).data;
+};
+
+export const createLink = async (body: ICreateLinkBody): Promise<ICreateLinkResponse> => {
+  return (await AbyssLinkCore.axios.post<ICreateLinkResponse>(`link`, body)).data;
+};
+
+export const createForOrganizationLink = async (
+  params: ICreateForOrganizationLinkParams,
+  body: ICreateForOrganizationLinkBody,
+): Promise<ICreateLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<ICreateLinkResponse>(
+      `link/organization/${params.organizationId}`,
+      body,
+    )
+  ).data;
+};
+
+export const updateLink = async (
+  params: IUpdateLinkParams,
+  body: IUpdateLinkBody,
+): Promise<IUpdateLinkResponse> => {
+  return (await AbyssLinkCore.axios.put<IUpdateLinkResponse>(`link/${params.linkId}`, body)).data;
+};
+
+export const deleteLink = async (params: IDeleteLinkParams): Promise<IDeleteLinkResponse> => {
+  return (await AbyssLinkCore.axios.delete<IDeleteLinkResponse>(`link/${params.linkId}`)).data;
+};
+
+export const transferLink = async (
+  params: ITransferLinkParams,
+  body: ITransferLinkBody,
+): Promise<ITransferLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<ITransferLinkResponse>(`link/${params.linkId}/transfer`, body)
+  ).data;
+};
+
+export const getStatsLink = async (
+  params: IGetLinkStatsParams,
+  query: IGetLinkStatsQuery = {},
+): Promise<IGetLinkStatsResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetLinkStatsResponse>(`link/${params.linkId}/stats`, {
+      params: query,
+    })
+  ).data;
+};
+
+export const getVisitsLink = async (
+  params: IGetLinkVisitsParams,
+  query: IGetLinkVisitsQuery = {},
+): Promise<IGetLinkVisitsResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetLinkVisitsResponse>(`link/${params.linkId}/visits`, {
+      params: query,
+    })
+  ).data;
+};
+
+/** The RESOURCE address of a product resource, from EDIT on the resource. */
+export const getByOriginLink = async (
+  query: IGetByOriginLinkQuery,
+): Promise<IGetByOriginLinkResponse> => {
+  return (await AbyssLinkCore.axios.get<IGetByOriginLinkResponse>(`link/origin`, { params: query }))
+    .data;
+};
+
+/** The statistics of a product resource's RESOURCE address, from EDIT on the resource. */
+export const getStatsByOriginLink = async (
+  query: IGetStatsByOriginLinkQuery,
+): Promise<IGetStatsByOriginLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetStatsByOriginLinkResponse>(`link/origin/stats`, {
+      params: query,
+    })
+  ).data;
+};

package/src/api/link.public.api.ts

@@ -0,0 +1,19 @@
+import {
+  AbyssLinkCore,
+  IUnlockLinkPublicBody,
+  IUnlockLinkPublicParams,
+  IUnlockLinkPublicResponse,
+} from '..';
+
+/** Unlocks a shortened link protected by a password: the right password answers its destination. */
+export const unlockLinkPublic = async ({
+  slug,
+  ...body
+}: IUnlockLinkPublicParams & IUnlockLinkPublicBody): Promise<IUnlockLinkPublicResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<IUnlockLinkPublicResponse>(
+      `link/public/${encodeURIComponent(slug)}/unlock`,
+      body,
+    )
+  ).data;
+};