page-tree-navigation v1.2.6

Page Tree Navigation

This provides support for navigating through a collection of pages with their own nested subpages. This includes support for tables of content, breadcrumb trails, page searches, and next/previous navigation through such trees.

Quickstart

Installation

You can install this library though npm like so:

$ npm install --save page-tree-navigation

Note that this takes advantage of the key-crawler library for a lot of it's traversal functionality.

Content Trees

Many utility classes in this library take advantage of the ContentNode generic class. Each such node consists of a typed content property and a children property for their child nodes.

PageTreeNode builds further on this by attaching the following properties to such nodes:

• id: A unique identifier for the node within the node tree.
• localName: An identifier that should be unique within the context of an ancestor with it's own local name or id.
• title: A name/description for the page meant to be displayed to users.

If you want key crawler functionality for these trees, you can use the IndexedContentTreeCrawler subclass or create a key crawler with getValidIndexedNodeVertex as a vertex factory rule. As the names suggests, these create abbreviated paths by the node's child index. For example, a path of 'pages0.children1' would abbreviate down to '0.1'.

If you want the crawler to use the full path, use the ContentCrawler subclass or getValidContentNodeVertex factory rule. This can useful if you want to reference the node's content. If that content is a tree itself you may need to add extra rules to reference subcontent.

As of 1.2.5 we've added the getPagesById function to group pages by id. This can be used to check for unused ids as well as multiple pages with the same id.

Content Locks

As of 1.2.0, you can attach a lock to content nodes. These locks can be used to indicate what actions should be usable on the target node. Such locks have 2 optional properties: permissions and exceptions.

A lock's permissions value can be either a boolean or map of boolean's by permission name. If a boolean it's assumed said booleans value applies to all permissions.

The exceptions property is used to override the default values for each permission as indicated by the above property. Each such exception consists of a token and changes property. The token is a string to be matched against the user's access tokens to determine if the exception applies. The changes value is the same kind of boolean / boolean map as the permissions property.

Content Permissions Reader

We've provided a ContentPermissionsReader class to help you check the permissions for a given user in regards to a particular content lock. Each such reader can have a token matching function provided in it's constructor. The function will be applied to pairs of access tokens and exception tokens to determine whether the expection applies when said access token is provided.

To get the permissions for a particular user, simply call getContentLockPermissions with the target content lock and user access tokens as the parameters. This will use the above function to apply all exceptions that match the provided access to the resulting permissions value.

Should you want to check a particular permission from said permissions value, you can use getPermission with that permission value as the first parameter and the name of the permission as the second.

If you have a content route, you can get the permissions value for the target using getRoutePermissions. Should the target node not have it's own content lock, this will use the lock of the nearest ancestor with such a lock instead.

Sample permissions

As of 1.2.1, we've provided sample permission enums. SamplePagePermissions include view, edit content, edit children, remove, and unlock permissions. SampleDocumentPermissions currently only cover edit style permissions.

Version 1.2.6 adds lock, rename, and publish permissions to sample page permissions.

Linear Navigation

If you want to go to the first, previous, next, or last node of a content tree, you can do so with the LinearTreeNavigator class. This takes a key crawler as it's only constructor parameter. You'll usually want the IndexedContentTreeCrawler for content node trees, like so:

  const nav = new LinearTreeNavigator(
    new IndexedContentTreeCrawler()
  )

Not that this ordering is a based preorder depth-first traversal. This mirror how a table of content maps to document content, where it starts at the first section listed advances into the first subsection from there.

Links

This libray provides support for anchor elements through HyperlinkSummary objects. These consist of text, href, and target strings.

These summaries are usually generated though a RouteLinkFactory. These take a text callback, href callback, and optional target string as their constructor parameters. The callbacks both take in key-crawler traversal routes as their sole parameter and return strings.

The PageLinkFactory variant only requires the href callback with an indexed title callback and target string as optional parameters. These will use the node's title for the text if the node has that property. If not, it will back using that indexed title callback with the node's index or simply convert the index to a string if that callback was not provided.

Table of Contents

TableOfContentsFactory instances convert content node trees to a tree of TableOfContentsNode entries. Each table of contents node contains a hyperlink summary (link property) that references the target content tree node. While implementing the display for such a table is up to you, this does the leg work of setting up the references and text for that table.

Each such factory expects a route link factory as it's first and only constructor parameter. To actually create the table of contents tree, simply call the factory's mapContentNodes function with the array of content nodes to be converted.

As of 1.2.0, table of content nodes can have a permissions value attached to them. These get automatically populated using the factory's attached permissionsReader. Should you want to customize a table of content to a particular user, you can pass access tokens to mapContentNodes and mapRoute. You can also pass viewPermission in as the third parameter to mapContentNodes. Doing so will cause anything with the named permission set to false will be trimmed from the resulting table of contents tree.

