@akbarsafari00/bonyan-types 5.52.1-fa.4

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

@@ -0,0 +1,221 @@
+/**
+ * Interfaces and types designed for managing attribute options.
+ *
+ * It includes (but is not limited to) settings for requirements, privacy, uniqueness, default values, configurability,
+ * constraints, visibility, and writability of an attribute as well as the provision for custom fields.
+ */
+/**
+ * Specifies whether an attribute is required to be filled.
+ *
+ * If not defined, it defaults to false.
+ */
+export interface RequiredOption {
+    required?: boolean;
+}
+/**
+ * Specifies whether an attribute is private and should be included in the content API entries.
+ *
+ * If not defined, it defaults to false.
+ */
+export interface PrivateOption {
+    private?: boolean;
+}
+/**
+ * Specifies whether an attribute must have unique values for each entry.
+ *
+ * If not defined, it defaults to false.
+ */
+export interface UniqueOption {
+    unique?: boolean;
+}
+/**
+ * Allow declaring a default value for an attribute's value.
+ *
+ * If not defined, there is no default value and the field will default to `null`.
+ */
+export interface DefaultOption<T> {
+    default?: T | (() => T);
+}
+/**
+ * Specifies whether an attribute can be configured from the admin panel.
+ *
+ * If not defined, it defaults to false.
+ */
+export interface ConfigurableOption {
+    configurable?: boolean;
+}
+/**
+ * Sets a minimum and/or maximum constraint for an attribute.
+ *
+ * If any of the property is undefined, there won't be any limit.
+ *
+ * @template T - The min/max type
+ */
+export interface MinMaxOption<T = number> {
+    min?: T;
+    max?: T;
+}
+/**
+ * Sets a minimum length and/or maximum length constraint for the total length for a text based field.
+ *
+ * If any of the property is undefined, there won't be any limit.
+ */
+export interface MinMaxLengthOption {
+    minLength?: number;
+    maxLength?: number;
+}
+/**
+ * Specified whether an attribute's value can be filled using the content API (REST or GraphQL)
+ *
+ * If not defined, the attribute is considered writable.
+ */
+export interface WritableOption {
+    writable?: boolean;
+}
+/**
+ * Specifies whether an attribute should be visible in the content-manager.
+ *
+ * If not defined, the attribute is considered visible.
+ */
+export interface VisibleOption {
+    visible?: boolean;
+}
+/**
+ * Setters for the attributes options
+ */
+/**
+ * Forces the attribute to be required.
+ *
+ * @see RequiredOption
+ */
+export type Required = {
+    required: true;
+};
+/**
+ * Forces the attribute to be optional
+ *
+ * @see RequiredOption
+ */
+export type NonRequired = {
+    required: false;
+};
+/**
+ * Forces the attribute to be private
+ *
+ * @see PrivateOption
+ */
+export type Private = {
+    private: true;
+};
+/**
+ * Forces the attribute to not be private
+ *
+ * @see PrivateOption
+ */
+export type NonPrivate = {
+    private: false;
+};
+/**
+ * Forces the attribute to be unique
+ *
+ * @see UniqueOption
+ */
+export type Unique = {
+    unique: true;
+};
+/**
+ * Forces the attribute not to be unique
+ *
+ * @see UniqueOption
+ */
+export type NonUnique = {
+    unique: false;
+};
+/**
+ * Forces the attribute not to be configurable
+ *
+ * @see ConfigurableOption
+ */
+export type Configurable = {
+    configurable: true;
+};
+/**
+ * Forces the attribute not to be configurable
+ *
+ * @see ConfigurableOption
+ */
+export type NonConfigurable = {
+    configurable: false;
+};
+/**
+ * Forces the attribute to be writable
+ *
+ * @see WritableOption
+ */
+export type Writable = {
+    writable: true;
+};
+/**
+ * Forces the attribute not to be writable
+ *
+ * @see WritableOption
+ */
+export type NonWritable = {
+    writable: false;
+};
+/**
+ * Forces the attribute to be visible
+ *
+ * @see VisibleOption
+ */
+export type Visible = {
+    visible: true;
+};
+/**
+ * Forces the attribute to be invisible
+ *
+ * @see VisibleOption
+ */
+export type NonVisible = {
+    visible: false;
+};
+export type CustomField<TKind extends string, TOptions extends object | undefined = undefined> = {
+    customField: TKind;
+    options?: TOptions;
+};
+/**
+ * Creates a {@link MinMaxOption} configuration object with the given values.
+ *
+ * @template TConfig The min/max configuration
+ * @template TType The type of the values.
+ *
+ * @see MinMaxOption
+ */
+export type SetMinMax<TConfig extends MinMaxOption<TType>, TType = number> = TConfig;
+/**
+ * Creates a {@link MinMaxLengthOption} configuration object with the given values.
+ *
+ * @template TConfig The minLength/maxLength configuration
+ *
+ * @see MinMaxLengthOption
+ */
+export type SetMinMaxLength<TConfig extends MinMaxLengthOption> = TConfig;
+/**
+ * Creates a plugin options' configuration object with the given values.
+ *
+ * @template TConfig The plugin options
+ */
+export type SetPluginOptions<TConfig extends object = object> = {
+    pluginOptions?: TConfig;
+};
+/**
+ * Sets a default value for a {@link DefaultOption}
+ *
+ * @template T
+ *
+ * @see DefaultOption
+ */
+export type DefaultTo<T> = {
+    default: T;
+};
+//# sourceMappingURL=options.d.ts.map

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"}