@strapi/types 5.0.0-rc.8 → 5.0.0

package/dist/core/controller.d.ts

@@ -1,3 +1,4 @@
+import 'koa-body';
 import type { Context, Next } from 'koa';
 export type Controller = Record<string, ControllerHandler>;
 export interface ControllerHandler<TResponse = unknown> {

package/dist/core/controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/core/controller.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC;AAEzC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAE3D,MAAM,WAAW,iBAAiB,CAAC,SAAS,GAAG,OAAO;IACpD,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;CAC9E"}
+{"version":3,"file":"controller.d.ts","sourceRoot":"","sources":["../../src/core/controller.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC;AAEzC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAC3D,MAAM,WAAW,iBAAiB,CAAC,SAAS,GAAG,OAAO;IACpD,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;CAC9E"}

package/dist/modules/cron.d.ts

@@ -1,8 +1,8 @@
-import type { Job } from 'node-schedule';
+import type { Job, Spec } from 'node-schedule';
 import type { Strapi } from '../core';
 interface JobSpec {
     job: Job;
-    options: string | number | Date;
+    options: Spec;
     name: string | null;
 }
 type TaskFn = ({ strapi }: {
@@ -10,7 +10,7 @@ type TaskFn = ({ strapi }: {
 }, ...args: unknown[]) => Promise<unknown>;
 type Task = TaskFn | {
     task: TaskFn;
-    options: string;
+    options: Spec;
 };
 interface Tasks {
     [key: string]: Task;

package/dist/modules/cron.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cron.d.ts","sourceRoot":"","sources":["../../src/modules/cron.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEzC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC,UAAU,OAAO;IACf,GAAG,EAAE,GAAG,CAAC;IACT,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAChC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,KAAK,MAAM,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAEvF,KAAK,IAAI,GACL,MAAM,GACN;IACE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEN,UAAU,KAAK;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,KAAK,EAAE,KAAK,GAAG,WAAW,CAAC;IAC/B,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAClC,KAAK,IAAI,WAAW,CAAC;IACrB,IAAI,IAAI,WAAW,CAAC;IACpB,OAAO,IAAI,WAAW,CAAC;IACvB,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB"}
+{"version":3,"file":"cron.d.ts","sourceRoot":"","sources":["../../src/modules/cron.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC,UAAU,OAAO;IACf,GAAG,EAAE,GAAG,CAAC;IACT,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,KAAK,MAAM,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAEvF,KAAK,IAAI,GACL,MAAM,GACN;IACE,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,IAAI,CAAC;CACf,CAAC;AAEN,UAAU,KAAK;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,KAAK,EAAE,KAAK,GAAG,WAAW,CAAC;IAC/B,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAClC,KAAK,IAAI,WAAW,CAAC;IACrB,IAAI,IAAI,WAAW,CAAC;IACpB,OAAO,IAAI,WAAW,CAAC;IACvB,IAAI,EAAE,OAAO,EAAE,CAAC;CACjB"}

package/dist/modules/documents/component-extension.d.ts

@@ -1,22 +1,73 @@
-import type { UID, Schema } from '../..';
-import type * as EntityService from '../entity-service';
+import type { UID, Schema, Utils } from '../..';
+import type { Input, PartialInput } from './params/data';
 import type * as AttributeUtils from './params/attributes';
-type ComponentBody = {
+/**
+ * Defines the structure of component bodies based on the given schema UID and component-like keys.
+ *
+ * It adapts based on whether schema registries have been extended, either mapping attribute names to
+ * their respective values or using a generic key-value structure if the registries have not been extended.
+ *
+ * @template TSchemaUID - The schema's UID, extending from {@link UID.Schema}, which determines the attribute names and types to use.
+ * @template TComponentLikeKeys - A string type representing the keys to keep that are component-like, defaults to a generic string.
+ *
+ * @example
+ * Using `ComponentBody` in a situation where the schema registries have been extended:
+ * ```typescript
+ * type MyComponentSchemaUID = 'default.mycomponent';
+ * type MyComponentBody = ComponentBody<MyComponentSchemaUID, 'header' | 'footer'>;
+ *
+ * // This resolves to:
+ * // {
+ * //   header: AttributeUtils.GetValue<Schema.AttributeByName<MyComponentSchemaUID, 'header'>>;
+ * //   footer: AttributeUtils.GetValue<Schema.AttributeByName<MyComponentSchemaUID, 'footer'>>;
+ * // }
+ * ```
+ *
+ * In cases where it's unknown whether schema registries have been extended:
+ * ```typescript
+ * type GenericComponentBody = ComponentBody<UID.Schema>;
+ *
+ * // This resolves to:
+ * // {
+ * //   [key: string]: AttributeUtils.GetValue<
+ * //     | Schema.Attribute.Component<UID.Component, false>
+ * //     | Schema.Attribute.Component<UID.Component, true>
+ * //     | Schema.Attribute.DynamicZone
+ * //   >;
+ * // }
+ * ```
+ *
+ * @todo: Move to common data structures and make it available for other use
+ */
+type ComponentBody<TSchemaUID extends UID.Schema = UID.Schema, TComponentLikeKeys extends string = string> = Utils.If<Utils.Constants.AreSchemaRegistriesExtended, {
+    [TAttributeName in Extract<Schema.AttributeNamesByType<TSchemaUID, 'component' | 'dynamiczone'>, TComponentLikeKeys>]: AttributeUtils.GetValue<Schema.AttributeByName<TSchemaUID, TAttributeName>>;
+}, {
     [key: string]: AttributeUtils.GetValue<Schema.Attribute.Component<UID.Component, false> | Schema.Attribute.Component<UID.Component, true> | Schema.Attribute.DynamicZone>;
-};
-export type ComponentExtension = {
+}>;
+/**
+ * Provides methods to manipulate component data in input payloads.
+ *
+ * @template TSchemaUID - Represents a unique identifier for a schema, extending {@link UID.Schema}.
+ */
+export type ComponentExtension<TSchemaUID extends UID.Schema> = {
     /**
+     * Update the component data for a given entity.
+     *
+     * @remark This method is exposed for use within document service middlewares.
+     *
      * @internal
-     * Exposed for use within document service middlewares
      */
-    updateComponents: (entityToUpdate: {
-        id: EntityService.Params.Attribute.ID;
-    }, data: EntityService.Params.Data.Input<UID.Schema>) => Promise<ComponentBody>;
+    updateComponents<const TData extends Input<TSchemaUID>>(entityToUpdate: {
+        id: AttributeUtils.ID;
+    }, data: TData): Promise<ComponentBody<TSchemaUID, Extract<keyof TData, string>>>;
     /**
+     * Omits component-like fields from the given input data.
+     *
+     * @remark This method is exposed for use within document service middlewares.
+     *
      * @internal
-     * Exposed for use within document service middlewares
      */
-    omitComponentData: (data: EntityService.Params.Data.Input<Schema.ContentType['uid']>) => Partial<EntityService.Params.Data.Input<Schema.ContentType['uid']>>;
+    omitComponentData<const TData extends PartialInput<TSchemaUID>>(data: TData): TData;
 };
 export {};
 //# sourceMappingURL=component-extension.d.ts.map

package/dist/modules/documents/component-extension.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"component-extension.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/component-extension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AACzC,OAAO,KAAK,KAAK,aAAa,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,KAAK,cAAc,MAAM,qBAAqB,CAAC;AAG3D,KAAK,aAAa,GAAG;IACnB,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC,QAAQ,CAClC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,GAChD,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,GAC/C,MAAM,CAAC,SAAS,CAAC,WAAW,CAC/B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,gBAAgB,EAAE,CAChB,cAAc,EAAE;QACd,EAAE,EAAE,aAAa,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;KACvC,EACD,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAC9C,OAAO,CAAC,aAAa,CAAC,CAAC;IAE5B;;;OAGG;IACH,iBAAiB,EAAE,CACjB,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,KAC7D,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;CAC1E,CAAC"}
+{"version":3,"file":"component-extension.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/component-extension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,KAAK,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,KAAK,KAAK,cAAc,MAAM,qBAAqB,CAAC;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,KAAK,aAAa,CAChB,UAAU,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,EAC1C,kBAAkB,SAAS,MAAM,GAAG,MAAM,IACxC,KAAK,CAAC,EAAE,CACV,KAAK,CAAC,SAAS,CAAC,2BAA2B,EAC3C;KACG,cAAc,IAAI,OAAO,CACxB,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,WAAW,GAAG,aAAa,CAAC,EACpE,kBAAkB,CACnB,GAAG,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;CAChF,EACD;IACE,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAC,QAAQ,CAClC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,GAChD,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,GAC/C,MAAM,CAAC,SAAS,CAAC,WAAW,CAC/B,CAAC;CACH,CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI;IAC9D;;;;;;OAMG;IACH,gBAAgB,CAAC,KAAK,CAAC,KAAK,SAAS,KAAK,CAAC,UAAU,CAAC,EACpD,cAAc,EAAE;QAAE,EAAE,EAAE,cAAc,CAAC,EAAE,CAAA;KAAE,EACzC,IAAI,EAAE,KAAK,GACV,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,MAAM,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAEpE;;;;;;OAMG;IACH,iBAAiB,CAAC,KAAK,CAAC,KAAK,SAAS,YAAY,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,KAAK,GAAG,KAAK,CAAC;CACrF,CAAC"}

package/dist/modules/documents/index.d.ts

@@ -13,7 +13,7 @@ type ServiceUtils = {
     transformData: (data: any, opts: any) => Promise<AnyDocument>;
 };
 export type Service = {
-    <TContentTypeUID extends UID.ContentType>(uid: TContentTypeUID): ServiceInstance<TContentTypeUID> & ComponentExtension;
+    <TContentTypeUID extends UID.ContentType>(uid: TContentTypeUID): ServiceInstance<TContentTypeUID> & ComponentExtension<TContentTypeUID>;
     utils: ServiceUtils;
     /** Add a middleware for all uid's and a specific action
      *  @example - Add a default locale

package/dist/modules/documents/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,KAAK,UAAU,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AAEnC,MAAM,MAAM,EAAE,GAAG,MAAM,CAAC;AAExB,KAAK,YAAY,GAAG;IAClB,aAAa,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CAC/D,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,EACtC,GAAG,EAAE,eAAe,GACnB,eAAe,CAAC,eAAe,CAAC,GAAG,kBAAkB,CAAC;IACzD,KAAK,EAAE,YAAY,CAAC;IACpB;;;;;;OAMG;IACH,GAAG,EAAE,CAAC,EAAE,EAAE,UAAU,CAAC,UAAU,KAAK,OAAO,CAAC;CAC7C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,KAAK,UAAU,MAAM,cAAc,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,oBAAoB,CAAC;AAEnC,MAAM,MAAM,EAAE,GAAG,MAAM,CAAC;AAExB,KAAK,YAAY,GAAG;IAClB,aAAa,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CAC/D,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG;IACpB,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,EACtC,GAAG,EAAE,eAAe,GACnB,eAAe,CAAC,eAAe,CAAC,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;IAE1E,KAAK,EAAE,YAAY,CAAC;IAEpB;;;;;;OAMG;IACH,GAAG,EAAE,CAAC,EAAE,EAAE,UAAU,CAAC,UAAU,KAAK,OAAO,CAAC;CAC7C,CAAC"}

package/dist/modules/documents/params/data.d.ts

@@ -1,4 +1,67 @@
 import type * as UID from '../../../uid';
+import type * as Utils from '../../../utils';
 import type * as AttributeUtils from './attributes';
+/**
+ * Represents the input data for a given content-type UID.
+ *
+ * This type evaluates the schema based on the given content-type UID, and extracts the attribute values
+ * accordingly.
+ *
+ * It combines optional and required attributes, while excluding certain relational attributes
+ * that don't target specific schemas like polymorphic relations.
+ *
+ * @template TSchemaUID - A unique identifier for a schema, extending {@link UID.Schema}.
+ *
+ * @remark
+ * The attributes' values are customized to allow additional input formats that are going to be
+ * transformed in the document service methods.
+ *
+ * For example, relational attributes can use the re-ordering API.
+ *
+ * @example
+ * Defining input for a content type schema:
+ *
+ * ```typescript
+ * import type { UID } from '@strapi/types';
+ *
+ * // Assume there's a schema with a UID of 'api::article.article'
+ * type ArticleInput = Input<'api::article.article'>;
+ *
+ * // Example usage of ArticleInput with typed attributes
+ * const articleData: ArticleInput = {
+ *   title: 'My Article', // Required title property
+ *   content: 'Content of the article', // Required content property
+ * };
+ * ```
+ *
+ * @example
+ * Handling component schema with optional and required attributes:
+ *
+ * ```typescript
+ * import type { UID } from '@strapi/types';
+ *
+ * // Assume there's a component with a UID of 'default.comment'
+ * type CommentInput = Input<'default.comment'>;
+ *
+ * const commentData: CommentInput = {
+ *   text: 'Great article!', // Required text property
+ *   author: 'John Doe',     // Optional author property
+ * };
+ * ```
+ */
 export type Input<TSchemaUID extends UID.Schema> = AttributeUtils.GetValues<TSchemaUID>;
+/**
+ * Conditionally applies partial types to schema input data based on the extension status of schema registries.
+ *
+ * This type evaluates whether the schema registries have been extended.
+ *
+ * If so, it returns a partial version of `Input<TSchemaUID>`, otherwise it returns the default `Input` type.
+ *
+ * @template TSchemaUID - Represents a unique identifier for a schema, either content-type or component, extending {@link UID.Schema}.
+ *
+ * @remark
+ * This type is particularly useful for ensuring backward compatibility within input data structures,
+ * enabling flexibility during schema transitions or extensions without breaking existing data contracts.
+ */
+export type PartialInput<TSchemaUID extends UID.Schema> = Utils.If<Utils.Constants.AreSchemaRegistriesExtended, Partial<Input<TSchemaUID>>, Input<TSchemaUID>>;
 //# sourceMappingURL=data.d.ts.map

package/dist/modules/documents/params/data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../src/modules/documents/params/data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AAEzC,OAAO,KAAK,KAAK,cAAc,MAAM,cAAc,CAAC;AAEpD,MAAM,MAAM,KAAK,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,cAAc,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC"}
+{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../src/modules/documents/params/data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,KAAK,cAAc,MAAM,cAAc,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,MAAM,KAAK,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,cAAc,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;AAExF;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,YAAY,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,KAAK,CAAC,EAAE,CAChE,KAAK,CAAC,SAAS,CAAC,2BAA2B,EAC3C,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,EAC1B,KAAK,CAAC,UAAU,CAAC,CAClB,CAAC"}

package/dist/modules/documents/params/sort.d.ts

@@ -49,7 +49,7 @@ export type StringNotation<TSchemaUID extends UID.Schema> = SingleAttribute<TSch
  * type E = [42]; // ❌
  * type F = 'title'; // ❌
  */
-export type ArrayNotation<TSchemaUID extends UID.Schema> = Any<TSchemaUID>[];
+export type ArrayNotation<TSchemaUID extends UID.Schema> = StringNotation<TSchemaUID>[] | ObjectNotation<TSchemaUID>[];
 /**
  * Object notation for a sort
  *

package/dist/modules/documents/params/sort.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sort.d.ts","sourceRoot":"","sources":["../../../../src/modules/documents/params/sort.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,iBAAiB,CAAC;AAE/C,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAG5C,yBAAiB,SAAS,CAAC;IACzB,KAAY,GAAG,GAAG,KAAK,CAAC;IACxB,KAAY,IAAI,GAAG,MAAM,CAAC;IAE1B,KAAY,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC;CAC9B;AAED;;;;;;;;GAQG;AACH,KAAK,eAAe,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAC9C,IAAI,GACJ,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,4BAA4B,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;AAEzE;;;;;;;;GAQG;AACH,KAAK,sBAAsB,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IACvD,GAAG,eAAe,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,GAAG,EAAE,CAAC;AAEpD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IACpD,eAAe,CAAC,UAAU,CAAC,GAC3B,sBAAsB,CAAC,UAAU,CAAC,GAElC,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAE1B;;;;;;;;;;GAUG;AACH,MAAM,MAAM,aAAa,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;AAE7E;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI;KAEzD,GAAG,IAAI,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG;CACrD,GAAG;KAGD,GAAG,IAAI,MAAM,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,cAAc,CACnE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CACjE;CACF,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,GAAG,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IACzC,cAAc,CAAC,UAAU,CAAC,GAC1B,aAAa,CAAC,UAAU,CAAC,GACzB,cAAc,CAAC,UAAU,CAAC,CAAC"}
+{"version":3,"file":"sort.d.ts","sourceRoot":"","sources":["../../../../src/modules/documents/params/sort.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,iBAAiB,CAAC;AAE/C,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAG5C,yBAAiB,SAAS,CAAC;IACzB,KAAY,GAAG,GAAG,KAAK,CAAC;IACxB,KAAY,IAAI,GAAG,MAAM,CAAC;IAE1B,KAAY,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC;CAC9B;AAED;;;;;;;;GAQG;AACH,KAAK,eAAe,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAC9C,IAAI,GACJ,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,4BAA4B,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;AAEzE;;;;;;;;GAQG;AACH,KAAK,sBAAsB,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IACvD,GAAG,eAAe,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,GAAG,EAAE,CAAC;AAEpD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IACpD,eAAe,CAAC,UAAU,CAAC,GAC3B,sBAAsB,CAAC,UAAU,CAAC,GAElC,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAE1B;;;;;;;;;;GAUG;AACH,MAAM,MAAM,aAAa,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IACnD,cAAc,CAAC,UAAU,CAAC,EAAE,GAC5B,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;AAEjC;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI;KAEzD,GAAG,IAAI,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG;CACrD,GAAG;KAGD,GAAG,IAAI,MAAM,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,cAAc,CACnE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,CACjE;CACF,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,GAAG,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IACzC,cAAc,CAAC,UAAU,CAAC,GAC1B,aAAa,CAAC,UAAU,CAAC,GACzB,cAAc,CAAC,UAAU,CAAC,CAAC"}

package/dist/modules/documents/service-instance.d.ts

@@ -1,48 +1,96 @@
-import type { Utils } from '../..';
+import type * as Utils from '../../utils';
 import type * as UID from '../../uid';
 import type { IsDraftAndPublishEnabled } from './draft-and-publish';
 import type * as Params from './params/document-engine';
 import type * as Result from './result/document-engine';
+export type ServiceInstance<TContentTypeUID extends UID.ContentType = UID.ContentType> = {
+    findMany<const TParams extends Params.FindMany<TContentTypeUID>>(params?: TParams): Result.FindMany<TContentTypeUID, TParams>;
+    findFirst<const TParams extends Params.FindFirst<TContentTypeUID>>(params?: TParams): Result.FindFirst<TContentTypeUID, TParams>;
+    findOne<const TParams extends Params.FindOne<TContentTypeUID>>(params: TParams): Result.FindOne<TContentTypeUID, TParams>;
+    delete<const TParams extends Params.Delete<TContentTypeUID>>(params: TParams): Result.Delete<TContentTypeUID, TParams>;
+    create<const TParams extends Params.Create<TContentTypeUID>>(params: TParams): Result.Create<TContentTypeUID, TParams>;
+    update<const TParams extends Params.Update<TContentTypeUID>>(params: TParams): Result.Update<TContentTypeUID, TParams>;
+    count<const TParams extends Params.Count<TContentTypeUID>>(params: TParams): Result.Count;
+    /**
+     * @internal
+     */
+    clone<const TParams extends Params.Clone<TContentTypeUID>>(params: TParams): Result.Clone<TContentTypeUID, TParams>;
+} & Utils.If<IsDraftAndPublishEnabled<TContentTypeUID>, DraftAndPublishExtension<TContentTypeUID>, unknown>;
+/**
+ * Provides methods for managing the draft and publish lifecycle of a document.
+ *
+ * This interface handles publishing, unpublishing, and discarding
+ * drafts of documents identified by their unique identifier.
+ *
+ * @template TContentTypeUID - The unique identifier type for the content-type, constrained to {@link UID.ContentType}.
+ */
+export interface DraftAndPublishExtension<TContentTypeUID extends UID.ContentType = UID.ContentType> {
+    /**
+     * Publishes the current draft for the given document ID.
+     */
+    publish<const TParams extends Params.Publish<TContentTypeUID>>(params: TParams): Result.Publish<TContentTypeUID, TParams>;
+    /**
+     * Unpublishes a document for the given document ID.
+     */
+    unpublish<const TParams extends Params.Unpublish<TContentTypeUID>>(params: TParams): Result.Unpublish<TContentTypeUID, TParams>;
+    /**
+     * Discards the draft entry for the given document ID and params.
+     */
+    discardDraft<const TParams extends Params.DiscardDraft<TContentTypeUID>>(params: TParams): Result.DiscardDraft<TContentTypeUID, TParams>;
+}
+/**
+ * Represents the parameters for various service operations on content types.
+ *
+ * This type aggregates different sets of parameters required for performing operations such as
+ * finding, creating, updating, deleting, cloning, and publishing content within a content management system.
+ *
+ * Each operation has its own set of parameters defined using different subtypes.
+ *
+ * @template TContentTypeUID - Extends {@link UID.ContentType}, used to specify the unique identifier for a content-type.
+ *
+ * @example
+ * Example of how to specify parameters for different operations on a content-type:
+ *
+ * ```typescript
+ * import type { UID } from '../../uid';
+ *
+ * type ArticleServiceParams = ServiceParams<'api::article.article'>;
+ *
+ * // Example: Parameters for finding multiple articles
+ * const findManyParams: ArticleServiceParams['findMany'] = {
+ *   fields: ['title', 'content'],
+ *   filters: { status: 'published' },
+ *   sort: { createdAt: 'desc' }
+ * };
+ *
+ * // Example: Parameters for creating a new article
+ * const createParams: ArticleServiceParams['create'] = {
+ *   data: { title: 'New Article', content: 'Article content', status: 'draft' }
+ * };
+ * ```
+ */
 export type ServiceParams<TContentTypeUID extends UID.ContentType = UID.ContentType> = {
+    /** Parameters for finding multiple documents */
     findMany: Params.FindMany<TContentTypeUID>;
+    /** Parameters for finding a single document */
     findFirst: Params.FindFirst<TContentTypeUID>;
+    /** Parameters for finding a single document by its ID */
     findOne: Params.FindOne<TContentTypeUID>;
+    /** Parameters for deleting a single document */
     delete: Params.Delete<TContentTypeUID>;
+    /** Parameters for creating a new document */
     create: Params.Create<TContentTypeUID>;
+    /** Parameters for cloning an existing document */
     clone: Params.Clone<TContentTypeUID>;
+    /** Parameters for updating an existing document */
     update: Params.Update<TContentTypeUID>;
+    /** Parameters for counting the number of documents  */
     count: Params.Count<TContentTypeUID>;
+    /** Parameters for publishing a document */
     publish: Params.Publish<TContentTypeUID>;
+    /** Parameters for unpublishing a document */
     unpublish: Params.Unpublish<TContentTypeUID>;
+    /** Parameters for discarding a draft of a document */
     discardDraft: Params.DiscardDraft<TContentTypeUID>;
 };
-export type ServiceResults<TContentTypeUID extends UID.ContentType = UID.ContentType> = {
-    findMany: Result.FindMany<TContentTypeUID, Params.FindMany<TContentTypeUID>>;
-    findFirst: Result.FindFirst<TContentTypeUID, Params.FindFirst<TContentTypeUID>>;
-    findOne: Result.FindOne<TContentTypeUID, Params.FindOne<TContentTypeUID>>;
-    delete: Result.Delete<TContentTypeUID, Params.Delete<TContentTypeUID>>;
-    create: Result.Create<TContentTypeUID, Params.Create<TContentTypeUID>>;
-    clone: Result.Clone<TContentTypeUID, Params.Clone<TContentTypeUID>>;
-    update: Result.Update<TContentTypeUID, Params.Update<TContentTypeUID>>;
-    count: Result.Count;
-    publish: Result.Publish<TContentTypeUID, Params.Publish<TContentTypeUID>>;
-    unpublish: Result.Unpublish<TContentTypeUID, Params.Unpublish<TContentTypeUID>>;
-    discardDraft: Result.DiscardDraft<TContentTypeUID, Params.DiscardDraft<TContentTypeUID>>;
-};
-export type ServiceInstance<TContentTypeUID extends UID.ContentType = UID.ContentType, TServiceParams extends ServiceParams<TContentTypeUID> = ServiceParams<TContentTypeUID>, TServiceResults extends ServiceResults<TContentTypeUID> = ServiceResults<TContentTypeUID>> = {
-    findMany: (params?: TServiceParams['findMany']) => TServiceResults['findMany'];
-    findFirst: (params?: TServiceParams['findFirst']) => TServiceResults['findFirst'];
-    findOne: (params: TServiceParams['findOne']) => TServiceResults['findOne'];
-    delete: (params: TServiceParams['delete']) => TServiceResults['delete'];
-    create: (params: TServiceParams['create']) => TServiceResults['create'];
-    /**
-     * @internal
-     */
-    clone: (params: TServiceParams['clone']) => TServiceResults['clone'];
-    update: (params: TServiceParams['update']) => TServiceResults['update'];
-    count: (params?: TServiceParams['count']) => TServiceResults['count'];
-    publish: Utils.If<IsDraftAndPublishEnabled<TContentTypeUID>, (params: TServiceParams['publish']) => TServiceResults['publish'], never>;
-    unpublish: Utils.If<IsDraftAndPublishEnabled<TContentTypeUID>, (params: TServiceParams['unpublish']) => TServiceResults['unpublish'], never>;
-    discardDraft: Utils.If<IsDraftAndPublishEnabled<TContentTypeUID>, (params: TServiceParams['discardDraft']) => TServiceResults['discardDraft'], never>;
-};
 //# sourceMappingURL=service-instance.d.ts.map

package/dist/modules/documents/service-instance.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service-instance.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/service-instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,KAAK,KAAK,GAAG,MAAM,WAAW,CAAC;AAEtC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,KAAK,KAAK,MAAM,MAAM,0BAA0B,CAAC;AACxD,OAAO,KAAK,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAExD,MAAM,MAAM,aAAa,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI;IACrF,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAC3C,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC7C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACzC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACvC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IACrC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACzC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC7C,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;CACpD,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI;IACtF,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC;IAC7E,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IAChF,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;IAC1E,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC;IACvE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC;IACvE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;IACpE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC;IACvE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;IAC1E,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;IAChF,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC;CAC1F,CAAC;AAEF,MAAM,MAAM,eAAe,CACzB,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,EACzD,cAAc,SAAS,aAAa,CAAC,eAAe,CAAC,GAAG,aAAa,CAAC,eAAe,CAAC,EACtF,eAAe,SAAS,cAAc,CAAC,eAAe,CAAC,GAAG,cAAc,CAAC,eAAe,CAAC,IACvF;IACF,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,KAAK,eAAe,CAAC,UAAU,CAAC,CAAC;IAC/E,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC,WAAW,CAAC,KAAK,eAAe,CAAC,WAAW,CAAC,CAAC;IAClF,OAAO,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,SAAS,CAAC,KAAK,eAAe,CAAC,SAAS,CAAC,CAAC;IAC3E,MAAM,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,KAAK,eAAe,CAAC,QAAQ,CAAC,CAAC;IACxE,MAAM,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,KAAK,eAAe,CAAC,QAAQ,CAAC,CAAC;IAExE;;OAEG;IACH,KAAK,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,OAAO,CAAC,KAAK,eAAe,CAAC,OAAO,CAAC,CAAC;IACrE,MAAM,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,KAAK,eAAe,CAAC,QAAQ,CAAC,CAAC;IACxE,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,KAAK,eAAe,CAAC,OAAO,CAAC,CAAC;IAGtE,OAAO,EAAE,KAAK,CAAC,EAAE,CAEf,wBAAwB,CAAC,eAAe,CAAC,EAEzC,CAAC,MAAM,EAAE,cAAc,CAAC,SAAS,CAAC,KAAK,eAAe,CAAC,SAAS,CAAC,EAEjE,KAAK,CACN,CAAC;IAEF,SAAS,EAAE,KAAK,CAAC,EAAE,CACjB,wBAAwB,CAAC,eAAe,CAAC,EACzC,CAAC,MAAM,EAAE,cAAc,CAAC,WAAW,CAAC,KAAK,eAAe,CAAC,WAAW,CAAC,EACrE,KAAK,CACN,CAAC;IAEF,YAAY,EAAE,KAAK,CAAC,EAAE,CACpB,wBAAwB,CAAC,eAAe,CAAC,EACzC,CAAC,MAAM,EAAE,cAAc,CAAC,cAAc,CAAC,KAAK,eAAe,CAAC,cAAc,CAAC,EAC3E,KAAK,CACN,CAAC;CACH,CAAC"}
+{"version":3,"file":"service-instance.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/service-instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,KAAK,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,KAAK,GAAG,MAAM,WAAW,CAAC;AAEtC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,KAAK,KAAK,MAAM,MAAM,0BAA0B,CAAC;AACxD,OAAO,KAAK,KAAK,MAAM,MAAM,0BAA0B,CAAC;AAExD,MAAM,MAAM,eAAe,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI;IACvF,QAAQ,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,EAC7D,MAAM,CAAC,EAAE,OAAO,GACf,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAE7C,SAAS,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,EAC/D,MAAM,CAAC,EAAE,OAAO,GACf,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAE9C,OAAO,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAC3D,MAAM,EAAE,OAAO,GACd,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAE5C,MAAM,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EACzD,MAAM,EAAE,OAAO,GACd,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAE3C,MAAM,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EACzD,MAAM,EAAE,OAAO,GACd,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAE3C,MAAM,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EACzD,MAAM,EAAE,OAAO,GACd,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAE3C,KAAK,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAE1F;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,EACvD,MAAM,EAAE,OAAO,GACd,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;CAC3C,GAAG,KAAK,CAAC,EAAE,CAEV,wBAAwB,CAAC,eAAe,CAAC,EACzC,wBAAwB,CAAC,eAAe,CAAC,EACzC,OAAO,CACR,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB,CACvC,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW;IAEzD;;OAEG;IACH,OAAO,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,EAC3D,MAAM,EAAE,OAAO,GACd,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAE5C;;OAEG;IACH,SAAS,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,EAC/D,MAAM,EAAE,OAAO,GACd,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAE9C;;OAEG;IACH,YAAY,CAAC,KAAK,CAAC,OAAO,SAAS,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,EACrE,MAAM,EAAE,OAAO,GACd,MAAM,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;CAClD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,MAAM,aAAa,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI;IACrF,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IAE3C,+CAA+C;IAC/C,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAE7C,yDAAyD;IACzD,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAEzC,gDAAgD;IAChD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAEvC,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAEvC,kDAAkD;IAClD,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAErC,mDAAmD;IACnD,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAEvC,uDAAuD;IACvD,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;IAErC,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAEzC,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAE7C,sDAAsD;IACtD,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;CACpD,CAAC"}

package/dist/modules/entity-service/params/data.d.ts

@@ -1,4 +1,52 @@
 import type * as UID from '../../../uid';
 import type * as AttributeUtils from './attributes';
+/**
+ * Represents the input data for a given content-type UID.
+ *
+ * This type evaluates the schema based on the given content-type UID, and extracts the attribute values
+ * accordingly.
+ *
+ * It combines optional and required attributes, while excluding certain relational attributes
+ * that don't target specific schemas like polymorphic relations.
+ *
+ * @template TSchemaUID - A unique identifier for a schema, extending {@link UID.Schema}.
+ *
+ * @remark
+ * The attributes' values are customized to allow additional input formats that are going to be
+ * transformed in the document service methods.
+ *
+ * For example, relational attributes can use the re-ordering API.
+ *
+ * @example
+ * Defining input for a content type schema:
+ *
+ * ```typescript
+ * import type { UID } from '@strapi/types';
+ *
+ * // Assume there's a schema with a UID of 'api::article.article'
+ * type ArticleInput = Input<'api::article.article'>;
+ *
+ * // Example usage of ArticleInput with typed attributes
+ * const articleData: ArticleInput = {
+ *   title: 'My Article', // Required title property
+ *   content: 'Content of the article', // Required content property
+ * };
+ * ```
+ *
+ * @example
+ * Handling component schema with optional and required attributes:
+ *
+ * ```typescript
+ * import type { UID } from '@strapi/types';
+ *
+ * // Assume there's a component with a UID of 'default.comment'
+ * type CommentInput = Input<'default.comment'>;
+ *
+ * const commentData: CommentInput = {
+ *   text: 'Great article!', // Required text property
+ *   author: 'John Doe',     // Optional author property
+ * };
+ * ```
+ */
 export type Input<TSchemaUID extends UID.Schema> = AttributeUtils.GetValues<TSchemaUID>;
 //# sourceMappingURL=data.d.ts.map

package/dist/modules/entity-service/params/data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../src/modules/entity-service/params/data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,KAAK,cAAc,MAAM,cAAc,CAAC;AAEpD,MAAM,MAAM,KAAK,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,cAAc,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC"}
+{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../src/modules/entity-service/params/data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AACzC,OAAO,KAAK,KAAK,cAAc,MAAM,cAAc,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,MAAM,KAAK,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,cAAc,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/types",
-  "version": "5.0.0-rc.8",
+  "version": "5.0.0",
   "description": "Shared typescript types for Strapi internal use",
   "keywords": [
     "strapi"
@@ -46,13 +46,14 @@
     "@casl/ability": "6.5.0",
     "@koa/cors": "5.0.0",
     "@koa/router": "12.0.1",
-    "@strapi/database": "5.0.0-rc.8",
-    "@strapi/logger": "5.0.0-rc.8",
-    "@strapi/permissions": "5.0.0-rc.8",
-    "@strapi/utils": "5.0.0-rc.8",
+    "@strapi/database": "5.0.0",
+    "@strapi/logger": "5.0.0",
+    "@strapi/permissions": "5.0.0",
+    "@strapi/utils": "5.0.0",
     "commander": "8.3.0",
     "koa": "2.15.2",
-    "node-schedule": "2.1.0",
+    "koa-body": "6.0.1",
+    "node-schedule": "2.1.1",
     "typedoc": "0.25.10",
     "typedoc-github-wiki-theme": "1.1.0",
     "typedoc-plugin-markdown": "3.17.1"
@@ -63,16 +64,16 @@
     "@types/jest": "29.5.2",
     "@types/koa": "2.13.4",
     "@types/koa__router": "12.0.0",
-    "@types/node-schedule": "2.1.0",
-    "eslint-config-custom": "5.0.0-rc.8",
+    "@types/node-schedule": "2.1.7",
+    "eslint-config-custom": "5.0.0",
     "lodash": "4.17.21",
-    "tsconfig": "5.0.0-rc.8",
+    "tsconfig": "5.0.0",
     "typescript": "5.3.2",
-    "undici": "6.18.2"
+    "undici": "6.19.2"
   },
   "engines": {
     "node": ">=18.0.0 <=20.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "128200000933388ac942fbb10d39d84b41b27730"
+  "gitHead": "ce84fada19d58a7dfbdd553035e6558f8befcba4"
 }