@lopan/filterchain 1.0.0

package/FilterChain.ts

@@ -0,0 +1,73 @@
+/**
+ * @author afu
+ * @license MIT
+ */
+import type IFilter from './IFilter.ts';
+import type IFilterChain from './IFilterChain.ts';
+import type IResource from './IResource.ts';
+
+/**
+ * Filter chain implementation
+ *
+ * ```
+ * -- req --> |         | -- req --> |         | -- req --> |
+ *            | filter1 |            | filter2 |            | RESOURCE
+ * <-- res -- |         | <-- res -- |         | <-- res -- |
+ * ```
+ */
+export default class FilterChain implements IFilterChain {
+    private resource: IResource | null = null;
+
+    /**
+     * The current position of the filter chain
+     */
+    private position: number = 0;
+
+    /**
+     * The filter collection
+     */
+    private filters: IFilter[] = [];
+
+    /**
+     * @inheritdoc
+     */
+    public async doFilter(payload: unknown): Promise<unknown> {
+        if (this.position >= this.filters.length) {
+            const resource = this.resource;
+            this.clearFilters();
+
+            if(resource === null) {
+                return null;
+            }
+
+            const res = await resource.run(payload);
+            return res;
+        }
+
+        const filter = this.filters[this.position++];
+        return await filter.doFilter(payload, this);
+    }
+
+    /**
+     * Add a filter to the filter chain
+     */
+    public addFilter(filter: IFilter): void {
+        this.filters.push(filter);
+    }
+
+    /**
+     * Clear all filters
+     */
+    public clearFilters(): void {
+        this.position = 0;
+        this.filters = [];
+        this.resource = null;
+    }
+
+    /**
+     * Set the resource
+     */
+    public setResource(resource: IResource | null): void {
+        this.resource = resource;
+    }
+}

package/IFilter.ts

@@ -0,0 +1,19 @@
+/**
+ * @author afu
+ * @license MIT
+ */
+import type IFilterChain from './IFilterChain.ts';
+
+/**
+ * Filter interface
+ *
+ * The class that implements the `doFilter` method considers to be a filter
+ */
+export default interface IFilter {
+    /**
+     * The filter method
+     *
+     * This method needs to call `filterChain.doFilter(payload)` manually to execute the next filter
+     */
+    doFilter(payload: unknown, filterChain: IFilterChain): Promise<unknown>;
+}

package/IFilterChain.ts

@@ -0,0 +1,14 @@
+/**
+ * @author afu
+ * @license MIT
+ */
+
+/**
+ * Filter chain interface
+ */
+export default interface IFilterChain {
+    /**
+     * Invoked the next filter or the resource
+     */
+    doFilter(payload: unknown): Promise<unknown>;
+}

package/IResource.ts

@@ -0,0 +1,14 @@
+/**
+ * @author afu
+ * @license MIT
+ */
+
+/**
+ * Class implementing this interface is a resource class
+ */
+export default interface IResource {
+    /**
+     * Run the resource
+     */
+    run(payload: unknown): Promise<unknown>;
+}

package/README.md

@@ -0,0 +1 @@
+# filter chain

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@lopan/filterchain",
+  "version": "1.0.0",
+  "main": "FilterChain.ts",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "description": ""
+}

package/test/index.ts

@@ -0,0 +1,35 @@
+import FilterChain from '../FilterChain.ts';
+import type IFilter from '../IFilter.ts';
+
+
+class ImgFilter1 implements IFilter {
+    public async doFilter(payload: unknown, filterChain: FilterChain): Promise<unknown> {
+        console.log('ImgFilter1 before');
+        const res = await filterChain.doFilter(payload);
+        console.log('ImgFilter1 after');
+        return res;
+    }
+}
+class ImgFilter2 implements IFilter {
+    public async doFilter(payload: unknown, filterChain: FilterChain): Promise<unknown> {
+        console.log('ImgFilter2 before');
+        const res = await filterChain.doFilter(payload);
+        console.log('ImgFilter2 after');
+        return res;
+    }
+}
+
+
+class Main {
+  static async run() {
+    const chain = new FilterChain()
+    // chain.setResource(null)
+    chain.addFilter(new ImgFilter1())
+    chain.addFilter(new ImgFilter2())
+
+    const res = await chain.doFilter(null)
+    console.log(res)
+  }
+}
+
+Main.run()