@alpaca-headless/alpaca-headless-nextjs 1.0.129 → 1.0.253

package/types/editor/sidebar/Sessions.d.ts

@@ -0,0 +1 @@
+export declare function Sessions(): import("react/jsx-runtime").JSX.Element | null;

package/types/editor/sidebar/Sidebar.d.ts

@@ -0,0 +1,4 @@
+import { EditorView } from "../config/types";
+export declare function Sidebar({ views }: {
+    views: EditorView[];
+}): import("react/jsx-runtime").JSX.Element | null;

package/types/editor/sidebar/SidebarView.d.ts

@@ -0,0 +1,8 @@
+import "allotment/dist/style.css";
+import { EditorView } from "../config/types";
+import { EditContextType } from "../editContext";
+export declare function SidebarView({ view, editContext, active, }: {
+    view: EditorView;
+    editContext: EditContextType;
+    active: boolean;
+}): import("react/jsx-runtime").JSX.Element;

package/types/editor/sidebar/Workbox.d.ts

@@ -0,0 +1 @@
+export declare function Workbox(): import("react/jsx-runtime").JSX.Element | null;

package/types/editor/ui/CopyToClipboardButton.d.ts

@@ -0,0 +1,3 @@
+export declare function CopyToClipboardButton({ text }: {
+    text: string;
+}): import("react/jsx-runtime").JSX.Element;

package/types/editor/ui/Icons.d.ts

