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

package/dist/dts/userTargeting.d.ts

@@ -0,0 +1,107 @@
+import { Auth, User } from '@genesislcap/foundation-comms';
+import type { ClientFilter, ClientFilterName, ClientFilterSchema } from './clientFilter';
+/**
+ * UserTargeting client filter function.
+ * @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.
+ * @param user - A user object.
+ * @param usernames - Usernames to target.
+ * @param profiles - Profiles to target.
+ * @param permissions - Permissions to target.
+ * @public
+ * @privateRemarks
+ * We could provide another parameter to indicate a complete match is required?
+ */
+export declare function userTargetingFilter(user: User, usernames?: string[], profiles?: string[], permissions?: string[]): boolean;
+/**
+ * UserTargetingParams
+ *
+ * @example
+ * ```json
+ * {
+ *    "usernames": ["JohnDoe"],
+ *    "profiles": ["ADMIN", "READ_WRITE_DEALER"],
+ *    "permissions": ["ExportClientDashboard"]
+ * }
+ * ```
+ *
+ * @public
+ */
+export type UserTargetingParams = {
+    /**
+     * Usernames to target.
+     */
+    readonly usernames?: string[];
+    /**
+     * Profiles to target.
+     *
+     * @remarks
+     * Profiles are assigned to users, and users may have multiple profiles assigned to them.
+     */
+    readonly profiles?: string[];
+    /**
+     * Permissions to target.
+     *
+     * @remarks
+     * Permissions are assigned to profiles, NEVER to users directly.
+     * The user permissions array will contain everything from the assigned profiles for fine-grained control.
+     */
+    readonly permissions?: string[];
+};
+/**
+ * UserTargetingSchema type.
+ *
+ * @remarks
+ * JSON schema type.
+ *
+ * @public
+ */
+export type UserTargetingSchema = ClientFilterSchema<typeof ClientFilterName.userTargeting, UserTargetingParams>;
+/**
+ * UserTargeting client filter DI interface.
+ *
+ * @remarks
+ * Simplifies access to runtime data / state contained within the DI container.
+ *
+ * @public
+ */
+export interface UserTargeting extends ClientFilter<UserTargetingParams> {
+    /**
+     * @remarks
+     * Has the user got the 'ADMIN' profile assigned.
+     *
+     * @privateRemarks
+     * Added as an example, see comment in implementation.
+     */
+    readonly hasAdminProfile: boolean;
+    /**
+     * @remarks
+     * Has the user logged in, regardless of their identity.
+     */
+    readonly isLoggedIn: boolean;
+}
+/**
+ * Default UserTargeting DI implementation.
+ * @public
+ */
+export declare class DefaultUserTargeting implements UserTargeting {
+    auth: Auth;
+    constructor(auth: Auth);
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params: UserTargetingParams): boolean;
+    /** {@inheritDoc UserTargeting.hasAdminProfile} */
+    get hasAdminProfile(): boolean;
+    /** {@inheritDoc UserTargeting.isLoggedIn} */
+    get isLoggedIn(): boolean;
+}
+/**
+ * UserTargeting DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export declare const UserTargeting: import("@microsoft/fast-foundation").InterfaceSymbol<UserTargeting>;
+//# sourceMappingURL=userTargeting.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"userTargeting.d.ts","sourceRoot":"","sources":["../../src/userTargeting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAE3D,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAGzF;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,IAAI,EACV,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,QAAQ,CAAC,EAAE,MAAM,EAAE,EACnB,WAAW,CAAC,EAAE,MAAM,EAAE,GACrB,OAAO,CAkBT;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACjC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,CAClD,OAAO,gBAAgB,CAAC,aAAa,EACrC,mBAAmB,CACpB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY,CAAC,mBAAmB,CAAC;IACtE;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAC9B;AAED;;;GAGG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IAC/B,IAAI,EAAE,IAAI;gBAAV,IAAI,EAAE,IAAI;IAEnC,wCAAwC;IACxC,MAAM,CAAC,MAAM,EAAE,mBAAmB;IASlC,kDAAkD;IAClD,IAAI,eAAe,YAMlB;IAED,6CAA6C;IAC7C,IAAI,UAAU,YAEb;CACF;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,qEAEzB,CAAC"}

package/dist/esm/clientFilter.js

@@ -0,0 +1,84 @@
+import { __decorate } from "tslib";
+import { Container, DI } from '@microsoft/fast-foundation';
+import { logger } from './logger';
+import { NodeEnv } from './nodeEnv';
+import { Percentage } from './percentage';
+import { TimeWindow } from './timeWindow';
+import { URLTargeting } from './urlTargeting';
+import { UserAgent } from './userAgent';
+import { UserTargeting } from './userTargeting';
+/**
+ * @public
+ */
+export const ClientFilterName = {
+    nodeEnv: 'nodeEnv',
+    percentage: 'percentage',
+    timeWindow: 'timeWindow',
+    urlTargeting: 'urlTargeting',
+    userAgent: 'userAgent',
+    userTargeting: 'userTargeting',
+};
+/**
+ * Filer lookup by name.
+ *
+ * @public
+ */
+export function getFilterByName(name, container) {
+    switch (name) {
+        case ClientFilterName.nodeEnv:
+            return container.get(NodeEnv);
+        case ClientFilterName.percentage:
+            return container.get(Percentage);
+        case ClientFilterName.timeWindow:
+            return container.get(TimeWindow);
+        case ClientFilterName.urlTargeting:
+            return container.get(URLTargeting);
+        case ClientFilterName.userAgent:
+            return container.get(UserAgent);
+        case ClientFilterName.userTargeting:
+            return container.get(UserTargeting);
+    }
+}
+/**
+ * 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 function runner(filters, container) {
+    if (!filters || !filters.length) {
+        logger.warn('The client filter runner requires an array of filters to run, received:', filters);
+        return true;
+    }
+    return filters.every((cf) => {
+        const target = getFilterByName(cf.name, container);
+        return target ? target.filter(cf.parameters) : true;
+    });
+}
+/**
+ * Default ClientFilterRunner DI implementation.
+ * @public
+ */
+export class DefaultClientFilterRunner {
+    run(filters, container = this.container) {
+        return runner(filters, container);
+    }
+}
+__decorate([
+    Container
+], DefaultClientFilterRunner.prototype, "container", void 0);
+/**
+ * ClientFilterRunner DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export const ClientFilterRunner = DI.createInterface((x) => x.transient(DefaultClientFilterRunner));
+//# sourceMappingURL=clientFilter.js.map

package/dist/esm/clientFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientFilter.js","sourceRoot":"","sources":["../../src/clientFilter.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,OAAO,EAAiB,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,UAAU,EAAoB,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAoB,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAsB,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,SAAS,EAAmB,MAAM,aAAa,CAAC;AACzD,OAAO,EAAE,aAAa,EAAuB,MAAM,iBAAiB,CAAC;AAErE;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,OAAO,EAAE,SAAS;IAClB,UAAU,EAAE,YAAY;IACxB,UAAU,EAAE,YAAY;IACxB,YAAY,EAAE,cAAc;IAC5B,SAAS,EAAE,WAAW;IACtB,aAAa,EAAE,eAAe;CACtB,CAAC;AAOX;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,IAAsB,EAAE,SAAoB;IAC1E,QAAQ,IAAI,EAAE;QACZ,KAAK,gBAAgB,CAAC,OAAO;YAC3B,OAAO,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,KAAK,gBAAgB,CAAC,UAAU;YAC9B,OAAO,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACnC,KAAK,gBAAgB,CAAC,UAAU;YAC9B,OAAO,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACnC,KAAK,gBAAgB,CAAC,YAAY;YAChC,OAAO,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACrC,KAAK,gBAAgB,CAAC,SAAS;YAC7B,OAAO,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAClC,KAAK,gBAAgB,CAAC,aAAa;YACjC,OAAO,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;KACvC;AACH,CAAC;AAqDD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,MAAM,CAAC,OAA8B,EAAE,SAAoB;IACzE,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QAC/B,MAAM,CAAC,IAAI,CAAC,yEAAyE,EAAE,OAAO,CAAC,CAAC;QAChG,OAAO,IAAI,CAAC;KACb;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE;QAC1B,MAAM,MAAM,GAAG,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,CAAiB,CAAC;QACnE,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC;AAWD;;;GAGG;AACH,MAAM,OAAO,yBAAyB;IAEpC,GAAG,CAAC,OAA8B,EAAE,SAAS,GAAG,IAAI,CAAC,SAAS;QAC5D,OAAO,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACpC,CAAC;CACF;AAJY;IAAV,SAAS;4DAAuB;AAMnC;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,CAAC,eAAe,CAAqB,CAAC,CAAC,EAAE,EAAE,CAC7E,CAAC,CAAC,SAAS,CAAC,yBAAyB,CAAC,CACvC,CAAC"}

package/dist/esm/index.federated.js

@@ -0,0 +1,2 @@
+import('./index');
+//# sourceMappingURL=index.federated.js.map

package/dist/esm/index.federated.js.map

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

package/dist/esm/index.js

@@ -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.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","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/esm/logger.js

@@ -0,0 +1,18 @@
+import { createLogger } from '@genesislcap/foundation-utils';
+/**
+ * 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 const logger = createLogger('foundation-filters');
+//# sourceMappingURL=logger.js.map

package/dist/esm/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,YAAY,CAAC,oBAAoB,CAAC,CAAC"}

package/dist/esm/nodeEnv.js

@@ -0,0 +1,48 @@
+import { DI } from '@microsoft/fast-foundation';
+import { logger } from './logger';
+/**
+ * NodeEnv client filter function.
+ * @remarks
+ * This will return true when the current node env matches target parameters.
+ * @param envs - Environments to target.
+ * @public
+ */
+export function nodeEnvFilter(envs) {
+    if (!envs) {
+        logger.warn('NodeEnv filter parameters must include envs.');
+        return true;
+    }
+    return !!process.env.NODE_ENV && envs.includes(process.env.NODE_ENV);
+}
+/**
+ * Default NodeEnv DI implementation.
+ * @public
+ */
+export class DefaultNodeEnv {
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params) {
+        return nodeEnvFilter(params === null || params === void 0 ? void 0 : params.envs);
+    }
+    /** {@inheritDoc NodeEnv.isDevelopment} */
+    get isDevelopment() {
+        return nodeEnvFilter(['development']);
+    }
+    /** {@inheritDoc NodeEnv.isTesting} */
+    get isTesting() {
+        return nodeEnvFilter(['testing', 'test']);
+    }
+    /** {@inheritDoc NodeEnv.isProduction} */
+    get isProduction() {
+        return nodeEnvFilter(['production']);
+    }
+}
+/**
+ * NodeEnv DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export const NodeEnv = DI.createInterface((x) => x.transient(DefaultNodeEnv));
+//# sourceMappingURL=nodeEnv.js.map

package/dist/esm/nodeEnv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodeEnv.js","sourceRoot":"","sources":["../../src/nodeEnv.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAEhD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,IAAc;IAC1C,IAAI,CAAC,IAAI,EAAE;QACT,MAAM,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;KACb;IACD,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACvE,CAAC;AAqDD;;;GAGG;AACH,MAAM,OAAO,cAAc;IACzB,wCAAwC;IACxC,MAAM,CAAC,MAAqB;QAC1B,OAAO,aAAa,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,0CAA0C;IAC1C,IAAI,aAAa;QACf,OAAO,aAAa,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,sCAAsC;IACtC,IAAI,SAAS;QACX,OAAO,aAAa,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,yCAAyC;IACzC,IAAI,YAAY;QACd,OAAO,aAAa,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC;IACvC,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,EAAE,CAAC,eAAe,CAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC"}

package/dist/esm/percentage.js

@@ -0,0 +1,38 @@
+import { DI } from '@microsoft/fast-foundation';
+import { logger } from './logger';
+/**
+ * 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 function percentageFilter(percent, random = Math.random()) {
+    const withinRange = percent >= 0 && percent <= 1;
+    if (!withinRange) {
+        logger.warn('Percentage filter parameters must include a numeric percent between 0 and 1.');
+        return true;
+    }
+    return random < percent;
+}
+/**
+ * Default Percentage DI implementation.
+ * @public
+ */
+export class DefaultPercentage {
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params) {
+        return percentageFilter(params === null || params === void 0 ? void 0 : params.percent, params === null || params === void 0 ? void 0 : params.random);
+    }
+}
+/**
+ * Percentage DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export const Percentage = DI.createInterface((x) => x.transient(DefaultPercentage));
+//# sourceMappingURL=percentage.js.map

package/dist/esm/percentage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"percentage.js","sourceRoot":"","sources":["../../src/percentage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAEhD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAe,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE;IACtE,MAAM,WAAW,GAAG,OAAO,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC;IACjD,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,CAAC,IAAI,CAAC,8EAA8E,CAAC,CAAC;QAC5F,OAAO,IAAI,CAAC;KACb;IACD,OAAO,MAAM,GAAG,OAAO,CAAC;AAC1B,CAAC;AA4DD;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAC5B,wCAAwC;IACxC,MAAM,CAAC,MAAwB;QAC7B,OAAO,gBAAgB,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,CAAC,eAAe,CAAa,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC"}

package/dist/esm/timeWindow.js

@@ -0,0 +1,49 @@
+import { DI } from '@microsoft/fast-foundation';
+import { logger } from './logger';
+/**
+ * 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 function timeWindowFilter(start, end) {
+    if (!start && !end) {
+        logger.warn('TimeWindow filter parameters must include start, end, or both.');
+        return true;
+    }
+    const now = new Date();
+    let result = true;
+    if (start) {
+        const startDate = new Date(start);
+        result = now >= startDate;
+    }
+    if (end && result) {
+        const endDate = new Date(end);
+        result = now < endDate;
+    }
+    return result;
+}
+/**
+ * Default TimeWindow DI implementation.
+ * @public
+ */
+export class DefaultTimeWindow {
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params) {
+        return timeWindowFilter(params === null || params === void 0 ? void 0 : params.start, params === null || params === void 0 ? void 0 : params.end);
+    }
+}
+/**
+ * TimeWindow DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export const TimeWindow = DI.createInterface((x) => x.transient(DefaultTimeWindow));
+//# sourceMappingURL=timeWindow.js.map

package/dist/esm/timeWindow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeWindow.js","sourceRoot":"","sources":["../../src/timeWindow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAEhD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc,EAAE,GAAY;IAC3D,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,EAAE;QAClB,MAAM,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;QAC9E,OAAO,IAAI,CAAC;KACb;IACD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,IAAI,MAAM,GAAG,IAAI,CAAC;IAClB,IAAI,KAAK,EAAE;QACT,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;QAClC,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC;KAC3B;IACD,IAAI,GAAG,IAAI,MAAM,EAAE;QACjB,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC;KACxB;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAoED;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAC5B,wCAAwC;IACxC,MAAM,CAAC,MAAwB;QAC7B,OAAO,gBAAgB,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,CAAC;IACtD,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,CAAC,eAAe,CAAa,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC"}

package/dist/esm/urlTargeting.js

@@ -0,0 +1,68 @@
+import { DI } from '@microsoft/fast-foundation';
+import { logger } from './logger';
+/**
+ * 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 function urlTargetingFilter(url, pattern, schemes, hosts, paths) {
+    var _a;
+    if (!url) {
+        logger.warn('URLTargeting filter needs a url to filter on.');
+        return true;
+    }
+    if (!pattern && !schemes && !hosts && !paths) {
+        logger.warn('URLTargeting filter parameters must include pattern, schemes, hosts, or paths.');
+        return true;
+    }
+    if (pattern && pattern.test(url)) {
+        return true;
+    }
+    let urlObj;
+    try {
+        urlObj = new URL(url);
+    }
+    catch (e) {
+        return true;
+    }
+    if (schemes && schemes.includes((_a = urlObj.protocol) === null || _a === void 0 ? void 0 : _a.slice(0, -1))) {
+        return true;
+    }
+    if (hosts && hosts.includes(urlObj.host)) {
+        return true;
+    }
+    return !!paths && paths.includes(urlObj.pathname);
+}
+/**
+ * Default URLTargeting DI implementation.
+ * @public
+ */
+export class DefaultURLTargeting {
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params) {
+        return urlTargetingFilter(params === null || params === void 0 ? void 0 : params.url, params === null || params === void 0 ? void 0 : params.pattern, params === null || params === void 0 ? void 0 : params.schemes, params === null || params === void 0 ? void 0 : params.hosts, params === null || params === void 0 ? void 0 : params.paths);
+    }
+    /** {@inheritDoc URLTargeting.isSecure} */
+    isSecure(url) {
+        return urlTargetingFilter(url, null, ['https', 'wss']);
+    }
+}
+/**
+ * URLTargeting DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export const URLTargeting = DI.createInterface((x) => x.transient(DefaultURLTargeting));
+//# sourceMappingURL=urlTargeting.js.map

package/dist/esm/urlTargeting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"urlTargeting.js","sourceRoot":"","sources":["../../src/urlTargeting.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAEhD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,kBAAkB,CAChC,GAAW,EACX,OAAgB,EAChB,OAAkB,EAClB,KAAgB,EAChB,KAAgB;;IAEhB,IAAI,CAAC,GAAG,EAAE;QACR,MAAM,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;KACb;IACD,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE;QAC5C,MAAM,CAAC,IAAI,CAAC,gFAAgF,CAAC,CAAC;QAC9F,OAAO,IAAI,CAAC;KACb;IACD,IAAI,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAChC,OAAO,IAAI,CAAC;KACb;IACD,IAAI,MAAW,CAAC;IAChB,IAAI;QACF,MAAM,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;KACvB;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,IAAI,CAAC;KACb;IACD,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAA,MAAM,CAAC,QAAQ,0CAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE;QAC9D,OAAO,IAAI,CAAC;KACb;IACD,IAAI,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QACxC,OAAO,IAAI,CAAC;KACb;IACD,OAAO,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AACpD,CAAC;AAkED;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAC9B,wCAAwC;IACxC,MAAM,CAAC,MAA0B;QAC/B,OAAO,kBAAkB,CACvB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,EACX,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,EACf,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,EACf,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,EACb,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CACd,CAAC;IACJ,CAAC;IAED,0CAA0C;IAC1C,QAAQ,CAAC,GAAG;QACV,OAAO,kBAAkB,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IACzD,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,EAAE,CAAC,eAAe,CAAe,CAAC,CAAC,EAAE,EAAE,CACjE,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CACjC,CAAC"}

package/dist/esm/userAgent.js

@@ -0,0 +1,59 @@
+import { DI } from '@microsoft/fast-foundation';
+import UAParser from 'ua-parser-js';
+import { logger } from './logger';
+/**
+ * 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 function userAgentFilter(browsers, devices, oss, ua) {
+    if (!browsers && !devices && !oss) {
+        logger.warn('UserAgent filter parameters must include browsers, devices, oss, or all three.');
+        return true;
+    }
+    const parser = new UAParser(ua);
+    const browser = browsers && parser.getBrowser();
+    if (browser && browser.name && browsers.includes(browser.name)) {
+        return true;
+    }
+    const device = devices && parser.getDevice();
+    if (device && device.type && devices.includes(device.type)) {
+        return true;
+    }
+    const os = oss && parser.getOS();
+    return !!os && !!os.name && oss.includes(os.name);
+}
+/**
+ * Default UserAgent DI implementation.
+ * @public
+ */
+export class DefaultUserAgent {
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params) {
+        return userAgentFilter(params === null || params === void 0 ? void 0 : params.browsers, params === null || params === void 0 ? void 0 : params.devices, params === null || params === void 0 ? void 0 : params.oss, params === null || params === void 0 ? void 0 : params.ua);
+    }
+    /** {@inheritDoc UserAgent.isSafari} */
+    get isSafari() {
+        /**
+         * You can use pre-defined params to encapsulate common requests.
+         */
+        return userAgentFilter(['Safari']);
+    }
+}
+/**
+ * UserAgent DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export const UserAgent = DI.createInterface((x) => x.transient(DefaultUserAgent));
+//# sourceMappingURL=userAgent.js.map

package/dist/esm/userAgent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userAgent.js","sourceRoot":"","sources":["../../src/userAgent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAChD,OAAO,QAAQ,MAAM,cAAc,CAAC;AAEpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAC7B,QAAmB,EACnB,OAAkB,EAClB,GAAc,EACd,EAAW;IAEX,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,IAAI,CAAC,GAAG,EAAE;QACjC,MAAM,CAAC,IAAI,CAAC,gFAAgF,CAAC,CAAC;QAC9F,OAAO,IAAI,CAAC;KACb;IACD,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC;IAChC,MAAM,OAAO,GAAG,QAAQ,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;IAChD,IAAI,OAAO,IAAI,OAAO,CAAC,IAAI,IAAI,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC9D,OAAO,IAAI,CAAC;KACb;IACD,MAAM,MAAM,GAAG,OAAO,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;IAC7C,IAAI,MAAM,IAAI,MAAM,CAAC,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QAC1D,OAAO,IAAI,CAAC;KACb;IACD,MAAM,EAAE,GAAG,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;IACjC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;AACpD,CAAC;AAsED;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAC3B,wCAAwC;IACxC,MAAM,CAAC,MAAuB;QAC5B,OAAO,eAAe,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,EAAE,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,uCAAuC;IACvC,IAAI,QAAQ;QACV;;WAEG;QACH,OAAO,eAAe,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IACrC,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAC,eAAe,CAAY,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC,CAAC"}

package/dist/esm/userTargeting.js

@@ -0,0 +1,73 @@
+import { __decorate, __param } from "tslib";
+import { Auth } from '@genesislcap/foundation-comms';
+import { DI } from '@microsoft/fast-foundation';
+import { logger } from './logger';
+/**
+ * UserTargeting client filter function.
+ * @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.
+ * @param user - A user object.
+ * @param usernames - Usernames to target.
+ * @param profiles - Profiles to target.
+ * @param permissions - Permissions to target.
+ * @public
+ * @privateRemarks
+ * We could provide another parameter to indicate a complete match is required?
+ */
+export function userTargetingFilter(user, usernames, profiles, permissions) {
+    if (!user) {
+        logger.warn('UserTargeting filter needs a user to filter on.');
+        return true;
+    }
+    if (!usernames && !profiles && !permissions) {
+        logger.warn('UserTargeting filter parameters must include usernames, profiles, permissions, or all three.');
+        return true;
+    }
+    if (usernames && usernames.includes(user.username)) {
+        return true;
+    }
+    if (profiles && profiles.some((p) => user.profiles.includes(p))) {
+        return true;
+    }
+    return !!permissions && permissions.some((p) => user.permissions.includes(p));
+}
+/**
+ * Default UserTargeting DI implementation.
+ * @public
+ */
+let DefaultUserTargeting = class DefaultUserTargeting {
+    constructor(auth) {
+        this.auth = auth;
+    }
+    /** {@inheritDoc ClientFilter.filter} */
+    filter(params) {
+        return userTargetingFilter(this.auth.currentUser, params === null || params === void 0 ? void 0 : params.usernames, params === null || params === void 0 ? void 0 : params.profiles, params === null || params === void 0 ? void 0 : params.permissions);
+    }
+    /** {@inheritDoc UserTargeting.hasAdminProfile} */
+    get hasAdminProfile() {
+        /**
+         * This could simply be `return this.auth.currentUser.hasAdminProfile()`, but the purpose was to show how we
+         * might leverage the baseline filter function with pre-defined params to encapsulate common requests.
+         */
+        return userTargetingFilter(this.auth.currentUser, undefined, ['ADMIN']);
+    }
+    /** {@inheritDoc UserTargeting.isLoggedIn} */
+    get isLoggedIn() {
+        return this.auth.isLoggedIn;
+    }
+};
+DefaultUserTargeting = __decorate([
+    __param(0, Auth)
+], DefaultUserTargeting);
+export { DefaultUserTargeting };
+/**
+ * UserTargeting DI key.
+ *
+ * @privateRemarks
+ * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ *
+ * @internal
+ */
+export const UserTargeting = DI.createInterface((x) => x.transient(DefaultUserTargeting));
+//# sourceMappingURL=userTargeting.js.map

