@webstir-io/module-contract 0.1.13 → 0.1.15

package/README.md

@@ -9,18 +9,10 @@ TypeScript interfaces, helper utilities, and JSON schema describing Webstir modu
 
 ## Install
 
-```ini
-# .npmrc
-@webstir-io:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=${GH_PACKAGES_TOKEN}
-```
-
 ```bash
 npm install @webstir-io/module-contract
 ```
 
-Consumers only need `read:packages`; publishers also require `write:packages`.
-
 ## Provided Types
 
 ```ts
@@ -204,16 +196,16 @@ When authoring a provider:
 ## Maintainer Workflow
 
 ```bash
-npm install
-npm run clean          # remove dist/schema artifacts
-npm run build          # compiles TypeScript, regenerates schema/*.schema.json
-npm run test           # type-checks the Accounts example module
-# Release helper (bumps version, pushes tags to trigger release workflow)
-npm run release -- patch
+bun install
+bun run clean          # remove dist/schema artifacts
+bun run build          # compiles TypeScript, regenerates schema/*.schema.json
+bun run test           # type-checks the Accounts example module
+# Release helper (bumps version and pushes a package-scoped release tag)
+bun run release -- patch
 ```
 
 - The `schema/` folder contains `*-definition.schema.json` files derived from the exported Zod schemas. Commit them with contract changes.
-- Ensure CI runs `npm ci`, `npm run clean`, `npm run build`, `npm run test`, and `npm run smoke` before publish.
+- Ensure CI runs `bun install --frozen-lockfile`, `bun run clean`, `bun run build`, and `bun run test` before publish.
 
 ## License
 

package/dist/index.d.ts

@@ -772,13 +772,16 @@ export interface ViewSpec<TContext extends SSRContext = SSRContext, TParams exte
 export declare const jobDefinitionSchema: z.ZodObject<{
     name: z.ZodString;
     schedule: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
     priority: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodString]>>;
 }, "strip", z.ZodTypeAny, {
     name: string;
+    description?: string | undefined;
     schedule?: string | undefined;
     priority?: string | number | undefined;
 }, {
     name: string;
+    description?: string | undefined;
     schedule?: string | undefined;
     priority?: string | number | undefined;
 }>;
@@ -1216,13 +1219,16 @@ export declare const moduleManifestSchema: z.ZodObject<{
     jobs: z.ZodOptional<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         schedule: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
         priority: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodString]>>;
     }, "strip", z.ZodTypeAny, {
         name: string;
+        description?: string | undefined;
         schedule?: string | undefined;
         priority?: string | number | undefined;
     }, {
         name: string;
+        description?: string | undefined;
         schedule?: string | undefined;
         priority?: string | number | undefined;
     }>, "many">>;
@@ -1358,6 +1364,7 @@ export declare const moduleManifestSchema: z.ZodObject<{
     }[] | undefined;
     jobs?: {
         name: string;
+        description?: string | undefined;
         schedule?: string | undefined;
         priority?: string | number | undefined;
     }[] | undefined;
@@ -1463,6 +1470,7 @@ export declare const moduleManifestSchema: z.ZodObject<{
     }[] | undefined;
     jobs?: {
         name: string;
+        description?: string | undefined;
         schedule?: string | undefined;
         priority?: string | number | undefined;
     }[] | undefined;

package/dist/index.js

@@ -69,6 +69,7 @@ export const viewDefinitionSchema = z.object({
 export const jobDefinitionSchema = z.object({
     name: z.string().min(1),
     schedule: z.string().optional(),
+    description: z.string().optional(),
     priority: z.union([z.number().int(), z.string()]).optional()
 });
 export const eventDefinitionSchema = z.object({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webstir-io/module-contract",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "description": "Public contract definitions for Webstir frontend and backend module providers.",
   "type": "module",
   "main": "dist/index.js",
@@ -24,14 +24,13 @@
   ],
   "scripts": {
     "clean": "rm -rf dist schema",
-    "build": "npm run build:types && npm run build:schema",
+    "build": "tsc -p tsconfig.json && node scripts/build-schema.mjs",
     "build:types": "tsc -p tsconfig.json",
     "build:schema": "node scripts/build-schema.mjs",
-    "test": "npm run test:examples",
+    "test": "tsc -p tsconfig.json && node scripts/build-schema.mjs && tsc -p tsconfig.examples.json",
     "test:examples": "tsc -p tsconfig.examples.json",
     "smoke": "node -e \"console.log('[smoke] no smoke tests configured');\"",
-    "release": "bash scripts/publish.sh",
-    "prepare": "npm run build"
+    "release": "bash scripts/publish.sh"
   },
   "keywords": [
     "webstir",
@@ -41,24 +40,21 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/webstir-io/module-contract"
+    "url": "git+https://github.com/webstir-io/webstir.git",
+    "directory": "packages/contracts/module-contract"
+  },
+  "homepage": "https://github.com/webstir-io/webstir/tree/main/packages/contracts/module-contract#readme",
+  "bugs": {
+    "url": "https://github.com/webstir-io/webstir/issues"
   },
   "author": "Webstir",
   "dependencies": {
+    "@ts-rest/core": "^3.40.0",
     "zod": "^3.23.8"
   },
   "devDependencies": {
     "@types/node": "^20.19.21",
-    "@ts-rest/core": "^3.40.0",
     "typescript": "^5.7.2",
     "zod-to-json-schema": "^3.23.3"
-  },
-  "peerDependencies": {
-    "@ts-rest/core": "^3.40.0"
-  },
-  "peerDependenciesMeta": {
-    "@ts-rest/core": {
-      "optional": true
-    }
   }
 }

package/schema/module-manifest.schema.json

@@ -279,6 +279,9 @@
               "schedule": {
                 "type": "string"
               },
+              "description": {
+                "type": "string"
+              },
               "priority": {
                 "anyOf": [
                   {