Added getAllPages operation

framework/bigcommerce/api/index.ts

@@ -14,7 +14,9 @@ import type { CustomerAPI } from './endpoints/customer'
 import type { LoginAPI } from './endpoints/login'
 import type { LogoutAPI } from './endpoints/logout'
 import type { SignupAPI } from './endpoints/signup'
+
 import login from './operations/login'
+import getAllPages from './operations/get-all-pages'
 
 export interface BigcommerceConfig extends CommerceAPIConfig {
   // Indicates if the returned metadata with translations should be applied to the
@@ -110,7 +112,7 @@ const config2: BigcommerceConfig = {
 
 export const provider = {
   config: config2,
-  operations: { login },
+  operations: { login, getAllPages },
 }
 
 export type Provider = typeof provider

framework/bigcommerce/api/operations/get-all-pages.ts

@@ -0,0 +1,46 @@
+import type {
+  OperationContext,
+  OperationOptions,
+} from '@commerce/api/operations'
+import type { RecursivePartial, RecursiveRequired } from '../utils/types'
+import type { Page, GetAllPagesOperation } from '../../types/page'
+import { BigcommerceConfig, Provider } from '..'
+
+function getAllPagesOperation({ commerce }: OperationContext<Provider>) {
+  async function getAllPages(opts?: {
+    config?: BigcommerceConfig
+    preview?: boolean
+  }): Promise<GetAllPagesOperation['data']>
+
+  async function getAllPages<T extends GetAllPagesOperation>(
+    opts: {
+      config?: BigcommerceConfig
+      preview?: boolean
+    } & OperationOptions
+  ): Promise<T['data']>
+
+  async function getAllPages({
+    config,
+    preview,
+  }: {
+    url?: string
+    config?: BigcommerceConfig
+    preview?: boolean
+  } = {}): Promise<GetAllPagesOperation['data']> {
+    config = commerce.getConfig(config)
+    // RecursivePartial forces the method to check for every prop in the data, which is
+    // required in case there's a custom `url`
+    const { data } = await config.storeApiFetch<
+      RecursivePartial<{ data: Page[] }>
+    >('/v3/content/pages')
+    const pages = (data as RecursiveRequired<typeof data>) ?? []
+
+    return {
+      pages: preview ? pages : pages.filter((p) => p.is_visible),
+    }
+  }
+
+  return getAllPages
+}
+
+export default getAllPagesOperation

framework/bigcommerce/common/get-all-pages.ts

@@ -1,43 +0,0 @@
-import type { RecursivePartial, RecursiveRequired } from '../api/utils/types'
-import { BigcommerceConfig, getConfig } from '../api'
-import { definitions } from '../api/definitions/store-content'
-
-export type Page = definitions['page_Full']
-
-export type GetAllPagesResult<
-  T extends { pages: any[] } = { pages: Page[] }
-> = T
-
-async function getAllPages(opts?: {
-  config?: BigcommerceConfig
-  preview?: boolean
-}): Promise<GetAllPagesResult>
-
-async function getAllPages<T extends { pages: any[] }>(opts: {
-  url: string
-  config?: BigcommerceConfig
-  preview?: boolean
-}): Promise<GetAllPagesResult<T>>
-
-async function getAllPages({
-  config,
-  preview,
-}: {
-  url?: string
-  config?: BigcommerceConfig
-  preview?: boolean
-} = {}): Promise<GetAllPagesResult> {
-  config = getConfig(config)
-  // RecursivePartial forces the method to check for every prop in the data, which is
-  // required in case there's a custom `url`
-  const { data } = await config.storeApiFetch<
-    RecursivePartial<{ data: Page[] }>
-  >('/v3/content/pages')
-  const pages = (data as RecursiveRequired<typeof data>) ?? []
-
-  return {
-    pages: preview ? pages : pages.filter((p) => p.is_visible),
-  }
-}
-
-export default getAllPages

framework/bigcommerce/types/page.ts

@@ -0,0 +1,9 @@
+import { definitions } from '../api/definitions/store-content'
+
+export * from '@commerce/types/page'
+
+export type Page = definitions['page_Full']
+
+export type GetAllPagesOperation = {
+  data: { pages: Page[] }
+}

framework/commerce/api/operations.ts

@@ -1,5 +1,5 @@
 import type { LoginOperation } from '../types/login'
-import type { GetAllPagesResult } from '../types/page'
+import type { GetAllPagesOperation } from '../types/page'
 import type { ServerResponse } from 'http'
 import type { APIProvider, CommerceAPI, CommerceAPICore } from '.'
 
@@ -33,17 +33,17 @@ export type Operations<P extends APIProvider> = {
     ): Promise<T['data']>
   }
   getAllPages: {
-    (opts?: {
+    <T extends GetAllPagesOperation>(opts?: {
       config?: P['config']
       preview?: boolean
-    }): Promise<GetAllPagesResult>
+    }): Promise<T['data']>
 
-    <T extends GetAllPagesResult>(
+    <T extends GetAllPagesOperation>(
       opts: {
         config?: P['config']
         preview?: boolean
       } & OperationOptions
-    ): Promise<T>
+    ): Promise<T['data']>
   }
 }
 

framework/commerce/types/page.ts

@@ -0,0 +1,6 @@
+// TODO: define this type
+export type Page = any
+
+export type GetAllPagesOperation = {
+  data: { pages: Page[] }
+}