@genesislcap/foundation-filters 9.0.1-alpha-b5c5eb7.0

package/docs/api/foundation-filters.runner.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [runner](./foundation-filters.runner.md)
+
+## runner() function
+
+Client filter runner function.
+
+**Signature:**
+
+```typescript
+export declare function runner(filters: ClientFilterSchemas[], container: Container): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  filters | [ClientFilterSchemas](./foundation-filters.clientfilterschemas.md)<!-- -->\[\] | An array of client filters to run. |
+|  container | Container | The DI container. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+This will return true when all the filters in the array pass.
+

package/docs/api/foundation-filters.timewindow.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [TimeWindow](./foundation-filters.timewindow.md)
+
+## TimeWindow interface
+
+TimeWindow client filter DI interface.
+
+**Signature:**
+
+```typescript
+export interface TimeWindow extends ClientFilter<TimeWindowParams> 
+```
+**Extends:** [ClientFilter](./foundation-filters.clientfilter.md)<!-- -->&lt;[TimeWindowParams](./foundation-filters.timewindowparams.md)<!-- -->&gt;
+
+## Remarks
+
+Simplifies access to runtime data / state contained within the DI container.
+

package/docs/api/foundation-filters.timewindowfilter.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [timeWindowFilter](./foundation-filters.timewindowfilter.md)
+
+## timeWindowFilter() function
+
+TimeWindow client filter function.
+
+**Signature:**
+
+```typescript
+export declare function timeWindowFilter(start?: string, end?: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  start | string | _(Optional)_ The start of the time window. |
+|  end | string | _(Optional)_ The end of the time window. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+This will return true between a certain time window. Start and end can be provided in any format recognized by the Date.parse() method.
+

package/docs/api/foundation-filters.timewindowparams.md

@@ -0,0 +1,59 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [TimeWindowParams](./foundation-filters.timewindowparams.md)
+
+## TimeWindowParams type
+
+TimeWindowParams
+
+**Signature:**
+
+```typescript
+export type TimeWindowParams = {
+    readonly start?: string;
+    readonly end?: string;
+};
+```
+
+## Remarks
+
+Both params can be provided in any format recognized by the Date.parse() method.
+
+## Example 1
+
+
+```json
+{
+  "start": "Sun Sep 25 2022 16:51:55 GMT+0000",
+  "end": "Fri Nov 25 2022 17:51:55 GMT+0000"
+}
+```
+
+## Example 2
+
+
+```json
+{
+  "start": "2022-10-01",
+  "end": "2022-12-01"
+}
+```
+
+## Example 3
+
+
+```json
+{
+  "end": "Dec 31, 2022"
+}
+```
+
+## Example 4
+
+
+```json
+{
+  "start": "2023-01-01T00:00:00.000+00:00"
+}
+```
+

package/docs/api/foundation-filters.timewindowschema.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [TimeWindowSchema](./foundation-filters.timewindowschema.md)
+
+## TimeWindowSchema type
+
+TimeWindowSchema type.
+
+**Signature:**
+
+```typescript
+export type TimeWindowSchema = ClientFilterSchema<typeof ClientFilterName.timeWindow, TimeWindowParams>;
+```
+**References:** [ClientFilterSchema](./foundation-filters.clientfilterschema.md)<!-- -->, [TimeWindowParams](./foundation-filters.timewindowparams.md)
+
+## Remarks
+
+JSON schema type.
+

package/docs/api/foundation-filters.urltargeting.issecure.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [URLTargeting](./foundation-filters.urltargeting.md) &gt; [isSecure](./foundation-filters.urltargeting.issecure.md)
+
+## URLTargeting.isSecure() method
+
+**Signature:**
+
+```typescript
+isSecure(url: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  url | string | A url. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+Check if a url is secure.
+

package/docs/api/foundation-filters.urltargeting.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [URLTargeting](./foundation-filters.urltargeting.md)
+
+## URLTargeting interface
+
+URLTargeting client filter DI interface.
+
+**Signature:**
+
+```typescript
+export interface URLTargeting extends ClientFilter<URLTargetingParams> 
+```
+**Extends:** [ClientFilter](./foundation-filters.clientfilter.md)<!-- -->&lt;[URLTargetingParams](./foundation-filters.urltargetingparams.md)<!-- -->&gt;
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [isSecure(url)](./foundation-filters.urltargeting.issecure.md) |  |
+

package/docs/api/foundation-filters.urltargetingfilter.md

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [urlTargetingFilter](./foundation-filters.urltargetingfilter.md)
+
+## urlTargetingFilter() function
+
+URLTargeting client filter function.
+
+**Signature:**
+
+```typescript
+export declare function urlTargetingFilter(url: string, pattern?: RegExp, schemes?: string[], hosts?: string[], paths?: string[]): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  url | string | A url. |
+|  pattern | RegExp | _(Optional)_ A regex. |
+|  schemes | string\[\] | _(Optional)_ Schemes/protocols to target. |
+|  hosts | string\[\] | _(Optional)_ Hosts to target. |
+|  paths | string\[\] | _(Optional)_ Paths to target. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+This will return true when the current URL matches on ANY of the parameters. If you wish to match on multiple parameters, consider chaining an array of urlTargeting filters together.
+

package/docs/api/foundation-filters.urltargetingparams.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [URLTargetingParams](./foundation-filters.urltargetingparams.md)
+
+## URLTargetingParams type
+
+URLTargetingParams
+
+**Signature:**
+
+```typescript
+export type URLTargetingParams = {
+    readonly url?: string;
+    readonly pattern?: RegExp;
+    readonly schemes?: string[];
+    readonly hosts?: string[];
+    readonly paths?: string[];
+};
+```
+
+## Example
+
+
+```json
+{
+   "schemes": ["https"],
+   "hosts": ["neptx.genesislab.global", "neptune-uat2-axes-server2"]
+}
+```
+

package/docs/api/foundation-filters.urltargetingschema.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [URLTargetingSchema](./foundation-filters.urltargetingschema.md)
+
+## URLTargetingSchema type
+
+URLTargetingSchema type.
+
+**Signature:**
+
+```typescript
+export type URLTargetingSchema = ClientFilterSchema<typeof ClientFilterName.urlTargeting, URLTargetingParams>;
+```
+**References:** [ClientFilterSchema](./foundation-filters.clientfilterschema.md)<!-- -->, [URLTargetingParams](./foundation-filters.urltargetingparams.md)
+
+## Remarks
+
+JSON schema type.
+

package/docs/api/foundation-filters.useragent.issafari.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [UserAgent](./foundation-filters.useragent.md) &gt; [isSafari](./foundation-filters.useragent.issafari.md)
+
+## UserAgent.isSafari property
+
+**Signature:**
+
+```typescript
+readonly isSafari: boolean;
+```
+
+## Remarks
+
+Is the user-agent safari.
+

package/docs/api/foundation-filters.useragent.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [UserAgent](./foundation-filters.useragent.md)
+
+## UserAgent interface
+
+UserAgent client filter DI interface.
+
+**Signature:**
+
+```typescript
+export interface UserAgent extends ClientFilter<UserAgentParams> 
+```
+**Extends:** [ClientFilter](./foundation-filters.clientfilter.md)<!-- -->&lt;[UserAgentParams](./foundation-filters.useragentparams.md)<!-- -->&gt;
+
+## Remarks
+
+Simplifies access to runtime data / state contained within the DI container.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isSafari](./foundation-filters.useragent.issafari.md) | <code>readonly</code> | boolean |  |
+

