@alpaca-headless/alpaca-headless 1.0.3397

package/dist/services/graphQL.js

@@ -0,0 +1,54 @@
+import { apiGet, apiPostObject } from "./api";
+export async function executeGraphQLQuery({ query, host, path, language, mode, itemId, version, 
+// tags,
+// revalidate,
+siteName, schema, sessionId, apiConfig, }) {
+    var _a, _b, _c;
+    let url = "/alpaca/headless/graphql";
+    if (sessionId)
+        url += "?sessionId=" + sessionId;
+    //console.log(`GraphQL query:`, query);
+    const request = {
+        Query: query,
+        Host: host,
+        Path: path,
+        ItemId: itemId,
+        Language: language,
+        Version: version,
+        Mode: mode,
+        SiteName: siteName,
+        Schema: schema,
+    };
+    //TODO: cache:
+    const response = await apiPostObject(url, request, apiConfig);
+    if (response.status !== 200) {
+        return { status: response.status, errors: getErrors(response) };
+    }
+    if ((_a = response.data) === null || _a === void 0 ? void 0 : _a.errors) {
+        return {
+            status: 400,
+            errors: (_b = response.data) === null || _b === void 0 ? void 0 : _b.errors,
+        };
+    }
+    return {
+        data: (_c = response.data) === null || _c === void 0 ? void 0 : _c.data,
+        status: response.status,
+        errors: getErrors(response),
+    };
+}
+function getErrors(response) {
+    var _a, _b;
+    if ((_a = response.data) === null || _a === void 0 ? void 0 : _a.errors)
+        return (_b = response.data) === null || _b === void 0 ? void 0 : _b.errors;
+    if (response.error)
+        return [{ message: response.error }];
+    return undefined;
+}
+export async function getGraphQLSchema({ id, apiConfig, }) {
+    let url = "/alpaca/headless/graphql/schema?id=" + id;
+    const response = await apiGet(url, apiConfig);
+    if (response.status !== 200) {
+        return { status: response.status, error: response.error };
+    }
+    return response.data;
+}

package/dist/types/fetch.d.ts

@@ -0,0 +1,7 @@
+export interface AlpacaFetchRequestConfig {
+    revalidate?: number | false;
+    tags?: string[];
+}
+export interface AlpacaRequestInit extends RequestInit {
+    alpaca?: AlpacaFetchRequestConfig | undefined;
+}

package/dist/types/fetch.js

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

package/dist/types/fieldTypes.d.ts

@@ -0,0 +1,106 @@
+import { Field } from "./items";
+export type TextField = Field & {
+    value: string;
+};
+export type PictureField = Field & {
+    value: PictureValue | null;
+};
+export type LinkField = Field & {
+    value: LinkValue;
+};
+export type InternalLinkField = Field & {
+    value: LinkValue;
+};
+export type PictureValue = {
+    name: string;
+    alt: string;
+    variants: PictureVariant[];
+    loopVideos: boolean;
+};
+export type PictureVariant = {
+    mediaItemName: string;
+    name: string;
+    src: string;
+    videoUrl?: string;
+    width: number;
+    height: number;
+    aspectRatio: number;
+    aspectRatioLock?: number;
+    aspectRatioLockText?: string;
+    minWidth?: number;
+    minHeight?: number;
+    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[];
+    AltText?: string;
+};
+export type PictureRawVariant = {
+    Name: string;
+    MediaId: string;
+    Region?: PictureRawRegion;
+};
+export type PictureRawRegion = {
+    X: number;
+    Y: number;
+    Width: number;
+    Height: number;
+};
+export type ImageField = Field & {
+    value: ImageValue | null;
+};
+export type ImageValue = {
+    altText: string;
+    src: string;
+};
+export type LinkValue = {
+    url: string;
+    type: "internal" | "external";
+    target?: string;
+    targetItemLongId?: string;
+    targetItemName?: string;
+    queryString?: string;
+    targetItemId?: string;
+};
+export interface KeyValuePair {
+    key: string;
+    value: string;
+}
+export type EnhancedNameValueListField = {
+    value: KeyValuePair[];
+};
+export type ReferencedItem = {
+    id: string;
+    name: string;
+    path: string;
+};
+export type TreeListField = Field & {
+    value: ReferencedItem[];
+    _editor: {
+        customEditorProperties: {
+            datasources: string[];
+        };
+    };
+};
+export type CheckboxField = Field & {
+    value: boolean;
+};
+export type DateField = Field & {
+    value: DateFieldValue;
+};
+export type DateFieldValue = Field & {
+    date: string;
+};
+export type NumberField = Field & {
+    value: number;
+};

