@turnipxenon/pineapple 2.4.33 → 2.4.34

package/.idea/workspace.xml

@@ -5,7 +5,9 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="accb6ba2-c343-4f84-ad30-6e2d71eceee5" name="Changes" comment="Migrate from relying on json instead of comments for meta">
-      <change beforePath="$PROJECT_DIR$/package.json" beforeDir="false" afterPath="$PROJECT_DIR$/package.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/lib/components/navigation_component/PageMeta.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/lib/components/navigation_component/PageMeta.ts" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/routes/(pineapple)/pineapple/(extra-pages)/page1/meta.json" beforeDir="false" afterPath="$PROJECT_DIR$/src/routes/(pineapple)/pineapple/(extra-pages)/page1/meta.json" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/routes/(pineapple)/pineapple/(extra-pages)/page2/meta.json" beforeDir="false" afterPath="$PROJECT_DIR$/src/routes/(pineapple)/pineapple/(extra-pages)/page2/meta.json" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -120,11 +122,11 @@
       <recent name="C:\Users\Pumpkin\Projects\Web\pineapple\src\routes\(pineapple)\pineapple\page3" />
     </key>
     <key name="MoveFile.RECENT_KEYS">
+      <recent name="C:\Users\Pumpkin\Projects\Web\pineapple\src\routes\(pineapple)\pineapple\(extra-pages)\page1" />
+      <recent name="C:\Users\Pumpkin\Projects\Web\pineapple\src\routes\(pineapple)\pineapple\(extra-pages)\page2" />
+      <recent name="C:\Users\Pumpkin\Projects\Web\pineapple\src\routes\(pineapple)\pineapple\(extra-pages)\page3" />
       <recent name="C:\Users\Pumpkin\Projects\Web\pineapple\src\routes\(pineapple)\pineapple\(extra-pages)" />
       <recent name="C:\Users\Pumpkin\Projects\Web\pineapple\src\routes\(pineapple)\pineapple\page3\page7\(test_layout)" />
-      <recent name="C:\Users\Pumpkin\Projects\Web\pineapple\src\lib\components\navigation_component" />
-      <recent name="C:\Users\Pumpkin\Projects\Web\pineapple\src\lib\components\dialog_overlay" />
-      <recent name="C:\Users\Pumpkin\Projects\Web\pineapple\src\lib\components\overrideable_meta" />
     </key>
     <key name="es6.move.members.recent.items">
       <recent name="C:\Users\Pumpkin\Projects\Web\pineapple\src\routes\types\RootLayoutProps.ts" />
@@ -243,6 +245,8 @@
       <workItem from="1711487798169" duration="264000" />
       <workItem from="1711488375110" duration="856000" />
       <workItem from="1711490061858" duration="2823000" />
+      <workItem from="1711492999560" duration="85000" />
+      <workItem from="1711493260312" duration="1358000" />
     </task>
     <task id="LOCAL-00062" summary="Improve text contrast in dark mode">
       <option name="closed" value="true" />

package/.svelte-kit/__package__/components/navigation_component/PageMeta.d.ts

