bc-deeplib 1.0.6 → 1.1.0

package/lib/build.js

@@ -0,0 +1,236 @@
+#!/usr/bin/env node
+// @ts-check
+
+import { exec } from 'child_process';
+import { watch } from 'chokidar';
+import { build } from 'esbuild';
+import progress from 'esbuild-plugin-progress';
+import time from 'esbuild-plugin-time';
+import { existsSync, readFileSync, readdirSync, mkdirSync, copyFileSync } from 'fs';
+import path, { dirname } from 'path';
+import simpleGit from 'simple-git';
+import { fileURLToPath, pathToFileURL } from 'url';
+import { promisify } from 'util';
+import http from 'http';
+import serveStatic from 'serve-static';
+import finalhandler from 'finalhandler';
+
+const execAsync = promisify(exec);
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+/**
+ * @param {import('./build').BuildConfig} config 
+ * @returns {Required<import('./build').BuildConfig>}
+ */
+export function defineConfig(config) {
+  return {
+    entry: 'index.ts',
+    outfile: 'index.js',
+    distDirName: 'dist',
+    publicDirName: 'public',
+    scripts: [],
+    target: [],
+    plugins: [],
+    defines: {},
+    host: 'localhost',
+    port: 45000,
+    ...config
+  };
+}
+
+async function runDeeplibBuild() {
+  const configPath = path.resolve(process.cwd(), 'deeplib.config.js');
+
+  if (!existsSync(configPath)) {
+    console.error('❌ Missing deeplib.config.js in project root');
+    process.exit(1);
+  }
+
+  const { default: config } = await import(pathToFileURL(configPath).toString());
+  await buildMod(config);
+}
+
+/**
+ * @param {Required<import('./build').BuildConfig>} config 
+ */
+async function buildMod({
+  entry,
+  outfile,
+  globalName,
+  distDirName,
+  publicDirName,
+  scripts,
+  prodRemoteURL,
+  devRemoteURL,
+  target,
+  plugins,
+  defines,
+  host,
+  port
+}) {
+  const cliLocal = !process.env.environment;
+  const cliWatch = process.argv.includes('--watch') || process.argv.includes('-w');
+  const cliServe = process.argv.includes('--serve') || process.argv.includes('-s');
+  const cliLibLocal = process.argv.includes('--lib-local') || process.argv.includes('-l');
+  const cliAllowDebug = process.argv.includes('--debug') || process.argv.includes('-d');
+
+  const envMode = process.env.environment || 'production';
+  const mode = cliLocal ? 'local' : envMode;
+
+  const isDev = mode === 'development';
+  const isLocal = mode === 'local';
+  const isWatch = cliWatch;
+  const isServe = cliServe;
+  const IS_DEVEL = isDev || isLocal;
+
+  const remotePath = isDev ? devRemoteURL : prodRemoteURL;
+  const localPath = `http://${host}:${port}`;
+  const PUBLIC_URL = `${isLocal ? localPath : remotePath}/${publicDirName}`;
+
+  const packageJsonPath = path.resolve(process.cwd(), 'package.json');
+  const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+
+  const git = simpleGit({ baseDir: process.cwd() });
+  const LAST_COMMIT_HASH = await git.log({ maxCount: 1 });
+  const VERSION_HASH = LAST_COMMIT_HASH?.latest?.hash.substring(0, 8);
+
+  /** @type {import('esbuild').BuildOptions} */
+  const buildOptions = {
+    entryPoints: [`src/${entry}`],
+    outfile: `${distDirName}/${outfile}`,
+    format: 'iife',
+    globalName,
+    bundle: true,
+    sourcemap: true,
+    target,
+    treeShaking: true,
+    keepNames: true,
+    define: {
+      PUBLIC_URL: JSON.stringify(PUBLIC_URL),
+      MOD_VERSION: JSON.stringify(packageJson.version),
+      VERSION_HASH: JSON.stringify(VERSION_HASH),
+      IS_DEVEL: JSON.stringify(IS_DEVEL),
+      IS_DEBUG: JSON.stringify(cliAllowDebug),
+      ...defines
+    },
+    plugins: [progress(), time(), ...plugins],
+  };
+  
+  /** @type {NodeJS.Timeout | null} */
+  let buildTimeout = null;
+  const DEBOUNCE_MS = 100; // Adjust as needed
+
+  function debounceRunBuild() {
+    if (buildTimeout) clearTimeout(buildTimeout);
+    buildTimeout = setTimeout(runBuild, DEBOUNCE_MS);
+  }
+
+  async function runBuild() {
+    const assetsSrc = path.resolve(__dirname, '../dist/public');
+    const assetsDest = path.resolve(process.cwd(), distDirName, publicDirName);
+
+    await build(buildOptions);
+    copyMatchingFiles(assetsSrc, assetsDest);
+
+    for (const script of scripts) {
+      try {
+        const { stdout } = await execAsync(`node ${script}`);
+        console.log(stdout);
+      } catch (err) {
+        console.error(err);
+      }
+    }
+  }
+
+  await runBuild();
+    
+  if (isLocal) {
+
+    if (isWatch) {
+      const watchDirs = ['./src', `./${publicDirName}`];
+      if (cliLibLocal) {
+        watchDirs.push('./node_modules/bc-deeplib/dist/deeplib.js');
+        watchDirs.push('./node_modules/bc-deeplib/dist/public/**/*');
+      }
+      const watcher = watch(watchDirs, {
+        ignoreInitial: true
+      });
+      watcher.on('change', debounceRunBuild);
+      console.info('🔭 Watching for changes...');
+    }
+    
+    if (isServe) {
+      try {
+        serveWithCORS(distDirName, port, host);
+      } catch (err) {
+        console.error(err);
+      }
+    }
+  }
+}
+
+/**
+ * @param {string} dir 
+ * @param {number} port 
+ * @param {string} host 
+ */
+function serveWithCORS(dir, port, host) {
+  const serve = serveStatic(dir, {
+    setHeaders: (res) => {
+      res.setHeader('Access-Control-Allow-Origin', '*');
+    }
+  });
+
+  const server = http.createServer((req, res) => {
+    serve(req, res, finalhandler(req, res));
+  });
+
+  server.listen(port, host, () => {
+    console.log(`🌐 Server running at http://${host}:${port}`);
+  });
+}
+
+/**
+ * @param {string} inputDir
+ * @param {string} outputDir
+ */
+function copyMatchingFiles(inputDir, outputDir) {
+  if (!existsSync(inputDir)) {
+    console.warn(`⚠️ ${relativeToProject(inputDir)} is not found.`);
+    return;
+  }
+
+  const extensions = ['html', 'js', 'css', 'json', 'png', 'jpg', 'jpeg', 'gif', 'svg', 'lang'];
+
+  if (!existsSync(outputDir)) {
+    mkdirSync(outputDir, { recursive: true });
+  }
+
+  const items = readdirSync(inputDir, { withFileTypes: true });
+
+  for (const item of items) {
+    const srcPath = path.join(inputDir, item.name);
+    const destPath = path.join(outputDir, item.name);
+
+    if (item.isDirectory()) {
+      copyMatchingFiles(srcPath, destPath);
+    } else if (item.isFile()) {
+      const ext = path.extname(item.name).slice(1).toLowerCase();
+      if (extensions.includes(ext)) {
+        copyFileSync(srcPath, destPath);
+      }
+    }
+  }
+  console.info(`📁 Copied assets from ${relativeToProject(inputDir)} to ${relativeToProject(outputDir)}`);
+}
+
+/**
+ * @param {string} absolutePath
+ */
+function relativeToProject(absolutePath) {
+  return path.relative(process.cwd(), absolutePath);
+}
+
+runDeeplibBuild();

