pure-orm 4.0.0-0 → 4.0.0-3

package/dist/test-utils/twelve/models/prompt.d.ts

@@ -0,0 +1,22 @@
+import { Member } from './member';
+import { IModel, ICollection, IColumns } from '../../../src/index';
+export declare const tableName: string;
+export declare const columns: IColumns;
+export declare class Prompt implements IModel {
+    id: number;
+    forMemberId: number;
+    forMember?: Member;
+    fromMemberId: number;
+    fromMember?: Member;
+    constructor(props: any);
+}
+export declare class Prompts implements ICollection<Prompt> {
+    models: Array<Prompt>;
+    constructor({ models }: any);
+}
+export declare const promptEntity: {
+    tableName: string;
+    columns: IColumns;
+    Model: typeof Prompt;
+    Collection: typeof Prompts;
+};

package/dist/test-utils/twelve/models/prompt.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptEntity = exports.Prompts = exports.Prompt = exports.columns = exports.tableName = void 0;
+const member_1 = require("./member");
+exports.tableName = 'prompt';
+exports.columns = [
+    'id',
+    { column: 'for_member_id', references: member_1.Member },
+    { column: 'from_member_id', references: member_1.Member }
+];
+class Prompt {
+    constructor(props) {
+        this.id = props.id;
+        this.forMemberId = props.forMemberId;
+        this.forMember = props.forMember;
+        this.fromMemberId = props.fromMemberId;
+        this.fromMember = props.fromMember;
+    }
+}
+exports.Prompt = Prompt;
+class Prompts {
+    constructor({ models }) {
+        this.models = models;
+    }
+}
+exports.Prompts = Prompts;
+exports.promptEntity = {
+    tableName: exports.tableName,
+    columns: exports.columns,
+    Model: Prompt,
+    Collection: Prompts
+};

package/dist/test-utils/twelve/models/prompt.ts

@@ -0,0 +1,40 @@
+import { Member } from './member';
+import { IModel, ICollection, IColumns } from '../../../src/index';
+
+export const tableName: string = 'prompt';
+
+export const columns: IColumns = [
+  'id',
+  { column: 'for_member_id', references: Member },
+  { column: 'from_member_id', references: Member }
+];
+
+export class Prompt implements IModel {
+  id: number;
+  forMemberId: number;
+  forMember?: Member;
+  fromMemberId: number;
+  fromMember?: Member;
+
+  constructor(props: any) {
+    this.id = props.id;
+    this.forMemberId = props.forMemberId;
+    this.forMember = props.forMember;
+    this.fromMemberId = props.fromMemberId;
+    this.fromMember = props.fromMember;
+  }
+}
+
+export class Prompts implements ICollection<Prompt> {
+  models: Array<Prompt>;
+  constructor({ models }: any) {
+    this.models = models;
+  }
+}
+
+export const promptEntity = {
+  tableName,
+  columns,
+  Model: Prompt,
+  Collection: Prompts
+};

package/dist/test-utils/twelve/orm.d.ts

