@datasworn-community/core 0.2.0

package/dist/esm/IdElements/TypeId.js

@@ -0,0 +1,257 @@
+import { TypeSep } from './CONST.js';
+/**
+ * Datasworn ID elements that represent specific types of Datasworn object. They appear in the second position, immediately after the {@link RulesPackageId} element.
+ *
+ * On major nodes, TypeIds always have the same value as `type` property. In other words, the `type` of the ID's target is always reconstructable from the ID.
+ */
+var TypeId;
+(function (TypeId) {
+    /** Object types that can exist in collections. */
+    TypeId.Collectable = [
+        'atlas_entry',
+        'npc',
+        'oracle_rollable',
+        'asset',
+        'move'
+    ];
+    TypeId.Collection = [
+        'atlas_collection',
+        'npc_collection',
+        'oracle_collection',
+        'asset_collection',
+        'move_category'
+    ];
+    /** ID type elements for types that don't use collections at all. */
+    TypeId.NonCollectable = [
+        'delve_site',
+        'delve_site_domain',
+        'delve_site_theme',
+        'rarity',
+        'truth'
+    ];
+    TypeId.Primary = [
+        ...TypeId.Collectable,
+        ...TypeId.Collection,
+        ...TypeId.NonCollectable
+    ];
+    TypeId.CollectedByMap = {
+        asset_collection: 'asset',
+        move_category: 'move',
+        atlas_collection: 'atlas_entry',
+        npc_collection: 'npc',
+        oracle_collection: 'oracle_rollable'
+    };
+    function getCollectableOf(typeId) {
+        return TypeId.CollectedByMap[typeId];
+    }
+    TypeId.getCollectableOf = getCollectableOf;
+    TypeId.CollectionOfMap = {
+        asset: 'asset_collection',
+        move: 'move_category',
+        atlas_entry: 'atlas_collection',
+        npc: 'npc_collection',
+        oracle_rollable: 'oracle_collection'
+    };
+    function getCollectionOf(typeId) {
+        return TypeId.CollectionOfMap[typeId];
+    }
+    TypeId.getCollectionOf = getCollectionOf;
+    TypeId.EmbeddablePrimary = [
+        'oracle_rollable',
+        'move'
+    ];
+    TypeId.EmbedOnly = [
+        'ability',
+        'condition',
+        'outcome',
+        'option',
+        'row',
+        'feature',
+        'danger',
+        'denizen',
+        'variant'
+    ];
+    TypeId.Embeddable = [
+        'oracle_rollable',
+        'move',
+        'ability',
+        'condition',
+        'outcome',
+        'option',
+        'row',
+        'feature',
+        'danger',
+        'denizen',
+        'variant'
+    ];
+    TypeId.EmbedTypeMap = {
+        asset: ['ability'],
+        ability: ['move', 'oracle_rollable'],
+        truth: ['option'],
+        option: ['oracle_rollable'],
+        move: ['condition', 'outcome', 'oracle_rollable'],
+        oracle_rollable: ['row'],
+        delve_site: ['denizen'],
+        delve_site_domain: ['feature', 'danger'],
+        delve_site_theme: ['feature', 'danger'],
+        npc: ['variant']
+    };
+    /** Types that can be an embed of an embed. */
+    TypeId.EmbeddableInEmbeddedTypeMap = {
+        ability: ['oracle_rollable', 'move'],
+        move: ['condition', 'outcome'],
+        option: ['oracle_rollable'],
+        oracle_rollable: ['row']
+    };
+    function canHaveEmbed(typeId, typeIsEmbedded = false) {
+        return getEmbeddableTypes(typeId, typeIsEmbedded).length > 0;
+    }
+    TypeId.canHaveEmbed = canHaveEmbed;
+    function canBeEmbedded(typeId) {
+        return getTypesThatCanHaveEmbedOfType(typeId).length > 0;
+    }
+    TypeId.canBeEmbedded = canBeEmbedded;
+    function isPrimary(typeId) {
+        return TypeId.Primary.includes(typeId);
+    }
+    TypeId.isPrimary = isPrimary;
+    function isEmbedOnly(typeId) {
+        return TypeId.EmbedOnly.includes(typeId);
+    }
+    TypeId.isEmbedOnly = isEmbedOnly;
+    function getEmbeddableTypes(embeddingType, typeIsEmbedded = false) {
+        if (typeIsEmbedded)
+            return (TypeId.EmbeddableInEmbeddedTypeMap[embeddingType] ?? []);
+        return TypeId.EmbedTypeMap[embeddingType] ?? [];
+    }
+    TypeId.getEmbeddableTypes = getEmbeddableTypes;
+    function getTypesThatCanHaveEmbedOfType(typeId) {
+        const typeIds = [];
+        for (const embedder in TypeId.EmbedTypeMap) {
+            const embeddables = TypeId.EmbedTypeMap[embedder];
+            if (embeddables.includes(typeId))
+                typeIds.push(embedder);
+        }
+        return typeIds;
+    }
+    TypeId.getTypesThatCanHaveEmbedOfType = getTypesThatCanHaveEmbedOfType;
+    TypeId.EmbeddedTypePath = [];
+    function expandTypePath(typeId, path = []) {
+        const isPrimary = path.length === 0;
+        const thisPath = [...path, typeId];
+        if (!isPrimary)
+            TypeId.EmbeddedTypePath.push(thisPath.join(TypeSep));
+        if (typeId in TypeId.EmbedTypeMap) {
+            for (const childTypeId of TypeId.EmbedTypeMap[typeId])
+                if (isPrimary ||
+                    (TypeId.EmbeddableInEmbeddedTypeMap[typeId] ??
+                        []).includes(childTypeId))
+                    expandTypePath(childTypeId, thisPath);
+        }
+    }
+    for (const typeId in TypeId.EmbedTypeMap)
+        expandTypePath(typeId);
+    TypeId.EmbeddedPropertyKeys = {
+        ability: 'abilities',
+        condition: 'trigger.conditions',
+        outcome: 'outcomes',
+        option: 'options',
+        row: 'rows',
+        feature: 'features',
+        danger: 'dangers',
+        denizen: 'denizens',
+        variant: 'variants'
+    };
+    // TODO
+    // is there a logic to this that i can formalize?
+    // i think it comes down to whether the type has a required `name` property to generate a key from.
+    const EmbeddedPropertyType = {
+        abilities: 'array',
+        'trigger.conditions': 'array',
+        outcomes: 'dictionary',
+        dangers: 'array',
+        denizens: 'array',
+        features: 'array',
+        options: 'array',
+        rows: 'array',
+        variants: 'dictionary'
+    };
+    function getEmbeddedPropertyType(typeId) {
+        if (TypeId.Primary.includes(typeId))
+            return 'dictionary';
+        const propKey = getEmbeddedPropertyKey(typeId);
+        if (propKey == null)
+            throw new Error(`Expected an embeddable TypeId, but got ${String(typeId)}`);
+        return EmbeddedPropertyType[propKey];
+    }
+    TypeId.getEmbeddedPropertyType = getEmbeddedPropertyType;
+    TypeId.Any = [
+        'atlas_entry',
+        'npc',
+        'oracle_rollable',
+        'asset',
+        'move',
+        'atlas_collection',
+        'npc_collection',
+        'oracle_collection',
+        'asset_collection',
+        'move_category',
+        'delve_site',
+        'delve_site_domain',
+        'delve_site_theme',
+        'rarity',
+        'truth',
+        'ability',
+        'condition',
+        'outcome',
+        'option',
+        'row',
+        'feature',
+        'danger',
+        'denizen',
+        'variant'
+    ];
+    // | EmbeddedTypePath | EmbedOfEmbedTypePaths
+    /** The ancestor key of this type on the {@link Datasworn.RulesPackage} object. */
+    TypeId.BranchKey = {
+        asset_collection: 'assets',
+        asset: 'assets',
+        move_category: 'moves',
+        move: 'moves',
+        atlas_collection: 'atlas',
+        atlas_entry: 'atlas',
+        npc_collection: 'npcs',
+        npc: 'npcs',
+        oracle_collection: 'oracles',
+        oracle_rollable: 'oracles',
+        delve_site: 'delve_sites',
+        truth: 'truths',
+        delve_site_domain: 'site_domains',
+        delve_site_theme: 'site_themes',
+        rarity: 'rarities'
+    };
+    function getBranchKey(typeId) {
+        const result = TypeId.BranchKey[typeId];
+        if (result == null)
+            throw new Error(`Expected primary TypeId but got ${typeId}`);
+        return result;
+    }
+    TypeId.getBranchKey = getBranchKey;
+    function getEmbeddedPropertyKey(typeId) {
+        const result = typeId in TypeId.EmbeddedPropertyKeys
+            ? // @ts-expect-error
+                TypeId.EmbeddedPropertyKeys[typeId]
+            : null;
+        if (result != null)
+            return result;
+        try {
+            return getBranchKey(typeId);
+        }
+        catch (_e) {
+            throw new Error(`Expected embeddable TypeId but got ${typeId}`);
+        }
+    }
+    TypeId.getEmbeddedPropertyKey = getEmbeddedPropertyKey;
+})(TypeId || (TypeId = {}));
+export default TypeId;
+//# sourceMappingURL=TypeId.js.map

