gitpod/components/gitpod-db/src/project-db.ts

/**
 * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
 * Licensed under the GNU Affero General Public License (AGPL).
 * See License.AGPL.txt in the project root for license information.
 */

import { PartialProject, Project, ProjectEnvVar, ProjectEnvVarWithValue, ProjectUsage } from "@gitpod/gitpod-protocol";

export const ProjectDB = Symbol("ProjectDB");
export interface ProjectDB {
    findProjectById(projectId: string): Promise<Project | undefined>;
    findProjectByCloneUrl(cloneUrl: string): Promise<Project | undefined>;
    findProjectsByCloneUrls(cloneUrls: string[]): Promise<(Project & { teamOwners?: string[] })[]>;
    findTeamProjects(teamId: string): Promise<Project[]>;
    findUserProjects(userId: string): Promise<Project[]>;
    findProjectsBySearchTerm(
        offset: number,
        limit: number,
        orderBy: keyof Project,
        orderDir: "ASC" | "DESC",
        searchTerm: string,
    ): Promise<{ total: number; rows: Project[] }>;
    storeProject(project: Project): Promise<Project>;
    updateProject(partialProject: PartialProject): Promise<void>;
    markDeleted(projectId: string): Promise<void>;
    setProjectEnvironmentVariable(projectId: string, name: string, value: string, censored: boolean): Promise<void>;
    getProjectEnvironmentVariables(projectId: string): Promise<ProjectEnvVar[]>;
    getProjectEnvironmentVariableById(variableId: string): Promise<ProjectEnvVar | undefined>;
    deleteProjectEnvironmentVariable(variableId: string): Promise<void>;
    getProjectEnvironmentVariableValues(envVars: ProjectEnvVar[]): Promise<ProjectEnvVarWithValue[]>;
    findCachedProjectOverview(projectId: string): Promise<Project.Overview | undefined>;
    storeCachedProjectOverview(projectId: string, overview: Project.Overview): Promise<void>;
    getProjectUsage(projectId: string): Promise<ProjectUsage | undefined>;
    updateProjectUsage(projectId: string, usage: Partial<ProjectUsage>): Promise<void>;
}