@team-internet/apiconnector 10.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TEAM INTERNET
+
+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,56 @@
+# node-sdk
+
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
+[![npm version](https://img.shields.io/npm/v/@cnr/apiconnector.svg?style=flat)](https://www.npmjs.com/package/@cnr/apiconnector)
+[![node](https://img.shields.io/node/v/@cnr/apiconnector.svg)](https://www.npmjs.com/package/@cnr/apiconnector)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![Build Status](https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/workflows/Release/badge.svg?branch=master)](https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/workflows/Release/badge.svg?branch=master)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/blob/master/CONTRIBUTING.md)
+
+This module is a connector library for the insanely fast CentralNic Reseller Backend API. For further informations visit our [homepage](https://www.centralnicreseller.com) and do not hesitate to [contact us](https://www.centralnicreseller.com/contact).
+
+## Deprecation Notice: Hexonet Node.js SDK
+
+This SDK succeeds the deprecated Hexonet Node.js SDK. It is an enhanced version that builds upon the foundation laid by the Hexonet SDK, offering improved features and performance. Hexonet is migrating to CentralNic Reseller, ensuring continued support and development under the new branding.
+
+## Resources
+
+- [Documentation](https://support.centralnicreseller.com/hc/en-gb/articles/5714403954333-Self-Development-Kit-for-NodeJS)
+- [Release Notes](https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/releases)
+
+## Running the Demo Application
+
+To run the demo application, follow these steps:
+
+1. **Set Your Credentials**: Ensure your credentials are available. You can either:
+
+- Replace them directly in the application file.
+- Set the environment variables `CNR_TEST_USER` and `CNR_TEST_PASSWORD` in your terminal.
+
+2. **Execute the Demo**: Once your credentials are set, run the following command in the terminal:
+
+   ```sh
+   npm run test-demo
+   ```
+
+3. **Update Demo Contents**: If you need to update the contents of the demo file, you can find it at:
+
+   ```plaintext
+   tests/app.js
+   ```
+
+By following these steps, you can successfully run and update the demo application.
+
+## Authors
+
+- **Kai Schwarz** - [KaiSchwarz-cnic](https://github.com/kaischwarz-cnic)
+- **Asif Nawaz** - [AsifNawaz-cnic](https://github.com/asifnawaz-cnic)
+
+## FAQ / Notes
+
+ESM/CJS Support: We followed the [ESM-NODE Guide](https://www.typescriptlang.org/docs/handbook/esm-node.html) of TypeScript.
+
+## License
+
+MIT

package/dist/apiclient.d.ts

@@ -0,0 +1,233 @@
+import { Logger } from "./logger.js";
+import { Response } from "./response.js";
+export declare const CNR_CONNECTION_URL_PROXY = "http://127.0.0.1/api/call.cgi";
+export declare const CNR_CONNECTION_URL_LIVE = "https://api.rrpproxy.net/api/call.cgi";
+export declare const CNR_CONNECTION_URL_OTE = "https://api-ote.rrpproxy.net/api/call.cgi";
+/**
+ * APIClient class
+ */
+export declare class APIClient {
+    /**
+     * API connection timeout setting
+     */
+    static readonly socketTimeout: number;
+    /**
+     * User Agent string
+     */
+    private ua;
+    /**
+     * API connection url
+     */
+    private socketURL;
+    /**
+     * Object covering API connection data
+     */
+    private socketConfig;
+    /**
+     * activity flag for debug mode
+     */
+    private debugMode;
+    /**
+     * additional connection settings
+     */
+    private curlopts;
+    /**
+     * logger function for debug mode
+     */
+    private logger;
+    /**
+     * set sub user account
+     */
+    private subUser;
+    /**
+     * set sub user account role seperater
+     */
+    private readonly roleSeparator;
+    constructor();
+    /**
+     * set custom logger to use instead of default one
+     * @param customLogger
+     * @returns Current APIClient instance for method chaining
+     */
+    setCustomLogger(customLogger: Logger): APIClient;
+    /**
+     * set default logger to use
+     * @returns Current APIClient instance for method chaining
+     */
+    setDefaultLogger(): APIClient;
+    /**
+     * Enable Debug Output to STDOUT
+     * @returns Current APIClient instance for method chaining
+     */
+    enableDebugMode(): APIClient;
+    /**
+     * Disable Debug Output
+     * @returns Current APIClient instance for method chaining
+     */
+    disableDebugMode(): APIClient;
+    /**
+     * Get the API connection url that is currently set
+     * @returns API connection url currently in use
+     */
+    getURL(): string;
+    /**
+     * Possibility to customize default user agent to fit your needs
+     * @param str user agent label
+     * @param rv revision of user agent
+     * @param modules further modules to add to user agent string, format: ["<mod1>/<rev>", "<mod2>/<rev>", ... ]
+     * @returns Current APIClient instance for method chaining
+     */
+    setUserAgent(str: string, rv: string, modules?: any): APIClient;
+    /**
+     * Get the User Agent
+     * @returns User Agent string
+     */
+    getUserAgent(): string;
+    /**
+     * Set the proxy server to use for API communication
+     * @param proxy proxy server to use for communicatio
+     * @returns Current APIClient instance for method chaining
+     */
+    setProxy(proxy: string): APIClient;
+    /**
+     * Get the proxy server configuration
+     * @returns proxy server configuration value or null if not set
+     */
+    getProxy(): string | null;
+    /**
+     * Set the referer to use for API communication
+     * @param referer Referer
+     * @returns Current APIClient instance for method chaining
+     */
+    setReferer(referer: string): APIClient;
+    /**
+     * Get the referer configuration
+     * @returns referer configuration value or null if not set
+     */
+    getReferer(): string | null;
+    /**
+     * Get the current module version
+     * @returns module version
+     */
+    getVersion(): string;
+    /**
+     * Apply session data (session id and system entity) to given client request session
+     * @param session ClientRequest session instance
+     * @returns Current APIClient instance for method chaining
+     */
+    saveSession(session: any): APIClient;
+    /**
+     * Use existing configuration out of ClientRequest session
+     * to rebuild and reuse connection settings
+     * @param session ClientRequest session instance
+     * @returns Current APIClient instance for method chaining
+     */
+    reuseSession(session: any): APIClient;
+    /**
+     * Set another connection url to be used for API communication
+     * @param value API connection url to set
+     * @returns Current APIClient instance for method chaining
+     */
+    setURL(value: string): APIClient;
+    /**
+     * Set Persistent to request session id for API communication
+     * @param value API session id
+     * @returns Current APIClient instance for method chaining
+     */
+    setPersistent(): APIClient;
+    /**
+     * Set Credentials to be used for API communication
+     * @param uid account name
+     * @param pw account password
+     * @returns Current APIClient instance for method chaining
+     */
+    setCredentials(uid: string, pw?: string): APIClient;
+    /**
+     * Set Credentials to be used for API communication
+     * @param uid account name
+     * @param role role user id
+     * @param pw role user password
+     * @returns Current APIClient instance for method chaining
+     */
+    setRoleCredentials(uid: string, role: string, pw?: string): APIClient;
+    /**
+     * Perform API login to start session-based communication
+     * @param otp optional one time password
+     * @returns Promise resolving with API Response
+     */
+    login(): Promise<Response>;
+    /**
+     * Perform API logout to close API session in use
+     * @returns Promise resolving with API Response
+     */
+    logout(): Promise<Response>;
+    /**
+     * Perform API request using the given command
+     * @param cmd API command to request
+     * @returns Promise resolving with API Response
+     */
+    request(cmd: any, setUserView?: boolean): Promise<Response>;
+    /**
+     * Request the next page of list entries for the current list query
+     * Useful for tables
+     * @param rr API Response of current page
+     * @returns Promise resolving with API Response or null in case there are no further list entries
+     */
+    requestNextResponsePage(rr: Response): Promise<Response | null>;
+    /**
+     * Request all pages/entries for the given query command
+     * @param cmd API list command to use
+     * @returns Promise resolving with array of API Responses
+     */
+    requestAllResponsePages(cmd: any): Promise<Response[]>;
+    /**
+     * Set a data view to a given subuser
+     * @param uid subuser account name
+     * @returns Current APIClient instance for method chaining
+     */
+    setUserView(uid: string): APIClient;
+    /**
+     * Reset data view back from subuser to user
+     * @returns Current APIClient instance for method chaining
+     */
+    resetUserView(): APIClient;
+    /**
+     * Activate High Performance Connection Setup
+     * @see https://github.com/centralnicgroup-opensource/rtldev-middleware-node-sdk/blob/master/README.md
+     * @returns Current APIClient instance for method chaining
+     */
+    useHighPerformanceConnectionSetup(): APIClient;
+    /**
+     * Activate Default Connection Setup (the default)
+     * @returns Current APIClient instance for method chaining
+     */
+    useDefaultConnectionSetup(): APIClient;
+    /**
+     * Set OT&E System for API communication
+     * @returns Current APIClient instance for method chaining
+     */
+    useOTESystem(): APIClient;
+    /**
+     * Set LIVE System for API communication (this is the default setting)
+     * @returns Current APIClient instance for method chaining
+     */
+    useLIVESystem(): APIClient;
+    /**
+     * Serialize given command for POST request including connection configuration data
+     * @param cmd API command to encode
+     * @returns encoded POST data string
+     */
+    getPOSTData(cmd: any, secured?: boolean): string;
+    /**
+     * Flatten nested arrays in command
+     * @param cmd api command
+     * @returns api command with flattended parameters
+     */
+    private flattenCommand;
+    /**
+     * Auto convert API command parameters to punycode, if necessary.
+     * @param cmd api command
+     * @returns Promise resolving with api command with IDN values replaced to punycode
+     */
+    private autoIDNConvert;
+}