@amazon/vinyl-util 1.0.0

package/dist/testUtil/types/ts4.1/reporters/RestApiReporter.d.ts

@@ -0,0 +1,24 @@
+import type { LogReporterProgressEvent, LogReporterDoneEvent, LogReporterStartedEvent } from '../reporters/LogReporter';
+import { LogReporter } from '../reporters/LogReporter';
+export declare class RestApiReporter extends LogReporter {
+    private readonly reportApi;
+    /**
+     * Installs this reporter if this is a Browser environment and the report api has been provided as a query
+     * parameter.
+     * @param searchParam
+     */
+    static installFromSearchParam(searchParam?: string): void;
+    constructor(reportApi: string);
+    protected onStarted(action: LogReporterStartedEvent): Promise<void>;
+    protected onProgress(action: LogReporterProgressEvent): Promise<void>;
+    protected onDone(action: LogReporterDoneEvent): Promise<void>;
+    /**
+     * If the reportApi url was set in the URL parameters, report to that URL the test progress.
+     *
+     * @param action One of: 'started', 'progress', or 'done'
+     * @param body
+     * @private
+     */
+    private doRequest;
+}
+//# sourceMappingURL=RestApiReporter.d.ts.map

package/dist/testUtil/types/ts4.1/util/event/createEventSpy.d.ts

@@ -0,0 +1,31 @@
+import type { Disposable, EventHandler, Fun, ReadonlyEventHost } from '@amazon/vinyl-util';
+import Spy = jasmine.Spy;
+/**
+ * A Spy that provides a way to promisify the next call and unsubscribe.
+ *
+ * Do not use `and` on an EventSpy, the callFake is used to provide the next promise.
+ */
+export interface EventSpy<EventMap, K extends keyof EventMap> extends Spy<EventHandler<EventMap[K]>>, Fun, Disposable {
+    /**
+     * Returns a promise that resolves when the event has next been dispatched, or rejects
+     * if timeout has elapsed.
+     *
+     * @param timeout The number of seconds before a timeout.
+     * @param timeoutMessage An optional timeout message to use instead of the default.
+     *  This may use two tokens:
+     *   {0} - The event type.
+     *   {1} - Number of seconds before the timeout.
+     */
+    next(timeout?: number, timeoutMessage?: string): Promise<EventMap[K]>;
+}
+/**
+ * Adds a listener to an event host, returning a spy for assertions.
+ *
+ * The returned spy provides a `next` function to promisify the next call and a `dispose` function
+ * to unsubscribe.
+ *
+ * @param host
+ * @param type
+ */
+export declare function createEventSpy<EventMap, K extends keyof EventMap>(host: ReadonlyEventHost<EventMap>, type: K): EventSpy<EventMap, K>;
+//# sourceMappingURL=createEventSpy.d.ts.map

package/dist/testUtil/types/ts4.1/util/initializeUncaughtErrorLogging.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Logs uncaught errors and promise rejections to the console, to be emitted to the report api.
+ * Jasmine catches uncaught errors and only reports the message in the test failure, not the whole error event.
+ */
+export declare function initializeUncaughtErrorLogging(): void;
+//# sourceMappingURL=initializeUncaughtErrorLogging.d.ts.map

package/dist/testUtil/types/ts4.7/error/uncaughtErrorUtil.d.ts

@@ -0,0 +1,15 @@
+import type { CodeRange } from '@amazon/vinyl-util';
+import type { MockEventTarget } from '@amazon/vinyl-util/browserTestUtil';
+/**
+ * Creates a code range object surrounding the given error.
+ */
+export declare function createRangeSurrounding(error: Error): CodeRange;
+/**
+ * Simulates an uncaught error event.
+ */
+export declare function throwMockError(target: MockEventTarget, error: any): void;
+/**
+ * Simulates an unhandled rejection to be caught by the global unhandled promise handler.
+ */
+export declare function rejectMockPromise(target: MockEventTarget, reason: any): void;
+//# sourceMappingURL=uncaughtErrorUtil.d.ts.map

package/dist/testUtil/types/ts4.7/global/overrideGlobalInit.d.ts

