kreftjs 0.0.0-stage → 0.0.2-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (184) hide show
  1. package/README.md +103 -2
  2. package/bin/add.js +1074 -0
  3. package/bin/artisan-more.js +994 -0
  4. package/bin/artisan.js +1877 -0
  5. package/bin/backend/app.js +161 -0
  6. package/bin/backend/cache.js +196 -0
  7. package/bin/backend/collection.js +117 -0
  8. package/bin/backend/command.js +45 -0
  9. package/bin/backend/config.js +234 -0
  10. package/bin/backend/error-page.js +773 -0
  11. package/bin/backend/events.js +49 -0
  12. package/bin/backend/factory.js +223 -0
  13. package/bin/backend/fake.js +180 -0
  14. package/bin/backend/form.js +102 -0
  15. package/bin/backend/gate.js +79 -0
  16. package/bin/backend/gc.js +69 -0
  17. package/bin/backend/html.js +322 -0
  18. package/bin/backend/http.js +652 -0
  19. package/bin/backend/index.js +452 -0
  20. package/bin/backend/mail.js +77 -0
  21. package/bin/backend/mcp.js +433 -0
  22. package/bin/backend/migrator.js +370 -0
  23. package/bin/backend/model.js +781 -0
  24. package/bin/backend/namespace.js +213 -0
  25. package/bin/backend/notifications.js +68 -0
  26. package/bin/backend/qr.js +164 -0
  27. package/bin/backend/query.js +387 -0
  28. package/bin/backend/queue.js +412 -0
  29. package/bin/backend/redis.js +479 -0
  30. package/bin/backend/schedule.js +112 -0
  31. package/bin/backend/schema.js +321 -0
  32. package/bin/backend/seo-pages.js +100 -0
  33. package/bin/backend/storage.js +153 -0
  34. package/bin/backend/support.js +567 -0
  35. package/bin/backend/typescript.js +166 -0
  36. package/bin/build.js +540 -0
  37. package/bin/db-api.js +249 -0
  38. package/bin/db.js +275 -0
  39. package/bin/deps.js +138 -0
  40. package/bin/electron.js +509 -0
  41. package/bin/env.js +97 -0
  42. package/bin/guard.js +80 -0
  43. package/bin/kreftjs-config.js +40 -0
  44. package/bin/kreftjs.js +1373 -0
  45. package/bin/lang.js +241 -0
  46. package/bin/layout.js +74 -0
  47. package/bin/no-auth.js +162 -0
  48. package/bin/prerender.js +258 -0
  49. package/bin/safe-json.js +24 -0
  50. package/bin/server-routes.js +154 -0
  51. package/bin/ssr.js +133 -0
  52. package/bin/terminal.js +195 -0
  53. package/bin/to-ts.js +36 -0
  54. package/bin/update.js +237 -0
  55. package/bin/urls-file.js +27 -0
  56. package/bin/vite.js +228 -0
  57. package/docs/Docs.kreftjs +557 -0
  58. package/docs/README.md +2302 -0
  59. package/docs/markdown.js +186 -0
  60. package/editors/vscode/README.md +13 -0
  61. package/editors/vscode/extension.js +183 -0
  62. package/editors/vscode/language-configuration.json +17 -0
  63. package/editors/vscode/package.json +57 -0
  64. package/editors/vscode/snippets/kreftjs.json +21 -0
  65. package/editors/vscode/syntaxes/kreftjs.tmLanguage.json +207 -0
  66. package/kreftjs.d.ts +579 -0
  67. package/kreftjs.js +5108 -0
  68. package/package.json +97 -4
  69. package/server.d.ts +1028 -0
  70. package/server.js +8 -0
  71. package/templates/app/README.md +127 -0
  72. package/templates/app/_env.example +64 -0
  73. package/templates/app/_gitignore +5 -0
  74. package/templates/app/_vscode/settings.json +9 -0
  75. package/templates/app/backend/app/Auth/Session.js +177 -0
  76. package/templates/app/backend/app/Auth/Throttle.js +29 -0
  77. package/templates/app/backend/app/Console/Commands/.gitkeep +0 -0
  78. package/templates/app/backend/app/Events/.gitkeep +0 -0
  79. package/templates/app/backend/app/Http/Controllers/Admin/DashboardController.js +34 -0
  80. package/templates/app/backend/app/Http/Controllers/Admin/UserController.js +53 -0
  81. package/templates/app/backend/app/Http/Controllers/Auth/ApiTokenController.js +47 -0
  82. package/templates/app/backend/app/Http/Controllers/Auth/AuthenticatedSessionController.js +41 -0
  83. package/templates/app/backend/app/Http/Controllers/Auth/ConfirmablePasswordController.js +14 -0
  84. package/templates/app/backend/app/Http/Controllers/Auth/EmailVerificationController.js +23 -0
  85. package/templates/app/backend/app/Http/Controllers/Auth/NewPasswordController.js +29 -0
  86. package/templates/app/backend/app/Http/Controllers/Auth/PasswordResetLinkController.js +20 -0
  87. package/templates/app/backend/app/Http/Controllers/Auth/RegisteredUserController.js +19 -0
  88. package/templates/app/backend/app/Http/Controllers/Auth/SessionController.js +36 -0
  89. package/templates/app/backend/app/Http/Controllers/Auth/TwoFactorChallengeController.js +41 -0
  90. package/templates/app/backend/app/Http/Controllers/Auth/TwoFactorController.js +63 -0
  91. package/templates/app/backend/app/Http/Controllers/ProfileController.js +66 -0
  92. package/templates/app/backend/app/Http/Kernel.js +8 -0
  93. package/templates/app/backend/app/Http/Middleware/Authenticate.js +84 -0
  94. package/templates/app/backend/app/Http/Middleware/CheckAbilities.js +17 -0
  95. package/templates/app/backend/app/Http/Middleware/CheckForAnyAbility.js +12 -0
  96. package/templates/app/backend/app/Http/Middleware/EnsureEmailIsVerified.js +11 -0
  97. package/templates/app/backend/app/Http/Middleware/EnsureHasRole.js +11 -0
  98. package/templates/app/backend/app/Http/Middleware/EnsureIsAdmin.js +11 -0
  99. package/templates/app/backend/app/Http/Middleware/RequirePassword.js +15 -0
  100. package/templates/app/backend/app/Http/Requests/Auth/LoginRequest.js +45 -0
  101. package/templates/app/backend/app/Http/Resources/.gitkeep +1 -0
  102. package/templates/app/backend/app/Jobs/.gitkeep +0 -0
  103. package/templates/app/backend/app/Listeners/.gitkeep +0 -0
  104. package/templates/app/backend/app/Mail/.gitkeep +0 -0
  105. package/templates/app/backend/app/Models/PersonalAccessToken.js +21 -0
  106. package/templates/app/backend/app/Models/User.js +64 -0
  107. package/templates/app/backend/app/Notifications/.gitkeep +0 -0
  108. package/templates/app/backend/app/Observers/.gitkeep +0 -0
  109. package/templates/app/backend/app/Policies/.gitkeep +0 -0
  110. package/templates/app/backend/app/Providers/AppServiceProvider.js +12 -0
  111. package/templates/app/backend/app/Rules/.gitkeep +1 -0
  112. package/templates/app/backend/config/app.js +16 -0
  113. package/templates/app/backend/config/auth.js +34 -0
  114. package/templates/app/backend/config/database.js +38 -0
  115. package/templates/app/backend/config/redis.js +28 -0
  116. package/templates/app/backend/config/session.js +36 -0
  117. package/templates/app/backend/database/migrations/0001_01_01_000000_create_users_table.js +49 -0
  118. package/templates/app/backend/database/migrations/0001_01_01_000001_create_cache_table.js +13 -0
  119. package/templates/app/backend/database/migrations/0001_01_01_000002_create_jobs_table.js +26 -0
  120. package/templates/app/backend/database/migrations/0001_01_01_000003_create_notifications_table.js +18 -0
  121. package/templates/app/backend/database/seeders/DatabaseSeeder.js +15 -0
  122. package/templates/app/backend/lang/ar/messages.json +10 -0
  123. package/templates/app/backend/lang/ar/validation.json +21 -0
  124. package/templates/app/backend/lang/en/messages.json +10 -0
  125. package/templates/app/backend/lang/en/validation.json +19 -0
  126. package/templates/app/backend/routes/api.js +25 -0
  127. package/templates/app/backend/routes/auth.js +52 -0
  128. package/templates/app/backend/routes/console.js +15 -0
  129. package/templates/app/frontend/App.kreftjs +4 -0
  130. package/templates/app/frontend/components/Field.kreftjs +19 -0
  131. package/templates/app/frontend/components/StatCard.kreftjs +47 -0
  132. package/templates/app/frontend/components/profile/ApiTokens.kreftjs +70 -0
  133. package/templates/app/frontend/components/profile/Sessions.kreftjs +42 -0
  134. package/templates/app/frontend/components/profile/TwoFactor.kreftjs +90 -0
  135. package/templates/app/frontend/errors/ErrorMonitor.kreftjs +264 -0
  136. package/templates/app/frontend/index.html +79 -0
  137. package/templates/app/frontend/kreftjs.d.ts +579 -0
  138. package/templates/app/frontend/kreftjs.js +5108 -0
  139. package/templates/app/frontend/layouts/app.kreftjs +718 -0
  140. package/templates/app/frontend/layouts/docs.kreftjs +37 -0
  141. package/templates/app/frontend/layouts/guest.kreftjs +18 -0
  142. package/templates/app/frontend/pages/Dashboard.kreftjs +273 -0
  143. package/templates/app/frontend/pages/ErrorMonitor.kreftjs +96 -0
  144. package/templates/app/frontend/pages/Home.kreftjs +617 -0
  145. package/templates/app/frontend/pages/Profile.kreftjs +104 -0
  146. package/templates/app/frontend/pages/Users.kreftjs +240 -0
  147. package/templates/app/frontend/pages/auth/ConfirmPassword.kreftjs +33 -0
  148. package/templates/app/frontend/pages/auth/ForgotPassword.kreftjs +36 -0
  149. package/templates/app/frontend/pages/auth/Login.kreftjs +89 -0
  150. package/templates/app/frontend/pages/auth/Register.kreftjs +48 -0
  151. package/templates/app/frontend/pages/auth/ResetPassword.kreftjs +45 -0
  152. package/templates/app/frontend/pages/auth/VerifyEmail.kreftjs +59 -0
  153. package/templates/app/frontend/routes/web.kreftjs +34 -0
  154. package/templates/app/frontend/tests/components/Counter.kreftjs +15 -0
  155. package/templates/app/frontend/tests/pages/About.kreftjs +12 -0
  156. package/templates/app/frontend/tests/pages/Test.kreftjs +31 -0
  157. package/templates/app/frontend/ui.css +517 -0
  158. package/templates/app/lang/ar/auth.json +6 -0
  159. package/templates/app/lang/ar/messages.json +6 -0
  160. package/templates/app/lang/ar/pagination.json +5 -0
  161. package/templates/app/lang/ar/passwords.json +8 -0
  162. package/templates/app/lang/ar/validation.json +22 -0
  163. package/templates/app/lang/ar.json +10 -0
  164. package/templates/app/lang/en/auth.json +6 -0
  165. package/templates/app/lang/en/messages.json +6 -0
  166. package/templates/app/lang/en/pagination.json +5 -0
  167. package/templates/app/lang/en/passwords.json +8 -0
  168. package/templates/app/lang/en/validation.json +22 -0
  169. package/templates/app/lang/en.json +10 -0
  170. package/templates/errors/401.kreftjs +11 -0
  171. package/templates/errors/402.kreftjs +11 -0
  172. package/templates/errors/403.kreftjs +11 -0
  173. package/templates/errors/404.kreftjs +11 -0
  174. package/templates/errors/419.kreftjs +11 -0
  175. package/templates/errors/429.kreftjs +11 -0
  176. package/templates/errors/500.kreftjs +11 -0
  177. package/templates/errors/503.kreftjs +11 -0
  178. package/templates/errors/ErrorMonitor.kreftjs +502 -0
  179. package/templates/errors/error.kreftjs +11 -0
  180. package/templates/errors/minimal.kreftjs +25 -0
  181. package/tools/dev-client.js +125 -0
  182. package/tools/devtools.js +172 -0
  183. package/tools/vite-plugin-kreftjs.d.ts +52 -0
  184. package/tools/vite-plugin-kreftjs.js +466 -0
