@strapi/core 5.18.1 → 5.20.0

package/dist/core-api/routes/validation/attributes.d.ts

@@ -0,0 +1,244 @@
+/**
+ * @file This module provides a set of functions to convert Strapi schema attributes into Zod schemas.
+ * It handles various attribute types, including primitive types, components, dynamic zones, media, and relations.
+ * The module also provides functions to create input schemas for these attributes, which are used for validation
+ * of incoming data.
+ */
+import { type Schema, UID } from '@strapi/types';
+import { z } from 'zod/v4';
+/**
+ * Converts a BigInteger attribute to a Zod schema.
+ * @param attribute - The BigInteger attribute object from the Strapi schema.
+ * @returns A Zod schema representing the BigInteger field.
+ */
+export declare const bigIntegerToSchema: (attribute: Schema.Attribute.BigInteger) => z.Schema;
+/**
+ * Converts a blocks attribute to a Zod schema.
+ * @returns A Zod schema representing the blocks field.
+ */
+export declare const blocksToSchema: () => z.Schema;
+/**
+ * Converts a boolean attribute to a Zod schema.
+ * @param attribute - The Boolean attribute object from the Strapi schema.
+ * @returns A Zod schema representing the boolean field.
+ */
+export declare const booleanToSchema: (attribute: Schema.Attribute.Boolean) => z.Schema;
+/**
+ * Converts a component attribute to a Zod schema.
+ * @param attribute - The Component attribute object from the Strapi schema.
+ * @returns A Zod schema representing the component field.
+ */
+export declare const componentToSchema: (attribute: Schema.Attribute.Component<UID.Component, boolean>) => z.Schema;
+/**
+ * Converts a date attribute to a Zod schema.
+ * @param attribute - The Date attribute object from the Strapi schema.
+ * @returns A Zod schema representing the date field.
+ */
+export declare const dateToSchema: (attribute: Schema.Attribute.Date) => z.Schema;
+/**
+ * Converts a datetime attribute to a Zod schema.
+ * @param attribute - The DateTime attribute object from the Strapi schema.
+ * @returns A Zod schema representing the datetime field.
+ */
+export declare const datetimeToSchema: (attribute: Schema.Attribute.DateTime) => z.Schema;
+/**
+ * Converts a decimal attribute to a Zod schema.
+ * @param attribute - The Decimal attribute object from the Strapi schema.
+ * @returns A Zod schema representing the decimal field.
+ */
+export declare const decimalToSchema: (attribute: Schema.Attribute.Decimal) => z.Schema;
+/**
+ * Converts a dynamic zone attribute to a Zod schema.
+ * @param attribute - The DynamicZone attribute object from the Strapi schema.
+ * @returns A Zod schema representing the dynamic zone field.
+ */
+export declare const dynamicZoneToSchema: (attribute: Schema.Attribute.DynamicZone) => z.Schema;
+/**
+ * Converts an email attribute to a Zod schema.
+ * @param attribute - The Email attribute object from the Strapi schema.
+ * @returns A Zod schema representing the email field.
+ */
+export declare const emailToSchema: (attribute: Schema.Attribute.Email) => z.Schema;
+/**
+ * Converts an enumeration attribute to a Zod schema.
+ * @param attribute - The Enumeration attribute object from the Strapi schema.
+ * @returns A Zod schema representing the enumeration field.
+ */
+export declare const enumToSchema: (attribute: Schema.Attribute.Enumeration<string[]>) => z.Schema;
+/**
+ * Converts a float attribute to a Zod schema.
+ * @param attribute - The Float attribute object from the Strapi schema.
+ * @returns A Zod schema representing the float field.
+ */
+export declare const floatToSchema: (attribute: Schema.Attribute.Float) => z.Schema;
+/**
+ * Converts an integer attribute to a Zod schema.
+ * @param attribute - The Integer attribute object from the Strapi schema.
+ * @returns A Zod schema representing the integer field.
+ */
+export declare const integerToSchema: (attribute: Schema.Attribute.Integer) => z.Schema;
+/**
+ * Converts a JSON attribute to a Zod schema.
+ * @param attribute - The JSON attribute object from the Strapi schema.
+ * @returns A Zod schema representing the JSON field.
+ */
+export declare const jsonToSchema: (attribute: Schema.Attribute.JSON) => z.Schema;
+/**
+ * Converts a media attribute to a Zod schema.
+ * @param attribute - The Media attribute object from the Strapi schema.
+ * @returns A Zod schema representing the media field.
+ */
+export declare const mediaToSchema: (attribute: Schema.Attribute.Media<Schema.Attribute.MediaKind | undefined, boolean>) => z.Schema;
+/**
+ * Converts a relation attribute to a Zod schema.
+ * @param attribute - The Relation attribute object from the Strapi schema.
+ * @returns A Zod schema representing the relational field.
+ */
+export declare const relationToSchema: (attribute: Schema.Attribute.Relation) => z.Schema;
+/**
+ * Converts a string, text, rich text, or password attribute to a Zod schema.
+ * @param attribute - The String, Text, RichText, or Password attribute object from the Strapi schema.
+ * @returns A Zod schema representing the field.
+ */
+export declare const stringToSchema: (attribute: Schema.Attribute.String | Schema.Attribute.Text | Schema.Attribute.RichText | Schema.Attribute.Password) => z.Schema;
+/**
+ * Converts a time attribute to a Zod schema.
+ * @param attribute - The Time attribute object from the Strapi schema.
+ * @returns A Zod schema representing the time field.
+ */
+export declare const timeToSchema: (attribute: Schema.Attribute.Time) => z.Schema;
+/**
+ * Converts a timestamp attribute to a Zod schema.
+ * @param attribute - The Timestamp attribute object from the Strapi schema.
+ * @returns A Zod schema representing the timestamp field.
+ */
+export declare const timestampToSchema: (attribute: Schema.Attribute.Timestamp) => z.Schema;
+/**
+ * Converts a UID attribute to a Zod schema.
+ * @param attribute - The UID attribute object from the Strapi schema.
+ * @returns A Zod schema representing the UID field.
+ */
+export declare const uidToSchema: (attribute: Schema.Attribute.UID) => z.Schema;
+/**
+ * Converts a BigInteger attribute to a Zod schema for input validation.
+ * @param attribute - The BigInteger attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the BigInteger field.
+ */
+export declare const bigIntegerToInputSchema: (attribute: Schema.Attribute.BigInteger) => z.ZodString;
+/**
+ * Converts a blocks attribute to a Zod schema for input validation.
+ * @returns A Zod schema for input validation of the blocks field.
+ */
+export declare const blocksToInputSchema: () => z.ZodArray<z.ZodAny>;
+/**
+ * Converts a boolean attribute to a Zod schema for input validation.
+ * @param attribute - The Boolean attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the boolean field.
+ */
+export declare const booleanToInputSchema: (attribute: Schema.Attribute.Boolean) => z.ZodEnum<{
+    0: "0";
+    t: "t";
+    1: "1";
+    true: "true";
+    f: "f";
+    false: "false";
+}>;
+/**
+ * Converts a component attribute to a Zod schema for input validation.
+ * @param attribute - The Component attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the component field.
+ */
+export declare const componentToInputSchema: (attribute: Schema.Attribute.Component<UID.Component, boolean>) => z.ZodAny | z.ZodArray<z.ZodAny>;
+/**
+ * Converts a date attribute to a Zod schema for input validation.
+ * @param attribute - The Date attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the date field.
+ */
+export declare const dateToInputSchema: (attribute: Schema.Attribute.Date) => z.ZodString;
+/**
+ * Converts a datetime attribute to a Zod schema for input validation.
+ * @param attribute - The DateTime attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the datetime field.
+ */
+export declare const datetimeToInputSchema: (attribute: Schema.Attribute.DateTime) => z.ZodString;
+/**
+ * Converts a decimal attribute to a Zod schema for input validation.
+ * @param attribute - The Decimal attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the decimal field.
+ */
+export declare const decimalToInputSchema: (attribute: Schema.Attribute.Decimal) => z.ZodNumber;
+/**
+ * Converts a dynamic zone attribute to a Zod schema for input validation.
+ * @param attribute - The DynamicZone attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the dynamic zone field.
+ */
+export declare const dynamicZoneToInputSchema: (attribute: Schema.Attribute.DynamicZone) => z.ZodArray<z.ZodAny>;
+/**
+ * Converts an email attribute to a Zod schema for input validation.
+ * @param attribute - The Email attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the email field.
+ */
+export declare const emailToInputSchema: (attribute: Schema.Attribute.Email) => z.ZodEmail;
+/**
+ * Converts an enumeration attribute to a Zod schema for input validation.
+ * @param attribute - The Enumeration attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the enumeration field.
+ */
+export declare const enumerationToInputSchema: (attribute: Schema.Attribute.Enumeration<string[]>) => z.ZodEnum<{
+    [x: string]: string;
+}>;
+/**
+ * Converts a float attribute to a Zod schema for input validation.
+ * @param attribute - The Float attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the float field.
+ */
+export declare const floatToInputSchema: (attribute: Schema.Attribute.Float) => z.ZodNumber;
+/**
+ * Converts an integer attribute to a Zod schema for input validation.
+ * @param attribute - The Integer attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the integer field.
+ */
+export declare const integerToInputSchema: (attribute: Schema.Attribute.Integer) => z.ZodNumber;
+/**
+ * Converts a JSON attribute to a Zod schema for input validation.
+ * @param attribute - The JSON attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the JSON field.
+ */
+export declare const jsonToInputSchema: (attribute: Schema.Attribute.JSON) => z.ZodAny;
+/**
+ * Converts a media attribute to a Zod schema for input validation.
+ * @param attribute - The Media attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the media field.
+ */
+export declare const mediaToInputSchema: (attribute: Schema.Attribute.Media<Schema.Attribute.MediaKind | undefined, boolean>) => z.ZodAny | z.ZodArray<z.ZodAny>;
+/**
+ * Converts a relation attribute to a Zod schema for input validation.
+ * @param attribute - The Relation attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the relational field.
+ */
+export declare const relationToInputSchema: (attribute: Schema.Attribute.Relation) => z.ZodString | z.ZodArray<z.ZodString>;
+/**
+ * Converts a string, text, rich text, or password attribute to a Zod schema for input validation.
+ * @param attribute - The String, Text, RichText, or Password attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the field.
+ */
+export declare const textToInputSchema: (attribute: Schema.Attribute.String | Schema.Attribute.Text | Schema.Attribute.RichText | Schema.Attribute.Password) => z.ZodString;
+/**
+ * Converts a time attribute to a Zod schema for input validation.
+ * @param attribute - The Time attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the time field.
+ */
+export declare const timeToInputSchema: (attribute: Schema.Attribute.Time) => z.ZodString;
+/**
+ * Converts a timestamp attribute to a Zod schema for input validation.
+ * @param attribute - The Timestamp attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the timestamp field.
+ */
+export declare const timestampToInputSchema: (attribute: Schema.Attribute.Timestamp) => z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>;
+/**
+ * Converts a UID attribute to a Zod schema for input validation.
+ * @param attribute - The UID attribute object from the Strapi schema.
+ * @returns A Zod schema for input validation of the UID field.
+ */
+export declare const uidToInputSchema: (attribute: Schema.Attribute.UID) => z.ZodString;
+//# sourceMappingURL=attributes.d.ts.map