@@ -0,0 +1,47 @@
+declare const orm: {
+    nestClump: (clump: import("../../src/factory").IModel[][]) => object;
+    clumpIntoGroups: (processed: import("../../src/factory").IModel[][]) => import("../../src/factory").IModel[][][];
+    mapToBos: (objectified: any) => any[];
+    objectifyDatabaseResult: (result: object) => any;
+    createFromDatabase: <T extends import("../../src/factory").ICollection<import("../../src/factory").IModel>>(_result: object | object[]) => T | undefined;
+    createOneFromDatabase: <T_1 extends import("../../src/factory").IModel>(_result: any) => T_1;
+    createOneOrNoneFromDatabase: <T_2 extends import("../../src/factory").IModel>(_result: any) => void | T_2;
+    createManyFromDatabase: <T_3 extends import("../../src/factory").ICollection<import("../../src/factory").IModel>>(_result: any) => T_3;
+    getSqlInsertParts: (model: import("../../src/factory").IModel) => {
+        columns: string;
+        values: any[];
+        valuesVar: string[];
+    };
+    getSqlUpdateParts: (model: import("../../src/factory").IModel, on?: string) => {
+        clause: string;
+        idVar: string;
+        values: any[];
+    };
+    getMatchingParts: (model: import("../../src/factory").IModel) => {
+        whereClause: string;
+        values: any[];
+    };
+    getMatchingPartsObject: (model: import("../../src/factory").IModel) => {
+        whereClause: string;
+        values: any;
+    };
+    getNewWith: (model: import("../../src/factory").IModel, sqlColumns: any, values: any) => any;
+    getValueBySqlColumn: (model: import("../../src/factory").IModel, sqlColumn: string) => any;
+    one: <T_4 extends import("../../src/factory").IModel>(query: string, values?: object | undefined, errorHandler?: (err: Error) => never) => T_4;
+    oneOrNone: <T_5 extends import("../../src/factory").IModel>(query: string, values?: object | undefined, errorHandler?: (err: Error) => never) => void | T_5;
+    many: <T_6 extends import("../../src/factory").ICollection<import("../../src/factory").IModel>>(query: string, values?: object | undefined, errorHandler?: (err: Error) => never) => T_6;
+    any: <T_7 extends import("../../src/factory").ICollection<import("../../src/factory").IModel>>(query: string, values?: object | undefined, errorHandler?: (err: Error) => never) => void | T_7;
+    none: (query: string, values?: object | undefined, errorHandler?: (err: Error) => never) => void;
+    create: <T_8 extends import("../../src/factory").IModel>(model: T_8) => T_8;
+    update: <T_9 extends import("../../src/factory").IModel>(model: T_9, { on }?: {
+        on?: string | undefined;
+    }) => T_9;
+    delete: <T_10 extends import("../../src/factory").IModel>(model: T_10) => void;
+    deleteMatching: <T_11 extends import("../../src/factory").IModel>(model: T_11) => void;
+    getMatching: <T_12 extends import("../../src/factory").IModel>(model: T_12) => T_12;
+    getOneOrNoneMatching: <T_13 extends import("../../src/factory").IModel>(model: T_13) => void | T_13;
+    getAnyMatching: <T_14 extends import("../../src/factory").ICollection<import("../../src/factory").IModel>>(model: import("../../src/factory").IModel) => void | T_14;
+    getAllMatching: <T_15 extends import("../../src/factory").ICollection<import("../../src/factory").IModel>>(model: import("../../src/factory").IModel) => T_15;
+    tables: any;
+};
+export default orm;

package/dist/test-utils/twelve/orm.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../../src/index");
+const prompt_1 = require("./models/prompt");
+const member_1 = require("./models/member");
+const orm = (0, index_1.create)({
+    entities: [prompt_1.promptEntity, member_1.memberEntity],
+    db: void 0
+});
+exports.default = orm;

package/dist/test-utils/twelve/orm.ts

@@ -0,0 +1,8 @@
+import { create } from '../../src/index';
+import { promptEntity } from './models/prompt';
+import { memberEntity } from './models/member';
+const orm = create({
+  entities: [promptEntity, memberEntity],
+  db: void 0
+});
+export default orm;

package/dist/test-utils/twelve/results.json

@@ -0,0 +1,8 @@
+[
+  {
+    "prompt#id": 13,
+    "prompt#for_member_id": 336,
+    "prompt#from_member_id": 1,
+    "member#id": 1
+  }
+]

package/dist/test-utils/two/results.js

