@sanity/workbench 0.1.0-alpha.6 → 0.1.0-alpha.8

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

@@ -0,0 +1,125 @@
+// eslint-disable-next-line no-restricted-imports
+import type { ApplicationResource as ProtocolApplicationResource } from "@sanity/message-protocol";
+import { afterEach, describe, expect, it, vi } from "vitest";
+
+import { APPLICATION_DATA } from "../__tests__/__fixtures__";
+import type { CoreAppUserApplication } from "./core-app";
+import { UserApplication as AbstractUserApplication } from "./user-application";
+
+class UserApplication extends AbstractUserApplication<
+  CoreAppUserApplication,
+  "coreApp",
+  ProtocolApplicationResource
+> {
+  constructor(application: CoreAppUserApplication) {
+    super(application, "coreApp");
+  }
+
+  get title(): string {
+    return this.application.title;
+  }
+
+  get subtitle() {
+    return undefined;
+  }
+
+  get href(): string {
+    return "";
+  }
+
+  toProtocolResource() {
+    return {
+      ...this.application,
+      type: "application",
+      url: this.url.toString(),
+    } as const;
+  }
+}
+
+const setup = (overrides?: Partial<CoreAppUserApplication>) =>
+  new UserApplication({
+    ...APPLICATION_DATA,
+    ...overrides,
+  } as CoreAppUserApplication);
+
+describe("UserApplication", () => {
+  afterEach(() => {
+    vi.unstubAllEnvs();
+  });
+
+  it("should generate a url for an internal application", () => {
+    vi.stubEnv("VITE_SANITY_ENV", "staging");
+    vi.stubEnv("VITE_SANITY_DOMAIN", "sanity.work");
+    const application = setup();
+    expect(application.url).toBeInstanceOf(URL);
+    expect(application.url.toString()).toMatchInlineSnapshot(
+      `"https://x7apsmr6fxvc.studio.sanity.work/"`,
+    );
+  });
+
+  it("should respect the SANITY_ENV", () => {
+    vi.stubEnv("VITE_SANITY_ENV", "production");
+    const application = setup();
+    expect(application.url).toBeInstanceOf(URL);
+    expect(application.url.toString()).toMatchInlineSnapshot(
+      `"https://x7apsmr6fxvc.sanity.studio/"`,
+    );
+  });
+
+  it("should generate a url for an external application", () => {
+    const application = setup({
+      ...APPLICATION_DATA,
+      activeDeployment: null,
+      appHost: "https://my-app.com",
+      urlType: "external",
+    });
+    expect(application.url).toBeInstanceOf(URL);
+    expect(application.url.toString()).toMatchInlineSnapshot(
+      `"https://my-app.com/"`,
+    );
+  });
+
+  describe("initials", () => {
+    const initials = (title: string) => setup({ title }).initials;
+
+    it("should return the initials of a name", () => {
+      expect(initials("John Doe")).toBe("JD");
+    });
+
+    it("should return the initials of a name with extra spaces", () => {
+      expect(initials("  John   Doe  ")).toBe("JD");
+    });
+
+    it("should return intials even if the name is only one word", () => {
+      expect(initials("John")).toBe("J");
+    });
+
+    it("should return a maximum of two initials", () => {
+      expect(initials("John Doe Smith")).toBe("JS");
+    });
+
+    it("should handle empty string", () => {
+      expect(initials("")).toBe("");
+    });
+
+    it("should handle symbols-only string", () => {
+      expect(initials("@#$%")).toBe("");
+    });
+
+    it("should handle a single character", () => {
+      expect(initials("A")).toBe("A");
+    });
+
+    it("should handle strings containing numbers", () => {
+      expect(initials("0xHoldings")).toBe("0X");
+      expect(initials("7-Eleven")).toBe("7E");
+      expect(initials("Forever 21")).toBe("F2");
+      expect(initials("Motel 6")).toBe("M6");
+      expect(initials("2 Wire")).toBe("2W");
+
+      expect(initials("010101")).toBe("01");
+      expect(initials("W4t")).toBe("W4");
+      expect(initials("H4xx0r")).toBe("H4");
+    });
+  });
+});

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