@@ -0,0 +1,5 @@
+import type { GlobalRef } from '@amazon/vinyl-util';
+export declare function overrideGlobalInit<T, U extends T>(initHandle: GlobalRef<T>, initOverride: () => U): {
+    readonly value: U;
+};
+//# sourceMappingURL=overrideGlobalInit.d.ts.map

package/dist/testUtil/types/ts4.7/index.d.ts

@@ -0,0 +1,20 @@
+/** Auto-generated from build scripts */
+export * from './util/initializeUncaughtErrorLogging';
+export * from './util/event/createEventSpy';
+export * from './reporters/RestApiReporter';
+export * from './reporters/LogReporter';
+export * from './patch/addPatchTests';
+export * from './mock/util/spyOnPropertySafe';
+export * from './mock/persistence/MockPersistence';
+export * from './mock/network/emptyRequestInfo';
+export * from './mock/network/MockRequester';
+export * from './mock/network/MockNetworkState';
+export * from './mock/network/MockNetworkMetricsController';
+export * from './mock/network/MockNetworkInformation';
+export * from './mock/navigator/setMockNavigator';
+export * from './mock/logging/MockLogger';
+export * from './mock/event/emptyLogTarget';
+export * from './mock/event/MockEventHost';
+export * from './global/overrideGlobalInit';
+export * from './error/uncaughtErrorUtil';
+//# sourceMappingURL=index.d.ts.map

package/dist/testUtil/types/ts4.7/mock/event/MockEventHost.d.ts

@@ -0,0 +1,15 @@
+import { EventHostImpl } from '@amazon/vinyl-util';
+/**
+ * MockEventHost creates spies with pass-through calls to the EventHost implementation.
+ * While this is not a true mock, events become easier to test when using a real event dispatcher.
+ */
+export declare class MockEventHost<EventMap = any> extends EventHostImpl<EventMap> {
+    private readonly spyFactory;
+    logPrefix: string;
+    hasAnyListeners: import("@amazon/vinyl-util/browserTestUtil").Spy2<(() => boolean) & (() => any)>;
+    hasListeners: import("@amazon/vinyl-util/browserTestUtil").Spy2<((type: keyof EventMap) => boolean) & ((type: keyof EventMap) => any)>;
+    dispatch: import("@amazon/vinyl-util/browserTestUtil").Spy2<(<K extends keyof EventMap>(type: K, event: EventMap[K]) => void)>;
+    on: import("@amazon/vinyl-util/browserTestUtil").Spy2<(<K extends keyof EventMap>(type: K, handler: import("@amazon/vinyl-util").EventHandler<EventMap[K]>, options?: import("@amazon/vinyl-util").SignalOptions) => import("@amazon/vinyl-util").Unsubscribe) & ((type: keyof EventMap, handler: import("@amazon/vinyl-util").EventHandler<EventMap[keyof EventMap]>, options?: import("@amazon/vinyl-util").SignalOptions | undefined) => any)>;
+    dispose: import("@amazon/vinyl-util/browserTestUtil").Spy2<() => void>;
+}
+//# sourceMappingURL=MockEventHost.d.ts.map

package/dist/testUtil/types/ts4.7/mock/event/emptyLogTarget.d.ts

@@ -0,0 +1,3 @@
+import type { LogTarget } from '@amazon/vinyl-util';
+export declare const emptyLogTarget: LogTarget;
+//# sourceMappingURL=emptyLogTarget.d.ts.map

package/dist/testUtil/types/ts4.7/mock/logging/MockLogger.d.ts

@@ -0,0 +1,18 @@
+import type { LogEventMap, Logger, LogTarget } from '@amazon/vinyl-util';
+import { LogLevel } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+type LogFilterFun = (target: LogTarget, ...messages: any[]) => void;
+export declare class MockLogger extends MockEventHost<LogEventMap> implements Logger {
+    logLevel: LogLevel;
+    log: jasmine.Spy<(target: LogTarget, level: LogLevel, ...messages: readonly any[]) => void>;
+    verbose: jasmine.Spy<LogFilterFun>;
+    debug: jasmine.Spy<LogFilterFun>;
+    info: jasmine.Spy<LogFilterFun>;
+    warn: jasmine.Spy<LogFilterFun>;
+    error: jasmine.Spy<LogFilterFun>;
+}
+export declare function useMockLogger(): {
+    readonly value: MockLogger;
+};
+export {};
+//# sourceMappingURL=MockLogger.d.ts.map

