caprover-api 0.0.1

package/src/api/ErrorFactory.ts

@@ -0,0 +1,35 @@
+class ErrorFactory {
+    public readonly OKAY = 100
+    public readonly OKAY_BUILD_STARTED = 101
+    public readonly OK_PARTIALLY = 102
+
+    public readonly STATUS_ERROR_GENERIC = 1000
+    public readonly STATUS_ERROR_CAPTAIN_NOT_INITIALIZED = 1001
+    public readonly STATUS_ERROR_USER_NOT_INITIALIZED = 1101
+    public readonly STATUS_ERROR_NOT_AUTHORIZED = 1102
+    public readonly STATUS_ERROR_ALREADY_EXIST = 1103
+    public readonly STATUS_ERROR_BAD_NAME = 1104
+    public readonly STATUS_WRONG_PASSWORD = 1105
+    public readonly STATUS_AUTH_TOKEN_INVALID = 1106
+    public readonly VERIFICATION_FAILED = 1107
+    public readonly ILLEGAL_OPERATION = 1108
+    public readonly BUILD_ERROR = 1109
+    public readonly ILLEGAL_PARAMETER = 1110
+    public readonly NOT_FOUND = 1111
+    public readonly AUTHENTICATION_FAILED = 1112
+    public readonly STATUS_PASSWORD_BACK_OFF = 1113
+    public readonly STATUS_ERROR_OTP_REQUIRED = 1114
+    static readonly STATUS_ERROR_PRO_API_KEY_INVALIDATED = 1115
+    public readonly UNKNOWN_ERROR = 1999
+
+    createError(status: number, message: string) {
+        let e = new Error(message || 'null') as any
+        e.captainStatus = status
+        e.captainMessage = message
+        return e
+    }
+}
+
+const errorFactory = new ErrorFactory()
+
+export default errorFactory

package/src/api/HttpClient.ts

