@frontstackdev/cli 0.0.0-canary-20250318182507 → 0.0.0-canary-20250318195346

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

@@ -4,43 +4,36 @@
  */
 
 import { ofetch } from 'ofetch'
-import type { BlockEndpoints, BlockParameters, BlockResponses, RequestOptions, BlockQueryFilters, BlockQuerySorts, BlockMode, Page, KeyBlocks, QueryBlocks } from './generated-types'
+
+import type { Endpoints, Responses, RequestOptions, Page, Blocks, Listings, ListingParameters, ListingQueryFilters, ListingQuerySorts } from './generated-types'
+
 import type { Query } from './query-types'
 
 type Method = 'GET' | 'POST' | 'PATCH' | 'DELETE'
-type ContextToken = string
-type Context = any
-type ContextOption = any
 
 /**
  * Interface describing the frontstack client API
  */
 export interface FrontstackClient {
   /**
-   * Fetch a simple block with a key
+   * Fetch a block with a key
    *
-   * @param blockName The name of the block to fetch
+   * @param name The name of the block to fetch
    * @example 'VariantCard'
    * @param key The key identifier for the block
    * @example '<variant-id>'
    * @param config Further configuration options
    */
-  block: <BlockName extends keyof KeyBlocks>(
-    blockName: BlockName,
+  block: <ApiName extends keyof Blocks>(
+    name: ApiName,
     key: string,
-    config?: {
-      /**
-       * Additional configuration options:
-       * - `requestUrl` to provide a URL that will be used to track the origin of the request
-       */
-      options?: RequestOptions
-    }
-  ) => Promise<BlockResponses[BlockName]>;
+    config?: RequestOptions
+  ) => Promise<Responses[ApiName]>;
 
   /**
-   * Fetch a listing block with parameters and optional query filters
+   * Fetch a listing with optional parameters and query filters
    *
-   * @param blockName The name of the listing block to fetch
+   * @param name The name of the listing to fetch
    * @example 'ProductList'
    * @param parameters The parameters to pass to the listing
    * @example { categoryId: '<category-id>' }
@@ -55,9 +48,9 @@ export interface FrontstackClient {
    *  }
    * }
    */
-  listing: <BlockName extends keyof QueryBlocks>(
-    blockName: BlockName,
-    parameters: BlockParameters[BlockName],
+  listing: <ApiName extends keyof Listings>(
+    name: ApiName,
+    parameters: ListingParameters[ApiName],
     config?: {
       /**
        * Query parameters to pass to the listing:
@@ -67,19 +60,14 @@ export interface FrontstackClient {
        * - `limit` to limit the number of results returned
        * - `page` to paginate results
        */
-      query?: Query<BlockQueryFilters[BlockName], BlockQuerySorts[BlockName]>
-      /**
-       * Additional configuration options:
-       * - `requestUrl` to provide a URL that will be used to track the origin of the request
-       */
-      options?: RequestOptions
-    }
-  ) => Promise<BlockResponses[BlockName]>;
+      query?: Query<ListingQueryFilters[ApiName], ListingQuerySorts[ApiName]>
+    } | RequestOptions
+  ) => Promise<Responses[ApiName]>;
 
   /**
    * Fetch a page by its slug
    * @param slug The URL slug of the page (without protocol)
-   * @example my-brand.com/uk/women/shoes/running
+   * @example demo-shop.com/uk/women/shoes/running
    *
    * @returns The page data
    * @example { data: { title: 'Running Shoes' }, type: 'ProductCategory', urls: [] }
@@ -131,7 +119,7 @@ export interface FrontstackClient {
   ) => Promise<Context>;
 }
 
-const endpoints: BlockEndpoints = {
+const endpoints: Endpoints = {
 {{#each paths}}
 {{#if (endsWith this.post.operationId "Block")}}
   {{this.summary}}: '{{@key}}',
@@ -178,10 +166,10 @@ const servers = {
  */
 const client: FrontstackClient = {
   /**
-   * Fetch a simple block with a key
+   * Fetch a block with a key
    */
-  block: async (blockName, key, config) => {
-    let endpoint: string = `${servers[0].url}${endpoints[blockName]}`;
+  block: async (name, key, config) => {
+    let endpoint: string = `${servers[0].url}${endpoints[name]}`;
 
     // Replace '{key}' in the endpoint
     endpoint = endpoint.replace('{key}', key);
@@ -191,32 +179,32 @@ const client: FrontstackClient = {
 
     let headers: Record<string, string> = {}
 
-    if(config?.options?.requestUrl !== undefined) {
-      headers['fs-request-url'] = config.options.requestUrl
+    if(config?.requestUrl !== undefined) {
+      headers['fs-request-url'] = config.requestUrl
     }
-    if (config?.options?.contextKey !== undefined) {
-      headers["fs-token"] = config.options.contextKey;
+    if (config?.contextKey !== undefined) {
+      headers["fs-token"] = config.contextKey;
     }
 
     return (await invoke(endpoint, 'POST', payload, headers))._data
   },
 
   /**
-   * Fetch a listing block with parameters and optional query filters
+   * Fetch a listing with parameters and optional query filters
    */
-  listing: async (blockName, parameters, config) => {
-    let endpoint: string = `${servers[0].url}${endpoints[blockName]}`;
+  listing: async (name, parameters, config) => {
+    let endpoint: string = `${servers[0].url}${endpoints[name]}`;
 
-    // Merge block parameters with query
+    // Merge listing parameters with query
     let payload = config && 'query' in config ? { param: {...parameters}, ...config.query } : { param: {...parameters} }
 
     let headers: Record<string, string> = {}
 
-    if(config?.options?.requestUrl !== undefined) {
-      headers['fs-request-url'] = config.options.requestUrl
+    if(config?.requestUrl !== undefined) {
+      headers['fs-request-url'] = config.requestUrl
     }
-    if (config?.options?.contextKey !== undefined) {
-      headers["fs-token"] = config.options.contextKey;
+    if (config?.contextKey !== undefined) {
+      headers["fs-token"] = config.contextKey;
     }
 
     return (await invoke(endpoint, 'POST', payload, headers))._data
@@ -230,11 +218,11 @@ const client: FrontstackClient = {
 
     let headers: Record<string, string> = {}
 
-    if(config?.options?.requestUrl !== undefined) {
-      headers['fs-request-url'] = config.options.requestUrl
+    if(config?.requestUrl !== undefined) {
+      headers['fs-request-url'] = config.requestUrl
     }
-    if (config?.options?.contextKey !== undefined) {
-      headers["fs-token"] = config.options.contextKey;
+    if (config?.contextKey !== undefined) {
+      headers["fs-token"] = config.contextKey;
     }
 
     return (await invoke(endpoint, 'GET', null, headers))._data

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

@@ -23,7 +23,7 @@ type RequestOptions = {
 
 /* List of all types used to fetch block parameters */
 
-{{#each paths}}{{#if (and (endsWith this.post.operationId "Block") (contains this.post.tags "query-block"))}}export type {{this.summary}}Parameters = {
+{{#each paths}}{{#if (and (endsWith this.post.operationId "Block") (contains this.post.tags "fetch-listing"))}}export type {{this.summary}}Parameters = {
 {{#each this.post.parameters}}
 {{#if @first}}{{else}}
 {{/if}}
@@ -49,30 +49,30 @@ type RequestOptions = {
 {{/if}}{{/each}}
 /* List of all blocks, used for IDE autocompletion */
 
-type BlockParameters = {
+type ListingParameters = {
     {{#each components.schemas}}
-    {{#if (contains tags "query-block")}}
+    {{#if (contains tags "fetch-listing")}}
     {{@key}}: {{@key}}Parameters
     {{/if}}
     {{/each}}
 }
 
-type BlockEndpoints = {
-    [key in keyof QueryBlocks | keyof KeyBlocks]: string;
+type Endpoints = {
+    [key in keyof Listings | keyof Blocks]: string;
 }
 
 /* Types for split block/listing methods */
-export type KeyBlocks = {
+export type Blocks = {
     {{#each components.schemas}}
-    {{#if (contains tags "key-block")}}
+    {{#if (contains tags "fetch-block")}}
     {{@key}}: never
     {{/if}}
     {{/each}}
 }
 
-export type QueryBlocks = {
+export type Listings = {
     {{#each components.schemas}}
-    {{#if (contains tags "query-block")}}
+    {{#if (contains tags "fetch-listing")}}
     {{@key}}: {{@key}}Parameters
     {{/if}}
     {{/each}}
@@ -80,40 +80,40 @@ export type QueryBlocks = {
 
 declare global {
 {{#each components.schemas}}
-{{#if (contains tags "blocks")}}
+{{#if (contains tags "fetch-api")}}
 export type {{@key}} = components['schemas']['{{@key}}']
 {{/if}}
 {{/each}}
 }
 
-export type BlockResponses = {
+export type Responses = {
     {{#each components.schemas}}
-    {{#if (contains tags "blocks")}}
+    {{#if (contains tags "fetch-api")}}
     {{@key}}: {{@key}}
     {{/if}}
     {{/each}}
 }
 
-export type BlockQueryFilters = {
+export type ListingQueryFilters = {
     {{#each components.schemas}}
-    {{#if (contains tags "query-block")}}
+    {{#if (contains tags "fetch-listing")}}
     {{@key}}: components['schemas']['{{@key}}QueryOptions']['filter']
     {{/if}}
     {{/each}}
 }
 
-export type BlockQuerySorts = {
+export type ListingQuerySorts = {
     {{#each components.schemas}}
-    {{#if (contains tags "query-block")}}
+    {{#if (contains tags "fetch-listing")}}
     {{@key}}: components['schemas']['{{@key}}QueryOptions']['sort']
     {{/if}}
     {{/each}}
 }
 
-type BlockMode = {
+type FetchMode = {
     {{#each components.schemas}}
-    {{#if (contains tags "blocks")}}
-    {{@key}}: {{#if (contains tags "query-block") }}'query'{{else}}'key'{{/if}};
+    {{#if (contains tags "fetch-api")}}
+    {{@key}}: {{#if (contains tags "fetch-listing") }}'query'{{else}}'key'{{/if}};
     {{/if}}
     {{/each}}
 }

package/dist/version

@@ -1 +1 @@
-0.0.0-canary-20250318182507
+0.0.0-canary-20250318195346

package/package.json

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