@cosmicds/vue-toolkit 0.1.0

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 cosmicds
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@cosmicds/vue-toolkit",
+  "version": "0.1.0",
+  "browser": "dist/index.umd.js",
+  "dependencies": {
+    "@fortawesome/fontawesome-svg-core": "^6.5.1",
+    "@fortawesome/free-solid-svg-icons": "^6.5.1",
+    "@fortawesome/vue-fontawesome": "^3.0.3",
+    "@kyvg/vue3-notification": "^2.9.1",
+    "@mdi/font": "^7.4.47",
+    "@wwtelescope/engine-pinia": "^0.9.0",
+    "leaflet": "^1.9.4",
+    "screenfull": "^6.0.2",
+    "vue": "^3",
+    "vuetify": "^3.3.3"
+  },
+  "devDependencies": {
+    "@types/leaflet": "^1.9.3",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
+    "@vue/cli-plugin-eslint": "^5.0.8",
+    "@vue/cli-plugin-typescript": "^5.0.8",
+    "@vue/cli-service": "^5.0.8",
+    "@vue/eslint-config-typescript": "^12.0.0",
+    "copy-webpack-plugin": "^12.0.2",
+    "eslint": "^8.31.0",
+    "eslint-plugin-vue": "^9.8.0",
+    "less": "^4.2.0",
+    "less-loader": "^12.1.0",
+    "typescript": "^4.9.4",
+    "vue-template-compiler": "^2.7.14",
+    "webpack": "^5.75.0"
+  },
+  "files": [
+    "dist/*",
+    "src/*"
+  ],
+  "main": "./dist/index.common.js",
+  "module": "dist/",
+  "packageManager": "yarn@3.3.0",
+  "publicConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vue-cli-service build --target lib --name index src/index.ts",
+    "clean": "rimraf dist",
+    "lint": "vue-cli-service lint src --no-fix"
+  },
+  "types": "./dist/src/index.d.ts"
+}

package/src/background.ts

@@ -0,0 +1,31 @@
+export class BackgroundImageset {
+  public imagesetName: string;
+  public displayName: string;
+
+  constructor(displayName: string, imagesetName: string) {
+    this.displayName = displayName;
+    this.imagesetName = imagesetName;
+  }
+}
+
+export const skyBackgroundImagesets: BackgroundImageset[] = [
+  new BackgroundImageset(
+    "Optical (Terapixel DSS)",
+    "Digitized Sky Survey (Color)"
+  ),
+  new BackgroundImageset(
+    "Low-frequency radio (VLSS)",
+    "VLSS: VLA Low-frequency Sky Survey (Radio)"
+  ),
+  new BackgroundImageset("Infrared (2MASS)", "2Mass: Imagery (Infrared)"),
+  new BackgroundImageset("Infrared (SFD dust map)", "SFD Dust Map (Infrared)"),
+  new BackgroundImageset("Ultraviolet (GALEX)", "GALEX (Ultraviolet)"),
+  new BackgroundImageset(
+    "X-Ray (ROSAT RASS)",
+    "RASS: ROSAT All Sky Survey (X-ray)"
+  ),
+  new BackgroundImageset(
+    "Gamma Rays (FERMI LAT 8-year)",
+    "Fermi LAT 8-year (gamma)"
+  ),
+];

package/src/index.ts

