@koloseum/utils 0.2.28 → 0.3.0

package/dist/platform.d.ts

@@ -0,0 +1,66 @@
+import type { MicroserviceGroup, MicroserviceObject, UserWithCustomMetadata } from "@koloseum/types/general";
+import type { BranchAddressObject, County } from "@koloseum/types/public-auth";
+export declare const Config: {
+    /**
+     * A reference of microservices available on the platform, represented as an object with each user group (i.e. `public`, `players`, `lounges`, and `backroom`) having its own array of microservices. Each microservice in a list is an object with the following properties:
+     * - `name`: The name of the microservice.
+     * - `description`: A description of the microservice.
+     * - `slug`: The slug of the microservice.
+     * - `features`: An array of features that the microservice has.
+     * - `roles`: An array of roles attached to the microservice.
+     */
+    microservices: { [key in MicroserviceGroup]: MicroserviceObject<key>[]; };
+};
+export declare const Mock: {
+    /**
+     * A generic authenticated user.
+     * @param {string} id - The user ID; defaults to a random UUID
+     * @param {Date} date - The date and time; defaults to the current date and time
+     * @param {string} phone - The phone number; defaults to a generic Kenyan phone number
+     * @param {string} identityId - A default identity ID; defaults to a random UUID
+     * @returns A generic authenticated user.
+     */
+    authenticatedUser: (id?: string, date?: Date, phone?: string, identityId?: string) => UserWithCustomMetadata;
+};
+export declare const Resource: {
+    /**
+     * Returns a list of all counties in Kenya.
+     * @param {"name" | "code"} sortBy - The field to sort the counties by, i.e. `name` or `code`; defaults to `name`
+     * @returns {Promise<County[]>} A list of objects with the county `name`, `code`, and a list of `subCounties`
+     */
+    getKenyaCounties: (sortBy?: "name" | "code") => Promise<County[]>;
+    /**
+     * Returns the parent URL for a given base URL.
+     * @param {string} base - The base URL
+     * @returns {string} The parent URL
+     */
+    getParentUrl: (base: string) => string;
+    /**
+     * Returns the redirect URL for a given URI.
+     * @param {string} uri - The URI to get the redirect URL for, i.e. `microserviceGroup:path` (e.g. `players:fgc/tournaments`)
+     * @param {"development" | "production"} env - The environment to use for the redirect URL; defaults to `production`
+     * @returns {string} An object with the redirect `url`, or an `error` if any occurs
+     */
+    getRedirectUrl: (uri: string, env?: "development" | "production") => {
+        url?: string;
+        error?: any;
+    };
+    /**
+     * Parses a resource request and returns the URL and path.
+     * @param request - The request to parse.
+     * @returns An object with the `url` and `path` of the request.
+     */
+    parseResourceRequest: (request: Request) => {
+        url: URL;
+        path?: string;
+    };
+    /**
+     * Validates address data submitted in a form and returns the validated data.
+     * @param {FormData} formData - The submitted form data
+     * @returns An object with the validated `address`, or an `error` if any has occurred
+     */
+    validateAddress: (formData: FormData) => Promise<{
+        address?: BranchAddressObject;
+        error?: any;
+    }>;
+};