@flexbe/sdk 0.2.42 → 0.2.43
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/dist/browser/client/auth.js +74 -0
- package/dist/browser/client/sandbox.js +47 -0
- package/dist/browser/client/site-api.js +2 -0
- package/dist/browser/index.js +1 -0
- package/dist/browser/types/index.js +1 -0
- package/dist/browser/types/sandbox.js +1 -0
- package/dist/cjs/client/auth.js +63 -0
- package/dist/cjs/client/sandbox.js +38 -0
- package/dist/cjs/client/site-api.js +2 -0
- package/dist/cjs/index.js +1 -0
- package/dist/cjs/types/index.js +1 -0
- package/dist/cjs/types/sandbox.js +2 -0
- package/dist/client/flexbe-client.d.ts +13 -0
- package/dist/client/flexbe-client.js +62 -0
- package/dist/esm/client/auth.js +59 -0
- package/dist/esm/client/sandbox.js +34 -0
- package/dist/esm/client/site-api.js +2 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/types/index.js +1 -0
- package/dist/esm/types/sandbox.js +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +18 -0
- package/dist/src/client/flexbe-client.d.ts +20 -0
- package/dist/src/client/flexbe-client.js +86 -0
- package/dist/src/client/pages-client.d.ts +14 -0
- package/dist/src/client/pages-client.js +23 -0
- package/dist/src/index.d.ts +4 -0
- package/dist/src/index.js +20 -0
- package/dist/src/types/index.d.ts +23 -0
- package/dist/src/types/index.js +2 -0
- package/dist/src/types/pages.d.ts +41 -0
- package/dist/src/types/pages.js +19 -0
- package/dist/test/client/flexbe-client.test.d.ts +1 -0
- package/dist/test/client/flexbe-client.test.js +38 -0
- package/dist/test/client/pages-client.test.d.ts +1 -0
- package/dist/test/client/pages-client.test.js +82 -0
- package/dist/types/client/auth.d.ts +11 -0
- package/dist/types/client/sandbox.d.ts +29 -0
- package/dist/types/client/site-api.d.ts +2 -0
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.js +2 -0
- package/dist/types/types/index.d.ts +1 -0
- package/dist/types/types/sandbox.d.ts +10 -0
- package/package.json +1 -1
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
+
});
|
|
9
|
+
};
|
|
10
|
+
import { FlexbeAuthType } from '../types';
|
|
11
|
+
import { TokenManager } from './token-manager';
|
|
12
|
+
export class FlexbeAuth {
|
|
13
|
+
constructor(config) {
|
|
14
|
+
this.initialized = false;
|
|
15
|
+
this.initializationPromise = null;
|
|
16
|
+
this.config = config;
|
|
17
|
+
this.tokenManager = TokenManager.getInstance();
|
|
18
|
+
if (this.config.authType === FlexbeAuthType.BEARER) {
|
|
19
|
+
// Start initialization but don't wait for it
|
|
20
|
+
this.initializationPromise = this.initialize();
|
|
21
|
+
}
|
|
22
|
+
else {
|
|
23
|
+
this.initialized = true;
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
initialize() {
|
|
27
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
28
|
+
try {
|
|
29
|
+
const token = yield this.tokenManager.getToken();
|
|
30
|
+
this.initialized = !!token;
|
|
31
|
+
}
|
|
32
|
+
catch (error) {
|
|
33
|
+
console.error('Failed to initialize auth:', error);
|
|
34
|
+
this.initialized = false;
|
|
35
|
+
}
|
|
36
|
+
finally {
|
|
37
|
+
this.initializationPromise = null;
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
ensureInitialized() {
|
|
42
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
43
|
+
if (this.config.authType !== FlexbeAuthType.BEARER || this.initialized) {
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
// If initialization is in progress, wait for it
|
|
47
|
+
if (this.initializationPromise) {
|
|
48
|
+
yield this.initializationPromise;
|
|
49
|
+
return;
|
|
50
|
+
}
|
|
51
|
+
// If not initialized and no initialization in progress, start one
|
|
52
|
+
yield this.initialize();
|
|
53
|
+
});
|
|
54
|
+
}
|
|
55
|
+
getAuthHeaders() {
|
|
56
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
57
|
+
yield this.ensureInitialized();
|
|
58
|
+
const headers = {
|
|
59
|
+
'Content-Type': 'application/json',
|
|
60
|
+
};
|
|
61
|
+
if (this.config.authType === FlexbeAuthType.API_KEY) {
|
|
62
|
+
headers['x-api-key'] = this.config.apiKey;
|
|
63
|
+
}
|
|
64
|
+
else if (this.config.authType === FlexbeAuthType.BEARER) {
|
|
65
|
+
const token = yield this.tokenManager.getToken();
|
|
66
|
+
if (!token) {
|
|
67
|
+
throw new Error('No valid bearer token available');
|
|
68
|
+
}
|
|
69
|
+
headers['Authorization'] = `Bearer ${token}`;
|
|
70
|
+
}
|
|
71
|
+
return headers;
|
|
72
|
+
});
|
|
73
|
+
}
|
|
74
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
2
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
3
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
4
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
5
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
6
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
7
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
8
|
+
});
|
|
9
|
+
};
|
|
10
|
+
export class Sandbox {
|
|
11
|
+
constructor(api, siteId) {
|
|
12
|
+
this.api = api;
|
|
13
|
+
this.siteId = siteId;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Create or get existing sandbox
|
|
17
|
+
* @param branch - Git branch name for the sandbox
|
|
18
|
+
* @returns Promise with sandbox details including URLs and token
|
|
19
|
+
* @throws {UnauthorizedException} When the API key is invalid or expired
|
|
20
|
+
* @throws {ForbiddenException} When the user does not have permission to access this site
|
|
21
|
+
* @throws {BadRequestException} When the request is invalid or failed to create sandbox
|
|
22
|
+
* @throws {ServerException} When the server encounters an error
|
|
23
|
+
* @throws {TimeoutException} When the request times out
|
|
24
|
+
*/
|
|
25
|
+
create(branch) {
|
|
26
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
27
|
+
const request = { branch };
|
|
28
|
+
const response = yield this.api.post(`/sites/${this.siteId}/app/sandbox`, request);
|
|
29
|
+
return response.data;
|
|
30
|
+
});
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Delete sandbox
|
|
34
|
+
* @param sandboxId - The sandbox ID to delete
|
|
35
|
+
* @throws {UnauthorizedException} When the API key is invalid or expired
|
|
36
|
+
* @throws {ForbiddenException} When the user does not have permission to access this site
|
|
37
|
+
* @throws {BadRequestException} When the request is invalid or failed to delete sandbox
|
|
38
|
+
* @throws {NotFoundException} When the sandbox is not found
|
|
39
|
+
* @throws {ServerException} When the server encounters an error
|
|
40
|
+
* @throws {TimeoutException} When the request times out
|
|
41
|
+
*/
|
|
42
|
+
delete(sandboxId) {
|
|
43
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
44
|
+
yield this.api.delete(`/sites/${this.siteId}/app/sandbox/${sandboxId}`);
|
|
45
|
+
});
|
|
46
|
+
}
|
|
47
|
+
}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import { Pages } from './pages';
|
|
2
|
+
import { Sandbox } from './sandbox';
|
|
2
3
|
import { Stat } from './stat';
|
|
3
4
|
export class SiteApi {
|
|
4
5
|
constructor(api, siteId) {
|
|
5
6
|
this.pages = new Pages(api, siteId);
|
|
7
|
+
this.sandbox = new Sandbox(api, siteId);
|
|
6
8
|
this.stat = new Stat(api, siteId);
|
|
7
9
|
}
|
|
8
10
|
}
|
package/dist/browser/index.js
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.FlexbeAuth = void 0;
|
|
4
|
+
const types_1 = require("../types");
|
|
5
|
+
const token_manager_1 = require("./token-manager");
|
|
6
|
+
class FlexbeAuth {
|
|
7
|
+
constructor(config) {
|
|
8
|
+
this.initialized = false;
|
|
9
|
+
this.initializationPromise = null;
|
|
10
|
+
this.config = config;
|
|
11
|
+
this.tokenManager = token_manager_1.TokenManager.getInstance();
|
|
12
|
+
if (this.config.authType === types_1.FlexbeAuthType.BEARER) {
|
|
13
|
+
// Start initialization but don't wait for it
|
|
14
|
+
this.initializationPromise = this.initialize();
|
|
15
|
+
}
|
|
16
|
+
else {
|
|
17
|
+
this.initialized = true;
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
async initialize() {
|
|
21
|
+
try {
|
|
22
|
+
const token = await this.tokenManager.getToken();
|
|
23
|
+
this.initialized = !!token;
|
|
24
|
+
}
|
|
25
|
+
catch (error) {
|
|
26
|
+
console.error('Failed to initialize auth:', error);
|
|
27
|
+
this.initialized = false;
|
|
28
|
+
}
|
|
29
|
+
finally {
|
|
30
|
+
this.initializationPromise = null;
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
async ensureInitialized() {
|
|
34
|
+
if (this.config.authType !== types_1.FlexbeAuthType.BEARER || this.initialized) {
|
|
35
|
+
return;
|
|
36
|
+
}
|
|
37
|
+
// If initialization is in progress, wait for it
|
|
38
|
+
if (this.initializationPromise) {
|
|
39
|
+
await this.initializationPromise;
|
|
40
|
+
return;
|
|
41
|
+
}
|
|
42
|
+
// If not initialized and no initialization in progress, start one
|
|
43
|
+
await this.initialize();
|
|
44
|
+
}
|
|
45
|
+
async getAuthHeaders() {
|
|
46
|
+
await this.ensureInitialized();
|
|
47
|
+
const headers = {
|
|
48
|
+
'Content-Type': 'application/json',
|
|
49
|
+
};
|
|
50
|
+
if (this.config.authType === types_1.FlexbeAuthType.API_KEY) {
|
|
51
|
+
headers['x-api-key'] = this.config.apiKey;
|
|
52
|
+
}
|
|
53
|
+
else if (this.config.authType === types_1.FlexbeAuthType.BEARER) {
|
|
54
|
+
const token = await this.tokenManager.getToken();
|
|
55
|
+
if (!token) {
|
|
56
|
+
throw new Error('No valid bearer token available');
|
|
57
|
+
}
|
|
58
|
+
headers['Authorization'] = `Bearer ${token}`;
|
|
59
|
+
}
|
|
60
|
+
return headers;
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
exports.FlexbeAuth = FlexbeAuth;
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Sandbox = void 0;
|
|
4
|
+
class Sandbox {
|
|
5
|
+
constructor(api, siteId) {
|
|
6
|
+
this.api = api;
|
|
7
|
+
this.siteId = siteId;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Create or get existing sandbox
|
|
11
|
+
* @param branch - Git branch name for the sandbox
|
|
12
|
+
* @returns Promise with sandbox details including URLs and token
|
|
13
|
+
* @throws {UnauthorizedException} When the API key is invalid or expired
|
|
14
|
+
* @throws {ForbiddenException} When the user does not have permission to access this site
|
|
15
|
+
* @throws {BadRequestException} When the request is invalid or failed to create sandbox
|
|
16
|
+
* @throws {ServerException} When the server encounters an error
|
|
17
|
+
* @throws {TimeoutException} When the request times out
|
|
18
|
+
*/
|
|
19
|
+
async create(branch) {
|
|
20
|
+
const request = { branch };
|
|
21
|
+
const response = await this.api.post(`/sites/${this.siteId}/app/sandbox`, request);
|
|
22
|
+
return response.data;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Delete sandbox
|
|
26
|
+
* @param sandboxId - The sandbox ID to delete
|
|
27
|
+
* @throws {UnauthorizedException} When the API key is invalid or expired
|
|
28
|
+
* @throws {ForbiddenException} When the user does not have permission to access this site
|
|
29
|
+
* @throws {BadRequestException} When the request is invalid or failed to delete sandbox
|
|
30
|
+
* @throws {NotFoundException} When the sandbox is not found
|
|
31
|
+
* @throws {ServerException} When the server encounters an error
|
|
32
|
+
* @throws {TimeoutException} When the request times out
|
|
33
|
+
*/
|
|
34
|
+
async delete(sandboxId) {
|
|
35
|
+
await this.api.delete(`/sites/${this.siteId}/app/sandbox/${sandboxId}`);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
exports.Sandbox = Sandbox;
|
|
@@ -2,10 +2,12 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.SiteApi = void 0;
|
|
4
4
|
const pages_1 = require("./pages");
|
|
5
|
+
const sandbox_1 = require("./sandbox");
|
|
5
6
|
const stat_1 = require("./stat");
|
|
6
7
|
class SiteApi {
|
|
7
8
|
constructor(api, siteId) {
|
|
8
9
|
this.pages = new pages_1.Pages(api, siteId);
|
|
10
|
+
this.sandbox = new sandbox_1.Sandbox(api, siteId);
|
|
9
11
|
this.stat = new stat_1.Stat(api, siteId);
|
|
10
12
|
}
|
|
11
13
|
}
|
package/dist/cjs/index.js
CHANGED
|
@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
17
|
__exportStar(require("./client/client"), exports);
|
|
18
18
|
__exportStar(require("./client/pages"), exports);
|
|
19
|
+
__exportStar(require("./client/sandbox"), exports);
|
|
19
20
|
__exportStar(require("./types"), exports);
|
package/dist/cjs/types/index.js
CHANGED
|
@@ -19,6 +19,7 @@ __exportStar(require("./meta"), exports);
|
|
|
19
19
|
__exportStar(require("./animations"), exports);
|
|
20
20
|
__exportStar(require("./pages"), exports);
|
|
21
21
|
__exportStar(require("./stat"), exports);
|
|
22
|
+
__exportStar(require("./sandbox"), exports);
|
|
22
23
|
var FlexbeAuthType;
|
|
23
24
|
(function (FlexbeAuthType) {
|
|
24
25
|
FlexbeAuthType["API_KEY"] = "apiKey";
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { AxiosRequestConfig } from 'axios';
|
|
2
|
+
import { FlexbeConfig, FlexbeResponse } from '../types';
|
|
3
|
+
export declare class FlexbeClient {
|
|
4
|
+
private readonly client;
|
|
5
|
+
private readonly config;
|
|
6
|
+
constructor(config: FlexbeConfig);
|
|
7
|
+
private setupInterceptors;
|
|
8
|
+
protected request<T>(config: AxiosRequestConfig): Promise<FlexbeResponse<T>>;
|
|
9
|
+
protected get<T>(url: string, config?: AxiosRequestConfig): Promise<FlexbeResponse<T>>;
|
|
10
|
+
protected post<T>(url: string, data?: unknown, config?: AxiosRequestConfig): Promise<FlexbeResponse<T>>;
|
|
11
|
+
protected put<T>(url: string, data?: unknown, config?: AxiosRequestConfig): Promise<FlexbeResponse<T>>;
|
|
12
|
+
protected delete<T>(url: string, config?: AxiosRequestConfig): Promise<FlexbeResponse<T>>;
|
|
13
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.FlexbeClient = void 0;
|
|
7
|
+
const axios_1 = __importDefault(require("axios"));
|
|
8
|
+
class FlexbeClient {
|
|
9
|
+
constructor(config) {
|
|
10
|
+
this.config = {
|
|
11
|
+
baseUrl: config.baseUrl || 'https://api.flexbe.com',
|
|
12
|
+
timeout: config.timeout || 30000,
|
|
13
|
+
...config,
|
|
14
|
+
};
|
|
15
|
+
this.client = axios_1.default.create({
|
|
16
|
+
baseURL: this.config.baseUrl,
|
|
17
|
+
timeout: this.config.timeout,
|
|
18
|
+
headers: {
|
|
19
|
+
'Authorization': `Bearer ${this.config.apiKey}`,
|
|
20
|
+
'Content-Type': 'application/json',
|
|
21
|
+
},
|
|
22
|
+
});
|
|
23
|
+
this.setupInterceptors();
|
|
24
|
+
}
|
|
25
|
+
setupInterceptors() {
|
|
26
|
+
this.client.interceptors.response.use((response) => response, (error) => {
|
|
27
|
+
const flexbeError = {
|
|
28
|
+
message: error.response?.data?.message || error.message,
|
|
29
|
+
code: error.response?.data?.code,
|
|
30
|
+
status: error.response?.status,
|
|
31
|
+
details: error.response?.data?.details,
|
|
32
|
+
};
|
|
33
|
+
return Promise.reject(flexbeError);
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
async request(config) {
|
|
37
|
+
try {
|
|
38
|
+
const response = await this.client.request(config);
|
|
39
|
+
return {
|
|
40
|
+
data: response.data,
|
|
41
|
+
status: response.status,
|
|
42
|
+
statusText: response.statusText,
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
catch (error) {
|
|
46
|
+
throw error;
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
get(url, config) {
|
|
50
|
+
return this.request({ ...config, method: 'GET', url });
|
|
51
|
+
}
|
|
52
|
+
post(url, data, config) {
|
|
53
|
+
return this.request({ ...config, method: 'POST', url, data });
|
|
54
|
+
}
|
|
55
|
+
put(url, data, config) {
|
|
56
|
+
return this.request({ ...config, method: 'PUT', url, data });
|
|
57
|
+
}
|
|
58
|
+
delete(url, config) {
|
|
59
|
+
return this.request({ ...config, method: 'DELETE', url });
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
exports.FlexbeClient = FlexbeClient;
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { FlexbeAuthType } from '../types';
|
|
2
|
+
import { TokenManager } from './token-manager';
|
|
3
|
+
export class FlexbeAuth {
|
|
4
|
+
constructor(config) {
|
|
5
|
+
this.initialized = false;
|
|
6
|
+
this.initializationPromise = null;
|
|
7
|
+
this.config = config;
|
|
8
|
+
this.tokenManager = TokenManager.getInstance();
|
|
9
|
+
if (this.config.authType === FlexbeAuthType.BEARER) {
|
|
10
|
+
// Start initialization but don't wait for it
|
|
11
|
+
this.initializationPromise = this.initialize();
|
|
12
|
+
}
|
|
13
|
+
else {
|
|
14
|
+
this.initialized = true;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
async initialize() {
|
|
18
|
+
try {
|
|
19
|
+
const token = await this.tokenManager.getToken();
|
|
20
|
+
this.initialized = !!token;
|
|
21
|
+
}
|
|
22
|
+
catch (error) {
|
|
23
|
+
console.error('Failed to initialize auth:', error);
|
|
24
|
+
this.initialized = false;
|
|
25
|
+
}
|
|
26
|
+
finally {
|
|
27
|
+
this.initializationPromise = null;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
async ensureInitialized() {
|
|
31
|
+
if (this.config.authType !== FlexbeAuthType.BEARER || this.initialized) {
|
|
32
|
+
return;
|
|
33
|
+
}
|
|
34
|
+
// If initialization is in progress, wait for it
|
|
35
|
+
if (this.initializationPromise) {
|
|
36
|
+
await this.initializationPromise;
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
// If not initialized and no initialization in progress, start one
|
|
40
|
+
await this.initialize();
|
|
41
|
+
}
|
|
42
|
+
async getAuthHeaders() {
|
|
43
|
+
await this.ensureInitialized();
|
|
44
|
+
const headers = {
|
|
45
|
+
'Content-Type': 'application/json',
|
|
46
|
+
};
|
|
47
|
+
if (this.config.authType === FlexbeAuthType.API_KEY) {
|
|
48
|
+
headers['x-api-key'] = this.config.apiKey;
|
|
49
|
+
}
|
|
50
|
+
else if (this.config.authType === FlexbeAuthType.BEARER) {
|
|
51
|
+
const token = await this.tokenManager.getToken();
|
|
52
|
+
if (!token) {
|
|
53
|
+
throw new Error('No valid bearer token available');
|
|
54
|
+
}
|
|
55
|
+
headers['Authorization'] = `Bearer ${token}`;
|
|
56
|
+
}
|
|
57
|
+
return headers;
|
|
58
|
+
}
|
|
59
|
+
}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
export class Sandbox {
|
|
2
|
+
constructor(api, siteId) {
|
|
3
|
+
this.api = api;
|
|
4
|
+
this.siteId = siteId;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Create or get existing sandbox
|
|
8
|
+
* @param branch - Git branch name for the sandbox
|
|
9
|
+
* @returns Promise with sandbox details including URLs and token
|
|
10
|
+
* @throws {UnauthorizedException} When the API key is invalid or expired
|
|
11
|
+
* @throws {ForbiddenException} When the user does not have permission to access this site
|
|
12
|
+
* @throws {BadRequestException} When the request is invalid or failed to create sandbox
|
|
13
|
+
* @throws {ServerException} When the server encounters an error
|
|
14
|
+
* @throws {TimeoutException} When the request times out
|
|
15
|
+
*/
|
|
16
|
+
async create(branch) {
|
|
17
|
+
const request = { branch };
|
|
18
|
+
const response = await this.api.post(`/sites/${this.siteId}/app/sandbox`, request);
|
|
19
|
+
return response.data;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Delete sandbox
|
|
23
|
+
* @param sandboxId - The sandbox ID to delete
|
|
24
|
+
* @throws {UnauthorizedException} When the API key is invalid or expired
|
|
25
|
+
* @throws {ForbiddenException} When the user does not have permission to access this site
|
|
26
|
+
* @throws {BadRequestException} When the request is invalid or failed to delete sandbox
|
|
27
|
+
* @throws {NotFoundException} When the sandbox is not found
|
|
28
|
+
* @throws {ServerException} When the server encounters an error
|
|
29
|
+
* @throws {TimeoutException} When the request times out
|
|
30
|
+
*/
|
|
31
|
+
async delete(sandboxId) {
|
|
32
|
+
await this.api.delete(`/sites/${this.siteId}/app/sandbox/${sandboxId}`);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import { Pages } from './pages';
|
|
2
|
+
import { Sandbox } from './sandbox';
|
|
2
3
|
import { Stat } from './stat';
|
|
3
4
|
export class SiteApi {
|
|
4
5
|
constructor(api, siteId) {
|
|
5
6
|
this.pages = new Pages(api, siteId);
|
|
7
|
+
this.sandbox = new Sandbox(api, siteId);
|
|
6
8
|
this.stat = new Stat(api, siteId);
|
|
7
9
|
}
|
|
8
10
|
}
|
package/dist/esm/index.js
CHANGED
package/dist/esm/types/index.js
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
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("./types"), exports);
|
|
18
|
+
__exportStar(require("./client/flexbe-client"), exports);
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { AxiosRequestConfig } from 'axios';
|
|
2
|
+
import { FlexbeConfig, FlexbeResponse } from '../types';
|
|
3
|
+
import { PagesClient } from './pages-client';
|
|
4
|
+
export declare class FlexbeClient {
|
|
5
|
+
private readonly client;
|
|
6
|
+
private readonly config;
|
|
7
|
+
readonly pages: PagesClient;
|
|
8
|
+
constructor(config?: Partial<FlexbeConfig>);
|
|
9
|
+
private setupInterceptors;
|
|
10
|
+
private request;
|
|
11
|
+
private get;
|
|
12
|
+
private post;
|
|
13
|
+
private put;
|
|
14
|
+
private delete;
|
|
15
|
+
private getSiteUrl;
|
|
16
|
+
sitesGet<T>(path: string, config?: AxiosRequestConfig): Promise<FlexbeResponse<T>>;
|
|
17
|
+
sitesPost<T>(path: string, data?: unknown, config?: AxiosRequestConfig): Promise<FlexbeResponse<T>>;
|
|
18
|
+
sitesPut<T>(path: string, data?: unknown, config?: AxiosRequestConfig): Promise<FlexbeResponse<T>>;
|
|
19
|
+
sitesDelete<T>(path: string, config?: AxiosRequestConfig): Promise<FlexbeResponse<T>>;
|
|
20
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.FlexbeClient = void 0;
|
|
7
|
+
const axios_1 = __importDefault(require("axios"));
|
|
8
|
+
const pages_client_1 = require("./pages-client");
|
|
9
|
+
class FlexbeClient {
|
|
10
|
+
constructor(config) {
|
|
11
|
+
this.config = {
|
|
12
|
+
baseUrl: config?.baseUrl || process.env.FLEXBE_API_URL || 'https://api.flexbe.com',
|
|
13
|
+
timeout: config?.timeout || 30000,
|
|
14
|
+
apiKey: config?.apiKey || process.env.FLEXBE_API_KEY || '',
|
|
15
|
+
siteId: config?.siteId || process.env.FLEXBE_SITE_ID,
|
|
16
|
+
};
|
|
17
|
+
if (!this.config.apiKey) {
|
|
18
|
+
throw new Error('API key is required. Please provide it either through config or FLEXBE_API_KEY environment variable.');
|
|
19
|
+
}
|
|
20
|
+
this.client = axios_1.default.create({
|
|
21
|
+
baseURL: this.config.baseUrl,
|
|
22
|
+
timeout: this.config.timeout,
|
|
23
|
+
headers: {
|
|
24
|
+
'Authorization': `Bearer ${this.config.apiKey}`,
|
|
25
|
+
'Content-Type': 'application/json',
|
|
26
|
+
},
|
|
27
|
+
});
|
|
28
|
+
this.setupInterceptors();
|
|
29
|
+
this.pages = new pages_client_1.PagesClient(this);
|
|
30
|
+
}
|
|
31
|
+
setupInterceptors() {
|
|
32
|
+
this.client.interceptors.response.use((response) => response, (error) => {
|
|
33
|
+
const flexbeError = {
|
|
34
|
+
message: error.response?.data?.message || error.message,
|
|
35
|
+
code: error.response?.data?.code,
|
|
36
|
+
status: error.response?.status,
|
|
37
|
+
details: error.response?.data?.details,
|
|
38
|
+
};
|
|
39
|
+
return Promise.reject(flexbeError);
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
async request(config) {
|
|
43
|
+
try {
|
|
44
|
+
const response = await this.client.request(config);
|
|
45
|
+
return {
|
|
46
|
+
data: response.data,
|
|
47
|
+
status: response.status,
|
|
48
|
+
statusText: response.statusText,
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
catch (error) {
|
|
52
|
+
throw error;
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
get(url, config) {
|
|
56
|
+
return this.request({ ...config, method: 'GET', url });
|
|
57
|
+
}
|
|
58
|
+
post(url, data, config) {
|
|
59
|
+
return this.request({ ...config, method: 'POST', url, data });
|
|
60
|
+
}
|
|
61
|
+
put(url, data, config) {
|
|
62
|
+
return this.request({ ...config, method: 'PUT', url, data });
|
|
63
|
+
}
|
|
64
|
+
delete(url, config) {
|
|
65
|
+
return this.request({ ...config, method: 'DELETE', url });
|
|
66
|
+
}
|
|
67
|
+
getSiteUrl(path) {
|
|
68
|
+
if (!this.config.siteId) {
|
|
69
|
+
return path;
|
|
70
|
+
}
|
|
71
|
+
return `/sites/${this.config.siteId}${path}`;
|
|
72
|
+
}
|
|
73
|
+
sitesGet(path, config) {
|
|
74
|
+
return this.get(this.getSiteUrl(path), config);
|
|
75
|
+
}
|
|
76
|
+
sitesPost(path, data, config) {
|
|
77
|
+
return this.post(this.getSiteUrl(path), data, config);
|
|
78
|
+
}
|
|
79
|
+
sitesPut(path, data, config) {
|
|
80
|
+
return this.put(this.getSiteUrl(path), data, config);
|
|
81
|
+
}
|
|
82
|
+
sitesDelete(path, config) {
|
|
83
|
+
return this.delete(this.getSiteUrl(path), config);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
exports.FlexbeClient = FlexbeClient;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { Page, GetPagesParams, PageListResponse } from '../types/pages';
|
|
2
|
+
import { FlexbeClient } from './flexbe-client';
|
|
3
|
+
export declare class PagesClient {
|
|
4
|
+
private readonly client;
|
|
5
|
+
constructor(client: FlexbeClient);
|
|
6
|
+
/**
|
|
7
|
+
* Get list of pages for a site
|
|
8
|
+
*/
|
|
9
|
+
getPages(params?: GetPagesParams): Promise<PageListResponse>;
|
|
10
|
+
/**
|
|
11
|
+
* Get a single page by ID
|
|
12
|
+
*/
|
|
13
|
+
getPage(pageId: number): Promise<Page>;
|
|
14
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PagesClient = void 0;
|
|
4
|
+
class PagesClient {
|
|
5
|
+
constructor(client) {
|
|
6
|
+
this.client = client;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Get list of pages for a site
|
|
10
|
+
*/
|
|
11
|
+
async getPages(params) {
|
|
12
|
+
const response = await this.client.sitesGet('/pages', { params });
|
|
13
|
+
return response.data;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Get a single page by ID
|
|
17
|
+
*/
|
|
18
|
+
async getPage(pageId) {
|
|
19
|
+
const response = await this.client.sitesGet(`/pages/${pageId}`);
|
|
20
|
+
return response.data;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
exports.PagesClient = PagesClient;
|
|
@@ -0,0 +1,20 @@
|
|
|
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("./client/flexbe-client"), exports);
|
|
18
|
+
__exportStar(require("./client/pages-client"), exports);
|
|
19
|
+
__exportStar(require("./types"), exports);
|
|
20
|
+
__exportStar(require("./types/pages"), exports);
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export interface FlexbeConfig {
|
|
2
|
+
apiKey?: string;
|
|
3
|
+
baseUrl?: string;
|
|
4
|
+
timeout?: number;
|
|
5
|
+
siteId?: string;
|
|
6
|
+
}
|
|
7
|
+
export interface FlexbeResponse<T> {
|
|
8
|
+
data: T;
|
|
9
|
+
status: number;
|
|
10
|
+
statusText: string;
|
|
11
|
+
}
|
|
12
|
+
export interface FlexbeErrorResponse {
|
|
13
|
+
message: string;
|
|
14
|
+
code?: string;
|
|
15
|
+
details?: unknown;
|
|
16
|
+
}
|
|
17
|
+
export interface FlexbeError {
|
|
18
|
+
message: string;
|
|
19
|
+
code?: string;
|
|
20
|
+
status?: number;
|
|
21
|
+
details?: unknown;
|
|
22
|
+
}
|
|
23
|
+
export type FlexbeAuthType = 'apiKey' | 'bearer' | 'oauth2';
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
export declare enum PageType {
|
|
2
|
+
PAGE = "page",
|
|
3
|
+
FILE = "file",
|
|
4
|
+
GLOBAL = "global",
|
|
5
|
+
AI = "ai",
|
|
6
|
+
CMS = "cms",
|
|
7
|
+
ECOMMERCE_PRODUCT = "ecommerce_product",
|
|
8
|
+
ECOMMERCE_CATEGORY = "ecommerce_category"
|
|
9
|
+
}
|
|
10
|
+
export declare enum PageStatus {
|
|
11
|
+
PUBLISHED = "published",
|
|
12
|
+
DRAFTED = "drafted",
|
|
13
|
+
DELETED = "deleted"
|
|
14
|
+
}
|
|
15
|
+
export interface Page {
|
|
16
|
+
id: number;
|
|
17
|
+
siteId: number;
|
|
18
|
+
type: PageType;
|
|
19
|
+
uri: string;
|
|
20
|
+
title: string | null;
|
|
21
|
+
status: PageStatus;
|
|
22
|
+
updatedAt?: Date;
|
|
23
|
+
imgId: number | null;
|
|
24
|
+
sortIndex: number;
|
|
25
|
+
}
|
|
26
|
+
export interface GetPagesParams {
|
|
27
|
+
offset?: number;
|
|
28
|
+
limit?: number;
|
|
29
|
+
type?: PageType;
|
|
30
|
+
status?: PageStatus;
|
|
31
|
+
search?: string;
|
|
32
|
+
}
|
|
33
|
+
export interface Pagination {
|
|
34
|
+
limit: number;
|
|
35
|
+
offset: number;
|
|
36
|
+
total: number;
|
|
37
|
+
}
|
|
38
|
+
export interface PageListResponse {
|
|
39
|
+
pages: Page[];
|
|
40
|
+
pagination: Pagination;
|
|
41
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.PageStatus = exports.PageType = void 0;
|
|
4
|
+
var PageType;
|
|
5
|
+
(function (PageType) {
|
|
6
|
+
PageType["PAGE"] = "page";
|
|
7
|
+
PageType["FILE"] = "file";
|
|
8
|
+
PageType["GLOBAL"] = "global";
|
|
9
|
+
PageType["AI"] = "ai";
|
|
10
|
+
PageType["CMS"] = "cms";
|
|
11
|
+
PageType["ECOMMERCE_PRODUCT"] = "ecommerce_product";
|
|
12
|
+
PageType["ECOMMERCE_CATEGORY"] = "ecommerce_category";
|
|
13
|
+
})(PageType || (exports.PageType = PageType = {}));
|
|
14
|
+
var PageStatus;
|
|
15
|
+
(function (PageStatus) {
|
|
16
|
+
PageStatus["PUBLISHED"] = "published";
|
|
17
|
+
PageStatus["DRAFTED"] = "drafted";
|
|
18
|
+
PageStatus["DELETED"] = "deleted";
|
|
19
|
+
})(PageStatus || (exports.PageStatus = PageStatus = {}));
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const flexbe_client_1 = require("../../src/client/flexbe-client");
|
|
4
|
+
describe('FlexbeClient', () => {
|
|
5
|
+
let client;
|
|
6
|
+
const testConfig = {
|
|
7
|
+
apiKey: process.env.FLEXBE_API_KEY || 'test-api-key',
|
|
8
|
+
baseUrl: process.env.FLEXBE_API_URL || 'https://api.flexbe.com',
|
|
9
|
+
};
|
|
10
|
+
beforeEach(() => {
|
|
11
|
+
client = new flexbe_client_1.FlexbeClient(testConfig);
|
|
12
|
+
});
|
|
13
|
+
it('should initialize with correct configuration', () => {
|
|
14
|
+
expect(client).toBeDefined();
|
|
15
|
+
const axiosInstance = client.client;
|
|
16
|
+
expect(axiosInstance.defaults.baseURL).toBe(testConfig.baseUrl);
|
|
17
|
+
expect(axiosInstance.defaults.headers.Authorization).toBe(`Bearer ${testConfig.apiKey}`);
|
|
18
|
+
});
|
|
19
|
+
it('should handle successful GET request', async () => {
|
|
20
|
+
// Access protected method for testing
|
|
21
|
+
const response = await client.get('/');
|
|
22
|
+
expect(response).toBeDefined();
|
|
23
|
+
expect(response.status).toBe(200);
|
|
24
|
+
expect(response.data).toBeDefined();
|
|
25
|
+
});
|
|
26
|
+
it('should handle error response', async () => {
|
|
27
|
+
try {
|
|
28
|
+
// Access protected method for testing
|
|
29
|
+
await client.get('/non-existent-endpoint');
|
|
30
|
+
fail('Should have thrown an error');
|
|
31
|
+
}
|
|
32
|
+
catch (error) {
|
|
33
|
+
const flexbeError = error;
|
|
34
|
+
expect(flexbeError.message).toBeDefined();
|
|
35
|
+
expect(flexbeError.status).toBeDefined();
|
|
36
|
+
}
|
|
37
|
+
});
|
|
38
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const flexbe_client_1 = require("../../src/client/flexbe-client");
|
|
4
|
+
const pages_1 = require("../../src/types/pages");
|
|
5
|
+
describe('PagesClient', () => {
|
|
6
|
+
let client;
|
|
7
|
+
const testConfig = {
|
|
8
|
+
apiKey: process.env.FLEXBE_API_KEY || 'test-api-key',
|
|
9
|
+
baseUrl: process.env.FLEXBE_API_URL || 'https://api.flexbe.com',
|
|
10
|
+
siteId: process.env.FLEXBE_SITE_ID || '0',
|
|
11
|
+
};
|
|
12
|
+
beforeEach(() => {
|
|
13
|
+
client = new flexbe_client_1.FlexbeClient(testConfig);
|
|
14
|
+
});
|
|
15
|
+
it('should initialize with correct configuration', () => {
|
|
16
|
+
expect(client.pages).toBeDefined();
|
|
17
|
+
const axiosInstance = client.client;
|
|
18
|
+
expect(axiosInstance.defaults.baseURL).toBe(testConfig.baseUrl);
|
|
19
|
+
expect(axiosInstance.defaults.headers.Authorization).toBe(`Bearer ${testConfig.apiKey}`);
|
|
20
|
+
});
|
|
21
|
+
it('should get list of pages with default parameters', async () => {
|
|
22
|
+
const response = await client.pages.getPages();
|
|
23
|
+
expect(response).toBeDefined();
|
|
24
|
+
expect(response.pages).toBeDefined();
|
|
25
|
+
expect(response.pagination).toBeDefined();
|
|
26
|
+
expect(response.pagination.limit).toBe(10);
|
|
27
|
+
expect(response.pagination.offset).toBe(0);
|
|
28
|
+
expect(response.pagination.total).toBeDefined();
|
|
29
|
+
});
|
|
30
|
+
it('should get list of pages with custom parameters', async () => {
|
|
31
|
+
const params = {
|
|
32
|
+
offset: 0,
|
|
33
|
+
limit: 20,
|
|
34
|
+
type: pages_1.PageType.PAGE,
|
|
35
|
+
status: pages_1.PageStatus.PUBLISHED,
|
|
36
|
+
search: ''
|
|
37
|
+
};
|
|
38
|
+
const response = await client.pages.getPages(params);
|
|
39
|
+
expect(response).toBeDefined();
|
|
40
|
+
expect(response.pages).toBeDefined();
|
|
41
|
+
expect(response.pagination).toBeDefined();
|
|
42
|
+
expect(response.pagination.limit).toBe(params.limit);
|
|
43
|
+
expect(response.pagination.offset).toBe(params.offset);
|
|
44
|
+
expect(response.pagination.total).toBeDefined();
|
|
45
|
+
});
|
|
46
|
+
it('should get a single page by ID', async () => {
|
|
47
|
+
const pageId = 2272741;
|
|
48
|
+
const response = await client.pages.getPage(pageId);
|
|
49
|
+
expect(response).toBeDefined();
|
|
50
|
+
expect(response.id).toBe(pageId);
|
|
51
|
+
expect(response.siteId).toBe(Number(testConfig.siteId));
|
|
52
|
+
expect(response.type).toBeDefined();
|
|
53
|
+
expect(response.uri).toBeDefined();
|
|
54
|
+
expect(response.status).toBeDefined();
|
|
55
|
+
expect(response.sortIndex).toBeDefined();
|
|
56
|
+
});
|
|
57
|
+
it('should handle error when getting non-existent page', async () => {
|
|
58
|
+
try {
|
|
59
|
+
await client.pages.getPage(999999);
|
|
60
|
+
fail('Should have thrown an error');
|
|
61
|
+
}
|
|
62
|
+
catch (error) {
|
|
63
|
+
const flexbeError = error;
|
|
64
|
+
expect(flexbeError.message).toBeDefined();
|
|
65
|
+
expect(flexbeError.status).toBeDefined();
|
|
66
|
+
}
|
|
67
|
+
});
|
|
68
|
+
it('should handle error when getting pages with invalid parameters', async () => {
|
|
69
|
+
try {
|
|
70
|
+
await client.pages.getPages({
|
|
71
|
+
offset: -1,
|
|
72
|
+
limit: 0
|
|
73
|
+
});
|
|
74
|
+
fail('Should have thrown an error');
|
|
75
|
+
}
|
|
76
|
+
catch (error) {
|
|
77
|
+
const flexbeError = error;
|
|
78
|
+
expect(flexbeError.message).toBeDefined();
|
|
79
|
+
expect(flexbeError.status).toBeDefined();
|
|
80
|
+
}
|
|
81
|
+
});
|
|
82
|
+
});
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { FlexbeConfig } from '../types';
|
|
2
|
+
export declare class FlexbeAuth {
|
|
3
|
+
private readonly config;
|
|
4
|
+
private readonly tokenManager;
|
|
5
|
+
private initialized;
|
|
6
|
+
private initializationPromise;
|
|
7
|
+
constructor(config: FlexbeConfig);
|
|
8
|
+
private initialize;
|
|
9
|
+
ensureInitialized(): Promise<void>;
|
|
10
|
+
getAuthHeaders(): Promise<Record<string, string>>;
|
|
11
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import type { ApiClient } from './api-client';
|
|
2
|
+
import type { SandboxResponse } from '../types/sandbox';
|
|
3
|
+
export declare class Sandbox {
|
|
4
|
+
private readonly api;
|
|
5
|
+
private readonly siteId;
|
|
6
|
+
constructor(api: ApiClient, siteId: number);
|
|
7
|
+
/**
|
|
8
|
+
* Create or get existing sandbox
|
|
9
|
+
* @param branch - Git branch name for the sandbox
|
|
10
|
+
* @returns Promise with sandbox details including URLs and token
|
|
11
|
+
* @throws {UnauthorizedException} When the API key is invalid or expired
|
|
12
|
+
* @throws {ForbiddenException} When the user does not have permission to access this site
|
|
13
|
+
* @throws {BadRequestException} When the request is invalid or failed to create sandbox
|
|
14
|
+
* @throws {ServerException} When the server encounters an error
|
|
15
|
+
* @throws {TimeoutException} When the request times out
|
|
16
|
+
*/
|
|
17
|
+
create(branch: string): Promise<SandboxResponse>;
|
|
18
|
+
/**
|
|
19
|
+
* Delete sandbox
|
|
20
|
+
* @param sandboxId - The sandbox ID to delete
|
|
21
|
+
* @throws {UnauthorizedException} When the API key is invalid or expired
|
|
22
|
+
* @throws {ForbiddenException} When the user does not have permission to access this site
|
|
23
|
+
* @throws {BadRequestException} When the request is invalid or failed to delete sandbox
|
|
24
|
+
* @throws {NotFoundException} When the sandbox is not found
|
|
25
|
+
* @throws {ServerException} When the server encounters an error
|
|
26
|
+
* @throws {TimeoutException} When the request times out
|
|
27
|
+
*/
|
|
28
|
+
delete(sandboxId: string): Promise<void>;
|
|
29
|
+
}
|
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
import { Pages } from './pages';
|
|
2
|
+
import { Sandbox } from './sandbox';
|
|
2
3
|
import { Stat } from './stat';
|
|
3
4
|
import type { ApiClient } from './api-client';
|
|
4
5
|
export declare class SiteApi {
|
|
5
6
|
readonly pages: Pages;
|
|
7
|
+
readonly sandbox: Sandbox;
|
|
6
8
|
readonly stat: Stat;
|
|
7
9
|
constructor(api: ApiClient, siteId: number);
|
|
8
10
|
}
|
package/dist/types/index.d.ts
CHANGED