@inglorious/web 6.6.2 → 6.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inglorious/web",
-  "version": "6.6.2",
+  "version": "6.7.0",
   "description": "A new web framework that leverages the power of the Inglorious Store combined with the performance and simplicity of lit-html.",
   "author": "Matteo Antony Mistretta <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
   "contributors": [
@@ -91,6 +91,7 @@
       "import": "./src/static.js"
     },
     "./test": {
+      "types": "./types/test.d.ts",
       "import": "./src/test.js"
     }
   },
@@ -109,11 +110,12 @@
     "lit-html": "^3.3.3"
   },
   "peerDependencies": {
-    "@inglorious/store": "11.0.5"
+    "@inglorious/store": "11.1.0"
   },
   "devDependencies": {
     "@inglorious/eslint-config": "1.1.4",
     "prettier": "^3.9.6",
+    "typescript": "~7.0.2",
     "vitest": "^5.0.0"
   },
   "engines": {
@@ -123,6 +125,7 @@
     "format": "prettier --write .",
     "lint": "eslint .",
     "test:watch": "vitest",
-    "test": "vitest run"
+    "test": "vitest run && tsc -p type-tests",
+    "test:types": "tsc -p type-tests"
   }
 }

package/types/directives/choose.d.ts

@@ -1 +1 @@
-export { choose } from "lit-html/directives/choose"
+export { choose } from "lit-html/directives/choose.js"

package/types/directives/class-map.d.ts

@@ -1 +1 @@
-export { classMap } from "lit-html/directives/class-map"
+export { classMap } from "lit-html/directives/class-map.js"

package/types/directives/ref.d.ts

@@ -1 +1 @@
-export { createRef, ref } from "lit-html/directives/ref"
+export { createRef, ref } from "lit-html/directives/ref.js"

package/types/directives/repeat.d.ts

@@ -1 +1 @@
-export { repeat } from "lit-html/directives/repeat"
+export { repeat } from "lit-html/directives/repeat.js"

package/types/directives/style-map.d.ts

@@ -1 +1 @@
-export { styleMap } from "lit-html/directives/style-map"
+export { styleMap } from "lit-html/directives/style-map.js"

package/types/directives/unsafe-html.d.ts

@@ -1 +1 @@
-export { unsafeHTML } from "lit-html/directives/unsafe-html"
+export { unsafeHTML } from "lit-html/directives/unsafe-html.js"

package/types/directives/when.d.ts

@@ -1 +1 @@
-export { when } from "lit-html/directives/when"
+export { when } from "lit-html/directives/when.js"

package/types/form.d.ts

