@uniformdev/redirect 20.75.1-alpha.15.sha-b6ff05804e → 20.75.1-alpha.3
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.
- package/dist/index.d.mts +60 -61
- package/dist/index.d.ts +60 -61
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -45,33 +45,33 @@ interface paths {
|
|
|
45
45
|
path?: never;
|
|
46
46
|
cookie?: never;
|
|
47
47
|
};
|
|
48
|
-
/** Called to retrieve a list of redirects related to a project */
|
|
48
|
+
/** @description Called to retrieve a list of redirects related to a project */
|
|
49
49
|
get: {
|
|
50
50
|
parameters: {
|
|
51
51
|
query: {
|
|
52
|
-
/** The project to fetch redirects for */
|
|
52
|
+
/** @description The project to fetch redirects for */
|
|
53
53
|
projectId: string;
|
|
54
|
-
/** Id of the redirect to retrieve */
|
|
54
|
+
/** @description Id of the redirect to retrieve */
|
|
55
55
|
id?: string;
|
|
56
|
-
/** Ids of the redirects to retrieve */
|
|
56
|
+
/** @description Ids of the redirects to retrieve */
|
|
57
57
|
ids?: string[];
|
|
58
|
-
/** Source url to attempt to find redirects for */
|
|
58
|
+
/** @description Source url to attempt to find redirects for */
|
|
59
59
|
sourceUrl?: string;
|
|
60
|
-
/** Find redirects that could redirect to this url */
|
|
60
|
+
/** @description Find redirects that could redirect to this url */
|
|
61
61
|
targetUrl?: string;
|
|
62
|
-
/** Id of the project map the source or target belongs to */
|
|
62
|
+
/** @description Id of the project map the source or target belongs to */
|
|
63
63
|
projectMapId?: string;
|
|
64
|
-
/** Id of the project map node to find redirects for */
|
|
64
|
+
/** @description Id of the project map node to find redirects for */
|
|
65
65
|
sourceProjectMapNodeId?: string;
|
|
66
|
-
/** Id of the project map node to find redirects for */
|
|
66
|
+
/** @description Id of the project map node to find redirects for */
|
|
67
67
|
targetProjectMapNodeId?: string;
|
|
68
|
-
/** Column to order results by, only applicable if trie is not active */
|
|
68
|
+
/** @description Column to order results by, only applicable if trie is not active */
|
|
69
69
|
orderBy?: "updated_at asc" | "updated_at desc" | "source_url asc" | "source_url desc" | "target_url asc" | "target_url desc" | "created_by asc" | "created_by desc";
|
|
70
|
-
/** Limit the results to this number of results, ignored if using trie parameter */
|
|
70
|
+
/** @description Limit the results to this number of results, ignored if using trie parameter */
|
|
71
71
|
limit?: number;
|
|
72
|
-
/** Offset the results a certain amount, useful for pagination */
|
|
72
|
+
/** @description Offset the results a certain amount, useful for pagination */
|
|
73
73
|
offset?: number;
|
|
74
|
-
/** Search text to filter redirects by, filtering on the source and target urls */
|
|
74
|
+
/** @description Search text to filter redirects by, filtering on the source and target urls */
|
|
75
75
|
search?: string;
|
|
76
76
|
};
|
|
77
77
|
header?: never;
|
|
@@ -80,7 +80,7 @@ interface paths {
|
|
|
80
80
|
};
|
|
81
81
|
requestBody?: never;
|
|
82
82
|
responses: {
|
|
83
|
-
/** OK */
|
|
83
|
+
/** @description OK */
|
|
84
84
|
200: {
|
|
85
85
|
headers: {
|
|
86
86
|
[name: string]: unknown;
|
|
@@ -109,18 +109,18 @@ interface paths {
|
|
|
109
109
|
requestBody: {
|
|
110
110
|
content: {
|
|
111
111
|
"application/json": {
|
|
112
|
-
/** Redirect object to insert */
|
|
112
|
+
/** @description Redirect object to insert */
|
|
113
113
|
redirect: components["schemas"]["Redirect"];
|
|
114
114
|
/**
|
|
115
115
|
* Format: uuid
|
|
116
|
-
* Project id to insert the redirect into
|
|
116
|
+
* @description Project id to insert the redirect into
|
|
117
117
|
*/
|
|
118
118
|
projectId: string;
|
|
119
119
|
};
|
|
120
120
|
};
|
|
121
121
|
};
|
|
122
122
|
responses: {
|
|
123
|
-
/** OK */
|
|
123
|
+
/** @description OK */
|
|
124
124
|
200: {
|
|
125
125
|
headers: {
|
|
126
126
|
[name: string]: unknown;
|
|
@@ -129,13 +129,13 @@ interface paths {
|
|
|
129
129
|
"application/json": {
|
|
130
130
|
/**
|
|
131
131
|
* Format: uuid
|
|
132
|
-
* Id of the redirect
|
|
132
|
+
* @description Id of the redirect
|
|
133
133
|
*/
|
|
134
134
|
id: string;
|
|
135
135
|
};
|
|
136
136
|
};
|
|
137
137
|
};
|
|
138
|
-
/** OK */
|
|
138
|
+
/** @description OK */
|
|
139
139
|
204: {
|
|
140
140
|
headers: {
|
|
141
141
|
[name: string]: unknown;
|
|
@@ -150,7 +150,7 @@ interface paths {
|
|
|
150
150
|
};
|
|
151
151
|
};
|
|
152
152
|
post?: never;
|
|
153
|
-
/** Called to delete a redirect */
|
|
153
|
+
/** @description Called to delete a redirect */
|
|
154
154
|
delete: {
|
|
155
155
|
parameters: {
|
|
156
156
|
query?: never;
|
|
@@ -163,19 +163,19 @@ interface paths {
|
|
|
163
163
|
"application/json": {
|
|
164
164
|
/**
|
|
165
165
|
* Format: uuid
|
|
166
|
-
* Redirect id to be deleted
|
|
166
|
+
* @description Redirect id to be deleted
|
|
167
167
|
*/
|
|
168
168
|
id: string;
|
|
169
169
|
/**
|
|
170
170
|
* Format: uuid
|
|
171
|
-
* Project the redirect belongs to
|
|
171
|
+
* @description Project the redirect belongs to
|
|
172
172
|
*/
|
|
173
173
|
projectId: string;
|
|
174
174
|
};
|
|
175
175
|
};
|
|
176
176
|
};
|
|
177
177
|
responses: {
|
|
178
|
-
/** OK */
|
|
178
|
+
/** @description OK */
|
|
179
179
|
200: {
|
|
180
180
|
headers: {
|
|
181
181
|
[name: string]: unknown;
|
|
@@ -184,13 +184,13 @@ interface paths {
|
|
|
184
184
|
"application/json": {
|
|
185
185
|
/**
|
|
186
186
|
* Format: uuid
|
|
187
|
-
* Id of the redirect
|
|
187
|
+
* @description Id of the redirect
|
|
188
188
|
*/
|
|
189
189
|
id: string;
|
|
190
190
|
};
|
|
191
191
|
};
|
|
192
192
|
};
|
|
193
|
-
/** OK */
|
|
193
|
+
/** @description OK */
|
|
194
194
|
204: {
|
|
195
195
|
headers: {
|
|
196
196
|
[name: string]: unknown;
|
|
@@ -204,7 +204,7 @@ interface paths {
|
|
|
204
204
|
500: components["responses"]["InternalServerError"];
|
|
205
205
|
};
|
|
206
206
|
};
|
|
207
|
-
/** Handles preflight requests. This endpoint allows CORS */
|
|
207
|
+
/** @description Handles preflight requests. This endpoint allows CORS */
|
|
208
208
|
options: {
|
|
209
209
|
parameters: {
|
|
210
210
|
query?: never;
|
|
@@ -214,7 +214,7 @@ interface paths {
|
|
|
214
214
|
};
|
|
215
215
|
requestBody?: never;
|
|
216
216
|
responses: {
|
|
217
|
-
/** OK */
|
|
217
|
+
/** @description OK */
|
|
218
218
|
204: {
|
|
219
219
|
headers: {
|
|
220
220
|
[name: string]: unknown;
|
|
@@ -235,64 +235,64 @@ interface components {
|
|
|
235
235
|
metadata: components["schemas"]["RedirectMetadata"];
|
|
236
236
|
}[];
|
|
237
237
|
RedirectMetadata: {
|
|
238
|
-
/** The last time the redirect was modified in UTC */
|
|
238
|
+
/** @description The last time the redirect was modified in UTC */
|
|
239
239
|
updatedAt?: string;
|
|
240
|
-
/** The last user who modified this redirect */
|
|
240
|
+
/** @description The last user who modified this redirect */
|
|
241
241
|
updatedBy?: string;
|
|
242
|
-
/** The time the redirect was created in UTC */
|
|
242
|
+
/** @description The time the redirect was created in UTC */
|
|
243
243
|
createdAt?: string;
|
|
244
|
-
/** The user who created this redirect */
|
|
244
|
+
/** @description The user who created this redirect */
|
|
245
245
|
createdBy?: string;
|
|
246
|
-
/** The user who created this redirect's name */
|
|
246
|
+
/** @description The user who created this redirect's name */
|
|
247
247
|
createdByName?: string;
|
|
248
248
|
};
|
|
249
249
|
Redirect: {
|
|
250
250
|
/**
|
|
251
251
|
* Format: uuid
|
|
252
|
-
* Id of the redirect
|
|
252
|
+
* @description Id of the redirect
|
|
253
253
|
*/
|
|
254
254
|
id?: string;
|
|
255
|
-
/** Source meant to match a url that needs to be redirected */
|
|
255
|
+
/** @description Source meant to match a url that needs to be redirected */
|
|
256
256
|
sourceUrl: string;
|
|
257
|
-
/** Target meant to be redirected to */
|
|
257
|
+
/** @description Target meant to be redirected to */
|
|
258
258
|
targetUrl: string;
|
|
259
|
-
/** Redirect type to occur from this redirect */
|
|
259
|
+
/** @description Redirect type to occur from this redirect */
|
|
260
260
|
targetStatusCode: number;
|
|
261
261
|
/**
|
|
262
262
|
* Format: uuid
|
|
263
|
-
* Project map node related to the source this redirect
|
|
263
|
+
* @description Project map node related to the source this redirect
|
|
264
264
|
*/
|
|
265
265
|
sourceProjectMapNodeId?: string;
|
|
266
266
|
/**
|
|
267
267
|
* Format: uuid
|
|
268
|
-
* Project map node related to the target this redirect
|
|
268
|
+
* @description Project map node related to the target this redirect
|
|
269
269
|
*/
|
|
270
270
|
targetProjectMapNodeId?: string;
|
|
271
271
|
/**
|
|
272
272
|
* Format: uuid
|
|
273
|
-
* Project map related to this redirect
|
|
273
|
+
* @description Project map related to this redirect
|
|
274
274
|
*/
|
|
275
275
|
projectMapId?: string;
|
|
276
|
-
/** Signals the redirect engine to retain query string parameters to the target url */
|
|
276
|
+
/** @description Signals the redirect engine to retain query string parameters to the target url */
|
|
277
277
|
sourceRetainQuerystring?: boolean;
|
|
278
|
-
/** Incoming requests must match the domain that's defined in the redirection source */
|
|
278
|
+
/** @description Incoming requests must match the domain that's defined in the redirection source */
|
|
279
279
|
sourceMustMatchDomain?: boolean;
|
|
280
|
-
/** Rewritten url should match the protocol (http / https) of the incoming request instead of whatever is defined in the redirection target */
|
|
280
|
+
/** @description Rewritten url should match the protocol (http / https) of the incoming request instead of whatever is defined in the redirection target */
|
|
281
281
|
targetPreserveIncomingProtocol?: boolean;
|
|
282
|
-
/** Rewritten url should match the domain of the incoming request regardless of what is defined in the redirection target */
|
|
282
|
+
/** @description Rewritten url should match the domain of the incoming request regardless of what is defined in the redirection target */
|
|
283
283
|
targetPreserveIncomingDomain?: boolean;
|
|
284
|
-
/** Merge incoming querystring with the querystring defined on the redirection target, taking the incoming querystring parameter where a merge is not possible */
|
|
284
|
+
/** @description Merge incoming querystring with the querystring defined on the redirection target, taking the incoming querystring parameter where a merge is not possible */
|
|
285
285
|
targetMergeQuerystring?: boolean;
|
|
286
|
-
/** Label as system generated or user generated */
|
|
286
|
+
/** @description Label as system generated or user generated */
|
|
287
287
|
labelAsSystem?: boolean;
|
|
288
288
|
};
|
|
289
289
|
Error: {
|
|
290
|
-
/** Error message(s) that occurred while processing the request */
|
|
290
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
291
291
|
errorMessage?: string[] | string;
|
|
292
292
|
};
|
|
293
293
|
};
|
|
294
294
|
responses: {
|
|
295
|
-
/** Request input validation failed */
|
|
295
|
+
/** @description Request input validation failed */
|
|
296
296
|
BadRequestError: {
|
|
297
297
|
headers: {
|
|
298
298
|
[name: string]: unknown;
|
|
@@ -301,7 +301,7 @@ interface components {
|
|
|
301
301
|
"application/json": components["schemas"]["Error"];
|
|
302
302
|
};
|
|
303
303
|
};
|
|
304
|
-
/** API key or token was not valid */
|
|
304
|
+
/** @description API key or token was not valid */
|
|
305
305
|
UnauthorizedError: {
|
|
306
306
|
headers: {
|
|
307
307
|
[name: string]: unknown;
|
|
@@ -310,7 +310,7 @@ interface components {
|
|
|
310
310
|
"application/json": components["schemas"]["Error"];
|
|
311
311
|
};
|
|
312
312
|
};
|
|
313
|
-
/** Permission was denied */
|
|
313
|
+
/** @description Permission was denied */
|
|
314
314
|
ForbiddenError: {
|
|
315
315
|
headers: {
|
|
316
316
|
[name: string]: unknown;
|
|
@@ -319,14 +319,14 @@ interface components {
|
|
|
319
319
|
"application/json": components["schemas"]["Error"];
|
|
320
320
|
};
|
|
321
321
|
};
|
|
322
|
-
/** Too many requests in allowed time period */
|
|
322
|
+
/** @description Too many requests in allowed time period */
|
|
323
323
|
RateLimitError: {
|
|
324
324
|
headers: {
|
|
325
325
|
[name: string]: unknown;
|
|
326
326
|
};
|
|
327
327
|
content?: never;
|
|
328
328
|
};
|
|
329
|
-
/** Execution error occurred */
|
|
329
|
+
/** @description Execution error occurred */
|
|
330
330
|
InternalServerError: {
|
|
331
331
|
headers: {
|
|
332
332
|
[name: string]: unknown;
|
|
@@ -467,28 +467,27 @@ declare function ExtractWildcards(url: string): Wildcard[];
|
|
|
467
467
|
declare function RedirectFileConverter<T>({ client, redirectEntryObject, wildcardConverter, writeFile, }: RedirectFileConverterParams<T>): Promise<void>;
|
|
468
468
|
|
|
469
469
|
/**
|
|
470
|
-
*
|
|
471
|
-
* @
|
|
470
|
+
* @typedef {Object} ProcessedUrl
|
|
471
|
+
* @property {string} url - The full url used during processing
|
|
472
|
+
* @property {string} path - The path portion of the URL
|
|
473
|
+
* @property {string} domain - The domain of the URL
|
|
474
|
+
* @property {string} port - The port of the URL
|
|
475
|
+
* @property {string} query - The querystring of the URL
|
|
476
|
+
* @property {string} fragment - The fragment of the URL
|
|
477
|
+
* @property {string} protocol - The protocol of the URL
|
|
472
478
|
*/
|
|
473
479
|
type ProcessedUrl = {
|
|
474
|
-
/** The full url used during processing */
|
|
475
480
|
url: string;
|
|
476
|
-
/** The path portion of the URL */
|
|
477
481
|
path: string;
|
|
478
|
-
/** The domain of the URL */
|
|
479
482
|
domain: string;
|
|
480
|
-
/** The port of the URL */
|
|
481
483
|
port: string;
|
|
482
|
-
/** The querystring of the URL */
|
|
483
484
|
query: string;
|
|
484
|
-
/** The fragment of the URL */
|
|
485
485
|
fragment: string;
|
|
486
|
-
/** The protocol of the URL */
|
|
487
486
|
protocol: string;
|
|
488
487
|
};
|
|
489
488
|
/**
|
|
490
489
|
* Breaks a url into the separate parts for processing
|
|
491
|
-
* @returns The url broken down into independent components
|
|
490
|
+
* @returns {ProcessedUrl} The url broken down into independent components
|
|
492
491
|
*/
|
|
493
492
|
declare function processUrl(url: string): ProcessedUrl;
|
|
494
493
|
|
package/dist/index.d.ts
CHANGED
|
@@ -45,33 +45,33 @@ interface paths {
|
|
|
45
45
|
path?: never;
|
|
46
46
|
cookie?: never;
|
|
47
47
|
};
|
|
48
|
-
/** Called to retrieve a list of redirects related to a project */
|
|
48
|
+
/** @description Called to retrieve a list of redirects related to a project */
|
|
49
49
|
get: {
|
|
50
50
|
parameters: {
|
|
51
51
|
query: {
|
|
52
|
-
/** The project to fetch redirects for */
|
|
52
|
+
/** @description The project to fetch redirects for */
|
|
53
53
|
projectId: string;
|
|
54
|
-
/** Id of the redirect to retrieve */
|
|
54
|
+
/** @description Id of the redirect to retrieve */
|
|
55
55
|
id?: string;
|
|
56
|
-
/** Ids of the redirects to retrieve */
|
|
56
|
+
/** @description Ids of the redirects to retrieve */
|
|
57
57
|
ids?: string[];
|
|
58
|
-
/** Source url to attempt to find redirects for */
|
|
58
|
+
/** @description Source url to attempt to find redirects for */
|
|
59
59
|
sourceUrl?: string;
|
|
60
|
-
/** Find redirects that could redirect to this url */
|
|
60
|
+
/** @description Find redirects that could redirect to this url */
|
|
61
61
|
targetUrl?: string;
|
|
62
|
-
/** Id of the project map the source or target belongs to */
|
|
62
|
+
/** @description Id of the project map the source or target belongs to */
|
|
63
63
|
projectMapId?: string;
|
|
64
|
-
/** Id of the project map node to find redirects for */
|
|
64
|
+
/** @description Id of the project map node to find redirects for */
|
|
65
65
|
sourceProjectMapNodeId?: string;
|
|
66
|
-
/** Id of the project map node to find redirects for */
|
|
66
|
+
/** @description Id of the project map node to find redirects for */
|
|
67
67
|
targetProjectMapNodeId?: string;
|
|
68
|
-
/** Column to order results by, only applicable if trie is not active */
|
|
68
|
+
/** @description Column to order results by, only applicable if trie is not active */
|
|
69
69
|
orderBy?: "updated_at asc" | "updated_at desc" | "source_url asc" | "source_url desc" | "target_url asc" | "target_url desc" | "created_by asc" | "created_by desc";
|
|
70
|
-
/** Limit the results to this number of results, ignored if using trie parameter */
|
|
70
|
+
/** @description Limit the results to this number of results, ignored if using trie parameter */
|
|
71
71
|
limit?: number;
|
|
72
|
-
/** Offset the results a certain amount, useful for pagination */
|
|
72
|
+
/** @description Offset the results a certain amount, useful for pagination */
|
|
73
73
|
offset?: number;
|
|
74
|
-
/** Search text to filter redirects by, filtering on the source and target urls */
|
|
74
|
+
/** @description Search text to filter redirects by, filtering on the source and target urls */
|
|
75
75
|
search?: string;
|
|
76
76
|
};
|
|
77
77
|
header?: never;
|
|
@@ -80,7 +80,7 @@ interface paths {
|
|
|
80
80
|
};
|
|
81
81
|
requestBody?: never;
|
|
82
82
|
responses: {
|
|
83
|
-
/** OK */
|
|
83
|
+
/** @description OK */
|
|
84
84
|
200: {
|
|
85
85
|
headers: {
|
|
86
86
|
[name: string]: unknown;
|
|
@@ -109,18 +109,18 @@ interface paths {
|
|
|
109
109
|
requestBody: {
|
|
110
110
|
content: {
|
|
111
111
|
"application/json": {
|
|
112
|
-
/** Redirect object to insert */
|
|
112
|
+
/** @description Redirect object to insert */
|
|
113
113
|
redirect: components["schemas"]["Redirect"];
|
|
114
114
|
/**
|
|
115
115
|
* Format: uuid
|
|
116
|
-
* Project id to insert the redirect into
|
|
116
|
+
* @description Project id to insert the redirect into
|
|
117
117
|
*/
|
|
118
118
|
projectId: string;
|
|
119
119
|
};
|
|
120
120
|
};
|
|
121
121
|
};
|
|
122
122
|
responses: {
|
|
123
|
-
/** OK */
|
|
123
|
+
/** @description OK */
|
|
124
124
|
200: {
|
|
125
125
|
headers: {
|
|
126
126
|
[name: string]: unknown;
|
|
@@ -129,13 +129,13 @@ interface paths {
|
|
|
129
129
|
"application/json": {
|
|
130
130
|
/**
|
|
131
131
|
* Format: uuid
|
|
132
|
-
* Id of the redirect
|
|
132
|
+
* @description Id of the redirect
|
|
133
133
|
*/
|
|
134
134
|
id: string;
|
|
135
135
|
};
|
|
136
136
|
};
|
|
137
137
|
};
|
|
138
|
-
/** OK */
|
|
138
|
+
/** @description OK */
|
|
139
139
|
204: {
|
|
140
140
|
headers: {
|
|
141
141
|
[name: string]: unknown;
|
|
@@ -150,7 +150,7 @@ interface paths {
|
|
|
150
150
|
};
|
|
151
151
|
};
|
|
152
152
|
post?: never;
|
|
153
|
-
/** Called to delete a redirect */
|
|
153
|
+
/** @description Called to delete a redirect */
|
|
154
154
|
delete: {
|
|
155
155
|
parameters: {
|
|
156
156
|
query?: never;
|
|
@@ -163,19 +163,19 @@ interface paths {
|
|
|
163
163
|
"application/json": {
|
|
164
164
|
/**
|
|
165
165
|
* Format: uuid
|
|
166
|
-
* Redirect id to be deleted
|
|
166
|
+
* @description Redirect id to be deleted
|
|
167
167
|
*/
|
|
168
168
|
id: string;
|
|
169
169
|
/**
|
|
170
170
|
* Format: uuid
|
|
171
|
-
* Project the redirect belongs to
|
|
171
|
+
* @description Project the redirect belongs to
|
|
172
172
|
*/
|
|
173
173
|
projectId: string;
|
|
174
174
|
};
|
|
175
175
|
};
|
|
176
176
|
};
|
|
177
177
|
responses: {
|
|
178
|
-
/** OK */
|
|
178
|
+
/** @description OK */
|
|
179
179
|
200: {
|
|
180
180
|
headers: {
|
|
181
181
|
[name: string]: unknown;
|
|
@@ -184,13 +184,13 @@ interface paths {
|
|
|
184
184
|
"application/json": {
|
|
185
185
|
/**
|
|
186
186
|
* Format: uuid
|
|
187
|
-
* Id of the redirect
|
|
187
|
+
* @description Id of the redirect
|
|
188
188
|
*/
|
|
189
189
|
id: string;
|
|
190
190
|
};
|
|
191
191
|
};
|
|
192
192
|
};
|
|
193
|
-
/** OK */
|
|
193
|
+
/** @description OK */
|
|
194
194
|
204: {
|
|
195
195
|
headers: {
|
|
196
196
|
[name: string]: unknown;
|
|
@@ -204,7 +204,7 @@ interface paths {
|
|
|
204
204
|
500: components["responses"]["InternalServerError"];
|
|
205
205
|
};
|
|
206
206
|
};
|
|
207
|
-
/** Handles preflight requests. This endpoint allows CORS */
|
|
207
|
+
/** @description Handles preflight requests. This endpoint allows CORS */
|
|
208
208
|
options: {
|
|
209
209
|
parameters: {
|
|
210
210
|
query?: never;
|
|
@@ -214,7 +214,7 @@ interface paths {
|
|
|
214
214
|
};
|
|
215
215
|
requestBody?: never;
|
|
216
216
|
responses: {
|
|
217
|
-
/** OK */
|
|
217
|
+
/** @description OK */
|
|
218
218
|
204: {
|
|
219
219
|
headers: {
|
|
220
220
|
[name: string]: unknown;
|
|
@@ -235,64 +235,64 @@ interface components {
|
|
|
235
235
|
metadata: components["schemas"]["RedirectMetadata"];
|
|
236
236
|
}[];
|
|
237
237
|
RedirectMetadata: {
|
|
238
|
-
/** The last time the redirect was modified in UTC */
|
|
238
|
+
/** @description The last time the redirect was modified in UTC */
|
|
239
239
|
updatedAt?: string;
|
|
240
|
-
/** The last user who modified this redirect */
|
|
240
|
+
/** @description The last user who modified this redirect */
|
|
241
241
|
updatedBy?: string;
|
|
242
|
-
/** The time the redirect was created in UTC */
|
|
242
|
+
/** @description The time the redirect was created in UTC */
|
|
243
243
|
createdAt?: string;
|
|
244
|
-
/** The user who created this redirect */
|
|
244
|
+
/** @description The user who created this redirect */
|
|
245
245
|
createdBy?: string;
|
|
246
|
-
/** The user who created this redirect's name */
|
|
246
|
+
/** @description The user who created this redirect's name */
|
|
247
247
|
createdByName?: string;
|
|
248
248
|
};
|
|
249
249
|
Redirect: {
|
|
250
250
|
/**
|
|
251
251
|
* Format: uuid
|
|
252
|
-
* Id of the redirect
|
|
252
|
+
* @description Id of the redirect
|
|
253
253
|
*/
|
|
254
254
|
id?: string;
|
|
255
|
-
/** Source meant to match a url that needs to be redirected */
|
|
255
|
+
/** @description Source meant to match a url that needs to be redirected */
|
|
256
256
|
sourceUrl: string;
|
|
257
|
-
/** Target meant to be redirected to */
|
|
257
|
+
/** @description Target meant to be redirected to */
|
|
258
258
|
targetUrl: string;
|
|
259
|
-
/** Redirect type to occur from this redirect */
|
|
259
|
+
/** @description Redirect type to occur from this redirect */
|
|
260
260
|
targetStatusCode: number;
|
|
261
261
|
/**
|
|
262
262
|
* Format: uuid
|
|
263
|
-
* Project map node related to the source this redirect
|
|
263
|
+
* @description Project map node related to the source this redirect
|
|
264
264
|
*/
|
|
265
265
|
sourceProjectMapNodeId?: string;
|
|
266
266
|
/**
|
|
267
267
|
* Format: uuid
|
|
268
|
-
* Project map node related to the target this redirect
|
|
268
|
+
* @description Project map node related to the target this redirect
|
|
269
269
|
*/
|
|
270
270
|
targetProjectMapNodeId?: string;
|
|
271
271
|
/**
|
|
272
272
|
* Format: uuid
|
|
273
|
-
* Project map related to this redirect
|
|
273
|
+
* @description Project map related to this redirect
|
|
274
274
|
*/
|
|
275
275
|
projectMapId?: string;
|
|
276
|
-
/** Signals the redirect engine to retain query string parameters to the target url */
|
|
276
|
+
/** @description Signals the redirect engine to retain query string parameters to the target url */
|
|
277
277
|
sourceRetainQuerystring?: boolean;
|
|
278
|
-
/** Incoming requests must match the domain that's defined in the redirection source */
|
|
278
|
+
/** @description Incoming requests must match the domain that's defined in the redirection source */
|
|
279
279
|
sourceMustMatchDomain?: boolean;
|
|
280
|
-
/** Rewritten url should match the protocol (http / https) of the incoming request instead of whatever is defined in the redirection target */
|
|
280
|
+
/** @description Rewritten url should match the protocol (http / https) of the incoming request instead of whatever is defined in the redirection target */
|
|
281
281
|
targetPreserveIncomingProtocol?: boolean;
|
|
282
|
-
/** Rewritten url should match the domain of the incoming request regardless of what is defined in the redirection target */
|
|
282
|
+
/** @description Rewritten url should match the domain of the incoming request regardless of what is defined in the redirection target */
|
|
283
283
|
targetPreserveIncomingDomain?: boolean;
|
|
284
|
-
/** Merge incoming querystring with the querystring defined on the redirection target, taking the incoming querystring parameter where a merge is not possible */
|
|
284
|
+
/** @description Merge incoming querystring with the querystring defined on the redirection target, taking the incoming querystring parameter where a merge is not possible */
|
|
285
285
|
targetMergeQuerystring?: boolean;
|
|
286
|
-
/** Label as system generated or user generated */
|
|
286
|
+
/** @description Label as system generated or user generated */
|
|
287
287
|
labelAsSystem?: boolean;
|
|
288
288
|
};
|
|
289
289
|
Error: {
|
|
290
|
-
/** Error message(s) that occurred while processing the request */
|
|
290
|
+
/** @description Error message(s) that occurred while processing the request */
|
|
291
291
|
errorMessage?: string[] | string;
|
|
292
292
|
};
|
|
293
293
|
};
|
|
294
294
|
responses: {
|
|
295
|
-
/** Request input validation failed */
|
|
295
|
+
/** @description Request input validation failed */
|
|
296
296
|
BadRequestError: {
|
|
297
297
|
headers: {
|
|
298
298
|
[name: string]: unknown;
|
|
@@ -301,7 +301,7 @@ interface components {
|
|
|
301
301
|
"application/json": components["schemas"]["Error"];
|
|
302
302
|
};
|
|
303
303
|
};
|
|
304
|
-
/** API key or token was not valid */
|
|
304
|
+
/** @description API key or token was not valid */
|
|
305
305
|
UnauthorizedError: {
|
|
306
306
|
headers: {
|
|
307
307
|
[name: string]: unknown;
|
|
@@ -310,7 +310,7 @@ interface components {
|
|
|
310
310
|
"application/json": components["schemas"]["Error"];
|
|
311
311
|
};
|
|
312
312
|
};
|
|
313
|
-
/** Permission was denied */
|
|
313
|
+
/** @description Permission was denied */
|
|
314
314
|
ForbiddenError: {
|
|
315
315
|
headers: {
|
|
316
316
|
[name: string]: unknown;
|
|
@@ -319,14 +319,14 @@ interface components {
|
|
|
319
319
|
"application/json": components["schemas"]["Error"];
|
|
320
320
|
};
|
|
321
321
|
};
|
|
322
|
-
/** Too many requests in allowed time period */
|
|
322
|
+
/** @description Too many requests in allowed time period */
|
|
323
323
|
RateLimitError: {
|
|
324
324
|
headers: {
|
|
325
325
|
[name: string]: unknown;
|
|
326
326
|
};
|
|
327
327
|
content?: never;
|
|
328
328
|
};
|
|
329
|
-
/** Execution error occurred */
|
|
329
|
+
/** @description Execution error occurred */
|
|
330
330
|
InternalServerError: {
|
|
331
331
|
headers: {
|
|
332
332
|
[name: string]: unknown;
|
|
@@ -467,28 +467,27 @@ declare function ExtractWildcards(url: string): Wildcard[];
|
|
|
467
467
|
declare function RedirectFileConverter<T>({ client, redirectEntryObject, wildcardConverter, writeFile, }: RedirectFileConverterParams<T>): Promise<void>;
|
|
468
468
|
|
|
469
469
|
/**
|
|
470
|
-
*
|
|
471
|
-
* @
|
|
470
|
+
* @typedef {Object} ProcessedUrl
|
|
471
|
+
* @property {string} url - The full url used during processing
|
|
472
|
+
* @property {string} path - The path portion of the URL
|
|
473
|
+
* @property {string} domain - The domain of the URL
|
|
474
|
+
* @property {string} port - The port of the URL
|
|
475
|
+
* @property {string} query - The querystring of the URL
|
|
476
|
+
* @property {string} fragment - The fragment of the URL
|
|
477
|
+
* @property {string} protocol - The protocol of the URL
|
|
472
478
|
*/
|
|
473
479
|
type ProcessedUrl = {
|
|
474
|
-
/** The full url used during processing */
|
|
475
480
|
url: string;
|
|
476
|
-
/** The path portion of the URL */
|
|
477
481
|
path: string;
|
|
478
|
-
/** The domain of the URL */
|
|
479
482
|
domain: string;
|
|
480
|
-
/** The port of the URL */
|
|
481
483
|
port: string;
|
|
482
|
-
/** The querystring of the URL */
|
|
483
484
|
query: string;
|
|
484
|
-
/** The fragment of the URL */
|
|
485
485
|
fragment: string;
|
|
486
|
-
/** The protocol of the URL */
|
|
487
486
|
protocol: string;
|
|
488
487
|
};
|
|
489
488
|
/**
|
|
490
489
|
* Breaks a url into the separate parts for processing
|
|
491
|
-
* @returns The url broken down into independent components
|
|
490
|
+
* @returns {ProcessedUrl} The url broken down into independent components
|
|
492
491
|
*/
|
|
493
492
|
declare function processUrl(url: string): ProcessedUrl;
|
|
494
493
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/redirect",
|
|
3
|
-
"version": "20.75.1-alpha.
|
|
3
|
+
"version": "20.75.1-alpha.3+8eaaa5230a",
|
|
4
4
|
"description": "Uniform redirect client",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -32,12 +32,12 @@
|
|
|
32
32
|
"/dist"
|
|
33
33
|
],
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@uniformdev/context": "20.75.1-alpha.
|
|
35
|
+
"@uniformdev/context": "20.75.1-alpha.3+8eaaa5230a",
|
|
36
36
|
"p-limit": "^3.1.0",
|
|
37
37
|
"rfdc": "^1.4.1"
|
|
38
38
|
},
|
|
39
39
|
"publishConfig": {
|
|
40
40
|
"access": "public"
|
|
41
41
|
},
|
|
42
|
-
"gitHead": "
|
|
42
|
+
"gitHead": "8eaaa5230a5621f7b30b1b54b48dcd097f684af9"
|
|
43
43
|
}
|