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

package/docs/api-report.md

@@ -0,0 +1,283 @@
+## API Report File for "@genesislcap/foundation-filters"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { Auth } from '@genesislcap/foundation-comms';
+import { Container } from '@microsoft/fast-foundation';
+import { InterfaceSymbol } from '@microsoft/fast-foundation';
+import { Logger } from '@genesislcap/foundation-utils';
+import { User } from '@genesislcap/foundation-comms';
+
+// @public
+export interface ClientFilter<P = any> {
+    // (undocumented)
+    filter(parameters: P): boolean;
+}
+
+// @public (undocumented)
+export const ClientFilterName: {
+    readonly nodeEnv: "nodeEnv";
+    readonly percentage: "percentage";
+    readonly timeWindow: "timeWindow";
+    readonly urlTargeting: "urlTargeting";
+    readonly userAgent: "userAgent";
+    readonly userTargeting: "userTargeting";
+};
+
+// @public (undocumented)
+export type ClientFilterName = (typeof ClientFilterName)[keyof typeof ClientFilterName];
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "ClientFilterRunner" because one of its declarations is marked as @internal
+//
+// @public
+export interface ClientFilterRunner {
+    // (undocumented)
+    run(filters: ClientFilterSchemas[], container?: Container): boolean;
+}
+
+// @internal
+export const ClientFilterRunner: InterfaceSymbol<ClientFilterRunner>;
+
+// @public
+export type ClientFilterSchema<N extends ClientFilterName, P> = {
+    readonly name: N;
+    readonly parameters: P;
+};
+
+// @public
+export type ClientFilterSchemas = NodeEnvSchema | PercentageSchema | TimeWindowSchema | URLTargetingSchema | UserAgentSchema | UserTargetingSchema;
+
+// @public
+export class DefaultClientFilterRunner implements ClientFilterRunner {
+    // (undocumented)
+    container: Container;
+    // (undocumented)
+    run(filters: ClientFilterSchemas[], container?: Container): boolean;
+}
+
+// @public
+export class DefaultNodeEnv implements NodeEnv {
+    // (undocumented)
+    filter(params: NodeEnvParams): boolean;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NodeEnv" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
+    get isDevelopment(): boolean;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NodeEnv" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
+    get isProduction(): boolean;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "NodeEnv" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
+    get isTesting(): boolean;
+}
+
+// @public
+export class DefaultPercentage implements Percentage {
+    // (undocumented)
+    filter(params: PercentageParams): boolean;
+}
+
+// @public
+export class DefaultTimeWindow implements TimeWindow {
+    // (undocumented)
+    filter(params: TimeWindowParams): boolean;
+}
+
+// @public
+export class DefaultURLTargeting implements URLTargeting {
+    // (undocumented)
+    filter(params: URLTargetingParams): boolean;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "URLTargeting" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
+    isSecure(url: any): boolean;
+}
+
+// @public
+export class DefaultUserAgent implements UserAgent {
+    // (undocumented)
+    filter(params: UserAgentParams): boolean;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "UserAgent" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
+    get isSafari(): boolean;
+}
+
+// @public
+export class DefaultUserTargeting implements UserTargeting {
+    constructor(auth: Auth);
+    // (undocumented)
+    auth: Auth;
+    // (undocumented)
+    filter(params: UserTargetingParams): boolean;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "UserTargeting" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
+    get hasAdminProfile(): boolean;
+    // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "UserTargeting" has more than one declaration; you need to add a TSDoc member reference selector
+    //
+    // (undocumented)
+    get isLoggedIn(): boolean;
+}
+
+// @public
+export function getFilterByName(name: ClientFilterName, container: Container): NodeEnv | Percentage | TimeWindow | URLTargeting | UserAgent | UserTargeting;
+
+// @public
+export const logger: Logger;
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "NodeEnv" because one of its declarations is marked as @internal
+//
+// @public
+export interface NodeEnv extends ClientFilter<NodeEnvParams> {
+    // (undocumented)
+    readonly isDevelopment: boolean;
+    // (undocumented)
+    readonly isProduction: boolean;
+    // (undocumented)
+    readonly isTesting: boolean;
+}
+
+// @internal
+export const NodeEnv: InterfaceSymbol<NodeEnv>;
+
+// @public
+export function nodeEnvFilter(envs: string[]): boolean;
+
+// @public
+export type NodeEnvParams = {
+    readonly envs: string[];
+};
+
+// @public
+export type NodeEnvSchema = ClientFilterSchema<typeof ClientFilterName.nodeEnv, NodeEnvParams>;
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Percentage" because one of its declarations is marked as @internal
+//
+// @public
+export interface Percentage extends ClientFilter<PercentageParams> {
+}
+
+// @internal
+export const Percentage: InterfaceSymbol<Percentage>;
+
+// @public
+export function percentageFilter(percent: number, random?: number): boolean;
+
+// @public
+export type PercentageParams = {
+    readonly percent: number;
+    readonly random?: number;
+};
+
+// @public
+export type PercentageSchema = ClientFilterSchema<typeof ClientFilterName.percentage, PercentageParams>;
+
+// @public
+export function runner(filters: ClientFilterSchemas[], container: Container): boolean;
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "TimeWindow" because one of its declarations is marked as @internal
+//
+// @public
+export interface TimeWindow extends ClientFilter<TimeWindowParams> {
+}
+
+// @internal
+export const TimeWindow: InterfaceSymbol<TimeWindow>;
+
+// @public
+export function timeWindowFilter(start?: string, end?: string): boolean;
+
+// @public
+export type TimeWindowParams = {
+    readonly start?: string;
+    readonly end?: string;
+};
+
+// @public
+export type TimeWindowSchema = ClientFilterSchema<typeof ClientFilterName.timeWindow, TimeWindowParams>;
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "URLTargeting" because one of its declarations is marked as @internal
+//
+// @public
+export interface URLTargeting extends ClientFilter<URLTargetingParams> {
+    // (undocumented)
+    isSecure(url: string): boolean;
+}
+
+// @internal
+export const URLTargeting: InterfaceSymbol<URLTargeting>;
+
+// @public
+export function urlTargetingFilter(url: string, pattern?: RegExp, schemes?: string[], hosts?: string[], paths?: string[]): boolean;
+
+// @public
+export type URLTargetingParams = {
+    readonly url?: string;
+    readonly pattern?: RegExp;
+    readonly schemes?: string[];
+    readonly hosts?: string[];
+    readonly paths?: string[];
+};
+
+// @public
+export type URLTargetingSchema = ClientFilterSchema<typeof ClientFilterName.urlTargeting, URLTargetingParams>;
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "UserAgent" because one of its declarations is marked as @internal
+//
+// @public
+export interface UserAgent extends ClientFilter<UserAgentParams> {
+    // (undocumented)
+    readonly isSafari: boolean;
+}
+
+// @internal
+export const UserAgent: InterfaceSymbol<UserAgent>;
+
+// @public
+export function userAgentFilter(browsers?: string[], devices?: string[], oss?: string[], ua?: string): boolean;
+
+// @public
+export type UserAgentParams = {
+    readonly browsers?: string[];
+    readonly devices?: string[];
+    readonly oss?: string[];
+    readonly ua?: string;
+};
+
+// @public
+export type UserAgentSchema = ClientFilterSchema<typeof ClientFilterName.userAgent, UserAgentParams>;
+
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "UserTargeting" because one of its declarations is marked as @internal
+//
+// @public
+export interface UserTargeting extends ClientFilter<UserTargetingParams> {
+    // (undocumented)
+    readonly hasAdminProfile: boolean;
+    // (undocumented)
+    readonly isLoggedIn: boolean;
+}
+
+// @internal
+export const UserTargeting: InterfaceSymbol<UserTargeting>;
+
+// @public
+export function userTargetingFilter(user: User, usernames?: string[], profiles?: string[], permissions?: string[]): boolean;
+
+// @public
+export type UserTargetingParams = {
+    readonly usernames?: string[];
+    readonly profiles?: string[];
+    readonly permissions?: string[];
+};
+
+// @public
+export type UserTargetingSchema = ClientFilterSchema<typeof ClientFilterName.userTargeting, UserTargetingParams>;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/jsdom.setup.ts

