@arisutalk/character-spec 0.0.0 → 0.0.2

package/dist/index.d.ts

@@ -1,166 +1,15 @@
-import { ArraySchema } from 'valibot';
-import { BooleanSchema } from 'valibot';
-import { CheckAction } from 'valibot';
-import { CustomSchema } from 'valibot';
-import { IntegerAction } from 'valibot';
-import { LiteralSchema } from 'valibot';
-import { MinValueAction } from 'valibot';
-import { NumberSchema } from 'valibot';
-import { ObjectSchema } from 'valibot';
-import { OptionalSchema } from 'valibot';
-import { PicklistSchema } from 'valibot';
-import { SchemaWithPipe } from 'valibot';
-import { StringSchema } from 'valibot';
-import { UrlAction } from 'valibot';
-import * as v from 'valibot';
-
-/**
- * Represents a specific AI character personality.
- */
-declare type Character = v.InferOutput<typeof CharacterSchema>;
-
-export declare type CharacterMap = {
-    "0": Character;
-};
-
-declare const characterMap: {
-    readonly 0: ObjectSchema<    {
-    readonly specVersion: LiteralSchema<0, undefined>;
-    readonly id: StringSchema<undefined>;
-    readonly name: StringSchema<undefined>;
-    readonly description: StringSchema<undefined>;
-    readonly avatarUrl: OptionalSchema<SchemaWithPipe<readonly [StringSchema<undefined>, UrlAction<string, undefined>]>, undefined>;
-    readonly prompt: ObjectSchema<    {
-    readonly description: StringSchema<undefined>;
-    readonly authorsNote: StringSchema<undefined>;
-    readonly lorebook: ObjectSchema<    {
-    readonly config: ObjectSchema<    {
-    readonly tokenLimit: SchemaWithPipe<readonly [NumberSchema<undefined>, IntegerAction<number, undefined>, MinValueAction<number, 1, undefined>]>;
-    }, undefined>;
-    readonly data: OptionalSchema<SchemaWithPipe<readonly [ArraySchema<ObjectSchema<    {
-    readonly id: OptionalSchema<StringSchema<undefined>, undefined>;
-    readonly name: StringSchema<undefined>;
-    readonly condition: OptionalSchema<ArraySchema<CustomSchema<    {
-    type: "regex_match";
-    regexPattern: string;
-    regexFlags?: string | undefined;
-    } | {
-    type: "plain_text_match";
-    text: string;
-    } | {
-    type: "always";
-    }, undefined>, undefined>, undefined>;
-    readonly multipleConditionResolveStrategy: OptionalSchema<PicklistSchema<["all", "any"], undefined>, undefined>;
-    readonly content: StringSchema<undefined>;
-    readonly priority: OptionalSchema<NumberSchema<undefined>, undefined>;
-    readonly enabled: OptionalSchema<BooleanSchema<undefined>, undefined>;
-    }, undefined>, undefined>, CheckAction<    {
-    id?: string | undefined;
-    name: string;
-    condition?: ({
-    type: "regex_match";
-    regexPattern: string;
-    regexFlags?: string | undefined;
-    } | {
-    type: "plain_text_match";
-    text: string;
-    } | {
-    type: "always";
-    })[] | undefined;
-    multipleConditionResolveStrategy?: "all" | "any" | undefined;
-    content: string;
-    priority?: number | undefined;
-    enabled?: boolean | undefined;
-    }[], "Duplicated id is not allowed.">]>, readonly []>;
-    }, undefined>;
-    }, undefined>;
-    }, undefined>;
-};
-export { characterMap }
-export default characterMap;
-
-/**
- * @see {@link Character}
- */
-declare const CharacterSchema: v.ObjectSchema<{
-    /**
-     * The version of the character spec.
-     * This is used to determine which schema to use for parsing.
-     * Also tries to migrate the character to the latest version.
-     */
-    readonly specVersion: v.LiteralSchema<0, undefined>;
-    /**
-     * Unique identifier for the character.
-     */
-    readonly id: v.StringSchema<undefined>;
-    /**
-     * The display name of the character.
-     * Human readable, not scriptable.
-     */
-    readonly name: v.StringSchema<undefined>;
-    /**
-     * A short description of the character.
-     * Human readable, not scriptable.
-     */
-    readonly description: v.StringSchema<undefined>;
-    /**
-     * Optional URL for the character's avatar image.
-     */
-    readonly avatarUrl: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, undefined>]>, undefined>;
-    readonly prompt: v.ObjectSchema<{
-        /**
-         * The character description.
-         */
-        readonly description: v.StringSchema<undefined>;
-        /**
-         * The authors note. It's usually used to mock the user's message(differ by prompt).
-         */
-        readonly authorsNote: v.StringSchema<undefined>;
-        /**
-         * Lorebook data.
-         * @see {@link LorebookDataSchema}
-         */
-        readonly lorebook: v.ObjectSchema<{
-            readonly config: v.ObjectSchema<{
-                readonly tokenLimit: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
-            }, undefined>;
-            readonly data: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
-                readonly id: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-                readonly name: v.StringSchema<undefined>;
-                readonly condition: v.OptionalSchema<v.ArraySchema<v.CustomSchema<{
-                    type: "regex_match";
-                    regexPattern: string;
-                    regexFlags?: string | undefined;
-                } | {
-                    type: "plain_text_match";
-                    text: string;
-                } | {
-                    type: "always";
-                }, undefined>, undefined>, undefined>;
-                readonly multipleConditionResolveStrategy: v.OptionalSchema<v.PicklistSchema<["all", "any"], undefined>, undefined>;
-                readonly content: v.StringSchema<undefined>;
-                readonly priority: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-                readonly enabled: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-            }, undefined>, undefined>, v.CheckAction<{
-                id?: string | undefined;
-                name: string;
-                condition?: ({
-                    type: "regex_match";
-                    regexPattern: string;
-                    regexFlags?: string | undefined;
-                } | {
-                    type: "plain_text_match";
-                    text: string;
-                } | {
-                    type: "always";
-                })[] | undefined;
-                multipleConditionResolveStrategy?: "all" | "any" | undefined;
-                content: string;
-                priority?: number | undefined;
-                enabled?: boolean | undefined;
-            }[], "Duplicated id is not allowed.">]>, readonly []>;
-        }, undefined>;
-    }, undefined>;
-}, undefined>;
-
-export { }
+// Auto-generated TypeScript types from Zod schemas
+import type { z } from "zod";
+import type { Character as CharacterV0 } from "./v0/Character/Character";
+export { CharacterV0 };
+export { CharacterSchema as CharacterV0Schema } from "./v0/Character/Character";
+
+export declare const characterMap: {
+    readonly 0: z.ZodType<CharacterV0>;
+};
+
+export type CharacterMap = {
+    "0": CharacterV0;
+};
+
+export default characterMap;

