caprover-api 0.0.1

package/src/models/IOneClickAppModels.ts

@@ -0,0 +1,51 @@
+import { IHashMapGeneric } from './IHashMapGeneric'
+
+export interface IOneClickAppIdentifier {
+    sortScore?: number // 0-1 and dynamically calculated based on search terms
+    isOfficial?: boolean
+    name: string
+    displayName: string
+    description: string
+    logoUrl: string
+    baseUrl: string
+}
+
+export interface IOneClickVariable {
+    id: string
+    label: string
+    defaultValue?: string
+    validRegex?: string
+    description?: string
+}
+
+export interface IDockerComposeService {
+    image?: string
+    volumes?: string[]
+    ports?: string[]
+    environment?: IHashMapGeneric<string>
+    depends_on?: string[]
+    hostname?: string
+    cap_add?: string[]
+    command?: string | string[]
+
+    // These are CapRover property, not DockerCompose. We use this instead of image if we need to extend the image.
+    caproverExtra?: {
+        dockerfileLines?: string[]
+        containerHttpPort: number
+        notExposeAsWebApp: boolean // This is actually a string "true", make sure to double negate!
+        websocketSupport: boolean // This is actually a string "true", make sure to double negate!
+    }
+}
+
+export interface IOneClickTemplate {
+    services: IHashMapGeneric<IDockerComposeService>
+    captainVersion: number
+    caproverOneClickApp: {
+        instructions: {
+            start: string
+            end: string
+        }
+        displayName: string
+        variables: IOneClickVariable[]
+    }
+}

package/src/models/IProFeatures.ts

@@ -0,0 +1,39 @@
+export interface IProFeatures {
+    isFeatureFlagEnabled: boolean
+    isSubscribed: boolean
+}
+
+export interface TwoFactorAuthResponse {
+    isEnabled: boolean
+    otpPath?: string
+}
+
+export interface TwoFactorAuthRequest {
+    enabled: boolean
+    token?: string
+}
+
+export enum ProAlertActionType {
+    email = 'email',
+    webhook = 'webhook',
+}
+
+export interface ProAlertAction {
+    actionType: ProAlertActionType
+    metadata?: any
+}
+
+export enum ProAlertEvent {
+    UserLoggedIn = 'UserLoggedIn',
+    AppBuildSuccessful = 'AppBuildSuccessful',
+    AppBuildFailed = 'AppBuildFailed',
+}
+
+export interface ProAlertConfig {
+    event: ProAlertEvent
+    action: ProAlertAction
+}
+
+export interface IProConfig {
+    alerts: ProAlertConfig[]
+}

package/src/models/IRegistryInfo.ts

@@ -0,0 +1,30 @@
+export class IRegistryTypes {
+    static readonly LOCAL_REG = 'LOCAL_REG'
+    static readonly REMOTE_REG = 'REMOTE_REG'
+}
+
+export type IRegistryType = 'LOCAL_REG' | 'REMOTE_REG'
+
+export interface IRegistryInfo {
+    id: string
+    registryUser: string
+    registryPassword: string
+
+    registryDomain: string
+
+    registryImagePrefix: string
+
+    registryType: IRegistryType
+}
+
+export interface IRegistryInfoEncrypted {
+    id: string
+    registryUser: string
+    registryPasswordEncrypted: string
+
+    registryDomain: string
+
+    registryImagePrefix: string
+
+    registryType: IRegistryType
+}

package/src/models/IServerBlockDetails.ts

@@ -0,0 +1,18 @@
+export interface IServerBlockDetails {
+    hasSsl: boolean
+    forceSsl: boolean
+    websocketSupport: boolean
+    publicDomain: string
+    localDomain: string
+    nginxConfigTemplate: string
+    containerHttpPort: number
+    httpBasicAuth?: string
+    httpBasicAuthPath?: string
+
+    crtPath?: string
+    keyPath?: string
+    customErrorPagesDirectory: string
+    staticWebRoot: string
+    redirectToPath?: string
+    logAccessPath?: string
+}

package/src/models/IVersionInfo.ts

@@ -0,0 +1,6 @@
+export interface IVersionInfo {
+    currentVersion: string
+    latestVersion: string
+    canUpdate: boolean
+    changeLogMessage: string
+}

package/src/models/LoadBalancerInfo.ts

@@ -0,0 +1,11 @@
+export default interface LoadBalancerInfo {
+    activeConnections: number
+
+    accepted: number
+    handled: number
+    total: number
+
+    reading: number
+    writing: number
+    waiting: number
+}

package/src/models/LogsResponse.ts

@@ -0,0 +1,3 @@
+export default interface LogsResponse {
+    logs: string
+}

package/src/models/NetDataInfo.ts

@@ -0,0 +1,27 @@
+export interface NetDataInfo {
+    isEnabled: boolean
+    netDataUrl: string
+    data: {
+        smtp: {
+            to: string
+            hostname: string
+            server: string
+            port: string
+            allowNonTls: string
+            username: string
+            password: string
+        }
+        slack: {
+            hook: string
+            channel: string
+        }
+        telegram: {
+            chatId: string
+            botToken: string
+        }
+        pushBullet: {
+            apiToken: string
+            fallbackEmail: string
+        }
+    }
+}

package/src/models/NginxConfig.ts

@@ -0,0 +1,10 @@
+export default interface NginxConfig {
+    baseConfig: {
+        byDefault: string
+        customValue: string
+    }
+    captainConfig: {
+        byDefault: string
+        customValue: string
+    }
+}

package/src/models/OneClickAppDefinitionResponse.ts

@@ -0,0 +1,3 @@
+export default interface OneClickAppDefinitionResponse {
+    appTemplate: string
+}

