@faicad/faijs-extra 0.16.0

package/dist/ops/text.js

@@ -0,0 +1,101 @@
+/**
+ * stdlib text — 文字创建库函数（text）
+ *
+ *
+ * dispatchPath 静态判定 brep/mesh，产物经 solid()/fromBrep() 构造器创建。
+ */
+import { text as meshText } from '../mesh/primitives.js';
+import { solidToShape } from '@faicad/faijs/brep/brep-ops';
+import { textToSolid } from '@faicad/faijs/brep/text/text-to-solid';
+import { ensureDefaultFont } from '@faicad/faijs/brep/text/fontRegistry';
+import { getSolidBoundingBox } from '@faicad/faijs/brep/brep-utils';
+import { containsCjk, loadSystemCjkFont } from '@faicad/faijs/primitives/text/cjk-font';
+import { getBackends } from '@faicad/faijs/runtime-state';
+import { fromBrep } from '@faicad/faijs/shape';
+import { defineOp } from '@faicad/faijs/sdk';
+import { assertPositiveNumber } from '@faicad/faijs/api/assert';
+/**
+ * Validate text parameters: `text` must be a non-empty string, and `size` and
+ * `depth` must be positive numbers.
+ * @param params - the raw text operation parameters.
+ */
+export function assertTextParams(params) {
+    if (typeof params.text !== 'string' || params.text.trim() === '') {
+        throw new Error(`[stdlib/text] text must be a non-empty string, got ${JSON.stringify(params.text)}`);
+    }
+    assertPositiveNumber(params.size, 'text.size');
+    assertPositiveNumber(params.depth, 'text.depth');
+}
+/**
+ * BREP 路径：opentype.js → OCCT wire/face → extrude → center + fromBrep 登记。
+ *
+ * 与 mesh 路径一样，当文本包含 CJK 字符但没有 CJK 字体时，
+ * 将 CJK 字符替换为 '?' 以实现优雅降级。
+ */
+async function textBrep(params) {
+    const kernel = getBackends().kernel.brep;
+    if (!kernel)
+        throw new Error('[stdlib/text] no OCCT kernel');
+    await ensureDefaultFont();
+    const text = params.text;
+    const size = params.size;
+    const depth = params.depth;
+    // 如果文本包含 CJK 字符，检查是否有 CJK 字体
+    let renderText = text;
+    if (containsCjk(text)) {
+        const cjkResult = await loadSystemCjkFont();
+        if (!cjkResult) {
+            // 无 CJK 字体：将 CJK 字符替换为 '?' 以实现优雅降级
+            renderText = text.replace(/[\u4E00-\u9FFF\u3400-\u4DBF\u2F800-\u2FA1F\u3000-\u303F\uFF00-\uFFEF]/g, '?');
+        }
+    }
+    // 将文字转换为 OCCT solid
+    const rawSolid = textToSolid(kernel, renderText, {
+        fontSize: size,
+        depth,
+    });
+    // Center the solid to match mesh path behavior:
+    // X/Z centered at origin, Y bottom aligned to 0
+    const bbox = getSolidBoundingBox(kernel, rawSolid);
+    const cx = (bbox.min[0] + bbox.max[0]) / 2;
+    const cz = (bbox.min[2] + bbox.max[2]) / 2;
+    const centeredSolid = kernel.translate(rawSolid, -cx, -bbox.min[1], -cz);
+    kernel.release(rawSolid);
+    return fromBrep(solidToShape(kernel, centeredSolid), { solid: centeredSolid });
+}
+/** 兼容两种调用形态：`cad.text({ text, size, depth })`（创建类）与
+ * `cad.text(part0, { text, size, depth })`（历史 fixture 带输入参数，输入被忽略）。 */
+function textParamsOf(inputOrParams, maybeParams) {
+    return (maybeParams ?? inputOrParams ?? {});
+}
+/**
+ * 生成文字零件（文字轮廓挤出，X/Z 居中、Y 底部对齐原点）。
+ * @group 创建
+ * @inputs 0
+ * @async true
+ * @qual warn
+ * @name text
+ * @returns Shape 文字几何，生成独立零件。
+ * @param maybeParams - 兼容形态的补充参数（正常不传）。type:Record<string, unknown> required:false
+ * @param inputOrParams.text - 要生成的文字。type:string required:true
+ * @param inputOrParams.size - 字号（mm）。type:number required:true
+ * @param inputOrParams.depth - 挤出深度（mm）。type:number required:true
+ * @param inputOrParams.font - 字体。type:string 默认 默认字体
+ * @note font 语义未定（当前只有默认字体），⚠️ 暂不要传。兼容 `cad.text(part0, {...})` 带输入形态（输入被忽略），正常写 `cad.text({...})` 即可。
+ * @example
+ * const t = await cad.text({ text: 'Hello', size: 20, depth: 5 })
+  */
+export const text = defineOp({
+    mesh: async (inputOrParams, maybeParams) => {
+        const params = textParamsOf(inputOrParams, maybeParams);
+        assertTextParams(params);
+        return meshText({ text: params.text, size: params.size, depth: params.depth });
+    },
+    brep: async (inputOrParams, maybeParams) => {
+        const params = textParamsOf(inputOrParams, maybeParams);
+        assertTextParams(params);
+        return textBrep(params);
+    },
+    naming: { kind: 'construct', newFaces: { via: 'explicit', vocab: [] } },
+});
+//# sourceMappingURL=text.js.map

