@janrankenhohn/react-thumbnail-list 0.7.1 → 1.0.0

package/dist/types/src/tests/mocks/MockListItems.d.ts

@@ -0,0 +1,41 @@
+export declare const items: ({
+    id: string;
+    name: string;
+    title: string;
+    subTitle: string;
+    label: string;
+    isScheduled: boolean;
+    thumbnailUrl: string;
+    link: string;
+    startDateTimeStamp?: undefined;
+} | {
+    id: string;
+    name: string;
+    title: string;
+    subTitle: string;
+    label: string;
+    thumbnailUrl: string;
+    link: string;
+    isScheduled?: undefined;
+    startDateTimeStamp?: undefined;
+} | {
+    id: string;
+    title: string;
+    subTitle: string;
+    label: string;
+    thumbnailUrl: string;
+    link: string;
+    name?: undefined;
+    isScheduled?: undefined;
+    startDateTimeStamp?: undefined;
+} | {
+    id: string;
+    title: string;
+    subTitle: string;
+    label: string;
+    startDateTimeStamp: number;
+    thumbnailUrl: string;
+    link: string;
+    name?: undefined;
+    isScheduled?: undefined;
+})[];

package/dist/types/src/types/AlignType.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Type for horizontal alignment positioning.
+ * Used to align child components in the header and other container components.
+ *
+ * @type {'start' | 'end'}
+ */
+export type AlignType = 'start' | 'end';

package/dist/types/src/types/BreakpointType.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Type definition for Material-UI Grid breakpoint configuration.
+ * Defines how many columns an item should span at each screen size.
+ * Grid has 12 columns total at each breakpoint.
+ *
+ * @property {number} xs - Extra small screens (<600px) - Number of columns to span
+ * @property {number} sm - Small screens (≥600px) - Number of columns to span
+ * @property {number} md - Medium screens (≥900px) - Number of columns to span
+ * @property {number} lg - Large screens (≥1200px) - Number of columns to span
+ * @property {number} xl - Extra large screens (≥1536px) - Number of columns to span
+ *
+ * @example
+ * ```tsx
+ * const breakpoints: BreakpointType = { xs: 12, sm: 6, md: 4, lg: 3, xl: 2 };
+ * // On xs: 1 column, sm: 2 columns, md: 3 columns, lg: 4 columns, xl: 6 columns
+ * ```
+ */
+type BreakpointType = {
+    xs: number;
+    sm: number;
+    md: number;
+    lg: number;
+    xl: number;
+};
+export default BreakpointType;

package/dist/types/src/utils/arrayHelper.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Generic method that sorts an array of items based on an item key
+ * @param values The array that should be sorted
+ * @param orderType The key of the entity that the array should be sorted by
+ * @returns A new reference of the ordered array
+ */
+export declare function orderByArray<T>(values: T[], orderType: keyof T): T[];
+/**
+ * Function type for filtering array items based on a custom condition.
+ *
+ * @template T - The type of value to be evaluated
+ * @param {T} value - The value to evaluate
+ * @returns {boolean} True if the value passes the condition, false otherwise
+ */
+export type ConditionFunction<T> = (value: T) => boolean;
+/**
+ * Filters an array of items based on a tag property and optional condition function.
+ * If no condition is provided, items are filtered based on the truthiness of the tag value.
+ *
+ * @template T - The type of items in the array
+ * @param {T[]} array - The array to filter
+ * @param {keyof T} tagType - The property key to use for filtering
+ * @param {ConditionFunction<T[keyof T]>} [condition] - Optional condition function to apply to tag values
+ * @returns {T[]} A new array containing only items that pass the filter
+ */
+export declare function filterByTag<T>(array: T[], tagType: keyof T, condition?: ConditionFunction<T[keyof T]>): T[];

package/dist/types/src/utils/logHelper.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Logs a message to the console only in development mode.
+ * In production, this function does nothing, preventing debug logs from appearing in production builds.
+ *
+ * @param {unknown} message - The message or value to log
+ *
+ * @example
+ * ```tsx
+ * logDev('Component rendered');
+ * logDev({ items: filteredItems });
+ * ```
+ */
+export declare const logDev: (message: unknown) => void;
+/**
+ * Logs a message to the console in all environments.
+ *
+ * @param {unknown} message - The message or value to log
+ *
+ * @example
+ * ```tsx
+ * log('Critical error occurred');
+ * ```
+ */
+export declare const log: (message: unknown) => void;

package/dist/types/utils/logHelper.d.ts

@@ -0,0 +1,2 @@
+export declare const logDev: (message: unknown) => void;
+export declare const log: (message: unknown) => void;

package/dist/types/vitest.setup.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/package.json

