Skip to content

feat: improve Frontify queries #64

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

Merged
d-klotz merged 2 commits into from
Dec 11, 2025
Merged

feat: improve Frontify queries #64

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56f7d5a
feat: find nested assets properly
d-klotz Dec 11, 2025
9471cfc
feat: add getAssetWithMetadata and removeAssetCustomMetadata methods
d-klotz Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 100 additions & 7 deletions packages/v1-ready/frontify/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,44 @@ class Api extends OAuth2Requester {
return response.data.asset;
}

/**
* Gets an asset by ID with custom metadata values
* @param {Object} query - Query parameters
* @param {string} query.assetId - ID of the asset
* @returns {Promise<Object>} Asset details with customMetadataValues
*/
async getAssetWithMetadata(query) {
// Query all metadata values - customMetadata returns CustomMetadata interface
// CustomMetadataValue (singular) - for text, url, select, date
// CustomMetadataValues (plural) - for multiselect (uses 'values' array)
const ql = `query AssetWithMetadata {
asset(id: "${query.assetId}") {
id
title
customMetadata {
__typename
... on CustomMetadataValue {
value
property {
id
}
}
... on CustomMetadataValues {
values
property {
id
}
}
}
}
}`;

const response = await this._post(this.buildRequestOptions(ql));
console.log('[getAssetWithMetadata] Raw response:', JSON.stringify(response.data, null, 2));
this.assertResponse(response);
return response.data.asset;
}

/**
* Gets permissions for an asset
* @param {Object} query - Query parameters
Expand Down Expand Up @@ -951,6 +989,51 @@ class Api extends OAuth2Requester {
};
}

/**
* Removes custom metadata values from an asset
* @param {string} assetId - The asset ID
* @param {Array<{propertyId: string, value: any}>} entries - Metadata entries to remove
* @returns {Promise<Object>} Result
*/
async removeAssetCustomMetadata(assetId, entries = []) {
if (!entries.length) return null;

const normalizeValue = (val) => {
if (val === null || val === undefined || val === '') return null;
if (typeof val === 'number') return val;
if (typeof val === 'string') return JSON.stringify(val.trim());
return JSON.stringify(val);
};

const metadataItems = entries
.filter((e) => e && e.propertyId && e.value !== undefined && e.value !== null)
.flatMap((e) => {
if (Array.isArray(e.value)) {
// For multi-select, create separate entries for each value to remove
return e.value
.map((v) => normalizeValue(v))
.filter((v) => v !== null)
.map((v) => `{ propertyId: "${e.propertyId}", value: ${v} }`);
}
const coerced = normalizeValue(e.value);
if (coerced === null) return [];
return `{ propertyId: "${e.propertyId}", value: ${coerced} }`;
})
.join(', ');

if (!metadataItems) return null;

const ql = `mutation RemoveAssetCustomMetadata {\n` +
` removeCustomMetadata(input: { parentIds: ["${assetId}"], customMetadata: [ ${metadataItems} ] }) {\n` +
` __typename\n` +
` }\n` +
`}`;

const response = await this._post(this.buildRequestOptions(ql));
this.assertResponse(response);
return response.data.removeCustomMetadata;
}

/**
* Sets or updates custom metadata values on an asset
* @param {string} assetId - The asset ID
Expand All @@ -968,7 +1051,7 @@ class Api extends OAuth2Requester {
}
return JSON.stringify(val);
};

const metadataItems = entries
.filter((e) => e && e.propertyId && e.value !== undefined && e.value !== null && e.value !== '')
.flatMap((e) => {
Expand All @@ -983,13 +1066,13 @@ class Api extends OAuth2Requester {
return `{ propertyId: "${e.propertyId}", value: ${coerced} }`;
})
.join(', ');

const ql = `mutation AddAssetCustomMetadata {\n` +
` addCustomMetadata(input: { parentIds: ["${assetId}"], customMetadata: [ ${metadataItems} ] }) {\n` +
` __typename\n` +
` }\n` +
`}`;

const response = await this._post(this.buildRequestOptions(ql));
this.assertResponse(response);
return response.data.addCustomMetadata;
Expand Down Expand Up @@ -1125,7 +1208,12 @@ class Api extends OAuth2Requester {
status
externalId
createdAt
modifiedAt
modifiedAt
location {
folder {
id
}
}
tags {
source
value
Expand Down Expand Up @@ -1208,7 +1296,12 @@ class Api extends OAuth2Requester {
status
externalId
createdAt
modifiedAt
modifiedAt
location {
folder {
id
}
}
tags {
source
value
Expand All @@ -1220,10 +1313,10 @@ class Api extends OAuth2Requester {
}
}
}`;

const response = await this._post(this.buildRequestOptions(ql));
this.assertResponse(response);

const {
items,
total,
Expand Down
Loading