@@ -0,0 +1,107 @@
+// eslint-disable-next-line no-restricted-imports
+import type { Resource as ProtocolResource } from "@sanity/message-protocol";
+import { z } from "zod";
+
+import {
+  AbstractApplication,
+  type AbstractApplicationType,
+} from "../applications/application";
+
+/**
+ * User application ID schema, branded for type safety.
+ * @public
+ */
+export const UserApplicationId = z
+  .string()
+  .nonempty()
+  .brand("UserApplicationId");
+
+/**
+ * User application ID type, branded for type safety.
+ * @public
+ */
+export type UserApplicationId = z.output<typeof UserApplicationId>;
+
+/**
+ * Validates and brands a string as a UserApplicationId.
+ * @public
+ */
+export function brandUserApplicationId(id: string): UserApplicationId {
+  return UserApplicationId.parse(id);
+}
+
+/**
+ * @public
+ */
+export const UserApplicationBase = z.object({
+  id: UserApplicationId,
+  appHost: z.string(),
+  urlType: z.enum(["internal", "external"]),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+  dashboardStatus: z.enum(["default", "disabled"]),
+});
+
+/**
+ * @public
+ */
+export type UserApplicationBase = z.output<typeof UserApplicationBase>;
+
+/**
+ * @public
+ */
+export const ActiveDeployment = z.object({
+  id: z.string(),
+  version: z.string(),
+  isActiveDeployment: z.boolean(),
+  userApplicationId: z.string(),
+  isAutoUpdating: z.boolean(),
+  size: z.number(),
+  deployedAt: z.string(),
+  deployedBy: z.string(),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+});
+
+/**
+ * @internal
+ */
+export abstract class UserApplication<
+  TUserApplication extends UserApplicationBase,
+  TType extends Extract<AbstractApplicationType, "coreApp" | "studio">,
+  TProtocolResource extends ProtocolResource = Extract<
+    ProtocolResource,
+    { type: TType }
+  >,
+> extends AbstractApplication<TType, TProtocolResource> {
+  readonly application: TUserApplication;
+
+  readonly id: UserApplicationId;
+
+  constructor(application: TUserApplication, type: TType) {
+    super(type);
+    this.application = application;
+    this.id = brandUserApplicationId(application.id);
+  }
+
+  abstract get subtitle(): string | undefined;
+
+  /**
+   * @returns A fully resolved URL instance for the application.
+   * For internal applications, constructs a URL using the Sanity studio domain
+   * pattern resolved from the environment at the consuming app's build time.
+   * For external applications, returns the provided app host as a URL.
+   */
+  get url(): URL {
+    if (this.application.urlType === "internal") {
+      if (import.meta.env.VITE_SANITY_ENV === "production") {
+        return new URL(`https://${this.application.appHost}.sanity.studio`);
+      }
+      return new URL(
+        `https://${this.application.appHost}.studio.${import.meta.env.VITE_SANITY_DOMAIN}`,
+      );
+    }
+
+    return new URL(this.application.appHost);
+  }
+}

package/src/vite-env.d.ts

@@ -0,0 +1,8 @@
+interface ImportMetaEnv {
+  readonly VITE_SANITY_ENV: "production" | "staging";
+  readonly VITE_SANITY_DOMAIN: "sanity.work" | "sanity.io";
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}

package/dist/log.d.ts

@@ -1,48 +0,0 @@
-/**
- * @public
- */
-export declare function createLogger({
-  namespace,
-  context: baseContext,
-  logLevel,
-}?: LoggerOptions): Logger;
-
-declare type LogContext = {
-  [key: string]: unknown;
-};
-
-/**
- * @public
- */
-export declare interface Logger {
-  error: (message: string, context?: LogContext) => void;
-  warn: (message: string, context?: LogContext) => void;
-  info: (message: string, context?: LogContext) => void;
-  debug: (message: string, context?: LogContext) => void;
-}
-
-declare interface LoggerOptions {
-  namespace?: LogNamespace;
-  context?: LogContext;
-  logLevel?: LogLevel;
-}
-
-/**
- * Log levels in order of verbosity (least to most)
- * - none: Silent
- * - error: Critical failures that prevent operation
- * - warn: Issues that may cause problems but don't stop execution
- * - info: High-level informational messages (default)
- * - debug: Detailed debugging information (maintainer level)
- * - trace: Very detailed tracing — sets `internal: true` on context
- * @public
- */
-export declare type LogLevel = "none" | "error" | "warn" | "info" | "debug";
-
-/**
- * Namespaces organize logs by functional domain.
- * @internal
- */
-export declare type LogNamespace = string;
-
-export {};

