caprover-api 0.0.1

package/dist/api/ErrorFactory.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ErrorFactory {
+    constructor() {
+        this.OKAY = 100;
+        this.OKAY_BUILD_STARTED = 101;
+        this.OK_PARTIALLY = 102;
+        this.STATUS_ERROR_GENERIC = 1000;
+        this.STATUS_ERROR_CAPTAIN_NOT_INITIALIZED = 1001;
+        this.STATUS_ERROR_USER_NOT_INITIALIZED = 1101;
+        this.STATUS_ERROR_NOT_AUTHORIZED = 1102;
+        this.STATUS_ERROR_ALREADY_EXIST = 1103;
+        this.STATUS_ERROR_BAD_NAME = 1104;
+        this.STATUS_WRONG_PASSWORD = 1105;
+        this.STATUS_AUTH_TOKEN_INVALID = 1106;
+        this.VERIFICATION_FAILED = 1107;
+        this.ILLEGAL_OPERATION = 1108;
+        this.BUILD_ERROR = 1109;
+        this.ILLEGAL_PARAMETER = 1110;
+        this.NOT_FOUND = 1111;
+        this.AUTHENTICATION_FAILED = 1112;
+        this.STATUS_PASSWORD_BACK_OFF = 1113;
+        this.STATUS_ERROR_OTP_REQUIRED = 1114;
+        this.UNKNOWN_ERROR = 1999;
+    }
+    createError(status, message) {
+        let e = new Error(message || 'null');
+        e.captainStatus = status;
+        e.captainMessage = message;
+        return e;
+    }
+}
+ErrorFactory.STATUS_ERROR_PRO_API_KEY_INVALIDATED = 1115;
+const errorFactory = new ErrorFactory();
+exports.default = errorFactory;

package/dist/api/HttpClient.d.ts

@@ -0,0 +1,16 @@
+export default class HttpClient {
+    private baseUrl;
+    private onAuthFailure;
+    readonly GET = "GET";
+    readonly POST = "POST";
+    isDestroyed: boolean;
+    private authToken;
+    constructor(baseUrl: string, onAuthFailure: () => Promise<string>);
+    createHeaders(): any;
+    setAuthToken(authToken: string): void;
+    destroy(): void;
+    fetch(method: 'GET' | 'POST', endpoint: string, variables: any): () => Promise<any>;
+    fetchInternal(method: 'GET' | 'POST', endpoint: string, variables: any): Promise<import("axios").AxiosResponse<any, any>>;
+    getReq(endpoint: string, variables: any): Promise<import("axios").AxiosResponse<any, any>>;
+    postReq(endpoint: string, variables: any): Promise<import("axios").AxiosResponse<any, any>>;
+}

package/dist/api/HttpClient.js