package/dist/esm/userTargeting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userTargeting.js","sourceRoot":"","sources":["../../src/userTargeting.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,IAAI,EAAQ,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,EAAE,EAAE,MAAM,4BAA4B,CAAC;AAEhD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAU,EACV,SAAoB,EACpB,QAAmB,EACnB,WAAsB;IAEtB,IAAI,CAAC,IAAI,EAAE;QACT,MAAM,CAAC,IAAI,CAAC,iDAAiD,CAAC,CAAC;QAC/D,OAAO,IAAI,CAAC;KACb;IACD,IAAI,CAAC,SAAS,IAAI,CAAC,QAAQ,IAAI,CAAC,WAAW,EAAE;QAC3C,MAAM,CAAC,IAAI,CACT,8FAA8F,CAC/F,CAAC;QACF,OAAO,IAAI,CAAC;KACb;IACD,IAAI,SAAS,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;QAClD,OAAO,IAAI,CAAC;KACb;IACD,IAAI,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;QAC/D,OAAO,IAAI,CAAC;KACb;IACD,OAAO,CAAC,CAAC,WAAW,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAChF,CAAC;AA4ED;;;GAGG;AACI,IAAM,oBAAoB,GAA1B,MAAM,oBAAoB;IAC/B,YAAyB,IAAU;QAAV,SAAI,GAAJ,IAAI,CAAM;IAAG,CAAC;IAEvC,wCAAwC;IACxC,MAAM,CAAC,MAA2B;QAChC,OAAO,mBAAmB,CACxB,IAAI,CAAC,IAAI,CAAC,WAAW,EACrB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,SAAS,EACjB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,EAChB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,CACpB,CAAC;IACJ,CAAC;IAED,kDAAkD;IAClD,IAAI,eAAe;QACjB;;;WAGG;QACH,OAAO,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,6CAA6C;IAC7C,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;IAC9B,CAAC;CACF,CAAA;AA1BY,oBAAoB;IAClB,WAAA,IAAI,CAAA;GADN,oBAAoB,CA0BhC;SA1BY,oBAAoB;AA4BjC;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,CAAC,eAAe,CAAgB,CAAC,CAAC,EAAE,EAAE,CACnE,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAClC,CAAC"}