@waline/client 2.15.8 → 3.0.0-alpha.2

package/src/comment.ts

@@ -1,69 +0,0 @@
-import { fetchCommentCount } from './api/index.js';
-import { type WalineAbort } from './typings/index.js';
-import { decodePath, errorHandler, getServerURL } from './utils/index.js';
-
-export interface WalineCommentCountOptions {
-  /**
-   * Waline 服务端地址
-   *
-   * Waline server url
-   */
-  serverURL: string;
-
-  /**
-   * 评论数 CSS 选择器
-   *
-   * Comment count CSS selector
-   *
-   * @default '.waline-comment-count'
-   */
-  selector?: string;
-
-  /**
-   * 需要获取的默认路径
-   *
-   * Path to be fetched by default
-   *
-   * @default window.location.pathname
-   */
-  path?: string;
-
-  /**
-   * 错误提示消息所使用的语言
-   *
-   * Language of error message
-   *
-   * @default navigator.language
-   */
-  lang?: string;
-}
-
-export const commentCount = ({
-  serverURL,
-  path = window.location.pathname,
-  selector = '.waline-comment-count',
-  lang = navigator.language,
-}: WalineCommentCountOptions): WalineAbort => {
-  const controller = new AbortController();
-
-  // comment count
-  const elements = document.querySelectorAll<HTMLElement>(selector);
-
-  if (elements.length)
-    void fetchCommentCount({
-      serverURL: getServerURL(serverURL),
-      paths: Array.from(elements).map((element) =>
-        decodePath(element.dataset.path || element.getAttribute('id') || path),
-      ),
-      lang,
-      signal: controller.signal,
-    })
-      .then((counts) => {
-        elements.forEach((element, index) => {
-          element.innerText = counts[index].toString();
-        });
-      })
-      .catch(errorHandler);
-
-  return controller.abort.bind(controller);
-};

package/src/compact/convert.ts

@@ -1,80 +0,0 @@
-import {
-  DROPPED_OPTIONS_WHICH_CAN_NOT_BE_POLYFILLED,
-  DROPPED_OPTIONS_WHICH_CAN_STILL_BE_POLYFILLED,
-} from './dropped.js';
-import { warning } from './logger.js';
-import { type DeprecatedWalineOptions } from './v1.js';
-import { resolveOldEmojiMap, type DeprecatedValineOptions } from './valine.js';
-import { type WalineInitOptions } from '../typings/index.js';
-
-export const covertOptions = (
-  options: WalineInitOptions &
-    DeprecatedValineOptions &
-    DeprecatedWalineOptions,
-): WalineInitOptions => {
-  const {
-    // Options which needs to be polyfilled
-    placeholder,
-    langMode = {},
-    emojiCDN,
-    emojiMaps,
-    requiredFields = [],
-    anonymous,
-    previewMath,
-    uploadImage,
-    highlight,
-    copyRight,
-    visitor,
-
-    pageview = visitor === true
-      ? '.leancloud_visitors,.leancloud-visitors,.waline-visitor-count,.waline-pageview-count'
-      : visitor,
-    locale = langMode,
-    emoji,
-    requiredMeta = requiredFields,
-    highlighter = highlight,
-    imageUploader = uploadImage,
-    texRenderer = previewMath,
-    copyright = copyRight,
-    login = anonymous === true
-      ? 'disable'
-      : anonymous === false
-      ? 'force'
-      : 'enable',
-    ...more
-  } = options;
-
-  // error with those which can no longer be handled
-  DROPPED_OPTIONS_WHICH_CAN_NOT_BE_POLYFILLED.filter((item) =>
-    Object.keys(options).includes(item),
-  ).forEach((item) =>
-    warning(`Option "${item}" is REMOVED and CAN NOT be polyfilled!`),
-  );
-
-  // warnings with those which is being polyfilled
-  DROPPED_OPTIONS_WHICH_CAN_STILL_BE_POLYFILLED.filter(([oldOption]) =>
-    Object.keys(options).includes(oldOption),
-  ).forEach(([oldOption, newOption]) =>
-    warning(
-      `Deprecated option "${oldOption}" is currently being polyfilled, Please switch to option "${newOption}" in v2!`,
-    ),
-  );
-
-  if (placeholder) locale.placeholder = placeholder;
-
-  return {
-    locale,
-    emoji:
-      emojiCDN && typeof emojiMaps === 'object'
-        ? resolveOldEmojiMap(emojiMaps, emojiCDN)
-        : emoji,
-    requiredMeta,
-    imageUploader,
-    highlighter,
-    texRenderer,
-    copyright,
-    login,
-    pageview,
-    ...more,
-  };
-};

