@procedures/procedure 0.0.0-stage → 0.2.0

package/dist/types.js

@@ -0,0 +1,34 @@
+/**
+ * Type definitions for client-procedure
+ */
+import { z } from "zod";
+// =============================================================================
+// procedure.new Types
+// =============================================================================
+export const ProcedureNewInputSchema = z.object({
+    /** Procedure name (e.g., "greet", "user.create" or "fs.readJson") */
+    name: z
+        .string()
+        .regex(/^[a-z][a-zA-Z0-9]*(\.[a-z][a-zA-Z0-9]*)*$/, "Name must be dot-separated segments, each starting with a lowercase letter (camelCase is allowed)").describe("Procedure name (e.g., \"greet\", \"user.create\" or \"fs.readJson\")"),
+    /** Namespace override (defaults to first segment of name): the folder under src/procedures */
+    namespace: z
+        .string()
+        .regex(/^[a-z][a-zA-Z0-9]*$/, "Namespace must be one segment that starts with a lowercase letter")
+        .optional().describe("Namespace override (defaults to first segment of name): the folder under src/procedures"),
+    /** Procedure description for CLI help */
+    description: z.string().optional().describe("Procedure description for CLI help"),
+    /** Project path (defaults to cwd) */
+    path: z.string().optional().describe("Project path (defaults to cwd)"),
+    /** Preview changes without creating */
+    dryRun: z.boolean().default(false).describe("Preview changes without creating"),
+});
+/** The output schema of procedure.new (roadmap 2.1). Loose: a field that it does not name stays. */
+export const ProcedureNewOutputSchema = z.looseObject({
+    success: z.boolean().describe("True when the procedure was made"),
+    procedurePath: z.array(z.string()).describe('The path of the new procedure, for example ["user", "create"]'),
+    created: z.array(z.string()).describe("The files that the call made"),
+    modified: z.array(z.string()).describe("The files that the call changed (types.ts, register.ts)"),
+    operations: z.array(z.string()).describe("The steps that the call ran"),
+    errors: z.array(z.string()).describe("The errors"),
+});
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,gFAAgF;AAChF,sBAAsB;AACtB,gFAAgF;AAEhF,MAAM,CAAC,MAAM,uBAAuB,GAM/B,CAAC,CAAC,MAAM,CAAC;IACZ,qEAAqE;IACrE,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,KAAK,CACJ,2CAA2C,EAC3C,mGAAmG,CACpG,CAAC,QAAQ,CAAC,sEAAsE,CAAC;IACpF,8FAA8F;IAC9F,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,KAAK,CAAC,qBAAqB,EAAE,mEAAmE,CAAC;SACjG,QAAQ,EAAE,CAAC,QAAQ,CAAC,yFAAyF,CAAC;IACjH,yCAAyC;IACzC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oCAAoC,CAAC;IACjF,qCAAqC;IACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;IACtE,uCAAuC;IACvC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,kCAAkC,CAAC;CAChF,CAAC,CAAC;AAmBH,oGAAoG;AACpG,MAAM,CAAC,MAAM,wBAAwB,GAAkC,CAAC,CAAC,WAAW,CAAC;IACnF,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;IACjE,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,+DAA+D,CAAC;IAC5G,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,8BAA8B,CAAC;IACrE,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,yDAAyD,CAAC;IACjG,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,6BAA6B,CAAC;IACvE,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;CACnD,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,78 @@
 {
+  "$schema": "https://json.schemastore.org/package",
   "name": "@procedures/procedure",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0",
+  "description": "Procedure scaffolding and management: procedure.new writes typed procedure files, plus get, list, define and the procedure store.",
+  "keywords": [
+    "scaffolding",
+    "codegen",
+    "generator",
+    "procedures"
+  ],
+  "homepage": "https://mark1russell7.github.io/client/",
+  "bugs": {
+    "url": "https://github.com/mark1russell7/client/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mark1russell7/client.git",
+    "directory": "packages/client-procedure"
+  },
+  "license": "MIT",
+  "author": "Mark Russell (https://github.com/mark1russell7)",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./module": {
+      "types": "./dist/module.d.ts",
+      "import": "./dist/module.js"
+    },
+    "./register": {
+      "types": "./dist/register.d.ts",
+      "import": "./dist/register.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test.tsx",
+    "!src/**/__tests__",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": [
+    "./dist/register.js"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "devDependencies": {
+    "typescript": "^7.0.2",
+    "@types/node": "^22.0.0",
+    "@mark1russell7/cue": "^1.0.0",
+    "vitest": "^5.0.3"
+  },
+  "dependencies": {
+    "zod": "^4.6.5",
+    "@procedures/client": "0.2.0"
+  },
+  "client": {
+    "procedures": "./dist/register.js"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist .tsbuildinfo",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest"
+  }
 }

