✨ feat: get all collection

:%s

framework/commerce/api/operations.ts

@@ -10,6 +10,7 @@ import type {
   GetProductOperation,
 } from '../types/product'
 import type { APIProvider, CommerceAPI } from '.'
+import { GetAllCollectionsOperation } from '@commerce/types/collection';
 
 const noop = () => {
   throw new Error('Not implemented')
@@ -25,6 +26,7 @@ export const OPERATIONS = [
   'getAllProducts',
   'getProduct',
   'getAllFacets',
+  'getAllCollections',
 
 ] as const
 
@@ -174,6 +176,22 @@ export type Operations<P extends APIProvider> = {
     ): Promise<T['data']>
   }
 
+  getAllCollections: {
+    <T extends GetAllCollectionsOperation>(opts: {
+      variables?: T['variables']
+      config?: P['config']
+      preview?: boolean
+    }): Promise<T['data']>
+  
+    <T extends GetAllCollectionsOperation>(
+      opts: {
+        variables?: T['variables']
+        config?: P['config']
+        preview?: boolean
+      } & OperationOptions
+    ): Promise<T['data']>
+  }
+
 
 }
 

framework/commerce/new-provider.md

@@ -16,6 +16,7 @@ Adding a commerce provider means adding a new folder in `framework` with a folde
   - getProduct
   - getAllProducts
   - getAllFacets
+  - getAllCollections
 - `wishlist`
   - useWishlist
   - useAddItem

framework/commerce/types/collection.ts

@@ -0,0 +1,54 @@
+import { Asset } from '../../vendure/schema.d';
+
+export type Collection = {
+  id: string
+  name: string
+  slug: string
+  description: string
+  featuredAsse: Asset
+  asset: Asset[]
+}
+
+export type SearchCollectionsBody = {
+  search?: string
+  sort?: string
+  locale?: string
+}
+
+export type CollectionTypes = {
+  collection: Collection
+  searchBody: SearchCollectionsBody
+}
+
+export type SearchCollectionsHook<T extends CollectionTypes = CollectionTypes> = {
+  data: {
+    collections: T['collection'][]
+    found: boolean
+  }
+  body: T['searchBody']
+  input: T['searchBody']
+  fetcherInput: T['searchBody']
+}
+
+export type CollectionsSchema<T extends CollectionTypes = CollectionTypes> = {
+  endpoint: {
+    options: {}
+    handlers: {
+      getCollections: SearchCollectionsHook<T>
+    }
+  }
+}
+
+
+export type GetAllCollectionsOperation<T extends CollectionTypes = CollectionTypes> = {
+  data: { collections: T['collection'][] }
+  variables: {
+    ids?: string[]
+    first?: number
+  }
+}
+
+export type GetCollectionOperation<T extends CollectionTypes = CollectionTypes> = {
+  data: { collection?: T['collection'] }
+  variables: { code: string; } | { code?: never; }
+}

framework/commerce/types/product.ts

@@ -1,4 +1,4 @@
-import { CurrencyCode, FacetValue } from './../../vendure/schema.d';
+import { CurrencyCode } from './../../vendure/schema.d';
 import { FacetValueFilterInput, LogicalOperator, SearchResultSortParameter } from "@framework/schema"
 
 export type ProductImage = {
@@ -59,8 +59,7 @@ export type ProductCard = {
   weight?: number
   facetValueIds?: string[],
   collectionIds?: string[],
-  // TODO: collection
-  category?: string,
+  collection?: string,
   isNotSell?: boolean
 }
 

framework/vendure/api/index.ts

@@ -1,6 +1,7 @@
 import type { CommerceAPIConfig } from '@commerce/api'
 import { CommerceAPI, getCommerceApi as commerceApi } from '@commerce/api'
 import getAllFacets from './operations/get-all-facets'
+import getAllCollections from './operations/get-all-collection'
 import getAllPages from './operations/get-all-pages'
 import getAllProductPaths from './operations/get-all-product-paths'
 import getAllProducts from './operations/get-all-products'
@@ -42,6 +43,7 @@ const operations = {
   getAllProducts,
   getProduct,
   getAllFacets,
+  getAllCollections,
 }
 
 export const provider = { config, operations }

framework/vendure/api/operations/get-all-collection.ts

@@ -0,0 +1,45 @@
+import { OperationContext } from '@commerce/api/operations'
+import { Collection } from '@commerce/types/collection'
+import { Provider, VendureConfig } from '..'
+import { GetAllCollectionsQuery } from '../../schema'
+import { getAllCollectionsQuery } from '../../utils/queries/get-all-collections-query'
+
+export type CollectionVariables = { first?: number }
+
+export default function getAllCollectionsOperation({
+  commerce,
+}: OperationContext<Provider>) {
+  async function getAllCollections(opts?: {
+    variables?: CollectionVariables
+    config?: Partial<VendureConfig>
+    preview?: boolean
+  }): Promise<{ collections: Collection[] }>
+
+  async function getAllCollections({
+    query = getAllCollectionsQuery,
+    variables: { ...vars } = {},
+    config: cfg,
+  }: {
+    query?: string
+    variables?: CollectionVariables
+    config?: Partial<VendureConfig>
+    preview?: boolean
+  } = {}): Promise<{ collections: Collection[] | any[] }> {
+    const config = commerce.getConfig(cfg)
+    const variables = {
+      input: {
+        take: vars.first,
+        groupByCollection: true,
+      },
+    }
+    const { data } = await config.fetch<GetAllCollectionsQuery>(query, {
+      variables,
+    })
+
+    return {
+      collections: data.collections.items,
+    }
+  }
+
+  return getAllCollections
+}

framework/vendure/schema.d.ts

@@ -3240,6 +3240,23 @@ export type GetAllFacetsQuery = { __typename?: 'Query' } & {
   }
 }
 
+export type GetAllCollectionsQuery = { __typename?: 'Query' } & {
+  collections: { __typename?: 'CollectionList' } & {
+    items: Array<
+      { __typename?: 'Collection' } & Pick<
+        Collection,
+        'id' | 'name' | 'slug'
+      > & {
+          parent?: Maybe<{ __typename?: 'Collection' } & Pick<Collection, 'id'>>
+          children?: Maybe<
+            Array<{ __typename?: 'Collection' } & Pick<Collection, 'id'>>
+          >
+        }
+    >,
+    'totalItems'
+  }
+}
+
 export type ActiveOrderQueryVariables = Exact<{ [key: string]: never }>
 
 export type ActiveOrderQuery = { __typename?: 'Query' } & {

framework/vendure/utils/normalize.ts

@@ -18,7 +18,6 @@ export function normalizeSearchResult(item: SearchResultFragment): ProductCard {
     // discount
     // isNotSell
     // weight
-    // category
   }
 }
 

framework/vendure/utils/queries/get-all-collections-query.ts

@@ -0,0 +1,12 @@
+export const getAllCollectionsQuery = /* GraphQL */ `
+query collections ($options: CollectionListOptions) {
+  collections (options: $options){
+    totalItems,
+    items {
+      id
+      name
+      slug
+    }
+  }
+}
+`