@akbarsafari00/bonyan-types 5.52.1-fa.4

package/dist/struct/schema.d.ts

@@ -0,0 +1,286 @@
+import type { Attribute } from '../schema';
+import type * as UID from '../uid';
+export type ContentTypeKind = 'collectionType' | 'singleType';
+export type ModelType = 'contentType' | 'component';
+export type Schema = CollectionTypeSchema | SingleTypeSchema | 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;
+    /**
+     * What plugin this schema belongs to if any
+     */
+    plugin?: 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;
+}
+/**
+ * Metadata for an image uploaded through the admin upload provider (same shape as admin logos).
+ */
+export interface PreviewImage {
+    url: string;
+    hash?: string;
+    provider?: string;
+    width?: number;
+    height?: number;
+    ext?: string;
+    size?: number;
+    name?: string;
+}
+/**
+ * Admin preview image reference: a git-portable static path/CDN URL, or an uploaded descriptor.
+ */
+export type PreviewImageValue = string | PreviewImage;
+/**
+ * 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;
+    /**
+     * Optional preview image for admin UI surfaces (e.g. the dynamic zone component picker).
+     *
+     * - **String** — root-relative path or absolute CDN URL. Git-portable when the file is
+     *   committed with the app (e.g. `/_component-screenshots/hero.png`) or hosted externally.
+     * - **`PreviewImage`** — descriptor from a CTB upload; bytes live on the upload provider
+     *   (same metadata shape as admin logos). CTB upload UI is not implemented yet.
+     *
+     * When omitted, the picker falls back to the `icon`.
+     */
+    preview?: PreviewImageValue;
+}
+/**
+ * `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[];
+    /**
+     * Optional attribute to indicate the foreignKeys to be created on the database for this content type.
+     *
+     * @internal
+     */
+    foreignKeys?: 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,oBAAoB,GAAG,gBAAgB,GAAG,eAAe,CAAC;AAE/E;;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,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;OAIG;IACH,UAAU,EAAE,gBAAgB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,YAAY,CAAC;AAEtD;;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;IAEd;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B;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;IAEpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,EAAE,CAAC;CACzB;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

@@ -0,0 +1,168 @@
+import type * as Internal from '../internal';
+import type * as Struct from '../struct';
+import type { Constants, Guard, Object, Extends, Or } from '../utils';
+import type * as Public from '../public';
+/**
+ * Combines ContentType and Component UID types in a single union type.
+ *
+ * `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;
+/**
+ * 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>;
+/**
+ * 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>;
+/**
+ * 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-Type UID based on the public content-type registry
+ *
+ * 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 UID based on the public content-type registry
+ *
+ * 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

@@ -0,0 +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;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}

package/dist/utils/array.d.ts

@@ -0,0 +1,80 @@
+import type { Extends, Not } from '.';
+/**
+ * The `Values` type extracts the type of the values stored in arrays or tuples.
+ *
+ * @returns A union of every value contained in the array/tuple
+ *
+ * @template TCollection - The array-like structure from which the values' type will be extracted.
+ *
+ * @example
+ * Let's suppose we have an array of numbers, and we would like to extract the type its values
+ *
+ * ```typescript
+ * type MyTuple = [1, 2, 3, 4];
+ *
+ * type TupleValues = Values<MyTuple>; // TupleValues: 1 | 2 | 3 | 4
+ * ```
+ *
+ * @example
+ * Now, let's suppose we have a regular TypeScript array, and we would like to extract its value
+ *
+ * ```typescript
+ * type MyArray = (string | number)[];
+ *
+ * type ArrayValues = Values<MyArray>; // ArrayValues: string | number
+ * ```
+ */
+export type Values<TCollection extends Array<unknown>> = TCollection extends Array<infer TValues> ? TValues : never;
+/**
+ * Checks if a given array ({@link TCollection}) is empty.
+ *
+ * @template TCollection - The array to be checked. It should extend 'Array<unknown>'.
+ *
+ * @example
+ * Validate an array that is empty:
+ * ```typescript
+ * type EmptyArray = [];
+ *
+ * type IsEmptyCheck = IsEmpty<EmptyArray>;
+ * // Result: Constants.True
+ * ```
+ *
+ * @example
+ * Validate an array that is not empty:
+ * ```typescript
+ * type NonEmptyArray = [1, 2, 3];
+ *
+ * type IsEmptyCheck = IsEmpty<NonEmptyArray>;
+ * // Result: Constants.False
+ * ```
+ */
+export type IsEmpty<TCollection extends Array<unknown>> = Extends<TCollection['length'], 0>;
+/**
+ * Checks if a given array ({@link TCollection}) is not empty.
+ *
+ * @template TCollection - The collection (array) that needs to be checked if it's not empty. It must extend 'Array<unknown>'.
+ *
+ * @see {@link Not}
+ * @see {@link IsEmpty}
+ *
+ * @example
+ * Checking non-empty array:
+ * ```typescript
+ * type NonEmptyArray = [1, 2, 3];
+ *
+ * // This type checks will result to True because
+ * // 'NonEmptyArray' is indeed not empty.
+ * type IsNotEmptyCheck = IsNotEmpty<NonEmptyArray>;
+ * ```
+ *
+ * @example
+ * Checking empty array:
+ * ```typescript
+ * type EmptyArray = [];
+ *
+ * // This type checks will result to False because 'EmptyArray' is empty.
+ * type IsNotEmptyCheck = IsNotEmpty<EmptyArray>;
+ * ```
+ */
+export type IsNotEmpty<TCollection extends Array<unknown>> = Not<IsEmpty<TCollection>>;
+//# sourceMappingURL=array.d.ts.map

