@frontstackdev/cli 0.0.0-canary-20250318230714 → 0.0.0-canary-20250319090433

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -31,7 +31,7 @@ export interface FrontstackClient {
31
31
  ) => Promise<Responses[ApiName]>;
32
32
 
33
33
  /**
34
- * Fetch a listing with optional parameters and query filters
34
+ * Fetch a listing with optional parameters and query options
35
35
  *
36
36
  * @param name The name of the listing to fetch
37
37
  * @example 'ProductList'
@@ -40,10 +40,10 @@ export interface FrontstackClient {
40
40
  * @param config Further configuration options
41
41
  * @example {
42
42
  * query: {
43
- * filter: [{ type: 'equals', field: 'name', value: 'Red Dress' }],
43
+ * filter: [{ type: 'equals', field: 'color', value: 'Red' }],
44
44
  * sort: [{
45
- * 'order': 'asc',
46
- * 'field': 'label'
45
+ * 'field': 'publishedAt',
46
+ * 'order': 'asc'
47
47
  * }]
48
48
  * }
49
49
  * }
@@ -61,7 +61,7 @@ export interface FrontstackClient {
61
61
  * - `page` to paginate results
62
62
  */
63
63
  query?: Query<ListingQueryFilters[ApiName], ListingQuerySorts[ApiName]>
64
- } | RequestOptions
64
+ } & RequestOptions
65
65
  ) => Promise<Responses[ApiName]>;
66
66
 
67
67
  /**
@@ -188,7 +188,7 @@ const client: FrontstackClient = {
188
188
  },
189
189
 
190
190
  /**
191
- * Fetch a listing with parameters and optional query filters
191
+ * Fetch a listing with parameters and optional query options
192
192
  */
193
193
  listing: async (name, parameters, config) => {
194
194
  let endpoint: string = `${servers[0].url}${endpoints[name]}`;
@@ -27,8 +27,8 @@ type StringKeys<T> = {
27
27
  * @example
28
28
  * {
29
29
  * type: 'equals',
30
- * field: 'name',
31
- * value: ['Red Dress', 'Blue Dress']
30
+ * field: 'color',
31
+ * value: ['Red', 'Blue']
32
32
  * }
33
33
  */
34
34
  export type EqualsFilter<T> = {
@@ -86,8 +86,8 @@ export type ContainsFilter<T> = {
86
86
  * filter: [
87
87
  * {
88
88
  * type: 'equals',
89
- * field: 'name',
90
- * value: 'Red Dress'
89
+ * field: 'color',
90
+ * value: 'Red'
91
91
  * },
92
92
  * {
93
93
  * type: 'range',
@@ -110,7 +110,7 @@ export type SortField<T> = keyof T;
110
110
  *
111
111
  * @example
112
112
  * {
113
- * field: 'price',
113
+ * field: 'publishedAt',
114
114
  * order: 'asc'
115
115
  * }
116
116
  */
package/dist/version CHANGED
@@ -1 +1 @@
1
- 0.0.0-canary-20250318230714
1
+ 0.0.0-canary-20250319090433
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@frontstackdev/cli",
3
- "version": "0.0.0-canary-20250318230714",
3
+ "version": "0.0.0-canary-20250319090433",
4
4
  "description": "frontstack CLI for managing projects",
5
5
  "type": "module",
6
6
  "module": "dist/frontstack.mjs",