@pygmalionjs/pygmalion 0.2.16 → 0.2.18

package/node/dev-mirror.mjs

@@ -114,6 +114,34 @@ function escapeRegExp(value) {
   return value.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 }
 
+/**
+ * Revisions the mirror can be repointed at: local branches first, then remote
+ * tracking branches. Listing them is what lets an editor offer a choice instead
+ * of asking for a ref string.
+ */
+export async function listSourceRefs(repoRoot, remote = 'origin') {
+  const format = '%(refname:short)%09%(objectname:short=8)%09%(refname)';
+  const read = async (...patterns) => {
+    const raw = await git(repoRoot, 'for-each-ref', `--format=${format}`, ...patterns);
+    if (!raw) return [];
+    return raw
+      .split('\n')
+      .map((line) => line.split('\t'))
+      .filter((parts) => parts.length === 3 && parts[0])
+      .map(([name, commit, fullName]) => ({ name, commit, fullName }));
+  };
+  const locals = (await read('refs/heads')).map((item) => ({ ...item, kind: 'local' }));
+  const remotes = (await read(`refs/remotes/${remote}`))
+    .filter((item) => !item.name.endsWith('/HEAD'))
+    .map((item) => ({ ...item, kind: 'remote' }));
+  const seen = new Set();
+  return [...locals, ...remotes].filter((item) => {
+    if (seen.has(item.name)) return false;
+    seen.add(item.name);
+    return true;
+  });
+}
+
 /**
  * Renders the current working tree, uncommitted changes included, instead of a
  * committed ref. Resolved to a throwaway commit at sync time.
@@ -673,6 +701,22 @@ export function pygmalionDevMirrorPlugin(options) {
           json(res, 200, status);
           return;
         }
+        if (url.pathname === `${control}/refs` && req.method === 'GET') {
+          try {
+            json(res, 200, {
+              refs: await listSourceRefs(repoRoot, remote),
+              sourceRef: ref,
+              defaultRef: `${remote}/${branch}`,
+              worktreeRef: PYGMALION_WORKTREE_SOURCE_REF,
+            });
+          } catch (error) {
+            json(res, 500, {
+              ok: false,
+              error: error instanceof Error ? error.message : String(error),
+            });
+          }
+          return;
+        }
         if (url.pathname === `${control}/refresh` && req.method === 'POST') {
           let requestedRef;
           try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pygmalionjs/pygmalion",
-  "version": "0.2.16",
+  "version": "0.2.18",
   "description": "Code-backed DOM design sandbox and visual QA editor",
   "license": "UNLICENSED",
   "publishConfig": {

package/types.d.ts

@@ -1545,6 +1545,39 @@ export interface PygmalionProjectRuntimeOptions {
   ) => string | undefined;
 }
 
+/** One revision the mirror can be repointed at. */
+export interface PygmalionSourceRef {
+  name: string;
+  commit: string;
+  fullName: string;
+  kind: 'local' | 'remote';
+}
+
+/** Revisions available to `switchSource`, listed from the mirror repository. */
+export interface PygmalionSourceRefs {
+  refs: readonly PygmalionSourceRef[];
+  /** Revision followed when none is pinned. */
+  defaultRef: string | null;
+  /** Ref that renders uncommitted work. */
+  worktreeRef: string | null;
+}
+
+export interface SourceRefControlProps {
+  value: string | null;
+  refs: readonly PygmalionSourceRef[];
+  onChange(ref: string): void;
+  busy?: boolean;
+  defaultRef?: string | null;
+  worktreeRef?: string | null;
+  label?: string;
+  /** Trigger content. Defaults to the selected revision. */
+  children?: ReactNode;
+  className?: string;
+}
+
+/** Selects the revision the dev mirror follows. Owned by Pygmalion, not by the host. */
+export declare function SourceRefControl(props: SourceRefControlProps): ReactElement;
+
 export interface PygmalionProjectRuntime {
   mirror: PygmalionDevMirrorStatus;
   session: PygmalionDesignSessionStatus | null;
@@ -1567,6 +1600,12 @@ export interface PygmalionProjectRuntime {
     sourceRef: string,
     options?: { discardEdits?: boolean },
   ): Promise<void>;
+  /**
+   * Revisions `switchSource` can be given. Empty until listed, so a host can
+   * offer a choice instead of asking for a ref string.
+   */
+  sourceRefs: PygmalionSourceRefs;
+  loadSourceRefs(): Promise<PygmalionSourceRefs>;
   previewVisual(payload: InspectApplyPayload): Promise<InspectPreviewResult>;
   inspectImpact(componentFiles: string[]): Promise<InspectImpactResult>;
   applyVisual(payload: InspectApplyPayload): Promise<InspectApplyResult>;