package/dist/log.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"log.js","sources":["../src/log/index.ts"],"sourcesContent":["/**\n * Log levels in order of verbosity (least to most)\n * - none: Silent\n * - error: Critical failures that prevent operation\n * - warn: Issues that may cause problems but don't stop execution\n * - info: High-level informational messages (default)\n * - debug: Detailed debugging information (maintainer level)\n * - trace: Very detailed tracing — sets `internal: true` on context\n * @public\n */\nexport type LogLevel = \"none\" | \"error\" | \"warn\" | \"info\" | \"debug\";\n\n/**\n * Namespaces organize logs by functional domain.\n * @internal\n */\nexport type LogNamespace = string;\n\ntype LogContext = { [key: string]: unknown };\n\n/**\n * @public\n */\nexport interface Logger {\n  error: (message: string, context?: LogContext) => void;\n  warn: (message: string, context?: LogContext) => void;\n  info: (message: string, context?: LogContext) => void;\n  debug: (message: string, context?: LogContext) => void;\n}\n\nconst LEVELS: readonly LogLevel[] = [\"none\", \"error\", \"warn\", \"info\", \"debug\"];\n\ninterface LoggerOptions {\n  namespace?: LogNamespace;\n  context?: LogContext;\n  logLevel?: LogLevel;\n}\n\n/**\n * @public\n */\nexport function createLogger({\n  namespace,\n  context: baseContext,\n  logLevel = \"info\",\n}: LoggerOptions = {}): Logger {\n  function isLevelEnabled(level: LogLevel): boolean {\n    return LEVELS.indexOf(level) <= LEVELS.indexOf(logLevel);\n  }\n\n  function logAtLevel(\n    level: LogLevel,\n    message: string,\n    context?: LogContext,\n  ): void {\n    if (!isLevelEnabled(level)) return;\n\n    const merged =\n      (baseContext ?? context) ? { ...baseContext, ...context } : undefined;\n    const args: unknown[] = [\n      ...(namespace ? [`[${namespace}]`] : []),\n      message,\n      ...(merged ? [merged] : []),\n    ];\n\n    if (level === \"error\") console.error(...args);\n    else if (level === \"warn\") console.warn(...args);\n    // oxlint-disable-next-line no-console\n    else if (level === \"info\") console.info(...args);\n    // oxlint-disable-next-line no-console\n    else console.debug(...args);\n  }\n\n  return {\n    error: (message, context) => logAtLevel(\"error\", message, context),\n    warn: (message, context) => logAtLevel(\"warn\", message, context),\n    info: (message, context) => logAtLevel(\"info\", message, context),\n    debug: (message, context) => logAtLevel(\"debug\", message, context),\n  };\n}\n"],"names":[],"mappings":"AA8BA,MAAM,SAA8B,CAAC,QAAQ,SAAS,QAAQ,QAAQ,OAAO;AAWtE,SAAS,aAAa;AAAA,EAC3B;AAAA,EACA,SAAS;AAAA,EACT,WAAW;AACb,IAAmB,IAAY;AAC7B,WAAS,eAAe,OAA0B;AAChD,WAAO,OAAO,QAAQ,KAAK,KAAK,OAAO,QAAQ,QAAQ;AAAA,EACzD;AAEA,WAAS,WACP,OACA,SACA,SACM;AACN,QAAI,CAAC,eAAe,KAAK,EAAG;AAE5B,UAAM,SACH,eAAe,UAAW,EAAE,GAAG,aAAa,GAAG,QAAA,IAAY,QACxD,OAAkB;AAAA,MACtB,GAAI,YAAY,CAAC,IAAI,SAAS,GAAG,IAAI,CAAA;AAAA,MACrC;AAAA,MACA,GAAI,SAAS,CAAC,MAAM,IAAI,CAAA;AAAA,IAAC;AAGvB,cAAU,UAAS,QAAQ,MAAM,GAAG,IAAI,IACnC,UAAU,SAAQ,QAAQ,KAAK,GAAG,IAAI,IAEtC,UAAU,SAAQ,QAAQ,KAAK,GAAG,IAAI,IAE1C,QAAQ,MAAM,GAAG,IAAI;AAAA,EAC5B;AAEA,SAAO;AAAA,IACL,OAAO,CAAC,SAAS,YAAY,WAAW,SAAS,SAAS,OAAO;AAAA,IACjE,MAAM,CAAC,SAAS,YAAY,WAAW,QAAQ,SAAS,OAAO;AAAA,IAC/D,MAAM,CAAC,SAAS,YAAY,WAAW,QAAQ,SAAS,OAAO;AAAA,IAC/D,OAAO,CAAC,SAAS,YAAY,WAAW,SAAS,SAAS,OAAO;AAAA,EAAA;AAErE;"}

package/src/_exports/log.ts

@@ -1 +0,0 @@
-export * from "../log";