watermark-js-plus 0.0.2 → 0.0.3

package/README.md

@@ -1 +1,88 @@
-# watermark-js-plus
+<p align="center">
+  <a href="https://zhensherlock.github.io/watermark-js-plus/" target="_blank" rel="noopener noreferrer">
+    <img width="300" src="https://zhensherlock.github.io/watermark-js-plus/hero-image.png" alt="watermark logo">
+  </a>
+</p>
+<p align="center">
+  <a href="https://npmjs.com/package/pinia"><img src="https://badgen.net/npm/v/pinia" alt="npm package"></a>
+  <a href="https://github.com/vuejs/pinia/actions/workflows/test.yml?query=branch%3Av2"><img src="https://github.com/vuejs/pinia/workflows/test/badge.svg?branch=v2" alt="build status"></a>
+  <a href="https://codecov.io/github/vuejs/pinia"><img src="https://badgen.net/codecov/c/github/vuejs/pinia/v2" alt="code coverage"></a>
+</p>
+
+# Watermark
+
+> This is a *canvas-based* watermark for browser.
+
+- 🛠️ Rich Features
+- 🔑 Fully Typed APIs
+- 📦️ Extremely light
+
+Watermark works with both Vue 2 , Vue 3 And React.
+
+# Translations
+
+* [中文文档](README_zh.md)
+
+## Installing
+
+```bash
+# or pnpm or yarn
+npm install watermark-js-plus
+```
+
+## Usage
+
+### Watermark
+
+```ts
+import { Watermark } from 'watermark-js-plus'
+
+const watermark = new Watermark({
+  content: 'hello my watermark',
+  width: 200,
+  height: 200,
+  onSuccess: () => {
+    // success callback
+  }
+})
+
+watermark.create()
+```
+
+### Blind Watermark
+
+```ts
+import { BlindWatermark } from 'watermark-js-plus'
+
+const watermark = new BlindWatermark({
+  content: 'hello my watermark',
+  width: 200,
+  height: 200,
+  onSuccess: () => {
+    // success callback
+  }
+})
+
+watermark.create()
+```
+
+### Decode Blind Watermark
+
+```js
+import { BlindWatermark } from 'watermark-js-plus'
+
+BlindWatermark.decode({
+  url: uploadFile.url, // image url
+  onSuccess: (imageBase64) => {
+    // success callback
+  }
+})
+```
+
+## Documentation
+
+To learn more, check [its documentation](https://zhensherlock.github.io/watermark-js-plus).
+
+## License
+
+[MIT](LICENSE).

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "watermark-js-plus",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "watermark for the browser",
-  "main": "lib/watermark.js",
   "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "prepare": "husky install",
     "lint": "npx eslint \"src/*.{ts,js}\"",
     "dev": "concurrently \"npm run src:dev\" \"npm run docs:dev\"",
-    "src:dev": "rollup -c --watch",
-    "build": "rollup -c --environment NODE_ENV:production && rollup -c",
+    "src:dev": "rollup -c --watch --bundleConfigAsCjs",
+    "build": "rollup -c --bundleConfigAsCjs --environment NODE_ENV:production",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 -n changelog-option.cjs",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
@@ -37,6 +36,19 @@
     "防删除水印",
     "解密水印"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.js",
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.js",
+  "files": [
+    "dist"
+  ],
   "devDependencies": {
     "@babel/core": "^7.20.5",
     "@babel/eslint-parser": "^7.19.1",
@@ -46,14 +58,14 @@
     "@commitlint/config-conventional": "^17.3.0",
     "@element-plus/icons-vue": "^2.0.10",
     "@rollup/plugin-babel": "^6.0.3",
-    "@rollup/plugin-commonjs": "^23.0.3",
+    "@rollup/plugin-commonjs": "^23.0.4",
     "@rollup/plugin-eslint": "^9.0.1",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@rollup/plugin-replace": "^5.0.1",
-    "@rollup/plugin-terser": "^0.1.0",
+    "@rollup/plugin-terser": "^0.2.0",
     "@rollup/plugin-typescript": "^10.0.1",
     "@types/markdown-it": "^12.2.3",
-    "@typescript-eslint/parser": "^5.45.0",
+    "@typescript-eslint/parser": "^5.45.1",
     "@vue/theme": "^1.3.0",
     "concurrently": "^7.6.0",
     "conventional-changelog-angular": "^5.0.13",
@@ -67,12 +79,12 @@
     "husky": "^8.0.2",
     "lint-staged": "^13.1.0",
     "markdown-it": "^13.0.1",
-    "rollup": "^3.5.1",
+    "rollup": "^3.7.0",
     "rollup-plugin-filesize": "^9.1.2",
     "rollup-plugin-your-function": "^0.4.3",
     "terser": "^5.16.1",
-    "typescript": "^4.9.3",
+    "typescript": "^4.9.4",
     "unplugin-element-plus": "^0.4.1",
-    "vitepress": "^1.0.0-alpha.29"
+    "vitepress": "^1.0.0-alpha.30"
   }
 }

