@strapi/strapi 4.2.1-alpha.0 → 4.3.0-beta.2

package/lib/types/core/attributes/relation.d.ts

@@ -0,0 +1,66 @@
+import { SchemaUID } from '../../utils';
+import { Attribute, ConfigurableOption, PrivateOption } from './base';
+import { GetAttributesByType, GetAttributesValues } from './utils';
+
+export type BasicRelationsType = 'oneToOne' | 'oneToMany' | 'manyToOne' | 'manyToMany';
+export type PolymorphicRelationsType =  'morphToOne' | 'morphToMany' | 'morphOne' | 'morphMany';
+export type RelationsType = BasicRelationsType | PolymorphicRelationsType;
+
+export interface BasicRelationAttributeProperties<
+  S extends SchemaUID,
+  R extends RelationsType,
+  T extends SchemaUID
+> {
+  relation: R;
+  target: T;
+  inversedBy?: RelationsKeysFromTo<T, S>;
+  mappedBy?: RelationsKeysFromTo<T, S>;
+}
+
+export interface PolymorphicRelationAttributeProperties<
+  R extends RelationsType,
+> {
+  relation: R;
+}
+
+export type RelationAttribute<
+  S extends SchemaUID,
+  R extends RelationsType,
+  T extends R extends PolymorphicRelationsType ? never: SchemaUID = never
+> = Attribute<'relation'> &
+  // Properties
+  (R extends BasicRelationsType
+    ? BasicRelationAttributeProperties<S, R, T>
+    : PolymorphicRelationAttributeProperties<R>) &
+  // Options
+  ConfigurableOption &
+  PrivateOption
+
+export type RelationsKeysFromTo<
+  TTarget extends SchemaUID,
+  TSource extends SchemaUID
+> = keyof PickRelationsFromTo<TTarget, TSource>;
+
+export type PickRelationsFromTo<TTarget extends SchemaUID, TSource extends SchemaUID> = GetAttributesByType<
+  TTarget,
+  'relation',
+  { target: TSource }
+>;
+
+export type RelationPluralityModifier<
+  TRelation extends RelationsType,
+  TValue extends Object
+> = TRelation extends `${string}Many` ? TValue[] : TValue;
+
+export type RelationValue<
+  TRelation extends RelationsType,
+  TTarget extends SchemaUID
+> = RelationPluralityModifier<TRelation, GetAttributesValues<TTarget>>;
+
+export type GetRelationAttributeValue<T extends Attribute> = T extends RelationAttribute<
+  infer _TSource,
+  infer TRelation,
+  infer TTarget
+>
+  ? RelationValue<TRelation, TTarget>
+  : never;

package/lib/types/core/attributes/richtext.d.ts

@@ -0,0 +1,22 @@
+import {
+  Attribute,
+  ConfigurableOption,
+  DefaultOption,
+  MinMaxLengthOption,
+  PrivateOption,
+  RequiredOption,
+} from './base';
+
+export type RichTextAttribute = Attribute<'richtext'> &
+  // Options
+  ConfigurableOption &
+  DefaultOption<RichTextValue> &
+  MinMaxLengthOption &
+  PrivateOption &
+  RequiredOption;
+
+export type RichTextValue = string;
+
+export type GetRichTextAttributeValue<T extends Attribute> = T extends RichTextAttribute
+  ? RichTextValue
+  : never;

package/lib/types/core/attributes/string.d.ts

@@ -0,0 +1,30 @@
+import {
+  Attribute,
+  ConfigurableOption,
+  DefaultOption,
+  MinMaxLengthOption,
+  PrivateOption,
+  RequiredOption,
+  UniqueOption,
+} from './base';
+
+export interface StringAttributeProperties {
+  regex?: RegExp;
+}
+
+export type StringAttribute = Attribute<'string'> &
+  // Properties
+  StringAttributeProperties &
+  // Options
+  ConfigurableOption &
+  DefaultOption<StringValue> &
+  MinMaxLengthOption &
+  PrivateOption &
+  UniqueOption &
+  RequiredOption;
+
+export type StringValue = string;
+
+export type GetStringAttributeValue<T extends Attribute> = T extends StringAttribute
+  ? StringValue
+  : never;

