@terascope/core-utils 2.0.0-dev.10

package/dist/src/entities/data-entity.js

@@ -0,0 +1,354 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { parseJSON } from '../json.js';
+import { isSimpleObject } from '../objects.js';
+import { getTypeOf } from '../deps.js';
+import { locked } from '../decorators.js';
+import { ensureBuffer, isBuffer } from '../buffers.js';
+import { isDataEntity } from './utils.js';
+import { getValidDate, getTime } from '../dates.js';
+import * as i from './interfaces.js';
+import { defineEntityProperties, makeMetadata, isValidKey, jsonToBuffer } from './utils.js';
+/**
+ * A wrapper for data that can hold additional metadata properties.
+ * A DataEntity should be essentially transparent to use within operations.
+ *
+ * NOTE: Use `DataEntity.make`, `DataEntity.fromBuffer` and `DataEntity.makeArray`
+ * in production for potential performance gains
+ */
+export class DataEntity {
+    static make(input, metadata) {
+        if (DataEntity.isDataEntity(input)) {
+            if (metadata) {
+                for (const [key, val] of Object.entries(metadata)) {
+                    input.setMetadata(key, val);
+                }
+            }
+            return input;
+        }
+        return new DataEntity(input, metadata);
+    }
+    /**
+     * A utility for safely converting an input of an object,
+     * or an array of objects, to an array of DataEntities.
+     * This will detect if passed an already converted input and return it.
+     */
+    static makeArray(input) {
+        if (!Array.isArray(input)) {
+            return [DataEntity.make(input)];
+        }
+        if (DataEntity.isDataEntityArray(input)) {
+            return input;
+        }
+        return input.map((d) => DataEntity.make(d));
+    }
+    /**
+     * Create a new instance of a DataEntity.
+     *
+     * If the second param `withData` is set to `true`
+     * both the data and metadata will be forked, if set
+     * to `false` only the metadata will be copied. Defaults
+     * to `true`
+     */
+    static fork(input, withData = true) {
+        if (!DataEntity.isDataEntity(input)) {
+            throw new Error(`Invalid input to fork, expected DataEntity, got ${getTypeOf(input)}`);
+        }
+        const { _createTime, ...metadata } = input.getMetadata();
+        if (withData) {
+            return DataEntity.make(input, metadata);
+        }
+        return DataEntity.make({}, metadata);
+    }
+    /**
+     * A utility for converting a `Buffer` to a `DataEntity`,
+     * using the DataEntity encoding.
+     *
+     * @param input A `Buffer` to parse to JSON
+     * @param opConfig The operation config used to get the encoding type of the Buffer,
+     * defaults to "json"
+     * @param metadata Optionally add any metadata
+     */
+    static fromBuffer(input, opConfig, metadata) {
+        const { _encoding = i.DataEncoding.JSON } = opConfig || {};
+        if (_encoding === i.DataEncoding.JSON) {
+            return DataEntity.make(parseJSON(input), metadata);
+        }
+        if (_encoding === i.DataEncoding.RAW) {
+            const entity = DataEntity.make({}, metadata);
+            entity.setRawData(input);
+            return entity;
+        }
+        throw new Error(`Unsupported encoding type, got "${_encoding}"`);
+    }
+    /**
+     * Verify that an input is the `DataEntity`
+     */
+    static isDataEntity(input) {
+        return isDataEntity(input);
+    }
+    /**
+     * Verify that an input is an Array of DataEntities,
+     */
+    static isDataEntityArray(input) {
+        if (input == null)
+            return false;
+        if (!Array.isArray(input))
+            return false;
+        if (input.length === 0)
+            return true;
+        return isDataEntity(input[0]);
+    }
+    /**
+     * Safely get the metadata from a `DataEntity`.
+     * If the input is object it will get the property from the object
+     *
+     * **DEPRECATED:** Since this isn't recommended to be used, and will
+     * be removed in future releases.
+     *
+     * @deprecated
+     */
+    static getMetadata(input, field) {
+        if (input == null)
+            return undefined;
+        if (DataEntity.isDataEntity(input)) {
+            const val = field ? input.getMetadata(field) : input.getMetadata();
+            return val;
+        }
+        return field ? input[field] : undefined;
+    }
+    static [Symbol.hasInstance](instance) {
+        // prevent automatically thinking a base DataEntity is
+        // an instance of a class that extends from a DataEntity
+        if (this.name !== 'DataEntity' && this.name !== 'Object') {
+            return false;
+        }
+        return isDataEntity(instance);
+    }
+    // @ts-expect-error the initializer is set in defineEntityProperties
+    [i.__ENTITY_METADATA_KEY];
+    // @ts-expect-error the initializer is set in defineEntityProperties
+    [i.__IS_DATAENTITY_KEY];
+    constructor(data, metadata) {
+        if (data && !isSimpleObject(data)) {
+            throw new Error(`Invalid data source, must be an object, got "${getTypeOf(data)}"`);
+        }
+        defineEntityProperties(this);
+        // @ts-expect-error the initializer is set in defineEntityProperties
+        this[i.__ENTITY_METADATA_KEY].metadata = makeMetadata(metadata);
+        if (data) {
+            Object.assign(this, data);
+        }
+    }
+    getMetadata(key) {
+        if (key) {
+            // @ts-expect-error TODO: fixme
+            return this[i.__ENTITY_METADATA_KEY].metadata[key];
+        }
+        return this[i.__ENTITY_METADATA_KEY].metadata;
+    }
+    /**
+     * Given a field and value set the metadata on the record
+    */
+    setMetadata(field, value) {
+        if (field == null || field === '') {
+            throw new Error('Missing field to set in metadata');
+        }
+        if (field === '_createTime') {
+            throw new Error(`Cannot set readonly metadata property ${String(field)}`);
+        }
+        // @ts-expect-error TODO: fixme
+        this[i.__ENTITY_METADATA_KEY].metadata[field] = value;
+    }
+    /**
+     * Get the unique document `_key` from the metadata.
+     * If no `_key` is found, an error will be thrown
+    */
+    getKey() {
+        const key = this[i.__ENTITY_METADATA_KEY].metadata._key;
+        if (!isValidKey(key)) {
+            throw new Error('No key has been set in the metadata');
+        }
+        return key;
+    }
+    /**
+     * Set the unique document `_key` from the metadata.
+     * If no `_key` is found, an error will be thrown
+    */
+    setKey(key) {
+        if (!isValidKey(key)) {
+            throw new Error('Invalid key to set in metadata');
+        }
+        this[i.__ENTITY_METADATA_KEY].metadata._key = key;
+    }
+    /**
+     * Get the time at which this entity was created.
+    */
+    getCreateTime() {
+        const val = this[i.__ENTITY_METADATA_KEY].metadata._createTime;
+        const date = getValidDate(val);
+        if (date === false) {
+            throw new Error('Missing _createTime');
+        }
+        return date;
+    }
+    /**
+     * Get the time at which the data was ingested into the source data
+     *
+     * If none is found, `undefined` will be returned.
+     * If an invalid date is found, `false` will be returned.
+    */
+    getIngestTime() {
+        const val = this[i.__ENTITY_METADATA_KEY].metadata._ingestTime;
+        if (val == null)
+            return undefined;
+        return getValidDate(val);
+    }
+    /**
+     * Set the time at which the data was ingested into the source data
+     *
+     * If the value is empty it will set the time to now.
+     * If an invalid date is given, an error will be thrown.
+     */
+    setIngestTime(val) {
+        const unixTime = getTime(val);
+        if (unixTime === false) {
+            throw new Error(`Invalid date format, got ${getTypeOf(val)}`);
+        }
+        this[i.__ENTITY_METADATA_KEY].metadata._ingestTime = unixTime;
+    }
+    /**
+     * Get the time at which the data was consumed by the reader.
+     *
+     * If none is found, `undefined` will be returned.
+     * If an invalid date is found, `false` will be returned.
+    */
+    getProcessTime() {
+        const val = this[i.__ENTITY_METADATA_KEY].metadata._ingestTime;
+        if (val == null)
+            return undefined;
+        return getValidDate(val);
+    }
+    /**
+    * Set the time at which the data was consumed by the reader
+    *
+    * If the value is empty it will set the time to now.
+    * If an invalid date is given, an error will be thrown.
+    */
+    setProcessTime(val) {
+        const unixTime = getTime(val);
+        if (unixTime === false) {
+            throw new Error(`Invalid date format, got ${getTypeOf(val)}`);
+        }
+        this[i.__ENTITY_METADATA_KEY].metadata._ingestTime = unixTime;
+    }
+    /**
+     * Get time associated from a specific field on source data or message
+     *
+     * If none is found, `undefined` will be returned.
+     * If an invalid date is found, `false` will be returned.
+    */
+    getEventTime() {
+        const val = this[i.__ENTITY_METADATA_KEY].metadata._ingestTime;
+        if (val == null)
+            return undefined;
+        return getValidDate(val);
+    }
+    /**
+     * Set time associated from a specific field on source data or message
+     *
+     * If the value is empty it will set the time to now.
+     * If an invalid date is given, an error will be thrown.
+     */
+    setEventTime(val) {
+        const unixTime = getTime(val);
+        if (unixTime === false) {
+            throw new Error(`Invalid date format, got ${getTypeOf(val)}`);
+        }
+        this[i.__ENTITY_METADATA_KEY].metadata._ingestTime = unixTime;
+    }
+    /**
+     * Get the raw data, usually used for encoding type `raw`.
+     * If there is no data, an error will be thrown
+    */
+    getRawData() {
+        const buf = this[i.__ENTITY_METADATA_KEY].rawData;
+        if (isBuffer(buf))
+            return buf;
+        throw new Error('No data has been set');
+    }
+    /**
+     * Set the raw data, usually used for encoding type `raw`
+     * If given `null`, it will unset the data
+    */
+    setRawData(buf) {
+        if (buf === null) {
+            this[i.__ENTITY_METADATA_KEY].rawData = null;
+            return;
+        }
+        this[i.__ENTITY_METADATA_KEY].rawData = ensureBuffer(buf, 'utf8');
+    }
+    /**
+     * Convert the DataEntity to an encoded buffer
+     *
+     * @param opConfig The operation config used to get the encoding type of the buffer,
+     * @default `json`
+     */
+    toBuffer(opConfig = {}) {
+        const { _encoding = i.DataEncoding.JSON } = opConfig;
+        if (_encoding === i.DataEncoding.JSON) {
+            return jsonToBuffer(this);
+        }
+        if (_encoding === i.DataEncoding.RAW) {
+            return this.getRawData();
+        }
+        throw new Error(`Unsupported encoding type, got "${_encoding}"`);
+    }
+}
+__decorate([
+    locked()
+], DataEntity.prototype, "getMetadata", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "setMetadata", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "getKey", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "setKey", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "getCreateTime", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "getIngestTime", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "setIngestTime", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "getProcessTime", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "setProcessTime", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "getEventTime", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "setEventTime", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "getRawData", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "setRawData", null);
+__decorate([
+    locked()
+], DataEntity.prototype, "toBuffer", null);
+//# sourceMappingURL=data-entity.js.map