package/dist/index.js

@@ -1,4 +1,4 @@
-import { C as a } from "./Character-Didq99iq.js";
+import { CharacterSchema as a } from "./v0/Character/Character.js";
 const t = {
   0: a
 };

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import {\n    type Character as CharacterV0,\n    CharacterSchema as CharacterV0Schema,\n} from \"@/types/v0/Character\";\n\nexport const characterMap = {\n    0: CharacterV0Schema,\n} as const;\nexport type CharacterMap = {\n    \"0\": CharacterV0;\n};\n\nexport default characterMap;\n"],"names":["characterMap","CharacterV0Schema"],"mappings":";AAKO,MAAMA,IAAe;AAAA,EACxB,GAAGC;AACP;"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["import {\n    type Character as CharacterV0,\n    CharacterSchema as CharacterV0Schema,\n} from \"@/types/v0/Character/Character\";\n\nexport const characterMap = {\n    0: CharacterV0Schema,\n} as const;\nexport type CharacterMap = {\n    \"0\": CharacterV0;\n};\n\nexport default characterMap;\n"],"names":["characterMap","CharacterV0Schema"],"mappings":";AAKO,MAAMA,IAAe;AAAA,EACxB,GAAGC;AACP;"}

package/dist/v0/Character/Assets.d.ts

