template-replacement 3.3.3 → 3.4.0

package/.editorconfig

@@ -0,0 +1,8 @@
+[*.{js,jsx,mjs,cjs,ts,tsx,mts,cts,vue,css,scss,sass,less,styl}]
+charset = utf-8
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+max_line_length = 100

package/.oxfmtrc.jsonc

@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/oxfmt/configuration_schema.json",
+  "semi": false,
+  "singleQuote": true,
+  "ignorePatterns": ["/dist/*", "/node_modules/*"],
+  "printWidth": 80
+}

package/.oxlintrc.json

@@ -0,0 +1,3 @@
+{
+  "ignorePatterns": ["/dist/**", "/node_modules/**"],
+}

package/README.md

@@ -16,6 +16,7 @@ application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
 - ✅ 变量提取
 - ✅ 媒体文件提取
 - ✅ 模板文件加密/替换加密模板（确保文件无法被第三方使用）
+- ✅ 多套变量同时替换
 ##### 待实现功能：
 - 支持PPTX文件进行替换
 - 更多媒体类型替换
@@ -33,7 +34,7 @@ const replaceInstance = tr()
 需要同时替换大量文件时使用
 ``` javascript
 import tr from 'template-replacement'
-const worker = 4 //线程数量
+const worker = 4 //线程数量，建议<=CPU核心数
 const replaceInstance = tr(worker)
 ```
 3、模板替换并校验签名：
@@ -43,7 +44,11 @@ import tr from 'template-replacement'
 
 //  获取函数签名
 async function getSignature(data) {
-  /** 对data数据进行签名处理，可以请求后端获取签名或者通过其他方式生成签名，不要前端直接生成 */
+  /**
+   * 对data数据进行签名处理，
+   * 可以请求后端获取签名或者通过其他方式生成签名，
+   * 不要前端直接生成，避免暴露签名方法
+   */
 }
 
 const replaceInstance = tr(0, getSignature)
@@ -51,7 +56,7 @@ const replaceInstance = tr(0, getSignature)
 4、多线程模板替换并校验签名：
 ``` javascript
 import tr from 'template-replacement'
-const worker = 4 //线程数量
+const worker = 4 //线程数量，建议<=CPU核心数
 const replaceInstance = tr(worker, getSignature)
 ```
 
@@ -73,7 +78,7 @@ type fileName = string
  */
 const tempFile = new temp(file, url, uint8Array, name)
 
-// 2、标记出加密的模板文件，未加密的文件跳过这一步
+// 2、标记出需要解密的模板文件（通过filesEncrypt方法加密后的文件），未加密的文件跳过这一步
 tempFile.isDecode = true
 
 // 3、把模板文件加入到替换任务中
@@ -83,6 +88,7 @@ replaceInstance.addTempFile(tempFile)
 // 4、清除所有模板文件
 replaceInstance.clear()
 ```
+
 ##### 三、批量提取模板中的媒体文件数据（不需要提取媒体文件数据时跳过这一步）
 ``` typescript
 //媒体文件id，同一个媒体文件在一个模板中多次使用或在不同模板中的id相同
@@ -109,6 +115,8 @@ const result: extractVariablesResult = await replaceInstance.extractVariables()
 ```
 
 ##### 五、执行变量替换
+支持单套变量替换和多套变量替换，执行替换前需确保模板文件已经完成添加。
+1、单套变量替换：一套模板文件根据一套变量的数据生成一套文件数据
 ``` typescript
 import paramsData, { textData, mediaData } from 'template-replacement/replace/paramsData'
 import image from 'template-replacement/replace/image'
