url-safe-bitpacking 0.3.4 → 0.3.6

package/README.md

@@ -29,10 +29,10 @@ From a memory footprint perspective there are two types of attributes in an obje
 | Predefined Bitwidth      | **✓** | **✓** | **✓** | **✓** | **✓** | ✗        | ✗      | ✗          | ✗     | ✗     |
 | Has State Bit            | ✗     | ✗     | ✗     | ✗     | ✗     | **✓**    | **✓**  | **✓**      | **✓** | ✗     |
 | Min Bitwidth             | `4`         | `1`         | `1`         | `0`         | `0`         | `1`            | –            | –                | –           | –           |
-| Max Bitwidth             | `10`        | `1`         | `10`        | `21`        | `21`        | `10`           | –            | –                | –           | –           |
+| Max Bitwidth             | `10`        | `1`         | `8`        | `10`        | `21`        | `8`           | –            | –                | –           | –           |
 | Min State Bitwidth       | –           | –           | –           | –           | –           | `0`            | `1`          | `1`              | `0`         | –           |
 | Max State Bitwidth       | –           | –           | –           | –           | –           | `10`           | `1`          | `10`             | `10`        | –           |
-| Max Available States     | `1024`      | `2`         | `1024`      | `2097152`   | `2097152`   | `1024 x 1024`  | `2`          | `1024`           | `1024`      | `0`         |
+| Max Available States     | `1024`      | `2`         | `256`      | `1024`   | `2097152`   | `1024 x 256`  | `2`          | `256`           | `1024`      | -         |
 | Has Mapping              | ✗     | ✗     | **✓** | ✗     | ✗     | **✓**    | ✗      | **✓**      | ✗     | ✗     |
 | Has Nested Objects       | ✗     | ✗     | ✗     | ✗     | ✗     | ✗        | **✓**  | **✓**      | **✓** | **✓** |
 | **UPDATING**             | **VERSION** | **BOOLEAN** | **ENUM**    | **INT**     | **FLOAT**   | **ENUM_ARRAY** | **OPTIONAL** | **ENUM_OPTIONS** | **ARRAY**   | **OBJECT**  |

package/dist/factory/copy.d.ts

@@ -0,0 +1,6 @@
+import { DataEntry } from '../types';
+/**
+ * Method that only copies the state and / or value of a data entry (doesn't touches the descriptor)
+ * @param d - `DataEntry` to copy
+ */
+export declare const getCopy: (d: DataEntry | null) => DataEntry | null;

package/dist/factory/enumOptionsFactory.d.ts

@@ -1,3 +1,3 @@
-import { DataEntry, EnumOptionsDataEntry, EnumOptionsType } from '../types';
-export type EnumOptionsFactory = (descriptor: (DataEntry | null)[], defaultState?: number, name?: string, options?: EnumOptionsType) => EnumOptionsDataEntry;
+import { EnumOptionsDataEntry, ObjectDataEntry } from '../types';
+export type EnumOptionsFactory = (descriptor: (ObjectDataEntry | null)[], defaultState?: number, name?: string) => EnumOptionsDataEntry;
 export declare const create: EnumOptionsFactory;

package/dist/index.js

@@ -561,6 +561,30 @@ var create6 = (value, options, minCount = 0, maxCount = 10, name = "enum array")
   return { type: "ENUM_ARRAY", minCount: r.min, maxCount: r.max, value, max, name, mapping, stateBits: r.bitwidth };
 };
 
