Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Parse Metaobjects Utility #1621

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Parse Metaobjects Utility #1621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
81 changes: 81 additions & 0 deletions packages/hydrogen-react/src/parse-metafield.test.ts
View file
Open in desktop
Expand Up @@ -11,6 +11,7 @@ import {TypeEqual, expectType} from 'ts-expect';
import type {
Collection,
GenericFile,
Metaobject,
MoneyV2,
Page,
Product,
Expand Down Expand Up @@ -252,6 +253,86 @@ describe(`parseMetafield`, () => {
expect(parsed?.parsedValue?.value === 2).toBe(true);
expectType<null | Measurement>(parsed?.parsedValue);
});

it(`metaobject_reference`, () => {
const parsed = parseMetafield<ParsedMetafields['metaobject_reference']>({
type: 'metaobject_reference',
reference: {
__typename: 'Metaobject',
fields: [
{
type: 'single_line_text_field',
key: 'title',
value: 'Test Title',
},
{
type: 'boolean',
key: 'enable',
value: 'true',
},
{
type: 'metaobject_reference',
key: 'nested_metaobject_reference',
value: 'gid://shopify/Metaobject/{id}',
reference: {
id: 'gid://shopify/Metaobject/{id}',
fields: [
{
type: 'single_line_text_field',
key: 'title',
value: 'Test Title',
},
{
type: 'boolean',
key: 'enable',
value: 'true',
},
],
},
},
],
},
});

expect(parsed.parsedValue?.__typename === 'Metaobject').toBe(true);
expect(
parsed.parsedValue?.parsedFields?.title.parsedValue === 'Test Title',
).toBe(true);
expect(
parsed.parsedValue?.parsedFields?.enable.parsedValue === true,
).toBe(true);
expectType<null | Metaobject>(parsed?.parsedValue);
});

it(`mixed_reference`, () => {
const parsed = parseMetafield<ParsedMetafields['mixed_reference']>({
type: 'mixed_reference',
reference: {
__typename: 'Metaobject',
fields: [
{
type: 'single_line_text_field',
key: 'title',
value: 'Test Title',
},
{
type: 'boolean',
key: 'enable',
value: 'true',
},
],
},
});

expect(parsed.parsedValue?.__typename === 'Metaobject').toBe(true);
expect(
parsed.parsedValue?.parsedFields?.title.parsedValue === 'Test Title',
).toBe(true);
expect(
parsed.parsedValue?.parsedFields?.enable.parsedValue === true,
).toBe(true);
expectType<null | Metaobject>(parsed?.parsedValue);
});
});

describe(`list metafields`, () => {
Expand Down
43 changes: 42 additions & 1 deletion packages/hydrogen-react/src/parse-metafield.ts
View file
Open in desktop
Expand Up @@ -2,12 +2,13 @@ import type {
Collection,
GenericFile,
Metafield as MetafieldBaseType,
Metaobject as MetaobjectBaseType,
MoneyV2,
Page,
Product,
ProductVariant,
} from './storefront-api-types.js';
import type {PartialDeep, Simplify} from 'type-fest';
import type {PartialDeep, Simplify, ValueOf} from 'type-fest';
import {flattenConnection} from './flatten-connection.js';

/**
Expand Down Expand Up @@ -52,6 +53,31 @@ export function parseMetafield<ReturnGeneric>(
parsedValue: metafield.reference,
} as ReturnGeneric;

case 'mixed_reference':
case 'metaobject_reference': {
let parsedFields: Record<string, ValueOf<ParsedMetafields> | undefined> =
{};
if (metafield.reference && 'fields' in metafield.reference) {
if (metafield.reference?.fields) {
parsedFields = metafield.reference.fields.reduce<
Record<string, ValueOf<ParsedMetafields> | undefined>
>((obj, field) => {
if (field && field.key) {
obj[field.key] = parseMetafield(field as MetafieldBaseType);
}
return obj;
}, {});
}
}
return {
...metafield,
parsedValue: {
...metafield.reference,
parsedFields,
},
} as ReturnGeneric;
}

case 'color':
case 'multi_line_text_field':
case 'single_line_text_field':
Expand Down Expand Up @@ -167,6 +193,8 @@ export const allMetafieldTypesArray = [
'dimension',
'file_reference',
'json',
'metaobject_reference',
'mixed_reference',
'money',
'multi_line_text_field',
'number_decimal',
Expand Down Expand Up @@ -233,6 +261,10 @@ export type ParsedMetafields<ExtraTypeGeneric = void> = {
* ```
*/
json: Simplify<JsonParsedMetafield<ExtraTypeGeneric>>;
/** A Metafield that's been parsed, with a `parsedValue` of a `Metaobject` object (as defined by the Storefront API) */
metaobject_reference: Simplify<MetaobjectParsedRefMetafield>;
/** A Metafield that's been parsed, with a `parsedValue` of a `Metaobject` object (as defined by the Storefront API) */
mixed_reference: Simplify<MetaobjectParsedRefMetafield>;
/** A Metafield that's been parsed, with a `parsedValue` of type `Money` */
money: Simplify<MoneyParsedMetafield>;
/** A Metafield that's been parsed, with a `parsedValue` of type `string` */
Expand Down Expand Up @@ -419,6 +451,15 @@ type VariantListParsedRefMetafield = MetafieldBaseType & {
parsedValue: Array<ProductVariant> | null;
};

type MetaobjectParsedRefMetafield = MetafieldBaseType & {
type: 'metaobject_reference' | 'mixed_reference';
parsedValue:
| (MetaobjectBaseType & {
parsedFields: Record<string, ValueOf<ParsedMetafields>>;
})
| null;
};

export type Measurement = {
unit: string;
value: number;
Expand Down