@alpaca-headless/alpaca-headless-nextjs 1.0.128 → 1.0.246

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,8 @@
-export * from "./layoutData";
+export * from "./servertypes";
 export * from "./loadRouteData";
 export * from "./components";
 export * from "./alpacaContext";
-export * from "./fieldTypes";
-export * from "./editor";
+export * from "./editor/Editor";
+export * from "./middleware";
 export * as GraphQLTypes from "./graphQLTypes";
+export * from "./graphQL";

package/types/loadRouteData.d.ts

@@ -1,85 +1,7 @@
-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 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/servertypes.d.ts

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

package/dist/cjs/client-components/ClientLink.js

@@ -1,36 +0,0 @@
-"use strict";
-"use client";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClientLink = void 0;
-const jsx_runtime_1 = require("react/jsx-runtime");
-const __1 = require("..");
-const LinkEditor_1 = __importDefault(require("../components/LinkEditor"));
-function ClientLink(_a) {
-    var { field, children } = _a, props = __rest(_a, ["field", "children"]);
-    if (!field)
-        return;
-    if (field.jsonValue) {
-        field = field.jsonValue;
-    }
-    if (!field.value)
-        return;
-    const editing = (0, __1.useEditContext)();
-    if (editing)
-        return ((0, jsx_runtime_1.jsx)(LinkEditor_1.default, Object.assign({ field: field }, props, { children: children })));
-    return ((0, jsx_runtime_1.jsx)("a", Object.assign({ href: field.value.url }, props, { children: children })));
-}
-exports.ClientLink = ClientLink;

package/dist/cjs/client-components/MultiComponentEditor.js

@@ -1,26 +0,0 @@
-"use strict";
-"use client";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MultiComponentEditor = void 0;
-const jsx_runtime_1 = require("react/jsx-runtime");
-const __1 = require("..");
-function MultiComponentEditor({ component, children, thumbZoom = 0.2, thumbHeight = "150px", thumbWidth = "150px", numComponentsVisibleWhenNotEditing = 1, }) {
-    var editContext = (0, __1.useEditContext)();
-    if (!editContext)
-        return null;
-    const style = {
-        "--a-mce-thumb-zoom": thumbZoom,
-        "--a-mce-thumb-width": thumbWidth,
-        "--a-mce-thumb-height": thumbHeight,
-    };
-    const filterChildCallback = ({ component, index, }) => {
-        var _a;
-        return index > numComponentsVisibleWhenNotEditing &&
-            ((_a = editContext === null || editContext === void 0 ? void 0 : editContext.selection) === null || _a === void 0 ? void 0 : _a.indexOf(component === null || component === void 0 ? void 0 : component.id)) === -1;
-    };
-    return ((0, jsx_runtime_1.jsxs)("div", { className: "a-mce", style: style, children: [(0, jsx_runtime_1.jsxs)("div", { className: "flex a-mce-items gap-2 flex-wrap items-center", children: [children, (0, jsx_runtime_1.jsx)("div", { onClick: (ev) => {
-                            editContext === null || editContext === void 0 ? void 0 : editContext.setSelectedForInsertion(component.id);
-                            ev.stopPropagation();
-                        }, children: (0, jsx_runtime_1.jsx)("i", { className: "pi pi-plus-circle text-3xl cursor-pointer" }) })] }), (0, jsx_runtime_1.jsx)("div", { className: "a-mce-selected", children: (0, jsx_runtime_1.jsx)(__1.EditFilterChildrenContextProvider, { value: { filterChildCallback }, children: children }) })] }));
-}
-exports.MultiComponentEditor = MultiComponentEditor;

package/dist/cjs/client-components/index.js

@@ -1,19 +0,0 @@
-"use strict";
-"use client";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ClientLink"), exports);
-__exportStar(require("./MultiComponentEditor"), exports);

package/dist/cjs/components/Error.js

@@ -1,15 +0,0 @@
-"use strict";
-"use client";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorFallbackWithDetails = exports.ErrorFallback = void 0;
-const jsx_runtime_1 = require("react/jsx-runtime");
-function ErrorFallback() {
-    // Call resetErrorBoundary() to reset the error boundary and retry the render.
-    return ((0, jsx_runtime_1.jsx)("div", { role: "alert", children: (0, jsx_runtime_1.jsx)("p", { children: "Something went wrong." }) }));
-}
-exports.ErrorFallback = ErrorFallback;
-function ErrorFallbackWithDetails({ error }) {
-    // Call resetErrorBoundary() to reset the error boundary and retry the render.
-    return ((0, jsx_runtime_1.jsxs)("div", { role: "alert", children: [(0, jsx_runtime_1.jsx)("p", { children: "Something went wrong:" }), (0, jsx_runtime_1.jsxs)("pre", { style: { color: "red" }, children: [error.message, " ", error.stack] })] }));
-}
-exports.ErrorFallbackWithDetails = ErrorFallbackWithDetails;

package/dist/cjs/components/Link.js

@@ -1,36 +0,0 @@
-"use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Link = void 0;
-const jsx_runtime_1 = require("react/jsx-runtime");
-const __1 = require("..");
-const LinkEditor_1 = __importDefault(require("./LinkEditor"));
-function Link(_a) {
-    var _b;
-    var { field, children } = _a, props = __rest(_a, ["field", "children"]);
-    if (!field)
-        return;
-    if (field.jsonValue) {
-        field = field.jsonValue;
-    }
-    if (!field.value)
-        return;
-    const editing = (_b = (0, __1.useAlpacaContext)().pageContext) === null || _b === void 0 ? void 0 : _b.pageEditing;
-    if (editing)
-        return ((0, jsx_runtime_1.jsx)(LinkEditor_1.default, Object.assign({ field: field }, props, { children: children })));
-    return ((0, jsx_runtime_1.jsx)("a", Object.assign({ href: field.value.url }, props, { children: children })));
-}
-exports.Link = Link;