maxim-mazurok/ez-vcard

vCard generator written in TypeScript for NodeJS that uses amazing ez-vcard library written in Java

ez-vcard

It is a vCard generator written in TypeScript for NodeJS that uses amazing ez-vcard library written in Java. It can read and write vCards in many different formats. The "ez" stands for "easy" because the goal is to create a library that's easy to use.

Getting started

1. Install JDK
   • Ubuntu / WSL: sudo apt install default-jdk
   • Windows: download and install
2. Install make and g++ on Ubuntu: sudo apt install build-essential (to build node-java dependency)
3. Install ez-vcard (this package)

   npm i ez-vcard

Usage in NodeJS

const ezVcard = require('ez-vcard').default;
(async () => {
  const vcard = await ezVcard({name: {first: 'Maxim'}});
  console.log(vcard);
})();

Usage in TypeScript

npm install @types/node typescript

src/vcard.ts

import ezVcard from 'ez-vcard';

(async () => {
  const vcard = await ezVcard({name: {first: 'Maxim'}});
  console.log(vcard);
})();

tsconfig.json

{
  "compilerOptions": {
    "esModuleInterop": true
  }
}

and run: npx ts-node src/vcard.ts or compile: npx tsc --outDir dist.

Note: the first run might take a while, because it downloads maven packages required for package to run. Subsequent runs will be much faster than the first one.

Features

• Status: It works!
• tsJavaModule.ts file contains ez-vcard TypeScript type definitions for node-java generated by Maxim-Mazurok/ez-vcard-ts-java-types
• index.ts exports default function to generate vcard

ez-vcard's Issues

could not resolve maven dependencies Error: Could not find java property in package.json

When using this package from node_modules, node-java-maven is looking for java property in a project's package.json, not in the ez-vcard's package.json.

Use packageJsonPath option to fix this.

Publish to NPM

During experiments, I published and then unpublished ez-vcard. Now I have to wait for 24 hours.
I published it at around 3-8 pm 28/09.

Figure out minimal required tsconfig.json

What is the minimal required tsconfig.json?

I got this working with the following config:

{
    "extends": "./node_modules/gts/tsconfig-google.json",
    "compilerOptions": {
        "esModuleInterop": true,
        "rootDir": "src",
        "outDir": "dist",
        "lib": [
            "es6"
        ],
        "listEmittedFiles": true,
        "typeRoots": [
            "./node_modules/@types"
        ]
    },
    "include": [
        "./src/**/*.ts"
    ]
}

which requires npm install gts.

And the project has the following structure:

- project
  - src
    - contact_picture.jpg
    - usage.ts (from https://github.com/Maxim-Mazurok/ez-vcard/blob/master/example/usage.ts)
  - package.json
  - tsconfig.json

Please, provide a better example of usage.

Expand schema

Add more options to the schema