@objectstack/rest 4.0.4 → 4.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@objectstack/rest",
-  "version": "4.0.4",
+  "version": "4.1.0",
   "license": "Apache-2.0",
   "description": "ObjectStack REST API Server - automatic REST endpoint generation from protocol",
   "type": "module",
@@ -14,13 +14,39 @@
     }
   },
   "dependencies": {
-    "zod": "^4.3.6",
-    "@objectstack/core": "4.0.4",
-    "@objectstack/spec": "4.0.4"
+    "zod": "^4.4.3",
+    "@objectstack/core": "4.1.0",
+    "@objectstack/service-package": "4.1.0",
+    "@objectstack/spec": "4.1.0"
   },
   "devDependencies": {
-    "typescript": "^6.0.2",
-    "vitest": "^4.1.4"
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.7"
+  },
+  "keywords": [
+    "objectstack",
+    "rest",
+    "api",
+    "crud",
+    "openapi"
+  ],
+  "author": "ObjectStack",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/objectstack-ai/framework.git",
+    "directory": "packages/rest"
+  },
+  "homepage": "https://objectstack.ai/docs",
+  "bugs": "https://github.com/objectstack-ai/framework/issues",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
   },
   "scripts": {
     "build": "tsup --config ../../tsup.config.ts",

package/.turbo/turbo-build.log

@@ -1,22 +0,0 @@
-
-> @objectstack/rest@4.0.4 build /home/runner/work/framework/framework/packages/rest
-> tsup --config ../../tsup.config.ts
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.5.1
-CLI Using tsup config: /home/runner/work/framework/framework/tsup.config.ts
-CLI Target: es2020
-CLI Cleaning output folder
-ESM Build start
-CJS Build start
-CJS dist/index.cjs     22.27 KB
-CJS dist/index.cjs.map 51.54 KB
-CJS ⚡️ Build success in 143ms
-ESM dist/index.js     21.14 KB
-ESM dist/index.js.map 51.03 KB
-ESM ⚡️ Build success in 178ms
-DTS Build start
-DTS ⚡️ Build success in 12998ms
-DTS dist/index.d.ts  6.42 KB
-DTS dist/index.d.cts 6.42 KB

package/CHANGELOG.md

@@ -1,481 +0,0 @@
-# @objectstack/rest
-
-## 4.0.4
-
-### Patch Changes
-
-- Updated dependencies [326b66b]
-  - @objectstack/spec@4.0.4
-  - @objectstack/core@4.0.4
-
-## 4.0.3
-
-### Patch Changes
-
-- @objectstack/spec@4.0.3
-- @objectstack/core@4.0.3
-
-## 4.0.2
-
-### Patch Changes
-
-- Updated dependencies [5f659e9]
-  - @objectstack/spec@4.0.2
-  - @objectstack/core@4.0.2
-
-## 4.0.0
-
-### Patch Changes
-
-- Updated dependencies [f08ffc3]
-- Updated dependencies [e0b0a78]
-  - @objectstack/spec@4.0.0
-  - @objectstack/core@4.0.0
-
-## 3.3.1
-
-### Patch Changes
-
-- @objectstack/spec@3.3.1
-- @objectstack/core@3.3.1
-
-## 3.3.0
-
-### Patch Changes
-
-- @objectstack/spec@3.3.0
-- @objectstack/core@3.3.0
-
-## 3.2.9
-
-### Patch Changes
-
-- @objectstack/spec@3.2.9
-- @objectstack/core@3.2.9
-
-## 3.2.8
-
-### Patch Changes
-
-- @objectstack/spec@3.2.8
-- @objectstack/core@3.2.8
-
-## 3.2.7
-
-### Patch Changes
-
-- @objectstack/spec@3.2.7
-- @objectstack/core@3.2.7
-
-## 3.2.6
-
-### Patch Changes
-
-- @objectstack/spec@3.2.6
-- @objectstack/core@3.2.6
-
-## 3.2.5
-
-### Patch Changes
-
-- @objectstack/spec@3.2.5
-- @objectstack/core@3.2.5
-
-## 3.2.4
-
-### Patch Changes
-
-- @objectstack/spec@3.2.4
-- @objectstack/core@3.2.4
-
-## 3.2.3
-
-### Patch Changes
-
-- @objectstack/spec@3.2.3
-- @objectstack/core@3.2.3
-
-## 3.2.2
-
-### Patch Changes
-
-- Updated dependencies [46defbb]
-  - @objectstack/spec@3.2.2
-  - @objectstack/core@3.2.2
-
-## 3.2.1
-
-### Patch Changes
-
-- Updated dependencies [850b546]
-  - @objectstack/spec@3.2.1
-  - @objectstack/core@3.2.1
-
-## 3.2.0
-
-### Patch Changes
-
-- Updated dependencies [5901c29]
-  - @objectstack/spec@3.2.0
-  - @objectstack/core@3.2.0
-
-## 3.1.1
-
-### Patch Changes
-
-- Updated dependencies [953d667]
-  - @objectstack/spec@3.1.1
-  - @objectstack/core@3.1.1
-
-## 3.1.0
-
-### Patch Changes
-
-- Updated dependencies [0088830]
-  - @objectstack/spec@3.1.0
-  - @objectstack/core@3.1.0
-
-## 3.0.11
-
-### Patch Changes
-
-- Updated dependencies [92d9d99]
-  - @objectstack/spec@3.0.11
-  - @objectstack/core@3.0.11
-
-## 3.0.10
-
-### Patch Changes
-
-- Updated dependencies [d1e5d31]
-  - @objectstack/spec@3.0.10
-  - @objectstack/core@3.0.10
-
-## 3.0.9
-
-### Patch Changes
-
-- Updated dependencies [15e0df6]
-  - @objectstack/spec@3.0.9
-  - @objectstack/core@3.0.9
-
-## 3.0.8
-
-### Patch Changes
-
-- Updated dependencies [5a968a2]
-  - @objectstack/spec@3.0.8
-  - @objectstack/core@3.0.8
-
-## 3.0.7
-
-### Patch Changes
-
-- Updated dependencies [0119bd7]
-- Updated dependencies [5426bdf]
-  - @objectstack/spec@3.0.7
-  - @objectstack/core@3.0.7
-
-## 3.0.6
-
-### Patch Changes
-
-- Updated dependencies [5df254c]
-  - @objectstack/spec@3.0.6
-  - @objectstack/core@3.0.6
-
-## 3.0.5
-
-### Patch Changes
-
-- Updated dependencies [23a4a68]
-  - @objectstack/spec@3.0.5
-  - @objectstack/core@3.0.5
-
-## 3.0.4
-
-### Patch Changes
-
-- Updated dependencies [d738987]
-  - @objectstack/spec@3.0.4
-  - @objectstack/core@3.0.4
-
-## 3.0.3
-
-### Patch Changes
-
-- c7267f6: Patch release for maintenance updates and improvements.
-- Updated dependencies [c7267f6]
-  - @objectstack/spec@3.0.3
-  - @objectstack/core@3.0.3
-
-## 3.0.2
-
-### Patch Changes
-
-- Updated dependencies [28985f5]
-  - @objectstack/spec@3.0.2
-  - @objectstack/core@3.0.2
-
-## 3.0.1
-
-### Patch Changes
-
-- Updated dependencies [389725a]
-  - @objectstack/spec@3.0.1
-  - @objectstack/core@3.0.1
-
-## 3.0.0
-
-### Major Changes
-
-- Release v3.0.0 — unified version bump for all ObjectStack packages.
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@3.0.0
-  - @objectstack/core@3.0.0
-
-## 2.0.7
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@2.0.7
-  - @objectstack/core@2.0.7
-
-## 2.0.6
-
-### Patch Changes
-
-- Patch release for maintenance and stability improvements
-- Updated dependencies
-  - @objectstack/spec@2.0.6
-  - @objectstack/core@2.0.6
-
-## 2.0.5
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@2.0.5
-  - @objectstack/core@2.0.5
-
-## 2.0.4
-
-### Patch Changes
-
-- Patch release for maintenance and stability improvements
-- Updated dependencies
-  - @objectstack/spec@2.0.4
-  - @objectstack/core@2.0.4
-
-## 2.0.3
-
-### Patch Changes
-
-- Patch release for maintenance and stability improvements
-- Updated dependencies
-  - @objectstack/spec@2.0.3
-  - @objectstack/core@2.0.3
-
-## 2.0.2
-
-### Patch Changes
-
-- Updated dependencies [1db8559]
-  - @objectstack/spec@2.0.2
-  - @objectstack/core@2.0.2
-
-## 2.0.1
-
-### Patch Changes
-
-- Patch release for maintenance and stability improvements
-- Updated dependencies
-  - @objectstack/spec@2.0.1
-  - @objectstack/core@2.0.1
-
-## 2.0.0
-
-### Patch Changes
-
-- Updated dependencies [38e5dd5]
-- Updated dependencies [38e5dd5]
-  - @objectstack/spec@2.0.0
-  - @objectstack/core@2.0.0
-
-## 1.1.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@2.0.0
-  - @objectstack/core@2.0.0
-
-## 1.1.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@2.0.0
-  - @objectstack/core@2.0.0
-
-## 1.1.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@2.0.0
-  - @objectstack/core@2.0.0
-
-## 2.0.0
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@2.0.0
-  - @objectstack/core@2.0.0
-
-## 1.1.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@1.1.1
-  - @objectstack/core@1.1.1
-
-## 1.1.1
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@2.0.0
-  - @objectstack/core@2.0.0
-
-## 1.2.0
-
-### Minor Changes
-
-- ## New Features
-
-  - **@objectstack/rest** (new package): Extracted REST server, route management, and `createRestApiPlugin` into a dedicated package
-  - **@objectstack/runtime**: Add `createDispatcherPlugin` for structured route management (auth, graphql, analytics, packages, hub, storage, automation)
-  - **@objectstack/cli**: Dev mode (`--dev`) now auto-enables Studio UI at `/_studio/` — no need for `--ui` flag; use `--no-ui` to disable
-  - **@objectstack/cli**: Root URL `/` redirects to `/_studio/` in dev mode for convenience
-  - **@objectstack/cli**: Removed Vite dev server fallback — always serves pre-built dist, no extra port
-  - **@objectstack/studio**: Interactive API Console in Object Explorer (request builder, response viewer, history)
-  - **@objectstack/spec**: Studio Plugin schema, MCP Protocol schemas, API versioning, Dispatcher protocol
-  - **@objectstack/spec**: Comprehensive `.describe()` annotations across all Zod schemas
-  - **@objectstack/core**: Production hot reload and dynamic plugin loading protocol
-
-  ## Migration Guide (from 1.1.0)
-
-  ### RuntimeConfig.api removed
-
-  ```ts
-  // Before (1.1.0) — implicit
-  const runtime = new Runtime({ api: { basePath: "/api/v1" } });
-
-  // After (1.2.0) — explicit
-  import { createRestApiPlugin } from "@objectstack/rest";
-  const runtime = new Runtime();
-  runtime.use(createRestApiPlugin({ basePath: "/api/v1" }));
-  ```
-
-  ### z.any() → z.unknown() (~30 fields)
-
-  Fields like `metadata`, `defaultValue`, `filters`, `config`, `data` now use `z.unknown()`. Add type narrowing where needed.
-
-  ### Hub schemas relocated
-
-  Barrel imports via `Hub.*` still work. Direct path imports (`hub/license.zod.ts` → `system/license.zod.ts`) need updating.
-
-  ### MetricType renamed
-
-  `MetricType` (analytics) → `AggregationMetricType`, `MetricType` (licensing) → `LicenseMetricType`
-
-  ### Deprecations
-
-  - `HttpDispatcher` → `createDispatcherPlugin()`
-  - `createHonoApp` → `HonoServerPlugin`
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@2.0.0
-  - @objectstack/core@2.0.0
-
-## 1.2.0
-
-### Minor Changes
-
-- ## New Features
-
-  - **@objectstack/rest** (new package): Extracted REST server, route management, and `createRestApiPlugin` into a dedicated package
-  - **@objectstack/runtime**: Add `createDispatcherPlugin` for structured route management (auth, graphql, analytics, packages, hub, storage, automation)
-  - **@objectstack/cli**: Dev mode (`--dev`) now auto-enables Studio UI at `/_studio/` — no need for `--ui` flag; use `--no-ui` to disable
-  - **@objectstack/cli**: Root URL `/` redirects to `/_studio/` in dev mode for convenience
-  - **@objectstack/cli**: Removed Vite dev server fallback — always serves pre-built dist, no extra port
-  - **@objectstack/studio**: Interactive API Console in Object Explorer (request builder, response viewer, history)
-  - **@objectstack/spec**: Studio Plugin schema (`Studio.PluginManifest`)
-  - **@objectstack/spec**: MCP (Model Context Protocol) schemas for AI tools, resources, prompts, transport
-  - **@objectstack/spec**: API versioning schema with multiple strategies
-  - **@objectstack/spec**: Dispatcher protocol schema
-  - **@objectstack/spec**: Comprehensive `.describe()` annotations across all Zod schemas for JSON Schema generation
-  - **@objectstack/core**: Production hot reload and dynamic plugin loading protocol
-
-  ## Migration Guide (from 1.1.0)
-
-  ### RuntimeConfig.api removed
-
-  REST API is now opt-in. If you relied on automatic REST registration:
-
-  ```ts
-  // Before (1.1.0) — implicit
-  const runtime = new Runtime({ api: { basePath: "/api/v1" } });
-
-  // After (1.2.0) — explicit
-  import { createRestApiPlugin } from "@objectstack/rest";
-  const runtime = new Runtime();
-  runtime.use(createRestApiPlugin({ basePath: "/api/v1" }));
-  ```
-
-  ### z.any() → z.unknown() (~30 fields)
-
-  Fields like `metadata`, `defaultValue`, `filters`, `config`, `data` in spec schemas changed from `z.any()` to `z.unknown()`. If you consume inferred types, add type narrowing:
-
-  ```ts
-  // Before — worked silently
-  const val: string = record.metadata.foo;
-
-  // After — requires narrowing
-  const meta = record.metadata as Record<string, string>;
-  const val = meta.foo;
-  ```
-
-  ### Hub schemas relocated
-
-  - `hub/composer.zod.ts`, `hub/marketplace.zod.ts`, `hub/space.zod.ts`, `hub/hub-federation.zod.ts` — removed
-  - `hub/plugin-registry.zod.ts` → `kernel/plugin-registry.zod.ts`
-  - `hub/license.zod.ts` → `system/license.zod.ts`
-  - `hub/tenant.zod.ts` → `system/tenant.zod.ts`
-
-  Barrel imports via `Hub.*` namespace still work. Direct path imports need updating.
-
-  ### MetricType renamed
-
-  - `MetricType` (data analytics) → `AggregationMetricType`
-  - `MetricType` (hub licensing) → `LicenseMetricType`
-
-  ### Deprecations
-
-  - `HttpDispatcher` → use `createDispatcherPlugin()` instead
-  - `createHonoApp` → use `HonoServerPlugin` instead
-
-### Patch Changes
-
-- Updated dependencies
-  - @objectstack/spec@2.0.0
-  - @objectstack/core@2.0.0

package/src/index.ts

@@ -1,12 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-// REST Server
-export { RestServer } from './rest-server.js';
-
-// Route Management
-export { RouteManager, RouteGroupBuilder } from './route-manager.js';
-export type { RouteEntry } from './route-manager.js';
-
-// REST API Plugin
-export { createRestApiPlugin } from './rest-api-plugin.js';
-export type { RestApiPluginConfig } from './rest-api-plugin.js';

package/src/rest-api-plugin.ts

@@ -1,72 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import { Plugin, PluginContext, IHttpServer } from '@objectstack/core';
-import { RestServer } from './rest-server.js';
-import { ObjectStackProtocol, RestServerConfig } from '@objectstack/spec/api';
-
-export interface RestApiPluginConfig {
-    serverServiceName?: string;
-    protocolServiceName?: string;
-    api?: RestServerConfig;
-}
-
-/**
- * REST API Plugin
- * 
- * Responsibilities:
- * 1. Consumes 'http.server' (or configured service)
- * 2. Consumes 'protocol' (ObjectStackProtocol)
- * 3. Instantiates RestServer to auto-generate routes
- */
-export function createRestApiPlugin(config: RestApiPluginConfig = {}): Plugin {
-    return {
-        name: 'com.objectstack.rest.api',
-        version: '1.0.0',
-        
-        init: async (_ctx: PluginContext) => {
-            // No service registration, this is a consumer plugin
-        },
-        
-        start: async (ctx: PluginContext) => {
-            const serverService = config.serverServiceName || 'http.server';
-            const protocolService = config.protocolServiceName || 'protocol';
-            
-            let server: IHttpServer | undefined;
-            let protocol: ObjectStackProtocol | undefined;
-
-            try {
-                server = ctx.getService<IHttpServer>(serverService);
-            } catch (e) {
-                // Ignore missing service
-            }
-
-            try {
-                protocol = ctx.getService<ObjectStackProtocol>(protocolService);
-            } catch (e) {
-                // Ignore missing service
-            }
-            
-            if (!server) {
-                ctx.logger.warn(`RestApiPlugin: HTTP Server service '${serverService}' not found. REST routes skipped.`);
-                return;
-            }
-            
-            if (!protocol) {
-                ctx.logger.warn(`RestApiPlugin: Protocol service '${protocolService}' not found. REST routes skipped.`);
-                return;
-            }
-            
-            ctx.logger.info('Hydrating REST API from Protocol...');
-            
-            try {
-                const restServer = new RestServer(server, protocol, config.api as any);
-                restServer.registerRoutes();
-                
-                ctx.logger.info('REST API successfully registered');
-            } catch (err: any) {
-                ctx.logger.error('Failed to register REST API routes', { error: err.message } as any);
-                throw err;
-            }
-        }
-    };
-}