@react-router/remix-routes-option-adapter 0.0.0-nightly-f0cd1c5cc-20241029

package/LICENSE.md

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) React Training LLC 2015-2019
+Copyright (c) Remix Software Inc. 2020-2021
+Copyright (c) Shopify Inc. 2022-2023
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# @react-router/remix-routes-option-adapter
+
+Adapter for [Remix's](https://remix.run) `routes` config option, for use within `routes.ts`.
+
+```sh
+npm install @react-router/remix-routes-option-adapter
+```

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+import { RouteConfigEntry } from '@react-router/dev/routes';
+
+interface RouteManifestEntry {
+    path?: string;
+    index?: boolean;
+    caseSensitive?: boolean;
+    id: string;
+    parentId?: string;
+    file: string;
+}
+interface RouteManifest {
+    [routeId: string]: RouteManifestEntry;
+}
+
+type DefineRoutesFunction = (callback: (defineRoute: DefineRouteFunction) => void) => RouteManifest;
+interface DefineRouteOptions {
+    /**
+     * Should be `true` if the route `path` is case-sensitive. Defaults to
+     * `false`.
+     */
+    caseSensitive?: boolean;
+    /**
+     * Should be `true` if this is an index route that does not allow child routes.
+     */
+    index?: boolean;
+    /**
+     * An optional unique id string for this route. Use this if you need to aggregate
+     * two or more routes with the same route file.
+     */
+    id?: string;
+}
+interface DefineRouteChildren {
+    (): void;
+}
+interface DefineRouteFunction {
+    (
+    /**
+     * The path this route uses to match the URL pathname.
+     */
+    path: string | undefined, 
+    /**
+     * The path to the file that exports the React component rendered by this
+     * route as its default export, relative to the `app` directory.
+     */
+    file: string, 
+    /**
+     * Options for defining routes, or a function for defining child routes.
+     */
+    optionsOrChildren?: DefineRouteOptions | DefineRouteChildren, 
+    /**
+     * A function for defining child routes.
+     */
+    children?: DefineRouteChildren): void;
+}
+
+/**
+ * Adapts routes defined using [Remix's `routes` config
+ * option](https://remix.run/docs/en/v2/file-conventions/vite-config#routes) to
+ * React Router's config format, for use within `routes.ts`.
+ */
+declare function remixRoutesOptionAdapter(routes: (defineRoutes: DefineRoutesFunction) => ReturnType<DefineRoutesFunction> | Promise<ReturnType<DefineRoutesFunction>>): Promise<RouteConfigEntry[]>;
+
+export { type DefineRoutesFunction, remixRoutesOptionAdapter };

package/dist/index.js

@@ -0,0 +1,140 @@
+/**
+ * @react-router/remix-routes-option-adapter v0.0.0-nightly-f0cd1c5cc-20241029
+ *
+ * Copyright (c) Remix Software Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var react_router_remix_routes_option_adapter_exports = {};
+__export(react_router_remix_routes_option_adapter_exports, {
+  remixRoutesOptionAdapter: () => remixRoutesOptionAdapter
+});
+module.exports = __toCommonJS(react_router_remix_routes_option_adapter_exports);
+
+// manifest.ts
+function routeManifestToRouteConfig(routeManifest, rootId = "root") {
+  let routeConfigById = {};
+  for (let id in routeManifest) {
+    let route = routeManifest[id];
+    routeConfigById[id] = {
+      id: route.id,
+      file: route.file,
+      path: route.path,
+      index: route.index,
+      caseSensitive: route.caseSensitive
+    };
+  }
+  let routeConfig = [];
+  for (let id in routeConfigById) {
+    let route = routeConfigById[id];
+    let parentId = routeManifest[route.id].parentId;
+    if (parentId === rootId) {
+      routeConfig.push(route);
+    } else {
+      let parentRoute = parentId && routeConfigById[parentId];
+      if (parentRoute) {
+        parentRoute.children = parentRoute.children || [];
+        parentRoute.children.push(route);
+      }
+    }
+  }
+  return routeConfig;
+}
+
+// normalizeSlashes.ts
+var import_node_path = __toESM(require("path"));
+function normalizeSlashes(file) {
+  return file.split(import_node_path.default.win32.sep).join("/");
+}
+
+// defineRoutes.ts
+var defineRoutes = (callback) => {
+  let routes = /* @__PURE__ */ Object.create(null);
+  let parentRoutes = [];
+  let alreadyReturned = false;
+  let defineRoute = (path2, file, optionsOrChildren, children) => {
+    if (alreadyReturned) {
+      throw new Error(
+        "You tried to define routes asynchronously but started defining routes before the async work was done. Please await all async data before calling `defineRoutes()`"
+      );
+    }
+    let options;
+    if (typeof optionsOrChildren === "function") {
+      options = {};
+      children = optionsOrChildren;
+    } else {
+      options = optionsOrChildren || {};
+    }
+    let route = {
+      path: path2 ? path2 : void 0,
+      index: options.index ? true : void 0,
+      caseSensitive: options.caseSensitive ? true : void 0,
+      id: options.id || createRouteId(file),
+      parentId: parentRoutes.length > 0 ? parentRoutes[parentRoutes.length - 1].id : "root",
+      file
+    };
+    if (route.id in routes) {
+      throw new Error(
+        `Unable to define routes with duplicate route id: "${route.id}"`
+      );
+    }
+    routes[route.id] = route;
+    if (children) {
+      parentRoutes.push(route);
+      children();
+      parentRoutes.pop();
+    }
+  };
+  callback(defineRoute);
+  alreadyReturned = true;
+  return routes;
+};
+function createRouteId(file) {
+  return normalizeSlashes(stripFileExtension(file));
+}
+function stripFileExtension(file) {
+  return file.replace(/\.[a-z0-9]+$/i, "");
+}
+
+// index.ts
+async function remixRoutesOptionAdapter(routes) {
+  let routeManifest = await routes(defineRoutes);
+  return routeManifestToRouteConfig(routeManifest);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  remixRoutesOptionAdapter
+});

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@react-router/remix-routes-option-adapter",
+  "version": "0.0.0-nightly-f0cd1c5cc-20241029",
+  "description": "Adapter for Remix's \"routes\" config option, for use within routes.ts",
+  "bugs": {
+    "url": "https://github.com/remix-run/react-router/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/remix-run/react-router",
+    "directory": "packages/react-router-remix-routes-option-adapter"
+  },
+  "license": "MIT",
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "wireit": {
+    "build": {
+      "command": "tsup",
+      "files": [
+        "*.ts",
+        "tsconfig.json",
+        "package.json"
+      ],
+      "output": [
+        "dist/**"
+      ]
+    }
+  },
+  "devDependencies": {
+    "tsup": "^8.3.0",
+    "typescript": "^5.1.6",
+    "wireit": "0.14.9",
+    "@react-router/dev": "0.0.0-nightly-f0cd1c5cc-20241029"
+  },
+  "peerDependencies": {
+    "typescript": "^5.1.0",
+    "@react-router/dev": "^0.0.0-nightly-f0cd1c5cc-20241029"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "files": [
+    "dist/",
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "wireit"
+  }
+}