fix replace history state when using deep path URL

[sroucheray]

Replacing history state did not work when RapiDoc component is delivered in a deep URL web page (i.e. http://www.mysite.com/deep/link/rapidoc).

Rapidoc calls on history.replaceState did not always use the full URL (was not DRY). So in some cases we ended up with URLs like http://www.mysite.com#overview instead of http://www.mysite.com/deep/link/rapidoc#overview.

[mrin9]

The idea is to support 2 styles of routes

• Routes with hash #
• Routes without hash

Frameworks like react, vue angular routing do not use hash in there routes
therefore routePrefix is used

at the end the route is constructed like
{current-location} + {routePrefix} + {elementId}
where

• current-location is location of the index.html in case of plain html or it will be location.origin in case of vue/react/angular etc
• routePrefix will be # in case of html or will be a non-blank value in case of vue/react/angular etc
• elementId is the id of the element
• Note that presence of routePrefix determines are we generating hash based routes or non-hash routes

So

• in case of plain html the final route can be
  • http://example.com/index.html#element-id-1
    • current-location = http://example.com/index.html
    • routePrefix = '' (coz routePrefix =='' we use # instead)
    • elementId = element-id-1
    • the final route looks like http://example.com/index.html#element-id-1
• in case of a framework, where rapidoc is loaded on a page in (vue/react etc) the route may look like
  • http://example.com/api-doc/element-id-1
    • current-location = http://example.com (location.origin)
    • routePrefix = 'api-doc'
    • elementId = element-id-1
    • the final route looks like http://example.com/api-doc/element-id-1

keeping this as the goal, this code needs some change as it assumes there will always be a hash in the route

in case of frameworks the replaceState should change

• from http://example.com/api-doc/element-id-1
• to http://example.com/api-doc/element-id-2

but in this case it will change to
http://example.com/api-doc/element-id-1 + api-doc + element-id-2

[mrin9]

in the deep-link example you provided above for the reason of this PR
can you try setting routePrefix = '/deep/link/rapidoc#' and check if it takes care of your situation ?

[sroucheray]

I made some changes to my PR. Following your explanations I tested it more thoroughly in a combination of many cases:

• render style: view, read, focused
• with or without route prefix
• within a deep path or not

I think this PR fix also small bugs where RapiDoc does not take into account the hash, for example here https://rapidocweb.com/examples/read-mode.html#get-/store/order/-orderId- (the hash is changed when the page loads at least in Chrome on Linux).

With this PR, the ID of an element (to open or to scroll to) is extracted from the URL whether it is in a hash or in the URL path with a routePrefix.

I made a lot of tests manually. I think for the sake of the project it would be good to have unit tests to avoid regression and make sure I don't introduce one :)

[mrin9]

thank you for the contribution, another nice feature and code cleanup !!!