ade-planning-api/src/index.ts

An unofficial API wrapper for ADE Planning from Adesoft

import { ADEFetcher } from "./utils/fetcher";
import type { Credentials } from "./models/auth";
import type { Project, Event, EventParams, EventByDetail, Memberships, AllMembers, Counters, Constraints, Cost, Activity, ActivityParams, ActivityByDetail, Rights, Resource, ResourceParams, ResourceByDetail } from "./models/timetable";
import { getProjects, setProject } from "./services/projectService";
import { getEvents } from "./services/eventService";
import { getResources } from "./services/resourceService";

export class ADEPlanningAPI {
    private fetcher: ADEFetcher;

    /** 
     * Initializes a new instance of the ADEPlanningAPI class.
     * @param baseUrl The base URL of the ADE instance.
     * @returns A new instance of the ADEPlanningAPI class.
    */
    constructor(baseUrl: string) {
        this.fetcher = new ADEFetcher(baseUrl);
    }

    /** 
     * Initializes a new session with the API.
     * @param credentials The credentials to use for authentication.
     * @returns A promise that resolves when the session is initialized.
    */
    async initializeSession(credentials: Credentials): Promise<void> {
        return await this.fetcher.initializeSession(credentials);
    }

    /**
     * Terminates the current session with the API.
     * @returns A promise that resolves when the session is terminated.
     */
    async terminateSession(): Promise<void> {
        return await this.fetcher.terminateSession();
    }

    /**
     * Gets the list of projects.
     * @returns A promise that resolves with the list of projects.
     */
    async getProjects(): Promise<Project[]> {
        return await getProjects(this.fetcher);
    }

    /**
     * Sets the current project.
     * @param project The project to set as current.
     * @returns A promise that resolves when the project is set.
     */
    async setProject(project: Project): Promise<void> {
        return await setProject(this.fetcher, project);
    }

    /**
     * Gets the list of events.
     * @param params The parameters to pass to the API.
     * @returns A promise that resolves with the list of events.
     */
    async getEvents<T extends number>(params: EventParams & { detail: T }): Promise<EventByDetail<T>[]> {
        return await getEvents(this.fetcher, params);
    }
    
    /**
     * @param params The parameters to pass to the API.
     * @returns A promise that resolves with the list of resources.
     */
    async getResources<T extends number>(params: ResourceParams & { detail: T }): Promise<ResourceByDetail<T>[]> {
        return await getResources(this.fetcher, params);
    }
}

export type { Project, EventByDetail, ResourceByDetail, ActivityByDetail, Event, Activity, Resource, Memberships, AllMembers, Counters, Constraints, Cost, Rights, Credentials }; // Export types for external use