@@ -0,0 +1,37 @@
+// Auto-generated TypeScript types from Zod schemas
+// JSDoc comments are extracted from schema .meta({ description }) values
+import type { z } from "zod";
+
+export type AssetsSetting = {
+    /** The assets of the character. */
+    assets: {
+        /** The URL of the asset. */
+        url: string;
+        /** MIME type of the asset. Usually `image/*` or `video/*`. */
+        mimeType: string;
+        /** The name of the asset. Used as the file name. Should be unique. */
+        name: string;
+    }[];
+    /** The inlays of the character. It is not intended to be exported as public. */
+    inlays: {
+        /** The URL of the asset. */
+        url: string;
+        /** MIME type of the asset. Usually `image/*` or `video/*`. */
+        mimeType: string;
+        /** The name of the asset. Used as the file name. Should be unique. */
+        name: string;
+    }[];
+};
+
+export declare const AssetsSettingSchema: z.ZodType<AssetsSetting>;
+
+export type AssetEntity = {
+    /** The URL of the asset. */
+    url: string;
+    /** MIME type of the asset. Usually `image/*` or `video/*`. */
+    mimeType: string;
+    /** The name of the asset. Used as the file name. Should be unique. */
+    name: string;
+};
+
+export declare const AssetEntitySchema: z.ZodType<AssetEntity>;

package/dist/v0/Character/Assets.js

@@ -0,0 +1,21 @@
+import { z as e } from "zod";
+import { ImageURLSchema as a, unique as t } from "../utils.js";
+const s = e.object({
+  url: a.meta({ description: "The URL of the asset." }),
+  mimeType: e.string().meta({
+    description: "MIME type of the asset. Usually `image/*` or `video/*`."
+  }),
+  name: e.string().meta({
+    description: "The name of the asset. Used as the file name. Should be unique."
+  })
+}), o = e.object({
+  assets: e.array(s).refine(t("name"), { message: "Not unique key: name" }).meta({ description: "The assets of the character." }),
+  inlays: e.array(s).refine(t("name"), { message: "Not unique key: name" }).meta({
+    description: "The inlays of the character. It is not intended to be exported as public."
+  })
+}).meta({ description: "Settings for character assets." });
+export {
+  s as AssetEntitySchema,
+  o as AssetsSettingSchema
+};
+//# sourceMappingURL=Assets.js.map

package/dist/v0/Character/Assets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Assets.js","sources":["../../../src/types/v0/Character/Assets.ts"],"sourcesContent":["import { z } from \"zod\";\nimport { ImageURLSchema, unique } from \"@/types/v0/utils\";\n\nexport const AssetEntitySchema = z.object({\n    url: ImageURLSchema.meta({ description: \"The URL of the asset.\" }),\n    mimeType: z.string().meta({\n        description: \"MIME type of the asset. Usually `image/*` or `video/*`.\",\n    }),\n    name: z.string().meta({\n        description:\n            \"The name of the asset. Used as the file name. Should be unique.\",\n    }),\n});\n\n/**\n * @see {@link AssetsSetting}\n */\nexport const AssetsSettingSchema = z\n    .object({\n        assets: z\n            .array(AssetEntitySchema)\n            .refine(unique(\"name\"), { message: \"Not unique key: name\" })\n            .meta({ description: \"The assets of the character.\" }),\n        inlays: z\n            .array(AssetEntitySchema)\n            .refine(unique(\"name\"), { message: \"Not unique key: name\" })\n            .meta({\n                description:\n                    \"The inlays of the character. It is not intended to be exported as public.\",\n            }),\n    })\n    .meta({ description: \"Settings for character assets.\" });\n\n/**\n * This is the settings for character assets.\n */\nexport type AssetsSetting = z.infer<typeof AssetsSettingSchema>;\n"],"names":["AssetEntitySchema","z","ImageURLSchema","AssetsSettingSchema","unique"],"mappings":";;AAGO,MAAMA,IAAoBC,EAAE,OAAO;AAAA,EACtC,KAAKC,EAAe,KAAK,EAAE,aAAa,yBAAyB;AAAA,EACjE,UAAUD,EAAE,OAAA,EAAS,KAAK;AAAA,IACtB,aAAa;AAAA,EAAA,CAChB;AAAA,EACD,MAAMA,EAAE,OAAA,EAAS,KAAK;AAAA,IAClB,aACI;AAAA,EAAA,CACP;AACL,CAAC,GAKYE,IAAsBF,EAC9B,OAAO;AAAA,EACJ,QAAQA,EACH,MAAMD,CAAiB,EACvB,OAAOI,EAAO,MAAM,GAAG,EAAE,SAAS,wBAAwB,EAC1D,KAAK,EAAE,aAAa,gCAAgC;AAAA,EACzD,QAAQH,EACH,MAAMD,CAAiB,EACvB,OAAOI,EAAO,MAAM,GAAG,EAAE,SAAS,uBAAA,CAAwB,EAC1D,KAAK;AAAA,IACF,aACI;AAAA,EAAA,CACP;AACT,CAAC,EACA,KAAK,EAAE,aAAa,kCAAkC;"}

