@jsonresume/types 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2026 JSON Resume contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,453 @@
+/**
+ * Auto-generated by packages/types/scripts/generate.mjs from
+ * @jsonresume/schema (schema.json + job-schema.json). Do not edit by hand;
+ * run `pnpm --filter @jsonresume/types build` to regenerate.
+ */
+/* eslint-disable */
+
+/**
+ * Similar to the standard date type, but each section after the year is optional. e.g. 2014-06-29 or 2023-04
+ */
+export type Iso8601 = string;
+
+export interface Resume {
+  /**
+   * link to the version of the schema that can validate the resume
+   */
+  $schema?: string;
+  basics?: ResumeBasics;
+  work?: WorkItem[];
+  volunteer?: VolunteerItem[];
+  education?: EducationItem[];
+  /**
+   * Specify any awards you have received throughout your professional career
+   */
+  awards?: AwardItem[];
+  /**
+   * Specify any certificates you have received throughout your professional career
+   */
+  certificates?: CertificateItem[];
+  /**
+   * Specify your publications through your career
+   */
+  publications?: PublicationItem[];
+  /**
+   * List out your professional skill-set
+   */
+  skills?: SkillItem[];
+  /**
+   * List any other languages you speak
+   */
+  languages?: LanguageItem[];
+  interests?: InterestItem[];
+  /**
+   * List references you have received
+   */
+  references?: ReferenceItem[];
+  /**
+   * Specify career projects
+   */
+  projects?: ProjectItem[];
+  meta?: ResumeMeta;
+  [k: string]: any;
+}
+export interface ResumeBasics {
+  name?: string;
+  /**
+   * e.g. Web Developer
+   */
+  label?: string;
+  /**
+   * URL (as per RFC 3986) to a image in JPEG or PNG format
+   */
+  image?: string;
+  /**
+   * e.g. thomas@gmail.com
+   */
+  email?: string;
+  /**
+   * Phone numbers are stored as strings so use any format you like, e.g. 712-117-2923
+   */
+  phone?: string;
+  /**
+   * URL (as per RFC 3986) to your website, e.g. personal homepage
+   */
+  url?: string;
+  /**
+   * Write a short 2-3 sentence biography about yourself
+   */
+  summary?: string;
+  location?: ResumeLocation;
+  /**
+   * Specify any number of social networks that you participate in
+   */
+  profiles?: ResumeProfile[];
+  [k: string]: any;
+}
+export interface ResumeLocation {
+  /**
+   * To add multiple address lines, use
+   * . For example, 1234 Glücklichkeit Straße
+   * Hinterhaus 5. Etage li.
+   */
+  address?: string;
+  postalCode?: string;
+  city?: string;
+  /**
+   * code as per ISO-3166-1 ALPHA-2, e.g. US, AU, IN
+   */
+  countryCode?: string;
+  /**
+   * The general region where you live. Can be a US state, or a province, for instance.
+   */
+  region?: string;
+  [k: string]: any;
+}
+export interface ResumeProfile {
+  /**
+   * e.g. Facebook or Twitter
+   */
+  network?: string;
+  /**
+   * e.g. neutralthoughts
+   */
+  username?: string;
+  /**
+   * e.g. http://twitter.example.com/neutralthoughts
+   */
+  url?: string;
+  [k: string]: any;
+}
+export interface WorkItem {
+  /**
+   * e.g. Facebook
+   */
+  name?: string;
+  /**
+   * e.g. Menlo Park, CA
+   */
+  location?: string;
+  /**
+   * e.g. Social Media Company
+   */
+  description?: string;
+  /**
+   * e.g. Software Engineer
+   */
+  position?: string;
+  /**
+   * e.g. http://facebook.example.com
+   */
+  url?: string;
+  startDate?: Iso8601;
+  endDate?: Iso8601;
+  /**
+   * Give an overview of your responsibilities at the company
+   */
+  summary?: string;
+  /**
+   * Specify multiple accomplishments
+   */
+  highlights?: string[];
+  [k: string]: any;
+}
+export interface VolunteerItem {
+  /**
+   * e.g. Facebook
+   */
+  organization?: string;
+  /**
+   * e.g. Software Engineer
+   */
+  position?: string;
+  /**
+   * e.g. http://facebook.example.com
+   */
+  url?: string;
+  startDate?: Iso8601;
+  endDate?: Iso8601;
+  /**
+   * Give an overview of your responsibilities at the company
+   */
+  summary?: string;
+  /**
+   * Specify accomplishments and achievements
+   */
+  highlights?: string[];
+  [k: string]: any;
+}
+export interface EducationItem {
+  /**
+   * e.g. Massachusetts Institute of Technology
+   */
+  institution?: string;
+  /**
+   * e.g. http://facebook.example.com
+   */
+  url?: string;
+  /**
+   * e.g. Arts
+   */
+  area?: string;
+  /**
+   * e.g. Bachelor
+   */
+  studyType?: string;
+  startDate?: Iso8601;
+  endDate?: Iso8601;
+  /**
+   * grade point average, e.g. 3.67/4.0
+   */
+  score?: string;
+  /**
+   * List notable courses/subjects
+   */
+  courses?: string[];
+  [k: string]: any;
+}
+export interface AwardItem {
+  /**
+   * e.g. One of the 100 greatest minds of the century
+   */
+  title?: string;
+  date?: Iso8601;
+  /**
+   * e.g. Time Magazine
+   */
+  awarder?: string;
+  /**
+   * e.g. Received for my work with Quantum Physics
+   */
+  summary?: string;
+  [k: string]: any;
+}
+export interface CertificateItem {
+  /**
+   * e.g. Certified Kubernetes Administrator
+   */
+  name?: string;
+  date?: Iso8601;
+  /**
+   * e.g. http://example.com
+   */
+  url?: string;
+  /**
+   * e.g. CNCF
+   */
+  issuer?: string;
+  [k: string]: any;
+}
+export interface PublicationItem {
+  /**
+   * e.g. The World Wide Web
+   */
+  name?: string;
+  /**
+   * e.g. IEEE, Computer Magazine
+   */
+  publisher?: string;
+  releaseDate?: Iso8601;
+  /**
+   * e.g. http://www.computer.org.example.com/csdl/mags/co/1996/10/rx069-abs.html
+   */
+  url?: string;
+  /**
+   * Short summary of publication. e.g. Discussion of the World Wide Web, HTTP, HTML.
+   */
+  summary?: string;
+  [k: string]: any;
+}
+export interface SkillItem {
+  /**
+   * e.g. Web Development
+   */
+  name?: string;
+  /**
+   * e.g. Master
+   */
+  level?: string;
+  /**
+   * List some keywords pertaining to this skill
+   */
+  keywords?: string[];
+  [k: string]: any;
+}
+export interface LanguageItem {
+  /**
+   * e.g. English, Spanish
+   */
+  language?: string;
+  /**
+   * e.g. Fluent, Beginner
+   */
+  fluency?: string;
+  [k: string]: any;
+}
+export interface InterestItem {
+  /**
+   * e.g. Philosophy
+   */
+  name?: string;
+  keywords?: string[];
+  [k: string]: any;
+}
+export interface ReferenceItem {
+  /**
+   * e.g. Timothy Cook
+   */
+  name?: string;
+  /**
+   * 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.
+   */
+  reference?: string;
+  [k: string]: any;
+}
+export interface ProjectItem {
+  /**
+   * e.g. The World Wide Web
+   */
+  name?: string;
+  /**
+   * Short summary of project. e.g. Collated works of 2017.
+   */
+  description?: string;
+  /**
+   * Specify multiple features
+   */
+  highlights?: string[];
+  /**
+   * Specify special elements involved
+   */
+  keywords?: string[];
+  startDate?: Iso8601;
+  endDate?: Iso8601;
+  /**
+   * e.g. http://www.computer.org/csdl/mags/co/1996/10/rx069-abs.html
+   */
+  url?: string;
+  /**
+   * Specify your role on this project or in company
+   */
+  roles?: string[];
+  /**
+   * Specify the relevant company/entity affiliations e.g. 'greenpeace', 'corporationXYZ'
+   */
+  entity?: string;
+  /**
+   *  e.g. 'volunteering', 'presentation', 'talk', 'application', 'conference'
+   */
+  type?: string;
+  [k: string]: any;
+}
+/**
+ * The schema version and any other tooling configuration lives here
+ */
+export interface ResumeMeta {
+  /**
+   * URL (as per RFC 3986) to latest version of this document
+   */
+  canonical?: string;
+  /**
+   * A version field which follows semver - e.g. v1.0.0
+   */
+  version?: string;
+  /**
+   * Using ISO 8601 with YYYY-MM-DDThh:mm:ss
+   */
+  lastModified?: string;
+  [k: string]: any;
+}
+
+export interface JobDescription {
+  /**
+   * e.g. Web Developer
+   */
+  title?: string;
+  /**
+   * Microsoft
+   */
+  company?: string;
+  /**
+   * Full-time, part-time, contract, etc.
+   */
+  type?: string;
+  date?: Iso8601;
+  /**
+   * Write a short description about the job
+   */
+  description?: string;
+  location?: {
+    /**
+     * To add multiple address lines, use \n. For example, 1234 Glücklichkeit Straße\nHinterhaus 5. Etage li.
+     */
+    address?: string;
+    postalCode?: string;
+    city?: string;
+    /**
+     * code as per ISO-3166-1 ALPHA-2, e.g. US, AU, IN
+     */
+    countryCode?: string;
+    /**
+     * The general region where you live. Can be a US state, or a province, for instance.
+     */
+    region?: string;
+    [k: string]: any;
+  };
+  /**
+   * the level of remote work available
+   */
+  remote?: 'Full' | 'Hybrid' | 'None';
+  /**
+   * 100000
+   */
+  salary?: string;
+  /**
+   * Senior or Junior or Mid-level
+   */
+  experience?: string;
+  /**
+   * what the job entails
+   */
+  responsibilities?: string[];
+  /**
+   * List out your qualifications
+   */
+  qualifications?: string[];
+  /**
+   * List out your professional skill-set
+   */
+  skills?: {
+    /**
+     * e.g. Web Development
+     */
+    name?: string;
+    /**
+     * e.g. Master
+     */
+    level?: string;
+    /**
+     * List some keywords pertaining to this skill
+     */
+    keywords?: string[];
+    [k: string]: any;
+  }[];
+  /**
+   * The schema version and any other tooling configuration lives here
+   */
+  meta?: {
+    /**
+     * URL (as per RFC 3986) to latest version of this document
+     */
+    canonical?: string;
+    /**
+     * A version field which follows semver - e.g. v1.0.0
+     */
+    version?: string;
+    /**
+     * Using ISO 8601 with YYYY-MM-DDThh:mm:ss
+     */
+    lastModified?: string;
+    [k: string]: any;
+  };
+  [k: string]: any;
+}

package/index.js

@@ -0,0 +1,3 @@
+// @jsonresume/types is a types-only package. The runtime entry is intentionally
+// empty: all interfaces live in ./dist/index.d.ts (generated from the schema).
+export {};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@jsonresume/types",
+  "version": "0.2.0",
+  "private": false,
+  "description": "TypeScript types for the JSON Resume and Job schemas, generated from @jsonresume/schema",
+  "types": "./dist/index.d.ts",
+  "main": "./index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "index.js"
+  ],
+  "devDependencies": {
+    "json-schema-to-typescript": "^15.0.4",
+    "typescript": "^5.9.3",
+    "@jsonresume/schema": "1.3.0",
+    "tsconfig": "0.0.0"
+  },
+  "keywords": [
+    "resume",
+    "cv",
+    "json-resume",
+    "types",
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jsonresume/jsonresume.org",
+    "directory": "packages/types"
+  },
+  "homepage": "https://github.com/jsonresume/jsonresume.org/tree/master/packages/types",
+  "bugs": {
+    "url": "https://github.com/jsonresume/jsonresume.org/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "node ./scripts/generate.mjs",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  }
+}