@turnipxenon/pineapple 2.9.0 → 2.10.0

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

@@ -1,116 +0,0 @@
-<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"
-		      turnOnLightModeBorder={false}
-		      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

@@ -1,57 +0,0 @@
-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

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

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

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

package/src/lib/consts.ts

@@ -1,2 +0,0 @@
-export const ItchBadgeHotLink = "https://static.itch.io/images/badge.svg";
-export const ItchLogoHotLink = "https://static.itch.io/images/itchio-textless-black.svg";

package/src/lib/index.ts

@@ -1,16 +0,0 @@
-// noinspection JSUnusedGlobalSymbols
-
-export { default as PineappleLayoutBase } from "./components/pineapple/PineappleBaseLayout.svelte";
-
-export * from "./components/index";
-export * from "$pkg/components/overrideable_meta/index";
-export * from "$pkg/components/navigation_component/index";
-export * from "$pkg/types/api/index";
-export * from "./components/dialog_manager/DialogManagerStore";
-export * from "./components/dialog_manager/DialogManager";
-export * from "./components/dialog_manager/DialogUtils";
-export * from "./types/pineapple_fiber/PortraitType";
-export * from "./types/pineapple_fiber/DialogDetail";
-export * from "./util/util";
-export * from "./api/index";
-export * from "./template/seaweed/index";

package/src/lib/postcss.d.ts

@@ -1,3 +0,0 @@
-// from https://stackoverflow.com/a/63885623/17836168
-declare module "./app.postcss";
-declare module "./theme.postcss";

package/src/lib/scripts/pineapple_fiber/PineappleFiberParser.ts