@@ -128,6 +136,29 @@ const params = new paramsData(texts, medias)
 const result: executeResult = await replaceInstance.execute(params)
 ```
 
+2、多套变量替换：一套模板文件根据多套变量的数据生成多套文件数据
+``` typescript
+import paramsData, { textData, mediaData } from 'template-replacement/replace/paramsData'
+import image from 'template-replacement/replace/image'
+
+//变量值
+type variableValue = string
+type textData = Record<variableName, variableValue|image>
+type mediaData = Record<mediaID, image>
+type executeResult = Record<fileName, Uint8Array>
+
+/**
+ * 替换的变量数据
+ * texts: textData 文本变量数据，将模板中的文本变量替换为指定文本或者媒体数据
+ * medias: mediaData 媒体变量数据，将模板中的媒体文件替换为指定媒体数据
+ */
+const paramsList = [
+  new paramsData(texts, medias),
+  new paramsData(texts1, medias1),
+  new paramsData(texts2, medias2),
+]
+const result: executeResult[] = await replaceInstance.executeMultipleParams(paramsList)
+```
 
 ##### 其他说明
 1、媒体文件替换，目前仅支持图片替换，其他文件类型暂不支持
@@ -150,9 +181,8 @@ media.setPxExtent(width: number, height: number)
 media.setCmExtent(width: number, height: number)
 ```
 
-2、文件加密，需要防止被第三方获取到模板文件的场景可以使用。
+2、文件加密，需要防止被第三方获取到模板文件的场景可以使用（配合class Temp中的isDecode属性进行解码使用）
 ``` typescript
-
 // 加密后的文件数据，按照传入的文件顺序返回
 type filesEncryptResult = Uint8Array[]
 
@@ -165,14 +195,14 @@ const result: filesEncryptResult = await replaceInstance.filesEncrypt(buffers)
 
 3、模板对象部分属性说明
 ``` typescript
