@contentful/experience-delivery 1.0.0-dev.4 → 1.0.0-dev.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Contentful
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -10,8 +10,8 @@ A TypeScript client for delivering and previewing Contentful Experiences. Fetch
 
 - [Installation](#installation)
 - [Reference](#reference)
-- [Authentication](#authentication)
 - [Usage](#usage)
+- [Authentication](#authentication)
 - [Environments](#environments)
 - [Request and Response Types](#request-and-response-types)
 - [Exception Handling](#exception-handling)
@@ -37,6 +37,30 @@ npm i -s @contentful/experience-delivery
 
 A full reference for this library is available [here](https://github.com/contentful/contentful-experience-delivery.js/blob/HEAD/./reference.md).
 
+## Usage
+
+Instantiate the client with a Content Delivery API token and fetch a published
+Experience:
+
+```typescript
+import { ContentfulViewDeliveryClient } from "@contentful/experience-delivery";
+
+const client = new ContentfulViewDeliveryClient({
+    token: process.env.CONTENTFUL_CDA_TOKEN!,
+});
+
+const experience = await client.view.getExperience(
+    "spaceId",
+    "environmentId",
+    "experienceId",
+    { locale: "en-US" },
+);
+```
+
+See [Authentication](#authentication) for preview tokens and the
+`access_token` query-parameter alternative.
+
+
 ## Authentication
 
 The API supports two authentication modes — both backed by a Contentful access token.
@@ -86,23 +110,6 @@ await client.view.getExperience(spaceId, envId, experienceId, {
 ```
 
 
-## Usage
-
-Instantiate and use the client with the following:
-
-```typescript
-import { ContentfulViewDeliveryClient } from "@contentful/experience-delivery";
-
-const client = new ContentfulViewDeliveryClient({ token: "YOUR_TOKEN" });
-await client.view.getExperienceWithOverrides("spaceId", "environmentId", "id", {
-    preview: "true",
-    accessToken: "access_token",
-    optimizationProfileId: "optimization-profile-id",
-    locale: "locale",
-    variant: "variant"
-});
-```
-
 ## Environments
 
 This SDK allows you to configure different environments for API requests.

package/dist/cjs/BaseClient.js

@@ -43,8 +43,8 @@ function normalizeClientOptions(options) {
     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.3",
-        "User-Agent": "@contentful/experience-delivery/0.0.0-fern-placeholder.3",
+        "X-Fern-SDK-Version": "0.0.0-fern-placeholder.4",
+        "User-Agent": "@contentful/experience-delivery/0.0.0-fern-placeholder.4",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.0-fern-placeholder.3";
+export declare const SDK_VERSION = "0.0.0-fern-placeholder.4";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.0-fern-placeholder.3";
+exports.SDK_VERSION = "0.0.0-fern-placeholder.4";

package/dist/esm/BaseClient.mjs

@@ -6,8 +6,8 @@ export function normalizeClientOptions(options) {
     const headers = mergeHeaders({
         "X-Fern-Language": "JavaScript",
         "X-Fern-SDK-Name": "@contentful/experience-delivery",
-        "X-Fern-SDK-Version": "0.0.0-fern-placeholder.3",
-        "User-Agent": "@contentful/experience-delivery/0.0.0-fern-placeholder.3",
+        "X-Fern-SDK-Version": "0.0.0-fern-placeholder.4",
+        "User-Agent": "@contentful/experience-delivery/0.0.0-fern-placeholder.4",
         "X-Fern-Runtime": core.RUNTIME.type,
         "X-Fern-Runtime-Version": core.RUNTIME.version,
     }, options === null || options === void 0 ? void 0 : options.headers);

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.0-fern-placeholder.3";
+export declare const SDK_VERSION = "0.0.0-fern-placeholder.4";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.0.0-fern-placeholder.3";
+export const SDK_VERSION = "0.0.0-fern-placeholder.4";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@contentful/experience-delivery",
-    "version": "1.0.0-dev.4",
+    "version": "1.0.0-dev.5",
     "private": false,
     "repository": {
         "type": "git",
@@ -74,7 +74,8 @@
         "build:cjs": "tsc --project ./tsconfig.cjs.json",
         "build:esm": "tsc --project ./tsconfig.esm.json && node scripts/rename-to-esm-files.js dist/esm",
         "test": "vitest",
-        "test:unit": "vitest --project unit"
+        "test:unit": "vitest --project unit",
+        "update-licenses": "node ./scripts/update-licenses.js"
     },
     "dependencies": {},
     "devDependencies": {
@@ -83,7 +84,8 @@
         "vitest": "^4.1.1",
         "@types/node": "^20.0.0",
         "typescript": "~5.9.3",
-        "@biomejs/biome": "2.4.10"
+        "@biomejs/biome": "2.4.10",
+        "license-checker-rseidelsohn": "^4.4.2"
     },
     "browser": {
         "fs": false,
@@ -97,5 +99,6 @@
         "node": ">=18.0.0"
     },
     "sideEffects": false,
-    "description": "TypeScript client for Contentful's Experience Delivery and Preview API"
+    "description": "TypeScript client for Contentful's Experience Delivery and Preview API",
+    "license": "MIT"
 }