package/lib/types/core/attributes/text.d.ts

@@ -0,0 +1,30 @@
+import {
+  Attribute,
+  ConfigurableOption,
+  DefaultOption,
+  MinMaxLengthOption,
+  PrivateOption,
+  RequiredOption,
+  UniqueOption,
+} from './base';
+
+export interface TextAttributeProperties {
+  regex?: RegExp;
+}
+
+export type TextAttribute = Attribute<'text'> &
+  // Properties
+  TextAttributeProperties &
+  // Options
+  ConfigurableOption &
+  DefaultOption<TextValue> &
+  MinMaxLengthOption &
+  PrivateOption &
+  UniqueOption &
+  RequiredOption;
+
+export type TextValue = string;
+
+export type GetTextAttributeValue<T extends Attribute> = T extends TextAttribute
+  ? TextValue
+  : never;

package/lib/types/core/attributes/time.d.ts

@@ -0,0 +1,22 @@
+import {
+  Attribute,
+  ConfigurableOption,
+  DefaultOption,
+  PrivateOption,
+  RequiredOption,
+  UniqueOption,
+} from './base';
+
+export type TimeAttribute = Attribute<'time'> &
+  // Options
+  ConfigurableOption &
+  DefaultOption<TimeValue> &
+  PrivateOption &
+  RequiredOption &
+  UniqueOption;
+
+export type TimeValue = string;
+
+export type GetTimeAttributeValue<T extends Attribute> = T extends TimeAttribute
+  ? TimeValue
+  : never;

package/lib/types/core/attributes/timestamp.d.ts

@@ -0,0 +1,22 @@
+import {
+  Attribute,
+  ConfigurableOption,
+  DefaultOption,
+  PrivateOption,
+  RequiredOption,
+  UniqueOption,
+} from './base';
+
+export type TimestampAttribute = Attribute<'timestamp'> &
+  // Options
+  ConfigurableOption &
+  DefaultOption<TimestampValue> &
+  PrivateOption &
+  RequiredOption &
+  UniqueOption;
+
+export type TimestampValue = string;
+
+export type GetTimestampAttributeValue<T extends Attribute> = T extends TimestampAttribute
+  ? TimestampValue
+  : never;

package/lib/types/core/attributes/uid.d.ts

@@ -0,0 +1,57 @@
+import {
+  Attribute,
+  ConfigurableOption,
+  DefaultOption,
+  MinMaxLengthOption,
+  PrivateOption,
+  RequiredOption,
+} from './base';
+import { SchemaUID } from '../../utils';
+import { GetAttributesKeysByType } from './utils';
+
+export interface UIDAttributeOptions {
+  separator?: string;
+  lowercase?: boolean;
+  decamelize?: boolean;
+  customReplacements?: Array<[string, string]>;
+  preserveLeadingUnderscore?: boolean;
+}
+
+export interface UIDAttributeProperties<
+  // Own Schema Reference
+  T extends SchemaUID | undefined = undefined,
+  // Target attribute
+  U extends T extends SchemaUID
+    ? GetAttributesKeysByType<T, 'string' | 'text'>
+    : undefined = undefined,
+  // UID options
+  S extends UIDAttributeOptions = UIDAttributeOptions
+> {
+  targetField?: U;
+  options?: UIDAttributeOptions & S;
+}
+
+export type UIDAttribute<
+  // Own Schema Reference
+  T extends SchemaUID | undefined = undefined,
+  // Target attribute
+  U extends T extends SchemaUID
+    ? GetAttributesKeysByType<T, 'string' | 'text'>
+    : undefined = undefined,
+  // UID options
+  S extends UIDAttributeOptions = UIDAttributeOptions
+> = Attribute<'uid'> &
+  // Properties
+  UIDAttributeProperties<T, U, S> &
+  // Options
+  ConfigurableOption &
+  DefaultOption<UIDValue> &
+  MinMaxLengthOption &
+  PrivateOption &
+  RequiredOption;
+
+export type UIDValue = string;
+
+export type GetUIDAttributeValue<T extends Attribute> = T extends UIDAttribute<infer _U, infer _P>
+  ? UIDValue
+  : never;