package/.editorconfig

@@ -1,16 +0,0 @@
-# http://editorconfig.org
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
-
-[Makefile]
-indent_style = tab

package/.eslintignore

@@ -1,7 +0,0 @@
-*/build/*.js
-*/public
-dist
-.husky/
-lib
-*/node_modules
-package-lock.json

package/.eslintrc.cjs

@@ -1,46 +0,0 @@
-module.exports = {
-  parser: '@typescript-eslint/parser', // 解析器，默认使用Espree
-  env: { // 指定脚本的运行环境。每种环境都有一组特定的预定义全局变量。
-    browser: true, // 运行在浏览器
-    es2021: true, // 支持es2021
-    es6: true,
-  },
-  extends: [ // 使用的外部代码格式化配置文件
-    'semistandard',
-    'plugin:import/recommended'
-  ],
-  plugins: [
-    'import'
-  ],
-  parserOptions: {
-    ecmaVersion: 12, // ecmaVersion 用来指定支持的 ECMAScript 版本 。默认为 5，即仅支持es5
-    sourceType: 'module',
-  },
-  globals: { // 脚本在执行期间访问的额外的全局变量
-    describe: true,
-    it: true,
-    after: true,
-    before: true,
-    afterEach: true,
-    beforeEach: true,
-    __BUILD__: true,
-    __DEV__: true,
-    __SIT__: true,
-    __UAT__: true,
-    __PROD__: true
-  },
-  rules: {
-    // 启用的规则及其各自的错误级别。0(off)  1(warning)  2(error)
-    'no-console': 0,
-    semi: [1, 'never'],
-    quotes: [1, 'single'],
-    'no-unused-vars': 0,
-  },
-  settings: {
-    'import/resolver': {
-      node: {
-        extensions: ['.js', '.jsx', '.ts', '.tsx']
-      }
-    }
-  },
-};

package/.github/workflows/deploy.yml

@@ -1,29 +0,0 @@
-name: deploy
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          cache: npm
-      - run: npm ci
-
-      - name: Build
-        run: yarn docs:build
-
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/.vitepress/dist
-          # cname: example.com # if wanna deploy to custom domain

package/.github/workflows/npm-publish.yml

@@ -1,32 +0,0 @@
-# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
-# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
-
-name: npm-publish
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - run: npm ci
-
-  publish-npm:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.husky/commit-msg

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx --no-install commitlint --edit ""

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npm run lint-changelog

package/.prettierrc

@@ -1,10 +0,0 @@
-{
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": false,
-  "singleQuote": true,
-  "TrailingComma": "all",
-  "bracketSpacing": true,
-  "jsxBracketSameLine": false,
-  "arrowParens": "avoid"
-}

package/CHANGELOG.md

