@jsonresume/types 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/index.d.ts +49 -1
  2. package/package.json +3 -3
package/dist/index.d.ts CHANGED
@@ -6,7 +6,7 @@
6
6
  /* eslint-disable */
7
7
 
8
8
  /**
9
- * Similar to the standard date type, but each section after the year is optional. e.g. 2014-06-29 or 2023-04
9
+ * 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).
10
10
  */
11
11
  export type Iso8601 = string;
12
12
 
@@ -16,6 +16,10 @@ export interface Resume {
16
16
  */
17
17
  $schema?: string;
18
18
  basics?: ResumeBasics;
19
+ /**
20
+ * Forward-looking career goal, e.g. 'Seeking a senior backend role in climate tech'. Distinct from basics.summary, which describes background (#317)
21
+ */
22
+ objective?: string;
19
23
  work?: WorkItem[];
20
24
  volunteer?: VolunteerItem[];
21
25
  education?: EducationItem[];
@@ -49,6 +53,7 @@ export interface Resume {
49
53
  */
50
54
  projects?: ProjectItem[];
51
55
  meta?: ResumeMeta;
56
+ custom?: Custom;
52
57
  [k: string]: any;
53
58
  }
54
59
  export interface ResumeBasics {
@@ -57,6 +62,10 @@ export interface ResumeBasics {
57
62
  * e.g. Web Developer
58
63
  */
59
64
  label?: string;
65
+ /**
66
+ * e.g. she/her, they/them (#312)
67
+ */
68
+ pronouns?: string;
60
69
  /**
61
70
  * URL (as per RFC 3986) to a image in JPEG or PNG format
62
71
  */
@@ -82,6 +91,7 @@ export interface ResumeBasics {
82
91
  * Specify any number of social networks that you participate in
83
92
  */
84
93
  profiles?: ResumeProfile[];
94
+ custom?: Custom;
85
95
  [k: string]: any;
86
96
  }
87
97
  export interface ResumeLocation {
@@ -118,6 +128,12 @@ export interface ResumeProfile {
118
128
  url?: string;
119
129
  [k: string]: any;
120
130
  }
131
+ /**
132
+ * 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.
133
+ */
134
+ export interface Custom {
135
+ [k: string]: any;
136
+ }
121
137
  export interface WorkItem {
122
138
  /**
123
139
  * e.g. Facebook
@@ -149,6 +165,11 @@ export interface WorkItem {
149
165
  * Specify multiple accomplishments
150
166
  */
151
167
  highlights?: string[];
168
+ /**
169
+ * Skills, tools or technologies used in this role (#293)
170
+ */
171
+ keywords?: string[];
172
+ custom?: Custom;
152
173
  [k: string]: any;
153
174
  }
154
175
  export interface VolunteerItem {
@@ -174,6 +195,7 @@ export interface VolunteerItem {
174
195
  * Specify accomplishments and achievements
175
196
  */
176
197
  highlights?: string[];
198
+ custom?: Custom;
177
199
  [k: string]: any;
178
200
  }
179
201
  export interface EducationItem {
@@ -203,6 +225,11 @@ export interface EducationItem {
203
225
  * List notable courses/subjects
204
226
  */
205
227
  courses?: string[];
228
+ /**
229
+ * Thesis topic, honours, notable projects or other context (#292)
230
+ */
231
+ summary?: string;
232
+ custom?: Custom;
206
233
  [k: string]: any;
207
234
  }
208
235
  export interface AwardItem {
@@ -219,6 +246,7 @@ export interface AwardItem {
219
246
  * e.g. Received for my work with Quantum Physics
220
247
  */
221
248
  summary?: string;
249
+ custom?: Custom;
222
250
  [k: string]: any;
223
251
  }
224
252
  export interface CertificateItem {
@@ -231,10 +259,20 @@ export interface CertificateItem {
231
259
  * e.g. http://example.com
232
260
  */
233
261
  url?: string;
262
+ /**
263
+ * Credential or licence number used to verify the certificate, e.g. a licence number or a certification ID (#590)
264
+ */
265
+ credentialId?: string;
234
266
  /**
235
267
  * e.g. CNCF
236
268
  */
237
269
  issuer?: string;
270
+ expiryDate?: Iso8601;
271
+ /**
272
+ * What the certificate covers (#590)
273
+ */
274
+ summary?: string;
275
+ custom?: Custom;
238
276
  [k: string]: any;
239
277
  }
240
278
  export interface PublicationItem {
@@ -255,6 +293,11 @@ export interface PublicationItem {
255
293
  * Short summary of publication. e.g. Discussion of the World Wide Web, HTTP, HTML.
256
294
  */
257
295
  summary?: string;
296
+ /**
297
+ * e.g. 'article', 'book', 'patent', 'thesis', 'talk' (#295)
298
+ */
299
+ type?: string;
300
+ custom?: Custom;
258
301
  [k: string]: any;
259
302
  }
260
303
  export interface SkillItem {
@@ -270,6 +313,7 @@ export interface SkillItem {
270
313
  * List some keywords pertaining to this skill
271
314
  */
272
315
  keywords?: string[];
316
+ custom?: Custom;
273
317
  [k: string]: any;
274
318
  }
275
319
  export interface LanguageItem {
@@ -281,6 +325,7 @@ export interface LanguageItem {
281
325
  * e.g. Fluent, Beginner
282
326
  */
283
327
  fluency?: string;
328
+ custom?: Custom;
284
329
  [k: string]: any;
285
330
  }
286
331
  export interface InterestItem {
@@ -289,6 +334,7 @@ export interface InterestItem {
289
334
  */
290
335
  name?: string;
291
336
  keywords?: string[];
337
+ custom?: Custom;
292
338
  [k: string]: any;
293
339
  }
294
340
  export interface ReferenceItem {
@@ -300,6 +346,7 @@ export interface ReferenceItem {
300
346
  * 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.
301
347
  */
302
348
  reference?: string;
349
+ custom?: Custom;
303
350
  [k: string]: any;
304
351
  }
305
352
  export interface ProjectItem {
@@ -337,6 +384,7 @@ export interface ProjectItem {
337
384
  * e.g. 'volunteering', 'presentation', 'talk', 'application', 'conference'
338
385
  */
339
386
  type?: string;
387
+ custom?: Custom;
340
388
  [k: string]: any;
341
389
  }
342
390
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jsonresume/types",
3
- "version": "0.2.1",
3
+ "version": "0.3.0",
4
4
  "private": false,
5
5
  "description": "TypeScript types for the JSON Resume and Job schemas, generated from @jsonresume/schema",
6
6
  "types": "./dist/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "devDependencies": {
19
19
  "json-schema-to-typescript": "^15.0.4",
20
20
  "typescript": "^5.9.3",
21
- "@jsonresume/schema": "1.3.0",
22
- "tsconfig": "0.0.0"
21
+ "tsconfig": "0.0.0",
22
+ "@jsonresume/schema": "1.4.0"
23
23
  },
24
24
  "keywords": [
25
25
  "resume",