package/dist/src/entities/data-entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-entity.js","sourceRoot":"","sources":["../../../src/entities/data-entity.ts"],"names":[],"mappings":";;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,KAAK,CAAC,MAAM,iBAAiB,CAAC;AACrC,OAAO,EACH,sBAAsB,EAAE,YAAY,EACpC,UAAU,EAAE,YAAY,EAC3B,MAAM,YAAY,CAAC;AAOpB;;;;;;GAMG;AACH,MAAM,OAAO,UAAU;IAmBnB,MAAM,CAAC,IAAI,CAGT,KAAQ,EAAE,QAAY;QACpB,IAAI,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,IAAI,QAAQ,EAAE,CAAC;gBACX,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAChD,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gBAChC,CAAC;YACL,CAAC;YACD,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,SAAS,CACZ,KAAqB;QAErB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACpC,CAAC;QAED,IAAI,UAAU,CAAC,iBAAiB,CAAO,KAAK,CAAC,EAAE,CAAC;YAC5C,OAAO,KAAK,CAAC;QACjB,CAAC;QAED,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACP,KAAQ,EACR,QAAQ,GAAG,IAAI;QAEf,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,mDAAmD,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3F,CAAC;QACD,MAAM,EAAE,WAAW,EAAE,GAAG,QAAQ,EAAE,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QACzD,IAAI,QAAQ,EAAE,CAAC;YACX,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAM,CAAC;QACjD,CAAC;QACD,OAAO,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAM,CAAC;IAC9C,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CACb,KAAsB,EACtB,QAA2B,EAC3B,QAAY;QAEZ,MAAM,EAAE,SAAS,GAAG,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,QAAQ,IAAI,EAAE,CAAC;QAC3D,IAAI,SAAS,KAAK,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YACpC,OAAO,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,SAAS,KAAK,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;YACnC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;YAC7C,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACzB,OAAO,MAAM,CAAC;QAClB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,mCAAmC,SAAS,GAAG,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAY,CACf,KAAc;QAEd,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,iBAAiB,CACpB,KAAc;QAEd,IAAI,KAAK,IAAI,IAAI;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QACxC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACpC,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,WAAW,CAAU,KAAc,EAAE,KAAc;QACtD,IAAI,KAAK,IAAI,IAAI;YAAE,OAAO,SAAS,CAAC;QAEpC,IAAI,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACjC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;YACnE,OAAO,GAAoB,CAAC;QAChC,CAAC;QAED,OAAO,KAAK,CAAC,CAAC,CAAE,KAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACrD,CAAC;IAED,MAAM,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAiB;QACzC,sDAAsD;QACtD,wDAAwD;QACxD,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACvD,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED,oEAAoE;IACnD,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAc;IACxD,oEAAoE;IACnD,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAO;IAE/C,YAAY,IAA0B,EAAE,QAAY;QAChD,IAAI,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,gDAAgD,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxF,CAAC;QAED,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAE7B,oEAAoE;QACpE,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAoC,CAAC,CAAC;QAE5F,IAAI,IAAI,EAAE,CAAC;YACP,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,CAAC;IACL,CAAC;IAUD,WAAW,CACP,GAAO;QAEP,IAAI,GAAG,EAAE,CAAC;YACN,+BAA+B;YAC/B,OAAO,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC;IAClD,CAAC;IAED;;MAEE;IAEF,WAAW,CACP,KAAQ,EACR,KAAQ;QAER,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,KAAK,KAAK,aAAa,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,yCAAyC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC9E,CAAC;QACD,+BAA+B;QAC/B,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,KAAY,CAAC;IACjE,CAAC;IAED;;;MAGE;IAEF,MAAM;QACF,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;QACxD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;MAGE;IAEF,MAAM,CAAC,GAAoB;QACvB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,IAAI,GAAG,GAAG,CAAC;IACtD,CAAC;IAED;;MAEE;IAEF,aAAa;QACT,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC/D,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC3C,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;MAKE;IAEF,aAAa;QACT,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC/D,IAAI,GAAG,IAAI,IAAI;YAAE,OAAO,SAAS,CAAC;QAClC,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IAEH,aAAa,CAAC,GAA4B;QACtC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,4BAA4B,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,WAAW,GAAG,QAAQ,CAAC;IAClE,CAAC;IAED;;;;;MAKE;IAEF,cAAc;QACV,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC/D,IAAI,GAAG,IAAI,IAAI;YAAE,OAAO,SAAS,CAAC;QAClC,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;MAKE;IAEF,cAAc,CAAC,GAA4B;QACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,4BAA4B,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,WAAW,GAAG,QAAQ,CAAC;IAClE,CAAC;IAED;;;;;MAKE;IAEF,YAAY;QACR,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;QAC/D,IAAI,GAAG,IAAI,IAAI;YAAE,OAAO,SAAS,CAAC;QAClC,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IAEH,YAAY,CAAC,GAA4B;QACrC,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,QAAQ,KAAK,KAAK,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,4BAA4B,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,WAAW,GAAG,QAAQ,CAAC;IAClE,CAAC;IAED;;;MAGE;IAEF,UAAU;QACN,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,OAAO,CAAC;QAClD,IAAI,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC5C,CAAC;IAED;;;MAGE;IAEF,UAAU,CAAC,GAA2B;QAClC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC;YAC7C,OAAO;QACX,CAAC;QACD,IAAI,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,OAAO,GAAG,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED;;;;;OAKG;IAEH,QAAQ,CAAC,WAA6B,EAAE;QACpC,MAAM,EAAE,SAAS,GAAG,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC;QACrD,IAAI,SAAS,KAAK,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YACpC,OAAO,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;QAED,IAAI,SAAS,KAAK,CAAC,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7B,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,mCAAmC,SAAS,GAAG,CAAC,CAAC;IACrE,CAAC;CAGJ;AApMG;IADC,MAAM,EAAE;6CASR;AAMD;IADC,MAAM,EAAE;6CAcR;AAOD;IADC,MAAM,EAAE;wCAOR;AAOD;IADC,MAAM,EAAE;wCAMR;AAMD;IADC,MAAM,EAAE;+CAQR;AASD;IADC,MAAM,EAAE;+CAKR;AASD;IADC,MAAM,EAAE;+CAOR;AASD;IADC,MAAM,EAAE;gDAKR;AASD;IADC,MAAM,EAAE;gDAOR;AASD;IADC,MAAM,EAAE;8CAKR;AASD;IADC,MAAM,EAAE;8CAOR;AAOD;IADC,MAAM,EAAE;4CAKR;AAOD;IADC,MAAM,EAAE;4CAOR;AASD;IADC,MAAM,EAAE;0CAYR"}