package/dist/testUtil/types/ts4.7/mock/navigator/setMockNavigator.d.ts

@@ -0,0 +1,7 @@
+import { MockNavigator } from '@amazon/vinyl-util/browserTestUtil';
+/**
+ * Sets the global navigator to a Mock
+ * Returns the new MockNavigator instance.
+ */
+export declare function setMockNavigator(): MockNavigator;
+//# sourceMappingURL=setMockNavigator.d.ts.map

package/dist/testUtil/types/ts4.7/mock/network/MockNetworkInformation.d.ts

@@ -0,0 +1,10 @@
+import type { NetworkInformation, NetworkInformationEffectiveType, NetworkInformationType } from '@amazon/vinyl-util';
+import { MockEventTarget } from '@amazon/vinyl-util/browserTestUtil';
+export declare class MockNetworkInformation extends MockEventTarget implements NetworkInformation {
+    downlink: number | undefined;
+    effectiveType: NetworkInformationEffectiveType;
+    rtt: number;
+    saveData: boolean;
+    type?: NetworkInformationType;
+}
+//# sourceMappingURL=MockNetworkInformation.d.ts.map

package/dist/testUtil/types/ts4.7/mock/network/MockNetworkMetricsController.d.ts

@@ -0,0 +1,10 @@
+import type { NetworkMetrics, NetworkMetricsController, NetworkMetricsEventMap } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+export declare class MockNetworkMetricsController extends MockEventHost<NetworkMetricsEventMap> implements NetworkMetricsController {
+    maxHistorySize: number;
+    metrics: NetworkMetrics;
+    addMetricsEntry: import("@amazon/vinyl-util/browserTestUtil").Spy2<(entry: import("@amazon/vinyl-util").NetworkMetricsEntry) => void>;
+    getServiceMetrics: import("@amazon/vinyl-util/browserTestUtil").Spy2<((serviceId: import("@amazon/vinyl-util").Maybe<string>) => import("@amazon/vinyl-util").ServiceMetrics) & ((serviceId: import("@amazon/vinyl-util").Maybe<string>) => any)>;
+    addDownlinkTransferEntry: import("@amazon/vinyl-util/browserTestUtil").Spy2<(entry: import("@amazon/vinyl-util").NetworkTransferEntry) => void>;
+}
+//# sourceMappingURL=MockNetworkMetricsController.d.ts.map

package/dist/testUtil/types/ts4.7/mock/network/MockNetworkState.d.ts

@@ -0,0 +1,7 @@
+import type { NetworkState, NetworkStateEventMap } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+export declare class MockNetworkState extends MockEventHost<NetworkStateEventMap> implements NetworkState {
+    onLine: boolean;
+    nextOnLine: import("@amazon/vinyl-util/browserTestUtil").Spy2<((abort?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").ReadonlyAbort>) => Promise<void>) & ((abort?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").ReadonlyAbort>) => any)>;
+}
+//# sourceMappingURL=MockNetworkState.d.ts.map

package/dist/testUtil/types/ts4.7/mock/network/MockRequester.d.ts

@@ -0,0 +1,6 @@
+import type { Requester, RequesterImplEventMap } from '@amazon/vinyl-util';
+import { MockEventHost } from '../../mock/event/MockEventHost';
+export declare class MockRequester extends MockEventHost<RequesterImplEventMap> implements Requester {
+    request: import("@amazon/vinyl-util/browserTestUtil").Spy2<((input: RequestInfo | Readonly<URL>, init?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").RequestInitOptions>, requestOptions?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").RequestOptions>) => Promise<Response>) & ((input: RequestInfo | Readonly<URL>, init?: import("@amazon/vinyl-util").Maybe<Readonly<Omit<RequestInit, "signal">>>, requestOptions?: import("@amazon/vinyl-util").Maybe<import("@amazon/vinyl-util").RequestOptions>) => any)>;
+}
+//# sourceMappingURL=MockRequester.d.ts.map

package/dist/testUtil/types/ts4.7/mock/network/emptyRequestInfo.d.ts

