@v7-cms/core 0.0.0-alpha.9

package/dist/serialize/index.js

@@ -0,0 +1,2 @@
+export { parseEntry, readData, setValue, deleteValue, getValue, hasValue, scalarStyleAt, serializeEntry, } from './entry.js';
+//# sourceMappingURL=index.js.map

package/dist/serialize/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/serialize/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,aAAa,EACb,cAAc,GAEf,MAAM,YAAY,CAAC"}

package/dist/storage/types.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Storage backends all look like this, so the editor never branches on which one it is talking to.
+ */
+export interface RepoRef {
+    owner: string;
+    repo: string;
+    branch: string;
+}
+export interface DirEntry {
+    name: string;
+    type: 'file' | 'dir';
+    /** GitHub's blob sha, used for optimistic concurrency on write. */
+    sha?: string;
+    size?: number;
+}
+export interface FileContents {
+    text: string;
+    /** Present on backends that support conflict detection. */
+    sha?: string;
+}
+export interface WriteOptions {
+    message: string;
+    /** Last-read sha. A mismatch must raise `ConflictError` rather than overwrite. */
+    sha?: string;
+    branch?: string;
+}
+export interface WriteResult {
+    sha?: string;
+    commit?: string;
+}
+export interface MediaRef {
+    /** Path inside the repository, or a key in object storage. */
+    path: string;
+    /** URL the site can serve, e.g. `/images/uploads/foo.webp`. */
+    url: string;
+    width?: number;
+    height?: number;
+    size?: number;
+    name?: string;
+}
+export interface MediaStore {
+    upload(file: {
+        data: Uint8Array;
+        name: string;
+        type: string;
+    }, options: {
+        folder: string;
+        filename?: string;
+    }): Promise<MediaRef>;
+    list(folder: string): Promise<MediaRef[]>;
+    remove(path: string): Promise<void>;
+}
+/** Raised when a write would clobber someone else's change. */
+export declare class ConflictError extends Error {
+    constructor(message?: string);
+}
+export declare class NotFoundError extends Error {
+    constructor(path: string);
+}
+/**
+ * Who the backend is acting as, when it has a notion of that.
+ *
+ * Optional because it is not universal: a folder on disk has no account, and neither does the
+ * in-memory backend. The editor shows an account panel only when this is present, so a local author
+ * never sees a sign-out button that would do nothing.
+ */
+export interface AccountInfo {
+    /** Login name, when the backend can report one. */
+    login?: string;
+    /** Display name, if it differs from the login. */
+    name?: string;
+    /** Avatar URL, already absolute. */
+    avatar?: string;
+    /** How the session was obtained, so the panel can explain what signing out drops. */
+    via: 'oauth' | 'token';
+    /** Repository being edited, for a backend that is bound to one. */
+    repo?: RepoRef;
+}
+export interface StorageAdapter {
+    readonly kind: 'github' | 'fs-access' | 'proxy' | 'memory';
+    init(): Promise<void>;
+    /**
+     * The signed-in account, or undefined when the backend has none. Called once the backend is
+     * ready; a failure here must not stop the editor from opening.
+     */
+    account?(): Promise<AccountInfo | undefined>;
+    listDir(path: string): Promise<DirEntry[]>;
+    readFile(path: string): Promise<FileContents>;
+    readBinary(path: string): Promise<Uint8Array>;
+    exists(path: string): Promise<boolean>;
+    writeFile(path: string, contents: string | Uint8Array, options: WriteOptions): Promise<WriteResult>;
+    deleteFile(path: string, options: WriteOptions): Promise<void>;
+    listBranches(): Promise<string[]>;
+    createBranch(name: string, from: string): Promise<void>;
+    media(): MediaStore;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/storage/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/storage/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IACrB,mEAAmE;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,kFAAkF;IAClF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,QAAQ;IACvB,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,CACJ,IAAI,EAAE;QAAE,IAAI,EAAE,UAAU,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EACtD,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAC7C,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrB,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC1C,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrC;AAED,+DAA+D;AAC/D,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,SAAwC;CAI5D;AAED,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,IAAI,EAAE,MAAM;CAIzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,mDAAmD;IACnD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kDAAkD;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qFAAqF;IACrF,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC;IACvB,mEAAmE;IACnE,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC3D,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB;;;OAGG;IACH,OAAO,CAAC,IAAI,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC;IAC7C,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3C,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAC9C,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9C,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC,SAAS,CACP,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,GAAG,UAAU,EAC7B,OAAO,EAAE,YAAY,GACpB,OAAO,CAAC,WAAW,CAAC,CAAC;IACxB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,YAAY,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAClC,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,KAAK,IAAI,UAAU,CAAC;CACrB"}

package/dist/storage/types.js

@@ -0,0 +1,14 @@
+/** Raised when a write would clobber someone else's change. */
+export class ConflictError extends Error {
+    constructor(message = 'The file changed since it was read.') {
+        super(message);
+        this.name = 'ConflictError';
+    }
+}
+export class NotFoundError extends Error {
+    constructor(path) {
+        super(`Not found: ${path}`);
+        this.name = 'NotFoundError';
+    }
+}
+//# sourceMappingURL=types.js.map

package/dist/storage/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/storage/types.ts"],"names":[],"mappings":"AAuDA,+DAA+D;AAC/D,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC,YAAY,OAAO,GAAG,qCAAqC;QACzD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;CACF;AAED,MAAM,OAAO,aAAc,SAAQ,KAAK;IACtC,YAAY,IAAY;QACtB,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;CACF"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@v7-cms/core",
+  "version": "0.0.0-alpha.9",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./serialize": {
+      "types": "./dist/serialize/index.d.ts",
+      "default": "./dist/serialize/index.js"
+    },
+    "./storage": {
+      "types": "./dist/storage/types.d.ts",
+      "default": "./dist/storage/types.js"
+    },
+    "./schema/config.json": "./schema/config.json"
+  },
+  "scripts": {
+    "check": "tsc --noEmit",
+    "schema": "node --experimental-strip-types scripts/emit-schema.mjs",
+    "build": "tsc -p tsconfig.build.json"
+  },
+  "dependencies": {
+    "yaml": "^2.8.1",
+    "zod": "^4.6.5"
+  },
+  "files": [
+    "dist",
+    "schema"
+  ],
+  "devDependencies": {
+    "prettier": "3.9.9"
+  },
+  "description": "The engine behind v7-cms: config schema, field contract, byte-faithful frontmatter serialization. No DOM.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/phishinqi/v7-cms.git",
+    "directory": "packages/core"
+  },
+  "homepage": "https://github.com/phishinqi/v7-cms#readme",
+  "bugs": {
+    "url": "https://github.com/phishinqi/v7-cms/issues"
+  },
+  "keywords": [
+    "frontmatter",
+    "yaml",
+    "markdown",
+    "serialize",
+    "cms",
+    "byte-faithful"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}