@@ -0,0 +1,322 @@
+module.exports = [
+  {
+    'article#id': 14,
+    'article#author_id': 8,
+    'article#created_date': new Date('2019-01-11T13:42:39.819Z'),
+    'article#read_time_minutes': 1,
+    'article#seo_description': 'some seo words',
+    'article#primary_image': 'https://example.com/8afdf36d95.jpg',
+    'article#title': 'Some blog',
+    'article#slug': 'some-blog',
+    'article#body': '<p>Oh yeah</p>',
+    'article#amp_body': '<p>Oh yeah</p>',
+    'article#kind': 'Article',
+    'article#points': 2,
+    'person#id': 8,
+    'person#first_name': 'Brad',
+    'person#last_name': 'Martin',
+    'person#slug': 'brad-martin',
+    'person#email': 'brad@brad.com',
+    'person#picture': 'https://example.com/brad.jpg',
+    'person#cover_photo': 'https://example.com/some.jpg',
+    'person#brand': null,
+    'person#tagline': 'Dreamer of big things',
+    'person#display_name': null,
+    'person#biography': 'Born to party',
+    'person#title': 'Chief Marketing Officer',
+    'article_tag#id': 36,
+    'article_tag#article_id': 14,
+    'article_tag#tag_id': 3,
+    'tag#id': 3,
+    'tag#name': 'Do-It-Yourself',
+    'tag#slug': 'do-it-yourself'
+  },
+  {
+    'article#id': 14,
+    'article#author_id': 8,
+    'article#created_date': new Date('2019-01-11T13:42:39.819Z'),
+    'article#read_time_minutes': 1,
+    'article#seo_description': 'some seo words',
+    'article#primary_image': 'https://example.com/8afdf36d95.jpg',
+    'article#title': 'Some blog',
+    'article#slug': 'some-blog',
+    'article#body': '<p>Oh yeah</p>',
+    'article#amp_body': '<p>Oh yeah</p>',
+    'article#kind': 'Article',
+    'article#points': 2,
+    'person#id': 8,
+    'person#first_name': 'Brad',
+    'person#last_name': 'Martin',
+    'person#slug': 'brad-martin',
+    'person#email': 'brad@brad.com',
+    'person#picture': 'https://example.com/brad.jpg',
+    'person#cover_photo': 'https://example.com/some.jpg',
+    'person#brand': null,
+    'person#tagline': 'Dreamer of big things',
+    'person#display_name': null,
+    'person#biography': 'Born to party',
+    'person#title': 'Chief Marketing Officer',
+    'article_tag#id': 37,
+    'article_tag#article_id': 14,
+    'article_tag#tag_id': 4,
+    'tag#id': 4,
+    'tag#name': 'Family Fun',
+    'tag#slug': 'family-fun'
+  },
+  {
+    'article#id': 14,
+    'article#author_id': 8,
+    'article#created_date': new Date('2019-01-11T13:42:39.819Z'),
+    'article#read_time_minutes': 1,
+    'article#seo_description': 'some seo words',
+    'article#primary_image': 'https://example.com/8afdf36d95.jpg',
+    'article#title': 'Some blog',
+    'article#slug': 'some-blog',
+    'article#body': '<p>Oh yeah</p>',
+    'article#amp_body': '<p>Oh yeah</p>',
+    'article#kind': 'Article',
+    'article#points': 2,
+    'person#id': 8,
+    'person#first_name': 'Brad',
+    'person#last_name': 'Martin',
+    'person#slug': 'brad-martin',
+    'person#email': 'brad@brad.com',
+    'person#picture': 'https://example.com/brad.jpg',
+    'person#cover_photo': 'https://example.com/some.jpg',
+    'person#brand': null,
+    'person#tagline': 'Dreamer of big things',
+    'person#display_name': null,
+    'person#biography': 'Born to party',
+    'person#title': 'Chief Marketing Officer',
+    'article_tag#id': 38,
+    'article_tag#article_id': 14,
+    'article_tag#tag_id': 5,
+    'tag#id': 5,
+    'tag#name': 'Decorating',
+    'tag#slug': 'decorating'
+  },
+  {
+    'article#id': 14,
+    'article#author_id': 8,
+    'article#created_date': new Date('2019-01-11T13:42:39.819Z'),
+    'article#read_time_minutes': 1,
+    'article#seo_description': 'some seo words',
+    'article#primary_image': 'https://example.com/8afdf36d95.jpg',
+    'article#title': 'Some blog',
+    'article#slug': 'some-blog',
+    'article#body': '<p>Oh yeah</p>',
+    'article#amp_body': '<p>Oh yeah</p>',
+    'article#kind': 'Article',
+    'article#points': 2,
+    'person#id': 8,
+    'person#first_name': 'Brad',
+    'person#last_name': 'Martin',
+    'person#slug': 'brad-martin',
+    'person#email': 'brad@brad.com',
+    'person#picture': 'https://example.com/brad.jpg',
+    'person#cover_photo': 'https://example.com/some.jpg',
+    'person#brand': null,
+    'person#tagline': 'Dreamer of big things',
+    'person#display_name': null,
+    'person#biography': 'Born to party',
+    'person#title': 'Chief Marketing Officer',
+    'article_tag#id': 39,
+    'article_tag#article_id': 14,
+    'article_tag#tag_id': 6,
+    'tag#id': 6,
+    'tag#name': 'Hosting',
+    'tag#slug': 'hosting'
+  },
+  {
+    'article#id': 14,
+    'article#author_id': 8,
+    'article#created_date': new Date('2019-01-11T13:42:39.819Z'),
+    'article#read_time_minutes': 1,
+    'article#seo_description': 'some seo words',
+    'article#primary_image': 'https://example.com/8afdf36d95.jpg',
+    'article#title': 'Some blog',
+    'article#slug': 'some-blog',
+    'article#body': '<p>Oh yeah</p>',
+    'article#amp_body': '<p>Oh yeah</p>',
+    'article#kind': 'Article',
+    'article#points': 2,
+    'person#id': 8,
+    'person#first_name': 'Brad',
+    'person#last_name': 'Martin',
+    'person#slug': 'brad-martin',
+    'person#email': 'brad@brad.com',
+    'person#picture': 'https://example.com/brad.jpg',
+    'person#cover_photo': 'https://example.com/some.jpg',
+    'person#brand': null,
+    'person#tagline': 'Dreamer of big things',
+    'person#display_name': null,
+    'person#biography': 'Born to party',
+    'person#title': 'Chief Marketing Officer',
+    'article_tag#id': 40,
+    'article_tag#article_id': 14,
+    'article_tag#tag_id': 7,
+    'tag#id': 7,
+    'tag#name': 'Recipes',
+    'tag#slug': 'recipes'
+  },
+  {
+    'article#id': 14,
+    'article#author_id': 8,
+    'article#created_date': new Date('2019-01-11T13:42:39.819Z'),
+    'article#read_time_minutes': 1,
+    'article#seo_description': 'some seo words',
+    'article#primary_image': 'https://example.com/8afdf36d95.jpg',
+    'article#title': 'Some blog',
+    'article#slug': 'some-blog',
+    'article#body': '<p>Oh yeah</p>',
+    'article#amp_body': '<p>Oh yeah</p>',
+    'article#kind': 'Article',
+    'article#points': 2,
+    'person#id': 8,
+    'person#first_name': 'Brad',
+    'person#last_name': 'Martin',
+    'person#slug': 'brad-martin',
+    'person#email': 'brad@brad.com',
+    'person#picture': 'https://example.com/brad.jpg',
+    'person#cover_photo': 'https://example.com/some.jpg',
+    'person#brand': null,
+    'person#tagline': 'Dreamer of big things',
+    'person#display_name': null,
+    'person#biography': 'Born to party',
+    'person#title': 'Chief Marketing Officer',
+    'article_tag#id': 41,
+    'article_tag#article_id': 14,
+    'article_tag#tag_id': 8,
+    'tag#id': 8,
+    'tag#name': 'Product Reviews',
+    'tag#slug': 'product-reviews'
+  },
+  {
+    'article#id': 14,
+    'article#author_id': 8,
+    'article#created_date': new Date('2019-01-11T13:42:39.819Z'),
+    'article#read_time_minutes': 1,
+    'article#seo_description': 'some seo words',
+    'article#primary_image': 'https://example.com/8afdf36d95.jpg',
+    'article#title': 'Some blog',
+    'article#slug': 'some-blog',
+    'article#body': '<p>Oh yeah</p>',
+    'article#amp_body': '<p>Oh yeah</p>',
+    'article#kind': 'Article',
+    'article#points': 2,
+    'person#id': 8,
+    'person#first_name': 'Brad',
+    'person#last_name': 'Martin',
+    'person#slug': 'brad-martin',
+    'person#email': 'brad@brad.com',
+    'person#picture': 'https://example.com/brad.jpg',
+    'person#cover_photo': 'https://example.com/some.jpg',
+    'person#brand': null,
+    'person#tagline': 'Dreamer of big things',
+    'person#display_name': null,
+    'person#biography': 'Born to party',
+    'person#title': 'Chief Marketing Officer',
+    'article_tag#id': 42,
+    'article_tag#article_id': 14,
+    'article_tag#tag_id': 9,
+    'tag#id': 9,
+    'tag#name': 'Mythbusters',
+    'tag#slug': 'mythbusters'
+  },
+  {
+    'article#id': 14,
+    'article#author_id': 8,
+    'article#created_date': new Date('2019-01-11T13:42:39.819Z'),
+    'article#read_time_minutes': 1,
+    'article#seo_description': 'some seo words',
+    'article#primary_image': 'https://example.com/8afdf36d95.jpg',
+    'article#title': 'Some blog',
+    'article#slug': 'some-blog',
+    'article#body': '<p>Oh yeah</p>',
+    'article#amp_body': '<p>Oh yeah</p>',
+    'article#kind': 'Article',
+    'article#points': 2,
+    'person#id': 8,
+    'person#first_name': 'Brad',
+    'person#last_name': 'Martin',
+    'person#slug': 'brad-martin',
+    'person#email': 'brad@brad.com',
+    'person#picture': 'https://example.com/brad.jpg',
+    'person#cover_photo': 'https://example.com/some.jpg',
+    'person#brand': null,
+    'person#tagline': 'Dreamer of big things',
+    'person#display_name': null,
+    'person#biography': 'Born to party',
+    'person#title': 'Chief Marketing Officer',
+    'article_tag#id': 43,
+    'article_tag#article_id': 14,
+    'article_tag#tag_id': 11,
+    'tag#id': 11,
+    'tag#name': 'Yard Care',
+    'tag#slug': 'yard-care'
+  },
+  {
+    'article#id': 14,
+    'article#author_id': 8,
+    'article#created_date': new Date('2019-01-11T13:42:39.819Z'),
+    'article#read_time_minutes': 1,
+    'article#seo_description': 'some seo words',
+    'article#primary_image': 'https://example.com/8afdf36d95.jpg',
+    'article#title': 'Some blog',
+    'article#slug': 'some-blog',
+    'article#body': '<p>Oh yeah</p>',
+    'article#amp_body': '<p>Oh yeah</p>',
+    'article#kind': 'Article',
+    'article#points': 2,
+    'person#id': 8,
+    'person#first_name': 'Brad',
+    'person#last_name': 'Martin',
+    'person#slug': 'brad-martin',
+    'person#email': 'brad@brad.com',
+    'person#picture': 'https://example.com/brad.jpg',
+    'person#cover_photo': 'https://example.com/some.jpg',
+    'person#brand': null,
+    'person#tagline': 'Dreamer of big things',
+    'person#display_name': null,
+    'person#biography': 'Born to party',
+    'person#title': 'Chief Marketing Officer',
+    'article_tag#id': 44,
+    'article_tag#article_id': 14,
+    'article_tag#tag_id': 12,
+    'tag#id': 12,
+    'tag#name': 'Lifestyle',
+    'tag#slug': 'lifestyle'
+  },
+  {
+    'article#id': 14,
+    'article#author_id': 8,
+    'article#created_date': new Date('2019-01-11T13:42:39.819Z'),
+    'article#read_time_minutes': 1,
+    'article#seo_description': 'some seo words',
+    'article#primary_image': 'https://example.com/8afdf36d95.jpg',
+    'article#title': 'Some blog',
+    'article#slug': 'some-blog',
+    'article#body': '<p>Oh yeah</p>',
+    'article#amp_body': '<p>Oh yeah</p>',
+    'article#kind': 'Article',
+    'article#points': 2,
+    'person#id': 8,
+    'person#first_name': 'Brad',
+    'person#last_name': 'Martin',
+    'person#slug': 'brad-martin',
+    'person#email': 'brad@brad.com',
+    'person#picture': 'https://example.com/brad.jpg',
+    'person#cover_photo': 'https://example.com/some.jpg',
+    'person#brand': null,
+    'person#tagline': 'Dreamer of big things',
+    'person#display_name': null,
+    'person#biography': 'Born to party',
+    'person#title': 'Chief Marketing Officer',
+    'article_tag#id': 45,
+    'article_tag#article_id': 14,
+    'article_tag#tag_id': 16,
+    'tag#id': 16,
+    'tag#name': 'Bar',
+    'tag#slug': 'bar'
+  }
+];

