@short.io/client-node 1.1.0 → 2.0.1

package/src/types/common.ts

@@ -1,11 +0,0 @@
-export interface SuccessResBody {
-    success: boolean;
-}
-
-export interface ErrorResBody {
-    error: string;
-}
-
-export interface StatusResBody {
-    status: string;
-}

package/src/types/domain.ts

@@ -1,44 +0,0 @@
-type LinkType = "increment" | "random" | "secure" | "four-char" | "eight-char" | "ten-char";
-type DomainState = "extra_records" | "not_registered" | "configured" | "not_configured" | "registration_pending";
-type SetupType = "dns" | "js";
-type HttpLevel = "none" | "redirect" | "hsts";
-type RobotPermission = "allow" | "disallow" | "noindex";
-
-export interface Domain {
-    id: number;
-    hostname: string;
-    title: string | null;
-    unicodeHostname: string;
-    isFavorite: boolean;
-    faviconURL: string | null;
-    segmentKey: string | null;
-    hasFavicon: boolean;
-    linkType: LinkType;
-    state: DomainState;
-    redirect404: string;
-    hideReferer: boolean;
-    hideVisitorIp: boolean;
-    caseSensitive: boolean;
-    exportEnabled: boolean;
-    cloaking: boolean;
-    incrementCounter: string;
-    setupType: SetupType;
-    httpsLinks: boolean;
-    integrationGA: string | null;
-    integrationFB: string | null;
-    integrationAdroll: string | null;
-    integrationGTM: string | null;
-    webhookURL: string | null;
-    httpsLevel: HttpLevel;
-    robots: RobotPermission;
-    provider: string | null;
-    purgeExpiredLinks: boolean;
-    lastPurgeDate: string | null;
-    createdAt: string;
-    updatedAt: string;
-    clientStorage?: string;
-    TeamId?: number;
-}
-
-export interface DomainCreateOptions
-    extends Partial<Pick<Domain, "caseSensitive" | "hideReferer" | "httpsLinks" | "linkType" | "redirect404">> {}

package/src/types/index.ts

@@ -1,4 +0,0 @@
-export * from "./common";
-export * from "./domain";
-export * from "./link";
-export * from "./statistics";

package/src/types/link.ts

