{"_id":"@simplysf/simply-document-core","_rev":"5-c726c0fd589db7a86d13bef80d9014d6","name":"@simplysf/simply-document-core","dist-tags":{"latest":"0.2.4"},"versions":{"0.2.0":{"name":"@simplysf/simply-document-core","version":"0.2.0","keywords":["force","salesforce","sfdx","salesforcedx","sfdx-plugin","sf-plugin","sf","documentation","confluence"],"author":{"name":"@ClayChipps"},"license":"Apache-2.0","_id":"@simplysf/simply-document-core@0.2.0","maintainers":[{"name":"ctchipps","email":"claychipps@gmail.com"},{"name":"jprichter","email":"jprichter@gmail.com"}],"homepage":"https://github.com/SimplySF/simply-node","bugs":{"url":"https://github.com/SimplySF/simply-node/issues"},"dist":{"shasum":"6aa1117eb56535467ea55c77f3865b64c1d2b62e","tarball":"https://registry.npmjs.org/@simplysf/simply-document-core/-/simply-document-core-0.2.0.tgz","fileCount":11,"integrity":"sha512-wgIbLF2muoLWrWjn9lSwnjvQJRNAPI6B5QoWhXcI6CtA6n0pD24nB3fT07DAygRk4jhcECxQs3QogZBlmsH1Wg==","signatures":[{"sig":"MEUCIQDywTfi7zAny+zKI9vUNn/uSQ/Zp3hP2kvkINftzLd99QIgBZjKeniWtSbWnU94PzqlWzMkGN3tLnb1yjktzzluZDg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":52128},"main":"./lib/index.js","type":"module","types":"./lib/index.d.ts","wireit":{"lint":{"files":["src/**/*.ts","test/**/*.ts","**/.eslint*","**/tsconfig.json","../../eslint.config.mjs","../../tsconfig.json"],"output":[],"command":"eslint src test --color --cache --cache-location .eslintcache"},"test":{"dependencies":["test:compile","test:only","lint"]},"build":{"dependencies":["compile","lint"]},"format":{"files":["src/**/*.ts","test/**/*.ts",".prettier*"],"output":[],"command":"prettier --write \"+(src|test)/**/*.+(ts|js|json)\""},"compile":{"clean":"if-file-deleted","files":["src/**/*.ts","**/tsconfig.json","../../tsconfig.json"],"output":["lib/**","*.tsbuildinfo"],"command":"tsc -p . --pretty --incremental"},"test:only":{"env":{"FORCE_COLOR":"2"},"files":["test/**/*.ts","src/**/*.ts","**/tsconfig.json","../../tsconfig.json","vitest.config.ts"],"output":[],"command":"vitest run --project simply-document-core"},"test:compile":{"files":["test/**/*.ts","**/tsconfig.json","../../tsconfig.json"],"output":[],"command":"tsc -p \"./test\" --pretty"}},"engines":{"node":">=22.0.0"},"exports":{".":{"types":"./lib/index.d.ts","default":"./lib/index.js"}},"gitHead":"b488b999d007c0036e86fda6dfa3092f103224ec","scripts":{"lint":"wireit","test":"wireit","build":"wireit","format":"wireit","compile":"wireit","test:only":"wireit","test:watch":"vitest watch --project simply-document-core","fix-license":"eslint src test --fix --rule \"header/header: [2]\"","test:coverage":"vitest run --coverage --project simply-document-core"},"_npmUser":{"name":"ctchipps","email":"claychipps@gmail.com"},"repository":{"url":"git+https://github.com/SimplySF/simply-node.git","type":"git","directory":"packages/simply-document-core"},"_npmVersion":"11.17.0","description":"Confluence-storage-format change report and technical design document rendering — the library layer behind @simplysf/simply-document, published separately for direct consumption (e.g. editor tooling, CI scripts) without the CLI framework","directories":{},"_nodeVersion":"24.19.0","dependencies":{"handlebars":"^4.7.9"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.1.10","@vitest/coverage-v8":"^4.1.10"},"_npmOperationalInternal":{"tmp":"tmp/simply-document-core_0.2.0_1788212767633_0.393067372988674","host":"s3://npm-registry-packages-npm-production"}},"0.2.1":{"name":"@simplysf/simply-document-core","version":"0.2.1","keywords":["force","salesforce","sfdx","salesforcedx","sfdx-plugin","sf-plugin","sf","documentation","confluence"],"author":{"name":"@ClayChipps"},"license":"Apache-2.0","_id":"@simplysf/simply-document-core@0.2.1","maintainers":[{"name":"ctchipps","email":"claychipps@gmail.com"},{"name":"jprichter","email":"jprichter@gmail.com"}],"homepage":"https://github.com/SimplySF/simply-node","bugs":{"url":"https://github.com/SimplySF/simply-node/issues"},"dist":{"shasum":"a8b9fe3918bfb515c3a042cb432bd8b6a8d73603","tarball":"https://registry.npmjs.org/@simplysf/simply-document-core/-/simply-document-core-0.2.1.tgz","fileCount":12,"integrity":"sha512-y4ZC8fEp1DFI8yYXtDwfzzBQDm9wYVpw+NsquMwcnf0yeRDLf1rRVv4RSszLWqrKSif2iICXvBjq8osd6HyNQQ==","signatures":[{"sig":"MEYCIQCEQyBBDiaKnnOutSImXZ2L9m9LJMjkSOX8WoQ6ZtmSYAIhANzZVsD+pBRHrC0+8wh4daUs8qBmbTHWHKAZ7vyDWRHx","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@simplysf%2fsimply-document-core@0.2.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":61980},"main":"./lib/index.js","type":"module","types":"./lib/index.d.ts","wireit":{"lint":{"files":["src/**/*.ts","test/**/*.ts","**/.eslint*","**/tsconfig.json","../../eslint.config.mjs","../../tsconfig.json"],"output":[],"command":"eslint src test --color --cache --cache-location .eslintcache"},"test":{"dependencies":["test:compile","test:only","lint"]},"build":{"dependencies":["compile","lint"]},"format":{"files":["src/**/*.ts","test/**/*.ts",".prettier*"],"output":[],"command":"prettier --write \"+(src|test)/**/*.+(ts|js|json)\""},"compile":{"clean":"if-file-deleted","files":["src/**/*.ts","**/tsconfig.json","../../tsconfig.json"],"output":["lib/**","*.tsbuildinfo"],"command":"tsc -p . --pretty --incremental"},"test:only":{"env":{"FORCE_COLOR":"2"},"files":["test/**/*.ts","src/**/*.ts","**/tsconfig.json","../../tsconfig.json","vitest.config.ts"],"output":[],"command":"vitest run --project simply-document-core"},"test:compile":{"files":["test/**/*.ts","**/tsconfig.json","../../tsconfig.json"],"output":[],"command":"tsc -p \"./test\" --pretty"}},"engines":{"node":">=22.0.0"},"exports":{".":{"types":"./lib/index.d.ts","default":"./lib/index.js"}},"gitHead":"1297c6539462c3ce009b1ee2bf6fe88eae5e6fa0","scripts":{"lint":"wireit","test":"wireit","build":"wireit","format":"wireit","compile":"wireit","test:only":"wireit","test:watch":"vitest watch --project simply-document-core","fix-license":"eslint src test --fix --rule \"header/header: [2]\"","test:coverage":"vitest run --coverage --project simply-document-core"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:fa2c7f97-f66a-4329-a198-c4549a15d795"}},"repository":{"url":"git+https://github.com/SimplySF/simply-node.git","type":"git","directory":"packages/simply-document-core"},"_npmVersion":"lerna/10.0.1/node@v24.19.0+x64 (linux)","description":"Confluence-storage-format change report and technical design document rendering — the library layer behind @simplysf/simply-document, published separately for direct consumption (e.g. editor tooling, CI scripts) without the CLI framework","directories":{},"_nodeVersion":"24.19.0","dependencies":{"handlebars":"^4.7.9"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.1.10","@vitest/coverage-v8":"^4.1.10"},"_npmOperationalInternal":{"tmp":"tmp/simply-document-core_0.2.1_1788359163051_0.09807568980364656","host":"s3://npm-registry-packages-npm-production"}},"0.2.2":{"name":"@simplysf/simply-document-core","version":"0.2.2","keywords":["force","salesforce","sfdx","salesforcedx","sfdx-plugin","sf-plugin","sf","documentation","confluence"],"author":{"name":"@ClayChipps"},"license":"Apache-2.0","_id":"@simplysf/simply-document-core@0.2.2","maintainers":[{"name":"ctchipps","email":"claychipps@gmail.com"},{"name":"jprichter","email":"jprichter@gmail.com"}],"homepage":"https://github.com/SimplySF/simply-node","bugs":{"url":"https://github.com/SimplySF/simply-node/issues"},"dist":{"shasum":"121d2c801a9f4ca3ea65b54c000c0dbbec6967d1","tarball":"https://registry.npmjs.org/@simplysf/simply-document-core/-/simply-document-core-0.2.2.tgz","fileCount":12,"integrity":"sha512-Olr+EdnsV784ju4Dd0KwWKDJUvgGwvqYFBYTJnXypric/3aqqM6ySDz4fC35v7PGCGht08l0dZT0JqUTJd0y4A==","signatures":[{"sig":"MEUCIBETLxeUJ2otiBEEJeU2bBwQAB1Ugnno8RNvRw5KznriAiEA8vm2OA4NaDrH6MGq6O+VBqRZ3ana1F9pIG62lpTWekw=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@simplysf%2fsimply-document-core@0.2.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":64426},"main":"./lib/index.js","type":"module","types":"./lib/index.d.ts","wireit":{"lint":{"files":["src/**/*.ts","test/**/*.ts","**/.eslint*","**/tsconfig.json","../../eslint.config.mjs","../../tsconfig.json"],"output":[],"command":"eslint src test --color --cache --cache-location .eslintcache"},"test":{"dependencies":["test:compile","test:only","lint"]},"build":{"dependencies":["compile","lint"]},"format":{"files":["src/**/*.ts","test/**/*.ts",".prettier*"],"output":[],"command":"prettier --write \"+(src|test)/**/*.+(ts|js|json)\""},"compile":{"clean":"if-file-deleted","files":["src/**/*.ts","**/tsconfig.json","../../tsconfig.json"],"output":["lib/**","*.tsbuildinfo"],"command":"tsc -p . --pretty --incremental"},"test:only":{"env":{"FORCE_COLOR":"2"},"files":["test/**/*.ts","src/**/*.ts","**/tsconfig.json","../../tsconfig.json","vitest.config.ts"],"output":[],"command":"vitest run --project simply-document-core"},"test:compile":{"files":["test/**/*.ts","**/tsconfig.json","../../tsconfig.json"],"output":[],"command":"tsc -p \"./test\" --pretty"}},"engines":{"node":">=22.0.0"},"exports":{".":{"types":"./lib/index.d.ts","default":"./lib/index.js"}},"gitHead":"00377b58018d2b1a7034c77389daba7c0fa0c246","scripts":{"lint":"wireit","test":"wireit","build":"wireit","format":"wireit","compile":"wireit","test:only":"wireit","test:watch":"vitest watch --project simply-document-core","fix-license":"eslint src test --fix --rule \"header/header: [2]\"","test:coverage":"vitest run --coverage --project simply-document-core"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:fa2c7f97-f66a-4329-a198-c4549a15d795"}},"repository":{"url":"git+https://github.com/SimplySF/simply-node.git","type":"git","directory":"packages/simply-document-core"},"_npmVersion":"lerna/10.0.1/node@v24.20.0+x64 (linux)","description":"Confluence-storage-format change report and technical design document rendering — the library layer behind @simplysf/simply-document, published separately for direct consumption (e.g. editor tooling, CI scripts) without the CLI framework","directories":{},"_nodeVersion":"24.20.0","dependencies":{"handlebars":"^4.7.9"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.1.10","@vitest/coverage-v8":"^4.1.10"},"_npmOperationalInternal":{"tmp":"tmp/simply-document-core_0.2.2_1788981270556_0.41996545112173367","host":"s3://npm-registry-packages-npm-production"}},"0.2.3":{"name":"@simplysf/simply-document-core","version":"0.2.3","keywords":["force","salesforce","sfdx","salesforcedx","sfdx-plugin","sf-plugin","sf","documentation","confluence"],"author":{"name":"@ClayChipps"},"license":"Apache-2.0","_id":"@simplysf/simply-document-core@0.2.3","maintainers":[{"name":"ctchipps","email":"claychipps@gmail.com"},{"name":"jprichter","email":"jprichter@gmail.com"}],"homepage":"https://github.com/SimplySF/simply-node","bugs":{"url":"https://github.com/SimplySF/simply-node/issues"},"dist":{"shasum":"458fab41f5457e4c4646fe10685aa3ed60f32080","tarball":"https://registry.npmjs.org/@simplysf/simply-document-core/-/simply-document-core-0.2.3.tgz","fileCount":12,"integrity":"sha512-S+sfwtuqTEHQOfzHKMfusTJ8VAtJTps15YG5B2p5/lYhyjtqU5n3mQOViciLBVzVD6xhVFjRB9hX9Jsc/PZ7dg==","signatures":[{"sig":"MEQCIBvRzwuU5ESB8zlKGPosQhLyC6LzJXRAB7KQht8TATepAiBag63gIxSkqe1ZmJbQifNlZTlnLzapa1nMWVA+s1x5jg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@simplysf%2fsimply-document-core@0.2.3","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":64414},"main":"./lib/index.js","type":"module","types":"./lib/index.d.ts","wireit":{"lint":{"files":["src/**/*.ts","test/**/*.ts","**/.eslint*","**/tsconfig.json","../../eslint.config.mjs","../../tsconfig.json"],"output":[],"command":"eslint src test --color --cache --cache-location .eslintcache"},"test":{"dependencies":["test:compile","test:only","lint"]},"build":{"dependencies":["compile","lint"]},"format":{"files":["src/**/*.ts","test/**/*.ts",".prettier*"],"output":[],"command":"prettier --write \"+(src|test)/**/*.+(ts|js|json)\""},"compile":{"clean":"if-file-deleted","files":["src/**/*.ts","**/tsconfig.json","../../tsconfig.json"],"output":["lib/**","*.tsbuildinfo"],"command":"tsc -p . --pretty --incremental"},"test:only":{"env":{"FORCE_COLOR":"2"},"files":["test/**/*.ts","src/**/*.ts","**/tsconfig.json","../../tsconfig.json","vitest.config.ts"],"output":[],"command":"vitest run --project simply-document-core"},"test:compile":{"files":["test/**/*.ts","**/tsconfig.json","../../tsconfig.json"],"output":[],"command":"tsc -p \"./test\" --pretty"}},"engines":{"node":">=22.0.0"},"exports":{".":{"types":"./lib/index.d.ts","default":"./lib/index.js"}},"gitHead":"f1bfa9ff90fe80862f432813ea255b0e96e78344","scripts":{"lint":"wireit","test":"wireit","build":"wireit","format":"wireit","compile":"wireit","test:only":"wireit","test:watch":"vitest watch --project simply-document-core","fix-license":"eslint src test --fix --rule \"header/header: [2]\"","test:coverage":"vitest run --coverage --project simply-document-core"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:fa2c7f97-f66a-4329-a198-c4549a15d795"}},"repository":{"url":"git+https://github.com/SimplySF/simply-node.git","type":"git","directory":"packages/simply-document-core"},"_npmVersion":"lerna/10.0.1/node@v24.20.0+x64 (linux)","description":"Confluence-storage-format change report and technical design document rendering — the library layer behind @simplysf/simply-document, published separately for direct consumption (e.g. editor tooling, CI scripts) without the CLI framework","directories":{},"_nodeVersion":"24.20.0","dependencies":{"handlebars":"^4.7.9"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"vitest":"^4.1.10","@vitest/coverage-v8":"^4.1.10"},"_npmOperationalInternal":{"tmp":"tmp/simply-document-core_0.2.3_1788981655133_0.07142070134890588","host":"s3://npm-registry-packages-npm-production"}},"0.2.4":{"name":"@simplysf/simply-document-core","description":"Confluence-storage-format change report and technical design document rendering — the library layer behind @simplysf/simply-document, published separately for direct consumption (e.g. editor tooling, CI scripts) without the CLI framework","version":"0.2.4","author":{"name":"@ClayChipps"},"homepage":"https://github.com/SimplySF/simply-plugins-core","bugs":{"url":"https://github.com/SimplySF/simply-plugins-core/issues"},"repository":{"type":"git","url":"git+https://github.com/SimplySF/simply-plugins-core.git","directory":"packages/simply-document-core"},"engines":{"node":">=22.0.0"},"keywords":["force","salesforce","sfdx","salesforcedx","sfdx-plugin","sf-plugin","sf","documentation","confluence"],"license":"Apache-2.0","main":"./lib/index.js","types":"./lib/index.d.ts","exports":{".":{"types":"./lib/index.d.ts","default":"./lib/index.js"}},"type":"module","dependencies":{"handlebars":"^4.7.9"},"devDependencies":{"@vitest/coverage-v8":"^4.1.10","vitest":"^4.1.10"},"publishConfig":{"access":"public"},"scripts":{"build":"wireit","compile":"wireit","fix-license":"eslint src test --fix --rule \"header/header: [2]\"","format":"wireit","lint":"wireit","test":"wireit","test:coverage":"vitest run --coverage --project simply-document-core","test:only":"wireit","test:watch":"vitest watch --project simply-document-core"},"wireit":{"build":{"dependencies":["compile","lint"]},"compile":{"command":"tsc -p . --pretty --incremental","files":["src/**/*.ts","**/tsconfig.json","../../tsconfig.json"],"output":["lib/**","*.tsbuildinfo"],"clean":"if-file-deleted"},"format":{"command":"prettier --write \"+(src|test)/**/*.+(ts|js|json)\"","files":["src/**/*.ts","test/**/*.ts",".prettier*"],"output":[]},"lint":{"command":"eslint src test --color --cache --cache-location .eslintcache","files":["src/**/*.ts","test/**/*.ts","**/.eslint*","**/tsconfig.json","../../eslint.config.mjs","../../tsconfig.json"],"output":[]},"test":{"dependencies":["test:compile","test:only","lint"]},"test:compile":{"command":"tsc -p \"./test\" --pretty","files":["test/**/*.ts","**/tsconfig.json","../../tsconfig.json"],"output":[]},"test:only":{"command":"vitest run --project simply-document-core","env":{"FORCE_COLOR":"2"},"files":["test/**/*.ts","src/**/*.ts","**/tsconfig.json","../../tsconfig.json","vitest.config.ts"],"output":[]}},"gitHead":"71ce9d30e732fcb9126605cef7ba857c6aa2ca1f","_id":"@simplysf/simply-document-core@0.2.4","_nodeVersion":"24.20.0","_npmVersion":"lerna/10.0.1/node@v24.20.0+x64 (linux)","dist":{"integrity":"sha512-LuwMHa2IoHCFjvLJC3v6BH0x8AzhM7EAinKOF9W9m+kdBmvRkiuR86ucAoVWqiJZ2RSAvOcT41QPk48ag6IyVQ==","shasum":"4a91adb83f64e20fba1b4c73b504e3a8931ddc35","tarball":"https://registry.npmjs.org/@simplysf/simply-document-core/-/simply-document-core-0.2.4.tgz","fileCount":12,"unpackedSize":64486,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@simplysf%2fsimply-document-core@0.2.4","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIAx9SexXcJnpHGuehv7p3MLdrPkCVQSM+5/Vib2BEvbyAiEAsOHWL6i6Ky7BGz+oVtX7vsFG4pZxKe4ERuWpXpPFDgo="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:36037228-f7b1-4a61-a08e-7eacbb7637b2"}},"directories":{},"maintainers":[{"name":"ctchipps","email":"claychipps@gmail.com"},{"name":"jprichter","email":"jprichter@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/simply-document-core_0.2.4_1789129888497_0.26389965764356327"},"_hasShrinkwrap":false}},"time":{"created":"2026-08-31T21:46:07.360Z","modified":"2026-09-11T12:31:28.996Z","0.2.0":"2026-08-31T21:46:07.771Z","0.2.1":"2026-09-02T14:26:03.190Z","0.2.2":"2026-09-09T19:14:30.690Z","0.2.3":"2026-09-09T19:20:55.294Z","0.2.4":"2026-09-11T12:31:28.636Z"},"bugs":{"url":"https://github.com/SimplySF/simply-plugins-core/issues"},"author":{"name":"@ClayChipps"},"license":"Apache-2.0","homepage":"https://github.com/SimplySF/simply-plugins-core","keywords":["force","salesforce","sfdx","salesforcedx","sfdx-plugin","sf-plugin","sf","documentation","confluence"],"repository":{"type":"git","url":"git+https://github.com/SimplySF/simply-plugins-core.git","directory":"packages/simply-document-core"},"description":"Confluence-storage-format change report and technical design document rendering — the library layer behind @simplysf/simply-document, published separately for direct consumption (e.g. editor tooling, CI scripts) without the CLI framework","maintainers":[{"name":"ctchipps","email":"claychipps@gmail.com"},{"name":"jprichter","email":"jprichter@gmail.com"}],"readme":"# @simplysf/simply-document-core\n\n[![NPM](https://img.shields.io/npm/v/@simplysf/simply-document-core?label=@simplysf/simply-document-core)](https://npmjs.com/@simplysf/simply-document-core) [![Downloads/week](https://img.shields.io/npm/dw/@simplysf/simply-document-core.svg)](https://npmjs.com/@simplysf/simply-document-core) [![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://raw.githubusercontent.com/SimplySF/simply-plugins-core/main/LICENSE.txt)\n\nConfluence-storage-format change report and technical design document rendering. This is not a Salesforce CLI plugin — it's the library layer behind [`@simplysf/simply-document`](https://github.com/SimplySF/simply-plugins/tree/main/packages/simply-document)'s `sf simply document diff`/`generate` commands, published separately so it can be imported directly by anything that wants the same rendering (an editor extension, a CI job, a script) without pulling in the CLI framework.\n\nUnlike the other internal libraries in this monorepo (`@simplysf/simply-core`, `@simplysf/simply-plugin-kit`, `@simplysf/simply-report`), this package is meant to be depended on by projects outside this repo, not only by other `simply-*` packages.\n\n## Install\n\n```bash\nnpm install @simplysf/simply-document-core\n```\n\nRequires Node.js `>=22` and either `\"type\": \"module\"` or a dynamic `import()` — this package ships ESM only.\n\n## API\n\nEverything below is exported from the package root. Removing or renaming an export is a breaking change; see [`src/index.ts`](src/index.ts).\n\n| Export                                                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |\n| --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `buildChangeReportHtml(changes, customTemplateSource?)`         | Pure function: renders a Confluence-storage-format change report grouping a set of changed components by component type, for pasting into a release/change-management page.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |\n| `buildTechnicalDesignDocumentHtml(data, customTemplateSource?)` | Pure function: renders a full Confluence-storage-format technical design document from a Salesforce project's scanned metadata — objects/data model, security model, groups/queues/permissions, solution inventory, and custom code inventory.                                                                                                                                                                                                                                                                                                                                                                                                                         |\n| `ChangeEntry`, `ChangesByComponentType`                         | Types for `buildChangeReportHtml`'s input.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |\n| `TechnicalDesignDocumentData`                                   | The full data model `buildTechnicalDesignDocumentHtml` renders, plus its 28 supporting item types: `ApexClassItem`, `ApexTriggerItem`, `ApprovalProcessItem`, `AuraComponentItem`, `CustomApplicationItem`, `CustomFieldItem`, `CustomLabelItem`, `CustomMetadataItem`, `DashboardItem`, `DigitalExperienceBundleItem`, `EmailTemplateItem`, `ExperienceBundleItem`, `FieldSetItem`, `FlexipageItem`, `FlowItem`, `GroupItem`, `LayoutItem`, `LightningComponentItem`, `ObjectItem`, `PermissionSetGroupItem`, `PermissionSetItem`, `QueueItem`, `RecordTypeItem`, `ReportItem`, `SharingRuleItem`, `StaticResourceItem`, `ValidationRuleItem`, `VisualforcePageItem`. |\n\nBoth functions accept an optional second `customTemplateSource` argument: a caller-supplied Handlebars template string, compiled against the same `Handlebars` instance as the built-in template (so it can use the same partials/helpers — `changeTable` for the change report, `loud` for the technical design document).\n\n```ts\nimport { buildChangeReportHtml, type ChangesByComponentType } from '@simplysf/simply-document-core';\n\nconst changes: ChangesByComponentType = {\n  apexClasses: [\n    {\n      componentName: 'AccountService',\n      componentType: 'ApexClass',\n      changeType: 'Added',\n      changeDescription: 'New service class',\n      path: 'force-app/main/default/classes/AccountService.cls',\n    },\n  ],\n};\n\nconst html = buildChangeReportHtml(changes);\n// paste the result into a Confluence page's storage-format editor\n```\n\n```ts\nimport { buildTechnicalDesignDocumentHtml, type TechnicalDesignDocumentData } from '@simplysf/simply-document-core';\n\nconst html = buildTechnicalDesignDocumentHtml(scannedProjectData);\n```\n\n## Issues\n\nPlease report any issues at https://github.com/SimplySF/simply-plugins-core/issues\n\n## Contributing\n\nThis package is part of the [`@simplysf/simply`](https://github.com/SimplySF/simply-plugins-core) monorepo. See [CONTRIBUTING.md](CONTRIBUTING.md) for what's specific to this package, and the repo's [root CONTRIBUTING.md](https://github.com/SimplySF/simply-plugins-core/blob/main/CONTRIBUTING.md) for repo structure, setup, commit conventions, and how to submit a pull request. Please also read our [Code of Conduct](https://github.com/SimplySF/simply-plugins-core/blob/main/CODE_OF_CONDUCT.md).\n\n## License\n\nLicensed under the [Apache-2.0](https://raw.githubusercontent.com/SimplySF/simply-plugins-core/main/LICENSE.txt) license.\n","readmeFilename":"README.md"}