lit-ui-router 1.1.2 → 1.2.1

package/dist/core.d.ts

@@ -1,5 +1,5 @@
 import { PathNode, StateObject, UIRouter, ViewConfig, _ViewDeclaration } from '@uirouter/core';
-import { RoutedLitElement, LitViewDeclaration, LitViewDeclarationTemplate, NormalizedLitViewDeclaration } from './interface.js';
+import { RoutedLitElement, LitViewDeclaration, LitViewDeclarationTemplate, NormalizedLitViewDeclaration, LitViewDeclarationElement, DefaultResolvesType } from './interface.js';
 /**
  * Configuration for a Lit view instance.
  *
@@ -38,7 +38,7 @@ export declare class LitViewConfig implements ViewConfig {
  * @returns True if the config is a template function
  * @internal
  */
-export declare function isLitViewDeclarationTemplate(config: LitViewDeclaration): config is LitViewDeclarationTemplate;
+export declare function isLitViewDeclarationTemplate<T extends DefaultResolvesType = DefaultResolvesType>(config: LitViewDeclaration<T>): config is LitViewDeclarationTemplate<T> | LitViewDeclarationElement<T>;
 /**
  * Type guard to check if a component is a RoutedLitElement class.
  *
@@ -46,7 +46,7 @@ export declare function isLitViewDeclarationTemplate(config: LitViewDeclaration)
  * @returns True if the component is a LitElement class
  * @internal
  */
-export declare function isRoutedLitElement(component?: unknown): component is RoutedLitElement;
+export declare function isRoutedLitElement<T extends DefaultResolvesType = DefaultResolvesType>(component?: unknown): component is RoutedLitElement<T>;
 /**
  * State builder function for Lit views.
  *
@@ -60,7 +60,7 @@ export declare function isRoutedLitElement(component?: unknown): component is Ro
  * @returns The normalized views object
  * @internal
  */
