@famgia/omnify-types 0.0.1 → 0.0.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/README.md +41 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# @famgia/omnify-types
|
|
2
|
+
|
|
3
|
+
Shared TypeScript types for the Omnify schema system.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @famgia/omnify-types
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type {
|
|
15
|
+
SchemaDefinition,
|
|
16
|
+
LoadedSchema,
|
|
17
|
+
PropertyDefinition,
|
|
18
|
+
AssociationDefinition,
|
|
19
|
+
OmnifyPlugin
|
|
20
|
+
} from '@famgia/omnify-types';
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Types
|
|
24
|
+
|
|
25
|
+
- `SchemaDefinition` - Raw schema definition from YAML/JSON
|
|
26
|
+
- `LoadedSchema` - Parsed and validated schema
|
|
27
|
+
- `PropertyDefinition` - Field/property definition
|
|
28
|
+
- `AssociationDefinition` - Relationship definition
|
|
29
|
+
- `OmnifyPlugin` - Plugin interface
|
|
30
|
+
- `OmnifyConfig` - Configuration options
|
|
31
|
+
|
|
32
|
+
## Related Packages
|
|
33
|
+
|
|
34
|
+
- [@famgia/omnify-core](https://www.npmjs.com/package/@famgia/omnify-core) - Core engine
|
|
35
|
+
- [@famgia/omnify-cli](https://www.npmjs.com/package/@famgia/omnify-cli) - CLI tool
|
|
36
|
+
- [@famgia/omnify-laravel](https://www.npmjs.com/package/@famgia/omnify-laravel) - Laravel generator
|
|
37
|
+
- [@famgia/omnify-atlas](https://www.npmjs.com/package/@famgia/omnify-atlas) - Atlas adapter
|
|
38
|
+
|
|
39
|
+
## License
|
|
40
|
+
|
|
41
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@famgia/omnify-types",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"description": "Shared TypeScript types for omnify-schema",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -14,7 +14,8 @@
|
|
|
14
14
|
}
|
|
15
15
|
},
|
|
16
16
|
"files": [
|
|
17
|
-
"dist"
|
|
17
|
+
"dist",
|
|
18
|
+
"README.md"
|
|
18
19
|
],
|
|
19
20
|
"scripts": {
|
|
20
21
|
"build": "tsup",
|