From 9a46ed70b7feefe2eaf8e06af8438eaab475a0a3 Mon Sep 17 00:00:00 2001 From: PeekabooSteam Date: Sun, 3 Dec 2023 12:24:52 +0000 Subject: [PATCH] Added boilerplate plugin --- client/package-lock.json | 26 ++--- client/package.json | 2 +- .../plugins/_boilerplate/@types/olympus.d.ts | 30 +++++ client/plugins/_boilerplate/copy.bat | 8 ++ .../_boilerplate/images/placeholder1x1.png | Bin 0 -> 928 bytes client/plugins/_boilerplate/package.json | 14 +++ client/plugins/_boilerplate/plugin.json | 7 ++ .../plugins/_boilerplate/src/boilerplate.ts | 27 +++++ client/plugins/_boilerplate/src/index.ts | 5 + client/plugins/_boilerplate/style.css | 0 client/plugins/_boilerplate/tsconfig.json | 104 ++++++++++++++++++ 11 files changed, 209 insertions(+), 14 deletions(-) create mode 100644 client/plugins/_boilerplate/@types/olympus.d.ts create mode 100644 client/plugins/_boilerplate/copy.bat create mode 100644 client/plugins/_boilerplate/images/placeholder1x1.png create mode 100644 client/plugins/_boilerplate/package.json create mode 100644 client/plugins/_boilerplate/plugin.json create mode 100644 client/plugins/_boilerplate/src/boilerplate.ts create mode 100644 client/plugins/_boilerplate/src/index.ts create mode 100644 client/plugins/_boilerplate/style.css create mode 100644 client/plugins/_boilerplate/tsconfig.json diff --git a/client/package-lock.json b/client/package-lock.json index 0b82ed23..bd56581b 100644 --- a/client/package-lock.json +++ b/client/package-lock.json @@ -24,7 +24,7 @@ }, "devDependencies": { "@babel/preset-env": "^7.21.4", - "@tanem/svg-injector": "^10.1.55", + "@tanem/svg-injector": "^10.1.68", "@types/formatcoords": "^1.1.0", "@types/geojson": "^7946.0.10", "@types/leaflet": "^1.9.0", @@ -1715,12 +1715,12 @@ "dev": true }, "node_modules/@babel/runtime": { - "version": "7.21.5", - "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.21.5.tgz", - "integrity": "sha512-8jI69toZqqcsnqGGqwGS4Qb1VwLOEp4hz+CXPywcvjs60u3B4Pom/U/7rm4W8tMOYEB+E9wgD0mW1l3r8qlI9Q==", + "version": "7.23.5", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.23.5.tgz", + "integrity": "sha512-NdUTHcPe4C99WxPub+K9l9tK5/lV4UXIoaHSYgzco9BCyjKAAwzdBI+wWtYqHt7LJdbo74ZjRPJgzVweq1sz0w==", "dev": true, "dependencies": { - "regenerator-runtime": "^0.13.11" + "regenerator-runtime": "^0.14.0" }, "engines": { "node": ">=6.9.0" @@ -2016,14 +2016,14 @@ "dev": true }, "node_modules/@tanem/svg-injector": { - "version": "10.1.55", - "resolved": "https://registry.npmjs.org/@tanem/svg-injector/-/svg-injector-10.1.55.tgz", - "integrity": "sha512-xh8ejdvjDaH1eddZC0CdI45eeid4BIU2ppjNEhiTiWMYcLGT19KWjbES/ttDS4mq9gIAQfXx57g5zimEVohqYA==", + "version": "10.1.68", + "resolved": "https://registry.npmjs.org/@tanem/svg-injector/-/svg-injector-10.1.68.tgz", + "integrity": "sha512-UkJajeR44u73ujtr5GVSbIlELDWD/mzjqWe54YMK61ljKxFcJoPd9RBSaO7xj02ISCWUqJW99GjrS+sVF0UnrA==", "dev": true, "dependencies": { - "@babel/runtime": "^7.21.5", + "@babel/runtime": "^7.23.2", "content-type": "^1.0.5", - "tslib": "^2.5.0" + "tslib": "^2.6.2" } }, "node_modules/@turf/along": { @@ -7673,9 +7673,9 @@ } }, "node_modules/regenerator-runtime": { - "version": "0.13.11", - "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.13.11.tgz", - "integrity": "sha512-kY1AZVr2Ra+t+piVaJ4gxaFaReZVH40AKNo7UCX6W+dEwBo/2oZJzqfuN1qLq1oL45o56cPaTXELwrTh8Fpggg==", + "version": "0.14.0", + "resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.14.0.tgz", + "integrity": "sha512-srw17NI0TUWHuGa5CFGGmhfNIeja30WMBfbslPNhf6JrqQlLN5gcrvig1oqPxiVaXb0oW0XRKtH6Nngs5lKCIA==", "dev": true }, "node_modules/regenerator-transform": { diff --git a/client/package.json b/client/package.json index 1b2ff03a..98541a71 100644 --- a/client/package.json +++ b/client/package.json @@ -30,7 +30,7 @@ }, "devDependencies": { "@babel/preset-env": "^7.21.4", - "@tanem/svg-injector": "^10.1.55", + "@tanem/svg-injector": "^10.1.68", "@types/formatcoords": "^1.1.0", "@types/geojson": "^7946.0.10", "@types/leaflet": "^1.9.0", diff --git a/client/plugins/_boilerplate/@types/olympus.d.ts b/client/plugins/_boilerplate/@types/olympus.d.ts new file mode 100644 index 00000000..555976c2 --- /dev/null +++ b/client/plugins/_boilerplate/@types/olympus.d.ts @@ -0,0 +1,30 @@ +export interface OlympusPlugin { + getName: () => string; + initialize: (any) => boolean; +} + + +export class Marker {} +export class CustomMarker extends Marker {} +export class Unit extends CustomMarker {} + +export class OlympusApp { + getShortcutManager():ShortcutManager; + getUnitsManager():UnitsManager; +} + +export class ShortcutManager { + add( name:string, shortcut:Shortcut ): ShortcutManager; + getKeysBeingHeld(): string[]; + keyComboMatches( combo: string[] ): boolean; + onKeyDown( callback:CallableFunction ); + onKeyUp( callback:CallableFunction ); +} + +export class UnitsManager { + getUnits(): { [ID: number]: Unit } +} + +export declare global { + function getOlympusPlugin(): OlympusPlugin; +} \ No newline at end of file diff --git a/client/plugins/_boilerplate/copy.bat b/client/plugins/_boilerplate/copy.bat new file mode 100644 index 00000000..73b65b51 --- /dev/null +++ b/client/plugins/_boilerplate/copy.bat @@ -0,0 +1,8 @@ +mkdir .\\..\\DCSOlympus\\client\\public\\plugins\\boilerplateplugin + +copy .\\index.js .\\..\\DCSOlympus\\client\\public\\plugins\\boilerplateplugin\\index.js +copy .\\plugin.json .\\..\\DCSOlympus\\client\\public\\plugins\\boilerplateplugin\\plugin.json +copy .\\style.css .\\..\\DCSOlympus\\client\\public\\plugins\\boilerplateplugin\\style.css + +mkdir .\\..\\DCSOlympus\\client\\public\\plugins\\boilerplateplugin\\images +copy .\\images\\*.* .\\..\\DCSOlympus\\client\\public\\plugins\\boilerplateplugin\\images\\ \ No newline at end of file diff --git a/client/plugins/_boilerplate/images/placeholder1x1.png b/client/plugins/_boilerplate/images/placeholder1x1.png new file mode 100644 index 0000000000000000000000000000000000000000..94ac31ebf1a833be2767fef97cf21b43bb22b5e0 GIT binary patch literal 928 zcmaJ=O^ee&7|yyN%ff;e1-&?AK@@BzNxOC@G}bmBHegEW7Pd#z$+QjKWU|TBq&Zb{s>Qk2ibMfZMq(;fysREJkR^Q@4R!->%KhLf3PnI!hzE<`+VLh z#@=oIe|Y!H1)uISYsgOMm}Ooq2v`9 zDGy`L7KBDKk3Bpi42;Mmh;;GCr_Uk?d|f;}a%DF*$Ta9I6LPZb4)Ah@kuNr%gGR1# zfsil{Rf#4Os33%(tU^_-a6~0t zM9j-8QF>S^m?XtX5VL?rpiuNibk1~$j8O*&HDw14eRRUf2|Ijep zpi|Z-H-7&qoDLQ-fqjzFd4l=fjSq`Zv1TO1V>B61dR7*)H>HfGQyK%cDpkSb(;)I` zmOfb#Tvv0Vlz9;*j;V`WLJ9(3Lv~F$GLeOpnyo07g^n%MIzsJdw$W}K8?};aQaley z#7eGz!?m|^i*^WO9@!*G@P_zyLPN01Sqrv%F}CWhx&C%9=2kA`W?*r%f8BI>#M`G> zZd#XbHqB2W-th@~r|2Fz{b=BN`@pebp`+e*3`v>=4@n#&WYkq9M Ge)k8E4IVN8 literal 0 HcmV?d00001 diff --git a/client/plugins/_boilerplate/package.json b/client/plugins/_boilerplate/package.json new file mode 100644 index 00000000..d6a37934 --- /dev/null +++ b/client/plugins/_boilerplate/package.json @@ -0,0 +1,14 @@ +{ + "name": "spawntesterplugin", + "version": "v0.0.1", + "private": true, + "scripts": { + "build": "browserify ./src/index.ts -p [ tsify --noImplicitAny] > index.js && copy.bat" + }, + "devDependencies": { + "@types/sortablejs": "^1.15.4", + "browserify": "^17.0.0", + "sortablejs": "^1.15.0", + "tsify": "^5.0.4" + } +} diff --git a/client/plugins/_boilerplate/plugin.json b/client/plugins/_boilerplate/plugin.json new file mode 100644 index 00000000..8f623404 --- /dev/null +++ b/client/plugins/_boilerplate/plugin.json @@ -0,0 +1,7 @@ +{ + "name": "Boilerplate", + "version": "0.0.1", + "description": "Base plguin starter", + "authorName": "", + "authorContact": "" +} \ No newline at end of file diff --git a/client/plugins/_boilerplate/src/boilerplate.ts b/client/plugins/_boilerplate/src/boilerplate.ts new file mode 100644 index 00000000..629bbc29 --- /dev/null +++ b/client/plugins/_boilerplate/src/boilerplate.ts @@ -0,0 +1,27 @@ +import { OlympusPlugin } from "interfaces"; +import { OlympusApp } from "olympusapp"; + + +export class BoilerplatePlugin implements OlympusPlugin { + #app!: OlympusApp; + + constructor() { + } + + /** + * @param app + * + * @returns boolean on success/fail + */ + + initialize(app: OlympusApp) : boolean { + this.#app = app; + + return true; // Return true on success + } + + getName() { + return "Boilerplate"; + } + +} \ No newline at end of file diff --git a/client/plugins/_boilerplate/src/index.ts b/client/plugins/_boilerplate/src/index.ts new file mode 100644 index 00000000..b1bef5f3 --- /dev/null +++ b/client/plugins/_boilerplate/src/index.ts @@ -0,0 +1,5 @@ +import { BoilerplatePlugin } from "./boilerplate"; + +globalThis.getOlympusPlugin = () => { + return new BoilerplatePlugin(); +} \ No newline at end of file diff --git a/client/plugins/_boilerplate/style.css b/client/plugins/_boilerplate/style.css new file mode 100644 index 00000000..e69de29b diff --git a/client/plugins/_boilerplate/tsconfig.json b/client/plugins/_boilerplate/tsconfig.json new file mode 100644 index 00000000..a445c704 --- /dev/null +++ b/client/plugins/_boilerplate/tsconfig.json @@ -0,0 +1,104 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + /* Language and Environment */ + "target": "ES2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + "rootDirs": ["./src", "./@types"], /* Specify the root folder within your source files. */ + // "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + "typeRoots": [ + "./node_modules/@types", + "@types" + ], /* Specify multiple folders that act like './node_modules/@types'. */ + "types": [ + "olympus" + ], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + /* JavaScript Support */ + "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + }, + "include": [ + "src/*.ts", + "../DCSOlympus/client/@types/olympus/index.d.ts" + ] +} \ No newline at end of file