package/dist/src/entities/index.d.ts

@@ -0,0 +1,3 @@
+export * from './interfaces.js';
+export * from './data-entity.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/entities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC"}

package/dist/src/entities/index.js

@@ -0,0 +1,3 @@
+export * from './interfaces.js';
+export * from './data-entity.js';
+//# sourceMappingURL=index.js.map

package/dist/src/entities/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/entities/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC"}

package/dist/src/entities/interfaces.d.ts

@@ -0,0 +1,52 @@
+export type TYPE_IS_DATAENTITY_KEY = '__isDataEntity';
+export type TYPE_ENTITY_METADATA_KEY = '___EntityMetadata';
+export declare const __IS_DATAENTITY_KEY: TYPE_IS_DATAENTITY_KEY;
+export declare const __ENTITY_METADATA_KEY: TYPE_ENTITY_METADATA_KEY;
+export type _DataEntityMetadataType = DataEntityMetadata | Record<string, any>;
+export type _DataEntityMetadata<M> = M & DataEntityMetadata & Record<string, any>;
+export type DataEntityMetadataValue<M> = (keyof DataEntityMetadata) | (keyof M) | string | number;
+export type EntityMetadataValue<M, K> = K extends (keyof DataEntityMetadata) ? DataEntityMetadata[K] : (K extends (keyof M) ? M[K] : any);
+/**
+ * DataEntities have conventional metadata properties
+ * that can track source, destination and other process
+ * information.
+ *
+ * **NOTE** Time values are set in UNIX Epoch time,
+ * to reduce memory footput, the DataEntity has convenience
+ * apis for getting and setting the time given and handling
+ * the conversion between unix milliseconds to Date format.
+*/
+export interface DataEntityMetadata {
+    /**
+     * The time at which this entity was created
+     * (this is automatically set on DataEntity creation)
+     * @readonly
+    */
+    _createTime?: number;
+    /** The time at which the data was ingested into the source data */
+    _ingestTime?: number;
+    /** The time at which the data was consumed by the reader */
+    _processTime?: number;
+    /**
+     * The time associated with this data entity,
+     * usually off of a specific field on source data or message
+     */
+    _eventTime?: number;
+    /** A unique key for the data which will be can be used to key the data */
+    _key?: string | number;
+}
+/**
+ * Available data encoding types for a DataEntity
+ */
+export declare enum DataEncoding {
+    JSON = "json",
+    RAW = "raw"
+}
+/** an encoding focused interfaces */
+export interface EncodingConfig {
+    _op?: string;
+    _encoding?: DataEncoding;
+}
+/** A list of supported encoding formats */
+export declare const dataEncodings: readonly DataEncoding[];
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/src/entities/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../../src/entities/interfaces.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AACtD,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,CAAC;AAE3D,eAAO,MAAM,mBAAmB,EAAE,sBAAyC,CAAC;AAE5E,eAAO,MAAM,qBAAqB,EAAE,wBAA8C,CAAC;AAEnF,MAAM,MAAM,uBAAuB,GAAG,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAC/E,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,CAAC,GAAG,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAElF,MAAM,MAAM,uBAAuB,CAAC,CAAC,IAC/B,CAAC,MAAM,kBAAkB,CAAC,GACtB,CAAC,MAAM,CAAC,CAAC,GACT,MAAM,GACN,MAAM,CAAC;AAEjB,MAAM,MAAM,mBAAmB,CAAC,CAAC,EAAE,CAAC,IAC9B,CAAC,SAAS,CAAC,MAAM,kBAAkB,CAAC,GAChC,kBAAkB,CAAC,CAAC,CAAC,GAAG,CACtB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,GACb,CAAC,CAAC,CAAC,CAAC,GACJ,GAAG,CAAC,CAAC;AAEvB;;;;;;;;;EASE;AACF,MAAM,WAAW,kBAAkB;IAC/B;;;;MAIE;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,mEAAmE;IACnE,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,4DAA4D;IAC5D,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,0EAA0E;IAC1E,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,oBAAY,YAAY;IACpB,IAAI,SAAS;IACb,GAAG,QAAQ;CACd;AAED,qCAAqC;AACrC,MAAM,WAAW,cAAc;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,YAAY,CAAC;CAC5B;AAED,2CAA2C;AAC3C,eAAO,MAAM,aAAa,EAAE,SAAS,YAAY,EAAgC,CAAC"}

