@verbb/plugin-kit-core 2.0.0

package/dist/utils/collections.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Collections utility for managing client-side collections of models
+ */
+/**
+ * Generates a unique client-side ID string
+ * @param {string} [prefix='client'] - Optional prefix for the generated ID
+ * @returns {string} A unique ID string in the format: prefix_timestamp_randomString
+ */
+export declare const generateId: (prefix?: string) => string;
+/**
+ * Normalize a collection by adding _id to each item that doesn't have one
+ * @param {Array} collection - Array of items
+ * @returns {Array} - Normalized collection with _id on each item
+ */
+export declare const normalizeCollection: (collection?: any[]) => any[];
+/**
+ * Create a new collection item
+ * @param {Object} itemData - Initial data for the new item
+ * @returns {Object} - The new item
+ */
+export declare const createItem: (itemData?: any) => any;
+/**
+ * Duplicate an existing item in a collection
+ * @param {Array} collection - Current collection
+ * @param {Object} item - Item to duplicate
+ * @param {Function} transformCallback - Optional callback to transform the duplicated item
+ * @returns {Object} - Updated collection with duplicated item
+ */
+export declare const duplicateItem: (collection: any[] | undefined, item: any, transformCallback?: ((item: any) => any) | null) => any[];
+/**
+ * Delete a item from a collection
+ * @param {Array} collection - Current collection
+ * @param {Object} item - Item to delete
+ * @returns {Object} - Updated collection without the deleted item
+ */
+export declare const deleteItem: (collection: any[] | undefined, itemToDelete: any) => any[];
+/**
+ * Update an item in a collection
+ * @param {Array} collection - Current collection
+ * @param {Object} item - Item to update
+ * @param {Object} updates - Updates to apply to the item
+ * @returns {Object} - Updated collection with updated item
+ */
+export declare const updateItem: (collection: any[] | undefined, itemToUpdate: any, updates: any) => any[];
+/**
+ * Move an item to a new position in a collection
+ * @param {Array} collection - Current collection
+ * @param {Object} fromItem - Item to move
+ * @param {Object} toItem - Item to move to (insert before this item)
+ * @returns {Array} - Updated collection with moved item
+ */
+export declare const moveItem: (collection: any[] | undefined, fromItem: any, toItem: any) => any[];
+/**
+ * Find an item in a collection by _id
+ * @param {Array} collection - Collection to search
+ * @param {string} _id - Client-side ID to find
+ * @returns {Object|null} - Found model or null
+ */
+export declare const findItemById: (collection: any[] | undefined, _id: string) => any | null;
+/**
+ * Get all items that have server-side IDs (existing items)
+ * @param {Array} collection - Collection to filter
+ * @returns {Array} - Items with server-side IDs
+ */
+export declare const getExistingItems: (collection?: any[]) => any[];
+/**
+ * Get all items that don't have server-side IDs (new items)
+ * @param {Array} collection - Collection to filter
+ * @returns {Array} - Items without server-side IDs
+ */
+export declare const getNewItems: (collection?: any[]) => any[];
+export declare const findRecursive: <T = any>(items: T[], predicate: (item: T) => boolean, optionsKey?: string) => T | null;
+/**
+ * Creates a deep clone of a value using JSON serialization
+ * @param {any} value - The value to clone
+ * @returns {any} A deep clone of the input value, or undefined if input is undefined
+ */
+export declare const clone: <T>(value: T) => T | undefined;
+//# sourceMappingURL=collections.d.ts.map

package/dist/utils/collections.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collections.d.ts","sourceRoot":"","sources":["../../src/utils/collections.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,eAAiB,KAAG,MAE9C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,aAAY,GAAG,EAAO,KAAG,GAAG,EAa/D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,UAAU,GAAI,WAAU,GAAQ,KAAG,GAK/C,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,YAAY,GAAG,EAAE,YAAK,EAAE,MAAM,GAAG,EAAE,oBAAmB,CAAC,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,IAAW,KAAG,GAAG,EAY3H,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,YAAY,GAAG,EAAE,YAAK,EAAE,cAAc,GAAG,KAAG,GAAG,EAEzE,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,YAAY,GAAG,EAAE,YAAK,EAAE,cAAc,GAAG,EAAE,SAAS,GAAG,KAAG,GAAG,EAYvF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,GAAI,YAAY,GAAG,EAAE,YAAK,EAAE,UAAU,GAAG,EAAE,QAAQ,GAAG,KAAG,GAAG,EAiBhF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,YAAY,GAAG,EAAE,YAAK,EAAE,KAAK,MAAM,KAAG,GAAG,GAAG,IAExE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,aAAY,GAAG,EAAO,KAAG,GAAG,EAE5D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,GAAI,aAAY,GAAG,EAAO,KAAG,GAAG,EAEvD,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,CAAC,GAAG,GAAG,EAAE,OAAO,CAAC,EAAE,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,EAAE,mBAAsB,KAAG,CAAC,GAAG,IAkBhH,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,KAAK,GAAa,CAAC,EAAE,OAAO,CAAC,KAAG,CAAC,GAAG,SAMhD,CAAC"}

