@vybit/api-sdk 1.0.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/README.md +73 -0
- package/dist/api-client.d.ts +18 -0
- package/dist/api-client.d.ts.map +1 -0
- package/dist/api-client.js +28 -0
- package/dist/api-client.js.map +1 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +27 -0
- package/dist/index.js.map +1 -0
- package/dist/types.d.ts +6 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +3 -0
- package/dist/types.js.map +1 -0
- package/package.json +43 -0
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# @vybit/api-sdk
|
|
2
|
+
|
|
3
|
+
� **PLACEHOLDER PACKAGE** - Full implementation coming in future release.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
This package is currently a placeholder for the Vybit REST API SDK. The full implementation will be available in a future release once the main Vybit application API is finalized.
|
|
8
|
+
|
|
9
|
+
## Current Status
|
|
10
|
+
|
|
11
|
+
- **@vybit/oauth2-sdk** - Fully functional OAuth2 authentication
|
|
12
|
+
- � **@vybit/api-sdk** - Placeholder (this package)
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install @vybit/api-sdk
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
> **Note**: This package currently only provides placeholder functionality. For authentication, use `@vybit/oauth2-sdk`.
|
|
21
|
+
|
|
22
|
+
## What's Coming
|
|
23
|
+
|
|
24
|
+
The full API SDK will include:
|
|
25
|
+
|
|
26
|
+
- **Vybit Management**: Create, update, delete vybits
|
|
27
|
+
- **Subscription Management**: Handle vybit subscriptions
|
|
28
|
+
- **User Profile**: Manage user account settings
|
|
29
|
+
- **Analytics**: Access usage statistics and metrics
|
|
30
|
+
- **Media Management**: Upload and manage audio files
|
|
31
|
+
- **Webhook Management**: Configure webhook endpoints
|
|
32
|
+
|
|
33
|
+
## Current Usage (Placeholder)
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
import { VybitAPIClient } from '@vybit/api-sdk';
|
|
37
|
+
|
|
38
|
+
// This currently shows a placeholder warning
|
|
39
|
+
const client = new VybitAPIClient();
|
|
40
|
+
const result = await client.placeholder();
|
|
41
|
+
// Returns: { message: 'API SDK implementation coming soon' }
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Migration Path
|
|
45
|
+
|
|
46
|
+
When the full API SDK is released:
|
|
47
|
+
|
|
48
|
+
1. Update to the latest version: `npm update @vybit/api-sdk`
|
|
49
|
+
2. Replace placeholder usage with real API methods
|
|
50
|
+
3. No breaking changes to OAuth2 authentication
|
|
51
|
+
|
|
52
|
+
## Using OAuth2 SDK Now
|
|
53
|
+
|
|
54
|
+
For current projects, use the OAuth2 SDK for authentication:
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
import { VybitOAuth2Client } from '@vybit/oauth2-sdk';
|
|
58
|
+
|
|
59
|
+
const client = new VybitOAuth2Client({
|
|
60
|
+
clientId: 'your-client-id',
|
|
61
|
+
clientSecret: 'your-client-secret',
|
|
62
|
+
redirectUri: 'https://yourapp.com/callback'
|
|
63
|
+
});
|
|
64
|
+
|
|
65
|
+
// Full OAuth2 functionality available
|
|
66
|
+
const authUrl = client.getAuthorizationUrl();
|
|
67
|
+
const token = await client.exchangeCodeForToken(code);
|
|
68
|
+
const vybits = await client.getVybitList();
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
|
|
73
|
+
MIT
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { PlaceholderResponse } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* VybitAPIClient - Placeholder Implementation
|
|
4
|
+
*
|
|
5
|
+
* This is a placeholder class for the Vybit API SDK.
|
|
6
|
+
* The full implementation will be available in a future release
|
|
7
|
+
* once the main Vybit application API is finalized.
|
|
8
|
+
*
|
|
9
|
+
* @deprecated This is a placeholder - do not use in production
|
|
10
|
+
*/
|
|
11
|
+
export declare class VybitAPIClient {
|
|
12
|
+
constructor();
|
|
13
|
+
/**
|
|
14
|
+
* Placeholder method - will be implemented in future release
|
|
15
|
+
*/
|
|
16
|
+
placeholder(): Promise<PlaceholderResponse>;
|
|
17
|
+
}
|
|
18
|
+
//# sourceMappingURL=api-client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-client.d.ts","sourceRoot":"","sources":["../src/api-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE9C;;;;;;;;GAQG;AACH,qBAAa,cAAc;;IAQzB;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC;CAKlD"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.VybitAPIClient = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* VybitAPIClient - Placeholder Implementation
|
|
6
|
+
*
|
|
7
|
+
* This is a placeholder class for the Vybit API SDK.
|
|
8
|
+
* The full implementation will be available in a future release
|
|
9
|
+
* once the main Vybit application API is finalized.
|
|
10
|
+
*
|
|
11
|
+
* @deprecated This is a placeholder - do not use in production
|
|
12
|
+
*/
|
|
13
|
+
class VybitAPIClient {
|
|
14
|
+
constructor() {
|
|
15
|
+
console.warn('VybitAPIClient is currently a placeholder. ' +
|
|
16
|
+
'Full API implementation coming in future release.');
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* Placeholder method - will be implemented in future release
|
|
20
|
+
*/
|
|
21
|
+
async placeholder() {
|
|
22
|
+
return {
|
|
23
|
+
message: 'API SDK implementation coming soon'
|
|
24
|
+
};
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
exports.VybitAPIClient = VybitAPIClient;
|
|
28
|
+
//# sourceMappingURL=api-client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-client.js","sourceRoot":"","sources":["../src/api-client.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;GAQG;AACH,MAAa,cAAc;IACzB;QACE,OAAO,CAAC,IAAI,CACV,6CAA6C;YAC7C,mDAAmD,CACpD,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QACf,OAAO;YACL,OAAO,EAAE,oCAAoC;SAC9C,CAAC;IACJ,CAAC;CACF;AAhBD,wCAgBC"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export * from './api-client';
|
|
2
|
+
export * from './types';
|
|
3
|
+
/**
|
|
4
|
+
* @vybit/api-sdk - Placeholder Package
|
|
5
|
+
*
|
|
6
|
+
* This package is currently a placeholder and will be fully implemented
|
|
7
|
+
* in a future release once the main Vybit application API is finalized.
|
|
8
|
+
*
|
|
9
|
+
* For now, please use the @vybit/oauth2-sdk package for authentication.
|
|
10
|
+
*/
|
|
11
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AAExB;;;;;;;GAOG"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./api-client"), exports);
|
|
18
|
+
__exportStar(require("./types"), exports);
|
|
19
|
+
/**
|
|
20
|
+
* @vybit/api-sdk - Placeholder Package
|
|
21
|
+
*
|
|
22
|
+
* This package is currently a placeholder and will be fully implemented
|
|
23
|
+
* in a future release once the main Vybit application API is finalized.
|
|
24
|
+
*
|
|
25
|
+
* For now, please use the @vybit/oauth2-sdk package for authentication.
|
|
26
|
+
*/
|
|
27
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,0CAAwB;AAExB;;;;;;;GAOG"}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,SAAS;CAEzB;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;CACjB"}
|
package/dist/types.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
|
package/package.json
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@vybit/api-sdk",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "[PLACEHOLDER] API SDK for Vybit - Full implementation coming in future release",
|
|
5
|
+
"main": "dist/index.js",
|
|
6
|
+
"types": "dist/index.d.ts",
|
|
7
|
+
"scripts": {
|
|
8
|
+
"build": "tsc",
|
|
9
|
+
"clean": "rm -rf dist",
|
|
10
|
+
"dev": "tsc --watch",
|
|
11
|
+
"test": "jest --config ../../jest.config.js --rootDir ../.."
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"vybit",
|
|
15
|
+
"api",
|
|
16
|
+
"rest",
|
|
17
|
+
"sdk"
|
|
18
|
+
],
|
|
19
|
+
"author": "Vybit Team",
|
|
20
|
+
"license": "MIT",
|
|
21
|
+
"repository": {
|
|
22
|
+
"type": "git",
|
|
23
|
+
"url": "https://github.com/vybit/vybit-sdk.git",
|
|
24
|
+
"directory": "packages/api"
|
|
25
|
+
},
|
|
26
|
+
"homepage": "https://github.com/vybit/vybit-sdk#readme",
|
|
27
|
+
"bugs": {
|
|
28
|
+
"url": "https://github.com/vybit/vybit-sdk/issues"
|
|
29
|
+
},
|
|
30
|
+
"publishConfig": {
|
|
31
|
+
"access": "public"
|
|
32
|
+
},
|
|
33
|
+
"files": [
|
|
34
|
+
"dist/**/*",
|
|
35
|
+
"README.md"
|
|
36
|
+
],
|
|
37
|
+
"engines": {
|
|
38
|
+
"node": ">=16.0.0"
|
|
39
|
+
},
|
|
40
|
+
"dependencies": {
|
|
41
|
+
"@vybit/core": "^1.0.0"
|
|
42
|
+
}
|
|
43
|
+
}
|