@jsonresume/types 0.6.0 → 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.
Files changed (2) hide show
  1. package/dist/index.d.ts +90 -16
  2. package/package.json +2 -2
package/dist/index.d.ts CHANGED
@@ -62,10 +62,6 @@ export interface ResumeBasics {
62
62
  * e.g. Web Developer
63
63
  */
64
64
  label?: string;
65
- /**
66
- * e.g. she/her, they/them (#312)
67
- */
68
- pronouns?: string;
69
65
  /**
70
66
  * URL (as per RFC 3986) to a image in JPEG or PNG format
71
67
  */
@@ -83,7 +79,7 @@ export interface ResumeBasics {
83
79
  */
84
80
  url?: string;
85
81
  /**
86
- * 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)
87
83
  */
88
84
  summary?: string;
89
85
  location?: ResumeLocation;
@@ -154,6 +150,10 @@ export interface WorkItem {
154
150
  * e.g. Software Engineer
155
151
  */
156
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;
157
157
  /**
158
158
  * e.g. http://facebook.example.com
159
159
  */
@@ -161,11 +161,11 @@ export interface WorkItem {
161
161
  startDate?: Iso8601;
162
162
  endDate?: Iso8601;
163
163
  /**
164
- * 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)
165
165
  */
166
166
  summary?: string;
167
167
  /**
168
- * Specify multiple accomplishments
168
+ * Specify multiple accomplishments. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
169
169
  */
170
170
  highlights?: string[];
171
171
  /**
@@ -217,7 +217,7 @@ export interface VolunteerItem {
217
217
  startDate?: Iso8601;
218
218
  endDate?: Iso8601;
219
219
  /**
220
- * 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)
221
221
  */
222
222
  summary?: string;
223
223
  /**
@@ -256,7 +256,7 @@ export interface EducationItem {
256
256
  */
257
257
  courses?: string[];
258
258
  /**
259
- * 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)
260
260
  */
261
261
  summary?: string;
262
262
  custom?: Custom;
@@ -273,7 +273,7 @@ export interface AwardItem {
273
273
  */
274
274
  awarder?: string;
275
275
  /**
276
- * 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)
277
277
  */
278
278
  summary?: string;
279
279
  custom?: Custom;
@@ -299,7 +299,7 @@ export interface CertificateItem {
299
299
  issuer?: string;
300
300
  expiryDate?: Iso8601;
301
301
  /**
302
- * 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)
303
303
  */
304
304
  summary?: string;
305
305
  custom?: Custom;
@@ -354,7 +354,7 @@ export interface PublicationItem {
354
354
  */
355
355
  url?: string;
356
356
  /**
357
- * 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)
358
358
  */
359
359
  summary?: string;
360
360
  /**
@@ -432,15 +432,15 @@ export interface ProjectItem {
432
432
  */
433
433
  name?: string;
434
434
  /**
435
- * 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)
436
436
  */
437
437
  summary?: string;
438
438
  /**
439
- * 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)
440
440
  */
441
441
  description?: string;
442
442
  /**
443
- * Specify multiple features
443
+ * Specify multiple features. Inline Markdown allowed: **strong**, *emphasis*, `code` and [links](https://example.com); no headings, lists or tables (#600)
444
444
  */
445
445
  highlights?: string[];
446
446
  /**
@@ -484,6 +484,24 @@ export interface ResumeMeta {
484
484
  * Using ISO 8601 with YYYY-MM-DDThh:mm:ss
485
485
  */
486
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
+ }[];
487
505
  [k: string]: any;
488
506
  }
489
507
 
@@ -527,13 +545,69 @@ export interface JobDescription {
527
545
  */
528
546
  remote?: 'Full' | 'Hybrid' | 'None';
529
547
  /**
530
- * 100000
548
+ * The pay as the post words it, for display, e.g. '$120k–150k + equity'. Structured amounts go in compensation (#319)
531
549
  */
532
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
+ };
533
573
  /**
534
574
  * Senior or Junior or Mid-level
535
575
  */
536
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
+ };
537
611
  /**
538
612
  * what the job entails
539
613
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jsonresume/types",
3
- "version": "0.6.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.7.0",
21
+ "@jsonresume/schema": "1.8.0",
22
22
  "tsconfig": "0.0.0"
23
23
  },
24
24
  "keywords": [