@catstral/levy-utils 1.0.0

package/dist/string/utils/parseUrlParams/index.d.ts

@@ -0,0 +1,4 @@
+export declare function parseUrlParams(url: string): Record<string, string | undefined>;
+export declare function parseUrlParams<const T extends Record<string, (value: string | undefined) => unknown>>(url: string, transform: T): {
+    [K in keyof T]: ReturnType<T[K]>;
+};

package/dist/string/utils/slug/index.d.ts

@@ -0,0 +1 @@
+export declare function slug(text: string): string;

package/dist/string/utils/textDifference/index.d.ts

@@ -0,0 +1,133 @@
+/**
+ * @typedef TextDifferenceOptionsNodes
+ * @prop {true} raw If raw nodes should be returned instead of a constructed string
+ * @prop {boolean} [htmlAware] If the difference should be HTML aware
+ */
+export type TextDifferenceOptionsNodes = {
+    /**
+     * If raw nodes should be returned instead of a constructed string
+     *
+     * @default false
+     */
+    raw: true;
+    /**
+     * If the difference should be HTML aware
+     *
+     * @default false
+     */
+    htmlAware?: boolean;
+};
+export type TextDifferenceTag = string | [string, string];
+/**
+ * @typedef TextDifferenceOptionsStringContextTags
+ * @prop {string | [string, string]} [equal] The tag(s) to wrap around nodes that are considered as equal
+ * @prop {string | [string, string]} [insert] The tag(s) to wrap around nodes that are considered as inserted/new
+ * @prop {string | [string, string]} [delete] The tag(s) to wrap around nodes that are considered as deleted/removed
+ */
+export type TextDifferenceOptionsStringTags = {
+    /**
+     * The tag(s) to wrap around nodes that are considered as equal.
+     *
+     * By default no tags are wrapped around equal nodes.
+     */
+    equal?: TextDifferenceTag;
+    /**
+     * The tag(s) to wrap around nodes that are considered as inserted/new.
+     */
+    insert?: TextDifferenceTag;
+    /**
+     * The tag(s) to wrap around nodes that are considered as deleted/removed.
+     */
+    delete?: TextDifferenceTag;
+};
+/**
+ * @typedef TextDifferenceOptionsStringContextTags
+ * @prop {TextDifferenceOptionsStringTags} [inlineContext] The tags to use when in a inline context for the diff
+ * @prop {TextDifferenceOptionsStringTags} [blockContext] The tags to use when in a block context for the diff
+ */
+export type TextDifferenceOptionsStringContextTags = {
+    /**
+     * The tags to use when in a inline context for the diff.
+     */
+    inlineContext?: TextDifferenceOptionsStringTags;
+    /**
+     * The tags to use when in a block context for the diff.
+     */
+    blockContext?: TextDifferenceOptionsStringTags;
+};
+/**
+ * @typedef TextDifferenceOptionsString
+ * @prop {false} [raw] If raw nodes should be returned instead of a constructed string
+ * @prop {boolean} [htmlAware] If the difference should be HTML aware
+ * @prop {TextDifferenceOptionsStringContextTags | TextDifferenceOptionsStringTags} [tags] The tags to wrap around the diff
+ */
+export type TextDifferenceOptionsString = {
+    /**
+     * If raw nodes should be returned instead of a constructed string
+     *
+     * @default false
+     */
+    raw?: false;
+} & ({
+    /**
+     * If the difference should be HTML aware
+     *
+     * @default false
+     */
+    htmlAware?: false;
+    /**
+     * The tags to use to mark the diff
+     */
+    tags?: TextDifferenceOptionsStringTags;
+} | {
+    /**
+     * If the difference should be HTML aware
+     *
+     * @default false
+     */
+    htmlAware: true;
+    /**
+     * The tags to use to mark the diff
+     */
+    tags?: TextDifferenceOptionsStringContextTags | TextDifferenceOptionsStringTags;
+});
+export type TextDifferenceNodeType = "EQUAL" | "INSERT" | "DELETE";
+export type TextDifferenceNodeContext = "INLINE" | "BLOCK" | "UNKNOWN";
+/**
+ * @typedef TextDifferenceNode
+ * @prop {"EQUAL" | "INSERT" | "DELETE"} type The operation type this node represents
+ * @prop {string} content The content this diff type applies for
+ * @prop {"INLINE" | "BLOCK" | "UNKNOWN"} context The HTML context this node is used in, this will always be `UNKNOWN` if `htmlAware` is not true
+ */
+export type TextDifferenceNode = {
+    /**
+     * The operation type this node represents.
+     */
+    type: TextDifferenceNodeType;
+    /**
+     * The content this diff type applies for.
+     */
+    content: string;
+    /**
+     * The HTML context this node is used in, this will always be `UNKNOWN` if `htmlAware` is not true.
+     */
+    context: TextDifferenceNodeContext;
+};
+/**
+ * Turns 2 strings into a constructed string, showing the difference using tags wrapped around changes.
+ *
+ * @param {string} oldValue A string representing what the text used to be
+ * @param {string} newValue A string representing what the text has turned into
+ * @param {TextDifferenceOptionsString} [options] Options to tweak the result (see {@link TextDifferenceOptionsString} for more details)
+ * @returns {string} A constructed string based on the difference between the 2 given strings
+ */
+export declare function textDifference(oldValue: string, newValue: string, options?: TextDifferenceOptionsString): string;
+/**
+ * Turns 2 strings into a list of difference nodes containing the info needed to be able to construct/view a difference of the 2.
+ *
+ * @param {string} oldValue A string representing what the text used to be
+ * @param {string} newValue A string representing what the text has turned into
+ * @param {TextDifferenceOptionsNodes} [options] Options to tweak the result (see {@link TextDifferenceOptionsNodes} for more details)
+ * @returns {TextDifferenceNode[]} A list of raw nodes that represent the difference between the 2 given strings (see {@link TextDifferenceNode} for more details)
+ */
+export declare function textDifference(oldValue: string, newValue: string, options?: TextDifferenceOptionsNodes): TextDifferenceNode[];

