@teamkeel/wasm 0.314.0 → 0.315.0

package/index.d.ts

@@ -11,6 +11,29 @@ export function completions(
   configFile: string
 ): Promise<CompletionResult>;
 
+export function getDefinition(
+  req: GetDefinitionRequest
+): Promise<DefinitionResult>;
+
+export interface DefinitionResult {
+  schema?: Position;
+  function?: { name: string };
+}
+
+export interface SchemaDefinition {
+  schema: SchemaDefinition;
+}
+
+export interface GetDefinitionRequest {
+  position: Position;
+  schemaFiles: SchemaFile[];
+}
+
+export interface SchemaFile {
+  filename: string;
+  contents: string;
+}
+
 export interface SimplePosition {
   column: number;
   line: number;

package/index.js

@@ -30,8 +30,14 @@ async function completions() {
   return api.completions(...arguments);
 }
 
+async function getDefinition() {
+  const api = await keel();
+  return api.getDefinition(...arguments);
+}
+
 module.exports = {
   format,
   validate,
   completions,
+  getDefinition,
 };

package/index.test.ts

@@ -1,4 +1,4 @@
-import { format, validate, completions } from "./index";
+import { format, validate, completions, getDefinition } from "./index";
 import { test, expect } from "vitest";
 
 const configFile = `
@@ -71,3 +71,63 @@ test("validate - invalid schema", async () => {
   expect(errors[0].code).toEqual("E025");
   expect(errors[0].message).toEqual(` unexpected token "<EOF>" (expected "}")`);
 });
+
+test("getDefinition", async () => {
+  const result = await getDefinition({
+    position: {
+      line: 7,
+      column: 21,
+      offset: 0,
+      filename: "myschema.keel",
+    },
+    schemaFiles: [
+      {
+        filename: "myschema.keel",
+        contents: `
+model Person {
+  fields {
+    name Text
+  }
+  operations {
+    list getPeople(name) 
+  }
+}
+        `,
+      },
+    ],
+  });
+
+  expect(result).toEqual({
+    function: null,
+    schema: {
+      filename: "myschema.keel",
+      line: 4,
+      column: 5,
+    },
+  });
+});
+
+test("getDefinition - no result", async () => {
+  const result = await getDefinition({
+    position: {
+      line: 1,
+      column: 1,
+      offset: 0,
+      filename: "myschema.keel",
+    },
+    schemaFiles: [
+      {
+        filename: "myschema.keel",
+        contents: `
+model Person {
+  fields {
+    name Text
+  }
+}
+        `,
+      },
+    ],
+  });
+
+  expect(result).toBeNull();
+});

package/lib/main.go

@@ -9,6 +9,7 @@ import (
 	"github.com/teamkeel/keel/config"
 	"github.com/teamkeel/keel/schema"
 	"github.com/teamkeel/keel/schema/completions"
+	"github.com/teamkeel/keel/schema/definitions"
 	"github.com/teamkeel/keel/schema/format"
 	"github.com/teamkeel/keel/schema/node"
 	"github.com/teamkeel/keel/schema/parser"
@@ -20,9 +21,10 @@ func init() {
 	// we have to declare our functions in an init func otherwise they aren't
 	// available in JS land at the call time.
 	js.Global().Set("keel", js.ValueOf(map[string]any{
-		"validate":    js.FuncOf(validate),
-		"format":      js.FuncOf(formatSchema),
-		"completions": js.FuncOf(provideCompletions),
+		"validate":      js.FuncOf(validate),
+		"format":        js.FuncOf(formatSchema),
+		"completions":   js.FuncOf(provideCompletions),
+		"getDefinition": js.FuncOf(getDefinition),
 	}))
 }
 
@@ -94,6 +96,49 @@ func provideCompletions(this js.Value, args []js.Value) any {
 	})
 }
 
+// Expected argument to definitions API:
+//
+//	{
+//		position: {
+//			filename: "",
+//			line: 1,
+//			column: 1,
+//		},
+//		schemaFiles: [
+//			{
+//				filename: "",
+//				contents: "",
+//			},
+//		],
+//	}
+func getDefinition(this js.Value, args []js.Value) any {
+	return newPromise(func() (any, error) {
+		positionArg := args[0].Get("position")
+		pos := definitions.Position{
+			Filename: positionArg.Get("filename").String(),
+			Line:     positionArg.Get("line").Int(),
+			Column:   positionArg.Get("column").Int(),
+		}
+
+		schemaFilesArg := args[0].Get("schemaFiles")
+		schemaFiles := []*reader.SchemaFile{}
+		for i := 0; i < schemaFilesArg.Length(); i++ {
+			f := schemaFilesArg.Index(i)
+			schemaFiles = append(schemaFiles, &reader.SchemaFile{
+				FileName: f.Get("filename").String(),
+				Contents: f.Get("contents").String(),
+			})
+		}
+
+		def := definitions.GetDefinition(schemaFiles, pos)
+		if def == nil {
+			return nil, nil
+		}
+
+		return toMap(def)
+	})
+}
+
 func formatSchema(this js.Value, args []js.Value) any {
 	return newPromise(func() (any, error) {
 		src := args[0].String()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamkeel/wasm",
-  "version": "0.314.0",
+  "version": "0.315.0",
   "description": "A wrapper around the Keel WASM binary",
   "main": "./index.js",
   "types": "./index.d.ts",