adminforth 1.21.0 → 1.22.0

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

@@ -1,6 +1,19 @@
 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,
@@ -15,8 +28,19 @@ export interface EmailAdapter {
 
 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[],
@@ -30,10 +54,14 @@ export interface CompletionAdapter {
 
 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 1 or 10, or Infinity if the adapter supports multiple images
+   * Return max number of images which model can generate in one request
    */
   outputImagesMaxCountSupported(): number;
 
@@ -47,6 +75,14 @@ export interface ImageGenerationAdapter {
    */
   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,
@@ -68,11 +104,91 @@ export interface ImageGenerationAdapter {
 }
 
 
-
+/**
+ * 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;
 }
+
+
+export interface StorageAdapter {
+  /**
+   * This method should return the presigned URL for the given key capable of upload (adapter user will call PUT multipart form data to this URL within expiresIn seconds after link generation).
+   * By default file which will be uploaded on PUT should be marked for deletion. So if during 24h it is not marked for not deletion, it adapter should delete it forever.
+   * The PUT method should fail if the file already exists.
+   * 
+   * Adapter user will always pass next parameters to the method:
+   * @param key - The key of the file to be uploaded e.g. "uploads/file.txt"
+   * @param expiresIn - The expiration time in seconds for the presigned URL
+   * @param contentType - The content type of the file to be uploaded, e.g. "image/png"
+   * 
+   * @returns A promise that resolves to an object containing the upload URL and any extra parameters which should be sent with PUT multipart form data
+   */
+  getUploadSignedUrl(key: string, contentType: string, expiresIn?: number): Promise<{
+    uploadUrl: string;
+    uploadExtraParams?: Record<string, string>;
+  }>;
+
+  /**
+   * This method should return the URL for the given key capable of download (200 GET request with response body or 200 HEAD request without response body).
+   * If adapter configured to use public storage, this method should return the public URL of the file.
+   * If adapter configured to use private storage, this method should return the presigned URL for the file.
+   * 
+   * @param key - The key of the file to be downloaded e.g. "uploads/file.txt"
+   * @param expiresIn - The expiration time in seconds for the presigned URL
+   */
+  getDownloadUrl(key: string, expiresIn?: number): Promise<string>;
+
+  /**
+   * This method should mark the file for deletion.
+   * If file is marked for delation and exists more then 24h (since creation date) it should be deleted.
+   * This method should work even if the file does not exist yet (e.g. only presigned URL was generated).
+   * @param key - The key of the file to be uploaded e.g. "uploads/file.txt"
+   */
+  markKeyForDeletation(key: string): Promise<string>;
+
+
+  /**
+   * This method should mark the file to not be deleted.
+   * This method should be used to cancel the deletion of the file if it was marked for deletion.
+   * @param key - The key of the file to be uploaded e.g. "uploads/file.txt"
+   */
+  markKeyForNotDeletation(key: string): Promise<string>;
+
+
+  /**
+   * This method can start needed schedullers, cron jobs, etc. to clean up the storage.
+   */
+  setupLifecycle(): Promise<void>;
+
+}
+
+  

package/dist/spa/src/utils.ts

@@ -30,9 +30,9 @@ export async function callApi({path, method, body=undefined}: {
       return null;
     } 
     return await r.json();
-  } catch(e){
+  } catch(e) {
     adminforth.alert({variant:'danger', message: window.i18n?.global?.t('Something went wrong, please try again later'),})
-    console.error(`error in callApi ${path}`,e);
+    console.error(`error in callApi ${path}`, e);
   }
 }
 

package/dist/types/Adapters.d.ts

@@ -1,12 +1,35 @@
 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;
     }>;
 }
 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;
@@ -14,9 +37,13 @@ export interface CompletionAdapter {
     }>;
 }
 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 1 or 10, or Infinity if the adapter supports multiple images
