# @openinc/parse-server-schema > Parse Server Schema Manager - Provides functionality to manage Parse Server schemas like converting to typescript interfaces, exporting and importing schemas. Latest version **4.1.2** (published 2026-09-14) · MIT license · 0 weekly downloads ## Install ```sh npm install @openinc/parse-server-schema pnpm add @openinc/parse-server-schema yarn add @openinc/parse-server-schema bun add @openinc/parse-server-schema ``` Provides the command `parse-server-schema`. ## Health **Score 65/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 4.1.2 | | Published | 2026-09-14 | | First published | 2020-06-16 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 4 | | Unpacked size | 191.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 9 | | Author | open.INC GmbH | | Maintainers | mstein-openinc, nicovitt, openinc-service | | Keywords | parse, schema | ## Links - npm: https://www.npmjs.com/package/@openinc/parse-server-schema - Repository: https://github.com/open-inc/node-parse-server-schema - Homepage: https://github.com/open-inc/node-parse-server-schema#readme - Issues: https://github.com/open-inc/node-parse-server-schema/issues - npm.io page: https://npm.io/package/@openinc/parse-server-schema ## Dependencies (4) - [dotenv](https://npm.io/package/dotenv.md) ^17.4.2 - [mkdirp](https://npm.io/package/mkdirp.md) ^3.0.1 - [commander](https://npm.io/package/commander.md) ^14.0.3 - [handlebars](https://npm.io/package/handlebars.md) ^4.7.9 ## Alternatives - [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads - [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads - [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads - [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads - [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads ## Recent versions - 4.1.2 (latest) — 2026-09-14 - 4.1.1 — 2026-04-23 - 4.1.0 — 2026-04-09 - 4.0.1 — 2026-04-01 - 4.0.0 — 2026-01-26 - 3.0.7 — 2025-12-29 - 3.0.6 — 2025-10-24 - 3.0.5 — 2025-09-18 - 3.0.4 — 2025-09-18 - 3.0.3 — 2025-09-18 - 3.0.2 — 2025-09-18 - 3.0.1 — 2025-09-18 - 3.0.0 — 2025-09-18 - 2.0.4 — 2025-09-08 - 2.0.3 — 2025-09-04 - … 34 more at https://npm.io/package/@openinc/parse-server-schema/versions ## README # @openinc/parse-server-schema A schema manager for Parse Server ## CLI Usage Repository on npm: https://www.npmjs.com/package/@openinc/parse-server-schema ``` npm i -g @openinc/parse-server-schema parse-server-schema --help # or npm i -D @openinc/parse-server-schema npx parse-server-schema --help ``` ### Generate local schemas from distant Parse server ``` parse-server-schema down ./path/to/local/schemas --configPath ./path/to/my-parse-conf.json ``` ### Generate TS types from distant Parse server ``` parse-server-schema typescript ./path/to/my/local/types --configPath ./path/to/my-parse-conf.json ``` ### Generate UML class diagrams from local schema/types The `draw` command creates a class diagram from local Parse schema files. Supported input: - A folder with `.json` schema files (output from `down`) - A folder with `.ts` files (output from `typescript`) - A single `.json` file containing an array of classes ```bash parse-server-schema draw ``` ### CLI options for diagram generation The `draw` command supports the following options: | Option | Type | Default | Description | | ------------------------------- | -------- | --------- | --------------------------------------------------------------------------- | | `--output ` | string | auto | Output file path. Defaults to `schema-diagram.mmd/.md/.html` by format | | `--format ` | string | `mermaid` | Output format: `mermaid`, `markdown`, or `html` | | `--prefix ` | string | `""` | Include only classes with this prefix; prefix is stripped in rendered names | | `--ignore ` | string[] | `[]` | Class name(s) to ignore | | `--font-size ` | number | `44` | Mermaid font size in pixels | | `--default-renderer ` | string | `elk` | Mermaid class renderer: `dagre-wrapper`, `dagre-d3`, or `elk` | ### Draw examples ```bash # Create Mermaid source parse-server-schema draw ./schema --format mermaid # Create markdown with embedded Mermaid parse-server-schema draw ./schema --format markdown --output ./docs/schema.md # Create interactive HTML viewer parse-server-schema draw ./types --format html --output ./schema-diagram.html # Filter classes by prefix and ignore selected classes parse-server-schema draw ./types --prefix OD3_ --ignore _User _Session _Role # Use a specific Mermaid layout renderer parse-server-schema draw ./types --format html --default-renderer dagre-wrapper ``` ## Configuration You have two options to connect to parse server. 1. By providing a json config file 2. By providing an env with the necessary values set. `loadConfig(...)` checks provided config in the following order: 1. options.operation === "down" ==> Set Config from process.env ==> return: ```ts Config.initialize({ publicServerURL: PARSE_SERVER_DOWN_SCHEMA_SERVER_URL, appId: PARSE_SERVER_DOWN_SCHEMA_APPID, masterKey: PARSE_SERVER_DOWN_SCHEMA_MASTERKEY, }); ``` 2. options.operation === "up" ==> Set Config from process.env ==> return: ```ts Config.initialize({ publicServerURL: PARSE_SERVER_UP_SCHEMA_SERVER_URL, appId: PARSE_SERVER_UP_SCHEMA_APPID, masterKey: PARSE_SERVER_UP_SCHEMA_MASTERKEY, }); ``` 3. Check for default process.env variable and use these, then return: ```ts Config.initialize({ publicServerURL: PARSE_SERVER_URL || PARSE_PUBLIC_SERVER_URL, appId: PARSE_SERVER_APPLICATION_ID, masterKey: PARSE_SERVER_MASTER_KEY, }); ``` 4. Look for `parse-server.config.json` or provided config path. ### 1. Config files By default the config file is expected to be in _./config/parse-server.config.json_ You can specify the path providing the option `--configPath`. Here's what a valid JSON file looks like: ```JSON { "masterKey": "my-parse-master-key", "publicServerURL": "https://my-parse-server.com", "appId": "my-parse-app-id" } ``` ### 2. Environment variables The following variables can be set. By default the package looks for process.env, so takes every .env in cwd into account and uses these information to connect to parse server. The json file is ignored in this scenarion. - PARSE_SERVER_APPLICATION_ID - PARSE_SERVER_MASTER_KEY - PARSE_PUBLIC_SERVER_URL - PARSE_SERVER_URL **Distinct values for "down" script (optional)** - PARSE_SERVER_DOWN_SCHEMA_SERVER_URL - PARSE_SERVER_DOWN_SCHEMA_APPID - PARSE_SERVER_DOWN_SCHEMA_MASTERKEY **Distinct values for "up" script (optional)** - PARSE_SERVER_UP_SCHEMA_SERVER_URL - PARSE_SERVER_UP_SCHEMA_APPID - PARSE_SERVER_UP_SCHEMA_MASTERKEY ### Providing custom types for class fields By default array and object typed class fields are set to any[]/any. By specifing `--custom-class-field-types-config ` in the cli command you can set these to custom types. The file has to be an array of form `classname` --> `fields` --> `[key: fieldname]: type`. Specify the **importfrom** option to import the type correctly! **Example:** ```json [ { "classname": "YourClassName", "fields": [ { "fieldname": "fieldtype", "importfrom": "import { fieldtype } from \"../path/to/type\"" } ] } ] ``` ### CLI options for typescript conversion The `typescript` command supports the following options: | Option | Type | Default | Description | | ------------------------------------------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--prefix ` | string | `""` | Prefix will be stripped from class names in generated TypeScript files | | `--ignore ` | string[] | `[]` | Class name(s) to ignore during generation. Supports wildcards: `Prefix*` (starts with) or `*Suffix` (ends with). Can be specified multiple times | | `--include ` | string[] | `[]` | Class name(s) to include (overrides --ignore). Supports wildcards with `*`. Can be specified multiple times | | `--no-class` | boolean | `false` | Don't create and register custom Parse.Object classes (generates type definitions only) | | `--no-sdk` | boolean | `false` | Don't use Parse JS SDK dependencies, generates plain TypeScript types only | | `--import-parse-statement ` | string | `""` | Control the import on top of generated files by yourself. E.g. `import Parse from "parse";` when using Parse JS SDK or `""` when Parse is globally available (on server). | | `--is-esm` | boolean | `false` | Use ES module imports/exports with `.js` extensions in generated files | | `--resolve-referenced-classes` | boolean | `false` | Generate TypeScript files for all referenced classes, even if they're not in the initial schema (enables recursive dependency resolution) | | `--custom-class-field-types-config ` | string | - | Path to JSON config file for custom class field type mappings | | `--verbose` | boolean | `false` | Enable verbose logging including dependency validation and dependency graph visualization | **Examples:** ```bash # Basic usage with prefix stripping parse-server-schema typescript ./types --prefix "MyApp_" # Generate with ES modules and recursive dependencies parse-server-schema typescript ./types --is-esm --resolve-referenced-classes # Generate type definitions only (no Parse.Object classes) parse-server-schema typescript ./types --no-class --no-sdk parse-server-schema typescript ./types --prefix XXX_ --import-parse-statement 'import Parse from "parse";' # Ignore specific classes and use custom field types parse-server-schema typescript ./types --ignore "_Session" "TempClass*" --custom-class-field-types-config ./custom-types.json # Enable verbose logging for debugging dependency issues parse-server-schema typescript ./types --verbose --resolve-referenced-classes # Generate MyApp_ prefixed classes plus additional Asset classes parse-server-schema typescript ./types --prefix "MyApp_" --include "Asset*" # Generate Documentation classes plus specific additional classes parse-server-schema typescript ./types --prefix "OD3_Documentation_" --include "OD3_Asset" "User" ``` ## Version update and deployment to npm The next version number is calculated by semantic release. When commiting keep the structure in mind: https://docs.openinc.dev/docs/general/semanticrelease A GitHub workflow publishes the package automatically to npm. ## Programmatic Usage ```ts import { loadConfig, up, down, typescript, draw, } from "@openinc/parse-server-schema"; // load JSON file with config loadConfig("./parse-server-config.json"); // or load config from process.env loadConfig(); // when using distinct up and down servers loadConfig(undefined, { operation: "up" }); loadConfig(undefined, { operation: "down" }); await up(schemaPath); await down(schemaPath); await typescript(typescriptPath); await draw(schemaPath, { format: "html", output: "./schema-diagram.html" }); ``` --- _Source: https://npm.io/package/@openinc/parse-server-schema · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._