storybooker 0.19.4 → 0.22.0-canary.0

package/dist/~internal/router.mjs

@@ -0,0 +1,39 @@
+import { SERVICE_NAME } from "./constants.mjs";
+import { getStore } from "../utils/store.mjs";
+import { createUIAdapterOptions } from "../utils/ui-utils.mjs";
+import { accountRouter } from "../routers/account-router.mjs";
+import { buildsRouter } from "../routers/builds-router.mjs";
+import { projectsRouter } from "../routers/projects-router.mjs";
+import { rootRouter } from "../routers/root-router.mjs";
+import { tagsRouter } from "../routers/tags-router.mjs";
+import { tasksRouter } from "../routers/tasks-router.mjs";
+import { OpenAPIHono } from "@hono/zod-openapi";
+import { swaggerUI } from "@hono/swagger-ui";
+
+//#region src/routers/_app-router.ts
+/**
+* @private
+*/
+const openapiConfig = {
+	openapi: "3.1.0",
+	info: {
+		title: SERVICE_NAME,
+		version: ""
+	}
+};
+/**
+* @private
+*/
+const appRouter = new OpenAPIHono({ strict: false }).doc31("/openapi.json", openapiConfig).get("/openapi.yaml", async (ctx) => {
+	const spec = appRouter.getOpenAPI31Document(openapiConfig);
+	const content = (await import("js-yaml").then((mod) => mod.dump))(spec, { forceQuotes: true });
+	return ctx.body(content, 200, { "Content-Type": "application/yaml" });
+}).get("/openapi", swaggerUI({ url: "/openapi.json" })).route("/", rootRouter).route("/", projectsRouter).route("/", buildsRouter).route("/", tagsRouter).route("/tasks", tasksRouter).route("/account", accountRouter).get("/:filepath{.+}", async (context) => {
+	const { ui } = getStore();
+	if (!ui?.handleUnhandledRoute) return context.notFound();
+	return await ui.handleUnhandledRoute(context.req.param("filepath"), createUIAdapterOptions());
+});
+
+//#endregion
+export { appRouter, openapiConfig };
+//# sourceMappingURL=router.mjs.map

package/dist/~internal/router.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.mjs","names":["openapiConfig: OpenAPIObjectConfig<OpenAPIObjectConfigure<Env, \"\">>","content: string"],"sources":["../../src/routers/_app-router.ts"],"sourcesContent":["import { swaggerUI } from \"@hono/swagger-ui\";\nimport { OpenAPIHono, type OpenAPIObjectConfigure } from \"@hono/zod-openapi\";\nimport type { Context, Env } from \"hono\";\nimport { SERVICE_NAME } from \"../utils/constants.ts\";\nimport { getStore } from \"../utils/store.ts\";\nimport { createUIAdapterOptions } from \"../utils/ui-utils.ts\";\nimport { accountRouter } from \"./account-router.ts\";\nimport { buildsRouter } from \"./builds-router.ts\";\nimport { projectsRouter } from \"./projects-router.ts\";\nimport { rootRouter } from \"./root-router.ts\";\nimport { tagsRouter } from \"./tags-router.ts\";\nimport { tasksRouter } from \"./tasks-router.ts\";\n\ntype OpenAPIObjectConfig<Configure extends OpenAPIObjectConfigure<Env, \"\">> = Configure extends (\n  context: Context,\n) => infer Config\n  ? Config\n  : Configure;\n/**\n * @private\n */\nexport const openapiConfig: OpenAPIObjectConfig<OpenAPIObjectConfigure<Env, \"\">> = {\n  openapi: \"3.1.0\",\n  info: { title: SERVICE_NAME, version: \"\" },\n};\n\n/**\n * @private\n */\nexport type AppRouter = typeof appRouter;\n\n/**\n * @private\n */\nexport const appRouter = new OpenAPIHono({ strict: false })\n  .doc31(\"/openapi.json\", openapiConfig)\n  .get(\"/openapi.yaml\", async (ctx) => {\n    const spec = (appRouter as OpenAPIHono).getOpenAPI31Document(openapiConfig);\n    const dumpYaml = await import(\"js-yaml\").then((mod) => mod.dump);\n    const content: string = dumpYaml(spec, { forceQuotes: true });\n    return ctx.body(content, 200, { \"Content-Type\": \"application/yaml\" });\n  })\n  .get(\"/openapi\", swaggerUI({ url: \"/openapi.json\" }))\n  .route(\"/\", rootRouter)\n  .route(\"/\", projectsRouter)\n  .route(\"/\", buildsRouter)\n  .route(\"/\", tagsRouter)\n  .route(\"/tasks\", tasksRouter)\n  .route(\"/account\", accountRouter)\n  .get(\"/:filepath{.+}\", async (context) => {\n    const { ui } = getStore();\n    if (!ui?.handleUnhandledRoute) {\n      return context.notFound();\n    }\n\n    return await ui.handleUnhandledRoute(context.req.param(\"filepath\"), createUIAdapterOptions());\n  });\n"],"mappings":";;;;;;;;;;;;;;;;AAqBA,MAAaA,gBAAsE;CACjF,SAAS;CACT,MAAM;EAAE,OAAO;EAAc,SAAS;EAAI;CAC3C;;;;AAUD,MAAa,YAAY,IAAI,YAAY,EAAE,QAAQ,OAAO,CAAC,CACxD,MAAM,iBAAiB,cAAc,CACrC,IAAI,iBAAiB,OAAO,QAAQ;CACnC,MAAM,OAAQ,UAA0B,qBAAqB,cAAc;CAE3E,MAAMC,WADW,MAAM,OAAO,WAAW,MAAM,QAAQ,IAAI,KAAK,EAC/B,MAAM,EAAE,aAAa,MAAM,CAAC;AAC7D,QAAO,IAAI,KAAK,SAAS,KAAK,EAAE,gBAAgB,oBAAoB,CAAC;EACrE,CACD,IAAI,YAAY,UAAU,EAAE,KAAK,iBAAiB,CAAC,CAAC,CACpD,MAAM,KAAK,WAAW,CACtB,MAAM,KAAK,eAAe,CAC1B,MAAM,KAAK,aAAa,CACxB,MAAM,KAAK,WAAW,CACtB,MAAM,UAAU,YAAY,CAC5B,MAAM,YAAY,cAAc,CAChC,IAAI,kBAAkB,OAAO,YAAY;CACxC,MAAM,EAAE,OAAO,UAAU;AACzB,KAAI,CAAC,IAAI,qBACP,QAAO,QAAQ,UAAU;AAG3B,QAAO,MAAM,GAAG,qBAAqB,QAAQ,IAAI,MAAM,WAAW,EAAE,wBAAwB,CAAC;EAC7F"}

