UNPKG

open-agreements

Version:

Open-source legal template filling CLI and library

61 lines • 2.2 kB
import { z } from 'zod'; import { fillTemplate } from '../core/engine.js'; export declare const AgreementRecordSchema: z.ZodObject<{ id: z.ZodString; template: z.ZodObject<{ id: z.ZodString; version: z.ZodString; source_sha256: z.ZodString; }, z.core.$strip>; revision: z.ZodNumber; terms: z.ZodRecord<z.ZodString, z.ZodUnknown>; review: z.ZodNullable<z.ZodObject<{ revision: z.ZodNumber; warnings: z.ZodArray<z.ZodString>; reviewed_at: z.ZodString; }, z.core.$strip>>; rendered_document: z.ZodNullable<z.ZodObject<{ revision: z.ZodNumber; path: z.ZodString; sha256: z.ZodString; warnings: z.ZodArray<z.ZodString>; rendered_at: z.ZodString; }, z.core.$strip>>; created_at: z.ZodString; updated_at: z.ZodString; }, z.core.$loose>; export type AgreementRecord = z.infer<typeof AgreementRecordSchema>; interface CommandOptions { root?: string; } export interface AgreementCreateArgs extends CommandOptions { template: string; terms?: Record<string, unknown>; id?: string; } export declare function runAgreementCreate(args: AgreementCreateArgs): Promise<AgreementRecord>; export declare function runAgreementList(args?: CommandOptions & { json?: boolean; }): Promise<AgreementRecord[]>; export declare function runAgreementShow(args: CommandOptions & { id: string; json?: boolean; }): Promise<AgreementRecord>; export interface AgreementUpdateArgs extends CommandOptions { id: string; terms: Record<string, unknown>; revision?: number; } export declare function runAgreementUpdate(args: AgreementUpdateArgs): Promise<AgreementRecord>; export declare function runAgreementReview(args: CommandOptions & { id: string; }): Promise<AgreementRecord>; export interface AgreementRenderArgs extends CommandOptions { id: string; output?: string; renderer?: typeof fillTemplate; } export declare function runAgreementRender(args: AgreementRenderArgs): Promise<AgreementRecord>; export declare function loadAgreementTerms(path?: string, sets?: string[]): Record<string, unknown>; export {}; //# sourceMappingURL=agreements.d.ts.map