As of 1.2.2 you can choose to skip this trimming of hidden nodes by setting the 4th parameter to false. This is mainly useful if you want to keep the indices of the table in sync with those of the document tree. Note that the mapping function will still skip processing the children of hidden nodes.

Breadcrumbs

BreadcrumbFactory instances create links to all non-array object steps along a given route. As with table of content factories, these take in a route link factory as their constructor parameter. Once set up, simply call getRouteLinks with the target traversal route and it will return an array of hyperlink summaries for step along that route.

As the name suggests, this is useful if you want to provide links to parents of the current page / content. The bit about only creating links for non-array objects means you'll only get links for the content nodes themselves, not the child lists.

Reversible Text Parsers

While you can create your own href callback functions, we have provided some parsers to help with that. As an added benefit, they can also be used to resolve such links back into routes. These are based on the generic ReversibleTextParser interface, with a parse method for extracting data from a string and a stringify method to encode said data in a string. For href callbacks you'll want to use the stringify function.

Delimited Path Parsers

The most basic of these is the DelimitedPathParser. That simply parses with a string split and stringifies with an array join. Both use the instance's delimiter property. You can specify that in the constructor, but it defaults to dot notation (".").

Delimiter Encoded Path Parsers

DelimiterEncodedPathParser is a bit more complex as it lets you specify multiple delimiters and map them to specific property names. Said delimiter map must be passed into the parser's constructor. This is usefull for full content paths there you can reference both the childred and content properties. For example this:

  const parser = new DelimiterEncodedPathParser({
    'children': '/',
    'content': '.'
  })

Would convert "pages.children0.children1.content2" to "0.1/2".

Phased Path Parsers

For more complex operations you may want to use a PhasedPathParser instance. These break parsing down into the following steps with their corresponding sub-parsers:

• stringParser - Removes any encoding or extra characters from the string.
• splitter - Breaks the decoded string into component substrings.
• stepParser - Performs any needed conversion on each substring to get it to the right data type.

You can specify these the above order in the phased parser's constructor. Of those only the splitter is critical and it defaults to a delimited path parser with dot notation. These parsers get used in reverse order to stringify a provided path.

On the string parser front, we've provided the EnclosedTextParser class for handling wrapped text. When creating such a parser, you may specify a prefix and suffix in the constructor. This can be used for basic url handling where the path is part of the url.

For step conversion, we've got the NumericTextParser class. That will try to convert the provided string to a number, but will leave it unchanged if text can not be converted. This is useful for dealing with paths that mix numbers and strings.

Should you potentially have symbols in your path, you can use the ValidKeyParser instead. That functions much the same but can safely stringify symbols as well as numbers. It also lets you speficy a string prefix in the constructor. The parser will them try to convert any string that start with that prefix back to symbols when parsing them.

URL Parameter Parsing

Another option for dealing with url strings is the KeyedURLValuesParser class. That extracts a paramter map from parsed string and creates url strings from such maps. This can help if you want to break the path into parts, such as a page path and subcontent path.

Each such parser relies on it's template to determine how to extract and insert those parameters. The template has the following properties:

• origin - A string covering the url's domain.
• path - An array of strings and path tokens.
• hash - An optional string or key wrapper.
• search - An optional map of query parameter names to text or key wrappers.

The key wrappers used by the hash and search properties are simply objects with a "key" property that references the target parameter name. Their being objects simply makes parsing easier as we can use type checks to detect them.

The path tokens used by the path property are similar, but can also have a "placeholder" string to use if the target parameter does not exist. This helps prevent double slashes in the url for missing parameters.

Note that if you don't specify any template it will default to one with an empty string for the origin and an empty array for the path. You can also specify a base path for the parser as it's second constructor parameter. This is only used to safely convert the provided string to a URL object internally before parameter extraction.

Searches

Should you want to search for a particular content node, you can do so with the relevant key crawler's search functions. This gets significantly more complicated if you want to perform nested searches, such as getting the a sub-page with a particular local name form an identified parent page.

While you can handle that with a series of searches, we're provided the SearchPathResolver class to help with that. For each instance you need only call it's resolve function with the root object and a search path as the parameters. As with a key crawler search, you can also provide a max results limitation as the 3rd parameter to cut things short early. Said path can be any combination of objects and keys (numbers, strings, or symbols).

Each such resolver will use it's list of term rules to determine the search to perform for a given path step. You can pass this rules list into the constructor or assign it after the fact to the termRules property.

Each of those rules is a callback function that takes a traversal state, search term, and visitation callback as it's parameters and returns true if the search term is a valid one for that rule. The resolver will pass search handling on to the first callback that return true for it and skip all remaining rules. That visitation callback will in turn be called for each node it finds that matches the rule's criteria.

