@frontstackdev/cli 0.0.0-canary-20240830084913 → 0.0.0-canary-20240831065733

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

@@ -0,0 +1,139 @@
+/**
+ * This file was automatically generated using the
+ * Frontstack CLI, please do not edit it manually!
+ */
+
+import { ofetch } from 'ofetch'
+import type { BlockEndpoints, BlockParameters, BlockResponses, RequestOptions, BlockQueryFilters, BlockMode, Page } from './generated-types'
+import type { Query } from './query-types'
+
+type Method = 'GET' | 'POST' | 'PUT' | 'DELETE'
+
+const endpoints: BlockEndpoints = {
+{{#each paths}}
+{{#if (endsWith this.get.operationId "Block")}}
+  {{this.summary}}: '{{@key}}',
+{{/if}}
+{{/each}}
+}
+
+const invoke = (path: string, method: Method, payload: any, headers: any) => {
+  const _headers: any = {
+    'Content-Type': 'application/json',
+    'Accept': 'application/json',
+  }
+
+  // Merge headers
+  headers = { ..._headers, ...headers }
+
+  let options: any = {
+    method,
+    headers,
+    body: payload
+  }
+
+  return ofetch(path, options)
+}
+
+/* Listing servers, even though only the first one is ever used */
+const servers = {
+  {{#each servers}}
+  {{@key}}: {
+    description: '{{description}}',
+    url: '{{url}}'
+  },
+  {{/each}}
+}
+
+/**
+ * Frontstack Client
+ */
+const client = {
+  /**
+   * Fetch a block with parameters
+   *
+   * @param blockName The name of the block to fetch
+   * @example 'VariantCard'
+   * @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: 'Red Dress' } } }
+   */
+  block: <BlockName extends keyof BlockEndpoints>(
+    blockName: BlockName,
+    blockParameters: BlockParameters[BlockName],
+    config?: (
+      BlockMode[BlockName] extends 'query' ?
+      {
+        /**
+         * 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
+         * - `search` to perform a text search
+         * - `limit` to limit the number of results returned
+         * - `page` to paginate results
+         */
+        query?: Query<BlockQueryFilters[BlockName]>
+      } : {}
+    ) &
+    {
+      /**
+       * Additional configuration options:
+       * - `requestUrl` to provide a URL that will be used to track the origin of the request
+       */
+      options?: BlockOptions
+    }
+  ): Promise<BlockResponses[BlockName]> => {
+    let endpoint: string = `${servers[0].url}${endpoints[blockName]}`;
+
+    // If payload contains `key` replace '{key}' in the endpoint
+    if(blockParameters.key) {
+      endpoint = endpoint.replace('{key}', blockParameters.key)
+      delete blockParameters.key
+    }
+
+    // Merge block parameters with query
+    let payload = { ...blockParameters, ...config?.query }
+
+    let headers: Record<string, string> = {}
+
+    if(config?.options?.requestUrl !== undefined) {
+      headers['fs-request-url'] = config.options.requestUrl
+    }
+    if (config?.options?.contextKey !== undefined) {
+      headers["fs-token"] = config.options.contextKey;
+    }
+
+    return invoke(endpoint, 'POST', payload, headers)
+  },
+
+  /**
+   * Fetch a page by its slug
+   * @param slug The URL slug of the page (without protocol)
+   * @example my-brand.com/uk/women/shoes/running
+   * 
+   * @returns The page data
+   * @example { data: { title: 'Running Shoes' }, type: 'ProductCategory', urls: [] }
+   */
+  page: async (
+    slug: string | string[],
+    config?: {
+      options?: RequestOptions
+    }
+  ): Promise<Page> => {
+    let endpoint: string = `${servers[0].url}/page/${slug}`;
+
+    let headers: Record<string, string> = {}
+
+    if(config?.options?.requestUrl !== undefined) {
+      headers['fs-request-url'] = config.options.requestUrl
+    }
+    if (config?.options?.contextKey !== undefined) {
+      headers["fs-token"] = config.options.contextKey;
+    }
+
+    return invoke(endpoint, 'POST', {}, headers)
+  }
+}
+
+export default client

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

@@ -0,0 +1,150 @@
+/**
+ * This file was automatically generated using the
+ * Frontstack CLI, please do not edit it manually!
+ */
+
+export type Filter<T> = EqualsFilter<T> | RangeFilter<T> | ContainsFilter<T> | LogicalFilter<T>;
+
+/**
+ * Helper Types
+ */
+type NumericKeys<T> = {
+  [K in keyof T]: T[K] extends number ? K : never
+}[keyof T];
+
+type EnumKeys<T> = {
+  [K in keyof T]: T[K] extends string ? (string extends T[K] ? never : K) : never
+}[keyof T];
+
+// All string keys that are not enums
+type StringKeys<T> = {
+  [K in keyof T]: T[K] extends string ? K : never
+}[keyof T] & Exclude<keyof T, EnumKeys<T>>;
+
+/**
+ * Filter a field by equality. You can use an array of values to filter by multiple values
+ *
+ * @example
+ * {
+ *   type: 'equals',
+ *   field: 'name',
+ *   value: ['Red Dress', 'Blue Dress']
+ * }
+ */
+export type EqualsFilter<T> = {
+  [K in keyof T]: {
+    type: 'equals';
+    field: K;
+    value: T[K] | T[K][];
+  }
+}[keyof T];
+
+/**
+ * Filter a field by a range. You can use either from, to or both
+ *
+ * @example
+ * {
+ *   type: 'range',
+ *   field: 'price',
+ *   from: 10,
+ *   to: 100
+ * }
+ */
+export type RangeFilter<T> = {
+  [K in NumericKeys<T>]: {
+    type: 'range';
+    field: K;
+    from?: T[K];
+    to?: T[K];
+  }
+}[NumericKeys<T>];
+
+/**
+ * Filter a field by a substring match.
+ *
+ * @example
+ * {
+ *   type: 'contains',
+ *   field: 'name',
+ *   value: 'Dress'
+ * }
+ */
+export type ContainsFilter<T> = {
+  [K in StringKeys<T>]: {
+    type: 'contains';
+    field: K;
+    value: string;
+  }
+}[StringKeys<T>];
+
+/**
+ * Combine multiple filters with a logical operator
+ *
+ * @example
+ * {
+ *   type: 'and',
+ *   filters: [
+ *     {
+ *       type: 'equals',
+ *       field: 'name',
+ *       value: 'Red Dress'
+ *     },
+ *     {
+ *       type: 'range',
+ *       field: 'price',
+ *       from: 10,
+ *       to: 100
+*      }
+ *   ]
+ * }
+ */
+export type LogicalFilter<T> = {
+  type: 'and' | 'or';
+  filters: Filter<T>[];
+}
+
+export type SortField<T> = keyof T;
+
+/**
+ * Sort results by a field and direction
+ *
+ * @example
+ * {
+ *   field: 'price',
+ *   direction: 'asc'
+ * }
+ */
+export type Sort<T> = {
+  field: SortField<T >;
+  direction: 'asc' | 'desc';
+}
+
+
+export type Query<T> = {
+  /**
+   * Filter results by a set of conditions
+   */
+  filter?: Filter<T>[];
+  /**
+   * Will search fields that are marked as searchable
+   */
+  search?: string;
+  /**
+   * Sort results by a field and direction
+   *
+   * There are three ways to sort:
+   *
+   *  * A single sort object
+   *  * An array of sort objects
+   *  * A single sort field
+   */
+  sort?: Sort<T> | Sort<T>[] | SortField<T>;
+  /**
+   * Limit the number of results returned
+   */
+  limit?: number;
+  /**
+   * Paginate results
+   */
+  page?: number;
+}

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

@@ -0,0 +1,103 @@
+/**
+ * This file was automatically generated using the
+ * Frontstack CLI, please do not edit it manually!
+ */
+
+import type { components } from './fetch-api.d.ts'
+
+/* Frontstack default types */
+
+type SearchQuery = components['schemas']['SearchQuery']
+type Media = components['schemas']['Media']
+
+type RequestOptions = {
+    /**
+     * @description URL to the current page
+     *
+     * Optionally, Frontstack accepts a URL to the current page. This is useful for tracking purposes.
+     */
+    requestUrl?: string
+
+    /**
+     * @description Context key
+     *
+     * Providing a context key will override the default context key for the request
+     */
+    contextKey?: string
+}
+
+/* List of all types used to fetch block parameters */
+
+{{#each paths}}{{#if (endsWith this.get.operationId "Block")}}export type {{this.summary}}Parameters = {
+{{#each this.get.parameters}}
+{{#if @first}}{{else}}
+{{/if}}
+    /**
+     * @description {{description}}
+     */
+    {{name}}{{#unless required}}?{{/unless}}: {{{getSchemaType schema}}};
+    {{/each}}
+}
+
+{{/if}}{{/each}}
+/* List of all blocks, used for IDE autocompletion */
+
+type BlockParameters = {
+    {{#each components.schemas}}
+    {{#if (contains tags "blocks")}}
+    {{@key}}: {{@key}}Parameters
+    {{/if}}
+    {{/each}}
+}
+
+type BlockEndpoints = {
+    [key in keyof BlockParameters]: string;
+}
+
+declare global {
+{{#each components.schemas}}
+{{#if (contains tags "blocks")}}
+export type {{@key}} = {
+    {{#each properties}}
+    {{@key}}: {{{getSchemaType this}}}
+    {{/each}}
+}
+{{/if}}
+{{/each}}
+}
+{{!--
+
+The loop below would work as well, but it makes all parameters optional, which leads to bad DX
+Solve later
+
+{{#each components.schemas}}
+{{#if (contains tags "blocks")}}
+export type {{@key}} = components['schemas']['{{@key}}']
+{{/if}}
+{{/each}}
+--}}
+type BlockResponses = {
+    {{#each components.schemas}}
+    {{#if (contains tags "blocks")}}
+    {{@key}}: {{@key}}
+    {{/if}}
+    {{/each}}
+}
+
+type BlockQueryFilters = {
+    {{#each components.schemas}}
+    {{#if (contains tags "blocks")}}
+    {{@key}}: components['schemas']['{{@key}}QueryOptions']['filter']
+    {{/if}}
+    {{/each}}
+}
+
+type BlockMode = {
+    {{#each components.schemas}}
+    {{#if (contains tags "blocks")}}
+    {{@key}}: {{#if (contains tags "query-block") }}'query'{{else}}'key'{{/if}};
+    {{/if}}
+    {{/each}}
+}
+
+export type Page = components['schemas']['Page']

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@frontstackdev/cli",
-  "version": "0.0.0-canary-20240830084913",
+  "version": "0.0.0-canary-20240831065733",
   "description": "Frontstack CLI for managing projects",
   "exports": "./dist/frontstack.mjs",
   "module": "./dist/frontstack.mjs",
   "type": "module",
   "scripts": {
-    "build": "pkgroll --clean-dist",
+    "build": "pkgroll --clean-dist --minify && mkdir -p dist/src/commands/generate && cp -r src/commands/generate/templates dist/src/commands/generate/",
     "start": "tsx src/frontstack.ts",
     "frontstack": "pnpm build && node dist/frontstack.mjs",
     "test": "vitest",
-    "lint": "tsc"
+    "lint": "tsc",
+    "clean": "rm -rf dist"
   },
   "keywords": [],
   "bin": {