package/example/README.md

@@ -0,0 +1,3 @@
+# Basic Example
+
+This is the basic example from the example in the main repo readme.

package/example/app.ts

@@ -0,0 +1,12 @@
+import express, { Express, Request, Response } from 'express';
+import { getPerson } from './data-access/person';
+
+const app: Express = express();
+const port = process.env.PORT;
+
+app.get('/rest/person', (req: Request, res: Response) => {
+  const person = getPerson(+req.params.id);
+  res.json(person);
+});
+
+app.listen(port);

package/example/data-access/person.ts

@@ -0,0 +1,16 @@
+import orm from '../factories/orm';
+import { Person } from '../models/person';
+
+export const getPerson = (id: number): Person => {
+  const query = `
+    SELECT
+      ${orm.tables.person.columns},
+      ${orm.tables.job.columns},
+      ${orm.tables.employer.columns}
+    FROM person
+    LEFT JOIN job on person.id = job.person_id
+    LEFT JOIN employer on job.employer_id = employer.id
+    WHERE id = $(id)
+  `;
+  return orm.one<Person>(query, { id });
+};

package/example/factories/db.ts

@@ -0,0 +1,11 @@
+import pgPromise from 'pg-promise';
+
+const pgp = pgPromise();
+const connectionObject = {
+  host: process.env.DB_HOSTNAME,
+  port: process.env.DB_PORT ? +process.env.DB_PORT : void 0,
+  database: process.env.DB_NAME,
+  user: process.env.DB_USERNAME,
+  password: process.env.DB_PASSWORD
+};
+export const db = pgp(connectionObject);