@@ -1,8 +1,7 @@
 export interface PageMeta {
-    relativeLink: string;
-    nestedPages: PageMeta[];
-    title: string;
-    tags: string[];
+    datePublished?: string;
+    description?: string;
+    imageAlt?: string;
     /**
      * imageID is an ID that NavigationComponent can use to identify imported images
      *
@@ -17,18 +16,29 @@ export interface PageMeta {
      * - Your image map typescript: ImageMap.ts
      * - The page you want with an image represented in the navigation: ./topic1/+page.svelte
      * - The meta for that page: ./topic1/meta.json
+     *
+     * imageID takes precedence over imageURL
      */
     imageID?: string;
     /**
      * imageURL is only limited to absolute paths (includes files in static folder)
+     *
+     * if imageID is defined, this will be ignored
      */
     imageUrl?: string;
-    imageAlt?: string;
-    description?: string;
-    datePublished?: string;
     lastUpdated?: string;
+    nestedPages: PageMeta[];
+    /**
+     * relativeLink is generated automatically. This will be ignored in meta.json.
+     */
+    relativeLink: string;
     shouldGroup?: boolean;
     shouldHide?: boolean;
+    tags: string[];
+    /**
+     * title defaults to the directory name if it's an empty string.
+     */
+    title: string;
 }
 /**
  * todo: doc
@@ -38,3 +48,11 @@ export interface PageMeta {
 export declare const findPageMetaParent: (parentList: PageMeta[], child: PageMeta) => boolean;
 export type ParsePageMetaCompareFn = ((a: PageMeta, b: PageMeta) => number);
 export declare const parsePageMeta: (fileList: Record<string, unknown>, jsonList: Record<string, unknown>, imageMap: Map<string, string>, compareFn?: ParsePageMetaCompareFn) => PageMeta[];
+/**
+ * Prioritizes, in order, lastUpdated, datePublished, has description, then title
+ *
+ * @param a
+ * @param b
+ * @constructor
+ */
+export declare const DefaultPageMetaSorter: ParsePageMetaCompareFn;

package/.svelte-kit/__package__/components/navigation_component/PageMeta.js

@@ -75,6 +75,9 @@ export const parsePageMeta = (fileList, jsonList, imageMap, compareFn) => {
                 }
             }
         }
+        if (meta.shouldHide) {
+            continue;
+        }
         pageFlatList.push(meta);
     }
     pageFlatList.sort((a, b) => a.relativeLink.localeCompare(b.relativeLink));
@@ -89,5 +92,44 @@ export const parsePageMeta = (fileList, jsonList, imageMap, compareFn) => {
     if (compareFn) {
         pageFlatList.sort(compareFn);
     }
+    else {
+        pageFlatList.sort(DefaultPageMetaSorter);
+    }
     return pageFlatList;
 };
+const AWins = -1;
+const BWins = 1;
+/**
+ * Prioritizes, in order, lastUpdated, datePublished, has description, then title
+ *
+ * @param a
+ * @param b
+ * @constructor
+ */
+export const DefaultPageMetaSorter = (a, b) => {
+    if (a.lastUpdated && !b.lastUpdated) {
+        return AWins;
+    }
+    else if (!a.lastUpdated && b.lastUpdated) {
+        return BWins;
+    }
+    else if (a.lastUpdated && b.lastUpdated) {
+        return a.lastUpdated.localeCompare(b.lastUpdated);
+    }
+    if (a.datePublished && !b.datePublished) {
+        return AWins;
+    }
+    else if (!a.lastUpdated && b.datePublished) {
+        return BWins;
+    }
+    else if (a.datePublished && b.datePublished) {
+        return a.datePublished.localeCompare(b.datePublished);
+    }
+    if (a.description && !b.description) {
+        return AWins;
+    }
+    else if (!a.description && b.description) {
+        return BWins;
+    }
+    return a.title.localeCompare(b.title);
+};

package/.svelte-kit/generated/server/internal.js

