mechanica 2.0.2 → 2.0.3

package/dist/types/cli/platform/bundle-format.d.ts

@@ -0,0 +1,40 @@
+/**
+ * The bundle `mechanica push` uploads: the built `dist/` for one commit, as one
+ * request body.
+ *
+ *   "MCHB" | u32 LE header length | header JSON | the files' bytes, in header order
+ *   header = { format: 1, commit, engine, files: [ { path, size } ] }
+ *
+ * `commit` ties the bundle to the source it was built from; `engine` (this
+ * package's version) tells the platform which export code to render it with.
+ * Paths are relative to `dist/`, forward-slashed, sorted — the same build always
+ * produces the same header.
+ */
+export declare const BUNDLE_MAGIC = "MCHB";
+export declare const BUNDLE_FORMAT = 1;
+export interface BundleHeader {
+    format: typeof BUNDLE_FORMAT;
+    /** The full id of the commit the bundle was built from. */
+    commit: string;
+    /** The mechanica version that built it. */
+    engine: string;
+    files: {
+        path: string;
+        size: number;
+    }[];
+}
+/** Every file under `dir`, as forward-slashed paths relative to it, sorted. */
+export declare function listBundleFiles(dir: string): Promise<string[]>;
+/** Serialize already-read files into a bundle body. */
+export declare function encodeBundle(meta: {
+    commit: string;
+    engine: string;
+}, files: {
+    path: string;
+    data: Uint8Array;
+}[]): Uint8Array;
+/** Read a built `dist/` and pack it for upload. */
+export declare function packBundle(distDir: string, meta: {
+    commit: string;
+    engine: string;
+}): Promise<Uint8Array>;

package/dist/types/cli/platform/credentials.d.ts

@@ -0,0 +1,11 @@
+/** The hosted platform `mechanica login` / `link` / `push` talk to by default. */
+export declare const DEFAULT_HOST = "https://mechanica.jt3.ru";
+/** Normalize a host argument to an origin (`https://example.com`, no trailing slash or path). */
+export declare function hostOrigin(host: string | undefined): string;
+/**
+ * The access token for a platform origin: `MECHANICA_TOKEN` (CI) wins over the
+ * one `mechanica login` saved.
+ */
+export declare function getToken(origin: string): Promise<string | null>;
+/** Remember the token for an origin, in a file only the user can read. */
+export declare function saveToken(origin: string, token: string): Promise<string>;

package/dist/types/cli/platform/engine-version.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This package's version, read from its own `package.json` — found by walking
+ * up from this module, which sits at a different depth in `src/` and in the
+ * built `dist/` (and its chunks).
+ */
+export declare function engineVersion(): string;

package/dist/types/cli/platform/git.d.ts

@@ -0,0 +1,15 @@
+export interface GitResult {
+    code: number;
+    stdout: string;
+    stderr: string;
+}
+/**
+ * Environment that makes git send the access token to one origin only, as HTTP
+ * Basic credentials. Passed through `GIT_CONFIG_*` variables so the token never
+ * appears on a command line (visible to other processes) or in the repo config.
+ */
+export declare function gitAuthEnv(origin: string, token: string): Record<string, string>;
+/** Run git in `cwd` and collect its output; never throws on a non-zero exit. */
+export declare function git(cwd: string, args: string[], env?: Record<string, string>): Promise<GitResult>;
+/** Like {@link git}, but a non-zero exit throws with git's own message. */
+export declare function gitOk(cwd: string, args: string[], env?: Record<string, string>): Promise<string>;

package/dist/types/cli/platform/link.d.ts

@@ -0,0 +1,11 @@
+/**
+ * `mechanica link <slug>`: attach this project to a site on the platform by
+ * pointing the `mechanica` git remote at it. With `--create` the site is made
+ * first. The remote is the whole link — `mechanica push` reads the platform
+ * origin and the site from its URL, so there is no extra config file.
+ */
+export declare function runLink(slug: string | undefined, options: {
+    host?: string;
+    create?: boolean;
+    name?: string;
+}): Promise<void>;

package/dist/types/cli/platform/login.d.ts

@@ -0,0 +1,9 @@
+/**
+ * `mechanica login`: sign in to the platform and keep an access token for this
+ * machine. With `--token` the given token is stored as is (CI, or a token made
+ * in the dashboard); otherwise it asks for email + password and creates one.
+ */
+export declare function runLogin(options: {
+    host?: string;
+    token?: string;
+}): Promise<void>;

package/dist/types/cli/platform/push.d.ts

@@ -0,0 +1,12 @@
+/**
+ * `mechanica push`: publish the committed project to the platform.
+ *
+ *   1. bring in what was published online since the last pull (`pull --rebase`),
+ *   2. `git push` the commits to the site's repository,
+ *   3. if the code changed, build locally and upload the bundle for that commit
+ *      (content-only pushes reuse the bundle already there — no build at all),
+ *   4. wait for the deploy and report it.
+ *
+ * The build runs on this machine; the platform only ever renders the bundle.
+ */
+export declare function runPush(): Promise<void>;

package/dist/types/cli/run-export.d.ts

@@ -0,0 +1,7 @@
+import { type ExportOptions } from './export';
+/**
+ * `mechanica export`: build the project, then statically render every page
+ * into `export/`. Kept apart from `export.ts` so that module never imports
+ * Vite — `mechanica/export` runs where only a built bundle exists.
+ */
+export declare function runExport(options?: ExportOptions): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mechanica",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Build Vue 3 websites with a visual block editor",
   "license": "MIT",
   "repository": {
@@ -37,6 +37,10 @@
       "types": "./dist/types/vite/index.d.ts",
       "import": "./dist/plugin.js"
     },
+    "./export": {
+      "types": "./dist/types/cli/export.d.ts",
+      "import": "./dist/export.js"
+    },
     "./editor": {
       "import": "./dist/editor.js"
     },
@@ -58,7 +62,7 @@
     "prepublishOnly": "bun ../../scripts/ensure-bun-publish.js && bun run build"
   },
   "dependencies": {
-    "mechanica-shared": "2.0.2",
+    "mechanica-shared": "2.0.3",
     "@vue/compiler-sfc": "^3.5.38",
     "compact-json-schema": "^0.1.5",
     "estree-walker": "^3.0.3",

package/dist/types/cli/push.d.ts

@@ -1,10 +0,0 @@
-/**
- * Upload a built project to a backend. Preserves v1's binary body format
- * (a JSON tree header + concatenated file buffers) so the existing backend
- * keeps working; the contract is redesigned later with the SAAS service.
- */
-export declare function runPush(options: {
-    key?: string;
-    host?: string;
-    dir?: string;
-}): Promise<void>;