@@ -0,0 +1,143 @@
+import axios from 'axios'
+import ErrorFactory from './ErrorFactory'
+
+let TOKEN_HEADER = 'x-captain-auth'
+let NAMESPACE = 'x-namespace'
+let CAPTAIN = 'captain'
+
+export default class HttpClient {
+    public readonly GET = 'GET'
+    public readonly POST = 'POST'
+    public isDestroyed = false
+    private authToken: string = ''
+
+    constructor(
+        private baseUrl: string,
+        private onAuthFailure: () => Promise<string>
+    ) {
+        //
+    }
+
+    createHeaders() {
+        let headers: any = {}
+        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: string) {
+        this.authToken = authToken
+    }
+
+    destroy() {
+        this.isDestroyed = true
+    }
+
+    fetch(method: 'GET' | 'POST', endpoint: string, variables: any) {
+        const self = this
+        return function (): Promise<any> {
+            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.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.STATUS_PASSWORD_BACK_OFF +
+                                            '' ||
+                                    error.captainStatus + '' ===
+                                        ErrorFactory.STATUS_WRONG_PASSWORD + ''
+                                ) {
+                                    self.setAuthToken('')
+                                }
+
+                                return Promise.reject(error)
+                            })
+                    } else {
+                        return data
+                    }
+                })
+                .then(function (data) {
+                    if (
+                        data.status !== ErrorFactory.OKAY &&
+                        data.status !== ErrorFactory.OK_PARTIALLY &&
+                        data.status !== ErrorFactory.OKAY_BUILD_STARTED
+                    ) {
+                        throw ErrorFactory.createError(
+                            data.status || ErrorFactory.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: 'GET' | 'POST', endpoint: string, variables: any) {
+        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: string, variables: any) {
+        const self = this
+        return axios
+            .get(this.baseUrl + endpoint, {
+                params: variables,
+                headers: self.createHeaders(),
+            }) //
+            .then(function (data) {
+                // console.log(data);
+                return data
+            })
+    }
+
+    postReq(endpoint: string, variables: any) {
+        const self = this
+        return axios
+            .post(this.baseUrl + endpoint, variables, {
+                headers: self.createHeaders(),
+            }) //
+            .then(function (data) {
+                // console.log(data);
+                return data
+            })
+    }
+}

package/src/example.ts

@@ -0,0 +1,36 @@
+import CapRoverAPI, { CapRoverModels } from './index'
+
+const caprover = new CapRoverAPI(
+    '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/src/index.ts

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

package/src/models/AppDefinition.ts

@@ -0,0 +1,124 @@
+import { IHashMapGeneric } from './IHashMapGeneric'
+
+export type IAllAppDefinitions = IHashMapGeneric<IAppDef>
+
+export interface IAppEnvVar {
+    key: string
+    value: string
+}
+
+export 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 // empty if the deploy is not completed
+    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/src/models/AppDefinitionsResponse.ts

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

package/src/models/AppDeleteResponse.ts

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

package/src/models/AutomatedCleanupConfigs.ts

@@ -0,0 +1,18 @@
+export interface IAutomatedCleanupConfigs {
+    mostRecentLimit: number
+    cronSchedule: string
+    timezone: string
+}
+
+export class AutomatedCleanupConfigsCleaner {
+    static sanitizeInput(instance: IAutomatedCleanupConfigs) {
+        return {
+            mostRecentLimit:
+                Number(instance.mostRecentLimit) > 0
+                    ? Number(instance.mostRecentLimit)
+                    : 1,
+            cronSchedule: `${instance.cronSchedule || ''}`.trim(),
+            timezone: `${instance.timezone || ''}`.trim() || 'UTC',
+        }
+    }
+}

package/src/models/BackupMeta.ts

@@ -0,0 +1,26 @@
+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/src/models/BuildLogsResponse.ts

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

package/src/models/CapRoverTheme.ts

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

package/src/models/CaptainInfo.ts

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

package/src/models/ContainerProps.ts

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

package/src/models/DockerAuthObj.ts

@@ -0,0 +1,25 @@
+export interface DockerAuthObj {
+    serveraddress: string
+    username: string
+    password: string
+    // email: string // Email is optional in auth
+}
+
+/*
+{
+  "docker.example.com": {
+    "username": "janedoe",
+    "password": "hunter2"
+  },
+  "https://index.docker.io/v1/": {
+    "username": "mobydock",
+    "password": "conta1n3rize14"
+  }
+}
+*/
+export interface DockerRegistryConfig {
+    [serveraddress: string]: {
+        username: string
+        password: string
+    }
+}

package/src/models/DockerSecret.ts

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

package/src/models/DockerService.ts

@@ -0,0 +1,117 @@
+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/src/models/GoAccessInfo.ts

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

package/src/models/GoAccessReportResponse.ts

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

package/src/models/IBuiltImage.ts

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

package/src/models/ICaptainDefinition.ts

@@ -0,0 +1,7 @@
+export interface ICaptainDefinition {
+    schemaVersion: number
+    dockerfileLines?: string[]
+    dockerfilePath?: string
+    imageName?: string
+    templateId?: string
+}

package/src/models/IGoAccessInfo.ts

@@ -0,0 +1,7 @@
+export default interface IGoAccessInfo {
+    isEnabled: boolean
+    data: {
+        rotationFrequencyCron: string
+        logRetentionDays?: number
+    }
+}

package/src/models/IHashMapGeneric.ts

@@ -0,0 +1,3 @@
+export interface IHashMapGeneric<T> {
+    [id: string]: T
+}

package/src/models/IImageSource.ts

@@ -0,0 +1,10 @@
+import { RepoInfo } from './AppDefinition'
+
+export interface IImageSource {
+    uploadedTarPathSource?: { uploadedTarPath: string; gitHash: string }
+    captainDefinitionContentSource?: {
+        captainDefinitionContent: string
+        gitHash: string
+    }
+    repoInfoSource?: RepoInfo
+}