@@ -0,0 +1,29 @@
+import { KeyboardControlSettings } from "./keyboard";
+import MiniDSBase from "./components/MiniDSBase";
+import IconButton from "./components/IconButton.vue";
+import LocationSelector from "./components/LocationSelector.vue";
+import DefaultMiniCredits from "./components/DefaultMiniCredits.vue";
+import FundingAcknowledgment from "./components/FundingAcknowledgment.vue";
+import CreditLogos from "./components/CreditLogos.vue";
+import wwtHUD from "./components/wwtHUD.vue";
+import { BackgroundImageset, skyBackgroundImagesets } from "./background";
+import Gallery from "./components/Gallery.vue";
+import { API_BASE_URL, MINIDS_BASE_URL, R2D, D2R } from "./utils";
+
+export {
+  BackgroundImageset,
+  KeyboardControlSettings,
+  MiniDSBase,
+  Gallery,
+  IconButton,
+  LocationSelector,
+  skyBackgroundImagesets,
+  DefaultMiniCredits,
+  FundingAcknowledgment,
+  CreditLogos,
+  wwtHUD,
+  API_BASE_URL,
+  MINIDS_BASE_URL,
+  R2D,
+  D2R
+};

package/src/keyboard.ts

@@ -0,0 +1,84 @@
+class KeyPressInfo {
+  code: string;
+  ctrl: boolean;
+  alt: boolean;
+  shift: boolean;
+  meta: boolean;
+
+  constructor(
+    code: string,
+    modifiers?: {
+      ctrl?: boolean;
+      alt?: boolean;
+      shift?: boolean;
+      meta?: boolean;
+    }
+  ) {
+    this.code = code;
+    this.ctrl = modifiers?.ctrl ?? false;
+    this.alt = modifiers?.alt ?? false;
+    this.shift = modifiers?.shift ?? false;
+    this.meta = modifiers?.meta ?? false;
+  }
+
+  matches(event: KeyboardEvent): boolean {
+    return (
+      event.code === this.code &&
+      event.ctrlKey === this.ctrl &&
+      event.altKey === this.alt &&
+      event.shiftKey === this.shift &&
+      event.metaKey === this.meta
+    );
+  }
+}
+
+export class KeyboardControlSettings {
+  zoomIn: KeyPressInfo[];
+  zoomOut: KeyPressInfo[];
+  moveUp: KeyPressInfo[];
+  moveDown: KeyPressInfo[];
+  moveLeft: KeyPressInfo[];
+  moveRight: KeyPressInfo[];
+  moveAmount: number;
+
+  constructor({
+    zoomIn = [new KeyPressInfo("KeyI")],
+    zoomOut = [new KeyPressInfo("KeyO")],
+    moveUp = [new KeyPressInfo("KeyW")],
+    moveLeft = [new KeyPressInfo("KeyA")],
+    moveDown = [new KeyPressInfo("KeyS")],
+    moveRight =[new KeyPressInfo("KeyD")],
+    moveAmount = 20
+  }) {
+    this.zoomIn = zoomIn;
+    this.zoomOut = zoomOut;
+    this.moveUp = moveUp;
+    this.moveDown = moveDown;
+    this.moveLeft = moveLeft;
+    this.moveRight = moveRight;
+    this.moveAmount = moveAmount;
+  }
+
+  // This is to make sure that we can't make a listener for an action type that doesn't exist
+  readonly actionTypes = [
+    "zoomIn",
+    "zoomOut",
+    "moveUp",
+    "moveDown",
+    "moveLeft",
+    "moveRight",
+  ] as const;
+  
+  makeListener(
+    actionName: KeyboardControlSettings["actionTypes"][number],
+    action: () => void
+  ): (e: KeyboardEvent) => void {
+    return (e) => {
+      for (const keyPress of this[actionName]) {
+        if (keyPress.matches(e)) {
+          action();
+        }
+      }
+    };
+  }
+}

package/src/shims-vue.d.ts

@@ -0,0 +1,5 @@
+declare module "*.vue" {
+  import { defineComponent } from "vue";
+  const component: ReturnType<typeof defineComponent>;
+  export default component;
+}

package/src/utils.ts

@@ -0,0 +1,5 @@
+export const D2R = Math.PI / 180;
+export const R2D = 180 / Math.PI;
+
+export const API_BASE_URL = "https://api.cosmicds.cfa.harvard.edu";
+export const MINIDS_BASE_URL = `${API_BASE_URL}/minids`;