web-background 0.0.1

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

package/README.md

@@ -0,0 +1,57 @@
+# Web Background
+This module is implemented as a web walker and is available in web browsers.  
+해당 모듈은 웹 워커로 구현되며 브라우저에서 사용할 수 있습니다. 
+
+It runs in an isolated environment and cannot be referenced by external variables and external module.  
+격리된 환경에서 실행되므로 외부의 변수에 참조하지 못합니다.
+
+In most cases, this module is not required.
+Recommended for long task  
+대부분의 경우 이 모듈을 사용할 필요는 없으나, long task를 처리해야 할 경우 사용할 것을 추천합니다. 
+
+Most WebAPIs including DOM APIs are cannot be used Becuase they are run in Web Worker.  
+WebWorker에서 실행되므로 DOM API를 포함한 WebAPI를 사용하지 못합니다.  
+
+## Example
+
+**worker**
+```ts
+async function runLongTask () {
+  const getCoordinate = background((imageData: ImageData) => {
+    const { data, width } = imageData;
+
+    let [
+      minX, minY, 
+      maxX, maxY
+    ] = [Infinity, Infinity, 0, 0];
+
+    for(let i = 0, leng = data.length; i < leng; i += 4) {
+      const [r, g, b, a] = data.slice(i, i+4);
+      const isFilled = Math.max(r, g, b, a) > 0;
+      
+      if(isFilled) {
+        const y = Math.floor(i / 4 / width);
+        const x = Math.floor(i / 4 - width * y);
+
+        minX = Math.min(minX, x);
+        maxX = Math.max(maxX, x);
+
+        minY = Math.min(minY, y);
+        maxY = Math.max(maxY, y);
+      }
+    }
+
+    return { 
+      x: minX === Infinity ? 0 : minX, 
+      width: maxX, 
+      y: minY === Infinity ? 0 : minY, 
+      height: maxY,
+    };
+  })
+
+  const coordiate = await getCoordinate(
+    canvas.getContext('2d').getImageData(0, 0, 1000, 1000)
+  )
+}
+```
+

package/dist/background.d.ts

@@ -0,0 +1,7 @@
+type ReturnFn<ReturnValue> = () => ReturnValue;
+type ReturnFnWithPayload<Payload, ReturnValue> = (payload: Payload) => ReturnValue;
+export declare function background<Payload = never, ReturnValue = void>(fn: (payload: Payload) => ReturnValue): {
+    (): Promise<ReturnValue>;
+    (payload: Payload): Promise<ReturnValue>;
+} | (Payload extends never ? ReturnFn<Promise<ReturnValue>> : ReturnFnWithPayload<Payload, Promise<ReturnValue>>);
+export {};

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { background } from './background';

package/dist/index.js

@@ -0,0 +1,97 @@
+class TypedWorker extends Worker {
+    postMessage(payload) {
+        super.postMessage(payload);
+    }
+    addEventListener(type, observer) {
+        super.addEventListener(type, observer);
+    }
+}
+
+class UtilWorker extends TypedWorker {
+    constructor(scriptURL, options) {
+        super(scriptURL, options);
+    }
+    subscribe(observer) {
+        const onMessage = (event) => {
+            observer(event.data);
+        };
+        this.addEventListener('message', onMessage);
+        return () => {
+            this.removeEventListener('message', onMessage);
+        };
+    }
+    request(payload) {
+        return new Promise(resolve => {
+            const onMessage = ({ data }) => {
+                resolve(data);
+                this.removeEventListener('message', onMessage);
+            };
+            this.postMessage(payload);
+            this.addEventListener('message', onMessage);
+        });
+    }
+}
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol */
+
+
+function __rest(s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+class WorkerBuilder {
+    static fromModule(Worker, _a) {
+        var { module } = _a, options = __rest(_a, ["module"]);
+        const code = `
+        self.addEventListener('message', event => {
+          const result = (${module.toString()})(event.data);
+          
+          self.postMessage(result);
+        });
+      `.trim();
+        const blob = new Blob([code]);
+        return new Worker(URL.createObjectURL(blob), options);
+    }
+}
+
+function background(fn) {
+    function createWorker() {
+        return WorkerBuilder.fromModule((UtilWorker), { module: fn, type: 'module' });
+    }
+    if (typeof window === 'undefined') {
+        function runWithCreatingWorker(payload) {
+            return createWorker().request(payload);
+        }
+        return runWithCreatingWorker;
+    }
+    return createWorker().request;
+}
+
+export { background };

package/dist/modules/TypedWorker.d.ts

@@ -0,0 +1,7 @@
+export interface TypedMessageEvent<Data = any> extends MessageEvent {
+    data: Data;
+}
+export declare class TypedWorker<Payload, Response> extends Worker {
+    postMessage<T = Payload>(payload: T): void;
+    addEventListener<R = Response>(type: 'message' | 'error' | 'messageerror', observer: (this: Worker, event: TypedMessageEvent<R>) => void): void;
+}

package/dist/modules/UtilWorker.d.ts

@@ -0,0 +1,7 @@
+import { TypedWorker } from "./TypedWorker";
+export declare class UtilWorker<Payload = never, Result = void> extends TypedWorker<Payload, Result> {
+    constructor(scriptURL: string | URL, options?: WorkerOptions);
+    subscribe(observer: (response: Result) => void): () => void;
+    request(): Promise<Result>;
+    request(payload: Payload): Promise<Result>;
+}

package/dist/modules/WorkerBuilder.d.ts

@@ -0,0 +1,11 @@
+interface WorkerConstructor<Worker> {
+    new (scriptURL: string | URL, options?: WorkerOptions): Worker;
+    prototype: Worker;
+}
+interface Options extends WorkerOptions {
+    module: (...args: any[]) => any;
+}
+export declare class WorkerBuilder {
+    static fromModule<W extends Worker>(Worker: WorkerConstructor<W>, { module, ...options }: Options): W;
+}
+export {};

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "web-background",
+  "description": "Running background in browser Worker",
+  "keywords": [
+    "Web Worker",
+    "Worker",
+    "Background"
+  ],
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "type": "module",
+  "license": "MIT",
+  "scripts": {
+    "build": "rollup -c"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.23.3",
+    "@babel/preset-env": "^7.23.3",
+    "@rollup/plugin-babel": "^6.0.4",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "rollup": "^4.4.0",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "typescript": "5.2"
+  },
+  "dependencies": {}
+}