@rushdb/javascript-sdk 2.9.0 → 2.9.1

package/README.md

@@ -88,7 +88,7 @@ const memories = await db.ai.search({
 // Push nested JSON — relationships created automatically
 await db.records.importJson({
   label: 'COMPANY',
-  payload: {
+  data: {
     name: 'Acme Corp',
     DEPARTMENT: [
       {

package/dist/types/query.d.ts

@@ -3,9 +3,9 @@ import type { BooleanExpression, DatetimeExpression, LogicalGrouping, NullExpres
 import type { Schema } from './schema.js';
 import type { AnyObject, MaybeArray, RequireAtLeastOne } from './utils.js';
 /**
- * Variable-length traversal depth for `$relation.hops`.
+ * Variable-length traversal depth for `$relation.hops` and `$cycle.hops`.
  * A number matches exactly that many hops; `{ min?, max? }` matches a range
- * (`min` defaults to 1, or 2 inside a `$cycle` block). Omitting `max` requests
+ * (`min` defaults to 1, or 2 for `$cycle`). Omitting `max` requests
  * unbounded traversal, which is only allowed on self-hosted deployments and
  * projects with a custom Neo4j instance.
  */
@@ -20,16 +20,20 @@ export type TraversalHops = number | {
 export type TraversalRelationOptions = RelationOptions & {
     hops?: TraversalHops;
 };
+/**
+ * Record-level cycle predicate: matches records sitting on a closed path
+ * (cycle/ring) back to themselves over the described edges. The value is the
+ * traversal spec itself — `hops` is mandatory (`min` ≥ 2, defaults to 2);
+ * intermediate node labels are unconstrained. A cycle has no separate endpoint
+ * to filter or alias.
+ */
+export type CycleExpression = RelationOptions & {
+    hops: TraversalHops;
+};
 export type Related<M extends Record<string, Model['schema']> = Models> = keyof M extends never ? AnyObject : {
     [Key in keyof M]?: {
         $alias?: string;
         $relation?: TraversalRelationOptions | string;
-        /**
-         * Matches records sitting on a closed path (cycle/ring) back to the
-         * parent record. Requires `$relation` with `hops` (`min` ≥ 2); accepts
-         * no other keys — a cycle has no separate endpoint to filter or alias.
-         */
-        $cycle?: boolean;
     } & Where<M[Key]>;
 };
 export type LogicalExpressionValue<T = PropertyExpression & Related> = AndExpression<T> | NorExpression<T> | NotExpression<T> | OrExpression<T> | T | XorExpression<T>;
@@ -58,7 +62,13 @@ export type Expression<S extends Schema = Schema> = IdExpression | (S extends Sc
 } : {
     [Key in keyof S]?: S[Key] extends MaybeArray<number> ? MaybeLogicalExpression<NumberExpression> : S[Key] extends MaybeArray<boolean> ? MaybeLogicalExpression<BooleanExpression> : S[Key] extends MaybeArray<string> ? MaybeLogicalExpression<DatetimeExpression> | MaybeLogicalExpression<StringExpression> : S[Key] extends MaybeArray<null> ? MaybeLogicalExpression<NullExpression> : LogicalExpression | Partial<PropertyExpression>;
 });
-export type Where<S extends Schema = Schema> = ((Expression<S> & Related) & LogicalGrouping<Expression<S> & Related>) | LogicalGrouping<Expression<S> & Related>;
+export type Where<S extends Schema = Schema> = ((Expression<S> & Related & {
+    $cycle?: CycleExpression;
+}) & LogicalGrouping<Expression<S> & Related & {
+    $cycle?: CycleExpression;
+}>) | LogicalGrouping<Expression<S> & Related & {
+    $cycle?: CycleExpression;
+}>;
 export type OrderDirection = 'asc' | 'desc';
 export type Order<S extends Schema = Schema> = OrderDirection | Partial<Record<keyof S, OrderDirection>>;
 /**

package/package.json

@@ -38,7 +38,7 @@
     "rush-db"
   ],
   "license": "Apache-2.0",
-  "version": "2.9.0",
+  "version": "2.9.1",
   "type": "module",
   "files": [
     "dist"