From fe3eee2b0558b330bd00422b4e2cd32cb345626a Mon Sep 17 00:00:00 2001 From: EvanJ0hnson Date: Wed, 16 Sep 2020 16:03:39 +0300 Subject: [PATCH] Base structure --- .editorconfig | 8 + .huskyrc.js | 6 + .prettierrc | 4 + package-lock.json | 391 ++++++++++++++++++ package.json | 24 ++ .../abstract-entity-api.ts | 88 ++++ src/abstract-entity-api/index.ts | 5 + src/api-clients/api-clients.ts | 37 ++ src/api-clients/index.ts | 1 + src/app-profiles/app-profiles.ts | 19 + src/app-profiles/index.ts | 1 + src/apps/apps.ts | 17 + src/apps/index.ts | 1 + src/auth/auth.ts | 23 ++ src/auth/definitions.ts | 3 + src/auth/index.ts | 1 + src/base-64.ts | 11 + src/credentials/credentials.ts | 47 +++ src/credentials/index.ts | 1 + src/devices/devices.ts | 25 ++ src/devices/index.ts | 1 + src/disposable.ts | 10 + src/entities/access-type.ts | 5 + src/entities/account.ts | 5 + src/entities/api-client-key.ts | 65 +++ src/entities/api-client.ts | 8 + src/entities/api-key.ts | 4 + src/entities/app-profile.ts | 3 + src/entities/app.ts | 3 + src/entities/auth-data.ts | 7 + src/entities/base.ts | 4 + src/entities/credentials.ts | 5 + src/entities/device.ts | 5 + src/entities/entity-type.ts | 4 + src/entities/env-config.ts | 5 + src/entities/index.ts | 20 + src/entities/property-type.ts | 8 + src/entities/property.ts | 29 ++ src/entities/publish-type.ts | 3 + src/entities/user.ts | 10 + src/index.ts | 7 + src/instance.ts | 74 ++++ src/properties/index.ts | 1 + src/properties/properties.ts | 41 ++ src/rest-client/definitions.ts | 44 ++ src/rest-client/index.ts | 6 + src/rest-client/rest-client.ts | 161 ++++++++ tsconfig.json | 21 + 48 files changed, 1272 insertions(+) create mode 100644 .editorconfig create mode 100644 .huskyrc.js create mode 100644 .prettierrc create mode 100644 package-lock.json create mode 100644 package.json create mode 100644 src/abstract-entity-api/abstract-entity-api.ts create mode 100644 src/abstract-entity-api/index.ts create mode 100644 src/api-clients/api-clients.ts create mode 100644 src/api-clients/index.ts create mode 100644 src/app-profiles/app-profiles.ts create mode 100644 src/app-profiles/index.ts create mode 100644 src/apps/apps.ts create mode 100644 src/apps/index.ts create mode 100644 src/auth/auth.ts create mode 100644 src/auth/definitions.ts create mode 100644 src/auth/index.ts create mode 100644 src/base-64.ts create mode 100644 src/credentials/credentials.ts create mode 100644 src/credentials/index.ts create mode 100644 src/devices/devices.ts create mode 100644 src/devices/index.ts create mode 100644 src/disposable.ts create mode 100644 src/entities/access-type.ts create mode 100644 src/entities/account.ts create mode 100644 src/entities/api-client-key.ts create mode 100644 src/entities/api-client.ts create mode 100644 src/entities/api-key.ts create mode 100644 src/entities/app-profile.ts create mode 100644 src/entities/app.ts create mode 100644 src/entities/auth-data.ts create mode 100644 src/entities/base.ts create mode 100644 src/entities/credentials.ts create mode 100644 src/entities/device.ts create mode 100644 src/entities/entity-type.ts create mode 100644 src/entities/env-config.ts create mode 100644 src/entities/index.ts create mode 100644 src/entities/property-type.ts create mode 100644 src/entities/property.ts create mode 100644 src/entities/publish-type.ts create mode 100644 src/entities/user.ts create mode 100644 src/index.ts create mode 100644 src/instance.ts create mode 100644 src/properties/index.ts create mode 100644 src/properties/properties.ts create mode 100644 src/rest-client/definitions.ts create mode 100644 src/rest-client/index.ts create mode 100644 src/rest-client/rest-client.ts create mode 100644 tsconfig.json diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..025dd8c --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true diff --git a/.huskyrc.js b/.huskyrc.js new file mode 100644 index 0000000..aaa0539 --- /dev/null +++ b/.huskyrc.js @@ -0,0 +1,6 @@ +module.exports = { + hooks: { + 'post-checkout': 'yarn install', + 'post-merge': 'yarn install', + }, +}; diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..dcb7279 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,4 @@ +{ + "singleQuote": true, + "trailingComma": "all" +} \ No newline at end of file diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..001bae0 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,391 @@ +{ + "name": "@evanj0hnson/js-sdk", + "version": "0.1.0-alpha.1", + "lockfileVersion": 1, + "requires": true, + "dependencies": { + "@babel/code-frame": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.10.4.tgz", + "integrity": "sha512-vG6SvB6oYEhvgisZNFRmRCUkLz11c7rp+tbNTynGqc6mS1d5ATd/sGyV6W0KZZnXRKMTzZDRgQT3Ou9jhpAfUg==", + "dev": true, + "requires": { + "@babel/highlight": "^7.10.4" + } + }, + "@babel/helper-validator-identifier": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.10.4.tgz", + "integrity": "sha512-3U9y+43hz7ZM+rzG24Qe2mufW5KhvFg/NhnNph+i9mgCtdTCtMJuI1TMkrIUiK7Ix4PYlRF9I5dhqaLYA/ADXw==", + "dev": true + }, + "@babel/highlight": { + "version": "7.10.4", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.10.4.tgz", + "integrity": "sha512-i6rgnR/YgPEQzZZnbTHHuZdlE8qyoBNalD6F+q4vAFlcMEcqmkoG+mPqJYJCo63qPf74+Y1UZsl3l6f7/RIkmA==", + "dev": true, + "requires": { + "@babel/helper-validator-identifier": "^7.10.4", + "chalk": "^2.0.0", + "js-tokens": "^4.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "requires": { + "color-convert": "^1.9.0" + } + }, + "chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "requires": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" + } + }, + "color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "requires": { + "color-name": "1.1.3" + } + }, + "color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true + }, + "supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "@types/color-name": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/@types/color-name/-/color-name-1.1.1.tgz", + "integrity": "sha512-rr+OQyAjxze7GgWrSaJwydHStIhHq2lvY3BOC2Mj7KnzI7XK0Uw1TOOdI9lDoajEbSWLiYgoo4f1R51erQfhPQ==", + "dev": true + }, + "@types/parse-json": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@types/parse-json/-/parse-json-4.0.0.tgz", + "integrity": "sha512-//oorEZjL6sbPcKUaCdIGlIUeH26mgzimjBB77G6XRgnDl/L5wOnpyBGRe/Mmf5CVW3PwEBE1NjiMZ/ssFh4wA==", + "dev": true + }, + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true + }, + "chalk": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.0.tgz", + "integrity": "sha512-qwx12AxXe2Q5xQ43Ac//I6v5aXTipYrSESdOgzrN+9XjgEpyjpKuvSGaN4qE93f7TQTlerQQ8S+EQ0EyDoVL1A==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "ci-info": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-2.0.0.tgz", + "integrity": "sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==", + "dev": true + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "compare-versions": { + "version": "3.6.0", + "resolved": "https://registry.npmjs.org/compare-versions/-/compare-versions-3.6.0.tgz", + "integrity": "sha512-W6Af2Iw1z4CB7q4uU4hv646dW9GQuBM+YpC0UvUCWSD8w90SJjp+ujJuXaEMtAXBtSqGfMPuFOVn4/+FlaqfBA==", + "dev": true + }, + "cosmiconfig": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/cosmiconfig/-/cosmiconfig-7.0.0.tgz", + "integrity": "sha512-pondGvTuVYDk++upghXJabWzL6Kxu6f26ljFw64Swq9v6sQPUL3EUlVDV56diOjpCayKihL6hVe8exIACU4XcA==", + "dev": true, + "requires": { + "@types/parse-json": "^4.0.0", + "import-fresh": "^3.2.1", + "parse-json": "^5.0.0", + "path-type": "^4.0.0", + "yaml": "^1.10.0" + } + }, + "error-ex": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", + "integrity": "sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==", + "dev": true, + "requires": { + "is-arrayish": "^0.2.1" + } + }, + "escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=", + "dev": true + }, + "find-up": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "dev": true, + "requires": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + } + }, + "find-versions": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/find-versions/-/find-versions-3.2.0.tgz", + "integrity": "sha512-P8WRou2S+oe222TOCHitLy8zj+SIsVJh52VP4lvXkaFVnOFFdoWv1H1Jjvel1aI6NCFOAaeAVm8qrI0odiLcww==", + "dev": true, + "requires": { + "semver-regex": "^2.0.0" + } + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "husky": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/husky/-/husky-4.3.0.tgz", + "integrity": "sha512-tTMeLCLqSBqnflBZnlVDhpaIMucSGaYyX6855jM4AguGeWCeSzNdb1mfyWduTZ3pe3SJVvVWGL0jO1iKZVPfTA==", + "dev": true, + "requires": { + "chalk": "^4.0.0", + "ci-info": "^2.0.0", + "compare-versions": "^3.6.0", + "cosmiconfig": "^7.0.0", + "find-versions": "^3.2.0", + "opencollective-postinstall": "^2.0.2", + "pkg-dir": "^4.2.0", + "please-upgrade-node": "^3.2.0", + "slash": "^3.0.0", + "which-pm-runs": "^1.0.0" + } + }, + "import-fresh": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.2.1.tgz", + "integrity": "sha512-6e1q1cnWP2RXD9/keSkxHScg508CdXqXWgWBaETNhyuBFz+kUZlKboh+ISK+bU++DmbHimVBrOz/zzPe0sZ3sQ==", + "dev": true, + "requires": { + "parent-module": "^1.0.0", + "resolve-from": "^4.0.0" + } + }, + "is-arrayish": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/is-arrayish/-/is-arrayish-0.2.1.tgz", + "integrity": "sha1-d8mYQFJ6qOyxqLppe4BkWnqSap0=", + "dev": true + }, + "js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true + }, + "json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "dev": true + }, + "lines-and-columns": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/lines-and-columns/-/lines-and-columns-1.1.6.tgz", + "integrity": "sha1-HADHQ7QzzQpOgHWPe2SldEDZ/wA=", + "dev": true + }, + "locate-path": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "dev": true, + "requires": { + "p-locate": "^4.1.0" + } + }, + "opencollective-postinstall": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/opencollective-postinstall/-/opencollective-postinstall-2.0.3.tgz", + "integrity": "sha512-8AV/sCtuzUeTo8gQK5qDZzARrulB3egtLzFgteqB2tcT4Mw7B8Kt7JcDHmltjz6FOAHsvTevk70gZEbhM4ZS9Q==", + "dev": true + }, + "p-limit": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", + "integrity": "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==", + "dev": true, + "requires": { + "p-try": "^2.0.0" + } + }, + "p-locate": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "dev": true, + "requires": { + "p-limit": "^2.2.0" + } + }, + "p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true + }, + "parent-module": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", + "integrity": "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==", + "dev": true, + "requires": { + "callsites": "^3.0.0" + } + }, + "parse-json": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-5.1.0.tgz", + "integrity": "sha512-+mi/lmVVNKFNVyLXV31ERiy2CY5E1/F6QtJFEzoChPRwwngMNXRDQ9GJ5WdE2Z2P4AujsOi0/+2qHID68KwfIQ==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "error-ex": "^1.3.1", + "json-parse-even-better-errors": "^2.3.0", + "lines-and-columns": "^1.1.6" + } + }, + "path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true + }, + "path-type": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", + "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "dev": true + }, + "pkg-dir": { + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-4.2.0.tgz", + "integrity": "sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==", + "dev": true, + "requires": { + "find-up": "^4.0.0" + } + }, + "please-upgrade-node": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/please-upgrade-node/-/please-upgrade-node-3.2.0.tgz", + "integrity": "sha512-gQR3WpIgNIKwBMVLkpMUeR3e1/E1y42bqDQZfql+kDeXd8COYfM8PQA4X6y7a8u9Ua9FHmsrrmirW2vHs45hWg==", + "dev": true, + "requires": { + "semver-compare": "^1.0.0" + } + }, + "resolve-from": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", + "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", + "dev": true + }, + "semver-compare": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/semver-compare/-/semver-compare-1.0.0.tgz", + "integrity": "sha1-De4hahyUGrN+nvsXiPavxf9VN/w=", + "dev": true + }, + "semver-regex": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/semver-regex/-/semver-regex-2.0.0.tgz", + "integrity": "sha512-mUdIBBvdn0PLOeP3TEkMH7HHeUP3GjsXCwKarjv/kGmUFOYg1VqEemKhoQpWMu6X2I8kHeuVdGibLGkVK+/5Qw==", + "dev": true + }, + "slash": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", + "dev": true + }, + "supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + }, + "which-pm-runs": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/which-pm-runs/-/which-pm-runs-1.0.0.tgz", + "integrity": "sha1-Zws6+8VS4LVd9rd4DKdGFfI60cs=", + "dev": true + }, + "yaml": { + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.0.tgz", + "integrity": "sha512-yr2icI4glYaNG+KWONODapy2/jDdMSDnrONSjblABjD9B4Z5LgiircSt8m8sRZFNi08kG9Sm0uSHtEmP3zaEGg==", + "dev": true + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..6f47c8d --- /dev/null +++ b/package.json @@ -0,0 +1,24 @@ +{ + "name": "@evanj0hnson/js-sdk", + "version": "0.1.0-alpha.0", + "description": "Connio JavaScript SKD", + "main": "./src/index.ts", + "repository": { + "type": "git", + "url": "git+https://github.com/EvanJ0hnson/cio-js-sdk.git" + }, + "author": "Connio Inc.", + "contributors": [ + "Connio Inc.", + "Ivan Gerasimov " + ], + "license": "MIT", + "bugs": { + "url": "https://github.com/EvanJ0hnson/cio-js-sdk/issues" + }, + "homepage": "https://github.com/EvanJ0hnson/cio-js-sdk#readme", + "devDependencies": { + "husky": "4.3.0" + }, + "dependencies": {} +} diff --git a/src/abstract-entity-api/abstract-entity-api.ts b/src/abstract-entity-api/abstract-entity-api.ts new file mode 100644 index 0000000..29a36d3 --- /dev/null +++ b/src/abstract-entity-api/abstract-entity-api.ts @@ -0,0 +1,88 @@ +import { + IDeleteResponse, + IPaginatedResponse, + IQueryParams, + IRestClient, +} from '../rest-client'; + +export interface IAbstractEntityOptions { + client: IRestClient; +} + +export interface IAbstractEntityApi< + TEntity, + TNewEntityPayload = Partial +> { + paginatedList( + queryParams?: IQueryParams, + ): Promise>; + list(queryParams?: IQueryParams): Promise; + delete(entityRef: string): Promise; + read(entityRef: string): Promise; + create(entity: TNewEntityPayload): Promise; + update(entityRef: string, entity: Partial): Promise; +} + +export abstract class AbstractEntityApi< + TEntity, + TNewEntityPayload = Partial +> implements IAbstractEntityApi { + protected readonly client: IRestClient; + + protected abstract BASE_URL: string; + + constructor(options: IAbstractEntityOptions) { + this.client = options.client; + } + + public async paginatedList( + queryParams?: IQueryParams, + ): Promise> { + return await this.client.get>( + this.BASE_URL, + queryParams, + ); + } + + public async list(queryParams?: IQueryParams): Promise { + let response = await this.paginatedList(queryParams); + + return response.results; + } + + /** + * @param entityRef Entity’s name or id + */ + public async delete(entityRef: string): Promise { + let response: IDeleteResponse = await this.client.delete( + `${this.BASE_URL}/${entityRef}`, + ); + + if (response.nrOfItems === 0) { + return Promise.reject(response); + } + + return response; + } + + /** + * @param entityRef Entity’s name or id + */ + public async read(entityRef: string): Promise { + return await this.client.get(`${this.BASE_URL}/${entityRef}`); + } + + public async create(entity: TNewEntityPayload): Promise { + return await this.client.post(this.BASE_URL, entity); + } + + public async update( + entityRef: string, + entity: Partial, + ): Promise { + return await this.client.put( + `${this.BASE_URL}/${entityRef}`, + entity, + ); + } +} diff --git a/src/abstract-entity-api/index.ts b/src/abstract-entity-api/index.ts new file mode 100644 index 0000000..60e4e91 --- /dev/null +++ b/src/abstract-entity-api/index.ts @@ -0,0 +1,5 @@ +export { + AbstractEntityApi, + IAbstractEntityApi, + IAbstractEntityOptions, +} from './abstract-entity-api'; diff --git a/src/api-clients/api-clients.ts b/src/api-clients/api-clients.ts new file mode 100644 index 0000000..18fedea --- /dev/null +++ b/src/api-clients/api-clients.ts @@ -0,0 +1,37 @@ +import { + AbstractEntityApi, + IAbstractEntityApi, + IAbstractEntityOptions, +} from '../abstract-entity-api'; +import { IApiClient } from '../entities'; +import { IApiClientKey } from '../entities/api-client-key'; + +interface INewApiClient + extends Partial< + Pick + >, + Required> {} + +interface IApiClientsOptions extends IAbstractEntityOptions {} +export interface IApiClients + extends IAbstractEntityApi { + create(entity: INewApiClient): Promise; + + /** + * @param id Api client's id + */ + regenerate(id: string): Promise; +} + +export class ApiClients extends AbstractEntityApi { + protected BASE_URL = '/apiclients'; + + constructor(options: IApiClientsOptions) { + super(options); + } + + public async regenerate(id: string): Promise { + console.log('asd') + return await this.client.post(`/${id}/apikey`, { id }); + } +} diff --git a/src/api-clients/index.ts b/src/api-clients/index.ts new file mode 100644 index 0000000..7a2ac26 --- /dev/null +++ b/src/api-clients/index.ts @@ -0,0 +1 @@ +export { ApiClients, IApiClients } from './api-clients'; diff --git a/src/app-profiles/app-profiles.ts b/src/app-profiles/app-profiles.ts new file mode 100644 index 0000000..cd95443 --- /dev/null +++ b/src/app-profiles/app-profiles.ts @@ -0,0 +1,19 @@ +import { + AbstractEntityApi, + IAbstractEntityApi, + IAbstractEntityOptions, +} from '../abstract-entity-api'; +import { IAppProfile } from '../entities'; + +export interface IAppProfiles extends IAbstractEntityApi {} +export interface IAppProfilesOptions extends IAbstractEntityOptions {} + +export class AppProfiles + extends AbstractEntityApi + implements IAppProfiles { + protected BASE_URL = '/appprofiles'; + + constructor(options: IAppProfilesOptions) { + super(options); + } +} diff --git a/src/app-profiles/index.ts b/src/app-profiles/index.ts new file mode 100644 index 0000000..a0e6ce2 --- /dev/null +++ b/src/app-profiles/index.ts @@ -0,0 +1 @@ +export { AppProfiles, IAppProfiles } from './app-profiles'; diff --git a/src/apps/apps.ts b/src/apps/apps.ts new file mode 100644 index 0000000..7158efb --- /dev/null +++ b/src/apps/apps.ts @@ -0,0 +1,17 @@ +import { + AbstractEntityApi, + IAbstractEntityApi, + IAbstractEntityOptions, +} from '../abstract-entity-api'; +import { IApp } from '../entities'; + +export interface IApps extends IAbstractEntityApi {} +export interface IAppsOptions extends IAbstractEntityOptions {} + +export class Apps extends AbstractEntityApi implements IApps { + protected BASE_URL = '/apps'; + + constructor(options: IAppsOptions) { + super(options); + } +} diff --git a/src/apps/index.ts b/src/apps/index.ts new file mode 100644 index 0000000..8e31a85 --- /dev/null +++ b/src/apps/index.ts @@ -0,0 +1 @@ +export { Apps, IApps } from './apps'; diff --git a/src/auth/auth.ts b/src/auth/auth.ts new file mode 100644 index 0000000..0ea44b0 --- /dev/null +++ b/src/auth/auth.ts @@ -0,0 +1,23 @@ +import { IAuthData, IUserCredentials } from '../entities'; +import { IRestClient } from '../rest-client'; +import { IdentityPath } from './definitions'; + +export interface IAuth { + login(user: IUserCredentials): Promise; +} + +interface IAuthOptions { + client: IRestClient; +} + +export class Auth { + private readonly _client: IRestClient; + + constructor({ client }: IAuthOptions) { + this._client = client; + } + + async login(user: IUserCredentials): Promise { + return await this._client.post(IdentityPath.LogIn, user); + } +} diff --git a/src/auth/definitions.ts b/src/auth/definitions.ts new file mode 100644 index 0000000..ec61882 --- /dev/null +++ b/src/auth/definitions.ts @@ -0,0 +1,3 @@ +export enum IdentityPath { + LogIn = '/identity/login', +} diff --git a/src/auth/index.ts b/src/auth/index.ts new file mode 100644 index 0000000..82b53f3 --- /dev/null +++ b/src/auth/index.ts @@ -0,0 +1 @@ +export { Auth, IAuth } from './auth'; diff --git a/src/base-64.ts b/src/base-64.ts new file mode 100644 index 0000000..2a76bd9 --- /dev/null +++ b/src/base-64.ts @@ -0,0 +1,11 @@ +export type TBase64String = string; + +export class Base64 { + static to(value: string): TBase64String { + return window.btoa(value); + } + + static from(value: TBase64String): string { + return window.atob(value); + } +} diff --git a/src/credentials/credentials.ts b/src/credentials/credentials.ts new file mode 100644 index 0000000..2743340 --- /dev/null +++ b/src/credentials/credentials.ts @@ -0,0 +1,47 @@ +import { ICredentials } from '../entities'; + +export interface ICredentialsStore { + isEmpty: boolean; + set(credentials?: ICredentials): this; + get(): ICredentials; +} + +export class CredentialsStore { + private _credentials: ICredentials; + + public isEmpty = true; + + constructor(credentials?: ICredentials) { + this._credentials = this._makeCredentials(credentials); + } + + private _setIsEmpty(credentials: ICredentials): this { + this.isEmpty = !( + credentials.id && + credentials.username && + credentials.password + ); + + return this; + } + + private _makeCredentials(crendentials?: ICredentials): ICredentials { + return Object.freeze({ + id: crendentials?.id || '', + username: crendentials?.username || '', + password: crendentials?.password || '', + }); + } + + public set(crendentials: ICredentials): this { + this._credentials = this._makeCredentials(crendentials); + + this._setIsEmpty(this._credentials); + + return this; + } + + public get(): ICredentials { + return this._credentials; + } +} diff --git a/src/credentials/index.ts b/src/credentials/index.ts new file mode 100644 index 0000000..35e6344 --- /dev/null +++ b/src/credentials/index.ts @@ -0,0 +1 @@ +export { CredentialsStore, ICredentialsStore } from './credentials'; diff --git a/src/devices/devices.ts b/src/devices/devices.ts new file mode 100644 index 0000000..59c3f94 --- /dev/null +++ b/src/devices/devices.ts @@ -0,0 +1,25 @@ +import { + AbstractEntityApi, + IAbstractEntityApi, + IAbstractEntityOptions, +} from '../abstract-entity-api'; +import { IDevice } from '../entities'; + +export interface IDevices extends IAbstractEntityApi { + associateWithApps(deviceId: string, appId: string): Promise; +} +export interface IDevicesOptions extends IAbstractEntityOptions {} + +export class Devices extends AbstractEntityApi implements IDevices { + protected BASE_URL = '/devices'; + + constructor(options: IDevicesOptions) { + super(options); + } + + public async associateWithApps(deviceId: string, ...appRef: string[]) { + return await this.update(deviceId, { + apps: appRef, + }); + } +} diff --git a/src/devices/index.ts b/src/devices/index.ts new file mode 100644 index 0000000..3baeffe --- /dev/null +++ b/src/devices/index.ts @@ -0,0 +1 @@ +export { Devices, IDevices } from './devices'; diff --git a/src/disposable.ts b/src/disposable.ts new file mode 100644 index 0000000..0c7e56a --- /dev/null +++ b/src/disposable.ts @@ -0,0 +1,10 @@ +/** + * Represents a type which can release resources, such + * as event listening or a timer. + */ +export interface IDisposable { + disposed: boolean; + + /** Dispose this object */ + dispose(): any; +} diff --git a/src/entities/access-type.ts b/src/entities/access-type.ts new file mode 100644 index 0000000..93d7d65 --- /dev/null +++ b/src/entities/access-type.ts @@ -0,0 +1,5 @@ +export enum AccessType { + Private = 'private', + Protected = 'protected', + Public = 'public', +} diff --git a/src/entities/account.ts b/src/entities/account.ts new file mode 100644 index 0000000..65289b7 --- /dev/null +++ b/src/entities/account.ts @@ -0,0 +1,5 @@ +import { IBaseEntity } from './base'; + +export interface IAccountEntity extends IBaseEntity { + friendlyName: string; +} diff --git a/src/entities/api-client-key.ts b/src/entities/api-client-key.ts new file mode 100644 index 0000000..cc5e43b --- /dev/null +++ b/src/entities/api-client-key.ts @@ -0,0 +1,65 @@ +import { IApiKey } from './api-key'; + +export enum ApiClientKeyAccountScope { + Read = 'account:read', +} + +export enum ApiClientKeyApiClientScope { + Read = 'apiclient:read', +} + +export enum ApiClientKeySubAccountScope { + Read = 'subaccount:read', +} + +export enum ApiClientKeyDeviceScope { + Execute = 'device:execute', + Modify = 'device:modify', + Read = 'device:read', + ReadData = 'device:read-data', + WriteData = 'device:write-data', +} + +export enum ApiClientKeyDeviceProfileScope { + Modify = 'deviceprofile:modify', + Read = 'deviceprofile:read', +} + +export enum ApiClientKeyAppScope { + Modify = 'app:modify', + Read = 'app:read', + ReadData = 'app:read-data', +} + +export enum ApiClientKeyAppProfileScope { + Modify = 'appprofile:modify', + Read = 'appprofile:read', +} + +export type TApiClientKeyScope = + | ApiClientKeyDeviceScope + | ApiClientKeyDeviceProfileScope + | ApiClientKeyAppScope + | ApiClientKeyAppProfileScope + | ApiClientKeyAccountScope + | ApiClientKeyApiClientScope + | ApiClientKeySubAccountScope; + +export enum ApiClientKeyContextType { + Account = 'account', + App = 'app', + Device = 'device', +} + +export interface IApiClientKeyContext { + type: ApiClientKeyContextType; + ids: string[]; +} + +export interface IApiClientKey extends IApiKey { + ownerId: string; + accountId: string; + context: IApiClientKeyContext; + scope: TApiClientKeyScope[]; + rateLimit: number; +} diff --git a/src/entities/api-client.ts b/src/entities/api-client.ts new file mode 100644 index 0000000..287abff --- /dev/null +++ b/src/entities/api-client.ts @@ -0,0 +1,8 @@ +import { IBaseEntity } from './base'; + +export interface IApiClient extends IBaseEntity { + accountId: string; + friendlyName?: string; + description?: string; + tags?: string[]; +} diff --git a/src/entities/api-key.ts b/src/entities/api-key.ts new file mode 100644 index 0000000..53ed828 --- /dev/null +++ b/src/entities/api-key.ts @@ -0,0 +1,4 @@ +export interface IApiKey { + readonly id: string; + readonly secret: string; +} diff --git a/src/entities/app-profile.ts b/src/entities/app-profile.ts new file mode 100644 index 0000000..81bcee7 --- /dev/null +++ b/src/entities/app-profile.ts @@ -0,0 +1,3 @@ +import { IBaseEntity } from './base'; + +export interface IAppProfile extends IBaseEntity {} diff --git a/src/entities/app.ts b/src/entities/app.ts new file mode 100644 index 0000000..00f7963 --- /dev/null +++ b/src/entities/app.ts @@ -0,0 +1,3 @@ +import { IBaseEntity } from '../entities/base'; + +export interface IApp extends IBaseEntity {} diff --git a/src/entities/auth-data.ts b/src/entities/auth-data.ts new file mode 100644 index 0000000..dfacb31 --- /dev/null +++ b/src/entities/auth-data.ts @@ -0,0 +1,7 @@ +import { IAccountEntity, IApiKey, IUser } from '../entities'; + +export interface IAuthData { + account: IAccountEntity; + apiKey: IApiKey; + user: IUser; +} diff --git a/src/entities/base.ts b/src/entities/base.ts new file mode 100644 index 0000000..068276d --- /dev/null +++ b/src/entities/base.ts @@ -0,0 +1,4 @@ +export interface IBaseEntity { + readonly id: string; + name: string; +} diff --git a/src/entities/credentials.ts b/src/entities/credentials.ts new file mode 100644 index 0000000..6d358da --- /dev/null +++ b/src/entities/credentials.ts @@ -0,0 +1,5 @@ +export interface ICredentials { + id: string; + username: string; + password: string; +} diff --git a/src/entities/device.ts b/src/entities/device.ts new file mode 100644 index 0000000..41e5c1d --- /dev/null +++ b/src/entities/device.ts @@ -0,0 +1,5 @@ +import { IBaseEntity } from '../entities/base'; + +export interface IDevice extends IBaseEntity { + apps?: string[]; +} diff --git a/src/entities/entity-type.ts b/src/entities/entity-type.ts new file mode 100644 index 0000000..3cfff11 --- /dev/null +++ b/src/entities/entity-type.ts @@ -0,0 +1,4 @@ +export enum EntityType { + App = 'app', + Device = 'device', +} diff --git a/src/entities/env-config.ts b/src/entities/env-config.ts new file mode 100644 index 0000000..5f20553 --- /dev/null +++ b/src/entities/env-config.ts @@ -0,0 +1,5 @@ +export interface IEnvConfig { + API_AUTH_URL: string; + API_URL: string; + isDev: boolean; +} diff --git a/src/entities/index.ts b/src/entities/index.ts new file mode 100644 index 0000000..29851af --- /dev/null +++ b/src/entities/index.ts @@ -0,0 +1,20 @@ +export { AccessType } from './access-type'; +export { IAccountEntity } from './account'; +export { IApiClient } from './api-client'; +export { + ApiClientKeyContextType, + ApiClientKeyDeviceScope, + IApiClientKey, +} from './api-client-key'; +export { IApiKey } from './api-key'; +export { IApp } from './app'; +export { IAppProfile } from './app-profile'; +export { IAuthData } from './auth-data'; +export { ICredentials } from './credentials'; +export { IDevice } from './device'; +export { EntityType } from './entity-type'; +export { IEnvConfig } from './env-config'; +export { IBoundaries as IPropertyBoundaries, IProperty } from './property'; +export { PropertyType } from './property-type'; +export { PublishType } from './publish-type'; +export { IUser, IUserCredentials } from './user'; diff --git a/src/entities/property-type.ts b/src/entities/property-type.ts new file mode 100644 index 0000000..f7f5580 --- /dev/null +++ b/src/entities/property-type.ts @@ -0,0 +1,8 @@ +export enum PropertyType { + Boolean = 'boolean', + Enum = 'enum', + Number = 'number', + Object = 'object', + String = 'string', + Waypoint = 'waypoint', +} diff --git a/src/entities/property.ts b/src/entities/property.ts new file mode 100644 index 0000000..da63ab3 --- /dev/null +++ b/src/entities/property.ts @@ -0,0 +1,29 @@ +import { AccessType } from './access-type'; +import { IBaseEntity } from './base'; +import { PropertyType } from './property-type'; +import { PublishType } from './publish-type'; + +export interface IMeasurement { + type: string; + unit: { + label: string; + symbol: string; + }; +} + +export interface IBoundaries { + min?: number; + max?: number; +} + +export interface IProperty extends IBaseEntity { + readonly accountId: string; + readonly ownerId: string; + friendlyName: string; + qualifiedName: string; + access: AccessType; + type: PropertyType; + publish: PublishType; + measurement?: IMeasurement; + boundaries?: IBoundaries; +} diff --git a/src/entities/publish-type.ts b/src/entities/publish-type.ts new file mode 100644 index 0000000..6c4e6ab --- /dev/null +++ b/src/entities/publish-type.ts @@ -0,0 +1,3 @@ +export enum PublishType { + Changed = 'changed', +} diff --git a/src/entities/user.ts b/src/entities/user.ts new file mode 100644 index 0000000..3861f60 --- /dev/null +++ b/src/entities/user.ts @@ -0,0 +1,10 @@ +import { IBaseEntity } from './base'; + +export interface IUser extends IBaseEntity { + accountId: string; +} + +export interface IUserCredentials { + email: string; + password: string; +} diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..bcfabb2 --- /dev/null +++ b/src/index.ts @@ -0,0 +1,7 @@ +export { ApiClients, IApiClients } from './api-clients'; +export { AppProfiles, IAppProfiles } from './app-profiles'; +export { Apps, IApps } from './apps'; +export { Auth, IAuth } from './auth'; +export { ICredentialsStore } from './credentials'; +export { Devices, IDevices } from './devices'; +export { RestClient } from './rest-client'; diff --git a/src/instance.ts b/src/instance.ts new file mode 100644 index 0000000..578643b --- /dev/null +++ b/src/instance.ts @@ -0,0 +1,74 @@ +import { ApiClients, IApiClients } from './api-clients'; +import { AppProfiles, IAppProfiles } from './app-profiles'; +import { Apps, IApps } from './apps'; +import { Auth, IAuth } from './auth'; +import { CredentialsStore, ICredentialsStore } from './credentials'; +import { Devices, IDevices } from './devices'; +import { IEnvConfig } from './entities'; +import { IProperties, Properties } from './properties'; +import { IRestClient, RestClient } from './rest-client'; + +export interface IPlatform { + env: IEnvConfig; + restClient: IRestClient; + auth: IAuth; + credentialsStore: ICredentialsStore; + properties: IProperties; + devices: IDevices; + apps: IApps; + appProfiles: IAppProfiles; + apiClients: IApiClients; +} + +let platform: IPlatform; + +export async function bootstrap(env: IEnvConfig): Promise { + console.log('@platform :: bootstrap :: env', env); + + let credentialsStore = new CredentialsStore(); + let restClient = new RestClient({ + baseUrl: env.API_URL, + credentialsStore, + }); + + platform = { + env, + restClient, + auth: new Auth({ + client: new RestClient({ + baseUrl: env.API_AUTH_URL, + credentialsStore: new CredentialsStore(), + }), + }), + credentialsStore, + properties: new Properties({ + client: restClient, + }), + devices: new Devices({ + client: restClient, + }), + apps: new Apps({ + client: restClient, + }), + appProfiles: new AppProfiles({ + client: restClient, + }), + apiClients: new ApiClients({ + client: restClient, + }), + }; + + return platform; +} + +export default function Platform(): IPlatform { + console.log('@platform :: Platform'); + + if (!platform) { + console.log('@platform :: Not initialized'); + + throw new Error('Platform not initialized'); + } + + return platform; +} diff --git a/src/properties/index.ts b/src/properties/index.ts new file mode 100644 index 0000000..49e10f5 --- /dev/null +++ b/src/properties/index.ts @@ -0,0 +1 @@ +export { IProperties, Properties } from './properties'; diff --git a/src/properties/properties.ts b/src/properties/properties.ts new file mode 100644 index 0000000..9fa1928 --- /dev/null +++ b/src/properties/properties.ts @@ -0,0 +1,41 @@ +import { + AbstractEntityApi, + IAbstractEntityApi, + IAbstractEntityOptions, +} from '../abstract-entity-api'; +import { IProperty } from '../entities'; +import { IDeleteResponse } from '../rest-client'; + +export interface IProperties extends IAbstractEntityApi { + makeQualifiedName(propertyName: string, profileName: string): string; +} +export interface IPropertiesOptions extends IAbstractEntityOptions {} + +export class Properties + extends AbstractEntityApi + implements IProperties { + private readonly QUALIFIED_NAME_SEPARATOR = '$'; + + protected BASE_URL = '/properties'; + + constructor(options: IPropertiesOptions) { + super(options); + } + + public async list({ ownerId }: { ownerId: string }): Promise { + console.log('_Properties :: list'); + + return await super.list({ ownerId }); + } + + /** + * @param id Property’s id + */ + public async delete(id: string): Promise { + return await super.delete(id); + } + + public makeQualifiedName(propertyName: string, profileName: string): string { + return `${profileName}${this.QUALIFIED_NAME_SEPARATOR}${propertyName}`; + } +} diff --git a/src/rest-client/definitions.ts b/src/rest-client/definitions.ts new file mode 100644 index 0000000..b2fd042 --- /dev/null +++ b/src/rest-client/definitions.ts @@ -0,0 +1,44 @@ +export interface IRequestHeaders extends Headers {} + +export interface ICustomHeaderds { + [header: string]: string; +} + +export interface IRequestConfig extends RequestInit { + method: RequestMethod; + headers: IRequestHeaders; +} + +export enum RequestMethod { + Delete = 'DELETE', + Get = 'GET', + Post = 'POST', + Put = 'PUT', +} + +export enum ContentType { + Json = 'application/json', + Text = 'text/plain', +} + +export enum RequestHeader { + ContentType = 'Content-Type', + Authorization = 'Authorization', +} + +export interface IPaginatedResponse { + itemCount: number; + numOfPages: number; + pageNo: number; + skip: number; + total: number; + results: T[]; +} + +export interface IDeleteResponse { + nrOfItems: number; +} + +export interface IQueryParams { + [key: string]: string | number; +} diff --git a/src/rest-client/index.ts b/src/rest-client/index.ts new file mode 100644 index 0000000..bfe40f0 --- /dev/null +++ b/src/rest-client/index.ts @@ -0,0 +1,6 @@ +export { + IDeleteResponse, + IPaginatedResponse, + IQueryParams, +} from './definitions'; +export { IRestClient, RestClient } from './rest-client'; diff --git a/src/rest-client/rest-client.ts b/src/rest-client/rest-client.ts new file mode 100644 index 0000000..8e5ccfe --- /dev/null +++ b/src/rest-client/rest-client.ts @@ -0,0 +1,161 @@ +import { Base64, TBase64String } from '../base-64'; +import { ICredentialsStore } from '../credentials'; +import { ICredentials } from '../entities'; +import { + ContentType, + ICustomHeaderds, + IQueryParams, + IRequestConfig, + RequestHeader, + RequestMethod, +} from './definitions'; + +export interface IRestClient { + get(url: string, queryParams?: IQueryParams): Promise; + post(url: string, payload: TPostRequestPayload): Promise; + delete(url: string): Promise; + put(url: string, payload: TPutRequestPayload): Promise; +} + +interface IRestClientOptions { + baseUrl: string; + credentialsStore: ICredentialsStore; + headers?: ICustomHeaderds; +} + +type TPostRequestPayload = Record; +type TPutRequestPayload = Record; + +export class RestClient implements IRestClient { + private readonly _baseUrl: string; + private readonly _credentialsStore: ICredentialsStore; + private readonly _customHeaders: ICustomHeaderds = {}; + + constructor({ baseUrl, credentialsStore, headers }: IRestClientOptions) { + this._baseUrl = baseUrl; + this._credentialsStore = credentialsStore; + this._customHeaders = headers || {}; + } + + private _makeRequestConfig(method: RequestMethod): IRequestConfig { + let headers = new Headers({ + [RequestHeader.ContentType]: ContentType.Json, + ...this._customHeaders, + }); + + if ( + !this._credentialsStore.isEmpty && + !this._customHeaders[RequestHeader.Authorization] + ) { + let credentials = this._credentialsStore.get(); + let authHeader = this._makeAuthorizationHeader(credentials); + + headers.append(RequestHeader.Authorization, authHeader); + } + + return { + method, + headers, + }; + } + + private _makeGetRequestConfig(): IRequestConfig { + return this._makeRequestConfig(RequestMethod.Get); + } + + private _makePostRequestConfig(): IRequestConfig { + return this._makeRequestConfig(RequestMethod.Post); + } + + private _makeAuthorizationHeader(credentials: ICredentials): TBase64String { + let token = Base64.to(`${credentials.username}:${credentials.password}`); + + return `Basic ${token}`; + } + + private _makeUrlWithQueryString( + url: string = '', + queryParams?: IQueryParams, + ): string { + let queryString = ''; + + if (queryParams) { + let queryParamList = Object.entries(queryParams).map(([key, value]) => { + return `${key}=${value}`; + }); + + queryString = `?${queryParamList.join('&')}`; + } + + return `${url}${queryString}`; + } + + private _addBodyToRequestConfig>( + body: T, + baseConfig: IRequestConfig, + ): IRequestConfig { + return { + ...baseConfig, + body: JSON.stringify(body), + }; + } + + private async _request(url: string, config: IRequestConfig): Promise { + try { + let response; + let rawResponse = await fetch(`${this._baseUrl}${url}`, config); + + if (!rawResponse.ok) { + throw rawResponse; + } + + let contentType = rawResponse.headers.get(RequestHeader.ContentType); + + if (contentType?.includes(ContentType.Text)) { + response = await rawResponse.text(); + } else { + response = await rawResponse.json(); + } + + return response; + } catch (error) { + throw error; + } + } + + public async post(url: string, payload: TPostRequestPayload): Promise { + return await this._request( + url, + this._addBodyToRequestConfig( + payload, + this._makePostRequestConfig(), + ), + ); + } + + public async get(url: string, queryParams?: IQueryParams): Promise { + let urlWithQueryString = this._makeUrlWithQueryString(url, queryParams); + + return await this._request( + urlWithQueryString, + this._makeGetRequestConfig(), + ); + } + + public async delete(url: string): Promise { + return await this._request( + url, + this._makeRequestConfig(RequestMethod.Delete), + ); + } + + public async put(url: string, payload: TPutRequestPayload): Promise { + return await this._request( + url, + this._addBodyToRequestConfig( + payload, + this._makeRequestConfig(RequestMethod.Put), + ), + ); + } +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..1c359d2 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "outDir": "dist/", + "target": "ES5", + "moduleResolution": "node", + "module": "ESNext", + "lib": ["ESNext", "DOM"], + "sourceMap": true, + "skipLibCheck": true, + "esModuleInterop": true, + "noImplicitAny": true, + "strict": true, + "forceConsistentCasingInFileNames": true, + "incremental": true, + "baseUrl": "./", + "paths": { + "@/*": ["src/*"] + } + }, + "include": ["src/**/*"] +}