js-routes 2.3.5 → 2.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5340711dfd4078cf7c63d618dbd4957f58fd79d0e3f82ca6b1f6a0b6cd0381a5
-  data.tar.gz: 00a7ae1424f6e61211f7bd0cc26f86542c3054c8d17ae062f026da2a44da7b32
+  metadata.gz: 8e1323cccad426e331d7f99923e967b09d06e028ec3f2665798dad91ff5ce582
+  data.tar.gz: 4ddb07ef468133b25d7ace1313b948f689a77a1c576e3102e88ff2b87f82a5c5
 SHA512:
-  metadata.gz: '00963c11a5f95f269924111950e8a3f9b9c9fc9347d3a52e745b191de8d6550d9d2d518d32088b3e98eec2e3fe8022f585523b99c71460be2d234f02c0f02cef'
-  data.tar.gz: 452e998d9c85ce6a7061cf002cd8cac7e77538fd71353fb3ea359f500060628a521dbc3f2e36b0dfdf43d3a4252d59566872914901e5e931ce55c19dca45231a
+  metadata.gz: 9840b6fa125bec3de173ce942e7daae8cac4de026d424d70a4bb82d67d9cf075d050c182c02fadef9d5c64a989599dd3a0cbc59197652d836b44f3452588bad2
+  data.tar.gz: 449669e3e6719f2c1ee22bd1b6b7bfaa34ca2821f7d6050563d76f43781c8e4efc8c1d6e986443007451550002abad649e6dc6bdf10629ba683be3ccf3f3f1ee

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## Pending
+
+## [2.3.7]
+
+* Obfuscate assignment to module.exports in order to prevent warnings in javascript bundlers, like Vite. Fixes [#337](https://github.com/railsware/js-routes/issues/337).
+
+## [2.3.6]
+
+* Fixed serialization of empty `Array` and empty `Hash`. Fixes [#336](https://github.com/railsware/js-routes/issues/336).
+
+``` javascript
+blog_path({filters: {}, columns: []}) // => /blog
+```
+
+* Support new Rails 8.1 nil parameter serialization.
+  [Rails #53962](https://github.com/rails/rails/pull/53962)
+  JsRoutes consistently follows current rails version behavior:
+
+``` ruby
+root_path(hello: nil)
+  # 8.0 => "/?hello="
+  # 8.1 => "/?hello"
+```
+
 ## [2.3.5]
 
 * Support `bigint` route parameter

data/Readme.md

@@ -117,15 +117,13 @@ Create webpack ERB config `config/webpack/loaders/erb.js`:
 
 ``` javascript
 module.exports = {
-  module: {
-    rules: [
-      {
-        test: /\.erb$/,
-        enforce: 'pre',
-        loader: 'rails-erb-loader'
-      },
-    ]
-  }
+  rules: [
+    {
+      test: /\.erb$/,
+      enforce: "pre",
+      loader: "rails-erb-loader",
+    },
+  ],
 };
 ```
 

data/lib/js_routes/instance.rb

@@ -43,7 +43,12 @@ module JsRoutes
           raise("Missing key #{key} in JS template")
         end
       end
-      banner + content + routes_export + prevent_types_export
+      unless @configuration.module_type == "NIL"
+        banner + content + routes_export + prevent_types_export
+      else
+        content.sub('"use strict";', "")
+      end
+
     end
 
     sig { returns(String) }
@@ -94,6 +99,7 @@ module JsRoutes
       {
         'ROUTES_OBJECT'       => routes_object,
         'DEPRECATED_FALSE_PARAMETER_BEHAVIOR' => Rails.version < '7.0.0',
+        'DEPRECATED_NIL_QUERY_PARAMETER_BEHAVIOR' => Rails.version < '8.1.0',
         'DEFAULT_URL_OPTIONS' => json(@configuration.default_url_options),
         'PREFIX'              => json(prefix),
         'SPECIAL_OPTIONS_KEY' => json(@configuration.special_options_key),

data/lib/js_routes/route.rb

@@ -55,7 +55,7 @@ module JsRoutes
       if @configuration.dts?
         definition_body
       else
-        # For tree-shaking ESM, add a #__PURE__ comment informing Webpack/minifiers that the call to `__jsr.r`
+        # For tree-shaking ESM, add a #__PURE__ comment informing js bundlers that the call to `__jsr.r`
         # has no side-effects (e.g. modifying global variables) and is safe to remove when unused.
         # https://webpack.js.org/guides/tree-shaking/#clarifying-tree-shaking-and-sidyeeffects
         pure_comment = @configuration.esm? ? '/*#__PURE__*/ ' : ''

data/lib/js_routes/version.rb

@@ -1,4 +1,4 @@
 # typed: strict
 module JsRoutes
-  VERSION = "2.3.5"
+  VERSION = "2.3.7"
 end

data/lib/routes.d.ts

@@ -1,38 +1,38 @@
-declare type Optional<T> = {
+type Optional<T> = {
     [P in keyof T]?: T[P] | null;
 };
-declare type Collection<T> = Record<string, T>;
-declare type BaseRouteParameter = string | boolean | Date | number | bigint;
-declare type MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
-declare type ModelRouteParameter = {
+type Collection<T> = Record<string, T>;
+type BaseRouteParameter = string | boolean | Date | number | bigint;
+type MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
+type ModelRouteParameter = {
     id: MethodRouteParameter;
 } | {
     to_param: MethodRouteParameter;
 } | {
     toParam: MethodRouteParameter;
 };
-declare type RequiredRouteParameter = BaseRouteParameter | ModelRouteParameter;
-declare type OptionalRouteParameter = undefined | null | RequiredRouteParameter;
-declare type QueryRouteParameter = OptionalRouteParameter | QueryRouteParameter[] | {
+type RequiredRouteParameter = BaseRouteParameter | ModelRouteParameter;
+type OptionalRouteParameter = undefined | null | RequiredRouteParameter;
+type QueryRouteParameter = OptionalRouteParameter | QueryRouteParameter[] | {
     [k: string]: QueryRouteParameter;
 };
-declare type RouteParameters = Collection<QueryRouteParameter>;
-declare type Serializable = Collection<unknown>;
-declare type Serializer = (value: Serializable) => string;
-declare type RouteHelperExtras = {
+type RouteParameters = Collection<QueryRouteParameter>;
+type Serializable = Collection<unknown>;
+type Serializer = (value: Serializable) => string;
+type RouteHelperExtras = {
     requiredParams(): string[];
     toString(): string;
 };
-declare type RequiredParameters<T extends number> = T extends 1 ? [RequiredRouteParameter] : T extends 2 ? [RequiredRouteParameter, RequiredRouteParameter] : T extends 3 ? [RequiredRouteParameter, RequiredRouteParameter, RequiredRouteParameter] : T extends 4 ? [
+type RequiredParameters<T extends number> = T extends 1 ? [RequiredRouteParameter] : T extends 2 ? [RequiredRouteParameter, RequiredRouteParameter] : T extends 3 ? [RequiredRouteParameter, RequiredRouteParameter, RequiredRouteParameter] : T extends 4 ? [
     RequiredRouteParameter,
     RequiredRouteParameter,
     RequiredRouteParameter,
     RequiredRouteParameter
 ] : RequiredRouteParameter[];
-declare type RouteHelperOptions = RouteOptions & Collection<OptionalRouteParameter>;
-declare type RouteHelper<T extends number = number> = ((...args: [...RequiredParameters<T>, RouteHelperOptions]) => string) & RouteHelperExtras;
-declare type RouteHelpers = Collection<RouteHelper>;
-declare type Configuration = {
+type RouteHelperOptions = RouteOptions & Collection<OptionalRouteParameter>;
+type RouteHelper<T extends number = number> = ((...args: [...RequiredParameters<T>, RouteHelperOptions]) => string) & RouteHelperExtras;
+type RouteHelpers = Collection<RouteHelper>;
+type Configuration = {
     prefix: string;
     default_url_options: RouteParameters;
     special_options_key: string;
@@ -43,7 +43,7 @@ interface RouterExposedMethods {
     configure(arg: Partial<Configuration>): Configuration;
     serialize: Serializer;
 }
-declare type KeywordUrlOptions = Optional<{
+type KeywordUrlOptions = Optional<{
     host: string;
     protocol: string;
     subdomain: string;
@@ -53,15 +53,16 @@ declare type KeywordUrlOptions = Optional<{
     script_name: string;
     params: RouteParameters;
 }>;
-declare type RouteOptions = KeywordUrlOptions & RouteParameters;
-declare type PartsTable = Collection<{
+type RouteOptions = KeywordUrlOptions & RouteParameters;
+type PartsTable = Collection<{
     r?: boolean;
     d?: OptionalRouteParameter;
 }>;
-declare type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "DTS" | "NIL";
+type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "DTS" | "NIL";
 declare const RubyVariables: {
     PREFIX: string;
     DEPRECATED_FALSE_PARAMETER_BEHAVIOR: boolean;
+    DEPRECATED_NIL_QUERY_PARAMETER_BEHAVIOR: boolean;
     SPECIAL_OPTIONS_KEY: string;
     DEFAULT_URL_OPTIONS: RouteParameters;
     SERIALIZER: Serializer;

data/lib/routes.js

@@ -1,7 +1,5 @@
-// eslint-disable-next-line
-RubyVariables.WRAPPER(
-// eslint-disable-next-line
-() => {
+"use strict";
+RubyVariables.WRAPPER(() => {
     const hasProp = (value, key) => Object.prototype.hasOwnProperty.call(value, key);
     let NodeTypes;
     (function (NodeTypes) {
@@ -27,7 +25,12 @@ RubyVariables.WRAPPER(
         CJS: {
             define(routes) {
                 if (module) {
-                    module.exports = routes;
+                    // Some javascript processors (like vite/rolldown)
+                    // warn on using module dot exports in an ESM module.
+                    // This just obfuscates that assignment a little so
+                    // users don't get a warning they can't fix.
+                    const _mod = module;
+                    _mod.exports = routes;
                 }
             },
             isSupported() {
@@ -79,7 +82,7 @@ RubyVariables.WRAPPER(
         },
         NIL: {
             define() {
-                // Defined using RubyVariables.WRAPPER
+                // Defined using RubyVariables . WRAPPER
             },
             isSupported() {
                 return true;
@@ -122,9 +125,6 @@ RubyVariables.WRAPPER(
             };
         }
         default_serializer(value, prefix) {
-            if (this.is_nullable(value)) {
-                return "";
-            }
             if (!prefix && !this.is_object(value)) {
                 throw new Error("Url parameters should be a javascript hash");
             }
@@ -140,21 +140,21 @@ RubyVariables.WRAPPER(
                     if (!hasProp(value, key))
                         continue;
                     let prop = value[key];
-                    if (this.is_nullable(prop) && prefix) {
-                        prop = "";
+                    if (prefix) {
+                        key = prefix + "[" + key + "]";
                     }
-                    if (this.is_not_nullable(prop)) {
-                        if (prefix) {
-                            key = prefix + "[" + key + "]";
-                        }
-                        result.push(this.default_serializer(prop, key));
+                    const subvalue = this.default_serializer(prop, key);
+                    if (subvalue.length) {
+                        result.push(subvalue);
                     }
                 }
             }
             else {
-                if (this.is_not_nullable(value)) {
-                    result.push(encodeURIComponent(prefix) + "=" + encodeURIComponent("" + value));
-                }
+                const key = encodeURIComponent(prefix);
+                result.push(this.is_not_nullable(value) ||
+                    RubyVariables.DEPRECATED_NIL_QUERY_PARAMETER_BEHAVIOR
+                    ? key + "=" + encodeURIComponent("" + (value !== null && value !== void 0 ? value : ""))
+                    : key);
             }
             return result.join("&");
         }
@@ -164,8 +164,7 @@ RubyVariables.WRAPPER(
         extract_options(number_of_params, args) {
             const last_el = args[args.length - 1];
             if ((args.length > number_of_params && last_el === 0) ||
-                (this.is_object(last_el) &&
-                    !this.looks_like_serialized_model(last_el))) {
+                (this.is_object(last_el) && !this.looks_like_serialized_model(last_el))) {
                 if (this.is_object(last_el)) {
                     delete last_el[this.configuration.special_options_key];
                 }
@@ -186,8 +185,7 @@ RubyVariables.WRAPPER(
         path_identifier(object) {
             const result = this.unwrap_path_identifier(object);
             return this.is_nullable(result) ||
-                (RubyVariables.DEPRECATED_FALSE_PARAMETER_BEHAVIOR &&
-                    result === false)
+                (RubyVariables.DEPRECATED_FALSE_PARAMETER_BEHAVIOR && result === false)
                 ? ""
                 : "" + result;
         }
@@ -211,7 +209,6 @@ RubyVariables.WRAPPER(
             return this.is_callable(result) ? result.call(object) : result;
         }
         partition_parameters(parts, required_params, default_options, call_arguments) {
-            // eslint-disable-next-line prefer-const
             let { args, options } = this.extract_options(parts.length, call_arguments);
             if (args.length > parts.length) {
                 throw new Error("Too many parameters provided for path");
@@ -516,21 +513,13 @@ RubyVariables.WRAPPER(
     const utils = new UtilsClass();
     // We want this helper name to be short
     const __jsr = {
-        r(parts_table, route_spec, absolute) {
-            return utils.route(parts_table, route_spec, absolute);
-        },
+        r: utils.route.bind(utils),
     };
     return utils.define_module(RubyVariables.MODULE_TYPE, {
         ...__jsr,
-        configure: (config) => {
-            return utils.configure(config);
-        },
-        config: () => {
-            return utils.config();
-        },
-        serialize: (object) => {
-            return utils.serialize(object);
-        },
+        configure: utils.configure.bind(utils),
+        config: utils.config.bind(utils),
+        serialize: utils.serialize.bind(utils),
         ...RubyVariables.ROUTES_OBJECT,
     });
 })();