@fluid-internal/client-utils 2.0.0-dev.7.2.0.203917 → 2.0.0-dev.7.2.0.205722

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluid-internal/client-utils",
-  "version": "2.0.0-dev.7.2.0.203917",
+  "version": "2.0.0-dev.7.2.0.205722",
   "description": "Not intended for use outside the Fluid Framework.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -39,8 +39,8 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluidframework/core-interfaces": "2.0.0-dev.7.2.0.203917",
-    "@fluidframework/core-utils": "2.0.0-dev.7.2.0.203917",
+    "@fluidframework/core-interfaces": "2.0.0-dev.7.2.0.205722",
+    "@fluidframework/core-utils": "2.0.0-dev.7.2.0.205722",
     "@types/events": "^3.0.0",
     "base64-js": "^1.5.1",
     "buffer": "^6.0.3",
@@ -49,11 +49,11 @@
     "sha.js": "^2.4.11"
   },
   "devDependencies": {
-    "@fluid-tools/build-cli": "0.26.0-203096",
-    "@fluidframework/build-common": "^2.0.2",
-    "@fluidframework/build-tools": "0.26.0-203096",
+    "@fluid-tools/build-cli": "^0.26.1",
+    "@fluidframework/build-common": "^2.0.3",
+    "@fluidframework/build-tools": "^0.26.1",
     "@fluidframework/eslint-config-fluid": "^3.0.0",
-    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.2.0.203917",
+    "@fluidframework/mocha-test-setup": "2.0.0-dev.7.2.0.205722",
     "@microsoft/api-extractor": "^7.37.0",
     "@types/base64-js": "^1.3.0",
     "@types/jest": "29.5.3",
@@ -119,7 +119,7 @@
     "build:test:mocha": "tsc --project ./src/test/mocha/tsconfig.json",
     "build:test:types": "tsc --project ./src/test/types/tsconfig.json",
     "ci:build:docs": "api-extractor run",
-    "clean": "rimraf --glob '_api-extractor-temp' 'dist' 'lib' '*.tsbuildinfo' '*.build.log' 'nyc'",
+    "clean": "rimraf --glob _api-extractor-temp dist lib \"*.tsbuildinfo\" \"*.build.log\" nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run prettier:fix",

package/dist/client-utils-alpha.d.ts

@@ -1,46 +0,0 @@
-import { EventEmitter } from 'events';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IEventTransformer } from '@fluidframework/core-interfaces';
-import { TransformedEvent } from '@fluidframework/core-interfaces';
-
-/* Excluded from this release type: Buffer */
-
-/* Excluded from this release type: bufferToString */
-
-/* Excluded from this release type: EventEmitterEventType */
-
-/* Excluded from this release type: EventForwarder */
-
-/* Excluded from this release type: fromBase64ToUtf8 */
-
-/* Excluded from this release type: fromUtf8ToBase64 */
-
-/* Excluded from this release type: gitHashFile */
-
-/* Excluded from this release type: hashFile */
-
-/* Excluded from this release type: IsoBuffer */
-
-/* Excluded from this release type: IsomorphicPerformance */
-
-/* Excluded from this release type: ITraceEvent */
-
-/* Excluded from this release type: performance_2 */
-
-/* Excluded from this release type: stringToBuffer */
-
-/* Excluded from this release type: toUtf8 */
-
-/* Excluded from this release type: Trace */
-
-/* Excluded from this release type: TypedEventEmitter */
-
-/* Excluded from this release type: TypedEventTransform */
-
-/* Excluded from this release type: Uint8ArrayToArrayBuffer */
-
-/* Excluded from this release type: Uint8ArrayToString */
-
-export { }

package/dist/client-utils-beta.d.ts

@@ -1,46 +0,0 @@
-import { EventEmitter } from 'events';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IEventTransformer } from '@fluidframework/core-interfaces';
-import { TransformedEvent } from '@fluidframework/core-interfaces';
-
-/* Excluded from this release type: Buffer */
-
-/* Excluded from this release type: bufferToString */
-
-/* Excluded from this release type: EventEmitterEventType */
-
-/* Excluded from this release type: EventForwarder */
-
-/* Excluded from this release type: fromBase64ToUtf8 */
-
-/* Excluded from this release type: fromUtf8ToBase64 */
-
-/* Excluded from this release type: gitHashFile */
-
-/* Excluded from this release type: hashFile */
-
-/* Excluded from this release type: IsoBuffer */
-
-/* Excluded from this release type: IsomorphicPerformance */
-
-/* Excluded from this release type: ITraceEvent */
-
-/* Excluded from this release type: performance_2 */
-
-/* Excluded from this release type: stringToBuffer */
-
-/* Excluded from this release type: toUtf8 */
-
-/* Excluded from this release type: Trace */
-
-/* Excluded from this release type: TypedEventEmitter */
-
-/* Excluded from this release type: TypedEventTransform */
-
-/* Excluded from this release type: Uint8ArrayToArrayBuffer */
-
-/* Excluded from this release type: Uint8ArrayToString */
-
-export { }