package/dist/utils/array.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../src/utils/array.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC;AAEtC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,MAAM,CAAC,WAAW,SAAS,KAAK,CAAC,OAAO,CAAC,IACnD,WAAW,SAAS,KAAK,CAAC,MAAM,OAAO,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC;AAE7D;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,OAAO,CAAC,WAAW,SAAS,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,MAAM,UAAU,CAAC,WAAW,SAAS,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC"}

package/dist/utils/constants.d.ts

@@ -0,0 +1,67 @@
+import type * as Internal from '../internal';
+import type * as UID from '../uid';
+import type { NotStrictEqual, Or } from '.';
+export type True = true;
+export type False = false;
+export type BooleanValue = True | False;
+/**
+ * Determine if there's been an extension or change in either Component Registry or Content-Type Registry.
+ *
+ * It applies the compound boolean OR operation on the results derived from {@link IsComponentRegistryExtended} and {@link IsContentTypeRegistryExtended}.
+ *
+ * If either or both results are true (indicating a change or extension in the corresponding registry), it returns {@link True}; otherwise, it returns {@link False}.
+ *
+ * @example
+ * ```typescript
+ * // A change or extension in both the Component Registry and the Content-Type Registry
+ * type Example1 = AreSchemaRegistriesExtended; // Result: Constants.True
+ *
+ * // A change or extension only in the Component Registry
+ * type Example2 = IsComponentRegistryExtended; // Result: Constants.True
+ *
+ * // A change or extension only in the Content-Type Registry
+ * type Example3 = IsContentTypeRegistryExtended; // Result: Constants.True
+
+ * // No change or extension in either registries
+ * type Example4 = AreSchemaRegistriesExtended; // Result: Constants.False
+ * ```
+ *
+ * @see IsComponentRegistryExtended
+ * @see IsContentTypeRegistryExtended
+ */
+export type AreSchemaRegistriesExtended = Or<IsComponentRegistryExtended, IsContentTypeRegistryExtended>;
+/**
+ * Evaluate if the internal UIDs ({@link Internal.UID.ContentType}) and public ones ({@link UID.ContentType}) are not identical.
+ *
+ * If these two types are not the same, it indicates an extension or change has occurred in the public Content-Type Registry.
+ *
+ * The type leverages {@link NotStrictEqual} to perform this comparison accurately. The result is a type-level
+ * boolean that denotes whether there is a deviation between the two Content-Type representations.
+ *
+ * @returns Either [Constants.True](@link Constants.True) if the Content-Type Registry has been extended, else [Constants.False](@link Constants.False).
+ *
+ * @remark
+ * This type is particularly useful when there is a need to verify whether there have been extensions or changes to the Content-Type Registry
+ * after initially creating it.
+ *
+ * It allows developers to perform this check at the type level and decide what type should be resolved depending on the context
+ */
+export type IsContentTypeRegistryExtended = NotStrictEqual<Internal.UID.ContentType, UID.ContentType>;
+/**
+ * Evaluate if the internal UIDs ({@link Internal.UID.Component}) and public ones ({@link UID.Component}) are not identical.
+ *
+ * If these two types are not the same, it indicates an extension or change has occurred in the public Component Registry.
+ *
+ * The type leverages {@link NotStrictEqual} to perform this comparison accurately. The result is a type-level
+ * boolean that denotes whether there is a deviation between the two Content-Type representations.
+ *
+ * @return - Either {@link True} if the Component Registry has been extended, else {@link False}.
+ *
+ * @remark
+ * This type is particularly useful when there is a need to verify whether there have been extensions or changes to the Component Registry
+ * after initially creating it.
+ *
+ * It allows developers to perform this check at the type level and decide what type should be resolved depending on the context
+ */
+export type IsComponentRegistryExtended = NotStrictEqual<Internal.UID.Component, UID.Component>;
+//# sourceMappingURL=constants.d.ts.map

package/dist/utils/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/utils/constants.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,QAAQ,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,KAAK,GAAG,MAAM,QAAQ,CAAC;AAEnC,OAAO,KAAK,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,GAAG,CAAC;AAE5C,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC;AAExB,MAAM,MAAM,KAAK,GAAG,KAAK,CAAC;AAE1B,MAAM,MAAM,YAAY,GAAG,IAAI,GAAG,KAAK,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,2BAA2B,GAAG,EAAE,CAC1C,2BAA2B,EAC3B,6BAA6B,CAC9B,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,6BAA6B,GAAG,cAAc,CACxD,QAAQ,CAAC,GAAG,CAAC,WAAW,EACxB,GAAG,CAAC,WAAW,CAChB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,2BAA2B,GAAG,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC"}