@cobbled-creators/cobblemon-schemas 1.7.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Cobbled Creators
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# @cobbled-creators/cobblemon-schemas
+
+JSON Schemas for Cobblemon datapack and resource pack files, and a small validator: it works out
+which schema a pack file uses, validates it, and reports one plain error per problem, with line
+numbers.
+
+Each Cobblemon version has its own release line:
+
+| Cobblemon | Install | Branch |
+|---|---|---|
+| 1.8 | `npm i @cobbled-creators/cobblemon-schemas@~1.8.0` | `main` |
+| 1.7 | `npm i @cobbled-creators/cobblemon-schemas@~1.7.0` | `cobblemon/1.7` |
+
+Pin with `~`, not `^`: the minor version is the Cobblemon version, so `^1.7.0` would upgrade you to
+1.8's schemas. To use several versions at once, use npm aliases:
+
+```json
+"cobblemon-schemas-1.8": "npm:@cobbled-creators/cobblemon-schemas@~1.8.0",
+"cobblemon-schemas-1.7": "npm:@cobbled-creators/cobblemon-schemas@~1.7.0"
+```
+
+## Use
+
+Node:
+
+```js
+import { loadEngine, readPack, validatePack } from '@cobbled-creators/cobblemon-schemas/node';
+
+const engine = await loadEngine();
+engine.resolve('data/mypack/species/foo.json');      // 'schemas/species/schema.json'
+engine.check('data/mypack/species/foo.json', value); // { schema, errors: [{ pointer, keyword, params, message }] }
+
+validatePack(readPack('path/to/pack'), engine);
+// [{ file, schema, errors: [{ kind: 'syntax' | 'schema', message, line, column, pointer }] }]
+```
+
+Browser: the main entry point has no Node APIs, and the validators are precompiled (no `eval`), so it
+works under a strict Content-Security-Policy.
+
+```js
+import { SchemaEngine } from '@cobbled-creators/cobblemon-schemas';
+import bundle from '@cobbled-creators/cobblemon-schemas/bundle.json' with { type: 'json' };
+import * as validators from '@cobbled-creators/cobblemon-schemas/validators.mjs';
+
+const engine = SchemaEngine.fromBundle(bundle, validators);
+```
+
+The schemas themselves are at `@cobbled-creators/cobblemon-schemas/schemas/<type>/schema.json`, listed in
+`schemas/index.json`.
+
+CLI, run on the pack folder (the one holding `data/` and `assets/`):
+
+```bash
+npx @cobbled-creators/cobblemon-schemas validate path/to/pack   # --json for machine-readable output; exits 1 on errors
+```
+
+## Development
+
+```bash
+npm install
+npm test           # builds dist/ and runs the tests
+npm run baseline   # lists schema errors in Cobblemon's own data at package.json's cobblemon.baseline tag
+```
+
+## License
+
+MIT. The schemas started out in [cobblemon-addon-vscode](https://github.com/ppVon/cobblemon-addon-vscode).
+Not affiliated with Cobblemon, Mojang or Microsoft.

package/bin/cobblemon-schemas.mjs

@@ -0,0 +1,51 @@
+#!/usr/bin/env node
+import fs from 'node:fs';
+import { cobblemon, loadEngine, readPack, validatePack } from '../src/node.mjs';
+
+const USAGE = 'usage: cobblemon-schemas validate <pack folder> [--json]\n       cobblemon-schemas --version';
+
+function isDirectory(dir) {
+  return Boolean(dir && fs.statSync(dir, { throwIfNoEntry: false })?.isDirectory());
+}
+
+function plural(count, word) {
+  return `${count} ${word}${count === 1 ? '' : 's'}`;
+}
+
+function formatError(error) {
+  const position = error.line ? `${error.line}:${error.column}` : '-';
+  const location = error.pointer.length ? `  at /${error.pointer.join('/')}` : '';
+  return `  ${position.padEnd(8)} ${error.message}${location}`;
+}
+
+function printText(results, failing) {
+  for (const result of failing) {
+    console.log(`\n${result.file}`);
+    for (const error of result.errors) console.log(formatError(error));
+  }
+  const errorCount = failing.reduce((total, result) => total + result.errors.length, 0);
+  const summary = errorCount ? `${plural(errorCount, 'error')} in ${plural(failing.length, 'file')}` : 'no errors';
+  console.log(`\n${plural(results.length, 'file')} checked: ${summary}.`);
+}
+
+function printJson(results, failing) {
+  console.log(JSON.stringify({ cobblemon, checked: results.length, results: failing }, null, 2));
+}
+
+async function main([command, dir, ...flags]) {
+  if (command === '--version') {
+    console.log(`Cobblemon ${cobblemon.version} schemas`);
+    return 0;
+  }
+  if (command !== 'validate' || !isDirectory(dir)) {
+    console.error(USAGE);
+    return 2;
+  }
+
+  const results = validatePack(readPack(dir), await loadEngine());
+  const failing = results.filter((result) => result.errors.length);
+  (flags.includes('--json') ? printJson : printText)(results, failing);
+  return failing.length ? 1 : 0;
+}
+
+process.exit(await main(process.argv.slice(2)));

package/dist/bundle.json

@@ -0,0 +1 @@
+{"package":"1.7.0","cobblemon":{"version":"1.7","minecraft":"1.21.1","baseline":"1.7.3"},"entries":[{"path":"schemas/action_effects/schema.json","id":"https://cobblemon-schema.local/action_effects/schema.json","validator":"v0"},{"path":"schemas/behaviours/schema.json","id":"https://cobblemon-schema.local/behaviours/schema.json","validator":"v1"},{"path":"schemas/berries/schema.json","id":"https://cobblemon-schema.local/berries/schema.json","validator":"v2"},{"path":"schemas/cosmetic_items/schema.json","id":"https://cobblemon-schema.local/cosmetic_items/schema.json","validator":"v3"},{"path":"schemas/dex_entries/schema.json","id":"https://cobblemon-schema.local/dex_entries/schema.json","validator":"v4"},{"path":"schemas/dexes/schema.json","id":"https://cobblemon-schema.local/dexes/schema.json","validator":"v5"},{"path":"schemas/dialogues/schema.json","id":"https://cobblemon-schema.local/dialogues/schema.json","validator":"v6"},{"path":"schemas/fossils/schema.json","id":"https://cobblemon-schema.local/fossils/schema.json","validator":"v7"},{"path":"schemas/global_species_features/schema.json","id":"https://cobblemon-schema.local/global_species_features/schema.json","validator":"v8"},{"path":"schemas/marks/schema.json","id":"https://cobblemon-schema.local/marks/schema.json","validator":"v9"},{"path":"schemas/mechanics/aprijuices.schema.json","id":"https://cobblemon-schema.local/mechanics/aprijuices.schema.json","validator":"v10"},{"path":"schemas/mechanics/berries.schema.json","id":"https://cobblemon-schema.local/mechanics/berries.schema.json","validator":"v11"},{"path":"schemas/mechanics/potions.schema.json","id":"https://cobblemon-schema.local/mechanics/potions.schema.json","validator":"v12"},{"path":"schemas/mechanics/remedies.schema.json","id":"https://cobblemon-schema.local/mechanics/remedies.schema.json","validator":"v13"},{"path":"schemas/mechanics/slowpoke_tails.schema.json","id":"https://cobblemon-schema.local/mechanics/slowpoke_tails.schema.json","validator":"v14"},{"path":"schemas/natural_materials/schema.json","id":"https://cobblemon-schema.local/natural_materials/schema.json","validator":"v15"},{"path":"schemas/npc_presets/schema.json","id":"https://cobblemon-schema.local/npc_presets/schema.json","validator":"v16"},{"path":"schemas/npcs/schema.json","id":"https://cobblemon-schema.local/npcs/schema.json","validator":"v17"},{"path":"schemas/pokemon_interactions/schema.json","id":"https://cobblemon-schema.local/pokemon_interactions/schema.json","validator":"v18"},{"path":"schemas/pokerods/schema.json","id":"https://cobblemon-schema.local/pokerods/schema.json","validator":"v19"},{"path":"schemas/ride_settings/bird.schema.json","id":"https://cobblemon-schema.local/ride_settings/bird.schema.json","validator":"v20"},{"path":"schemas/ride_settings/boat.schema.json","id":"https://cobblemon-schema.local/ride_settings/boat.schema.json","validator":"v21"},{"path":"schemas/ride_settings/burst.schema.json","id":"https://cobblemon-schema.local/ride_settings/burst.schema.json","validator":"v22"},{"path":"schemas/ride_settings/dolphin.schema.json","id":"https://cobblemon-schema.local/ride_settings/dolphin.schema.json","validator":"v23"},{"path":"schemas/ride_settings/glider.schema.json","id":"https://cobblemon-schema.local/ride_settings/glider.schema.json","validator":"v24"},{"path":"schemas/ride_settings/helicopter.schema.json","id":"https://cobblemon-schema.local/ride_settings/helicopter.schema.json","validator":"v25"},{"path":"schemas/ride_settings/horse.schema.json","id":"https://cobblemon-schema.local/ride_settings/horse.schema.json","validator":"v26"},{"path":"schemas/ride_settings/hover.schema.json","id":"https://cobblemon-schema.local/ride_settings/hover.schema.json","validator":"v27"},{"path":"schemas/ride_settings/jet.schema.json","id":"https://cobblemon-schema.local/ride_settings/jet.schema.json","validator":"v28"},{"path":"schemas/ride_settings/minekart.schema.json","id":"https://cobblemon-schema.local/ride_settings/minekart.schema.json","validator":"v29"},{"path":"schemas/ride_settings/rocket.schema.json","id":"https://cobblemon-schema.local/ride_settings/rocket.schema.json","validator":"v30"},{"path":"schemas/ride_settings/submarine.schema.json","id":"https://cobblemon-schema.local/ride_settings/submarine.schema.json","validator":"v31"},{"path":"schemas/ride_settings/vehicle.schema.json","id":"https://cobblemon-schema.local/ride_settings/vehicle.schema.json","validator":"v32"},{"path":"schemas/seasonings/schema.json","id":"https://cobblemon-schema.local/seasonings/schema.json","validator":"v33"},{"path":"schemas/spawn_bait_effects/schema.json","id":"https://cobblemon-schema.local/spawn_bait_effects/schema.json","validator":"v34"},{"path":"schemas/spawn_detail_presets/schema.json","id":"https://cobblemon-schema.local/spawn_detail_presets/schema.json","validator":"v35"},{"path":"schemas/spawn_pool_world/schema.json","id":"https://cobblemon-schema.local/spawn_pool_world/schema.json","validator":"v36"},{"path":"schemas/spawn_rules/schema.json","id":"https://cobblemon-schema.local/spawn_rules/schema.json","validator":"v37"},{"path":"schemas/species/schema.json","id":"https://cobblemon-schema.local/species/schema.json","validator":"v38"},{"path":"schemas/species_feature_assignments/schema.json","id":"https://cobblemon-schema.local/species_feature_assignments/schema.json","validator":"v39"},{"path":"schemas/species_features/schema.json","id":"https://cobblemon-schema.local/species_features/schema.json","validator":"v40"},{"path":"schemas/unlockable_pc_box_wallpapers/schema.json","id":"https://cobblemon-schema.local/unlockable_pc_box_wallpapers/schema.json","validator":"v41"},{"path":"schemas/species_additions/schema.json","id":"https://cobblemon-schema.local/species_additions/schema.json","validator":"v42"},{"path":"schemas/dex_additions/schema.json","id":"https://cobblemon-schema.local/dex_additions/schema.json","validator":"v43"},{"path":"schemas/dex_entry_additions/schema.json","id":"https://cobblemon-schema.local/dex_entry_additions/schema.json","validator":"v44"},{"path":"schemas/starters/schema.json","id":"https://cobblemon-schema.local/starters/schema.json","validator":"v45"},{"path":"schemas/bedrock_pokemon_resolvers/schema.json","id":"https://cobblemon-schema.local/bedrock_pokemon_resolvers/schema.json","validator":"v46"},{"path":"schemas/bedrock_posers/schema.json","id":"https://cobblemon-schema.local/bedrock_posers/schema.json","validator":"v47"}]}