package/package.json

@@ -1,40 +1,57 @@
 {
   "name": "bc-deeplib",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "author": "dDeepLb",
-  "description": "Package for easier development of BC mods without need to repeat myself in every mod",
+  "description": "Library for easier development of BC mods, which strives to be a framework :D",
   "license": "MIT",
   "type": "module",
   "files": [
-    ".types",
-    "public",
-    "dist"
+    "/dist",
+    "lib",
+    "CREDITS.md",
+    "README.md"
   ],
-  "main": "./dist/deeplib.js",
+  "types": "./dist/deeplib.d.ts",
+  "exports": {
+    "./deeplib": {
+      "import": "./dist/deeplib.js"
+    },
+    "./build": {
+      "import": "./lib/build.js"
+    }
+  },
+  "bin": {
+    "deeplib": "./lib/build.js",
+    "serve-static": "^2.2.0",
+    "simple-git": "^3.28.0",
+    "finalhandler": "^2.1.0",
+    "fs-extra": "^11.3.0",
+    "chokidar": "^4.0.3",
+    "esbuild": "^0.25.1",
+    "esbuild-plugin-progress": "^1.3.0",
+    "esbuild-plugin-time": "^1.0.0",
+    "esbuild-sass-plugin": "^3.3.1"
+  },
   "devDependencies": {
-    "@eslint/js": "^9.16.0",
-    "@stylistic/eslint-plugin": "^2.11.0",
-    "@types/node": "^22.5.4",
-    "bc-stubs": "^110.0.0",
-    "copy-webpack-plugin": "^12.0.2",
-    "cross-env": "^7.0.3",
-    "css-loader": "^7.1.2",
-    "eslint": "^9.16.0",
-    "globals": "^15.13.0",
-    "terser-webpack-plugin": "^5.3.10",
-    "ts-loader": "^9.5.1",
-    "typescript": "^5.7.2",
-    "typescript-eslint": "^8.17.0",
-    "webpack": "^5.97.1",
-    "webpack-cli": "^5.1.4",
-    "webpack-dev-server": "^5.1.0"
+    "@eslint/js": "^9.22.0",
+    "@stylistic/eslint-plugin": "^4.2.0",
+    "@types/node": "^22.13.10",
+    "bc-stubs": "117.0.1",
+    "eslint": "^9.22.0",
+    "globals": "^16.3.0",
+    "npm-dts": "^1.3.13",
+    "sass": "^1.89.2",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.26.1"
   },
   "dependencies": {
     "bondage-club-mod-sdk": "^1.2.0"
   },
   "scripts": {
+    "all": "pnpm build && pnpm type-gen && pnpm asset-copy",
     "lint": "eslint src/",
-    "build": "cross-env TS_NODE_PROJECT=\"tsconfig.webpack.json\" webpack --env prod --fail-on-warnings",
-    "dev": "cross-env TS_NODE_PROJECT=\"tsconfig.webpack.json\" webpack serve --progress"
+    "build": "node scripts/build.js",
+    "type-gen": "node scripts/type_gen.js",
+    "asset-copy": "node scripts/asset_copy.js"
   }
 }

