@turnipxenon/pineapple 2.4.13 → 2.4.15

package/src/lib/components/dialog_manager/DialogManager.ts

@@ -6,7 +6,7 @@ import { writable } from "svelte/store";
 import type { DialogDetail } from "$pkg/types/pineapple_fiber/DialogDetail";
 import { DialogState } from "$pkg/types/pineapple_fiber/DialogState";
 import { tweened } from "svelte/motion";
-import { cubicOut } from "svelte/easing";
+import { backOut } from "svelte/easing";
 import { PortraitType } from "$pkg/types/pineapple_fiber/PortraitType";
 import AresHappy from "$pkg/assets/characters/ares/ares_happy.webp";
 import AresBlushing from "$pkg/assets/characters/ares/ares_blushing.webp";
@@ -24,6 +24,7 @@ import {
 	updateRate
 } from "$pkg/components/dialog_manager/DialogManagerStore";
 import { DialogProcessor } from "$pkg/components/dialog_manager/DialogProcessor";
+import { parseYarn } from "$pkg/scripts/pineapple_fiber/PineappleFiberParser";
 
 const shouldDebugYarn = false;
 
@@ -31,7 +32,7 @@ export type OnSetDialogChoiceCallback = (newMessage: DialogDetail) => void;
 
 export class DialogManager {
 	dialogMessageMap: Map<string, DialogDetail> = new Map();
-	dialogMessageList: DialogDetail[] = [];
+	currentDialogTree: DialogDetail[] = [];
 	fullCurrentMessage: string = defaultDialogMessage[0].textContent;
 	currentMessageMeta: DialogDetail = defaultDialogMessage[0];
 	currentMessage = writable("");
@@ -41,9 +42,10 @@ export class DialogManager {
 	currentPortrait = writable();
 	portraitMap: Map<string, any> = new Map();
 	currentState = DialogState.Visible;
+	currentReadableState = writable(this.currentState);
 	hidePercent = tweened(100, {
 		duration: 400,
-		easing: cubicOut
+		easing: backOut
 	}); // 100 = 100%
 	skipNextActiveTime = 0;
 	dialogProcessor = new DialogProcessor();
@@ -51,16 +53,23 @@ export class DialogManager {
 	_setDialogChoiceQueue: DialogDetail[] = [];
 	_setDialogChoiceMutex = false;
 	onSetDialogListeners: OnSetDialogChoiceCallback[] = [];
+	enableDialogueOverlayCache = false;
 
 	constructor() {
 		enableDialogueOverlay.subscribe((value) => {
 			// todo: investigate why we cant put setDialogDefault inside the then clause
 			// ISSUE #82 https://github.com/TurnipXenon/pineapple/issues/82
+			this.enableDialogueOverlayCache = value;
 			if (value) {
-				this.hidePercent.set(0);
-				this.setDialogToDefault();
+				this.hidePercent.set(0).then(() => {
+					this.currentState = DialogState.Visible;
+					this.currentReadableState.set(this.currentState);
+				});
 			} else {
-				this.hidePercent.set(100);
+				this.hidePercent.set(100).then(() => {
+					this.currentState = DialogState.Invisible;
+					this.currentReadableState.set(this.currentState);
+				});
 				this.setDialogTree([{ textContent: "" }]);
 			}
 		});
@@ -93,13 +102,13 @@ export class DialogManager {
 	 * sets the possible dialog that might appear on the Dialog UI
 	 * note that it overwrites the previous tree and does not append on it due to the possibility
 	 * of node name conflicts
-	 * @param newMessageList
+	 * @param newDialogTree
 	 */
-	setDialogTree = (newMessageList: DialogDetail[]) => {
-		this.dialogMessageList = newMessageList;
+	setDialogTree = (newDialogTree: DialogDetail[]) => {
+		this.currentDialogTree = newDialogTree;
 
 		this.dialogMessageMap.clear();
-		newMessageList.map((value) => {
+		newDialogTree.map((value) => {
 			if (value.dialogId) {
 				this.dialogMessageMap.set(value.dialogId!, value);
 			}
@@ -118,7 +127,7 @@ export class DialogManager {
 			this.portraitMap.set(PortraitType.AresYay.toString(), AresYay);
 		}
 
-		this.setDialogChoice(newMessageList[0]);
+		this.setDialogChoice(newDialogTree[0]);
 	};
 
 	/**
@@ -265,7 +274,7 @@ export class DialogManager {
 		while (
 			this.fullCurrentMessage[this.currentIndex] == "<" &&
 			this.currentIndex + 1 < this.fullCurrentMessage.length
-		) {
+			) {
 			// find valid character, trap with closing
 			this.currentIndex = this.fullCurrentMessage.indexOf(">", this.currentIndex) + 1;
 			// normalize
@@ -279,4 +288,21 @@ export class DialogManager {
 
 		window.requestAnimationFrame(this.update);
 	};
+
+	enableDialogOverlay(enable: boolean) {
+		enableDialogueOverlay.set(enable);
+	}
+
+	toggleDialogOverlay() {
+		enableDialogueOverlay.set(!this.enableDialogueOverlayCache);
+	};
+
+	async parseAndSetDialogTree(dialogYarn: string): Promise<DialogDetail[]> {
+		return parseYarn(dialogYarn)
+			.then((dialogTree) => {
+				console.log(dialogTree);
+				this.setDialogTree(dialogTree);
+				return dialogTree;
+			});
+	}
 }

package/src/lib/components/dialog_manager/DialogManagerStore.ts

@@ -32,7 +32,7 @@ export const updateRate: number = 40 / 1000; // *at least* 40ms per letter
 // todo: if we go through doing yarn to typescript, move this!
 export const defaultDialogMessage: DialogDetail[] = [
 	{
-		textContent: `<p>Have you drank water? Or perhaps, you've checked out <a target="_blank" class="external-link" href="http://crouton.net">one of the best webpages</a> out there?`
+		textContent: `<p>I don't really have anything to say. Have you drank water? Or perhaps, you've checked out <a target="_blank" class="external-link" href="http://crouton.net">one of the best webpages</a> out there?`
 	}
 ];
 

package/src/lib/components/layouts/SeaweedBaseLayout.svelte

@@ -66,8 +66,8 @@
 
 <style lang="postcss">
     :root {
-        --dialog-left-pad: clamp(0em, 5vw, 2em);
-        --dialog-box-width: min(calc(50em + 4em), calc(100vw - var(--dialog-left-pad) - var(--theme-border-base)));
+        --dialog-start-pad: clamp(0em, 5vw, 2em);
+        --dialog-box-width: min(calc(50em + 4em), calc(100vw - var(--dialog-start-pad) - var(--theme-border-base)));
         --dialog-box-height: clamp(15em, 50vw, 18em);
     }
 

package/src/lib/components/pineapple/PineappleBaseLayout.svelte

@@ -0,0 +1,220 @@
+<script lang="ts">
+	// For auto dark/light mode
+	import { AppBar, AppShell, autoModeWatcher, LightSwitch } from "@skeletonlabs/skeleton";
+	import RandomizedBackground from "$pkg/components/RandomizedBackground.svelte";
+
+	// navigation
+	import { page } from "$app/stores";
+	// store
+	import { enableBackground } from "$pkg/store";
+	import type { BreadcrumbData } from "$pkg/types/BreadcrumbData";
+	// assets
+	// import DialogOverlay from "$lib/components/DialogOverlay.svelte";
+	import AresLogo from "$pkg/assets/characters/ares/ares_logo.webp";
+	import FABIcon from "$pkg/assets/placeholder/placeholder_circle.png";
+	import CloseIcon from "$pkg/assets/icons/close.svg";
+	import { dialogManager, enableDialogueOverlay } from "$pkg/components/dialog_manager/DialogManagerStore";
+	import Toast from "$pkg/components/pineapple/toast/Toast.svelte";
+	import DialogOverlay from "$pkg/components/DialogOverlay.svelte";
+	// todo: clean up all these imports!
+
+	let pages: BreadcrumbData[] = [];
+
+	const updateBreadcrumb = (pathname: string) => {
+		pages = [];
+		let basePath = "";
+		pathname.split("/").forEach((value, index) => {
+			if (index === 0) {
+				basePath = "/";
+				pages.push({
+					path: "/",
+					name: "Home"
+				});
+				return;
+			}
+
+			if (value === "") {
+				return;
+			}
+
+			basePath += value + "/";
+			pages.push({
+				path: basePath,
+				name: value
+			});
+		});
+		pages = pages;
+	};
+
+	$: updateBreadcrumb($page.url.pathname); // run every time we navigate
+
+	let enableBackgroundValue = true;
+	enableBackground.subscribe((value) => {
+		enableBackgroundValue = value;
+	});
+
+	let enableDialogueOverlayValue = true;
+	enableDialogueOverlay.subscribe((value) => {
+		enableDialogueOverlayValue = value;
+	});
+
+	enableDialogueOverlay.set(false);
+</script>
+
+<!-- App Shell -->
+<svelte:head>
+	{@html `<script>${autoModeWatcher.toString()} autoModeWatcher();</script>`}
+</svelte:head>
+
+<!--todo: turn off hidden when it's time-->
+<button type="button" class="fab" on:click={()=>{
+	dialogManager.toggleDialogOverlay()
+}}>
+	{#if (enableDialogueOverlayValue)}
+		<img class="img-icon" src={CloseIcon} alt="interactive floating action button represented as a turnip">
+	{:else }
+		<img src={FABIcon} alt="interactive floating action button represented as a turnip">
+	{/if}
+</button>
+
+<AppShell>
+	<svelte:fragment slot="header">
+		<!-- App Bar -->
+		<AppBar
+			background="app-shell-token"
+			slotDefault="place-content-start"
+			slotTrail="place-content-end">
+			<svelte:fragment slot="lead">
+				<!--TODO: add logo or something for the lead in layout-->
+				<img
+					alt="Ares's head titled towards the left with his tongue out and winking"
+					class="ares-logo"
+					src={AresLogo}
+				/>
+				<span class="mr-2" />
+				<ol class="breadcrumb">
+					{#each pages as crumb, i}
+						{#if i < pages.length - 1}
+							<li class="crumb">
+								<a href={crumb.path}>{crumb.name.charAt(0).toUpperCase() + crumb.name.slice(1)}</a>
+							</li>
+							<li class="crumb-separator" aria-hidden="true">&rsaquo;</li>
+						{:else}
+							<li class="crumb">{crumb.name.charAt(0).toUpperCase() + crumb.name.slice(1)}</li>
+						{/if}
+					{/each}
+				</ol>
+			</svelte:fragment>
+			<svelte:fragment slot="trail">
+				<LightSwitch bgLight="bg-surface-400" />
+			</svelte:fragment>
+		</AppBar>
+	</svelte:fragment>
+
+	<RandomizedBackground enable={enableBackgroundValue} />
+
+	<Toast></Toast>
+
+	<DialogOverlay></DialogOverlay>
+
+	<div class="default-page-container">
+		<slot />
+		<div class="footer-space" />
+	</div>
+	<!--{#if enableDialogueOverlayValue}-->
+	<!--	&lt;!&ndash; Page Route Content &ndash;&gt;-->
+	<!--	<div class="default-page-container">-->
+	<!--		<slot />-->
+	<!--		<div class="footer-space" />-->
+	<!--	</div>-->
+	<!--	<DialogOverlay />-->
+	<!--{:else}-->
+	<!--	<DialogOverlay />-->
+	<!--	<slot />-->
+	<!--{/if}-->
+</AppShell>
+
+<style lang="postcss">
+    :root {
+        --dialog-start-pad: clamp(0em, 5vw, 2em);
+        --dialog-box-width: min(calc(50em + 4em), calc(100vw - var(--dialog-start-pad) - var(--theme-border-base)));
+        --dialog-box-height: clamp(15em, 50vw, 18em);
+
+        /** FAB icon margin/position calculation origin:
+						Criteria:
+						- We want at mobile (360px) our margin to be at 1em (16px)
+						- We want at web (1960px) our margin to be at 2em (32px)
+
+						A useful scaling factor might vw. At 360px, 16px would be around 4.44vw (360/16).
+						At 360px: margin is at 16px or 1em.
+						At 1960px: 4.44vw is at 87px but that will be clamped to 32px or 2em.
+						The calculation implies that the natural point that the margin becomes 2em is clamped on
+						wider screens is at 727px.
+				*/
+        --fab-margin: clamp(1em, 4.44vw, 2em);
+    }
+
+    .default-page-container {
+        @apply flex justify-center items-center;
+        margin-top: 4em;
+        margin-right: 1em;
+        flex-direction: column;
+        z-index: 0;
+    }
+
+    .ares-logo {
+        object-fit: contain;
+        height: 2em;
+        margin-inline-end: 0.5em;
+    }
+
+    /* breadcrumb does not work due to a lot of magic stuff i do
+       the code below is from skeleton's tailwind css:
+       https://github.com/skeletonlabs/skeleton/blob/54f4ecedabf2be6d94a670b56dc8821095ca3fc9/packages/plugin/src/styles/components/breadcrumbs.css
+
+       it likely disappeared due to code gen shenanigans and package magic */
+    .breadcrumb,
+    .breadcrumb-nonresponsive {
+        @apply flex items-center space-x-4 w-full overflow-x-auto;
+        /*@apply flex items-center space-x-4 w-full hide-scrollbar overflow-x-auto;*/
+    }
+
+    .crumb {
+        @apply flex justify-center items-center space-x-2;
+    }
+
+    .crumb-separator {
+        @apply flex text-surface-700-200-token opacity-50;
+    }
+
+    /* === Auto-Responsive === */
+
+    .breadcrumb li {
+        @apply hidden md:block;
+    }
+
+    .breadcrumb li:nth-last-child(3),
+    .breadcrumb li:nth-last-child(2),
+    .breadcrumb li:nth-last-child(1) {
+        @apply block;
+    }
+
+    .fab {
+        position: fixed;
+        bottom: var(--fab-margin);
+        width: 4em;
+        border-radius: 50%;
+    }
+
+    .fab > img {
+        width: 100%;
+    }
+
+    .fab:dir(ltr) {
+        right: var(--fab-margin);
+    }
+
+    .fab:dir(rtl) {
+        left: var(--fab-margin);
+    }
+</style>

package/src/lib/components/pineapple/toast/DefaultToastBody.svelte

@@ -0,0 +1,43 @@
+<script lang="ts">
+	import type { Props } from "$pkg/components/pineapple/toast/DefaultToastBody";
+	import type { DismissToastCallback } from "$pkg/components/pineapple/toast/Toast";
+	import CloseIcon from "$pkg/assets/icons/close.svg";
+
+	export let props: Props;
+	export let dismissToastCallback: DismissToastCallback | undefined;
+	export let shouldEnableButton = false;
+</script>
+
+<div class="body-container">
+	<!-- todo: support markdown? -->
+	<button class="btn"
+	        disabled={!shouldEnableButton}
+	        on:click={dismissToastCallback}>
+		<img class="img-icon" src={CloseIcon} alt="close button">
+	</button>
+	<div class="text-container">
+		<span>{props.message}</span>
+	</div>
+</div>
+
+<style lang="postcss">
+    .body-container {
+        display: flex;
+        gap: 1em;
+    }
+
+    .text-container {
+        margin-top: 0.25lh;
+        margin-right: 1em;
+    }
+
+    .text-container:dir(rtl) {
+        margin-left: 1em;
+    }
+
+    .btn {
+        @apply bg-surface-100 dark:bg-surface-900;
+        border-radius: 8px;
+		    padding: 0.5em;
+    }
+</style>

package/src/lib/components/pineapple/toast/DefaultToastBody.ts

@@ -0,0 +1,10 @@
+import DefaultToastBody from "./DefaultToastBody.svelte";
+
+export interface Props {
+	message: string;
+}
+
+export interface DefaultToastPair {
+	component: typeof DefaultToastBody;
+	props: Props;
+}

package/src/lib/components/pineapple/toast/Toast.svelte

@@ -0,0 +1,114 @@
+<script lang="ts">
+	import {
+		activeToast,
+		type CustomToastPairs,
+		DefaultToastParamsDuration,
+		toastQueue
+	} from "$pkg/components/pineapple/toast/Toast";
+	import { type ComponentType } from "svelte";
+	import Card from "$pkg/components/Card.svelte";
+	import { spring, tweened } from "svelte/motion";
+
+	let localComponent: ComponentType | undefined;
+	let localProps: CustomToastPairs["props"];
+
+	// todo: make hidden value reliant on current vh
+	const HIDDEN_VALUE = -15;
+	const SHOWN_VALUE = 0;
+	const progress = tweened(0, { duration: DefaultToastParamsDuration });
+	const position = spring(HIDDEN_VALUE);
+	position.damping = 0.4;
+	let isDismissed = false;
+	let shouldEnableButton = false;
+
+	const onToastDisappear = () => {
+		// clear the local component to undefined to make the component disappear
+		// also set activeToast to null to indicate to the system that it's ready to take new
+		// Toast requests
+		localComponent = undefined;
+		activeToast.update(() => {
+			if (toastQueue.length === 0) {
+				return undefined;
+			}
+			return toastQueue.shift();
+		});
+	};
+
+	activeToast.subscribe((params) => {
+		if (!params) {
+			return;
+		}
+
+		if (params.componentAndProps?.component === localComponent) {
+			return;
+		}
+
+		localComponent = params.componentAndProps.component;
+		localProps = params.componentAndProps.props;
+
+		// todo: make unnested
+		// set progress to 0 before showing
+		progress.set(0, { duration: 0 }).then(() => {
+			// animate showing the toast
+			position.set(SHOWN_VALUE).then(() => {
+				shouldEnableButton = true;
+
+				// now animate the lifespan of the current toast
+				progress.set(100, { delay: 500, duration: params.duration ?? DefaultToastParamsDuration }).then(() => {
+					// during the lifecycle the button to cause dismissal can only happen when
+					// position is completely set SHOWN_VALUE and when progress has reached to 100
+					shouldEnableButton = false;
+					if (isDismissed) {
+						return;
+					}
+
+					// when the lifespan duration is over, animate hiding the toast by putting its bottom
+					// position out of bounds
+					position.set(HIDDEN_VALUE).then(onToastDisappear);
+				});
+			});
+		});
+	});
+
+	const dismissToast = () => {
+		shouldEnableButton = false;
+		isDismissed = true;
+		position.set(HIDDEN_VALUE).then(onToastDisappear);
+	};
+</script>
+
+{#if (localComponent !== undefined)}
+	<div class="toast-positioner" style={`bottom: ${$position}lh;`}>
+		<!-- todo: adjust shadow to be more dynamic or transparent -->
+		<Card marginBottom="1lh" overrideStyle="box-shadow: 3px 3px 3px var(--shadow-color);">
+			<div slot="content">
+				{#if (localProps !== undefined)}
+					<svelte:component this={localComponent}
+					                  props={localProps}
+					                  dismissToastCallback={dismissToast}
+					                  shouldEnableButton={shouldEnableButton} />
+				{:else }
+					<svelte:component this={localComponent} />
+				{/if}
+				<progress id="toast-progress" value={$progress/100}></progress>
+			</div>
+		</Card>
+	</div>
+{/if}
+
+<style lang="postcss">
+    .toast-positioner {
+        position: fixed;
+        /* 12em = this component's margin (4em) + fab margin + width (8em) */
+        max-width: calc(100vw - 12em);
+		    z-index: 100;
+    }
+
+    .toast-positioner:dir(ltr) {
+        left: 2em;
+    }
+
+    .toast-positioner:dir(rtl) {
+        right: 2em;
+    }
+</style>

package/src/lib/components/pineapple/toast/Toast.ts

@@ -0,0 +1,57 @@
+import { writable } from "svelte/store";
+import type { DefaultToastPair } from "$pkg/components/pineapple/toast/DefaultToastBody";
+import DefaultToastBody from "$pkg/components/pineapple/toast/DefaultToastBody.svelte";
+import type { TestCustomToastPair } from "$pkg/components/pineapple/toast/custom-toast/TestCustomToast";
+
+/**
+ * Default toast duration is 5 seconds
+ */
+export const DefaultToastParamsDuration = 5000;
+
+export type CustomToastPairs = DefaultToastPair
+	| TestCustomToastPair;
+
+export type DismissToastCallback = () => void;
+
+// todo: note may not be possible
+export interface ToastParams {
+	componentAndProps: CustomToastPairs;
+	/**
+	 * Time in millisecond. If undefined, defaults to DefaultToastParamsDuration
+	 */
+	duration?: number;
+}
+
+/**
+ * todo: do not call directly documentation
+ */
+export const activeToast = writable<ToastParams | undefined>();
+
+export const toastQueue: ToastParams[] = [];
+
+/**
+ *
+ * @param newToast
+ */
+export const showComponentInToast = (newToast: ToastParams) => {
+	// todo: queue component
+	activeToast.update((currentToast) => {
+		if (currentToast !== undefined) {
+			toastQueue.push(newToast);
+			return currentToast;
+		} else {
+			return newToast;
+		}
+	});
+};
+
+export const showTextInToast = (message: string) => {
+	showComponentInToast({
+		componentAndProps: {
+			component: DefaultToastBody,
+			props: {
+				message
+			}
+		}
+	});
+};

package/src/lib/components/pineapple/toast/custom-toast/TestCustomToast.svelte

@@ -0,0 +1 @@
+<h1>Testing bad custom card</h1>

package/src/lib/components/pineapple/toast/custom-toast/TestCustomToast.ts

@@ -0,0 +1,6 @@
+import TestCustomToast from "./TestCustomToast.svelte";
+
+export interface TestCustomToastPair {
+	component: typeof TestCustomToast;
+	props: undefined;
+}

package/src/lib/index.ts

@@ -1,4 +1,4 @@
-export { default as PineappleLayoutBase } from "./components/layouts/PineappleBaseLayout.svelte";
+export { default as PineappleLayoutBase } from "./components/pineapple/PineappleBaseLayout.svelte";
 export { default as SeaweedTemplate } from "./template/SeaweedTemplate.svelte";
 export { default as LazyAsset } from "./components/LazyAsset.svelte";