@jsonresume/types 0.6.1 → 0.7.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 +90 -12
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -79,7 +79,7 @@ export interface ResumeBasics {
|
|
|
79
79
|
*/
|
|
80
80
|
url?: string;
|
|
81
81
|
/**
|
|
82
|
-
* Write a short 2-3 sentence biography about yourself
|
|
82
|
+
* 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
83
|
*/
|
|
84
84
|
summary?: string;
|
|
85
85
|
location?: ResumeLocation;
|
|
@@ -150,6 +150,10 @@ export interface WorkItem {
|
|
|
150
150
|
* e.g. Software Engineer
|
|
151
151
|
*/
|
|
152
152
|
position?: string;
|
|
153
|
+
/**
|
|
154
|
+
* 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)
|
|
155
|
+
*/
|
|
156
|
+
type?: string;
|
|
153
157
|
/**
|
|
154
158
|
* e.g. http://facebook.example.com
|
|
155
159
|
*/
|
|
@@ -157,11 +161,11 @@ export interface WorkItem {
|
|
|
157
161
|
startDate?: Iso8601;
|
|
158
162
|
endDate?: Iso8601;
|
|
159
163
|
/**
|
|
160
|
-
* Give an overview of your responsibilities at the company
|
|
164
|
+
* 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
165
|
*/
|
|
162
166
|
summary?: string;
|
|
163
167
|
/**
|
|
164
|
-
* Specify multiple accomplishments
|
|
168
|
+
* Specify multiple accomplishments. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
165
169
|
*/
|
|
166
170
|
highlights?: string[];
|
|
167
171
|
/**
|
|
@@ -213,7 +217,7 @@ export interface VolunteerItem {
|
|
|
213
217
|
startDate?: Iso8601;
|
|
214
218
|
endDate?: Iso8601;
|
|
215
219
|
/**
|
|
216
|
-
* Give an overview of your responsibilities at the company
|
|
220
|
+
* 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
221
|
*/
|
|
218
222
|
summary?: string;
|
|
219
223
|
/**
|
|
@@ -252,7 +256,7 @@ export interface EducationItem {
|
|
|
252
256
|
*/
|
|
253
257
|
courses?: string[];
|
|
254
258
|
/**
|
|
255
|
-
* Thesis topic, honours, notable projects or other context (#292)
|
|
259
|
+
* 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
260
|
*/
|
|
257
261
|
summary?: string;
|
|
258
262
|
custom?: Custom;
|
|
@@ -269,7 +273,7 @@ export interface AwardItem {
|
|
|
269
273
|
*/
|
|
270
274
|
awarder?: string;
|
|
271
275
|
/**
|
|
272
|
-
* e.g. Received for my work with Quantum Physics
|
|
276
|
+
* 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
277
|
*/
|
|
274
278
|
summary?: string;
|
|
275
279
|
custom?: Custom;
|
|
@@ -295,7 +299,7 @@ export interface CertificateItem {
|
|
|
295
299
|
issuer?: string;
|
|
296
300
|
expiryDate?: Iso8601;
|
|
297
301
|
/**
|
|
298
|
-
* What the certificate covers (#590)
|
|
302
|
+
* What the certificate covers (#590). Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
299
303
|
*/
|
|
300
304
|
summary?: string;
|
|
301
305
|
custom?: Custom;
|
|
@@ -350,7 +354,7 @@ export interface PublicationItem {
|
|
|
350
354
|
*/
|
|
351
355
|
url?: string;
|
|
352
356
|
/**
|
|
353
|
-
* Short summary of publication. e.g. Discussion of the World Wide Web, HTTP, HTML.
|
|
357
|
+
* 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
358
|
*/
|
|
355
359
|
summary?: string;
|
|
356
360
|
/**
|
|
@@ -428,15 +432,15 @@ export interface ProjectItem {
|
|
|
428
432
|
*/
|
|
429
433
|
name?: string;
|
|
430
434
|
/**
|
|
431
|
-
* Short summary of the project, consistent with summary in other sections (#296). e.g. Collated works of 2017.
|
|
435
|
+
* 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
436
|
*/
|
|
433
437
|
summary?: string;
|
|
434
438
|
/**
|
|
435
|
-
* Deprecated alias of summary, kept for compatibility; when both are set, summary wins (#296). e.g. Collated works of 2017.
|
|
439
|
+
* 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
440
|
*/
|
|
437
441
|
description?: string;
|
|
438
442
|
/**
|
|
439
|
-
* Specify multiple features
|
|
443
|
+
* Specify multiple features. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
|
|
440
444
|
*/
|
|
441
445
|
highlights?: string[];
|
|
442
446
|
/**
|
|
@@ -480,6 +484,24 @@ export interface ResumeMeta {
|
|
|
480
484
|
* Using ISO 8601 with YYYY-MM-DDThh:mm:ss
|
|
481
485
|
*/
|
|
482
486
|
lastModified?: string;
|
|
487
|
+
/**
|
|
488
|
+
* The language this resume is written in, as a BCP 47 tag, e.g. en, pt-BR. One document per language (#288)
|
|
489
|
+
*/
|
|
490
|
+
language?: string;
|
|
491
|
+
/**
|
|
492
|
+
* The same resume in other languages, one document each (#288)
|
|
493
|
+
*/
|
|
494
|
+
translations?: {
|
|
495
|
+
/**
|
|
496
|
+
* BCP 47 tag of that document, e.g. fr
|
|
497
|
+
*/
|
|
498
|
+
language?: string;
|
|
499
|
+
/**
|
|
500
|
+
* URL (as per RFC 3986) of that document
|
|
501
|
+
*/
|
|
502
|
+
url?: string;
|
|
503
|
+
[k: string]: any;
|
|
504
|
+
}[];
|
|
483
505
|
[k: string]: any;
|
|
484
506
|
}
|
|
485
507
|
|
|
@@ -523,13 +545,69 @@ export interface JobDescription {
|
|
|
523
545
|
*/
|
|
524
546
|
remote?: 'Full' | 'Hybrid' | 'None';
|
|
525
547
|
/**
|
|
526
|
-
*
|
|
548
|
+
* The pay as the post words it, for display, e.g. '$120k–150k + equity'. Structured amounts go in compensation (#319)
|
|
527
549
|
*/
|
|
528
550
|
salary?: string;
|
|
551
|
+
/**
|
|
552
|
+
* 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
|
|
553
|
+
*/
|
|
554
|
+
compensation?: {
|
|
555
|
+
/**
|
|
556
|
+
* The lowest amount offered, per period
|
|
557
|
+
*/
|
|
558
|
+
min?: number;
|
|
559
|
+
/**
|
|
560
|
+
* The highest amount offered, per period; equal to min for a single figure
|
|
561
|
+
*/
|
|
562
|
+
max?: number;
|
|
563
|
+
/**
|
|
564
|
+
* ISO 4217 code, e.g. USD, EUR, AUD
|
|
565
|
+
*/
|
|
566
|
+
currency?: string;
|
|
567
|
+
/**
|
|
568
|
+
* What each amount is paid for
|
|
569
|
+
*/
|
|
570
|
+
period?: 'hour' | 'day' | 'week' | 'month' | 'year';
|
|
571
|
+
[k: string]: any;
|
|
572
|
+
};
|
|
529
573
|
/**
|
|
530
574
|
* Senior or Junior or Mid-level
|
|
531
575
|
*/
|
|
532
576
|
experience?: string;
|
|
577
|
+
/**
|
|
578
|
+
* 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
|
|
579
|
+
*/
|
|
580
|
+
facets?: {
|
|
581
|
+
/**
|
|
582
|
+
* Where the work is done: remote_region is remote within named regions, remote_global remote from anywhere
|
|
583
|
+
*/
|
|
584
|
+
remoteScope?: 'onsite' | 'hybrid' | 'remote_region' | 'remote_global' | 'unspecified';
|
|
585
|
+
/**
|
|
586
|
+
* Where remote work is allowed, when limited, e.g. ['US'], ['EU']
|
|
587
|
+
*/
|
|
588
|
+
remoteRegions?: string[];
|
|
589
|
+
/**
|
|
590
|
+
* Hours of overlap or time zones required, e.g. UTC-5 to UTC+1
|
|
591
|
+
*/
|
|
592
|
+
timezoneRange?: string;
|
|
593
|
+
/**
|
|
594
|
+
* The level of the role
|
|
595
|
+
*/
|
|
596
|
+
seniority?: 'intern' | 'junior' | 'mid' | 'senior' | 'staff_plus' | 'lead_management' | 'unspecified';
|
|
597
|
+
/**
|
|
598
|
+
* How the role is held
|
|
599
|
+
*/
|
|
600
|
+
employmentType?: 'full_time' | 'part_time' | 'contract' | 'internship' | 'cofounder' | 'unspecified';
|
|
601
|
+
/**
|
|
602
|
+
* Whether the employer sponsors a visa
|
|
603
|
+
*/
|
|
604
|
+
visaSponsorship?: 'yes' | 'no' | 'unspecified';
|
|
605
|
+
/**
|
|
606
|
+
* Whether compensation comes from numbers the post states, was inferred, or is missing
|
|
607
|
+
*/
|
|
608
|
+
salaryProvenance?: 'stated' | 'inferred' | 'absent';
|
|
609
|
+
[k: string]: any;
|
|
610
|
+
};
|
|
533
611
|
/**
|
|
534
612
|
* what the job entails
|
|
535
613
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jsonresume/types",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.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.8.0",
|
|
22
22
|
"tsconfig": "0.0.0"
|
|
23
23
|
},
|
|
24
24
|
"keywords": [
|