package/docs/api/foundation-filters.useragentfilter.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [userAgentFilter](./foundation-filters.useragentfilter.md)
+
+## userAgentFilter() function
+
+UserAgent client filter function.
+
+**Signature:**
+
+```typescript
+export declare function userAgentFilter(browsers?: string[], devices?: string[], oss?: string[], ua?: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  browsers | string\[\] | _(Optional)_ Browser names to target. |
+|  devices | string\[\] | _(Optional)_ Device types to target. |
+|  oss | string\[\] | _(Optional)_ Operating system names to target. |
+|  ua | string | _(Optional)_ User-agent string (required in nodejs environment). |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+See [https://github.com/faisalman/ua-parser-js](https://github.com/faisalman/ua-parser-js) for more information.
+

package/docs/api/foundation-filters.useragentparams.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [UserAgentParams](./foundation-filters.useragentparams.md)
+
+## UserAgentParams type
+
+UserAgentParams
+
+**Signature:**
+
+```typescript
+export type UserAgentParams = {
+    readonly browsers?: string[];
+    readonly devices?: string[];
+    readonly oss?: string[];
+    readonly ua?: string;
+};
+```
+
+## Example
+
+
+```json
+{
+   "browsers": ["Safari", "Firefox", "Chrome", "Chromium"],
+   "devices": ["mobile", "tablet"],
+   "oss": ["Mac OS", "Linux"]
+}
+```
+

package/docs/api/foundation-filters.useragentschema.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [UserAgentSchema](./foundation-filters.useragentschema.md)
+
+## UserAgentSchema type
+
+UserAgentSchema type.
+
+**Signature:**
+
+```typescript
+export type UserAgentSchema = ClientFilterSchema<typeof ClientFilterName.userAgent, UserAgentParams>;
+```
+**References:** [ClientFilterSchema](./foundation-filters.clientfilterschema.md)<!-- -->, [UserAgentParams](./foundation-filters.useragentparams.md)
+
+## Remarks
+
+JSON schema type.
+

package/docs/api/foundation-filters.usertargeting.hasadminprofile.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [UserTargeting](./foundation-filters.usertargeting.md) &gt; [hasAdminProfile](./foundation-filters.usertargeting.hasadminprofile.md)
+
+## UserTargeting.hasAdminProfile property
+
+**Signature:**
+
+```typescript
+readonly hasAdminProfile: boolean;
+```
+
+## Remarks
+
+Has the user got the 'ADMIN' profile assigned.
+

package/docs/api/foundation-filters.usertargeting.isloggedin.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [UserTargeting](./foundation-filters.usertargeting.md) &gt; [isLoggedIn](./foundation-filters.usertargeting.isloggedin.md)
+
+## UserTargeting.isLoggedIn property
+
+**Signature:**
+
+```typescript
+readonly isLoggedIn: boolean;
+```
+
+## Remarks
+
+Has the user logged in, regardless of their identity.
+

package/docs/api/foundation-filters.usertargeting.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [UserTargeting](./foundation-filters.usertargeting.md)
+
+## UserTargeting interface
+
+UserTargeting client filter DI interface.
+
+**Signature:**
+
+```typescript
+export interface UserTargeting extends ClientFilter<UserTargetingParams> 
+```
+**Extends:** [ClientFilter](./foundation-filters.clientfilter.md)<!-- -->&lt;[UserTargetingParams](./foundation-filters.usertargetingparams.md)<!-- -->&gt;
+
+## Remarks
+
+Simplifies access to runtime data / state contained within the DI container.
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [hasAdminProfile](./foundation-filters.usertargeting.hasadminprofile.md) | <code>readonly</code> | boolean |  |
+|  [isLoggedIn](./foundation-filters.usertargeting.isloggedin.md) | <code>readonly</code> | boolean |  |
+

package/docs/api/foundation-filters.usertargetingfilter.md

@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [userTargetingFilter](./foundation-filters.usertargetingfilter.md)
+
+## userTargetingFilter() function
+
+UserTargeting client filter function.
+
+**Signature:**
+
+```typescript
+export declare function userTargetingFilter(user: User, usernames?: string[], profiles?: string[], permissions?: string[]): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  user | User | A user object. |
+|  usernames | string\[\] | _(Optional)_ Usernames to target. |
+|  profiles | string\[\] | _(Optional)_ Profiles to target. |
+|  permissions | string\[\] | _(Optional)_ Permissions to target. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+This will return true when the current user matches on ANY of the parameters. If you wish to match on multiple parameters, consider chaining an array of userTargeting filters together.
+