@@ -0,0 +1,10 @@
+import { type FetchRequestInfo, type RequestAttemptInfo, type RequestCaughtErrorEvent, type RequestNetworkErrorEvent, type RequestResponseErrorEvent, type RequestSuccessEvent, type ResponseInfo } from '@amazon/vinyl-util';
+export declare const emptyRequestInfo: FetchRequestInfo;
+export declare const emptyRequestAttemptInfo: RequestAttemptInfo;
+export declare const emptyResponseInfo: ResponseInfo;
+export declare const emptyRequestSuccessEvent: RequestSuccessEvent;
+export declare const emptyInternalError: RequestCaughtErrorEvent;
+export declare const emptyNetworkError: RequestNetworkErrorEvent;
+export declare const emptyResponseError: RequestResponseErrorEvent;
+export declare const emptyAbortError: RequestCaughtErrorEvent;
+//# sourceMappingURL=emptyRequestInfo.d.ts.map

package/dist/testUtil/types/ts4.7/mock/persistence/MockPersistence.d.ts

@@ -0,0 +1,9 @@
+import type { KeyValuePersistence } from '@amazon/vinyl-util';
+export declare class MockPersistence<T = any> implements KeyValuePersistence<T> {
+    private readonly spyFactory;
+    clear: import("@amazon/vinyl-util/browserTestUtil").Spy2<(() => Promise<void>) & (() => any)>;
+    get: import("@amazon/vinyl-util/browserTestUtil").Spy2<((key: string) => Promise<T | null>) & ((key: string) => any)>;
+    remove: import("@amazon/vinyl-util/browserTestUtil").Spy2<((key: string) => Promise<void>) & ((key: string) => any)>;
+    set: import("@amazon/vinyl-util/browserTestUtil").Spy2<((key: string, value: T) => Promise<void>) & ((key: string, value: T) => any)>;
+}
+//# sourceMappingURL=MockPersistence.d.ts.map

package/dist/testUtil/types/ts4.7/mock/util/spyOnPropertySafe.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A wrapper to jasmine spyOnProperty for property getters that will define property
+ * if it doesn't exist.
+ */
+export declare function spyOnPropertySafe<T extends object, K extends keyof T = keyof T>(object: T, property: K): jasmine.Spy<(this: T) => T[K]>;
+//# sourceMappingURL=spyOnPropertySafe.d.ts.map

package/dist/testUtil/types/ts4.7/patch/addPatchTests.d.ts

@@ -0,0 +1,35 @@
+import type { PatchedRef } from '@amazon/vinyl-util';
+export interface PatchTestOptions<T> {
+    /**
+     * True if the patch is enabled by default.
+     */
+    actualFlag: boolean | undefined;
+    /**
+     * The target, not patched.
+     */
+    target: T;
+    /**
+     * The patched target.
+     */
+    patchedRef: PatchedRef<T>;
+    /**
+     * Runs the scenario to reproduce the issue on the target.
+     * @param target
+     */
+    canReproduce: (target: T) => Promise<boolean>;
+    /**
+     * If true and the tested flag is true but the issue cannot be reproduced, then only a
+     * warning is logged, if false, then the test will be marked as a failure.
+     */
+    allowFalseNegative: boolean;
+}
+/**
+ * Adds tests to ensure that a patch flag is enabled when the issue can be reproduced for the UA,
+ * and when the patch is applied the issue is no longer reproducible.
+ *
+ * @param flagName The flag name, used in test descriptions.
+ * @param description The condition which requires the patch to be enabled.
+ * @param optionsProvider
+ */
+export declare function addPatchTests<T>(flagName: string, description: string, optionsProvider: () => PatchTestOptions<T>): void;
+//# sourceMappingURL=addPatchTests.d.ts.map

package/dist/testUtil/types/ts4.7/reporters/LogReporter.d.ts

