@equinor/fusion-framework-module-app 8.0.2 → 8.0.3

package/dist/types/AppClient.d.ts

@@ -93,29 +93,71 @@ export interface IAppClient extends Disposable {
  */
 export declare class AppClient implements IAppClient {
     #private;
+    /**
+     * Creates a new {@link AppClient} backed by the given HTTP client.
+     * @param client - The HTTP client used to communicate with the Fusion app service API.
+     */
     constructor(client: IHttpClient);
+    /**
+     * Fetches the build metadata for an application.
+     * @param args - Object containing the `appKey` and an optional version `tag`.
+     * @returns An observable that emits the resolved {@link AppBuildManifest}.
+     * @throws {AppBuildError} When the build metadata cannot be loaded.
+     */
     getAppBuild(args: {
         appKey: string;
         tag?: string;
     }): Observable<AppBuildManifest>;
+    /**
+     * Fetches the manifest for a single application.
+     * @param args - Object containing the `appKey` and an optional version `tag`.
+     * @returns An observable that emits the resolved {@link AppManifest}.
+     * @throws {AppManifestError} When the manifest cannot be loaded.
+     */
     getAppManifest(args: {
         appKey: string;
         tag?: string;
     }): Observable<AppManifest>;
+    /**
+     * Fetches manifests for all registered applications.
+     * @param args - Optional filter; set `filterByCurrentUser` to `true` to return only apps the authenticated user has access to.
+     * @returns An observable that emits an array of {@link AppManifest} objects.
+     */
     getAppManifests(args: {
         filterByCurrentUser?: boolean;
     } | undefined): Observable<AppManifest[]>;
+    /**
+     * Fetches the runtime configuration for an application.
+     * @template TType - Shape of the `environment` record in the returned config.
+     * @param args - Object containing the `appKey` and an optional version `tag`.
+     * @returns An observable that emits the resolved {@link AppConfig}.
+     * @throws {AppConfigError} When the configuration cannot be loaded.
+     */
     getAppConfig<TType extends ConfigEnvironment = ConfigEnvironment>(args: {
         appKey: string;
         tag?: string;
     }): Observable<AppConfig<TType>>;
+    /**
+     * Fetches per-user settings for an application.
+     * @param args - Object containing the `appKey`.
+     * @returns An observable that emits the {@link AppSettings} record.
+     * @throws {AppSettingsError} When settings cannot be loaded.
+     */
     getAppSettings(args: {
         appKey: string;
     }): Observable<AppSettings>;
+    /**
+     * Persists updated per-user settings for an application via PUT.
+     * @param args - Object containing the `appKey` and the `settings` payload to save.
+     * @returns An observable that emits the persisted {@link AppSettings}.
+     */
     updateAppSettings(args: {
         appKey: string;
         settings: AppSettings;
     }): Observable<AppSettings>;
+    /**
+     * Disposes of the client, completing all internal query streams.
+     */
     [Symbol.dispose](): void;
 }
 export default AppClient;

package/dist/types/AppConfig.d.ts

@@ -35,12 +35,18 @@ export declare class AppConfig<TEnvironment extends ConfigEnvironment = ConfigEn
     #private;
     /**
      * The environment configuration for the application.
+     * @returns The frozen environment configuration.
      */
     get environment(): TEnvironment;
     /**
-     * The configuration endpoints for the application,.
+     * The configuration endpoints for the application.
+     * @returns The frozen map of configuration endpoints.
      */
     get endpoints(): Record<string, ConfigEndPoint>;
+    /**
+     * Creates a new {@link AppConfig}, deep-freezing the provided environment and endpoints.
+     * @param config - The environment and endpoints to initialize the configuration with.
+     */
     constructor(config: {
         environment?: TEnvironment | null;
         endpoints?: Record<string, ConfigEndPoint>;

package/dist/types/AppConfigurator.d.ts

@@ -45,10 +45,35 @@ export interface IAppConfigurator {
 export declare class AppConfigurator extends BaseConfigBuilder<AppModuleConfig> implements IAppConfigurator {
     defaultExpireTime: number;
     /**
+     * Creates the default HTTP client for the app service, preferring a pre-configured
+     * client from the http module and falling back to service discovery.
+     *
      * WARNING: this function will be remove in future
+     *
+     * @param init - Module initializer args providing access to the http and service discovery modules.
+     * @returns A promise resolving to the {@link IHttpClient} used to communicate with the app service.
      */
     protected _createHttpClient(init: ModuleInitializerArgs<IAppConfigurator, [HttpModule, ServiceDiscoveryModule]>): Promise<IHttpClient>;
+    /**
+     * Sets the app service client used to fetch manifests, configs, and settings.
+     * @param client_or_cb - A promise resolving to an {@link IAppClient}, or a callback
+     *   that receives module initializer args and returns one.
+     */
     setClient(client_or_cb: Promise<AppModuleConfig['client']> | ConfigBuilderCallback<AppModuleConfig['client']>): void;
+    /**
+     * Sets the base URI used to proxy-load application script bundles.
+     *
+     * TODO(#5132) - explain why, used in import of resources aka proxy url
+     *
+     * @param base_or_cb - A static URI string or a callback returning one.
+     */
     setAssetUri(base_or_cb: string | ConfigBuilderCallback<string>): void;
+    /**
+     * Builds the resolved {@link AppModuleConfig}, applying default client and asset URI
+     * when they haven't been explicitly configured.
+     * @param init - Module initializer args used to build the default client.
+     * @param initial - Optional initial partial configuration.
+     * @returns The resolved module config.
+     */
     protected _createConfig(init: ModuleInitializerArgs<IAppConfigurator, [HttpModule, ServiceDiscoveryModule]>, initial?: Partial<AppModuleConfig>): import("rxjs").ObservableInput<AppModuleConfig>;
 }

package/dist/types/AppModuleProvider.d.ts

@@ -24,6 +24,7 @@ export declare class AppModuleProvider {
     /**
      * Shallow-compares two app manifests by JSON serialization.
      *
+     * @template T - The manifest type being compared.
      * @param a - First manifest to compare.
      * @param b - Second manifest to compare.
      * @returns `true` if the serialized manifests are identical.
@@ -31,6 +32,7 @@ export declare class AppModuleProvider {
     static compareAppManifest<T extends AppManifest>(a?: T, b?: T): boolean;
     /**
      * Get module version
+     * @returns The module's semantic version.
      */
     get version(): SemanticVersion;
     /**
@@ -39,6 +41,8 @@ export declare class AppModuleProvider {
      * - `undefined` – no application has been set yet.
      * - `null` – the current application was explicitly cleared.
      * - `App` – an active application instance.
+     *
+     * @returns The current active application, `null` if cleared, or `undefined` if never set.
      */
     get current(): CurrentApp | null | undefined;
     /**
@@ -46,6 +50,8 @@ export declare class AppModuleProvider {
      *
      * Emits are deduplicated by `appKey`; re-setting the same app does not trigger
      * a new emission.
+     *
+     * @returns An observable of the current active application.
      */
     get current$(): Observable<CurrentApp | null>;
     /**
@@ -79,6 +85,7 @@ export declare class AppModuleProvider {
     /**
      * fetch all applications
      * @deprecated use `getAppManifests` instead
+     * @returns An observable that emits an array of {@link AppManifest} objects.
      */
     getAllAppManifests(): Observable<AppManifest[]>;
     /**
@@ -121,11 +128,14 @@ export declare class AppModuleProvider {
     clearCurrentApp(): void;
     /**
      * Base URI used for proxying application script imports.
+     * @returns The configured asset base URI.
      */
     get assetUri(): string;
     /**
      * This should not be used, only for legacy creation backdoor
      * @deprecated
+     * @param value - The initial app bundle state to construct the app from.
+     * @returns The newly created {@link App} instance.
      */
     createApp(value: AppBundleStateInitial): App;
     /**

package/dist/types/app/App.d.ts

@@ -1,18 +1,11 @@
 import type { AppModulesInstance, AppScriptModule, AppManifest, AppConfig, AppSettings, ConfigEnvironment } from '../types';
 import { Observable } from '@equinor/fusion-observable';
 import type { AppModuleProvider } from '../AppModuleProvider';
-import { type OperatorFunction } from 'rxjs';
 import type { EventModule } from '@equinor/fusion-framework-module-event';
 import type { AnyModule, ModuleType } from '@equinor/fusion-framework-module';
 import type { AppBundleState, AppBundleStateInitial } from './types';
 import './events';
-/**
- * RxJS operator that filters out `null` and `undefined` emissions.
- *
- * @template T - The non-nullable value type.
- * @returns An operator that only passes through non-nullable values.
- */
-export declare function filterEmpty<T>(): OperatorFunction<T | null | undefined, T>;
+export { filterEmpty } from './filter-empty';
 /**
  * Public interface for a single loaded Fusion application.
  *
@@ -208,45 +201,93 @@ export type AppInitializeResult = {
  * manifest fetching, config loading, settings management, and script import. Dispatches
  * lifecycle events through the {@link EventModule} when available.
  *
+ * TODO(#5130): streams should be made distinct until changed from state.
+ *
  * @template TEnv - Shape of the environment configuration record.
  * @template TModules - Additional framework modules the app depends on.
  */
 export declare class App<TEnv extends ConfigEnvironment = ConfigEnvironment, TModules extends Array<AnyModule> | unknown = unknown> implements IApp<TEnv, TModules> {
     #private;
+    /** @inheritdoc */
     get manifest$(): Observable<AppManifest>;
+    /** @inheritdoc */
     get config$(): Observable<AppConfig<TEnv>>;
+    /** @inheritdoc */
     get modules$(): Observable<AppScriptModule>;
+    /** @inheritdoc */
     get instance$(): Observable<AppModulesInstance<TModules>>;
+    /** @inheritdoc */
     get settings$(): Observable<AppSettings>;
+    /** @inheritdoc */
     get status$(): Observable<AppBundleState['status']>;
+    /** @inheritdoc */
     get state(): Readonly<AppBundleState>;
+    /** @inheritdoc */
     get appKey(): string;
+    /**
+     * The tag (version) this app instance was loaded with, if any.
+     * @returns The tag string, or `undefined` if none was specified.
+     */
     get tag(): string | undefined;
+    /** @inheritdoc */
     get manifest(): Readonly<AppManifest> | undefined;
+    /** @inheritdoc */
     get manifestAsync(): Promise<Readonly<AppManifest>>;
+    /** @inheritdoc */
     get config(): AppConfig<TEnv> | undefined;
+    /**
+     * Retrieves the configuration asynchronously.
+     * @returns A promise that resolves to the {@link AppConfig}.
+     */
     get configAsync(): Promise<AppConfig<TEnv>>;
+    /** @inheritdoc */
     get instance(): AppModulesInstance<TModules> | undefined;
+    /**
+     * Creates a new {@link App} instance and starts its internal state machine.
+     * @param value - Initial app bundle state (appKey, tag, and any pre-loaded data).
+     * @param args - The owning {@link AppModuleProvider} and an optional event module for lifecycle events.
+     */
     constructor(value: AppBundleStateInitial, args: {
         provider: AppModuleProvider;
         event?: ModuleType<EventModule>;
     });
+    /** @inheritdoc */
     initialize(): Observable<AppInitializeResult>;
+    /** @inheritdoc */
     loadConfig(): void;
+    /** @inheritdoc */
     loadManifest(update?: boolean): void;
+    /**
+     * Replaces or merges the current manifest with a new one.
+     * @param manifest - The manifest to apply.
+     * @param replace - When `false` (default), merges into the existing manifest; when omitted, behaves the same.
+     */
     updateManifest(manifest: AppManifest, replace?: false): void;
+    /** @inheritdoc */
     loadAppModule(allow_cache?: boolean): Promise<void>;
+    /** @inheritdoc */
     getConfig(force_refresh?: boolean): Observable<AppConfig>;
+    /** @inheritdoc */
     getConfigAsync(allow_cache?: boolean): Promise<AppConfig>;
+    /** @inheritdoc */
     getSettings<T extends AppSettings>(force_refresh?: boolean): Observable<T>;
+    /** @inheritdoc */
     getSettingsAsync<T extends AppSettings>(allow_cache?: boolean): Promise<T>;
+    /** @inheritdoc */
     updateSettings<T extends AppSettings>(settings: T): Observable<T>;
+    /** @inheritdoc */
     updateSettingsAsync<T extends AppSettings>(settings: T): Promise<T>;
+    /** @inheritdoc */
     updateSetting<T extends AppSettings, P extends keyof T>(property: P, value: T[P]): Observable<T[P]>;
+    /** @inheritdoc */
     updateSettingAsync<T extends AppSettings, P extends keyof T>(property: P, value: T[P]): Promise<T[P]>;
+    /** @inheritdoc */
     getManifest(force_refresh?: boolean): Observable<AppManifest>;
+    /** @inheritdoc */
     getManifestAsync(allow_cache?: boolean): Promise<AppManifest>;
+    /** @inheritdoc */
     getAppModule(force_refresh?: boolean): Observable<AppScriptModule>;
+    /** @inheritdoc */
     getAppModuleAsync(allow_cache?: boolean): Promise<AppScriptModule>;
     dispose: VoidFunction;
 }

package/dist/types/app/create-reducer.d.ts

@@ -8,84 +8,84 @@ import type { AppBundleState, AppBundleStateInitial } from './types';
  * @param value - Initial state values (appKey, tag, and any pre-loaded data).
  * @returns A reducer function compatible with {@link FlowSubject}.
  */
-export declare const createReducer: (value: AppBundleStateInitial) => import("@equinor/fusion-observable").ReducerWithInitialState<AppBundleState, import("@equinor/fusion-observable").PayloadAction<import("..").AppManifest, "set_manifest", {
-    created: number;
-    update: boolean | undefined;
-}, never> | import("@equinor/fusion-observable").PayloadAction<{
-    key: string;
-    tag: string | undefined;
-}, "fetch_manifest::request", {
-    update: boolean | undefined;
-}, never> | {
-    payload: import("..").AppConfig<import("../AppConfig").ConfigEnvironment>;
-    type: "set_config";
-} | {
-    payload: import("..").AppManifest;
-    type: "fetch_config::request";
-} | {
-    payload: import("..").AppSettings | undefined;
-    type: "set_settings";
+export declare const createReducer: (value: AppBundleStateInitial) => import("@equinor/fusion-observable").ReducerWithInitialState<AppBundleState, {
+    payload: any;
+    type: "set_module";
 } | {
-    payload: {
-        appKey: string;
-    };
-    type: "fetch_settings::request";
+    payload: unknown;
+    type: "fetch_config::failure";
 } | {
-    payload: {
-        appKey: string;
-        settings: import("..").AppSettings;
-    };
-    type: "update_settings::request";
+    payload: unknown;
+    type: "fetch_manifest::failure";
 } | {
-    payload: string;
-    type: "update_settings::abort";
+    payload: unknown;
+    type: "fetch_settings::failure";
 } | {
-    payload: any;
-    type: "set_module";
+    payload: unknown;
+    type: "import_app::failure";
 } | {
-    payload: string;
-    type: "import_app::request";
+    payload: unknown;
+    type: "initialize_app::failure";
 } | {
-    payload: import("..").AppModulesInstance;
-    type: "set_instance";
+    payload: unknown;
+    type: "update_settings::failure";
 } | {
     payload: null;
     type: "initialize_app::request";
 } | {
-    payload: import("..").AppManifest;
-    type: "fetch_manifest::success";
+    payload: null;
+    type: "initialize_app::success";
 } | {
-    payload: unknown;
-    type: "fetch_manifest::failure";
+    payload: string;
+    type: "import_app::request";
+} | {
+    payload: string;
+    type: "update_settings::abort";
 } | {
     payload: import("..").AppConfig<import("../AppConfig").ConfigEnvironment>;
     type: "fetch_config::success";
 } | {
-    payload: unknown;
-    type: "fetch_config::failure";
+    payload: import("..").AppConfig<import("../AppConfig").ConfigEnvironment>;
+    type: "set_config";
+} | {
+    payload: import("..").AppManifest;
+    type: "fetch_config::request";
+} | {
+    payload: import("..").AppManifest;
+    type: "fetch_manifest::success";
+} | {
+    payload: import("..").AppScriptModule;
+    type: "import_app::success";
 } | {
     payload: import("..").AppSettings;
     type: "fetch_settings::success";
-} | {
-    payload: unknown;
-    type: "fetch_settings::failure";
 } | {
     payload: import("..").AppSettings;
     type: "update_settings::success";
 } | {
-    payload: unknown;
-    type: "update_settings::failure";
-} | {
-    payload: import("..").AppScriptModule;
-    type: "import_app::success";
+    payload: {
+        appKey: string;
+    };
+    type: "fetch_settings::request";
 } | {
-    payload: unknown;
-    type: "import_app::failure";
+    payload: {
+        appKey: string;
+        settings: import("..").AppSettings;
+    };
+    type: "update_settings::request";
 } | {
-    payload: null;
-    type: "initialize_app::success";
+    payload: import("..").AppSettings | undefined;
+    type: "set_settings";
 } | {
-    payload: unknown;
-    type: "initialize_app::failure";
-}>;
+    payload: import("..").AppModulesInstance;
+    type: "set_instance";
+} | import("@equinor/fusion-observable").PayloadAction<import("..").AppManifest, "set_manifest", {
+    created: number;
+    update: boolean | undefined;
+}, never> | import("@equinor/fusion-observable").PayloadAction<{
+    key: string;
+    tag: string | undefined;
+}, "fetch_manifest::request", {
+    update: boolean | undefined;
+}, never>>;
 export default createReducer;

package/dist/types/app/filter-empty.d.ts

@@ -0,0 +1,8 @@
+import { type OperatorFunction } from 'rxjs';
+/**
+ * RxJS operator that filters out `null` and `undefined` emissions.
+ *
+ * @template T - The non-nullable value type.
+ * @returns An operator that only passes through non-nullable values.
+ */
+export declare function filterEmpty<T>(): OperatorFunction<T | null | undefined, T>;

package/dist/types/app/flows/handle-fetch-config.d.ts

@@ -0,0 +1,12 @@
+import type { Flow } from '@equinor/fusion-observable';
+import type { AppModuleProvider } from '../../AppModuleProvider';
+import type { Actions } from '../actions';
+import type { AppBundleState } from '../types';
+/**
+ * Handles the fetch config action by fetching the app configuration from the provider,
+ * filtering out null values, and dispatching success or failure actions accordingly.
+ *
+ * @param provider The AppModuleProvider used to fetch the app configuration.
+ * @returns A Flow function that takes an Observable of actions and returns an Observable of actions.
+ */
+export declare const handleFetchConfig: (provider: AppModuleProvider) => Flow<Actions, AppBundleState>;

package/dist/types/app/flows/handle-fetch-manifest.d.ts

@@ -0,0 +1,12 @@
+import type { Flow } from '@equinor/fusion-observable';
+import type { AppModuleProvider } from '../../AppModuleProvider';
+import type { Actions } from '../actions';
+import type { AppBundleState } from '../types';
+/**
+ * Handles the fetch manifest action by fetching the app manifest from the provider,
+ * dispatching success or failure actions based on the result.
+ *
+ * @param provider The AppModuleProvider used to fetch the app manifest.
+ * @returns A Flow function that takes an Observable of actions and returns an Observable of actions.
+ */
+export declare const handleFetchManifest: (provider: AppModuleProvider) => Flow<Actions, AppBundleState>;

package/dist/types/app/flows/handle-fetch-settings.d.ts

@@ -0,0 +1,12 @@
+import type { Flow } from '@equinor/fusion-observable';
+import type { AppModuleProvider } from '../../AppModuleProvider';
+import type { Actions } from '../actions';
+import type { AppBundleState } from '../types';
+/**
+ * Handles the fetch settings action by fetching the app settings from the provider,
+ * filtering out null values, and dispatching success or failure actions accordingly.
+ *
+ * @param provider The AppModuleProvider used to fetch the app settings.
+ * @returns A Flow function that takes an Observable of actions and returns an Observable of actions.
+ */
+export declare const handleFetchSettings: (provider: AppModuleProvider) => Flow<Actions, AppBundleState>;

package/dist/types/app/flows/handle-import-application.d.ts

@@ -0,0 +1,10 @@
+import type { Flow } from '@equinor/fusion-observable';
+import type { AppModuleProvider } from '../../AppModuleProvider';
+import type { Actions } from '../actions';
+import type { AppBundleState } from '../types';
+/**
+ * Handles the import application flow.
+ * @param provider The AppModuleProvider used to resolve the application asset URI.
+ * @returns A flow that takes in actions and returns an observable of AppBundleState.
+ */
+export declare const handleImportApplication: (provider: AppModuleProvider) => Flow<Actions, AppBundleState>;

package/dist/types/app/flows/handle-update-settings.d.ts

@@ -0,0 +1,12 @@
+import type { Flow } from '@equinor/fusion-observable';
+import type { AppModuleProvider } from '../../AppModuleProvider';
+import type { Actions } from '../actions';
+import type { AppBundleState } from '../types';
+/**
+ * Handles the set settings action by setting the app settings from the provider,
+ * filtering out null values, and dispatching success or failure actions accordingly.
+ *
+ * @param provider The AppModuleProvider used to fetch the app settings.
+ * @returns A Flow function that takes an Observable of actions and returns an Observable of actions.
+ */
+export declare const handleUpdateSettings: (provider: AppModuleProvider) => Flow<Actions, AppBundleState>;

package/dist/types/app/flows/index.d.ts

@@ -0,0 +1,5 @@
+export { handleFetchManifest } from './handle-fetch-manifest';
+export { handleFetchConfig } from './handle-fetch-config';
+export { handleFetchSettings } from './handle-fetch-settings';
+export { handleUpdateSettings } from './handle-update-settings';
+export { handleImportApplication } from './handle-import-application';

package/dist/types/errors/AppBuildError.d.ts

@@ -0,0 +1,21 @@
+import type { AppErrorType } from './app-error-type';
+/**
+ * Represents an error that occurs in the application build.
+ */
+export declare class AppBuildError extends Error {
+    readonly type: AppErrorType;
+    /**
+     * Creates an instance of `AppBuildError` based on the HTTP response status.
+     * @param response The HTTP response.
+     * @param options Additional error options.
+     * @returns An instance of `AppBuildError` based on the HTTP response status.
+     */
+    static fromHttpResponse(response: Response, options?: ErrorOptions): AppBuildError;
+    /**
+     * Creates an instance of `AppBuildError`.
+     * @param type The type of the application error.
+     * @param message The error message.
+     * @param options Additional error options.
+     */
+    constructor(type: AppErrorType, message?: string, options?: ErrorOptions);
+}

package/dist/types/errors/AppConfigError.d.ts

@@ -0,0 +1,21 @@
+import type { AppErrorType } from './app-error-type';
+/**
+ * Represents an error that occurs in the application configuration.
+ */
+export declare class AppConfigError extends Error {
+    readonly type: AppErrorType;
+    /**
+     * Creates an instance of `AppConfigError` based on the HTTP response status.
+     * @param response The HTTP response.
+     * @param options Additional error options.
+     * @returns An instance of `AppConfigError` based on the HTTP response status.
+     */
+    static fromHttpResponse(response: Response, options?: ErrorOptions): AppConfigError;
+    /**
+     * Creates an instance of `AppConfigError`.
+     * @param type The type of the application error.
+     * @param message The error message.
+     * @param options Additional error options.
+     */
+    constructor(type: AppErrorType, message?: string, options?: ErrorOptions);
+}

package/dist/types/errors/AppManifestError.d.ts

@@ -0,0 +1,21 @@
+import type { AppErrorType } from './app-error-type';
+/**
+ * Represents an error that occurs when loading an application manifest.
+ */
+export declare class AppManifestError extends Error {
+    readonly type: AppErrorType;
+    /**
+     * Creates an instance of AppManifestError based on the HTTP response status.
+     * @param response The HTTP response.
+     * @param options Optional error options.
+     * @returns An instance of AppManifestError.
+     */
+    static fromHttpResponse(response: Response, options?: ErrorOptions): AppManifestError;
+    /**
+     * Creates an instance of AppManifestError.
+     * @param type The type of the error.
+     * @param message The error message.
+     * @param options Optional error options.
+     */
+    constructor(type: AppErrorType, message?: string, options?: ErrorOptions);
+}

package/dist/types/errors/AppScriptModuleError.d.ts

@@ -0,0 +1,14 @@
+import type { AppErrorType } from './app-error-type';
+/**
+ * Represents an error that occurs when loading the application script.
+ */
+export declare class AppScriptModuleError extends Error {
+    readonly type: AppErrorType;
+    /**
+     * Creates a new instance of the AppScriptModuleError class.
+     * @param type The type of the error.
+     * @param message The error message.
+     * @param options Additional options for the error.
+     */
+    constructor(type: AppErrorType, message?: string, options?: ErrorOptions);
+}

package/dist/types/errors/AppSettingsError.d.ts

@@ -0,0 +1,21 @@
+import type { AppErrorType } from './app-error-type';
+/**
+ * Represents an error that occurs while fetching application settings.
+ */
+export declare class AppSettingsError extends Error {
+    readonly type: AppErrorType;
+    /**
+     * Creates an instance of `AppSettingsError` based on the HTTP response status.
+     * @param response The HTTP response.
+     * @param options Additional error options.
+     * @returns An instance of `AppSettingsError` based on the HTTP response status.
+     */
+    static fromHttpResponse(response: Response, options?: ErrorOptions): AppSettingsError;
+    /**
+     * Creates an instance of `AppSettingsError`.
+     * @param type The type of the application error.
+     * @param message The error message.
+     * @param options Additional error options.
+     */
+    constructor(type: AppErrorType, message?: string, options?: ErrorOptions);
+}

package/dist/types/errors/app-error-type.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Discriminant for application-related errors.
+ *
+ * - `'not_found'` – The requested resource does not exist (HTTP 404).
+ * - `'unauthorized'` – The request lacks valid credentials (HTTP 401).
+ * - `'deleted'` – The resource has been removed (HTTP 410).
+ * - `'unknown'` – An unexpected failure occurred.
+ */
+export type AppErrorType = 'not_found' | 'unauthorized' | 'unknown' | 'deleted';