@simtlix/simfinity-js-client 1.0.2 → 1.0.6

package/README.md

@@ -16,16 +16,29 @@ 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)`
+### `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.**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simtlix/simfinity-js-client",
-  "version": "1.0.2",
+  "version": "1.0.6",
   "description": "Introspection-driven GraphQL client for simfinity-js APIs",
   "type": "module",
   "main": "src/SimfinityClient.js",

package/src/SimfinityClient.js

@@ -481,7 +481,14 @@ class AggregateBuilder {
 // ---------------------------------------------------------------------------
 
 export default class SimfinityClient {
-  constructor(endpoint) {
+  /**
+   * @param {string} endpoint GraphQL HTTP endpoint URL
+   * @param {{ prepareHeaders?: (headers: Record<string, string>) => void }} [options]
+   *        Optional `prepareHeaders` runs before each request; mutate `headers` to add auth
+   *        (e.g. `headers['Authorization'] = 'Bearer …'`). Login is not part of this client —
+   *        perform auth in your app and set tokens inside this callback or a closure it sees.
+   */
+  constructor(endpoint, options = {}) {
     this._endpoint = endpoint;
     this._types = new Map();
     this._queries = new Map();
@@ -491,6 +498,8 @@ export default class SimfinityClient {
     this._typeNameToAggregate = new Map();
     this._queryNameToType = new Map();
     this._initialized = false;
+    this._prepareHeaders =
+      typeof options.prepareHeaders === 'function' ? options.prepareHeaders : null;
   }
 
   // -- Initialization ------------------------------------------------------
@@ -664,9 +673,13 @@ export default class SimfinityClient {
     if (variables && Object.keys(variables).length > 0) {
       body.variables = variables;
     }
+    const headers = { 'Content-Type': 'application/json' };
+    if (this._prepareHeaders) {
+      this._prepareHeaders(headers);
+    }
     const response = await _fetch(this._endpoint, {
       method: 'POST',
-      headers: { 'Content-Type': 'application/json' },
+      headers,
       body: JSON.stringify(body),
     });
     return response.json();