declare dependencies as peers & add version check

Author: mistic100

build/plugins/esbuild-plugin-umd.js

@@ -25,10 +25,8 @@ export function umdPlugin({ pkg, externals }) {
 }
 
 function wrapUmd(fileContent, pkg, externals) {
-    const deps = Object.keys(pkg.dependencies);
-    if (!deps.includes('three')) {
-        deps.unshift('three');
-    }
+    const deps = Object.keys(pkg.peerDependencies || {});
+    deps.unshift('three');
 
     const depsCommonJs = deps.map((dep) => `require('${dep}')`).join(', ');
     const depsAmd = deps.map((dep) => `'${dep}'`).join(', ');
@@ -52,6 +50,7 @@ ${fileContent
     .replace(`var ${globalParent};\n`, '')
     .replace(`var ${globalParent} = (() => {\n`, '')
     .replace(`(${globalParent} ||= {}).${globalName.split('.').pop()} = (() => {\n`, '')
+
     // hydrate exports
     .replace(/return __toCommonJS\((.*?)\);\n}\)\(\);/, '__copyProps(__defProp(exports, "__esModule", { value: true }), $1);')
     // unused function
@@ -75,6 +74,7 @@ ${fileContent
     .replace(/  var __commonJS = ([\s\S]*?)};\n/, '')
     .replace(/  var __create = (.*?);\n/, '')
     .replace(/  var __getProtoOf = (.*?);\n/, '')
+
     // remove plugin reference
     .replace(/external-global-plugin:/g, '')}
 }));`;

build/tsup.config.js

@@ -46,6 +46,9 @@ ${
             external: Object.keys(externals),
             noExternal: [/three\/examples\/.*/],
             target: 'es2021',
+            define: {
+                PKG_VERSION: `'${pkg.version}'`,
+            },
             esbuildPlugins: [
                 sassPlugin(),
                 externalGlobalPlugin(externals),

packages/autorotate-plugin/package.json

@@ -6,7 +6,7 @@
   "license": "MIT",
   "main": "./src/index.ts",
   "types": "./src/index.ts",
-  "dependencies": {
+  "peerDependencies": {
     "@photo-sphere-viewer/core": "0.0.0"
   },
   "scripts": {

packages/autorotate-plugin/src/AutorotatePlugin.ts

@@ -72,6 +72,7 @@ export class AutorotatePlugin extends AbstractConfigurablePlugin<
     AutorotatePluginEvents
 > {
     static override readonly id = 'autorotate';
+    static override readonly VERSION = PKG_VERSION;
     static override readonly configParser = getConfig;
     static override readonly readonlyOptions: Array<keyof AutorotatePluginConfig> = ['keypoints'];
 

packages/compass-plugin/package.json

@@ -6,12 +6,9 @@
   "license": "MIT",
   "main": "./src/index.ts",
   "types": "./src/index.ts",
-  "dependencies": {
+  "peerDependencies": {
     "@photo-sphere-viewer/core": "0.0.0"
   },
-  "optionalDependencies": {
-    "@photo-sphere-viewer/markers-plugin": "0.0.0"
-  },
   "scripts": {
     "build": "tsup",
     "watch": "tsup --watch",

packages/compass-plugin/src/CompassPlugin.ts

@@ -33,6 +33,7 @@ export class CompassPlugin extends AbstractConfigurablePlugin<
     UpdatableCompassPluginConfig
 > {
     static override readonly id = 'compass';
+    static override readonly VERSION = PKG_VERSION;
     static override readonly configParser = getConfig;
     static override readonly readonlyOptions: Array<keyof CompassPluginConfig> = ['navigation'];
 

packages/core/src/adapters/AbstractAdapter.ts

@@ -2,6 +2,7 @@ import { Mesh, ShaderMaterial, ShaderMaterialParameters } from 'three';
 import { PanoData, PanoDataProvider, PanoramaPosition, Position, TextureData } from '../model';
 import type { Viewer } from '../Viewer';
 import { PSVError } from '../PSVError';
+import { checkVersion } from '../utils';
 
 /**
  * Base class for adapters
@@ -14,6 +15,11 @@ export abstract class AbstractAdapter<TPanorama, TTexture, TData> {
      * Unique identifier of the adapter
      */
     static readonly id: string;
+    /**
+     * Expected version of the core
+     * DO NOT USE on custom adapters
+     */
+    static readonly VERSION: string;
 
     /**
      * Indicates if the adapter supports panorama download natively
@@ -186,6 +192,7 @@ export function adapterInterop(adapter: any): AdapterConstructor & typeof Abstra
     if (adapter) {
         for (const [, p] of [['_', adapter], ...Object.entries(adapter)]) {
             if (p.prototype instanceof AbstractAdapter) {
+                checkVersion(p.id, p.VERSION, PKG_VERSION);
                 return p;
             }
         }

packages/core/src/adapters/EquirectangularAdapter.ts

@@ -64,6 +64,7 @@ const getConfig = getConfigParser<EquirectangularAdapterConfig>(
  */
 export class EquirectangularAdapter extends AbstractAdapter<string, Texture, PanoData> {
     static override readonly id: string = 'equirectangular';
+    static override readonly VERSION = PKG_VERSION;
     static override readonly supportsDownload: boolean = true;
     static override readonly supportsOverlay: boolean = true;
 

packages/core/src/index.ts

@@ -36,6 +36,7 @@ export { PSVError } from './PSVError';
 export { Viewer } from './Viewer';
 export * from './model';
 export { CONSTANTS, events, utils };
+export const VERSION = PKG_VERSION;
 
 /** @internal  */
 import './styles/index.scss';

packages/core/src/plugins/AbstractPlugin.ts

@@ -1,5 +1,5 @@
 import { TypedEvent, TypedEventTarget } from '../lib/TypedEventTarget';
-import { ConfigParser, logWarn } from '../utils';
+import { checkVersion, ConfigParser, logWarn } from '../utils';
 import type { Viewer } from '../Viewer';
 
 /**
@@ -13,6 +13,11 @@ export abstract class AbstractPlugin<
      * Unique identifier of the plugin
      */
     static readonly id: string;
+    /**
+     * Expected version of the core
+     * DO NOT USE on custom plugins
+     */
+    static readonly VERSION: string;
 
     constructor(protected viewer: Viewer) {
         super();
@@ -112,6 +117,7 @@ export function pluginInterop(plugin: any): PluginConstructor & typeof AbstractP
     if (plugin) {
         for (const [, p] of [['_', plugin], ...Object.entries(plugin)]) {
             if (p.prototype instanceof AbstractPlugin) {
+                checkVersion(p.id, p.VERSION, PKG_VERSION);
                 return p;
             }
         }