nextpress-core 1.0.1 → 1.0.3

package/dist/acf-functions/core/acf-builder.d.ts

@@ -1,3 +1,4 @@
+import { ACFFieldGroup, NextpressFieldGroup } from "../types/acf-field-group";
 /**
  * Class representing ACF builder.
  */

package/dist/acf-functions/core/acf-field-group-autoloader.d.ts

@@ -1,3 +1,4 @@
+import { NextpressFieldGroup } from '../types/acf-field-group';
 /**
  * Autoloads ACF field groups dynamically from the field-groups directory.
  * * **Requirements for it to work:**

package/dist/acf-functions/field-props.d.ts

@@ -0,0 +1,196 @@
+import { IPost } from "@/entities/post/post.interface";
+import { ITerm } from "@/entities/term/term.interface";
+import { IUser } from "@/entities/user/user.interface";
+import { JSX } from "react";
+type GetFields<T> = T extends {
+    fields: readonly any[];
+} ? T['fields'] : T extends {
+    sub_fields: readonly any[];
+} ? T['sub_fields'] : never;
+/**
+ * Represents the properties passed to a Nextpress ACF component.
+ *
+ * @template T - The expected type of the mapped ACF fields.
+ */
+export type FieldProps<LayoutT> = LayoutT extends {
+    fields: readonly any[];
+} | {
+    sub_fields: readonly any[];
+} ? ResolvedFields<GetFields<LayoutT>> : never;
+/**
+ * An array of ACF field configurations to a strongly-typed object representing the resolved data structure.
+ * It iterates over the array, using the `name` property of each field as the object key, and determines the expected value type using the `MapFieldType` utility.
+ *
+ * @template Fields - A readonly array of ACF field configuration objects.
+ */
+type ResolvedFields<Fields extends readonly any[]> = {
+    [F in Fields[number] as F['name']]: MapFieldType<F>;
+};
+/**
+ * Maps an array of ACF Flexible Content layouts to a union type representing the resolved layout blocks.
+ * For each layout, it checks for the presence of `fields` or `sub_fields`, and resolves to a specific object
+ * structure containing the layout's React component and its deeply resolved field content.
+ *
+ * @template Layouts - A readonly array of ACF Flexible Content layout configuration objects.
+ */
+type ResolvedFlexibleContent<Layouts extends readonly any[]> = {
+    [L in Layouts[number] as L['name']]: L extends {
+        name: infer Name;
+    } & ({
+        fields: readonly any[];
+    } | {
+        sub_fields: readonly any[];
+    }) ? {
+        Component: () => Promise<JSX.Element>;
+        content: ResolvedFields<GetFields<L>>;
+    }[] : never;
+}[Layouts[number]['name']];
+type MapFieldType<Field> = Field extends {
+    type: 'color_picker';
+} ? string | null : Field extends {
+    type: 'date_picker';
+} ? string | null : Field extends {
+    type: 'date_time_picker';
+} ? string | null : Field extends {
+    type: 'google_map';
+} ? ACFGoogleMapsObject | null : Field extends {
+    type: 'icon_picker';
+} ? Field extends {
+    return_format: 'string';
+} ? string | null : Field extends {
+    return_format: 'array';
+} ? ACFIconObject | null : ACFIconObject | null : Field extends {
+    type: 'time_picker';
+} ? string | null : Field extends {
+    type: 'email';
+} ? string | null : Field extends {
+    type: 'number';
+} ? number | null : Field extends {
+    type: 'password';
+} ? string | null : Field extends {
+    type: 'range';
+} ? number | null : Field extends {
+    type: 'text';
+} ? string | null : Field extends {
+    type: 'textarea';
+} ? string | null : Field extends {
+    type: 'button_group';
+} ? Field extends {
+    return_format: 'array';
+} ? ACFChoiceObject | null : string | null : Field extends {
+    type: 'checkbox';
+} ? Field extends {
+    return_format: 'array';
+} ? ACFChoiceObject[] : string[] : Field extends {
+    type: 'radio';
+} ? Field extends {
+    return_format: 'array';
+} ? ACFChoiceObject | null : string | null : Field extends {
+    type: 'select';
+} ? Field extends {
+    multiple: 1;
+} ? Field extends {
+    return_format: 'array';
+} ? ACFChoiceObject[] : string[] : Field extends {
+    return_format: 'array';
+} ? ACFChoiceObject | null : string | null : Field extends {
+    type: 'true_false';
+} ? boolean : Field extends {
+    type: 'file';
+} ? number | null : Field extends {
+    type: 'gallery';
+} ? number[] : Field extends {
+    type: 'image';
+} ? number | null : Field extends {
+    type: 'oembed';
+} ? string | null : Field extends {
+    type: 'wysiwyg';
+} ? string | null : Field extends {
+    type: 'link';
+} ? Field extends {
+    return_format: 'url';
+} ? string | null : Field extends {
+    return_format: 'array';
+} ? ACFLinkObject | null : ACFLinkObject : Field extends {
+    type: 'page_link';
+} ? Field extends {
+    multiple: 1;
+} ? string[] : string | null : Field extends {
+    type: 'post_object';
+} ? Field extends {
+    multiple: 1;
+} ? Field extends {
+    return_format: 'object';
+} ? IPost[] : number[] : Field extends {
+    return_format: 'object';
+} ? IPost | null : number | null : Field extends {
+    type: 'relationship';
+} ? Field extends {
+    return_format: 'object';
+} ? IPost[] | null : number[] | null : Field extends {
+    type: 'taxonomy';
+} ? Field extends {
+    multiple: 1;
+} ? Field extends {
+    return_format: 'object';
+} ? ITerm[] : number[] : Field extends {
+    return_format: 'object';
+} ? ITerm | null : number | null : Field extends {
+    type: 'user';
+} ? Field extends {
+    multiple: 1;
+} ? Field extends {
+    return_format: 'object';
+} ? IUser[] : number[] : Field extends {
+    return_format: 'object';
+} ? IUser | null : number | null : Field extends {
+    type: 'group';
+} & ({
+    fields: readonly any[];
+} | {
+    sub_fields: readonly any[];
+}) ? ResolvedFields<GetFields<Field>> | null : Field extends {
+    type: 'repeater';
+} & ({
+    fields: readonly any[];
+} | {
+    sub_fields: readonly any[];
+}) ? ResolvedFields<GetFields<Field>>[] | null : Field extends {
+    type: 'flexible_content';
+    layouts: readonly any[];
+} ? ResolvedFlexibleContent<Field['layouts']> | null : Field extends {
+    fields: readonly any[];
+} | {
+    sub_fields: readonly any[];
+} ? ResolvedFields<GetFields<Field>> : never;
+type ACFIconObject = {
+    type: string;
+    value: string;
+};
+type ACFLinkObject = {
+    title: string;
+    url: string;
+    target: string;
+};
+type ACFChoiceObject = {
+    label?: string;
+    value?: string;
+};
+type ACFGoogleMapsObject = {
+    address: string;
+    lat: string | number;
+    lng: string | number;
+    zoom: string | number;
+    place_id: string;
+    name: string;
+    street_number: string | number;
+    street_name: string;
+    street_name_short: string;
+    city: string;
+    state: string;
+    state_short: string;
+    post_code: string | number;
+    country: string;
+    country_short: string;
+};
+export {};

