js-cloudimage-360-view 4.0.0 → 4.1.0-beta.0

package/package.json

@@ -1,11 +1,26 @@
 {
   "name": "js-cloudimage-360-view",
-  "version": "4.0.0",
+  "version": "4.1.0-beta.0",
   "main": "dist/js-cloudimage-360-view.min.js",
+  "types": "src/types/ci360.d.ts",
+  "files": [
+    "dist/js-cloudimage-360-view.min.js",
+    "dist/js-cloudimage-360-view.min.css",
+    "dist/react",
+    "src/types",
+    "src/react/types.d.ts"
+  ],
   "exports": {
     ".": {
+      "types": "./src/types/ci360.d.ts",
       "import": "./dist/js-cloudimage-360-view.min.js",
       "require": "./dist/js-cloudimage-360-view.min.js"
+    },
+    "./css": "./dist/js-cloudimage-360-view.min.css",
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js",
+      "require": "./dist/react/index.cjs"
     }
   },
   "style": "dist/js-cloudimage-360-view.min.css",
@@ -30,40 +45,64 @@
     "360 product view"
   ],
   "scripts": {
-    "dev": "vite serve demo",
+    "dev": "vite serve demo --host",
+    "dev:react": "npm --prefix demo/react-demo run dev",
     "clean:build": "rm -rf dist",
     "build:bundle": "npm run clean:build && vite build",
+    "build:react": "vite build --config vite-react.config.js && cp src/react/types.d.ts dist/react/index.d.ts",
+    "build": "npm run build:bundle && npm run build:react",
     "deploy:bundle": "npm run build:bundle && node bin/deploy-bundle",
     "clean:dist": "rm -rf dist",
     "clean:demo": "rm -rf demo/dist",
     "build:npm": "npm run clean:demo && vite --config vite-npm.config.js build",
-    "build:demo": "npm run clean:demo && vite --config vite-demo.config.js build",
+    "build:demo": "vite --config vite-demo.config.js build && npm --prefix demo/react-demo run build",
     "deploy:demo": "gh-pages -d dist",
-    "publish": "npm run build:demo && npm run deploy:demo"
+    "publish": "npm run build:demo && npm run deploy:demo",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage"
   },
   "dependencies": {
     "@popperjs/core": "^2.11.2",
-    "lodash.debounce": "^4.0.8",
     "lodash.throttle": "^4.1.1"
   },
