@kinotic-ai/idl 1.0.0-beta.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +58 -0
  2. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,58 @@
1
+ # @kinotic-ai/idl
2
+
3
+ The type schema layer that makes Kinotic's cross-language RPC safe and consistent. `@kinotic-ai/idl` bridges Java backend services and TypeScript clients so you always know exactly what you're sending and receiving — no guesswork, no runtime type surprises. It is the foundation Kinotic uses to generate APIs, validate data, and keep every part of the platform speaking the same language.
4
+
5
+ **[Get started at kinotic.ai/getting-started](https://kinotic.ai/getting-started)**
6
+
7
+ ---
8
+
9
+ ## Why @kinotic-ai/idl?
10
+
11
+ - **One schema, every language.** Define a data structure or service interface once in a language-neutral format — Java, TypeScript, and the platform all stay in sync automatically.
12
+ - **No more integration surprises.** Schema contracts are enforced across the RPC boundary, catching mismatches at definition time rather than in production.
13
+ - **Rich metadata, zero boilerplate.** Attach validation rules and behavioral decorators to your models without writing custom validators or annotation processors.
14
+ - **Drives the whole platform.** OpenAPI specifications, GraphQL schemas, and serialization logic are all generated from the same IDL definitions — change once, update everywhere.
15
+
16
+ ---
17
+
18
+ ## Features
19
+
20
+ ### Language-Neutral Schema Definition
21
+ Describe any data structure or service interface in a format that is not tied to any one language or runtime. The same definition drives both the Java server and the TypeScript client.
22
+
23
+ ### Automatic API Generation
24
+ Publish a schema and the platform generates OpenAPI endpoints, GraphQL types, and serialization mappings for you. There is no manual mapping layer to maintain.
25
+
26
+ ### Validation and Behavioral Metadata
27
+ Annotate data models with constraints and behavioral hints directly in the schema. Validation rules travel with the definition instead of being scattered across your codebase.
28
+
29
+ ### Cross-Platform Serialization
30
+ Data moving between services is serialized and deserialized according to the schema contract. Format differences between languages are handled automatically.
31
+
32
+ ### Foundation for Schema-Driven Development
33
+ `@kinotic-ai/idl` is the type layer that everything else in the Kinotic platform builds on. Define your domain model here and let the platform do the rest.
34
+
35
+ ---
36
+
37
+ ## Part of the Kinotic Ecosystem
38
+
39
+ `@kinotic-ai/idl` sits just above the core transport layer:
40
+
41
+ ```
42
+ @kinotic-ai/os-api ← cloud OS management
43
+ @kinotic-ai/persistence ← schema-driven data access
44
+ @kinotic-ai/idl ← cross-language type schemas (this package)
45
+ @kinotic-ai/core ← connection & transport
46
+ ```
47
+
48
+ `@kinotic-ai/persistence` and `@kinotic-ai/os-api` both depend on the schema definitions this package provides. Start here when you need to describe data that crosses a service boundary.
49
+
50
+ ---
51
+
52
+ ## Installation
53
+
54
+ ```bash
55
+ npm install @kinotic-ai/idl
56
+ ```
57
+
58
+ For full documentation, guides, and API reference, visit **[kinotic.ai](https://kinotic.ai)**.
package/package.json CHANGED
@@ -50,5 +50,5 @@
50
50
  "optional": true
51
51
  }
52
52
  },
53
- "version": "1.0.0-beta.1"
53
+ "version": "1.0.0"
54
54
  }