@@ -0,0 +1,130 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const ErrorFactory_1 = __importDefault(require("./ErrorFactory"));
+let TOKEN_HEADER = 'x-captain-auth';
+let NAMESPACE = 'x-namespace';
+let CAPTAIN = 'captain';
+class HttpClient {
+    constructor(baseUrl, onAuthFailure) {
+        this.baseUrl = baseUrl;
+        this.onAuthFailure = onAuthFailure;
+        this.GET = 'GET';
+        this.POST = 'POST';
+        this.isDestroyed = false;
+        this.authToken = '';
+        //
+    }
+    createHeaders() {
+        let headers = {};
+        if (this.authToken)
+            headers[TOKEN_HEADER] = this.authToken;
+        headers[NAMESPACE] = CAPTAIN;
+        // check user/appData or apiManager.uploadAppData before changing this signature.
+        return headers;
+    }
+    setAuthToken(authToken) {
+        this.authToken = authToken;
+    }
+    destroy() {
+        this.isDestroyed = true;
+    }
+    fetch(method, endpoint, variables) {
+        const self = this;
+        return function () {
+            return Promise.resolve() //
+                .then(function () {
+                return self.fetchInternal(method, endpoint, variables); //
+            })
+                .then(function (axiosResponse) {
+                const data = axiosResponse.data; // this is an axios thing!
+                if (data.status === ErrorFactory_1.default.STATUS_AUTH_TOKEN_INVALID) {
+                    return self
+                        .onAuthFailure() //
+                        .then(function (authToken) {
+                        self.setAuthToken(authToken);
+                        return self
+                            .fetchInternal(method, endpoint, variables)
+                            .then(function (newAxiosResponse) {
+                            return newAxiosResponse.data;
+                        });
+                    })
+                        .catch(function (error) {
+                        // Upon wrong password or back-off error, we force logout the user
+                        // to avoid getting stuck with wrong password loop
+                        if (error.captainStatus + '' ===
+                            ErrorFactory_1.default.STATUS_PASSWORD_BACK_OFF +
+                                '' ||
+                            error.captainStatus + '' ===
+                                ErrorFactory_1.default.STATUS_WRONG_PASSWORD + '') {
+                            self.setAuthToken('');
+                        }
+                        return Promise.reject(error);
+                    });
+                }
+                else {
+                    return data;
+                }
+            })
+                .then(function (data) {
+                if (data.status !== ErrorFactory_1.default.OKAY &&
+                    data.status !== ErrorFactory_1.default.OK_PARTIALLY &&
+                    data.status !== ErrorFactory_1.default.OKAY_BUILD_STARTED) {
+                    throw ErrorFactory_1.default.createError(data.status || ErrorFactory_1.default.UNKNOWN_ERROR, data.description || '');
+                }
+                return data;
+            })
+                .then(function (data) {
+                // These two blocks are clearly memory leaks! But I don't have time to fix them now... I need to CANCEL the promise, but since I don't
+                // have CANCEL method on the native Promise, I return a promise that will never RETURN if the HttpClient is destroyed.
+                // Will fix them later... but it shouldn't be a big deal anyways as it's only a problem when user navigates away from a page before the
+                // network request returns back.
+                return new Promise(function (resolve, reject) {
+                    // data.data here is the "data" field inside the API response! {status: 100, description: "Login succeeded", data: {…}}
+                    if (!self.isDestroyed)
+                        return resolve(data.data);
+                });
+            })
+                .catch(function (error) {
+                return new Promise(function (resolve, reject) {
+                    if (!self.isDestroyed)
+                        return reject(error);
+                });
+            });
+        };
+    }
+    fetchInternal(method, endpoint, variables) {
+        if (method === this.GET)
+            return this.getReq(endpoint, variables);
+        if (method === this.POST)
+            return this.postReq(endpoint, variables);
+        throw new Error(`Unknown method: ${method}`);
+    }
+    getReq(endpoint, variables) {
+        const self = this;
+        return axios_1.default
+            .get(this.baseUrl + endpoint, {
+            params: variables,
+            headers: self.createHeaders(),
+        }) //
+            .then(function (data) {
+            // console.log(data);
+            return data;
+        });
+    }
+    postReq(endpoint, variables) {
+        const self = this;
+        return axios_1.default
+            .post(this.baseUrl + endpoint, variables, {
+            headers: self.createHeaders(),
+        }) //
+            .then(function (data) {
+            // console.log(data);
+            return data;
+        });
+    }
+}
+exports.default = HttpClient;

package/dist/example.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/example.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = __importDefault(require("./index"));
+const caprover = new index_1.default('https://captain.server.demo.caprover.com', () => {
+    // get password and otp from user
+    return Promise.resolve({
+        password: 'captain42',
+        otpToken: undefined,
+    });
+});
+console.log('===============================================');
+Promise.resolve()
+    .then(() => {
+    return caprover.getAllNodes();
+})
+    .then((response) => {
+    console.log('=============================================== getAllNodes:');
+    console.log(response);
+    return caprover.getDockerRegistries();
+})
+    .then((response) => {
+    console.log('=============================================== getDockerRegistries:');
+    console.log(response);
+})
+    .catch((error) => {
+    console.log(error);
+});

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import CapRoverAPI from './api/ApiManager';
+import * as CapRoverModels from './models';
+export default CapRoverAPI;
+export { CapRoverModels };

package/dist/index.js

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CapRoverModels = void 0;
+const ApiManager_1 = __importDefault(require("./api/ApiManager"));
+const CapRoverModels = __importStar(require("./models"));
+exports.CapRoverModels = CapRoverModels;
+exports.default = ApiManager_1.default;

package/dist/models/AppDefinition.d.ts