package/src/compact/dropped.ts

@@ -1,35 +0,0 @@
-export const DROPPED_OPTIONS_WHICH_CAN_NOT_BE_POLYFILLED: string[] = [
-  // valine
-  'region',
-  'appId',
-  'appKey',
-  'notify',
-  'verify',
-  'avatar',
-  'avatarForce',
-  'enableQQ',
-  'recordIP',
-  'serverURLs',
-
-  // waline v1
-  'avatarCDN',
-  'mathTagSupport',
-];
-
-export const DROPPED_OPTIONS_WHICH_CAN_STILL_BE_POLYFILLED: [string, string][] =
-  [
-    // valine
-    ['emojiCDN', 'emoji'],
-    ['emojiMaps', 'emoji'],
-    ['requiredFields', 'requiredMeta'],
-    ['visitor', 'pageview'],
-    ['langMode', 'locale'],
-    ['placeholder', 'locale.placeholder'],
-
-    // waline v1
-    ['highlight', 'highlighter'],
-    ['uploadImage', 'imageUploader'],
-    ['previewMath', 'texRenderer'],
-    ['anonymous', 'login'],
-    ['copyRight', 'copyright'],
-  ];

package/src/compact/index.ts

@@ -1,4 +0,0 @@
-export * from './convert';
-export * from './logger';
-export * from './v1';
-export * from './valine';

package/src/compact/logger.ts

@@ -1,5 +0,0 @@
-export const warning = (content: string): void =>
-  console.warn(
-    `%c ${content}`,
-    'background:#ff0;color:red;font-size:36px;font-weight:bold;',
-  );

package/src/compact/v1.ts

@@ -1,103 +0,0 @@
-import {
-  type WalineHighlighter,
-  type WalineImageUploader,
-  type WalineTeXRenderer,
-} from '../typings/index.js';
-
-export interface DeprecatedWalineOptions {
-  /**
-   * @deprecated Please use mathjax in server, dropped in V2
-   *
-   * 是否注入额外的样式添加对 `<math>` 块的兼容
-   *
-   * Whether injecting additional styles to support math block
-   *
-   * @default false
-   */
-  mathTagSupport?: boolean;
-
-  /**
-   * @deprecated use `pageview` instead, dropped in V2
-   *
-   * 文章访问量统计
-   *
-   * Article reading statistics
-   *
-   * @default false
-   */
-  visitor?: boolean;
-
-  /**
-   * @deprecated use `highlighter` instead, dropped in V2
-   *
-   * 代码高亮
-   *
-   * Code highlighting
-   */
-
-  highlight?: WalineHighlighter | false;
-
-  /**
-   * @deprecated use `imageUploader` instead, dropped in V2
-   *
-   * 自定义图片上传方法，方便更好的存储图片
-   *
-   * 方法执行时会将图片对象传入。
-   *
-   * Custom image upload callback to manage picture by yourself.
-   *
-   * We will pass a picture file object when execute it.
-   */
-
-  uploadImage?: WalineImageUploader | false;
-
-  /**
-   * @deprecated Use `login` instead, dropped in V2
-   *
-   * 是否允许登录评论
-   *
-   * 默认情况是两者都支持，设置为 `true` 表示仅支持匿名评论，`false` 表示仅支持登录评论。
-   *
-   * Whether to allow login comments.
-   *
-   * Both supported by default, set to `true` means only support anonymous comments, `false` means only support login comments.
-   *
-   * @default undefined
-   */
-  anonymous?: boolean;
-
-  /**
-   * @deprecated Please use `AVATAR_PROXY` in server, dropped in V2
-   *
-   * 设置 Gravatar 头像 CDN 地址
-   *
-   * Gravatar CDN baseURL
-   *
-   * @default 'https://www.gravatar.com/avatar'
-   */
-  avatarCDN?: string;
-
-  /**
-   * @deprecated Use `texRenderer` instead, dropped in V2
-   *
-   * 自定义 TeX 处理方法，用于预览。
-   *
-   * Custom math formula parse callback for preview.
-   */
-  previewMath?: WalineTeXRenderer | false;
-
-  /**
-   * @deprecated use `copyright` instead, dropped in V2
-   *
-   * 是否在页脚展示版权信息
-   *
-   * 为了支持 Waline，我们强烈建议你开启它
-   *
-   * Whether show copyright in footer
-   *
-   * We strongly recommended you to keep it on to support waline
-   *
-   * @default true
-   */
-  copyRight?: boolean;
-}