-export declare function litViewsBuilder(state: StateObject): Record<string, NormalizedLitViewDeclaration>;
+export declare function litViewsBuilder<T extends DefaultResolvesType = DefaultResolvesType>(state: StateObject): Record<string, NormalizedLitViewDeclaration<T>>;
 /**
  * The main router class for Lit applications.
  *

package/dist/core.js

@@ -83,27 +83,33 @@ export function litViewsBuilder(state) {
         $default: pick(state, ['component']),
     };
     forEach(viewsObject, function (config, name) {
+        let normalizedConfig;
         name = name || '$default'; // Account for views: { "": { template... } }
-        if (isLitViewDeclarationTemplate(config))
-            config = { component: config };
-        if (Object.keys(config || {}).length === 0)
+        if (isLitViewDeclarationTemplate(config)) {
+            normalizedConfig = { component: config };
+        }
+        else {
+            normalizedConfig = config;
+        }
+        if (Object.keys(normalizedConfig || {}).length === 0)
             return;
-        config.$type = 'lit';
-        config.$context = state;
-        config.$name = name;
-        const normalized = ViewService.normalizeUIViewTarget(config.$context, config.$name);
-        config.$uiViewName = normalized.uiViewName;
-        config.$uiViewContextAnchor = normalized.uiViewContextAnchor;
-        if (isRoutedLitElement(config.component)) {
-            const Component = config.component;
+        normalizedConfig.$type = 'lit';
+        normalizedConfig.$context = state;
+        normalizedConfig.$name = name;
+        const normalizedTarget = ViewService.normalizeUIViewTarget(normalizedConfig.$context, normalizedConfig.$name);
+        normalizedConfig.$uiViewName = normalizedTarget.uiViewName;
+        normalizedConfig.$uiViewContextAnchor =
+            normalizedTarget.uiViewContextAnchor;
+        if (isRoutedLitElement(normalizedConfig.component)) {
+            const Component = normalizedConfig.component;
             let component;
-            config.component = (props) => {
+            normalizedConfig.component = (props) => {
                 component = (Component.sticky && component) || new Component(props);
                 component._uiViewProps = props;
                 return html `${component}`;
             };
         }
-        views[name] = viewsObject[name] = config;
+        views[name] = viewsObject[name] = normalizedConfig;
     });
     return views;
 }

package/dist/core.js.map

@@ -1 +1 @@
-{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,UAAU,EAEV,IAAI,EACJ,cAAc,EAGd,QAAQ,EAER,WAAW,GAEZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,KAAK,CAAC;AAUvC;;;GAGG;AACH,IAAI,mBAAmB,GAAG,CAAC,CAAC;AAE5B;;;;;;;GAOG;AACH,MAAM,OAAO,aAAa;IAMxB;;;;OAIG;IACH,YACS,IAAgB,EAChB,QAA0B;QAD1B,SAAI,GAAJ,IAAI,CAAY;QAChB,aAAQ,GAAR,QAAQ,CAAkB;QAZnC,6CAA6C;QAC7C,QAAG,GAAW,mBAAmB,EAAE,CAAC;QACpC,qDAAqD;QACrD,WAAM,GAAG,IAAI,CAAC;IAUX,CAAC;IAEJ;;;OAGG;IACH,IAAI;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,4BAA4B,CAC1C,MAA0B;IAE1B,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,IAAI,MAAM,CAAC,SAAS,YAAY,UAAU,EAAE,CAAC;YAC3C,OAAO,cAAc,IAAI,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAChC,SAAmB;IAEnB,OAAQ,SAAoC,EAAE,SAAS,YAAY,UAAU,CAAC;AAChF,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe,CAAC,KAAkB;IAChD,MAAM,KAAK,GAAiD,EAAE,EAC5D,WAAW,GAAG,KAAK,CAAC,KAAK,IAAI;QAC3B,QAAQ,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC;KACrC,CAAC;IAEJ,OAAO,CACL,WAAW,EACX,UAAU,MAAoC,EAAE,IAAY;QAC1D,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,6CAA6C;QACxE,IAAI,4BAA4B,CAAC,MAAM,CAAC;YAAE,MAAM,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;QACzE,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAEnD,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QACrB,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC;QACxB,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;QAEpB,MAAM,UAAU,GAAG,WAAW,CAAC,qBAAqB,CAClD,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,KAAK,CACb,CAAC;QACF,MAAM,CAAC,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC;QAC3C,MAAM,CAAC,oBAAoB,GAAG,UAAU,CAAC,mBAAmB,CAAC;QAE7D,IAAI,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;YACzC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;YACnC,IAAI,SAAyC,CAAC;YAC9C,MAAM,CAAC,SAAS,GAAG,CAAC,KAA0B,EAAE,EAAE;gBAChD,SAAS,GAAG,CAAC,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;gBACpE,SAAS,CAAC,YAAY,GAAG,KAAK,CAAC;gBAC/B,OAAO,IAAI,CAAA,GAAG,SAAS,EAAE,CAAC;YAC5B,CAAC,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;IAC3C,CAAC,CACF,CAAC;IACF,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,iBAAiB,GAAG,CAAC,IAAgB,EAAE,MAAwB,EAAE,EAAE,CACvE,IAAI,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,OAAO,WAAY,SAAQ,QAAQ;IACvC;;;;;;;OAOG;IACH;QACE,KAAK,EAAE,CAAC;QAOV,0CAA0C;QAClC,YAAO,GAAG,KAAK,CAAC;QAPtB,IAAI,CAAC,MAAM,CAAiB,cAAc,CAAC,CAAC;QAC5C,kCAAkC;QAClC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;QACzE,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACzD,CAAC;IAKD;;;;;;;;;;;;;;;OAeG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACtB,CAAC;CACF"}
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../src/core.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,UAAU,EAEV,IAAI,EACJ,cAAc,EAGd,QAAQ,EAER,WAAW,GAEZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,KAAK,CAAC;AAYvC;;;GAGG;AACH,IAAI,mBAAmB,GAAG,CAAC,CAAC;AAE5B;;;;;;;GAOG;AACH,MAAM,OAAO,aAAa;IAMxB;;;;OAIG;IACH,YACS,IAAgB,EAChB,QAA0B;QAD1B,SAAI,GAAJ,IAAI,CAAY;QAChB,aAAQ,GAAR,QAAQ,CAAkB;QAZnC,6CAA6C;QAC7C,QAAG,GAAW,mBAAmB,EAAE,CAAC;QACpC,qDAAqD;QACrD,WAAM,GAAG,IAAI,CAAC;IAUX,CAAC;IAEJ;;;OAGG;IACH,IAAI;QACF,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,4BAA4B,CAG1C,MAA6B;IAE7B,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,IAAI,MAAM,CAAC,SAAS,YAAY,UAAU,EAAE,CAAC;YAC3C,OAAO,cAAc,IAAI,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;QACnE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CAEhC,SAAmB;IACnB,OAAQ,SAAoC,EAAE,SAAS,YAAY,UAAU,CAAC;AAChF,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,eAAe,CAE7B,KAAkB;IAClB,MAAM,KAAK,GAAoD,EAAE,EAC/D,WAAW,GAAG,KAAK,CAAC,KAAK,IAAI;QAC3B,QAAQ,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC;KACrC,CAAC;IAEJ,OAAO,CAAC,WAAW,EAAE,UAAU,MAA6B,EAAE,IAAY;QACxE,IAAI,gBAAiD,CAAC;QACtD,IAAI,GAAG,IAAI,IAAI,UAAU,CAAC,CAAC,6CAA6C;QACxE,IAAI,4BAA4B,CAAI,MAAM,CAAC,EAAE,CAAC;YAC5C,gBAAgB,GAAG,EAAE,SAAS,EAAE,MAAoC,EAAE,CAAC;QACzE,CAAC;aAAM,CAAC;YACN,gBAAgB,GAAG,MAAyC,CAAC;QAC/D,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAE7D,gBAAgB,CAAC,KAAK,GAAG,KAAK,CAAC;QAC/B,gBAAgB,CAAC,QAAQ,GAAG,KAAK,CAAC;QAClC,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;QAE9B,MAAM,gBAAgB,GAAG,WAAW,CAAC,qBAAqB,CACxD,gBAAgB,CAAC,QAAQ,EACzB,gBAAgB,CAAC,KAAK,CACvB,CAAC;QACF,gBAAgB,CAAC,WAAW,GAAG,gBAAgB,CAAC,UAAU,CAAC;QAC3D,gBAAgB,CAAC,oBAAoB;YACnC,gBAAgB,CAAC,mBAAmB,CAAC;QAEvC,IAAI,kBAAkB,CAAI,gBAAgB,CAAC,SAAS,CAAC,EAAE,CAAC;YACtD,MAAM,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC;YAC7C,IAAI,SAA4C,CAAC;YACjD,gBAAgB,CAAC,SAAS,GAAG,CAAC,KAA6B,EAAE,EAAE;gBAC7D,SAAS,GAAG,CAAC,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,KAAK,CAAC,CAAC;gBACpE,SAAS,CAAC,YAAY,GAAG,KAAK,CAAC;gBAC/B,OAAO,IAAI,CAAA,GAAG,SAAS,EAAE,CAAC;YAC5B,CAAC,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC;IACrD,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,iBAAiB,GAAG,CAAC,IAAgB,EAAE,MAAwB,EAAE,EAAE,CACvE,IAAI,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,MAAM,OAAO,WAAY,SAAQ,QAAQ;IACvC;;;;;;;OAOG;IACH;QACE,KAAK,EAAE,CAAC;QAOV,0CAA0C;QAClC,YAAO,GAAG,KAAK,CAAC;QAPtB,IAAI,CAAC,MAAM,CAAiB,cAAc,CAAC,CAAC;QAC5C,kCAAkC;QAClC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,kBAAkB,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;QACzE,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IACzD,CAAC;IAKD;;;;;;;;;;;;;;;OAeG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;IACtB,CAAC;CACF"}

package/dist/interface.d.ts

@@ -98,17 +98,24 @@ export interface UiOnExit {
      */
     uiCanExit(newTransition?: Transition): HookResult;
 }
