adminforth 2.33.1 → 2.35.0

package/dist/spa/pnpm-workspace.yaml

@@ -0,0 +1,4 @@
+
+ignoredBuiltDependencies:
+  - esbuild
+

package/dist/spa/src/App.vue

@@ -2,6 +2,7 @@
   <div>
     <nav 
       v-if="loggedIn && routerIsReady && loginRedirectCheckIsReady && defaultLayout"
+      id="af-header-nav"
       class="fixed h-14 top-0 z-30 w-full border-b drop-shadow-sm bg-lightNavbar dark:bg-darkNavbar dark:border-darkSidebarDevider"
     >
       <div class="af-header px-3 lg:px-5 lg:pl-3 flex items-center justify-between h-full w-full" >

package/dist/spa/src/afcl/Skeleton.vue

@@ -17,7 +17,7 @@
     <div 
         v-else-if="type === 'input'" 
         role="input" 
-        :class="['animate-pulse bg-gray-100 dark:bg-gray-700 border border-gray-200 dark:border-gray-600 rounded', $attrs.class]"
+        :class="['animate-pulse bg-gray-100 dark:bg-gray-700 border border-gray-200 dark:border-gray-600 rounded-default', $attrs.class]"
     ></div>
     <div v-else role="status" class="flex items-center justify-center animate-pulse bg-lightSkeletonIconColor rounded-full dark:bg-darkSkeletonBackgroundColor">
         <span class="sr-only">Loading...</span>

package/dist/spa/src/stores/core.ts

@@ -1,4 +1,4 @@
-import { ref, computed } from 'vue'
+import { ref, computed, onMounted, onUnmounted } from 'vue'
 import { defineStore } from 'pinia'
 import { callAdminForthApi } from '@/utils';
 import websocket from '@/websocket';
