Primary Collection

To construct breadcrumbs and URL's it's useful to have a primary collection for each product, in case a product is part of multiple collections. This plugin extends Vendure's Product graphql type, adding a primaryCollection field that points to the primary collection of a product.

Primary collections can be selected in the Admin UI's product detail view.

This Plugin also exports PrimaryCollectionHelperService which can be used to assign primaryCollection's to products without existing values by running PrimaryCollectionHelperService.setPrimaryCollectionForAllProducts.

Getting started

Add the plugin to your vendure-config.ts:

plugins: [  PrimaryCollectionPlugin.init({    customFieldUITabName: 'Primary Collection',  }),  AdminUiPlugin.init({    port: 3002,    route: 'admin',    app: compileUiExtensions({      outputPath: path.join(__dirname, '__admin-ui'),      extensions: [PrimaryCollectionPlugin.ui],    }),  }),];

And your good to go with just that.

Migrating from `1.6.0` to `2.0.0`

Always create a backup of your database
Install the plugin and generate a migration
In your migration file, add the function exportCurrentPrimaryCollections(queryRunner) to the top and savePrimaryCollection(queryRunner) to the bottom of the up function in your migration file, like so

import { exportCurrentPrimaryCollections, savePrimaryCollection } from "@pinelab/vendure-plugin-primary-collection";   public async up(queryRunner: QueryRunner): Promise<any> {        // add this line        await exportCurrentPrimaryCollections(queryRunner)        await queryRunner.query("ALTER TABLE `product` DROP FOREIGN KEY `FK_5e6c3c845407ccaa497eca1a865`", undefined);        await queryRunner.query("ALTER TABLE `product` CHANGE `customFieldsPrimarycollectionid` `customFieldsPrimarycollection` int NULL", undefined);        await queryRunner.query("ALTER TABLE `product` DROP COLUMN `customFieldsPrimarycollection`", undefined);        await queryRunner.query("ALTER TABLE `product` ADD `customFieldsPrimarycollection` varchar(255) NULL", undefined);        //...and this line        await savePrimaryCollection(queryRunner)   }

Run the migration.

Upgraded to Vendure 3.5.3

Documentation update

Updated official documentation URL

Upgrade to Vendure to 3.3.2

Update Vendure to 3.1.1

Update compatibility range (#480)

Make primaryCollection custom field channel aware.
Resolve product.breadcrumbs when a product has a primary collection set

Updated Vendure to 2.2.6

Primary collection filter should hide Private collections (#395)

Fixed issue when creating a new product in Vendure (#367)

Updated vendure to 2.1.1

Config option customFieldUITabName added

Renamed admin ui extention NgModule from SharedExtensionModule to PrimaryCollectionSharedExtensionModule
the /src/ui folder will be copied into dist folder when running yarn build

Fix Error: Cannot find module '../types.ts'

Export the service class PrimaryCollectionHelperService which can be used to assign primaryCollections to products without existing value

Products will have a primaryCollection as a custom field which can be selected via Admin UI.

Added index barrel file to export plugin (#261)

Initial setup(#258)

Primary collections can be selected in the Admin UI's product detail view.

Getting started

Add the plugin to your vendure-config.ts:

plugins: [  PrimaryCollectionPlugin.init({    customFieldUITabName: 'Primary Collection',  }),  AdminUiPlugin.init({    port: 3002,    route: 'admin',    app: compileUiExtensions({      outputPath: path.join(__dirname, '__admin-ui'),      extensions: [PrimaryCollectionPlugin.ui],    }),  }),];

And your good to go with just that.

Migrating from `1.6.0` to `2.0.0`

Always create a backup of your database
Install the plugin and generate a migration
In your migration file, add the function exportCurrentPrimaryCollections(queryRunner) to the top and savePrimaryCollection(queryRunner) to the bottom of the up function in your migration file, like so

import { exportCurrentPrimaryCollections, savePrimaryCollection } from "@pinelab/vendure-plugin-primary-collection";   public async up(queryRunner: QueryRunner): Promise<any> {        // add this line        await exportCurrentPrimaryCollections(queryRunner)        await queryRunner.query("ALTER TABLE `product` DROP FOREIGN KEY `FK_5e6c3c845407ccaa497eca1a865`", undefined);        await queryRunner.query("ALTER TABLE `product` CHANGE `customFieldsPrimarycollectionid` `customFieldsPrimarycollection` int NULL", undefined);        await queryRunner.query("ALTER TABLE `product` DROP COLUMN `customFieldsPrimarycollection`", undefined);        await queryRunner.query("ALTER TABLE `product` ADD `customFieldsPrimarycollection` varchar(255) NULL", undefined);        //...and this line        await savePrimaryCollection(queryRunner)   }

Run the migration.

Upgraded to Vendure 3.5.3

Documentation update

Updated official documentation URL

Upgrade to Vendure to 3.3.2

Update Vendure to 3.1.1

Update compatibility range (#480)

Make primaryCollection custom field channel aware.
Resolve product.breadcrumbs when a product has a primary collection set

Updated Vendure to 2.2.6

Primary collection filter should hide Private collections (#395)

Fixed issue when creating a new product in Vendure (#367)

Updated vendure to 2.1.1

Config option customFieldUITabName added

Renamed admin ui extention NgModule from SharedExtensionModule to PrimaryCollectionSharedExtensionModule
the /src/ui folder will be copied into dist folder when running yarn build

Fix Error: Cannot find module '../types.ts'

Export the service class PrimaryCollectionHelperService which can be used to assign primaryCollections to products without existing value

Products will have a primaryCollection as a custom field which can be selected via Admin UI.

Added index barrel file to export plugin (#261)

Initial setup(#258)

Getting started

Migrating from 1.6.0 to 2.0.0

Primary Collection

Getting started

Migrating from 1.6.0 to 2.0.0

Migrating from `1.6.0` to `2.0.0`

Migrating from `1.6.0` to `2.0.0`