@jiovan-labs/ts-multi-map 0.0.0-stage → 2.0.0

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jiovan Ltd. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,47 @@
-# Temporary Holding Version
+# @jiovan-labs/ts-multi-map
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![NPM version](https://img.shields.io/npm/v/@jiovan-labs/ts-multi-map.svg?style=flat)](https://npmjs.org/package/@jiovan-labs/ts-multi-map)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](LICENSE.txt)
+[![NPM downloads](http://img.shields.io/npm/dm/@jiovan-labs/ts-multi-map.svg?style=flat)](https://npmjs.org/package/@jiovan-labs/ts-multi-map)
+
+🏅 Multiple key/value map & range map for typescript 👍
+
+## Features
+
+✅ Supports multiple keys/values, with readonly capability
+
+✅ Supports ranges, with readonly capability
+
+## Quickstart
+
+You can install this package in your typescript project as follows:
+
+```bash
+$ npm install @jiovan-labs/ts-multi-map --save
+```
+
+Then, you may import components as follows:
+
+```jsx | pure
+import { MultiKeyMap, ReadonlyMultiKeyMap } from '@jiovan-labs/ts-multi-map';
+import { MultiValueMap, ReadonlyMultiValueMap } from '@jiovan-labs/ts-multi-map';
+import { RangeMap, ReadonlyRangeMap } from '@jiovan-labs/ts-multi-map';
+```
+
+Enjoy your coding journey with `ts-multi-map` ✌️
+
+## Document
+
+- GitHub pages: [https://jiovan-labs.github.io/ts-multi-map](https://jiovan-labs.github.io/ts-multi-map)
+
+## License
+
+This project is under the [MIT License](https://mit-license.org/).
+
+## Copyright
+
+Beijing Jiovan Technology Ltd.
+
+## Website
+
+- Jiovan: [https://joivan.com](https://joivan.com)

package/dist/cjs/index.d.ts

@@ -0,0 +1,7 @@
+export { MultiKeyMap } from './util/MultiKeyMap';
+export { MultiValueMap } from './util/MultiValueMap';
+export { RangeMap } from './util/RangeMap';
+export { ReadonlyMultiKeyMap } from './util/ReadonlyMultiKeyMap';
+export { ReadonlyMultiValueMap } from './util/ReadonlyMultiValueMap';
+export { ReadonlyRangeMap } from './util/ReadonlyRangeMap';
+export * from './type/declaration';

package/dist/cjs/index.js

@@ -0,0 +1,47 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  MultiKeyMap: () => import_MultiKeyMap.MultiKeyMap,
+  MultiValueMap: () => import_MultiValueMap.MultiValueMap,
+  RangeMap: () => import_RangeMap.RangeMap,
+  ReadonlyMultiKeyMap: () => import_ReadonlyMultiKeyMap.ReadonlyMultiKeyMap,
+  ReadonlyMultiValueMap: () => import_ReadonlyMultiValueMap.ReadonlyMultiValueMap,
+  ReadonlyRangeMap: () => import_ReadonlyRangeMap.ReadonlyRangeMap
+});
+module.exports = __toCommonJS(src_exports);
+var import_MultiKeyMap = require("./util/MultiKeyMap");
+var import_MultiValueMap = require("./util/MultiValueMap");
+var import_RangeMap = require("./util/RangeMap");
+var import_ReadonlyMultiKeyMap = require("./util/ReadonlyMultiKeyMap");
+var import_ReadonlyMultiValueMap = require("./util/ReadonlyMultiValueMap");
+var import_ReadonlyRangeMap = require("./util/ReadonlyRangeMap");
+__reExport(src_exports, require("./type/declaration"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MultiKeyMap,
+  MultiValueMap,
+  RangeMap,
+  ReadonlyMultiKeyMap,
+  ReadonlyMultiValueMap,
+  ReadonlyRangeMap,
+  ...require("./type/declaration")
+});

package/dist/cjs/type/declaration.d.ts

@@ -0,0 +1,10 @@
+export type MultiKeyMapEntry<K, V> = [K[], V];
+export type MultiKeyMapEntries<K, V> = readonly (readonly [K[], V])[] | null;
+export type MultiValueMapEntry<K, V> = [K, V[]];
+export type MultiValueMapEntries<K, V> = readonly (readonly [K, V[]])[] | null;
+export type RangeMapKey = {
+    start: number;
+    end: number;
+    startInclusive?: boolean;
+    endInclusive?: boolean;
+};

package/dist/cjs/type/declaration.js

@@ -0,0 +1,17 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/type/declaration.ts
+var declaration_exports = {};
+module.exports = __toCommonJS(declaration_exports);

package/dist/cjs/util/MultiKeyMap.d.ts

@@ -0,0 +1,34 @@
+import { type MultiKeyMapEntries } from "..";
+export declare class MultiKeyMap<K, V> implements Omit<Map<K[], V>, 'delete' | 'forEach' | 'get' | 'has' | 'set' | 'entries' | 'keys' | 'values' | 'push'> {
+    private readonly keyMap;
+    private readonly valueMap;
+    static of<K, V>(entries?: MultiKeyMapEntries<K, V>): MultiKeyMap<K, V>;
+    constructor(entries?: MultiKeyMapEntries<K, V>);
+    get(keys: K[], defaults?: V): V | undefined;
+    set(keys: K[], value: V): void;
+    clear(): void;
+    keys(): K[][];
+    values(): V[];
+    entries(): [K[], V][];
+    deleteByKey(key: K[]): boolean;
+    deleteByKeys(keys: K[][]): boolean;
+    deleteByValue(value: V): boolean;
+    deleteByValues(values: V[]): boolean;
+    forEach(callback: (value?: V, keys?: K[]) => void, thisArg?: any): void;
+    forEachIndexing(callback: (value?: V, keys?: K[], index?: number) => void, thisArg?: any): void;
+    forEachBreakable(callback: (value?: V, keys?: K[]) => boolean, thisArg?: any): void;
+    hasKey(keys: K[], exact?: boolean): boolean;
+    hasKeyValue(keys: K[], value: V): boolean;
+    hasAnyKeys(keys: K[][], exact?: boolean): boolean;
+    hasAllKeys(keys: K[][], exact?: boolean): boolean;
+    hasValue(value: V): boolean;
+    hasAnyValues(values: V[]): boolean;
+    hasAllValues(values: V[]): boolean;
+    isEmpty(): boolean;
+    isNotEmpty(): boolean;
+    getKey(value: V, defaults?: K[]): K[] | undefined;
+    [Symbol.iterator](): IterableIterator<[K[], V]>;
+    get size(): number;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+}