caprover-api 0.0.1

package/dist/models/ICaptainDefinition.d.ts

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

package/dist/models/ICaptainDefinition.js

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

package/dist/models/IGoAccessInfo.d.ts

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

package/dist/models/IGoAccessInfo.js

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

package/dist/models/IHashMapGeneric.d.ts

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

package/dist/models/IHashMapGeneric.js

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

package/dist/models/IImageSource.d.ts

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

package/dist/models/IImageSource.js

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

package/dist/models/IOneClickAppModels.d.ts

@@ -0,0 +1,45 @@
+import { IHashMapGeneric } from './IHashMapGeneric';
+export interface IOneClickAppIdentifier {
+    sortScore?: number;
+    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[];
+    caproverExtra?: {
+        dockerfileLines?: string[];
+        containerHttpPort: number;
+        notExposeAsWebApp: boolean;
+        websocketSupport: boolean;
+    };
+}
+export interface IOneClickTemplate {
+    services: IHashMapGeneric<IDockerComposeService>;
+    captainVersion: number;
+    caproverOneClickApp: {
+        instructions: {
+            start: string;
+            end: string;
+        };
+        displayName: string;
+        variables: IOneClickVariable[];
+    };
+}

package/dist/models/IOneClickAppModels.js

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

package/dist/models/IProFeatures.d.ts

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

package/dist/models/IProFeatures.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProAlertEvent = exports.ProAlertActionType = void 0;
+var ProAlertActionType;
+(function (ProAlertActionType) {
+    ProAlertActionType["email"] = "email";
+    ProAlertActionType["webhook"] = "webhook";
+})(ProAlertActionType || (exports.ProAlertActionType = ProAlertActionType = {}));
+var ProAlertEvent;
+(function (ProAlertEvent) {
+    ProAlertEvent["UserLoggedIn"] = "UserLoggedIn";
+    ProAlertEvent["AppBuildSuccessful"] = "AppBuildSuccessful";
+    ProAlertEvent["AppBuildFailed"] = "AppBuildFailed";
+})(ProAlertEvent || (exports.ProAlertEvent = ProAlertEvent = {}));

package/dist/models/IRegistryInfo.d.ts

@@ -0,0 +1,21 @@
+export declare 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/dist/models/IRegistryInfo.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IRegistryTypes = void 0;
+class IRegistryTypes {
+}
+exports.IRegistryTypes = IRegistryTypes;
+IRegistryTypes.LOCAL_REG = 'LOCAL_REG';
+IRegistryTypes.REMOTE_REG = 'REMOTE_REG';

package/dist/models/IServerBlockDetails.d.ts

@@ -0,0 +1,17 @@
+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/dist/models/IServerBlockDetails.js

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

package/dist/models/IVersionInfo.d.ts

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

package/dist/models/IVersionInfo.js

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

package/dist/models/LoadBalancerInfo.d.ts

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

package/dist/models/LoadBalancerInfo.js

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

package/dist/models/LogsResponse.d.ts

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

package/dist/models/LogsResponse.js

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

package/dist/models/NetDataInfo.d.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/dist/models/NetDataInfo.js

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

package/dist/models/NginxConfig.d.ts

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

package/dist/models/NginxConfig.js

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

package/dist/models/OneClickAppDefinitionResponse.d.ts

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

package/dist/models/OneClickAppDefinitionResponse.js

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

package/dist/models/OneClickAppRepositories.d.ts

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

package/dist/models/OneClickAppRepositories.js

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

package/dist/models/OneClickAppResponse.d.ts

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

package/dist/models/OneClickAppResponse.js

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

package/dist/models/OtherTypes.d.ts

@@ -0,0 +1,29 @@
+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/dist/models/OtherTypes.js

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

package/dist/models/ProjectDefinition.d.ts

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

package/dist/models/ProjectDefinition.js

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

package/dist/models/ProjectsResponse.d.ts

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

package/dist/models/ProjectsResponse.js

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

