@rxap/config 19.0.1-dev.2 → 19.0.1-dev.5

package/docs/wiki/Class.ConfigLoaderService.md

@@ -0,0 +1,69 @@
+[@rxap/config](../wiki/globals) / ConfigLoaderService
+
+# Class: ConfigLoaderService
+
+Defined in: [config-loader.service.ts:16](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-loader.service.ts#L16)
+
+## Constructors
+
+### new ConfigLoaderService()
+
+> **new ConfigLoaderService**(`http`): [`ConfigLoaderService`](../wiki/Class.ConfigLoaderService)
+
+Defined in: [config-loader.service.ts:21](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-loader.service.ts#L21)
+
+#### Parameters
+
+##### http
+
+`HttpClient`
+
+#### Returns
+
+[`ConfigLoaderService`](../wiki/Class.ConfigLoaderService)
+
+## Properties
+
+### configLoading
+
+> `readonly` **configLoading**: `Map`\<`string`, `Observable`\<`any`\>\>
+
+Defined in: [config-loader.service.ts:19](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-loader.service.ts#L19)
+
+***
+
+### configs
+
+> `readonly` **configs**: `Map`\<`string`, `any`\>
+
+Defined in: [config-loader.service.ts:17](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-loader.service.ts#L17)
+
+***
+
+### http
+
+> `readonly` **http**: `HttpClient`
+
+Defined in: [config-loader.service.ts:23](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-loader.service.ts#L23)
+
+## Methods
+
+### load$()
+
+> **load$**\<`T`\>(`url`): `Promise`\<`T`\>
+
+Defined in: [config-loader.service.ts:27](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-loader.service.ts#L27)
+
+#### Type Parameters
+
+• **T** = `any`
+
+#### Parameters
+
+##### url
+
+`string`
+
+#### Returns
+
+`Promise`\<`T`\>

package/docs/wiki/Class.ConfigService.md

@@ -0,0 +1,354 @@
+[@rxap/config](../wiki/globals) / ConfigService
+
+# Class: ConfigService\<Config\>
+
+Defined in: [config.service.ts:32](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L32)
+
+## Type Parameters
+
+• **Config** *extends* `Record`\<`string`, `any`\> = `Record`\<`string`, `any`\>
+
+## Constructors
+
+### new ConfigService()
+
+> **new ConfigService**\<`Config`\>(`config`): [`ConfigService`](../wiki/Class.ConfigService)\<`Config`\>
+
+Defined in: [config.service.ts:63](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L63)
+
+#### Parameters
+
+##### config
+
+`any` = `null`
+
+#### Returns
+
+[`ConfigService`](../wiki/Class.ConfigService)\<`Config`\>
+
+## Properties
+
+### config
+
+> `readonly` **config**: `Config`
+
+Defined in: [config.service.ts:61](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L61)
+
+***
+
+### Config
+
+> `static` **Config**: `any` = `null`
+
+Defined in: [config.service.ts:40](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L40)
+
+***
+
+### Defaults
+
+> `static` **Defaults**: `any` = `{}`
+
+Defined in: [config.service.ts:47](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L47)
+
+Static default values for the config object.
+Will be overwritten by an dynamic config file specified in
+the Urls array.
+
+***
+
+### LocalStorageKey
+
+> `static` **LocalStorageKey**: `string` = `'rxap/config/local-config'`
+
+Defined in: [config.service.ts:55](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L55)
+
+***
+
+### onError
+
+> `static` **onError**: `ReplaySubject`\<`unknown`\>
+
+Defined in: [config.service.ts:34](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L34)
+
+***
+
+### onErrorFnc
+
+> `static` **onErrorFnc**: (`error`) => `void`[] = `[]`
+
+Defined in: [config.service.ts:37](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L37)
+
+#### Parameters
+
+##### error
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### onRequestError
+
+> `static` **onRequestError**: `ReplaySubject`\<`Response`\>
+
+Defined in: [config.service.ts:35](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L35)
+
+***
+
+### onRequestErrorFnc
+
+> `static` **onRequestErrorFnc**: (`response`) => `void`[] = `[]`
+
+Defined in: [config.service.ts:38](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L38)
+
+#### Parameters
+
+##### response
+
+`Response`
+
+#### Returns
+
+`void`
+
+***
+
+### Overwrites
+
+> `static` **Overwrites**: `any` = `{}`
+
+Defined in: [config.service.ts:53](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L53)
+
+Any value definition in the Overwrites object will overwrite any
+value form the Defaults values or dynamic config files
+
+***
+
+### ~~Urls~~
+
+> `static` **Urls**: `never`[] = `[]`
+
+Defined in: [config.service.ts:60](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L60)
+
+#### Deprecated
+
+instead use the url property of the ConfigLoadOptions
+
+## Methods
+
+### clearLocalConfig()
+
+> **clearLocalConfig**(): `void`
+
+Defined in: [config.service.ts:346](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L346)
+
+#### Returns
+
+`void`
+
+***
+
+### get()
+
+#### Call Signature
+
+> **get**\<`T`\>(`propertyPath`): `undefined` \| `T`
+
+Defined in: [config.service.ts:350](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L350)
+
+##### Type Parameters
+
+• **T** = `any`
+
+##### Parameters
+
+###### propertyPath
+
+`string`
+
+##### Returns
+
+`undefined` \| `T`
+
+#### Call Signature
+
+> **get**\<`T`\>(`propertyPath`, `defaultValue`): `T`
+
+Defined in: [config.service.ts:351](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L351)
+
+##### Type Parameters
+
+• **T** = `any`
+
+##### Parameters
+
+###### propertyPath
+
+`string`
+
+###### defaultValue
+
+[`NoInferType`](../wiki/TypeAlias.NoInferType)\<`T`\>
+
+##### Returns
+
+`T`
+
+***
+
+### getOrThrow()
+
+#### Call Signature
+
+> **getOrThrow**\<`T`\>(`propertyPath`): `T`
+
+Defined in: [config.service.ts:356](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L356)
+
+##### Type Parameters
+
+• **T** = `any`
+
+##### Parameters
+
+###### propertyPath
+
+`string`
+
+##### Returns
+
+`T`
+
+#### Call Signature
+
+> **getOrThrow**\<`T`\>(`propertyPath`, `defaultValue`): `T`
+
+Defined in: [config.service.ts:357](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L357)
+
+##### Type Parameters
+
+• **T** = `any`
+
+##### Parameters
+
+###### propertyPath
+
+`string`
+
+###### defaultValue
+
+[`NoInferType`](../wiki/TypeAlias.NoInferType)\<`T`\>
+
+##### Returns
+
+`T`
+
+***
+
+### setLocalConfig()
+
+> **setLocalConfig**(`config`): `void`
+
+Defined in: [config.service.ts:342](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L342)
+
+#### Parameters
+
+##### config
+
+`Config`
+
+#### Returns
+
+`void`
+
+***
+
+### Get()
+
+> `static` **Get**\<`T`, `K`\>(`path`, `defaultValue`, `config`): `T`
+
+Defined in: [config.service.ts:283](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L283)
+
+#### Type Parameters
+
+• **T** = `any`
+
+• **K** *extends* `Record`\<`string`, `any`\> = `Record`\<`string`, `any`\>
+
+#### Parameters
+
+##### path
+
+`string`
+
+##### defaultValue
+
+`undefined` | `T`
+
+##### config
+
+`Record`\<`string`, `any`\>
+
+#### Returns
+
+`T`
+
+***
+
+### Load()
+
+> `static` **Load**(`options`?, `environment`?): `Promise`\<`void`\>
+
+Defined in: [config.service.ts:81](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L81)
+
+Used to load the app config from a remote resource.
+
+Promise.all([ ConfigService.Load() ])
+.then(() => platformBrowserDynamic().bootstrapModule(AppModule))
+.catch(err => console.error(err))
+
+#### Parameters
+
+##### options?
+
+[`ConfigLoadOptions`](../wiki/Interface.ConfigLoadOptions)
+
+##### environment?
+
+`Environment`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### SideLoad()
+
+> `static` **SideLoad**(`url`, `propertyPath`, `required`?, `schema`?): `Promise`\<`void`\>
+
+Defined in: [config.service.ts:264](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L264)
+
+#### Parameters
+
+##### url
+
+`string`
+
+##### propertyPath
+
+`string`
+
+##### required?
+
+`boolean`
+
+##### schema?
+
+[`AnySchema`](../wiki/TypeAlias.AnySchema)
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/wiki/Class.ConfigTestingService.md

@@ -0,0 +1,151 @@
+[@rxap/config](../wiki/globals) / ConfigTestingService
+
+# Class: ConfigTestingService
+
+Defined in: [config-testing-service.ts:9](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-testing-service.ts#L9)
+
+## Implements
+
+- [`ConfigService`](../wiki/Class.ConfigService)
+
+## Constructors
+
+### new ConfigTestingService()
+
+> **new ConfigTestingService**(): [`ConfigTestingService`](../wiki/Class.ConfigTestingService)
+
+#### Returns
+
+[`ConfigTestingService`](../wiki/Class.ConfigTestingService)
+
+## Properties
+
+### config
+
+> `readonly` **config**: `Record`\<`string`, `any`\> = `{}`
+
+Defined in: [config-testing-service.ts:10](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-testing-service.ts#L10)
+
+#### Implementation of
+
+[`ConfigService`](../wiki/Class.ConfigService).[`config`](../wiki/Class.ConfigService#config-1)
+
+## Methods
+
+### clearLocalConfig()
+
+> **clearLocalConfig**(): `void`
+
+Defined in: [config-testing-service.ts:13](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-testing-service.ts#L13)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ConfigService`](../wiki/Class.ConfigService).[`clearLocalConfig`](../wiki/Class.ConfigService#clearlocalconfig)
+
+***
+
+### get()
+
+> **get**\<`T`\>(`propertyPath`, `defaultValue`?): `undefined` \| `T`
+
+Defined in: [config-testing-service.ts:20](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-testing-service.ts#L20)
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+##### propertyPath
+
+`string`
+
+##### defaultValue?
+
+`T`
+
+#### Returns
+
+`undefined` \| `T`
+
+#### Implementation of
+
+[`ConfigService`](../wiki/Class.ConfigService).[`get`](../wiki/Class.ConfigService#get)
+
+***
+
+### getOrThrow()
+
+> **getOrThrow**\<`T`\>(`propertyPath`): `T`
+
+Defined in: [config-testing-service.ts:24](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-testing-service.ts#L24)
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+##### propertyPath
+
+`string`
+
+#### Returns
+
+`T`
+
+#### Implementation of
+
+[`ConfigService`](../wiki/Class.ConfigService).[`getOrThrow`](../wiki/Class.ConfigService#getorthrow)
+
+***
+
+### set()
+
+> **set**\<`T`\>(`propertyPath`, `value`): `void`
+
+Defined in: [config-testing-service.ts:16](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-testing-service.ts#L16)
+
+#### Type Parameters
+
+• **T**
+
+#### Parameters
+
+##### propertyPath
+
+`string`
+
+##### value
+
+`T`
+
+#### Returns
+
+`void`
+
+***
+
+### setLocalConfig()
+
+> **setLocalConfig**(`config`): `void`
+
+Defined in: [config-testing-service.ts:33](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config-testing-service.ts#L33)
+
+#### Parameters
+
+##### config
+
+`Record`\<`string`, `any`\>
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ConfigService`](../wiki/Class.ConfigService).[`setLocalConfig`](../wiki/Class.ConfigService#setlocalconfig)

package/docs/wiki/Function.ProvideConfig.md

@@ -0,0 +1,25 @@
+[@rxap/config](../wiki/globals) / ProvideConfig
+
+# Function: ProvideConfig()
+
+> **ProvideConfig**(`config`): `object`
+
+Defined in: [provide-config.ts:3](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/provide-config.ts#L3)
+
+## Parameters
+
+### config
+
+`Record`\<`string`, `unknown`\> = `{}`
+
+## Returns
+
+`object`
+
+### provide
+
+> **provide**: `InjectionToken`\<`unknown`\> = `RXAP_CONFIG`
+
+### useValue
+
+> **useValue**: `Record`\<`string`, `unknown`\> = `config`

package/docs/wiki/Home.md

@@ -0,0 +1,33 @@
+Provides a configuration service for Angular applications, allowing you to load and manage application settings from various sources such as static files, URLs, local storage, and URL parameters. It supports schema validation and provides utilities for accessing configuration values. This package also includes testing utilities for mocking and managing configurations in test environments.
+
+[![npm version](https://img.shields.io/npm/v/@rxap/config?style=flat-square)](https://www.npmjs.com/package/@rxap/config)
+[![commitizen
+friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
+[![styled with
+prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+![Libraries.io dependency status for latest release, scoped npm
+package](https://img.shields.io/librariesio/release/npm/@rxap/config)
+![npm](https://img.shields.io/npm/dm/@rxap/config)
+![NPM](https://img.shields.io/npm/l/@rxap/config) -
+[Installation](../wiki/#installation)
+- [Generators](../wiki/#generators)
+    - [init](../wiki/#init)
+
+# Installation **Add the package to your workspace:** ```bash yarn add
+@rxap/config
+```
+**Install peer dependencies:** ```bash yarn add
+  @angular/common@^19.1.3 @angular/core@^19.1.3 @rxap/environment@^19.0.1-dev.4 @rxap/utilities@^16.4.2-dev.4 rxjs@^7.8.1 
+  ```
+**Execute the init generator:** ```bash yarn nx g
+  @rxap/config:init ```
+# Generators
+
+    ##
+    init
+    >
+    Initialize the package in the workspace
+
+    ```bash nx g
+    @rxap/config:init
+    ```