package/src/compact/valine.ts

@@ -1,132 +0,0 @@
-import {
-  type WalineEmojiInfo,
-  type WalineEmojiMaps,
-  type WalineLocale,
-  type WalineMeta,
-} from '../typings/index.js';
-
-export type DeprecatedAvatar =
-  | ''
-  | 'mp'
-  | 'identicon'
-  | 'monsterid'
-  | 'wavatar'
-  | 'retro'
-  | 'robohash'
-  | 'hide';
-
-export type DeprecatedEmojiMaps = Record<string, string>;
-
-export interface DeprecatedValineOptions {
-  /**
-   * @deprecated Use `locale.placeholder` instead, dropped in V2
-   */
-  placeholder?: string;
-
-  /**
-   * @deprecated Use `locale` instead, dropped in V2
-   */
-  langMode?: Partial<WalineLocale>;
-
-  /**
-   * @deprecated Use `requiredMeta` instead, dropped in V2
-   */
-  requiredFields?: WalineMeta[];
-
-  /**
-   * @deprecated Please use `AVATAR_PROXY` in server, dropped in V2
-   *
-   * [Gravatar](http://cn.gravatar.com/) 头像展示方式
-   *
-   * 可选值:
-   *
-   * - `''`
-   * - `'mp'`
-   * - `'identicon'`
-   * - `'monsterid'`
-   * - `'wavatar'`
-   * - `'retro'`
-   * - `'robohash'`
-   * - `'hide'`
-   *
-   * [Gravatar](http://gravatar.com/) type
-   *
-   * Optional value:
-   *
-   * - `''`
-   * - `'mp'`
-   * - `'identicon'`
-   * - `'monsterid'`
-   * - `'wavatar'`
-   * - `'retro'`
-   * - `'robohash'`
-   * - `'hide'`
-   *
-   * @default 'mp'
-   */
-  avatar?: DeprecatedAvatar;
-
-  /**
-   * @deprecated no longer needed, dropped in V2
-   *
-   * 每次访问是否**强制**拉取最新的*评论列表头像*
-   *
-   * Whether **force** pulling the latest avatar each time
-   *
-   * @default false
-   */
-  avatarForce?: boolean;
-
-  /**
-   * @deprecated Use `emojis` instead, dropped in V2
-   *
-   * 设置**表情包 CDN**
-   *
-   * @see [自定义表情包](https://waline.js.org/client/emoji.html)
-   *
-   * Set **Emoji Pack CDN**
-   *
-   * @see [Custom Emoji](https://waline.js.org/en/client/emoji.html)
-   *
-   * @default 'https://img.t.sinajs.cn/t4/appstyle/expression/ext/normal/'
-   */
-  emojiCDN?: string;
-
-  /**
-   * @deprecated Use `emojis` instead, dropped in V2
-   *
-   * 设置**表情包映射**
-   *
-   * @see [自定义表情](https://waline.js.org/client/emoji.html)
-   *
-   * Set **emoji maps**
-   *
-   * @see [Custom Emoji](https://waline.js.org/en/client/emoji.html)
-   *
-   * @default 微博表情包
-   */
-
-  emojiMaps?: DeprecatedEmojiMaps;
-}
-
-// TODO: remove
-export const resolveOldEmojiMap = (
-  emojiMaps: DeprecatedEmojiMaps,
-  emojiCDN = '',
-): WalineEmojiInfo[] => {
-  const resolvedEmojiMaps: WalineEmojiMaps = {};
-
-  for (const key in emojiMaps) {
-    resolvedEmojiMaps[key] = /(?:https?:)?\/\//.test(emojiMaps[key])
-      ? emojiMaps[key]
-      : `${emojiCDN}${emojiMaps[key]}`;
-  }
-
-  return [
-    {
-      name: 'Emoji',
-      icon: Object.values(resolvedEmojiMaps).pop() || '',
-      items: Object.keys(resolvedEmojiMaps),
-    },
-  ];
-};

package/src/components/ArticleReaction.vue

