watermark-js-plus 0.0.2 → 0.0.4

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.

package/docs/config/blind.md

@@ -1,19 +0,0 @@
----
-layout: doc
----
-# Blind Watermark Config
-
-## globalAlpha
-
-- **Type:** `number`
-- **Default:** `0.005`
-
-Transparency of watermark.
-
-## mode
-
-- **Type:** `string`
-- **Default:** `'blind'`
-- **available values**: `'default' | 'blind'`
-
-Watermark mode

package/docs/config/index.md

@@ -1,178 +0,0 @@
----
-layout: doc
----
-# Basic Config
-
-## width
-
-- **Type:** `number`
-- **Default:** `300`
-
-A unit of width for a single watermark.
-
-## height
-
-- **Type:** `number`
-- **Default:** `300`
-
-A unit of height for a single watermark.
-
-## rotate
-
-- **Type:** `number`
-- **Default:** `45`
-
-Watermark rotation Angle.
-
-Rotate with the center of the text as the origin.
-
-## contentType
-
-- **Type:** `string`
-- **Default:** `'text'`
-- **available values**: `'text' | 'image' | 'multi-line-text' | 'rich-text'`
-
-Type of watermark content.
-
-## content
-
-- **Type:** `string`
-- **Default:** `'hello watermark-js-plus'`
-
-Watermark content.
-
-## imageWidth
-
-- **Type:** `number`
-- **Default:** `0`
-
-Watermark image width.
-
-## imageHeight
-
-- **Type:** `number`
-- **Default:** `0`
-
-Watermark image height.
-
-## lineHeight
-
-- **Type:** `number`
-- **Default:** `30`
-
-Watermark content line high.
-
-## zIndex
-
-- **Type:** `number`
-- **Default:** `10000`
-
-z-index
-
-## backgroundPosition
-
-- **Type:** `string`
-- **Default:** `'0 0, 0 0'`
-
-background-position
-
-## fontSize
-
-- **Type:** `number`
-- **Default:** `20`
-
-The font size of the watermark content.
-
-## fontFamily
-
-- **Type:** `string`
-- **Default:** `'sans-serif'`
-
-The font family of the watermark content.
-
-## textAlign
-
-- **Type:** `string`
-- **Default:** `'center'`
-- **available values**: `'center' | 'left' | 'right'`
-
-Watermark content horizontal alignment.
-
-## textBaseline
-
-- **Type:** `string`
-- **Default:** `'middle'`
-- **available values**: `'top' | 'bottom' | 'middle'`
-
-Watermark content baseline.
-
-## fontColor
-
-- **Type:** `string`
-- **Default:** `'#000'`
-
-Watermark content font color.
-
-## globalAlpha
-
-- **Type:** `number`
-- **Default:** `0.5`
-
-Transparency of watermark.
-
-## fontWeight
-
-- **Type:** `string`
-- **Default:** `'normal'`
-
-Watermark content font weight.
-
-## mode
-
-- **Type:** `string`
-- **Default:** `'default'`
-- **available values**: `'default' | 'blind'`
-
-Watermark mode
-
-## mutationObserve
-
-- **Type:** `boolean`
-- **Default:** `true`
-
-Enable listening for watermark dom changes.
-
-## unique
-
-- **Type:** `boolean`
-- **Default:** `true`
-
-The watermark cannot be added repeatedly.
-
-## parent
-
-- **Type:** `Element | string`
-- **Default:** `'body'`
-
-Watermarking container.
-
-## onSuccess
-
-- **Type:** `Function`
-- **Default:** `() => {}`
-
-Watermark added successful callback event.
-
-## onBeforeDestroy
-
-- **Type:** `Function`
-- **Default:** `() => {}`
-
-Watermark delete before callback event.
-
-## onDestroyed
-
-- **Type:** `Function`
-- **Default:** `() => {}`
-
-Watermark deleted after callback event.