@@ -21,6 +21,19 @@ export const useCoreStore = defineStore('core', () => {
   const userData: Ref<UserData | null> = ref(null);
   const isResourceFetching = ref(false);
   const isInternetError = ref(false);
+  const screenWidth = ref(window.innerWidth);
+
+  onMounted(() => {
+    window.addEventListener('resize', updateWidth);
+  });
+  onUnmounted(() => {
+    window.removeEventListener('resize', updateWidth);
+  });
+
+  const isMobile = computed(() => screenWidth.value <= 768);
+  const updateWidth = () => {
+    screenWidth.value = window.innerWidth
+  }
 
   const resourceColumnsWithFilters = computed(() => {
     if (!resource.value) {
@@ -261,5 +274,6 @@ export const useCoreStore = defineStore('core', () => {
     isResourceFetching,
     isIos,
     isInternetError,
+    isMobile,
   }
 })

package/dist/spa/src/types/Back.ts

@@ -1,5 +1,7 @@
 import type { Express, Request, Response } from 'express';
+import type { AnySchemaObject } from 'ajv';
 import type { Writable } from 'stream';
+import type { ZodType } from 'zod';
 
 import { ActionCheckSource, AdminForthFilterOperators, AdminForthSortDirections, AllowedActionsEnum, AdminForthResourcePages,
   type AdminForthComponentDeclaration, 
@@ -38,6 +40,81 @@ export interface IAdminForthHttpResponse {
     blobStream: () => Writable,
 };
 
+export interface IAdminForthEndpointHandlerInput {
+  body: any;
+  adminUser: AdminUser | undefined;
+  query: {[key: string]: any};
+  headers: {[key: string]: any};
+  cookies: Array<{ key: string, value: string }>;
+  response: IAdminForthHttpResponse;
+  requestUrl: string;
+  abortSignal: AbortSignal;
+  _raw_express_req: Request;
+  _raw_express_res: Response;
+  tr: ITranslateFunction;
+}
+
+export interface IAdminForthEndpointOptions {
+  method: string,
+  noAuth?: boolean,
+  path: string,
+  description?: string,
+  request_schema?: AnySchemaObject,
+  response_schema?: AnySchemaObject,
+  responce_schema?: AnySchemaObject,
+  handler: (input: IAdminForthEndpointHandlerInput) => void | Promise<any>,
+}
+
+export type AdminForthExpressSchemaInput = AnySchemaObject | ZodType;
+
+export interface IAdminForthExpressRouteSchema {
+  /**
+   * Detailed OpenAPI operation description for a custom Express route.
+   */
+  description?: string;
+
+  /**
+   * JSON schema or Zod schema describing the request body for a custom Express route.
+   */
+  request?: AdminForthExpressSchemaInput;
+
+  /**
+   * JSON schema or Zod schema describing the JSON response body for a custom Express route.
+   */
+  response?: AdminForthExpressSchemaInput;
+}
+
+export interface IRegisteredApiSchema {
+  method: string;
+  path: string;
+  description?: string;
+  request_schema?: AnySchemaObject;
+  response_schema?: AnySchemaObject;
+}
+
+export interface IAdminForthApiValidationError {
+  instancePath: string;
+  schemaPath: string;
+  keyword: string;
+  message?: string;
+  params: {[key: string]: any};
+}
+
+export interface IAdminForthApiValidationResult {
+  valid: boolean;
+  errors?: IAdminForthApiValidationError[];
+}
+
+export interface IOpenApiRegistry {
+  registeredSchemas: IRegisteredApiSchema[];
+
+  registerApiSchema(options: IAdminForthEndpointOptions): IRegisteredApiSchema;
+  register_api_schema(options: IAdminForthEndpointOptions): IRegisteredApiSchema;
+  validateRequestSchema(route: IRegisteredApiSchema | null, payload: any): IAdminForthApiValidationResult;
+  validateResponseSchema(route: IRegisteredApiSchema | null, payload: any): IAdminForthApiValidationResult;
+  renderOpenApiDocument(): {[key: string]: any};
+}
+
 /**
  * Implement this interface to create custom HTTP server adapter for AdminForth.
  */
@@ -57,23 +134,7 @@ export interface IHttpServer {
    * 
    * @param options : Object with method, path and handler properties.
    */
-  endpoint(options: {
-    method: string,
-    noAuth?: boolean,
-    path: string,
-    handler: (
-      body: any, 
-      adminUser: any, 
-      query: {[key: string]: string}, 
-      headers: {[key: string]: string}, 
-      cookies: {[key: string]: string}, 
-      response: IAdminForthHttpResponse,
-      requestUrl: string,
-      abortSignal: AbortSignal,
-      _raw_express_req: Request,
-      _raw_express_res: Response,
-    ) => void,
-  }): void;
+  endpoint(options: IAdminForthEndpointOptions): void;
 
 }
 
@@ -107,14 +168,38 @@ export interface IExpressHttpServer extends IHttpServer {
    * ```
    * 
    */  
-  authorize(callable: Function): void;
+  authorize(callable: (...args: any[]) => any): (...args: any[]) => any;
+
+  /**
+   * Method (middleware) to inject translation helper into Express request object.
+   */
+  translatable(callable: (...args: any[]) => any): (...args: any[]) => any;
+
+  /**
+   * Registers OpenAPI schemas for a custom Express route.
+   *
+   * Wrap this around the handler passed to `app.get/post/...`.
+   * If you also need authorization, make `withSchema` the outer wrapper:
+   *
+   * ```ts
+  * import * as z from 'zod';
+  *
+   * app.get('/myApi', admin.express.withSchema({
+   *   description: 'Returns current user profile',
+  *   response: z.object({ user: z.unknown() }),
+   * }, admin.express.authorize((req, res) => {
+   *   res.json({ user: req.adminUser });
+   * })));
+   * ```
+   */
+  withSchema(schema: IAdminForthExpressRouteSchema, callable: (...args: any[]) => any): (...args: any[]) => any;
 }
 
 export interface ITranslateFunction {
   (
     msg: string,
     category: string,
-    params: any,
+    params?: any,
     pluralizationNumber?: number
   ): Promise<string>;
 }
@@ -359,7 +444,8 @@ export interface IAdminForthRestAPI {
 export interface IAdminForth {
   config: AdminForthConfig;
   codeInjector: ICodeInjector;
-  express: IHttpServer;
+  express: IExpressHttpServer;
+  openApi: IOpenApiRegistry;
 
   restApi: IAdminForthRestAPI;
   activatedPlugins: Array<IAdminForthPlugin>;
@@ -535,7 +621,7 @@ export type BeforeDataSourceRequestFunction = (params: {
     body: any,
     query: Record<string, string>,
     headers: Record<string, string>,
-    cookies: Record<string, string>,
+    cookies: { key: string, value: string }[],
     requestUrl: string,
   },
   filtersTools: any,
@@ -573,7 +659,7 @@ export interface HttpExtra {
   body: any,
   query: Record<string, string>,
   headers: Record<string, string>,
-  cookies: Record<string, string>,
+  cookies: { key: string, value: string }[],
   requestUrl: string,
   meta?: any,
   response: IAdminForthHttpResponse
@@ -2021,7 +2107,7 @@ export interface AdminForthBulkAction extends AdminForthBulkActionCommon {
    * It should return Promise which will be resolved when action is done.
    */
   action: ({ resource, selectedIds, adminUser, response, tr }: { 
-    resource: AdminForthResource, selectedIds: Array<any>, adminUser: AdminUser, response: IAdminForthHttpResponse, tr: (key: string, category?: string, params?: any) => string
+    resource: AdminForthResource, selectedIds: Array<any>, adminUser: AdminUser, response: IAdminForthHttpResponse, tr: ITranslateFunction
   }) => Promise<{ ok: boolean, error?: string, successMessage?: string }>,
 
   /**

package/dist/spa/src/types/adapters/CompletionAdapter.ts

@@ -1,9 +1,18 @@
+import type { JSONSchemaType } from "ajv";
+
 export type CompletionStreamEvent = {
   type: "output" | "reasoning";
   delta: string;
   text: string;
   source?: "summary" | "text";
 };
+
+export type CompletionTool<Input = Record<string, any>, Output = any> = {
+  name: string;
+  input_schema: JSONSchemaType<Input>;
+  description?: string;
+  handler: (input: Input) => Promise<Output> | Output;
+};
 export interface CompletionAdapter {
 
   /**
@@ -26,6 +35,7 @@ export interface CompletionAdapter {
     maxTokens: number,
     outputSchema?: any,
     reasoningEffort?: 'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh',
+    tools?: CompletionTool[],
     onChunk?: (
       chunk: string,
       event?: CompletionStreamEvent,

package/dist/spa/src/views/CreateEditSkeleton.vue

@@ -11,50 +11,32 @@
         </div>
       </div>
 
-      <div v-for="i in 5" :key="i" 
-        class="flex items-center bg-lightForm dark:bg-darkForm border-b border-gray-100 dark:border-darkFormBorder"
-        :style="{ height: i === 2 ? '95px' : '75px' }"
-      >
-          <div class="w-[208px] flex-shrink-0 px-6 flex items-center gap-1">
+      <template v-for="column in visibleColumns" :key="column.name">
+        <div
+          class="flex items-center bg-lightForm dark:bg-darkForm border-b border-gray-100 dark:border-darkFormBorder"
+          :style="{ height: getFieldHeight(column) }"
+        >
+          <div class="w-[208px] flex-shrink-0 px-6 flex items-center">
             <Skeleton class="w-24 h-[10px]" />
           </div>
-          
-          <div class="flex-1 px-6"> 
-            <div v-if="i === 2">
-              <Skeleton type="input" class="h-[42px] w-[160px]" />
-              <Skeleton class="mt-1 h-[12px] w-20" />
-            </div>
-                <Skeleton type="input" v-else-if="i === 4 || i === 5" class="h-[42px] w-[160px]" />
-                <Skeleton v-else type="input" class="h-[42px] w-full" />          
-            </div>
-      </div>
 
-      <div class="flex items-start bg-lightForm dark:bg-darkForm" style="height: 759px;">
-        <div class="w-[208px] flex-shrink-0 px-6 pt-7">
-           <Skeleton class="w-24 h-[10px]" />
-        </div>
-        
-        <div class="flex-1 px-6 pt-4 h-full flex flex-col">
-          <div class="flex flex-wrap items-center gap-3 p-1.5 border border-gray-300 dark:border-gray-600 rounded-t-lg bg-gray-50 dark:bg-gray-800 w-full box-border h-[44px]">
-            <template v-for="btn in skeletonButtons" :key="btn.id">
-              <div class=" animate-pulse flex items-center justify-center h-8 px-1 text-gray-300 dark:text-gray-600">
-                <component :is="btn.icon" class="w-5 h-5" />
-              </div>
-              <div v-if="btn.sep" class="w-px h-4 bg-gray-300 dark:bg-gray-600 mx-1"></div>
-            </template>
+          <div class="flex-1 px-6">
+            <Skeleton type="input" :class="getSkeletonInputClass(column)" />
+
+            <div v-if="hasEditingNote(column)" class="mt-1">
+              <Skeleton class="h-[12px] w-20" />
+            </div>
           </div>
-          <div class="flex-1 animate-pulse bg-white dark:bg-gray-950 border-x border-b border-gray-200 dark:border-gray-700 rounded-b-lg w-full shadow-inner"></div>
-          <div class="h-10"></div>
         </div>
-      </div>
+
+      </template>
     </div>
   </div>
 </template>
 
 <script setup lang="ts">
-import { markRaw } from 'vue';
-import { IconExclamationCircleSolid } from '@iconify-prerendered/vue-flowbite';
-import { 
+import { computed, markRaw } from 'vue';
+import {
   IconLinkOutline, IconCodeOutline, IconRectangleListOutline, 
   IconOrderedListOutline, IconLetterBoldOutline, IconLetterUnderlineOutline, 
   IconLetterItalicOutline, IconTextSlashOutline 
@@ -62,6 +44,39 @@ import {
 import { IconH116Solid, IconH216Solid, IconH316Solid } from '@iconify-prerendered/vue-heroicons';
 import { Skeleton } from '@/afcl';
 
+interface Props {
+  resource?: any;
+  page?: string;}
+
+const props = withDefaults(defineProps<Props>(), {
+  page: 'edit'
+});
+
+const visibleColumns = computed(() => {
+  if (!props.resource?.columns) return [];
+
+  return props.resource.columns.filter((col: any) => {
+    if (col.virtual) return false;
+    if (col.primaryKey) return false;
+    if (col.backendOnly) return false;
+    if (col.showIn?.[props.page] === false) return false;
+    return true;
+  });
+});
+
+
+const hasEditingNote = (column: any) => !!column.editingNote;
+
+const getFieldHeight = (column: any) =>
+  hasEditingNote(column) ? '95px' : '75px';
+
+const getSkeletonInputClass = (column: any) => {
+  if (['integer', 'decimal', 'float'].includes(column.type)) {
+    return 'h-[42px] w-[160px]';
+  }
+  return 'h-[42px] w-full';
+};
+
 const skeletonButtons = [
   { id: 'bold', icon: markRaw(IconLetterBoldOutline), sep: false },
   { id: 'italic', icon: markRaw(IconLetterItalicOutline), sep: false },

package/dist/spa/src/views/EditView.vue

@@ -41,7 +41,7 @@
       :adminUser="coreStore.adminUser"
     />
 
-    <CreateEditSkeleton v-if="loading"></CreateEditSkeleton>
+    <CreateEditSkeleton :resource="coreStore.resource" v-if="loading"></CreateEditSkeleton>
  
     <ResourceForm 
       v-else-if="coreStore.resource"

package/dist/types/Back.d.ts

@@ -1,5 +1,7 @@
 import type { Express, Request, Response } from 'express';
+import type { AnySchemaObject } from 'ajv';
 import type { Writable } from 'stream';
+import type { ZodType } from 'zod';
 import { ActionCheckSource, AdminForthFilterOperators, AdminForthSortDirections, AllowedActionsEnum, AdminForthResourcePages, type AdminForthComponentDeclaration, type AdminUser, type AllowedActionsResolved, type AdminForthBulkActionCommon, type AdminForthForeignResourceCommon, type AdminForthResourceColumnCommon, type AdminForthResourceInputCommon, type AdminForthComponentDeclarationFull, type AdminForthConfigMenuItem, type AnnouncementBadgeResponse, type AdminForthResourceColumnInputCommon, type ColumnMinMaxValue } from './Common.js';
 export interface ICodeInjector {
     srcFoldersToSync: Object;
@@ -19,6 +21,81 @@ export interface IAdminForthHttpResponse {
     setStatus: (code: number, message: string) => void;
     blobStream: () => Writable;
 }
+export interface IAdminForthEndpointHandlerInput {
+    body: any;
+    adminUser: AdminUser | undefined;
+    query: {
+        [key: string]: any;
+    };
+    headers: {
+        [key: string]: any;
+    };
+    cookies: Array<{
+        key: string;
+        value: string;
+    }>;
+    response: IAdminForthHttpResponse;
+    requestUrl: string;
+    abortSignal: AbortSignal;
+    _raw_express_req: Request;
+    _raw_express_res: Response;
+    tr: ITranslateFunction;
+}
+export interface IAdminForthEndpointOptions {
+    method: string;
+    noAuth?: boolean;
+    path: string;
+    description?: string;
+    request_schema?: AnySchemaObject;
+    response_schema?: AnySchemaObject;
+    responce_schema?: AnySchemaObject;
+    handler: (input: IAdminForthEndpointHandlerInput) => void | Promise<any>;
+}
+export type AdminForthExpressSchemaInput = AnySchemaObject | ZodType;
+export interface IAdminForthExpressRouteSchema {
+    /**
+     * Detailed OpenAPI operation description for a custom Express route.
+     */
+    description?: string;
+    /**
+     * JSON schema or Zod schema describing the request body for a custom Express route.
+     */
+    request?: AdminForthExpressSchemaInput;
+    /**
+     * JSON schema or Zod schema describing the JSON response body for a custom Express route.
+     */
+    response?: AdminForthExpressSchemaInput;
+}
+export interface IRegisteredApiSchema {
+    method: string;
+    path: string;
+    description?: string;
+    request_schema?: AnySchemaObject;
+    response_schema?: AnySchemaObject;
+}
+export interface IAdminForthApiValidationError {
+    instancePath: string;
+    schemaPath: string;
+    keyword: string;
+    message?: string;
+    params: {
+        [key: string]: any;
+    };
+}
+export interface IAdminForthApiValidationResult {
+    valid: boolean;
+    errors?: IAdminForthApiValidationError[];
+}
+export interface IOpenApiRegistry {
+    registeredSchemas: IRegisteredApiSchema[];
+    registerApiSchema(options: IAdminForthEndpointOptions): IRegisteredApiSchema;
+    register_api_schema(options: IAdminForthEndpointOptions): IRegisteredApiSchema;
+    validateRequestSchema(route: IRegisteredApiSchema | null, payload: any): IAdminForthApiValidationResult;
+    validateResponseSchema(route: IRegisteredApiSchema | null, payload: any): IAdminForthApiValidationResult;
+    renderOpenApiDocument(): {
+        [key: string]: any;
+    };
+}
 /**
  * Implement this interface to create custom HTTP server adapter for AdminForth.
  */
@@ -34,18 +111,7 @@ export interface IHttpServer {
      *
      * @param options : Object with method, path and handler properties.
      */
-    endpoint(options: {
-        method: string;
-        noAuth?: boolean;
-        path: string;
-        handler: (body: any, adminUser: any, query: {
-            [key: string]: string;
-        }, headers: {
-            [key: string]: string;
-        }, cookies: {
-            [key: string]: string;
-        }, response: IAdminForthHttpResponse, requestUrl: string, abortSignal: AbortSignal, _raw_express_req: Request, _raw_express_res: Response) => void;
-    }): void;
+    endpoint(options: IAdminForthEndpointOptions): void;
 }
 export interface IExpressHttpServer extends IHttpServer {
     /**
@@ -73,10 +139,32 @@ export interface IExpressHttpServer extends IHttpServer {
      * ```
      *
      */
-    authorize(callable: Function): void;
+    authorize(callable: (...args: any[]) => any): (...args: any[]) => any;
+    /**
+     * Method (middleware) to inject translation helper into Express request object.
+     */
+    translatable(callable: (...args: any[]) => any): (...args: any[]) => any;
+    /**
+     * Registers OpenAPI schemas for a custom Express route.
+     *
+     * Wrap this around the handler passed to `app.get/post/...`.
+     * If you also need authorization, make `withSchema` the outer wrapper:
+     *
+     * ```ts
+    * import * as z from 'zod';
+    *
+     * app.get('/myApi', admin.express.withSchema({
+     *   description: 'Returns current user profile',
+    *   response: z.object({ user: z.unknown() }),
+     * }, admin.express.authorize((req, res) => {
+     *   res.json({ user: req.adminUser });
+     * })));
+     * ```
+     */
+    withSchema(schema: IAdminForthExpressRouteSchema, callable: (...args: any[]) => any): (...args: any[]) => any;
 }
 export interface ITranslateFunction {
-    (msg: string, category: string, params: any, pluralizationNumber?: number): Promise<string>;
+    (msg: string, category: string, params?: any, pluralizationNumber?: number): Promise<string>;
 }
 export interface IAdminUserExpressRequest extends Omit<Request, 'protocol' | 'param' | 'unshift'> {
     adminUser: AdminUser;
@@ -333,7 +421,8 @@ export interface IAdminForthRestAPI {
 export interface IAdminForth {
     config: AdminForthConfig;
     codeInjector: ICodeInjector;
-    express: IHttpServer;
+    express: IExpressHttpServer;
+    openApi: IOpenApiRegistry;
     restApi: IAdminForthRestAPI;
     activatedPlugins: Array<IAdminForthPlugin>;
     websocket: IWebSocketBroker;
@@ -477,7 +566,10 @@ export type BeforeDataSourceRequestFunction = (params: {
         body: any;
         query: Record<string, string>;
         headers: Record<string, string>;
-        cookies: Record<string, string>;
+        cookies: {
+            key: string;
+            value: string;
+        }[];
         requestUrl: string;
     };
     filtersTools: any;
@@ -519,7 +611,10 @@ export interface HttpExtra {
     body: any;
     query: Record<string, string>;
     headers: Record<string, string>;
-    cookies: Record<string, string>;
+    cookies: {
+        key: string;
+        value: string;
+    }[];
     requestUrl: string;
     meta?: any;
     response: IAdminForthHttpResponse;
@@ -1756,7 +1851,7 @@ export interface AdminForthBulkAction extends AdminForthBulkActionCommon {
         selectedIds: Array<any>;
         adminUser: AdminUser;
         response: IAdminForthHttpResponse;
-        tr: (key: string, category?: string, params?: any) => string;
+        tr: ITranslateFunction;
     }) => Promise<{
         ok: boolean;
         error?: string;