fix: removed Adapters.ts and created 5 new adapters files and one index.js file

Author: yaroslav8765

adminforth/index.ts

@@ -38,7 +38,7 @@ import SocketBroker from './modules/socketBroker.js';
 // exports
 export * from './types/Back.js';
 export * from './types/Common.js';
-export * from './types/Adapters.js';
+export {EmailAdapter, CompletionAdapter,ImageGenerationAdapter, OAuth2Adapter, StorageAdapter} from './types/adapters/index.js';
 export { interpretResource };
 export { AdminForthPlugin };
 export { suggestIfTypo, RateLimiter, RAMLock, getClientIp };

adminforth/types/Adapters.ts

@@ -0,0 +1,25 @@
+export interface CompletionAdapter {
+
+  /**
+   * This method is called to validate the configuration of the adapter
+   * and should throw a clear user-readbale error if the configuration is invalid.
+   */
+  validate(): void;
+
+  /**
+   * This method should return a text completion based on the provided content and stop sequence.
+   * @param content - The input text to complete
+   * @param stop - An array of stop sequences to indicate where to stop the completion
+   * @param maxTokens - The maximum number of tokens to generate
+   * @returns A promise that resolves to an object containing the completed text and other metadata
+   */
+  complete(
+    content: string,
+    stop: string[],
+    maxTokens: number,
+  ): Promise<{
+    content?: string;
+    finishReason?: string;
+    error?: string;
+  }>;
+}

adminforth/types/adapters/CompletionAdapter.ts

@@ -0,0 +1,27 @@
+export interface EmailAdapter {
+
+  /**
+   * This method is called to validate the configuration of the adapter
+   * and should throw a clear user-readbale error if the configuration is invalid.
+   */
+  validate(): Promise<void>;
+
+  /**
+   * This method should send an email using the adapter
+   * @param from - The sender's email address
+   * @param to - The recipient's email address
+   * @param text - The plain text version of the email
+   * @param html - The HTML version of the email
+   * @param subject - The subject of the email
+   */
+  sendEmail(
+    from: string,
+    to: string,
+    text: string,
+    html: string,
+    subject: string
+  ): Promise<{
+    error?: string;
+    ok?: boolean;
+  }>;
+}

adminforth/types/adapters/EmailAdapter.ts

@@ -0,0 +1,50 @@
+export interface ImageGenerationAdapter {
+
+  /**
+   * This method is called to validate the configuration of the adapter
+   * and should throw a clear user-readbale error if the configuration is invalid.
+   */
+  validate(): void;
+
+  /**
+   * Return max number of images which model can generate in one request
+   */
+  outputImagesMaxCountSupported(): number;
+
+  /**
+   * Return the list of supported dimensions in format ["100x500", "200x200"]
+   */
+  outputDimensionsSupported(): string[];
+
+  /**
+   * Input file extension supported
+   */
+  inputFileExtensionSupported(): string[];
+
+  /**
+   * This method should generate an image based on the provided prompt and input files.
+   * @param prompt - The prompt to generate the image
+   * @param inputFiles - An array of input file paths (optional)
+   * @param n - The number of images to generate (default is 1)
+   * @param size - The size of the generated image (default is the lowest dimension supported)
+   * @returns A promise that resolves to an object containing the generated image URLs and any error message
+   */
+  generate({
+    prompt, 
+    inputFiles,
+    n,
+    size,
+  }: {
+    prompt: string,
+    inputFiles: string[],
+
+    // default = lowest dimension supported 
+    size?: string,
+
+    // one by default
+    n?: number
+  }): Promise<{
+    imageURLs?: string[];
+    error?: string;
+  }>;
+}

adminforth/types/adapters/ImageGenerationAdapter.ts

@@ -0,0 +1,34 @@
+
+/**
+ * This interface is used to implement OAuth2 authentication adapters.
+ */
+export interface OAuth2Adapter {
+  /**
+   * This method should return navigatable URL to the OAuth2 provider authentication page.
+   */
+  getAuthUrl(): string;
+
+  /**
+   * This method should return the token from the OAuth2 provider using the provided code and redirect URI.
+   * @param code - The authorization code received from the OAuth2 provider
+   * @param redirect_uri - The redirect URI used in the authentication request
+   * @returns A promise that resolves to an object containing the email address of the authenticated user
+   */
+  getTokenFromCode(code: string, redirect_uri: string): Promise<{ email: string }>;
+
+  /**
+   * This method should return text (content) of SVG icon which will be used in the UI.
+   * Use official SVG icons with simplest possible conent, omit icons which have base64 encoded raster images inside.
+   */
+  getIcon(): string;
+
+  /**
+   * This method should return the text to be displayed on the button in the UI
+   */
+  getButtonText?(): string;
+
+  /**
+   * This method should return the name of the adapter
+   */
+  getName?(): string;
+}