@@ -0,0 +1,57 @@
+import CustomReporter = jasmine.CustomReporter;
+import JasmineDoneInfo = jasmine.JasmineDoneInfo;
+import JasmineStartedInfo = jasmine.JasmineStartedInfo;
+import SpecResult = jasmine.SpecResult;
+import { LogLevel, type ReadonlyDate } from '@amazon/vinyl-util';
+export interface LogReporterStartedEvent {
+    readonly totalSpecs: number;
+}
+export interface LogReporterProgressEvent {
+    readonly totalCompleted: number;
+    readonly totalSpecs: number;
+    readonly logs: readonly LogEntry[];
+}
+export interface LogReporterDoneEvent {
+    readonly overallStatus: 'passed' | 'failed';
+    readonly totalCompleted: number;
+    readonly totalSpecs: number;
+    readonly reason: string;
+}
+export interface LogEntry {
+    readonly timestamp: ReadonlyDate;
+    readonly messages: readonly any[];
+    readonly level: LogLevel;
+}
+export declare abstract class LogReporter implements CustomReporter {
+    /**
+     * The first failed spec.
+     *
+     * Jasmine's spec result in `jasmineDone` does not provide these correctly in
+     * failedExpectations, save this from `specDone`.
+     */
+    private failedResult;
+    private totalSpecs;
+    private totalCompleted;
+    /**
+     * The timestamp of the last progress update.
+     */
+    protected lastProgressTimestamp: number;
+    protected updateInterval: number;
+    protected maxLogsBuffer: number;
+    private consoleInterceptor;
+    private readonly logs;
+    protected constructor();
+    jasmineStarted(suiteInfo: JasmineStartedInfo): void;
+    protected abstract onStarted(action: LogReporterStartedEvent): Promise<void>;
+    specDone(result: SpecResult): void;
+    jasmineDone(runDetails: JasmineDoneInfo): void;
+    /**
+     * If there has not been a progress update within `updateInterval`, emit another progress
+     * event.
+     * @private
+     */
+    private maybeReportProgress;
+    protected abstract onProgress(action: LogReporterProgressEvent): Promise<void>;
+    protected abstract onDone(action: LogReporterDoneEvent): Promise<void>;
+}
+//# sourceMappingURL=LogReporter.d.ts.map

package/dist/testUtil/types/ts4.7/reporters/RestApiReporter.d.ts

@@ -0,0 +1,23 @@
+import { type LogReporterProgressEvent, LogReporter, type LogReporterDoneEvent, type LogReporterStartedEvent } from '../reporters/LogReporter';
+export declare class RestApiReporter extends LogReporter {
+    private readonly reportApi;
+    /**
+     * Installs this reporter if this is a Browser environment and the report api has been provided as a query
+     * parameter.
+     * @param searchParam
+     */
+    static installFromSearchParam(searchParam?: string): void;
+    constructor(reportApi: string);
+    protected onStarted(action: LogReporterStartedEvent): Promise<void>;
+    protected onProgress(action: LogReporterProgressEvent): Promise<void>;
+    protected onDone(action: LogReporterDoneEvent): Promise<void>;
+    /**
+     * If the reportApi url was set in the URL parameters, report to that URL the test progress.
+     *
+     * @param action One of: 'started', 'progress', or 'done'
+     * @param body
+     * @private
+     */
+    private doRequest;
+}
+//# sourceMappingURL=RestApiReporter.d.ts.map

package/dist/testUtil/types/ts4.7/util/event/createEventSpy.d.ts

@@ -0,0 +1,31 @@
+import type { Disposable, EventHandler, Fun, ReadonlyEventHost } from '@amazon/vinyl-util';
+import Spy = jasmine.Spy;
+/**
+ * A Spy that provides a way to promisify the next call and unsubscribe.
+ *
+ * Do not use `and` on an EventSpy, the callFake is used to provide the next promise.
+ */
+export interface EventSpy<EventMap, K extends keyof EventMap> extends Spy<EventHandler<EventMap[K]>>, Fun, Disposable {
+    /**
+     * Returns a promise that resolves when the event has next been dispatched, or rejects
+     * if timeout has elapsed.
+     *
+     * @param timeout The number of seconds before a timeout.
+     * @param timeoutMessage An optional timeout message to use instead of the default.
+     *  This may use two tokens:
+     *   {0} - The event type.
+     *   {1} - Number of seconds before the timeout.
+     */
+    next(timeout?: number, timeoutMessage?: string): Promise<EventMap[K]>;
+}
+/**
+ * Adds a listener to an event host, returning a spy for assertions.
+ *
+ * The returned spy provides a `next` function to promisify the next call and a `dispose` function
+ * to unsubscribe.
+ *
+ * @param host
+ * @param type
+ */
+export declare function createEventSpy<EventMap, K extends keyof EventMap>(host: ReadonlyEventHost<EventMap>, type: K): EventSpy<EventMap, K>;
+//# sourceMappingURL=createEventSpy.d.ts.map

