@ossy/router-react 0.1.3 → 0.1.5

package/build/index.js

@@ -0,0 +1 @@
+import e,{createContext as n,useContext as r,useCallback as a}from"react";import{Router as t}from"@ossy/router";var o=function(){return o=Object.assign||function(e){for(var n,r=1,a=arguments.length;r<a;r++)for(var t in n=arguments[r])Object.prototype.hasOwnProperty.call(n,t)&&(e[t]=n[t]);return e},o.apply(this,arguments)};"function"==typeof SuppressedError&&SuppressedError;var i=n({pages:[],defaultLanguage:void 0,supportedLanguages:[]}),u=function(){return r(i)},d=function(e){return void 0===e&&(e=""),function(e){return"/"===e[e.length-1]?e:"".concat(e,"/")}(function(e){return"/"===e[0]?e:"/".concat(e)}(e))},l=function(n){var r,u,l,c,s,f=n.url,g=n.pages,p=void 0===g?[]:g,v=n.defaultLanguage,w=void 0===v?void 0:v,h=n.supportedLanguages,m=void 0===h?[]:h;if(f){var y=f.match(/([^?#]*)(\?[^#]*)?(#.*)?/);u=f,l=(null==y?void 0:y[1])||"",c=(null==y?void 0:y[3])||"",s=(null==y?void 0:y[2])||""}else{if("undefined"==typeof window)return e.createElement(e.Fragment,null);u=window.location.href,l=window.location.pathname,s=(null==(c=window.location.hash)?void 0:c.includes("?"))?c.split("?")[1]:window.location.search}var L=m.length>1&&!!w,P=l.split("/")[1]||"",S=m.includes(P)?P:w,b=t.of({pages:p,defaultLanguage:w,supportedLanguages:m}),E=b.getParamsFromUrl(u),R=new URLSearchParams(s),k=b.getPageByUrl(u);if(k||(L&&"/"===l&&"undefined"!=typeof window&&(window.location.href="/"+w),k=L?p.find(function(e){return"*"===d(e.path[S])}):p.find(function(e){return"*"===d(e.path)})),!k)return console.warn("[RouterReact] No active page found for",l),e.createElement(e.Fragment,null);a(function(e,n){if("undefined"!=typeof window){window.history.pushState({},"","".concat(l,"?").concat(R.toString()));var r=new URLSearchParams(R);r.set(e,n),history.pushState({},"","?".concat(r.toString()))}},[R]);var U=a(function(e){var n,r,a,t,o,i={};if("string"==typeof e?(n=e,i=E,r=S):(o=e).id||void 0===o.language?(n=(null==e?void 0:e.id)||k.id,i=(null==e?void 0:e.params)||E,r=(null==e?void 0:e.language)||S):(n=k.id,i=E,r=e.language),n.includes("#")){var u=n.split("#");if(n=u[0],(a=u[1]).includes("?")){var d=n.split("?");a=d[0],t=d[1]}}else if(n.includes("?")){var l=n.split("?");n=l[0],t=l[1]}var c=b.getPathname({id:n.replace("@",""),params:i,language:r});return a&&(c=c+"#"+a),t&&(c=c+"?"+t),c},[b,S]),F=a(function(e){if("undefined"!=typeof window&&e)if("@back"!==e){var n=U(e);n&&(window.location.href=n)}else window.history.back()},[U]),O=a(function(){"undefined"!=typeof window&&window.history.back()},[]),j={href:u,pages:p,language:S,defaultLanguage:w,supportedLanguages:m,params:E,searchParams:o({},Array.from(R.entries()).reduce(function(e,n){var r,a=n[0],t=n[1];return o(o({},e),((r={})[a]=t,r))},{})),navigate:F,getHref:U,back:O};(null==k?void 0:k.redirect)&&F({id:k.redirect});var x=(null==k?void 0:k.element)||(null===(r=null==k?void 0:k.render)||void 0===r?void 0:r.call(k));return e.createElement(i.Provider,{value:j},x)};export{l as Router,i as RouterContext,u as useRouter};

package/build/types/router-react.d.ts

@@ -0,0 +1,51 @@
+import React from 'react';
+import { MultiLanguagePage, RouterOptions, SingleLanguagePage } from '@ossy/router';
+export declare const RouterContext: React.Context<{
+    pages: RouterPage[];
+    defaultLanguage: string | undefined;
+    supportedLanguages: string[];
+}>;
+export declare const useRouter: () => {
+    pages: RouterPage[];
+    defaultLanguage: string | undefined;
+    supportedLanguages: string[];
+};
+export declare const Router: <T extends RouterPage>({ url, pages, defaultLanguage, supportedLanguages }: RouterProps<T>) => React.JSX.Element;
+export interface RouterProps<T extends RouterPage> extends RouterOptions<T> {
+    /**
+     * Render page associated with the given url.
+     * Used to render the page on server side where window.location is not available
+     * @type string
+     * @default undefined
+    */
+    url?: string;
+}
+export type RouterPage = SingleLanguageRouterPage | MultiLanguageRouterPage;
+export interface SingleLanguageRouterPage extends SingleLanguagePage {
+    /** If provided the page will redirect to the given page id
+     * @default undefined
+     * @type {string}
+     * @example { redirect: '@home'}
+    */
+    redirect?: string;
+    element?: React.ReactNode;
+    render: () => React.ReactNode;
+}
+export interface MultiLanguageRouterPage extends MultiLanguagePage {
+    /** If provided the page will redirect to the given page id
+     * @default undefined
+     * @type {string}
+     * @example { redirect: '@home'}
+    */
+    redirect?: string;
+    element?: React.ReactNode;
+    render: () => React.ReactNode;
+}
+export interface GetHrefRequest {
+    id?: string;
+    language?: string;
+    params?: Record<string, string>;
+}
+export interface GetHrefOfActivePageByLanguageRequest {
+    language: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ossy/router-react",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ossy-se/packages.git"
@@ -57,5 +57,9 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
-  "gitHead": "80c0c70120640e7b389d1881a71b2376fd523095"
+  "files": [
+    "/build",
+    "README.md"
+  ],
+  "gitHead": "a768d71e76cc523f367cd764a403c0960f8d2e93"
 }

package/CHANGELOG.md

@@ -1,155 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## 0.1.3 (2025-10-31)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.1.2 (2025-10-31)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.1.1 (2025-10-31)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-# 0.1.0 (2025-10-30)
-
-
-### Features
-
-* **sdk:** get current workspace ([#4](https://github.com/ossy-se/packages/issues/4)) ([afce7d5](https://github.com/ossy-se/packages/commit/afce7d5787af42691f62c9eba672ea1be000e19e))
-
-
-
-
-
-## 0.0.16 (2025-10-30)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.15 (2025-10-27)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.14 (2025-10-27)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.13 (2025-10-27)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.12 (2025-10-27)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.11 (2025-10-27)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.10 (2025-10-25)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.9 (2025-10-25)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.8 (2025-10-25)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.7 (2025-10-25)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.6 (2025-10-25)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.5 (2025-10-25)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.4 (2025-10-25)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.3 (2025-10-25)
-
-**Note:** Version bump only for package @ossy/router-react
-
-
-
-
-
-## 0.0.2 (2025-10-25)
-
-**Note:** Version bump only for package @ossy/router-react

package/rollup.config.js

@@ -1,34 +0,0 @@
-import babel from '@rollup/plugin-babel'
-import { nodeResolve as resolveDependencies } from '@rollup/plugin-node-resolve'
-import resolveCommonJsDependencies from '@rollup/plugin-commonjs'
-import removeOwnPeerDependencies from 'rollup-plugin-peer-deps-external'
-import minifyJS from '@rollup/plugin-terser'
-import typescript from '@rollup/plugin-typescript'
-import preserveDirectives from "rollup-plugin-preserve-directives"
-
-export default [
-  {
-    input: 'src/router-react.tsx',
-    output: [
-      {
-        file: 'build/index.js',
-        format: 'esm'
-      }
-    ],
-    plugins: [
-      resolveCommonJsDependencies(),
-      resolveDependencies(),
-      removeOwnPeerDependencies(),
-      babel({
-        exclude: ['**/node_modules/**/*'],
-        presets: ['@babel/preset-react']
-      }),
-      minifyJS(),
-      preserveDirectives(),
-      typescript({
-        tsconfig: "./tsconfig.json",
-        outDir: 'build',
-      }),
-    ]
-  },
-]

package/src/router-react.tsx

@@ -1,253 +0,0 @@
-'use client'
-import React, { createContext, useContext, useCallback } from 'react'
-import { MultiLanguagePage, Router as BaseRouter, RouterOptions, SingleLanguagePage, Page as _Page } from '@ossy/router'
-
-export const RouterContext = createContext({
-  pages: [] as RouterPage[],
-  defaultLanguage: undefined as string | undefined,
-  supportedLanguages: [] as string[]
-})
-
-export const useRouter = () => useContext(RouterContext)
-
-
-const appendSlash = (string: string) => string[string.length - 1] === '/'
-  ? string : `${string}/`
-
-const prependSlash = (string: string) => string[0] === '/'
-  ? string : `/${string}`
-
-const padWithSlash = (string = '') => appendSlash(prependSlash(string))
-
-export const Router = <T extends RouterPage>({
-  url,
-  pages = [],
-  defaultLanguage = undefined,
-  supportedLanguages = []
-}: RouterProps<T> ) => {
-  let href: string;
-  let pathname: string;
-  let hash: string;
-  let search: string;
-
-  if (url) {
-    const urlParts = url.match(/([^?#]*)(\?[^#]*)?(#.*)?/);
-    href = url;
-    pathname = urlParts?.[1] || '';
-    hash = urlParts?.[3] || '';
-    search = urlParts?.[2] || '';
-  } else if (typeof window !== 'undefined') {
-     href = window.location.href
-     pathname = window.location.pathname
-     hash = window.location.hash
-     search = hash?.includes('?') ? hash.split('?')[1] :  window.location.search
-  } else {
-    return <></>
-  }
-
-  const isMultiLanguage = supportedLanguages.length > 1 && !!defaultLanguage
-  const potentialLanguage = pathname.split('/')[1] || ''
-  const language = supportedLanguages.includes(potentialLanguage) ? potentialLanguage : defaultLanguage
-  const router = BaseRouter.of<T>({ pages, defaultLanguage, supportedLanguages })
-  const params = router.getParamsFromUrl(href)
-  const searchParams = new URLSearchParams(search)
-
-  let activePage: T = router.getPageByUrl(href) as T
-
-  if (!activePage) {
-    if (isMultiLanguage) {
-      if (pathname === '/') {
-        if (typeof window !== 'undefined') {
-          window.location.href = '/' + defaultLanguage
-        }
-      }
-    }
-
-    activePage = isMultiLanguage
-      ? pages.find(page => padWithSlash((page.path as Record<string, string>)[(language as string)]) === '*') as T
-      : pages.find(page => padWithSlash(page.path as string) === '*') as T
-  }
-
-  if (!activePage) {
-    console.warn('[RouterReact] No active page found for', pathname)
-    return <></>
-  }
-
-  /**
-   * @deprecated router do not support setting client side only search params.
-   * Use getHref with search params instead
-   * 
-   * Note: That migh not be true though because we have the back() and navigate() functions....
-   */
-  const setSearchParam = useCallback((name: string, value: any) => {
-    if (typeof window === 'undefined') return
-    window.history.pushState({}, '', `${pathname}?${searchParams.toString()}`)
-    const newSearchParams = new URLSearchParams(searchParams)
-    newSearchParams.set(name, value)
-    history.pushState({ }, "", `?${newSearchParams.toString()}`)
-  }, [searchParams])
-
-  /**
-   * takes either a string id or an object with id, params and language
-   *  - params.id - id of the page to get the href for
-   *  - param.language - language to use for the href, defaults to current language
-   *  - param.params - params to use for the href, defaults to current params
-   * @param {string|object}
-   * @returns {string}
-   */
-  const getHref = useCallback((getHrefRequest: string | GetHrefRequest | GetHrefOfActivePageByLanguageRequest) => {
-    // Can be supplied from params, if not will be taken from active page
-    let _pageId: string;
-    let _params: Record<string, string> = {}
-    let _language: string | undefined;
-    
-    // Can only be supplied from params, will not be taken from active page
-    let hash: string | undefined;
-    let search: string | undefined;
-
-
-    if (typeof getHrefRequest === 'string') {
-      _pageId = getHrefRequest
-      _params = params
-      _language = language
-    } else if (isGetHrefOfActivePageByLanguageRequest(getHrefRequest)) {
-      _pageId = activePage.id
-      _params = params
-      _language = getHrefRequest.language
-    } else {
-      _pageId = getHrefRequest?.id || activePage.id
-      _params = getHrefRequest?.params || params
-      _language = getHrefRequest?.language || language
-    }
-
-    if (_pageId.includes('#')) {
-      const [_id, _hash] = _pageId.split('#')
-      _pageId = _id
-      hash = _hash
-
-      if (hash.includes('?')) {
-        const [_hash, _search] = _pageId.split('?')
-        hash = _hash
-        search = _search
-      }
-
-    } else if (_pageId.includes('?')) {
-      const [_id, _search] = _pageId.split('?')
-      _pageId = _id
-      search = _search
-    }
-
-    let pathname = router.getPathname({
-      id: _pageId.replace('@', ''),
-      params: _params,
-      language: _language
-    })
-
-    if (hash) {
-      pathname = pathname + '#' + hash
-    }
-
-    if (search) {
-      pathname = pathname + '?' + search
-    }
-
-    return pathname
-  }, [router, language])
-
-  const navigate = useCallback((navigationRequest: string | '@back' | GetHrefRequest | GetHrefOfActivePageByLanguageRequest) => {
-    if (typeof window === 'undefined') return
-    if (!navigationRequest) return
-
-    if (navigationRequest === '@back') {
-      window.history.back()
-      return
-    }
-
-    const href = getHref(navigationRequest)
-    if (!href) return
-    window.location.href = href
-    
-  }, [getHref])
-
-  const back = useCallback(() => {
-    if (typeof window === 'undefined') return
-    window.history.back()
-  }, [])
-
-  const context = {
-    href,
-    pages,
-    language,
-    defaultLanguage,
-    supportedLanguages,
-    params,
-    searchParams: {
-      ...Array.from(searchParams.entries()).reduce((all, [key, value]) => ({ ...all, [key]: value }), {}),
-      // set: setSearchParam
-    },
-    navigate,
-    getHref,
-    back,
-  }
-
-  if (activePage?.redirect) {
-    navigate({ id: activePage.redirect })
-  }
-  
-  const renderedPage = activePage?.element || activePage?.render?.()
-
-  return (
-      <RouterContext.Provider value={context}>
-         { renderedPage }
-      </RouterContext.Provider>
-  )
-
-}
-
-export interface RouterProps<T extends RouterPage> extends RouterOptions<T> {
-  /** 
-   * Render page associated with the given url.
-   * Used to render the page on server side where window.location is not available
-   * @type string
-   * @default undefined
-  */
-  url?: string;
-}
-
-export type RouterPage = SingleLanguageRouterPage | MultiLanguageRouterPage
-
-export interface SingleLanguageRouterPage extends SingleLanguagePage {
-  /** If provided the page will redirect to the given page id
-   * @default undefined
-   * @type {string}
-   * @example { redirect: '@home'}
-  */
-  redirect?: string;
-  element?: React.ReactNode;
-  render: () => React.ReactNode
-}
-
-export interface MultiLanguageRouterPage extends MultiLanguagePage {
-  /** If provided the page will redirect to the given page id
-   * @default undefined
-   * @type {string}
-   * @example { redirect: '@home'}
-  */
-  redirect?: string;
-  element?: React.ReactNode;
-  render: () => React.ReactNode
-}
-
-export interface GetHrefRequest {
-  id?: string;
-  language?: string;
-  params?: Record<string, string>;
-}
-
-export interface GetHrefOfActivePageByLanguageRequest {
-  language: string;
-}
-
-function isGetHrefOfActivePageByLanguageRequest(request: any): request is GetHrefOfActivePageByLanguageRequest {
-  return !request.id && request.language !== undefined
-}

package/tsconfig.json

@@ -1,27 +0,0 @@
-{
-    "compilerOptions": {
-      "target": "es5",
-      "lib": ["dom", "dom.iterable", "esnext"],
-      "allowJs": true,
-      "skipLibCheck": true,
-      "strict": true,
-      "forceConsistentCasingInFileNames": true,
-      "esModuleInterop": true,
-      "module": "esnext",
-      "moduleResolution": "node",
-      "resolveJsonModule": true,
-      "isolatedModules": true,
-      "jsx": "react",
-      "incremental": false,
-      "declaration": true,
-      "declarationDir": "./build/types"
-    },
-    "exclude": [
-      "build",
-      "node_modules",
-      "src/**/*.test.tsx",
-      "src/**/*.stories.tsx",
-      "rollup.config.js",
-      "src/data.mock.ts"
-    ]
-  }