@webiny/website-builder-sdk 6.4.12-beta.4 → 6.5.0-beta.0

package/index.js

@@ -8,6 +8,12 @@ export * from "./DocumentStore.js";
 export * from "./Logger.js";
 export * from "./FunctionConverter.js";
 export * from "./createInput.js";
+export * from "./contentEntry/resolveContentEntry.js";
+export * from "./contentEntry/ContentEntryCache.js";
+export * from "./contentEntry/ContentEntryBindingsResolver.js";
+export * from "./createComponent.js";
+export * from "./image/index.js";
+export * from "./asset/index.js";
 export * from "./MouseTracker.js";
 export * from "./ViewportManager.js";
 export * from "./messenger/Messenger.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@webiny/website-builder-sdk",
-	"version": "6.4.12-beta.4",
+	"version": "6.5.0-beta.0",
 	"type": "module",
 	"repository": {
 		"type": "git",
@@ -12,6 +12,7 @@
 	"author": "Pavel Denisjuk",
 	"license": "MIT",
 	"dependencies": {
+		"@webiny/sdk": "6.5.0-beta.0",
 		"csstype": "3.2.3",
 		"deep-equal": "2.2.3",
 		"deepmerge": "4.3.1",
@@ -20,8 +21,8 @@
 		"is-hotkey": "0.2.0",
 		"lodash": "4.18.1",
 		"matcher": "6.0.0",
-		"mobx": "7.0.3",
-		"nanoid": "6.0.1",
+		"mobx": "6.16.1",
+		"nanoid": "6.0.0",
 		"nanoid-dictionary": "5.0.0",
 		"pino": "10.3.1",
 		"pino-pretty": "13.1.3"
@@ -29,9 +30,9 @@
 	"devDependencies": {
 		"@types/deep-equal": "1.0.4",
 		"@types/is-hotkey": "0.1.10",
-		"@webiny/build-tools": "6.4.12-beta.4",
-		"typescript": "6.0.3",
-		"vitest": "5.0.1"
+		"@webiny/build-tools": "6.5.0-beta.0",
+		"typescript": "7.0.2",
+		"vitest": "4.1.10"
 	},
 	"publishConfig": {
 		"access": "public"

package/types.d.ts

@@ -231,6 +231,7 @@ export type DocumentElement = {
 export type SerializableCSSStyleDeclaration = {
     [K in keyof CssProperties]?: CssProperties[K];
 };
+export type DocumentCache = Record<string, unknown>;
 export type Document = {
     id: string;
     state: DocumentState;
@@ -240,6 +241,7 @@ export type Document = {
     metadata: DocumentMetadata;
     bindings: DocumentBindings;
     elements: ElementMap;
+    __cache?: DocumentCache;
 };
 export type PublicPage = Pick<Page, "id" | "version" | "properties" | "bindings" | "elements" | "extensions" | "metadata" | "state"> & {
     languagePaths: Record<string, string>;
@@ -448,6 +450,72 @@ export type RadioInput = BaseInput<string> & {
         value: string;
     }[];
 };
+export interface ContentEntryReference {
+    id: string;
+    modelId: string;
+}
+/**
+ * Query-mode configuration, declared by the component author. The editor then
+ * builds a query within these bounds (see `ContentEntryQueryValue`).
+ */
+/**
+ * A field the editor may sort by: a bare read-API sort key, or a key paired with
+ * a display label shown in the editor.
+ */
+export type ContentEntrySortField = string | {
+    field: string;
+    label?: string;
+};
+export interface ContentEntryQueryConfig {
+    /**
+     * Fields the editor may sort by (one at a time). Each `field` is a CMS read-API
+     * sort key — value fields as `values_<fieldId>` (e.g. `values_title`), meta
+     * fields bare (e.g. `createdOn`). Provide a `label` for a friendlier UI; a bare
+     * string uses the key as its label.
+     */
+    sort?: {
+        fields: ContentEntrySortField[];
+    };
+    /** Editor-configurable result limit, with an optional default and hard cap. */
+    limit?: {
+        default?: number;
+        max?: number;
+    };
+    /** Show a free-text search box (matches fullTextSearch-enabled fields). */
+    search?: boolean;
+    /** Enable "load more" pagination in the rendered component. */
+    pagination?: boolean;
+}
+/**
+ * The value stored for a query-mode input: the editor's chosen query.
+ * `modelId` identifies the CMS model so the frontend SDK can resolve the
+ * query without component manifests.
+ */
+export interface ContentEntryQueryValue {
+    modelId: string;
+    sort?: {
+        field: string;
+        order: "asc" | "desc";
+    };
+    limit?: number;
+    search?: string;
+}
+export type ContentEntryInput = BaseInput<ContentEntryReference | ContentEntryReference[] | ContentEntryQueryValue> & {
+    type: "contentEntry";
+    /**
+     * The content model(s) the editor may pick entries from. Author-fixed.
+     */
+    models: string[];
+    /**
+     * "manual" (default): the editor hand-picks entries (stored as references).
+     * "query": the editor configures a dynamic query on the fixed model.
+     */
+    mode?: "manual" | "query";
+    /**
+     * Query-mode configuration. Only used when `mode` is "query".
+     */
+    query?: ContentEntryQueryConfig;
+};
 export type ObjectInput = BaseInput<Record<string, any>> & {
     type: "object";
     fields: ComponentInput[];
@@ -456,7 +524,7 @@ export type CustomInput = BaseInput<any> & {
     type: string;
     fields: ComponentInput[];
 };
-export type ComponentInput = TextInput | LongTextInput | NumberInput | BooleanInput | ColorInput | FileInput | DateTimeInput | LexicalInput | SelectInput | RadioInput | TagsInput | ObjectInput | SlotInput | CustomInput;
+export type ComponentInput = TextInput | LongTextInput | NumberInput | BooleanInput | ColorInput | FileInput | DateTimeInput | LexicalInput | SelectInput | RadioInput | TagsInput | ObjectInput | SlotInput | ContentEntryInput | CustomInput;
 export type ManifestInputsArray<TInputs, TAllowChildren extends boolean> = TAllowChildren extends true ? {
     [K in Exclude<keyof TInputs, "children">]: InputFactory<K & string>;
 }[Exclude<keyof TInputs, "children">][] : {

package/dataProviders/queries.test.js

@@ -1,45 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { GET_PAGE_BY_PATH } from "./GET_PAGE_BY_PATH.js";
-import { GET_PAGE_BY_ID } from "./GET_PAGE_BY_ID.js";
-const getDataSelection = (query)=>{
-    const match = query.match(/data\s*\{([^}]*)\}/);
-    if (!match) throw new Error("Query has no `data` selection set.");
-    return match[1].split("\n").map((line)=>line.trim()).filter(Boolean);
-};
-describe("single-page queries", ()=>{
-    it.each([
-        [
-            "GET_PAGE_BY_PATH",
-            GET_PAGE_BY_PATH
-        ],
-        [
-            "GET_PAGE_BY_ID",
-            GET_PAGE_BY_ID
-        ]
-    ])("%s selects metadata", (_name, query)=>{
-        expect(getDataSelection(query)).toContain("metadata");
-    });
-    it.each([
-        [
-            "GET_PAGE_BY_PATH",
-            GET_PAGE_BY_PATH
-        ],
-        [
-            "GET_PAGE_BY_ID",
-            GET_PAGE_BY_ID
-        ]
-    ])("%s selects exactly the expected fields", (_name, query)=>{
-        expect(getDataSelection(query)).toEqual([
-            "id",
-            "version",
-            "properties",
-            "metadata",
-            "elements",
-            "bindings",
-            "extensions",
-            "languagePaths"
-        ]);
-    });
-});
-
-//# sourceMappingURL=queries.test.js.map

package/dataProviders/queries.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"dataProviders/queries.test.js","sources":["../../src/dataProviders/queries.test.ts"],"sourcesContent":["import { describe, it, expect } from \"vitest\";\nimport { GET_PAGE_BY_PATH } from \"./GET_PAGE_BY_PATH.js\";\nimport { GET_PAGE_BY_ID } from \"./GET_PAGE_BY_ID.js\";\n\n/**\n * Extracts the fields selected inside the `data { ... }` block of a single-page query.\n * The block is flat (all scalars), so matching up to the first closing brace is enough.\n */\nconst getDataSelection = (query: string): string[] => {\n    const match = query.match(/data\\s*\\{([^}]*)\\}/);\n    if (!match) {\n        throw new Error(\"Query has no `data` selection set.\");\n    }\n\n    return match[1]\n        .split(\"\\n\")\n        .map(line => line.trim())\n        .filter(Boolean);\n};\n\ndescribe(\"single-page queries\", () => {\n    // These assertions exist because a missing `metadata` field previously forced consumers\n    // to maintain a Yarn patch against the built SDK. Keep both queries selecting it.\n    it.each([\n        [\"GET_PAGE_BY_PATH\", GET_PAGE_BY_PATH],\n        [\"GET_PAGE_BY_ID\", GET_PAGE_BY_ID]\n    ])(\"%s selects metadata\", (_name, query) => {\n        expect(getDataSelection(query)).toContain(\"metadata\");\n    });\n\n    // `PublicPage` also declares `state`, which is not sourced from the API and so is\n    // deliberately absent from both queries.\n    it.each([\n        [\"GET_PAGE_BY_PATH\", GET_PAGE_BY_PATH],\n        [\"GET_PAGE_BY_ID\", GET_PAGE_BY_ID]\n    ])(\"%s selects exactly the expected fields\", (_name, query) => {\n        expect(getDataSelection(query)).toEqual([\n            \"id\",\n            \"version\",\n            \"properties\",\n            \"metadata\",\n            \"elements\",\n            \"bindings\",\n            \"extensions\",\n            \"languagePaths\"\n        ]);\n    });\n});\n"],"names":["getDataSelection","query","match","Error","line","Boolean","describe","it","GET_PAGE_BY_PATH","GET_PAGE_BY_ID","_name","expect"],"mappings":";;;AAQA,MAAMA,mBAAmB,CAACC;IACtB,MAAMC,QAAQD,MAAM,KAAK,CAAC;IAC1B,IAAI,CAACC,OACD,MAAM,IAAIC,MAAM;IAGpB,OAAOD,KAAK,CAAC,EAAE,CACV,KAAK,CAAC,MACN,GAAG,CAACE,CAAAA,OAAQA,KAAK,IAAI,IACrB,MAAM,CAACC;AAChB;AAEAC,SAAS,uBAAuB;IAG5BC,GAAG,IAAI,CAAC;QACJ;YAAC;YAAoBC;SAAiB;QACtC;YAAC;YAAkBC;SAAe;KACrC,EAAE,uBAAuB,CAACC,OAAOT;QAC9BU,OAAOX,iBAAiBC,QAAQ,SAAS,CAAC;IAC9C;IAIAM,GAAG,IAAI,CAAC;QACJ;YAAC;YAAoBC;SAAiB;QACtC;YAAC;YAAkBC;SAAe;KACrC,EAAE,0CAA0C,CAACC,OAAOT;QACjDU,OAAOX,iBAAiBC,QAAQ,OAAO,CAAC;YACpC;YACA;YACA;YACA;YACA;YACA;YACA;YACA;SACH;IACL;AACJ"}