package/dist/acf-functions/field-props.js

@@ -0,0 +1 @@
+export {};

package/dist/acf-functions/services/define-field-group.d.ts

@@ -1,3 +1,4 @@
+import { NextpressFieldGroup } from "../types/acf-field-group";
 /**
  * Defines field group configuration and applies typing.
  *

package/dist/acf-functions/services/define-layout.d.ts

@@ -1,3 +1,4 @@
+import { NextpressLayout } from "../types/acf-layout";
 /**
  * Defines layout configuration and applies typing.
  *

package/dist/acf-functions/services/map-fields/helpers/map-choice-object.d.ts

@@ -1,2 +1,2 @@
 import { ACFChoiceObject } from "@/acf-functions/types/components/field-props";
-export declare function mapChoiceObject(return_format: 'array' | 'label' | 'value', value?: string, choices?: Choices): ACFChoiceObject | string | undefined;
+export declare function mapChoiceObject(return_format: 'array' | 'label' | 'value', value?: string, choices?: any): ACFChoiceObject | string | undefined;

package/dist/acf-functions/services/map-fields/map-fields.d.ts

@@ -1,3 +1,6 @@
+import { NextpressField } from "@/acf-functions/types/acf-field";
+import { NextpressLayout } from "@/acf-functions/types/acf-layout";
+import { ACFRawValues } from "@/acf-functions/types/acf-values";
 /**
  * Maps individual ACF field to corresponding value.
  *

package/dist/acf-functions/types/acf-field-group.d.ts

@@ -0,0 +1,99 @@
+import { NextpressField, ACFField } from "./acf-field";
+type TransformACFFieldGroup<T> = T extends any ? Omit<T, 'key' | 'fields'> & ('fields' extends keyof T ? {
+    fields: NextpressField[];
+} : []) : never;
+/** ACF Field Group without key constraints to allow key generation */
+export type NextpressFieldGroup = TransformACFFieldGroup<ACFFieldGroup>;
+/**
+ * Represents an Advanced Custom Fields (ACF) Field Group configuration.
+ */
+export interface ACFFieldGroup {
+    /**
+     * Unique identifier for the field group with group_ prefix (e.g. 'group_abc123')
+     */
+    key: string;
+    /**
+     * The title/name of this entity
+     */
+    title: string;
+    /**
+     * Array of field definitions. If empty array, field group appears but contains no fields.
+     */
+    fields: ACFField[];
+    /**
+     * The order of this entity in the admin menu
+     */
+    menu_order?: number;
+    /**
+     * [ACF] Whether this entity is active
+     */
+    active?: boolean;
+    /**
+     * [ACF Export Only] Unix timestamp of last modification
+     */
+    modified?: number;
+    /**
+     * Location rules determining where this field group appears. Array of rule groups (OR logic between groups, AND logic within groups). If omitted or empty, field group won't appear on any edit screens.
+     */
+    location?: ACFLocationGroup[];
+    /**
+     * Position of the field group on the edit screen
+     */
+    position?: "normal" | "side" | "acf_after_title";
+    /**
+     * Visual style of the field group metabox
+     */
+    style?: "default" | "seamless";
+    /**
+     * Placement of field labels relative to fields
+     */
+    label_placement?: "top" | "left";
+    /**
+     * Placement of field instructions
+     */
+    instruction_placement?: "label" | "field";
+    /**
+     * Screen elements to hide when this field group is displayed
+     */
+    hide_on_screen?: ("permalink" | "the_content" | "excerpt" | "custom_fields" | "discussion" | "comments" | "revisions" | "slug" | "author" | "format" | "page_attributes" | "featured_image" | "categories" | "tags" | "send-trackbacks")[];
+    /**
+     * Description of the field group
+     */
+    description?: string;
+    /**
+     * Whether to expose this field group's fields in the REST API
+     */
+    show_in_rest?: boolean | number;
+    /**
+     * Whether to expose this field group to AI integrations
+     */
+    allow_ai_access?: boolean | number;
+    /**
+     * Description that helps AI integrations understand how to use this field group
+     */
+    ai_description?: string;
+    /**
+     * Alternative display title for the field group
+     */
+    display_title?: string;
+}
+/**
+ * Group of location rules (AND logic within group)
+ */
+export type ACFLocationGroup = [ACFLocationRule, ...ACFLocationRule[]];
+export interface ACFLocationRule {
+    /**
+     * The parameter to compare (e.g. 'post_type', 'page_template', 'user_role')
+     */
+    param: string;
+    /**
+     * Comparison operator
+     */
+    operator: "==" | "!=";
+    /**
+     * Value to compare against
+     */
+    value: string;
+    [k: string]: unknown;
+}
+export {};

package/dist/acf-functions/types/acf-field-group.js

@@ -0,0 +1 @@
+export {};