package/dist/models/RegistriesResponse.d.ts

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

package/dist/models/RegistriesResponse.js

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

package/dist/models/ServerDockerInfo.d.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/dist/models/ServerDockerInfo.js

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

package/dist/models/UnusedImagesResponse.d.ts

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

package/dist/models/UnusedImagesResponse.js

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

package/dist/models/index.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @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/dist/models/index.js

@@ -0,0 +1,56 @@
+"use strict";
+/**
+ * @file Automatically generated by barrelsby.
+ */
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AppDefinition"), exports);
+__exportStar(require("./AppDefinitionsResponse"), exports);
+__exportStar(require("./AppDeleteResponse"), exports);
+__exportStar(require("./AutomatedCleanupConfigs"), exports);
+__exportStar(require("./BackupMeta"), exports);
+__exportStar(require("./BuildLogsResponse"), exports);
+__exportStar(require("./CapRoverTheme"), exports);
+__exportStar(require("./CaptainInfo"), exports);
+__exportStar(require("./ContainerProps"), exports);
+__exportStar(require("./DockerAuthObj"), exports);
+__exportStar(require("./DockerSecret"), exports);
+__exportStar(require("./DockerService"), exports);
+__exportStar(require("./GoAccessInfo"), exports);
+__exportStar(require("./GoAccessReportResponse"), exports);
+__exportStar(require("./IBuiltImage"), exports);
+__exportStar(require("./ICaptainDefinition"), exports);
+__exportStar(require("./IGoAccessInfo"), exports);
+__exportStar(require("./IHashMapGeneric"), exports);
+__exportStar(require("./IImageSource"), exports);
+__exportStar(require("./IOneClickAppModels"), exports);
+__exportStar(require("./IProFeatures"), exports);
+__exportStar(require("./IRegistryInfo"), exports);
+__exportStar(require("./IServerBlockDetails"), exports);
+__exportStar(require("./IVersionInfo"), exports);
+__exportStar(require("./LoadBalancerInfo"), exports);
+__exportStar(require("./LogsResponse"), exports);
+__exportStar(require("./NetDataInfo"), exports);
+__exportStar(require("./NginxConfig"), exports);
+__exportStar(require("./OneClickAppDefinitionResponse"), exports);
+__exportStar(require("./OneClickAppRepositories"), exports);
+__exportStar(require("./OneClickAppResponse"), exports);
+__exportStar(require("./OtherTypes"), exports);
+__exportStar(require("./ProjectDefinition"), exports);
+__exportStar(require("./ProjectsResponse"), exports);
+__exportStar(require("./RegistriesResponse"), exports);
+__exportStar(require("./ServerDockerInfo"), exports);
+__exportStar(require("./UnusedImagesResponse"), exports);

package/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "caprover-api",
+    "version": "0.0.1",
+    "description": "API client for CapRover",
+    "types": "dist/index.d.ts",
+    "main": "dist/index.js",
+    "scripts": {
+        "formatter": "prettier --check './src/**/*.ts*'",
+        "formatter-write": "prettier --write './src/**/*.ts*'",
+        "tslint": "tslint -c tslint.json -p tsconfig.json",
+        "tslint-fix": "tslint --fix -c tslint.json -p tsconfig.json",
+        "test": "echo \"Error: no test specified\" && exit 1",
+        "build": "rm -rf ./dist && npm run tslint && npx tsc && chmod +x ./dist -R",
+        "dev": "rm -rf ./dist && npx tsc && node ./dist/example.js",
+        "generate-barrels": "barrelsby --directory src/models"
+    },
+    "author": "",
+    "license": "ISC",
+    "dependencies": {
+        "axios": "^1.10.0"
+    },
+    "devDependencies": {
+        "@types/node": "^24.0.10",
+        "barrelsby": "^2.8.1",
+        "prettier": "^3.6.2",
+        "tslint": "^6.1.3",
+        "tslint-config-prettier": "^1.18.0",
+        "typescript": "^5.8.3"
+    }
+}