@frontstackdev/cli 0.0.0-canary-20241104114513 → 0.0.0-canary-20241104163513

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

@@ -7,7 +7,7 @@ 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'
+type Method = 'GET' | 'POST' | 'PATCH' | 'DELETE'
 
 const endpoints: BlockEndpoints = {
 {{#each paths}}
@@ -17,7 +17,7 @@ const endpoints: BlockEndpoints = {
 {{/each}}
 }
 
-const invoke = (path: string, method: Method, payload: any, headers: any) => {
+const invoke = async (path: string, method: Method, payload: any, headers: any) => {
   const _headers: any = {
     'Content-Type': 'application/json',
     'Accept': 'application/json',
@@ -25,7 +25,7 @@ const invoke = (path: string, method: Method, payload: any, headers: any) => {
     'fs-preview-key': '{{components.parameters.FsPreviewKey.schema.enum.[0]}}',
     {{/if}}
     {{#if components.parameters.FsSecret.required}}
-    'fs-secret': '{{components.parameters.FsSecret.schema.enum.[0]}}'
+    'fs-secret': '{{components.parameters.FsSecret.schema.enum.[0]}}',
     {{/if}}
   }
 
@@ -38,7 +38,7 @@ const invoke = (path: string, method: Method, payload: any, headers: any) => {
     body: payload
   }
 
-  return ofetch(path, options)
+  return await ofetch.raw(path, options)
 }
 
 /* Listing servers, even though only the first one is ever used */
@@ -63,9 +63,9 @@ 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: 'Red Dress' } } }
+   * @example { query: { filter: [{ type: 'equals', field: 'name', value: 'Red Dress' }] } }
    */
-  block: <BlockName extends keyof BlockEndpoints>(
+  block: async <BlockName extends keyof BlockEndpoints>(
     blockName: BlockName,
     blockParameters: BlockParameters[BlockName],
     config?: (
@@ -110,7 +110,7 @@ const client = {
       headers["fs-token"] = config.options.contextKey;
     }
 
-    return invoke(endpoint, 'POST', payload, headers)
+    return (await invoke(endpoint, 'POST', payload, headers))._data
   },
 
   /**
@@ -138,7 +138,74 @@ const client = {
       headers["fs-token"] = config.options.contextKey;
     }
 
-    return invoke(endpoint, 'GET', null, headers)
+    return (await invoke(endpoint, 'GET', null, headers))._data
+  },
+
+  /**
+   * Fetch a context by its token
+   * @param token The token of the context
+   * @example 'ae0d4981-c363-4d5a-a49e-1f053d49f2f7'
+   *
+   * @returns The context and token
+   */
+  context: async (
+    token: ContextToken
+  ): Promise<Context> => {
+    let endpoint: string = `${servers[0].url}/context/token`;
+
+    let headers: Record<string, string> = {
+      'fs-token': token
+    }
+
+    return (await invoke(endpoint, 'GET', null, headers))._data
+  },
+
+  /**
+   * Fetch a list of contexts
+   * @param token The token of the context to fetch
+   * @example 'ae0d4981-c363-4d5a-a49e-1f053d49f2f7'
+   *
+   * @returns The list of contexts and the token
+   */
+  contextList: async (
+    token?: ContextToken
+  ): Promise<[Context[], ContextToken]> => {
+    let endpoint: string = `${servers[0].url}/context`;
+
+    const requestHeaders: Record<string, string> = {}
+
+    if (token) {
+      requestHeaders["fs-token"] = token;
+    }
+
+    const {
+      _data,
+      headers: responseHeaders
+    } = await invoke(endpoint, 'GET', null, requestHeaders)
+    
+    return [_data, responseHeaders.get('fs-token')!]
+  },
+
+  /**
+   * Update a context
+   * @param context The context to update
+   * @example { region: 'uk', locale: 'en-GB' }
+   * @param token The token of the context to update
+   * @example 'ae0d4981-c363-4d5a-a49e-1f053d49f2f7'
+   *
+   * @returns The updated context
+   */
+  contextUpdate: async(context: {
+    region: string
+    locale: string
+  }, token: ContextToken): Promise<Context> => {
+    let endpoint: string = `${servers[0].url}/context`;
+
+    let headers: Record<string, string> = {
+      'fs-token': token
+    }
+
+    return (await invoke(endpoint, 'PATCH', context, headers))._data
   }
 }
 

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

@@ -96,3 +96,33 @@ type BlockMode = {
 }
 
 export type Page = components['schemas']['Page']
+
+declare global {
+    export type ContextToken = string
+
+    export type Context = {
+        /**
+        * The region of the context - e.g. 'uk'
+        */
+        region: string
+        /**
+        * The currency of the context - e.g. 'GBP'
+        */
+        currency: string
+        /**
+        * List of locales of the context
+        */
+        locales: Array<Locale>
+    }
+
+    export type Locale = {
+        /**
+        * The key of the locale - e.g. 'en-GB'
+        */
+        key: string
+        /**
+        * The URL configured for the locale - e.g. 'https://my-brand.com/uk/en'
+        */
+        url: string
+    }
+}

package/dist/version

@@ -1 +1 @@
-0.0.0-canary-20241104114513
+0.0.0-canary-20241104163513

package/package.json

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