adapt-authoring-contentplugin 0.0.1 → 1.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/.eslintignore +1 -1
- package/.eslintrc +14 -14
- package/.github/ISSUE_TEMPLATE/bug_report.yml +55 -55
- package/.github/ISSUE_TEMPLATE/feature_request.yml +22 -22
- package/.github/dependabot.yml +11 -11
- package/.github/pull_request_template.md +25 -25
- package/.github/workflows/labelled_prs.yml +16 -16
- package/.github/workflows/new.yml +19 -19
- package/.github/workflows/releases.yml +25 -0
- package/adapt-authoring.json +5 -5
- package/conf/config.schema.json +12 -12
- package/errors/errors.json +76 -76
- package/index.js +5 -5
- package/lib/ContentPluginModule.js +440 -438
- package/lib/apidefs.js +67 -67
- package/package.json +52 -17
- package/schema/contentplugin.schema.json +58 -58
package/lib/apidefs.js
CHANGED
|
@@ -1,67 +1,67 @@
|
|
|
1
|
-
export default {
|
|
2
|
-
update: {
|
|
3
|
-
post: {
|
|
4
|
-
summary: 'Update a single content plugin',
|
|
5
|
-
parameters: [{ name: '_id', in: 'path', description: 'Content plugin _id', required: true }],
|
|
6
|
-
responses: {
|
|
7
|
-
200: {
|
|
8
|
-
description: '',
|
|
9
|
-
content: {
|
|
10
|
-
'application/json': {
|
|
11
|
-
schema: { $ref: '#components/schemas/contentplugin' }
|
|
12
|
-
}
|
|
13
|
-
}
|
|
14
|
-
}
|
|
15
|
-
}
|
|
16
|
-
}
|
|
17
|
-
},
|
|
18
|
-
uses: {
|
|
19
|
-
get: {
|
|
20
|
-
summary: 'Return courses using a single content plugin',
|
|
21
|
-
parameters: [{ name: '_id', in: 'path', description: 'Content plugin _id', required: true }],
|
|
22
|
-
responses: {
|
|
23
|
-
200: {
|
|
24
|
-
description: '',
|
|
25
|
-
content: {
|
|
26
|
-
'application/json': {
|
|
27
|
-
schema: {
|
|
28
|
-
type: 'array',
|
|
29
|
-
items: { $ref: '#components/schemas/course' }
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
},
|
|
37
|
-
install: {
|
|
38
|
-
post: {
|
|
39
|
-
summary: 'Import an Adapt course',
|
|
40
|
-
requestBody: {
|
|
41
|
-
content: {
|
|
42
|
-
'application/json': {
|
|
43
|
-
schema: {
|
|
44
|
-
$schema: 'https://json-schema.org/draft/2020-12/schema',
|
|
45
|
-
type: 'object',
|
|
46
|
-
properties: {
|
|
47
|
-
name: { type: 'string' },
|
|
48
|
-
version: { type: 'string' },
|
|
49
|
-
force: { type: 'Boolean', default: false }
|
|
50
|
-
}
|
|
51
|
-
}
|
|
52
|
-
}
|
|
53
|
-
}
|
|
54
|
-
},
|
|
55
|
-
responses: {
|
|
56
|
-
200: {
|
|
57
|
-
description: '',
|
|
58
|
-
content: {
|
|
59
|
-
'application/json': {
|
|
60
|
-
schema: { $ref: '#components/schemas/contentplugin' }
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
}
|
|
67
|
-
}
|
|
1
|
+
export default {
|
|
2
|
+
update: {
|
|
3
|
+
post: {
|
|
4
|
+
summary: 'Update a single content plugin',
|
|
5
|
+
parameters: [{ name: '_id', in: 'path', description: 'Content plugin _id', required: true }],
|
|
6
|
+
responses: {
|
|
7
|
+
200: {
|
|
8
|
+
description: '',
|
|
9
|
+
content: {
|
|
10
|
+
'application/json': {
|
|
11
|
+
schema: { $ref: '#components/schemas/contentplugin' }
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
uses: {
|
|
19
|
+
get: {
|
|
20
|
+
summary: 'Return courses using a single content plugin',
|
|
21
|
+
parameters: [{ name: '_id', in: 'path', description: 'Content plugin _id', required: true }],
|
|
22
|
+
responses: {
|
|
23
|
+
200: {
|
|
24
|
+
description: '',
|
|
25
|
+
content: {
|
|
26
|
+
'application/json': {
|
|
27
|
+
schema: {
|
|
28
|
+
type: 'array',
|
|
29
|
+
items: { $ref: '#components/schemas/course' }
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
},
|
|
37
|
+
install: {
|
|
38
|
+
post: {
|
|
39
|
+
summary: 'Import an Adapt course',
|
|
40
|
+
requestBody: {
|
|
41
|
+
content: {
|
|
42
|
+
'application/json': {
|
|
43
|
+
schema: {
|
|
44
|
+
$schema: 'https://json-schema.org/draft/2020-12/schema',
|
|
45
|
+
type: 'object',
|
|
46
|
+
properties: {
|
|
47
|
+
name: { type: 'string' },
|
|
48
|
+
version: { type: 'string' },
|
|
49
|
+
force: { type: 'Boolean', default: false }
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
},
|
|
55
|
+
responses: {
|
|
56
|
+
200: {
|
|
57
|
+
description: '',
|
|
58
|
+
content: {
|
|
59
|
+
'application/json': {
|
|
60
|
+
schema: { $ref: '#components/schemas/contentplugin' }
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
package/package.json
CHANGED
|
@@ -1,17 +1,52 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "adapt-authoring-contentplugin",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "Module for managing framework plugins",
|
|
5
|
-
"homepage": "https://github.com/adapt-security/adapt-authoring-contentplugin",
|
|
6
|
-
"main": "index.js",
|
|
7
|
-
"type": "module",
|
|
8
|
-
"dependencies": {
|
|
9
|
-
"adapt-cli": "github:adaptlearning/adapt-cli#v3.3.
|
|
10
|
-
"glob": "^11.0.0",
|
|
11
|
-
"semver": "^7.6.0"
|
|
12
|
-
},
|
|
13
|
-
"devDependencies": {
|
|
14
|
-
"eslint": "^9.12.0",
|
|
15
|
-
"standard": "^17.1.0"
|
|
16
|
-
|
|
17
|
-
|
|
1
|
+
{
|
|
2
|
+
"name": "adapt-authoring-contentplugin",
|
|
3
|
+
"version": "1.0.1",
|
|
4
|
+
"description": "Module for managing framework plugins",
|
|
5
|
+
"homepage": "https://github.com/adapt-security/adapt-authoring-contentplugin",
|
|
6
|
+
"main": "index.js",
|
|
7
|
+
"type": "module",
|
|
8
|
+
"dependencies": {
|
|
9
|
+
"adapt-cli": "github:adaptlearning/adapt-cli#v3.3.3",
|
|
10
|
+
"glob": "^11.0.0",
|
|
11
|
+
"semver": "^7.6.0"
|
|
12
|
+
},
|
|
13
|
+
"devDependencies": {
|
|
14
|
+
"eslint": "^9.12.0",
|
|
15
|
+
"standard": "^17.1.0",
|
|
16
|
+
"@semantic-release/commit-analyzer": "^9.0.2",
|
|
17
|
+
"@semantic-release/git": "^10.0.1",
|
|
18
|
+
"@semantic-release/github": "^8.0.5",
|
|
19
|
+
"@semantic-release/npm": "^9.0.1",
|
|
20
|
+
"@semantic-release/release-notes-generator": "^10.0.3",
|
|
21
|
+
"conventional-changelog-eslint": "^3.0.9",
|
|
22
|
+
"semantic-release": "^21.0.1",
|
|
23
|
+
"semantic-release-replace-plugin": "^1.2.7"
|
|
24
|
+
},
|
|
25
|
+
"release": {
|
|
26
|
+
"plugins": [
|
|
27
|
+
[
|
|
28
|
+
"@semantic-release/commit-analyzer",
|
|
29
|
+
{
|
|
30
|
+
"preset": "eslint"
|
|
31
|
+
}
|
|
32
|
+
],
|
|
33
|
+
[
|
|
34
|
+
"@semantic-release/release-notes-generator",
|
|
35
|
+
{
|
|
36
|
+
"preset": "eslint"
|
|
37
|
+
}
|
|
38
|
+
],
|
|
39
|
+
"@semantic-release/npm",
|
|
40
|
+
"@semantic-release/github",
|
|
41
|
+
[
|
|
42
|
+
"@semantic-release/git",
|
|
43
|
+
{
|
|
44
|
+
"assets": [
|
|
45
|
+
"package.json"
|
|
46
|
+
],
|
|
47
|
+
"message": "Chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
|
|
48
|
+
}
|
|
49
|
+
]
|
|
50
|
+
]
|
|
51
|
+
}
|
|
52
|
+
}
|
|
@@ -1,58 +1,58 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$anchor": "contentplugin",
|
|
4
|
-
"description": "An Adapt framework plugin",
|
|
5
|
-
"type": "object",
|
|
6
|
-
"properties": {
|
|
7
|
-
"name": {
|
|
8
|
-
"description": "Unique name for the plugin",
|
|
9
|
-
"type": "string"
|
|
10
|
-
},
|
|
11
|
-
"displayName": {
|
|
12
|
-
"description": "User-friendly name for the plugin",
|
|
13
|
-
"type": "string"
|
|
14
|
-
},
|
|
15
|
-
"version": {
|
|
16
|
-
"description": "Version number for the plugin",
|
|
17
|
-
"type": "string"
|
|
18
|
-
},
|
|
19
|
-
"framework": {
|
|
20
|
-
"description": "",
|
|
21
|
-
"type": "string"
|
|
22
|
-
},
|
|
23
|
-
"isLocalInstall": {
|
|
24
|
-
"description": "Whether the plugin has been installed locally (as opposed to with the CLI)",
|
|
25
|
-
"type": "boolean"
|
|
26
|
-
},
|
|
27
|
-
"isEnabled": {
|
|
28
|
-
"description": "",
|
|
29
|
-
"type": "boolean",
|
|
30
|
-
"default": true
|
|
31
|
-
},
|
|
32
|
-
"type": {
|
|
33
|
-
"description": "",
|
|
34
|
-
"type": "string"
|
|
35
|
-
},
|
|
36
|
-
"targetAttribute": {
|
|
37
|
-
"description": "",
|
|
38
|
-
"type": "string"
|
|
39
|
-
},
|
|
40
|
-
"description": {
|
|
41
|
-
"description": "",
|
|
42
|
-
"type": "string"
|
|
43
|
-
},
|
|
44
|
-
"pluginDependencies": {
|
|
45
|
-
"description": "",
|
|
46
|
-
"type": "object"
|
|
47
|
-
},
|
|
48
|
-
"canBeUpdated" : {
|
|
49
|
-
"type": "boolean",
|
|
50
|
-
"isReadOnly": true
|
|
51
|
-
},
|
|
52
|
-
"latestCompatibleVersion" : {
|
|
53
|
-
"type": "boolean",
|
|
54
|
-
"isReadOnly": true
|
|
55
|
-
}
|
|
56
|
-
},
|
|
57
|
-
"required": ["framework", "name", "type", "version", "isLocalInstall"]
|
|
58
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$anchor": "contentplugin",
|
|
4
|
+
"description": "An Adapt framework plugin",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"name": {
|
|
8
|
+
"description": "Unique name for the plugin",
|
|
9
|
+
"type": "string"
|
|
10
|
+
},
|
|
11
|
+
"displayName": {
|
|
12
|
+
"description": "User-friendly name for the plugin",
|
|
13
|
+
"type": "string"
|
|
14
|
+
},
|
|
15
|
+
"version": {
|
|
16
|
+
"description": "Version number for the plugin",
|
|
17
|
+
"type": "string"
|
|
18
|
+
},
|
|
19
|
+
"framework": {
|
|
20
|
+
"description": "",
|
|
21
|
+
"type": "string"
|
|
22
|
+
},
|
|
23
|
+
"isLocalInstall": {
|
|
24
|
+
"description": "Whether the plugin has been installed locally (as opposed to with the CLI)",
|
|
25
|
+
"type": "boolean"
|
|
26
|
+
},
|
|
27
|
+
"isEnabled": {
|
|
28
|
+
"description": "",
|
|
29
|
+
"type": "boolean",
|
|
30
|
+
"default": true
|
|
31
|
+
},
|
|
32
|
+
"type": {
|
|
33
|
+
"description": "",
|
|
34
|
+
"type": "string"
|
|
35
|
+
},
|
|
36
|
+
"targetAttribute": {
|
|
37
|
+
"description": "",
|
|
38
|
+
"type": "string"
|
|
39
|
+
},
|
|
40
|
+
"description": {
|
|
41
|
+
"description": "",
|
|
42
|
+
"type": "string"
|
|
43
|
+
},
|
|
44
|
+
"pluginDependencies": {
|
|
45
|
+
"description": "",
|
|
46
|
+
"type": "object"
|
|
47
|
+
},
|
|
48
|
+
"canBeUpdated" : {
|
|
49
|
+
"type": "boolean",
|
|
50
|
+
"isReadOnly": true
|
|
51
|
+
},
|
|
52
|
+
"latestCompatibleVersion" : {
|
|
53
|
+
"type": "boolean",
|
|
54
|
+
"isReadOnly": true
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
"required": ["framework", "name", "type", "version", "isLocalInstall"]
|
|
58
|
+
}
|