package/docs/api/foundation-filters.usertargetingparams.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [UserTargetingParams](./foundation-filters.usertargetingparams.md)
+
+## UserTargetingParams type
+
+UserTargetingParams
+
+**Signature:**
+
+```typescript
+export type UserTargetingParams = {
+    readonly usernames?: string[];
+    readonly profiles?: string[];
+    readonly permissions?: string[];
+};
+```
+
+## Example
+
+
+```json
+{
+   "usernames": ["JohnDoe"],
+   "profiles": ["ADMIN", "READ_WRITE_DEALER"],
+   "permissions": ["ExportClientDashboard"]
+}
+```
+

package/docs/api/foundation-filters.usertargetingschema.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [UserTargetingSchema](./foundation-filters.usertargetingschema.md)
+
+## UserTargetingSchema type
+
+UserTargetingSchema type.
+
+**Signature:**
+
+```typescript
+export type UserTargetingSchema = ClientFilterSchema<typeof ClientFilterName.userTargeting, UserTargetingParams>;
+```
+**References:** [ClientFilterSchema](./foundation-filters.clientfilterschema.md)<!-- -->, [UserTargetingParams](./foundation-filters.usertargetingparams.md)
+
+## Remarks
+
+JSON schema type.
+

package/docs/api/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [@genesislcap/foundation-filters](./foundation-filters.md) |  |
+