@xylabs/api 4.13.15 → 4.13.16
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/README.md +22 -31
- package/dist/neutral/index.d.ts +6 -44
- package/dist/neutral/spec/ApiEndpoint.spec.d.ts +2 -0
- package/dist/neutral/spec/ApiEndpoint.spec.d.ts.map +1 -0
- package/dist/neutral/spec/getApiStage.spec.d.ts +2 -0
- package/dist/neutral/spec/getApiStage.spec.d.ts.map +1 -0
- package/package.json +5 -5
- package/build/neutral/index.d.ts +0 -6
- /package/{build → dist}/neutral/ApiClient.d.ts +0 -0
- /package/{build → dist}/neutral/ApiClient.d.ts.map +0 -0
- /package/{build → dist}/neutral/ApiConfig.d.ts +0 -0
- /package/{build → dist}/neutral/ApiConfig.d.ts.map +0 -0
- /package/{build → dist}/neutral/ApiEndpoint.d.ts +0 -0
- /package/{build → dist}/neutral/ApiEndpoint.d.ts.map +0 -0
- /package/{build → dist}/neutral/ApiStage.d.ts +0 -0
- /package/{build → dist}/neutral/ApiStage.d.ts.map +0 -0
- /package/{build → dist}/neutral/getApiStage.d.ts +0 -0
- /package/{build → dist}/neutral/getApiStage.d.ts.map +0 -0
- /package/{build → dist}/neutral/index.d.ts.map +0 -0
package/README.md
CHANGED
|
@@ -1,63 +1,54 @@
|
|
|
1
|
-
[![logo][]](https://xylabs.com)
|
|
2
|
-
|
|
3
1
|
# @xylabs/api
|
|
4
2
|
|
|
3
|
+
[![logo][]](https://xylabs.com)
|
|
4
|
+
|
|
5
|
+
[![main-build][]][main-build-link]
|
|
5
6
|
[![npm-badge][]][npm-link]
|
|
6
7
|
[![npm-downloads-badge][]][npm-link]
|
|
7
8
|
[![jsdelivr-badge][]][jsdelivr-link]
|
|
8
9
|
[![npm-license-badge][]](LICENSE)
|
|
10
|
+
[![codacy-badge][]][codacy-link]
|
|
11
|
+
[![codeclimate-badge][]][codeclimate-link]
|
|
12
|
+
[![snyk-badge][]][snyk-link]
|
|
9
13
|
[![socket-badge][]][socket-link]
|
|
10
14
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
## Table of Contents
|
|
14
|
-
|
|
15
|
-
- [Description](#description)
|
|
16
|
-
- [Install](#install)
|
|
17
|
-
- [Maintainers](#maintainers)
|
|
18
|
-
- [License](#license)
|
|
19
|
-
- [Credits](#credits)
|
|
20
|
-
|
|
21
|
-
## Description
|
|
15
|
+
Version: 4.13.15
|
|
22
16
|
|
|
23
|
-
|
|
17
|
+
Base functionality used throughout XY Labs TypeScript/JavaScript libraries
|
|
24
18
|
|
|
25
|
-
##
|
|
26
|
-
|
|
27
|
-
Using npm:
|
|
28
|
-
|
|
29
|
-
```sh
|
|
30
|
-
npm i --save @xylabs/api
|
|
31
|
-
```
|
|
19
|
+
## Documentation
|
|
32
20
|
|
|
33
|
-
|
|
21
|
+
Coming Soon!
|
|
34
22
|
|
|
35
|
-
|
|
36
|
-
yarn add @xylabs/api
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
## Documentation
|
|
40
|
-
[Developer Reference](https://xylabs.github.io/sdk-js)
|
|
23
|
+
Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
|
|
41
24
|
|
|
42
25
|
## Maintainers
|
|
43
26
|
|
|
44
27
|
- [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
|
|
45
|
-
- [Joel Carter](https://github.com/JoelBCarter)
|
|
46
28
|
- [Matt Jones](https://github.com/jonesmac)
|
|
29
|
+
- [Joel Carter](https://github.com/JoelBCarter)
|
|
47
30
|
- [Jordan Trouw](https://github.com/jordantrouw)
|
|
48
31
|
|
|
49
32
|
## License
|
|
50
33
|
|
|
51
|
-
See the [LICENSE](LICENSE) file for license details
|
|
34
|
+
> See the [LICENSE](LICENSE) file for license details
|
|
52
35
|
|
|
53
36
|
## Credits
|
|
54
37
|
|
|
55
|
-
[Made with 🔥and ❄️ by
|
|
38
|
+
[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
|
|
56
39
|
|
|
57
40
|
[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
|
|
58
41
|
|
|
42
|
+
[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
|
|
43
|
+
[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
|
|
59
44
|
[npm-badge]: https://img.shields.io/npm/v/@xylabs/api.svg
|
|
60
45
|
[npm-link]: https://www.npmjs.com/package/@xylabs/api
|
|
46
|
+
[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
|
|
47
|
+
[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
|
|
48
|
+
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
|
|
49
|
+
[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
|
|
50
|
+
[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
|
|
51
|
+
[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
|
|
61
52
|
|
|
62
53
|
[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/api
|
|
63
54
|
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/api
|
package/dist/neutral/index.d.ts
CHANGED
|
@@ -1,44 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
}>;
|
|
8
|
-
type ApiStage = EnumValue<typeof ApiStage>;
|
|
9
|
-
|
|
10
|
-
declare abstract class ApiClient {
|
|
11
|
-
protected token?: string | null | undefined;
|
|
12
|
-
protected stage?: ApiStage | undefined;
|
|
13
|
-
constructor(token?: string | null | undefined, stage?: ApiStage | undefined);
|
|
14
|
-
abstract endPoint(): string;
|
|
15
|
-
}
|
|
16
|
-
//# sourceMappingURL=ApiClient.d.ts.map
|
|
17
|
-
|
|
18
|
-
interface ApiConfig {
|
|
19
|
-
apiDomain: string;
|
|
20
|
-
apiKey?: string;
|
|
21
|
-
jwtToken?: string;
|
|
22
|
-
userid?: string;
|
|
23
|
-
}
|
|
24
|
-
//# sourceMappingURL=ApiConfig.d.ts.map
|
|
25
|
-
|
|
26
|
-
declare class ApiEndpoint<T> {
|
|
27
|
-
private _value?;
|
|
28
|
-
private config;
|
|
29
|
-
private path;
|
|
30
|
-
constructor(config: ApiConfig, path: string);
|
|
31
|
-
get value(): T | undefined;
|
|
32
|
-
private get headers();
|
|
33
|
-
private get url();
|
|
34
|
-
fetch(): Promise<T>;
|
|
35
|
-
get(): Promise<T | NonNullable<T>>;
|
|
36
|
-
insert(value: T): Promise<T>;
|
|
37
|
-
}
|
|
38
|
-
//# sourceMappingURL=ApiEndpoint.d.ts.map
|
|
39
|
-
|
|
40
|
-
declare const getApiStage: (hostname: string) => "beta" | "local" | "prod";
|
|
41
|
-
//# sourceMappingURL=getApiStage.d.ts.map
|
|
42
|
-
|
|
43
|
-
export { ApiClient, ApiEndpoint, ApiStage, getApiStage };
|
|
44
|
-
export type { ApiConfig };
|
|
1
|
+
export * from './ApiClient.ts';
|
|
2
|
+
export * from './ApiConfig.ts';
|
|
3
|
+
export * from './ApiEndpoint.ts';
|
|
4
|
+
export * from './ApiStage.ts';
|
|
5
|
+
export * from './getApiStage.ts';
|
|
6
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ApiEndpoint.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/ApiEndpoint.spec.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"getApiStage.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/getApiStage.spec.ts"],"names":[],"mappings":""}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xylabs/api",
|
|
3
|
-
"version": "4.13.
|
|
3
|
+
"version": "4.13.16",
|
|
4
4
|
"description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"xylabs",
|
|
@@ -38,13 +38,13 @@
|
|
|
38
38
|
"packages/**/*"
|
|
39
39
|
],
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@xylabs/enum": "^4.13.
|
|
42
|
-
"@xylabs/typeof": "^4.13.
|
|
41
|
+
"@xylabs/enum": "^4.13.16",
|
|
42
|
+
"@xylabs/typeof": "^4.13.16",
|
|
43
43
|
"axios": "^1.10.0"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
|
-
"@xylabs/ts-scripts-yarn3": "^7.0.0-rc.
|
|
47
|
-
"@xylabs/tsconfig": "^7.0.0-rc.
|
|
46
|
+
"@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
|
|
47
|
+
"@xylabs/tsconfig": "^7.0.0-rc.27",
|
|
48
48
|
"typescript": "^5.8.3",
|
|
49
49
|
"vitest": "^3.2.4"
|
|
50
50
|
},
|
package/build/neutral/index.d.ts
DELETED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|