@formfeed/devkit 0.3.10 → 0.3.12

package/types/index.d.ts

@@ -1,16 +1,18 @@
 export { DevkitError } from './lib/errors.js';
-export { defaultProjectConfig, findProject, isIgnored, loadProject, projectAround, writeProjectConfig } from './lib/project-config.js';
+export { defaultProjectConfig, findProject, isIgnored, loadProject, projectAround, writeProjectConfig, } from './lib/project-config.js';
 export type { Project, ProjectConfig } from './lib/project-config.js';
 export { contentHash, defaultData, listTemplateSlugs, officeVersionPayload, partialContentHash, partialResolver, readState, readTemplate, recordSharedPartial, recordSync, sharedPartialNames, sharedPartialPath, templateDir, templateFileName, titleFromSlug, versionPayload, writePartials, writeState, writeTemplate, } from './lib/project.js';
-export type { LocalOfficeFile, LocalTemplate, ProjectState, SharedPartialState, TemplateMeta, TemplateState } from './lib/project.js';
+export type { LocalOfficeFile, LocalTemplate, ProjectState, SharedPartialState, TemplateMeta, TemplateState, } from './lib/project.js';
 export { brandFromJson, brandPath, readBrand, writeBrand } from './lib/brand.js';
 export { collectPartials } from './lib/partials.js';
 export type { CollectedPartials } from './lib/partials.js';
-export { diagnose, htmlSnapshot, officeSnapshot, prettyXml, previewDocument, renderContext, renderLocal, renderOfficeLocal, renderedSettings } from './lib/local-render.js';
+export { diagnose, htmlSnapshot, officeSnapshot, prettyXml, previewDocument, renderContext, renderLocal, renderOfficeLocal, renderedSettings, } from './lib/local-render.js';
 export type { LocalDiagnostic, OfficeLocalOptions } from './lib/local-render.js';
-export { contentTypeFor, listLocalFiles, localFilePath, sha256File, writeLocalFile } from './lib/files.js';
+export { declaredEinvoice, diagnoseEinvoice, localEinvoiceXml, } from './lib/einvoice.js';
+export type { DataSetDiagnostics } from './lib/einvoice.js';
+export { contentTypeFor, listLocalFiles, localFilePath, sha256File, writeLocalFile, } from './lib/files.js';
 export type { LocalFile, LocalFileListing } from './lib/files.js';
 export type { LocalRenderOptions } from './lib/local-render.js';
 export { parseRedactPath, redactData, redactString } from './lib/redact.js';
 export { defaultTypesFile, generateTypes, localTypeSource } from './lib/types/index.js';
-export type { SchemaOrigin, TypeScriptOptions, TypeSource, TypesLanguage } from './lib/types/index.js';
+export type { SchemaOrigin, TypeScriptOptions, TypeSource, TypesLanguage, } from './lib/types/index.js';

package/types/lib/einvoice.d.cts

@@ -0,0 +1,37 @@
+import { type EinvoiceOptions, type EinvoiceOptionsInput, type Invoice } from '@formfeed/engine';
+import type { LocalDiagnostic } from './local-render.cjs';
+import type { LocalTemplate } from './project.cjs';
+/**
+ * The e-invoice of a template folder (spec 17): what `settings.json` declares, the check of every
+ * data set against it, and the XML itself. All of it runs offline, with the code the API runs, so
+ * what `formfeed validate` accepts the API accepts too.
+ */
+/**
+ * The e-invoice a template declares in `settings.json`, with every default filled in; `null` when
+ * it declares none. `override` is merged over it like a request's `post.einvoice`; `{}` asks for an
+ * e-invoice with the defaults from a template that declares nothing.
+ */
+export declare function declaredEinvoice(tpl: LocalTemplate, override?: EinvoiceOptionsInput | false): EinvoiceOptions | null;
+/** The findings of one data set, with the file they are in. */
+export interface DataSetDiagnostics {
+    dataSet: string;
+    /** Relative to the template folder: `data/default.json`. */
+    file: string;
+    diagnostics: LocalDiagnostic[];
+}
+/**
+ * Every data set of an invoice template against the `_invoice` schema and the rules of EN 16931
+ * (spec 17 §8). Each is an error: a render with that data fails with `einvoice_data_invalid`, and a
+ * template that declares an e-invoice renders nothing else. Empty for a template that declares
+ * none; one warning for an image template, where the declaration has no effect.
+ */
+export declare function diagnoseEinvoice(tpl: LocalTemplate): DataSetDiagnostics[];
+/**
+ * The XML of one data set, as a render of the template would embed it. Throws a validation error
+ * that lists what is wrong with the block when it does not pass.
+ */
+export declare function localEinvoiceXml(tpl: LocalTemplate, data: unknown, override?: EinvoiceOptionsInput): {
+    xml: string;
+    invoice: Invoice;
+    options: EinvoiceOptions;
+};

