Merge pull request #81 from richmolj/select

Select

Author: wadetandy

lib-esm/model.d.ts

@@ -2,7 +2,7 @@ import { CollectionProxy, RecordProxy, NullProxy } from "./proxies";
 import { CredentialStorage, StorageBackend } from "./credential-storage";
 import { IDMap } from "./id-map";
 import { Attribute } from "./attribute";
-import { Scope, WhereClause, SortScope, FieldScope, StatsScope, IncludeScope } from "./scope";
+import { Scope, WhereClause, SortScope, FieldArg, StatsScope, IncludeScope } from "./scope";
 import { JsonapiTypeRegistry } from "./jsonapi-type-registry";
 import { ILogger } from "./logger";
 import { MiddlewareStack, BeforeFilter, AfterFilter } from "./middleware-stack";
@@ -146,8 +146,8 @@ export declare class JSORMBase {
     static page<I extends typeof JSORMBase>(this: I, pageNum: number): Scope<I>;
     static per<I extends typeof JSORMBase>(this: I, size: number): Scope<I>;
     static order<I extends typeof JSORMBase>(this: I, clause: SortScope | string): Scope<I>;
-    static select<I extends typeof JSORMBase>(this: I, clause: FieldScope): Scope<I>;
-    static selectExtra<I extends typeof JSORMBase>(this: I, clause: FieldScope): Scope<I>;
+    static select<I extends typeof JSORMBase>(this: I, clause: FieldArg): Scope<I>;
+    static selectExtra<I extends typeof JSORMBase>(this: I, clause: FieldArg): Scope<I>;
     static stats<I extends typeof JSORMBase>(this: I, clause: StatsScope): Scope<I>;
     static includes<I extends typeof JSORMBase>(this: I, clause: IncludeScope): Scope<I>;
     static merge<I extends typeof JSORMBase>(this: I, obj: Record<string, Scope>): Scope<I>;

lib-esm/model.js.map

@@ -13,6 +13,7 @@ export interface JsonapiQueryParams {
 export declare type SortDir = "asc" | "desc";
 export declare type SortScope = Record<string, SortDir>;
 export declare type FieldScope = Record<string, string[]>;
+export declare type FieldArg = FieldScope | string[];
 export declare type WhereClause = Record<string, string | number | boolean>;
 export declare type StatsScope = Record<string, string | string[]>;
 export declare type IncludeScope = string | IncludeArgHash | (string | IncludeArgHash)[];
@@ -37,8 +38,8 @@ export declare class Scope<T extends typeof JSORMBase = typeof JSORMBase> {
     where(clause: WhereClause): Scope<T>;
     stats(clause: StatsScope): Scope<T>;
     order(clause: SortScope | string): Scope<T>;
-    select(clause: FieldScope): Scope<T>;
-    selectExtra(clause: FieldScope): Scope<T>;
+    select(clause: FieldArg): Scope<T>;
+    selectExtra(clause: FieldArg): Scope<T>;
     includes(clause: IncludeScope): Scope<T>;
     scope(): Scope<T>;
     asQueryParams(): JsonapiQueryParams;