mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-18 21:27:51 +00:00
106 lines
2.6 KiB
TypeScript
106 lines
2.6 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2019 Balena Ltd.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
declare module 'balena-device-init' {
|
|
import type { DeviceTypeJson } from 'balena-sdk';
|
|
|
|
interface OperationState {
|
|
operation:
|
|
| CopyOperation
|
|
| ReplaceOperation
|
|
| RunScriptOperation
|
|
| BurnOperation;
|
|
percentage: number;
|
|
}
|
|
|
|
interface Operation {
|
|
command: string;
|
|
}
|
|
|
|
interface CopyOperation extends Operation {
|
|
command: 'copy';
|
|
from: { path: string };
|
|
to: { path: string };
|
|
}
|
|
|
|
interface ReplaceOperation extends Operation {
|
|
command: 'replace';
|
|
copy: string;
|
|
replace: string;
|
|
file: {
|
|
path: string;
|
|
};
|
|
}
|
|
|
|
interface RunScriptOperation extends Operation {
|
|
command: 'run-script';
|
|
script: string;
|
|
arguments?: string[];
|
|
}
|
|
|
|
interface BurnOperation extends Operation {
|
|
command: 'burn';
|
|
image?: string;
|
|
}
|
|
|
|
interface BurnProgress {
|
|
type: 'write' | 'check';
|
|
percentage: number;
|
|
transferred: number;
|
|
length: number;
|
|
remaining: number;
|
|
eta: number;
|
|
runtime: number;
|
|
delta: number;
|
|
speed: number;
|
|
}
|
|
|
|
interface InitializeEmitter {
|
|
on(event: 'stdout' | 'stderr', callback: (msg: string) => void): void;
|
|
on(event: 'state', callback: (state: OperationState) => void): void;
|
|
on(event: 'burn', callback: (state: BurnProgress) => void): void;
|
|
on(event: 'end', callback: () => void): void;
|
|
on(event: 'error', callback: (error: Error) => void): void;
|
|
}
|
|
|
|
// As of writing this, these are Bluebird promises, but we are typing then
|
|
// as normal Promises so that we do not rely on Bluebird specific methods,
|
|
// so that the CLI will not require any change once the package drops Bluebird.
|
|
|
|
export function configure(
|
|
image: string,
|
|
manifest: DeviceTypeJson.DeviceType,
|
|
config: object,
|
|
options?: object,
|
|
): Promise<InitializeEmitter>;
|
|
|
|
export function initialize(
|
|
image: string,
|
|
manifest: DeviceTypeJson.DeviceType,
|
|
config: object,
|
|
): Promise<InitializeEmitter>;
|
|
|
|
export function getImageOsVersion(
|
|
image: string,
|
|
manifest: DeviceTypeJson.DeviceType,
|
|
): Promise<string | null>;
|
|
|
|
export function getImageManifest(
|
|
image: string,
|
|
): Promise<DeviceTypeJson.DeviceType | null>;
|
|
}
|