@@ -0,0 +1,16 @@
+export declare function WizardIcon({ className }: {
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function BugIcon({ className }: {
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function EditIcon({ className }: {
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function JsonIcon({ className }: {
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function GraphQLIcon({ className }: {
+    className?: string;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function ArrowDownIcon(): import("react/jsx-runtime").JSX.Element;

package/types/editor/{ItemNameDialog.d.ts → ui/ItemNameDialog.d.ts}

@@ -4,6 +4,7 @@ export interface ItemNameDialogHandle {
 }
 export type ItemNameDialogProps = {
     name?: string;
+    title?: string;
     accept: (name: string) => void;
 };
 declare const ItemNameDialog: import("react").ForwardRefExoticComponent<import("react").RefAttributes<ItemNameDialogHandle>>;

package/types/editor/utils/insertOptions.d.ts

@@ -0,0 +1,3 @@
+import { InsertOption } from "../../servertypes";
+import { EditContextType } from "../editContext";
+export declare function getInsertOptionsForCurrentSelection(editContext: EditContextType): InsertOption[];

package/types/editor/utils.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { Field, Item, ItemDescriptor } from "../servertypes";
+import { EditContextType } from "./editContext";
+export declare function useEventListenerExt(eventName: string, handler: any, element: HTMLElement | Window, capture?: boolean): void;
+export declare const useLocalStorage: <T>(storageKey: string, fallbackState: T) => [T, React.Dispatch<React.SetStateAction<T>>];
+export declare const getSelectedText: () => string;
+export declare function isFieldActionExecuting(field: Field, editContext: EditContextType): boolean;
+export declare function getItemDescriptor(item: Item | ItemDescriptor): ItemDescriptor;

package/types/editor/views/ItemEditor.d.ts

@@ -0,0 +1 @@
+export declare function ItemEditor(): import("react/jsx-runtime").JSX.Element | undefined;

package/types/fieldTypes.d.ts

@@ -1,4 +1,4 @@
-import { Field } from "./layoutData";
+import { Field } from "./servertypes";
 export type TextField = Field & {
     value: string;
 };
@@ -11,6 +11,10 @@ export type LinkField = Field & {
 export type InternalLinkField = Field & {
     value: LinkValue;
 };
+export type LinkOption = {
+    name: string;
+    id: string;
+};
 export type PictureValue = {
     name: string;
     alt: string;
@@ -18,20 +22,41 @@ export type PictureValue = {
     loopVideos: boolean;
 };
 export type PictureVariant = {
+    mediaItemName: string;
     name: string;
     src: string;
     videoUrl?: string;
     width: number;
-    aspectRatioText?: string;
+    height: number;
+    aspectRatio: number;
+    aspectRatioLock?: number;
+    aspectRatioLockText?: string;
     thumbSrc?: string;
+    originalSrc?: string;
+    mediaId?: string;
     idPath?: string;
+    region: PictureRegion;
+};
+export type PictureRegion = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
 };
 export type PictureRawValue = {
-    variants: PictureRawVariant[];
+    Variants: PictureRawVariant[];
+    AltText?: string;
 };
 export type PictureRawVariant = {
-    name: string;
-    mediaId: string;
+    Name: string;
+    MediaId: string;
+    Region?: PictureRawRegion;
+};
+export type PictureRawRegion = {
+    X: number;
+    Y: number;
+    Width: number;
+    Height: number;
 };
 export type ImageField = Field & {
     value: ImageValue | null;
@@ -43,10 +68,11 @@ export type ImageValue = {
 export type LinkValue = {
     url: string;
     type: "internal" | "external";
-    target: string;
-    targetItemLongId: string;
-    targetItemName: string;
-    queryString: string;
+    target?: string;
+    targetItemLongId?: string;
+    targetItemName?: string;
+    queryString?: string;
+    targetItemId?: string;
 };
 export interface KeyValuePair {
     key: string;
@@ -62,8 +88,10 @@ export type ReferencedItem = {
 };
 export type TreeListField = Field & {
     value: ReferencedItem[];
-    customEditorProperties: {
-        datasources: string[];
+    _editor: {
+        customEditorProperties: {
+            datasources: string[];
+        };
     };
 };
 export type CheckboxField = Field & {

package/types/graphQL.d.ts

@@ -0,0 +1,12 @@
+export declare function executeGraphQLQuery({ query, host, path, language, mode, itemId, version, tags, revalidate, siteName, }: {
+    query: string;
+    tags?: string[];
+    host?: string;
+    path?: string;
+    language?: string;
+    mode?: string;
+    itemId?: string;
+    version?: number;
+    revalidate?: number;
+    siteName?: string;
+}, sessionId?: string): Promise<any>;

package/types/index.d.ts

@@ -1,7 +1,10 @@
-export * from "./layoutData";
+export * from "./servertypes";
 export * from "./loadRouteData";
 export * from "./components";
-export * from "./alpacaContext";
-export * from "./fieldTypes";
-export * from "./editor";
+export * from "./renderContext";
+export * from "./Editor";
+export * from "./middleware";
 export * as GraphQLTypes from "./graphQLTypes";
+export * from "./graphQL";
+export { translate } from "./translate";
+export type { EditorClientBuilderProps } from "./editor/config/types";

package/types/loadRouteData.d.ts

@@ -1,85 +1,8 @@
-import { Fields, PlaceholderData } from "./layoutData";
-import { ItemDescriptor } from "./editor";
-type Response = {
-    type: "page" | "redirect" | "error" | "notfound";
-};
-export type Error = Response & {
-    type: "error";
-    message: string;
-    errorCode: number;
-};
-export type Language = {
-    name: string;
-    versions: number;
-};
-export type Version = {
-    version: number;
-    updated: Date;
-    updatedBy: string;
-};
-export type Item = {
-    id: string;
-    language: string;
-    version: number;
-    name: string;
-    fields: any;
-    translations?: string[];
-    masterLanguages?: string[];
-    path: string;
-    templateId: string;
-    templateName: string;
-};
-export type Page = Response & Item & {
-    type: "page";
-    editing?: boolean;
-    placeholders: PlaceholderData[];
-    language: string;
-    version: number;
-    languages: Language[];
-    versions: Version[];
-    idPath: string;
-    previewUrl: string;
-    meta: {
-        title: string;
-        description: string;
-        canonical: string;
-        keywords: string;
-        hrefLangTags: object;
-        "og:title": string;
-        "og:description": string;
-        "og:url": string;
-        "og:type": string;
-        "og:image": string;
-    };
-    fields: Fields;
-    workbox: Workbox;
-};
-export type WorkboxItem = {
-    item: ItemDescriptor;
-    lockedBy: string;
-    canLock: boolean;
-    hasLock: boolean;
-    publishStatus: string;
-    workflowState: string;
-    isFinalState: boolean;
-    isPublishable: boolean;
-    path: string;
-    commands: {
-        name: string;
-        id: string;
-    }[];
-};
-export type Workbox = {
-    items: WorkboxItem[];
-};
-export type Redirect = Response & {
-    type: "redirect";
-    location: string;
-};
-export type NotFound = Response & {
-    type: "notfound";
-};
-export declare function loadRouteData(params: {
-    path: string[];
-}, searchParams: any, host: string): Promise<Page | Error | Redirect | NotFound>;
-export {};
+import { NotFound, Page, Redirect, Error, Unauthorized } from "./servertypes";
+export declare function loadRouteData({ path, searchParams, host, }: {
+    path: string[] | string;
+    searchParams: any;
+    host: string;
+}): Promise<Page | Error | Redirect | NotFound | Unauthorized>;
+export declare function loadDictionary(siteName: string, language: string, mode: string, session?: string): Promise<any>;
+export declare function getApiKey(): string | undefined;

package/types/middleware/handleRequest.d.ts

@@ -0,0 +1,5 @@
+import { NextRequest } from "next/server";
+export declare function handleRequest({ request, mapHost, }: {
+    request: NextRequest;
+    mapHost: (host: string) => string;
+}): Promise<Response | undefined>;

package/types/middleware/index.d.ts

@@ -1 +1 @@
-export * from "./authorization";
+export * from "./handleRequest";

package/types/public.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+import { RichText, Text, Placeholder, Translate } from "./components";
+import { translate } from "./translate";
+declare const _default: {
+    Text: typeof Text;
+    RichText: typeof RichText;
+    Image: import("react").FC<import("./components").ImageProps>;
+    Placeholder: typeof Placeholder;
+    Translate: typeof Translate;
+    translate: typeof translate;
+};
+export default _default;

package/types/renderContext.d.ts

@@ -0,0 +1,41 @@
+/// <reference types="react" />
+import { Dictionary, NotFound, Unauthorized, Redirect, Error, Page, EditableDictionary, ComponentData } from "./servertypes";
+export type ContextBase = {
+    isError?: boolean;
+};
+export type ClientRenderContext = {
+    page: Page;
+    dictionary: Dictionary | EditableDictionary;
+    mode: string;
+    isEditing: boolean;
+    isPreview: boolean;
+};
+export type RenderContext = ContextBase & ClientRenderContext & {
+    isError: false;
+    renderings: {
+        [key: string]: React.ComponentType<any>;
+    };
+};
+export type RenderContextProps = {
+    context: RenderContext;
+};
+export type ContextError = ContextBase & {
+    isError: true;
+    message: string;
+    error: Error | Redirect | NotFound | Unauthorized;
+};
+export declare function createRenderContext({ path, searchParams, host, renderings, }: {
+    path: string[] | string;
+    searchParams: any;
+    host: string;
+    renderings: {
+        [key: string]: React.ComponentType<any>;
+    };
+}): Promise<RenderContext | ContextError>;
+export declare function createClientContext(context: RenderContext): ClientRenderContext;
+export type RenderingProps = RenderContextProps & {
+    context: RenderContext;
+    component: ComponentData;
+    index: number;
+    count: number;
+};

package/types/renderings.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+type Rendering = {
+    code: string;
+};
+export declare function getRenderingById(id: string): Promise<React.ComponentType<any>>;
+export declare function getRendering(id: string): Promise<Rendering | undefined>;
+export {};

package/types/servertypes.d.ts

@@ -0,0 +1,308 @@
+import { TextField } from "./fieldTypes";
+export * from "./fieldTypes";
+export type Item = ItemDescriptor & {
+    fields: Fields;
+    templateId: string;
+    templateName: string;
+    _editor?: {
+        translations?: string[];
+        path: string;
+        languages: Language[];
+        versions: Version[];
+        idPath: string;
+        parentId: string;
+        masterLanguages?: string[];
+        hasLock: boolean;
+        canLock: boolean;
+        lockedBy: string;
+        hasLayout: boolean;
+    };
+};
+export type InsertOption = {
+    id: string;
+    name: string;
+    icon: string;
+    group?: string;
+    svg?: string;
+    isComponent: boolean;
+    isHidden: any;
+    compatibleTemplates?: string[];
+};
+export type PlaceholderData = {
+    name: string;
+    key: string;
+    components: ComponentData[];
+    _editor?: {
+        insertOptions?: InsertOption[];
+        canSynchronize?: boolean;
+    };
+    parentComponent?: ComponentData | Page;
+};
+export type FieldDescriptor = {
+    item: ItemDescriptor;
+    fieldId: string;
+};
+export type Field = {
+    id: string;
+    value: unknown;
+    jsonValue?: Field;
+    _editor?: {
+        name?: string;
+        type: string;
+        descriptor: FieldDescriptor;
+        displayName?: string;
+        sortOrder?: number;
+        sectionSortOrder?: number;
+        customProperties?: any;
+        canWrite?: boolean;
+        hasLock?: boolean;
+        canLock?: boolean;
+        lockedBy?: EditSession;
+        buttons?: FieldButton[];
+        section?: string;
+        rawValue?: string;
+        isFallback?: boolean;
+        isStandardValue?: boolean;
+    };
+};
+export interface Fields {
+    [name: string]: Field;
+}
+export type Message = {
+    text: string;
+};
+export type ComponentData = Item & {
+    componentType: string;
+    renderingId?: string;
+    graphql: any;
+    placeholders: PlaceholderData[];
+    type: "component";
+    visible?: boolean;
+    _editor: {
+        linkItemId: string;
+        placeholderReference?: PlaceholderData;
+        messages?: Message[];
+        linkedComponentItem: ItemDescriptor & {
+            path: string;
+        };
+        isRemoved?: boolean;
+        canSynchronize?: boolean;
+        isInheritedFromMasterLanguage?: boolean;
+        isRemovedFromMasterLanguage?: boolean;
+        translations?: string[];
+        graphql_query: string;
+        hostingPageItem?: {
+            id: string;
+            language: string;
+            version: number;
+            path: string;
+            editUrl: string;
+        };
+    };
+};
+export type LanguageVersions = {
+    languageCode: string;
+    countryCode: string;
+    name: string;
+    versions: number;
+};
+export type Dictionary = {
+    [key: string]: string;
+};
+export type EditableDictionary = {
+    [key: string]: TextField;
+};
+export type FieldButton = {
+    id: string;
+    label: string;
+    description: string;
+    action: string;
+    icon?: string;
+    isGenerator: boolean;
+};
+export type ValidationResult = {
+    item: ItemDescriptor;
+    results: SingleValidatorResult[];
+};
+export type SingleValidatorResult = {
+    itemId: string;
+    itemName: string;
+    fieldId: string;
+    fieldName: string;
+    validator: string;
+    result: 0 | 1 | 2 | 3 | 4 | 5;
+    message: string;
+};
+export type ItemDescriptor = {
+    id: string;
+    language: string;
+    version: number;
+    name?: string;
+    hasLayout?: boolean;
+};
+export type User = {
+    name: string;
+    ai: boolean;
+};
+type Response = {
+    type: "page" | "redirect" | "error" | "notfound" | "unauthorized";
+};
+export type Unauthorized = Response & {
+    type: "unauthorized";
+    auth: string | null;
+};
+export type Error = Response & {
+    type: "error";
+    message: string;
+    errorCode: number;
+};
+export type Language = {
+    name: string;
+    versions: number;
+};
+export type Version = {
+    version: number;
+    updated: Date;
+    updatedBy: string;
+};
+export type Page = Response & Item & {
+    type: "page";
+    previewing?: boolean;
+    placeholders: PlaceholderData[];
+    language: string;
+    version: number;
+    graphql: any;
+    site: {
+        name: string;
+    };
+    meta: {
+        title: string;
+        description: string;
+        canonical: string;
+        keywords: string;
+        hrefLangTags: object;
+        "og:title": string;
+        "og:description": string;
+        "og:url": string;
+        "og:type": string;
+        "og:image": string;
+    };
+    fields: Fields;
+    _editor?: {
+        graphql_query: string;
+        workbox: Workbox;
+    };
+};
+export type WorkboxItem = {
+    item: ItemDescriptor;
+    lockedBy: string;
+    canLock: boolean;
+    hasLock: boolean;
+    publishStatus: {
+        [target: string]: string;
+    };
+    workflowState: string;
+    isFinalState: boolean;
+    isPublishable: boolean;
+    isPublished: boolean;
+    path: string;
+    commands: {
+        name: string;
+        id: string;
+    }[];
+};
+export type Workbox = {
+    items: WorkboxItem[];
+};
+export type Redirect = Response & {
+    type: "redirect";
+    location: string;
+    redirectType: "permanent" | "temporary";
+};
+export type NotFound = Response & {
+    type: "notfound";
+};
+export type AiPrompt = {
+    title: string;
+    prompt: string;
+};
+export type EditData = {
+    loginUrl: string;
+    aiPrompts: AiPrompt[];
+};
+export type EditSession = {
+    sessionId: string;
+    url?: string;
+    user: User;
+    userAgent?: string;
+    page?: ItemDescriptor;
+    item?: ItemDescriptor;
+    fieldLock?: {
+        item: ItemDescriptor;
+        fieldId: string;
+    };
+};
+export type EditOperation = {
+    type: "edit-field" | "remove-component" | "move-component" | "add-component" | "synchronize-components" | "link-component" | "duplicate-components";
+    date: string;
+    noRefresh?: boolean;
+    refreshAfterQuietPeriod?: boolean;
+    pageItem: ItemDescriptor;
+    id: string;
+    user?: User;
+    undone?: boolean;
+    sessionId?: string;
+    description: string;
+    canUndo?: boolean;
+    canRedo?: boolean;
+    focus?: string;
+};
+export type EditFieldOperation = EditOperation & {
+    type: "edit-field";
+    item: ItemDescriptor;
+    fieldName: string;
+    fieldId: string;
+    value?: any;
+};
+export type AddComponentOperation = EditOperation & {
+    type: "add-component";
+    templateId: string;
+    language: string;
+    parent: ItemDescriptor;
+    placeholderName: string;
+    placeholderIndex: number;
+    components: ItemDescriptor[];
+};
+export type LinkComponentOperation = EditOperation & {
+    type: "link-component";
+    itemName?: string;
+    linkedComponentItem: ItemDescriptor;
+};
+export type MoveComponentOperation = EditOperation & {
+    type: "move-component";
+    language: string;
+    parent: ItemDescriptor;
+    placeholderName: string;
+    placeholderIndex: number;
+    components: ItemDescriptor[];
+};
+export type DuplicateComponentsOperation = EditOperation & {
+    type: "duplicate-components";
+    sourceComponentIds: string[];
+    parent: ItemDescriptor;
+    placeholderName: string;
+};
+export type RemoveComponentOperation = EditOperation & {
+    type: "remove-component";
+    components: ItemDescriptor[];
+};
+export type SynchronizeComponentsOperation = EditOperation & {
+    type: "synchronize-components";
+    placeholders: PlaceholderToSynchronize[];
+    delete: boolean;
+    itemsCreated?: ItemDescriptor[];
+};
+export type PlaceholderToSynchronize = {
+    name?: string;
+    item?: ItemDescriptor | null;
+};

package/types/translate.d.ts

@@ -0,0 +1,2 @@
+import { RenderContext } from "./renderContext";
+export declare function translate(text: string, context: RenderContext): string;

package/dist/cjs/alpacaContext.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useAlpacaContext = void 0;
-function useAlpacaContext() {
-    let context = globalThis.alpacaContext;
-    if (!context) {
-        context = {};
-        globalThis.alpacaContext = context;
-    }
-    return context;
-}
-exports.useAlpacaContext = useAlpacaContext;