@strapi/types 5.0.0-beta.0 → 5.0.0-beta.10

package/dist/schema/attribute/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/schema/attribute/options.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,MAAM;IACtC,GAAG,CAAC,EAAE,CAAC,CAAC;IACR,GAAG,CAAC,EAAE,CAAC,CAAC;CACT;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AAIH;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAC;AAE1C;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IAAE,QAAQ,EAAE,KAAK,CAAA;CAAE,CAAC;AAI9C;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IAAE,OAAO,EAAE,IAAI,CAAA;CAAE,CAAC;AAExC;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,KAAK,CAAA;CAAE,CAAC;AAI5C;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG;IAAE,MAAM,EAAE,IAAI,CAAA;CAAE,CAAC;AAEtC;;;;GAIG;AACH,MAAM,MAAM,SAAS,GAAG;IAAE,MAAM,EAAE,KAAK,CAAA;CAAE,CAAC;AAI1C;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IAAE,YAAY,EAAE,IAAI,CAAA;CAAE,CAAC;AAElD;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAAE,YAAY,EAAE,KAAK,CAAA;CAAE,CAAC;AAItD;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAC;AAE1C;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG;IAAE,QAAQ,EAAE,KAAK,CAAA;CAAE,CAAC;AAI9C;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG;IAAE,OAAO,EAAE,IAAI,CAAA;CAAE,CAAC;AAExC;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IAAE,OAAO,EAAE,KAAK,CAAA;CAAE,CAAC;AAG5C,MAAM,MAAM,WAAW,CAAC,KAAK,SAAS,MAAM,EAAE,QAAQ,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,IAAI;IAC/F,WAAW,EAAE,KAAK,CAAC;IACnB,OAAO,CAAC,EAAE,QAAQ,CAAC;CACpB,CAAC;AAIF;;;;;;;GAOG;AACH,MAAM,MAAM,SAAS,CAAC,OAAO,SAAS,YAAY,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,IAAI,OAAO,CAAC;AAIrF;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,kBAAkB,IAAI,OAAO,CAAC;AAE1E;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,IAAI;IAAE,aAAa,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAE5F;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,CAAC"}

package/dist/schema/attribute/utils.d.ts