package/lib/types/core/attributes/utils.d.ts

@@ -0,0 +1,99 @@
+import { Get, KeysBy, NeverGuard, PickBy, SchemaUID } from '../../utils';
+import {
+  Attribute,
+  AttributeType,
+  GetBigIntegerAttributeValue,
+  GetBooleanAttributeValue,
+  GetDecimalAttributeValue,
+  GetDynamicZoneAttributeValue,
+  GetEnumerationAttributeValue,
+  GetFloatAttributeValue,
+  GetIntegerAttributeValue,
+  GetJsonAttributeValue,
+  GetMediaAttributeValue,
+  GetPasswordAttributeValue,
+  GetRelationAttributeValue,
+  GetRichTextAttributeValue,
+  GetStringAttributeValue,
+  GetTextAttributeValue,
+  GetUIDAttributeValue,
+  GetComponentAttributeValue,
+  GetEmailAttributeValue,
+} from '.';
+import { GetDateAttributeValue } from './date';
+import { GetDateTimeAttributeValue } from './date-time';
+import { GetTimeAttributeValue } from './time';
+import { GetTimestampAttributeValue } from './timestamp';
+
+export type PickTypes<T extends AttributeType> = T;
+
+export type GetAttributesKeysByType<
+  T extends SchemaUID,
+  U extends AttributeType,
+  P = never
+> = KeysBy<GetAttributes<T>, Attribute<U> & NeverGuard<P, unknown>>;
+
+export type GetAttributesByType<T extends SchemaUID, U extends AttributeType, P = never> = PickBy<
+  GetAttributes<T>,
+  Attribute<U> & NeverGuard<P, unknown>
+>;
+
+export type GetAttribute<T extends SchemaUID, U extends GetAttributesKey<T>> = Get<
+  GetAttributes<T>,
+  U
+>;
+
+export type GetAttributes<T extends SchemaUID> = Get<Strapi.Schemas[T], 'attributes'>;
+
+export type GetAttributesKey<T extends SchemaUID> = keyof GetAttributes<T>;
+
+export type GetAttributeValue<T extends Attribute> =
+  | GetBigIntegerAttributeValue<T>
+  | GetBooleanAttributeValue<T>
+  | GetComponentAttributeValue<T>
+  | GetDecimalAttributeValue<T>
+  | GetDynamicZoneAttributeValue<T>
+  | GetEnumerationAttributeValue<T>
+  | GetEmailAttributeValue<T>
+  | GetFloatAttributeValue<T>
+  | GetIntegerAttributeValue<T>
+  | GetJsonAttributeValue<T>
+  | GetMediaAttributeValue<T>
+  | GetPasswordAttributeValue<T>
+  | GetRelationAttributeValue<T>
+  | GetRichTextAttributeValue<T>
+  | GetStringAttributeValue<T>
+  | GetTextAttributeValue<T>
+  | GetUIDAttributeValue<T>
+  | GetMediaAttributeValue<T>
+  | GetDateAttributeValue<T>
+  | GetDateTimeAttributeValue<T>
+  | GetTimeAttributeValue<T>
+  | GetTimestampAttributeValue<T>;
+
+export type GetAttributeValueByKey<
+  T extends SchemaUID,
+  U extends GetAttributesKey<T>
+> = GetAttribute<T, U> extends infer P
+  ? P extends Attribute
+    ? GetAttributeValue<P>
+    : never
+  : never;
+
+export type GetAttributesValues<T extends SchemaUID> = {
+  // Handle required attributes
+  [key in GetAttributesRequiredKeys<T>]-?: GetAttributeValueByKey<T, key>;
+} &
+  {
+    // Handle optional attributes
+    [key in GetAttributesOptionalKeys<T>]?: GetAttributeValueByKey<T, key>;
+  };
+
+export type GetAttributesRequiredKeys<T extends SchemaUID> = KeysBy<
+  GetAttributes<T>,
+  { required: true }
+>;
+export type GetAttributesOptionalKeys<T extends SchemaUID> = keyof Omit<
+  GetAttributes<T>,
+  GetAttributesRequiredKeys<T>
+>;