package/dist/esm/IdElements/TypeId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypeId.js","sourceRoot":"","sources":["../../../src/IdElements/TypeId.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEpC;;;;GAIG;AACH,IAAU,MAAM,CA8Uf;AA9UD,WAAU,MAAM;IACf,kDAAkD;IACrC,kBAAW,GAAG;QAC1B,aAAa;QACb,KAAK;QACL,iBAAiB;QACjB,OAAO;QACP,MAAM;KACG,CAAA;IAGG,iBAAU,GAAG;QACzB,kBAAkB;QAClB,gBAAgB;QAChB,mBAAmB;QACnB,kBAAkB;QAClB,eAAe;KACN,CAAA;IAGV,oEAAoE;IACvD,qBAAc,GAAG;QAC7B,YAAY;QACZ,mBAAmB;QACnB,kBAAkB;QAClB,QAAQ;QACR,OAAO;KACE,CAAA;IAMG,cAAO,GAAG;QACtB,GAAG,OAAA,WAAW;QACd,GAAG,OAAA,UAAU;QACb,GAAG,OAAA,cAAc;KAKjB,CAAA;IAEY,qBAAc,GAAG;QAC7B,gBAAgB,EAAE,OAAO;QACzB,aAAa,EAAE,MAAM;QACrB,gBAAgB,EAAE,aAAa;QAC/B,cAAc,EAAE,KAAK;QACrB,iBAAiB,EAAE,iBAAiB;KACe,CAAA;IAIpD,SAAgB,gBAAgB,CAAuB,MAAS;QAC/D,OAAO,OAAA,cAAc,CAAC,MAAM,CAAqB,CAAA;IAClD,CAAC;IAFe,uBAAgB,mBAE/B,CAAA;IAEY,sBAAe,GAAG;QAC9B,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,eAAe;QACrB,WAAW,EAAE,kBAAkB;QAC/B,GAAG,EAAE,gBAAgB;QACrB,eAAe,EAAE,mBAAmB;KAGpC,CAAA;IAGD,SAAgB,eAAe,CAAwB,MAAS;QAC/D,OAAO,OAAA,eAAe,CAAC,MAAM,CAAoB,CAAA;IAClD,CAAC;IAFe,sBAAe,kBAE9B,CAAA;IAEY,wBAAiB,GAAG;QAChC,iBAAiB;QACjB,MAAM;KACmD,CAAA;IAE7C,gBAAS,GAAG;QACxB,SAAS;QACT,WAAW;QACX,SAAS;QACT,QAAQ;QACR,KAAK;QACL,SAAS;QACT,QAAQ;QACR,SAAS;QACT,SAAS;KACA,CAAA;IAEG,iBAAU,GAAG;QACzB,iBAAiB;QACjB,MAAM;QACN,SAAS;QACT,WAAW;QACX,SAAS;QACT,QAAQ;QACR,KAAK;QACL,SAAS;QACT,QAAQ;QACR,SAAS;QACT,SAAS;KAC6D,CAAA;IAG1D,mBAAY,GAAG;QAC3B,KAAK,EAAE,CAAC,SAAS,CAAC;QAClB,OAAO,EAAE,CAAC,MAAM,EAAE,iBAAiB,CAAC;QACpC,KAAK,EAAE,CAAC,QAAQ,CAAC;QACjB,MAAM,EAAE,CAAC,iBAAiB,CAAC;QAC3B,IAAI,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,iBAAiB,CAAC;QACjD,eAAe,EAAE,CAAC,KAAK,CAAC;QACxB,UAAU,EAAE,CAAC,SAAS,CAAC;QACvB,iBAAiB,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;QACxC,gBAAgB,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;QACvC,GAAG,EAAE,CAAC,SAAS,CAAC;KACsD,CAAA;IAMvE,8CAA8C;IACjC,kCAA2B,GAAG;QAC1C,OAAO,EAAE,CAAC,iBAAiB,EAAE,MAAM,CAAC;QACpC,IAAI,EAAE,CAAC,WAAW,EAAE,SAAS,CAAC;QAC9B,MAAM,EAAE,CAAC,iBAAiB,CAAC;QAC3B,eAAe,EAAE,CAAC,KAAK,CAAC;KAGxB,CAAA;IASD,SAAgB,YAAY,CAC3B,MAAc,EACd,cAAc,GAAG,KAAK;QAEtB,OAAO,kBAAkB,CAAC,MAAa,EAAE,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;IACpE,CAAC;IALe,mBAAY,eAK3B,CAAA;IAED,SAAgB,aAAa,CAAC,MAAc;QAC3C,OAAO,8BAA8B,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;IACzD,CAAC;IAFe,oBAAa,gBAE5B,CAAA;IAED,SAAgB,SAAS,CAAC,MAAc;QACvC,OAAO,OAAA,OAAO,CAAC,QAAQ,CAAC,MAAiB,CAAC,CAAA;IAC3C,CAAC;IAFe,gBAAS,YAExB,CAAA;IACD,SAAgB,WAAW,CAAC,MAAc;QACzC,OAAO,OAAA,SAAS,CAAC,QAAQ,CAAC,MAAmB,CAAC,CAAA;IAC/C,CAAC;IAFe,kBAAW,cAE1B,CAAA;IAED,SAAgB,kBAAkB,CACjC,aAAkB,EAClB,cAAc,GAAG,KAAK;QAEtB,IAAI,cAAc;YACjB,OAAO,CACL,OAAA,2BAA4D,CAC5D,aAAa,CACb,IAAI,EAAE,CACP,CAAA;QAEF,OAAQ,OAAA,YAA6C,CAAC,aAAa,CAAC,IAAI,EAAE,CAAA;IAC3E,CAAC;IAZe,yBAAkB,qBAYjC,CAAA;IAED,SAAgB,8BAA8B,CAAC,MAAc;QAC5D,MAAM,OAAO,GAAgB,EAAE,CAAA;QAE/B,KAAK,MAAM,QAAQ,IAAI,OAAA,YAAY,EAAE,CAAC;YACrC,MAAM,WAAW,GAAI,OAAA,YAAyC,CAAC,QAAQ,CAAC,CAAA;YACxE,IAAI,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,QAAqB,CAAC,CAAA;QACtE,CAAC;QAED,OAAO,OAAO,CAAA;IACf,CAAC;IATe,qCAA8B,iCAS7C,CAAA;IAMY,uBAAgB,GAAG,EAAc,CAAA;IAE9C,SAAS,cAAc,CAAC,MAAiB,EAAE,OAAiB,EAAE;QAC7D,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,KAAK,CAAC,CAAA;QACnC,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,CAAA;QAClC,IAAI,CAAC,SAAS;YAAE,OAAA,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QAC7D,IAAI,MAAM,IAAI,OAAA,YAAY,EAAE,CAAC;YAC5B,KAAK,MAAM,WAAW,IAAK,OAAA,YAAyC,CACnE,MAAM,CACN;gBACA,IACC,SAAS;oBACT,CACE,OAAA,2BAAwD,CAAC,MAAM,CAAC;wBACjE,EAAE,CACF,CAAC,QAAQ,CAAC,WAAW,CAAC;oBAEvB,cAAc,CAAC,WAAwB,EAAE,QAAQ,CAAC,CAAA;QACrD,CAAC;IACF,CAAC;IAED,KAAK,MAAM,MAAM,IAAI,OAAA,YAAY;QAAE,cAAc,CAAC,MAAmB,CAAC,CAAA;IAEzD,2BAAoB,GAAG;QACnC,OAAO,EAAE,WAAW;QACpB,SAAS,EAAE,oBAAoB;QAC/B,OAAO,EAAE,UAAU;QACnB,MAAM,EAAE,SAAS;QACjB,GAAG,EAAE,MAAM;QACX,OAAO,EAAE,UAAU;QACnB,MAAM,EAAE,SAAS;QACjB,OAAO,EAAE,UAAU;QACnB,OAAO,EAAE,UAAU;KAC0B,CAAA;IAE9C,OAAO;IACP,iDAAiD;IACjD,mGAAmG;IACnG,MAAM,oBAAoB,GAAG;QAC5B,SAAS,EAAE,OAAO;QAClB,oBAAoB,EAAE,OAAO;QAC7B,QAAQ,EAAE,YAAY;QACtB,OAAO,EAAE,OAAO;QAChB,QAAQ,EAAE,OAAO;QACjB,QAAQ,EAAE,OAAO;QACjB,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,YAAY;KAItB,CAAA;IAED,SAAgB,uBAAuB,CACtC,MAAkB;QAElB,IAAI,OAAA,OAAO,CAAC,QAAQ,CAAC,MAAiB,CAAC;YAAE,OAAO,YAAY,CAAA;QAE5D,MAAM,OAAO,GAAG,sBAAsB,CAAC,MAAmB,CAAC,CAAA;QAE3D,IAAI,OAAO,IAAI,IAAI;YAClB,MAAM,IAAI,KAAK,CACd,0CAA0C,MAAM,CAAC,MAAM,CAAC,EAAE,CAC1D,CAAA;QAEF,OAAO,oBAAoB,CAAC,OAAO,CAAC,CAAA;IACrC,CAAC;IAbe,8BAAuB,0BAatC,CAAA;IAGY,UAAG,GAAG;QAClB,aAAa;QACb,KAAK;QACL,iBAAiB;QACjB,OAAO;QACP,MAAM;QACN,kBAAkB;QAClB,gBAAgB;QAChB,mBAAmB;QACnB,kBAAkB;QAClB,eAAe;QACf,YAAY;QACZ,mBAAmB;QACnB,kBAAkB;QAClB,QAAQ;QACR,OAAO;QACP,SAAS;QACT,WAAW;QACX,SAAS;QACT,QAAQ;QACR,KAAK;QACL,SAAS;QACT,QAAQ;QACR,SAAS;QACT,SAAS;KACmD,CAAA;IAC7D,6CAA6C;IAE7C,kFAAkF;IACrE,gBAAS,GAAG;QACxB,gBAAgB,EAAE,QAAQ;QAC1B,KAAK,EAAE,QAAQ;QACf,aAAa,EAAE,OAAO;QACtB,IAAI,EAAE,OAAO;QACb,gBAAgB,EAAE,OAAO;QACzB,WAAW,EAAE,OAAO;QACpB,cAAc,EAAE,MAAM;QACtB,GAAG,EAAE,MAAM;QACX,iBAAiB,EAAE,SAAS;QAC5B,eAAe,EAAE,SAAS;QAC1B,UAAU,EAAE,aAAa;QACzB,KAAK,EAAE,QAAQ;QACf,iBAAiB,EAAE,cAAc;QACjC,gBAAgB,EAAE,aAAa;QAC/B,MAAM,EAAE,UAAU;KAC+C,CAAA;IAYlE,SAAgB,YAAY,CAAoB,MAAS;QACxD,MAAM,MAAM,GAAG,OAAA,SAAS,CAAC,MAAM,CAAiB,CAAA;QAChD,IAAI,MAAM,IAAI,IAAI;YACjB,MAAM,IAAI,KAAK,CAAC,mCAAmC,MAAM,EAAE,CAAC,CAAA;QAC7D,OAAO,MAAM,CAAA;IACd,CAAC;IALe,mBAAY,eAK3B,CAAA;IACD,SAAgB,sBAAsB,CACrC,MAAS;QAET,MAAM,MAAM,GACX,MAAM,IAAI,OAAA,oBAAoB;YAC7B,CAAC,CAAC,mBAAmB;gBACpB,OAAA,oBAAoB,CAAC,MAAM,CAAC;YAC7B,CAAC,CAAC,IAAI,CAAA;QAER,IAAI,MAAM,IAAI,IAAI;YAAE,OAAO,MAAM,CAAA;QAEjC,IAAI,CAAC;YACJ,OAAO,YAAY,CAAC,MAAa,CAAC,CAAA;QACnC,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,sCAAsC,MAAM,EAAE,CAAC,CAAA;QAChE,CAAC;IACF,CAAC;IAhBe,6BAAsB,yBAgBrC,CAAA;AACF,CAAC,EA9US,MAAM,KAAN,MAAM,QA8Uf;AAED,eAAe,MAAM,CAAA"}

package/dist/esm/IdElements/index.d.ts

@@ -0,0 +1,6 @@
+export * as CONST from './CONST.js';
+export * as PathKeys from './PathKeys.js';
+export { default as Pattern } from './Pattern.js';
+export { default as TypeGuard } from './TypeGuard.js';
+export { default as TypeId } from './TypeId.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/IdElements/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/IdElements/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAA"}

package/dist/esm/IdElements/index.js

@@ -0,0 +1,6 @@
+export * as CONST from './CONST.js';
+export * as PathKeys from './PathKeys.js';
+export { default as Pattern } from './Pattern.js';
+export { default as TypeGuard } from './TypeGuard.js';
+export { default as TypeId } from './TypeId.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/IdElements/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/IdElements/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAA"}