package/example/factories/orm.ts

@@ -0,0 +1,10 @@
+import { create } from '../../src/index';
+import { db } from './db';
+import { personEntity } from '../models/person';
+import { jobEntity } from '../models/job';
+import { employerEntity } from '../models/employer';
+const orm = create({
+  entities: [personEntity, jobEntity, employerEntity],
+  db
+});
+export default orm;

package/example/models/employer.ts

@@ -0,0 +1,36 @@
+import { IModel, ICollection, IColumns } from '../../src/index';
+
+export const tableName: string = 'employer';
+
+export const columns: IColumns = ['id', 'name'];
+
+interface IEmployerProps {
+  id: number;
+  name: string;
+}
+
+export class Employer implements IModel {
+  id: number;
+  name: string;
+  constructor(props: IEmployerProps) {
+    this.id = props.id;
+    this.name = props.name;
+  }
+  // any business methods...
+}
+
+export class Employers implements ICollection<Employer> {
+  models: Array<Employer>;
+  constructor({ models }: any) {
+    this.models = models;
+    return this;
+  }
+  // any business methods...
+}
+
+export const employerEntity = {
+  tableName,
+  columns,
+  Model: Employer,
+  Collection: Employers
+};

package/example/models/job.ts

@@ -0,0 +1,59 @@
+import { IModel, ICollection, IColumns } from '../../src/index';
+import { Person } from './person';
+import { Employer } from './employer';
+
+export const tableName: string = 'job';
+
+export const columns: IColumns = [
+  'id',
+  { column: 'person_id', references: Person },
+  { column: 'employer_id', references: Employer },
+  'start_date',
+  'end_date'
+];
+
+interface IJobProps {
+  id: number;
+  personId: number;
+  person?: Person;
+  employerId: number;
+  employer?: Employer;
+  startDate: Date;
+  endDate: Date;
+}
+
+export class Job implements IModel {
+  id: number;
+  personId: number;
+  person?: Person;
+  employerId: number;
+  employer?: Employer;
+  startDate: Date;
+  endDate: Date;
+  constructor(props: IJobProps) {
+    this.id = props.id;
+    this.personId = props.personId;
+    this.person = props.person;
+    this.employerId = props.employerId;
+    this.employer = props.employer;
+    this.startDate = props.startDate;
+    this.endDate = props.endDate;
+  }
+  // any business methods...
+}
+
+export class Jobs implements ICollection<Job> {
+  models: Array<Job>;
+  constructor({ models }: any) {
+    this.models = models;
+    return this;
+  }
+  // any business methods...
+}
+
+export const jobEntity = {
+  tableName,
+  columns,
+  Model: Job,
+  Collection: Jobs
+};