package/types/lib/einvoice.d.ts

@@ -0,0 +1,37 @@
+import { type EinvoiceOptions, type EinvoiceOptionsInput, type Invoice } from '@formfeed/engine';
+import type { LocalDiagnostic } from './local-render.js';
+import type { LocalTemplate } from './project.js';
+/**
+ * The e-invoice of a template folder (spec 17): what `settings.json` declares, the check of every
+ * data set against it, and the XML itself. All of it runs offline, with the code the API runs, so
+ * what `formfeed validate` accepts the API accepts too.
+ */
+/**
+ * The e-invoice a template declares in `settings.json`, with every default filled in; `null` when
+ * it declares none. `override` is merged over it like a request's `post.einvoice`; `{}` asks for an
+ * e-invoice with the defaults from a template that declares nothing.
+ */
+export declare function declaredEinvoice(tpl: LocalTemplate, override?: EinvoiceOptionsInput | false): EinvoiceOptions | null;
+/** The findings of one data set, with the file they are in. */
+export interface DataSetDiagnostics {
+    dataSet: string;
+    /** Relative to the template folder: `data/default.json`. */
+    file: string;
+    diagnostics: LocalDiagnostic[];
+}
+/**
+ * Every data set of an invoice template against the `_invoice` schema and the rules of EN 16931
+ * (spec 17 §8). Each is an error: a render with that data fails with `einvoice_data_invalid`, and a
+ * template that declares an e-invoice renders nothing else. Empty for a template that declares
+ * none; one warning for an image template, where the declaration has no effect.
+ */
+export declare function diagnoseEinvoice(tpl: LocalTemplate): DataSetDiagnostics[];
+/**
+ * The XML of one data set, as a render of the template would embed it. Throws a validation error
+ * that lists what is wrong with the block when it does not pass.
+ */
+export declare function localEinvoiceXml(tpl: LocalTemplate, data: unknown, override?: EinvoiceOptionsInput): {
+    xml: string;
+    invoice: Invoice;
+    options: EinvoiceOptions;
+};

package/types/lib/project.d.cts

@@ -5,7 +5,8 @@ import type { Project } from './project-config.cjs';
  * The template folder of spec 15 §2. `template.json` (name, kind, engine, description, tags) is
  * the one addition to the spec's layout: `push` needs it to create a template that does not exist
  * remotely, `pull` writes it. Header and footer live in their own files and fold back into
- * `settings.header.html` / `settings.footer.html`, as the editor's tabs do.
+ * `settings.header.html` / `settings.footer.html`, as the editor's tabs do; a visual design lives in
+ * `design.json` and folds back into `settings.design`.
  */
 export interface TemplateMeta {
     name: string;

package/types/lib/project.d.ts

@@ -5,7 +5,8 @@ import type { Project } from './project-config.js';
  * The template folder of spec 15 §2. `template.json` (name, kind, engine, description, tags) is
  * the one addition to the spec's layout: `push` needs it to create a template that does not exist
  * remotely, `pull` writes it. Header and footer live in their own files and fold back into
- * `settings.header.html` / `settings.footer.html`, as the editor's tabs do.
+ * `settings.header.html` / `settings.footer.html`, as the editor's tabs do; a visual design lives in
+ * `design.json` and folds back into `settings.design`.
  */
 export interface TemplateMeta {
     name: string;