@usegraft/contracts 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,36 @@
+# @usegraft/contracts
+
+> Shared error codes and introspection schemas. The vocabulary every other Graft package speaks.
+
+Part of [Graft](https://github.com/AndersonDesign1/graft), a CMS built so an AI agent is the primary operator.
+
+## Install
+
+```bash
+npm i @usegraft/contracts
+```
+
+You rarely install this directly. It arrives as a dependency of the packages that throw.
+
+## Errors an agent can act on
+
+```ts
+import { GraftError, ErrorCodes } from "@usegraft/contracts";
+
+throw new GraftError({
+  code: "INPUT_VALIDATION_FAILED",
+  message: 'Slug "My Page" is not URL-safe.',
+  fix: 'Slugs are kebab-case: lowercase letters, digits and single hyphens, e.g. "my-page".',
+  details: { slug: "My Page" },
+});
+```
+
+`fix` is not decoration. Every error carries the next action, because the primary reader is an agent deciding what to do rather than a human reading a stack trace. That is why `message` says what happened and `fix` says what to do about it.
+
+## Introspection
+
+`CollectionDescriptor`, `FieldDescriptor`, `FunctionDescriptor` and the registry descriptors are the shapes `describe_schema` and friends return over MCP. They are declared here so the CLI, the MCP server and the Studio cannot drift on what a collection looks like.
+
+---
+
+MIT. [Repository](https://github.com/AndersonDesign1/graft) · [Changelog](https://github.com/AndersonDesign1/graft/blob/feat/core/packages/contracts/CHANGELOG.md)

package/dist/index.d.ts

@@ -34,6 +34,7 @@ declare const ErrorCodes: {
     readonly DESTRUCTIVE_OP_REQUIRES_APPROVAL: "DESTRUCTIVE_OP_REQUIRES_APPROVAL";
     readonly APPROVAL_INVALID: "APPROVAL_INVALID";
     readonly APPROVAL_SELF_DECISION: "APPROVAL_SELF_DECISION";
+    readonly APPROVAL_UNATTRIBUTED: "APPROVAL_UNATTRIBUTED";
     readonly BRANCH_NOT_FOUND: "BRANCH_NOT_FOUND";
     readonly BRANCH_EXISTS: "BRANCH_EXISTS";
     readonly BRANCH_INVALID: "BRANCH_INVALID";
@@ -278,4 +279,17 @@ declare const RegistryItemDescriptor: z.ZodObject<{
 }, z.core.$strip>;
 type RegistryItemDescriptor = z.infer<typeof RegistryItemDescriptor>;
 
-export { CollectionDescriptor, ContentAuthority, EditorComponentList, EditorComponentSpec, type ErrorCode, ErrorCodes, FieldDescriptor, FunctionDescriptor, GraftError, type GraftErrorJSON, type GraftErrorOptions, RegistryFileDescriptor, RegistryFileRole, RegistryItemDescriptor, RegistryItemType, SchemaDescription };
+/**
+ * Well-known paths shared across packages.
+ */
+/**
+ * Where a static-tier project's compiled index lives, relative to the project
+ * root.
+ *
+ * Here rather than in @usegraft/db because the CLI resolves it while loading a
+ * config and deliberately lazy-loads the database package — a static import
+ * just to read one string would pull Postgres into every `graft` invocation.
+ */
+declare const STATIC_INDEX_DEFAULT_PATH = ".graft/index.db";
+
+export { CollectionDescriptor, ContentAuthority, EditorComponentList, EditorComponentSpec, type ErrorCode, ErrorCodes, FieldDescriptor, FunctionDescriptor, GraftError, type GraftErrorJSON, type GraftErrorOptions, RegistryFileDescriptor, RegistryFileRole, RegistryItemDescriptor, RegistryItemType, STATIC_INDEX_DEFAULT_PATH, SchemaDescription };

package/dist/index.js

@@ -26,6 +26,7 @@ var ErrorCodes = {
   DESTRUCTIVE_OP_REQUIRES_APPROVAL: "DESTRUCTIVE_OP_REQUIRES_APPROVAL",
   APPROVAL_INVALID: "APPROVAL_INVALID",
   APPROVAL_SELF_DECISION: "APPROVAL_SELF_DECISION",
+  APPROVAL_UNATTRIBUTED: "APPROVAL_UNATTRIBUTED",
   BRANCH_NOT_FOUND: "BRANCH_NOT_FOUND",
   BRANCH_EXISTS: "BRANCH_EXISTS",
   BRANCH_INVALID: "BRANCH_INVALID",
@@ -172,6 +173,9 @@ var RegistryItemDescriptor = z.object({
   /** Whether the item ships an llms.txt teaching fragment. */
   llms: z.boolean()
 });
+
+// src/paths.ts
+var STATIC_INDEX_DEFAULT_PATH = ".graft/index.db";
 export {
   CollectionDescriptor,
   ContentAuthority,
@@ -185,5 +189,6 @@ export {
   RegistryFileRole,
   RegistryItemDescriptor,
   RegistryItemType,
+  STATIC_INDEX_DEFAULT_PATH,
   SchemaDescription
 };

package/package.json

@@ -1,6 +1,20 @@
 {
   "name": "@usegraft/contracts",
-  "version": "0.1.0",
+  "version": "0.2.0",
+  "description": "Shared error codes and introspection schemas: the vocabulary every Graft package speaks.",
+  "keywords": [
+    "agent",
+    "ai",
+    "cms",
+    "errors",
+    "graft",
+    "headless-cms",
+    "introspection",
+    "mcp",
+    "schemas",
+    "typescript"
+  ],
+  "homepage": "https://github.com/AndersonDesign1/graft#readme",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -33,7 +47,6 @@
     "build": "tsup src/index.ts --format esm --dts --clean",
     "dev": "tsup src/index.ts --format esm --watch",
     "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "lint": "oxlint ."
+    "test": "vitest run"
   }
 }