@short.io/client-node 1.1.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,199 +0,0 @@
1
- import { Link } from "./link";
2
- export interface GetStatisticsOptions extends StartEndDate {
3
- period?: Period;
4
- tzOffset?: number;
5
- clicksChartInterval?: Interval;
6
- }
7
- export interface TopByColumnOptions extends StartEndDate, Pick<LimitOffset, "limit">, IncludeExcludeOptions {
8
- period?: Period;
9
- tzOffset?: number;
10
- prefix?: string;
11
- }
12
- export interface TopByIntervalOptions extends StartEndDate, Pick<LimitOffset, "limit">, IncludeExcludeOptions {
13
- interval?: Interval;
14
- period?: Period;
15
- tzOffset?: number;
16
- }
17
- export interface TopByIntervalRes {
18
- date: string;
19
- statistics: {
20
- column: string;
21
- score: string;
22
- }[];
23
- }
24
- export interface TopByColumnRes {
25
- name: string;
26
- }
27
- export interface GetLastClicksOptions extends StartEndDate, Pick<LimitOffset, "limit">, IncludeExcludeOptions, BeforeAfterDate {
28
- tzOffset?: number;
29
- period?: Period;
30
- }
31
- export interface LastClicksRes {
32
- host: string;
33
- path: string;
34
- lcpath: string;
35
- dt: string;
36
- method: string;
37
- url: string;
38
- st: number;
39
- ip: string;
40
- proto: string;
41
- ref: string;
42
- ua: string;
43
- human: boolean;
44
- browser: string;
45
- browser_version: string;
46
- country: string;
47
- city: string;
48
- social: string;
49
- refhost: string;
50
- os: string;
51
- utm_source: string;
52
- utm_medium: string;
53
- utm_campaign: string;
54
- goal_completed: boolean | null;
55
- ab_path: string | null;
56
- }
57
- export interface FilterOptions {
58
- paths?: Set<string>;
59
- countries?: Set<string>;
60
- dt?: [Date, Date];
61
- browsers?: string[];
62
- human?: boolean;
63
- socials?: string[];
64
- browserVersions?: string[];
65
- statuses?: number[];
66
- methods?: string[];
67
- protos?: ("http" | "https")[];
68
- refhosts?: string[];
69
- utmSources?: string[];
70
- utmMediums?: string[];
71
- utmCampaigns?: string[];
72
- }
73
- export interface IncludeExcludeOptions {
74
- include?: FilterOptions;
75
- exclude?: FilterOptions;
76
- }
77
- export interface LinkIds {
78
- ids: string;
79
- }
80
- export interface PathDate extends Pick<Link, "path" | "createdAt"> {
81
- }
82
- export interface PathClicks {
83
- [path: Link["path"]]: number;
84
- }
85
- export interface LinkStatistics {
86
- totalClicks: number;
87
- humanClicks: number;
88
- humanClicksChange: string;
89
- totalClicksChange: string;
90
- clickStatistics: {
91
- datasets: [
92
- {
93
- data: DatePoint[];
94
- }
95
- ];
96
- };
97
- interval: IntervalResponse;
98
- referer: Referer[];
99
- social: Social[];
100
- browser: Browser[];
101
- os: OS[];
102
- city: City[];
103
- country: Country[];
104
- }
105
- export interface DomainStatistics {
106
- country: Country[];
107
- city: City[];
108
- clicks: number;
109
- humanClicks: number;
110
- links: number;
111
- linksChange: string;
112
- linksChangePositive: boolean;
113
- clicksPerLink: string;
114
- clicksPerLinkChange: string;
115
- humanClicksPerLink: string;
116
- prevClicksChange: string;
117
- humanClicksChange: string;
118
- humanClicksChangePositive: boolean;
119
- interval: IntervalResponse;
120
- clickStatistics: {
121
- datasets: [
122
- {
123
- data: DatePoint[];
124
- }
125
- ];
126
- };
127
- referer: Referer[];
128
- social: Social[];
129
- browser: Browser[];
130
- os: OS[];
131
- utm_medium: ({
132
- utm_medium: string;
133
- } & ClicksScore)[];
134
- utm_source: ({
135
- utm_source: string;
136
- } & ClicksScore)[];
137
- utm_campaign: ({
138
- utm_campaign: string;
139
- } & ClicksScore)[];
140
- }
141
- interface IntervalResponse {
142
- startDate: Date | null;
143
- endDate: Date | null;
144
- prevStartDate: Date | null;
145
- prevEndDate: Date | null;
146
- }
147
- interface DatePoint {
148
- x: Date;
149
- y: number;
150
- }
151
- interface City extends ClicksScore {
152
- city: number;
153
- name: string;
154
- }
155
- interface OS extends ClicksScore {
156
- os: string;
157
- }
158
- interface Social extends ClicksScore {
159
- social: string;
160
- socialName?: string;
161
- }
162
- interface Browser extends ClicksScore {
163
- browser: string;
164
- browserName?: string;
165
- }
166
- interface Referer extends ClicksScore {
167
- referer: string;
168
- }
169
- interface Country extends ClicksScore {
170
- country: string;
171
- countryName: string;
172
- }
173
- interface ClicksScore {
174
- score: number;
175
- }
176
- type Period = "custom" | "today" | "yesterday" | "total" | "week" | "month" | "lastmonth" | "last7" | "last30";
177
- type Interval = "hour" | "day" | "week" | "month";
178
- export interface StartEndDate {
179
- startDate?: string;
180
- endDate?: string;
181
- }
182
- export interface BeforeAfterDate {
183
- afterDate?: string;
184
- beforeDate?: string;
185
- }
186
- export interface LinkClicks {
187
- [key: Link["idString"]]: number;
188
- }
189
- export interface LimitOffset {
190
- limit?: number;
191
- offset?: number;
192
- }
193
- 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";
194
- export interface TopColumnRes {
195
- score: number;
196
- column: string;
197
- displayName: string;
198
- }
199
- export {};
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=statistics.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"statistics.js","sourceRoot":"","sources":["../../src/types/statistics.ts"],"names":[],"mappings":"","sourcesContent":["import { Link } from \"./link\";\n\nexport interface GetStatisticsOptions extends StartEndDate {\n period?: Period;\n tzOffset?: number;\n clicksChartInterval?: Interval;\n}\n\nexport interface TopByColumnOptions extends StartEndDate, Pick<LimitOffset, \"limit\">, IncludeExcludeOptions {\n period?: Period;\n tzOffset?: number;\n prefix?: string;\n}\n\nexport interface TopByIntervalOptions extends StartEndDate, Pick<LimitOffset, \"limit\">, IncludeExcludeOptions {\n interval?: Interval;\n period?: Period;\n tzOffset?: number;\n}\n\nexport interface TopByIntervalRes {\n date: string;\n statistics: {\n column: string;\n score: string;\n }[];\n}\n\nexport interface TopByColumnRes {\n name: string;\n}\n\nexport interface GetLastClicksOptions\n extends StartEndDate,\n Pick<LimitOffset, \"limit\">,\n IncludeExcludeOptions,\n BeforeAfterDate {\n tzOffset?: number;\n period?: Period;\n}\n\nexport interface LastClicksRes {\n host: string;\n path: string;\n lcpath: string;\n dt: string;\n method: string;\n url: string;\n st: number;\n ip: string;\n proto: string;\n ref: string;\n ua: string;\n human: boolean;\n browser: string;\n browser_version: string;\n country: string;\n city: string;\n social: string;\n refhost: string;\n os: string;\n utm_source: string;\n utm_medium: string;\n utm_campaign: string;\n goal_completed: boolean | null;\n ab_path: string | null;\n}\n\nexport interface FilterOptions {\n paths?: Set<string>;\n countries?: Set<string>;\n dt?: [Date, Date];\n browsers?: string[];\n human?: boolean;\n socials?: string[];\n browserVersions?: string[];\n statuses?: number[];\n methods?: string[];\n protos?: (\"http\" | \"https\")[];\n refhosts?: string[];\n utmSources?: string[];\n utmMediums?: string[];\n utmCampaigns?: string[];\n}\n\nexport interface IncludeExcludeOptions {\n include?: FilterOptions;\n exclude?: FilterOptions;\n}\n\nexport interface LinkIds {\n ids: string;\n}\n\nexport interface PathDate extends Pick<Link, \"path\" | \"createdAt\"> {}\n\nexport interface PathClicks {\n [path: Link[\"path\"]]: number;\n}\n\nexport interface LinkStatistics {\n totalClicks: number;\n humanClicks: number;\n humanClicksChange: string;\n totalClicksChange: string;\n clickStatistics: {\n datasets: [\n {\n data: DatePoint[];\n },\n ];\n };\n interval: IntervalResponse;\n referer: Referer[];\n social: Social[];\n browser: Browser[];\n os: OS[];\n city: City[];\n country: Country[];\n}\n\nexport interface DomainStatistics {\n country: Country[];\n city: City[];\n clicks: number;\n humanClicks: number;\n links: number;\n linksChange: string;\n linksChangePositive: boolean;\n clicksPerLink: string;\n clicksPerLinkChange: string;\n humanClicksPerLink: string;\n prevClicksChange: string;\n humanClicksChange: string;\n humanClicksChangePositive: boolean;\n interval: IntervalResponse;\n clickStatistics: {\n datasets: [\n {\n data: DatePoint[];\n },\n ];\n };\n referer: Referer[];\n social: Social[];\n browser: Browser[];\n os: OS[];\n utm_medium: ({ utm_medium: string } & ClicksScore)[];\n utm_source: ({ utm_source: string } & ClicksScore)[];\n utm_campaign: ({ utm_campaign: string } & ClicksScore)[];\n}\n\ninterface IntervalResponse {\n startDate: Date | null;\n endDate: Date | null;\n prevStartDate: Date | null;\n prevEndDate: Date | null;\n}\n\ninterface DatePoint {\n x: Date;\n y: number;\n}\n\ninterface City extends ClicksScore {\n city: number;\n name: string;\n}\n\ninterface OS extends ClicksScore {\n os: string;\n}\n\ninterface Social extends ClicksScore {\n social: string;\n socialName?: string;\n}\n\ninterface Browser extends ClicksScore {\n browser: string;\n browserName?: string;\n}\n\ninterface Referer extends ClicksScore {\n referer: string;\n}\n\ninterface Country extends ClicksScore {\n country: string;\n countryName: string;\n}\n\ninterface ClicksScore {\n score: number;\n}\n\ntype Period = \"custom\" | \"today\" | \"yesterday\" | \"total\" | \"week\" | \"month\" | \"lastmonth\" | \"last7\" | \"last30\";\ntype Interval = \"hour\" | \"day\" | \"week\" | \"month\";\n\nexport interface StartEndDate {\n startDate?: string;\n endDate?: string;\n}\n\nexport interface BeforeAfterDate {\n afterDate?: string;\n beforeDate?: string;\n}\n\nexport interface LinkClicks {\n [key: Link[\"idString\"]]: number;\n}\n\nexport interface LimitOffset {\n limit?: number;\n offset?: number;\n}\n\nexport type Column =\n | \"path\"\n | \"method\"\n | \"st\"\n | \"proto\"\n | \"human\"\n | \"browser\"\n | \"browser_version\"\n | \"country\"\n | \"city\"\n | \"social\"\n | \"refhost\"\n | \"os\"\n | \"utm_source\"\n | \"utm_medium\"\n | \"utm_campaign\"\n | \"goal_completed\"\n | \"ab_path\";\n\nexport interface TopColumnRes {\n score: number;\n column: string;\n displayName: string;\n}\n"]}
package/dist/types.d.ts DELETED
@@ -1 +0,0 @@
1
- export * from "./types/index";
package/dist/types.js DELETED
@@ -1,2 +0,0 @@
1
- export * from "./types/index";
2
- //# sourceMappingURL=types.js.map
package/dist/types.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC","sourcesContent":["export * from \"./types/index\";\n"]}
package/renovate.json DELETED
@@ -1,6 +0,0 @@
1
- {
2
- "$schema": "https://docs.renovatebot.com/renovate-schema.json",
3
- "extends": [
4
- "config:base"
5
- ]
6
- }