@jsonresume/types 0.6.1 → 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.
- package/dist/index.d.ts +141 -12
- 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
|
/**
|
|
@@ -79,7 +96,7 @@ export interface ResumeBasics {
|
|
|
79
96
|
*/
|
|
80
97
|
url?: string;
|
|
81
98
|
/**
|
|
82
|
-
* Write a short 2-3 sentence biography about yourself
|
|
99
|
+
* Write a short 2-3 sentence biography about yourself. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
83
100
|
*/
|
|
84
101
|
summary?: string;
|
|
85
102
|
location?: ResumeLocation;
|
|
@@ -150,6 +167,10 @@ export interface WorkItem {
|
|
|
150
167
|
* e.g. Software Engineer
|
|
151
168
|
*/
|
|
152
169
|
position?: string;
|
|
170
|
+
/**
|
|
171
|
+
* How the role was held. Free text; recommended values: 'full-time', 'part-time', 'contract', 'freelance', 'internship', 'temporary'. Combine them as needed, e.g. 'part-time contract'. Describes past roles, not what you are looking for (#599). A career break is a work entry with type 'career-break', its dates and an optional summary, and no name (#589)
|
|
172
|
+
*/
|
|
173
|
+
type?: string;
|
|
153
174
|
/**
|
|
154
175
|
* e.g. http://facebook.example.com
|
|
155
176
|
*/
|
|
@@ -157,17 +178,21 @@ export interface WorkItem {
|
|
|
157
178
|
startDate?: Iso8601;
|
|
158
179
|
endDate?: Iso8601;
|
|
159
180
|
/**
|
|
160
|
-
* Give an overview of your responsibilities at the company
|
|
181
|
+
* Give an overview of your responsibilities at the company. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
161
182
|
*/
|
|
162
183
|
summary?: string;
|
|
163
184
|
/**
|
|
164
|
-
* Specify multiple accomplishments
|
|
185
|
+
* Specify multiple accomplishments. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
165
186
|
*/
|
|
166
187
|
highlights?: string[];
|
|
167
188
|
/**
|
|
168
189
|
* Skills, tools or technologies used in this role (#293)
|
|
169
190
|
*/
|
|
170
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[];
|
|
171
196
|
custom?: Custom;
|
|
172
197
|
[k: string]: any;
|
|
173
198
|
}
|
|
@@ -213,13 +238,17 @@ export interface VolunteerItem {
|
|
|
213
238
|
startDate?: Iso8601;
|
|
214
239
|
endDate?: Iso8601;
|
|
215
240
|
/**
|
|
216
|
-
* Give an overview of your responsibilities at the company
|
|
241
|
+
* Give an overview of your responsibilities at the company. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
217
242
|
*/
|
|
218
243
|
summary?: string;
|
|
219
244
|
/**
|
|
220
245
|
* Specify accomplishments and achievements
|
|
221
246
|
*/
|
|
222
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[];
|
|
223
252
|
custom?: Custom;
|
|
224
253
|
[k: string]: any;
|
|
225
254
|
}
|
|
@@ -252,9 +281,13 @@ export interface EducationItem {
|
|
|
252
281
|
*/
|
|
253
282
|
courses?: string[];
|
|
254
283
|
/**
|
|
255
|
-
* Thesis topic, honours, notable projects or other context (#292)
|
|
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)
|
|
256
285
|
*/
|
|
257
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[];
|
|
258
291
|
custom?: Custom;
|
|
259
292
|
[k: string]: any;
|
|
260
293
|
}
|
|
@@ -269,7 +302,7 @@ export interface AwardItem {
|
|
|
269
302
|
*/
|
|
270
303
|
awarder?: string;
|
|
271
304
|
/**
|
|
272
|
-
* e.g. Received for my work with Quantum Physics
|
|
305
|
+
* e.g. Received for my work with Quantum Physics. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
273
306
|
*/
|
|
274
307
|
summary?: string;
|
|
275
308
|
custom?: Custom;
|
|
@@ -295,7 +328,7 @@ export interface CertificateItem {
|
|
|
295
328
|
issuer?: string;
|
|
296
329
|
expiryDate?: Iso8601;
|
|
297
330
|
/**
|
|
298
|
-
* What the certificate covers (#590)
|
|
331
|
+
* What the certificate covers (#590). Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
299
332
|
*/
|
|
300
333
|
summary?: string;
|
|
301
334
|
custom?: Custom;
|
|
@@ -350,7 +383,7 @@ export interface PublicationItem {
|
|
|
350
383
|
*/
|
|
351
384
|
url?: string;
|
|
352
385
|
/**
|
|
353
|
-
* Short summary of publication. e.g. Discussion of the World Wide Web, HTTP, HTML.
|
|
386
|
+
* Short summary of publication. e.g. Discussion of the World Wide Web, HTTP, HTML. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
354
387
|
*/
|
|
355
388
|
summary?: string;
|
|
356
389
|
/**
|
|
@@ -365,6 +398,10 @@ export interface SkillItem {
|
|
|
365
398
|
* e.g. Web Development
|
|
366
399
|
*/
|
|
367
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;
|
|
368
405
|
/**
|
|
369
406
|
* e.g. Master
|
|
370
407
|
*/
|
|
@@ -385,6 +422,20 @@ export interface LanguageItem {
|
|
|
385
422
|
* e.g. Fluent, Beginner
|
|
386
423
|
*/
|
|
387
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
|
+
};
|
|
388
439
|
custom?: Custom;
|
|
389
440
|
[k: string]: any;
|
|
390
441
|
}
|
|
@@ -428,15 +479,15 @@ export interface ProjectItem {
|
|
|
428
479
|
*/
|
|
429
480
|
name?: string;
|
|
430
481
|
/**
|
|
431
|
-
* Short summary of the project, consistent with summary in other sections (#296). e.g. Collated works of 2017.
|
|
482
|
+
* Short summary of the project, consistent with summary in other sections (#296). e.g. Collated works of 2017. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
432
483
|
*/
|
|
433
484
|
summary?: string;
|
|
434
485
|
/**
|
|
435
|
-
* Deprecated alias of summary, kept for compatibility; when both are set, summary wins (#296). e.g. Collated works of 2017.
|
|
486
|
+
* Deprecated alias of summary, kept for compatibility; when both are set, summary wins (#296). e.g. Collated works of 2017. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
436
487
|
*/
|
|
437
488
|
description?: string;
|
|
438
489
|
/**
|
|
439
|
-
* Specify multiple features
|
|
490
|
+
* Specify multiple features. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
440
491
|
*/
|
|
441
492
|
highlights?: string[];
|
|
442
493
|
/**
|
|
@@ -461,6 +512,10 @@ export interface ProjectItem {
|
|
|
461
512
|
* e.g. 'volunteering', 'presentation', 'talk', 'application', 'conference'
|
|
462
513
|
*/
|
|
463
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[];
|
|
464
519
|
custom?: Custom;
|
|
465
520
|
[k: string]: any;
|
|
466
521
|
}
|
|
@@ -480,6 +535,24 @@ export interface ResumeMeta {
|
|
|
480
535
|
* Using ISO 8601 with YYYY-MM-DDThh:mm:ss
|
|
481
536
|
*/
|
|
482
537
|
lastModified?: string;
|
|
538
|
+
/**
|
|
539
|
+
* The language this resume is written in, as a BCP 47 tag, e.g. en, pt-BR. One document per language (#288)
|
|
540
|
+
*/
|
|
541
|
+
language?: string;
|
|
542
|
+
/**
|
|
543
|
+
* The same resume in other languages, one document each (#288)
|
|
544
|
+
*/
|
|
545
|
+
translations?: {
|
|
546
|
+
/**
|
|
547
|
+
* BCP 47 tag of that document, e.g. fr
|
|
548
|
+
*/
|
|
549
|
+
language?: string;
|
|
550
|
+
/**
|
|
551
|
+
* URL (as per RFC 3986) of that document
|
|
552
|
+
*/
|
|
553
|
+
url?: string;
|
|
554
|
+
[k: string]: any;
|
|
555
|
+
}[];
|
|
483
556
|
[k: string]: any;
|
|
484
557
|
}
|
|
485
558
|
|
|
@@ -523,13 +596,69 @@ export interface JobDescription {
|
|
|
523
596
|
*/
|
|
524
597
|
remote?: 'Full' | 'Hybrid' | 'None';
|
|
525
598
|
/**
|
|
526
|
-
*
|
|
599
|
+
* The pay as the post words it, for display, e.g. '$120k–150k + equity'. Structured amounts go in compensation (#319)
|
|
527
600
|
*/
|
|
528
601
|
salary?: string;
|
|
602
|
+
/**
|
|
603
|
+
* The pay as numbers, for tools (#319). salary stays the text people read. Values normalised to one currency are derived data, not part of the document
|
|
604
|
+
*/
|
|
605
|
+
compensation?: {
|
|
606
|
+
/**
|
|
607
|
+
* The lowest amount offered, per period
|
|
608
|
+
*/
|
|
609
|
+
min?: number;
|
|
610
|
+
/**
|
|
611
|
+
* The highest amount offered, per period; equal to min for a single figure
|
|
612
|
+
*/
|
|
613
|
+
max?: number;
|
|
614
|
+
/**
|
|
615
|
+
* ISO 4217 code, e.g. USD, EUR, AUD
|
|
616
|
+
*/
|
|
617
|
+
currency?: string;
|
|
618
|
+
/**
|
|
619
|
+
* What each amount is paid for
|
|
620
|
+
*/
|
|
621
|
+
period?: 'hour' | 'day' | 'week' | 'month' | 'year';
|
|
622
|
+
[k: string]: any;
|
|
623
|
+
};
|
|
529
624
|
/**
|
|
530
625
|
* Senior or Junior or Mid-level
|
|
531
626
|
*/
|
|
532
627
|
experience?: string;
|
|
628
|
+
/**
|
|
629
|
+
* The post in fixed terms tools can filter on (#353). Each is optional, and unspecified means the post does not say. The free-text fields above stay for display
|
|
630
|
+
*/
|
|
631
|
+
facets?: {
|
|
632
|
+
/**
|
|
633
|
+
* Where the work is done: remote_region is remote within named regions, remote_global remote from anywhere
|
|
634
|
+
*/
|
|
635
|
+
remoteScope?: 'onsite' | 'hybrid' | 'remote_region' | 'remote_global' | 'unspecified';
|
|
636
|
+
/**
|
|
637
|
+
* Where remote work is allowed, when limited, e.g. ['US'], ['EU']
|
|
638
|
+
*/
|
|
639
|
+
remoteRegions?: string[];
|
|
640
|
+
/**
|
|
641
|
+
* Hours of overlap or time zones required, e.g. UTC-5 to UTC+1
|
|
642
|
+
*/
|
|
643
|
+
timezoneRange?: string;
|
|
644
|
+
/**
|
|
645
|
+
* The level of the role
|
|
646
|
+
*/
|
|
647
|
+
seniority?: 'intern' | 'junior' | 'mid' | 'senior' | 'staff_plus' | 'lead_management' | 'unspecified';
|
|
648
|
+
/**
|
|
649
|
+
* How the role is held
|
|
650
|
+
*/
|
|
651
|
+
employmentType?: 'full_time' | 'part_time' | 'contract' | 'internship' | 'cofounder' | 'unspecified';
|
|
652
|
+
/**
|
|
653
|
+
* Whether the employer sponsors a visa
|
|
654
|
+
*/
|
|
655
|
+
visaSponsorship?: 'yes' | 'no' | 'unspecified';
|
|
656
|
+
/**
|
|
657
|
+
* Whether compensation comes from numbers the post states, was inferred, or is missing
|
|
658
|
+
*/
|
|
659
|
+
salaryProvenance?: 'stated' | 'inferred' | 'absent';
|
|
660
|
+
[k: string]: any;
|
|
661
|
+
};
|
|
533
662
|
/**
|
|
534
663
|
* what the job entails
|
|
535
664
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jsonresume/types",
|
|
3
|
-
"version": "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.
|
|
21
|
+
"@jsonresume/schema": "1.9.0",
|
|
22
22
|
"tsconfig": "0.0.0"
|
|
23
23
|
},
|
|
24
24
|
"keywords": [
|