package/schema/config.json

@@ -0,0 +1,171 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "v7-cms configuration",
+  "description": "The file passed to mount(). See docs/configuration.md for the prose version.",
+  "type": "object",
+  "properties": {
+    "backend": {
+      "type": "object",
+      "properties": {
+        "name": { "type": "string", "enum": ["github", "local"] },
+        "repo": { "type": "string", "pattern": "^[\\w.-]+\\/[\\w.-]+$" },
+        "branch": { "type": "string", "minLength": 1 },
+        "authBase": { "type": "string" },
+        "authEndpoint": { "type": "string" },
+        "local": {
+          "type": "object",
+          "properties": {
+            "kind": { "type": "string", "enum": ["fs-access", "proxy", "memory"] },
+            "url": { "type": "string" },
+            "files": {
+              "type": "object",
+              "propertyNames": { "type": "string" },
+              "additionalProperties": { "type": "string" }
+            }
+          },
+          "required": ["kind"]
+        }
+      },
+      "required": ["name"]
+    },
+    "media": {
+      "type": "object",
+      "properties": {
+        "provider": { "type": "string", "enum": ["repo", "s3"] },
+        "repoPath": { "type": "string" },
+        "publicPath": { "type": "string" },
+        "maxEdge": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 },
+        "exif": { "type": "boolean" },
+        "s3": {
+          "type": "object",
+          "properties": {
+            "endpoint": { "type": "string" },
+            "bucket": { "type": "string" },
+            "publicBase": { "type": "string" }
+          },
+          "required": ["endpoint", "bucket", "publicBase"]
+        }
+      },
+      "required": ["provider"]
+    },
+    "collections": {
+      "minItems": 1,
+      "type": "array",
+      "items": {
+        "anyOf": [
+          {
+            "type": "object",
+            "properties": {
+              "kind": { "type": "string", "const": "fields" },
+              "name": { "type": "string", "minLength": 1 },
+              "label": { "type": "string", "minLength": 1 },
+              "labelSingular": { "type": "string" },
+              "folder": { "type": "string", "minLength": 1 },
+              "extension": { "type": "string", "enum": ["md", "mdx", "json", "yaml"] },
+              "format": { "type": "string", "enum": ["frontmatter", "json"] },
+              "identifierField": { "type": "string" },
+              "contentField": { "type": "string" },
+              "nested": { "type": "boolean" },
+              "media": {
+                "type": "object",
+                "propertyNames": { "type": "string" },
+                "additionalProperties": {}
+              },
+              "create": { "type": "boolean" },
+              "fields": { "minItems": 1, "type": "array", "items": { "$ref": "#/$defs/__schema0" } }
+            },
+            "required": ["kind", "name", "label", "folder", "extension", "format", "fields"]
+          },
+          {
+            "type": "object",
+            "properties": {
+              "kind": { "type": "string", "const": "file" },
+              "name": { "type": "string", "minLength": 1 },
+              "label": { "type": "string", "minLength": 1 },
+              "format": { "type": "string", "enum": ["yaml", "json"] },
+              "files": {
+                "minItems": 1,
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": { "type": "string", "minLength": 1 },
+                    "label": { "type": "string", "minLength": 1 },
+                    "file": { "type": "string", "minLength": 1 },
+                    "fields": { "type": "array", "items": { "$ref": "#/$defs/__schema0" } },
+                    "inferSchema": { "type": "boolean" },
+                    "fieldOverrides": {
+                      "type": "object",
+                      "propertyNames": { "type": "string" },
+                      "additionalProperties": {
+                        "type": "object",
+                        "propertyNames": { "type": "string" },
+                        "additionalProperties": {}
+                      }
+                    }
+                  },
+                  "required": ["name", "label", "file"]
+                }
+              }
+            },
+            "required": ["kind", "name", "label", "files"]
+          }
+        ]
+      }
+    },
+    "locale": { "type": "string" },
+    "editorialWorkflow": { "type": "boolean" },
+    "preview": {
+      "type": "object",
+      "properties": {
+        "devServerURL": { "type": "string" },
+        "pathTemplate": { "type": "string" },
+        "editAttribute": { "type": "string" }
+      }
+    },
+    "plugins": { "type": "array", "items": {} }
+  },
+  "required": ["backend", "collections"],
+  "$defs": {
+    "__schema0": {
+      "type": "object",
+      "properties": {
+        "name": { "type": "string", "minLength": 1 },
+        "label": { "type": "string" },
+        "widget": { "type": "string", "minLength": 1 },
+        "required": { "type": "boolean" },
+        "hint": { "type": "string" },
+        "fields": { "type": "array", "items": { "$ref": "#/$defs/__schema0" } },
+        "field": { "$ref": "#/$defs/__schema0" },
+        "options": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              { "type": "string" },
+              {
+                "type": "object",
+                "properties": { "label": { "type": "string" }, "value": { "type": "string" } },
+                "required": ["label", "value"]
+              }
+            ]
+          }
+        },
+        "default": {},
+        "collapseEmpty": { "type": "boolean" },
+        "collection": { "type": "string" },
+        "valueField": { "type": "string" },
+        "displayFields": { "type": "array", "items": { "type": "string" } },
+        "format": { "type": "string" },
+        "pattern": {
+          "type": "array",
+          "prefixItems": [{ "type": "string" }, { "type": "string" }],
+          "items": false,
+          "minItems": 2,
+          "maxItems": 2
+        }
+      },
+      "required": ["name", "widget"],
+      "additionalProperties": {}
+    }
+  }
+}