+// src/factory/copy.ts
+var getCopy = (d) => {
+  if (d === null)
+    return null;
+  switch (d.type) {
+    case "VERSION":
+    case "BOOLEAN":
+    case "ENUM":
+    case "INT":
+    case "FLOAT":
+      return { ...d };
+    case "ENUM_ARRAY":
+      return { ...d, value: [...d.value] };
+    case "OPTIONAL":
+      return { ...d, value: getCopy(d.value) };
+    case "ENUM_OPTIONS":
+      return { ...d, value: getCopy(d.value) };
+    case "ARRAY":
+      return { ...d, value: d.value.map(getCopy) };
+    case "OBJECT":
+      return { ...d, value: d.value.map(getCopy) };
+  }
+};
+
 // src/factory/optionalFactory.ts
 var create7 = (descriptor, defaultState = false, name = "an optional") => {
   if (descriptor[0] === null && descriptor[1] === null)
@@ -571,7 +595,7 @@ var create7 = (descriptor, defaultState = false, name = "an optional") => {
     type: "OPTIONAL",
     state: defaultState,
     descriptor,
-    value: JSON.parse(JSON.stringify(defaultState ? descriptor[1] : descriptor[0])),
+    value: getCopy(defaultState ? descriptor[1] : descriptor[0]),
     name,
     stateBits: 1
   };
@@ -589,21 +613,18 @@ var getMinimumBitsForInteger = (v) => Math.ceil(Math.log2(v + 1));
 // src/factory/enumOptionsFactory.ts
 var maxEnumOptions = 64;
 var maxEnumOptionsBits = getMinimumBitsForInteger(maxEnumOptions);
-var create8 = (descriptor, defaultState = 0, name = "enum options", options) => {
-  if (descriptor.length < 2)
-    throw new Error("descriptor must have at least two entries");
+var create8 = (descriptor, defaultState = 0, name = "enum options") => {
+  if (descriptor.length < 1)
+    throw new Error("descriptor must have at least one entry");
   if (descriptor.length - 1 < defaultState)
     throw new Error("defaultState must be less than the length of the descriptor");
-  const mapping = [];
-  if (options) {
-    const { max, mapping: mapping2 } = getEnumMaxAndMappingFromOptions(options);
-    if (max !== descriptor.length - 1)
-      throw new Error("max must be equal to the length of the descriptor - 1");
-    mapping2.push(...mapping2);
-  } else
-    mapping.push(...descriptor.map((_, i) => i));
+  if (descriptor.some((v) => v !== null && v.type !== "OBJECT"))
+    throw new Error("descriptors must be either ObjectDataEntry or null");
+  const { max, mapping } = getEnumMaxAndMappingFromOptions(descriptor.map((v, i) => v ? v.name : i));
+  if (max !== descriptor.length - 1)
+    throw new Error("max must be equal to the length of the descriptor - 1");
   return {
-    value: JSON.parse(JSON.stringify(descriptor[defaultState])),
+    value: getCopy(descriptor[defaultState]),
     descriptor,
     name,
     mapping,
@@ -617,7 +638,7 @@ var create8 = (descriptor, defaultState = 0, name = "enum options", options) =>
 var create9 = (descriptor, defaultState = 0, minCount = 0, maxCount = 10, name = "an array") => {
   const r = validateUnsignedInt(minCount, maxCount, defaultState, name, "ARRAY", IntegerMaxBits);
   return {
-    value: [...Array(r.value)].map(() => JSON.parse(JSON.stringify(descriptor))),
+    value: Array.from({ length: r.value }, () => getCopy(descriptor)),
     descriptor,
     type: "ARRAY",
     minCount: r.min,
@@ -633,7 +654,7 @@ var create10 = (descriptor, name = "an object") => {
   return {
     type: "OBJECT",
     descriptor,
-    value: descriptor,
+    value: descriptor.map(getCopy),
     name
   };
 };
@@ -929,6 +950,7 @@ var getObjectForDataEntries = (entries) => {
   });
   return object;
 };
+var getStringForDataEntries = (values) => Array.isArray(values) && values.every((v) => typeof v === "string" && v.length === 1) ? values.join("") : values;
 var getStateData = (entry) => {
   switch (entry.type) {
     case "BOOLEAN":
@@ -939,7 +961,7 @@ var getStateData = (entry) => {
     case "ENUM":
       return entry.mapping[entry.value];
     case "ENUM_ARRAY":
-      return entry.value.map((v) => entry.mapping[v]);
+      return getStringForDataEntries(entry.value.map((v) => entry.mapping[v]));
     case "OPTIONAL":
       return entry.value === null ? null : getStateData(entry.value);
     case "ENUM_OPTIONS":
@@ -948,7 +970,7 @@ var getStateData = (entry) => {
         switch (entry.value.type) {
           case "OBJECT":
             return {
-              ...getStateData(entry.value),
+              ...getObjectForDataEntries(entry.value.value),
               state
             };
           default:
@@ -959,7 +981,7 @@ var getStateData = (entry) => {
     case "OBJECT":
       return getObjectForDataEntries(entry.value);
     case "ARRAY":
-      return entry.value.map((v) => getStateData(v));
+      return getStringForDataEntries(entry.value.map(getStateData));
   }
 };
 // src/utils/interpolateData.ts

package/dist/types/enumOptionsData.d.ts

@@ -1,10 +1,10 @@
-import { DataEntry } from './dataEntry';
+import { ObjectDataEntry } from './dataEntry';
 import { EnumMappingType } from './enumData';
 export type EnumOptionsData = {
     type: 'ENUM_OPTIONS';
     stateBits: number;
     state: number;
-    descriptor: (DataEntry | null)[];
+    descriptor: (ObjectDataEntry | null)[];
     mapping: EnumMappingType;
-    value: DataEntry | null;
+    value: ObjectDataEntry | null;
 };

package/package.json

@@ -6,7 +6,7 @@
     "dist/*"
   ],
   "type": "module",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "author": "Jonas Ward",
   "description": "Library for creating web safe base64 objects with custom bith widths and dynamic values.",
   "scripts": {