@rljson/rljson 0.0.65 → 0.0.67

package/dist/route/route.d.ts

@@ -11,6 +11,7 @@ export type RouteSegmentFlat<N extends string> = `${N}` | `${N}@${string}` | `${
  */
 export declare class Route {
     private readonly _segments;
+    private _propertyKey?;
     constructor(_segments: RouteSegment<any>[]);
     /**
      * Creates a Route from a flat string representation.
@@ -31,6 +32,33 @@ export declare class Route {
      * @returns A new Route that is one level deeper or 'steps' levels deeper
      */
     deeper(steps?: number): Route;
+    /**
+     * Returns a new Route that is one level higher than the current route.
+     * If steps is provided, it returns a new Route that is 'steps' levels higher.
+     * @param steps - The number of levels to go higher (optional)
+     * @returns A new Route that is one level higher or 'steps' levels higher
+     */
+    upper(steps?: number): Route;
+    /**
+     * Returns a new Route with the property key set to the last segment's table key.
+     * If the property key is already set, it returns the current route.
+     * @returns A new Route with the property key set
+     */
+    toRouteWithProperty(): Route;
+    /**
+     * Returns a new Route without the property key.
+     * If the property key is not set, it returns the current route.
+     * @returns A new Route without the property key
+     */
+    toRouteWithoutProperty(): Route;
+    /**
+     * Checks if the current route includes another route.
+     * A route includes another route if all segments of the other route
+     * are present in the current route in the same order.
+     * @param other - The other route to check
+     * @returns True if the current route includes the other route, false otherwise
+     */
+    includes(other: Route): boolean;
     /**
      * Checks if the current route is the root route.
      * @returns True if the current route is the root route, false otherwise
@@ -41,6 +69,16 @@ export declare class Route {
      * @returns The flat string representation of the route (e.g. "/a/b/c")
      */
     get flat(): string;
+    /**
+     * Returns the flat string representation of the route without the property key.
+     * @returns The flat string representation of the route without the property key
+     */
+    get flatWithoutPropertyKey(): string;
+    /**
+     * Returns the flat string representation of the route without any references.
+     * @returns The flat string representation of the route without any references
+     */
+    get flatWithoutRefs(): string;
     /**
      * Returns the segments of the route as an array of strings.
      * @returns The segments of the route as an array of strings
@@ -66,6 +104,39 @@ export declare class Route {
      * @returns True if the route is valid, false otherwise
      */
     get isValid(): boolean;
+    /**
+     * Checks if the route has a property key.
+     * @returns True if the route has a property key, false otherwise
+     */
+    get hasPropertyKey(): boolean;
+    /**
+     * Returns the property key of the route if it exists.
+     * @returns The property key of the route or undefined if it doesn't exist
+     */
+    get propertyKey(): string | undefined;
+    /**
+     * Sets the property key of the route.
+     * @param key - The property key to set
+     */
+    set propertyKey(key: string | undefined);
+    /**
+     * Checks if two routes are equal.
+     * @param other - The other route to compare with
+     * @returns True if the routes are equal, false otherwise
+     */
+    equals(other: Route): boolean;
+    /**
+     * Checks if two routes are equal without considering the property key.
+     * @param other - The other route to compare with
+     * @returns True if the routes are equal without considering the property key, false otherwise
+     */
+    equalsWithoutPropertyKey(other: Route): boolean;
+    /**
+     * Checks if two routes are equal without considering the references.
+     * @param other - The other route to compare with
+     * @returns True if the routes are equal without considering the references, false otherwise
+     */
+    equalsWithoutRefs(other: Route): boolean;
     /**
      * Returns the reference of a segment if it exists.
      * @param segment - The segment to get the reference from
@@ -73,21 +144,21 @@ export declare class Route {
      */
     static segmentRef(segment: RouteSegment<any>): string | undefined;
     /**
-     * Checks if a segment has any reference (either default or history).
+     * Checks if a segment has any reference (either default or insertHistory).
      * @param segment - The segment to check
      * @returns True if the segment has any reference, false otherwise
      */
     static segmentHasRef(segment: RouteSegment<any>): boolean;
     /**
-     * Checks if a segment has a default reference (i.e. not a history reference).
+     * Checks if a segment has a default reference (i.e. not a insertHistory reference).
      * @param segment - The segment to check
      * @returns True if the segment has a default reference, false otherwise
      */
     static segmentHasDefaultRef(segment: RouteSegment<any>): boolean;
     /**
-     * Checks if a segment has a history reference (i.e. an HistoryRef).
+     * Checks if a segment has a insertHistory reference (i.e. an InsertHistoryRef).
      * @param segment - The segment to check
-     * @returns True if the segment has a history reference, false otherwise
+     * @returns True if the segment has a insertHistory reference, false otherwise
      */
-    static segmentHasHistoryRef(segment: RouteSegment<any>): boolean;
+    static segmentHasInsertHistoryRef(segment: RouteSegment<any>): boolean;
 }