@@ -0,0 +1,101 @@
+import type * as UID from '../../uid';
+import type { Constants, Guard, And, Extends, IsNotNever } from '../../utils';
+import type { Attribute } from '..';
+/**
+ * Determines if a given attribute type is of a specific kind.
+ *
+ * @template TAttribute - The attribute type to check.
+ * @template TKind - The kind of attribute to compare against.
+ */
+export type IsOfType<TAttribute extends Attribute.Attribute, TKind extends Attribute.Kind> = TAttribute extends {
+    type: TKind;
+} ? true : false;
+/**
+ * Checks whether a given Attribute {@link TAttribute} is populatable.
+ *
+ * @template TAttribute - The attribute to check.
+ *
+ * @see {@link PopulatableKind} for more information about populatable attributes.
+ */
+export type IsPopulatable<TAttribute extends Attribute.Attribute> = IsOfType<TAttribute, Attribute.PopulatableKind>;
+/**
+ * Returns the type (as {@link Kind}) of a given attribute.
+ *
+ * @template TAttribute - Any attribute
+ */
+export type TypeOf<TAttribute extends Attribute.Attribute> = TAttribute['type'];
+/**
+ * Extract the target of an attribute.
+ *
+ * Returns never if the attribute don't have a target.
+ *
+ * Returns {@link UID.Schema} if a valid target is found
+ *
+ * @template TAttribute - The attribute to use
+ *
+ * @remark Targets can only be inferred from relation, component, and media attributes.
+ */
+export type Target<TAttribute extends Attribute.Attribute> = Attribute.RelationTarget<TAttribute> | Attribute.ComponentTarget<TAttribute> | Attribute.MediaTarget<TAttribute>;
+/**
+ * Extract the potential targets of a polymorphic attribute.
+ *
+ * Returns never if the attribute don't have any target.
+ *
+ * Returns {@link UID.Schema} if valid targets are found
+ *
+ * @template TAttribute - The attribute to use
+ *
+ * @remark Morph targets can only be inferred from dynamic-zone attributes.
+ */
+export type MorphTargets<TAttribute extends Attribute.Attribute> = Attribute.DynamicZoneTargets<TAttribute>;
+/**
+ * Checks whether an attribute has a valid target.
+ *
+ * @template TAttribute - The attribute to check
+ *
+ * @see Target
+ *
+ * @remark Targets can only be inferred from relation, component, and media attributes.
+ */
+export type HasTarget<TAttribute extends Attribute.Attribute> = Target<TAttribute> extends infer TTarget ? And<IsNotNever<TTarget>, Extends<TTarget, UID.Schema>> : Constants.False;
+/**
+ * Checks whether an attribute has valid targets.
+ *
+ * @template TAttribute - The attribute to check
+ *
+ * @see MorphTargets
+ *
+ * @remark Targets can only be inferred from dynamic-zone attributes.
+ */
+export type HasMorphTargets<TAttribute extends Attribute.Attribute> = MorphTargets<TAttribute> extends infer TMaybeTargets ? And<IsNotNever<TMaybeTargets>, Extends<TMaybeTargets, UID.Schema>> : Constants.False;
+/**
+ * Represents the actual value of a given attribute {@link TAttribute}.
+ *
+ * @template TAttribute - The attribute to extract the value from.
+ * @template TGuard - The fallback type to use if it's not possible to infer the correct type value.
+ */
+export type Value<TAttribute extends Attribute.Attribute, TGuard = unknown> = Guard.Never<{
+    biginteger: Attribute.GetBigIntegerValue<TAttribute>;
+    boolean: Attribute.GetBooleanValue<TAttribute>;
+    blocks: Attribute.GetBlocksValue<TAttribute>;
+    decimal: Attribute.GetDecimalValue<TAttribute>;
+    enumeration: Attribute.GetEnumerationValue<TAttribute>;
+    email: Attribute.GetEmailValue<TAttribute>;
+    float: Attribute.GetFloatValue<TAttribute>;
+    integer: Attribute.GetIntegerValue<TAttribute>;
+    json: Attribute.GetJsonValue<TAttribute>;
+    password: Attribute.GetPasswordValue<TAttribute>;
+    richtext: Attribute.GetRichTextValue<TAttribute>;
+    string: Attribute.GetStringValue<TAttribute>;
+    text: Attribute.GetTextValue<TAttribute>;
+    uid: Attribute.GetUIDValue<TAttribute>;
+    date: Attribute.GetDateValue<TAttribute>;
+    datetime: Attribute.GetDateTimeValue<TAttribute>;
+    time: Attribute.GetTimeValue<TAttribute>;
+    timestamp: Attribute.GetTimestampValue<TAttribute>;
+    component: Attribute.GetComponentValue<TAttribute>;
+    dynamiczone: Attribute.GetDynamicZoneValue<TAttribute>;
+    media: Attribute.GetMediaValue<TAttribute>;
+    relation: Attribute.GetRelationValue<TAttribute>;
+}[Attribute.TypeOf<TAttribute>], TGuard>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/schema/attribute/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/schema/attribute/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,GAAG,MAAM,WAAW,CAAC;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAEpC;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,CAClB,UAAU,SAAS,SAAS,CAAC,SAAS,EACtC,KAAK,SAAS,SAAS,CAAC,IAAI,IAC1B,UAAU,SAAS;IACrB,IAAI,EAAE,KAAK,CAAC;CACb,GACG,IAAI,GACJ,KAAK,CAAC;AAEV;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,UAAU,SAAS,SAAS,CAAC,SAAS,IAAI,QAAQ,CAC1E,UAAU,EACV,SAAS,CAAC,eAAe,CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAAC,UAAU,SAAS,SAAS,CAAC,SAAS,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;AAEhF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,MAAM,CAAC,UAAU,SAAS,SAAS,CAAC,SAAS,IACrD,SAAS,CAAC,cAAc,CAAC,UAAU,CAAC,GACpC,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC,GACrC,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAEtC;;;;;;;;;;GAUG;AACH,MAAM,MAAM,YAAY,CAAC,UAAU,SAAS,SAAS,CAAC,SAAS,IAC7D,SAAS,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;AAE3C;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,CAAC,UAAU,SAAS,SAAS,CAAC,SAAS,IAC1D,MAAM,CAAC,UAAU,CAAC,SAAS,MAAM,OAAO,GACpC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,GACtD,SAAS,CAAC,KAAK,CAAC;AAEtB;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,UAAU,SAAS,SAAS,CAAC,SAAS,IAChE,YAAY,CAAC,UAAU,CAAC,SAAS,MAAM,aAAa,GAChD,GAAG,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,GAClE,SAAS,CAAC,KAAK,CAAC;AAEtB;;;;;GAKG;AACH,MAAM,MAAM,KAAK,CAAC,UAAU,SAAS,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,IAAI,KAAK,CAAC,KAAK,CACvF;IAEE,UAAU,EAAE,SAAS,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC;IACrD,OAAO,EAAE,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IAC/C,MAAM,EAAE,SAAS,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAC7C,OAAO,EAAE,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IAC/C,WAAW,EAAE,SAAS,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACvD,KAAK,EAAE,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAC3C,KAAK,EAAE,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAC3C,OAAO,EAAE,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IAC/C,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACzC,QAAQ,EAAE,SAAS,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACjD,QAAQ,EAAE,SAAS,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACjD,MAAM,EAAE,SAAS,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAC7C,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACzC,GAAG,EAAE,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACvC,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACzC,QAAQ,EAAE,SAAS,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACjD,IAAI,EAAE,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACzC,SAAS,EAAE,SAAS,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IAEnD,SAAS,EAAE,SAAS,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACnD,WAAW,EAAE,SAAS,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACvD,KAAK,EAAE,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAC3C,QAAQ,EAAE,SAAS,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;CAClD,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAC/B,MAAM,CACP,CAAC"}