@@ -0,0 +1 @@
+export * from '@genesislcap/foundation-testing/jsdom';

package/license.txt

@@ -0,0 +1,46 @@
+Developer License Agreement
+
+This Developer License Agreement (the “Agreement”) is entered into by and between Genesis, Global FinTech Inc.(“Genesis”) and you and/or the entity on whose behalf you are downloading the Software (as defined below) (“you”). This Agreement forms a legally binding contract between you and Genesis in relation to your use of the software libraries, reference implementations, and other related demonstration code (collectively, the “Genesis Software”). [a]
+
+To use the Software, you must first agree to this Agreement. You may not use the Software if you do not agree to be bound by the terms of this Agreement. Accordingly, you and Genesis acknowledge and agree as follows:
+
+1. LIMITED LICENSE.
+Subject to your complete and ongoing compliance with all the terms and conditions set forth in this Agreement, including without limitation all license limitations and restrictions set forth herein, Genesis grants you the following limited, non-exclusive, non-transferable, non-sublicensable, revocable licenses to use, and (where applicable) authorize your employees to use, the Software internally solely in connection with building, developing and testing your own applications that interoperate with or incorporate the Software (“Applications”) for the purposes of evaluation.
+
+2. RESTRICTIONS.
+A. By accessing or using the Software, you represent, warrant, and covenant that (a) you are a person or business entity engaged in the development of software applications, and (b) in the case of a business entity, you have the full power and authority to bind such entity to the terms of this Agreement.
+B. You acknowledge that the foregoing license does not include any right to:
+(i) redistribute, sell, lease, license, modify or otherwise create any derivative works of any portion of the Software, or;
+(ii) distribute, deploy, or otherwise utilize Applications on a public, production, commercial, or other similar purpose other than internal use for evaluation and the development of non-public, experimental Applications (any other public, production, commercial, or similar use requires a separate agreement with Genesis), or
+(iii) use or implement any undocumented feature or API or use any documented feature or API other than in accordance with applicable documentation. You agree to not to do any of the foregoing.
+C. Except as expressly provided herein, you may not:
+(a) reproduce, distribute, publicly display, or publicly perform any part of the Software;
+(b) decompile, reverse engineer, or otherwise access or attempt to access the source code for the Software not made available to you in source code form;
+(c) make or attempt to make any modification to, or otherwise create derivative works of the Software; or
+(d) remove, obscure, interfere with or circumvent any feature of the Software, including without limitation any copyright or other intellectual property notices, security, or access control mechanism;
+(f) use the Software to do anything illegal, including facilitating, promoting, or otherwise encouraging any illegal activities.
+
+3. RESERVATION OF RIGHTS.
+A. The Software is owned by Genesis and licensed, not sold, to you. The Software, content, visual interfaces, interactive features, information, graphics, design, compilation, computer code, products, services, and all other elements of the Software and related documentation (the “Materials“), are protected by copyright, trade dress, patent, and trademark laws of the United States and other jurisdictions, international conventions, and all other relevant intellectual property and proprietary rights, and applicable laws (collectively, the “Intellectual Property Rights“).
+B. You agree that Genesis or its subsidiaries or affiliated companies and/or its third-party licensors own all legal right, title and interest in and to the Software and Materials, including any and all Intellectual Property Rights. Genesis reserves all rights not expressly granted in this Agreement. You do not acquire any right, interest or title to the Materials, whether by implication, estoppel, or otherwise, except for the limited rights set forth in this Agreement.
+C. You agree that the form and nature of the Software that Genesis provides may change without prior notice to you and that future versions of the Software may be incompatible with applications developed on previous of the Software. You agree that Genesis may stop (permanently or temporarily) providing the Software (or any features within the Software) to you or to users generally at Genesis’s sole discretion, without prior notice to you. Nothing in this Agreement gives you a right to use any of Genesis’s trade names, trademarks, service marks, logos, domain names, or other distinctive brand features.
+
+4. TERMINATION.
+At Genesis’s sole discretion, Genesis may terminate your Developer License and cease provision of the Genesis Software with or without notice, effective immediately, for any reason or no reason at all. Upon the expiration or termination of this Agreement all rights and licenses granted under this Agreement will immediately terminate.
+
+5. THIRD PARTY SOFTWARE.
+The Software consists of a package of components and may include references to certain third-party software (“Third Party Software”) that are provided by their authors under separate license terms (the “Third Party Terms”). Your use of any such Third-Party Software in conjunction with the Software in a manner consistent with this Agreement is permitted, however, you may have broader rights and/or restrictions under the applicable Third-Party Terms. Genesis cannot accept any responsibility for the Third-Party Software or your use thereof.
+
+6. DISCLAIMER OF WARRANTIES.
+YOU EXPRESSLY UNDERSTAND AND AGREE THAT YOUR USE OF THE SOFTWARE IS AT YOUR SOLE RISK AND THAT THE SOFTWARE IS PROVIDED “AS IS” AND “AS AVAILABLE” WITHOUT WARRANTY OF ANY KIND FROM GENESIS. YOUR USE OF THE SOFTWARE AND ANY MATERIAL DOWNLOADED OR OTHERWISE OBTAINED THROUGH THE USE OF THE SOFTWARE IS AT YOUR OWN DISCRETION AND RISK AND YOU ARE SOLELY RESPONSIBLE FOR ANY DAMAGE TO YOUR COMPUTER SYSTEM OR OTHER DEVICE OR LOSS OF DATA THAT RESULTS FROM SUCH USE. GENESIS FURTHER EXPRESSLY DISCLAIMS ALL WARRANTIES AND CONDITIONS OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO THE IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. GENESIS EXPRESSLY DISCLAIMS ANY WARRANTIES OF ANY KIND WITH RESPECT TO THE ACCURACY OR FUNCTIONALITY OF THE SOFTWARE, AND WITH RESPECT TO THE ACCURACY, VALIDITY, OR COMPLETENESS OF ANY INFORMATION OR FEATURES AVAILABLE THROUGH THE SOFTWARE, OR THE QUALITY OR CONSISTENCY OF THE SOFTWARE OR RESULTS OBTAINED THROUGH ITS USE.
+
+7. INDEMNIFICATION. To the maximum extent permitted by law, you agree to defend, indemnify, and hold harmless Genesis, its affiliates, and their respective directors, officers, employees, and agents, from and against any and all third-party claims, actions, suits, or proceedings, as well as any and all losses, liabilities, damages, costs, and expenses (including reasonable attorneys’ fees) arising out of or accruing from (a) your breach of this Developer License; (b) your use or misuse of the Genesis Software; (c) your negligence or willful misconduct; and/or (d) your use of the Genesis Software that actually or allegedly infringes any Intellectual Property Rights or privacy rights of any third party in any jurisdiction.
+
+8. MISCELLANEOUS.
+(a) If you are agreeing to be bound by this Agreement on behalf of your employer or other entity, you represent and warrant that you have full legal authority to bind your employer or such entity to this Agreement. If you do not have the requisite authority, you may not accept this Agreement on behalf of your employer or other entity.
+(b) This Developer License shall be governed by, and construed in accordance with, the laws of the State of New York without regard to conflict of law principles. For all purposes of this Developer License, the parties’ consent to exclusive jurisdiction and venue in the state and federal courts located in New York County, New York.
+(c) Nothing in this Agreement, or in the nature of your access and use of the Genesis Software, shall create or is intended to create a joint-venture, partnership, or agency relationship between you and Genesis.
+(d) You may not assign or transfer this Agreement or any of your rights or obligations hereunder, absent the prior written consent of Genesis.
+(e) You agree that if Genesis does not exercise or enforce any legal right or remedy contained in this Agreement, this will not be taken to be a formal waiver of Genesis’s rights and that those rights or remedies will still be available to Genesis.
+(f) This Agreement constitutes the complete understanding between you and Genesis with respect to the subject matter contained herein, and supersedes all prior written or oral communications, understandings, and agreements.
+(g) If any provision of this Agreement is deemed to be illegal, invalid, or unenforceable, then that provision shall be removed, and the remaining terms will continue to be valid and enforceable.

