@fhss-web-team/frontend-utils 4.1.2 → 21.0.1

package/lib/components/fhss-table/fhss-table.types.d.ts

@@ -1,46 +0,0 @@
-import { Resolver } from '@trpc/client';
-import { ResolverDef } from '../../signals/trpcResource/trpcResource.types';
-import { trpcResource } from '../../signals/trpcResource/trpcResource';
-export type FhssTableConfig<TDef extends ResolverDef> = {
-    procedure: Resolver<TDef>;
-    columns: {
-        [K in keyof TDef['output']['data'][number]]: {
-            hide?: boolean;
-            header?: string;
-            allowSort?: boolean;
-            individualFilter?: boolean;
-        };
-    };
-    showSearch?: boolean;
-    sorting: {
-        defaultSortBy: Extract<keyof TDef['output']['data'][number], string>;
-        defaultSortDirection?: 'asc' | 'desc';
-    };
-    pagination: {
-        pageSize: number;
-        hideControls?: boolean;
-    };
-    disableAlternatingColors?: boolean;
-    interaction?: {
-        type: 'click';
-        onClick: (obj: TDef['output']['data'][number]) => void;
-    } | {
-        type: 'select';
-        multi?: boolean;
-    };
-};
-export declare const makeTableConfig: <TDef extends ResolverDef>(config: FhssTableConfig<TDef>) => FhssTableConfig<TDef>;
-export type AnyResolver = {
-    input: any;
-    output: {
-        totalCount: number;
-        data: any[];
-    };
-    transformer: any;
-    errorShape: {
-        code: any;
-        message: string;
-        data: any;
-    };
-};
-export type AnyResource = ReturnType<typeof trpcResource<AnyResolver>>;

package/lib/config/lib.config.d.ts

@@ -1,5 +0,0 @@
-import { InjectionToken } from '@angular/core';
-export declare const FHSS_CONFIG: InjectionToken<FhssConfig>;
-export interface FhssConfig {
-    rolePermissionMap: Record<string, string[]>;
-}

package/lib/config/utils.config.d.ts

@@ -1,3 +0,0 @@
-import { Provider } from "@angular/core";
-import { FhssConfig } from "./lib.config";
-export declare const provideFhss: (config: FhssConfig) => Provider;

package/lib/directives/scroll-anchor.directive.d.ts

