@smartlyio/oats-runtime 4.3.1 → 4.3.2

package/dist/redirect.d.ts

@@ -14,6 +14,12 @@ declare type DefaultValue<ContentType extends string> = ContentType extends type
  * But it will pass if type inference is not prevented.
  */
 declare type PreventGenericDefaultValueOverride<T> = [T][T extends unknown ? 0 : never];
+/**
+ * Use to perform HTTP redirect.
+ * @param url an absolute or relative URL string. Will be encoded with `encodeurl` and set as "Location" header (@see https://github.com/pillarjs/encodeurl).
+ * @param options optional `status`, `contentType`, `value` that will override the default ones. Default `status` is 302, `contentType` is "text/html".
+ * @returns redirect server response.
+ */
 export declare function redirect<Status extends RedirectStatus = typeof DEFAULT_REDIRECT_STATUS, ContentType extends string = typeof TEXT_HTML_CONTENT_TYPE, Value = DefaultValue<ContentType>>(url: string, options?: {
     status?: Status;
     contentType?: ContentType;

package/dist/redirect.js

@@ -2,13 +2,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.redirect = void 0;
 const escapeHtml = require("escape-html");
+const encodeUrl = require("encodeurl");
 const REDIRECT_STATUSES = [300, 301, 302, 303, 305, 307, 308];
 const DEFAULT_REDIRECT_STATUS = 302;
 const TEXT_HTML_CONTENT_TYPE = 'text/html';
 const TEXT_PLAIN_CONTENT_TYPE = 'text/plain';
+/**
+ * Use to perform HTTP redirect.
+ * @param url an absolute or relative URL string. Will be encoded with `encodeurl` and set as "Location" header (@see https://github.com/pillarjs/encodeurl).
+ * @param options optional `status`, `contentType`, `value` that will override the default ones. Default `status` is 302, `contentType` is "text/html".
+ * @returns redirect server response.
+ */
 function redirect(url, options = {}) {
     const { status = DEFAULT_REDIRECT_STATUS } = options;
-    const encodedUrl = encodeURI(url);
+    const encodedUrl = encodeUrl(url);
     if (!REDIRECT_STATUSES.includes(status)) {
         throw new Error(`Status "${status}" is not a redirect status.`);
     }

package/dist/redirect.js.map

@@ -1 +1 @@
-{"version":3,"file":"redirect.js","sourceRoot":"","sources":["../src/redirect.ts"],"names":[],"mappings":";;;AACA,0CAA2C;AAE3C,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAU,CAAC;AACvE,MAAM,uBAAuB,GAAG,GAAG,CAAC;AACpC,MAAM,sBAAsB,GAAG,WAAW,CAAC;AAC3C,MAAM,uBAAuB,GAAG,YAAY,CAAC;AAsB7C,SAAgB,QAAQ,CAKtB,GAAW,EACX,UAII,EAAE;IAON,MAAM,EAAE,MAAM,GAAG,uBAAiC,EAAE,GAAG,OAAO,CAAC;IAC/D,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAElC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,WAAW,MAAM,6BAA6B,CAAC,CAAC;KACjE;IACD,MAAM,EACJ,WAAW,GAAG,sBAAqC,EACnD,KAAK,GAAG,uBAAuB,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAqB,EACjF,GAAG,OAAO,CAAC;IAEZ,OAAO;QACL,MAAM;QACN,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;QAC7B,OAAO,EAAE;YACP,QAAQ,EAAE,UAAU;SACrB;KACF,CAAC;AACJ,CAAC;AAnCD,4BAmCC;AAED,SAAS,uBAAuB,CAAC,EAC/B,UAAU,EACV,WAAW,EAIZ;IACC,IAAI,aAAa,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAC,EAAE;QAChE,oGAAoG;QACpG,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;QAC1C,OAAO,2BAA2B,UAAU,KAAK,UAAU,OAAO,CAAC;KACpE;IACD,IAAI,aAAa,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjE,OAAO,kBAAkB,UAAU,GAAG,CAAC;KACxC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,EAAE,WAAW,EAAE,IAAI,EAAyC;IACjF,OAAO,WAAW,KAAK,IAAI,IAAI,WAAW,CAAC,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;AACpE,CAAC"}
+{"version":3,"file":"redirect.js","sourceRoot":"","sources":["../src/redirect.ts"],"names":[],"mappings":";;;AACA,0CAA2C;AAC3C,uCAAwC;AAExC,MAAM,iBAAiB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAU,CAAC;AACvE,MAAM,uBAAuB,GAAG,GAAG,CAAC;AACpC,MAAM,sBAAsB,GAAG,WAAW,CAAC;AAC3C,MAAM,uBAAuB,GAAG,YAAY,CAAC;AAsB7C;;;;;GAKG;AACH,SAAgB,QAAQ,CAKtB,GAAW,EACX,UAII,EAAE;IAON,MAAM,EAAE,MAAM,GAAG,uBAAiC,EAAE,GAAG,OAAO,CAAC;IAC/D,MAAM,UAAU,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAElC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,WAAW,MAAM,6BAA6B,CAAC,CAAC;KACjE;IACD,MAAM,EACJ,WAAW,GAAG,sBAAqC,EACnD,KAAK,GAAG,uBAAuB,CAAC,EAAE,UAAU,EAAE,WAAW,EAAE,CAAqB,EACjF,GAAG,OAAO,CAAC;IAEZ,OAAO;QACL,MAAM;QACN,KAAK,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE;QAC7B,OAAO,EAAE;YACP,QAAQ,EAAE,UAAU;SACrB;KACF,CAAC;AACJ,CAAC;AAnCD,4BAmCC;AAED,SAAS,uBAAuB,CAAC,EAC/B,UAAU,EACV,WAAW,EAIZ;IACC,IAAI,aAAa,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAC,EAAE;QAChE,oGAAoG;QACpG,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;QAC1C,OAAO,2BAA2B,UAAU,KAAK,UAAU,OAAO,CAAC;KACpE;IACD,IAAI,aAAa,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,EAAE;QACjE,OAAO,kBAAkB,UAAU,GAAG,CAAC;KACxC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,aAAa,CAAC,EAAE,WAAW,EAAE,IAAI,EAAyC;IACjF,OAAO,WAAW,KAAK,IAAI,IAAI,WAAW,CAAC,UAAU,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;AACpE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartlyio/oats-runtime",
-  "version": "4.3.1",
+  "version": "4.3.2",
   "license": "MIT",
   "description": "Runtime for Oats a Openapi3 based generator for typescript aware servers and clients",
   "private": false,
@@ -23,7 +23,9 @@
   },
   "dependencies": {
     "@smartlyio/safe-navigation": "^5.0.1",
+    "@types/encodeurl": "1.0.0",
     "@types/escape-html": "1.0.1",
+    "encodeurl": "1.0.2",
     "escape-html": "1.0.3",
     "lodash": "^4.17.20"
   },
@@ -49,5 +51,5 @@
     "tsconfig-paths": "3.14.1",
     "typescript": "4.6.3"
   },
-  "gitHead": "e608b6e9286423d95792b9fe3a4e7158fa3f7d9b"
+  "gitHead": "8e6ff688c82fb559b853f01041343441be32e15a"
 }

package/src/redirect.ts

@@ -1,5 +1,6 @@
 import type { Response } from './server';
 import escapeHtml = require('escape-html');
+import encodeUrl = require('encodeurl');
 
 const REDIRECT_STATUSES = [300, 301, 302, 303, 305, 307, 308] as const;
 const DEFAULT_REDIRECT_STATUS = 302;
@@ -26,6 +27,12 @@ type DefaultValue<ContentType extends string> = ContentType extends
  */
 type PreventGenericDefaultValueOverride<T> = [T][T extends unknown ? 0 : never];
 
+/**
+ * Use to perform HTTP redirect.
+ * @param url an absolute or relative URL string. Will be encoded with `encodeurl` and set as "Location" header (@see https://github.com/pillarjs/encodeurl).
+ * @param options optional `status`, `contentType`, `value` that will override the default ones. Default `status` is 302, `contentType` is "text/html".
+ * @returns redirect server response.
+ */
 export function redirect<
   Status extends RedirectStatus = typeof DEFAULT_REDIRECT_STATUS,
   ContentType extends string = typeof TEXT_HTML_CONTENT_TYPE,
@@ -44,7 +51,7 @@ export function redirect<
   { Location: string }
 > {
   const { status = DEFAULT_REDIRECT_STATUS as Status } = options;
-  const encodedUrl = encodeURI(url);
+  const encodedUrl = encodeUrl(url);
 
   if (!REDIRECT_STATUSES.includes(status)) {
     throw new Error(`Status "${status}" is not a redirect status.`);