@nil-/doc 0.2.23 → 0.2.24

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @nil-/doc
 
+## 0.2.24
+
+### Patch Changes
+
+-   782e6fa: [doc][breaking] simplified sveltekit glue layer
+-   782e6fa: [doc] added documentation to public methods
+
 ## 0.2.23
 
 ### Patch Changes

package/components/navigation/utils.d.ts

@@ -1,5 +1,27 @@
 import type { Tree, Sorter, Renamer } from "./types";
+/**
+ * Compares two texts for sorting.
+ *
+ * If the texts follows `<I>-<Name>` format,
+ * sorting is done by comparing the numbers in the prefix.
+ *
+ * If only one of the texts follows `<I>-<Name>` format,
+ * the text that follows the format is considered as higher in order.
+ *
+ * Else comparison is done using built-in `string` comparison.
+ *
+ * @param {string} l
+ * @param {string} r
+ * @returns `-1 | 0 | +1`
+ */
 declare const sorter: Sorter;
+/**
+ * If a text follows `<I>-<Name>` format,
+ * this method simply removes the Prefix.
+ *
+ * @param {string} text
+ * @returns `<Name>`
+ */
 declare const renamer: Renamer;
 export declare function sort(t: Record<string, Tree>, order: (l: string, r: string) => 1 | 0 | -1): [string, Tree][];
 export { sorter, renamer };

package/components/navigation/utils.js

@@ -8,6 +8,21 @@ function sorterT(l, r) {
     }
     return 0;
 }
+/**
+ * Compares two texts for sorting.
+ *
+ * If the texts follows `<I>-<Name>` format,
+ * sorting is done by comparing the numbers in the prefix.
+ *
+ * If only one of the texts follows `<I>-<Name>` format,
+ * the text that follows the format is considered as higher in order.
+ *
+ * Else comparison is done using built-in `string` comparison.
+ *
+ * @param {string} l
+ * @param {string} r
+ * @returns `-1 | 0 | +1`
+ */
 const sorter = (l, r) => {
     const lmatch = match.exec(l);
     const rmatch = match.exec(r);
@@ -22,12 +37,19 @@ const sorter = (l, r) => {
     }
     return sorterT(parseInt(lmatch[1]), parseInt(rmatch[1]));
 };