package/dist/utils/forms.d.ts

@@ -0,0 +1,27 @@
+interface ErrorContent {
+    heading: string;
+    text: string;
+    trace: string;
+    traceAsString: string;
+    traceAsArray: string[];
+}
+interface ServerError {
+    response?: {
+        statusText?: string;
+        data?: {
+            message?: string;
+            error?: string;
+            file?: string;
+            line?: string;
+            trace?: Array<{
+                file?: string;
+                line?: string;
+            }>;
+        };
+    };
+    message?: string;
+    stack?: string;
+}
+export declare const getErrorMessage: (error: ServerError, maxTraceLines?: number) => ErrorContent;
+export {};
+//# sourceMappingURL=forms.d.ts.map

package/dist/utils/forms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"forms.d.ts","sourceRoot":"","sources":["../../src/utils/forms.ts"],"names":[],"mappings":"AAAA,UAAU,YAAY;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,EAAE,CAAC;CAC1B;AAED,UAAU,WAAW;IACjB,QAAQ,CAAC,EAAE;QACP,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,IAAI,CAAC,EAAE;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,KAAK,CAAC,EAAE,KAAK,CAAC;gBACV,IAAI,CAAC,EAAE,MAAM,CAAC;gBACd,IAAI,CAAC,EAAE,MAAM,CAAC;aACjB,CAAC,CAAC;SACN,CAAC;KACL,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AA6ED,eAAO,MAAM,eAAe,GAAY,OAAO,WAAW,EAAE,gBAAe,MAAU,KAAG,YAUvF,CAAC"}

package/dist/utils/handle.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Resolve dynamic reserved handles from other field values (e.g. a sibling field whose
+ * value would collide once slugified).
+ */
+export declare const getDynamicReservedHandles: (values: Record<string, unknown>, reservedFieldValues?: string[]) => string[];
+/**
+ * Generate a unique handle from a human-readable source value, honouring reserved handles
+ * (static + dynamically derived from other field values) and an optional max length.
+ */
+export declare const buildUniqueHandleFromSource: ({ sourceValue, values, reservedHandles, reservedFieldValues, maxLength, }: {
+    sourceValue: unknown;
+    values?: Record<string, unknown>;
+    reservedHandles?: string[];
+    reservedFieldValues?: string[];
+    maxLength?: number;
+}) => string;
+//# sourceMappingURL=handle.d.ts.map

package/dist/utils/handle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"handle.d.ts","sourceRoot":"","sources":["../../src/utils/handle.ts"],"names":[],"mappings":"AAkCA;;;GAGG;AACH,eAAO,MAAM,yBAAyB,GAClC,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,sBAAqB,MAAM,EAAO,KACnC,MAAM,EAgBR,CAAC;AAsDF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,GAAI,2EAMzC;IACC,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,KAAG,MAMH,CAAC"}

package/dist/utils/index.d.ts

@@ -0,0 +1,8 @@
+export * from './collections';
+export * from './forms';
+export * from './handle';
+export * from './markdown';
+export * from './promises';
+export * from './query';
+export * from './string';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}

package/dist/utils/markdown.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Initialize markdown-it instance with secure defaults and common options
+ * - HTML is disabled for security
+ * - Links are auto-detected
+ * - Typography features like smart quotes are enabled
+ * - Line breaks are converted to <br> tags
+ */
+declare const md: any;
+/**
+ * Renders markdown content as block-level HTML
+ * Includes block elements like headers, paragraphs, lists etc.
+ *
+ * @param content - The markdown string to render
+ * @returns Rendered HTML string, or empty string if no content provided
+ */
+export declare const renderMarkdown: (content: string) => string;
+/**
+ * Renders markdown content as inline HTML only
+ * Excludes block-level elements, only processes inline markdown syntax
+ *
+ * @param content - The markdown string to render
+ * @returns Rendered HTML string, or empty string if no content provided
+ */
+export declare const renderInlineMarkdown: (content: string) => string;
+/**
+ * Export the configured markdown-it instance for direct usage
+ * Allows access to the full markdown-it API if needed
+ */
+export { md };
+//# sourceMappingURL=markdown.d.ts.map

