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

package/docs/markdown/classes/ConfigTestingService.md

@@ -0,0 +1,155 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / 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`](ConfigService.md)
+
+## Constructors
+
+### new ConfigTestingService()
+
+> **new ConfigTestingService**(): [`ConfigTestingService`](ConfigTestingService.md)
+
+#### Returns
+
+[`ConfigTestingService`](ConfigTestingService.md)
+
+## 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`](ConfigService.md).[`config`](ConfigService.md#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`](ConfigService.md).[`clearLocalConfig`](ConfigService.md#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`](ConfigService.md).[`get`](ConfigService.md#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`](ConfigService.md).[`getOrThrow`](ConfigService.md#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`](ConfigService.md).[`setLocalConfig`](ConfigService.md#setlocalconfig)

package/docs/markdown/functions/ProvideConfig.md

@@ -0,0 +1,29 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / 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/markdown/globals.md

@@ -0,0 +1,38 @@
+[**@rxap/config**](README.md)
+
+***
+
+# @rxap/config
+
+## Classes
+
+- [ConfigLoaderService](classes/ConfigLoaderService.md)
+- [ConfigService](classes/ConfigService.md)
+- [ConfigTestingService](classes/ConfigTestingService.md)
+
+## Interfaces
+
+- [AppsNavigationConfig](interfaces/AppsNavigationConfig.md)
+- [Config](interfaces/Config.md)
+- [ConfigLoadOptions](interfaces/ConfigLoadOptions.md)
+- [i18nConfig](interfaces/i18nConfig.md)
+- [LogoConfig](interfaces/LogoConfig.md)
+- [NavigationConfig](interfaces/NavigationConfig.md)
+- [Oauth2Config](interfaces/Oauth2Config.md)
+
+## Type Aliases
+
+- [AnySchema](type-aliases/AnySchema.md)
+- [Join](type-aliases/Join.md)
+- [LanguagesConfig](type-aliases/LanguagesConfig.md)
+- [Leaves](type-aliases/Leaves.md)
+- [NoInferType](type-aliases/NoInferType.md)
+- [Paths](type-aliases/Paths.md)
+
+## Variables
+
+- [RXAP\_CONFIG](variables/RXAP_CONFIG.md)
+
+## Functions
+
+- [ProvideConfig](functions/ProvideConfig.md)

package/docs/markdown/interfaces/AppsNavigationConfig.md

@@ -0,0 +1,89 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / AppsNavigationConfig
+
+# Interface: AppsNavigationConfig
+
+Defined in: [config.ts:3](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L3)
+
+## Properties
+
+### empty?
+
+> `optional` **empty**: `false`
+
+Defined in: [config.ts:9](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L9)
+
+***
+
+### hidden?
+
+> `optional` **hidden**: `boolean`
+
+Defined in: [config.ts:10](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L10)
+
+***
+
+### href?
+
+> `optional` **href**: `string`
+
+Defined in: [config.ts:7](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L7)
+
+***
+
+### icon?
+
+> `optional` **icon**: `IconConfig`
+
+Defined in: [config.ts:13](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L13)
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+Defined in: [config.ts:11](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L11)
+
+***
+
+### image?
+
+> `optional` **image**: `string`
+
+Defined in: [config.ts:5](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L5)
+
+***
+
+### label
+
+> **label**: `string`
+
+Defined in: [config.ts:6](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L6)
+
+***
+
+### permissions?
+
+> `optional` **permissions**: `string`[]
+
+Defined in: [config.ts:12](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L12)
+
+***
+
+### routerLink?
+
+> `optional` **routerLink**: `string`[]
+
+Defined in: [config.ts:8](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L8)
+
+***
+
+### target?
+
+> `optional` **target**: `string`
+
+Defined in: [config.ts:4](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L4)

package/docs/markdown/interfaces/Config.md

@@ -0,0 +1,41 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / Config
+
+# Interface: Config
+
+Defined in: [config.ts:42](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L42)
+
+## Properties
+
+### i18n?
+
+> `optional` **i18n**: [`i18nConfig`](i18nConfig.md)
+
+Defined in: [config.ts:45](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L45)
+
+***
+
+### logo?
+
+> `optional` **logo**: [`LogoConfig`](LogoConfig.md)
+
+Defined in: [config.ts:44](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L44)
+
+***
+
+### navigation?
+
+> `optional` **navigation**: [`NavigationConfig`](NavigationConfig.md)
+
+Defined in: [config.ts:43](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L43)
+
+***
+
+### oauth2?
+
+> `optional` **oauth2**: [`Oauth2Config`](Oauth2Config.md)
+
+Defined in: [config.ts:46](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L46)

package/docs/markdown/interfaces/ConfigLoadOptions.md

@@ -0,0 +1,51 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / ConfigLoadOptions
+
+# Interface: ConfigLoadOptions
+
+Defined in: [config.service.ts:18](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L18)
+
+## Properties
+
+### fromLocalStorage?
+
+> `optional` **fromLocalStorage**: `boolean`
+
+Defined in: [config.service.ts:20](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L20)
+
+***
+
+### fromUrlParam?
+
+> `optional` **fromUrlParam**: `string` \| `boolean`
+
+Defined in: [config.service.ts:19](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L19)
+
+***
+
+### schema?
+
+> `optional` **schema**: [`AnySchema`](../type-aliases/AnySchema.md)
+
+Defined in: [config.service.ts:21](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L21)
+
+***
+
+### static?
+
+> `optional` **static**: `Record`\<`string`, `any`\>
+
+Defined in: [config.service.ts:26](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L26)
+
+static config values
+
+***
+
+### url?
+
+> `optional` **url**: `string` \| `string`[] \| (`environment`) => `string` \| `string`[]
+
+Defined in: [config.service.ts:22](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L22)

package/docs/markdown/interfaces/LogoConfig.md

@@ -0,0 +1,33 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / LogoConfig
+
+# Interface: LogoConfig
+
+Defined in: [config.ts:16](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L16)
+
+## Properties
+
+### height?
+
+> `optional` **height**: `number`
+
+Defined in: [config.ts:19](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L19)
+
+***
+
+### src?
+
+> `optional` **src**: `string`
+
+Defined in: [config.ts:17](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L17)
+
+***
+
+### width?
+
+> `optional` **width**: `number`
+
+Defined in: [config.ts:18](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L18)

package/docs/markdown/interfaces/NavigationConfig.md

@@ -0,0 +1,57 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / NavigationConfig
+
+# Interface: NavigationConfig
+
+Defined in: [config.ts:22](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L22)
+
+## Properties
+
+### apps?
+
+> `optional` **apps**: [`AppsNavigationConfig`](AppsNavigationConfig.md)[]
+
+Defined in: [config.ts:23](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L23)
+
+***
+
+### collapsable?
+
+> `optional` **collapsable**: `boolean`
+
+Defined in: [config.ts:24](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L24)
+
+***
+
+### fixedInViewport?
+
+> `optional` **fixedInViewport**: `boolean`
+
+Defined in: [config.ts:28](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L28)
+
+***
+
+### mode?
+
+> `optional` **mode**: `"side"` \| `"over"`
+
+Defined in: [config.ts:26](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L26)
+
+***
+
+### opened?
+
+> `optional` **opened**: `boolean`
+
+Defined in: [config.ts:27](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L27)
+
+***
+
+### pinned?
+
+> `optional` **pinned**: `boolean`
+
+Defined in: [config.ts:25](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L25)

package/docs/markdown/interfaces/Oauth2Config.md

@@ -0,0 +1,17 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / Oauth2Config
+
+# Interface: Oauth2Config
+
+Defined in: [config.ts:38](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L38)
+
+## Properties
+
+### profileUrl?
+
+> `optional` **profileUrl**: `string`
+
+Defined in: [config.ts:39](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L39)

package/docs/markdown/interfaces/i18nConfig.md

@@ -0,0 +1,25 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / i18nConfig
+
+# Interface: i18nConfig
+
+Defined in: [config.ts:33](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L33)
+
+## Properties
+
+### defaultLanguage?
+
+> `optional` **defaultLanguage**: `string`
+
+Defined in: [config.ts:35](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L35)
+
+***
+
+### languages?
+
+> `optional` **languages**: [`LanguagesConfig`](../type-aliases/LanguagesConfig.md)
+
+Defined in: [config.ts:34](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L34)

package/docs/markdown/type-aliases/AnySchema.md

@@ -0,0 +1,27 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / AnySchema
+
+# Type Alias: AnySchema
+
+> **AnySchema**: `object`
+
+Defined in: [config.service.ts:16](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.service.ts#L16)
+
+## Type declaration
+
+### validateAsync()
+
+> **validateAsync**: (...`args`) => `any`
+
+#### Parameters
+
+##### args
+
+...`any`[]
+
+#### Returns
+
+`any`

package/docs/markdown/type-aliases/Join.md

@@ -0,0 +1,17 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / Join
+
+# Type Alias: Join\<K, P\>
+
+> **Join**\<`K`, `P`\>: `K` *extends* `string` \| `number` ? `P` *extends* `string` \| `number` ? `` `${K}${"" extends P ? "" : "."}${P}` `` : `never` : `never`
+
+Defined in: [types.ts:8](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/types.ts#L8)
+
+## Type Parameters
+
+• **K**
+
+• **P**

package/docs/markdown/type-aliases/LanguagesConfig.md

@@ -0,0 +1,11 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / LanguagesConfig
+
+# Type Alias: LanguagesConfig
+
+> **LanguagesConfig**: `Record`\<`string`, `string`\>
+
+Defined in: [config.ts:31](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/config.ts#L31)

package/docs/markdown/type-aliases/Leaves.md

@@ -0,0 +1,17 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / Leaves
+
+# Type Alias: Leaves\<T, D\>
+
+> **Leaves**\<`T`, `D`\>: \[`D`\] *extends* \[`never`\] ? `never` : `T` *extends* `object` ? `{ [K in keyof T]-?: Join<K, Leaves<T[K], Prev[D]>> }`\[keyof `T`\] : `""`
+
+Defined in: [types.ts:20](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/types.ts#L20)
+
+## Type Parameters
+
+• **T**
+
+• **D** *extends* `number` = `10`

package/docs/markdown/type-aliases/NoInferType.md

@@ -0,0 +1,15 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / NoInferType
+
+# Type Alias: NoInferType\<T\>
+
+> **NoInferType**\<`T`\>: \[`T`\]\[`T` *extends* `any` ? `0` : `never`\]
+
+Defined in: [types.ts:1](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/types.ts#L1)
+
+## Type Parameters
+
+• **T**

package/docs/markdown/type-aliases/Paths.md

@@ -0,0 +1,17 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / Paths
+
+# Type Alias: Paths\<T, D\>
+
+> **Paths**\<`T`, `D`\>: \[`D`\] *extends* \[`never`\] ? `never` : `T` *extends* `object` ? \{ \[K in keyof T\]-?: K extends string \| number ? \`$\{K\}\` \| Join\<K, Paths\<T\[K\], Prev\[D\]\>\> : never \}\[keyof `T`\] : `""`
+
+Defined in: [types.ts:13](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/types.ts#L13)
+
+## Type Parameters
+
+• **T**
+
+• **D** *extends* `number` = `10`

package/docs/markdown/variables/RXAP_CONFIG.md

@@ -0,0 +1,11 @@
+[**@rxap/config**](../README.md)
+
+***
+
+[@rxap/config](../globals.md) / RXAP\_CONFIG
+
+# Variable: RXAP\_CONFIG
+
+> `const` **RXAP\_CONFIG**: `InjectionToken`\<`unknown`\>
+
+Defined in: [tokens.ts:3](https://gitlab.com/rxap/packages/-/blob/969f0867a1da05a157f626d5bdd316bd0a67494a/packages/angular/config/src/lib/tokens.ts#L3)