+/**
+ * Default Resolves Types when not provided to Generic UIViewResolves
+ * @see [[UIViewResolves]]
+ * @category types
+ */
+export type DefaultResolvesType = Record<string, any>;
 /**
  * Type alias for resolved values passed to routed components.
  *
  * @template T - The shape of the resolved values object
  *
  * @see [[UIViewInjectedProps]]
+ * @see [[DefaultResolvesType]]
  * @see [[StateDeclaration.resolve]]
  *
  * @category types
  */
-export type UIViewResolves<T = Record<string, any>> = T;
+export type UIViewResolves<T extends DefaultResolvesType = DefaultResolvesType> = T;
 /**
  * Props injected into routed components by the `<ui-view>` element.
  *
@@ -148,11 +155,11 @@ export type UIViewResolves<T = Record<string, any>> = T;
  *
  * @category types
  */
-export interface UIViewInjectedProps<T = Record<string, any>> {
+export interface UIViewInjectedProps<T extends DefaultResolvesType = DefaultResolvesType> {
     /** The current transition (if one is in progress) */
     transition?: Transition;
     /** Resolved data from state declarations */
-    resolves?: UIViewResolves<T>;
+    resolves: UIViewResolves<T>;
     /** The UIRouter instance for programmatic navigation */
     router: UIRouter;
 }
@@ -178,12 +185,13 @@ export interface UIViewInjectedProps<T = Record<string, any>> {
  *
  * @category types
  */
-export type RoutedLitTemplate = ((props?: UIViewInjectedProps) => TemplateResult) | ((props: UIViewInjectedProps) => TemplateResult);
+export type RoutedLitTemplate<T extends DefaultResolvesType = DefaultResolvesType> = ((props?: UIViewInjectedProps<T>) => TemplateResult) | ((props: UIViewInjectedProps<T>) => TemplateResult);
 /**
  * A template function that can be used as a view declaration.
  */
-export interface LitViewDeclarationTemplate extends _ViewDeclaration {
-    (props?: UIViewInjectedProps): TemplateResult;
+export interface LitViewDeclarationTemplate<T extends DefaultResolvesType = DefaultResolvesType> extends _ViewDeclaration {
+    (props: UIViewInjectedProps<T>): TemplateResult;
+    (props?: UIViewInjectedProps<T>): TemplateResult;
 }
 /**
  * A LitElement class constructor that can be used in state declarations.
@@ -195,9 +203,9 @@ export interface LitViewDeclarationTemplate extends _ViewDeclaration {
  * @example
  * ```ts
  * class UserList extends LitElement {
- *   _uiViewProps?: UIViewInjectedProps;
+ *   _uiViewProps: UIViewInjectedProps;
  *
- *   constructor(props?: UIViewInjectedProps) {
+ *   constructor(props: UIViewInjectedProps) {
  *     super();
  *     this._uiViewProps = props;
  *   }
@@ -216,10 +224,10 @@ export interface LitViewDeclarationTemplate extends _ViewDeclaration {
  *
  * @category types
  */
-export interface RoutedLitElement {
-    /** Constructor that accepts optional UIViewInjectedProps */
-    new (props?: UIViewInjectedProps): LitElement & {
-        _uiViewProps?: UIViewInjectedProps;
+export interface RoutedLitElement<T extends DefaultResolvesType = DefaultResolvesType> {
+    /** Overloaded constructor that requires UIViewInjectedProps */
+    new (props: UIViewInjectedProps<T>): LitElement & {
+        _uiViewProps: UIViewInjectedProps<T>;
     };
     /** If true, the same component instance is reused across state transitions */
     sticky?: boolean;
@@ -233,17 +241,17 @@ export interface RoutedLitElement {
  *
  * @category types
  */
-export type RoutedLitComponent = RoutedLitTemplate | RoutedLitElement;
+export type RoutedLitComponent<T extends DefaultResolvesType = DefaultResolvesType> = RoutedLitTemplate<T> | RoutedLitElement<T>;
 /**
  * A LitElement class used directly as a view declaration.
  */
-export interface LitViewDeclarationElement extends RoutedLitElement, _ViewDeclaration {
+export interface LitViewDeclarationElement<T extends DefaultResolvesType = DefaultResolvesType> extends RoutedLitElement<T>, _ViewDeclaration {
 }
 /**
  * A view declaration object with an explicit component property.
  */
-export interface LitViewDeclarationObject extends _ViewDeclaration {
-    component: RoutedLitComponent;
+export interface LitViewDeclarationObject<T extends DefaultResolvesType = DefaultResolvesType> extends _ViewDeclaration {
+    component: RoutedLitComponent<T>;
 }
 /**
  * Union type for all valid view declaration formats.
@@ -253,7 +261,7 @@ export interface LitViewDeclarationObject extends _ViewDeclaration {
  * - A LitElement class directly ({@link LitViewDeclarationElement})
  * - A template function directly ({@link LitViewDeclarationTemplate})
  */
-export type LitViewDeclaration = LitViewDeclarationObject | LitViewDeclarationElement | LitViewDeclarationTemplate;
+export type LitViewDeclaration<T extends DefaultResolvesType = DefaultResolvesType> = LitViewDeclarationObject<T> | LitViewDeclarationElement<T> | LitViewDeclarationTemplate<T>;
 /**
  * State declaration interface for Lit applications.
  *
@@ -293,15 +301,15 @@ export type LitViewDeclaration = LitViewDeclarationObject | LitViewDeclarationEl
  *
  * @category types
  */
-export interface LitStateDeclaration extends StateDeclaration {
+export interface LitStateDeclaration<T extends DefaultResolvesType = DefaultResolvesType> extends StateDeclaration {
     /** The Lit component to render for this state */
-    component?: LitViewDeclaration;
+    component?: LitViewDeclaration<T>;
 }
 /**
  * The `litViewsBuilder` registered in [[UIRouterLit.constructor]] normalizes config to this internal interface.
  *
  * @category types
  */
-export interface NormalizedLitViewDeclaration extends _ViewDeclaration {
-    component: RoutedLitTemplate;
+export interface NormalizedLitViewDeclaration<T extends DefaultResolvesType = DefaultResolvesType> extends _ViewDeclaration {
+    component: RoutedLitTemplate<T>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lit-ui-router",
-  "version": "1.1.2",
+  "version": "1.2.1",
   "type": "module",
   "module": "./dist/index.js",
   "homepage": "https://lit-ui-router.dev",
@@ -26,7 +26,9 @@
     "format:check": "prettier --check \"**/*.{ts,js,json,md}\"",
     "lint": "eslint .",
     "build:custom-elements": "cem analyze --outdir ./dist",
-    "docs:api": "rimraf ../../docs/api/reference && typedoc --defaultCategory other"
+    "docs:api": "rimraf ../../docs/api/reference && typedoc --defaultCategory other",
+    "changelog": "release-it --changelog --git.tagMatch=\"lit-ui-router@[0-9]*.[0-9]*.[0-9]*\"",
+    "commit:changelog": "echo \"Release \\${version}\n\n$(pnpm --silent changelog)\""
   },
   "customElements": "./dist/custom-elements.json",
   "dependencies": {