package/dist/schema/index.d.ts

@@ -0,0 +1,144 @@
+import type * as Public from '../public';
+import type * as UID from '../uid';
+import type { If, Object, Guard } from '../utils';
+import type * as Attribute from './attribute';
+export { Attribute };
+/**
+ * Combines both content type and component schemas, effectively serving as a consolidated registry of all schemas.
+ *
+ * Enables mapping between a unique identifier and its corresponding schema.
+ *
+ @remark Schema definitions are pulled from the public registries
+ */
+export type Schemas = Public.ContentTypeSchemas & Public.ComponentSchemas;
+/**
+ * Content-type schema definitions.
+ *
+ * @remark Schema definitions are pulled from the public content-type registries
+ */
+export type ContentTypes = Public.ContentTypeSchemas;
+/**
+ * Component schema definitions.
+ *
+ * @remark Schema definitions are pulled from the public component registries
+ */
+export type Components = Public.ComponentSchemas;
+export type ContentType<TContentTypeUID extends UID.ContentType = UID.ContentType> = ContentTypes[TContentTypeUID];
+export type Component<TComponentUID extends UID.Component = UID.Component> = Components[TComponentUID];
+/**
+ * Returns the Schema data structure associated with the given UID
+ *
+ * @template TSchemaUID - The unique identifier for the schema.
+ *
+ * @see Schemas
+ */
+export type Schema<TSchemaUID extends UID.Schema = UID.Schema> = Schemas[TSchemaUID];
+/**
+ * Returns the `info` property for a given schema.
+ *
+ * @template TSchemaUID - The targeted schema UID.
+ *
+ * @see Schema
+ */
+export type Info<TSchemaUID extends UID.Schema> = Schema<TSchemaUID>['info'];
+/**
+ * Returns the `modelType` property for a given schema.
+ *
+ * @template TSchemaUID - The targeted schema UID.
+ *
+ * @see Schema
+ */
+export type ModelType<TSchemaUID extends UID.Schema> = Schema<TSchemaUID>['modelType'];
+/**
+ * Returns the attribute {@link TAttributeName} from {@link TSchemaUID}'s attributes.
+ *
+ * @template TSchemaUID - The Schema's UID used to look for attributes.
+ * @template TAttributeName - The name of the wanted attribute.
+ */
+export type AttributeByName<TSchemaUID extends UID.Schema, TAttributeName extends AttributeNames<TSchemaUID>> = Attributes<TSchemaUID>[TAttributeName];
+/**
+ * Represents the value of an attribute based on its name
+ *
+ * @template TSchemaUID - The Schema's UID used to look for attributes.
+ * @template TAttributeName - The name of the wanted attribute.
+ */
+export type AttributeValueByName<TSchemaUID extends UID.Schema, TAttributeName extends AttributeNames<TSchemaUID>> = Attribute.Value<AttributeByName<TSchemaUID, TAttributeName>>;
+/**
+ * Returns an object containing every attribute within {@link TSchemaUID}.
+ *
+ * @template TSchemaUID - The Schema's UID used to get its attributes
+ */
+export type Attributes<TSchemaUID extends UID.Schema = UID.Schema> = {
+    [TUID in TSchemaUID]: Schema<TSchemaUID>['attributes'];
+}[TSchemaUID];
+/**
+ * Union type of every attribute name within {@link TSchemaUID}'s attributes
+ *
+ * @template TSchemaUID - The Schema's UID used to get the attributes names.
+ */
+export type AttributeNames<TSchemaUID extends UID.Schema> = Extract<keyof Attributes<TSchemaUID>, string>;
+/**
+ * Create an attribute record whose types matches the given ones.
+ *
+ * @template TSchemaUID - The Schema's UID used to get the attribute names.
+ * @template TKind - The kind of attribute we are searching for.
+ * @template TCondition - Optional. An additional condition to match additional attributes properties.
+ */
+export type AttributesByType<TSchemaUID extends UID.Schema, TKind extends Attribute.Kind, TCondition = never> = Object.PickBy<Attributes<TSchemaUID>, Attribute.OfType<TKind> & Guard.Never<TCondition>>;
+/**
+ * Returns a union of attribute names whose type matches the given ones.
+ *
+ * @template TSchemaUID - The Schema's UID used to get the attribute names.
+ * @template TKind - The kind of attribute we are searching for.
+ * @template TCondition - Optional. An additional condition to match additional attributes properties.
+ */
+export type AttributeNamesByType<TSchemaUID extends UID.Schema, TKind extends Attribute.Kind, TCondition = never> = Object.KeysBy<Attributes<TSchemaUID>, Attribute.OfType<TKind> & Guard.Never<TCondition, unknown>, AttributeNames<TSchemaUID>>;
+/**
+ * Provides the names of non-populatable attributes of a Schema.
+ *
+ * Non-populatable attributes are those which do not need to be populated to get their final value.
+ *
+ * @template TSchemaUID - The unique identifier of the schema.
+ */
+export type NonPopulatableAttributeNames<TSchemaUID extends UID.Schema> = AttributeNamesByType<TSchemaUID, Attribute.NonPopulatableKind>;
+/**
+ * Provides the names of populatable attributes of a Schema.
+ *
+ * Populatable attributes are those which need to be populated to get their final value, such as {@link Attribute.Relation}, {@link Attribute.DynamicZone}, {@link Attribute.Component} or {@link Attribute.Media}.
+ *
+ * @template TSchemaUID - The unique identifier of the schema.
+ */
+export type PopulatableAttributeNames<TSchemaUID extends UID.Schema> = AttributeNamesByType<TSchemaUID, Attribute.PopulatableKind>;
+/**
+ * Returns a list of attribute names which have associated targets.
+ *
+ * @remark `
+ AttributeNamesWithTarget` maps over the list of attribute for a given schema and filters those
+ * with targets (in other words, attribute names that have associated {@link Attribute.HasTarget} true).
+ *
+ * @returns a union of each attribute's name matching the condition.
+ *
+ * @template TSchemaUID - The unique identifier of the schema.
+ */
+export type AttributeNamesWithTarget<TSchemaUID extends UID.Schema> = Extract<Object.Values<{
+    [TKey in AttributeNames<TSchemaUID>]: If<Attribute.HasTarget<AttributeByName<TSchemaUID, TKey>>, TKey>;
+}>, AttributeNames<TSchemaUID>>;
+/**
+ * Extracts the names of all required attributes from a given schema.
+ *
+ * @remark `RequiredAttributeNames` screens attributes based on the {@link Attribute.Required} property,
+ * determining mandatory attributes from the given schema.
+ *
+ * @template TSchemaUID - The identifier of the schema.
+ */
+export type RequiredAttributeNames<TSchemaUID extends UID.Schema> = Object.KeysBy<Attributes<TSchemaUID>, Attribute.Required, AttributeNames<TSchemaUID>>;
+/**
+ * Returns a union of every optional attribute name by excluding required attribute keys from the given Schema UID.
+ *
+ * @remark The `
+ OptionalAttributeNames` type utilises the {@link Object.KeysExcept} utility that takes a Schema's attributes and excludes the keys of required attributes.
+ *
+ * @template TSchemaUID - The unique identifier for the schema.
+ */
+export type OptionalAttributeNames<TSchemaUID extends UID.Schema> = Object.KeysExcept<Attributes<TSchemaUID>, Attribute.Required, AttributeNames<TSchemaUID>>;
+//# sourceMappingURL=index.d.ts.map

