@jsonresume/schema 1.3.0 → 1.4.0

package/README.md

@@ -18,30 +18,33 @@ npm install --save @jsonresume/schema
 
 To use
 
+`validate(resume, callback)` calls back with `(errors, valid)`:
+
 ```js
-import resumeSchema from '@jsonresume/schema';
-resumeSchema.validate(
-  { basics: { name: "Thomas" } },
-  function (err, report) {
-    if (err) {
-      console.error("The resume was invalid:", err);
-      return;
-    }
-    console.log("Resume validated successfully:", report);
-  },
-  function (err) {
-    console.error("The resume was invalid:", err);
+const { validate } = require('@jsonresume/schema');
+
+validate({ basics: { name: 'Thomas' } }, (errors, valid) => {
+  if (!valid) {
+    console.error('The resume was invalid:', errors);
+    return;
   }
-);
+  console.log('Resume validated successfully');
+});
 ```
 
 Or against a full `resume.json`
 
 ```js
 const fs = require('fs');
-const resumeSchema = require('@jsonresume/schema');
-const resumeObject = JSON.parse(fs.readFileSync('./resume.json', 'utf8'));
-resumeSchema.validate(resumeObject);
+const { validate } = require('@jsonresume/schema');
+
+const resume = JSON.parse(fs.readFileSync('./resume.json', 'utf8'));
+validate(resume, (errors, valid) => {
+  if (!valid) {
+    console.error(errors);
+    process.exit(1);
+  }
+});
 ```
 
 The JSON Resume schema is available from:
@@ -50,6 +53,28 @@ The JSON Resume schema is available from:
 require('@jsonresume/schema').schema;
 ```
 
+### Extending with `custom`
+
+Data with no standard field can go in an optional `custom` object, allowed at
+the root, in `basics`, and on every entry of every section. Its contents are
+free-form; namespace keys by tool to avoid collisions:
+
+```json
+{
+  "work": [
+    {
+      "name": "Tech Corp",
+      "position": "Senior Developer",
+      "custom": { "myAts": { "teamSize": 12, "directReports": 5 } }
+    }
+  ]
+}
+```
+
+Themes don't render `custom`, and tools that read and write resumes should
+preserve it unchanged. Unknown top-level properties are also still allowed
+(`additionalProperties: true`); `custom` gives that data a predictable home.
+
 ### Contribute
 
 We encourage anyone who's interested in participating in the formation of this standard to join the discussions [here on GitHub](https://github.com/jsonresume/jsonresume.org/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.

package/examples/career-changer.resume.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/jsonresume/resume-schema/v1.0.0/schema.json",
+  "$schema": "https://raw.githubusercontent.com/jsonresume/jsonresume.org/master/packages/schema/schema.json",
   "basics": {
     "name": "Daniel Reyes",
     "label": "Junior Data Analyst (former Restaurant Manager)",

package/examples/new-grad.resume.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/jsonresume/resume-schema/v1.0.0/schema.json",
+  "$schema": "https://raw.githubusercontent.com/jsonresume/jsonresume.org/master/packages/schema/schema.json",
   "basics": {
     "name": "Maya Okonkwo",
     "label": "Computer Science Graduate",

package/examples/senior-engineer.resume.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/jsonresume/resume-schema/v1.0.0/schema.json",
+  "$schema": "https://raw.githubusercontent.com/jsonresume/jsonresume.org/master/packages/schema/schema.json",
   "basics": {
     "name": "Dr. Lena Vasquez",
     "label": "Staff Software Engineer, Distributed Systems",

package/job-schema.json

@@ -1,5 +1,6 @@
 {
-  "$schema": "http://json-schema.org/draft-04/schema#",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://raw.githubusercontent.com/jsonresume/jsonresume.org/master/packages/schema/job-schema.json",
   "additionalProperties": true,
   "definitions": {
     "iso8601": {
@@ -68,7 +69,6 @@
     "responsibilities": {
       "type": "array",
       "description": "what the job entails",
-      "additionalItems": false,
       "items": {
         "type": "string",
         "description": "e.g. Build out a new API for our customer base."
@@ -77,7 +77,6 @@
     "qualifications": {
       "type": "array",
       "description": "List out your qualifications",
-      "additionalItems": false,
       "items": {
         "type": "string",
         "description": "undergraduate degree, etc.  "
@@ -86,7 +85,6 @@
     "skills": {
       "type": "array",
       "description": "List out your professional skill-set",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -102,7 +100,6 @@
           "keywords": {
             "type": "array",
             "description": "List some keywords pertaining to this skill",
-            "additionalItems": false,
             "items": {
               "type": "string",
               "description": "e.g. HTML"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsonresume/schema",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "JSON Resume Schema",
   "private": false,
   "main": "validator.js",
@@ -25,7 +25,9 @@
     "jsonschema": "^1.4.1"
   },
   "devDependencies": {
+    "ajv": "^8.17.1",
     "ajv-cli": "^3.3.0",
+    "ajv-formats": "^3.0.1",
     "json-metaschema": "^1.3.0",
     "tap-spec": "^5.0.0",
     "tape": "^4.16.2"
@@ -35,7 +37,7 @@
   },
   "scripts": {
     "test": "npm run validate && npm run test-units",
-    "validate": "ajv validate -s node_modules/json-metaschema/draft-07-schema -d schema",
+    "validate": "ajv validate -s node_modules/json-metaschema/draft-07-schema -d schema -d job-schema",
     "test-units": "tape **/*.spec.js | tap-spec"
   }
 }

package/sample.resume.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/jsonresume/resume-schema/v1.0.0/schema.json",
+  "$schema": "https://raw.githubusercontent.com/jsonresume/jsonresume.org/master/packages/schema/schema.json",
   "basics": {
     "name": "Richard Hendriks",
     "label": "Programmer",
@@ -28,6 +28,7 @@
       }
     ]
   },
+  "objective": "Lead engineering for a compression-first storage platform.",
   "work": [
     {
       "name": "Pied Piper",
@@ -42,7 +43,8 @@
         "Build an algorithm for artist to detect if their music was violating copy right infringement laws",
         "Successfully won Techcrunch Disrupt",
         "Optimized an algorithm that holds the current world record for Weisman Scores"
-      ]
+      ],
+      "keywords": ["Compression", "C++", "Distributed Systems"]
     }
   ],
   "volunteer": [
@@ -65,7 +67,8 @@
       "startDate": "2011-06-01",
       "endDate": "2014-01-01",
       "score": "4.0",
-      "courses": ["DB1101 - Basic SQL", "CS2011 - Java Introduction"]
+      "courses": ["DB1101 - Basic SQL", "CS2011 - Java Introduction"],
+      "summary": "Senior project on lossless compression for streaming media."
     }
   ],
   "awards": [
@@ -76,13 +79,25 @@
       "summary": "There is no spoon."
     }
   ],
+  "certificates": [
+    {
+      "name": "AWS Certified Solutions Architect – Associate",
+      "date": "2014-06-01",
+      "expiryDate": "2017-06-01",
+      "issuer": "Amazon Web Services",
+      "url": "https://certificates.example.com/aws/rhendriks",
+      "credentialId": "AWS-ASA-12345",
+      "summary": "Designing distributed systems on AWS."
+    }
+  ],
   "publications": [
     {
       "name": "Video compression for 3d media",
       "publisher": "Hooli",
       "releaseDate": "2014-10-01",
       "url": "http://en.wikipedia.org/wiki/Silicon_Valley_(TV_series)",
-      "summary": "Innovative middle-out compression algorithm that changes the way we store data."
+      "summary": "Innovative middle-out compression algorithm that changes the way we store data.",
+      "type": "article"
     }
   ],
   "skills": [
@@ -134,8 +149,8 @@
     }
   ],
   "meta": {
-    "canonical": "https://raw.githubusercontent.com/jsonresume/resume-schema/v1.0.0/sample.resume.json",
-    "version": "v1.0.0",
-    "lastModified": "2017-12-24T15:53:00"
+    "canonical": "https://raw.githubusercontent.com/jsonresume/jsonresume.org/master/packages/schema/sample.resume.json",
+    "version": "v1.3.1",
+    "lastModified": "2026-10-22T00:00:00"
   }
 }

package/schema.json

@@ -1,12 +1,17 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "http://example.com/example.json",
+  "$id": "https://raw.githubusercontent.com/jsonresume/jsonresume.org/master/packages/schema/schema.json",
   "additionalProperties": true,
   "definitions": {
     "iso8601": {
       "type": "string",
-      "description": "Similar to the standard date type, but each section after the year is optional. e.g. 2014-06-29 or 2023-04",
-      "pattern": "^([1-2][0-9]{3}-[0-1][0-9]-[0-3][0-9]|[1-2][0-9]{3}-[0-1][0-9]|[1-2][0-9]{3})$"
+      "description": "Similar to the standard date type, but each section after the year is optional. e.g. 2014-06-29 or 2023-04. Every date is optional; omit endDate for a current position or ongoing entry (#309).",
+      "pattern": "^([1-2][0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])|[1-2][0-9]{3}-(0[1-9]|1[0-2])|[1-2][0-9]{3})$"
+    },
+    "custom": {
+      "type": "object",
+      "description": "Tool- or author-specific data that has no standard field yet (#316). Keys are free-form; namespace them by tool (e.g. \"myTool\": { ... }) to avoid collisions. Themes are not expected to render it, and tools should preserve it unchanged when reading and writing resumes.",
+      "additionalProperties": true
     }
   },
   "properties": {
@@ -26,6 +31,10 @@
           "type": "string",
           "description": "e.g. Web Developer"
         },
+        "pronouns": {
+          "type": "string",
+          "description": "e.g. she/her, they/them (#312)"
+        },
         "image": {
           "type": "string",
           "description": "URL (as per RFC 3986) to a image in JPEG or PNG format"
@@ -75,7 +84,6 @@
         "profiles": {
           "type": "array",
           "description": "Specify any number of social networks that you participate in",
-          "additionalItems": false,
           "items": {
             "type": "object",
             "additionalProperties": true,
@@ -95,12 +103,18 @@
               }
             }
           }
+        },
+        "custom": {
+          "$ref": "#/definitions/custom"
         }
       }
     },
+    "objective": {
+      "type": "string",
+      "description": "Forward-looking career goal, e.g. 'Seeking a senior backend role in climate tech'. Distinct from basics.summary, which describes background (#317)"
+    },
     "work": {
       "type": "array",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -139,18 +153,27 @@
           "highlights": {
             "type": "array",
             "description": "Specify multiple accomplishments",
-            "additionalItems": false,
             "items": {
               "type": "string",
               "description": "e.g. Increased profits by 20% from 2011-2012 through viral advertising"
             }
+          },
+          "keywords": {
+            "type": "array",
+            "description": "Skills, tools or technologies used in this role (#293)",
+            "items": {
+              "type": "string",
+              "description": "e.g. React"
+            }
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
     },
     "volunteer": {
       "type": "array",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -181,18 +204,19 @@
           "highlights": {
             "type": "array",
             "description": "Specify accomplishments and achievements",
-            "additionalItems": false,
             "items": {
               "type": "string",
               "description": "e.g. Increased profits by 20% from 2011-2012 through viral advertising"
             }
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
     },
     "education": {
       "type": "array",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -227,11 +251,17 @@
           "courses": {
             "type": "array",
             "description": "List notable courses/subjects",
-            "additionalItems": false,
             "items": {
               "type": "string",
               "description": "e.g. H1302 - Introduction to American history"
             }
+          },
+          "summary": {
+            "type": "string",
+            "description": "Thesis topic, honours, notable projects or other context (#292)"
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
@@ -239,7 +269,6 @@
     "awards": {
       "type": "array",
       "description": "Specify any awards you have received throughout your professional career",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -258,6 +287,9 @@
           "summary": {
             "type": "string",
             "description": "e.g. Received for my work with Quantum Physics"
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
@@ -265,7 +297,6 @@
     "certificates": {
       "type": "array",
       "description": "Specify any certificates you have received throughout your professional career",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -282,9 +313,23 @@
             "description": "e.g. http://example.com",
             "format": "uri"
           },
+          "credentialId": {
+            "type": "string",
+            "description": "Credential or licence number used to verify the certificate, e.g. a licence number or a certification ID (#590)"
+          },
           "issuer": {
             "type": "string",
             "description": "e.g. CNCF"
+          },
+          "expiryDate": {
+            "$ref": "#/definitions/iso8601"
+          },
+          "summary": {
+            "type": "string",
+            "description": "What the certificate covers (#590)"
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
@@ -292,7 +337,6 @@
     "publications": {
       "type": "array",
       "description": "Specify your publications through your career",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -316,6 +360,13 @@
           "summary": {
             "type": "string",
             "description": "Short summary of publication. e.g. Discussion of the World Wide Web, HTTP, HTML."
+          },
+          "type": {
+            "type": "string",
+            "description": "e.g. 'article', 'book', 'patent', 'thesis', 'talk' (#295)"
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
@@ -323,7 +374,6 @@
     "skills": {
       "type": "array",
       "description": "List out your professional skill-set",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -339,11 +389,13 @@
           "keywords": {
             "type": "array",
             "description": "List some keywords pertaining to this skill",
-            "additionalItems": false,
             "items": {
               "type": "string",
               "description": "e.g. HTML"
             }
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
@@ -351,7 +403,6 @@
     "languages": {
       "type": "array",
       "description": "List any other languages you speak",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -363,13 +414,15 @@
           "fluency": {
             "type": "string",
             "description": "e.g. Fluent, Beginner"
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
     },
     "interests": {
       "type": "array",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -380,11 +433,13 @@
           },
           "keywords": {
             "type": "array",
-            "additionalItems": false,
             "items": {
               "type": "string",
               "description": "e.g. Friedrich Nietzsche"
             }
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
@@ -392,7 +447,6 @@
     "references": {
       "type": "array",
       "description": "List references you have received",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -404,6 +458,9 @@
           "reference": {
             "type": "string",
             "description": "e.g. Joe blogs was a great employee, who turned up to work at least once a week. He exceeded my expectations when it came to doing nothing."
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
@@ -411,7 +468,6 @@
     "projects": {
       "type": "array",
       "description": "Specify career projects",
-      "additionalItems": false,
       "items": {
         "type": "object",
         "additionalProperties": true,
@@ -427,7 +483,6 @@
           "highlights": {
             "type": "array",
             "description": "Specify multiple features",
-            "additionalItems": false,
             "items": {
               "type": "string",
               "description": "e.g. Directs you close but not quite there"
@@ -436,7 +491,6 @@
           "keywords": {
             "type": "array",
             "description": "Specify special elements involved",
-            "additionalItems": false,
             "items": {
               "type": "string",
               "description": "e.g. AngularJS"
@@ -456,7 +510,6 @@
           "roles": {
             "type": "array",
             "description": "Specify your role on this project or in company",
-            "additionalItems": false,
             "items": {
               "type": "string",
               "description": "e.g. Team Lead, Speaker, Writer"
@@ -469,6 +522,9 @@
           "type": {
             "type": "string",
             "description": " e.g. 'volunteering', 'presentation', 'talk', 'application', 'conference'"
+          },
+          "custom": {
+            "$ref": "#/definitions/custom"
           }
         }
       }
@@ -492,6 +548,9 @@
           "description": "Using ISO 8601 with YYYY-MM-DDThh:mm:ss"
         }
       }
+    },
+    "custom": {
+      "$ref": "#/definitions/custom"
     }
   },
   "title": "Resume Schema",

package/validator.js

@@ -4,6 +4,19 @@ const jobSchema = require('./job-schema');
 const Validator = require('jsonschema').Validator;
 
 function validate(resumeJson, callback) {
+  // jsonschema treats an absent instance as valid, which hides failed reads
+  // and parses upstream
+  if (
+    resumeJson === null ||
+    typeof resumeJson !== 'object' ||
+    Array.isArray(resumeJson)
+  ) {
+    return callback(
+      [{ property: 'instance', message: 'resume must be a JSON object' }],
+      false
+    );
+  }
+
   const v = new Validator();
 
   const validation = v.validate(resumeJson, schema);