@drincs/pixi-vn 1.8.12 → 1.8.14

package/dist/vite.d.ts

@@ -46,21 +46,26 @@ interface VitePluginPixivnOptions {
      */
     labels?: string | string[];
     /**
-     * Path to the auto-generated TypeScript declaration file that augments
-     * `PixivnCharacterIds` (in `@drincs/pixi-vn/characters`) and `PixivnLabelIds`
-     * (in `@drincs/pixi-vn/narration`) with all currently known IDs.
+     * Path to the auto-generated TypeScript file that combines compile-time type
+     * augmentations and runtime `as const` arrays for all currently known entity IDs.
      *
      * When provided, the plugin generates (or overwrites) this file:
      * - after all content modules have been loaded at startup,
      * - after every hot-reload of a watched content file,
      * - whenever `api.setExternalLabels` or `api.clearExternalLabels` is called.
      *
+     * The generated file contains:
+     * - `declare module` augmentations for `PixivnCharacterIds` and `PixivnLabelIds`,
+     *   narrowing `CharacterIdType` / `LabelIdType` to unions of known string literals.
+     * - `export const characterIds` and `export const labelIds` as `as const` arrays,
+     *   usable at runtime for validation (e.g. `z.enum(characterIds)`).
+     *
      * The generated file is **excluded from HMR** so that updating it never
      * triggers a full-page reload.
      *
      * The path may be absolute or relative to Vite `root`.
      *
-     * @example "./src/pixi-vn.gen.d.ts"
+     * @example "./src/pixi-vn.keys.gen.ts"
      */
     typeFilePath?: string;
 }
