@teselagen/range-utils 0.3.18 → 0.3.20-beta.1

package/README.md

@@ -69,16 +69,6 @@ Tests will automatically be run pre-commit.
 
 ## Updating this repo:
 
-### Teselagen collaborators:
-
-Commit and push all changes
-Sign into npm using the teselagen npm account (npm whoami)
-
-```
-npm version patch|minor|major
-npm publish
-```
-
 ### Outside collaborators:
 
 fork and pull request please :)

package/RangeAngles.d.ts

@@ -0,0 +1,7 @@
+export interface RangeAngles {
+    startAngle: number;
+    totalAngle: number;
+    endAngle: number;
+    centerAngle: number;
+    locationAngles?: RangeAngles[];
+}

package/adjustRangeToDeletionOfAnotherRange.d.ts

@@ -1 +1,2 @@
-export default function adjustRangeToDeletionOfAnotherRange(rangeToBeAdjusted: any, anotherRange: any, maxLength: any): object | null;
+import { Range } from './types';
+export default function adjustRangeToDeletionOfAnotherRange(rangeToBeAdjusted: Range, anotherRange: Range, maxLength: number): Range | null;

package/adjustRangeToInsert.d.ts

@@ -1 +1,2 @@
-export default function adjustRangeToInsert(rangeToBeAdjusted: any, insertStart: any, insertLength: any): any;
+import { Range } from './types';
+export default function adjustRangeToInsert(rangeToBeAdjusted: Range, insertStart: number, insertLength: number): Range;

package/adjustRangeToRotation.d.ts

@@ -1 +1,2 @@
-export default function adjustRangeToRotation(rangeToBeAdjusted: any, rotateTo: number | undefined, rangeLength: any): any;
+import { Range } from './types';
+export default function adjustRangeToRotation<T extends Range>(rangeToBeAdjusted: T, rotateTo?: number, rangeLength?: number): T;

package/checkIfNonCircularRangesOverlap.d.ts

@@ -1 +1,2 @@
-export default function checkIfNonCircularRangesOverlap(range: any, comparisonRange: any): boolean;
+import { Range } from './types';
+export default function checkIfNonCircularRangesOverlap(range: Range, comparisonRange: Range): boolean;

package/checkIfPotentiallyCircularRangesOverlap.d.ts

@@ -1 +1,2 @@
-export default function checkIfPotentiallyCircularRangesOverlap(range: any, comparisonRange: any): boolean;
+import { Range } from './types';
+export default function checkIfPotentiallyCircularRangesOverlap(range: Range, comparisonRange: Range): boolean;

package/collapseOverlapsGeneratedFromRangeComparisonIfPossible.d.ts

@@ -1 +1,2 @@
-export default function collapseOverlapsGeneratedFromRangeComparisonIfPossible(overlaps: any, sequenceLength: any, optionalOriginalRange: any): any;
+import { Range } from './types';
+export default function collapseOverlapsGeneratedFromRangeComparisonIfPossible(overlaps: Range[], sequenceLength: number, optionalOriginalRange?: Range): Range[];

package/convertRangeIndices.d.ts

@@ -1 +1,10 @@
-export default function convertRangeIndices(range: any, inputType: any, outputType: any): any;
+import { Range } from './types';
+interface RangeIndicesOptions {
+    inclusive1BasedStart?: boolean;
+    inclusive1BasedEnd?: boolean;
+}
+export default function convertRangeIndices(range: Range, inputType?: RangeIndicesOptions, outputType?: RangeIndicesOptions): Range & {
+    start: number;
+    end: number;
+};
+export {};

package/convertRangeTo0Based.d.ts

@@ -1 +1,5 @@
-export default function convertRangeTo0Based(range: any): any;
+import { Range } from './types';
+export default function convertRangeTo0Based(range: Range): Range & {
+    start: number;
+    end: number;
+};

package/convertRangeTo1Based.d.ts

@@ -1 +1,5 @@
-export default function convertRangeTo1Based(range: any): any;
+import { Range } from './types';
+export default function convertRangeTo1Based(range: Range): Range & {
+    start: number;
+    end: number;
+};

package/doesRangeSpanEntireSequence.d.ts