@@ -1,159 +0,0 @@
-import { ErrorResBody, SuccessResBody } from "./common.js";
-import { Domain } from "./domain.js";
-
-export interface Link {
-    idString: string;
-    path: string;
-    DomainId: number;
-    createdAt: string;
-    updatedAt: string | null;
-    expiresAt: string | null;
-    shortURL: string;
-    cloaking: boolean;
-    OwnerId: number;
-    originalURL: string;
-    secureShortURL: string;
-    title?: string;
-    expiredURL?: string;
-    ttl?: string;
-    source?: string;
-    duplicate?: boolean;
-    archived?: boolean;
-    redirectType?: string;
-    clicksLimit?: number;
-    passwordContact?: boolean;
-    hasPassword?: true;
-    password?: string;
-    tags?: string[];
-    androidURL?: string;
-    iphoneURL?: string;
-    utmSource?: string | null;
-    utmMedium?: string | null;
-    utmCampaign?: string | null;
-    utmTerm?: string | null;
-    utmContent?: string | null;
-}
-
-export interface LinkCountry {
-    id: string;
-    LinkIdString: Link["idString"];
-    country: string;
-    originalURL: string;
-    createdAt: Date;
-}
-
-export interface LinkRegion {
-    id: string;
-    LinkIdString: Link["idString"];
-    country: string;
-    region: string;
-    originalURL: string;
-    name: string;
-    createdAt: Date;
-}
-
-export interface LinkCreateOptions
-    extends Pick<
-        Partial<Link>,
-        | "source"
-        | "cloaking"
-        | "password"
-        | "redirectType"
-        | "expiredURL"
-        | "title"
-        | "path"
-        | "androidURL"
-        | "iphoneURL"
-        | "clicksLimit"
-    > {
-    tags?: string[];
-    allowDuplicates?: boolean;
-    folderId?: LinkFolder["id"];
-    expiresAt?: number;
-    ttl?: string;
-    createdAt?: number;
-}
-
-export interface LinkUpdateOptions extends LinkCreateOptions {
-    originalURL?: Link["originalURL"];
-    archived?: Link["archived"];
-    icon?: string;
-    splitURL?: string;
-    splitPercent?: number;
-    passwordContact?: boolean;
-    utmSource?: string | null;
-    utmMedium?: string | null;
-    utmCampaign?: string | null;
-    utmTerm?: string | null;
-    utmContent?: string | null;
-}
-
-export interface LinkBulkCreateOptions extends LinkCreateOptions, Pick<Link, "originalURL"> {}
-
-export interface LinkWithUser extends Link, User {}
-
-export interface LinksAndCount {
-    links: LinkWithUser[];
-    count: number;
-    nextPageToken: string | null;
-    hasMore?: boolean;
-}
-
-export interface LinkListOptions {
-    domain_id: string;
-    beforeDate?: string;
-    afterDate?: string;
-    dateSortOrder?: SortingOrder;
-    createdAt?: string;
-    idString?: string;
-    pageToken?: string;
-    folderId?: LinkFolder["id"];
-    limit?: number;
-    offset?: number;
-}
-
-export interface UpdateLinkErrorRes extends ErrorResBody {
-    field: string;
-}
-
-export interface DeleteLinkRes extends SuccessResBody, Pick<Link, "idString"> {}
-
-export interface GetLinkQRCodeOptions {
-    type?: string;
-    size?: number;
-    color?: string;
-    backgroundColor?: string;
-}
-
-export type LinkOpenGraphData = [string, string][];
-
-export interface LinkCountryCreateOptions {
-    country: string;
-    originalURL: string;
-}
-
-export interface LinkRegionCreateOptions {
-    country: string;
-    region: string;
-    originalURL: string;
-}
-
-export interface LinkRegionDeleteOptions {
-    country: string;
-    region: string;
-}
-
-type SortingOrder = "asc" | "desc";
-
-interface User {
-    email: string;
-    id: number;
-    name: string;
-    photoURL: string;
-}
-
-interface LinkFolder {
-    id: string;
-    name: string;
-    DomainId: Domain["id"];
-}

package/src/types/statistics.ts

