@ygracs/chn-alias-list 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+#### *v0.0.1-0.0.3*
+
+Pre-release version.

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-2024 Yuri Grachev
+
+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

@@ -0,0 +1,32 @@
+|***rev.*:**|0.0.1|
+|:---|---:|
+|***date***:|2024-06-18|
+
+## Introduction
+
+This module provide a small helper library which implements some classes used as helper objects to deal with instances of an EPG-sources.
+
+## Content
+
+> for detailed description of the classes and function listed below see the [docs](doc/chn-alias-list.md).
+
+### 1. classes:
+
+- base elements:
+  - TChnNameRecord;
+  - TChnNamesList;
+
+- lists:
+  - TChnAliasItem;
+  - TChnAliasList.
+
+### 2. functions:
+
+- loadAliasFromFileSync;
+- saveAliasToFileSync.
+
+## Use cases
+
+### Installation
+
+`npm install @ygracs/chn-alias-list`

package/doc/chn-alias-list.md

@@ -0,0 +1,443 @@
+
+>|***rev.*:**|0.0.3|
+>|:---|---:|
+>|date:|2024-10-21|
+
+## Introduction
+
+This paper describes a classes and some helper functions provided by `chn-alias-list.js` module.
+
+## Content
+
+- Classes
+    - <a href="#TChnNameRecord">TChnNameRecord</a>
+    - <a href="#TChnNamesList">TChnNamesList</a>
+    - <a href="#TChnAliasItem">TChnAliasItem</a>
+    - <a href="#TChnAliasList">TChnAliasList</a>
+
+- Functions
+    - <a href="#loadAliasFromFileSync">loadAliasFromFileSync</a>
+    - <a href="#saveAliasToFileSync">saveAliasToFileSync</a>
+
+## Module classes
+
+<a name="TChnNameRecord"></a>
+### **TChnNameRecord**
+
+This class implements an interface of the name record
+
+<a name="new_TChnNameRecord_new"></a>
+#### class constructor
+
+The class constructor creates a new instance of the class. It receives no arguments.
+
+#### class properties
+
+<a name="TChnNameRecord+lang"></a>
+##### **lang**
+
+| value type | read only | description |
+|---|---|:---|
+| `string` | yes | defines a language applied to a name record value |
+
+<a name="TChnNameRecord+text"></a>
+##### **text**
+
+| value type | read only | description |
+|---|---|:---|
+| `string` | yes | defines a text value of a name record |
+
+<a name="TChnNameRecord+value"></a>
+##### **value**
+
+| value type | read only | description |
+|---|---|:---|
+| `array` | no | defines a value of a name record |
+
+#### class methods
+
+<a name="TChnNameRecord+setValue"></a>
+##### **setValue(data)** => `boolean`
+
+This method sets the value of a name record.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `data` | `any` | --- | a data for a name record to be set |
+
+<a name="TChnNameRecord+toFormatString"></a>
+##### **toFormatString(opt)** => `string`
+
+Returns a name record value as a formatted string.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `opt` | `any` | --- | <*reserved*> |
+
+<a name="TChnNameRecord+reset"></a>
+##### **reset()** => `void`
+
+Clears the record.
+
+<a name="TChnNamesList"></a>
+### **TChnNamesList**
+
+This class implements an interface of the name records list.
+
+<a name="new_TChnNamesList_new"></a>
+#### class constructor
+
+The class constructor creates a new instance of the class. It receives no arguments.
+
+#### class properties
+
+<a name="TChnNamesList+count"></a>
+##### **count**
+
+| value type | read only | description |
+|---|---|:---|
+| `number` | yes | contains a quantity of a name records |
+
+<a name="TChnNamesList+value"></a>
+##### **value**
+
+| value type | read only | description |
+|---|---|:---|
+| `array` | yes | contains a list of a name records |
+
+#### class methods
+
+<a name="TChnNamesList+isEmpty"></a>
+##### **isEmpty()** => `boolean`
+
+Returns a flag that indicating whether a list is empty or not.
+
+<a name="TChnNamesList+isNotEmpty"></a>
+##### **isNotEmpty()** => `boolean`
+
+Returns a flag that indicating whether a list has any members.
+
+<a name="TChnNamesList+chkIndex"></a>
+##### **chkIndex(value)** => `boolean`
+
+Checks whether a given value is an index and fits
 an Index range within the instance.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `any` | --- | a value to be verified |
