Skip to content

A fully open source & end-to-end encrypted note taking alternative to Evernote.

6.7 KB
Raw Blame
/*
This file is part of the Notesnook project (https://notesnook.com/)

Copyright (C) 2023 Streetwriters (Private) Limited

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

import {
  Extension,
  InputRule,
  InputRuleFinder,
  ExtendedRegExpMatchArray
} from "@tiptap/core";
import { formatDate, tiptapKeys } from "@notesnook/common";

declare module "@tiptap/core" {
  interface Commands<ReturnType> {
    datetime: {
      /**
       * Insert time at current position
       */
      insertTime: () => ReturnType;

      /**
       * Insert date at current position
       */
      insertDate: () => ReturnType;

      /**
       * Insert day at current position
       */
      insertDay: () => ReturnType;

      /**
       * Insert date & time at current position
       */
      insertDateTime: () => ReturnType;

      /**
       * Insert date & time with time zone at current position
       */
      insertDateTimeWithTimeZone: () => ReturnType;
    };
  }
}

export type DateTimeOptions = {
  dateFormat: string;
  timeFormat: "12-hour" | "24-hour";
  dayFormat: "short" | "long";
};

export const DateTime = Extension.create<DateTimeOptions>({
  name: "datetime",

  addOptions() {
    return {
      dateFormat: "DD-MM-YYYY",
      timeFormat: "12-hour",
      dayFormat: "short"
    };
  },

  addKeyboardShortcuts() {
    return {
      [tiptapKeys.insertTime.keys]: ({ editor }) =>
        editor.commands.insertTime(),
      [tiptapKeys.insertDate.keys]: ({ editor }) =>
        editor.commands.insertDate(),
      [tiptapKeys.insertDateTime.keys]: ({ editor }) =>
        editor.commands.insertDateTime(),
      [tiptapKeys.insertDateTimeWithTimezone.keys]: ({ editor }) =>
        editor.commands.insertDateTimeWithTimeZone()
    };
  },

  addCommands() {
    return {
      insertDate:
        () =>
        ({ commands }) =>
          commands.insertContent(
            formatDate(Date.now(), {
              dateFormat: this.options.dateFormat,
              type: "date"
            })
          ),
      insertTime:
        () =>
        ({ commands }) =>
          commands.insertContent(
            formatDate(Date.now(), {
              timeFormat: this.options.timeFormat,
              type: "time"
            })
          ),
      insertDay:
        () =>
        ({ commands }) =>
          commands.insertContent(
            formatDate(Date.now(), {
              dayFormat: this.options.dayFormat,
              type: "day"
            })
          ),
      insertDateTime:
        () =>
        ({ commands }) =>
          commands.insertContent(
            formatDate(Date.now(), {
              dateFormat: this.options.dateFormat,
              timeFormat: this.options.timeFormat,
              type: "date-time"
            })
          ),
      insertDateTimeWithTimeZone:
        () =>
        ({ commands }) =>
          commands.insertContent(
            formatDate(Date.now(), {
              dateFormat: this.options.dateFormat,
              timeFormat: this.options.timeFormat,
              type: "date-time-timezone"
            })
          )
    };
  },

  addInputRules() {
    return [
      shortcutInputRule({
        shortcut: "/time",
        replace: () => {
          return formatDate(Date.now(), {
            timeFormat: this.options.timeFormat,
            type: "time"
          });
        }
      }),
      shortcutInputRule({
        shortcut: "/date",
        replace: () => {
          return formatDate(Date.now(), {
            dateFormat: this.options.dateFormat,
            type: "date"
          });
        }
      }),
      shortcutInputRule({
        shortcut: "/day",
        replace: () => {
          return formatDate(Date.now(), {
            dayFormat: this.options.dayFormat,
            type: "day"
          });
        }
      }),
      shortcutInputRule({
        shortcut: "/now",
        replace: () => {
          return formatDate(Date.now(), {
            dateFormat: this.options.dateFormat,
            timeFormat: this.options.timeFormat,
            type: "date-time"
          });
        }
      }),
      shortcutInputRule({
        shortcut: "/nowz",
        replace: () => {
          return formatDate(Date.now(), {
            dateFormat: this.options.dateFormat,
            timeFormat: this.options.timeFormat,
            type: "date-time-timezone"
          });
        }
      })
    ];
  }
});

function shortcutInputRule(config: {
  shortcut: string;
  replace: () => string;
}) {
  const regex = new RegExp(`(^| )${config.shortcut}(\\s)`, "i");
  return textInputRule({
    find: regex,
    replace: (match) => {
      const endToken = match[2] === "\n" ? "" : match[2];
      return `${match[1]}${config.replace()}${endToken}`;
    },
    after: ({ match, state, range }) => {
      const newlineRequested = match[2] === "\n";
      if (newlineRequested) state.tr.split(state.tr.mapping.map(range.to));
    }
  });
}

function textInputRule(config: {
  find: InputRuleFinder;
  replace: (match: ExtendedRegExpMatchArray) => string;
  after?: InputRule["handler"];
}) {
  return new InputRule({
    find: config.find,
    handler: (props) => {
      const { state, range, match } = props;
      const insert = config.replace(match);
      const start = range.from;
      const end = range.to;

      state.tr.insertText(insert, start, end);

      if (config.after) config.after(props);
    }
  });
}

export function replaceDateTime(
  value: string,
  dateFormat = "DD-MM-YYYY",
  timeFormat: "12-hour" | "24-hour" = "12-hour",
  dayFormat: DateTimeOptions["dayFormat"] = "short"
) {
  value = value.replaceAll(
    "/time ",
    formatDate(Date.now(), {
      timeFormat,
      type: "time"
    }) + " "
  );

  value = value.replaceAll(
    "/date ",
    formatDate(Date.now(), {
      dateFormat,
      type: "date"
    }) + " "
  );

  value = value.replaceAll(
    "/now ",
    formatDate(Date.now(), {
      dateFormat,
      timeFormat,
      type: "date-time"
    }) + " "
  );

  value = value.replaceAll(
    "/nowz ",
    formatDate(Date.now(), {
      dateFormat,
      timeFormat,
      type: "date-time-timezone"
    }) + " "
  );

  value = value.replaceAll(
    "/day ",
    formatDate(Date.now(), {
      dayFormat: dayFormat,
      type: "day"
    }) + " "
  );

  return value;
}