@@ -1,159 +0,0 @@
-<template>
-  <div v-if="reactionsInfo.length" class="wl-reaction">
-    <div class="wl-reaction-title" v-text="locale.reactionTitle" />
-
-    <ul class="wl-reaction-list">
-      <li
-        v-for="({ active, icon, desc }, index) in reactionsInfo"
-        :key="index"
-        class="wl-reaction-item"
-        :class="{ active }"
-        @click="vote(index)"
-      >
-        <div class="wl-reaction-img">
-          <img :src="icon" :alt="desc" />
-
-          <LoadingIcon
-            v-if="votingIndex === index"
-            class="wl-reaction-loading"
-          />
-
-          <div
-            v-else
-            class="wl-reaction-votes"
-            v-text="voteNumbers[index] || 0"
-          />
-        </div>
-
-        <div class="wl-reaction-text" v-text="desc" />
-      </li>
-    </ul>
-  </div>
-</template>
-
-<script setup lang="ts">
-import {
-  type ComputedRef,
-  computed,
-  inject,
-  onMounted,
-  onUnmounted,
-  ref,
-  watch,
-} from 'vue';
-
-import { LoadingIcon } from './Icons.js';
-import { getArticleCounter, updateArticleCounter } from '../api/index.js';
-import { useReactionStorage } from '../composables/index.js';
-import { type WalineReactionLocale } from '../typings/index.js';
-import { type WalineConfig } from '../utils/index.js';
-
-defineExpose();
-
-interface ReactionItem {
-  icon: string;
-  desc: string;
-  active?: boolean;
-}
-
-const reactionStorage = useReactionStorage();
-const config = inject<ComputedRef<WalineConfig>>('config')!;
-
-const votingIndex = ref(-1);
-const voteNumbers = ref<number[]>([]);
-
-const locale = computed(() => config.value.locale);
-const isReactionEnabled = computed(() => config.value.reaction.length > 0);
-
-const reactionsInfo = computed<ReactionItem[]>(() => {
-  const { reaction, path } = config.value;
-
-  return reaction.map((icon, index) => ({
-    icon,
-    desc: locale.value[`reaction${index}` as keyof WalineReactionLocale],
-    active: reactionStorage.value[path] === index,
-  }));
-});
-
-let abort: () => void;
-
-const fetchReaction = async (): Promise<void> => {
-  if (isReactionEnabled.value) {
-    const { serverURL, lang, path, reaction } = config.value;
-    const controller = new AbortController();
-
-    abort = controller.abort.bind(controller);
-
-    const resp = await getArticleCounter({
-      serverURL,
-      lang,
-      paths: [path],
-      type: reaction.map((_reaction, index) => `reaction${index}`),
-      signal: controller.signal,
-    });
-
-    // TODO: Remove this compact code
-    if (Array.isArray(resp) || typeof resp === 'number') return;
-
-    voteNumbers.value = reaction.map(
-      (_reaction, index) => resp[`reaction${index}`],
-    );
-  }
-};
-
-const vote = async (index: number): Promise<void> => {
-  // we should ensure that only one vote request is sent at a time
-  if (votingIndex.value === -1) {
-    const { serverURL, lang, path } = config.value;
-    const currentVoteItemIndex = reactionStorage.value[path];
-
-    // mark voting status
-    votingIndex.value = index;
-
-    // if user already vote current article, decrease the voted item number
-    if (currentVoteItemIndex !== undefined) {
-      await updateArticleCounter({
-        serverURL,
-        lang,
-        path,
-        type: `reaction${currentVoteItemIndex}`,
-        action: 'desc',
-      });
-
-      voteNumbers.value[currentVoteItemIndex] = Math.max(
-        voteNumbers.value[currentVoteItemIndex] - 1,
-        0,
-      );
-    }
-
-    // increase voting number if current reaction item is not been voted
-    if (currentVoteItemIndex !== index) {
-      await updateArticleCounter({
-        serverURL,
-        lang,
-        path,
-        type: `reaction${index}`,
-      });
-      voteNumbers.value[index] = (voteNumbers.value[index] || 0) + 1;
-    }
-
-    // update vote info in local storage
-    if (currentVoteItemIndex === index) delete reactionStorage.value[path];
-    else reactionStorage.value[path] = index;
-
-    // voting is completed
-    votingIndex.value = -1;
-  }
-};
-
-onMounted(() => {
-  watch(
-    () => [config.value.serverURL, config.value.path],
-    () => {
-      void fetchReaction();
-    },
-    { immediate: true },
-  );
-});
-onUnmounted(() => abort?.());
-</script>