@jsonresume/types 0.2.1 → 0.4.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 +83 -5
  2. package/package.json +2 -2
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 {
@@ -91,7 +101,13 @@ export interface ResumeLocation {
91
101
  * Hinterhaus 5. Etage li.
92
102
  */
93
103
  address?: string;
104
+ /**
105
+ * e.g. 12345
106
+ */
94
107
  postalCode?: string;
108
+ /**
109
+ * e.g. Teststadt
110
+ */
95
111
  city?: string;
96
112
  /**
97
113
  * code as per ISO-3166-1 ALPHA-2, e.g. US, AU, IN
@@ -118,15 +134,18 @@ export interface ResumeProfile {
118
134
  url?: string;
119
135
  [k: string]: any;
120
136
  }
137
+ /**
138
+ * 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.
139
+ */
140
+ export interface Custom {
141
+ [k: string]: any;
142
+ }
121
143
  export interface WorkItem {
122
144
  /**
123
145
  * e.g. Facebook
124
146
  */
125
147
  name?: string;
126
- /**
127
- * e.g. Menlo Park, CA
128
- */
129
- location?: string;
148
+ location?: string | Location;
130
149
  /**
131
150
  * e.g. Social Media Company
132
151
  */
@@ -149,6 +168,36 @@ export interface WorkItem {
149
168
  * Specify multiple accomplishments
150
169
  */
151
170
  highlights?: string[];
171
+ /**
172
+ * Skills, tools or technologies used in this role (#293)
173
+ */
174
+ keywords?: string[];
175
+ custom?: Custom;
176
+ [k: string]: any;
177
+ }
178
+ export interface Location {
179
+ /**
180
+ * To add multiple address lines, use
181
+ * . For example, 1234 Glücklichkeit Straße
182
+ * Hinterhaus 5. Etage li.
183
+ */
184
+ address?: string;
185
+ /**
186
+ * e.g. 12345
187
+ */
188
+ postalCode?: string;
189
+ /**
190
+ * e.g. Teststadt
191
+ */
192
+ city?: string;
193
+ /**
194
+ * code as per ISO-3166-1 ALPHA-2, e.g. US, AU, IN
195
+ */
196
+ countryCode?: string;
197
+ /**
198
+ * The general region where you live. Can be a US state, or a province, for instance.
199
+ */
200
+ region?: string;
152
201
  [k: string]: any;
153
202
  }
154
203
  export interface VolunteerItem {
@@ -156,6 +205,7 @@ export interface VolunteerItem {
156
205
  * e.g. Facebook
157
206
  */
158
207
  organization?: string;
208
+ location?: string | Location;
159
209
  /**
160
210
  * e.g. Software Engineer
161
211
  */
@@ -174,6 +224,7 @@ export interface VolunteerItem {
174
224
  * Specify accomplishments and achievements
175
225
  */
176
226
  highlights?: string[];
227
+ custom?: Custom;
177
228
  [k: string]: any;
178
229
  }
179
230
  export interface EducationItem {
@@ -181,6 +232,7 @@ export interface EducationItem {
181
232
  * e.g. Massachusetts Institute of Technology
182
233
  */
183
234
  institution?: string;
235
+ location?: string | Location;
184
236
  /**
185
237
  * e.g. http://facebook.example.com
186
238
  */
@@ -203,6 +255,11 @@ export interface EducationItem {
203
255
  * List notable courses/subjects
204
256
  */
205
257
  courses?: string[];
258
+ /**
259
+ * Thesis topic, honours, notable projects or other context (#292)
260
+ */
261
+ summary?: string;
262
+ custom?: Custom;
206
263
  [k: string]: any;
207
264
  }
208
265
  export interface AwardItem {
@@ -219,6 +276,7 @@ export interface AwardItem {
219
276
  * e.g. Received for my work with Quantum Physics
220
277
  */
221
278
  summary?: string;
279
+ custom?: Custom;
222
280
  [k: string]: any;
223
281
  }
224
282
  export interface CertificateItem {
@@ -231,10 +289,20 @@ export interface CertificateItem {
231
289
  * e.g. http://example.com
232
290
  */
233
291
  url?: string;
292
+ /**
293
+ * Credential or licence number used to verify the certificate, e.g. a licence number or a certification ID (#590)
294
+ */
295
+ credentialId?: string;
234
296
  /**
235
297
  * e.g. CNCF
236
298
  */
237
299
  issuer?: string;
300
+ expiryDate?: Iso8601;
301
+ /**
302
+ * What the certificate covers (#590)
303
+ */
304
+ summary?: string;
305
+ custom?: Custom;
238
306
  [k: string]: any;
239
307
  }
240
308
  export interface PublicationItem {
@@ -255,6 +323,11 @@ export interface PublicationItem {
255
323
  * Short summary of publication. e.g. Discussion of the World Wide Web, HTTP, HTML.
256
324
  */
257
325
  summary?: string;
326
+ /**
327
+ * e.g. 'article', 'book', 'patent', 'thesis', 'talk' (#295)
328
+ */
329
+ type?: string;
330
+ custom?: Custom;
258
331
  [k: string]: any;
259
332
  }
260
333
  export interface SkillItem {
@@ -270,6 +343,7 @@ export interface SkillItem {
270
343
  * List some keywords pertaining to this skill
271
344
  */
272
345
  keywords?: string[];
346
+ custom?: Custom;
273
347
  [k: string]: any;
274
348
  }
275
349
  export interface LanguageItem {
@@ -281,6 +355,7 @@ export interface LanguageItem {
281
355
  * e.g. Fluent, Beginner
282
356
  */
283
357
  fluency?: string;
358
+ custom?: Custom;
284
359
  [k: string]: any;
285
360
  }
286
361
  export interface InterestItem {
@@ -289,6 +364,7 @@ export interface InterestItem {
289
364
  */
290
365
  name?: string;
291
366
  keywords?: string[];
367
+ custom?: Custom;
292
368
  [k: string]: any;
293
369
  }
294
370
  export interface ReferenceItem {
@@ -300,6 +376,7 @@ export interface ReferenceItem {
300
376
  * 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
377
  */
302
378
  reference?: string;
379
+ custom?: Custom;
303
380
  [k: string]: any;
304
381
  }
305
382
  export interface ProjectItem {
@@ -337,6 +414,7 @@ export interface ProjectItem {
337
414
  * e.g. 'volunteering', 'presentation', 'talk', 'application', 'conference'
338
415
  */
339
416
  type?: string;
417
+ custom?: Custom;
340
418
  [k: string]: any;
341
419
  }
342
420
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jsonresume/types",
3
- "version": "0.2.1",
3
+ "version": "0.4.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,7 +18,7 @@
18
18
  "devDependencies": {
19
19
  "json-schema-to-typescript": "^15.0.4",
20
20
  "typescript": "^5.9.3",
21
- "@jsonresume/schema": "1.3.0",
21
+ "@jsonresume/schema": "1.5.0",
22
22
  "tsconfig": "0.0.0"
23
23
  },
24
24
  "keywords": [