package/.types/declarations.d.ts

@@ -1,15 +0,0 @@
-interface Window {
-  RibbonMenuMods?: string[];
-}
-
-declare const serverUrl: string;
-
-declare module '*.css' {
-  const value: string;
-  export = value;
-}
-
-declare module '*.html' {
-  const value: string;
-  export = value;
-}

package/.types/elements.d.ts

@@ -1,38 +0,0 @@
-export type SettingElement = Button | Checkbox | Input | Label;
-
-export type BaseElementModel = {
-  id: string;
-  size?: [width: number, height: number];
-  position?: [x: number, y: number];
-  disabled?: boolean;
-};
-
-export type Button = BaseElementModel & {
-  type: 'button';
-  image?: string;
-  label?: string;
-  tooltip?: string;
-  onClick: () => void;
-};
-
-export type Checkbox = BaseElementModel & {
-  type: 'checkbox';
-  label: string;
-  description: string;
-  getSettingValue: () => boolean;
-  setSettingValue: (val: boolean) => void;
-};
-
-export type Input = BaseElementModel & {
-  type: 'text' | 'number';
-  label: string;
-  description: string;
-  getElementValue: () => string;
-  setSettingValue: (val: string) => void;
-};
-
-export type Label = BaseElementModel & {
-  type: 'label';
-  label: string;
-  description?: string;
-};

package/.types/type-override.d.ts

@@ -1,3 +0,0 @@
-interface PlayerCharacter {
-  [key: string]: any;
-}

package/dist/public/styles/DeepLib.css

