@sasjs/api 0.9.0 → 0.10.0

package/build/browser.js

@@ -1,4 +1,4 @@
-/* @sasjs/api 0.9.0 - the SASjs Server API, for a service worker. https://github.com/sasjs/api */
+/* @sasjs/api 0.10.0 - the SASjs Server API, for a service worker. https://github.com/sasjs/api */
 "use strict";
 var SASjsApi = (() => {
   var __defProp = Object.defineProperty;
@@ -25,6 +25,7 @@ var SASjsApi = (() => {
     ADMIN_SIGNED_IN: () => ADMIN_SIGNED_IN,
     ALWAYS_VISIBLE_ROUTES: () => ALWAYS_VISIBLE_ROUTES,
     ApiError: () => ApiError,
+    CODE_CORPUS: () => CODE_CORPUS,
     DEFAULT_GRANTABLE_ROUTES: () => DEFAULT_GRANTABLE_ROUTES,
     DEFAULT_IDENTITY: () => DEFAULT_IDENTITY,
     DEPLOY_LIMITS: () => DEPLOY_LIMITS,
@@ -2459,7 +2460,6 @@ var SASjsApi = (() => {
     Web: ["identity"]
   };
   var DIRECTORY = "Synchronising with an external auth provider needs a directory port, which this package does not have: a host decides which directory it holds accounts in, and answers this itself.";
-  var EDITOR = "Linting and formatting come from @sasjs/lint, which this package does not depend on. They land with the code routes so an editor has one wiring.";
   var RUNTIME = "Starting a program needs a runtime port, which this package does not have: a host decides which languages it holds, and answers this itself until then.";
   var SESSION_RECORD = "A triggered session's record, log, output and state belong to the runtime that ran the program, and this package has no runtime port.";
   var HOST_CONFIG = "The body is the host's own configuration - ports, run times and providers - which a mock states for itself and this package cannot know.";
@@ -2529,8 +2529,14 @@ var SASjsApi = (() => {
     // Code - the editor's three calls, and the runtime one
     "POST /SASjsApi/code/execute": { implemented: false, reason: RUNTIME },
     "POST /SASjsApi/code/trigger": { implemented: false, reason: RUNTIME },
-    "POST /SASjsApi/code/lint": { implemented: false, reason: EDITOR },
-    "POST /SASjsApi/code/format": { implemented: false, reason: EDITOR },
+    "POST /SASjsApi/code/lint": {
+      implemented: true,
+      capabilities: ["identity"]
+    },
+    "POST /SASjsApi/code/format": {
+      implemented: true,
+      capabilities: ["identity"]
+    },
     // Drive - the file and folder rules, and the three deploy routes
     // The body is the file itself, so there is nothing to annotate
     "GET /SASjsApi/drive/file": { implemented: true },
@@ -2772,8 +2778,10 @@ var SASjsApi = (() => {
         continue;
       if (param.in === "path") continue;
       const given = param.in === "query" ? request.query?.[param.name] : request.body?.[param.name];
-      if (given === void 0 || given === "")
+      if (given === void 0)
         throw new ApiError(400, `"${param.name}" is required`);
+      if (given === "")
+        throw new ApiError(400, `"${param.name}" is not allowed to be empty`);
     }
   };
   var targetPath = (request) => {
@@ -2786,7 +2794,7 @@ var SASjsApi = (() => {
   var dispatch = async (services, routeId, request = {}) => {
     const route = routeById(routeId);
     if (!route) throw new ApiError(404, `No such operation: ${routeId}`);
-    const { drive, identity, records } = services;
+    const { drive, identity, records, code } = services;
     const identityScoped = ["User", "Group", "Permission", "Client"].includes(route.tag) || routeId === "PATCH /SASjsApi/auth/updatePassword";
     if (identityScoped && records) {
       const subject = request.subject ?? (identity ? await identity.authenticate(request.token) : void 0);
@@ -2827,7 +2835,7 @@ var SASjsApi = (() => {
             status: 200,
             body: await identity.token({
               clientId: String(body.clientId ?? ""),
-              code: String(body.code ?? "")
+              code: body.code
             })
           };
         case "POST /SASjsApi/auth/refresh":
@@ -2971,6 +2979,32 @@ var SASjsApi = (() => {
             { password: body.password }
           )
         };
+      case "POST /SASjsApi/code/lint":
+        if (!code)
+          throw new ApiError(
+            501,
+            `This host has no code service, so it cannot answer ${routeId}.`
+          );
+        return {
+          status: 200,
+          body: await code.lint(await caller(), {
+            code: body.code,
+            filePath: body.filePath
+          })
+        };
+      case "POST /SASjsApi/code/format":
+        if (!code)
+          throw new ApiError(
+            501,
+            `This host has no code service, so it cannot answer ${routeId}.`
+          );
+        return {
+          status: 200,
+          body: await code.format(await caller(), {
+            code: body.code,
+            filePath: body.filePath
+          })
+        };
       case "GET /SASjsApi/info/authorizedRoutes":
         return {
           status: 200,
@@ -3091,6 +3125,8 @@ var SASjsApi = (() => {
     }
   };
   var HANDLED_ROUTES = [
+    "POST /SASjsApi/code/lint",
+    "POST /SASjsApi/code/format",
     "GET /SASjsApi/info/authorizedRoutes",
     "GET /SASjsApi/info/myAuthorizedRoutes",
     "GET /SASjsApi/drive/file",
@@ -3602,6 +3638,53 @@ var SASjsApi = (() => {
     };
   };
 
+  // src/corpus/code.ts
+  var CODE_CORPUS = [
+    {
+      id: "code-lint-missing-header",
+      route: "POST /SASjsApi/code/lint",
+      description: "answers the diagnostics for a buffer, without touching a file",
+      request: {
+        // the routes are permissioned; the runner resolves the fixture's admin
+        subject: { userId: "user-admin", clientId: "web_app" },
+        body: { code: "data _null_;\n  x = 1;\nrun;\n" }
+      },
+      expect: {
+        status: 200,
+        body: [
+          {
+            message: "File missing Doxygen header",
+            lineNumber: 1,
+            startColumnNumber: 1,
+            endColumnNumber: 1,
+            severity: 1
+          }
+        ]
+      }
+    },
+    // Two refusals are deliberately not pinned here yet: a `code` that is not a
+    // string, and one that is empty. The package answers 400 `"code" must be a
+    // string` / `"code" is not allowed to be empty` - the messages the server's
+    // schema produces - but sasjs/server's code controller carries no
+    // `@Response(400)` for these routes, so the document states 200 alone and the
+    // parity gate refuses a case answering anything else. The cases land when the
+    // decorators do.
+    {
+      id: "code-format-adds-the-header",
+      route: "POST /SASjsApi/code/format",
+      description: "answers the formatted buffer, header block included",
+      request: {
+        // the routes are permissioned; the runner resolves the fixture's admin
+        subject: { userId: "user-admin", clientId: "web_app" },
+        body: { code: "data _null_;\n  x = 1;\nrun;\n" }
+      },
+      expect: {
+        status: 200,
+        body: "/**\n  @file\n  @brief <Your brief here>\n\n  <h4> SAS Macros </h4>\n\n**/\ndata _null_;\n  x = 1;\nrun;\n"
+      }
+    }
+  ];
+
   // src/identity/fixture.ts
   var IDENTITY_FORMAT = 1;
   var SECONDS_IN_A_DAY2 = 86400;

package/build/cjs/code/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCodeService = void 0;
+/**
+ * The code service, on its own entry point.
+ *
+ * `@sasjs/lint` reads the filesystem (its config resolution walks up for a
+ * `.sasjslint`), so it cannot be bundled for a service worker: the package root
+ * stays free of it and a host that wants these routes imports `@sasjs/api/code`.
+ */
+var service_js_1 = require("./service.js");
+Object.defineProperty(exports, "createCodeService", { enumerable: true, get: function () { return service_js_1.createCodeService; } });

package/build/cjs/code/service.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCodeService = void 0;
+const lint_1 = require("@sasjs/lint");
+const types_js_1 = require("../types.js");
+/**
+ * `code`, refused the way the server's schema refuses it.
+ *
+ * Coercing with `String(...)` defeated the refusal: `{"code": 123}` was linted as
+ * the text "123" and `{"code": ""}` answered "required" where the server says it
+ * is empty. The three messages are Joi's, because they are the ones a client
+ * written against the document already handles.
+ */
+const codeOf = (body) => {
+    const value = body.code;
+    if (value === undefined)
+        throw new types_js_1.ApiError(400, '"code" is required');
+    if (typeof value !== 'string')
+        throw new types_js_1.ApiError(400, '"code" must be a string');
+    if (value === '')
+        throw new types_js_1.ApiError(400, '"code" is not allowed to be empty');
+    return value;
+};
+/**
+ * The two editor routes, over `@sasjs/lint`.
+ *
+ * The linter is a dependency because it is the same everywhere, and it is
+ * deliberately NOT reachable from the package root: `@sasjs/lint` resolves its
+ * configuration by walking the filesystem, so it cannot be bundled into the
+ * service worker the browser entry produces. A host that wants these routes
+ * imports `@sasjs/api/code`, which is Node-only, exactly like the linter.
+ *
+ * The *rules* are the host's: which `.sasjslint` applies to a path is a fact
+ * about a drive, so `lintConfig` is asked for it.
+ * Neither route touches the drive or runs anything; they answer about the text
+ * in the request, which is what lets an editor check unsaved changes.
+ */
+const createCodeService = (options = {}) => {
+    const requireCaller = (caller) => {
+        // both routes are permissioned at the gate, so a caller that reached the
+        // service without one is a host that skipped it rather than a public route
+        if (!caller)
+            throw new types_js_1.ApiError(401, 'Unauthorized');
+    };
+    const configFor = (filePath) => options.lintConfig ? options.lintConfig(filePath) : undefined;
+    return {
+        async lint(caller, body) {
+            requireCaller(caller);
+            return (0, lint_1.lintText)(codeOf(body), configFor(body.filePath));
+        },
+        async format(caller, body) {
+            requireCaller(caller);
+            return (0, lint_1.formatText)(codeOf(body), configFor(body.filePath));
+        }
+    };
+};
+exports.createCodeService = createCodeService;

package/build/cjs/corpus/code.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CODE_CORPUS = void 0;
+/**
+ * The editor's corpus: the two routes that answer about a buffer rather than a
+ * file.
+ *
+ * Both expectations are the linter's own output for the same input, measured
+ * against `@sasjs/lint` with no configuration - the defaults an untitled buffer
+ * lints against. A host that supplies a `.sasjslint` changes the rules for its
+ * own drive, which is why the case names no `filePath`.
+ *
+ *     lintText('data _null_;\n  x = 1;\nrun;\n')
+ *       -> [{ message: 'File missing Doxygen header', lineNumber: 1, ... }]
+ *     formatText(...)
+ *       -> the header block, then the program with its spacing normalised
+ */
+exports.CODE_CORPUS = [
+    {
+        id: 'code-lint-missing-header',
+        route: 'POST /SASjsApi/code/lint',
+        description: 'answers the diagnostics for a buffer, without touching a file',
+        request: {
+            // the routes are permissioned; the runner resolves the fixture's admin
+            subject: { userId: 'user-admin', clientId: 'web_app' },
+            body: { code: 'data _null_;\n  x = 1;\nrun;\n' }
+        },
+        expect: {
+            status: 200,
+            body: [
+                {
+                    message: 'File missing Doxygen header',
+                    lineNumber: 1,
+                    startColumnNumber: 1,
+                    endColumnNumber: 1,
+                    severity: 1
+                }
+            ]
+        }
+    },
+    // Two refusals are deliberately not pinned here yet: a `code` that is not a
+    // string, and one that is empty. The package answers 400 `"code" must be a
+    // string` / `"code" is not allowed to be empty` - the messages the server's
+    // schema produces - but sasjs/server's code controller carries no
+    // `@Response(400)` for these routes, so the document states 200 alone and the
+    // parity gate refuses a case answering anything else. The cases land when the
+    // decorators do.
+    {
+        id: 'code-format-adds-the-header',
+        route: 'POST /SASjsApi/code/format',
+        description: 'answers the formatted buffer, header block included',
+        request: {
+            // the routes are permissioned; the runner resolves the fixture's admin
+            subject: { userId: 'user-admin', clientId: 'web_app' },
+            body: { code: 'data _null_;\n  x = 1;\nrun;\n' }
+        },
+        expect: {
+            status: 200,
+            body: '/**\n  @file\n  @brief <Your brief here>\n\n  <h4> SAS Macros </h4>\n\n**/\ndata _null_;\n  x = 1;\nrun;\n'
+        }
+    }
+];

package/build/cjs/host/dispatch.js

@@ -24,8 +24,13 @@ const validate = (route, request) => {
         const given = param.in === 'query'
             ? request.query?.[param.name]
             : request.body?.[param.name];
-        if (given === undefined || given === '')
+        // missing and empty are two refusals, the way the schema has them: a
+        // client that sent the field an empty value has a different bug from one
+        // that omitted it
+        if (given === undefined)
             throw new types_js_1.ApiError(400, `"${param.name}" is required`);
+        if (given === '')
+            throw new types_js_1.ApiError(400, `"${param.name}" is not allowed to be empty`);
     }
 };
 /** The drive path a write names: the query parameter wins over the form field. */
@@ -44,7 +49,7 @@ const dispatch = async (services, routeId, request = {}) => {
     const route = (0, index_js_1.routeById)(routeId);
     if (!route)
         throw new types_js_1.ApiError(404, `No such operation: ${routeId}`);
-    const { drive, identity, records } = services;
+    const { drive, identity, records, code } = services;
     // The server authenticates before its payload schema runs, so an anonymous
     // request with an incomplete body is a 401 there rather than a 400. The order
     // is only observable on the route groups that gate on a caller: the sign-in
@@ -92,7 +97,7 @@ const dispatch = async (services, routeId, request = {}) => {
                     status: 200,
                     body: await identity.token({
                         clientId: String(body.clientId ?? ''),
-                        code: String(body.code ?? '')
+                        code: body.code
                     })
                 };
             case 'POST /SASjsApi/auth/refresh':
@@ -219,6 +224,26 @@ const dispatch = async (services, routeId, request = {}) => {
                 status: 200,
                 body: await required().deleteUser(await caller(), { username: String(params.username ?? '') }, { password: body.password })
             };
+        case 'POST /SASjsApi/code/lint':
+            if (!code)
+                throw new types_js_1.ApiError(501, `This host has no code service, so it cannot answer ${routeId}.`);
+            return {
+                status: 200,
+                body: await code.lint(await caller(), {
+                    code: body.code,
+                    filePath: body.filePath
+                })
+            };
+        case 'POST /SASjsApi/code/format':
+            if (!code)
+                throw new types_js_1.ApiError(501, `This host has no code service, so it cannot answer ${routeId}.`);
+            return {
+                status: 200,
+                body: await code.format(await caller(), {
+                    code: body.code,
+                    filePath: body.filePath
+                })
+            };
         case 'GET /SASjsApi/info/authorizedRoutes':
             return {
                 status: 200,
@@ -332,6 +357,8 @@ const dispatch = async (services, routeId, request = {}) => {
 exports.dispatch = dispatch;
 /** Whether a route is one `dispatch` can answer today. */
 exports.HANDLED_ROUTES = [
+    'POST /SASjsApi/code/lint',
+    'POST /SASjsApi/code/format',
     'GET /SASjsApi/info/authorizedRoutes',
     'GET /SASjsApi/info/myAuthorizedRoutes',
     'GET /SASjsApi/drive/file',

package/build/cjs/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.servicesFor = exports.runCase = exports.PROVIDER_MANAGED = exports.ADMIN_SIGNED_IN = exports.RECORD_CORPUS = exports.IDENTITY_CORPUS = exports.DRIVE_CORPUS = exports.parseIdentity = exports.IDENTITY_FORMAT = exports.DEFAULT_IDENTITY = exports.MemoryIdentityStore = exports.sanitiseDisplayName = exports.createRecordService = exports.createIdentityService = exports.HANDLED_ROUTES = exports.dispatch = exports.TAG_CAPABILITIES = exports.OVERLAY = exports.findRoute = exports.routeById = exports.ROUTES = exports.MemoryDriveStore = exports.measureDeployTree = exports.isDeployTree = exports.deployTree = exports.decodeBase64 = exports.checkDeployTree = exports.DEPLOY_SUCCESS = exports.DEPLOY_PAYLOAD_BYTES = exports.DEPLOY_LIMITS = exports.createDriveService = exports.isRoot = exports.basename = exports.dirname = exports.hasBlockedExtension = exports.normaliseDrivePath = void 0;
+exports.servicesFor = exports.runCase = exports.PROVIDER_MANAGED = exports.ADMIN_SIGNED_IN = exports.RECORD_CORPUS = exports.IDENTITY_CORPUS = exports.DRIVE_CORPUS = exports.parseIdentity = exports.IDENTITY_FORMAT = exports.DEFAULT_IDENTITY = exports.MemoryIdentityStore = exports.CODE_CORPUS = exports.sanitiseDisplayName = exports.createRecordService = exports.createIdentityService = exports.HANDLED_ROUTES = exports.dispatch = exports.TAG_CAPABILITIES = exports.OVERLAY = exports.findRoute = exports.routeById = exports.ROUTES = exports.MemoryDriveStore = exports.measureDeployTree = exports.isDeployTree = exports.deployTree = exports.decodeBase64 = exports.checkDeployTree = exports.DEPLOY_SUCCESS = exports.DEPLOY_PAYLOAD_BYTES = exports.DEPLOY_LIMITS = exports.createDriveService = exports.isRoot = exports.basename = exports.dirname = exports.hasBlockedExtension = exports.normaliseDrivePath = void 0;
 /**
  * `@sasjs/api` - the SASjs Server API described once.
  *
@@ -67,6 +67,8 @@ Object.defineProperty(exports, "createIdentityService", { enumerable: true, get:
 var records_js_1 = require("./identity/records.js");
 Object.defineProperty(exports, "createRecordService", { enumerable: true, get: function () { return records_js_1.createRecordService; } });
 Object.defineProperty(exports, "sanitiseDisplayName", { enumerable: true, get: function () { return records_js_1.sanitiseDisplayName; } });
+var code_js_1 = require("./corpus/code.js");
+Object.defineProperty(exports, "CODE_CORPUS", { enumerable: true, get: function () { return code_js_1.CODE_CORPUS; } });
 var memory_store_js_2 = require("./identity/memory-store.js");
 Object.defineProperty(exports, "MemoryIdentityStore", { enumerable: true, get: function () { return memory_store_js_2.MemoryIdentityStore; } });
 var fixture_js_1 = require("./identity/fixture.js");

package/build/cjs/routes/overlay.js

@@ -26,7 +26,6 @@ exports.TAG_CAPABILITIES = {
  * thing thirty times.
  */
 const DIRECTORY = 'Synchronising with an external auth provider needs a directory port, which this package does not have: a host decides which directory it holds accounts in, and answers this itself.';
-const EDITOR = 'Linting and formatting come from @sasjs/lint, which this package does not depend on. They land with the code routes so an editor has one wiring.';
 const RUNTIME = 'Starting a program needs a runtime port, which this package does not have: a host decides which languages it holds, and answers this itself until then.';
 const SESSION_RECORD = "A triggered session's record, log, output and state belong to the runtime that ran the program, and this package has no runtime port.";
 const HOST_CONFIG = "The body is the host's own configuration - ports, run times and providers - which a mock states for itself and this package cannot know.";
@@ -96,8 +95,14 @@ exports.OVERLAY = {
     // Code - the editor's three calls, and the runtime one
     'POST /SASjsApi/code/execute': { implemented: false, reason: RUNTIME },
     'POST /SASjsApi/code/trigger': { implemented: false, reason: RUNTIME },
-    'POST /SASjsApi/code/lint': { implemented: false, reason: EDITOR },
-    'POST /SASjsApi/code/format': { implemented: false, reason: EDITOR },
+    'POST /SASjsApi/code/lint': {
+        implemented: true,
+        capabilities: ['identity']
+    },
+    'POST /SASjsApi/code/format': {
+        implemented: true,
+        capabilities: ['identity']
+    },
     // Drive - the file and folder rules, and the three deploy routes
     // The body is the file itself, so there is nothing to annotate
     'GET /SASjsApi/drive/file': { implemented: true },

package/build/esm/code/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The code service, on its own entry point.
+ *
+ * `@sasjs/lint` reads the filesystem (its config resolution walks up for a
+ * `.sasjslint`), so it cannot be bundled for a service worker: the package root
+ * stays free of it and a host that wants these routes imports `@sasjs/api/code`.
+ */
+export { createCodeService } from './service.js';
+export type { CodeRequest, CodeService, CodeServiceOptions } from './service.js';
+//# sourceMappingURL=index.d.ts.map

package/build/esm/code/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/code/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAA"}

package/build/esm/code/index.js

@@ -0,0 +1,8 @@
+/**
+ * The code service, on its own entry point.
+ *
+ * `@sasjs/lint` reads the filesystem (its config resolution walks up for a
+ * `.sasjslint`), so it cannot be bundled for a service worker: the package root
+ * stays free of it and a host that wants these routes imports `@sasjs/api/code`.
+ */
+export { createCodeService } from './service.js';

package/build/esm/code/service.d.ts

@@ -0,0 +1,40 @@
+import type { Diagnostic, LintConfig } from '@sasjs/lint';
+import type { Subject } from '../identity/types.js';
+/** What both code routes take: a buffer, and where it came from when it has a file. */
+export interface CodeRequest {
+    code: string;
+    /** The drive path the code belongs to, so a host can pick that folder's rules. */
+    filePath?: string;
+}
+export interface CodeServiceOptions {
+    /**
+     * The lint configuration that applies to a file.
+     *
+     * A host resolves the nearest `.sasjslint` at or above `filePath`, so each
+     * folder can carry its own rules; without one the linter's defaults apply,
+     * which is what an untitled buffer lints against.
+     */
+    lintConfig?: (filePath?: string) => LintConfig | undefined;
+}
+export interface CodeService {
+    /** The diagnostics for a buffer. Nothing is written and nothing is executed. */
+    lint(caller: Subject | undefined, body: CodeRequest): Promise<Diagnostic[]>;
+    /** The formatted buffer. */
+    format(caller: Subject | undefined, body: CodeRequest): Promise<string>;
+}
+/**
+ * The two editor routes, over `@sasjs/lint`.
+ *
+ * The linter is a dependency because it is the same everywhere, and it is
+ * deliberately NOT reachable from the package root: `@sasjs/lint` resolves its
+ * configuration by walking the filesystem, so it cannot be bundled into the
+ * service worker the browser entry produces. A host that wants these routes
+ * imports `@sasjs/api/code`, which is Node-only, exactly like the linter.
+ *
+ * The *rules* are the host's: which `.sasjslint` applies to a path is a fact
+ * about a drive, so `lintConfig` is asked for it.
+ * Neither route touches the drive or runs anything; they answer about the text
+ * in the request, which is what lets an editor check unsaved changes.
+ */
+export declare const createCodeService: (options?: CodeServiceOptions) => CodeService;
+//# sourceMappingURL=service.d.ts.map

package/build/esm/code/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../../src/code/service.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGzD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAEnD,uFAAuF;AACvF,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,kFAAkF;IAClF,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,KAAK,UAAU,GAAG,SAAS,CAAA;CAC3D;AAED,MAAM,WAAW,WAAW;IAC1B,gFAAgF;IAChF,IAAI,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAAA;IAC3E,4BAA4B;IAC5B,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,EAAE,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;CACxE;AAmBD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB,GAC5B,UAAS,kBAAuB,KAC/B,WAqBF,CAAA"}

package/build/esm/code/service.js

@@ -0,0 +1,53 @@
+import { formatText, lintText } from '@sasjs/lint';
+import { ApiError } from '../types.js';
+/**
+ * `code`, refused the way the server's schema refuses it.
+ *
+ * Coercing with `String(...)` defeated the refusal: `{"code": 123}` was linted as
+ * the text "123" and `{"code": ""}` answered "required" where the server says it
+ * is empty. The three messages are Joi's, because they are the ones a client
+ * written against the document already handles.
+ */
+const codeOf = (body) => {
+    const value = body.code;
+    if (value === undefined)
+        throw new ApiError(400, '"code" is required');
+    if (typeof value !== 'string')
+        throw new ApiError(400, '"code" must be a string');
+    if (value === '')
+        throw new ApiError(400, '"code" is not allowed to be empty');
+    return value;
+};
+/**
+ * The two editor routes, over `@sasjs/lint`.
+ *
+ * The linter is a dependency because it is the same everywhere, and it is
+ * deliberately NOT reachable from the package root: `@sasjs/lint` resolves its
+ * configuration by walking the filesystem, so it cannot be bundled into the
+ * service worker the browser entry produces. A host that wants these routes
+ * imports `@sasjs/api/code`, which is Node-only, exactly like the linter.
+ *
+ * The *rules* are the host's: which `.sasjslint` applies to a path is a fact
+ * about a drive, so `lintConfig` is asked for it.
+ * Neither route touches the drive or runs anything; they answer about the text
+ * in the request, which is what lets an editor check unsaved changes.
+ */
+export const createCodeService = (options = {}) => {
+    const requireCaller = (caller) => {
+        // both routes are permissioned at the gate, so a caller that reached the
+        // service without one is a host that skipped it rather than a public route
+        if (!caller)
+            throw new ApiError(401, 'Unauthorized');
+    };
+    const configFor = (filePath) => options.lintConfig ? options.lintConfig(filePath) : undefined;
+    return {
+        async lint(caller, body) {
+            requireCaller(caller);
+            return lintText(codeOf(body), configFor(body.filePath));
+        },
+        async format(caller, body) {
+            requireCaller(caller);
+            return formatText(codeOf(body), configFor(body.filePath));
+        }
+    };
+};

package/build/esm/corpus/code.d.ts

@@ -0,0 +1,17 @@
+import type { CorpusCase } from './drive.js';
+/**
+ * The editor's corpus: the two routes that answer about a buffer rather than a
+ * file.
+ *
+ * Both expectations are the linter's own output for the same input, measured
+ * against `@sasjs/lint` with no configuration - the defaults an untitled buffer
+ * lints against. A host that supplies a `.sasjslint` changes the rules for its
+ * own drive, which is why the case names no `filePath`.
+ *
+ *     lintText('data _null_;\n  x = 1;\nrun;\n')
+ *       -> [{ message: 'File missing Doxygen header', lineNumber: 1, ... }]
+ *     formatText(...)
+ *       -> the header block, then the program with its spacing normalised
+ */
+export declare const CODE_CORPUS: CorpusCase[];
+//# sourceMappingURL=code.d.ts.map

package/build/esm/corpus/code.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"code.d.ts","sourceRoot":"","sources":["../../../src/corpus/code.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAE5C;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,EAAE,UAAU,EA6CnC,CAAA"}

package/build/esm/corpus/code.js

@@ -0,0 +1,59 @@
+/**
+ * The editor's corpus: the two routes that answer about a buffer rather than a
+ * file.
+ *
+ * Both expectations are the linter's own output for the same input, measured
+ * against `@sasjs/lint` with no configuration - the defaults an untitled buffer
+ * lints against. A host that supplies a `.sasjslint` changes the rules for its
+ * own drive, which is why the case names no `filePath`.
+ *
+ *     lintText('data _null_;\n  x = 1;\nrun;\n')
+ *       -> [{ message: 'File missing Doxygen header', lineNumber: 1, ... }]
+ *     formatText(...)
+ *       -> the header block, then the program with its spacing normalised
+ */
+export const CODE_CORPUS = [
+    {
+        id: 'code-lint-missing-header',
+        route: 'POST /SASjsApi/code/lint',
+        description: 'answers the diagnostics for a buffer, without touching a file',
+        request: {
+            // the routes are permissioned; the runner resolves the fixture's admin
+            subject: { userId: 'user-admin', clientId: 'web_app' },
+            body: { code: 'data _null_;\n  x = 1;\nrun;\n' }
+        },
+        expect: {
+            status: 200,
+            body: [
+                {
+                    message: 'File missing Doxygen header',
+                    lineNumber: 1,
+                    startColumnNumber: 1,
+                    endColumnNumber: 1,
+                    severity: 1
+                }
+            ]
+        }
+    },
+    // Two refusals are deliberately not pinned here yet: a `code` that is not a
+    // string, and one that is empty. The package answers 400 `"code" must be a
+    // string` / `"code" is not allowed to be empty` - the messages the server's
+    // schema produces - but sasjs/server's code controller carries no
+    // `@Response(400)` for these routes, so the document states 200 alone and the
+    // parity gate refuses a case answering anything else. The cases land when the
+    // decorators do.
+    {
+        id: 'code-format-adds-the-header',
+        route: 'POST /SASjsApi/code/format',
+        description: 'answers the formatted buffer, header block included',
+        request: {
+            // the routes are permissioned; the runner resolves the fixture's admin
+            subject: { userId: 'user-admin', clientId: 'web_app' },
+            body: { code: 'data _null_;\n  x = 1;\nrun;\n' }
+        },
+        expect: {
+            status: 200,
+            body: '/**\n  @file\n  @brief <Your brief here>\n\n  <h4> SAS Macros </h4>\n\n**/\ndata _null_;\n  x = 1;\nrun;\n'
+        }
+    }
+];

package/build/esm/corpus/drive.d.ts

@@ -47,6 +47,15 @@ export interface CorpusCase {
          * minted token is not a value a case can state.
          */
         keys?: string[];
+        /**
+         * How the body travels, where a string could be either. `json` is a JSON
+         * string on the wire - what tsoa emits for `Promise<string>` and what the
+         * server's `res.json` sends; `text` is a body the route sends itself, which
+         * the document carries in the `description` with no content. A case that
+         * names neither is read as `text` when the document declares no content and
+         * as `json` when it does.
+         */
+        encoding?: 'json' | 'text';
     };
 }
 export declare const DRIVE_CORPUS: CorpusCase[];

package/build/esm/corpus/drive.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"drive.d.ts","sourceRoot":"","sources":["../../../src/corpus/drive.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAE7D,MAAM,WAAW,UAAU;IACzB,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,kEAAkE;IAClE,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,CAAA;IAC1C,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,eAAe,CAAA;IAC1B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,OAAO,EAAE,UAAU,CAAA;IACnB,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;QAC9B,yDAAyD;QACzD,KAAK,CAAC,EAAE,MAAM,CAAA;QACd;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACjC;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAChB,CAAA;CACF;AAmBD,eAAO,MAAM,YAAY,EAAE,UAAU,EAqapC,CAAA"}
+{"version":3,"file":"drive.d.ts","sourceRoot":"","sources":["../../../src/corpus/drive.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAE7D,MAAM,WAAW,UAAU;IACzB,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAA;IACV,kEAAkE;IAClE,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,kCAAkC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,CAAA;IAC1C,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,eAAe,CAAA;IAC1B;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,OAAO,EAAE,UAAU,CAAA;IACnB,MAAM,EAAE;QACN,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,CAAC,EAAE,OAAO,CAAA;QACd,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;QAC9B,yDAAyD;QACzD,KAAK,CAAC,EAAE,MAAM,CAAA;QACd;;;;WAIG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACjC;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;QACf;;;;;;;WAOG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAC3B,CAAA;CACF;AAmBD,eAAO,MAAM,YAAY,EAAE,UAAU,EAqapC,CAAA"}

package/build/esm/host/dispatch.d.ts

@@ -1,6 +1,7 @@
 import type { DriveService } from '../drive/service.js';
 import type { IdentityService } from '../identity/service.js';
 import type { RecordService } from '../identity/records.js';
+import type { CodeService } from '../code/service.js';
 import type { Subject } from '../identity/types.js';
 export interface ApiRequest {
     query?: Record<string, string | undefined>;
@@ -33,6 +34,8 @@ export interface ApiResponse {
     contents?: string | Uint8Array;
 }
 export interface Services {
+    /** The editor routes, where the host supplies a linter. */
+    code?: CodeService;
     drive: DriveService;
     /**
      * Users, clients and tokens. A host without one answers 501 for the identity

package/build/esm/host/dispatch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dispatch.d.ts","sourceRoot":"","sources":["../../../src/host/dispatch.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAOnD,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,oFAAoF;IACpF,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,CAAA;IACtD;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iEAAiE;IACjE,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,mBAAmB;IACnB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;CAC/B;AAED,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,YAAY,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAA;IAC1B,yFAAyF;IACzF,OAAO,CAAC,EAAE,aAAa,CAAA;CACxB;AAsCD,eAAO,MAAM,QAAQ,GACnB,UAAU,QAAQ,EAClB,SAAS,MAAM,EACf,UAAS,UAAe,KACvB,OAAO,CAAC,WAAW,CAgXrB,CAAA;AAED,0DAA0D;AAC1D,eAAO,MAAM,cAAc,EAAE,MAAM,EA0ClC,CAAA"}
+{"version":3,"file":"dispatch.d.ts","sourceRoot":"","sources":["../../../src/host/dispatch.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC3D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAOnD,MAAM,WAAW,UAAU;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,oFAAoF;IACpF,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,CAAA;IACtD;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,iEAAiE;IACjE,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,mBAAmB;IACnB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;CAC/B;AAED,MAAM,WAAW,QAAQ;IACvB,2DAA2D;IAC3D,IAAI,CAAC,EAAE,WAAW,CAAA;IAClB,KAAK,EAAE,YAAY,CAAA;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,eAAe,CAAA;IAC1B,yFAAyF;IACzF,OAAO,CAAC,EAAE,aAAa,CAAA;CACxB;AA2CD,eAAO,MAAM,QAAQ,GACnB,UAAU,QAAQ,EAClB,SAAS,MAAM,EACf,UAAS,UAAe,KACvB,OAAO,CAAC,WAAW,CA2YrB,CAAA;AAED,0DAA0D;AAC1D,eAAO,MAAM,cAAc,EAAE,MAAM,EA4ClC,CAAA"}

package/build/esm/host/dispatch.js

@@ -21,8 +21,13 @@ const validate = (route, request) => {
         const given = param.in === 'query'
             ? request.query?.[param.name]
             : request.body?.[param.name];
-        if (given === undefined || given === '')
+        // missing and empty are two refusals, the way the schema has them: a
+        // client that sent the field an empty value has a different bug from one
+        // that omitted it
+        if (given === undefined)
             throw new ApiError(400, `"${param.name}" is required`);
+        if (given === '')
+            throw new ApiError(400, `"${param.name}" is not allowed to be empty`);
     }
 };
 /** The drive path a write names: the query parameter wins over the form field. */
@@ -41,7 +46,7 @@ export const dispatch = async (services, routeId, request = {}) => {
     const route = routeById(routeId);
     if (!route)
         throw new ApiError(404, `No such operation: ${routeId}`);
-    const { drive, identity, records } = services;
+    const { drive, identity, records, code } = services;
     // The server authenticates before its payload schema runs, so an anonymous
     // request with an incomplete body is a 401 there rather than a 400. The order
     // is only observable on the route groups that gate on a caller: the sign-in
@@ -89,7 +94,7 @@ export const dispatch = async (services, routeId, request = {}) => {
                     status: 200,
                     body: await identity.token({
                         clientId: String(body.clientId ?? ''),
-                        code: String(body.code ?? '')
+                        code: body.code
                     })
                 };
             case 'POST /SASjsApi/auth/refresh':
@@ -216,6 +221,26 @@ export const dispatch = async (services, routeId, request = {}) => {
                 status: 200,
                 body: await required().deleteUser(await caller(), { username: String(params.username ?? '') }, { password: body.password })
             };
+        case 'POST /SASjsApi/code/lint':
+            if (!code)
+                throw new ApiError(501, `This host has no code service, so it cannot answer ${routeId}.`);
+            return {
+                status: 200,
+                body: await code.lint(await caller(), {
+                    code: body.code,
+                    filePath: body.filePath
+                })
+            };
+        case 'POST /SASjsApi/code/format':
+            if (!code)
+                throw new ApiError(501, `This host has no code service, so it cannot answer ${routeId}.`);
+            return {
+                status: 200,
+                body: await code.format(await caller(), {
+                    code: body.code,
+                    filePath: body.filePath
+                })
+            };
         case 'GET /SASjsApi/info/authorizedRoutes':
             return {
                 status: 200,
@@ -328,6 +353,8 @@ export const dispatch = async (services, routeId, request = {}) => {
 };
 /** Whether a route is one `dispatch` can answer today. */
 export const HANDLED_ROUTES = [
+    'POST /SASjsApi/code/lint',
+    'POST /SASjsApi/code/format',
     'GET /SASjsApi/info/authorizedRoutes',
     'GET /SASjsApi/info/myAuthorizedRoutes',
     'GET /SASjsApi/drive/file',

package/build/esm/index.d.ts

@@ -29,6 +29,7 @@ export * from './identity/routeAccess.js';
 export type { ApiRequest, ApiResponse, Services } from './host/dispatch.js';
 export { createIdentityService } from './identity/service.js';
 export { createRecordService, sanitiseDisplayName } from './identity/records.js';
+export { CODE_CORPUS } from './corpus/code.js';
 export type { AuthorizedRoutesResponse, GroupDetailsResponse, GroupResponse, PermissionResponse, RecordServiceOptions, RecordService, UserDetailsResponse, UserResponse } from './identity/records.js';
 export type { IdentityService, LoginResult, SessionResult } from './identity/service.js';
 export { MemoryIdentityStore } from './identity/memory-store.js';

package/build/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,cAAc,YAAY,CAAA;AAC1B,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,OAAO,EACP,QAAQ,EACR,MAAM,EACP,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAC1B,YAAY,EACV,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACb,UAAU,EACX,MAAM,mBAAmB,CAAA;AAC1B,YAAY,EACV,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,SAAS,EACT,SAAS,EACV,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAChE,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAC/D,YAAY,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAG7D,cAAc,2BAA2B,CAAA;AACzC,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAA;AAC7D,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAChF,YAAY,EACV,wBAAwB,EACxB,oBAAoB,EACpB,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACb,mBAAmB,EACnB,YAAY,EACb,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EACV,eAAe,EACf,WAAW,EACX,aAAa,EACd,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,aAAa,EACd,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EACV,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,EACxB,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,QAAQ,EACR,aAAa,EACb,OAAO,EACP,OAAO,EACP,SAAS,EACT,UAAU,EACX,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EACL,aAAa,EACb,eAAe,EACf,gBAAgB,EACjB,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACzD,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,cAAc,YAAY,CAAA;AAC1B,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,OAAO,EACP,QAAQ,EACR,MAAM,EACP,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,iBAAiB,EAClB,MAAM,mBAAmB,CAAA;AAC1B,YAAY,EACV,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACb,UAAU,EACX,MAAM,mBAAmB,CAAA;AAC1B,YAAY,EACV,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,SAAS,EACT,SAAS,EACV,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAChE,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AAC/D,YAAY,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAG7D,cAAc,2BAA2B,CAAA;AACzC,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC3E,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAA;AAC7D,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,YAAY,EACV,wBAAwB,EACxB,oBAAoB,EACpB,aAAa,EACb,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACb,mBAAmB,EACnB,YAAY,EACb,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EACV,eAAe,EACf,WAAW,EACX,aAAa,EACd,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,aAAa,EACd,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EACV,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,mBAAmB,EACnB,wBAAwB,EACxB,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,QAAQ,EACR,aAAa,EACb,OAAO,EACP,OAAO,EACP,SAAS,EACT,UAAU,EACX,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EACL,aAAa,EACb,eAAe,EACf,gBAAgB,EACjB,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACzD,YAAY,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA"}

package/build/esm/index.js

@@ -25,6 +25,7 @@ export { dispatch, HANDLED_ROUTES } from './host/dispatch.js';
 export * from './identity/routeAccess.js';
 export { createIdentityService } from './identity/service.js';
 export { createRecordService, sanitiseDisplayName } from './identity/records.js';
+export { CODE_CORPUS } from './corpus/code.js';
 export { MemoryIdentityStore } from './identity/memory-store.js';
 export { DEFAULT_IDENTITY, IDENTITY_FORMAT, parseIdentity } from './identity/fixture.js';
 export { DRIVE_CORPUS } from './corpus/drive.js';

package/build/esm/routes/overlay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"overlay.d.ts","sourceRoot":"","sources":["../../../src/routes/overlay.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGzD,yDAAyD;AACzD,UAAU,aAAa;IACrB,YAAY,CAAC,EAAE,UAAU,EAAE,CAAA;IAC3B;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACpC;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,aAAa,GACtC,CAAC;IAAE,WAAW,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAElE,kFAAkF;AAClF,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAczD,CAAA;AA8CD,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAmNhD,CAAA;AAED,wEAAwE;AACxE,eAAO,MAAM,OAAO,EAAE,UAAU,EAA8C,CAAA"}
+{"version":3,"file":"overlay.d.ts","sourceRoot":"","sources":["../../../src/routes/overlay.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGzD,yDAAyD;AACzD,UAAU,aAAa;IACrB,YAAY,CAAC,EAAE,UAAU,EAAE,CAAA;IAC3B;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACpC;AAED;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,aAAa,GACtC,CAAC;IAAE,WAAW,EAAE,IAAI,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAElE,kFAAkF;AAClF,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAczD,CAAA;AA2CD,eAAO,MAAM,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAyNhD,CAAA;AAED,wEAAwE;AACxE,eAAO,MAAM,OAAO,EAAE,UAAU,EAA8C,CAAA"}

package/build/esm/routes/overlay.js

@@ -23,7 +23,6 @@ export const TAG_CAPABILITIES = {
  * thing thirty times.
  */
 const DIRECTORY = 'Synchronising with an external auth provider needs a directory port, which this package does not have: a host decides which directory it holds accounts in, and answers this itself.';
-const EDITOR = 'Linting and formatting come from @sasjs/lint, which this package does not depend on. They land with the code routes so an editor has one wiring.';
 const RUNTIME = 'Starting a program needs a runtime port, which this package does not have: a host decides which languages it holds, and answers this itself until then.';
 const SESSION_RECORD = "A triggered session's record, log, output and state belong to the runtime that ran the program, and this package has no runtime port.";
 const HOST_CONFIG = "The body is the host's own configuration - ports, run times and providers - which a mock states for itself and this package cannot know.";
@@ -93,8 +92,14 @@ export const OVERLAY = {
     // Code - the editor's three calls, and the runtime one
     'POST /SASjsApi/code/execute': { implemented: false, reason: RUNTIME },
     'POST /SASjsApi/code/trigger': { implemented: false, reason: RUNTIME },
-    'POST /SASjsApi/code/lint': { implemented: false, reason: EDITOR },
-    'POST /SASjsApi/code/format': { implemented: false, reason: EDITOR },
+    'POST /SASjsApi/code/lint': {
+        implemented: true,
+        capabilities: ['identity']
+    },
+    'POST /SASjsApi/code/format': {
+        implemented: true,
+        capabilities: ['identity']
+    },
     // Drive - the file and folder rules, and the three deploy routes
     // The body is the file itself, so there is nothing to annotate
     'GET /SASjsApi/drive/file': { implemented: true },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sasjs/api",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "The SASjs Server API, described once - a generated route table, the services behind it, and the conformance corpus both hosts run",
   "license": "MIT",
   "author": "SASjs",
@@ -17,6 +17,11 @@
       "types": "./build/esm/index.d.ts",
       "import": "./build/esm/index.js",
       "require": "./build/cjs/index.js"
+    },
+    "./code": {
+      "types": "./build/esm/code/index.d.ts",
+      "import": "./build/esm/code/index.js",
+      "require": "./build/cjs/code/index.js"
     }
   },
   "files": [
@@ -60,5 +65,8 @@
     "deepmerge": "$deepmerge",
     "glob": "14.0.3",
     "minimatch": "11.0.4"
+  },
+  "dependencies": {
+    "@sasjs/lint": "5.0.0"
   }
 }