url-safe-bitpacking 0.2.0 → 0.3.0

package/dist/update/enumArrayUpdate.d.ts

@@ -1,2 +1,3 @@
-import { EnumArrayDataEntry } from '@/types';
-export declare const updateValue: (original: EnumArrayDataEntry, update: EnumArrayDataEntry) => EnumArrayDataEntry;
+import { EnumArrayDataEntry } from '../types';
+export declare const constrainValue: <T extends EnumArrayDataEntry>(original: T, update: T["value"]) => T["value"];
+export declare const updateValue: <T extends EnumArrayDataEntry>(original: T, update: T["value"]) => T;

package/dist/update/enumOptionsUpdate.d.ts

@@ -1,2 +1,3 @@
-import { EnumOptionsDataEntry } from '@/types';
-export declare const updateComplexValue: (original: EnumOptionsDataEntry, update: EnumOptionsDataEntry) => EnumOptionsDataEntry;
+import { EnumOptionsDataEntry, UpdateState } from '../types';
+export declare const constrainState: (descriptorLength: EnumOptionsDataEntry["descriptor"]["length"], state: number) => number;
+export declare const updateState: UpdateState<EnumOptionsDataEntry>;

package/dist/update/enumUpdate.d.ts

@@ -1,2 +1,3 @@
 import { EnumDataEntry } from '../types/dataEntry';
-export declare const updateValue: (original: EnumDataEntry, update: EnumDataEntry) => EnumDataEntry;
+export declare const constrainValue: <T extends EnumDataEntry>(original: T, update: T["value"]) => T["value"];
+export declare const updateValue: <T extends EnumDataEntry>(original: T, update: T["value"]) => T;

package/dist/update/floatUpdate.d.ts

@@ -1,2 +1,3 @@
 import { FloatDataEntry } from '../types/dataEntry';
-export declare const updateValue: (original: FloatDataEntry, update: FloatDataEntry) => FloatDataEntry;
+export declare const constrainValue: <T extends FloatDataEntry>(original: T, update: T["value"]) => T["value"];
+export declare const updateValue: <T extends FloatDataEntry>(original: T, update: T["value"]) => T;

package/dist/update/index.d.ts

@@ -1 +1,2 @@
 export * from './updateValues';
+export * from './validateUtils';

package/dist/update/intUpdate.d.ts

@@ -1,2 +1,3 @@
 import { IntDataEntry } from '../types/dataEntry';
-export declare const updateValue: (original: IntDataEntry, update: IntDataEntry) => IntDataEntry;
+export declare const constrainValue: <T extends IntDataEntry>(original: T, update: T["value"]) => T["value"];
+export declare const updateValue: <T extends IntDataEntry>(original: T, update: T["value"]) => T;

package/dist/update/objectUpdate.d.ts

@@ -0,0 +1,2 @@
+import { ObjectDataEntry } from '../types';
+export declare const updateValue: (original: ObjectDataEntry, value: ObjectDataEntry["value"]) => ObjectDataEntry;

package/dist/update/optionalUpdate.d.ts

@@ -1,2 +1,3 @@
-import { OptionalDataEntry } from '@/types';
-export declare const updateComplexValue: (original: OptionalDataEntry, update: OptionalDataEntry) => OptionalDataEntry;
+import { OptionalDataEntry, UpdateState } from '../types';
+export declare const constrainState: (state: OptionalDataEntry["state"]) => OptionalDataEntry["state"];
+export declare const updateState: UpdateState<OptionalDataEntry>;

package/dist/update/updateUtils.d.ts

@@ -0,0 +1,27 @@
+import { PrecisionRangeType } from '../types';
+/**
+ * Get the step for a given precision
+ * @param precision - the precision range
+ */
+export declare const getStepForPrecision: (precision: PrecisionRangeType) => number;
+/**
+ * Constrain an unsigned int value to the given range
+ * @param value - the value to constrains
+ * @param maxValue - the maximum value (should be an integer)
+ */
+export declare const constrainUnsignedInt: (value: number, maxValue: number) => number;
+/**
+ * Constrain a signed int value to the given range
+ * @param value - the value to constrain
+ * @param minValue - the minimum value
+ * @param maxValue - the maximum value
+ */
+export declare const constrainSignedInt: (value: number, minValue: number, maxValue: number) => number;
+/**
+ * Constrain a float value to the given precision range
+ * @param value - the value to constrain
+ * @param minValue - the minimum value
+ * @param maxValue - the maximum value
+ * @param precision - the precision range
+ */
+export declare const constrainFloat: (value: number, minValue: number, maxValue: number, precision: PrecisionRangeType) => number;

