@arisutalk/character-spec 0.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright 2025 concertypin
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,64 @@
+# @arisutalk/character-spec ✨
+
+Hi there! Welcome to the **character-spec** library for ArisuTalk! 🌸
+This package defines the official character specification, schemas, and providing migration tools strictly typed with [Valibot](https://valibot.dev/).
+
+It's super important to keep our waifus... I mean, characters, well-defined! (◕‿◕✿)
+v0 is still in development, it's not even finished!
+
+## 📦 Installation
+
+Grab it with your favorite package manager!
+
+```bash
+pnpm add @arisutalk/character-spec valibot
+```
+*Note: `valibot` is a peer dependency! Don't forget it!* 😉
+
+## 🚀 Usage
+
+Here is how you can use the schemas to validate your character data. It's safe and sound! 🛡️
+
+```typescript
+import { CharacterSchema, type Character } from "@arisutalk/character-spec/v0";
+import * as v from "valibot";
+
+// Let's say you have some raw data...
+const rawData: Character = {
+  specVersion: 0,
+  id: "uuid-1234",
+  name: "Aris",
+  description: "Light Attribute AoE Dealer from Blue Archive.",
+  prompt: {} as any // Just for example, you should fill it with valid data!
+};
+
+// Validate it against v0 Schema!
+const AL_1S = v.parse(CharacterSchema, rawData);
+
+console.log(`Hello, ${AL_1S.name}!`); // Typescript knows 'name' exists! ✨
+```
+
+## 📂 Structure
+
+Everything is versioned so we don't break things!
+- `src/types/v0/`: Contains the initial Version 0 specs.
+  - `Character.ts`: The main character object.
+  - `Lorebook.ts`: World info and lore.
+  - `Chat.ts` & `Message.ts`: Chat history structures.
+
+## 🛠️ Development
+
+Want to contribute? Yay! Make sure to keep things clean. 🧹
+
+```bash
+# Build the library
+pnpm build
+
+# Lint the code (Biome is fast! ⚡)
+pnpm lint
+
+# Format the code
+pnpm format
+```
+
+Made with ❤️ for ArisuTalk.

package/dist/Character-Didq99iq.js

@@ -0,0 +1,157 @@
+import * as t from "valibot";
+const i = t.object({
+  /**
+   * Internally generated ID.
+   */
+  id: t.optional(t.string()),
+  /**
+   * Human readable name for the lorebook.
+   */
+  name: t.string(),
+  /**
+   * The condition for the lorebook to be activated.
+   * If empty, it will not be activated.
+   * Duplicated condition is no effect.
+   * Use 'always' to activate without any condition. {@link LorebookConditionTypeMap#always}
+   */
+  condition: t.optional(t.array(t.custom(() => !0))),
+  /**
+   * The strategy for resolving multiple conditions.
+   * "all" means all conditions must be met.
+   * "any" means at least one condition must be met.
+   */
+  multipleConditionResolveStrategy: t.optional(t.picklist(["all", "any"])),
+  /**
+   * The lorebook content to be added on AI prompt.
+   * Not for human reading, and it's scriptable.
+   */
+  content: t.string(),
+  /**
+   * The priority of the lorebook.
+   * Higher priority means it will be activated first, remains when token limit is exceeded.
+   * May be negative. Base is 0. Allows demical.
+   */
+  priority: t.optional(t.number()),
+  /**
+   * Whether the lorebook is enabled.
+   */
+  enabled: t.optional(t.boolean())
+}), o = {
+  regex: t.object({
+    /**
+     * The type of the condition.
+     * This condition matches the regex pattern.
+     */
+    type: t.literal("regex_match"),
+    /**
+     * The regex pattern to match.
+     * Note that this is scriptable.
+     */
+    regexPattern: t.string(),
+    /**
+     * The regex flags to use.
+     * Note that this is not scriptable.
+     */
+    regexFlags: t.optional(t.string())
+  }),
+  plainText: t.object({
+    /**
+     * The type of the condition.
+     * This condition simply matches the text.
+     */
+    type: t.literal("plain_text_match"),
+    /**
+     * The text to match.
+     * Note that this is scriptable.
+     * No case sensitive.
+     */
+    text: t.string()
+  }),
+  always: t.object({
+    /**
+     * The type of the condition.
+     * This condition is always true.
+     */
+    type: t.literal("always")
+  })
+}, l = t.variant("type", [
+  o.regex,
+  o.plainText,
+  o.always
+]), n = t.object({
+  /**
+   * The configuration for the lorebook.
+   * It is not scriptable.
+   */
+  config: t.object({
+    /**
+     * The token limit for the lorebook.
+     * When the token limit is exceeded, some low-priority lorebooks will be deactivated to keep the token usage within the limit.
+     * Positive integer.
+     */
+    tokenLimit: t.pipe(t.number(), t.integer(), t.minValue(1))
+  }),
+  /**
+   * Contains the actual lorebooks.
+   * Duplicated id is not allowed.
+   */
+  data: t.optional(
+    t.pipe(
+      t.array(i),
+      t.check(
+        (a) => a.map((e) => e.id).length === new Set(a.map((e) => e.id)).size,
+        "Duplicated id is not allowed."
+      )
+    ),
+    []
+  )
+}), r = t.object({
+  /**
+   * The character description.
+   */
+  description: t.string(),
+  /**
+   * The authors note. It's usually used to mock the user's message(differ by prompt).
+   */
+  authorsNote: t.string(),
+  /**
+   * Lorebook data.
+   * @see {@link LorebookDataSchema}
+   */
+  lorebook: n
+}), s = t.object({
+  /**
+   * 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.
+   */
+  specVersion: t.literal(0),
+  /**
+   * Unique identifier for the character.
+   */
+  id: t.string(),
+  /**
+   * The display name of the character.
+   * Human readable, not scriptable.
+   */
+  name: t.string(),
+  /**
+   * A short description of the character.
+   * Human readable, not scriptable.
+   */
+  description: t.string(),
+  /**
+   * Optional URL for the character's avatar image.
+   */
+  avatarUrl: t.optional(t.pipe(t.string(), t.url())),
+  prompt: r
+});
+export {
+  s as C,
+  i as L,
+  r as a,
+  o as b,
+  l as c,
+  n as d
+};
+//# sourceMappingURL=Character-Didq99iq.js.map

package/dist/Character-Didq99iq.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Character-Didq99iq.js","sources":["../src/types/v0/Lorebook.ts","../src/types/v0/Character.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * @see {@link LorebookEntry}\n */\nexport const LorebookEntrySchema = v.object({\n    /**\n     * Internally generated ID.\n     */\n    id: v.optional(v.string()),\n    /**\n     * Human readable name for the lorebook.\n     */\n    name: v.string(),\n    /**\n     * The condition for the lorebook to be activated.\n     * If empty, it will not be activated.\n     * Duplicated condition is no effect.\n     * Use 'always' to activate without any condition. {@link LorebookConditionTypeMap#always}\n     */\n    condition: v.optional(v.array(v.custom<LorebookCondition>(() => true))),\n    /**\n     * The strategy for resolving multiple conditions.\n     * \"all\" means all conditions must be met.\n     * \"any\" means at least one condition must be met.\n     */\n    multipleConditionResolveStrategy: v.optional(v.picklist([\"all\", \"any\"])),\n    /**\n     * The lorebook content to be added on AI prompt.\n     * Not for human reading, and it's scriptable.\n     */\n    content: v.string(),\n    /**\n     * The priority of the lorebook.\n     * Higher priority means it will be activated first, remains when token limit is exceeded.\n     * May be negative. Base is 0. Allows demical.\n     */\n    priority: v.optional(v.number()),\n    /**\n     * Whether the lorebook is enabled.\n     */\n    enabled: v.optional(v.boolean()),\n});\n/**\n * A lorebook is a collection of lorebooks.\n * Lorebook is a small part of prompts which is activated by session's text matching.\n */\nexport type LorebookEntry = v.InferOutput<typeof LorebookEntrySchema>;\n\n/**\n * @see {@link LorebookConditionSchema}\n */\nexport const LorebookConditionDetailSchema = {\n    regex: v.object({\n        /**\n         * The type of the condition.\n         * This condition matches the regex pattern.\n         */\n        type: v.literal(\"regex_match\"),\n        /**\n         * The regex pattern to match.\n         * Note that this is scriptable.\n         */\n        regexPattern: v.string(),\n        /**\n         * The regex flags to use.\n         * Note that this is not scriptable.\n         */\n        regexFlags: v.optional(v.string()),\n    }),\n    plainText: v.object({\n        /**\n         * The type of the condition.\n         * This condition simply matches the text.\n         */\n        type: v.literal(\"plain_text_match\"),\n        /**\n         * The text to match.\n         * Note that this is scriptable.\n         * No case sensitive.\n         */\n        text: v.string(),\n    }),\n    always: v.object({\n        /**\n         * The type of the condition.\n         * This condition is always true.\n         */\n        type: v.literal(\"always\"),\n    }),\n} as const;\n\n/**\n * The condition for the lorebook to be activated.\n */\nexport const LorebookConditionSchema = v.variant(\"type\", [\n    LorebookConditionDetailSchema.regex,\n    LorebookConditionDetailSchema.plainText,\n    LorebookConditionDetailSchema.always,\n]);\n\n/**\n * The condition for the lorebook to be activated.\n * @see {@link LorebookConditionSchema}\n */\nexport type LorebookCondition = v.InferOutput<typeof LorebookConditionSchema>;\n\n/**\n * @see {@link LorebookData}\n */\nexport const LorebookDataSchema = v.object({\n    /**\n     * The configuration for the lorebook.\n     * It is not scriptable.\n     */\n    config: v.object({\n        /**\n         * The token limit for the lorebook.\n         * When the token limit is exceeded, some low-priority lorebooks will be deactivated to keep the token usage within the limit.\n         * Positive integer.\n         */\n        tokenLimit: v.pipe(v.number(), v.integer(), v.minValue(1)),\n    }),\n    /**\n     * Contains the actual lorebooks.\n     * Duplicated id is not allowed.\n     */\n    data: v.optional(\n        v.pipe(\n            v.array(LorebookEntrySchema),\n            v.check(\n                (data) =>\n                    data.map((i) => i.id).length ===\n                    new Set(data.map((i) => i.id)).size,\n                \"Duplicated id is not allowed.\",\n            ),\n        ),\n        [],\n    ),\n});\n/**\n * Object containing all data for the lorebook.\n * It's meant to be stored in the database and many other places.\n */\nexport type LorebookData = v.InferOutput<typeof LorebookDataSchema>;\n","import * as v from \"valibot\";\nimport { LorebookDataSchema } from \"@/types/v0/Lorebook\";\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 = v.InferOutput<\n    typeof CharacterPromptDataSchema\n>;\n\n/**\n * @see {@link CharacterPromptData}\n */\nexport const CharacterPromptDataSchema = v.object({\n    /**\n     * The character description.\n     */\n    description: v.string(),\n    /**\n     * The authors note. It's usually used to mock the user's message(differ by prompt).\n     */\n    authorsNote: v.string(),\n    /**\n     * Lorebook data.\n     * @see {@link LorebookDataSchema}\n     */\n    lorebook: LorebookDataSchema,\n});\n\n/**\n * @see {@link Character}\n */\nexport const CharacterSchema = v.object({\n    /**\n     * The version of the character spec.\n     * This is used to determine which schema to use for parsing.\n     * Also tries to migrate the character to the latest version.\n     */\n    specVersion: v.literal(0),\n    /**\n     * Unique identifier for the character.\n     */\n    id: v.string(),\n    /**\n     * The display name of the character.\n     * Human readable, not scriptable.\n     */\n    name: v.string(),\n    /**\n     * A short description of the character.\n     * Human readable, not scriptable.\n     */\n    description: v.string(),\n    /**\n     * Optional URL for the character's avatar image.\n     */\n    avatarUrl: v.optional(v.pipe(v.string(), v.url())),\n    prompt: CharacterPromptDataSchema,\n});\n\n/**\n * Represents a specific AI character personality.\n */\nexport type Character = v.InferOutput<typeof CharacterSchema>;\n"],"names":["LorebookEntrySchema","v","LorebookConditionDetailSchema","LorebookConditionSchema","LorebookDataSchema","data","i","CharacterPromptDataSchema","CharacterSchema"],"mappings":";AAKO,MAAMA,IAAsBC,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,EAIxC,IAAIA,EAAE,SAASA,EAAE,QAAQ;AAAA;AAAA;AAAA;AAAA,EAIzB,MAAMA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOR,WAAWA,EAAE,SAASA,EAAE,MAAMA,EAAE,OAA0B,MAAM,EAAI,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMtE,kCAAkCA,EAAE,SAASA,EAAE,SAAS,CAAC,OAAO,KAAK,CAAC,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,EAKvE,SAASA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMX,UAAUA,EAAE,SAASA,EAAE,QAAQ;AAAA;AAAA;AAAA;AAAA,EAI/B,SAASA,EAAE,SAASA,EAAE,SAAS;AACnC,CAAC,GAUYC,IAAgC;AAAA,EACzC,OAAOD,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,IAKZ,MAAMA,EAAE,QAAQ,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7B,cAAcA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAKhB,YAAYA,EAAE,SAASA,EAAE,QAAQ;AAAA,EAAA,CACpC;AAAA,EACD,WAAWA,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,IAKhB,MAAMA,EAAE,QAAQ,kBAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMlC,MAAMA,EAAE,OAAA;AAAA,EAAO,CAClB;AAAA,EACD,QAAQA,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,IAKb,MAAMA,EAAE,QAAQ,QAAQ;AAAA,EAAA,CAC3B;AACL,GAKaE,IAA0BF,EAAE,QAAQ,QAAQ;AAAA,EACrDC,EAA8B;AAAA,EAC9BA,EAA8B;AAAA,EAC9BA,EAA8B;AAClC,CAAC,GAWYE,IAAqBH,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAKvC,QAAQA,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMb,YAAYA,EAAE,KAAKA,EAAE,OAAA,GAAUA,EAAE,QAAA,GAAWA,EAAE,SAAS,CAAC,CAAC;AAAA,EAAA,CAC5D;AAAA;AAAA;AAAA;AAAA;AAAA,EAKD,MAAMA,EAAE;AAAA,IACJA,EAAE;AAAA,MACEA,EAAE,MAAMD,CAAmB;AAAA,MAC3BC,EAAE;AAAA,QACE,CAACI,MACGA,EAAK,IAAI,CAACC,MAAMA,EAAE,EAAE,EAAE,WACtB,IAAI,IAAID,EAAK,IAAI,CAACC,MAAMA,EAAE,EAAE,CAAC,EAAE;AAAA,QACnC;AAAA,MAAA;AAAA,IACJ;AAAA,IAEJ,CAAA;AAAA,EAAC;AAET,CAAC,GC5HYC,IAA4BN,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,EAI9C,aAAaA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA,EAIf,aAAaA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKf,UAAUG;AACd,CAAC,GAKYI,IAAkBP,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMpC,aAAaA,EAAE,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA,EAIxB,IAAIA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKN,MAAMA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKR,aAAaA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA,EAIf,WAAWA,EAAE,SAASA,EAAE,KAAKA,EAAE,UAAUA,EAAE,IAAA,CAAK,CAAC;AAAA,EACjD,QAAQM;AACZ,CAAC;"}

package/dist/index.d.ts

@@ -0,0 +1,166 @@
+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 { }

package/dist/index.js

@@ -0,0 +1,9 @@
+import { C as a } from "./Character-Didq99iq.js";
+const t = {
+  0: a
+};
+export {
+  t as characterMap,
+  t as default
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +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;"}

package/dist/v0.d.ts

@@ -0,0 +1,507 @@
+import * as v from 'valibot';
+
+/**
+ * Represents a specific AI character personality.
+ */
+export declare type Character = v.InferOutput<typeof CharacterSchema>;
+
+/**
+ * The prompt data for a character.
+ * It is used to generate the character's persona.
+ * All of parameters are for AI prompt, and scriptable.
+ */
+export declare type CharacterPromptData = v.InferOutput<typeof CharacterPromptDataSchema>;
+
+/**
+ * @see {@link CharacterPromptData}
+ */
+export declare const CharacterPromptDataSchema: 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>;
+
+/**
+ * @see {@link Character}
+ */
+export 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>;
+
+/**
+ * Represents a chat session with a character.
+ */
+export declare type Chat = v.InferOutput<typeof ChatSchema>;
+
+/**
+ * @see {@link Chat}
+ */
+export declare const ChatSchema: v.ObjectSchema<{
+    /**
+     * Unique identifier for the chat session.
+     */
+    readonly id: v.StringSchema<undefined>;
+    /**
+     * The ID of the character associated with this chat.
+     */
+    readonly characterId: v.StringSchema<undefined>;
+    /**
+     * The list of messages in this chat.
+     */
+    readonly messages: v.ArraySchema<v.ObjectSchema<{
+        readonly id: v.StringSchema<undefined>;
+        readonly role: v.UnionSchema<[v.LiteralSchema<"user", undefined>, v.LiteralSchema<"assistant", undefined>, v.LiteralSchema<"system", undefined>], undefined>;
+        readonly content: v.VariantSchema<"type", [v.ObjectSchema<{
+            readonly type: v.LiteralSchema<"string", undefined>;
+            readonly data: v.StringSchema<undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly type: v.LiteralSchema<"file", undefined>;
+            readonly data: v.StringSchema<undefined>;
+            readonly mimeType: v.StringSchema<undefined>;
+        }, undefined>, v.ObjectSchema<{
+            readonly type: v.LiteralSchema<"inline_file", undefined>;
+            readonly data: v.UnionSchema<[v.FileSchema<undefined>, v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.Base64Action<string, undefined>]>, v.BlobSchema<undefined>], undefined>;
+            readonly mimeType: v.StringSchema<undefined>;
+        }, undefined>], undefined>;
+        readonly timestamp: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+    }, undefined>, undefined>;
+    /**
+     * Optional title for the chat.
+     */
+    readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    /**
+     * creation timestamp(unix epoch)
+     */
+    readonly createdAt: v.OptionalSchema<v.NumberSchema<undefined>, () => number>;
+    /**
+     * Last updated timestamp(unix epoch)
+     */
+    readonly updatedAt: v.OptionalSchema<v.NumberSchema<undefined>, () => number>;
+}, undefined>;
+
+/**
+ * The condition for the lorebook to be activated.
+ * @see {@link LorebookConditionSchema}
+ */
+export declare type LorebookCondition = v.InferOutput<typeof LorebookConditionSchema>;
+
+/**
+ * @see {@link LorebookConditionSchema}
+ */
+export declare const LorebookConditionDetailSchema: {
+    readonly regex: v.ObjectSchema<{
+        /**
+         * The type of the condition.
+         * This condition matches the regex pattern.
+         */
+        readonly type: v.LiteralSchema<"regex_match", undefined>;
+        /**
+         * The regex pattern to match.
+         * Note that this is scriptable.
+         */
+        readonly regexPattern: v.StringSchema<undefined>;
+        /**
+         * The regex flags to use.
+         * Note that this is not scriptable.
+         */
+        readonly regexFlags: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    }, undefined>;
+    readonly plainText: v.ObjectSchema<{
+        /**
+         * The type of the condition.
+         * This condition simply matches the text.
+         */
+        readonly type: v.LiteralSchema<"plain_text_match", undefined>;
+        /**
+         * The text to match.
+         * Note that this is scriptable.
+         * No case sensitive.
+         */
+        readonly text: v.StringSchema<undefined>;
+    }, undefined>;
+    readonly always: v.ObjectSchema<{
+        /**
+         * The type of the condition.
+         * This condition is always true.
+         */
+        readonly type: v.LiteralSchema<"always", undefined>;
+    }, undefined>;
+};
+
+/**
+ * The condition for the lorebook to be activated.
+ */
+export declare const LorebookConditionSchema: v.VariantSchema<"type", [v.ObjectSchema<{
+    /**
+     * The type of the condition.
+     * This condition matches the regex pattern.
+     */
+    readonly type: v.LiteralSchema<"regex_match", undefined>;
+    /**
+     * The regex pattern to match.
+     * Note that this is scriptable.
+     */
+    readonly regexPattern: v.StringSchema<undefined>;
+    /**
+     * The regex flags to use.
+     * Note that this is not scriptable.
+     */
+    readonly regexFlags: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>, v.ObjectSchema<{
+    /**
+     * The type of the condition.
+     * This condition simply matches the text.
+     */
+    readonly type: v.LiteralSchema<"plain_text_match", undefined>;
+    /**
+     * The text to match.
+     * Note that this is scriptable.
+     * No case sensitive.
+     */
+    readonly text: v.StringSchema<undefined>;
+}, undefined>, v.ObjectSchema<{
+    /**
+     * The type of the condition.
+     * This condition is always true.
+     */
+    readonly type: v.LiteralSchema<"always", undefined>;
+}, undefined>], undefined>;
+
+/**
+ * Object containing all data for the lorebook.
+ * It's meant to be stored in the database and many other places.
+ */
+export declare type LorebookData = v.InferOutput<typeof LorebookDataSchema>;
+
+/**
+ * @see {@link LorebookData}
+ */
+export declare const LorebookDataSchema: v.ObjectSchema<{
+    /**
+     * The configuration for the lorebook.
+     * It is not scriptable.
+     */
+    readonly config: v.ObjectSchema<{
+        /**
+         * The token limit for the lorebook.
+         * When the token limit is exceeded, some low-priority lorebooks will be deactivated to keep the token usage within the limit.
+         * Positive integer.
+         */
+        readonly tokenLimit: v.SchemaWithPipe<readonly [v.NumberSchema<undefined>, v.IntegerAction<number, undefined>, v.MinValueAction<number, 1, undefined>]>;
+    }, undefined>;
+    /**
+     * Contains the actual lorebooks.
+     * Duplicated id is not allowed.
+     */
+    readonly data: v.OptionalSchema<v.SchemaWithPipe<readonly [v.ArraySchema<v.ObjectSchema<{
+        /**
+         * Internally generated ID.
+         */
+        readonly id: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+        /**
+         * Human readable name for the lorebook.
+         */
+        readonly name: v.StringSchema<undefined>;
+        /**
+         * The condition for the lorebook to be activated.
+         * If empty, it will not be activated.
+         * Duplicated condition is no effect.
+         * Use 'always' to activate without any condition. {@link LorebookConditionTypeMap#always}
+         */
+        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>;
+        /**
+         * The strategy for resolving multiple conditions.
+         * "all" means all conditions must be met.
+         * "any" means at least one condition must be met.
+         */
+        readonly multipleConditionResolveStrategy: v.OptionalSchema<v.PicklistSchema<["all", "any"], undefined>, undefined>;
+        /**
+         * The lorebook content to be added on AI prompt.
+         * Not for human reading, and it's scriptable.
+         */
+        readonly content: v.StringSchema<undefined>;
+        /**
+         * The priority of the lorebook.
+         * Higher priority means it will be activated first, remains when token limit is exceeded.
+         * May be negative. Base is 0. Allows demical.
+         */
+        readonly priority: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+        /**
+         * Whether the lorebook is enabled.
+         */
+        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>;
+
+/**
+ * A lorebook is a collection of lorebooks.
+ * Lorebook is a small part of prompts which is activated by session's text matching.
+ */
+export declare type LorebookEntry = v.InferOutput<typeof LorebookEntrySchema>;
+
+/**
+ * @see {@link LorebookEntry}
+ */
+export declare const LorebookEntrySchema: v.ObjectSchema<{
+    /**
+     * Internally generated ID.
+     */
+    readonly id: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    /**
+     * Human readable name for the lorebook.
+     */
+    readonly name: v.StringSchema<undefined>;
+    /**
+     * The condition for the lorebook to be activated.
+     * If empty, it will not be activated.
+     * Duplicated condition is no effect.
+     * Use 'always' to activate without any condition. {@link LorebookConditionTypeMap#always}
+     */
+    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>;
+    /**
+     * The strategy for resolving multiple conditions.
+     * "all" means all conditions must be met.
+     * "any" means at least one condition must be met.
+     */
+    readonly multipleConditionResolveStrategy: v.OptionalSchema<v.PicklistSchema<["all", "any"], undefined>, undefined>;
+    /**
+     * The lorebook content to be added on AI prompt.
+     * Not for human reading, and it's scriptable.
+     */
+    readonly content: v.StringSchema<undefined>;
+    /**
+     * The priority of the lorebook.
+     * Higher priority means it will be activated first, remains when token limit is exceeded.
+     * May be negative. Base is 0. Allows demical.
+     */
+    readonly priority: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+    /**
+     * Whether the lorebook is enabled.
+     */
+    readonly enabled: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
+}, undefined>;
+
+/**
+ * Represents a single message in a chat history.
+ */
+export declare type Message = v.InferOutput<typeof MessageSchema>;
+
+/**
+ * @see {@link Message}
+ */
+export declare const MessageSchema: v.ObjectSchema<{
+    /** Unique identifier for the message. */
+    readonly id: v.StringSchema<undefined>;
+    /** The role of the message sender. */
+    readonly role: v.UnionSchema<[v.LiteralSchema<"user", undefined>, v.LiteralSchema<"assistant", undefined>, v.LiteralSchema<"system", undefined>], undefined>;
+    /** The content of the message. */
+    readonly content: v.VariantSchema<"type", [v.ObjectSchema<{
+        /**
+         * string: The message content is a simple string.
+         */
+        readonly type: v.LiteralSchema<"string", undefined>;
+        /**
+         * The message content.
+         */
+        readonly data: v.StringSchema<undefined>;
+    }, undefined>, v.ObjectSchema<{
+        /**
+         * file: The file content is stored in the separated storage.
+         */
+        readonly type: v.LiteralSchema<"file", undefined>;
+        /**
+         * URL of the file. May be absolute or relative, or even uuid.
+         * Client should handle the actual file loading.
+         * Don't use base64 encoded file. Instead, use with type:"inline_file".
+         */
+        readonly data: v.StringSchema<undefined>;
+        /**
+         * MIME type of the file.
+         */
+        readonly mimeType: v.StringSchema<undefined>;
+    }, undefined>, v.ObjectSchema<{
+        /**
+         * inline_file: The file content is embedded in the message.
+         */
+        readonly type: v.LiteralSchema<"inline_file", undefined>;
+        /**
+         * File content. May be base64 encoded or file, or blob.
+         * It's good to use url with type:"file" instead, to avoid getting too large message.
+         */
+        readonly data: v.UnionSchema<[v.FileSchema<undefined>, v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.Base64Action<string, undefined>]>, v.BlobSchema<undefined>], undefined>;
+        /**
+         * MIME type of the file.
+         */
+        readonly mimeType: v.StringSchema<undefined>;
+    }, undefined>], undefined>;
+    /** The timestamp when the message was created. */
+    readonly timestamp: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
+}, undefined>;
+
+/**
+ * Represents the role of the message sender.
+ */
+export declare const RoleSchema: v.UnionSchema<[v.LiteralSchema<"user", undefined>, v.LiteralSchema<"assistant", undefined>, v.LiteralSchema<"system", undefined>], undefined>;
+
+export { }

package/dist/v0.js

@@ -0,0 +1,99 @@
+import { a as s, C as l, b as c, c as m, d as p, L as b } from "./Character-Didq99iq.js";
+import * as e from "valibot";
+const a = e.union([
+  e.literal("user"),
+  e.literal("assistant"),
+  e.literal("system")
+]), t = {
+  text: e.object({
+    /**
+     * string: The message content is a simple string.
+     */
+    type: e.literal("string"),
+    /**
+     * The message content.
+     */
+    data: e.string()
+  }),
+  file: e.object({
+    /**
+     * file: The file content is stored in the separated storage.
+     */
+    type: e.literal("file"),
+    /**
+     * URL of the file. May be absolute or relative, or even uuid.
+     * Client should handle the actual file loading.
+     * Don't use base64 encoded file. Instead, use with type:"inline_file".
+     */
+    data: e.string(),
+    /**
+     * MIME type of the file.
+     */
+    mimeType: e.string()
+  }),
+  inline_file: e.object({
+    /**
+     * inline_file: The file content is embedded in the message.
+     */
+    type: e.literal("inline_file"),
+    /**
+     * File content. May be base64 encoded or file, or blob.
+     * It's good to use url with type:"file" instead, to avoid getting too large message.
+     */
+    data: e.union([e.file(), e.pipe(e.string(), e.base64()), e.blob()]),
+    /**
+     * MIME type of the file.
+     */
+    mimeType: e.string()
+  })
+}, i = e.object({
+  /** Unique identifier for the message. */
+  id: e.string(),
+  /** The role of the message sender. */
+  role: a,
+  /** The content of the message. */
+  content: e.variant("type", [
+    t.text,
+    t.file,
+    t.inline_file
+  ]),
+  /** The timestamp when the message was created. */
+  timestamp: e.optional(e.number())
+}), o = e.object({
+  /**
+   * Unique identifier for the chat session.
+   */
+  id: e.string(),
+  /**
+   * The ID of the character associated with this chat.
+   */
+  characterId: e.string(),
+  /**
+   * The list of messages in this chat.
+   */
+  messages: e.array(i),
+  /**
+   * Optional title for the chat.
+   */
+  title: e.optional(e.string()),
+  /**
+   * creation timestamp(unix epoch)
+   */
+  createdAt: e.optional(e.number(), Date.now),
+  /**
+   * Last updated timestamp(unix epoch)
+   */
+  updatedAt: e.optional(e.number(), Date.now)
+});
+export {
+  s as CharacterPromptDataSchema,
+  l as CharacterSchema,
+  o as ChatSchema,
+  c as LorebookConditionDetailSchema,
+  m as LorebookConditionSchema,
+  p as LorebookDataSchema,
+  b as LorebookEntrySchema,
+  i as MessageSchema,
+  a as RoleSchema
+};
+//# sourceMappingURL=v0.js.map

package/dist/v0.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"v0.js","sources":["../src/types/v0/Message.ts","../src/types/v0/Chat.ts"],"sourcesContent":["import * as v from \"valibot\";\n\n/**\n * Represents the role of the message sender.\n */\nexport const RoleSchema = v.union([\n    v.literal(\"user\"),\n    v.literal(\"assistant\"),\n    v.literal(\"system\"),\n]);\n\nconst MessageContentSchema = {\n    text: v.object({\n        /**\n         * string: The message content is a simple string.\n         */\n        type: v.literal(\"string\"),\n        /**\n         * The message content.\n         */\n        data: v.string(),\n    }),\n    file: v.object({\n        /**\n         * file: The file content is stored in the separated storage.\n         */\n        type: v.literal(\"file\"),\n        /**\n         * URL of the file. May be absolute or relative, or even uuid.\n         * Client should handle the actual file loading.\n         * Don't use base64 encoded file. Instead, use with type:\"inline_file\".\n         */\n        data: v.string(),\n        /**\n         * MIME type of the file.\n         */\n        mimeType: v.string(),\n    }),\n    inline_file: v.object({\n        /**\n         * inline_file: The file content is embedded in the message.\n         */\n        type: v.literal(\"inline_file\"),\n        /**\n         * File content. May be base64 encoded or file, or blob.\n         * It's good to use url with type:\"file\" instead, to avoid getting too large message.\n         */\n        data: v.union([v.file(), v.pipe(v.string(), v.base64()), v.blob()]),\n        /**\n         * MIME type of the file.\n         */\n        mimeType: v.string(),\n    }),\n};\n\n/**\n * @see {@link Message}\n */\nexport const MessageSchema = v.object({\n    /** Unique identifier for the message. */\n    id: v.string(),\n    /** The role of the message sender. */\n    role: RoleSchema,\n    /** The content of the message. */\n    content: v.variant(\"type\", [\n        MessageContentSchema.text,\n        MessageContentSchema.file,\n        MessageContentSchema.inline_file,\n    ]),\n    /** The timestamp when the message was created. */\n    timestamp: v.optional(v.number()),\n});\n\n/**\n * Represents a single message in a chat history.\n */\nexport type Message = v.InferOutput<typeof MessageSchema>;\n","import * as v from \"valibot\";\nimport { MessageSchema } from \"@/types/v0/Message\";\n\n/**\n * @see {@link Chat}\n */\nexport const ChatSchema = v.object({\n    /**\n     * Unique identifier for the chat session.\n     */\n    id: v.string(),\n    /**\n     * The ID of the character associated with this chat.\n     */\n    characterId: v.string(),\n    /**\n     * The list of messages in this chat.\n     */\n    messages: v.array(MessageSchema),\n    /**\n     * Optional title for the chat.\n     */\n    title: v.optional(v.string()),\n    /**\n     * creation timestamp(unix epoch)\n     */\n    createdAt: v.optional(v.number(), Date.now),\n    /**\n     * Last updated timestamp(unix epoch)\n     */\n    updatedAt: v.optional(v.number(), Date.now),\n});\n\n/**\n * Represents a chat session with a character.\n */\nexport type Chat = v.InferOutput<typeof ChatSchema>;\n"],"names":["RoleSchema","v","MessageContentSchema","MessageSchema","ChatSchema"],"mappings":";;AAKO,MAAMA,IAAaC,EAAE,MAAM;AAAA,EAC9BA,EAAE,QAAQ,MAAM;AAAA,EAChBA,EAAE,QAAQ,WAAW;AAAA,EACrBA,EAAE,QAAQ,QAAQ;AACtB,CAAC,GAEKC,IAAuB;AAAA,EACzB,MAAMD,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,IAIX,MAAMA,EAAE,QAAQ,QAAQ;AAAA;AAAA;AAAA;AAAA,IAIxB,MAAMA,EAAE,OAAA;AAAA,EAAO,CAClB;AAAA,EACD,MAAMA,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,IAIX,MAAMA,EAAE,QAAQ,MAAM;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMtB,MAAMA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA,IAIR,UAAUA,EAAE,OAAA;AAAA,EAAO,CACtB;AAAA,EACD,aAAaA,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,IAIlB,MAAMA,EAAE,QAAQ,aAAa;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7B,MAAMA,EAAE,MAAM,CAACA,EAAE,KAAA,GAAQA,EAAE,KAAKA,EAAE,OAAA,GAAUA,EAAE,OAAA,CAAQ,GAAGA,EAAE,KAAA,CAAM,CAAC;AAAA;AAAA;AAAA;AAAA,IAIlE,UAAUA,EAAE,OAAA;AAAA,EAAO,CACtB;AACL,GAKaE,IAAgBF,EAAE,OAAO;AAAA;AAAA,EAElC,IAAIA,EAAE,OAAA;AAAA;AAAA,EAEN,MAAMD;AAAA;AAAA,EAEN,SAASC,EAAE,QAAQ,QAAQ;AAAA,IACvBC,EAAqB;AAAA,IACrBA,EAAqB;AAAA,IACrBA,EAAqB;AAAA,EAAA,CACxB;AAAA;AAAA,EAED,WAAWD,EAAE,SAASA,EAAE,QAAQ;AACpC,CAAC,GCjEYG,IAAaH,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,EAI/B,IAAIA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA,EAIN,aAAaA,EAAE,OAAA;AAAA;AAAA;AAAA;AAAA,EAIf,UAAUA,EAAE,MAAME,CAAa;AAAA;AAAA;AAAA;AAAA,EAI/B,OAAOF,EAAE,SAASA,EAAE,QAAQ;AAAA;AAAA;AAAA;AAAA,EAI5B,WAAWA,EAAE,SAASA,EAAE,OAAA,GAAU,KAAK,GAAG;AAAA;AAAA;AAAA;AAAA,EAI1C,WAAWA,EAAE,SAASA,EAAE,OAAA,GAAU,KAAK,GAAG;AAC9C,CAAC;"}

package/package.json

@@ -0,0 +1,55 @@
+{
+    "name": "@arisutalk/character-spec",
+    "description": "Character specification, schema & migration for ArisuTalk",
+    "version": "0.0.0",
+    "contributors": [
+        {
+            "name": "concertypin",
+            "url": "https://github.com/concertypin"
+        }
+    ],
+    "repository": "github:arisutalk/character-spec",
+    "license": "Apache-2.0",
+    "engines": {
+        "node": ">=22"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "type": "module",
+    "scripts": {
+        "build": "vite build",
+        "prepare": "pnpm exec simple-git-hooks",
+        "format": "biome format --write .",
+        "lint": "biome check ."
+    },
+    "peerDependencies": {
+        "valibot": "^1.2.0"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "^2.3.5",
+        "lint-staged": "^16.2.6",
+        "simple-git-hooks": "^2.13.1",
+        "typescript": "^5.9.3",
+        "valibot": "^1.2.0",
+        "vite": "^6.4.1",
+        "vite-plugin-dts": "^4.5.4",
+        "vite-tsconfig-paths": "^5.1.4"
+    },
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        },
+        "./v0": {
+            "import": "./dist/v0.js",
+            "types": "./dist/v0.d.ts"
+        }
+    },
+    "packageManager": "pnpm@10.16.1+sha512.0e155aa2629db8672b49e8475da6226aa4bdea85fdcdfdc15350874946d4f3c91faaf64cbdc4a5d1ab8002f473d5c3fcedcd197989cf0390f9badd3c04678706"
+}