feat(schema): introduce shortcuts, history and aliases

Author: Plopix

components/schema/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@crystallize/schema",
-    "version": "6.5.0",
+    "version": "6.6.0",
     "license": "MIT",
     "repository": {
         "type": "git",

components/schema/src/mass-operation/index.ts

@@ -15,6 +15,9 @@ import {
     UpdateProductOperationSchema,
     UpsertProductOperationSchema,
     DeleteItemOperationSchema,
+    AddItemTreeNodeAliasesOperationSchema,
+    AddItemTreeNodeShortcutsOperationSchema,
+    AddItemTreeNodeHistoryOperationSchema,
 } from './item';
 import {
     CreatePieceOperationSchema,
@@ -106,6 +109,10 @@ export const OperationSchema = z.discriminatedUnion('intent', [
     CreateTopicOperationSchema,
     UpdateTopicOperationSchema,
     UpsertTopicOperationSchema,
+
+    AddItemTreeNodeAliasesOperationSchema,
+    AddItemTreeNodeShortcutsOperationSchema,
+    AddItemTreeNodeHistoryOperationSchema,
 ]);
 
 export const OperationsSchema = z.object({
@@ -132,6 +139,9 @@ export type {
     UpdateItemComponentOperation,
     UpdateSkuComponentOperation,
     DeleteItemOperation,
+    AddItemTreeNodeAliasesOperation,
+    AddItemTreeNodeShortcutsOperation,
+    AddItemTreeNodeHistoryOperation,
 } from './item';
 
 export type {

components/schema/src/mass-operation/item.ts

@@ -98,25 +98,66 @@ export const UpdateSkuComponentOperationSchema = z.object({
     sku: z.string(),
 });
 
-export const PublishItemOperationSchema = z.object({
-    _ref: RefSchema.optional(),
-    intent: z.literal('item/publish'),
-    language: z.string().min(1),
-    includeDescendants: z.boolean().optional(),
-    itemId: IdSchema.optional(),
-    resourceIdentifier: ResourceIdentifierSchema.optional(),
-});
+export const PublishItemOperationSchema = z
+    .object({
+        _ref: RefSchema.optional(),
+        intent: z.literal('item/publish'),
+        language: z.string().min(1),
+        includeDescendants: z.boolean().optional(),
+        itemId: IdSchema.optional(),
+        resourceIdentifier: ResourceIdentifierSchema.optional(),
+    })
+    .superRefine(checkResourceIdentifierOrId);
 
 export const UnPublishItemOperationSchema = PublishItemOperationSchema.omit({ intent: true }).extend({
     intent: z.literal('item/unpublish'),
 });
 
-export const DeleteItemOperationSchema = z.object({
-    _ref: RefSchema.optional(),
-    intent: z.literal('item/delete'),
-    itemId: IdSchema.optional(),
-    resourceIdentifier: ResourceIdentifierSchema.optional(),
-});
+export const DeleteItemOperationSchema = z
+    .object({
+        _ref: RefSchema.optional(),
+        intent: z.literal('item/delete'),
+        itemId: IdSchema.optional(),
+        resourceIdentifier: ResourceIdentifierSchema.optional(),
+    })
+    .superRefine(checkResourceIdentifierOrId);
+
+export const AddItemTreeNodeShortcutsOperationSchema = z
+    .object({
+        _ref: RefSchema.optional(),
+        intent: z.literal('item/paths/addShortcuts'),
+        itemId: IdSchema.optional(),
+        resourceIdentifier: ResourceIdentifierSchema.optional(),
+        shortcuts: z.array(
+            z.object({
+                parentId: IdSchema,
+                position: z.number().int().min(0).optional(),
+            }),
+        ),
+    })
+    .superRefine(checkResourceIdentifierOrId);
+
+export const AddItemTreeNodeAliasesOperationSchema = z
+    .object({
+        _ref: RefSchema.optional(),
+        intent: z.literal('item/paths/addAliases'),
+        itemId: IdSchema.optional(),
+        resourceIdentifier: ResourceIdentifierSchema.optional(),
+        language: z.string().min(1),
+        paths: z.array(z.string().min(1)),
+    })
+    .superRefine(checkResourceIdentifierOrId);
+
+export const AddItemTreeNodeHistoryOperationSchema = z
+    .object({
+        _ref: RefSchema.optional(),
+        intent: z.literal('item/paths/addHistory'),
+        itemId: IdSchema.optional(),
+        resourceIdentifier: ResourceIdentifierSchema.optional(),
+        language: z.string().min(1),
+        paths: z.array(z.string().min(1)),
+    })
+    .superRefine(checkResourceIdentifierOrId);
 
 export type UpdateItemComponentOperation = z.infer<typeof UpdateItemComponentOperationSchema>;
 export type UpdateSkuComponentOperation = z.infer<typeof UpdateSkuComponentOperationSchema>;
@@ -135,3 +176,7 @@ export type UpsertFolderOperation = z.infer<typeof UpsertFolderOperationSchema>;
 export type CreateProductOperation = z.infer<typeof CreateProductOperationSchema>;
 export type UpdateProductOperation = z.infer<typeof UpdateProductOperationSchema>;
 export type UpsertProductOperation = z.infer<typeof UpsertProductOperationSchema>;
+
+export type AddItemTreeNodeShortcutsOperation = z.infer<typeof AddItemTreeNodeShortcutsOperationSchema>;
+export type AddItemTreeNodeAliasesOperation = z.infer<typeof AddItemTreeNodeAliasesOperationSchema>;
+export type AddItemTreeNodeHistoryOperation = z.infer<typeof AddItemTreeNodeHistoryOperationSchema>;

components/schema/tests/mass-operation/valid-files/mass-op-paths.json

@@ -0,0 +1,80 @@
+{
+    "version": "0.0.1",
+    "operations": [
+        {
+            "_ref": "topA",
+            "intent": "folder/upsert",
+            "tree": {
+                "parentId": "{{ defaults.rootItemId }}"
+            },
+            "language": "en",
+            "shapeIdentifier": "default-folder",
+            "name": "Top A of my tree for Paths Operations",
+            "resourceIdentifier": "top-A-of-my-tree-for-paths-operations"
+        },
+        {
+            "_ref": "topB",
+            "intent": "folder/upsert",
+            "tree": {
+                "parentId": "{{ defaults.rootItemId }}"
+            },
+            "language": "en",
+            "shapeIdentifier": "default-folder",
+            "name": "Top B of my tree for Paths Operations",
+            "resourceIdentifier": "top-B-of-my-tree-for-paths-operations"
+        },
+        {
+            "_ref": "topC",
+            "intent": "folder/upsert",
+            "tree": {
+                "parentId": "{{ defaults.rootItemId }}"
+            },
+            "language": "en",
+            "shapeIdentifier": "default-folder",
+            "name": "Top C of my tree for Paths Operations",
+            "resourceIdentifier": "top-C-of-my-tree-for-paths-operations"
+        },
+        {
+            "intent": "document/upsert",
+            "tree": {
+                "parentId": "{{#if topA.id.id}}{{ topA.id.id }}{{else}}{{ topA.id}}{{/if}}"
+            },
+            "language": "en",
+            "shapeIdentifier": "default-document",
+            "name": "Child of Top A",
+            "resourceIdentifier": "child-of-top-a"
+        },
+        {
+            "intent": "item/paths/addAliases",
+            "language": "en",
+            "resourceIdentifier": "child-of-top-a",
+            "paths": [
+                "/fake/top-b-of-my-tree-for-paths-operations/alias-for-child-of-top-a",
+                "/another-fake/top-b/alias2-for-child-of-top-a"
+            ]
+        },
+        {
+            "intent": "item/paths/addHistory",
+            "language": "en",
+            "resourceIdentifier": "child-of-top-a",
+            "paths": [
+                "/old-fake/top-b-of-my-tree-for-paths-operations/alias-for-child-of-top-a",
+                "/old-another-fake/top-b/alias2-for-child-of-top-a"
+            ]
+        },
+        {
+            "intent": "item/paths/addShortcuts",
+            "resourceIdentifier": "child-of-top-a",
+            "shortcuts": [
+                {
+                    "parentId": "{{#if topB.id.id}}{{ topB.id.id }}{{else}}{{ topB.id}}{{/if}}",
+                    "position": 12
+                },
+                {
+                    "parentId": "{{#if topC.id.id}}{{ topC.id.id }}{{else}}{{ topC.id}}{{/if}}",
+                    "position": 12
+                }
+            ]
+        }
+    ]
+}