optolith-database-schema 0.17.0 → 0.18.1

package/lib/types/PersonalityTrait.d.ts

@@ -1,67 +1,80 @@
-/**
- * @main PersonalityTrait
- */
-import { TypeConfig } from "../typeConfig.js";
-import { LocaleMap } from "./_LocaleMap.js";
-import { NonEmptyString } from "./_NonEmptyString.js";
-import { PersonalityTraitPrerequisites } from "./_Prerequisite.js";
-import { PersonalityTraitReference } from "./_SimpleReferences.js";
-import { Errata } from "./source/_Erratum.js";
-import { PublicationRefs } from "./source/_PublicationRef.js";
-/**
- * A personality trait describes character aspects of a person from a certain
- * region. Higher trait levels only cover a part of the region covered by
- * lower-level traits.
- * @title Personality Trait
- */
-export type PersonalityTrait = {
-    /**
-     * The personality trait's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * The personality trait's level.
-     * @integer
-     * @minimum 1
-     * @maximum 3
-     */
-    level: number;
-    prerequisites?: PersonalityTraitPrerequisites;
-    /**
-     * The lower-level personality trait(s) this trait can be combined with.
-     * @minItems 1
-     * @uniqueItems
-     */
-    combination_options?: PersonalityTraitReference[];
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<PersonalityTraitTranslation>;
-};
-export type PersonalityTraitTranslation = {
-    /**
-     * The name of the personality trait.
-     */
-    name: NonEmptyString;
-    /**
-     * The effects of the personality trait. They should be sorted like they
-     * are in the book.
-     * @minItems 1
-     */
-    effects: PersonalityTraitEffect[];
-    errata?: Errata;
-};
-export type PersonalityTraitEffect = {
-    /**
-     * A label that is displayed and placed before the actual text.
-     */
-    label?: NonEmptyString;
-    /**
-     * The effect text.
-     */
-    text: NonEmptyString;
-};
-export declare const config: TypeConfig<PersonalityTrait, PersonalityTrait["id"], "PersonalityTrait">;
+import { Array, Entity, IncludeIdentifier, Integer, Object, String, TypeAlias } from "tsondb/schema/def";
+export declare const PersonalityTrait: Entity<"PersonalityTrait", {
+    level: import("tsondb/schema/def").MemberDecl<Integer, true>;
+    prerequisites: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"PersonalityTraitPrerequisites", IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], TypeAlias<"PlainPrerequisites", Array<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").EnumDecl<"PrerequisitesElement", {
+        Single: import("tsondb/schema/def").EnumCaseDecl<import("tsondb/schema/def").TypeArgumentType<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>;
+        Disjunction: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], TypeAlias<"PrerequisitesDisjunction", Object<{
+            list: import("tsondb/schema/def").MemberDecl<Array<import("tsondb/schema/def").TypeArgumentType<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>, true>;
+            display_option: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"DisplayOption", {
+                Hide: import("tsondb/schema/def").EnumCaseDecl<null>;
+                ReplaceWith: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], TypeAlias<"ReplacementDisplayOption", Object<{
+                    sentence_type: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"SentenceType", {
+                        Standalone: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        Connected: import("tsondb/schema/def").EnumCaseDecl<null>;
+                    }, []>>, false>;
+                    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"ReplacementDisplayOptionTranslation", {
+                        replacement: import("tsondb/schema/def").MemberDecl<String, true>;
+                    }>, true>;
+                }>, []>>>;
+            }, []>>, false>;
+        }>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>;
+        Group: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], TypeAlias<"PrerequisiteGroup", Object<{
+            list: import("tsondb/schema/def").MemberDecl<Array<import("tsondb/schema/def").TypeArgumentType<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>, true>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"PrerequisiteGroupTranslation", {
+                text: import("tsondb/schema/def").MemberDecl<String, true>;
+            }>, true>;
+        }>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>;
+    }, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>, []>>, false>;
+    combination_options: import("tsondb/schema/def").MemberDecl<Array<import("tsondb/schema/def").ReferenceIdentifierType>, false>;
+    src: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"PublicationRefs", Array<IncludeIdentifier<[], TypeAlias<"PublicationRef", Object<{
+        id: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, true>;
+        occurrences: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"Occurrence", {
+            initial: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"InitialOccurrence", Object<{
+                printing: import("tsondb/schema/def").MemberDecl<Integer, false>;
+                pages: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], TypeAlias<"PageRange", Object<{
+                    first_page: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"Page", {
+                        InsideCoverFront: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        InsideCoverBack: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        Numbered: import("tsondb/schema/def").EnumCaseDecl<Integer>;
+                    }, []>>, true>;
+                    last_page: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"Page", {
+                        InsideCoverFront: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        InsideCoverBack: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        Numbered: import("tsondb/schema/def").EnumCaseDecl<Integer>;
+                    }, []>>, false>;
+                }>, []>>>, true>;
+            }>, []>>, true>;
+            revisions: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"Revision", {
+                Since: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], TypeAlias<"Since", Object<{
+                    printing: import("tsondb/schema/def").MemberDecl<Integer, true>;
+                    pages: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], TypeAlias<"PageRange", Object<{
+                        first_page: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"Page", {
+                            InsideCoverFront: import("tsondb/schema/def").EnumCaseDecl<null>;
+                            InsideCoverBack: import("tsondb/schema/def").EnumCaseDecl<null>;
+                            Numbered: import("tsondb/schema/def").EnumCaseDecl<Integer>;
+                        }, []>>, true>;
+                        last_page: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"Page", {
+                            InsideCoverFront: import("tsondb/schema/def").EnumCaseDecl<null>;
+                            InsideCoverBack: import("tsondb/schema/def").EnumCaseDecl<null>;
+                            Numbered: import("tsondb/schema/def").EnumCaseDecl<Integer>;
+                        }, []>>, false>;
+                    }>, []>>>, true>;
+                }>, []>>>;
+                Deprecated: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], TypeAlias<"Deprecation", Object<{
+                    printing: import("tsondb/schema/def").MemberDecl<Integer, true>;
+                }>, []>>>;
+            }, []>>>, false>;
+        }>, true>;
+    }>, []>>>, []>>, true>;
+    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"PersonalityTraitTranslation", {
+        name: import("tsondb/schema/def").MemberDecl<String, true>;
+        effects: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], TypeAlias<"PersonalityTraitEffect", Object<{
+            label: import("tsondb/schema/def").MemberDecl<String, false>;
+            text: import("tsondb/schema/def").MemberDecl<String, true>;
+        }>, []>>>, true>;
+        errata: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"Errata", Array<IncludeIdentifier<[], TypeAlias<"Erratum", Object<{
+            date: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").DateType, true>;
+            description: import("tsondb/schema/def").MemberDecl<String, true>;
+        }>, []>>>, []>>, false>;
+    }>, true>;
+}, undefined>;

