@micacms/runtime 0.4.1 → 0.5.0-rc.1

package/dist/services/staging.d.ts

@@ -1,174 +1,42 @@
 /**
- * Content staging: the orchestration between "saved" and "published".
- *
- * Two implementations of one service, because the two deployment shapes have
- * genuinely different draft workspaces:
- *
- *   - working tree  (`staging-local.ts`): the checkout is the draft. Autosave
- *     writes files the Astro dev server can hot-reload, which is the whole
- *     value of local mode; Recent changes is `git status`, and Publish is a
- *     real commit and push through the developer's own Git.
- *   - draft store   (this file): the repository is remote and writing through
- *     its API would already be a commit, so saves accumulate in SQLite and
- *     Publish turns the whole set into one provider-side commit.
- *
- * The editor sees one API either way. What differs is only what Saved means —
- * and the two must stay visibly different words in the UI, because in neither
- * mode does Saved imply that a change is in Git.
+ * The staging service on a Git working tree. Autosave has already written the
+ * files; Publish commits the reviewed paths.
+ *
+ *   - Every Git operation is limited to an explicit path set, so other work in
+ *     the same checkout is never swept in.
+ *   - Only the reviewed files are published, as the editor saw them. Drafts of
+ *     other entries stay drafts.
+ *   - When the push fails, the commit stays as `committed-pending-push`; a
+ *     retry pushes and never commits again.
  */
