@cooperco/cooper-component-library 0.1.60 → 0.1.62

package/dist/cms/contentful/graphql/queries/header.query.js

@@ -0,0 +1,39 @@
+import { gql } from 'graphql-tag';
+import { ctaFragment, imageFragment, linkFragment } from './fragments.js';
+export const getHeader = gql `
+	${imageFragment}
+	${ctaFragment}
+	${linkFragment}
+	query headerQuery($id: String!, $preview: Boolean = false) {
+		primaryNavigation(id: $id, preview: $preview) {
+			logo {
+				...imageFragment
+			}
+			navigationElementsCollection {
+				items {
+					title
+					dividerLine
+					link {
+						...linkFragment
+					}
+					subNavigationElementsCollection(limit: 10) {
+						items {
+							title
+							link {
+								...linkFragment
+							}
+						}
+					}
+				}
+			}
+			ctasCollection {
+				items {
+					...ctaFragment
+					logo {
+						...imageFragment
+					}
+				}
+			}
+		}
+	}
+`;

package/dist/cms/contentful/graphql/queries/image.query.d.ts

@@ -0,0 +1,2 @@
+import type { DocumentNode } from 'graphql';
+export declare const getImage: DocumentNode;

package/dist/cms/contentful/graphql/queries/image.query.js

@@ -0,0 +1,10 @@
+import { gql } from 'graphql-tag';
+import { imageFragment } from './fragments.js';
+export const getImage = gql `
+	${imageFragment}
+	query imageQuery($id: String!, $preview: Boolean = false) {
+		image(id: $id, preview: $preview) {
+			...imageFragment
+		}
+	}
+`;

package/dist/cms/contentful/graphql/queries/index.d.ts

@@ -0,0 +1,18 @@
+export * from './fragments.js';
+export * from './accordion.query.js';
+export * from './carousel.query.js';
+export * from './containerModule.query.js';
+export * from './contentModule.query.js';
+export * from './cta.query.js';
+export * from './footer.query.js';
+export * from './header.query.js';
+export * from './image.query.js';
+export * from './link.query.js';
+export * from './logoCollection.query.js';
+export * from './navigation.query.js';
+export * from './page.query.js';
+export * from './pageMetadata.query.js';
+export * from './productModule.query.js';
+export * from './testimonial.query.js';
+export * from './tileCollection.query.js';
+export * from './video.query.js';

package/dist/cms/contentful/graphql/queries/index.js

@@ -0,0 +1,18 @@
+export * from './fragments.js';
+export * from './accordion.query.js';
+export * from './carousel.query.js';
+export * from './containerModule.query.js';
+export * from './contentModule.query.js';
+export * from './cta.query.js';
+export * from './footer.query.js';
+export * from './header.query.js';
+export * from './image.query.js';
+export * from './link.query.js';
+export * from './logoCollection.query.js';
+export * from './navigation.query.js';
+export * from './page.query.js';
+export * from './pageMetadata.query.js';
+export * from './productModule.query.js';
+export * from './testimonial.query.js';
+export * from './tileCollection.query.js';
+export * from './video.query.js';

package/dist/cms/contentful/graphql/queries/link.query.d.ts

@@ -0,0 +1,2 @@
+import type { DocumentNode } from 'graphql';
+export declare const getLink: DocumentNode;

package/dist/cms/contentful/graphql/queries/link.query.js

@@ -0,0 +1,10 @@
+import { gql } from 'graphql-tag';
+import { linkFragment } from './fragments.js';
+export const getLink = gql `
+	${linkFragment}
+	query linkQuery($id: String!, $preview: Boolean = false) {
+		link(id: $id, preview: $preview) {
+			...linkFragment
+		}
+	}
+`;

package/dist/cms/contentful/graphql/queries/logoCollection.query.d.ts

@@ -0,0 +1,2 @@
+import type { DocumentNode } from 'graphql';
+export declare const getLogoCollection: DocumentNode;

