optolith-database-schema 0.15.3 → 0.15.4

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.15.4](https://github.com/elyukai/optolith-database-schema/compare/v0.15.3...v0.15.4) (2024-01-12)
+
+
+### Features
+
+* add possible and requirable select option identifiers ([0ee088a](https://github.com/elyukai/optolith-database-schema/commit/0ee088a01b98e2f8828303d43f40ac8143db1eac))
+* add pre-generated select options for activatable entries as cache ([3fdcaf2](https://github.com/elyukai/optolith-database-schema/commit/3fdcaf2a95623e751993c1e696f2b269acbc7594))
+
+
+### Bug Fixes
+
+* add missing vampiric gift identifier to activatable identifier group ([98316b6](https://github.com/elyukai/optolith-database-schema/commit/98316b63a9b9e7dd00939d596621a3b5782e2d2e))
+* wrong identifier references in select option config ([a70a7ea](https://github.com/elyukai/optolith-database-schema/commit/a70a7ea4a02ecbcb5167ab13b1e3a1d75c327e3f))
+
 ### [0.15.3](https://github.com/elyukai/optolith-database-schema/compare/v0.15.2...v0.15.3) (2024-01-09)
 
 

package/lib/cache/activatableSelectOptions.d.ts

@@ -0,0 +1,80 @@
+import type { CacheConfig } from "../cacheConfig.js";
+import { TypeMap } from "../config/types.js";
+import { SelectOptions, SkillApplications, SkillUses } from "../types/_Activatable.js";
+import { SelectOptionIdentifier } from "../types/_IdentifierGroup.js";
+import { LocaleMap } from "../types/_LocaleMap.js";
+import { GeneralPrerequisites } from "../types/_Prerequisite.js";
+import { Errata } from "../types/source/_Erratum.js";
+import { PublicationRefs } from "../types/source/_PublicationRef.js";
+export type ResolvedSelectOption = {
+    id: SelectOptionIdentifier;
+    /**
+     * Sometimes, professions use specific text selections that are not
+     * contained in described lists. This ensures you can use them for
+     * professions only. They are not going to be displayed as options to the
+     * user.
+     */
+    profession_only?: true;
+    /**
+     * Registers new applications, which get enabled once this entry is
+     * activated with its respective select option. It specifies an entry-unique
+     * identifier and the skill it belongs to. A translation can be left out if
+     * its name equals the name of the origin select option.
+     */
+    skill_applications?: SkillApplications;
+    /**
+     * Registers uses, which get enabled once this entry is activated with its
+     * respective select option. It specifies an entry-unique identifier and the
+     * skill it belongs to. A translation can be left out if its name equals the
+     * name of the origin select option.
+     */
+    skill_uses?: SkillUses;
+    prerequisites?: GeneralPrerequisites;
+    /**
+     * Specific binding cost for the select option. Only has an effect if the
+     * associated entry supports binding costs.
+     */
+    binding_cost?: number;
+    /**
+     * Specific volume for the select option. Only has an effect if the
+     * associated entry supports volume values.
+     */
+    volume?: number;
+    /**
+     * Specific AP cost for the select option.
+     */
+    ap_value?: number;
+    src?: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ResolvedSelectOptionTranslation>;
+};
+export type ResolvedSelectOptionTranslation = {
+    /**
+     * The name of the select option.
+     */
+    name: string;
+    /**
+     * The name of the select option when displayed in a generated
+     * profession text.
+     */
+    name_in_profession?: string;
+    /**
+     * The description of the select option. Useful for Bad Habits, Trade
+     * Secrets and other entries where a description is available.
+     */
+    description?: string;
+    errata?: Errata;
+};
+export type ActivatableSelectOptionsCacheKeys = {
+    [K in keyof TypeMap]: TypeMap[K] extends {
+        select_options?: SelectOptions;
+    } ? K : never;
+}[keyof TypeMap];
+export type ActivatableSelectOptionsCache = {
+    [K in ActivatableSelectOptionsCacheKeys]: {
+        [id: number]: ResolvedSelectOption[];
+    };
+};
+export declare const config: CacheConfig<ActivatableSelectOptionsCache>;