@alpaca-headless/alpaca-headless-nextjs 0.0.3 → 1.0.13

package/types/fieldTypes.d.ts

@@ -1,3 +1,65 @@
-export type TextField = {
+import { Field } from "./layoutData";
+export type TextField = Field & {
     value: string;
 };
+export type PictureField = Field & {
+    value: PictureValue | null;
+};
+export type LinkField = Field & {
+    value: LinkValue;
+};
+export type PictureValue = {
+    name: string;
+    alt: string;
+    variants: PictureVariant[];
+    loopVideos: boolean;
+};
+export type PictureVariant = {
+    name: string;
+    src: string;
+    videoUrl: string;
+    width: number;
+    mediaId: string;
+    aspectRatioText?: string;
+};
+export type ImageField = Field & {
+    value: ImageValue | null;
+};
+export type ImageValue = {
+    altText: string;
+    src: string;
+};
+export type LinkValue = {
+    url: string;
+};
+export interface KeyValuePair {
+    key: string;
+    value: string;
+}
+export type EnhancedNameValueListField = {
+    value: KeyValuePair[];
+};
+export interface MediaItemImageFields {
+    alt: string;
+    width: string;
+    height: string;
+}
+export interface EnhancedTreeListFieldItem {
+    url: string;
+    fields: MediaItemImageFields | null;
+}
+export type EnhancedTreeListField = {
+    value: EnhancedTreeListFieldItem[];
+};
+export type CheckboxField = {
+    value: boolean;
+};
+export type DateField = {
+    value: DateFieldValue;
+};
+export type DateFieldValue = {
+    date: string;
+};
+export type NumberField = {
+    value: number;
+};

package/types/graphQLTypes.d.ts

@@ -0,0 +1,24 @@
+export type SitecoreItem = {
+    id: string;
+    name: string;
+    key: string;
+    template: Template;
+    fields: Field[];
+    children: SitecoreItem[];
+    parentId: string;
+    url: string;
+    versionsCount: number;
+};
+export type Template = {
+    id: string;
+    name: string;
+};
+export type Field = {
+    name: string;
+    value: string;
+    jsonValue: Value;
+    targetItems: SitecoreItem[];
+};
+export type Value = {
+    value: any;
+};

package/types/index.d.ts

@@ -1,3 +1,7 @@
 export * from "./layoutData";
 export * from "./loadRouteData";
 export * from "./components";
+export * from "./alpacaContext";
+export * from "./fieldTypes";
+export * from "./editor";
+export * as GraphQLTypes from "./graphQLTypes";

package/types/layoutData.d.ts

@@ -1,11 +1,66 @@
 export type PlaceholderData = {
     name: string;
+    key: string;
     components: ComponentData[];
+    insertOptions?: {
+        id: string;
+        name: string;
+        icon: string;
+    }[];
 };
+export type Field = {
+    id: string;
+    name: string;
+    itemId: string;
+    language: string;
+    version: number;
+    path: string;
+    type: string;
+    containsFallbackValue?: boolean;
+    value: unknown;
+    jsonValue?: Field;
+    valueInheritedFrom?: {
+        description: string;
+    };
+    section?: string;
+    displayName?: string;
+    sortOrder?: number;
+    sectionSortOrder?: number;
+};
+export interface Fields {
+    [name: string]: Field;
+}
 export type ComponentData = {
     name: string;
+    id: string;
+    linkItemId: string;
+    templateId: string;
     componentType: string;
-    graphql: object;
+    graphql: any;
+    graphql_query: string;
     placeholders: PlaceholderData[];
     type: "component";
+    fields: Fields;
+    translations?: string[];
+    hostingPageItem?: {
+        id: string;
+        language: string;
+        version: number;
+        path: string;
+        editUrl: string;
+    };
+    linkedComponentItem: {
+        language: string;
+        version: number;
+        path: string;
+    };
+};
+export type LanguageVersions = {
+    languageCode: string;
+    countryCode: string;
+    name: string;
+    versions: number;
+};
+export type Dictionary = {
+    [key: string]: string;
 };

package/types/loadRouteData.d.ts

@@ -1,4 +1,4 @@
-import { PlaceholderData } from "./layoutData";
+import { Fields, PlaceholderData } from "./layoutData";
 type Response = {
     type: "page" | "redirect" | "error" | "notfound";
 };
@@ -7,9 +7,41 @@ export type Error = Response & {
     message: string;
     errorCode: number;
 };
+export type Language = {
+    name: string;
+    versions: number;
+};
+export type Version = {
+    version: number;
+    updated: Date;
+    updatedBy: string;
+};
 export type Page = Response & {
     type: "page";
+    editing?: boolean;
     placeholders: PlaceholderData[];
+    language: string;
+    version: number;
+    languages: Language[];
+    versions: Version[];
+    id: string;
+    name: string;
+    path: string;
+    idPath: 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;
+    translations: string[];
 };
 export type Redirect = Response & {
     type: "redirect";
@@ -20,5 +52,5 @@ export type NotFound = Response & {
 };
 export declare function loadRouteData(params: {
     path: string[];
-}, host: string): Promise<Page | Error | Redirect | NotFound>;
+}, searchParams: any, host: string): Promise<Page | Error | Redirect | NotFound>;
 export {};

package/types/mediaProtection.d.ts

@@ -0,0 +1,2 @@
+import "url";
+export declare function hashImageUrl(url: string): string;

package/types/AlpacaHeadless.d.ts

@@ -1,37 +0,0 @@
-export type PlaceholderData = {
-    name: string;
-    components: ComponentData[];
-};
-export type ComponentData = {
-    name: string;
-    componentType: string;
-    graphql: object;
-    placeholders: PlaceholderData[];
-    type: "component";
-};
-type Response = {
-    type: "page" | "redirect" | "error" | "notfound";
-};
-export type Error = Response & {
-    type: "error";
-    message: string;
-    errorCode: number;
-};
-export type Page = Response & {
-    type: "page";
-    placeholders: PlaceholderData[];
-};
-export type Redirect = Response & {
-    type: "redirect";
-    location: string;
-};
-export type NotFound = Response & {
-    type: "notfound";
-};
-export type TextField = {
-    value: string;
-};
-export declare function loadRouteData(params: {
-    path: string[];
-}): Promise<Page | Error | Redirect | NotFound>;
-export {};