@@ -1 +1,2 @@
-export default function doesRangeSpanEntireSequence(range: any, sequenceLength: any): true | undefined;
+import { Range } from './types';
+export default function doesRangeSpanEntireSequence(range: Range, sequenceLength: number): boolean;

package/doesRangeSpanOrigin.d.ts

@@ -1 +1,2 @@
-export default function doesRangeSpanOrigin(range: any): boolean;
+import { Range } from './types';
+export default function doesRangeSpanOrigin(range: Range): boolean;

package/expandOrContractCircularRangeToPosition.d.ts

@@ -1,4 +1,5 @@
-export default function expandOrContractCircularRangeToPosition(range: any, position: any, maxLength: any): {
-    newRange: any;
+import { Range } from './types';
+export default function expandOrContractCircularRangeToPosition(range: Range, position: number, maxLength: number): {
+    newRange: Range;
     endMoved: boolean;
 };

package/expandOrContractNonCircularRangeToPosition.d.ts

@@ -1,4 +1,5 @@
-export default function expandOrContractNonCircularRangeToPosition(range: any, position: any): {
-    newRange: any;
+import { Range } from './types';
+export default function expandOrContractNonCircularRangeToPosition(range: Range, position: number): {
+    newRange: Range;
     endMoved: boolean;
 };

package/expandOrContractRangeByLength.d.ts

@@ -1 +1,5 @@
-export default function expandOrContractRangeByLength(range: any, shiftBy: any, shiftStart: any, sequenceLength: any): any;
+import { Range } from './types';
+export default function expandOrContractRangeByLength(range: Range, shiftBy: number, shiftStart: boolean, sequenceLength: number): Range & {
+    start: number;
+    end: number;
+};

package/expandOrContractRangeToPosition.d.ts

@@ -1,4 +1,5 @@
-export default function expandOrContractRangeToPosition(range: any, position: any, maxLength: any): {
-    newRange: any;
+import { Range } from './types';
+export default function expandOrContractRangeToPosition(range: Range, position: number, maxLength: number): {
+    newRange: Range;
     endMoved: boolean;
 };

package/flipContainedRange.d.ts

@@ -1 +1,5 @@
-export default function flipRelativeRange(innerRange: any, outerRange: any, sequenceLength: any): any;
+import { Range } from './types';
+export default function flipRelativeRange(innerRange: Range, outerRange: Range, sequenceLength: number): Range & {
+    start: number;
+    end: number;
+};

package/generateRandomRange.d.ts

@@ -1,4 +1,4 @@
-export default function generateRandomRange(minStart: any, maxEnd: any, maxLength: any): {
-    start: any;
-    end: any;
+export default function generateRandomRange(minStart: number, maxEnd: number, maxLength: number): {
+    start: number;
+    end: number;
 };

package/getAnnotationRangeType.d.ts

@@ -1 +1,2 @@
-export default function getAnnotationRangeType(annotationRange: any, enclosingRangeType: any, forward: any): "end" | "beginningAndEnd" | "start" | "middle";
+import { Range } from './types';
+export default function getAnnotationRangeType(annotationRange: Range, enclosingRangeType: Range, forward: boolean): "end" | "beginningAndEnd" | "start" | "middle";

package/getEachPositionInRangeAsArray.d.ts

@@ -1 +1,2 @@
-export default function getEachPositionInRangeAsArray(range: any, rangeMax: any): any[];
+import { Range } from './types';
+export default function getEachPositionInRangeAsArray(range: Range, rangeMax: number): number[];

package/getLengthOfOverlappingRegionsBetweenTwoRanges.d.ts

@@ -1 +1,2 @@
-export default function getLengthOfOverlappingRegionsBetweenTwoRanges(rangeA: any, rangeB: any, maxLength: any): any;
+import { Range } from './types';
+export default function getLengthOfOverlappingRegionsBetweenTwoRanges(rangeA: Range, rangeB: Range, maxLength: number): number;

package/getMiddleOfRange.d.ts

@@ -1 +1,2 @@
-export default function getMiddleOfRange(range: any, rangeMax: any): any;
+import { Range } from './types';
+export default function getMiddleOfRange(range: Range, rangeMax: number): number;

package/getOverlapOfNonCircularRanges.d.ts

@@ -1,4 +1,5 @@
-export default function getOverlapOfNonCircularRanges(rangeA: any, rangeB: any): {
-    start: any;
-    end: any;
-} | undefined;
+import { Range } from './types';
+export default function getOverlapOfNonCircularRanges(rangeA: Range, rangeB: Range): {
+    start: number;
+    end: number;
+} | null;

package/getOverlapsOfPotentiallyCircularRanges.d.ts

@@ -1 +1,2 @@
-export default function getOverlapsOfPotentiallyCircularRanges(rangeA: any, rangeB: any, maxRangeLength: any, joinIfPossible: any): any[];
+import { Range } from './types';
+export default function getOverlapsOfPotentiallyCircularRanges(rangeA: Range, rangeB: Range, maxRangeLength: number, joinIfPossible?: boolean): Range[];

package/getPositionFromAngle.d.ts

@@ -1 +1 @@
-export default function getPositionFromAngle(angle: any, rangeMax: any, isInBetweenPositions: any): number;
+export default function getPositionFromAngle(angle: number, rangeMax: number, isInBetweenPositions?: boolean): number;

package/getRangeAngles.d.ts

@@ -1,7 +1,3 @@
-export default function getRangeAngles(range: any, rangeMax: any): {
-    startAngle: number;
-    totalAngle: number;
-    endAngle: number;
-    centerAngle: number;
-    locationAngles: any;
-};
+import { Range } from './types';
+import { RangeAngles } from './RangeAngles';
+export default function getRangeAngles(range: Range, rangeMax: number): RangeAngles;

package/getRangeLength.d.ts

@@ -1,2 +1,6 @@
-declare const _default: (...args: any[]) => any;
+import { Range } from './types';
+declare const _default: (range: Range, rangeMax: number, options?: {
+    inclusive1BasedEnd?: boolean;
+    inclusive1BasedStart?: boolean;
+} | undefined) => number;
 export default _default;

package/getRangesBetweenTwoRanges.d.ts

@@ -1 +1,2 @@
-export default function getRangesBetweenTwoRanges(range1: any, range2: any): any[];
+import { Range } from './types';
+export default function getRangesBetweenTwoRanges(range1: Range, range2: Range): Range[];

package/getSequenceWithinRange.d.ts

@@ -1 +1,3 @@
-export default function getSequenceWithinRange(range: any, sequence: any): any;
+import { Range } from './types';
+export default function getSequenceWithinRange(range: Range, sequence: string): string;
+export default function getSequenceWithinRange<T>(range: Range, sequence: T[]): T[];

package/getShortestDistanceBetweenTwoPositions.d.ts

@@ -1 +1 @@
-export default function getShortestDistanceBetweenTwoPositions(position1: any, position2: any, sequenceLength: any): number;
+export default function getShortestDistanceBetweenTwoPositions(position1: number, position2: number, sequenceLength: number): number;

package/getYOffsetForPotentiallyCircularRange.d.ts

@@ -1 +1,2 @@
-export default function getYOffsetForPotentiallyCircularRange(range: any, YOffsetLevelsWithRanges: any, assignYOffsetToRange: any): any;
+import { Range } from './types';
+export default function getYOffsetForPotentiallyCircularRange(range: Range, YOffsetLevelsWithRanges: Range[][], assignYOffsetToRange: boolean): number;

package/getYOffsetsForPotentiallyCircularRanges.d.ts

@@ -1,4 +1,5 @@
-export default function getYOffsetsForPotentiallyCircularRanges(ranges: any, assignYOffsetToRange: any): {
-    yOffsets: any[];
+import { Range } from './types';
+export default function getYOffsetsForPotentiallyCircularRanges(ranges: Range[], assignYOffsetToRange: boolean): {
+    yOffsets: number[];
     maxYOffset: number;
 };

package/getZeroedRangeOverlaps.d.ts

@@ -1 +1,2 @@
-export default function getZeroedRangeOverlaps(annotation: any, selection: any, sequenceLength: any): any;
+import { Range } from './types';
+export default function getZeroedRangeOverlaps(annotation: Range, selection: Range, sequenceLength: number): Range[];

package/index.cjs

@@ -1566,9 +1566,10 @@ function getOverlapOfNonCircularRanges(rangeA, rangeB) {
       }
     }
   }
+  return null;
 }
 __name(getOverlapOfNonCircularRanges, "getOverlapOfNonCircularRanges");
-function getOverlapsOfPotentiallyCircularRanges(rangeA, rangeB, maxRangeLength, joinIfPossible) {
+function getOverlapsOfPotentiallyCircularRanges(rangeA, rangeB, maxRangeLength, joinIfPossible = false) {
   const normalizedRangeA = splitRangeIntoTwoPartsIfItIsCircular(
     rangeA,
     maxRangeLength
@@ -1599,8 +1600,11 @@ function getOverlapsOfPotentiallyCircularRanges(rangeA, rangeB, maxRangeLength,
         joinedOverlap.start = o.start;
         return [];
       }
+      return [o];
     });
-    overlaps.push(joinedOverlap);
+    if (Object.keys(joinedOverlap).length > 0) {
+      overlaps.push(joinedOverlap);
+    }
   }
   return overlaps;
 }
@@ -1673,10 +1677,7 @@ function trimRangeByAnotherRange(rangeToBeTrimmed, trimmingRange, sequenceLength
   if (!overlaps.length) {
     return rangeToBeTrimmed;
   }
-  const splitRangesToBeTrimmed = splitRangeIntoTwoPartsIfItIsCircular(
-    rangeToBeTrimmed,
-    sequenceLength
-  );
+  const splitRangesToBeTrimmed = splitRangeIntoTwoPartsIfItIsCircular(rangeToBeTrimmed, sequenceLength);
   splitRangesToBeTrimmed.forEach(function(nonCircularRangeToBeTrimmed, index) {
     overlaps.forEach(function(overlap) {
       if (nonCircularRangeToBeTrimmed) {
@@ -1719,6 +1720,7 @@ function trimRangeByAnotherRange(rangeToBeTrimmed, trimmingRange, sequenceLength
       end: outputTrimmedRange.end
     });
   }
+  return void 0;
 }
 __name(trimRangeByAnotherRange, "trimRangeByAnotherRange");
 function adjustRangeToDeletionOfAnotherRange(rangeToBeAdjusted, anotherRange, maxLength) {
@@ -1865,11 +1867,10 @@ function collapseOverlapsGeneratedFromRangeComparisonIfPossible(overlaps, sequen
       }
     }
   }
+  return overlaps;
 }
 __name(collapseOverlapsGeneratedFromRangeComparisonIfPossible, "collapseOverlapsGeneratedFromRangeComparisonIfPossible");
-function convertRangeIndices(range, inputType, outputType) {
-  inputType = inputType || {};
-  outputType = outputType || {};
+function convertRangeIndices(range, inputType = {}, outputType = {}) {
   return assign({}, range, {
     start: Number(range.start) + (inputType.inclusive1BasedStart ? outputType.inclusive1BasedStart ? 0 : -1 : outputType.inclusive1BasedStart ? 1 : 0),
     end: Number(range.end) + (inputType.inclusive1BasedEnd ? outputType.inclusive1BasedEnd ? 0 : -1 : outputType.inclusive1BasedEnd ? 1 : 0)
@@ -1892,25 +1893,32 @@ function convertRangeTo1Based(range) {
 }
 __name(convertRangeTo1Based, "convertRangeTo1Based");
 function provideInclusiveOptions(funToWrap) {
-  return function() {
-    const args = Array.prototype.slice.call(arguments);
+  return function(...args) {
     const options = args[args.length - 1];
     if (options && (options.inclusive1BasedEnd || options.inclusive1BasedStart)) {
       args.forEach(function(arg, index) {
-        if (arg && arg.start > -1 && options.inclusive1BasedStart) {
-          args[index] = assign(arg, { start: arg.start - 1 });
+        const potentialRange = arg;
+        if (potentialRange && typeof potentialRange.start === "number" && potentialRange.start > -1 && options.inclusive1BasedStart) {
+          args[index] = assign(potentialRange, {
+            start: potentialRange.start - 1
+          });
         }
-        if (arg && arg.end > -1 && options.inclusive1BasedEnd) {
-          args[index] = assign(arg, { end: arg.end - 1 });
+        if (potentialRange && typeof potentialRange.end === "number" && potentialRange.end > -1 && options.inclusive1BasedEnd) {
+          args[index] = assign(potentialRange, {
+            end: potentialRange.end - 1
+          });
         }
       });
     }
     let returnVal = funToWrap.apply(this, args);
-    if (returnVal && returnVal.start > -1 && options && options.inclusive1BasedStart) {
-      returnVal = assign(returnVal, { start: returnVal.start + 1 });
+    const potentialReturn = returnVal;
+    if (potentialReturn && typeof potentialReturn.start === "number" && potentialReturn.start > -1 && options && options.inclusive1BasedStart) {
+      returnVal = assign(potentialReturn, {
+        start: potentialReturn.start + 1
+      });
     }
-    if (returnVal && returnVal.end > -1 && options && options.inclusive1BasedEnd) {
-      returnVal = assign(returnVal, { end: returnVal.end + 1 });
+    if (potentialReturn && typeof potentialReturn.end === "number" && potentialReturn.end > -1 && options && options.inclusive1BasedEnd) {
+      returnVal = assign(potentialReturn, { end: potentialReturn.end + 1 });
     }
     return returnVal;
   };
@@ -1931,9 +1939,10 @@ function getRangeLength$1(range, rangeMax) {
 }
 __name(getRangeLength$1, "getRangeLength$1");
 function doesRangeSpanEntireSequence(range, sequenceLength) {
-  if (getRangeLength(range) === sequenceLength) {
+  if (getRangeLength(range, sequenceLength) === sequenceLength) {
     return true;
   }
+  return false;
 }
 __name(doesRangeSpanEntireSequence, "doesRangeSpanEntireSequence");
 function isRangeWithinRange(rangeToCheck, containingRange, maxLength) {
@@ -1967,6 +1976,9 @@ function isRangeOrPositionWithinRange(rangeOrPositionToCheck, containingRange, m
     return false;
   }
   if (isObject(rangeOrPositionToCheck)) {
+    if (typeof rangeOrPositionToCheck.start !== "number") {
+      return false;
+    }
     return isRangeWithinRange(
       rangeOrPositionToCheck,
       containingRange,
@@ -1987,7 +1999,7 @@ function doesRangeSpanOrigin(range) {
   return range.start > range.end;
 }
 __name(doesRangeSpanOrigin, "doesRangeSpanOrigin");
-function normalizePositionByRangeLength(pPosition, sequenceLength, isInBetweenPositions) {
+function normalizePositionByRangeLength(pPosition, sequenceLength, isInBetweenPositions = false) {
   let position = pPosition;
   if (position < 0) {
     position += sequenceLength;
@@ -2079,10 +2091,7 @@ function expandOrContractRangeToPosition(range, position, maxLength) {
   if (range.start > range.end) {
     return expandOrContractCircularRangeToPosition(range, position, maxLength);
   } else {
-    return expandOrContractNonCircularRangeToPosition(
-      range,
-      position
-    );
+    return expandOrContractNonCircularRangeToPosition(range, position);
   }
 }
 __name(expandOrContractRangeToPosition, "expandOrContractRangeToPosition");
@@ -2340,15 +2349,19 @@ function getRangesBetweenTwoRanges(range1, range2) {
 }
 __name(getRangesBetweenTwoRanges, "getRangesBetweenTwoRanges");
 function getSequenceWithinRange(range, sequence) {
-  if (range.start < 0 || range.end < 0) return "";
+  if (range.start < 0 || range.end < 0) {
+    if (typeof sequence === "string") return "";
+    return [];
+  }
   if (range.start > range.end) {
-    let subSequence = sequence.slice(range.start, sequence.length);
+    const subSequence = sequence.slice(range.start, sequence.length);
     if (typeof subSequence === "string") {
-      subSequence += sequence.slice(0, range.end + 1);
+      return subSequence + sequence.slice(0, range.end + 1);
     } else {
-      subSequence = subSequence.concat(sequence.slice(0, range.end + 1));
+      return subSequence.concat(
+        sequence.slice(0, range.end + 1)
+      );
     }
-    return subSequence;
   } else {
     return sequence.slice(range.start, range.end + 1);
   }
@@ -2366,7 +2379,7 @@ function getShortestDistanceBetweenTwoPositions(position1, position2, sequenceLe
 }
 __name(getShortestDistanceBetweenTwoPositions, "getShortestDistanceBetweenTwoPositions");
 function getYOffsetForPotentiallyCircularRange(range, YOffsetLevelsWithRanges, assignYOffsetToRange) {
-  let yOffset = [];
+  let yOffset = 0;
   const openYOffsetFound = YOffsetLevelsWithRanges.some(
     function(rangesAlreadyAddedToYOffset, index) {
       const rangeBlocked = rangesAlreadyAddedToYOffset.some(
@@ -2416,21 +2429,20 @@ function getYOffsetsForPotentiallyCircularRanges(ranges, assignYOffsetToRange) {
 __name(getYOffsetsForPotentiallyCircularRanges, "getYOffsetsForPotentiallyCircularRanges");
 const invertRange = provideInclusiveOptions(invertRange$1);
 function invertRange$1(rangeOrCaret, rangeMax) {
-  if (rangeOrCaret.start > -1) {
+  if (typeof rangeOrCaret !== "number" && rangeOrCaret.start > -1) {
     const start = rangeOrCaret.end + 1;
     const end = rangeOrCaret.start - 1;
     return {
       start: normalizePositionByRangeLength(start, rangeMax, false),
       end: normalizePositionByRangeLength(end, rangeMax, false)
     };
-  } else {
-    if (rangeOrCaret > -1) {
-      return {
-        start: normalizePositionByRangeLength(rangeOrCaret, rangeMax, false),
-        end: normalizePositionByRangeLength(rangeOrCaret - 1, rangeMax, false)
-      };
-    }
+  } else if (typeof rangeOrCaret === "number" && rangeOrCaret > -1) {
+    return {
+      start: normalizePositionByRangeLength(rangeOrCaret, rangeMax, false),
+      end: normalizePositionByRangeLength(rangeOrCaret - 1, rangeMax, false)
+    };
   }
+  return void 0;
 }
 __name(invertRange$1, "invertRange$1");
 function isPositionCloserToRangeStartThanRangeEnd(position, range, maxLength) {
@@ -2498,9 +2510,10 @@ function zeroSubrangeByContainerRange(subRange, containerRange, sequenceLength)
       "subRange must be fully contained by containerRange! Otherwise this function does not make sense"
     );
   }
-  const newSubrange = {};
-  newSubrange.start = subRange.start - containerRange.start;
-  newSubrange.end = subRange.end - containerRange.start;
+  const newSubrange = {
+    start: subRange.start - containerRange.start,
+    end: subRange.end - containerRange.start
+  };
   if (newSubrange.start < 0) {
     newSubrange.start += sequenceLength;
   }
@@ -2511,10 +2524,10 @@ function zeroSubrangeByContainerRange(subRange, containerRange, sequenceLength)
 }
 __name(zeroSubrangeByContainerRange, "zeroSubrangeByContainerRange");
 function adjustRangeToRotation(rangeToBeAdjusted, rotateTo = 0, rangeLength) {
-  const mod = rangeLength ? modulo : identity;
+  const mod = /* @__PURE__ */ __name((n) => rangeLength ? modulo(n, rangeLength) : n, "mod");
   const newRange = assign({}, rangeToBeAdjusted, {
-    start: mod(rangeToBeAdjusted.start - (rotateTo || 0), rangeLength),
-    end: mod(rangeToBeAdjusted.end - (rotateTo || 0), rangeLength)
+    start: mod(rangeToBeAdjusted.start - (rotateTo || 0)),
+    end: mod(rangeToBeAdjusted.end - (rotateTo || 0))
   });
   return newRange;
 }

package/index.d.ts

@@ -50,3 +50,4 @@ export { default as zeroSubrangeByContainerRange } from './zeroSubrangeByContain
 export { default as adjustRangeToRotation } from './adjustRangeToRotation';
 export { default as getZeroedRangeOverlaps } from './getZeroedRangeOverlaps';
 export { default as trimAnnStartEndToFitSeqLength } from './trimAnnStartEndToFitSeqLength';
+export * from './types';