url-safe-bitpacking 0.1.12 → 0.1.13

package/README.md

@@ -11,16 +11,13 @@ Package for creating definitions of parametric models that can be stored as comp
 | updating model entries                               | ✓  | ✓  |          |
 | re-using data from old model on change in definition | ½ | ¼ |          |
 | flattening and reading of the objects                | ✓  | ✓  | ¿ |
+| arrays (both bit-level as arrays of objects)         | ½ | ¼ |          |
 
 ## concept
 
-The goal of this library is to offer a flexible, minimal and, variable object definition that can be stored in the browser URL. The main imagined use-case is parametric models that have nested and variable sub-object definitions.
+The goal of this library is to offer a flexible, minimal and, variable object definition that can be stored in the browser URL. The main imagined use-case is parametric models that have nested and variable sub-object definitions. The library heavily relies on the bitpacking of custom bitwidth numeric values. Because of that, the biggest trade-off for this library is legibility. Without the related object definition, it would be impossible to reconstruct the state. The big advantage though is the ability to store rather many variables in a very condensed URL, allowing to store all information in rather short urls which then can be used for qr code generation.
 
-The library heavily relies on the bitpacking of custom bitwidth numeric values. Because of that, the biggest trade-off for this library is legibility. Without the related object definition, it would be impossible to reconstruct the state.
-
-The big advantage though is the ability to store rather many variables in a very condensed URL, allowing to store all information in rather short urls which then can be used for qr code generation.
-
-## data types
+## bit-level data types
 
 Currently, there are 4 data types implemented (+1 special case for safety). All data entries have a name that will behave as an attribute name in the object.
 
@@ -64,11 +61,11 @@ There is also a Version object which is a special case of the enum data type and
 DataEntryFactory.createVersion(0, 8, 'version');
 ```
 
-## attribute map
+## nested attribute definitions
 
-On a macro level there are two types of data. Either Single Level array objects or Double Nested array objects.
+More often than not in parametric models, certain data belongs together. It can also happen that the specific state of some values will have an impact on other ones being present (or which ranges are allowed). To be able to deal with this there is the option to nest data. I tried to come with an as concise yet versatile way of defining the object definitions.
 
-Single-level nested objects are arrays in which the entries it contains describe themselves. The Double Nested arrays describe objects that will have a variable size, that depends on the linked data entry that is selected is set in state.
+### single nes
 
 For the Double Nested arrays there are currently two variations: either an Optional type, which only accepts two values of which is an empty array and will be toggle on/off in relation to a certain boolean data entry.
 

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { DataType } from './enums';
 export { DataEntryFactory } from './factory';
-export { SingleLevelContentType, NestedContentDataType, NestedContentType, DoubleLevelContentType, NonEmptyValidEntryArrayType, OptionalEntryDataType, EnumEntryDataType, PrecisionRangeType, SignificandMaxBits, FloatData, IntegerMaxBits, IntData, VersionRangeType, VersionData, BooleanData, DataEntry, DataEntryArray, } from './types';
-export { createParserObject, getStateValue, getBase64String } from './objectmap';
+export { SingleLevelContentType, NestedContentDataType, NestedContentType, DoubleLevelContentType, NonEmptyValidEntryArrayType, OptionalEntryDataType, EnumEntryDataType, PrecisionRangeType, SignificandMaxBits, FloatData, IntegerMaxBits, IntData, VersionRangeType, VersionData, BooleanData, DataEntry, DataEntryArray, StateDataType, StateValueType, EnumSemantics, } from './types';
+export { createParserObject, getStateValue, getBase64String, getDataEntryArray } from './objectmap';
 export { parseBase64ToBits } from './parsers';
 export { interpolateEntryAt, getRelativeValue } from './utils';

package/dist/index.js

@@ -547,6 +547,7 @@ export {
   interpolateEntryAt,
   getStateValue,
   getRelativeValue,
+  getDataEntryArray,
   getBase64String,
   createParserObject,
   SignificandMaxBits,

package/package.json

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