@strapi/types 5.0.0-beta.3 → 5.0.0-beta.4

package/dist/schema/index.d.ts

@@ -4,12 +4,24 @@ import type { If, Object, Guard } from '../utils';
 import type * as Attribute from './attribute';
 export { Attribute };
 /**
- * The Schemas type represents a combination of both content type and component schemas
+ * Combines both content type and component schemas, effectively serving as a consolidated registry of all schemas.
  *
- * Both are fetched from the public registries.
+ * 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];
@@ -17,18 +29,24 @@ export type Component<TComponentUID extends UID.Component = UID.Component> = Com
  * 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'];
 /**
@@ -59,13 +77,68 @@ export type Attributes<TSchemaUID extends UID.Schema = UID.Schema> = {
  * @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

@@ -1 +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;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,kBAAkB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAE1E,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,kBAAkB,CAAC;AAErD,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;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;AAErF;;;;GAIG;AACH,MAAM,MAAM,IAAI,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAE7E;;;;GAIG;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;AAEH,MAAM,MAAM,cAAc,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,OAAO,CACjE,MAAM,UAAU,CAAC,UAAU,CAAC,EAC5B,MAAM,CACP,CAAC;AAEF,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,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,MAAM,MAAM,4BAA4B,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,oBAAoB,CAC5F,UAAU,EACV,SAAS,CAAC,kBAAkB,CAC7B,CAAC;AAEF,MAAM,MAAM,yBAAyB,CAAC,UAAU,SAAS,GAAG,CAAC,MAAM,IAAI,oBAAoB,CACzF,UAAU,EACV,SAAS,CAAC,eAAe,CAC1B,CAAC;AAEF,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,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,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"}
+{"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/schema.d.ts

@@ -4,141 +4,245 @@ export type ContentTypeKind = 'collectionType' | 'singleType';
 export type ModelType = 'contentType' | 'component';
 export type Schema = ContentTypeSchema | ComponentSchema;
 /**
- * Represents a Strapi Schema once loaded by the server
+ * A loaded instance of a Strapi Schema accessible to the server.
  */
 export interface BaseSchema {
     /**
-     * The unique identifier of the Schema
+     * 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;
     /**
-     * The type of the model. Useful to discriminate content-types from component
+     * 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;
     /**
-     * Unique identifier of the schema
+     * Serves as the public name of the schema. Often utilized in referencing a specific schema (e.g. in the database).
      */
     modelName: string;
     /**
-     * Unique identifier of the schema
+     * This global identifier acts as a unique reference to the schema across varying scopes and contexts.
      */
     globalId: string;
     /**
-     * Options declared and read by the plugins
+     * 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;
     /**
-     * Options object dedicated to Strapi core features
+     * Encapsulates all core options related to Strapi features for a given Schema.
      */
     options?: SchemaOptions;
     /**
-     * Custom table name for the schema
+     * Optional property. Specifies the custom table name for the Schema if any.
      */
     collectionName?: string;
     /**
-     * Information about schema naming and display
+     * Contains information related to naming and display characteristics of the Schema.
      */
     info: SchemaInfo;
     /**
-     * A collection of attributes for a given Schema.
-     *
-     * It is stored as a record, where each attribute is associated with a unique string key.
+     * Houses a comprehensive collection of attributes for this Schema.
      *
-     * The values should be instances of {@link Attribute.AnyAttribute}.
+     * Each attribute has a unique string key and corresponding value should be any Attribute type instance.
      */
     attributes: SchemaAttributes;
 }
 /**
- * Data structure containing naming and display information for a Schema
+ * Comprises naming and display parameters to customize a Schema's representation.
  */
 export interface SchemaInfo {
     /**
-     * Default name to use in the admin panel
+     * 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;
     /**
-     * Description of the model
+     * 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;
     /**
-     * @strapi/icon name to use for the component's icon in the admin panel
+     * 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>;
 /**
- * Structure containing every core schema options and their associated value
+ * 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 {
     /**
-     * EE only.
+     * 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;
 }
 /**
- * Plugins' options for a Schema
+ * 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;
 }
 /**
- * Schema for a content type
+ * 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 of the schema
+     * 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;
     /**
-     * Determine the type of the content type (single-type or collection-type)
+     * Classifies the content type as 'collection-type' or 'single-type'.
      */
     kind: ContentTypeKind;
     /**
-     * Information about schema naming and display
+     * 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;
     /**
-     * Indexes to be created on the database
+     * Optional attribute to indicate the indexes to be created on the database for this content type.
+     *
      * @internal
      */
     indexes?: unknown[];
 }
 /**
- * Represents information about a content type schema.
+ * Contains naming properties specific to a specific content type.
  */
 export interface ContentTypeSchemaInfo extends SchemaInfo {
     /**
-     * Singular form of the content type name
+     * Indicates how a single instance of the content type should be labeled.
      */
     singularName: string;
     /**
-     * Plural form of the collection type name
+     * Provides a human-friendly label for referring to multiple instances of the content type.
      */
     pluralName: string;
 }
 /**
- * Schema for a collection type
+ * 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 for a single type
+ * 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';
 }
 /**
- * Schema for a component
+ * 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

@@ -1 +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;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC;IAEhB;;OAEG;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;;;;;;OAMG;IACH,UAAU,EAAE,gBAAgB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,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;;;OAGG;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,IAAI,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IACzD,IAAI,EAAE,YAAY,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,SAAS,EAAE,WAAW,CAAC;IAEvB,GAAG,EAAE,GAAG,CAAC,SAAS,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;CAClB"}
+{"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"}

package/dist/uid/index.d.ts

@@ -3,41 +3,166 @@ import type * as Struct from '../struct';
 import type { Constants, Guard, Object, Extends, Or } from '../utils';
 import type * as Public from '../public';
 /**
- * Schemas' UIDs based on the public schema registries.
+ * Combines ContentType and Component UID types in a single union type.
  *
- * It includes both ContentTypeSchemas and ComponentSchemas
+ * `UID.Schema` provides the ability to deal with both content types and components through one streamlined type.
+ *
+ * It hinges on underlying schema registries, which aggregates and maps unique identifiers to their respective schemas.
+ *
+ * This type would typically be used where the context is not particular about dealing with content types or components exclusively but rather any kind of schema.
+ *
+ * @example
+ * Let's assume we need a function that processes schema irrespective of whether it's ContenType or Component.
+ *
+ * ```typescript
+ * import type { UID } from '@strapi/types';
+ *
+ * function processSchema(schemaID: UID.Schema) {
+ *     // Implementation goes here...
+ * }
+ *
+ * // Now, calling processSchema() with uid of content type
+ * processSchema('api::foo.foo');
+ *
+ * // And calling processSchema() with uid of component
+ * processSchema('default.foo');
+ * ```
+ *
+ * @see {@link ContentType} Identifier for content types based on the public registry.
+ * @see {@link Component} Identifier for components based on the public registry.
  */
 export type Schema = ContentType | Component;
 /**
- * Content-Types' UIDs based on the public content-type registry.
+ * Unique identifiers for any content-type defined in the public content-type registry.
+ *
+ * Useful when it's required to work with data structures that can only be identified by the underlying content-type UID.
+ *
+ * When no content-types are declared in the registry, it uses the generic {@link Internal.UID.ContentType} instead.
+ *
+ * @example
+ * Here's an example of how to use the `UID.ContentType` type:
+ *
+ * ```typescript
+ * import type { UID } from '@strapi/types';
+ *
+ * // Assume we have a function that requires a ContentType UID
+ * function fetchSchema(uid: UID.ContentType) {
+ *   // Implementation goes here...
+ * }
+ *
+ * // Now you can pass the unique identifier for a content type to fetch its schema
+ * fetchSchema('api::foo.foo');
+ * ```
+ * @see {@link Public.ContentTypeSchemas} Content-type public registry.
+ * @see {@link UID.ContentType} ContentType UID format definition.
  */
 export type ContentType = Internal.Registry.Keys<Public.ContentTypeSchemas, Internal.UID.ContentType>;
 /**
- * Components' UIDs based on the public component registry.
+ * Unique identifiers for any component defined in the public component registry.
+ *
+ * Useful when it's required to work with data structures that can only be identified by the underlying component UID.
+ *
+ * When no component are declared in the registry, it uses the generic {@link Internal.UID.Component} instead.
+ *
+ * @example
+ * Here's an example of how to use the `UID.Component` type:
+ *
+ * ```typescript
+ * import type { UID } from '@strapi/types';
+ *
+ * // Assume we have a function that requires a Component UID
+ * function fetchSchema(uid: UID.Component) {
+ *   // Implementation goes here...
+ * }
+ *
+ * // Now you can pass the unique identifier for a component to fetch its schema
+ * fetchSchema('default.foo');
+ * ```
+ * @see {@link Public.ComponentSchemas} Component public registry.
+ * @see {@link UID.Component} Component UID format definition.
  */
 export type Component = Internal.Registry.Keys<Public.ComponentSchemas, Internal.UID.Component>;
 /**
- * Union of every components' category, based on the public component registry
+ * Obtains a union of every component's category from the public component registry.
+ *
+ * It utilizes [conditional types inference](https://www.typescriptlang.org/docs/handbook/2/conditional-types.html#inferring-within-conditional-types) to extract the category name from the components' UID.
+ *
+ * The component UID format is a string that follows a specific pattern defined by {@link Internal.UID.Component}.
+ * If a type extends `Internal.UID.Component`, it implies that it has a structure with `TCategory` string as the category name of the component.
+ *
+ * @see {@link Internal.UID.Component} for more details on how the component's unique identifier is structured.
  */
 export type ComponentCategory = Component extends Internal.UID.Component<infer TCategory> ? TCategory : never;
 /**
- * Collection-Types' UIDs based on the public content-type registry.
+ * Collection-Type UID based on the public content-type registry
  *
- * If no collection type is found, fallback to a generic content-type UID.
+ * If no collection type is found, it fallbacks to a generic content-type UID.
  */
 export type CollectionType = Guard.Never<Extract<Object.KeysBy<Public.ContentTypeSchemas, Struct.CollectionTypeSchema>, ContentType>, Internal.UID.ContentType>;
 /**
- * Single-Type's UIDs based on the public content-type registry
+ * Single-Type UID based on the public content-type registry
  *
- * If no collection type is found, fallback to a generic content-type UID.
+ * If no single type is found, it falls back to a generic content-type UID.
  */
 export type SingleType = Guard.Never<Extract<Object.KeysBy<Public.ContentTypeSchemas, Struct.SingleTypeSchema>, ContentType>, Internal.UID.ContentType>;
