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

package/dist/755.c71c3a1801dd2c0461f8b831d09ec90f.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["webpack://@genesislcap/foundation-filters/./src/index.federated.ts"],"names":[],"mappings":"wIAAA,6D","file":"755.755.xxxxxxxxxxxxxxxxxxxx.js","sourcesContent":["import('./index');\n"],"sourceRoot":""}

package/dist/dashboard.json

@@ -0,0 +1 @@
+{"dependencies":[{"name":"@microsoft/fast-element","version":"1.11"},{"name":"@microsoft/fast-foundation","version":"2.47"},{"name":"tslib","version":"2.5"},{"name":"ua-parser-js","version":"1.0"}],"devDependencies":[{"name":"@microsoft/api-documenter","version":"7.21"},{"name":"@microsoft/api-extractor","version":"7.34"},{"name":"@module-federation/dashboard-plugin","version":"2.3"},{"name":"@playwright/test","version":"1.31"},{"name":"@rollup/plugin-commonjs","version":"21.1"},{"name":"@rollup/plugin-node-resolve","version":"13.3"},{"name":"@rollup/plugin-typescript","version":"8.5"},{"name":"analytics","version":"0.8"},{"name":"c8","version":"7.13"},{"name":"camel-case","version":"4.1"},{"name":"clean-webpack-plugin","version":"4.0"},{"name":"copyfiles","version":"2.4"},{"name":"cross-env","version":"7.0"},{"name":"csp-html-webpack-plugin","version":"5.1"},{"name":"css-loader","version":"6.7"},{"name":"cssnano","version":"5.1"},{"name":"esm","version":"3.2"},{"name":"file-loader","version":"6.2"},{"name":"html-webpack-plugin","version":"5.5"},{"name":"jsdom","version":"19.0"},{"name":"mini-css-extract-plugin","version":"2.7"},{"name":"playwright-test","version":"7.4"},{"name":"portfinder-sync","version":"0.0"},{"name":"postcss","version":"8.4"},{"name":"postcss-import","version":"14.1"},{"name":"postcss-loader","version":"6.2"},{"name":"postcss-preset-env","version":"7.8"},{"name":"rollup","version":"2.79"},{"name":"rollup-plugin-commonjs","version":"10.1"},{"name":"rollup-plugin-filesize","version":"9.1"},{"name":"rollup-plugin-node-resolve","version":"5.2"},{"name":"rollup-plugin-terser","version":"7.0"},{"name":"rollup-plugin-visualizer","version":"5.9"},{"name":"terser-webpack-plugin","version":"5.3"},{"name":"to-string-loader","version":"1.2"},{"name":"ts-loader","version":"9.3"},{"name":"tsconfig-paths-webpack-plugin","version":"3.5"},{"name":"tsm","version":"2.3"},{"name":"typescript","version":"4.9"},{"name":"uvu","version":"0.5"},{"name":"watchlist","version":"0.3"},{"name":"webpack","version":"5.45"},{"name":"webpack-bundle-analyzer","version":"4.8"},{"name":"webpack-cli","version":"4.10"},{"name":"webpack-dev-server","version":"4.11"},{"name":"webpack-merge","version":"5.8"}],"optionalDependencies":[],"id":"foundationFilters","name":"foundationFilters","remote":"","metadata":{},"overrides":[{"id":"tslib","name":"tslib","version":"2.5","location":"tslib","applicationID":"foundationFilters"},{"id":"@microsoft/fast-foundation","name":"@microsoft/fast-foundation","version":"2.47","location":"@microsoft/fast-foundation","applicationID":"foundationFilters"},{"id":"@genesislcap/foundation-utils","name":"@genesislcap/foundation-utils","version":"","location":"@genesislcap/foundation-utils","applicationID":"foundationFilters"},{"id":"ua-parser-js","name":"ua-parser-js","version":"1.0","location":"ua-parser-js","applicationID":"foundationFilters"},{"id":"@genesislcap/foundation-comms","name":"@genesislcap/foundation-comms","version":"","location":"@genesislcap/foundation-comms","applicationID":"foundationFilters"},{"id":"@microsoft/fast-element","name":"@microsoft/fast-element","version":"1.11","location":"@microsoft/fast-element","applicationID":"foundationFilters"}],"consumes":[],"modules":[{"id":"foundationFilters:index","name":"index","applicationID":"foundationFilters","requires":[],"file":"./src/index.federated.ts"}],"version":"1.0.0"}

package/dist/dts/clientFilter.d.ts

