@read-frog/definitions 0.1.4 → 0.3.0

package/package.json

@@ -1,26 +1,37 @@
 {
   "name": "@read-frog/definitions",
   "type": "module",
-  "version": "0.1.4",
+  "version": "0.3.0",
   "private": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mengxi-ream/read-frog-monorepo",
+    "directory": "packages/definitions"
+  },
+  "imports": {
+    "#/*": "./src/*.ts"
+  },
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.js"
     }
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
-    "dist",
-    "src"
+    "dist/**",
+    "src/**"
   ],
   "dependencies": {
-    "zod": "^4.3.6"
+    "@date-fns/tz": "^1.4.1",
+    "date-fns": "^4.1.0",
+    "zod": "^4.4.3"
   },
   "devDependencies": {
-    "tsdown": "^0.21.8",
+    "tsdown": "^0.22.0",
+    "vitest": "^4.1.6",
     "@repo/eslint-config": "0.0.1",
     "@repo/tsdown-config": "0.0.0",
     "@repo/typescript-config": "0.0.0"
@@ -32,7 +43,8 @@
     "unlink:packages": "pnpm unlink --global",
     "build:publish": "tsdown",
     "type-check": "tsc --noEmit",
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix"
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint --fix --max-warnings 0",
+    "test": "vitest run"
   }
 }

package/src/constants/dictionary.ts

@@ -1,4 +1,4 @@
-import type { LangCodeISO6393 } from "@/types/languages"
+import type { LangCodeISO6393 } from "#/types/languages"
 
 /**
  * This file is used to assemble a system prompt according to different languages.

package/src/constants/notebase-column.ts

@@ -0,0 +1,2 @@
+export const NOTEBASE_COLUMN_MIN_WIDTH = 100
+export const NOTEBASE_COLUMN_MAX_WIDTH = 500

package/src/index.ts

@@ -1,10 +1,13 @@
 export * from "./constants/app"
 export * from "./constants/auth"
 export * from "./constants/beta-access"
-export * from "./constants/column"
 export * from "./constants/dictionary"
+export * from "./constants/notebase-column"
 export * from "./constants/url"
 export * from "./schemas/cell-value"
 export * from "./schemas/version"
-export * from "./types/column"
+export * from "./types/card"
 export * from "./types/languages"
+export * from "./types/notebase-column"
+export * from "./types/srs"
+export * from "./utils/srs-day"

package/src/schemas/cell-value.ts

@@ -1,4 +1,4 @@
-import type { ColumnConfig } from "@/types/column"
+import type { NotebaseColumnConfig } from "#/types/notebase-column"
 
 import { z } from "zod"
 
@@ -6,7 +6,7 @@ import { z } from "zod"
  * Create a Zod schema for a cell value based on column config.
  * All cell schemas are nullable (empty cells are valid).
  */
