@simtlix/simfinity-js-client 1.0.6 → 1.1.0

package/.claude/worktrees/flamboyant-cartwright/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/.claude/worktrees/flamboyant-cartwright/README.md

@@ -0,0 +1,491 @@
+# @simtlix/simfinity-js-client
+
+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.
+
+## Installation
+
+```bash
+npm install @simtlix/simfinity-js-client
+```
+
+## Quick Start
+
+```js
+import SimfinityClient from '@simtlix/simfinity-js-client';
+
+const client = new SimfinityClient('http://localhost:3000/graphql');
+await client.init();
+
+// Optional: attach auth headers (perform login in your app; this client does not include login)
+const tokenStore = { accessToken: null };
+const authedClient = new SimfinityClient('http://localhost:3000/graphql', {
+  prepareHeaders(headers) {
+    if (tokenStore.accessToken) {
+      headers['Authorization'] = `Bearer ${tokenStore.accessToken}`;
+    }
+  },
+});
+await authedClient.init();
+
+const series = await client.find('serie').exec();
+console.log(series);
+```
+
+## API Reference
+
+### `new SimfinityClient(endpoint [, options])`
+
+Creates a new client instance pointing at the given GraphQL endpoint.
+
+- **`options.prepareHeaders(headers)`** (optional): invoked before every GraphQL HTTP request. Mutate the plain `headers` object to add credentials (for example `Authorization`). The client does not implement login — call your auth API separately, then set tokens in a closure or store that `prepareHeaders` reads.
+
+### `client.init()`
+
+Runs an introspection query against the endpoint and builds internal registries of types, queries, and mutations — including Simfinity-specific field extensions (relation metadata, state machine flags, read-only markers). **Must be called before any other method.**
+
+### Schema Inspection
+
+| Method | Returns |
+|---|---|
+| `client.getTypes()` | All discovered types (objects, enums, scalars, inputs) |
+| `client.getQueries()` | All root query fields |
+| `client.getMutations()` | All root mutation fields |
+
+---
+
+### Query Builder — `client.find(typeName)`
+
+Returns a chainable `QueryBuilder`. Call `.exec()` to execute.
+
+```js
+const results = await client.find('serie')
+  .where('categories', 'EQ', 'Drama')
+  .joinObject('director', 'name country')
+  .joinCollection('seasons', 'number year state')
+  .joinCollection('seasons.episodes', 'number name')
+  .fields('id name categories')
+  .page(1, 10)
+  .sort('name', 'ASC')
+  .exec();
+```
+
+#### `.where(field, operator, value [, value2])`
+
+Filter by a scalar field. Supported operators depend on the server schema (e.g. `EQ`, `NE`, `GT`, `LT`, `GTE`, `LTE`, `BETWEEN`, `LIKE`, `NIN`).
+
+#### `.where(field, terms)`
+
+Filter by a collection field using an array of term objects:
+
+```js
+.where('seasons', [
+  { path: 'episodes.name', operator: 'EQ', value: 'Pilot' }
+])
+```
+
+#### `.or(groups)` / `.and(groups)`
+
+Add AND/OR logical filter groups for complex boolean conditions. Each method accepts an array of `QLFilterGroup` objects and can be called multiple times (groups accumulate). These combine with existing flat `.where()` filters via AND at the top level.
+
+A `QLFilterGroup` is a plain object with optional `AND`, `OR`, and `conditions` fields:
+
+```js
+{
+  conditions: [{ field: 'category', operator: 'EQ', value: 'Drama' }],
+  AND: [/* nested QLFilterGroup objects */],
+  OR:  [/* nested QLFilterGroup objects */],
+}
+```
+
+**Simple OR** -- return series in either Drama or Comedy:
+
+```js
+const results = await client.find('serie')
+  .or([
+    SimfinityClient.condition('categories', 'EQ', 'Drama'),
+    SimfinityClient.condition('categories', 'EQ', 'Comedy'),
+  ])
+  .fields('id name categories')
+  .exec();
+```
+
+**Flat filters combined with OR** -- flat `.where()` is ANDed with the OR group:
+
+```js
+const results = await client.find('serie')
+  .where('categories', 'NE', 'Horror')
+  .or([
+    SimfinityClient.condition('name', 'LIKE', 'Breaking'),
+    SimfinityClient.condition('name', 'LIKE', 'Game'),
+  ])
+  .fields('id name categories')
+  .exec();
+// Equivalent to: categories != "Horror" AND (name LIKE "Breaking" OR name LIKE "Game")
+```
+
+**Nested AND inside OR**:
+
+```js
+const results = await client.find('serie')
+  .or([
+    { AND: [
+      SimfinityClient.condition('categories', 'EQ', 'Drama'),
+      SimfinityClient.condition('year', 'GTE', 2020),
+    ]},
+    { AND: [
+      SimfinityClient.condition('categories', 'EQ', 'Comedy'),
+      SimfinityClient.condition('year', 'GTE', 2015),
+    ]},
+  ])
+  .exec();
+// Equivalent to: (categories = "Drama" AND year >= 2020) OR (categories = "Comedy" AND year >= 2015)
+```
+
+**AND with nested OR groups**:
+
+```js
+const results = await client.find('serie')
+  .where('year', 'GTE', 2000)
+  .and([
+    { OR: [
+      SimfinityClient.condition('categories', 'EQ', 'Drama'),
+      SimfinityClient.condition('categories', 'EQ', 'Comedy'),
+    ]},
+    { OR: [
+      SimfinityClient.condition('director', 'EQ', 'UK', 'country'),
+      SimfinityClient.condition('director', 'EQ', 'US', 'country'),
+    ]},
+  ])
+  .exec();
+// Equivalent to: year >= 2000 AND (Drama OR Comedy) AND (UK OR US director)
+```
+
+**Relationship path filtering** -- use the `path` parameter for object field conditions:
+
+```js
+.or([
+  SimfinityClient.condition('director', 'LIKE', 'Adams', 'name'),
+  SimfinityClient.condition('director', 'LIKE', 'Nolan', 'name'),
+])
+```
+
+The Aggregate Builder also supports `.or()` and `.and()` with identical behavior. The server enforces a maximum nesting depth of 5 levels.
+
+#### `SimfinityClient.condition(field, operator, value [, path])`
+
+Static convenience factory for creating a filter group with a single condition. Returns a `QLFilterGroup` object:
+
+```js
+SimfinityClient.condition('category', 'EQ', 'Drama')
+// Equivalent to: { conditions: [{ field: 'category', operator: 'EQ', value: 'Drama' }] }
+
+SimfinityClient.condition('author', 'LIKE', 'Adams', 'name')
+// Equivalent to: { conditions: [{ field: 'author', operator: 'LIKE', value: 'Adams', path: 'name' }] }
+```
+
+#### `.joinObject(path, fields)`
+
+Include a related object's fields in the selection.
+
+#### `.joinCollection(path, fields [, filter])`
+
+Include a related collection's fields. Supports dot-notation for nested joins (e.g. `'seasons.episodes'`). An optional `filter` array of terms can be passed.
+
+#### `.fields(selectionString)`
+
+Space-separated list of scalar fields to select on the root type. If omitted, all scalar and enum fields are selected automatically.
+
+#### `.autoSelect()`
+
+Automatically builds a full selection set using schema metadata, including nested object fields with display field resolution. Returns the builder for chaining. The selection metadata is available via `builder._selectionMeta`.
+
+```js
+const results = await client.find('serie')
+  .autoSelect()
+  .page(1, 10)
+  .exec();
+```
+
+#### `.page(page, size [, count])`
+
+Paginate results. `page` is 1-based. Set `count` to `true` to include total count in response extensions.
+
+#### `.sort(field, order)`
+
+Sort results. `order` is `'ASC'` or `'DESC'`. Can be called multiple times for multi-field sorting.
+
+#### `.exec()`
+
+Executes the query and returns the result array. If the server returns extensions (e.g. pagination count), they are attached as `result.__extensions`.
+
+#### `.execWithMeta()`
+
+Executes the query and returns a `{ data, extensions }` wrapper for clean access to response metadata:
+
+```js
+const { data: series, extensions } = await client.find('serie')
+  .page(1, 10, true)
+  .execWithMeta();
+
+console.log(series);              // the result array
+console.log(extensions?.count);   // total count from server
+```
+
+---
+
+### Aggregate Builder — `client.aggregate(typeName)`
+
+Returns a chainable `AggregateBuilder`. Call `.exec()` to execute.
+
+```js
+const results = await client.aggregate('season')
+  .groupBy('serie')
+  .fact('COUNT', 'seasonCount', 'id')
+  .fact('AVG', 'avgYear', 'year')
+  .page(1, 5)
+  .sort('serie', 'ASC')
+  .exec();
+```
+
+#### `.groupBy(field)`
+
+**Required.** The field to group by.
+
+#### `.fact(operation, factName, path)`
+
+Add an aggregation fact. `operation` can be `COUNT`, `SUM`, `AVG`, `MIN`, `MAX`, etc.
+
+#### `.where()`, `.page()`, `.sort()`
+
+Same API as the Query Builder.
+
+---
+
+### Get by ID
+
+```js
+const serie = await client.getById('serie', '507f1f77bcf86cd799439011', 'id name categories');
+```
+
+If `fields` is omitted, all scalar fields are returned.
+
+---
+
+### Collection Item Queries — `client.findByParent()`
+
+Query collection items filtered by their parent entity:
+
+```js
+const seasons = await client.findByParent('season', 'serie', parentSerieId)
+  .page(1, 10, true)
+  .fields('id number year state')
+  .exec();
+```
+
+Returns a `QueryBuilder` pre-configured with a connection field filter and default sort by `id ASC`. Chain additional `.where()`, `.page()`, `.fields()`, `.sort()` as needed.
+
+---
+
+### FK/Relation Search — `client.search()`
+
+Search-as-you-type for FK reference fields:
+
+```js
+const results = await client.search('Genre', 'com', {
+  displayField: 'name',
+  page: 1,
+  size: 10,
+});
+// [{ id: '1', name: 'Comedy' }, { id: '2', name: 'Romantic Comedy' }]
+```
+
+Automatically selects the appropriate operator (`LIKE` for strings, `EQ` for numeric/boolean) and casts the search term to the field's scalar type.
+
+| Option | Default | Description |
+|---|---|---|
+| `displayField` | auto-resolved (`name` or first scalar) | Field to search by |
+| `page` | `1` | Page number |
+| `size` | `10` | Page size |
+
+---
+
+### CRUD Mutations
+
+```js
+const created = await client.add('star', { name: 'John Doe' }, 'id name');
+
+const updated = await client.update('star', createdId, { name: 'Jane Doe' }, 'id name');
+
+const deleted = await client.delete('star', createdId, 'id name');
+```
+
+#### Automatic Input Transformation
+
+Pass `{ transform: true }` as the last argument to have the client automatically clean mutation input based on schema metadata — stripping `__typename`, coercing scalar types, extracting FK IDs, handling embedded objects, and skipping read-only/state-machine fields:
+
+```js
+const created = await client.add('serie', rawFormData, 'id name', { transform: true });
+
+const updated = await client.update('serie', id, rawFormData, 'id name', {
+  transform: true,
+  skipFields: ['temporaryField'],
+});
+```
+
+---
+
+### Mutation Input Transformation — `client.transformInput()`
+
+Schema-aware mutation input cleaning, usable standalone:
+
+```js
+const cleaned = client.transformInput('serie', rawInput, {
+  mode: 'create',           // or 'update'
+  skipFields: [],            // fields to exclude
+  transientFields: [],       // transient fields to exclude
+});
+```
+
+Handles: `__typename` removal, numeric/date coercion, embedded object cleaning, FK reference extraction (`{ id }` only), and skipping read-only, state-machine, and collection fields.
+
+---
+
+### Collection Delta Mutations — `client.transformCollectionDelta()`
+
+Build the `{ added, updated, deleted }` structure for collection field mutations:
+
+```js
+const delta = {
+  added: [{ id: 'temp_1', number: '3', year: '2025', __status: 'added' }],
+  updated: [{ id: 'real-id', number: '2', year: '2024', __status: 'modified' }],
+  deleted: [{ id: 'del-id' }],
+};
+
+const cleaned = client.transformCollectionDelta('season', delta, {
+  connectionField: 'serie',
+});
+// { added: [{ number: 3, year: 2025 }], updated: [{ id: 'real-id', number: 2, year: 2024 }], deleted: ['del-id'] }
+```
+
+Strips metadata (`__status`, `__originalData`, `__typename`), removes temporary IDs and connection fields, coerces scalar types, and extracts FK object IDs.
+
+---
+
+### State Machine Transitions
+
+```js
+const activated = await client.transition('season', 'activate', seasonId, 'id number state');
+```
+
+Optionally pass extra input fields:
+
+```js
+await client.transition('season', 'activate', seasonId, { extraField: 'value' }, 'id number state');
+```
+
+---
+
+### Custom Mutations
+
+```js
+const result = await client.customMutation('myCustomMutation', { arg1: 'value' }, 'id status');
+```
+
+---
+
+### Raw GraphQL Execution
+
+```js
+const response = await client.execute(
+  '{ stars(pagination: { page: 1, size: 2 }) { id name } }'
+);
+console.log(response.data);
+```
+
+---
+
+### Selection Set Building — `client.buildSelectionSet()`
+
+Generate a complete GraphQL selection set string with metadata from the schema, useful for building dynamic UIs:
+
+```js
+const { selection, columns, sortFieldByColumn, fieldTypeByColumn } =
+  client.buildSelectionSet('serie');
+```
+
+Returns:
+
+| Property | Type | Description |
+|---|---|---|
+| `selection` | `string` | GraphQL selection set string (includes nested object sub-selections) |
+| `columns` | `string[]` | Display column names (excludes `id`) |
+| `sortFieldByColumn` | `object` | Maps column name to sort field path (e.g. `director` -> `director.name`) |
+| `fieldTypeByColumn` | `object` | Maps column name to scalar type name |
+
+---
+
+### Schema Metadata Access
+
+#### Field Extensions
+
+```js
+const ext = client.getFieldExtensions('serie', 'director');
+// { relation: { displayField: 'name', embedded: true, connectionField: null }, stateMachine: null, readOnly: null }
+```
+
+| Method | Signature | Description |
+|---|---|---|
+| `getFieldExtensions` | `(typeName, fieldName)` | Full extensions object for a field |
+| `getDisplayField` | `(typeName, fieldName)` | Display field with fallback chain (extension -> `name` -> first scalar) |
+| `isEmbeddedField` | `(typeName, fieldName)` | Whether the field is an embedded object |
+| `getConnectionField` | `(typeName, fieldName)` | Back-reference field name for collections |
+| `isStateMachineField` | `(typeName, fieldName)` | Whether the field is state-machine managed |
+| `isReadOnlyField` | `(typeName, fieldName)` | Whether the field is read-only |
+| `getEnumValues` | `(typeName)` | Enum values for an enum type |
+| `getFieldsOfType` | `(typeName)` | All fields with full metadata |
+| `getDescriptionFieldType` | `(typeName, fieldName)` | Scalar type name of a display field |
+
+#### Entity & Query Name Resolution
+
+```js
+client.getTypeNameForQuery('series');           // 'serie'
+client.getPluralQueryName('serie');              // 'series'
+client.getSingularQueryName('serie');            // 'serie'
+client.getListEntityNames();                    // ['episodes', 'seasons', 'series', 'stars', ...]
+client.getListEntityNamesOfType('serie');        // ['series']
+client.getQueryNamesForType('serie');
+// { pluralQueryName: 'series', singularQueryName: 'serie', aggregateQueryName: 'series_aggregate' }
+```
+
+#### Scalar Type Utilities
+
+Simfinity uses validated scalar names like `SeasonNumber_Int` where the suffix after `_` indicates the base type:
+
+```js
+client.getActualScalarType('SeasonNumber_Int');  // 'Int'
+client.isNumericScalar('SeasonNumber_Int');       // true
+client.isBooleanScalar('Boolean');               // true
+client.isDateTimeScalar('StartDate_DateTime');   // true
+```
+
+#### State Machine Metadata
+
+```js
+client.getStateMachineFields('season');          // ['state']
+client.getAvailableTransitions('season');
+// [{ action: 'activate', mutationName: 'activate_season' }, { action: 'finalize', mutationName: 'finalize_season' }]
+```
+
+---
+
+## Examples
+
+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.
+
+```bash
+GRAPHQL_ENDPOINT=http://localhost:3000/graphql npm run demo
+```
+
+## License
+
+[Apache-2.0](LICENSE)