@@ -1,242 +0,0 @@
-import { Link } from "./link";
-
-export interface GetStatisticsOptions extends StartEndDate {
-    period?: Period;
-    tzOffset?: number;
-    clicksChartInterval?: Interval;
-}
-
-export interface TopByColumnOptions extends StartEndDate, Pick<LimitOffset, "limit">, IncludeExcludeOptions {
-    period?: Period;
-    tzOffset?: number;
-    prefix?: string;
-}
-
-export interface TopByIntervalOptions extends StartEndDate, Pick<LimitOffset, "limit">, IncludeExcludeOptions {
-    interval?: Interval;
-    period?: Period;
-    tzOffset?: number;
-}
-
-export interface TopByIntervalRes {
-    date: string;
-    statistics: {
-        column: string;
-        score: string;
-    }[];
-}
-
-export interface TopByColumnRes {
-    name: string;
-}
-
-export interface GetLastClicksOptions
-    extends StartEndDate,
-        Pick<LimitOffset, "limit">,
-        IncludeExcludeOptions,
-        BeforeAfterDate {
-    tzOffset?: number;
-    period?: Period;
-}
-
-export interface LastClicksRes {
-    host: string;
-    path: string;
-    lcpath: string;
-    dt: string;
-    method: string;
-    url: string;
-    st: number;
-    ip: string;
-    proto: string;
-    ref: string;
-    ua: string;
-    human: boolean;
-    browser: string;
-    browser_version: string;
-    country: string;
-    city: string;
-    social: string;
-    refhost: string;
-    os: string;
-    utm_source: string;
-    utm_medium: string;
-    utm_campaign: string;
-    goal_completed: boolean | null;
-    ab_path: string | null;
-}
-
-export interface FilterOptions {
-    paths?: Set<string>;
-    countries?: Set<string>;
-    dt?: [Date, Date];
-    browsers?: string[];
-    human?: boolean;
-    socials?: string[];
-    browserVersions?: string[];
-    statuses?: number[];
-    methods?: string[];
-    protos?: ("http" | "https")[];
-    refhosts?: string[];
-    utmSources?: string[];
-    utmMediums?: string[];
-    utmCampaigns?: string[];
-}
-
-export interface IncludeExcludeOptions {
-    include?: FilterOptions;
-    exclude?: FilterOptions;
-}
-
-export interface LinkIds {
-    ids: string;
-}
-
-export interface PathDate extends Pick<Link, "path" | "createdAt"> {}
-
-export interface PathClicks {
-    [path: Link["path"]]: number;
-}
-
-export interface LinkStatistics {
-    totalClicks: number;
-    humanClicks: number;
-    humanClicksChange: string;
-    totalClicksChange: string;
-    clickStatistics: {
-        datasets: [
-            {
-                data: DatePoint[];
-            },
-        ];
-    };
-    interval: IntervalResponse;
-    referer: Referer[];
-    social: Social[];
-    browser: Browser[];
-    os: OS[];
-    city: City[];
-    country: Country[];
-}
-
-export interface DomainStatistics {
-    country: Country[];
-    city: City[];
-    clicks: number;
-    humanClicks: number;
-    links: number;
-    linksChange: string;
-    linksChangePositive: boolean;
-    clicksPerLink: string;
-    clicksPerLinkChange: string;
-    humanClicksPerLink: string;
-    prevClicksChange: string;
-    humanClicksChange: string;
-    humanClicksChangePositive: boolean;
-    interval: IntervalResponse;
-    clickStatistics: {
-        datasets: [
-            {
-                data: DatePoint[];
-            },
-        ];
-    };
-    referer: Referer[];
-    social: Social[];
-    browser: Browser[];
-    os: OS[];
-    utm_medium: ({ utm_medium: string } & ClicksScore)[];
-    utm_source: ({ utm_source: string } & ClicksScore)[];
-    utm_campaign: ({ utm_campaign: string } & ClicksScore)[];
-}
-
-interface IntervalResponse {
-    startDate: Date | null;
-    endDate: Date | null;
-    prevStartDate: Date | null;
-    prevEndDate: Date | null;
-}
-
-interface DatePoint {
-    x: Date;
-    y: number;
-}
-
-interface City extends ClicksScore {
-    city: number;
-    name: string;
-}
-
-interface OS extends ClicksScore {
-    os: string;
-}
-
-interface Social extends ClicksScore {
-    social: string;
-    socialName?: string;
-}
-
-interface Browser extends ClicksScore {
-    browser: string;
-    browserName?: string;
-}
-
-interface Referer extends ClicksScore {
-    referer: string;
-}
-
-interface Country extends ClicksScore {
-    country: string;
-    countryName: string;
-}
-
-interface ClicksScore {
-    score: number;
-}
-
-type Period = "custom" | "today" | "yesterday" | "total" | "week" | "month" | "lastmonth" | "last7" | "last30";
-type Interval = "hour" | "day" | "week" | "month";
-
-export interface StartEndDate {
-    startDate?: string;
-    endDate?: string;
-}
-
-export interface BeforeAfterDate {
-    afterDate?: string;
-    beforeDate?: string;
-}
-
-export interface LinkClicks {
-    [key: Link["idString"]]: number;
-}
-
-export interface LimitOffset {
-    limit?: number;
-    offset?: number;
-}
-
-export type Column =
-    | "path"
-    | "method"
-    | "st"
-    | "proto"
-    | "human"
-    | "browser"
-    | "browser_version"
-    | "country"
-    | "city"
-    | "social"
-    | "refhost"
-    | "os"
-    | "utm_source"
-    | "utm_medium"
-    | "utm_campaign"
-    | "goal_completed"
-    | "ab_path";
-
-export interface TopColumnRes {
-    score: number;
-    column: string;
-    displayName: string;
-}

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-    "compilerOptions": {
-        "rootDir": "./src",
-        "outDir": "./dist",
-        "module": "ESNext",
-        "target": "ESNext",
-        "moduleResolution": "node",
-        "experimentalDecorators": true,
-        "allowSyntheticDefaultImports": true,
-        "incremental": true,
-        "noImplicitAny": true,
-        "removeComments": true,
-        "preserveConstEnums": true,
-        "noUnusedLocals": true,
-        "sourceMap": true,
-        "inlineSources": true,
-        "strictNullChecks": true,
-        "declaration": true
-    }
-}