resuml 1.2.2

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "resuml",
+  "version": "1.2.2",
+  "description": "Generate JSON resumes from YAML with theme support",
+  "main": "./dist/index.js",
+  "bin": {
+    "resuml": "./bin/resuml.cjs"
+  },
+  "files": [
+    "bin",
+    "dist",
+    "README.md",
+    "scripts",
+    "src/types"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "prepublishOnly": "npm run generate:types && npm run build",
+    "generate:types": "node scripts/generate-types.js",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src --ext .ts",
+    "format": "prettier --write .",
+    "release": "semantic-release",
+    "prepare": "husky"
+  },
+  "dependencies": {
+    "@jsonresume/schema": "^1.0.0",
+    "ajv": "^8.12.0",
+    "chalk": "^5.3.0",
+    "commander": "^11.1.0",
+    "js-yaml": "^4.1.0",
+    "lodash.merge": "^4.6.2",
+    "yaml": "^2.3.4"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^11.0.3",
+    "@semantic-release/npm": "^12.0.1",
+    "@semantic-release/release-notes-generator": "^14.0.3",
+    "@types/js-yaml": "^4.0.9",
+    "@types/lodash.merge": "^4.6.9",
+    "@types/node": "^20.11.19",
+    "@typescript-eslint/eslint-plugin": "^8.33.0",
+    "@typescript-eslint/parser": "^8.33.0",
+    "eslint": "^8.0.0",
+    "eslint-config-prettier": "^9.0.0",
+    "husky": "^9.1.7",
+    "json-schema-to-typescript": "^15.0.4",
+    "prettier": "^3.0.0",
+    "semantic-release": "^24.2.5",
+    "tsup": "^8.0.2",
+    "typescript": "^5.0.0",
+    "vitest": "^3.2.2"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "license": "ISC",
+  "author": "phoinixi",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/scripts/generate-types.js

@@ -0,0 +1,55 @@
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+const SCHEMA_URL = 'https://raw.githubusercontent.com/jsonresume/resume-schema/master/schema.json';
+const SCHEMA_FILE = 'resume.schema.json';
+const OUTPUT_DIR = path.join('src', 'types');
+const OUTPUT_FILE = path.join(OUTPUT_DIR, 'resume.ts');
+
+function runCommand(command, description) {
+  console.log(`⏳ ${description}...`);
+  try {
+    execSync(command, { stdio: 'inherit' });
+    console.log(`✅ ${description} successful!`);
+  } catch (error) {
+    console.error(`❌ Error during ${description}:`, error.message);
+    if (error.stderr) {
+      console.error(error.stderr.toString());
+    }
+    if (error.stdout) {
+      console.error(error.stdout.toString());
+    }
+    process.exit(1);
+  }
+}
+
+console.log('🚀 Starting type generation process...');
+
+// 1. Fetch the schema
+runCommand(`curl -s -L -o ${SCHEMA_FILE} ${SCHEMA_URL}`, 'Fetching latest JSON Resume schema');
+
+// 2. Create output directory if it doesn't exist
+if (!fs.existsSync(OUTPUT_DIR)) {
+  console.log(`⏳ Creating directory ${OUTPUT_DIR}...`);
+  fs.mkdirSync(OUTPUT_DIR, { recursive: true });
+  console.log(`✅ Directory ${OUTPUT_DIR} created.`);
+}
+
+// 3. Generate TypeScript types
+runCommand(
+  `npx json-schema-to-typescript ${SCHEMA_FILE} -o ${OUTPUT_FILE}`,
+  'Generating TypeScript types'
+);
+
+// 4. Remove the downloaded schema file
+console.log(`⏳ Removing temporary schema file ${SCHEMA_FILE}...`);
+try {
+  fs.unlinkSync(SCHEMA_FILE);
+  console.log(`✅ Temporary schema file ${SCHEMA_FILE} removed.`);
+} catch (error) {
+  console.error(`❌ Error removing temporary schema file ${SCHEMA_FILE}:`, error.message);
+  // Non-fatal, so don't exit
+}
+
+console.log('🎉 TypeScript types generated successfully from JSON Resume schema!');

package/src/types/resume.ts

@@ -0,0 +1,344 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+/**
+ * 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 ResumeSchema {
+  /**
+   * link to the version of the schema that can validate the resume
+   */
+  $schema?: string;
+  basics?: {
+    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?: {
+      /**
+       * 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]: unknown;
+    };
+    /**
+     * Specify any number of social networks that you participate in
+     */
+    profiles?: {
+      /**
+       * e.g. Facebook or Twitter
+       */
+      network?: string;
+      /**
+       * e.g. neutralthoughts
+       */
+      username?: string;
+      /**
+       * e.g. http://twitter.example.com/neutralthoughts
+       */
+      url?: string;
+      [k: string]: unknown;
+    }[];
+    [k: string]: unknown;
+  };
+  work?: {
+    /**
+     * 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]: unknown;
+  }[];
+  volunteer?: {
+    /**
+     * 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]: unknown;
+  }[];
+  education?: {
+    /**
+     * 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]: unknown;
+  }[];
+  /**
+   * Specify any awards you have received throughout your professional career
+   */
+  awards?: {
+    /**
+     * 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]: unknown;
+  }[];
+  /**
+   * Specify any certificates you have received throughout your professional career
+   */
+  certificates?: {
+    /**
+     * e.g. Certified Kubernetes Administrator
+     */
+    name?: string;
+    date?: Iso8601;
+    /**
+     * e.g. http://example.com
+     */
+    url?: string;
+    /**
+     * e.g. CNCF
+     */
+    issuer?: string;
+    [k: string]: unknown;
+  }[];
+  /**
+   * Specify your publications through your career
+   */
+  publications?: {
+    /**
+     * 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]: unknown;
+  }[];
+  /**
+   * 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]: unknown;
+  }[];
+  /**
+   * List any other languages you speak
+   */
+  languages?: {
+    /**
+     * e.g. English, Spanish
+     */
+    language?: string;
+    /**
+     * e.g. Fluent, Beginner
+     */
+    fluency?: string;
+    [k: string]: unknown;
+  }[];
+  interests?: {
+    /**
+     * e.g. Philosophy
+     */
+    name?: string;
+    keywords?: string[];
+    [k: string]: unknown;
+  }[];
+  /**
+   * List references you have received
+   */
+  references?: {
+    /**
+     * 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]: unknown;
+  }[];
+  /**
+   * Specify career projects
+   */
+  projects?: {
+    /**
+     * 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]: unknown;
+  }[];
+  /**
+   * 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]: unknown;
+  };
+  [k: string]: unknown;
+}

package/src/types/schema.d.ts

@@ -0,0 +1,6 @@
+declare module '@jsonresume/schema' {
+  export function validate(
+    data: unknown,
+    callback: (errors: unknown[], isValid: boolean) => void
+  ): void;
+}

package/src/types/theme.d.ts

@@ -0,0 +1,15 @@
+declare module 'jsonresume-theme-mock' {
+  export interface Theme {
+    render: (resumeData: unknown) => string;
+  }
+  const theme: Theme;
+  export default theme;
+}
+
+declare module '@resuml/theme-mock-native' {
+  export interface Theme {
+    render: (resumeData: unknown, options: unknown) => string;
+  }
+  const theme: Theme;
+  export default theme;
+}