soul-cli 0.0.7 → 0.0.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "soul-cli",
3
- "version": "0.0.7",
3
+ "version": "0.0.8",
4
4
  "description": "A SQLite RESTful server",
5
5
  "main": "src/server.js",
6
6
  "bin": {
@@ -578,10 +578,94 @@ const updateRowInTableByPK = async (req, res) => {
578
578
 
579
579
  const query = `UPDATE ${tableName} SET ${fieldsString} WHERE ${lookupField} = '${pk}'`;
580
580
  try {
581
- db.prepare(query).run();
581
+ const data = db.prepare(query).run();
582
582
 
583
583
  res.json({
584
584
  message: 'Row updated',
585
+ data,
586
+ });
587
+ } catch (error) {
588
+ res.status(400).json({
589
+ message: error.message,
590
+ error: error,
591
+ });
592
+ }
593
+ };
594
+
595
+ // Update a row by pk
596
+ const bulkUpdateRowsInTableByPK = async (req, res) => {
597
+ /*
598
+ #swagger.tags = ['Rows']
599
+ #swagger.summary = 'Bulk Update Rows'
600
+ #swagger.description = 'Bulk Update rows by primary key'
601
+ #swagger.parameters['name'] = {
602
+ in: 'path',
603
+ description: 'Table name',
604
+ required: true,
605
+ type: 'string'
606
+ }
607
+
608
+ #swagger.parameters['body'] = {
609
+ in: 'body',
610
+ required: true,
611
+ type: 'object',
612
+ schema: { $ref: "#/definitions/BulkUpdateRowsRequestBody" }
613
+ }
614
+
615
+ #swagger.parameters['_lookup_field'] = {
616
+ in: 'query',
617
+ description: 'If you want to update row by any other field than primary key, use this parameter',
618
+ required: false,
619
+ type: 'string'
620
+ }
621
+ */
622
+
623
+ const { name: tableName } = req.params;
624
+ const { pks, fields } = req.body;
625
+ const { _lookup_field } = req.query;
626
+
627
+ let lookupField = _lookup_field;
628
+
629
+ if (!_lookup_field) {
630
+ // find the primary key of the table
631
+ try {
632
+ lookupField = db
633
+ .prepare(`PRAGMA table_info(${tableName})`)
634
+ .all()
635
+ .find((field) => field.pk === 1).name;
636
+ } catch (error) {
637
+ return res.status(400).json({
638
+ message: error.message,
639
+ error: error,
640
+ });
641
+ }
642
+ }
643
+
644
+ // wrap text values in quotes
645
+ const fieldsString = Object.keys(fields)
646
+ .map((key) => {
647
+ let value = fields[key];
648
+ if (typeof value === 'string') {
649
+ value = `'${value}'`;
650
+ }
651
+ return `${key} = ${value}`;
652
+ })
653
+ .join(', ');
654
+
655
+ if (fieldsString === '') {
656
+ return res.status(400).json({
657
+ message: 'No fields provided',
658
+ error: 'no_fields_provided',
659
+ });
660
+ }
661
+
662
+ const query = `UPDATE ${tableName} SET ${fieldsString} WHERE ${lookupField} in (${pks})`;
663
+ try {
664
+ const data = db.prepare(query).run();
665
+
666
+ res.json({
667
+ message: 'Rows updated',
668
+ data,
585
669
  });
586
670
  } catch (error) {
587
671
  res.status(400).json({
@@ -659,10 +743,82 @@ const deleteRowInTableByPK = async (req, res) => {
659
743
  }
660
744
  };
661
745
 
746
+ // Bulk Delete rows by id
747
+ const bulkDeleteRowsInTableByPK = async (req, res) => {
748
+ /*
749
+ #swagger.tags = ['Rows']
750
+ #swagger.summary = 'Bulk Delete Rows'
751
+ #swagger.description = 'Bulks Delete rows by primary key'
752
+ #swagger.parameters['name'] = {
753
+ in: 'path',
754
+ description: 'Table name',
755
+ required: true,
756
+ type: 'string'
757
+ }
758
+ #swagger.parameters['_lookup_field'] = {
759
+ in: 'query',
760
+ description: 'If you want to delete row by any other field than primary key, use this parameter',
761
+ required: false,
762
+ type: 'string'
763
+ }
764
+
765
+ #swagger.parameters['body'] = {
766
+ in: 'body',
767
+ required: true,
768
+ type: 'object',
769
+ schema: { $ref: "#/definitions/BulkDeleteRowsRequestBody" }
770
+ }
771
+ */
772
+ const { name: tableName } = req.params;
773
+ const { _lookup_field } = req.query;
774
+ const { pks } = req.body;
775
+
776
+ let lookupField = _lookup_field;
777
+
778
+ if (!_lookup_field) {
779
+ // find the primary key of the table
780
+ try {
781
+ lookupField = db
782
+ .prepare(`PRAGMA table_info(${tableName})`)
783
+ .all()
784
+ .find((field) => field.pk === 1).name;
785
+ } catch (error) {
786
+ return res.status(400).json({
787
+ message: error.message,
788
+ error: error,
789
+ });
790
+ }
791
+ }
792
+
793
+ const query = `DELETE FROM ${tableName} WHERE ${lookupField} in (${pks})`;
794
+
795
+ try {
796
+ const data = db.prepare(query).run();
797
+
798
+ if (data.changes === 0) {
799
+ res.status(404).json({
800
+ error: 'not_found',
801
+ });
802
+ } else {
803
+ res.json({
804
+ message: 'Rows deleted',
805
+ data,
806
+ });
807
+ }
808
+ } catch (error) {
809
+ res.status(400).json({
810
+ message: error.message,
811
+ error: error,
812
+ });
813
+ }
814
+ };
815
+
662
816
  module.exports = {
663
817
  listTableRows,
664
818
  insertRowInTable,
665
819
  getRowInTableByPK,
666
820
  updateRowInTableByPK,
821
+ bulkUpdateRowsInTableByPK,
667
822
  deleteRowInTableByPK,
823
+ bulkDeleteRowsInTableByPK,
668
824
  };
@@ -1,6 +1,7 @@
1
1
  const validator = (schema) => (req, res, next) => {
2
2
  const data = { ...req.body, ...req.params, ...req.query };
3
- const { error } = schema.validate(data);
3
+ const { value, error } = schema.validate(data);
4
+
4
5
  if (error) {
5
6
  res.status(400).json({
6
7
  message: error.message,
@@ -21,11 +21,21 @@ router.get(
21
21
  validator(schema.getRowInTableByPK),
22
22
  controllers.getRowInTableByPK
23
23
  );
24
+ router.put(
25
+ '/:name/rows/bulk',
26
+ validator(schema.bulkUpdateRowsInTableByPK),
27
+ controllers.bulkUpdateRowsInTableByPK
28
+ );
24
29
  router.put(
25
30
  '/:name/rows/:pk',
26
31
  validator(schema.updateRowInTableByPK),
27
32
  controllers.updateRowInTableByPK
28
33
  );
34
+ router.delete(
35
+ '/:name/rows/bulk',
36
+ validator(schema.bulkDeleteRowsInTableByPK),
37
+ controllers.bulkDeleteRowsInTableByPK
38
+ );
29
39
  router.delete(
30
40
  '/:name/rows/:pk',
31
41
  validator(schema.deleteRowInTableByPK),
@@ -31,16 +31,31 @@ const updateRowInTableByPK = Joi.object({
31
31
  _lookup_field: Joi.string().min(3).max(30),
32
32
  });
33
33
 
34
+ const bulkUpdateRowsInTableByPK = Joi.object({
35
+ name: Joi.string().min(3).max(30).required(),
36
+ pks: Joi.array().items(Joi.required()).required(),
37
+ fields: Joi.object().required(),
38
+ _lookup_field: Joi.string().min(3).max(30),
39
+ });
40
+
34
41
  const deleteRowInTableByPK = Joi.object({
35
42
  name: Joi.string().min(3).max(30).required(),
36
43
  pk: Joi.string().required(),
37
44
  _lookup_field: Joi.string().min(3).max(30),
38
45
  });
39
46
 
47
+ const bulkDeleteRowsInTableByPK = Joi.object({
48
+ name: Joi.string().min(3).max(30).required(),
49
+ pks: Joi.array().items(Joi.required()).required(),
50
+ _lookup_field: Joi.string().min(3).max(30),
51
+ });
52
+
40
53
  module.exports = {
41
54
  listTableRows,
42
55
  insertRowInTable,
43
56
  getRowInTableByPK,
44
57
  updateRowInTableByPK,
58
+ bulkUpdateRowsInTableByPK,
45
59
  deleteRowInTableByPK,
60
+ bulkDeleteRowsInTableByPK,
46
61
  };
@@ -110,6 +110,15 @@ const doc = {
110
110
  fields: [{ $ref: '#/definitions/Field' }],
111
111
  },
112
112
 
113
+ BulkUpdateRowsRequestBody: {
114
+ pks: [1, 2, 3],
115
+ fields: [{ $ref: '#/definitions/Field' }],
116
+ },
117
+
118
+ BulkDeleteRowsRequestBody: {
119
+ pks: [1, 2, 3],
120
+ },
121
+
113
122
  TransactionRequestBody: {
114
123
  $ref: '#/definitions/Transaction',
115
124
  },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "swagger": "2.0",
3
3
  "info": {
4
- "version": "0.0.7",
4
+ "version": "0.0.8",
5
5
  "title": "Soul API",
6
6
  "description": "API Documentation for <b>Soul</b>, a simple SQLite RESTful server. "
7
7
  },
@@ -459,6 +459,129 @@
459
459
  }
460
460
  }
461
461
  }
462
+ },
463
+ "/api/tables/{name}/rows/bulk": {
464
+ "put": {
465
+ "tags": [
466
+ "Rows"
467
+ ],
468
+ "summary": "Bulk Update Rows",
469
+ "description": "Bulk Update rows by primary key",
470
+ "parameters": [
471
+ {
472
+ "name": "name",
473
+ "in": "path",
474
+ "required": true,
475
+ "type": "string",
476
+ "description": "Table name"
477
+ },
478
+ {
479
+ "name": "body",
480
+ "in": "body",
481
+ "required": true,
482
+ "schema": {
483
+ "$ref": "#/definitions/BulkUpdateRowsRequestBody"
484
+ }
485
+ },
486
+ {
487
+ "name": "_lookup_field",
488
+ "in": "query",
489
+ "description": "If you want to update row by any other field than primary key, use this parameter",
490
+ "required": false,
491
+ "type": "string"
492
+ },
493
+ {
494
+ "name": "in",
495
+ "in": "query",
496
+ "type": "string"
497
+ },
498
+ {
499
+ "name": "required",
500
+ "in": "query",
501
+ "type": "string"
502
+ },
503
+ {
504
+ "name": "type",
505
+ "in": "query",
506
+ "type": "string"
507
+ },
508
+ {
509
+ "name": "schema",
510
+ "in": "query",
511
+ "type": "string"
512
+ }
513
+ ],
514
+ "responses": {
515
+ "200": {
516
+ "description": "OK"
517
+ },
518
+ "400": {
519
+ "description": "Bad Request"
520
+ }
521
+ }
522
+ },
523
+ "delete": {
524
+ "tags": [
525
+ "Rows"
526
+ ],
527
+ "summary": "Bulk Delete Rows",
528
+ "description": "Bulks Delete rows by primary key",
529
+ "parameters": [
530
+ {
531
+ "name": "name",
532
+ "in": "path",
533
+ "required": true,
534
+ "type": "string",
535
+ "description": "Table name"
536
+ },
537
+ {
538
+ "name": "_lookup_field",
539
+ "in": "query",
540
+ "description": "If you want to delete row by any other field than primary key, use this parameter",
541
+ "required": false,
542
+ "type": "string"
543
+ },
544
+ {
545
+ "name": "body",
546
+ "in": "body",
547
+ "required": true,
548
+ "schema": {
549
+ "$ref": "#/definitions/BulkDeleteRowsRequestBody"
550
+ }
551
+ },
552
+ {
553
+ "name": "in",
554
+ "in": "query",
555
+ "type": "string"
556
+ },
557
+ {
558
+ "name": "required",
559
+ "in": "query",
560
+ "type": "string"
561
+ },
562
+ {
563
+ "name": "type",
564
+ "in": "query",
565
+ "type": "string"
566
+ },
567
+ {
568
+ "name": "schema",
569
+ "in": "query",
570
+ "type": "string"
571
+ }
572
+ ],
573
+ "responses": {
574
+ "200": {
575
+ "description": "OK"
576
+ },
577
+ "400": {
578
+ "description": "Bad Request"
579
+ },
580
+ "404": {
581
+ "description": "Not Found"
582
+ }
583
+ }
584
+ }
462
585
  }
463
586
  },
464
587
  "definitions": {
@@ -702,6 +825,44 @@
702
825
  }
703
826
  }
704
827
  },
828
+ "BulkUpdateRowsRequestBody": {
829
+ "type": "object",
830
+ "properties": {
831
+ "pks": {
832
+ "type": "array",
833
+ "example": [
834
+ 1,
835
+ 2,
836
+ 3
837
+ ],
838
+ "items": {
839
+ "type": "number"
840
+ }
841
+ },
842
+ "fields": {
843
+ "type": "array",
844
+ "items": {
845
+ "$ref": "#/definitions/Field"
846
+ }
847
+ }
848
+ }
849
+ },
850
+ "BulkDeleteRowsRequestBody": {
851
+ "type": "object",
852
+ "properties": {
853
+ "pks": {
854
+ "type": "array",
855
+ "example": [
856
+ 1,
857
+ 2,
858
+ 3
859
+ ],
860
+ "items": {
861
+ "type": "number"
862
+ }
863
+ }
864
+ }
865
+ },
705
866
  "TransactionRequestBody": {
706
867
  "$ref": "#/definitions/Transaction"
707
868
  }