@simtlix/simfinity-descriptor 3.15.0 → 3.16.0

package/README.md

@@ -28,3 +28,9 @@ types. Directly importing `@simtlix/simfinity-core/introspection` requires core
 a direct dependency pinned to the facade's version. The 3.x introspection default
 remains enabled, and clients selecting `__Field.extensions` must migrate before
 using the early opt-out.
+
+Since 3.16.0, a generated transaction field is described with
+`operation: 'transaction'` and `type: null`, with its actual arguments, result
+type and reachable `@oneOf` input. Format version 1 is unchanged; clients that
+handle operation kinds exhaustively must accept `transaction`. User-registered
+mutations retain `customMutation`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simtlix/simfinity-descriptor",
-  "version": "3.15.0",
+  "version": "3.16.0",
   "description": "Schema-owned client metadata and an explicitly authorized HTTP endpoint for Simfinity",
   "type": "module",
   "main": "./src/index.js",
@@ -27,7 +27,7 @@
     "directory": "packages/descriptor"
   },
   "dependencies": {
-    "@simtlix/simfinity-core": "3.15.0"
+    "@simtlix/simfinity-core": "3.16.0"
   },
   "peerDependencies": {
     "graphql": "^16.11.0"

package/src/client-descriptor.js

@@ -3,7 +3,7 @@ import {
   isObjectType, isScalarType, isUnionType, print,
 } from 'graphql';
 import SimfinityError from '@simtlix/simfinity-core/internal/errors';
-import { schemaRegistrations } from '@simtlix/simfinity-core/internal/schema-registrations';
+import { schemaRegistrations, schemaTransaction } from '@simtlix/simfinity-core/internal/schema-registrations';
 import { getFieldStorageName, getListShape, isVirtualField, normalizeConnectionField, virtualFieldOptions } from '@simtlix/simfinity-core/internal/relation-storage';
 import { packageInfo } from './package-info.js';
 
@@ -118,9 +118,10 @@ const createDescriptor = (schema, registrations) => {
       ...(marker?.view ? { view: marker.view.name } : {}) }];
   });
   const mutationKinds = { save: 'add', update: 'update', delete: 'delete', state_changed: 'transition', custom_mutation: 'customMutation' };
+  const transaction = schemaTransaction(schema);
   const mutationEntries = Object.entries(schema.getMutationType()?.getFields() || {}).map(([name, field]) => {
     const marker = field.extensions?.simfinityMutation;
-    const kind = mutationKinds[marker?.operation] || 'customMutation';
+    const kind = field === transaction ? 'transaction' : mutationKinds[marker?.operation] || 'customMutation';
     const result = { ...operation(field), type: marker?.typeName || null, operation: kind };
     if (['add', 'update', 'delete'].includes(kind) && result.description === kind) result.description = null;
     if (kind === 'transition') Object.assign(result, { action: marker.action, from: textOrNull(marker.from), to: textOrNull(marker.to) });
@@ -161,8 +162,10 @@ const createDescriptor = (schema, registrations) => {
         } : null;
       }
     }
-    if (isInputObjectType(type)) result.fields = Object.values(type.getFields()).map(input);
-    else if (isObjectType(type) || isInterfaceType(type)) {
+    if (isInputObjectType(type)) {
+      result.fields = Object.values(type.getFields()).map(input);
+      if (type.isOneOf === true) result.isOneOf = true;
+    } else if (isObjectType(type) || isInterfaceType(type)) {
       result.interfaces = type.getInterfaces().map((item) => item.name);
       result.fields = Object.values(type.getFields()).map((field) => {
         const relation = relationOf(type, field);

package/src/package-info.js

@@ -1,2 +1,2 @@
 // Generated by scripts/release-packages.js; keeps the descriptor builder free of Node/JSON loader dependencies.
-export const packageInfo = Object.freeze({ name: '@simtlix/simfinity-descriptor', version: '3.15.0' });
+export const packageInfo = Object.freeze({ name: '@simtlix/simfinity-descriptor', version: '3.16.0' });

package/types/index.d.ts

@@ -34,7 +34,7 @@ export interface ClientDescriptorField {
 }
 export interface ClientDescriptorOperation {
   readonly type: string | null;
-  readonly operation: 'get' | 'list' | 'aggregate' | 'add' | 'update' | 'delete' | 'transition' | 'customQuery' | 'customMutation';
+  readonly operation: 'get' | 'list' | 'aggregate' | 'add' | 'update' | 'delete' | 'transition' | 'transaction' | 'customQuery' | 'customMutation';
   readonly args: readonly ClientDescriptorInputValue[];
   readonly returns: string;
   readonly description: string | null;
@@ -58,6 +58,7 @@ export interface ClientDescriptorType {
   readonly inputs?: Readonly<{ add?: string; update?: string }>;
   readonly stateMachine?: ClientDescriptorStateMachine | null;
   readonly fields?: readonly (ClientDescriptorField | ClientDescriptorInputValue)[];
+  readonly isOneOf?: boolean;
   readonly interfaces?: readonly string[];
   readonly possibleTypes?: readonly string[];
   readonly values?: readonly Readonly<{ name: string; description: string | null; deprecationReason: string | null }>[];