@@ -21,7 +21,7 @@ export const options = {
 		app: ({ head, body, assets, nonce, env }) => "<!DOCTYPE html>\n<html lang=\"en\">\n\t<head>\n\t\t<meta charset=\"utf-8\" />\n\t\t<link rel=\"icon\" href=\"" + assets + "/favicon.png\" />\n\t\t<meta name=\"viewport\" content=\"width=device-width\" />\n\t\t" + head + "\n\t</head>\n\n\t<body data-sveltekit-preload-data=\"hover\" data-theme=\"crimson\">\n\t\t<div style=\"display: contents\" class=\"h-full overflow-hidden\">" + body + "</div>\n\t</body>\n</html>\n",
 		error: ({ status, message }) => "<!doctype html>\n<html lang=\"en\">\n\t<head>\n\t\t<meta charset=\"utf-8\" />\n\t\t<title>" + message + "</title>\n\n\t\t<style>\n\t\t\tbody {\n\t\t\t\t--bg: white;\n\t\t\t\t--fg: #222;\n\t\t\t\t--divider: #ccc;\n\t\t\t\tbackground: var(--bg);\n\t\t\t\tcolor: var(--fg);\n\t\t\t\tfont-family:\n\t\t\t\t\tsystem-ui,\n\t\t\t\t\t-apple-system,\n\t\t\t\t\tBlinkMacSystemFont,\n\t\t\t\t\t'Segoe UI',\n\t\t\t\t\tRoboto,\n\t\t\t\t\tOxygen,\n\t\t\t\t\tUbuntu,\n\t\t\t\t\tCantarell,\n\t\t\t\t\t'Open Sans',\n\t\t\t\t\t'Helvetica Neue',\n\t\t\t\t\tsans-serif;\n\t\t\t\tdisplay: flex;\n\t\t\t\talign-items: center;\n\t\t\t\tjustify-content: center;\n\t\t\t\theight: 100vh;\n\t\t\t\tmargin: 0;\n\t\t\t}\n\n\t\t\t.error {\n\t\t\t\tdisplay: flex;\n\t\t\t\talign-items: center;\n\t\t\t\tmax-width: 32rem;\n\t\t\t\tmargin: 0 1rem;\n\t\t\t}\n\n\t\t\t.status {\n\t\t\t\tfont-weight: 200;\n\t\t\t\tfont-size: 3rem;\n\t\t\t\tline-height: 1;\n\t\t\t\tposition: relative;\n\t\t\t\ttop: -0.05rem;\n\t\t\t}\n\n\t\t\t.message {\n\t\t\t\tborder-left: 1px solid var(--divider);\n\t\t\t\tpadding: 0 0 0 1rem;\n\t\t\t\tmargin: 0 0 0 1rem;\n\t\t\t\tmin-height: 2.5rem;\n\t\t\t\tdisplay: flex;\n\t\t\t\talign-items: center;\n\t\t\t}\n\n\t\t\t.message h1 {\n\t\t\t\tfont-weight: 400;\n\t\t\t\tfont-size: 1em;\n\t\t\t\tmargin: 0;\n\t\t\t}\n\n\t\t\t@media (prefers-color-scheme: dark) {\n\t\t\t\tbody {\n\t\t\t\t\t--bg: #222;\n\t\t\t\t\t--fg: #ddd;\n\t\t\t\t\t--divider: #666;\n\t\t\t\t}\n\t\t\t}\n\t\t</style>\n\t</head>\n\t<body>\n\t\t<div class=\"error\">\n\t\t\t<span class=\"status\">" + status + "</span>\n\t\t\t<div class=\"message\">\n\t\t\t\t<h1>" + message + "</h1>\n\t\t\t</div>\n\t\t</div>\n\t</body>\n</html>\n"
 	},