package/dist/schema/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/schema/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAElD,OAAO,KAAK,KAAK,SAAS,MAAM,aAAa,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,CAAC;AAErB;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,kBAAkB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAE1E;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAErD;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAEjD,MAAM,MAAM,WAAW,CAAC,eAAe,SAAS,GAAG,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,IAC/E,YAAY,CAAC,eAAe,CAAC,CAAC;AAEhC,MAAM,MAAM,SAAS,CAAC,aAAa,SAAS,GAAG,CAAC,SAAS,GAAG,GAAG,CAAC,SAAS,IACvE,UAAU,CAAC,aAAa,CAAC,CAAC;AAE5B;;;;;;GAMG;AACH,MAAM,MAAM,MAAM,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;AAErF;;;;;;GAMG;AACH,MAAM,MAAM,IAAI,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7E;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,CACzB,UAAU,SAAS,GAAG,CAAC,MAAM,EAC7B,cAAc,SAAS,cAAc,CAAC,UAAU,CAAC,IAC/C,UAAU,CAAC,UAAU,CAAC,CAAC,cAAc,CAAC,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,CAC9B,UAAU,SAAS,GAAG,CAAC,MAAM,EAC7B,cAAc,SAAS,cAAc,CAAC,UAAU,CAAC,IAC/C,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI;KAClE,IAAI,IAAI,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,YAAY,CAAC;CACvD,CAAC,UAAU,CAAC,CAAC;AAEd;;;;GAIG;AACH,MAAM,MAAM,cAAc,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,OAAO,CACjE,MAAM,UAAU,CAAC,UAAU,CAAC,EAC5B,MAAM,CACP,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,CAC1B,UAAU,SAAS,GAAG,CAAC,MAAM,EAC7B,KAAK,SAAS,SAAS,CAAC,IAAI,EAC5B,UAAU,GAAG,KAAK,IAChB,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;AAE7F;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,CAC9B,UAAU,SAAS,GAAG,CAAC,MAAM,EAC7B,KAAK,SAAS,SAAS,CAAC,IAAI,EAC5B,UAAU,GAAG,KAAK,IAChB,MAAM,CAAC,MAAM,CACf,UAAU,CAAC,UAAU,CAAC,EACtB,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,EAC1D,cAAc,CAAC,UAAU,CAAC,CAC3B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,4BAA4B,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,oBAAoB,CAC5F,UAAU,EACV,SAAS,CAAC,kBAAkB,CAC7B,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,oBAAoB,CACzF,UAAU,EACV,SAAS,CAAC,eAAe,CAC1B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,wBAAwB,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,OAAO,CAC3E,MAAM,CAAC,MAAM,CAAC;KACX,IAAI,IAAI,cAAc,CAAC,UAAU,CAAC,GAAG,EAAE,CACtC,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,EACtD,IAAI,CACL;CACF,CAAC,EACF,cAAc,CAAC,UAAU,CAAC,CAC3B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,CAC/E,UAAU,CAAC,UAAU,CAAC,EACtB,SAAS,CAAC,QAAQ,EAClB,cAAc,CAAC,UAAU,CAAC,CAC3B,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,CACnF,UAAU,CAAC,UAAU,CAAC,EACtB,SAAS,CAAC,QAAQ,EAClB,cAAc,CAAC,UAAU,CAAC,CAC3B,CAAC"}