package/dist/types/fieldTypes.js

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

package/dist/types/items.d.ts

@@ -0,0 +1,56 @@
+import { ItemEditorProps } from "./layoutDataTypes";
+export type ItemRef = {
+    id: string;
+    name?: string;
+};
+export type ItemDescriptor = {
+    id: string;
+    language: string;
+    version: number;
+    name?: string;
+    hasLayout?: boolean;
+};
+export interface Item extends ItemDescriptor {
+    fields: Fields;
+    templateId: string;
+    templateName: string;
+    _editor?: ItemEditorProps;
+}
+export interface Fields {
+    [name: string]: Field;
+}
+export interface Field {
+    id: string;
+    value: unknown;
+    jsonValue?: Field;
+    descriptor?: FieldDescriptor;
+    name?: string;
+    displayName?: string;
+}
+export type FieldButton = {
+    id: string;
+    label: string;
+    description: string;
+    action?: string;
+    icon?: string;
+    isGenerator: boolean;
+};
+export type LockSession = {
+    sessionId: string;
+    name: string;
+};
+export type FieldDescriptor = {
+    item: ItemDescriptor;
+    fieldId: string;
+};
+export type Language = {
+    name: string;
+    versions: number;
+    icon: string;
+    languageCode: string;
+};
+export type Version = {
+    version: number;
+    updated: Date;
+    updatedBy: string;
+};

package/dist/types/items.js

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

package/dist/types/layoutDataTypes.d.ts

@@ -0,0 +1,142 @@
+/// <reference types="react" />
+import { ServerRenderContext } from "../render-context";
+import { Rendering } from "../renderings/renderings";
+import { Item, ItemDescriptor, Language, Version } from "./items";
+export interface PlaceholderData {
+    context: ServerRenderContext;
+    name: string;
+    key: string;
+    components: ComponentData[];
+    hasMore?: boolean;
+    parentComponent?: ComponentData | Page;
+    _editor?: {
+        insertOptions?: InsertOption[];
+        canSynchronize?: boolean;
+    };
+}
+export interface ComponentData extends Item {
+    context: ServerRenderContext;
+    componentType: string;
+    rendering?: RenderingReference;
+    defaultRendering?: RenderingReference;
+    graphql: any;
+    placeholders: PlaceholderData[];
+    type: "component";
+    visible?: boolean;
+    _editor: ItemEditorProps & {
+        linkItemId: string;
+        placeholderReference?: PlaceholderData;
+        messages?: Message[];
+        linkedComponentItem: ItemDescriptor & {
+            path: string;
+        };
+        isRemoved?: boolean;
+        canSynchronize?: boolean;
+        isInheritedFromMasterLanguage?: boolean;
+        isRemovedFromMasterLanguage?: boolean;
+        translations?: string[];
+        graphql_query: string;
+        compatibleRenderings?: Rendering[];
+        hostingPageItem?: {
+            id: string;
+            language: string;
+            version: number;
+            path: string;
+            editUrl: string;
+        };
+    };
+}
+export interface RenderingReference {
+    id: string;
+    revision: string;
+}
+export type RenderMode = "normal" | "edit" | "preview";
+export interface Page extends Item {
+    context: ServerRenderContext;
+    mode: RenderMode;
+    placeholders: PlaceholderData[];
+    graphql: any;
+    site: {
+        name: string;
+    };
+    meta: {
+        title: string;
+        description: string;
+        canonical: string;
+        keywords: string;
+        hrefLangTags: {
+            [language: string]: string;
+        };
+        "og:title": string;
+        "og:description": string;
+        "og:url": string;
+        "og:type": string;
+        "og:image": string;
+    };
+    _editor?: ItemEditorProps & {
+        graphql_query: string;
+        workbox: Workbox;
+    };
+}
+export interface DictionaryEntry {
+    value: string;
+}
+export interface Dictionary {
+    [key: string]: DictionaryEntry;
+}
+export type RenderingsMap = {
+    [key: string]: React.ComponentType<any>;
+};
+export type InsertOption = {
+    templateId: string;
+    name: string;
+    icon: string;
+    group?: string;
+    svg?: string;
+    isComponent: boolean;
+    isHidden: any;
+    compatibleTemplates?: string[];
+};
+export interface ItemEditorProps {
+    translations?: string[];
+    path: string;
+    languages: Language[];
+    versions: Version[];
+    idPath: string;
+    parentId: string;
+    masterLanguages?: string[];
+    hasLock: boolean;
+    canLock: boolean;
+    canWrite: boolean;
+    canWriteLanguage: boolean;
+    canWriteItem: boolean;
+    canWriteWorkflow: boolean;
+    workflowState: boolean;
+    lockedBy: string;
+    hasLayout: boolean;
+    icon: string;
+}
+export type Message = {
+    text: string;
+};
+export type Workbox = {
+    items: WorkboxItem[];
+};
+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;
+    }[];
+};