@@ -1,177 +0,0 @@
-import type { DialogDetail } from "$pkg/types/pineapple_fiber/DialogDetail";
-import { PortraitType } from "$pkg/types/pineapple_fiber/PortraitType";
-
-interface ChoiceDetail {
-	name: string;
-	jumpNode: string;
-}
-
-const shouldDebug = false;
-
-export const parseYarn = async (fileContent: string): Promise<DialogDetail[]> => {
-	const dialogDetailList: DialogDetail[] = [];
-
-	fileContent.split("===").map((unparsedNode) => {
-		// todo: detect empty nodes
-		// todo: improve the code readability
-		if (unparsedNode.trim() === "") {
-			return;
-		}
-
-		const dialogDetails: DialogDetail = {
-			// todo: dissect the line below and give comments because it is complex
-			dialogId: unparsedNode
-				.slice(unparsedNode.indexOf("title: "))
-				.split("\n")[0]
-				.split(" ")
-				.pop()
-				?.trim(),
-			portraitType: PortraitType.AresNeutral,
-			textContent: "" // will be filled later below
-		};
-		let portraitUnset = true;
-
-		// parse the PineappleFiber metatags
-		const unparsedBody = unparsedNode.split("---").pop()!.trim();
-		const bodyList = unparsedBody.split("\n");
-		let contentIndexStart = 0;
-		for (let index = 0; index < bodyList.length; index++) {
-			const possibleTagPair = bodyList[index].split(": ");
-			const possibleTagName = possibleTagPair[0].toLowerCase();
-
-			if (!["portrait"].includes(possibleTagName)) {
-				break;
-			}
-
-			contentIndexStart = index + 1; // increase count for each viable tah
-			switch (possibleTagName) {
-				case "portrait":
-					portraitUnset = false;
-					// todo: implement a way to match the appropriate portrait based on the metatag
-					// from https://stackoverflow.com/a/17381004/17836168
-					dialogDetails.portraitType =
-						PortraitType[possibleTagPair[1].trim() as keyof typeof PortraitType];
-					if (shouldDebug) {
-						console.log(
-							"Portrait detected:",
-							possibleTagPair[1],
-							" => ",
-							dialogDetails.portraitType
-						);
-					}
-					break;
-			}
-		}
-
-		// portrait check
-		if (portraitUnset) {
-			console.warn(`Portrait missing for node: ${dialogDetails.dialogId}`);
-			dialogDetails.portraitType = PortraitType.AresNeutral;
-		}
-
-		// remove the metatags from the body
-		const unprocessedContent = bodyList.slice(contentIndexStart).join("\n");
-		const contentPair = unprocessedContent.split("<ChoiceBreak>");
-
-		if (contentPair.length === 2) {
-			// parse for the choice names in the options
-			enum ChoiceParsingState {
-				Free, // detects for the next option
-				Line // previously detected an option, will try to detect for the next option
-			}
-
-			let parsingState: ChoiceParsingState = ChoiceParsingState.Free;
-			const currentChoiceDetail: ChoiceDetail = { jumpNode: "", name: "" };
-			const choiceList: ChoiceDetail[] = [];
-			let shouldSkipChoices = false;
-
-			const checkChoiceForSave = () => {
-				if (currentChoiceDetail.name !== "") {
-					choiceList.push({
-						name: currentChoiceDetail.name,
-						jumpNode: currentChoiceDetail.jumpNode
-					});
-				}
-			};
-
-			contentPair[1]
-				.trim()
-				.split("\n")
-				.filter((line) => {
-					const trimmedLine = line.trim();
-					if (shouldSkipChoices) {
-						return false;
-					}
-
-					if (trimmedLine.startsWith("// ignore the rest")) {
-						shouldSkipChoices = true;
-						return false;
-					}
-
-					return true;
-				})
-				.map((line) => {
-					const trimmedLine = line.trim();
-
-					switch (parsingState) {
-						case ChoiceParsingState.Free:
-							if (trimmedLine.startsWith("->")) {
-								// save previous choice
-								checkChoiceForSave();
-
-								// write start of new choice
-								currentChoiceDetail.name = trimmedLine.split(" ").pop()!;
-								parsingState = ChoiceParsingState.Line;
-							}
-							break;
-
-						case ChoiceParsingState.Line:
-							if (trimmedLine.startsWith("<<jump")) {
-								const jumpNode = trimmedLine.split(" ").pop()!;
-								currentChoiceDetail.jumpNode = jumpNode.slice(0, jumpNode.length - 2); // remove ">>"
-								parsingState = ChoiceParsingState.Free;
-							}
-							break;
-
-						default:
-							console.error(`Unimplemented parsing state: ${parsingState}`);
-							break;
-					}
-				});
-			checkChoiceForSave();
-
-			dialogDetails.textContent = contentPair[0];
-
-			// handle choice start tags to a href
-			choiceList.forEach((choiceDetail) => {
-				const keyword = `<choice ${choiceDetail.name}>`;
-				while (dialogDetails.textContent.includes(keyword)) {
-					dialogDetails.textContent = dialogDetails.textContent.replace(
-						keyword,
-						`<a class="choice-${choiceDetail.jumpNode} dialog-choice" title="Click to continue the dialog">`
-					);
-				}
-			});
-
-			const externalKeyword = "<a href=";
-			while (dialogDetails.textContent.includes(externalKeyword)) {
-				dialogDetails.textContent = dialogDetails.textContent.replace(
-					externalKeyword,
-					"<a target=\"_blank\" class=\"external-link\" href="
-				); // make all external tags with a custom cursor
-			}
-
-			const choiceEndKeyword = "</choice>";
-			while (dialogDetails.textContent.includes(choiceEndKeyword)) {
-				dialogDetails.textContent = dialogDetails.textContent.replace(choiceEndKeyword, "</a>"); // convert all choice end tags to a tags
-			}
-		} else {
-			// assume only one which indicates it is choiceless
-			dialogDetails.textContent = unprocessedContent;
-		}
-
-		dialogDetailList.push(dialogDetails);
-	});
-
-	return dialogDetailList;
-};

package/src/lib/scripts/pineapple_fiber/PineappleWeaver.ts