package/dist/struct/index.d.ts

@@ -0,0 +1,3 @@
+export type * from './schema';
+export type * from './schema-definition';
+//# sourceMappingURL=index.d.ts.map

package/dist/struct/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/struct/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,UAAU,CAAC;AAC9B,mBAAmB,qBAAqB,CAAC"}

package/dist/struct/schema-definition.d.ts

@@ -0,0 +1,10 @@
+import type { Schema } from './schema';
+/**
+ * Represents a generic Schema before being loaded by Strapi (e.g. app or user defined schemas)
+ *
+ * @internal
+ */
+export type SchemaDefinition = Omit<Schema, 'uid' | 'attributes'> & {
+    attributes: Record<string, Record<string, unknown>>;
+};
+//# sourceMappingURL=schema-definition.d.ts.map

package/dist/struct/schema-definition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-definition.d.ts","sourceRoot":"","sources":["../../src/struct/schema-definition.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,GAAG,YAAY,CAAC,GAAG;IAClE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACrD,CAAC"}

package/dist/struct/schema.d.ts

@@ -0,0 +1,248 @@
+import type { Attribute } from '../schema';
+import type * as UID from '../uid';
+export type ContentTypeKind = 'collectionType' | 'singleType';
+export type ModelType = 'contentType' | 'component';
+export type Schema = ContentTypeSchema | ComponentSchema;
+/**
+ * A loaded instance of a Strapi Schema accessible to the server.
+ */
+export interface BaseSchema {
+    /**
+     * The unique identifier of the Schema. This identifier is a combined type encompassing both ContentType and Component UID types.
+     *
+     * It is mainly used when dealing with either content types or components in a situation where the context is not specific.
+     */
+    uid: UID.Schema;
+    /**
+     * This is an identifier type that helps differentiate between a 'contentType' and 'component'.
+     * This distinction aids in communication where the ModelType needs to be specified explicitly.
+     */
+    modelType: ModelType;
+    /**
+     * Serves as the public name of the schema. Often utilized in referencing a specific schema (e.g. in the database).
+     */
+    modelName: string;
+    /**
+     * This global identifier acts as a unique reference to the schema across varying scopes and contexts.
+     */
+    globalId: string;
+    /**
+     * Contains options specific to plugins. It is an optional property and stores configurations that are read by the plugins associated with this Schema.
+     */
+    pluginOptions?: SchemaPluginOptions;
+    /**
+     * Encapsulates all core options related to Strapi features for a given Schema.
+     */
+    options?: SchemaOptions;
+    /**
+     * Optional property. Specifies the custom table name for the Schema if any.
+     */
+    collectionName?: string;
+    /**
+     * Contains information related to naming and display characteristics of the Schema.
+     */
+    info: SchemaInfo;
+    /**
+     * Houses a comprehensive collection of attributes for this Schema.
+     *
+     * Each attribute has a unique string key and corresponding value should be any Attribute type instance.
+     */
+    attributes: SchemaAttributes;
+}
+/**
+ * Comprises naming and display parameters to customize a Schema's representation.
+ */
+export interface SchemaInfo {
+    /**
+     * Sets the default nomenclature for the Admin Panel. Acts as the label while identifying
+     * the schema or interacting with it within the admin panel. For example, used as a label
+     * for fields, table columns, and menu items.
+     */
+    displayName: string;
+    /**
+     * Delineates the purpose of the model, clarifying its intended usage or its function. This
+     * property is optional and is primarily meant for further documentation to provide better
+     * context and understanding of the schema.
+     */
+    description?: string;
+    /**
+     * Specifies the visual identifier - an icon, for the schema inside the admin panel. It eases
+     * recognition and improves navigation. The value should be any valid @strapi/icon name. This
+     * property is optional, and if omitted, a default icon might be used by the interface.
+     */
+    icon?: string;
+}
+/**
+ * `SchemaAttributes` is a mapping of attribute keys to their corresponding values.
+ *
+ * These keys and values define the structure and characteristics of a Strapi schema.
+ */
+export type SchemaAttributes = Record<string, Attribute.AnyAttribute>;
+/**
+ * Contains various options employed during runtime to tweak certain aspects of Strapi features.
+ *
+ * Each property under this interface can enable, disable or modify a specific feature or functionality associated with a schema.
+ */
+export interface SchemaOptions {
+    /**
+     * Toggles the review workflow feature on or off.
+     *
+     * A review workflow is a process that describes the stages a document must go through from creation to publication.
+     *
+     * @remark This option is Enterprise Edition Exclusive.
+     */
+    reviewWorkflows?: boolean;
+    /**
+     * Determines if creator fields can be populated.
+     *
+     * When enabled, this feature will allow populating data about the admin user who created a specific document entry.
+     */
+    populateCreatorFields?: boolean;
+    /**
+     * May be used for providing specific notes or annotations of the schema.
+     */
+    comment?: string;
+    /**
+     * Can be utilized for setting a particular version of schema related to the review-workflow feature.
+     *
+     * @deprecated As of v5, this is deprecated and will likely be removed soon.
+     */
+    version?: string;
+    /**
+     * Used to enable or disable the draft and publish feature.
+     * This would decide whether the changes made to a document are published immediately or saved as a draft for later.
+     */
+    draftAndPublish?: boolean;
+}
+/**
+ * Provides a flexible configuration method for Strapi plugins.
+ *
+ * In Strapi, plugins extend the core functionality and enhance features of the application. Each plugin may require
+ * prerequisite settings or configurations for successful functioning. `SchemaPluginOptions` facilitates this by storing these configurations
+ * as key-value pairs where the key corresponds to the name of the plugin, and the value defines the respective settings of that plugin.
+ *
+ * @remark The keys/values of configurations are not explicitly defined and are manually defined in each schema definition.
+ *
+ * @example
+ * Using `SchemaPluginOptions` in the schema definition:
+ *
+ * ```typescript
+ * import type { Struct } from '@strapi/types';
+ *
+ * const strapiPluginOptions: Struct.SchemaPluginOptions = {
+ *   'plugin-foo': {
+ *     prop1: string;
+ *     prop2: boolean;
+ *   },
+ *   'plugin-bar': {
+ *     prop1: string;
+ *     prop2: boolean;
+ *   },
+ * };
+ *
+ * const articleSchema: Struct.BaseSchema = {
+ *   uid: 'article',
+ *   modelType: 'contentType',
+ *   modelName: 'Article',
+ *   globalId: 'Article',
+ *   pluginOptions: strapiPluginOptions,
+ *   // Other schema properties...
+ * };
+ * ```
+ *
+ */
+export interface SchemaPluginOptions {
+    [key: string]: unknown;
+}
+/**
+ * Serves as a layout for a content type.
+ *
+ * Inherits and enhances various properties from the `BaseSchema`, the `ContentTypeSchema` is a unique derivative of the base schema that distinguishes itself with additional properties.
+ */
+export interface ContentTypeSchema extends BaseSchema {
+    /**
+     * Forces the `modelType` to be a `contentType`.
+     *
+     * @remark Helpful to distinguish a {@link ContentTypeSchema} from a {@link ComponentSchema}
+     */
+    modelType: 'contentType';
+    /**
+     * Unique identifier associated with the content type. It acts as a reference to work with data structures that are specifically identified by the content type's UID.
+     */
+    uid: UID.ContentType;
+    /**
+     * Classifies the content type as 'collection-type' or 'single-type'.
+     */
+    kind: ContentTypeKind;
+    /**
+     * Brings together attributes related to naming and display characteristics like singular name and plural name of the content type. These names are typically used in user interfaces where these entries are displayed.
+     */
+    info: ContentTypeSchemaInfo;
+    /**
+     * Optional attribute to indicate the indexes to be created on the database for this content type.
+     *
+     * @internal
+     */
+    indexes?: unknown[];
+}
+/**
+ * Contains naming properties specific to a specific content type.
+ */
+export interface ContentTypeSchemaInfo extends SchemaInfo {
+    /**
+     * Indicates how a single instance of the content type should be labeled.
+     */
+    singularName: string;
+    /**
+     * Provides a human-friendly label for referring to multiple instances of the content type.
+     */
+    pluralName: string;
+}
+/**
+ * Schema that represents a collection of content types' entry in the system.
+ */
+export interface CollectionTypeSchema extends ContentTypeSchema {
+    /**
+     * Explicitly sets the kind of content type schema to 'collectionType'.
+     *
+     * This signifies that the content type is organized in a collection, handling multiple entries.
+     */
+    kind: 'collectionType';
+}
+/**
+ * Schema that represents a single of content type's entry in the system.
+ */
+export interface SingleTypeSchema extends ContentTypeSchema {
+    /**
+     * Explicitly sets the kind of content type schema to 'singleType'.
+     *
+     * This signifies that the content type has a single entry.
+     */
+    kind: 'singleType';
+}
+/**
+ * Serves as a layout for a component type.
+ *
+ * Inherits and enhances various properties from the `BaseSchema`, the `ComponentSchema` is a unique derivative of the base schema that distinguishes itself with additional properties.
+ */
+export interface ComponentSchema extends BaseSchema {
+    /**
+     * Forces the `modelType` to be a `component`.
+     *
+     * @remark Helpful to distinguish a {@link ComponentSchema} from a {@link ContentTypeSchema}
+     */
+    modelType: 'component';
+    /**
+     * A unique identifier for the component.
+     *
+     * It uses `UID.Component` type which encapsulates unique identifiers for any component defined in the public component registry.
+     */
+    uid: UID.Component;
+    /**
+     * A classification field for the component.
+     *
+     * This string type field is utilized to categorize components into different categories based on their function or feature.
+     */
+    category: string;
+}
+//# sourceMappingURL=schema.d.ts.map

package/dist/struct/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/struct/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AAEnC,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG,YAAY,CAAC;AAE9D,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,WAAW,CAAC;AAEpD,MAAM,MAAM,MAAM,GAAG,iBAAiB,GAAG,eAAe,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC;IAEhB;;;OAGG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;OAIG;IACH,UAAU,EAAE,gBAAgB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;AAEtE;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,WAAW,mBAAmB;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD;;;;OAIG;IACH,SAAS,EAAE,aAAa,CAAC;IAEzB;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC,WAAW,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,eAAe,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC;IAE5B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,iBAAiB;IAC7D;;;;OAIG;IACH,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD;;;;OAIG;IACH,IAAI,EAAE,YAAY,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD;;;;OAIG;IACH,SAAS,EAAE,WAAW,CAAC;IAEvB;;;;OAIG;IACH,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC;IAEnB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB"}