@eriknaslund/skiss 0.2.1 → 0.4.0

package/dist/index.d.ts

@@ -63,8 +63,12 @@ interface ClassNode {
     line: number;
 }
 type Severity = 'error' | 'warning';
-/** Codes from the table in docs/ARCHITECTURE.md. `parse` adds the `E_` codes, `resolve` the `W_` codes. */
-type DiagnosticCode = 'E_UNPARSABLE' | 'E_FIELD_WITHOUT_CLASS' | 'E_MISSING_TYPE' | 'E_UNCLOSED_MANY' | 'E_BAD_NAME' | 'W_UNKNOWN_TYPE' | 'W_UNDECLARED_CLASS' | 'W_UNDECLARED_FIELD' | 'W_DUPLICATE_CLASS' | 'W_DUPLICATE_FIELD' | 'W_MULTIPLE_IDENTIFIERS';
+/**
+ * Codes from the tables in docs/ARCHITECTURE.md. `parse` adds the `E_` codes,
+ * `resolve` the `W_` codes, and `importLinkML` the one code of its own,
+ * `E_NOT_YAML`, for a text no schema can be read out of.
+ */
+type DiagnosticCode = 'E_UNPARSABLE' | 'E_FIELD_WITHOUT_CLASS' | 'E_MISSING_TYPE' | 'E_UNCLOSED_MANY' | 'E_BAD_NAME' | 'W_UNKNOWN_TYPE' | 'W_UNDECLARED_CLASS' | 'W_UNDECLARED_FIELD' | 'W_DUPLICATE_CLASS' | 'W_DUPLICATE_FIELD' | 'W_DUPLICATE_ENUM_VALUE' | 'W_MULTIPLE_IDENTIFIERS' | 'E_NOT_YAML';
 interface Diagnostic {
     severity: Severity;
     code: DiagnosticCode;
@@ -168,6 +172,41 @@ declare function compile(source: string, opts: CompileOptions): CompileResult;
  */
 declare function formatDiagnostic(d: Diagnostic, file?: string): string;
 
+/**
+ * One thing the projection could not carry. `kind` is the LinkML key, or one
+ * of the projection's own kinds: `renamed`, `narrowed`, `inlined`,
+ * `enum_detail`, `annotation`, `reworded`, `schema`, `unreadable`. `element`
+ * names what carried it as the sketch names it — `Class`, `Class.field` — or,
+ * for an enum, its LinkML name, which the sketch does not keep.
+ */
+interface Dropped {
+    kind: string;
+    element: string;
+    detail?: string;
+}
+interface FromLinkMLResult {
+    /** The projected sketch, parsed from `source`, so every node has a position. */
+    document: Document;
+    /** The sketch as canonical Skiss text. */
+    source: string;
+    /** SPEC §8, in schema order: class by class, then enums, then the schema itself. */
+    dropped: Dropped[];
+}
+declare function fromLinkML(schema: unknown): FromLinkMLResult;
+declare function formatDropped(dropped: Dropped[]): string;
+
+declare function toSkiss(doc: Document): string;
+
+interface ImportResult {
+    /** The projected sketch as canonical Skiss text, `\n`-terminated. */
+    output: string;
+    /** SPEC §8, in schema order: what the projection could not carry. */
+    dropped: Dropped[];
+    /** The diagnostics of the projected sketch. Their lines are lines of `output`. */
+    diagnostics: Diagnostic[];
+}
+declare function importLinkML(text: string): ImportResult;
+
 declare function parse(source: string): Document;
 
 /** What `resolve` returns: a `Document` whose `undeclared` list is always present. */
@@ -176,6 +215,6 @@ interface ResolvedDocument extends Document {
 }
 declare function resolve(doc: Document): ResolvedDocument;
 
-declare const VERSION = "0.2.1";
+declare const VERSION = "0.4.0";
 
-export { type ClassNode, type CompileOptions, type CompileResult, type Diagnostic, type DiagnosticCode, type Document, type FieldNode, type JoinRef, type LinkMLAnnotations, type LinkMLAttribute, type LinkMLClass, type LinkMLCompileOptions, type LinkMLEnum, type LinkMLOptions, type LinkMLSchema, type MermaidCompileOptions, type MermaidOptions, type Name, type Primitive, type ResolvedDocument, type SerializeFormat, type Severity, type TypeRef, VERSION, compile, formatDiagnostic, parse, resolve, serialize, toLinkML, toMermaid };
+export { type ClassNode, type CompileOptions, type CompileResult, type Diagnostic, type DiagnosticCode, type Document, type Dropped, type FieldNode, type FromLinkMLResult, type ImportResult, type JoinRef, type LinkMLAnnotations, type LinkMLAttribute, type LinkMLClass, type LinkMLCompileOptions, type LinkMLEnum, type LinkMLOptions, type LinkMLSchema, type MermaidCompileOptions, type MermaidOptions, type Name, type Primitive, type ResolvedDocument, type SerializeFormat, type Severity, type TypeRef, VERSION, compile, formatDiagnostic, formatDropped, fromLinkML, importLinkML, parse, resolve, serialize, toLinkML, toMermaid, toSkiss };