+
+<a name="TChnNamesList+getIndex"></a>
+##### **getIndex(value)** => `number`
+
+Searches an index of a given name in the list.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | a name to be searched |
+
+<a name="TChnNamesList+getName"></a>
+##### **getName(value)** => `?TChnNameRecord`
+
+Returns a name record addressed by a given index.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `number` | --- | an element index in the list |
+
+<a name="TChnNamesList+addName"></a>
+#### **addName(data)** => `boolean`
+
+Adds a new name record to a list members.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `data` | `any` | --- | a data for a name record to be added in the list |
+
+<a name="TChnNamesList+delName"></a>
+##### **delName(value)** => `boolean`
+
+Tries to delete a name record addressed by a given index.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `number` | --- | an element index in the list |
+
+<a name="TChnNamesList+loadNames"></a>
+##### **loadNames(list, \[opt])** => `number`
+
+Loads a list of a new name records.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `list` | `array` | --- | a list of an elements to load |
+| `opt` | `boolean` | `true` | defines whether to clear the list before load a new one |
+
+<a name="TChnNamesList+clear"></a>
+##### **clear()** => `void`
+
+Removes all of the instance members.
+
+<a name="TChnNamesList+forEach"></a>
+##### **forEach(cb)** => `void`
+
+Calls given function for each name record in the list.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `cb` | `callback` | --- | a callback function defined by a user |
+
+<a name="TChnAliasItem"></a>
+### **TChnAliasItem**
+
+This class implements an interface of the channel item.
+
+<a name="new_TChnAliasItem_new"></a>
+#### class constructor
+
+The class constructor creates a new instance of the class. It receives no arguments.
+
+#### class properties
+
+<a name="TChnAliasItem+id"></a>
+##### **id**
+
+| value type | read only | description |
+|---|---|:---|
+| `string` | no | defines a channel ID |
+
+<a name="TChnAliasItem+alias"></a>
+##### **alias**
+
+| value type | read only | description |
+|---|---|:---|
+| `string` | no | defines a channel alias |
+
+<a name="TChnAliasItem+names"></a>
+##### **names**
+
+| value type | read only | description |
+|---|---|:---|
+| `TChnNamesList` | yes | contains a list of a name records |
+
+<a name="TChnAliasItem+status"></a>
+##### **status**
+
+| value type | read only | description |
+|---|---|:---|
+| `string` | yes | defines an instance status |
+
+#### class methods
+
+<a name="TChnAliasItem+setID"></a>
+##### **setID(value)** => `boolean`
+
+Sets a channel ID.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | a channel ID |
+
+<a name="TChnAliasItem+setAlias"></a>
+##### **setAlias(value)** => `boolean`
+
+Sets a channel alias.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | a channel alias |
+
+<a name="TChnAliasItem+addName"></a>
+##### **addName(data)** => `boolean`
+
+Adds a new name record.
+
+> **See**: [TChnNamesList.addName](#TChnNamesList+addName)
+
+<a name="TChnAliasItem+loadNames"></a>
+##### **loadNames(list, \[opt])** => `number`
+
+Loads a list of a new name records.
+
+> **See**: [TChnNamesList.loadNames](#TChnNamesList+loadNames)
+
+<a name="TChnAliasItem+enable"></a>
+##### **enable()** => `void`
+
+Sets item status to "enabled".
+
+<a name="TChnAliasItem+disable"></a>
+##### **disable()** => `void`
+
+Sets item status to "disabled".
+
+<a name="TChnAliasItem+up"></a>
+##### **up()** => `void`
+
+Sets item status to "active"/"running".
+
+<a name="TChnAliasItem+down"></a>
+##### **down()** => `void`
+
+Sets item status to "inactive"/"stopped".
+
+#### class methods
+
+<a name="TChnAliasItem+setStatus"></a>
+##### **setStatus(value)** => `boolean`
+
+Sets item status.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | a name of predefined status value (a possible value may be: `enabled`, `disabled`, `up` or `down`) |
+
+#### class methods (*special*)
+
+<a name="TChnAliasItem+toJSON"></a>
+##### **toJSON()**
+
+A special method that provides an interface to an instance representation
 for a `JSON.stringify()`.
+
+#### class methods (*static*)
+
+<a name="TChnAliasItem.create"></a>
+##### **create(obj)** => `?TChnAliasItem`
+
+Creates a new alias element.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `obj` | `object` | --- | an initial data |
+
+<a name="TChnAliasList"></a>
+### **TChnAliasList**
+
+This class implements an interface of the channel items list.
+
+<a name="new_TChnAliasList_new"></a>
+#### class constructor
+
+The class constructor creates a new instance of the class. It receives no arguments.
+
+#### class properties
+
+<a name="TChnAliasList+count"></a>
+##### **count**
+
+| value type | read only | description |
+|---|---|:---|
+| `number` | yes | contains a quantity of the elements |
+
+#### class methods
+
+<a name="TChnAliasList+isEmpty"></a>
+##### **isEmpty()** => `boolean`
+
+Returns a flag that indicating whether a list is empty or not.
+
+<a name="TChnAliasList+isNotEmpty"></a>
+##### **isNotEmpty()** => `boolean`
+
+Returns a flag that indicating whether a list has any members.
+
+<a name="TChnAliasList+chkIndex"></a>
+##### **chkIndex(value)** => `boolean`
+
+Checks whether a given value is an index and fits
+ an Index range within the instance.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `any` | --- | a value to be verified |
+
+<a name="TChnAliasList+searchIndexByID"></a>
+##### **searchIndexByID(value)** => `number`
+
+Searches an index of an element by its given ID.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | a value of ID to be searched |
+
+<a name="TChnAliasList+getItem"></a>
+##### **getItem(value)** => `?TChnAliasItem`
+
+Returns an alias element by its index.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `number` | --- | an element index |
+
+<a name="TChnAliasList+getItemByID"></a>
+##### **getItemByID(value)** => `?TChnAliasItem`
+
+Returns an alias element by its ID.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | an element ID |
+
+<a name="TChnAliasList+addItem"></a>
+##### **addItem(obj)** => `number`
+
+Adds an alias element.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `obj` | `object` | --- | an element to be added |
+
+<a name="TChnAliasList+delItem"></a>
+##### **delItem(value)** => `boolean`
+
+Tries to delete an element addressed by a given index.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `number` | --- | an element index |
+
+<a name="TChnAliasList+loadItems"></a>
+##### **loadItems(list, \[opt])** => `number`
+
+Loads a list of a new alias elements.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `list` | `array` | --- | a list of an elements |
+| `opt` | `boolean` | `true` | a flag that defines whether to clear the list before load a new one |
+
+<a name="TChnAliasList+clear"></a>
+##### **clear()** => `void`
+
+Removes all of the instance members.
+
+<a name="TChnAliasList+forEach"></a>
+##### **forEach(cb)** => `void`
+
+Calls given function for each alias element in the list.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `cb` | `callback` | --- | a callback function defined by a user |
+
+## Module functions
+
+<a name="loadAliasFromFileSync"></a>
+#### **loadAliasFromFileSync(src, [opt])** => `object`
+
+Loads an alias from a file.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `src` | `string` | --- | a path to some file |
+| `opt` | `any` | --- | <*reserved*> |
+
+<a name="saveAliasToFileSync"></a>
+#### **saveAliasToFileSync(src, content, [opt])** => `object`
+
+Saves an alias to a file
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `src` | `string` | --- | a path to some file |
+| `content` | `array` | --- | a content to save |
+| `opt` | `any` | --- | <*reserved*> |

package/index.js

@@ -0,0 +1,13 @@
+// [v0.0.001-20240620]
+
+// === module init block ===
+
+const lib = require('#lib/chn-alias-list.js');
+
+// === module extra block (helper functions) ===
+
+// === module main block ===
+
+// === module exports block ===
+
+module.exports = lib;