@@ -0,0 +1,108 @@
+import { Container } from '@microsoft/fast-foundation';
+import { NodeEnv, NodeEnvSchema } from './nodeEnv';
+import { Percentage, PercentageSchema } from './percentage';
+import { TimeWindow, TimeWindowSchema } from './timeWindow';
+import { URLTargeting, URLTargetingSchema } from './urlTargeting';
+import { UserAgent, UserAgentSchema } from './userAgent';
+import { UserTargeting, UserTargetingSchema } from './userTargeting';
+/**
+ * @public
+ */
+export declare const ClientFilterName: {
+    readonly nodeEnv: "nodeEnv";
+    readonly percentage: "percentage";
+    readonly timeWindow: "timeWindow";
+    readonly urlTargeting: "urlTargeting";
+    readonly userAgent: "userAgent";
+    readonly userTargeting: "userTargeting";
+};
+/**
+ * @public
+ */
+export type ClientFilterName = (typeof ClientFilterName)[keyof typeof ClientFilterName];
+/**
+ * Filer lookup by name.
+ *
+ * @public
+ */
+export declare function getFilterByName(name: ClientFilterName, container: Container): NodeEnv | Percentage | TimeWindow | URLTargeting | UserAgent | UserTargeting;
+/**
+ * ClientFilter interface.
+ *
+ * @remarks
+ * Simplifies access to runtime data / state contained within the DI container.
+ *
+ * @typeParam P - The filter parameter type.
+ *
+ * @public
+ */
+export interface ClientFilter<P = any> {
+    /**
+     * @param parameters - The filter parameters.
+     *
+     * @returns The filter outcome.
+     *
+     * @privateRemarks
+     * Not sure if there's a need for an async api here.
+     */
+    filter(parameters: P): boolean;
+}
+/**
+ * ClientFilterSchema type.
+ *
+ * @remarks
+ * JSON schema type.
+ *
+ * @typeParam N - The filter name type.
+ * @typeParam P - The filter parameters type.
+ *
+ * @public
+ */
+export type ClientFilterSchema<N extends ClientFilterName, P> = {
+    readonly name: N;
+    readonly parameters: P;
+};
+/**
+ * ClientFilterSchemas type.
+ *
+ * @public
+ */
+export type ClientFilterSchemas = NodeEnvSchema | PercentageSchema | TimeWindowSchema | URLTargetingSchema | UserAgentSchema | UserTargetingSchema;
+/**
+ * Client filter runner function.
+ * @remarks
+ * This will return true when all the filters in the array pass.
+ * @param filters - An array of client filters to run.
+ * @param container - The DI container.
+ * @public
+ * @privateRemarks
+ * As a runner working off static input, we can't know or source the runtime dependencies of each filter. As such we use
+ * the DI version of each which have those encapsulated.
+ */
+export declare function runner(filters: ClientFilterSchemas[], container: Container): boolean;
+/**
+ * ClientFilterRunner DI interface.
+ *
+ * @public
+ */
+export interface ClientFilterRunner {
+    run(filters: ClientFilterSchemas[], container?: Container): boolean;
+}
+/**
+ * Default ClientFilterRunner DI implementation.
+ * @public
+ */
+export declare class DefaultClientFilterRunner implements ClientFilterRunner {
+    container: Container;
+    run(filters: ClientFilterSchemas[], container?: Container): boolean;
+}
+/**
+ * ClientFilterRunner DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export declare const ClientFilterRunner: import("@microsoft/fast-foundation").InterfaceSymbol<ClientFilterRunner>;
+//# sourceMappingURL=clientFilter.d.ts.map

package/dist/dts/clientFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientFilter.d.ts","sourceRoot":"","sources":["../../src/clientFilter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAM,MAAM,4BAA4B,CAAC;AAE3D,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;CAOnB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,OAAO,gBAAgB,CAAC,CAAC;AAExF;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,gBAAgB,EAAE,SAAS,EAAE,SAAS,gFAe3E;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,GAAG;IACnC;;;;;;;OAOG;IACH,MAAM,CAAC,UAAU,EAAE,CAAC,GAAG,OAAO,CAAC;CAChC;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,gBAAgB,EAAE,CAAC,IAAI;IAC9D,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IACjB,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC3B,aAAa,GACb,gBAAgB,GAChB,gBAAgB,GAChB,kBAAkB,GAClB,eAAe,GACf,mBAAmB,CAAC;AAExB;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,mBAAmB,EAAE,EAAE,SAAS,EAAE,SAAS,GAAG,OAAO,CASpF;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,GAAG,CAAC,OAAO,EAAE,mBAAmB,EAAE,EAAE,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC;CACrE;AAED;;;GAGG;AACH,qBAAa,yBAA0B,YAAW,kBAAkB;IACvD,SAAS,EAAG,SAAS,CAAC;IACjC,GAAG,CAAC,OAAO,EAAE,mBAAmB,EAAE,EAAE,SAAS,YAAiB;CAG/D;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,0EAE9B,CAAC"}

package/dist/dts/index.d.ts

@@ -0,0 +1,9 @@
+export * from './clientFilter';
+export * from './logger';
+export * from './nodeEnv';
+export * from './percentage';
+export * from './timeWindow';
+export * from './urlTargeting';
+export * from './userAgent';
+export * from './userTargeting';
+//# sourceMappingURL=index.d.ts.map

package/dist/dts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC"}

package/dist/dts/index.federated.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=index.federated.d.ts.map

package/dist/dts/index.federated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.federated.d.ts","sourceRoot":"","sources":["../../src/index.federated.ts"],"names":[],"mappings":""}

package/dist/dts/logger.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Client filter logger
+ *
+ * @remarks
+ * Exposed so that the logging level within this package can be tailored differently to the default level when needed.
+ *
+ * @example
+ * ```ts
+ * import { LogLevel } from '@genesislcap/foundation-utils';
+ * import { logger as clientFilterLogger } from '@genesislcap/foundation-filters';
+ * clientFilterLogger.level = LogLevel.Error;
+ * ```
+ *
+ * @public
+ */
+export declare const logger: import("@genesislcap/foundation-utils").Logger;
+//# sourceMappingURL=logger.d.ts.map

