@locusai/shared 0.1.2 → 0.1.3
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.
- package/CHANGELOG.md +6 -0
- package/README.md +45 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/asgarovf/locusai/refs/heads/master/assets/logo.png" alt="Locus" width="150" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="https://www.npmjs.com/package/@locusai/shared"><img src="https://img.shields.io/npm/v/@locusai/shared?color=blue" alt="npm version" /></a>
|
|
7
|
+
<a href="https://github.com/asgarovf/locusai/blob/master/LICENSE"><img src="https://img.shields.io/github/license/asgarovf/locusai?color=blue" alt="License" /></a>
|
|
8
|
+
<a href="https://github.com/asgarovf/locusai"><img src="https://img.shields.io/github/stars/asgarovf/locusai?style=flat&color=blue" alt="GitHub Stars" /></a>
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
# @locusai/shared
|
|
12
|
+
|
|
13
|
+
Shared types, schemas, and utilities for the **Locus** platform.
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @locusai/shared
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## What's Included
|
|
22
|
+
|
|
23
|
+
- **TypeScript types** for tasks, artifacts, CI runs, and more
|
|
24
|
+
- **Zod schemas** for runtime validation
|
|
25
|
+
- **Enums** for task status, CI status, and artifact types
|
|
26
|
+
|
|
27
|
+
## Usage
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
import { TaskStatus, TaskSchema, CiRunStatus } from "@locusai/shared";
|
|
31
|
+
|
|
32
|
+
// Use types
|
|
33
|
+
const status: TaskStatus = TaskStatus.IN_PROGRESS;
|
|
34
|
+
|
|
35
|
+
// Validate data
|
|
36
|
+
const task = TaskSchema.parse(data);
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Part of Locus
|
|
40
|
+
|
|
41
|
+
This package is part of the [Locus](https://github.com/asgarovf/locusai) platform — a local-first AI development platform for task management, documentation, and CI coordination.
|
|
42
|
+
|
|
43
|
+
## License
|
|
44
|
+
|
|
45
|
+
[MIT](https://github.com/asgarovf/locusai/blob/master/LICENSE)
|