@isardsat/editorial-client 6.13.2 → 6.15.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @isardsat/editorial-client
 
+## 6.15.0
+
+### Minor Changes
+
+- 7ff5f4d: - Adds a new /api/v1/meta-schema endpoint that returns the JSON Schema for the Editorial configuration.
+  - Includes optional `allowedExtraFields` parameter to allow additional fields not defined in the meta-schema.
+  - - Updated the CLI `init` command to automatically add the line `# yaml-language-server: $schema=http://localhost:3001/api/v1/meta-schema` to schema.yml
+
+### Patch Changes
+
+- Updated dependencies [7ff5f4d]
+  - @isardsat/editorial-common@6.15.0
+
+## 6.14.0
+
+### Minor Changes
+
+- 61cb350: This PR adds:
+  - select and multiselect (with maxSelectedItems and 'minSelectedItems` optional fields) field types.
+  - Support for dynamic options via $field_name references to populate from other data types.
+  - resolve param to /api/v1/data /api/v1/data/{itemType} /api/v1/data/{itemType}/{id} GET endpoints which resolve referenced fields to full objects.
+
+### Patch Changes
+
+- Updated dependencies [61cb350]
+  - @isardsat/editorial-common@6.14.0
+
 ## 6.13.2
 
 ### Patch Changes

package/dist/client.js

@@ -55,6 +55,9 @@ export function createEditorialClient(baseURL, options = {}) {
         if (options.preview) {
             params.append("preview", "true");
         }
+        if (options.resolve) {
+            params.append("resolve", "true");
+        }
         return params;
     }
     return {

package/dist/types.d.ts

@@ -10,6 +10,8 @@ export interface GetContentOptions {
     locale?: string;
     /** Include preview/draft content in the response */
     preview?: boolean;
+    /** Resolve references to other content items in the response */
+    resolve?: boolean;
 }
 export interface EditorialClientInterface {
     getSchema(): Promise<EditorialSchema>;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@isardsat/editorial-client",
-  "version": "6.13.2",
+  "version": "6.15.0",
   "description": "JavaScript client for the Editorial CMS API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "dependencies": {
-    "@isardsat/editorial-common": "6.13.2"
+    "@isardsat/editorial-common": "6.15.0"
   },
   "devDependencies": {
     "@tsconfig/node22": "^22.0.0",

package/src/client.ts

@@ -19,7 +19,7 @@ import type {
 
 export function createEditorialClient(
   baseURL: string,
-  options: ClientOptions = {}
+  options: ClientOptions = {},
 ): EditorialClientInterface {
   const apiBaseURL = new URL("/api/v1/", baseURL);
   const defaultLocale = options.defaultLocale || "en";
@@ -32,7 +32,7 @@ export function createEditorialClient(
 
   async function request<T>(
     endpoint: string,
-    requestOptions: RequestInit = {}
+    requestOptions: RequestInit = {},
   ): Promise<T> {
     const url = new URL(endpoint, apiBaseURL);
 
@@ -67,7 +67,7 @@ export function createEditorialClient(
         throw new EditorialError(
           errorMessage || `HTTP ${response.status} ${response.statusText}`,
           response.status,
-          response.statusText
+          response.statusText,
         );
       }
 
@@ -87,7 +87,7 @@ export function createEditorialClient(
         `Network error: ${
           error instanceof Error ? error.message : "Unknown error"
         }`,
-        error instanceof Error ? error : undefined
+        error instanceof Error ? error : undefined,
       );
     }
   }
@@ -103,6 +103,10 @@ export function createEditorialClient(
       params.append("preview", "true");
     }
 
+    if (options.resolve) {
+      params.append("resolve", "true");
+    }
+
     return params;
   }
 
@@ -116,7 +120,7 @@ export function createEditorialClient(
     },
 
     async getContent<T = EditorialData>(
-      options: GetContentOptions = {}
+      options: GetContentOptions = {},
     ): Promise<T> {
       const params = buildQueryParams(options);
       const endpoint = params.toString() ? `data?${params}` : "data";
@@ -126,7 +130,7 @@ export function createEditorialClient(
 
     async getContentByType<T = EditorialDataType>(
       type: string,
-      options: GetContentOptions = {}
+      options: GetContentOptions = {},
     ): Promise<T[]> {
       const params = buildQueryParams(options);
       const endpoint = params.toString()
@@ -139,7 +143,7 @@ export function createEditorialClient(
 
     async getContentIds(
       type: string,
-      options: GetContentOptions = {}
+      options: GetContentOptions = {},
     ): Promise<string[]> {
       const params = new URLSearchParams();
       if (options.preview) {
@@ -156,7 +160,7 @@ export function createEditorialClient(
     async getContentById<T = EditorialDataItem>(
       type: string,
       id: string,
-      options: GetContentOptions = {}
+      options: GetContentOptions = {},
     ): Promise<T> {
       const params = buildQueryParams(options);
       const endpoint = params.toString()
@@ -169,28 +173,28 @@ export function createEditorialClient(
     async createContent<T = EditorialDataItem>(
       type: string,
       id: string,
-      data: T
+      data: T,
     ): Promise<T> {
       return request<T>(
         `data/${encodeURIComponent(type)}/${encodeURIComponent(id)}`,
         {
           method: "PUT",
           body: JSON.stringify(data),
-        }
+        },
       );
     },
 
     async updateContent<T = EditorialDataItem>(
       type: string,
       id: string,
-      data: Partial<T>
+      data: Partial<T>,
     ): Promise<T> {
       return request<T>(
         `data/${encodeURIComponent(type)}/${encodeURIComponent(id)}`,
         {
           method: "PATCH",
           body: JSON.stringify(data),
-        }
+        },
       );
     },
 
@@ -199,7 +203,7 @@ export function createEditorialClient(
         `data/${encodeURIComponent(type)}/${encodeURIComponent(id)}`,
         {
           method: "DELETE",
-        }
+        },
       );
     },
   };

package/src/types.ts

@@ -18,6 +18,8 @@ export interface GetContentOptions {
   locale?: string;
   /** Include preview/draft content in the response */
   preview?: boolean;
+  /** Resolve references to other content items in the response */
+  resolve?: boolean;
 }
 
 export interface EditorialClientInterface {
@@ -26,23 +28,23 @@ export interface EditorialClientInterface {
   getContent<T = EditorialData>(options?: GetContentOptions): Promise<T>;
   getContentByType<T = EditorialDataType>(
     type: string,
-    options?: GetContentOptions
+    options?: GetContentOptions,
   ): Promise<T[]>;
   getContentIds(type: string, options?: GetContentOptions): Promise<string[]>;
   getContentById<T = EditorialDataItem>(
     type: string,
     id: string,
-    options?: GetContentOptions
+    options?: GetContentOptions,
   ): Promise<T>;
   createContent<T = EditorialDataItem>(
     type: string,
     id: string,
-    data: T
+    data: T,
   ): Promise<T>;
   updateContent<T = EditorialDataItem>(
     type: string,
     id: string,
-    data: Partial<T>
+    data: Partial<T>,
   ): Promise<T>;
   deleteContent(type: string, id: string): Promise<boolean>;
 }