+/**
+ * Service UID based on the public service registry
+ *
+ * @see {Public.Services}
+ */
 export type Service = Internal.Registry.Keys<Public.Services, Internal.UID.Service>;
+/**
+ * Controller UID based on the public service registry
+ *
+ * @see {Public.Controllers}
+ */
 export type Controller = Internal.Registry.Keys<Public.Controllers, Internal.UID.Controller>;
+/**
+ * Policy UID based on the public service registry
+ *
+ * @see {Public.Policies}
+ */
 export type Policy = Internal.Registry.Keys<Public.Policies, Internal.UID.Policy>;
+/**
+ * Middleware UID based on the public service registry
+ *
+ * @see {Public.Middlewares}
+ */
 export type Middleware = Internal.Registry.Keys<Public.Middlewares, Internal.UID.Middleware>;
+/**
+ * Verifies if a certain schema UIDs correspond to a collection type.
+ *
+ * Given a schema UID, it checks if it matches the {@link CollectionType} UID type. Since {@link CollectionType}
+ * can resolve to the more generic {@link ContentType} type, we also need to check that the associated
+ * schema extends the {@link Struct.CollectionTypeSchema} data structure.
+ *
+ * @template TSchemaUID - The UID of the schema
+ */
 export type IsCollectionType<TSchemaUID extends Schema> = TSchemaUID extends CollectionType ? Extends<Public.ContentTypeSchemas[TSchemaUID], Struct.CollectionTypeSchema> : Constants.False;
