@edgepdf/viewer-js 0.0.1

package/README.md

@@ -0,0 +1,197 @@
+# @edgepdf/viewer-js
+
+Core JavaScript library for the EdgePDF viewer, providing Leaflet map integration for displaying and interacting with PDF/image tiles.
+
+## Installation
+
+```bash
+npm install @edgepdf/viewer-js
+# or
+pnpm add @edgepdf/viewer-js
+```
+
+**Note:** Leaflet is bundled with this library, so you don't need to install it separately. However, you do need to import the CSS:
+
+```typescript
+import '@edgepdf/viewer-js/styles.css';
+```
+
+## Usage
+
+### Basic Example
+
+```typescript
+import { EdgePdfViewer } from '@edgepdf/viewer-js';
+import '@edgepdf/viewer-js/styles.css'; // Required: Leaflet CSS
+import type { ViewerConfig } from '@edgepdf/types';
+
+// Get container element
+const container = document.getElementById('map-container');
+
+// Configure viewer
+const config: ViewerConfig = {
+  tileUrl: 'https://example.com/tiles/{z}/{x}/{y}.png',
+  imageInfo: {
+    width: 2000,
+    height: 3000,
+    tileSize: 256,
+    maxZoom: 5,
+    minZoom: 0
+  }
+};
+
+// Create and initialize viewer
+const viewer = new EdgePdfViewer({ container, config });
+viewer.initialize();
+
+// Cleanup when done
+viewer.dispose();
+```
+
+### With Custom Map Options
+
+```typescript
+import { EdgePdfViewer } from '@edgepdf/viewer-js';
+import '@edgepdf/viewer-js/styles.css'; // Required: Leaflet CSS
+import type { ViewerConfig, MapOptions } from '@edgepdf/types';
+
+const config: ViewerConfig = {
+  tileUrl: 'https://example.com/tiles/{z}/{x}/{y}.png',
+  imageInfo: {
+    width: 2000,
+    height: 3000,
+    tileSize: 256,
+    maxZoom: 5,
+    minZoom: 0
+  }
+};
+
+const mapOptions: MapOptions = {
+  center: [1500, 1000], // [y, x] in pixel coordinates
+  zoom: 2,
+  minZoom: 0,
+  maxZoom: 5
+};
+
+const viewer = new EdgePdfViewer({
+  container: document.getElementById('map-container'),
+  config,
+  mapOptions
+});
+
+viewer.initialize();
+```
+
+## API Reference
+
+### EdgePdfViewer
+
+Main class for initializing and managing Leaflet map instances.
+
+#### Constructor
+
+```typescript
+new EdgePdfViewer(options: {
+  container: HTMLElement;
+  config: ViewerConfig;
+  mapOptions?: MapOptions;
+})
+```
+
+**Parameters:**
+- `container` - HTML element that will contain the map
+- `config` - Viewer configuration with tile URL and image info
+- `mapOptions` - Optional Leaflet map options (center, zoom, etc.)
+
+**Throws:**
+- `Error` if container is not provided or invalid
+- `Error` if config is not provided or invalid
+- `Error` if tileUrl is missing
+- `Error` if imageInfo is missing
+
+#### Methods
+
+##### `initialize(): void`
+
+Initializes the Leaflet map with custom CRS (Coordinate Reference System). Sets up a custom CRS.Simple coordinate system suitable for displaying image tiles without geographic coordinates.
+
+**Throws:**
+- `Error` if map initialization fails
+
+##### `getMap(): L.Map | null`
+
+Gets the Leaflet map instance.
+
+**Returns:** The Leaflet map instance, or `null` if not initialized
+
+##### `isInitialized(): boolean`
+
+Checks if the map is initialized.
+
+**Returns:** `true` if map is initialized, `false` otherwise
+
+##### `dispose(): void`
+
+Disposes of the map instance and cleans up resources. This should be called when the viewer is no longer needed to prevent memory leaks and event listener issues.
+
+## Configuration
+
+### ViewerConfig
+
+```typescript
+interface ViewerConfig {
+  tileUrl: string;           // Tile URL template with {z}, {x}, {y} placeholders
+  imageInfo: ImageInfo;       // Image metadata
+  onPinsUpdate?: (pins: Marker[]) => void;  // Optional callback for marker updates
+  originalImagePath?: string; // Optional original image path
+}
+```
+
+### ImageInfo
+
+```typescript
+interface ImageInfo {
+  width: number;    // Original image width in pixels
+  height: number;    // Original image height in pixels
+  tileSize: number; // Tile size in pixels (default: 256)
+  maxZoom: number;  // Maximum zoom level
+  minZoom: number;  // Minimum zoom level
+}
+```
+
+### MapOptions
+
+```typescript
+interface MapOptions {
+  center?: [number, number];  // Initial center coordinates [y, x]
+  zoom?: number;              // Initial zoom level
+  minZoom?: number;          // Minimum zoom level
+  maxZoom?: number;          // Maximum zoom level
+  bounds?: {
+    southwest: [number, number];
+    northeast: [number, number];
+  };
+}
+```
+
+## Coordinate System
+
+The viewer uses Leaflet's `CRS.Simple` coordinate system, which treats coordinates as pixel positions rather than geographic lat/lng. This is ideal for displaying image tiles:
+
+- X-axis: horizontal pixel position (0 to image width)
+- Y-axis: vertical pixel position (0 to image height)
+- Origin: top-left corner (0, 0)
+
+## Building
+
+Run `nx build viewer-js` to build the library.
+
+## Running Tests
+
+Run `nx test viewer-js` to execute the unit tests via [Jest](https://jestjs.io).
+
+Run `nx test viewer-js --coverage` to generate coverage reports.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export * from './lib/viewer.js';
+export { EdgePdfViewer } from './lib/viewer.js';
+export { TileLayerManager } from './lib/tile-layer-manager.js';
+export { CoordinateMapper } from './lib/coordinate-mapper.js';
+export { ZoomController } from './lib/zoom-controller.js';
+export { MarkerManager } from './lib/marker-manager.js';
+export type { CreateMarkerOptions } from './lib/marker-manager.js';
+export type { ImageInfo, TileConfig, ViewerConfig, LeafletCoords, ImageCoords, Marker, MarkerData, MapOptions, ZoomConfig, ZoomState, CoordinateBounds, MarkerEventType, MarkerEvent, MarkerEditHandler, MarkerDeleteHandler, MarkerInteractionConfig, MarkerSelectionState, } from '@edgepdf/types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,YAAY,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAGnE,YAAY,EACV,SAAS,EACT,UAAU,EACV,YAAY,EACZ,aAAa,EACb,WAAW,EACX,MAAM,EACN,UAAU,EACV,UAAU,EACV,UAAU,EACV,SAAS,EACT,gBAAgB,EAChB,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,oBAAoB,GACrB,MAAM,gBAAgB,CAAC"}