From f58a59cccf58d82663269011f36922094c1f1f16 Mon Sep 17 00:00:00 2001 From: cswimr Date: Sun, 9 Feb 2025 14:00:39 -0600 Subject: [PATCH] switch to meli for documentation hosting --- .forgejo/workflows/docs.yml | 47 +++-- .gitignore | 3 + bun.lock | 149 ++++++++++++++ docs/README.md | 67 ------- docs/enums/hash-format/README.md | 15 -- .../hash-format/enumerations/HashFormat.md | 51 ----- .../functions/isValidHashFormat.md | 27 --- docs/enums/side/README.md | 15 -- docs/enums/side/enumerations/Side.md | 35 ---- docs/enums/side/functions/isValidSide.md | 27 --- docs/modules.md | 13 -- docs/parser/README.md | 22 --- docs/parser/classes/IndexFileEntry.md | 139 ------------- docs/parser/classes/Packwiz.md | 155 --------------- docs/parser/functions/parsePackwiz.md | 27 --- docs/parser/interfaces/Metafile.md | 67 ------- docs/parser/interfaces/PackwizIndex.md | 43 ---- docs/parser/interfaces/PackwizVersions.md | 60 ------ docs/provider/README.md | 14 -- docs/provider/classes/CurseForgeProvider.md | 138 ------------- docs/provider/classes/GitHubProvider.md | 160 --------------- docs/provider/classes/ModrinthProvider.md | 128 ------------ docs/provider/classes/UrlProvider.md | 81 -------- docs/resource/README.md | 11 -- docs/resource/classes/Resource.md | 187 ------------------ package.json | 1 + typedoc.json | 19 +- 27 files changed, 197 insertions(+), 1504 deletions(-) delete mode 100644 docs/README.md delete mode 100644 docs/enums/hash-format/README.md delete mode 100644 docs/enums/hash-format/enumerations/HashFormat.md delete mode 100644 docs/enums/hash-format/functions/isValidHashFormat.md delete mode 100644 docs/enums/side/README.md delete mode 100644 docs/enums/side/enumerations/Side.md delete mode 100644 docs/enums/side/functions/isValidSide.md delete mode 100644 docs/modules.md delete mode 100644 docs/parser/README.md delete mode 100644 docs/parser/classes/IndexFileEntry.md delete mode 100644 docs/parser/classes/Packwiz.md delete mode 100644 docs/parser/functions/parsePackwiz.md delete mode 100644 docs/parser/interfaces/Metafile.md delete mode 100644 docs/parser/interfaces/PackwizIndex.md delete mode 100644 docs/parser/interfaces/PackwizVersions.md delete mode 100644 docs/provider/README.md delete mode 100644 docs/provider/classes/CurseForgeProvider.md delete mode 100644 docs/provider/classes/GitHubProvider.md delete mode 100644 docs/provider/classes/ModrinthProvider.md delete mode 100644 docs/provider/classes/UrlProvider.md delete mode 100644 docs/resource/README.md delete mode 100644 docs/resource/classes/Resource.md diff --git a/.forgejo/workflows/docs.yml b/.forgejo/workflows/docs.yml index 649064f..03197d8 100644 --- a/.forgejo/workflows/docs.yml +++ b/.forgejo/workflows/docs.yml @@ -13,32 +13,37 @@ jobs: steps: - name: Checkout repository uses: https://github.com/actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 - - name: Set up SSH key - uses: https://www.coastalcommits.com/actions/ssh-agent@forgejo - with: - ssh-private-key: ${{ secrets.DEPLOY_KEY }} - instance-urls: "coastalcommits.com" - - name: Add instance URLs to known_hosts - run: ssh-keyscan -H coastalcommits.com >> ~/.ssh/known_hosts - name: Setup Bun uses: https://github.com/oven-sh/setup-bun@4bc047ad259df6fc24a6c9b0f9a0cb08cf17fbe5 # v2 with: bun-version: latest - - name: Configure Git - run: | - git config --global user.name "CoastalCommits" - git config --global user.email "CoastalCommits@noreply@coastalcommits.com" - git remote set-url origin git@coastalcommits.com:${{ github.repository }} - name: Install dependencies run: bun install --frozen-lockfile + - name: Set environment variables + uses: https://www.coastalcommits.com/actions/env@v2 - name: Build Documentation - run: bun docs - - name: Commit and Push run: | - git add . - if ! git diff-index --quiet HEAD --; then - git commit -m "Update documentation" - git push origin - else - echo "No changes to commit." - fi + export SITE_URL="https://$CI_ACTION_REF_NAME_SLUG.packwizjs.csw.im" + bun docs --hostedBaseUrl=$SITE_URL --useHostedBaseUrlForAbsoluteLinks=true + - name: Deploy documentation to Meli + run: | + GREEN='\033[0;32m' + YELLOW='\033[0;33m' + BLUE='\033[0;34m' + + unset GITHUB_TOKEN + unset GITLAB_TOKEN + + echo "${YELLOW}Deploying to ${BLUE}Meli ${YELLOW}on branch ${GREEN}$CI_ACTION_REF_NAME_SLUG${YELLOW}...\n" + + npx -p "@getmeli/cli" meli upload ./docs/html \ + --url "https://pages.coastalcommits.com" \ + --site "${{ vars.MELI_SITE_ID }}" \ + --token "${{ secrets.MELI_SITE_SECRET }}" \ + --release "$CI_ACTION_REF_NAME_SLUG/${{ env.GITHUB_SHA }}" \ + --branch "$CI_ACTION_REF_NAME_SLUG" + + echo "\n${YELLOW}Deployed to ${BLUE}Meli ${YELLOW}on branch ${GREEN}$CI_ACTION_REF_NAME_SLUG${YELLOW}!" + echo "${GREEN}https://$CI_ACTION_REF_NAME_SLUG.packwizjs.csw.im/" + env: + GITEA_TOKEN: ${{ github.token }} diff --git a/.gitignore b/.gitignore index 6855f8f..43208ea 100644 --- a/.gitignore +++ b/.gitignore @@ -176,3 +176,6 @@ dist # direnv .direnv/ + +# Documentation +docs/ diff --git a/bun.lock b/bun.lock index 92f370f..aac889d 100644 --- a/bun.lock +++ b/bun.lock @@ -9,6 +9,7 @@ "toml": "^3.0.0", }, "devDependencies": { + "@getmeli/cli": "^1.2.0", "@types/bun": "latest", "eslint": "9.20.0", "eslint-config-standard": "17.1.0", @@ -21,6 +22,10 @@ }, }, "packages": { + "@colors/colors": ["@colors/colors@1.6.0", "", {}, "sha512-Ir+AOibqzrIsL6ajt3Rz3LskB7OiMVHqltZmspbW/TJuTVuyOMirVqAkjfY6JISiLHgyNqicAC8AyHHGzNd/dA=="], + + "@dabh/diagnostics": ["@dabh/diagnostics@2.0.3", "", { "dependencies": { "colorspace": "1.1.x", "enabled": "2.0.x", "kuler": "^2.0.0" } }, "sha512-hrlQOIi7hAfzsMqlGSFyVucrx38O+j6wiGOf//H2ecvIEqYN4ADBSS2iLMh5UFyDunCNniUIPk/q3riFv45xRA=="], + "@eslint-community/eslint-utils": ["@eslint-community/eslint-utils@4.4.1", "", { "dependencies": { "eslint-visitor-keys": "^3.4.3" }, "peerDependencies": { "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" } }, "sha512-s3O3waFUrMV8P/XaF/+ZTp1X9XBZW1a4B97ZnjQF2KYWaFD2A8KyFBsrsfSjEmjn3RGWAIuvlneuZm3CUK3jbA=="], "@eslint-community/regexpp": ["@eslint-community/regexpp@4.12.1", "", {}, "sha512-CCZCDJuduB9OUkFkY2IgppNZMi2lBQgD2qzwXkEia16cge2pijY/aXi96CJMquDMn3nJdlPV1A5KrJEXwfLNzQ=="], @@ -39,6 +44,8 @@ "@gerrit0/mini-shiki": ["@gerrit0/mini-shiki@1.27.2", "", { "dependencies": { "@shikijs/engine-oniguruma": "^1.27.2", "@shikijs/types": "^1.27.2", "@shikijs/vscode-textmate": "^10.0.1" } }, "sha512-GeWyHz8ao2gBiUW4OJnQDxXQnFgZQwwQk05t/CVVgNBN7/rK8XZ7xY6YhLVv9tH3VppWWmr9DCl3MwemB/i+Og=="], + "@getmeli/cli": ["@getmeli/cli@1.2.0", "", { "dependencies": { "axios": "^0.21.1", "chalk": "^4.1.0", "debug": "^4.2.0", "form-data": "^3.0.0", "slugify": "^1.4.6", "source-map-support": "^0.5.19", "tar": "^6.0.5", "uuid": "^8.3.2", "winston": "^3.3.3", "yargs": "^15.4.1" }, "bin": { "meli": "build/index.js" } }, "sha512-9k5ZRN0UUo8YZB/lxaIdKp3qLHwPMd7xMfQr7rgLs7NWogvcHz7SCsZjokYKtduH7wzzqVfQklnL15rngMho8Q=="], + "@humanfs/core": ["@humanfs/core@0.19.1", "", {}, "sha512-5DyQ4+1JEUzejeK1JGICcideyfUbGixgS9jNgex5nqkW+cY7WZhxBigmieN5Qnw9ZosSNVC9KQKyb+GUaGyKUA=="], "@humanfs/node": ["@humanfs/node@0.16.6", "", { "dependencies": { "@humanfs/core": "^0.19.1", "@humanwhocodes/retry": "^0.3.0" } }, "sha512-YuI2ZHQL78Q5HbhDiBA1X4LmYdXCKCMQIfw0pw7piHJwyREFebJUvrQN4cMssyES6x+vfUbx1CIpaQUKYdQZOw=="], @@ -69,6 +76,8 @@ "@types/semver": ["@types/semver@7.5.8", "", {}, "sha512-I8EUhyrgfLrcTkzV3TSsGyl1tSuPrEDzr0yd5m90UgNxQkyDXULk3b6MlQqTCpZpNtWe1K0hzclnZkTcLBe2UQ=="], + "@types/triple-beam": ["@types/triple-beam@1.3.5", "", {}, "sha512-6WaYesThRMCl19iryMYP7/x2OVgCtbIVflDGFpWnb9irXI3UjYE4AzmYuiUKY1AJstGijoY+MgUszMgRxIYTYw=="], + "@types/unist": ["@types/unist@3.0.3", "", {}, "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q=="], "@types/ws": ["@types/ws@8.5.14", "", { "dependencies": { "@types/node": "*" } }, "sha512-bd/YFLW+URhBzMXurx7lWByOu+xzU9+kb3RboOteXYDfW+tr+JZa99OyNmPINEGB/ahzKrEuc8rcv4gnpJmxTw=="], @@ -79,6 +88,8 @@ "ajv": ["ajv@6.12.6", "", { "dependencies": { "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", "json-schema-traverse": "^0.4.1", "uri-js": "^4.2.2" } }, "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g=="], + "ansi-regex": ["ansi-regex@5.0.1", "", {}, "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ=="], + "ansi-styles": ["ansi-styles@4.3.0", "", { "dependencies": { "color-convert": "^2.0.1" } }, "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg=="], "argparse": ["argparse@2.0.1", "", {}, "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="], @@ -95,14 +106,22 @@ "arraybuffer.prototype.slice": ["arraybuffer.prototype.slice@1.0.4", "", { "dependencies": { "array-buffer-byte-length": "^1.0.1", "call-bind": "^1.0.8", "define-properties": "^1.2.1", "es-abstract": "^1.23.5", "es-errors": "^1.3.0", "get-intrinsic": "^1.2.6", "is-array-buffer": "^3.0.4" } }, "sha512-BNoCY6SXXPQ7gF2opIP4GBE+Xw7U+pHMYKuzjgCN3GwiaIR09UUeKfheyIry77QtrCBlC0KK0q5/TER/tYh3PQ=="], + "async": ["async@3.2.6", "", {}, "sha512-htCUDlxyyCLMgaM3xXg0C0LW2xqfuQ6p05pCEIsXuyQ+a1koYKTuBMzRNwmybfLgvJDMd0r1LTn4+E0Ti6C2AA=="], + "async-function": ["async-function@1.0.0", "", {}, "sha512-hsU18Ae8CDTR6Kgu9DYf0EbCr/a5iGL0rytQDobUcdpYOKokk8LEjVphnXkDkgpi0wYVsqrXuP0bZxJaTqdgoA=="], + "asynckit": ["asynckit@0.4.0", "", {}, "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q=="], + "available-typed-arrays": ["available-typed-arrays@1.0.7", "", { "dependencies": { "possible-typed-array-names": "^1.0.0" } }, "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ=="], + "axios": ["axios@0.21.4", "", { "dependencies": { "follow-redirects": "^1.14.0" } }, "sha512-ut5vewkiu8jjGBdqpM44XxjuCjq9LAKeHVmoVfHVzy8eHgxxq8SbAVQNovDA8mVi05kP0Ea/n/UzcSHcTJQfNg=="], + "balanced-match": ["balanced-match@1.0.2", "", {}, "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="], "brace-expansion": ["brace-expansion@1.1.11", "", { "dependencies": { "balanced-match": "^1.0.0", "concat-map": "0.0.1" } }, "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA=="], + "buffer-from": ["buffer-from@1.1.2", "", {}, "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ=="], + "builtin-modules": ["builtin-modules@3.3.0", "", {}, "sha512-zhaCDicdLuWN5UbN5IMnFqNMhNfo919sH85y2/ea+5Yg9TsTkeZxpL+JLbp6cgYFS4sRLp3YV4S6yDuqVWHYOw=="], "builtins": ["builtins@5.1.0", "", { "dependencies": { "semver": "^7.0.0" } }, "sha512-SW9lzGTLvWTP1AY8xeAMZimqDrIaSdLQUcVr9DMef51niJ022Ri87SwRRKYm4A6iHfkPaiVUu/Duw2Wc4J7kKg=="], @@ -117,12 +136,26 @@ "callsites": ["callsites@3.1.0", "", {}, "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ=="], + "camelcase": ["camelcase@5.3.1", "", {}, "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg=="], + "chalk": ["chalk@4.1.2", "", { "dependencies": { "ansi-styles": "^4.1.0", "supports-color": "^7.1.0" } }, "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA=="], + "chownr": ["chownr@2.0.0", "", {}, "sha512-bIomtDF5KGpdogkLd9VspvFzk9KfpyyGlS8YFVZl7TGPBHL5snIOnxeshwVgPteQ9b4Eydl+pVbIyE1DcvCWgQ=="], + + "cliui": ["cliui@6.0.0", "", { "dependencies": { "string-width": "^4.2.0", "strip-ansi": "^6.0.0", "wrap-ansi": "^6.2.0" } }, "sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ=="], + + "color": ["color@3.2.1", "", { "dependencies": { "color-convert": "^1.9.3", "color-string": "^1.6.0" } }, "sha512-aBl7dZI9ENN6fUGC7mWpMTPNHmWUSNan9tuWN6ahh5ZLNk9baLJOnSMlrQkHcrfFgz2/RigjUVAjdx36VcemKA=="], + "color-convert": ["color-convert@2.0.1", "", { "dependencies": { "color-name": "~1.1.4" } }, "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ=="], "color-name": ["color-name@1.1.4", "", {}, "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="], + "color-string": ["color-string@1.9.1", "", { "dependencies": { "color-name": "^1.0.0", "simple-swizzle": "^0.2.2" } }, "sha512-shrVawQFojnZv6xM40anx4CkoDP+fZsw/ZerEMsW/pyzsRbElpsL/DBVW7q3ExxwusdNXI3lXpuhEZkzs8p5Eg=="], + + "colorspace": ["colorspace@1.1.4", "", { "dependencies": { "color": "^3.1.3", "text-hex": "1.0.x" } }, "sha512-BgvKJiuVu1igBUF2kEjRCZXol6wiiGbY5ipL/oVPwm0BL9sIpMIzM8IK7vwuxIIzOXMV3Ey5w+vxhm0rR/TN8w=="], + + "combined-stream": ["combined-stream@1.0.8", "", { "dependencies": { "delayed-stream": "~1.0.0" } }, "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg=="], + "concat-map": ["concat-map@0.0.1", "", {}, "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg=="], "cross-spawn": ["cross-spawn@7.0.6", "", { "dependencies": { "path-key": "^3.1.0", "shebang-command": "^2.0.0", "which": "^2.0.1" } }, "sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA=="], @@ -135,16 +168,24 @@ "debug": ["debug@4.4.0", "", { "dependencies": { "ms": "^2.1.3" } }, "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA=="], + "decamelize": ["decamelize@1.2.0", "", {}, "sha512-z2S+W9X73hAUUki+N+9Za2lBlun89zigOyGrsax+KUQ6wKW4ZoWpEYBkGhQjwAjjDCkWxhY0VKEhk8wzY7F5cA=="], + "deep-is": ["deep-is@0.1.4", "", {}, "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ=="], "define-data-property": ["define-data-property@1.1.4", "", { "dependencies": { "es-define-property": "^1.0.0", "es-errors": "^1.3.0", "gopd": "^1.0.1" } }, "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A=="], "define-properties": ["define-properties@1.2.1", "", { "dependencies": { "define-data-property": "^1.0.1", "has-property-descriptors": "^1.0.0", "object-keys": "^1.1.1" } }, "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg=="], + "delayed-stream": ["delayed-stream@1.0.0", "", {}, "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ=="], + "doctrine": ["doctrine@2.1.0", "", { "dependencies": { "esutils": "^2.0.2" } }, "sha512-35mSku4ZXK0vfCuHEDAwt55dg2jNajHZ1odvF+8SSr82EsZY4QmXfuWso8oEd8zRhVObSN18aM0CjSdoBX7zIw=="], "dunder-proto": ["dunder-proto@1.0.1", "", { "dependencies": { "call-bind-apply-helpers": "^1.0.1", "es-errors": "^1.3.0", "gopd": "^1.2.0" } }, "sha512-KIN/nDJBQRcXw0MLVhZE9iQHmG68qAVIBg9CqmUYjmQIhgij9U5MFvrqkUL5FbtyyzZuOeOt0zdeRe4UY7ct+A=="], + "emoji-regex": ["emoji-regex@8.0.0", "", {}, "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="], + + "enabled": ["enabled@2.0.0", "", {}, "sha512-AKrN98kuwOzMIdAizXGI86UFBoo26CL21UM763y1h/GMSJ4/OHU9k2YlsmBpyScFo/wbLzWQJBMCW4+IO3/+OQ=="], + "entities": ["entities@4.5.0", "", {}, "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw=="], "es-abstract": ["es-abstract@1.23.9", "", { "dependencies": { "array-buffer-byte-length": "^1.0.2", "arraybuffer.prototype.slice": "^1.0.4", "available-typed-arrays": "^1.0.7", "call-bind": "^1.0.8", "call-bound": "^1.0.3", "data-view-buffer": "^1.0.2", "data-view-byte-length": "^1.0.2", "data-view-byte-offset": "^1.0.1", "es-define-property": "^1.0.1", "es-errors": "^1.3.0", "es-object-atoms": "^1.0.0", "es-set-tostringtag": "^2.1.0", "es-to-primitive": "^1.3.0", "function.prototype.name": "^1.1.8", "get-intrinsic": "^1.2.7", "get-proto": "^1.0.0", "get-symbol-description": "^1.1.0", "globalthis": "^1.0.4", "gopd": "^1.2.0", "has-property-descriptors": "^1.0.2", "has-proto": "^1.2.0", "has-symbols": "^1.1.0", "hasown": "^2.0.2", "internal-slot": "^1.1.0", "is-array-buffer": "^3.0.5", "is-callable": "^1.2.7", "is-data-view": "^1.0.2", "is-regex": "^1.2.1", "is-shared-array-buffer": "^1.0.4", "is-string": "^1.1.1", "is-typed-array": "^1.1.15", "is-weakref": "^1.1.0", "math-intrinsics": "^1.1.0", "object-inspect": "^1.13.3", "object-keys": "^1.1.1", "object.assign": "^4.1.7", "own-keys": "^1.0.1", "regexp.prototype.flags": "^1.5.3", "safe-array-concat": "^1.1.3", "safe-push-apply": "^1.0.0", "safe-regex-test": "^1.1.0", "set-proto": "^1.0.0", "string.prototype.trim": "^1.2.10", "string.prototype.trimend": "^1.0.9", "string.prototype.trimstart": "^1.0.8", "typed-array-buffer": "^1.0.3", "typed-array-byte-length": "^1.0.3", "typed-array-byte-offset": "^1.0.4", "typed-array-length": "^1.0.7", "unbox-primitive": "^1.1.0", "which-typed-array": "^1.1.18" } }, "sha512-py07lI0wjxAC/DcfK1S6G7iANonniZwTISvdPzk9hzeH0IZIshbuuFxLIU96OyF89Yb9hiqWn8M/bY83KY5vzA=="], @@ -201,6 +242,8 @@ "fast-levenshtein": ["fast-levenshtein@2.0.6", "", {}, "sha512-DCXu6Ifhqcks7TZKY3Hxp3y6qphY5SJZmrWMDrKcERSOXWQdMhU9Ig/PYrzyw/ul9jOIyh0N4M0tbC5hodg8dw=="], + "fecha": ["fecha@4.2.3", "", {}, "sha512-OP2IUU6HeYKJi3i0z4A19kHMQoLVs4Hc+DPqqxI2h/DPZHTm/vjsfC6P0b4jCMy14XizLBqvndQ+UilD7707Jw=="], + "file-entry-cache": ["file-entry-cache@8.0.0", "", { "dependencies": { "flat-cache": "^4.0.0" } }, "sha512-XXTUwCvisa5oacNGRP9SfNtYBNAMi+RPwBFmblZEF7N7swHYQS6/Zfk7SRwx4D5j3CH211YNRco1DEMNVfZCnQ=="], "find-up": ["find-up@5.0.0", "", { "dependencies": { "locate-path": "^6.0.0", "path-exists": "^4.0.0" } }, "sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng=="], @@ -209,14 +252,24 @@ "flatted": ["flatted@3.3.2", "", {}, "sha512-AiwGJM8YcNOaobumgtng+6NHuOqC3A7MixFeDafM3X9cIUM+xUXoS5Vfgf+OihAYe20fxqNM9yPBXJzRtZ/4eA=="], + "fn.name": ["fn.name@1.1.0", "", {}, "sha512-GRnmB5gPyJpAhTQdSZTSp9uaPSvl09KoYcMQtsB9rQoOmzs9dH6ffeccH+Z+cv6P68Hu5bC6JjRh4Ah/mHSNRw=="], + + "follow-redirects": ["follow-redirects@1.15.9", "", {}, "sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ=="], + "for-each": ["for-each@0.3.4", "", { "dependencies": { "is-callable": "^1.2.7" } }, "sha512-kKaIINnFpzW6ffJNDjjyjrk21BkDx38c0xa/klsT8VzLCaMEefv4ZTacrcVR4DmgTeBra++jMDAfS/tS799YDw=="], + "form-data": ["form-data@3.0.2", "", { "dependencies": { "asynckit": "^0.4.0", "combined-stream": "^1.0.8", "mime-types": "^2.1.12" } }, "sha512-sJe+TQb2vIaIyO783qN6BlMYWMw3WBOHA1Ay2qxsnjuafEOQFJ2JakedOQirT6D5XPRxDvS7AHYyem9fTpb4LQ=="], + + "fs-minipass": ["fs-minipass@2.1.0", "", { "dependencies": { "minipass": "^3.0.0" } }, "sha512-V/JgOLFCS+R6Vcq0slCuaeWEdNC3ouDlJMNIsacH2VtALiu9mV4LPrHc5cDl8k5aw6J8jwgWWpiTo5RYhmIzvg=="], + "function-bind": ["function-bind@1.1.2", "", {}, "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA=="], "function.prototype.name": ["function.prototype.name@1.1.8", "", { "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", "define-properties": "^1.2.1", "functions-have-names": "^1.2.3", "hasown": "^2.0.2", "is-callable": "^1.2.7" } }, "sha512-e5iwyodOHhbMr/yNrc7fDYG4qlbIvI5gajyzPnb5TCwyhjApznQh1BMFou9b30SevY43gCJKXycoCBjMbsuW0Q=="], "functions-have-names": ["functions-have-names@1.2.3", "", {}, "sha512-xckBUXyTIqT97tq2x2AMb+g163b5JFysYk0x4qxNFwbfQkmNZoiRHb6sPzI9/QV33WeuvVYBUIiD4NzNIyqaRQ=="], + "get-caller-file": ["get-caller-file@2.0.5", "", {}, "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg=="], + "get-intrinsic": ["get-intrinsic@1.2.7", "", { "dependencies": { "call-bind-apply-helpers": "^1.0.1", "es-define-property": "^1.0.1", "es-errors": "^1.3.0", "es-object-atoms": "^1.0.0", "function-bind": "^1.1.2", "get-proto": "^1.0.0", "gopd": "^1.2.0", "has-symbols": "^1.1.0", "hasown": "^2.0.2", "math-intrinsics": "^1.1.0" } }, "sha512-VW6Pxhsrk0KAOqs3WEd0klDiF/+V7gQOpAvY1jVU/LHmaD/kQO4523aiJuikX/QAKYiW6x8Jh+RJej1almdtCA=="], "get-proto": ["get-proto@1.0.1", "", { "dependencies": { "dunder-proto": "^1.0.1", "es-object-atoms": "^1.0.0" } }, "sha512-sTSfBjoXBp89JvIKIefqw7U2CCebsc74kiY6awiGogKtoSGbgjYE/G/+l9sF3MWFPNc9IcoOC4ODfKHfxFmp0g=="], @@ -253,10 +306,14 @@ "imurmurhash": ["imurmurhash@0.1.4", "", {}, "sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA=="], + "inherits": ["inherits@2.0.4", "", {}, "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ=="], + "internal-slot": ["internal-slot@1.1.0", "", { "dependencies": { "es-errors": "^1.3.0", "hasown": "^2.0.2", "side-channel": "^1.1.0" } }, "sha512-4gd7VpWNQNB4UKKCFFVcp1AVv+FMOgs9NKzjHKusc8jTMhd5eL1NqQqOpE0KzMds804/yHlglp3uxgluOqAPLw=="], "is-array-buffer": ["is-array-buffer@3.0.5", "", { "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", "get-intrinsic": "^1.2.6" } }, "sha512-DDfANUiiG2wC1qawP66qlTugJeL5HyzMpfr8lLK+jMQirGzNod0B12cFB/9q838Ru27sBwfw78/rdoU7RERz6A=="], + "is-arrayish": ["is-arrayish@0.3.2", "", {}, "sha512-eVRqCvVlZbuw3GrM63ovNSNAeA1K16kaR/LRY/92w0zxQ5/1YzwblUX652i4Xs9RwAGjW9d9y6X88t8OaAJfWQ=="], + "is-async-function": ["is-async-function@2.1.1", "", { "dependencies": { "async-function": "^1.0.0", "call-bound": "^1.0.3", "get-proto": "^1.0.1", "has-tostringtag": "^1.0.2", "safe-regex-test": "^1.1.0" } }, "sha512-9dgM/cZBnNvjzaMYHVoxxfPj2QXt22Ev7SuuPrs+xav0ukGB0S6d4ydZdEiM48kLx5kDV+QBPrpVnFyefL8kkQ=="], "is-bigint": ["is-bigint@1.1.0", "", { "dependencies": { "has-bigints": "^1.0.2" } }, "sha512-n4ZT37wG78iz03xPRKJrHTdZbe3IicyucEtdRsV5yglwc3GyUfbAfpSeD0FJ41NbUNSt5wbhqfp1fS+BgnvDFQ=="], @@ -277,6 +334,8 @@ "is-finalizationregistry": ["is-finalizationregistry@1.1.1", "", { "dependencies": { "call-bound": "^1.0.3" } }, "sha512-1pC6N8qWJbWoPtEjgcL2xyhQOP491EQjeUo3qTKcmV8YSDDJrOepfG8pcC7h/QgnQHYSv0mJ3Z/ZWxmatVrysg=="], + "is-fullwidth-code-point": ["is-fullwidth-code-point@3.0.0", "", {}, "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg=="], + "is-generator-function": ["is-generator-function@1.1.0", "", { "dependencies": { "call-bound": "^1.0.3", "get-proto": "^1.0.0", "has-tostringtag": "^1.0.2", "safe-regex-test": "^1.1.0" } }, "sha512-nPUB5km40q9e8UfN/Zc24eLlzdSf9OfKByBw9CIdw4H1giPMeA0OIJvbchsCu4npfI2QcMVBsGEBHKZ7wLTWmQ=="], "is-glob": ["is-glob@4.0.3", "", { "dependencies": { "is-extglob": "^2.1.1" } }, "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg=="], @@ -291,6 +350,8 @@ "is-shared-array-buffer": ["is-shared-array-buffer@1.0.4", "", { "dependencies": { "call-bound": "^1.0.3" } }, "sha512-ISWac8drv4ZGfwKl5slpHG9OwPNty4jOWPRIhBpxOoD+hqITiwuipOQ2bNthAzwA3B4fIjO4Nln74N0S9byq8A=="], + "is-stream": ["is-stream@2.0.1", "", {}, "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg=="], + "is-string": ["is-string@1.1.1", "", { "dependencies": { "call-bound": "^1.0.3", "has-tostringtag": "^1.0.2" } }, "sha512-BtEeSsoaQjlSPBemMQIrY1MY0uM6vnS1g5fmufYOtnxLGUZM2178PKbhsk7Ffv58IX+ZtcvoGwccYsh0PglkAA=="], "is-symbol": ["is-symbol@1.1.1", "", { "dependencies": { "call-bound": "^1.0.2", "has-symbols": "^1.1.0", "safe-regex-test": "^1.1.0" } }, "sha512-9gGx6GTtCQM73BgmHQXfDmLtfjjTUDSyoxTCbp5WtoixAhfgsDirWIcVQ/IHpvI5Vgd5i/J5F7B9cN/WlVbC/w=="], @@ -319,6 +380,8 @@ "keyv": ["keyv@4.5.4", "", { "dependencies": { "json-buffer": "3.0.1" } }, "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw=="], + "kuler": ["kuler@2.0.0", "", {}, "sha512-Xq9nH7KlWZmXAtodXDDRE7vs6DU1gTU8zYDHDiWLSip45Egwq3plLHzPn27NgvzL2r1LMPC1vdqh98sQxtqj4A=="], + "levn": ["levn@0.4.1", "", { "dependencies": { "prelude-ls": "^1.2.1", "type-check": "~0.4.0" } }, "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ=="], "linkify-it": ["linkify-it@5.0.0", "", { "dependencies": { "uc.micro": "^2.0.0" } }, "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ=="], @@ -327,6 +390,8 @@ "lodash.merge": ["lodash.merge@4.6.2", "", {}, "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ=="], + "logform": ["logform@2.7.0", "", { "dependencies": { "@colors/colors": "1.6.0", "@types/triple-beam": "^1.3.2", "fecha": "^4.2.0", "ms": "^2.1.1", "safe-stable-stringify": "^2.3.1", "triple-beam": "^1.3.0" } }, "sha512-TFYA4jnP7PVbmlBIfhlSe+WKxs9dklXMTEGcBCIvLhE/Tn3H6Gk1norupVW7m5Cnd4bLcr08AytbyV/xj7f/kQ=="], + "lunr": ["lunr@2.3.9", "", {}, "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow=="], "markdown-it": ["markdown-it@14.1.0", "", { "dependencies": { "argparse": "^2.0.1", "entities": "^4.4.0", "linkify-it": "^5.0.0", "mdurl": "^2.0.0", "punycode.js": "^2.3.1", "uc.micro": "^2.1.0" }, "bin": { "markdown-it": "bin/markdown-it.mjs" } }, "sha512-a54IwgWPaeBCAAsv13YgmALOF1elABB08FxO9i+r4VFk5Vl4pKokRPeX8u5TCgSsPi6ec1otfLjdOpVcgbpshg=="], @@ -335,10 +400,20 @@ "mdurl": ["mdurl@2.0.0", "", {}, "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w=="], + "mime-db": ["mime-db@1.52.0", "", {}, "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg=="], + + "mime-types": ["mime-types@2.1.35", "", { "dependencies": { "mime-db": "1.52.0" } }, "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw=="], + "minimatch": ["minimatch@3.1.2", "", { "dependencies": { "brace-expansion": "^1.1.7" } }, "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw=="], "minimist": ["minimist@1.2.8", "", {}, "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA=="], + "minipass": ["minipass@5.0.0", "", {}, "sha512-3FnjYuehv9k6ovOEbyOswadCDPX1piCfhV8ncmYtHOjuPwylVWsghTLo7rabjC3Rx5xD4HDx8Wm1xnMF7S5qFQ=="], + + "minizlib": ["minizlib@2.1.2", "", { "dependencies": { "minipass": "^3.0.0", "yallist": "^4.0.0" } }, "sha512-bAxsR8BVfj60DWXHE3u30oHzfl4G7khkSuPW+qvpd7jFRHm7dLxOjUk1EHACJ/hxLY8phGJ0YhYHZo7jil7Qdg=="], + + "mkdirp": ["mkdirp@1.0.4", "", { "bin": { "mkdirp": "bin/cmd.js" } }, "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw=="], + "ms": ["ms@2.1.3", "", {}, "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA=="], "natural-compare": ["natural-compare@1.4.0", "", {}, "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw=="], @@ -355,6 +430,8 @@ "object.values": ["object.values@1.2.1", "", { "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.3", "define-properties": "^1.2.1", "es-object-atoms": "^1.0.0" } }, "sha512-gXah6aZrcUxjWg2zR2MwouP2eHlCBzdV4pygudehaKXSGW4v2AsRQUK+lwwXhii6KFZcunEnmSUoYp5CXibxtA=="], + "one-time": ["one-time@1.0.0", "", { "dependencies": { "fn.name": "1.x.x" } }, "sha512-5DXOiRKwuSEcQ/l0kGCF6Q3jcADFv5tSmRaJck/OqkVFcOzutB134KRSfF0xDrL39MNnqxbHBbUUcjZIhTgb2g=="], + "optionator": ["optionator@0.9.4", "", { "dependencies": { "deep-is": "^0.1.3", "fast-levenshtein": "^2.0.6", "levn": "^0.4.1", "prelude-ls": "^1.2.1", "type-check": "^0.4.0", "word-wrap": "^1.2.5" } }, "sha512-6IpQ7mKUxRcZNLIObR0hz7lxsapSSIYNZJwXPGeF0mTVqGKFIXj1DQcMoT22S3ROcLyY/rz0PWaWZ9ayWmad9g=="], "own-keys": ["own-keys@1.0.1", "", { "dependencies": { "get-intrinsic": "^1.2.6", "object-keys": "^1.1.1", "safe-push-apply": "^1.0.0" } }, "sha512-qFOyK5PjiWZd+QQIh+1jhdb9LpxTF0qs7Pm8o5QHYZ0M3vKqSqzsZaEB6oWlxZ+q2sJBMI/Ktgd2N5ZwQoRHfg=="], @@ -363,6 +440,8 @@ "p-locate": ["p-locate@5.0.0", "", { "dependencies": { "p-limit": "^3.0.2" } }, "sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw=="], + "p-try": ["p-try@2.2.0", "", {}, "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ=="], + "parent-module": ["parent-module@1.0.1", "", { "dependencies": { "callsites": "^3.0.0" } }, "sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g=="], "path-exists": ["path-exists@4.0.0", "", {}, "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w=="], @@ -379,10 +458,16 @@ "punycode.js": ["punycode.js@2.3.1", "", {}, "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA=="], + "readable-stream": ["readable-stream@3.6.2", "", { "dependencies": { "inherits": "^2.0.3", "string_decoder": "^1.1.1", "util-deprecate": "^1.0.1" } }, "sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA=="], + "reflect.getprototypeof": ["reflect.getprototypeof@1.0.10", "", { "dependencies": { "call-bind": "^1.0.8", "define-properties": "^1.2.1", "es-abstract": "^1.23.9", "es-errors": "^1.3.0", "es-object-atoms": "^1.0.0", "get-intrinsic": "^1.2.7", "get-proto": "^1.0.1", "which-builtin-type": "^1.2.1" } }, "sha512-00o4I+DVrefhv+nX0ulyi3biSHCPDe+yLv5o/p6d/UVlirijB8E16FtfwSAi4g3tcqrQ4lRAqQSoFEZJehYEcw=="], "regexp.prototype.flags": ["regexp.prototype.flags@1.5.4", "", { "dependencies": { "call-bind": "^1.0.8", "define-properties": "^1.2.1", "es-errors": "^1.3.0", "get-proto": "^1.0.1", "gopd": "^1.2.0", "set-function-name": "^2.0.2" } }, "sha512-dYqgNSZbDwkaJ2ceRd9ojCGjBq+mOm9LmtXnAnEGyHhN/5R7iDW2TRw3h+o/jCFxus3P2LfWIIiwowAjANm7IA=="], + "require-directory": ["require-directory@2.1.1", "", {}, "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q=="], + + "require-main-filename": ["require-main-filename@2.0.0", "", {}, "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg=="], + "resolve": ["resolve@1.22.10", "", { "dependencies": { "is-core-module": "^2.16.0", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, "bin": { "resolve": "bin/resolve" } }, "sha512-NPRy+/ncIMeDlTAsuqwKIiferiawhefFJtkNSW0qZJEqMEb+qBt/77B/jGeeek+F0uOeN05CDa6HXbbIgtVX4w=="], "resolve-from": ["resolve-from@4.0.0", "", {}, "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g=="], @@ -391,12 +476,18 @@ "safe-array-concat": ["safe-array-concat@1.1.3", "", { "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.2", "get-intrinsic": "^1.2.6", "has-symbols": "^1.1.0", "isarray": "^2.0.5" } }, "sha512-AURm5f0jYEOydBj7VQlVvDrjeFgthDdEF5H1dP+6mNpoXOMo1quQqJ4wvJDyRZ9+pO3kGWoOdmV08cSv2aJV6Q=="], + "safe-buffer": ["safe-buffer@5.2.1", "", {}, "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ=="], + "safe-push-apply": ["safe-push-apply@1.0.0", "", { "dependencies": { "es-errors": "^1.3.0", "isarray": "^2.0.5" } }, "sha512-iKE9w/Z7xCzUMIZqdBsp6pEQvwuEebH4vdpjcDWnyzaI6yl6O9FHvVpmGelvEHNsoY6wGblkxR6Zty/h00WiSA=="], "safe-regex-test": ["safe-regex-test@1.1.0", "", { "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", "is-regex": "^1.2.1" } }, "sha512-x/+Cz4YrimQxQccJf5mKEbIa1NzeCRNI5Ecl/ekmlYaampdNLPalVyIcCZNNH3MvmqBugV5TMYZXv0ljslUlaw=="], + "safe-stable-stringify": ["safe-stable-stringify@2.5.0", "", {}, "sha512-b3rppTKm9T+PsVCBEOUR46GWI7fdOs00VKZ1+9c1EWDaDMvjQc6tUwuFyIprgGgTcWoVHSKrU8H31ZHA2e0RHA=="], + "semver": ["semver@7.7.1", "", { "bin": { "semver": "bin/semver.js" } }, "sha512-hlq8tAfn0m/61p4BVRcPzIGr6LKiMwo4VM6dGi6pt4qcRkmNzTcWq6eCEjEh+qXjkMDvPlOFFSGwQjoEa6gyMA=="], + "set-blocking": ["set-blocking@2.0.0", "", {}, "sha512-KiKBS8AnWGEyLzofFfmvKwpdPzqiy16LvQfK3yv/fVH7Bj13/wl3JSR1J+rfgRE9q7xUJK4qvgS8raSOeLUehw=="], + "set-function-length": ["set-function-length@1.2.2", "", { "dependencies": { "define-data-property": "^1.1.4", "es-errors": "^1.3.0", "function-bind": "^1.1.2", "get-intrinsic": "^1.2.4", "gopd": "^1.0.1", "has-property-descriptors": "^1.0.2" } }, "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg=="], "set-function-name": ["set-function-name@2.0.2", "", { "dependencies": { "define-data-property": "^1.1.4", "es-errors": "^1.3.0", "functions-have-names": "^1.2.3", "has-property-descriptors": "^1.0.2" } }, "sha512-7PGFlmtwsEADb0WYyvCMa1t+yke6daIG4Wirafur5kcf+MhUnPms1UeR0CKQdTZD81yESwMHbtn+TR+dMviakQ=="], @@ -415,12 +506,28 @@ "side-channel-weakmap": ["side-channel-weakmap@1.0.2", "", { "dependencies": { "call-bound": "^1.0.2", "es-errors": "^1.3.0", "get-intrinsic": "^1.2.5", "object-inspect": "^1.13.3", "side-channel-map": "^1.0.1" } }, "sha512-WPS/HvHQTYnHisLo9McqBHOJk2FkHO/tlpvldyrnem4aeQp4hai3gythswg6p01oSoTl58rcpiFAjF2br2Ak2A=="], + "simple-swizzle": ["simple-swizzle@0.2.2", "", { "dependencies": { "is-arrayish": "^0.3.1" } }, "sha512-JA//kQgZtbuY83m+xT+tXJkmJncGMTFT+C+g2h2R9uxkYIrE2yy9sgmcLhCnw57/WSD+Eh3J97FPEDFnbXnDUg=="], + + "slugify": ["slugify@1.6.6", "", {}, "sha512-h+z7HKHYXj6wJU+AnS/+IH8Uh9fdcX1Lrhg1/VMdf9PwoBQXFcXiAdsy2tSK0P6gKwJLXp02r90ahUCqHk9rrw=="], + + "source-map": ["source-map@0.6.1", "", {}, "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g=="], + + "source-map-support": ["source-map-support@0.5.21", "", { "dependencies": { "buffer-from": "^1.0.0", "source-map": "^0.6.0" } }, "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w=="], + + "stack-trace": ["stack-trace@0.0.10", "", {}, "sha512-KGzahc7puUKkzyMt+IqAep+TVNbKP+k2Lmwhub39m1AsTSkaDutx56aDCo+HLDzf/D26BIHTJWNiTG1KAJiQCg=="], + + "string-width": ["string-width@4.2.3", "", { "dependencies": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", "strip-ansi": "^6.0.1" } }, "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g=="], + "string.prototype.trim": ["string.prototype.trim@1.2.10", "", { "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.2", "define-data-property": "^1.1.4", "define-properties": "^1.2.1", "es-abstract": "^1.23.5", "es-object-atoms": "^1.0.0", "has-property-descriptors": "^1.0.2" } }, "sha512-Rs66F0P/1kedk5lyYyH9uBzuiI/kNRmwJAR9quK6VOtIpZ2G+hMZd+HQbbv25MgCA6gEffoMZYxlTod4WcdrKA=="], "string.prototype.trimend": ["string.prototype.trimend@1.0.9", "", { "dependencies": { "call-bind": "^1.0.8", "call-bound": "^1.0.2", "define-properties": "^1.2.1", "es-object-atoms": "^1.0.0" } }, "sha512-G7Ok5C6E/j4SGfyLCloXTrngQIQU3PWtXGst3yM7Bea9FRURf1S42ZHlZZtsNque2FN2PoUhfZXYLNWwEr4dLQ=="], "string.prototype.trimstart": ["string.prototype.trimstart@1.0.8", "", { "dependencies": { "call-bind": "^1.0.7", "define-properties": "^1.2.1", "es-object-atoms": "^1.0.0" } }, "sha512-UXSH262CSZY1tfu3G3Secr6uGLCFVPMhIqHjlgCUtCCcgihYc/xKs9djMTMUOb2j1mVSeU8EU6NWc/iQKU6Gfg=="], + "string_decoder": ["string_decoder@1.3.0", "", { "dependencies": { "safe-buffer": "~5.2.0" } }, "sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA=="], + + "strip-ansi": ["strip-ansi@6.0.1", "", { "dependencies": { "ansi-regex": "^5.0.1" } }, "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A=="], + "strip-bom": ["strip-bom@3.0.0", "", {}, "sha512-vavAMRXOgBVNF6nyEEmL3DBK19iRpDcoIwW+swQ+CbGiu7lju6t+JklA1MHweoWtadgt4ISVUsXLyDq34ddcwA=="], "strip-json-comments": ["strip-json-comments@3.1.1", "", {}, "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig=="], @@ -429,8 +536,14 @@ "supports-preserve-symlinks-flag": ["supports-preserve-symlinks-flag@1.0.0", "", {}, "sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w=="], + "tar": ["tar@6.2.1", "", { "dependencies": { "chownr": "^2.0.0", "fs-minipass": "^2.0.0", "minipass": "^5.0.0", "minizlib": "^2.1.1", "mkdirp": "^1.0.3", "yallist": "^4.0.0" } }, "sha512-DZ4yORTwrbTj/7MZYq2w+/ZFdI6OZ/f9SFHR+71gIVUZhOQPHzVCLpvRnPgyaMpfWxxk/4ONva3GQSyNIKRv6A=="], + + "text-hex": ["text-hex@1.0.0", "", {}, "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg=="], + "toml": ["toml@3.0.0", "", {}, "sha512-y/mWCZinnvxjTKYhJ+pYxwD0mRLVvOtdS2Awbgxln6iEnt4rk0yBxeSBHkGJcPucRiG0e55mwWp+g/05rsrd6w=="], + "triple-beam": ["triple-beam@1.4.1", "", {}, "sha512-aZbgViZrg1QNcG+LULa7nhZpJTZSLm/mXnHXnbAbjmN5aSa0y7V+wvv6+4WaBtpISJzThKy+PIPxc1Nq1EJ9mg=="], + "tsconfig-paths": ["tsconfig-paths@3.15.0", "", { "dependencies": { "@types/json5": "^0.0.29", "json5": "^1.0.2", "minimist": "^1.2.6", "strip-bom": "^3.0.0" } }, "sha512-2Ac2RgzDe/cn48GvOe3M+o82pEFewD3UPbyoUHHdKasHwJKjds4fLXWf/Ux5kATBKN20oaFGu+jbElp1pos0mg=="], "type-check": ["type-check@0.4.0", "", { "dependencies": { "prelude-ls": "^1.2.1" } }, "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew=="], @@ -459,6 +572,10 @@ "uri-js": ["uri-js@4.4.1", "", { "dependencies": { "punycode": "^2.1.0" } }, "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg=="], + "util-deprecate": ["util-deprecate@1.0.2", "", {}, "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw=="], + + "uuid": ["uuid@8.3.2", "", { "bin": { "uuid": "dist/bin/uuid" } }, "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="], + "which": ["which@2.0.2", "", { "dependencies": { "isexe": "^2.0.0" }, "bin": { "node-which": "./bin/node-which" } }, "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA=="], "which-boxed-primitive": ["which-boxed-primitive@1.1.1", "", { "dependencies": { "is-bigint": "^1.1.0", "is-boolean-object": "^1.2.1", "is-number-object": "^1.1.1", "is-string": "^1.1.1", "is-symbol": "^1.1.1" } }, "sha512-TbX3mj8n0odCBFVlY8AxkqcHASw3L60jIuF8jFP78az3C2YhmGvqbHBpAjTRH2/xqYunrJ9g1jSyjCjpoWzIAA=="], @@ -467,12 +584,28 @@ "which-collection": ["which-collection@1.0.2", "", { "dependencies": { "is-map": "^2.0.3", "is-set": "^2.0.3", "is-weakmap": "^2.0.2", "is-weakset": "^2.0.3" } }, "sha512-K4jVyjnBdgvc86Y6BkaLZEN933SwYOuBFkdmBu9ZfkcAbdVbpITnDmjvZ/aQjRXQrv5EPkTnD1s39GiiqbngCw=="], + "which-module": ["which-module@2.0.1", "", {}, "sha512-iBdZ57RDvnOR9AGBhML2vFZf7h8vmBjhoaZqODJBFWHVtKkDmKuHai3cx5PgVMrX5YDNp27AofYbAwctSS+vhQ=="], + "which-typed-array": ["which-typed-array@1.1.18", "", { "dependencies": { "available-typed-arrays": "^1.0.7", "call-bind": "^1.0.8", "call-bound": "^1.0.3", "for-each": "^0.3.3", "gopd": "^1.2.0", "has-tostringtag": "^1.0.2" } }, "sha512-qEcY+KJYlWyLH9vNbsr6/5j59AXk5ni5aakf8ldzBvGde6Iz4sxZGkJyWSAueTG7QhOvNRYb1lDdFmL5Td0QKA=="], + "winston": ["winston@3.17.0", "", { "dependencies": { "@colors/colors": "^1.6.0", "@dabh/diagnostics": "^2.0.2", "async": "^3.2.3", "is-stream": "^2.0.0", "logform": "^2.7.0", "one-time": "^1.0.0", "readable-stream": "^3.4.0", "safe-stable-stringify": "^2.3.1", "stack-trace": "0.0.x", "triple-beam": "^1.3.0", "winston-transport": "^4.9.0" } }, "sha512-DLiFIXYC5fMPxaRg832S6F5mJYvePtmO5G9v9IgUFPhXm9/GkXarH/TUrBAVzhTCzAj9anE/+GjrgXp/54nOgw=="], + + "winston-transport": ["winston-transport@4.9.0", "", { "dependencies": { "logform": "^2.7.0", "readable-stream": "^3.6.2", "triple-beam": "^1.3.0" } }, "sha512-8drMJ4rkgaPo1Me4zD/3WLfI/zPdA9o2IipKODunnGDcuqbHwjsbB79ylv04LCGGzU0xQ6vTznOMpQGaLhhm6A=="], + "word-wrap": ["word-wrap@1.2.5", "", {}, "sha512-BN22B5eaMMI9UMtjrGd5g5eCYPpCPDUy0FJXbYsaT5zYxjFOckS53SQDE3pWkVoWpHXVb3BrYcEN4Twa55B5cA=="], + "wrap-ansi": ["wrap-ansi@6.2.0", "", { "dependencies": { "ansi-styles": "^4.0.0", "string-width": "^4.1.0", "strip-ansi": "^6.0.0" } }, "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA=="], + + "y18n": ["y18n@4.0.3", "", {}, "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ=="], + + "yallist": ["yallist@4.0.0", "", {}, "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="], + "yaml": ["yaml@2.7.0", "", { "bin": { "yaml": "bin.mjs" } }, "sha512-+hSoy/QHluxmC9kCIJyL/uyFmLmc+e5CFR5Wa+bpIhIj85LVb9ZH2nVnqrHoSvKogwODv0ClqZkmiSSaIH5LTA=="], + "yargs": ["yargs@15.4.1", "", { "dependencies": { "cliui": "^6.0.0", "decamelize": "^1.2.0", "find-up": "^4.1.0", "get-caller-file": "^2.0.1", "require-directory": "^2.1.1", "require-main-filename": "^2.0.0", "set-blocking": "^2.0.0", "string-width": "^4.2.0", "which-module": "^2.0.0", "y18n": "^4.0.0", "yargs-parser": "^18.1.2" } }, "sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A=="], + + "yargs-parser": ["yargs-parser@18.1.3", "", { "dependencies": { "camelcase": "^5.0.0", "decamelize": "^1.2.0" } }, "sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ=="], + "yocto-queue": ["yocto-queue@0.1.0", "", {}, "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q=="], "@eslint-community/eslint-utils/eslint-visitor-keys": ["eslint-visitor-keys@3.4.3", "", {}, "sha512-wpc+LXeiyiisxPlEkUzU6svyS1frIO3Mgxj1fdy7Pm8Ygzguax2N3Fa/D/ag1WqbOprdI+uY6wMUl8/a2G+iag=="], @@ -481,6 +614,8 @@ "@humanfs/node/@humanwhocodes/retry": ["@humanwhocodes/retry@0.3.1", "", {}, "sha512-JBxkERygn7Bv/GbN5Rv8Ul6LVknS+5Bp6RgDC/O8gEBU/yeH5Ui5C/OlWrTb6qct7LjjfT6Re2NxB0ln0yYybA=="], + "color/color-convert": ["color-convert@1.9.3", "", { "dependencies": { "color-name": "1.1.3" } }, "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg=="], + "eslint-import-resolver-node/debug": ["debug@3.2.7", "", { "dependencies": { "ms": "^2.1.1" } }, "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ=="], "eslint-module-utils/debug": ["debug@3.2.7", "", { "dependencies": { "ms": "^2.1.1" } }, "sha512-CFjzYYAi4ThfiQvizrFQevTTXHtnCqWfe7x1AhgEscTz6ZbLbfoLRLPugTQyBth6f8ZERVUSyWHFD/7Wu4t1XQ=="], @@ -491,8 +626,22 @@ "eslint-plugin-n/globals": ["globals@13.24.0", "", { "dependencies": { "type-fest": "^0.20.2" } }, "sha512-AhO5QUcj8llrbG09iWhPU2B204J1xnPeL8kQmVorSsy+Sjj1sk8gIyh6cUocGmH4L0UuhAJy+hJMRA4mgA4mFQ=="], + "fs-minipass/minipass": ["minipass@3.3.6", "", { "dependencies": { "yallist": "^4.0.0" } }, "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw=="], + + "minizlib/minipass": ["minipass@3.3.6", "", { "dependencies": { "yallist": "^4.0.0" } }, "sha512-DxiNidxSEK+tHG6zOIklvNOwm3hvCrbUrdtzY74U6HKTJxvIDfOUL5W5P2Ghd3DTkhhKPYGqeNUIh5qcM4YBfw=="], + "typedoc/minimatch": ["minimatch@9.0.5", "", { "dependencies": { "brace-expansion": "^2.0.1" } }, "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow=="], + "yargs/find-up": ["find-up@4.1.0", "", { "dependencies": { "locate-path": "^5.0.0", "path-exists": "^4.0.0" } }, "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw=="], + + "color/color-convert/color-name": ["color-name@1.1.3", "", {}, "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw=="], + "typedoc/minimatch/brace-expansion": ["brace-expansion@2.0.1", "", { "dependencies": { "balanced-match": "^1.0.0" } }, "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA=="], + + "yargs/find-up/locate-path": ["locate-path@5.0.0", "", { "dependencies": { "p-locate": "^4.1.0" } }, "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g=="], + + "yargs/find-up/locate-path/p-locate": ["p-locate@4.1.0", "", { "dependencies": { "p-limit": "^2.2.0" } }, "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A=="], + + "yargs/find-up/locate-path/p-locate/p-limit": ["p-limit@2.3.0", "", { "dependencies": { "p-try": "^2.0.0" } }, "sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w=="], } } diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 6fd5c1f..0000000 --- a/docs/README.md +++ /dev/null @@ -1,67 +0,0 @@ -**packwizjs** - -*** - -# PackwizJS - -A simple JavaScript module to parse the contents of Packwiz index files. - -## Installation - -TODO - -## Usage - -See the [documentation](./docs) for more information. - -### Basic Example - -```ts -> import { parsePackwiz } from "packwizjs"; -> const packwizFile = await parsePackwiz("./packwiz/pack.toml") -Packwiz { - location: Resource { path: 'packwiz/pack.toml' }, - index: { // The index file is automatically parsed alongside the pack.toml file - location: Resource { path: 'packwiz/index.toml' }, - hash: '6ce48b376540c840b9c2c1eaedbdf64f3b0e1203888ea644fc5d8fff66377c18', - hashFormat: 'sha256', - files: [ - [IndexFileEntry], - [IndexFileEntry], - [IndexFileEntry], - [IndexFileEntry] - ] - }, - name: 'PackwizJS Testing Pack', - packFormat: 'packwiz:1.1.0', - authors: [ 'cswimr', 'GalacticFactory' ], - description: 'PackwizJS Testing Pack', - version: '1.0.0', - versions: { - minecraft: '1.21.4', - fabric: '0.16.10', - forge: undefined, - neoforge: undefined, - quilt: undefined, - liteloader: undefined - } -} -> await packwizFile.index.files[2].parse() -{ - name: 'Fabric API', - filename: 'fabric-api-0.115.1+1.21.4.jar', - side: 'both', - provider: ModrinthProvider { - hash: 'd5e9f87679b5edc9786e651fc481f8861a9cf53ed381890a1cb5e129222d6c5fa99f06045007f8e1fba02da686cdb6db2d99b334a1d23881cb56dfa199932eea', - hashFormat: 'sha512', - url: Resource { - path: 'https://cdn.modrinth.com/data/P7dR8mSH/versions/UnrycCWP/fabric-api-0.115.1%2B1.21.4.jar' - }, - modId: 'P7dR8mSH', - versionId: 'UnrycCWP' - }, - isOptional: false, - isDefault: true, - description: undefined -} -``` diff --git a/docs/enums/hash-format/README.md b/docs/enums/hash-format/README.md deleted file mode 100644 index 1fe021c..0000000 --- a/docs/enums/hash-format/README.md +++ /dev/null @@ -1,15 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / enums/hash-format - -# enums/hash-format - -## Enumerations - -- [HashFormat](enumerations/HashFormat.md) - -## Functions - -- [isValidHashFormat](functions/isValidHashFormat.md) diff --git a/docs/enums/hash-format/enumerations/HashFormat.md b/docs/enums/hash-format/enumerations/HashFormat.md deleted file mode 100644 index 8c5f4c5..0000000 --- a/docs/enums/hash-format/enumerations/HashFormat.md +++ /dev/null @@ -1,51 +0,0 @@ -[**packwizjs**](../../../README.md) - -*** - -[packwizjs](../../../modules.md) / [enums/hash-format](../README.md) / HashFormat - -# Enumeration: HashFormat - -Defined in: enums/hash-format.ts:4 - -The hash formats allowed by Packwiz. - -## Enumeration Members - -### md5 - -> **md5**: `"md5"` - -Defined in: enums/hash-format.ts:8 - -*** - -### murmur2 - -> **murmur2**: `"murmur2"` - -Defined in: enums/hash-format.ts:9 - -*** - -### sha1 - -> **sha1**: `"sha1"` - -Defined in: enums/hash-format.ts:7 - -*** - -### sha256 - -> **sha256**: `"sha256"` - -Defined in: enums/hash-format.ts:5 - -*** - -### sha512 - -> **sha512**: `"sha512"` - -Defined in: enums/hash-format.ts:6 diff --git a/docs/enums/hash-format/functions/isValidHashFormat.md b/docs/enums/hash-format/functions/isValidHashFormat.md deleted file mode 100644 index 43542ed..0000000 --- a/docs/enums/hash-format/functions/isValidHashFormat.md +++ /dev/null @@ -1,27 +0,0 @@ -[**packwizjs**](../../../README.md) - -*** - -[packwizjs](../../../modules.md) / [enums/hash-format](../README.md) / isValidHashFormat - -# Function: isValidHashFormat() - -> **isValidHashFormat**(`hashFormat`): [`HashFormat`](../enumerations/HashFormat.md) - -Defined in: enums/hash-format.ts:17 - -Checks if the provided hash format is allowed by Packwiz. - -## Parameters - -### hashFormat - -`string` - -The hash format to check. - -## Returns - -[`HashFormat`](../enumerations/HashFormat.md) - -The HashFormat enum value if valid, otherwise throws an error. diff --git a/docs/enums/side/README.md b/docs/enums/side/README.md deleted file mode 100644 index 1aeced4..0000000 --- a/docs/enums/side/README.md +++ /dev/null @@ -1,15 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / enums/side - -# enums/side - -## Enumerations - -- [Side](enumerations/Side.md) - -## Functions - -- [isValidSide](functions/isValidSide.md) diff --git a/docs/enums/side/enumerations/Side.md b/docs/enums/side/enumerations/Side.md deleted file mode 100644 index df0c308..0000000 --- a/docs/enums/side/enumerations/Side.md +++ /dev/null @@ -1,35 +0,0 @@ -[**packwizjs**](../../../README.md) - -*** - -[packwizjs](../../../modules.md) / [enums/side](../README.md) / Side - -# Enumeration: Side - -Defined in: enums/side.ts:4 - -The sides allowed by Packwiz. - -## Enumeration Members - -### Both - -> **Both**: `"both"` - -Defined in: enums/side.ts:5 - -*** - -### Client - -> **Client**: `"client"` - -Defined in: enums/side.ts:6 - -*** - -### Server - -> **Server**: `"server"` - -Defined in: enums/side.ts:7 diff --git a/docs/enums/side/functions/isValidSide.md b/docs/enums/side/functions/isValidSide.md deleted file mode 100644 index dbb8cd4..0000000 --- a/docs/enums/side/functions/isValidSide.md +++ /dev/null @@ -1,27 +0,0 @@ -[**packwizjs**](../../../README.md) - -*** - -[packwizjs](../../../modules.md) / [enums/side](../README.md) / isValidSide - -# Function: isValidSide() - -> **isValidSide**(`side`): [`Side`](../enumerations/Side.md) - -Defined in: enums/side.ts:15 - -Checks if the provided side is allowed by Packwiz. - -## Parameters - -### side - -The side to check. - -`undefined` | `string` - -## Returns - -[`Side`](../enumerations/Side.md) - -The Side enum value if valid, otherwise throws an error. diff --git a/docs/modules.md b/docs/modules.md deleted file mode 100644 index d2e051a..0000000 --- a/docs/modules.md +++ /dev/null @@ -1,13 +0,0 @@ -[**packwizjs**](README.md) - -*** - -# packwizjs - -## Modules - -- [enums/hash-format](enums/hash-format/README.md) -- [enums/side](enums/side/README.md) -- [parser](parser/README.md) -- [provider](provider/README.md) -- [resource](resource/README.md) diff --git a/docs/parser/README.md b/docs/parser/README.md deleted file mode 100644 index af6f816..0000000 --- a/docs/parser/README.md +++ /dev/null @@ -1,22 +0,0 @@ -[**packwizjs**](../README.md) - -*** - -[packwizjs](../modules.md) / parser - -# parser - -## Classes - -- [IndexFileEntry](classes/IndexFileEntry.md) -- [Packwiz](classes/Packwiz.md) - -## Interfaces - -- [Metafile](interfaces/Metafile.md) -- [PackwizIndex](interfaces/PackwizIndex.md) -- [PackwizVersions](interfaces/PackwizVersions.md) - -## Functions - -- [parsePackwiz](functions/parsePackwiz.md) diff --git a/docs/parser/classes/IndexFileEntry.md b/docs/parser/classes/IndexFileEntry.md deleted file mode 100644 index 61c02ac..0000000 --- a/docs/parser/classes/IndexFileEntry.md +++ /dev/null @@ -1,139 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [parser](../README.md) / IndexFileEntry - -# Class: IndexFileEntry - -Defined in: parser.ts:29 - -Represents a file entry in the Packwiz index. - -## Constructors - -### new IndexFileEntry() - -> **new IndexFileEntry**(`file`, `hash`, `hashFormat`, `alias`?, `metafile`?, `preserve`?): [`IndexFileEntry`](IndexFileEntry.md) - -Defined in: parser.ts:39 - -Creates a new IndexFileEntry instance. - -#### Parameters - -##### file - -[`Resource`](../../resource/classes/Resource.md) - -The Resource instance representing the file. - -##### hash - -`string` - -The hash of the file. - -##### hashFormat - -[`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -The format of the hash. - -##### alias? - -`string` - -An optional alias for the file that will be downloaded by this file. - -##### metafile? - -`boolean` = `false` - -Whether the file is a metafile. - -##### preserve? - -`boolean` = `false` - -Whether to preserve the file downloaded by this file if it is modified by an end user. - -#### Returns - -[`IndexFileEntry`](IndexFileEntry.md) - -## Properties - -### alias? - -> `readonly` `optional` **alias**: `string` - -Defined in: parser.ts:43 - -An optional alias for the file that will be downloaded by this file. - -*** - -### file - -> `readonly` **file**: [`Resource`](../../resource/classes/Resource.md) - -Defined in: parser.ts:40 - -The Resource instance representing the file. - -*** - -### hash - -> `readonly` **hash**: `string` - -Defined in: parser.ts:41 - -The hash of the file. - -*** - -### hashFormat - -> `readonly` **hashFormat**: [`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -Defined in: parser.ts:42 - -The format of the hash. - -*** - -### metafile - -> `readonly` **metafile**: `boolean` = `false` - -Defined in: parser.ts:44 - -Whether the file is a metafile. - -*** - -### preserve - -> `readonly` **preserve**: `boolean` = `false` - -Defined in: parser.ts:45 - -Whether to preserve the file downloaded by this file if it is modified by an end user. - -## Methods - -### parse() - -> **parse**(): `Promise`\<[`Metafile`](../interfaces/Metafile.md)\> - -Defined in: parser.ts:59 - -Parses the TOML file and returns its contents. - -#### Returns - -`Promise`\<[`Metafile`](../interfaces/Metafile.md)\> - -The parsed file as a structured object. diff --git a/docs/parser/classes/Packwiz.md b/docs/parser/classes/Packwiz.md deleted file mode 100644 index e7c742d..0000000 --- a/docs/parser/classes/Packwiz.md +++ /dev/null @@ -1,155 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [parser](../README.md) / Packwiz - -# Class: Packwiz - -Defined in: parser.ts:151 - -A class representing a Packwiz TOML file. - -## Constructors - -### new Packwiz() - -> **new Packwiz**(`location`, `index`, `name`, `packFormat`, `authors`, `description`, `version`, `versions`): [`Packwiz`](Packwiz.md) - -Defined in: parser.ts:163 - -Creates a new Packwiz instance. - -#### Parameters - -##### location - -[`Resource`](../../resource/classes/Resource.md) - -The location of the TOML file. - -##### index - -[`PackwizIndex`](../interfaces/PackwizIndex.md) - -The index of the TOML file. - -##### name - -`string` - -The name of the pack. - -##### packFormat - -`string` = `"packwiz:1.0.0"` - -The packwiz version of the TOML file. - -##### authors - -`string`[] - -The authors of the pack. - -##### description - -`string` - -The description of the pack. - -##### version - -`string` - -The version of the pack. - -##### versions - -[`PackwizVersions`](../interfaces/PackwizVersions.md) - -The Minecraft / modloader versions that the pack uses. - -#### Returns - -[`Packwiz`](Packwiz.md) - -## Properties - -### authors - -> `readonly` **authors**: `string`[] - -Defined in: parser.ts:168 - -The authors of the pack. - -*** - -### description - -> `readonly` **description**: `string` - -Defined in: parser.ts:169 - -The description of the pack. - -*** - -### index - -> `readonly` **index**: [`PackwizIndex`](../interfaces/PackwizIndex.md) - -Defined in: parser.ts:165 - -The index of the TOML file. - -*** - -### location - -> `readonly` **location**: [`Resource`](../../resource/classes/Resource.md) - -Defined in: parser.ts:164 - -The location of the TOML file. - -*** - -### name - -> `readonly` **name**: `string` - -Defined in: parser.ts:166 - -The name of the pack. - -*** - -### packFormat - -> `readonly` **packFormat**: `string` = `"packwiz:1.0.0"` - -Defined in: parser.ts:167 - -The packwiz version of the TOML file. - -*** - -### version - -> `readonly` **version**: `string` - -Defined in: parser.ts:170 - -The version of the pack. - -*** - -### versions - -> `readonly` **versions**: [`PackwizVersions`](../interfaces/PackwizVersions.md) - -Defined in: parser.ts:171 - -The Minecraft / modloader versions that the pack uses. diff --git a/docs/parser/functions/parsePackwiz.md b/docs/parser/functions/parsePackwiz.md deleted file mode 100644 index 08b1539..0000000 --- a/docs/parser/functions/parsePackwiz.md +++ /dev/null @@ -1,27 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [parser](../README.md) / parsePackwiz - -# Function: parsePackwiz() - -> **parsePackwiz**(`filePath`): `Promise`\<[`Packwiz`](../classes/Packwiz.md)\> - -Defined in: parser.ts:193 - -Parses a packwiz.toml file and returns its contents. - -## Parameters - -### filePath - -`string` - -The path of the TOML file. - -## Returns - -`Promise`\<[`Packwiz`](../classes/Packwiz.md)\> - -The parsed file as a structured class. diff --git a/docs/parser/interfaces/Metafile.md b/docs/parser/interfaces/Metafile.md deleted file mode 100644 index 8a86d10..0000000 --- a/docs/parser/interfaces/Metafile.md +++ /dev/null @@ -1,67 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [parser](../README.md) / Metafile - -# Interface: Metafile - -Defined in: parser.ts:16 - -The structure of a Packwiz metafile. - -## Properties - -### description? - -> `optional` **description**: `string` - -Defined in: parser.ts:23 - -*** - -### filename - -> **filename**: `string` - -Defined in: parser.ts:18 - -*** - -### isDefault - -> **isDefault**: `boolean` - -Defined in: parser.ts:22 - -*** - -### isOptional - -> **isOptional**: `boolean` - -Defined in: parser.ts:21 - -*** - -### name - -> **name**: `string` - -Defined in: parser.ts:17 - -*** - -### provider - -> **provider**: [`UrlProvider`](../../provider/classes/UrlProvider.md) - -Defined in: parser.ts:20 - -*** - -### side - -> **side**: [`Side`](../../enums/side/enumerations/Side.md) - -Defined in: parser.ts:19 diff --git a/docs/parser/interfaces/PackwizIndex.md b/docs/parser/interfaces/PackwizIndex.md deleted file mode 100644 index 15fe736..0000000 --- a/docs/parser/interfaces/PackwizIndex.md +++ /dev/null @@ -1,43 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [parser](../README.md) / PackwizIndex - -# Interface: PackwizIndex - -Defined in: parser.ts:128 - -Represents the structure of a Packwiz index file, as well as providing its location. - -## Properties - -### files - -> **files**: [`IndexFileEntry`](../classes/IndexFileEntry.md)[] - -Defined in: parser.ts:132 - -*** - -### hash - -> **hash**: `string` - -Defined in: parser.ts:130 - -*** - -### hashFormat - -> **hashFormat**: [`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -Defined in: parser.ts:131 - -*** - -### location - -> **location**: [`Resource`](../../resource/classes/Resource.md) - -Defined in: parser.ts:129 diff --git a/docs/parser/interfaces/PackwizVersions.md b/docs/parser/interfaces/PackwizVersions.md deleted file mode 100644 index 84a350a..0000000 --- a/docs/parser/interfaces/PackwizVersions.md +++ /dev/null @@ -1,60 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [parser](../README.md) / PackwizVersions - -# Interface: PackwizVersions - -Defined in: parser.ts:139 - -Represents modloaders present in the pack. -If any of these are not undefined, applications using this information should install the specific version of the modlaoder listed. - -## Properties - -### fabric? - -> `optional` **fabric**: `string` - -Defined in: parser.ts:141 - -*** - -### forge? - -> `optional` **forge**: `string` - -Defined in: parser.ts:142 - -*** - -### liteloader? - -> `optional` **liteloader**: `string` - -Defined in: parser.ts:145 - -*** - -### minecraft - -> **minecraft**: `string` - -Defined in: parser.ts:140 - -*** - -### neoforge? - -> `optional` **neoforge**: `string` - -Defined in: parser.ts:143 - -*** - -### quilt? - -> `optional` **quilt**: `string` - -Defined in: parser.ts:144 diff --git a/docs/provider/README.md b/docs/provider/README.md deleted file mode 100644 index 37f4d6c..0000000 --- a/docs/provider/README.md +++ /dev/null @@ -1,14 +0,0 @@ -[**packwizjs**](../README.md) - -*** - -[packwizjs](../modules.md) / provider - -# provider - -## Classes - -- [CurseForgeProvider](classes/CurseForgeProvider.md) -- [GitHubProvider](classes/GitHubProvider.md) -- [ModrinthProvider](classes/ModrinthProvider.md) -- [UrlProvider](classes/UrlProvider.md) diff --git a/docs/provider/classes/CurseForgeProvider.md b/docs/provider/classes/CurseForgeProvider.md deleted file mode 100644 index 21b7e61..0000000 --- a/docs/provider/classes/CurseForgeProvider.md +++ /dev/null @@ -1,138 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [provider](../README.md) / CurseForgeProvider - -# Class: CurseForgeProvider - -Defined in: provider.ts:77 - -URL provider for handling CurseForge-related URLs. -Extends the UrlProvider with CurseForge-specific properties. - -## Extends - -- [`UrlProvider`](UrlProvider.md) - -## Constructors - -### new CurseForgeProvider() - -> **new CurseForgeProvider**(`hash`, `hashFormat`, `mode`, `fileId`, `projectId`): [`CurseForgeProvider`](CurseForgeProvider.md) - -Defined in: provider.ts:86 - -Creates a new CurseForgeProvider instance. - -#### Parameters - -##### hash - -`string` - -A hash string used for identification or verification. - -##### hashFormat - -[`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -The format of the provided hash. - -##### mode - -`string` - -The mode indicating how the CurseForge file should be accessed. - -##### fileId - -`number` - -The identifier for the file on CurseForge. - -##### projectId - -`number` - -The identifier for the project on CurseForge. - -#### Returns - -[`CurseForgeProvider`](CurseForgeProvider.md) - -#### Overrides - -[`UrlProvider`](UrlProvider.md).[`constructor`](UrlProvider.md#constructors) - -## Properties - -### fileId - -> **fileId**: `number` - -Defined in: provider.ts:90 - -The identifier for the file on CurseForge. - -*** - -### hash - -> **hash**: `string` - -Defined in: provider.ts:15 - -A hash string used for identifying or verifying the resource. - -#### Inherited from - -[`UrlProvider`](UrlProvider.md).[`hash`](UrlProvider.md#hash-1) - -*** - -### hashFormat - -> **hashFormat**: [`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -Defined in: provider.ts:16 - -The format of the provided hash. - -#### Inherited from - -[`UrlProvider`](UrlProvider.md).[`hashFormat`](UrlProvider.md#hashformat-1) - -*** - -### mode - -> **mode**: `string` - -Defined in: provider.ts:89 - -The mode indicating how the CurseForge file should be accessed. - -*** - -### projectId - -> **projectId**: `number` - -Defined in: provider.ts:91 - -The identifier for the project on CurseForge. - -*** - -### url - -> **url**: [`Resource`](../../resource/classes/Resource.md) - -Defined in: provider.ts:17 - -A Resource instance representing the URL. - -#### Inherited from - -[`UrlProvider`](UrlProvider.md).[`url`](UrlProvider.md#url-1) diff --git a/docs/provider/classes/GitHubProvider.md b/docs/provider/classes/GitHubProvider.md deleted file mode 100644 index 5f131e6..0000000 --- a/docs/provider/classes/GitHubProvider.md +++ /dev/null @@ -1,160 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [provider](../README.md) / GitHubProvider - -# Class: GitHubProvider - -Defined in: provider.ts:49 - -URL provider for handling GitHub-related URLs. -Extends the UrlProvider with GitHub-specific properties. - -## Extends - -- [`UrlProvider`](UrlProvider.md) - -## Constructors - -### new GitHubProvider() - -> **new GitHubProvider**(`hash`, `hashFormat`, `url`, `branch`, `regex`, `slug`, `tag`): [`GitHubProvider`](GitHubProvider.md) - -Defined in: provider.ts:60 - -Creates a new GitHubProvider instance. - -#### Parameters - -##### hash - -`string` - -A hash string used for identification or verification. - -##### hashFormat - -[`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -The format of the hash. - -##### url - -[`Resource`](../../resource/classes/Resource.md) - -A Resource instance representing the URL. - -##### branch - -`string` - -The branch name within the GitHub repository. - -##### regex - -`string` - -A regular expression for matching specific patterns in the GitHub URL. - -##### slug - -`string` - -A URL slug used for identifying the repository. - -##### tag - -`string` - -The tag associated with the GitHub resource. - -#### Returns - -[`GitHubProvider`](GitHubProvider.md) - -#### Overrides - -[`UrlProvider`](UrlProvider.md).[`constructor`](UrlProvider.md#constructors) - -## Properties - -### branch - -> **branch**: `string` - -Defined in: provider.ts:64 - -The branch name within the GitHub repository. - -*** - -### hash - -> **hash**: `string` - -Defined in: provider.ts:15 - -A hash string used for identifying or verifying the resource. - -#### Inherited from - -[`UrlProvider`](UrlProvider.md).[`hash`](UrlProvider.md#hash-1) - -*** - -### hashFormat - -> **hashFormat**: [`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -Defined in: provider.ts:16 - -The format of the provided hash. - -#### Inherited from - -[`UrlProvider`](UrlProvider.md).[`hashFormat`](UrlProvider.md#hashformat-1) - -*** - -### regex - -> **regex**: `string` - -Defined in: provider.ts:65 - -A regular expression for matching specific patterns in the GitHub URL. - -*** - -### slug - -> **slug**: `string` - -Defined in: provider.ts:66 - -A URL slug used for identifying the repository. - -*** - -### tag - -> **tag**: `string` - -Defined in: provider.ts:67 - -The tag associated with the GitHub resource. - -*** - -### url - -> **url**: [`Resource`](../../resource/classes/Resource.md) - -Defined in: provider.ts:17 - -A Resource instance representing the URL. - -#### Inherited from - -[`UrlProvider`](UrlProvider.md).[`url`](UrlProvider.md#url-1) diff --git a/docs/provider/classes/ModrinthProvider.md b/docs/provider/classes/ModrinthProvider.md deleted file mode 100644 index faf7312..0000000 --- a/docs/provider/classes/ModrinthProvider.md +++ /dev/null @@ -1,128 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [provider](../README.md) / ModrinthProvider - -# Class: ModrinthProvider - -Defined in: provider.ts:25 - -URL provider for handling Modrinth-related URLs. -Extends the UrlProvider with Modrinth-specific properties. - -## Extends - -- [`UrlProvider`](UrlProvider.md) - -## Constructors - -### new ModrinthProvider() - -> **new ModrinthProvider**(`hash`, `hashFormat`, `url`, `modId`, `versionId`): [`ModrinthProvider`](ModrinthProvider.md) - -Defined in: provider.ts:34 - -Creates a new ModrinthProvider instance. - -#### Parameters - -##### hash - -`string` - -A hash string used for identification or verification. - -##### hashFormat - -[`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -The format of the provided hash. - -##### url - -[`Resource`](../../resource/classes/Resource.md) - -A Resource instance representing the URL. - -##### modId - -`string` - -The identifier for the Modrinth mod. - -##### versionId - -`string` - -The version identifier for the mod. - -#### Returns - -[`ModrinthProvider`](ModrinthProvider.md) - -#### Overrides - -[`UrlProvider`](UrlProvider.md).[`constructor`](UrlProvider.md#constructors) - -## Properties - -### hash - -> **hash**: `string` - -Defined in: provider.ts:15 - -A hash string used for identifying or verifying the resource. - -#### Inherited from - -[`UrlProvider`](UrlProvider.md).[`hash`](UrlProvider.md#hash-1) - -*** - -### hashFormat - -> **hashFormat**: [`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -Defined in: provider.ts:16 - -The format of the provided hash. - -#### Inherited from - -[`UrlProvider`](UrlProvider.md).[`hashFormat`](UrlProvider.md#hashformat-1) - -*** - -### modId - -> **modId**: `string` - -Defined in: provider.ts:38 - -The identifier for the Modrinth mod. - -*** - -### url - -> **url**: [`Resource`](../../resource/classes/Resource.md) - -Defined in: provider.ts:17 - -A Resource instance representing the URL. - -#### Inherited from - -[`UrlProvider`](UrlProvider.md).[`url`](UrlProvider.md#url-1) - -*** - -### versionId - -> **versionId**: `string` - -Defined in: provider.ts:39 - -The version identifier for the mod. diff --git a/docs/provider/classes/UrlProvider.md b/docs/provider/classes/UrlProvider.md deleted file mode 100644 index 394d6e4..0000000 --- a/docs/provider/classes/UrlProvider.md +++ /dev/null @@ -1,81 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [provider](../README.md) / UrlProvider - -# Class: UrlProvider - -Defined in: provider.ts:7 - -Provides a base class for URL-based providers. - -## Extended by - -- [`ModrinthProvider`](ModrinthProvider.md) -- [`GitHubProvider`](GitHubProvider.md) -- [`CurseForgeProvider`](CurseForgeProvider.md) - -## Constructors - -### new UrlProvider() - -> **new UrlProvider**(`hash`, `hashFormat`, `url`): [`UrlProvider`](UrlProvider.md) - -Defined in: provider.ts:14 - -Creates a new UrlProvider instance. - -#### Parameters - -##### hash - -`string` - -A hash string used for identifying or verifying the resource. - -##### hashFormat - -[`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -The format of the provided hash. - -##### url - -[`Resource`](../../resource/classes/Resource.md) - -A Resource instance representing the URL. - -#### Returns - -[`UrlProvider`](UrlProvider.md) - -## Properties - -### hash - -> **hash**: `string` - -Defined in: provider.ts:15 - -A hash string used for identifying or verifying the resource. - -*** - -### hashFormat - -> **hashFormat**: [`HashFormat`](../../enums/hash-format/enumerations/HashFormat.md) - -Defined in: provider.ts:16 - -The format of the provided hash. - -*** - -### url - -> **url**: [`Resource`](../../resource/classes/Resource.md) - -Defined in: provider.ts:17 - -A Resource instance representing the URL. diff --git a/docs/resource/README.md b/docs/resource/README.md deleted file mode 100644 index 0baf7a3..0000000 --- a/docs/resource/README.md +++ /dev/null @@ -1,11 +0,0 @@ -[**packwizjs**](../README.md) - -*** - -[packwizjs](../modules.md) / resource - -# resource - -## Classes - -- [Resource](classes/Resource.md) diff --git a/docs/resource/classes/Resource.md b/docs/resource/classes/Resource.md deleted file mode 100644 index 9b5bbba..0000000 --- a/docs/resource/classes/Resource.md +++ /dev/null @@ -1,187 +0,0 @@ -[**packwizjs**](../../README.md) - -*** - -[packwizjs](../../modules.md) / [resource](../README.md) / Resource - -# Class: Resource - -Defined in: resource.ts:8 - -Resource class for handling file and URL paths. - -## Constructors - -### new Resource() - -> **new Resource**(`path`): [`Resource`](Resource.md) - -Defined in: resource.ts:13 - -Creates a new Resource instance. - -#### Parameters - -##### path - -`string` - -The file or URL path. - -#### Returns - -[`Resource`](Resource.md) - -## Properties - -### path - -> `readonly` **path**: `string` - -Defined in: resource.ts:13 - -The file or URL path. - -## Accessors - -### ext - -#### Get Signature - -> **get** **ext**(): `string` - -Defined in: resource.ts:63 - -Gets the file extension of the file or URL. - -##### Returns - -`string` - -The file extension of the file or URL. - -*** - -### isUrl - -#### Get Signature - -> **get** **isUrl**(): `boolean` - -Defined in: resource.ts:27 - -Checks if the path is a valid URL. - -##### Returns - -`boolean` - -True if the path is a valid URL, false otherwise. - -*** - -### name - -#### Get Signature - -> **get** **name**(): `string` - -Defined in: resource.ts:40 - -Gets the name of the file or URL. - -##### Returns - -`string` - -The name of the file or URL. - -*** - -### parent - -#### Get Signature - -> **get** **parent**(): [`Resource`](Resource.md) - -Defined in: resource.ts:50 - -Gets the parent directory of the file or URL. - -##### Returns - -[`Resource`](Resource.md) - -The parent directory of the file or URL. - -## Methods - -### exists() - -> **exists**(): `Promise`\<`boolean`\> - -Defined in: resource.ts:73 - -Checks if the file or URL exists. - -#### Returns - -`Promise`\<`boolean`\> - -True if the file or URL exists, false otherwise. - -*** - -### fetchContents() - -> **fetchContents**(): `Promise`\<`string`\> - -Defined in: resource.ts:87 - -Fetches the contents of the file or URL. - -#### Returns - -`Promise`\<`string`\> - -The contents of file the Resource points to. - -*** - -### join() - -> **join**(...`segments`): [`Resource`](Resource.md) - -Defined in: resource.ts:102 - -Joins the Resource with other segments to create a new Resource. - -#### Parameters - -##### segments - -...`string`[] - -The segments to join with the Resource. - -#### Returns - -[`Resource`](Resource.md) - -A new Resource instance with the joined path. - -*** - -### toString() - -> **toString**(): `string` - -Defined in: resource.ts:19 - -Returns the string representation of the Resource instance. - -#### Returns - -`string` - -The path of the Resource. diff --git a/package.json b/package.json index cff955c..d929567 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,7 @@ "docs": "typedoc --options typedoc.json" }, "devDependencies": { + "@getmeli/cli": "^1.2.0", "@types/bun": "latest", "eslint": "9.20.0", "eslint-config-standard": "17.1.0", diff --git a/typedoc.json b/typedoc.json index 2cab686..9f3b619 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,23 @@ { "entryPoints": ["src/**/*.ts"], - "out": "docs", + "outputs": [ + { + "name": "html", + "path": "./docs/html", + "options": { + "naivgation": { + "includeCategories": true, + "includeGroups": true, + "excludeReferences": false, + "includeFolders": true + } + } + }, + { + "name": "markdown", + "path": "./docs/markdown" + } + ], "exclude": ["**/*+(test|spec).ts"], "theme": "default", "plugin": ["typedoc-plugin-markdown"],