package/dist/testUtil/types/ts4.7/util/initializeUncaughtErrorLogging.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Logs uncaught errors and promise rejections to the console, to be emitted to the report api.
+ * Jasmine catches uncaught errors and only reports the message in the test failure, not the whole error event.
+ */
+export declare function initializeUncaughtErrorLogging(): void;
+//# sourceMappingURL=initializeUncaughtErrorLogging.d.ts.map

package/dist/types/current/client/Version.d.ts

@@ -0,0 +1,38 @@
+import type { Comparator } from '../util/comparison/compare';
+import type { Maybe } from '../util/type';
+/**
+ * An object representing a version.
+ */
+export interface Version {
+    readonly str: string;
+    readonly major: number;
+    readonly minor: number | null;
+    readonly patch: number | null;
+    readonly build: number | null;
+}
+/**
+ * A comparator for Version objects.
+ * This strict comparator will consider 1.0.0 > 1.0. Use {@link compareVersions} if null
+ * segments should be treated as zero values.
+ * Use this comparator when stable sorting.
+ */
+export declare const compareVersionsStrict: Comparator<Version | null>;
+/**
+ * A comparator for Version objects.
+ * Unlike {@link compareVersionsStrict}, 1.0.0.0 === 1.
+ * Use this comparator when comparing two versions and order does not need to be stable.
+ */
+export declare const compareVersions: Comparator<Version | null>;
+/**
+ * Given a string containing a semver-like version string, finds and returns the parsed Version.
+ *
+ * @param str
+ */
+export declare function parseVersion(str: string): Version;
+/**
+ * Given a string containing a semver-like version string, finds and returns the parsed Version.
+ *
+ * @param str
+ */
+export declare function parseVersion(str: Maybe<string>): Version | null;
+//# sourceMappingURL=Version.d.ts.map

package/dist/types/current/client/Version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Version.d.ts","sourceRoot":"","sources":["../../../../src/client/Version.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAE3D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAGxC;;GAEG;AACH,MAAM,WAAW,OAAO;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;CAChC;AAED;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,EAAE,UAAU,CAAC,OAAO,GAAG,IAAI,CAOxD,CAAA;AAEL;;;;GAIG;AACH,eAAO,MAAM,eAAe,EAAE,UAAU,CAAC,OAAO,GAAG,IAAI,CAKtD,CAAA;AAID;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;AAElD;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,GAAG,IAAI,CAAA"}

package/dist/types/current/client/Version.js

@@ -0,0 +1,40 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { compareBy } from '../util/comparison/compare';
+import { parseIntSafe } from '../util/serialization/primitives';
+/**
+ * A comparator for Version objects.
+ * This strict comparator will consider 1.0.0 > 1.0. Use {@link compareVersions} if null
+ * segments should be treated as zero values.
+ * Use this comparator when stable sorting.
+ */
+export const compareVersionsStrict = compareBy((v) => v.major, (v) => v.minor, (v) => v.patch, (v) => v.build, (v) => v.str);
+/**
+ * A comparator for Version objects.
+ * Unlike {@link compareVersionsStrict}, 1.0.0.0 === 1.
+ * Use this comparator when comparing two versions and order does not need to be stable.
+ */
+export const compareVersions = compareBy((v) => v.major, (v) => v.minor ?? 0, (v) => v.patch ?? 0, (v) => v.build ?? 0);
+const versionRegex = /(\b\w*\d(?:[._-]\d+)*[\w-._]*)/;
+/**
+ * Given a string containing a semver-like version string, finds and returns the parsed Version.
+ *
+ * @param str
+ */
+export function parseVersion(str) {
+    if (!str)
+        return null;
+    const match = versionRegex.exec(str);
+    if (!match)
+        return null;
+    const parts = match[0].match(/\d+/g);
+    return {
+        str: match[0],
+        major: parseInt(parts[0]),
+        minor: parseIntSafe(parts[1]),
+        patch: parseIntSafe(parts[2]),
+        build: parseIntSafe(parts[3]),
+    };
+}