package/dist/src/entities/interfaces.js

@@ -0,0 +1,13 @@
+export const __IS_DATAENTITY_KEY = '__isDataEntity';
+export const __ENTITY_METADATA_KEY = '___EntityMetadata';
+/**
+ * Available data encoding types for a DataEntity
+ */
+export var DataEncoding;
+(function (DataEncoding) {
+    DataEncoding["JSON"] = "json";
+    DataEncoding["RAW"] = "raw";
+})(DataEncoding || (DataEncoding = {}));
+/** A list of supported encoding formats */
+export const dataEncodings = Object.values(DataEncoding);
+//# sourceMappingURL=interfaces.js.map

package/dist/src/entities/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/entities/interfaces.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,mBAAmB,GAA2B,gBAAgB,CAAC;AAE5E,MAAM,CAAC,MAAM,qBAAqB,GAA6B,mBAAmB,CAAC;AAoDnF;;GAEG;AACH,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACpB,6BAAa,CAAA;IACb,2BAAW,CAAA;AACf,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAQD,2CAA2C;AAC3C,MAAM,CAAC,MAAM,aAAa,GAA4B,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC"}

package/dist/src/entities/utils.d.ts

@@ -0,0 +1,9 @@
+import * as i from './interfaces.js';
+export declare function defineEntityProperties(entity: unknown): void;
+export declare function createMetadata<M>(metadata: M): i._DataEntityMetadata<M>;
+export declare function makeMetadata<M extends i._DataEntityMetadataType>(metadata?: M | undefined): i._DataEntityMetadata<M>;
+export declare function createCoreMetadata<M extends i._DataEntityMetadataType>(): i._DataEntityMetadata<M>;
+export declare function jsonToBuffer(input: unknown): Buffer;
+export declare function isValidKey(key: unknown): key is string | number;
+export declare function isDataEntity(input: unknown): boolean;
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/entities/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/entities/utils.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,iBAAiB,CAAC;AAErC,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,CAc5D;AAED,wBAAgB,cAAc,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAEvE;AAED,wBAAgB,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,uBAAuB,EAC5D,QAAQ,CAAC,EAAE,CAAC,GAAG,SAAS,GACzB,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAG1B;AAED,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,CAAC,CAAC,uBAAuB,KACnE,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAE1B;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAEnD;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,GAAG,MAAM,CAK/D;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAEpD"}