package/dist/client-utils-public.d.ts

@@ -1,46 +0,0 @@
-import { EventEmitter } from 'events';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IEventTransformer } from '@fluidframework/core-interfaces';
-import { TransformedEvent } from '@fluidframework/core-interfaces';
-
-/* Excluded from this release type: Buffer */
-
-/* Excluded from this release type: bufferToString */
-
-/* Excluded from this release type: EventEmitterEventType */
-
-/* Excluded from this release type: EventForwarder */
-
-/* Excluded from this release type: fromBase64ToUtf8 */
-
-/* Excluded from this release type: fromUtf8ToBase64 */
-
-/* Excluded from this release type: gitHashFile */
-
-/* Excluded from this release type: hashFile */
-
-/* Excluded from this release type: IsoBuffer */
-
-/* Excluded from this release type: IsomorphicPerformance */
-
-/* Excluded from this release type: ITraceEvent */
-
-/* Excluded from this release type: performance_2 */
-
-/* Excluded from this release type: stringToBuffer */
-
-/* Excluded from this release type: toUtf8 */
-
-/* Excluded from this release type: Trace */
-
-/* Excluded from this release type: TypedEventEmitter */
-
-/* Excluded from this release type: TypedEventTransform */
-
-/* Excluded from this release type: Uint8ArrayToArrayBuffer */
-
-/* Excluded from this release type: Uint8ArrayToString */
-
-export { }

package/dist/client-utils-untrimmed.d.ts

