bdsa-react-components 0.1.14 → 0.1.15

package/dist/utils/itemUtils.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Utility functions for working with DSA items
+ */
+/**
+ * Item interface representing a DSA item (file or folder)
+ */
+export interface Item {
+    /** Item ID */
+    _id: string;
+    /** Item name */
+    name?: string;
+    /** Item type (e.g., 'file', 'folder') */
+    _modelType?: string;
+    /** Large image flag (can be at root level or in meta) */
+    largeImage?: boolean | string | object;
+    /** Metadata object */
+    meta?: {
+        /** Large image flag in metadata */
+        largeImage?: boolean | string | object;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+/**
+ * Check if an item has the largeImage flag set
+ *
+ * This function checks BOTH the root level and meta.largeImage locations,
+ * as different DSA servers and configurations store this flag in different places.
+ *
+ * Based on actual DSA data, the largeImage flag is most commonly found at the root level,
+ * but this function checks both locations for maximum compatibility.
+ *
+ * @param item - The DSA item to check
+ * @returns true if the item has largeImage flag set (as true, 'true', or an object)
+ *
+ * @example
+ * ```typescript
+ * // Root level largeImage (most common)
+ * const item1 = { _id: '123', largeImage: true }
+ * hasLargeImage(item1) // => true
+ *
+ * // Object type largeImage (contains image metadata)
+ * const item2 = { _id: '456', largeImage: { width: 1024, height: 768 } }
+ * hasLargeImage(item2) // => true
+ *
+ * // Meta level largeImage (fallback location)
+ * const item3 = { _id: '789', meta: { largeImage: true } }
+ * hasLargeImage(item3) // => true
+ *
+ * // No largeImage flag
+ * const item4 = { _id: '000' }
+ * hasLargeImage(item4) // => false
+ * ```
+ */
+export declare function hasLargeImage(item: Item): boolean;
+/**
+ * Filter an array of items to only include those with largeImage flag
+ *
+ * @param items - Array of DSA items to filter
+ * @returns Filtered array containing only items with largeImage flag
+ *
+ * @example
+ * ```typescript
+ * const items = [
+ *     { _id: '1', name: 'image.svs', largeImage: true },
+ *     { _id: '2', name: 'document.pdf' },
+ *     { _id: '3', name: 'slide.tif', meta: { largeImage: true } }
+ * ]
+ *
+ * const imageItems = filterLargeImages(items)
+ * // => [{ _id: '1', ... }, { _id: '3', ... }]
+ * ```
+ */
+export declare function filterLargeImages(items: Item[]): Item[];
+//# sourceMappingURL=itemUtils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"itemUtils.d.ts","sourceRoot":"","sources":["../../src/utils/itemUtils.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,MAAM,WAAW,IAAI;IACjB,cAAc;IACd,GAAG,EAAE,MAAM,CAAA;IACX,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,yDAAyD;IACzD,UAAU,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;IACtC,sBAAsB;IACtB,IAAI,CAAC,EAAE;QACH,mCAAmC;QACnC,UAAU,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;QACtC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KACzB,CAAA;IACD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAqBjD;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,CAEvD"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bdsa-react-components",
-    "version": "0.1.14",
+    "version": "0.1.15",
     "description": "Reusable React components for the Digital Slide Archive project",
     "type": "module",
     "main": "./dist/index.cjs",