package/dist/utils/markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/utils/markdown.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,QAAA,MAAM,EAAE,KAKN,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,SAAS,MAAM,KAAG,MAIhD,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAI,SAAS,MAAM,KAAG,MAItD,CAAC;AAEF;;;GAGG;AACH,OAAO,EAAE,EAAE,EAAE,CAAC"}

package/dist/utils/promises.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Creates a function that ensures a promise takes at least a minimum amount of time to resolve
+ *
+ * @param ms - The minimum time in milliseconds that the promise should take
+ * @returns A function that wraps a promise or promise-returning function
+ * @example
+ * ```ts
+ * const slowFetch = takeAtLeast(1000)(fetch('https://api.example.com'));
+ * // Will take at least 1 second even if the fetch is faster
+ * ```
+ */
+export declare const takeAtLeast: (ms: number) => <T>(promiseOrFn: Promise<T> | (() => Promise<T>)) => Promise<T>;
+//# sourceMappingURL=promises.d.ts.map

package/dist/utils/promises.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promises.d.ts","sourceRoot":"","sources":["../../src/utils/promises.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,GAAY,IAAI,MAAM,MAQzB,CAAC,EAAE,aAAa,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,KAAG,OAAO,CAAC,CAAC,CAc/E,CAAC"}

package/dist/utils/query.d.ts

@@ -0,0 +1,3 @@
+export declare const getQueryParam: (key: string) => string | null;
+export declare const setQueryParam: (key: string, value: string) => void;
+//# sourceMappingURL=query.d.ts.map

package/dist/utils/query.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../src/utils/query.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,GAAI,KAAK,MAAM,KAAG,MAAM,GAAG,IAGpD,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,KAAK,MAAM,EAAE,OAAO,MAAM,KAAG,IAI1D,CAAC"}

package/dist/utils/string.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Convert a string to a handle format
+ * @param {string} sourceValue - The source string to convert
+ * @param {string} handleCasing - The casing format ('camelCase', 'pascal', 'snake', 'kebab')
+ * @param {boolean} allowNonAlphaStart - Whether to allow non-alphabetic characters at the start
+ * @returns {string} The generated handle
+ */
+export declare const generateHandle: (sourceValue: string, handleCasing?: string, allowNonAlphaStart?: boolean) => string;
+/**
+ * Find a unique handle by checking against reserved handles and adding suffixes
+ * @param {string} baseHandle - The base handle to check
+ * @param {Array} allReservedHandles - Array of all reserved handles to check against (static + dynamic)
+ * @returns {string} A unique handle
+ */
+export declare const findUniqueHandle: (baseHandle: string, allReservedHandles?: string[]) => string;
+//# sourceMappingURL=string.d.ts.map

package/dist/utils/string.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../src/utils/string.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAY,aAAa,MAAM,EAAE,eAAc,MAAoB,EAAE,qBAAoB,OAAe,KAAG,MAyCrI,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAAI,YAAY,MAAM,EAAE,qBAAoB,MAAM,EAAO,KAAG,MAaxF,CAAC"}

package/package.json

@@ -0,0 +1,57 @@
+{
+    "name": "@verbb/plugin-kit-core",
+    "version": "2.0.0",
+    "type": "module",
+    "main": "dist/plugin-kit-core.es.js",
+    "module": "dist/plugin-kit-core.es.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist",
+        "CHANGELOG.md",
+        "LICENSE.md"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/verbb/plugin-kit.git",
+        "directory": "plugin-kit-core"
+    },
+    "bugs": {
+        "url": "https://github.com/verbb/plugin-kit/issues"
+    },
+    "homepage": "https://docs.verbb.io/plugin-kit",
+    "engines": {
+        "node": ">=20.0.0"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/plugin-kit-core.es.js"
+        },
+        "./eslint/*": "./dist/eslint/*",
+        "./prettier/*": "./dist/prettier/*",
+        "./package.json": "./package.json"
+    },
+    "scripts": {
+        "build": "vite build",
+        "dev": "vite build --watch",
+        "lint": "eslint ."
+    },
+    "license": "MIT",
+    "dependencies": {
+        "@eslint/js": "^10.0.1",
+        "@typescript-eslint/eslint-plugin": "^8.59.0",
+        "@typescript-eslint/parser": "^8.59.0",
+        "eslint-plugin-react-hooks": "^7.1.1",
+        "globals": "^17.5.0",
+        "markdown-it": "^14.1.1"
+    },
+    "devDependencies": {
+        "eslint": "^10.2.1",
+        "typescript": "^6.0.3",
+        "vite": "^8.0.10",
+        "vite-plugin-dts": "^4.5.4"
+    }
+}