octopian-configuration-apis 1.0.0

package/README.md

@@ -0,0 +1,104 @@
+<p align="center">
+  <a href="" rel="noopener">
+ <img width=200px height=200px src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTeJ-YBkjQDwqC4eWVNwG-N8qmvuREtZfLn4w&s" alt="Project logo"></a>
+</p>
+
+<h3 align="center">Configuration API SDK</h3>
+
+<div align="center">
+
+[![Status](https://img.shields.io/badge/status-active-success.svg)]()
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)
+
+</div>
+
+---
+
+<p align="center"> APIs SDK that implements Octopian Configuration Services which will be used for any node project typescript or javascript
+    <br> 
+</p>
+
+## 📝 Table of Contents
+
+- [About](#about)
+- [Getting Started](#getting_started)
+- [Usage](#usage)
+- [Built Using](#built_using)
+- [Authors](#authors)
+
+## 🧐 About <a name = "about"></a>
+The APIs SDK simplifies the integration of Octopian Configuration Services into your Node.js applications. With support for both JavaScript and TypeScript, this SDK provides seamless interaction with transaction-based services, leveraging well-defined input and output models. Whether you're working on a backend service, a CLI tool, or a full-stack application, this SDK ensures a consistent and efficient development experience.
+
+Key Features:
+
+Compatibility: Designed for both JavaScript and TypeScript projects.
+
+Modular Design: Offers reusable input and output models to standardize API interactions.
+
+Performance: Optimized for high-speed and reliable transaction processing.
+
+Flexibility: Works across any Node.js environment.
+
+## 🏁 Getting Started <a name = "getting_started"></a>
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
+
+### Prerequisites
+
+Access to the Octopian_Configuration_SDK devops solution is required to install the project.
+
+
+### Installing
+
+A step by step series of examples that tell you how to get a development env running.
+
+Use below command to install the SDK to your project
+
+you will need to provide an API key that was generated by admin to authorize the APIs in the SDK, and the domain name (dns) that will be used for the application.
+
+```typescript
+
+npm install git+https://in4ma.visualstudio.com/DefaultCollection/Octopian_Configuration_SDK/_git/Octopian_Configuration_SDK
+```
+
+### Initializing
+
+In order to use the sdk after installation you need to initialize it, like below.
+
+```typescript
+import { ConfigurationSDKConfig } from "ConfigurationAPIs";
+
+ConfigurationSDKConfig.Init('Your-API-Key',"Doman-Name")
+ConfigurationSDKConfig.SetToken("Set Token")
+```
+
+## 🎈 Usage <a name="usage"></a>
+
+check below sample for usage
+
+```typescript
+import {ConfigurationServices} from 'ConfigurationAPIs';
+
+function BecomeCashier() {
+  var Output = ConfigurationServices.Login({
+    domainName: domain Name;
+    username: username value;
+    password: password value;
+    clientType: client type value;
+  },"Auth Token");
+
+  console.log(Output.Result);
+}
+
+```
+
+
+## ⛏️ Built Using <a name = "built_using"></a>
+
+- [Node.js](https://nodejs.org/en) - Server Environment
+
+## ✍️ Authors <a name = "authors"></a>
+
+- [@Octopian](https://octopian.com/) - Octopian global services
+
+

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "octopian-configuration-apis",
+  "version": "1.0.0",
+  "description": "a global javascript sdk",
+  "main": "./src/index.js",
+  "scripts": {
+    "test": "npm run",
+    "docs": "typedoc --entryPoints ./src/index.d.ts --out docs"
+  },
+  "author": "octopian",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.7.7"
+  },
+  "devDependencies": {
+    "typedoc": "^0.26.11"
+  }
+}