package/dist/v0/Character/Character.d.ts

@@ -0,0 +1,263 @@
+// Auto-generated TypeScript types from Zod schemas
+// JSDoc comments are extracted from schema .meta({ description }) values
+import type { z } from "zod";
+
+export type Character = {
+    /** The version of the character spec. Used to determine which schema to use for parsing and migration. */
+    specVersion: 0;
+    /** Unique identifier for the character. */
+    id: string;
+    /** The display name of the character. Human readable, not scriptable. */
+    name: string;
+    /** A short description of the character. Human readable, not scriptable. */
+    description: string;
+    /** Optional URL for the character's avatar image. */
+    avatarUrl?: string | undefined;
+    /** The prompt data for the character. */
+    prompt: {
+        /** The character description. */
+        description: string;
+        /** The authors note. It's usually used to mock the user's message (differ by prompt). */
+        authorsNote: string;
+        /** Lorebook data. */
+        lorebook: {
+            /** The configuration for the lorebook. Not scriptable. */
+            config: {
+                /** The token limit for the lorebook. When exceeded, low-priority lorebooks will be deactivated. Positive integer. */
+                tokenLimit: number;
+            };
+            /** Contains the actual lorebooks. Duplicated id is not allowed. */
+            data: {
+                /** Internally generated ID. */
+                id: string;
+                /** Human readable name for the lorebook. */
+                name: string;
+                /** The condition for the lorebook to be activated. If empty, it will not be activated. Use 'always' to activate without any condition. */
+                condition: ({
+                    /** This condition matches the regex pattern. */
+                    type: "regex_match";
+                    /** The regex pattern to match. Scriptable. */
+                    regexPattern: string;
+                    /** The regex flags to use. Not scriptable. */
+                    regexFlags?: string | undefined;
+                } | {
+                    /** This condition simply matches the text. */
+                    type: "plain_text_match";
+                    /** The text to match. Scriptable. Case insensitive. */
+                    text: string;
+                } | {
+                    /** This condition is always true. */
+                    type: "always";
+                })[];
+                /** The strategy for resolving multiple conditions. 'all' means all must be met, 'any' means at least one. */
+                multipleConditionResolveStrategy?: ("all" | "any") | undefined;
+                /** The lorebook content to be added on AI prompt. Not for human reading. Scriptable. */
+                content: string;
+                /** The priority of the lorebook. Higher priority means it will be activated first. May be negative or decimal. Base is 0. */
+                priority?: number | undefined;
+                /** Whether the lorebook is enabled. */
+                enabled?: boolean | undefined;
+            }[];
+        };
+    };
+    /** Script and hooks which can be used to control the character's behavior. */
+    executables: {
+        /** Runtime settings for the script. Controls runtime environment. All values capped at user's configuration. */
+        runtimeSetting: {
+            /** The maximum memory usage of the script, in MB. Not an exact limit. May be exceeded or ignored. */
+            mem?: number | undefined;
+        };
+        /** Replace hooks for the script. */
+        replaceHooks: {
+            /** Replace hooks for display. Doesn't edit the data, only changes the display. */
+            display: {
+                /** The input pattern. May contain additional javascript expression if `isInputPatternScripted` is true. */
+                input: string;
+                /** The meta data for the replace hook. */
+                meta: ({
+                    /** The input pattern is a RegExp. */
+                    type: "regex";
+                    /** The flag for RegExp. */
+                    flag: string;
+                } | {
+                    /** The input pattern is a simple string. */
+                    type: "string";
+                    /** If true, the input pattern is case sensitive. */
+                    caseSensitive: boolean;
+                }) & {
+                    /** If true, input pattern might contain additional javascript expression. Resolved before matching. */
+                    isInputPatternScripted: boolean;
+                    /** If true, output might contain additional javascript expression. Resolved after matching. */
+                    isOutputScripted: boolean;
+                    /** The priority of the replace hook. Higher number means higher priority. Can be positive, negative, or fractional. */
+                    priority: number;
+                };
+                /** The output. May contain additional javascript expression if `isOutputScripted` is true. */
+                output: string;
+            }[];
+            /** Replace hooks for input. User chat input will be edited by this. */
+            input: {
+                /** The input pattern. May contain additional javascript expression if `isInputPatternScripted` is true. */
+                input: string;
+                /** The meta data for the replace hook. */
+                meta: ({
+                    /** The input pattern is a RegExp. */
+                    type: "regex";
+                    /** The flag for RegExp. */
+                    flag: string;
+                } | {
+                    /** The input pattern is a simple string. */
+                    type: "string";
+                    /** If true, the input pattern is case sensitive. */
+                    caseSensitive: boolean;
+                }) & {
+                    /** If true, input pattern might contain additional javascript expression. Resolved before matching. */
+                    isInputPatternScripted: boolean;
+                    /** If true, output might contain additional javascript expression. Resolved after matching. */
+                    isOutputScripted: boolean;
+                    /** The priority of the replace hook. Higher number means higher priority. Can be positive, negative, or fractional. */
+                    priority: number;
+                };
+                /** The output. May contain additional javascript expression if `isOutputScripted` is true. */
+                output: string;
+            }[];
+            /** Replace hooks for output. Character response will be edited by this. */
+            output: {
+                /** The input pattern. May contain additional javascript expression if `isInputPatternScripted` is true. */
+                input: string;
+                /** The meta data for the replace hook. */
+                meta: ({
+                    /** The input pattern is a RegExp. */
+                    type: "regex";
+                    /** The flag for RegExp. */
+                    flag: string;
+                } | {
+                    /** The input pattern is a simple string. */
+                    type: "string";
+                    /** If true, the input pattern is case sensitive. */
+                    caseSensitive: boolean;
+                }) & {
+                    /** If true, input pattern might contain additional javascript expression. Resolved before matching. */
+                    isInputPatternScripted: boolean;
+                    /** If true, output might contain additional javascript expression. Resolved after matching. */
+                    isOutputScripted: boolean;
+                    /** The priority of the replace hook. Higher number means higher priority. Can be positive, negative, or fractional. */
+                    priority: number;
+                };
+                /** The output. May contain additional javascript expression if `isOutputScripted` is true. */
+                output: string;
+            }[];
+            /** Replace hooks for request. AI request will be edited by this. Differs from `input` in that it's for AI request. Does not edit the data, only changes the fetching request. */
+            request: {
+                /** The input pattern. May contain additional javascript expression if `isInputPatternScripted` is true. */
+                input: string;
+                /** The meta data for the replace hook. */
+                meta: ({
+                    /** The input pattern is a RegExp. */
+                    type: "regex";
+                    /** The flag for RegExp. */
+                    flag: string;
+                } | {
+                    /** The input pattern is a simple string. */
+                    type: "string";
+                    /** If true, the input pattern is case sensitive. */
+                    caseSensitive: boolean;
+                }) & {
+                    /** If true, input pattern might contain additional javascript expression. Resolved before matching. */
+                    isInputPatternScripted: boolean;
+                    /** If true, output might contain additional javascript expression. Resolved after matching. */
+                    isOutputScripted: boolean;
+                    /** The priority of the replace hook. Higher number means higher priority. Can be positive, negative, or fractional. */
+                    priority: number;
+                };
+                /** The output. May contain additional javascript expression if `isOutputScripted` is true. */
+                output: string;
+            }[];
+        };
+    };
+    /** Additional metadata about the character. Not used by the system, but can be used by the user. */
+    metadata: {
+        /** The author of the character. Optional. */
+        author?: string | undefined;
+        /** The license of the character. Optional. Using SPDX license identifier or URL is recommended. Default: ARR, which means the character is all rights reserved by the author. */
+        license: string;
+        /** The version of the character. Optional. */
+        version?: string | undefined;
+        /** The distributed page of the character.URL is recommended. Optional. */
+        distributedOn?: string | undefined;
+        /** Additional information about the character, which can't be represented by other fields. Optional. */
+        additionalInfo?: string | undefined;
+    };
+    /** Assets for the character. */
+    assets: {
+        /** The assets of the character. */
+        assets: {
+            /** The URL of the asset. */
+            url: string;
+            /** MIME type of the asset. Usually `image/*` or `video/*`. */
+            mimeType: string;
+            /** The name of the asset. Used as the file name. Should be unique. */
+            name: string;
+        }[];
+        /** The inlays of the character. It is not intended to be exported as public. */
+        inlays: {
+            /** The URL of the asset. */
+            url: string;
+            /** MIME type of the asset. Usually `image/*` or `video/*`. */
+            mimeType: string;
+            /** The name of the asset. Used as the file name. Should be unique. */
+            name: string;
+        }[];
+    };
+};
+
+export declare const CharacterSchema: z.ZodType<Character>;
+
+export type CharacterPromptData = {
+    /** The character description. */
+    description: string;
+    /** The authors note. It's usually used to mock the user's message (differ by prompt). */
+    authorsNote: string;
+    /** Lorebook data. */
+    lorebook: {
+        /** The configuration for the lorebook. Not scriptable. */
+        config: {
+            /** The token limit for the lorebook. When exceeded, low-priority lorebooks will be deactivated. Positive integer. */
+            tokenLimit: number;
+        };
+        /** Contains the actual lorebooks. Duplicated id is not allowed. */
+        data: {
+            /** Internally generated ID. */
+            id: string;
+            /** Human readable name for the lorebook. */
+            name: string;
+            /** The condition for the lorebook to be activated. If empty, it will not be activated. Use 'always' to activate without any condition. */
+            condition: ({
+                /** This condition matches the regex pattern. */
+                type: "regex_match";
+                /** The regex pattern to match. Scriptable. */
+                regexPattern: string;
+                /** The regex flags to use. Not scriptable. */
+                regexFlags?: string | undefined;
+            } | {
+                /** This condition simply matches the text. */
+                type: "plain_text_match";
+                /** The text to match. Scriptable. Case insensitive. */
+                text: string;
+            } | {
+                /** This condition is always true. */
+                type: "always";
+            })[];
+            /** The strategy for resolving multiple conditions. 'all' means all must be met, 'any' means at least one. */
+            multipleConditionResolveStrategy?: ("all" | "any") | undefined;
+            /** The lorebook content to be added on AI prompt. Not for human reading. Scriptable. */
+            content: string;
+            /** The priority of the lorebook. Higher priority means it will be activated first. May be negative or decimal. Base is 0. */
+            priority?: number | undefined;
+            /** Whether the lorebook is enabled. */
+            enabled?: boolean | undefined;
+        }[];
+    };
+};
+
+export declare const CharacterPromptDataSchema: z.ZodType<CharacterPromptData>;