@@ -1,206 +0,0 @@
-.deeplib-subscreen {
-  --deeplib-background-color: var(--main, white);
-  --deeplib-element-color: var(--element, white);
-  --deeplib-element-hover-color: var(--accentHover, cyan);
-  --deeplib-text-color: var(--text, black);
-  --deeplib-icon-color: var(--accent, white);
-  --deeplib-border-color: var(--accent, black);
-}
-
-/************/
-/* ELEMENTS */
-/************/
-
-.deeplib-text {
-  color: var(--deeplib-text-color);
-}
-
-.deeplib-subscreen {
-  padding: 0;
-  margin: 0;
-}
-
-.deeplib-subscreen * {
-  box-sizing: border-box;
-}
-
-.deeplib-settings {
-  display: flex;
-  flex-direction: column;
-  padding: min(1.0dvh, 0.5dvw);
-  gap: 0.3em;
-  overflow-y: auto;
-}
-
-.deeplib-misc {
-  display: flex;
-  align-items: center;
-  justify-content: space-between;
-  flex-direction: column-reverse;
-}
-
-.deeplib-button.button-styling {
-  border-radius: min(1.0dvh, 0.5dvw);
-  color: var(--deeplib-text-color);
-}
-
-.deeplib-button.button-styling img {
-  position: absolute;
-  top: 0%;
-  left: 0%;
-  width: 100%;
-  height: 100%;
-  background-position: left;
-  background-color: var(--deeplib-icon-color);
-  background-blend-mode: multiply;
-  background-size: contain;
-  mask-position: left;
-  mask-size: contain;
-  background-repeat: no-repeat;
-  mask-repeat: no-repeat;
-  color: transparent;
-
-  background-image: var(--image);
-  mask-image: var(--image);
-}
-
-.deeplib-button.button-styling .button-label {
-  width: 100%;
-  background-color: transparent;
-  color: var(--deeplib-text-color);
-  font-size: min(3.6dvh, 1.8dvw);
-}
-
-#deeplib-subscreen-title {
-  text-align: center;
-  color: var(--deeplib-text-color);
-}
-
-#deeplib-reset-button {
-  background-color: indianred;
-}
-
-#deeplib-wiki-button {
-  background-color: #BDA203;
-}
-
-#deeplib-support-button {
-  background-color: #5e4969;
-}
-
-.deeplib-checkbox-container {
-  display: flex;
-  flex-direction: row;
-  align-items: center;
-  gap: 0.3em;
-}
-
-.deeplib-input {
-  border-radius: min(1.0dvh, 0.5dvw);
-}
-
-.deeplib-input-container {
-  position: relative;
-  margin-top: min(1vh, 0.5vw);
-}
-
-.deeplib-input-container input.deeplib-input {
-  font-size: 20px;
-  width: 100%;
-  padding: 5px 0;
-  background-color: transparent;
-  outline: none;
-  padding-left: min(1vh, 0.5vw);
-  padding-right: min(1vh, 0.5vw);
-}
-
-.deeplib-input-container label.deeplib-text {
-  position: absolute;
-  top: min(0.6vh, 0.3vw);
-  left: min(0.6vh, 0.3vw);
-  transition: all 0.3s ease;
-  pointer-events: none;
-}
-
-.deeplib-input-container input.deeplib-input:focus~label,
-.deeplib-input-container input.deeplib-input:not(:placeholder-shown)~label {
-  font-size: 0.7em;
-  transform: translate(20%, -70%);
-  background-color: var(--deeplib-background-color);
-  padding: 0px min(1vh, 0.5vw);
-}
-
-.deeplib-input-container .deeplib-underline {
-  position: absolute;
-  bottom: 0;
-  left: 0;
-  height: 2px;
-  width: 100%;
-  background-color: var(--deeplib-element-hover-color);
-  transform: scaleX(0);
-  transition: all 0.3s ease;
-}
-
-.deeplib-input-container input.deeplib-input:focus~.deeplib-underline,
-.deeplib-input-container input.deeplib-input:not(:placeholder-shown)~.deeplib-underline {
-  transform: scaleX(0.98);
-}
-
-.deeplib-tooltip {
-  background-color: var(--deeplib-element-color);
-  color: var(--deeplib-text-color);
-  display: flex;
-  align-items: center;
-  justify-content: center;
-  border-radius: min(1.0dvh, 0.5dvw);
-  padding: min(1vh, 0.5vw);
-  font-size: 0.8em;
-  border: min(0.2vh, 0.1vw) solid var(--deeplib-border-color);
-}
-
-input::-webkit-outer-spin-button,
-input::-webkit-inner-spin-button {
-  -webkit-appearance: none;
-  margin: 0;
-}
-
-input[type=number] {
-  appearance: textfield;
-  -moz-appearance: textfield;
-}
-
-/*************/
-/* MESSAGES */
-/*************/
-
-.deeplib-highlight-text {
-  font-weight: bold;
-  color: rgb(203, 185, 23);
-}
-
-#TextAreaChatLog[data-colortheme='dark'] div.ChatMessage.deeplib-message,
-#TextAreaChatLog[data-colortheme='dark2'] div.ChatMessage.deeplib-message {
-  background-color: var(--deeplib-element-color);
-  border: min(0.2dvh, 0.1dvw) solid var(--deeplib-border-color);
-  color: var(--deeplib-text-color);
-}
-
-#TextAreaChatLog div.ChatMessage.deeplib-message {
-  background-color: #eee;
-  border: min(0.2dvh, 0.1dvw) solid #440171;
-  color: #111;
-  padding-left: min(0.6dvh, 0.3dvw);
-  display: block;
-  white-space: normal;
-}
-
-#TextAreaChatLog[data-colortheme='dark'] div.ChatMessage.deeplib-message a,
-#TextAreaChatLog[data-colortheme='dark2'] div.ChatMessage.deeplib-message a {
-  color: var(--deeplib-text-color);
-}
-
-#TextAreaChatLog div.ChatMessage.deeplib-message a {
-  cursor: pointer;
-  font-weight: bold;
-  color: #111;
-}

package/dist/public/styles/Gratitude.css

@@ -1,23 +0,0 @@
-#deeplib-gratitude {
-  position: fixed;
-  width: 25%;
-  height: 50%;
-  top: 15%;
-  left: 50%;
-}
-
-#deeplib-gratitude h1 {
-  font-size: 1em;
-  color: var(--text, #333);
-}
-
-#deeplib-gratitude p {
-  font-size: 0.6em;
-  color: var(--text, #555);
-  line-height: 1.5;
-}
-
-#deeplib-gratitude p:last-child {
-  font-size: 0.8em;
-  color: var(--text, #ff69b4);
-}