🐛 Fix dual-packages hazard and types incompatibility (#4842)

dubzzz · Mar 28, 2024 · 2e675d9 · 2e675d9
1 parent 70f63fc
commit 2e675d9
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 3 deletions.
diff --git a/.yarn/versions/1488efe6.yml b/.yarn/versions/1488efe6.yml
@@ -0,0 +1,8 @@
+releases:
+  fast-check: patch
+
+declined:
+  - "@fast-check/ava"
+  - "@fast-check/jest"
+  - "@fast-check/vitest"
+  - "@fast-check/worker"
diff --git a/packages/fast-check/src/arbitrary/_internals/helpers/DepthContext.ts b/packages/fast-check/src/arbitrary/_internals/helpers/DepthContext.ts
@@ -1,6 +1,6 @@
 /**
  * Internal symbol used to declare an opaque type for DepthIdentifier
- * @public
+ * @internal
  */
 declare const depthIdentifierSymbol: unique symbol;
 
@@ -11,7 +11,10 @@ declare const depthIdentifierSymbol: unique symbol;
  * @remarks Since 2.25.0
  * @public
  */
-export type DepthIdentifier = { [depthIdentifierSymbol]: true };
+export type DepthIdentifier = {
+  /** @internal */
+  [depthIdentifierSymbol]: true;
+} & DepthContext;
 
 /**
  * Instance of depth, can be used to alter the depth perceived by an arbitrary

diff --git a/packages/fast-check/src/check/arbitrary/definition/Value.ts b/packages/fast-check/src/check/arbitrary/definition/Value.ts
@@ -18,6 +18,7 @@ export class Value<T> {
    */
   readonly hasToBeCloned: boolean;
   /**
+   * @internal
    * Flag indicating whether or not the this.value has already been called once
    * If so, the underlying will be cloned
    * Only set when hasToBeCloned = true

diff --git a/packages/fast-check/src/check/precondition/PreconditionFailure.ts b/packages/fast-check/src/check/precondition/PreconditionFailure.ts
@@ -4,7 +4,9 @@
  * @public
  */
 export class PreconditionFailure extends Error {
+  /** @internal */
   private static readonly SharedFootPrint: symbol = Symbol('fast-check/PreconditionFailure');
+  /** @internal */
   private readonly footprint: symbol;
   constructor(readonly interruptExecution: boolean = false) {
     super();

diff --git a/packages/fast-check/src/random/generator/Random.ts b/packages/fast-check/src/random/generator/Random.ts
@@ -17,6 +17,7 @@ export class Random {
   private static DBL_FACTOR: number = Math.pow(2, 27);
   private static DBL_DIVISOR: number = Math.pow(2, -53);
 
+  /** @internal */
   private internalRng: RandomGenerator;
 
   /**

diff --git a/packages/fast-check/src/stream/Stream.ts b/packages/fast-check/src/stream/Stream.ts
@@ -43,7 +43,7 @@ export class Stream<T> implements IterableIterator<T> {
    * Create a Stream based on `g`
    * @param g - Underlying data of the Stream
    */
-  constructor(private readonly g: IterableIterator<T>) {
+  constructor(/** @internal */ private readonly g: IterableIterator<T>) {
     // /*DEBUG*/ this.isLive = true;
   }