sfobjects-basic-client 1.1.5 → 1.1.7

package/dist/index.d.ts

@@ -166,10 +166,10 @@ export interface SfSelectActions<OI, N extends KeyOf<OI>, S extends SfRootSelect
     limit: (limit: number) => SfSelectActions<OI, N, S>;
 }
 export interface SfOrderByAction<OI, N extends KeyOf<OI>, S extends SfRootSelect<OI, N>> {
-    orderBy: (orderBy: SfRootOrderBy<OI, N>) => SfSelectActions<OI, N, S>;
+    orderBy: <R extends SfRootOrderBy<OI, N>>(orderBy: R) => SfSelectActions<OI, N, S>;
 }
 export interface SfWhereActions<OI, N extends KeyOf<OI>, S extends SfRootSelect<OI, N>> {
-    where: (where: SfRootWhere<OI, N>) => (SfSelectActions<OI, N, S> & SfOrderByAction<OI, N, S>);
+    where: <W extends SfRootWhere<OI, N>>(where: W) => (SfSelectActions<OI, N, S> & SfOrderByAction<OI, N, S>);
 }
 export interface SfSelectAditionalActions<OI, N extends KeyOf<OI>, S extends SfRootSelect<OI, N>> {
     find: (id: string, options?: SfQueryOptions) => Promise<SfRootSelectProjection<OI, N, S> | undefined>;
@@ -177,9 +177,9 @@ export interface SfSelectAditionalActions<OI, N extends KeyOf<OI>, S extends SfR
     selection: S[];
 }
 export interface SfObjActions<OI, N extends KeyOf<OI>> {
-    query: <S extends SfRootSelect<OI, N>>(q: {
+    query: <S extends SfRootSelect<OI, N>, W extends SfRootWhere<OI, N>>(q: {
         select: S[];
-        where?: SfRootWhere<OI, N>;
+        where?: string | W;
         orderBy?: SfRootOrderBy<OI, N>;
         limit?: number;
     }) => SfSelectActions<OI, N, S>;
@@ -189,14 +189,20 @@ export interface SfObjActions<OI, N extends KeyOf<OI>> {
     upsert: <K extends MandatoryCreateProps<OI[N]>>(records: SfUpsert<OI[N], K>[], key: K, options?: SfDmlOptions) => PromiseLike<SfSaveResult[]>;
     select: <S extends SfRootSelect<OI, N>>(select: S[]) => (SfSelectActions<OI, N, S> & SfWhereActions<OI, N, S> & SfSelectAditionalActions<OI, N, S>);
 }
-export declare class SfBasicClientError extends Error {
+export declare class SfBasicClientSaveError extends Error {
     errors: SfSaveError[];
     constructor(errors: SfSaveError[]);
 }
+export declare class SfBasicClientReadError extends Error {
+    error: string;
+    constructor(error: string);
+}
 export declare function isPlainObject(value: unknown): value is Record<string, any>;
 export declare function constructSoql<OI>(_cfg: SfObjCfgIndex<OI>): (objName: string, from: string, select: (string | {})[], where?: string | Record<string, any>, orderBy?: Record<string, any>, limit?: number) => string;
 export declare function getSfObject<OI>(_cfg: SfObjCfgIndex<OI>, o?: SfClientOptions): <N extends KeyOf<OI>>(from: N, _conn: ISfConnection) => SfObjActions<OI, N>;
-export declare const getSfObjects: <OI>(cfg: SfObjCfgIndex<OI>) => (conn: ISfConnection, options?: SfClientOptions) => { [N in KeyOf<OI>]: SfObjActions<OI, N>; };
+export declare const getSfObjects: <OI>(cfg: SfObjCfgIndex<OI>) => (conn: ISfConnection, options?: SfClientOptions) => { [N in KeyOf<OI>]: SfObjActions<OI, N>; } & {
+    __getObject: <N_1 extends KeyOf<OI>>(from: N_1) => SfObjActions<OI, N_1>;
+};
 export declare const sfObject: <OI, N extends KeyOf<OI>>(cfg: SfObjCfgIndex<OI>, n: N) => {
     info: SfObjCfgIndex<OI>[N];
     select: <S extends SfRootSelect<OI, N>>(s: S[]) => S[];

package/dist/index.js

@@ -21,7 +21,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sfObject = exports.getSfObjects = exports.SfBasicClientError = void 0;
+exports.sfObject = exports.getSfObjects = exports.SfBasicClientReadError = exports.SfBasicClientSaveError = void 0;
 exports.isPlainObject = isPlainObject;
 exports.constructSoql = constructSoql;
 exports.getSfObject = getSfObject;
@@ -70,15 +70,24 @@ const OP_RULES = [
     { ops: OP_KEYS_LIKE, soqlOp: 'like' },
     { ops: OP_KEYS_NLIKE, soqlOp: 'like', isNot: true },
 ];
-class SfBasicClientError extends Error {
+class SfBasicClientSaveError extends Error {
     constructor(errors) {
         super('Salesforce error(s): ' + errors.map(e => { var _a; return `[${e.errorCode}] ${e.message}, field(s): ${(_a = e.fields) === null || _a === void 0 ? void 0 : _a.join(',')}`; }).join(';\r\n'));
         this.errors = errors;
-        this.name = 'SfBasicClientError';
+        this.name = 'SfBasicClientSaveError';
         Object.setPrototypeOf(this, new.target.prototype);
     }
 }
-exports.SfBasicClientError = SfBasicClientError;
+exports.SfBasicClientSaveError = SfBasicClientSaveError;
+class SfBasicClientReadError extends Error {
+    constructor(error) {
+        super('Salesforce error: ' + error);
+        this.error = error;
+        this.name = 'SfBasicClientReadError';
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+exports.SfBasicClientReadError = SfBasicClientReadError;
 // functions
 function isPlainObject(value) {
     if (typeof value !== 'object' || value === null)
@@ -235,7 +244,7 @@ function processSaveResult(sr, breakOnError) {
     if (breakOnError) {
         const _errors = sr.filter(r => (r.success !== true)).map(r => r.errors).flat();
         if (_errors.length) {
-            throw new SfBasicClientError(_errors);
+            throw new SfBasicClientSaveError(_errors);
         }
     }
     return sr;
@@ -270,7 +279,7 @@ function getSfObject(_cfg, o) {
                 }), retrieve: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = o === null || o === void 0 ? void 0 : o.query) {
                     const result = yield _queryOne(_conn, from, select, id, options);
                     if (!result.records.length) {
-                        throw new Error(`Record with id '${id}' is not found in '${from}'.`);
+                        throw new SfBasicClientReadError(`Record with id '${id}' is not found in '${from}'.`);
                     }
                     return result.records[0];
                 }), selection: select }))
@@ -278,8 +287,8 @@ function getSfObject(_cfg, o) {
     };
 }
 const getSfObjects = (cfg) => (conn, options) => {
-    const _func = getSfObject(cfg, options);
-    return Object.keys(cfg).reduce((p, n) => (Object.assign(Object.assign({}, p), { [n]: _func(n, conn) })), {});
+    const __getObject = (from) => getSfObject(cfg, options)(from, conn);
+    return Object.assign(Object.assign({}, Object.keys(cfg).reduce((p, n) => (Object.assign(Object.assign({}, p), { [n]: __getObject(n) })), {})), { __getObject });
 };
 exports.getSfObjects = getSfObjects;
 const sfObject = (cfg, n) => ({ info: cfg[n], select: (s) => s });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sfobjects-basic-client",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "description": "Basic Salesforce Client to use together with sfobjects-to-typescript lib",
   "license": "ISC",
   "author": "Murad Aliyev",  

package/src/index.ts

@@ -265,11 +265,11 @@ export interface SfSelectActions<OI, N extends KeyOf<OI>, S extends SfRootSelect
 }
 
 export interface SfOrderByAction<OI, N extends KeyOf<OI>, S extends SfRootSelect<OI, N>> {
-    orderBy: (orderBy: SfRootOrderBy<OI, N>) => SfSelectActions<OI, N, S>;
+    orderBy: <R extends SfRootOrderBy<OI, N>>(orderBy: R) => SfSelectActions<OI, N, S>;
 }
 
 export interface SfWhereActions<OI, N extends KeyOf<OI>, S extends SfRootSelect<OI, N>> {
-    where: (where: SfRootWhere<OI, N>) => (SfSelectActions<OI, N, S> & SfOrderByAction<OI, N, S>);
+    where: <W extends SfRootWhere<OI, N>>(where: W) => (SfSelectActions<OI, N, S> & SfOrderByAction<OI, N, S>);
 }
 
 export interface SfSelectAditionalActions<OI, N extends KeyOf<OI>, S extends SfRootSelect<OI, N>> {
@@ -280,7 +280,7 @@ export interface SfSelectAditionalActions<OI, N extends KeyOf<OI>, S extends SfR
 }
 
 export interface SfObjActions<OI, N extends KeyOf<OI>> {
-    query: <S extends SfRootSelect<OI, N>>(q: { select: S[], where?: SfRootWhere<OI, N>, orderBy?: SfRootOrderBy<OI, N>, limit?: number }) => SfSelectActions<OI, N, S>;
+    query: <S extends SfRootSelect<OI, N>, W extends SfRootWhere<OI, N>>(q: { select: S[], where?: string | W, orderBy?: SfRootOrderBy<OI, N>, limit?: number }) => SfSelectActions<OI, N, S>;
     delete: (ids: string[], options?: SfDmlOptions) => PromiseLike<SfSaveResult[]>;
     update: (records: SfUpdate<OI[N]>[], options?: SfDmlOptions) => PromiseLike<SfSaveResult[]>;
     create: (records: SfCreate<OI[N]>[], options?: SfDmlOptions) => PromiseLike<SfSaveResult[]>;
@@ -557,12 +557,12 @@ function processSaveResult(sr: SfSaveResult[], breakOnError?: boolean): SfSaveRe
 export function getSfObject<OI>(_cfg: SfObjCfgIndex<OI>, o?: SfClientOptions) {
 
 
-    function _query<S extends SfRootSelect<OI, N>, N extends KeyOf<OI>>(
+    function _query<S extends SfRootSelect<OI, N>, W extends SfRootWhere<OI, N>, R extends SfRootOrderBy<OI, N>, N extends KeyOf<OI>>(
         conn: ISfConnection,
         from: N,
         select: S[],
-        where?: string | SfRootWhere<OI, N>,
-        orderBy?: SfRootOrderBy<OI, N>,
+        where?: string | W,
+        orderBy?: R,
         limit?: number
     ): SfSelectActions<OI, N, S> {
 
@@ -589,7 +589,7 @@ export function getSfObject<OI>(_cfg: SfObjCfgIndex<OI>, o?: SfClientOptions) {
 
         return ({
 
-            query: <S extends SfRootSelect<OI, N>>(q: { select: S[], where?: SfRootWhere<OI, N>, orderBy?: SfRootOrderBy<OI, N>, limit?: number }) => {
+            query: <S extends SfRootSelect<OI, N>, W extends SfRootWhere<OI, N>, R extends SfRootOrderBy<OI, N>>(q: { select: S[], where?: string | W, orderBy?: R, limit?: number }) => {
                 const { select, where, orderBy, limit } = q;
                 return _query(_conn, from, select, where, orderBy, limit);
             },
@@ -606,13 +606,13 @@ export function getSfObject<OI>(_cfg: SfObjCfgIndex<OI>, o?: SfClientOptions) {
 
                 ..._query(_conn, from, select),
 
-                orderBy: (orderBy: SfRootOrderBy<OI, N>) => _query(_conn, from, select, undefined, orderBy),
+                orderBy: <R extends SfRootOrderBy<OI, N>>(orderBy: R) => _query(_conn, from, select, undefined, orderBy),
 
-                where: (where: SfRootWhere<OI, N>) => ({
+                where: <W extends SfRootWhere<OI, N>>(where: string | W) => ({
 
                     ..._query(_conn, from, select, where),
 
-                    orderBy: (orderBy: SfRootOrderBy<OI, N>) => _query(_conn, from, select, where, orderBy),
+                    orderBy: <R extends SfRootOrderBy<OI, N>>(orderBy: R) => _query(_conn, from, select, where, orderBy),
 
                 }),
 
@@ -645,8 +645,13 @@ export function getSfObject<OI>(_cfg: SfObjCfgIndex<OI>, o?: SfClientOptions) {
 
 
 export const getSfObjects = <OI>(cfg: SfObjCfgIndex<OI>) => (conn: ISfConnection, options?: SfClientOptions) => {
-    const _func = getSfObject<OI>(cfg, options);
-    return (Object.keys(cfg) as KeyOf<OI>[]).reduce((p, n) => ({ ...p, [n]: _func(n, conn) }), {} as { [N in KeyOf<OI>]: SfObjActions<OI, N> });
+    
+    const __getObject = <N extends KeyOf<OI>>(from: N) => getSfObject<OI>(cfg, options)(from, conn);
+
+    return {
+        ...(Object.keys(cfg) as KeyOf<OI>[]).reduce((p, n) => ({ ...p, [n]: __getObject(n) }), {} as { [N in KeyOf<OI>]: SfObjActions<OI, N> }),
+        __getObject
+    };
 }
 
 export const sfObject = <OI, N extends KeyOf<OI>>(cfg: SfObjCfgIndex<OI>, n: N) => ({ info: cfg[n], select: <S extends SfRootSelect<OI, N>>(s: S[]) => s });