@kinotic-ai/persistence 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 +65 -0
  2. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,65 @@
1
+ # @kinotic-ai/persistence
2
+
3
+ Instant, schema-driven data access for your Kinotic applications. `@kinotic-ai/persistence` eliminates the data layer boilerplate that slows every project down — define your entity once and get full CRUD, full-text search, pagination, bulk operations, and named queries without writing a single query or mapping file. It is designed for developers who want enterprise-grade data capabilities without the infrastructure overhead.
4
+
5
+ **[Get started at kinotic.ai/getting-started](https://kinotic.ai/getting-started)**
6
+
7
+ ---
8
+
9
+ ## Why @kinotic-ai/persistence?
10
+
11
+ - **Zero query boilerplate.** Decorate your TypeScript classes and the data layer is ready — no mappers, no repositories, no hand-written queries to maintain.
12
+ - **Search is a first-class feature.** Full-text search across your data is available immediately, as naturally as any other read operation.
13
+ - **Built for scale.** Pagination, bulk operations, and cursor-based traversal handle large datasets without architectural changes.
14
+ - **Multi-tenancy handled for you.** Data isolation between tenants is automatic — your application logic stays clean.
15
+ - **One line to activate.** Plugs directly into your existing Kinotic connection. No separate configuration, no extra infrastructure.
16
+
17
+ ---
18
+
19
+ ## Features
20
+
21
+ ### Decorator-Driven Entity Definition
22
+ Annotate your TypeScript classes with decorators from this package to define entities — ID generation, indexing behavior, precision, multi-tenancy, access policies, and more. Once decorated, the full data access layer — reads, writes, deletes, and queries — is available immediately. No separate schema files, no mapping layer to write or maintain.
23
+
24
+ ### Full CRUD and Bulk Operations
25
+ Create, read, update, and delete individual records or entire batches with a consistent API. Bulk operations are designed for high-throughput scenarios without special-casing.
26
+
27
+ ### Full-Text Search
28
+ Query your data with powerful full-text search out of the box. No separate search infrastructure required — it comes with the persistence layer.
29
+
30
+ ### Flexible Pagination
31
+ Retrieve large result sets with both offset-based and cursor-based pagination. Switch between styles depending on the use case without changing your data model.
32
+
33
+ ### Named and Reusable Queries
34
+ Define complex queries once, give them a name, and reuse them across your application. Query definitions are first-class citizens, not one-off strings scattered through your code.
35
+
36
+ ### Multi-Tenancy and Data Isolation
37
+ Tenant boundaries are enforced automatically. Data from one tenant never leaks into another — no conditional filters to add, no policies to wire up manually.
38
+
39
+ ### Optimistic Locking
40
+ Concurrent writes are safe by default. Optimistic locking prevents silent data conflicts without requiring pessimistic locks or complex transaction management.
41
+
42
+ ---
43
+
44
+ ## Part of the Kinotic Ecosystem
45
+
46
+ `@kinotic-ai/persistence` sits in the middle of the Kinotic JavaScript/TypeScript stack:
47
+
48
+ ```
49
+ @kinotic-ai/os-api ← cloud OS management
50
+ @kinotic-ai/persistence ← schema-driven data access (this package)
51
+ @kinotic-ai/idl ← cross-language type schemas
52
+ @kinotic-ai/core ← connection & transport
53
+ ```
54
+
55
+ It depends on `@kinotic-ai/core` for the platform connection and `@kinotic-ai/idl` for schema definitions. `@kinotic-ai/os-api` builds on top of it to provide full cloud OS management.
56
+
57
+ ---
58
+
59
+ ## Installation
60
+
61
+ ```bash
62
+ npm install @kinotic-ai/persistence
63
+ ```
64
+
65
+ 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
  }