package/dist/v0/Character/Character.js

@@ -0,0 +1,46 @@
+import { z as e } from "zod";
+import { AssetsSettingSchema as t } from "./Assets.js";
+import { LorebookDataSchema as a } from "./Lorebook.js";
+import { MetaSchema as r } from "./Meta.js";
+import { ScriptSettingSchema as o } from "../Executables/Executable.js";
+import { ImageURLSchema as i } from "../utils.js";
+const c = e.object({
+  description: e.string().meta({ description: "The character description." }),
+  authorsNote: e.string().meta({
+    description: "The authors note. It's usually used to mock the user's message (differ by prompt)."
+  }),
+  lorebook: a.meta({ description: "Lorebook data." })
+}).meta({
+  description: "The prompt data for a character. Used to generate the character's persona. All parameters are for AI prompt and scriptable."
+}), f = e.object({
+  specVersion: e.literal(0).meta({
+    description: "The version of the character spec. Used to determine which schema to use for parsing and migration."
+  }),
+  id: e.string().meta({ description: "Unique identifier for the character." }),
+  name: e.string().meta({
+    description: "The display name of the character. Human readable, not scriptable."
+  }),
+  description: e.string().meta({
+    description: "A short description of the character. Human readable, not scriptable."
+  }),
+  avatarUrl: i.optional().meta({
+    description: "Optional URL for the character's avatar image."
+  }),
+  prompt: c.meta({
+    description: "The prompt data for the character."
+  }),
+  executables: o.meta({
+    description: "Script and hooks which can be used to control the character's behavior."
+  }),
+  metadata: r.meta({
+    description: "Additional metadata about the character. Not used by the system, but can be used by the user."
+  }),
+  assets: t.meta({
+    description: "Assets for the character."
+  })
+}).meta({ description: "Represents a specific AI character personality." });
+export {
+  c as CharacterPromptDataSchema,
+  f as CharacterSchema
+};
+//# sourceMappingURL=Character.js.map