+     * Return max number of images which model can generate in one request
      */
     outputImagesMaxCountSupported(): number;
     /**
@@ -27,6 +54,14 @@ export interface ImageGenerationAdapter {
      * 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[];
@@ -37,13 +72,79 @@ export interface ImageGenerationAdapter {
         error?: string;
     }>;
 }
+/**
+ * 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;
 }
+export interface StorageAdapter {
+    /**
+     * This method should return the presigned URL for the given key capable of upload (adapter user will call PUT multipart form data to this URL within expiresIn seconds after link generation).
+     * By default file which will be uploaded on PUT should be marked for deletion. So if during 24h it is not marked for not deletion, it adapter should delete it forever.
+     * The PUT method should fail if the file already exists.
+     *
+     * Adapter user will always pass next parameters to the method:
+     * @param key - The key of the file to be uploaded e.g. "uploads/file.txt"
+     * @param expiresIn - The expiration time in seconds for the presigned URL
+     * @param contentType - The content type of the file to be uploaded, e.g. "image/png"
+     *
+     * @returns A promise that resolves to an object containing the upload URL and any extra parameters which should be sent with PUT multipart form data
+     */
+    getUploadSignedUrl(key: string, contentType: string, expiresIn?: number): Promise<{
+        uploadUrl: string;
+        uploadExtraParams?: Record<string, string>;
+    }>;
+    /**
+     * This method should return the URL for the given key capable of download (200 GET request with response body or 200 HEAD request without response body).
+     * If adapter configured to use public storage, this method should return the public URL of the file.
+     * If adapter configured to use private storage, this method should return the presigned URL for the file.
+     *
+     * @param key - The key of the file to be downloaded e.g. "uploads/file.txt"
+     * @param expiresIn - The expiration time in seconds for the presigned URL
+     */
+    getDownloadUrl(key: string, expiresIn?: number): Promise<string>;
+    /**
+     * This method should mark the file for deletion.
+     * If file is marked for delation and exists more then 24h (since creation date) it should be deleted.
+     * This method should work even if the file does not exist yet (e.g. only presigned URL was generated).
+     * @param key - The key of the file to be uploaded e.g. "uploads/file.txt"
+     */
+    markKeyForDeletation(key: string): Promise<string>;
+    /**
+     * This method should mark the file to not be deleted.
+     * This method should be used to cancel the deletion of the file if it was marked for deletion.
+     * @param key - The key of the file to be uploaded e.g. "uploads/file.txt"
+     */
+    markKeyForNotDeletation(key: string): Promise<string>;
+    /**
+     * This method can start needed schedullers, cron jobs, etc. to clean up the storage.
+     */
+    setupLifecycle(): Promise<void>;
+}
 //# sourceMappingURL=Adapters.d.ts.map

package/dist/types/Adapters.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Adapters.d.ts","sourceRoot":"","sources":["../../types/Adapters.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,EAAE,CAAC,EAAE,OAAO,CAAC;KACd,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,iBAAiB;IAEhC,QAAQ,IAAI,IAAI,CAAC;IAEjB,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EAAE,EACd,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC;QACT,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,sBAAsB;IAErC,QAAQ,IAAI,IAAI,CAAC;IAEjB;;OAEG;IACH,6BAA6B,IAAI,MAAM,CAAC;IAExC;;OAEG;IACH,yBAAyB,IAAI,MAAM,EAAE,CAAC;IAEtC;;OAEG;IACH,2BAA2B,IAAI,MAAM,EAAE,CAAC;IAExC,QAAQ,CAAC,EACP,MAAM,EACN,UAAU,EACV,CAAC,EACD,IAAI,GACL,EAAE;QACD,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,EAAE,CAAC;QAGrB,IAAI,CAAC,EAAE,MAAM,CAAC;QAGd,CAAC,CAAC,EAAE,MAAM,CAAA;KACX,GAAG,OAAO,CAAC;QACV,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;CACJ;AAID,MAAM,WAAW,aAAa;IAC5B,UAAU,IAAI,MAAM,CAAC;IACrB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjF,OAAO,IAAI,MAAM,CAAC;IAClB,aAAa,CAAC,IAAI,MAAM,CAAC;IACzB,OAAO,CAAC,IAAI,MAAM,CAAC;CACpB"}
+{"version":3,"file":"Adapters.d.ts","sourceRoot":"","sources":["../../types/Adapters.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAE3B;;;OAGG;IACH,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1B;;;;;;;OAOG;IACH,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GACd,OAAO,CAAC;QACT,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,EAAE,CAAC,EAAE,OAAO,CAAC;KACd,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,iBAAiB;IAEhC;;;OAGG;IACH,QAAQ,IAAI,IAAI,CAAC;IAEjB;;;;;;OAMG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EAAE,EACd,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC;QACT,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,sBAAsB;IAErC;;;OAGG;IACH,QAAQ,IAAI,IAAI,CAAC;IAEjB;;OAEG;IACH,6BAA6B,IAAI,MAAM,CAAC;IAExC;;OAEG;IACH,yBAAyB,IAAI,MAAM,EAAE,CAAC;IAEtC;;OAEG;IACH,2BAA2B,IAAI,MAAM,EAAE,CAAC;IAExC;;;;;;;OAOG;IACH,QAAQ,CAAC,EACP,MAAM,EACN,UAAU,EACV,CAAC,EACD,IAAI,GACL,EAAE;QACD,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,EAAE,CAAC;QAGrB,IAAI,CAAC,EAAE,MAAM,CAAC;QAGd,CAAC,CAAC,EAAE,MAAM,CAAA;KACX,GAAG,OAAO,CAAC;QACV,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;CACJ;AAGD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,UAAU,IAAI,MAAM,CAAC;IAErB;;;;;OAKG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAEjF;;;OAGG;IACH,OAAO,IAAI,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,IAAI,MAAM,CAAC;IAEzB;;OAEG;IACH,OAAO,CAAC,IAAI,MAAM,CAAC;CACpB;AAGD,MAAM,WAAW,cAAc;IAC7B;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAChF,SAAS,EAAE,MAAM,CAAC;QAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAC5C,CAAC,CAAC;IAEH;;;;;;;OAOG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjE;;;;;OAKG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAGnD;;;;OAIG;IACH,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAGtD;;OAEG;IACH,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAEjC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adminforth",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "description": "OpenSource Vue3 powered forth-generation admin panel",
   "main": "dist/index.js",
   "module": "dist/index.js",