sedentary 0.0.10 → 0.0.14

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/lib/db.d.ts CHANGED
@@ -1,50 +1,57 @@
1
- export declare class Record {
1
+ export declare type Natural = Date | Record<string, unknown> | boolean | number | string;
2
+ export declare class Entry {
2
3
  init(): void;
3
4
  save(): Promise<boolean>;
4
5
  }
5
- export declare class Type<N extends unknown, R extends unknown> {
6
+ export declare class Type<N extends Natural, E> {
6
7
  base: unknown;
8
+ entry?: E;
7
9
  native?: N;
8
- record?: R;
9
- size: number;
10
+ size?: number;
10
11
  type: string;
11
- constructor(from: Partial<Type<unknown, unknown>>);
12
- }
13
- interface IMeta {
14
- init: () => void;
15
- methods: {
16
- [key: string]: () => unknown;
12
+ foreignKey?: {
13
+ attributeName: string;
14
+ fieldName: string;
15
+ tableName: string;
17
16
  };
18
- primaryKey: string;
19
- tableName: string;
17
+ constructor(from: Type<N, E>);
20
18
  }
21
- export declare class Meta<N extends unknown, R extends Record> extends Type<N, R> {
19
+ export declare class Meta<N extends Natural, E> extends Type<N, E> {
22
20
  init: () => void;
21
+ isModel?: () => boolean;
23
22
  methods: {
24
23
  [key: string]: () => unknown;
25
24
  };
26
25
  primaryKey: string;
27
26
  tableName: string;
28
- constructor(options: IMeta);
29
- isModel(): boolean;
27
+ constructor(from: Meta<N, E>);
30
28
  }
31
- export declare class Field<N extends unknown, R extends unknown> extends Type<N, R> {
29
+ export declare class Attribute<N extends Natural, E> extends Type<N, E> {
30
+ attributeName: string;
32
31
  defaultValue?: unknown;
33
- fieldName?: string;
34
- notNull?: boolean;
32
+ fieldName: string;
33
+ notNull: boolean;
34
+ tableName: string;
35
35
  unique?: boolean;
36
- constructor(from: Partial<Field<N, R>>);
36
+ constructor(from: Attribute<N, E>);
37
37
  }
38
38
  export interface Constraint {
39
- field: string;
40
- name: string;
39
+ attribute: Attribute<Natural, unknown>;
40
+ constraintName: string;
41
41
  type: "f" | "u";
42
42
  }
43
+ export interface Index {
44
+ fields: string[];
45
+ indexName: string;
46
+ type: "btree" | "hash";
47
+ unique: boolean;
48
+ }
43
49
  interface ITable {
50
+ attributes: Attribute<Natural, unknown>[];
44
51
  constraints: Constraint[];
45
- fields: Field<unknown, unknown>[];
52
+ indexes: Index[];
46
53
  oid?: number;
47
- parent: Meta<unknown, Record>;
54
+ parent: Meta<Natural, unknown>;
48
55
  primaryKey: string;
49
56
  sync: boolean;
50
57
  tableName: string;
@@ -60,17 +67,19 @@ export declare abstract class DB {
60
67
  [key: string]: Table;
61
68
  };
62
69
  tablesArr: Table[];
63
- protected log: (message: string) => void;
70
+ protected log: (...data: unknown[]) => void;
64
71
  abstract connect(): Promise<void>;
65
72
  abstract end(): Promise<void>;
66
73
  constructor(log: (message: string) => void);
67
74
  addTable(table: Table): void;
75
+ protected indexesEq(a: Index, b: Index): boolean;
68
76
  sync(): Promise<void>;
69
- abstract dropConstraints(table: Table): Promise<void>;
77
+ abstract dropConstraints(table: Table): Promise<number[]>;
70
78
  abstract dropFields(table: Table): Promise<void>;
71
- abstract dropIndexes(table: Table): Promise<void>;
79
+ abstract dropIndexes(table: Table, constraintIndexes: number[]): Promise<void>;
72
80
  abstract syncConstraints(table: Table): Promise<void>;
73
81
  abstract syncFields(table: Table): Promise<void>;
82
+ abstract syncIndexes(table: Table): Promise<void>;
74
83
  abstract syncSequence(table: Table): Promise<void>;
75
84
  abstract syncTable(table: Table): Promise<void>;
76
85
  }
package/lib/db.js CHANGED
@@ -1,13 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DB = exports.Table = exports.Field = exports.Meta = exports.Type = exports.Record = void 0;
4
- class Record {
3
+ exports.DB = exports.Table = exports.Attribute = exports.Meta = exports.Type = exports.Entry = void 0;
4
+ class Entry {
5
5
  init() { }
6
6
  async save() {
7
7
  return false;
8
8
  }
9
9
  }
10
- exports.Record = Record;
10
+ exports.Entry = Entry;
11
11
  class Type {
12
12
  constructor(from) {
13
13
  Object.assign(this, from);
@@ -15,21 +15,17 @@ class Type {
15
15
  }
16
16
  exports.Type = Type;
17
17
  class Meta extends Type {
18
- constructor(options) {
19
- super({ size: 0, type: "" });
20
- Object.assign(this, options);
21
- }
22
- isModel() {
23
- return true;
18
+ constructor(from) {
19
+ super(from);
24
20
  }
25
21
  }
26
22
  exports.Meta = Meta;
27
- class Field extends Type {
23
+ class Attribute extends Type {
28
24
  constructor(from) {
29
25
  super(from);
30
26
  }
31
27
  }
32
- exports.Field = Field;
28
+ exports.Attribute = Attribute;
33
29
  function autoImplement() {
34
30
  return class {
35
31
  constructor(defaults) {
@@ -61,16 +57,29 @@ class DB {
61
57
  this.tables[table.tableName] = table;
62
58
  this.tablesArr.push(table);
63
59
  }
60
+ indexesEq(a, b) {
61
+ if (a.fields.length !== b.fields.length)
62
+ return false;
63
+ for (const i in a.fields)
64
+ if (a.fields[i] !== b.fields[i])
65
+ return false;
66
+ if (a.type !== b.type)
67
+ return false;
68
+ if (a.unique !== b.unique)
69
+ return false;
70
+ return true;
71
+ }
64
72
  async sync() {
65
73
  for (const i in this.tablesArr) {
66
74
  const table = this.tablesArr[i];
67
75
  await this.syncTable(table);
68
- await this.dropConstraints(table);
69
- await this.dropIndexes(table);
76
+ const indexes = await this.dropConstraints(table);
77
+ await this.dropIndexes(table, indexes);
70
78
  await this.dropFields(table);
71
79
  await this.syncFields(table);
72
80
  await this.syncSequence(table);
73
81
  await this.syncConstraints(table);
82
+ await this.syncIndexes(table);
74
83
  }
75
84
  }
76
85
  }
package/lib/log.d.ts ADDED
@@ -0,0 +1,4 @@
1
+ export declare function createLogger(log: ((message: string) => void) | null | undefined): {
2
+ (...data: any[]): void;
3
+ (message?: any, ...optionalParams: any[]): void;
4
+ };
package/lib/log.js ADDED
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.createLogger = void 0;
4
+ const console_1 = require("console");
5
+ const stream_1 = require("stream");
6
+ class Logger extends stream_1.Writable {
7
+ constructor(log) {
8
+ super();
9
+ this.log = log;
10
+ }
11
+ _write(chunk, encoding, callback) {
12
+ this.log(chunk.toString());
13
+ callback();
14
+ }
15
+ }
16
+ function createLogger(log) {
17
+ // eslint-disable-next-line no-console
18
+ return log ? new console_1.Console(new Logger(log)).log : log === null ? () => { } : console.log;
19
+ }
20
+ exports.createLogger = createLogger;
package/lib/log.ts ADDED
@@ -0,0 +1,22 @@
1
+ import { Console } from "console";
2
+ import { Writable } from "stream";
3
+
4
+ class Logger extends Writable {
5
+ private log: (message: string) => void;
6
+
7
+ constructor(log: (message: string) => void) {
8
+ super();
9
+
10
+ this.log = log;
11
+ }
12
+
13
+ _write(chunk: Buffer, encoding: string, callback: () => void) {
14
+ this.log(chunk.toString());
15
+ callback();
16
+ }
17
+ }
18
+
19
+ export function createLogger(log: ((message: string) => void) | null | undefined) {
20
+ // eslint-disable-next-line no-console
21
+ return log ? new Console(new Logger(log)).log : log === null ? () => {} : console.log;
22
+ }
package/lib/minidb.d.ts CHANGED
@@ -4,12 +4,13 @@ export declare class MiniDB extends DB {
4
4
  private file;
5
5
  constructor(filename: string, log: (message: string) => void);
6
6
  connect(): Promise<void>;
7
- dropConstraints(table: Table): Promise<void>;
7
+ dropConstraints(table: Table): Promise<number[]>;
8
8
  dropFields(table: Table): Promise<void>;
9
- dropIndexes(table: Table): Promise<void>;
9
+ dropIndexes(table: Table, constraintIndexes: number[]): Promise<void>;
10
10
  end(): Promise<void>;
11
11
  save(): Promise<void>;
12
12
  syncConstraints(table: Table): Promise<void>;
13
+ syncIndexes(table: Table): Promise<void>;
13
14
  syncFields(table: Table): Promise<void>;
14
15
  syncSequence(table: Table): Promise<void>;
15
16
  syncTable(table: Table): Promise<void>;
package/lib/minidb.js CHANGED
@@ -22,62 +22,114 @@ class MiniDB extends db_1.DB {
22
22
  }
23
23
  async dropConstraints(table) {
24
24
  const { constraints } = this.body.tables[table.tableName];
25
- for (const constraint in constraints.u) {
26
- if (!table.constraints.filter(({ field, type }) => field === constraint && type === "u").length) {
27
- this.log(`'${table.tableName}': Removing unique constraint on field: '${constraint}'`);
25
+ for (const constraint of Object.keys(constraints.f).sort()) {
26
+ if (!table.constraints.filter(({ constraintName, type }) => constraintName === constraint && type === "f").length) {
27
+ this.log(`'${table.tableName}': Removing foreign key: '${constraint}'`);
28
+ delete constraints.f[constraint];
29
+ }
30
+ }
31
+ for (const constraint of Object.keys(constraints.u).sort()) {
32
+ if (!table.constraints.filter(({ constraintName, type }) => constraintName === constraint && type === "u").length) {
33
+ this.log(`'${table.tableName}': Removing unique constraint from field: '${constraints.u[constraint].fieldName}'`);
28
34
  delete constraints.u[constraint];
29
35
  }
30
36
  }
31
37
  await this.save();
38
+ return [];
32
39
  }
33
40
  async dropFields(table) {
34
41
  const { fields } = this.body.tables[table.tableName];
35
- for (const field in fields) {
36
- if (table.fields.filter(f => f.fieldName === field).length === 0) {
37
- this.log(`'${table.tableName}': Removing field: '${field}'`);
38
- delete fields[field];
42
+ for (const attribute in fields) {
43
+ if (table.attributes.filter(f => f.fieldName === attribute).length === 0) {
44
+ this.log(`'${table.tableName}': Removing field: '${attribute}'`);
45
+ delete fields[attribute];
46
+ }
47
+ }
48
+ await this.save();
49
+ }
50
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
51
+ async dropIndexes(table, constraintIndexes) {
52
+ const { indexes } = this.body.tables[table.tableName];
53
+ for (const name in indexes) {
54
+ const index = table.indexes.filter(_ => _.indexName === name);
55
+ if (index.length === 0 || !this.indexesEq(indexes[name], index[0])) {
56
+ this.log(`'${table.tableName}': Removing index: '${name}'`);
57
+ delete indexes[name];
39
58
  }
40
59
  }
41
60
  await this.save();
42
61
  }
43
- async dropIndexes(table) { }
44
62
  async end() { }
45
63
  async save() {
46
64
  await writeFile(this.file, JSON.stringify(this.body));
47
65
  }
48
66
  async syncConstraints(table) {
49
67
  const { constraints } = this.body.tables[table.tableName];
50
- for (const i in table.constraints) {
51
- const constraint = table.constraints[i];
52
- if (!constraints[constraint.type][constraint.field]) {
53
- this.log(`'${table.tableName}': Adding unique constraint on field: '${constraint.field}'`);
54
- constraints[constraint.type][constraint.field] = true;
68
+ for (const constraint of table.constraints) {
69
+ const { constraintName, type } = constraint;
70
+ const { fieldName, foreignKey } = constraint.attribute;
71
+ if (!constraints[type][constraintName]) {
72
+ switch (type) {
73
+ case "f":
74
+ this.log(`'${table.tableName}': Adding foreign key '${constraint.constraintName}' on field: '${fieldName}' references '${foreignKey.tableName}(${foreignKey.fieldName})'`);
75
+ constraints[type][constraintName] = { fieldName, toField: foreignKey.fieldName, toTable: foreignKey.tableName };
76
+ break;
77
+ case "u":
78
+ this.log(`'${table.tableName}': Adding unique constraint on field: '${fieldName}'`);
79
+ constraints[type][constraintName] = { fieldName };
80
+ break;
81
+ }
82
+ }
83
+ }
84
+ await this.save();
85
+ }
86
+ async syncIndexes(table) {
87
+ const { indexes } = this.body.tables[table.tableName];
88
+ for (const index of table.indexes) {
89
+ const { indexName } = index;
90
+ if (!(indexName in indexes)) {
91
+ this.log(`'${table.tableName}': Adding index: '${indexName}' on (${index.fields.map(_ => `'${_}'`).join(", ")}) type '${index.type}'${index.unique ? " unique" : ""}`);
92
+ indexes[indexName] = index;
55
93
  }
56
94
  }
57
95
  await this.save();
58
96
  }
59
97
  async syncFields(table) {
60
- for (const i in table.fields) {
61
- const field = table.fields[i];
98
+ for (const attribute of table.attributes) {
62
99
  const { fields } = this.body.tables[table.tableName];
63
- const { size, type } = field;
64
- if (!fields[field.fieldName]) {
65
- this.log(`'${table.tableName}': Adding field: '${field.fieldName}' '${type}' '${size}'`);
66
- fields[field.fieldName] = { size, type };
100
+ const { defaultValue, fieldName, notNull, size, type } = attribute;
101
+ let field = fields[fieldName];
102
+ if (!field) {
103
+ this.log(`'${table.tableName}': Adding field: '${fieldName}' '${type}' '${size || ""}'`);
104
+ field = fields[fieldName] = { size, type };
105
+ }
106
+ if (field.size !== size || field.type !== type) {
107
+ this.log(`'${table.tableName}': Changing field type: '${fieldName}' '${type}' '${size || ""}'`);
108
+ field = fields[fieldName] = Object.assign(Object.assign({}, field), { size, type });
67
109
  }
68
- if (fields[field.fieldName].size !== size || fields[field.fieldName].type !== type) {
69
- this.log(`'${table.tableName}': Changing field type: '${field.fieldName}' '${type}' '${size}'`);
70
- fields[field.fieldName] = { size, type };
110
+ if (field.default) {
111
+ if (!defaultValue) {
112
+ this.log(`'${table.tableName}': Dropping default value for field: '${fieldName}'`);
113
+ delete field.default;
114
+ }
115
+ else if (field.default !== defaultValue) {
116
+ this.log(`'${table.tableName}': Changing default value to '${defaultValue}' for field: '${fieldName}'`);
117
+ field.default = defaultValue;
118
+ }
71
119
  }
72
- if (fields[field.fieldName].default) {
73
- if (!field.defaultValue)
74
- this.log(`'${table.tableName}': Dropping default value for field: '${field.fieldName}'`);
75
- else if (fields[field.fieldName].default !== field.defaultValue)
76
- this.log(`'${table.tableName}': Changing default value to '${field.defaultValue}' for field: '${field.fieldName}'`);
120
+ else if (defaultValue) {
121
+ this.log(`'${table.tableName}': Setting default value '${defaultValue instanceof Date ? defaultValue.toISOString() : defaultValue}' for field: '${fieldName}'`);
122
+ field.default = defaultValue;
123
+ }
124
+ if (field.notNull) {
125
+ if (!notNull) {
126
+ this.log(`'${table.tableName}': Dropping not null for field: '${fieldName}'`);
127
+ delete field.notNull;
128
+ }
77
129
  }
78
- else if (field.defaultValue) {
79
- this.log(`'${table.tableName}': Setting default value '${field.defaultValue}' for field: '${field.fieldName}'`);
80
- fields[field.fieldName].default = field.defaultValue;
130
+ else if (notNull) {
131
+ this.log(`'${table.tableName}': Setting not null for field: '${fieldName}'`);
132
+ field.notNull = true;
81
133
  }
82
134
  }
83
135
  await this.save();
@@ -99,7 +151,7 @@ class MiniDB extends db_1.DB {
99
151
  }
100
152
  if (!this.body.tables[table.tableName]) {
101
153
  this.log(`Adding table: '${table.tableName}'`);
102
- this.body.tables[table.tableName] = { constraints: { f: {}, u: {} }, fields: {} };
154
+ this.body.tables[table.tableName] = { constraints: { f: {}, u: {} }, fields: {}, indexes: {} };
103
155
  if (table.parent) {
104
156
  this.log(`Setting parent: '${table.parent.tableName}' - to table: '${table.tableName}'`);
105
157
  this.body.tables[table.tableName].parent = table.parent.tableName;
package/package.json CHANGED
@@ -4,21 +4,21 @@
4
4
  "dependencies": {},
5
5
  "description": "The ORM which never needs to migrate",
6
6
  "devDependencies": {
7
- "@types/mocha": "8.2.0",
8
- "@types/node": "14.14.16",
7
+ "@types/mocha": "9.0.0",
8
+ "@types/node": "16.11.7",
9
9
  "@types/yamljs": "0.2.31",
10
- "@typescript-eslint/eslint-plugin": "4.11.1",
11
- "@typescript-eslint/parser": "4.11.1",
12
- "eslint": "7.16.0",
13
- "mocha": "8.2.1",
10
+ "@typescript-eslint/eslint-plugin": "5.3.1",
11
+ "@typescript-eslint/parser": "5.3.1",
12
+ "eslint": "8.2.0",
13
+ "mocha": "9.1.3",
14
14
  "nyc": "15.1.0",
15
- "prettier": "2.2.1",
16
- "ts-node": "9.1.1",
17
- "typescript": "4.1.3",
15
+ "prettier": "2.4.1",
16
+ "ts-node": "10.4.0",
17
+ "typescript": "4.4.4",
18
18
  "yamljs": "0.3.0"
19
19
  },
20
20
  "engines": {
21
- "node": ">=10.0"
21
+ "node": ">=12.0"
22
22
  },
23
23
  "homepage": "https://github.com/iccicci/sedentary#readme",
24
24
  "keywords": [
@@ -53,5 +53,5 @@
53
53
  "version": "node -r ts-node/register utils.ts version"
54
54
  },
55
55
  "types": "index.d.ts",
56
- "version": "0.0.10"
57
- }
56
+ "version": "0.0.14"
57
+ }
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2017 Daniele Ricci
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,32 @@
1
+ # sedentary-pg
2
+
3
+ [![Build Status][travis-badge]][travis-url]
4
+ [![Code Climate][code-badge]][code-url]
5
+ [![Test Coverage][cover-badge]][code-url]
6
+
7
+ [![NPM version][npm-badge]][npm-url]
8
+ [![NPM downloads][npm-downloads-badge]][npm-url]
9
+ [![Stars][stars-badge]][github-url]
10
+
11
+ [![Types][types-badge]][npm-url]
12
+ [![Dependents][deps-badge]][npm-url]
13
+ [![Donate][donate-badge]][donate-url]
14
+
15
+ [code-badge]: https://codeclimate.com/github/iccicci/sedentary-pg/badges/gpa.svg
16
+ [code-url]: https://codeclimate.com/github/iccicci/sedentary-pg
17
+ [cover-badge]: https://codeclimate.com/github/iccicci/sedentary-pg/badges/coverage.svg
18
+ [deps-badge]: https://badgen.net/npm/dependents/sedentary-pg?icon=npm&cache=300
19
+ [donate-badge]: https://badgen.net/badge/donate/bitcoin?icon=bitcoin&cache=300
20
+ [donate-url]: https://blockchain.info/address/1Md9WFAHrXTb3yPBwQWmUfv2RmzrtbHioB
21
+ [github-url]: https://github.com/iccicci/sedentary-pg
22
+ [npm-downloads-badge]: https://badgen.net/npm/dw/sedentary-pg?icon=npm&cache=300
23
+ [npm-badge]: https://badgen.net/npm/v/sedentary-pg?color=green&icon=npm&cache=300
24
+ [npm-url]: https://www.npmjs.com/package/sedentary-pg
25
+ [stars-badge]: https://badgen.net/github/stars/iccicci/sedentary-pg?icon=github&cache=300
26
+ [travis-badge]: https://badgen.net/travis/iccicci/sedentary-pg?icon=travis&cache=300
27
+ [travis-url]: https://app.travis-ci.com/github/iccicci/sedentary-pg
28
+ [types-badge]: https://badgen.net/npm/types/sedentary-pg?color=green&icon=typescript&cache=300
29
+
30
+ # under development
31
+
32
+ https://bucardo.org/postgres_all_versions.html