@@ -1,84 +1,103 @@
-{
-  "name": "@janrankenhohn/react-thumbnail-list",
-  "version": "0.7.1",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.js",
-  "types": "dist/types/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/JanRankenhohn/react-thumbnail-list.git"
-  },
-  "scripts": {
-    "build": "rollup -c",
-    "build-watch": "rollup -c -w",
-    "play": "cd playground && npm run dev",
-    "i-all": "npm i && cd playground && npm i",
-    "dev": "npm-run-all --parallel build-watch start-playground",
-    "start": "react-scripts start",
-    "test": "react-scripts test",
-    "eject": "react-scripts eject"
-  },
-  "eslintConfig": {
-    "extends": [
-      "react-app",
-      "react-app/jest"
-    ]
-  },
-  "browserslist": {
-    "production": [
-      ">0.2%",
-      "not dead",
-      "not op_mini all"
-    ],
-    "development": [
-      "last 1 chrome version",
-      "last 1 firefox version",
-      "last 1 safari version"
-    ]
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.23.9",
-    "@babel/core": "^7.23.9",
-    "@babel/preset-env": "^7.23.9",
-    "@babel/preset-react": "^7.23.3",
-    "@eslint/js": "^9.1.1",
-    "@testing-library/jest-dom": "^5.17.0",
-    "@testing-library/react": "^13.4.0",
-    "@testing-library/user-event": "^13.5.0",
-    "@types/lodash": "^4.17.0",
-    "@typescript-eslint/eslint-plugin": "^7.8.0",
-    "@typescript-eslint/parser": "^7.8.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-react": "^7.34.1",
-    "globals": "^15.1.0",
-    "jest": "^27.5.1",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^3.2.5",
-    "react-router": "^6.26.1",
-    "@rollup/plugin-typescript": "^11.1.6",
-    "@rollup/plugin-url": "^8.0.2",
-    "@rollup/plugin-commonjs": "^25.0.8",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "rollup-plugin-dts": "^6.1.1",
-    "rollup": "^4.18.0",
-    "rollup-plugin-peer-deps-external": "^2.2.4",
-    "rollup-plugin-typescript2": "^0.36.0",
-    "typescript-eslint": "^7.8.0"
-  },
-  "peerDependencies": {
-    "@emotion/react": "^11.11.4",
-    "@emotion/styled": "^11.11.0",
-    "@mui/icons-material": "^5.15.11 || ^6.0.0",
-    "@mui/material": "^5.15.11 || ^6.0.0",
-    "lodash.debounce": "^4.0.8",
-    "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
-    "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0",
-    "web-vitals": "^2.1.4"
-  }
-}
+{
+  "name": "@janrankenhohn/react-thumbnail-list",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/types/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JanRankenhohn/react-thumbnail-list.git"
+  },
+  "scripts": {
+    "build": "cross-env NODE_ENV=production rollup -c",
+    "build-watch": "rollup -c -w",
+    "play": "cd playground && npm run dev",
+    "i-all": "npm i && cd playground && npm i",
+    "dev": "npm-run-all --parallel build-watch play",
+    "test": "vitest",
+    "test:run": "vitest run --reporter verbose",
+    "test:watch": "vitest --watch",
+    "test:ui": "vitest --ui",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.23.9",
+    "@babel/core": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
+    "@babel/preset-react": "^7.23.3",
+    "@chromatic-com/storybook": "^4.1.3",
+    "@eslint/js": "^9.1.1",
+    "@rollup/plugin-commonjs": "^25.0.8",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^6.0.2",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@rollup/plugin-url": "^8.0.2",
+    "@storybook/addon-a11y": "^10.1.11",
+    "@storybook/addon-docs": "^10.1.11",
+    "@storybook/addon-vitest": "^10.1.11",
+    "@storybook/react-vite": "^10.1.11",
+    "@testing-library/jest-dom": "^5.17.0",
+    "@testing-library/react": "^13.4.0",
+    "@testing-library/user-event": "^13.5.0",
+    "@types/lodash": "^4.17.0",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0",
+    "@typescript-eslint/eslint-plugin": "^8.51.0",
+    "@typescript-eslint/parser": "^8.51.0",
+    "@vitest/browser-playwright": "^4.0.16",
+    "@vitest/coverage-v8": "^4.0.16",
+    "@vitest/ui": "^4.0.16",
+    "cross-env": "^7.0.3",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-react": "^7.37.5",
+    "eslint-plugin-storybook": "^10.1.11",
+    "globals": "^15.1.0",
+    "jest": "^27.5.1",
+    "npm-run-all": "^4.1.5",
+    "playwright": "^1.57.0",
+    "prettier": "^3.2.5",
+    "react-router": "^6.26.1",
+    "rollup": "^4.18.0",
+    "rollup-plugin-dts": "^6.1.1",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "storybook": "^10.1.11",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.16"
+  },
+  "peerDependencies": {
+    "@emotion/react": "^11.11.4",
+    "@emotion/styled": "^11.11.0",
+    "@mui/icons-material": "^5.15.11 || ^6.0.0",
+    "@mui/material": "^5.15.11 || ^6.0.0",
+    "lodash.debounce": "^4.0.8",
+    "react": "^17.0.0 || ^18.0.0 || ^19.0.0",
+    "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0",
+    "web-vitals": "^2.1.4"
+  }
+}