@genesislcap/foundation-filters 14.408.0 → 14.409.0

package/README.md

@@ -1,184 +1,25 @@
-# Genesis Foundation Filters
+# @genesislcap/foundation-filters
 
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
-[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
+Documentation for this package is published on the Genesis docs site:
 
-`foundation-filters` provides a collection of client-side filters, including:
-
-* [nodeEnv](./docs/api/foundation-filters.nodeenvfilter.md)
-* [percentage](./docs/api/foundation-filters.percentagefilter.md)
-* [timeWindow](./docs/api/foundation-filters.timewindowfilter.md)
-* [urlTargeting](./docs/api/foundation-filters.urltargetingfilter.md)
-* [userAgent](./docs/api/foundation-filters.useragentfilter.md)
-* [userTargeting](./docs/api/foundation-filters.usertargetingfilter.md)
-
-These can be run in isolation or as part of a chain using the [runner](./docs/api/foundation-filters.runner.md) function.
-
-Client-side filters generally take primitive input parameters, and return `true` or `false` based on these values. They may also access runtime data or state to provide an outcome. They can be used for simple tasks like array or input filtering, or for more advanced use cases - such as driving feature flags, behaviors, directives, etc.
-
-Filters can be chained using the utilities provided in this package to handle more complex scenarios. When a filter is used without all the input parameters needed, Genesis logs a warning and returns `true` by convention so that the chain can continue. This is currently controlled at an individual filter level, and may change in time.
-
-:::important
-It's important to highlight that filters are purposefully decoupled from any `effect`, like pairing with a `when()` directive or custom-effect logic. This flexibility allows these filters to be reused for numerous purposes.
-:::
-
-## Usage
-
-Each filter is provided in two flavours:
-
-1. *Function*
-
-```ts
-import { timeWindowFilter } from '@genesislcap/foundation-filters';
-...
-const outcome = timeWindowFilter('Sun Sep 25 2022 16:51:55 GMT+0000', 'Fri Nov 25 2022 17:51:55 GMT+0000');
-```
-
-2. *DI Injected*
-
-```ts
-import { TimeWindow } from '@genesislcap/foundation-filters';
-...
-@TimeWindow timeWindow: TimeWindow;
-...
-const outcome = this.timeWindow.filter({
-  start: 'Sun Sep 25 2022 16:51:55 GMT+0000',
-  end: 'Fri Nov 25 2022 17:51:55 GMT+0000',
-});
-```
-
-The function version is pretty self-explanatory, and you may be wondering why you would use the DI injected version. The
-reason is at the point of calling a filter, either directly or indirectly as (say) part of a chain, you may not know what
-data or state from the application it needs to provide its outcome. The DI versions encapsulate this complexity, which aids later refactoring, and leaves callers free to pass only primitive input parameters where possible.
-
-### DI use cases
-
-```ts
-import { UserTargeting } from '@genesislcap/foundation-filters';
-...
-@UserTargeting userTargeting: UserTargeting;
-...
-const outcome = this.userTargeting.filter({
-  profiles: ['ADMIN']
-});
-```
-
-Here we've used the `UserTargeting` filter without the need to provide the current user or other data points to the underlying function directly. If we source the current user from changes over time, the author of the filter can refactor centrally.
-
-All DI-based filters implement the [ClientFilter](./docs/api/foundation-filters.clientfilter.md) interface; however, they may provide other APIs for convenience to abstract underlying implementation details. For example, `UserTargeting` provides a `hasAdminProfile` API, so the previous example can be re-written as:
-
-```ts
-import { UserTargeting } from '@genesislcap/foundation-filters';
-...
-@UserTargeting userTargeting: UserTargeting;
-...
-const outcome = this.userTargeting.hasAdminProfile();
-```
-
-This is quite a simplistic example, but we hope it helps to highlight that common parameters can be predefined in the
-filters themselves where needed. It is also worth mentioning that DI-based filters are registered as transient, meaning
-you will get a new instance for every dependency request or container.get(). The ClientFilterRunner used to run chained
-filters is also transient.
-
-### Client Filter Runner
-
-A [ClientFilterRunner](./docs/api/foundation-filters.clientfilterrunner.md) will return true when all the filters in the array pass.
-
-```ts
-import { ClientFilterRunner } from '@genesislcap/foundation-filters';
-...
-@customElement({
-  name: 'runner-example',
-  template: html`
-    <template>
-      ${when(
-        (x) => x.seasonsGreetings,
-        html`
-          <happy-christmas-chome-users></happy-christmas-chome-users>
-        `
-      )}
-      ${when(
-        (x) => x.santasShift,
-        html`
-          <working-hard-or-hardly-working>Santa!</working-hard-or-hardly-working>
-        `
-      )}
-    </template>
-  `,
-})
-class RunnerExample extends FASTElement {
-  @ClientFilterRunner runner: ClientFilterRunner;
-  /**
-   * This getter will remain reactive to any observable state each filter may use. Filters can be defined with strong
-   * typings as shown, or they can be simply loaded in from json files etc. Here we've defined the chain in the element,
-   * but you could inject a ClientFilterRunner into a store fragment to centralise and share such logic. Here we're
-   * targeting non-admin users on chrome between Christmas and New Year.
-   */
-  get seasonsGreetings() {
-    return this.runner.run([
-      {
-        name: 'userTargeting',
-        parameters: {
-          profiles: ['USER'],
-        },
-      },
-      {
-        name: 'userAgent',
-        parameters: {
-          browsers: ['Chrome']
-        },
-      },
-      {
-        name: 'timeWindow',
-        parameters: {
-          start: '2022-12-25',
-          end: '2022-12-31',
-        },
-      }]);
-  }
-
-  get santasShift() {
-    return this.runner.run([
-      {
-        name: 'userTargeting',
-        parameters: {
-          username: ['santa'],
-        },
-      },
-      {
-        name: 'timeWindow',
-        parameters: {
-          start: '2022-12-24',
-          end: '2022-12-25',
-        },
-      }]);
-  }
-}
-```
+**Docs: [Filters](https://docs.genesis.global/docs/develop/client-capabilities/filters/)**
 
 ## Installation
 
-To enable this module in your application, follow the steps below.
-
-1. Add `@genesislcap/foundation-filters` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
 ```json
 {
-  ...
   "dependencies": {
-    ...
     "@genesislcap/foundation-filters": "latest"
-    ...
-  },
-  ...
+  }
 }
 ```
 
-## [API Docs](./docs/api/index.md)
-
 ## License
 
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
+
 Genesis low-code platform

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-filters",
   "description": "Genesis Foundation Filters",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -50,19 +50,19 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0",
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0",
     "@types/ua-parser-js": "^0.7.36"
   },
   "dependencies": {
-    "@genesislcap/foundation-comms": "14.408.0",
-    "@genesislcap/foundation-logger": "14.408.0",
-    "@genesislcap/foundation-user": "14.408.0",
+    "@genesislcap/foundation-comms": "14.409.0",
+    "@genesislcap/foundation-logger": "14.409.0",
+    "@genesislcap/foundation-user": "14.409.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.50.0",
     "ua-parser-js": "^1.0.32"
@@ -75,5 +75,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/foundation-filters.clientfilter.filter.md

@@ -1,54 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [ClientFilter](./foundation-filters.clientfilter.md) &gt; [filter](./foundation-filters.clientfilter.filter.md)
-
-## ClientFilter.filter() method
-
-**Signature:**
-
-```typescript
-filter(parameters: P): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-parameters
-
-
-</td><td>
-
-P
-
-
-</td><td>
-
-The filter parameters.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-
-The filter outcome.
-

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

@@ -1,42 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [ClientFilter](./foundation-filters.clientfilter.md)
-
-## ClientFilter interface
-
-ClientFilter interface.
-
-**Signature:**
-
-```typescript
-export interface ClientFilter<P = any> 
-```
-
-## Remarks
-
-Simplifies access to runtime data / state contained within the DI container.
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[filter(parameters)](./foundation-filters.clientfilter.filter.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [ClientFilterName](./foundation-filters.clientfiltername.md)
-
-## ClientFilterName variable
-
-
-**Signature:**
-
-```typescript
-ClientFilterName: {
-    readonly nodeEnv: "nodeEnv";
-    readonly percentage: "percentage";
-    readonly timeWindow: "timeWindow";
-    readonly urlTargeting: "urlTargeting";
-    readonly userAgent: "userAgent";
-    readonly userTargeting: "userTargeting";
-}
-```

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

@@ -1,38 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [ClientFilterRunner](./foundation-filters.clientfilterrunner.md)
-
-## ClientFilterRunner interface
-
-ClientFilterRunner DI interface.
-
-**Signature:**
-
-```typescript
-export interface ClientFilterRunner 
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[run(filters, container)](./foundation-filters.clientfilterrunner.run.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-filters.clientfilterrunner.run.md

@@ -1,66 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [ClientFilterRunner](./foundation-filters.clientfilterrunner.md) &gt; [run](./foundation-filters.clientfilterrunner.run.md)
-
-## ClientFilterRunner.run() method
-
-**Signature:**
-
-```typescript
-run(filters: ClientFilterSchemas[], container?: Container): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-filters
-
-
-</td><td>
-
-[ClientFilterSchemas](./foundation-filters.clientfilterschemas.md)<!-- -->\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-container
-
-
-</td><td>
-
-Container
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-

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

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [ClientFilterSchema](./foundation-filters.clientfilterschema.md)
-
-## ClientFilterSchema type
-
-ClientFilterSchema type.
-
-**Signature:**
-
-```typescript
-export type ClientFilterSchema<N extends ClientFilterName, P> = {
-    readonly name: N;
-    readonly parameters: P;
-};
-```
-**References:** [ClientFilterName](./foundation-filters.clientfiltername.md)
-
-## Remarks
-
-JSON schema type.
-

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

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [ClientFilterSchemas](./foundation-filters.clientfilterschemas.md)
-
-## ClientFilterSchemas type
-
-ClientFilterSchemas type.
-
-**Signature:**
-
-```typescript
-export type ClientFilterSchemas = NodeEnvSchema | PercentageSchema | TimeWindowSchema | URLTargetingSchema | UserAgentSchema | UserTargetingSchema;
-```
-**References:** [NodeEnvSchema](./foundation-filters.nodeenvschema.md)<!-- -->, [PercentageSchema](./foundation-filters.percentageschema.md)<!-- -->, [TimeWindowSchema](./foundation-filters.timewindowschema.md)<!-- -->, [URLTargetingSchema](./foundation-filters.urltargetingschema.md)<!-- -->, [UserAgentSchema](./foundation-filters.useragentschema.md)<!-- -->, [UserTargetingSchema](./foundation-filters.usertargetingschema.md)
-

package/docs/api/foundation-filters.defaultclientfilterrunner.container.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultClientFilterRunner](./foundation-filters.defaultclientfilterrunner.md) &gt; [container](./foundation-filters.defaultclientfilterrunner.container.md)
-
-## DefaultClientFilterRunner.container property
-
-**Signature:**
-
-```typescript
-container: Container;
-```

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

@@ -1,89 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultClientFilterRunner](./foundation-filters.defaultclientfilterrunner.md)
-
-## DefaultClientFilterRunner class
-
-Default ClientFilterRunner DI implementation.
-
-**Signature:**
-
-```typescript
-export declare class DefaultClientFilterRunner implements ClientFilterRunner 
-```
-**Implements:** [ClientFilterRunner](./foundation-filters.clientfilterrunner.md)
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[container](./foundation-filters.defaultclientfilterrunner.container.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Container
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[run(filters, container)](./foundation-filters.defaultclientfilterrunner.run.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-filters.defaultclientfilterrunner.run.md

@@ -1,66 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultClientFilterRunner](./foundation-filters.defaultclientfilterrunner.md) &gt; [run](./foundation-filters.defaultclientfilterrunner.run.md)
-
-## DefaultClientFilterRunner.run() method
-
-**Signature:**
-
-```typescript
-run(filters: ClientFilterSchemas[], container?: Container): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-filters
-
-
-</td><td>
-
-[ClientFilterSchemas](./foundation-filters.clientfilterschemas.md)<!-- -->\[\]
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-container
-
-
-</td><td>
-
-Container
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-