tgui-core 1.0.0

package/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{js,json,yml}]
+charset = utf-8
+indent_style = space
+indent_size = 2

package/.eslintrc.cjs

@@ -0,0 +1,78 @@
+/** @type {import("eslint").Linter.Config} */
+const config = {
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: true,
+  },
+  plugins: [
+    "@typescript-eslint",
+    "eslint-plugin-simple-import-sort",
+    "eslint-plugin-sort-destructure-keys",
+    "eslint-plugin-typescript-sort-keys",
+    "unused-imports",
+    "react",
+    "react-hooks",
+  ],
+  extends: [
+    "plugin:@typescript-eslint/recommended-type-checked",
+    "plugin:@typescript-eslint/stylistic-type-checked",
+    "plugin:react/jsx-runtime",
+    "plugin:react-hooks/recommended",
+    "prettier",
+  ],
+  rules: {
+    "@typescript-eslint/array-type": "off",
+    "@typescript-eslint/consistent-type-definitions": ["error", "type"],
+    "@typescript-eslint/prefer-destructuring": "error",
+    "@typescript-eslint/consistent-type-imports": [
+      "warn",
+      {
+        prefer: "type-imports",
+        fixStyle: "inline-type-imports",
+      },
+    ],
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-floating-promises": "off",
+    "@typescript-eslint/no-unsafe-argument": "off",
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-unsafe-enum-comparison": "off",
+    "@typescript-eslint/no-unsafe-member-access": "off",
+    "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
+    "@typescript-eslint/require-await": "off",
+    "@typescript-eslint/no-misused-promises": [
+      "error",
+      {
+        checksVoidReturn: { attributes: false },
+      },
+    ],
+    "prefer-destructuring": "off",
+    "react-hooks/exhaustive-deps": "off",
+    "react/jsx-sort-props": [
+      "error",
+      {
+        ignoreCase: true,
+      },
+    ],
+
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error",
+    "sort-destructure-keys/sort-destructure-keys": [
+      1,
+      { caseSensitive: false },
+    ],
+    "typescript-sort-keys/interface": "error",
+    "typescript-sort-keys/string-enum": "error",
+    "unused-imports/no-unused-imports": "error",
+    "unused-imports/no-unused-vars": [
+      "error",
+      {
+        vars: "all",
+        varsIgnorePattern: "^_",
+        args: "after-used",
+        argsIgnorePattern: "^_",
+      },
+    ],
+  },
+};
+
+module.exports = config;

package/.gitattributes

@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated

package/.prettierrc.yml

@@ -0,0 +1 @@
+singleQuote: true

package/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "arcanis.vscode-zipfs",
+    "esbenp.prettier-vscode"
+  ]
+}

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  }
+}

package/README.md

@@ -0,0 +1 @@
+# tgui-core

package/global.d.ts

