js-routes 2.0.6 → 2.1.1

data/lib/routes.js

@@ -18,25 +18,32 @@ RubyVariables.WRAPPER((that) => {
     const Root = that;
     const ModuleReferences = {
         CJS: {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            define: (routes) => (module.exports = routes),
-            support: () => typeof module === "object",
+            define(routes) {
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                module.exports = routes;
+            },
+            isSupported() {
+                return typeof module === "object";
+            },
         },
         AMD: {
-            define: (routes) => 
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            define([], function () {
-                return routes;
-            }),
-            support: () => typeof define === "function" && !!define.amd,
+            define(routes) {
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                define([], function () {
+                    return routes;
+                });
+            },
+            isSupported() {
+                return typeof define === "function" && !!define.amd;
+            },
         },
         UMD: {
-            define: (routes) => {
-                if (ModuleReferences.AMD.support()) {
+            define(routes) {
+                if (ModuleReferences.AMD.isSupported()) {
                     ModuleReferences.AMD.define(routes);
                 }
                 else {
-                    if (ModuleReferences.CJS.support()) {
+                    if (ModuleReferences.CJS.isSupported()) {
                         try {
                             ModuleReferences.CJS.define(routes);
                         }
@@ -47,11 +54,36 @@ RubyVariables.WRAPPER((that) => {
                     }
                 }
             },
-            support: () => ModuleReferences.AMD.support() || ModuleReferences.CJS.support(),
+            isSupported() {
+                return (ModuleReferences.AMD.isSupported() ||
+                    ModuleReferences.CJS.isSupported());
+            },
         },
         ESM: {
-            define: () => null,
-            support: () => true,
+            define() {
+                // Module can only be defined using ruby code generation
+            },
+            isSupported() {
+                // Its impossible to check if "export" keyword is supported
+                return true;
+            },
+        },
+        NIL: {
+            define(routes) {
+                Utils.namespace(Root, RubyVariables.NAMESPACE, routes);
+            },
+            isSupported() {
+                return !!Root;
+            },
+        },
+        DTS: {
+            // Acts the same as ESM
+            define(routes) {
+                ModuleReferences.ESM.define(routes);
+            },
+            isSupported() {
+                return ModuleReferences.ESM.isSupported();
+            },
         },
     };
     class ParametersMissing extends Error {
@@ -62,7 +94,6 @@ RubyVariables.WRAPPER((that) => {
             this.name = ParametersMissing.name;
         }
     }
-    const DeprecatedGlobbingBehavior = RubyVariables.DEPRECATED_GLOBBING_BEHAVIOR;
     const UriEncoderSegmentRegex = /[^a-zA-Z0-9\-._~!$&'()*+,;=:@]/g;
     const ReservedOptions = [
         "anchor",
@@ -140,7 +171,7 @@ RubyVariables.WRAPPER((that) => {
         }
         looks_like_serialized_model(object) {
             return (this.is_object(object) &&
-                !object[this.configuration.special_options_key] &&
+                !(this.configuration.special_options_key in object) &&
                 ("id" in object || "to_param" in object || "toParam" in object));
         }
         path_identifier(object) {
@@ -298,9 +329,7 @@ RubyVariables.WRAPPER((that) => {
             }
         }
         encode_segment(segment) {
-            return segment.replace(UriEncoderSegmentRegex, function (str) {
-                return encodeURIComponent(str);
-            });
+            return segment.replace(UriEncoderSegmentRegex, (str) => encodeURIComponent(str));
         }
         is_optional_node(node) {
             return [NodeTypes.STAR, NodeTypes.SYMBOL, NodeTypes.CAT].includes(node);
@@ -342,7 +371,9 @@ RubyVariables.WRAPPER((that) => {
                 value = value.join("/");
             }
             const result = this.path_identifier(value);
-            return DeprecatedGlobbingBehavior ? result : encodeURI(result);
+            return RubyVariables.DEPRECATED_GLOBBING_BEHAVIOR
+                ? result
+                : encodeURI(result);
         }
         get_prefix() {
             const prefix = this.configuration.prefix;
@@ -386,32 +417,17 @@ RubyVariables.WRAPPER((that) => {
             port = port ? ":" + port : "";
             return protocol + "://" + subdomain + hostname + port;
         }
-        has_location() {
-            return this.is_not_nullable(window) && !!window.location;
-        }
         current_host() {
-            if (this.has_location()) {
-                return window.location.hostname;
-            }
-            else {
-                return null;
-            }
+            var _a;
+            return ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.hostname) || "";
         }
         current_protocol() {
-            if (this.has_location() && window.location.protocol !== "") {
-                return window.location.protocol.replace(/:$/, "");
-            }
-            else {
-                return "http";
-            }
+            var _a, _b;
+            return ((_b = (_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.protocol) === null || _b === void 0 ? void 0 : _b.replace(/:$/, "")) || "http";
         }
         current_port() {
-            if (this.has_location() && window.location.port !== "") {
-                return window.location.port;
-            }
-            else {
-                return "";
-            }
+            var _a;
+            return ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.port) || "";
         }
         is_object(value) {
             return (typeof value === "object" &&
@@ -449,7 +465,7 @@ RubyVariables.WRAPPER((that) => {
             return { ...this.configuration };
         }
         is_module_supported(name) {
-            return ModuleReferences[name].support();
+            return ModuleReferences[name].isSupported();
         }
         ensure_module_supported(name) {
             if (!this.is_module_supported(name)) {
@@ -457,9 +473,6 @@ RubyVariables.WRAPPER((that) => {
             }
         }
         define_module(name, module) {
-            if (!name) {
-                return;
-            }
             this.ensure_module_supported(name);
             ModuleReferences[name].define(module);
         }
@@ -484,10 +497,6 @@ RubyVariables.WRAPPER((that) => {
         },
         ...RubyVariables.ROUTES_OBJECT,
     };
-    Utils.namespace(Root, RubyVariables.NAMESPACE, result);
-    if (RubyVariables.MODULE_TYPE) {
-        Utils.define_module(RubyVariables.MODULE_TYPE, result);
-    }
+    Utils.define_module(RubyVariables.MODULE_TYPE, result);
     return result;
 })(this);
-//# sourceMappingURL=routes.js.map

data/lib/routes.ts

@@ -3,15 +3,51 @@
  * Based on Rails RubyVariables.RAILS_VERSION routes of RubyVariables.APP_CLASS
  */
 
-type RouteParameter = unknown;
-type RouteParameters = Record<string, RouteParameter>;
-type Serializer = (value: unknown) => string;
-type RouteHelper = {
-  (...args: RouteParameter[]): string;
+type Optional<T> = { [P in keyof T]?: T[P] | null };
+type BaseRouteParameter = string | boolean | Date | number;
+type MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
+type ModelRouteParameter =
+  | { id: MethodRouteParameter }
+  | { to_param: MethodRouteParameter }
+  | { toParam: MethodRouteParameter };
+type RequiredRouteParameter = BaseRouteParameter | ModelRouteParameter;
+type OptionalRouteParameter = undefined | null | RequiredRouteParameter;
+type QueryRouteParameter =
+  | OptionalRouteParameter
+  | QueryRouteParameter[]
+  | { [k: string]: QueryRouteParameter };
+type RouteParameters = Record<string, QueryRouteParameter>;
+
+type Serializable = Record<string, unknown>;
+type Serializer = (value: Serializable) => string;
+type RouteHelperExtras = {
   requiredParams(): string[];
   toString(): string;
 };
 
+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[];
+
+type RouteHelperOptions<T extends string> = RouteOptions &
+  Optional<Record<T, OptionalRouteParameter>>;
+
+type RouteHelper<T extends number = number, U extends string = string> = ((
+  ...args: [...RequiredParameters<T>, RouteHelperOptions<U>]
+) => string) &
+  RouteHelperExtras;
+
 type RouteHelpers = Record<string, RouteHelper>;
 
 type Configuration = {
@@ -21,7 +57,6 @@ type Configuration = {
   serializer: Serializer;
 };
 
-type Optional<T> = { [P in keyof T]?: T[P] | null };
 interface RouterExposedMethods {
   config(): Configuration;
   configure(arg: Partial<Configuration>): Configuration;
@@ -32,14 +67,16 @@ type KeywordUrlOptions = Optional<{
   host: string;
   protocol: string;
   subdomain: string;
-  port: string;
+  port: string | number;
   anchor: string;
   trailing_slash: boolean;
 }>;
 
-type PartsTable = Record<string, { r?: boolean; d?: unknown }>;
+type RouteOptions = KeywordUrlOptions & RouteParameters;
 
-type ModuleType = "CJS" | "AMD" | "UMD" | "ESM";
+type PartsTable = Record<string, { r?: boolean; d?: OptionalRouteParameter }>;
+
+type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "DTS" | "NIL";
 
 declare const RubyVariables: {
   PREFIX: string;
@@ -49,7 +86,7 @@ declare const RubyVariables: {
   SERIALIZER: Serializer;
   NAMESPACE: string;
   ROUTES_OBJECT: RouteHelpers;
-  MODULE_TYPE: ModuleType | null;
+  MODULE_TYPE: ModuleType;
   WRAPPER: <T>(callback: T) => T;
 };
 
@@ -93,29 +130,36 @@ RubyVariables.WRAPPER(
 
     const Root = that;
     type ModuleDefinition = {
-      define: (routes: unknown) => void;
-      support: () => boolean;
+      define: (routes: RouterExposedMethods) => void;
+      isSupported: () => boolean;
     };
     const ModuleReferences: Record<ModuleType, ModuleDefinition> = {
       CJS: {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        define: (routes) => (module!.exports = routes),
-        support: () => typeof module === "object",
+        define(routes) {
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          module!.exports = routes;
+        },
+        isSupported() {
+          return typeof module === "object";
+        },
       },
       AMD: {
-        define: (routes) =>
+        define(routes) {
           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           define!([], function () {
             return routes;
-          }),
-        support: () => typeof define === "function" && !!define.amd,
+          });
+        },
+        isSupported() {
+          return typeof define === "function" && !!define.amd;
+        },
       },
       UMD: {
-        define: (routes) => {
-          if (ModuleReferences.AMD.support()) {
+        define(routes) {
+          if (ModuleReferences.AMD.isSupported()) {
             ModuleReferences.AMD.define(routes);
           } else {
-            if (ModuleReferences.CJS.support()) {
+            if (ModuleReferences.CJS.isSupported()) {
               try {
                 ModuleReferences.CJS.define(routes);
               } catch (error) {
@@ -124,12 +168,38 @@ RubyVariables.WRAPPER(
             }
           }
         },
-        support: () =>
-          ModuleReferences.AMD.support() || ModuleReferences.CJS.support(),
+        isSupported() {
+          return (
+            ModuleReferences.AMD.isSupported() ||
+            ModuleReferences.CJS.isSupported()
+          );
+        },
       },
       ESM: {
-        define: () => null,
-        support: () => true,
+        define() {
+          // Module can only be defined using ruby code generation
+        },
+        isSupported() {
+          // Its impossible to check if "export" keyword is supported
+          return true;
+        },
+      },
+      NIL: {
+        define(routes) {
+          Utils.namespace(Root, RubyVariables.NAMESPACE, routes);
+        },
+        isSupported() {
+          return !!Root;
+        },
+      },
+      DTS: {
+        // Acts the same as ESM
+        define(routes) {
+          ModuleReferences.ESM.define(routes);
+        },
+        isSupported() {
+          return ModuleReferences.ESM.isSupported();
+        },
       },
     };
 
@@ -143,9 +213,6 @@ RubyVariables.WRAPPER(
       }
     }
 
-    const DeprecatedGlobbingBehavior =
-      RubyVariables.DEPRECATED_GLOBBING_BEHAVIOR;
-
     const UriEncoderSegmentRegex = /[^a-zA-Z0-9\-._~!$&'()*+,;=:@]/g;
 
     const ReservedOptions = [
@@ -204,16 +271,16 @@ RubyVariables.WRAPPER(
         return result.join("&");
       }
 
-      serialize(object: unknown): string {
+      serialize(object: Serializable): string {
         return this.configuration.serializer(object);
       }
 
       extract_options(
         number_of_params: number,
-        args: RouteParameter[]
+        args: OptionalRouteParameter[]
       ): {
-        args: RouteParameter[];
-        options: KeywordUrlOptions & RouteParameters;
+        args: OptionalRouteParameter[];
+        options: RouteOptions;
       } {
         const last_el = args[args.length - 1];
         if (
@@ -226,32 +293,27 @@ RubyVariables.WRAPPER(
           }
           return {
             args: args.slice(0, args.length - 1),
-            options: last_el as KeywordUrlOptions & RouteParameters,
+            options: (last_el as any) as RouteOptions,
           };
         } else {
           return { args, options: {} };
         }
       }
 
-      looks_like_serialized_model(
-        object: any
-      ): object is
-        | { id: unknown }
-        | { to_param: unknown }
-        | { toParam: unknown } {
+      looks_like_serialized_model(object: any): object is ModelRouteParameter {
         return (
           this.is_object(object) &&
-          !object[this.configuration.special_options_key] &&
+          !(this.configuration.special_options_key in object) &&
           ("id" in object || "to_param" in object || "toParam" in object)
         );
       }
 
-      path_identifier(object: unknown): string {
+      path_identifier(object: QueryRouteParameter): string {
         const result = this.unwrap_path_identifier(object);
         return this.is_nullable(result) || result === false ? "" : "" + result;
       }
 
-      unwrap_path_identifier(object: any): unknown {
+      unwrap_path_identifier(object: QueryRouteParameter): unknown {
         let result: any = object;
         if (!this.is_object(object)) {
           return object;
@@ -272,7 +334,7 @@ RubyVariables.WRAPPER(
         parts: string[],
         required_params: string[],
         default_options: RouteParameters,
-        call_arguments: RouteParameter[]
+        call_arguments: OptionalRouteParameter[]
       ): {
         keyword_parameters: KeywordUrlOptions;
         query_parameters: RouteParameters;
@@ -336,7 +398,7 @@ RubyVariables.WRAPPER(
         default_options: RouteParameters,
         route: RouteTree,
         absolute: boolean,
-        args: RouteParameter[]
+        args: OptionalRouteParameter[]
       ): string {
         const {
           keyword_parameters,
@@ -446,9 +508,9 @@ RubyVariables.WRAPPER(
       }
 
       encode_segment(segment: string): string {
-        return segment.replace(UriEncoderSegmentRegex, function (str) {
-          return encodeURIComponent(str);
-        });
+        return segment.replace(UriEncoderSegmentRegex, (str) =>
+          encodeURIComponent(str)
+        );
       }
 
       is_optional_node(node: NodeTypes): boolean {
@@ -498,7 +560,9 @@ RubyVariables.WRAPPER(
           value = value.join("/");
         }
         const result = this.path_identifier(value as any);
-        return DeprecatedGlobbingBehavior ? result : encodeURI(result);
+        return RubyVariables.DEPRECATED_GLOBBING_BEHAVIOR
+          ? result
+          : encodeURI(result);
       }
 
       get_prefix(): string {
@@ -527,7 +591,7 @@ RubyVariables.WRAPPER(
             default_options[part] = value;
           }
         }
-        const result = (...args: RouteParameter[]): string => {
+        const result = (...args: OptionalRouteParameter[]): string => {
           return this.build_route(
             parts,
             required_params,
@@ -541,7 +605,7 @@ RubyVariables.WRAPPER(
         result.toString = () => {
           return this.build_path_spec(route_spec);
         };
-        return result;
+        return result as any;
       }
 
       route_url(route_defaults: KeywordUrlOptions): string {
@@ -560,31 +624,16 @@ RubyVariables.WRAPPER(
         return protocol + "://" + subdomain + hostname + port;
       }
 
-      has_location(): boolean {
-        return this.is_not_nullable(window) && !!window.location;
-      }
-
-      current_host(): string | null {
-        if (this.has_location()) {
-          return window.location.hostname;
-        } else {
-          return null;
-        }
+      current_host(): string {
+        return window?.location?.hostname || "";
       }
 
       current_protocol(): string {
-        if (this.has_location() && window.location.protocol !== "") {
-          return window.location.protocol.replace(/:$/, "");
-        } else {
-          return "http";
-        }
+        return window?.location?.protocol?.replace(/:$/, "") || "http";
       }
+
       current_port(): string {
-        if (this.has_location() && window.location.port !== "") {
-          return window.location.port;
-        } else {
-          return "";
-        }
+        return window?.location?.port || "";
       }
 
       is_object(value: unknown): value is Record<string, unknown> {
@@ -635,7 +684,7 @@ RubyVariables.WRAPPER(
       }
 
       is_module_supported(name: ModuleType): boolean {
-        return ModuleReferences[name].support();
+        return ModuleReferences[name].isSupported();
       }
 
       ensure_module_supported(name: ModuleType): void {
@@ -644,13 +693,7 @@ RubyVariables.WRAPPER(
         }
       }
 
-      define_module(
-        name: ModuleType | null,
-        module: RouterExposedMethods
-      ): void {
-        if (!name) {
-          return;
-        }
+      define_module(name: ModuleType, module: RouterExposedMethods): void {
         this.ensure_module_supported(name);
         ModuleReferences[name].define(module);
       }
@@ -677,17 +720,13 @@ RubyVariables.WRAPPER(
       config: (): Configuration => {
         return Utils.config();
       },
-      serialize: (object: unknown): string => {
+      serialize: (object: Serializable): string => {
         return Utils.serialize(object);
       },
       ...RubyVariables.ROUTES_OBJECT,
     };
 
-    Utils.namespace(Root, RubyVariables.NAMESPACE, result);
-
-    if (RubyVariables.MODULE_TYPE) {
-      Utils.define_module(RubyVariables.MODULE_TYPE, result);
-    }
+    Utils.define_module(RubyVariables.MODULE_TYPE, result);
     return result;
   }
 )(this);

data/lib/tasks/js_routes.rake

@@ -1,8 +1,14 @@
 namespace :js do
-  desc "Make a js file that will have functions that will return restful routes/urls."
+  desc "Make a js file with all rails route URL helpers"
   task routes: :environment do
     require "js-routes"
-
     JsRoutes.generate!
   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!
+    end
+  end
 end

data/lib/templates/erb.js

@@ -0,0 +1,11 @@
+module.exports = {
+  module: {
+    rules: [
+      {
+        test: /\.erb$/,
+        enforce: 'pre',
+        loader: 'rails-erb-loader'
+      },
+    ]
+  }
+};

data/lib/templates/initializer.rb

@@ -0,0 +1,5 @@
+JsRoutes.setup do |c|
+  # Setup your JS module system:
+  # ESM, CJS, AMD, UMD or nil
+  # c.module_type = "ESM"
+end

data/lib/templates/routes.js.erb

@@ -0,0 +1 @@
+<%= JsRoutes.generate %>

data/package.json

@@ -21,6 +21,7 @@
     "prettier": "^2.2.1"
   },
   "scripts": {
+    "build": "tsc && yarn lint:fix",
     "lint:fix": "yarn eslint --fix && yarn prettier --write lib/routes.ts",
     "postinstall": "yarn husky-upgrade"
   },
@@ -30,7 +31,7 @@
     }
   },
   "lint-staged": {
-    "*.ts": ["yarn lint:fix" ]
+    "./lib/routes.ts": ["yarn lint:fix" ]
   }
 
 }