@webstudio-is/sdk 0.124.0 → 0.125.0

package/lib/index.js

@@ -32,13 +32,26 @@ var Assets = z.map(AssetId, Asset);
 // src/schema/pages.ts
 import { z as z2 } from "zod";
 var MIN_TITLE_LENGTH = 2;
+var PageId = z2.string();
+var FolderId = z2.string();
+var FolderName = z2.string().refine((value) => value.trim() !== "", "Can't be empty");
+var FolderSlug = z2.string().refine((slug) => slug !== "", "Can't be empty").refine((slug) => slug.includes("/") === false, "Can't contain a /").refine(
+  (path) => /^[-a-z0-9]*$/.test(path),
+  "Only a-z, 0-9 and - are allowed"
+);
+var Folder = z2.object({
+  id: FolderId,
+  name: FolderName,
+  slug: z2.string(),
+  children: z2.array(z2.union([FolderId, PageId]))
+});
 var PageName = z2.string().refine((value) => value.trim() !== "", "Can't be empty");
 var PageTitle = z2.string().refine(
   (val) => val.length >= MIN_TITLE_LENGTH,
   `Minimum ${MIN_TITLE_LENGTH} characters required`
 );
 var commonPageFields = {
-  id: z2.string(),
+  id: PageId,
   name: PageName,
   title: PageTitle,
   meta: z2.object({
@@ -95,26 +108,31 @@ var Pages = z2.object({
   pages: z2.array(Page).refine(
     (array) => new Set(array.map((page) => page.path)).size === array.length,
     "All paths must be unique"
-  )
+  ),
+  folders: z2.array(Folder).refine((folders) => folders.length > 0, "Folders can't be empty")
 });
 
 // src/schema/instances.ts
 import { z as z3 } from "zod";
-var Text = z3.object({
+var TextChild = z3.object({
   type: z3.literal("text"),
   value: z3.string()
 });
 var InstanceId = z3.string();
-var Id = z3.object({
+var IdChild = z3.object({
   type: z3.literal("id"),
   value: InstanceId
 });
+var ExpressionChild = z3.object({
+  type: z3.literal("expression"),
+  value: z3.string()
+});
 var Instance = z3.object({
   type: z3.literal("instance"),
   id: InstanceId,
   component: z3.string(),
   label: z3.string().optional(),
-  children: z3.array(z3.union([Id, Text]))
+  children: z3.array(z3.union([IdChild, TextChild, ExpressionChild]))
 });
 var Instances = z3.map(InstanceId, Instance);
 
@@ -463,9 +481,13 @@ export {
   DataSourceVariableValue,
   DataSources,
   Deployment,
+  ExpressionChild,
+  Folder,
+  FolderName,
+  FolderSlug,
   FontAsset,
   HomePagePath,
-  Id,
+  IdChild,
   ImageAsset,
   ImageMeta,
   Instance,
@@ -484,7 +506,7 @@ export {
   StyleSourceSelections,
   StyleSources,
   Styles,
-  Text,
+  TextChild,
   createScope,
   findTreeInstanceIds,
   findTreeInstanceIdsExcludingSlotDescendants,

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

@@ -2,27 +2,33 @@ import type { Instance } from "./schema/instances";
 export declare const findTreeInstanceIds: (instances: Map<string, {
     type: "instance";
     id: string;
-    component: string;
     children: ({
         value: string;
         type: "text";
     } | {
         value: string;
         type: "id";
+    } | {
+        value: string;
+        type: "expression";
     })[];
+    component: string;
     label?: string | undefined;
 }>, rootInstanceId: Instance["id"]) => Set<string>;
 export declare const findTreeInstanceIdsExcludingSlotDescendants: (instances: Map<string, {
     type: "instance";
     id: string;
-    component: string;
     children: ({
         value: string;
         type: "text";
     } | {
         value: string;
         type: "id";
+    } | {
+        value: string;
+        type: "expression";
     })[];
+    component: string;
     label?: string | undefined;
 }>, rootInstanceId: Instance["id"]) => Set<string>;
 export declare const parseComponentName: (componentName: string) => readonly [string | undefined, string];

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

@@ -1,5 +1,5 @@
 import { z } from "zod";
-export declare const Text: z.ZodObject<{
+export declare const TextChild: z.ZodObject<{
     type: z.ZodLiteral<"text">;
     value: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -9,8 +9,8 @@ export declare const Text: z.ZodObject<{
     value: string;
     type: "text";
 }>;
-export type Text = z.infer<typeof Text>;
-export declare const Id: z.ZodObject<{
+export type TextChild = z.infer<typeof TextChild>;
+export declare const IdChild: z.ZodObject<{
     type: z.ZodLiteral<"id">;
     value: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -20,7 +20,18 @@ export declare const Id: z.ZodObject<{
     value: string;
     type: "id";
 }>;
-export type Id = z.infer<typeof Id>;
+export type IdChild = z.infer<typeof IdChild>;
+export declare const ExpressionChild: z.ZodObject<{
+    type: z.ZodLiteral<"expression">;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    type: "expression";
+}, {
+    value: string;
+    type: "expression";
+}>;
+export type ExpressionChild = z.infer<typeof ExpressionChild>;
 export declare const Instance: z.ZodObject<{
     type: z.ZodLiteral<"instance">;
     id: z.ZodString;
@@ -44,30 +55,45 @@ export declare const Instance: z.ZodObject<{
     }, {
         value: string;
         type: "text";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"expression">;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: "expression";
+    }, {
+        value: string;
+        type: "expression";
     }>]>, "many">;
 }, "strip", z.ZodTypeAny, {
     type: "instance";
     id: string;
-    component: string;
     children: ({
         value: string;
         type: "text";
     } | {
         value: string;
         type: "id";
+    } | {
+        value: string;
+        type: "expression";
     })[];
+    component: string;
     label?: string | undefined;
 }, {
     type: "instance";
     id: string;
-    component: string;
     children: ({
         value: string;
         type: "text";
     } | {
         value: string;
         type: "id";
+    } | {
+        value: string;
+        type: "expression";
     })[];
+    component: string;
     label?: string | undefined;
 }>;
 export type Instance = z.infer<typeof Instance>;
@@ -94,30 +120,45 @@ export declare const Instances: z.ZodMap<z.ZodString, z.ZodObject<{
     }, {
         value: string;
         type: "text";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"expression">;
+        value: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        type: "expression";
+    }, {
+        value: string;
+        type: "expression";
     }>]>, "many">;
 }, "strip", z.ZodTypeAny, {
     type: "instance";
     id: string;
-    component: string;
     children: ({
         value: string;
         type: "text";
     } | {
         value: string;
         type: "id";
+    } | {
+        value: string;
+        type: "expression";
     })[];
+    component: string;
     label?: string | undefined;
 }, {
     type: "instance";
     id: string;
-    component: string;
     children: ({
         value: string;
         type: "text";
     } | {
         value: string;
         type: "id";
+    } | {
+        value: string;
+        type: "expression";
     })[];
+    component: string;
     label?: string | undefined;
 }>>;
 export type Instances = z.infer<typeof Instances>;

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

@@ -1,4 +1,23 @@
 import { z } from "zod";
+export declare const FolderName: z.ZodEffects<z.ZodString, string, string>;
+export declare const FolderSlug: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>;
+export declare const Folder: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodEffects<z.ZodString, string, string>;
+    slug: z.ZodString;
+    children: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodString]>, "many">;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    id: string;
+    slug: string;
+    children: string[];
+}, {
+    name: string;
+    id: string;
+    slug: string;
+    children: string[];
+}>;
+export type Folder = z.infer<typeof Folder>;
 export declare const PageName: z.ZodEffects<z.ZodString, string, string>;
 export declare const PageTitle: z.ZodEffects<z.ZodString, string, string>;
 export declare const HomePagePath: z.ZodEffects<z.ZodString, string, string>;
@@ -301,6 +320,32 @@ export declare const Pages: z.ZodObject<{
         rootInstanceId: string;
         pathVariableId?: string | undefined;
     }[]>;
+    folders: z.ZodEffects<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodEffects<z.ZodString, string, string>;
+        slug: z.ZodString;
+        children: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodString]>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        slug: string;
+        children: string[];
+    }, {
+        name: string;
+        id: string;
+        slug: string;
+        children: string[];
+    }>, "many">, {
+        name: string;
+        id: string;
+        slug: string;
+        children: string[];
+    }[], {
+        name: string;
+        id: string;
+        slug: string;
+        children: string[];
+    }[]>;
 }, "strip", z.ZodTypeAny, {
     homePage: {
         path: string;
@@ -338,6 +383,12 @@ export declare const Pages: z.ZodObject<{
         rootInstanceId: string;
         pathVariableId?: string | undefined;
     }[];
+    folders: {
+        name: string;
+        id: string;
+        slug: string;
+        children: string[];
+    }[];
     meta?: {
         siteName?: string | undefined;
         faviconAssetId?: string | undefined;
@@ -383,6 +434,12 @@ export declare const Pages: z.ZodObject<{
         rootInstanceId: string;
         pathVariableId?: string | undefined;
     }[];
+    folders: {
+        name: string;
+        id: string;
+        slug: string;
+        children: string[];
+    }[];
     meta?: {
         siteName?: string | undefined;
         faviconAssetId?: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webstudio-is/sdk",
-  "version": "0.124.0",
+  "version": "0.125.0",
   "description": "Webstudio project data schema",
   "author": "Webstudio <github@webstudio.is>",
   "homepage": "https://webstudio.is",
@@ -19,8 +19,8 @@
   "sideEffects": false,
   "dependencies": {
     "zod": "^3.21.4",
-    "@webstudio-is/css-engine": "0.124.0",
-    "@webstudio-is/fonts": "0.124.0"
+    "@webstudio-is/css-engine": "0.125.0",
+    "@webstudio-is/fonts": "0.125.0"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",