@@ -0,0 +1,173 @@
+/**
+ * @file
+ * @copyright 2021 Aleksej Komarov
+ * @license MIT
+ */
+
+// Webpack asset modules.
+// Should match extensions used in webpack config.
+declare module "*.png" {
+  const content: string;
+  export default content;
+}
+
+declare module "*.jpg" {
+  const content: string;
+  export default content;
+}
+
+declare module "*.svg" {
+  const content: string;
+  export default content;
+}
+
+namespace JSX {
+  interface IntrinsicElements {
+    marquee: any;
+    blink: any;
+  }
+}
+
+type TguiMessage = {
+  type: string;
+  payload?: any;
+  [key: string]: any;
+};
+
+type ByondType = {
+  /**
+   * ID of the Byond window this script is running on.
+   * Can be used as a parameter to winget/winset.
+   */
+  windowId: string;
+
+  /**
+   * If `true`, unhandled errors and common mistakes result in a blue screen
+   * of death, which stops this window from handling incoming messages and
+   * closes the active instance of tgui datum if there was one.
+   *
+   * It can be defined in window.initialize() in DM, or changed in runtime
+   * here via this property to `true` or `false`.
+   *
+   * It is recommended that you keep this ON to detect hard to find bugs.
+   */
+  strictMode: boolean;
+
+  /**
+   * Makes a BYOND call.
+   *
+   * If path is empty, this will trigger a Topic call.
+   * You can reference a specific object by setting the "src" parameter.
+   *
+   * See: https://secure.byond.com/docs/ref/skinparams.html
+   */
+  call(path: string, params: object): void;
+
+  /**
+   * Makes an asynchronous BYOND call. Returns a promise.
+   */
+  callAsync(path: string, params: object): Promise<any>;
+
+  /**
+   * Makes a Topic call.
+   *
+   * You can reference a specific object by setting the "src" parameter.
+   */
+  topic(params: object): void;
+
+  /**
+   * Runs a command or a verb.
+   */
+  command(command: string): void;
+
+  /**
+   * Retrieves all properties of the BYOND skin element.
+   *
+   * Returns a promise with a key-value object containing all properties.
+   */
+  winget(id: string | null): Promise<object>;
+
+  /**
+   * Retrieves all properties of the BYOND skin element.
+   *
+   * Returns a promise with a key-value object containing all properties.
+   */
+  winget(id: string | null, propName: "*"): Promise<object>;
+
+  /**
+   * Retrieves an exactly one property of the BYOND skin element,
+   * as defined in `propName`.
+   *
+   * Returns a promise with the value of that property.
+   */
+  winget(id: string | null, propName: string): Promise<any>;
+
+  /**
+   * Retrieves multiple properties of the BYOND skin element,
+   * as defined in the `propNames` array.
+   *
+   * Returns a promise with a key-value object containing listed properties.
+   */
+  winget(id: string | null, propNames: string[]): Promise<object>;
+
+  /**
+   * Assigns properties to BYOND skin elements in bulk.
+   */
+  winset(props: object): void;
+
+  /**
+   * Assigns properties to the BYOND skin element.
+   */
+  winset(id: string | null, props: object): void;
+
+  /**
+   * Sets a property on the BYOND skin element to a certain value.
+   */
+  winset(id: string | null, propName: string, propValue: any): void;
+
+  /**
+   * Parses BYOND JSON.
+   *
+   * Uses a special encoding to preserve `Infinity` and `NaN`.
+   */
+  parseJson(text: string): any;
+
+  /**
+   * Sends a message to `/datum/tgui_window` which hosts this window instance.
+   */
+  sendMessage(type: string, payload?: any): void;
+  sendMessage(message: TguiMessage): void;
+
+  /**
+   * Subscribe to incoming messages that were sent from `/datum/tgui_window`.
+   */
+  subscribe(listener: (type: string, payload: any) => void): void;
+
+  /**
+   * Subscribe to incoming messages *of some specific type*
+   * that were sent from `/datum/tgui_window`.
+   */
+  subscribeTo(type: string, listener: (payload: any) => void): void;
+
+  /**
+   * Loads a stylesheet into the document.
+   */
+  loadCss(url: string): void;
+
+  /**
+   * Loads a script into the document.
+   */
+  loadJs(url: string): void;
+};
+
+/**
+ * Object that provides access to Byond Skin API and is available in
+ * any tgui application.
+ */
+const Byond: ByondType;
+
+interface Window {
+  Byond: ByondType;
+  __store__: Store<unknown, AnyAction>;
+  __augmentStack__: (store: Store) => StackAugmentor;
+}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "tgui-core",
+  "version": "1.0.0",
+  "description": "TGUI core component library",
+  "main": "index.js",
+  "keywords": [
+    "TGUI",
+    "library",
+    "typescript"
+  ],
+  "author": "jlsnow301",
+  "license": "MIT",
+  "dependencies": {
+    "@popperjs/core": "^2.11.8",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-popper": "^2.3.0"
+  },
+  "packageManager": "pnpm@9.1.2+sha512.127dc83b9ea10c32be65d22a8efb4a65fb952e8fefbdfded39bdc3c97efc32d31b48b00420df2c1187ace28c921c902f0cb5a134a4d032b8b5295cbfa2c681e2",
+  "devDependencies": {
+    "@types/node": "^20.12.12",
+    "@types/react": "^18.3.3",
+    "@types/react-dom": "^18.3.0"
+  }
+}

package/src/assets.ts

@@ -0,0 +1,43 @@
+/**
+ * @file
+ * @copyright 2020 Aleksej Komarov
+ * @license MIT
+ */
+
+import { Action, AnyAction, Dispatch, Middleware } from './common/redux';
+
+const EXCLUDED_PATTERNS = [/v4shim/i];
+const loadedMappings: Record<string, string> = {};
+
+export const resolveAsset = (name: string): string =>
+  loadedMappings[name] || name;
+
+export const assetMiddleware: Middleware =
+  (storeApi) =>
+  <ActionType extends Action = AnyAction>(next: Dispatch<ActionType>) =>
+  (action: ActionType) => {
+    const { type, payload } = action as AnyAction;
+    if (type === 'asset/stylesheet') {
+      Byond.loadCss(payload);
+      return;
+    }
+    if (type === 'asset/mappings') {
+      for (const name of Object.keys(payload)) {
+        // Skip anything that matches excluded patterns
+        if (EXCLUDED_PATTERNS.some((regex) => regex.test(name))) {
+          continue;
+        }
+        const url = payload[name];
+        const ext = name.split('.').pop();
+        loadedMappings[name] = url;
+        if (ext === 'css') {
+          Byond.loadCss(url);
+        }
+        if (ext === 'js') {
+          Byond.loadJs(url);
+        }
+      }
+      return;
+    }
+    next(action);
+  };