@@ -0,0 +1,105 @@
+import { IHashMapGeneric } from './IHashMapGeneric';
+export type IAllAppDefinitions = IHashMapGeneric<IAppDef>;
+export interface IAppEnvVar {
+    key: string;
+    value: string;
+}
+export declare const enum VolumesTypes {
+    BIND = "bind",
+    VOLUME = "volume"
+}
+export interface IAppVolume {
+    containerPath: string;
+    volumeName?: string;
+    hostPath?: string;
+    mode?: string;
+}
+export interface IAppPort {
+    containerPort: number;
+    hostPort: number;
+    protocol?: 'udp' | 'tcp';
+    publishMode?: 'ingress' | 'host';
+}
+export interface RepoInfo {
+    repo: string;
+    branch: string;
+    user: string;
+    sshKey?: string;
+    password: string;
+}
+export interface RepoInfoEncrypted {
+    repo: string;
+    branch: string;
+    user: string;
+    sshKeyEncrypted?: string;
+    passwordEncrypted: string;
+}
+export interface IAppVersion {
+    version: number;
+    deployedImageName?: string;
+    timeStamp: string;
+    gitHash: string | undefined;
+}
+export interface IAppCustomDomain {
+    publicDomain: string;
+    hasSsl: boolean;
+}
+export interface IAppTag {
+    tagName: string;
+}
+export interface IAppDefinitionBase {
+    projectId?: string | undefined;
+    description: string;
+    deployedVersion: number;
+    notExposeAsWebApp: boolean;
+    hasPersistentData: boolean;
+    hasDefaultSubDomainSsl: boolean;
+    containerHttpPort?: number;
+    captainDefinitionRelativeFilePath: string;
+    forceSsl: boolean;
+    websocketSupport: boolean;
+    nodeId?: string;
+    instanceCount: number;
+    preDeployFunction?: string;
+    serviceUpdateOverride?: string;
+    customNginxConfig?: string;
+    redirectDomain?: string;
+    networks: string[];
+    customDomain: IAppCustomDomain[];
+    tags?: IAppTag[];
+    ports: IAppPort[];
+    volumes: IAppVolume[];
+    envVars: IAppEnvVar[];
+    versions: IAppVersion[];
+    appDeployTokenConfig?: AppDeployTokenConfig;
+}
+export interface IHttpAuth {
+    user: string;
+    password?: string;
+    passwordHashed?: string;
+}
+export interface AppDeployTokenConfig {
+    enabled: boolean;
+    appDeployToken?: string;
+}
+export interface IAppDef extends IAppDefinitionBase {
+    appPushWebhook?: {
+        tokenVersion: string;
+        repoInfo: RepoInfo;
+        pushWebhookToken: string;
+    };
+    httpAuth?: IHttpAuth;
+    appName?: string;
+    isAppBuilding?: boolean;
+}
+export interface IAppDefSaved extends IAppDefinitionBase {
+    appPushWebhook: {
+        tokenVersion: string;
+        repoInfo: RepoInfoEncrypted;
+        pushWebhookToken: string;
+    } | undefined;
+    httpAuth?: {
+        user: string;
+        passwordHashed: string;
+    };
+}

package/dist/models/AppDefinition.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/AppDefinitionsResponse.d.ts

@@ -0,0 +1,7 @@
+import { IAppDef } from './AppDefinition';
+export default interface AppDefinitionsResponse {
+    appDefinitions: IAppDef[];
+    rootDomain: string;
+    captainSubDomain: string;
+    defaultNginxConfig: string;
+}

package/dist/models/AppDefinitionsResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/AppDeleteResponse.d.ts

@@ -0,0 +1,3 @@
+export default interface AppDeleteResponse {
+    volumesFailedToDelete?: string[];
+}

package/dist/models/AppDeleteResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/AutomatedCleanupConfigs.d.ts

@@ -0,0 +1,12 @@
+export interface IAutomatedCleanupConfigs {
+    mostRecentLimit: number;
+    cronSchedule: string;
+    timezone: string;
+}
+export declare class AutomatedCleanupConfigsCleaner {
+    static sanitizeInput(instance: IAutomatedCleanupConfigs): {
+        mostRecentLimit: number;
+        cronSchedule: string;
+        timezone: string;
+    };
+}

package/dist/models/AutomatedCleanupConfigs.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutomatedCleanupConfigsCleaner = void 0;
+class AutomatedCleanupConfigsCleaner {
+    static sanitizeInput(instance) {
+        return {
+            mostRecentLimit: Number(instance.mostRecentLimit) > 0
+                ? Number(instance.mostRecentLimit)
+                : 1,
+            cronSchedule: `${instance.cronSchedule || ''}`.trim(),
+            timezone: `${instance.timezone || ''}`.trim() || 'UTC',
+        };
+    }
+}
+exports.AutomatedCleanupConfigsCleaner = AutomatedCleanupConfigsCleaner;

package/dist/models/BackupMeta.d.ts

@@ -0,0 +1,19 @@
+import { ServerDockerInfo } from './ServerDockerInfo';
+export interface RestoringNode {
+    oldIp: string;
+    newIp: string;
+    user: string;
+    privateKeyPath: string;
+}
+export interface OldNodesForReference {
+    appsLockOnThisNode: string[];
+    nodeData: ServerDockerInfo;
+}
+export interface RestoringInfo {
+    nodesMapping: RestoringNode[];
+    oldNodesForReference: OldNodesForReference[];
+}
+export interface BackupMeta {
+    salt: string;
+    nodes: ServerDockerInfo[];
+}

package/dist/models/BackupMeta.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/BuildLogsResponse.d.ts

@@ -0,0 +1,8 @@
+export interface BuildLogsResponse {
+    isAppBuilding: boolean;
+    logs: {
+        lines: string[];
+        firstLineNumber: number;
+    };
+    isBuildFailed: boolean;
+}

