@neverblink/linkml 0.8.7-5-25b1515-SNAPSHOT

package/README.md

@@ -0,0 +1,62 @@
+# @neverblink/linkml
+
+JavaScript / TypeScript bindings for [LinkML-Scala](https://github.com/NeverBlink-OSS/linkml-scala) —
+LinkML schema validation and multi-format code generation (JSON Schema, SHACL, RDFS, Scala),
+compiled from Scala 3 to JavaScript via [Scala.js](https://www.scala-js.org/).
+
+The package ships a single self-contained ES module. It has no runtime dependencies.
+
+## Installation
+
+```shell
+npm install @neverblink/linkml
+```
+
+## Usage
+
+```js
+import { LinkML } from "@neverblink/linkml";
+
+const schema = `
+id: https://example.org/my-schema
+name: my-schema
+default_range: string
+classes:
+  Person:
+    attributes:
+      name:
+      age:
+        range: integer
+`;
+
+// The second argument is an import map (filename -> YAML source) for any
+// models referenced via LinkML \`imports:\`. Pass {} when there are none.
+const jsonSchema = LinkML.jsonSchema(schema, {});
+console.log(jsonSchema);
+```
+
+### Available functions
+
+| Function | Returns | Notes |
+| --- | --- | --- |
+| `jsonSchema(schema, importMap, open?, treeRootOverride?)` | `string` | JSON Schema |
+| `shacl(schema, importMap, open?)` | `string` | SHACL shapes in N-Triples |
+| `scala(schema, importMap, packageName)` | `Record<string, string>` | filename → generated Scala |
+| `lint(schema, importMap, maxProblems?, verbose?)` | `string` | problem summary, empty if valid |
+
+See [`index.d.ts`](./index.d.ts) for full type signatures.
+
+## Browser use
+
+The module works in Node.js as-is. In the browser it references `process.cwd`
+once, so provide a minimal shim before importing:
+
+```html
+<script>
+  var process = { cwd: () => "/" };
+</script>
+```
+
+## License
+
+Apache-2.0 © [NeverBlink](https://neverblink.eu)

package/index.d.ts

@@ -0,0 +1,65 @@
+/**
+ * TypeScript declarations for the LinkML-Scala JS library (`@neverblink/linkml`).
+ *
+ * The implementation is generated from Scala by Scala.js; this file is
+ * hand-maintained and must be kept in sync with
+ * `generator/src-js/eu/neverblink/linkml/js/LinkMlJsApi.scala`.
+ */
+
+/**
+ * Mapping from imported model filename to its LinkML model source (YAML).
+ * Every `imports:` entry referenced by the main schema must have a matching
+ * entry here.
+ */
+export type ImportMap = Record<string, string>;
+
+export interface LinkMLApi {
+  /**
+   * Generate JSON Schema from the provided LinkML model.
+   *
+   * @param mainSchema Main LinkML model in YAML format.
+   * @param importMap Mapping from filename to LinkML models (YAML) for imports.
+   * @param open Whether the JSON Schema should allow `additionalProperties`. Defaults to `false`.
+   * @param treeRootOverride Override for the LinkML `tree_root` class at the root of the schema.
+   * @returns Serialized JSON Schema.
+   */
+  jsonSchema(
+    mainSchema: string,
+    importMap: ImportMap,
+    open?: boolean,
+    treeRootOverride?: string,
+  ): string;
+
+  /**
+   * Generate SHACL shapes (in N-Triples format) from the provided LinkML model.
+   *
+   * @param mainSchema Main LinkML model in YAML format.
+   * @param importMap Mapping from filename to LinkML models (YAML) for imports.
+   * @param open Whether the SHACL shapes should be open (allowing additional properties). Defaults to `false`.
+   * @returns SHACL shapes in N-Triples format.
+   */
+  shacl(mainSchema: string, importMap: ImportMap, open?: boolean): string;
+
+  /**
+   * Generate Scala code from the provided LinkML model.
+   *
+   * @param mainSchema Main LinkML model in YAML format.
+   * @param importMap Mapping from filename to LinkML models (YAML) for imports.
+   * @param packageName Package to generate the classes in.
+   * @returns Mapping from filename to the generated Scala source.
+   */
+  scala(mainSchema: string, importMap: ImportMap, packageName: string): Record<string, string>;
+
+  /**
+   * Lint the provided LinkML model, reporting problems that may cause issues.
+   *
+   * @param mainSchema Main LinkML model in YAML format.
+   * @param importMap Mapping from filename to LinkML models (YAML) for imports.
+   * @param maxProblems Maximum number of problems to include in the summary. Defaults to `5`.
+   * @param verbose Whether to use the more verbose problem descriptions. Defaults to `false`.
+   * @returns The summary of detected problems, or an empty string if everything is correct.
+   */
+  lint(mainSchema: string, importMap: ImportMap, maxProblems?: number, verbose?: boolean): string;
+}
+
+export declare const LinkML: LinkMLApi;