@spytecgps/nova-orm 0.0.21 → 0.0.22

package/README.md

@@ -2,8 +2,47 @@
 
 This package contains repositories and entities to connect to Planet Scale database using typeorm
 
+## How to use?
+
+### Installing
+
+Clone the project locally with `git clone` to the desired folder and run `npm i` to install all the dependencies
+
+### Linting and Formatting
+
+Linting allows to run few code checks
+
+Run `npm run lint`
+_for any strict rule that can be followed, go to `tslint.json` and modify_
+
+Run `npm run format` to update the code formatting
+
+### Building
+
+Building will generate a new folder with the source code and the type definitions
+ready to be consumed as a package
+
+Run `npm run build` to build all the content into the distribution folder ( `dist` in our case, although in can be changed to any other folder )
+
 # SYNC the entities definition with Planet Scale schema:
 
 1- Modify the url value for the data source in the file data-source.ts to use the dev branch connection string
 
-2- Run the command npm run schema-sync
+2- Run the command npm run schema-sync
+
+### Usage
+
+Go to the project you want to use the new package and either remove the package reference in dependencies from `package.json` or just update the version number matching the latest version just published to npm
+
+Delete the @spytecgps/nova-orm folder from the node_modules folder to make sure the package will be using the lastest code
+
+After that run `npm i @spytecgps/nova-orm` if you removed the dependency completely and this will bring the latest package, or run `npm i` if you just updated the version
+
+### Copy Distribution folder to local project ((local testing))
+
+when making changes and would like to avoid commiting and publishing changes.
+
+1. Run `npm run build-prod` to build all the content into the distribution folder
+2. Run `npm run copydistfolder -- {destPath}` to copy distribution folder to local project
+   ex: `npm run copydistfolder -- ../api-reports` copies dist folder to folder -> `api-reports/node_modules/@spytecgps/nova-orm/dist`
+3. In order for VSCode to reload and get udpated nova-orm copied to node_modules dist folder -> On PC you can do Ctrl + Shift + P (mac: Cmd + Shift + P) then type "Reload Window"git

package/dist/entities/client.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { Relation } from 'typeorm';
 import { ClientType } from './clientType';
 import { Device } from './device';
 import { Organization } from './organization';
@@ -6,7 +7,6 @@ import { User } from './user';
 export declare class Client {
     id: number;
     name: string | null;
-    appClientId: string | null;
     createdAt: Date | null;
     modifiedAt: Date | null;
     uuid: Buffer | null;
@@ -17,7 +17,7 @@ export declare class Client {
     sievaUserName: string | null;
     sievaBatchId: number | null;
     clientTypeId: number;
-    clientType: ClientType;
+    clientType: Relation<ClientType>;
     salesforceId: string | null;
     accumaticaId: string | null;
     expirationDate: Date | null;
@@ -25,7 +25,7 @@ export declare class Client {
     btCustomerId: string | null;
     activationCampaign: string | null;
     organizationId: number | null;
-    organization: Organization;
-    users: User[];
-    devices: Device[];
+    organization: Relation<Organization>;
+    users: Relation<User>[];
+    devices: Relation<Device>[];
 }

package/dist/entities/device.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+import { Relation } from 'typeorm';
 import { Client } from './client';
 import { DeviceType } from './deviceType';
 import { ImeiIccidCarrier } from './imeiIccidCarrier';
@@ -7,8 +8,10 @@ export declare class Device {
     identifier: string;
     identifierKey: string;
     deviceTypeId: number;
+    deviceType?: Relation<DeviceType>;
     imei: string;
-    client: Client;
+    clientId: number;
+    client: Relation<Client>;
     createdAt: Date | null;
     brand: string | null;
     model: string | null;
@@ -27,6 +30,5 @@ export declare class Device {
     sievaBatchId: number | null;
     assetCategoryId: number | null;
     usageRegion: string | null;
-    deviceType?: DeviceType;
     iccidCarrier?: ImeiIccidCarrier;
 }

package/dist/entities/user.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="node" />
+import { Relation } from 'typeorm';
 import { Client } from './client';
 import { Country } from './country';
+import { UserAlertConfiguration } from './userAlertConfiguration';
 import { UserConfiguration } from './userConfiguration';
 export declare class User {
     id: Buffer;
@@ -17,16 +19,18 @@ export declare class User {
     createdAt: Date | null;
     modifiedAt: Date | null;
     status: string | null;
-    client: Client;
+    clientId: number;
+    client: Relation<Client>;
     pincode: string | null;
     isAdmin: boolean;
-    country: Country;
+    countryId: number | null;
+    country: Relation<Country>;
     dataSourceTypeId: number | null;
     preferredUserName: string | null;
     lastLoginAt: Date | null;
     emailVerified: boolean;
     lat: number | null;
     lon: number | null;
-    userConfiguration: UserConfiguration;
-    userAlertConfiguration: UserConfiguration[];
+    userConfiguration: Relation<UserConfiguration>;
+    userAlertConfiguration: Relation<UserAlertConfiguration>[];
 }

package/dist/entities/userAlertConfiguration.d.ts

@@ -1,11 +1,15 @@
+/// <reference types="node" />
+import { Relation } from 'typeorm';
 import { AlertType } from './alertType';
 import { User } from './user';
 export declare class UserAlertConfiguration {
     id: number;
-    user: User;
+    userId: Buffer;
+    user: Relation<User>;
     smsNotification: boolean | null;
     emailNotification: boolean | null;
-    alertType: AlertType;
+    alertTypeId: number;
+    alertType: Relation<AlertType>;
     alertValue: string | null;
     appNotification: boolean | null;
     dataSourceTypeId: number | null;

package/dist/entities/userConfiguration.d.ts

@@ -1,7 +1,10 @@
+/// <reference types="node" />
+import { Relation } from 'typeorm';
 import { User } from './user';
 export declare class UserConfiguration {
     id: number;
-    user: User;
+    userId: Buffer;
+    user: Relation<User>;
     isMetric: boolean;
     timezone: string | null;
     createdAt: Date | null;