package/src/index.ts

@@ -0,0 +1,13 @@
+/**
+ * @procedures/procedure
+ *
+ * Procedure scaffolding procedures - procedure.new
+ */
+
+export * from "./module.js";
+
+// Re-export types
+export * from "./types.js";
+
+// Re-export procedures
+export { procedureNew } from "./procedures/procedure/index.js";

package/src/module.ts

@@ -0,0 +1,61 @@
+/**
+ * Module (no side effects): the procedures of this package as data, for `createRegistry()`.
+ *
+ * Procedure Registration for procedure operations
+ *
+ * This is the canonical home for procedure.* procedures.
+ * client-cli no longer registers these to avoid duplicates.
+ */
+
+import { createProcedure, zodAdapter, defineModule, type AnyProcedure, type ProcedureModule, PROCEDURE_REGISTRY, registerModules, type ProcedureRegistry } from "@procedures/client";
+import { procedureNew } from "./procedures/procedure/index.js";
+import { procedureRegistryProcedures } from "./procedures/procedure/registry.js";
+import {
+  ProcedureNewInputSchema,
+  type ProcedureNewInput,
+  type ProcedureNewOutput,
+  ProcedureNewOutputSchema,
+} from "./types.js";
+import type { ProcedureContext } from "@procedures/client";
+
+// procedure.new procedure
+const procedureNewProcedure = createProcedure()
+  .path(["procedure", "new"])
+  .input(zodAdapter<ProcedureNewInput>(ProcedureNewInputSchema))
+  .output(zodAdapter<ProcedureNewOutput>(ProcedureNewOutputSchema))
+  .meta({
+    description: "Scaffold a new procedure with types and registration boilerplate",
+    calls: ["fs.exists", "fs.read", "fs.write", "fs.mkdir"],
+    // It refuses a name that collides, makes new files and adds lines to the existing files
+    effects: { reads: ["fs", "registry"], writes: ["fs"], destructive: false },
+    args: ["name"],
+    shorts: { namespace: "n", description: "d", path: "p", dryRun: "D" },
+    output: "text",
+  })
+  .handler(async (input: ProcedureNewInput, ctx: ProcedureContext): Promise<ProcedureNewOutput> => {
+    return procedureNew(input, ctx);
+  })
+  .build();
+
+/**
+ * The module of this package, for `createRegistry()`: its procedures as data. Importing this
+ * file registers nothing. (`register.ts` registers the same procedures in the global registry.)
+ * `procedure.new` calls `fs.*`: the host gives them (this package does not depend on client-fs).
+ */
+export const procedureModule: ProcedureModule = defineModule("@procedures/procedure", [
+  // procedure.new
+  procedureNewProcedure as AnyProcedure,
+  // procedure.export (from registry.ts)
+  ...procedureRegistryProcedures,
+]);
+
+export default procedureModule;
+
+/**
+ * This function registers the procedures of @procedures/procedure, and of the modules that it requires, in
+ * a registry. The default is the global registry. Importing this file registers nothing: the
+ * `./register` entry starts this function (ARCHITECTURE-PROPOSALS-2026-10, P9).
+ */
+export function registerProcedureProcedures(registry: ProcedureRegistry = PROCEDURE_REGISTRY): void {
+  registerModules(registry, [procedureModule], { override: true });
+}

package/src/procedures/procedure/index.ts

@@ -0,0 +1,5 @@
+/**
+ * procedure namespace procedures
+ */
+
+export { procedureNew } from "./new.js";