@strapi/types/dist/modules/documents/result/index.d.ts

Shared typescript types for Strapi internal use

import type * as Schema from '../../../schema';
import type * as Data from '../../../data';
import type * as UID from '../../../uid';
import type { Array, Constants, Guard, String, Cast, If, Extends, MatchFirst, Or, StrictEqual, IsNever } from '../../../utils';
import type { Params } from '..';
type Pagination = {
    page: number;
    pageSize: number;
    pageCount: number;
    total: number;
};
export type AnyDocument = {
    documentId: string;
    id: number;
} & {
    [key: string]: any;
};
export type Result<TSchemaUID extends UID.Schema, TParams extends Params.Pick<TSchemaUID, 'fields' | 'populate'> = never> = If<Constants.AreSchemaRegistriesExtended, GetValues<TSchemaUID, Guard.Never<ExtractFields<TSchemaUID, TParams['fields']>, Schema.NonPopulatableAttributeNames<TSchemaUID>>, ExtractPopulate<TSchemaUID, TParams['populate']>>, AnyDocument>;
export type Document<TSchemaUID extends UID.Schema, TParams extends Params.Pick<TSchemaUID, 'fields' | 'populate'> = never> = If<Constants.AreSchemaRegistriesExtended, GetValues<TSchemaUID, Guard.Never<ExtractFields<TSchemaUID, TParams['fields']>, Schema.NonPopulatableAttributeNames<TSchemaUID>>, Guard.Never<ExtractPopulate<TSchemaUID, TParams['populate']>, Schema.PopulatableAttributeNames<TSchemaUID>>>, AnyDocument>;
export type PartialDocument<TSchemaUID extends UID.Schema, TParams extends Params.Pick<TSchemaUID, 'fields' | 'populate'> = never> = Partial<Document<TSchemaUID, TParams>>;
export type PaginatedResult<TSchemaUID extends UID.Schema, TParams extends Params.Pick<TSchemaUID, 'fields' | 'populate'> = never> = {
    results: Document<TSchemaUID, TParams>[];
    pagination: Pagination;
};
/**
 * Attribute.GetValues override with extended values
 *
 * TODO: Make it recursive for populatable fields
 */
export type GetValues<TSchemaUID extends UID.Schema, TFields extends Schema.AttributeNames<TSchemaUID> = Schema.NonPopulatableAttributeNames<TSchemaUID>, TPopulate extends Schema.AttributeNames<TSchemaUID> = Schema.PopulatableAttributeNames<TSchemaUID>> = If<Constants.AreSchemaRegistriesExtended, Guard.Never<TFields | TPopulate, Schema.AttributeNames<TSchemaUID>> extends infer TKeys extends Schema.AttributeNames<TSchemaUID> ? Data.Entity<TSchemaUID, TKeys> : never, AnyDocument>;
type ExtractFields<TSchemaUID extends UID.Schema, TFields extends Params.Fields.Any<TSchemaUID> | undefined> = Extract<MatchFirst<[
    [
        Or<StrictEqual<TFields, Params.Fields.Any<TSchemaUID>>, Or<IsNever<TFields>, StrictEqual<TFields, undefined>>>,
        never
    ],
    [
        Extends<TFields, Params.Fields.StringNotation<TSchemaUID>>,
        ParseStringFields<TSchemaUID, Cast<TFields, Params.Fields.StringNotation<TSchemaUID>>>
    ],
    [
        Extends<TFields, Params.Fields.ArrayNotation<TSchemaUID>>,
        ParseStringFields<TSchemaUID, Cast<Array.Values<Cast<TFields, Params.Fields.ArrayNotation<TSchemaUID>>>, Params.Fields.StringNotation<TSchemaUID>>>
    ]
]>, Schema.NonPopulatableAttributeNames<TSchemaUID>>;
type ParseStringFields<TSchemaUID extends UID.Schema, TFields extends Params.Fields.StringNotation<TSchemaUID>> = MatchFirst<[
    [
        StrictEqual<TFields, Params.Fields.WildcardNotation>,
        Schema.NonPopulatableAttributeNames<TSchemaUID>
    ],
    [
        Extends<TFields, Params.Fields.SingleAttribute<TSchemaUID>>,
        TFields
    ],
    [
        Extends<TFields, `${string},${string}`>,
        Array.Values<String.Split<Cast<TFields, string>, ','>>
    ]
]>;
type ExtractPopulate<TSchemaUID extends UID.Schema, TPopulate extends Params.Populate.Any<TSchemaUID> | undefined> = Extract<MatchFirst<[
    [
        Or<StrictEqual<TPopulate, Params.Populate.Any<TSchemaUID>>, IsNever<TPopulate>>,
        never
    ],
    [
        Extends<TPopulate, Params.Populate.StringNotation<TSchemaUID>>,
        ParseStringPopulate<TSchemaUID, Cast<TPopulate, Params.Populate.StringNotation<TSchemaUID>>>
    ],
    [
        Extends<TPopulate, Params.Populate.ArrayNotation<TSchemaUID>>,
        ParseStringPopulate<TSchemaUID, Cast<Array.Values<Cast<TPopulate, Params.Populate.ArrayNotation<TSchemaUID>>>, Params.Populate.StringNotation<TSchemaUID>>>
    ],
    [
        Extends<TPopulate, Params.Populate.ObjectNotation<TSchemaUID>>,
        ParseStringPopulate<TSchemaUID, Cast<keyof TPopulate, Params.Populate.StringNotation<TSchemaUID>>>
    ]
]>, Schema.PopulatableAttributeNames<TSchemaUID>>;
type ParsePopulateDotNotation<TSchemaUID extends UID.Schema, TPopulate extends Params.Populate.StringNotation<TSchemaUID>> = Cast<String.Split<Cast<TPopulate, string>, '.'>[0], Schema.PopulatableAttributeNames<TSchemaUID>>;
type ParseStringPopulate<TSchemaUID extends UID.Schema, TPopulate extends Params.Populate.StringNotation<TSchemaUID>> = MatchFirst<[
    [
        StrictEqual<Params.Populate.WildcardNotation, TPopulate>,
        Schema.PopulatableAttributeNames<TSchemaUID>
    ],
    [
        Extends<TPopulate, `${string},${string}`>,
        ParsePopulateDotNotation<TSchemaUID, Cast<Array.Values<String.Split<Cast<TPopulate, string>, ','>>, Params.Populate.StringNotation<TSchemaUID>>>
    ],
    [
        Extends<TPopulate, `${string}.${string}`>,
        ParsePopulateDotNotation<TSchemaUID, TPopulate>
    ]
], TPopulate>;
export {};
//# sourceMappingURL=index.d.ts.map