neetjn / core-routing Goto Github PK

View Code? Open in Web Editor NEW

0.0 2.0 0.0 1.03 MB

Framework agnostic interface for client sided routing using the HTML5 history api.

License: MIT License

JavaScript 39.52% TypeScript 60.48%

framework js javascript node routing client route

core-routing's People

Contributors

Watchers

core-routing's Issues

complete router tools and implement in router

core-routing/src/router.ts

Lines 8 to 13 in 54af60c

 // TODO: complete router tools and implement in router 

 class RouterTools implements IRouterTools { 

 process(route: string, source: string) { 

 return { 

 };

This issue was generated by todo based on a `TODO` comment in `54af60c`. It's been assigned to @neetjn because they committed the code.

Feature Request: Event emitter in observer pattern form for flexible use.

Is your feature request related to a problem? Please describe.
TBD

Describe the solution you'd like
In addition to the provided router client, I would like to provide an optional event emitter in the form of the observer/subscriber pattern. See Events and riot-observable for possible implementation specifications.

Describe alternatives you've considered
The client structure makes sense, and helps ensure a clean implementation for 3rd party applications. However, for more dynamic applications I'd like to provide a more flexible api.

Additional context
TBD

revise when implementing fragment identification

core-routing/src/router.ts

Lines 42 to 47 in af58772

 // TODO: revise when implementing fragment identification 

 parts = parts.join('').split('#')[0].split(''); 

 } 

 // remove query arguments from route 

 // remove expected empty first element 

 parts = parts.join('').split('?')[0].split('/').slice(1);

This issue was generated by todo based on a `TODO` comment in `af58772`. It's been assigned to @neetjn because they committed the code.

Complete basic README markup.

implement optional localStorage cache w/ config

core-routing/src/router.ts

Lines 16 to 21 in af58772

 // TODO: implement optional localStorage cache w/ config 

 this.cache = { 

 split: {}, 

 match: {}, 

 process: {} 

 };

This issue was generated by todo based on a `TODO` comment in `af58772`. It's been assigned to @neetjn because they committed the code.

add test for config

core-routing/__test__/router.test.js

Lines 4 to 9 in e1fec08

 // TODO: add test for config 

 // TODO: add test for legacy support 

 describe('Router', () => { 

 const navigate = route => { 

 window.location.hash = `#!${route}`

This issue was generated by todo based on a `TODO` comment in `e1fec08`. It's been assigned to @neetjn because they committed the code.

left here, process route details using source

core-routing/src/router.ts

Lines 91 to 96 in af58772

 // TODO: left here, process route details using source 

 return { 

 }; 

 } 

 }

This issue was generated by todo based on a `TODO` comment in `af58772`. It's been assigned to @neetjn because they committed the code.

complete functional protoype -->

core-routing/prototype.html

Lines 9 to 14 in d8710ed

 <!-- TODO: complete functional protoype --> 

 <script> 

 window.onload = (e) => { 

 const context = document.querySelector('#context'); 

 const routes = [ 

 {

This issue was generated by todo based on a `TODO` comment in `d8710ed`. It's been assigned to @neetjn because they committed the code.

Add npm ignore to ignore none bundle modules and reduce package size.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

add documentation

core-routing/src/router.ts

Lines 6 to 11 in 54af60c

 // TODO: add documentation 

 // TODO: complete router tools and implement in router 

 class RouterTools implements IRouterTools { 

 process(route: string, source: string) { 

 return {

This issue was generated by todo based on a `TODO` comment in `54af60c`. It's been assigned to @neetjn because they committed the code.

Bug: Matching not working for path "/"

Describe the bug
The matching logic for the router is not matching the path "/".

Ref: https://github.com/neetjn/core-routing/blob/master/src/router.ts#L62
In example: https://github.com/neetjn/riot-routing-prototype/blob/master/src/components/router.riot#L38

To Reproduce
Steps to reproduce the behavior:

Create a new instance of the router.
In the interface, on either onStart or onNavigate -- try matching the current or incoming route path with "/".
Notice there is no match.

Expected behavior
The path "/" should properly be matched.

0.0.2 - Roadmap

With the riot-routing projects in the work as a replacement for riot-view-routing, I wanted to design a framework agnostic interface for client sided routing.

Roadmap - 0.0.2

Core Proposals

~~Provide test(s) for configuration: Issue 14~~
~~Provide test for legacy support: Issue 15~~
~~Provide proper code documentation: Issue 2~~
~~Complete README: Issue 22~~

Feature Requests

~~Event emitter in observer pattern form for flexible use: Issue 20~~

Bugs

~~Matching not working for path "/": Issue 18~~

0.0.3 - Roadmap

With the riot-routing projects in the work as a replacement for riot-view-routing, I wanted to design a framework agnostic interface for client sided routing.

Roadmap - 0.0.3

Core Proposals

TBD

Feature Requests

TBD

leverage typescript decorator for memoize

core-routing/src/router.ts

Lines 11 to 16 in af58772

 // TODO: leverage typescript decorator for memoize 

 public cache: IRouterToolsCache; 

 constructor (config: IConfig) { 

 this.config = config; 

 // TODO: implement optional localStorage cache w/ config

This issue was generated by todo based on a `TODO` comment in `af58772`. It's been assigned to @neetjn because they committed the code.

resolve matching logic

core-routing/src/router.ts

Lines 57 to 62 in c624f83

 // TODO: resolve matching logic 

 if (source !== this.config.settings.wildcard) { 

 const result = this.inspect(route, source); 

 if (result.route.length === result.source.length) { 

 for (const i in result.source) {

This issue was generated by todo based on a `TODO` comment in `c624f83`. It's been assigned to @neetjn because they committed the code.

Fragment Identification

placeholder issue for fragment identification
Q: Do we pop an event?

ensure stop works as expected when binding watcher

core-routing/src/router.ts

Lines 173 to 176 in af58772

 // TODO: ensure stop works as expected when binding watcher 

 if (this.running) { 

 this.running = false; 

 if (this.client && this.client.onStop) {

This issue was generated by todo based on a `TODO` comment in `af58772`. It's been assigned to @neetjn because they committed the code.

figure out why watch not called with history.pushState

core-routing/src/router.ts

Lines 48 to 52 in 54af60c

 // TODO: figure out why watch not called with history.pushState 

 console.log('watch called?'); 

 if (this.running) { 

 if (this.client && this.client.onNavigate) { 

 this.client.onNavigate({

This issue was generated by todo based on a `TODO` comment in `54af60c`. It's been assigned to @neetjn because they committed the code.

make ambiguous, must be able to run only on route change w/ interval

core-routing/src/router.ts

Lines 52 to 57 in ac8a1d2

 // TODO: make ambiguous, must be able to run only on route change w/ interval 

 if (this.running) { 

 // let navigated = 

 if (this.client && this.client.onNavigate) { 

 this.client.onNavigate({

This issue was generated by todo based on a `TODO` comment in `ac8a1d2`. It's been assigned to @neetjn because they committed the code.

add test for legacy support

core-routing/__test__/router.test.js

Lines 5 to 10 in e1fec08

 // TODO: add test for legacy support 

 describe('Router', () => { 

 const navigate = route => { 

 window.location.hash = `#!${route}` 

 window.dispatchEvent(new Event('popstate'))

This issue was generated by todo based on a `TODO` comment in `e1fec08`. It's been assigned to @neetjn because they committed the code.

0.0.1 - Roadmap

With the riot-routing projects in the work as a replacement for riot-view-routing, I wanted to design a framework agnostic interface for client sided routing.

Roadmap - 0.0.1

Create basic project structure.
Define types.
Provide basic interface for subscribing to route changes.
Create functional tests using Jest/Jest-Dom.
Write basic documentation for code, provide project documentation in README.
Wire up project with either Git Actions or Travis CI.

	// TODO: complete router tools and implement in router
	class RouterTools implements IRouterTools {
	process(route: string, source: string) {
	return {

	};

	// TODO: revise when implementing fragment identification
	parts = parts.join('').split('#')[0].split('');
	}
	// remove query arguments from route
	// remove expected empty first element
	parts = parts.join('').split('?')[0].split('/').slice(1);

	// TODO: implement optional localStorage cache w/ config
	this.cache = {
	split: {},
	match: {},
	process: {}
	};

	// TODO: add test for config
	// TODO: add test for legacy support

	describe('Router', () => {
	const navigate = route => {
	window.location.hash = `#!${route}`

	// TODO: left here, process route details using source
	return {

	};
	}
	}

	<!-- TODO: complete functional protoype -->
	<script>
	window.onload = (e) => {
	const context = document.querySelector('#context');
	const routes = [
	{

	// TODO: add documentation

	// TODO: complete router tools and implement in router
	class RouterTools implements IRouterTools {
	process(route: string, source: string) {
	return {

	// TODO: leverage typescript decorator for memoize
	public cache: IRouterToolsCache;

	constructor (config: IConfig) {
	this.config = config;
	// TODO: implement optional localStorage cache w/ config

	// TODO: resolve matching logic
	if (source !== this.config.settings.wildcard) {
	const result = this.inspect(route, source);

	if (result.route.length === result.source.length) {
	for (const i in result.source) {

	// TODO: ensure stop works as expected when binding watcher
	if (this.running) {
	this.running = false;
	if (this.client && this.client.onStop) {

	// TODO: figure out why watch not called with history.pushState
	console.log('watch called?');
	if (this.running) {
	if (this.client && this.client.onNavigate) {
	this.client.onNavigate({

	// TODO: make ambiguous, must be able to run only on route change w/ interval

	if (this.running) {
	// let navigated =
	if (this.client && this.client.onNavigate) {
	this.client.onNavigate({

neetjn / core-routing Goto Github PK

core-routing's People

Contributors

Watchers

core-routing's Issues

This issue was generated by todo based on a TODO comment in 54af60c. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in af58772. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in af58772. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in e1fec08. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in af58772. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in d8710ed. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in 54af60c. It's been assigned to @neetjn because they committed the code.

Roadmap - 0.0.2

Core Proposals

Feature Requests

Bugs

Roadmap - 0.0.3

Core Proposals

Feature Requests

This issue was generated by todo based on a TODO comment in af58772. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in c624f83. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in af58772. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in 54af60c. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in ac8a1d2. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a TODO comment in e1fec08. It's been assigned to @neetjn because they committed the code.

Roadmap - 0.0.1

Recommend Projects

Recommend Topics

Recommend Org

This issue was generated by todo based on a `TODO` comment in `54af60c`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `af58772`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `af58772`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `e1fec08`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `af58772`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `d8710ed`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `54af60c`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `af58772`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `c624f83`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `af58772`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `54af60c`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `ac8a1d2`. It's been assigned to @neetjn because they committed the code.

This issue was generated by todo based on a `TODO` comment in `e1fec08`. It's been assigned to @neetjn because they committed the code.