@webstudio-is/sdk 0.145.0 → 0.151.0

package/lib/index.js

@@ -71,8 +71,7 @@ var commonPageFields = {
     ).optional()
   }),
   rootInstanceId: z2.string(),
-  // @todo make required after releasing migration
-  systemDataSourceId: z2.optional(z2.string())
+  systemDataSourceId: z2.string()
 };
 var HomePagePath = z2.string().refine((path) => path === "", "Home page path must be empty");
 var HomePage = z2.object({
@@ -99,11 +98,15 @@ var Page = z2.object({
 var ProjectMeta = z2.object({
   // All fields are optional to ensure consistency and allow for the addition of new fields without requiring migration
   siteName: z2.string().optional(),
+  contactEmail: z2.string().optional(),
   faviconAssetId: z2.string().optional(),
   code: z2.string().optional()
 });
 var ProjectNewRedirectPath = PagePath.or(
   z2.string().refine((data) => {
+    if (data === "/") {
+      return true;
+    }
     try {
       new URL(data);
       return true;
@@ -238,6 +241,8 @@ var ResourceRequest = z5.object({
   body: z5.optional(z5.unknown())
 });
 var Resources = z5.map(ResourceId, Resource);
+var LOCAL_RESOURCE_PREFIX = "$resources";
+var isLocalResource = (pathname, resourceName) => pathname.split("/").filter(Boolean).join("/") === `${LOCAL_RESOURCE_PREFIX}/${resourceName}`;
 
 // src/schema/props.ts
 import { z as z6 } from "zod";
@@ -451,133 +456,6 @@ var parseComponentName = (componentName) => {
   return [namespace, name];
 };
 
-// src/page-utils.ts
-var ROOT_FOLDER_ID = "root";
-var isRoot = (folder) => folder.id === ROOT_FOLDER_ID;
-var findPageByIdOrPath = (idOrPath, pages) => {
-  if (idOrPath === "" || idOrPath === "/" || idOrPath === pages.homePage.id) {
-    return pages.homePage;
-  }
-  return pages.pages.find(
-    (page) => page.id === idOrPath || getPagePath(page.id, pages) === idOrPath
-  );
-};
-var findParentFolderByChildId = (id, folders) => {
-  for (const folder of folders) {
-    if (folder.children.includes(id)) {
-      return folder;
-    }
-  }
-};
-var getPagePath = (id, pages) => {
-  const foldersMap = /* @__PURE__ */ new Map();
-  const childParentMap = /* @__PURE__ */ new Map();
-  for (const folder of pages.folders) {
-    foldersMap.set(folder.id, folder);
-    for (const childId of folder.children) {
-      childParentMap.set(childId, folder.id);
-    }
-  }
-  const paths = [];
-  let currentId = id;
-  const allPages = [pages.homePage, ...pages.pages];
-  for (const page of allPages) {
-    if (page.id === id) {
-      paths.push(page.path);
-      currentId = childParentMap.get(page.id);
-      break;
-    }
-  }
-  while (currentId) {
-    const folder = foldersMap.get(currentId);
-    if (folder === void 0) {
-      break;
-    }
-    paths.push(folder.slug);
-    currentId = childParentMap.get(currentId);
-  }
-  return paths.reverse().join("/").replace(/\/+/g, "/");
-};
-
-// src/scope.ts
-var normalizeName = (name) => {
-  name = name.replaceAll(/[^\w$]/g, "");
-  if (name.length === 0) {
-    return "_";
-  }
-  if (/[A-Za-z_$]/.test(name[0]) === false) {
-    name = `_${name}`;
-  }
-  return name;
-};
-var createScope = (occupiedIdentifiers = []) => {
-  const freeIndexByPreferredName = /* @__PURE__ */ new Map();
-  const scopedNameByIdMap = /* @__PURE__ */ new Map();
-  for (const identifier of occupiedIdentifiers) {
-    freeIndexByPreferredName.set(identifier, 1);
-  }
-  const getName = (id, preferredName) => {
-    const cachedName = scopedNameByIdMap.get(id);
-    if (cachedName !== void 0) {
-      return cachedName;
-    }
-    preferredName = normalizeName(preferredName);
-    const index = freeIndexByPreferredName.get(preferredName);
-    freeIndexByPreferredName.set(preferredName, (index ?? 0) + 1);
-    let scopedName = preferredName;
-    if (index !== void 0) {
-      scopedName = `${preferredName}_${index}`;
-    }
-    scopedNameByIdMap.set(id, scopedName);
-    return scopedName;
-  };
-  return {
-    getName
-  };
-};
-
-// src/resource-loader.ts
-var loadResource = async (resourceData) => {
-  const { url, method, headers, body } = resourceData;
-  const requestHeaders = new Headers(
-    headers.map(({ name, value }) => [name, value])
-  );
-  const requestInit = {
-    method,
-    headers: requestHeaders
-  };
-  if (method !== "get" && body !== void 0) {
-    if (typeof body === "string") {
-      requestInit.body = body;
-    }
-    if (typeof body === "object") {
-      requestInit.body = JSON.stringify(body);
-    }
-  }
-  try {
-    const response = await fetch(url.trim(), requestInit);
-    let data;
-    if (response.ok && // accept json by default and when specified explicitly
-    (requestHeaders.has("accept") === false || requestHeaders.get("accept") === "application/json")) {
-      data = await response.json();
-    } else {
-      data = await response.text();
-    }
-    return {
-      data,
-      status: response.status,
-      statusText: response.statusText
-    };
-  } catch (error) {
-    const message = error.message;
-    return {
-      data: void 0,
-      status: 500,
-      statusText: message
-    };
-  }
-};
-
 // src/expression.ts
 import { parseExpressionAt } from "acorn";
 import { simple } from "acorn-walk";
@@ -816,6 +694,142 @@ var executeExpression = (expression) => {
   }
 };
 
+// src/page-utils.ts
+var ROOT_FOLDER_ID = "root";
+var isRoot = (folder) => folder.id === ROOT_FOLDER_ID;
+var findPageByIdOrPath = (idOrPath, pages) => {
+  if (idOrPath === "" || idOrPath === "/" || idOrPath === pages.homePage.id) {
+    return pages.homePage;
+  }
+  return pages.pages.find(
+    (page) => page.id === idOrPath || getPagePath(page.id, pages) === idOrPath
+  );
+};
+var findParentFolderByChildId = (id, folders) => {
+  for (const folder of folders) {
+    if (folder.children.includes(id)) {
+      return folder;
+    }
+  }
+};
+var getPagePath = (id, pages) => {
+  const foldersMap = /* @__PURE__ */ new Map();
+  const childParentMap = /* @__PURE__ */ new Map();
+  for (const folder of pages.folders) {
+    foldersMap.set(folder.id, folder);
+    for (const childId of folder.children) {
+      childParentMap.set(childId, folder.id);
+    }
+  }
+  const paths = [];
+  let currentId = id;
+  const allPages = [pages.homePage, ...pages.pages];
+  for (const page of allPages) {
+    if (page.id === id) {
+      paths.push(page.path);
+      currentId = childParentMap.get(page.id);
+      break;
+    }
+  }
+  while (currentId) {
+    const folder = foldersMap.get(currentId);
+    if (folder === void 0) {
+      break;
+    }
+    paths.push(folder.slug);
+    currentId = childParentMap.get(currentId);
+  }
+  return paths.reverse().join("/").replace(/\/+/g, "/");
+};
+var getStaticSiteMapXml = (pages, updatedAt) => {
+  const allPages = [pages.homePage, ...pages.pages];
+  return allPages.filter(
+    (page) => executeExpression(page.meta.excludePageFromSearch) !== true
+  ).map((page) => ({
+    path: getPagePath(page.id, pages),
+    lastModified: updatedAt.split("T")[0]
+  }));
+};
+
+// src/scope.ts
+var normalizeName = (name) => {
+  name = name.replaceAll(/[^\w$]/g, "");
+  if (name.length === 0) {
+    return "_";
+  }
+  if (/[A-Za-z_$]/.test(name[0]) === false) {
+    name = `_${name}`;
+  }
+  return name;
+};
+var createScope = (occupiedIdentifiers = []) => {
+  const freeIndexByPreferredName = /* @__PURE__ */ new Map();
+  const scopedNameByIdMap = /* @__PURE__ */ new Map();
+  for (const identifier of occupiedIdentifiers) {
+    freeIndexByPreferredName.set(identifier, 1);
+  }
+  const getName = (id, preferredName) => {
+    const cachedName = scopedNameByIdMap.get(id);
+    if (cachedName !== void 0) {
+      return cachedName;
+    }
+    preferredName = normalizeName(preferredName);
+    const index = freeIndexByPreferredName.get(preferredName);
+    freeIndexByPreferredName.set(preferredName, (index ?? 0) + 1);
+    let scopedName = preferredName;
+    if (index !== void 0) {
+      scopedName = `${preferredName}_${index}`;
+    }
+    scopedNameByIdMap.set(id, scopedName);
+    return scopedName;
+  };
+  return {
+    getName
+  };
+};
+
+// src/resource-loader.ts
+var loadResource = async (customFetch, resourceData) => {
+  const { url, method, headers, body } = resourceData;
+  const requestHeaders = new Headers(
+    headers.map(({ name, value }) => [name, value])
+  );
+  const requestInit = {
+    method,
+    headers: requestHeaders
+  };
+  if (method !== "get" && body !== void 0) {
+    if (typeof body === "string") {
+      requestInit.body = body;
+    }
+    if (typeof body === "object") {
+      requestInit.body = JSON.stringify(body);
+    }
+  }
+  try {
+    const response = await customFetch(url.trim(), requestInit);
+    let data;
+    if (response.ok && // accept json by default and when specified explicitly
+    (requestHeaders.has("accept") === false || requestHeaders.get("accept") === "application/json")) {
+      data = await response.json();
+    } else {
+      data = await response.text();
+    }
+    return {
+      data,
+      status: response.status,
+      statusText: response.statusText
+    };
+  } catch (error) {
+    const message = error.message;
+    return {
+      data: void 0,
+      status: 500,
+      statusText: message
+    };
+  }
+};
+
 // src/forms-generator.ts
 var generateFormsProperties = (props) => {
   const formsProperties = /* @__PURE__ */ new Map();
@@ -861,7 +875,7 @@ var generateResourcesLoader = ({
       const resourceName = scope.getName(resource.id, dataSource.name);
       generatedOutput += `${resourceName},
 `;
-      generatedLoaders += `loadResource({
+      generatedLoaders += `loadResource(customFetch, {
 `;
       generatedLoaders += `id: "${resource.id}",
 `;
@@ -923,12 +937,32 @@ var generateResourcesLoader = ({
     }
   }
   let generated = "";
-  generated += `import { loadResource, type System } from "@webstudio-is/sdk";
+  generated += `import { loadResource, isLocalResource, type System } from "@webstudio-is/sdk";
 `;
+  if (hasResources) {
+    generated += `import { sitemap } from "./[sitemap.xml]";
+`;
+  }
   generated += `export const loadResources = async (_props: { system: System }) => {
 `;
   generated += generatedVariables;
   if (hasResources) {
+    generated += `
+    const customFetch: typeof fetch = (input, init) => {
+      if (typeof input !== "string") {
+        return fetch(input, init);
+      }
+
+      if (isLocalResource(input, "sitemap.xml")) {
+        // @todo: dynamic import sitemap ???
+        const response = new Response(JSON.stringify(sitemap));
+        response.headers.set('content-type',  'application/json; charset=utf-8');
+        return Promise.resolve(response);
+      }
+
+      return fetch(input, init);
+    };
+    `;
     generated += `const [
 `;
     generated += generatedOutput;
@@ -1148,9 +1182,11 @@ export {
   generateResourcesLoader,
   getExpressionIdentifiers,
   getPagePath,
+  getStaticSiteMapXml,
   getStyleDeclKey,
   initialBreakpoints,
   isLiteralExpression,
+  isLocalResource,
   isRoot,
   lintExpression,
   loadResource,

package/lib/types/page-utils.d.ts

@@ -16,3 +16,7 @@ export declare const findParentFolderByChildId: (id: Folder["id"] | Page["id"],
  * Get a path from all folder slugs from root to the current folder or page.
  */
 export declare const getPagePath: (id: Folder["id"] | Page["id"], pages: Pages) => string;
+export declare const getStaticSiteMapXml: (pages: Pages, updatedAt: string) => {
+    path: string;
+    lastModified: string;
+}[];

package/lib/types/resource-loader.d.ts

@@ -1,5 +1,5 @@
 import type { ResourceRequest } from "./schema/resources";
-export declare const loadResource: (resourceData: ResourceRequest) => Promise<{
+export declare const loadResource: (customFetch: typeof fetch, resourceData: ResourceRequest) => Promise<{
     data: any;
     status: number;
     statusText: string;

package/lib/types/schema/pages.d.ts

@@ -2,6 +2,7 @@ import { z } from "zod";
 export type System = {
     params: Record<string, string | undefined>;
     search: Record<string, string | undefined>;
+    origin: string;
 };
 export declare const FolderName: z.ZodEffects<z.ZodString, string, string>;
 export declare const Folder: z.ZodObject<{
@@ -77,7 +78,7 @@ declare const Page: z.ZodObject<{
         }[] | undefined;
     }>;
     rootInstanceId: z.ZodString;
-    systemDataSourceId: z.ZodOptional<z.ZodString>;
+    systemDataSourceId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     path: string;
     id: string;
@@ -98,7 +99,7 @@ declare const Page: z.ZodObject<{
     };
     title: string;
     rootInstanceId: string;
-    systemDataSourceId?: string | undefined;
+    systemDataSourceId: string;
 }, {
     path: string;
     id: string;
@@ -119,18 +120,21 @@ declare const Page: z.ZodObject<{
     };
     title: string;
     rootInstanceId: string;
-    systemDataSourceId?: string | undefined;
+    systemDataSourceId: string;
 }>;
 declare const ProjectMeta: z.ZodObject<{
     siteName: z.ZodOptional<z.ZodString>;
+    contactEmail: z.ZodOptional<z.ZodString>;
     faviconAssetId: z.ZodOptional<z.ZodString>;
     code: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     siteName?: string | undefined;
+    contactEmail?: string | undefined;
     faviconAssetId?: string | undefined;
     code?: string | undefined;
 }, {
     siteName?: string | undefined;
+    contactEmail?: string | undefined;
     faviconAssetId?: string | undefined;
     code?: string | undefined;
 }>;
@@ -162,14 +166,17 @@ export type Page = z.infer<typeof Page>;
 export declare const Pages: z.ZodObject<{
     meta: z.ZodOptional<z.ZodObject<{
         siteName: z.ZodOptional<z.ZodString>;
+        contactEmail: z.ZodOptional<z.ZodString>;
         faviconAssetId: z.ZodOptional<z.ZodString>;
         code: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         siteName?: string | undefined;
+        contactEmail?: string | undefined;
         faviconAssetId?: string | undefined;
         code?: string | undefined;
     }, {
         siteName?: string | undefined;
+        contactEmail?: string | undefined;
         faviconAssetId?: string | undefined;
         code?: string | undefined;
     }>>;
@@ -245,7 +252,7 @@ export declare const Pages: z.ZodObject<{
             }[] | undefined;
         }>;
         rootInstanceId: z.ZodString;
-        systemDataSourceId: z.ZodOptional<z.ZodString>;
+        systemDataSourceId: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         path: string;
         id: string;
@@ -266,7 +273,7 @@ export declare const Pages: z.ZodObject<{
         };
         title: string;
         rootInstanceId: string;
-        systemDataSourceId?: string | undefined;
+        systemDataSourceId: string;
     }, {
         path: string;
         id: string;
@@ -287,7 +294,7 @@ export declare const Pages: z.ZodObject<{
         };
         title: string;
         rootInstanceId: string;
-        systemDataSourceId?: string | undefined;
+        systemDataSourceId: string;
     }>;
     pages: z.ZodArray<z.ZodObject<{
         path: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, string, string>, string, string>, string, string>, string, string>, string, string>;
@@ -341,7 +348,7 @@ export declare const Pages: z.ZodObject<{
             }[] | undefined;
         }>;
         rootInstanceId: z.ZodString;
-        systemDataSourceId: z.ZodOptional<z.ZodString>;
+        systemDataSourceId: z.ZodString;
     }, "strip", z.ZodTypeAny, {
         path: string;
         id: string;
@@ -362,7 +369,7 @@ export declare const Pages: z.ZodObject<{
         };
         title: string;
         rootInstanceId: string;
-        systemDataSourceId?: string | undefined;
+        systemDataSourceId: string;
     }, {
         path: string;
         id: string;
@@ -383,7 +390,7 @@ export declare const Pages: z.ZodObject<{
         };
         title: string;
         rootInstanceId: string;
-        systemDataSourceId?: string | undefined;
+        systemDataSourceId: string;
     }>, "many">;
     folders: z.ZodEffects<z.ZodArray<z.ZodObject<{
         id: z.ZodString;
@@ -432,7 +439,7 @@ export declare const Pages: z.ZodObject<{
         };
         title: string;
         rootInstanceId: string;
-        systemDataSourceId?: string | undefined;
+        systemDataSourceId: string;
     };
     pages: {
         path: string;
@@ -454,7 +461,7 @@ export declare const Pages: z.ZodObject<{
         };
         title: string;
         rootInstanceId: string;
-        systemDataSourceId?: string | undefined;
+        systemDataSourceId: string;
     }[];
     folders: {
         id: string;
@@ -464,6 +471,7 @@ export declare const Pages: z.ZodObject<{
     }[];
     meta?: {
         siteName?: string | undefined;
+        contactEmail?: string | undefined;
         faviconAssetId?: string | undefined;
         code?: string | undefined;
     } | undefined;
@@ -496,7 +504,7 @@ export declare const Pages: z.ZodObject<{
         };
         title: string;
         rootInstanceId: string;
-        systemDataSourceId?: string | undefined;
+        systemDataSourceId: string;
     };
     pages: {
         path: string;
@@ -518,7 +526,7 @@ export declare const Pages: z.ZodObject<{
         };
         title: string;
         rootInstanceId: string;
-        systemDataSourceId?: string | undefined;
+        systemDataSourceId: string;
     }[];
     folders: {
         id: string;
@@ -528,6 +536,7 @@ export declare const Pages: z.ZodObject<{
     }[];
     meta?: {
         siteName?: string | undefined;
+        contactEmail?: string | undefined;
         faviconAssetId?: string | undefined;
         code?: string | undefined;
     } | undefined;

package/lib/types/schema/resources.d.ts

@@ -113,3 +113,7 @@ export declare const Resources: z.ZodMap<z.ZodString, z.ZodObject<{
     body?: string | undefined;
 }>>;
 export type Resources = z.infer<typeof Resources>;
+/**
+ * Prevents fetch cycles by prefixing local resources.
+ */
+export declare const isLocalResource: (pathname: string, resourceName: string) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webstudio-is/sdk",
-  "version": "0.145.0",
+  "version": "0.151.0",
   "description": "Webstudio project data schema",
   "author": "Webstudio <github@webstudio.is>",
   "homepage": "https://webstudio.is",
@@ -22,8 +22,8 @@
     "acorn-walk": "^8.3.2",
     "type-fest": "^4.3.1",
     "zod": "^3.22.4",
-    "@webstudio-is/css-engine": "0.145.0",
-    "@webstudio-is/fonts": "0.145.0"
+    "@webstudio-is/css-engine": "0.151.0",
+    "@webstudio-is/fonts": "0.151.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",