@contentstack/delivery-sdk 5.1.0 → 5.1.2
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 +2 -2
- package/dist/legacy/assets/asset.cjs.map +1 -1
- package/dist/legacy/assets/asset.js +2 -2
- package/dist/legacy/assets/asset.js.map +1 -1
- package/dist/legacy/common/types.cjs.map +1 -1
- package/dist/legacy/common/types.js.map +1 -1
- package/dist/legacy/entries/entries.cjs +2 -2
- package/dist/legacy/entries/entries.cjs.map +1 -1
- package/dist/legacy/entries/entries.js +2 -2
- package/dist/legacy/entries/entries.js.map +1 -1
- package/dist/legacy/entries/entry.cjs +2 -2
- package/dist/legacy/entries/entry.cjs.map +1 -1
- package/dist/legacy/entries/entry.js +2 -2
- package/dist/legacy/entries/entry.js.map +1 -1
- package/dist/legacy/query/asset-query.cjs +2 -2
- package/dist/legacy/query/asset-query.cjs.map +1 -1
- package/dist/legacy/query/asset-query.js +2 -2
- package/dist/legacy/query/asset-query.js.map +1 -1
- package/dist/legacy/query/query.cjs +1 -1
- package/dist/legacy/query/query.cjs.map +1 -1
- package/dist/legacy/query/query.js +1 -1
- package/dist/legacy/query/query.js.map +1 -1
- package/dist/modern/assets/asset.cjs +2 -2
- package/dist/modern/assets/asset.cjs.map +1 -1
- package/dist/modern/assets/asset.d.ts +2 -2
- package/dist/modern/assets/asset.js +2 -2
- package/dist/modern/assets/asset.js.map +1 -1
- package/dist/modern/common/types.cjs.map +1 -1
- package/dist/modern/common/types.d.ts +3 -2
- package/dist/modern/common/types.d.ts.map +1 -1
- package/dist/modern/common/types.js.map +1 -1
- package/dist/modern/entries/entries.cjs +2 -2
- package/dist/modern/entries/entries.cjs.map +1 -1
- package/dist/modern/entries/entries.d.ts +2 -2
- package/dist/modern/entries/entries.js +2 -2
- package/dist/modern/entries/entries.js.map +1 -1
- package/dist/modern/entries/entry.cjs +2 -2
- package/dist/modern/entries/entry.cjs.map +1 -1
- package/dist/modern/entries/entry.d.ts +2 -2
- package/dist/modern/entries/entry.js +2 -2
- package/dist/modern/entries/entry.js.map +1 -1
- package/dist/modern/query/asset-query.cjs +2 -2
- package/dist/modern/query/asset-query.cjs.map +1 -1
- package/dist/modern/query/asset-query.d.ts +2 -2
- package/dist/modern/query/asset-query.js +2 -2
- package/dist/modern/query/asset-query.js.map +1 -1
- package/dist/modern/query/query.cjs +1 -1
- package/dist/modern/query/query.cjs.map +1 -1
- package/dist/modern/query/query.js +1 -1
- package/dist/modern/query/query.js.map +1 -1
- package/package.json +11 -11
|
@@ -122,14 +122,14 @@ class Asset {
|
|
|
122
122
|
* @method assetFields
|
|
123
123
|
* @memberof Asset
|
|
124
124
|
* @description Include specific asset fields in the response (CDA getAssets - single asset).
|
|
125
|
-
* Use with asset_fields[]: user_defined_fields,
|
|
125
|
+
* Use with asset_fields[]: user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups.
|
|
126
126
|
* @example
|
|
127
127
|
* import contentstack from '@contentstack/delivery-sdk'
|
|
128
128
|
*
|
|
129
129
|
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
130
130
|
* const result = await stack.asset("assetUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
|
|
131
131
|
*
|
|
132
|
-
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields,
|
|
132
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups)
|
|
133
133
|
* @returns {Asset} - Returns the Asset instance for chaining.
|
|
134
134
|
*/
|
|
135
135
|
assetFields(...fields) {
|
|
@@ -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 | 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,
|
|
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_metadata, ai_generated_metadata, 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_metadata, ai_generated_metadata, 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;;;;"}
|
|
@@ -120,14 +120,14 @@ class Asset {
|
|
|
120
120
|
* @method assetFields
|
|
121
121
|
* @memberof Asset
|
|
122
122
|
* @description Include specific asset fields in the response (CDA getAssets - single asset).
|
|
123
|
-
* Use with asset_fields[]: user_defined_fields,
|
|
123
|
+
* Use with asset_fields[]: user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups.
|
|
124
124
|
* @example
|
|
125
125
|
* import contentstack from '@contentstack/delivery-sdk'
|
|
126
126
|
*
|
|
127
127
|
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
128
128
|
* const result = await stack.asset("assetUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
|
|
129
129
|
*
|
|
130
|
-
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields,
|
|
130
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups)
|
|
131
131
|
* @returns {Asset} - Returns the Asset instance for chaining.
|
|
132
132
|
*/
|
|
133
133
|
assetFields(...fields) {
|
|
@@ -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 | 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,
|
|
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_metadata, ai_generated_metadata, 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_metadata, ai_generated_metadata, 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;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.cjs","sources":["../../../src/common/types.ts"],"sourcesContent":["/* eslint-disable @cspell/spellchecker */\nimport { HttpClientParams } from \"@contentstack/core\";\nimport { AxiosRequestConfig, AxiosResponse } from \"axios\";\n\n/**\n * Contract for cache persistence. Use @contentstack/persistence-plugin or a custom implementation.\n */\nexport interface PersistenceStore {\n setItem(key: string, value: any, contentTypeUid?: string, maxAge?: number): void;\n getItem(key: string, contentTypeUid?: string): any;\n}\n\n// Internal Types\nexport type params = {\n [key: string]: any;\n};\n\nexport type queryParams = {\n [key: string]: string | boolean | number | string[];\n};\n\n/**\n * Interface for creating Contentstack plugins\n * \n * @example\n * ```typescript\n * import { ContentstackPlugin } from '@contentstack/delivery-sdk';\n * \n * class MyPlugin implements ContentstackPlugin {\n * onRequest(config: any): any {\n * // Modify request configuration\n * console.log('Processing request:', config.url);\n * return { ...config, headers: { ...config.headers, 'X-Custom-Header': 'value' } };\n * }\n * \n * onResponse(request: any, response: any, data: any): any {\n * // Process response data\n * console.log('Processing response:', response.status);\n * return { ...response, data: { ...data, processed: true } };\n * }\n * }\n * \n * const stack = contentstack.stack({\n * apiKey: 'your-api-key',\n * deliveryToken: 'your-delivery-token',\n * environment: 'your-environment',\n * plugins: [new MyPlugin()]\n * });\n * ```\n */\nexport interface ContentstackPlugin {\n /**\n * Called before each request is sent\n * @param config - Axios request configuration object (with possible custom properties)\n * @returns Modified request configuration (can be sync or async)\n */\n onRequest(config: any): any;\n\n /**\n * Called after each response is received\n * @param request - The original request configuration\n * @param response - Axios response object (with possible custom properties)\n * @param data - Response data\n * @returns Modified response object (can be sync or async)\n */\n onResponse(request: any, response: any, data: any): any;\n}\n\n// External Types\nexport enum Region {\n US = \"us\",\n EU = \"eu\",\n AU = \"au\",\n AZURE_NA = \"azure-na\",\n AZURE_EU = \"azure-eu\",\n GCP_NA = \"gcp-na\",\n GCP_EU = \"gcp-eu\",\n}\nexport interface StackConfig extends HttpClientParams {\n host?: string;\n apiKey: string;\n deliveryToken: string;\n environment: string;\n branch?: string;\n early_access?: string[];\n region?: Region | string;\n locale?: string;\n plugins?: ContentstackPlugin[];\n logHandler?: (level: string, data: any) => void;\n cacheOptions?: CacheOptions;\n live_preview?: LivePreview;\n port?: number;\n debug?: boolean;\n}\nexport interface CacheOptions {\n policy: Policy;\n /** Required when policy is not IGNORE_CACHE. Use @contentstack/persistence-plugin or a custom implementation. */\n persistenceStore?: PersistenceStore;\n /** Maximum age for cached items in milliseconds; passed to the store when writing. */\n maxAge?: number;\n}\n\nexport enum Policy {\n IGNORE_CACHE = \"IGNORE_CACHE\",\n CACHE_THEN_NETWORK = \"CACHE_THEN_NETWORK\",\n CACHE_ELSE_NETWORK = \"CACHE_ELSE_NETWORK\",\n NETWORK_ELSE_CACHE = \"NETWORK_ELSE_CACHE\",\n}\n\nexport interface SyncStack {\n paginationToken?: string;\n syncToken?: string;\n}\nexport enum PublishType {\n ENTRY_PUBLISHED = \"entry_published\",\n ENTRY_UNPUBLISHED = \"entry_unpublished\",\n ENTRY_DELETED = \"entry_deleted\",\n ASSET_PUBLISHED = \"asset_published\",\n ASSET_UNPUBLISHED = \"asset_unpublished\",\n ASSET_DELETED = \"asset_deleted\",\n CONTENT_TYPE_DELETED = \"content_type_deleted\",\n}\nexport interface SyncType {\n environment?: string;\n contentTypeUid?: string;\n type?: PublishType[] | PublishType | string;\n locale?: string;\n startDate?: string;\n}\n\nexport interface SyncItem {\n type: string;\n event_at: string;\n content_type_uid: string;\n data: any;\n}\n\nexport interface SyncResponse {\n items: SyncItem[];\n skip?: number;\n limit?: number;\n total_count?: number;\n sync_token?: string;\n pagination_token?: string;\n}\nexport type TransformData = { [key: string]: string | string[] };\n\nexport enum Format {\n GIF = \"gif\",\n PNG = \"png\",\n JPG = \"jpg\",\n PJPG = \"pjpg\",\n WEBP = \"webp\",\n WEBPLL = \"webpll\",\n WEBPLY = \"webply\",\n}\n\nexport enum CropBy {\n DEFAULT = \"default\",\n ASPECTRATIO = \"aspectRatio\",\n REGION = \"region\",\n OFFSET = \"offset\",\n}\n\nexport enum FitBy {\n BOUNDS = \"bounds\",\n CROP = \"crop\",\n}\n\nexport enum Orientation {\n DEFAULT = 1,\n FLIP_HORIZONTAL = 2,\n FLIP_HORIZONTAL_VERTICAL = 3,\n FLIP_VERTICAL = 4,\n FLIP_HORIZONTAL_LEFT = 5,\n RIGHT = 6,\n FLIP_HORIZONTAL_RIGHT = 7,\n LEFT = 8,\n}\n\nexport enum OverlayAlign {\n TOP = \"top\",\n BOTTOM = \"bottom\",\n LEFT = \"left\",\n RIGHT = \"right\",\n MIDDLE = \"middle\",\n CENTER = \"center\",\n}\n\nexport enum OverlayRepeat {\n X = \"x\",\n Y = \"y\",\n BOTH = \"both\",\n}\n\nexport enum ResizeFilter {\n NEAREST = \"nearest\",\n BILINEAR = \"bilinear\",\n BICUBIC = \"bicubic\",\n LANCZOS2 = \"lanczos2\",\n LANCZOS3 = \"lanczos3\",\n}\n\nexport enum CanvasBy {\n DEFAULT = \"default\",\n ASPECTRATIO = \"aspectRatio\",\n REGION = \"region\",\n OFFSET = \"offset\",\n}\n\nexport enum QueryOperation {\n EQUALS = \"\",\n NOT_EQUALS = \"$ne\",\n INCLUDES = \"$in\",\n EXCLUDES = \"$nin\",\n IS_LESS_THAN = \"$lt\",\n IS_LESS_THAN_OR_EQUAL = \"$lte\",\n IS_GREATER_THAN = \"$gt\",\n IS_GREATER_THAN_OR_EQUAL = \"$gte\",\n EXISTS = \"$exists\",\n MATCHES = \"$regex\",\n}\n\nexport enum TaxonomyQueryOperation {\n ABOVE = \"$above\",\n BELOW = \"$below\",\n EQ_ABOVE = \"$eq_above\",\n EQ_BELOW = \"$eq_below\",\n}\n\nexport type BaseQueryParameters = {\n [key: string]:\n | string\n | string[]\n | { [key in QueryOperation]?: string | string[] }\n | { [key: string]: BaseQueryParameters | any };\n};\n\nexport enum QueryOperator {\n AND = \"$and\",\n OR = \"$or\",\n}\n\nexport type PaginationObj = {\n skip?: number;\n limit?: number;\n};\n\ninterface ACL {\n roles?: Record<string, never>;\n others?: {\n read?: boolean;\n create?: boolean;\n update?: boolean;\n delete?: boolean;\n sub_acl?: {\n read?: boolean;\n create?: boolean;\n update?: boolean;\n delete?: boolean;\n publish?: boolean;\n };\n };\n}\n\nexport interface PublishDetails {\n environment: string;\n locale: string;\n time: string;\n user: string;\n}\nexport interface BaseEntry {\n _version: number;\n locale: string;\n uid: string;\n ACL: Record<string, never> | ACL;\n _in_progress: boolean;\n created_at: string;\n created_by: string;\n tags: string[];\n title: string;\n updated_at: string;\n updated_by: string;\n publish_details: PublishDetails;\n}\n\nexport interface ReferenceResponse {\n uid: string;\n _content_type_uid: string;\n}\n\nexport interface BaseAsset {\n uid: string;\n created_at: string;\n updated_at: string;\n created_by: string;\n updated_by: string;\n content_type: string;\n file_size: string;\n tags: [];\n filename: string;\n url: string;\n ACL: ACL;\n is_dir: boolean;\n parent_uid: null | string;\n _version: number;\n title: string;\n publish_details?: PublishDetails;\n}\n\nexport interface BaseContentType {\n title: string;\n uid: string;\n options: {\n is_page: false;\n singleton: false;\n title: string;\n sub_title: [];\n };\n DEFAULT_ACL: ACL;\n SYS_ACL: ACL;\n created_at: string;\n updated_at: string;\n inbuilt_class: false;\n description: string;\n abilities: {\n get_one_object: true;\n get_all_objects: true;\n create_object: true;\n update_object: true;\n delete_object: true;\n delete_all_objects: true;\n };\n last_activity: any;\n maintain_revisions: boolean;\n _version: number;\n schema: any;\n}\n\nexport interface FindResponse<T> {\n entries?: T[];\n content_types?: T[];\n assets?: T[];\n global_fields?: T[];\n count?: number;\n}\n\nexport interface LivePreviewQuery {\n live_preview: string;\n include_applied_variants?: boolean;\n contentTypeUid?: string;\n content_type_uid?: string;\n entry_uid?: string;\n entryUid?: any;\n preview_timestamp?: string;\n release_id?: string;\n}\n\nexport type LivePreview = {\n live_preview?: string;\n include_applied_variants?: boolean;\n contentTypeUid?: string;\n entryUid?: any;\n host?: string;\n enable: boolean;\n management_token?: string;\n preview_token?: string;\n};\n"],"names":["Region","Policy","PublishType","Format","CropBy","FitBy","Orientation","OverlayAlign","OverlayRepeat","ResizeFilter","CanvasBy","QueryOperation","TaxonomyQueryOperation","QueryOperator"],"mappings":";;AAqEY,IAAA,MAAA,qBAAAA,OAAL,KAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,QAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAPC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAiCA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,cAAe,CAAA,GAAA,cAAA,CAAA;AACf,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AACrB,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AACrB,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AAJX,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAWA,IAAA,WAAA,qBAAAC,YAAL,KAAA;AACL,EAAAA,aAAA,iBAAkB,CAAA,GAAA,iBAAA,CAAA;AAClB,EAAAA,aAAA,mBAAoB,CAAA,GAAA,mBAAA,CAAA;AACpB,EAAAA,aAAA,eAAgB,CAAA,GAAA,eAAA,CAAA;AAChB,EAAAA,aAAA,iBAAkB,CAAA,GAAA,iBAAA,CAAA;AAClB,EAAAA,aAAA,mBAAoB,CAAA,GAAA,mBAAA,CAAA;AACpB,EAAAA,aAAA,eAAgB,CAAA,GAAA,eAAA,CAAA;AAChB,EAAAA,aAAA,sBAAuB,CAAA,GAAA,sBAAA,CAAA;AAPb,EAAAA,OAAAA,YAAAA,CAAAA;AAAA,CAAA,EAAA,WAAA,IAAA,EAAA,EAAA;AAkCA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,QAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAPC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAUA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,QAAA,aAAc,CAAA,GAAA,aAAA,CAAA;AACd,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAJC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAOA,IAAA,KAAA,qBAAAC,MAAL,KAAA;AACL,EAAAA,OAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,OAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AAFG,EAAAA,OAAAA,MAAAA,CAAAA;AAAA,CAAA,EAAA,KAAA,IAAA,EAAA,EAAA;AAKA,IAAA,WAAA,qBAAAC,YAAL,KAAA;AACL,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,aAAU,CAAV,CAAA,GAAA,SAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,qBAAkB,CAAlB,CAAA,GAAA,iBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,8BAA2B,CAA3B,CAAA,GAAA,0BAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,mBAAgB,CAAhB,CAAA,GAAA,eAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,0BAAuB,CAAvB,CAAA,GAAA,sBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,WAAQ,CAAR,CAAA,GAAA,OAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,2BAAwB,CAAxB,CAAA,GAAA,uBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,UAAO,CAAP,CAAA,GAAA,MAAA,CAAA;AARU,EAAAA,OAAAA,YAAAA,CAAAA;AAAA,CAAA,EAAA,WAAA,IAAA,EAAA,EAAA;AAWA,IAAA,YAAA,qBAAAC,aAAL,KAAA;AACL,EAAAA,cAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,cAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,cAAA,OAAQ,CAAA,GAAA,OAAA,CAAA;AACR,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AANC,EAAAA,OAAAA,aAAAA,CAAAA;AAAA,CAAA,EAAA,YAAA,IAAA,EAAA,EAAA;AASA,IAAA,aAAA,qBAAAC,cAAL,KAAA;AACL,EAAAA,eAAA,GAAI,CAAA,GAAA,GAAA,CAAA;AACJ,EAAAA,eAAA,GAAI,CAAA,GAAA,GAAA,CAAA;AACJ,EAAAA,eAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AAHG,EAAAA,OAAAA,cAAAA,CAAAA;AAAA,CAAA,EAAA,aAAA,IAAA,EAAA,EAAA;AAMA,IAAA,YAAA,qBAAAC,aAAL,KAAA;AACL,EAAAA,cAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,cAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AALD,EAAAA,OAAAA,aAAAA,CAAAA;AAAA,CAAA,EAAA,YAAA,IAAA,EAAA,EAAA;AAQA,IAAA,QAAA,qBAAAC,SAAL,KAAA;AACL,EAAAA,UAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,UAAA,aAAc,CAAA,GAAA,aAAA,CAAA;AACd,EAAAA,UAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,UAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAJC,EAAAA,OAAAA,SAAAA,CAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA,EAAA;AAOA,IAAA,cAAA,qBAAAC,eAAL,KAAA;AACL,EAAAA,gBAAA,QAAS,CAAA,GAAA,EAAA,CAAA;AACT,EAAAA,gBAAA,YAAa,CAAA,GAAA,KAAA,CAAA;AACb,EAAAA,gBAAA,UAAW,CAAA,GAAA,KAAA,CAAA;AACX,EAAAA,gBAAA,UAAW,CAAA,GAAA,MAAA,CAAA;AACX,EAAAA,gBAAA,cAAe,CAAA,GAAA,KAAA,CAAA;AACf,EAAAA,gBAAA,uBAAwB,CAAA,GAAA,MAAA,CAAA;AACxB,EAAAA,gBAAA,iBAAkB,CAAA,GAAA,KAAA,CAAA;AAClB,EAAAA,gBAAA,0BAA2B,CAAA,GAAA,MAAA,CAAA;AAC3B,EAAAA,gBAAA,QAAS,CAAA,GAAA,SAAA,CAAA;AACT,EAAAA,gBAAA,SAAU,CAAA,GAAA,QAAA,CAAA;AAVA,EAAAA,OAAAA,eAAAA,CAAAA;AAAA,CAAA,EAAA,cAAA,IAAA,EAAA,EAAA;AAaA,IAAA,sBAAA,qBAAAC,uBAAL,KAAA;AACL,EAAAA,wBAAA,OAAQ,CAAA,GAAA,QAAA,CAAA;AACR,EAAAA,wBAAA,OAAQ,CAAA,GAAA,QAAA,CAAA;AACR,EAAAA,wBAAA,UAAW,CAAA,GAAA,WAAA,CAAA;AACX,EAAAA,wBAAA,UAAW,CAAA,GAAA,WAAA,CAAA;AAJD,EAAAA,OAAAA,uBAAAA,CAAAA;AAAA,CAAA,EAAA,sBAAA,IAAA,EAAA,EAAA;AAeA,IAAA,aAAA,qBAAAC,cAAL,KAAA;AACL,EAAAA,eAAA,KAAM,CAAA,GAAA,MAAA,CAAA;AACN,EAAAA,eAAA,IAAK,CAAA,GAAA,KAAA,CAAA;AAFK,EAAAA,OAAAA,cAAAA,CAAAA;AAAA,CAAA,EAAA,aAAA,IAAA,EAAA;;;;;;;;;;;;;;;;;"}
|
|
1
|
+
{"version":3,"file":"types.cjs","sources":["../../../src/common/types.ts"],"sourcesContent":["/* eslint-disable @cspell/spellchecker */\nimport { HttpClientParams } from \"@contentstack/core\";\nimport { AxiosRequestConfig, AxiosResponse } from \"axios\";\n\n/**\n * Contract for cache persistence. Use @contentstack/persistence-plugin or a custom implementation.\n */\nexport interface PersistenceStore {\n setItem(key: string, value: any, contentTypeUid?: string, maxAge?: number): void;\n getItem(key: string, contentTypeUid?: string): any;\n}\n\n// Internal Types\nexport type params = {\n [key: string]: any;\n};\n\nexport type queryParams = {\n [key: string]: string | boolean | number | string[];\n};\n\n/**\n * Interface for creating Contentstack plugins\n * \n * @example\n * ```typescript\n * import { ContentstackPlugin } from '@contentstack/delivery-sdk';\n * \n * class MyPlugin implements ContentstackPlugin {\n * onRequest(config: any): any {\n * // Modify request configuration\n * console.log('Processing request:', config.url);\n * return { ...config, headers: { ...config.headers, 'X-Custom-Header': 'value' } };\n * }\n * \n * onResponse(request: any, response: any, data: any): any {\n * // Process response data\n * console.log('Processing response:', response.status);\n * return { ...response, data: { ...data, processed: true } };\n * }\n * }\n * \n * const stack = contentstack.stack({\n * apiKey: 'your-api-key',\n * deliveryToken: 'your-delivery-token',\n * environment: 'your-environment',\n * plugins: [new MyPlugin()]\n * });\n * ```\n */\nexport interface ContentstackPlugin {\n /**\n * Called before each request is sent\n * @param config - Axios request configuration object (with possible custom properties)\n * @returns Modified request configuration (can be sync or async)\n */\n onRequest(config: any): any;\n\n /**\n * Called after each response is received\n * @param request - The original request configuration\n * @param response - Axios response object (with possible custom properties)\n * @param data - Response data\n * @returns Modified response object (can be sync or async)\n */\n onResponse(request: any, response: any, data: any): any;\n}\n\n// External Types\nexport enum Region {\n US = \"us\",\n EU = \"eu\",\n AU = \"au\",\n AZURE_NA = \"azure-na\",\n AZURE_EU = \"azure-eu\",\n GCP_NA = \"gcp-na\",\n GCP_EU = \"gcp-eu\",\n}\nexport interface StackConfig extends HttpClientParams {\n host?: string;\n apiKey: string;\n deliveryToken: string;\n environment: string;\n branch?: string;\n early_access?: string[];\n region?: Region | string;\n locale?: string;\n plugins?: ContentstackPlugin[];\n logHandler?: (level: string, data: any) => void;\n cacheOptions?: CacheOptions;\n live_preview?: LivePreview;\n port?: number;\n debug?: boolean;\n}\nexport interface CacheOptions {\n policy: Policy;\n /** Required when policy is not IGNORE_CACHE. Use @contentstack/persistence-plugin or a custom implementation. */\n persistenceStore?: PersistenceStore;\n /** Maximum age for cached items in milliseconds; passed to the store when writing. */\n maxAge?: number;\n}\n\nexport enum Policy {\n IGNORE_CACHE = \"IGNORE_CACHE\",\n CACHE_THEN_NETWORK = \"CACHE_THEN_NETWORK\",\n CACHE_ELSE_NETWORK = \"CACHE_ELSE_NETWORK\",\n NETWORK_ELSE_CACHE = \"NETWORK_ELSE_CACHE\",\n}\n\nexport interface SyncStack {\n paginationToken?: string;\n syncToken?: string;\n}\nexport enum PublishType {\n ENTRY_PUBLISHED = \"entry_published\",\n ENTRY_UNPUBLISHED = \"entry_unpublished\",\n ENTRY_DELETED = \"entry_deleted\",\n ASSET_PUBLISHED = \"asset_published\",\n ASSET_UNPUBLISHED = \"asset_unpublished\",\n ASSET_DELETED = \"asset_deleted\",\n CONTENT_TYPE_DELETED = \"content_type_deleted\",\n}\nexport interface SyncType {\n environment?: string;\n contentTypeUid?: string;\n type?: PublishType[] | PublishType | string;\n locale?: string;\n startDate?: string;\n}\n\nexport interface SyncItem {\n type: string;\n event_at: string;\n content_type_uid: string;\n data: any;\n}\n\nexport interface SyncResponse {\n items: SyncItem[];\n skip?: number;\n limit?: number;\n total_count?: number;\n sync_token?: string;\n pagination_token?: string;\n}\nexport type TransformData = { [key: string]: string | string[] };\n\nexport enum Format {\n GIF = \"gif\",\n PNG = \"png\",\n JPG = \"jpg\",\n PJPG = \"pjpg\",\n WEBP = \"webp\",\n WEBPLL = \"webpll\",\n WEBPLY = \"webply\",\n}\n\nexport enum CropBy {\n DEFAULT = \"default\",\n ASPECTRATIO = \"aspectRatio\",\n REGION = \"region\",\n OFFSET = \"offset\",\n}\n\nexport enum FitBy {\n BOUNDS = \"bounds\",\n CROP = \"crop\",\n}\n\nexport enum Orientation {\n DEFAULT = 1,\n FLIP_HORIZONTAL = 2,\n FLIP_HORIZONTAL_VERTICAL = 3,\n FLIP_VERTICAL = 4,\n FLIP_HORIZONTAL_LEFT = 5,\n RIGHT = 6,\n FLIP_HORIZONTAL_RIGHT = 7,\n LEFT = 8,\n}\n\nexport enum OverlayAlign {\n TOP = \"top\",\n BOTTOM = \"bottom\",\n LEFT = \"left\",\n RIGHT = \"right\",\n MIDDLE = \"middle\",\n CENTER = \"center\",\n}\n\nexport enum OverlayRepeat {\n X = \"x\",\n Y = \"y\",\n BOTH = \"both\",\n}\n\nexport enum ResizeFilter {\n NEAREST = \"nearest\",\n BILINEAR = \"bilinear\",\n BICUBIC = \"bicubic\",\n LANCZOS2 = \"lanczos2\",\n LANCZOS3 = \"lanczos3\",\n}\n\nexport enum CanvasBy {\n DEFAULT = \"default\",\n ASPECTRATIO = \"aspectRatio\",\n REGION = \"region\",\n OFFSET = \"offset\",\n}\n\nexport enum QueryOperation {\n EQUALS = \"\",\n NOT_EQUALS = \"$ne\",\n INCLUDES = \"$in\",\n EXCLUDES = \"$nin\",\n IS_LESS_THAN = \"$lt\",\n IS_LESS_THAN_OR_EQUAL = \"$lte\",\n IS_GREATER_THAN = \"$gt\",\n IS_GREATER_THAN_OR_EQUAL = \"$gte\",\n EXISTS = \"$exists\",\n MATCHES = \"$regex\",\n}\n\nexport enum TaxonomyQueryOperation {\n ABOVE = \"$above\",\n BELOW = \"$below\",\n EQ_ABOVE = \"$eq_above\",\n EQ_BELOW = \"$eq_below\",\n}\n\nexport type BaseQueryParameters = {\n [key: string]:\n | string\n | string[]\n | { [key in QueryOperation]?: string | string[] }\n | { [key: string]: BaseQueryParameters | any };\n};\n\nexport enum QueryOperator {\n AND = \"$and\",\n OR = \"$or\",\n}\n\nexport type PaginationObj = {\n skip?: number;\n limit?: number;\n};\n\ninterface ACL {\n roles?: Record<string, never>;\n others?: {\n read?: boolean;\n create?: boolean;\n update?: boolean;\n delete?: boolean;\n sub_acl?: {\n read?: boolean;\n create?: boolean;\n update?: boolean;\n delete?: boolean;\n publish?: boolean;\n };\n };\n}\n\nexport interface PublishDetails {\n environment: string;\n locale: string;\n time: string;\n user: string;\n}\nexport interface BaseEntry {\n _version: number;\n locale: string;\n uid: string;\n ACL: Record<string, never> | ACL;\n _in_progress: boolean;\n created_at: string;\n created_by: string;\n tags: string[];\n title: string;\n updated_at: string;\n updated_by: string;\n publish_details: PublishDetails;\n}\n\nexport interface ReferenceResponse {\n uid: string;\n _content_type_uid: string;\n}\n\nexport interface BaseAsset {\n uid: string;\n created_at: string;\n updated_at: string;\n created_by: string;\n updated_by: string;\n content_type: string;\n file_size: string;\n tags: [];\n filename: string;\n url: string;\n ACL: ACL;\n is_dir: boolean;\n parent_uid: null | string;\n _version: number;\n title: string;\n publish_details?: PublishDetails;\n}\n\nexport interface BaseContentType {\n title: string;\n uid: string;\n options: {\n is_page: false;\n singleton: false;\n title: string;\n sub_title: [];\n };\n DEFAULT_ACL: ACL;\n SYS_ACL: ACL;\n created_at: string;\n updated_at: string;\n inbuilt_class: false;\n description: string;\n abilities: {\n get_one_object: true;\n get_all_objects: true;\n create_object: true;\n update_object: true;\n delete_object: true;\n delete_all_objects: true;\n };\n last_activity: any;\n maintain_revisions: boolean;\n _version: number;\n schema: any;\n}\n\nexport interface FindResponse<T, TContentType = unknown> {\n entries?: T[];\n content_type?: TContentType;\n content_types?: TContentType[];\n assets?: T[];\n global_fields?: T[];\n count?: number;\n}\n\nexport interface LivePreviewQuery {\n live_preview: string;\n include_applied_variants?: boolean;\n contentTypeUid?: string;\n content_type_uid?: string;\n entry_uid?: string;\n entryUid?: any;\n preview_timestamp?: string;\n release_id?: string;\n}\n\nexport type LivePreview = {\n live_preview?: string;\n include_applied_variants?: boolean;\n contentTypeUid?: string;\n entryUid?: any;\n host?: string;\n enable: boolean;\n management_token?: string;\n preview_token?: string;\n};\n"],"names":["Region","Policy","PublishType","Format","CropBy","FitBy","Orientation","OverlayAlign","OverlayRepeat","ResizeFilter","CanvasBy","QueryOperation","TaxonomyQueryOperation","QueryOperator"],"mappings":";;AAqEY,IAAA,MAAA,qBAAAA,OAAL,KAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,QAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAPC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAiCA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,cAAe,CAAA,GAAA,cAAA,CAAA;AACf,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AACrB,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AACrB,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AAJX,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAWA,IAAA,WAAA,qBAAAC,YAAL,KAAA;AACL,EAAAA,aAAA,iBAAkB,CAAA,GAAA,iBAAA,CAAA;AAClB,EAAAA,aAAA,mBAAoB,CAAA,GAAA,mBAAA,CAAA;AACpB,EAAAA,aAAA,eAAgB,CAAA,GAAA,eAAA,CAAA;AAChB,EAAAA,aAAA,iBAAkB,CAAA,GAAA,iBAAA,CAAA;AAClB,EAAAA,aAAA,mBAAoB,CAAA,GAAA,mBAAA,CAAA;AACpB,EAAAA,aAAA,eAAgB,CAAA,GAAA,eAAA,CAAA;AAChB,EAAAA,aAAA,sBAAuB,CAAA,GAAA,sBAAA,CAAA;AAPb,EAAAA,OAAAA,YAAAA,CAAAA;AAAA,CAAA,EAAA,WAAA,IAAA,EAAA,EAAA;AAkCA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,QAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAPC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAUA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,QAAA,aAAc,CAAA,GAAA,aAAA,CAAA;AACd,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAJC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAOA,IAAA,KAAA,qBAAAC,MAAL,KAAA;AACL,EAAAA,OAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,OAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AAFG,EAAAA,OAAAA,MAAAA,CAAAA;AAAA,CAAA,EAAA,KAAA,IAAA,EAAA,EAAA;AAKA,IAAA,WAAA,qBAAAC,YAAL,KAAA;AACL,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,aAAU,CAAV,CAAA,GAAA,SAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,qBAAkB,CAAlB,CAAA,GAAA,iBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,8BAA2B,CAA3B,CAAA,GAAA,0BAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,mBAAgB,CAAhB,CAAA,GAAA,eAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,0BAAuB,CAAvB,CAAA,GAAA,sBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,WAAQ,CAAR,CAAA,GAAA,OAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,2BAAwB,CAAxB,CAAA,GAAA,uBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,UAAO,CAAP,CAAA,GAAA,MAAA,CAAA;AARU,EAAAA,OAAAA,YAAAA,CAAAA;AAAA,CAAA,EAAA,WAAA,IAAA,EAAA,EAAA;AAWA,IAAA,YAAA,qBAAAC,aAAL,KAAA;AACL,EAAAA,cAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,cAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,cAAA,OAAQ,CAAA,GAAA,OAAA,CAAA;AACR,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AANC,EAAAA,OAAAA,aAAAA,CAAAA;AAAA,CAAA,EAAA,YAAA,IAAA,EAAA,EAAA;AASA,IAAA,aAAA,qBAAAC,cAAL,KAAA;AACL,EAAAA,eAAA,GAAI,CAAA,GAAA,GAAA,CAAA;AACJ,EAAAA,eAAA,GAAI,CAAA,GAAA,GAAA,CAAA;AACJ,EAAAA,eAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AAHG,EAAAA,OAAAA,cAAAA,CAAAA;AAAA,CAAA,EAAA,aAAA,IAAA,EAAA,EAAA;AAMA,IAAA,YAAA,qBAAAC,aAAL,KAAA;AACL,EAAAA,cAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,cAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AALD,EAAAA,OAAAA,aAAAA,CAAAA;AAAA,CAAA,EAAA,YAAA,IAAA,EAAA,EAAA;AAQA,IAAA,QAAA,qBAAAC,SAAL,KAAA;AACL,EAAAA,UAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,UAAA,aAAc,CAAA,GAAA,aAAA,CAAA;AACd,EAAAA,UAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,UAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAJC,EAAAA,OAAAA,SAAAA,CAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA,EAAA;AAOA,IAAA,cAAA,qBAAAC,eAAL,KAAA;AACL,EAAAA,gBAAA,QAAS,CAAA,GAAA,EAAA,CAAA;AACT,EAAAA,gBAAA,YAAa,CAAA,GAAA,KAAA,CAAA;AACb,EAAAA,gBAAA,UAAW,CAAA,GAAA,KAAA,CAAA;AACX,EAAAA,gBAAA,UAAW,CAAA,GAAA,MAAA,CAAA;AACX,EAAAA,gBAAA,cAAe,CAAA,GAAA,KAAA,CAAA;AACf,EAAAA,gBAAA,uBAAwB,CAAA,GAAA,MAAA,CAAA;AACxB,EAAAA,gBAAA,iBAAkB,CAAA,GAAA,KAAA,CAAA;AAClB,EAAAA,gBAAA,0BAA2B,CAAA,GAAA,MAAA,CAAA;AAC3B,EAAAA,gBAAA,QAAS,CAAA,GAAA,SAAA,CAAA;AACT,EAAAA,gBAAA,SAAU,CAAA,GAAA,QAAA,CAAA;AAVA,EAAAA,OAAAA,eAAAA,CAAAA;AAAA,CAAA,EAAA,cAAA,IAAA,EAAA,EAAA;AAaA,IAAA,sBAAA,qBAAAC,uBAAL,KAAA;AACL,EAAAA,wBAAA,OAAQ,CAAA,GAAA,QAAA,CAAA;AACR,EAAAA,wBAAA,OAAQ,CAAA,GAAA,QAAA,CAAA;AACR,EAAAA,wBAAA,UAAW,CAAA,GAAA,WAAA,CAAA;AACX,EAAAA,wBAAA,UAAW,CAAA,GAAA,WAAA,CAAA;AAJD,EAAAA,OAAAA,uBAAAA,CAAAA;AAAA,CAAA,EAAA,sBAAA,IAAA,EAAA,EAAA;AAeA,IAAA,aAAA,qBAAAC,cAAL,KAAA;AACL,EAAAA,eAAA,KAAM,CAAA,GAAA,MAAA,CAAA;AACN,EAAAA,eAAA,IAAK,CAAA,GAAA,KAAA,CAAA;AAFK,EAAAA,OAAAA,cAAAA,CAAAA;AAAA,CAAA,EAAA,aAAA,IAAA,EAAA;;;;;;;;;;;;;;;;;"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sources":["../../../src/common/types.ts"],"sourcesContent":["/* eslint-disable @cspell/spellchecker */\nimport { HttpClientParams } from \"@contentstack/core\";\nimport { AxiosRequestConfig, AxiosResponse } from \"axios\";\n\n/**\n * Contract for cache persistence. Use @contentstack/persistence-plugin or a custom implementation.\n */\nexport interface PersistenceStore {\n setItem(key: string, value: any, contentTypeUid?: string, maxAge?: number): void;\n getItem(key: string, contentTypeUid?: string): any;\n}\n\n// Internal Types\nexport type params = {\n [key: string]: any;\n};\n\nexport type queryParams = {\n [key: string]: string | boolean | number | string[];\n};\n\n/**\n * Interface for creating Contentstack plugins\n * \n * @example\n * ```typescript\n * import { ContentstackPlugin } from '@contentstack/delivery-sdk';\n * \n * class MyPlugin implements ContentstackPlugin {\n * onRequest(config: any): any {\n * // Modify request configuration\n * console.log('Processing request:', config.url);\n * return { ...config, headers: { ...config.headers, 'X-Custom-Header': 'value' } };\n * }\n * \n * onResponse(request: any, response: any, data: any): any {\n * // Process response data\n * console.log('Processing response:', response.status);\n * return { ...response, data: { ...data, processed: true } };\n * }\n * }\n * \n * const stack = contentstack.stack({\n * apiKey: 'your-api-key',\n * deliveryToken: 'your-delivery-token',\n * environment: 'your-environment',\n * plugins: [new MyPlugin()]\n * });\n * ```\n */\nexport interface ContentstackPlugin {\n /**\n * Called before each request is sent\n * @param config - Axios request configuration object (with possible custom properties)\n * @returns Modified request configuration (can be sync or async)\n */\n onRequest(config: any): any;\n\n /**\n * Called after each response is received\n * @param request - The original request configuration\n * @param response - Axios response object (with possible custom properties)\n * @param data - Response data\n * @returns Modified response object (can be sync or async)\n */\n onResponse(request: any, response: any, data: any): any;\n}\n\n// External Types\nexport enum Region {\n US = \"us\",\n EU = \"eu\",\n AU = \"au\",\n AZURE_NA = \"azure-na\",\n AZURE_EU = \"azure-eu\",\n GCP_NA = \"gcp-na\",\n GCP_EU = \"gcp-eu\",\n}\nexport interface StackConfig extends HttpClientParams {\n host?: string;\n apiKey: string;\n deliveryToken: string;\n environment: string;\n branch?: string;\n early_access?: string[];\n region?: Region | string;\n locale?: string;\n plugins?: ContentstackPlugin[];\n logHandler?: (level: string, data: any) => void;\n cacheOptions?: CacheOptions;\n live_preview?: LivePreview;\n port?: number;\n debug?: boolean;\n}\nexport interface CacheOptions {\n policy: Policy;\n /** Required when policy is not IGNORE_CACHE. Use @contentstack/persistence-plugin or a custom implementation. */\n persistenceStore?: PersistenceStore;\n /** Maximum age for cached items in milliseconds; passed to the store when writing. */\n maxAge?: number;\n}\n\nexport enum Policy {\n IGNORE_CACHE = \"IGNORE_CACHE\",\n CACHE_THEN_NETWORK = \"CACHE_THEN_NETWORK\",\n CACHE_ELSE_NETWORK = \"CACHE_ELSE_NETWORK\",\n NETWORK_ELSE_CACHE = \"NETWORK_ELSE_CACHE\",\n}\n\nexport interface SyncStack {\n paginationToken?: string;\n syncToken?: string;\n}\nexport enum PublishType {\n ENTRY_PUBLISHED = \"entry_published\",\n ENTRY_UNPUBLISHED = \"entry_unpublished\",\n ENTRY_DELETED = \"entry_deleted\",\n ASSET_PUBLISHED = \"asset_published\",\n ASSET_UNPUBLISHED = \"asset_unpublished\",\n ASSET_DELETED = \"asset_deleted\",\n CONTENT_TYPE_DELETED = \"content_type_deleted\",\n}\nexport interface SyncType {\n environment?: string;\n contentTypeUid?: string;\n type?: PublishType[] | PublishType | string;\n locale?: string;\n startDate?: string;\n}\n\nexport interface SyncItem {\n type: string;\n event_at: string;\n content_type_uid: string;\n data: any;\n}\n\nexport interface SyncResponse {\n items: SyncItem[];\n skip?: number;\n limit?: number;\n total_count?: number;\n sync_token?: string;\n pagination_token?: string;\n}\nexport type TransformData = { [key: string]: string | string[] };\n\nexport enum Format {\n GIF = \"gif\",\n PNG = \"png\",\n JPG = \"jpg\",\n PJPG = \"pjpg\",\n WEBP = \"webp\",\n WEBPLL = \"webpll\",\n WEBPLY = \"webply\",\n}\n\nexport enum CropBy {\n DEFAULT = \"default\",\n ASPECTRATIO = \"aspectRatio\",\n REGION = \"region\",\n OFFSET = \"offset\",\n}\n\nexport enum FitBy {\n BOUNDS = \"bounds\",\n CROP = \"crop\",\n}\n\nexport enum Orientation {\n DEFAULT = 1,\n FLIP_HORIZONTAL = 2,\n FLIP_HORIZONTAL_VERTICAL = 3,\n FLIP_VERTICAL = 4,\n FLIP_HORIZONTAL_LEFT = 5,\n RIGHT = 6,\n FLIP_HORIZONTAL_RIGHT = 7,\n LEFT = 8,\n}\n\nexport enum OverlayAlign {\n TOP = \"top\",\n BOTTOM = \"bottom\",\n LEFT = \"left\",\n RIGHT = \"right\",\n MIDDLE = \"middle\",\n CENTER = \"center\",\n}\n\nexport enum OverlayRepeat {\n X = \"x\",\n Y = \"y\",\n BOTH = \"both\",\n}\n\nexport enum ResizeFilter {\n NEAREST = \"nearest\",\n BILINEAR = \"bilinear\",\n BICUBIC = \"bicubic\",\n LANCZOS2 = \"lanczos2\",\n LANCZOS3 = \"lanczos3\",\n}\n\nexport enum CanvasBy {\n DEFAULT = \"default\",\n ASPECTRATIO = \"aspectRatio\",\n REGION = \"region\",\n OFFSET = \"offset\",\n}\n\nexport enum QueryOperation {\n EQUALS = \"\",\n NOT_EQUALS = \"$ne\",\n INCLUDES = \"$in\",\n EXCLUDES = \"$nin\",\n IS_LESS_THAN = \"$lt\",\n IS_LESS_THAN_OR_EQUAL = \"$lte\",\n IS_GREATER_THAN = \"$gt\",\n IS_GREATER_THAN_OR_EQUAL = \"$gte\",\n EXISTS = \"$exists\",\n MATCHES = \"$regex\",\n}\n\nexport enum TaxonomyQueryOperation {\n ABOVE = \"$above\",\n BELOW = \"$below\",\n EQ_ABOVE = \"$eq_above\",\n EQ_BELOW = \"$eq_below\",\n}\n\nexport type BaseQueryParameters = {\n [key: string]:\n | string\n | string[]\n | { [key in QueryOperation]?: string | string[] }\n | { [key: string]: BaseQueryParameters | any };\n};\n\nexport enum QueryOperator {\n AND = \"$and\",\n OR = \"$or\",\n}\n\nexport type PaginationObj = {\n skip?: number;\n limit?: number;\n};\n\ninterface ACL {\n roles?: Record<string, never>;\n others?: {\n read?: boolean;\n create?: boolean;\n update?: boolean;\n delete?: boolean;\n sub_acl?: {\n read?: boolean;\n create?: boolean;\n update?: boolean;\n delete?: boolean;\n publish?: boolean;\n };\n };\n}\n\nexport interface PublishDetails {\n environment: string;\n locale: string;\n time: string;\n user: string;\n}\nexport interface BaseEntry {\n _version: number;\n locale: string;\n uid: string;\n ACL: Record<string, never> | ACL;\n _in_progress: boolean;\n created_at: string;\n created_by: string;\n tags: string[];\n title: string;\n updated_at: string;\n updated_by: string;\n publish_details: PublishDetails;\n}\n\nexport interface ReferenceResponse {\n uid: string;\n _content_type_uid: string;\n}\n\nexport interface BaseAsset {\n uid: string;\n created_at: string;\n updated_at: string;\n created_by: string;\n updated_by: string;\n content_type: string;\n file_size: string;\n tags: [];\n filename: string;\n url: string;\n ACL: ACL;\n is_dir: boolean;\n parent_uid: null | string;\n _version: number;\n title: string;\n publish_details?: PublishDetails;\n}\n\nexport interface BaseContentType {\n title: string;\n uid: string;\n options: {\n is_page: false;\n singleton: false;\n title: string;\n sub_title: [];\n };\n DEFAULT_ACL: ACL;\n SYS_ACL: ACL;\n created_at: string;\n updated_at: string;\n inbuilt_class: false;\n description: string;\n abilities: {\n get_one_object: true;\n get_all_objects: true;\n create_object: true;\n update_object: true;\n delete_object: true;\n delete_all_objects: true;\n };\n last_activity: any;\n maintain_revisions: boolean;\n _version: number;\n schema: any;\n}\n\nexport interface FindResponse<T> {\n entries?: T[];\n content_types?: T[];\n assets?: T[];\n global_fields?: T[];\n count?: number;\n}\n\nexport interface LivePreviewQuery {\n live_preview: string;\n include_applied_variants?: boolean;\n contentTypeUid?: string;\n content_type_uid?: string;\n entry_uid?: string;\n entryUid?: any;\n preview_timestamp?: string;\n release_id?: string;\n}\n\nexport type LivePreview = {\n live_preview?: string;\n include_applied_variants?: boolean;\n contentTypeUid?: string;\n entryUid?: any;\n host?: string;\n enable: boolean;\n management_token?: string;\n preview_token?: string;\n};\n"],"names":["Region","Policy","PublishType","Format","CropBy","FitBy","Orientation","OverlayAlign","OverlayRepeat","ResizeFilter","CanvasBy","QueryOperation","TaxonomyQueryOperation","QueryOperator"],"mappings":"AAqEY,IAAA,MAAA,qBAAAA,OAAL,KAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,QAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAPC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAiCA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,cAAe,CAAA,GAAA,cAAA,CAAA;AACf,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AACrB,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AACrB,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AAJX,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAWA,IAAA,WAAA,qBAAAC,YAAL,KAAA;AACL,EAAAA,aAAA,iBAAkB,CAAA,GAAA,iBAAA,CAAA;AAClB,EAAAA,aAAA,mBAAoB,CAAA,GAAA,mBAAA,CAAA;AACpB,EAAAA,aAAA,eAAgB,CAAA,GAAA,eAAA,CAAA;AAChB,EAAAA,aAAA,iBAAkB,CAAA,GAAA,iBAAA,CAAA;AAClB,EAAAA,aAAA,mBAAoB,CAAA,GAAA,mBAAA,CAAA;AACpB,EAAAA,aAAA,eAAgB,CAAA,GAAA,eAAA,CAAA;AAChB,EAAAA,aAAA,sBAAuB,CAAA,GAAA,sBAAA,CAAA;AAPb,EAAAA,OAAAA,YAAAA,CAAAA;AAAA,CAAA,EAAA,WAAA,IAAA,EAAA,EAAA;AAkCA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,QAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAPC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAUA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,QAAA,aAAc,CAAA,GAAA,aAAA,CAAA;AACd,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAJC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAOA,IAAA,KAAA,qBAAAC,MAAL,KAAA;AACL,EAAAA,OAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,OAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AAFG,EAAAA,OAAAA,MAAAA,CAAAA;AAAA,CAAA,EAAA,KAAA,IAAA,EAAA,EAAA;AAKA,IAAA,WAAA,qBAAAC,YAAL,KAAA;AACL,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,aAAU,CAAV,CAAA,GAAA,SAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,qBAAkB,CAAlB,CAAA,GAAA,iBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,8BAA2B,CAA3B,CAAA,GAAA,0BAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,mBAAgB,CAAhB,CAAA,GAAA,eAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,0BAAuB,CAAvB,CAAA,GAAA,sBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,WAAQ,CAAR,CAAA,GAAA,OAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,2BAAwB,CAAxB,CAAA,GAAA,uBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,UAAO,CAAP,CAAA,GAAA,MAAA,CAAA;AARU,EAAAA,OAAAA,YAAAA,CAAAA;AAAA,CAAA,EAAA,WAAA,IAAA,EAAA,EAAA;AAWA,IAAA,YAAA,qBAAAC,aAAL,KAAA;AACL,EAAAA,cAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,cAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,cAAA,OAAQ,CAAA,GAAA,OAAA,CAAA;AACR,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AANC,EAAAA,OAAAA,aAAAA,CAAAA;AAAA,CAAA,EAAA,YAAA,IAAA,EAAA,EAAA;AASA,IAAA,aAAA,qBAAAC,cAAL,KAAA;AACL,EAAAA,eAAA,GAAI,CAAA,GAAA,GAAA,CAAA;AACJ,EAAAA,eAAA,GAAI,CAAA,GAAA,GAAA,CAAA;AACJ,EAAAA,eAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AAHG,EAAAA,OAAAA,cAAAA,CAAAA;AAAA,CAAA,EAAA,aAAA,IAAA,EAAA,EAAA;AAMA,IAAA,YAAA,qBAAAC,aAAL,KAAA;AACL,EAAAA,cAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,cAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AALD,EAAAA,OAAAA,aAAAA,CAAAA;AAAA,CAAA,EAAA,YAAA,IAAA,EAAA,EAAA;AAQA,IAAA,QAAA,qBAAAC,SAAL,KAAA;AACL,EAAAA,UAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,UAAA,aAAc,CAAA,GAAA,aAAA,CAAA;AACd,EAAAA,UAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,UAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAJC,EAAAA,OAAAA,SAAAA,CAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA,EAAA;AAOA,IAAA,cAAA,qBAAAC,eAAL,KAAA;AACL,EAAAA,gBAAA,QAAS,CAAA,GAAA,EAAA,CAAA;AACT,EAAAA,gBAAA,YAAa,CAAA,GAAA,KAAA,CAAA;AACb,EAAAA,gBAAA,UAAW,CAAA,GAAA,KAAA,CAAA;AACX,EAAAA,gBAAA,UAAW,CAAA,GAAA,MAAA,CAAA;AACX,EAAAA,gBAAA,cAAe,CAAA,GAAA,KAAA,CAAA;AACf,EAAAA,gBAAA,uBAAwB,CAAA,GAAA,MAAA,CAAA;AACxB,EAAAA,gBAAA,iBAAkB,CAAA,GAAA,KAAA,CAAA;AAClB,EAAAA,gBAAA,0BAA2B,CAAA,GAAA,MAAA,CAAA;AAC3B,EAAAA,gBAAA,QAAS,CAAA,GAAA,SAAA,CAAA;AACT,EAAAA,gBAAA,SAAU,CAAA,GAAA,QAAA,CAAA;AAVA,EAAAA,OAAAA,eAAAA,CAAAA;AAAA,CAAA,EAAA,cAAA,IAAA,EAAA,EAAA;AAaA,IAAA,sBAAA,qBAAAC,uBAAL,KAAA;AACL,EAAAA,wBAAA,OAAQ,CAAA,GAAA,QAAA,CAAA;AACR,EAAAA,wBAAA,OAAQ,CAAA,GAAA,QAAA,CAAA;AACR,EAAAA,wBAAA,UAAW,CAAA,GAAA,WAAA,CAAA;AACX,EAAAA,wBAAA,UAAW,CAAA,GAAA,WAAA,CAAA;AAJD,EAAAA,OAAAA,uBAAAA,CAAAA;AAAA,CAAA,EAAA,sBAAA,IAAA,EAAA,EAAA;AAeA,IAAA,aAAA,qBAAAC,cAAL,KAAA;AACL,EAAAA,eAAA,KAAM,CAAA,GAAA,MAAA,CAAA;AACN,EAAAA,eAAA,IAAK,CAAA,GAAA,KAAA,CAAA;AAFK,EAAAA,OAAAA,cAAAA,CAAAA;AAAA,CAAA,EAAA,aAAA,IAAA,EAAA;;;;"}
|
|
1
|
+
{"version":3,"file":"types.js","sources":["../../../src/common/types.ts"],"sourcesContent":["/* eslint-disable @cspell/spellchecker */\nimport { HttpClientParams } from \"@contentstack/core\";\nimport { AxiosRequestConfig, AxiosResponse } from \"axios\";\n\n/**\n * Contract for cache persistence. Use @contentstack/persistence-plugin or a custom implementation.\n */\nexport interface PersistenceStore {\n setItem(key: string, value: any, contentTypeUid?: string, maxAge?: number): void;\n getItem(key: string, contentTypeUid?: string): any;\n}\n\n// Internal Types\nexport type params = {\n [key: string]: any;\n};\n\nexport type queryParams = {\n [key: string]: string | boolean | number | string[];\n};\n\n/**\n * Interface for creating Contentstack plugins\n * \n * @example\n * ```typescript\n * import { ContentstackPlugin } from '@contentstack/delivery-sdk';\n * \n * class MyPlugin implements ContentstackPlugin {\n * onRequest(config: any): any {\n * // Modify request configuration\n * console.log('Processing request:', config.url);\n * return { ...config, headers: { ...config.headers, 'X-Custom-Header': 'value' } };\n * }\n * \n * onResponse(request: any, response: any, data: any): any {\n * // Process response data\n * console.log('Processing response:', response.status);\n * return { ...response, data: { ...data, processed: true } };\n * }\n * }\n * \n * const stack = contentstack.stack({\n * apiKey: 'your-api-key',\n * deliveryToken: 'your-delivery-token',\n * environment: 'your-environment',\n * plugins: [new MyPlugin()]\n * });\n * ```\n */\nexport interface ContentstackPlugin {\n /**\n * Called before each request is sent\n * @param config - Axios request configuration object (with possible custom properties)\n * @returns Modified request configuration (can be sync or async)\n */\n onRequest(config: any): any;\n\n /**\n * Called after each response is received\n * @param request - The original request configuration\n * @param response - Axios response object (with possible custom properties)\n * @param data - Response data\n * @returns Modified response object (can be sync or async)\n */\n onResponse(request: any, response: any, data: any): any;\n}\n\n// External Types\nexport enum Region {\n US = \"us\",\n EU = \"eu\",\n AU = \"au\",\n AZURE_NA = \"azure-na\",\n AZURE_EU = \"azure-eu\",\n GCP_NA = \"gcp-na\",\n GCP_EU = \"gcp-eu\",\n}\nexport interface StackConfig extends HttpClientParams {\n host?: string;\n apiKey: string;\n deliveryToken: string;\n environment: string;\n branch?: string;\n early_access?: string[];\n region?: Region | string;\n locale?: string;\n plugins?: ContentstackPlugin[];\n logHandler?: (level: string, data: any) => void;\n cacheOptions?: CacheOptions;\n live_preview?: LivePreview;\n port?: number;\n debug?: boolean;\n}\nexport interface CacheOptions {\n policy: Policy;\n /** Required when policy is not IGNORE_CACHE. Use @contentstack/persistence-plugin or a custom implementation. */\n persistenceStore?: PersistenceStore;\n /** Maximum age for cached items in milliseconds; passed to the store when writing. */\n maxAge?: number;\n}\n\nexport enum Policy {\n IGNORE_CACHE = \"IGNORE_CACHE\",\n CACHE_THEN_NETWORK = \"CACHE_THEN_NETWORK\",\n CACHE_ELSE_NETWORK = \"CACHE_ELSE_NETWORK\",\n NETWORK_ELSE_CACHE = \"NETWORK_ELSE_CACHE\",\n}\n\nexport interface SyncStack {\n paginationToken?: string;\n syncToken?: string;\n}\nexport enum PublishType {\n ENTRY_PUBLISHED = \"entry_published\",\n ENTRY_UNPUBLISHED = \"entry_unpublished\",\n ENTRY_DELETED = \"entry_deleted\",\n ASSET_PUBLISHED = \"asset_published\",\n ASSET_UNPUBLISHED = \"asset_unpublished\",\n ASSET_DELETED = \"asset_deleted\",\n CONTENT_TYPE_DELETED = \"content_type_deleted\",\n}\nexport interface SyncType {\n environment?: string;\n contentTypeUid?: string;\n type?: PublishType[] | PublishType | string;\n locale?: string;\n startDate?: string;\n}\n\nexport interface SyncItem {\n type: string;\n event_at: string;\n content_type_uid: string;\n data: any;\n}\n\nexport interface SyncResponse {\n items: SyncItem[];\n skip?: number;\n limit?: number;\n total_count?: number;\n sync_token?: string;\n pagination_token?: string;\n}\nexport type TransformData = { [key: string]: string | string[] };\n\nexport enum Format {\n GIF = \"gif\",\n PNG = \"png\",\n JPG = \"jpg\",\n PJPG = \"pjpg\",\n WEBP = \"webp\",\n WEBPLL = \"webpll\",\n WEBPLY = \"webply\",\n}\n\nexport enum CropBy {\n DEFAULT = \"default\",\n ASPECTRATIO = \"aspectRatio\",\n REGION = \"region\",\n OFFSET = \"offset\",\n}\n\nexport enum FitBy {\n BOUNDS = \"bounds\",\n CROP = \"crop\",\n}\n\nexport enum Orientation {\n DEFAULT = 1,\n FLIP_HORIZONTAL = 2,\n FLIP_HORIZONTAL_VERTICAL = 3,\n FLIP_VERTICAL = 4,\n FLIP_HORIZONTAL_LEFT = 5,\n RIGHT = 6,\n FLIP_HORIZONTAL_RIGHT = 7,\n LEFT = 8,\n}\n\nexport enum OverlayAlign {\n TOP = \"top\",\n BOTTOM = \"bottom\",\n LEFT = \"left\",\n RIGHT = \"right\",\n MIDDLE = \"middle\",\n CENTER = \"center\",\n}\n\nexport enum OverlayRepeat {\n X = \"x\",\n Y = \"y\",\n BOTH = \"both\",\n}\n\nexport enum ResizeFilter {\n NEAREST = \"nearest\",\n BILINEAR = \"bilinear\",\n BICUBIC = \"bicubic\",\n LANCZOS2 = \"lanczos2\",\n LANCZOS3 = \"lanczos3\",\n}\n\nexport enum CanvasBy {\n DEFAULT = \"default\",\n ASPECTRATIO = \"aspectRatio\",\n REGION = \"region\",\n OFFSET = \"offset\",\n}\n\nexport enum QueryOperation {\n EQUALS = \"\",\n NOT_EQUALS = \"$ne\",\n INCLUDES = \"$in\",\n EXCLUDES = \"$nin\",\n IS_LESS_THAN = \"$lt\",\n IS_LESS_THAN_OR_EQUAL = \"$lte\",\n IS_GREATER_THAN = \"$gt\",\n IS_GREATER_THAN_OR_EQUAL = \"$gte\",\n EXISTS = \"$exists\",\n MATCHES = \"$regex\",\n}\n\nexport enum TaxonomyQueryOperation {\n ABOVE = \"$above\",\n BELOW = \"$below\",\n EQ_ABOVE = \"$eq_above\",\n EQ_BELOW = \"$eq_below\",\n}\n\nexport type BaseQueryParameters = {\n [key: string]:\n | string\n | string[]\n | { [key in QueryOperation]?: string | string[] }\n | { [key: string]: BaseQueryParameters | any };\n};\n\nexport enum QueryOperator {\n AND = \"$and\",\n OR = \"$or\",\n}\n\nexport type PaginationObj = {\n skip?: number;\n limit?: number;\n};\n\ninterface ACL {\n roles?: Record<string, never>;\n others?: {\n read?: boolean;\n create?: boolean;\n update?: boolean;\n delete?: boolean;\n sub_acl?: {\n read?: boolean;\n create?: boolean;\n update?: boolean;\n delete?: boolean;\n publish?: boolean;\n };\n };\n}\n\nexport interface PublishDetails {\n environment: string;\n locale: string;\n time: string;\n user: string;\n}\nexport interface BaseEntry {\n _version: number;\n locale: string;\n uid: string;\n ACL: Record<string, never> | ACL;\n _in_progress: boolean;\n created_at: string;\n created_by: string;\n tags: string[];\n title: string;\n updated_at: string;\n updated_by: string;\n publish_details: PublishDetails;\n}\n\nexport interface ReferenceResponse {\n uid: string;\n _content_type_uid: string;\n}\n\nexport interface BaseAsset {\n uid: string;\n created_at: string;\n updated_at: string;\n created_by: string;\n updated_by: string;\n content_type: string;\n file_size: string;\n tags: [];\n filename: string;\n url: string;\n ACL: ACL;\n is_dir: boolean;\n parent_uid: null | string;\n _version: number;\n title: string;\n publish_details?: PublishDetails;\n}\n\nexport interface BaseContentType {\n title: string;\n uid: string;\n options: {\n is_page: false;\n singleton: false;\n title: string;\n sub_title: [];\n };\n DEFAULT_ACL: ACL;\n SYS_ACL: ACL;\n created_at: string;\n updated_at: string;\n inbuilt_class: false;\n description: string;\n abilities: {\n get_one_object: true;\n get_all_objects: true;\n create_object: true;\n update_object: true;\n delete_object: true;\n delete_all_objects: true;\n };\n last_activity: any;\n maintain_revisions: boolean;\n _version: number;\n schema: any;\n}\n\nexport interface FindResponse<T, TContentType = unknown> {\n entries?: T[];\n content_type?: TContentType;\n content_types?: TContentType[];\n assets?: T[];\n global_fields?: T[];\n count?: number;\n}\n\nexport interface LivePreviewQuery {\n live_preview: string;\n include_applied_variants?: boolean;\n contentTypeUid?: string;\n content_type_uid?: string;\n entry_uid?: string;\n entryUid?: any;\n preview_timestamp?: string;\n release_id?: string;\n}\n\nexport type LivePreview = {\n live_preview?: string;\n include_applied_variants?: boolean;\n contentTypeUid?: string;\n entryUid?: any;\n host?: string;\n enable: boolean;\n management_token?: string;\n preview_token?: string;\n};\n"],"names":["Region","Policy","PublishType","Format","CropBy","FitBy","Orientation","OverlayAlign","OverlayRepeat","ResizeFilter","CanvasBy","QueryOperation","TaxonomyQueryOperation","QueryOperator"],"mappings":"AAqEY,IAAA,MAAA,qBAAAA,OAAL,KAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,IAAK,CAAA,GAAA,IAAA,CAAA;AACL,EAAAA,QAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,QAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAPC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAiCA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,cAAe,CAAA,GAAA,cAAA,CAAA;AACf,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AACrB,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AACrB,EAAAA,QAAA,oBAAqB,CAAA,GAAA,oBAAA,CAAA;AAJX,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAWA,IAAA,WAAA,qBAAAC,YAAL,KAAA;AACL,EAAAA,aAAA,iBAAkB,CAAA,GAAA,iBAAA,CAAA;AAClB,EAAAA,aAAA,mBAAoB,CAAA,GAAA,mBAAA,CAAA;AACpB,EAAAA,aAAA,eAAgB,CAAA,GAAA,eAAA,CAAA;AAChB,EAAAA,aAAA,iBAAkB,CAAA,GAAA,iBAAA,CAAA;AAClB,EAAAA,aAAA,mBAAoB,CAAA,GAAA,mBAAA,CAAA;AACpB,EAAAA,aAAA,eAAgB,CAAA,GAAA,eAAA,CAAA;AAChB,EAAAA,aAAA,sBAAuB,CAAA,GAAA,sBAAA,CAAA;AAPb,EAAAA,OAAAA,YAAAA,CAAAA;AAAA,CAAA,EAAA,WAAA,IAAA,EAAA,EAAA;AAkCA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,QAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,QAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAPC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAUA,IAAA,MAAA,qBAAAC,OAAL,KAAA;AACL,EAAAA,QAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,QAAA,aAAc,CAAA,GAAA,aAAA,CAAA;AACd,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,QAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAJC,EAAAA,OAAAA,OAAAA,CAAAA;AAAA,CAAA,EAAA,MAAA,IAAA,EAAA,EAAA;AAOA,IAAA,KAAA,qBAAAC,MAAL,KAAA;AACL,EAAAA,OAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,OAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AAFG,EAAAA,OAAAA,MAAAA,CAAAA;AAAA,CAAA,EAAA,KAAA,IAAA,EAAA,EAAA;AAKA,IAAA,WAAA,qBAAAC,YAAL,KAAA;AACL,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,aAAU,CAAV,CAAA,GAAA,SAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,qBAAkB,CAAlB,CAAA,GAAA,iBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,8BAA2B,CAA3B,CAAA,GAAA,0BAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,mBAAgB,CAAhB,CAAA,GAAA,eAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,0BAAuB,CAAvB,CAAA,GAAA,sBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,WAAQ,CAAR,CAAA,GAAA,OAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,2BAAwB,CAAxB,CAAA,GAAA,uBAAA,CAAA;AACA,EAAAA,YAAAA,CAAAA,YAAAA,CAAA,UAAO,CAAP,CAAA,GAAA,MAAA,CAAA;AARU,EAAAA,OAAAA,YAAAA,CAAAA;AAAA,CAAA,EAAA,WAAA,IAAA,EAAA,EAAA;AAWA,IAAA,YAAA,qBAAAC,aAAL,KAAA;AACL,EAAAA,cAAA,KAAM,CAAA,GAAA,KAAA,CAAA;AACN,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,cAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AACP,EAAAA,cAAA,OAAQ,CAAA,GAAA,OAAA,CAAA;AACR,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,cAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AANC,EAAAA,OAAAA,aAAAA,CAAAA;AAAA,CAAA,EAAA,YAAA,IAAA,EAAA,EAAA;AASA,IAAA,aAAA,qBAAAC,cAAL,KAAA;AACL,EAAAA,eAAA,GAAI,CAAA,GAAA,GAAA,CAAA;AACJ,EAAAA,eAAA,GAAI,CAAA,GAAA,GAAA,CAAA;AACJ,EAAAA,eAAA,MAAO,CAAA,GAAA,MAAA,CAAA;AAHG,EAAAA,OAAAA,cAAAA,CAAAA;AAAA,CAAA,EAAA,aAAA,IAAA,EAAA,EAAA;AAMA,IAAA,YAAA,qBAAAC,aAAL,KAAA;AACL,EAAAA,cAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,cAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AACX,EAAAA,cAAA,UAAW,CAAA,GAAA,UAAA,CAAA;AALD,EAAAA,OAAAA,aAAAA,CAAAA;AAAA,CAAA,EAAA,YAAA,IAAA,EAAA,EAAA;AAQA,IAAA,QAAA,qBAAAC,SAAL,KAAA;AACL,EAAAA,UAAA,SAAU,CAAA,GAAA,SAAA,CAAA;AACV,EAAAA,UAAA,aAAc,CAAA,GAAA,aAAA,CAAA;AACd,EAAAA,UAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AACT,EAAAA,UAAA,QAAS,CAAA,GAAA,QAAA,CAAA;AAJC,EAAAA,OAAAA,SAAAA,CAAAA;AAAA,CAAA,EAAA,QAAA,IAAA,EAAA,EAAA;AAOA,IAAA,cAAA,qBAAAC,eAAL,KAAA;AACL,EAAAA,gBAAA,QAAS,CAAA,GAAA,EAAA,CAAA;AACT,EAAAA,gBAAA,YAAa,CAAA,GAAA,KAAA,CAAA;AACb,EAAAA,gBAAA,UAAW,CAAA,GAAA,KAAA,CAAA;AACX,EAAAA,gBAAA,UAAW,CAAA,GAAA,MAAA,CAAA;AACX,EAAAA,gBAAA,cAAe,CAAA,GAAA,KAAA,CAAA;AACf,EAAAA,gBAAA,uBAAwB,CAAA,GAAA,MAAA,CAAA;AACxB,EAAAA,gBAAA,iBAAkB,CAAA,GAAA,KAAA,CAAA;AAClB,EAAAA,gBAAA,0BAA2B,CAAA,GAAA,MAAA,CAAA;AAC3B,EAAAA,gBAAA,QAAS,CAAA,GAAA,SAAA,CAAA;AACT,EAAAA,gBAAA,SAAU,CAAA,GAAA,QAAA,CAAA;AAVA,EAAAA,OAAAA,eAAAA,CAAAA;AAAA,CAAA,EAAA,cAAA,IAAA,EAAA,EAAA;AAaA,IAAA,sBAAA,qBAAAC,uBAAL,KAAA;AACL,EAAAA,wBAAA,OAAQ,CAAA,GAAA,QAAA,CAAA;AACR,EAAAA,wBAAA,OAAQ,CAAA,GAAA,QAAA,CAAA;AACR,EAAAA,wBAAA,UAAW,CAAA,GAAA,WAAA,CAAA;AACX,EAAAA,wBAAA,UAAW,CAAA,GAAA,WAAA,CAAA;AAJD,EAAAA,OAAAA,uBAAAA,CAAAA;AAAA,CAAA,EAAA,sBAAA,IAAA,EAAA,EAAA;AAeA,IAAA,aAAA,qBAAAC,cAAL,KAAA;AACL,EAAAA,eAAA,KAAM,CAAA,GAAA,MAAA,CAAA;AACN,EAAAA,eAAA,IAAK,CAAA,GAAA,KAAA,CAAA;AAFK,EAAAA,OAAAA,cAAAA,CAAAA;AAAA,CAAA,EAAA,aAAA,IAAA,EAAA;;;;"}
|
|
@@ -260,14 +260,14 @@ class Entries extends baseQuery.BaseQuery {
|
|
|
260
260
|
* @method assetFields
|
|
261
261
|
* @memberof Entries
|
|
262
262
|
* @description Include specific asset fields in the response (CDA getEntry/entries).
|
|
263
|
-
* Use with asset_fields[]: user_defined_fields,
|
|
263
|
+
* Use with asset_fields[]: user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups.
|
|
264
264
|
* @example
|
|
265
265
|
* import contentstack from '@contentstack/delivery-sdk'
|
|
266
266
|
*
|
|
267
267
|
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
268
268
|
* const result = await stack.contentType("contentTypeUid").entry().assetFields("user_defined_fields", "embedded_metadata").find();
|
|
269
269
|
*
|
|
270
|
-
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields,
|
|
270
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups)
|
|
271
271
|
* @returns {Entries} - Returns the Entries instance for chaining.
|
|
272
272
|
*/
|
|
273
273
|
assetFields(...fields) {
|
|
@@ -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 * @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;;;;"}
|
|
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_metadata, ai_generated_metadata, 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_metadata, ai_generated_metadata, 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;;;;"}
|
|
@@ -258,14 +258,14 @@ class Entries extends BaseQuery {
|
|
|
258
258
|
* @method assetFields
|
|
259
259
|
* @memberof Entries
|
|
260
260
|
* @description Include specific asset fields in the response (CDA getEntry/entries).
|
|
261
|
-
* Use with asset_fields[]: user_defined_fields,
|
|
261
|
+
* Use with asset_fields[]: user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups.
|
|
262
262
|
* @example
|
|
263
263
|
* import contentstack from '@contentstack/delivery-sdk'
|
|
264
264
|
*
|
|
265
265
|
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
266
266
|
* const result = await stack.contentType("contentTypeUid").entry().assetFields("user_defined_fields", "embedded_metadata").find();
|
|
267
267
|
*
|
|
268
|
-
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields,
|
|
268
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups)
|
|
269
269
|
* @returns {Entries} - Returns the Entries instance for chaining.
|
|
270
270
|
*/
|
|
271
271
|
assetFields(...fields) {
|
|
@@ -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 * @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;;;;"}
|
|
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_metadata, ai_generated_metadata, 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_metadata, ai_generated_metadata, 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;;;;"}
|
|
@@ -255,14 +255,14 @@ class Entry {
|
|
|
255
255
|
* @method assetFields
|
|
256
256
|
* @memberof Entry
|
|
257
257
|
* @description Include specific asset fields in the response (CDA getEntry).
|
|
258
|
-
* Use with asset_fields[]: user_defined_fields,
|
|
258
|
+
* Use with asset_fields[]: user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups.
|
|
259
259
|
* @example
|
|
260
260
|
* import contentstack from '@contentstack/delivery-sdk'
|
|
261
261
|
*
|
|
262
262
|
* const stack = contentstack.stack({ apiKey: "apiKey", deliveryToken: "deliveryToken", environment: "environment" });
|
|
263
263
|
* const result = await stack.contentType("contentTypeUid").entry("entryUid").assetFields("user_defined_fields", "embedded_metadata").fetch();
|
|
264
264
|
*
|
|
265
|
-
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields,
|
|
265
|
+
* @param {...string} fields - Asset field names to include (e.g. user_defined_fields, embedded_metadata, ai_generated_metadata, visual_markups)
|
|
266
266
|
* @returns {Entry} - Returns the Entry instance for chaining.
|
|
267
267
|
*/
|
|
268
268
|
assetFields(...fields) {
|
|
@@ -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 /**\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;;;;"}
|
|
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_metadata, ai_generated_metadata, 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_metadata, ai_generated_metadata, 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;;;;"}
|