@aionis/doc-module-copy-summary 0.1.0
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 +43 -0
- package/index.mjs +41 -0
- package/package.json +31 -0
package/CHANGELOG.md
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# @aionis/doc-module-copy-summary
|
|
2
|
+
|
|
3
|
+
Official Aionis Doc module that joins a list of claims into a single summary string.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm i @aionis/doc-module-copy-summary@0.1.0
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Input
|
|
12
|
+
|
|
13
|
+
```json
|
|
14
|
+
{
|
|
15
|
+
"claims": ["Aionis", "turns docs into workflows."]
|
|
16
|
+
}
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Output
|
|
20
|
+
|
|
21
|
+
```json
|
|
22
|
+
{
|
|
23
|
+
"summary": "Aionis turns docs into workflows."
|
|
24
|
+
}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Exports
|
|
28
|
+
|
|
29
|
+
1. `manifest`
|
|
30
|
+
2. `handler`
|
|
31
|
+
|
|
32
|
+
## Module ID
|
|
33
|
+
|
|
34
|
+
`copy.summary.v1`
|
|
35
|
+
|
|
36
|
+
## Registry Entry
|
|
37
|
+
|
|
38
|
+
```json
|
|
39
|
+
{
|
|
40
|
+
"module": "copy.summary.v1",
|
|
41
|
+
"package": "@aionis/doc-module-copy-summary"
|
|
42
|
+
}
|
|
43
|
+
```
|
package/index.mjs
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
export const manifest = {
|
|
2
|
+
module: "copy.summary.v1",
|
|
3
|
+
version: "1.0.0",
|
|
4
|
+
title: "Copy Summary",
|
|
5
|
+
description: "Join an ordered list of claims into one summary string.",
|
|
6
|
+
deterministic: true,
|
|
7
|
+
required_capabilities: ["direct_execution"],
|
|
8
|
+
input_contract: {
|
|
9
|
+
kind: "object",
|
|
10
|
+
properties: {
|
|
11
|
+
claims: {
|
|
12
|
+
kind: "array",
|
|
13
|
+
items: { kind: "string" }
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
required: ["claims"],
|
|
17
|
+
additional_properties: false
|
|
18
|
+
},
|
|
19
|
+
output_contract: {
|
|
20
|
+
kind: "object",
|
|
21
|
+
properties: {
|
|
22
|
+
summary: { kind: "string" }
|
|
23
|
+
},
|
|
24
|
+
required: ["summary"],
|
|
25
|
+
additional_properties: false
|
|
26
|
+
}
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
export async function handler(input) {
|
|
30
|
+
const claims =
|
|
31
|
+
input && typeof input === "object" && Array.isArray(input.claims)
|
|
32
|
+
? input.claims.filter((item) => typeof item === "string")
|
|
33
|
+
: [];
|
|
34
|
+
|
|
35
|
+
return {
|
|
36
|
+
kind: "module_result",
|
|
37
|
+
output: {
|
|
38
|
+
summary: claims.join(" ")
|
|
39
|
+
}
|
|
40
|
+
};
|
|
41
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@aionis/doc-module-copy-summary",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Official Aionis Doc module for joining claim arrays into a summary string.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "index.mjs",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": "./index.mjs"
|
|
9
|
+
},
|
|
10
|
+
"files": [
|
|
11
|
+
"index.mjs",
|
|
12
|
+
"README.md",
|
|
13
|
+
"CHANGELOG.md"
|
|
14
|
+
],
|
|
15
|
+
"publishConfig": {
|
|
16
|
+
"access": "public"
|
|
17
|
+
},
|
|
18
|
+
"engines": {
|
|
19
|
+
"node": ">=18.0.0"
|
|
20
|
+
},
|
|
21
|
+
"keywords": [
|
|
22
|
+
"aionis-doc",
|
|
23
|
+
"module",
|
|
24
|
+
"summary"
|
|
25
|
+
],
|
|
26
|
+
"author": "Aionis Core",
|
|
27
|
+
"license": "Apache-2.0",
|
|
28
|
+
"scripts": {
|
|
29
|
+
"pack:dry-run": "npm pack --dry-run --cache /tmp/aionis-npm-cache"
|
|
30
|
+
}
|
|
31
|
+
}
|