@contentful/experience-delivery 1.0.0-dev.6 → 1.0.0-dev.8

package/dist/cjs/BaseClient.d.ts

@@ -6,6 +6,8 @@ export type BaseClientOptions = {
     environment?: core.Supplier<environments.ContentfulViewDeliveryEnvironment | string>;
     /** Specify a custom URL to connect the client to. */
     baseUrl?: core.Supplier<string>;
+    /** Override the x-contentful-enable-alpha-feature header */
+    xContentfulEnableAlphaFeature?: "new-exo-entity-types";
     /** Additional headers to include in requests. */
     headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
     /** The default maximum time to wait for a response in seconds. */
@@ -26,6 +28,8 @@ export interface BaseRequestOptions {
     maxRetries?: number;
     /** A hook to abort the request. */
     abortSignal?: AbortSignal;
+    /** Override the x-contentful-enable-alpha-feature header */
+    xContentfulEnableAlphaFeature?: "new-exo-entity-types";
     /** Additional query string parameters to include in the request. */
     queryParams?: Record<string, unknown>;
     /** Additional headers to include in the request. */

package/dist/cjs/BaseClient.js

@@ -40,13 +40,15 @@ const BearerAuthProvider_js_1 = require("./auth/BearerAuthProvider.js");
 const headers_js_1 = require("./core/headers.js");
 const core = __importStar(require("./core/index.js"));
 function normalizeClientOptions(options) {
+    var _a;
     const headers = (0, headers_js_1.mergeHeaders)({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@contentful/experience-delivery",
-        "X-Fern-SDK-Version": "0.0.0-fern-placeholder.5",
-        "User-Agent": "@contentful/experience-delivery/0.0.0-fern-placeholder.5",
+        "X-Fern-SDK-Version": "0.0.0-fern-placeholder.7",
+        "User-Agent": "@contentful/experience-delivery/0.0.0-fern-placeholder.7",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
+        "x-contentful-enable-alpha-feature": (_a = options === null || options === void 0 ? void 0 : options.xContentfulEnableAlphaFeature) !== null && _a !== void 0 ? _a : "new-exo-entity-types",
     }, options === null || options === void 0 ? void 0 : options.headers);
     return Object.assign(Object.assign({}, options), { logging: core.logging.createLogger(options === null || options === void 0 ? void 0 : options.logging), headers });
 }

package/dist/cjs/Client.d.ts

@@ -1,4 +1,5 @@
 import { ComponentClient } from "./api/resources/component/client/Client.js";
+import { DestinationClient } from "./api/resources/destination/client/Client.js";
 import { ExperienceClient } from "./api/resources/experience/client/Client.js";
 import { ExperienceFragmentClient } from "./api/resources/experienceFragment/client/Client.js";
 import { FragmentClient } from "./api/resources/fragment/client/Client.js";
@@ -19,6 +20,7 @@ export declare class ContentfulViewDeliveryClient {
     protected _component: ComponentClient | undefined;
     protected _fragment: FragmentClient | undefined;
     protected _experienceFragment: ExperienceFragmentClient | undefined;
+    protected _destination: DestinationClient | undefined;
     protected _release: ReleaseClient | undefined;
     constructor(options: ContentfulViewDeliveryClient.Options);
     get experience(): ExperienceClient;
@@ -26,6 +28,7 @@ export declare class ContentfulViewDeliveryClient {
     get component(): ComponentClient;
     get fragment(): FragmentClient;
     get experienceFragment(): ExperienceFragmentClient;
+    get destination(): DestinationClient;
     get release(): ReleaseClient;
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/cjs/Client.js

@@ -45,11 +45,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContentfulViewDeliveryClient = void 0;
 const Client_js_1 = require("./api/resources/component/client/Client.js");
-const Client_js_2 = require("./api/resources/experience/client/Client.js");
-const Client_js_3 = require("./api/resources/experienceFragment/client/Client.js");
-const Client_js_4 = require("./api/resources/fragment/client/Client.js");
-const Client_js_5 = require("./api/resources/release/client/Client.js");
-const Client_js_6 = require("./api/resources/template/client/Client.js");
+const Client_js_2 = require("./api/resources/destination/client/Client.js");
+const Client_js_3 = require("./api/resources/experience/client/Client.js");
+const Client_js_4 = require("./api/resources/experienceFragment/client/Client.js");
+const Client_js_5 = require("./api/resources/fragment/client/Client.js");
+const Client_js_6 = require("./api/resources/release/client/Client.js");
+const Client_js_7 = require("./api/resources/template/client/Client.js");
 const BaseClient_js_1 = require("./BaseClient.js");
 const core = __importStar(require("./core/index.js"));
 class ContentfulViewDeliveryClient {
@@ -58,11 +59,11 @@ class ContentfulViewDeliveryClient {
     }
     get experience() {
         var _a;
-        return ((_a = this._experience) !== null && _a !== void 0 ? _a : (this._experience = new Client_js_2.ExperienceClient(this._options)));
+        return ((_a = this._experience) !== null && _a !== void 0 ? _a : (this._experience = new Client_js_3.ExperienceClient(this._options)));
     }
     get template() {
         var _a;
-        return ((_a = this._template) !== null && _a !== void 0 ? _a : (this._template = new Client_js_6.TemplateClient(this._options)));
+        return ((_a = this._template) !== null && _a !== void 0 ? _a : (this._template = new Client_js_7.TemplateClient(this._options)));
     }
     get component() {
         var _a;
@@ -70,15 +71,19 @@ class ContentfulViewDeliveryClient {
     }
     get fragment() {
         var _a;
-        return ((_a = this._fragment) !== null && _a !== void 0 ? _a : (this._fragment = new Client_js_4.FragmentClient(this._options)));
+        return ((_a = this._fragment) !== null && _a !== void 0 ? _a : (this._fragment = new Client_js_5.FragmentClient(this._options)));
     }
     get experienceFragment() {
         var _a;
-        return ((_a = this._experienceFragment) !== null && _a !== void 0 ? _a : (this._experienceFragment = new Client_js_3.ExperienceFragmentClient(this._options)));
+        return ((_a = this._experienceFragment) !== null && _a !== void 0 ? _a : (this._experienceFragment = new Client_js_4.ExperienceFragmentClient(this._options)));
+    }
+    get destination() {
+        var _a;
+        return ((_a = this._destination) !== null && _a !== void 0 ? _a : (this._destination = new Client_js_2.DestinationClient(this._options)));
     }
     get release() {
         var _a;
-        return ((_a = this._release) !== null && _a !== void 0 ? _a : (this._release = new Client_js_5.ReleaseClient(this._options)));
+        return ((_a = this._release) !== null && _a !== void 0 ? _a : (this._release = new Client_js_6.ReleaseClient(this._options)));
     }
     /**
      * Make a passthrough request using the SDK's configured auth, retry, logging, etc.

package/dist/cjs/api/resources/component/client/Client.js

@@ -85,7 +85,7 @@ class ComponentClient {
     }
     __get(spaceId_1, environmentId_1, id_1) {
         return __awaiter(this, arguments, void 0, function* (spaceId, environmentId, id, request = {}, requestOptions) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
             const { preview, accessToken, optimizationProfileId, locale, variant } = request;
             const _queryParams = {
                 preview,
@@ -95,9 +95,11 @@ class ComponentClient {
                 variant,
             };
             const _authRequest = yield this._options.authProvider.getAuthRequest();
-            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                "x-contentful-enable-alpha-feature": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.xContentfulEnableAlphaFeature) !== null && _b !== void 0 ? _b : "new-exo-entity-types",
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ContentfulViewDeliveryEnvironment.Default, `spaces/${core.url.encodePathParam(spaceId)}/environments/${core.url.encodePathParam(environmentId)}/components/${core.url.encodePathParam(id)}`),
+                url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ContentfulViewDeliveryEnvironment.Default, `spaces/${core.url.encodePathParam(spaceId)}/environments/${core.url.encodePathParam(environmentId)}/components/${core.url.encodePathParam(id)}`),
                 method: "GET",
                 headers: _headers,
                 queryString: core.url
@@ -105,10 +107,10 @@ class ComponentClient {
                     .addMany(_queryParams)
                     .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
                     .build(),
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
+                maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_k = this._options) === null || _k === void 0 ? void 0 : _k.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {

package/dist/cjs/api/resources/destination/client/Client.d.ts

@@ -0,0 +1,96 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as ContentfulViewDelivery from "../../../index.js";
+export declare namespace DestinationClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class DestinationClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<DestinationClient.Options>;
+    constructor(options: DestinationClient.Options);
+    /**
+     * @param {string} spaceId - ID of the space.
+     * @param {string} destinationId - ID of the published Destination.
+     * @param {ContentfulViewDelivery.SitemapDestinationRequest} request
+     * @param {DestinationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ContentfulViewDelivery.BadRequestError}
+     * @throws {@link ContentfulViewDelivery.UnauthorizedError}
+     * @throws {@link ContentfulViewDelivery.ForbiddenError}
+     * @throws {@link ContentfulViewDelivery.NotFoundError}
+     * @throws {@link ContentfulViewDelivery.ConflictError}
+     * @throws {@link ContentfulViewDelivery.UnprocessableEntityError}
+     * @throws {@link ContentfulViewDelivery.InternalServerError}
+     *
+     * @example
+     *     await client.destination.sitemap("yadj1kx9rmg0", "4RqKkGJqLHpMiomHuILv5N", {
+     *         limit: 1,
+     *         pageNext: "pageNext",
+     *         pagePrev: "pagePrev"
+     *     })
+     */
+    sitemap(spaceId: string, destinationId: string, request?: ContentfulViewDelivery.SitemapDestinationRequest, requestOptions?: DestinationClient.RequestOptions): core.HttpResponsePromise<ContentfulViewDelivery.DestinationSitemap>;
+    private __sitemap;
+    /**
+     * @param {string} spaceId - ID of the space.
+     * @param {string} destinationId - ID of the published Destination.
+     * @param {string} nodeId - ID of the Destination Node to resolve.
+     * @param {DestinationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ContentfulViewDelivery.BadRequestError}
+     * @throws {@link ContentfulViewDelivery.UnauthorizedError}
+     * @throws {@link ContentfulViewDelivery.ForbiddenError}
+     * @throws {@link ContentfulViewDelivery.NotFoundError}
+     * @throws {@link ContentfulViewDelivery.ConflictError}
+     * @throws {@link ContentfulViewDelivery.UnprocessableEntityError}
+     * @throws {@link ContentfulViewDelivery.InternalServerError}
+     *
+     * @example
+     *     await client.destination.resolveByNodeId("yadj1kx9rmg0", "4RqKkGJqLHpMiomHuILv5N", "6BslKh9TdKGOK41VmLDjFZ")
+     */
+    resolveByNodeId(spaceId: string, destinationId: string, nodeId: string, requestOptions?: DestinationClient.RequestOptions): core.HttpResponsePromise<ContentfulViewDelivery.DestinationExperienceResolutionResponse>;
+    private __resolveByNodeId;
+    /**
+     * @param {string} spaceId - ID of the space.
+     * @param {string} destinationId - ID of the published Destination.
+     * @param {string} nodeId - ID of the Destination Node to resolve.
+     * @param {ContentfulViewDelivery.DestinationExperiencesByNodeRequest} request
+     * @param {DestinationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ContentfulViewDelivery.BadRequestError}
+     * @throws {@link ContentfulViewDelivery.UnauthorizedError}
+     * @throws {@link ContentfulViewDelivery.ForbiddenError}
+     * @throws {@link ContentfulViewDelivery.NotFoundError}
+     * @throws {@link ContentfulViewDelivery.ConflictError}
+     * @throws {@link ContentfulViewDelivery.UnprocessableEntityError}
+     * @throws {@link ContentfulViewDelivery.InternalServerError}
+     *
+     * @example
+     *     await client.destination.resolveByNodeIdWithOverrides("yadj1kx9rmg0", "4RqKkGJqLHpMiomHuILv5N", "6BslKh9TdKGOK41VmLDjFZ")
+     */
+    resolveByNodeIdWithOverrides(spaceId: string, destinationId: string, nodeId: string, request?: ContentfulViewDelivery.DestinationExperiencesByNodeRequest, requestOptions?: DestinationClient.RequestOptions): core.HttpResponsePromise<ContentfulViewDelivery.DestinationExperienceResolutionResponse>;
+    private __resolveByNodeIdWithOverrides;
+    /**
+     * @param {string} spaceId - ID of the space.
+     * @param {string} destinationId - ID of the published Destination.
+     * @param {ContentfulViewDelivery.DestinationExperiencesByPathRequest} request
+     * @param {DestinationClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ContentfulViewDelivery.BadRequestError}
+     * @throws {@link ContentfulViewDelivery.UnauthorizedError}
+     * @throws {@link ContentfulViewDelivery.ForbiddenError}
+     * @throws {@link ContentfulViewDelivery.NotFoundError}
+     * @throws {@link ContentfulViewDelivery.ConflictError}
+     * @throws {@link ContentfulViewDelivery.UnprocessableEntityError}
+     * @throws {@link ContentfulViewDelivery.InternalServerError}
+     *
+     * @example
+     *     await client.destination.resolveByPath("yadj1kx9rmg0", "4RqKkGJqLHpMiomHuILv5N", {
+     *         path: "/products"
+     *     })
+     */
+    resolveByPath(spaceId: string, destinationId: string, request: ContentfulViewDelivery.DestinationExperiencesByPathRequest, requestOptions?: DestinationClient.RequestOptions): core.HttpResponsePromise<ContentfulViewDelivery.DestinationExperienceResolutionResponse>;
+    private __resolveByPath;
+}