package/src/models/OneClickAppRepositories.ts

@@ -0,0 +1,3 @@
+export default interface OneClickAppRepositories {
+    urls: string[]
+}

package/src/models/OneClickAppResponse.ts

@@ -0,0 +1,5 @@
+import { IOneClickAppIdentifier } from './IOneClickAppModels'
+
+export default interface OneClickAppResponse {
+    oneClickApps: IOneClickAppIdentifier[]
+}

package/src/models/OtherTypes.ts

@@ -0,0 +1,32 @@
+import { IAppDef } from './AppDefinition'
+
+export type CaptainError = {
+    captainErrorType: number
+    apiMessage: string
+}
+
+export type AnyError = any
+
+export type PreDeployFunction = (
+    appDef: IAppDef | undefined,
+    updatedData: any
+) => Promise<void>
+
+export interface IDockerApiPort {
+    Protocol: string
+    TargetPort: number
+    PublishedPort: number
+    PublishMode?: 'ingress' | 'host'
+}
+
+export interface IDockerContainerResource {
+    Limits?: { NanoCPUs?: number; MemoryBytes?: number }
+    Reservation?: { NanoCPUs?: number; MemoryBytes?: number }
+}
+
+export interface ITemplate {
+    templateName: string
+    dockerHubImageName: string
+    tagSuffix: string
+    postFromLines?: string
+}

package/src/models/ProjectDefinition.ts

@@ -0,0 +1,6 @@
+export interface ProjectDefinition {
+    id: string
+    name: string
+    description: string
+    parentProjectId?: string
+}

package/src/models/ProjectsResponse.ts

@@ -0,0 +1,5 @@
+import { ProjectDefinition } from './ProjectDefinition'
+
+export default interface ProjectsResponse {
+    projects: ProjectDefinition[]
+}

package/src/models/RegistriesResponse.ts

@@ -0,0 +1,6 @@
+import { IRegistryInfo } from './IRegistryInfo'
+
+export default interface RegistriesResponse {
+    registries: IRegistryInfo[]
+    defaultRegistryId?: string
+}

package/src/models/ServerDockerInfo.ts

@@ -0,0 +1,14 @@
+export interface ServerDockerInfo {
+    nodeId: string
+    type: 'manager' | 'worker'
+    isLeader: boolean
+    hostname: string
+    architecture: string
+    operatingSystem: string
+    nanoCpu: number
+    memoryBytes: number
+    dockerEngineVersion: string
+    ip: string
+    state: string
+    status: string
+}

package/src/models/UnusedImagesResponse.ts

@@ -0,0 +1,3 @@
+export default interface UnusedImagesResponse {
+    images: { id: string; tags: string[] }[]
+}

package/src/models/index.ts

@@ -0,0 +1,41 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+
+export * from './AppDefinition'
+export * from './AppDefinitionsResponse'
+export * from './AppDeleteResponse'
+export * from './AutomatedCleanupConfigs'
+export * from './BackupMeta'
+export * from './BuildLogsResponse'
+export * from './CapRoverTheme'
+export * from './CaptainInfo'
+export * from './ContainerProps'
+export * from './DockerAuthObj'
+export * from './DockerSecret'
+export * from './DockerService'
+export * from './GoAccessInfo'
+export * from './GoAccessReportResponse'
+export * from './IBuiltImage'
+export * from './ICaptainDefinition'
+export * from './IGoAccessInfo'
+export * from './IHashMapGeneric'
+export * from './IImageSource'
+export * from './IOneClickAppModels'
+export * from './IProFeatures'
+export * from './IRegistryInfo'
+export * from './IServerBlockDetails'
+export * from './IVersionInfo'
+export * from './LoadBalancerInfo'
+export * from './LogsResponse'
+export * from './NetDataInfo'
+export * from './NginxConfig'
+export * from './OneClickAppDefinitionResponse'
+export * from './OneClickAppRepositories'
+export * from './OneClickAppResponse'
+export * from './OtherTypes'
+export * from './ProjectDefinition'
+export * from './ProjectsResponse'
+export * from './RegistriesResponse'
+export * from './ServerDockerInfo'
+export * from './UnusedImagesResponse'

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "moduleResolution": "Node",
+    "declaration": true,
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  },
+  "include": ["src"]
+}

package/tslint.json

@@ -0,0 +1,46 @@
+{
+    "jsRules": {
+        "no-empty": true
+    },
+    "rules": {
+        "class-name": true,
+        "comment-format": [true, "check-space"],
+        "indent": [true, "spaces"],
+        "one-line": [true, "check-open-brace", "check-whitespace"],
+        "no-var-keyword": true,
+        //"quotemark": [true, "single", "avoid-escape"],
+        "semicolon": [true, "never", "ignore-bound-class-methods"],
+        "whitespace": [
+            true,
+            "check-branch",
+            "check-decl",
+            "check-operator",
+            "check-module",
+            "check-separator",
+            "check-type"
+        ],
+        "typedef-whitespace": [
+            true,
+            {
+                "call-signature": "nospace",
+                "index-signature": "nospace",
+                "parameter": "nospace",
+                "property-declaration": "nospace",
+                "variable-declaration": "nospace"
+            },
+            {
+                "call-signature": "onespace",
+                "index-signature": "onespace",
+                "parameter": "onespace",
+                "property-declaration": "onespace",
+                "variable-declaration": "onespace"
+            }
+        ],
+        "no-internal-module": true,
+        "no-trailing-whitespace": true,
+        "no-null-keyword": true,
+        //"prefer-const": true,
+        "jsdoc-format": true
+    },
+    "extends": ["tslint-config-prettier"]
+}