{"_id":"@averagehelper/resume-schema","_rev":"2-dc1c7d0f9237cbc8ce983443cfd63497","name":"@averagehelper/resume-schema","dist-tags":{"latest":"1.3.0"},"versions":{"1.2.0":{"name":"@averagehelper/resume-schema","version":"1.2.0","description":"JSON Resume Schema, with extras","main":"validator.js","types":"validator.d.ts","scripts":{"build":"cat schema.json | json2ts > resume.d.ts","test":"npm run validate && npm run test-units","validate":"ajv validate -s node_modules/json-metaschema/draft-07-schema -d schema","test-units":"tape **/*.spec.js | tap-spec","preversion":"npm test","postversion":"git push --follow-tags","prepublishOnly":"npm run build"},"repository":{"type":"git","url":"git://github.com/AverageHelper/resume-schema.git"},"license":"MIT","bugs":{"url":"https://github.com/AverageHelper/resume-schema/issues"},"dependencies":{"z-schema":"^4.2.4"},"devDependencies":{"ajv-cli":"^3.3.0","json-metaschema":"^1.3.0","json-schema-to-typescript":"13.1.2","tap-spec":"^5.0.0","tape":"^4.16.2"},"engines":{"node":">=10"},"_id":"@averagehelper/resume-schema@1.2.0","gitHead":"98904d5d6e63f2846f8ed51446e31d08c8bc2ded","homepage":"https://github.com/AverageHelper/resume-schema#readme","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-wZzaQHteZ1I9QVOesSNCQCxi7+jCM4YyZ91XkizhCk4E22txUDsTydKYAV5gmYlqZrYMQwe0xiIbNcWpLQvZZQ==","shasum":"23616f62e3503fd3551c69ffd6bd9621012859d7","tarball":"https://registry.npmjs.org/@averagehelper/resume-schema/-/resume-schema-1.2.0.tgz","fileCount":8,"unpackedSize":35784,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEYjKWA0k+zCwLo6kGUkOrZ20G+e0yA9DD+llusdCMltAiAbmnbiWFAte+5RB6jWwXAsoJA/Q9fZMCTNt6eRiFvIDw=="}]},"_npmUser":{"name":"averagehelper","email":"6d243cbc-4840-4590-9d09-2e6b1ecabcee@simplelogin.co"},"directories":{},"maintainers":[{"name":"averagehelper","email":"6d243cbc-4840-4590-9d09-2e6b1ecabcee@simplelogin.co"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/resume-schema_1.2.0_1706819802765_0.45015564202386815"},"_hasShrinkwrap":false},"1.2.1":{"name":"@averagehelper/resume-schema","version":"1.2.1","description":"JSON Resume Schema, with extras","main":"validator.js","types":"validator.d.ts","scripts":{"prebuild":"rm -f validator.js validator.d.ts resume.d.ts","build":"cat schema.json | json2ts > resume.d.ts && tsc -p tsconfig.json","test":"npm run build && npm run validate && npm run test-units","validate":"ajv validate -s node_modules/json-metaschema/draft-07-schema -d schema","test-units":"tape **/*.spec.js | tap-spec","preversion":"npm test","postversion":"git push --follow-tags","prepublishOnly":"npm run build"},"repository":{"type":"git","url":"git://github.com/AverageHelper/resume-schema.git"},"license":"MIT","bugs":{"url":"https://github.com/AverageHelper/resume-schema/issues"},"dependencies":{"z-schema":"^4.2.4"},"devDependencies":{"ajv-cli":"^3.3.0","json-metaschema":"^1.3.0","json-schema-to-typescript":"13.1.2","tap-spec":"^5.0.0","tape":"^4.16.2","typescript":"5.3.3"},"engines":{"node":">=10"},"_id":"@averagehelper/resume-schema@1.2.1","gitHead":"78cf70f314f3ac01fd932600e76e571df6d6646d","homepage":"https://github.com/AverageHelper/resume-schema#readme","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-8Mb1iJHl/LLyKItFHZtb7HbWqfr0QyMe/KIc0xxo/mHIPqDyL/DXFzOyC3y+4BSwnq1AoUf+ABHmoJG6JzgJkg==","shasum":"c28f4c19dc876fb187063313773fcd8392432939","tarball":"https://registry.npmjs.org/@averagehelper/resume-schema/-/resume-schema-1.2.1.tgz","fileCount":8,"unpackedSize":36591,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD9zXZLiN95C2yfj9WeJLkkRy/O7yOL1yeCOFzUGeTHJAIhAKg7HiJrzj5x2FQdykzQ7QZroW1NcrY8Ex6ZOoft0Me9"}]},"_npmUser":{"name":"averagehelper","email":"6d243cbc-4840-4590-9d09-2e6b1ecabcee@simplelogin.co"},"directories":{},"maintainers":[{"name":"averagehelper","email":"6d243cbc-4840-4590-9d09-2e6b1ecabcee@simplelogin.co"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/resume-schema_1.2.1_1706823103661_0.03254839053752945"},"_hasShrinkwrap":false},"1.3.0":{"name":"@averagehelper/resume-schema","version":"1.3.0","description":"JSON Resume Schema, with extras","main":"validator.js","types":"validator.d.ts","scripts":{"prebuild":"rm -f validator.js validator.d.ts resume.d.ts","build":"cat schema.json | json2ts > resume.d.ts && tsc -p tsconfig.json","test":"npm run build && npm run validate && npm run test-units","validate":"ajv validate -s node_modules/json-metaschema/draft-07-schema -d schema","test-units":"tape **/*.spec.js | tap-spec","preversion":"npm test","postversion":"git push --follow-tags","prepublishOnly":"npm run build"},"repository":{"type":"git","url":"git://github.com/AverageHelper/resume-schema.git"},"license":"MIT","bugs":{"url":"https://github.com/AverageHelper/resume-schema/issues"},"dependencies":{"z-schema":"^4.2.4"},"devDependencies":{"ajv-cli":"^3.3.0","json-metaschema":"^1.3.0","json-schema-to-typescript":"13.1.2","tap-spec":"^5.0.0","tape":"^4.16.2","typescript":"5.3.3"},"engines":{"node":">=10"},"_id":"@averagehelper/resume-schema@1.3.0","gitHead":"c9809dd55f1c4dfe2c16a706f068a75f205decc6","homepage":"https://github.com/AverageHelper/resume-schema#readme","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-67MxVKgMVZJkurGOaLmY6TjNiARdDke2IAFHl5WOvkSWH9xzhS237K0pIqC/27TyVWBacaJIZeC7KohbvBAKmw==","shasum":"67747eff27843015dd46717c2c6d878fd0c9872f","tarball":"https://registry.npmjs.org/@averagehelper/resume-schema/-/resume-schema-1.3.0.tgz","fileCount":8,"unpackedSize":39374,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCvhDVndhzoZZ7WHdrLdzj4DyefHyEZ9b8QWHyAgWN46gIhALF3syucyBJtEe8C2m6+xKLd0puqPfBVLBYRu/PdNoRk"}]},"_npmUser":{"name":"averagehelper","email":"6d243cbc-4840-4590-9d09-2e6b1ecabcee@simplelogin.co"},"directories":{},"maintainers":[{"name":"averagehelper","email":"6d243cbc-4840-4590-9d09-2e6b1ecabcee@simplelogin.co"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/resume-schema_1.3.0_1707081150601_0.4590066787775344"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-01T20:36:42.685Z","1.2.0":"2024-02-01T20:36:42.934Z","modified":"2024-02-04T21:12:31.018Z","1.2.1":"2024-02-01T21:31:43.831Z","1.3.0":"2024-02-04T21:12:30.822Z"},"maintainers":[{"name":"averagehelper","email":"6d243cbc-4840-4590-9d09-2e6b1ecabcee@simplelogin.co"}],"description":"JSON Resume Schema, with extras","homepage":"https://github.com/AverageHelper/resume-schema#readme","repository":{"type":"git","url":"git://github.com/AverageHelper/resume-schema.git"},"bugs":{"url":"https://github.com/AverageHelper/resume-schema/issues"},"license":"MIT","readme":"# JSON Resume Schema\n\n[![GitHub Releases](https://badgen.net/github/tag/AverageHelper/resume-schema)](https://github.com/AverageHelper/resume-schema/releases)\n[![NPM Release](https://badgen.net/npm/v/@averagehelper/resume-schema)](https://www.npmjs.com/package/@averagehelper/resume-schema)\n<!-- [![Latest Status](https://github.com/AverageHelper/resume-schema/workflows/Latest/badge.svg)](https://github.com/AverageHelper/resume-schema/actions) -->\n<!-- [![Release Status](https://github.com/AverageHelper/resume-schema/workflows/Release/badge.svg)](https://github.com/AverageHelper/resume-schema/actions) -->\n\nStandard, Specification, Schema\n\n> [!NOTE]\n> This is a fork of [jsonresume/resume-schema](https://github.com/jsonresume/resume-schema).\n\nMy goals for this project:\n- [x] Add a `basics.pronouns` field\n- [x] Basic TypeScript declarations around exported structures\n- [x] Generate a TypeScript interface from the JSON schema, to make generic theme templates easier to construct\n- [x] Port to TypeScript\n- [x] Add a `Promise`-compatible interface for `validate`\n- [ ] Clean up and update the changelog, perhaps using the [keep a changelog](https://keepachangelog.com) standard\n- [ ] Simplify unit tests. Surely there's a way to generate each valid/invalid test case from the existing well-labeled valid/invalid test fixtures!\n- [ ] Build both legacy CJS and modern ESM bundles\n- [ ] Switch to tab indentation [for accessibility](https://www.reddit.com/r/javascript/comments/c8drjo/nobody_talks_about_the_real_reason_to_use_tabs/)\n\nI might add more as ideas come to me. I plan to open upstream pull requests once in a while. I'm not sure all of my changes will make it upstream, but a gal can try!\n\nA read-only mirror exists at [my git forge](https://git.average.name/AverageHelper/resume-schema).\n\n### Getting started\n\nThis package requires Node 10 or newer.\n\n```sh\nnpm install @averagehelper/resume-schema\n```\n\n### Usage\n\nBasic:\n\n```js\nconst resumeSchema = require(\"@averagehelper/resume-schema\");\nconst resume = JSON.parse(fs.readFileSync(\"resume.json\", \"utf8\"));\n\ntry {\n  await resumeSchema.validate(resume);\n  console.log(\"Resume validated successfully!\");\n} catch (error) {\n  console.error(\"The resume was invalid:\", error);\n}\n```\n\nSimplified:\n\n```js\nconst fs = require(\"node:fs\");\nconst resumeSchema = require(\"@averagehelper/resume-schema\");\nconst resume = JSON.parse(fs.readFileSync(\"resume.json\", \"utf8\"));\n\nconst resumeObject = await resumeSchema.validated(resume); // throws if invalid\n```\n\nCallback:\n\n```js\nconst fs = require(\"node:fs\");\nconst resumeSchema = require(\"@averagehelper/resume-schema\");\nconst resume = JSON.parse(fs.readFileSync(\"resume.json\", \"utf8\"));\n\nresumeSchema.validate(resume, function (err, result) {\n  if (err) {\n    console.error(\"The resume was invalid:\", error);\n  } else {\n    console.log(\"Resume validated successfully:\", result);\n  }\n});\n```\n\nESM:\n\n```js\nimport fs from \"node:fs\";\nimport { validated } from \"@averagehelper/resume-schema\";\nconst resume = JSON.parse(fs.readFileSync(\"resume.json\", \"utf8\"));\n\nconst resumeObject = await validated(resume); // throws if invalid\n```\n\nTypeScript:\n\n```ts\nimport fs from \"node:fs\";\nimport type { ResumeSchema } from \"@averagehelper/resume-schema\";\nimport { validated } from \"@averagehelper/resume-schema\";\nconst resume = JSON.parse(fs.readFileSync(\"resume.json\", \"utf8\"));\n\nconst resumeObject: ResumeSchema = await validated(resume); // throws if invalid\n```\n\nThe JSON Resume schema is available from:\n\n```js\nimport { schema } from \"@averagehelper/resume-schema\";\n```\n\n### Contribute\n\nWe encourage anyone who's interested in participating in the formation of this standard to join the discussions [here on GitHub](https://github.com/jsonresume/resume-schema/issues). Also feel free to fork this project and submit new ideas to add to the JSON Resume Schema standard. To make sure all formatting is kept in check, please install the [EditorConfig plugin](http://editorconfig.org/) for your editor of choice.\n\n### Versioning\n\nJSON Resume Schema adheres to Semantic Versioning 2.0.0. If there is a violation of\nthis scheme, report it as a bug. Specifically, if a patch or minor version is\nreleased and breaks backward compatibility, that version should be immediately\nyanked and/or a new version should be immediately released that restores\ncompatibility. Any change that breaks the public API will only be introduced at\na major-version release. As a result of this policy, you can (and should)\nspecify any dependency on JSON Resume Schema by using the Pessimistic Version\nConstraint with two digits of precision.\n\nWe use automatic semver system.\n\nPull requests titles should be formatted as such\n\n```\n\"fix: added something\" - will bump the patch version\n\"feat: added something\" - will bump the minor version\n```\n\n`major` version bumps will be few and far between for this schema.\n\n### Other resume standards\n\n- [HR-XML](https://schemas.liquid-technologies.com/HR-XML/2007-04-15/)\n- [Europass](http://europass.cedefop.europa.eu/about-europass)\n","readmeFilename":"README.md"}