nextpress-core 1.0.0 → 1.0.2

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

@@ -0,0 +1,50 @@
+/**
+ * Class representing ACF builder.
+ */
+export declare class ACFBuilder {
+    /** Array of ACF field groups. */
+    private fieldGroups;
+    constructor();
+    /**
+     * Gets built field groups.
+     *
+     * @returns {ACFFieldGroup[]} Array of field groups.
+     */
+    getFieldGroups(): ACFFieldGroup[];
+    /**
+     * Converts field groups to JSON string.
+     *
+     * @returns {string} JSON string representation of field groups.
+     */
+    toJSON(): string;
+    /**
+     * Registers and processes Nextpress field groups.
+     *
+     * @param {NextpressFieldGroup[]} fieldGroups - Array of field groups to register.
+     * @returns {this} Current instance.
+     */
+    registerFieldGroups(fieldGroups: NextpressFieldGroup[]): this;
+    /**
+     * Sets keys for fields based on parent name.
+     *
+     * @param {NextpressField[]} fields - Array of fields to process.
+     * @param {string} parentName - Parent string name.
+     * @returns {ACFField[]} Array of fields with generated keys.
+     */
+    private setFieldKeys;
+    /**
+     * Sets keys for layouts based on parent name.
+     *
+     * @param {NextpressLayout[]} layouts - Array of layouts to process.
+     * @param {string} parentName - Parent string name.
+     * @returns {ACFLayout[]} Array of layouts with generated keys.
+     */
+    private setLayoutKeys;
+    /**
+     * Formats suffix string.
+     *
+     * @param {string} suffix - Suffix to format.
+     * @returns {string} Formatted string.
+     */
+    private formatKeySuffix;
+}

package/{lib/acf-functions/core/acf-builder.ts → dist/acf-functions/core/acf-builder.js}

@@ -1,49 +1,39 @@
 /**
  * Class representing ACF builder.
  */
-export class ACFBuilder
-{
-    /** Array of ACF field groups. */
-    private fieldGroups: ACFFieldGroup[] = [];
-
-    public constructor() {};
-
+export class ACFBuilder {
+    constructor() {
+        /** Array of ACF field groups. */
+        this.fieldGroups = [];
+    }
+    ;
     /**
      * Gets built field groups.
      *
      * @returns {ACFFieldGroup[]} Array of field groups.
      */
-    public getFieldGroups(): ACFFieldGroup[] {
+    getFieldGroups() {
         return this.fieldGroups;
     }
-
     /**
      * Converts field groups to JSON string.
      *
      * @returns {string} JSON string representation of field groups.
      */
-    public toJSON(): string {
+    toJSON() {
         return JSON.stringify(this.fieldGroups);
     }
-
     /**
      * Registers and processes Nextpress field groups.
      *
      * @param {NextpressFieldGroup[]} fieldGroups - Array of field groups to register.
      * @returns {this} Current instance.
      */
-    public registerFieldGroups(fieldGroups: NextpressFieldGroup[]): this {
-        const keyedFieldGroups: ACFFieldGroup[] = fieldGroups.map(fieldGroup => ({
-            ...fieldGroup,
-            key: `group_${this.formatKeySuffix(fieldGroup.title)}`,
-            fields: this.setFieldKeys(fieldGroup.fields, fieldGroup.title),
-        }));
-
+    registerFieldGroups(fieldGroups) {
+        const keyedFieldGroups = fieldGroups.map(fieldGroup => (Object.assign(Object.assign({}, fieldGroup), { key: `group_${this.formatKeySuffix(fieldGroup.title)}`, fields: this.setFieldKeys(fieldGroup.fields, fieldGroup.title) })));
         this.fieldGroups = [...this.fieldGroups, ...keyedFieldGroups];
-
         return this;
     }
-
     /**
      * Sets keys for fields based on parent name.
      *
@@ -51,26 +41,18 @@ export class ACFBuilder
      * @param {string} parentName - Parent string name.
      * @returns {ACFField[]} Array of fields with generated keys.
      */
-    private setFieldKeys(fields: NextpressField[], parentName: string): ACFField[] {
+    setFieldKeys(fields, parentName) {
         return fields.map(field => {
             const keySuffix = this.formatKeySuffix(`${parentName}_${field.name}`);
-
             const childFields = field.sub_fields
                 ? this.setFieldKeys(field.sub_fields, keySuffix)
                 : undefined;
-
             const childLayouts = field.layouts
                 ? this.setLayoutKeys(field.layouts, keySuffix)
                 : undefined;
-
-            return {
-                ...field,
-                key: `field_${keySuffix}`,
-                sub_fields: childFields,
-                layouts: childLayouts
-            }});
+            return Object.assign(Object.assign({}, field), { key: `field_${keySuffix}`, sub_fields: childFields, layouts: childLayouts });
+        });
     }
-
     /**
      * Sets keys for layouts based on parent name.
      *
@@ -78,28 +60,22 @@ export class ACFBuilder
      * @param {string} parentName - Parent string name.
      * @returns {ACFLayout[]} Array of layouts with generated keys.
      */
-    private setLayoutKeys(layouts: NextpressLayout[], parentName: string): ACFLayout[] {
+    setLayoutKeys(layouts, parentName) {
         return layouts.map(layout => {
             const keySuffix = this.formatKeySuffix(`${parentName}_${layout.name}`);
-
             const childFields = layout.sub_fields
                 ? this.setFieldKeys(layout.sub_fields, `${parentName}_${layout.name}`)
                 : undefined;
-
-            return {
-                ...layout,
-                key: `layout_${keySuffix}`,
-                sub_fields: childFields || [],
-        }})
+            return Object.assign(Object.assign({}, layout), { key: `layout_${keySuffix}`, sub_fields: childFields || [] });
+        });
     }
-
     /**
      * Formats suffix string.
      *
      * @param {string} suffix - Suffix to format.
      * @returns {string} Formatted string.
      */
-    private formatKeySuffix(suffix: string): string {
+    formatKeySuffix(suffix) {
         return suffix.replace(/[\s-]+/g, '_').toLowerCase();
     }
 }

package/dist/acf-functions/core/acf-component-autoloader.d.ts

@@ -0,0 +1,11 @@
+import { NextpressComponent } from '../types/components/nextpress-component';
+/**
+ * Autoloads ACF components dynamically from the templates directory.
+ * * **Requirements for it to work:**
+ * Each `.tsx` file within the `src/app/_templates/components/` directory MUST export the following:
+ * 1. `layout` (Named Export): The configuration for the ACF layout, typically defined using the `defineLayout` function.
+ * 2. `default` (Default Export): The React component (JSX/TSX function) that renders the layout.
+ *
+ * @returns {Promise<NextpressComponent[]>} A promise resolving to an array of mapped layout configurations and their respective components.
+ */
+export declare function acfComponentAutoloader(): Promise<NextpressComponent[]>;

package/{lib/acf-functions/core/acf-component-autoloader.ts → dist/acf-functions/core/acf-component-autoloader.js}

@@ -1,7 +1,5 @@
 import fs from 'fs';
 import path from 'path';
-import { NextpressComponent } from '../types/components/nextpress-component';
-
 /**
  * Autoloads ACF components dynamically from the templates directory.
  * * **Requirements for it to work:**
@@ -11,23 +9,19 @@ import { NextpressComponent } from '../types/components/nextpress-component';
  *
  * @returns {Promise<NextpressComponent[]>} A promise resolving to an array of mapped layout configurations and their respective components.
  */
-export async function acfComponentAutoloader(): Promise<NextpressComponent[]> {
+export async function acfComponentAutoloader() {
     const absolutePath = path.join(process.cwd(), 'src', 'app', '_templates', 'components');
     const files = fs.readdirSync(absolutePath);
-
-    const layouts: NextpressComponent[] = [];
-
+    const layouts = [];
     for (const file of files) {
-        if (!file.endsWith('.tsx')) continue;
-
+        if (!file.endsWith('.tsx'))
+            continue;
         const imported = await import(`@/app/_templates/components/${file}`);
-
         const layout = imported.layout;
         const component = imported.default;
-        if (!layout || !component) continue;
-
-        layouts.push({layout, Component: component});
+        if (!layout || !component)
+            continue;
+        layouts.push({ layout, Component: component });
     }
-
     return layouts;
 }

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

@@ -0,0 +1,9 @@
+/**
+ * Autoloads ACF field groups dynamically from the field-groups directory.
+ * * **Requirements for it to work:**
+ * Each `.ts` file within the `src/app/_templates/components/field-groups/` directory MUST export the following:
+ * 1. `default` (Default Export): The configuration object for the ACF Field Group, typically defined using the `defineFieldGroup` function.
+ *
+ * @returns {Promise<NextpressFieldGroup[]>} A promise resolving to an array of loaded ACF field group configurations.
+ */
+export declare function acfFieldGroupAutoloader(): Promise<NextpressFieldGroup[]>;

package/{lib/acf-functions/core/acf-field-group-autoloader.ts → dist/acf-functions/core/acf-field-group-autoloader.js}

@@ -1,6 +1,5 @@
 import fs from 'fs';
 import path from 'path';
-
 /**
  * Autoloads ACF field groups dynamically from the field-groups directory.
  * * **Requirements for it to work:**
@@ -9,20 +8,16 @@ import path from 'path';
  *
  * @returns {Promise<NextpressFieldGroup[]>} A promise resolving to an array of loaded ACF field group configurations.
  */
-export async function acfFieldGroupAutoloader(): Promise<NextpressFieldGroup[]> {
+export async function acfFieldGroupAutoloader() {
     const absolutePath = path.join(process.cwd(), 'src', 'app', '_templates', 'components', 'field-groups');
     const files = fs.readdirSync(absolutePath);
-
-    const fieldGroups: NextpressFieldGroup[] = [];
-
+    const fieldGroups = [];
     for (const file of files) {
-        if (!file.endsWith('.ts')) continue;
-
+        if (!file.endsWith('.ts'))
+            continue;
         const imported = await import(`@/app/_templates/components/field-groups/${file}`);
         const fieldGroup = imported.default;
-
         fieldGroups.push(fieldGroup);
     }
-
     return fieldGroups;
 }

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

@@ -0,0 +1,8 @@
+/**
+ * Defines field group configuration and applies typing.
+ *
+ * @template T - Field group type extending NextpressFieldGroup.
+ * @param {T} layout - Field group configuration object.
+ * @returns {T} Passed field group configuration object.
+ */
+export declare function defineFieldGroup<const T extends NextpressFieldGroup>(layout: T): T;

package/{lib/acf-functions/services/define-field-group.ts → dist/acf-functions/services/define-field-group.js}

@@ -5,6 +5,6 @@
  * @param {T} layout - Field group configuration object.
  * @returns {T} Passed field group configuration object.
  */
-export function defineFieldGroup<const T extends NextpressFieldGroup>(layout: T): T {
+export function defineFieldGroup(layout) {
     return layout;
 }

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

@@ -0,0 +1,8 @@
+/**
+ * Defines layout configuration and applies typing.
+ *
+ * @template T - Layout type extending NextpressLayout.
+ * @param {T} layout - Layout configuration object.
+ * @returns {T} Passed layout configuration object.
+ */
+export declare function defineLayout<const T extends NextpressLayout>(layout: T): T;

package/{lib/acf-functions/services/define-layout.ts → dist/acf-functions/services/define-layout.js}

@@ -5,6 +5,6 @@
  * @param {T} layout - Layout configuration object.
  * @returns {T} Passed layout configuration object.
  */
-export function defineLayout<const T extends NextpressLayout>(layout: T): T {
+export function defineLayout(layout) {
     return layout;
 }

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

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

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

@@ -0,0 +1,18 @@
+export function mapChoiceObject(return_format, value, choices) {
+    if (return_format === 'value') {
+        return value;
+    }
+    if (!choices)
+        return;
+    const label = choices[value !== null && value !== void 0 ? value : ''];
+    if (return_format === 'array') {
+        const result = {
+            label: label,
+            value: value
+        };
+        return result;
+    }
+    else if (return_format === 'label') {
+        return label;
+    }
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Maps individual ACF field to corresponding value.
+ *
+ * @param {NextpressField} field - Field configuration.
+ * @param {ACFRawValues} rawValues - Raw values map.
+ * @returns {Promise<any>} Promise resolving to mapped value.
+ */
+export declare function mapField(field: NextpressField, rawValues: ACFRawValues): Promise<any>;
+/**
+ * Maps layout configuration to values object.
+ *
+ * @param {NextpressLayout} layout - Layout configuration.
+ * @param {ACFRawValues} rawValues - Raw values map.
+ * @returns {Promise<{ [key: string]: any }>} Promise resolving to layout values object.
+ */
+export declare function mapLayout(layout: NextpressLayout, rawValues: ACFRawValues): Promise<{
+    [key: string]: any;
+}>;