@akbarsafari00/bonyan-types 5.52.1-fa.4

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

@@ -0,0 +1,73 @@
+import type { UID, Schema, Utils } from '../..';
+import type { Input, PartialInput } from './params/data';
+import type * as AttributeUtils from './params/attributes';
+/**
+ * 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>;
+}>;
+/**
+ * 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
+     */
+    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
+     */
+    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

@@ -0,0 +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,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/draft-and-publish.d.ts

@@ -0,0 +1,12 @@
+import type { Schema, UID, Utils } from '../..';
+export type IsDraftAndPublishEnabled<TSchemaUID extends UID.Schema> = Utils.MatchFirst<[
+    [
+        UID.IsContentType<TSchemaUID>,
+        Utils.IsTrue<NonNullable<Schema.Schema<TSchemaUID>['options']>['draftAndPublish']>
+    ],
+    [
+        Utils.And<Utils.Not<Utils.Extends<TSchemaUID, UID.ContentType>>, UID.IsComponent<TSchemaUID>>,
+        Utils.Constants.False
+    ]
+], Utils.Constants.True>;
+//# sourceMappingURL=draft-and-publish.d.ts.map

package/dist/modules/documents/draft-and-publish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"draft-and-publish.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/draft-and-publish.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAEhD,MAAM,MAAM,wBAAwB,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,KAAK,CAAC,UAAU,CACpF;IACE;QACE,GAAG,CAAC,aAAa,CAAC,UAAU,CAAC;QAC7B,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC;KACnF;IACD;QAGE,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;QAC7F,KAAK,CAAC,SAAS,CAAC,KAAK;KACtB;CACF,EAED,KAAK,CAAC,SAAS,CAAC,IAAI,CACrB,CAAC"}

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