package/dist/v0/Character/Character.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Character.js","sources":["../../../src/types/v0/Character/Character.ts"],"sourcesContent":["import { z } from \"zod\";\nimport { AssetsSettingSchema } from \"@/types/v0/Character/Assets\";\nimport { LorebookDataSchema } from \"@/types/v0/Character/Lorebook\";\nimport { MetaSchema } from \"@/types/v0/Character/Meta\";\nimport { ScriptSettingSchema as ExecutableSettingSchema } from \"@/types/v0/Executables/Executable\";\nimport { ImageURLSchema } from \"@/types/v0/utils\";\n\n/**\n * The prompt data for a character.\n * It is used to generate the character's persona.\n * All of parameters are for AI prompt, and scriptable.\n */\nexport type CharacterPromptData = z.infer<typeof CharacterPromptDataSchema>;\n\nexport const CharacterPromptDataSchema = z\n    .object({\n        description: z\n            .string()\n            .meta({ description: \"The character description.\" }),\n        authorsNote: z.string().meta({\n            description:\n                \"The authors note. It's usually used to mock the user's message (differ by prompt).\",\n        }),\n        lorebook: LorebookDataSchema.meta({ description: \"Lorebook data.\" }),\n    })\n    .meta({\n        description:\n            \"The prompt data for a character. Used to generate the character's persona. All parameters are for AI prompt and scriptable.\",\n    });\n\nexport const CharacterSchema = z\n    .object({\n        specVersion: z.literal(0).meta({\n            description:\n                \"The version of the character spec. Used to determine which schema to use for parsing and migration.\",\n        }),\n        id: z\n            .string()\n            .meta({ description: \"Unique identifier for the character.\" }),\n        name: z.string().meta({\n            description:\n                \"The display name of the character. Human readable, not scriptable.\",\n        }),\n        description: z.string().meta({\n            description:\n                \"A short description of the character. Human readable, not scriptable.\",\n        }),\n        avatarUrl: ImageURLSchema.optional().meta({\n            description: \"Optional URL for the character's avatar image.\",\n        }),\n        prompt: CharacterPromptDataSchema.meta({\n            description: \"The prompt data for the character.\",\n        }),\n        executables: ExecutableSettingSchema.meta({\n            description:\n                \"Script and hooks which can be used to control the character's behavior.\",\n        }),\n        metadata: MetaSchema.meta({\n            description:\n                \"Additional metadata about the character. Not used by the system, but can be used by the user.\",\n        }),\n        assets: AssetsSettingSchema.meta({\n            description: \"Assets for the character.\",\n        }),\n    })\n    .meta({ description: \"Represents a specific AI character personality.\" });\n\n/**\n * Represents a specific AI character personality.\n */\nexport type Character = z.infer<typeof CharacterSchema>;\n"],"names":["CharacterPromptDataSchema","z","LorebookDataSchema","CharacterSchema","ImageURLSchema","ExecutableSettingSchema","MetaSchema","AssetsSettingSchema"],"mappings":";;;;;;AAcO,MAAMA,IAA4BC,EACpC,OAAO;AAAA,EACJ,aAAaA,EACR,OAAA,EACA,KAAK,EAAE,aAAa,8BAA8B;AAAA,EACvD,aAAaA,EAAE,OAAA,EAAS,KAAK;AAAA,IACzB,aACI;AAAA,EAAA,CACP;AAAA,EACD,UAAUC,EAAmB,KAAK,EAAE,aAAa,kBAAkB;AACvE,CAAC,EACA,KAAK;AAAA,EACF,aACI;AACR,CAAC,GAEQC,IAAkBF,EAC1B,OAAO;AAAA,EACJ,aAAaA,EAAE,QAAQ,CAAC,EAAE,KAAK;AAAA,IAC3B,aACI;AAAA,EAAA,CACP;AAAA,EACD,IAAIA,EACC,OAAA,EACA,KAAK,EAAE,aAAa,wCAAwC;AAAA,EACjE,MAAMA,EAAE,OAAA,EAAS,KAAK;AAAA,IAClB,aACI;AAAA,EAAA,CACP;AAAA,EACD,aAAaA,EAAE,OAAA,EAAS,KAAK;AAAA,IACzB,aACI;AAAA,EAAA,CACP;AAAA,EACD,WAAWG,EAAe,SAAA,EAAW,KAAK;AAAA,IACtC,aAAa;AAAA,EAAA,CAChB;AAAA,EACD,QAAQJ,EAA0B,KAAK;AAAA,IACnC,aAAa;AAAA,EAAA,CAChB;AAAA,EACD,aAAaK,EAAwB,KAAK;AAAA,IACtC,aACI;AAAA,EAAA,CACP;AAAA,EACD,UAAUC,EAAW,KAAK;AAAA,IACtB,aACI;AAAA,EAAA,CACP;AAAA,EACD,QAAQC,EAAoB,KAAK;AAAA,IAC7B,aAAa;AAAA,EAAA,CAChB;AACL,CAAC,EACA,KAAK,EAAE,aAAa,mDAAmD;"}

