skir-codemirror-plugin 1.0.0 → 1.0.1

package/README.md

@@ -28,9 +28,12 @@ npm install skir-codemirror-plugin
 The package root exports:
 
 - `createEditorState`
+- `ensureJsonState`
+- `toJson`
 - `CreateEditorStateParams` (type)
 - `CustomTheme` (type)
-- `Json` (type)
+- `JsonState` (type)
+- all types from `./json/types`
 
 ## Usage
 
@@ -60,6 +63,41 @@ new EditorView({
 });
 ```
 
+## Read Current JSON Value
+
+Use `ensureJsonState(view, schema)` to force parse/validation against the current
+document and retrieve the latest state. Then call `toJson(...)` on
+`parseResult.value` when it exists.
+
+```ts
+import { EditorView } from "@codemirror/view";
+import {
+	createEditorState,
+	ensureJsonState,
+	toJson,
+	type TypeDefinition,
+} from "skir-codemirror-plugin";
+
+const schema: TypeDefinition = {
+	type: { kind: "primitive", value: "string" },
+	records: [],
+};
+
+const view = new EditorView({
+	state: createEditorState({ schema }),
+	parent: document.getElementById("editor")!,
+});
+
+const jsonState = ensureJsonState(view, schema);
+
+if (jsonState.parseResult.value) {
+	const jsonValue = toJson(jsonState.parseResult.value);
+	console.log("Current JSON value:", jsonValue);
+} else {
+	console.log("Cannot convert to JSON:", jsonState.parseResult.errors);
+}
+```
+
 ## createEditorState Parameters
 
 ```ts

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 export { createEditorState } from "./codemirror/create_editor_state";
 export type { CreateEditorStateParams, CustomTheme, } from "./codemirror/create_editor_state";
-export type { Json } from "./json/types";
+export { ensureJsonState } from "./codemirror/json_state";
+export type { JsonState } from "./codemirror/json_state";
+export { toJson } from "./json/to_json";
+export type * from "./json/types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,YAAY,EACV,uBAAuB,EACvB,WAAW,GACZ,MAAM,kCAAkC,CAAC;AAC1C,YAAY,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,YAAY,EACV,uBAAuB,EACvB,WAAW,GACZ,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,YAAY,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,mBAAmB,cAAc,CAAC"}

package/dist/index.js

@@ -1,2 +1,4 @@
 export { createEditorState } from "./codemirror/create_editor_state";
+export { ensureJsonState } from "./codemirror/json_state";
+export { toJson } from "./json/to_json";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC","sourcesContent":["export { createEditorState } from \"./codemirror/create_editor_state\";\nexport type {\n  CreateEditorStateParams,\n  CustomTheme,\n} from \"./codemirror/create_editor_state\";\nexport type { Json } from \"./json/types\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAKrE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC","sourcesContent":["export { createEditorState } from \"./codemirror/create_editor_state\";\nexport type {\n  CreateEditorStateParams,\n  CustomTheme,\n} from \"./codemirror/create_editor_state\";\nexport { ensureJsonState } from \"./codemirror/json_state\";\nexport type { JsonState } from \"./codemirror/json_state\";\nexport { toJson } from \"./json/to_json\";\nexport type * from \"./json/types\";\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skir-codemirror-plugin",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
   "homepage": "https://github.com/gepheum/skir-codemirror-plugin#readme",
   "bugs": {

package/src/index.ts

@@ -3,4 +3,7 @@ export type {
   CreateEditorStateParams,
   CustomTheme,
 } from "./codemirror/create_editor_state";
-export type { Json } from "./json/types";
+export { ensureJsonState } from "./codemirror/json_state";
+export type { JsonState } from "./codemirror/json_state";
+export { toJson } from "./json/to_json";
+export type * from "./json/types";