fix optional arguments bug

README.md

@@ -19,11 +19,10 @@ This lightweight (~215 lines) VanJS addon adds the following features:
     - pass additional context data such as a prefetched data or other configuration to route component
 - TypeScript support
 
-# Beta
+### Official release
 
-🚨 Van Cone is in Beta 🚨
+Van Cone has reached version 1.0.0 and is no longer in beta.
 
-Van Cone is close but not quite out of beta, so use with your own caution.
 
 # Overview
 
@@ -95,6 +94,10 @@ Example HTML:
 
 # Changelog
 
+**1.0.0**
+- fix issue #4 - argument for `navigate` and `pushHistory` functions
+- Van Cone is out of beta and is API stable
+
 **0.0.8**
 - fix type definitions for `navigate` and `pushHistory` functions
 

docs/getting-started.md

@@ -15,6 +15,10 @@ Van Cone has only one exported function [`createCone`](./api-reference.md#create
 ### TypeScript
 - Supported! 🥳
 
+### Official release
+
+Van Cone has reached version 1.0.0 and is no longer in beta! 🥳
+
 # Your first Van Cone App
 
 Init your npm project

examples/component-routing/package.json

@@ -12,7 +12,7 @@
     "test-report": "npx playwright show-report"
   },
   "dependencies": {
-    "van-cone": "^0.0.8",
+    "van-cone": "^1.0.0",
     "vanjs-core": "^1.2.7"
   },
   "devDependencies": {

examples/component-routing/src/index.js

@@ -1,9 +1,17 @@
 import createCone from 'van-cone'
 import van from 'vanjs-core'
-const { div, span, hr } = van.tags
+const { div, span, hr, button, br } = van.tags
 
 // define page components
-const homePage = div('Home Page')
+const homePage = div(
+  'Home Page', 
+  br(),
+  // these buttons exists to test the navigation functions
+  button({onclick: () => navigate('default')}, 'test navigation function - wo options'), br(),
+  button({onclick: () => navigate('default', {query: {'x': '1', 'y': '2'}})}, 'test navigation function - w options'), br(),
+  button({onclick: () => pushHistory('default')}, 'test pushHistory function - wo options'), br(),
+  button({onclick: () => pushHistory('default', {query: {'x': '1', 'y': '2'}})}, 'test pushHistory function - w options')
+)
 const vanJSElementPage = div('Van JS Element Page')
 const functionPage = () => div('Function Page')
 
@@ -17,7 +25,7 @@ const fromStringPage = '<div>From String Page</div>'
 
 // create the spa object
 const routerElement = div({ id: 'layout' })
-const { link, route } = createCone({routerElement: routerElement})
+const { link, route, navigate, pushHistory } = createCone({routerElement: routerElement})
 
 route('home', '/', homePage)
 route('van-element', '/van-element', vanJSElementPage)

examples/component-routing/tests/component-routing.spec.ts

@@ -27,4 +27,24 @@ test('test', async ({ page }) => {
 
   await page.getByRole('link', { name: 'Non Default String' }).click();
   await expect(page.locator('#layout')).toContainText('Non Default String Page');
+});
+
+test('test navigate function', async ({ page }) => {
+  await page.goto('http://localhost:5173');
+  await page.getByRole('button', { name: 'test navigation function - wo options' }).click();
+  await expect(page.locator('#layout')).toContainText('Default Export Page');
+
+  await page.goto('http://localhost:5173');
+  await page.getByRole('button', { name: 'test navigation function - w options' }).click();
+  await expect(page.locator('#layout')).toContainText('Default Export Page');
+});
+
+test('test pushHistory function', async ({ page }) => {
+  await page.goto('http://localhost:5173');
+  await page.getByRole('button', { name: 'test pushHistory function - wo options' }).click();
+  await expect(page.locator('#layout')).toContainText('Home Page');
+
+  await page.goto('http://localhost:5173');
+  await page.getByRole('button', { name: 'test pushHistory function - w options' }).click();
+  await expect(page.locator('#layout')).toContainText('Home Page');
 });

examples/hello-world/package.json

@@ -12,7 +12,7 @@
     "test-report": "npx playwright show-report"
   },
   "dependencies": {
-    "van-cone": "^0.0.8",
+    "van-cone": "^1.0.0",
     "vanjs-core": "^1.2.7"
   },
   "devDependencies": {

examples/spa-app/package.json

@@ -18,7 +18,7 @@
     "vite-bundle-visualizer": "^0.7.0"
   },
   "dependencies": {
-    "van-cone": "^0.0.8",
+    "van-cone": "^1.0.0",
     "vanjs-core": "^1.2.7"
   }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "van-cone",
-  "version": "0.0.8",
+  "version": "1.0.0",
   "description": "a lightweight package providing basic SPA such as routing, history and navigation functionality for VanJS applications",
   "homepage": "https://medium-tech.github.io/van-cone-website",
   "repository": {

src/spa.d.ts

@@ -21,10 +21,10 @@ declare type RouteHandlerProps = {
 };
 
 declare type NavigateOptions = {
-  params: RouteParams;
-  query: QueryParams;
-  navState: NavState;
-  context: RouterContext;
+  params?: RouteParams;
+  query?: QueryParams;
+  navState?: NavState;
+  context?: RouterContext;
 };
 
 declare type RouterConfig = {

src/spa.js

@@ -158,18 +158,19 @@ function createCone(coneConfig) {
 
     // navigation functions
     const navigate = (routeName, options) => {
-        const { params, query, navState, context } = options
+        const { params, query, navState, context, dispatch } = options || {}
         const url = router.navUrl(routeName, params, query)
 
         if (typeof navState !== 'undefined') setNavState(navState)
         history.pushState(getNavState(), '', url);
 
-        if (typeof options.dispatch === 'undefined' || options.dispatch === true) router.dispatch(url, context)
+        if (typeof dispatch === 'undefined' || dispatch === true) router.dispatch(url, context)
 
         return url
     }
 
     const pushHistory = (routeName, options) => {
+        options = options || {}
         options.dispatch = false
         return navigate(routeName, options)
     }