v0.13.0-alpha.1 - see CHANGELOG for details

Author: Thesephi

.gitignore

@@ -28,3 +28,4 @@ Temporary Items
 
 cov_profile
 cov_profile.lcov
+docs

CHANGELOG.md

@@ -1,3 +1,11 @@
+## Unreleased
+
+### Changed
+
+- switched from `deps.ts` and `dev_deps.ts` to `deno.jsonc`
+- revamped documentation
+- code format
+
 ## [0.12.2] - 2024-12-06
 
 ### Added

deno.json

@@ -0,0 +1,18 @@
+{
+  "imports": {
+    "@asteasolutions/zod-to-openapi": "npm:@asteasolutions/zod-to-openapi@^7.3.0",
+    "@dklab/oak-routing-ctrl": "jsr:@dklab/oak-routing-ctrl@^0.12.2",
+    "@oak/oak": "jsr:@oak/oak@^17.1.3",
+    "@std/assert": "jsr:@std/assert@^1.0.9",
+    "@std/io": "jsr:@std/io@^0.225.0",
+    "@std/path": "jsr:@std/path@^1.0.8",
+    "@std/testing": "jsr:@std/testing@^1.0.6",
+    "zod": "npm:zod@^3.23.8"
+  },
+  "tasks": {
+    "pretty": "deno lint --ignore=docs && deno check . && deno fmt",
+    "test": "deno test -RE",
+    "check-doc": "deno check --doc .",
+    "doc": "deno doc --html mod.ts"
+  }
+}

deno.lock

@@ -1,11 +1,12 @@
 {
   "name": "@dklab/oak-routing-ctrl",
-  "version": "0.12.2",
+  "version": "0.13.0",
   "exports": {
     ".": "./mod.ts",
     "./mod": "./mod.ts"
   },
   "exclude": [
+    "./docs",
     "./test_utils",
     "**/*_test.ts",
     "cov_profile",

dev_deps.ts

@@ -1,6 +1,6 @@
 export { useOakServer } from "./src/useOakServer.ts";
-export { useOakServer as useOak } from "./src/useOakServer.ts";
-export { useOas } from "./src/useOas.ts";
+export { useOak } from "./src/useOakServer.ts";
+export { useOas, type UseOasConfig } from "./src/useOas.ts";
 export { Controller } from "./src/Controller.ts";
 export {
   type ControllerMethodArg,
@@ -14,4 +14,8 @@ export { Delete } from "./src/Delete.ts";
 export { Options } from "./src/Options.ts";
 export { Head } from "./src/Head.ts";
 
-export { type OakOpenApiSpec, z, type zInfer } from "./deps.ts";
+export {
+  type OakOpenApiSpec,
+  z,
+  type zInfer,
+} from "./src/utils/schema_utils.ts";

jsr.json

@@ -1,20 +1,31 @@
+import { join } from "@std/path";
 import { debug } from "./utils/logger.ts";
-import { join } from "../deps.ts";
 import { store } from "./Store.ts";
 import { patchOasPath } from "./oasStore.ts";
 
 /**
- * Just a standard Class, that can be decorated with the `@Controller` decorator
+ * Just a standard Class, that can be decorated with the {@linkcode Controller} decorator
  */
 export type ControllerClass = new (args?: unknown) => unknown;
 
+type ClassDecorator = (
+  target: ControllerClass,
+  context?: ClassDecoratorContext,
+) => void;
+
 /**
  * Decorator that should be used on the Controller Class
  * @NOTE under `experimentalDecorators`, `context` is not available
+ * @example
+ * ```ts
+ * ;@Controller("/api/")
+ * class ExampleClass {
+ *   // functions that handle endpoints starting with `/api/`
+ * }
+ * ```
  */
 export const Controller =
-  (pathPrefix: string = "") =>
-  (target: ControllerClass, context?: ClassDecoratorContext): void => {
+  (pathPrefix: string = ""): ClassDecorator => (target, context): void => {
     debug(
       `invoking ControllerDecorator for ${target.name} -`,
       "runtime provides context:",