-//template-replacement/temp
-class temp {
+//template-replacement/temp/index.ts
+class Temp {
     name: string = '' //文件名
     blob?: File|Blob //文件数据
     uint8Array?: Uint8Array //文件数据
     url?: string //文件下载地址
     status = status.waitLoad // 文件状态 0文件待加载,1文件已加载,2完成替换,3替换失败
-    isDecode: boolean = false //文件是否被加密
+    isDecode: boolean = false //文件是否需要解密
 }
 
 ```

package/core/base.ts

@@ -1,67 +1,66 @@
-export interface Interface {
-    await(): Promise<Interface>
-    add_template(file: Uint8Array, is_decode: boolean): Promise<number>
-    add_media(file: Uint8Array): Promise<string>
-    extract_one_file_variable_names(data: Uint8Array, is_decode: boolean): Promise<(string)[]>
-    extract_variable_names(files: (Uint8Array)[], is_decode: boolean): Promise<(string)[]>
-    extract_one_file_medias(data: Uint8Array, is_decode: boolean): Promise<any>
-    extract_medias(files: (Uint8Array)[], is_decode: boolean): Promise<any>
-    file_encrypt(file: Uint8Array): Promise<Uint8Array>
-    files_encrypt(files: (Uint8Array)[]): Promise<(Uint8Array)[]>
+export interface rawCoreInterface {
+  add_media(file: Uint8Array): string
+  add_template(file_data: Uint8Array, is_decode: boolean): Promise<number>
+  extract_medias(files: Uint8Array[], encode_files: Uint8Array[]): Promise<unknown>
+  extract_one_file_medias(data: Uint8Array, is_decode: boolean): Promise<unknown>
+  extract_one_file_variable_names(
+    data: Uint8Array,
+    is_decode: boolean,
+  ): Promise<string[]>
+  extract_variable_names(
+    files: Uint8Array[],
+    encode_files: Uint8Array[],
+  ): Promise<string[]>
+  file_encrypt(file: Uint8Array): Uint8Array
+  files_encrypt(files: Uint8Array[]): Uint8Array[]
 }
 
-export default class implements Interface {
-    module: any
-    awaitInit: Promise<void>
+type PromisifyAll<T> = {
+  [K in keyof T]: T[K] extends (...args: infer Args) => infer R
+  ? (...args: Args) => R extends Promise<unknown>
+    ? R
+    : Promise<R>
+  : never;
+};
 
-    constructor(init: Promise<any>, module: any) {
-        this.awaitInit = init
-        this.module = module
-    }
+export type AsyncCoreInterface = PromisifyAll<rawCoreInterface>;
 
-    async await(): Promise<Interface> {
-        await this.awaitInit
-        return this
-    }
+export default class implements AsyncCoreInterface {
+  awaitInit: Promise<rawCoreInterface>
 
-    async add_template(file: Uint8Array, is_decode: boolean): Promise<number> {
-        await this.awaitInit
-        return this.module.add_template(file, is_decode)
-    }
+  constructor(init: Promise<rawCoreInterface>) {
+    this.awaitInit = init
+  }
 
-    async add_media(file: Uint8Array): Promise<string> {
-        await this.awaitInit
-        return this.module.add_media(file)
-    }
+  async add_template(file: Uint8Array, is_decode: boolean) {
+    return (await this.awaitInit).add_template(file, is_decode)
+  }
 
-    async extract_one_file_variable_names(data: Uint8Array, is_decode: boolean): Promise<(string)[]> {
-        await this.awaitInit
-        return this.module.extract_one_file_variable_names(data, is_decode)
-    }
+  async add_media(file: Uint8Array) {
+    return (await this.awaitInit).add_media(file)
+  }
 
-    async extract_variable_names(files: (Uint8Array)[], is_decode: boolean): Promise<(string)[]> {
-        await this.awaitInit
-        return this.module.extract_variable_names(files, is_decode)
-    }
+  async extract_one_file_variable_names(data: Uint8Array, is_decode: boolean) {
+    return (await this.awaitInit).extract_one_file_variable_names(data, is_decode)
+  }
 
-    async extract_one_file_medias(data: Uint8Array, is_decode: boolean): Promise<any> {
-        await this.awaitInit
-        return this.module.extract_one_file_medias(data, is_decode)
-    }
+  async extract_variable_names(files: Uint8Array[], encode_files: Uint8Array[]) {
+    return (await this.awaitInit).extract_variable_names(files, encode_files)
+  }
 
-    async extract_medias(files: (Uint8Array)[], is_decode: boolean): Promise<any> {
-        await this.awaitInit
-        return this.module.extract_medias(files, is_decode)
-    }
+  async extract_one_file_medias(data: Uint8Array, is_decode: boolean) {
+    return (await this.awaitInit).extract_one_file_medias(data, is_decode)
+  }
 
-    async file_encrypt(file: Uint8Array): Promise<Uint8Array> {
-        await this.awaitInit
-        return this.module.file_encrypt(file)
-    }
+  async extract_medias(files: Uint8Array[], encode_files: Uint8Array[]) {
+    return (await this.awaitInit).extract_medias(files, encode_files)
+  }
 
-    async files_encrypt(files: (Uint8Array)[]): Promise<(Uint8Array)[]> {
-        await this.awaitInit
-        const res = this.module.files_encrypt(files)
-        return  res
-    }
-}
+  async file_encrypt(file: Uint8Array) {
+    return (await this.awaitInit).file_encrypt(file)
+  }
+
+  async files_encrypt(files: Uint8Array[]) {
+    return (await this.awaitInit).files_encrypt(files)
+  }
+}

package/core/general.ts

@@ -1,13 +1,41 @@
-import init, * as core from 'template-replacement-core-wasm'
-import base from './base'
-export * from 'template-replacement-core-wasm'
+import {
+  replace_batch_multiple_params,
+  replace_batch,
+  add_media,
+  add_template,
+  extract_medias,
+  extract_one_file_medias,
+  extract_one_file_variable_names,
+  extract_variable_names,
+  file_encrypt,
+  files_encrypt,
+} from 'template-replacement-core-wasm'
+import init from 'template-replacement-core-wasm'
+import base, { rawCoreInterface } from './base'
 
-let awaitInit: Promise<any> | undefined
+let awaitInit: Promise<rawCoreInterface> | undefined
 
-export default () => {
-    if (!awaitInit) {
-        awaitInit = init()
-    }
-    return new base(awaitInit as Promise<any>, core)
+export {
+  replace_batch_multiple_params,
+  replace_batch
 }
 
+export default () => {
+  if (!awaitInit) {
+    awaitInit = new Promise((resolve) => {
+      init().then(() => {
+        resolve({
+          add_media,
+          add_template,
+          extract_medias,
+          extract_one_file_medias,
+          extract_one_file_variable_names,
+          extract_variable_names,
+          file_encrypt,
+          files_encrypt,
+        })
+      })
+    })
+  }
+  return new base(awaitInit)
+}

package/core/sign.ts

@@ -1,13 +1,48 @@
-import init, * as core from 'template-replacement-sign-core-wasm'
-import base from './base'
-export * from 'template-replacement-sign-core-wasm'
+import {
+  replace_batch_multiple_params,
+  replace_batch,
+  add_media,
+  add_template,
+  extract_medias,
+  extract_one_file_medias,
+  extract_one_file_variable_names,
+  extract_variable_names,
+  file_encrypt,
+  files_encrypt,
+  replace_params_encode,
+  replace_params_encode_multiple_params,
+} from 'template-replacement-sign-core-wasm'
+import init from 'template-replacement-sign-core-wasm'
+import base, { rawCoreInterface } from './base'
 
-let awaitInit: Promise<any> | undefined
+let awaitInit: Promise<rawCoreInterface> | undefined
+
+export {
+  add_media,
+  add_template,
+  replace_params_encode,
+  replace_params_encode_multiple_params,
+  replace_batch_multiple_params,
+  replace_batch
+}
 
 export default () => {
-    if (!awaitInit) {
-        awaitInit = init()
-    }
-    return new base(awaitInit as Promise<any>, core)
+  if (!awaitInit) {
+    awaitInit = new Promise((resolve) => {
+      init().then(() => {
+        resolve({
+          add_media,
+          add_template,
+          extract_medias,
+          extract_one_file_medias,
+          extract_one_file_variable_names,
+          extract_variable_names,
+          file_encrypt,
+          files_encrypt,
+        })
+      })
+    })
+  }
+  return new base(awaitInit)
 }
 

package/dispatcher/general.ts

@@ -1,6 +1,7 @@
 import ReplaceInterface from '../replace/interface'
+// import replace from '../replace/general'
 import replace from '../dist/replace/general'
 
 export default (): ReplaceInterface => {
-    return new replace()
+  return new replace()
 }

package/dispatcher/sign.ts

@@ -1,6 +1,7 @@
 import ReplaceInterface from '../replace/interface'
+// import replace from '../replace/sign'
 import replace from '../dist/replace/sign'
 
 export default (): ReplaceInterface => {
-    return new replace()
+  return new replace()
 }

package/dispatcher/workerGeneral.ts

@@ -4,5 +4,5 @@ import WorkerReplace from '../worker/main'
 import replace from '../dist/main/general'
 
 export default (concurrency?: number): ReplaceInterface => {
-    return new WorkerReplace(new replace(concurrency))
+  return new WorkerReplace(new replace(concurrency))
 }

package/dispatcher/workerSign.ts

@@ -4,5 +4,5 @@ import WorkerReplace from '../worker/main'
 import replace from '../dist/main/sign'
 
 export default (concurrency?: number): ReplaceInterface => {
-    return new WorkerReplace(new replace(concurrency))
+  return new WorkerReplace(new replace(concurrency))
 }

package/dist/base-DQz39fXI.js

@@ -0,0 +1,249 @@
+class y {
+  // 构造函数
+  constructor() {
+    this._initFinishCallBackFuns = [], this.#t = !1, this.#e = "template_replacement_db", this.#n = 1, this.#a = "template_files", this.#s();
+  }
+  #t;
+  #e;
+  #n;
+  #a;
+  #s() {
+    return this._init ? this._init : (this._init = new Promise((t, e) => {
+      const a = indexedDB.open(this.#e, this.#n);
+      a.onsuccess = (s) => {
+        if (this._db = a.result, this.#t = !0, this._initFinishCallBackFuns) {
+          try {
+            for (const n of this._initFinishCallBackFuns)
+              n();
+          } catch {
+          }
+          this._initFinishCallBackFuns = void 0;
+        }
+        t(s);
+      }, a.onerror = (s) => {
+        console.error(s), e(s);
+      }, a.onupgradeneeded = (s) => {
+        let n = a.result;
+        n.objectStoreNames.contains(this.#a) || n.createObjectStore(this.#a, {
+          keyPath: "key"
+          // 设置主键
+        }), t(s);
+      };
+    }), this._init);
+  }
+  async awaitInit() {
+    this.#t || !this._initFinishCallBackFuns || await new Promise((t, e) => {
+      this._initFinishCallBackFuns?.push(t);
+    });
+  }
+  closeDB() {
+    this._db?.close();
+  }
+  async store(t) {
+    return await this.awaitInit(), this._db.transaction(this.#a, t).objectStore(this.#a);
+  }
+  /**
+   * @description : 更新数据
+   * @param        {templateData} params 添加到数据库中的数据 { key: 文件key, data: 文件blob }
+   * @return       {*}
+   */
+  putData(t) {
+    return new Promise((e, a) => {
+      this.store("readwrite").then((s) => {
+        const n = s.put(t);
+        n.onsuccess = (i) => {
+          e(i);
+        }, n.onerror = (i) => {
+          a(i);
+        };
+      }).catch(a);
+    });
+  }
+  // 通过主键读取数据
+  getDataByKey(t) {
+    return new Promise((e, a) => {
+      this.store().then((s) => {
+        const n = s.get(t);
+        n.onsuccess = () => {
+          e(n.result);
+        }, n.onerror = (i) => {
+          a(i);
+        };
+      }).catch(a);
+    });
+  }
+  // 通过主键移除数据
+  deleteDataByKey(t) {
+    return new Promise((e, a) => {
+      this.store().then((s) => {
+        const n = s.delete(t);
+        n.onsuccess = () => {
+          e(n.result);
+        }, n.onerror = (i) => {
+          a(i);
+        };
+      }).catch(a);
+    });
+  }
+  // 清空数据库数据
+  clearDB() {
+    return new Promise((t, e) => {
+      this.store("readwrite").then((a) => {
+        const s = a.clear();
+        s.onsuccess = (n) => {
+          t(n);
+        }, s.onerror = (n) => {
+          e(n);
+        };
+      }).catch(e);
+    });
+  }
+}
+new y();
+var d = /* @__PURE__ */ ((r) => (r.word = "word", r.excel = "excel", r.unknown = "unknown", r))(d || {});
+async function f(r = []) {
+  const t = [];
+  for (const a of r)
+    t.push(a.getBuffer());
+  await Promise.all(t);
+  const e = {
+    decode: {
+      names: [],
+      uint8Arrays: []
+    },
+    noDecode: {
+      names: [],
+      uint8Arrays: []
+    }
+  };
+  for (const a of r)
+    a.uint8Array && (a.isDecode ? (e.decode.names.push(a.name), e.decode.uint8Arrays.push(a.uint8Array)) : (e.noDecode.names.push(a.name), e.noDecode.uint8Arrays.push(a.uint8Array)));
+  return e;
+}
+class _ {
+  #t = [];
+  #e;
+  constructor(t) {
+    this.#e = t;
+  }
+  addTempFile(t) {
+    this.#t.push(t);
+  }
+  clear() {
+    this.#t.length = 0;
+  }
+  //提取单个文件内的所有变量
+  async extractOneFileVariables(t, e) {
+    const a = await e.getBuffer();
+    a && (await e.type() === d.unknown && !e.isDecode || (t[e.name] = await this.#e.extract_one_file_variable_names(
+      a,
+      e.isDecode
+    )));
+  }
+  //提取多个文件内的所有变量
+  async extractVariables(t) {
+    t || (t = this.#t);
+    const e = {}, a = [];
+    for (const s of t)
+      a.push(this.extractOneFileVariables(e, s));
+    return await Promise.allSettled(a), e;
+  }
+  //提取单个文件内的所有媒体文件
+  async extractOneFileMedias(t, e) {
+    const a = await e.getBuffer();
+    if (!a || await e.type() === d.unknown && !e.isDecode)
+      return;
+    const s = await this.#e.extract_one_file_medias(
+      a,
+      e.isDecode
+    );
+    if (t[e.name] = [], !!Array.isArray(s))
+      for (const { id: n, data: i } of s)
+        n && i && t[e.name].push({
+          id: n,
+          data: new Uint8Array(i)
+        });
+  }
+  //提取多个文件内的所有媒体文件
+  async extractMedias(t) {
+    t || (t = this.#t);
+    const e = {}, a = [];
+    for (const s of t)
+      a.push(this.extractOneFileMedias(e, s));
+    return await Promise.all(a), e;
+  }
+  async handle(t, e, a) {
+    return [];
+  }
+  async handleMultipleParams(t, e, a) {
+    return [];
+  }
+  async sign(t) {
+    return "";
+  }
+  async execute(t, e) {
+    const { noDecode: a, decode: s } = await f(e ?? this.#t), n = await this.handle(t, a.uint8Arrays, s.uint8Arrays), i = {};
+    let o = 0;
+    for (const c of a.names)
+      i[c] = n[o++] ?? new Uint8Array();
+    for (const c of s.names)
+      i[c] = n[o++] ?? new Uint8Array();
+    return i;
+  }
+  async executeMultipleParams(t, e) {
+    const { noDecode: a, decode: s } = await f(e ?? this.#t), n = await this.handleMultipleParams(t, a.uint8Arrays, s.uint8Arrays), i = Array(t.length);
+    let o = 0;
+    for (let c = 0; c < t.length; c++) {
+      const h = {};
+      for (const l of a.names) {
+        const u = n[o++];
+        u.length && (h[l] = u);
+      }
+      for (const l of s.names) {
+        const u = n[o++];
+        u.length && (h[l] = u);
+      }
+      i[c] = h;
+    }
+    return i;
+  }
+  async fileEncrypt(t) {
+    return this.#e.file_encrypt(t);
+  }
+  async filesEncrypt(t) {
+    return this.#e.files_encrypt(t);
+  }
+}
+class m {
+  constructor(t) {
+    this.awaitInit = t;
+  }
+  async add_template(t, e) {
+    return (await this.awaitInit).add_template(t, e);
+  }
+  async add_media(t) {
+    return (await this.awaitInit).add_media(t);
+  }
+  async extract_one_file_variable_names(t, e) {
+    return (await this.awaitInit).extract_one_file_variable_names(t, e);
+  }
+  async extract_variable_names(t, e) {
+    return (await this.awaitInit).extract_variable_names(t, e);
+  }
+  async extract_one_file_medias(t, e) {
+    return (await this.awaitInit).extract_one_file_medias(t, e);
+  }
+  async extract_medias(t, e) {
+    return (await this.awaitInit).extract_medias(t, e);
+  }
+  async file_encrypt(t) {
+    return (await this.awaitInit).file_encrypt(t);
+  }
+  async files_encrypt(t) {
+    return (await this.awaitInit).files_encrypt(t);
+  }
+}
+export {
+  _ as B,
+  m as b
+};