package/dist/cms/contentful/graphql/queries/logoCollection.query.js

@@ -0,0 +1,16 @@
+import { gql } from 'graphql-tag';
+import { imageFragment } from './fragments.js';
+export const getLogoCollection = gql `
+	${imageFragment}
+	query logoCollectionQuery($id: String!, $preview: Boolean = false) {
+		logoCollectionModule(id: $id, preview: $preview) {
+			headline
+			backgroundColor
+			logosCollection {
+				items {
+					...imageFragment
+				}
+			}
+		}
+	}
+`;

package/dist/cms/contentful/graphql/queries/navigation.query.d.ts

@@ -0,0 +1,2 @@
+import type { DocumentNode } from 'graphql';
+export declare const getNavigationElement: DocumentNode;

package/dist/cms/contentful/graphql/queries/navigation.query.js

@@ -0,0 +1,10 @@
+import { gql } from 'graphql-tag';
+import { navigationElementFragment } from './fragments.js';
+export const getNavigationElement = gql `
+	${navigationElementFragment}
+	query navigationElementQuery($id: String!, $preview: Boolean = false) {
+		navigationElement(id: $id, preview: $preview) {
+			...navigationElementFragment
+		}
+	}
+`;

package/dist/cms/contentful/graphql/queries/page.query.d.ts

@@ -0,0 +1,2 @@
+import type { DocumentNode } from 'graphql';
+export declare const getPage: DocumentNode;

package/dist/cms/contentful/graphql/queries/page.query.js

@@ -0,0 +1,23 @@
+import { gql } from 'graphql-tag';
+import { metaDataFragment } from './fragments.js';
+export const getPage = gql `
+	${metaDataFragment}
+	query PageQuery($slug: String!, $preview: Boolean = false) {
+		pageCollection(where: { slug: $slug }, limit: 1, preview: $preview) {
+			items {
+				showCart
+				pageModulesCollection(limit: 50) {
+					items {
+						__typename
+						sys {
+							id
+						}
+					}
+				}
+				metadata {
+					...metaDataFragment
+				}
+			}
+		}
+	}
+`;

package/dist/cms/contentful/graphql/queries/pageMetadata.query.d.ts

@@ -0,0 +1,2 @@
+import type { DocumentNode } from 'graphql';
+export declare const getPageMetadata: DocumentNode;

package/dist/cms/contentful/graphql/queries/pageMetadata.query.js

@@ -0,0 +1,16 @@
+import { gql } from 'graphql-tag';
+import { imageFragment } from './fragments.js';
+export const getPageMetadata = gql `
+	${imageFragment}
+	query pageMetadataQuery($id: String!, $preview: Boolean = false) {
+		pageMetadata(id: $id, preview: $preview) {
+			entryName
+			title
+			description
+			keywords
+			socialImage {
+				...imageFragment
+			}
+		}
+	}
+`;

package/dist/cms/contentful/graphql/queries/productModule.query.d.ts

@@ -0,0 +1,2 @@
+import type { DocumentNode } from 'graphql';
+export declare const getProductModule: DocumentNode;

package/dist/cms/contentful/graphql/queries/productModule.query.js

@@ -0,0 +1,59 @@
+// ~/graphql/queries/getProductModule.ts
+import { gql } from 'graphql-tag';
+import { imageFragment } from './fragments.js';
+export const getProductModule = gql `
+	${imageFragment}
+	query GetProductModule($id: String!) {
+		productModuleCollection(where: { sys: { id: $id } }, limit: 1) {
+			items {
+				__typename
+				entryName
+				headerTitle
+				subtitle
+				headerLogo {
+					...imageFragment
+				}
+				tabsCollection {
+					items {
+						sys {
+							id
+						}
+						entryName
+						title
+						productId
+						headerTitle
+						bodyCopy {
+							entryName
+							bodyCopy {
+								json
+							}
+						}
+						cta {
+							title
+							link {
+								externalUrl
+								page {
+									slug
+								}
+							}
+						}
+					}
+				}
+				footerContent {
+					... on ContainerModule {
+						sys {
+							id
+						}
+						__typename
+					}
+					... on LogoCollectionModule {
+						sys {
+							id
+						}
+						__typename
+					}
+				}
+			}
+		}
+	}
+`;