+/**
+ * Verifies if a certain schema UIDs correspond to a single type.
+ *
+ * Given a schema UID, it checks if it matches the {@link SingleType} UID type. Since {@link SingleType}
+ * can resolve to the more generic {@link ContentType} type, we also need to check that the associated
+ * schema extends the {@link Struct.CollectionTypeSchema} data structure.
+ *
+ * @template TSchemaUID - The UID of the schema
+ */
 export type IsSingleType<TSchemaUID extends Schema> = TSchemaUID extends SingleType ? Extends<Public.ContentTypeSchemas[TSchemaUID], Struct.SingleTypeSchema> : Constants.False;
+/**
+ * Verifies if a certain schema UIDs correspond to a component.
+ *
+ * Given a schema UID, it checks if it matches the {@link Component} UID type.
+ *
+ * @template TSchemaUID - The UID of the schema
+ */
 export type IsComponent<TSchemaUID extends Schema> = TSchemaUID extends Component ? Extends<Public.ComponentSchemas[TSchemaUID], Struct.ComponentSchema> : Constants.False;
+/**
+ * Verifies if a certain schema UIDs correspond to a content-type.
+ *
+ * Given a schema UID, it checks if it matches the {@link ContentType} UID type.
+ *
+ * @template TSchemaUID - The UID of the schema
+ */
 export type IsContentType<TSchemaUID extends Schema> = TSchemaUID extends ContentType ? Or<IsCollectionType<TSchemaUID>, IsSingleType<TSchemaUID>> : Constants.False;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/uid/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,QAAQ,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,KAAK,MAAM,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AACtE,OAAO,KAAK,KAAK,MAAM,MAAM,WAAW,CAAC;AAEzC;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAC9C,MAAM,CAAC,kBAAkB,EACzB,QAAQ,CAAC,GAAG,CAAC,WAAW,CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAEhG;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAC3B,SAAS,SAAS,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,SAAS,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CACtC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,oBAAoB,CAAC,EAAE,WAAW,CAAC,EAC3F,QAAQ,CAAC,GAAG,CAAC,WAAW,CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAClC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,gBAAgB,CAAC,EAAE,WAAW,CAAC,EACvF,QAAQ,CAAC,GAAG,CAAC,WAAW,CACzB,CAAC;AAEF,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAEpF,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAE7F,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAElF,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAG7F,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,MAAM,IAAI,UAAU,SAAS,cAAc,GACvF,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC,GAC3E,SAAS,CAAC,KAAK,CAAC;AAEpB,MAAM,MAAM,YAAY,CAAC,UAAU,SAAS,MAAM,IAAI,UAAU,SAAS,UAAU,GAC/E,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,gBAAgB,CAAC,GACvE,SAAS,CAAC,KAAK,CAAC;AAEpB,MAAM,MAAM,WAAW,CAAC,UAAU,SAAS,MAAM,IAAI,UAAU,SAAS,SAAS,GAC7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,GACpE,SAAS,CAAC,KAAK,CAAC;AAEpB,MAAM,MAAM,aAAa,CAAC,UAAU,SAAS,MAAM,IAAI,UAAU,SAAS,WAAW,GACjF,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,GAC1D,SAAS,CAAC,KAAK,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/uid/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,QAAQ,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,KAAK,MAAM,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AACtE,OAAO,KAAK,KAAK,MAAM,MAAM,WAAW,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;AAE7C;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAC9C,MAAM,CAAC,kBAAkB,EACzB,QAAQ,CAAC,GAAG,CAAC,WAAW,CACzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAEhG;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,GAC3B,SAAS,SAAS,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,SAAS,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC;AAEhF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CACtC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,oBAAoB,CAAC,EAAE,WAAW,CAAC,EAC3F,QAAQ,CAAC,GAAG,CAAC,WAAW,CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAClC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE,MAAM,CAAC,gBAAgB,CAAC,EAAE,WAAW,CAAC,EACvF,QAAQ,CAAC,GAAG,CAAC,WAAW,CACzB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAEpF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAE7F;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;AAElF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAE7F;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,MAAM,IAAI,UAAU,SAAS,cAAc,GACvF,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC,GAC3E,SAAS,CAAC,KAAK,CAAC;AAEpB;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,CAAC,UAAU,SAAS,MAAM,IAAI,UAAU,SAAS,UAAU,GAC/E,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,gBAAgB,CAAC,GACvE,SAAS,CAAC,KAAK,CAAC;AAEpB;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,CAAC,UAAU,SAAS,MAAM,IAAI,UAAU,SAAS,SAAS,GAC7E,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,GACpE,SAAS,CAAC,KAAK,CAAC;AAEpB;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,CAAC,UAAU,SAAS,MAAM,IAAI,UAAU,SAAS,WAAW,GACjF,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,GAC1D,SAAS,CAAC,KAAK,CAAC"}