@bare-ts/lib 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## 0.1.0 (2022-01-02)
+
+* `ByteCursor` abstraction to read and write safely a buffer of bytes
+
+* Enable to configure at runtime:
+    - initial buffer length
+    - maximum buffer length
+    - thresholds (string length) for switching from custom to native UTF-8 decoders/encoders
+
+* Decoders and encoders for basic types (bool, opaque data, floats, integers, typed arrays, UTF-8 string)

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the usered form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,15 @@
+# bare-ts library
+
+![CI status][ci]
+
+[BARE][bare] (Binary Application Record Encoding) is a schema-based binary format that favors compactness and simplicity.
+[bare-ts/lib](#) provides decoders and encoders for basic BARE types.
+
+Please, take a look to [bare-ts/tools][bare-ts-tools] for more information.
+
+Warning: BARE specification is currently a IEF draft.
+The specification is likely to evolve before its final release. [bare-ts](#) implements an ongoing draft that is not published yet.
+
+[bare]: https://baremessages.org
+[bare-ts-tools]: https://github.com/bare-ts/tools
+[ci]: https://github.com/bare-ts/lib/actions/workflows/ci.yml/badge.svg

package/dist/codec/data.d.ts

@@ -0,0 +1,5 @@
+import type { ByteCursor } from "../core/index.js";
+export declare function decodeData(bc: ByteCursor): ArrayBuffer;
+export declare function encodeData(bc: ByteCursor, x: ArrayBuffer): void;
+export declare function decodeFixedData(bc: ByteCursor, len: number): ArrayBuffer;
+export declare function encodeFixedData(bc: ByteCursor, x: ArrayBuffer, len: number): void;

package/dist/codec/float-array.d.ts

@@ -0,0 +1,14 @@
+import type { ByteCursor } from "../core/index.js";
+export declare const decodeF32FixedArray: typeof decodeF32FixedArrayLE;
+declare function decodeF32FixedArrayLE(bc: ByteCursor, len: number): Float32Array;
+export declare const encodeF32FixedArray: typeof encodeF32FixedArrayLE;
+declare function encodeF32FixedArrayLE(bc: ByteCursor, x: Float32Array, len: number): void;
+export declare function decodeF32Array(bc: ByteCursor): Float32Array;
+export declare function encodeF32Array(bc: ByteCursor, x: Float32Array): void;
+export declare const decodeF64FixedArray: typeof decodeF64FixedArrayLE;
+declare function decodeF64FixedArrayLE(bc: ByteCursor, len: number): Float64Array;
+export declare const encodeF64FixedArray: typeof encodeF64FixedArrayLE;
+declare function encodeF64FixedArrayLE(bc: ByteCursor, x: Float64Array, len: number): void;
+export declare function decodeF64Array(bc: ByteCursor): Float64Array;
+export declare function encodeF64Array(bc: ByteCursor, x: Float64Array): void;
+export {};

package/dist/codec/i16-array.d.ts

@@ -0,0 +1,8 @@
+import type { ByteCursor } from "../core/index.js";
+export declare const decodeI16FixedArray: typeof decodeI16FixedArrayLE;
+export declare function decodeI16Array(bc: ByteCursor): Int16Array;
+declare function decodeI16FixedArrayLE(bc: ByteCursor, len: number): Int16Array;
+export declare const encodeI16FixedArray: typeof encodeI16FixedArrayLE;
+export declare function encodeI16Array(bc: ByteCursor, x: Int16Array): void;
+declare function encodeI16FixedArrayLE(bc: ByteCursor, x: Int16Array, len: number): void;
+export {};

package/dist/codec/i32-array.d.ts

@@ -0,0 +1,8 @@
+import type { ByteCursor } from "../core/index.js";
+export declare const decodeI32FixedArray: typeof decodeI32FixedArrayLE;
+export declare function decodeI32Array(bc: ByteCursor): Int32Array;
+declare function decodeI32FixedArrayLE(bc: ByteCursor, len: number): Int32Array;
+export declare const encodeI32FixedArray: typeof encodeI32FixedArrayLE;
+export declare function encodeI32Array(bc: ByteCursor, x: Int32Array): void;
+declare function encodeI32FixedArrayLE(bc: ByteCursor, x: Int32Array, len: number): void;
+export {};

package/dist/codec/i64-array.d.ts

@@ -0,0 +1,8 @@
+import type { ByteCursor } from "../core/index.js";
+export declare const decodeI64FixedArray: typeof decodeI64FixedArrayLE;
+export declare function decodeI64Array(bc: ByteCursor): BigInt64Array;
+declare function decodeI64FixedArrayLE(bc: ByteCursor, len: number): BigInt64Array;
+export declare const encodeI64FixedArray: typeof encodeI64FixedArrayLE;
+export declare function encodeI64Array(bc: ByteCursor, x: BigInt64Array): void;
+declare function encodeI64FixedArrayLE(bc: ByteCursor, x: BigInt64Array, len: number): void;
+export {};

package/dist/codec/i8-array.d.ts

@@ -0,0 +1,5 @@
+import type { ByteCursor } from "../core/index.js";
+export declare function decodeI8Array(bc: ByteCursor): Int8Array;
+export declare function encodeI8Array(bc: ByteCursor, x: Int8Array): void;
+export declare function decodeI8FixedArray(bc: ByteCursor, len: number): Int8Array;
+export declare function encodeI8FixedArray(bc: ByteCursor, x: Int8Array, len: number): void;

package/dist/codec/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./data.js";
+export * from "./float-array.js";
+export * from "./i16-array.js";
+export * from "./i32-array.js";
+export * from "./i64-array.js";
+export * from "./i8-array.js";
+export * from "./primitive.js";
+export * from "./string.js";
+export * from "./u16-array.js";
+export * from "./u32-array.js";
+export * from "./u64-array.js";
+export * from "./u8-array.js";
+export * from "./u8-clamped-array.js";

package/dist/codec/primitive.d.ts

@@ -0,0 +1,37 @@
+import { type ByteCursor } from "../core/index.js";
+export declare function decodeBool(bc: ByteCursor): boolean;
+export declare function encodeBool(bc: ByteCursor, x: boolean): void;
+export declare function decodeF32(bc: ByteCursor): number;
+export declare function encodeF32(bc: ByteCursor, x: number): void;
+export declare function decodeF64(bc: ByteCursor): number;
+export declare function encodeF64(bc: ByteCursor, x: number): void;
+export declare function decodeI8(bc: ByteCursor): number;
+export declare function encodeI8(bc: ByteCursor, x: number): void;
+export declare function decodeI16(bc: ByteCursor): number;
+export declare function encodeI16(bc: ByteCursor, x: number): void;
+export declare function decodeI32(bc: ByteCursor): number;
+export declare function encodeI32(bc: ByteCursor, x: number): void;
+export declare function decodeI64(bc: ByteCursor): bigint;
+export declare function encodeI64(bc: ByteCursor, x: bigint): void;
+export declare function decodeI64Safe(bc: ByteCursor): number;
+export declare function encodeI64Safe(bc: ByteCursor, x: number): void;
+export declare function decodeInt(bc: ByteCursor): bigint;
+export declare function encodeInt(bc: ByteCursor, x: bigint): void;
+export declare function decodeIntSafe(bc: ByteCursor): number;
+export declare function encodeIntSafe(bc: ByteCursor, x: number): void;
+export declare function decodeU8(bc: ByteCursor): number;
+export declare function encodeU8(bc: ByteCursor, x: number): void;
+export declare function decodeU16(bc: ByteCursor): number;
+export declare function encodeU16(bc: ByteCursor, x: number): void;
+export declare function decodeU32(bc: ByteCursor): number;
+export declare function encodeU32(bc: ByteCursor, x: number): void;
+export declare function decodeU64(bc: ByteCursor): bigint;
+export declare function encodeU64(bc: ByteCursor, x: bigint): void;
+export declare function decodeU64Safe(bc: ByteCursor): number;
+export declare function encodeU64Safe(bc: ByteCursor, x: number): void;
+export declare function decodeUint(bc: ByteCursor): bigint;
+export declare function encodeUint(bc: ByteCursor, x: bigint): void;
+export declare function decodeUintSafe(bc: ByteCursor): number;
+export declare function encodeUintSafe(bc: ByteCursor, x: number): void;
+export declare function decodeVoid(_dc: ByteCursor): undefined;
+export declare function encodeVoid(_dc: ByteCursor, _x: undefined): void;

package/dist/codec/string.d.ts

@@ -0,0 +1,3 @@
+import type { ByteCursor } from "../core/index.js";
+export declare function decodeString(bc: ByteCursor): string;
+export declare function encodeString(bc: ByteCursor, x: string): void;

package/dist/codec/u16-array.d.ts

@@ -0,0 +1,8 @@
+import type { ByteCursor } from "../core/index.js";
+export declare const decodeU16FixedArray: typeof decodeU16FixedArrayLE;
+export declare function decodeU16Array(bc: ByteCursor): Uint16Array;
+declare function decodeU16FixedArrayLE(bc: ByteCursor, len: number): Uint16Array;
+export declare const encodeU16FixedArray: typeof encodeU16FixedArrayLE;
+export declare function encodeU16Array(bc: ByteCursor, x: Uint16Array): void;
+declare function encodeU16FixedArrayLE(bc: ByteCursor, x: Uint16Array, len: number): void;
+export {};

package/dist/codec/u32-array.d.ts

@@ -0,0 +1,8 @@
+import type { ByteCursor } from "../core/index.js";
+export declare const decodeU32FixedArray: typeof decodeU32FixedArrayLE;
+export declare function decodeU32Array(bc: ByteCursor): Uint32Array;
+declare function decodeU32FixedArrayLE(bc: ByteCursor, len: number): Uint32Array;
+export declare const encodeU32FixedArray: typeof encodeU32FixedArrayLE;
+export declare function encodeU32Array(bc: ByteCursor, x: Uint32Array): void;
+declare function encodeU32FixedArrayLE(bc: ByteCursor, x: Uint32Array, len: number): void;
+export {};

package/dist/codec/u64-array.d.ts

@@ -0,0 +1,8 @@
+import type { ByteCursor } from "../core/index.js";
+export declare const decodeU64FixedArray: typeof decodeU64FixedArrayLE;
+export declare function decodeU64Array(bc: ByteCursor): BigUint64Array;
+declare function decodeU64FixedArrayLE(bc: ByteCursor, len: number): BigUint64Array;
+export declare const encodeU64FixedArray: typeof encodeU64FixedArrayLE;
+export declare function encodeU64Array(bc: ByteCursor, x: BigUint64Array): void;
+declare function encodeU64FixedArrayLE(bc: ByteCursor, x: BigUint64Array, len: number): void;
+export {};

package/dist/codec/u8-array.d.ts

@@ -0,0 +1,5 @@
+import type { ByteCursor } from "../core/index.js";
+export declare function decodeU8Array(bc: ByteCursor): Uint8Array;
+export declare function encodeU8Array(bc: ByteCursor, x: Uint8Array): void;
+export declare function decodeU8FixedArray(bc: ByteCursor, len: number): Uint8Array;
+export declare function encodeU8FixedArray(bc: ByteCursor, x: Uint8Array, len: number): void;

package/dist/codec/u8-clamped-array.d.ts

@@ -0,0 +1,5 @@
+import type { ByteCursor } from "../core/index.js";
+export declare function decodeU8ClampedArray(bc: ByteCursor): Uint8ClampedArray;
+export declare function encodeU8ClampedArray(bc: ByteCursor, x: Uint8ClampedArray): void;
+export declare function decodeU8ClampedFixedArray(bc: ByteCursor, len: number): Uint8ClampedArray;
+export declare function encodeU8ClampedFixedArray(bc: ByteCursor, x: Uint8ClampedArray, len: number): void;

package/dist/core/bare-error.d.ts

@@ -0,0 +1,9 @@
+export declare class BareError extends Error {
+    readonly name: "BareError";
+    readonly cause: unknown;
+    readonly issue: string;
+    readonly offset: number;
+    constructor(offset: number, issue: string, opts?: {
+        cause: unknown;
+    });
+}

package/dist/core/byte-cursor.d.ts

@@ -0,0 +1,31 @@
+import type { Config } from "./config.js";
+export declare class ByteCursor {
+    readonly config: Config;
+    offset: number;
+    view: DataView;
+    constructor(bytes: ArrayBuffer | Uint8Array, config: Config);
+    /**
+     * @param min number of needed bytes
+     * @throw BareError when there is not enough bytes
+     */
+    check(min: number): void;
+    /**
+     * @param min number of bytes to reserve
+     */
+    reserve(min: number): void;
+    /**
+     * Advance cursor by {@code len} bytes and return a view of the read bytes.
+     * The returned array should not be modified.
+     *
+     * @param len number of bytes to read
+     * @returns read bytes
+     */
+    read(len: number): Uint8Array;
+    /**
+     * Write {@code bytes} in the buffer and advance cursor by
+     *  {@code bytes.length}
+     *
+     * @param bytes bytes to copy
+     */
+    write(bytes: Uint8Array): void;
+}

package/dist/core/config.d.ts

@@ -0,0 +1,7 @@
+export interface Config {
+    readonly initialBufferLength: number;
+    readonly maxBufferLength: number;
+    readonly textDecoderThreshold: number;
+    readonly textEncoderThreshold: number;
+}
+export declare function Config(part: Partial<Config>): Config;

package/dist/core/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./bare-error.js";
+export * from "./config.js";
+export * from "./byte-cursor.js";