@sasjs/api 0.0.0-stage → 0.2.0

package/build/cjs/host/dispatch.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HANDLED_ROUTES = exports.dispatch = void 0;
+const index_js_1 = require("../routes/index.js");
+const types_js_1 = require("../types.js");
+/**
+ * The parameters the table marks required, checked before the handler runs.
+ *
+ * Multipart fields are deliberately left to the handler: the payload carries the
+ * file itself, and the server words a missing one as `"file" is not present.`
+ * rather than `"file" is required` - a distinction a client may already key on.
+ */
+const validate = (route, request) => {
+    for (const param of route.params) {
+        if (!param.required || param.in === 'formData' || param.in === 'header')
+            continue;
+        // a path parameter comes from the matcher, not from the caller's payload, so
+        // it is the host's job to have supplied it
+        if (param.in === 'path')
+            continue;
+        const given = param.in === 'query'
+            ? request.query?.[param.name]
+            : request.body?.[param.name];
+        if (given === undefined || given === '')
+            throw new types_js_1.ApiError(400, `"${param.name}" is required`);
+    }
+};
+/** The drive path a write names: the query parameter wins over the form field. */
+const targetPath = (request) => {
+    const fromQuery = request.query?._filePath;
+    const fromBody = request.body?.filePath;
+    const path = fromQuery !== undefined
+        ? String(fromQuery)
+        : fromBody;
+    // neither given: the server's validation answers for the query parameter
+    if (path === undefined)
+        throw new types_js_1.ApiError(400, '"_filePath" is required');
+    return path;
+};
+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}`);
+    validate(route, request);
+    const { drive } = services;
+    const query = request.query || {};
+    switch (routeId) {
+        case 'GET /SASjsApi/drive/file': {
+            const file = await drive.read(String(query._filePath || ''));
+            return { status: 200, contents: file.contents };
+        }
+        case 'POST /SASjsApi/drive/file':
+        case 'PATCH /SASjsApi/drive/file': {
+            if (!request.file)
+                throw new types_js_1.ApiError(400, '"file" is not present.');
+            const path = targetPath(request);
+            const result = routeId === 'PATCH /SASjsApi/drive/file'
+                ? await drive.update(path, request.file.contents)
+                : await drive.save(path, request.file.contents);
+            return { status: 200, body: result };
+        }
+        case 'DELETE /SASjsApi/drive/file':
+            return {
+                status: 200,
+                body: await drive.remove(String(query._filePath || ''))
+            };
+        case 'GET /SASjsApi/drive/folder':
+            return { status: 200, body: await drive.list(query._folderPath) };
+        case 'POST /SASjsApi/drive/folder':
+            return {
+                status: 200,
+                body: await drive.mkdir(String(request.body?.folderPath || ''))
+            };
+        case 'DELETE /SASjsApi/drive/folder':
+            return {
+                status: 200,
+                body: await drive.rmdir(String(query._folderPath || ''))
+            };
+        case 'POST /SASjsApi/drive/rename':
+            return {
+                status: 200,
+                body: await drive.rename(String(request.body?.oldPath || ''), String(request.body?.newPath || ''))
+            };
+        case 'GET /SASjsApi/drive/filetree':
+            return { status: 200, body: await drive.tree(query._folderPath) };
+        default:
+            throw new types_js_1.ApiError(501, `This package has no handler for ${routeId}.`);
+    }
+};
+exports.dispatch = dispatch;
+/** Whether a route is one `dispatch` can answer today. */
+exports.HANDLED_ROUTES = [
+    'GET /SASjsApi/drive/file',
+    'POST /SASjsApi/drive/file',
+    'PATCH /SASjsApi/drive/file',
+    'DELETE /SASjsApi/drive/file',
+    'GET /SASjsApi/drive/folder',
+    'POST /SASjsApi/drive/folder',
+    'DELETE /SASjsApi/drive/folder',
+    'POST /SASjsApi/drive/rename',
+    'GET /SASjsApi/drive/filetree'
+];

package/build/cjs/index.js

@@ -0,0 +1,58 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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.DRIVE_CORPUS = exports.HANDLED_ROUTES = exports.dispatch = exports.TAG_CAPABILITIES = exports.OVERLAY = exports.findRoute = exports.routeById = exports.ROUTES = exports.MemoryDriveStore = exports.createDriveService = exports.isRoot = exports.basename = exports.dirname = exports.hasBlockedExtension = exports.normaliseDrivePath = void 0;
+/**
+ * `@sasjs/api` - the SASjs Server API described once.
+ *
+ * The package has three parts, and each is usable on its own:
+ *
+ *   - the route table (`ROUTES`, `findRoute`), generated from sasjs/server's
+ *     published OpenAPI document and amended by a reviewed overlay;
+ *   - the services (`createDriveService`), which are the API's decisions over
+ *     storage a host supplies;
+ *   - the conformance corpus (`DRIVE_CORPUS`, `runCase`), which is what "the
+ *     same API" means when a test has to check it.
+ *
+ * It imports no runtime on purpose: the same build runs in an Express server and
+ * in a service worker, so anything node-shaped is a store a host passes in.
+ */
+__exportStar(require("./types.js"), exports);
+var paths_js_1 = require("./drive/paths.js");
+Object.defineProperty(exports, "normaliseDrivePath", { enumerable: true, get: function () { return paths_js_1.normaliseDrivePath; } });
+Object.defineProperty(exports, "hasBlockedExtension", { enumerable: true, get: function () { return paths_js_1.hasBlockedExtension; } });
+Object.defineProperty(exports, "dirname", { enumerable: true, get: function () { return paths_js_1.dirname; } });
+Object.defineProperty(exports, "basename", { enumerable: true, get: function () { return paths_js_1.basename; } });
+Object.defineProperty(exports, "isRoot", { enumerable: true, get: function () { return paths_js_1.isRoot; } });
+var service_js_1 = require("./drive/service.js");
+Object.defineProperty(exports, "createDriveService", { enumerable: true, get: function () { return service_js_1.createDriveService; } });
+var memory_store_js_1 = require("./drive/memory-store.js");
+Object.defineProperty(exports, "MemoryDriveStore", { enumerable: true, get: function () { return memory_store_js_1.MemoryDriveStore; } });
+var index_js_1 = require("./routes/index.js");
+Object.defineProperty(exports, "ROUTES", { enumerable: true, get: function () { return index_js_1.ROUTES; } });
+Object.defineProperty(exports, "routeById", { enumerable: true, get: function () { return index_js_1.routeById; } });
+Object.defineProperty(exports, "findRoute", { enumerable: true, get: function () { return index_js_1.findRoute; } });
+var overlay_js_1 = require("./routes/overlay.js");
+Object.defineProperty(exports, "OVERLAY", { enumerable: true, get: function () { return overlay_js_1.OVERLAY; } });
+Object.defineProperty(exports, "TAG_CAPABILITIES", { enumerable: true, get: function () { return overlay_js_1.TAG_CAPABILITIES; } });
+var dispatch_js_1 = require("./host/dispatch.js");
+Object.defineProperty(exports, "dispatch", { enumerable: true, get: function () { return dispatch_js_1.dispatch; } });
+Object.defineProperty(exports, "HANDLED_ROUTES", { enumerable: true, get: function () { return dispatch_js_1.HANDLED_ROUTES; } });
+var drive_js_1 = require("./corpus/drive.js");
+Object.defineProperty(exports, "DRIVE_CORPUS", { enumerable: true, get: function () { return drive_js_1.DRIVE_CORPUS; } });
+var runner_js_1 = require("./corpus/runner.js");
+Object.defineProperty(exports, "runCase", { enumerable: true, get: function () { return runner_js_1.runCase; } });
+Object.defineProperty(exports, "servicesFor", { enumerable: true, get: function () { return runner_js_1.servicesFor; } });