feat: add TS types #1904

achrinza · 2021-09-22T15:30:25Z

This is a mostly reverse-engineering effort to document the contracts in Juggler on a best-effort basis.

Signed-off-by: Rifa Achrinza [email protected]

Checklist

Sign off your commits with DCO (Developer Certificate of Origin)
npm test passes on your machine
New tests added or existing tests modified to cover all changes
Code conforms with the style guide
Commit messages are following our guidelines

Signed-off-by: Rifa Achrinza <[email protected]>

coveralls · 2021-09-24T09:20:14Z

Pull Request Test Coverage Report for Build 1269225996

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.007%) to 84.747%

Totals
Change from base Build 1261591086:	-0.007%
Covered Lines:	7159
Relevant Lines:	8149

💛 - Coveralls

coveralls · 2021-09-24T09:20:15Z

Pull Request Test Coverage Report for Build 1269236745

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

For more information on this, see Tracking coverage changes with pull request builds.
To avoid this issue with future PRs, see these Recommended CI Configurations.
For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 86.464%

Totals
Change from base Build 1261591086:	0.0%
Covered Lines:	7008
Relevant Lines:	7701

💛 - Coveralls

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza · 2021-09-24T15:19:56Z

types/connector.d.ts

+  /**
+   * @internal
+   */
+  _models?: Record<string, ModelBaseClass>;


Not sure if this is correct.

Most probably ModelDefinition.

types/connector.d.ts

achrinza · 2021-09-24T15:21:37Z

types/datasource.d.ts

