@small-web/kitten-types 1.0.2 → 1.1.2

package/README.md

@@ -4,8 +4,6 @@ Type-safety for [Kitten](https://kitten.small-web.org) apps and sites.
 
 This is a **types-only** package. It declares the global `kitten` namespace (via `declare global`) and exports reusable Kitten types you can use to annotate your own code.
 
-> 💡 The older [`@small-web/kitten`](https://www.npmjs.com/package/@small-web/kitten) module [has now been deprecated](#relationship-to-small-web-kitten). You should use this module for new projects and plan on migrating existing projects over to it going forward.
-
 ## Install
 
 ```shell
@@ -116,7 +114,9 @@ If you want type safety for your custom project database, please create and use
 
 ## Relationship to `@small-web/kitten`
 
-The older [`@small-web/kitten`](https://www.npmjs.com/package/@small-web/kitten) globals module cast the members of  `globalThis.kitten` at runtime and provided type safety for JavaScript projects (prior to TypeScript support being added to Kitten). 
+> 💡 The older [`@small-web/kitten`](https://www.npmjs.com/package/@small-web/kitten) module [has now been deprecated](#relationship-to-small-web-kitten). You should use this module for new projects and plan on migrating existing projects over to it going forward.
+
+The older globals module cast the members of  `globalThis.kitten` at runtime and provided type safety for JavaScript projects (prior to TypeScript support being added to Kitten). 
 
 This was problematic as a discrepency between Kitten and the globals module was not just a missing completion in your editor but could break your app at runtime.  
 

package/fragments.d.ts

@@ -0,0 +1,14 @@
+type Fragment = (props?: {SLOT?: any}) => string
+
+declare module '*.fragment.html' {
+  const fragment: Fragment
+  export default fragment
+}
+declare module '*.fragment.css' {
+  const fragment: Fragment
+  export default fragment
+}
+declare module '*.fragment.md' {
+  const fragment: Fragment
+  export default fragment
+}

package/global.d.ts

@@ -211,12 +211,19 @@ export interface kitten {
     @remarks For internal use only.
   */
   appRepository?: {
+    latestCompatibleVersion: string,
+    latestVersion: string,
+    latestApiVersion: string,
+    manualUpdateAvailable: boolean,
+    originRemoteUrl: string,
+    currentVersion: string,
+    latestAvailableCommit: string,
     upgradeAppToLatestCompatibleVersion(): Promise<void>
     upgradeAppToLatestAvailableCommit(): Promise<void>
     updateAppToVersion(versionTag: string): Promise<void>
     update(): Promise<void>
     hasCompatibleAppVersion: boolean
-    canBeUpdated: boolean
+    canBeUpgraded: boolean
     hasNewerApiVersion: boolean
     upgradeOrDowngrade(versionTag: string, lowercase: boolean): 'upgrade' | 'downgrade'
     isEqualToVersion(versionTag: string): boolean

package/index.d.ts

@@ -7,6 +7,7 @@
 */
 
 import './global.d.ts'
+import './fragments.d.ts'
 
 // Reusable types, re-exported for explicit annotations
 // (e.g. `import type { KittenRequest } from '@small-web/kitten-types'`).
@@ -33,7 +34,7 @@ export type {
   Signature
 } from './types.d.ts'
 
-export { yaml } from './types.d.ts'
+export type { yaml } from './types.d.ts'
 
 // Also export hand-written global namespace shape, in case an author wants to reference it explicitly (e.g. `typeof kitten`).
 export type { kitten } from './global.d.ts'

package/package.json

@@ -1,13 +1,23 @@
 {
   "name": "@small-web/kitten-types",
-  "version": "1.0.2",
+  "version": "1.1.2",
   "description": "Types-only package for Kitten: declares global `kitten` namespace and exports Kitten types.",
   "types": "index.d.ts",
+  "files": [
+    "index.d.ts",
+    "global.d.ts",
+    "fragments.d.ts",
+    "types.d.ts",
+    "polka/index.d.ts",
+    "slugify/index.d.ts",
+    "ws/index.d.ts"
+  ],
   "exports": {
     ".": {
       "types": "./index.d.ts"
     },
     "./global.d.ts": "./global.d.ts",
+    "./fragments.d.ts": "./fragments.d.ts",
     "./types.d.ts": "./types.d.ts"
   },
   "type": "module",

package/types.d.ts

@@ -448,7 +448,7 @@ export class KittenPage extends KittenComponent {
 
     @deprecated Instead of `on(eventName, handler)`, export `onEventName()` from your page (or add `onEventName()` method to your `kitten.Page` subclass if using class-based page routes.)
   */
-  on (eventName: string, eventHandler: () => void):void
+  on (eventName: string, eventHandler: (data: any) => void):void
 
   /**
     Send specified message to just this page’s socket.

package/.idea/kitten-types.iml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/kitten-types.iml" filepath="$PROJECT_DIR$/.idea/kitten-types.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/vcs.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>

package/CHANGELOG.md

@@ -1,30 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [1.0.2] - 2026-06-26
-
-### Improved
-
-  - Documentation
-
-### Fixed
-
-  - Polka router export (as referenced at `kitten.app.router`).
-
-## [1.0.1] - 2026-06-26
-
-### Added
-
-  - Missing types
-  - Documentation for all types
-
-## [1.0.0] - 2026-06-23
-
-__Initial release__
-
-The predecessor of this module is Kitten Globals ([@small-web/kitten](https://codeberg.org/kitten/globals)), which has now been deprecated.
-
-For previous history, please see that module.