package/dist/dts/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,MAAM,gDAAqC,CAAC"}

package/dist/dts/nodeEnv.d.ts

@@ -0,0 +1,81 @@
+import type { ClientFilter, ClientFilterName, ClientFilterSchema } from './clientFilter';
+/**
+ * NodeEnv client filter function.
+ * @remarks
+ * This will return true when the current node env matches target parameters.
+ * @param envs - Environments to target.
+ * @public
+ */
+export declare function nodeEnvFilter(envs: string[]): boolean;
+/**
+ * NodeEnvParams
+ *
+ * @example
+ * ```json
+ * {
+ *    "envs": ["development", "testing"],
+ * }
+ * ```
+ *
+ * @public
+ */
+export type NodeEnvParams = {
+    /**
+     * Envs to target.
+     */
+    readonly envs: string[];
+};
+/**
+ * NodeEnvSchema type.
+ *
+ * @remarks
+ * JSON schema type.
+ *
+ * @public
+ */
+export type NodeEnvSchema = ClientFilterSchema<typeof ClientFilterName.nodeEnv, NodeEnvParams>;
+/**
+ * NodeEnv client filter DI interface.
+ * @public
+ */
+export interface NodeEnv extends ClientFilter<NodeEnvParams> {
+    /**
+     * @remarks
+     * Running in development mode.
+     */
+    readonly isDevelopment: boolean;
+    /**
+     * @remarks
+     * Running in test mode.
+     */
+    readonly isTesting: boolean;
+    /**
+     * @remarks
+     * Running in production mode.
+     */
+    readonly isProduction: boolean;
+}
+/**
+ * Default NodeEnv DI implementation.
+ * @public
+ */
+export declare class DefaultNodeEnv implements NodeEnv {
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params: NodeEnvParams): boolean;
+    /** {@inheritDoc NodeEnv.isDevelopment} */
+    get isDevelopment(): boolean;
+    /** {@inheritDoc NodeEnv.isTesting} */
+    get isTesting(): boolean;
+    /** {@inheritDoc NodeEnv.isProduction} */
+    get isProduction(): boolean;
+}
+/**
+ * NodeEnv DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export declare const NodeEnv: import("@microsoft/fast-foundation").InterfaceSymbol<NodeEnv>;
+//# sourceMappingURL=nodeEnv.d.ts.map

package/dist/dts/nodeEnv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeEnv.d.ts","sourceRoot":"","sources":["../../src/nodeEnv.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGzF;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAMrD;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAC,OAAO,gBAAgB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;AAE/F;;;GAGG;AACH,MAAM,WAAW,OAAQ,SAAQ,YAAY,CAAC,aAAa,CAAC;IAC1D;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;CAChC;AAED;;;GAGG;AACH,qBAAa,cAAe,YAAW,OAAO;IAC5C,wCAAwC;IACxC,MAAM,CAAC,MAAM,EAAE,aAAa;IAI5B,0CAA0C;IAC1C,IAAI,aAAa,YAEhB;IAED,sCAAsC;IACtC,IAAI,SAAS,YAEZ;IAED,yCAAyC;IACzC,IAAI,YAAY,YAEf;CACF;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,+DAAkE,CAAC"}

package/dist/dts/percentage.d.ts

@@ -0,0 +1,81 @@
+import type { ClientFilter, ClientFilterName, ClientFilterSchema } from './clientFilter';
+/**
+ * Percentage client filter function.
+ * @remarks
+ * This will return true a certain percentage of the time.
+ * @param percent - The percent of the time to pass, a numeric value between 0 and 1.
+ * @param random - Math.random() generated floating-point.
+ * @public
+ */
+export declare function percentageFilter(percent: number, random?: number): boolean;
+/**
+ * PercentageParams
+ *
+ * @remarks
+ * Percent should be a numeric value between 0 and 1.
+ *
+ * @example
+ * ```json
+ * {
+ *    "percent": 0.5
+ * }
+ * ```
+ *
+ * @example
+ * In a rare case where you need to control the random floating-point creation, you can do so externally and provide it.
+ * ```json
+ * {
+ *    "percent": 0.34
+ *    "random": 0.08901819974272063
+ * }
+ * ```
+ *
+ * @public
+ */
+export type PercentageParams = {
+    readonly percent: number;
+    /**
+     * @remarks
+     * Provided for fine-grain control over the random floating-point
+     */
+    readonly random?: number;
+};
+/**
+ * PercentageSchema type.
+ *
+ * @remarks
+ * JSON schema type.
+ *
+ * @public
+ */
+export type PercentageSchema = ClientFilterSchema<typeof ClientFilterName.percentage, PercentageParams>;
+/**
+ * Percentage client filter DI interface.
+ *
+ * @remarks
+ * Simplifies access to runtime data / state contained within the DI container.
+ *
+ * @public
+ * @privateRemarks
+ * Created for consistency with other filters that required DI container access.
+ */
+export interface Percentage extends ClientFilter<PercentageParams> {
+}
+/**
+ * Default Percentage DI implementation.
+ * @public
+ */
+export declare class DefaultPercentage implements Percentage {
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params: PercentageParams): boolean;
+}
+/**
+ * Percentage DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export declare const Percentage: import("@microsoft/fast-foundation").InterfaceSymbol<Percentage>;
+//# sourceMappingURL=percentage.d.ts.map

package/dist/dts/percentage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"percentage.d.ts","sourceRoot":"","sources":["../../src/percentage.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGzF;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAgB,GAAG,OAAO,CAOjF;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,CAC/C,OAAO,gBAAgB,CAAC,UAAU,EAClC,gBAAgB,CACjB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY,CAAC,gBAAgB,CAAC;CAAG;AAErE;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,UAAU;IAClD,wCAAwC;IACxC,MAAM,CAAC,MAAM,EAAE,gBAAgB;CAGhC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,kEAAwE,CAAC"}

package/dist/dts/timeWindow.d.ts

@@ -0,0 +1,91 @@
+import type { ClientFilter, ClientFilterName, ClientFilterSchema } from './clientFilter';
+/**
+ * TimeWindow client filter function.
+ * @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.
+ *
+ * @param start - The start of the time window.
+ * @param end - The end of the time window.
+ * @public
+ */
+export declare function timeWindowFilter(start?: string, end?: string): boolean;
+/**
+ * TimeWindowParams
+ *
+ * @remarks
+ * Both params can be provided in any format recognized by the Date.parse() method.
+ *
+ * @example
+ * ```json
+ * {
+ *   "start": "Sun Sep 25 2022 16:51:55 GMT+0000",
+ *   "end": "Fri Nov 25 2022 17:51:55 GMT+0000"
+ * }
+ * ```
+ *
+ * @example
+ * ```json
+ * {
+ *   "start": "2022-10-01",
+ *   "end": "2022-12-01"
+ * }
+ * ```
+ *
+ * @example
+ * ```json
+ * {
+ *   "end": "Dec 31, 2022"
+ * }
+ * ```
+ *
+ * @example
+ * ```json
+ * {
+ *   "start": "2023-01-01T00:00:00.000+00:00"
+ * }
+ * ```
+ *
+ * @public
+ */
+export type TimeWindowParams = {
+    readonly start?: string;
+    readonly end?: string;
+};
+/**
+ * TimeWindowSchema type.
+ *
+ * @remarks
+ * JSON schema type.
+ *
+ * @public
+ */
+export type TimeWindowSchema = ClientFilterSchema<typeof ClientFilterName.timeWindow, TimeWindowParams>;
+/**
+ * TimeWindow client filter DI interface.
+ *
+ * @remarks
+ * Simplifies access to runtime data / state contained within the DI container.
+ *
+ * @public
+ */
+export interface TimeWindow extends ClientFilter<TimeWindowParams> {
+}
+/**
+ * Default TimeWindow DI implementation.
+ * @public
+ */
+export declare class DefaultTimeWindow implements TimeWindow {
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params: TimeWindowParams): boolean;
+}
+/**
+ * TimeWindow DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export declare const TimeWindow: import("@microsoft/fast-foundation").InterfaceSymbol<TimeWindow>;
+//# sourceMappingURL=timeWindow.d.ts.map

package/dist/dts/timeWindow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeWindow.d.ts","sourceRoot":"","sources":["../../src/timeWindow.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGzF;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAgBtE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,kBAAkB,CAC/C,OAAO,gBAAgB,CAAC,UAAU,EAClC,gBAAgB,CACjB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,WAAW,UAAW,SAAQ,YAAY,CAAC,gBAAgB,CAAC;CAAG;AAErE;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,UAAU;IAClD,wCAAwC;IACxC,MAAM,CAAC,MAAM,EAAE,gBAAgB;CAGhC;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,kEAAwE,CAAC"}

package/dist/dts/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.4"
+    }
+  ]
+}

package/dist/dts/urlTargeting.d.ts

@@ -0,0 +1,94 @@
+import type { ClientFilter, ClientFilterName, ClientFilterSchema } from './clientFilter';
+/**
+ * URLTargeting client filter function.
+ * @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.
+ * @param url - A url.
+ * @param pattern - A regex.
+ * @param schemes - Schemes/protocols to target.
+ * @param hosts - Hosts to target.
+ * @param paths - Paths to target.
+ * @public
+ * @privateRemarks
+ * The pattern regex can cover everything here, but some devs will likely welcome the explicit arguments.
+ */
+export declare function urlTargetingFilter(url: string, pattern?: RegExp, schemes?: string[], hosts?: string[], paths?: string[]): boolean;
+/**
+ * URLTargetingParams
+ *
+ * @example
+ * ```json
+ * {
+ *    "schemes": ["https"],
+ *    "hosts": ["neptx.genesislab.global", "neptune-uat2-axes-server2"]
+ * }
+ * ```
+ *
+ * @public
+ */
+export type URLTargetingParams = {
+    /**
+     * A url.
+     */
+    readonly url?: string;
+    /**
+     * A regex.
+     */
+    readonly pattern?: RegExp;
+    /**
+     * Schemes/protocols to target.
+     */
+    readonly schemes?: string[];
+    /**
+     * Hosts to target.
+     */
+    readonly hosts?: string[];
+    /**
+     * Paths to target.
+     */
+    readonly paths?: string[];
+};
+/**
+ * URLTargetingSchema type.
+ *
+ * @remarks
+ * JSON schema type.
+ *
+ * @public
+ */
+export type URLTargetingSchema = ClientFilterSchema<typeof ClientFilterName.urlTargeting, URLTargetingParams>;
+/**
+ * URLTargeting client filter DI interface.
+ *
+ * @public
+ */
+export interface URLTargeting extends ClientFilter<URLTargetingParams> {
+    /**
+     * @remarks
+     * Check if a url is secure.
+     *
+     * @param url - A url.
+     */
+    isSecure(url: string): boolean;
+}
+/**
+ * Default URLTargeting DI implementation.
+ * @public
+ */
+export declare class DefaultURLTargeting implements URLTargeting {
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params: URLTargetingParams): boolean;
+    /** {@inheritDoc URLTargeting.isSecure} */
+    isSecure(url: any): boolean;
+}
+/**
+ * URLTargeting DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export declare const URLTargeting: import("@microsoft/fast-foundation").InterfaceSymbol<URLTargeting>;
+//# sourceMappingURL=urlTargeting.d.ts.map

package/dist/dts/urlTargeting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"urlTargeting.d.ts","sourceRoot":"","sources":["../../src/urlTargeting.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGzF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,KAAK,CAAC,EAAE,MAAM,EAAE,EAChB,KAAK,CAAC,EAAE,MAAM,EAAE,GACf,OAAO,CAyBT;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,kBAAkB,CACjD,OAAO,gBAAgB,CAAC,YAAY,EACpC,kBAAkB,CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,YAAY,CAAC,kBAAkB,CAAC;IACpE;;;;;OAKG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAChC;AAED;;;GAGG;AACH,qBAAa,mBAAoB,YAAW,YAAY;IACtD,wCAAwC;IACxC,MAAM,CAAC,MAAM,EAAE,kBAAkB;IAUjC,0CAA0C;IAC1C,QAAQ,CAAC,GAAG,KAAA;CAGb;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,oEAExB,CAAC"}

package/dist/dts/userAgent.d.ts

@@ -0,0 +1,96 @@
+import type { ClientFilter, ClientFilterName, ClientFilterSchema } from './clientFilter';
+/**
+ * UserAgent client filter function.
+ *
+ * @remarks
+ * See {@link https://github.com/faisalman/ua-parser-js} for more information.
+ *
+ * @param browsers - Browser names to target.
+ * @param devices - Device types to target.
+ * @param oss - Operating system names to target.
+ * @param ua - User-agent string (required in nodejs environment).
+ * @public
+ */
+export declare function userAgentFilter(browsers?: string[], devices?: string[], oss?: string[], ua?: string): boolean;
+/**
+ * UserAgentParams
+ *
+ * @example
+ * ```json
+ * {
+ *    "browsers": ["Safari", "Firefox", "Chrome", "Chromium"],
+ *    "devices": ["mobile", "tablet"],
+ *    "oss": ["Mac OS", "Linux"]
+ * }
+ * ```
+ *
+ * @public
+ */
+export type UserAgentParams = {
+    /**
+     * Browser names to target.
+     */
+    readonly browsers?: string[];
+    /**
+     * Device types to target.
+     */
+    readonly devices?: string[];
+    /**
+     * Operating system names to target.
+     */
+    readonly oss?: string[];
+    /**
+     * @remarks
+     * Provided for fine-grain control over the user-agent string in browser, and nodejs usage.
+     */
+    readonly ua?: string;
+};
+/**
+ * UserAgentSchema type.
+ *
+ * @remarks
+ * JSON schema type.
+ *
+ * @public
+ */
+export type UserAgentSchema = ClientFilterSchema<typeof ClientFilterName.userAgent, UserAgentParams>;
+/**
+ * UserAgent client filter DI interface.
+ *
+ * @remarks
+ * Simplifies access to runtime data / state contained within the DI container.
+ *
+ * @public
+ * @privateRemarks
+ * Created for consistency with other filters that required DI container access.
+ */
+export interface UserAgent extends ClientFilter<UserAgentParams> {
+    /**
+     * @remarks
+     * Is the user-agent safari.
+     *
+     * @privateRemarks
+     * Added as an example, see comment in implementation.
+     */
+    readonly isSafari: boolean;
+}
+/**
+ * Default UserAgent DI implementation.
+ * @public
+ */
+export declare class DefaultUserAgent implements UserAgent {
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params: UserAgentParams): boolean;
+    /** {@inheritDoc UserAgent.isSafari} */
+    get isSafari(): boolean;
+}
+/**
+ * UserAgent DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export declare const UserAgent: import("@microsoft/fast-foundation").InterfaceSymbol<UserAgent>;
+//# sourceMappingURL=userAgent.d.ts.map

package/dist/dts/userAgent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"userAgent.d.ts","sourceRoot":"","sources":["../../src/userAgent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGzF;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,CAAC,EAAE,MAAM,EAAE,EACnB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,GAAG,CAAC,EAAE,MAAM,EAAE,EACd,EAAE,CAAC,EAAE,MAAM,GACV,OAAO,CAgBT;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAC9C,OAAO,gBAAgB,CAAC,SAAS,EACjC,eAAe,CAChB,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,WAAW,SAAU,SAAQ,YAAY,CAAC,eAAe,CAAC;IAC9D;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;CAC5B;AAED;;;GAGG;AACH,qBAAa,gBAAiB,YAAW,SAAS;IAChD,wCAAwC;IACxC,MAAM,CAAC,MAAM,EAAE,eAAe;IAI9B,uCAAuC;IACvC,IAAI,QAAQ,YAKX;CACF;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,iEAAsE,CAAC"}