diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 08818dd7c..954f8b9ab 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -28,7 +28,7 @@ body: label: Your Environment description: A clear and concise description of your environment value: | - - pdfme package(@pdfme/generator or @pdfme/ui): + - pdfme package(@lisb/pdfme-generator or @lisb/pdfme-ui): - pdfme version: - Operating system: - Node.js version or Browser name & version: diff --git a/.github/workflows/publish-package.yml b/.github/workflows/publish-package.yml new file mode 100644 index 000000000..1be23ca25 --- /dev/null +++ b/.github/workflows/publish-package.yml @@ -0,0 +1,59 @@ +name: Publish custom pdfme package + +on: + push: + branches: + - 1.1.5-custom + +jobs: + build: + runs-on: ubuntu-latest + permissions: + packages: write + contents: read + + steps: + - uses: actions/checkout@v3 + + - uses: actions/setup-node@v3 + with: + node-version: 19 + registry-url: https://npm.pkg.github.com/ + scope: '@lisb' + always-auth: true + + - name: install root + run: npm install + + - name: install common + run: npm install + working-directory: packages/common + + - name: install ui + run: npm install + working-directory: packages/ui + + - name: install generator + run: npm install + working-directory: packages/generator + + - name: build all + run: npm run build + + - name: publish common + run: npm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + working-directory: packages/common + + - name: publish generator + run: npm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + working-directory: packages/generator + + - name: publish ui + run: npm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + working-directory: packages/ui \ No newline at end of file diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index e0fd6d567..36df4a698 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -18,19 +18,19 @@ Make sure that any changes are output to the each packages's `dist` folder. ``` To confirm the changes, for example, create a React application with `npx create-react-app my-app` in other folder and -Install `@pdfme/generator` and `@pdfme/ui` with the following command. +Install `@lisb/pdfme-generator` and `@lisb/pdfme-ui` with the following command. ```cmd -[in my-app dir] $ npm install --save @pdfme/generator @pdfme/ui +[in my-app dir] $ npm install --save @lisb/pdfme-generator @lisb/pdfme-ui ``` In addition, connect `packages/generator` and `packages/ui`, which you npm linked above, to my-app with the following command ```cmd -[in my-app dir] $ npm link @pdfme/generator @pdfme/ui +[in my-app dir] $ npm link @lisb/pdfme-generator @lisb/pdfme-ui ``` -> If you don't want to prepare my-app by yourself, you can clone the following repository and use npm link @pdfme/generator @pdfme/ui to develop it. +> If you don't want to prepare my-app by yourself, you can clone the following repository and use npm link @lisb/pdfme-generator @lisb/pdfme-ui to develop it. > https://github.com/pdfme/pdfme-playground You can use `npm ls` to check if the `npm link` is configured correctly as follows. @@ -38,8 +38,8 @@ You can use `npm ls` to check if the `npm link` is configured correctly as follo ```cmd [in my-app dir] $ npm ls my-app@0.1.0 /Users/user/my-app -├── @pdfme/generator@npm:generator@1.0.0-beta.7 extraneous -> ./../../../pdfme/packages/generator -├── @pdfme/ui@npm:ui@1.0.0-beta.7 extraneous -> ./../../../pdfme/packages/ui +├── @lisb/pdfme-generator@npm:generator@1.0.0-beta.7 extraneous -> ./../../../pdfme/packages/generator +├── @lisb/pdfme-ui@npm:ui@1.0.0-beta.7 extraneous -> ./../../../pdfme/packages/ui ├── @testing-library/jest-dom@5.16.2 ├── @testing-library/react@12.1.2 ├── @testing-library/user-event@13.5.0 @@ -49,6 +49,6 @@ my-app@0.1.0 /Users/user/my-app └── web-vitals@2.1.4 ``` -Now, changes in `packages/common`, `packages/generator`, and `packages/ui` will be reflected in my-app's @pdfme/generator and @pdfme/ui. +Now, changes in `packages/common`, `packages/generator`, and `packages/ui` will be reflected in my-app's @lisb/pdfme-generator and @lisb/pdfme-ui. If you run npm run start on my-app and rewrite `packages/common`, `packages/generator`, and `packages/ui`, you can confirm the changes on my-app diff --git a/README.md b/README.md index 7c673768c..bb4a5d581 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@ Unit Testing status - - Current npm package version. + + Current npm package version. - - Downloads per month on npm. + + Downloads per month on npm. PRs welcome! @@ -59,23 +59,23 @@ There are two packages in pdfme, generator and UI. The package for generating PDF can be installed with the following command. ``` -npm i @pdfme/generator +npm i @lisb/pdfme-generator ``` The packages for using PDF designer, forms and viewers can be installed with the following commands. ``` -npm i @pdfme/ui +npm i @lisb/pdfme-ui ``` The following type, function and classes are available in pdfme. -`@pdfme/generator` +`@lisb/pdfme-generator` - [generate](https://pdfme.com/docs/getting-started#generator) - [Template](https://pdfme.com/docs/getting-started#template) -`@pdfme/ui` +`@lisb/pdfme-ui` - [Designer](https://pdfme.com/docs/getting-started#designer) - [Form](https://pdfme.com/docs/getting-started#form) @@ -85,11 +85,11 @@ The following type, function and classes are available in pdfme. If your environment uses webpack, import the necessary items as shown below. ```ts -import { Template, generate } from '@pdfme/generator'; +import { Template, generate } from '@lisb/pdfme-generator'; ``` ```ts -import { Template, Designer, Form, Viewer } from '@pdfme/ui'; +import { Template, Designer, Form, Viewer } from '@lisb/pdfme-ui'; ``` **All objects use `Template`, which will be briefly explained in the next section.** @@ -98,7 +98,7 @@ import { Template, Designer, Form, Viewer } from '@pdfme/ui'; ## Template The core of pdfme library are Templates. -Template Type can be imported by both `@pdfme/generator` or `@pdfme/ui`. Templates are used everywhere. +Template Type can be imported by both `@lisb/pdfme-generator` or `@lisb/pdfme-ui`. Templates are used everywhere. A template can be divided into two parts: a fixed part and a variable part. We call them basePdf and schema. @@ -124,8 +124,8 @@ Let's take a look at some specific data. ### Minimal Template ```ts -import { Template, BLANK_PDF } from '@pdfme/generator'; -// import { Template, BLANK_PDF } from '@pdfme/ui'; <- Template types and BLANK_PDF can also be imported from @pdfme/ui. +import { Template, BLANK_PDF } from '@lisb/pdfme-generator'; +// import { Template, BLANK_PDF } from '@lisb/pdfme-ui'; <- Template types and BLANK_PDF can also be imported from @lisb/pdfme-ui. const template: Template = { basePdf: BLANK_PDF, @@ -165,7 +165,7 @@ The PDF generator function, `generate`, takes 2 arguments of `template` and `inp The code to generate a PDF file using the [template created above](https://pdfme.com/docs/getting-started#sample-template) is shown below. ```ts -import { Template, generate } from '@pdfme/generator'; +import { Template, generate } from '@lisb/pdfme-generator'; const template: Template = { // skip... Check the Template section. @@ -203,7 +203,7 @@ You can design your own template from [Template Design page](https://pdfme.com/t Let's integrate the designer using the template created above as the default template. ```ts -import { Template, Designer } from '@pdfme/ui'; +import { Template, Designer } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { @@ -236,7 +236,7 @@ You can use templates to create forms and PDF viewers. The Form creates a UI for the user to enter schemas based on the template. ```ts -import { Template, Form } from '@pdfme/ui'; +import { Template, Form } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { @@ -272,7 +272,7 @@ The Viewer is a byproduct of the Form development process, but it allows you to Using the Viewer is basically the same as using the Form, except that user cannot edit it. ```ts -import { Template, Viewer } from '@pdfme/ui'; +import { Template, Viewer } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { diff --git a/package-lock.json b/package-lock.json index 61d27fd20..c009520e4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { - "name": "root", - "version": "0.0.0", + "name": "@lisb/pdfme", + "version": "0.0.3", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "root", - "version": "0.0.0", + "name": "@lisb/pdfme", + "version": "0.0.3", "license": "MIT", "workspaces": [ "packages/*" @@ -1408,6 +1408,18 @@ "@jridgewell/sourcemap-codec": "^1.4.10" } }, + "node_modules/@lisb/pdfme-common": { + "resolved": "packages/common", + "link": true + }, + "node_modules/@lisb/pdfme-generator": { + "resolved": "packages/generator", + "link": true + }, + "node_modules/@lisb/pdfme-ui": { + "resolved": "packages/ui", + "link": true + }, "node_modules/@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -1467,18 +1479,6 @@ "pako": "^1.0.10" } }, - "node_modules/@pdfme/common": { - "resolved": "packages/common", - "link": true - }, - "node_modules/@pdfme/generator": { - "resolved": "packages/generator", - "link": true - }, - "node_modules/@pdfme/ui": { - "resolved": "packages/ui", - "link": true - }, "node_modules/@scena/dragscroll": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/@scena/dragscroll/-/dragscroll-1.0.3.tgz", @@ -9885,8 +9885,8 @@ } }, "packages/common": { - "name": "@pdfme/common", - "version": "1.1.5", + "name": "@lisb/pdfme-common", + "version": "1.1.6", "license": "MIT", "dependencies": { "zod": "^3.11.6" @@ -9896,12 +9896,12 @@ } }, "packages/generator": { - "name": "@pdfme/generator", - "version": "1.1.5", + "name": "@lisb/pdfme-generator", + "version": "1.1.6", "license": "MIT", "dependencies": { + "@lisb/pdfme-common": "^1.0.0", "@pdf-lib/fontkit": "^1.1.1", - "@pdfme/common": "^1.0.0", "atob": "^2.1.2", "bwip-js": "^3.2.2", "pdf-lib": "^1.17.1" @@ -9918,14 +9918,14 @@ } }, "packages/ui": { - "name": "@pdfme/ui", - "version": "1.1.5", + "name": "@lisb/pdfme-ui", + "version": "1.1.6", "license": "MIT", "dependencies": { "@dnd-kit/core": "^5.0.1", "@dnd-kit/sortable": "^6.0.0", "@heroicons/react": "^2.0.13", - "@pdfme/common": "^1.0.0", + "@lisb/pdfme-common": "^1.0.0", "@scena/react-guides": "^0.16.0", "hotkeys-js": "^3.8.7", "pdfjs-dist": "^2.12.313", @@ -10991,6 +10991,55 @@ "@jridgewell/sourcemap-codec": "^1.4.10" } }, + "@lisb/pdfme-common": { + "version": "file:packages/common", + "requires": { + "zod": "^3.11.6" + } + }, + "@lisb/pdfme-generator": { + "version": "file:packages/generator", + "requires": { + "@lisb/pdfme-common": "^1.0.0", + "@pdf-lib/fontkit": "^1.1.1", + "@types/bwip-js": "^3.0.0", + "@types/pngjs": "^6.0.1", + "atob": "^2.1.2", + "bwip-js": "^3.2.2", + "jsqr": "^1.4.0", + "pdf-lib": "^1.17.1", + "pdf2json": "^2.0.0", + "pngjs": "^6.0.0" + } + }, + "@lisb/pdfme-ui": { + "version": "file:packages/ui", + "requires": { + "@dnd-kit/core": "^5.0.1", + "@dnd-kit/sortable": "^6.0.0", + "@heroicons/react": "^2.0.13", + "@lisb/pdfme-common": "^1.0.0", + "@scena/react-guides": "^0.16.0", + "@testing-library/jest-dom": "^5.16.1", + "@testing-library/react": "^12.1.2", + "@types/pdfjs-dist": "^2.7.4", + "@types/react": "^17.0.52", + "@types/react-dom": "^17.0.18", + "eslint-plugin-react": "^7.28.0", + "eslint-plugin-react-hooks": "^4.3.0", + "hotkeys-js": "^3.8.7", + "jest-canvas-mock": "^2.3.1", + "pdfjs-dist": "^2.12.313", + "process": "^0.11.10", + "react": "^17.0.2", + "react-dom": "^17.0.2", + "react-moveable": "^0.30.3", + "react-selecto": "^1.12.0", + "webpack": "^5.75.0", + "webpack-cli": "^5.0.1", + "worker-loader": "^3.0.8" + } + }, "@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -11041,55 +11090,6 @@ "pako": "^1.0.10" } }, - "@pdfme/common": { - "version": "file:packages/common", - "requires": { - "zod": "^3.11.6" - } - }, - "@pdfme/generator": { - "version": "file:packages/generator", - "requires": { - "@pdf-lib/fontkit": "^1.1.1", - "@pdfme/common": "^1.0.0", - "@types/bwip-js": "^3.0.0", - "@types/pngjs": "^6.0.1", - "atob": "^2.1.2", - "bwip-js": "^3.2.2", - "jsqr": "^1.4.0", - "pdf-lib": "^1.17.1", - "pdf2json": "^2.0.0", - "pngjs": "^6.0.0" - } - }, - "@pdfme/ui": { - "version": "file:packages/ui", - "requires": { - "@dnd-kit/core": "^5.0.1", - "@dnd-kit/sortable": "^6.0.0", - "@heroicons/react": "^2.0.13", - "@pdfme/common": "^1.0.0", - "@scena/react-guides": "^0.16.0", - "@testing-library/jest-dom": "^5.16.1", - "@testing-library/react": "^12.1.2", - "@types/pdfjs-dist": "^2.7.4", - "@types/react": "^17.0.52", - "@types/react-dom": "^17.0.18", - "eslint-plugin-react": "^7.28.0", - "eslint-plugin-react-hooks": "^4.3.0", - "hotkeys-js": "^3.8.7", - "jest-canvas-mock": "^2.3.1", - "pdfjs-dist": "^2.12.313", - "process": "^0.11.10", - "react": "^17.0.2", - "react-dom": "^17.0.2", - "react-moveable": "^0.30.3", - "react-selecto": "^1.12.0", - "webpack": "^5.75.0", - "webpack-cli": "^5.0.1", - "worker-loader": "^3.0.8" - } - }, "@scena/dragscroll": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/@scena/dragscroll/-/dragscroll-1.0.3.tgz", diff --git a/package.json b/package.json index 94029a9ba..bf656f458 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "root", - "version": "0.0.0", - "private": true, + "name": "@lisb/pdfme", + "version": "0.0.3", + "private": false, "author": "hand-dot", "license": "MIT", "keywords": [ @@ -16,10 +16,10 @@ "homepage": "https://pdfme.com", "repository": { "type": "git", - "url": "git@github.com:pdfme/pdfme.git" + "url": "https://github.com/lisb/pdfme.git" }, "bugs": { - "url": "https://github.com/pdfme/pdfme/issues" + "url": "https://github.com/lisb/pdfme/issues" }, "workspaces": [ "packages/*" @@ -30,6 +30,10 @@ "build": "npm run --workspaces clean && npm run --workspaces build", "test": "npm run --workspaces test" }, + "publishConfig": { + "access": "public", + "registry": "https://npm.pkg.github.com/" + }, "devDependencies": { "@babel/core": "^7.16.7", "@types/jest": "^27.4.0", diff --git a/packages/common/package.json b/packages/common/package.json index 4552ca5b3..49e804a72 100644 --- a/packages/common/package.json +++ b/packages/common/package.json @@ -1,6 +1,6 @@ { - "name": "@pdfme/common", - "version": "1.1.5", + "name": "@lisb/pdfme-common", + "version": "1.1.6", "sideEffects": false, "author": "hand-dot", "license": "MIT", @@ -16,10 +16,10 @@ "homepage": "https://pdfme.com", "repository": { "type": "git", - "url": "git@github.com:pdfme/pdfme.git" + "url": "https://github.com/lisb/pdfme-common.git" }, "bugs": { - "url": "https://github.com/pdfme/pdfme/issues" + "url": "https://github.com/lisb/pdfme/issues" }, "main": "dist/cjs/src/index.js", "module": "dist/esm/src/index.js", diff --git a/packages/generator/README.md b/packages/generator/README.md index 5fe218b36..0c7954e30 100644 --- a/packages/generator/README.md +++ b/packages/generator/README.md @@ -6,11 +6,11 @@ Unit Testing status - - Current npm package version. + + Current npm package version. - - Downloads per month on npm. + + Downloads per month on npm. PRs welcome! @@ -59,23 +59,23 @@ There are two packages in pdfme, generator and UI. The package for generating PDF can be installed with the following command. ``` -npm i @pdfme/generator +npm i @lisb/pdfme-generator ``` The packages for using PDF designer, forms and viewers can be installed with the following commands. ``` -npm i @pdfme/ui +npm i @lisb/pdfme-ui ``` The following type, function and classes are available in pdfme. -`@pdfme/generator` +`@lisb/pdfme-generator` - [generate](https://pdfme.com/docs/getting-started#generator) - [Template](https://pdfme.com/docs/getting-started#template) -`@pdfme/ui` +`@lisb/pdfme-ui` - [Designer](https://pdfme.com/docs/getting-started#designer) - [Form](https://pdfme.com/docs/getting-started#form) @@ -85,11 +85,11 @@ The following type, function and classes are available in pdfme. If your environment uses webpack, import the necessary items as shown below. ```ts -import { Template, generate } from '@pdfme/generator'; +import { Template, generate } from '@lisb/pdfme-generator'; ``` ```ts -import { Template, Designer, Form, Viewer } from '@pdfme/ui'; +import { Template, Designer, Form, Viewer } from '@lisb/pdfme-ui'; ``` **All objects use `Template`, which will be briefly explained in the next section.** @@ -97,7 +97,7 @@ import { Template, Designer, Form, Viewer } from '@pdfme/ui'; ## Template The core of pdfme library are Templates. -Template Type can be imported by both `@pdfme/generator` or `@pdfme/ui`. Templates are used everywhere. +Template Type can be imported by both `@lisb/pdfme-generator` or `@lisb/pdfme-ui`. Templates are used everywhere. A template can be divided into two parts: a fixed part and a variable part. We call them basePdf and schema. @@ -123,8 +123,8 @@ Let's take a look at some specific data. ### Minimal Template ```ts -import { Template, BLANK_PDF } from '@pdfme/generator'; -// import { Template, BLANK_PDF } from '@pdfme/ui'; <- Template types and BLANK_PDF can also be imported from @pdfme/ui. +import { Template, BLANK_PDF } from '@lisb/pdfme-generator'; +// import { Template, BLANK_PDF } from '@lisb/pdfme-ui'; <- Template types and BLANK_PDF can also be imported from @lisb/pdfme-ui. const template: Template = { basePdf: BLANK_PDF, @@ -164,7 +164,7 @@ The PDF generator function, `generate`, takes 2 arguments of `template` and `inp The code to generate a PDF file using the [template created above](https://pdfme.com/docs/getting-started#sample-template) is shown below. ```ts -import { Template, generate } from '@pdfme/generator'; +import { Template, generate } from '@lisb/pdfme-generator'; const template: Template = { // skip... Check the Template section. @@ -202,7 +202,7 @@ You can design your own template from [Template Design page](https://pdfme.com/t Let's integrate the designer using the template created above as the default template. ```ts -import { Template, Designer } from '@pdfme/ui'; +import { Template, Designer } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { @@ -235,7 +235,7 @@ You can use templates to create forms and PDF viewers. The Form creates a UI for the user to enter schemas based on the template. ```ts -import { Template, Form } from '@pdfme/ui'; +import { Template, Form } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { @@ -271,7 +271,7 @@ The Viewer is a byproduct of the Form development process, but it allows you to Using the Viewer is basically the same as using the Form, except that user cannot edit it. ```ts -import { Template, Viewer } from '@pdfme/ui'; +import { Template, Viewer } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { diff --git a/packages/generator/__tests__/assets/templates/index.ts b/packages/generator/__tests__/assets/templates/index.ts index 0d3a1066e..ee16c8b97 100644 --- a/packages/generator/__tests__/assets/templates/index.ts +++ b/packages/generator/__tests__/assets/templates/index.ts @@ -1,4 +1,4 @@ -import { Template, BLANK_PDF } from '@pdfme/common'; +import { Template, BLANK_PDF } from '@lisb/pdfme-common'; /* eslint global-require: off*/ /* eslint @typescript-eslint/no-var-requires: off*/ diff --git a/packages/generator/__tests__/generate.test.ts b/packages/generator/__tests__/generate.test.ts index 88cba8b02..9f74af39d 100644 --- a/packages/generator/__tests__/generate.test.ts +++ b/packages/generator/__tests__/generate.test.ts @@ -2,7 +2,7 @@ import { writeFileSync, readFileSync, readdir, unlink } from 'fs'; import * as path from 'path'; import generate from '../src/generate'; import templateData from './assets/templates'; -import { Template, Font, BLANK_PDF } from '@pdfme/common'; +import { Template, Font, BLANK_PDF } from '@lisb/pdfme-common'; // eslint-disable-next-line @typescript-eslint/no-var-requires const PDFParser = require('pdf2json'); diff --git a/packages/generator/package.json b/packages/generator/package.json index 77aa2180b..3f0294135 100644 --- a/packages/generator/package.json +++ b/packages/generator/package.json @@ -1,6 +1,6 @@ { - "name": "@pdfme/generator", - "version": "1.1.5", + "name": "@lisb/pdfme-generator", + "version": "1.1.6", "sideEffects": false, "author": "hand-dot", "license": "MIT", @@ -16,10 +16,10 @@ "homepage": "https://pdfme.com", "repository": { "type": "git", - "url": "git@github.com:pdfme/pdfme.git" + "url": "https://github.com/lisb/pdfme-generator.git" }, "bugs": { - "url": "https://github.com/pdfme/pdfme/issues" + "url": "https://github.com/lisb/pdfme/issues" }, "main": "dist/cjs/src/index.js", "module": "dist/esm/src/index.js", @@ -47,7 +47,7 @@ }, "dependencies": { "@pdf-lib/fontkit": "^1.1.1", - "@pdfme/common": "^1.0.0", + "@lisb/pdfme-common": "^1.0.0", "atob": "^2.1.2", "bwip-js": "^3.2.2", "pdf-lib": "^1.17.1" diff --git a/packages/generator/src/generate.ts b/packages/generator/src/generate.ts index fe4c67767..36f75d82d 100644 --- a/packages/generator/src/generate.ts +++ b/packages/generator/src/generate.ts @@ -1,7 +1,7 @@ import { PDFDocument } from 'pdf-lib'; import fontkit from '@pdf-lib/fontkit'; -import type { GenerateProps, Template, Font } from '@pdfme/common'; -import { getDefaultFont, getFallbackFontName, checkGenerateProps } from '@pdfme/common'; +import type { GenerateProps, Template, Font } from '@lisb/pdfme-common'; +import { getDefaultFont, getFallbackFontName, checkGenerateProps } from '@lisb/pdfme-common'; import { getEmbeddedPagesAndEmbedPdfBoxes, drawInputByTemplateSchema, diff --git a/packages/generator/src/helper.ts b/packages/generator/src/helper.ts index 7f93e36bf..eaf5741a6 100644 --- a/packages/generator/src/helper.ts +++ b/packages/generator/src/helper.ts @@ -30,7 +30,7 @@ import { DEFAULT_LINE_HEIGHT, DEFAULT_CHARACTER_SPACING, DEFAULT_FONT_COLOR, -} from '@pdfme/common'; +} from '@lisb/pdfme-common'; export interface InputImageCache { [key: string]: PDFImage | undefined; diff --git a/packages/generator/src/index.ts b/packages/generator/src/index.ts index 7e744e23b..338061f2c 100644 --- a/packages/generator/src/index.ts +++ b/packages/generator/src/index.ts @@ -23,7 +23,7 @@ export type { UIProps, PreviewProps, DesignerProps, -} from '@pdfme/common'; +} from '@lisb/pdfme-common'; export { BLANK_PDF, @@ -36,4 +36,4 @@ export { checkDesignerProps, checkGenerateProps, validateBarcodeInput, -} from '@pdfme/common'; +} from '@lisb/pdfme-common'; diff --git a/packages/ui/README.md b/packages/ui/README.md index ebc8a40e3..ba3c9682a 100644 --- a/packages/ui/README.md +++ b/packages/ui/README.md @@ -6,11 +6,11 @@ Unit Testing status - - Current npm package version. + + Current npm package version. - - Downloads per month on npm. + + Downloads per month on npm. PRs welcome! @@ -59,23 +59,23 @@ There are two packages in pdfme, generator and UI. The package for generating PDF can be installed with the following command. ``` -npm i @pdfme/generator +npm i @lisb/pdfme-generator ``` The packages for using PDF designer, forms and viewers can be installed with the following commands. ``` -npm i @pdfme/ui +npm i @lisb/pdfme-ui ``` The following type, function and classes are available in pdfme. -`@pdfme/generator` +`@lisb/pdfme-generator` - [generate](https://pdfme.com/docs/getting-started#generator) - [Template](https://pdfme.com/docs/getting-started#template) -`@pdfme/ui` +`@lisb/pdfme-ui` - [Designer](https://pdfme.com/docs/getting-started#designer) - [Form](https://pdfme.com/docs/getting-started#form) @@ -85,11 +85,11 @@ The following type, function and classes are available in pdfme. If your environment uses webpack, import the necessary items as shown below. ```ts -import { Template, generate } from '@pdfme/generator'; +import { Template, generate } from '@lisb/pdfme-generator'; ``` ```ts -import { Template, Designer, Form, Viewer } from '@pdfme/ui'; +import { Template, Designer, Form, Viewer } from '@lisb/pdfme-ui'; ``` **All objects use `Template`, which will be briefly explained in the next section.** @@ -97,7 +97,7 @@ import { Template, Designer, Form, Viewer } from '@pdfme/ui'; ## Template The core of pdfme library are Templates. -Template Type can be imported by both `@pdfme/generator` or `@pdfme/ui`. Templates are used everywhere. +Template Type can be imported by both `@lisb/pdfme-generator` or `@lisb/pdfme-ui`. Templates are used everywhere. A template can be divided into two parts: a fixed part and a variable part. We call them basePdf and schema. @@ -123,8 +123,8 @@ Let's take a look at some specific data. ### Minimal Template ```ts -import { Template, BLANK_PDF } from '@pdfme/generator'; -// import { Template, BLANK_PDF } from '@pdfme/ui'; <- Template types and BLANK_PDF can also be imported from @pdfme/ui. +import { Template, BLANK_PDF } from '@lisb/pdfme-generator'; +// import { Template, BLANK_PDF } from '@lisb/pdfme-ui'; <- Template types and BLANK_PDF can also be imported from @lisb/pdfme-ui. const template: Template = { basePdf: BLANK_PDF, @@ -164,7 +164,7 @@ The PDF generator function, `generate`, takes 2 arguments of `template` and `inp The code to generate a PDF file using the [template created above](https://pdfme.com/docs/getting-started#sample-template) is shown below. ```ts -import { Template, generate } from '@pdfme/generator'; +import { Template, generate } from '@lisb/pdfme-generator'; const template: Template = { // skip... Check the Template section. @@ -202,7 +202,7 @@ You can design your own template from [Template Design page](https://pdfme.com/t Let's integrate the designer using the template created above as the default template. ```ts -import { Template, Designer } from '@pdfme/ui'; +import { Template, Designer } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { @@ -235,7 +235,7 @@ You can use templates to create forms and PDF viewers. The Form creates a UI for the user to enter schemas based on the template. ```ts -import { Template, Form } from '@pdfme/ui'; +import { Template, Form } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { @@ -271,7 +271,7 @@ The Viewer is a byproduct of the Form development process, but it allows you to Using the Viewer is basically the same as using the Form, except that user cannot edit it. ```ts -import { Template, Viewer } from '@pdfme/ui'; +import { Template, Viewer } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { diff --git a/packages/ui/__tests__/assets/helper.ts b/packages/ui/__tests__/assets/helper.ts index 769c8e78f..2b00a754e 100644 --- a/packages/ui/__tests__/assets/helper.ts +++ b/packages/ui/__tests__/assets/helper.ts @@ -1,6 +1,6 @@ import * as hooks from '../../src/hooks'; import { uuid, getPdfPageSizes, pdf2Pngs } from '../../src/helper'; -import { BLANK_PDF, Template } from '@pdfme/common'; +import { BLANK_PDF, Template } from '@lisb/pdfme-common'; export const setupUIMock = () => { const backgrounds = ['data:image/png;base64,a...']; diff --git a/packages/ui/__tests__/components/Designer.test.tsx b/packages/ui/__tests__/components/Designer.test.tsx index e3059522d..3c66128a2 100644 --- a/packages/ui/__tests__/components/Designer.test.tsx +++ b/packages/ui/__tests__/components/Designer.test.tsx @@ -8,7 +8,7 @@ import Designer from '../../src/components/Designer/index'; import { I18nContext, FontContext } from '../../src/contexts'; import { curriedI18n } from '../../src/i18n'; import { SELECTABLE_CLASSNAME } from '../../src/constants'; -import { getDefaultFont } from '@pdfme/common'; +import { getDefaultFont } from '@lisb/pdfme-common'; import { setupUIMock, getSampleTemplate } from '../assets/helper'; test('Designer snapshot', async () => { diff --git a/packages/ui/__tests__/components/Preview.test.tsx b/packages/ui/__tests__/components/Preview.test.tsx index c7235ece5..6dfe70fe5 100644 --- a/packages/ui/__tests__/components/Preview.test.tsx +++ b/packages/ui/__tests__/components/Preview.test.tsx @@ -8,7 +8,7 @@ import Preview from '../../src/components/Preview'; import { I18nContext, FontContext } from '../../src/contexts'; import { curriedI18n } from '../../src/i18n'; import { SELECTABLE_CLASSNAME } from '../../src/constants'; -import { getDefaultFont } from '@pdfme/common'; +import { getDefaultFont } from '@lisb/pdfme-common'; import { setupUIMock, getSampleTemplate } from '../assets/helper'; test('Preview(as Viewer) snapshot', async () => { diff --git a/packages/ui/__tests__/components/__snapshots__/Designer.test.tsx.snap b/packages/ui/__tests__/components/__snapshots__/Designer.test.tsx.snap index 668b1a54b..a224ba960 100644 --- a/packages/ui/__tests__/components/__snapshots__/Designer.test.tsx.snap +++ b/packages/ui/__tests__/components/__snapshots__/Designer.test.tsx.snap @@ -220,7 +220,7 @@ exports[`Designer snapshot 1`] = ` style="transform: scale(1); transform-origin: center top; width: 1200px; height: 1200px;" >
@@ -216,7 +216,7 @@ exports[`Preview(as Viewer) snapshot 1`] = ` style="transform: scale(1); transform-origin: center top; width: 1200px; height: 1200px;" >
diff --git a/packages/ui/__tests__/helper.test.ts b/packages/ui/__tests__/helper.test.ts index 1d9095e3b..17f81fd73 100644 --- a/packages/ui/__tests__/helper.test.ts +++ b/packages/ui/__tests__/helper.test.ts @@ -1,4 +1,4 @@ -import { SchemaForUI, Schema } from '@pdfme/common'; +import { SchemaForUI, Schema } from '@lisb/pdfme-common'; import { uuid, getUniqSchemaKey } from '../src/helper'; describe('getUniqSchemaKey test', () => { diff --git a/packages/ui/package.json b/packages/ui/package.json index 03fa4d54b..5aeb93445 100644 --- a/packages/ui/package.json +++ b/packages/ui/package.json @@ -1,6 +1,6 @@ { - "name": "@pdfme/ui", - "version": "1.1.5", + "name": "@lisb/pdfme-ui", + "version": "1.1.6", "sideEffects": false, "author": "hand-dot", "license": "MIT", @@ -16,10 +16,10 @@ "homepage": "https://pdfme.com", "repository": { "type": "git", - "url": "git@github.com:pdfme/pdfme.git" + "url": "https://github.com/lisb/pdfme-ui.git" }, "bugs": { - "url": "https://github.com/pdfme/pdfme/issues" + "url": "https://github.com/lisb/pdfme/issues" }, "main": "dist/index.js", "module": "dist/index.js", @@ -41,7 +41,7 @@ "@dnd-kit/core": "^5.0.1", "@dnd-kit/sortable": "^6.0.0", "@heroicons/react": "^2.0.13", - "@pdfme/common": "^1.0.0", + "@lisb/pdfme-common": "^1.0.0", "@scena/react-guides": "^0.16.0", "hotkeys-js": "^3.8.7", "pdfjs-dist": "^2.12.313", diff --git a/packages/ui/src/Designer.tsx b/packages/ui/src/Designer.tsx index 96948d5a6..c8eb531a8 100644 --- a/packages/ui/src/Designer.tsx +++ b/packages/ui/src/Designer.tsx @@ -1,6 +1,6 @@ import React from 'react'; import ReactDOM from 'react-dom'; -import { Template, DesignerProps, checkDesignerProps, checkTemplate } from '@pdfme/common'; +import { Template, DesignerProps, checkDesignerProps, checkTemplate } from '@lisb/pdfme-common'; import { BaseUIClass } from './class'; import { DESTROYED_ERR_MSG } from './constants'; import { I18nContext, FontContext } from './contexts'; diff --git a/packages/ui/src/Form.tsx b/packages/ui/src/Form.tsx index 525285129..35fe1d2d3 100644 --- a/packages/ui/src/Form.tsx +++ b/packages/ui/src/Form.tsx @@ -1,6 +1,6 @@ import React from 'react'; import ReactDOM from 'react-dom'; -import { PreviewProps } from '@pdfme/common'; +import { PreviewProps } from '@lisb/pdfme-common'; import { PreviewUI } from './class'; import { DESTROYED_ERR_MSG } from './constants'; import { I18nContext, FontContext } from './contexts'; diff --git a/packages/ui/src/Viewer.tsx b/packages/ui/src/Viewer.tsx index 79a8f11b3..c2b20ac94 100644 --- a/packages/ui/src/Viewer.tsx +++ b/packages/ui/src/Viewer.tsx @@ -1,6 +1,6 @@ import React from 'react'; import ReactDOM from 'react-dom'; -import { PreviewProps } from '@pdfme/common'; +import { PreviewProps } from '@lisb/pdfme-common'; import { PreviewUI } from './class'; import { DESTROYED_ERR_MSG } from './constants'; import { I18nContext, FontContext } from './contexts'; diff --git a/packages/ui/src/class.ts b/packages/ui/src/class.ts index 91d849873..a79f483b8 100644 --- a/packages/ui/src/class.ts +++ b/packages/ui/src/class.ts @@ -16,7 +16,7 @@ import { checkInputs, checkUIOptions, checkPreviewProps, -} from '@pdfme/common'; +} from '@lisb/pdfme-common'; const generateColumnsAndSampledataIfNeeded = (template: Template) => { const { schemas, columns, sampledata } = template; diff --git a/packages/ui/src/components/CtlBar/index.tsx b/packages/ui/src/components/CtlBar/index.tsx index d0a0ac643..edefad24a 100644 --- a/packages/ui/src/components/CtlBar/index.tsx +++ b/packages/ui/src/components/CtlBar/index.tsx @@ -1,7 +1,7 @@ import React from 'react'; import Pager from './Pager'; import Zoom from './Zoom'; -import { Size } from '@pdfme/common'; +import { Size } from '@lisb/pdfme-common'; type Props = { size: Size; diff --git a/packages/ui/src/components/Designer/Main/Guides.tsx b/packages/ui/src/components/Designer/Main/Guides.tsx index 3f3b7f9d1..31c87bb32 100644 --- a/packages/ui/src/components/Designer/Main/Guides.tsx +++ b/packages/ui/src/components/Designer/Main/Guides.tsx @@ -1,6 +1,6 @@ import React, { Ref } from 'react'; import Guides from '@scena/react-guides'; -import { Size } from '@pdfme/common'; +import { Size } from '@lisb/pdfme-common'; import { ZOOM, RULER_HEIGHT } from '../../../constants'; const _Guides = ({ diff --git a/packages/ui/src/components/Designer/Main/Mask.tsx b/packages/ui/src/components/Designer/Main/Mask.tsx index 2d4916e6d..b11f3d1f0 100644 --- a/packages/ui/src/components/Designer/Main/Mask.tsx +++ b/packages/ui/src/components/Designer/Main/Mask.tsx @@ -1,5 +1,5 @@ import React from 'react'; -import { Size } from '@pdfme/common'; +import { Size } from '@lisb/pdfme-common'; import { RULER_HEIGHT } from '../../../constants'; const Mask = ({ width, height }: Size) => ( diff --git a/packages/ui/src/components/Designer/Main/index.tsx b/packages/ui/src/components/Designer/Main/index.tsx index 4bc050128..8a4d45f6d 100644 --- a/packages/ui/src/components/Designer/Main/index.tsx +++ b/packages/ui/src/components/Designer/Main/index.tsx @@ -8,7 +8,7 @@ import React, { useCallback, } from 'react'; import { OnDrag, OnResize, OnClick } from 'react-moveable'; -import { SchemaForUI, Size } from '@pdfme/common'; +import { SchemaForUI, Size } from '@lisb/pdfme-common'; import { ZOOM, RULER_HEIGHT } from '../../../constants'; import { usePrevious } from '../../../hooks'; import { uuid, round, flatten } from '../../../helper'; diff --git a/packages/ui/src/components/Designer/Sidebar/DetailView/ExampleInputEditor.tsx b/packages/ui/src/components/Designer/Sidebar/DetailView/ExampleInputEditor.tsx index e759a1efa..b123fbfab 100644 --- a/packages/ui/src/components/Designer/Sidebar/DetailView/ExampleInputEditor.tsx +++ b/packages/ui/src/components/Designer/Sidebar/DetailView/ExampleInputEditor.tsx @@ -1,5 +1,5 @@ import React, { useContext } from 'react'; -import { SchemaForUI } from '@pdfme/common'; +import { SchemaForUI } from '@lisb/pdfme-common'; import { readFiles } from '../../../../helper'; import { I18nContext } from '../../../../contexts'; import { SidebarProps } from '..'; diff --git a/packages/ui/src/components/Designer/Sidebar/DetailView/PositionAndSizeEditor.tsx b/packages/ui/src/components/Designer/Sidebar/DetailView/PositionAndSizeEditor.tsx index 65ccd2821..2319f8863 100644 --- a/packages/ui/src/components/Designer/Sidebar/DetailView/PositionAndSizeEditor.tsx +++ b/packages/ui/src/components/Designer/Sidebar/DetailView/PositionAndSizeEditor.tsx @@ -1,5 +1,5 @@ import React, { CSSProperties } from 'react'; -import { SchemaForUI } from '@pdfme/common'; +import { SchemaForUI } from '@lisb/pdfme-common'; import { round } from '../../../../helper'; import { SidebarProps } from '../index'; diff --git a/packages/ui/src/components/Designer/Sidebar/DetailView/TextPropEditor.tsx b/packages/ui/src/components/Designer/Sidebar/DetailView/TextPropEditor.tsx index 12435aae9..bfca67b26 100644 --- a/packages/ui/src/components/Designer/Sidebar/DetailView/TextPropEditor.tsx +++ b/packages/ui/src/components/Designer/Sidebar/DetailView/TextPropEditor.tsx @@ -6,7 +6,7 @@ import { DEFAULT_LINE_HEIGHT, DEFAULT_CHARACTER_SPACING, DEFAULT_FONT_COLOR, -} from '@pdfme/common'; +} from '@lisb/pdfme-common'; import { FontContext } from '../../../../contexts'; import { SidebarProps } from '..'; import { XMarkIcon } from '@heroicons/react/24/outline'; diff --git a/packages/ui/src/components/Designer/Sidebar/DetailView/TypeAndKeyEditor.tsx b/packages/ui/src/components/Designer/Sidebar/DetailView/TypeAndKeyEditor.tsx index ccbfe17ee..8376d1ed8 100644 --- a/packages/ui/src/components/Designer/Sidebar/DetailView/TypeAndKeyEditor.tsx +++ b/packages/ui/src/components/Designer/Sidebar/DetailView/TypeAndKeyEditor.tsx @@ -1,5 +1,5 @@ import React, { useContext, useRef, useCallback } from 'react'; -import { schemaTypes, SchemaForUI } from '@pdfme/common'; +import { schemaTypes, SchemaForUI } from '@lisb/pdfme-common'; import { SidebarProps } from '../index'; import { I18nContext } from '../../../../contexts'; diff --git a/packages/ui/src/components/Designer/Sidebar/DetailView/index.tsx b/packages/ui/src/components/Designer/Sidebar/DetailView/index.tsx index e361a9bff..b66e37887 100644 --- a/packages/ui/src/components/Designer/Sidebar/DetailView/index.tsx +++ b/packages/ui/src/components/Designer/Sidebar/DetailView/index.tsx @@ -1,5 +1,5 @@ import React, { useContext } from 'react'; -import { SchemaForUI } from '@pdfme/common'; +import { SchemaForUI } from '@lisb/pdfme-common'; import { I18nContext } from '../../../../contexts'; import Divider from '../../../Divider'; import { SidebarProps } from '../index'; diff --git a/packages/ui/src/components/Designer/Sidebar/ListView/SelectableSortableContainer.tsx b/packages/ui/src/components/Designer/Sidebar/ListView/SelectableSortableContainer.tsx index 011ff24ab..d0ea4ed82 100644 --- a/packages/ui/src/components/Designer/Sidebar/ListView/SelectableSortableContainer.tsx +++ b/packages/ui/src/components/Designer/Sidebar/ListView/SelectableSortableContainer.tsx @@ -15,7 +15,7 @@ import { sortableKeyboardCoordinates, verticalListSortingStrategy, } from '@dnd-kit/sortable'; -import { SchemaForUI } from '@pdfme/common'; +import { SchemaForUI } from '@lisb/pdfme-common'; import Item from './Item'; import SelectableSortableItem from './SelectableSortableItem'; import { SidebarProps } from '../index'; diff --git a/packages/ui/src/components/Designer/Sidebar/ListView/SelectableSortableItem.tsx b/packages/ui/src/components/Designer/Sidebar/ListView/SelectableSortableItem.tsx index ec70acc31..3bf4ecbd0 100644 --- a/packages/ui/src/components/Designer/Sidebar/ListView/SelectableSortableItem.tsx +++ b/packages/ui/src/components/Designer/Sidebar/ListView/SelectableSortableItem.tsx @@ -1,6 +1,6 @@ import React, { useContext } from 'react'; import { useSortable } from '@dnd-kit/sortable'; -import { SchemaForUI } from '@pdfme/common'; +import { SchemaForUI } from '@lisb/pdfme-common'; import { I18nContext } from '../../../../contexts'; import Item from './Item'; import { useMountStatus } from '../../../../hooks'; diff --git a/packages/ui/src/components/Designer/Sidebar/index.tsx b/packages/ui/src/components/Designer/Sidebar/index.tsx index 13c01dd2a..ac6287367 100644 --- a/packages/ui/src/components/Designer/Sidebar/index.tsx +++ b/packages/ui/src/components/Designer/Sidebar/index.tsx @@ -1,5 +1,5 @@ import React, { useState, useContext } from 'react'; -import { SchemaForUI, Size } from '@pdfme/common'; +import { SchemaForUI, Size } from '@lisb/pdfme-common'; import { RULER_HEIGHT, SIDEBAR_WIDTH } from '../../../constants'; import { I18nContext } from '../../../contexts'; import { ArrowLeftIcon, ArrowRightIcon } from '@heroicons/react/24/outline'; diff --git a/packages/ui/src/components/Designer/index.tsx b/packages/ui/src/components/Designer/index.tsx index e55c28ff7..1d554e623 100644 --- a/packages/ui/src/components/Designer/index.tsx +++ b/packages/ui/src/components/Designer/index.tsx @@ -1,5 +1,5 @@ import React, { useRef, useState, useEffect, useContext, useCallback } from 'react'; -import { DesignerReactProps, Template, SchemaForUI } from '@pdfme/common'; +import { DesignerReactProps, Template, SchemaForUI } from '@lisb/pdfme-common'; import Sidebar from './Sidebar/index'; import Main from './Main/index'; import { ZOOM, RULER_HEIGHT } from '../../constants'; diff --git a/packages/ui/src/components/Error.tsx b/packages/ui/src/components/Error.tsx index 02ee132b2..fd6316349 100644 --- a/packages/ui/src/components/Error.tsx +++ b/packages/ui/src/components/Error.tsx @@ -1,5 +1,5 @@ import React, { useContext } from 'react'; -import { Size } from '@pdfme/common'; +import { Size } from '@lisb/pdfme-common'; import { I18nContext } from '../contexts'; const Error = ({ size, error }: { size: Size; error: Error }) => { diff --git a/packages/ui/src/components/Paper.tsx b/packages/ui/src/components/Paper.tsx index 02a5e942d..e752c2c76 100644 --- a/packages/ui/src/components/Paper.tsx +++ b/packages/ui/src/components/Paper.tsx @@ -1,5 +1,5 @@ import React, { MutableRefObject, ReactNode, useContext } from 'react'; -import { SchemaForUI, Size, getFallbackFontName } from '@pdfme/common'; +import { SchemaForUI, Size, getFallbackFontName } from '@lisb/pdfme-common'; import { FontContext } from '../contexts'; import { ZOOM, RULER_HEIGHT } from '../constants'; @@ -35,7 +35,7 @@ const Paper = (porps: { return (
{ if (e) { diff --git a/packages/ui/src/components/Preview.tsx b/packages/ui/src/components/Preview.tsx index 0fb4826ea..df3a1f450 100644 --- a/packages/ui/src/components/Preview.tsx +++ b/packages/ui/src/components/Preview.tsx @@ -1,5 +1,5 @@ import React, { useCallback, useRef, useState, useEffect } from 'react'; -import { PreviewReactProps, SchemaForUI } from '@pdfme/common'; +import { PreviewReactProps, SchemaForUI } from '@lisb/pdfme-common'; import { ZOOM, RULER_HEIGHT } from '../constants'; import UnitPager from './UnitPager'; import Root from './Root'; diff --git a/packages/ui/src/components/Root.tsx b/packages/ui/src/components/Root.tsx index 1a204d3e1..8f9f1bd5c 100644 --- a/packages/ui/src/components/Root.tsx +++ b/packages/ui/src/components/Root.tsx @@ -1,5 +1,5 @@ import React, { useContext, forwardRef, ReactNode, Ref, useEffect } from 'react'; -import { Size } from '@pdfme/common'; +import { Size } from '@lisb/pdfme-common'; import { FontContext } from '../contexts'; import Spinner from './Spinner'; diff --git a/packages/ui/src/components/Schemas/BarcodeSchema.tsx b/packages/ui/src/components/Schemas/BarcodeSchema.tsx index 0827b300a..3e33ded11 100644 --- a/packages/ui/src/components/Schemas/BarcodeSchema.tsx +++ b/packages/ui/src/components/Schemas/BarcodeSchema.tsx @@ -1,5 +1,5 @@ import React, { forwardRef, Ref } from 'react'; -import { validateBarcodeInput, BarCodeType, BarcodeSchema } from '@pdfme/common'; +import { validateBarcodeInput, BarCodeType, BarcodeSchema } from '@lisb/pdfme-common'; import { ZOOM } from '../../constants'; import { SchemaUIProps } from './SchemaUI'; diff --git a/packages/ui/src/components/Schemas/ImageSchema.tsx b/packages/ui/src/components/Schemas/ImageSchema.tsx index 160c5575f..84dd7ee2f 100644 --- a/packages/ui/src/components/Schemas/ImageSchema.tsx +++ b/packages/ui/src/components/Schemas/ImageSchema.tsx @@ -1,5 +1,5 @@ import React, { useState, forwardRef, ChangeEvent, Ref } from 'react'; -import { ImageSchema } from '@pdfme/common'; +import { ImageSchema } from '@lisb/pdfme-common'; import { SchemaUIProps } from './SchemaUI'; import { readFiles } from '../../helper'; import { ZOOM } from '../../constants'; diff --git a/packages/ui/src/components/Schemas/SchemaUI.tsx b/packages/ui/src/components/Schemas/SchemaUI.tsx index 9c7bfd2e5..8dd236bc8 100644 --- a/packages/ui/src/components/Schemas/SchemaUI.tsx +++ b/packages/ui/src/components/Schemas/SchemaUI.tsx @@ -1,5 +1,5 @@ import React, { forwardRef, RefObject, Ref, ReactNode } from 'react'; -import { SchemaForUI, isTextSchema, isImageSchema, isBarcodeSchema } from '@pdfme/common'; +import { SchemaForUI, isTextSchema, isImageSchema, isBarcodeSchema } from '@lisb/pdfme-common'; import { ZOOM, SELECTABLE_CLASSNAME } from '../../constants'; import TextSchema from './TextSchema'; import ImageSchema from './ImageSchema'; diff --git a/packages/ui/src/components/Schemas/TextSchema.tsx b/packages/ui/src/components/Schemas/TextSchema.tsx index bea5ee91c..ef57d58a4 100644 --- a/packages/ui/src/components/Schemas/TextSchema.tsx +++ b/packages/ui/src/components/Schemas/TextSchema.tsx @@ -6,7 +6,7 @@ import { DEFAULT_CHARACTER_SPACING, DEFAULT_FONT_COLOR, TextSchema, -} from '@pdfme/common'; +} from '@lisb/pdfme-common'; import { SchemaUIProps } from './SchemaUI'; import { ZOOM } from '../../constants'; @@ -34,7 +34,7 @@ const TextSchemaUI = ( color: schema.fontColor ? schema.fontColor : DEFAULT_FONT_COLOR, backgroundColor: schema.data && schema.backgroundColor ? schema.backgroundColor : 'rgb(242 244 255 / 75%)', - overflowY: "hidden", + overflowY: "hidden", }; return editable ? ( diff --git a/packages/ui/src/components/UnitPager.tsx b/packages/ui/src/components/UnitPager.tsx index ce99d555e..bd2b4ec38 100644 --- a/packages/ui/src/components/UnitPager.tsx +++ b/packages/ui/src/components/UnitPager.tsx @@ -5,7 +5,7 @@ import { ChevronRightIcon, ChevronDoubleRightIcon, } from '@heroicons/react/24/outline'; -import { Size } from '@pdfme/common'; +import { Size } from '@lisb/pdfme-common'; const buttonHeight = 38; const buttonWrapStyle: React.CSSProperties = { diff --git a/packages/ui/src/contexts.ts b/packages/ui/src/contexts.ts index 9f991e4e4..9b9a76556 100644 --- a/packages/ui/src/contexts.ts +++ b/packages/ui/src/contexts.ts @@ -1,7 +1,7 @@ import { createContext } from 'react'; import { curriedI18n } from './i18n'; import { DEFAULT_LANG } from './constants'; -import { getDefaultFont } from '@pdfme/common'; +import { getDefaultFont } from '@lisb/pdfme-common'; export const I18nContext = createContext(curriedI18n(DEFAULT_LANG)); diff --git a/packages/ui/src/helper.ts b/packages/ui/src/helper.ts index c9df803b7..02348b497 100644 --- a/packages/ui/src/helper.ts +++ b/packages/ui/src/helper.ts @@ -17,7 +17,7 @@ import { DEFAULT_FONT_SIZE, DEFAULT_CHARACTER_SPACING, DEFAULT_LINE_HEIGHT, -} from '@pdfme/common'; +} from '@lisb/pdfme-common'; import { ZOOM, RULER_HEIGHT } from './constants'; export const uuid = () => diff --git a/packages/ui/src/hooks.ts b/packages/ui/src/hooks.ts index ffb288baa..5f63e8c03 100644 --- a/packages/ui/src/hooks.ts +++ b/packages/ui/src/hooks.ts @@ -1,5 +1,5 @@ import { RefObject, useRef, useState, useCallback, useEffect } from 'react'; -import { Template, Size, getB64BasePdf } from '@pdfme/common'; +import { Template, Size, getB64BasePdf } from '@lisb/pdfme-common'; import { pdf2Pngs, getPdfPageSizes, b64toBlob } from './helper'; import { ZOOM, RULER_HEIGHT } from './constants'; diff --git a/packages/ui/src/i18n.ts b/packages/ui/src/i18n.ts index dcbad82bc..3fa5a9f9a 100644 --- a/packages/ui/src/i18n.ts +++ b/packages/ui/src/i18n.ts @@ -1,4 +1,4 @@ -import { Lang } from '@pdfme/common'; +import { Lang } from '@lisb/pdfme-common'; import { DEFAULT_LANG } from './constants'; type DictEn = typeof dictEn; diff --git a/packages/ui/src/index.ts b/packages/ui/src/index.ts index 099110909..409b184e6 100644 --- a/packages/ui/src/index.ts +++ b/packages/ui/src/index.ts @@ -25,7 +25,7 @@ export type { UIProps, PreviewProps, DesignerProps, -} from '@pdfme/common'; +} from '@lisb/pdfme-common'; export { BLANK_PDF, @@ -38,4 +38,4 @@ export { checkDesignerProps, checkGenerateProps, validateBarcodeInput, -} from '@pdfme/common'; +} from '@lisb/pdfme-common'; diff --git a/website/docs/api/common/index.md b/website/docs/api/common/index.md index 293aa5c94..5987efb25 100644 --- a/website/docs/api/common/index.md +++ b/website/docs/api/common/index.md @@ -1,6 +1,6 @@ --- id: "index" -title: "@pdfme/common" +title: "@lisb/pdfme-common" slug: "/api/common/" sidebar_label: "Exports" sidebar_position: 0.5 diff --git a/website/docs/api/generator/index.md b/website/docs/api/generator/index.md index 4c434cac8..55c76d972 100644 --- a/website/docs/api/generator/index.md +++ b/website/docs/api/generator/index.md @@ -1,6 +1,6 @@ --- id: "index" -title: "@pdfme/generator" +title: "@lisb/pdfme-generator" slug: "/api/generator/" sidebar_label: "Exports" sidebar_position: 0.5 diff --git a/website/docs/api/ui/index.md b/website/docs/api/ui/index.md index c416088c6..095fe9c03 100644 --- a/website/docs/api/ui/index.md +++ b/website/docs/api/ui/index.md @@ -1,6 +1,6 @@ --- id: "index" -title: "@pdfme/ui" +title: "@lisb/pdfme-ui" slug: "/api/ui/" sidebar_label: "Exports" sidebar_position: 0.5 diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index 4a2cb8923..e784d729c 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -18,23 +18,23 @@ There are two packages in pdfme, generator and UI. The package for generating PDF can be installed with the following command. ``` -npm i @pdfme/generator +npm i @lisb/pdfme-generator ``` The packages for using PDF designer, forms and viewers can be installed with the following commands. ``` -npm i @pdfme/ui +npm i @lisb/pdfme-ui ``` The following type, function and classes are available in pdfme. -`@pdfme/generator` +`@lisb/pdfme-generator` - [generate](/docs/getting-started#generator) - [Template](/docs/getting-started#template) -`@pdfme/ui` +`@lisb/pdfme-ui` - [Designer](/docs/getting-started#designer) - [Form](/docs/getting-started#form) @@ -44,11 +44,11 @@ The following type, function and classes are available in pdfme. If your environment uses webpack, import the necessary items as shown below. ```ts -import { Template, generate } from '@pdfme/generator'; +import { Template, generate } from '@lisb/pdfme-generator'; ``` ```ts -import { Template, Designer, Form, Viewer } from '@pdfme/ui'; +import { Template, Designer, Form, Viewer } from '@lisb/pdfme-ui'; ``` **All objects use `Template`, which will be briefly explained in the next section.** @@ -56,7 +56,7 @@ import { Template, Designer, Form, Viewer } from '@pdfme/ui'; ## Template The core of pdfme library are Templates. -Template Type can be imported by both `@pdfme/generator` or `@pdfme/ui`. Templates are used everywhere. +Template Type can be imported by both `@lisb/pdfme-generator` or `@lisb/pdfme-ui`. Templates are used everywhere. A template can be divided into two parts: a fixed part and a variable part. We call them basePdf and schema. @@ -82,8 +82,8 @@ Let's take a look at some specific data. ### Minimal Template ```ts -import { Template, BLANK_PDF } from '@pdfme/generator'; -// import { Template, BLANK_PDF } from '@pdfme/ui'; <- Template types and BLANK_PDF can also be imported from @pdfme/ui. +import { Template, BLANK_PDF } from '@lisb/pdfme-generator'; +// import { Template, BLANK_PDF } from '@lisb/pdfme-ui'; <- Template types and BLANK_PDF can also be imported from @lisb/pdfme-ui. const template: Template = { basePdf: BLANK_PDF, @@ -123,7 +123,7 @@ The PDF generator function, `generate`, takes 2 arguments of `template` and `inp The code to generate a PDF file using the [template created above](/docs/getting-started#sample-template) is shown below. ```ts -import { Template, generate } from '@pdfme/generator'; +import { Template, generate } from '@lisb/pdfme-generator'; const template: Template = { // skip... Check the Template section. @@ -161,7 +161,7 @@ You can design your own template from [Template Design page](/template-design), Let's integrate the designer using the template created above as the default template. ```ts -import { Template, Designer } from '@pdfme/ui'; +import { Template, Designer } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { @@ -194,7 +194,7 @@ You can use templates to create forms and PDF viewers. The Form creates a UI for the user to enter schemas based on the template. ```ts -import { Template, Form } from '@pdfme/ui'; +import { Template, Form } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { @@ -230,7 +230,7 @@ The Viewer is a byproduct of the Form development process, but it allows you to Using the Viewer is basically the same as using the Form, except that user cannot edit it. ```ts -import { Template, Viewer } from '@pdfme/ui'; +import { Template, Viewer } from '@lisb/pdfme-ui'; const domContainer = document.getElementById('container'); const template: Template = { diff --git a/website/docs/guides/custom-font.md b/website/docs/guides/custom-font.md index 7a821e2df..98e0839de 100644 --- a/website/docs/guides/custom-font.md +++ b/website/docs/guides/custom-font.md @@ -38,7 +38,7 @@ Let's check out how to set font in the generator and ui packages. Set font as option in [generate](/docs/getting-started#generator) function ```ts -import { Template, BLANK_PDF, generate } from '@pdfme/generator'; +import { Template, BLANK_PDF, generate } from '@lisb/pdfme-generator'; const font = { serif: { @@ -98,7 +98,7 @@ The sample code is for [Designer](/docs/getting-started#designer), but the same #### Setting font at instance initialization ```ts -import { Designer } from "@pdfme/ui"; +import { Designer } from "@lisb/pdfme-ui"; const domContainer = document.getElementById('container'); const template = { diff --git a/website/package-lock.json b/website/package-lock.json index bda94dd96..a952a405f 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -1,11 +1,11 @@ { - "name": "@pdfme/website", + "name": "@lisb/pdfme-website", "version": "0.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "@pdfme/website", + "name": "@lisb/pdfme-website", "version": "0.0.0", "dependencies": { "@docusaurus/core": "^2.1.0", @@ -17,8 +17,8 @@ "@mdx-js/react": "^1.6.21", "@mui/icons-material": "^5.3.0", "@mui/material": "^5.3.0", - "@pdfme/generator": "^1.0.17", - "@pdfme/ui": "^1.0.17", + "@lisb/pdfme-generator": "^1.0.17", + "@lisb/pdfme-ui": "^1.0.17", "clsx": "^1.1.1", "handsontable": "^12.0.1", "prism-react-renderer": "^1.2.1", @@ -3537,9 +3537,9 @@ "pako": "^1.0.10" } }, - "node_modules/@pdfme/common": { + "node_modules/@lisb/pdfme-common": { "version": "1.0.17", - "resolved": "https://registry.npmjs.org/@pdfme/common/-/common-1.0.17.tgz", + "resolved": "https://registry.npmjs.org/@lisb/pdfme-common/-/common-1.0.17.tgz", "integrity": "sha512-GOwdpjVtncas0xhTiqlQarEAQcgZ8YAufCtm+rDopsoK06X/8NvZWAaWE2nAyjwHMnvrCAuXlWt4OyxTUyrksw==", "dependencies": { "zod": "^3.11.6" @@ -3548,13 +3548,13 @@ "node": ">=14" } }, - "node_modules/@pdfme/generator": { + "node_modules/@lisb/pdfme-generator": { "version": "1.0.17", - "resolved": "https://registry.npmjs.org/@pdfme/generator/-/generator-1.0.17.tgz", + "resolved": "https://registry.npmjs.org/@lisb/pdfme-generator/-/generator-1.0.17.tgz", "integrity": "sha512-c1dZzHf2tZ4QlbCsSgopSxK6x5zLnNJqxhgrmQ0nTANVTx9hdhMcYLNICnZqSmPYk2JlZzwsZoU++gzeqWDW/A==", "dependencies": { "@pdf-lib/fontkit": "^1.1.1", - "@pdfme/common": "^1.0.0", + "@lisb/pdfme-common": "^1.0.0", "atob": "^2.1.2", "bwip-js": "^2.1.3", "pdf-lib": "^1.17.1" @@ -3563,14 +3563,14 @@ "node": ">=14" } }, - "node_modules/@pdfme/ui": { + "node_modules/@lisb/pdfme-ui": { "version": "1.0.17", - "resolved": "https://registry.npmjs.org/@pdfme/ui/-/ui-1.0.17.tgz", + "resolved": "https://registry.npmjs.org/@lisb/pdfme-ui/-/ui-1.0.17.tgz", "integrity": "sha512-dvJAqSXaycceNr5YSqSmMqVvzOnU5qFVCshvi0ZQCK69eivK0xUr7o6A6fAzWn+h0ttA1k+S8MGcFDIAwdtsDw==", "dependencies": { "@dnd-kit/core": "^5.0.1", "@dnd-kit/sortable": "^6.0.0", - "@pdfme/common": "^1.0.0", + "@lisb/pdfme-common": "^1.0.0", "@scena/react-guides": "^0.16.0", "hotkeys-js": "^3.8.7", "pdfjs-dist": "^2.12.313", @@ -16767,34 +16767,34 @@ "pako": "^1.0.10" } }, - "@pdfme/common": { + "@lisb/pdfme-common": { "version": "1.0.17", - "resolved": "https://registry.npmjs.org/@pdfme/common/-/common-1.0.17.tgz", + "resolved": "https://registry.npmjs.org/@lisb/pdfme-common/-/common-1.0.17.tgz", "integrity": "sha512-GOwdpjVtncas0xhTiqlQarEAQcgZ8YAufCtm+rDopsoK06X/8NvZWAaWE2nAyjwHMnvrCAuXlWt4OyxTUyrksw==", "requires": { "zod": "^3.11.6" } }, - "@pdfme/generator": { + "@lisb/pdfme-generator": { "version": "1.0.17", - "resolved": "https://registry.npmjs.org/@pdfme/generator/-/generator-1.0.17.tgz", + "resolved": "https://registry.npmjs.org/@lisb/pdfme-generator/-/generator-1.0.17.tgz", "integrity": "sha512-c1dZzHf2tZ4QlbCsSgopSxK6x5zLnNJqxhgrmQ0nTANVTx9hdhMcYLNICnZqSmPYk2JlZzwsZoU++gzeqWDW/A==", "requires": { "@pdf-lib/fontkit": "^1.1.1", - "@pdfme/common": "^1.0.0", + "@lisb/pdfme-common": "^1.0.0", "atob": "^2.1.2", "bwip-js": "^2.1.3", "pdf-lib": "^1.17.1" } }, - "@pdfme/ui": { + "@lisb/pdfme-ui": { "version": "1.0.17", - "resolved": "https://registry.npmjs.org/@pdfme/ui/-/ui-1.0.17.tgz", + "resolved": "https://registry.npmjs.org/@lisb/pdfme-ui/-/ui-1.0.17.tgz", "integrity": "sha512-dvJAqSXaycceNr5YSqSmMqVvzOnU5qFVCshvi0ZQCK69eivK0xUr7o6A6fAzWn+h0ttA1k+S8MGcFDIAwdtsDw==", "requires": { "@dnd-kit/core": "^5.0.1", "@dnd-kit/sortable": "^6.0.0", - "@pdfme/common": "^1.0.0", + "@lisb/pdfme-common": "^1.0.0", "@scena/react-guides": "^0.16.0", "hotkeys-js": "^3.8.7", "pdfjs-dist": "^2.12.313", diff --git a/website/package.json b/website/package.json index 247f731e8..0b7e259ad 100644 --- a/website/package.json +++ b/website/package.json @@ -1,5 +1,5 @@ { - "name": "@pdfme/website", + "name": "@lisb/pdfme-website", "version": "0.0.0", "private": true, "scripts": { @@ -24,8 +24,8 @@ "@mdx-js/react": "^1.6.21", "@mui/icons-material": "^5.3.0", "@mui/material": "^5.3.0", - "@pdfme/generator": "^1.0.17", - "@pdfme/ui": "^1.0.17", + "@lisb/pdfme-generator": "^1.0.17", + "@lisb/pdfme-ui": "^1.0.17", "clsx": "^1.1.1", "handsontable": "^12.0.1", "prism-react-renderer": "^1.2.1", diff --git a/website/sidebars.js b/website/sidebars.js index eba4570f4..c62c0c103 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -36,19 +36,19 @@ const sidebars = { items: [ { type: 'category', - label: '@pdfme/common', + label: '@lisb/pdfme-common', link: { type: 'doc', id: 'api/common/index' }, items: ['api/common/index'], }, { type: 'category', - label: '@pdfme/generator', + label: '@lisb/pdfme-generator', link: { type: 'doc', id: 'api/generator/index' }, items: ['api/generator/index'], }, { type: 'category', - label: '@pdfme/ui', + label: '@lisb/pdfme-ui', link: { type: 'doc', id: 'api/ui/index' }, items: [ 'api/ui/index', diff --git a/website/src/components/DemoApp.tsx b/website/src/components/DemoApp.tsx index 6224610c3..f1727b92a 100644 --- a/website/src/components/DemoApp.tsx +++ b/website/src/components/DemoApp.tsx @@ -1,5 +1,5 @@ import React, { useEffect, useRef, useState } from 'react'; -import { generate, Template, BLANK_PDF, checkTemplate } from '@pdfme/generator'; +import { generate, Template, BLANK_PDF, checkTemplate } from '@lisb/pdfme-generator'; import Link from '@docusaurus/Link'; import Layout from '@theme/Layout'; import Head from '@docusaurus/Head'; diff --git a/website/src/components/DemoAppGrid.tsx b/website/src/components/DemoAppGrid.tsx index f211c0b29..890a11ccf 100644 --- a/website/src/components/DemoAppGrid.tsx +++ b/website/src/components/DemoAppGrid.tsx @@ -1,5 +1,5 @@ import React, { useEffect, useRef, useState } from 'react'; -import { generate, Template, BLANK_PDF, checkTemplate } from '@pdfme/generator'; +import { generate, Template, BLANK_PDF, checkTemplate } from '@lisb/pdfme-generator'; import Link from '@docusaurus/Link'; import Layout from '@theme/Layout'; import Head from '@docusaurus/Head'; diff --git a/website/src/hooks.ts b/website/src/hooks.ts index 6a5588199..1bbe58f53 100644 --- a/website/src/hooks.ts +++ b/website/src/hooks.ts @@ -1,5 +1,5 @@ import { useEffect, useRef } from 'react'; -import { Form, Viewer, Template } from '@pdfme/ui'; +import { Form, Viewer, Template } from '@lisb/pdfme-ui'; import { getFont, cloneDeep } from './libs/helper'; export const useForm = (props: { diff --git a/website/src/libs/helper.ts b/website/src/libs/helper.ts index 10dcb8100..da09710b8 100644 --- a/website/src/libs/helper.ts +++ b/website/src/libs/helper.ts @@ -1,4 +1,4 @@ -import { Template, Font, checkTemplate } from '@pdfme/generator'; +import { Template, Font, checkTemplate } from '@lisb/pdfme-generator'; import { examplePdfb64, dogPngb64 } from './sampleData'; export const getSampleTemplate = (): Template => ({ @@ -147,7 +147,7 @@ const templateFmt4SampleCode = (template: Template) => ); export const getGeneratorSampleCode = (template: Template) => - `import { generate } from "@pdfme/generator"; + `import { generate } from "@lisb/pdfme-generator"; (async () => { const template = ${templateFmt4SampleCode(template)}; @@ -164,7 +164,7 @@ export const getGeneratorSampleCode = (template: Template) => })();`.trim(); export const getDesignerSampleCode = (template: Template) => - `import { Designer } from "@pdfme/ui"; + `import { Designer } from "@lisb/pdfme-ui"; const domContainer = document.getElementById('container'); const template = ${templateFmt4SampleCode(template)}; @@ -172,7 +172,7 @@ const template = ${templateFmt4SampleCode(template)}; const designer = new Designer({ domContainer, template });`.trim(); export const getFormSampleCode = (template: Template) => - `import { Form } from "@pdfme/ui"; + `import { Form } from "@lisb/pdfme-ui"; const domContainer = document.getElementById('container'); const template = ${templateFmt4SampleCode(template)}; @@ -181,7 +181,7 @@ const inputs = ${JSON.stringify(cloneDeep(template.sampledata), null, 2)}; const form = new Form({ domContainer, template, inputs });`.trim(); export const getViewerSampleCode = (template: Template) => - `import { Viewer } from "@pdfme/ui"; + `import { Viewer } from "@lisb/pdfme-ui"; const domContainer = document.getElementById('container'); const template = ${templateFmt4SampleCode(template)}; diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index 3df67e111..5034435e1 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -7,8 +7,8 @@ import HomepageHeader from '../components/HomepageHeader'; import Divider from '../components/Divider'; import Code from '../components/Code'; import GithubStar from '../components/GithubStar'; -import { generate, Template } from '@pdfme/generator'; -import { Designer, Viewer, Form } from '@pdfme/ui'; +import { generate, Template } from '@lisb/pdfme-generator'; +import { Designer, Viewer, Form } from '@lisb/pdfme-ui'; import { getSampleTemplate, cloneDeep, getGeneratorSampleCode } from '../libs/helper'; export default function Home(): JSX.Element { diff --git a/website/src/pages/template-design.tsx b/website/src/pages/template-design.tsx index bac4c858f..05061daf9 100644 --- a/website/src/pages/template-design.tsx +++ b/website/src/pages/template-design.tsx @@ -6,8 +6,8 @@ import { CodeOutlined, PreviewOutlined, } from '@mui/icons-material'; -import { generate, Template } from '@pdfme/generator'; -import { Designer } from '@pdfme/ui'; +import { generate, Template } from '@lisb/pdfme-generator'; +import { Designer } from '@lisb/pdfme-ui'; import Layout from '@theme/Layout'; import { getSampleTemplate,