js-routes 2.2.10 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f69479723e452f1b4ed09bf940b3150ad45430b5c601f966f05a082bce0a9494
-  data.tar.gz: bd47ceb7b1cba241262b8308e913f7d87aef6304d93d9185026e70dd4980487f
+  metadata.gz: 97421ede18a16a1cb38ede32268ea60e79dc3aeee2dbe419cbbc4f117848cebb
+  data.tar.gz: d65a56e1026ef6551a7e0c30f90278245dfed8b4ceca460c285b16855586709c
 SHA512:
-  metadata.gz: 4f67b2ccc88195647ea7c694f935848aad52ddd9e46ac1a766df0c29b7e123a147169deb5b8207c8d3a598fcf0c0ba01f98b0d24ee30b326737200f02f2f8235
-  data.tar.gz: 9aad6d181099b3fdd7ada0facf1269e08669cd1181f94d3039f0e13f8bf2bc5a44172e13843fec5a8317b4c99e1eee6a2de2343e34fe6c3cddebb7a63f9608fb
+  metadata.gz: 13c8299991c8821aff0aa09f4b90ce3a38a9881b780688a6aabadf4871ab79948a095feb0fc9c76b4cc51c84f00aa758f5276838234e963efa1bb641db526984
+  data.tar.gz: 651ae1108a3845a1b948c0b9a1bb9475a2374d6178bd0cf35a7da2dca990081b2bfd40fb2beb92301a4efa3cdef143e83e04a7c39afb7394a685383d9a6b8a91

data/CHANGELOG.md

@@ -1,12 +1,24 @@
 # Changelog
 