package/dist/src/entities/utils.js

@@ -0,0 +1,44 @@
+import { isString } from '../strings.js';
+import { isNumber } from '../numbers.js';
+import * as i from './interfaces.js';
+export function defineEntityProperties(entity) {
+    Object.defineProperty(entity, i.__IS_DATAENTITY_KEY, {
+        value: true,
+        configurable: false,
+        enumerable: false,
+        writable: false,
+    });
+    Object.defineProperty(entity, i.__ENTITY_METADATA_KEY, {
+        value: {},
+        configurable: false,
+        enumerable: false,
+        writable: false,
+    });
+}
+export function createMetadata(metadata) {
+    return { ...createCoreMetadata(), ...metadata };
+}
+export function makeMetadata(metadata) {
+    if (!metadata)
+        return createCoreMetadata();
+    return createMetadata(metadata);
+}
+export function createCoreMetadata() {
+    return { _createTime: Date.now() };
+}
+export function jsonToBuffer(input) {
+    return Buffer.from(JSON.stringify(input));
+}
+export function isValidKey(key) {
+    if (key == null)
+        return false;
+    if (isString(key) && key !== '')
+        return true;
+    if (isNumber(key))
+        return true;
+    return false;
+}
+export function isDataEntity(input) {
+    return Boolean(input != null && input[i.__IS_DATAENTITY_KEY] === true);
+}
+//# sourceMappingURL=utils.js.map

