@nubitio/hydra 0.5.20 → 0.5.23

package/dist/index.cjs

@@ -93,12 +93,24 @@ function getFlatIriFilter(filter) {
 	if (!Array.isArray(filter)) return null;
 	return filter.length === 1 && Array.isArray(filter[0]) ? filter[0] : filter;
 }
+function parseGridSummaryHeader(headers) {
+	const raw = headers.get("x-grid-summary");
+	if (!raw) return null;
+	try {
+		const parsed = JSON.parse(raw);
+		return parsed && typeof parsed === "object" && !Array.isArray(parsed) ? parsed : null;
+	} catch {
+		return null;
+	}
+}
 function parseCollectionResponse(responseData, responseHeaders) {
+	const gridSummary = parseGridSummaryHeader(responseHeaders);
 	if (Array.isArray(responseData)) {
 		const headerCount = Number(responseHeaders.get("x-total-count"));
 		return {
 			data: responseData,
-			totalCount: Number.isFinite(headerCount) ? headerCount : responseData.length
+			totalCount: Number.isFinite(headerCount) ? headerCount : responseData.length,
+			gridSummary
 		};
 	}
 	if (responseData && typeof responseData === "object") {
@@ -109,13 +121,15 @@ function parseCollectionResponse(responseData, responseHeaders) {
 			const totalCount = Number(rawTotal);
 			return {
 				data: member,
-				totalCount: Number.isFinite(totalCount) ? totalCount : member.length
+				totalCount: Number.isFinite(totalCount) ? totalCount : member.length,
+				gridSummary
 			};
 		}
 	}
 	return {
 		data: [],
-		totalCount: 0
+		totalCount: 0,
+		gridSummary
 	};
 }
 var HydraRemoteDataSource = class {
@@ -174,7 +188,8 @@ var HydraRemoteDataSource = class {
 		return {
 			data,
 			totalCount,
-			summary: null
+			summary: null,
+			gridSummary: parsed.gridSummary
 		};
 	}
 	async fetchById(url, id, loadOptions) {
@@ -194,6 +209,16 @@ function HydraResourceStoreProvider({ children }) {
 	});
 }
 //#endregion
+//#region packages/hydra/buildSummaryFields.ts
+function buildSummaryFieldsFromSchema(schema) {
+	return schema.fields.filter((field) => field.crudHints?.summable).map((field) => ({
+		column: field.name,
+		summaryType: field.crudHints?.summaryType ?? "sum",
+		valueFormat: field.crudHints?.format === "currency" ? "currency" : void 0,
+		label: field["hydra:title"] && field["hydra:title"] !== field.name ? field["hydra:title"] : void 0
+	}));
+}
+//#endregion
 //#region packages/hydra/openApiParser.ts
 /**
 * Converts a camelCase or PascalCase name to dash-case.
@@ -410,6 +435,7 @@ function parseHydraDoc(doc, entrypointHrefs) {
 			fields,
 			formLayout: cls["x-crud-layout"],
 			workflow: cls["x-workflow"],
+			sequence: cls["x-sequence"],
 			searchMappings: extractSearchMappings(cls),
 			supportedOperations: Array.from(new Set([...collectionOperationsMap[className] ?? [], ...extractSupportedOperations(cls)]))
 		};
@@ -520,6 +546,18 @@ function applyCrudHints(field, hints) {
 	if (hints.order !== void 0) field.order = hints.order;
 	if (hints.width !== void 0) field.width = hints.width;
 }
+/**
+* Apply `x-sequence` hints: the server-allocated field is read-only and
+* excluded from create/edit forms (the listener assigns it on POST).
+*/
+function applySequenceHints(fields, schema) {
+	const sequenceField = schema.sequence?.field;
+	if (!sequenceField) return;
+	for (const field of fields) if (field.name === sequenceField) {
+		field.visibleOnForm = false;
+		field.readonly = true;
+	}
+}
 function resolveEntityValueField(relatedSchema) {
 	if (!relatedSchema) return "_iri";
 	const fieldNames = new Set(relatedSchema.fields.map((field) => field.name));
@@ -716,6 +754,7 @@ function mapHydraSchemaToFields(schema, urlLookup, schemaLookup) {
 		};
 		fields.unshift(syntheticId);
 	}
