@maydotinc/q-studio 0.1.0 → 0.8.0

package/dist/express/index.d.ts

@@ -1,38 +0,0 @@
-import { WorkbenchOptions } from '@maydotinc/q-studio/core';
-export { WorkbenchOptions } from '@maydotinc/q-studio/core';
-import { Queue } from 'bullmq';
-import { Router } from 'express';
-
-/**
- * Mount the Workbench dashboard on an Express app.
- *
- * Returns an Express `Router` so it composes with `app.use("/path", router)`.
- *
- * @example
- * ```ts
- * import express from "express";
- * import { Queue } from "bullmq";
- * import { qStudio } from "@maydotinc/q-studio/express";
- *
- * const app = express();
- * const emailQueue = new Queue("email", {
- *   connection: { url: process.env.REDIS_URL! },
- * });
- *
- * app.use(
- *   "/jobs",
- *   qStudio({
- *     queues: [emailQueue],
- *     auth: {
- *       username: process.env.WORKBENCH_USER!,
- *       password: process.env.WORKBENCH_PASS!,
- *     },
- *   }),
- * );
- *
- * app.listen(3000);
- * ```
- */
-declare function qStudio(options: WorkbenchOptions | Queue[]): Router;
-
-export { qStudio };

package/dist/express/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\n  BASIC_AUTH_CHALLENGE,\n  buildRouteTable,\n  checkBasicAuth,\n  renderIndexHtml,\n  resolveBasePath,\n  serveStaticAsset,\n  WorkbenchCore,\n  type WorkbenchOptions,\n} from \"@maydotinc/q-studio/core\";\nimport type { Queue } from \"bullmq\";\nimport express, { type Router } from \"express\";\n\n/**\n * Mount the Workbench dashboard on an Express app.\n *\n * Returns an Express `Router` so it composes with `app.use(\"/path\", router)`.\n *\n * @example\n * ```ts\n * import express from \"express\";\n * import { Queue } from \"bullmq\";\n * import { qStudio } from \"@maydotinc/q-studio/express\";\n *\n * const app = express();\n * const emailQueue = new Queue(\"email\", {\n *   connection: { url: process.env.REDIS_URL! },\n * });\n *\n * app.use(\n *   \"/jobs\",\n *   qStudio({\n *     queues: [emailQueue],\n *     auth: {\n *       username: process.env.WORKBENCH_USER!,\n *       password: process.env.WORKBENCH_PASS!,\n *     },\n *   }),\n * );\n *\n * app.listen(3000);\n * ```\n */\nexport function qStudio(options: WorkbenchOptions | Queue[]): Router {\n  const core = new WorkbenchCore(options);\n  const router = express.Router();\n\n  if (core.requiresAuth()) {\n    router.use((req, res, next) => {\n      if (\n        !checkBasicAuth(\n          req.headers.authorization,\n          core.options.auth!.username,\n          core.options.auth!.password,\n        )\n      ) {\n        res.set(BASIC_AUTH_CHALLENGE.headers);\n        res.status(BASIC_AUTH_CHALLENGE.status).send(BASIC_AUTH_CHALLENGE.body);\n        return;\n      }\n      next();\n    });\n  }\n\n  router.use(\"/api\", (_req, res, next) => {\n    res.set(\"Access-Control-Allow-Origin\", \"*\");\n    res.set(\"Access-Control-Allow-Methods\", \"GET,HEAD,PUT,PATCH,POST,DELETE\");\n    res.set(\"Access-Control-Allow-Headers\", \"*\");\n    next();\n  });\n\n  router.use(\"/api\", express.json());\n\n  for (const route of buildRouteTable(core)) {\n    router[route.method](`/api${route.path}`, async (req, res) => {\n      try {\n        const result = await route.handler({\n          params: req.params as Record<string, string>,\n          query: req.query as Record<string, string | undefined>,\n          body: req.body,\n        });\n        res.status(result.status).json(result.body);\n      } catch (error) {\n        res.status(500).json({\n          error:\n            error instanceof Error ? error.message : \"Internal server error\",\n        });\n      }\n    });\n  }\n\n  router.get(\"/config\", (_req, res) => {\n    res.json(core.getConfig());\n  });\n\n  router.get(\"/favicon.ico\", (req, res) => {\n    const asset = serveStaticAsset(\"favicon.ico\");\n    if (asset.status === 404 || !asset.body) {\n      res.status(404).type(\"text/plain\").send(\"Not found\");\n      return;\n    }\n\n    res.status(200).type(asset.contentType).send(asset.body);\n  });\n\n  router.get(\"/assets/:file\", (req, res) => {\n    const asset = serveStaticAsset(req.params.file as string);\n    if (asset.status === 404 || !asset.body) {\n      res.status(404).type(\"text/plain\").send(\"Not found\");\n      return;\n    }\n    res.status(200).type(asset.contentType).send(asset.body);\n  });\n\n  router.use((req, res, next) => {\n    if (req.method !== \"GET\") {\n      next();\n      return;\n    }\n    const pathname = (req.originalUrl ?? req.url).split(\"?\")[0] ?? \"/\";\n    const basePath = resolveBasePath(core.options.basePath, pathname);\n    const html = renderIndexHtml(basePath, core.options.title || \"Workbench\");\n    res.status(200).type(\"text/html; charset=utf-8\").send(html.body);\n  });\n\n  return router;\n}\n\nexport type { WorkbenchOptions } from \"@maydotinc/q-studio/core\";\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OAEK;AAEP,OAAO,aAA8B;AAgC9B,SAAS,QAAQ,SAA6C;AACnE,QAAM,OAAO,IAAI,cAAc,OAAO;AACtC,QAAM,SAAS,QAAQ,OAAO;AAE9B,MAAI,KAAK,aAAa,GAAG;AACvB,WAAO,IAAI,CAAC,KAAK,KAAK,SAAS;AAC7B,UACE,CAAC;AAAA,QACC,IAAI,QAAQ;AAAA,QACZ,KAAK,QAAQ,KAAM;AAAA,QACnB,KAAK,QAAQ,KAAM;AAAA,MACrB,GACA;AACA,YAAI,IAAI,qBAAqB,OAAO;AACpC,YAAI,OAAO,qBAAqB,MAAM,EAAE,KAAK,qBAAqB,IAAI;AACtE;AAAA,MACF;AACA,WAAK;AAAA,IACP,CAAC;AAAA,EACH;AAEA,SAAO,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS;AACtC,QAAI,IAAI,+BAA+B,GAAG;AAC1C,QAAI,IAAI,gCAAgC,gCAAgC;AACxE,QAAI,IAAI,gCAAgC,GAAG;AAC3C,SAAK;AAAA,EACP,CAAC;AAED,SAAO,IAAI,QAAQ,QAAQ,KAAK,CAAC;AAEjC,aAAW,SAAS,gBAAgB,IAAI,GAAG;AACzC,WAAO,MAAM,MAAM,EAAE,OAAO,MAAM,IAAI,IAAI,OAAO,KAAK,QAAQ;AAC5D,UAAI;AACF,cAAM,SAAS,MAAM,MAAM,QAAQ;AAAA,UACjC,QAAQ,IAAI;AAAA,UACZ,OAAO,IAAI;AAAA,UACX,MAAM,IAAI;AAAA,QACZ,CAAC;AACD,YAAI,OAAO,OAAO,MAAM,EAAE,KAAK,OAAO,IAAI;AAAA,MAC5C,SAAS,OAAO;AACd,YAAI,OAAO,GAAG,EAAE,KAAK;AAAA,UACnB,OACE,iBAAiB,QAAQ,MAAM,UAAU;AAAA,QAC7C,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO,IAAI,WAAW,CAAC,MAAM,QAAQ;AACnC,QAAI,KAAK,KAAK,UAAU,CAAC;AAAA,EAC3B,CAAC;AAED,SAAO,IAAI,gBAAgB,CAAC,KAAK,QAAQ;AACvC,UAAM,QAAQ,iBAAiB,aAAa;AAC5C,QAAI,MAAM,WAAW,OAAO,CAAC,MAAM,MAAM;AACvC,UAAI,OAAO,GAAG,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW;AACnD;AAAA,IACF;AAEA,QAAI,OAAO,GAAG,EAAE,KAAK,MAAM,WAAW,EAAE,KAAK,MAAM,IAAI;AAAA,EACzD,CAAC;AAED,SAAO,IAAI,iBAAiB,CAAC,KAAK,QAAQ;AACxC,UAAM,QAAQ,iBAAiB,IAAI,OAAO,IAAc;AACxD,QAAI,MAAM,WAAW,OAAO,CAAC,MAAM,MAAM;AACvC,UAAI,OAAO,GAAG,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW;AACnD;AAAA,IACF;AACA,QAAI,OAAO,GAAG,EAAE,KAAK,MAAM,WAAW,EAAE,KAAK,MAAM,IAAI;AAAA,EACzD,CAAC;AAED,SAAO,IAAI,CAAC,KAAK,KAAK,SAAS;AAC7B,QAAI,IAAI,WAAW,OAAO;AACxB,WAAK;AACL;AAAA,IACF;AACA,UAAM,YAAY,IAAI,eAAe,IAAI,KAAK,MAAM,GAAG,EAAE,CAAC,KAAK;AAC/D,UAAM,WAAW,gBAAgB,KAAK,QAAQ,UAAU,QAAQ;AAChE,UAAM,OAAO,gBAAgB,UAAU,KAAK,QAAQ,SAAS,WAAW;AACxE,QAAI,OAAO,GAAG,EAAE,KAAK,0BAA0B,EAAE,KAAK,KAAK,IAAI;AAAA,EACjE,CAAC;AAED,SAAO;AACT;","names":[]}