Search Term Callback Factories

An easy way to generate search path rules is with a SearchTermCallbackFactory. These provide a getSearchCallback and

getSearchCallback expects a check generation callback and allows a "shallow" flag as it's second parameter. The check generation callback accepts a term returns a check callback if the term is valid. Said check callback takes in a traversal state and returns either true or false.

The "shallow" flag tells the search to skip iterating though any descendants of a matching node. This can be useful for things like idenfier searches.

getKeyCallback is significantly simpler, returning a rule that treats all non-object terms as keys and directing the search to the node pointed at by that key. In effect this lets you combine normal path keys with more elaborate search steps. That allows for things like "get the first child of the node with the following id".

As of 1.2.3, there's also a getPropertyItemAtCallback. This lets you try to apply indices to an object by checking the provided properties by name, applying that index to the first such array property found. This is mainly used to build search handlers that can handle index paths as well as more explicit property paths.

Property Searches

PropertySearchFactory simplifies more setting up checks for specific property values. Just use the getPropertySearch to generate a search rule to will treat any object with the "key" property as a property check. Said check will return true true if the target node has a property whose name matches the term's key and whose value matches the term's "value" property. For example, giving it the term { key: "id", value: "main" } would return true for a node whose id is "main".

Should you want that rule and above getKeyCallback rule enabled by default you can use the PageTreeSearchResolver as it comes with both of those.

Routing by Name

You may have noticed that generating hyperlinks by traversal paths is accurate but not the most readable. They're also prone to breaking if the target node is moved to another point in the tree.

One way to mitigate these is use the page's id and/or local name in the hyperlink string. To help with this, we've provided the NamedPageRouteParser class. Such parsers will try to replace part of the path with page id or local name strings where possible.

By default it handles these separating the page path and content subpath with a slash. The page pathing uses a tilde (~) at the start to mark an id search and .~ to mark a local name search, with period separator between child indices. In contrast, the content path just used a period delimiter.

For example, ~main.~terms.0/body.text would convert to:

  [
    { key: 'id', value: 'main' },
    { key: 'localName', value: 'terms' },
    'children',
    0,
    'content',
    'body',
    'text'
  ]

You can override that "pagePath/contentPath" breakdown by passing a different string map parser in as the first parameter, such a KeyedURLValuesParser. Such parser should use "pagePath" and "contentPath" as it's parameters.

Note that this still keeps the page path encoding. To change that you'd need to change the "pathParser" property. This defaults to a PageContentPathParser. Those are composed of the following subparsers:

• paramParser - Extracts pagePath and contentPath parameters from the provided string.
• pageParser - Converts the page path to specific terms. This is the part that provides the rules for marking searches with a special prefix.
• contentParser - Converts the content path to substrings.

Prior to version 1.1.0 the constructor had more parameters, but the functionality has since been split amoung sub-components.

Note that the NamedPageRouteParser is a specialized RouteSearchParser subclass. Should you want to make your own such parser to handle string to route conversions, you can create one with the following parameters:

• pathParser - Converts strings to search terms and vice versa.
• searchResolver - Handles resolving the above search within the provided context.
• getSearch - Extracts a search path from a traversal route.
• context - Object to search within then resolving a route.

Publication

As of version 1.2.0, we've added support for attaching PublicationData to pages and documents via their published property. Said property is a list of PublicationData entries. Each entry will at minimum have an on property containing their publication date. They can also have the following properties:

• as - id of the property at time of publication
• by - name / id of the content's creator / owner
• version - optional version string

To attach this data, simply pass the target into the publishItem utility function. This will automatically attach the publication date and will try to set the entry's as property based on it's current id. The function also lets you provide the author and version as additional parameters.

Compilation Functions

Version 1.2.0 introduces some helpful utility functions for combining documents, making it easier to create a compilation that combines multiple documents in one.

getStyleRulesConflicts can be used to check if two documents have any conflicting style rules. Simply pass the style for both documents in as parameters. The result will be a list of pairings where each entry has a rule from each list that share selectors but have different effects. If the resulting list is empty, there are no conflicts.

Should you have no conflicts or be good with overwriting some rules, you can use extendStyleRules to merge multiple style rule sets. This will take the rules from all provided sets. If multiple sets have a rule with the same selector, it gives precedence to later parameters.

getDocumentAsPage converts a PageTreeDocument to a PageTreeNode. Note that since documents don't have content on their own you'll need to provide that as it's second parameter. Note that the resulting page will contain a reference to the original document in the page's source property. Note that the style rules aren't supported in content nodes by default, so you'll need to modify the rules of the document you're adding the page to if you want those style rules to get applied.