@a16njs/models 0.0.1
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 +57 -0
- package/dist/helpers.d.ts +25 -0
- package/dist/helpers.d.ts.map +1 -0
- package/dist/helpers.js +35 -0
- package/dist/helpers.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -0
- package/dist/plugin.d.ts +59 -0
- package/dist/plugin.d.ts.map +1 -0
- package/dist/plugin.js +2 -0
- package/dist/plugin.js.map +1 -0
- package/dist/types.d.ts +65 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +16 -0
- package/dist/types.js.map +1 -0
- package/dist/warnings.d.ts +30 -0
- package/dist/warnings.d.ts.map +1 -0
- package/dist/warnings.js +17 -0
- package/dist/warnings.js.map +1 -0
- package/package.json +43 -0
package/README.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# @a16njs/models
|
|
2
|
+
|
|
3
|
+
Type definitions and plugin interface for a16n.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @a16njs/models
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import {
|
|
15
|
+
CustomizationType,
|
|
16
|
+
type A16nPlugin,
|
|
17
|
+
type AgentCustomization,
|
|
18
|
+
type GlobalPrompt,
|
|
19
|
+
isGlobalPrompt,
|
|
20
|
+
createId,
|
|
21
|
+
} from '@a16njs/models';
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Exports
|
|
25
|
+
|
|
26
|
+
### Types
|
|
27
|
+
|
|
28
|
+
- `CustomizationType` - Enum of customization types (GlobalPrompt, AgentSkill, FileRule, AgentIgnore)
|
|
29
|
+
- `AgentCustomization` - Base interface for all customizations
|
|
30
|
+
- `GlobalPrompt` - Always-applied prompts
|
|
31
|
+
- `AgentSkill` - Context-triggered by description (Phase 2)
|
|
32
|
+
- `FileRule` - Triggered by file patterns (Phase 2)
|
|
33
|
+
- `AgentIgnore` - Ignore patterns (Phase 3)
|
|
34
|
+
|
|
35
|
+
### Plugin Interface
|
|
36
|
+
|
|
37
|
+
- `A16nPlugin` - Interface that plugins must implement
|
|
38
|
+
- `DiscoveryResult` - Result of discovering customizations
|
|
39
|
+
- `EmitResult` - Result of emitting customizations
|
|
40
|
+
- `WrittenFile` - Info about a written file
|
|
41
|
+
|
|
42
|
+
### Warnings
|
|
43
|
+
|
|
44
|
+
- `WarningCode` - Enum of warning codes (Merged, Approximated, Skipped, Overwritten)
|
|
45
|
+
- `Warning` - Warning structure
|
|
46
|
+
|
|
47
|
+
### Helpers
|
|
48
|
+
|
|
49
|
+
- `isGlobalPrompt(item)` - Type guard for GlobalPrompt
|
|
50
|
+
- `isAgentSkill(item)` - Type guard for AgentSkill
|
|
51
|
+
- `isFileRule(item)` - Type guard for FileRule
|
|
52
|
+
- `isAgentIgnore(item)` - Type guard for AgentIgnore
|
|
53
|
+
- `createId(type, sourcePath)` - Create unique ID
|
|
54
|
+
|
|
55
|
+
## License
|
|
56
|
+
|
|
57
|
+
MIT
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { type AgentCustomization, type GlobalPrompt, type AgentSkill, type FileRule, type AgentIgnore, CustomizationType } from './types.js';
|
|
2
|
+
/**
|
|
3
|
+
* Type guard to check if an item is a GlobalPrompt.
|
|
4
|
+
*/
|
|
5
|
+
export declare function isGlobalPrompt(item: AgentCustomization): item is GlobalPrompt;
|
|
6
|
+
/**
|
|
7
|
+
* Type guard to check if an item is an AgentSkill.
|
|
8
|
+
*/
|
|
9
|
+
export declare function isAgentSkill(item: AgentCustomization): item is AgentSkill;
|
|
10
|
+
/**
|
|
11
|
+
* Type guard to check if an item is a FileRule.
|
|
12
|
+
*/
|
|
13
|
+
export declare function isFileRule(item: AgentCustomization): item is FileRule;
|
|
14
|
+
/**
|
|
15
|
+
* Type guard to check if an item is an AgentIgnore.
|
|
16
|
+
*/
|
|
17
|
+
export declare function isAgentIgnore(item: AgentCustomization): item is AgentIgnore;
|
|
18
|
+
/**
|
|
19
|
+
* Create a unique ID from a customization type and source path.
|
|
20
|
+
* @param type - The customization type
|
|
21
|
+
* @param sourcePath - The path where the item was found
|
|
22
|
+
* @returns A unique identifier string
|
|
23
|
+
*/
|
|
24
|
+
export declare function createId(type: CustomizationType, sourcePath: string): string;
|
|
25
|
+
//# sourceMappingURL=helpers.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI,IAAI,YAAY,CAE7E;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI,IAAI,UAAU,CAEzE;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI,IAAI,QAAQ,CAErE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,kBAAkB,GAAG,IAAI,IAAI,WAAW,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,CAE5E"}
|
package/dist/helpers.js
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { CustomizationType, } from './types.js';
|
|
2
|
+
/**
|
|
3
|
+
* Type guard to check if an item is a GlobalPrompt.
|
|
4
|
+
*/
|
|
5
|
+
export function isGlobalPrompt(item) {
|
|
6
|
+
return item.type === CustomizationType.GlobalPrompt;
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* Type guard to check if an item is an AgentSkill.
|
|
10
|
+
*/
|
|
11
|
+
export function isAgentSkill(item) {
|
|
12
|
+
return item.type === CustomizationType.AgentSkill;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Type guard to check if an item is a FileRule.
|
|
16
|
+
*/
|
|
17
|
+
export function isFileRule(item) {
|
|
18
|
+
return item.type === CustomizationType.FileRule;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Type guard to check if an item is an AgentIgnore.
|
|
22
|
+
*/
|
|
23
|
+
export function isAgentIgnore(item) {
|
|
24
|
+
return item.type === CustomizationType.AgentIgnore;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Create a unique ID from a customization type and source path.
|
|
28
|
+
* @param type - The customization type
|
|
29
|
+
* @param sourcePath - The path where the item was found
|
|
30
|
+
* @returns A unique identifier string
|
|
31
|
+
*/
|
|
32
|
+
export function createId(type, sourcePath) {
|
|
33
|
+
return `${type}:${sourcePath}`;
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=helpers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,iBAAiB,GAClB,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,IAAwB;IACrD,OAAO,IAAI,CAAC,IAAI,KAAK,iBAAiB,CAAC,YAAY,CAAC;AACtD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,IAAwB;IACnD,OAAO,IAAI,CAAC,IAAI,KAAK,iBAAiB,CAAC,UAAU,CAAC;AACpD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,IAAwB;IACjD,OAAO,IAAI,CAAC,IAAI,KAAK,iBAAiB,CAAC,QAAQ,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,IAAwB;IACpD,OAAO,IAAI,CAAC,IAAI,KAAK,iBAAiB,CAAC,WAAW,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAuB,EAAE,UAAkB;IAClE,OAAO,GAAG,IAAI,IAAI,UAAU,EAAE,CAAC;AACjC,CAAC"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export { CustomizationType, type AgentCustomization, type GlobalPrompt, type AgentSkill, type FileRule, type AgentIgnore, } from './types.js';
|
|
2
|
+
export { type A16nPlugin, type DiscoveryResult, type EmitResult, type WrittenFile, } from './plugin.js';
|
|
3
|
+
export { WarningCode, type Warning } from './warnings.js';
|
|
4
|
+
export { isGlobalPrompt, isAgentSkill, isFileRule, isAgentIgnore, createId, } from './helpers.js';
|
|
5
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,iBAAiB,EACjB,KAAK,kBAAkB,EACvB,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,QAAQ,EACb,KAAK,WAAW,GACjB,MAAM,YAAY,CAAC;AAGpB,OAAO,EACL,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,KAAK,UAAU,EACf,KAAK,WAAW,GACjB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,WAAW,EAAE,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAG1D,OAAO,EACL,cAAc,EACd,YAAY,EACZ,UAAU,EACV,aAAa,EACb,QAAQ,GACT,MAAM,cAAc,CAAC"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// @a16njs/models - Type definitions and plugin interface for a16n
|
|
2
|
+
// Types
|
|
3
|
+
export { CustomizationType, } from './types.js';
|
|
4
|
+
// Warnings
|
|
5
|
+
export { WarningCode } from './warnings.js';
|
|
6
|
+
// Helpers
|
|
7
|
+
export { isGlobalPrompt, isAgentSkill, isFileRule, isAgentIgnore, createId, } from './helpers.js';
|
|
8
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,kEAAkE;AAElE,QAAQ;AACR,OAAO,EACL,iBAAiB,GAMlB,MAAM,YAAY,CAAC;AAUpB,WAAW;AACX,OAAO,EAAE,WAAW,EAAgB,MAAM,eAAe,CAAC;AAE1D,UAAU;AACV,OAAO,EACL,cAAc,EACd,YAAY,EACZ,UAAU,EACV,aAAa,EACb,QAAQ,GACT,MAAM,cAAc,CAAC"}
|
package/dist/plugin.d.ts
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import type { AgentCustomization, CustomizationType } from './types.js';
|
|
2
|
+
import type { Warning } from './warnings.js';
|
|
3
|
+
/**
|
|
4
|
+
* Result of discovering customizations from a project.
|
|
5
|
+
*/
|
|
6
|
+
export interface DiscoveryResult {
|
|
7
|
+
/** All customization items found */
|
|
8
|
+
items: AgentCustomization[];
|
|
9
|
+
/** Any warnings encountered during discovery */
|
|
10
|
+
warnings: Warning[];
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Information about a file that was written.
|
|
14
|
+
*/
|
|
15
|
+
export interface WrittenFile {
|
|
16
|
+
/** Path to the written file */
|
|
17
|
+
path: string;
|
|
18
|
+
/** Type of customization written */
|
|
19
|
+
type: CustomizationType;
|
|
20
|
+
/** How many models went into this file (1 for 1:1, more if merged) */
|
|
21
|
+
itemCount: number;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Result of emitting customizations to a project.
|
|
25
|
+
*/
|
|
26
|
+
export interface EmitResult {
|
|
27
|
+
/** Files that were written */
|
|
28
|
+
written: WrittenFile[];
|
|
29
|
+
/** Any warnings encountered during emission */
|
|
30
|
+
warnings: Warning[];
|
|
31
|
+
/** Items that could not be represented by this plugin */
|
|
32
|
+
unsupported: AgentCustomization[];
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* The plugin interface that all a16n plugins must implement.
|
|
36
|
+
* Plugins bridge between a16n's internal model and a specific tool's format.
|
|
37
|
+
*/
|
|
38
|
+
export interface A16nPlugin {
|
|
39
|
+
/** Unique identifier, e.g., 'cursor', 'claude', 'codex' */
|
|
40
|
+
id: string;
|
|
41
|
+
/** Human-readable name */
|
|
42
|
+
name: string;
|
|
43
|
+
/** Which customization types this plugin supports */
|
|
44
|
+
supports: CustomizationType[];
|
|
45
|
+
/**
|
|
46
|
+
* Discover all agent customizations in a directory tree.
|
|
47
|
+
* @param root - The root directory to search
|
|
48
|
+
* @returns All customizations found and any warnings
|
|
49
|
+
*/
|
|
50
|
+
discover(root: string): Promise<DiscoveryResult>;
|
|
51
|
+
/**
|
|
52
|
+
* Emit customization models to disk in this plugin's format.
|
|
53
|
+
* @param models - The customizations to emit
|
|
54
|
+
* @param root - The root directory to write to
|
|
55
|
+
* @returns Info about what was written and any issues
|
|
56
|
+
*/
|
|
57
|
+
emit(models: AgentCustomization[], root: string): Promise<EmitResult>;
|
|
58
|
+
}
|
|
59
|
+
//# sourceMappingURL=plugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,oCAAoC;IACpC,KAAK,EAAE,kBAAkB,EAAE,CAAC;IAC5B,gDAAgD;IAChD,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,oCAAoC;IACpC,IAAI,EAAE,iBAAiB,CAAC;IACxB,sEAAsE;IACtE,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,8BAA8B;IAC9B,OAAO,EAAE,WAAW,EAAE,CAAC;IACvB,+CAA+C;IAC/C,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,yDAAyD;IACzD,WAAW,EAAE,kBAAkB,EAAE,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,2DAA2D;IAC3D,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAEjD;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,kBAAkB,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CACvE"}
|
package/dist/plugin.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":""}
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The taxonomy of agent customization types.
|
|
3
|
+
* Each type represents a different way agents can be customized.
|
|
4
|
+
*/
|
|
5
|
+
export declare enum CustomizationType {
|
|
6
|
+
/** Always-applied prompts (CLAUDE.md, alwaysApply rules) */
|
|
7
|
+
GlobalPrompt = "global-prompt",
|
|
8
|
+
/** Context-triggered by description matching */
|
|
9
|
+
AgentSkill = "agent-skill",
|
|
10
|
+
/** Triggered by file glob patterns */
|
|
11
|
+
FileRule = "file-rule",
|
|
12
|
+
/** Files/patterns to exclude from agent context */
|
|
13
|
+
AgentIgnore = "agent-ignore"
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Base interface for all agent customization items.
|
|
17
|
+
* Every customization discovered or emitted extends this interface.
|
|
18
|
+
*/
|
|
19
|
+
export interface AgentCustomization {
|
|
20
|
+
/** Unique identifier for this item */
|
|
21
|
+
id: string;
|
|
22
|
+
/** The type of customization */
|
|
23
|
+
type: CustomizationType;
|
|
24
|
+
/** Original file path where this was discovered */
|
|
25
|
+
sourcePath: string;
|
|
26
|
+
/** The actual prompt/rule content */
|
|
27
|
+
content: string;
|
|
28
|
+
/** Tool-specific extras that don't fit the standard model */
|
|
29
|
+
metadata: Record<string, unknown>;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* A global prompt that is always applied.
|
|
33
|
+
* Examples: CLAUDE.md, Cursor rules with alwaysApply: true
|
|
34
|
+
*/
|
|
35
|
+
export interface GlobalPrompt extends AgentCustomization {
|
|
36
|
+
type: CustomizationType.GlobalPrompt;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* A skill that is activated by description matching.
|
|
40
|
+
* Examples: Cursor rules with description but no globs
|
|
41
|
+
*/
|
|
42
|
+
export interface AgentSkill extends AgentCustomization {
|
|
43
|
+
type: CustomizationType.AgentSkill;
|
|
44
|
+
/** What triggers this skill */
|
|
45
|
+
description: string;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* A rule that is triggered by file patterns.
|
|
49
|
+
* Examples: Cursor rules with globs
|
|
50
|
+
*/
|
|
51
|
+
export interface FileRule extends AgentCustomization {
|
|
52
|
+
type: CustomizationType.FileRule;
|
|
53
|
+
/** File patterns that trigger this rule */
|
|
54
|
+
globs: string[];
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Patterns for files the agent should ignore.
|
|
58
|
+
* Examples: .cursorignore
|
|
59
|
+
*/
|
|
60
|
+
export interface AgentIgnore extends AgentCustomization {
|
|
61
|
+
type: CustomizationType.AgentIgnore;
|
|
62
|
+
/** Gitignore-style patterns */
|
|
63
|
+
patterns: string[];
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,4DAA4D;IAC5D,YAAY,kBAAkB;IAC9B,gDAAgD;IAChD,UAAU,gBAAgB;IAC1B,sCAAsC;IACtC,QAAQ,cAAc;IACtB,mDAAmD;IACnD,WAAW,iBAAiB;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,sCAAsC;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,IAAI,EAAE,iBAAiB,CAAC;IACxB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IACtD,IAAI,EAAE,iBAAiB,CAAC,YAAY,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAW,SAAQ,kBAAkB;IACpD,IAAI,EAAE,iBAAiB,CAAC,UAAU,CAAC;IACnC,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAS,SAAQ,kBAAkB;IAClD,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC;IACjC,2CAA2C;IAC3C,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACrD,IAAI,EAAE,iBAAiB,CAAC,WAAW,CAAC;IACpC,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB"}
|
package/dist/types.js
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The taxonomy of agent customization types.
|
|
3
|
+
* Each type represents a different way agents can be customized.
|
|
4
|
+
*/
|
|
5
|
+
export var CustomizationType;
|
|
6
|
+
(function (CustomizationType) {
|
|
7
|
+
/** Always-applied prompts (CLAUDE.md, alwaysApply rules) */
|
|
8
|
+
CustomizationType["GlobalPrompt"] = "global-prompt";
|
|
9
|
+
/** Context-triggered by description matching */
|
|
10
|
+
CustomizationType["AgentSkill"] = "agent-skill";
|
|
11
|
+
/** Triggered by file glob patterns */
|
|
12
|
+
CustomizationType["FileRule"] = "file-rule";
|
|
13
|
+
/** Files/patterns to exclude from agent context */
|
|
14
|
+
CustomizationType["AgentIgnore"] = "agent-ignore";
|
|
15
|
+
})(CustomizationType || (CustomizationType = {}));
|
|
16
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAN,IAAY,iBASX;AATD,WAAY,iBAAiB;IAC3B,4DAA4D;IAC5D,mDAA8B,CAAA;IAC9B,gDAAgD;IAChD,+CAA0B,CAAA;IAC1B,sCAAsC;IACtC,2CAAsB,CAAA;IACtB,mDAAmD;IACnD,iDAA4B,CAAA;AAC9B,CAAC,EATW,iBAAiB,KAAjB,iBAAiB,QAS5B"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Warning codes indicating the type of issue encountered.
|
|
3
|
+
*/
|
|
4
|
+
export declare enum WarningCode {
|
|
5
|
+
/** Multiple items were collapsed into one file */
|
|
6
|
+
Merged = "merged",
|
|
7
|
+
/** Feature was translated imperfectly */
|
|
8
|
+
Approximated = "approximated",
|
|
9
|
+
/** Feature was not supported and omitted */
|
|
10
|
+
Skipped = "skipped",
|
|
11
|
+
/** Existing file was replaced */
|
|
12
|
+
Overwritten = "overwritten",
|
|
13
|
+
/** File was renamed to avoid collision */
|
|
14
|
+
FileRenamed = "file-renamed"
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* A warning about something that happened during conversion.
|
|
18
|
+
* Warnings don't stop the conversion but should be surfaced to users.
|
|
19
|
+
*/
|
|
20
|
+
export interface Warning {
|
|
21
|
+
/** The type of warning */
|
|
22
|
+
code: WarningCode;
|
|
23
|
+
/** Human-readable description of the issue */
|
|
24
|
+
message: string;
|
|
25
|
+
/** Source files that were affected (optional) */
|
|
26
|
+
sources?: string[];
|
|
27
|
+
/** Additional details about the warning (optional) */
|
|
28
|
+
details?: Record<string, unknown>;
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=warnings.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"warnings.d.ts","sourceRoot":"","sources":["../src/warnings.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,WAAW;IACrB,kDAAkD;IAClD,MAAM,WAAW;IACjB,yCAAyC;IACzC,YAAY,iBAAiB;IAC7B,4CAA4C;IAC5C,OAAO,YAAY;IACnB,iCAAiC;IACjC,WAAW,gBAAgB;IAC3B,0CAA0C;IAC1C,WAAW,iBAAiB;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,0BAA0B;IAC1B,IAAI,EAAE,WAAW,CAAC;IAClB,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,iDAAiD;IACjD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC"}
|
package/dist/warnings.js
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Warning codes indicating the type of issue encountered.
|
|
3
|
+
*/
|
|
4
|
+
export var WarningCode;
|
|
5
|
+
(function (WarningCode) {
|
|
6
|
+
/** Multiple items were collapsed into one file */
|
|
7
|
+
WarningCode["Merged"] = "merged";
|
|
8
|
+
/** Feature was translated imperfectly */
|
|
9
|
+
WarningCode["Approximated"] = "approximated";
|
|
10
|
+
/** Feature was not supported and omitted */
|
|
11
|
+
WarningCode["Skipped"] = "skipped";
|
|
12
|
+
/** Existing file was replaced */
|
|
13
|
+
WarningCode["Overwritten"] = "overwritten";
|
|
14
|
+
/** File was renamed to avoid collision */
|
|
15
|
+
WarningCode["FileRenamed"] = "file-renamed";
|
|
16
|
+
})(WarningCode || (WarningCode = {}));
|
|
17
|
+
//# sourceMappingURL=warnings.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"warnings.js","sourceRoot":"","sources":["../src/warnings.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,WAWX;AAXD,WAAY,WAAW;IACrB,kDAAkD;IAClD,gCAAiB,CAAA;IACjB,yCAAyC;IACzC,4CAA6B,CAAA;IAC7B,4CAA4C;IAC5C,kCAAmB,CAAA;IACnB,iCAAiC;IACjC,0CAA2B,CAAA;IAC3B,0CAA0C;IAC1C,2CAA4B,CAAA;AAC9B,CAAC,EAXW,WAAW,KAAX,WAAW,QAWtB"}
|
package/package.json
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@a16njs/models",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "Type definitions and plugin interface for a16n",
|
|
5
|
+
"license": "AGPL-3.0",
|
|
6
|
+
"author": "Texarkanine",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "git+https://github.com/Texarkanine/a16n.git",
|
|
10
|
+
"directory": "packages/models"
|
|
11
|
+
},
|
|
12
|
+
"homepage": "https://github.com/Texarkanine/a16n#readme",
|
|
13
|
+
"bugs": {
|
|
14
|
+
"url": "https://github.com/Texarkanine/a16n/issues"
|
|
15
|
+
},
|
|
16
|
+
"keywords": [
|
|
17
|
+
"a16n",
|
|
18
|
+
"models",
|
|
19
|
+
"types",
|
|
20
|
+
"plugin"
|
|
21
|
+
],
|
|
22
|
+
"type": "module",
|
|
23
|
+
"main": "./dist/index.js",
|
|
24
|
+
"types": "./dist/index.d.ts",
|
|
25
|
+
"exports": {
|
|
26
|
+
".": {
|
|
27
|
+
"types": "./dist/index.d.ts",
|
|
28
|
+
"import": "./dist/index.js"
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
"files": ["dist"],
|
|
32
|
+
"scripts": {
|
|
33
|
+
"build": "tsc",
|
|
34
|
+
"clean": "rimraf dist *.tsbuildinfo",
|
|
35
|
+
"typecheck": "tsc --noEmit",
|
|
36
|
+
"test": "vitest run",
|
|
37
|
+
"test:watch": "vitest"
|
|
38
|
+
},
|
|
39
|
+
"devDependencies": {
|
|
40
|
+
"typescript": "^5.4.0",
|
|
41
|
+
"vitest": "^2.0.0"
|
|
42
|
+
}
|
|
43
|
+
}
|