-## master
+## v2.3.1
+
+* Add timestamp on when routes.js was generated into banner.
+* Fix application specified directly without proc. [#323](https://github.com/railsware/js-routes/issues/323)
+* Support `optional_definition_params` option. See [Related Docs](./Readme.md#optional-definition-params).
+
+## v2.3.0
+
+* Drop support of Rails 4.x
+* Fix support of shakapacker [#321](https://github.com/railsware/js-routes/issues/321).
+* Fix support for Rails 8 [#319](https://github.com/railsware/js-routes/issues/319)
+* Deprecated `rake js:routes:typescript`.
+  `rake js:routes` now automatically detects if types support can be used on not.
 
 ## v2.2.10
 
 * Remove sorbet files from repo
 * Clearly define files included in gem
-* Fix Middleware and Middleware generator bugs [#316](https://github.com/railsware/js-routes/issue/316)
+* Fix Middleware and Middleware generator bugs [#316](https://github.com/railsware/js-routes/issues/316)
 * Remove empty object linter warning on DTS module
 * Generators: Add `.ts` extension when searching for main JS file of the project
 
@@ -14,7 +26,8 @@
 
 * Fix middleware error for non-modern setup.
 * Added [Sorbet](https://sorbet.org/) method signatures.
-* Always use DTS module type when calling JsRoutes.definitions or .definitions!. [#313](https://github.com/railsware/js-routes/issues/313)
+* Always use DTS module type when calling JsRoutes.definitions or .definitions!.
+  [#313](https://github.com/railsware/js-routes/issues/313)
 
 ## v2.2.8
 

data/Readme.md

@@ -2,7 +2,16 @@
 
 [![CI](https://github.com/railsware/js-routes/actions/workflows/ci.yml/badge.svg)](https://github.com/railsware/js-routes/actions/workflows/ci.yml)
 
-Generates javascript file that defines all Rails named routes as javascript helpers
+Generates javascript file that defines all Rails named routes as javascript helpers:
+
+``` js
+import { root_path, api_user_path } from './routes';
+
+root_path() # => /
+api_user_path(25, include_profile: true, format: 'json') // => /api/users/25.json?include_profile=true
+```
+
+[More Examples](#usage)
 
 ## Intallation
 
@@ -33,8 +42,8 @@ There are several possible ways to setup JsRoutes:
 
 ### Quick Start
 
-Setup [Rack Middleware](https://guides.rubyonrails.org/rails_on_rack.html#action-dispatcher-middleware-stack) 
-to automatically generate and maintain `routes.js` file and corresponding 
+Setup [Rack Middleware](https://guides.rubyonrails.org/rails_on_rack.html#action-dispatcher-middleware-stack)
+to automatically generate and maintain `routes.js` file and corresponding
 [Typescript definitions](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-d-ts.html) `routes.d.ts`:
 
 #### Use a Generator
@@ -61,13 +70,12 @@ import {post_path} from '../routes';
 alert(post_path(1))
 ```
 
-Upgrade js building process to update js-routes files in `Rakefile`: 
+Upgrade js building process to update js-routes files in `Rakefile`:
 
 ``` ruby
-task "javascript:build" => "js:routes:typescript"
+task "javascript:build" => "js:routes"
 # For setups without jsbundling-rails
-task "assets:precompile" => "js:routes:typescript"
-
+task "assets:precompile" => "js:routes"
 ```
 
 Add js-routes files to `.gitignore`:
@@ -227,7 +235,7 @@ JsRoutes.definitions! # to output to file
 JsRoutes.definitions # to output to string
 ```
 
-Even more advanced setups can be achieved by setting `module_type` to `DTS` inside [configuration](#module_type) 
+Even more advanced setups can be achieved by setting `module_type` to `DTS` inside [configuration](#module_type)
 which will cause any `JsRoutes` instance to generate defintions instead of routes themselves.
 
 <div id="sprockets"></div>
@@ -316,9 +324,13 @@ Options to configure JavaScript file generator. These options are only available
   * Sample route call when option is set to true: `users() // => /users`
 * `application` - a key to specify which rails engine you want to generate routes too.
   * This option allows to only generate routes for a specific rails engine, that is mounted into routes instead of all Rails app routes
-  * Default: `Rails.application`
+  * It is recommended to wrap the value with `lambda`. This will reduce the reliance on order during initialization your application.
+  * Default: `-> { Rails.application }`
 * `file` - a file location where generated routes are stored
   * Default: `app/javascript/routes.js` if setup with Webpacker, otherwise `app/assets/javascripts/routes.js` if setup with Sprockets.
+* `optional_definition_params` - make all route paramters in definition optional
+  * See [related compatibility issue](#optional-definition-params)
+  * Default: `false`
 
 <div id="formatter-options"></div>
 
@@ -348,35 +360,35 @@ Configuration above will create a nice javascript file with `Routes` object that
 ``` js
 import {
   user_path, user_project_path, company_path
-} as Routes from 'routes';
+} from 'routes';
 
-users_path() 
+users_path()
   // => "/users"
 
-user_path(1) 
+user_path(1)
   // => "/users/1"
-  
-user_path(1, {format: 'json'}) 
+
+user_path(1, {format: 'json'})
   // => "/users/1.json"
 
-user_path(1, {anchor: 'profile'}) 
+user_path(1, {anchor: 'profile'})
   // => "/users/1#profile"
 
-new_user_project_path(1, {format: 'json'}) 
+new_user_project_path(1, {format: 'json'})
   // => "/users/1/projects/new.json"
 
-user_project_path(1,2, {q: 'hello', custom: true}) 
+user_project_path(1,2, {q: 'hello', custom: true})
   // => "/users/1/projects/2?q=hello&custom=true"
 
-user_project_path(1,2, {hello: ['world', 'mars']}) 
+user_project_path(1,2, {hello: ['world', 'mars']})
   // => "/users/1/projects/2?hello%5B%5D=world&hello%5B%5D=mars"
 
 var google = {id: 1, name: "Google"};
-company_path(google) 
+company_path(google)
   // => "/companies/1"
 
 var google = {id: 1, name: "Google", to_param: "google"};
-company_path(google) 
+company_path(google)
   // => "/companies/google"
 ```
 
@@ -419,14 +431,63 @@ In this case you would need to pass a special key to help:
 ``` js
 import {company_project_path} from '../routes'
 
-company_project_path({company_id: 1, id: 2}) // => Not enough parameters
-company_project_path({company_id: 1, id: 2, _options: true}) // => "/companies/1/projects/2"
+company_project_path({company_id: 1, id: 2})
+    // => Not enough parameters
+company_project_path({company_id: 1, id: 2, _options: true})
+    // => "/companies/1/projects/2"
+```
+
+Use `special_options_key` to configure the `_options` parameter name.
+
+<div id="optional-definition-params"></div>
+
+### Rails required parameters specified as optional
+
+Rails is very flexible on how route parameters can be specified.
+All of the following calls will make the same result:
+
+``` ruby
+# Given route
+# /inboxes/:inbox_id/messages/:message_id/attachments/:id
+# every call below returns:
+# => "/inboxes/1/messages/2/attachments/3"
+
+inbox_message_attachment_path(1, 2, 3)
+inbox_message_attachment_path(1, 2, id: 3)
+inbox_message_attachment_path(1, message_id: 2, id: 3)
+inbox_message_attachment_path(inbox_id: 1, message_id: 2, id: 3)
+
+# including these mad versions
+inbox_message_attachment_path(2, inbox_id: 1, id: 3)
+inbox_message_attachment_path(1, 3, message_id: 2)
+inbox_message_attachment_path(3, inbox_id: 1, message_id: 2)
 ```
 
+While all of these methods are supported by JsRoutes, it is impossible to support them in `DTS` type definitions.
+If you are using routes like this, use the following configuration that will prevent required parameters presence to be validated by definition:
+
+``` ruby
+JsRoutes.configure do |c|
+  c.optional_definition_params = true
+end
+```
+
+This will enforce the following route signature:
+
+``` typescript
+export const inbox_message_attachment_path: ((
+  inbox_id?: RequiredRouteParameter,
+  message_id?: RequiredRouteParameter,
+  id?: RequiredRouteParameter,
+  options?: RouteOptions
+) => string) & RouteHelperExtras;
+```
+
+That will make every call above valid.
 
 ## What about security?
 
-JsRoutes itself does not have security holes. 
+JsRoutes itself does not have security holes.
 It makes URLs without access protection more reachable by potential attacker.
 If that is an issue for you, you may use one of the following solutions:
 
@@ -459,15 +520,13 @@ console.log(routes.inbox_path); // OK, only `inbox_path` is included in the bund
 console.log(Object.keys(routes)); // forces bundler to include all exports, breaking tree shaking
 ```
 
-### Exclude option
+### Exclude/Include options
 
 Split your routes into multiple files related to each section of your website like:
 
-``` javascript
-// admin-routes.js.erb
-<%= JsRoutes.generate(include: /^admin_/) %>
-// app-routes.js.erb
-<%= JsRoutes.generate(exclude: /^admin_/) %>
+``` ruby
+JsRoutes.generate!('app/javascript/admin-routes.js', include: /^admin_/) %>
+JsRoutes.generate!('app/javascript/app-routes.js', exclude: /^admin_/) %>
 ```
 
 ## Advantages over alternatives
@@ -475,17 +534,9 @@ Split your routes into multiple files related to each section of your website li
 There are some alternatives available. Most of them has only basic feature and don't reach the level of quality I accept.
 Advantages of this one are:
 
-* Rails 4,5,6 support
+* Actively maintained
 * [ESM Tree shaking](https://webpack.js.org/guides/tree-shaking/) support
 * Rich options set
 * Full rails compatibility
 * Support Rails `#to_param` convention for seo optimized paths
 * Well tested
-
-#### Thanks to [contributors](https://github.com/railsware/js-routes/contributors)
-
-#### Have fun
-
-
-## License
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Frailsware%2Fjs-routes.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Frailsware%2Fjs-routes?ref=badge_large)

data/lib/js_routes/configuration.rb

@@ -1,6 +1,8 @@
 # typed: strict
+
 require "pathname"
 require "js_routes/types"
+require 'js_routes/utils'
 
 module JsRoutes
   class Configuration
@@ -35,6 +37,8 @@ module JsRoutes
     attr_accessor :documentation
     sig { returns(T.nilable(String)) }
     attr_accessor :module_type
+    sig { returns(T::Boolean) }
+    attr_accessor :optional_definition_params
 
     sig {params(attributes: T.nilable(Options)).void }
     def initialize(attributes = nil)
@@ -52,6 +56,7 @@ module JsRoutes
       @application = T.let(-> { Rails.application }, ApplicationCaller)
       @module_type = T.let('ESM', T.nilable(String))
       @documentation = T.let(true, T::Boolean)
+      @optional_definition_params = T.let(false, T::Boolean)
 
       return unless attributes
       assign(attributes)
@@ -114,14 +119,14 @@ module JsRoutes
 
     sig { returns(Pathname) }
     def output_file
-      webpacker_dir = defined?(::Webpacker) ?
-        T.unsafe(::Webpacker).config.source_path :
-        pathname('app', 'javascript')
+      shakapacker = JsRoutes::Utils.shakapacker
+      shakapacker_dir = shakapacker ?
+        shakapacker.config.source_path : pathname('app', 'javascript')
       sprockets_dir = pathname('app','assets','javascripts')
       file_name = file || default_file_name
       sprockets_file = sprockets_dir.join(file_name)
-      webpacker_file = webpacker_dir.join(file_name)
-      !Dir.exist?(webpacker_dir) && defined?(::Sprockets) ? sprockets_file : webpacker_file
+      webpacker_file = shakapacker_dir.join(file_name)
+      !Dir.exist?(shakapacker_dir) && defined?(::Sprockets) ? sprockets_file : webpacker_file
     end
 
     protected

data/lib/js_routes/generators/middleware.rb

@@ -10,8 +10,7 @@ class JsRoutes::Generators::Middleware < JsRoutes::Generators::Base
     if path = application_js_path
       inject_into_file path, pack_content
     end
-    JsRoutes.generate!
-    JsRoutes.definitions! if JsRoutes.configuration.modern?
+    JsRoutes.generate!(typed: true)
   end
 
   protected
@@ -34,10 +33,9 @@ alert(`JsRoutes installed.\\nYour root path is ${root_path()}`)
 
   def rakefile_content
     enhanced_task = depends_on_js_bundling? ? "javascript:build" : "assets:precompile"
-    dependency_task = JsRoutes.configuration.modern? ? "js:routes:typescript" : 'js:routes'
     <<-RB
 # Update js-routes file before javascript build
-task "#{enhanced_task}" => "#{dependency_task}"
+task "#{enhanced_task}" => "js:routes"
     RB
   end
 

data/lib/js_routes/generators/webpacker.rb

@@ -1,11 +1,12 @@
 require "rails/generators"
+require 'js_routes/utils'
 
 class JsRoutes::Generators::Webpacker < Rails::Generators::Base
 
   def create_webpack
     copy_file "initializer.rb", "config/initializers/js_routes.rb"
     copy_file "erb.js", "config/webpack/loaders/erb.js"
-    copy_file "routes.js.erb", "#{Webpacker.config.source_path}/routes.js.erb"
+    copy_file "routes.js.erb", "#{JsRoutes::Utils.shakapacker.config.source_path}/routes.js.erb"
     inject_into_file "config/webpack/environment.js", loader_content
     if path = application_js_path
       inject_into_file path, pack_content

data/lib/js_routes/instance.rb

@@ -24,9 +24,16 @@ module JsRoutes
     sig {returns(String)}
     def generate
       # Ensure routes are loaded. If they're not, load them.
+
       application = T.unsafe(self.application)
-      if named_routes.empty? && application.respond_to?(:reload_routes!, true)
-        application.reload_routes!
+      if named_routes.empty?
+        if application.is_a?(Rails::Application)
+          if Rails.version >= "8.0.0"
+            application.reload_routes_unless_loaded
+          else
+            application.reload_routes!
+          end
+        end
       end
       content = File.read(@configuration.source_file)
 
@@ -69,15 +76,14 @@ module JsRoutes
 
     sig { returns(T::Hash[String, String]) }
     def js_variables
-      version = Rails.version
       prefix = @configuration.prefix
       prefix = prefix.call if prefix.is_a?(Proc)
       {
         'GEM_VERSION'         => JsRoutes::VERSION,
+        'TIMESTAMP'           => Time.now.to_s,
         'ROUTES_OBJECT'       => routes_object,
         'RAILS_VERSION'       => ::Rails.version,
-        'DEPRECATED_GLOBBING_BEHAVIOR' => version >= '4.0.0' && version < '4.1.0',
-        'DEPRECATED_FALSE_PARAMETER_BEHAVIOR' => version < '7.0.0',
+        'DEPRECATED_FALSE_PARAMETER_BEHAVIOR' => Rails.version < '7.0.0',
         'APP_CLASS'           => application.class.to_s,
         'DEFAULT_URL_OPTIONS' => json(@configuration.default_url_options),
         'PREFIX'              => json(prefix),
@@ -111,7 +117,8 @@ module JsRoutes
 
     sig { returns(Application) }
     def application
-      @configuration.application.call
+      app = @configuration.application
+      app.is_a?(Proc) ? app.call : app
     end
 
     sig { params(value: T.untyped).returns(String) }
@@ -178,8 +185,8 @@ export {};
     sig { params(route: JourneyRoute).returns(T::Array[StringArray]) }
     def mounted_app_routes(route)
       rails_engine_app = T.unsafe(app_from_route(route))
-      if rails_engine_app.respond_to?(:superclass) &&
-          rails_engine_app.superclass == Rails::Engine && !route.path.anchored
+      if rails_engine_app.is_a?(Class) &&
+          rails_engine_app < Rails::Engine && !route.path.anchored
         rails_engine_app.routes.named_routes.flat_map do |_, engine_route|
           route_helpers_if_match(engine_route, route)
         end
@@ -191,9 +198,9 @@ export {};
     sig { params(route: JourneyRoute).returns(T.untyped) }
     def app_from_route(route)
       app = route.app
-      # rails engine in Rails 4.2 use additional
+      # Rails Engine can use additional
       # ActionDispatch::Routing::Mapper::Constraints, which contain app
-      if app.respond_to?(:app) && app.respond_to?(:constraints)
+      if app.is_a?(ActionDispatch::Routing::Mapper::Constraints)
         app.app
       else
         app

data/lib/js_routes/middleware.rb

@@ -39,8 +39,7 @@ module JsRoutes
 
     sig { void }
     def regenerate
-      JsRoutes.generate!
-      JsRoutes.definitions! if JsRoutes.configuration.modern?
+      JsRoutes.generate!(typed: true)
     end
 
     sig { returns(T.nilable(Time)) }

data/lib/js_routes/route.rb

@@ -66,7 +66,8 @@ module JsRoutes
     sig { returns(String) }
     def definition_body
       options_type = optional_parts_type ? "#{optional_parts_type} & RouteOptions" : "RouteOptions"
-      args = required_parts.map{|p| "#{apply_case(p)}: RequiredRouteParameter"}
+      predicate = @configuration.optional_definition_params ? '?' : ''
+      args = required_parts.map{|p| "#{apply_case(p)}#{predicate}: RequiredRouteParameter"}
       args << "options?: #{options_type}"
       "((\n#{args.join(",\n").indent(2)}\n) => string) & RouteHelperExtras"
     end
@@ -194,7 +195,9 @@ JS
     sig { params(spec: SpecNode, parent_spec: T.nilable(RouteSpec)).returns(T.nilable(T.any(UntypedArray, String))) }
     def serialize(spec, parent_spec=nil)
       return nil unless spec
-      # Rails 4 globbing requires * removal
+      # Removing special character prefix from route variable name
+      # * for globbing
+      # : for common parameter
       return spec.tr(':*', '') if spec.is_a?(String)
 
       result = serialize_spec(spec, parent_spec)

data/lib/js_routes/types.rb

@@ -17,7 +17,7 @@ module JsRoutes
     JourneyRoute = T.type_alias{ActionDispatch::Journey::Route}
     RouteSpec = T.type_alias {T.untyped}
     Application = T.type_alias { T.any(T::Class[Rails::Engine], Rails::Application) }
-    ApplicationCaller = T.type_alias { T.proc.returns(Application) }
+    ApplicationCaller = T.type_alias { T.any(Application, T.proc.returns(Application)) }
     Clusivity = T.type_alias { T.any(Regexp, T::Array[Regexp]) }
     FileName = T.type_alias { T.any(String, Pathname, NilClass) }
     ConfigurationBlock = T.type_alias { T.proc.params(arg0: JsRoutes::Configuration).void }

data/lib/js_routes/utils.rb

@@ -0,0 +1,18 @@
+# typed: strict
+
+module JsRoutes
+  module Utils
+    extend T::Sig
+    sig {returns(T.untyped)}
+    def self.shakapacker
+      if defined?(::Shakapacker)
+        ::Shakapacker
+      elsif defined?(::Webpacker)
+        ::Webpacker
+      else
+        nil
+      end
+    end
+  end
+
+end

data/lib/js_routes/version.rb

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

data/lib/js_routes.rb

@@ -34,9 +34,10 @@ module JsRoutes
       Instance.new(**opts).generate
     end
 
-    sig { params(file_name: FileName, opts: T.untyped).void }
-    def generate!(file_name = configuration.file, **opts)
+    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
     end
 
     sig { params(file_name: FileName, opts: T.untyped).void }
@@ -46,12 +47,14 @@ module JsRoutes
 
     sig { params(opts: T.untyped).returns(String) }
     def definitions(**opts)
-      generate(**opts, module_type: 'DTS',)
+      generate(**opts, module_type: 'DTS')
     end
 
     sig { params(file_name: FileName, opts: T.untyped).void }
     def definitions!(file_name = nil, **opts)
-      file_name ||= configuration.file&.sub(%r{(\.d)?\.(j|t)s\Z}, ".d.ts")
+      file_name ||= configuration.file
+
+      file_name = file_name&.sub(%r{(\.d)?\.(j|t)s\Z}, ".d.ts")
       generate!(file_name, **opts, module_type: 'DTS')
     end
 

data/lib/routes.d.ts

@@ -1,10 +1,11 @@
 /**
- * File generated by js-routes RubyVariables.GEM_VERSION
+ * File generated by js-routes RubyVariables.GEM_VERSION on RubyVariables.TIMESTAMP
  * Based on Rails RubyVariables.RAILS_VERSION routes of RubyVariables.APP_CLASS
  */
 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 MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
 declare type ModelRouteParameter = {
@@ -19,8 +20,8 @@ declare type OptionalRouteParameter = undefined | null | RequiredRouteParameter;
 declare type QueryRouteParameter = OptionalRouteParameter | QueryRouteParameter[] | {
     [k: string]: QueryRouteParameter;
 };
-declare type RouteParameters = Record<string, QueryRouteParameter>;
-declare type Serializable = Record<string, unknown>;
+declare type RouteParameters = Collection<QueryRouteParameter>;
+declare type Serializable = Collection<unknown>;
 declare type Serializer = (value: Serializable) => string;
 declare type RouteHelperExtras = {
     requiredParams(): string[];
@@ -32,9 +33,9 @@ declare type RequiredParameters<T extends number> = T extends 1 ? [RequiredRoute
     RequiredRouteParameter,
     RequiredRouteParameter
 ] : RequiredRouteParameter[];
-declare type RouteHelperOptions = RouteOptions & Record<string, OptionalRouteParameter>;
+declare type RouteHelperOptions = RouteOptions & Collection<OptionalRouteParameter>;
 declare type RouteHelper<T extends number = number> = ((...args: [...RequiredParameters<T>, RouteHelperOptions]) => string) & RouteHelperExtras;
-declare type RouteHelpers = Record<string, RouteHelper>;
+declare type RouteHelpers = Collection<RouteHelper>;
 declare type Configuration = {
     prefix: string;
     default_url_options: RouteParameters;
@@ -56,14 +57,13 @@ declare type KeywordUrlOptions = Optional<{
     params: RouteParameters;
 }>;
 declare type RouteOptions = KeywordUrlOptions & RouteParameters;
-declare type PartsTable = Record<string, {
+declare type PartsTable = Collection<{
     r?: boolean;
     d?: OptionalRouteParameter;
 }>;
 declare type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "DTS" | "NIL";
 declare const RubyVariables: {
     PREFIX: string;
-    DEPRECATED_GLOBBING_BEHAVIOR: boolean;
     DEPRECATED_FALSE_PARAMETER_BEHAVIOR: boolean;
     SPECIAL_OPTIONS_KEY: string;
     DEFAULT_URL_OPTIONS: RouteParameters;
@@ -76,5 +76,5 @@ declare const define: undefined | (((arg: unknown[], callback: () => unknown) =>
     amd?: unknown;
 });
 declare const module: {
-    exports: any;
+    exports: unknown;
 } | undefined;

data/lib/routes.js

@@ -1,5 +1,5 @@
 /**
- * File generated by js-routes RubyVariables.GEM_VERSION
+ * File generated by js-routes RubyVariables.GEM_VERSION on RubyVariables.TIMESTAMP
  * Based on Rails RubyVariables.RAILS_VERSION routes of RubyVariables.APP_CLASS
  */
 // eslint-disable-next-line
@@ -30,8 +30,9 @@ RubyVariables.WRAPPER(
     const ModuleReferences = {
         CJS: {
             define(routes) {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                module.exports = routes;
+                if (module) {
+                    module.exports = routes;
+                }
             },
             isSupported() {
                 return typeof module === "object";
@@ -39,10 +40,11 @@ RubyVariables.WRAPPER(
         },
         AMD: {
             define(routes) {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                define([], function () {
-                    return routes;
-                });
+                if (define) {
+                    define([], function () {
+                        return routes;
+                    });
+                }
             },
             isSupported() {
                 return typeof define === "function" && !!define.amd;
@@ -290,9 +292,9 @@ RubyVariables.WRAPPER(
             if (url_params.length) {
                 result += "?" + url_params;
             }
-            result += keyword_parameters.anchor
-                ? "#" + keyword_parameters.anchor
-                : "";
+            if (keyword_parameters.anchor) {
+                result += "#" + keyword_parameters.anchor;
+            }
             if (absolute) {
                 result = this.route_url(keyword_parameters) + result;
             }
@@ -413,9 +415,7 @@ RubyVariables.WRAPPER(
                 value = value.join("/");
             }
             const result = this.path_identifier(value);
-            return RubyVariables.DEPRECATED_GLOBBING_BEHAVIOR
-                ? result
-                : encodeURI(result);
+            return encodeURI(result);
         }
         get_prefix() {
             const prefix = this.configuration.prefix;
@@ -502,28 +502,27 @@ RubyVariables.WRAPPER(
         define_module(name, module) {
             this.ensure_module_supported(name);
             ModuleReferences[name].define(module);
+            return module;
         }
     }
-    const Utils = new UtilsClass();
+    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);
+            return utils.route(parts_table, route_spec, absolute);
         },
     };
-    const result = {
+    return utils.define_module(RubyVariables.MODULE_TYPE, {
         ...__jsr,
         configure: (config) => {
-            return Utils.configure(config);
+            return utils.configure(config);
         },
         config: () => {
-            return Utils.config();
+            return utils.config();
         },
         serialize: (object) => {
-            return Utils.serialize(object);
+            return utils.serialize(object);
         },
         ...RubyVariables.ROUTES_OBJECT,
-    };
-    Utils.define_module(RubyVariables.MODULE_TYPE, result);
-    return result;
+    });
 })();

data/lib/routes.ts

@@ -1,9 +1,11 @@
 /**
- * File generated by js-routes RubyVariables.GEM_VERSION
+ * File generated by js-routes RubyVariables.GEM_VERSION on RubyVariables.TIMESTAMP
  * Based on Rails RubyVariables.RAILS_VERSION routes of RubyVariables.APP_CLASS
  */
 
 type Optional<T> = { [P in keyof T]?: T[P] | null };
+type Collection<T> = Record<string, T>;
+
 type BaseRouteParameter = string | boolean | Date | number;
 type MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
 type ModelRouteParameter =
@@ -16,9 +18,9 @@ type QueryRouteParameter =
   | OptionalRouteParameter
   | QueryRouteParameter[]
   | { [k: string]: QueryRouteParameter };
-type RouteParameters = Record<string, QueryRouteParameter>;
+type RouteParameters = Collection<QueryRouteParameter>;
 
-type Serializable = Record<string, unknown>;
+type Serializable = Collection<unknown>;
 type Serializer = (value: Serializable) => string;
 type RouteHelperExtras = {
   requiredParams(): string[];
@@ -40,14 +42,14 @@ type RequiredParameters<T extends number> = T extends 1
     ]
   : RequiredRouteParameter[];
 
-type RouteHelperOptions = RouteOptions & Record<string, OptionalRouteParameter>;
+type RouteHelperOptions = RouteOptions & Collection<OptionalRouteParameter>;
 
 type RouteHelper<T extends number = number> = ((
   ...args: [...RequiredParameters<T>, RouteHelperOptions]
 ) => string) &
   RouteHelperExtras;
 
-type RouteHelpers = Record<string, RouteHelper>;
+type RouteHelpers = Collection<RouteHelper>;
 
 type Configuration = {
   prefix: string;
@@ -74,13 +76,12 @@ type KeywordUrlOptions = Optional<{
 
 type RouteOptions = KeywordUrlOptions & RouteParameters;
 
-type PartsTable = Record<string, { r?: boolean; d?: OptionalRouteParameter }>;
+type PartsTable = Collection<{ r?: boolean; d?: OptionalRouteParameter }>;
 
 type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "DTS" | "NIL";
 
 declare const RubyVariables: {
   PREFIX: string;
-  DEPRECATED_GLOBBING_BEHAVIOR: boolean;
   DEPRECATED_FALSE_PARAMETER_BEHAVIOR: boolean;
   SPECIAL_OPTIONS_KEY: string;
   DEFAULT_URL_OPTIONS: RouteParameters;
@@ -94,7 +95,7 @@ declare const define:
   | undefined
   | (((arg: unknown[], callback: () => unknown) => void) & { amd?: unknown });
 
-declare const module: { exports: any } | undefined;
+declare const module: { exports: unknown } | undefined;
 
 // eslint-disable-next-line
 RubyVariables.WRAPPER(
@@ -148,8 +149,9 @@ RubyVariables.WRAPPER(
     const ModuleReferences: Record<ModuleType, ModuleDefinition> = {
       CJS: {
         define(routes) {
-          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          module!.exports = routes;
+          if (module) {
+            module.exports = routes;
+          }
         },
         isSupported() {
           return typeof module === "object";
@@ -157,10 +159,11 @@ RubyVariables.WRAPPER(
       },
       AMD: {
         define(routes) {
-          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          define!([], function () {
-            return routes;
-          });
+          if (define) {
+            define([], function () {
+              return routes;
+            });
+          }
         },
         isSupported() {
           return typeof define === "function" && !!define.amd;
@@ -419,6 +422,7 @@ RubyVariables.WRAPPER(
         }
         return { keyword_parameters, query_parameters };
       }
+
       build_route(
         parts: string[],
         required_params: string[],
@@ -450,9 +454,9 @@ RubyVariables.WRAPPER(
         if (url_params.length) {
           result += "?" + url_params;
         }
-        result += keyword_parameters.anchor
-          ? "#" + keyword_parameters.anchor
-          : "";
+        if (keyword_parameters.anchor) {
+          result += "#" + keyword_parameters.anchor;
+        }
         if (absolute) {
           result = this.route_url(keyword_parameters) + result;
         }
@@ -601,9 +605,7 @@ RubyVariables.WRAPPER(
           value = value.join("/");
         }
         const result = this.path_identifier(value as any);
-        return RubyVariables.DEPRECATED_GLOBBING_BEHAVIOR
-          ? result
-          : encodeURI(result);
+        return encodeURI(result);
       }
 
       get_prefix(): string {
@@ -679,7 +681,7 @@ RubyVariables.WRAPPER(
         return (isBrowser && window?.location?.port) || "";
       }
 
-      is_object(value: unknown): value is Record<string, unknown> {
+      is_object(value: unknown): value is Collection<unknown> {
         return (
           typeof value === "object" &&
           Object.prototype.toString.call(value) === "[object Object]"
@@ -717,13 +719,17 @@ RubyVariables.WRAPPER(
         }
       }
 
-      define_module(name: ModuleType, module: RouterExposedMethods): void {
+      define_module(
+        name: ModuleType,
+        module: RouterExposedMethods
+      ): RouterExposedMethods {
         this.ensure_module_supported(name);
         ModuleReferences[name].define(module);
+        return module;
       }
     }
 
-    const Utils = new UtilsClass();
+    const utils = new UtilsClass();
 
     // We want this helper name to be short
     const __jsr = {
@@ -732,25 +738,22 @@ RubyVariables.WRAPPER(
         route_spec: RouteTree,
         absolute?: boolean
       ): RouteHelper {
-        return Utils.route(parts_table, route_spec, absolute);
+        return utils.route(parts_table, route_spec, absolute);
       },
     };
 
-    const result = {
+    return utils.define_module(RubyVariables.MODULE_TYPE, {
       ...__jsr,
       configure: (config: Partial<Configuration>) => {
-        return Utils.configure(config);
+        return utils.configure(config);
       },
       config: (): Configuration => {
-        return Utils.config();
+        return utils.config();
       },
       serialize: (object: Serializable): string => {
-        return Utils.serialize(object);
+        return utils.serialize(object);
       },
       ...RubyVariables.ROUTES_OBJECT,
-    };
-
-    Utils.define_module(RubyVariables.MODULE_TYPE, result);
-    return result;
+    });
   }
 )();

data/lib/tasks/js_routes.rake

@@ -2,13 +2,15 @@ namespace :js do
   desc "Make a js file with all rails route URL helpers"
   task routes: :environment do
     require "js-routes"
-    JsRoutes.generate!
+    JsRoutes.generate!(typed: true)
   end
 
   namespace :routes do
     desc "Make a js file with all rails route URL helpers and typescript definitions for them"
     task typescript: "js:routes" do
-      JsRoutes.definitions!
+      ActiveSupport::Deprecation.warn(
+        "`js:routes:typescript` task is deprecated. Please use `js:routes` instead."
+      )
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.2.10
+  version: 2.3.1
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-03 00:00:00.000000000 Z
+date: 2024-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -94,48 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.2
-- !ruby/object:Gem::Dependency
-  name: bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mini_racer
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +130,7 @@ files:
 - lib/js_routes/middleware.rb
 - lib/js_routes/route.rb
 - lib/js_routes/types.rb
+- lib/js_routes/utils.rb
 - lib/js_routes/version.rb
 - lib/routes.d.ts
 - lib/routes.js
@@ -185,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.2.10/CHANGELOG.md
+  changelog_uri: https://github.com/railsware/js-routes/blob/v2.3.1/CHANGELOG.md
   documentation_uri: https://github.com/railsware/js-routes
-  source_code_uri: https://github.com/railsware/js-routes/tree/v2.2.10/activerecord
+  source_code_uri: https://github.com/railsware/js-routes/tree/v2.3.1/activerecord
   rubygems_mfa_required: 'true'
   github_repo: ssh://github.com/railsware/js-routes
 post_install_message:
@@ -205,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Brings Rails named routes to javascript