@uniformdev/redirect 19.100.0 → 19.106.1-alpha.3

package/dist/index.esm.js

@@ -334,6 +334,7 @@ function mergeQueryStrings(qs1, qs2) {
 var _RedirectClient = class _RedirectClient extends ApiClient {
   constructor(options) {
     super(options);
+    // Get a single redirect by ID or project map id
     this.getRedirect = async (options) => {
       var _a;
       const { projectId } = this.options;
@@ -341,12 +342,14 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
       const results = await this.apiClient(fetchUri);
       return (_a = results.redirects) == null ? void 0 : _a[0];
     };
+    // Get redirects by list of IDs, source URL, target URL, or search
     this.getRedirects = async (options) => {
       const { projectId } = this.options;
       const fetchUri = this.createUrl("/api/v1/redirect", { ...options, projectId });
       const results = await this.apiClient(fetchUri);
       return results;
     };
+    // Assemble a trie powered search structure, used to have instant resolution of redirects.  Note, result set may be large.
     this.getRedirectTrie = async (options) => {
       var _a, _b;
       const { projectId } = this.options;
@@ -438,6 +441,8 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
       const trie = await this.getRedirectTrie();
       return (_b = _RedirectClient.processHops(sanitizedUrl, trie, true, options)) == null ? void 0 : _b[0];
     };
+    // Caculate redirect matches based on an incoming URL with an option to use a trie storage structure to streamline future
+    // redirect resolutions.  Note this may cause a large in memory load for large collections of redirect, off by default.
     this.processUrlAllMatches = async (url, options, useTrie) => {
       const sanitizedUrl = url.endsWith("/") ? url.replace(/\/+$/, "") : url;
       if (!useTrie) {
@@ -470,6 +475,7 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
       }
     }
   }
+  // Get all redirects in Uniform 500 at a time.
   async *getAllRedirects(orderBy = "updated_at desc") {
     var _a, _b;
     const { projectId } = this.options;
@@ -518,6 +524,8 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
     }
     return await _RedirectClient.assemblingPromise;
   }
+  // Find all redirects involved for the current URL, this is for the case where a redirect definition leads to
+  // another redirect.  This also involves cycle busting error handling
   static processHops(initialUrl, trie, bestMatch, options) {
     const url = (options == null ? void 0 : options.reverse) ? initialUrl.replace(/\/:/, "/~~") : initialUrl;
     const isCycle = (id, result) => {

package/dist/index.js

@@ -380,6 +380,7 @@ function mergeQueryStrings(qs1, qs2) {
 var _RedirectClient = class _RedirectClient extends import_api.ApiClient {
   constructor(options) {
     super(options);
+    // Get a single redirect by ID or project map id
     this.getRedirect = async (options) => {
       var _a;
       const { projectId } = this.options;
@@ -387,12 +388,14 @@ var _RedirectClient = class _RedirectClient extends import_api.ApiClient {
       const results = await this.apiClient(fetchUri);
       return (_a = results.redirects) == null ? void 0 : _a[0];
     };
+    // Get redirects by list of IDs, source URL, target URL, or search
     this.getRedirects = async (options) => {
       const { projectId } = this.options;
       const fetchUri = this.createUrl("/api/v1/redirect", { ...options, projectId });
       const results = await this.apiClient(fetchUri);
       return results;
     };
+    // Assemble a trie powered search structure, used to have instant resolution of redirects.  Note, result set may be large.
     this.getRedirectTrie = async (options) => {
       var _a, _b;
       const { projectId } = this.options;
@@ -484,6 +487,8 @@ var _RedirectClient = class _RedirectClient extends import_api.ApiClient {
       const trie = await this.getRedirectTrie();
       return (_b = _RedirectClient.processHops(sanitizedUrl, trie, true, options)) == null ? void 0 : _b[0];
     };
+    // Caculate redirect matches based on an incoming URL with an option to use a trie storage structure to streamline future
+    // redirect resolutions.  Note this may cause a large in memory load for large collections of redirect, off by default.
     this.processUrlAllMatches = async (url, options, useTrie) => {
       const sanitizedUrl = url.endsWith("/") ? url.replace(/\/+$/, "") : url;
       if (!useTrie) {
@@ -516,6 +521,7 @@ var _RedirectClient = class _RedirectClient extends import_api.ApiClient {
       }
     }
   }
+  // Get all redirects in Uniform 500 at a time.
   async *getAllRedirects(orderBy = "updated_at desc") {
     var _a, _b;
     const { projectId } = this.options;
@@ -564,6 +570,8 @@ var _RedirectClient = class _RedirectClient extends import_api.ApiClient {
     }
     return await _RedirectClient.assemblingPromise;
   }
+  // Find all redirects involved for the current URL, this is for the case where a redirect definition leads to
+  // another redirect.  This also involves cycle busting error handling
   static processHops(initialUrl, trie, bestMatch, options) {
     const url = (options == null ? void 0 : options.reverse) ? initialUrl.replace(/\/:/, "/~~") : initialUrl;
     const isCycle = (id, result) => {

package/dist/index.mjs

@@ -334,6 +334,7 @@ function mergeQueryStrings(qs1, qs2) {
 var _RedirectClient = class _RedirectClient extends ApiClient {
   constructor(options) {
     super(options);
+    // Get a single redirect by ID or project map id
     this.getRedirect = async (options) => {
       var _a;
       const { projectId } = this.options;
@@ -341,12 +342,14 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
       const results = await this.apiClient(fetchUri);
       return (_a = results.redirects) == null ? void 0 : _a[0];
     };
+    // Get redirects by list of IDs, source URL, target URL, or search
     this.getRedirects = async (options) => {
       const { projectId } = this.options;
       const fetchUri = this.createUrl("/api/v1/redirect", { ...options, projectId });
       const results = await this.apiClient(fetchUri);
       return results;
     };
+    // Assemble a trie powered search structure, used to have instant resolution of redirects.  Note, result set may be large.
     this.getRedirectTrie = async (options) => {
       var _a, _b;
       const { projectId } = this.options;
@@ -438,6 +441,8 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
       const trie = await this.getRedirectTrie();
       return (_b = _RedirectClient.processHops(sanitizedUrl, trie, true, options)) == null ? void 0 : _b[0];
     };
+    // Caculate redirect matches based on an incoming URL with an option to use a trie storage structure to streamline future
+    // redirect resolutions.  Note this may cause a large in memory load for large collections of redirect, off by default.
     this.processUrlAllMatches = async (url, options, useTrie) => {
       const sanitizedUrl = url.endsWith("/") ? url.replace(/\/+$/, "") : url;
       if (!useTrie) {
@@ -470,6 +475,7 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
       }
     }
   }
+  // Get all redirects in Uniform 500 at a time.
   async *getAllRedirects(orderBy = "updated_at desc") {
     var _a, _b;
     const { projectId } = this.options;
@@ -518,6 +524,8 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
     }
     return await _RedirectClient.assemblingPromise;
   }
+  // Find all redirects involved for the current URL, this is for the case where a redirect definition leads to
+  // another redirect.  This also involves cycle busting error handling
   static processHops(initialUrl, trie, bestMatch, options) {
     const url = (options == null ? void 0 : options.reverse) ? initialUrl.replace(/\/:/, "/~~") : initialUrl;
     const isCycle = (id, result) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/redirect",
-  "version": "19.100.0",
+  "version": "19.106.1-alpha.3+47677ea6f",
   "description": "Uniform redirect client",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -33,12 +33,12 @@
     "/dist"
   ],
   "dependencies": {
-    "@uniformdev/context": "19.100.0",
+    "@uniformdev/context": "19.106.1-alpha.3+47677ea6f",
     "p-limit": "^3.1.0",
     "rfdc": "^1.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3a7c70c06a71b4ecc211ab15eb3bb185480ccf36"
+  "gitHead": "47677ea6fd6eb707bb30eb20dc67e42573e0516d"
 }