package/dist/v0/Character/Chat.d.ts

@@ -0,0 +1,73 @@
+// Auto-generated TypeScript types from Zod schemas
+// JSDoc comments are extracted from schema .meta({ description }) values
+import type { z } from "zod";
+
+export type Chat = {
+    /** Unique identifier for the chat session. */
+    id: string;
+    /** The ID of the character associated with this chat. */
+    characterId: string;
+    /** The list of messages in this chat. */
+    messages: {
+        /** Unique identifier for the message. */
+        id: string;
+        /** The role of the message sender. */
+        role: "user" | "assistant" | "system";
+        /** The content of the message. */
+        content: {
+            /** The message content is a simple string. */
+            type: "string";
+            /** The message content. */
+            data: string;
+        } | {
+            /** The file content is stored in the separated storage. */
+            type: "file";
+            /** URL of the file. */
+            data: string;
+            /** MIME type of the file. */
+            mimeType: string;
+        };
+        /** The timestamp when the message was created. */
+        timestamp?: number | undefined;
+    }[];
+    /** Optional title for the chat. */
+    title: string;
+    /** creation timestamp (unix epoch) */
+    createdAt: number;
+    /** Last updated timestamp (unix epoch) */
+    updatedAt: number;
+    /** Chat specific lorebook data. */
+    lorebook?: {
+        /** Internally generated ID. */
+        id: string;
+        /** Human readable name for the lorebook. */
+        name: string;
+        /** The condition for the lorebook to be activated. If empty, it will not be activated. Use 'always' to activate without any condition. */
+        condition: ({
+            /** This condition matches the regex pattern. */
+            type: "regex_match";
+            /** The regex pattern to match. Scriptable. */
+            regexPattern: string;
+            /** The regex flags to use. Not scriptable. */
+            regexFlags?: string | undefined;
+        } | {
+            /** This condition simply matches the text. */
+            type: "plain_text_match";
+            /** The text to match. Scriptable. Case insensitive. */
+            text: string;
+        } | {
+            /** This condition is always true. */
+            type: "always";
+        })[];
+        /** The strategy for resolving multiple conditions. 'all' means all must be met, 'any' means at least one. */
+        multipleConditionResolveStrategy?: ("all" | "any") | undefined;
+        /** The lorebook content to be added on AI prompt. Not for human reading. Scriptable. */
+        content: string;
+        /** The priority of the lorebook. Higher priority means it will be activated first. May be negative or decimal. Base is 0. */
+        priority?: number | undefined;
+        /** Whether the lorebook is enabled. */
+        enabled?: boolean | undefined;
+    }[] | undefined;
+};
+
+export declare const ChatSchema: z.ZodType<Chat>;