mblabs-roccato-backend-commons 1.0.8 → 1.1.0

package/src/interfaces/azure.ts

@@ -7,39 +7,31 @@ interface Credentials {
 export namespace AzureApplicationInsights {
   export namespace TrackTrace {
     export interface Request {
-      data: {
-        message: string;
-        severity: string;
-      };
+      message: string;
+      severity: string;
       credentials: Credentials;
     }
   }
 
   export namespace TrackEvent {
     export interface Request {
-      data: {
-        name: string;
-        properties?: { [key: string]: string };
-      };
+      name: string;
+      properties?: { [key: string]: string };
       credentials: Credentials;
     }
   }
 
   export namespace TrackException {
     export interface Request {
-      data: {
-        error: Error;
-      };
+      error: Error;
       credentials: Credentials;
     }
   }
 
   export namespace TrackMetric {
     export interface Request {
-      data: {
-        name: string;
-        value: number;
-      };
+      name: string;
+      value: number;
       credentials: Credentials;
     }
   }
@@ -48,37 +40,31 @@ export namespace AzureApplicationInsights {
 export namespace AzureCommunication {
   export namespace SendMail {
     export interface Request {
-      data: {
-        subject: string;
-        text: string;
-        emails: string | string[];
-        from: string;
-        variables?: Record<string, string | number>;
-      };
+      subject: string;
+      text: string;
+      emails: string | string[];
+      from: string;
+      variables?: Record<string, string | number>;
       credentials: Credentials;
     }
   }
 
   export namespace SendTemplateMail {
     export interface Request {
-      data: {
-        subject: string;
-        template: string;
-        emails: string | string[];
-        from: string;
-        variables?: Record<string, string | number>;
-      };
+      subject: string;
+      template: string;
+      emails: string | string[];
+      from: string;
+      variables?: Record<string, string | number>;
       credentials: Credentials;
     }
   }
 
   export namespace SendSMS {
     export interface Request {
-      data: {
-        sender: string;
-        text: string;
-        phones: string | string[];
-      };
+      sender: string;
+      text: string;
+      phones: string | string[];
       credentials: Credentials;
     }
   }
@@ -87,11 +73,8 @@ export namespace AzureCommunication {
 export namespace AzureKeyVault {
   export namespace GetSecret {
     export interface Request {
-      data: {
-        vault: string;
-        secretName: string;
-      };
-      credentials: Credentials;
+      vault: string;
+      secretName: string;
     }
 
     export interface Response<T> {
@@ -103,23 +86,19 @@ export namespace AzureKeyVault {
 export namespace AzureStorageBlob {
   export namespace UploadBuffer {
     export interface Request {
-      data: {
-        storageContainer: string;
-        storageUrl: string;
-        filename: string;
-        file: Buffer;
-      };
+      storageContainer: string;
+      storageUrl: string;
+      filename: string;
+      file: Buffer;
       credentials: Credentials;
     }
   }
 
   export namespace DownloadBuffer {
     export interface Request {
-      data: {
-        storageContainer: string;
-        storageUrl: string;
-        filename: string;
-      };
+      storageContainer: string;
+      storageUrl: string;
+      filename: string;
       credentials: Credentials;
     }
 
@@ -130,16 +109,14 @@ export namespace AzureStorageBlob {
 
   export namespace GetPreSignedUrl {
     export interface Request {
-      data: {
-        filename: string;
-        storageContainer: string;
-        storageUrl: string;
-        options?: {
-          version?: string;
-          hoursToExpire?: number;
-          contentType?: string;
-          contentEncoding?: string;
-        };
+      filename: string;
+      storageContainer: string;
+      storageUrl: string;
+      options?: {
+        version?: string;
+        hoursToExpire?: number;
+        contentType?: string;
+        contentEncoding?: string;
       };
       credentials: Credentials;
     }
@@ -151,24 +128,26 @@ export namespace AzureStorageBlob {
 }
 
 export interface IAzureApplicationInsightsService {
-  trackTrace(req: AzureApplicationInsights.TrackTrace.Request): Promise<void>;
-  trackEvent(req: AzureApplicationInsights.TrackEvent.Request): Promise<void>;
-  trackException(req: AzureApplicationInsights.TrackException.Request): Promise<void>;
-  trackMetric(req: AzureApplicationInsights.TrackMetric.Request): Promise<void>;
+  trackTrace (req: AzureApplicationInsights.TrackTrace.Request): Promise<void>;
+  trackEvent (req: AzureApplicationInsights.TrackEvent.Request): Promise<void>;
+  trackException (req: AzureApplicationInsights.TrackException.Request): Promise<void>;
+  trackMetric (req: AzureApplicationInsights.TrackMetric.Request): Promise<void>;
 }
 
 export interface IAzureCommunicationService {
-  sendMail(req: AzureCommunication.SendMail.Request): Promise<void>;
-  sendSMS(req: AzureCommunication.SendSMS.Request): Promise<void>;
-  sendTemplateMail(req: AzureCommunication.SendTemplateMail.Request): Promise<void>;
+  sendMail (req: AzureCommunication.SendMail.Request): Promise<void>;
+  sendSMS (req: AzureCommunication.SendSMS.Request): Promise<void>
+  sendTemplateMail (req: AzureCommunication.SendTemplateMail.Request): Promise<void>
 }
 
 export interface IAzureKeyVaultService {
-  getSecret<T>(req: AzureKeyVault.GetSecret.Request): Promise<AzureKeyVault.GetSecret.Response<T>>;
+  getSecret <T>(req: AzureKeyVault.GetSecret.Request): Promise<AzureKeyVault.GetSecret.Response<T>>;
 }
 
 export interface IAzureStorageBlobService {
-  uploadBuffer(req: AzureStorageBlob.UploadBuffer.Request): Promise<void>;
-  downloadBuffer(req: AzureStorageBlob.DownloadBuffer.Request): Promise<AzureStorageBlob.DownloadBuffer.Response>;
-  getPreSignedUrl(req: AzureStorageBlob.GetPreSignedUrl.Request): Promise<AzureStorageBlob.GetPreSignedUrl.Response>;
+  uploadBuffer (req: AzureStorageBlob.UploadBuffer.Request): Promise<void>;
+  downloadBuffer (req: AzureStorageBlob.DownloadBuffer.Request): Promise<AzureStorageBlob.DownloadBuffer.Response>;
+  getPreSignedUrl (
+    req: AzureStorageBlob.GetPreSignedUrl.Request,
+  ): Promise<AzureStorageBlob.GetPreSignedUrl.Response>;
 }

package/src/interfaces/firebase.ts

@@ -9,25 +9,21 @@ interface Credentials {
 export namespace Firebase {
   export namespace SendNotification {
     export interface Request {
-      data: {
-        message: FirebaseAdmin.messaging.MulticastMessage;
-        isTest: boolean;
-      };
+      message: FirebaseAdmin.messaging.MulticastMessage;
+      isTest: boolean;
       credentials: Credentials;
     }
   }
 
   export namespace PublishConfig {
     export interface Request {
-      data: {
-        template: string;
-      };
+      template: string;
       credentials: Credentials;
     }
   }
 }
 
 export interface IFirebaseService {
-  sendNotification(req: Firebase.SendNotification.Request): Promise<void>;
-  publishConfig(req: Firebase.PublishConfig.Request): Promise<void>;
-}
+  sendNotification (req: Firebase.SendNotification.Request): Promise<void>;
+  publishConfig (req: Firebase.PublishConfig.Request): Promise<void>;
+}

package/src/interfaces/gcp.ts

@@ -7,9 +7,7 @@ interface Credentials {
 export namespace GoogleDrive {
   export namespace ReadFile {
     export interface Request {
-      data: {
-        file: string;
-      };
+      fileId: string;
       credentials: Credentials;
     }
 
@@ -22,10 +20,8 @@ export namespace GoogleDrive {
 export namespace GoogleSheets {
   export namespace ReadSheet {
     export interface Request {
-      data: {
-        spreadsheet: string;
-        tabs: string[];
-      };
+      spreadsheetId: string;
+      tabs: string[];
       credentials: Credentials;
     }
 
@@ -38,10 +34,8 @@ export namespace GoogleSheets {
 export namespace GoogleSecrets {
   export namespace GetSecret {
     export interface Request {
-      data: {
-        project: string;
-        secret: string;
-      };
+      projectId: string;
+      secretId: string;
       credentials: Credentials;
     }
 
@@ -52,13 +46,13 @@ export namespace GoogleSecrets {
 }
 
 export interface IGoogleSecretsService {
-  getSecret<T>(req: GoogleSecrets.GetSecret.Request): Promise<GoogleSecrets.GetSecret.Response<T>>;
+  getSecret <T>(req: GoogleSecrets.GetSecret.Request): Promise<GoogleSecrets.GetSecret.Response<T>>;
 }
 
 export interface IGoogleDriveService {
-  readFile(req: GoogleDrive.ReadFile.Request): Promise<GoogleDrive.ReadFile.Response>;
+  readFile (req: GoogleDrive.ReadFile.Request): Promise<GoogleDrive.ReadFile.Response>;
 }
 
 export interface IGoogleSheetsService {
-  readSheet(req: GoogleSheets.ReadSheet.Request): Promise<GoogleSheets.ReadSheet.Response>;
+  readSheet (req: GoogleSheets.ReadSheet.Request): Promise<GoogleSheets.ReadSheet.Response>;
 }

package/src/interfaces/grafana.ts

@@ -6,9 +6,7 @@ interface Credentials {
 export namespace Grafana {
   export namespace GetDashboard {
     export interface Request {
-      data: {
-        uid: string;
-      };
+      uid: string;
       credentials: Credentials;
     }
 
@@ -19,9 +17,7 @@ export namespace Grafana {
 
   export namespace SearchDashboard {
     export interface Request {
-      data: {
-        query: string;
-      };
+      query: string;
       credentials: Credentials;
     }
 
@@ -32,6 +28,6 @@ export namespace Grafana {
 }
 
 export interface IGrafanaService {
-  getDashboard(req: Grafana.GetDashboard.Request): Promise<Grafana.GetDashboard.Response>;
-  searchDashboard(req: Grafana.SearchDashboard.Request): Promise<Grafana.SearchDashboard.Response>;
-}
+  getDashboard (req: Grafana.GetDashboard.Request): Promise<Grafana.GetDashboard.Response>;
+  searchDashboard (req: Grafana.SearchDashboard.Request): Promise<Grafana.SearchDashboard.Response>;
+}

package/src/interfaces/keycloak.ts

@@ -1,41 +1,16 @@
 interface Credentials {
-  clientId: string;
   realm: string;
+  clientId: string;
   clientSecret: string;
   grantType: string;
 }
 
-export interface Roles {
-  id: string;
-  name: string;
-  description: string;
-}
-
 export namespace Keycloak {
   export namespace Authenticate {
     export interface Request {
       url: string;
-      data: {
-        username: string;
-        password: string;
-      };
-      credentials: Credentials;
-    }
-
-    export interface Response {
-      access_token: string;
-      expires_in: number;
-      refresh_expires_in: number;
-      refresh_token: string;
-      token_type: string;
-      profileType?: number;
-      active?: boolean;
-    }
-  }
-
-  export namespace AuthenticateServer {
-    export interface Request {
-      url: string;
+      username: string;
+      password: string;
       credentials: Credentials;
     }
 
@@ -53,9 +28,7 @@ export namespace Keycloak {
   export namespace RefreshAccess {
     export interface Request {
       url: string;
-      data: {
-        refreshToken: string;
-      };
+      refreshToken: string;
       credentials: Credentials;
     }
 
@@ -69,165 +42,9 @@ export namespace Keycloak {
       active?: boolean;
     }
   }
-
-  export namespace RevokeAccess {
-    export interface Request {
-      url: string;
-      data: {
-        accessToken: string;
-      };
-      credentials: Credentials;
-    }
-  }
-
-  export namespace CreateUser {
-    export interface Request {
-      url: string;
-      data: {
-        username: string;
-        firstName: string;
-        lastName?: string;
-        email: string;
-        password: string;
-        isTemporaryPassword?: boolean;
-        groups: string[];
-      };
-      credentials: Credentials;
-    }
-  }
-
-  export namespace UpdateUser {
-    export interface Request {
-      url: string;
-      data: {
-        id: string;
-        username?: string;
-        firstName?: string;
-        lastName?: string;
-        email?: string;
-        password?: string;
-        isTemporaryPassword?: boolean;
-        groups?: string[];
-      };
-      credentials: Credentials;
-    }
-  }
-
-  export namespace GetUser {
-    export interface Request {
-      url: string;
-      data: {
-        id: string;
-      };
-      credentials: Credentials;
-    }
-
-    export interface Response {
-      id: string;
-      sub: string;
-      firstName: string;
-      lastName: string;
-      email: string;
-      enabled: boolean;
-      attributes: {
-        isFirstAccess: boolean;
-      };
-    }
-  }
-
-  export namespace DeleteUser {
-    export interface Request {
-      url: string;
-      data: {
-        id: string;
-      };
-      credentials: Credentials;
-    }
-  }
-
-  export namespace ChangeUserPassword {
-    export interface Request {
-      url: string;
-      data: {
-        id: string;
-        password: string;
-        isTemporaryPassword?: boolean;
-      };
-      credentials: Credentials;
-    }
-  }
-
-  export namespace AddRealm {
-    export interface Request {
-      url: string;
-      data: {
-        name: string;
-        enabled: boolean;
-      };
-      credentials: Credentials;
-    }
-  }
-
-  export namespace AddRole {
-    export interface Request {
-      url: string;
-      data: {
-        name: string;
-        description: string;
-      };
-      credentials: Credentials;
-    }
-  }
-
-  export namespace AssociateUserRole {
-    export interface Request {
-      url: string;
-      data: {
-        user: string;
-        role: string;
-      };
-      credentials: Credentials;
-    }
-  }
-
-  export namespace GetRoles {
-    export interface Request {
-      url: string;
-      data: {
-        search: string;
-      };
-      credentials: Credentials;
-    }
-
-    export interface Response {
-      roles: Roles[];
-    }
-  }
-
-  export namespace DeleteRole {
-    export interface Request {
-      url: string;
-      data: {
-        id: string;
-      };
-      credentials: Credentials;
-    }
-  }
 }
 
 export interface IKeycloakService {
-  authenticate(req: Keycloak.Authenticate.Request): Promise<Keycloak.Authenticate.Response>;
-  authenticateServer(req: Keycloak.AuthenticateServer.Request): Promise<Keycloak.AuthenticateServer.Response>;
-  refreshAccess(req: Keycloak.RefreshAccess.Request): Promise<Keycloak.RefreshAccess.Response>;
-  revokeAccess(req: Keycloak.RevokeAccess.Request): Promise<void>;
-  createUser(req: Keycloak.CreateUser.Request): Promise<void>;
-  updateUser(req: Keycloak.UpdateUser.Request): Promise<void>;
-  getUser(req: Keycloak.GetUser.Request): Promise<Keycloak.GetUser.Response>;
-  deleteUser(req: Keycloak.DeleteUser.Request): Promise<void>;
-  changeUserPassword(req: Keycloak.ChangeUserPassword.Request): Promise<void>;
-  addRealm(req: Keycloak.AddRealm.Request): Promise<void>;
-  addRole(req: Keycloak.AddRole.Request): Promise<void>;
-  associateUserRole(req: Keycloak.AssociateUserRole.Request): Promise<void>;
-  getRoles(req: Keycloak.GetRoles.Request): Promise<Keycloak.GetRoles.Response>;
-  deleteRole(req: Keycloak.DeleteRole.Request): Promise<void>;
-}
+  authenticate (req: Keycloak.Authenticate.Request): Promise<Keycloak.Authenticate.Response>;
+  refreshAccess (req: Keycloak.RefreshAccess.Request): Promise<Keycloak.RefreshAccess.Response>;
+}

package/src/interfaces/nodemailer.ts

@@ -11,40 +11,36 @@ interface Credentials {
 export namespace NodeMailer {
   export namespace Send {
     export interface Request {
-      data: {
-        from: {
-          name: string;
-          address: string;
-        };
-        to: string;
-        subject: string;
-        text: string;
+      from: {
+        name: string;
+        address: string;
       };
+      to: string;
+      subject: string;
+      text: string;
       credentials: Credentials;
     }
   }
 
   export namespace SendWithTemplate {
     export interface Request {
-      data: {
-        from: {
-          name: string;
-          address: string;
-        };
-        to: string;
-        subject: string;
-        html: string;
-        attachments: {
-          filename: string;
-          content: Buffer;
-        }[];
+      from: {
+        name: string;
+        address: string;
       };
+      to: string;
+      subject: string;
+      html: string;
+      attachments: {
+        filename: string;
+        content: Buffer;
+      }[];
       credentials: Credentials;
     }
   }
 }
 
 export interface INodeMailerService {
-  send(req: NodeMailer.Send.Request): Promise<void>;
-  sendWithTemplate(req: NodeMailer.SendWithTemplate.Request): Promise<void>;
+  send (req: NodeMailer.Send.Request): Promise<void>;
+  sendWithTemplate (req: NodeMailer.SendWithTemplate.Request): Promise<void>;
 }

package/src/interfaces/redis.ts

@@ -1,60 +1,14 @@
-interface Credentials {
-  host: string;
-  port: number;
-  password?: string;
-}
-
 export namespace Redis {
-  export namespace Set {
-    export interface Request {
-      data: {
-        key: string;
-        value: unknown;
-        ttl?: number;
-      };
-      credentials: Credentials;
-    }
-  }
-
-  export namespace Get {
-    export interface Request {
-      data: {
-        key: string;
-      };
-      credentials: Credentials;
-    }
-
-    export interface Response<T>{
-      data: T;
-    }
-  }
-
-  export namespace Del {
-    export interface Request {
-      data: {
-        key: string;
-      };
-      credentials: Credentials;
-    }
-  }
-
-  export namespace Exists {
-    export interface Request {
-      data: {
-        key: string;
-      };
-      credentials: Credentials;
-    }
-
-    export interface Response {
-      exists: boolean;
-    }
+  export interface Credentials {
+    host: string;
+    port: number;
+    password?: string;
   }
 }
 
 export interface IRedisService {
-  set(req: Redis.Set.Request): Promise<void>;
-  get<T>(req: Redis.Get.Request): Promise<Redis.Get.Response<T>>;
-  del(req: Redis.Del.Request): Promise<void>;
-  exists(req: Redis.Exists.Request): Promise<Redis.Exists.Response>;
+  set (key: string, value: unknown, ttlInSeconds?: number): Promise<void>;
+  get <T>(key: string): Promise<T | null>;
+  del (key: string): Promise<void>;
+  exists (key: string): Promise<boolean>;
 }