New reordering algorithm

Author: stefanoverna

biome.json

@@ -29,5 +29,13 @@
     "formatter": {
       "quoteStyle": "single"
     }
-  }
+  },
+  "overrides": [
+    {
+      "include": ["package.json"],
+      "formatter": {
+        "lineWidth": 1
+      }
+    }
+  ]
 }

packages/cli/package-lock.json

@@ -34,7 +34,7 @@
     "@oclif/plugin-warn-if-update-available": "^2.0.4",
     "lodash": "^4.17.21",
     "mkdirp": "^1.0.4",
-    "prettier": "^2.7.1",
+    "prettier": "^3.3.3",
     "ts-node": "^10.7.0",
     "typescript": "~4.5.0"
   },

packages/cli/package.json

@@ -10,6 +10,7 @@ export async function fetchSchema(client: CmaClient.Client): Promise<Schema> {
     workflowsResponse,
     itemTypeFiltersResponse,
     uploadFiltersResponse,
+    uploadCollectionsResponse,
   ] = await Promise.all([
     client.site.rawFind({
       include: 'item_types,item_types.fields,item_types.fieldsets',
@@ -20,6 +21,7 @@ export async function fetchSchema(client: CmaClient.Client): Promise<Schema> {
     client.workflows.rawList(),
     client.itemTypeFilters.rawList(),
     client.uploadFilters.rawList(),
+    client.uploadCollections.rawList(),
   ]);
 
   const includedResources = siteResponse.included || [];
@@ -70,6 +72,12 @@ export async function fetchSchema(client: CmaClient.Client): Promise<Schema> {
         schemaMenuItem,
       ]),
     ),
+    uploadCollectionsById: Object.fromEntries(
+      uploadCollectionsResponse.data.map((uploadCollection) => [
+        uploadCollection.id,
+        uploadCollection,
+      ]),
+    ),
     pluginsById: Object.fromEntries(
       pluginsResponse.data.map((plugin) => [plugin.id, plugin]),
     ),

packages/cli/src/utils/environments-diff/fetch-schema.ts

@@ -10,6 +10,7 @@ import { manageItemTypeFilters } from './resources/manage-item-type-filters';
 import { manageMenuItems } from './resources/manage-menu-items';
 import { managePlugins } from './resources/manage-plugins';
 import { manageSchemaMenuItems } from './resources/manage-schema-menu-items';
+import { manageUploadCollections } from './resources/manage-upload-collections';
 import { manageUploadFilters } from './resources/manage-upload-filters';
 import { manageWorkflows } from './resources/manage-workflows';
 import { updateFieldsAndFieldsets } from './resources/update-fields-and-fieldsets';
@@ -51,10 +52,15 @@ export async function diffEnvironments({
     ...manageItemTypeFilters(newSchema, oldSchema),
     ...manageMenuItems(newSchema, oldSchema),
     ...manageSchemaMenuItems(newSchema, oldSchema),
+    ...manageUploadCollections(newSchema, oldSchema),
     ...updateRoles(roles, newEnvironmentId, oldEnvironmentId),
   ];
 
   const options = await resolveConfig(migrationFilePath);
 
-  return write(commands, { ...options, format, filepath: migrationFilePath });
+  return write(commands, {
+    ...options,
+    format,
+    filepath: migrationFilePath,
+  });
 }

packages/cli/src/utils/environments-diff/index.ts

@@ -0,0 +1,113 @@
+import { isEqual } from 'lodash';
+import { buildLog } from './comments';
+
+type ReorderableEntity<EntityType extends string> = {
+  id: string;
+  type: EntityType;
+  /**
+   * JSON API attributes
+   */
+  attributes: {
+    /**
+     * Ordering index
+     */
+    position: number;
+  };
+  relationships: {
+    /**
+     * Parent menu item
+     */
+    parent: {
+      data: null | {
+        id: string;
+        type: EntityType;
+      };
+    };
+  };
+};
+
+type SingleReorderCommand<EntityType extends string> = {
+  id: string;
+  type: EntityType;
+  /**
+   * JSON API attributes
+   */
+  attributes: {
+    /**
+     * Ordering index
+     */
+    position: number;
+  };
+  relationships: {
+    /**
+     * Parent menu item
+     */
+    parent: {
+      data: null | {
+        id: string;
+        type: EntityType;
+      };
+    };
+  };
+};
+
+export function buildReorderCommand<
+  T extends string,
+  Command extends {
+    type: 'apiCallClientCommand';
+    call: string;
+    arguments: [{ data: SingleReorderCommand<T>[] }];
+  },
+>(
+  call: Command['call'],
+  keptEntities: [ReorderableEntity<T>, ReorderableEntity<T>][],
+  newEntities: ReorderableEntity<T>[],
+) {
+  const commands: SingleReorderCommand<T>[] = [
+    ...newEntities,
+    ...keptEntities
+      .filter(
+        ([newEntity, oldEntity]) =>
+          !isEqual(
+            newEntity.attributes.position,
+            oldEntity.attributes.position,
+          ) ||
+          !isEqual(
+            newEntity.relationships.parent.data?.id,
+            oldEntity.relationships.parent.data?.id,
+          ),
+      )
+      .map((tuple) => tuple[0]),
+  ].map((entity) => ({
+    id: entity.id,
+    type: entity.type,
+    attributes: { position: entity.attributes.position },
+    relationships: {
+      parent: {
+        data: entity.relationships.parent.data?.id
+          ? {
+              id: entity.relationships.parent.data.id,
+              type: entity.type,
+            }
+          : null,
+      },
+    },
+  }));
+
+  if (commands.length === 0) {
+    return [];
+  }
+
+  return [
+    buildLog('Reorder elements in the tree'),
+    {
+      type: 'apiCallClientCommand',
+      call,
+      arguments: [
+        {
+          data: commands,
+        },
+      ],
+    },
+  ] as Command[];
+}

packages/cli/src/utils/environments-diff/resources/build-reorder-command.ts

@@ -1,5 +1,5 @@
-import type { Comment } from '../types';
+import type { LogCommand } from '../types';
 
-export function buildComment(message: string): Comment {
-  return { type: 'comment', message };
+export function buildLog(message: string): LogCommand {
+  return { type: 'log', message };
 }