@eriknaslund/skiss 0.3.0 → 0.5.0

package/dist/index.d.ts

@@ -55,6 +55,12 @@ interface FieldNode {
 }
 interface ClassNode {
     name: Name;
+    /**
+     * The class after `<` (SPEC §3.10), set by `parse` whenever one is written.
+     * `resolve` clears it on the class whose `<` closes a circle, as it clears
+     * `identifier` on a second `*`, so no generator has to know about circles.
+     */
+    parent?: Name;
     system?: Name;
     similarTo?: Name;
     description?: string;
@@ -65,10 +71,11 @@ interface ClassNode {
 type Severity = 'error' | 'warning';
 /**
  * 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,
+ * `resolve` the `W_` codes and `E_INHERITANCE_CYCLE`, the one error no single
+ * line can see (SPEC §7), 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_MULTIPLE_IDENTIFIERS' | 'E_NOT_YAML';
+type DiagnosticCode = 'E_UNPARSABLE' | 'E_FIELD_WITHOUT_CLASS' | 'E_MISSING_TYPE' | 'E_UNCLOSED_MANY' | 'E_BAD_NAME' | 'E_INHERITANCE_CYCLE' | 'W_UNKNOWN_TYPE' | 'W_UNDECLARED_CLASS' | 'W_UNDECLARED_FIELD' | 'W_DUPLICATE_CLASS' | 'W_DUPLICATE_FIELD' | 'W_DUPLICATE_ENUM_VALUE' | 'W_MULTIPLE_IDENTIFIERS' | 'W_REDUNDANT_OVERRIDE' | 'E_NOT_YAML';
 interface Diagnostic {
     severity: Severity;
     code: DiagnosticCode;
@@ -106,9 +113,10 @@ interface LinkMLAttribute {
     identifier?: boolean;
     annotations?: LinkMLAnnotations;
 }
-/** One entry under `classes`. Key order is SPEC §5.3. */
+/** One entry under `classes`. Key order is SPEC §5.1, Inheritance. */
 interface LinkMLClass {
     description?: string;
+    is_a?: string;
     annotations?: LinkMLAnnotations;
     close_mappings?: string[];
     attributes?: Record<string, LinkMLAttribute>;
@@ -175,9 +183,9 @@ 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`, `schema`. `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.
+ * `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;
@@ -215,6 +223,6 @@ interface ResolvedDocument extends Document {
 }
 declare function resolve(doc: Document): ResolvedDocument;
 
-declare const VERSION = "0.3.0";
+declare const VERSION = "0.5.0";
 
 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 };