@ossy/types 0.3.0 → 0.3.2
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/README.md +28 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,18 +1,37 @@
|
|
|
1
1
|
# @ossy/types
|
|
2
2
|
|
|
3
|
-
Shared TypeScript types for
|
|
3
|
+
Shared TypeScript types for the Ossy ecosystem. Defines interfaces for themes, SDK configuration, resources, workspaces, and more.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
```bash
|
|
8
|
+
npm install @ossy/types
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
8
12
|
|
|
9
13
|
```typescript
|
|
10
|
-
import {
|
|
14
|
+
import type { Theme, Resource, SDKConfig, Workspace } from '@ossy/types'
|
|
11
15
|
```
|
|
12
16
|
|
|
13
|
-
##
|
|
17
|
+
## Key types
|
|
18
|
+
|
|
19
|
+
| Category | Types |
|
|
20
|
+
|----------|-------|
|
|
21
|
+
| **Theme & Design** | `Theme`, `SurfaceVariant`, `SpaceScale`, `MaxWidthScale`, `ColorPalette`, `SurfaceDefinitions`, `SurfacesMap` |
|
|
22
|
+
| **SDK** | `SDKConfig`, `Action` |
|
|
23
|
+
| **Resources** | `Resource`, `ResourceTemplate`, `Field`, `Workspace` |
|
|
24
|
+
| **Jobs** | `Job` |
|
|
25
|
+
|
|
26
|
+
## Documentation
|
|
14
27
|
|
|
15
|
-
|
|
28
|
+
Full type documentation is available in Storybook. Run from the monorepo root:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npm start
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Browse **Types** in the sidebar for generated interface tables.
|
|
16
35
|
|
|
17
36
|
## Development
|
|
18
37
|
|
|
@@ -21,3 +40,7 @@ Build the package:
|
|
|
21
40
|
```bash
|
|
22
41
|
npm run build
|
|
23
42
|
```
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ossy/types",
|
|
3
3
|
"description": "Shared TypeScript types for all packages",
|
|
4
|
-
"version": "0.3.
|
|
4
|
+
"version": "0.3.2",
|
|
5
5
|
"url": "git://github.com/ossy-se/packages/types",
|
|
6
6
|
"source": "src/index.ts",
|
|
7
7
|
"module": "build/index.js",
|
|
@@ -26,5 +26,5 @@
|
|
|
26
26
|
"/build",
|
|
27
27
|
"README.md"
|
|
28
28
|
],
|
|
29
|
-
"gitHead": "
|
|
29
|
+
"gitHead": "5c689da5bbcfcdb39a81f7bed613a6559468464a"
|
|
30
30
|
}
|