{"_id":"@crit-fumble/worldanvil","_rev":"7-dae3aab75b9ffe447f58bd4d17318f7c","name":"@crit-fumble/worldanvil","dist-tags":{"latest":"3.1.0"},"versions":{"0.1.0":{"name":"@crit-fumble/worldanvil","version":"0.1.0","keywords":["worldanvil","api","client","crit-fumble","rpg","worldbuilding"],"author":{"name":"Crit-Fumble"},"license":"MIT","_id":"@crit-fumble/worldanvil@0.1.0","maintainers":[{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"}],"homepage":"https://github.com/your-username/crit-fumble#readme","bugs":{"url":"https://github.com/your-username/crit-fumble/issues"},"dist":{"shasum":"48e078cd7ca2027e259a1aab5c09957f4173969b","tarball":"https://registry.npmjs.org/@crit-fumble/worldanvil/-/worldanvil-0.1.0.tgz","fileCount":61,"integrity":"sha512-mQ9aEBojM2HNAwiSBPHHOuRMF1pwGgfOVWTTuIZMayzp9EPqckNtxkeYVRiserm7TDYPwfAd2ch+p0oqbWXKvA==","signatures":[{"sig":"MEUCIQDeEkFJtLdJsgcE5ptjpd8PND7OsTKDBem8IqAkx5VWvAIgF1b86UbWZV2IeIBoDL5Fobvbf8tPSJ+/CF6a0S5ZGZg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":45333},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./client":{"types":"./dist/client/index.d.ts","import":"./dist/client/index.js"},"./models":{"types":"./dist/models/index.d.ts","import":"./dist/models/index.js"},"./server":{"types":"./dist/server/index.d.ts","import":"./dist/server/index.js"}},"gitHead":"5034d555cbb007ea1641a36227ebb6bb59d2a420","scripts":{"lint":"eslint --config eslint.config.js models/**/*.ts server/**/*.ts client/**/*.ts","test":"jest --config jest.config.js","build":"tsc -p tsconfig.json","clean":"rimraf dist","prepare":"npm run clean && npm run build","publish-major":"npm version major && npm publish","publish-minor":"npm version minor && npm publish","publish-patch":"npm version patch && npm publish","extract-schema":"node scripts/extract-world-anvil-schema.js","prepublishOnly":"npm run test && npm run lint"},"_npmUser":{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"},"repository":{"url":"git+https://github.com/your-username/crit-fumble.git","type":"git","directory":"packages/worldanvil"},"_npmVersion":"10.9.1","description":"World Anvil API integration for Crit-Fumble","directories":{},"_nodeVersion":"20.12.2","dependencies":{"yaml":"^2.8.1","axios":"^1.6.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.5.0","rimraf":"^5.0.0","globals":"^16.3.0","ts-jest":"^29.1.0","typescript":"^5.1.6","@types/jest":"^29.5.0","@types/node":"^20.4.0","@typescript-eslint/parser":"^8.41.0","@typescript-eslint/eslint-plugin":"^8.41.0"},"_npmOperationalInternal":{"tmp":"tmp/worldanvil_0.1.0_1756660170625_0.9923489041729505","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"2.0.0-r1":{"name":"@crit-fumble/worldanvil","version":"2.0.0-r1","keywords":["worldanvil","api","client","crit-fumble","rpg","worldbuilding"],"author":{"name":"Crit-Fumble"},"license":"MIT","_id":"@crit-fumble/worldanvil@2.0.0-r1","maintainers":[{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"}],"homepage":"https://github.com/Crit-Fumble/crit-fumble#readme","bugs":{"url":"https://github.com/Crit-Fumble/crit-fumble/issues"},"dist":{"shasum":"7adc60f1c52a163f520ac3ff6ca33aa6bc28c87a","tarball":"https://registry.npmjs.org/@crit-fumble/worldanvil/-/worldanvil-2.0.0-r1.tgz","fileCount":97,"integrity":"sha512-QFUhjymCsRNzz7XkpsV9dWxPOS0GW3zk44ZlknLsSLPMautqNGi+6BxFLHJ7s7CuQpYi21+QH01pyLCOYN+Jkg==","signatures":[{"sig":"MEYCIQD7Srzr+v/pAz4o85v7TIRopKdVIeSmnh3u454pbR6o1QIhAMG36xUmo7fi1PBRER8+e2fXDvvGcCq0sAiEYUAJGcYd","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":294381},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./client":{"types":"./dist/client/index.d.ts","import":"./dist/client/index.js"},"./models":{"types":"./dist/models/index.d.ts","import":"./dist/models/index.js"},"./server":{"types":"./dist/server/index.d.ts","import":"./dist/server/index.js"}},"gitHead":"b3f098b2d6f096690538de35bbffe1a03d2f58a3","scripts":{"lint":"eslint --config eslint.config.js models/**/*.ts server/**/*.ts client/**/*.ts","test":"jest --config jest.config.js","build":"tsc -p tsconfig.json","clean":"rimraf dist","prepare":"npm run clean && npm run build","publish-major":"npm version major && npm publish","publish-minor":"npm version minor && npm publish","publish-patch":"npm version patch && npm publish","extract-schema":"node scripts/extract-world-anvil-schema.js","prepublishOnly":"npm run test && npm run lint"},"_npmUser":{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"},"repository":{"url":"git+https://github.com/Crit-Fumble/crit-fumble.git","type":"git","directory":"packages/worldanvil"},"_npmVersion":"10.9.1","description":"World Anvil API integration for Crit-Fumble; version matches World Anvil API version","directories":{},"_nodeVersion":"20.12.2","dependencies":{"yaml":"^2.8.1","axios":"^1.6.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.5.0","rimraf":"^5.0.0","globals":"^16.3.0","ts-jest":"^29.1.0","typescript":"^5.1.6","@types/jest":"^29.5.0","@types/node":"^20.4.0","@typescript-eslint/parser":"^8.41.0","@typescript-eslint/eslint-plugin":"^8.41.0"},"_npmOperationalInternal":{"tmp":"tmp/worldanvil_2.0.0-r1_1756784992328_0.9009006356072868","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"2.0.0-r2":{"name":"@crit-fumble/worldanvil","version":"2.0.0-r2","keywords":["worldanvil","api","client","crit-fumble","rpg","worldbuilding"],"author":{"name":"Crit-Fumble"},"license":"MIT","_id":"@crit-fumble/worldanvil@2.0.0-r2","maintainers":[{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"}],"homepage":"https://github.com/Crit-Fumble/crit-fumble#readme","bugs":{"url":"https://github.com/Crit-Fumble/crit-fumble/issues"},"dist":{"shasum":"57a9cebd33bdf458fdf0101675d3541d2aa59867","tarball":"https://registry.npmjs.org/@crit-fumble/worldanvil/-/worldanvil-2.0.0-r2.tgz","fileCount":95,"integrity":"sha512-oN045JX46MPw1TjpW1A6Fo8sjEWjPwil2YoYMYEECwm1n6ROE6iotjQxiJi3AcdC2+ofccfHbgrhLB569zhmwg==","signatures":[{"sig":"MEQCICYbIAcXbZfVtqVUryRJu858si4cwFUC0X5kdJkTTBGWAiBsO1Yt8Dv77AY8Q/URGz7xim+eRPJNB/6RfYg3DwWt8A==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":299275},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./client":{"types":"./dist/client/index.d.ts","import":"./dist/client/index.js"},"./models":{"types":"./dist/models/index.d.ts","import":"./dist/models/index.js"},"./server":{"types":"./dist/server/index.d.ts","import":"./dist/server/index.js"}},"gitHead":"840c78f468d8cc1a84380cba293f759ab4c3c470","scripts":{"lint":"eslint --config eslint.config.js models/**/*.ts server/**/*.ts client/**/*.ts","test":"jest --config jest.config.js","build":"tsc -p tsconfig.json","clean":"rimraf dist","prepare":"npm run clean && npm run build","publish-major":"npm version major && npm publish","publish-minor":"npm version minor && npm publish","publish-patch":"npm version patch && npm publish","extract-schema":"node scripts/extract-world-anvil-schema.js","prepublishOnly":"npm run test && npm run lint"},"_npmUser":{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"},"repository":{"url":"git+https://github.com/Crit-Fumble/crit-fumble.git","type":"git","directory":"packages/worldanvil"},"_npmVersion":"10.9.1","description":"World Anvil API integration for Crit-Fumble; version matches World Anvil API version","directories":{},"_nodeVersion":"20.12.2","dependencies":{"yaml":"^2.8.1","axios":"^1.6.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.5.0","rimraf":"^5.0.0","globals":"^16.3.0","ts-jest":"^29.1.0","typescript":"^5.1.6","@types/jest":"^29.5.0","@types/node":"^20.4.0","@typescript-eslint/parser":"^8.41.0","@typescript-eslint/eslint-plugin":"^8.41.0"},"_npmOperationalInternal":{"tmp":"tmp/worldanvil_2.0.0-r2_1756788777879_0.9031801731435896","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"2.0.0-r3":{"name":"@crit-fumble/worldanvil","version":"2.0.0-r3","keywords":["worldanvil","api","client","crit-fumble","rpg","worldbuilding"],"author":{"name":"Crit-Fumble"},"license":"MIT","_id":"@crit-fumble/worldanvil@2.0.0-r3","maintainers":[{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"}],"homepage":"https://github.com/Crit-Fumble/crit-fumble#readme","bugs":{"url":"https://github.com/Crit-Fumble/crit-fumble/issues"},"dist":{"shasum":"355925614ab0f08372c7a16705680828660bc5f9","tarball":"https://registry.npmjs.org/@crit-fumble/worldanvil/-/worldanvil-2.0.0-r3.tgz","fileCount":92,"integrity":"sha512-h86+Mpx9kIkYpk8wtmR2gi1DtxJ68eb1UrbKCzusABLroSidBR0LRKr3fj6dYisfLEYe1zFKmsAeGThjB1W6cQ==","signatures":[{"sig":"MEQCIAv/gx4fU1fxWpNoqrxoP/RkhD8KPLAqfnj4/izuhxLYAiBIQ2qP82BPZlLtFT90duZxA3VyPKmh+Iq56N/vrLAc2A==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":176595},"main":"dist/index.js","types":"dist/index.d.ts","module":"dist/index.js","engines":{"npm":">=9.0.0","node":">=22.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./client":{"types":"./dist/client/index.d.ts","import":"./dist/client/index.js"},"./models":{"types":"./dist/models/index.d.ts","import":"./dist/models/index.js"},"./server":{"types":"./dist/server/index.d.ts","import":"./dist/server/index.js"}},"gitHead":"b67d91c7da459e74fd652d9d204e914999ae2b58","scripts":{"lint":"eslint --config eslint.config.js models/**/*.ts server/**/*.ts client/**/*.ts","test":"jest --config jest.config.js","build":"tsc -p tsconfig.json","clean":"rimraf dist","prepare":"npm run clean && npm run build","publish-major":"npm version major && npm publish","publish-minor":"npm version minor && npm publish","publish-patch":"npm version patch && npm publish","extract-schema":"node scripts/extract-world-anvil-schema.js","prepublishOnly":"npm run test"},"_npmUser":{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"},"repository":{"url":"git+https://github.com/Crit-Fumble/crit-fumble.git","type":"git","directory":"packages/worldanvil"},"_npmVersion":"9.8.1","description":"World Anvil API integration for Crit-Fumble; version matches World Anvil API version","directories":{},"_nodeVersion":"22.17.0","dependencies":{"yaml":"^2.8.1","axios":"^1.6.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^29.5.0","rimraf":"^5.0.0","globals":"^16.3.0","ts-jest":"^29.1.0","typescript":"^5.1.6","@types/jest":"^29.5.0","@types/node":"^20.4.0","@typescript-eslint/parser":"^8.41.0","@typescript-eslint/eslint-plugin":"^8.41.0"},"_npmOperationalInternal":{"tmp":"tmp/worldanvil_2.0.0-r3_1758018850689_0.07804557044762128","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"3.0.0":{"name":"@crit-fumble/worldanvil","version":"3.0.0","keywords":["crit-fumble","worldanvil","world-anvil","worldbuilding","ttrpg","api-client"],"author":{"name":"Crit-Fumble"},"license":"MIT","_id":"@crit-fumble/worldanvil@3.0.0","maintainers":[{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"}],"homepage":"https://github.com/crit-fumble/core.crit-fumble.com#readme","bugs":{"url":"https://github.com/crit-fumble/core.crit-fumble.com/issues"},"dist":{"shasum":"d26389cb801deca8383b1c6e1d8d96dd30ad4061","tarball":"https://registry.npmjs.org/@crit-fumble/worldanvil/-/worldanvil-3.0.0.tgz","fileCount":61,"integrity":"sha512-G6zOPVqoe+qQXidkszkre1AhB7jNHWIw4AIHpd72dnqMIE3MgVn8WYAG/duURLlzSSbvlNhe2j6cOF3Swb8KgA==","signatures":[{"sig":"MEQCIEyDvPU+B/WC4YMnbqkmMGYcL/mn4tE0TSEWDAaeMhpMAiBJgJ5/zhQDty/DMU8fDupAz3C4wXekDxtOTfR4eDkqyw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":113321},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=20.19.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./types":{"types":"./dist/types/index.d.ts","import":"./dist/types/index.js"},"./client":{"types":"./dist/client/index.d.ts","import":"./dist/client/index.js"}},"gitHead":"e27327d55d0bf653497ddfceccd5f40e4f24d4a7","scripts":{"build":"tsc","clean":"rimraf dist","typecheck":"tsc --noEmit"},"_npmUser":{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"},"repository":{"url":"git+https://github.com/crit-fumble/core.crit-fumble.com.git","type":"git","directory":"packages/worldanvil"},"_npmVersion":"10.9.3","description":"Client SDK for World Anvil API - types and HTTP client for worldbuilding integration","directories":{},"_nodeVersion":"22.19.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^6.0.1","typescript":"^5.7.2"},"_npmOperationalInternal":{"tmp":"tmp/worldanvil_3.0.0_1764407123806_0.2756805959298787","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"3.1.0":{"name":"@crit-fumble/worldanvil","version":"3.1.0","keywords":["crit-fumble","worldanvil","world-anvil","worldbuilding","ttrpg","api-client"],"author":{"name":"Crit-Fumble"},"license":"MIT","_id":"@crit-fumble/worldanvil@3.1.0","maintainers":[{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"}],"homepage":"https://github.com/crit-fumble/core.crit-fumble.com#readme","bugs":{"url":"https://github.com/crit-fumble/core.crit-fumble.com/issues"},"dist":{"shasum":"35c4e0bcba36f27bdd71fb985eae77b95c4ced90","tarball":"https://registry.npmjs.org/@crit-fumble/worldanvil/-/worldanvil-3.1.0.tgz","fileCount":66,"integrity":"sha512-/3jD/RiDjyQ6gmSN2uRp6kH8p79Jv9jG55XouiY/VXJKQQRMtyEAIBr7QajyzWu5xL82gw9WRn7/Aae72iZazA==","signatures":[{"sig":"MEUCIQCFFWr/0+JOH7qeQ3AdnzbWwBL7/XQUr90Eo2Ys+VxOoAIgV7C8uFJfzkiqYniCAXF5+ZGm0lpbqCXjwpihB6uebpg=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":119301},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=20.19.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./types":{"types":"./dist/types/index.d.ts","import":"./dist/types/index.js"},"./client":{"types":"./dist/client/index.d.ts","import":"./dist/client/index.js"}},"gitHead":"e3f913fdd27ecde25d13454cb217c8643a400cec","scripts":{"build":"tsc","clean":"rimraf dist","typecheck":"tsc --noEmit"},"_npmUser":{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"},"repository":{"url":"git+https://github.com/crit-fumble/core.crit-fumble.com.git","type":"git","directory":"packages/worldanvil"},"_npmVersion":"10.9.3","description":"Client SDK for World Anvil API - types and HTTP client for worldbuilding integration","directories":{},"_nodeVersion":"22.19.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"rimraf":"^6.0.1","typescript":"^5.7.2"},"_npmOperationalInternal":{"tmp":"tmp/worldanvil_3.1.0_1764794948493_0.5576663083189854","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2025-08-31T17:09:30.554Z","modified":"2026-08-06T19:47:47.142Z","0.1.0":"2025-08-31T17:09:30.810Z","2.0.0-r1":"2025-09-02T03:49:52.530Z","2.0.0-r2":"2025-09-02T04:52:58.056Z","2.0.0-r3":"2025-09-16T10:34:10.853Z","3.0.0":"2025-11-29T09:05:24.023Z","3.1.0":"2025-12-03T20:49:08.644Z"},"bugs":{"url":"https://github.com/crit-fumble/core.crit-fumble.com/issues"},"author":{"name":"Crit-Fumble"},"license":"MIT","homepage":"https://github.com/crit-fumble/core.crit-fumble.com#readme","keywords":["crit-fumble","worldanvil","world-anvil","worldbuilding","ttrpg","api-client"],"repository":{"url":"git+https://github.com/crit-fumble/core.crit-fumble.com.git","type":"git","directory":"packages/worldanvil"},"description":"Client SDK for World Anvil API - types and HTTP client for worldbuilding integration","maintainers":[{"name":"hob.daytrain","email":"crit.fumble.web@gmail.com"}],"readme":"# @crit-fumble/worldanvil\r\n\r\nClient SDK for the [World Anvil](https://www.worldanvil.com) Boromir API (v2).\r\n\r\n## Installation\r\n\r\n```bash\r\nnpm install @crit-fumble/worldanvil\r\n```\r\n\r\n## Usage\r\n\r\n```typescript\r\nimport { WorldAnvilClient } from '@crit-fumble/worldanvil'\r\n\r\nconst client = new WorldAnvilClient({\r\n  applicationKey: process.env.WORLDANVIL_APP_KEY!,\r\n  authToken: process.env.WORLDANVIL_AUTH_TOKEN!,\r\n})\r\n\r\n// Get current user identity\r\nconst user = await client.identity()\r\nconsole.log(`Logged in as ${user.username}`)\r\n\r\n// List user's worlds\r\nconst { entities: worlds } = await client.worlds.list()\r\n\r\n// Get articles in a world\r\nconst { entities: articles } = await client.articles.listByWorld(worlds[0].id)\r\n\r\n// List available RPG systems\r\nconst { entities: systems } = await client.rpgSystems.list()\r\n```\r\n\r\n## API Coverage\r\n\r\n| Resource | List | Get | Create | Update | Delete |\r\n|----------|------|-----|--------|--------|--------|\r\n| Users | - | ✓ | - | - | - |\r\n| Worlds | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| Articles | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| Notebooks | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| Note Sections | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| Notes | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| Categories | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| Maps | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| Markers | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| Timelines | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| Histories | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| Images | ✓ | ✓ | - | - | - |\r\n| Secrets | ✓ | ✓ | ✓ | ✓ | ✓ |\r\n| RPG Systems | ✓ | ✓ | - | - | - |\r\n\r\n## Authentication\r\n\r\nYou need two keys to use the World Anvil API:\r\n\r\n1. **Application Key** - Obtained by [registering as a developer](https://www.worldanvil.com/api/external/boromir/documentation)\r\n2. **User Auth Token** - Generated from [User API Tokens page](https://www.worldanvil.com/api/auth/key)\r\n\r\n## License\r\n\r\nMIT\r\n","readmeFilename":"README.md"}