@radio-garden/ditojs-server 2.91.0-0.1b51d4b4e → 2.91.0-2.566eca6ca

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@radio-garden/ditojs-server",
-  "version": "2.91.0-0.1b51d4b4e",
+  "version": "2.91.0-2.566eca6ca",
   "type": "module",
   "description": "Dito.js Server – Dito.js is a declarative and modern web framework, based on Objection.js, Koa.js and Vue.js",
   "repository": "https://github.com/ditojs/dito/tree/main/packages/server",
@@ -61,10 +61,10 @@
     "repl": "^0.1.3",
     "type-fest": "^5.4.4",
     "uuid": "^13.0.0",
-    "@ditojs/utils": "npm:@radio-garden/ditojs-utils@^2.91.0-0.1b51d4b4e",
-    "@ditojs/admin": "npm:@radio-garden/ditojs-admin@^2.91.0-0.1b51d4b4e",
-    "@ditojs/build": "npm:@radio-garden/ditojs-build@^2.91.0-0.1b51d4b4e",
-    "@ditojs/router": "npm:@radio-garden/ditojs-router@^2.91.0-0.1b51d4b4e"
+    "@ditojs/admin": "npm:@radio-garden/ditojs-admin@^2.91.0-2.566eca6ca",
+    "@ditojs/build": "npm:@radio-garden/ditojs-build@^2.91.0-2.566eca6ca",
+    "@ditojs/utils": "npm:@radio-garden/ditojs-utils@^2.91.0-2.566eca6ca",
+    "@ditojs/router": "npm:@radio-garden/ditojs-router@^2.91.0-2.566eca6ca"
   },
   "peerDependencies": {
     "@aws-sdk/client-s3": "^3.0.0",
@@ -87,7 +87,7 @@
     "objection": "^3.1.5",
     "typescript": "^5.9.3"
   },