package/lib/types/core/index.d.ts

@@ -0,0 +1,3 @@
+export * from './attributes';
+export * from  './schemas';
+export * from './strapi'

package/lib/types/core/schemas/index.d.ts

@@ -0,0 +1,126 @@
+import { Attribute, ComponentAttribute } from '../attributes';
+import { KeysBy, StringRecord } from '../../utils';
+
+/**
+ * Literal union type representing the possible natures of a content type
+ */
+export type ContentTypeKind = 'singleType' | 'collectionType';
+
+/**
+ * Literal union type representing the possible types of a model
+ */
+export type SchemaModelType = 'contentType' | 'component';
+
+/**
+ * Data structure that can either represent a content type or a component
+ */
+export interface Schema {
+  /**
+   * The type of the model. Useful to discriminate content-types from component
+   */
+  modelType: SchemaModelType;
+
+  /**
+   * Informations about schema naming and display
+   */
+  info: SchemaInfo;
+
+  /**
+   * Map of all the attributes with their name and definition
+   */
+  attributes: SchemaAttributes;
+
+  /**
+   * Options declared and read by the plugins
+   */
+  pluginOptions?: PluginOptions;
+
+  /**
+   * Options object dedicated to Strapi core features
+   */
+  options?: SchemaOptions;
+
+  /**
+   * Custom table name for the schema
+   */
+  collectionName?: string;
+}
+
+/**
+ * Data structure containing naming and display information for a Schema
+ */
+export interface SchemaInfo {
+  /**
+   * Default name to use in the admin panel
+   */
+  displayName: string;
+
+  /**
+   * Singular form of the content type name
+   */
+  singularName?: string;
+
+  /**
+   * Plural form of the collection type name
+   */
+  pluralName?: string;
+
+  /**
+   * Description of the model
+   */
+  description?: string;
+
+  /**
+   * FontAwesome (v5) icon name to use for the component's icon in the admin panel
+   */
+  icon?: string;
+}
+
+/**
+ * Low level data structure referencing every schema attribute and its name
+ */
+export interface SchemaAttributes extends StringRecord<Attribute> {}
+
+/**
+ * Structure containing every core schema options and their associated value
+ */
+export interface SchemaOptions {
+  draftAndPublish?: boolean;
+  populateCreatorFields?: boolean;
+  comment?: string;
+}
+
+export interface PluginOptions {}
+
+/**
+ * Schema for a content type
+ */
+export interface ContentTypeSchema extends Schema {
+  modelType: 'contentType';
+
+  /**
+   * Determine the type of the content type (single-type or collection-type)
+   */
+  kind: ContentTypeKind;
+}
+
+/**
+ * Schema for a collection type
+ */
+export interface CollectionTypeSchema extends ContentTypeSchema {
+  kind: 'collectionType';
+}
+
+/**
+ * Schema for a single type
+ */
+export interface SingleTypeSchema extends ContentTypeSchema {
+  kind: 'singleType';
+}
+
+/**
+ * Schema for a component
+ */
+export interface ComponentSchema extends Schema {
+  modelType: 'component';
+}