@fluid-internal/client-utils 2.0.0-dev-rc.5.0.0.265721 → 2.0.0-dev-rc.5.0.0.268409
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-extractor/api-extractor-lint-bundle.json +5 -0
- package/api-extractor/api-extractor-lint-indexBrowser.cjs.json +5 -0
- package/api-extractor/api-extractor-lint-indexBrowser.esm.json +5 -0
- package/api-extractor/api-extractor-lint-indexNode.cjs.json +5 -0
- package/api-extractor/api-extractor-lint-indexNode.esm.json +5 -0
- package/api-report/client-utils.alpha.api.md +47 -0
- package/api-report/client-utils.beta.api.md +19 -0
- package/api-report/client-utils.public.api.md +19 -0
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +15 -9
- package/api-report/client-utils.api.md +0 -111
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
|
|
4
|
+
"mainEntryPointFilePath": "<projectFolder>/dist/indexBrowser.d.ts"
|
|
5
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
|
|
4
|
+
"mainEntryPointFilePath": "<projectFolder>/lib/indexBrowser.d.ts"
|
|
5
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
|
|
4
|
+
"mainEntryPointFilePath": "<projectFolder>/dist/indexNode.d.ts"
|
|
5
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
|
3
|
+
"extends": "<projectFolder>/../../../common/build/build-common/api-extractor-lint.entrypoint.json",
|
|
4
|
+
"mainEntryPointFilePath": "<projectFolder>/lib/indexNode.d.ts"
|
|
5
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
## Alpha API Report File for "@fluid-internal/client-utils"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { EventEmitter } from 'events_pkg';
|
|
8
|
+
import { IEvent } from '@fluidframework/core-interfaces';
|
|
9
|
+
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
10
|
+
import { IEventTransformer } from '@fluidframework/core-interfaces';
|
|
11
|
+
import { TransformedEvent } from '@fluidframework/core-interfaces';
|
|
12
|
+
|
|
13
|
+
// @alpha
|
|
14
|
+
export const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;
|
|
15
|
+
|
|
16
|
+
export { EventEmitter }
|
|
17
|
+
|
|
18
|
+
// @alpha
|
|
19
|
+
export type EventEmitterEventType = string;
|
|
20
|
+
|
|
21
|
+
export { performance_2 as performance }
|
|
22
|
+
|
|
23
|
+
// @alpha
|
|
24
|
+
export class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
|
|
25
|
+
constructor();
|
|
26
|
+
// (undocumented)
|
|
27
|
+
readonly addListener: TypedEventTransform<this, TEvent>;
|
|
28
|
+
// (undocumented)
|
|
29
|
+
readonly off: TypedEventTransform<this, TEvent>;
|
|
30
|
+
// (undocumented)
|
|
31
|
+
readonly on: TypedEventTransform<this, TEvent>;
|
|
32
|
+
// (undocumented)
|
|
33
|
+
readonly once: TypedEventTransform<this, TEvent>;
|
|
34
|
+
// (undocumented)
|
|
35
|
+
readonly prependListener: TypedEventTransform<this, TEvent>;
|
|
36
|
+
// (undocumented)
|
|
37
|
+
readonly prependOnceListener: TypedEventTransform<this, TEvent>;
|
|
38
|
+
// (undocumented)
|
|
39
|
+
readonly removeListener: TypedEventTransform<this, TEvent>;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
// @alpha (undocumented)
|
|
43
|
+
export type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;
|
|
44
|
+
|
|
45
|
+
// (No @packageDocumentation comment for this package)
|
|
46
|
+
|
|
47
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
## Beta API Report File for "@fluid-internal/client-utils"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { EventEmitter } from 'events_pkg';
|
|
8
|
+
import { IEvent } from '@fluidframework/core-interfaces';
|
|
9
|
+
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
10
|
+
import { IEventTransformer } from '@fluidframework/core-interfaces';
|
|
11
|
+
import { TransformedEvent } from '@fluidframework/core-interfaces';
|
|
12
|
+
|
|
13
|
+
export { EventEmitter }
|
|
14
|
+
|
|
15
|
+
export { performance_2 as performance }
|
|
16
|
+
|
|
17
|
+
// (No @packageDocumentation comment for this package)
|
|
18
|
+
|
|
19
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
## Public API Report File for "@fluid-internal/client-utils"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
import { EventEmitter } from 'events_pkg';
|
|
8
|
+
import { IEvent } from '@fluidframework/core-interfaces';
|
|
9
|
+
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
10
|
+
import { IEventTransformer } from '@fluidframework/core-interfaces';
|
|
11
|
+
import { TransformedEvent } from '@fluidframework/core-interfaces';
|
|
12
|
+
|
|
13
|
+
export { EventEmitter }
|
|
14
|
+
|
|
15
|
+
export { performance_2 as performance }
|
|
16
|
+
|
|
17
|
+
// (No @packageDocumentation comment for this package)
|
|
18
|
+
|
|
19
|
+
```
|
package/lib/tsdoc-metadata.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fluid-internal/client-utils",
|
|
3
|
-
"version": "2.0.0-dev-rc.5.0.0.
|
|
3
|
+
"version": "2.0.0-dev-rc.5.0.0.268409",
|
|
4
4
|
"description": "Not intended for use outside the Fluid Framework.",
|
|
5
5
|
"homepage": "https://fluidframework.com",
|
|
6
6
|
"repository": {
|
|
@@ -81,8 +81,8 @@
|
|
|
81
81
|
"temp-directory": "nyc/.nyc_output"
|
|
82
82
|
},
|
|
83
83
|
"dependencies": {
|
|
84
|
-
"@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.
|
|
85
|
-
"@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.
|
|
84
|
+
"@fluidframework/core-interfaces": "2.0.0-dev-rc.5.0.0.268409",
|
|
85
|
+
"@fluidframework/core-utils": "2.0.0-dev-rc.5.0.0.268409",
|
|
86
86
|
"@types/events_pkg": "npm:@types/events@^3.0.0",
|
|
87
87
|
"base64-js": "^1.5.1",
|
|
88
88
|
"buffer": "^6.0.3",
|
|
@@ -92,17 +92,17 @@
|
|
|
92
92
|
},
|
|
93
93
|
"devDependencies": {
|
|
94
94
|
"@arethetypeswrong/cli": "^0.15.2",
|
|
95
|
-
"@biomejs/biome": "^1.
|
|
95
|
+
"@biomejs/biome": "^1.7.3",
|
|
96
96
|
"@fluid-internal/client-utils-previous": "npm:@fluid-internal/client-utils@2.0.0-rc.4.0.0",
|
|
97
|
-
"@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.
|
|
97
|
+
"@fluid-internal/mocha-test-setup": "2.0.0-dev-rc.5.0.0.268409",
|
|
98
98
|
"@fluid-tools/build-cli": "^0.39.0-264124",
|
|
99
99
|
"@fluidframework/build-common": "^2.0.3",
|
|
100
100
|
"@fluidframework/build-tools": "^0.39.0-264124",
|
|
101
|
-
"@fluidframework/eslint-config-fluid": "^5.
|
|
102
|
-
"@microsoft/api-extractor": "^7.
|
|
101
|
+
"@fluidframework/eslint-config-fluid": "^5.3.0",
|
|
102
|
+
"@microsoft/api-extractor": "^7.45.1",
|
|
103
103
|
"@types/base64-js": "^1.3.0",
|
|
104
104
|
"@types/jest": "29.5.3",
|
|
105
|
-
"@types/jest-environment-puppeteer": "2.0.0-dev-rc.5.0.0.
|
|
105
|
+
"@types/jest-environment-puppeteer": "2.0.0-dev-rc.5.0.0.268409",
|
|
106
106
|
"@types/mocha": "^9.1.1",
|
|
107
107
|
"@types/node": "^18.19.0",
|
|
108
108
|
"@types/rewire": "^2.5.28",
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
"sinon": "^17.0.1",
|
|
130
130
|
"ts-jest": "^29.1.1",
|
|
131
131
|
"ts-node": "^10.9.1",
|
|
132
|
-
"typescript": "~5.
|
|
132
|
+
"typescript": "~5.4.5"
|
|
133
133
|
},
|
|
134
134
|
"fluidBuild": {
|
|
135
135
|
"tasks": {
|
|
@@ -170,6 +170,12 @@
|
|
|
170
170
|
"build:test:mocha:esm": "tsc --project ./src/test/mocha/tsconfig.json",
|
|
171
171
|
"build:test:types": "tsc --project ./src/test/types/tsconfig.json",
|
|
172
172
|
"check:are-the-types-wrong": "attw --pack .",
|
|
173
|
+
"check:exports": "concurrently npm:check:exports:bundle-release-tags npm:check:exports:cjs:indexBrowser npm:check:exports:cjs:indexNode npm:check:exports:esm:indexBrowser npm:check:exports:esm:indexNode",
|
|
174
|
+
"check:exports:bundle-release-tags": "api-extractor run --config api-extractor/api-extractor-lint-bundle.json",
|
|
175
|
+
"check:exports:cjs:indexBrowser": "api-extractor run --config api-extractor/api-extractor-lint-indexBrowser.cjs.json",
|
|
176
|
+
"check:exports:cjs:indexNode": "api-extractor run --config api-extractor/api-extractor-lint-indexNode.cjs.json",
|
|
177
|
+
"check:exports:esm:indexBrowser": "api-extractor run --config api-extractor/api-extractor-lint-indexBrowser.esm.json",
|
|
178
|
+
"check:exports:esm:indexNode": "api-extractor run --config api-extractor/api-extractor-lint-indexNode.esm.json",
|
|
173
179
|
"check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
|
|
174
180
|
"check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
|
|
175
181
|
"ci:build:docs": "api-extractor run",
|
|
@@ -1,111 +0,0 @@
|
|
|
1
|
-
## API Report File for "@fluid-internal/client-utils"
|
|
2
|
-
|
|
3
|
-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
-
|
|
5
|
-
```ts
|
|
6
|
-
|
|
7
|
-
import { EventEmitter } from 'events_pkg';
|
|
8
|
-
import { IEvent } from '@fluidframework/core-interfaces';
|
|
9
|
-
import { IEventProvider } from '@fluidframework/core-interfaces';
|
|
10
|
-
import { IEventTransformer } from '@fluidframework/core-interfaces';
|
|
11
|
-
import { TransformedEvent } from '@fluidframework/core-interfaces';
|
|
12
|
-
|
|
13
|
-
// @internal
|
|
14
|
-
export class Buffer extends Uint8Array {
|
|
15
|
-
static from(value: unknown, encodingOrOffset?: unknown, length?: unknown): IsoBuffer;
|
|
16
|
-
// (undocumented)
|
|
17
|
-
static isBuffer(obj: unknown): obj is Buffer;
|
|
18
|
-
// (undocumented)
|
|
19
|
-
toString(encoding?: "utf8" | "utf-8" | "base64"): string;
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
// @alpha
|
|
23
|
-
export const bufferToString: (blob: ArrayBufferLike, encoding: "utf8" | "utf-8" | "base64") => string;
|
|
24
|
-
|
|
25
|
-
export { EventEmitter }
|
|
26
|
-
|
|
27
|
-
// @alpha
|
|
28
|
-
export type EventEmitterEventType = string;
|
|
29
|
-
|
|
30
|
-
// @internal
|
|
31
|
-
export const fromBase64ToUtf8: (input: string) => string;
|
|
32
|
-
|
|
33
|
-
// @internal
|
|
34
|
-
export const fromUtf8ToBase64: (input: string) => string;
|
|
35
|
-
|
|
36
|
-
// @internal
|
|
37
|
-
export function gitHashFile(file: IsoBuffer): Promise<string>;
|
|
38
|
-
|
|
39
|
-
// @internal
|
|
40
|
-
export function hashFile(file: IsoBuffer, algorithm?: "SHA-1" | "SHA-256", hashEncoding?: "hex" | "base64"): Promise<string>;
|
|
41
|
-
|
|
42
|
-
// @internal (undocumented)
|
|
43
|
-
export const IsoBuffer: typeof Buffer;
|
|
44
|
-
|
|
45
|
-
// @internal (undocumented)
|
|
46
|
-
export type IsoBuffer = Buffer;
|
|
47
|
-
|
|
48
|
-
// @internal
|
|
49
|
-
export type IsomorphicPerformance = Partial<Performance> & Pick<Performance, "clearMarks" | "mark" | "measure" | "now">;
|
|
50
|
-
|
|
51
|
-
// @internal
|
|
52
|
-
export interface ITraceEvent {
|
|
53
|
-
readonly duration: number;
|
|
54
|
-
readonly tick: number;
|
|
55
|
-
readonly totalTimeElapsed: number;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
// @internal
|
|
59
|
-
const performance_2: IsomorphicPerformance;
|
|
60
|
-
export { performance_2 as performance }
|
|
61
|
-
|
|
62
|
-
// @internal
|
|
63
|
-
export function stringToBuffer(input: string, encoding: string): ArrayBufferLike;
|
|
64
|
-
|
|
65
|
-
// @internal
|
|
66
|
-
export const toUtf8: (input: string, encoding: string) => string;
|
|
67
|
-
|
|
68
|
-
// @internal
|
|
69
|
-
export class Trace {
|
|
70
|
-
protected constructor(startTick: number);
|
|
71
|
-
// (undocumented)
|
|
72
|
-
protected lastTick: number;
|
|
73
|
-
// (undocumented)
|
|
74
|
-
static start(): Trace;
|
|
75
|
-
// (undocumented)
|
|
76
|
-
readonly startTick: number;
|
|
77
|
-
// (undocumented)
|
|
78
|
-
trace(): ITraceEvent;
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
// @alpha
|
|
82
|
-
export class TypedEventEmitter<TEvent> extends EventEmitter implements IEventProvider<TEvent & IEvent> {
|
|
83
|
-
constructor();
|
|
84
|
-
// (undocumented)
|
|
85
|
-
readonly addListener: TypedEventTransform<this, TEvent>;
|
|
86
|
-
// (undocumented)
|
|
87
|
-
readonly off: TypedEventTransform<this, TEvent>;
|
|
88
|
-
// (undocumented)
|
|
89
|
-
readonly on: TypedEventTransform<this, TEvent>;
|
|
90
|
-
// (undocumented)
|
|
91
|
-
readonly once: TypedEventTransform<this, TEvent>;
|
|
92
|
-
// (undocumented)
|
|
93
|
-
readonly prependListener: TypedEventTransform<this, TEvent>;
|
|
94
|
-
// (undocumented)
|
|
95
|
-
readonly prependOnceListener: TypedEventTransform<this, TEvent>;
|
|
96
|
-
// (undocumented)
|
|
97
|
-
readonly removeListener: TypedEventTransform<this, TEvent>;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
// @alpha (undocumented)
|
|
101
|
-
export type TypedEventTransform<TThis, TEvent> = TransformedEvent<TThis, "newListener" | "removeListener", Parameters<(event: string, listener: (...args: any[]) => void) => void>> & IEventTransformer<TThis, TEvent & IEvent> & TransformedEvent<TThis, EventEmitterEventType, any[]>;
|
|
102
|
-
|
|
103
|
-
// @internal
|
|
104
|
-
export function Uint8ArrayToArrayBuffer(array: Uint8Array): ArrayBuffer;
|
|
105
|
-
|
|
106
|
-
// @internal
|
|
107
|
-
export function Uint8ArrayToString(arr: Uint8Array, encoding?: "utf8" | "utf-8" | "base64"): string;
|
|
108
|
-
|
|
109
|
-
// (No @packageDocumentation comment for this package)
|
|
110
|
-
|
|
111
|
-
```
|