kitsas-library 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +20 -0
- package/lib/main/index.d.ts +2 -0
- package/lib/main/index.js +15 -0
- package/lib/main/services/index.d.ts +2 -0
- package/lib/main/services/index.js +8 -0
- package/lib/main/services/kitsasconnection.d.ts +14 -0
- package/lib/main/services/kitsasconnection.js +31 -0
- package/lib/main/services/kitsasservice.d.ts +15 -0
- package/lib/main/services/kitsasservice.js +73 -0
- package/lib/main/services/sample-service.d.ts +35 -0
- package/lib/main/services/sample-service.js +41 -0
- package/lib/main/types/authresponse.d.ts +9 -0
- package/lib/main/types/authresponse.js +19 -0
- package/lib/main/types/index.d.ts +1 -0
- package/lib/main/types/index.js +6 -0
- package/lib/main/types/kitsasconnectionoptions.d.ts +18 -0
- package/lib/main/types/kitsasconnectionoptions.js +25 -0
- package/lib/main/types/kitsasexeptions.d.ts +6 -0
- package/lib/main/types/kitsasexeptions.js +16 -0
- package/lib/main/types/sample-interface.d.ts +10 -0
- package/lib/main/types/sample-interface.js +3 -0
- package/lib/module/index.d.ts +2 -0
- package/lib/module/index.js +3 -0
- package/lib/module/services/index.d.ts +2 -0
- package/lib/module/services/index.js +3 -0
- package/lib/module/services/kitsasconnection.d.ts +14 -0
- package/lib/module/services/kitsasconnection.js +30 -0
- package/lib/module/services/kitsasservice.d.ts +15 -0
- package/lib/module/services/kitsasservice.js +50 -0
- package/lib/module/services/sample-service.d.ts +35 -0
- package/lib/module/services/sample-service.js +37 -0
- package/lib/module/types/authresponse.d.ts +9 -0
- package/lib/module/types/authresponse.js +10 -0
- package/lib/module/types/index.d.ts +1 -0
- package/lib/module/types/index.js +2 -0
- package/lib/module/types/kitsasconnectionoptions.d.ts +18 -0
- package/lib/module/types/kitsasconnectionoptions.js +19 -0
- package/lib/module/types/kitsasexeptions.d.ts +6 -0
- package/lib/module/types/kitsasexeptions.js +11 -0
- package/lib/module/types/sample-interface.d.ts +10 -0
- package/lib/module/types/sample-interface.js +2 -0
- package/package.json +92 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Kitsas Oy
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Kitsas Library
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Installation
|
|
5
|
+
```bash
|
|
6
|
+
npm install kitsas-library
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
### Login to Kitsas
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { KitsasService } from './kitsasservice';
|
|
15
|
+
|
|
16
|
+
const connection = await KitsasService.connect({
|
|
17
|
+
email: 'name@kitsas.fi',
|
|
18
|
+
password: 'secret'
|
|
19
|
+
})
|
|
20
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
|
|
5
|
+
}) : (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
o[k2] = m[k];
|
|
8
|
+
}));
|
|
9
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
10
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
11
|
+
};
|
|
12
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
+
__exportStar(require("./types"), exports);
|
|
14
|
+
__exportStar(require("./services"), exports);
|
|
15
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7O0FBQUEsMENBQXdCO0FBQ3hCLDZDQUEyQiJ9
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.KitsasConnection = exports.KitsasService = void 0;
|
|
4
|
+
var kitsasservice_1 = require("./kitsasservice");
|
|
5
|
+
Object.defineProperty(exports, "KitsasService", { enumerable: true, get: function () { return kitsasservice_1.KitsasService; } });
|
|
6
|
+
var kitsasconnection_1 = require("./kitsasconnection");
|
|
7
|
+
Object.defineProperty(exports, "KitsasConnection", { enumerable: true, get: function () { return kitsasconnection_1.KitsasConnection; } });
|
|
8
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvc2VydmljZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsaURBQWdEO0FBQXZDLDhHQUFBLGFBQWEsT0FBQTtBQUN0Qix1REFBc0Q7QUFBN0Msb0hBQUEsZ0JBQWdCLE9BQUEifQ==
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { ApisauceInstance } from 'apisauce';
|
|
2
|
+
import { AuthResponse } from '../types/authresponse';
|
|
3
|
+
export declare class KitsasConnection {
|
|
4
|
+
constructor(baseapi: string, agent: string, response: AuthResponse);
|
|
5
|
+
/**
|
|
6
|
+
* Get current user's name
|
|
7
|
+
* @returns User's name
|
|
8
|
+
*/
|
|
9
|
+
getName(): string;
|
|
10
|
+
getApi(): ApisauceInstance;
|
|
11
|
+
private token;
|
|
12
|
+
private name;
|
|
13
|
+
private api;
|
|
14
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.KitsasConnection = void 0;
|
|
4
|
+
const apisauce_1 = require("apisauce");
|
|
5
|
+
class KitsasConnection {
|
|
6
|
+
constructor(baseapi, agent, response) {
|
|
7
|
+
// this.baseapi = baseapi;
|
|
8
|
+
// this.agent = agent;
|
|
9
|
+
this.token = response.access_token;
|
|
10
|
+
this.name = response.name;
|
|
11
|
+
this.api = (0, apisauce_1.create)({
|
|
12
|
+
baseURL: baseapi,
|
|
13
|
+
headers: {
|
|
14
|
+
'User-Agent': agent,
|
|
15
|
+
Authorization: 'Bearer ' + this.token
|
|
16
|
+
}
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Get current user's name
|
|
21
|
+
* @returns User's name
|
|
22
|
+
*/
|
|
23
|
+
getName() {
|
|
24
|
+
return this.name;
|
|
25
|
+
}
|
|
26
|
+
getApi() {
|
|
27
|
+
return this.api;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
exports.KitsasConnection = KitsasConnection;
|
|
31
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoia2l0c2FzY29ubmVjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zZXJ2aWNlcy9raXRzYXNjb25uZWN0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHVDQUFvRDtBQUlwRCxNQUFhLGdCQUFnQjtJQUMzQixZQUFZLE9BQWUsRUFBRSxLQUFhLEVBQUUsUUFBc0I7UUFDaEUsNkJBQTZCO1FBQzdCLHlCQUF5QjtRQUN6QixJQUFJLENBQUMsS0FBSyxHQUFHLFFBQVEsQ0FBQyxZQUFZLENBQUM7UUFDbkMsSUFBSSxDQUFDLElBQUksR0FBRyxRQUFRLENBQUMsSUFBSSxDQUFDO1FBQzFCLElBQUksQ0FBQyxHQUFHLEdBQUcsSUFBQSxpQkFBTSxFQUFDO1lBQ2hCLE9BQU8sRUFBRSxPQUFPO1lBQ2hCLE9BQU8sRUFBRTtnQkFDUCxZQUFZLEVBQUUsS0FBSztnQkFDbkIsYUFBYSxFQUFFLFNBQVMsR0FBRyxJQUFJLENBQUMsS0FBSzthQUN0QztTQUNGLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRDs7O09BR0c7SUFDSCxPQUFPO1FBQ0wsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDO0lBQ25CLENBQUM7SUFFRCxNQUFNO1FBQ0osT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDO0lBQ2xCLENBQUM7Q0FNRjtBQS9CRCw0Q0ErQkMifQ==
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { KitsasConnectionOptions } from '../types/kitsasconnectionoptions';
|
|
2
|
+
import { KitsasConnection } from './kitsasconnection';
|
|
3
|
+
export declare class KitsasService {
|
|
4
|
+
private constructor();
|
|
5
|
+
/**
|
|
6
|
+
* Connect to Kitsas
|
|
7
|
+
* @param options Login and connection options
|
|
8
|
+
* @returns Connection object
|
|
9
|
+
* @throws InvalidCreditentialsError if creditentials are invalid
|
|
10
|
+
* @throws TFARequiredError if 2FA is required
|
|
11
|
+
* @throws Error if network or server errors occurs
|
|
12
|
+
*
|
|
13
|
+
*/
|
|
14
|
+
static connect(options: KitsasConnectionOptions): Promise<KitsasConnection>;
|
|
15
|
+
}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
|
|
5
|
+
}) : (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
o[k2] = m[k];
|
|
8
|
+
}));
|
|
9
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
10
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
11
|
+
}) : function(o, v) {
|
|
12
|
+
o["default"] = v;
|
|
13
|
+
});
|
|
14
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
15
|
+
if (mod && mod.__esModule) return mod;
|
|
16
|
+
var result = {};
|
|
17
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
18
|
+
__setModuleDefault(result, mod);
|
|
19
|
+
return result;
|
|
20
|
+
};
|
|
21
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
22
|
+
exports.KitsasService = void 0;
|
|
23
|
+
const apisauce_1 = require("apisauce");
|
|
24
|
+
const Exceptions = __importStar(require("../types/kitsasexeptions"));
|
|
25
|
+
const kitsasconnection_1 = require("./kitsasconnection");
|
|
26
|
+
class KitsasService {
|
|
27
|
+
constructor() {
|
|
28
|
+
throw Error('KitsasService is a static class');
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Connect to Kitsas
|
|
32
|
+
* @param options Login and connection options
|
|
33
|
+
* @returns Connection object
|
|
34
|
+
* @throws InvalidCreditentialsError if creditentials are invalid
|
|
35
|
+
* @throws TFARequiredError if 2FA is required
|
|
36
|
+
* @throws Error if network or server errors occurs
|
|
37
|
+
*
|
|
38
|
+
*/
|
|
39
|
+
static async connect(options) {
|
|
40
|
+
const api = (0, apisauce_1.create)({
|
|
41
|
+
baseURL: options.url || process.env.KITSAS_URL || 'https://hub.kitsas.fi',
|
|
42
|
+
headers: {
|
|
43
|
+
'User-Agent': options.agent || process.env.KITSAS_AGENT || 'KitsasLibrary'
|
|
44
|
+
}
|
|
45
|
+
});
|
|
46
|
+
const payload = {
|
|
47
|
+
username: options.email || process.env.KITSAS_USERNAME,
|
|
48
|
+
password: options.password || process.env.KITSAS_PASSWORD
|
|
49
|
+
};
|
|
50
|
+
const response = await api.post('/v1/login', payload);
|
|
51
|
+
if (response.ok) {
|
|
52
|
+
const data = response.data;
|
|
53
|
+
return new kitsasconnection_1.KitsasConnection(api.getBaseURL(), options.agent || process.env.KITSAS_AGENT || 'KitsasLibrary', data);
|
|
54
|
+
}
|
|
55
|
+
else if (response.problem === 'CLIENT_ERROR') {
|
|
56
|
+
const error = response.data;
|
|
57
|
+
if (error.message === 'Invalid credentials') {
|
|
58
|
+
throw new Exceptions.InvalidCreditentialsError();
|
|
59
|
+
}
|
|
60
|
+
else if (error.message === '2FA required') {
|
|
61
|
+
throw new Exceptions.TFARequiredError();
|
|
62
|
+
}
|
|
63
|
+
else {
|
|
64
|
+
throw new Error(error.message);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
else {
|
|
68
|
+
throw new Error(response.problem);
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
exports.KitsasService = KitsasService;
|
|
73
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoia2l0c2Fzc2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zZXJ2aWNlcy9raXRzYXNzZXJ2aWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSx1Q0FBa0M7QUFJbEMscUVBQXVEO0FBRXZELHlEQUFzRDtBQUV0RCxNQUFhLGFBQWE7SUFDeEI7UUFDRSxNQUFNLEtBQUssQ0FBQyxpQ0FBaUMsQ0FBQyxDQUFDO0lBQ2pELENBQUM7SUFFRDs7Ozs7Ozs7T0FRRztJQUNILE1BQU0sQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUNsQixPQUFnQztRQUVoQyxNQUFNLEdBQUcsR0FBRyxJQUFBLGlCQUFNLEVBQUM7WUFDakIsT0FBTyxFQUFFLE9BQU8sQ0FBQyxHQUFHLElBQUksT0FBTyxDQUFDLEdBQUcsQ0FBQyxVQUFVLElBQUksdUJBQXVCO1lBQ3pFLE9BQU8sRUFBRTtnQkFDUCxZQUFZLEVBQ1YsT0FBTyxDQUFDLEtBQUssSUFBSSxPQUFPLENBQUMsR0FBRyxDQUFDLFlBQVksSUFBSSxlQUFlO2FBQy9EO1NBQ0YsQ0FBQyxDQUFDO1FBRUgsTUFBTSxPQUFPLEdBQUc7WUFDZCxRQUFRLEVBQUUsT0FBTyxDQUFDLEtBQUssSUFBSSxPQUFPLENBQUMsR0FBRyxDQUFDLGVBQWU7WUFDdEQsUUFBUSxFQUFFLE9BQU8sQ0FBQyxRQUFRLElBQUksT0FBTyxDQUFDLEdBQUcsQ0FBQyxlQUFlO1NBQzFELENBQUM7UUFFRixNQUFNLFFBQVEsR0FBRyxNQUFNLEdBQUcsQ0FBQyxJQUFJLENBQUMsV0FBVyxFQUFFLE9BQU8sQ0FBQyxDQUFDO1FBRXRELElBQUksUUFBUSxDQUFDLEVBQUUsRUFBRTtZQUNmLE1BQU0sSUFBSSxHQUFHLFFBQVEsQ0FBQyxJQUE4QixDQUFDO1lBRXJELE9BQU8sSUFBSSxtQ0FBZ0IsQ0FDekIsR0FBRyxDQUFDLFVBQVUsRUFBRSxFQUNoQixPQUFPLENBQUMsS0FBSyxJQUFJLE9BQU8sQ0FBQyxHQUFHLENBQUMsWUFBWSxJQUFJLGVBQWUsRUFDNUQsSUFBSSxDQUNMLENBQUM7U0FDSDthQUFNLElBQUksUUFBUSxDQUFDLE9BQU8sS0FBSyxjQUFjLEVBQUU7WUFDOUMsTUFBTSxLQUFLLEdBQUcsUUFBUSxDQUFDLElBQStCLENBQUM7WUFDdkQsSUFBSSxLQUFLLENBQUMsT0FBTyxLQUFLLHFCQUFxQixFQUFFO2dCQUMzQyxNQUFNLElBQUksVUFBVSxDQUFDLHlCQUF5QixFQUFFLENBQUM7YUFDbEQ7aUJBQU0sSUFBSSxLQUFLLENBQUMsT0FBTyxLQUFLLGNBQWMsRUFBRTtnQkFDM0MsTUFBTSxJQUFJLFVBQVUsQ0FBQyxnQkFBZ0IsRUFBRSxDQUFDO2FBQ3pDO2lCQUFNO2dCQUNMLE1BQU0sSUFBSSxLQUFLLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFDO2FBQ2hDO1NBQ0Y7YUFBTTtZQUNMLE1BQU0sSUFBSSxLQUFLLENBQUMsUUFBUSxDQUFDLE9BQU8sQ0FBQyxDQUFDO1NBQ25DO0lBQ0gsQ0FBQztDQUNGO0FBckRELHNDQXFEQyJ9
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { SampleInterface } from '../types';
|
|
2
|
+
export declare class SampleService {
|
|
3
|
+
/**
|
|
4
|
+
* Adds two numbers
|
|
5
|
+
*
|
|
6
|
+
* ### Example (es module)
|
|
7
|
+
* ```js
|
|
8
|
+
* import { SampleService } from 'typescript-library-template';
|
|
9
|
+
*
|
|
10
|
+
* async function add() {
|
|
11
|
+
* const sampleService = new SampleService();
|
|
12
|
+
* const res = await sampleService.sampleMethod({
|
|
13
|
+
* number1: 1,
|
|
14
|
+
* number2: 2,
|
|
15
|
+
* });
|
|
16
|
+
* console.log(res);
|
|
17
|
+
* }
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* ### Example (commonjs)
|
|
21
|
+
* ```js
|
|
22
|
+
* const { SampleService } = require('typescript-library-template');
|
|
23
|
+
*
|
|
24
|
+
* async function add() {
|
|
25
|
+
* const sampleService = new SampleService();
|
|
26
|
+
* const res = await sampleService.sampleMethod({
|
|
27
|
+
* number1: 1,
|
|
28
|
+
* number2: 2,
|
|
29
|
+
* });
|
|
30
|
+
* console.log(res);
|
|
31
|
+
* }
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
sampleMethod(numbers: SampleInterface): Promise<number>;
|
|
35
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SampleService = void 0;
|
|
4
|
+
class SampleService {
|
|
5
|
+
/**
|
|
6
|
+
* Adds two numbers
|
|
7
|
+
*
|
|
8
|
+
* ### Example (es module)
|
|
9
|
+
* ```js
|
|
10
|
+
* import { SampleService } from 'typescript-library-template';
|
|
11
|
+
*
|
|
12
|
+
* async function add() {
|
|
13
|
+
* const sampleService = new SampleService();
|
|
14
|
+
* const res = await sampleService.sampleMethod({
|
|
15
|
+
* number1: 1,
|
|
16
|
+
* number2: 2,
|
|
17
|
+
* });
|
|
18
|
+
* console.log(res);
|
|
19
|
+
* }
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* ### Example (commonjs)
|
|
23
|
+
* ```js
|
|
24
|
+
* const { SampleService } = require('typescript-library-template');
|
|
25
|
+
*
|
|
26
|
+
* async function add() {
|
|
27
|
+
* const sampleService = new SampleService();
|
|
28
|
+
* const res = await sampleService.sampleMethod({
|
|
29
|
+
* number1: 1,
|
|
30
|
+
* number2: 2,
|
|
31
|
+
* });
|
|
32
|
+
* console.log(res);
|
|
33
|
+
* }
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
async sampleMethod(numbers) {
|
|
37
|
+
return numbers.number1 + numbers.number2;
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
exports.SampleService = SampleService;
|
|
41
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2FtcGxlLXNlcnZpY2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvc2VydmljZXMvc2FtcGxlLXNlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBRUEsTUFBYSxhQUFhO0lBQ3hCOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7T0E4Qkc7SUFDSCxLQUFLLENBQUMsWUFBWSxDQUFDLE9BQXdCO1FBQ3pDLE9BQU8sT0FBTyxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUMsT0FBTyxDQUFDO0lBQzNDLENBQUM7Q0FDRjtBQW5DRCxzQ0FtQ0MifQ==
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ErrorResponse = exports.AuthResponse = void 0;
|
|
4
|
+
class AuthResponse {
|
|
5
|
+
constructor() {
|
|
6
|
+
this.access_token = '';
|
|
7
|
+
this.name = '';
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
exports.AuthResponse = AuthResponse;
|
|
11
|
+
class ErrorResponse {
|
|
12
|
+
constructor() {
|
|
13
|
+
this.message = '';
|
|
14
|
+
this.error = '';
|
|
15
|
+
this.statusCode = 0;
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
exports.ErrorResponse = ErrorResponse;
|
|
19
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXV0aHJlc3BvbnNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGVzL2F1dGhyZXNwb25zZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxNQUFhLFlBQVk7SUFBekI7UUFDRSxpQkFBWSxHQUFHLEVBQUUsQ0FBQztRQUNsQixTQUFJLEdBQUcsRUFBRSxDQUFDO0lBQ1osQ0FBQztDQUFBO0FBSEQsb0NBR0M7QUFFRCxNQUFhLGFBQWE7SUFBMUI7UUFDRSxZQUFPLEdBQUcsRUFBRSxDQUFDO1FBQ2IsVUFBSyxHQUFHLEVBQUUsQ0FBQztRQUNYLGVBQVUsR0FBRyxDQUFDLENBQUM7SUFDakIsQ0FBQztDQUFBO0FBSkQsc0NBSUMifQ==
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { KitsasConnectionOptions } from './kitsasconnectionoptions';
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.KitsasConnectionOptions = void 0;
|
|
4
|
+
var kitsasconnectionoptions_1 = require("./kitsasconnectionoptions");
|
|
5
|
+
Object.defineProperty(exports, "KitsasConnectionOptions", { enumerable: true, get: function () { return kitsasconnectionoptions_1.KitsasConnectionOptions; } });
|
|
6
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHlwZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEscUVBQW9FO0FBQTNELGtJQUFBLHVCQUF1QixPQUFBIn0=
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export declare class KitsasConnectionOptions {
|
|
2
|
+
/**
|
|
3
|
+
* Kitsas API Base URL
|
|
4
|
+
*/
|
|
5
|
+
url?: string | undefined;
|
|
6
|
+
/**
|
|
7
|
+
* User email to login
|
|
8
|
+
*/
|
|
9
|
+
email?: string | undefined;
|
|
10
|
+
/**
|
|
11
|
+
* User password to login
|
|
12
|
+
*/
|
|
13
|
+
password?: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* User agent to identify the client
|
|
16
|
+
*/
|
|
17
|
+
agent?: string | undefined;
|
|
18
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.KitsasConnectionOptions = void 0;
|
|
4
|
+
class KitsasConnectionOptions {
|
|
5
|
+
constructor() {
|
|
6
|
+
/**
|
|
7
|
+
* Kitsas API Base URL
|
|
8
|
+
*/
|
|
9
|
+
this.url = undefined;
|
|
10
|
+
/**
|
|
11
|
+
* User email to login
|
|
12
|
+
*/
|
|
13
|
+
this.email = undefined;
|
|
14
|
+
/**
|
|
15
|
+
* User password to login
|
|
16
|
+
*/
|
|
17
|
+
this.password = undefined;
|
|
18
|
+
/**
|
|
19
|
+
* User agent to identify the client
|
|
20
|
+
*/
|
|
21
|
+
this.agent = undefined;
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
exports.KitsasConnectionOptions = KitsasConnectionOptions;
|
|
25
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoia2l0c2FzY29ubmVjdGlvbm9wdGlvbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHlwZXMva2l0c2FzY29ubmVjdGlvbm9wdGlvbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsTUFBYSx1QkFBdUI7SUFBcEM7UUFDRTs7V0FFRztRQUNILFFBQUcsR0FBd0IsU0FBUyxDQUFDO1FBQ3JDOztXQUVHO1FBQ0gsVUFBSyxHQUF3QixTQUFTLENBQUM7UUFDdkM7O1dBRUc7UUFDSCxhQUFRLEdBQXdCLFNBQVMsQ0FBQztRQUMxQzs7V0FFRztRQUNILFVBQUssR0FBd0IsU0FBUyxDQUFDO0lBQ3pDLENBQUM7Q0FBQTtBQWpCRCwwREFpQkMifQ==
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.TFARequiredError = exports.InvalidCreditentialsError = void 0;
|
|
4
|
+
class InvalidCreditentialsError extends Error {
|
|
5
|
+
constructor() {
|
|
6
|
+
super('Invalid creditentials');
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
exports.InvalidCreditentialsError = InvalidCreditentialsError;
|
|
10
|
+
class TFARequiredError extends Error {
|
|
11
|
+
constructor() {
|
|
12
|
+
super('2FA required');
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
exports.TFARequiredError = TFARequiredError;
|
|
16
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoia2l0c2FzZXhlcHRpb25zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGVzL2tpdHNhc2V4ZXB0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxNQUFhLHlCQUEwQixTQUFRLEtBQUs7SUFDbEQ7UUFDRSxLQUFLLENBQUMsdUJBQXVCLENBQUMsQ0FBQztJQUNqQyxDQUFDO0NBQ0Y7QUFKRCw4REFJQztBQUVELE1BQWEsZ0JBQWlCLFNBQVEsS0FBSztJQUN6QztRQUNFLEtBQUssQ0FBQyxjQUFjLENBQUMsQ0FBQztJQUN4QixDQUFDO0NBQ0Y7QUFKRCw0Q0FJQyJ9
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2FtcGxlLWludGVyZmFjZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy90eXBlcy9zYW1wbGUtaW50ZXJmYWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export * from './types';
|
|
2
|
+
export * from './services';
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYyxTQUFTLENBQUM7QUFDeEIsY0FBYyxZQUFZLENBQUMifQ==
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
export { KitsasService } from './kitsasservice';
|
|
2
|
+
export { KitsasConnection } from './kitsasconnection';
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvc2VydmljZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLGFBQWEsRUFBRSxNQUFNLGlCQUFpQixDQUFDO0FBQ2hELE9BQU8sRUFBRSxnQkFBZ0IsRUFBRSxNQUFNLG9CQUFvQixDQUFDIn0=
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { ApisauceInstance } from 'apisauce';
|
|
2
|
+
import { AuthResponse } from '../types/authresponse';
|
|
3
|
+
export declare class KitsasConnection {
|
|
4
|
+
constructor(baseapi: string, agent: string, response: AuthResponse);
|
|
5
|
+
/**
|
|
6
|
+
* Get current user's name
|
|
7
|
+
* @returns User's name
|
|
8
|
+
*/
|
|
9
|
+
getName(): string;
|
|
10
|
+
getApi(): ApisauceInstance;
|
|
11
|
+
private token;
|
|
12
|
+
private name;
|
|
13
|
+
private api;
|
|
14
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { create } from 'apisauce';
|
|
2
|
+
export class KitsasConnection {
|
|
3
|
+
constructor(baseapi, agent, response) {
|
|
4
|
+
// this.baseapi = baseapi;
|
|
5
|
+
// this.agent = agent;
|
|
6
|
+
this.token = response.access_token;
|
|
7
|
+
this.name = response.name;
|
|
8
|
+
this.api = create({
|
|
9
|
+
baseURL: baseapi,
|
|
10
|
+
headers: {
|
|
11
|
+
'User-Agent': agent,
|
|
12
|
+
Authorization: 'Bearer ' + this.token
|
|
13
|
+
}
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Get current user's name
|
|
18
|
+
* @returns User's name
|
|
19
|
+
*/
|
|
20
|
+
getName() {
|
|
21
|
+
return this.name;
|
|
22
|
+
}
|
|
23
|
+
getApi() {
|
|
24
|
+
return this.api;
|
|
25
|
+
}
|
|
26
|
+
token;
|
|
27
|
+
name;
|
|
28
|
+
api;
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoia2l0c2FzY29ubmVjdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zZXJ2aWNlcy9raXRzYXNjb25uZWN0aW9uLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBb0IsTUFBTSxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBSXBELE1BQU0sT0FBTyxnQkFBZ0I7SUFDM0IsWUFBWSxPQUFlLEVBQUUsS0FBYSxFQUFFLFFBQXNCO1FBQ2hFLDZCQUE2QjtRQUM3Qix5QkFBeUI7UUFDekIsSUFBSSxDQUFDLEtBQUssR0FBRyxRQUFRLENBQUMsWUFBWSxDQUFDO1FBQ25DLElBQUksQ0FBQyxJQUFJLEdBQUcsUUFBUSxDQUFDLElBQUksQ0FBQztRQUMxQixJQUFJLENBQUMsR0FBRyxHQUFHLE1BQU0sQ0FBQztZQUNoQixPQUFPLEVBQUUsT0FBTztZQUNoQixPQUFPLEVBQUU7Z0JBQ1AsWUFBWSxFQUFFLEtBQUs7Z0JBQ25CLGFBQWEsRUFBRSxTQUFTLEdBQUcsSUFBSSxDQUFDLEtBQUs7YUFDdEM7U0FDRixDQUFDLENBQUM7SUFDTCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsT0FBTztRQUNMLE9BQU8sSUFBSSxDQUFDLElBQUksQ0FBQztJQUNuQixDQUFDO0lBRUQsTUFBTTtRQUNKLE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQztJQUNsQixDQUFDO0lBRU8sS0FBSyxDQUFTO0lBQ2QsSUFBSSxDQUFTO0lBRWIsR0FBRyxDQUFtQjtDQUMvQiJ9
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { KitsasConnectionOptions } from '../types/kitsasconnectionoptions';
|
|
2
|
+
import { KitsasConnection } from './kitsasconnection';
|
|
3
|
+
export declare class KitsasService {
|
|
4
|
+
private constructor();
|
|
5
|
+
/**
|
|
6
|
+
* Connect to Kitsas
|
|
7
|
+
* @param options Login and connection options
|
|
8
|
+
* @returns Connection object
|
|
9
|
+
* @throws InvalidCreditentialsError if creditentials are invalid
|
|
10
|
+
* @throws TFARequiredError if 2FA is required
|
|
11
|
+
* @throws Error if network or server errors occurs
|
|
12
|
+
*
|
|
13
|
+
*/
|
|
14
|
+
static connect(options: KitsasConnectionOptions): Promise<KitsasConnection>;
|
|
15
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { create } from 'apisauce';
|
|
2
|
+
import * as Exceptions from '../types/kitsasexeptions';
|
|
3
|
+
import { KitsasConnection } from './kitsasconnection';
|
|
4
|
+
export class KitsasService {
|
|
5
|
+
constructor() {
|
|
6
|
+
throw Error('KitsasService is a static class');
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Connect to Kitsas
|
|
10
|
+
* @param options Login and connection options
|
|
11
|
+
* @returns Connection object
|
|
12
|
+
* @throws InvalidCreditentialsError if creditentials are invalid
|
|
13
|
+
* @throws TFARequiredError if 2FA is required
|
|
14
|
+
* @throws Error if network or server errors occurs
|
|
15
|
+
*
|
|
16
|
+
*/
|
|
17
|
+
static async connect(options) {
|
|
18
|
+
const api = create({
|
|
19
|
+
baseURL: options.url || process.env.KITSAS_URL || 'https://hub.kitsas.fi',
|
|
20
|
+
headers: {
|
|
21
|
+
'User-Agent': options.agent || process.env.KITSAS_AGENT || 'KitsasLibrary'
|
|
22
|
+
}
|
|
23
|
+
});
|
|
24
|
+
const payload = {
|
|
25
|
+
username: options.email || process.env.KITSAS_USERNAME,
|
|
26
|
+
password: options.password || process.env.KITSAS_PASSWORD
|
|
27
|
+
};
|
|
28
|
+
const response = await api.post('/v1/login', payload);
|
|
29
|
+
if (response.ok) {
|
|
30
|
+
const data = response.data;
|
|
31
|
+
return new KitsasConnection(api.getBaseURL(), options.agent || process.env.KITSAS_AGENT || 'KitsasLibrary', data);
|
|
32
|
+
}
|
|
33
|
+
else if (response.problem === 'CLIENT_ERROR') {
|
|
34
|
+
const error = response.data;
|
|
35
|
+
if (error.message === 'Invalid credentials') {
|
|
36
|
+
throw new Exceptions.InvalidCreditentialsError();
|
|
37
|
+
}
|
|
38
|
+
else if (error.message === '2FA required') {
|
|
39
|
+
throw new Exceptions.TFARequiredError();
|
|
40
|
+
}
|
|
41
|
+
else {
|
|
42
|
+
throw new Error(error.message);
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
else {
|
|
46
|
+
throw new Error(response.problem);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoia2l0c2Fzc2VydmljZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9zZXJ2aWNlcy9raXRzYXNzZXJ2aWNlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sRUFBRSxNQUFNLEVBQUUsTUFBTSxVQUFVLENBQUM7QUFJbEMsT0FBTyxLQUFLLFVBQVUsTUFBTSwwQkFBMEIsQ0FBQztBQUV2RCxPQUFPLEVBQUUsZ0JBQWdCLEVBQUUsTUFBTSxvQkFBb0IsQ0FBQztBQUV0RCxNQUFNLE9BQU8sYUFBYTtJQUN4QjtRQUNFLE1BQU0sS0FBSyxDQUFDLGlDQUFpQyxDQUFDLENBQUM7SUFDakQsQ0FBQztJQUVEOzs7Ozs7OztPQVFHO0lBQ0gsTUFBTSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQ2xCLE9BQWdDO1FBRWhDLE1BQU0sR0FBRyxHQUFHLE1BQU0sQ0FBQztZQUNqQixPQUFPLEVBQUUsT0FBTyxDQUFDLEdBQUcsSUFBSSxPQUFPLENBQUMsR0FBRyxDQUFDLFVBQVUsSUFBSSx1QkFBdUI7WUFDekUsT0FBTyxFQUFFO2dCQUNQLFlBQVksRUFDVixPQUFPLENBQUMsS0FBSyxJQUFJLE9BQU8sQ0FBQyxHQUFHLENBQUMsWUFBWSxJQUFJLGVBQWU7YUFDL0Q7U0FDRixDQUFDLENBQUM7UUFFSCxNQUFNLE9BQU8sR0FBRztZQUNkLFFBQVEsRUFBRSxPQUFPLENBQUMsS0FBSyxJQUFJLE9BQU8sQ0FBQyxHQUFHLENBQUMsZUFBZTtZQUN0RCxRQUFRLEVBQUUsT0FBTyxDQUFDLFFBQVEsSUFBSSxPQUFPLENBQUMsR0FBRyxDQUFDLGVBQWU7U0FDMUQsQ0FBQztRQUVGLE1BQU0sUUFBUSxHQUFHLE1BQU0sR0FBRyxDQUFDLElBQUksQ0FBQyxXQUFXLEVBQUUsT0FBTyxDQUFDLENBQUM7UUFFdEQsSUFBSSxRQUFRLENBQUMsRUFBRSxFQUFFO1lBQ2YsTUFBTSxJQUFJLEdBQUcsUUFBUSxDQUFDLElBQThCLENBQUM7WUFFckQsT0FBTyxJQUFJLGdCQUFnQixDQUN6QixHQUFHLENBQUMsVUFBVSxFQUFFLEVBQ2hCLE9BQU8sQ0FBQyxLQUFLLElBQUksT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLElBQUksZUFBZSxFQUM1RCxJQUFJLENBQ0wsQ0FBQztTQUNIO2FBQU0sSUFBSSxRQUFRLENBQUMsT0FBTyxLQUFLLGNBQWMsRUFBRTtZQUM5QyxNQUFNLEtBQUssR0FBRyxRQUFRLENBQUMsSUFBK0IsQ0FBQztZQUN2RCxJQUFJLEtBQUssQ0FBQyxPQUFPLEtBQUsscUJBQXFCLEVBQUU7Z0JBQzNDLE1BQU0sSUFBSSxVQUFVLENBQUMseUJBQXlCLEVBQUUsQ0FBQzthQUNsRDtpQkFBTSxJQUFJLEtBQUssQ0FBQyxPQUFPLEtBQUssY0FBYyxFQUFFO2dCQUMzQyxNQUFNLElBQUksVUFBVSxDQUFDLGdCQUFnQixFQUFFLENBQUM7YUFDekM7aUJBQU07Z0JBQ0wsTUFBTSxJQUFJLEtBQUssQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7YUFDaEM7U0FDRjthQUFNO1lBQ0wsTUFBTSxJQUFJLEtBQUssQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUM7U0FDbkM7SUFDSCxDQUFDO0NBQ0YifQ==
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { SampleInterface } from '../types';
|
|
2
|
+
export declare class SampleService {
|
|
3
|
+
/**
|
|
4
|
+
* Adds two numbers
|
|
5
|
+
*
|
|
6
|
+
* ### Example (es module)
|
|
7
|
+
* ```js
|
|
8
|
+
* import { SampleService } from 'typescript-library-template';
|
|
9
|
+
*
|
|
10
|
+
* async function add() {
|
|
11
|
+
* const sampleService = new SampleService();
|
|
12
|
+
* const res = await sampleService.sampleMethod({
|
|
13
|
+
* number1: 1,
|
|
14
|
+
* number2: 2,
|
|
15
|
+
* });
|
|
16
|
+
* console.log(res);
|
|
17
|
+
* }
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* ### Example (commonjs)
|
|
21
|
+
* ```js
|
|
22
|
+
* const { SampleService } = require('typescript-library-template');
|
|
23
|
+
*
|
|
24
|
+
* async function add() {
|
|
25
|
+
* const sampleService = new SampleService();
|
|
26
|
+
* const res = await sampleService.sampleMethod({
|
|
27
|
+
* number1: 1,
|
|
28
|
+
* number2: 2,
|
|
29
|
+
* });
|
|
30
|
+
* console.log(res);
|
|
31
|
+
* }
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
sampleMethod(numbers: SampleInterface): Promise<number>;
|
|
35
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
export class SampleService {
|
|
2
|
+
/**
|
|
3
|
+
* Adds two numbers
|
|
4
|
+
*
|
|
5
|
+
* ### Example (es module)
|
|
6
|
+
* ```js
|
|
7
|
+
* import { SampleService } from 'typescript-library-template';
|
|
8
|
+
*
|
|
9
|
+
* async function add() {
|
|
10
|
+
* const sampleService = new SampleService();
|
|
11
|
+
* const res = await sampleService.sampleMethod({
|
|
12
|
+
* number1: 1,
|
|
13
|
+
* number2: 2,
|
|
14
|
+
* });
|
|
15
|
+
* console.log(res);
|
|
16
|
+
* }
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
19
|
+
* ### Example (commonjs)
|
|
20
|
+
* ```js
|
|
21
|
+
* const { SampleService } = require('typescript-library-template');
|
|
22
|
+
*
|
|
23
|
+
* async function add() {
|
|
24
|
+
* const sampleService = new SampleService();
|
|
25
|
+
* const res = await sampleService.sampleMethod({
|
|
26
|
+
* number1: 1,
|
|
27
|
+
* number2: 2,
|
|
28
|
+
* });
|
|
29
|
+
* console.log(res);
|
|
30
|
+
* }
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
async sampleMethod(numbers) {
|
|
34
|
+
return numbers.number1 + numbers.number2;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2FtcGxlLXNlcnZpY2UuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvc2VydmljZXMvc2FtcGxlLXNlcnZpY2UudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBRUEsTUFBTSxPQUFPLGFBQWE7SUFDeEI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztPQThCRztJQUNILEtBQUssQ0FBQyxZQUFZLENBQUMsT0FBd0I7UUFDekMsT0FBTyxPQUFPLENBQUMsT0FBTyxHQUFHLE9BQU8sQ0FBQyxPQUFPLENBQUM7SUFDM0MsQ0FBQztDQUNGIn0=
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export class AuthResponse {
|
|
2
|
+
access_token = '';
|
|
3
|
+
name = '';
|
|
4
|
+
}
|
|
5
|
+
export class ErrorResponse {
|
|
6
|
+
message = '';
|
|
7
|
+
error = '';
|
|
8
|
+
statusCode = 0;
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXV0aHJlc3BvbnNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGVzL2F1dGhyZXNwb25zZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLE9BQU8sWUFBWTtJQUN2QixZQUFZLEdBQUcsRUFBRSxDQUFDO0lBQ2xCLElBQUksR0FBRyxFQUFFLENBQUM7Q0FDWDtBQUVELE1BQU0sT0FBTyxhQUFhO0lBQ3hCLE9BQU8sR0FBRyxFQUFFLENBQUM7SUFDYixLQUFLLEdBQUcsRUFBRSxDQUFDO0lBQ1gsVUFBVSxHQUFHLENBQUMsQ0FBQztDQUNoQiJ9
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { KitsasConnectionOptions } from './kitsasconnectionoptions';
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
export { KitsasConnectionOptions } from './kitsasconnectionoptions';
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHlwZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLHVCQUF1QixFQUFFLE1BQU0sMkJBQTJCLENBQUMifQ==
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export declare class KitsasConnectionOptions {
|
|
2
|
+
/**
|
|
3
|
+
* Kitsas API Base URL
|
|
4
|
+
*/
|
|
5
|
+
url?: string | undefined;
|
|
6
|
+
/**
|
|
7
|
+
* User email to login
|
|
8
|
+
*/
|
|
9
|
+
email?: string | undefined;
|
|
10
|
+
/**
|
|
11
|
+
* User password to login
|
|
12
|
+
*/
|
|
13
|
+
password?: string | undefined;
|
|
14
|
+
/**
|
|
15
|
+
* User agent to identify the client
|
|
16
|
+
*/
|
|
17
|
+
agent?: string | undefined;
|
|
18
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export class KitsasConnectionOptions {
|
|
2
|
+
/**
|
|
3
|
+
* Kitsas API Base URL
|
|
4
|
+
*/
|
|
5
|
+
url = undefined;
|
|
6
|
+
/**
|
|
7
|
+
* User email to login
|
|
8
|
+
*/
|
|
9
|
+
email = undefined;
|
|
10
|
+
/**
|
|
11
|
+
* User password to login
|
|
12
|
+
*/
|
|
13
|
+
password = undefined;
|
|
14
|
+
/**
|
|
15
|
+
* User agent to identify the client
|
|
16
|
+
*/
|
|
17
|
+
agent = undefined;
|
|
18
|
+
}
|
|
19
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoia2l0c2FzY29ubmVjdGlvbm9wdGlvbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdHlwZXMva2l0c2FzY29ubmVjdGlvbm9wdGlvbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsTUFBTSxPQUFPLHVCQUF1QjtJQUNsQzs7T0FFRztJQUNILEdBQUcsR0FBd0IsU0FBUyxDQUFDO0lBQ3JDOztPQUVHO0lBQ0gsS0FBSyxHQUF3QixTQUFTLENBQUM7SUFDdkM7O09BRUc7SUFDSCxRQUFRLEdBQXdCLFNBQVMsQ0FBQztJQUMxQzs7T0FFRztJQUNILEtBQUssR0FBd0IsU0FBUyxDQUFDO0NBQ3hDIn0=
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export class InvalidCreditentialsError extends Error {
|
|
2
|
+
constructor() {
|
|
3
|
+
super('Invalid creditentials');
|
|
4
|
+
}
|
|
5
|
+
}
|
|
6
|
+
export class TFARequiredError extends Error {
|
|
7
|
+
constructor() {
|
|
8
|
+
super('2FA required');
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoia2l0c2FzZXhlcHRpb25zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3R5cGVzL2tpdHNhc2V4ZXB0aW9ucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLE9BQU8seUJBQTBCLFNBQVEsS0FBSztJQUNsRDtRQUNFLEtBQUssQ0FBQyx1QkFBdUIsQ0FBQyxDQUFDO0lBQ2pDLENBQUM7Q0FDRjtBQUVELE1BQU0sT0FBTyxnQkFBaUIsU0FBUSxLQUFLO0lBQ3pDO1FBQ0UsS0FBSyxDQUFDLGNBQWMsQ0FBQyxDQUFDO0lBQ3hCLENBQUM7Q0FDRiJ9
|
package/package.json
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "kitsas-library",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "KitsasHub Client Library",
|
|
5
|
+
"main": "lib/main/index.js",
|
|
6
|
+
"typings": "lib/main/index.d.ts",
|
|
7
|
+
"module": "lib/module/index.js",
|
|
8
|
+
"repository": "https://github.com/Kitsas-Oy/kitsaslibrary.git",
|
|
9
|
+
"author": "Kitsas Oy",
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"kitsas"
|
|
13
|
+
],
|
|
14
|
+
"scripts": {
|
|
15
|
+
"build": "run-p build:*",
|
|
16
|
+
"build:main": "tsc -p tsconfig.json",
|
|
17
|
+
"build:module": "tsc -p tsconfig.module.json",
|
|
18
|
+
"fix": "run-s fix:*",
|
|
19
|
+
"fix:prettier": "prettier \"src/**/*.ts\" --write",
|
|
20
|
+
"fix:lint": "eslint src --ext .ts --fix",
|
|
21
|
+
"test": "run-s build test:*",
|
|
22
|
+
"test:lint": "eslint src --ext .ts",
|
|
23
|
+
"test:prettier": "prettier \"src/**/*.ts\" --list-different",
|
|
24
|
+
"test:unit": "nyc --silent ava",
|
|
25
|
+
"watch:build": "tsc -p tsconfig.json -w",
|
|
26
|
+
"watch:test": "nyc --silent ava --watch",
|
|
27
|
+
"cov": "run-s build test:unit cov:html cov:lcov && open-cli coverage/index.html",
|
|
28
|
+
"cov:html": "nyc report --reporter=html",
|
|
29
|
+
"cov:lcov": "nyc report --reporter=lcov",
|
|
30
|
+
"cov:send": "run-s cov:lcov && codecov",
|
|
31
|
+
"cov:check": "nyc report && nyc check-coverage --lines 100 --functions 100 --branches 100",
|
|
32
|
+
"doc": "run-s doc:html && open-cli lib/docs/index.html",
|
|
33
|
+
"doc:html": "typedoc src/ --exclude **/*.spec.ts --out lib/docs",
|
|
34
|
+
"doc:json": "typedoc src/ --exclude **/*.spec.ts --json lib/docs/typedoc.json",
|
|
35
|
+
"prepare": "husky install"
|
|
36
|
+
},
|
|
37
|
+
"devDependencies": {
|
|
38
|
+
"@ava/typescript": "^3.0.1",
|
|
39
|
+
"@istanbuljs/nyc-config-typescript": "^1.0.2",
|
|
40
|
+
"@typescript-eslint/eslint-plugin": "^5.51.0",
|
|
41
|
+
"@typescript-eslint/parser": "^5.51.0",
|
|
42
|
+
"ava": "^5.2.0",
|
|
43
|
+
"codecov": "^3.8.3",
|
|
44
|
+
"eslint": "^8.34.0",
|
|
45
|
+
"eslint-config-prettier": "^8.5.0",
|
|
46
|
+
"eslint-plugin-eslint-comments": "^3.2.0",
|
|
47
|
+
"eslint-plugin-import": "^2.26.0",
|
|
48
|
+
"husky": "^8.0.3",
|
|
49
|
+
"lint-staged": "^13.1.2",
|
|
50
|
+
"npm-run-all": "^4.1.5",
|
|
51
|
+
"nyc": "^15.1.0",
|
|
52
|
+
"open-cli": "^7.0.1",
|
|
53
|
+
"prettier": "^2.8.4",
|
|
54
|
+
"ts-node": "^10.9.1",
|
|
55
|
+
"typedoc": "^0.23.10",
|
|
56
|
+
"typescript": "^4.9.5"
|
|
57
|
+
},
|
|
58
|
+
"files": [
|
|
59
|
+
"lib/main",
|
|
60
|
+
"lib/module",
|
|
61
|
+
"!**/*.spec.*",
|
|
62
|
+
"!**/*.json",
|
|
63
|
+
"CHANGELOG.md",
|
|
64
|
+
"LICENSE",
|
|
65
|
+
"README.md"
|
|
66
|
+
],
|
|
67
|
+
"ava": {
|
|
68
|
+
"failFast": true,
|
|
69
|
+
"timeout": "60s",
|
|
70
|
+
"typescript": {
|
|
71
|
+
"rewritePaths": {
|
|
72
|
+
"src/": "lib/main/"
|
|
73
|
+
},
|
|
74
|
+
"compile": false
|
|
75
|
+
},
|
|
76
|
+
"files": [
|
|
77
|
+
"!lib/module/**"
|
|
78
|
+
]
|
|
79
|
+
},
|
|
80
|
+
"prettier": {
|
|
81
|
+
"singleQuote": true
|
|
82
|
+
},
|
|
83
|
+
"nyc": {
|
|
84
|
+
"extends": "@istanbuljs/nyc-config-typescript",
|
|
85
|
+
"exclude": [
|
|
86
|
+
"**/*.spec.js"
|
|
87
|
+
]
|
|
88
|
+
},
|
|
89
|
+
"dependencies": {
|
|
90
|
+
"apisauce": "^3.0.1"
|
|
91
|
+
}
|
|
92
|
+
}
|