@@ -31,7 +31,7 @@ export type FormTouched<T> = T extends (infer U)[]
  */
 export interface FormEntity<T extends FormValues = FormValues> {
   /** A unique identifier for the form entity. */
-  id: string | number
+  id?: string
   /** The initial values of the form, used for resetting. */
   initialValues: T
   /** The current values of the form fields. */
@@ -191,7 +191,7 @@ export interface FormValidationErrorPayload {
 /**
  * The form type implementation for the entity-based state manager.
  */
-export interface FormType {
+export type FormType = {
   /**
    * Initializes the form entity with default state.
    * @param entity The form entity.

package/types/mount.d.ts

@@ -1,33 +1,43 @@
 import type { TemplateResult } from "lit-html"
 import type {
+  AnyTypeDefinition,
   BaseEntity,
   EntitiesState,
-  EntityType,
   Store,
   Api as StoreApi,
 } from "@inglorious/store"
 
+// `mount` gives the store's api a `render`, so loading these types gives the
+// store's `Api` one too. There is a single `Api`: the one handlers receive,
+// and the one components take.
+declare module "@inglorious/store" {
+  interface Api<
+    TEntity extends BaseEntity = BaseEntity,
+    TState extends EntitiesState<TEntity> = EntitiesState<TEntity>,
+  > {
+    /**
+     * Renders an entity or a type component by its ID.
+     * @param id The ID of the entity or type to render. None, such as the route
+     *   of an unmatched path, renders nothing.
+     * @param typeName Optional type name to lazy-register.
+     * @param type Optional type definition to register when typeName is provided.
+     * @returns The rendered template or an empty string if not found.
+     */
+    render: {
+      (id: string | undefined): TemplateResult | string
+      (
+        id: string,
+        typeName: string,
+        type: AnyTypeDefinition,
+      ): TemplateResult | string
+    }
+  }
+}
+
 export type Api<
   TEntity extends BaseEntity = BaseEntity,
   TState extends EntitiesState<TEntity> = EntitiesState<TEntity>,
-> = StoreApi<TEntity, TState> & {
-  /**
-   * Renders an entity or a type component by its ID.
-   * @param id The ID of the entity or type to render. None, such as the route
-   *   of an unmatched path, renders nothing.
-   * @param typeName Optional type name to lazy-register.
-   * @param type Optional type definition to register when typeName is provided.
-   * @returns The rendered template or an empty string if not found.
-   */
-  render: {
-    (id: string | undefined): TemplateResult | string
-    (
-      id: string,
-      typeName: string,
-      type: EntityType<TEntity>,
-    ): TemplateResult | string
-  }
-}
+> = StoreApi<TEntity, TState>
 
 /**
  * Root error-boundary options for `mount`.

package/types/router.d.ts

@@ -27,7 +27,7 @@ export type QueryParams = Record<string, string>
  */
 export interface RouterEntity {
   /** A unique identifier for the router entity. */
-  id: string | number
+  id?: string
   /** The current active path, without query string or hash. */
   path?: string
   /** The entity type of the current active route. */
@@ -79,7 +79,7 @@ export type { Api as StoreApi } from "@inglorious/store"
 /**
  * Client-side router for entity-based systems. Handles URL changes, link interception, and browser history management.
  */
-export interface RouterType {
+export type RouterType = {
   /**
    * Initializes the router, sets up a popstate listener to handle browser navigation,
    * and intercepts clicks on local links.

package/types/sensors/compass.d.ts

@@ -1,8 +1,8 @@
 import { Api } from "../mount"
 
 export interface CompassEntity {
-  id: string | number
-  type?: "Compass"
+  id?: string
+  type: string
   error: CompassError | null
   heading: number | null
   isActive: boolean
@@ -21,7 +21,7 @@ export interface CompassError {
   message: string
 }
 
-export interface CompassType {
+export type CompassType = {
   create(entity: CompassEntity, payload: unknown, api: Api): void
   destroy(entity: CompassEntity, payload: unknown, api: Api): void
   compassUnwatch(entity: CompassEntity, payload: unknown, api: Api): void

package/types/sensors/element-size.d.ts

@@ -2,11 +2,11 @@ import { Api } from "../mount"
 
 export interface ElementSizeEntity {
   height: number | null
-  id: string | number
+  id?: string
   isSupported: boolean
   isWatching: boolean
   selector?: string | null
-  type?: "ElementSize"
+  type: string
   width: number | null
 }
 
@@ -15,7 +15,7 @@ export interface ElementSizeSize {
   width: number
 }
 
-export interface ElementSizeType {
+export type ElementSizeType = {
   create(entity: ElementSizeEntity, payload: unknown, api: Api): void
   destroy(entity: ElementSizeEntity): void
   elementSizeChange(entity: ElementSizeEntity, size: ElementSizeSize): void

package/types/sensors/geolocation.d.ts

@@ -12,12 +12,12 @@ export interface GeolocationCoordinates {
 
 export interface GeolocationEntity {
   error: GeolocationError | null
-  id: string | number
+  id?: string
   isLoading: boolean
   isSupported: boolean
   isWatching: boolean
   position: GeolocationPosition | null
-  type?: "Geolocation"
+  type: string
   watchId: number | null
 }
 
@@ -37,7 +37,7 @@ export interface GeolocationPosition {
   timestamp: number
 }
 
-export interface GeolocationType {
+export type GeolocationType = {
   unwatch(entity: GeolocationEntity): void
   create(entity: GeolocationEntity): void
   destroy(entity: GeolocationEntity): void

package/types/sensors/media-query.d.ts

@@ -1,8 +1,8 @@
 import { Api } from "../mount"
 
 export interface MediaQueryEntity {
-  id: string | number
-  type?: "MediaQuery"
+  id?: string
+  type: string
   media: string
   matches: boolean
   isSupported: boolean
@@ -13,7 +13,7 @@ export interface MediaQueryMatchEvent {
   matches: boolean
 }
 
-export interface MediaQueryType {
+export type MediaQueryType = {
   create(entity: MediaQueryEntity, payload: unknown, api: Api): void
   destroy(entity: MediaQueryEntity): void
   mediaQueryChange(entity: MediaQueryEntity, event: MediaQueryMatchEvent): void

package/types/sensors/network-status.d.ts

@@ -1,14 +1,14 @@
 import { Api } from "../mount"
 
 export interface NetworkStatusEntity {
-  id: string | number
-  type?: "NetworkStatus"
+  id?: string
+  type: string
   isOnline: boolean
   isSupported: boolean
   isWatching: boolean
 }
 
-export interface NetworkStatusType {
+export type NetworkStatusType = {
   create(entity: NetworkStatusEntity, payload: unknown, api: Api): void
   destroy(entity: NetworkStatusEntity, payload: unknown, api: Api): void
   networkStatusChange(entity: NetworkStatusEntity, value: boolean): void

package/types/sensors/page-visibility.d.ts

@@ -1,14 +1,14 @@
 import { Api } from "../mount"
 
 export interface PageVisibilityEntity {
-  id: string | number
-  type?: "PageVisibility"
+  id?: string
+  type: string
   isSupported: boolean
   isVisible: boolean
   isWatching: boolean
 }
 
-export interface PageVisibilityType {
+export type PageVisibilityType = {
   create(entity: PageVisibilityEntity, payload: unknown, api: Api): void
   destroy(entity: PageVisibilityEntity, payload: unknown, api: Api): void
   pageVisibilityChange(entity: PageVisibilityEntity, value: boolean): void

package/types/static.d.ts

@@ -1 +1 @@
-export { html as staticHtml, unsafeStatic } from "lit-html/static"
+export { html as staticHtml, unsafeStatic } from "lit-html/static.js"

package/types/test.d.ts

@@ -0,0 +1,2 @@
+export { createMockApi, trigger } from "@inglorious/store/test"
+export { render } from "lit-html"