sketches-service.ts

import URI from '@theia/core/lib/common/uri';

export const SketchesServicePath = '/services/sketches-service';
export const SketchesService = Symbol('SketchesService');
export interface SketchesService {

    /**
     * Returns with the direct sketch folders from the location of the `fileStat`.
     * The sketches returns with inverse-chronological order, the first item is the most recent one.
     */
    getSketches(uri?: string): Promise<Sketch[]>;

    /**
     * This is the TS implementation of `SketchLoad` from the CLI and should be replaced with a gRPC call eventually.
     * See: https://github.com/arduino/arduino-cli/issues/837
     * Based on: https://github.com/arduino/arduino-cli/blob/eef3705c4afcba4317ec38b803d9ffce5dd59a28/arduino/builder/sketch.go#L100-L215
     */
    loadSketch(uri: string): Promise<Sketch>;

    /**
     * Creates a new sketch folder in the temp location.
     */
    createNewSketch(): Promise<Sketch>;

    /**
     * Creates a new sketch with existing content. Rejects if `uri` is not pointing to a valid sketch folder.
     */
    cloneExample(uri: string): Promise<Sketch>;

    isSketchFolder(uri: string): Promise<boolean>;

    /**
     * Sketches are created to the temp location by default and will be moved under `directories.user` on save.
     * This method resolves to `true` if the `sketch` is still in the temp location. Otherwise, `false`.
     */
    isTemp(sketch: Sketch): Promise<boolean>;

    /**
     * If `isTemp` is `true` for the `sketch`, you can call this method to move the sketch from the temp
     * location to `directories.user`. Resolves with the URI of the sketch after the move. Rejects, when the sketch
     * was not in the temp folder. This method always overrides. It's the callers responsibility to ask the user whether
     * the files at the destination can be overwritten or not.
     */
    copy(sketch: Sketch, options: { destinationUri: string }): Promise<string>;

    /**
     * Returns with the container sketch for the input `uri`. If the `uri` is not in a sketch folder, resolved `undefined`.
     */
    getSketchFolder(uri: string): Promise<Sketch | undefined>;

    /**
     * Marks the sketch with the given URI as recently opened. It does nothing if the sketch is temp or not valid.
     */
    markAsRecentlyOpened(uri: string): Promise<void>;

    /**
     * Resolves to an array of sketches in inverse chronological order. The newest is the first.
     */
    recentlyOpenedSketches(): Promise<Sketch[]>;

    /**
     * Archives the sketch, resolves to the archive URI.
     */
    archive(sketch: Sketch, destinationUri: string): Promise<string>;

}

export interface Sketch {
    readonly name: string;
    readonly uri: string; // `LocationPath`
    readonly mainFileUri: string; // `MainFile`
    readonly otherSketchFileUris: string[]; // `OtherSketchFiles`
    readonly additionalFileUris: string[]; // `AdditionalFiles`
    readonly rootFolderFileUris: string[]; // `RootFolderFiles` (does not include the main sketch file)
}
export namespace Sketch {
    export function is(arg: any): arg is Sketch {
        return !!arg && 'name' in arg && 'uri' in arg && typeof arg.name === 'string' && typeof arg.uri === 'string';
    }
    export namespace Extensions {
        export const MAIN = ['.ino', '.pde'];
        export const SOURCE = ['.c', '.cpp', '.s'];
        export const ADDITIONAL = ['.h', '.c', '.hpp', '.hh', '.cpp', '.s', '.json'];
        export const ALL = Array.from(new Set([...MAIN, ...SOURCE, ...ADDITIONAL]));
    }
    export function isInSketch(uri: string | URI, sketch: Sketch): boolean {
        const { mainFileUri, otherSketchFileUris, additionalFileUris } = sketch;
        return [mainFileUri, ...otherSketchFileUris, ...additionalFileUris].indexOf(uri.toString()) !== -1;
    }
    export function isSketchFile(arg: string | URI): boolean {
        if (arg instanceof URI) {
            return isSketchFile(arg.toString());
        }
        return Extensions.MAIN.some(ext => arg.endsWith(ext));
    }
}