package/dist/~internal/types.d.mts

@@ -0,0 +1,77 @@
+import { LoggerAdapter } from "./adapter/logger.mjs";
+import { AuthAdapter, StoryBookerPermissionAction, StoryBookerPermissionKey, StoryBookerPermissionResource, StoryBookerPermissionWithKey, StoryBookerUser } from "./adapter/auth.mjs";
+import { DatabaseAdapter } from "./adapter/database.mjs";
+import { StorageAdapter } from "./adapter/storage.mjs";
+import { ErrorParser, ParsedError } from "../utils/error.mjs";
+import { BuildCreateType, BuildStoryType, BuildType, BuildUpdateType, BuildUploadVariant, BuildsGetResultType, BuildsListResultType } from "../models/builds-schema.mjs";
+import { ProjectCreateType, ProjectGetResultType, ProjectType, ProjectUpdateType, ProjectsListResultType } from "../models/projects-schema.mjs";
+import { TagCreateType, TagType, TagUpdateType, TagVariant, TagsGetResultType, TagsListResultType } from "../models/tags-schema.mjs";
+import { UrlBuilder } from "../urls.mjs";
+import { UIAdapter } from "./adapter/ui.mjs";
+import "./adapter.mjs";
+import { MiddlewareHandler } from "hono";
+
+//#region src/types.d.ts
+/**
+ * Options for creating a router.
+ */
+interface RouterOptions<User extends StoryBookerUser> {
+  /** Adapter for Auth service. Provides authentication to the service. */
+  auth?: AuthAdapter<User>;
+  /** Adapter for Database service. Provides access to storing data to the service. */
+  database: DatabaseAdapter;
+  /** Additional options to configure the router. */
+  config?: RouterConfig;
+  /** Adapter for Logging service. Provides option to direct the logging of the service. */
+  logger?: LoggerAdapter;
+  /** Adapter for Storage service. Provides access to storing files to the service. */
+  storage: StorageAdapter;
+  /** Options to customise StoryBooker UI. */
+  ui?: UIAdapter;
+}
+/**
+ * Options for creating a purge handler.
+ */
+interface PurgeHandlerOptions {
+  /** Adapter for Database service. Provides access to storing data to the service. */
+  database: DatabaseAdapter;
+  /**
+   * A function for parsing custom errors.
+   * Return `undefined` from parser if the service should handle the error.
+   */
+  errorParser?: ErrorParser;
+  /** Adapter for Logging service. Provides option to direct the logging of the service. */
+  logger?: LoggerAdapter;
+  /** Adapter for Storage service. Provides access to storing files to the service. */
+  storage: StorageAdapter;
+}
+/** Additional options to configure the router. */
+interface RouterConfig {
+  /**
+   * A function for parsing custom errors.
+   * Return `undefined` from parser if the service should handle the error.
+   */
+  errorParser?: ErrorParser;
+  /**
+   * Maximum upload size in bytes for processing zip files while uploading.
+   * @default "5 * 1024 * 1024" (5MB)
+   */
+  maxInlineUploadProcessingSizeInBytes?: number;
+  /**
+   * Enable queueing of zip file processing for files larger than the maximum inline upload processing size.
+   * Requires QueueAdapter and other setup.
+   * @default false
+   */
+  queueLargeZipFileProcessing?: boolean;
+  /**
+   * Convey URL prefix to the service if the router is not hosted on the root.
+   */
+  prefix?: string;
+  /**
+   * Add Hono middlewares to the router before any endpoint is registered/invoked.
+   */
+  middlewares?: MiddlewareHandler[];
+}
+//#endregion
+export { type BuildCreateType, type BuildStoryType, type BuildType, type BuildUpdateType, type BuildUploadVariant, type BuildsGetResultType, type BuildsListResultType, type ErrorParser, type ParsedError, type ProjectCreateType, type ProjectGetResultType, type ProjectType, type ProjectUpdateType, type ProjectsListResultType, PurgeHandlerOptions, RouterConfig, RouterOptions, type StoryBookerPermissionAction, type StoryBookerPermissionKey, type StoryBookerPermissionResource, type StoryBookerPermissionWithKey, type StoryBookerUser, type TagCreateType, type TagType, type TagUpdateType, type TagVariant, type TagsGetResultType, type TagsListResultType, type UrlBuilder };
+//# sourceMappingURL=types.d.mts.map

