@uniformdev/redirect 19.62.0 → 19.62.1-alpha.127

package/LICENSE.txt

@@ -1,2 +1,2 @@
-© 2023 Uniform Systems, Inc. All Rights Reserved.
+© 2024 Uniform Systems, Inc. All Rights Reserved.
 See details of Uniform Systems, Inc. Master Subscription Agreement here: https://uniform.dev/eula

package/dist/index.d.mts

@@ -111,9 +111,6 @@ declare class RedirectClient extends ApiClient<RedirectClientOptions> {
      */
     private static processDefinitionToResults;
     static validateRedirect(url: string, redirectDefinition: RedirectDefinition['redirect']): boolean;
-    static getTargetVariableExpandedUrl(url: string, redirectDefinition: RedirectDefinition['redirect'], isVariable?: (pathSegment: string) => boolean): string;
-    private static mergeQueryStrings;
-    private static getSourceVariables;
 }
 declare class UncachedRedirectClient extends RedirectClient {
     constructor(options: Omit<RedirectClientOptions, 'bypassCache'>);
@@ -162,7 +159,6 @@ interface paths {
                         "application/json": {
                             redirects: components["schemas"]["RedirectGetResponse"];
                             total?: number;
-                            resultUrl?: string;
                         };
                     };
                 };
@@ -402,6 +398,12 @@ declare class WithMemoryCache extends RedirectClientCache<RedirectClientCacheOpt
     refresh(): Promise<void[]>;
 }
 