package/dist/src/entities/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/entities/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,CAAC,MAAM,iBAAiB,CAAC;AAErC,MAAM,UAAU,sBAAsB,CAAC,MAAe;IAClD,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,mBAAmB,EAAE;QACjD,KAAK,EAAE,IAAI;QACX,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,qBAAqB,EAAE;QACnD,KAAK,EAAE,EAAE;QACT,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,KAAK;QACjB,QAAQ,EAAE,KAAK;KAClB,CAAC,CAAC;AACP,CAAC;AAED,MAAM,UAAU,cAAc,CAAI,QAAW;IACzC,OAAO,EAAE,GAAG,kBAAkB,EAAE,EAAE,GAAG,QAAQ,EAA8B,CAAC;AAChF,CAAC;AAED,MAAM,UAAU,YAAY,CACxB,QAAwB;IAExB,IAAI,CAAC,QAAQ;QAAE,OAAO,kBAAkB,EAAE,CAAC;IAC3C,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,kBAAkB;IAE9B,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,EAA8B,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAc;IACvC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,GAAY;IACnC,IAAI,GAAG,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAC9B,IAAI,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,EAAE;QAAE,OAAO,IAAI,CAAC;IAC7C,IAAI,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/B,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAc;IACvC,OAAO,OAAO,CAAC,KAAK,IAAI,IAAI,IAAK,KAAa,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,IAAI,CAAC,CAAC;AACpF,CAAC"}

