@objectql/types 4.0.1 → 4.0.2

package/README.md

@@ -1,7 +1,11 @@
 # @objectql/types
 
+> **Implementation Status**: ✅ **Complete** - All type definitions available. See [Implementation Status](https://github.com/objectstack-ai/objectql/blob/main/IMPLEMENTATION_STATUS.md) for runtime implementation details.
+
 Type definitions for the ObjectQL system, including object schemas, field configurations, validation rules, queries, hooks, and actions.
 
+> **Note**: This package defines the type system. Some types (like permissions and workflows) are defined but require application-layer implementation. See the implementation status document for details.
+
 ## Features
 
 - **Object & Field Types**: Define data models with `ObjectConfig` and `FieldConfig`

package/dist/api.d.ts

@@ -96,16 +96,22 @@ export interface DataApiListResponse<T = unknown> extends DataApiResponse<T> {
 }
 /**
  * Response for single item operations (findOne, create, update)
+ * Single item operations wrap the data in a 'data' field
  */
 export interface DataApiItemResponse<T = unknown> extends DataApiResponse<T> {
-    /** The item ID */
-    _id?: string | number;
-    /** Object type identifier */
-    '@type'?: string;
-    /** Timestamp when created */
-    created_at?: string | Date;
-    /** Timestamp when last updated */
-    updated_at?: string | Date;
+    /** The returned item data */
+    data?: T & {
+        /** The item ID */
+        _id?: string | number;
+        /** Object type identifier */
+        '@type'?: string;
+        /** Timestamp when created */
+        created_at?: string | Date;
+        /** Timestamp when last updated */
+        updated_at?: string | Date;
+        /** Additional item fields */
+        [key: string]: unknown;
+    };
 }
 /**
  * Query parameters for GET /api/data/:object (list records)

package/dist/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAujBH,4CASC;AAljBD,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E;;GAEG;AACH,IAAY,YAUX;AAVD,WAAY,YAAY;IACpB,mDAAmC,CAAA;IACnC,qDAAqC,CAAA;IACrC,6CAA6B,CAAA;IAC7B,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;IACrB,iDAAiC,CAAA;IACjC,iDAAiC,CAAA;IACjC,2DAA2C,CAAA;AAC/C,CAAC,EAVW,YAAY,4BAAZ,YAAY,QAUvB;AAwBD;;GAEG;AACH,MAAa,aAAc,SAAQ,KAAK;IAIpC,YAAY,KAAkF;QAC1F,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAE7B,uDAAuD;QACvD,MAAM,gBAAgB,GAAG,KAA2F,CAAC;QACrH,IAAI,OAAO,gBAAgB,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;YAC3D,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;CACJ;AAhBD,sCAgBC;AA+dD;;GAEG;AACU,QAAA,kBAAkB,GAA2B;IACtD,GAAG,EAAE,eAAe;IACpB,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,eAAe;IACzB,KAAK,EAAE,YAAY;CACtB,CAAC;AAEF;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,MAAuB;;IACpD,MAAM,aAAa,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;IAEzF,OAAO;QACH,GAAG,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,mCAAI,0BAAkB,CAAC,GAAG,CAAC;QACzD,IAAI,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,0BAAkB,CAAC,IAAI,CAAC;QAC5D,QAAQ,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,mCAAI,0BAAkB,CAAC,QAAQ,CAAC;QACxE,KAAK,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,mCAAI,0BAAkB,CAAC,KAAK,CAAC;KAClE,CAAC;AACN,CAAC"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AA6jBH,4CASC;AAxjBD,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E;;GAEG;AACH,IAAY,YAUX;AAVD,WAAY,YAAY;IACpB,mDAAmC,CAAA;IACnC,qDAAqC,CAAA;IACrC,6CAA6B,CAAA;IAC7B,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,qCAAqB,CAAA;IACrB,iDAAiC,CAAA;IACjC,iDAAiC,CAAA;IACjC,2DAA2C,CAAA;AAC/C,CAAC,EAVW,YAAY,4BAAZ,YAAY,QAUvB;AAwBD;;GAEG;AACH,MAAa,aAAc,SAAQ,KAAK;IAIpC,YAAY,KAAkF;QAC1F,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAE7B,uDAAuD;QACvD,MAAM,gBAAgB,GAAG,KAA2F,CAAC;QACrH,IAAI,OAAO,gBAAgB,CAAC,iBAAiB,KAAK,UAAU,EAAE,CAAC;YAC3D,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAC5D,CAAC;IACL,CAAC;CACJ;AAhBD,sCAgBC;AAqeD;;GAEG;AACU,QAAA,kBAAkB,GAA2B;IACtD,GAAG,EAAE,eAAe;IACpB,IAAI,EAAE,WAAW;IACjB,QAAQ,EAAE,eAAe;IACzB,KAAK,EAAE,YAAY;CACtB,CAAC;AAEF;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,MAAuB;;IACpD,MAAM,aAAa,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;IAEzF,OAAO;QACH,GAAG,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,mCAAI,0BAAkB,CAAC,GAAG,CAAC;QACzD,IAAI,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,mCAAI,0BAAkB,CAAC,IAAI,CAAC;QAC5D,QAAQ,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,QAAQ,mCAAI,0BAAkB,CAAC,QAAQ,CAAC;QACxE,KAAK,EAAE,aAAa,CAAC,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,mCAAI,0BAAkB,CAAC,KAAK,CAAC;KAClE,CAAC;AACN,CAAC"}

package/dist/field.d.ts

@@ -104,7 +104,7 @@ export interface FieldOption {
  * - `deleteBehavior`: Made optional with protocol-compatible enum values
  *
  * All other protocol properties (description, defaultValue, maxLength, minLength, precision, scale, min, max,
- * reference, referenceFilters, writeRequiresMasterRead, expression, formula, summaryOperations) are inherited as-is.
+ * reference, referenceFilters, writeRequiresMasterRead, expression, summaryOperations) are inherited as-is.
  */
 export interface FieldConfig extends Omit<Field, 'name' | 'label' | 'type' | 'options' | 'required' | 'multiple' | 'unique' | 'deleteBehavior' | 'hidden' | 'readonly' | 'encryption' | 'index' | 'externalId' | 'searchable'> {
     /** Field name (inferred from Record key when used in ObjectConfig.fields) */

package/dist/object.d.ts

@@ -5,18 +5,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Data } from '@objectstack/spec';
-type ServiceObject = Data.ServiceObject;
-type IndexSchema = NonNullable<ServiceObject['indexes']>[number];
 import { FieldConfig } from './field';
 import { ActionConfig } from './action';
 import { AnyValidationRule } from './validation';
-/**
- * Re-export Protocol Types from the Constitution
- *
- * @deprecated Import directly from @objectstack/spec instead
- */
-export type { ServiceObject as SpecObject, IndexSchema };
 /**
  * RUNTIME-SPECIFIC TYPES
  * The following types extend or complement the Protocol Constitution
@@ -63,7 +54,7 @@ export interface ObjectAiConfig {
  * Runtime Object Configuration
  *
  * Extends the Protocol ServiceObject with runtime-specific properties.
- * The Protocol Constitution (SpecObject) defines the core object schema.
+ * The Protocol Constitution defines the core object schema.
  * This adds runtime conveniences like actions, AI config, and validation rules.
  */
 export interface ObjectConfig {

package/dist/query.d.ts

@@ -22,33 +22,70 @@ type FilterCondition = Data.FilterCondition;
  * Note: $not operator is not supported. Use $ne for field-level negation.
  */
 export type Filter = FilterCondition;
-export type AggregateFunction = 'count' | 'sum' | 'avg' | 'min' | 'max';
+/** @deprecated Use AggregationFunctionType instead */
+export type AggregateFunction = AggregationFunctionType;
+/** @deprecated Use AggregationNode instead */
 export interface AggregateOption {
     func: AggregateFunction;
     field: string;
     alias?: string;
 }
 /**
- * Unified Query Interface
+ * Sort Node - Standard Protocol Format
+ * Represents an "Order By" clause.
+ */
+export interface SortNode {
+    /** Field name to sort by */
+    field: string;
+    /** Sort direction - defaults to 'asc' */
+    order: 'asc' | 'desc';
+}
+/**
+ * Aggregation Function - Standard Protocol Format
+ */
+export type AggregationFunctionType = 'count' | 'sum' | 'avg' | 'min' | 'max' | 'count_distinct' | 'array_agg' | 'string_agg';
+/**
+ * Aggregation Node - Standard Protocol Format
+ * Represents an aggregated field with function.
+ */
+export interface AggregationNode {
+    /** Aggregation function to apply */
+    function: AggregationFunctionType;
+    /** Field to aggregate (optional for count) */
+    field?: string;
+    /** Alias for the result field */
+    alias: string;
+    /** Apply DISTINCT to the field before aggregation */
+    distinct?: boolean;
+    /** Optional filter condition for this aggregation */
+    filter?: Filter;
+}
+/**
+ * Unified Query Interface - Standard Protocol Format
  *
- * Provides a consistent query API across all ObjectQL drivers.
+ * Uses @objectstack/spec QueryAST format directly.
+ * This is the single source of truth for query structure.
  */
 export interface UnifiedQuery {
     /** Field selection - specify which fields to return */
     fields?: string[];
-    /** Filter conditions using modern FilterCondition syntax */
-    filters?: Filter;
-    /** Sort order - array of [field, direction] tuples */
-    sort?: [string, 'asc' | 'desc'][];
-    /** Pagination - number of records to skip */
-    skip?: number;
+    /** Filter conditions using standard FilterCondition syntax (was: filters) */
+    where?: Filter;
+    /** Sort order - array of SortNode objects (was: sort as tuples) */
+    orderBy?: SortNode[];
+    /** Pagination - number of records to skip (was: skip) */
+    offset?: number;
     /** Pagination - maximum number of records to return */
     limit?: number;
     /** Relation expansion - load related records */
     expand?: Record<string, UnifiedQuery>;
     /** Aggregation - group by fields */
     groupBy?: string[];
-    /** Aggregation - aggregate functions to apply */
-    aggregate?: AggregateOption[];
+    /** Aggregation - aggregate functions to apply (was: aggregate with func) */
+    aggregations?: AggregationNode[];
+    /** Filter for aggregated results (HAVING clause) */
+    having?: Filter;
+    /** Enable distinct results */
+    distinct?: boolean;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@objectql/types",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "Pure TypeScript type definitions and interfaces for the ObjectQL protocol - The Contract",
   "keywords": [
     "objectql",
@@ -27,12 +27,13 @@
     "test": "jest --passWithNoTests"
   },
   "peerDependencies": {
-    "@objectstack/spec": "^0.3.1",
+    "@objectstack/spec": "^0.3.3",
     "@objectql/runtime": "^0.2.0"
   },
   "devDependencies": {
-    "@objectstack/spec": "^0.3.1",
+    "@objectstack/spec": "^0.3.3",
     "@objectql/runtime": "workspace:*",
-    "ts-json-schema-generator": "^2.4.0"
+    "ts-json-schema-generator": "^2.4.0",
+    "zod": "^3.23.8"
   }
 }