package/dist/cms/contentful/graphql/queries/testimonial.query.d.ts

@@ -0,0 +1,2 @@
+import type { DocumentNode } from 'graphql';
+export declare const getTestimonialModule: DocumentNode;

package/dist/cms/contentful/graphql/queries/testimonial.query.js

@@ -0,0 +1,23 @@
+import { gql } from 'graphql-tag';
+import { imageFragment, videoFragment } from './fragments.js';
+export const getTestimonialModule = gql `
+	${imageFragment}
+	${videoFragment}
+	query TestimonialModuleQuery($id: String!, $preview: Boolean = false) {
+		testimonialModule(id: $id, preview: $preview) {
+			entryName
+			headline
+			quote
+			author
+			details
+			media {
+				... on Image {
+					...imageFragment
+				}
+				... on Video {
+					...videoFragment
+				}
+			}
+		}
+	}
+`;

package/dist/cms/contentful/graphql/queries/tileCollection.query.d.ts

@@ -0,0 +1,4 @@
+import type { DocumentNode } from 'graphql';
+export declare const getTileContent: DocumentNode;
+export declare const getTileLabel: DocumentNode;
+export declare const getTileCollection: DocumentNode;

package/dist/cms/contentful/graphql/queries/tileCollection.query.js

@@ -0,0 +1,35 @@
+import { gql } from 'graphql-tag';
+import { tileContentFragment, tileLabelFragment } from './fragments.js';
+export const getTileContent = gql `
+	${tileContentFragment}
+	query tileContentQuery($id: String!, $preview: Boolean = false) {
+		tileContent(id: $id, preview: $preview) {
+			...tileContentFragment
+		}
+	}
+`;
+export const getTileLabel = gql `
+	${tileLabelFragment}
+	query TileLabelQuery($id: String!, $preview: Boolean = false) {
+		tileLabel(id: $id, preview: $preview) {
+			...tileLabelFragment
+		}
+	}
+`;
+export const getTileCollection = gql `
+	${tileContentFragment}
+	query tileCollectionQuery($id: String!, $preview: Boolean = false) {
+		tileCollectionModule(id: $id, preview: $preview) {
+			headline
+			tilesCollection(limit: 6) {
+				items {
+					...tileContentFragment
+				}
+			}
+			backgroundColor
+			variant
+			tileLabelType
+			includeDecoration
+		}
+	}
+`;

package/dist/cms/contentful/graphql/queries/video.query.d.ts

@@ -0,0 +1,2 @@
+import type { DocumentNode } from 'graphql';
+export declare const getVideo: DocumentNode;

package/dist/cms/contentful/graphql/queries/video.query.js

@@ -0,0 +1,11 @@
+import { gql } from 'graphql-tag';
+import { videoFragment, imageFragment } from './fragments.js';
+export const getVideo = gql `
+	${imageFragment}
+	${videoFragment}
+	query videoQuery($id: String!, $preview: Boolean = false) {
+		video(id: $id, preview: $preview) {
+			...videoFragment
+		}
+	}
+`;

package/dist/cms/contentful/migrations/README.md