@@ -86,6 +91,13 @@ interface VitePluginPixivnOptions {
  * The file is regenerated whenever the character or label set changes (content reload or
  * external-label updates). It is **excluded from HMR** so regenerating it never triggers a page reload.
  *
+ * **Auto-generated list file**
+ *
+ * When {@link VitePluginPixivnOptions.listFilePath} is provided, the plugin writes a
+ * TypeScript file that exports runtime `as const` arrays of all currently known IDs:
+ * `characterIds` and `labelIds`. These arrays can be used for runtime validation
+ * (e.g. `z.enum(characterIds)`) and are regenerated on the same triggers as the type file.
+ *
  * **External label providers**
  *
  * Other Vite plugins can inject label IDs via the plugin API without needing to register

package/dist/vite.mjs

@@ -1,2 +1,2 @@
-import {a as a$1,b,c as c$1,d}from'./chunk-3BBZHKU4.mjs';export{c as PIXIVN_DEV_API_ASSETS_MANIFEST,d as PIXIVN_DEV_API_CANVAS_OPTIONS,a as PIXIVN_DEV_API_CHARACTERS,b as PIXIVN_DEV_API_LABELS}from'./chunk-3BBZHKU4.mjs';import {a,c}from'./chunk-K7JIC2F2.mjs';import {mkdirSync,writeFileSync,readFileSync}from'fs';import {isAbsolute,resolve,dirname}from'path';import {glob}from'tinyglobby';var F=a((ee,P)=>{var h=process||{},V=h.argv||[],f=h.env||{},G=!(f.NO_COLOR||V.includes("--no-color"))&&(!!f.FORCE_COLOR||V.includes("--color")||h.platform==="win32"||(h.stdout||{}).isTTY&&f.TERM!=="dumb"||!!f.CI),j=(i,e,c=i)=>d=>{let o=""+d,a=o.indexOf(e,i.length);return ~a?i+H(o,e,c,a)+e:i+o+e},H=(i,e,c,d)=>{let o="",a=0;do o+=i.substring(a,d)+c,a=d+e.length,d=i.indexOf(e,a);while(~d);return o+i.substring(a)},N=(i=G)=>{let e=i?j:()=>String;return {isColorSupported:i,reset:e("\x1B[0m","\x1B[0m"),bold:e("\x1B[1m","\x1B[22m","\x1B[22m\x1B[1m"),dim:e("\x1B[2m","\x1B[22m","\x1B[22m\x1B[2m"),italic:e("\x1B[3m","\x1B[23m"),underline:e("\x1B[4m","\x1B[24m"),inverse:e("\x1B[7m","\x1B[27m"),hidden:e("\x1B[8m","\x1B[28m"),strikethrough:e("\x1B[9m","\x1B[29m"),black:e("\x1B[30m","\x1B[39m"),red:e("\x1B[31m","\x1B[39m"),green:e("\x1B[32m","\x1B[39m"),yellow:e("\x1B[33m","\x1B[39m"),blue:e("\x1B[34m","\x1B[39m"),magenta:e("\x1B[35m","\x1B[39m"),cyan:e("\x1B[36m","\x1B[39m"),white:e("\x1B[37m","\x1B[39m"),gray:e("\x1B[90m","\x1B[39m"),bgBlack:e("\x1B[40m","\x1B[49m"),bgRed:e("\x1B[41m","\x1B[49m"),bgGreen:e("\x1B[42m","\x1B[49m"),bgYellow:e("\x1B[43m","\x1B[49m"),bgBlue:e("\x1B[44m","\x1B[49m"),bgMagenta:e("\x1B[45m","\x1B[49m"),bgCyan:e("\x1B[46m","\x1B[49m"),bgWhite:e("\x1B[47m","\x1B[49m"),blackBright:e("\x1B[90m","\x1B[39m"),redBright:e("\x1B[91m","\x1B[39m"),greenBright:e("\x1B[92m","\x1B[39m"),yellowBright:e("\x1B[93m","\x1B[39m"),blueBright:e("\x1B[94m","\x1B[39m"),magentaBright:e("\x1B[95m","\x1B[39m"),cyanBright:e("\x1B[96m","\x1B[39m"),whiteBright:e("\x1B[97m","\x1B[39m"),bgBlackBright:e("\x1B[100m","\x1B[49m"),bgRedBright:e("\x1B[101m","\x1B[49m"),bgGreenBright:e("\x1B[102m","\x1B[49m"),bgYellowBright:e("\x1B[103m","\x1B[49m"),bgBlueBright:e("\x1B[104m","\x1B[49m"),bgMagentaBright:e("\x1B[105m","\x1B[49m"),bgCyanBright:e("\x1B[106m","\x1B[49m"),bgWhiteBright:e("\x1B[107m","\x1B[49m")}};P.exports=N();P.exports.createColors=N;});var _=c(F(),1);var C=_.default.cyan("(pixi-vn)");function A(i){return i?Array.isArray(i)?i:[i]:[]}function Z(i){let e=[],c=[];for(let d of i)try{let o=readFileSync(d,"utf-8"),a=/newLabel\(\s*["']([^"']+)["']/g,m;for(;(m=a.exec(o))!==null;)c.push(m[1]);let b=/new\s+\w*[Cc]haracter\(\s*["']([^"']+)["']/g;for(;(m=b.exec(o))!==null;)e.push(m[1]);}catch{}return {charIds:e,labelIds:c}}function q(i){let e,c,d$1=new Promise(t=>{c=t;}),o=[...A(i?.content),...A(i?.characters),...A(i?.labels)],a=[],m=[],b$1=new Set,E=[],p=new Map;function O(){if(!i?.typeFilePath||!e)return null;let t=i.typeFilePath;return isAbsolute(t)?t:resolve(e.root,t)}function M(){let t=[...m,...Array.from(p.values()).flat()];return Array.from(new Set(t))}function k(t,n,s){mkdirSync(dirname(t),{recursive:true});let r=["// @ts-nocheck","/* eslint-disable */","// noinspection JSUnusedGlobalSymbols","// This file is auto-generated by @drincs/pixi-vn vite plugin. Do not edit manually."];if(n.length>0){r.push('declare module "@drincs/pixi-vn/characters" {'),r.push("    interface PixivnCharacterIds {");for(let l of n)r.push(`        ${JSON.stringify(l)}: never;`);r.push("    }"),r.push("}");}if(s.length>0){r.push('declare module "@drincs/pixi-vn/narration" {'),r.push("    interface PixivnLabelIds {");for(let l of s)r.push(`        ${JSON.stringify(l)}: never;`);r.push("    }"),r.push("}");}r.push("export {};"),r.push(""),writeFileSync(t,r.join(`
-`),"utf-8");}function u(){let t=O();if(t)try{k(t,a.map(n=>n.id),M());}catch(n){e?.logger.error(`${C} Failed to write type file "${t}".`,{error:n instanceof Error?n:new Error(String(n)),timestamp:true});}}async function R(t,n=[]){try{a=(await t("@drincs/pixi-vn/characters")).RegisteredCharacters?.values()??[];}catch{a=[];}try{m=(await t("@drincs/pixi-vn/narration")).RegisteredLabels?.keys()??[];}catch{m=[];}if(n.length>0){let{charIds:r,labelIds:l}=Z(n),y=new Set(a.map(g=>g.id)),$=new Set(m);for(let g of r)y.has(g)||a.push({id:g});for(let g of l)$.has(g)||m.push(g);}let s=a.map(r=>r.id).join(", ")||"none";e?.logger.info(`${C} ${_.default.dim(`${a.length} character(s): [${s}], ${m.length} label(s)`)}`,{timestamp:true});}async function B(t,n){try{await t("@drincs/pixi-vn/characters");}catch{}try{await t("@drincs/pixi-vn/narration");}catch{}let s=await glob(o,{cwd:n,absolute:true,onlyFiles:true}),r=[];for(let l of s){b$1.add(l);try{await t(l);}catch{r.push(l);}}await R(t,r),u(),c();}async function D(t){for(let r of b$1)for(let l of t.moduleGraph.getModulesByFile(r)??[])t.moduleGraph.invalidateModule(l);try{(await t.ssrLoadModule("@drincs/pixi-vn/characters")).registeredCharacters?.clear?.();}catch{}let n=await glob(o,{cwd:e.root,absolute:true,onlyFiles:true}),s=[];for(let r of n){b$1.add(r);try{await t.ssrLoadModule(r);}catch{s.push(r);}}await R(r=>t.ssrLoadModule(r),s),u();for(let r of E)r();}let L={characters:null,labels:null,manifest:null,canvasOptions:null};function x(t,n){return (s,r)=>{if(r.setHeader("Content-Type","application/json"),s.method==="GET"){let l=L[t];if(l===null){r.statusCode=404,r.end(JSON.stringify({error:`${n} not initialized`}));return}r.statusCode=200,r.end(JSON.stringify(l));return}if(s.method==="POST"){let l="";s.on("data",y=>{l+=y.toString();}),s.on("end",()=>{try{L[t]=JSON.parse(l),r.statusCode=201,r.end(JSON.stringify({message:`${n} updated successfully`}));}catch{r.statusCode=400,r.end(JSON.stringify({error:`Invalid JSON format for ${n}`}));}});}}}return {name:"vite-plugin-pixi-vn",enforce:"pre",api:{contentLoaded:d$1,get characters(){return a},onReload(t){E.push(t);},setExternalLabels(t,n){p.set(t,n),u();},clearExternalLabels(t){p.delete(t),u();}},config(t,n){if(n.command==="serve"&&o.length>0)return {ssr:{noExternal:["@drincs/pixi-vn"]}}},configResolved(t){e=t,o.length===0&&c();},async buildStart(){if(e?.command!=="build"||o.length===0)return;let{createServer:t}=await import('vite'),n=await t({root:e.root,configFile:false,server:{middlewareMode:true},appType:"custom",logLevel:"silent",optimizeDeps:{noDiscovery:true},ssr:{noExternal:["@drincs/pixi-vn"]}});try{await B(s=>n.ssrLoadModule(s),e.root);}catch{c();}finally{await n.close();}},configureServer(t){o.length>0&&B(n=>t.ssrLoadModule(n),e.root).catch(()=>{c();}),t.middlewares.use(a$1,x("characters","Characters")),t.middlewares.use(b,x("labels","Labels")),t.middlewares.use(c$1,x("manifest","Manifest")),t.middlewares.use(d,x("canvasOptions","Canvas options"));},hotUpdate({file:t,server:n}){let s=O();if(s&&t===s)return [];if(o.length>0&&b$1.has(t))return D(n).catch(r=>{e?.logger.error(`${C} Failed to reload content.`,{error:r instanceof Error?r:new Error(String(r)),timestamp:true});}),[]}}}export{q as vitePluginPixivn};
+import {a as a$1,b,c as c$1,d}from'./chunk-3BBZHKU4.mjs';export{c as PIXIVN_DEV_API_ASSETS_MANIFEST,d as PIXIVN_DEV_API_CANVAS_OPTIONS,a as PIXIVN_DEV_API_CHARACTERS,b as PIXIVN_DEV_API_LABELS}from'./chunk-3BBZHKU4.mjs';import {a,c}from'./chunk-K7JIC2F2.mjs';import {mkdirSync,writeFileSync,readFileSync}from'fs';import {isAbsolute,resolve,dirname}from'path';import {glob}from'tinyglobby';var F=a((ee,P)=>{var h=process||{},N=h.argv||[],f=h.env||{},G=!(f.NO_COLOR||N.includes("--no-color"))&&(!!f.FORCE_COLOR||N.includes("--color")||h.platform==="win32"||(h.stdout||{}).isTTY&&f.TERM!=="dumb"||!!f.CI),j=(i,e,c=i)=>d=>{let o=""+d,a=o.indexOf(e,i.length);return ~a?i+H(o,e,c,a)+e:i+o+e},H=(i,e,c,d)=>{let o="",a=0;do o+=i.substring(a,d)+c,a=d+e.length,d=i.indexOf(e,a);while(~d);return o+i.substring(a)},V=(i=G)=>{let e=i?j:()=>String;return {isColorSupported:i,reset:e("\x1B[0m","\x1B[0m"),bold:e("\x1B[1m","\x1B[22m","\x1B[22m\x1B[1m"),dim:e("\x1B[2m","\x1B[22m","\x1B[22m\x1B[2m"),italic:e("\x1B[3m","\x1B[23m"),underline:e("\x1B[4m","\x1B[24m"),inverse:e("\x1B[7m","\x1B[27m"),hidden:e("\x1B[8m","\x1B[28m"),strikethrough:e("\x1B[9m","\x1B[29m"),black:e("\x1B[30m","\x1B[39m"),red:e("\x1B[31m","\x1B[39m"),green:e("\x1B[32m","\x1B[39m"),yellow:e("\x1B[33m","\x1B[39m"),blue:e("\x1B[34m","\x1B[39m"),magenta:e("\x1B[35m","\x1B[39m"),cyan:e("\x1B[36m","\x1B[39m"),white:e("\x1B[37m","\x1B[39m"),gray:e("\x1B[90m","\x1B[39m"),bgBlack:e("\x1B[40m","\x1B[49m"),bgRed:e("\x1B[41m","\x1B[49m"),bgGreen:e("\x1B[42m","\x1B[49m"),bgYellow:e("\x1B[43m","\x1B[49m"),bgBlue:e("\x1B[44m","\x1B[49m"),bgMagenta:e("\x1B[45m","\x1B[49m"),bgCyan:e("\x1B[46m","\x1B[49m"),bgWhite:e("\x1B[47m","\x1B[49m"),blackBright:e("\x1B[90m","\x1B[39m"),redBright:e("\x1B[91m","\x1B[39m"),greenBright:e("\x1B[92m","\x1B[39m"),yellowBright:e("\x1B[93m","\x1B[39m"),blueBright:e("\x1B[94m","\x1B[39m"),magentaBright:e("\x1B[95m","\x1B[39m"),cyanBright:e("\x1B[96m","\x1B[39m"),whiteBright:e("\x1B[97m","\x1B[39m"),bgBlackBright:e("\x1B[100m","\x1B[49m"),bgRedBright:e("\x1B[101m","\x1B[49m"),bgGreenBright:e("\x1B[102m","\x1B[49m"),bgYellowBright:e("\x1B[103m","\x1B[49m"),bgBlueBright:e("\x1B[104m","\x1B[49m"),bgMagentaBright:e("\x1B[105m","\x1B[49m"),bgCyanBright:e("\x1B[106m","\x1B[49m"),bgWhiteBright:e("\x1B[107m","\x1B[49m")}};P.exports=V();P.exports.createColors=V;});var _=c(F(),1);var C=_.default.cyan("(pixi-vn)");function A(i){return i?Array.isArray(i)?i:[i]:[]}function Z(i){let e=[],c=[];for(let d of i)try{let o=readFileSync(d,"utf-8"),a=/newLabel\(\s*["']([^"']+)["']/g,m;for(;(m=a.exec(o))!==null;)c.push(m[1]);let b=/new\s+\w*[Cc]haracter\(\s*["']([^"']+)["']/g;for(;(m=b.exec(o))!==null;)e.push(m[1]);}catch{}return {charIds:e,labelIds:c}}function q(i){let e,c,d$1=new Promise(t=>{c=t;}),o=[...A(i?.content),...A(i?.characters),...A(i?.labels)],a=[],m=[],b$1=new Set,O=[],p=new Map;function E(){if(!i?.typeFilePath||!e)return null;let t=i.typeFilePath;return isAbsolute(t)?t:resolve(e.root,t)}function T(){let t=[...m,...Array.from(p.values()).flat()];return Array.from(new Set(t))}function $(t,n,s){mkdirSync(dirname(t),{recursive:true});let r=["/* eslint-disable */","// noinspection JSUnusedGlobalSymbols","// This file is auto-generated by @drincs/pixi-vn vite plugin. Do not edit manually."];if(n.length>0){r.push('declare module "@drincs/pixi-vn/characters" {'),r.push("    interface PixivnCharacterIds {");for(let l of n)r.push(`        ${JSON.stringify(l)}: never;`);r.push("    }"),r.push("}");}if(s.length>0){r.push('declare module "@drincs/pixi-vn/narration" {'),r.push("    interface PixivnLabelIds {");for(let l of s)r.push(`        ${JSON.stringify(l)}: never;`);r.push("    }"),r.push("}");}r.push(`export const characterIds = ${JSON.stringify(n)} as const;`),r.push(`export const labelIds = ${JSON.stringify(s)} as const;`),r.push(""),writeFileSync(t,r.join(`
+`),"utf-8");}function u(){let t=E();if(t)try{$(t,a.map(n=>n.id),T());}catch(n){e?.logger.error(`${C} Failed to write keys file "${t}".`,{error:n instanceof Error?n:new Error(String(n)),timestamp:true});}}async function R(t,n=[]){try{a=(await t("@drincs/pixi-vn/characters")).RegisteredCharacters?.values()??[];}catch{a=[];}try{m=(await t("@drincs/pixi-vn/narration")).RegisteredLabels?.keys()??[];}catch{m=[];}if(n.length>0){let{charIds:r,labelIds:l}=Z(n),y=new Set(a.map(g=>g.id)),D=new Set(m);for(let g of r)y.has(g)||a.push({id:g});for(let g of l)D.has(g)||m.push(g);}let s=a.map(r=>r.id).join(", ")||"none";e?.logger.info(`${C} ${_.default.dim(`${a.length} character(s): [${s}], ${m.length} label(s)`)}`,{timestamp:true});}async function L(t,n){try{await t("@drincs/pixi-vn/characters");}catch{}try{await t("@drincs/pixi-vn/narration");}catch{}let s=await glob(o,{cwd:n,absolute:true,onlyFiles:true}),r=[];for(let l of s){b$1.add(l);try{await t(l);}catch{r.push(l);}}await R(t,r),u(),c();}async function k(t){for(let r of b$1)for(let l of t.moduleGraph.getModulesByFile(r)??[])t.moduleGraph.invalidateModule(l);try{(await t.ssrLoadModule("@drincs/pixi-vn/characters")).RegisteredCharacters?.clear?.();}catch{}try{(await t.ssrLoadModule("@drincs/pixi-vn/narration")).RegisteredLabels?.clear?.();}catch{}let n=await glob(o,{cwd:e.root,absolute:true,onlyFiles:true}),s=[];for(let r of n){b$1.add(r);try{await t.ssrLoadModule(r);}catch{s.push(r);}}await R(r=>t.ssrLoadModule(r),s),u();for(let r of O)r();}let B={characters:null,labels:null,manifest:null,canvasOptions:null};function x(t,n){return (s,r)=>{if(r.setHeader("Content-Type","application/json"),s.method==="GET"){let l=B[t];if(l===null){r.statusCode=404,r.end(JSON.stringify({error:`${n} not initialized`}));return}r.statusCode=200,r.end(JSON.stringify(l));return}if(s.method==="POST"){let l="";s.on("data",y=>{l+=y.toString();}),s.on("end",()=>{try{B[t]=JSON.parse(l),r.statusCode=201,r.end(JSON.stringify({message:`${n} updated successfully`}));}catch{r.statusCode=400,r.end(JSON.stringify({error:`Invalid JSON format for ${n}`}));}});}}}return {name:"vite-plugin-pixi-vn",enforce:"pre",api:{contentLoaded:d$1,get characters(){return a},onReload(t){O.push(t);},setExternalLabels(t,n){p.set(t,n),u();},clearExternalLabels(t){p.delete(t),u();}},config(t,n){if(n.command==="serve"&&o.length>0)return {ssr:{noExternal:["@drincs/pixi-vn"]}}},configResolved(t){e=t,o.length===0&&c();},async buildStart(){if(e?.command!=="build"||o.length===0)return;let{createServer:t}=await import('vite'),n=await t({root:e.root,configFile:false,server:{middlewareMode:true},appType:"custom",logLevel:"silent",optimizeDeps:{noDiscovery:true},ssr:{noExternal:["@drincs/pixi-vn"]}});try{await L(s=>n.ssrLoadModule(s),e.root);}catch{c();}finally{await n.close();}},configureServer(t){o.length>0&&L(n=>t.ssrLoadModule(n),e.root).catch(()=>{c();}),t.middlewares.use(a$1,x("characters","Characters")),t.middlewares.use(b,x("labels","Labels")),t.middlewares.use(c$1,x("manifest","Manifest")),t.middlewares.use(d,x("canvasOptions","Canvas options"));},hotUpdate({file:t,server:n}){let s=E();if(s&&t===s)return [];if(o.length>0&&b$1.has(t))return k(n).catch(r=>{e?.logger.error(`${C} Failed to reload content.`,{error:r instanceof Error?r:new Error(String(r)),timestamp:true});}),[]}}}export{q as vitePluginPixivn};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drincs/pixi-vn",
-  "version": "1.8.12",
+  "version": "1.8.14",
   "type": "module",
   "description": "Pixi'VN is a npm package that provides various features for creating visual novels.",
   "main": "./dist/index.cjs",
@@ -14,7 +14,7 @@
   ],
   "scripts": {
     "dev": "tsup --watch",
-    "build": "tsup --config tsup.config.ts && node scripts/fix-imports.mjs",
+    "build": "tsup --config tsup.config.ts",
     "lint": "biome lint",
     "check": "biome check",
     "format": "biome format --write",