-const renamer = (t) => {
-    const m = match.exec(t);
+/**
+ * If a text follows `<I>-<Name>` format,
+ * this method simply removes the Prefix.
+ *
+ * @param {string} text
+ * @returns `<Name>`
+ */
+const renamer = (text) => {
+    const m = match.exec(text);
     if (m) {
         return m[2];
     }
-    return t;
+    return text;
 };
 export function sort(t, order) {
     return Object.entries(t).sort(([l], [r]) => order(l, r));

package/index.d.ts

@@ -1,4 +1,3 @@
-export { routes } from "./components/routes";
 export { renamer, sorter } from "./components/navigation/utils";
 export type { Control } from "./components/block/controls/types";
 export { default as Layout } from "./components/Layout.svelte";

package/index.js

@@ -1,4 +1,3 @@
-export { routes } from "./components/routes";
 export { renamer, sorter } from "./components/navigation/utils";
 export { default as Layout } from "./components/Layout.svelte";
 export { default as Block } from "./components/block/Block.svelte";

package/package.json

@@ -1,24 +1,24 @@
 {
   "name": "@nil-/doc",
-  "version": "0.2.23",
+  "version": "0.2.24",
   "author": {
     "email": "njaldea@gmail.com",
     "name": "Neil Aldea"
   },
   "peerDependencies": {
-    "svelte": "^3.54.0"
+    "svelte": "^3.55.0"
   },
   "devDependencies": {
     "@sveltejs/adapter-vercel": "^1.0.0",
-    "@sveltejs/kit": "^1.0.0",
-    "@sveltejs/package": "^1.0.0",
+    "@sveltejs/kit": "^1.0.1",
+    "@sveltejs/package": "^1.0.1",
     "mdsvex": "^0.10.6",
     "svelte-check": "^2.10.2",
     "svelte-markdown": "^0.2.3",
     "svelte-preprocess": "^4.10.7",
     "tslib": "^2.4.1",
     "typescript": "^4.9.4",
-    "vite": "^4.0.0"
+    "vite": "^4.0.1"
   },
   "type": "module",
   "publishConfig": {
@@ -32,7 +32,8 @@
   "license": "ISC",
   "exports": {
     "./package.json": "./package.json",
-    ".": "./index.js"
+    ".": "./index.js",
+    "./sveltekit": "./sveltekit/index.js"
   },
   "svelte": "./index.js"
 }

package/sveltekit/index.d.ts

@@ -0,0 +1,22 @@
+import { type Readable } from "svelte/store";
+type Routes = {
+    /**
+     * Routes
+     */
+    data: string[];
+    /**
+     * Removes unneeded group layout in the route
+     * @param {string} route
+     * @returns
+     */
+    current: Readable<string | null>;
+    navigate: (e: CustomEvent<string>) => void;
+};
+/**
+ * Dedicated helper method to be used for sveltekit
+ * @param detail - vite's `import.meta.glob(..., { eager: true })`
+ * @param prefix - only use when layout is not in the root route
+ * @returns Routes
+ */
+export declare function sveltekit(detail: Record<string, unknown>, prefix?: string | null): Routes;
+export {};

package/sveltekit/index.js

@@ -0,0 +1,47 @@
+import { derived } from "svelte/store";
+import { page } from "$app/stores";
+import { goto } from "$app/navigation";
+const PREFIX = ".";
+const SUFFIX = "/+page.svelte";
+function toRoute(p) {
+    return p.substring(PREFIX.length, p.length - SUFFIX.length);
+}
+const route_advanced_layout_match = /\(.*\)/;
+function collapseLayout(p) {
+    return p
+        .split("/")
+        .filter((p) => route_advanced_layout_match.exec(p) == null)
+        .join("/");
+}
+function isNotRoot(p) {
+    return p !== "/";
+}
+const route_rest_match = /.*\[.*\].*/;
+function isRouteDynamic(p) {
+    return route_rest_match.exec(p) == null;
+}
+/**
+ * Dedicated helper method to be used for sveltekit
+ * @param detail - vite's `import.meta.glob(..., { eager: true })`
+ * @param prefix - only use when layout is not in the root route
+ * @returns Routes
+ */
+export function sveltekit(detail, prefix = null) {
+    return {
+        data: Object.keys(detail)
+            .map(toRoute)
+            .map(collapseLayout)
+            .filter(isNotRoot)
+            .filter(isRouteDynamic),
+        current: derived(page, ($page) => {
+            if ($page.route.id) {
+                if (prefix) {
+                    return collapseLayout($page.route.id.substring(prefix.length));
+                }
+                return collapseLayout($page.route.id);
+            }
+            return null;
+        }),
+        navigate: prefix ? (e) => goto(`${prefix}${e.detail}`) : (e) => goto(e.detail)
+    };
+}

package/components/routes.d.ts

@@ -1,6 +0,0 @@
-type Routes = {
-    data: string[];
-    process: (r: string | null) => string | null;
-};
-export declare function routes(files_from_import_meta: Record<string, unknown>): Routes;
-export {};

package/components/routes.js

@@ -1,29 +0,0 @@
-const prefix = ".".length;
-const suffix = "/+page.svelte".length;
-function toRoute(p) {
-    return p.substring(prefix, p.length - suffix);
-}
-const route_advanced_layout_match = /\(.*\)/;
-function collapseLayout(p) {
-    return p
-        .split("/")
-        .filter((p) => route_advanced_layout_match.exec(p) == null)
-        .join("/");
-}
-function isNotRoot(p) {
-    return p !== "/";
-}
-const route_rest_match = /.*\[.*\].*/;
-function isRouteDynamic(p) {
-    return route_rest_match.exec(p) == null;
-}
-export function routes(files_from_import_meta) {
-    return {
-        data: Object.keys(files_from_import_meta)
-            .map(toRoute)
-            .map(collapseLayout)
-            .filter(isNotRoot)
-            .filter(isRouteDynamic),
-        process: (r) => (r ? collapseLayout(r) : null)
-    };
-}