Registry / devops / mobiletto-orm-typedef-gen

mobiletto-orm-typedef-gen

library2.3.42jsnpmunverified

A dev-dependency tool to generate TypeScript types, Yup validators, Nuxt 3 server APIs, API client services, Pinia stores, and Vue 3 admin components based on mobiletto-orm-typedef definitions. Current stable version 2.3.42. Released actively (last update within months). Differentiator: automatically produces full-stack artifacts from a single ORM type definition, reducing boilerplate across frontend and backend.

devops

npm install mobiletto-orm-typedef-gen

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MOBILETTO-ORM-TYPE

mobiletto-orm-typedef-gen

devopsjavascriptv2.3.42

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

generateTypescriptTypes

✓ import { generateTypescriptTypes } from 'mobiletto-orm-typedef-gen'

✗ const { generateTypescriptTypes } = require('mobiletto-orm-typedef-gen')

Package is ESM-only. Use named import. CJS require will fail.

generateYupValidator

✓ import { generateYupValidator } from 'mobiletto-orm-typedef-gen'

Named export, ESM only.

generatePiniaStore

✓ import { generatePiniaStore } from 'mobiletto-orm-typedef-gen'

✗ import { generatePiniaStore } from 'mobiletto-orm-typedef-gen'

Same pattern. Only named exports available; no default export.

generateNuxt3ServerApi

✓ import { generateNuxt3ServerApi } from 'mobiletto-orm-typedef-gen'

Named export. Requires Nuxt 3 project context.

Demonstrates how to import and run all major generators on a sample typedef, outputting files to specific directories.

import { generateTypescriptTypes, generateYupValidator, generateNuxt3ServerApi, generatePiniaStore } from 'mobiletto-orm-typedef-gen'; // Assuming you have a mobiletto-orm-typedef definition const typedef = { type: 'MyType', fields: { name: { type: 'string' }, age: { type: 'number' } } }; // Generate TypeScript type generateTypescriptTypes(typedef, { outputDir: './types' }); // Generate Yup validator generateYupValidator(typedef, { outputDir: './validators' }); // Generate Nuxt 3 server API generateNuxt3ServerApi(typedef, { outputDir: './server/api' }); // Generate Pinia store generatePiniaStore(typedef, { outputDir: './stores' });

Debug

Known issues

breakingVersion 2.0.0 dropped support for CommonJS require. All exports are ESM only.

fix

Use import syntax instead of require. Ensure your project uses ESM (package.json type: module) or a bundler that can import ESM.

affects: >=2.0.0

breakingVersion 2.0.0 renamed some generator functions. generateTypes moved to generateTypescriptTypes, generateYup moved to generateYupValidator.

fix

Update import names to the new symbols.

affects: >=2.0.0

gotchaGenerator functions require a mobiletto-orm-typedef definition object as first argument; passing an undefined or invalid definition causes runtime errors with unclear messages.

fix

Ensure your typedef object is properly defined and exported from 'mobiletto-orm-typedef' before passing to generators.

affects: *

gotchaOutput directories must exist or be writable; generator does not create intermediate directories. If outputDir does not exist, file generation fails silently or throws.

fix

Use fs.mkdirSync(outputDir, { recursive: true }) before calling generators.

affects: *

Errors

Common errors & fixes

Cannot find module 'mobiletto-orm-typedef-gen'

Package not installed as dev dependency.

fix

Run 'npm install --save-dev mobiletto-orm-typedef-gen' (or yarn/pnpm equivalent).

Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/node_modules/mobiletto-orm-typedef-gen/index.js from /path/to/your-file.js not supported.

Using CommonJS require() on an ESM-only package.

fix

Switch to import syntax or add 'type': 'module' to your package.json.

TypeError: generateTypescriptTypes is not a function

Importing the function incorrectly (e.g., default import on a named export).

fix

Use { generateTypescriptTypes } in import statement, not default import.

TypeError: Cannot read properties of undefined (reading 'type')

The typedef object passed to a generator is undefined or malformed.

fix

Check that you correctly imported the typedef and passed it as first argument.

ENOENT: no such file or directory, mkdir '/path/to/outputDir'

The output directory does not exist.

fix

Create the output directory before calling the generator, e.g., with fs.mkdirSync(outputDir, { recursive: true }).

Upgrade

Version history

2.3.42latest on npm

Audit

Dependencies

mobiletto-orm-typedefrequiredThe type definitions this generator consumes

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/cobbzilla/mobiletto-orm-typedef-gen ↗

packagemobiletto-orm-typedef-gen ↗

homepagehttps://github.com/cobbzilla/mobiletto-orm-typedef-gen ↗