package/dist/src/env.d.ts

@@ -0,0 +1,6 @@
+export declare const isProd: boolean;
+export declare const isTest: boolean;
+export declare const isDev: boolean;
+export declare const isCI: boolean;
+export declare function isExecutedFile(url: string): boolean;
+//# sourceMappingURL=env.d.ts.map

package/dist/src/env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../src/env.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,MAAM,SAAiE,CAAC;AACrF,eAAO,MAAM,MAAM,SAAkC,CAAC;AACtD,eAAO,MAAM,KAAK,SAAyC,CAAC;AAC5D,eAAO,MAAM,IAAI,SAA4B,CAAC;AAE9C,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAOnD"}

package/dist/src/env.js

@@ -0,0 +1,15 @@
+import { fileURLToPath } from 'node:url';
+import fs from 'node:fs';
+export const isProd = !process.env.NODE_ENV || process.env.NODE_ENV === 'production';
+export const isTest = process.env.NODE_ENV === 'test';
+export const isDev = process.env.NODE_ENV === 'development';
+export const isCI = process.env.CI === 'true';
+export function isExecutedFile(url) {
+    if (url.startsWith('file:')) {
+        const modulePath = fileURLToPath(url);
+        const mainPath = fs.realpathSync(process.argv[1]);
+        return mainPath === modulePath;
+    }
+    return false;
+}
+//# sourceMappingURL=env.js.map

package/dist/src/env.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.js","sourceRoot":"","sources":["../../src/env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzB,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC;AACrF,MAAM,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,MAAM,CAAC;AACtD,MAAM,CAAC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,CAAC;AAC5D,MAAM,CAAC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,MAAM,CAAC;AAE9C,MAAM,UAAU,cAAc,CAAC,GAAW;IACtC,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1B,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,OAAO,QAAQ,KAAK,UAAU,CAAC;IACnC,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC"}

