Prepare v8.1.1 release (#91)

adams85 · web-flow · commit f5f0d5d0243c · 2023-08-04T17:47:08.000+02:00
* Downgrade TypeScript to v4.0

* Bump version
diff --git a/.eslintignore b/.eslintignore
@@ -4,4 +4,5 @@ dist/
 lib/
 node_modules/
 src/Semver.ts
-src/Sha1.ts
+src/Sha1.ts
+src/lib.*.d.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "configcat-common",
-  "version": "8.1.0",
+  "version": "8.1.1",
   "description": "ConfigCat is a configuration as a service that lets you manage your features and configurations without actually deploying new code.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -48,7 +48,7 @@
     "nyc": "^15.1.0",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.4"
+    "typescript": "^4.0.2"
   },
   "repository": {
     "type": "git",
diff --git a/src/ConfigCatClient.ts b/src/ConfigCatClient.ts
@@ -110,7 +110,7 @@ export interface IConfigCatClient extends IProvidesHooks {
   /**
    * Returns `true` when the client is configured not to initiate HTTP requests, otherwise `false`.
    */
-  get isOffline(): boolean;
+  readonly isOffline: boolean;
 
   /**
    * Configures the client to allow HTTP requests.
diff --git a/src/ConfigFetcher.ts b/src/ConfigFetcher.ts
@@ -45,24 +45,21 @@ export class FetchError<TCause extends keyof FetchErrorCauses = keyof FetchError
   args: FetchErrorCauses[TCause];
 
   constructor(public cause: TCause, ...args: FetchErrorCauses[TCause]) {
-    let message: string | undefined;
-    switch (cause) {
-      case "abort":
-        message = "Request was aborted.";
-        break;
-      case "timeout":
-        const [timeoutMs] = args as FetchErrorCauses["timeout"];
-        message = `Request timed out. Timeout value: ${timeoutMs}ms`;
-        break;
-      case "failure":
-        const [err] = args as FetchErrorCauses["failure"];
-        message = "Request failed due to a network or protocol error.";
-        if (err) {
-          message += " " + (err instanceof Error ? err.message : err + "");
-        }
-        break;
-    }
-    super(message);
+    super(((cause: TCause, args: FetchErrorCauses[TCause]): string | undefined => {
+      switch (cause) {
+        case "abort":
+          return "Request was aborted.";
+        case "timeout":
+          const [timeoutMs] = args as FetchErrorCauses["timeout"];
+          return `Request timed out. Timeout value: ${timeoutMs}ms`;
+        case "failure":
+          const [err] = args as FetchErrorCauses["failure"];
+          const message = "Request failed due to a network or protocol error.";
+          return err
+            ? message + " " + (err instanceof Error ? err.message : err + "")
+            : message;
+      }
+    })(cause, args));
 
     // NOTE: due to a known issue in the TS compiler, instanceof is broken when subclassing Error and targeting ES5 or earlier
     // (see https://github.com/microsoft/TypeScript/issues/13965).
diff --git a/src/ConfigServiceBase.ts b/src/ConfigServiceBase.ts
@@ -39,7 +39,7 @@ export interface IConfigService {
 
   refreshConfigAsync(): Promise<[RefreshResult, ProjectConfig]>;
 
-  get isOffline(): boolean;
+  readonly isOffline: boolean;
 
   setOnline(): void;
 
diff --git a/src/DefaultEventEmitter.ts b/src/DefaultEventEmitter.ts
@@ -21,15 +21,16 @@ export class DefaultEventEmitter implements IEventEmitter {
       throw new TypeError("Listener must be a function");
     }
 
-    const listeners = this.events[eventName];
+    // TODO: remove `as string` when updating to TypeScript 4.4 or newer (https://stackoverflow.com/a/64943542/8656352)
+    const listeners = this.events[eventName as string];
     const listener: Listener = { fn, once };
 
     if (!listeners) {
-      this.events[eventName] = listener;
+      this.events[eventName as string] = listener;
       this.eventCount++;
     }
     else if (isSingle(listeners)) {
-      this.events[eventName] = [listeners, listener];
+      this.events[eventName as string] = [listeners, listener];
     }
     else {
       listeners.push(listener);
@@ -39,7 +40,7 @@ export class DefaultEventEmitter implements IEventEmitter {
   }
 
   private removeListenerCore<TState>(eventName: string | symbol, state: TState, isMatch: (listener: Listener, state: TState) => boolean) {
-    const listeners = this.events[eventName];
+    const listeners = this.events[eventName as string];
 
     if (!listeners) {
       return this;
@@ -53,7 +54,7 @@ export class DefaultEventEmitter implements IEventEmitter {
             this.removeEvent(eventName);
           }
           else if (listeners.length === 1) {
-            this.events[eventName] = listeners[0];
+            this.events[eventName as string] = listeners[0];
           }
           break;
         }
@@ -71,7 +72,7 @@ export class DefaultEventEmitter implements IEventEmitter {
       this.events = {};
     }
     else {
-      delete this.events[eventName];
+      delete this.events[eventName as string];
     }
   }
 
@@ -100,15 +101,15 @@ export class DefaultEventEmitter implements IEventEmitter {
       this.events = {};
       this.eventCount = 0;
     }
-    else if (this.events[eventName]) {
+    else if (this.events[eventName as string]) {
       this.removeEvent(eventName);
     }
 
     return this;
   }
 
   listeners(eventName: string | symbol): Function[] {
-    const listeners = this.events[eventName];
+    const listeners = this.events[eventName as string];
 
     if (!listeners) {
       return [];
@@ -126,7 +127,7 @@ export class DefaultEventEmitter implements IEventEmitter {
   }
 
   listenerCount(eventName: string | symbol): number {
-    const listeners = this.events[eventName];
+    const listeners = this.events[eventName as string];
 
     if (!listeners) {
       return 0;
@@ -161,7 +162,7 @@ export class DefaultEventEmitter implements IEventEmitter {
   }
 
   emit(eventName: string | symbol, arg0?: any, arg1?: any, arg2?: any, arg3?: any, ...moreArgs: any[]): boolean {
-    let listeners = this.events[eventName];
+    let listeners = this.events[eventName as string];
 
     if (!listeners) {
       return false;
diff --git a/src/Polyfills.ts b/src/Polyfills.ts
@@ -34,8 +34,10 @@ export function ObjectEntriesPolyfill<T>(o: { [s: string]: T } | ArrayLike<T>):
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-export function ObjectFromEntriesPolyfill<T>(entries: Iterable<readonly [PropertyKey, T]>): { [k: PropertyKey]: T } {
-  const result: { [k: PropertyKey]: T } = {};
+export function ObjectFromEntriesPolyfill<T>(entries: Iterable<readonly [PropertyKey, T]>): { [k: string]: T } {
+  // TODO: change `k: string` to `k: PropertyKey` in the following line and remove `as string` below
+  // when updating to TypeScript 4.4 or newer (https://stackoverflow.com/a/64943542/8656352)
+  const result: { [k: string]: T } = {};
   if (Array.isArray(entries)) {
     for (const [key, value] of entries) {
       result[key] = value;
@@ -46,7 +48,7 @@ export function ObjectFromEntriesPolyfill<T>(entries: Iterable<readonly [Propert
     let element: readonly [PropertyKey, T], done: boolean | undefined;
     while (({ value: element, done } = iterator.next(), !done)) {
       const [key, value] = element;
-      result[key] = value;
+      result[key as string] = value;
     }
   }
   else {
diff --git a/src/lib.es2021.promise.d.ts b/src/lib.es2021.promise.d.ts
@@ -0,0 +1,31 @@
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at http://www.apache.org/licenses/LICENSE-2.0
+
+THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
+WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
+MERCHANTABLITY OR NON-INFRINGEMENT.
+
+See the Apache Version 2.0 License for specific language governing permissions
+and limitations under the License.
+***************************************************************************** */
+
+
+
+/// <reference no-default-lib="true"/>
+
+
+interface AggregateError extends Error {
+    errors: any[]
+}
+
+interface AggregateErrorConstructor {
+    new(errors: Iterable<any>, message?: string): AggregateError;
+    (errors: Iterable<any>, message?: string): AggregateError;
+    readonly prototype: AggregateError;
+}
+
+declare var AggregateError: AggregateErrorConstructor;
diff --git a/src/lib.es2021.weakref.d.ts b/src/lib.es2021.weakref.d.ts
@@ -0,0 +1,75 @@
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation. All rights reserved.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at http://www.apache.org/licenses/LICENSE-2.0
+
+THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
+WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
+MERCHANTABLITY OR NON-INFRINGEMENT.
+
+See the Apache Version 2.0 License for specific language governing permissions
+and limitations under the License.
+***************************************************************************** */
+
+
+
+/// <reference no-default-lib="true"/>
+
+
+interface WeakRef<T extends object> {
+    readonly [Symbol.toStringTag]: "WeakRef";
+
+    /**
+     * Returns the WeakRef instance's target object, or undefined if the target object has been
+     * reclaimed.
+     */
+    deref(): T | undefined;
+}
+
+interface WeakRefConstructor {
+    readonly prototype: WeakRef<any>;
+
+    /**
+     * Creates a WeakRef instance for the given target object.
+     * @param target The target object for the WeakRef instance.
+     */
+    new<T extends object>(target: T): WeakRef<T>;
+}
+
+declare var WeakRef: WeakRefConstructor;
+
+interface FinalizationRegistry<T> {
+    readonly [Symbol.toStringTag]: "FinalizationRegistry";
+
+    /**
+     * Registers an object with the registry.
+     * @param target The target object to register.
+     * @param heldValue The value to pass to the finalizer for this object. This cannot be the
+     * target object.
+     * @param unregisterToken The token to pass to the unregister method to unregister the target
+     * object. If provided (and not undefined), this must be an object. If not provided, the target
+     * cannot be unregistered.
+     */
+    register(target: object, heldValue: T, unregisterToken?: object): void;
+
+    /**
+     * Unregisters an object from the registry.
+     * @param unregisterToken The token that was used as the unregisterToken argument when calling
+     * register to register the target object.
+     */
+    unregister(unregisterToken: object): void;
+}
+
+interface FinalizationRegistryConstructor {
+    readonly prototype: FinalizationRegistry<any>;
+
+    /**
+     * Creates a finalization registry with an associated cleanup callback
+     * @param cleanupCallback The callback to call after an object in the registry has been reclaimed.
+     */
+    new<T>(cleanupCallback: (heldValue: T) => void): FinalizationRegistry<T>;
+}
+
+declare var FinalizationRegistry: FinalizationRegistryConstructor;
diff --git a/test/ConfigCatCacheTests.ts b/test/ConfigCatCacheTests.ts
@@ -1,7 +1,7 @@
 import { assert } from "chai";
 import "mocha";
-import { ManualPollOptions } from "../lib/ConfigCatClientOptions";
 import { ExternalConfigCache, IConfigCache, IConfigCatCache, InMemoryConfigCache, } from "../src/ConfigCatCache";
+import { ManualPollOptions } from "../src/ConfigCatClientOptions";
 import { LogLevel, LoggerWrapper } from "../src/ConfigCatLogger";
 import { Config, ProjectConfig } from "../src/ProjectConfig";
 import { FakeLogger } from "./helpers/fakes";
diff --git a/test/IndexTests.ts b/test/IndexTests.ts
@@ -1,6 +1,6 @@
 import { assert } from "chai";
 import "mocha";
-import { PollingMode } from "../lib";
+import { PollingMode } from "../src";
 import { IConfigCatClient } from "../src/ConfigCatClient";
 import * as configcatClient from "../src/index";
 import { FakeConfigCatKernel, FakeConfigFetcher } from "./helpers/fakes";
diff --git a/test/OverrideTests.ts b/test/OverrideTests.ts
@@ -1,6 +1,6 @@
 import { assert, expect } from "chai";
 import "mocha";
-import { SettingKeyValue } from "../lib";
+import { SettingKeyValue } from "../src";
 import { ConfigCatClient, IConfigCatClient, IConfigCatKernel } from "../src/ConfigCatClient";
 import { AutoPollOptions, ManualPollOptions } from "../src/ConfigCatClientOptions";
 import { MapOverrideDataSource, OverrideBehaviour } from "../src/FlagOverrides";
diff --git a/test/PolyfillTests.ts b/test/PolyfillTests.ts
@@ -36,7 +36,8 @@ describe("Polyfills", () => {
 
     assert.deepEqual({}, ObjectFromEntriesPolyfill<any>((function* () { })()));
     // eslint-disable-next-line @typescript-eslint/naming-convention
-    assert.deepEqual({ "a": 1, 2: "b" }, ObjectFromEntriesPolyfill<any>((function* () { yield* [["a", 1], [2, "b"]]; })()));
+    const entries = (function* () { yield* [["a", 1], [2, "b"]]; })() as unknown as Iterable<readonly [PropertyKey, any]>;
+    assert.deepEqual({ "a": 1, 2: "b" }, ObjectFromEntriesPolyfill<any>(entries));
 
     assert.throws(() => ObjectFromEntriesPolyfill<any>(1 as any));
   });
diff --git a/test/helpers/fakes.ts b/test/helpers/fakes.ts
@@ -1,4 +1,4 @@
-import { IConfigCatCache, LogEventId } from "../../lib";
+import { IConfigCatCache, LogEventId } from "../../src";
 import { IConfigCache } from "../../src/ConfigCatCache";
 import { IConfigCatKernel } from "../../src/ConfigCatClient";
 import { OptionsBase } from "../../src/ConfigCatClientOptions";
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/tsconfig.mocha.json b/tsconfig.mocha.json

Original file line number	Diff line number	Diff line change
`@@ -21,15 +21,16 @@ export class DefaultEventEmitter implements IEventEmitter {`
`21`	`21`	`throw new TypeError("Listener must be a function");`
`22`	`22`	`}`
`23`	`23`
`24`		`- const listeners = this.events[eventName];`
	`24`	+ // TODO: remove `as string` when updating to TypeScript 4.4 or newer (https://stackoverflow.com/a/64943542/8656352)
	`25`	`+ const listeners = this.events[eventName as string];`
`25`	`26`	`const listener: Listener = { fn, once };`
`26`	`27`
`27`	`28`	`if (!listeners) {`
`28`		`- this.events[eventName] = listener;`
	`29`	`+ this.events[eventName as string] = listener;`
`29`	`30`	`this.eventCount++;`
`30`	`31`	`}`
`31`	`32`	`else if (isSingle(listeners)) {`
`32`		`- this.events[eventName] = [listeners, listener];`
	`33`	`+ this.events[eventName as string] = [listeners, listener];`
`33`	`34`	`}`
`34`	`35`	`else {`
`35`	`36`	`listeners.push(listener);`
`@@ -39,7 +40,7 @@ export class DefaultEventEmitter implements IEventEmitter {`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`private removeListenerCore<TState>(eventName: string \| symbol, state: TState, isMatch: (listener: Listener, state: TState) => boolean) {`
`42`		`- const listeners = this.events[eventName];`
	`43`	`+ const listeners = this.events[eventName as string];`
`43`	`44`
`44`	`45`	`if (!listeners) {`
`45`	`46`	`return this;`
`@@ -53,7 +54,7 @@ export class DefaultEventEmitter implements IEventEmitter {`
`53`	`54`	`this.removeEvent(eventName);`
`54`	`55`	`}`
`55`	`56`	`else if (listeners.length === 1) {`
`56`		`- this.events[eventName] = listeners[0];`
	`57`	`+ this.events[eventName as string] = listeners[0];`
`57`	`58`	`}`
`58`	`59`	`break;`
`59`	`60`	`}`
`@@ -71,7 +72,7 @@ export class DefaultEventEmitter implements IEventEmitter {`
`71`	`72`	`this.events = {};`
`72`	`73`	`}`
`73`	`74`	`else {`
`74`		`- delete this.events[eventName];`
	`75`	`+ delete this.events[eventName as string];`
`75`	`76`	`}`
`76`	`77`	`}`
`77`	`78`
`@@ -100,15 +101,15 @@ export class DefaultEventEmitter implements IEventEmitter {`
`100`	`101`	`this.events = {};`
`101`	`102`	`this.eventCount = 0;`
`102`	`103`	`}`
`103`		`- else if (this.events[eventName]) {`
	`104`	`+ else if (this.events[eventName as string]) {`
`104`	`105`	`this.removeEvent(eventName);`
`105`	`106`	`}`
`106`	`107`
`107`	`108`	`return this;`
`108`	`109`	`}`
`109`	`110`
`110`	`111`	`listeners(eventName: string \| symbol): Function[] {`
`111`		`- const listeners = this.events[eventName];`
	`112`	`+ const listeners = this.events[eventName as string];`
`112`	`113`
`113`	`114`	`if (!listeners) {`
`114`	`115`	`return [];`
`@@ -126,7 +127,7 @@ export class DefaultEventEmitter implements IEventEmitter {`
`126`	`127`	`}`
`127`	`128`
`128`	`129`	`listenerCount(eventName: string \| symbol): number {`
`129`		`- const listeners = this.events[eventName];`
	`130`	`+ const listeners = this.events[eventName as string];`
`130`	`131`
`131`	`132`	`if (!listeners) {`
`132`	`133`	`return 0;`
`@@ -161,7 +162,7 @@ export class DefaultEventEmitter implements IEventEmitter {`
`161`	`162`	`}`
`162`	`163`
`163`	`164`	`emit(eventName: string \| symbol, arg0?: any, arg1?: any, arg2?: any, arg3?: any, ...moreArgs: any[]): boolean {`
`164`		`- let listeners = this.events[eventName];`
	`165`	`+ let listeners = this.events[eventName as string];`
`165`	`166`
`166`	`167`	`if (!listeners) {`
`167`	`168`	`return false;`