{"_id":"@adaas/a-os","_rev":"1-d21ed076bada0e28d3f449da4119e2f9","name":"@adaas/a-os","dist-tags":{"latest":"0.0.16"},"versions":{"0.0.15":{"name":"@adaas/a-os","version":"0.0.15","keywords":["adaas","a-os","products-management","digital products"],"author":{"name":"adaas.org"},"license":"ISC","_id":"@adaas/a-os@0.0.15","maintainers":[{"name":"andrew-adaas","email":"andrew.t@adaas.org"}],"homepage":"https://github.com/ADAAS-org/adaas-a-os#readme","bugs":{"url":"https://github.com/ADAAS-org/adaas-a-os/issues"},"dist":{"shasum":"c94c278cc301fcf3c489612fcfb771dbaa4346bb","tarball":"https://registry.npmjs.org/@adaas/a-os/-/a-os-0.0.15.tgz","fileCount":68,"integrity":"sha512-1Bh9f775t/ZVY5wbgL39YCvR6mbd6sndB+6yXUkBOISgiXaeeitmDra8Z1a273hh2BVUVTxQd4jjcLqe7+Pv5g==","signatures":[{"sig":"MEYCIQDKhArOJvosTt3sNLMUMIdRAAw9Nz+ZeDqZOdEB7U7deQIhAPsF9IY9XffWglEAHyKks6dE132PQmMMGeYcE18b9qNK","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":147388},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","browser":{"fs":false,"os":false,"path":false},"gitHead":"5d9ed560c226c2aa0b9c9c723f74535c04736621","scripts":{"test":"jest","build":"tsc --declaration --project tsconfig.json && tscpaths -p tsconfig.json -s ./ -o ./dist  ","publish":"npm run build && git add . && git commit -m \"new version created :: $(cat package.json | grep version | head -1  | awk -F: '{ print $2 }'  | sed 's/[\",]//g')\" && npm version patch && npm publish --access public","version":"echo git add .","preversion":"echo test","postversion":"git push --no-verify && git push --tags --no-verify && echo \"\n======Version Pushed Successfully=====\n\" ","echo-version":"echo $npm_package_version"},"_npmUser":{"name":"andrew-adaas","email":"andrew.t@adaas.org"},"repository":{"url":"git+https://github.com/ADAAS-org/adaas-a-os.git","type":"git"},"_npmVersion":"10.2.3","description":"The SDK to interact with a-os API","directories":{"doc":"docs","test":"tests"},"_nodeVersion":"20.10.0","dependencies":{"axios":"^1.6.2","@types/node":"^20.10.0","@adaas/a-auth":"^0.0.61","@adaas/a-products":"0.0.19","@adaas/a-sdk-types":"^0.0.64"},"nodemonConfig":{"ext":"ts, js","exec":"node -r tsconfig-paths/register -r ts-node/register ./src/bin/www.ts","watch":["config","constants","src","lib","db","shared"],"ignore":["**/*.test.ts","**/*.spec.ts",".git","node_modules"]},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.0","jest":"^29.7.0","mocha":"^10.4.0","dotenv":"^16.4.5","ts-jest":"^29.1.2","ts-node":"^10.9.2","tscpaths":"^0.0.9","@types/chai":"^4.3.14","@types/jest":"^29.5.12","@types/mocha":"^10.0.6","tsconfig-paths":"^4.2.0"},"_npmOperationalInternal":{"tmp":"tmp/a-os_0.0.15_1723756014925_0.39896427078968966","host":"s3://npm-registry-packages"}},"0.0.16":{"name":"@adaas/a-os","version":"0.0.16","description":"The SDK to interact with a-os API","main":"./dist/index.js","module":"./dist/index.mjs","types":"./dist/index.d.ts","nodemonConfig":{"ignore":["**/*.test.ts","**/*.spec.ts",".git","node_modules"],"watch":["config","constants","src","lib","db","shared"],"exec":"node -r tsconfig-paths/register -r ts-node/register ./src/bin/www.ts","ext":"ts, js"},"scripts":{"test":"jest","publish":"npm run build && git add . && git commit -m \"new version created :: $(cat package.json | grep version | head -1  | awk -F: '{ print $2 }'  | sed 's/[\",]//g')\" && npm version patch && npm publish --access public","preversion":"echo test","version":"echo git add .","postversion":"git push --no-verify && git push --tags --no-verify && echo \"\n======Version Pushed Successfully=====\n\" ","echo-version":"echo $npm_package_version","build":"tsc --declaration --project tsconfig.json && tscpaths -p tsconfig.json -s ./ -o ./dist  "},"repository":{"type":"git","url":"git+https://github.com/ADAAS-org/adaas-a-os.git"},"keywords":["adaas","a-os","products-management","digital products"],"author":{"name":"adaas.org"},"license":"ISC","bugs":{"url":"https://github.com/ADAAS-org/adaas-a-os/issues"},"homepage":"https://github.com/ADAAS-org/adaas-a-os#readme","dependencies":{"@adaas/a-auth":"^0.0.61","@adaas/a-products":"0.0.19","@adaas/a-sdk-types":"^0.0.64","@types/node":"^20.10.0","axios":"^1.6.2"},"devDependencies":{"@types/chai":"^4.3.14","@types/jest":"^29.5.12","@types/mocha":"^10.0.6","chai":"^5.1.0","dotenv":"^16.4.5","jest":"^29.7.0","mocha":"^10.4.0","ts-jest":"^29.1.2","ts-node":"^10.9.2","tsconfig-paths":"^4.2.0","tscpaths":"^0.0.9"},"browser":{"fs":false,"os":false,"path":false},"directories":{"doc":"docs","test":"tests"},"_id":"@adaas/a-os@0.0.16","gitHead":"a0e61b9b24d8a56440a9ab54da346776cca26887","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-P4uV6u8EgPYyRI8yoAgMveQ4XBPS1TxAiZ9R1/D5lb6Lf57HL2p7qfQ3QwoGl/K+PMbYaQdTKn0ywCn/dbbvEg==","shasum":"f7003a4269e0e0efe7546f0baf7fb159d6fa8dc9","tarball":"https://registry.npmjs.org/@adaas/a-os/-/a-os-0.0.16.tgz","fileCount":68,"unpackedSize":147435,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBr1YsDoX+4diDlcLHvRydW7gLvpahAqpGhUNiRhdz7uAiEA8w/LzaERTbspMkKrkxio+7bl8FCZXNDy7qP1bxtwG4Y="}]},"_npmUser":{"name":"andrew-adaas","email":"andrew.t@adaas.org"},"maintainers":[{"name":"andrew-adaas","email":"andrew.t@adaas.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/a-os_0.0.16_1723765423838_0.04114448973634666"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-15T21:06:54.844Z","modified":"2024-08-15T23:43:44.243Z","0.0.15":"2024-08-15T21:06:55.148Z","0.0.16":"2024-08-15T23:43:44.029Z"},"bugs":{"url":"https://github.com/ADAAS-org/adaas-a-os/issues"},"author":{"name":"adaas.org"},"license":"ISC","homepage":"https://github.com/ADAAS-org/adaas-a-os#readme","keywords":["adaas","a-os","products-management","digital products"],"repository":{"type":"git","url":"git+https://github.com/ADAAS-org/adaas-a-os.git"},"description":"The SDK to interact with a-os API","maintainers":[{"name":"andrew-adaas","email":"andrew.t@adaas.org"}],"readme":"<img align=\"left\" style=\"margin-right:40px; margin-bottom:80px;\" width=\"180\" height=\"80\" src=\"./docs/a-logo-docs.png\" alt=\"ADAAS Logo\">\n\n# a-os SDK \n\n| LTS | Latest | npm               |\n|---------------|----------|---------------------------|\n| v1.0.0      |   v1.0.1    |     [@adaas/a-os](https://npm.com)    |\n\n\n<!-- TABLE OF CONTENTS -->\n## Table of Contents\n\n- [About the Project](#overview)\n- [Quick Start](#quick-start)\n- [ENV Variables](#environment-variables)\n- [Links](#links)\n\n\n## Quick Start\n\n#### Step 1: Install SDK\n\n```bash\n\ncd /your/project/location\nadf\nnpm i @adaas/a-os\n\n```\n\n#### Step 2: Provide Credentials \n\nYou can pass credentials through ENV variable or via code:\n\n##### BASH \n\n```bash\n# Mandatory\nADAAS_API_CREDENTIALS_CLIENT_ID=ADAAS--client::769e6cb6597b...YOUR_ID...911f3060c161\nADAAS_API_CREDENTIALS_CLIENT_SECRET=ADAAS--secret::5ca6204b...YOUR_SECRET...e90c00a263f4db\n\n```\n\n##### In APPLICATION \n\n```javascript\nconst ADAAS_API_CREDENTIALS_CLIENT_ID = process.env.ADAAS_API_CREDENTIALS_CLIENT_ID!;\nconst ADAAS_API_CREDENTIALS_CLIENT_SECRET = process.env.ADAAS_API_CREDENTIALS_CLIENT_SECRET!\nADAAS_A_AUTH_Context.setCredentials(\n    ADAAS_API_CREDENTIALS_CLIENT_ID,\n    ADAAS_API_CREDENTIALS_CLIENT_SECRET\n\nawait ADAAS_A_AUTH_Context.authenticate();\n```\n\n\n#### Step 4: Start Using  \nBy installing this app into your application then you will be able to access the ADAAS API or ADAAS products API via SSO \n\n\n```javascript\n\n```\n\n\n\n## Environment Variables\n\n| Variable Name | Required | Description               |\n|---------------|----------|---------------------------|\n| ADAAS_API_CREDENTIALS_CLIENT_ID      |    YES    |      Your ADAAS API Credentials Key. Not mandatory in case when  it's provided through the code     |\n| ADAAS_API_CREDENTIALS_CLIENT_SECRET    |    YES    | Your ADAAS Api Credentials Secret Not mandatory in case when  it's provided through the code  |\n| ADAAS_A_AUTH_CONFIG_SDK_VALIDATION    |    NO    | Allows to ignore configurations validation |\n| ADAAS_A_AUTH_CONFIG_VERBOSE    |    NO    | Allows to turn off extra library logs |\n| ADAAS_A_AUTH_CONFIG_IGNORE_ERRORS    |    NO    | Allows to ignore error  |\n\n## Links\n\n- [ADAAS Website](https://adaas.org)\n- [Report Issues](https://github.com/ADAAS-org/adaas-adf-auth/issues)\n- [Become Future Creator](https://sso.adaas.org)\n---\n","readmeFilename":"README.md"}