@sanity/workbench 0.1.0-alpha.5 → 0.1.0-alpha.7

package/src/core/user-applications/core-app.test.ts

@@ -0,0 +1,151 @@
+import type { ApplicationResource as ProtocolApplicationResource } from "@sanity/message-protocol";
+import { afterEach, describe, expect, expectTypeOf, it, vi } from "vitest";
+
+import { APPLICATION_DATA } from "../__tests__/__fixtures__";
+import { CoreAppApplication } from "./core-app";
+
+const setup = () => new CoreAppApplication(APPLICATION_DATA);
+
+describe("CoreAppApplication", () => {
+  afterEach(() => {
+    vi.unstubAllEnvs();
+  });
+  it("should have a type of coreApp", () => {
+    const application = setup();
+    expect(application.type).toBe("coreApp");
+  });
+
+  it("should have a href of <application>/<id>", () => {
+    const application = setup();
+    expect(application.href).toBe("/application/v27rvqtlp3lmdvcln6ey3lro");
+  });
+
+  it("should have a name of the application title", () => {
+    const application = setup();
+    expect(application.title).toBe("sdk-movie-list");
+  });
+
+  it("should have a updatedAt property", () => {
+    const application = setup();
+    expect(application.updatedAt).toBe("2025-03-27T19:00:32.792Z");
+  });
+
+  it("should have an activeDeployment property", () => {
+    const application = setup();
+    expect(application.activeDeployment).toMatchInlineSnapshot(`
+      {
+        "createdAt": "2025-03-27T19:07:21.038Z",
+        "deployedAt": "2025-03-27T19:07:21.082Z",
+        "deployedBy": "gwXueEBci",
+        "id": "dv3kz3fsl4aqha3parc8k391",
+        "isActiveDeployment": true,
+        "isAutoUpdating": false,
+        "manifest": null,
+        "size": 528292,
+        "updatedAt": "2025-03-27T19:07:21.082Z",
+        "userApplicationId": "v27rvqtlp3lmdvcln6ey3lro",
+        "version": "3.81.0",
+      }
+    `);
+  });
+
+  it("should implement the toProtocolResource method", () => {
+    vi.stubEnv("VITE_SANITY_ENV", "staging");
+    vi.stubEnv("VITE_SANITY_DOMAIN", "sanity.work");
+    const application = setup();
+    expect(application.toProtocolResource()).toMatchInlineSnapshot(`
+      {
+        "activeDeployment": {
+          "createdAt": "2025-03-27T19:07:21.038Z",
+          "deployedAt": "2025-03-27T19:07:21.082Z",
+          "deployedBy": "gwXueEBci",
+          "id": "dv3kz3fsl4aqha3parc8k391",
+          "isActiveDeployment": true,
+          "isAutoUpdating": false,
+          "manifest": null,
+          "size": 528292,
+          "updatedAt": "2025-03-27T19:07:21.082Z",
+          "userApplicationId": "v27rvqtlp3lmdvcln6ey3lro",
+          "version": "3.81.0",
+        },
+        "appHost": "x7apsmr6fxvc",
+        "createdAt": "2025-03-27T19:00:32.792Z",
+        "dashboardStatus": "default",
+        "id": "v27rvqtlp3lmdvcln6ey3lro",
+        "organizationId": "oSyH1iET5",
+        "projectId": null,
+        "title": "sdk-movie-list",
+        "type": "application",
+        "updatedAt": "2025-03-27T19:00:32.792Z",
+        "url": "https://x7apsmr6fxvc.studio.sanity.work/",
+        "urlType": "internal",
+      }
+    `);
+
+    expectTypeOf(
+      application.toProtocolResource(),
+    ).toEqualTypeOf<ProtocolApplicationResource>();
+  });
+
+  it("should return undefined for subtitle", () => {
+    const application = setup();
+    expect(application.subtitle).toBeUndefined();
+  });
+
+  describe("get", () => {
+    it("should throw when accessing a non-existent attribute", () => {
+      const application = setup();
+      expect(() =>
+        // @ts-expect-error - testing invalid attribute
+        application.get("nonExistent"),
+      ).toThrow(
+        "Attribute nonExistent does not exist on application v27rvqtlp3lmdvcln6ey3lro",
+      );
+    });
+  });
+
+  describe("manifest functionality", () => {
+    it("should use manifest from application when present", () => {
+      const applicationWithManifest = {
+        ...APPLICATION_DATA,
+        activeDeployment: {
+          ...APPLICATION_DATA.activeDeployment,
+          manifest: {
+            version: "1.0.0",
+            icon: "<svg>test-icon</svg>",
+            title: "Manifest Title",
+          },
+        },
+      };
+      const application = new CoreAppApplication(applicationWithManifest);
+      expect(application.title).toBe("Manifest Title");
+    });
+
+    it("should use manifest from activeDeployment when application manifest is not present", () => {
+      const applicationWithDeploymentManifest = {
+        ...APPLICATION_DATA,
+        activeDeployment: {
+          ...APPLICATION_DATA.activeDeployment,
+          manifest: {
+            version: "1.0.0",
+            icon: "<svg>deployment-icon</svg>",
+            title: "Deployment Title",
+          },
+        },
+      };
+      const application = new CoreAppApplication(
+        applicationWithDeploymentManifest,
+      );
+      expect(application.title).toBe("Deployment Title");
+    });
+
+    it("should allow you to get attributes from the application", () => {
+      const application = setup();
+
+      expect(application.get("title")).toBe("sdk-movie-list");
+      expect(application.get("urlType")).toBe("internal");
+      expect(application.get("appHost")).toBe("x7apsmr6fxvc");
+      expectTypeOf(application.get("appHost")).toEqualTypeOf<string>();
+    });
+  });
+});

package/src/core/user-applications/core-app.ts

@@ -0,0 +1,57 @@
+import type {
+  ApplicationResource as ProtocolApplicationResource,
+  CoreApplication,
+} from "@sanity/message-protocol";
+
+import { UserApplication } from "./user-application";
+
+/**
+ * @internal
+ */
+export class CoreAppApplication extends UserApplication<
+  CoreApplication,
+  "coreApp",
+  ProtocolApplicationResource
+> {
+  readonly activeDeployment: CoreApplication["activeDeployment"];
+
+  constructor(application: CoreApplication) {
+    super(application, "coreApp");
+
+    this.activeDeployment = application.activeDeployment;
+  }
+
+  get href() {
+    return `/application/${this.application.id}`;
+  }
+
+  get title() {
+    return this.activeDeployment?.manifest?.title ?? this.application.title;
+  }
+
+  get subtitle() {
+    return undefined;
+  }
+
+  get updatedAt() {
+    return this.application.updatedAt;
+  }
+
+  get<TKey extends keyof CoreApplication>(attr: TKey): CoreApplication[TKey] {
+    if (!(attr in this.application)) {
+      throw new Error(
+        `Attribute ${attr.toString()} does not exist on application ${this.application.id}`,
+      );
+    }
+
+    return this.application[attr];
+  }
+
+  toProtocolResource(): ProtocolApplicationResource {
+    return {
+      ...this.application,
+      type: "application",
+      url: this.url.toString(),
+    } satisfies ProtocolApplicationResource;
+  }
+}