@@ -0,0 +1,42 @@
+# Migrations
+
+## Prerequisites
+
+- Run `pnpm install`
+- Obtain a Contentful CMA token
+- Confirm and double check what space and environment you should be running these in
+- Run `pnpm exec contentful-cli-migrations --environment-id <your-env-name> --space-id <space-id> --management-token <CMA-TOKEN> --initialise` on environment if not already and update `.env`
+
+
+## Helpful Docs
+
+- [Contentful Migration](https://github.com/contentful/contentful-migration)
+- [Contentful Migration Reference Docs](https://github.com/contentful/contentful-migration/blob/main/README.md#reference-documentation)
+- [Contentful Data Model](https://www.contentful.com/developers/docs/concepts/data-model/)
+
+### Instructions
+
+- Create your migration file in the scripts folder with the following format: `0002-description.cjs`
+- Write your migrations
+  - This should be with an up and a down function
+  - The up function updates the model
+  - The down function reversts your changes
+- Run your migration on a test environment with the following command: `pnpm exec contentful-cli-migrations --environment-id <your-env-name> --space-id <space-id> --management-token <CMA-TOKEN>`
+  - Optional Flags:
+    - `--rollback`: Rolls back one migration.
+
+### Gotchas
+
+- Currently the rollback may change the version counter even if the migration doesnt run.
+  - for this just update the counter to the correct counter in contentful and rerun.
+- The migration may run and create a content type even if the whole migration doesnt run correctly.
+  - To fix you will need to delete the content type and re-run
+
+### TODO
+
+- Fix rollback versioning
+  - This flag should cause a rollback to that specific version, in this case 0001 `--version 0001`
+  - It should be used with `--rollback`
+  - It should update dthe versionTracker entry on successful rollback
+- Run migration error handling
+  - runMigration is currently not working as expected and bumping the counter when the migration was aborted

package/dist/cms/contentful/migrations/helpers/addEntryNameField.cjs

@@ -0,0 +1,9 @@
+const addEntryNameField = (contentType) => {
+	contentType.createField('entryName', {
+		type: 'Symbol',
+		name: 'Entry Name',
+		required: true,
+	})
+}
+
+module.exports = addEntryNameField

package/dist/cms/contentful/migrations/scripts/0001-init.cjs

@@ -0,0 +1,41 @@
+module.exports = {
+	up: async function (migration) {
+		const versionTrackingContentType = migration.createContentType(
+			'migrationVersionTracker',
+			{
+				name: 'Migration Version Tracker',
+				displayField: 'entryName',
+			}
+		)
+
+		versionTrackingContentType
+			.createField('entryName')
+			.name('Entry Name')
+			.type('Symbol')
+			.localized(false)
+			.required(true)
+			.validations([
+				{
+					unique: true,
+				},
+			])
+			.disabled(false)
+			.omitted(false)
+
+		versionTrackingContentType
+			.createField('version')
+			.name('Version')
+			.type('Integer')
+			.required(true)
+			.validations([])
+			.disabled(true)
+			.omitted(false)
+
+		versionTrackingContentType.changeFieldControl(
+			'version',
+			'builtin',
+			'numberEditor',
+			{}
+		)
+	},
+}

package/dist/cms/contentful/migrations/scripts/0002-create-image.cjs

@@ -0,0 +1,34 @@
+const addEntryNameField = require('../helpers/addEntryNameField.cjs')
+
+module.exports = {
+	// @ts-check
+	/** @type { import('contentful-migration').MigrationFunction } */
+	up: async function (migration) {
+		const image = migration.createContentType('image', {
+			name: 'Image',
+			displayField: 'entryName',
+			description: 'Manage an image asset',
+		})
+
+		// Add required entryName field
+		addEntryNameField(image)
+
+		// Add required image asset field
+		image
+			.createField('media')
+			.name('Media')
+			.type('Link')
+			.linkType('Asset')
+			.required(true)
+			.validations([
+				{
+					linkMimetypeGroup: ['image'],
+				},
+			])
+
+		image.createField('altTag').name('Alt Tag').type('Symbol').required(false)
+	},
+	down: async function (migration) {
+		await migration.deleteContentType('image')
+	},
+}

package/dist/cms/contentful/migrations/scripts/0003-create-video.cjs

@@ -0,0 +1,52 @@
+const addEntryNameField = require('../helpers/addEntryNameField.cjs')
+
+module.exports = {
+	// @ts-check
+	/** @type { import('contentful-migration').MigrationFunction } */
+	up: async function (migration) {
+		const video = migration.createContentType('video', {
+			name: 'Video',
+			displayField: 'entryName',
+			description: 'Manage a video asset',
+		})
+
+		// Add required assetName field
+		addEntryNameField(video)
+
+		// Add required url field
+		video
+			.createField('url')
+			.name('Url')
+			.type('Symbol')
+			.required(true)
+			.validations([
+				{
+					regexp: {
+						pattern:
+							'^(ftp|http|https):\\/\\/(\\w+:{0,1}\\w*@)?(\\S+)(:[0-9]+)?(\\/|\\/([\\w#!:.?+=&%@!\\-/]))?$',
+						flags: null,
+					},
+				},
+			])
+
+		// add help text to 'url' field
+		video.changeFieldControl('url', 'builtin', 'urlEditor', {
+			helpText: 'The URL of the video',
+		})
+
+		video
+			.createField('thumbnail')
+			.name('Thumbnail')
+			.type('Link')
+			.linkType('Entry')
+			.validations([
+				{
+					linkContentType: ['image'],
+				},
+			])
+			.required(true)
+	},
+	down: async function (migration) {
+		await migration.deleteContentType('video')
+	},
+}

package/dist/cms/contentful/migrations/scripts/0004-create-testimonial.cjs

@@ -0,0 +1,56 @@
+const addEntryNameField = require('../helpers/addEntryNameField.cjs')
+
+module.exports = {
+	// @ts-check
+	/** @type { import('contentful-migration').MigrationFunction } */
+	up: async function (migration) {
+		const testimonialModule = migration.createContentType('testimonialModule', {
+			name: 'Testimonial Module',
+			displayField: 'entryName',
+			description: 'Testimonial module with text and media',
+		})
+
+		// Add mandatory assetName field
+		addEntryNameField(testimonialModule)
+
+		// Add headline field
+		testimonialModule
+			.createField('headline')
+			.name('Headline')
+			.type('Symbol')
+			.required(false)
+
+		testimonialModule
+			.createField('media')
+			.name('Media')
+			.type('Link')
+			.linkType('Entry')
+			.validations([
+				{
+					linkContentType: ['image', 'video'],
+				},
+			])
+			.required(false)
+
+		testimonialModule
+			.createField('quote')
+			.name('Quote')
+			.type('Symbol')
+			.required(true)
+
+		testimonialModule
+			.createField('author')
+			.name('Author')
+			.type('Symbol')
+			.required(false)
+
+		testimonialModule
+			.createField('details')
+			.name('Details')
+			.type('Text')
+			.required(false)
+	},
+	down: async function (migration) {
+		await migration.deleteContentType('testimonialModule')
+	},
+}

package/dist/cms/contentful/migrations/scripts/0005-create-tile-label.cjs

@@ -0,0 +1,41 @@
+const addEntryNameField = require('../helpers/addEntryNameField.cjs')
+
+module.exports = {
+	// @ts-check
+	/** @type { import('contentful-migration').MigrationFunction } */
+	up: async function (migration) {
+		const tileLabel = migration.createContentType('tileLabel', {
+			name: 'Tile Label',
+			displayField: 'entryName',
+			description: 'Label for tiles',
+		})
+
+		// Add mandatory assetName field
+		addEntryNameField(tileLabel)
+
+		// Add mandatory copy field
+		tileLabel.createField('copy').name('Copy').type('Symbol').required(false)
+
+		tileLabel
+			.createField('color')
+			.name('Color')
+			.type('Symbol')
+			.validations([
+				{
+					in: ['Primary', 'Secondary', 'Tertiary'],
+				},
+			])
+			.defaultValue({
+				'en-US': 'Primary',
+			})
+			.required(true)
+
+		tileLabel.changeFieldControl('color', 'builtin', 'dropdown', {
+			helpText:
+				'These colors are determined by the background color of the tile, based on the design system.',
+		})
+	},
+	down: async function (migration) {
+		await migration.deleteContentType('tileLabel')
+	},
+}