Add editor charts api (#3078)

Author: stepanenkoxx

src/server/components/public-api/utils/init-public-api-swagger.ts

@@ -93,6 +93,8 @@ export const initPublicApiSwagger = (app: ExpressKit) => {
                 const swaggerOptions = {
                     url: jsonPath,
                     validatorUrl: null,
+                    tagsSorter: 'alpha',
+                    operationsSorter: 'alpha',
                 };
 
                 app.express.use(

src/shared/components/public-api/utils/index.ts

@@ -0,0 +1,11 @@
+const registeredComponents = new Set<string>();
+
+export const registerComponentId = (id: string): string => {
+    if (registeredComponents.has(id)) {
+        throw new Error(`OpenAPI component ${id} is already registered`);
+    }
+
+    registeredComponents.add(id);
+
+    return id;
+};

src/shared/schema/gateway-utils.ts

@@ -23,7 +23,7 @@ const VALIDATION_SCHEMA_KEY = Symbol('$schema');
 const registerValidationSchema = <T extends object>(value: T, schema: TypedActionSchema): T => {
     Object.defineProperty(value, VALIDATION_SCHEMA_KEY, {
         value: schema,
-        enumerable: false,
+        configurable: true,
     });
 
     return value;
@@ -62,6 +62,39 @@ export const createTypedAction = <TOutput, TParams, TTransformed = TOutput>(
     return registerValidationSchema(actionConfig, schemaValidationObject);
 };
 
+export const createExtendedTypedAction =
+    <TConfigOutput, TConfigParams, TConfigTransformed = TConfigOutput>(
+        actionConfig: ApiServiceActionConfig<
+            AppContext,
+            Request,
+            Response,
+            TConfigOutput,
+            TConfigParams,
+            TConfigTransformed
+        >,
+    ) =>
+    <TResult extends TConfigTransformed, TParams extends TConfigParams>(schema: {
+        resultSchema: z.ZodType<TResult>;
+        paramsSchema: z.ZodType<TParams>;
+    }) => {
+        const schemaValidationObject = {
+            paramsSchema: schema.paramsSchema,
+            resultSchema: schema.resultSchema,
+        };
+
+        return registerValidationSchema(
+            actionConfig as unknown as ApiServiceActionConfig<
+                AppContext,
+                Request,
+                Response,
+                TConfigOutput,
+                TParams,
+                TResult
+            >,
+            schemaValidationObject,
+        );
+    };
+
 type AuthArgsData = {
     userAccessToken?: string;
     serviceUserAccessToken?: string;

src/shared/schema/mix/schemas/ql.ts

@@ -8,7 +8,7 @@ export const deleteQLChartResultSchema = z.object({});
 
 export const getQLChartArgsSchema = z.strictObject({
     chartId: z.string(),
-    workbookId: z.union([z.string(), z.null()]).optional(),
+    workbookId: z.string().nullable().optional(),
     revId: z.string().optional(),
     includePermissions: z.boolean().optional(),
     includeLinks: z.boolean().optional(),

src/shared/schema/mix/schemas/wizard.ts

@@ -8,7 +8,7 @@ export const deleteWizardChartResultSchema = z.object({});
 
 export const getWizardChartArgsSchema = z.strictObject({
     chartId: z.string(),
-    workbookId: z.union([z.string(), z.null()]).optional(),
+    workbookId: z.string().nullable().optional(),
     revId: z.string().optional(),
     includePermissions: z.boolean().optional(),
     includeLinks: z.boolean().optional(),

src/shared/schema/us/actions/editor.ts

@@ -16,6 +16,7 @@ export const editorActions = {
         path: () => `${PATH_PREFIX}/entries`,
         params: (
             {
+                version,
                 type,
                 key,
                 data,
@@ -31,6 +32,7 @@ export const editorActions = {
         ) => {
             return {
                 body: {
+                    version,
                     scope: 'widget',
                     type,
                     key,
@@ -52,9 +54,13 @@ export const editorActions = {
         method: 'POST',
         path: ({entryId}) => `${PATH_PREFIX}/entries/${filterUrlFragment(entryId)}`,
 
-        params: ({data, mode, revId, meta = {}, links, annotation, description = ''}, headers) => {
+        params: (
+            {version, data, mode, revId, meta = {}, links, annotation, description = ''},
+            headers,
+        ) => {
             return {
                 body: {
+                    version,
                     mode,
                     meta,
                     data,

src/shared/schema/us/schemas/entries/list-directory.ts

@@ -19,8 +19,6 @@ export const listDirectoryArgsSchema = z.object({
     page: z.number().optional(),
     pageSize: z.number().optional(),
     includePermissionsInfo: z.boolean().optional(),
-    // Broken in US controller
-    // ignoreWorkbookEntries: z.boolean().optional(),
 });
 
 export const listDirectoryBreadCrumbSchema = z.object({

src/shared/schema/us/types/editor.ts

@@ -7,6 +7,7 @@ export interface CreateEditorChartResponse extends EntryFields {
 }
 
 export interface CreateEditorChartArgs {
+    version?: number;
     type: string;
     data: EntryFieldData;
     key?: string;
@@ -24,6 +25,7 @@ export interface UpdateEditorChartResponse extends EntryFields {
 }
 
 export interface UpdateEditorChartArgs {
+    version?: number;
     entryId: string;
     mode: 'save' | 'publish';
     data: EntryFieldData;

src/shared/schema/us/types/fields.ts

@@ -8,6 +8,7 @@ export type EntryFieldPublishedId = null | string;
 
 // corresponds to RETURN_COLUMNS from US
 export interface EntryFields {
+    version?: number | null;
     displayAlias?: string | null;
     createdAt: string;
     createdBy: string;

src/shared/utils/array/assert-non-empty-array.ts

@@ -0,0 +1,5 @@
+export function assertNonEmptyArray<T>(arr: T[], message?: string): asserts arr is [T, ...T[]] {
+    if (arr.length === 0) {
+        throw new Error(message ?? 'Array must not be empty!');
+    }
+}