+  "peerDependencies": {
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
   "devDependencies": {
     "@babel/cli": "^7.16.7",
+    "@types/react": "^18.2.0",
+    "@types/react-dom": "^18.2.0",
+    "@vitejs/plugin-react": "^4.2.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "typescript": "^5.3.0",
     "@babel/core": "^7.16.7",
     "@babel/plugin-transform-runtime": "^7.16.5",
     "@babel/preset-env": "^7.16.5",
     "@eslint/js": "^9.12.0",
+    "@vitest/coverage-v8": "^4.0.17",
+    "autoprefixer": "^10.4.23",
     "babel-loader": "^8.2.3",
     "babel-plugin-array-includes": "^2.0.3",
-    "babel-preset-env": "^1.7.0",
-    "babel-preset-es2015": "^6.24.1",
     "babel-preset-minify": "^0.5.0",
-    "babel-preset-stage-0": "^6.24.1",
     "css-loader": "^2.1.1",
     "dotenv": "^16.0.3",
     "eslint": "^9.12.0",
     "form-data": "^4.0.0",
     "gh-pages": "^2.0.1",
     "highlight.js": "^10.4.1",
+    "isomorphic-fetch": "^3.0.0",
+    "jsdom": "^27.4.0",
     "mini-css-extract-plugin": "^0.9.0",
     "mobile-detect": "^1.4.3",
     "prettier": "3.3.3",
@@ -72,6 +111,7 @@
     "vite-plugin-dts": "^4.3.0",
     "vite-plugin-html": "^3.2.2",
     "vite-plugin-lib-inject-css": "^2.1.1",
+    "vitest": "^4.0.17",
     "webpack": "^5.95.0",
     "webpack-cli": "^5.0.1",
     "webpack-dev-server": "^4.13.3"

package/src/react/types.d.ts

@@ -0,0 +1,228 @@
+import { CSSProperties, RefObject, ForwardRefExoticComponent, RefAttributes } from 'react';
+
+/**
+ * Autoplay behavior options
+ */
+export type AutoplayBehavior = 'spin-x' | 'spin-y' | 'spin-xy' | 'spin-yx';
+
+/**
+ * Theme options for the viewer
+ */
+export type Theme = 'light' | 'dark';
+
+/**
+ * Hotspot orientation
+ */
+export type HotspotOrientation = 'x' | 'y';
+
+/**
+ * Hotspot position
+ */
+export interface HotspotPosition {
+  x: number;
+  y: number;
+}
+
+/**
+ * Hotspot configuration
+ */
+export interface Hotspot {
+  id: string;
+  label?: string;
+  orientation?: HotspotOrientation;
+  containerSize?: [number, number];
+  positions: Record<number, HotspotPosition>;
+  content?: string;
+  className?: string;
+}
+
+/**
+ * Hint configuration
+ */
+export interface Hint {
+  text: string;
+  icon?: 'drag' | 'scroll' | 'pinch' | 'keys';
+}
+
+/**
+ * Spin event data
+ */
+export interface SpinEventData {
+  viewerId: string;
+  direction: 'left' | 'right' | 'up' | 'down';
+  activeImageX: number;
+  activeImageY: number;
+  amountX: number;
+  amountY: number;
+}
+
+/**
+ * Load event data
+ */
+export interface LoadEventData {
+  viewerId: string;
+  imagesX: number;
+  imagesY: number;
+}
+
+/**
+ * Zoom event data
+ */
+export interface ZoomEventData {
+  viewerId: string;
+  zoomLevel: number;
+}
+
+/**
+ * Error event data
+ */
+export interface ErrorEventData {
+  viewerId: string;
+  error: { message: string; url?: string };
+  errorCount: number;
+  totalImages: number;
+  errors: Array<{ message: string; url?: string }>;
+}
+
+/**
+ * Base event data (common to all events)
+ */
+export interface BaseEventData {
+  viewerId: string;
+}
+
+/**
+ * CI360 Configuration options
+ */
+export interface CI360Config {
+  folder?: string;
+  apiVersion?: string;
+  filenameX?: string;
+  filenameY?: string | null;
+  imageListX?: string | string[] | null;
+  imageListY?: string | string[] | null;
+  indexZeroBase?: number;
+  amountX?: number;
+  amountY?: number;
+  draggable?: boolean;
+  swipeable?: boolean;
+  keys?: boolean;
+  keysReverse?: boolean;
+  autoplay?: boolean;
+  autoplayBehavior?: AutoplayBehavior;
+  playOnce?: boolean;
+  speed?: number;
+  autoplayReverse?: boolean;
+  dragSpeed?: number;
+  dragReverse?: boolean;
+  stopAtEdges?: boolean;
+  inertia?: boolean;
+  fullscreen?: boolean;
+  magnifier?: number | null;
+  pointerZoom?: number;
+  pinchZoom?: boolean;
+  bottomCircle?: boolean;
+  bottomCircleOffset?: number;
+  initialIconShown?: boolean;
+  hide360Logo?: boolean;
+  logoSrc?: string;
+  imageInfo?: boolean;
+  hints?: boolean | Hint[];
+  theme?: Theme;
+  ciToken?: string | null;
+  ciFilters?: string | null;
+  ciTransformation?: string | null;
+  lazyload?: boolean;
+  hotspots?: Hotspot[] | null;
+  hotspotTimelineOnClick?: boolean;
+  onReady?: (data: BaseEventData) => void;
+  onLoad?: (data: LoadEventData) => void;
+  onSpin?: (data: SpinEventData) => void;
+  onAutoplayStart?: (data: BaseEventData) => void;
+  onAutoplayStop?: (data: BaseEventData) => void;
+  onFullscreenOpen?: (data: BaseEventData) => void;
+  onFullscreenClose?: (data: BaseEventData) => void;
+  onZoomIn?: (data: ZoomEventData) => void;
+  onZoomOut?: (data: BaseEventData) => void;
+  onDragStart?: (data: BaseEventData) => void;
+  onDragEnd?: (data: BaseEventData) => void;
+  onError?: (data: ErrorEventData) => void;
+}
+
+/**
+ * CI360 Viewer Instance methods available from the native viewer
+ */
+export interface CI360ViewerInstance {
+  moveLeft: (stopAtEdges?: boolean, steps?: number) => void;
+  moveRight: (stopAtEdges?: boolean, steps?: number) => void;
+  moveTop: (stopAtEdges?: boolean, steps?: number) => void;
+  moveBottom: (stopAtEdges?: boolean, steps?: number) => void;
+  play: () => void;
+  stopAutoplay: () => void;
+  toggleZoom: (event?: MouseEvent) => void;
+  removeZoom: () => void;
+  animateToFrame: (frame: number, hotspotId?: string) => void;
+  destroy: () => void;
+  update: (config: Partial<CI360Config>) => void;
+  isReady: boolean;
+  activeImageX: number;
+  activeImageY: number;
+  amountX: number;
+  amountY: number;
+  isZoomed: boolean;
+  viewerConfig: CI360Config;
+}
+
+/**
+ * Props for the CI360Viewer React component
+ */
+export interface CI360ViewerProps extends CI360Config {
+  id?: string;
+  className?: string;
+  style?: CSSProperties;
+}
+
+/**
+ * Ref methods exposed by CI360Viewer component
+ */
+export interface CI360ViewerRef {
+  moveLeft: (steps?: number) => void;
+  moveRight: (steps?: number) => void;
+  moveTop: (steps?: number) => void;
+  moveBottom: (steps?: number) => void;
+  play: () => void;
+  stop: () => void;
+  zoomIn: () => void;
+  zoomOut: () => void;
+  goToFrame: (frame: number, hotspotId?: string) => void;
+  getViewer: () => CI360ViewerInstance | null;
+}
+
+/**
+ * Return type for useCI360 hook
+ */
+export interface UseCI360Return {
+  viewer: CI360ViewerInstance | null;
+  isReady: boolean;
+}
+
+/**
+ * Options for useCI360 hook
+ */
+export interface UseCI360Options extends CI360Config {
+  autoInit?: boolean;
+}
+
+/**
+ * CI360Viewer React Component
+ */
+export declare const CI360Viewer: ForwardRefExoticComponent<CI360ViewerProps & RefAttributes<CI360ViewerRef>>;
+export default CI360Viewer;
+
+/**
+ * useCI360 Hook for advanced control
+ */
+export declare function useCI360(
+  containerRef: RefObject<HTMLDivElement | null>,
+  config: UseCI360Options
+): UseCI360Return;

package/src/types/ci360.d.ts

@@ -0,0 +1,66 @@
+declare module CI360 {
+  export interface CI360ViewerConfig {
+    folder?: string; // Default: '/'
+    apiVersion?: string; // Default: 'v7'
+    filenameX?: string; // Default: 'image-{index}.jpg'
+    filenameY?: string | null; // Default: null
+    imageListX?: string | null; // Default: null
+    imageListY?: string | null; // Default: null
+    indexZeroBase?: number; // Default: 0
+    amountX?: number; // Default: 0
+    amountY?: number; // Default: 0
+    draggable?: boolean; // Default: true
+    swipeable?: boolean; // Default: true
+    keys?: boolean; // Default: false
+    keysReverse?: boolean; // Default: false
+    bottomCircleOffset?: number; // Default: 5
+    autoplay?: boolean; // Default: false
+    autoplayBehavior?: string; // Default: AUTOPLAY_BEHAVIOR.SPIN_X
+    playOnce?: boolean; // Default: false
+    speed?: number; // Default: 80
+    autoplayReverse?: boolean; // Default: false
+    fullscreen?: boolean; // Default: false
+    magnifier?: number | null; // Default: null
+    ciToken?: string | null; // Default: null
+    ciFilters?: string | null; // Default: null
+    ciTransformation?: string | null; // Default: null
+    lazyload?: boolean; // Default: true
+    dragSpeed?: number; // Default: 150
+    stopAtEdges?: boolean; // Default: false
+    pointerZoom?: number; // Default: 0
+    imageInfo?: boolean; // Changed from string to boolean; Default: false
+    initialIconShown?: boolean; // Default: true
+    bottomCircle?: boolean; // Default: true
+    hotspots?: any; // Default: null (type adjusted as needed)
+    dragReverse?: boolean; // Default: false
+    hide360Logo?: boolean; // Default: false (not documented)
+    logoSrc?: string; // Default: Scaleflex 360 logo URL
+  }
+
+  // Define the CI360Viewer class with the config type and constructor
+  export default class CI360Viewer {
+    constructor(container: HTMLElement | string, config?: CI360ViewerConfig, fullscreen?: boolean);
+    destroy(): void;
+    update(config: CI360ViewerConfig): void;
+    viewerConfig: CI360ViewerConfig;
+  }
+
+  // Define the CI360 class
+  export class CI360 {
+    views: Map<string, CI360Viewer>;
+    instances: CI360Viewer[];
+    initAll: (className?: string) => void;
+    getInstances: () => CI360Viewer[];
+    init: (
+      container: HTMLElement | string,
+      config?: CI360ViewerConfig,
+      fullscreen?: boolean
+    ) => CI360Viewer | undefined;
+    getViewById: (id: string) => CI360Viewer | undefined;
+    getViews: () => CI360Viewer[];
+    updateView: (id: string, config: CI360ViewerConfig) => CI360Viewer | undefined;
+    destroy: (id: string) => void;
+    destroyAll: () => void;
+    constructor();
+  }
+}

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "semi": true,
-  "singleQuote": true,
-  "trailingComma": "es5",
-  "tabWidth": 2,
-  "useTabs": false,
-  "printWidth": 110,
-  "arrowParens": "always"
-}