Merge branch 'next' of github.com:devforth/adminforth into next

Author: yaroslav8765

adminforth/documentation/docs/tutorial/03-Customization/09-Actions.md

@@ -163,9 +163,12 @@ Instead of defining an `action` handler, you can specify a `url` that the user w
 }
 ```
 
+> ☝️ Note: You cannot specify both `action` and `url` for the same action - only one should be used.
+
 The URL can be:
 - A relative path within your admin panel (starting with '/')
 - An absolute URL (starting with 'http://' or 'https://')
+- function which creates URL based on record fields
 
 To open the URL in a new tab, append `target=_blank` as a query parameter. If the URL already has query parameters, use `&target=_blank`; otherwise use `?target=_blank`:
 
@@ -181,7 +184,46 @@ To open the URL in a new tab, append `target=_blank` as a query parameter. If th
 }
 ```
 
-> ☝️ Note: You cannot specify both `action` and `url` for the same action - only one should be used.
+Example to generate dynamic URL:
+
+```ts
+{
+  name: 'View on Google',
+  icon: 'flowbite:external-link-solid',
+  url: async ({record, recordId, adminUser, resource }) => `https://google.com/search?q=Apartment ${record.title}`,
+  showIn: {
+    list: true,
+    showButton: true
+  }
+}
+```
+
+> ☝️ Note: Though url function might be async we recommend to omit long awaits, or ideally don't use them at all, cause slow execution of this hook might be a subject of bottleneck for resource pages rendering. For built actions the async functions would be called in parallel to optimize loading speed.
+
+
+### Deep-level redirects.
+
+Using `url` prop described above is recommended way to implementing URL navigation from actions (internal or external), because URLs are rendered into direct anchour tag and support all anchour features (like Open in new tab). 
+
+However, rearely you might also like to decide whether to redirect only after performing some logic (conditionally). This way is not recommended for most of cases, because it is not compatible with action native features (we can't know URL before executing action body):
+
+
+```ts
+{
+  name: 'View on Google',
+  icon: 'flowbite:external-link-solid',
+  action: async ({ recordId }) => {
+    if (await testSomething(recordId)) {
+        return { ok: true, redirectUrl: 'https://google.com/search?q=apartment' };
+    };
+    return { ok: true, successMessage: 'Done' };
+  },
+  showIn: {
+    list: true,
+    showButton: true
+  }
+}
+```
 
 ## Custom Component
 
@@ -313,4 +355,4 @@ Backend handler: read the payload via `extra`.
 
 Notes:
 - If you don’t emit a payload, the default behavior is used by the UI (e.g., in lists the current row context is used). When you do provide a payload, it will be forwarded to the backend as `extra` for your action handler.
-- You can combine default context with your own payload by merging before emitting, for example: `emit('callAction', { ...row, asListed: true })` if your component has access to the row object.
+- You can combine default context with your own payload by merging before emitting, for example: `emit('callAction', { ...row, asListed: true })` if your component has access to the row object.

adminforth/modules/restApi.ts

@@ -2238,6 +2238,11 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
         if (!resource) {
           return { error: await tr(`Resource {resourceId} not found`, 'errors', { resourceId }) };
         }
+
+        const record = await this.adminforth.connectors[resource.dataSource].getRecordByPrimaryKey(resource, recordId);
+        if (!record){
+            return { error: `Record with ${recordId} not found` };
+        }
         const { allowedActions } = await interpretResource(
           adminUser, 
           resource, 
@@ -2257,16 +2262,18 @@ export default class AdminForthRestAPI implements IAdminForthRestAPI {
         }
 
         if (action.url) {
+          const redirectUrl = typeof action.url === 'function'
+            ? await action.url({ record, recordId, adminUser, resource })
+            : action.url;
           return {
             actionId,
             recordId,
+            record,
             resourceId,
-            redirectUrl: action.url
+            redirectUrl,
           }
         }
-
         const actionResponse = await action.action({ recordId, adminUser, resource, tr, adminforth: this.adminforth, response, extra: {...extra, cookies: cookies, headers: headers} });
-        
         return {
           actionId,
           recordId,

adminforth/spa/src/afcl/Link.vue

@@ -1,17 +1,37 @@
 <template>
+  <a 
+    v-if="isExternal"
+    v-bind="$attrs"
+    :href="to"
+    :target="target"
+    rel="noopener noreferrer"
+    :class="linkClasses"
+  >
+    <slot></slot>
+  </a>
+
   <router-link 
+    v-else
     v-bind="$attrs"
     :to="to"
-    class="afcl-link text-lightPrimary underline dark:text-darkPrimary hover:no-underline hover:brightness-110
-      cursor-pointer"
+    :target="target"
+    :class="linkClasses"
   >
     <slot></slot>
   </router-link>
 </template>
 
 <script setup lang="ts">
+import { computed } from 'vue';
 
-defineProps<{
+const props = defineProps<{
   to: string,
-}>()
+  target?: 'blank' | 'self' | 'parent' | 'top'
+}>();
+
+const isExternal = computed(() => {
+  return typeof props.to === 'string' && props.to.startsWith('http');
+});
+
+const linkClasses = "afcl-link text-lightPrimary underline dark:text-darkPrimary hover:no-underline hover:brightness-110 cursor-pointer";
 </script>

adminforth/spa/src/utils/listUtils.ts

@@ -61,6 +61,7 @@ export async function startBulkAction(actionId: string, resource: AdminForthReso
   if (action?.confirm) {
     const confirmed = await confirm({
       title: action.confirm,
+      message: t(`Deleting ${checkboxes.value.length} ${checkboxes.value.length === 1 ? 'item' : 'items'}. This process is irreversible.`),
     });
     if (!confirmed) {
       return;

adminforth/types/Back.ts

@@ -1424,7 +1424,7 @@ export interface AdminForthActionInput {
     adminUser: AdminUser;
     standardAllowedActions: AllowedActions;
   }) => boolean | Promise<boolean>);
-  url?: string;
+  url?: string | ((params: { adminUser: AdminUser; resource: AdminForthResource; recordId: string, record: any }) => string);
   bulkHandler?: (params: {
       adminforth: IAdminForth;
       resource: AdminForthResource;

adminforth/types/adapters/AudioAdapter.ts

@@ -0,0 +1,73 @@
+export type SpeechToTextInput = {
+  buffer: Buffer;
+  filename: string;
+  mimeType: string;
+  language?: string;
+  prompt?: string;
+};
+
+export type SpeechToTextResult = {
+  text: string;
+  language?: string;
+  raw?: unknown;
+};
+
+export interface SpeechToTextAdapter {
+  name: string;
+
+  validate(): void;
+
+  transcribe(input: SpeechToTextInput): Promise<SpeechToTextResult>;
+}
+
+export type TtsAudioFormat =
+  | "mp3"
+  | "opus"
+  | "aac"
+  | "flac"
+  | "wav"
+  | "pcm";
+
+export type TextToSpeechInput<Voice extends string = string> = {
+  text: string;
+  voice?: Voice;
+  format?: TtsAudioFormat;
+  speed?: number;
+  instructions?: string;
+  stream?: false;
+};
+
+export type TextToSpeechResult = {
+  audio: Buffer;
+  mimeType: string;
+  format: TtsAudioFormat;
+  raw?: unknown;
+};
+
+export type TtsStreamFormat = "audio" | "sse";
+
+export type TextToSpeechStreamInput<Voice extends string = string> =
+  Omit<TextToSpeechInput<Voice>, "stream"> & {
+    stream: true;
+    streamFormat?: TtsStreamFormat;
+  };
+
+export type TextToSpeechStreamResult = {
+  audioStream: ReadableStream<Uint8Array>;
+  mimeType: string;
+  format: TtsAudioFormat;
+  streamFormat: TtsStreamFormat;
+  raw?: unknown;
+};
+
+export interface TextToSpeechAdapter<Voice extends string = string> {
+  name: string;
+
+  validate(): void;
+
+  synthesize(input: TextToSpeechStreamInput<Voice>): Promise<TextToSpeechStreamResult>;
+  synthesize(input: TextToSpeechInput<Voice>): Promise<TextToSpeechResult>;
+}
+
+export type AudioAdapter<Voice extends string = string> =
+  SpeechToTextAdapter & TextToSpeechAdapter<Voice>;

adminforth/types/adapters/index.ts

@@ -15,3 +15,13 @@ export type { ImageVisionAdapter } from './ImageVisionAdapter.js';
 export type { OAuth2Adapter } from './OAuth2Adapter.js';
 export type { StorageAdapter } from './StorageAdapter.js';
 export type { CaptchaAdapter } from './CaptchaAdapter.js';
+export type {
+	AudioAdapter,
+	SpeechToTextAdapter,
+	SpeechToTextInput,
+	SpeechToTextResult,
+	TextToSpeechAdapter,
+	TextToSpeechInput,
+	TextToSpeechResult,
+	TtsAudioFormat,
+} from './AudioAdapter.js';