docs: oas (#197)

Adds OpenAPI specification of Storefront and Admin APIs.
Updates docs project.

docs-util/helpers/setup-server.js

@@ -0,0 +1,30 @@
+const path = require("path");
+const { spawn } = require("child_process");
+
+const { setPort } = require("./use-api");
+
+module.exports = ({ cwd }) => {
+  const serverPath = path.join(__dirname, "test-server.js");
+
+  return new Promise((resolve, reject) => {
+    const medusaProcess = spawn("node", [path.resolve(serverPath)], {
+      cwd,
+      env: {
+        ...process.env,
+        NODE_ENV: "development",
+        JWT_SECRET: "test",
+        COOKIE_SECRET: "test",
+      },
+      stdio: ["ignore", "ignore", "inherit", "ipc"],
+    });
+
+    medusaProcess.on("uncaughtException", (err) => {
+      medusaProcess.kill();
+    });
+
+    medusaProcess.on("message", (port) => {
+      setPort(port);
+      resolve(medusaProcess);
+    });
+  });
+};

docs-util/helpers/test-server.js

@@ -0,0 +1,32 @@
+const path = require("path");
+const express = require("express");
+const getPort = require("get-port");
+
+const loaders = require("@medusajs/medusa/dist/loaders").default;
+
+const initialize = async () => {
+  const app = express();
+
+  const { dbConnection } = await loaders({
+    directory: path.resolve(process.cwd()),
+    expressApp: app,
+  });
+
+  const PORT = await getPort();
+
+  return {
+    db: dbConnection,
+    app,
+    port: PORT,
+  };
+};
+
+const setup = async () => {
+  const { app, port } = await initialize();
+
+  app.listen(port, (err) => {
+    process.send(port);
+  });
+};
+
+setup();

docs-util/helpers/use-api.js

@@ -0,0 +1,21 @@
+const axios = require("axios").default;
+
+const ServerTestUtil = {
+  port_: null,
+  client_: null,
+
+  setPort: function (port) {
+    this.client_ = axios.create({ baseURL: `http://localhost:${port}` });
+  },
+};
+
+const instance = ServerTestUtil;
+
+module.exports = {
+  setPort: function (port) {
+    instance.setPort(port);
+  },
+  useApi: function () {
+    return instance.client_;
+  },
+};

docs-util/helpers/use-db.js

@@ -0,0 +1,73 @@
+const { dropDatabase, createDatabase } = require("pg-god");
+const { createConnection } = require("typeorm");
+
+const path = require("path");
+
+const DbTestUtil = {
+  db_: null,
+
+  setDb: function (connection) {
+    this.db_ = connection;
+  },
+
+  clear: function () {
+    return this.db_.synchronize(true);
+  },
+
+  shutdown: async function () {
+    await this.db_.close();
+    return dropDatabase({ databaseName });
+  },
+};
+
+const instance = DbTestUtil;
+
+module.exports = {
+  initDb: async function ({ cwd }) {
+    const migrationDir = path.resolve(
+      path.join(
+        cwd,
+        `node_modules`,
+        `@medusajs`,
+        `medusa`,
+        `dist`,
+        `migrations`
+      )
+    );
+
+    const databaseName = "medusa-fixtures";
+    await createDatabase({ databaseName });
+
+    const connection = await createConnection({
+      type: "postgres",
+      url: "postgres://localhost/medusa-fixtures",
+      migrations: [`${migrationDir}/*.js`],
+    });
+
+    await connection.runMigrations();
+    await connection.close();
+
+    const modelsLoader = require(path.join(
+      cwd,
+      `node_modules`,
+      `@medusajs`,
+      `medusa`,
+      `dist`,
+      `loaders`,
+      `models`
+    )).default;
+
+    const entities = modelsLoader({}, { register: false });
+    const dbConnection = await createConnection({
+      type: "postgres",
+      url: "postgres://localhost/medusa-fixtures",
+      entities,
+    });
+
+    instance.setDb(dbConnection);
+    return dbConnection;
+  },
+  useDb: function () {
+    return instance;
+  },
+};

docs-util/helpers/use-server.js

@@ -0,0 +1,41 @@
+const ServerTestUtil = {
+  server_: null,
+  app_: null,
+
+  setApp: function (app) {
+    this.app_ = app;
+  },
+
+  start: async function () {
+    this.server_ = await new Promise((resolve, reject) => {
+      const s = this.app_.listen(PORT, (err) => {
+        if (err) {
+          reject(err);
+        }
+      });
+      resolve(s);
+    });
+  },
+
+  kill: function () {
+    return new Promise((resolve, _) => {
+      if (this.server_) {
+        this.server_.close(() => resolve());
+      }
+      resolve();
+    });
+  },
+};
+
+const instance = ServerTestUtil;
+
+module.exports = {
+  setApp: function (app) {
+    instance.setApp(app);
+    return instance;
+  },
+
+  useServer: function () {
+    return instance;
+  },
+};