@faicad/faijs-fcstd 0.17.0

package/dist/unpack.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unpack.d.ts","sourceRoot":"","sources":["../src/unpack.ts"],"names":[],"mappings":"AAUA,OAAO,EAAW,KAAK,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,gEAAgE;IAChE,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,KAAK,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACjC,4EAA4E;IAC5E,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GACpC;IAAE,IAAI,EAAE,iBAAiB,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAEjD;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC,YAAY,EAAE,WAAW,CAAC,CAkB/E;AAiBD;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAIlF"}

package/dist/unpack.js

@@ -0,0 +1,64 @@
+/**
+ * M1.1 — FCStd container unpacking.
+ *
+ * Validation rules per plan §5.5.6 (corrected): a file is an FCStd iff it opens
+ * as a ZIP and contains `Document.xml` at its root. The ZIP comment is advisory
+ * only and must never cause rejection.
+ *
+ * faijs contract: unit mm, errors via Result (ok/err).
+ */
+import { unzipSync } from 'fflate';
+import { err, ok } from '@faicad/faijs/api/result';
+/**
+ * Unpack an FCStd file. Only requirement: valid ZIP + root `Document.xml`.
+ *
+ * @param data - the raw FCStd file bytes.
+ * @returns the unpacked archive, or a structured UnpackError.
+ */
+export function unpackFcstd(data) {
+    let entries;
+    try {
+        entries = unzipSync(data);
+    }
+    catch (e) {
+        return err({
+            kind: 'not-zip',
+            message: `cannot open as ZIP: ${e instanceof Error ? e.message : String(e)}`,
+        });
+    }
+    if (!('Document.xml' in entries)) {
+        return err({ kind: 'no-document-xml', message: 'root Document.xml not found in ZIP' });
+    }
+    // fflate does not expose the raw ZIP comment through unzipSync; read it
+    // directly from the EOCD record (22 bytes from end when comment is empty,
+    // else longer). Advisory only — never used for validation.
+    const comment = readZipComment(data) ?? '';
+    return ok({ members: new Map(Object.entries(entries)), zipComment: comment });
+}
+function readZipComment(data) {
+    // scan for EOCD signature 0x06054b50 from the end
+    for (let i = data.length - 22; i >= Math.max(0, data.length - 22 - 65535); i--) {
+        if (data[i] === 0x50 && data[i + 1] === 0x4b && data[i + 2] === 0x05 && data[i + 3] === 0x06) {
+            const len = data[i + 20] | (data[i + 21] << 8);
+            const start = i + 22;
+            if (start + len > data.length)
+                return null;
+            return new TextDecoder('latin1').decode(data.subarray(start, start + len));
+        }
+    }
+    return null;
+}
+/**
+ * UTF-8 text decode helper for XML members.
+ *
+ * @param archive - the unpacked FCStd container.
+ * @param path - member path inside the ZIP, e.g. "Document.xml".
+ * @returns the member decoded as UTF-8 text, or undefined when absent.
+ */
+export function memberText(archive, path) {
+    const bytes = archive.members.get(path);
+    if (!bytes)
+        return undefined;
+    return new TextDecoder('utf-8').decode(bytes);
+}
+//# sourceMappingURL=unpack.js.map

