@simtlix/simfinity-js-client 3.19.0 → 3.19.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +18 -5
  2. package/package.json +2 -1
package/README.md CHANGED
@@ -1,13 +1,26 @@
1
+ [![Simfinity.js — Define once. Build beyond. GraphQL, MongoDB, PostgreSQL, and optional MCP.](https://raw.githubusercontent.com/simtlix/simfinity.js/master/.github/assets/readme-cover.png)](https://simtlix.github.io/simfinity.js/)
2
+
1
3
  # @simtlix/simfinity-js-client
2
4
 
3
- Introspection-driven GraphQL client for [simfinity-js](https://github.com/simtlix/simfinity.js) APIs. It discovers your schema at runtime via introspection and exposes a chainable query builder, CRUD helpers, aggregate queries, state-machine transitions, schema metadata access, mutation input transformation, and more — no code generation required.
5
+ [![npm version](https://img.shields.io/npm/v/@simtlix/simfinity-js-client.svg)](https://www.npmjs.com/package/@simtlix/simfinity-js-client)
6
+ [![Node.js](https://img.shields.io/node/v/@simtlix/simfinity-js-client.svg)](https://nodejs.org/)
7
+ [![License](https://img.shields.io/npm/l/@simtlix/simfinity-js-client.svg)](https://github.com/simtlix/simfinity.js/blob/master/LICENSE)
8
+ [![Documentation](https://img.shields.io/badge/docs-simtlix.github.io-2563eb.svg)](https://simtlix.github.io/simfinity.js/)
9
+
10
+ Introspection-driven GraphQL client for [Simfinity.js](https://simtlix.github.io/simfinity.js/) APIs. It discovers your schema at runtime via introspection and exposes a chainable query builder, CRUD helpers, aggregate queries, state-machine transitions, schema metadata access, mutation input transformation, and more — no code generation required.
4
11
 
5
12
  > Since 3.19.0, the client is maintained in the Simfinity monorepo and follows its aligned release version. Existing valid 1.1 JavaScript calls remain supported.
6
13
 
14
+ **[Documentation](https://simtlix.github.io/simfinity.js/)** ·
15
+ **[JavaScript client guide](https://simtlix.github.io/simfinity.js/guide/client.html)** ·
16
+ **[Client descriptor](https://simtlix.github.io/simfinity.js/reference/client-descriptor.html)** ·
17
+ **[Example app](https://simtlix.github.io/simfinity.js/resources/barber.html)** ·
18
+ **[Releases](https://github.com/simtlix/simfinity.js/releases)**
19
+
7
20
  ## Installation
8
21
 
9
22
  ```bash
10
- npm install @simtlix/simfinity-js-client@3.19.0
23
+ npm install @simtlix/simfinity-js-client
11
24
  ```
12
25
 
13
26
  ## Quick Start
@@ -482,7 +495,7 @@ client.getAvailableTransitions('season');
482
495
 
483
496
  ## Examples
484
497
 
485
- See [`examples/demo.js`](examples/demo.js) for a comprehensive walkthrough covering all features: schema discovery, filtering, joins, pagination, sorting, CRUD, state machine transitions, aggregates, raw queries, schema metadata, selection set building, entity resolution, input transformation, collection deltas, parent queries, FK search, and response extensions.
498
+ See [`examples/demo.js`](https://github.com/simtlix/simfinity.js/blob/master/packages/client/examples/demo.js) for a comprehensive walkthrough covering all features: schema discovery, filtering, joins, pagination, sorting, CRUD, state machine transitions, aggregates, raw queries, schema metadata, selection set building, entity resolution, input transformation, collection deltas, parent queries, FK search, and response extensions.
486
499
 
487
500
  ```bash
488
501
  GRAPHQL_ENDPOINT=http://localhost:3000/graphql npm run demo
@@ -490,7 +503,7 @@ GRAPHQL_ENDPOINT=http://localhost:3000/graphql npm run demo
490
503
 
491
504
  ## License
492
505
 
493
- [Apache-2.0](LICENSE)
506
+ [Apache-2.0](https://github.com/simtlix/simfinity.js/blob/master/LICENSE)
494
507
 
495
508
  ## Source provenance
496
509
 
@@ -498,7 +511,7 @@ Imported from simtlix/simfinity-js-client commit `32d9c5bf7264cd3ecddcd3441bffea
498
511
 
499
512
  ## Monorepo additions
500
513
 
501
- See the [JavaScript client guide](https://simtlix.github.io/simfinity.js/guide/client) for the complete current API and both-engine setup. The client remains dependency-free and browser compatible.
514
+ See the [JavaScript client guide](https://simtlix.github.io/simfinity.js/guide/client.html) for the complete current API and both-engine setup. The client remains dependency-free and browser compatible.
502
515
 
503
516
  - Constructor options add mutually exclusive `descriptor` and `descriptorEndpoint`, injected `fetch`, `introspection: 'extended' | 'standard'`, and asynchronous `prepareHeaders`. Descriptor mode never introspects; use it when the server disables introspection. `getDescriptor()` returns the loaded descriptor or null.
504
517
  - `query(name, args?, fields?)` executes exact query roots, including scalar and abstract outputs. `findView(name, params?)` returns a normal list builder, while `getViews(typeName?)` lists descriptor-classified views. Canonical lists are not replaced by views.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@simtlix/simfinity-js-client",
3
- "version": "3.19.0",
3
+ "version": "3.19.1",
4
4
  "description": "Introspection-driven GraphQL client for simfinity-js APIs",
5
5
  "type": "module",
6
6
  "main": "./src/SimfinityClient.js",
@@ -22,6 +22,7 @@
22
22
  ],
23
23
  "author": "Multiscreen Technology Group - SimTLiX SRL",
24
24
  "license": "Apache-2.0",
25
+ "homepage": "https://simtlix.github.io/simfinity.js/guide/client.html",
25
26
  "repository": {
26
27
  "type": "git",
27
28
  "url": "https://github.com/simtlix/simfinity.js",