package/dist/types.d.ts

@@ -0,0 +1,3 @@
+export type Key = string | number | symbol;
+export type Falsy = false | 0 | 0n | "" | null | undefined;
+export type Promisable<T> = T | Promise<T>;

package/package.json

@@ -0,0 +1,63 @@
+{
+	"name": "@catstral/levy-utils",
+	"version": "1.0.0",
+	"description": "Re-useable and common JS/TS utility functions",
+	"license": "MIT",
+	"contributors": [
+		{
+			"email": "levyvandervalk@gmail.com",
+			"name": "Levy van der Valk"
+		},
+		{
+			"email": "levypondman@live.nl",
+			"name": "Levy Pondman"
+		}
+	],
+	"keywords": [
+		"javascript",
+		"typescript",
+		"util",
+		"utils",
+		"utility",
+		"utilities"
+	],
+	"type": "module",
+	"sideEffects": false,
+	"files": [
+		"dist"
+	],
+	"main": "dist/levyUtils.cjs",
+	"module": "dist/levyUtils.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		"types": "./dist/index.d.ts",
+		"import": "./dist/levyUtils.js",
+		"require": "./dist/levyUtils.cjs"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Catstral/levy-utils.git"
+	},
+	"scripts": {
+		"dev": "vite",
+		"compile": "tsc && bun test && vite build",
+		"preview": "vite preview",
+		"production": "bun compile && npm publish",
+		"tsc": "tsc --noEmit --diagnostics",
+		"lint": "biome check . --formatter-enabled=true",
+		"lint:apply": "biome check . --formatter-enabled=true --write",
+		"lint:apply:unsafe": "biome check . --formatter-enabled=true --write --unsafe",
+		"check": "bun tsc && bun lint"
+	},
+	"devDependencies": {
+		"@types/bun": "1.4.0",
+		"@biomejs/biome": "2.5.4",
+		"@types/diff-match-patch": "^1.0.36",
+		"typescript": "^7.0.0",
+		"vite": "^8.1.5",
+		"vite-plugin-dts": "^5.1.0"
+	},
+	"dependencies": {
+		"diff-match-patch": "^1.0.5"
+	}
+}