zen-flow 2.0.0 → 2.0.3

package/README.md

@@ -87,6 +87,7 @@ Array.from({ length: 11 })
 
 ## API
 
+ - Types(#types)
  - MineCraft
    - [Vanilla](#vanilla)
       - [Crafting patterns](#craftingpatterns)
@@ -100,6 +101,52 @@ Array.from({ length: 11 })
     - [NEI](#nei)
     - [ThermalExpansion](#thermalexpansion)
 
+## Types
+
+```TS
+type Stack = {
+  id: string,
+  n: number
+};
+
+type Ingredient = string | Stack;
+
+type RecipeShaped = Partial<{
+  1: string
+  2: string
+  3: string
+  4: string
+  5: string
+  6: string
+  7: string
+  8: string
+  9: string
+  corner: string
+  edge: string
+  ring: string
+  square: string
+  center: string
+}>;
+
+type RecipeShapeless = string[];
+
+type Recipe = RecipeShaped | RecipeShapeless;
+
+type Enchantment = {
+  type: keyof typeof ENCHANTMENTS
+  level?: number | string
+  short?: boolean
+};
+
+type TextRich = {
+  text: string
+  color?: typeof COLORS[number],
+  format?: typeof FORMATS[number]
+};
+
+type Text = string | TextRich;
+```
+
 ## Vanilla
 
  - `add` - Add a crafting table recipe.
@@ -184,15 +231,15 @@ Shaped crafting recipes support the following shorthand patterns, in order:
 withName('<minecraft:bread>', 'Bread');
 
 // Bread (with red text)
-withName('<minecraft:bread>', ['Bread', { colour: 'red' }]);
+withName('<minecraft:bread>', { text: 'Bread', colour: 'red' });
 
 // Bread (bold red text)
-withName('<minecraft:bread>', ['Bread', { colour: 'red', format: 'bold' }]);
+withName('<minecraft:bread>', { text: 'Bread', colour: 'red', format: 'bold' });
 
 // Bread (normal text) with butter (yellow italic text)
 withName('<minecraft:bread>', [
   'Bread',
-  ['with butter', { colour: 'yellow', format: 'italic' }]
+  { text: 'with butter', colour: 'yellow', format: 'italic' }
 ]);
 ```
 
@@ -227,10 +274,10 @@ withName('<minecraft:bread>', [
 import { exnihilo } from 'zen-flow';
 
 exnilo.addHammer('<minecraft:cobblestone>', {
-  '<minecraft:stick>': [0.5], // 50%
+  '<minecraft:stick>': 0.5, // 50%
   '<minecraft:bread>': [1, 1, 0.5] // 100%, 100%, 50%
-  '<minecraft:stone>': [[1, 2], [0.5, 1]] // 100% with 2x modifier, 50% with 1x modifier
-  '<minecraft:coal>': [[1, 2], 1] // 100% with 2x modifier, 100% 
+  '<minecraft:stone>': [{ chance: 1, modifier: 2 }, { chance: 0.5, modifier: 1 }] // 100% with 2x modifier, 50% with 1x modifier
+  '<minecraft:coal>': [{ chance: 1, modifier: 2 }, 1] // 100% with 2x modifier, 100% 
 });
 
 exnihilo.addSieve('<minecraft:cobblestone>', {
@@ -276,3 +323,5 @@ exnihilo.addSieve('<minecraft:cobblestone>', {
  - `removeTransposerFill` - Remove Fluid Transposer fill recipe
  - `addTransposerExtract` - Add Fluid Transposer extract recipe
  - `removeTransposerExtract` - Remove Fluid Transposer extract recipe
+
+<i>* All bonus properties take a number between 1 and 100</i>

package/dist/zenflow.cjs

@@ -122,7 +122,7 @@ const formatName = (texts) => {
       text.format && NAME_FORMAT[text.format],
       text.text,
       (text.color || text.format) && NAME_FORMAT.reset
-    ].filter((x) => x).join("");
+    ].filter((x) => x !== void 0).join("");
   }).join("");
   return `"${formatted}"`;
 };
@@ -151,7 +151,7 @@ const formatRecipe = (recipe) => {
 ]`;
 };
 const formatArgs = (...args) => {
-  const list = args.filter((x) => x).map((x) => Array.isArray(x) ? formatList(x) : x);
+  const list = args.filter((x) => x !== void 0).map((x) => Array.isArray(x) ? formatList(x) : x);
   return list.length > 3 ? `
 	${list.join(",\n	")}
 ` : list.join(", ");
@@ -213,8 +213,8 @@ const replaceQED = (ingredient, recipe) => [
 const addDict = (dict, ids) => ids.map((id) => `${dict}.add(${id});`).join("\n");
 const removeDict = (dict, ids) => ids.map((id) => `${dict}.remove(${id});`).join("\n");
 const withName = (id, name) => `${id}.displayName = ${formatName(name)};`;
-const withTooltip = (id, tooltips) => toArray(tooltips).map((tooltip) => `${id}.addTooltip(${formatTooltip(tooltip)});`).join("\n");
-const withTooltipShift = (id, tooltips) => toArray(tooltips).map((tooltip) => `${id}.addShiftTooltip(${formatTooltip(tooltip)});`).join("\n");
+const withTooltip = (id, tooltip) => `${id}.addTooltip(${formatTooltip(tooltip)});`;
+const withTooltipShift = (id, tooltip) => `${id}.addShiftTooltip(${formatTooltip(tooltip)});`;
 const withTag = (tag) => (id) => `${id}.withTag(${tag})`;
 const withEnchantment = (enchantments) => withTag(`{ ench: ${formatList(toArray(enchantments).map(formatEnchantment))} }`);
 
@@ -288,7 +288,7 @@ const addFurnace = (recipe) => {
 const removeFurnace = (recipe) => {
   if (typeof recipe === "string")
     return `furnace.remove(<*>, ${recipe});`;
-  return `furnace.remove(${formatArgs(recipe.out, recipe.in)})`;
+  return `furnace.remove(${formatArgs(recipe.out, recipe.in)});`;
 };
 const replace = (ingredient, recipe) => {
   const id = isObject(ingredient) ? ingredient.id : ingredient;

package/dist/zenflow.d.ts

@@ -157,8 +157,8 @@ declare const addDict: (dict: string, ids: string[]) => string;
 */
 declare const removeDict: (dict: string, ids: string[]) => string;
 declare const withName: (id: string, name: Text) => string;
-declare const withTooltip: (id: string, tooltips: Text | Text[]) => string;
-declare const withTooltipShift: (id: string, tooltips: Text | Text[]) => string;
+declare const withTooltip: (id: string, tooltip: Text | Text[]) => string;
+declare const withTooltipShift: (id: string, tooltip: Text | Text[]) => string;
 declare const withTag: (tag: string) => (id: string) => string;
 declare const withEnchantment: (enchantments: Enchantment | Enchantment[]) => (id: string) => string;
 

package/dist/zenflow.mjs

@@ -118,7 +118,7 @@ const formatName = (texts) => {
       text.format && NAME_FORMAT[text.format],
       text.text,
       (text.color || text.format) && NAME_FORMAT.reset
-    ].filter((x) => x).join("");
+    ].filter((x) => x !== void 0).join("");
   }).join("");
   return `"${formatted}"`;
 };
@@ -147,7 +147,7 @@ const formatRecipe = (recipe) => {
 ]`;
 };
 const formatArgs = (...args) => {
-  const list = args.filter((x) => x).map((x) => Array.isArray(x) ? formatList(x) : x);
+  const list = args.filter((x) => x !== void 0).map((x) => Array.isArray(x) ? formatList(x) : x);
   return list.length > 3 ? `
 	${list.join(",\n	")}
 ` : list.join(", ");
@@ -209,8 +209,8 @@ const replaceQED = (ingredient, recipe) => [
 const addDict = (dict, ids) => ids.map((id) => `${dict}.add(${id});`).join("\n");
 const removeDict = (dict, ids) => ids.map((id) => `${dict}.remove(${id});`).join("\n");
 const withName = (id, name) => `${id}.displayName = ${formatName(name)};`;
-const withTooltip = (id, tooltips) => toArray(tooltips).map((tooltip) => `${id}.addTooltip(${formatTooltip(tooltip)});`).join("\n");
-const withTooltipShift = (id, tooltips) => toArray(tooltips).map((tooltip) => `${id}.addShiftTooltip(${formatTooltip(tooltip)});`).join("\n");
+const withTooltip = (id, tooltip) => `${id}.addTooltip(${formatTooltip(tooltip)});`;
+const withTooltipShift = (id, tooltip) => `${id}.addShiftTooltip(${formatTooltip(tooltip)});`;
 const withTag = (tag) => (id) => `${id}.withTag(${tag})`;
 const withEnchantment = (enchantments) => withTag(`{ ench: ${formatList(toArray(enchantments).map(formatEnchantment))} }`);
 
@@ -284,7 +284,7 @@ const addFurnace = (recipe) => {
 const removeFurnace = (recipe) => {
   if (typeof recipe === "string")
     return `furnace.remove(<*>, ${recipe});`;
-  return `furnace.remove(${formatArgs(recipe.out, recipe.in)})`;
+  return `furnace.remove(${formatArgs(recipe.out, recipe.in)});`;
 };
 const replace = (ingredient, recipe) => {
   const id = isObject(ingredient) ? ingredient.id : ingredient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zen-flow",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "description": "MineTweaker ZenScript made easy.",
   "main": "dist/zenflow.cjs",
   "module": "dist/zenflow.mjs",