package/kreftjs.d.ts ADDED
@@ -0,0 +1,579 @@
1
+ // Type definitions for Kreft 0.0.2-beta
2
+ // Use from TypeScript or for editor hints in plain JavaScript (// @ts-check).
3
+
4
+ export interface Signal<T> { value: T }
5
+ export interface Derived<T> { readonly value: T }
6
+ export interface WritableDerived<T> { value: T }
7
+ export type Source<T> = Signal<T> | Derived<T> | (() => T)
8
+ export type Stop = () => void
9
+
10
+ export interface WatchOptions { immediate?: boolean; deep?: boolean; flush?: 'pre' | 'post' | 'sync' }
11
+
12
+ /** A value loaded with `load x = …` or Kreftjs.resource(() => …) */
13
+ export interface Resource<T> {
14
+ data: T | null
15
+ loading: boolean
16
+ error: any
17
+ loaded: boolean
18
+ reload(): Promise<T | undefined>
19
+ }
20
+
21
+ /** Every store gets these (hidden from loops and from saving) */
22
+ export interface StoreTools<T> {
23
+ readonly $name: string
24
+ /** Put every value back to how it started */
25
+ $reset(): void
26
+ /** Change several values at once */
27
+ $patch(change: Partial<T> | ((store: T) => void)): void
28
+ /** Run fn whenever any value changes */
29
+ $watch(fn: (values: T, store: T) => void): Stop
30
+ }
31
+ export type Store<T> = T & StoreTools<T>
32
+
33
+ export interface Storage {
34
+ has(key: string): boolean
35
+ get<T = any>(key: string, fallback?: T): T
36
+ set(key: string, value: any): void
37
+ remove(key: string): void
38
+ clear(): void
39
+ keys(): string[]
40
+ }
41
+
42
+ export interface ApiOptions {
43
+ /** put in front of every address, like '/api' */
44
+ base?: string
45
+ headers?: Record<string, string>
46
+ /** ms, default 30000 */
47
+ timeout?: number
48
+ query?: Record<string, any>
49
+ /** true: get { data, status, headers } instead of only the data */
50
+ full?: boolean
51
+ signal?: AbortSignal
52
+ credentials?: RequestCredentials
53
+ body?: any
54
+ [key: string]: any
55
+ }
56
+ export interface Api {
57
+ get<T = any>(url: string, options?: ApiOptions): Promise<T>
58
+ delete<T = any>(url: string, options?: ApiOptions): Promise<T>
59
+ post<T = any>(url: string, body?: any, options?: ApiOptions): Promise<T>
60
+ put<T = any>(url: string, body?: any, options?: ApiOptions): Promise<T>
61
+ patch<T = any>(url: string, body?: any, options?: ApiOptions): Promise<T>
62
+ head(url: string, options?: ApiOptions): Promise<any>
63
+ request<T = any>(method: string, url: string, options?: ApiOptions): Promise<T>
64
+ /** change the settings of this client */
65
+ setup(options: ApiOptions): Api
66
+ /** a new client with its own settings */
67
+ create(options: ApiOptions): Api
68
+ before(fn: (request: { method: string; url: string; headers: Record<string, string>; body?: any }) => any): Stop
69
+ after(fn: (response: any) => any): Stop
70
+ onError(fn: (error: ApiError) => any): Stop
71
+ }
72
+ export declare class ApiError extends Error {
73
+ status: number
74
+ data: any
75
+ /** Standard validation errors: { email: ['The email field is required.'] } */
76
+ errors: Record<string, string[]>
77
+ }
78
+
79
+ export interface Bus {
80
+ on(name: string, fn: (...args: any[]) => void): Stop
81
+ once(name: string, fn: (...args: any[]) => void): Stop
82
+ off(name: string, fn?: (...args: any[]) => void): void
83
+ send(name: string, ...args: any[]): void
84
+ }
85
+
86
+ /** Kreftjs.table('posts'): the rows of a table served by `kreftjs dev --db` / `kreftjs serve --db` */
87
+ export interface TableQuery {
88
+ _limit?: number
89
+ _page?: number
90
+ /** columns to sort by; a leading - sorts backwards: '-created_at,title' */
91
+ _sort?: string
92
+ /** search every text column */
93
+ q?: string
94
+ /** column = value, or column_gte / _lte / _gt / _lt / _ne / _like */
95
+ [filter: string]: any
96
+ }
97
+ export interface Table<T = any> {
98
+ readonly name: string
99
+ all(query?: TableQuery, options?: ApiOptions): Promise<T[]>
100
+ find(id: string | number, options?: ApiOptions): Promise<T>
101
+ /** how many rows match (from the X-Total-Count header) */
102
+ count(query?: TableQuery): Promise<number>
103
+ create(data: Partial<T>, options?: ApiOptions): Promise<T>
104
+ update(id: string | number, data: Partial<T>, options?: ApiOptions): Promise<T>
105
+ patch(id: string | number, data: Partial<T>, options?: ApiOptions): Promise<T>
106
+ remove(id: string | number, options?: ApiOptions): Promise<void>
107
+ }
108
+
109
+ /** Validation rules: 'required|min:3|max:120', 'required|email', 'nullable|integer|between:1,10', or functions */
110
+ export type Rule = string | ((value: any, data: any) => true | string | void)
111
+ export type Rules = Record<string, string | Rule[]>
112
+ export type Errors = Record<string, string[]>
113
+ export interface ValidateOptions {
114
+ /** your own words: { 'title.required': 'Write a title', email: '…' } */
115
+ messages?: Record<string, string>
116
+ /** field names in messages: { first_name: 'first name' } */
117
+ names?: Record<string, string>
118
+ /** check only these fields */
119
+ only?: string | string[]
120
+ /** Kreftjs.form: show errors while typing from the start, not only after the first submit */
121
+ live?: boolean
122
+ }
123
+ export interface FormTools<T> {
124
+ readonly $errors: Errors
125
+ readonly $valid: boolean
126
+ readonly $busy: boolean
127
+ readonly $submitted: boolean
128
+ /** the first message for a field, or '' */
129
+ $error(field: keyof T & string): string
130
+ $values(): T
131
+ /** check every field (or one); true when there are no mistakes */
132
+ $check(field?: keyof T & string): boolean
133
+ /** show errors from somewhere else, like an ApiError or { title: ['…'] } */
134
+ $setErrors(errors: Errors | { errors: Errors }): void
135
+ /** back to the starting values (or to new ones), errors cleared */
136
+ $reset(values?: Partial<T>): void
137
+ /** checks the rules; only then calls send(values). A 422 ApiError fills $errors. false when it didn't send or the server refused */
138
+ $submit<R>(send?: (values: T) => Promise<R> | R): Promise<R | true | false>
139
+ }
140
+ export type Form<T> = T & FormTools<T>
141
+
142
+ export interface ActionState {
143
+ /** true while the async action is executing */
144
+ readonly loading: boolean
145
+ /** alias for loading */
146
+ readonly pending: boolean
147
+ /** error message string if the action threw an error, or null */
148
+ readonly error: string | null
149
+ /** validation error dictionary if the action threw a 422 ApiError or validation error, or null */
150
+ readonly errors: Record<string, string[]> | null
151
+ /** reset loading, error, and errors back to clean state */
152
+ reset(): void
153
+ }
154
+
155
+ export type ActionFn<A extends any[] = any[], R = any> = ((...args: A) => Promise<R> | R) & ActionState
156
+
157
+ export interface Selection<T = any> {
158
+ readonly ids: (string | number)[]
159
+ readonly count: number
160
+ readonly all: boolean
161
+ has(idOrItem: string | number | T): boolean
162
+ toggle(idOrItem: string | number | T): void
163
+ toggleAll(): void
164
+ select(...idOrItems: (string | number | T)[]): void
165
+ deselect(...idOrItems: (string | number | T)[]): void
166
+ clear(): void
167
+ }
168
+
169
+ export interface Theme {
170
+ /** 'auto' | 'dark' | 'light' */
171
+ readonly current: 'auto' | 'dark' | 'light'
172
+ /** true when dark mode is currently active (explicit or via system prefers-color-scheme) */
173
+ readonly dark: boolean
174
+ readonly isDark: boolean
175
+ /** toggle between light and dark modes */
176
+ toggle(): void
177
+ /** set mode explicitly to 'dark', 'light', or 'auto' (system preference) */
178
+ set(mode: 'auto' | 'dark' | 'light'): void
179
+ }
180
+
181
+ /* ---------------- components ---------------- */
182
+ export type PropType = StringConstructor | NumberConstructor | BooleanConstructor | ArrayConstructor | ObjectConstructor | FunctionConstructor
183
+ export interface PropOptions { type?: PropType | PropType[]; default?: any; required?: boolean; validator?: (v: any) => boolean }
184
+
185
+ export interface Context {
186
+ send: (event: string, ...args: any[]) => void
187
+ attrs: Record<string, any>
188
+ slots: Record<string, any>
189
+ expose: (o: object) => void
190
+ }
191
+
192
+ /** An object component: plain values are state, getters are derived values, functions are actions */
193
+ export interface ComponentDef {
194
+ template?: string
195
+ templateUrl?: string
196
+ props?: string[] | Record<string, PropType | PropType[] | PropOptions>
197
+ events?: string[] | Record<string, any>
198
+ components?: Record<string, Component>
199
+ directives?: Record<string, Directive>
200
+ init?: (props: any, ctx: Context) => object | void
201
+ watch?: Record<string, ((value: any, old: any) => void) | string | { handler: Function | string; deep?: boolean; immediate?: boolean }>
202
+ share?: object | (() => object)
203
+ receive?: string[] | Record<string, string | { from?: string; fallback?: any }>
204
+ saved?: string | string[]
205
+ passAttrs?: boolean
206
+ start?(): void | Promise<void>
207
+ ready?(): void
208
+ update?(): void
209
+ show?(): void
210
+ hide?(): void
211
+ destroy?(): void
212
+ destroyed?(): void
213
+ [key: string]: any
214
+ }
215
+ /** A component: an object, an init function, a lazy() loader or the address of a .kreftjs file */
216
+ export type Component = ComponentDef | ((props: any, ctx: Context) => object | void) | LazyComponent | string
217
+ export interface LazyComponent { __loader: () => Promise<any> }
218
+
219
+ export interface DirectiveBinding { value: any; oldValue: any; arg?: string; modifiers: Record<string, boolean>; instance: any }
220
+ export type Directive = ((el: HTMLElement, binding: DirectiveBinding) => void) | {
221
+ ready?(el: HTMLElement, binding: DirectiveBinding): void
222
+ update?(el: HTMLElement, binding: DirectiveBinding): void
223
+ destroy?(el: HTMLElement, binding: DirectiveBinding): void
224
+ }
225
+
226
+ export interface App {
227
+ readonly version: string
228
+ globals: Record<string, any>
229
+ component(name: string): Component | undefined
230
+ component(name: string, def: Component): App
231
+ directive(name: string): Directive | undefined
232
+ directive(name: string, def: Directive): App
233
+ share(key: string | symbol, value: any): App
234
+ use(plugin: { install(app: App, ...options: any[]): any } | ((app: App, ...options: any[]) => any), ...options: any[]): App
235
+ mount(target: string | Element): any
236
+ unmount(): void
237
+ }
238
+
239
+ /* ---------------- router ---------------- */
240
+ export interface RouteRecord {
241
+ path: string
242
+ component?: Component
243
+ name?: string
244
+ /** true: params become props; an object: fixed props; a function: (route) => props */
245
+ props?: boolean | Record<string, any> | ((route: Route) => Record<string, any>)
246
+ meta?: Record<string, any> & { title?: string }
247
+ redirect?: string | RouteTarget | ((route: Route) => string | RouteTarget)
248
+ guard?: Guard
249
+ /** Child routes, shown in the page's own <kreft-view> */
250
+ children?: RouteRecord[]
251
+ /** The layout for this route and its children: 'admin' → layouts/admin.kreftjs, a .kreftjs path, a component, or false for none */
252
+ layout?: string | Component | false
253
+ }
254
+ export interface Route {
255
+ readonly path: string
256
+ readonly fullPath: string
257
+ readonly params: Record<string, string>
258
+ readonly query: Record<string, string | string[]>
259
+ readonly hash: string
260
+ readonly name: string | null
261
+ readonly meta: Record<string, any>
262
+ /** set while an error page shows (an unknown address, or abort()) */
263
+ readonly error: { status: number; message: string } | null
264
+ }
265
+ export type RouteTarget = string | { path?: string; name?: string; params?: Record<string, any>; query?: Record<string, any>; hash?: string }
266
+ export type Guard = (to: Route, from: Route) => boolean | void | RouteTarget | Promise<boolean | void | RouteTarget>
267
+ export interface Router {
268
+ readonly route: Route
269
+ /** shows errors/<status>.kreftjs for this address: abort(403, 'Only the owner can see this.') */
270
+ abort(status?: number, message?: string): void
271
+ readonly routes: RouteRecord[]
272
+ go(to: RouteTarget | number): Promise<void> | void
273
+ replace(to: RouteTarget): Promise<void>
274
+ back(): void
275
+ forward(): void
276
+ href(to: RouteTarget): string
277
+ resolve(to: RouteTarget): Route
278
+ before(guard: Guard): Stop
279
+ /** a middleware name the routes can use: router.middleware('admin', (to) => isAdmin() || '/') */
280
+ middleware(name: string, fn: RouteMiddleware): Router
281
+ after(fn: (to: Route, from: Route) => void): Stop
282
+ ready(): Promise<void>
283
+ install(app: App): void
284
+ }
285
+ /** routes/web.kreftjs: `Route` is there without an import */
286
+ export interface RouteEntry {
287
+ name(name: string): RouteEntry
288
+ title(title: string): RouteEntry
289
+ description(description: string): RouteEntry
290
+ seo(options: SeoOptions | string): RouteEntry
291
+ meta(meta: Record<string, any>): RouteEntry
292
+ layout(layout: string | false): RouteEntry
293
+ middleware(...names: (string | string[])[]): RouteEntry
294
+ withoutMiddleware(...names: string[]): RouteEntry
295
+ props(props: boolean | Record<string, any> | ((route: Route) => Record<string, any>)): RouteEntry
296
+ children(fn: (route: RouteFile) => void): RouteEntry
297
+ }
298
+ export interface RouteGroup {
299
+ prefix(prefix: string): RouteGroup
300
+ middleware(...names: (string | string[])[]): RouteGroup
301
+ name(name: string): RouteGroup
302
+ layout(layout: string | false): RouteGroup
303
+ title(title: string): RouteGroup
304
+ description(description: string): RouteGroup
305
+ seo(options: SeoOptions | string): RouteGroup
306
+ meta(meta: Record<string, any>): RouteGroup
307
+ group(fn: (route: RouteFile) => void): RouteFile
308
+ }
309
+ export interface RouteFile {
310
+ /** a page: Route.view('/posts/:id', 'pages/Post.kreftjs') — :id reaches the page as a prop */
311
+ view(path: string, component: string | Component): RouteEntry
312
+ get(path: string, component: string | Component): RouteEntry
313
+ redirect(from: string, to: string): void
314
+ fallback(component: string | Component): RouteEntry
315
+ group(attributes: { prefix?: string; middleware?: string | string[]; name?: string; layout?: string | false; meta?: Record<string, any> } | ((route: RouteFile) => void), fn?: (route: RouteFile) => void): RouteFile
316
+ prefix(prefix: string): RouteGroup
317
+ middleware(...names: (string | string[])[]): RouteGroup
318
+ name(name: string): RouteGroup
319
+ layout(layout: string | false): RouteGroup
320
+ title(title: string): RouteGroup
321
+ description(description: string): RouteGroup
322
+ seo(options: SeoOptions | string): RouteGroup
323
+ }
324
+ /** a middleware for routes: true (or nothing) goes on, false stays, an address goes there instead */
325
+ export type RouteMiddleware = (to: Route, from: Route, ...args: string[]) => boolean | string | object | void | Promise<boolean | string | object | void>
326
+
327
+ export interface RouterOptions {
328
+ /** route objects, or route files: 'routes/web.kreftjs' / ['routes/web.kreftjs', 'routes/admin.kreftjs'] (both can be mixed) */
329
+ routes: RouteRecord[] | string | (string | RouteRecord)[]
330
+ /** the names routes use in .middleware(…): { auth: (to) => auth.token ? true : '/login' } */
331
+ middleware?: Record<string, RouteMiddleware>
332
+ mode?: 'history' | 'hash'
333
+ base?: string
334
+ scrollToTop?: boolean
335
+ /** The layout every page goes in: 'app' → layouts/app.kreftjs (a page's `layout x`, or a route's `layout`, wins) */
336
+ layout?: string | Component | false
337
+ /** Names for layouts that live elsewhere: { admin: 'views/AdminShell.kreftjs' } */
338
+ layouts?: Record<string, string | Component>
339
+ /** The folder with the error pages (errors/404.kreftjs, 403, 500…): unknown addresses show 404.kreftjs, abort(…) the others */
340
+ errors?: string | boolean
341
+ }
342
+
343
+ /* ---------------- Kreft ---------------- */
344
+ export interface KreftStatic {
345
+ readonly version: string
346
+ /** PUBLIC_ values from .env (also `env` in .kreftjs files). Never secrets: those stay in server code */
347
+ readonly env: Readonly<Record<string, string>>
348
+ /** true when running inside an Electron desktop window */
349
+ readonly isElectron: boolean
350
+ /** Native desktop bridge methods (minimize, maximize, dialogs) when running in Electron */
351
+ readonly desktop: DesktopBridge | null
352
+ /** true when running with Vite (dev server or production build) */
353
+ readonly isVite: boolean
354
+ __makeDef(parts: any, values?: any): ComponentDef
355
+ __registerDef(path: string, def: any): any
356
+ __hotDef(id: string, newDef: any): boolean
357
+ /** the error page for this address: abort(404), abort(403, 'Only the owner can see this.') (also `abort` in .kreftjs files) */
358
+ abort(status?: number, message?: string): void
359
+ app(root?: Component, props?: Record<string, any>): App
360
+ lazy(loader: () => Promise<any>): LazyComponent
361
+ load(url: string): Promise<ComponentDef>
362
+ /** Compiles the text of a .kreftjs file into a component */
363
+ compile(source: string, url?: string): Promise<ComponentDef>
364
+ /** @deprecated the Som.js name of `compile` */
365
+ compileSom(source: string, url?: string): Promise<ComponentDef>
366
+ /** Strips TypeScript type annotations, interfaces, type aliases and enums from source code while preserving line numbers */
367
+ stripTypeScript(source: string): string
368
+ /** The template engine: a view and data → an HTML string */
369
+ render(view: string, data?: Record<string, any>, options?: { components?: Record<string, Component>; directives?: Record<string, Directive> }): string
370
+
371
+ signal<T>(value: T): Signal<T>
372
+ state<T extends object>(obj: T): T
373
+ derived<T>(get: () => T): Derived<T>
374
+ derived<T>(options: { get: () => T; set: (v: T) => void }): WritableDerived<T>
375
+ readonly<T extends object>(obj: T): Readonly<T>
376
+ isSignal(v: any): v is Signal<any>
377
+ isState(v: any): boolean
378
+ read<T>(v: T | Signal<T>): T
379
+ unwrap<T>(v: T): T
380
+ raw<T>(v: T): T
381
+
382
+ saved<T>(key: string, initial: T | (() => T)): Signal<T>
383
+ storage: Storage
384
+ api: Api
385
+ ApiError: typeof ApiError
386
+ resource<T>(load: () => Promise<T>, options?: { initial?: T }): Resource<T>
387
+ table<T = any>(name: string, options?: { api?: Api; base?: string }): Table<T>
388
+ /** {} when everything is fine, otherwise { field: ['message', …] } — standard 422 errors shape */
389
+ validate: ((data: Record<string, any>, rules: Rules, options?: ValidateOptions) => Errors) & { messages: Record<string, any> }
390
+ form<T extends object>(values: T, rules?: Rules, options?: ValidateOptions): Form<T>
391
+ /** reactive multi-row selection for tables & bulk actions */
392
+ selection<T = any>(itemsSource: T[] | (() => T[]), key?: string): Selection<T>
393
+ /** reactive theme controller (dark/light/auto, toggle, system detection) */
394
+ theme: Theme
395
+ slug(text: string): string
396
+
397
+ watch<T>(source: Source<T> | object | Source<any>[], cb: (value: T, old: T, onCleanup: (fn: () => void) => void) => void, options?: WatchOptions): Stop
398
+ effect(fn: (onCleanup: (fn: () => void) => void) => void, options?: WatchOptions): Stop
399
+ tick(fn?: () => void): Promise<void>
400
+ onCleanup(fn: () => void): void
401
+
402
+ store<T extends object>(name: string, obj: T, options?: { saved?: boolean | string[] }): Store<T>
403
+ store<T extends object = any>(name: string): Store<T>
404
+ bus: Bus
405
+ createBus(): Bus
406
+ share(key: string | symbol, value: any): void
407
+ receive<T = any>(key: string | symbol, fallback?: T): T
408
+
409
+ onReady(fn: () => void): void
410
+ onUpdate(fn: () => void): void
411
+ onShow(fn: () => void): void
412
+ onHide(fn: () => void): void
413
+ onDestroy(fn: () => void): void
414
+ onDestroyed(fn: () => void): void
415
+ onMounted(fn: () => void): void
416
+ onUnmounted(fn: () => void): void
417
+ onBeforeUnmount(fn: () => void): void
418
+ onUpdated(fn: () => void): void
419
+ /** creates a timer that automatically cleans up when the component is unmounted */
420
+ useInterval(fn: () => void, ms?: number): () => void
421
+ useTimeout(fn: () => void, ms?: number): () => void
422
+ /** inactivity watchdog: tracks user interaction and auto-redirects upon session expiration */
423
+ useInactivityTimer(options?: number | InactivityTimerOptions): { reset: () => void; stop: () => void; timeoutMs: number }
424
+
425
+ router(options: RouterOptions): Router
426
+ currentRoute(): Route | null
427
+ currentRouter(): Router | null
428
+
429
+ /** updates <title>, <meta>, <link rel="canonical">, openGraph, twitter cards and JSON-LD */
430
+ seo(options: SeoOptions | string): void
431
+ useSeo(options: SeoOptions | string): void
432
+
433
+ /** HTML Security & XSS Sanitization utilities */
434
+ cleanHtml(rawHtml: any, options?: { allowedTags?: string[]; allowedAttributes?: Record<string, string[]>; allowedSchemes?: string[] }): string
435
+ sanitizeHtml(rawHtml: any, options?: { allowedTags?: string[]; allowedAttributes?: Record<string, string[]>; allowedSchemes?: string[] }): string
436
+ stripTags(html: any): string
437
+ escapeHtml(str: any): string
438
+ unescapeHtml(str: any): string
439
+ SafeHtml: {
440
+ new (html: string): { __kreft_safe_html: true; toString(): string; toHtml(): string }
441
+ raw(html: string): { __kreft_safe_html: true; toString(): string; toHtml(): string }
442
+ clean(rawHtml: any, options?: any): { __kreft_safe_html: true; toString(): string; toHtml(): string }
443
+ isSafe(value: any): boolean
444
+ }
445
+
446
+ // localization & i18n
447
+ locale(lang?: string): string
448
+ fallbackLocale(lang?: string): string
449
+ locales(): string[]
450
+ translations(localeOrDict: string | Record<string, any>, dict?: Record<string, any>): KreftStatic
451
+ dir(locale?: string): 'rtl' | 'ltr'
452
+ isRtl(locale?: string): boolean
453
+ __(key: string, replace?: Record<string, any>, locale?: string): string
454
+ t(key: string, replace?: Record<string, any>, locale?: string): string
455
+ trans(key: string, replace?: Record<string, any>, locale?: string): string
456
+ choice(key: string, count: number, replace?: Record<string, any>, locale?: string): string
457
+ transChoice(key: string, count: number, replace?: Record<string, any>, locale?: string): string
458
+ trans_choice(key: string, count: number, replace?: Record<string, any>, locale?: string): string
459
+ hasTranslation(key: string, locale?: string): boolean
460
+ formatNumber(value: number, options?: Intl.NumberFormatOptions, locale?: string): string
461
+ formatCurrency(amount: number, currency?: string, locale?: string): string
462
+ formatDate(date: Date | string | number, options?: Intl.DateTimeFormatOptions, locale?: string): string
463
+ html(strings: TemplateStringsArray, ...values: any[]): { __kreft_safe_html: true; toString(): string; toHtml(): string }
464
+ }
465
+
466
+ export interface SeoOptions {
467
+ title?: string
468
+ description?: string
469
+ keywords?: string | string[]
470
+ author?: string
471
+ robots?: string
472
+ canonical?: string
473
+ image?: string
474
+ og?: {
475
+ title?: string
476
+ description?: string
477
+ image?: string
478
+ url?: string
479
+ type?: string
480
+ siteName?: string
481
+ }
482
+ twitter?: {
483
+ card?: string
484
+ title?: string
485
+ description?: string
486
+ image?: string
487
+ site?: string
488
+ creator?: string
489
+ }
490
+ schema?: Record<string, any> | string
491
+ jsonLd?: Record<string, any> | string
492
+ }
493
+
494
+ /**
495
+ * server/*.js — every exported function (get, post, put, patch, del, handle) gets this.
496
+ * /** @param {import('kreftjs').KreftServerContext} ctx *\/
497
+ * exports.get = (ctx) => ({ hello: ctx.query.name })
498
+ */
499
+ export interface KreftServerContext {
500
+ method: string
501
+ path: string
502
+ /** [id] parts of the file name: server/users/[id].js → { id: '5' } */
503
+ params: Record<string, string>
504
+ query: Record<string, string>
505
+ /** JSON or form data (null for GET and DELETE) */
506
+ body: any
507
+ headers: Record<string, string | string[] | undefined>
508
+ /** the database from --db or kreftjs.config.json, or null */
509
+ db: null | {
510
+ kind: 'sqlite' | 'mysql' | 'postgres'
511
+ query<T = any>(sql: string, params?: any[]): Promise<T[]>
512
+ run(sql: string, params?: any[]): Promise<{ changes: number; insertId: number | null }>
513
+ exec(sql: string): Promise<void>
514
+ }
515
+ /** checks the rules; returns the data, or stops with 422 and { message, errors } */
516
+ validate<T extends Record<string, any>>(data: T, rules: Record<string, string>, options?: ValidateOptions): T
517
+ /** stops with an error: a message, or { field: ['message'] } */
518
+ fail(status: number, detail?: string | Record<string, string[]>): never
519
+ /** answer with another status or headers: return ctx.reply(201, row) */
520
+ reply(status: number, data?: any, headers?: Record<string, string>): any
521
+ /** process.env, with the values from .env */
522
+ env: Record<string, string | undefined>
523
+ req: any
524
+ res: any
525
+ }
526
+
527
+ export interface DesktopBridge {
528
+ readonly isElectron: boolean
529
+ getInfo(): Promise<{ name: string; version: string; platform: string; arch: string; isPackaged: boolean }>
530
+ minimize(): Promise<void>
531
+ maximize(): Promise<void>
532
+ close(): Promise<void>
533
+ showMessageBox(options: any): Promise<any>
534
+ showOpenDialog(options: any): Promise<any>
535
+ showSaveDialog(options: any): Promise<any>
536
+ }
537
+
538
+ export interface InactivityTimerOptions {
539
+ timeout?: number
540
+ warningTime?: number
541
+ redirect?: string
542
+ events?: string[]
543
+ onWarning?: (info: { remainingMs: number; remainingMinutes: number }) => void
544
+ onTimeout?: () => void
545
+ }
546
+
547
+ declare const Kreftjs: KreftStatic
548
+ export default Kreftjs
549
+
550
+ declare global {
551
+ // the <script src="kreftjs.js"> global
552
+ var Kreftjs: KreftStatic
553
+ /** the shorter name of `Kreftjs` */
554
+ var Kreft: KreftStatic
555
+ /** @deprecated the Som.js name of `Kreftjs` */
556
+ var Som: KreftStatic
557
+ interface Window {
558
+ kreftDesktop?: DesktopBridge
559
+ /** @deprecated the Som.js name of `kreftDesktop` */
560
+ somDesktop?: DesktopBridge
561
+ }
562
+ }
563
+
564
+ declare module '*.kreftjs' {
565
+ const component: import('./kreftjs.js').ComponentDef
566
+ export default component
567
+ }
568
+
569
+ // files from older projects (.kreft, then Som.js's .som)
570
+ declare module '*.kreft' {
571
+ const component: import('./kreftjs.js').ComponentDef
572
+ export default component
573
+ }
574
+
575
+ declare module '*.som' {
576
+ const component: import('./kreftjs.js').ComponentDef
577
+ export default component
578
+ }
579
+