@@ -1,79 +0,0 @@
-/**
- * Pineapple Fiber
- *
- * A script that generates Typescript files from Yarn where the choices are embedded on
- * the dialogue itself
- *
- * npx vite-node src/lib/scripts/pineapple_fiber/PineappleWeaver.ts
- */
-
-import { getAllFiles } from "$pkg/scripts/util/FileManagement";
-import fs, { readFileSync } from "fs";
-import type { DialogDetail } from "$pkg/types/pineapple_fiber/DialogDetail";
-import { PortraitType } from "$pkg/types/pineapple_fiber/PortraitType";
-import { parseYarn } from "$pkg/scripts/pineapple_fiber/PineappleFiberParser";
-
-const pineappleWeaverRun = () => {
-	console.info("Starting Pineapple Weaver.");
-	const BASE_PATH = "./src/routes";
-	getAllFiles(BASE_PATH, (path: string): boolean => {
-		return path.split(".").pop() === "yarn";
-	}).map(async (filePath) => {
-		console.info(`Converting: ${filePath}`);
-		const fileContent = readFileSync(filePath, "utf-8");
-		const dialogDetailList: DialogDetail[] = await parseYarn(fileContent);
-
-		const dialogDetailToString = (detail: DialogDetail): string => {
-			if (detail.portraitType === undefined) {
-				detail.portraitType = PortraitType.AresNeutral;
-				console.error(`Missing portrait at dialog: ${detail.dialogId}`);
-				console.error(`It contains: ${detail.textContent}`);
-			}
-			return `		{
-			dialogId: "${detail.dialogId}",
-			portraitType: PortraitType.${detail.portraitType.toString()},
-			textContent: \`${detail.textContent}\`
-		},`;
-		};
-
-		const dialogDetailListToString = (detailList: DialogDetail[]): string => {
-			return detailList
-				.map((detail) => {
-					return dialogDetailToString(detail);
-				})
-				.join("\n");
-		};
-
-		// generate file
-		const filePathList = filePath.split(".");
-		const fileName = filePathList[filePathList.length - 2].split("/").pop();
-		const template = `// this file was generated by PineappleWeaver.ts
-// do not edit!
-			
-import type { DialogDetail } from "@turnipxenon/pineapple";
-import { dialogManager, PortraitType } from "@turnipxenon/pineapple";
-
-class _${fileName}Yarn {
-	dialogList: DialogDetail[] = [
-${dialogDetailListToString(dialogDetailList)}
-	];
-	
-	/* Remember to call DialogManager.subscribeToSetDialogChoice before calling this in Svelte */
-	setDialogTree = () => {
-		dialogManager.setDialogTree(this.dialogList);
-	};
-}
-
-export const ${fileName}Yarn = new _${fileName}Yarn();
-`;
-
-		const filePathSplit = filePath.split(".");
-		filePathSplit.pop();
-		const generatedPath = `${filePathSplit.join(".")}Yarn.ts`;
-		fs.writeFileSync(generatedPath, template);
-	});
-
-	console.info("Finish converting all yarn files!");
-};
-
-pineappleWeaverRun();

package/src/lib/scripts/util/FileManagement.ts

@@ -1,38 +0,0 @@
-import fs from "fs";
-
-// from https://stackoverflow.com/a/26832802
-export const getDirectories = (path: string): string[] => {
-	return fs
-		.readdirSync(path)
-		.filter(function (file) {
-			return fs.statSync(path + "/" + file).isDirectory();
-		})
-		.map((value: string) => {
-			return path + "/" + value;
-		});
-};
-
-/**
- * Get all files underneath a path. The results can be filtered!
- * @param path: path where to start finding all files underneath
- * @param filter?: optional path filter
- */
-export const getAllFiles = (path: string, filter?: (path: string) => boolean): string[] => {
-	const contentList = fs.readdirSync(path);
-	const fileList: string[] = [];
-
-	contentList.forEach((content) => {
-		const contentName = path + "/" + content;
-		const stat = fs.statSync(contentName);
-		if (stat.isDirectory()) {
-			fileList.push(...getAllFiles(contentName, filter));
-		} else {
-			// takes advantage of lazy evaluation
-			if (filter === undefined || filter(contentName)) {
-				fileList.push(contentName);
-			}
-		}
-	});
-
-	return fileList;
-};

