@harperfast/template-vue-studio 1.5.22 → 1.5.23

package/.agents/skills/harper-best-practices/AGENTS.md

@@ -245,11 +245,12 @@ How to use filters, operators, sorting, and pagination in REST requests.
 
 #### Query Parameters
 
-- `limit`: Number of records to return.
-- `offset`: Number of records to skip.
-- `sort`: Field to sort by.
-- `order`: `asc` or `desc`.
-- `filter`: JSON object for filtering.
+- `limit(count)` or `limit(offset, count)`: Number of records to return and optional skip. Example: `?limit(10)`, `?limit(10, 20)`.
+- `sort(+field1, -field2)`: Fields to sort by. Use `+` for ascending and `-` for descending. Example: `?sort(+name)`, `?sort(-price, +name)`.
+- `select(field1, field2)`: Specific fields to return. Example: `?select(id, name)`.
+- `filter`: Advanced filtering using comparison operators and logic.
+  - Operators: `gt`, `ge`, `lt`, `le`, `ne`. Example: `?price=gt=100`.
+  - Logic: `&` (AND), `|` (OR), `()` (grouping). Example: `?(category=electronics|category=books)&price=lt=500`.
 
 ### 2.3 Real-time Applications
 
@@ -292,8 +293,13 @@ How to define custom REST endpoints using JavaScript or TypeScript.
 #### How It Works
 
 1. **Create Resource File**: Define your logic in a JS or TS file.
-2. **Export Handlers**: Export functions like `GET`, `POST`, etc.
-3. **Registration**: Ensure the resource is correctly registered in your application configuration.
+2. **Define Resource Class**: Export a class extending `Resource` from `harperdb`.
+3. **Implement HTTP Methods**: Add methods like `get`, `post`, `put`, `patch`, or `delete` to handle corresponding requests.
+4. **Route Nesting and Naming**: You can control the URL structure by how you export your resources:
+   - **Direct Class Export**: `export class Foo extends Resource` creates endpoints at `/Foo/`. Class names are case-sensitive in the URL.
+   - **Nested Objects**: `export const Bar = { Foo };` creates endpoints at `/Bar/Foo/`.
+   - **Lowercase and Hyphens**: Use object keys to define custom paths: `export const bar = { 'foo-baz': Foo };` exposes endpoints at `/bar/foo-baz/`.
+5. **Registration**: Ensure the resource is correctly registered in your application configuration.
 
 ### 3.2 Extending Table Resources
 

package/.agents/skills/harper-best-practices/rules/custom-resources.md

@@ -27,11 +27,15 @@ Use this skill when the automatic CRUD operations provided by `@table @export` a
    }
    ```
 
-4. **Implement HTTP Methods**: Add methods like `get`, `post`, `put`, `patch`, or `delete` to handle corresponding requests. Note that paths are **case-sensitive** and match the class name.
-5. **Access Tables (Optional)**: Import and use the `tables` object to interact with your data:
+4. **Implement HTTP Methods**: Add methods like `get`, `post`, `put`, `patch`, or `delete` to handle corresponding requests.
+5. **Route Nesting and Naming**: You can control the URL structure by how you export your resources:
+   - **Direct Class Export**: `export class Foo extends Resource` creates endpoints at `/Foo/`. Class names are case-sensitive in the URL.
+   - **Nested Objects**: `export const Bar = { Foo };` creates endpoints at `/Bar/Foo/`.
+   - **Lowercase and Hyphens**: Use object keys to define custom paths: `export const bar = { 'foo-baz': Foo };` exposes endpoints at `/bar/foo-baz/`.
+6. **Access Tables (Optional)**: Import and use the `tables` object to interact with your data:
    ```typescript
    import { tables } from 'harperdb';
    // ... inside a method
    const results = await tables.MyTable.list();
    ```
-6. **Configure Loading**: Ensure `config.yaml` points to your resource files (e.g., `jsResource: { files: 'resources/*.ts' }`).
+7. **Configure Loading**: Ensure `config.yaml` points to your resource files (e.g., `jsResource: { files: 'resources/*.ts' }`).

package/.agents/skills/harper-best-practices/rules/querying-rest-apis.md

@@ -17,6 +17,11 @@ Use this skill when you need to perform advanced data retrieval (filtering, sort
 2. **Use Comparison Operators**: Append operators like `gt`, `ge`, `lt`, `le`, `ne` using FIQL-style syntax: `GET /Table/?price=gt=100`.
 3. **Apply Logic and Grouping**: Use `&` for AND, `|` for OR, and `()` for grouping: `GET /Table/?(rating=5|featured=true)&price=lt=50`.
 4. **Select Specific Fields**: Use `select()` to limit returned attributes: `GET /Table/?select(name,price)`.
-5. **Paginate Results**: Use `limit(count)` or `limit(offset, count)`: `GET /Table/?limit(20, 10)`.
-6. **Sort Results**: Use `sort()` with `+` (asc) or `-` (desc): `GET /Table/?sort(-price,+name)`.
+5. **Paginate Results**: Use `limit(count)` or `limit(offset, count)` to set the number of records to return and skip.
+   - Example (first 10): `GET /Table/?limit(10)`
+   - Example (skip 20, return 10): `GET /Table/?limit(20, 10)`
+6. **Sort Results**: Use `sort()` with `+` (asc) or `-` (desc) before the field name. Avoid `sort=field` format.
+   - Example (asc): `GET /Table/?sort(+name)`
+   - Example (desc): `GET /Table/?sort(-price)`
+   - Example (combined): `GET /Table/?sort(-price,+name)`
 7. **Query Relationships**: Use dot syntax for tables linked with `@relationship`: `GET /Book/?author.name=Harper`.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@harperfast/template-vue-studio",
-	"version": "1.5.22",
+	"version": "1.5.23",
 	"type": "module",
 	"repository": "github:HarperFast/create-harper",
 	"scripts": {},

package/skills-lock.json

@@ -4,7 +4,7 @@
     "harper-best-practices": {
       "source": "harperfast/skills",
       "sourceType": "github",
-      "computedHash": "20b7623e2a79067e2362cd6ffee756f7d039259ff33dd52f2b69ff8f8e3c06bb"
+      "computedHash": "dc6edafe30ac9800fb009d9ac48b73206e9ba9efc6b9a49268aeb1bb7e8c1b8c"
     }
   }
 }