package/dist/~internal/types.mjs

@@ -0,0 +1 @@
+export {  };

package/dist/~internal/utils.d.mts

@@ -0,0 +1,4 @@
+import { ErrorParser, ParsedError, parseErrorMessage } from "../utils/error.mjs";
+import { CACHE_CONTROL_PUBLIC_YEAR, DEFAULT_GITHUB_BRANCH, DEFAULT_LOCALE, DEFAULT_PURGE_AFTER_DAYS, ONE_DAY_IN_MS, PATTERNS, QUERY_PARAMS, SERVICE_NAME, SERVICE_SHORT_NAME, TagTypes, buildUploadVariants } from "./constants.mjs";
+import { generatePrefixFromBaseRoute, urlJoin } from "../utils/url-utils.mjs";
+export { CACHE_CONTROL_PUBLIC_YEAR, DEFAULT_GITHUB_BRANCH, DEFAULT_LOCALE, DEFAULT_PURGE_AFTER_DAYS, type ErrorParser, ONE_DAY_IN_MS, PATTERNS, type ParsedError, QUERY_PARAMS, SERVICE_NAME, SERVICE_SHORT_NAME, TagTypes, buildUploadVariants, generatePrefixFromBaseRoute, parseErrorMessage, urlJoin };

package/dist/~internal/utils.mjs

@@ -0,0 +1,5 @@
+import { CACHE_CONTROL_PUBLIC_YEAR, DEFAULT_GITHUB_BRANCH, DEFAULT_LOCALE, DEFAULT_PURGE_AFTER_DAYS, ONE_DAY_IN_MS, PATTERNS, QUERY_PARAMS, SERVICE_NAME, SERVICE_SHORT_NAME, TagTypes, buildUploadVariants } from "./constants.mjs";
+import { generatePrefixFromBaseRoute, urlJoin } from "../utils/url-utils.mjs";
+import { parseErrorMessage } from "../utils/error.mjs";
+
+export { CACHE_CONTROL_PUBLIC_YEAR, DEFAULT_GITHUB_BRANCH, DEFAULT_LOCALE, DEFAULT_PURGE_AFTER_DAYS, ONE_DAY_IN_MS, PATTERNS, QUERY_PARAMS, SERVICE_NAME, SERVICE_SHORT_NAME, TagTypes, buildUploadVariants, generatePrefixFromBaseRoute, parseErrorMessage, urlJoin };