-  "gitHead": "1b51d4b4e",
+  "gitHead": "566eca6ca",
   "gitBranch": "feature/asset-signatures",
   "scripts": {
     "types": "tsc --noEmit --esModuleInterop ./types/index.d.ts"

package/types/index.d.ts

@@ -694,6 +694,7 @@ export interface Application
 
 export type SchemaType = LiteralUnion<
   | 'string'
+  | 'text'
   | 'number'
   | 'integer'
   | 'boolean'
@@ -936,7 +937,7 @@ export type ModelProperty<T = any> = Schema<T> & {
    */
   computed?: boolean
   /**
-   * Marks the property has hidden, so that it does not show up in data
+   * Marks the property as hidden, so that it does not show up in data
    * converted to JSON.
    *
    * This can be used for sensitive data.
@@ -1722,11 +1723,31 @@ export type ModelProperties<$Model extends Model = Model> = [
     }
 
 /**
- * A controller action definition. Either an options object
- * with `handler`, `method`, `path`, `authorize`, etc., or a
- * bare handler function. The HTTP method and path are
- * derived from the action name key (e.g. `'postImport'`
- * maps to `POST /import`).
+ * A controller action definition. The HTTP method and route
+ * path are derived from the action name key (e.g.
+ * `'post import'` → `POST /import`, `'get'` → `GET /`).
+ *
+ * @example
+ * // Bare handler function:
+ * collection = {
+ *   allow: ['get'],
+ *   'post import'(ctx) {
+ *     return this.importData(ctx.request.body)
+ *   }
+ * }
+ *
+ * @example
+ * // Options object with handler, authorize, etc.:
+ * collection = {
+ *   allow: ['get'],
+ *   'post import': {
+ *     handler(ctx) {
+ *       return this.importData(ctx.request.body)
+ *     },
+ *     authorize: 'admin',
+ *     transacted: true
+ *   }
+ * }
  */
 export type ControllerAction<$Controller extends Controller = Controller> =
   | ControllerActionOptions<$Controller>
@@ -1773,9 +1794,12 @@ export class Controller {
   logRoutes: boolean
 
   /**
-   * A list of allowed actions. If provided, only the
-   * action names listed here as strings will be mapped to
-   * routes, everything else will be omitted.
+   * Which inherited actions to enable, e.g.
+   * `['get', 'post', 'get stats']`. Actions defined
+   * directly on the same object are always enabled.
+   * When set, it replaces any parent controller's
+   * `allow` list. When omitted, the parent's `allow`
+   * list is inherited.
    */
   allow?: OrReadOnly<ControllerActionName[]>
 
@@ -1938,14 +1962,14 @@ type ModelDataProperties<$Model extends Model = Model> = {
  * - Any other `string`: Checked as a role via
  *   `UserModel.$hasRole()`.
  * - `function`: Dynamically resolves to any of the above.
- * - `Record<HTTPMethod, string | string[]>`: Per-method
+ * - `Partial<Record<HTTPMethod, string | string[]>>`: Per-method
  *   role authorization.
  */
 export type Authorize =
   | boolean
   | OrArrayOf<LiteralUnion<'$self' | '$owner'>>
   | ((ctx: KoaContext) => OrPromiseOf<Authorize>)
-  | Record<HTTPMethod, string | string[]>
+  | Partial<Record<HTTPMethod, string | string[]>>
 
 export type BaseControllerActionOptions = {
   /**
@@ -2051,8 +2075,8 @@ export type ModelControllerAction<
 
 /**
  * Map of action names to action definitions for a model
- * controller's collection-level actions (e.g. `getList`,
- * `postCreate`).
+ * controller's collection-level actions (e.g. `'get'`,
+ * `'post'`, `'post login'`).
  */
 export type ModelControllerActions<
   $ModelController extends ModelController = ModelController
@@ -2089,16 +2113,19 @@ export type ModelControllerMemberActions<
 }
 
 /**
- * Action name pattern: an HTTP method followed by an
- * optional suffix, e.g. `'getStats'`, `'postImport'`,
- * `'deleteAll'`.
+ * Action name: an HTTP method, optionally followed by a
+ * space and a name (e.g. `'get'`, `'post login'`,
+ * `'get session'`). The method and name are split on the
+ * first space to determine the HTTP method and route path.
+ * Bare names without an HTTP method prefix (e.g. `'login'`)
+ * are not supported and will throw at runtime.
  */
 export type ControllerActionName = `${HTTPMethod}${string}`
 
 /**
  * Map of action names to action definitions for a
- * controller. Supports `allow` to whitelist specific
- * actions and `authorize` for group-level authorization.
+ * controller. Use `allow` to whitelist specific actions
+ * and `authorize` for group-level authorization.
  */
 export type ControllerActions<$Controller extends Controller = Controller> = {
   [name: ControllerActionName]: ControllerAction<$Controller>
@@ -3416,11 +3443,25 @@ export function addRelationSchemas(
   properties: Record<string, ModelProperty>
 ): void
 
-export type Keyword =
+export type Keyword = (
   | SetOptional<Ajv.MacroKeywordDefinition, 'keyword'>
   | SetOptional<Ajv.CodeKeywordDefinition, 'keyword'>
   | SetOptional<Ajv.FuncKeywordDefinition, 'keyword'>
-export type Format = Ajv.ValidateFunction | Ajv.FormatDefinition<string>
+) & {
+  /** Custom error message shown when validation fails. */
+  message?: string
+  /** When true, validation errors for this keyword are suppressed. */
+  silent?: boolean
+}
+export type Format = (
+  | Ajv.ValidateFunction
+  | Ajv.FormatDefinition<string>
+) & {
+  /** Custom error message shown when validation fails. */
+  message?: string
+  /** When true, validation errors for this format are suppressed. */
+  silent?: boolean
+}
 
 /** Built-in AJV keyword definitions. */
 export const keywords: {
@@ -3459,24 +3500,21 @@ export type Id = string | number
  * ```ts
  * declare module '@ditojs/server' {
  *   interface KoaContextState {
- *     user: User
+ *     foo: string
  *   }
  * }
  * ```
  */
-export interface KoaContextState {}
-
-type ResolvedState = keyof KoaContextState extends never
-  ? any
-  : KoaContextState
+export interface KoaContextState {
+  user: InstanceType<typeof UserModel>
+  [key: string]: unknown
+}
 
-export type KoaContext<$State = ResolvedState> = Koa.ParameterizedContext<
+export type KoaContext<$State = KoaContextState> = Koa.ParameterizedContext<
   $State,
   {
     transaction: objection.Transaction
-    session: koaSession.ContextSession & {
-      state: { user: any }
-    }
+    session: koaSession.ContextSession
     logger: PinoLogger
   }
 >