@jsonresume/types 0.7.0 → 0.8.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 +51 -0
  2. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -9,6 +9,23 @@
9
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
+ /**
13
+ * A skill used in this entry (#313): the name or id of a skill in the top-level skills list, or a skill object shaped like one, e.g. { "name": "Backend", "keywords": ["Go"] }
14
+ */
15
+ export type SkillReference =
16
+ | string
17
+ | {
18
+ /**
19
+ * e.g. Backend
20
+ */
21
+ name?: string;
22
+ /**
23
+ * e.g. Master
24
+ */
25
+ level?: string;
26
+ keywords?: string[];
27
+ [k: string]: any;
28
+ };
12
29
 
13
30
  export interface Resume {
14
31
  /**
@@ -172,6 +189,10 @@ export interface WorkItem {
172
189
  * Skills, tools or technologies used in this role (#293)
173
190
  */
174
191
  keywords?: string[];
192
+ /**
193
+ * Skills used in this role, naming or repeating entries of the top-level skills list, so a skill can point to where it was used (#313)
194
+ */
195
+ skills?: SkillReference[];
175
196
  custom?: Custom;
176
197
  [k: string]: any;
177
198
  }
@@ -224,6 +245,10 @@ export interface VolunteerItem {
224
245
  * Specify accomplishments and achievements
225
246
  */
226
247
  highlights?: string[];
248
+ /**
249
+ * Skills used in this role, naming or repeating entries of the top-level skills list, so a skill can point to where it was used (#313)
250
+ */
251
+ skills?: SkillReference[];
227
252
  custom?: Custom;
228
253
  [k: string]: any;
229
254
  }
@@ -259,6 +284,10 @@ export interface EducationItem {
259
284
  * Thesis topic, honours, notable projects or other context (#292). Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
260
285
  */
261
286
  summary?: string;
287
+ /**
288
+ * Skills used in this course of study, naming or repeating entries of the top-level skills list, so a skill can point to where it was used (#313)
289
+ */
290
+ skills?: SkillReference[];
262
291
  custom?: Custom;
263
292
  [k: string]: any;
264
293
  }
@@ -369,6 +398,10 @@ export interface SkillItem {
369
398
  * e.g. Web Development
370
399
  */
371
400
  name?: string;
401
+ /**
402
+ * A short, stable identifier that entries' skills lists can use instead of the name, e.g. 'typescript' (#313)
403
+ */
404
+ id?: string;
372
405
  /**
373
406
  * e.g. Master
374
407
  */
@@ -389,6 +422,20 @@ export interface LanguageItem {
389
422
  * e.g. Fluent, Beginner
390
423
  */
391
424
  fluency?: string;
425
+ /**
426
+ * Where the language sits on a published proficiency scale, for tools; fluency stays the label people read (#315). e.g. { "framework": "CEFR", "level": "C1" }
427
+ */
428
+ scale?: {
429
+ /**
430
+ * The scale, free text: 'CEFR', 'ILR', 'ACTFL', 'JLPT', 'HSK', …
431
+ */
432
+ framework?: string;
433
+ /**
434
+ * The level on that scale as it writes it, e.g. 'C1', '3+', 'Advanced Mid', 'N2'
435
+ */
436
+ level?: string;
437
+ [k: string]: any;
438
+ };
392
439
  custom?: Custom;
393
440
  [k: string]: any;
394
441
  }
@@ -465,6 +512,10 @@ export interface ProjectItem {
465
512
  * e.g. 'volunteering', 'presentation', 'talk', 'application', 'conference'
466
513
  */
467
514
  type?: string;
515
+ /**
516
+ * Skills used in this project, naming or repeating entries of the top-level skills list, so a skill can point to where it was used (#313)
517
+ */
518
+ skills?: SkillReference[];
468
519
  custom?: Custom;
469
520
  [k: string]: any;
470
521
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jsonresume/types",
3
- "version": "0.7.0",
3
+ "version": "0.8.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.8.0",
21
+ "@jsonresume/schema": "1.9.0",
22
22
  "tsconfig": "0.0.0"
23
23
  },
24
24
  "keywords": [