@frontstackdev/cli 0.0.0-canary-20241122101833 → 0.0.0-canary-20241122125012

package/dist/src/commands/generate/templates/client.js.hbs

@@ -4,7 +4,7 @@
  */
 
 import { ofetch } from 'ofetch'
-import type { BlockEndpoints, BlockParameters, BlockResponses, RequestOptions, BlockQueryFilters, BlockMode, Page } from './generated-types'
+import type { BlockEndpoints, BlockParameters, BlockResponses, RequestOptions, BlockQueryFilters, BlockQuerySorts, BlockMode, Page } from './generated-types'
 import type { Query } from './query-types'
 
 type Method = 'GET' | 'POST' | 'PATCH' | 'DELETE'
@@ -63,7 +63,15 @@ const client = {
    * @param blockParameters The parameters to pass to the block
    * @example { key: '<variant-id>' }
    * @param config  Further configuration options
-   * @example { query: { filter: [{ type: 'equals', field: 'name', value: 'Blue Dress' }] } }
+   * @example {
+   *  query: {
+   *    filter: [{ type: 'equals', field: 'name', value: 'Red Dress' }],
+   *    sort: [{
+   *      'order': 'asc',
+   *      'field': 'label'
+   *    }]
+   *  }
+   * }
    */
   block: async <BlockName extends keyof BlockEndpoints>(
     blockName: BlockName,
@@ -74,12 +82,12 @@ const client = {
         /**
          * Query parameters to pass to the block:
          * - `filter` accepts an array of filter objects to filter results
-         * - `sort` accepts an array of sorting options to sort results
+         * - `sort` accepts a string or an array of sorting options to sort results
          * - `search` to perform a text search
          * - `limit` to limit the number of results returned
          * - `page` to paginate results
          */
-        query?: Query<BlockQueryFilters[BlockName]>
+        query?: Query<BlockQueryFilters[BlockName], BlockQuerySorts[BlockName]>
       } : {}
     ) &
     {

package/dist/src/commands/generate/templates/query.js.hbs

@@ -106,25 +106,24 @@ export type LogicalFilter<T> = {
 export type SortField<T> = keyof T;
 
 /**
- * Sort results by a field and direction
+ * Sort results by a field and ordering direction
  *
  * @example
  * {
  *   field: 'price',
- *   direction: 'asc'
+ *   order: 'asc'
  * }
  */
 export type Sort<T> = {
   field: SortField<T >;
-  direction: 'asc' | 'desc';
+  order: 'asc' | 'desc';
 }
 
-
-export type Query<T> = {
+export type Query<FilterType, SortType> = {
   /**
    * Filter results by a set of conditions
    */
-  filter?: Filter<T>[];
+  filter?: Filter<FilterType>[];
   /**
    * Will search fields that are marked as searchable
    */
@@ -138,7 +137,7 @@ export type Query<T> = {
    *  * An array of sort objects
    *  * A single sort field
    */
-  sort?: Sort<T> | Sort<T>[] | SortField<T>;
+  sort?: Sort<SortType> | Sort<SortType>[] | SortField<SortType>;
   /**
    * Limit the number of results returned
    */

package/dist/src/commands/generate/templates/types.js.hbs

@@ -99,6 +99,14 @@ type BlockQueryFilters = {
     {{/each}}
 }
 
+type BlockQuerySorts = {
+    {{#each components.schemas}}
+    {{#if (contains tags "blocks")}}
+    {{@key}}: components['schemas']['{{@key}}QueryOptions']['sort']
+    {{/if}}
+    {{/each}}
+}
+
 type BlockMode = {
     {{#each components.schemas}}
     {{#if (contains tags "blocks")}}

package/dist/version

@@ -1 +1 @@
-0.0.0-canary-20241122101833
+0.0.0-canary-20241122125012

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frontstackdev/cli",
-  "version": "0.0.0-canary-20241122101833",
+  "version": "0.0.0-canary-20241122125012",
   "description": "frontstack CLI for managing projects",
   "type": "module",
   "module": "dist/frontstack.mjs",