package/dist/core-api/routes/validation/attributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributes.d.ts","sourceRoot":"","sources":["../../../../src/core-api/routes/validation/attributes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,KAAK,MAAM,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAUjD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAC;AAU3B;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,cAAe,OAAO,SAAS,WAAW,KAAG,EAAE,MAY7E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAO,EAAE,MAEnC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,cAAe,OAAO,SAAS,QAAQ,KAAG,EAAE,MAUvE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,cACjB,OAAO,SAAS,CAAC,SAAS,CAAC,IAAI,SAAS,EAAE,OAAO,CAAC,KAC5D,EAAE,MAkBJ,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,cAAe,OAAO,SAAS,KAAK,KAAG,EAAE,MAUjE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,cAAe,OAAO,SAAS,CAAC,QAAQ,KAAG,EAAE,MAUzE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,cAAe,OAAO,SAAS,CAAC,OAAO,KAAG,EAAE,MAWvE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,cAAe,OAAO,SAAS,CAAC,WAAW,KAAG,EAAE,MAY/E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,cAAe,OAAO,SAAS,CAAC,KAAK,KAAG,EAAE,MAanE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,cAAe,OAAO,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,KAAG,EAAE,MAYlF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,cAAe,OAAO,SAAS,CAAC,KAAK,KAAG,EAAE,MAWnE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,cAAe,OAAO,SAAS,CAAC,OAAO,KAAG,EAAE,MAavE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,cAAe,OAAO,SAAS,KAAK,KAAG,EAAE,MAUjE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,cACb,OAAO,SAAS,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,SAAS,GAAG,SAAS,EAAE,OAAO,CAAC,KACjF,EAAE,MAkBJ,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,cAAe,OAAO,SAAS,CAAC,QAAQ,KAAG,EAAE,MAiBzE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,cAErB,OAAO,SAAS,OAAO,GACvB,OAAO,SAAS,KAAK,GACrB,OAAO,SAAS,CAAC,QAAQ,GACzB,OAAO,SAAS,CAAC,QAAQ,KAC5B,EAAE,MAWJ,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,cAAe,OAAO,SAAS,CAAC,IAAI,KAAG,EAAE,MAUjE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,cAAe,OAAO,SAAS,CAAC,SAAS,KAAG,EAAE,MAY3E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,cAAe,OAAO,SAAS,CAAC,GAAG,KAAG,EAAE,MAW/D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,cAAe,OAAO,SAAS,WAAW,gBAW7E,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,4BAG/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,cAAe,OAAO,SAAS,QAAQ;;;;;;;EAWvE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,cACtB,OAAO,SAAS,CAAC,SAAS,CAAC,IAAI,SAAS,EAAE,OAAO,CAAC,oCAa9D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,cAAe,OAAO,SAAS,KAAK,gBASjE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,cAAe,OAAO,SAAS,CAAC,QAAQ,gBASzE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,cAAe,OAAO,SAAS,CAAC,OAAO,gBAUvE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,cAAe,OAAO,SAAS,CAAC,WAAW,yBAQ/E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,cAAe,OAAO,SAAS,CAAC,KAAK,eAYnE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,cAAe,OAAO,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;;EAWzF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,cAAe,OAAO,SAAS,CAAC,KAAK,gBAUnE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,cAAe,OAAO,SAAS,CAAC,OAAO,gBAYvE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,cAAe,OAAO,SAAS,KAAK,aAMjE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,cAClB,OAAO,SAAS,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,SAAS,GAAG,SAAS,EAAE,OAAO,CAAC,oCASnF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,cAAe,OAAO,SAAS,CAAC,QAAQ,0CAUzE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,cAExB,OAAO,SAAS,OAAO,GACvB,OAAO,SAAS,KAAK,GACrB,OAAO,SAAS,CAAC,QAAQ,GACzB,OAAO,SAAS,CAAC,QAAQ,gBAW9B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,cAAe,OAAO,SAAS,CAAC,IAAI,gBASjE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,cAAe,OAAO,SAAS,CAAC,SAAS,oDAW3E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,cAAe,OAAO,SAAS,CAAC,GAAG,gBAU/D,CAAC"}