package/dist/types/layoutDataTypes.js

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

package/dist/utils/media-protection.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="node" />
+import "url";
+export declare function hashImageUrl(url: string): string;

package/dist/utils/media-protection.js

@@ -0,0 +1,49 @@
+import crypto from "crypto";
+import "url";
+const protectedParams = [
+    "w",
+    "h",
+    "mw",
+    "mh",
+    "sc",
+    "as",
+    "bc",
+    "db",
+    "iar",
+    "la",
+    "thn",
+    "vs",
+    "sc_content",
+    "sc_lang",
+    "sc_site",
+    "gray",
+    "rev",
+    "devicepixelratio",
+    "encodequality",
+    "rx",
+    "ry",
+    "rw",
+    "rh",
+    "crop",
+];
+export function hashImageUrl(url) {
+    if (!process.env.MEDIA_REQUESTPROTECTION_SHAREDSECRET)
+        return url;
+    if (!url)
+        return url;
+    const baseURL = 'http://temp-base-url.com'; // This will serve as a placeholder.
+    const uri = new URL(url.toLowerCase(), baseURL);
+    uri.searchParams.delete("hash");
+    const searchParams = protectedParams
+        .map((x) => ({ name: x, val: uri.searchParams.get(x) }))
+        .filter((x) => x.val)
+        .map((x) => x.name + "=" + x.val)
+        .join("&");
+    const stringToProtect = uri.pathname.substring(1) + "?" + searchParams;
+    const hash = crypto
+        .createHash("md5")
+        .update(stringToProtect + process.env.MEDIA_REQUESTPROTECTION_SHAREDSECRET, "utf16le")
+        .digest("hex");
+    uri.searchParams.set("hash", hash);
+    return url.startsWith('http') ? uri.toString() : uri.pathname + uri.search;
+}

package/next.config.mjs

@@ -0,0 +1,4 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {};
+
+export default nextConfig;

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@alpaca-headless/alpaca-headless",
+  "version": "1.0.3397",
+  "type": "module",
+  "description": "Alpaca Headless",
+  "main": "dist/index.js",
+  "exports": {
+    ".": "./dist/index.js",
+    "./client-components": "./dist/client-components/index.js",
+    "./middleware": "./dist/middleware/index.js",
+    "./internals": "./dist/internals/index.js"
+  },
+  "typesVersions": {
+    "*": {
+      "client-components": [
+        "dist/client-components/index.d.ts"
+      ],
+      "middleware": [
+        "dist/middleware/index.d.ts"
+      ],
+      "internals": [
+        "dist/internals/index.d.ts"
+      ]
+    }
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yourusername/your-module-name.git"
+  },
+  "keywords": [
+    "esm",
+    "module"
+  ],
+  "author": "Canvas REPLY DE GmbH",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/yourusername/your-module-name/issues"
+  },
+  "homepage": "https://github.com/yourusername/your-module-name#readme",
+  "devDependencies": {
+    "@types/node": "^20.12.11",
+    "@types/react": "18.3.3",
+    "@types/react-dom": "18.3.0",
+    "@types/uuid": "^10.0.0",
+    "eslint": "^8",
+    "eslint-config-next": "14.1.3",
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "axios": "^1.7.2",
+    "next": "^14.2.10",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-error-boundary": "^4.0.13",
+    "uuid": "^10.0.0"
+  }
+}