package/lib/types/PersonalityTrait.js

@@ -1,14 +1,52 @@
-/**
- * @main PersonalityTrait
- */
-import { todo } from "../validation/builders/integrity.js";
-import { validateEntityFileName } from "../validation/builders/naming.js";
-import { createSchemaValidator } from "../validation/builders/schema.js";
-import { getFilenamePrefixAsNumericId } from "../validation/filename.js";
-export const config = {
+import { Array, Entity, IncludeIdentifier, Integer, Object, Optional, Required, String, TypeAlias, } from "tsondb/schema/def";
+import { NestedLocaleMap } from "./Locale.js";
+import { PersonalityTraitIdentifier } from "./_Identifier.js";
+import { PersonalityTraitPrerequisites } from "./_Prerequisite.js";
+import { Errata } from "./source/_Erratum.js";
+import { src } from "./source/_PublicationRef.js";
+export const PersonalityTrait = Entity(import.meta.url, {
     name: "PersonalityTrait",
-    id: getFilenamePrefixAsNumericId,
-    integrityValidator: todo("PersonalityTrait"),
-    schemaValidator: createSchemaValidator(import.meta.url),
-    fileNameValidator: validateEntityFileName,
-};
+    namePlural: "PersonalityTraits",
+    comment: "A personality trait describes character aspects of a person from a certain region. Higher trait levels only cover a part of the region covered by lower-level traits.",
+    type: () => Object({
+        level: Required({
+            comment: "The personality trait’s level.",
+            type: Integer({ minimum: 1, maximum: 3 }),
+        }),
+        prerequisites: Optional({
+            type: IncludeIdentifier(PersonalityTraitPrerequisites),
+        }),
+        combination_options: Optional({
+            comment: "The lower-level personality trait(s) this trait can be combined with.",
+            type: Array(PersonalityTraitIdentifier(), { minItems: 1, uniqueItems: true }),
+        }),
+        src,
+        translations: NestedLocaleMap(Required, "PersonalityTraitTranslation", Object({
+            name: Required({
+                comment: "The personality trait’s name.",
+                type: String({ minLength: 1 }),
+            }),
+            effects: Required({
+                comment: "The effects of the personality trait. They should be sorted like they are in the book.",
+                type: Array(IncludeIdentifier(PersonalityTraitEffect), { minItems: 1 }),
+            }),
+            errata: Optional({
+                type: IncludeIdentifier(Errata),
+            }),
+        })),
+    }),
+    displayName: {},
+});
+const PersonalityTraitEffect = TypeAlias(import.meta.url, {
+    name: "PersonalityTraitEffect",
+    type: () => Object({
+        label: Optional({
+            comment: "A label that is displayed and placed before the actual text.",
+            type: String({ minLength: 1 }),
+        }),
+        text: Required({
+            comment: "The effect text.",
+            type: String({ minLength: 1 }),
+        }),
+    }),
+});