# @travetto/rest-model-query

> RESTful support for generating query APIs from Model classes.

Latest version **5.0.5** (published 2024-09-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @travetto/rest-model-query
pnpm add @travetto/rest-model-query
yarn add @travetto/rest-model-query
bun add @travetto/rest-model-query
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.0.5 |
| Published | 2024-09-15 |
| First published | 2022-09-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 23 |
| Author | Travetto Framework |
| Maintainers | arcsine |
| Keywords | rest, model-query, travetto, typescript |

## Links

- npm: https://www.npmjs.com/package/@travetto/rest-model-query
- Repository: https://github.com/travetto/travetto
- Homepage: https://travetto.io
- Issues: https://github.com/travetto/travetto/issues
- npm.io page: https://npm.io/package/@travetto/rest-model-query

## Dependencies (5)

- [@travetto/rest](https://npm.io/package/@travetto/rest.md) ^5.0.5
- [@travetto/model](https://npm.io/package/@travetto/model.md) ^5.0.4
- [@travetto/schema](https://npm.io/package/@travetto/schema.md) ^5.0.4
- [@travetto/model-query](https://npm.io/package/@travetto/model-query.md) ^5.0.4
- [@travetto/model-query-language](https://npm.io/package/@travetto/model-query-language.md) ^5.0.4

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 5.0.5 (latest) — 2024-09-15
- 5.0.0-rc.15 (rc) — 2024-08-25
- 5.0.4 — 2024-09-15
- 5.0.3 — 2024-09-14
- 5.0.2 — 2024-09-04
- 5.0.1 — 2024-09-03
- 5.0.0 — 2024-08-25
- 5.0.0-rc.14 — 2024-08-25
- 5.0.0-rc.13 — 2024-08-25
- 5.0.0-rc.12 — 2024-08-25
- 5.0.0-rc.11 — 2024-08-24
- 5.0.0-rc.10 — 2024-08-11
- 5.0.0-rc.9 — 2024-08-11
- 5.0.0-rc.8 — 2024-08-06
- 5.0.0-rc.7 — 2024-08-06
- … 129 more at https://npm.io/package/@travetto/rest-model-query/versions

## README

<!-- This file was generated by @travetto/doc and should not be modified directly -->
<!-- Please modify https://github.com/travetto/travetto/tree/main/module/rest-model-query/DOC.tsx and execute "npx trv doc" to rebuild -->
# RESTful Model Query Routes

## RESTful support for generating query APIs from Model classes.

**Install: @travetto/rest-model-query**
```bash
npm install @travetto/rest-model-query

# or

yarn add @travetto/rest-model-query
```

[Data Model Querying](https://github.com/travetto/travetto/tree/main/module/model-query#readme "Datastore abstraction for advanced query support.") support can also be added support in the form of [ModelQueryRoutes](https://github.com/travetto/travetto/tree/main/module/rest-model-query/src/model-query.ts#L46). This provides listing by query as well as an endpoint to facilitate suggestion behaviors.

**Code: ModelQueryRoutes example**
```typescript
import { Inject } from '@travetto/di';
import { ModelQuerySupport } from '@travetto/model-query';
import { Controller } from '@travetto/rest';
import { ModelQueryRoutes } from '@travetto/rest-model-query';

import { User } from './user';

@Controller('/user')
@ModelQueryRoutes(User)
class UserQueryController {
  @Inject()
  source: ModelQuerySupport;
}
```

is a shorthand that is equal to:

**Code: Comparable UserController, built manually**
```typescript
import { Inject } from '@travetto/di';
import { ModelQuerySupport, ValidStringFields } from '@travetto/model-query';
import { isQuerySuggestSupported } from '@travetto/model-query/src/internal/service/common';
import { Controller, Get } from '@travetto/rest';
import { RestModelQuery, RestModelSuggestQuery } from '@travetto/rest-model-query';

import { User } from './user';

@Controller('/user')
class UserQueryController {

  @Inject()
  service: ModelQuerySupport;

  @Get('')
  async getAllUser(query: RestModelQuery) {
    return this.service.query(User, query.finalize());
  }

  @Get('/suggest/:field')
  async suggest(field: ValidStringFields<User>, suggest: RestModelSuggestQuery) {
    if (isQuerySuggestSupported(this.service)) {
      return this.service.suggest(User, field, suggest.q, suggest);
    }
  }
}
```

---
_Source: https://npm.io/package/@travetto/rest-model-query · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._