@xylabs/sdk-js 2.3.2 → 2.3.6

package/README.md

@@ -1,7 +1,9 @@
 [![logo][]](https://xylabs.com)
 
-# sdk-xyo-js
+# @xylabs/sdk-js
 
+[![main-build][]][main-build-link]
+[![beta-build][]][beta-build-link]
 [![npm-badge][]][npm-link]
 [![bch-badge][]][bch-link]
 [![codacy-badge][]][codacy-link]
@@ -10,12 +12,12 @@
 
 ## Table of Contents
 
--   [Title](#sdk-xyo-js)
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
+- [Description](#description)
+- [Install](#install)
+- [Scripts](#scripts)
+- [Maintainers](#maintainers)
+- [License](#license)
+- [Credits](#credits)
 
 ## Description
 
@@ -35,9 +37,35 @@ Using yarn:
 $ yarn add @xylabs/sdk-js
 ```
 
+## Scripts
+
+### Build
+Builds the project as if it will be deployed
+```
+yarn build
+```
+
+### Start
+Starts the project in the browser for testing, with auto reload
+```
+yarn start
+```
+
+### Lint
+Runs the linter (eslint) for the project
+```
+yarn lint
+```
+
+### Dependencies
+Shows a dependency report for the project
+```
+yarn deps
+```
+
 ## Maintainers
 
--   [Arie Trouw](https://github.com/arietrouw) (https://arietrouw.com)
+- [Arie Trouw](https://github.com/arietrouw) (https://arietrouw.com)
 
 ## License
 
@@ -45,14 +73,20 @@ See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-Made with 🔥and ❄️ by [XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-main.yml
+
+[beta-build]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml/badge.svg
+[beta-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build-beta.yml
+
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/sdk-js.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/sdk-js
 
-[bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-js?branch=master
+[bch-badge]: https://bettercodehub.com/edge/badge/xylabs/sdk-js?branch=main
 [bch-link]: https://bettercodehub.com/results/xylabs/sdk-js
 
 [codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698

package/package.json

@@ -26,7 +26,8 @@
     "typescript",
     "esm"
   ],
-  "version": "2.3.2",
+  "version": "2.3.6",
+  "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/index.cjs

@@ -1,176 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var tslib = require('tslib');
-var axios = require('axios');
-var Rollbar = require('rollbar');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
-var Rollbar__default = /*#__PURE__*/_interopDefaultLegacy(Rollbar);
-
-var ApiStage;
-(function (ApiStage) {
-    ApiStage["Beta"] = "beta";
-    ApiStage["Local"] = "local";
-    ApiStage["Prod"] = "prod";
-})(ApiStage || (ApiStage = {}));
-var ApiStage$1 = ApiStage;
-
-class ApiClient {
-    constructor(token, stage) {
-        this.stage = stage !== null && stage !== void 0 ? stage : ApiStage$1.Prod;
-        this.token = token;
-    }
-}
-
-class ApiEndpoint {
-    constructor(config, path) {
-        this.config = config;
-        this.path = path;
-    }
-    get headers() {
-        return this.config.token ? { Authorization: this.config.token } : undefined;
-    }
-    get url() {
-        return `${this.config.apiDomain}/${this.path}`;
-    }
-    get value() {
-        return this._value;
-    }
-    get() {
-        var _a;
-        return tslib.__awaiter(this, void 0, void 0, function* () {
-            return (_a = this._value) !== null && _a !== void 0 ? _a : (yield this.fetch());
-        });
-    }
-    fetch() {
-        return tslib.__awaiter(this, void 0, void 0, function* () {
-            const response = yield axios__default["default"].get(this.url, { headers: this.headers });
-            if (response.status === 200) {
-                this._value = response.data;
-            }
-            else {
-                throw Error('Unexpected Status Code');
-            }
-            return this._value;
-        });
-    }
-    insert(value) {
-        return tslib.__awaiter(this, void 0, void 0, function* () {
-            const response = yield axios__default["default"].post(this.url, value, { headers: this.headers });
-            if (response.status === 200) {
-                this._value = response.data;
-            }
-            else {
-                throw Error('Unexpected Status Code');
-            }
-            return this._value;
-        });
-    }
-}
-
-/**
- * Error object thrown by assertEx
- */
-class AssertExError extends Error {
-}
-/**
- *
- * Intended for simple null/undefiend checks for variables
- *
- * @param expr - Expression to be evaluated for truthiness
- * @param message - Message in Error if expression is false
- * @throws AssertExError
- * @returns Value of expression
- */
-const assertEx = (expr, message) => {
-    if (expr)
-        return expr;
-    throw new AssertExError(message);
-};
-
-const delay = (ms) => {
-    return new Promise((resolve) => setTimeout(resolve, ms));
-};
-
-const getApiStage = (hostname) => {
-    if (hostname.startsWith('localhost')) {
-        return ApiStage$1.Local;
-    }
-    else if (hostname.startsWith('beta.')) {
-        return ApiStage$1.Beta;
-    }
-    else {
-        return ApiStage$1.Prod;
-    }
-};
-
-class Log {
-    constructor(config) {
-        var _a;
-        this.devMode = (_a = config.devMode) !== null && _a !== void 0 ? _a : false;
-        if (config.rollbarToken) {
-            this.rollbar = new Rollbar__default["default"]({
-                accessToken: config.rollbarToken,
-                captureUncaught: true,
-                captureUnhandledRejections: true,
-                codeVersion: config.commitHash,
-                code_version: config.commitHash,
-                payload: Object.assign({ client: {
-                        javascript: {
-                            code_version: config.commitHash,
-                            guess_uncaught_frames: true,
-                            source_map_enabled: true,
-                        },
-                    }, codeVersion: config.commitHash, code_version: config.commitHash, environment: this.devMode ? 'development' : 'production' }, config.payload),
-                sendConfig: true,
-            });
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    error(...params) {
-        var _a;
-        console.error(params);
-        if (this.devMode) {
-            (_a = this.rollbar) === null || _a === void 0 ? void 0 : _a.error(params);
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    warn(...params) {
-        var _a;
-        console.warn(params);
-        if (this.devMode) {
-            (_a = this.rollbar) === null || _a === void 0 ? void 0 : _a.warn(params);
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    info(...params) {
-        if (this.devMode) {
-            console.info(params);
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    debug(...params) {
-        if (this.devMode) {
-            console.debug(params);
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    log(...params) {
-        if (this.devMode) {
-            console.log(params);
-        }
-    }
-}
-
-exports.ApiClient = ApiClient;
-exports.ApiEndpoint = ApiEndpoint;
-exports.ApiStage = ApiStage$1;
-exports.Log = Log;
-exports.assertEx = assertEx;
-exports.delay = delay;
-exports.getApiStage = getApiStage;
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","sources":["../../src/ApiStage.ts","../../src/ApiClient.ts","../../src/ApiEndpoint.ts","../../src/assertEx.ts","../../src/delay.ts","../../src/getApiStage.ts","../../src/Log.ts"],"sourcesContent":[null,null,null,null,null,null,null],"names":["ApiStage","axios","Rollbar"],"mappings":";;;;;;;;;;;;;AAAA,IAAK,QAIJ;AAJD,WAAK,QAAQ;IACX,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,yBAAa,CAAA;AACf,CAAC,EAJI,QAAQ,KAAR,QAAQ,QAIZ;AAED,iBAAe,QAAQ;;ACJvB,MAAe,SAAS;IACtB,YAAmB,KAAqB,EAAE,KAAgB;QACxD,IAAI,CAAC,KAAK,GAAG,KAAK,aAAL,KAAK,cAAL,KAAK,GAAIA,UAAQ,CAAC,IAAI,CAAA;QACnC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;KACnB;;;ACFH,MAAM,WAAW;IAIf,YAAY,MAAyB,EAAE,IAAY;QACjD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;KACjB;IAED,IAAY,OAAO;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,EAAE,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,SAAS,CAAA;KAC5E;IAED,IAAY,GAAG;QACb,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE,CAAA;KAC/C;IAID,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;IAEY,GAAG;;;YACd,OAAO,MAAA,IAAI,CAAC,MAAM,oCAAK,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC,CAAA;;KAC3C;IAEY,KAAK;;YAChB,MAAM,QAAQ,GAAG,MAAMC,yBAAK,CAAC,GAAG,CAAI,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YACxE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;gBAC3B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAA;aAC5B;iBAAM;gBACL,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAA;aACtC;YACD,OAAO,IAAI,CAAC,MAAM,CAAA;SACnB;KAAA;IAEY,MAAM,CAAC,KAAQ;;YAC1B,MAAM,QAAQ,GAAG,MAAMA,yBAAK,CAAC,IAAI,CAAI,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;YAChF,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;gBAC3B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAA;aAC5B;iBAAM;gBACL,MAAM,KAAK,CAAC,wBAAwB,CAAC,CAAA;aACtC;YACD,OAAO,IAAI,CAAC,MAAM,CAAA;SACnB;KAAA;;;ACjDH;;;AAGA,MAAM,aAAc,SAAQ,KAAK;CAAG;AAEpC;;;;;;;;;MASM,QAAQ,GAAG,CAAI,IAAe,EAAE,OAAgB;IACpD,IAAI,IAAI;QAAE,OAAO,IAAI,CAAA;IACrB,MAAM,IAAI,aAAa,CAAC,OAAO,CAAC,CAAA;AAClC;;MCjBM,KAAK,GAAG,CAAC,EAAU;IACvB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,KAAK,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;AAC1D;;MCAM,WAAW,GAAG,CAAC,QAAgB;IACnC,IAAI,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE;QACpC,OAAOD,UAAQ,CAAC,KAAK,CAAA;KACtB;SAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;QACvC,OAAOA,UAAQ,CAAC,IAAI,CAAA;KACrB;SAAM;QACL,OAAOA,UAAQ,CAAC,IAAI,CAAA;KACrB;AACH;;ACDA,MAAM,GAAG;IAIP,YAAY,MAAiB;;QAC3B,IAAI,CAAC,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,KAAK,CAAA;QAEtC,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,IAAI,CAAC,OAAO,GAAG,IAAIE,2BAAO,CAAC;gBACzB,WAAW,EAAE,MAAM,CAAC,YAAY;gBAChC,eAAe,EAAE,IAAI;gBACrB,0BAA0B,EAAE,IAAI;gBAChC,WAAW,EAAE,MAAM,CAAC,UAAU;gBAC9B,YAAY,EAAE,MAAM,CAAC,UAAU;gBAC/B,OAAO,kBACL,MAAM,EAAE;wBACN,UAAU,EAAE;4BACV,YAAY,EAAE,MAAM,CAAC,UAAU;4BAC/B,qBAAqB,EAAE,IAAI;4BAC3B,kBAAkB,EAAE,IAAI;yBACzB;qBACF,EACD,WAAW,EAAE,MAAM,CAAC,UAAU,EAC9B,YAAY,EAAE,MAAM,CAAC,UAAU,EAC/B,WAAW,EAAE,IAAI,CAAC,OAAO,GAAG,aAAa,GAAG,YAAY,IACrD,MAAM,CAAC,OAAO,CAClB;gBACD,UAAU,EAAE,IAAI;aACjB,CAAC,CAAA;SACH;KACF;;IAGM,KAAK,CAAC,GAAG,MAAa;;QAC3B,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QACrB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAA,IAAI,CAAC,OAAO,0CAAE,KAAK,CAAC,MAAM,CAAC,CAAA;SAC5B;KACF;;IAGM,IAAI,CAAC,GAAG,MAAa;;QAC1B,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACpB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,MAAA,IAAI,CAAC,OAAO,0CAAE,IAAI,CAAC,MAAM,CAAC,CAAA;SAC3B;KACF;;IAGM,IAAI,CAAC,GAAG,MAAa;QAC1B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;SACrB;KACF;;IAGM,KAAK,CAAC,GAAG,MAAa;QAC3B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;SACtB;KACF;;IAGM,GAAG,CAAC,GAAG,MAAa;QACzB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;SACpB;KACF;;;;;;;;;;;"}