js-routes 2.3.4 → 2.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8057000afc83b5ce111428c7aec30249f52ef15872db97527757c94fc7faf6d
-  data.tar.gz: f7d4b47f6248278cb53b5cac80807d37aec7a51a1c47f1c4711e1e6bd0d2d3ea
+  metadata.gz: 3b618b5e9e78d0a6ed8878c737c26c84fdc00c9e26ede9bd01329a042818b816
+  data.tar.gz: e86d3fa9a429188ff3d6146ad981cae9ff01f3f2c7113a87dd2fcc601e674c85
 SHA512:
-  metadata.gz: 40c3c12d7d4a37089268aebda4b82d2f5d8944d5c16048394c1e38eda270f82f867faed7b129e4c27295bcf8158e998e42b92b552c015303d965c0e2227b0780
-  data.tar.gz: 0f075f81e3d5c0b3d6ed9315e3a34d34857c9c9bf34f136c6884e95b4ab6c6f37c0ebb4ee767eceba98bad7377bd1f4e0bc5e68019c9179fef32b4a7f57b96ea
+  metadata.gz: 67a230e2e6500fe55d6e7ed408ecf895d386d920383c34f8dd4fa384dad13bc5d7d96f98d960ac4df0aab3658d638f21d208c90cc547c3a042c9856a1ed1047a
+  data.tar.gz: b158b8a4cb4ffa635c63de49e8fd9cb4415938cb21af078f384e36aaf2d90ce5f51661499dbfe4372fd6051e9ebba301bff8c9fd550b354932c5234173429f3a

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## [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
+
+``` typescript
+import {nft_path} from "./routes"
+
+nft_path(123456789012345678901234567890n)
+    // => /nfts/123456789012345678901234567890
+```
+
+* Fix rake task for non-esm modules. [#316](https://github.com/railsware/js-routes/issues/316)
+
 ## [2.3.4]
 
 * Fix deprecator usage in `rake js:routes:typescript` [#327](https://github.com/railsware/js-routes/issues/327)
@@ -118,7 +149,7 @@ end
 
 ## [2.2.1]
 
-* Improve generator to update route files on `assets:precompile` and add them to `.gitignore by default` [#288](https://github.com/railsware/js-routes/issues/288#issuecomment-1012182815)
+* Improve generator to update route files on `assets:precompile` and add them to `.gitignore` by default [#288](https://github.com/railsware/js-routes/issues/288#issuecomment-1012182815)
 
 ## [2.2.0]
 

data/Readme.md

@@ -2,6 +2,8 @@
 
 [![CI](https://github.com/railsware/js-routes/actions/workflows/ci.yml/badge.svg)](https://github.com/railsware/js-routes/actions/workflows/ci.yml)
 
+<img src="/logo.webp" alt="Logo" width="200" height="200">
+
 Generates javascript file that defines all Rails named routes as javascript helpers:
 
 ``` js
@@ -115,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

@@ -94,6 +94,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/version.rb

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

data/lib/js_routes.rb

@@ -37,8 +37,11 @@ module JsRoutes
 
     sig { params(file_name: FileName, typed: T::Boolean, opts: T.untyped).void }
     def generate!(file_name = configuration.file, typed: false, **opts)
-      Instance.new(file: file_name, **opts).generate!
-      definitions!(file_name, **opts) if typed
+      instance = Instance.new(file: file_name, **opts)
+      instance.generate!
+      if typed && instance.configuration.modern?
+        definitions!(file_name, **opts)
+      end
     end
 
     sig { params(file_name: FileName, opts: T.untyped).void }

data/lib/routes.d.ts

@@ -2,7 +2,7 @@ declare type Optional<T> = {
     [P in keyof T]?: T[P] | null;
 };
 declare type Collection<T> = Record<string, T>;
-declare type BaseRouteParameter = string | boolean | Date | number;
+declare type BaseRouteParameter = string | boolean | Date | number | bigint;
 declare type MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
 declare type ModelRouteParameter = {
     id: MethodRouteParameter;
@@ -62,6 +62,7 @@ declare 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

@@ -122,9 +122,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 +137,22 @@ 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));
-                }
+                result.push(this.is_not_nullable(value) ||
+                    RubyVariables.DEPRECATED_NIL_QUERY_PARAMETER_BEHAVIOR
+                    ? encodeURIComponent(prefix) +
+                        "=" +
+                        encodeURIComponent("" + (value !== null && value !== void 0 ? value : ""))
+                    : encodeURIComponent(prefix));
             }
             return result.join("&");
         }

data/lib/routes.ts

@@ -1,7 +1,7 @@
 type Optional<T> = { [P in keyof T]?: T[P] | null };
 type Collection<T> = Record<string, T>;
 
-type BaseRouteParameter = string | boolean | Date | number;
+type BaseRouteParameter = string | boolean | Date | number | bigint;
 type MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
 type ModelRouteParameter =
   | { id: MethodRouteParameter }
@@ -79,6 +79,7 @@ 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;
@@ -246,9 +247,6 @@ RubyVariables.WRAPPER(
       };
 
       default_serializer(value: unknown, prefix?: string | null): string {
-        if (this.is_nullable(value)) {
-          return "";
-        }
         if (!prefix && !this.is_object(value)) {
           throw new Error("Url parameters should be a javascript hash");
         }
@@ -262,22 +260,23 @@ RubyVariables.WRAPPER(
           for (let key in value) {
             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)
-            );
-          }
+          result.push(
+            this.is_not_nullable(value) ||
+              RubyVariables.DEPRECATED_NIL_QUERY_PARAMETER_BEHAVIOR
+              ? encodeURIComponent(prefix) +
+                  "=" +
+                  encodeURIComponent("" + (value ?? ""))
+              : encodeURIComponent(prefix)
+          );
         }
         return result.join("&");
       }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.3.6
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2025-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -144,9 +144,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/railsware/js-routes/issues
-  changelog_uri: https://github.com/railsware/js-routes/blob/v2.3.4/CHANGELOG.md
+  changelog_uri: https://github.com/railsware/js-routes/blob/v2.3.6/CHANGELOG.md
   documentation_uri: https://github.com/railsware/js-routes
-  source_code_uri: https://github.com/railsware/js-routes/tree/v2.3.4/activerecord
+  source_code_uri: https://github.com/railsware/js-routes/tree/v2.3.6
   rubygems_mfa_required: 'true'
   github_repo: ssh://github.com/railsware/js-routes
 post_install_message: