mirror of
https://github.com/arduino/arduino-ide.git
synced 2025-05-17 02:18:42 +00:00
123 lines
3.6 KiB
TypeScript
123 lines
3.6 KiB
TypeScript
import { Searchable } from './searchable';
|
|
import { Installable } from './installable';
|
|
import { ArduinoComponent } from './arduino-component';
|
|
|
|
export const LibraryServicePath = '/services/library-service';
|
|
export const LibraryService = Symbol('LibraryService');
|
|
export interface LibraryService
|
|
extends Installable<LibraryPackage>,
|
|
Searchable<LibraryPackage> {
|
|
list(options: LibraryService.List.Options): Promise<LibraryPackage[]>;
|
|
/**
|
|
* When `installDependencies` is not set, it is `true` by default. If you want to skip the installation of required dependencies, set it to `false`.
|
|
*/
|
|
install(options: {
|
|
item: LibraryPackage;
|
|
progressId?: string;
|
|
version?: Installable.Version;
|
|
installDependencies?: boolean;
|
|
}): Promise<void>;
|
|
installZip(options: {
|
|
zipUri: string;
|
|
progressId?: string;
|
|
overwrite?: boolean;
|
|
}): Promise<void>;
|
|
/**
|
|
* Set `filterSelf` to `true` if you want to avoid having `item` in the result set.
|
|
* Note: as of today (22.02.2021), the CLI works like this: `./arduino-cli lib deps Adaino@0.1.0 ✕ Adaino 0.1.0 must be installed.`.
|
|
*/
|
|
listDependencies({
|
|
item,
|
|
version,
|
|
filterSelf,
|
|
}: {
|
|
item: LibraryPackage;
|
|
version: Installable.Version;
|
|
filterSelf?: boolean;
|
|
}): Promise<LibraryDependency[]>;
|
|
}
|
|
|
|
export namespace LibraryService {
|
|
export namespace List {
|
|
export interface Options {
|
|
readonly fqbn?: string | undefined;
|
|
}
|
|
}
|
|
}
|
|
|
|
export enum LibraryLocation {
|
|
/**
|
|
* In the `libraries` subdirectory of the Arduino IDE installation.
|
|
*/
|
|
IDE_BUILTIN = 0,
|
|
|
|
/**
|
|
* In the `libraries` subdirectory of the user directory (sketchbook).
|
|
*/
|
|
USER = 1,
|
|
|
|
/**
|
|
* In the `libraries` subdirectory of a platform.
|
|
*/
|
|
PLATFORM_BUILTIN = 2,
|
|
|
|
/**
|
|
* When `LibraryLocation` is used in a context where a board is specified, this indicates the library is in the `libraries`
|
|
* subdirectory of a platform referenced by the board's platform.
|
|
*/
|
|
REFERENCED_PLATFORM_BUILTIN = 3,
|
|
}
|
|
|
|
export interface LibraryPackage extends ArduinoComponent {
|
|
/**
|
|
* Same as [`Library#real_name`](https://arduino.github.io/arduino-cli/latest/rpc/commands/#library).
|
|
* Should be used for the UI, and `name` is used to uniquely identify a library. It does not have an ID.
|
|
*/
|
|
readonly label: string;
|
|
|
|
/**
|
|
* An array of string that should be included into the `ino` file if this library is used.
|
|
* For example, including `SD` will prepend `#include <SD.h>` to the `ino` file. While including `Bridge`
|
|
* requires multiple `#include` declarations: `YunClient`, `YunServer`, `Bridge`, etc.
|
|
*/
|
|
readonly includes: string[];
|
|
readonly exampleUris: string[];
|
|
readonly location: LibraryLocation;
|
|
readonly installDirUri?: string;
|
|
}
|
|
export namespace LibraryPackage {
|
|
export function is(arg: any): arg is LibraryPackage {
|
|
return (
|
|
ArduinoComponent.is(arg) &&
|
|
'includes' in arg &&
|
|
Array.isArray(arg['includes'])
|
|
);
|
|
}
|
|
|
|
export function equals(left: LibraryPackage, right: LibraryPackage): boolean {
|
|
return left.name === right.name && left.author === right.author;
|
|
}
|
|
|
|
export function groupByLocation(packages: LibraryPackage[]): {
|
|
user: LibraryPackage[];
|
|
rest: LibraryPackage[];
|
|
} {
|
|
const user: LibraryPackage[] = [];
|
|
const rest: LibraryPackage[] = [];
|
|
for (const pkg of packages) {
|
|
if (pkg.location === LibraryLocation.USER) {
|
|
user.push(pkg);
|
|
} else {
|
|
rest.push(pkg);
|
|
}
|
|
}
|
|
return { user, rest };
|
|
}
|
|
}
|
|
|
|
export interface LibraryDependency {
|
|
readonly name: string;
|
|
readonly requiredVersion: Installable.Version;
|
|
readonly installedVersion: Installable.Version;
|
|
}
|