-export function createCellSchema(config: ColumnConfig): z.ZodType {
+export function createCellSchema(config: NotebaseColumnConfig): z.ZodType {
   switch (config.type) {
     case "string":
       return z.string().nullable()
@@ -31,7 +31,7 @@ export function createCellSchema(config: ColumnConfig): z.ZodType {
  * Each column becomes a field in the object schema.
  */
 export function createRowSchema(
-  columns: Array<{ id: string, name: string, config: ColumnConfig }>,
+  columns: Array<{ id: string, name: string, config: NotebaseColumnConfig }>,
 ): z.ZodObject<Record<string, z.ZodType>> {
   const shape: Record<string, z.ZodType> = {}
 
@@ -48,7 +48,7 @@ export function createRowSchema(
  * Use this when generating prompts for LLMs that support structured outputs.
  */
 export function rowSchemaToJsonSchema(
-  columns: Array<{ id: string, name: string, config: ColumnConfig }>,
+  columns: Array<{ id: string, name: string, config: NotebaseColumnConfig }>,
 ) {
   return z.toJSONSchema(createRowSchema(columns))
 }

package/src/types/card.ts

@@ -0,0 +1,73 @@
+import { z } from "zod"
+
+export const CARD_STATE_VALUES = [
+  "new",
+  "learning",
+  "review",
+  "relearning",
+] as const
+
+export const SCHEDULE_STATUS_VALUES = [
+  "new",
+  "learning",
+  "review",
+  "suspended",
+  "buried",
+] as const
+
+export const cardStateSchema = z.enum(CARD_STATE_VALUES)
+export type CardState = z.infer<typeof cardStateSchema>
+
+export const scheduleStatusSchema = z.enum(SCHEDULE_STATUS_VALUES)
+export type ScheduleStatus = z.infer<typeof scheduleStatusSchema>
+
+export const CARD_STATE_TO_SCHEDULE_STATUS = {
+  new: "new",
+  learning: "learning",
+  relearning: "learning",
+  review: "review",
+} satisfies Record<CardState, Extract<ScheduleStatus, "new" | "learning" | "review">>
+
+export const basicCardTemplateConfigSchema = z.object({
+  type: z.literal("basic"),
+  frontPattern: z.string().min(1),
+  backPattern: z.string().min(1),
+}).strict()
+
+export const cardTemplateConfigSchema = z.discriminatedUnion("type", [
+  basicCardTemplateConfigSchema,
+])
+
+export type BasicCardTemplateConfig = z.infer<typeof basicCardTemplateConfigSchema>
+export type CardTemplateConfig = z.infer<typeof cardTemplateConfigSchema>
+
+export const cardIdentityShape = {
+  id: z.uuid(),
+  notebaseId: z.uuid(),
+  notebaseRowId: z.uuid(),
+  templateId: z.uuid(),
+  variantKey: z.string(),
+} satisfies z.ZodRawShape
+
+export const cardReviewStateShape = {
+  state: cardStateSchema,
+  scheduleStatus: scheduleStatusSchema,
+  dueAt: z.coerce.date(),
+  lastReviewTime: z.coerce.date().nullable(),
+  stability: z.number(),
+  difficulty: z.number(),
+  step: z.number().int(),
+  lapses: z.number().int(),
+  reps: z.number().int(),
+} satisfies z.ZodRawShape
+
+export const cardMemoryStateShape = {
+  ...cardReviewStateShape,
+  buriedAt: z.coerce.date().nullable(),
+} satisfies z.ZodRawShape
+
+export const cardReviewStateSchema = z.object(cardReviewStateShape)
+export type CardReviewState = z.infer<typeof cardReviewStateSchema>
+
+export const cardMemoryStateSchema = z.object(cardMemoryStateShape)
+export type CardMemoryState = z.infer<typeof cardMemoryStateSchema>

package/src/types/language-names/en.ts

@@ -0,0 +1,183 @@
+import type { LangCodeISO6393 } from "../languages"
+
+export const LANG_CODE_TO_EN_NAME = {
+  "eng": "English",
+  "cmn": "Simplified Mandarin Chinese",
+  "cmn-Hant": "Traditional Mandarin Chinese",
+  "yue": "Cantonese", // not supported by franc-min
+  "spa": "Spanish",
+  "rus": "Russian",
+  "arb": "Standard Arabic",
+  "ben": "Bengali",
+  "hin": "Hindi",
+  "por": "Portuguese",
+  "ind": "Indonesian",
+  "jpn": "Japanese",
+  "fra": "French",
+  "deu": "German",
+  "jav": "Javanese (Javanese)",
+  "kor": "Korean",
+  "tel": "Telugu",
+  "vie": "Vietnamese",
+  "mar": "Marathi",
+  "ita": "Italian",
+  "tam": "Tamil",
+  "tur": "Turkish",
+  "urd": "Urdu",
+  "guj": "Gujarati",
+  "pol": "Polish",
+  "ukr": "Ukrainian",
+  "kan": "Kannada",
+  "mai": "Maithili",
+  "mal": "Malayalam",
+  "pes": "Iranian Persian",
+  "mya": "Burmese",
+  "swh": "Swahili (individual language)",
+  "sun": "Sundanese",
+  "ron": "Romanian",
+  "pan": "Panjabi",
+  "bho": "Bhojpuri",
+  "amh": "Amharic",
+  "hau": "Hausa",
+  "fuv": "Nigerian Fulfulde",
+  "bos": "Bosnian (Cyrillic)",
+  "hrv": "Croatian",
+  "nld": "Dutch",
+  "srp": "Serbian (Cyrillic)",
+  "tha": "Thai",
+  "ckb": "Central Kurdish",
+  "yor": "Yoruba",
+  "uzn": "Northern Uzbek (Cyrillic)",
+  "zlm": "Malay (individual language) (Arabic)",
+  "ibo": "Igbo",
+  "npi": "Nepali (individual language)",
+  "ceb": "Cebuano",
+  "skr": "Saraiki",
+  "tgl": "Tagalog",
+  "hun": "Hungarian",
+  "azj": "North Azerbaijani (Cyrillic)",
+  "sin": "Sinhala",
+  "koi": "Komi-Permyak",
+  "ell": "Modern Greek (1453-)",
+  "ces": "Czech",
+  "mag": "Magahi",
+  "run": "Rundi",
+  "bel": "Belarusian",
+  "plt": "Plateau Malagasy",
+  "qug": "Chimborazo Highland Quichua",
+  "mad": "Madurese",
+  "nya": "Nyanja",
+  "zyb": "Yongbei Zhuang",
+  "pbu": "Northern Pashto",
+  "kin": "Kinyarwanda",
+  "zul": "Zulu",
+  "bul": "Bulgarian",
+  "swe": "Swedish",
+  "lin": "Lingala",
+  "som": "Somali",
+  "hms": "Southern Qiandong Miao",
+  "hnj": "Hmong Njua",
+  "ilo": "Iloko",
+  "kaz": "Kazakh",
+  "heb": "Hebrew",
+  "nob": "Norwegian Bokmål",
+  "nno": "Norwegian Nynorsk",
+  "afr": "Afrikaans",
+  "sqi": "Albanian",
+  "asm": "Assamese",
+  "eus": "Basque",
+  "bre": "Breton",
+  "cat": "Catalan",
+  "cos": "Corsican",
+  "cym": "Welsh",
+  "dan": "Danish",
+  "div": "Divehi",
+  "epo": "Esperanto",
+  "ekk": "Estonian",
+  "fao": "Faroese",
+  "fij": "Fijian",
+  "fin": "Finnish",
+  "fry": "Western Frisian",
+  "gla": "Scottish Gaelic",
+  "gle": "Irish",
+  "glg": "Galician",
+  "grn": "Guarani",
+  "hat": "Haitian Creole",
+  "haw": "Hawaiian",
+  "hye": "Armenian",
+  "ido": "Ido",
+  "ina": "Interlingua",
+  "isl": "Icelandic",
+  "kat": "Georgian",
+  "khm": "Khmer",
+  "kir": "Kyrgyz",
+  "lao": "Lao",
+  "lat": "Latin",
+  "lvs": "Latvian",
+  "lit": "Lithuanian",
+  "ltz": "Luxembourgish",
+  "mkd": "Macedonian",
+  "mlt": "Maltese",
+  "mon": "Mongolian",
+  "mri": "Maori",
+  "nso": "Northern Sotho",
+  "oci": "Occitan",
+  "ori": "Odia",
+  "orm": "Oromo",
+  "prs": "Dari",
+  "san": "Sanskrit",
+  "slk": "Slovak",
+  "slv": "Slovenian",
+  "smo": "Samoan",
+  "sna": "Shona",
+  "snd": "Sindhi",
+  "sot": "Southern Sotho",
+  "tah": "Tahitian",
+  "tat": "Tatar",
+  "tgk": "Tajik",
+  "tir": "Tigrinya",
+  "ton": "Tongan",
+  "tsn": "Tswana",
+  "tuk": "Turkmen",
+  "uig": "Uyghur",
+  "vol": "Volapük",
+  "wol": "Wolof",
+  "xho": "Xhosa",
+  "ydd": "Eastern Yiddish",
+  "aka": "Akan",
+  "bam": "Bambara",
+  "bis": "Bislama",
+  "bod": "Tibetan",
+  "che": "Chechen",
+  "chv": "Chuvash",
+  "dzo": "Dzongkha",
+  "ewe": "Ewe",
+  "kab": "Kabyle",
+  "lug": "Ganda",
+  "oss": "Ossetian",
+  "ssw": "Swati",
+  "ven": "Venda",
+  "war": "Waray",
+  "nde": "North Ndebele",
+  "nbl": "South Ndebele",
+  "pam": "Pampanga",
+  "hil": "Hiligaynon",
+  "bcl": "Central Bikol",
+  "min": "Minangkabau",
+  "ace": "Acehnese",
+  "bug": "Buginese",
+  "ban": "Balinese",
+  "bjn": "Banjar",
+  "mak": "Makasar",
+  "sas": "Sasak",
+  "tet": "Tetum",
+  "cha": "Chamorro",
+  "niu": "Niuean",
+  "tvl": "Tuvaluan",
+  "gil": "Gilbertese",
+  "mah": "Marshallese",
+  "pau": "Palauan",
+  "wls": "Wallisian",
+  "rar": "Rarotongan",
+  "hif": "Fiji Hindi",
+} satisfies Record<LangCodeISO6393, string>

package/src/types/language-names/locale.ts

@@ -0,0 +1,183 @@
+import type { LangCodeISO6393 } from "../languages"
+
+export const LANG_CODE_TO_LOCALE_NAME = {
+  "eng": "English",
+  "cmn": "简体中文",
+  "cmn-Hant": "繁體中文",
+  "yue": "粵語",
+  "spa": "Español",
+  "rus": "Русский",
+  "arb": "العربية",
+  "ben": "বাংলা",
+  "hin": "हिन्दी",
+  "por": "Português",
+  "ind": "Bahasa Indonesia",
+  "jpn": "日本語",
+  "fra": "Français",
+  "deu": "Deutsch",
+  "jav": "Basa Jawa",
+  "kor": "한국어",
+  "tel": "తెలుగు",
+  "vie": "Tiếng Việt",
+  "mar": "मराठी",
+  "ita": "Italiano",
+  "tam": "தமிழ்",
+  "tur": "Türkçe",
+  "urd": "اردو",
+  "guj": "ગુજરાતી",
+  "pol": "Polski",
+  "ukr": "Українська",
+  "kan": "ಕನ್ನಡ",
+  "mai": "मैथिली",
+  "mal": "മലയാളം",
+  "pes": "فارسی",
+  "mya": "မြန်မာစာ",
+  "swh": "Kiswahili",
+  "sun": "Basa Sunda",
+  "ron": "Română",
+  "pan": "ਪੰਜਾਬੀ",
+  "bho": "भोजपुरी",
+  "amh": "አማርኛ",
+  "hau": "Hausa",
+  "fuv": "Fulfulde",
+  "bos": "Босански",
+  "hrv": "Hrvatski",
+  "nld": "Nederlands",
+  "srp": "Српски",
+  "tha": "ไทย",
+  "ckb": "کوردیی ناوەندی",
+  "yor": "Yorùbá",
+  "uzn": "Ўзбекча",
+  "zlm": "بهاس ملايو",
+  "ibo": "Asụsụ Igbo",
+  "npi": "नेपाली",
+  "ceb": "Cebuano",
+  "skr": "سرائیکی",
+  "tgl": "Tagalog",
+  "hun": "Magyar",
+  "azj": "Азәрбајҹан дили",
+  "sin": "සිංහල",
+  "koi": "Перем Коми кыв",
+  "ell": "Ελληνικά",
+  "ces": "Čeština",
+  "mag": "मगही",
+  "run": "Ikirundi",
+  "bel": "Беларуская",
+  "plt": "Fiteny Malagasy",
+  "qug": "Kichwa",
+  "mad": "Madhurâ",
+  "nya": "Chinyanja",
+  "zyb": "Yongbei Bouxcuengh",
+  "pbu": "پښتو",
+  "kin": "Kinyarwanda",
+  "zul": "isiZulu",
+  "bul": "Български",
+  "swe": "Svenska",
+  "lin": "Lingála",
+  "som": "Af Soomaali",
+  "hms": "Hmongb Shuad",
+  "hnj": "Hmong Njua",
+  "ilo": "Ilokano",
+  "kaz": "Қазақ тілі",
+  "heb": "עברית",
+  "nob": "Norsk bokmål",
+  "nno": "Norsk nynorsk",
+  "afr": "Afrikaans",
+  "sqi": "Shqip",
+  "asm": "অসমীয়া",
+  "eus": "Euskara",
+  "bre": "Brezhoneg",
+  "cat": "Català",
+  "cos": "Corsu",
+  "cym": "Cymraeg",
+  "dan": "Dansk",
+  "div": "ދިވެހި",
+  "epo": "Esperanto",
+  "ekk": "Eesti",
+  "fao": "Føroyskt",
+  "fij": "Vosa Vakaviti",
+  "fin": "Suomi",
+  "fry": "Frysk",
+  "gla": "Gàidhlig",
+  "gle": "Gaeilge",
+  "glg": "Galego",
+  "grn": "Avañeʼẽ",
+  "hat": "Kreyòl ayisyen",
+  "haw": "ʻŌlelo Hawaiʻi",
+  "hye": "Հایերен",
+  "ido": "Ido",
+  "ina": "Interlingua",
+  "isl": "Íslenska",
+  "kat": "ქართული",
+  "khm": "ភាសាខ្មែរ",
+  "kir": "Кыргызча",
+  "lao": "ພາສາລາວ",
+  "lat": "Latina",
+  "lvs": "Latviešu",
+  "lit": "Lietuvių",
+  "ltz": "Lëtzebuergesch",
+  "mkd": "Македонски",
+  "mlt": "Malti",
+  "mon": "Монгол",
+  "mri": "Te Reo Māori",
+  "nso": "Sesotho sa Leboa",
+  "oci": "Occitan",
+  "ori": "ଓଡ଼ିଆ",
+  "orm": "Oromoo",
+  "prs": "دری",
+  "san": "संस्कृतम्",
+  "slk": "Slovenčina",
+  "slv": "Slovenščina",
+  "smo": "Gagana Samoa",
+  "sna": "chiShona",
+  "snd": "سنڌي",
+  "sot": "Sesotho",
+  "tah": "Reo Tahiti",
+  "tat": "Татарча",
+  "tgk": "Тоҷикӣ",
+  "tir": "ትግርኛ",
+  "ton": "Lea fakatonga",
+  "tsn": "Setswana",
+  "tuk": "Türkmençe",
+  "uig": "ئۇيغۇرچە",
+  "vol": "Volapük",
+  "wol": "Wolof",
+  "xho": "isiXhosa",
+  "ydd": "ייִדיש",
+  "aka": "Akan",
+  "bam": "Bamanankan",
+  "bis": "Bislama",
+  "bod": "བོད་སྐད",
+  "che": "Нохчийн",
+  "chv": "Чӑвашла",
+  "dzo": "རྫོང་ཁ",
+  "ewe": "Eʋegbe",
+  "kab": "Taqbaylit",
+  "lug": "Luganda",
+  "oss": "Ирон",
+  "ssw": "SiSwati",
+  "ven": "Tshivenḓa",
+  "war": "Winaray",
+  "nde": "isiNdebele",
+  "nbl": "isiNdebele seSewula",
+  "pam": "Kapampangan",
+  "hil": "Ilonggo",
+  "bcl": "Bikol Sentral",
+  "min": "Baso Minangkabau",
+  "ace": "Bahsa Acèh",
+  "bug": "Basa Ugi",
+  "ban": "Basa Bali",
+  "bjn": "Bahasa Banjar",
+  "mak": "Basa Mangkasara",
+  "sas": "Sasak",
+  "tet": "Tetun",
+  "cha": "Chamoru",
+  "niu": "Vagahau Niuē",
+  "tvl": "Te Gana Tuvalu",
+  "gil": "Taetae ni Kiribati",
+  "mah": "Kajin Majel",
+  "pau": "A tekoi er a Belau",
+  "wls": "Fakaʻuvea",
+  "rar": "Māori Kūki ʻĀirani",
+  "hif": "फ़िजी हिंदी",
+} satisfies Record<LangCodeISO6393, string>