@isardsat/editorial-common 6.13.2 → 6.15.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @isardsat/editorial-common
 
+## 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
+
+## 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.
+
 ## 6.13.2
 
 ### Patch Changes

package/dist/data-utils.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Checks if the options value is a reference to another field.
+ * References are in the format $key_field
+ */
+export declare function getOptionsReference(options: string[] | undefined): string | null;

package/dist/data-utils.js

@@ -0,0 +1,10 @@
+/**
+ * Checks if the options value is a reference to another field.
+ * References are in the format $key_field
+ */
+export function getOptionsReference(options) {
+    if (!options || options.length !== 1)
+        return null;
+    const match = options[0].match(/^\$(.+)$/);
+    return match ? match[1] : null;
+}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
-export * from './schemas.js';
-export type * from './types.js';
+export * from "./data-utils.js";
+export * from "./schemas.js";
+export type * from "./types.js";

package/dist/index.js

@@ -1 +1,2 @@
-export * from './schemas.js';
+export * from "./data-utils.js";
+export * from "./schemas.js";

package/dist/schemas.d.ts

@@ -50,6 +50,7 @@ export declare const EditorialSchemaItemFieldType: z.ZodEnum<{
     markdown: "markdown";
     color: "color";
     select: "select";
+    multiselect: "multiselect";
 }>;
 export declare const RGBColorSchema: z.ZodString;
 export declare const EditorialSchemaItemFieldSchema: z.ZodObject<{
@@ -63,12 +64,17 @@ export declare const EditorialSchemaItemFieldSchema: z.ZodObject<{
         markdown: "markdown";
         color: "color";
         select: "select";
+        multiselect: "multiselect";
     }>;
     displayName: z.ZodString;
     displayExtra: z.ZodOptional<z.ZodString>;
     placeholder: z.ZodOptional<z.ZodString>;
-    optional: z.ZodDefault<z.ZodBoolean>;
+    optional: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
     showInSummary: z.ZodOptional<z.ZodBoolean>;
+    options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    maxSelectedOptions: z.ZodOptional<z.ZodNumber>;
+    minSelectedOptions: z.ZodOptional<z.ZodNumber>;
+    isUploadedFile: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$loose>;
 export declare const EditorialSchemaItemSchema: z.ZodObject<{
     displayName: z.ZodString;
@@ -85,12 +91,17 @@ export declare const EditorialSchemaItemSchema: z.ZodObject<{
             markdown: "markdown";
             color: "color";
             select: "select";
+            multiselect: "multiselect";
         }>;
         displayName: z.ZodString;
         displayExtra: z.ZodOptional<z.ZodString>;
         placeholder: z.ZodOptional<z.ZodString>;
-        optional: z.ZodDefault<z.ZodBoolean>;
+        optional: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
         showInSummary: z.ZodOptional<z.ZodBoolean>;
+        options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        maxSelectedOptions: z.ZodOptional<z.ZodNumber>;
+        minSelectedOptions: z.ZodOptional<z.ZodNumber>;
+        isUploadedFile: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$loose>>;
 }, z.core.$strip>;
 export declare const EditorialSchemaSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
@@ -108,12 +119,17 @@ export declare const EditorialSchemaSchema: z.ZodRecord<z.ZodString, z.ZodObject
             markdown: "markdown";
             color: "color";
             select: "select";
+            multiselect: "multiselect";
         }>;
         displayName: z.ZodString;
         displayExtra: z.ZodOptional<z.ZodString>;
         placeholder: z.ZodOptional<z.ZodString>;
-        optional: z.ZodDefault<z.ZodBoolean>;
+        optional: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
         showInSummary: z.ZodOptional<z.ZodBoolean>;
+        options: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        maxSelectedOptions: z.ZodOptional<z.ZodNumber>;
+        minSelectedOptions: z.ZodOptional<z.ZodNumber>;
+        isUploadedFile: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$loose>>;
 }, z.core.$strip>>;
 export declare const BaseEditorialFileSchema: z.ZodObject<{

package/dist/schemas.js

@@ -42,6 +42,8 @@ export const EditorialSchemaItemFieldType = z.enum([
     "color",
     "select",
     "url",
+    "select",
+    "multiselect",
 ]);
 export const RGBColorSchema = z
     .string()
@@ -63,8 +65,12 @@ export const EditorialSchemaItemFieldSchema = z.looseObject({
     displayName: z.string(),
     displayExtra: z.string().optional(),
     placeholder: z.string().optional(),
-    optional: z.boolean().default(false),
+    optional: z.boolean().optional().default(false),
     showInSummary: z.boolean().optional(),
+    options: z.array(z.string()).optional(),
+    maxSelectedOptions: z.number().optional(),
+    minSelectedOptions: z.number().optional(),
+    isUploadedFile: z.boolean().optional(),
 });
 export const EditorialSchemaItemSchema = z.object({
     displayName: z.string(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isardsat/editorial-common",
-  "version": "6.13.2",
+  "version": "6.15.0",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/data-utils.ts

@@ -0,0 +1,12 @@
+/**
+ * Checks if the options value is a reference to another field.
+ * References are in the format $key_field
+ */
+export function getOptionsReference(
+  options: string[] | undefined,
+): string | null {
+  if (!options || options.length !== 1) return null;
+
+  const match = options[0].match(/^\$(.+)$/);
+  return match ? match[1] : null;
+}

package/src/index.ts

@@ -1,2 +1,3 @@
-export * from './schemas.js';
-export type * from './types.js';
+export * from "./data-utils.js";
+export * from "./schemas.js";
+export type * from "./types.js";

package/src/schemas.ts

@@ -36,12 +36,12 @@ export const EditorialDataItemSchema = z.looseObject({
 
 export const EditorialDataTypeSchema = z.record(
   z.string(),
-  EditorialDataItemSchema
+  EditorialDataItemSchema,
 );
 
 export const EditorialDataSchema = z.record(
   z.string(),
-  EditorialDataTypeSchema
+  EditorialDataTypeSchema,
 );
 
 export const EditorialSchemaItemFieldType = z.enum([
@@ -54,16 +54,20 @@ export const EditorialSchemaItemFieldType = z.enum([
   "color",
   "select",
   "url",
+  "select",
+  "multiselect",
 ]);
 
 export const RGBColorSchema = z
   .string()
   .regex(
     /^rgb\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*\)$/,
-    "Must be a valid RGB color format: rgb(r, g, b)"
+    "Must be a valid RGB color format: rgb(r, g, b)",
   )
   .refine((value) => {
-    const match = value.match(/^rgb\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*\)$/);
+    const match = value.match(
+      /^rgb\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*\)$/,
+    );
     if (!match) return false;
     const [, r, g, b] = match;
     return (
@@ -81,8 +85,12 @@ export const EditorialSchemaItemFieldSchema = z.looseObject({
   displayName: z.string(),
   displayExtra: z.string().optional(),
   placeholder: z.string().optional(),
-  optional: z.boolean().default(false),
+  optional: z.boolean().optional().default(false),
   showInSummary: z.boolean().optional(),
+  options: z.array(z.string()).optional(),
+  maxSelectedOptions: z.number().optional(),
+  minSelectedOptions: z.number().optional(),
+  isUploadedFile: z.boolean().optional(),
 });
 
 export const EditorialSchemaItemSchema = z.object({
@@ -94,7 +102,7 @@ export const EditorialSchemaItemSchema = z.object({
 
 export const EditorialSchemaSchema = z.record(
   z.string(),
-  EditorialSchemaItemSchema
+  EditorialSchemaItemSchema,
 );
 
 export const BaseEditorialFileSchema = z.object({