package/dist/ops/text.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.js","sourceRoot":"","sources":["../../src/ops/text.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,IAAI,IAAI,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAA;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAA;AACvF,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAA;AAG/D;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAA+B;IAC9D,IAAI,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACjE,MAAM,IAAI,KAAK,CAAC,sDAAsD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACtG,CAAC;IACD,oBAAoB,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;IAC9C,oBAAoB,CAAC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;AAClD,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,QAAQ,CAAC,MAA+B;IACrD,MAAM,MAAM,GAAG,WAAW,EAAE,CAAC,MAAM,CAAC,IAA4B,CAAA;IAChE,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;IAE5D,MAAM,iBAAiB,EAAE,CAAA;IAEzB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAc,CAAA;IAClC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAc,CAAA;IAClC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAe,CAAA;IAEpC,6BAA6B;IAC7B,IAAI,UAAU,GAAG,IAAI,CAAA;IACrB,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,MAAM,SAAS,GAAG,MAAM,iBAAiB,EAAE,CAAA;QAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,mCAAmC;YACnC,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,wEAAwE,EAAE,GAAG,CAAC,CAAA;QAC1G,CAAC;IACH,CAAC;IAED,oBAAoB;IACpB,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE;QAC/C,QAAQ,EAAE,IAAI;QACd,KAAK;KACN,CAAC,CAAA;IAEF,gDAAgD;IAChD,gDAAgD;IAChD,MAAM,IAAI,GAAG,mBAAmB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IAClD,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IAC1C,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IAC1C,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;IACxE,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAExB,OAAO,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAA;AAChF,CAAC;AAED;uEACuE;AACvE,SAAS,YAAY,CAAC,aAAsB,EAAE,WAAqC;IACjF,OAAO,CAAC,WAAW,IAAI,aAAa,IAAI,EAAE,CAA4B,CAAA;AACxE,CAAC;AAED;;;;;;;;;;;;;;;;IAgBI;AACJ,MAAM,CAAC,MAAM,IAAI,GAAG,QAAQ,CAAC;IAC3B,IAAI,EAAE,KAAK,EAAE,aAAsB,EAAE,WAAqC,EAAE,EAAE;QAC5E,MAAM,MAAM,GAAG,YAAY,CAAC,aAAa,EAAE,WAAW,CAAC,CAAA;QACvD,gBAAgB,CAAC,MAAM,CAAC,CAAA;QACxB,OAAO,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAc,EAAE,IAAI,EAAE,MAAM,CAAC,IAAc,EAAE,KAAK,EAAE,MAAM,CAAC,KAAe,EAAE,CAAC,CAAA;IAC9G,CAAC;IACD,IAAI,EAAE,KAAK,EAAE,aAAsB,EAAE,WAAqC,EAAE,EAAE;QAC5E,MAAM,MAAM,GAAG,YAAY,CAAC,aAAa,EAAE,WAAW,CAAC,CAAA;QACvD,gBAAgB,CAAC,MAAM,CAAC,CAAA;QACxB,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAA;IACzB,CAAC;IACD,MAAM,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,EAAgB;CACtF,CAAC,CAAA","sourcesContent":["/**\n * stdlib text — 文字创建库函数（text）\n *\n *\n * dispatchPath 静态判定 brep/mesh，产物经 solid()/fromBrep() 构造器创建。\n */\n\nimport type { Shape } from '@faicad/faijs/mesh/types'\nimport { text as meshText } from '../mesh/primitives'\nimport { solidToShape } from '@faicad/faijs/brep/brep-ops'\nimport { textToSolid } from '@faicad/faijs/brep/text/text-to-solid'\nimport { ensureDefaultFont } from '@faicad/faijs/brep/text/fontRegistry'\nimport { getSolidBoundingBox } from '@faicad/faijs/brep/brep-utils'\nimport { containsCjk, loadSystemCjkFont } from '@faicad/faijs/primitives/text/cjk-font'\nimport { getBackends } from '@faicad/faijs/runtime-state'\nimport { fromBrep } from '@faicad/faijs/shape'\nimport { defineOp } from '@faicad/faijs/sdk'\nimport type { Provenance } from '@faicad/faijs/topology/naming/lineage'\nimport { assertPositiveNumber } from '@faicad/faijs/api/assert'\nimport type { BrepEngineApi } from '@faicad/faijs/brep/engine/primitives'\n\n/**\n * Validate text parameters: `text` must be a non-empty string, and `size` and\n * `depth` must be positive numbers.\n * @param params - the raw text operation parameters.\n */\nexport function assertTextParams(params: Record<string, unknown>): void {\n  if (typeof params.text !== 'string' || params.text.trim() === '') {\n    throw new Error(`[stdlib/text] text must be a non-empty string, got ${JSON.stringify(params.text)}`)\n  }\n  assertPositiveNumber(params.size, 'text.size')\n  assertPositiveNumber(params.depth, 'text.depth')\n}\n\n/**\n * BREP 路径：opentype.js → OCCT wire/face → extrude → center + fromBrep 登记。\n *\n * 与 mesh 路径一样，当文本包含 CJK 字符但没有 CJK 字体时，\n * 将 CJK 字符替换为 '?' 以实现优雅降级。\n */\nasync function textBrep(params: Record<string, unknown>): Promise<Shape> {\n  const kernel = getBackends().kernel.brep as BrepEngineApi | null\n  if (!kernel) throw new Error('[stdlib/text] no OCCT kernel')\n\n  await ensureDefaultFont()\n\n  const text = params.text as string\n  const size = params.size as number\n  const depth = params.depth as number\n\n  // 如果文本包含 CJK 字符，检查是否有 CJK 字体\n  let renderText = text\n  if (containsCjk(text)) {\n    const cjkResult = await loadSystemCjkFont()\n    if (!cjkResult) {\n      // 无 CJK 字体：将 CJK 字符替换为 '?' 以实现优雅降级\n      renderText = text.replace(/[\\u4E00-\\u9FFF\\u3400-\\u4DBF\\u2F800-\\u2FA1F\\u3000-\\u303F\\uFF00-\\uFFEF]/g, '?')\n    }\n  }\n\n  // 将文字转换为 OCCT solid\n  const rawSolid = textToSolid(kernel, renderText, {\n    fontSize: size,\n    depth,\n  })\n\n  // Center the solid to match mesh path behavior:\n  // X/Z centered at origin, Y bottom aligned to 0\n  const bbox = getSolidBoundingBox(kernel, rawSolid)\n  const cx = (bbox.min[0] + bbox.max[0]) / 2\n  const cz = (bbox.min[2] + bbox.max[2]) / 2\n  const centeredSolid = kernel.translate(rawSolid, -cx, -bbox.min[1], -cz)\n  kernel.release(rawSolid)\n\n  return fromBrep(solidToShape(kernel, centeredSolid), { solid: centeredSolid })\n}\n\n/** 兼容两种调用形态：`cad.text({ text, size, depth })`（创建类）与\n * `cad.text(part0, { text, size, depth })`（历史 fixture 带输入参数，输入被忽略）。 */\nfunction textParamsOf(inputOrParams: unknown, maybeParams?: Record<string, unknown>): Record<string, unknown> {\n  return (maybeParams ?? inputOrParams ?? {}) as Record<string, unknown>\n}\n\n/**\n * 生成文字零件（文字轮廓挤出，X/Z 居中、Y 底部对齐原点）。\n * @group 创建\n * @inputs 0\n * @async true\n * @qual warn\n * @name text\n * @returns Shape 文字几何，生成独立零件。\n * @param maybeParams - 兼容形态的补充参数（正常不传）。type:Record<string, unknown> required:false\n * @param inputOrParams.text - 要生成的文字。type:string required:true\n * @param inputOrParams.size - 字号（mm）。type:number required:true\n * @param inputOrParams.depth - 挤出深度（mm）。type:number required:true\n * @param inputOrParams.font - 字体。type:string 默认 默认字体\n * @note font 语义未定（当前只有默认字体），⚠️ 暂不要传。兼容 `cad.text(part0, {...})` 带输入形态（输入被忽略），正常写 `cad.text({...})` 即可。\n * @example\n * const t = await cad.text({ text: 'Hello', size: 20, depth: 5 })\n  */\nexport const text = defineOp({\n  mesh: async (inputOrParams: unknown, maybeParams?: Record<string, unknown>) => {\n    const params = textParamsOf(inputOrParams, maybeParams)\n    assertTextParams(params)\n    return meshText({ text: params.text as string, size: params.size as number, depth: params.depth as number })\n  },\n  brep: async (inputOrParams: unknown, maybeParams?: Record<string, unknown>) => {\n    const params = textParamsOf(inputOrParams, maybeParams)\n    assertTextParams(params)\n    return textBrep(params)\n  },\n  naming: { kind: 'construct', newFaces: { via: 'explicit', vocab: [] } } as Provenance,\n})\n"]}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@faicad/faijs-extra",
+  "version": "0.16.0",
+  "description": "Editor extension library for faijs — fai_* ops, group/assembly/copy/load, and the svg / 3D-text creators",
+  "keywords": [
+    "faijs",
+    "cad",
+    "editor",
+    "svg",
+    "text",
+    "three"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitcode.com/Faicad/faijs.git"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./browser": {
+      "types": "./dist/browser.d.ts",
+      "default": "./dist/browser.js"
+    },
+    "./editor-ops": {
+      "types": "./dist/editor-ops.d.ts",
+      "default": "./dist/editor-ops.js"
+    }
+  },
+  "files": [
+    "dist",
+    "NOTICE",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "opentype.js": "^1.3.4"
+  },
+  "peerDependencies": {
+    "@faicad/faijs": "^0.16.0",
+    "three": "^0.162.0 || ^0.184.0"
+  },
+  "devDependencies": {
+    "typescript": "*",
+    "vitest": "*",
+    "three": "^0.184.0",
+    "@types/three": "^0.184.1"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && node ../../scripts/fix-import-extensions.mjs dist",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "lint": "eslint src"
+  }
+}