package/dist/unpack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unpack.js","sourceRoot":"","sources":["../src/unpack.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,GAAG,EAAE,EAAE,EAAe,MAAM,0BAA0B,CAAC;AA4BhE;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,IAAgB;IAC1C,IAAI,OAAmC,CAAC;IACxC,IAAI,CAAC;QACH,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,GAAG,CAAC;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,uBAAuB,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;SAC7E,CAAC,CAAC;IACL,CAAC;IACD,IAAI,CAAC,CAAC,cAAc,IAAI,OAAO,CAAC,EAAE,CAAC;QACjC,OAAO,GAAG,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,OAAO,EAAE,oCAAoC,EAAE,CAAC,CAAC;IACzF,CAAC;IACD,wEAAwE;IACxE,0EAA0E;IAC1E,2DAA2D;IAC3D,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAC3C,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;AAChF,CAAC;AAED,SAAS,cAAc,CAAC,IAAgB;IACtC,kDAAkD;IAClD,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,GAAG,EAAE,GAAG,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/E,IACE,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,EACxF,CAAC;YACD,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,GAAG,EAAE,CAAE,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAE,IAAI,CAAC,CAAC,CAAC;YACjD,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,CAAC;YACrB,IAAI,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM;gBAAE,OAAO,IAAI,CAAC;YAC3C,OAAO,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC;QAC7E,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,OAAqB,EAAE,IAAY;IAC5D,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxC,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC","sourcesContent":["/**\n * M1.1 — FCStd container unpacking.\n *\n * Validation rules per plan §5.5.6 (corrected): a file is an FCStd iff it opens\n * as a ZIP and contains `Document.xml` at its root. The ZIP comment is advisory\n * only and must never cause rejection.\n *\n * faijs contract: unit mm, errors via Result (ok/err).\n */\nimport { unzipSync } from 'fflate';\nimport { err, ok, type Result } from '@faicad/faijs/api/result';\n\n/**\n * One raw file inside the FCStd ZIP container.\n */\nexport interface FcstdMember {\n  /** path inside the ZIP, e.g. \"Document.xml\", \"PartShape.brp\" */\n  path: string;\n  /** the member's raw bytes */\n  bytes: Uint8Array;\n}\n\n/**\n * The unpacked FCStd container: all ZIP members plus the advisory comment.\n */\nexport interface FcstdArchive {\n  members: Map<string, Uint8Array>;\n  /** advisory ZIP comment; may be empty (2/56 samples have empty comments) */\n  zipComment: string;\n}\n\n/**\n * Structured unpack failure: not a valid ZIP, or missing root `Document.xml`.\n */\nexport type UnpackError =\n  | { kind: 'not-zip'; message: string }\n  | { kind: 'no-document-xml'; message: string };\n\n/**\n * Unpack an FCStd file. Only requirement: valid ZIP + root `Document.xml`.\n *\n * @param data - the raw FCStd file bytes.\n * @returns the unpacked archive, or a structured UnpackError.\n */\nexport function unpackFcstd(data: Uint8Array): Result<FcstdArchive, UnpackError> {\n  let entries: Record<string, Uint8Array>;\n  try {\n    entries = unzipSync(data);\n  } catch (e) {\n    return err({\n      kind: 'not-zip',\n      message: `cannot open as ZIP: ${e instanceof Error ? e.message : String(e)}`,\n    });\n  }\n  if (!('Document.xml' in entries)) {\n    return err({ kind: 'no-document-xml', message: 'root Document.xml not found in ZIP' });\n  }\n  // fflate does not expose the raw ZIP comment through unzipSync; read it\n  // directly from the EOCD record (22 bytes from end when comment is empty,\n  // else longer). Advisory only — never used for validation.\n  const comment = readZipComment(data) ?? '';\n  return ok({ members: new Map(Object.entries(entries)), zipComment: comment });\n}\n\nfunction readZipComment(data: Uint8Array): string | null {\n  // scan for EOCD signature 0x06054b50 from the end\n  for (let i = data.length - 22; i >= Math.max(0, data.length - 22 - 65535); i--) {\n    if (\n      data[i] === 0x50 && data[i + 1] === 0x4b && data[i + 2] === 0x05 && data[i + 3] === 0x06\n    ) {\n      const len = data[i + 20]! | (data[i + 21]! << 8);\n      const start = i + 22;\n      if (start + len > data.length) return null;\n      return new TextDecoder('latin1').decode(data.subarray(start, start + len));\n    }\n  }\n  return null;\n}\n\n/**\n * UTF-8 text decode helper for XML members.\n *\n * @param archive - the unpacked FCStd container.\n * @param path - member path inside the ZIP, e.g. \"Document.xml\".\n * @returns the member decoded as UTF-8 text, or undefined when absent.\n */\nexport function memberText(archive: FcstdArchive, path: string): string | undefined {\n  const bytes = archive.members.get(path);\n  if (!bytes) return undefined;\n  return new TextDecoder('utf-8').decode(bytes);\n}\n"]}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@faicad/faijs-fcstd",
+  "version": "0.17.0",
+  "description": "FCStd reader and .fai.js conversion pipeline for faijs — unpack, sketch parse/solve, feature translate, batch CLI",
+  "keywords": [
+    "faijs",
+    "cad",
+    "fcstd",
+    "freecad",
+    "converter"
+  ],
+  "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",
+  "bin": {
+    "faijs-fcstd-convert": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./convert": {
+      "types": "./dist/convert.d.ts",
+      "default": "./dist/convert.js"
+    },
+    "./*": {
+      "types": "./dist/*.d.ts",
+      "default": "./dist/*.js"
+    }
+  },
+  "files": [
+    "dist",
+    "NOTICE",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "@salusoft89/planegcs": "1.2.0",
+    "@xmldom/xmldom": "^0.9.8",
+    "fflate": "^0.8.2"
+  },
+  "peerDependencies": {
+    "@faicad/faijs": "^0.17.0",
+    "occt-wasm": "^3.8.4"
+  },
+  "devDependencies": {
+    "typescript": "*",
+    "vitest": "*",
+    "occt-wasm": "^3.8.4",
+    "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"
+  }
+}