package/dist/types/current/client/userAgent/UserAgentInfo.d.ts

@@ -0,0 +1,36 @@
+import type { Version } from '../../client/Version';
+/**
+ * A parsed user agent.
+ */
+export interface UserAgentInfo {
+    readonly userAgent: string;
+    readonly browser: UaSystemInfo | null;
+    readonly browserLike: UaSystemInfo | null;
+    readonly device: UaDeviceInfo | null;
+    readonly os: UaSystemInfo | null;
+    readonly osLike: UaSystemInfo | null;
+}
+/**
+ * Platform or system information.
+ */
+export interface UaSystemInfo {
+    readonly name: string;
+    readonly version: Version | null;
+}
+/**
+ * Device information from the user agent.
+ */
+export interface UaDeviceInfo {
+    readonly vendor: string | null;
+    readonly model: string | null;
+    readonly type: string | null;
+}
+export declare const emptyUserAgentInfo: {
+    readonly userAgent: "";
+    readonly browser: null;
+    readonly browserLike: null;
+    readonly os: null;
+    readonly osLike: null;
+    readonly device: null;
+};
+//# sourceMappingURL=UserAgentInfo.d.ts.map

package/dist/types/current/client/userAgent/UserAgentInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UserAgentInfo.d.ts","sourceRoot":"","sources":["../../../../../src/client/userAgent/UserAgentInfo.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,CAAA;IACrC,QAAQ,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAAA;IACzC,QAAQ,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;IACpC,QAAQ,CAAC,EAAE,EAAE,YAAY,GAAG,IAAI,CAAA;IAChC,QAAQ,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAC/B;AAED,eAAO,MAAM,kBAAkB;;;;;;;CAOG,CAAA"}

package/dist/types/current/client/userAgent/UserAgentInfo.js

@@ -0,0 +1,12 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export const emptyUserAgentInfo = {
+    userAgent: '',
+    browser: null,
+    browserLike: null,
+    os: null,
+    osLike: null,
+    device: null,
+};

package/dist/types/current/client/userAgent/defaultUserAgentRules.d.ts

