@lokalise/node-api/src/collections/branches.ts

Official Lokalise API 2.0 Node.js client

import type { PaginatedResult } from "../interfaces/paginated_result.js";
import { Branch } from "../models/branch.js";
import type {
	BranchDeleted,
	BranchMerged,
	BranchParams,
	MergeBranchParams,
} from "../types/branches.js";
import type {
	ProjectOnly,
	ProjectWithPagination,
} from "../types/common_get_params.js";
import { BaseCollection } from "./base_collection.js";

export class Branches extends BaseCollection<Branch> {
	protected static override prefixURI =
		"projects/{!:project_id}/branches/{:id}";

	protected get elementClass(): new (
		json: Record<string, unknown>,
	) => Branch {
		return Branch;
	}

	protected override get rootElementName(): string {
		return "branches";
	}

	protected override get rootElementNameSingular(): string | null {
		return "branch";
	}

	list(
		request_params: ProjectWithPagination,
	): Promise<PaginatedResult<Branch>> {
		return this.doList(request_params) as Promise<PaginatedResult<Branch>>;
	}

	create(
		branch_params: BranchParams,
		request_params: ProjectOnly,
	): Promise<Branch> {
		return this.doCreate(
			branch_params,
			request_params,
			this.populateObjectFromJsonRoot,
		);
	}

	get(
		branch_id: string | number,
		request_params: ProjectOnly,
	): Promise<Branch> {
		return this.doGet(branch_id, request_params);
	}

	update(
		branch_id: string | number,
		branch_params: BranchParams,
		request_params: ProjectOnly,
	): Promise<Branch> {
		return this.doUpdate(branch_id, branch_params, request_params);
	}

	delete(
		branch_id: string | number,
		request_params: ProjectOnly,
	): Promise<BranchDeleted> {
		return this.doDelete<BranchDeleted>(branch_id, request_params);
	}

	merge(
		branch_id: string | number,
		request_params: ProjectOnly,
		body: MergeBranchParams = {},
	): Promise<BranchMerged> {
		const params = {
			...request_params,
			...{ id: branch_id },
		};

		return this.createPromise<BranchMerged>(
			"POST",
			params,
			this.returnBareJSON<BranchMerged>,
			body,
			"projects/{!:project_id}/branches/{:id}/merge",
		);
	}
}