Merge pull request #118 from curveball/all-links-option

Add a flag allowing users to see 'all links'

README.md

@@ -161,6 +161,13 @@ settings:
 * `hiddenRels` - List of relationship types that will be hidden from the user by
   default. This can be used for links that are simply not interesting for a human
   to see. (default: `['self', 'curies']`.
+* `fullBody` - If turned on, full JSON bodies are always rendered. This can also
+  be turned on during runtime by adding a `?_browser-fullbody` query parameter.
+* `allLinks` - By default the Browser will hide links from the 'Links' table
+  that will be rendered as 'navigation buttons', forms (templated links), or are
+  considered special (the 'self' link). While this might be a nicer interface
+  for an average user browsing the hypermedia graph, as a developer you might
+  just want to see all the links.
 
 Example:
 

src/components/links-table.tsx

@@ -10,7 +10,9 @@ export function LinksTable(props: PageProps) {
 
   for (const link of props.resourceState.links.getAll()) {
 
-    if (props.options.hiddenRels.includes(link.rel) || link.rel in props.options.navigationLinks || (link as any).rendered) {
+    if (!props.options.allLinks &&
+        (props.options.hiddenRels.includes(link.rel) || link.rel in props.options.navigationLinks || (link as any).rendered))
+    {
       continue;
     }
 

src/index.ts

@@ -213,6 +213,7 @@ function normalizeOptions(options?: Partial<Options>): Options {
     assetBaseUrl: '/_hal-browser/assets/',
     serveAssets: true,
     fullBody: false,
+    allLinks: false,
   };
 
   const tmpNavLinks = Object.assign(

src/types.ts

@@ -59,6 +59,18 @@ export type Options = {
    * query parameter
    */
   fullBody: boolean;
+
+  /**
+   * By default the Browser will hide links from the 'Links' table that will
+   * be rendered as 'navigation buttons', forms (templated links), or are
+   * considered special (the 'self' link).
+   *
+   * While this might be a nicer interface for an average user browsing the
+   * hypermedia graph, as a developer you might just want to see all the links
+   *
+   * Turning 'allLinks' on ensures that everything always shows.
+   */
+  allLinks: boolean;
 };
 
 /**