package/dist/models/BuildLogsResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/CapRoverTheme.d.ts

@@ -0,0 +1,10 @@
+export interface CapRoverExtraTheme {
+    siderTheme?: string;
+}
+export default interface CapRoverTheme {
+    content: string;
+    name: string;
+    extra?: string;
+    headEmbed?: string;
+    builtIn?: boolean;
+}

package/dist/models/CapRoverTheme.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/CaptainInfo.d.ts

@@ -0,0 +1,6 @@
+export default interface CaptainInfo {
+    hasRootSsl: boolean;
+    forceSsl: boolean;
+    rootDomain: string;
+    captainSubDomain: string;
+}

package/dist/models/CaptainInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/ContainerProps.d.ts

@@ -0,0 +1,3 @@
+export interface IMobileComponent {
+    isMobile: boolean;
+}

package/dist/models/ContainerProps.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/DockerAuthObj.d.ts

@@ -0,0 +1,11 @@
+export interface DockerAuthObj {
+    serveraddress: string;
+    username: string;
+    password: string;
+}
+export interface DockerRegistryConfig {
+    [serveraddress: string]: {
+        username: string;
+        password: string;
+    };
+}

package/dist/models/DockerAuthObj.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/DockerSecret.d.ts

@@ -0,0 +1,4 @@
+export interface DockerSecret {
+    secretName: string;
+    secretId: string;
+}

package/dist/models/DockerSecret.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/DockerService.d.ts

@@ -0,0 +1,99 @@
+export interface Version {
+    Index: number;
+}
+export interface Labels {
+    [id: string]: string;
+}
+export interface Mount {
+    Type: string;
+    Source: string;
+    Target: string;
+}
+export interface ContainerSpecType {
+    Image: string;
+    Env: string[];
+    Mounts: Mount[];
+    Isolation: string;
+}
+export interface Resources {
+    Limits: {
+        MemoryBytes: number;
+        NanoCPUs: number;
+    };
+    Reservations: {
+        MemoryBytes: number;
+        NanoCPUs: number;
+    };
+}
+export interface Placement {
+    Constraints: string[];
+}
+export interface Options {
+    'max-size': string;
+}
+export interface LogDriver {
+    Name: string;
+    Options: Options;
+}
+export interface TaskTemplate {
+    ContainerSpec: ContainerSpecType;
+    Resources: Resources;
+    Placement: Placement;
+    LogDriver: LogDriver;
+    ForceUpdate: number;
+    Runtime: string;
+}
+export interface Replicated {
+    Replicas: number;
+}
+export interface Mode {
+    Replicated: Replicated;
+}
+export interface Port {
+    Protocol: string;
+    TargetPort: number;
+    PublishedPort: number;
+    PublishMode: string;
+}
+export interface EndpointSpec {
+    Mode: string;
+    Ports: Port[];
+}
+export interface Spec {
+    Name: string;
+    Labels: Labels;
+    TaskTemplate: TaskTemplate;
+    Mode: Mode;
+    EndpointSpec: EndpointSpec;
+}
+export interface PreviousSpec {
+    Name: string;
+    Labels: Labels;
+    TaskTemplate: TaskTemplate;
+    Mode: Mode;
+    EndpointSpec: EndpointSpec;
+}
+export interface VirtualIP {
+    NetworkID: string;
+    Addr: string;
+}
+export interface Endpoint {
+    Spec: Spec;
+    Ports: Port[];
+    VirtualIPs: VirtualIP[];
+}
+export interface UpdateStatus {
+    State: string;
+    StartedAt: string;
+    Message: string;
+}
+export default interface DockerService {
+    ID: string;
+    Version: Version;
+    CreatedAt: string;
+    UpdatedAt: string;
+    Spec: Spec;
+    PreviousSpec: PreviousSpec;
+    Endpoint: Endpoint;
+    UpdateStatus: UpdateStatus;
+}

package/dist/models/DockerService.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/GoAccessInfo.d.ts

@@ -0,0 +1,7 @@
+export interface GoAccessInfo {
+    isEnabled: boolean;
+    data: {
+        rotationFrequencyCron: string;
+        logRetentionDays: number;
+    };
+}

package/dist/models/GoAccessInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/GoAccessReportResponse.d.ts

@@ -0,0 +1,6 @@
+export default interface GoAccessReportResponse {
+    domainName: string;
+    name: string;
+    lastModifiedTime: Date;
+    url: string;
+}

package/dist/models/GoAccessReportResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/models/IBuiltImage.d.ts

@@ -0,0 +1,4 @@
+export interface IBuiltImage {
+    imageName: string;
+    gitHash: string;
+}

package/dist/models/IBuiltImage.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });