@anvilkit/puck-studio 0.0.1 → 0.1.0

package/dist/overrides.d.cts

@@ -0,0 +1,212 @@
+import { Overrides, Field } from '@puckeditor/core';
+import * as React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare function EditorDrawer({ children, }: {
+    children: React.ReactNode;
+}): React.ReactElement;
+declare function EditorComponents({ children, }: {
+    children: React.ReactNode;
+}): React.ReactElement;
+
+declare function DrawerItem({ children, name, }: {
+    children: React.ReactNode;
+    name: string;
+}): React.ReactElement;
+
+declare function EditorOutline({ children, }: {
+    children: React.ReactNode;
+}): React.ReactElement;
+
+declare function CanvasIframe({ children, document: iframeDoc, }: {
+    children: React.ReactNode;
+    document?: Document;
+}): React.ReactElement;
+
+declare function CanvasPreview({ children, }: {
+    children: React.ReactNode;
+}): React.ReactElement;
+
+declare function ComponentOverlay({ children, hover, isSelected, }: {
+    children: React.ReactNode;
+    hover: boolean;
+    isSelected: boolean;
+    componentId: string;
+    componentType: string;
+}): React.ReactElement;
+
+declare function ActionBar({ children, label, parentAction, }: {
+    children: React.ReactNode;
+    label?: string;
+    parentAction: React.ReactNode;
+}): React.ReactElement;
+
+type FieldWrapperProps = Parameters<NonNullable<Overrides["fields"]>>[0];
+type BaseFieldLabelProps = Parameters<NonNullable<Overrides["fieldLabel"]>>[0];
+type FieldLabelProps = Omit<BaseFieldLabelProps, "icon"> & {
+    icon?: React.ReactNode;
+    labelIcon?: React.ReactNode;
+};
+declare function FieldWrapper({ children, }: FieldWrapperProps): React.ReactElement;
+declare function FieldLabel({ children, label, icon, labelIcon, el, readOnly, className, }: FieldLabelProps): React.ReactElement;
+
+interface TextFieldProps {
+    field?: {
+        ai?: {
+            instructions?: string;
+        };
+    };
+    value: string;
+    onChange: (value: string) => void;
+    readOnly?: boolean;
+    placeholder?: string;
+    label?: string;
+    labelIcon?: React.ReactNode;
+}
+declare function TextField({ field, value, onChange, readOnly, placeholder, label, labelIcon, }: TextFieldProps): react_jsx_runtime.JSX.Element;
+
+interface TextareaFieldProps {
+    value: string;
+    onChange: (value: string) => void;
+    readOnly?: boolean;
+    placeholder?: string;
+    label?: string;
+}
+declare function TextareaField({ value, onChange, readOnly, placeholder, label }: TextareaFieldProps): react_jsx_runtime.JSX.Element;
+
+interface NumberFieldProps {
+    value: number;
+    onChange: (value: number) => void;
+    readOnly?: boolean;
+    min?: number;
+    max?: number;
+    step?: number;
+    label?: string;
+}
+declare function NumberField({ value, onChange, readOnly, min, max, step, label }: NumberFieldProps): react_jsx_runtime.JSX.Element;
+
+interface SelectOption {
+    label: string;
+    value: string | number | boolean;
+}
+interface SelectFieldProps {
+    field: {
+        type: "select";
+        options: SelectOption[];
+    };
+    value: string | number | boolean;
+    onChange: (value: string | number | boolean) => void;
+    id?: string;
+    readOnly?: boolean;
+    label?: string;
+}
+declare function SelectField({ field, value, onChange, id, readOnly, label }: SelectFieldProps): react_jsx_runtime.JSX.Element;
+
+interface RadioOption {
+    label: string;
+    value: string | number | boolean;
+}
+interface RadioFieldProps {
+    field: {
+        type: "radio";
+        options: RadioOption[];
+    };
+    value: string | number | boolean;
+    onChange: (value: string | number | boolean) => void;
+    id?: string;
+    readOnly?: boolean;
+    label?: string;
+}
+declare function RadioField({ field, value, onChange, readOnly, label }: RadioFieldProps): react_jsx_runtime.JSX.Element;
+
+interface ArrayItem {
+    _id?: string;
+    [key: string]: unknown;
+}
+type ArraySubField = Field & {
+    label?: string;
+};
+interface ArrayFieldDef {
+    type: "array";
+    arrayFields: Record<string, ArraySubField>;
+    getItemSummary?: (item: unknown, index: number) => string;
+    defaultItemProps?: Record<string, unknown> | ((index: number) => Record<string, unknown>);
+    max?: number;
+    min?: number;
+    label?: string;
+}
+interface ArrayFieldProps {
+    field: ArrayFieldDef;
+    value: ArrayItem[];
+    onChange: (value: ArrayItem[]) => void;
+    id?: string;
+    readOnly?: boolean;
+    label?: string;
+    name?: string;
+    children?: React.ReactNode;
+}
+declare function ArrayField({ field, value, onChange, readOnly, label, id, }: ArrayFieldProps): react_jsx_runtime.JSX.Element;
+
+interface ObjectFieldProps {
+    field: {
+        type: "object";
+        objectFields: Record<string, unknown>;
+    };
+    value: Record<string, unknown>;
+    onChange: (value: Record<string, unknown>) => void;
+    id?: string;
+    readOnly?: boolean;
+    name: string;
+    children?: React.ReactNode;
+}
+declare function ObjectField({ children, name, readOnly }: ObjectFieldProps): react_jsx_runtime.JSX.Element;
+
+interface SlotFieldProps {
+    children?: React.ReactNode;
+    label?: string;
+}
+declare function SlotField({ children, label }: SlotFieldProps): react_jsx_runtime.JSX.Element;
+
+interface CustomFieldProps {
+    children?: React.ReactNode;
+    label?: string;
+}
+declare function CustomField({ children, label }: CustomFieldProps): react_jsx_runtime.JSX.Element;
+
+interface RichtextFieldProps {
+    value: string;
+    onChange: (value: string) => void;
+    readOnly?: boolean;
+    label?: string;
+}
+declare function RichtextField({ value, onChange, readOnly, label }: RichtextFieldProps): react_jsx_runtime.JSX.Element;
+
+interface ExternalFieldProps {
+    value: unknown;
+    onChange: (value: unknown) => void;
+    fetchList?: (query: string) => Promise<{
+        label: string;
+        value: unknown;
+    }[]>;
+    readOnly?: boolean;
+    label?: string;
+}
+declare function ExternalField({ value, onChange, fetchList, readOnly, label }: ExternalFieldProps): react_jsx_runtime.JSX.Element;
+
+declare const fieldTypesRegistry: {
+    text: typeof TextField;
+    textarea: typeof TextareaField;
+    number: typeof NumberField;
+    select: typeof SelectField;
+    radio: typeof RadioField;
+    array: typeof ArrayField;
+    object: typeof ObjectField;
+    slot: typeof SlotField;
+    custom: typeof CustomField;
+    richtext: typeof RichtextField;
+    external: typeof ExternalField;
+};
+
+declare const puckOverrides: Partial<Overrides>;
+
+export { ActionBar, CanvasIframe, CanvasPreview, ComponentOverlay, DrawerItem, EditorComponents, EditorDrawer, EditorOutline, FieldLabel, FieldWrapper, fieldTypesRegistry, puckOverrides };

package/dist/overrides.d.ts

@@ -0,0 +1,212 @@
+import { Overrides, Field } from '@puckeditor/core';
+import * as React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare function EditorDrawer({ children, }: {
+    children: React.ReactNode;
+}): React.ReactElement;
+declare function EditorComponents({ children, }: {
+    children: React.ReactNode;
+}): React.ReactElement;
+
+declare function DrawerItem({ children, name, }: {
+    children: React.ReactNode;
+    name: string;
+}): React.ReactElement;
+
+declare function EditorOutline({ children, }: {
+    children: React.ReactNode;
+}): React.ReactElement;
+
+declare function CanvasIframe({ children, document: iframeDoc, }: {
+    children: React.ReactNode;
+    document?: Document;
+}): React.ReactElement;
+
+declare function CanvasPreview({ children, }: {
+    children: React.ReactNode;
+}): React.ReactElement;
+
+declare function ComponentOverlay({ children, hover, isSelected, }: {
+    children: React.ReactNode;
+    hover: boolean;
+    isSelected: boolean;
+    componentId: string;
+    componentType: string;
+}): React.ReactElement;
+
+declare function ActionBar({ children, label, parentAction, }: {
+    children: React.ReactNode;
+    label?: string;
+    parentAction: React.ReactNode;
+}): React.ReactElement;
+
+type FieldWrapperProps = Parameters<NonNullable<Overrides["fields"]>>[0];
+type BaseFieldLabelProps = Parameters<NonNullable<Overrides["fieldLabel"]>>[0];
+type FieldLabelProps = Omit<BaseFieldLabelProps, "icon"> & {
+    icon?: React.ReactNode;
+    labelIcon?: React.ReactNode;
+};
+declare function FieldWrapper({ children, }: FieldWrapperProps): React.ReactElement;
+declare function FieldLabel({ children, label, icon, labelIcon, el, readOnly, className, }: FieldLabelProps): React.ReactElement;
+
+interface TextFieldProps {
+    field?: {
+        ai?: {
+            instructions?: string;
+        };
+    };
+    value: string;
+    onChange: (value: string) => void;
+    readOnly?: boolean;
+    placeholder?: string;
+    label?: string;
+    labelIcon?: React.ReactNode;
+}
+declare function TextField({ field, value, onChange, readOnly, placeholder, label, labelIcon, }: TextFieldProps): react_jsx_runtime.JSX.Element;
+
+interface TextareaFieldProps {
+    value: string;
+    onChange: (value: string) => void;
+    readOnly?: boolean;
+    placeholder?: string;
+    label?: string;
+}
+declare function TextareaField({ value, onChange, readOnly, placeholder, label }: TextareaFieldProps): react_jsx_runtime.JSX.Element;
+
+interface NumberFieldProps {
+    value: number;
+    onChange: (value: number) => void;
+    readOnly?: boolean;
+    min?: number;
+    max?: number;
+    step?: number;
+    label?: string;
+}
+declare function NumberField({ value, onChange, readOnly, min, max, step, label }: NumberFieldProps): react_jsx_runtime.JSX.Element;
+
+interface SelectOption {
+    label: string;
+    value: string | number | boolean;
+}
+interface SelectFieldProps {
+    field: {
+        type: "select";
+        options: SelectOption[];
+    };
+    value: string | number | boolean;
+    onChange: (value: string | number | boolean) => void;
+    id?: string;
+    readOnly?: boolean;
+    label?: string;
+}
+declare function SelectField({ field, value, onChange, id, readOnly, label }: SelectFieldProps): react_jsx_runtime.JSX.Element;
+
+interface RadioOption {
+    label: string;
+    value: string | number | boolean;
+}
+interface RadioFieldProps {
+    field: {
+        type: "radio";
+        options: RadioOption[];
+    };
+    value: string | number | boolean;
+    onChange: (value: string | number | boolean) => void;
+    id?: string;
+    readOnly?: boolean;
+    label?: string;
+}
+declare function RadioField({ field, value, onChange, readOnly, label }: RadioFieldProps): react_jsx_runtime.JSX.Element;
+
+interface ArrayItem {
+    _id?: string;
+    [key: string]: unknown;
+}
+type ArraySubField = Field & {
+    label?: string;
+};
+interface ArrayFieldDef {
+    type: "array";
+    arrayFields: Record<string, ArraySubField>;
+    getItemSummary?: (item: unknown, index: number) => string;
+    defaultItemProps?: Record<string, unknown> | ((index: number) => Record<string, unknown>);
+    max?: number;
+    min?: number;
+    label?: string;
+}
+interface ArrayFieldProps {
+    field: ArrayFieldDef;
+    value: ArrayItem[];
+    onChange: (value: ArrayItem[]) => void;
+    id?: string;
+    readOnly?: boolean;
+    label?: string;
+    name?: string;
+    children?: React.ReactNode;
+}
+declare function ArrayField({ field, value, onChange, readOnly, label, id, }: ArrayFieldProps): react_jsx_runtime.JSX.Element;
+
+interface ObjectFieldProps {
+    field: {
+        type: "object";
+        objectFields: Record<string, unknown>;
+    };
+    value: Record<string, unknown>;
+    onChange: (value: Record<string, unknown>) => void;
+    id?: string;
+    readOnly?: boolean;
+    name: string;
+    children?: React.ReactNode;
+}
+declare function ObjectField({ children, name, readOnly }: ObjectFieldProps): react_jsx_runtime.JSX.Element;
+
+interface SlotFieldProps {
+    children?: React.ReactNode;
+    label?: string;
+}
+declare function SlotField({ children, label }: SlotFieldProps): react_jsx_runtime.JSX.Element;
+
+interface CustomFieldProps {
+    children?: React.ReactNode;
+    label?: string;
+}
+declare function CustomField({ children, label }: CustomFieldProps): react_jsx_runtime.JSX.Element;
+
+interface RichtextFieldProps {
+    value: string;
+    onChange: (value: string) => void;
+    readOnly?: boolean;
+    label?: string;
+}
+declare function RichtextField({ value, onChange, readOnly, label }: RichtextFieldProps): react_jsx_runtime.JSX.Element;
+
+interface ExternalFieldProps {
+    value: unknown;
+    onChange: (value: unknown) => void;
+    fetchList?: (query: string) => Promise<{
+        label: string;
+        value: unknown;
+    }[]>;
+    readOnly?: boolean;
+    label?: string;
+}
+declare function ExternalField({ value, onChange, fetchList, readOnly, label }: ExternalFieldProps): react_jsx_runtime.JSX.Element;
+
+declare const fieldTypesRegistry: {
+    text: typeof TextField;
+    textarea: typeof TextareaField;
+    number: typeof NumberField;
+    select: typeof SelectField;
+    radio: typeof RadioField;
+    array: typeof ArrayField;
+    object: typeof ObjectField;
+    slot: typeof SlotField;
+    custom: typeof CustomField;
+    richtext: typeof RichtextField;
+    external: typeof ExternalField;
+};
+
+declare const puckOverrides: Partial<Overrides>;
+
+export { ActionBar, CanvasIframe, CanvasPreview, ComponentOverlay, DrawerItem, EditorComponents, EditorDrawer, EditorOutline, FieldLabel, FieldWrapper, fieldTypesRegistry, puckOverrides };