@@ -0,0 +1,27 @@
+import type { UID } from '../..';
+import type * as Middleware from './middleware';
+import type { ServiceInstance } from './service-instance';
+import type { AnyDocument } from './result';
+import type { ComponentExtension } from './component-extension';
+export * as Middleware from './middleware';
+export * as Params from './params';
+export * from './plugin';
+export * from './result';
+export * from './service-instance';
+export type ID = string;
+type ServiceUtils = {
+    transformData: (data: any, opts: any) => Promise<AnyDocument>;
+};
+export type Service = {
+    <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
+     *  strapi.documents.use((ctx, next) => {
+     *    if (!params.locale) params.locale = 'en'
+     *    return next()
+     *  })
+     */
+    use: (cb: Middleware.Middleware) => Service;
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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,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/middleware.d.ts

@@ -0,0 +1,14 @@
+import type { Schema, UID } from '../..';
+import type { ServiceInstance, ServiceParams } from './service-instance';
+export type Context<TUID extends UID.ContentType = UID.ContentType> = {
+    [TUIDKey in TUID]: {
+        [TKey in keyof ServiceParams<TUIDKey>]: {
+            contentType: Schema.ContentType<TUIDKey>;
+            uid: TUIDKey;
+            action: TKey;
+            params: ServiceParams<TUIDKey>[TKey];
+        };
+    }[keyof ServiceParams<TUIDKey>];
+}[TUID];
+export type Middleware = (ctx: Context, next: () => ReturnType<ServiceInstance[keyof ServiceInstance]>) => ReturnType<ServiceInstance[keyof ServiceInstance]> extends Promise<infer Return> ? Promise<Return> : Promise<ReturnType<ServiceInstance[keyof ServiceInstance]>>;
+//# sourceMappingURL=middleware.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../../src/modules/documents/middleware.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AACzC,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEzE,MAAM,MAAM,OAAO,CAAC,IAAI,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI;KACnE,OAAO,IAAI,IAAI,GAAG;SAChB,IAAI,IAAI,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG;YACtC,WAAW,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;YACzC,GAAG,EAAE,OAAO,CAAC;YACb,MAAM,EAAE,IAAI,CAAC;YACb,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;SACtC;KACF,CAAC,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;CAChC,CAAC,IAAI,CAAC,CAAC;AAER,MAAM,MAAM,UAAU,GAAG,CACvB,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,UAAU,CAAC,eAAe,CAAC,MAAM,eAAe,CAAC,CAAC,KAC3D,UAAU,CAAC,eAAe,CAAC,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,MAAM,CAAC,GACjF,OAAO,CAAC,MAAM,CAAC,GACf,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,MAAM,eAAe,CAAC,CAAC,CAAC,CAAC"}

package/dist/modules/documents/params/attributes/id.d.ts

@@ -0,0 +1,4 @@
+import type * as Data from '../../../../data';
+export type ID = Data.ID;
+export type DocumentID = Data.DocumentID;
+//# sourceMappingURL=id.d.ts.map

package/dist/modules/documents/params/attributes/id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"id.d.ts","sourceRoot":"","sources":["../../../../../src/modules/documents/params/attributes/id.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,IAAI,MAAM,kBAAkB,CAAC;AAE9C,MAAM,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;AAEzB,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC"}

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

@@ -0,0 +1,79 @@
+import type * as Schema from '../../../../schema';
+import type * as UID from '../../../../uid';
+import type { Array, Constants, Object, If, Extends, MatchFirst, IsNotNever } from '../../../../utils';
+import type { ID, DocumentID } from './id';
+import type { OmitRelationsWithoutTarget, RelationInputValue } from './relations';
+export type NonFilterableKind = Extract<Schema.Attribute.Kind, 'password' | 'dynamiczone'>;
+export type FilterableKind = Exclude<Schema.Attribute.Kind, NonFilterableKind>;
+export type GetNonFilterableKeys<TSchemaUID extends UID.Schema> = Object.KeysBy<Schema.Attributes<TSchemaUID>, Schema.Attribute.OfType<NonFilterableKind>, string>;
+export type GetScalarKeys<TSchemaUID extends UID.Schema> = Exclude<Schema.AttributeNamesByType<TSchemaUID, Schema.Attribute.NonPopulatableKind>, GetNonFilterableKeys<TSchemaUID>>;
+export type GetNestedKeys<TSchemaUID extends UID.Schema> = Exclude<Schema.AttributeNamesWithTarget<TSchemaUID>, GetNonFilterableKeys<TSchemaUID>>;
+export type BooleanValue = boolean | 'true' | 'false' | 't' | 'f' | '1' | '0' | 1 | 0;
+export type NumberValue = string | number;
+export type DateValue = Schema.Attribute.DateValue | number;
+export type TimeValue = Schema.Attribute.TimeValue | number;
+export type DateTimeValue = Schema.Attribute.DateTimeValue | number;
+export type TimeStampValue = Schema.Attribute.TimestampValue;
+/**
+ * List of possible values for the scalar attributes
+ * Uses the local GetValue to benefit from the values' overrides
+ */
+export type ScalarValues = GetValue<Schema.Attribute.BigInteger | Schema.Attribute.Boolean | Schema.Attribute.DateTime | Schema.Attribute.Date | Schema.Attribute.Decimal | Schema.Attribute.Email | Schema.Attribute.Enumeration<string[]> | Schema.Attribute.Float | Schema.Attribute.Integer | Schema.Attribute.Blocks | Schema.Attribute.JSON | Schema.Attribute.RichText | Schema.Attribute.String | Schema.Attribute.Text | Schema.Attribute.Time | Schema.Attribute.Timestamp | Schema.Attribute.UID>;
+/**
+ * Attribute.GetValues override with extended values
+ */
+export type GetValues<TSchemaUID extends UID.Schema> = {
+    id?: ID;
+    documentId?: DocumentID;
+} & OmitRelationsWithoutTarget<TSchemaUID, {
+    [TKey in Schema.OptionalAttributeNames<TSchemaUID>]?: GetValue<Schema.AttributeByName<TSchemaUID, TKey>>;
+} & {
+    [TKey in Schema.RequiredAttributeNames<TSchemaUID>]-?: GetValue<Schema.AttributeByName<TSchemaUID, TKey>>;
+}>;
+/**
+ * Attribute.GetValue override with extended values
+ *
+ * Fallback to unknown if never is found
+ */
+export type GetValue<TAttribute extends Schema.Attribute.Attribute> = If<IsNotNever<TAttribute>, MatchFirst<[
+    [
+        Extends<TAttribute, Schema.Attribute.OfType<'relation'>>,
+        TAttribute extends Schema.Attribute.RelationWithTarget ? RelationInputValue<TAttribute['relation']> : never
+    ],
+    [
+        Extends<TAttribute, Schema.Attribute.OfType<'dynamiczone'>>,
+        TAttribute extends Schema.Attribute.DynamicZone<infer TComponentsUIDs> ? Array<Array.Values<TComponentsUIDs> extends infer TComponentUID ? TComponentUID extends UID.Component ? GetValues<TComponentUID> & {
+            __component: TComponentUID;
+        } : never : never> : never
+    ],
+    [
+        Extends<TAttribute, Schema.Attribute.OfType<'component'>>,
+        TAttribute extends Schema.Attribute.Component<infer TComponentUID, infer TRepeatable> ? TComponentUID extends UID.Component ? GetValues<TComponentUID> extends infer TValues ? If<TRepeatable, TValues[], TValues> : never : never : never
+    ],
+    [
+        Extends<TAttribute, Schema.Attribute.Boolean>,
+        BooleanValue
+    ],
+    [
+        Extends<TAttribute, Schema.Attribute.Integer | Schema.Attribute.BigInteger | Schema.Attribute.Float | Schema.Attribute.Decimal>,
+        NumberValue
+    ],
+    [
+        Extends<TAttribute, Schema.Attribute.Time>,
+        TimeValue
+    ],
+    [
+        Extends<TAttribute, Schema.Attribute.Date>,
+        DateValue
+    ],
+    [
+        Extends<TAttribute, Schema.Attribute.Timestamp | Schema.Attribute.DateTime>,
+        DateTimeValue
+    ],
+    [
+        Constants.True,
+        Schema.Attribute.Value<TAttribute>
+    ]
+], unknown>, unknown>;
+export type { ID, DocumentID };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/modules/documents/params/attributes/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAElD,OAAO,KAAK,KAAK,GAAG,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EACV,KAAK,EACL,SAAS,EACT,MAAM,EACN,EAAE,EACF,OAAO,EACP,UAAU,EACV,UAAU,EACX,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAC3C,OAAO,KAAK,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAElF,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,aAAa,CAAC,CAAC;AAC3F,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;AAE/E,MAAM,MAAM,oBAAoB,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAC7E,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAC7B,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,iBAAiB,CAAC,EAC1C,MAAM,CACP,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,OAAO,CAChE,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAC5E,oBAAoB,CAAC,UAAU,CAAC,CACjC,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,OAAO,CAChE,MAAM,CAAC,wBAAwB,CAAC,UAAU,CAAC,EAC3C,oBAAoB,CAAC,UAAU,CAAC,CACjC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;AAEtF,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC;AAE1C,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC;AAE5D,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC;AAE5D,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,SAAS,CAAC,aAAa,GAAG,MAAM,CAAC;AAEpE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC;AAE7D;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAC/B,MAAM,CAAC,SAAS,CAAC,UAAU,GAC3B,MAAM,CAAC,SAAS,CAAC,OAAO,GACxB,MAAM,CAAC,SAAS,CAAC,QAAQ,GACzB,MAAM,CAAC,SAAS,CAAC,IAAI,GACrB,MAAM,CAAC,SAAS,CAAC,OAAO,GACxB,MAAM,CAAC,SAAS,CAAC,KAAK,GACtB,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC,GACtC,MAAM,CAAC,SAAS,CAAC,KAAK,GACtB,MAAM,CAAC,SAAS,CAAC,OAAO,GACxB,MAAM,CAAC,SAAS,CAAC,MAAM,GACvB,MAAM,CAAC,SAAS,CAAC,IAAI,GAIrB,MAAM,CAAC,SAAS,CAAC,QAAQ,GACzB,MAAM,CAAC,SAAS,CAAC,MAAM,GACvB,MAAM,CAAC,SAAS,CAAC,IAAI,GACrB,MAAM,CAAC,SAAS,CAAC,IAAI,GACrB,MAAM,CAAC,SAAS,CAAC,SAAS,GAC1B,MAAM,CAAC,SAAS,CAAC,GAAG,CACvB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI;IACrD,EAAE,CAAC,EAAE,EAAE,CAAC;IACR,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB,GAAG,0BAA0B,CAC5B,UAAU,EACV;KACG,IAAI,IAAI,MAAM,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,QAAQ,CAC5D,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CACzC;CACF,GAAG;KACD,IAAI,IAAI,MAAM,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,QAAQ,CAC7D,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CACzC;CACF,CACF,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAAC,UAAU,SAAS,MAAM,CAAC,SAAS,CAAC,SAAS,IAAI,EAAE,CACtE,UAAU,CAAC,UAAU,CAAC,EACtB,UAAU,CACR;IAEE;QACE,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACxD,UAAU,SAAS,MAAM,CAAC,SAAS,CAAC,kBAAkB,GAClD,kBAAkB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,GAC1C,KAAK;KACV;IAED;QACE,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAC3D,UAAU,SAAS,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,MAAM,eAAe,CAAC,GAClE,KAAK,CAEH,KAAK,CAAC,MAAM,CAAC,eAAe,CAAC,SAAS,MAAM,aAAa,GACrD,aAAa,SAAS,GAAG,CAAC,SAAS,GACjC,SAAS,CAAC,aAAa,CAAC,GAAG;YAAE,WAAW,EAAE,aAAa,CAAA;SAAE,GACzD,KAAK,GACP,KAAK,CACV,GACD,KAAK;KACV;IAED;QACE,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzD,UAAU,SAAS,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,aAAa,EAAE,MAAM,WAAW,CAAC,GACjF,aAAa,SAAS,GAAG,CAAC,SAAS,GACjC,SAAS,CAAC,aAAa,CAAC,SAAS,MAAM,OAAO,GAC5C,EAAE,CAAC,WAAW,EAAE,OAAO,EAAE,EAAE,OAAO,CAAC,GACnC,KAAK,GACP,KAAK,GACP,KAAK;KACV;IAED;QAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC;QAAE,YAAY;KAAC;IAE7D;QACE,OAAO,CACL,UAAU,EACR,MAAM,CAAC,SAAS,CAAC,OAAO,GACxB,MAAM,CAAC,SAAS,CAAC,UAAU,GAC3B,MAAM,CAAC,SAAS,CAAC,KAAK,GACtB,MAAM,CAAC,SAAS,CAAC,OAAO,CAC3B;QACD,WAAW;KACZ;IAED;QAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC;QAAE,SAAS;KAAC;IACvD;QAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC;QAAE,SAAS;KAAC;IACvD;QAAC,OAAO,CAAC,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;QAAE,aAAa;KAAC;IAG5F;QAAC,SAAS,CAAC,IAAI;QAAE,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC;KAAC;CACrD,EACD,OAAO,CACR,EACD,OAAO,CACR,CAAC;AAIF,YAAY,EAAE,EAAE,EAAE,UAAU,EAAE,CAAC"}

package/dist/modules/documents/params/attributes/relations.d.ts

@@ -0,0 +1,40 @@
+import type * as Schema from '../../../../schema';
+import type * as UID from '../../../../uid';
+import type { If } from '../../../../utils';
+import type { ID, DocumentID } from './id';
+type ShortHand = ID;
+type LongHandEntity = {
+    id: ID;
+};
+type LongHandDocument = {
+    documentId: DocumentID;
+    locale?: string;
+};
+type LongHand = LongHandEntity | LongHandDocument;
+interface PositionalArguments {
+    before?: ID;
+    after?: ID;
+    start?: boolean;
+    end?: boolean;
+}
+type WithPositionArguments<T> = T & {
+    position?: PositionalArguments;
+};
+type Set = {
+    set: ShortHand[] | LongHand[] | null;
+};
+type Connect = {
+    connect: ShortHand[] | WithPositionArguments<LongHand>[];
+};
+type Disconnect = {
+    disconnect: ShortHand[] | LongHand[];
+};
+type FullUpdate = Set;
+type PartialUpdate = Partial<Connect & Disconnect>;
+type XOneInput = ShortHand | LongHand | null;
+type XManyInput = ShortHand[] | LongHand[] | null | PartialUpdate | FullUpdate;
+export type RelationInputValue<TRelationKind extends Schema.Attribute.RelationKind.Any> = If<Schema.Attribute.IsManyRelation<TRelationKind>, XManyInput, XOneInput>;
+type RelationsKeysWithoutTarget<TSchemaUID extends UID.Schema> = Exclude<Schema.AttributeNamesByType<TSchemaUID, 'relation'>, Schema.AttributeNamesWithTarget<TSchemaUID>>;
+export type OmitRelationsWithoutTarget<TSchemaUID extends UID.Schema, TValue> = Omit<TValue, RelationsKeysWithoutTarget<TSchemaUID>>;
+export {};
+//# sourceMappingURL=relations.d.ts.map

package/dist/modules/documents/params/attributes/relations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relations.d.ts","sourceRoot":"","sources":["../../../../../src/modules/documents/params/attributes/relations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAElD,OAAO,KAAK,KAAK,GAAG,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,KAAK,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAE3C,KAAK,SAAS,GAAG,EAAE,CAAC;AACpB,KAAK,cAAc,GAAG;IAAE,EAAE,EAAE,EAAE,CAAA;CAAE,CAAC;AACjC,KAAK,gBAAgB,GAAG;IAAE,UAAU,EAAE,UAAU,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACpE,KAAK,QAAQ,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAElD,UAAU,mBAAmB;IAC3B,MAAM,CAAC,EAAE,EAAE,CAAC;IACZ,KAAK,CAAC,EAAE,EAAE,CAAC;IACX,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,KAAK,qBAAqB,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,QAAQ,CAAC,EAAE,mBAAmB,CAAA;CAAE,CAAC;AAEvE,KAAK,GAAG,GAAG;IAAE,GAAG,EAAE,SAAS,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAA;CAAE,CAAC;AACpD,KAAK,OAAO,GAAG;IAAE,OAAO,EAAE,SAAS,EAAE,GAAG,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAA;CAAE,CAAC;AAC5E,KAAK,UAAU,GAAG;IAAE,UAAU,EAAE,SAAS,EAAE,GAAG,QAAQ,EAAE,CAAA;CAAE,CAAC;AAE3D,KAAK,UAAU,GAAG,GAAG,CAAC;AACtB,KAAK,aAAa,GAAG,OAAO,CAAC,OAAO,GAAG,UAAU,CAAC,CAAC;AAEnD,KAAK,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,IAAI,CAAC;AAC7C,KAAK,UAAU,GAAG,SAAS,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,GAAG,aAAa,GAAG,UAAU,CAAC;AAE/E,MAAM,MAAM,kBAAkB,CAAC,aAAa,SAAS,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,GAAG,IAAI,EAAE,CAC1F,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,aAAa,CAAC,EAC9C,UAAU,EACV,SAAS,CACV,CAAC;AAEF,KAAK,0BAA0B,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,OAAO,CACtE,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,UAAU,CAAC,EACnD,MAAM,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAC5C,CAAC;AAEF,MAAM,MAAM,0BAA0B,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,IAAI,IAAI,CAClF,MAAM,EACN,0BAA0B,CAAC,UAAU,CAAC,CACvC,CAAC"}

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

@@ -0,0 +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

@@ -0,0 +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;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/document-engine.d.ts

@@ -0,0 +1,34 @@
+import type * as UID from '../../../uid';
+import { Pick } from '.';
+import { ID } from '..';
+/**
+ * Document Service specific method params
+ *
+ * `hasPublishedVersion` on these picks is deprecated in favor of `publicationFilter`.
+ */
+export type FindMany<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'fields' | 'filters' | '_q' | 'pagination' | 'sort' | 'populate' | 'status' | 'publicationFilter' | 'hasPublishedVersion' | 'locale' | 'plugin' | 'lookup'>;
+export type Count<TContentTypeUID extends UID.ContentType> = FindMany<TContentTypeUID>;
+export type FindFirst<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'fields' | 'filters' | '_q' | 'sort' | 'populate' | 'status' | 'publicationFilter' | 'hasPublishedVersion' | 'locale:string' | 'plugin' | 'lookup'>;
+export type FindOne<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'fields' | 'populate' | 'filters' | 'status' | 'locale:string' | 'sort' | 'lookup'> & {
+    documentId: ID;
+};
+export type Delete<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'fields' | 'populate' | 'filters' | 'status' | 'publicationFilter' | 'hasPublishedVersion' | 'locale:string' | 'lookup'> & {
+    documentId: ID;
+};
+export type Create<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'data' | 'fields' | 'populate' | 'locale:string' | 'lookup' | 'status'>;
+export type Clone<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'data' | 'fields' | 'populate' | 'status' | 'locale:string' | 'lookup'> & {
+    documentId: ID;
+};
+export type Update<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'data:partial' | 'fields' | 'populate' | 'locale:string' | 'lookup'> & {
+    documentId: ID;
+};
+export type Publish<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'filters' | 'locale' | 'lookup'> & {
+    documentId: ID;
+};
+export type Unpublish<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'filters' | 'locale:string' | 'lookup'> & {
+    documentId: ID;
+};
+export type DiscardDraft<TContentTypeUID extends UID.ContentType> = Pick<TContentTypeUID, 'filters' | 'locale' | 'lookup'> & {
+    documentId: ID;
+};
+//# sourceMappingURL=document-engine.d.ts.map

package/dist/modules/documents/params/document-engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-engine.d.ts","sourceRoot":"","sources":["../../../../src/modules/documents/params/document-engine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC;AACzB,OAAO,EAAE,EAAE,EAAE,MAAM,IAAI,CAAC;AAExB;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CAClE,eAAe,EACb,QAAQ,GACR,SAAS,GACT,IAAI,GACJ,YAAY,GACZ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,qBAAqB,GACrB,QAAQ,GACR,QAAQ,GACR,QAAQ,CACX,CAAC;AAEF,MAAM,MAAM,KAAK,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,QAAQ,CAAC,eAAe,CAAC,CAAC;AAEvF,MAAM,MAAM,SAAS,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CACnE,eAAe,EACb,QAAQ,GACR,SAAS,GACT,IAAI,GACJ,MAAM,GACN,UAAU,GACV,QAAQ,GACR,mBAAmB,GACnB,qBAAqB,GACrB,eAAe,GACf,QAAQ,GACR,QAAQ,CACX,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CACjE,eAAe,EACf,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,eAAe,GAAG,MAAM,GAAG,QAAQ,CACnF,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,MAAM,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CAChE,eAAe,EACb,QAAQ,GACR,UAAU,GACV,SAAS,GACT,QAAQ,GACR,mBAAmB,GACnB,qBAAqB,GACrB,eAAe,GACf,QAAQ,CACX,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,MAAM,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CAChE,eAAe,EACf,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,eAAe,GAAG,QAAQ,GAAG,QAAQ,CACvE,CAAC;AAEF,MAAM,MAAM,KAAK,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CAC/D,eAAe,EACf,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,eAAe,GAAG,QAAQ,CACvE,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,MAAM,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CAChE,eAAe,EACf,cAAc,GAAG,QAAQ,GAAG,UAAU,GAAG,eAAe,GAAG,QAAQ,CACpE,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CACjE,eAAe,EACf,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAChC,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CACnE,eAAe,EACf,SAAS,GAAG,eAAe,GAAG,QAAQ,CACvC,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,IAAI,IAAI,CACtE,eAAe,EACf,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAChC,GAAG;IACF,UAAU,EAAE,EAAE,CAAC;CAChB,CAAC"}

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

@@ -0,0 +1,61 @@
+import type * as Schema from '../../../schema';
+import type * as UID from '../../../uid';
+import type { Guard } from '../../../utils';
+/**
+ * Wildcard notation for the fields.
+ *
+ * When used, it represents every non-populatable field from the given schema
+ */
+export type WildcardNotation = '*';
+/**
+ * Single non-populatable attribute representation
+ *
+ * @example
+ * type A = 'title'; // ✅
+ * type B = 'description'; // ✅
+ * type C = 'populatableField'; // ❌
+ * type D = '<random_string>'; // ❌
+ */
+export type SingleAttribute<TSchemaUID extends UID.Schema> = 'id' | 'documentId' | Guard.Never<Schema.NonPopulatableAttributeNames<TSchemaUID>, string>;
+/**
+ * Union of all possible string representation for fields
+ *
+ * @example
+ * type A = 'title'; // ✅
+ * type B = 'title,description'; // ✅
+ * type C = 'id'; // ✅
+ * type D = '*'; // ✅
+ * type E = 'populatableField'; // ❌
+ * type F = '<random_string>'; // ❌
+ */
+export type StringNotation<TSchemaUID extends UID.Schema> = WildcardNotation | SingleAttribute<TSchemaUID> | `${string},${string}`;
+/**
+ * Array notation for fields
+ *
+ * @example
+ * type A = ['title']; // ✅
+ * type B = ['title', 'description']; // ✅
+ * type C = ['id']; // ✅
+ * type E = ['*']; // ❌
+ * type F = ['populatableField']; // ❌
+ * type G = ['<random_string>']; // ❌
+ */
+export type ArrayNotation<TSchemaUID extends UID.Schema> = Exclude<StringNotation<TSchemaUID>, WildcardNotation>[];
+/**
+ * Represents any notation for a sort (string, array, object)
+ *
+ * @example
+ * type A = '*'; // ✅
+ * type B = 'id'; // ✅
+ * type C = 'title'; // ✅
+ * type D = 'title,description'; // ✅
+ * type E = ['title', 'description']; // ✅
+ * type F = [id, 'title,description']; // ✅
+ * type G = ['*']; // ❌
+ * type H = ['populatableField']; // ❌
+ * type I = ['<random_string>']; // ❌
+ * type J = 'populatableField'; // ❌
+ * type K = '<random_string>'; // ❌
+ */
+export type Any<TSchemaUID extends UID.Schema> = StringNotation<TSchemaUID> | ArrayNotation<TSchemaUID>;
+//# sourceMappingURL=fields.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../../src/modules/documents/params/fields.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;AAE5C;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAEnC;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IACrD,IAAI,GACJ,YAAY,GACZ,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,4BAA4B,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,CAAC;AAEzE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IACpD,gBAAgB,GAChB,eAAe,CAAC,UAAU,CAAC,GAE3B,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAE1B;;;;;;;;;;GAUG;AACH,MAAM,MAAM,aAAa,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,OAAO,CAChE,cAAc,CAAC,UAAU,CAAC,EAC1B,gBAAgB,CACjB,EAAE,CAAC;AAEJ;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,GAAG,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IACzC,cAAc,CAAC,UAAU,CAAC,GAC1B,aAAa,CAAC,UAAU,CAAC,CAAC"}

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

@@ -0,0 +1,61 @@
+import type * as Schema from '../../../../schema';
+import type * as UID from '../../../../uid';
+import type { Guard, If, And, MatchFirst, StrictEqual, IsNotNever } from '../../../../utils';
+import type * as Operator from './operators';
+import type * as AttributeUtils from '../attributes';
+import type * as Params from '..';
+export { Operator };
+type IDKey = 'id';
+type DocumentIDKey = 'documentId';
+/**
+ * Filter representation for nested attributes
+ */
+type NestedAttributeCondition<TSchemaUID extends UID.Schema, TAttributeName extends Schema.AttributeNames<TSchemaUID>> = ObjectNotation<Guard.Never<Schema.Attribute.Target<Schema.AttributeByName<TSchemaUID, TAttributeName>>, UID.Schema>>;
+/**
+ * Filter representation for scalar attributes
+ */
+type AttributeCondition<TSchemaUID extends UID.Schema, TAttributeName extends IDKey | DocumentIDKey | Schema.AttributeNames<TSchemaUID>> = MatchFirst<[
+    [
+        StrictEqual<TAttributeName, IDKey>,
+        Params.Attribute.ID
+    ],
+    [
+        StrictEqual<TAttributeName, DocumentIDKey>,
+        Params.Attribute.DocumentID
+    ],
+    [
+        IsNotNever<TAttributeName>,
+        AttributeUtils.GetValue<Schema.AttributeByName<TSchemaUID, Extract<TAttributeName, Schema.AttributeNames<TSchemaUID>>>>
+    ]
+], AttributeUtils.ScalarValues> extends infer TAttributeValue ? TAttributeValue | ({
+    [TIter in Operator.BooleanValue]?: boolean;
+} & {
+    [TIter in Operator.DynamicValue]?: TAttributeValue;
+} & {
+    [TIter in Operator.DynamicArrayValue]?: TAttributeValue[];
+} & {
+    [TIter in Operator.DynamicBoundValue]?: [TAttributeValue, TAttributeValue];
+} & {
+    [TIter in Operator.Logical]?: AttributeCondition<TSchemaUID, TAttributeName>;
+} & {
+    [TIter in Operator.Group]?: AttributeCondition<TSchemaUID, TAttributeName>[];
+}) : never;
+/**
+ * Tree representation of a Strapi filter for a given schema UID
+ */
+export type ObjectNotation<TSchemaUID extends UID.Schema> = {
+    [TIter in Operator.Group]?: ObjectNotation<TSchemaUID>[];
+} & {
+    [TIter in Operator.Logical]?: ObjectNotation<TSchemaUID>;
+} & ([AttributeUtils.GetScalarKeys<TSchemaUID>, AttributeUtils.GetNestedKeys<TSchemaUID>] extends [
+    infer TScalarKeys extends AttributeUtils.GetScalarKeys<TSchemaUID>,
+    infer TNestedKeys extends AttributeUtils.GetNestedKeys<TSchemaUID>
+] ? If<And<IsNotNever<TScalarKeys>, IsNotNever<TNestedKeys>>, {
+    [TIter in IDKey | DocumentIDKey | TScalarKeys]?: AttributeCondition<TSchemaUID, TIter>;
+} & {
+    [TIter in TNestedKeys]?: NestedAttributeCondition<TSchemaUID, TIter>;
+}, {
+    [TKey in string]?: AttributeCondition<TSchemaUID, never> | NestedAttributeCondition<TSchemaUID, never>;
+}> : never);
+export type Any<TSchemaUID extends UID.Schema> = ObjectNotation<TSchemaUID>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/modules/documents/params/filters/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAElD,OAAO,KAAK,KAAK,GAAG,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE7F,OAAO,KAAK,KAAK,QAAQ,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,KAAK,cAAc,MAAM,eAAe,CAAC;AACrD,OAAO,KAAK,KAAK,MAAM,MAAM,IAAI,CAAC;AAElC,OAAO,EAAE,QAAQ,EAAE,CAAC;AAEpB,KAAK,KAAK,GAAG,IAAI,CAAC;AAClB,KAAK,aAAa,GAAG,YAAY,CAAC;AAElC;;GAEG;AACH,KAAK,wBAAwB,CAC3B,UAAU,SAAS,GAAG,CAAC,MAAM,EAC7B,cAAc,SAAS,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,IACtD,cAAc,CAChB,KAAK,CAAC,KAAK,CACT,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,EAC3E,GAAG,CAAC,MAAM,CACX,CACF,CAAC;AAEF;;GAEG;AACH,KAAK,kBAAkB,CACrB,UAAU,SAAS,GAAG,CAAC,MAAM,EAC7B,cAAc,SAAS,KAAK,GAAG,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,IAEhF,UAAU,CACR;IAEE;QAAC,WAAW,CAAC,cAAc,EAAE,KAAK,CAAC;QAAE,MAAM,CAAC,SAAS,CAAC,EAAE;KAAC;IACzD;QAAC,WAAW,CAAC,cAAc,EAAE,aAAa,CAAC;QAAE,MAAM,CAAC,SAAS,CAAC,UAAU;KAAC;IACzE;QACE,UAAU,CAAC,cAAc,CAAC;QAE1B,cAAc,CAAC,QAAQ,CACrB,MAAM,CAAC,eAAe,CACpB,UAAU,EACV,OAAO,CAAC,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAC3D,CACF;KACF;CACF,EAED,cAAc,CAAC,YAAY,CAC5B,SAAS,MAAM,eAAe,GAEvB,eAAe,GACf,CAAC;KACE,KAAK,IAAI,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,OAAO;CAC3C,GAAG;KACD,KAAK,IAAI,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,eAAe;CACnD,GAAG;KACD,KAAK,IAAI,QAAQ,CAAC,iBAAiB,CAAC,CAAC,EAAE,eAAe,EAAE;CAC1D,GAAG;KACD,KAAK,IAAI,QAAQ,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,eAAe,EAAE,eAAe,CAAC;CAC3E,GAAG;KACD,KAAK,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,EAAE,cAAc,CAAC;CAC7E,GAAG;KACD,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,EAAE,cAAc,CAAC,EAAE;CAC7E,CAAC,GACN,KAAK,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI;KACzD,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE;CACzD,GAAG;KACD,KAAK,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,cAAc,CAAC,UAAU,CAAC;CACzD,GAAG,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,SAAS;IAC9F,MAAM,WAAW,SAAS,cAAc,CAAC,aAAa,CAAC,UAAU,CAAC;IAClE,MAAM,WAAW,SAAS,cAAc,CAAC,aAAa,CAAC,UAAU,CAAC;CACnE,GAGG,EAAE,CACA,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC,EAErD;KACG,KAAK,IAAI,KAAK,GAAG,aAAa,GAAG,WAAW,CAAC,CAAC,EAAE,kBAAkB,CAAC,UAAU,EAAE,KAAK,CAAC;CACvF,GAAG;KACD,KAAK,IAAI,WAAW,CAAC,CAAC,EAAE,wBAAwB,CAAC,UAAU,EAAE,KAAK,CAAC;CACrE,EAED;KACG,IAAI,IAAI,MAAM,CAAC,CAAC,EACb,kBAAkB,CAAC,UAAU,EAAE,KAAK,CAAC,GACrC,wBAAwB,CAAC,UAAU,EAAE,KAAK,CAAC;CAChD,CACF,GACD,KAAK,CAAC,CAAC;AAEb,MAAM,MAAM,GAAG,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,cAAc,CAAC,UAAU,CAAC,CAAC"}

package/dist/modules/documents/params/filters/operators.d.ts

@@ -0,0 +1,9 @@
+export type Array = '$in' | '$notIn' | '$between';
+export type Group = '$and' | '$or';
+export type Logical = '$not';
+export type BooleanValue = '$null' | '$notNull';
+export type DynamicValue = '$eq' | '$eqi' | '$ne' | '$nei' | '$gt' | '$gte' | '$lt' | '$lte' | '$startsWith' | '$endsWith' | '$startsWithi' | '$endsWithi' | '$contains' | '$notContains' | '$containsi' | '$notContainsi';
+export type DynamicArrayValue = '$in' | '$notIn';
+export type DynamicBoundValue = '$between';
+export type Where = BooleanValue | DynamicValue | DynamicArrayValue | DynamicBoundValue;
+//# sourceMappingURL=operators.d.ts.map

package/dist/modules/documents/params/filters/operators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operators.d.ts","sourceRoot":"","sources":["../../../../../src/modules/documents/params/filters/operators.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,UAAU,CAAC;AAElD,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;AAEnC,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAE7B,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,UAAU,CAAC;AAEhD,MAAM,MAAM,YAAY,GACpB,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,aAAa,GACb,WAAW,GACX,cAAc,GACd,YAAY,GACZ,WAAW,GACX,cAAc,GACd,YAAY,GACZ,eAAe,CAAC;AAEpB,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEjD,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC;AAE3C,MAAM,MAAM,KAAK,GAAG,YAAY,GAAG,YAAY,GAAG,iBAAiB,GAAG,iBAAiB,CAAC"}