+	applySequenceHints(fields, schema);
 	return fields;
 }
 //#endregion
@@ -908,7 +947,9 @@ function useResourceSchema(apiUrl) {
 			error: void 0,
 			supportedOperations: resourceSchema.supportedOperations ?? [],
 			formLayout: resourceSchema.formLayout,
-			workflow: resourceSchema.workflow
+			workflow: resourceSchema.workflow,
+			sequence: resourceSchema.sequence,
+			summaryFields: buildSummaryFieldsFromSchema(resourceSchema)
 		};
 	}, [
 		data,

package/dist/index.d.cts

@@ -74,6 +74,10 @@ interface CrudHints {
    * upload controls that submit the media IRI.
    */
   format?: 'currency' | 'image' | 'file';
+  /** Include this column in the server-side grid summary footer. */
+  summable?: boolean;
+  /** Aggregate function for summable columns. @default 'sum' */
+  summaryType?: 'sum' | 'count' | 'avg' | 'min' | 'max';
 }
 interface HydraSupportedProperty {
   '@type': 'SupportedProperty';
@@ -133,6 +137,13 @@ interface WorkflowSchema {
   field: string;
   transitions: WorkflowTransitionSchema[];
 }
+interface SequenceSchema {
+  field: string;
+  name?: string;
+  prefix?: string;
+  padding?: number;
+  scope?: string[];
+}
 interface HydraClass {
   '@id': string;
   '@type': string;
@@ -140,6 +151,8 @@ interface HydraClass {
   supportedProperty: HydraSupportedProperty[];
   /** State machine metadata from nubitio/workflow-bundle. */
   'x-workflow'?: WorkflowSchema;
+  /** Auto-numbering metadata from nubitio/sequence-bundle. */
+  'x-sequence'?: SequenceSchema;
   /**
    * Class-level UI hints injected by TranslatedDocumentationNormalizer from
    * the ApiResource's extraProperties['x-crud']['formLayout']. Mirrors
@@ -234,6 +247,8 @@ interface HydraResourceSchema {
   supportedOperations?: string[];
   /** Workflow transitions for auto row actions (nubitio/workflow-bundle). */
   workflow?: WorkflowSchema;
+  /** Server-allocated sequence field (nubitio/sequence-bundle). */
+  sequence?: SequenceSchema;
 }
 interface OpenApiProperty {
   type?: string;
@@ -384,4 +399,4 @@ interface UseSchemaContextResult {
  */
 declare function useSchemaContext(): UseSchemaContextResult;
 //#endregion
-export { API_DOC_QUERY_KEY, type ApiDoc, type HydraApiDoc, HydraRemoteDataSource, HydraResourceSchemaProvider, type HydraResourceSchemaProviderProps, HydraResourceStoreProvider, type HydraResourceStoreProviderProps, type OpenApiDoc, type RemoteDataSourceOptions, type RemoteFilterDescriptor, type RemoteLoadOptions, type RemoteSortDescriptor, SchemaProvider, type UseSchemaContextResult, type WorkflowSchema, type WorkflowTransitionSchema, createHydraResourceStore, mapHydraSchemaToFields, parseHydraDoc, parseOpenApiDoc, resolveRangeTag, useHydraMetadata, useResourceSchema, useSchemaContext };
+export { API_DOC_QUERY_KEY, type ApiDoc, type HydraApiDoc, HydraRemoteDataSource, HydraResourceSchemaProvider, type HydraResourceSchemaProviderProps, HydraResourceStoreProvider, type HydraResourceStoreProviderProps, type OpenApiDoc, type RemoteDataSourceOptions, type RemoteFilterDescriptor, type RemoteLoadOptions, type RemoteSortDescriptor, SchemaProvider, type SequenceSchema, type UseSchemaContextResult, type WorkflowSchema, type WorkflowTransitionSchema, createHydraResourceStore, mapHydraSchemaToFields, parseHydraDoc, parseOpenApiDoc, resolveRangeTag, useHydraMetadata, useResourceSchema, useSchemaContext };

package/dist/index.d.mts

@@ -74,6 +74,10 @@ interface CrudHints {
    * upload controls that submit the media IRI.
    */
   format?: 'currency' | 'image' | 'file';
+  /** Include this column in the server-side grid summary footer. */
+  summable?: boolean;
+  /** Aggregate function for summable columns. @default 'sum' */
+  summaryType?: 'sum' | 'count' | 'avg' | 'min' | 'max';
 }
 interface HydraSupportedProperty {
   '@type': 'SupportedProperty';
@@ -133,6 +137,13 @@ interface WorkflowSchema {
   field: string;
   transitions: WorkflowTransitionSchema[];
 }
+interface SequenceSchema {
+  field: string;
+  name?: string;
+  prefix?: string;
+  padding?: number;
+  scope?: string[];
+}
 interface HydraClass {
   '@id': string;
   '@type': string;
@@ -140,6 +151,8 @@ interface HydraClass {
   supportedProperty: HydraSupportedProperty[];
   /** State machine metadata from nubitio/workflow-bundle. */
   'x-workflow'?: WorkflowSchema;
+  /** Auto-numbering metadata from nubitio/sequence-bundle. */
+  'x-sequence'?: SequenceSchema;
   /**
    * Class-level UI hints injected by TranslatedDocumentationNormalizer from
    * the ApiResource's extraProperties['x-crud']['formLayout']. Mirrors
@@ -234,6 +247,8 @@ interface HydraResourceSchema {
   supportedOperations?: string[];
   /** Workflow transitions for auto row actions (nubitio/workflow-bundle). */
   workflow?: WorkflowSchema;
+  /** Server-allocated sequence field (nubitio/sequence-bundle). */
+  sequence?: SequenceSchema;
 }
 interface OpenApiProperty {
   type?: string;
@@ -384,4 +399,4 @@ interface UseSchemaContextResult {
  */
 declare function useSchemaContext(): UseSchemaContextResult;
 //#endregion
-export { API_DOC_QUERY_KEY, type ApiDoc, type HydraApiDoc, HydraRemoteDataSource, HydraResourceSchemaProvider, type HydraResourceSchemaProviderProps, HydraResourceStoreProvider, type HydraResourceStoreProviderProps, type OpenApiDoc, type RemoteDataSourceOptions, type RemoteFilterDescriptor, type RemoteLoadOptions, type RemoteSortDescriptor, SchemaProvider, type UseSchemaContextResult, type WorkflowSchema, type WorkflowTransitionSchema, createHydraResourceStore, mapHydraSchemaToFields, parseHydraDoc, parseOpenApiDoc, resolveRangeTag, useHydraMetadata, useResourceSchema, useSchemaContext };
+export { API_DOC_QUERY_KEY, type ApiDoc, type HydraApiDoc, HydraRemoteDataSource, HydraResourceSchemaProvider, type HydraResourceSchemaProviderProps, HydraResourceStoreProvider, type HydraResourceStoreProviderProps, type OpenApiDoc, type RemoteDataSourceOptions, type RemoteFilterDescriptor, type RemoteLoadOptions, type RemoteSortDescriptor, SchemaProvider, type SequenceSchema, type UseSchemaContextResult, type WorkflowSchema, type WorkflowTransitionSchema, createHydraResourceStore, mapHydraSchemaToFields, parseHydraDoc, parseOpenApiDoc, resolveRangeTag, useHydraMetadata, useResourceSchema, useSchemaContext };

package/dist/index.mjs

@@ -69,12 +69,24 @@ function getFlatIriFilter(filter) {
 	if (!Array.isArray(filter)) return null;
 	return filter.length === 1 && Array.isArray(filter[0]) ? filter[0] : filter;
 }
+function parseGridSummaryHeader(headers) {
+	const raw = headers.get("x-grid-summary");
+	if (!raw) return null;
+	try {
+		const parsed = JSON.parse(raw);
+		return parsed && typeof parsed === "object" && !Array.isArray(parsed) ? parsed : null;
+	} catch {
+		return null;
+	}
+}
 function parseCollectionResponse(responseData, responseHeaders) {
+	const gridSummary = parseGridSummaryHeader(responseHeaders);
 	if (Array.isArray(responseData)) {
 		const headerCount = Number(responseHeaders.get("x-total-count"));
 		return {
 			data: responseData,
-			totalCount: Number.isFinite(headerCount) ? headerCount : responseData.length
+			totalCount: Number.isFinite(headerCount) ? headerCount : responseData.length,
+			gridSummary
 		};
 	}
 	if (responseData && typeof responseData === "object") {
@@ -85,13 +97,15 @@ function parseCollectionResponse(responseData, responseHeaders) {
 			const totalCount = Number(rawTotal);
 			return {
 				data: member,
-				totalCount: Number.isFinite(totalCount) ? totalCount : member.length
+				totalCount: Number.isFinite(totalCount) ? totalCount : member.length,
+				gridSummary
 			};
 		}
 	}
 	return {
 		data: [],
-		totalCount: 0
+		totalCount: 0,
+		gridSummary
 	};
 }
 var HydraRemoteDataSource = class {
@@ -150,7 +164,8 @@ var HydraRemoteDataSource = class {
 		return {
 			data,
 			totalCount,
-			summary: null
+			summary: null,
+			gridSummary: parsed.gridSummary
 		};
 	}
 	async fetchById(url, id, loadOptions) {
@@ -170,6 +185,16 @@ function HydraResourceStoreProvider({ children }) {
 	});
 }
 //#endregion
+//#region packages/hydra/buildSummaryFields.ts
+function buildSummaryFieldsFromSchema(schema) {
+	return schema.fields.filter((field) => field.crudHints?.summable).map((field) => ({
+		column: field.name,
+		summaryType: field.crudHints?.summaryType ?? "sum",
+		valueFormat: field.crudHints?.format === "currency" ? "currency" : void 0,
+		label: field["hydra:title"] && field["hydra:title"] !== field.name ? field["hydra:title"] : void 0
+	}));
+}
+//#endregion
 //#region packages/hydra/openApiParser.ts
 /**
 * Converts a camelCase or PascalCase name to dash-case.
@@ -386,6 +411,7 @@ function parseHydraDoc(doc, entrypointHrefs) {
 			fields,
 			formLayout: cls["x-crud-layout"],
 			workflow: cls["x-workflow"],
+			sequence: cls["x-sequence"],
 			searchMappings: extractSearchMappings(cls),
 			supportedOperations: Array.from(new Set([...collectionOperationsMap[className] ?? [], ...extractSupportedOperations(cls)]))
 		};
@@ -496,6 +522,18 @@ function applyCrudHints(field, hints) {
 	if (hints.order !== void 0) field.order = hints.order;
 	if (hints.width !== void 0) field.width = hints.width;
 }
+/**
+* Apply `x-sequence` hints: the server-allocated field is read-only and
+* excluded from create/edit forms (the listener assigns it on POST).
+*/
+function applySequenceHints(fields, schema) {
+	const sequenceField = schema.sequence?.field;
+	if (!sequenceField) return;
+	for (const field of fields) if (field.name === sequenceField) {
+		field.visibleOnForm = false;
+		field.readonly = true;
+	}
+}
 function resolveEntityValueField(relatedSchema) {
 	if (!relatedSchema) return "_iri";
 	const fieldNames = new Set(relatedSchema.fields.map((field) => field.name));
@@ -692,6 +730,7 @@ function mapHydraSchemaToFields(schema, urlLookup, schemaLookup) {
 		};
 		fields.unshift(syntheticId);
 	}
+	applySequenceHints(fields, schema);
 	return fields;
 }
 //#endregion
@@ -884,7 +923,9 @@ function useResourceSchema(apiUrl) {
 			error: void 0,
 			supportedOperations: resourceSchema.supportedOperations ?? [],
 			formLayout: resourceSchema.formLayout,
-			workflow: resourceSchema.workflow
+			workflow: resourceSchema.workflow,
+			sequence: resourceSchema.sequence,
+			summaryFields: buildSummaryFieldsFromSchema(resourceSchema)
 		};
 	}, [
 		data,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nubitio/hydra",
-  "version": "0.5.20",
+  "version": "0.5.23",
   "type": "module",
   "description": "Hydra / OpenAPI adapter for @nubitio/crud — automatic schema discovery and data source from API Platform docs.",
   "license": "MIT",
@@ -50,7 +50,7 @@
     "react": "^19.0.0",
     "react-dom": "^19.0.0",
     "react-i18next": "^14.0.0",
-    "@nubitio/core": "^0.5.20",
-    "@nubitio/crud": "^0.5.20"
+    "@nubitio/core": "^0.5.23",
+    "@nubitio/crud": "^0.5.23"
   }
 }