@webstudio-is/http-client 0.1.1 → 0.3.0

package/lib/index.d.ts

@@ -1,7 +1,22 @@
-import type { Includes, Project } from "./index.d";
-export declare const loadProject: ({ apiUrl, projectId, include, }: {
+import type { BaseInstance, UserProp } from "@webstudio-is/react-sdk";
+import type { Breakpoint } from "@webstudio-is/css-data";
+export declare type Page = {
+    id: string;
+    root: [string, string];
+};
+export declare type Project = {
+    pages: {
+        [path: string]: {
+            page: Page;
+            tree: BaseInstance;
+            props: Array<UserProp> | [];
+            breakpoints: Array<Breakpoint> | null;
+            css: string;
+        };
+    };
+};
+export declare const loadProject: ({ apiUrl, projectId, }: {
     apiUrl: string;
     projectId: string;
-    include?: Includes<boolean> | undefined;
-}) => Promise<Project>;
+}) => Promise<Project | string>;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEnD,eAAO,MAAM,WAAW;YAKd,MAAM;eACH,MAAM;;MAEf,QAAQ,OAAO,CAmBlB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAEzD,oBAAY,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACxB,CAAC;AACF,oBAAY,OAAO,GAAG;IACpB,KAAK,EAAE;QACL,CAAC,IAAI,EAAE,MAAM,GAAG;YACd,IAAI,EAAE,IAAI,CAAC;YACX,IAAI,EAAE,YAAY,CAAC;YACnB,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YAC5B,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;YACtC,GAAG,EAAE,MAAM,CAAC;SACb,CAAC;KACH,CAAC;CACH,CAAC;AAEF,eAAO,MAAM,WAAW;YAId,MAAM;eACH,MAAM;MACf,QAAQ,OAAO,GAAG,MAAM,CAmB3B,CAAC"}

package/lib/index.js

@@ -5,23 +5,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadProject = void 0;
 const isomorphic_fetch_1 = __importDefault(require("isomorphic-fetch"));
-const loadProject = async ({ apiUrl, projectId, include = { tree: true, props: true, breakpoints: true }, }) => {
-    if (apiUrl === undefined) {
-        throw new Error("Webstudio API URL is required.");
+const loadProject = async ({ apiUrl, projectId, }) => {
+    try {
+        if (apiUrl === undefined) {
+            throw new Error("Webstudio API URL is required.");
+        }
+        const baseUrl = new URL(apiUrl);
+        const projectUrl = new URL(`/rest/project/${projectId}`, baseUrl);
+        const projectResponse = await (0, isomorphic_fetch_1.default)(projectUrl);
+        const project = await projectResponse.json();
+        if (!projectResponse.ok) {
+            throw new Error(project);
+        }
+        return project;
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            return error.message;
+        }
+        throw error;
     }
-    const baseUrl = new URL(`${apiUrl}`);
-    const treeUrl = new URL(`/rest/tree/${projectId}`, baseUrl);
-    const propsUrl = new URL(`/rest/props/${projectId}`, baseUrl);
-    const breakpointsUrl = new URL(`/rest/breakpoints/${projectId}`, baseUrl);
-    const [tree, props, breakpoints] = await Promise.all([
-        include.tree && (await (0, isomorphic_fetch_1.default)(treeUrl)).json(),
-        include.props && (await (0, isomorphic_fetch_1.default)(propsUrl)).json(),
-        include.breakpoints && (await (0, isomorphic_fetch_1.default)(breakpointsUrl)).json(),
-    ]);
-    return {
-        tree,
-        props,
-        breakpoints,
-    };
 };
 exports.loadProject = loadProject;

package/lib/index.test.js

@@ -1,22 +1,50 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const index_1 = require("./index");
-const existingProjectId = "ab3619d3-831f-46f8-abb6-609558cffd99";
+const existingProjectId = "675e8af3-48fa-4b18-9ebf-fd2b128865e2";
 const notPublishedProjectId = "7ec397c6-b3d0-4967-9073-9d83623fcf8e";
+const onlyHomeProjectId = "36d6c16f-04a0-45d4-ab1d-aa0ab61eb5b6";
+const morePagesProjectId = existingProjectId;
 const apiUrl = "http://localhost:3000";
 describe("getProjectDetails", () => {
+    test("include pages", async () => {
+        const response = await (0, index_1.loadProject)({
+            apiUrl,
+            projectId: morePagesProjectId,
+        });
+        if (response instanceof Error) {
+            throw response;
+        }
+        if (typeof response === "object") {
+            return expect(Object.keys(response.pages).length > 1).toBeTruthy();
+        }
+        throw new Error("Unexpected response");
+    });
+    test("does not include pages", async () => {
+        const response = await (0, index_1.loadProject)({
+            apiUrl,
+            projectId: onlyHomeProjectId,
+        });
+        if (response instanceof Error) {
+            throw response;
+        }
+        if (typeof response === "object") {
+            return expect(Object.keys(response.pages).length === 1).toBeTruthy();
+        }
+        throw new Error("Unexpected response");
+    });
     test("loads existing project", async () => {
         const response = await (0, index_1.loadProject)({
             apiUrl,
             projectId: existingProjectId,
         });
-        expect(response.tree.id).toBeTruthy();
+        expect(response).toBeTruthy();
     });
     test("loads not published project", async () => {
         const response = await (0, index_1.loadProject)({
             apiUrl,
             projectId: notPublishedProjectId,
         });
-        expect(response.tree.errors).toBe("Project 7ec397c6-b3d0-4967-9073-9d83623fcf8e needs to be published first");
+        expect(response.toString()).toBe(`Project ${notPublishedProjectId} not found or not published yet. Please contact us to get help.`);
     });
 });

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@webstudio-is/http-client",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Webstudio HTTP Client",
   "author": "Webstudio <github@webstudio.is>",
   "homepage": "https://webstudio.is",
   "scripts": {
-    "dev": "tsup src/index.ts --format esm,cjs --watch --out-dir=lib",
+    "dev": "tsup --watch",
     "test": "jest",
-    "build": "rm -fr lib && tsc",
+    "build": "rm -fr lib tsconfig.tsbuildinfo && tsc",
     "typecheck": "tsc --noEmit",
     "lint": "eslint ./src --ext .ts,.tsx --max-warnings 0",
     "checks": "yarn typecheck && yarn lint"
@@ -32,5 +32,13 @@
     "!*.test.*"
   ],
   "license": "MIT",
-  "private": false
+  "private": false,
+  "sideEffects": false,
+  "tsup": {
+    "entry": [
+      "src/index.ts"
+    ],
+    "format": "cjs",
+    "outDir": "lib"
+  }
 }