@@ -1,241 +0,0 @@
-import { EventEmitter } from 'events';
-import { IDisposable } from '@fluidframework/core-interfaces';
-import { IEvent } from '@fluidframework/core-interfaces';
-import { IEventProvider } from '@fluidframework/core-interfaces';
-import { IEventTransformer } from '@fluidframework/core-interfaces';
-import { TransformedEvent } from '@fluidframework/core-interfaces';
-
-/**
- * Declare the subset of Buffer functionality we want to make available instead of
- * exposing the entirely of Node's typings.  This should match the public interface
- * of the browser implementation, so any changes made in one should be made in both.
- *
- * @internal
- */
-export declare class Buffer extends Uint8Array {
-    toString(encoding?: "utf8" | "utf-8" | "base64"): string;
-    /**
-     * Static constructor
-     *
-     * @param value - (string | ArrayBuffer).
-     * @param encodingOrOffset - (string | number).
-     * @param length - (number).
-     *
-     * @privateRemarks TODO: Use actual types
-     */
-    static from(value: unknown, encodingOrOffset?: unknown, length?: unknown): IsoBuffer;
-    static isBuffer(obj: unknown): obj is Buffer;
-}
-
-/**
- * Convert binary blob to string format
- *
- * @param blob - The binary blob
- * @param encoding - Output string's encoding
- * @returns The blob in string format
- *
- * @internal
- */
-export declare const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;
-
-/**
- * The event emitter polyfill and the node event emitter have different event types:
- * string | symbol vs. string | number
- *
- * This type allow us to correctly handle either type
- *
- * @internal
- */
-export declare type EventEmitterEventType = EventEmitter extends {
-    on(event: infer E, listener: any): any;
-} ? E : never;
-
-/**
- * Base class used for forwarding events from a source EventEmitter.
- * This can be useful when all arbitrary listeners need to be removed,
- * but the primary source needs to stay intact.
- *
- * @internal
- */
-export declare class EventForwarder<TEvent = IEvent> extends TypedEventEmitter<TEvent> implements IDisposable {
-    protected static isEmitterEvent(event: string): boolean;
-    private static readonly newListenerEvent;
-    private static readonly removeListenerEvent;
-    /**
-     * {@inheritDoc @fluidframework/core-interfaces#IDisposable.disposed}
-     */
-    get disposed(): boolean;
-    private isDisposed;
-    private readonly forwardingEvents;
-    constructor(source?: EventEmitter | IEventProvider<TEvent & IEvent>);
-    /**
-     * {@inheritDoc @fluidframework/core-interfaces#IDisposable.dispose}
-     */
-    dispose(): void;
-    protected forwardEvent(source: EventEmitter | IEventProvider<TEvent & IEvent>, ...events: string[]): void;
-    protected unforwardEvent(source: EventEmitter | IEventProvider<TEvent & IEvent>, ...events: string[]): void;
-}
-
-/**
- * Converts the provided {@link https://en.wikipedia.org/wiki/Base64 | base64}-encoded string
- * to {@link https://en.wikipedia.org/wiki/UTF-8 | utf-8}.
- *
- * @internal
- */
-export declare const fromBase64ToUtf8: (input: string) => string;
-
-/**
- * Converts the provided {@link https://en.wikipedia.org/wiki/UTF-8 | utf-8}-encoded string
- * to {@link https://en.wikipedia.org/wiki/Base64 | base64}.
- *
- * @internal
- */
-export declare const fromUtf8ToBase64: (input: string) => string;
-
-/**
- * Create a github hash (Github hashes the string with blob and size)
- * Must be called under secure context for browsers
- *
- * @param file - The contents of the file in a buffer
- * @returns The sha1 hash of the content of the buffer with the `blob` prefix and size
- *
- * @internal
- */
-export declare function gitHashFile(file: IsoBuffer): Promise<string>;
-
-/**
- * Hash a file. Consistent within a session, but should not be persisted and
- * is not consistent with git.
- * If called under an insecure context for a browser, this will fallback to
- * using the node implementation.
- *
- * @param file - The contents of the file in a buffer.
- * @param algorithm - The hash algorithm to use, artificially constrained by what is used internally.
- * @param hashEncoding - The encoding of the returned hash, also artificially constrained.
- * @returns The hash of the content of the buffer.
- *
- * @internal
- */
-export declare function hashFile(file: IsoBuffer, algorithm?: "SHA-1" | "SHA-256", hashEncoding?: "hex" | "base64"): Promise<string>;
-
-/**
- * @internal
- */
-export declare const IsoBuffer: typeof Buffer;
-
-/**
- * @internal
- */
-export declare type IsoBuffer = Buffer;
-
-/**
- * This type contains all browser performance properties as optional, and some
- * of the intersecting properties of node and browser performance as required.
- *
- * @internal
- */
-export declare type IsomorphicPerformance = Partial<Performance> & Pick<Performance, "clearMarks" | "mark" | "measure" | "now">;
-
-/**
- * Event in a performance trace including time elapsed.
- *
- * @internal
- */
-export declare interface ITraceEvent {
-    /**
-     * Total time elapsed since the start of the Trace.
-     * Measured in milliseconds as a floating point with a decimal
-     */
-    readonly totalTimeElapsed: number;
-    /**
-     * Time elapsed since the last trace event.
-     * Measured in milliseconds as a floating point with a decimal
-     */
-    readonly duration: number;
-    /**
-     * This number represents a relative time which should
-     * be consistent for all trace ticks.
-     */
-    readonly tick: number;
-}
-
-/**
- * @internal
- */
-declare const performance_2: IsomorphicPerformance;
-export { performance_2 as performance }
-
-/**
- * Convert base64 or utf8 string to array buffer.
- * @param encoding - The input string's encoding.
- *
- * @internal
- */
-export declare function stringToBuffer(input: string, encoding: string): ArrayBufferLike;
-
-/**
- * Convenience function to convert unknown encoding to utf8 that avoids
- * buffer copies/encode ops when no conversion is needed.
- * @param input - The source string to convert.
- * @param encoding - The source string's encoding.
- *
- * @internal
- */
-export declare const toUtf8: (input: string, encoding: string) => string;
-
-/**
- * Helper class for tracing performance of events
- * Time measurements are in milliseconds as a floating point with a decimal
- *
- * @internal
- */
-export declare class Trace {
-    readonly startTick: number;
-    static start(): Trace;
-    protected lastTick: number;
-    protected constructor(startTick: number);
-    trace(): ITraceEvent;
-}
-
-/**
- * Event Emitter helper class the supports emitting typed events
- *
- * @internal
- */
-export declare class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
-    constructor();
-    readonly addListener: TypedEventTransform<this, TEvent>;
-    readonly on: TypedEventTransform<this, TEvent>;
-    readonly once: TypedEventTransform<this, TEvent>;
-    readonly prependListener: TypedEventTransform<this, TEvent>;
-    readonly prependOnceListener: TypedEventTransform<this, TEvent>;
-    readonly removeListener: TypedEventTransform<this, TEvent>;
-    readonly off: TypedEventTransform<this, TEvent>;
-}
-
-/**
- * @internal
- */
-export declare type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;
-
-/**
- * Converts a Uint8Array array to an ArrayBuffer.
- * @param array - Array to convert to ArrayBuffer.
- *
- * @internal
- */
-export declare function Uint8ArrayToArrayBuffer(array: Uint8Array): ArrayBuffer;
-
-/**
- * Converts a Uint8Array to a string of the provided encoding.
- * @remarks Useful when the array might be an IsoBuffer.
- * @param arr - The array to convert.
- * @param encoding - Optional target encoding; only "utf8" and "base64" are
- * supported, with "utf8" being default.
- * @returns The converted string.
- *
- * @internal
- */
-export declare function Uint8ArrayToString(arr: Uint8Array, encoding?: "utf8" | "utf-8" | "base64"): string;
-
-export { }