forest-cli
Version:
The Lumberjacks' toolbelt is the Forest CLI which makes easy to manage your back office application directly from the terminal.
19 lines • 928 B
TypeScript
/**
* (De)serialization of forest-layout.json: a `forest` header carrying the scope,
* then one section per domain mirroring the patchable documents 1:1. JSON is used
* for consistency with the rest of the toolbelt (`.forestadmin-schema.json`) and
* the JSON:API server — the file is a machine round-trip (pull → diff → apply),
* not a hand-commented document.
*/
import type { LayoutFileDoc, LayoutScope } from './types';
export declare class LayoutFileError extends Error {
constructor(message: string);
}
/** Serialize the pulled documents with the scope header. */
export declare function serializeLayoutFile(scope: LayoutScope, docs: LayoutFileDoc, now: () => Date): string;
/** Parse the file back; tolerates absent domains (partial pulls). */
export declare function parseLayoutFile(content: string): {
docs: LayoutFileDoc;
scope: Partial<LayoutScope>;
};
//# sourceMappingURL=layout-file.d.ts.map