@@ -1,18 +0,0 @@
-## [0.0.2](https://github.com/zhensherlock/watermark-js-plus/compare/v0.0.1...v0.0.2) (2022-12-07)
-
-
-### ✨ Features | 新功能
-
-* optimize parent element logic ([836a1ee](https://github.com/zhensherlock/watermark-js-plus/commit/836a1eed2319c42444bdb6362dbf8114ab9bcf0e))
-
-
-
-## [0.0.1](https://github.com/zhensherlock/watermark-js-plus/compare/fb530a78a35020947fec230142a131b56b3588b4...v0.0.1) (2022-12-05)
-
-
-### ✨ Features | 新功能
-
-* add initial version ([fb530a7](https://github.com/zhensherlock/watermark-js-plus/commit/fb530a78a35020947fec230142a131b56b3588b4))
-
-
-

package/babel.config.cjs

@@ -1,23 +0,0 @@
-const presets = [
-  [
-    '@babel/preset-env',
-    {
-      useBuiltIns: 'usage',
-      corejs: { version: 3 },
-      targets: [
-        '> 1%',
-        'Firefox ESR',
-        'last 4 versions',
-        'maintained node versions',
-        'not dead',
-        'safari >= 7'
-      ],
-    },
-  ],
-]
-
-const plugins = [
-  '@babel/plugin-transform-runtime'
-]
-
-module.exports = { presets, plugins }

package/changelog-option.cjs

@@ -1,87 +0,0 @@
-const compareFunc = require('compare-func')
-
-module.exports = {
-  writerOpts: {
-    transform: (commit, context) => {
-      let discard = true
-      const issues = []
-
-      commit.notes.forEach(note => {
-        note.title = 'BREAKING CHANGES'
-        discard = false
-      })
-      if (commit.type === 'feat') {
-        commit.type = '✨ Features | 新功能'
-      } else if (commit.type === 'fix') {
-        commit.type = '🐛 Bug Fixes | Bug 修复'
-      } else if (commit.type === 'perf') {
-        commit.type = '⚡ Performance Improvements | 性能优化'
-      } else if (commit.type === 'revert' || commit.revert) {
-        commit.type = '⏪ Reverts | 回退'
-      } else if (discard) {
-        return
-      } else if (commit.type === 'refactor') {
-        commit.type = '♻ Code Refactoring | 代码重构'
-      } else if (commit.type === 'test') {
-        commit.type = '✅ Tests | 测试'
-      } else if (commit.type === 'build') {
-        commit.type = '👷‍ Build System | 构建'
-      } else if (commit.type === 'ci') {
-        commit.type = '🔧 Continuous Integration | CI 配置'
-      } else if (commit.type === 'chore') {
-        commit.type = '🎫 Chores | 其他更新'
-      } else if (commit.type === 'style') {
-        commit.type = '💄 Styles | 风格'
-      } else if (commit.type === 'docs') {
-        commit.type = '📝 Documentation | 文档'
-      }
-
-      if (commit.scope === '*') {
-        commit.scope = ''
-      }
-
-      if (typeof commit.hash === 'string') {
-        commit.shortHash = commit.hash.substring(0, 7)
-      }
-
-      if (typeof commit.subject === 'string') {
-        let url = context.repository
-          ? `${context.host}/${context.owner}/${context.repository}`
-          : context.repoUrl
-
-        if (url) {
-          url = `${url}/issues/`
-          // Issue URLs.
-          commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => {
-            issues.push(issue)
-            return `[#${issue}](${url}${issue})`
-          })
-        }
-
-        if (context.host) {
-          // User URLs.
-          commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => {
-            if (username.includes('/')) {
-              return `@${username}`
-            }
-            return `[@${username}](${context.host}/${username})`
-          })
-        }
-      }
-
-      // remove references that already appear in the subject
-      commit.references = commit.references.filter(reference => {
-        if (issues.indexOf(reference.issue) === -1) {
-          return true
-        }
-        return false
-      })
-      return commit
-    },
-    groupBy: 'type',
-    commitGroupsSort: 'title',
-    commitsSort: ['scope', 'subject'],
-    noteGroupsSort: 'title',
-    notesSort: compareFunc
-  }
-}

package/commitlint.config.cjs

@@ -1,26 +0,0 @@
-module.exports = {
-  extends: ['@commitlint/config-conventional'],
-  rules: {
-    // type 类型定义，表示 git 提交的 type 必须在以下类型范围内
-    'type-enum': [
-      2,
-      'always',
-      [
-        'feat', // 新功能
-        'fix', //  修复
-        'docs', // 文档变更
-        'style', // 代码格式
-        'refactor', // 重构
-        'pref', // 性能优化
-        'test', // 增加测试
-        'build', // 构建
-        'ci', // CI配置
-        'chore', // 构建过程或辅助工具的变动
-        'revert', // 回退
-        'build' // 打包
-      ]
-    ],
-    // subject 大小写不做校验
-    'subject-case': [0]
-  }
-};

package/docs/.vitepress/config.ts

@@ -1,103 +0,0 @@
-import { version } from '../../package.json'
-import zh_CN from './locales/zh-CN'
-
-export default {
-  title: 'watermark-js-plus',
-  description: 'A watermark plugin',
-  base: '/watermark-js-plus',
-  head: [
-    ['link', { rel: 'shortcut icon', href: '/watermark-js-plus/favicons/favicon-64x64.png' }],
-    ['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/watermark-js-plus/favicons/apple-touch-icon.png' }],
-    // ['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicons/favicon-32x32.png' }],
-    // ['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/favicons/favicon-16x16.png' }],
-    // ['link', { rel: "manifest", href: "/assets/favicons/site.webmanifest"}],
-    // ['link', { rel: "mask-icon", href: "/assets/favicons/safari-pinned-tab.svg", color: "#3a0839"}],
-    // ['meta', { name: "msapplication-TileColor", content: "#3a0839"}],
-    // ['meta', { name: "msapplication-config", content: "/assets/favicons/browserconfig.xml"}],
-    // ['meta', { name: "theme-color", content: "#ffffff"}],
-  ],
-  themeConfig: {
-    logo: '/logo.png',
-    nav: [
-      { text: 'Guide', link: '/guide/what-is-this', activeMatch: '/guide/' },
-      { text: 'Configs', link: '/config/', activeMatch: '/config/' },
-      {
-        text: version,
-        items: [
-          {
-            text: 'Changelog',
-            link: 'https://github.com/zhensherlock/watermark-js-plus/blob/main/CHANGELOG.md'
-          },
-          // {
-          //   text: 'Contributing',
-          //   link: 'https://github.com/zhensherlock/watermark-js-plus/blob/main/.github/contributing.md'
-          // }
-        ]
-      }
-    ],
-    socialLinks: [
-      { icon: 'github', link: 'https://github.com/zhensherlock/watermark-js-plus' },
-    ],
-    sidebar: {
-      '/guide': [
-        {
-          text: 'Guide',
-          // collapsible: true,
-          items: [
-            { text: 'Introduce', link: '/guide/what-is-this' },
-            { text: 'Getting Started', link: '/guide/getting-started' },
-            { text: 'Watermark', link: '/guide/watermark' },
-            { text: 'Blind Watermark', link: '/guide/blind-watermark' },
-          ]
-        }
-      ],
-      '/config': [
-        {
-          text: 'Config',
-          // collapsible: true,
-          items: [
-            { text: 'Basic Config', link: '/config/' },
-            { text: 'Blind Watermark Config', link: '/config/blind' },
-            { text: 'Blind Watermark Decode', link: '/config/blind-decode' },
-          ]
-        }
-      ]
-    },
-    algolia: {
-      appId: 'V6CF28P0PS',
-      apiKey: '692752b7b3c6f794997d8ae22aed79fa',
-      indexName: 'dev_docs'
-    },
-    footer: {
-      message: 'Released under the MIT License.',
-      copyright: 'Copyright © 2021-present Michael Sun'
-    },
-    locales: {
-      '/zh/': zh_CN
-    },
-    localeLinks: {
-      // text: 'English',
-      items: [
-        { text: 'English', link: '/' },
-        { text: '简体中文', link: '/zh/' },
-      ]
-    },
-  },
-  markdown: {
-    lineNumbers: true
-  },
-  locales: {
-    '/': {
-      lang: 'en-US',
-      title: 'watermark-js-plus',
-      description: 'A watermark plugin',
-    },
-    '/zh/': {
-      lang: 'zh-CN',
-      description: '一个水印插件',
-      outlineTitle: '本页目录',
-      lastUpdatedText: '上次更新',
-      base: '/zh/',
-    }
-  }
-}

package/docs/.vitepress/locales/zh-CN.ts

@@ -1,51 +0,0 @@
-import { version } from '../../../package.json'
-
-export default {
-  outlineTitle: '本页目录',
-  lastUpdatedText: '上次更新',
-  nav: [
-    { text: '指南', link: '/zh/guide/what-is-this', activeMatch: '/guide/' },
-    { text: '配置项', link: '/zh/config/', activeMatch: '/config/' },
-    {
-      text: version,
-      items: [
-        {
-          text: '更新日志',
-          link: 'https://github.com/zhensherlock/watermark-js-plus/blob/main/CHANGELOG.md'
-        },
-        // {
-        //   text: '贡献',
-        //   link: 'https://github.com/vuejs/vitepress/blob/main/.github/contributing.md'
-        // }
-      ]
-    }
-  ],
-  sidebar: {
-    '/zh/guide': [
-      {
-        text: '向导',
-        // collapsible: true,
-        items: [
-          { text: '介绍', link: '/zh/guide/what-is-this' },
-          { text: '开始使用', link: '/zh/guide/getting-started' },
-          { text: '水印', link: '/zh/guide/watermark' },
-          { text: '暗水印', link: '/zh/guide/blink-watermark' },
-        ]
-      }
-    ],
-    '/zh/config': [
-      {
-        text: '配置',
-        // collapsible: true,
-        items: [
-          { text: '基础配置项', link: '/zh/config/' },
-          { text: '暗水印配置项', link: '/zh/config/blind' },
-          { text: '暗水印解码配置项', link: '/zh/config/blind-decode' },
-        ]
-      }
-    ]
-  },
-  footer: {
-    message: '本中文文档内容版权为 Michael Sun 所有，保留所有权利。'
-  },
-}

package/docs/.vitepress/theme/index.ts

@@ -1,12 +0,0 @@
-import DefaultTheme from 'vitepress/theme'
-import 'element-plus/dist/index.css'
-export default {
-  ...DefaultTheme,
-  enhanceApp: async ({ app, router, siteData, isServer }: any) => {
-    // app is the Vue 3 app instance from `createApp()`. router is VitePress'
-    // custom router. `siteData`` is a `ref`` of current site-level metadata.
-    import('element-plus').then((module) => {
-      app.use(module)
-    })
-  }
-}

package/docs/config/blind-decode.md

@@ -1,33 +0,0 @@
----
-layout: doc
----
-# Blind Watermark Decode
-
-## url
-
-- **Type:** `string`
-- **Default:** `''`
-
-Decoding picture path.
-
-## mode
-
-- **Type:** `string`
-- **Default:** `'canvas'`
-- **available values**: `'canvas'`
-
-Mode of decoding.
-
-## fillColor
-
-- **Type:** `string`
-- **Default:** `'#000'`
-
-fill color.
-
-## compositeOperation
-
-- **Type:** `string`
-- **Default:** `'color-burn'`
-
-composite operation.