feat(schema): enable shape upsert operation

CrystallizeAPI · Dec 11, 2024 · ca359a3 · ca359a3
1 parent 5d38597
commit ca359a3
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 59 deletions.
diff --git a/components/schema/package.json b/components/schema/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@crystallize/schema",
-    "version": "3.0.0",
+    "version": "3.0.1",
     "license": "MIT",
     "exports": {
         "./pim": {

diff --git a/components/schema/src/mass-operation/index.ts b/components/schema/src/mass-operation/index.ts
@@ -8,12 +8,7 @@ import {
     UpdateItemOperationSchema,
     UpsertItemOperationSchema,
 } from './item.js';
-import {
-    CreateProductShapeOperationSchema,
-    CreateFolderShapeOperationSchema,
-    CreateDocumentShapeOperationSchema,
-    UpdateShapeOperationSchema,
-} from './shape.js';
+import { CreateShapeOperationSchema, UpdateShapeOperationSchema, UpsertShapeOperationSchema } from './shape.js';
 
 export const OperationSchema = z.discriminatedUnion('intent', [
     CreateItemOperationSchema,
@@ -23,10 +18,9 @@ export const OperationSchema = z.discriminatedUnion('intent', [
     UnPublishItemOperationSchema,
     UpdateItemComponentOperationSchema,
     UpdateSkuComponentOperationSchema,
-    CreateProductShapeOperationSchema,
-    CreateFolderShapeOperationSchema,
-    CreateDocumentShapeOperationSchema,
+    CreateShapeOperationSchema,
     UpdateShapeOperationSchema,
+    UpsertShapeOperationSchema,
 ]);
 
 export const OperationsSchema = z.object({
@@ -48,9 +42,4 @@ export type {
     UpsertItemOperation,
 } from './item.js';
 
-export type {
-    CreateProductShapeOperation,
-    CreateDocumentShapeOperation,
-    CreateFolderShapeOperation,
-    UpdateShapeOperation,
-} from './shape.js';
+export type { CreateShapeOperation, UpdateShapeOperation, UpsertShapeOperation } from './shape.js';
diff --git a/components/schema/src/mass-operation/shape.ts b/components/schema/src/mass-operation/shape.ts
@@ -1,28 +1,17 @@
 import { z } from 'zod';
-import {
-    CreateDocumentShapeInputSchema,
-    CreateFolderShapeInputSchema,
-    CreateProductShapeInputSchema,
-    UpdateShapeInputSchema,
-} from '../pim/shape/index.js';
+import { CreateShapeInputSchema, UpdateShapeInputSchema } from '../pim/shape/index.js';
 
-export const CreateDocumentShapeOperationSchema = CreateDocumentShapeInputSchema.extend({
-    intent: z.literal('shape/create/document'),
+export const CreateShapeOperationSchema = CreateShapeInputSchema.extend({
+    intent: z.literal('shape/create'),
 });
-export type CreateDocumentShapeOperation = z.infer<typeof CreateDocumentShapeOperationSchema>;
-
-export const CreateFolderShapeOperationSchema = CreateFolderShapeInputSchema.extend({
-    intent: z.literal('shape/create/folder'),
-});
-export type CreateFolderShapeOperation = z.infer<typeof CreateDocumentShapeOperationSchema>;
-
-export const CreateProductShapeOperationSchema = CreateProductShapeInputSchema.extend({
-    intent: z.literal('shape/create/product'),
-});
-export type CreateProductShapeOperation = z.infer<typeof CreateProductShapeOperationSchema>;
+export type CreateShapeOperation = z.infer<typeof CreateShapeOperationSchema>;
 
 export const UpdateShapeOperationSchema = UpdateShapeInputSchema.extend({
     intent: z.literal('shape/update'),
-    identifier: z.string().min(1),
 });
 export type UpdateShapeOperation = z.infer<typeof UpdateShapeOperationSchema>;
+
+export const UpsertShapeOperationSchema = CreateShapeOperationSchema.extend({
+    intent: z.literal('shape/upsert'),
+});
+export type UpsertShapeOperation = z.infer<typeof UpsertShapeOperationSchema>;
diff --git a/components/schema/src/pim/components/component-definition.ts b/components/schema/src/pim/components/component-definition.ts
@@ -7,17 +7,17 @@ export const ComponentDefinitionSchema = z.object({
     id: z.string().min(1),
     type: ComponentTypeEnum,
     name: z.string().min(1),
-    description: z.string(),
-    config: ComponentConfigSchema,
+    description: z.string().optional(),
+    config: ComponentConfigSchema.optional(),
 });
 export type ComponentDefinition = z.infer<typeof ComponentDefinitionSchema>;
 
 export const ComponentDefinitionInputSchema = z.object({
     id: z.string().min(1),
     type: ComponentTypeEnum,
     name: z.string().min(1),
-    description: z.string(),
-    config: ComponentConfigInputSchema,
+    description: z.string().optional(),
+    config: ComponentConfigInputSchema.optional(),
 });
 
 export type ComponentDefinitionInput = z.infer<typeof ComponentDefinitionInputSchema>;
diff --git a/components/schema/src/pim/shape/index.ts b/components/schema/src/pim/shape/index.ts
@@ -2,29 +2,16 @@ import { z } from 'zod';
 import { ItemTypeEnum, KeyValuePairInputSchema } from '../../shared/index.js';
 import { ComponentDefinitionInputSchema, ComponentDefinitionSchema } from '../components/component-definition.js';
 
-const BaseShapeInputSchema = z.object({
+export const UpdateShapeInputSchema = z.object({
     identifier: z.string().min(2).max(64),
     name: z.string().min(1),
     meta: KeyValuePairInputSchema.optional().nullable(),
     components: z.array(ComponentDefinitionInputSchema).optional().nullable(),
-});
-
-export const CreateDocumentShapeInputSchema = BaseShapeInputSchema.extend({
-    type: z.literal(ItemTypeEnum.Values.document),
-});
-
-export const CreateFolderShapeInputSchema = BaseShapeInputSchema.extend({
-    type: z.literal(ItemTypeEnum.Values.folder),
-});
-
-export const CreateProductShapeInputSchema = BaseShapeInputSchema.extend({
-    type: z.literal(ItemTypeEnum.Values.product),
     variantComponents: z.array(ComponentDefinitionInputSchema).optional().nullable(),
 });
 
-export const UpdateShapeInputSchema = BaseShapeInputSchema.extend({
-    components: z.array(ComponentDefinitionInputSchema).optional().nullable(),
-    variantComponents: z.array(ComponentDefinitionInputSchema).optional().nullable(),
+export const CreateShapeInputSchema = UpdateShapeInputSchema.extend({
+    type: ItemTypeEnum,
 });
 
 export const BasicShapeSchema = z.object({
@@ -38,8 +25,6 @@ export const ShapeSchema = BasicShapeSchema.extend({
     variantComponents: z.array(ComponentDefinitionSchema).optional(),
 });
 
-export type CreateDocumentShapeInput = z.infer<typeof CreateDocumentShapeInputSchema>;
-export type CreateFolderShapeInput = z.infer<typeof CreateFolderShapeInputSchema>;
-export type CreateProductShapeInput = z.infer<typeof CreateProductShapeInputSchema>;
+export type CreateShapeInput = z.infer<typeof UpdateShapeInputSchema>;
 export type UpdateShapeInput = z.infer<typeof UpdateShapeInputSchema>;
 export type Shape = z.infer<typeof ShapeSchema>;