-import type { Author, RepositoryConnector } from "@micacms/connectors";
-import { type ContentChange, type ContentSource, type DraftStore, type FieldIssue, type PublishResult, type Site } from "@micacms/core";
-/** Where the change happened, in words an editor recognises. */
-export type ChangeOwner = {
-    kind: "entry";
-    collection: string;
-    slug: string;
-    label: string;
-    /** The slug before a pending rename. Set on the files of both slugs. */
-    renamedFrom?: string;
-} | {
-    kind: "singleton";
-    name: string;
-    label: string;
-} | {
-    kind: "order";
-    collection: string;
-    label: string;
-} | {
-    kind: "media";
-    label: string;
-} | {
-    kind: "other";
-    label: string;
-};
-export interface AnnotatedChange extends ContentChange {
-    owner: ChangeOwner;
-}
-/** One thing that would make the staged result unpublishable. */
-export interface StagingProblem {
-    /** The file the problem is about, relative to the content root. */
-    path: string;
-    label: string;
-    issues: FieldIssue[];
-}
-export interface StagingValidation {
-    ok: boolean;
-    problems: StagingProblem[];
-}
-export interface StagingStatus {
-    /** How this deployment stages. The UI words differ with it. */
-    workspace: "working-tree" | "draft-store";
-    publish: {
-        enabled: boolean;
-        reason?: string;
-    };
+import { type Site } from "@micacms/core";
+import type { Logger } from "../lib/logger.js";
+import type { ContentFiles } from "../workspace/files.js";
+import { type WorkspaceLocks } from "../workspace/locks.js";
+import type { OwnerPolicy } from "../workspace/policy.js";
+import { type GitTree } from "../workspace/tree.js";
+import { type ContentStagingService } from "./changes.js";
+export interface WorkingTreeStagingDeps {
+    model: Site;
     /**
-     * What the pending changes are based on: HEAD for a working tree, the
-     * branch head for a draft store. Sent back with Publish as `expectedBase`.
+     * The working tree's files without the lock wrapper: this service holds the
+     * locks around whole operations.
      */
-    baseRevision: string | null;
-    /** The branch a publication lands on, where the workspace knows it. */
-    branch: string | null;
-    /** Commits created and not yet pushed. Working tree only. */
-    ahead: number | null;
-    changes: AnnotatedChange[];
-    validation: StagingValidation;
-    /** When the pending set last moved. Null when nothing is pending. */
-    updatedAt: string | null;
-}
-export interface PublishInput {
-    /** Subject line of the commit. Written by the editor, for `git log`. */
-    message: string;
-    /** The base the editor reviewed. A repository that moved past it refuses. */
-    expectedBase: string | null;
-    author?: Author;
-}
-export interface ContentStagingService {
-    status(): Promise<StagingStatus>;
-    publish(input: PublishInput): Promise<PublishResult>;
-    discard(paths: string[]): Promise<{
-        discarded: string[];
-    }>;
-    /** Retries the push after `committed-pending-push`. Working tree only. */
-    push(): Promise<PublishResult>;
-    /** The document a pending change touches, before and after that change. */
-    compare(target: CompareTarget): Promise<Comparison>;
-}
-/** One thing an editor recognises on the Publish page, named for comparison. */
-export type CompareTarget = 
-/** `from` names the published slug of a renamed entry. */
-{
-    kind: "entry";
-    collection: string;
-    slug: string;
-    from?: string;
-} | {
-    kind: "singleton";
-    name: string;
-} | {
-    kind: "order";
-    collection: string;
-};
-/**
- * A document on both sides of the pending change set.
- *
- * Raw field data, deliberately: the editor holds the model and can name,
- * order and render every field, so the friendly comparison is its job. What
- * only the server can do is read the same document from two places.
- */
-export interface Comparison {
-    /** As the repository has it — null when the change creates the document. */
-    before: Record<string, unknown> | null;
-    /** As staged for publication — null when the change deletes it. */
-    after: Record<string, unknown> | null;
-}
-/**
- * Reads one document from the repository (`published`) and from the pending
- * workspace (`staged`) — the whole of a before/after comparison, shared by
- * both staging implementations since a `ContentSource` is all it needs.
- *
- * An order target compares the collection's ordering rather than a document:
- * each side becomes `{ order: [{ slug, title }] }`, in position order.
- */
-export declare function compareSources(model: Site, published: ContentSource, staged: ContentSource, target: CompareTarget): Promise<Comparison>;
-/**
- * Annotates a change set with owners and validates the entries it touches.
- *
- * One pass on purpose: naming a change and validating it both need the same
- * read of the same entries, and content trees are small enough to read the
- * affected collections whole.
- *
- * Validation is scoped to *changed* documents. Content that was already in
- * the repository is not this publication's problem — refusing
- * to publish a fixed typo because somebody once hand-committed a broken entry
- * elsewhere would make the editor hostage to history it cannot touch.
- */
-export declare function analyseChanges(model: Site, source: ContentSource, changes: ContentChange[], 
-/** The repository's side. When given, renamed entries are detected. */
-published?: ContentSource): Promise<{
-    changes: AnnotatedChange[];
-    validation: StagingValidation;
-}>;
-/**
- * Which piece of content a file belongs to.
- *
- * The path layout is the model's own (`layout.ts`), so this is a reading of
- * it, not a second convention: `collection/slug/…` or `collection/slug.json`,
- * `singleton.json` or `singleton/…`, and the shared `media/` directory.
- */
-export declare function classifyPath(model: Site, path: string): ChangeOwner;
-export interface DraftStagingDeps {
-    model: Site;
-    drafts: DraftStore;
-    /** The real repository. The one thing here that writes to it. */
-    repository: RepositoryConnector;
-    /** The staged overlay the rest of the application reads through. */
-    overlay: RepositoryConnector;
-    /** Revision of `.mica/schema.json` when the model was loaded. */
+    files: ContentFiles;
+    contentRoot: string;
     schemaRevision: string | null;
+    /** `MICA_LOCAL_PUBLISH`, for the default developer policy. */
+    publishEnabled: boolean;
+    logger: Logger;
+    /** Defaults to the developer. */
+    policy?: OwnerPolicy;
+    /** Shared with the services that write content. */
+    locks?: WorkspaceLocks;
+    /**
+     * Set by a managed clone, whose Git runs in an isolated environment. Without
+     * it, the developer's Git finds the tree.
+     */
+    tree?: GitTree;
 }
-export declare function createDraftStagingService(deps: DraftStagingDeps): ContentStagingService;
-export declare function describeProblems(problems: StagingProblem[]): string;
-/** Field issues with the file path folded in, for the flat API envelope. */
-export declare function flattenProblems(problems: StagingProblem[]): FieldIssue[];
+export declare function createWorkingTreeStagingService(deps: WorkingTreeStagingDeps): ContentStagingService;
 //# sourceMappingURL=staging.d.ts.map

package/dist/services/staging.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"staging.d.ts","sourceRoot":"","sources":["../../src/services/staging.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAU,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAgBL,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,KAAK,IAAI,EACV,MAAM,eAAe,CAAC;AAIvB,gEAAgE;AAChE,MAAM,MAAM,WAAW,GACnB;IACE,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,wEAAwE;IACxE,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACD;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACpD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAErC,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACpD,KAAK,EAAE,WAAW,CAAC;CACpB;AAED,iEAAiE;AACjE,MAAM,WAAW,cAAc;IAC7B,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,UAAU,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,OAAO,CAAC;IACZ,QAAQ,EAAE,cAAc,EAAE,CAAC;CAC5B;AAED,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,SAAS,EAAE,cAAc,GAAG,aAAa,CAAC;IAC1C,OAAO,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/C;;;OAGG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,uEAAuE;IACvE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,6DAA6D;IAC7D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,qEAAqE;IACrE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB,6EAA6E;IAC7E,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IACjC,OAAO,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACrD,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC,CAAC;IAC3D,0EAA0E;IAC1E,IAAI,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC;IAC/B,2EAA2E;IAC3E,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACrD;AAED,gFAAgF;AAChF,MAAM,MAAM,aAAa;AACvB,0DAA0D;AACxD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAClE;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACnC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1C;;;;;;GAMG;AACH,MAAM,WAAW,UAAU;IACzB,4EAA4E;IAC5E,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACvC,mEAAmE;IACnE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CACvC;AAED;;;;;;;GAOG;AACH,wBAAsB,cAAc,CAClC,KAAK,EAAE,IAAI,EACX,SAAS,EAAE,aAAa,EACxB,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,aAAa,GACpB,OAAO,CAAC,UAAU,CAAC,CAuCrB;AAMD;;;;;;;;;;;GAWG;AACH,wBAAsB,cAAc,CAClC,KAAK,EAAE,IAAI,EACX,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,aAAa,EAAE;AACxB,uEAAuE;AACvE,SAAS,CAAC,EAAE,aAAa,GACxB,OAAO,CAAC;IAAE,OAAO,EAAE,eAAe,EAAE,CAAC;IAAC,UAAU,EAAE,iBAAiB,CAAA;CAAE,CAAC,CAyGxE;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,GAAG,WAAW,CAoCnE;AAgLD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,IAAI,CAAC;IACZ,MAAM,EAAE,UAAU,CAAC;IACnB,iEAAiE;IACjE,UAAU,EAAE,mBAAmB,CAAC;IAChC,oEAAoE;IACpE,OAAO,EAAE,mBAAmB,CAAC;IAC7B,iEAAiE;IACjE,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,gBAAgB,GAAG,qBAAqB,CA2HvF;AAID,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,cAAc,EAAE,GAAG,MAAM,CAInE;AAED,4EAA4E;AAC5E,wBAAgB,eAAe,CAAC,QAAQ,EAAE,cAAc,EAAE,GAAG,UAAU,EAAE,CAOxE"}
+{"version":3,"file":"staging.d.ts","sourceRoot":"","sources":["../../src/services/staging.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAmD,KAAK,IAAI,EAAE,MAAM,eAAe,CAAC;AAG3F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D,OAAO,EAAwB,KAAK,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAClF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EASL,KAAK,OAAO,EAEb,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAQL,KAAK,qBAAqB,EAK3B,MAAM,cAAc,CAAC;AAEtB,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,IAAI,CAAC;IACZ;;;OAGG;IACH,KAAK,EAAE,YAAY,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,8DAA8D;IAC9D,cAAc,EAAE,OAAO,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,mDAAmD;IACnD,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,wBAAgB,+BAA+B,CAC7C,IAAI,EAAE,sBAAsB,GAC3B,qBAAqB,CA8OvB"}