@small-web/kitten-types 1.1.3 → 1.1.5

package/global.d.ts

@@ -6,6 +6,8 @@
 
 import type { EventEmitter } from 'node:events'
 import type { Server } from 'node:https'
+import type { AutoEncryptedServer } from '@small-tech/auto-encrypt'
+import type { AutoEncryptedLocalhostServer } from '@small-tech/auto-encrypt-localhost'
 
 import type {
   Session,
@@ -55,6 +57,7 @@ export interface KittenInternalDatabase {
       interval: number
     }
     domainToken: string
+    domainRedirects: Record<string, string>
     evergreenWebUrl: string
     hideWelcomeMessage: boolean
     id: {
@@ -76,10 +79,13 @@ export interface KittenInternalDatabase {
       referrers: StatsObject
       serverErrors: StatsObject
     }
-    uploads: UploadStore
     webhookSecret: string
   }
-  uploads: Record<string, Upload>
+  uploads: UploadStore,
+  scheduledRestart: {
+    lastRestartDate: number
+    restartHour: number
+  }
 }
 
 /**
@@ -106,6 +112,8 @@ interface ServerOptions {
   'small-web-host-domain'?: string
 }
 
+type UpdateType = 'upgrade' | 'downgrade' | 'updating' | 'restarting'
+
 /**
   Global `kitten` namespace.
 */
@@ -135,8 +143,8 @@ export interface kitten {
   app: {
     /** The parsed package.json file for the current Kitten app (if any). */
     package?: any
-    router: Polka
-    server: Server
+    router: Polka<any>
+    server: Server | AutoEncryptedServer | AutoEncryptedLocalhostServer
   }
 
   /**
@@ -211,13 +219,13 @@ export interface kitten {
     @remarks For internal use only.
   */
   appRepository?: {
-    latestCompatibleVersion: string,
-    latestVersion: string,
-    latestApiVersion: string,
-    manualUpdateAvailable: boolean,
-    originRemoteUrl: string,
-    currentVersion: string,
-    latestAvailableCommit: string,
+    latestCompatibleVersion?: string,
+    latestVersion?: string,
+    latestApiVersion?: number,
+    manualUpdateAvailable?: boolean,
+    originRemoteUrl?: string,
+    currentVersion?: string,
+    latestAvailableCommit?: string,
     upgradeAppToLatestCompatibleVersion(): Promise<void>
     upgradeAppToLatestAvailableCommit(): Promise<void>
     updateAppToVersion(versionTag: string): Promise<void>
@@ -225,12 +233,19 @@ export interface kitten {
     hasCompatibleAppVersion: boolean
     canBeUpgraded: boolean
     hasNewerApiVersion: boolean
-    upgradeOrDowngrade(versionTag: string, lowercase: boolean): 'upgrade' | 'downgrade'
+    upgradeOrDowngrade(versionTag: string, lowercase: boolean): 'upgrade' | 'Upgrade' | 'downgrade' | 'Downgrade' | false
     isEqualToVersion(versionTag: string): boolean
-    UpdateButtonComponent(): (type: string, version: string, small: boolean) => string | Array<string>
-    VersionComponent(): (version: string, compatible: boolean, brief: boolean) => string | Array<string>
-    CurrentAppVersionComponent(): () => string | Array<string>
-    AllAvailableVersionsComponent(): () => string | Array<string>
+
+    /** Returns a configured update button component. */
+    UpdateButtonComponent(): ({type, version, small}: { type?: UpdateType, version?: string, small?: boolean }) => ReturnType<TaggedTemplate>
+
+    VersionComponent ({version, compatible, brief}: { version: string, compatible: boolean, brief: boolean}): ReturnType<TaggedTemplate>
+
+    /** Returns a configured Current app version component. */
+    CurrentAppVersionComponent(): () => ReturnType<TaggedTemplate>
+
+    /** Returns a configured All available versions component or kitten.html (it probably shouoldn’t be doing that). */
+    AllAvailableVersionsComponent(): (() => ReturnType<TaggedTemplate>) | ReturnType<TaggedTemplate>
     displayAppVersion(): void
   }
 
@@ -245,7 +260,7 @@ export interface kitten {
     interval: number
     intervalInHours: number
     timeToNextCheck(): number
-    timeToNextCheckPretty(): string
+    timeToNextCheckPretty(): string | number
     start(): void
     checkForUpdates(): Promise<void>
     stop(): void
@@ -267,7 +282,7 @@ export interface kitten {
     canBeUpgraded: boolean
     upgrade(apiVersion?: number): void
     update(): Promise<void>,
-    latestRecommendedVersion: {
+    latestRecommendedVersion?: {
       versionStamp: number,
       gitHash: string,
       apiVersion: number,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@small-web/kitten-types",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "Types-only package for Kitten: declares global `kitten` namespace and exports Kitten types.",
   "types": "index.d.ts",
   "files": [
@@ -57,6 +57,8 @@
     "@types/node": ">=24"
   },
   "dependencies": {
+    "@small-tech/auto-encrypt": "^5.1.0",
+    "@small-tech/auto-encrypt-localhost": "^10.0.0",
     "@types/markdown-it": "^14.1.2",
     "@types/node": ">=24",
     "kitten-icons": "^4.1.0"

package/types.d.ts

@@ -117,7 +117,7 @@ export class LazilyLoadedRoute {
   method: 'use' | 'get'
 
   constructor(filePath:string, basePath:string)
-  get handler():BoundHandler<LazilyLoadedRoute>
+  get handler():BoundHandler<LazilyLoadedRoute>&{filePath?: string}
   lazilyLoadedhandler:AsyncKittenHandler
 }