-	version_hash: "99eys7"
+	version_hash: "1l3dq8o"
 };
 
 export async function get_hooks() {

package/dist/components/navigation_component/PageMeta.d.ts

@@ -1,8 +1,7 @@
 export interface PageMeta {
-    relativeLink: string;
-    nestedPages: PageMeta[];
-    title: string;
-    tags: string[];
+    datePublished?: string;
+    description?: string;
+    imageAlt?: string;
     /**
      * imageID is an ID that NavigationComponent can use to identify imported images
      *
@@ -17,18 +16,29 @@ export interface PageMeta {
      * - Your image map typescript: ImageMap.ts
      * - The page you want with an image represented in the navigation: ./topic1/+page.svelte
      * - The meta for that page: ./topic1/meta.json
+     *
+     * imageID takes precedence over imageURL
      */
     imageID?: string;
     /**
      * imageURL is only limited to absolute paths (includes files in static folder)
+     *
+     * if imageID is defined, this will be ignored
      */
     imageUrl?: string;
-    imageAlt?: string;
-    description?: string;
-    datePublished?: string;
     lastUpdated?: string;
+    nestedPages: PageMeta[];
+    /**
+     * relativeLink is generated automatically. This will be ignored in meta.json.
+     */
+    relativeLink: string;
     shouldGroup?: boolean;
     shouldHide?: boolean;
+    tags: string[];
+    /**
+     * title defaults to the directory name if it's an empty string.
+     */
+    title: string;
 }
 /**
  * todo: doc
@@ -38,3 +48,11 @@ export interface PageMeta {
 export declare const findPageMetaParent: (parentList: PageMeta[], child: PageMeta) => boolean;
 export type ParsePageMetaCompareFn = ((a: PageMeta, b: PageMeta) => number);
 export declare const parsePageMeta: (fileList: Record<string, unknown>, jsonList: Record<string, unknown>, imageMap: Map<string, string>, compareFn?: ParsePageMetaCompareFn) => PageMeta[];
+/**
+ * Prioritizes, in order, lastUpdated, datePublished, has description, then title
+ *
+ * @param a
+ * @param b
+ * @constructor
+ */
+export declare const DefaultPageMetaSorter: ParsePageMetaCompareFn;

package/dist/components/navigation_component/PageMeta.js

@@ -75,6 +75,9 @@ export const parsePageMeta = (fileList, jsonList, imageMap, compareFn) => {
                 }
             }
         }
+        if (meta.shouldHide) {
+            continue;
+        }
         pageFlatList.push(meta);
     }
     pageFlatList.sort((a, b) => a.relativeLink.localeCompare(b.relativeLink));
@@ -89,5 +92,44 @@ export const parsePageMeta = (fileList, jsonList, imageMap, compareFn) => {
     if (compareFn) {
         pageFlatList.sort(compareFn);
     }
+    else {
+        pageFlatList.sort(DefaultPageMetaSorter);
+    }
     return pageFlatList;
 };
