@intersystems-community/ascot 0.3.1 → 0.4.1

package/README.md

@@ -40,13 +40,13 @@ await ws.hover("file:///T.cls", { line: 5, character: 7 }); // the `x` being wri
 // "```objectscript\n%DataType = 1\n```"
 ````
 
-To provide declarations for documents that aren't in the workspace, extend `IrisConnection`,
+To provide declarations for documents that aren't in the workspace, extend `IrisContext`,
 override the lookups you can answer, and pass an instance:
 
 ```ts
-import { IrisConnection, type ClassInfo } from "@intersystems-community/ascot";
+import { IrisContext, type ClassInfo } from "@intersystems-community/ascot";
 
-class MyIris extends IrisConnection {
+class MyIris extends IrisContext {
   override async getCls(cls: string): Promise<ClassInfo | undefined> {
     return undefined; // look `cls` up, e.g. over IRIS's REST API
   }
@@ -55,6 +55,22 @@ class MyIris extends IrisConnection {
 const connected = await createWorkspace(new MyIris());
 ```
 
+Or extend `Atelier` with the two Atelier REST API requests, `query` (the rows of
+`/action/query` as a JSON array) and `getDoc` (the text of `/doc/{name}`), and let ascot make
+the lookups itself:
+
+```ts
+import { Atelier } from "@intersystems-community/ascot";
+
+class MyAtelier extends Atelier {
+  override async getDoc(name: string): Promise<string | undefined> {
+    return undefined; // GET /doc/{name}, e.g. with your own credentials and session
+  }
+}
+
+const connected = await createWorkspace(new MyAtelier());
+```
+
 `createWorkspace` takes an optional second argument, a `Style` applied to every document:
 
 ```ts

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { Root } from "../generated/ascot.js" with { "resolution-mode": "import" };
-import type { ClassInfo, RoutineSource, Style } from "../generated/interfaces/iris-ascot-common.js" with { "resolution-mode": "import"
+import type { ClassInfo, RoutineInfo, Source, Style } from "../generated/interfaces/iris-ascot-common.js" with { "resolution-mode": "import"
 };
 export type * from "../generated/interfaces/iris-ascot-common.js";
 type RawWorkspace = InstanceType<Root["exported"]["Workspace"]>;
@@ -8,19 +8,23 @@ type RawWorkspace = InstanceType<Root["exported"]["Workspace"]>;
 export type Workspace = {
     [K in keyof RawWorkspace]: RawWorkspace[K] extends (...args: infer A) => infer R ? (...args: A) => Promise<Awaited<R>> : RawWorkspace[K];
 };
-export declare class IrisConnection {
+/** What ascot asks about code outside the workspace. A failed lookup throws; ascot then takes
+ * what it looked for on trust and says why. */
+export declare class IrisContext {
     /** A class's own members and metadata. */
     getCls(_cls: string): Promise<ClassInfo | undefined>;
     /** The text of `name.inc`. */
-    getInc(_name: string): Promise<RoutineSource | undefined>;
-    /** The text of `name.int` or `name.mac`: `{ tag: "none" }` if there is no such routine,
-     * `val: undefined` if its source isn't available. */
-    getIntOrMac(_name: string): Promise<{
-        tag: "none";
-    } | {
-        tag: "some";
-        val: RoutineSource | undefined;
-    }>;
+    getInc(_name: string): Promise<Source | undefined>;
+    /** The labels of routine `name`, `undefined` if there is no such routine. */
+    getRtn(_name: string): Promise<RoutineInfo | undefined>;
+}
+/** The two Atelier REST API requests, for ascot to make `IrisContext`'s lookups with. A failed
+ * request throws, like a failed lookup. */
+export declare class Atelier {
+    /** The rows of `/action/query` as a JSON array, each an object keyed by column name. */
+    query(_sql: string, _params: string[]): Promise<string>;
+    /** The text of `/doc/{name}`, `undefined` if there is no such document. */
+    getDoc(_name: string): Promise<string | undefined>;
 }
 /** A workspace whose calls run one at a time, resolving what it doesn't contain through `iris`. */
-export declare function createWorkspace(iris?: IrisConnection, style?: Style): Promise<Workspace>;
+export declare function createWorkspace(iris?: IrisContext | Atelier, style?: Style): Promise<Workspace>;

package/dist/index.js

@@ -33,11 +33,13 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IrisConnection = void 0;
+exports.Atelier = exports.IrisContext = void 0;
 exports.createWorkspace = createWorkspace;
 const fs = __importStar(require("node:fs"));
 const path = __importStar(require("node:path"));
-class IrisConnection {
+/** What ascot asks about code outside the workspace. A failed lookup throws; ascot then takes
+ * what it looked for on trust and says why. */
+class IrisContext {
     /** A class's own members and metadata. */
     async getCls(_cls) {
         return undefined;
@@ -46,16 +48,28 @@ class IrisConnection {
     async getInc(_name) {
         return undefined;
     }
-    /** The text of `name.int` or `name.mac`: `{ tag: "none" }` if there is no such routine,
-     * `val: undefined` if its source isn't available. */
-    async getIntOrMac(_name) {
-        return { tag: "some", val: undefined };
+    /** The labels of routine `name`, `undefined` if there is no such routine. */
+    async getRtn(_name) {
+        return { labels: undefined, uri: undefined };
     }
 }
-exports.IrisConnection = IrisConnection;
+exports.IrisContext = IrisContext;
+/** The two Atelier REST API requests, for ascot to make `IrisContext`'s lookups with. A failed
+ * request throws, like a failed lookup. */
+class Atelier {
+    /** The rows of `/action/query` as a JSON array, each an object keyed by column name. */
+    async query(_sql, _params) {
+        throw new Error("no IRIS connection");
+    }
+    /** The text of `/doc/{name}`, `undefined` if there is no such document. */
+    async getDoc(_name) {
+        throw new Error("no IRIS connection");
+    }
+}
+exports.Atelier = Atelier;
 const wasm = import("../generated/ascot.js").then(({ instantiate }) => instantiate((name) => new WebAssembly.Module(fs.readFileSync(path.resolve(__dirname, "../lib", name))), {
     "iris:ascot/common": {},
-    "iris:ascot/imported": { IrisConnection },
+    "iris:ascot/imported": { IrisContext, Atelier },
 }));
 wasm.catch(() => { }); // reported by createWorkspace instead
 // jco's jspi glue allows only one in-flight suspended call per component instance --
@@ -87,6 +101,48 @@ function serialize(instance) {
 /** A workspace whose calls run one at a time, resolving what it doesn't contain through `iris`. */
 async function createWorkspace(iris, style) {
     const root = await wasm;
-    return serialize(new root.exported.Workspace(iris, style));
+    const env = iris instanceof Atelier
+        ? { tag: "atelier", val: new FailingAtelier(iris) }
+        : iris && { tag: "context", val: new FailingContext(iris) };
+    return serialize(new root.exported.Workspace(env, style));
+}
+// jco rethrows a thrown `Error` to the caller, and hands ascot only a thrown `{ payload }` as the
+// failure; so what the host throws becomes one.
+class FailingContext extends IrisContext {
+    inner;
+    constructor(inner) {
+        super();
+        this.inner = inner;
+    }
+    getCls(cls) {
+        return payload(() => this.inner.getCls(cls));
+    }
+    getInc(name) {
+        return payload(() => this.inner.getInc(name));
+    }
+    getRtn(name) {
+        return payload(() => this.inner.getRtn(name));
+    }
+}
+class FailingAtelier extends Atelier {
+    inner;
+    constructor(inner) {
+        super();
+        this.inner = inner;
+    }
+    query(sql, params) {
+        return payload(() => this.inner.query(sql, params));
+    }
+    getDoc(name) {
+        return payload(() => this.inner.getDoc(name));
+    }
+}
+async function payload(request) {
+    try {
+        return await request();
+    }
+    catch (e) {
+        throw { payload: e instanceof Error ? e.message : String(e) };
+    }
 }
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,MAAY,EAAE,oCAAgB;AAC9B,MAAY,IAAI,sCAAkB;AA4BlC;IACC,0CAA0C;IAC1C,KAAK,CAAC,MAAM,CAAC,IAAY;QACxB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,8BAA8B;IAC9B,KAAK,CAAC,MAAM,CAAC,KAAa;QACzB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD;yDACqD;IACrD,KAAK,CAAC,WAAW,CAChB,KAAa;QAEb,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;IACxC,CAAC;CACD;;AAED,MAAM,IAAI,GAAkB,MAAM,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CACpF,WAAW,CACV,CAAC,IAAY,EAAE,EAAE,CAChB,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EACjF;IACC,mBAAmB,EAAE,EAAE;IACvB,qBAAqB,EAAE,EAAE,cAAc,EAAE;CAChC,CACV,CACD,CAAC;AACF,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAC,sCAAsC;AAE5D,qFAAqF;AACrF,qFAAqF;AACrF,wFAAwF;AACxF,kEAAkE;AAClE,IAAI,IAAI,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;AAE5C,SAAS,SAAS,CAAC,QAAsB;IACxC,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE;QAC1B,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ;YACzB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClD,IAAI,OAAO,KAAK,KAAK,UAAU;gBAAE,OAAO,KAAK,CAAC;YAC9C,OAAO,KAAK,EAAE,GAAG,IAAe,EAAE,EAAE;gBACnC,MAAM,IAAI,GAAG,IAAI,CAAC;gBAClB,IAAI,OAAoB,CAAC;gBACzB,IAAI,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;gBAC3D,MAAM,IAAI,CAAC;gBACX,IAAI,CAAC;oBACJ,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBACxC,CAAC;wBAAS,CAAC;oBACV,OAAO,EAAE,CAAC;gBACX,CAAC;YACF,CAAC,CAAC;QACH,CAAC;KACD,CAAyB,CAAC;AAC5B,CAAC;AAED,mGAAmG;AAC5F,KAAK,0BAA0B,IAAqB,EAAE,KAAa;IACzE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;IACxB,OAAO,SAAS,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;AAC5D,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,MAAY,EAAE,oCAAgB;AAC9B,MAAY,IAAI,sCAAkB;AA6BlC;+CAC+C;AAC/C;IACC,0CAA0C;IAC1C,KAAK,CAAC,MAAM,CAAC,IAAY;QACxB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,8BAA8B;IAC9B,KAAK,CAAC,MAAM,CAAC,KAAa;QACzB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,6EAA6E;IAC7E,KAAK,CAAC,MAAM,CAAC,KAAa;QACzB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;IAC9C,CAAC;CACD;;AAED;2CAC2C;AAC3C;IACC,wFAAwF;IACxF,KAAK,CAAC,KAAK,CAAC,IAAY,EAAE,OAAiB;QAC1C,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACvC,CAAC;IACD,2EAA2E;IAC3E,KAAK,CAAC,MAAM,CAAC,KAAa;QACzB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACvC,CAAC;CACD;;AAED,MAAM,IAAI,GAAkB,MAAM,CAAC,uBAAuB,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,CACpF,WAAW,CACV,CAAC,IAAY,EAAE,EAAE,CAChB,IAAI,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EACjF;IACC,mBAAmB,EAAE,EAAE;IACvB,qBAAqB,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE;CACtC,CACV,CACD,CAAC;AACF,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAC,sCAAsC;AAE5D,qFAAqF;AACrF,qFAAqF;AACrF,wFAAwF;AACxF,kEAAkE;AAClE,IAAI,IAAI,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;AAE5C,SAAS,SAAS,CAAC,QAAsB;IACxC,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE;QAC1B,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ;YACzB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClD,IAAI,OAAO,KAAK,KAAK,UAAU;gBAAE,OAAO,KAAK,CAAC;YAC9C,OAAO,KAAK,EAAE,GAAG,IAAe,EAAE,EAAE;gBACnC,MAAM,IAAI,GAAG,IAAI,CAAC;gBAClB,IAAI,OAAoB,CAAC;gBACzB,IAAI,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;gBAC3D,MAAM,IAAI,CAAC;gBACX,IAAI,CAAC;oBACJ,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBACxC,CAAC;wBAAS,CAAC;oBACV,OAAO,EAAE,CAAC;gBACX,CAAC;YACF,CAAC,CAAC;QACH,CAAC;KACD,CAAyB,CAAC;AAC5B,CAAC;AAED,mGAAmG;AAC5F,KAAK,0BACX,IAA4B,EAC5B,KAAa;IAEb,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;IACxB,MAAM,GAAG,GACR,IAAI,YAAY,OAAO;QACtB,CAAC,CAAC,EAAE,GAAG,EAAE,SAAkB,EAAE,GAAG,EAAE,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE;QAC5D,CAAC,CAAC,IAAI,IAAI,EAAE,GAAG,EAAE,SAAkB,EAAE,GAAG,EAAE,IAAI,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;IACvE,OAAO,SAAS,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,kGAAkG;AAClG,gDAAgD;AAChD,MAAM,cAAe,SAAQ,WAAW;IACV,KAAK;IAAlC,YAA6B,KAAkB;QAC9C,KAAK,EAAE,CAAC;qBADoB,KAAK;IAElC,CAAC;IACQ,MAAM,CAAC,GAAW;QAC1B,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9C,CAAC;IACQ,MAAM,CAAC,IAAY;QAC3B,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/C,CAAC;IACQ,MAAM,CAAC,IAAY;QAC3B,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/C,CAAC;CACD;AAED,MAAM,cAAe,SAAQ,OAAO;IACN,KAAK;IAAlC,YAA6B,KAAc;QAC1C,KAAK,EAAE,CAAC;qBADoB,KAAK;IAElC,CAAC;IACQ,KAAK,CAAC,GAAW,EAAE,MAAgB;QAC3C,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;IACrD,CAAC;IACQ,MAAM,CAAC,IAAY;QAC3B,OAAO,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/C,CAAC;CACD;AAED,KAAK,UAAU,OAAO,CAAI,OAAyB;IAClD,IAAI,CAAC;QACJ,OAAO,MAAM,OAAO,EAAE,CAAC;IACxB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACZ,MAAM,EAAE,OAAO,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,CAAC;AACF,CAAC"}