@@ -76,28 +86,194 @@ import {IsolationLevel, Transaction} from './transaction-mixin';
 */
 export declare class DataSource extends EventEmitter {
  name: string;
-  settings: Options;
+  settings: ConnectorSettings;


Based on the codebase, the DataSource simply passes the whole settings to the connector; Hence why the type called ConnectorSettings.

On second thought, we may want to create a dedicated passthrough type to avoid potential future issues due to the shared type.

achrinza · 2021-09-24T15:23:24Z

types/datasource.d.ts

+  // Reason for deprecation is not clear.
+  /**
+   * {@inheritDoc Connector.getTypes}
+   * @deprecated
+   */
+  getTypes(): string[];
+
+  /**
+   * Check if the datasource supports the specified types.
+   * @param types Type name(s) to check against
+   */
+  supportTypes(types: string | string[]): boolean;


Based on the original codebase comments, getTypes() is deprecated but not supportTypes(); Not sure of the reason for this. The original purpose of these functions are also not clear.

achrinza · 2021-09-24T15:24:20Z

types/datasource.d.ts

+   * @param propertyName Target property name
+   * @returns Column metadata
+   */
+  columnMetadata(modelName: string, propertyName: string): ColumnMetadata;


This seems to be the only function that uses ColumnMetadata. However, ColumnMetadata typedef is non-specific. Need to find examples of the return value.

achrinza · 2021-09-24T15:26:20Z

types/datasource.d.ts

+   * @param modelName Target model name
+   * @returns The ID property definition
+   */
+  idProperty(modelName: string): PropertyDefinition;


There's also a IdDefinition in model.d.ts. Not sure if this function is supposed to return that instead.

types/model.d.ts

achrinza · 2021-09-24T15:29:04Z

types/connector.d.ts

+  freezeDataSource?(): void;
+  freezeSchema?(): void;


Not sure the difference between these functions. DataSource.prototype.freeze calls both functions if they are defined.

freezeDatasource seems to have been introduced by this commit:

9b169ef#diff-7de38f47065ef67b4936fbd6396bb71a580fe9a5a9ff2c9723c4fe859d1e2a6eR977-R979

freezeSchema was from JugglingDB.

Based on the commit just before the one mentioned above, they should be identical, and the use of both is for backwards-compatibility with JugglingDB:

6af4b1b

achrinza · 2021-09-24T15:34:50Z

types/connector.d.ts

+// #TODO(achrinza): The codebase suggets that `context` differs
+// depending on the situation, and that there's no cohesive interface.
+// Hence, we'll need to identify all the possible contexts.
+export type Context = {
+  Model: ModelBaseClass,
+  instance?: object,
+  query?: Filter,
+  where?: Where,
+  data?: AnyObject,
+  hookState?: AnyObject,
+  options?: Options,
+  isNewInstance?: boolean,
+  currentInstance?: Readonly<ModelBase>,
+}


These are defined here:

https://loopback.io/doc/en/lb3/Operation-hooks.html

https://loopback.io/doc/en/lb3/Remote-hooks.html#context-object

https://loopback.io/doc/en/lb3/Connector-hooks.html#context

Currently, this is only based on all the possible attributes for an Operation Hooks context.

Will probably need to add separate context typedefs for the other 2.

While the Operation Hooks context differs depending on the event being observed and the function called, I'm not sure if its better to create distinctive op. hook contexts for these different hooks.

Signed-off-by: Rifa Achrinza <[email protected]>

types/connector.d.ts

achrinza · 2021-11-20T03:50:20Z

types/datasource.d.ts

+
+  defineOperation(name: string, options: OperationOptions, fn: Function): void;
+
+  enableRemote(operation: string): void;


Should deprecate as an LB3-only feature.

achrinza · 2021-11-20T03:50:34Z

types/datasource.d.ts

+
+  enableRemote(operation: string): void;
+
+  disableRemote(operation: string): void;


Should deprecate as an LB3-only feature.

types/datasource.d.ts

achrinza · 2021-11-20T03:52:12Z

types/datasource.d.ts

+   * {@link Connector.discoverModelProperties} is used instead. Otherwise, an
+   * error is thrown.


#TODO: What error is thrown?

achrinza · 2021-11-20T04:02:40Z

types/datasource.d.ts

+  /**
+   * A hash-map of the different relation types.
+   */


Let's include an example since it's not expected to change.

types/datasource.d.ts

achrinza · 2021-11-20T04:03:48Z

types/datasource.d.ts

  initialized?: boolean;
  connected?: boolean;
  connecting?: boolean;


Add tsdoc explaining the circumstances for the possible values.

achrinza · 2021-11-20T04:04:47Z

types/connector.d.ts

 /**
 * Base connector class
+ * 
+ * @internal
 */
 export declare class ConnectorBase implements Connector {


May need to extract this to loopback-connector package along with transaction-related typedefs.

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza · 2021-12-03T13:30:03Z

types/test-suite.d.ts

+/**
+ * Opt-out unless stated otherwise
+ */
+export interface ConnectorCapabilities {


Separate between DAO and KVAO connector capabilities.

types/model.d.ts

achrinza · 2021-12-03T14:58:54Z

types/model.d.ts

+  excludeBaseProperties?: string[];
+
+  /**
+   * Indicates if the {@link ModelBaseClass | Model} is attached to the DataS


Fix this tsdoc

achrinza · 2021-12-03T14:58:58Z

types/model.d.ts

+   * Alias of {@link ModelSettings.base}. Takes lower precedence.
+   */
+  super?: ModelBaseClass;
+  excludeBaseProperties?: string[];


achrinza · 2021-12-03T14:59:17Z

types/model.d.ts

+   * Model properties to be set as hidden.
+   * 
+   * @remarks
+   * Hidden properties are


Fix incomplete tsdoc

types/model.d.ts

achrinza · 2021-12-03T15:01:35Z

types/model.d.ts

+  plural?: string;
+
+  http?: {
+    path?: string;
+  }


Deprecate; Add tsdoc explaining their purpose, defaults, and relationship between each other (e.g. plural is used for http.path when the latter is not set)

achrinza · 2021-12-03T15:01:50Z

types/model.d.ts

+      // Postgresql-specific
+      type: string;
+      kind: string;


Also, add tsdoc

types/model.d.ts

achrinza · 2021-12-03T15:05:40Z

types/model-utils.d.ts

+    maxDepthOfQuery?: number;
+    maxDepthOfData?: number;
+    prohibitHiddenPropertiesInQuery?: boolean;


Explain these options with tsdoc.

achrinza · 2022-04-02T21:53:37Z

types/connector.d.ts

+// #TODO(achrinza): The codebase suggets that `context` differs
+// depending on the situation, and that there's no cohesive interface.
+// Hence, we'll need to identify all the possible contexts.
+export interface Context {
+  Model: ModelBaseClass;
+  instance?: object;
+  query?: Filter;
+  where?: Where;
+  data?: AnyObject;
+  hookState: object;
+  options: Options;
+  isNewInstance?: boolean;
+  currentInstance?: Readonly<ModelBase>;
+}


#TODO(achrinza): The codebase suggets that context differs
depending on the situation, and that there's no cohesive interface.
Hence, we'll need to identify all the possible contexts.

achrinza · 2022-04-02T21:55:01Z

types/datasource.d.ts

+export type OperationOptions = {
+  accepts: string[],
+  returns: string[],
+  http: object,
+  remoteEnabled: boolean,
+  scope: unknown,
+  fnName: string,
+}


~~This looks like it's for "HTTP remoting"; We should mark as deprecated.~~

EDIT 1: Not deprecated

EDIT 2: May be deprecated even though used internally - Need to re-review.

types/datasource.d.ts

achrinza · 2022-04-02T22:01:56Z

types/datasource.d.ts

  buildModelFromInstance(
    modelName: string,
    jsonObject: AnyObject,
    options?: Options,
  ): ModelBaseClass;


Add documentation on what (Connector?) methods this calls behind the scenes.

achrinza · 2022-04-02T22:07:09Z

types/datasource.d.ts

@@ -76,28 +86,194 @@ import {IsolationLevel, Transaction} from './transaction-mixin';
 */
 export declare class DataSource extends EventEmitter {
  name: string;
-  settings: Options;
+  settings: ConnectorSettings;


On second thought, we may want to create a dedicated passthrough type to avoid potential future issues due to the shared type.

types/datasource.d.ts

types/connector.d.ts

achrinza · 2022-04-02T22:55:20Z

types/connector.d.ts

+   * @deprecated Use {@link ConnectorSettings.connector} instead.
+   */
+  adapter?: ConnectorStatic | string;
+  database: string;


Add tsdoc explaining that this is used by the Connectors directly.

types/connector.d.ts

achrinza · 2022-04-02T23:27:11Z

types/model.d.ts

@@ -219,7 +405,11 @@ export declare class ModelBase {
   * If true, then protected properties should not be brought out.
   * @returns {object} returns Plain JSON object


Convert to tsdoc

achrinza · 2022-04-02T23:36:10Z

types/model.d.ts

+       * Comma-separated column names
+       * 
+       * @remarks
+       * Handled by {@link Connector}s directly by default.


What does "by default" mean? What is the circumstance where this is not the case, and what is the impact?

achrinza · 2022-04-02T23:36:21Z

types/model.d.ts

+       * Array of column names to create an index.
+       * 
+       * @remarks
+       * Handled by {@link Connector}s directly by default.


Ditto. What does "by default" mean? What is the circumstance where this is not the case, and what is the impact?

achrinza · 2022-04-02T23:40:30Z

types/connector.d.ts

+  /**
+   * @internal
+   */
+  _models?: Record<string, ModelBaseClass>;


Most probably ModelDefinition.

achrinza · 2022-04-02T23:41:44Z

types/datasource.d.ts

+  models: Record<string, typeof ModelBase>;
+
+  definitions: {[modelName: string]: ModelDefinition};


Will need to check and document these' relationship with Connector._models

These are populated from the same-named properties of the ModelBuilder instance passed during class initialisation.

types/connector.d.ts

types/model-utils.d.ts

types/connector.d.ts

types/model.d.ts

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza · 2022-05-09T13:33:30Z

JugglingDB documentation: https://1602.github.io/jugglingdb/#DOCUMENTATION

achrinza · 2022-04-07T12:56:29Z

types/model.d.ts

+   * @remarks
+   * Alias of {@link ModelSettings.base}. Takes lower precedence.
+   */
+  super?: ModelBaseClass;


todo: Document that this convention is from node:util.inherits.

achrinza · 2022-05-02T08:57:27Z

types/connector.d.ts

+   * @param options Discovery options
+   * @param cb Callback function
+   */
+  discoverSchemas?(tableName: string, options: SchemaDiscoveryOptions, cb: Callback<Schema>): Promise<Schema>;


clarification: Are the 2nd and 3rd parameters supposed to be optional? Check the return type as well.

Suggested change

discoverSchemas?(tableName: string, options: SchemaDiscoveryOptions, cb: Callback<Schema>): Promise<Schema>;

discoverSchemas?(tableName: string, options?: SchemaDiscoveryOptions, cb?: Callback<Schema>): Promise<Schema>;

achrinza · 2022-05-02T08:59:06Z

types/datasource.d.ts

+  constructor(name: string, settings?: ConnectorSettings, modelBuilder?: ModelBuilder);
+
+  constructor(settings?: ConnectorSettings, modelBuilder?: ModelBuilder);

  constructor(
    connectorModule: Connector,
-    settings?: Options,
+    settings?: Omit<ConnectorSettings, 'adapter' | 'connector'>,
    modelBuilder?: ModelBuilder,
  );


issue: This should be more lenient. the first parameter should be connectorAndDataSourceName, with the 2nd parameter's connector/adapter and name taking precedence if they exist.

achrinza · 2022-05-20T14:20:19Z

types/model.d.ts

+  /**
+   * Sets if JavaScript {@link undefined} as an attribute value should be
+   * persisted as database `NULL`.
+   */
+  persistUndefinedAsNull?: boolean;


What's the default value?

achrinza · 2022-05-20T14:21:09Z

types/model.d.ts

+   * - {@link DataAccessObject.removeById}/{@link DataAccessObject.destroyById}/{@link DataAccessObject.deleteById}
+   * - {@link DataAccessObject.remove}/{@link DataAccessObject.delete}/{@link DataAccessObject.destroy}
+   */
+  strictDelete?: boolean;


What's the default value? IIRC, it's true as LoopBack 4's DefaultCrudRepository explicitly sets this to false:

https://github.com/loopbackio/loopback-next/blob/1e48456fde20e691d85b506f5c8e296c3c64b1fe/packages/repository/src/repositories/legacy-juggler-bridge.ts#L217

achrinza · 2022-05-20T14:23:53Z

types/model.d.ts

@@ -7,21 +7,37 @@ import {EventEmitter} from 'events';
 import {AnyObject, Options} from './common';
 import {DataSource} from './datasource';
 import {Listener, OperationHookContext} from './observer-mixin';
+import {ModelUtilsOptions} from './model-utils';



interface Schema has an options object property?

https://github.com/loopbackio/loopback-next/blob/1a51f322cc618a553dda346c1fe4e3905e794746/packages/cli/lib/model-discoverer.js#L34

achrinza · 2022-05-21T05:11:28Z

types/model.d.ts

+    patch: boolean;
+  }; // Only referenced in "legacy built-in merge policy"
+  options?: {
+    path: boolean;


This looks like a typo

Suggested change

path: boolean;

patch: boolean;

achrinza · 2022-05-21T05:12:11Z

types/model.d.ts

+  /**
+   * {@inheritDoc ModelSettings.tableName}
+   */
+  tableName?: string
+
+  /**
+   * Mapped table name for the model.
+   */
+  table?: string;


Which one takes precedence?

achrinza · 2022-05-21T05:27:57Z

types/datasource.d.ts

+  accepts: string[],
+  returns: string[],
+  http: object,
+  remoteEnabled: boolean,
+  scope: unknown,
+  fnName: string,


~~Refine TS typedef according to https://github.com/loopbackio/loopback-connector-openapi/blob/88cbea3ebcfe0fd7634e3fb49245bf8c15aa6a7a/README.md#extend-a-model-to-wrapmediate-api-operations~~

The striken out paragraph above is wrong - The linked resource is for loopback.remoteMethod, which is not related to DataSource.defineOperation.

Refine scope according to

loopback-datasource-juggler/lib/datasource.js

Line 187 in be09d57

scope: this.DataAccessObject.prototype,

.

Suggested change

accepts: string[],

returns: string[],

http: object,

remoteEnabled: boolean,

scope: unknown,

fnName: string,

accepts: string[],

returns: string[],

http: object,

remoteEnabled: boolean,

scope: DataAccessObject,

fnName: string,

Note that we'll need to write DataAccessObject itself, which is only used to be mixin-ed into DataSource and BaseModel.

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza · 2022-05-29T13:29:52Z

types/model.d.ts

+  indexes?: {
+    [indexJugglerName: string]: IndexDefinition
+  };


This is incorrect. Index definitions are done under the index object prop. of the PropertyDefinition.

Suggested change

indexes?: {

[indexJugglerName: string]: IndexDefinition

};

indexes?: string[];

achrinza · 2022-05-29T13:31:08Z

types/model.d.ts

@@ -66,6 +82,31 @@ export interface ModelProperties {
  [name: string]: PropertyDefinition
 }

+export interface IndexDefinition {


As stated above, there is no separate "IndexDefinition". Instead, this is integrated under the "PropertyDefinition"

achrinza · 2022-06-27T05:59:46Z

types/model.d.ts

  | string
  | Function
  | {[property: string]: PropertyType};

+export type DefaultFns = 'guid' | 'uuid' | 'uuidv4' | 'now' | 'shortid' | 'nanoid' | string;


Let's document which versions of Juggler onwards were these introduced.

achrinza · 2022-06-27T06:43:17Z

types/model.d.ts

 /**
 * Base class for LoopBack 3.x models
 */
 export declare class ModelBase {
  static dataSource?: DataSource;
  static modelName: string;
  static definition: ModelDefinition;
+  static hideInternalProperties?: boolean;
  static readonly base: typeof ModelBase;



Add missing protected attributes:

protected __cachedRelations: Record<string, unknown>; protected __strict: boolean; protected __persisted: boolean; protected __unknownProperties: string[];

achrinza · 2022-06-27T06:49:47Z

types/model.d.ts

 /**
 * Property definition
 */
 export interface PropertyDefinition extends AnyObject {
  type?: PropertyType;
  id?: boolean | number;
+  defaultFn?: DefaultFns;


Add missing property

Suggested change

defaultFn?: DefaultFns;

/**

* @remarks

* | '$now' | Sets default to `new Date()`. Only applicable when {@link PropertyDefinition.type.name} equals `Date`.

**/

default?: Function | Date | '$now';

defaultFn?: DefaultFns;

see:

loopback-datasource-juggler/lib/model.js

Lines 281 to 300 in f8d7ca9

if (applyDefaultValues && propVal === undefined && appliesDefaultsOnWrites(properties[p])) {

let def = properties[p]['default'];

if (def !== undefined) {

if (typeof def === 'function') {

if (def === Date) {

// FIXME: We should coerce the value in general

// This is a work around to {default: Date}

// Date() will return a string instead of Date

def = new Date();

} else {

def = def();

}

} else if (type.name === 'Date' && def === '$now') {

def = new Date();

}

// FIXME: We should coerce the value

// will implement it after we refactor the PropertyDefinition

self.__data[p] = propVal = def;

}

}

achrinza · 2022-06-27T07:01:23Z

types/model.d.ts

+  applySetters?: boolean;
+  applyDefaultValues?: boolean;
+  strict?: boolean;
+  persisted?: boolean;


Suggested change

applySetters?: boolean;

applyDefaultValues?: boolean;

strict?: boolean;

persisted?: boolean;

/**

* @defaultValue `true`

**/

applySetters?: boolean;

/**

* Configures if {@Link ModelBase.definition.settings.default} and {@Link ModelBase.definition.settings.defaultFn} should be used to populate yet-to-be-set model properties.

* @defaultValue `true`

**/

applyDefaultValues?: boolean;

/**

* @defaultValue {@Link ModelBase.definition.settings.strict}

**/

strict?: boolean;

persisted?: boolean;

achrinza added 2 commits September 22, 2021 23:29

feat: add connector TS types

8fb2b6f

Signed-off-by: Rifa Achrinza <[email protected]>

feat: add types for connector and datasource

6281ebe

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza added 11 commits September 24, 2021 17:20

fix: update ConnectorSettings.connector

b500cd7

Signed-off-by: Rifa Achrinza <[email protected]>

refactor: NameMapper

6c66be8

Signed-off-by: Rifa Achrinza <[email protected]>

feat: add missing non-function class members

2cbf624

Signed-off-by: Rifa Achrinza <[email protected]>

feat: add operations typedefs

6479173

Signed-off-by: Rifa Achrinza <[email protected]>

feat: add missing types

b460b94

Signed-off-by: Rifa Achrinza <[email protected]>

update operation hook context typedef

68521cb

Signed-off-by: Rifa Achrinza <[email protected]>

feat: update datasource typedefs

27496ae

Signed-off-by: Rifa Achrinza <[email protected]>

feat(PropertyDefinition): add missing props

ecb1a7b

Signed-off-by: Rifa Achrinza <[email protected]>

feat(DataSource): refine columnMetadata return type

54aa233

Signed-off-by: Rifa Achrinza <[email protected]>

feat(Connector): refine _models typedef

f75a599

Signed-off-by: Rifa Achrinza <[email protected]>

feat: refined defs

17ff165

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza commented Sep 24, 2021

View reviewed changes

achrinza changed the title ~~feat: add connector TS types~~ feat: add TS types Sep 24, 2021

achrinza added 6 commits September 26, 2021 17:13

feat: misc. updates

7234599

Signed-off-by: Rifa Achrinza <[email protected]>

feat: update model settings, prop defs

fe45124

Signed-off-by: Rifa Achrinza <[email protected]>

feat: add initial jutil typedefs

181578d

Signed-off-by: Rifa Achrinza <[email protected]>

feat(DataSource): add prototype.mixin

2e7b0cf

Signed-off-by: Rifa Achrinza <[email protected]>

feat: initial kvao typedefs

aedf47a

Signed-off-by: Rifa Achrinza <[email protected]>

feat: misc. updates

8b56310

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza commented Nov 20, 2021

View reviewed changes

feat: misc updates

055efd3

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza commented Dec 3, 2021

View reviewed changes

achrinza commented Apr 2, 2022

View reviewed changes

achrinza commented Apr 5, 2022

View reviewed changes

types/model-utils.d.ts Show resolved Hide resolved

types/connector.d.ts Show resolved Hide resolved

achrinza mentioned this pull request Apr 5, 2022

feat(cli): add option to create relations in cli discover command loopbackio/loopback-next#8461

Merged

8 tasks

achrinza commented Apr 5, 2022

View reviewed changes

types/model.d.ts Outdated Show resolved Hide resolved

achrinza added 2 commits April 9, 2022 22:36

feat: misc updates

884776b

Signed-off-by: Rifa Achrinza <[email protected]>

feat: apply misc review suggestions

db34269

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza mentioned this pull request Apr 12, 2022

[EPIC] Composite primary/foreign keys loopbackio/loopback-next#1830

Open

achrinza commented May 20, 2022

View reviewed changes

achrinza commented May 21, 2022

View reviewed changes

feat: misc. changes

e1bb7a1

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza mentioned this pull request Aug 7, 2022

Retire deprecated Bluebird dependency loopbackio/loopback-connector#229

Open

achrinza added 3 commits August 22, 2022 15:42

feat: misc changes

de9ce11

Signed-off-by: Rifa Achrinza <[email protected]>

feat: misc typedef updates

5a52edb

Signed-off-by: Rifa Achrinza <[email protected]>

chore: more misc changes

7d59e16

Signed-off-by: Rifa Achrinza <[email protected]>

achrinza commented Feb 27, 2024

View reviewed changes


		defineOperation(name: string, options: OperationOptions, fn: Function): void;

		enableRemote(operation: string): void;


		enableRemote(operation: string): void;

		disableRemote(operation: string): void;

		* {@link Connector.discoverModelProperties} is used instead. Otherwise, an
		* error is thrown.

		@@ -219,7 +405,11 @@ export declare class ModelBase {
		* If true, then protected properties should not be brought out.
		* @returns {object} returns Plain JSON object

		models: Record<string, typeof ModelBase>;

		definitions: {[modelName: string]: ModelDefinition};

	discoverSchemas?(tableName: string, options: SchemaDiscoveryOptions, cb: Callback<Schema>): Promise<Schema>;
	discoverSchemas?(tableName: string, options?: SchemaDiscoveryOptions, cb?: Callback<Schema>): Promise<Schema>;

	if (applyDefaultValues && propVal === undefined && appliesDefaultsOnWrites(properties[p])) {
	let def = properties[p]['default'];
	if (def !== undefined) {
	if (typeof def === 'function') {
	if (def === Date) {
	// FIXME: We should coerce the value in general
	// This is a work around to {default: Date}
	// Date() will return a string instead of Date
	def = new Date();
	} else {
	def = def();
	}
	} else if (type.name === 'Date' && def === '$now') {
	def = new Date();
	}
	// FIXME: We should coerce the value
	// will implement it after we refactor the PropertyDefinition
	self.__data[p] = propVal = def;
	}
	}

feat: add TS types #1904

Are you sure you want to change the base?

feat: add TS types #1904

Conversation

achrinza commented Sep 22, 2021 • edited Loading

Checklist

coveralls commented Sep 24, 2021

Pull Request Test Coverage Report for Build 1269225996

💛 - Coveralls

coveralls commented Sep 24, 2021 • edited Loading

Pull Request Test Coverage Report for Build 1269236745

Warning: This coverage report may be inaccurate.

Details

💛 - Coveralls

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

achrinza Sep 24, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

achrinza Apr 2, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

achrinza commented May 9, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

achrinza May 20, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

achrinza May 21, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

achrinza commented Sep 22, 2021 •

edited

Loading

coveralls commented Sep 24, 2021 •

edited

Loading

achrinza Sep 24, 2021 •

edited

Loading

achrinza Apr 2, 2022 •

edited

Loading

achrinza May 20, 2022 •

edited

Loading

achrinza May 21, 2022 •

edited

Loading