@@ -1,12 +0,0 @@
-import { ElementRef } from '@angular/core';
-import * as i0 from "@angular/core";
-export declare class ScrollAnchorDirective {
-    private element;
-    private readonly registery;
-    scrollAnchor: import("@angular/core").InputSignal<string>;
-    constructor(element: ElementRef<HTMLElement>);
-    ngOnInit(): void;
-    ngOnDestroy(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ScrollAnchorDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ScrollAnchorDirective, "[scrollAnchor]", never, { "scrollAnchor": { "alias": "scrollAnchor"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
-}

package/lib/guards/auth/auth.guard.d.ts

@@ -1,5 +0,0 @@
-import { CanActivateFn } from '@angular/router';
-/**
- * This guard checks if the client is authenticated, redirecting to login if not.
- */
-export declare const authGuard: CanActivateFn;

package/lib/guards/permission/permission.guard.d.ts

@@ -1,25 +0,0 @@
-import { CanActivateFn } from '@angular/router';
-/**
- * A permission-based route guard.
- *
- * This guard checks if the current user has the required permissions to access a route.
- * If the user is not authenticated, they are redirected to the login page.
- * If the user lacks the necessary permissions, they are redirected to the `/forbidden` page.
- *
- * Pass the Permission type to get intellisense on requiredPermissions
- * @param requiredPermissions - An array of permission strings that the user must have.
- * @param haveAll - If `true`, the user must have all required permissions. If `false` or omitted, the user must have at least one of the required permissions.
- * @returns A `CanActivateFn` function to be used as a route guard.
- *
- * @example
- * ```typescript
- * const routes: Routes = [
- *   {
- *     path: 'admin',
- *     component: AdminPage,
- *     canActivate: [permissionGuard<Permission>(['manage-users', 'see-data'], true)],
- *   },
- * ];
- * ```
- */
-export declare const permissionGuard: <Permission extends string>(requiredPermissions: Permission[], haveAll?: boolean) => CanActivateFn;

package/lib/pages/auth-error/auth-error.page.d.ts

@@ -1,7 +0,0 @@
-import { SystemConfig } from "../system/system.page";
-import * as i0 from "@angular/core";
-export declare class AuthErrorPage {
-    protected readonly config: SystemConfig;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AuthErrorPage, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<AuthErrorPage, "fhss-auth-error", never, {}, {}, never, never, true, never>;
-}

package/lib/pages/forbidden/forbidden.page.d.ts

@@ -1,7 +0,0 @@
-import { SystemConfig } from '../system/system.page';
-import * as i0 from "@angular/core";
-export declare class ForbiddenPage {
-    protected readonly config: SystemConfig;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ForbiddenPage, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ForbiddenPage, "fhss-forbidden", never, {}, {}, never, never, true, never>;
-}

package/lib/pages/not-found/not-found.page.d.ts

@@ -1,7 +0,0 @@
-import { SystemConfig } from '../system/system.page';
-import * as i0 from "@angular/core";
-export declare class NotFoundPage {
-    protected readonly config: SystemConfig;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NotFoundPage, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NotFoundPage, "fhss-not-found", never, {}, {}, never, never, true, never>;
-}

package/lib/pages/server-error/server-error.page.d.ts

@@ -1,7 +0,0 @@
-import { SystemConfig } from '../system/system.page';
-import * as i0 from "@angular/core";
-export declare class ServerErrorPage {
-    protected readonly config: SystemConfig;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ServerErrorPage, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ServerErrorPage, "fhss-server-error", never, {}, {}, never, never, true, never>;
-}

package/lib/pages/system/system.page.d.ts

@@ -1,11 +0,0 @@
-import * as i0 from "@angular/core";
-export type SystemConfig = {
-    title?: string;
-    message?: string;
-    image?: string;
-};
-export declare class SystemPage {
-    readonly config: import("@angular/core").InputSignal<SystemConfig>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SystemPage, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SystemPage, "fhss-system", never, { "config": { "alias": "config"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
-}

package/lib/services/auth/auth.service.d.ts

@@ -1,67 +0,0 @@
-import * as i0 from "@angular/core";
-type AuthUser = {
-    id: string;
-    preferredFirstName: string;
-    preferredLastName: string;
-    roles: string[];
-    permissions: string[];
-};
-export declare class AuthService {
-    private readonly FhssConfig;
-    private readonly readyPromise;
-    constructor();
-    /**
-     * Returns a promise that resolves when the authentication service is ready.
-     */
-    ready(): Promise<AuthUser | null>;
-    /**
-     * Updates the authentication state by retrieving the current user's information.
-     *
-     * @returns A promise containing the current user's authentication details.
-     */
-    update(): Promise<AuthUser | null>;
-    readonly authenticated: import("@angular/core").WritableSignal<boolean>;
-    readonly userId: import("@angular/core").WritableSignal<string | undefined>;
-    readonly preferredFirstName: import("@angular/core").WritableSignal<string | undefined>;
-    readonly preferredLastName: import("@angular/core").WritableSignal<string | undefined>;
-    readonly roles: import("@angular/core").WritableSignal<string[]>;
-    readonly permissions: import("@angular/core").WritableSignal<string[]>;
-    /**
-     * Contains all of the user's permissions, meaning those explicitly given, as well as
-     * those provided by the user's roles.
-     *
-     * The result is a `Set` containing all unique permissions granted to the user.
-     */
-    readonly effectivePermissions: import("@angular/core").Signal<Set<string>>;
-    /**
-     * Computes the user's preferred full name by concatenating the preferred first name
-     * and, if available, the preferred last name separated by a space.
-     * If the preferred first name is not set, an empty string is used.
-     * If the preferred last name is not set, only the first name is returned.
-     *
-     * @returns The computed preferred full name as a string.
-     */
-    readonly preferredName: import("@angular/core").Signal<string>;
-    private resetAuthState;
-    private setUser;
-    /**
-     * Redirects the user to the login page.
-     *
-     * @param nextUri - (Optional) The URI to redirect to after login.
-     */
-    login(nextUri?: string): void;
-    /**
-     * Logs the user out by resetting the authentication state and redirecting to the logout page.
-     */
-    logout(): void;
-    /**
-     * Retrieves information about the currently authenticated user.
-     *
-     * @returns A promise that resolves to a `WhoAmI` object
-     * representing the current user, or `null` if not authenticated or on error.
-     */
-    private whoAmI;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AuthService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AuthService>;
-}
-export {};

package/lib/services/scroll-registry/scroll-registry.service.d.ts

@@ -1,12 +0,0 @@
-import * as i0 from "@angular/core";
-export declare class ScrollRegistryService {
-    private anchors;
-    private pending;
-    register(key: string, el: HTMLElement): void;
-    unregister(key: string): void;
-    scrollTo(key: string, opts?: ScrollIntoViewOptions & {
-        delay?: number;
-    }): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ScrollRegistryService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ScrollRegistryService>;
-}

package/lib/signals/debounced/debounced.d.ts

@@ -1,2 +0,0 @@
-import { Signal } from '@angular/core';
-export declare const debounced: <T>(inputSignal: Signal<T>, wait?: number) => import("@angular/core").WritableSignal<T>;

package/lib/signals/fetch-signal/fetch-signal.d.ts

@@ -1,4 +0,0 @@
-import { FetchSignalFactory, Json } from './fetch-signal.types';
-declare const fetchSignal: FetchSignalFactory;
-export { fetchSignal };
-export type { Json };

package/lib/signals/trpcResource/trpcResource.d.ts

@@ -1,9 +0,0 @@
-import { Resolver } from "@trpc/client";
-import { ResolverDef, TrpcResource, TrpcResourceOptions } from "./trpcResource.types";
-declare function trpcResource<TDef extends ResolverDef>(procedure: Resolver<TDef>, input: () => TDef['input'] | undefined, options?: TrpcResourceOptions<TDef['output']>): TrpcResource<TDef>;
-declare function debugTrpcResource<TDef extends ResolverDef>(_trpcResource: TrpcResource<TDef>): {
-    value: TDef["output"] | undefined;
-    error: TDef["errorShape"] | undefined;
-    isLoading: boolean;
-};
-export { debugTrpcResource, trpcResource };

package/lib/signals/trpcResource/trpcResource.types.d.ts

@@ -1,72 +0,0 @@
-import { Injector, ValueEqualityFn, WritableSignal } from "@angular/core";
-export type ResolverDef = {
-    input: any;
-    output: any;
-    transformer: boolean;
-    errorShape: any;
-};
-export type TrpcResourceOptions<TOutput> = {
-    /**
-     * Whether or not the request should be fetched reactively when the request updates.
-     */
-    autoRefresh?: boolean;
-    /**
-     * Optional computation that will be used in a `linkedSignal` definition of the `trpcResource` value.
-     */
-    valueComputation?: () => NoInfer<TOutput>;
-    /**
-     * Value that the `trpcResource` will take when in the Idle or Error states.
-     *
-     * If not set, the `trpcResource` will use `undefined` as its default value.
-     */
-    defaultValue?: NoInfer<TOutput> | undefined;
-    /**
-     * Value that the `trpcResource` will take when first initialized.
-     *
-     * If not set, the `trpcResource` will use `defaultValue` as its initial value.
-     */
-    initialValue?: NoInfer<TOutput> | undefined;
-    /**
-     * The `Injector` in which to create the `trpcResource`.
-     *
-     * If this is not provided, the current
-     * [injection context](https://angular.dev/guide/di/dependency-injection-context)
-     * will be used instead (via `inject`).
-     */
-    injector?: Injector | undefined;
-    /**
-     * A comparison function which defines equality for the response value.
-     */
-    equal?: ValueEqualityFn<NoInfer<TOutput | undefined>> | undefined;
-};
-type Expand<T> = T extends infer O ? {
-    [K in keyof O]: O[K];
-} : never;
-type _TrpcResource<TDef extends ResolverDef> = {
-    /**
-     * Signal of the tRPC procedure output, when available.
-     * This value will persist while the `trpcResource` is loading.
-     */
-    value: WritableSignal<TDef["output"] | undefined>;
-    /**
-     * Signal of the tRPC procedure error, when available.
-     */
-    error: WritableSignal<TDef['errorShape'] | undefined>;
-    /**
-     * Whether this `trpcResource` is loading a new value (or reloading the existing one).
-     */
-    isLoading: WritableSignal<boolean>;
-    /**
-     * Instructs the `trpcResource` to call the procedure with the current reactive dependencies.
-     * @param abortSignal Optional abort signal to abort the procedure call.
-     * @param keepLoadingThroughAbort Whether the `trpcResource` should maintain a loading state after an abort.
-     * This is useful when another refresh is the cause of an abort so the resource appears to keep loading.
-     * @returns true if there was no error during the call
-     */
-    refresh: (abortSignal?: AbortSignal, keepLoadingThroughAbort?: boolean) => Promise<boolean>;
-};
-/**
- * Represents the reactive result of an tRPC request.
- */
-export type TrpcResource<TDef extends ResolverDef> = Expand<_TrpcResource<TDef>>;
-export {};

package/public-api.d.ts

@@ -1,41 +0,0 @@
-/**
- * Components
- */
-export * from './lib/components/byu-footer/byu-footer.component';
-export { ByuHeaderComponent } from './lib/components/byu-header/byu-header.component';
-export type { HeaderConfig } from './lib/components/byu-header/byu-header.component';
-export * from './lib/components/fhss-table/fhss-table.component';
-export * from './lib/components/confirmation/confirmation.dialog';
-export * from './lib/components/combo-box/combo-box.component';
-/**
- * Config
- */
-export * from './lib/config/lib.config';
-export * from './lib/config/utils.config';
-/**
- * Directives
- */
-export * from './lib/directives/scroll-anchor.directive';
-/**
- * Guards
- */
-export * from './lib/guards/auth/auth.guard';
-export * from './lib/guards/permission/permission.guard';
-/**
- * Pages
- */
-export * from './lib/pages/auth-error/auth-error.page';
-export * from './lib/pages/forbidden/forbidden.page';
-export * from './lib/pages/not-found/not-found.page';
-export * from './lib/pages/server-error/server-error.page';
-/**
- * Services
- */
-export * from './lib/services/auth/auth.service';
-export * from './lib/services/scroll-registry/scroll-registry.service';
-/**
- * Signals
- */
-export * from './lib/signals/trpcResource/trpcResource';
-export * from './lib/signals/fetch-signal/fetch-signal';
-export * from './lib/signals/debounced/debounced';