+const AWins = -1;
+const BWins = 1;
+/**
+ * Prioritizes, in order, lastUpdated, datePublished, has description, then title
+ *
+ * @param a
+ * @param b
+ * @constructor
+ */
+export const DefaultPageMetaSorter = (a, b) => {
+    if (a.lastUpdated && !b.lastUpdated) {
+        return AWins;
+    }
+    else if (!a.lastUpdated && b.lastUpdated) {
+        return BWins;
+    }
+    else if (a.lastUpdated && b.lastUpdated) {
+        return a.lastUpdated.localeCompare(b.lastUpdated);
+    }
+    if (a.datePublished && !b.datePublished) {
+        return AWins;
+    }
+    else if (!a.lastUpdated && b.datePublished) {
+        return BWins;
+    }
+    else if (a.datePublished && b.datePublished) {
+        return a.datePublished.localeCompare(b.datePublished);
+    }
+    if (a.description && !b.description) {
+        return AWins;
+    }
+    else if (!a.description && b.description) {
+        return BWins;
+    }
+    return a.title.localeCompare(b.title);
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@turnipxenon/pineapple",
   "description": "personal package for base styling for other personal projects",
-  "version": "2.4.33",
+  "version": "2.4.34",
   "scripts": {
     "dev": "vite dev",
     "build": "npm run check-requirements && vite build && yarn package",

package/src/lib/components/navigation_component/PageMeta.ts

@@ -1,14 +1,10 @@
 import type { RawGlob } from "$pkg/util/util";
 
 export interface PageMeta {
-	// generated meta
-	relativeLink: string;
-	nestedPages: PageMeta[];
-
-	// defined meta
-	title: string; // defaults to directory name
-	tags: string[];
+	datePublished?: string;
+	description?: string;
 
+	imageAlt?: string; // defaults to directory name
 	/**
 	 * imageID is an ID that NavigationComponent can use to identify imported images
 	 *
@@ -23,19 +19,33 @@ export interface PageMeta {
 	 * - Your image map typescript: ImageMap.ts
 	 * - The page you want with an image represented in the navigation: ./topic1/+page.svelte
 	 * - The meta for that page: ./topic1/meta.json
+	 *
+	 * imageID takes precedence over imageURL
 	 */
 	imageID?: string;
 
 	/**
 	 * imageURL is only limited to absolute paths (includes files in static folder)
+	 *
+	 * if imageID is defined, this will be ignored
 	 */
 	imageUrl?: string;
-	imageAlt?: string;
-	description?: string;
-	datePublished?: string;
+
 	lastUpdated?: string;
+	nestedPages: PageMeta[];
+
+	/**
+	 * relativeLink is generated automatically. This will be ignored in meta.json.
+	 */
+	relativeLink: string;
 	shouldGroup?: boolean;
 	shouldHide?: boolean;
+	tags: string[];
+
+	/**
+	 * title defaults to the directory name if it's an empty string.
+	 */
+	title: string;
 }
 
 /**
@@ -135,7 +145,10 @@ export const parsePageMeta = (fileList: Record<string, unknown>,
 					console.warn(`Accessibility issues: image alt missing for image ${meta.imageUrl}`);
 				}
 			}
+		}
 
+		if (meta.shouldHide) {
+			continue;
 		}
 
 		pageFlatList.push(meta);
@@ -154,7 +167,45 @@ export const parsePageMeta = (fileList: Record<string, unknown>,
 
 	if (compareFn) {
 		pageFlatList.sort(compareFn);
+	} else {
+		pageFlatList.sort(DefaultPageMetaSorter);
 	}
 
 	return pageFlatList;
+};
+
+const AWins = -1;
+const BWins = 1;
+
+/**
+ * Prioritizes, in order, lastUpdated, datePublished, has description, then title
+ *
+ * @param a
+ * @param b
+ * @constructor
+ */
+export const DefaultPageMetaSorter: ParsePageMetaCompareFn = (a, b) => {
+	if (a.lastUpdated && !b.lastUpdated) {
+		return AWins;
+	} else if (!a.lastUpdated && b.lastUpdated) {
+		return BWins;
+	} else if (a.lastUpdated && b.lastUpdated) {
+		return a.lastUpdated.localeCompare(b.lastUpdated);
+	}
+
+	if (a.datePublished && !b.datePublished) {
+		return AWins;
+	} else if (!a.lastUpdated && b.datePublished) {
+		return BWins;
+	} else if (a.datePublished && b.datePublished) {
+		return a.datePublished.localeCompare(b.datePublished);
+	}
+
+	if (a.description && !b.description) {
+		return AWins;
+	} else if (!a.description && b.description) {
+		return BWins;
+	}
+
+	return a.title.localeCompare(b.title);
 };

package/src/routes/(pineapple)/pineapple/(extra-pages)/page1/meta.json

@@ -1,5 +1,14 @@
 {
-  "title": "Custom title for page 1",
-  "imageUrl": "/favicon.png",
-  "tags": ["random"]
+  "datePublished": "23-01-01",
+  "description": "random description but look at Ares!",
+  "imageAlt": "Image of Ares being excited",
+  "imageID": "testImageID",
+  "imageURL": "./favicon.png/?q=imageIDTakesPrecedence",
+  "lastUpdated": "23-02-02",
+  "shouldGroup": false,
+  "shouldHide": false,
+  "tags": [
+    "random"
+  ],
+  "title": "Custom title for page 1!!!"
 }

package/src/routes/(pineapple)/pineapple/(extra-pages)/page2/meta.json

@@ -1,5 +1,8 @@
 {
-  "title": "Custom title for page 2!!!",
-  "imageID": "testImageID",
-  "tags": ["random"]
+  "lastUpdated": "2024-03-03",
+  "title": "Custom title for page 2",
+  "imageUrl": "/favicon.png",
+  "tags": [
+    "random"
+  ]
 }