@owlmeans/entrypoint 0.1.7 → 0.1.8
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
CHANGED
|
@@ -93,3 +93,20 @@ enum EntrypointOutcome { Ok, Accepted, Created, Finished }
|
|
|
93
93
|
- [`@owlmeans/server-entrypoint`](../server-entrypoint) — server-side `elevate()` to attach handlers
|
|
94
94
|
- [`@owlmeans/client-entrypoint`](../client-entrypoint) — client-side entrypoint with API call support
|
|
95
95
|
- [`@owlmeans/server-app`](../server-app) — re-exports everything from this package
|
|
96
|
+
|
|
97
|
+
<!-- owlmeans:agent-guidance:start -->
|
|
98
|
+
## Agent guidance
|
|
99
|
+
|
|
100
|
+
This package ships embedded Claude Code skills and GitHub Copilot instructions under
|
|
101
|
+
`agent-meta/`. After installing your `@owlmeans/*` packages, run the OwlMeans
|
|
102
|
+
agent-skills installer to place them into your project's native locations
|
|
103
|
+
(`.claude/skills/` and `.github/instructions/`):
|
|
104
|
+
|
|
105
|
+
```sh
|
|
106
|
+
npx @owlmeans/agent-skills
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
The embedded files are version-matched to this package release. Do not edit them
|
|
110
|
+
directly — they are regenerated on each publish. To contribute guidance edits,
|
|
111
|
+
open a PR against the source monorepo.
|
|
112
|
+
<!-- owlmeans:agent-guidance:end -->
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "How to use @owlmeans/entrypoint — declarative entrypoint/route definitions with entrypoint(), guard(), gate(), filter(), body(), params(), query() builders. Use when defining a service entrypoint declaration. Also covers the deprecated @owlmeans/module reexport shim (module() → entrypoint())."
|
|
3
|
+
applyTo: "**/modules.ts, **/modules.tsx, **/*.ts, **/*.tsx"
|
|
4
|
+
---
|
|
5
|
+
<!-- AUTO-GENERATED — do not edit. Regenerate via sync-agent-meta. -->
|
|
6
|
+
|
|
7
|
+
# @owlmeans/entrypoint
|
|
8
|
+
|
|
9
|
+
**Layer:** Core
|
|
10
|
+
**Install:** `"@owlmeans/entrypoint": "^0.1.8"` in `dependencies`
|
|
11
|
+
|
|
12
|
+
## Key Exports
|
|
13
|
+
|
|
14
|
+
| Export | Description |
|
|
15
|
+
|--------|-------------|
|
|
16
|
+
| `entrypoint(...builders)` | Compose an entrypoint declaration |
|
|
17
|
+
| `guard(alias, ...gates)` | Attach a security guard |
|
|
18
|
+
| `gate(alias, scopes[])` | Define an auth gate inside a guard |
|
|
19
|
+
| `filter(...validators)` | Attach request validators |
|
|
20
|
+
| `body(Schema)`, `params(Schema)`, `query(Schema)` | AJV validators |
|
|
21
|
+
| `ClientEntrypoint<T>` | Resolved entrypoint type for `ctx.entrypoint<...>(alias).call(...)` |
|
|
22
|
+
| `EntrypointOutcome` | Enum: Ok, Accepted, Created, Finished |
|
|
23
|
+
| Constants | Built-in entrypoint aliases |
|
|
24
|
+
|
|
25
|
+
## Subpath Exports
|
|
26
|
+
|
|
27
|
+
- `./utils` — entrypoint construction helpers
|
|
28
|
+
|
|
29
|
+
## Usage
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import { entrypoint, guard, gate, filter, body } from '@owlmeans/entrypoint'
|
|
33
|
+
import { route, RouteMethod } from '@owlmeans/route'
|
|
34
|
+
import { DEFAULT_GUARD } from '@owlmeans/auth-common'
|
|
35
|
+
import { OIDC_GATE } from '@owlmeans/oidc'
|
|
36
|
+
|
|
37
|
+
export const managerModules = [
|
|
38
|
+
entrypoint(
|
|
39
|
+
route(manager.back.project.create, '/create', {
|
|
40
|
+
parent: manager.back.project.base,
|
|
41
|
+
method: RouteMethod.POST,
|
|
42
|
+
}),
|
|
43
|
+
filter(body(CreateProjectSchema)),
|
|
44
|
+
guard(DEFAULT_GUARD, gate(OIDC_GATE, [`my-service-{entity}`]))
|
|
45
|
+
),
|
|
46
|
+
]
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Depends On
|
|
50
|
+
|
|
51
|
+
- `@owlmeans/route`, `@owlmeans/auth-common`, `@owlmeans/error`, `@owlmeans/i18n`
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
{
|
|
2
|
+
"schemaVersion": 1,
|
|
3
|
+
"package": "@owlmeans/entrypoint",
|
|
4
|
+
"version": "0.1.8",
|
|
5
|
+
"generatedAt": "2026-06-11T16:30:27.185Z",
|
|
6
|
+
"canonicalRepo": "https://github.com/owlmeans/common",
|
|
7
|
+
"entries": [
|
|
8
|
+
{
|
|
9
|
+
"kind": "skill",
|
|
10
|
+
"name": "entrypoint",
|
|
11
|
+
"category": "package-specific",
|
|
12
|
+
"file": "skills/entrypoint/SKILL.md",
|
|
13
|
+
"canonicalPath": ".claude/skills/entrypoint/SKILL.md"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"kind": "instruction",
|
|
17
|
+
"name": "entrypoint",
|
|
18
|
+
"category": "package-specific",
|
|
19
|
+
"file": "instructions/entrypoint.instructions.md",
|
|
20
|
+
"canonicalPath": ".github/instructions/entrypoint.instructions.md"
|
|
21
|
+
}
|
|
22
|
+
]
|
|
23
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: entrypoint
|
|
3
|
+
description: How to use @owlmeans/entrypoint — declarative entrypoint/route definitions with entrypoint(), guard(), gate(), filter(), body(), params(), query() builders. Auto-invoked when importing from this package or defining a service entrypoint declaration. Also covers the deprecated @owlmeans/module reexport shim (module() → entrypoint()).
|
|
4
|
+
user-invocable: false
|
|
5
|
+
---
|
|
6
|
+
<!-- AUTO-GENERATED — do not edit. Regenerate via sync-agent-meta. -->
|
|
7
|
+
|
|
8
|
+
# @owlmeans/entrypoint
|
|
9
|
+
|
|
10
|
+
**Layer:** Core
|
|
11
|
+
**Install:** `"@owlmeans/entrypoint": "^0.1.8"` in `dependencies`
|
|
12
|
+
|
|
13
|
+
## Key Exports
|
|
14
|
+
|
|
15
|
+
| Export | Description |
|
|
16
|
+
|--------|-------------|
|
|
17
|
+
| `entrypoint(...builders)` | Compose an entrypoint declaration from builders |
|
|
18
|
+
| `guard(alias, ...gates)` | Attach a security guard |
|
|
19
|
+
| `gate(alias, scopes[])` | Define an auth gate (used inside a guard) |
|
|
20
|
+
| `filter(...validators)` | Attach request validators |
|
|
21
|
+
| `body(Schema)` | AJV body validator |
|
|
22
|
+
| `params(Schema)` | URL params validator |
|
|
23
|
+
| `query(Schema)` | Query string validator |
|
|
24
|
+
| `ClientEntrypoint<T>` types | Resolved entrypoint type used for `ctx.entrypoint<...>(alias).call(...)` |
|
|
25
|
+
| `EntrypointOutcome` | Enum: Ok, Accepted, Created, Finished |
|
|
26
|
+
| Constants | Built-in entrypoint aliases |
|
|
27
|
+
|
|
28
|
+
## Subpath Exports
|
|
29
|
+
|
|
30
|
+
- `./utils` — entrypoint construction helpers (`isEntrypoint`, `CreateEntrypointSignature`)
|
|
31
|
+
|
|
32
|
+
## Usage
|
|
33
|
+
|
|
34
|
+
Define entrypoints in a shared `common` package, then `elevate()` them with handlers in server/web packages:
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
import { entrypoint, guard, gate, filter, body } from '@owlmeans/entrypoint'
|
|
38
|
+
import { route, RouteMethod } from '@owlmeans/route'
|
|
39
|
+
import { DEFAULT_GUARD } from '@owlmeans/auth-common'
|
|
40
|
+
import { OIDC_GATE } from '@owlmeans/oidc'
|
|
41
|
+
import { CreateProjectSchema } from './schemas.js'
|
|
42
|
+
|
|
43
|
+
export const managerModules = [
|
|
44
|
+
entrypoint(
|
|
45
|
+
route(manager.back.account.base, '/account'),
|
|
46
|
+
guard(DEFAULT_GUARD, gate(OIDC_GATE, [`my-service-account-{entity}`]))
|
|
47
|
+
),
|
|
48
|
+
entrypoint(
|
|
49
|
+
route(manager.back.project.create, '/create', {
|
|
50
|
+
parent: manager.back.project.base,
|
|
51
|
+
method: RouteMethod.POST,
|
|
52
|
+
}),
|
|
53
|
+
filter(body(CreateProjectSchema))
|
|
54
|
+
),
|
|
55
|
+
]
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Depends On
|
|
59
|
+
|
|
60
|
+
- `@owlmeans/route` — `route()`, `RouteMethod`
|
|
61
|
+
- `@owlmeans/auth-common` — guard aliases (`DEFAULT_GUARD`)
|
|
62
|
+
- `@owlmeans/error`, `@owlmeans/i18n`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@owlmeans/entrypoint",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.8",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"scripts": {
|
|
@@ -28,9 +28,9 @@
|
|
|
28
28
|
}
|
|
29
29
|
},
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@owlmeans/auth": "^0.1.
|
|
32
|
-
"@owlmeans/context": "^0.1.
|
|
33
|
-
"@owlmeans/route": "^0.1.
|
|
31
|
+
"@owlmeans/auth": "^0.1.8",
|
|
32
|
+
"@owlmeans/context": "^0.1.8",
|
|
33
|
+
"@owlmeans/route": "^0.1.8",
|
|
34
34
|
"ajv": "^8.17.1"
|
|
35
35
|
},
|
|
36
36
|
"devDependencies": {
|