@@ -0,0 +1,94 @@
+import type { UserAgentRules } from './tokenizeUserAgent';
+/**
+ * An enumeration of operating systems that can be detected from the user agent.
+ */
+export declare enum Os {
+    ANDROID = "Android",
+    ANDROID_OSP = "Android OSP",
+    CHROME_OS = "chromeOS",
+    CHROMECAST = "Chromecast",
+    FEDORA = "Fedora",
+    FIREFOX_OS = "Firefox OS",// Firefox OS (legacy) does not have a differentiable user agent
+    FIRE_OS = "Fire OS",
+    FREE_BSD = "FreeBSD",
+    HARMONY_OS = "HarmonyOS",
+    I_OS = "iOS",
+    KAIOS = "KaiOS",// Based on the discontinued Firefox OS
+    LINUX = "Linux",
+    MAC_OS = "macOS",
+    MIUI = "MIUI",
+    ORBIS = "Orbis OS",
+    SMART_CAST = "SmartCast",
+    SYMBIAN = "Symbian",
+    TIZEN = "Tizen",
+    UBUNTU = "Ubuntu",
+    VEGA = "Vega",
+    WEB_OS = "webOS",
+    WINDOWS = "Windows",
+    WINDOWS_PHONE = "Windows Phone"
+}
+/**
+ * An enumeration of browsers that can be detected from the user agent.
+ */
+export declare enum Browser {
+    BRAVE = "Brave",
+    CHROME = "Chrome",
+    CHROME_HEADLESS = "Chrome Headless",
+    CHROMIUM = "Chromium",
+    DUCK_DUCK_GO = "DuckDuckGo",
+    EDGE_CHROMIUM = "Edge Chromium",
+    EDGE_LEGACY = "Edge Legacy",
+    ELECTRON = "Electron",
+    FIREFOX = "Firefox",
+    HUAWEI = "Huawei",
+    IE = "IE",
+    IE_MOBILE = "IE Mobile",// AKA Pocket Internet Explorer
+    OCULUS = "Oculus Browser",
+    OPENWAVE = "Openwave",
+    OPERA = "Opera",
+    OPERA_TOUCH = "Opera Touch",
+    QUARK = "Quark",
+    SILK = "Silk",
+    SAFARI = "Safari",
+    SAMSUNG_BROWSER = "Samsung Browser",
+    UC_BROWSER = "UC Browser",
+    WPE = "WPE WebKit",
+    YANDEX = "Yandex",
+    WEBKIT = "WebKit"
+}
+export declare enum DeviceVendor {
+    AMAZON = "Amazon",
+    APPLE = "Apple",
+    FACEBOOK = "Facebook",
+    GOOGLE = "Google",
+    HISENSE = "Hisense",
+    HTC = "HTC",
+    HUAWEI = "Huawei",
+    K = "K",
+    LG = "LG",
+    MEIZU = "Meizu",
+    MICROSOFT = "Microsoft",
+    MOTOROLA = "Motorola",
+    NINTENDO = "Nintendo",
+    NOKIA = "Nokia",
+    NVIDIA = "Nvidia",
+    ONE_PLUS = "OnePlus",
+    OPPO = "OPPO",
+    ROKU = "Roku",
+    SAMSUNG = "Samsung",
+    SKY = "Sky",
+    SKY_DEVICES = "SKY Devices",// Not related to the set-top boxes.
+    SONY = "Sony",
+    TESLA = "Tesla",
+    VIZIO = "VIZIO"
+}
+export declare enum DeviceType {
+    AUTOMOTIVE = "automotive",
+    CONSOLE = "console",
+    DESKTOP = "desktop",
+    SMART_TV = "smarttv",
+    MOBILE = "mobile",
+    WEARABLE = "wearable"
+}
+export declare const defaultUserAgentRules: UserAgentRules;
+//# sourceMappingURL=defaultUserAgentRules.d.ts.map

package/dist/types/current/client/userAgent/defaultUserAgentRules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultUserAgentRules.d.ts","sourceRoot":"","sources":["../../../../../src/client/userAgent/defaultUserAgentRules.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAWzD;;GAEG;AACH,oBAAY,EAAE;IACV,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC3B,SAAS,aAAa;IACtB,UAAU,eAAe;IACzB,MAAM,WAAW;IACjB,UAAU,eAAe,CAAE,gEAAgE;IAC3F,OAAO,YAAY;IACnB,QAAQ,YAAY;IACpB,UAAU,cAAc;IACxB,IAAI,QAAQ;IACZ,KAAK,UAAU,CAAE,uCAAuC;IACxD,KAAK,UAAU;IACf,MAAM,UAAU;IAChB,IAAI,SAAS;IACb,KAAK,aAAa;IAClB,UAAU,cAAc;IACxB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,MAAM,UAAU;IAChB,OAAO,YAAY;IACnB,aAAa,kBAAkB;CAClC;AAED;;GAEG;AACH,oBAAY,OAAO;IACf,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,eAAe,oBAAoB;IACnC,QAAQ,aAAa;IACrB,YAAY,eAAe;IAC3B,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,EAAE,OAAO;IACT,SAAS,cAAc,CAAE,+BAA+B;IACxD,MAAM,mBAAmB;IACzB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,eAAe,oBAAoB;IACnC,UAAU,eAAe;IACzB,GAAG,eAAe;IAClB,MAAM,WAAW;IACjB,MAAM,WAAW;CACpB;AAED,oBAAY,YAAY;IACpB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,GAAG,QAAQ;IACX,MAAM,WAAW;IACjB,CAAC,MAAM;IACP,EAAE,OAAO;IACT,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,QAAQ,YAAY;IACpB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,GAAG,QAAQ;IACX,WAAW,gBAAgB,CAAE,oCAAoC;IACjE,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;CAClB;AAED,oBAAY,UAAU;IAClB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,QAAQ,YAAY;IACpB,MAAM,WAAW;IACjB,QAAQ,aAAa;CACxB;AAED,eAAO,MAAM,qBAAqB,EAAE,cAsLnC,CAAA"}