@arkstack/driver-express 0.1.1 → 0.1.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/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import express, { type ErrorRequestHandler, type Express, type Handler } from
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import express, { type ErrorRequestHandler, type Express, type Handler } from 'express'\n\nimport { ArkstackKitDriver, PromiseOrValue } from '@arkstack/contract'\n\nexport interface ExpressDriverOptions {\n bindRouter: (app: Express) => PromiseOrValue<void>;\n errorHandler?: ErrorRequestHandler | Handler;\n}\n\n/**\n * The ExpressDriver class implements the ArkstackKitDriver \n * contract for the Express framework.\n */\nexport class ExpressDriver extends ArkstackKitDriver<Express, Handler> {\n readonly name = 'express'\n private readonly options: ExpressDriverOptions\n\n /**\n * Creates an instance of ExpressDriver.\n * \n * @param options \n */\n constructor(options: ExpressDriverOptions) {\n super()\n this.options = options\n }\n\n /**\n * Creates an Express application instance.\n * \n * @returns \n */\n createApp (): Express {\n return express()\n }\n\n /**\n * Mounts static assets from the specified public path to the Express application.\n * \n * @param app \n * @param publicPath \n */\n mountPublicAssets (app: Express, publicPath: string): void {\n app.use(express.static(publicPath))\n }\n\n /**\n * Binds the router to the Express application using the provided bindRouter function.\n * \n * @param app \n */\n bindRouter (app: Express): PromiseOrValue<void> {\n return this.options.bindRouter(app)\n }\n\n /**\n * Applies middleware to the Express application.\n * \n * @param app \n * @param middleware \n */\n applyMiddleware (app: Express, middleware: Handler): void {\n app.use(middleware)\n }\n\n /**\n * Registers an error handler middleware to the Express \n * application if provided in the options.\n * \n * @param app \n */\n registerErrorHandler (app: Express): void {\n if (this.options.errorHandler) {\n app.use(this.options.errorHandler as ErrorRequestHandler)\n }\n }\n\n /**\n * Starts the Express server on the specified port.\n * \n * @param app \n * @param port \n */\n start (app: Express, port: number): void {\n app.listen(port, () => {\n console.log(`Server is running on http://localhost:${port}`)\n })\n }\n}\n"],"mappings":";;;;;;;;AAaA,IAAa,gBAAb,cAAmC,kBAAoC;CACnE,AAAS,OAAO;CAChB,AAAiB;;;;;;CAOjB,YAAY,SAA+B;AACvC,SAAO;AACP,OAAK,UAAU;;;;;;;CAQnB,YAAsB;AAClB,SAAO,SAAS;;;;;;;;CASpB,kBAAmB,KAAc,YAA0B;AACvD,MAAI,IAAI,QAAQ,OAAO,WAAW,CAAC;;;;;;;CAQvC,WAAY,KAAoC;AAC5C,SAAO,KAAK,QAAQ,WAAW,IAAI;;;;;;;;CASvC,gBAAiB,KAAc,YAA2B;AACtD,MAAI,IAAI,WAAW;;;;;;;;CASvB,qBAAsB,KAAoB;AACtC,MAAI,KAAK,QAAQ,aACb,KAAI,IAAI,KAAK,QAAQ,aAAoC;;;;;;;;CAUjE,MAAO,KAAc,MAAoB;AACrC,MAAI,OAAO,YAAY;AACnB,WAAQ,IAAI,yCAAyC,OAAO;IAC9D"}
|
package/package.json
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arkstack/driver-express",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Express driver package for Arkstack providing Express-specific implementations of core Arkstack features such as routing, middleware, and database integration.",
|
|
6
|
+
"homepage": "https://arkstack.toneflix.net",
|
|
6
7
|
"repository": {
|
|
7
8
|
"type": "git",
|
|
8
9
|
"url": "git+https://github.com/arkstack-hq/arkstack.git",
|
|
@@ -34,7 +35,7 @@
|
|
|
34
35
|
"./package.json": "./package.json"
|
|
35
36
|
},
|
|
36
37
|
"dependencies": {
|
|
37
|
-
"@arkstack/contract": "^0.1.
|
|
38
|
+
"@arkstack/contract": "^0.1.3"
|
|
38
39
|
},
|
|
39
40
|
"peerDependencies": {
|
|
40
41
|
"express": "^5.2.1"
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
import BaseController from '@controllers/BaseController'
|
|
1
|
+
import { BaseController } from '@controllers/BaseController'
|
|
2
2
|
import { HttpContext } from 'clear-router/types/express'
|
|
3
3
|
import {{ResourceName}} from '@app/http/resources/{{ResourceName}}'
|
|
4
4
|
import {{CollectionResourceName}} from '@app/http/resources/{{CollectionResourceName}}'
|
|
5
5
|
|
|
6
|
-
import { Resource, ResourceCollection } from 'resora'
|
|
6
|
+
import { Resource, ResourceCollection } from 'resora'
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
9
|
* {{ControllerName}}
|
|
10
10
|
*/
|
|
11
|
-
export default class extends BaseController {
|
|
11
|
+
export default class {{ControllerName}} extends BaseController {
|
|
12
12
|
/**
|
|
13
13
|
* Get all resources
|
|
14
14
|
*
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import BaseController from '@controllers/BaseController'
|
|
1
|
+
import { BaseController } from '@controllers/BaseController'
|
|
2
2
|
import { HttpContext } from 'clear-router/types/express'
|
|
3
|
-
import { Resource, ResourceCollection } from "resora"
|
|
3
|
+
import { Resource, ResourceCollection } from "resora"
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* {{ControllerName}}
|
|
7
7
|
*/
|
|
8
|
-
export default class extends BaseController {
|
|
8
|
+
export default class {{ControllerName}} extends BaseController {
|
|
9
9
|
/**
|
|
10
10
|
* Get all resources
|
|
11
11
|
*
|
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import BaseController from '@controllers/BaseController'
|
|
1
|
+
import { BaseController } from '@controllers/BaseController'
|
|
2
2
|
import { HttpContext } from 'clear-router/types/express'
|
|
3
|
-
import { Resource, ResourceCollection } from "resora"
|
|
4
|
-
import {
|
|
3
|
+
import { Resource, ResourceCollection } from "resora"
|
|
4
|
+
import { {{Model}} } from 'src/models/{{Model}}'
|
|
5
5
|
|
|
6
6
|
/**
|
|
7
7
|
* {{ControllerName}}
|
|
8
8
|
*/
|
|
9
|
-
export default class extends BaseController {
|
|
9
|
+
export default class {{ControllerName}} extends BaseController {
|
|
10
10
|
/**
|
|
11
11
|
* Get all resource from the database
|
|
12
12
|
*
|
|
@@ -15,9 +15,7 @@ export default class extends BaseController {
|
|
|
15
15
|
*/
|
|
16
16
|
index = async ({ res }: HttpContext) => {
|
|
17
17
|
return new ResourceCollection({
|
|
18
|
-
data: await
|
|
19
|
-
{ orderBy: { id: 'asc' } }
|
|
20
|
-
),
|
|
18
|
+
data: await {{Model}}.query().orderBy({ id: 'asc' }).get(),
|
|
21
19
|
}, res)
|
|
22
20
|
.additional({
|
|
23
21
|
status: 'success',
|
|
@@ -36,9 +34,7 @@ export default class extends BaseController {
|
|
|
36
34
|
*/
|
|
37
35
|
show = async ({ req, res }: HttpContext) => {
|
|
38
36
|
return new Resource({
|
|
39
|
-
data: await
|
|
40
|
-
{ where: { id: String(req.params.id) } }
|
|
41
|
-
),
|
|
37
|
+
data: await {{Model}}.query().where({ id: String(req.params.id) }).firstOrFail(),
|
|
42
38
|
}, res)
|
|
43
39
|
.additional({
|
|
44
40
|
status: 'success',
|
|
@@ -60,7 +56,7 @@ export default class extends BaseController {
|
|
|
60
56
|
* @param res
|
|
61
57
|
*/
|
|
62
58
|
create = async ({ req, res }: HttpContext) => {
|
|
63
|
-
const data = await
|
|
59
|
+
const data = await {{Model}}.query().create({
|
|
64
60
|
data: req.body,
|
|
65
61
|
})
|
|
66
62
|
|
|
@@ -83,9 +79,8 @@ export default class extends BaseController {
|
|
|
83
79
|
* @param res
|
|
84
80
|
*/
|
|
85
81
|
update = async ({ req, res }: HttpContext) => {
|
|
86
|
-
const data = await
|
|
87
|
-
|
|
88
|
-
data: req.body(),
|
|
82
|
+
const data = await {{Model}}.query().where({ id: String(req.params.id) }).update({
|
|
83
|
+
data: req.body,
|
|
89
84
|
})
|
|
90
85
|
|
|
91
86
|
return new Resource({
|
|
@@ -107,9 +102,7 @@ export default class extends BaseController {
|
|
|
107
102
|
* @param res
|
|
108
103
|
*/
|
|
109
104
|
destroy = async ({ req, res }: HttpContext) => {
|
|
110
|
-
await
|
|
111
|
-
{ where: { id: String(req.params.id) } }
|
|
112
|
-
)
|
|
105
|
+
await {{Model}}.query().where({ id: String(req.params.id) }).delete()
|
|
113
106
|
|
|
114
107
|
return new Resource({
|
|
115
108
|
data: {},
|
package/stubs/controller.stub
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import BaseController from '@controllers/BaseController'
|
|
1
|
+
import { BaseController } from '@controllers/BaseController'
|
|
2
2
|
import { HttpContext } from 'clear-router/types/express'
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* {{ControllerName}}
|
|
6
6
|
*/
|
|
7
|
-
export default class extends BaseController {
|
|
7
|
+
export default class {{ControllerName}} extends BaseController {
|
|
8
8
|
index = async ({ res }: HttpContext) => {
|
|
9
9
|
res.send('<p>Hello!</p>')
|
|
10
10
|
}
|