/** * @license * Copyright 2021 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import { IParameterModel } from '../interfaces/i_parameter_model.js'; import { IProcedureModel } from '../interfaces/i_procedure_model.js'; import type { ISerializer } from '../interfaces/i_serializer.js'; import type { Workspace } from '../workspace.js'; /** Represents the state of a procedure model. */ export interface State { id: string; name: string; returnTypes: string[] | null; parameters?: ParameterState[]; [key: string]: unknown; } /** Represents the state of a parameter model. */ export interface ParameterState { id: string; name: string; types?: string[]; [key: string]: unknown; } /** * A newable signature for an IProcedureModel. * * Refer to * https://www.typescriptlang.org/docs/handbook/interfaces.html#difference-between-the-static-and-instance-sides-of-classes * for what is going on with this. */ interface ProcedureModelConstructor { new (workspace: Workspace, name: string, id: string): ProcedureModel; /** * Deserializes the JSON state and returns a procedure model. * * @param state The state to deserialize. * @param workspace The workspace to load the procedure model into. * @returns The constructed procedure model. */ loadState(state: object, workspace: Workspace): ProcedureModel; } /** * A newable signature for an IParameterModel. * * Refer to * https://www.typescriptlang.org/docs/handbook/interfaces.html#difference-between-the-static-and-instance-sides-of-classes * for what is going on with this. */ interface ParameterModelConstructor { new (workspace: Workspace, name: string, id: string): ParameterModel; /** * Deserializes the JSON state and returns a parameter model. * * @param state The state to deserialize. * @param workspace The workspace to load the parameter model into. * @returns The constructed parameter model. */ loadState(state: object, workspace: Workspace): ParameterModel; } /** * Serializes the given IProcedureModel to JSON. */ export declare function saveProcedure(proc: IProcedureModel): State; /** * Deserializes the given procedure model State from JSON. */ export declare function loadProcedure(procedureModelClass: ProcedureModelConstructor, parameterModelClass: ParameterModelConstructor, state: State, workspace: Workspace): ProcedureModel; /** Serializer for saving and loading procedure state. */ export declare class ProcedureSerializer implements ISerializer { private readonly procedureModelClass; private readonly parameterModelClass; priority: number; /** * Constructs the procedure serializer. * * Example usage: * new ProcedureSerializer(MyProcedureModelClass, MyParameterModelClass) * * @param procedureModelClass The class (implementing IProcedureModel) that * you want this serializer to deserialize. * @param parameterModelClass The class (implementing IParameterModel) that * you want this serializer to deserialize. */ constructor(procedureModelClass: ProcedureModelConstructor, parameterModelClass: ParameterModelConstructor); /** Serializes the procedure models of the given workspace. */ save(workspace: Workspace): State[] | null; /** * Deserializes the procedures models defined by the given state into the * workspace. */ load(state: State[], workspace: Workspace): void; /** Disposes of any procedure models that exist on the workspace. */ clear(workspace: Workspace): void; } export {}; //# sourceMappingURL=procedures.d.ts.map