Update jsforce interfaces, function definitions (DefinitelyTyped#37021)

* make type optional in create, update, upsert implement RetrieveRequest, associated interfaces * fix spacing
breeze9527 · Jan 27, 2020 · 433e097 · 433e097
1 parent fe6f827
commit 433e097
Show file tree

Hide file tree

Showing 3 changed files with 144 additions and 36 deletions.
diff --git a/types/jsforce/api/metadata.d.ts b/types/jsforce/api/metadata.d.ts
@@ -66,7 +66,40 @@ interface MetadataInfo {
     fullName: string;
 }
 
+interface Package {
+    apiAccessLevel?: "Unrestricted" | "Restricted";
+    description?: string;
+    fullName?: string;
+    namespacePrefix?: string;
+    objectPermissions?: ProfileObjectPermissions[];
+    postInstallClass?: string;
+    setupWeblink?: string;
+    types: PackageTypeMembers[];
+    uninstallClass?: string;
+    version: string;
+}
+
+interface PackageTypeMembers {
+    members: string[];
+    name: string;
+}
+
+interface ProfileObjectPermissions {
+    allowCreate?: boolean;
+    allowDelete?: boolean;
+    allowEdit?: boolean;
+    allowRead?: boolean;
+    modifyAllRecords?: boolean;
+    object: string;
+    viewAllRecords?: boolean;
+}
+
 interface RetrieveRequest {
+    apiVersion?: string;
+    packageNames?: string[];
+    singlePackage?: boolean;
+    specificFiles?: string[];
+    unpackaged?: Package;
 }
 
 interface RetrieveResult {
@@ -135,43 +168,111 @@ export class Metadata {
 
     constructor(conn: Connection);
 
-    checkDeployStatus(id: string, includeDetails?: boolean, callback?: Callback<DeployResult>): Promise<DeployResult>
-
-    checkRetrieveStatus(id: string, callback?: Callback<RetrieveResult>): Promise<RetrieveResult>
-
-    checkStatus(ids: string | string[], callback?: Callback<AsyncResult | Array<AsyncResult>>): AsyncResultLocator<AsyncResult | Array<AsyncResult>>
-
-    create(type: string, metadata: MetadataInfo | Array<MetadataInfo>, callback?: Callback<SaveResult | Array<SaveResult>>): Promise<SaveResult | Array<SaveResult>>
-
-    createAsync(type: string, metadata: MetadataInfo | Array<MetadataInfo>, callback?: Callback<SaveResult | Array<SaveResult>>): Promise<SaveResult | Array<SaveResult>>
-
-    createSync(type: string, metadata: MetadataInfo | Array<MetadataInfo>,  callback?: Callback<SaveResult | Array<SaveResult>>): Promise<SaveResult | Array<SaveResult>>;
-
-    delete(type: string, fullNames: string | string[], callback?: Callback<SaveResult | Array<SaveResult>>): Promise<SaveResult | Array<SaveResult>>;
-
-    deleteAsync(type: string, metadata: string | string[] | MetadataInfo | Array<MetadataInfo>, callback?: Callback<AsyncResult | Array<AsyncResult>>): AsyncResultLocator<AsyncResult | Array<AsyncResult>>
-
-    deleteSync(type: string, fullNames: string | string[], callback?: Callback<SaveResult | Array<SaveResult>>): Promise<SaveResult | Array<SaveResult>>;
-
-    deploy(zipInput: Stream | Buffer | string, options: DeployOptions, callback?:Callback<AsyncResult>): DeployResultLocator<AsyncResult>;
+    checkDeployStatus(
+        id: string,
+        includeDetails?: boolean,
+        callback?: Callback<DeployResult>
+    ): Promise<DeployResult>;
+
+    checkRetrieveStatus(id: string, callback?: Callback<RetrieveResult>): Promise<RetrieveResult>;
+
+    checkStatus(
+        ids: string | string[],
+        callback?: Callback<AsyncResult | Array<AsyncResult>>
+    ): AsyncResultLocator<AsyncResult | Array<AsyncResult>>;
+
+    create(
+        type: string,
+        metadata: MetadataInfo | Array<MetadataInfo>,
+        callback?: Callback<SaveResult | Array<SaveResult>>
+    ): Promise<SaveResult | Array<SaveResult>>;
+
+    createAsync(
+        type: string,
+        metadata: MetadataInfo | Array<MetadataInfo>,
+        callback?: Callback<SaveResult | Array<SaveResult>>
+    ): Promise<SaveResult | Array<SaveResult>>;
+
+    createSync(
+        type: string,
+        metadata: MetadataInfo | Array<MetadataInfo>,
+        callback?: Callback<SaveResult | Array<SaveResult>>
+    ): Promise<SaveResult | Array<SaveResult>>;
+
+    delete(
+        type: string,
+        fullNames: string | string[],
+        callback?: Callback<SaveResult | Array<SaveResult>>
+    ): Promise<SaveResult | Array<SaveResult>>;
+
+    deleteAsync(
+        type: string,
+        metadata: string | string[] | MetadataInfo | Array<MetadataInfo>,
+        callback?: Callback<AsyncResult | Array<AsyncResult>>
+    ): AsyncResultLocator<AsyncResult | Array<AsyncResult>>;
+
+    deleteSync(
+        type: string,
+        fullNames: string | string[],
+        callback?: Callback<SaveResult | Array<SaveResult>>
+    ): Promise<SaveResult | Array<SaveResult>>;
+
+    deploy(
+        zipInput: Stream | Buffer | string,
+        options: DeployOptions,
+        callback?: Callback<AsyncResult>
+    ): DeployResultLocator<AsyncResult>;
 
     describe(version?: string, callback?: Callback<DescribeMetadataResult>): Promise<DescribeMetadataResult>;
 
-    list(queries: ListMetadataQuery | Array<ListMetadataQuery>, version?: string, callback?: Callback<Array<FileProperties>>): Promise<Array<FileProperties>>;
-
-    read(type: string, fullNames: string | string[], callback?: Callback<MetadataInfo | Array<MetadataInfo>>): Promise<MetadataInfo | Array<MetadataInfo>>;
-
-    readSync(type: string, fullNames: string | string[], callback?: Callback<MetadataInfo | Array<MetadataInfo>>): Promise<MetadataInfo | Array<MetadataInfo>>;
-
-    rename(type: string, oldFullName: string, newFullName: string, callback?: Callback<SaveResult>): Promise<SaveResult>
-
-    retrieve(request: RetrieveRequest, callback: Callback<AsyncResult>): RetrieveResultLocator<AsyncResult>
-
-    update(type: string, updateMetadata: MetadataInfo | Array<MetadataInfo>, callback?: Callback<SaveResult | Array<SaveResult>>): Promise<SaveResult | Array<SaveResult>>
-
-    updateAsync(type: string, updateMetadata: MetadataInfo, callback?: Callback<AsyncResult | Array<AsyncResult>>): AsyncResultLocator<AsyncResult | Array<AsyncResult>>
-
-    updateSync(type: string, updateMetadata: MetadataInfo | Array<MetadataInfo>, callback?: Callback<SaveResult | Array<SaveResult>>): Promise<SaveResult | Array<SaveResult>>
-
-    upsert(type: string, metadata: MetadataInfo | Array<MetadataInfo>, callback?: Callback<UpsertResult | Array<UpsertResult>>): Promise<UpsertResult | Array<UpsertResult>>
+    list(
+        queries: ListMetadataQuery | Array<ListMetadataQuery>,
+        version?: string,
+        callback?: Callback<Array<FileProperties>>
+    ): Promise<Array<FileProperties>>;
+
+    read(
+        type: string,
+        fullNames: string | string[],
+        callback?: Callback<MetadataInfo | Array<MetadataInfo>>
+    ): Promise<MetadataInfo | Array<MetadataInfo>>;
+
+    readSync(
+        type: string,
+        fullNames: string | string[],
+        callback?: Callback<MetadataInfo | Array<MetadataInfo>>
+    ): Promise<MetadataInfo | Array<MetadataInfo>>;
+
+    rename(
+        type: string,
+        oldFullName: string,
+        newFullName: string,
+        callback?: Callback<SaveResult>
+    ): Promise<SaveResult>;
+
+    retrieve(request: RetrieveRequest, callback?: Callback<AsyncResult>): RetrieveResultLocator<AsyncResult>;
+
+    update(
+        type: string,
+        updateMetadata: MetadataInfo | Array<MetadataInfo>,
+        callback?: Callback<SaveResult | Array<SaveResult>>
+    ): Promise<SaveResult | Array<SaveResult>>;
+
+    updateAsync(
+        type: string,
+        updateMetadata: MetadataInfo,
+        callback?: Callback<AsyncResult | Array<AsyncResult>>
+    ): AsyncResultLocator<AsyncResult | Array<AsyncResult>>;
+
+    updateSync(
+        type: string,
+        updateMetadata: MetadataInfo | Array<MetadataInfo>,
+        callback?: Callback<SaveResult | Array<SaveResult>>
+    ): Promise<SaveResult | Array<SaveResult>>;
+
+    upsert(
+        type: string,
+        metadata: MetadataInfo | Array<MetadataInfo>,
+        callback?: Callback<UpsertResult | Array<UpsertResult>>
+    ): Promise<UpsertResult | Array<UpsertResult>>;
 }
diff --git a/types/jsforce/connection.d.ts b/types/jsforce/connection.d.ts
@@ -108,14 +108,20 @@ export abstract class BaseConnection extends EventEmitter {
     queryMore<T>(locator: string, options?: ExecuteOptions, callback?: (err: Error, result: QueryResult<T>) => void): Promise<QueryResult<T>>;
     create<T>(type: string, records: Record<T> | Array<Record<T>>, options?: RestApiOptions,
         callback?: (err: Error, result: RecordResult | RecordResult[]) => void): Promise<(RecordResult | RecordResult[])>;
+    create<T>(records: Record<T> | Array<Record<T>>, options?: RestApiOptions,
+        callback?: (err: Error, result: RecordResult | RecordResult[]) => void): Promise<(RecordResult | RecordResult[])>;
     insert<T>(type: string, records: Record<T> | Array<Record<T>>, options?: RestApiOptions,
         callback?: (err: Error, result: RecordResult | RecordResult[]) => void): Promise<(RecordResult | RecordResult[])>;
     retrieve<T>(type: string, ids: string | string[], options?: RestApiOptions,
         callback?: (err: Error, result: Record<T> | Array<Record<T>>) => void): Promise<(Record<T> | Array<Record<T>>)>;
     update<T>(type: string, records: Record<T> | Array<Record<T>>, options?: RestApiOptions,
         callback?: (err: Error, result: RecordResult | Array<Record<T>>) => void): Promise<(RecordResult | RecordResult[])>;
+    update<T>(records: Record<T> | Array<Record<T>>, options?: RestApiOptions,
+        callback?: (err: Error, result: RecordResult | Array<Record<T>>) => void): Promise<(RecordResult | RecordResult[])>;
     upsert<T>(type: string, records: Record<T> | Array<Record<T>>, extIdField: string, options?: RestApiOptions,
         callback?: (err: Error, result: RecordResult | RecordResult[]) => void): Promise<(RecordResult | RecordResult[])>;
+    upsert<T>(records: Record<T> | Array<Record<T>>, extIdField: string, options?: RestApiOptions,
+        callback?: (err: Error, result: RecordResult | RecordResult[]) => void): Promise<(RecordResult | RecordResult[])>;
     del<T>(type: string, ids: string | string[], options?: RestApiOptions,
         callback?: (err: Error, result: RecordResult | RecordResult[]) => void): Promise<(RecordResult | RecordResult[])>;
     delete<T>(type: string, ids: string | string[], options?: RestApiOptions,

diff --git a/types/jsforce/index.d.ts b/types/jsforce/index.d.ts
@@ -7,6 +7,7 @@
 //                 Abraham White <https://github.com/whiteabelincoln>
 //                 Borys Kupar <https://github.com/borys-kupar>
 //                 Andrés Catalán <https://github.com/catalandres>
+//                 Ken Human <https://github.com/kenhuman>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.3