カスタムユーザーシステム

Waline はユーザーシステムのストレージに基づくコメントサービスを提供していますが、このユーザーシステムは Waline 独自のものです。多くのサードパーティのウェブサイトは独自のユーザーシステムを持っているため、一部のユーザーは自分のユーザーシステムを Waline に統合したいと考えています。

カスタムデータベースサービスを使えばこの機能を実現できます。その本質は、基盤となるテーブルのマッピングを行うことです。

// index.js
const Application = require('@waline/vercel');
class UserModel {}

module.exports = Application({
  model(tableName) {
    if (tableName !== 'Users') {
      return;
    }

    return new UserModel();
  },
});

上記の設定により、Waline のユーザーテーブルの読み取りを分離できました。次に、入出力パラメータのフィールドマッピングを行う必要があります。入力パラメータではフィールドをサードパーティシステムのテーブルフィールドにマッピングし、出力パラメータではサードパーティシステムのテーブルフィールドを Waline のフィールドにマッピングします。

TypeScript に詳しい場合は、以下の型定義を参照してください。

type strNum = string | number;
type UserFields =
  | 'objectId'
  | 'display_name'
  | 'email'
  | 'password'
  | 'type'
  | 'label'
  | 'url'
  | 'avatar'
  | 'github'
  | 'twitter'
  | 'facebook'
  | 'google'
  | 'weibo'
  | 'qq'
  | '2fa'
  | 'createdAt'
  | 'updatedAt';
type UserData = Record<UserFields, strNum>;
type UsersWhere = Record<UserFields, strNum | ['IN', strNum[]]>;
interface UsersOptions {
  field: string[];
  desc?: UserFields;
  limit?: number;
  offset?: number;
}

interface UsersModel {
  select: (where: UsersWhere, options: UsersOptions) => UserData[];
  add: (user: Partial<UserData>) => UserData;
  update: (user: Partial<UserData>, where: UsersWhere) => UserData;
  delete: (where: UsersWhere) => void;
  count: (where: UsersWhere) => number;
}

function model(modelName): UsersModel | undefined {
  if (modelName !== 'Users') {
    return;
  }

  //...
}

上記はデータベースのクエリに問題がないことだけを保証するものです。しかし、パスワードの暗号化方式が異なるため、Waline 内部の暗号化方式をサードパーティのウェブサイトで使われている方式と一致させることはできません。このような場合は、パスワードの暗号化と検証の方法をカスタマイズする必要があります。

// index.js
const Application = require('@waline/vercel');
class UserModel {}

module.exports = Application({
   encryptPassword() {
     return {
       hashPassword(password) {
         return hash;
       }
       checkPassword(password, storeHash) {
         return false;
       }
     }
   }
});

上記の 2 つの拡張機能により、Waline がサードパーティのウェブサイトのユーザーシステムを利用できるようになります。