package/src/lib/scripts/util/ManualCheck.ts

@@ -1,32 +0,0 @@
-import { getAllFiles } from "$lib/scripts/util/FileManagement";
-import { readFileSync } from "fs";
-
-/**
- * checks for manual dialog tree sets in all files except for *Yarn.ts and DialogManager.ts
- */
-const checkManualDialogSet = () => {
-	// todo:
-	const BASE_PATH = "./src/routes";
-	getAllFiles(BASE_PATH, (path: string): boolean => {
-		// from: https://stackoverflow.com/a/424006/17836168
-		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-		// @ts-ignore
-		const filename: string = path.split("\\").pop().split("/").pop();
-
-		const isNonYarn = !filename.endsWith("Yarn.ts");
-
-		// takes advantage of lazy evaluation
-		// is non-yarn and is not exempted
-		return isNonYarn && !["DialogManager.ts"].includes(filename);
-	}).map((filePath) => {
-		// todo:
-		const fileContent = readFileSync(filePath, "utf-8");
-		if (fileContent.includes("dialogManager.setDialogTree")) {
-			console.warn(`Warning! Manual dialog tree set found in path: ${filePath}`);
-		}
-	});
-};
-
-export const runAll = () => {
-	checkManualDialogSet();
-};

package/src/lib/scripts/util/ManualCheckRun.ts

@@ -1,7 +0,0 @@
-import { runAll } from "$lib/scripts/util/ManualCheck";
-
-/**
- * todo: Integrate manual check into CI check#137
- * ISSUE #137 https://github.com/TurnipXenon/pineapple/issues/137
- */
-runAll();

package/src/lib/server-temp/prisma.ts

@@ -1,3 +0,0 @@
-import { PrismaClient } from "@prisma/client";
-
-export const prismaClient = new PrismaClient();

package/src/lib/store.ts

@@ -1,18 +0,0 @@
-import { writable } from "svelte/store";
-
-/**
- * Enables background in main layout
- *
- * @example
- * When updating to false, remember to restore the value to true, our default value, onDestroy.
- * Avoid async to prevent weird flashes of updates!
- * ```
- * import {enableBackground} from "$lib/store.ts";
- * enableBackground.update(() => false);
- *
- * onDestroy(() => {
- *     enableBackground.update(() =>  true);
- * });
- * ```
- */
-export const enableBackground = writable(true);

package/src/lib/styles/DefaultGridContainer.css

@@ -1,61 +0,0 @@
-.default-grid-container-title-card {
-	max-width: calc(var(--default-card-max-width) + 32rem) !important;
-	width: 100%;
-	padding: 2rem !important;
-	text-align: center !important;
-}
-
-.default-grid-container {
-	width: 100%;
-	max-width: calc(var(--default-card-max-width) + 32rem);
-	padding-top: 4rem;
-	display: flex;
-	flex-wrap: wrap;
-	justify-content: center;
-	align-items: flex-start;
-}
-
-.default-grid-container > .card,
-.default-grid-container > .lite-wrapper {
-	width: 22rem;
-	margin: clamp(0vw, 1vw, 1.5rem);
-}
-
-.default-grid-container div h3 {
-	margin: 0.5em;
-	text-align: center;
-	font-weight: bold;
-}
-
-.default-grid-container video {
-	padding: var(--theme-border-base);
-}
-
-.default-grid-container img {
-	padding: var(--theme-border-base);
-	width: 100%;
-}
-
-.links {
-	width: 100%;
-	display: flex;
-	flex-wrap: wrap;
-	justify-content: center;
-	align-items: center;
-}
-
-.card.tx-badge {
-	object-fit: scale-down;
-	padding: 0.5rem;
-}
-
-img.tx-badge,
-.card.tx-badge {
-	max-height: 5rem;
-	max-width: 6rem;
-	margin: 1rem;
-}
-
-.twitter-wrapper {
-	padding: 1rem;
-}

package/src/lib/styles/global.css

@@ -1 +0,0 @@
-/* todo: delete if unneeded */