package/package.json

@@ -0,0 +1,122 @@
+{
+  "name": "@genesislcap/foundation-filters",
+  "description": "Genesis Foundation Filters",
+  "version": "9.0.1-alpha-b5c5eb7.0",
+  "sideEffects": false,
+  "license": "SEE LICENSE IN license.txt",
+  "main": "dist/esm/index.js",
+  "types": "dist/dts/index.d.ts",
+  "unpkg": "dist/foundation-filters.min.js",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/dts/index.d.ts",
+      "default": "./dist/esm/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "config": {
+    "PORT": 3090
+  },
+  "scripts": {
+    "api:extract": "api-extractor run --local",
+    "api:document": "api-documenter markdown -i dist -o docs/api",
+    "build": "npm run build:tsc && npm run build:rollup && npm run build:webpack && npm run api:extract && npm run api:document",
+    "build:rollup": "rollup -c",
+    "build:rollup:stats": "cross-env ANALYZE=1 npm run build:rollup",
+    "build:tsc": "tsc -b ./tsconfig.build.json",
+    "build:webpack": "cross-env NODE_ENV=production webpack",
+    "build:webpack:stats": "cross-env ANALYZE=1 npm run build:webpack",
+    "clean": "npm run clean:dist",
+    "clean:dist": "node ../../../build/clean dist tsconfig.build.tsbuildinfo .rollup.cache",
+    "dev": "npm run dev:tsc",
+    "dev:rollup": "rollup -c -w --configDev",
+    "dev:tsc": "tsc -b ./tsconfig.build.json -w",
+    "dev:webpack": "cross-env NODE_ENV=development webpack serve",
+    "prepare": "npm run clean && npm run build",
+    "prepublishOnly": "npm run prepare",
+    "serve": "serve dist -p $npm_package_config_PORT",
+    "test": "npm run test:unit",
+    "test:coverage": "c8 --include=src npm run test:unit",
+    "test:coverage:report": "npm run test:coverage && c8 report --reporter=text-lcov > coverage.lcov",
+    "test:coverage:report:nyc": "npm run test:unit:browser -- --cov && npx nyc report --reporter=html",
+    "test:unit": "npm run test:unit:node",
+    "test:unit:browser": "playwright-test \"./**/*.test.ts\" --runner uvu",
+    "test:unit:browser:watch": "npm run test:unit:browser -- -w -d",
+    "test:unit:node": "npm run test:unit:node:src",
+    "test:unit:node:src": "uvu -r tsm -r esm -r ./jsdom.setup.ts ./src \".*.test.ts\"",
+    "test:unit:watch": "watchlist src test -- npm run test:unit"
+  },
+  "devDependencies": {
+    "@genesislcap/foundation-testing": "9.0.1-alpha-b5c5eb7.0",
+    "@microsoft/api-documenter": "^7.19.13",
+    "@microsoft/api-extractor": "^7.31.1",
+    "@module-federation/dashboard-plugin": "2.3.0",
+    "@playwright/test": "^1.18.1",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "@rollup/plugin-typescript": "^8.3.0",
+    "@types/mocha": "^9.1.0",
+    "@types/ua-parser-js": "^0.7.36",
+    "analytics": "^0.8.0",
+    "c8": "^7.11.0",
+    "camel-case": "^4.1.2",
+    "clean-webpack-plugin": "^4.0.0",
+    "copyfiles": "^2.4.1",
+    "cross-env": "^7.0.3",
+    "csp-html-webpack-plugin": "^5.1.0",
+    "css-loader": "^6.6.0",
+    "cssnano": "^5.0.17",
+    "esm": "^3.2.25",
+    "file-loader": "^6.2.0",
+    "html-webpack-plugin": "^5.3.1",
+    "jsdom": "^19.0.0",
+    "mini-css-extract-plugin": "^2.5.3",
+    "playwright-test": "^7.2.1",
+    "portfinder-sync": "^0.0.2",
+    "postcss": "^8.2.8",
+    "postcss-import": "^14.0.0",
+    "postcss-loader": "^6.2.1",
+    "postcss-preset-env": "^7.0.1",
+    "rollup": "^2.7.6",
+    "rollup-plugin-commonjs": "^10.1.0",
+    "rollup-plugin-filesize": "^9.1.2",
+    "rollup-plugin-node-resolve": "^5.2.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-transform-tagged-template": "^0.0.3",
+    "rollup-plugin-visualizer": "^5.6.0",
+    "serve": "^14.1.2",
+    "terser-webpack-plugin": "^5.3.1",
+    "to-string-loader": "^1.2.0",
+    "ts-loader": "9.3.1",
+    "tsconfig-paths-webpack-plugin": "^3.5.1",
+    "tsm": "^2.2.1",
+    "typescript": "^4.5.5",
+    "uvu": "0.5.4",
+    "watchlist": "^0.3.1",
+    "webpack": "^5.45.1",
+    "webpack-bundle-analyzer": "^4.5.0",
+    "webpack-cli": "^4.5.0",
+    "webpack-dev-server": "^4.0.0-beta.3",
+    "webpack-merge": "^5.7.3"
+  },
+  "dependencies": {
+    "@genesislcap/foundation-comms": "9.0.1-alpha-b5c5eb7.0",
+    "@genesislcap/foundation-utils": "9.0.1-alpha-b5c5eb7.0",
+    "@microsoft/fast-element": "^1.7.0",
+    "@microsoft/fast-foundation": "^2.33.2",
+    "tslib": "^2.3.1",
+    "ua-parser-js": "^1.0.32"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/genesislcap/foundation-ui.git",
+    "directory": "packages/foundation/foundation-filters"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "d5066d32a263aaef9221c570914e1ce7b90526ef"
+}