package/postcss.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+};

package/src/client-components/ClientLink.tsx

@@ -0,0 +1,33 @@
+"use client";
+import { LinkField } from "../types/fieldTypes";
+
+export function ClientLink({
+  field,
+  children,
+  ...props
+}: {
+  field: LinkField;
+  children: React.ReactNode;
+  editable?: boolean;
+} & React.AnchorHTMLAttributes<HTMLAnchorElement>) {
+  const descriptor = field.descriptor;
+
+  const editProps = descriptor
+    ? {
+        ...props,
+        "data-fieldid": descriptor.fieldId,
+        "data-itemid": descriptor.item.id,
+        "data-language": descriptor.item.language,
+        "data-version": descriptor.item.version,
+      }
+    : props;
+  return (
+    <a
+      href={field.value.url}
+      {...editProps}
+      onClick={(e: any) => e.preventDefault()}
+    >
+      {children}
+    </a>
+  );
+}

package/src/client-components/index.ts

@@ -0,0 +1 @@
+export { ClientLink } from "./ClientLink";

package/src/components/Error.tsx

@@ -0,0 +1,56 @@
+"use client";
+
+// import { EditContextType } from "../editor/editContext";
+
+export function ErrorFallback() {
+  // Call resetErrorBoundary() to reset the error boundary and retry the render.
+
+  return (
+    <div role="alert">
+      <p>Something went wrong.</p>
+    </div>
+  );
+}
+
+// export function ErrorFallbackWithDetails({
+//   error,
+//   component,
+//   editContext,
+// }: {
+//   error: Error;
+//   component: ComponentData;
+//   editContext?: EditContextType;
+// }) {
+//   // Call resetErrorBoundary() to reset the error boundary and retry the render.
+
+//   return (
+//     <div
+//       role="alert"
+//       className="a-cursor-pointer"
+//       onClick={(ev) => {
+//         if (!editContext) return;
+//         ev.stopPropagation();
+//         ev.preventDefault();
+//         editContext.select([component.id]);
+//         if (!editContext.configuration.chrome.editor.views) return;
+//         const designerView = editContext.configuration.chrome.editor.views.find(
+//           (x) => x.name === "component-designer"
+//         );
+//         if (component.rendering && designerView)
+//           editContext.setView(designerView);
+//       }}
+//     >
+//       <div className="a-text-xs a-bg-gray-100 a-p-3">
+//         <div className="a-font-bold a-mb-1">Something went wrong</div>
+//         <div>Component id: {component.id}</div>
+//         <div>Component type: {component.componentType}</div>
+//         {component.rendering && (
+//           <div>Rendering id: {component.rendering.id}</div>
+//         )}
+//         <pre className="a-overflow-x-auto a-text-red-500 a-py-2">
+//           {error.message} {error.stack}
+//         </pre>
+//       </div>
+//     </div>
+//   );
+// }

package/src/components/LazyPlaceholder.tsx

@@ -0,0 +1,35 @@
+import { ServerRenderContext } from "../render-context";
+import { loadPartialLayout } from "../route-data/resolve-route";
+import { PlaceholderData } from "../types/layoutDataTypes";
+import { Placeholder } from "./Placeholder";
+
+export async function LazyPlaceholder({
+  placeholder,
+  context,
+}: {
+  context: ServerRenderContext;
+  placeholder: PlaceholderData;
+}) {
+  const data = await loadPartialLayout(
+    context.page.id,
+    context.page.language,
+    context.page.version,
+    placeholder.parentComponent
+      ? {
+          id: placeholder.parentComponent.id,
+          language: placeholder.parentComponent.language,
+          version: placeholder.parentComponent.version,
+        }
+      : undefined,
+    placeholder.key,
+    context.renderOptions,
+    context.page.site.name,
+    context.mode
+  );
+
+  if (data == null) return null;
+
+  return (
+    <Placeholder name={placeholder.key} content={data.page} context={context} />
+  );
+}