package/dist/src/equality.d.ts

@@ -0,0 +1,72 @@
+/**
+ * Verify that two values are the same (uses a reference check).
+ * Similar to === except two NaNs is considered the same
+ * For deep equality use isDeepEqual
+*/
+export declare function isEqual<T>(target: T, input: unknown): input is T;
+export declare function isEqual<T>(target: T, input: unknown): boolean;
+/**
+ * A functional version of isEqual
+*/
+export declare function isEqualFP<T>(target: T): (input: unknown) => input is T;
+export declare function isEqualFP<T>(target: T): (input: unknown) => boolean;
+/**
+ * Compares two values and returns a boolean if they are the same.
+ * Arrays are compared using original sorting, while object key ordering
+ * doesn't matter.
+ *
+ * @example
+        isDeepEqual({ key1: 1, key2: 2 }, { key2: 2, key1: 1 }) === true;
+        isDeepEqual(null, null) === true;
+        isDeepEqual(undefined, undefined) === true;
+        isDeepEqual(NaN, NaN) === true;
+        isDeepEqual(3, 3) === true
+        isDeepEqual('hello', 'hello') === true
+        isDeepEqual([1, 2, 3], [1, 2, 3]) === true
+        isDeepEqual([{ some: 'obj' }], [{ some: 'obj' }]) === true
+
+        isDeepEqual(undefined, null) === false;
+        isDeepEqual([1, 2, 3], [1, 3, 2]) === false
+        isDeepEqual([1, 2, 3], [1, 2, undefined, 3]) === false
+        isDeepEqual(true, 'true') === false;
+*/
+export declare function isDeepEqual<T>(target: T, input: unknown): input is T;
+export declare function isDeepEqual<T>(target: T, input: unknown): boolean;
+/**
+ * A functional version of isDeepEqual
+*/
+export declare function isDeepEqualFP<T>(target: T): (input: unknown) => input is T;
+export declare function isDeepEqualFP<T>(target: T): (input: unknown) => boolean;
+/**
+ * Check if a value is greater than or equal to another
+*/
+export declare function isGreaterThanOrEqualTo(value: unknown, other: unknown): boolean;
+/**
+ * Check if a value is greater than or equal to another
+*/
+export declare function isGreaterThanOrEqualToFP(other: unknown): (value: unknown) => boolean;
+/**
+ * Check if a value is greater than another
+*/
+export declare function isGreaterThan(value: unknown, other: unknown): boolean;
+/**
+ * Check if a value is greater than or equal to another
+*/
+export declare function isGreaterThanFP(other: unknown): (value: unknown) => boolean;
+/**
+ * Check if a value is less than or equal to another
+*/
+export declare function isLessThanOrEqualTo(value: unknown, other: unknown): boolean;
+/**
+ * Check if a value is less than or equal to another
+*/
+export declare function isLessThanOrEqualToFP(other: unknown): (value: unknown) => boolean;
+/**
+ * Check if a value is less than another
+*/
+export declare function isLessThan(value: unknown, other: unknown): boolean;
+/**
+ * Check if a value is greater than or equal to another
+*/
+export declare function isLessThanFP(other: unknown): (value: unknown) => boolean;
+//# sourceMappingURL=equality.d.ts.map

package/dist/src/equality.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"equality.d.ts","sourceRoot":"","sources":["../../src/equality.ts"],"names":[],"mappings":"AAIA;;;;EAIE;AACF,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC;AAClE,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;AAK/D;;EAEE;AACF,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;AACxE,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;AAKrE;;;;;;;;;;;;;;;;;;;EAmBE;AAEF,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC;AACtE,wBAAgB,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;AAoBnE;;EAEE;AACF,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC;AAC5E,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;AAwBzE;;EAEE;AACF,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAI9E;AAED;;EAEE;AACF,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAMpF;AAED;;EAEE;AACF,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAIrE;AAED;;EAEE;AACF,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAM3E;AAED;;EAEE;AACF,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAI3E;AAED;;EAEE;AACF,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAMjF;AAED;;EAEE;AACF,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAIlE;AAED;;EAEE;AACF,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAMxE"}