@contentstack/delivery-sdk 5.0.0 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/legacy/assets/asset.cjs +20 -0
- package/dist/legacy/assets/asset.cjs.map +1 -1
- package/dist/legacy/assets/asset.js +20 -0
- package/dist/legacy/assets/asset.js.map +1 -1
- package/dist/legacy/entries/entries.cjs +20 -0
- package/dist/legacy/entries/entries.cjs.map +1 -1
- package/dist/legacy/entries/entries.js +20 -0
- package/dist/legacy/entries/entries.js.map +1 -1
- package/dist/legacy/entries/entry.cjs +20 -0
- package/dist/legacy/entries/entry.cjs.map +1 -1
- package/dist/legacy/entries/entry.js +20 -0
- package/dist/legacy/entries/entry.js.map +1 -1
- package/dist/legacy/query/asset-query.cjs +20 -0
- package/dist/legacy/query/asset-query.cjs.map +1 -1
- package/dist/legacy/query/asset-query.js +20 -0
- package/dist/legacy/query/asset-query.js.map +1 -1
- package/dist/legacy/query/query.cjs +2 -2
- package/dist/legacy/query/query.cjs.map +1 -1
- package/dist/legacy/query/query.js +2 -2
- package/dist/legacy/query/query.js.map +1 -1
- package/dist/modern/assets/asset.cjs +20 -0
- package/dist/modern/assets/asset.cjs.map +1 -1
- package/dist/modern/assets/asset.d.ts +16 -1
- package/dist/modern/assets/asset.d.ts.map +1 -1
- package/dist/modern/assets/asset.js +20 -0
- package/dist/modern/assets/asset.js.map +1 -1
- package/dist/modern/entries/entries.cjs +20 -0
- package/dist/modern/entries/entries.cjs.map +1 -1
- package/dist/modern/entries/entries.d.ts +15 -0
- package/dist/modern/entries/entries.d.ts.map +1 -1
- package/dist/modern/entries/entries.js +20 -0
- package/dist/modern/entries/entries.js.map +1 -1
- package/dist/modern/entries/entry.cjs +20 -0
- package/dist/modern/entries/entry.cjs.map +1 -1
- package/dist/modern/entries/entry.d.ts +15 -0
- package/dist/modern/entries/entry.d.ts.map +1 -1
- package/dist/modern/entries/entry.js +20 -0
- package/dist/modern/entries/entry.js.map +1 -1
- package/dist/modern/query/asset-query.cjs +20 -0
- package/dist/modern/query/asset-query.cjs.map +1 -1
- package/dist/modern/query/asset-query.d.ts +15 -0
- package/dist/modern/query/asset-query.d.ts.map +1 -1
- package/dist/modern/query/asset-query.js +20 -0
- package/dist/modern/query/asset-query.js.map +1 -1
- package/dist/modern/query/query.cjs +2 -2
- package/dist/modern/query/query.cjs.map +1 -1
- package/dist/modern/query/query.d.ts.map +1 -1
- package/dist/modern/query/query.js +2 -2
- package/dist/modern/query/query.js.map +1 -1
- package/package.json +1 -1
|
@@ -118,6 +118,26 @@ class Asset {
|
|
|
118
118
|
this._queryParams.locale = locale;
|
|
119
119
|
return this;
|
|
120
120
|
}
|
|
121
|
+
/**
|
|
122
|
+
* @method assetFields
|
|
123
|
+
* @memberof Asset
|
|
124
|
+
* @description Include specific asset fields in the response (CDA getAssets - single asset).
|
|
125
|
+
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
|
|
126
|
+
* @example
|
|
127
|
+
* import contentstack from '@contentstack/delivery-sdk'
|
|
128
|
+
*
|
|
129
|
+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
130
|
+
* const result = await stack.asset("assetUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
|
|
131
|
+
*
|
|
132
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
|
|
133
|
+
* @returns {Asset} - Returns the Asset instance for chaining.
|
|
134
|
+
*/
|
|
135
|
+
assetFields(...fields) {
|
|
136
|
+
if (fields.length > 0) {
|
|
137
|
+
this._queryParams["asset_fields[]"] = fields;
|
|
138
|
+
}
|
|
139
|
+
return this;
|
|
140
|
+
}
|
|
121
141
|
/**
|
|
122
142
|
* @method fetch
|
|
123
143
|
* @memberof Asset
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"asset.cjs","sources":["../../../src/assets/asset.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\n\nexport class Asset {\n private _client: AxiosInstance;\n private _urlPath: string;\n _queryParams: { [key: string]: string | number } = {};\n\n constructor(client: AxiosInstance, assetUid: string) {\n this._client = client;\n this._urlPath = `/assets/${assetUid}`;\n }\n\n /**\n * @method includeFallback\n * @memberof Asset\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeFallback().fetch();\n */\n includeFallback(): Asset {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Asset\n * @description Include the metadata for getting metadata content for the asset.\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeMetadata().fetch();\n */\n includeMetadata(): Asset {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeDimension\n * @memberof Asset\n * @description Includes the dimensions (height and width) of the image in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeDimension().fetch();\n */\n includeDimension(): Asset {\n this._queryParams.include_dimension = 'true';\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Asset\n * @description Includes the branch in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeBranch().fetch();\n */\n includeBranch(): Asset {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method relativeUrls\n * @memberof Asset\n * @description Includes the relative URLs of the asset in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').relativeUrls().fetch();\n */\n relativeUrls(): Asset {\n this._queryParams.relative_urls = 'true';\n\n return this;\n }\n\n /**\n * @method version\n * @memberof Asset\n * @description Retrieve a specific version of an asset in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').version(1).fetch();\n */\n version(version: number): Asset {\n this._queryParams.version = String(version);\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Asset\n * @description The asset published in the locale will be fetched\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').locale('en-us').fetch();\n */\n locale(locale: string): Asset {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method fetch\n * @memberof Asset\n * @description Fetches the asset data on the basis of the asset uid\n * @returns {Promise<T>} Promise that resolves to the asset data\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').fetch();\n */\n async fetch<T>(): Promise<T> {\n const response = await getData(this._client, this._urlPath, { params: this._queryParams});\n\n if (response.asset) return response.asset as T;\n\n return response;\n }\n}\n"],"names":["getData"],"mappings":";;;;;;;AAEO,MAAM,KAAM,CAAA;AAAA,EAKjB,WAAA,CAAY,QAAuB,QAAkB,EAAA;AAJrD,IAAQ,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AACR,IAAA,aAAA,CAAA,IAAA,EAAA,cAAA,
|
|
1
|
+
{"version":3,"file":"asset.cjs","sources":["../../../src/assets/asset.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\n\nexport class Asset {\n private _client: AxiosInstance;\n private _urlPath: string;\n _queryParams: { [key: string]: string | number | string[] } = {};\n\n constructor(client: AxiosInstance, assetUid: string) {\n this._client = client;\n this._urlPath = `/assets/${assetUid}`;\n }\n\n /**\n * @method includeFallback\n * @memberof Asset\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeFallback().fetch();\n */\n includeFallback(): Asset {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Asset\n * @description Include the metadata for getting metadata content for the asset.\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeMetadata().fetch();\n */\n includeMetadata(): Asset {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeDimension\n * @memberof Asset\n * @description Includes the dimensions (height and width) of the image in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeDimension().fetch();\n */\n includeDimension(): Asset {\n this._queryParams.include_dimension = 'true';\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Asset\n * @description Includes the branch in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeBranch().fetch();\n */\n includeBranch(): Asset {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method relativeUrls\n * @memberof Asset\n * @description Includes the relative URLs of the asset in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').relativeUrls().fetch();\n */\n relativeUrls(): Asset {\n this._queryParams.relative_urls = 'true';\n\n return this;\n }\n\n /**\n * @method version\n * @memberof Asset\n * @description Retrieve a specific version of an asset in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').version(1).fetch();\n */\n version(version: number): Asset {\n this._queryParams.version = String(version);\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Asset\n * @description The asset published in the locale will be fetched\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').locale('en-us').fetch();\n */\n locale(locale: string): Asset {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method assetFields\n * @memberof Asset\n * @description Include specific asset fields in the response (CDA getAssets - single asset).\n * Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset(\"assetUid\").assetFields(\"user_defined_fields\", \"embedded_metadata\").fetch();\n *\n * @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)\n * @returns {Asset} - Returns the Asset instance for chaining.\n */\n assetFields(...fields: string[]): this {\n if (fields.length > 0) {\n this._queryParams['asset_fields[]'] = fields;\n }\n return this;\n }\n\n /**\n * @method fetch\n * @memberof Asset\n * @description Fetches the asset data on the basis of the asset uid\n * @returns {Promise<T>} Promise that resolves to the asset data\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').fetch();\n */\n async fetch<T>(): Promise<T> {\n const response = await getData(this._client, this._urlPath, { params: this._queryParams});\n\n if (response.asset) return response.asset as T;\n\n return response;\n }\n}\n"],"names":["getData"],"mappings":";;;;;;;AAEO,MAAM,KAAM,CAAA;AAAA,EAKjB,WAAA,CAAY,QAAuB,QAAkB,EAAA;AAJrD,IAAQ,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AACR,IAAA,aAAA,CAAA,IAAA,EAAA,cAAA,EAA8D,EAAC,CAAA,CAAA;AAG7D,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAK,IAAA,CAAA,QAAA,GAAW,WAAW,QAAQ,CAAA,CAAA,CAAA;AAAA,GACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,gBAA0B,GAAA;AACxB,IAAA,IAAA,CAAK,aAAa,iBAAoB,GAAA,MAAA,CAAA;AAEtC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAuB,GAAA;AACrB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,YAAsB,GAAA;AACpB,IAAA,IAAA,CAAK,aAAa,aAAgB,GAAA,MAAA,CAAA;AAElC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,QAAQ,OAAwB,EAAA;AAC9B,IAAK,IAAA,CAAA,YAAA,CAAa,OAAU,GAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAE1C,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,OAAO,MAAuB,EAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,MAAS,GAAA,MAAA,CAAA;AAE3B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,eAAe,MAAwB,EAAA;AACrC,IAAI,IAAA,MAAA,CAAO,SAAS,CAAG,EAAA;AACrB,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,MAAA,CAAA;AAAA,KACxC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,KAAuB,GAAA;AAC3B,IAAM,MAAA,QAAA,GAAW,MAAMA,YAAA,CAAQ,IAAK,CAAA,OAAA,EAAS,IAAK,CAAA,QAAA,EAAU,EAAE,MAAA,EAAQ,IAAK,CAAA,YAAA,EAAa,CAAA,CAAA;AAExF,IAAI,IAAA,QAAA,CAAS,KAAO,EAAA,OAAO,QAAS,CAAA,KAAA,CAAA;AAEpC,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
|
@@ -116,6 +116,26 @@ class Asset {
|
|
|
116
116
|
this._queryParams.locale = locale;
|
|
117
117
|
return this;
|
|
118
118
|
}
|
|
119
|
+
/**
|
|
120
|
+
* @method assetFields
|
|
121
|
+
* @memberof Asset
|
|
122
|
+
* @description Include specific asset fields in the response (CDA getAssets - single asset).
|
|
123
|
+
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
|
|
124
|
+
* @example
|
|
125
|
+
* import contentstack from '@contentstack/delivery-sdk'
|
|
126
|
+
*
|
|
127
|
+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
128
|
+
* const result = await stack.asset("assetUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
|
|
129
|
+
*
|
|
130
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
|
|
131
|
+
* @returns {Asset} - Returns the Asset instance for chaining.
|
|
132
|
+
*/
|
|
133
|
+
assetFields(...fields) {
|
|
134
|
+
if (fields.length > 0) {
|
|
135
|
+
this._queryParams["asset_fields[]"] = fields;
|
|
136
|
+
}
|
|
137
|
+
return this;
|
|
138
|
+
}
|
|
119
139
|
/**
|
|
120
140
|
* @method fetch
|
|
121
141
|
* @memberof Asset
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"asset.js","sources":["../../../src/assets/asset.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\n\nexport class Asset {\n private _client: AxiosInstance;\n private _urlPath: string;\n _queryParams: { [key: string]: string | number } = {};\n\n constructor(client: AxiosInstance, assetUid: string) {\n this._client = client;\n this._urlPath = `/assets/${assetUid}`;\n }\n\n /**\n * @method includeFallback\n * @memberof Asset\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeFallback().fetch();\n */\n includeFallback(): Asset {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Asset\n * @description Include the metadata for getting metadata content for the asset.\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeMetadata().fetch();\n */\n includeMetadata(): Asset {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeDimension\n * @memberof Asset\n * @description Includes the dimensions (height and width) of the image in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeDimension().fetch();\n */\n includeDimension(): Asset {\n this._queryParams.include_dimension = 'true';\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Asset\n * @description Includes the branch in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeBranch().fetch();\n */\n includeBranch(): Asset {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method relativeUrls\n * @memberof Asset\n * @description Includes the relative URLs of the asset in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').relativeUrls().fetch();\n */\n relativeUrls(): Asset {\n this._queryParams.relative_urls = 'true';\n\n return this;\n }\n\n /**\n * @method version\n * @memberof Asset\n * @description Retrieve a specific version of an asset in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').version(1).fetch();\n */\n version(version: number): Asset {\n this._queryParams.version = String(version);\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Asset\n * @description The asset published in the locale will be fetched\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').locale('en-us').fetch();\n */\n locale(locale: string): Asset {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method fetch\n * @memberof Asset\n * @description Fetches the asset data on the basis of the asset uid\n * @returns {Promise<T>} Promise that resolves to the asset data\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').fetch();\n */\n async fetch<T>(): Promise<T> {\n const response = await getData(this._client, this._urlPath, { params: this._queryParams});\n\n if (response.asset) return response.asset as T;\n\n return response;\n }\n}\n"],"names":[],"mappings":";;;;;AAEO,MAAM,KAAM,CAAA;AAAA,EAKjB,WAAA,CAAY,QAAuB,QAAkB,EAAA;AAJrD,IAAQ,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AACR,IAAA,aAAA,CAAA,IAAA,EAAA,cAAA,
|
|
1
|
+
{"version":3,"file":"asset.js","sources":["../../../src/assets/asset.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\n\nexport class Asset {\n private _client: AxiosInstance;\n private _urlPath: string;\n _queryParams: { [key: string]: string | number | string[] } = {};\n\n constructor(client: AxiosInstance, assetUid: string) {\n this._client = client;\n this._urlPath = `/assets/${assetUid}`;\n }\n\n /**\n * @method includeFallback\n * @memberof Asset\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeFallback().fetch();\n */\n includeFallback(): Asset {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Asset\n * @description Include the metadata for getting metadata content for the asset.\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeMetadata().fetch();\n */\n includeMetadata(): Asset {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeDimension\n * @memberof Asset\n * @description Includes the dimensions (height and width) of the image in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeDimension().fetch();\n */\n includeDimension(): Asset {\n this._queryParams.include_dimension = 'true';\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Asset\n * @description Includes the branch in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').includeBranch().fetch();\n */\n includeBranch(): Asset {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method relativeUrls\n * @memberof Asset\n * @description Includes the relative URLs of the asset in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').relativeUrls().fetch();\n */\n relativeUrls(): Asset {\n this._queryParams.relative_urls = 'true';\n\n return this;\n }\n\n /**\n * @method version\n * @memberof Asset\n * @description Retrieve a specific version of an asset in result\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').version(1).fetch();\n */\n version(version: number): Asset {\n this._queryParams.version = String(version);\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Asset\n * @description The asset published in the locale will be fetched\n * @returns {Asset}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').locale('en-us').fetch();\n */\n locale(locale: string): Asset {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method assetFields\n * @memberof Asset\n * @description Include specific asset fields in the response (CDA getAssets - single asset).\n * Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset(\"assetUid\").assetFields(\"user_defined_fields\", \"embedded_metadata\").fetch();\n *\n * @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)\n * @returns {Asset} - Returns the Asset instance for chaining.\n */\n assetFields(...fields: string[]): this {\n if (fields.length > 0) {\n this._queryParams['asset_fields[]'] = fields;\n }\n return this;\n }\n\n /**\n * @method fetch\n * @memberof Asset\n * @description Fetches the asset data on the basis of the asset uid\n * @returns {Promise<T>} Promise that resolves to the asset data\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.asset('asset_uid').fetch();\n */\n async fetch<T>(): Promise<T> {\n const response = await getData(this._client, this._urlPath, { params: this._queryParams});\n\n if (response.asset) return response.asset as T;\n\n return response;\n }\n}\n"],"names":[],"mappings":";;;;;AAEO,MAAM,KAAM,CAAA;AAAA,EAKjB,WAAA,CAAY,QAAuB,QAAkB,EAAA;AAJrD,IAAQ,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AACR,IAAA,aAAA,CAAA,IAAA,EAAA,cAAA,EAA8D,EAAC,CAAA,CAAA;AAG7D,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAK,IAAA,CAAA,QAAA,GAAW,WAAW,QAAQ,CAAA,CAAA,CAAA;AAAA,GACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,gBAA0B,GAAA;AACxB,IAAA,IAAA,CAAK,aAAa,iBAAoB,GAAA,MAAA,CAAA;AAEtC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAuB,GAAA;AACrB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,YAAsB,GAAA;AACpB,IAAA,IAAA,CAAK,aAAa,aAAgB,GAAA,MAAA,CAAA;AAElC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,QAAQ,OAAwB,EAAA;AAC9B,IAAK,IAAA,CAAA,YAAA,CAAa,OAAU,GAAA,MAAA,CAAO,OAAO,CAAA,CAAA;AAE1C,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,OAAO,MAAuB,EAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,MAAS,GAAA,MAAA,CAAA;AAE3B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,eAAe,MAAwB,EAAA;AACrC,IAAI,IAAA,MAAA,CAAO,SAAS,CAAG,EAAA;AACrB,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,MAAA,CAAA;AAAA,KACxC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,KAAuB,GAAA;AAC3B,IAAM,MAAA,QAAA,GAAW,MAAM,OAAA,CAAQ,IAAK,CAAA,OAAA,EAAS,IAAK,CAAA,QAAA,EAAU,EAAE,MAAA,EAAQ,IAAK,CAAA,YAAA,EAAa,CAAA,CAAA;AAExF,IAAI,IAAA,QAAA,CAAS,KAAO,EAAA,OAAO,QAAS,CAAA,KAAA,CAAA;AAEpC,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
|
@@ -256,6 +256,26 @@ class Entries extends baseQuery.BaseQuery {
|
|
|
256
256
|
}
|
|
257
257
|
return this;
|
|
258
258
|
}
|
|
259
|
+
/**
|
|
260
|
+
* @method assetFields
|
|
261
|
+
* @memberof Entries
|
|
262
|
+
* @description Include specific asset fields in the response (CDA getEntry/entries).
|
|
263
|
+
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
|
|
264
|
+
* @example
|
|
265
|
+
* import contentstack from '@contentstack/delivery-sdk'
|
|
266
|
+
*
|
|
267
|
+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
268
|
+
* const result = await stack.contentType("contentTypeUid").entry().assetFields("user_defined_fields", "embedded_metadata").find();
|
|
269
|
+
*
|
|
270
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
|
|
271
|
+
* @returns {Entries} - Returns the Entries instance for chaining.
|
|
272
|
+
*/
|
|
273
|
+
assetFields(...fields) {
|
|
274
|
+
if (fields.length > 0) {
|
|
275
|
+
this._queryParams["asset_fields[]"] = fields;
|
|
276
|
+
}
|
|
277
|
+
return this;
|
|
278
|
+
}
|
|
259
279
|
/**
|
|
260
280
|
* Override find method to include content type UID directly for better caching
|
|
261
281
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entries.cjs","sources":["../../../src/entries/entries.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\nimport { Query } from '../query';\nimport { BaseQuery } from '../query';\nimport { FindResponse } from '../common/types';\nimport { encodeQueryParams } from '../common/utils';\nimport { ErrorMessages } from '../common/error-messages';\n\nexport class Entries extends BaseQuery {\n private _contentTypeUid: string;\n\n constructor(client: AxiosInstance, contentTypeUid: string) {\n super();\n this._client = client;\n this._contentTypeUid = contentTypeUid;\n this._urlPath = `/content_types/${this._contentTypeUid}/entries`;\n this._variants = '';\n }\n\n /**\n * @method except\n * @memberof Entries\n * @description Excludes specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().except(\"fieldUID\").find()\n *\n * @param {string} fieldUid - field uid to exclude\n * @returns {Entries} - returns Entries object for chaining method calls\n */\n except(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`except[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"except[BASE][]\"] = fieldUid;\n }\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Entries\n * @description Includes the branch in result\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeBranch().find();\n */\n includeBranch(): Entries {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method includeContentType\n * @memberof Entries\n * @description Include the details of the content type along with the entries details\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeContentType().find();\n */\n includeContentType(): Entries {\n this._queryParams.include_content_type = 'true';\n\n return this;\n }\n\n /**\n * @method includeEmbeddedItems\n * @memberof Entries\n * @description Include Embedded Objects (Entries and Assets) along with entry/entries details.\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeEmbeddedItems().find();\n */\n includeEmbeddedItems(): Entries {\n this._queryParams['include_embedded_items[]'] = 'BASE';\n\n return this;\n }\n\n /**\n * @method includeFallback\n * @memberof Entries\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeFallback().find();\n */\n includeFallback(): Entries {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Entries\n * @description Include the metadata for getting metadata content for the entry.\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeMetadata().find();\n */\n includeMetadata(): Entries {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeReference\n * @memberof Entries\n * @description To include the content of the referred entries in your response,\n * you need to use the include[] parameter and specify the UID of the reference field as value.\n * This function sets the include parameter to a reference field UID in the API request.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeReference(\"brand\")\n * const result = await entries.find()\n *\n * @param {string} referenceFieldUid - UID of the reference field to include.\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeReference(...referenceFieldUid: (string | string[])[]): Entries {\n if (referenceFieldUid.length) {\n referenceFieldUid.forEach(value => {\n if (!Array.isArray(this._queryParams['include[]'])) {\n this._queryParams['include[]'] = [];\n }\n (this._queryParams['include[]'] as string[]).push(...(Array.isArray(value) ? value : [value]));\n });\n } else {\n console.error(ErrorMessages.INVALID_ARGUMENT_STRING_OR_ARRAY);\n }\n return this;\n }\n\n /**\n * @method includeReferenceContentTypeUID\n * @memberof Entries\n * @description This method also includes the content type UIDs of the referenced entries returned in the response.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeReferenceContentTypeUID()\n * const result = await entries.find()\n *\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeReferenceContentTypeUID(): Entries {\n this._queryParams.include_reference_content_type_uid = 'true';\n\n return this;\n }\n\n /**\n * @method includeSchema\n * @memberof Entries\n * @description Includes the schema of the content type along with the entries details.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeSchema()\n * const result = await entries.find()\n *\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeSchema(): Entries {\n this._queryParams.include_schema = 'true';\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Entries\n * @description The entries published in the locale will be fetched\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().locale('en-us').find();\n */\n locale(locale: string): Entries {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method only\n * @memberof Entries\n * @description Selects specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().only(\"fieldUID\").find()\n *\n * @param {string} fieldUid - field uid to select\n * @returns {Entries} - returns Entries object for chaining method calls\n */\n only(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`only[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"only[BASE][]\"] = fieldUid;\n }\n return this;\n }\n\n /**\n * @method query\n * @memberof Entries\n * @description Creates a query object for filtering entries\n * @param {object} queryObj - Optional query object to initialize the query\n * @returns {Query} Query instance for chaining query methods\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const query = stack.contentType(\"contentTypeUid\").entry().query();\n */\n query(queryObj?: { [key: string]: any }) {\n if (queryObj) return new Query(this._client, this._parameters, this._queryParams, this._variants, this._contentTypeUid, queryObj);\n\n return new Query(this._client, this._parameters, this._queryParams, this._variants, this._contentTypeUid);\n }\n\n /**\n * @method variants\n * @memberof Entries\n * @description The variant header will be added to axios client\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('abc').entry().variants('xyz').find();\n */\n variants(variants: string | string[]): Entries {\n if (Array.isArray(variants) && variants.length > 0) {\n this._variants = variants.join(',');\n } else if (typeof variants == 'string' && variants.length > 0) {\n this._variants = variants;\n }\n return this;\n }\n\n /**\n * Override find method to include content type UID directly for better caching\n */\n override async find<T>(encode: boolean = false): Promise<FindResponse<T>> {\n let requestParams: { [key: string]: any } = this._queryParams;\n\n if (Object.keys(this._parameters).length > 0) {\n let queryParams = { ...this._parameters };\n \n if (encode) {\n queryParams = encodeQueryParams(queryParams);\n }\n \n requestParams = { ...this._queryParams, query: queryParams };\n }\n\n const getRequestOptions: any = { \n params: requestParams,\n // Add contentTypeUid directly for improved caching\n contentTypeUid: this._contentTypeUid\n };\n\n if (this._variants) {\n getRequestOptions.headers = {\n ...getRequestOptions.headers,\n 'x-cs-variant-uid': this._variants\n };\n }\n const response = await getData(this._client, this._urlPath, getRequestOptions);\n\n return response as FindResponse<T>;\n }\n}\n"],"names":["BaseQuery","ErrorMessages","Query","encodeQueryParams","getData"],"mappings":";;;;;;;;;;;AAOO,MAAM,gBAAgBA,mBAAU,CAAA;AAAA,EAGrC,WAAA,CAAY,QAAuB,cAAwB,EAAA;AACzD,IAAM,KAAA,EAAA,CAAA;AAHR,IAAQ,aAAA,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AAIN,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,cAAA,CAAA;AACvB,IAAK,IAAA,CAAA,QAAA,GAAW,CAAkB,eAAA,EAAA,IAAA,CAAK,eAAe,CAAA,QAAA,CAAA,CAAA;AACtD,IAAA,IAAA,CAAK,SAAY,GAAA,EAAA,CAAA;AAAA,GACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,QAAiC,EAAA;AACtC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,aAAA,EAAgB,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AAC1C,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,QAAA,CAAA;AAAA,KACxC;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,kBAA8B,GAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,oBAAuB,GAAA,MAAA,CAAA;AAEzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,oBAAgC,GAAA;AAC9B,IAAK,IAAA,CAAA,YAAA,CAAa,0BAA0B,CAAI,GAAA,MAAA,CAAA;AAEhD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,oBAAoB,iBAAmD,EAAA;AACrE,IAAA,IAAI,kBAAkB,MAAQ,EAAA;AAC5B,MAAA,iBAAA,CAAkB,QAAQ,CAAS,KAAA,KAAA;AACjC,QAAA,IAAI,CAAC,KAAM,CAAA,OAAA,CAAQ,KAAK,YAAa,CAAA,WAAW,CAAC,CAAG,EAAA;AAClD,UAAK,IAAA,CAAA,YAAA,CAAa,WAAW,CAAA,GAAI,EAAC,CAAA;AAAA,SACpC;AACA,QAAC,IAAK,CAAA,YAAA,CAAa,WAAW,CAAA,CAAe,IAAK,CAAA,GAAI,KAAM,CAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAQ,GAAA,CAAC,KAAK,CAAE,CAAA,CAAA;AAAA,OAC9F,CAAA,CAAA;AAAA,KACI,MAAA;AACL,MAAQ,OAAA,CAAA,KAAA,CAAMC,4BAAc,gCAAgC,CAAA,CAAA;AAAA,KAC9D;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,8BAA0C,GAAA;AACxC,IAAA,IAAA,CAAK,aAAa,kCAAqC,GAAA,MAAA,CAAA;AAEvD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,aAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,OAAO,MAAyB,EAAA;AAC9B,IAAA,IAAA,CAAK,aAAa,MAAS,GAAA,MAAA,CAAA;AAE3B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,KAAK,QAAiC,EAAA;AACpC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,WAAA,EAAc,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AACxC,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,cAAc,CAAI,GAAA,QAAA,CAAA;AAAA,KACtC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,QAAmC,EAAA;AACvC,IAAA,IAAI,QAAU,EAAA,OAAO,IAAIC,WAAA,CAAM,KAAK,OAAS,EAAA,IAAA,CAAK,WAAa,EAAA,IAAA,CAAK,YAAc,EAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,iBAAiB,QAAQ,CAAA,CAAA;AAEhI,IAAO,OAAA,IAAIA,WAAM,CAAA,IAAA,CAAK,OAAS,EAAA,IAAA,CAAK,WAAa,EAAA,IAAA,CAAK,YAAc,EAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,eAAe,CAAA,CAAA;AAAA,GAC1G;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,SAAS,QAAsC,EAAA;AAC7C,IAAA,IAAI,MAAM,OAAQ,CAAA,QAAQ,CAAK,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAClD,MAAK,IAAA,CAAA,SAAA,GAAY,QAAS,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,eACzB,OAAO,QAAA,IAAY,QAAY,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAC7D,MAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AAAA,KACnB;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAe,IAAQ,CAAA,MAAA,GAAkB,KAAiC,EAAA;AACxE,IAAA,IAAI,gBAAwC,IAAK,CAAA,YAAA,CAAA;AAEjD,IAAA,IAAI,OAAO,IAAK,CAAA,IAAA,CAAK,WAAW,CAAA,CAAE,SAAS,CAAG,EAAA;AAC5C,MAAA,IAAI,WAAc,GAAA,EAAE,GAAG,IAAA,CAAK,WAAY,EAAA,CAAA;AAExC,MAAA,IAAI,MAAQ,EAAA;AACV,QAAA,WAAA,GAAcC,wBAAkB,WAAW,CAAA,CAAA;AAAA,OAC7C;AAEA,MAAA,aAAA,GAAgB,EAAE,GAAG,IAAK,CAAA,YAAA,EAAc,OAAO,WAAY,EAAA,CAAA;AAAA,KAC7D;AAEA,IAAA,MAAM,iBAAyB,GAAA;AAAA,MAC7B,MAAQ,EAAA,aAAA;AAAA;AAAA,MAER,gBAAgB,IAAK,CAAA,eAAA;AAAA,KACvB,CAAA;AAEA,IAAA,IAAI,KAAK,SAAW,EAAA;AAClB,MAAA,iBAAA,CAAkB,OAAU,GAAA;AAAA,QAC1B,GAAG,iBAAkB,CAAA,OAAA;AAAA,QACrB,oBAAoB,IAAK,CAAA,SAAA;AAAA,OAC3B,CAAA;AAAA,KACF;AACA,IAAA,MAAM,WAAW,MAAMC,YAAA,CAAQ,KAAK,OAAS,EAAA,IAAA,CAAK,UAAU,iBAAiB,CAAA,CAAA;AAE7E,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"entries.cjs","sources":["../../../src/entries/entries.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\nimport { Query } from '../query';\nimport { BaseQuery } from '../query';\nimport { FindResponse } from '../common/types';\nimport { encodeQueryParams } from '../common/utils';\nimport { ErrorMessages } from '../common/error-messages';\n\nexport class Entries extends BaseQuery {\n private _contentTypeUid: string;\n\n constructor(client: AxiosInstance, contentTypeUid: string) {\n super();\n this._client = client;\n this._contentTypeUid = contentTypeUid;\n this._urlPath = `/content_types/${this._contentTypeUid}/entries`;\n this._variants = '';\n }\n\n /**\n * @method except\n * @memberof Entries\n * @description Excludes specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().except(\"fieldUID\").find()\n *\n * @param {string} fieldUid - field uid to exclude\n * @returns {Entries} - returns Entries object for chaining method calls\n */\n except(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`except[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"except[BASE][]\"] = fieldUid;\n }\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Entries\n * @description Includes the branch in result\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeBranch().find();\n */\n includeBranch(): Entries {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method includeContentType\n * @memberof Entries\n * @description Include the details of the content type along with the entries details\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeContentType().find();\n */\n includeContentType(): Entries {\n this._queryParams.include_content_type = 'true';\n\n return this;\n }\n\n /**\n * @method includeEmbeddedItems\n * @memberof Entries\n * @description Include Embedded Objects (Entries and Assets) along with entry/entries details.\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeEmbeddedItems().find();\n */\n includeEmbeddedItems(): Entries {\n this._queryParams['include_embedded_items[]'] = 'BASE';\n\n return this;\n }\n\n /**\n * @method includeFallback\n * @memberof Entries\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeFallback().find();\n */\n includeFallback(): Entries {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Entries\n * @description Include the metadata for getting metadata content for the entry.\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeMetadata().find();\n */\n includeMetadata(): Entries {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeReference\n * @memberof Entries\n * @description To include the content of the referred entries in your response,\n * you need to use the include[] parameter and specify the UID of the reference field as value.\n * This function sets the include parameter to a reference field UID in the API request.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeReference(\"brand\")\n * const result = await entries.find()\n *\n * @param {string} referenceFieldUid - UID of the reference field to include.\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeReference(...referenceFieldUid: (string | string[])[]): Entries {\n if (referenceFieldUid.length) {\n referenceFieldUid.forEach(value => {\n if (!Array.isArray(this._queryParams['include[]'])) {\n this._queryParams['include[]'] = [];\n }\n (this._queryParams['include[]'] as string[]).push(...(Array.isArray(value) ? value : [value]));\n });\n } else {\n console.error(ErrorMessages.INVALID_ARGUMENT_STRING_OR_ARRAY);\n }\n return this;\n }\n\n /**\n * @method includeReferenceContentTypeUID\n * @memberof Entries\n * @description This method also includes the content type UIDs of the referenced entries returned in the response.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeReferenceContentTypeUID()\n * const result = await entries.find()\n *\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeReferenceContentTypeUID(): Entries {\n this._queryParams.include_reference_content_type_uid = 'true';\n\n return this;\n }\n\n /**\n * @method includeSchema\n * @memberof Entries\n * @description Includes the schema of the content type along with the entries details.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeSchema()\n * const result = await entries.find()\n *\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeSchema(): Entries {\n this._queryParams.include_schema = 'true';\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Entries\n * @description The entries published in the locale will be fetched\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().locale('en-us').find();\n */\n locale(locale: string): Entries {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method only\n * @memberof Entries\n * @description Selects specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().only(\"fieldUID\").find()\n *\n * @param {string} fieldUid - field uid to select\n * @returns {Entries} - returns Entries object for chaining method calls\n */\n only(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`only[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"only[BASE][]\"] = fieldUid;\n }\n return this;\n }\n\n /**\n * @method query\n * @memberof Entries\n * @description Creates a query object for filtering entries\n * @param {object} queryObj - Optional query object to initialize the query\n * @returns {Query} Query instance for chaining query methods\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const query = stack.contentType(\"contentTypeUid\").entry().query();\n */\n query(queryObj?: { [key: string]: any }) {\n if (queryObj) return new Query(this._client, this._parameters, this._queryParams, this._variants, this._contentTypeUid, queryObj);\n\n return new Query(this._client, this._parameters, this._queryParams, this._variants, this._contentTypeUid);\n }\n\n /**\n * @method variants\n * @memberof Entries\n * @description The variant header will be added to axios client\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('abc').entry().variants('xyz').find();\n */\n variants(variants: string | string[]): Entries {\n if (Array.isArray(variants) && variants.length > 0) {\n this._variants = variants.join(',');\n } else if (typeof variants == 'string' && variants.length > 0) {\n this._variants = variants;\n }\n return this;\n }\n\n /**\n * @method assetFields\n * @memberof Entries\n * @description Include specific asset fields in the response (CDA getEntry/entries).\n * Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().assetFields(\"user_defined_fields\", \"embedded_metadata\").find();\n *\n * @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n assetFields(...fields: string[]): this {\n if (fields.length > 0) {\n this._queryParams['asset_fields[]'] = fields;\n }\n return this;\n }\n\n /**\n * Override find method to include content type UID directly for better caching\n */\n override async find<T>(encode: boolean = false): Promise<FindResponse<T>> {\n let requestParams: { [key: string]: any } = this._queryParams;\n\n if (Object.keys(this._parameters).length > 0) {\n let queryParams = { ...this._parameters };\n \n if (encode) {\n queryParams = encodeQueryParams(queryParams);\n }\n \n requestParams = { ...this._queryParams, query: queryParams };\n }\n\n const getRequestOptions: any = { \n params: requestParams,\n // Add contentTypeUid directly for improved caching\n contentTypeUid: this._contentTypeUid\n };\n\n if (this._variants) {\n getRequestOptions.headers = {\n ...getRequestOptions.headers,\n 'x-cs-variant-uid': this._variants\n };\n }\n const response = await getData(this._client, this._urlPath, getRequestOptions);\n\n return response as FindResponse<T>;\n }\n}\n"],"names":["BaseQuery","ErrorMessages","Query","encodeQueryParams","getData"],"mappings":";;;;;;;;;;;AAOO,MAAM,gBAAgBA,mBAAU,CAAA;AAAA,EAGrC,WAAA,CAAY,QAAuB,cAAwB,EAAA;AACzD,IAAM,KAAA,EAAA,CAAA;AAHR,IAAQ,aAAA,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AAIN,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,cAAA,CAAA;AACvB,IAAK,IAAA,CAAA,QAAA,GAAW,CAAkB,eAAA,EAAA,IAAA,CAAK,eAAe,CAAA,QAAA,CAAA,CAAA;AACtD,IAAA,IAAA,CAAK,SAAY,GAAA,EAAA,CAAA;AAAA,GACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,QAAiC,EAAA;AACtC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,aAAA,EAAgB,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AAC1C,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,QAAA,CAAA;AAAA,KACxC;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,kBAA8B,GAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,oBAAuB,GAAA,MAAA,CAAA;AAEzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,oBAAgC,GAAA;AAC9B,IAAK,IAAA,CAAA,YAAA,CAAa,0BAA0B,CAAI,GAAA,MAAA,CAAA;AAEhD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,oBAAoB,iBAAmD,EAAA;AACrE,IAAA,IAAI,kBAAkB,MAAQ,EAAA;AAC5B,MAAA,iBAAA,CAAkB,QAAQ,CAAS,KAAA,KAAA;AACjC,QAAA,IAAI,CAAC,KAAM,CAAA,OAAA,CAAQ,KAAK,YAAa,CAAA,WAAW,CAAC,CAAG,EAAA;AAClD,UAAK,IAAA,CAAA,YAAA,CAAa,WAAW,CAAA,GAAI,EAAC,CAAA;AAAA,SACpC;AACA,QAAC,IAAK,CAAA,YAAA,CAAa,WAAW,CAAA,CAAe,IAAK,CAAA,GAAI,KAAM,CAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAQ,GAAA,CAAC,KAAK,CAAE,CAAA,CAAA;AAAA,OAC9F,CAAA,CAAA;AAAA,KACI,MAAA;AACL,MAAQ,OAAA,CAAA,KAAA,CAAMC,4BAAc,gCAAgC,CAAA,CAAA;AAAA,KAC9D;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,8BAA0C,GAAA;AACxC,IAAA,IAAA,CAAK,aAAa,kCAAqC,GAAA,MAAA,CAAA;AAEvD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,aAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,OAAO,MAAyB,EAAA;AAC9B,IAAA,IAAA,CAAK,aAAa,MAAS,GAAA,MAAA,CAAA;AAE3B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,KAAK,QAAiC,EAAA;AACpC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,WAAA,EAAc,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AACxC,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,cAAc,CAAI,GAAA,QAAA,CAAA;AAAA,KACtC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,QAAmC,EAAA;AACvC,IAAA,IAAI,QAAU,EAAA,OAAO,IAAIC,WAAA,CAAM,KAAK,OAAS,EAAA,IAAA,CAAK,WAAa,EAAA,IAAA,CAAK,YAAc,EAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,iBAAiB,QAAQ,CAAA,CAAA;AAEhI,IAAO,OAAA,IAAIA,WAAM,CAAA,IAAA,CAAK,OAAS,EAAA,IAAA,CAAK,WAAa,EAAA,IAAA,CAAK,YAAc,EAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,eAAe,CAAA,CAAA;AAAA,GAC1G;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,SAAS,QAAsC,EAAA;AAC7C,IAAA,IAAI,MAAM,OAAQ,CAAA,QAAQ,CAAK,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAClD,MAAK,IAAA,CAAA,SAAA,GAAY,QAAS,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,eACzB,OAAO,QAAA,IAAY,QAAY,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAC7D,MAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AAAA,KACnB;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,eAAe,MAAwB,EAAA;AACrC,IAAI,IAAA,MAAA,CAAO,SAAS,CAAG,EAAA;AACrB,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,MAAA,CAAA;AAAA,KACxC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAe,IAAQ,CAAA,MAAA,GAAkB,KAAiC,EAAA;AACxE,IAAA,IAAI,gBAAwC,IAAK,CAAA,YAAA,CAAA;AAEjD,IAAA,IAAI,OAAO,IAAK,CAAA,IAAA,CAAK,WAAW,CAAA,CAAE,SAAS,CAAG,EAAA;AAC5C,MAAA,IAAI,WAAc,GAAA,EAAE,GAAG,IAAA,CAAK,WAAY,EAAA,CAAA;AAExC,MAAA,IAAI,MAAQ,EAAA;AACV,QAAA,WAAA,GAAcC,wBAAkB,WAAW,CAAA,CAAA;AAAA,OAC7C;AAEA,MAAA,aAAA,GAAgB,EAAE,GAAG,IAAK,CAAA,YAAA,EAAc,OAAO,WAAY,EAAA,CAAA;AAAA,KAC7D;AAEA,IAAA,MAAM,iBAAyB,GAAA;AAAA,MAC7B,MAAQ,EAAA,aAAA;AAAA;AAAA,MAER,gBAAgB,IAAK,CAAA,eAAA;AAAA,KACvB,CAAA;AAEA,IAAA,IAAI,KAAK,SAAW,EAAA;AAClB,MAAA,iBAAA,CAAkB,OAAU,GAAA;AAAA,QAC1B,GAAG,iBAAkB,CAAA,OAAA;AAAA,QACrB,oBAAoB,IAAK,CAAA,SAAA;AAAA,OAC3B,CAAA;AAAA,KACF;AACA,IAAA,MAAM,WAAW,MAAMC,YAAA,CAAQ,KAAK,OAAS,EAAA,IAAA,CAAK,UAAU,iBAAiB,CAAA,CAAA;AAE7E,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
|
@@ -254,6 +254,26 @@ class Entries extends BaseQuery {
|
|
|
254
254
|
}
|
|
255
255
|
return this;
|
|
256
256
|
}
|
|
257
|
+
/**
|
|
258
|
+
* @method assetFields
|
|
259
|
+
* @memberof Entries
|
|
260
|
+
* @description Include specific asset fields in the response (CDA getEntry/entries).
|
|
261
|
+
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
|
|
262
|
+
* @example
|
|
263
|
+
* import contentstack from '@contentstack/delivery-sdk'
|
|
264
|
+
*
|
|
265
|
+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
266
|
+
* const result = await stack.contentType("contentTypeUid").entry().assetFields("user_defined_fields", "embedded_metadata").find();
|
|
267
|
+
*
|
|
268
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
|
|
269
|
+
* @returns {Entries} - Returns the Entries instance for chaining.
|
|
270
|
+
*/
|
|
271
|
+
assetFields(...fields) {
|
|
272
|
+
if (fields.length > 0) {
|
|
273
|
+
this._queryParams["asset_fields[]"] = fields;
|
|
274
|
+
}
|
|
275
|
+
return this;
|
|
276
|
+
}
|
|
257
277
|
/**
|
|
258
278
|
* Override find method to include content type UID directly for better caching
|
|
259
279
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entries.js","sources":["../../../src/entries/entries.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\nimport { Query } from '../query';\nimport { BaseQuery } from '../query';\nimport { FindResponse } from '../common/types';\nimport { encodeQueryParams } from '../common/utils';\nimport { ErrorMessages } from '../common/error-messages';\n\nexport class Entries extends BaseQuery {\n private _contentTypeUid: string;\n\n constructor(client: AxiosInstance, contentTypeUid: string) {\n super();\n this._client = client;\n this._contentTypeUid = contentTypeUid;\n this._urlPath = `/content_types/${this._contentTypeUid}/entries`;\n this._variants = '';\n }\n\n /**\n * @method except\n * @memberof Entries\n * @description Excludes specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().except(\"fieldUID\").find()\n *\n * @param {string} fieldUid - field uid to exclude\n * @returns {Entries} - returns Entries object for chaining method calls\n */\n except(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`except[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"except[BASE][]\"] = fieldUid;\n }\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Entries\n * @description Includes the branch in result\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeBranch().find();\n */\n includeBranch(): Entries {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method includeContentType\n * @memberof Entries\n * @description Include the details of the content type along with the entries details\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeContentType().find();\n */\n includeContentType(): Entries {\n this._queryParams.include_content_type = 'true';\n\n return this;\n }\n\n /**\n * @method includeEmbeddedItems\n * @memberof Entries\n * @description Include Embedded Objects (Entries and Assets) along with entry/entries details.\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeEmbeddedItems().find();\n */\n includeEmbeddedItems(): Entries {\n this._queryParams['include_embedded_items[]'] = 'BASE';\n\n return this;\n }\n\n /**\n * @method includeFallback\n * @memberof Entries\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeFallback().find();\n */\n includeFallback(): Entries {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Entries\n * @description Include the metadata for getting metadata content for the entry.\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeMetadata().find();\n */\n includeMetadata(): Entries {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeReference\n * @memberof Entries\n * @description To include the content of the referred entries in your response,\n * you need to use the include[] parameter and specify the UID of the reference field as value.\n * This function sets the include parameter to a reference field UID in the API request.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeReference(\"brand\")\n * const result = await entries.find()\n *\n * @param {string} referenceFieldUid - UID of the reference field to include.\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeReference(...referenceFieldUid: (string | string[])[]): Entries {\n if (referenceFieldUid.length) {\n referenceFieldUid.forEach(value => {\n if (!Array.isArray(this._queryParams['include[]'])) {\n this._queryParams['include[]'] = [];\n }\n (this._queryParams['include[]'] as string[]).push(...(Array.isArray(value) ? value : [value]));\n });\n } else {\n console.error(ErrorMessages.INVALID_ARGUMENT_STRING_OR_ARRAY);\n }\n return this;\n }\n\n /**\n * @method includeReferenceContentTypeUID\n * @memberof Entries\n * @description This method also includes the content type UIDs of the referenced entries returned in the response.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeReferenceContentTypeUID()\n * const result = await entries.find()\n *\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeReferenceContentTypeUID(): Entries {\n this._queryParams.include_reference_content_type_uid = 'true';\n\n return this;\n }\n\n /**\n * @method includeSchema\n * @memberof Entries\n * @description Includes the schema of the content type along with the entries details.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeSchema()\n * const result = await entries.find()\n *\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeSchema(): Entries {\n this._queryParams.include_schema = 'true';\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Entries\n * @description The entries published in the locale will be fetched\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().locale('en-us').find();\n */\n locale(locale: string): Entries {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method only\n * @memberof Entries\n * @description Selects specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().only(\"fieldUID\").find()\n *\n * @param {string} fieldUid - field uid to select\n * @returns {Entries} - returns Entries object for chaining method calls\n */\n only(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`only[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"only[BASE][]\"] = fieldUid;\n }\n return this;\n }\n\n /**\n * @method query\n * @memberof Entries\n * @description Creates a query object for filtering entries\n * @param {object} queryObj - Optional query object to initialize the query\n * @returns {Query} Query instance for chaining query methods\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const query = stack.contentType(\"contentTypeUid\").entry().query();\n */\n query(queryObj?: { [key: string]: any }) {\n if (queryObj) return new Query(this._client, this._parameters, this._queryParams, this._variants, this._contentTypeUid, queryObj);\n\n return new Query(this._client, this._parameters, this._queryParams, this._variants, this._contentTypeUid);\n }\n\n /**\n * @method variants\n * @memberof Entries\n * @description The variant header will be added to axios client\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('abc').entry().variants('xyz').find();\n */\n variants(variants: string | string[]): Entries {\n if (Array.isArray(variants) && variants.length > 0) {\n this._variants = variants.join(',');\n } else if (typeof variants == 'string' && variants.length > 0) {\n this._variants = variants;\n }\n return this;\n }\n\n /**\n * Override find method to include content type UID directly for better caching\n */\n override async find<T>(encode: boolean = false): Promise<FindResponse<T>> {\n let requestParams: { [key: string]: any } = this._queryParams;\n\n if (Object.keys(this._parameters).length > 0) {\n let queryParams = { ...this._parameters };\n \n if (encode) {\n queryParams = encodeQueryParams(queryParams);\n }\n \n requestParams = { ...this._queryParams, query: queryParams };\n }\n\n const getRequestOptions: any = { \n params: requestParams,\n // Add contentTypeUid directly for improved caching\n contentTypeUid: this._contentTypeUid\n };\n\n if (this._variants) {\n getRequestOptions.headers = {\n ...getRequestOptions.headers,\n 'x-cs-variant-uid': this._variants\n };\n }\n const response = await getData(this._client, this._urlPath, getRequestOptions);\n\n return response as FindResponse<T>;\n }\n}\n"],"names":[],"mappings":";;;;;;;;;AAOO,MAAM,gBAAgB,SAAU,CAAA;AAAA,EAGrC,WAAA,CAAY,QAAuB,cAAwB,EAAA;AACzD,IAAM,KAAA,EAAA,CAAA;AAHR,IAAQ,aAAA,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AAIN,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,cAAA,CAAA;AACvB,IAAK,IAAA,CAAA,QAAA,GAAW,CAAkB,eAAA,EAAA,IAAA,CAAK,eAAe,CAAA,QAAA,CAAA,CAAA;AACtD,IAAA,IAAA,CAAK,SAAY,GAAA,EAAA,CAAA;AAAA,GACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,QAAiC,EAAA;AACtC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,aAAA,EAAgB,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AAC1C,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,QAAA,CAAA;AAAA,KACxC;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,kBAA8B,GAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,oBAAuB,GAAA,MAAA,CAAA;AAEzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,oBAAgC,GAAA;AAC9B,IAAK,IAAA,CAAA,YAAA,CAAa,0BAA0B,CAAI,GAAA,MAAA,CAAA;AAEhD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,oBAAoB,iBAAmD,EAAA;AACrE,IAAA,IAAI,kBAAkB,MAAQ,EAAA;AAC5B,MAAA,iBAAA,CAAkB,QAAQ,CAAS,KAAA,KAAA;AACjC,QAAA,IAAI,CAAC,KAAM,CAAA,OAAA,CAAQ,KAAK,YAAa,CAAA,WAAW,CAAC,CAAG,EAAA;AAClD,UAAK,IAAA,CAAA,YAAA,CAAa,WAAW,CAAA,GAAI,EAAC,CAAA;AAAA,SACpC;AACA,QAAC,IAAK,CAAA,YAAA,CAAa,WAAW,CAAA,CAAe,IAAK,CAAA,GAAI,KAAM,CAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAQ,GAAA,CAAC,KAAK,CAAE,CAAA,CAAA;AAAA,OAC9F,CAAA,CAAA;AAAA,KACI,MAAA;AACL,MAAQ,OAAA,CAAA,KAAA,CAAM,cAAc,gCAAgC,CAAA,CAAA;AAAA,KAC9D;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,8BAA0C,GAAA;AACxC,IAAA,IAAA,CAAK,aAAa,kCAAqC,GAAA,MAAA,CAAA;AAEvD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,aAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,OAAO,MAAyB,EAAA;AAC9B,IAAA,IAAA,CAAK,aAAa,MAAS,GAAA,MAAA,CAAA;AAE3B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,KAAK,QAAiC,EAAA;AACpC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,WAAA,EAAc,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AACxC,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,cAAc,CAAI,GAAA,QAAA,CAAA;AAAA,KACtC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,QAAmC,EAAA;AACvC,IAAA,IAAI,QAAU,EAAA,OAAO,IAAI,KAAA,CAAM,KAAK,OAAS,EAAA,IAAA,CAAK,WAAa,EAAA,IAAA,CAAK,YAAc,EAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,iBAAiB,QAAQ,CAAA,CAAA;AAEhI,IAAO,OAAA,IAAI,KAAM,CAAA,IAAA,CAAK,OAAS,EAAA,IAAA,CAAK,WAAa,EAAA,IAAA,CAAK,YAAc,EAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,eAAe,CAAA,CAAA;AAAA,GAC1G;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,SAAS,QAAsC,EAAA;AAC7C,IAAA,IAAI,MAAM,OAAQ,CAAA,QAAQ,CAAK,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAClD,MAAK,IAAA,CAAA,SAAA,GAAY,QAAS,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,eACzB,OAAO,QAAA,IAAY,QAAY,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAC7D,MAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AAAA,KACnB;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAe,IAAQ,CAAA,MAAA,GAAkB,KAAiC,EAAA;AACxE,IAAA,IAAI,gBAAwC,IAAK,CAAA,YAAA,CAAA;AAEjD,IAAA,IAAI,OAAO,IAAK,CAAA,IAAA,CAAK,WAAW,CAAA,CAAE,SAAS,CAAG,EAAA;AAC5C,MAAA,IAAI,WAAc,GAAA,EAAE,GAAG,IAAA,CAAK,WAAY,EAAA,CAAA;AAExC,MAAA,IAAI,MAAQ,EAAA;AACV,QAAA,WAAA,GAAc,kBAAkB,WAAW,CAAA,CAAA;AAAA,OAC7C;AAEA,MAAA,aAAA,GAAgB,EAAE,GAAG,IAAK,CAAA,YAAA,EAAc,OAAO,WAAY,EAAA,CAAA;AAAA,KAC7D;AAEA,IAAA,MAAM,iBAAyB,GAAA;AAAA,MAC7B,MAAQ,EAAA,aAAA;AAAA;AAAA,MAER,gBAAgB,IAAK,CAAA,eAAA;AAAA,KACvB,CAAA;AAEA,IAAA,IAAI,KAAK,SAAW,EAAA;AAClB,MAAA,iBAAA,CAAkB,OAAU,GAAA;AAAA,QAC1B,GAAG,iBAAkB,CAAA,OAAA;AAAA,QACrB,oBAAoB,IAAK,CAAA,SAAA;AAAA,OAC3B,CAAA;AAAA,KACF;AACA,IAAA,MAAM,WAAW,MAAM,OAAA,CAAQ,KAAK,OAAS,EAAA,IAAA,CAAK,UAAU,iBAAiB,CAAA,CAAA;AAE7E,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"entries.js","sources":["../../../src/entries/entries.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\nimport { Query } from '../query';\nimport { BaseQuery } from '../query';\nimport { FindResponse } from '../common/types';\nimport { encodeQueryParams } from '../common/utils';\nimport { ErrorMessages } from '../common/error-messages';\n\nexport class Entries extends BaseQuery {\n private _contentTypeUid: string;\n\n constructor(client: AxiosInstance, contentTypeUid: string) {\n super();\n this._client = client;\n this._contentTypeUid = contentTypeUid;\n this._urlPath = `/content_types/${this._contentTypeUid}/entries`;\n this._variants = '';\n }\n\n /**\n * @method except\n * @memberof Entries\n * @description Excludes specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().except(\"fieldUID\").find()\n *\n * @param {string} fieldUid - field uid to exclude\n * @returns {Entries} - returns Entries object for chaining method calls\n */\n except(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`except[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"except[BASE][]\"] = fieldUid;\n }\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Entries\n * @description Includes the branch in result\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeBranch().find();\n */\n includeBranch(): Entries {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method includeContentType\n * @memberof Entries\n * @description Include the details of the content type along with the entries details\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeContentType().find();\n */\n includeContentType(): Entries {\n this._queryParams.include_content_type = 'true';\n\n return this;\n }\n\n /**\n * @method includeEmbeddedItems\n * @memberof Entries\n * @description Include Embedded Objects (Entries and Assets) along with entry/entries details.\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeEmbeddedItems().find();\n */\n includeEmbeddedItems(): Entries {\n this._queryParams['include_embedded_items[]'] = 'BASE';\n\n return this;\n }\n\n /**\n * @method includeFallback\n * @memberof Entries\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeFallback().find();\n */\n includeFallback(): Entries {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Entries\n * @description Include the metadata for getting metadata content for the entry.\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry().includeMetadata().find();\n */\n includeMetadata(): Entries {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeReference\n * @memberof Entries\n * @description To include the content of the referred entries in your response,\n * you need to use the include[] parameter and specify the UID of the reference field as value.\n * This function sets the include parameter to a reference field UID in the API request.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeReference(\"brand\")\n * const result = await entries.find()\n *\n * @param {string} referenceFieldUid - UID of the reference field to include.\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeReference(...referenceFieldUid: (string | string[])[]): Entries {\n if (referenceFieldUid.length) {\n referenceFieldUid.forEach(value => {\n if (!Array.isArray(this._queryParams['include[]'])) {\n this._queryParams['include[]'] = [];\n }\n (this._queryParams['include[]'] as string[]).push(...(Array.isArray(value) ? value : [value]));\n });\n } else {\n console.error(ErrorMessages.INVALID_ARGUMENT_STRING_OR_ARRAY);\n }\n return this;\n }\n\n /**\n * @method includeReferenceContentTypeUID\n * @memberof Entries\n * @description This method also includes the content type UIDs of the referenced entries returned in the response.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeReferenceContentTypeUID()\n * const result = await entries.find()\n *\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeReferenceContentTypeUID(): Entries {\n this._queryParams.include_reference_content_type_uid = 'true';\n\n return this;\n }\n\n /**\n * @method includeSchema\n * @memberof Entries\n * @description Includes the schema of the content type along with the entries details.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const entries = stack.contentType(\"contentTypeUid\").entry().includeSchema()\n * const result = await entries.find()\n *\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n includeSchema(): Entries {\n this._queryParams.include_schema = 'true';\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Entries\n * @description The entries published in the locale will be fetched\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().locale('en-us').find();\n */\n locale(locale: string): Entries {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method only\n * @memberof Entries\n * @description Selects specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().only(\"fieldUID\").find()\n *\n * @param {string} fieldUid - field uid to select\n * @returns {Entries} - returns Entries object for chaining method calls\n */\n only(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`only[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"only[BASE][]\"] = fieldUid;\n }\n return this;\n }\n\n /**\n * @method query\n * @memberof Entries\n * @description Creates a query object for filtering entries\n * @param {object} queryObj - Optional query object to initialize the query\n * @returns {Query} Query instance for chaining query methods\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const query = stack.contentType(\"contentTypeUid\").entry().query();\n */\n query(queryObj?: { [key: string]: any }) {\n if (queryObj) return new Query(this._client, this._parameters, this._queryParams, this._variants, this._contentTypeUid, queryObj);\n\n return new Query(this._client, this._parameters, this._queryParams, this._variants, this._contentTypeUid);\n }\n\n /**\n * @method variants\n * @memberof Entries\n * @description The variant header will be added to axios client\n * @returns {Entries}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('abc').entry().variants('xyz').find();\n */\n variants(variants: string | string[]): Entries {\n if (Array.isArray(variants) && variants.length > 0) {\n this._variants = variants.join(',');\n } else if (typeof variants == 'string' && variants.length > 0) {\n this._variants = variants;\n }\n return this;\n }\n\n /**\n * @method assetFields\n * @memberof Entries\n * @description Include specific asset fields in the response (CDA getEntry/entries).\n * Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry().assetFields(\"user_defined_fields\", \"embedded_metadata\").find();\n *\n * @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)\n * @returns {Entries} - Returns the Entries instance for chaining.\n */\n assetFields(...fields: string[]): this {\n if (fields.length > 0) {\n this._queryParams['asset_fields[]'] = fields;\n }\n return this;\n }\n\n /**\n * Override find method to include content type UID directly for better caching\n */\n override async find<T>(encode: boolean = false): Promise<FindResponse<T>> {\n let requestParams: { [key: string]: any } = this._queryParams;\n\n if (Object.keys(this._parameters).length > 0) {\n let queryParams = { ...this._parameters };\n \n if (encode) {\n queryParams = encodeQueryParams(queryParams);\n }\n \n requestParams = { ...this._queryParams, query: queryParams };\n }\n\n const getRequestOptions: any = { \n params: requestParams,\n // Add contentTypeUid directly for improved caching\n contentTypeUid: this._contentTypeUid\n };\n\n if (this._variants) {\n getRequestOptions.headers = {\n ...getRequestOptions.headers,\n 'x-cs-variant-uid': this._variants\n };\n }\n const response = await getData(this._client, this._urlPath, getRequestOptions);\n\n return response as FindResponse<T>;\n }\n}\n"],"names":[],"mappings":";;;;;;;;;AAOO,MAAM,gBAAgB,SAAU,CAAA;AAAA,EAGrC,WAAA,CAAY,QAAuB,cAAwB,EAAA;AACzD,IAAM,KAAA,EAAA,CAAA;AAHR,IAAQ,aAAA,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AAIN,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,cAAA,CAAA;AACvB,IAAK,IAAA,CAAA,QAAA,GAAW,CAAkB,eAAA,EAAA,IAAA,CAAK,eAAe,CAAA,QAAA,CAAA,CAAA;AACtD,IAAA,IAAA,CAAK,SAAY,GAAA,EAAA,CAAA;AAAA,GACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,QAAiC,EAAA;AACtC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,aAAA,EAAgB,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AAC1C,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,QAAA,CAAA;AAAA,KACxC;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,kBAA8B,GAAA;AAC5B,IAAA,IAAA,CAAK,aAAa,oBAAuB,GAAA,MAAA,CAAA;AAEzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,oBAAgC,GAAA;AAC9B,IAAK,IAAA,CAAA,YAAA,CAAa,0BAA0B,CAAI,GAAA,MAAA,CAAA;AAEhD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,oBAAoB,iBAAmD,EAAA;AACrE,IAAA,IAAI,kBAAkB,MAAQ,EAAA;AAC5B,MAAA,iBAAA,CAAkB,QAAQ,CAAS,KAAA,KAAA;AACjC,QAAA,IAAI,CAAC,KAAM,CAAA,OAAA,CAAQ,KAAK,YAAa,CAAA,WAAW,CAAC,CAAG,EAAA;AAClD,UAAK,IAAA,CAAA,YAAA,CAAa,WAAW,CAAA,GAAI,EAAC,CAAA;AAAA,SACpC;AACA,QAAC,IAAK,CAAA,YAAA,CAAa,WAAW,CAAA,CAAe,IAAK,CAAA,GAAI,KAAM,CAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAQ,GAAA,CAAC,KAAK,CAAE,CAAA,CAAA;AAAA,OAC9F,CAAA,CAAA;AAAA,KACI,MAAA;AACL,MAAQ,OAAA,CAAA,KAAA,CAAM,cAAc,gCAAgC,CAAA,CAAA;AAAA,KAC9D;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,8BAA0C,GAAA;AACxC,IAAA,IAAA,CAAK,aAAa,kCAAqC,GAAA,MAAA,CAAA;AAEvD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,aAAyB,GAAA;AACvB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,OAAO,MAAyB,EAAA;AAC9B,IAAA,IAAA,CAAK,aAAa,MAAS,GAAA,MAAA,CAAA;AAE3B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,KAAK,QAAiC,EAAA;AACpC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,WAAA,EAAc,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AACxC,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,cAAc,CAAI,GAAA,QAAA,CAAA;AAAA,KACtC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAM,QAAmC,EAAA;AACvC,IAAA,IAAI,QAAU,EAAA,OAAO,IAAI,KAAA,CAAM,KAAK,OAAS,EAAA,IAAA,CAAK,WAAa,EAAA,IAAA,CAAK,YAAc,EAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,iBAAiB,QAAQ,CAAA,CAAA;AAEhI,IAAO,OAAA,IAAI,KAAM,CAAA,IAAA,CAAK,OAAS,EAAA,IAAA,CAAK,WAAa,EAAA,IAAA,CAAK,YAAc,EAAA,IAAA,CAAK,SAAW,EAAA,IAAA,CAAK,eAAe,CAAA,CAAA;AAAA,GAC1G;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,SAAS,QAAsC,EAAA;AAC7C,IAAA,IAAI,MAAM,OAAQ,CAAA,QAAQ,CAAK,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAClD,MAAK,IAAA,CAAA,SAAA,GAAY,QAAS,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,eACzB,OAAO,QAAA,IAAY,QAAY,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAC7D,MAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AAAA,KACnB;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,eAAe,MAAwB,EAAA;AACrC,IAAI,IAAA,MAAA,CAAO,SAAS,CAAG,EAAA;AACrB,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,MAAA,CAAA;AAAA,KACxC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA,EAKA,MAAe,IAAQ,CAAA,MAAA,GAAkB,KAAiC,EAAA;AACxE,IAAA,IAAI,gBAAwC,IAAK,CAAA,YAAA,CAAA;AAEjD,IAAA,IAAI,OAAO,IAAK,CAAA,IAAA,CAAK,WAAW,CAAA,CAAE,SAAS,CAAG,EAAA;AAC5C,MAAA,IAAI,WAAc,GAAA,EAAE,GAAG,IAAA,CAAK,WAAY,EAAA,CAAA;AAExC,MAAA,IAAI,MAAQ,EAAA;AACV,QAAA,WAAA,GAAc,kBAAkB,WAAW,CAAA,CAAA;AAAA,OAC7C;AAEA,MAAA,aAAA,GAAgB,EAAE,GAAG,IAAK,CAAA,YAAA,EAAc,OAAO,WAAY,EAAA,CAAA;AAAA,KAC7D;AAEA,IAAA,MAAM,iBAAyB,GAAA;AAAA,MAC7B,MAAQ,EAAA,aAAA;AAAA;AAAA,MAER,gBAAgB,IAAK,CAAA,eAAA;AAAA,KACvB,CAAA;AAEA,IAAA,IAAI,KAAK,SAAW,EAAA;AAClB,MAAA,iBAAA,CAAkB,OAAU,GAAA;AAAA,QAC1B,GAAG,iBAAkB,CAAA,OAAA;AAAA,QACrB,oBAAoB,IAAK,CAAA,SAAA;AAAA,OAC3B,CAAA;AAAA,KACF;AACA,IAAA,MAAM,WAAW,MAAM,OAAA,CAAQ,KAAK,OAAS,EAAA,IAAA,CAAK,UAAU,iBAAiB,CAAA,CAAA;AAE7E,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
|
@@ -251,6 +251,26 @@ class Entry {
|
|
|
251
251
|
}
|
|
252
252
|
return this;
|
|
253
253
|
}
|
|
254
|
+
/**
|
|
255
|
+
* @method assetFields
|
|
256
|
+
* @memberof Entry
|
|
257
|
+
* @description Include specific asset fields in the response (CDA getEntry).
|
|
258
|
+
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
|
|
259
|
+
* @example
|
|
260
|
+
* import contentstack from '@contentstack/delivery-sdk'
|
|
261
|
+
*
|
|
262
|
+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
263
|
+
* const result = await stack.contentType("contentTypeUid").entry("entryUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
|
|
264
|
+
*
|
|
265
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
|
|
266
|
+
* @returns {Entry} - Returns the Entry instance for chaining.
|
|
267
|
+
*/
|
|
268
|
+
assetFields(...fields) {
|
|
269
|
+
if (fields.length > 0) {
|
|
270
|
+
this._queryParams["asset_fields[]"] = fields;
|
|
271
|
+
}
|
|
272
|
+
return this;
|
|
273
|
+
}
|
|
254
274
|
}
|
|
255
275
|
|
|
256
276
|
exports.Entry = Entry;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entry.cjs","sources":["../../../src/entries/entry.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\nimport { ErrorMessages } from '../common/error-messages';\n\ninterface EntryResponse<T> {\n entry: T;\n}\nexport class Entry {\n protected _client: AxiosInstance;\n private _contentTypeUid: string;\n private _entryUid: string;\n private _urlPath: string;\n protected _variants: string;\n _queryParams: { [key: string]: string | number | string[] } = {};\n constructor(client: AxiosInstance, contentTypeUid: string, entryUid: string) {\n this._client = client;\n this._contentTypeUid = contentTypeUid;\n this._entryUid = entryUid;\n this._urlPath = `/content_types/${this._contentTypeUid}/entries/${this._entryUid}`;\n this._variants = '';\n }\n\n /**\n * @method includeFallback\n * @memberof Entry\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeFallback().fetch();\n */\n includeFallback(): this {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method variants\n * @memberof Entry\n * @description The variant header will be added to axios client\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('abc').entry('entry_uid').variants('xyz').fetch();\n */\n variants(variants: string | string[]): this {\n if (Array.isArray(variants) && variants.length > 0) {\n this._variants = variants.join(',');\n } else if (typeof variants == 'string' && variants.length > 0) {\n this._variants = variants;\n }\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Entry\n * @description Include the metadata for getting metadata content for the entry.\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeMetadata().fetch();\n */\n includeMetadata(): this {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeEmbeddedItems\n * @memberof Entry\n * @description Include Embedded Objects (Entry and Assets) along with entry/entries details.\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeEmbeddedItems().fetch();\n */\n includeEmbeddedItems(): this {\n this._queryParams['include_embedded_items[]'] = 'BASE';\n\n return this;\n }\n\n /**\n * @method includeReference\n * @memberof Entry\n * @description To include the content of the referred entry in your response,\n * you need to use the include[] parameter and specify the UID of the reference field as value.\n * This function sets the include parameter to a reference field UID in the API request.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(entry_uid).includeReference(\"brand\").fetch()\n *\n * @param {string} referenceFieldUid - UID of the reference field to include.\n * @returns {Entry} - Returns the Entry instance for chaining.\n */\n includeReference(...referenceFieldUid: (string | string[])[]): this {\n if (referenceFieldUid.length) {\n referenceFieldUid.forEach(value => {\n if (!Array.isArray(this._queryParams['include[]'])) {\n this._queryParams['include[]'] = [];\n }\n (this._queryParams['include[]'] as string[]).push(...(Array.isArray(value) ? value : [value]));\n });\n } else {\n console.error(ErrorMessages.INVALID_ARGUMENT_STRING_OR_ARRAY);\n }\n return this;\n }\n\n /**\n * @method includeContentType\n * @memberof Entry\n * @description Include the details of the content type along with the entries details\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeContentType().fetch();\n */\n includeContentType(): this {\n this._queryParams.include_content_type = 'true';\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Entry\n * @description Includes the branch in result\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeBranch().fetch();\n */\n includeBranch(): this {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Entry\n * @description The entry published in the locale will be fetched\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('contentTypeUid').entry('entryUid').locale('en-us').fetch();\n */\n locale(locale: string): this {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method fetch\n * @memberof Entry\n * @description Fetches the entry data on the basis of the entry uid\n * @returns {Promise<T>} Promise that resolves to the entry data\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).fetch();\n */\n async fetch<T>(): Promise<T> {\n const getRequestOptions: any = { \n params: this._queryParams,\n // Add contentTypeUid and entryUid to config for improved caching\n contentTypeUid: this._contentTypeUid,\n entryUid: this._entryUid\n };\n if (this._variants) {\n getRequestOptions.headers = {\n ...getRequestOptions.headers,\n 'x-cs-variant-uid': this._variants\n };\n }\n\n const response = await getData(this._client, this._urlPath, getRequestOptions);\n\n if (response.entry) return response.entry as T;\n\n return response;\n }\n\n /**\n * @method addParams\n * @memberof Entry\n * @description Adds a query parameter to the query.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").addParams({\"key\": \"value\"}).fetch()\n *\n * @returns {Entry}\n */\n addParams(paramObj: { [key: string]: string | number | string[] }): this {\n this._queryParams = { ...this._queryParams, ...paramObj };\n\n return this;\n }\n\n /**\n * @method except\n * @memberof Entry\n * @description Excludes specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").except(\"fieldUID\").fetch()\n *\n * @param {string} fieldUid - field uid to exclude\n * @returns {Entry} - returns Entry object for chaining method calls\n */\n except(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`except[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"except[BASE][]\"] = fieldUid;\n }\n\n return this;\n }\n\n /**\n * @method only\n * @memberof Entry\n * @description Selects specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").only(\"fieldUID\").fetch()\n *\n * @param {string} fieldUid - field uid to select\n * @returns {Entry} - returns Entry object for chaining method calls\n */\n only(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`only[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"only[BASE][]\"] = fieldUid;\n }\n return this;\n }\n}\n"],"names":["ErrorMessages","getData"],"mappings":";;;;;;;;AAMO,MAAM,KAAM,CAAA;AAAA,EAOjB,WAAA,CAAY,MAAuB,EAAA,cAAA,EAAwB,QAAkB,EAAA;AAN7E,IAAU,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACV,IAAQ,aAAA,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AACR,IAAU,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACV,IAAA,aAAA,CAAA,IAAA,EAAA,cAAA,EAA8D,EAAC,CAAA,CAAA;AAE7D,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,cAAA,CAAA;AACvB,IAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AACjB,IAAA,IAAA,CAAK,WAAW,CAAkB,eAAA,EAAA,IAAA,CAAK,eAAe,CAAA,SAAA,EAAY,KAAK,SAAS,CAAA,CAAA,CAAA;AAChF,IAAA,IAAA,CAAK,SAAY,GAAA,EAAA,CAAA;AAAA,GACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAwB,GAAA;AACtB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,SAAS,QAAmC,EAAA;AAC1C,IAAA,IAAI,MAAM,OAAQ,CAAA,QAAQ,CAAK,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAClD,MAAK,IAAA,CAAA,SAAA,GAAY,QAAS,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,eACzB,OAAO,QAAA,IAAY,QAAY,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAC7D,MAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AAAA,KACnB;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAwB,GAAA;AACtB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,oBAA6B,GAAA;AAC3B,IAAK,IAAA,CAAA,YAAA,CAAa,0BAA0B,CAAI,GAAA,MAAA,CAAA;AAEhD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,oBAAoB,iBAAgD,EAAA;AAClE,IAAA,IAAI,kBAAkB,MAAQ,EAAA;AAC5B,MAAA,iBAAA,CAAkB,QAAQ,CAAS,KAAA,KAAA;AACjC,QAAA,IAAI,CAAC,KAAM,CAAA,OAAA,CAAQ,KAAK,YAAa,CAAA,WAAW,CAAC,CAAG,EAAA;AAClD,UAAK,IAAA,CAAA,YAAA,CAAa,WAAW,CAAA,GAAI,EAAC,CAAA;AAAA,SACpC;AACA,QAAC,IAAK,CAAA,YAAA,CAAa,WAAW,CAAA,CAAe,IAAK,CAAA,GAAI,KAAM,CAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAQ,GAAA,CAAC,KAAK,CAAE,CAAA,CAAA;AAAA,OAC9F,CAAA,CAAA;AAAA,KACI,MAAA;AACL,MAAQ,OAAA,CAAA,KAAA,CAAMA,4BAAc,gCAAgC,CAAA,CAAA;AAAA,KAC9D;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,kBAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,oBAAuB,GAAA,MAAA,CAAA;AAEzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAsB,GAAA;AACpB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,OAAO,MAAsB,EAAA;AAC3B,IAAA,IAAA,CAAK,aAAa,MAAS,GAAA,MAAA,CAAA;AAE3B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,KAAuB,GAAA;AAC3B,IAAA,MAAM,iBAAyB,GAAA;AAAA,MAC7B,QAAQ,IAAK,CAAA,YAAA;AAAA;AAAA,MAEb,gBAAgB,IAAK,CAAA,eAAA;AAAA,MACrB,UAAU,IAAK,CAAA,SAAA;AAAA,KACjB,CAAA;AACA,IAAA,IAAI,KAAK,SAAW,EAAA;AAClB,MAAA,iBAAA,CAAkB,OAAU,GAAA;AAAA,QAC1B,GAAG,iBAAkB,CAAA,OAAA;AAAA,QACrB,oBAAoB,IAAK,CAAA,SAAA;AAAA,OAC3B,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,WAAW,MAAMC,YAAA,CAAQ,KAAK,OAAS,EAAA,IAAA,CAAK,UAAU,iBAAiB,CAAA,CAAA;AAE7E,IAAI,IAAA,QAAA,CAAS,KAAO,EAAA,OAAO,QAAS,CAAA,KAAA,CAAA;AAEpC,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,UAAU,QAA+D,EAAA;AACvE,IAAA,IAAA,CAAK,eAAe,EAAE,GAAG,IAAK,CAAA,YAAA,EAAc,GAAG,QAAS,EAAA,CAAA;AAExD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,QAAiC,EAAA;AACtC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,aAAA,EAAgB,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AAC1C,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,QAAA,CAAA;AAAA,KACxC;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,KAAK,QAAiC,EAAA;AACpC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,WAAA,EAAc,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AACxC,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,cAAc,CAAI,GAAA,QAAA,CAAA;AAAA,KACtC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"entry.cjs","sources":["../../../src/entries/entry.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\nimport { ErrorMessages } from '../common/error-messages';\n\ninterface EntryResponse<T> {\n entry: T;\n}\nexport class Entry {\n protected _client: AxiosInstance;\n private _contentTypeUid: string;\n private _entryUid: string;\n private _urlPath: string;\n protected _variants: string;\n _queryParams: { [key: string]: string | number | string[] } = {};\n constructor(client: AxiosInstance, contentTypeUid: string, entryUid: string) {\n this._client = client;\n this._contentTypeUid = contentTypeUid;\n this._entryUid = entryUid;\n this._urlPath = `/content_types/${this._contentTypeUid}/entries/${this._entryUid}`;\n this._variants = '';\n }\n\n /**\n * @method includeFallback\n * @memberof Entry\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeFallback().fetch();\n */\n includeFallback(): this {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method variants\n * @memberof Entry\n * @description The variant header will be added to axios client\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('abc').entry('entry_uid').variants('xyz').fetch();\n */\n variants(variants: string | string[]): this {\n if (Array.isArray(variants) && variants.length > 0) {\n this._variants = variants.join(',');\n } else if (typeof variants == 'string' && variants.length > 0) {\n this._variants = variants;\n }\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Entry\n * @description Include the metadata for getting metadata content for the entry.\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeMetadata().fetch();\n */\n includeMetadata(): this {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeEmbeddedItems\n * @memberof Entry\n * @description Include Embedded Objects (Entry and Assets) along with entry/entries details.\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeEmbeddedItems().fetch();\n */\n includeEmbeddedItems(): this {\n this._queryParams['include_embedded_items[]'] = 'BASE';\n\n return this;\n }\n\n /**\n * @method includeReference\n * @memberof Entry\n * @description To include the content of the referred entry in your response,\n * you need to use the include[] parameter and specify the UID of the reference field as value.\n * This function sets the include parameter to a reference field UID in the API request.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(entry_uid).includeReference(\"brand\").fetch()\n *\n * @param {string} referenceFieldUid - UID of the reference field to include.\n * @returns {Entry} - Returns the Entry instance for chaining.\n */\n includeReference(...referenceFieldUid: (string | string[])[]): this {\n if (referenceFieldUid.length) {\n referenceFieldUid.forEach(value => {\n if (!Array.isArray(this._queryParams['include[]'])) {\n this._queryParams['include[]'] = [];\n }\n (this._queryParams['include[]'] as string[]).push(...(Array.isArray(value) ? value : [value]));\n });\n } else {\n console.error(ErrorMessages.INVALID_ARGUMENT_STRING_OR_ARRAY);\n }\n return this;\n }\n\n /**\n * @method includeContentType\n * @memberof Entry\n * @description Include the details of the content type along with the entries details\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeContentType().fetch();\n */\n includeContentType(): this {\n this._queryParams.include_content_type = 'true';\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Entry\n * @description Includes the branch in result\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeBranch().fetch();\n */\n includeBranch(): this {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Entry\n * @description The entry published in the locale will be fetched\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('contentTypeUid').entry('entryUid').locale('en-us').fetch();\n */\n locale(locale: string): this {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method fetch\n * @memberof Entry\n * @description Fetches the entry data on the basis of the entry uid\n * @returns {Promise<T>} Promise that resolves to the entry data\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).fetch();\n */\n async fetch<T>(): Promise<T> {\n const getRequestOptions: any = { \n params: this._queryParams,\n // Add contentTypeUid and entryUid to config for improved caching\n contentTypeUid: this._contentTypeUid,\n entryUid: this._entryUid\n };\n if (this._variants) {\n getRequestOptions.headers = {\n ...getRequestOptions.headers,\n 'x-cs-variant-uid': this._variants\n };\n }\n\n const response = await getData(this._client, this._urlPath, getRequestOptions);\n\n if (response.entry) return response.entry as T;\n\n return response;\n }\n\n /**\n * @method addParams\n * @memberof Entry\n * @description Adds a query parameter to the query.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").addParams({\"key\": \"value\"}).fetch()\n *\n * @returns {Entry}\n */\n addParams(paramObj: { [key: string]: string | number | string[] }): this {\n this._queryParams = { ...this._queryParams, ...paramObj };\n\n return this;\n }\n\n /**\n * @method except\n * @memberof Entry\n * @description Excludes specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").except(\"fieldUID\").fetch()\n *\n * @param {string} fieldUid - field uid to exclude\n * @returns {Entry} - returns Entry object for chaining method calls\n */\n except(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`except[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"except[BASE][]\"] = fieldUid;\n }\n\n return this;\n }\n\n /**\n * @method only\n * @memberof Entry\n * @description Selects specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").only(\"fieldUID\").fetch()\n *\n * @param {string} fieldUid - field uid to select\n * @returns {Entry} - returns Entry object for chaining method calls\n */\n only(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`only[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"only[BASE][]\"] = fieldUid;\n }\n return this;\n }\n\n /**\n * @method assetFields\n * @memberof Entry\n * @description Include specific asset fields in the response (CDA getEntry).\n * Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").assetFields(\"user_defined_fields\", \"embedded_metadata\").fetch();\n *\n * @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)\n * @returns {Entry} - Returns the Entry instance for chaining.\n */\n assetFields(...fields: string[]): this {\n if (fields.length > 0) {\n this._queryParams['asset_fields[]'] = fields;\n }\n return this;\n }\n}\n"],"names":["ErrorMessages","getData"],"mappings":";;;;;;;;AAMO,MAAM,KAAM,CAAA;AAAA,EAOjB,WAAA,CAAY,MAAuB,EAAA,cAAA,EAAwB,QAAkB,EAAA;AAN7E,IAAU,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACV,IAAQ,aAAA,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AACR,IAAU,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACV,IAAA,aAAA,CAAA,IAAA,EAAA,cAAA,EAA8D,EAAC,CAAA,CAAA;AAE7D,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,cAAA,CAAA;AACvB,IAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AACjB,IAAA,IAAA,CAAK,WAAW,CAAkB,eAAA,EAAA,IAAA,CAAK,eAAe,CAAA,SAAA,EAAY,KAAK,SAAS,CAAA,CAAA,CAAA;AAChF,IAAA,IAAA,CAAK,SAAY,GAAA,EAAA,CAAA;AAAA,GACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAwB,GAAA;AACtB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,SAAS,QAAmC,EAAA;AAC1C,IAAA,IAAI,MAAM,OAAQ,CAAA,QAAQ,CAAK,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAClD,MAAK,IAAA,CAAA,SAAA,GAAY,QAAS,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,eACzB,OAAO,QAAA,IAAY,QAAY,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAC7D,MAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AAAA,KACnB;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAwB,GAAA;AACtB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,oBAA6B,GAAA;AAC3B,IAAK,IAAA,CAAA,YAAA,CAAa,0BAA0B,CAAI,GAAA,MAAA,CAAA;AAEhD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,oBAAoB,iBAAgD,EAAA;AAClE,IAAA,IAAI,kBAAkB,MAAQ,EAAA;AAC5B,MAAA,iBAAA,CAAkB,QAAQ,CAAS,KAAA,KAAA;AACjC,QAAA,IAAI,CAAC,KAAM,CAAA,OAAA,CAAQ,KAAK,YAAa,CAAA,WAAW,CAAC,CAAG,EAAA;AAClD,UAAK,IAAA,CAAA,YAAA,CAAa,WAAW,CAAA,GAAI,EAAC,CAAA;AAAA,SACpC;AACA,QAAC,IAAK,CAAA,YAAA,CAAa,WAAW,CAAA,CAAe,IAAK,CAAA,GAAI,KAAM,CAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAQ,GAAA,CAAC,KAAK,CAAE,CAAA,CAAA;AAAA,OAC9F,CAAA,CAAA;AAAA,KACI,MAAA;AACL,MAAQ,OAAA,CAAA,KAAA,CAAMA,4BAAc,gCAAgC,CAAA,CAAA;AAAA,KAC9D;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,kBAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,oBAAuB,GAAA,MAAA,CAAA;AAEzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAsB,GAAA;AACpB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,OAAO,MAAsB,EAAA;AAC3B,IAAA,IAAA,CAAK,aAAa,MAAS,GAAA,MAAA,CAAA;AAE3B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,KAAuB,GAAA;AAC3B,IAAA,MAAM,iBAAyB,GAAA;AAAA,MAC7B,QAAQ,IAAK,CAAA,YAAA;AAAA;AAAA,MAEb,gBAAgB,IAAK,CAAA,eAAA;AAAA,MACrB,UAAU,IAAK,CAAA,SAAA;AAAA,KACjB,CAAA;AACA,IAAA,IAAI,KAAK,SAAW,EAAA;AAClB,MAAA,iBAAA,CAAkB,OAAU,GAAA;AAAA,QAC1B,GAAG,iBAAkB,CAAA,OAAA;AAAA,QACrB,oBAAoB,IAAK,CAAA,SAAA;AAAA,OAC3B,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,WAAW,MAAMC,YAAA,CAAQ,KAAK,OAAS,EAAA,IAAA,CAAK,UAAU,iBAAiB,CAAA,CAAA;AAE7E,IAAI,IAAA,QAAA,CAAS,KAAO,EAAA,OAAO,QAAS,CAAA,KAAA,CAAA;AAEpC,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,UAAU,QAA+D,EAAA;AACvE,IAAA,IAAA,CAAK,eAAe,EAAE,GAAG,IAAK,CAAA,YAAA,EAAc,GAAG,QAAS,EAAA,CAAA;AAExD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,QAAiC,EAAA;AACtC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,aAAA,EAAgB,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AAC1C,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,QAAA,CAAA;AAAA,KACxC;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,KAAK,QAAiC,EAAA;AACpC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,WAAA,EAAc,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AACxC,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,cAAc,CAAI,GAAA,QAAA,CAAA;AAAA,KACtC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,eAAe,MAAwB,EAAA;AACrC,IAAI,IAAA,MAAA,CAAO,SAAS,CAAG,EAAA;AACrB,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,MAAA,CAAA;AAAA,KACxC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
|
@@ -249,6 +249,26 @@ class Entry {
|
|
|
249
249
|
}
|
|
250
250
|
return this;
|
|
251
251
|
}
|
|
252
|
+
/**
|
|
253
|
+
* @method assetFields
|
|
254
|
+
* @memberof Entry
|
|
255
|
+
* @description Include specific asset fields in the response (CDA getEntry).
|
|
256
|
+
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
|
|
257
|
+
* @example
|
|
258
|
+
* import contentstack from '@contentstack/delivery-sdk'
|
|
259
|
+
*
|
|
260
|
+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
261
|
+
* const result = await stack.contentType("contentTypeUid").entry("entryUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
|
|
262
|
+
*
|
|
263
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
|
|
264
|
+
* @returns {Entry} - Returns the Entry instance for chaining.
|
|
265
|
+
*/
|
|
266
|
+
assetFields(...fields) {
|
|
267
|
+
if (fields.length > 0) {
|
|
268
|
+
this._queryParams["asset_fields[]"] = fields;
|
|
269
|
+
}
|
|
270
|
+
return this;
|
|
271
|
+
}
|
|
252
272
|
}
|
|
253
273
|
|
|
254
274
|
export { Entry };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entry.js","sources":["../../../src/entries/entry.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\nimport { ErrorMessages } from '../common/error-messages';\n\ninterface EntryResponse<T> {\n entry: T;\n}\nexport class Entry {\n protected _client: AxiosInstance;\n private _contentTypeUid: string;\n private _entryUid: string;\n private _urlPath: string;\n protected _variants: string;\n _queryParams: { [key: string]: string | number | string[] } = {};\n constructor(client: AxiosInstance, contentTypeUid: string, entryUid: string) {\n this._client = client;\n this._contentTypeUid = contentTypeUid;\n this._entryUid = entryUid;\n this._urlPath = `/content_types/${this._contentTypeUid}/entries/${this._entryUid}`;\n this._variants = '';\n }\n\n /**\n * @method includeFallback\n * @memberof Entry\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeFallback().fetch();\n */\n includeFallback(): this {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method variants\n * @memberof Entry\n * @description The variant header will be added to axios client\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('abc').entry('entry_uid').variants('xyz').fetch();\n */\n variants(variants: string | string[]): this {\n if (Array.isArray(variants) && variants.length > 0) {\n this._variants = variants.join(',');\n } else if (typeof variants == 'string' && variants.length > 0) {\n this._variants = variants;\n }\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Entry\n * @description Include the metadata for getting metadata content for the entry.\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeMetadata().fetch();\n */\n includeMetadata(): this {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeEmbeddedItems\n * @memberof Entry\n * @description Include Embedded Objects (Entry and Assets) along with entry/entries details.\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeEmbeddedItems().fetch();\n */\n includeEmbeddedItems(): this {\n this._queryParams['include_embedded_items[]'] = 'BASE';\n\n return this;\n }\n\n /**\n * @method includeReference\n * @memberof Entry\n * @description To include the content of the referred entry in your response,\n * you need to use the include[] parameter and specify the UID of the reference field as value.\n * This function sets the include parameter to a reference field UID in the API request.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(entry_uid).includeReference(\"brand\").fetch()\n *\n * @param {string} referenceFieldUid - UID of the reference field to include.\n * @returns {Entry} - Returns the Entry instance for chaining.\n */\n includeReference(...referenceFieldUid: (string | string[])[]): this {\n if (referenceFieldUid.length) {\n referenceFieldUid.forEach(value => {\n if (!Array.isArray(this._queryParams['include[]'])) {\n this._queryParams['include[]'] = [];\n }\n (this._queryParams['include[]'] as string[]).push(...(Array.isArray(value) ? value : [value]));\n });\n } else {\n console.error(ErrorMessages.INVALID_ARGUMENT_STRING_OR_ARRAY);\n }\n return this;\n }\n\n /**\n * @method includeContentType\n * @memberof Entry\n * @description Include the details of the content type along with the entries details\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeContentType().fetch();\n */\n includeContentType(): this {\n this._queryParams.include_content_type = 'true';\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Entry\n * @description Includes the branch in result\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeBranch().fetch();\n */\n includeBranch(): this {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Entry\n * @description The entry published in the locale will be fetched\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('contentTypeUid').entry('entryUid').locale('en-us').fetch();\n */\n locale(locale: string): this {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method fetch\n * @memberof Entry\n * @description Fetches the entry data on the basis of the entry uid\n * @returns {Promise<T>} Promise that resolves to the entry data\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).fetch();\n */\n async fetch<T>(): Promise<T> {\n const getRequestOptions: any = { \n params: this._queryParams,\n // Add contentTypeUid and entryUid to config for improved caching\n contentTypeUid: this._contentTypeUid,\n entryUid: this._entryUid\n };\n if (this._variants) {\n getRequestOptions.headers = {\n ...getRequestOptions.headers,\n 'x-cs-variant-uid': this._variants\n };\n }\n\n const response = await getData(this._client, this._urlPath, getRequestOptions);\n\n if (response.entry) return response.entry as T;\n\n return response;\n }\n\n /**\n * @method addParams\n * @memberof Entry\n * @description Adds a query parameter to the query.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").addParams({\"key\": \"value\"}).fetch()\n *\n * @returns {Entry}\n */\n addParams(paramObj: { [key: string]: string | number | string[] }): this {\n this._queryParams = { ...this._queryParams, ...paramObj };\n\n return this;\n }\n\n /**\n * @method except\n * @memberof Entry\n * @description Excludes specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").except(\"fieldUID\").fetch()\n *\n * @param {string} fieldUid - field uid to exclude\n * @returns {Entry} - returns Entry object for chaining method calls\n */\n except(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`except[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"except[BASE][]\"] = fieldUid;\n }\n\n return this;\n }\n\n /**\n * @method only\n * @memberof Entry\n * @description Selects specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").only(\"fieldUID\").fetch()\n *\n * @param {string} fieldUid - field uid to select\n * @returns {Entry} - returns Entry object for chaining method calls\n */\n only(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`only[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"only[BASE][]\"] = fieldUid;\n }\n return this;\n }\n}\n"],"names":[],"mappings":";;;;;;AAMO,MAAM,KAAM,CAAA;AAAA,EAOjB,WAAA,CAAY,MAAuB,EAAA,cAAA,EAAwB,QAAkB,EAAA;AAN7E,IAAU,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACV,IAAQ,aAAA,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AACR,IAAU,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACV,IAAA,aAAA,CAAA,IAAA,EAAA,cAAA,EAA8D,EAAC,CAAA,CAAA;AAE7D,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,cAAA,CAAA;AACvB,IAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AACjB,IAAA,IAAA,CAAK,WAAW,CAAkB,eAAA,EAAA,IAAA,CAAK,eAAe,CAAA,SAAA,EAAY,KAAK,SAAS,CAAA,CAAA,CAAA;AAChF,IAAA,IAAA,CAAK,SAAY,GAAA,EAAA,CAAA;AAAA,GACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAwB,GAAA;AACtB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,SAAS,QAAmC,EAAA;AAC1C,IAAA,IAAI,MAAM,OAAQ,CAAA,QAAQ,CAAK,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAClD,MAAK,IAAA,CAAA,SAAA,GAAY,QAAS,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,eACzB,OAAO,QAAA,IAAY,QAAY,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAC7D,MAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AAAA,KACnB;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAwB,GAAA;AACtB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,oBAA6B,GAAA;AAC3B,IAAK,IAAA,CAAA,YAAA,CAAa,0BAA0B,CAAI,GAAA,MAAA,CAAA;AAEhD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,oBAAoB,iBAAgD,EAAA;AAClE,IAAA,IAAI,kBAAkB,MAAQ,EAAA;AAC5B,MAAA,iBAAA,CAAkB,QAAQ,CAAS,KAAA,KAAA;AACjC,QAAA,IAAI,CAAC,KAAM,CAAA,OAAA,CAAQ,KAAK,YAAa,CAAA,WAAW,CAAC,CAAG,EAAA;AAClD,UAAK,IAAA,CAAA,YAAA,CAAa,WAAW,CAAA,GAAI,EAAC,CAAA;AAAA,SACpC;AACA,QAAC,IAAK,CAAA,YAAA,CAAa,WAAW,CAAA,CAAe,IAAK,CAAA,GAAI,KAAM,CAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAQ,GAAA,CAAC,KAAK,CAAE,CAAA,CAAA;AAAA,OAC9F,CAAA,CAAA;AAAA,KACI,MAAA;AACL,MAAQ,OAAA,CAAA,KAAA,CAAM,cAAc,gCAAgC,CAAA,CAAA;AAAA,KAC9D;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,kBAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,oBAAuB,GAAA,MAAA,CAAA;AAEzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAsB,GAAA;AACpB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,OAAO,MAAsB,EAAA;AAC3B,IAAA,IAAA,CAAK,aAAa,MAAS,GAAA,MAAA,CAAA;AAE3B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,KAAuB,GAAA;AAC3B,IAAA,MAAM,iBAAyB,GAAA;AAAA,MAC7B,QAAQ,IAAK,CAAA,YAAA;AAAA;AAAA,MAEb,gBAAgB,IAAK,CAAA,eAAA;AAAA,MACrB,UAAU,IAAK,CAAA,SAAA;AAAA,KACjB,CAAA;AACA,IAAA,IAAI,KAAK,SAAW,EAAA;AAClB,MAAA,iBAAA,CAAkB,OAAU,GAAA;AAAA,QAC1B,GAAG,iBAAkB,CAAA,OAAA;AAAA,QACrB,oBAAoB,IAAK,CAAA,SAAA;AAAA,OAC3B,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,WAAW,MAAM,OAAA,CAAQ,KAAK,OAAS,EAAA,IAAA,CAAK,UAAU,iBAAiB,CAAA,CAAA;AAE7E,IAAI,IAAA,QAAA,CAAS,KAAO,EAAA,OAAO,QAAS,CAAA,KAAA,CAAA;AAEpC,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,UAAU,QAA+D,EAAA;AACvE,IAAA,IAAA,CAAK,eAAe,EAAE,GAAG,IAAK,CAAA,YAAA,EAAc,GAAG,QAAS,EAAA,CAAA;AAExD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,QAAiC,EAAA;AACtC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,aAAA,EAAgB,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AAC1C,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,QAAA,CAAA;AAAA,KACxC;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,KAAK,QAAiC,EAAA;AACpC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,WAAA,EAAc,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AACxC,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,cAAc,CAAI,GAAA,QAAA,CAAA;AAAA,KACtC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"entry.js","sources":["../../../src/entries/entry.ts"],"sourcesContent":["import { AxiosInstance, getData } from '@contentstack/core';\nimport { ErrorMessages } from '../common/error-messages';\n\ninterface EntryResponse<T> {\n entry: T;\n}\nexport class Entry {\n protected _client: AxiosInstance;\n private _contentTypeUid: string;\n private _entryUid: string;\n private _urlPath: string;\n protected _variants: string;\n _queryParams: { [key: string]: string | number | string[] } = {};\n constructor(client: AxiosInstance, contentTypeUid: string, entryUid: string) {\n this._client = client;\n this._contentTypeUid = contentTypeUid;\n this._entryUid = entryUid;\n this._urlPath = `/content_types/${this._contentTypeUid}/entries/${this._entryUid}`;\n this._variants = '';\n }\n\n /**\n * @method includeFallback\n * @memberof Entry\n * @description When an entry is not published in a specific language, content can be fetched from its fallback language\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeFallback().fetch();\n */\n includeFallback(): this {\n this._queryParams.include_fallback = 'true';\n\n return this;\n }\n\n /**\n * @method variants\n * @memberof Entry\n * @description The variant header will be added to axios client\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('abc').entry('entry_uid').variants('xyz').fetch();\n */\n variants(variants: string | string[]): this {\n if (Array.isArray(variants) && variants.length > 0) {\n this._variants = variants.join(',');\n } else if (typeof variants == 'string' && variants.length > 0) {\n this._variants = variants;\n }\n\n return this;\n }\n\n /**\n * @method includeMetadata\n * @memberof Entry\n * @description Include the metadata for getting metadata content for the entry.\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeMetadata().fetch();\n */\n includeMetadata(): this {\n this._queryParams.include_metadata = 'true';\n\n return this;\n }\n\n /**\n * @method includeEmbeddedItems\n * @memberof Entry\n * @description Include Embedded Objects (Entry and Assets) along with entry/entries details.\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeEmbeddedItems().fetch();\n */\n includeEmbeddedItems(): this {\n this._queryParams['include_embedded_items[]'] = 'BASE';\n\n return this;\n }\n\n /**\n * @method includeReference\n * @memberof Entry\n * @description To include the content of the referred entry in your response,\n * you need to use the include[] parameter and specify the UID of the reference field as value.\n * This function sets the include parameter to a reference field UID in the API request.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(entry_uid).includeReference(\"brand\").fetch()\n *\n * @param {string} referenceFieldUid - UID of the reference field to include.\n * @returns {Entry} - Returns the Entry instance for chaining.\n */\n includeReference(...referenceFieldUid: (string | string[])[]): this {\n if (referenceFieldUid.length) {\n referenceFieldUid.forEach(value => {\n if (!Array.isArray(this._queryParams['include[]'])) {\n this._queryParams['include[]'] = [];\n }\n (this._queryParams['include[]'] as string[]).push(...(Array.isArray(value) ? value : [value]));\n });\n } else {\n console.error(ErrorMessages.INVALID_ARGUMENT_STRING_OR_ARRAY);\n }\n return this;\n }\n\n /**\n * @method includeContentType\n * @memberof Entry\n * @description Include the details of the content type along with the entries details\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeContentType().fetch();\n */\n includeContentType(): this {\n this._queryParams.include_content_type = 'true';\n\n return this;\n }\n\n /**\n * @method includeBranch\n * @memberof Entry\n * @description Includes the branch in result\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).includeBranch().fetch();\n */\n includeBranch(): this {\n this._queryParams.include_branch = 'true';\n\n return this;\n }\n\n /**\n * @method locale\n * @memberof Entry\n * @description The entry published in the locale will be fetched\n * @returns {Entry}\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType('contentTypeUid').entry('entryUid').locale('en-us').fetch();\n */\n locale(locale: string): this {\n this._queryParams.locale = locale;\n\n return this;\n }\n\n /**\n * @method fetch\n * @memberof Entry\n * @description Fetches the entry data on the basis of the entry uid\n * @returns {Promise<T>} Promise that resolves to the entry data\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(contentType_uid).entry(entry_uid).fetch();\n */\n async fetch<T>(): Promise<T> {\n const getRequestOptions: any = { \n params: this._queryParams,\n // Add contentTypeUid and entryUid to config for improved caching\n contentTypeUid: this._contentTypeUid,\n entryUid: this._entryUid\n };\n if (this._variants) {\n getRequestOptions.headers = {\n ...getRequestOptions.headers,\n 'x-cs-variant-uid': this._variants\n };\n }\n\n const response = await getData(this._client, this._urlPath, getRequestOptions);\n\n if (response.entry) return response.entry as T;\n\n return response;\n }\n\n /**\n * @method addParams\n * @memberof Entry\n * @description Adds a query parameter to the query.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").addParams({\"key\": \"value\"}).fetch()\n *\n * @returns {Entry}\n */\n addParams(paramObj: { [key: string]: string | number | string[] }): this {\n this._queryParams = { ...this._queryParams, ...paramObj };\n\n return this;\n }\n\n /**\n * @method except\n * @memberof Entry\n * @description Excludes specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").except(\"fieldUID\").fetch()\n *\n * @param {string} fieldUid - field uid to exclude\n * @returns {Entry} - returns Entry object for chaining method calls\n */\n except(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`except[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"except[BASE][]\"] = fieldUid;\n }\n\n return this;\n }\n\n /**\n * @method only\n * @memberof Entry\n * @description Selects specific field/fields of an entry\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").only(\"fieldUID\").fetch()\n *\n * @param {string} fieldUid - field uid to select\n * @returns {Entry} - returns Entry object for chaining method calls\n */\n only(fieldUid: string|string[]): this {\n if (Array.isArray(fieldUid)) {\n let i = 0;\n for (const uid of fieldUid) {\n this._queryParams[`only[BASE][${i}]`] = uid;\n i++;\n }\n } else {\n this._queryParams[\"only[BASE][]\"] = fieldUid;\n }\n return this;\n }\n\n /**\n * @method assetFields\n * @memberof Entry\n * @description Include specific asset fields in the response (CDA getEntry).\n * Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.\n * @example\n * import contentstack from '@contentstack/delivery-sdk'\n *\n * const stack = contentstack.stack({ apiKey: \"apiKey\", deliveryToken: \"deliveryToken\", environment: \"environment\" });\n * const result = await stack.contentType(\"contentTypeUid\").entry(\"entryUid\").assetFields(\"user_defined_fields\", \"embedded_metadata\").fetch();\n *\n * @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)\n * @returns {Entry} - Returns the Entry instance for chaining.\n */\n assetFields(...fields: string[]): this {\n if (fields.length > 0) {\n this._queryParams['asset_fields[]'] = fields;\n }\n return this;\n }\n}\n"],"names":[],"mappings":";;;;;;AAMO,MAAM,KAAM,CAAA;AAAA,EAOjB,WAAA,CAAY,MAAuB,EAAA,cAAA,EAAwB,QAAkB,EAAA;AAN7E,IAAU,aAAA,CAAA,IAAA,EAAA,SAAA,CAAA,CAAA;AACV,IAAQ,aAAA,CAAA,IAAA,EAAA,iBAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACR,IAAQ,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AACR,IAAU,aAAA,CAAA,IAAA,EAAA,WAAA,CAAA,CAAA;AACV,IAAA,aAAA,CAAA,IAAA,EAAA,cAAA,EAA8D,EAAC,CAAA,CAAA;AAE7D,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,eAAkB,GAAA,cAAA,CAAA;AACvB,IAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AACjB,IAAA,IAAA,CAAK,WAAW,CAAkB,eAAA,EAAA,IAAA,CAAK,eAAe,CAAA,SAAA,EAAY,KAAK,SAAS,CAAA,CAAA,CAAA;AAChF,IAAA,IAAA,CAAK,SAAY,GAAA,EAAA,CAAA;AAAA,GACnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAwB,GAAA;AACtB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,SAAS,QAAmC,EAAA;AAC1C,IAAA,IAAI,MAAM,OAAQ,CAAA,QAAQ,CAAK,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAClD,MAAK,IAAA,CAAA,SAAA,GAAY,QAAS,CAAA,IAAA,CAAK,GAAG,CAAA,CAAA;AAAA,eACzB,OAAO,QAAA,IAAY,QAAY,IAAA,QAAA,CAAS,SAAS,CAAG,EAAA;AAC7D,MAAA,IAAA,CAAK,SAAY,GAAA,QAAA,CAAA;AAAA,KACnB;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,eAAwB,GAAA;AACtB,IAAA,IAAA,CAAK,aAAa,gBAAmB,GAAA,MAAA,CAAA;AAErC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,oBAA6B,GAAA;AAC3B,IAAK,IAAA,CAAA,YAAA,CAAa,0BAA0B,CAAI,GAAA,MAAA,CAAA;AAEhD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,oBAAoB,iBAAgD,EAAA;AAClE,IAAA,IAAI,kBAAkB,MAAQ,EAAA;AAC5B,MAAA,iBAAA,CAAkB,QAAQ,CAAS,KAAA,KAAA;AACjC,QAAA,IAAI,CAAC,KAAM,CAAA,OAAA,CAAQ,KAAK,YAAa,CAAA,WAAW,CAAC,CAAG,EAAA;AAClD,UAAK,IAAA,CAAA,YAAA,CAAa,WAAW,CAAA,GAAI,EAAC,CAAA;AAAA,SACpC;AACA,QAAC,IAAK,CAAA,YAAA,CAAa,WAAW,CAAA,CAAe,IAAK,CAAA,GAAI,KAAM,CAAA,OAAA,CAAQ,KAAK,CAAA,GAAI,KAAQ,GAAA,CAAC,KAAK,CAAE,CAAA,CAAA;AAAA,OAC9F,CAAA,CAAA;AAAA,KACI,MAAA;AACL,MAAQ,OAAA,CAAA,KAAA,CAAM,cAAc,gCAAgC,CAAA,CAAA;AAAA,KAC9D;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,kBAA2B,GAAA;AACzB,IAAA,IAAA,CAAK,aAAa,oBAAuB,GAAA,MAAA,CAAA;AAEzC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,aAAsB,GAAA;AACpB,IAAA,IAAA,CAAK,aAAa,cAAiB,GAAA,MAAA,CAAA;AAEnC,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,OAAO,MAAsB,EAAA;AAC3B,IAAA,IAAA,CAAK,aAAa,MAAS,GAAA,MAAA,CAAA;AAE3B,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaA,MAAM,KAAuB,GAAA;AAC3B,IAAA,MAAM,iBAAyB,GAAA;AAAA,MAC7B,QAAQ,IAAK,CAAA,YAAA;AAAA;AAAA,MAEb,gBAAgB,IAAK,CAAA,eAAA;AAAA,MACrB,UAAU,IAAK,CAAA,SAAA;AAAA,KACjB,CAAA;AACA,IAAA,IAAI,KAAK,SAAW,EAAA;AAClB,MAAA,iBAAA,CAAkB,OAAU,GAAA;AAAA,QAC1B,GAAG,iBAAkB,CAAA,OAAA;AAAA,QACrB,oBAAoB,IAAK,CAAA,SAAA;AAAA,OAC3B,CAAA;AAAA,KACF;AAEA,IAAA,MAAM,WAAW,MAAM,OAAA,CAAQ,KAAK,OAAS,EAAA,IAAA,CAAK,UAAU,iBAAiB,CAAA,CAAA;AAE7E,IAAI,IAAA,QAAA,CAAS,KAAO,EAAA,OAAO,QAAS,CAAA,KAAA,CAAA;AAEpC,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,UAAU,QAA+D,EAAA;AACvE,IAAA,IAAA,CAAK,eAAe,EAAE,GAAG,IAAK,CAAA,YAAA,EAAc,GAAG,QAAS,EAAA,CAAA;AAExD,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,OAAO,QAAiC,EAAA;AACtC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,aAAA,EAAgB,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AAC1C,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,QAAA,CAAA;AAAA,KACxC;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAeA,KAAK,QAAiC,EAAA;AACpC,IAAI,IAAA,KAAA,CAAM,OAAQ,CAAA,QAAQ,CAAG,EAAA;AAC3B,MAAA,IAAI,CAAI,GAAA,CAAA,CAAA;AACR,MAAA,KAAA,MAAW,OAAO,QAAU,EAAA;AAC1B,QAAA,IAAA,CAAK,YAAa,CAAA,CAAA,WAAA,EAAc,CAAC,CAAA,CAAA,CAAG,CAAI,GAAA,GAAA,CAAA;AACxC,QAAA,CAAA,EAAA,CAAA;AAAA,OACF;AAAA,KACK,MAAA;AACL,MAAK,IAAA,CAAA,YAAA,CAAa,cAAc,CAAI,GAAA,QAAA,CAAA;AAAA,KACtC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,eAAe,MAAwB,EAAA;AACrC,IAAI,IAAA,MAAA,CAAO,SAAS,CAAG,EAAA;AACrB,MAAK,IAAA,CAAA,YAAA,CAAa,gBAAgB,CAAI,GAAA,MAAA,CAAA;AAAA,KACxC;AACA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACF;;;;"}
|
|
@@ -114,6 +114,26 @@ class AssetQuery extends baseQuery.BaseQuery {
|
|
|
114
114
|
this._queryParams.locale = locale;
|
|
115
115
|
return this;
|
|
116
116
|
}
|
|
117
|
+
/**
|
|
118
|
+
* @method assetFields
|
|
119
|
+
* @memberof AssetQuery
|
|
120
|
+
* @description Include specific asset fields in the response (CDA getAssets).
|
|
121
|
+
* Use with asset_fields[]: user_defined_fields, embedded, ai_suggested, visual_markups.
|
|
122
|
+
* @example
|
|
123
|
+
* import contentstack from '@contentstack/delivery-sdk'
|
|
124
|
+
*
|
|
125
|
+
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
126
|
+
* const result = await stack.asset().assetFields("user_defined_fields", "embedded_metadata").find();
|
|
127
|
+
*
|
|
128
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded, ai_suggested, visual_markups)
|
|
129
|
+
* @returns {AssetQuery} - Returns the AssetQuery instance for chaining.
|
|
130
|
+
*/
|
|
131
|
+
assetFields(...fields) {
|
|
132
|
+
if (fields.length > 0) {
|
|
133
|
+
this._queryParams["asset_fields[]"] = fields;
|
|
134
|
+
}
|
|
135
|
+
return this;
|
|
136
|
+
}
|
|
117
137
|
/**
|
|
118
138
|
* @method query
|
|
119
139
|
* @memberof AssetQuery
|