+declare function getTargetVariableExpandedUrl(url: string, redirectDefinition: RedirectDefinition['redirect'], isVariable?: (pathSegment: string) => boolean): string;
+declare function getSourceVariables(path: string, source: string, isVariable?: (pathSegment: string, isLast: boolean) => boolean): {
+    [variable: string]: string;
+};
+declare function mergeQueryStrings(qs1: string, qs2: string): string;
+
 type Wildcard = {
     pathSegment: string;
     index: number;
@@ -448,4 +450,4 @@ type ProcessedUrl = {
  */
 declare function processUrl(url: string): ProcessedUrl;
 
-export { DirectionAwareRedirectDefinition, ExtractWildcards, PathTrie, PathTrieData, ProcessedUrl, RedirectClient, RedirectClientGetRedirect, RedirectClientGetRedirects, RedirectClientGetRequest, RedirectClientOptions, RedirectDataCache, RedirectDefinition, RedirectDefinitions, RedirectDeleteRequest, RedirectDeleteResponse, RedirectFileConverter, RedirectFileConverterParams, RedirectGetRequest, RedirectGetResponse, RedirectOptions, RedirectResult, RedirectUpsertRequest, RedirectUpsertResponse, SourceAndTarget, SourceTargetAndWildcards, UncachedRedirectClient, Wildcard, WithMemoryCache, pathTrieReturn, processUrl };
+export { type DirectionAwareRedirectDefinition, ExtractWildcards, PathTrie, PathTrieData, type ProcessedUrl, RedirectClient, type RedirectClientGetRedirect, type RedirectClientGetRedirects, type RedirectClientGetRequest, type RedirectClientOptions, type RedirectDataCache, type RedirectDefinition, type RedirectDefinitions, type RedirectDeleteRequest, type RedirectDeleteResponse, RedirectFileConverter, type RedirectFileConverterParams, type RedirectGetRequest, type RedirectGetResponse, type RedirectOptions, type RedirectResult, type RedirectUpsertRequest, type RedirectUpsertResponse, type SourceAndTarget, type SourceTargetAndWildcards, UncachedRedirectClient, type Wildcard, WithMemoryCache, getSourceVariables, getTargetVariableExpandedUrl, mergeQueryStrings, type pathTrieReturn, processUrl };

package/dist/index.d.ts

@@ -111,9 +111,6 @@ declare class RedirectClient extends ApiClient<RedirectClientOptions> {
      */
     private static processDefinitionToResults;
     static validateRedirect(url: string, redirectDefinition: RedirectDefinition['redirect']): boolean;
-    static getTargetVariableExpandedUrl(url: string, redirectDefinition: RedirectDefinition['redirect'], isVariable?: (pathSegment: string) => boolean): string;
-    private static mergeQueryStrings;
-    private static getSourceVariables;
 }
 declare class UncachedRedirectClient extends RedirectClient {
     constructor(options: Omit<RedirectClientOptions, 'bypassCache'>);
@@ -162,7 +159,6 @@ interface paths {
                         "application/json": {
                             redirects: components["schemas"]["RedirectGetResponse"];
                             total?: number;
-                            resultUrl?: string;
                         };
                     };
                 };
@@ -402,6 +398,12 @@ declare class WithMemoryCache extends RedirectClientCache<RedirectClientCacheOpt
     refresh(): Promise<void[]>;
 }
 
+declare function getTargetVariableExpandedUrl(url: string, redirectDefinition: RedirectDefinition['redirect'], isVariable?: (pathSegment: string) => boolean): string;
+declare function getSourceVariables(path: string, source: string, isVariable?: (pathSegment: string, isLast: boolean) => boolean): {
+    [variable: string]: string;
+};
+declare function mergeQueryStrings(qs1: string, qs2: string): string;
+
 type Wildcard = {
     pathSegment: string;
     index: number;
@@ -448,4 +450,4 @@ type ProcessedUrl = {
  */
 declare function processUrl(url: string): ProcessedUrl;
 
-export { DirectionAwareRedirectDefinition, ExtractWildcards, PathTrie, PathTrieData, ProcessedUrl, RedirectClient, RedirectClientGetRedirect, RedirectClientGetRedirects, RedirectClientGetRequest, RedirectClientOptions, RedirectDataCache, RedirectDefinition, RedirectDefinitions, RedirectDeleteRequest, RedirectDeleteResponse, RedirectFileConverter, RedirectFileConverterParams, RedirectGetRequest, RedirectGetResponse, RedirectOptions, RedirectResult, RedirectUpsertRequest, RedirectUpsertResponse, SourceAndTarget, SourceTargetAndWildcards, UncachedRedirectClient, Wildcard, WithMemoryCache, pathTrieReturn, processUrl };
+export { type DirectionAwareRedirectDefinition, ExtractWildcards, PathTrie, PathTrieData, type ProcessedUrl, RedirectClient, type RedirectClientGetRedirect, type RedirectClientGetRedirects, type RedirectClientGetRequest, type RedirectClientOptions, type RedirectDataCache, type RedirectDefinition, type RedirectDefinitions, type RedirectDeleteRequest, type RedirectDeleteResponse, RedirectFileConverter, type RedirectFileConverterParams, type RedirectGetRequest, type RedirectGetResponse, type RedirectOptions, type RedirectResult, type RedirectUpsertRequest, type RedirectUpsertResponse, type SourceAndTarget, type SourceTargetAndWildcards, UncachedRedirectClient, type Wildcard, WithMemoryCache, getSourceVariables, getTargetVariableExpandedUrl, mergeQueryStrings, type pathTrieReturn, processUrl };

package/dist/index.esm.js

@@ -1,5 +1,3 @@
-import "./chunk-TLYAXJ7N.mjs";
-
 // src/cache/data/refresher.ts
 var Refresher = class {
   /**
@@ -262,22 +260,78 @@ import { ApiClient } from "@uniformdev/context/api";
 // src/util/url.ts
 function processUrl(url) {
   var _a, _b, _c, _d, _e, _f;
-  const matches = url.match(/^(https?:\/\/)?(([^:/?#]*)(?:(:[0-9]+))?)?([/]{0,1}[^?#]*)(\?[^#]*|)(#.*|)$/);
+  const matches = url.match(/^(https?:\/\/)?(([^:/?#]*)(?:(:[0-9]+))?)?([/]{0,1}[^?#]*)(\?[^#?]*|)(#.*|)$/);
+  const protocol = (_a = matches == null ? void 0 : matches[1]) != null ? _a : "";
+  const domain = (_b = matches == null ? void 0 : matches[3]) != null ? _b : "";
+  const port = (_c = matches == null ? void 0 : matches[4]) != null ? _c : "";
+  const path = (_d = matches == null ? void 0 : matches[5].replace(/\/+$/g, "")) != null ? _d : "";
+  const query = (_e = matches == null ? void 0 : matches[6]) != null ? _e : "";
+  const fragment = (_f = matches == null ? void 0 : matches[7]) != null ? _f : "";
   return {
-    url,
-    protocol: (_a = matches == null ? void 0 : matches[1]) != null ? _a : "",
-    domain: (_b = matches == null ? void 0 : matches[3]) != null ? _b : "",
-    port: (_c = matches == null ? void 0 : matches[4]) != null ? _c : "",
-    path: (_d = matches == null ? void 0 : matches[5]) != null ? _d : "",
-    query: (_e = matches == null ? void 0 : matches[6]) != null ? _e : "",
-    fragment: (_f = matches == null ? void 0 : matches[7]) != null ? _f : ""
+    url: `${protocol}${domain}${port}${path}${query}${fragment}`,
+    protocol,
+    domain,
+    port,
+    path,
+    query,
+    fragment
   };
 }
 
+// src/util/process.ts
+function getTargetVariableExpandedUrl(url, redirectDefinition, isVariable) {
+  const processedTarget = processUrl(redirectDefinition.targetUrl);
+  const processedSource = processUrl(redirectDefinition.sourceUrl);
+  let finalUrlPath = processedTarget.path;
+  const processedUrl = processUrl(url);
+  const variables = getSourceVariables(processedUrl.path, processedSource.path, isVariable);
+  for (const variable in variables) {
+    finalUrlPath = finalUrlPath.replace(variable, variables[variable]);
+  }
+  let protocol = redirectDefinition.targetPreserveIncomingProtocol || processedTarget.protocol === "" ? processedUrl.protocol : processedTarget.protocol;
+  const domain = protocol !== "" ? redirectDefinition.targetPreserveIncomingDomain || processedTarget.domain === "" ? processedUrl.domain : processedTarget.domain : "";
+  if (domain === "" && protocol !== "") {
+    protocol = "";
+  }
+  const port = domain === "" ? "" : redirectDefinition.targetPreserveIncomingDomain || processedTarget.domain === "" ? processedUrl.port : processedTarget.port;
+  const query = redirectDefinition.sourceRetainQuerystring && redirectDefinition.targetMergeQuerystring ? mergeQueryStrings(processedUrl.query, processedTarget.query) : !redirectDefinition.targetMergeQuerystring && redirectDefinition.sourceRetainQuerystring ? processedUrl.query : processedTarget.query;
+  const fragment = redirectDefinition.sourceRetainQuerystring && redirectDefinition.targetMergeQuerystring ? mergeQueryStrings(processedUrl.fragment, processedTarget.fragment) : !redirectDefinition.targetMergeQuerystring && redirectDefinition.sourceRetainQuerystring ? processedUrl.fragment : processedTarget.fragment;
+  return `${protocol}${domain}${port}${finalUrlPath}${query}${fragment}`;
+}
+function getSourceVariables(path, source, isVariable = (pathSegment, isLast) => pathSegment.startsWith(":") || pathSegment === "*" && isLast) {
+  const variables = {};
+  const pathSegments = path.split("/");
+  const sourceSegments = source.split("/");
+  sourceSegments.forEach((sourceSegment, i) => {
+    if (pathSegments.length >= i && isVariable(sourceSegment, i === sourceSegments.length - 1)) {
+      variables[sourceSegment] = pathSegments[i];
+    }
+  });
+  return variables;
+}
+function mergeQueryStrings(qs1, qs2) {
+  let fragment = false;
+  if (qs1.startsWith("#")) {
+    fragment = true;
+    qs1 = qs1.substring(1);
+  }
+  if (qs2.startsWith("#")) {
+    fragment = true;
+    qs2 = qs2.substring(1);
+  }
+  const params1 = new URLSearchParams(qs1);
+  const params2 = new URLSearchParams(qs2);
+  const merged = new URLSearchParams([...params1, ...params2]).toString();
+  if (merged.length > 0)
+    return (fragment ? "#" : "?") + merged;
+  return "";
+}
+
 // src/redirectClient.ts
 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;
@@ -285,12 +339,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;
@@ -372,7 +428,7 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
         return _RedirectClient.processDefinitionToResults(
           processedUrl,
           redirect,
-          _RedirectClient.getSourceVariables(
+          getSourceVariables(
             processedUrl.path,
             processUrl((options == null ? void 0 : options.reverse) ? redirect.redirect.targetUrl : redirect.redirect.sourceUrl).path
           ),
@@ -382,6 +438,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) {
@@ -393,7 +451,7 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
           return _RedirectClient.processDefinitionToResults(
             processedUrl,
             redirect,
-            _RedirectClient.getSourceVariables(
+            getSourceVariables(
               processedUrl.path,
               processUrl((options == null ? void 0 : options.reverse) ? redirect.redirect.targetUrl : redirect.redirect.sourceUrl).path
             ),
@@ -414,6 +472,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;
@@ -462,6 +521,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) => {
@@ -530,7 +591,7 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
     const redirect = definition == null ? void 0 : definition.redirect;
     if (redirect.sourceMustMatchDomain && processedUrl.domain !== processedResult.domain)
       return void 0;
-    const finalUrl = (options == null ? void 0 : options.reverse) ? "n/a" : _RedirectClient.getTargetVariableExpandedUrl(processedUrl.url, redirect);
+    const finalUrl = (options == null ? void 0 : options.reverse) ? "n/a" : getTargetVariableExpandedUrl(processedUrl.url, redirect);
     return {
       url: finalUrl,
       definition,
@@ -556,56 +617,6 @@ var _RedirectClient = class _RedirectClient extends ApiClient {
     }
     return true;
   }
-  static getTargetVariableExpandedUrl(url, redirectDefinition, isVariable) {
-    const processedTarget = processUrl(redirectDefinition.targetUrl);
-    const processedSource = processUrl(redirectDefinition.sourceUrl);
-    let finalUrlPath = processedTarget.path;
-    const processedUrl = processUrl(url);
-    const variables = this.getSourceVariables(processedUrl.path, processedSource.path, isVariable);
-    for (const variable in variables) {
-      finalUrlPath = finalUrlPath.replace(variable, variables[variable]);
-    }
-    let protocol = redirectDefinition.targetPreserveIncomingProtocol || processedTarget.protocol === "" ? processedUrl.protocol : processedTarget.protocol;
-    const domain = protocol !== "" ? redirectDefinition.targetPreserveIncomingDomain || processedTarget.domain === "" ? processedUrl.domain : processedTarget.domain : "";
-    if (domain === "" && protocol !== "") {
-      protocol = "";
-    }
-    const port = domain === "" ? "" : redirectDefinition.targetPreserveIncomingDomain || processedTarget.domain === "" ? processedUrl.port : processedTarget.port;
-    const query = redirectDefinition.sourceRetainQuerystring && redirectDefinition.targetMergeQuerystring ? this.mergeQueryStrings(processedUrl.query, processedTarget.query) : !redirectDefinition.targetMergeQuerystring && redirectDefinition.sourceRetainQuerystring ? processedUrl.query : processedTarget.query;
-    const fragment = redirectDefinition.sourceRetainQuerystring && redirectDefinition.targetMergeQuerystring ? this.mergeQueryStrings(processedUrl.fragment, processedTarget.fragment) : !redirectDefinition.targetMergeQuerystring && redirectDefinition.sourceRetainQuerystring ? processedUrl.fragment : processedTarget.fragment;
-    return `${protocol}${domain}${port}${finalUrlPath}${query}${fragment}`;
-  }
-  static mergeQueryStrings(qs1, qs2) {
-    let fragment = false;
-    if (qs1.startsWith("#")) {
-      fragment = true;
-      qs1 = qs1.substring(1);
-    }
-    if (qs2.startsWith("#")) {
-      fragment = true;
-      qs2 = qs2.substring(1);
-    }
-    const params1 = new URLSearchParams(qs1);
-    const params2 = new URLSearchParams(qs2);
-    const merged = new URLSearchParams([...params1, ...params2]).toString();
-    if (merged.length > 0)
-      return (fragment ? "#" : "?") + merged;
-    return "";
-  }
-  static getSourceVariables(path, source, isVariable = (pathSegment, isLast) => pathSegment.startsWith(":") || pathSegment === "*" && isLast) {
-    const variables = {};
-    const pathSegments = path.split("/");
-    const sourceSegments = source.split("/");
-    if (pathSegments.length !== sourceSegments.length && !source.endsWith("/*")) {
-      throw new Error("Path and source have different numbers of path segments, must be the same");
-    }
-    sourceSegments.forEach((sourceSegment, i) => {
-      if (isVariable(sourceSegment, i === sourceSegments.length - 1)) {
-        variables[sourceSegment] = pathSegments[i];
-      }
-    });
-    return variables;
-  }
 };
 _RedirectClient.processUrlBestMatch = async (url, trie, options) => {
   var _a;
@@ -624,8 +635,6 @@ var UncachedRedirectClient = class extends RedirectClient {
 
 // src/util/RedirectFileConverter.ts
 var getDefaultClient = async () => {
-  const dotenv = await import("./main-4Y7KG46W.mjs");
-  dotenv.config();
   return new RedirectClient({
     apiKey: process.env.UNIFORM_API_KEY,
     apiHost: process.env.UNIFORM_BASE_URL,
@@ -702,5 +711,8 @@ export {
   RedirectFileConverter,
   UncachedRedirectClient,
   WithMemoryCache,
+  getSourceVariables,
+  getTargetVariableExpandedUrl,
+  mergeQueryStrings,
   processUrl
 };