@aneuhold/core-ts-api-lib 1.0.119 → 2.0.0

package/lib/services/DOFunctionService/DOFunctionService.js

@@ -1,19 +1,23 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const bson_1 = require("bson");
-const authCheckPassword_1 = __importDefault(require("./functions/authCheckPassword"));
-const authValidateUser_1 = __importDefault(require("./functions/authValidateUser"));
-const projectDashboard_1 = __importDefault(require("./functions/projectDashboard"));
+import { BSON } from 'bson';
+import AuthCheckPassword from './functions/authCheckPassword.js';
+import AuthValidateUser from './functions/authValidateUser.js';
+import ProjectDashboard from './functions/projectDashboard.js';
 /**
  * A service to provide some utility related to Digital Ocean functions.
  */
-class DOFunctionService {
-    static auchCheckPassword = authCheckPassword_1.default.getFunction();
-    static authValidateUser = authValidateUser_1.default.getFunction();
-    static projectDashboard = projectDashboard_1.default.getFunction();
+export default class DOFunctionService {
+    /**
+     * {@link AuthCheckPassword} function instance.
+     */
+    static authCheckPassword = AuthCheckPassword.getFunction();
+    /**
+     * {@link AuthValidateUser} function instance.
+     */
+    static authValidateUser = AuthValidateUser.getFunction();
+    /**
+     * {@link ProjectDashboard} function instance.
+     */
+    static projectDashboard = ProjectDashboard.getFunction();
     /**
      * A generic method to handle any API request on the backend. This has
      * no use on the frontend.
@@ -21,6 +25,10 @@ class DOFunctionService {
      * This will take care of returning the error if the handler throws.
      * Ideally the handler should not throw though unless something really
      * unexpected happened.
+     *
+     * @param rawInput - The raw input for the function.
+     * @param handler - The handler function to process the input.
+     * @returns The raw output of the function call.
      */
     static async handleApiRequest(rawInput, handler) {
         const input = this.deserializeInput(rawInput);
@@ -47,6 +55,12 @@ class DOFunctionService {
         }
         return rawOutput;
     }
+    /**
+     * Deserializes the raw input into a typed input object.
+     *
+     * @param rawInput - The raw input to deserialize.
+     * @returns The deserialized input object.
+     */
     static deserializeInput(rawInput) {
         const binaryString = atob(rawInput.http.body);
         const len = binaryString.length;
@@ -54,11 +68,17 @@ class DOFunctionService {
         for (let i = 0; i < len; i += 1) {
             bytes[i] = binaryString.charCodeAt(i);
         }
-        return bson_1.BSON.deserialize(bytes);
+        return BSON.deserialize(bytes);
     }
+    /**
+     * Serializes the output object into a base64 string.
+     *
+     * @param output - The output object to serialize.
+     * @returns The serialized output as a base64 string.
+     */
     static serializeOutput(output) {
-        const uInt8Array = bson_1.BSON.serialize(output);
+        const uInt8Array = BSON.serialize(output);
         return Buffer.from(uInt8Array).toString('base64');
     }
 }
-exports.default = DOFunctionService;
+//# sourceMappingURL=DOFunctionService.js.map

package/lib/services/DOFunctionService/DOFunctionService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DOFunctionService.js","sourceRoot":"./src/","sources":["services/DOFunctionService/DOFunctionService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAQ5B,OAAO,iBAAiB,MAAM,kCAAkC,CAAC;AACjE,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAC/D,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC;;OAEG;IACH,MAAM,CAAC,iBAAiB,GAAsB,iBAAiB,CAAC,WAAW,EAAE,CAAC;IAE9E;;OAEG;IACH,MAAM,CAAC,gBAAgB,GAAqB,gBAAgB,CAAC,WAAW,EAAE,CAAC;IAE3E;;OAEG;IACH,MAAM,CAAC,gBAAgB,GAAqB,gBAAgB,CAAC,WAAW,EAAE,CAAC;IAE3E;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAI3B,QAA4B,EAC5B,OAAkE;QAElE,MAAM,KAAK,GAAW,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACtD,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,EAAE;YACR,OAAO,EAAE;gBACP,cAAc,EAAE,0BAA0B;aAC3C;SACF,CAAC;QACF,yCAAyC;QACzC,MAAM,aAAa,GAAkC;YACnD,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,EAAa;SACpB,CAAC;QACF,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;YACpC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACzC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,gBAAgB,CAC7B,QAA4B;QAE5B,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;QAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAW,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,eAAe,CAC5B,MAAqC;QAErC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC"}

package/lib/services/DOFunctionService/DOFunctionService.ts

@@ -0,0 +1,105 @@
+import { BSON } from 'bson';
+import {
+  DOFunctionCallOutput,
+  DOFunctionInput,
+  DOFunctionOutput,
+  DOFunctionRawInput,
+  DOFunctionRawOutput
+} from './DOFunction.js';
+import AuthCheckPassword from './functions/authCheckPassword.js';
+import AuthValidateUser from './functions/authValidateUser.js';
+import ProjectDashboard from './functions/projectDashboard.js';
+
+/**
+ * A service to provide some utility related to Digital Ocean functions.
+ */
+export default class DOFunctionService {
+  /**
+   * {@link AuthCheckPassword} function instance.
+   */
+  static authCheckPassword: AuthCheckPassword = AuthCheckPassword.getFunction();
+
+  /**
+   * {@link AuthValidateUser} function instance.
+   */
+  static authValidateUser: AuthValidateUser = AuthValidateUser.getFunction();
+
+  /**
+   * {@link ProjectDashboard} function instance.
+   */
+  static projectDashboard: ProjectDashboard = ProjectDashboard.getFunction();
+
+  /**
+   * A generic method to handle any API request on the backend. This has
+   * no use on the frontend.
+   *
+   * This will take care of returning the error if the handler throws.
+   * Ideally the handler should not throw though unless something really
+   * unexpected happened.
+   *
+   * @param rawInput - The raw input for the function.
+   * @param handler - The handler function to process the input.
+   * @returns The raw output of the function call.
+   */
+  static async handleApiRequest<
+    TInput extends DOFunctionInput,
+    TOutput extends DOFunctionOutput
+  >(
+    rawInput: DOFunctionRawInput,
+    handler: (input: TInput) => Promise<DOFunctionCallOutput<TOutput>>
+  ): Promise<DOFunctionRawOutput> {
+    const input: TInput = this.deserializeInput(rawInput);
+    const rawOutput: DOFunctionRawOutput = {
+      body: '',
+      headers: {
+        'Content-Type': 'application/octet-stream'
+      }
+    };
+    // Default output if something goes wrong
+    const defaultOutput: DOFunctionCallOutput<TOutput> = {
+      success: false,
+      errors: [],
+      data: {} as TOutput
+    };
+    try {
+      const output = await handler(input);
+      rawOutput.body = this.serializeOutput(output);
+    } catch (e) {
+      const error = e as Error;
+      defaultOutput.errors.push(error.message);
+      rawOutput.body = this.serializeOutput(defaultOutput);
+    }
+    return rawOutput;
+  }
+
+  /**
+   * Deserializes the raw input into a typed input object.
+   *
+   * @param rawInput - The raw input to deserialize.
+   * @returns The deserialized input object.
+   */
+  private static deserializeInput<TInput extends DOFunctionInput>(
+    rawInput: DOFunctionRawInput
+  ): TInput {
+    const binaryString = atob(rawInput.http.body);
+    const len = binaryString.length;
+    const bytes = new Uint8Array(len);
+    for (let i = 0; i < len; i += 1) {
+      bytes[i] = binaryString.charCodeAt(i);
+    }
+    return BSON.deserialize(bytes) as TInput;
+  }
+
+  /**
+   * Serializes the output object into a base64 string.
+   *
+   * @param output - The output object to serialize.
+   * @returns The serialized output as a base64 string.
+   */
+  private static serializeOutput<TOutput extends DOFunctionOutput>(
+    output: DOFunctionCallOutput<TOutput>
+  ): string {
+    const uInt8Array = BSON.serialize(output);
+    return Buffer.from(uInt8Array).toString('base64');
+  }
+}

package/lib/services/DOFunctionService/functions/authCheckPassword.d.ts

@@ -1,13 +1,29 @@
-import DOFunction, { DOFunctionInput, DOFunctionOutput } from '../DOFunction';
+import DOFunction, { DOFunctionInput, DOFunctionOutput } from '../DOFunction.js';
+/**
+ * Input interface for {@link AuthCheckPassword}.
+ */
 export interface AuthCheckPasswordInput extends DOFunctionInput {
     password: string;
 }
+/**
+ * Output interface for {@link AuthCheckPassword}.
+ */
 export interface AuthCheckPasswordOutput extends DOFunctionOutput {
     passwordIsCorrect: boolean;
 }
+/**
+ * Class representing the AuthCheckPassword function.
+ *
+ * This class is a singleton and provides a method to get the instance of the function.
+ */
 export default class AuthCheckPassword extends DOFunction<AuthCheckPasswordInput, AuthCheckPasswordOutput> {
     private static instance;
     private constructor();
+    /**
+     * Gets the singleton instance of {@link AuthCheckPassword}.
+     *
+     * @returns The instance of the AuthCheckPassword function.
+     */
     static getFunction(): AuthCheckPassword;
 }
 //# sourceMappingURL=authCheckPassword.d.ts.map

package/lib/services/DOFunctionService/functions/authCheckPassword.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"authCheckPassword.d.ts","sourceRoot":"","sources":["../../../../src/services/DOFunctionService/functions/authCheckPassword.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,EAAE,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE9E,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,UAAU,CACvD,sBAAsB,EACtB,uBAAuB,CACxB;IACC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAgC;IAEvD,OAAO;IAMP,MAAM,CAAC,WAAW;CAMnB"}
+{"version":3,"file":"authCheckPassword.d.ts","sourceRoot":"./src/","sources":["services/DOFunctionService/functions/authCheckPassword.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,EAAE,EACjB,eAAe,EACf,gBAAgB,EACjB,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,eAAe;IAC7D,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D,iBAAiB,EAAE,OAAO,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,UAAU,CACvD,sBAAsB,EACtB,uBAAuB,CACxB;IACC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAgC;IAEvD,OAAO;IAMP;;;;OAIG;IACH,MAAM,CAAC,WAAW,IAAI,iBAAiB;CAMxC"}

package/lib/services/DOFunctionService/functions/authCheckPassword.js

@@ -1,16 +1,21 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const DOFunction_1 = __importDefault(require("../DOFunction"));
-class AuthCheckPassword extends DOFunction_1.default {
+import DOFunction from '../DOFunction.js';
+/**
+ * Class representing the AuthCheckPassword function.
+ *
+ * This class is a singleton and provides a method to get the instance of the function.
+ */
+export default class AuthCheckPassword extends DOFunction {
     static instance;
     constructor() {
         super();
         this.url =
             'https://faas-sfo3-7872a1dd.doserverless.co/api/v1/web/fn-66dd3ef6-c21d-46dc-b7ae-caf2ac8041ec/auth/checkPassword';
     }
+    /**
+     * Gets the singleton instance of {@link AuthCheckPassword}.
+     *
+     * @returns The instance of the AuthCheckPassword function.
+     */
     static getFunction() {
         if (!AuthCheckPassword.instance) {
             AuthCheckPassword.instance = new AuthCheckPassword();
@@ -18,4 +23,4 @@ class AuthCheckPassword extends DOFunction_1.default {
         return AuthCheckPassword.instance;
     }
 }
-exports.default = AuthCheckPassword;
+//# sourceMappingURL=authCheckPassword.js.map

package/lib/services/DOFunctionService/functions/authCheckPassword.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authCheckPassword.js","sourceRoot":"./src/","sources":["services/DOFunctionService/functions/authCheckPassword.ts"],"names":[],"mappings":"AAAA,OAAO,UAGN,MAAM,kBAAkB,CAAC;AAgB1B;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAkB,SAAQ,UAG9C;IACS,MAAM,CAAC,QAAQ,CAAgC;IAEvD;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG;YACN,kHAAkH,CAAC;IACvH,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,CAAC;YAChC,iBAAiB,CAAC,QAAQ,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACvD,CAAC;QACD,OAAO,iBAAiB,CAAC,QAAQ,CAAC;IACpC,CAAC;CACF"}

package/lib/services/DOFunctionService/functions/authCheckPassword.ts

@@ -0,0 +1,48 @@
+import DOFunction, {
+  DOFunctionInput,
+  DOFunctionOutput
+} from '../DOFunction.js';
+
+/**
+ * Input interface for {@link AuthCheckPassword}.
+ */
+export interface AuthCheckPasswordInput extends DOFunctionInput {
+  password: string;
+}
+
+/**
+ * Output interface for {@link AuthCheckPassword}.
+ */
+export interface AuthCheckPasswordOutput extends DOFunctionOutput {
+  passwordIsCorrect: boolean;
+}
+
+/**
+ * Class representing the AuthCheckPassword function.
+ *
+ * This class is a singleton and provides a method to get the instance of the function.
+ */
+export default class AuthCheckPassword extends DOFunction<
+  AuthCheckPasswordInput,
+  AuthCheckPasswordOutput
+> {
+  private static instance: AuthCheckPassword | undefined;
+
+  private constructor() {
+    super();
+    this.url =
+      'https://faas-sfo3-7872a1dd.doserverless.co/api/v1/web/fn-66dd3ef6-c21d-46dc-b7ae-caf2ac8041ec/auth/checkPassword';
+  }
+
+  /**
+   * Gets the singleton instance of {@link AuthCheckPassword}.
+   *
+   * @returns The instance of the AuthCheckPassword function.
+   */
+  static getFunction(): AuthCheckPassword {
+    if (!AuthCheckPassword.instance) {
+      AuthCheckPassword.instance = new AuthCheckPassword();
+    }
+    return AuthCheckPassword.instance;
+  }
+}

package/lib/services/DOFunctionService/functions/authValidateUser.d.ts

@@ -1,11 +1,26 @@
 import { ApiKey, User } from '@aneuhold/core-ts-db-lib';
-import DOFunction, { DOFunctionInput, DOFunctionOutput } from '../DOFunction';
-import { DashboardConfig } from '../../../types/DashboardConfig';
+import { DashboardConfig } from '../../../types/DashboardConfig.js';
+import DOFunction, { DOFunctionInput, DOFunctionOutput } from '../DOFunction.js';
+/**
+ * Interface representing the input to the {@link AuthValidateUser} function.
+ */
 export interface AuthValidateUserInput extends DOFunctionInput {
+    /**
+     * The username of the user to be validated.
+     */
     userName: string;
+    /**
+     * The password of the user to be validated.
+     */
     password: string;
 }
+/**
+ * Interface representing the output of the {@link AuthValidateUser} function.
+ */
 export interface AuthValidateUserOutput extends DOFunctionOutput {
+    /**
+     * Information about the authenticated user.
+     */
     userInfo?: {
         user: User;
         apiKey: ApiKey;
@@ -17,9 +32,24 @@ export interface AuthValidateUserOutput extends DOFunctionOutput {
         dashboard?: DashboardConfig;
     };
 }
+/**
+ * Class representing the {@link AuthValidateUser} function.
+ * This class is a singleton and extends {@link DOFunction}.
+ * It is used to validate user authentication.
+ */
 export default class AuthValidateUser extends DOFunction<AuthValidateUserInput, AuthValidateUserOutput> {
     private static instance;
+    /**
+     * Private constructor to prevent direct instantiation.
+     * Initializes the URL for the validate user function.
+     */
     private constructor();
+    /**
+     * Retrieves the singleton instance of {@link AuthValidateUser}.
+     * If the instance does not exist, it creates a new one.
+     *
+     * @returns The singleton instance of {@link AuthValidateUser}.
+     */
     static getFunction(): AuthValidateUser;
 }
 //# sourceMappingURL=authValidateUser.d.ts.map

package/lib/services/DOFunctionService/functions/authValidateUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"authValidateUser.d.ts","sourceRoot":"","sources":["../../../../src/services/DOFunctionService/functions/authValidateUser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,UAAU,EAAE,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAEjE,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,SAAS,CAAC,EAAE,eAAe,CAAC;KAC7B,CAAC;CACH;AAED,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,UAAU,CACtD,qBAAqB,EACrB,sBAAsB,CACvB;IACC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA+B;IAEtD,OAAO;IAMP,MAAM,CAAC,WAAW;CAMnB"}
+{"version":3,"file":"authValidateUser.d.ts","sourceRoot":"./src/","sources":["services/DOFunctionService/functions/authValidateUser.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAC;AACpE,OAAO,UAAU,EAAE,EACjB,eAAe,EACf,gBAAgB,EACjB,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT,IAAI,EAAE,IAAI,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF;;OAEG;IACH,MAAM,CAAC,EAAE;QACP,SAAS,CAAC,EAAE,eAAe,CAAC;KAC7B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,UAAU,CACtD,qBAAqB,EACrB,sBAAsB,CACvB;IACC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA+B;IAEtD;;;OAGG;IACH,OAAO;IAMP;;;;;OAKG;IACH,MAAM,CAAC,WAAW,IAAI,gBAAgB;CAMvC"}

package/lib/services/DOFunctionService/functions/authValidateUser.js

@@ -1,16 +1,26 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const DOFunction_1 = __importDefault(require("../DOFunction"));
-class AuthValidateUser extends DOFunction_1.default {
+import DOFunction from '../DOFunction.js';
+/**
+ * Class representing the {@link AuthValidateUser} function.
+ * This class is a singleton and extends {@link DOFunction}.
+ * It is used to validate user authentication.
+ */
+export default class AuthValidateUser extends DOFunction {
     static instance;
+    /**
+     * Private constructor to prevent direct instantiation.
+     * Initializes the URL for the validate user function.
+     */
     constructor() {
         super();
         this.url =
             'https://faas-sfo3-7872a1dd.doserverless.co/api/v1/web/fn-66dd3ef6-c21d-46dc-b7ae-caf2ac8041ec/auth/validateUser';
     }
+    /**
+     * Retrieves the singleton instance of {@link AuthValidateUser}.
+     * If the instance does not exist, it creates a new one.
+     *
+     * @returns The singleton instance of {@link AuthValidateUser}.
+     */
     static getFunction() {
         if (!AuthValidateUser.instance) {
             AuthValidateUser.instance = new AuthValidateUser();
@@ -18,4 +28,4 @@ class AuthValidateUser extends DOFunction_1.default {
         return AuthValidateUser.instance;
     }
 }
-exports.default = AuthValidateUser;
+//# sourceMappingURL=authValidateUser.js.map

package/lib/services/DOFunctionService/functions/authValidateUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authValidateUser.js","sourceRoot":"./src/","sources":["services/DOFunctionService/functions/authValidateUser.ts"],"names":[],"mappings":"AAEA,OAAO,UAGN,MAAM,kBAAkB,CAAC;AAmC1B;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,UAG7C;IACS,MAAM,CAAC,QAAQ,CAA+B;IAEtD;;;OAGG;IACH;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG;YACN,iHAAiH,CAAC;IACtH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YAC/B,gBAAgB,CAAC,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACrD,CAAC;QACD,OAAO,gBAAgB,CAAC,QAAQ,CAAC;IACnC,CAAC;CACF"}

package/lib/services/DOFunctionService/functions/authValidateUser.ts

@@ -0,0 +1,74 @@
+import { ApiKey, User } from '@aneuhold/core-ts-db-lib';
+import { DashboardConfig } from '../../../types/DashboardConfig.js';
+import DOFunction, {
+  DOFunctionInput,
+  DOFunctionOutput
+} from '../DOFunction.js';
+
+/**
+ * Interface representing the input to the {@link AuthValidateUser} function.
+ */
+export interface AuthValidateUserInput extends DOFunctionInput {
+  /**
+   * The username of the user to be validated.
+   */
+  userName: string;
+  /**
+   * The password of the user to be validated.
+   */
+  password: string;
+}
+
+/**
+ * Interface representing the output of the {@link AuthValidateUser} function.
+ */
+export interface AuthValidateUserOutput extends DOFunctionOutput {
+  /**
+   * Information about the authenticated user.
+   */
+  userInfo?: {
+    user: User;
+    apiKey: ApiKey;
+  };
+  /**
+   * Basic configuration for the projects that the user has access to.
+   */
+  config?: {
+    dashboard?: DashboardConfig;
+  };
+}
+
+/**
+ * Class representing the {@link AuthValidateUser} function.
+ * This class is a singleton and extends {@link DOFunction}.
+ * It is used to validate user authentication.
+ */
+export default class AuthValidateUser extends DOFunction<
+  AuthValidateUserInput,
+  AuthValidateUserOutput
+> {
+  private static instance: AuthValidateUser | undefined;
+
+  /**
+   * Private constructor to prevent direct instantiation.
+   * Initializes the URL for the validate user function.
+   */
+  private constructor() {
+    super();
+    this.url =
+      'https://faas-sfo3-7872a1dd.doserverless.co/api/v1/web/fn-66dd3ef6-c21d-46dc-b7ae-caf2ac8041ec/auth/validateUser';
+  }
+
+  /**
+   * Retrieves the singleton instance of {@link AuthValidateUser}.
+   * If the instance does not exist, it creates a new one.
+   *
+   * @returns The singleton instance of {@link AuthValidateUser}.
+   */
+  static getFunction(): AuthValidateUser {
+    if (!AuthValidateUser.instance) {
+      AuthValidateUser.instance = new AuthValidateUser();
+    }
+    return AuthValidateUser.instance;
+  }
+}

package/lib/services/DOFunctionService/functions/projectDashboard.d.ts

@@ -1,39 +1,87 @@
-import { UUID } from 'crypto';
 import { DashboardTask, DashboardUserConfig, NonogramKatanaItem, NonogramKatanaUpgrade, UserCTO } from '@aneuhold/core-ts-db-lib';
-import { Translations } from '../../../types/Translations';
-import DOFunction, { DOFunctionInput, DOFunctionOutput } from '../DOFunction';
+import { UUID } from 'crypto';
+import { Translations } from '../../../types/Translations.js';
+import DOFunction, { DOFunctionInput, DOFunctionOutput } from '../DOFunction.js';
+/**
+ * Options for configuring the project dashboard.
+ */
 export interface ProjectDashboardOptions {
     get?: {
+        /**
+         * Whether to include translations in the response.
+         */
         translations?: boolean;
         /**
-         * If this is true, the user config will be returned for the user
+         * If true, the user config will be returned for the user
          * and the collaborators.
          */
         userConfig?: boolean;
+        /**
+         * Whether to include tasks in the response.
+         */
         tasks?: boolean;
+        /**
+         * A string indicating if the user name is valid.
+         */
         userNameIsValid?: string;
+        /**
+         * Whether to include nonogram katana items in the response.
+         */
         nonogramKatanaItems?: boolean;
+        /**
+         * Whether to include nonogram katana upgrades in the response.
+         */
         nonogramKatanaUpgrades?: boolean;
     };
     insert?: {
+        /**
+         * Tasks to be inserted.
+         */
         tasks?: DashboardTask[];
+        /**
+         * Nonogram katana items to be inserted.
+         */
         nonogramKatanaItems?: NonogramKatanaItem[];
+        /**
+         * Nonogram katana upgrades to be inserted.
+         */
         nonogramKatanaUpgrades?: NonogramKatanaUpgrade[];
     };
     update?: {
+        /**
+         * User configuration to be updated.
+         */
         userConfig?: DashboardUserConfig;
+        /**
+         * Tasks to be updated.
+         */
         tasks?: DashboardTask[];
+        /**
+         * Nonogram katana items to be updated.
+         */
         nonogramKatanaItems?: NonogramKatanaItem[];
+        /**
+         * Nonogram katana upgrades to be updated.
+         */
         nonogramKatanaUpgrades?: NonogramKatanaUpgrade[];
     };
     delete?: {
+        /**
+         * Tasks to be deleted.
+         */
         tasks?: DashboardTask[];
     };
 }
+/**
+ * Represents the input to the project dashboard function.
+ */
 export interface ProjectDashboardInput extends DOFunctionInput {
     apiKey: UUID;
     options: ProjectDashboardOptions;
 }
+/**
+ * Represents the output of the project dashboard function.
+ */
 export interface ProjectDashboardOutput extends DOFunctionOutput {
     translations?: Translations;
     userConfig?: DashboardUserConfig;

package/lib/services/DOFunctionService/functions/projectDashboard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"projectDashboard.d.ts","sourceRoot":"","sources":["../../../../src/services/DOFunctionService/functions/projectDashboard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,OAAO,EACR,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,UAAU,EAAE,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAE9E,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,EAAE;QACJ,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAC;KAClC,CAAC;IACF,MAAM,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;QACxB,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAC3C,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;KAClD,CAAC;IACF,MAAM,CAAC,EAAE;QACP,UAAU,CAAC,EAAE,mBAAmB,CAAC;QACjC,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;QACxB,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAC3C,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;KAClD,CAAC;IACF,MAAM,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;KACzB,CAAC;CACH;AAED,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,uBAAuB,CAAC;CAClC;AAED,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC;IAC1B,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC3C,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAClD;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,UAAU,CACtD,qBAAqB,EACrB,sBAAsB,CACvB;IACC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA+B;IAEtD,OAAO;IAIP,MAAM,CAAC,WAAW;CAMnB"}
+{"version":3,"file":"projectDashboard.d.ts","sourceRoot":"./src/","sources":["services/DOFunctionService/functions/projectDashboard.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,kBAAkB,EAClB,qBAAqB,EACrB,OAAO,EACR,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAC9D,OAAO,UAAU,EAAE,EACjB,eAAe,EACf,gBAAgB,EACjB,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,CAAC,EAAE;QACJ;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB;;;WAGG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;;WAEG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B;;WAEG;QACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;KAClC,CAAC;IACF,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;QACxB;;WAEG;QACH,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAC3C;;WAEG;QACH,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;KAClD,CAAC;IACF,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,UAAU,CAAC,EAAE,mBAAmB,CAAC;QACjC;;WAEG;QACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;QACxB;;WAEG;QACH,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;QAC3C;;WAEG;QACH,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;KAClD,CAAC;IACF,MAAM,CAAC,EAAE;QACP;;WAEG;QACH,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;KACzB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,eAAe;IAC5D,MAAM,EAAE,IAAI,CAAC;IACb,OAAO,EAAE,uBAAuB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC9D,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,UAAU,CAAC,EAAE,mBAAmB,CAAC;IACjC,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,EAAE,CAAC;IAC1B,gBAAgB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAClC,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC3C,sBAAsB,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAClD;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,UAAU,CACtD,qBAAqB,EACrB,sBAAsB,CACvB;IACC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA+B;IAEtD,OAAO;IAIP,MAAM,CAAC,WAAW,IAAI,gBAAgB;CAMvC"}

package/lib/services/DOFunctionService/functions/projectDashboard.js

@@ -1,14 +1,9 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const DOFunction_1 = __importDefault(require("../DOFunction"));
+import DOFunction from '../DOFunction.js';
 /**
  * The Digital Ocean function which handles all data requests for the
  * dashboard project.
  */
-class ProjectDashboard extends DOFunction_1.default {
+export default class ProjectDashboard extends DOFunction {
     static instance;
     constructor() {
         super();
@@ -20,4 +15,4 @@ class ProjectDashboard extends DOFunction_1.default {
         return ProjectDashboard.instance;
     }
 }
-exports.default = ProjectDashboard;
+//# sourceMappingURL=projectDashboard.js.map

package/lib/services/DOFunctionService/functions/projectDashboard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectDashboard.js","sourceRoot":"./src/","sources":["services/DOFunctionService/functions/projectDashboard.ts"],"names":[],"mappings":"AASA,OAAO,UAGN,MAAM,kBAAkB,CAAC;AA8F1B;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,UAG7C;IACS,MAAM,CAAC,QAAQ,CAA+B;IAEtD;QACE,KAAK,EAAE,CAAC;IACV,CAAC;IAED,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;YAC/B,gBAAgB,CAAC,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;QACrD,CAAC;QACD,OAAO,gBAAgB,CAAC,QAAQ,CAAC;IACnC,CAAC;CACF"}