package/dist/update/updateValues.d.ts

@@ -1,15 +1,16 @@
-import { DataEntry, ComplexDataEntry } from '../types/dataEntry';
+import { UpdateWithStateEntries, UpdateWithValidationTypes, UpdateWithValuesEntries } from '../types';
 /**
  * Method to update the value of a data entry
+ * MUTATES OBJECT IN PLACE!
  * @param original - the original data entry
  * @param update - the update data entry
  * @returns the updated data entry
  */
-export declare const updateValue: (original: DataEntry, update: DataEntry) => DataEntry;
+export declare const updateValueEntry: <T extends UpdateWithValuesEntries>(original: T, update: T["value"]) => T;
+export declare const constrainValue: <T extends UpdateWithValidationTypes>(original: T, update: T["value"]) => T["value"];
 /**
  * Method to update the value of a data entry
  * @param original - the original data entry
  * @param update - the update data entry
- * @returns the updated data entry
  */
-export declare const updateComplexValue: (original: ComplexDataEntry, update: ComplexDataEntry) => ComplexDataEntry;
+export declare const updateStateEntry: <T extends UpdateWithStateEntries>(original: T, update: T["state"]) => T;

package/dist/update/validateUtils.d.ts

@@ -0,0 +1,2 @@
+import { DataEntry } from '../types';
+export declare const validateDataEntry: <T extends DataEntry>(descriptorValue: T | null, differentValue: T | null) => T | null;

package/dist/update/versionUpdate.d.ts

@@ -1,2 +1,3 @@
-import { VersionDataEntry } from '../types/dataEntry';
-export declare const updateValue: (original: VersionDataEntry, update: VersionDataEntry) => VersionDataEntry;
+import { VersionDataEntry } from '../types';
+export declare const constrainValue: <T extends VersionDataEntry>(original: T, update: T["value"]) => T["value"];
+export declare const updateValue: <T extends VersionDataEntry>(original: T, update: T["value"]) => T;

package/dist/utils/interpolateData.d.ts

@@ -1,3 +1,4 @@
+import { ConstantBitWidthDataTypes } from '@/enums';
 import { DataEntry } from '../types/dataEntry';
 /**
  * helper method to interpolate a data entry at a given t parameter
@@ -5,4 +6,6 @@ import { DataEntry } from '../types/dataEntry';
  * @param t - number between 0 and 1
  * @returns updated data entry
  */
-export declare const interpolateEntryAt: (dataEntry: DataEntry, t: number) => DataEntry;
+export declare const interpolateEntryAt: (dataEntry: DataEntry & {
+    type: (typeof ConstantBitWidthDataTypes)[number];
+}, t: number) => DataEntry;

package/dist/utils/relativeValue.d.ts

@@ -1,2 +1,5 @@
+import { ConstantBitWidthDataTypes } from '@/enums';
 import { DataEntry } from '../types/dataEntry';
-export declare const getRelativeValue: (dataEntry: DataEntry) => number;
+export declare const getRelativeValue: (dataEntry: DataEntry & {
+    type: (typeof ConstantBitWidthDataTypes)[number];
+}) => Number;

package/package.json

@@ -6,7 +6,7 @@
     "dist/*"
   ],
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "author": "Jonas Ward",
   "description": "Library for creating web safe base64 objects with custom bith widths and dynamic values.",
   "scripts": {
@@ -17,7 +17,7 @@
   "devDependencies": {
     "bun-types": "latest",
     "rimraf": "^6.0.1",
-    "typescript": "^5.0.0",
+    "typescript": "^5.9.3",
     "@types/bun": "latest"
   }
 }