@jsforce/jsforce-node 0.0.1 → 3.0.0-next.1

package/lib/api/analytics.d.ts

@@ -0,0 +1,163 @@
+import Connection from '../connection';
+import { Schema } from '../types';
+import { ReportMetadata, ReportExecuteResult, ReportRetrieveResult, ReportDescribeResult, ReportInfo, ReportInstanceInfo, DashboardMetadata, DashboardResult, DashboardStatusResult, DashboardRefreshResult, DashboardInfo } from './analytics/types';
+import { QueryExplainResult } from '../query';
+export type { ReportMetadata, ReportExecuteResult, ReportRetrieveResult, ReportDescribeResult, ReportInfo, ReportInstanceInfo, DashboardMetadata, DashboardResult, DashboardStatusResult, DashboardRefreshResult, DashboardInfo, };
+export type ReportExecuteOptions = {
+    details?: boolean;
+    metadata?: {
+        reportMetadata: Partial<ReportMetadata>;
+    };
+};
+/**
+ * Report object class in Analytics API
+ */
+export declare class ReportInstance<S extends Schema> {
+    _report: Report<S>;
+    _conn: Connection<S>;
+    id: string;
+    /**
+     *
+     */
+    constructor(report: Report<S>, id: string);
+    /**
+     * Retrieve report result asynchronously executed
+     */
+    retrieve(): Promise<ReportRetrieveResult>;
+}
+/**
+ * Report object class in Analytics API
+ */
+export declare class Report<S extends Schema> {
+    _conn: Connection<S>;
+    id: string;
+    /**
+     *
+     */
+    constructor(conn: Connection<S>, id: string);
+    /**
+     * Describe report metadata
+     */
+    describe(): Promise<ReportDescribeResult>;
+    /**
+     * Destroy a report
+     */
+    destroy(): Promise<void>;
+    /**
+     * Synonym of Analytics~Report#destroy()
+     */
+    delete: () => Promise<void>;
+    /**
+     * Synonym of Analytics~Report#destroy()
+     */
+    del: () => Promise<void>;
+    /**
+     * Clones a given report
+     */
+    clone(name: string): Promise<ReportDescribeResult>;
+    /**
+     * Explain plan for executing report
+     */
+    explain(): Promise<QueryExplainResult>;
+    /**
+     * Run report synchronously
+     */
+    execute(options?: ReportExecuteOptions): Promise<ReportExecuteResult>;
+    /**
+     * Synonym of Analytics~Report#execute()
+     */
+    run: (options?: ReportExecuteOptions) => Promise<ReportExecuteResult>;
+    /**
+     * Synonym of Analytics~Report#execute()
+     */
+    exec: (options?: ReportExecuteOptions) => Promise<ReportExecuteResult>;
+    /**
+     * Run report asynchronously
+     */
+    executeAsync(options?: ReportExecuteOptions): Promise<ReportInstanceInfo>;
+    /**
+     * Get report instance for specified instance ID
+     */
+    instance(id: string): ReportInstance<S>;
+    /**
+     * List report instances which had been executed asynchronously
+     */
+    instances(): Promise<ReportInstanceInfo[]>;
+}
+/**
+ * Dashboard object class in the Analytics API
+ */
+export declare class Dashboard<S extends Schema> {
+    _conn: Connection<S>;
+    id: string;
+    /**
+     *
+     */
+    constructor(conn: Connection<S>, id: string);
+    /**
+     * Describe dashboard metadata
+     *
+     * @method Analytics~Dashboard#describe
+     * @param {Callback.<Analytics-DashboardMetadata>} [callback] - Callback function
+     * @returns {Promise.<Analytics-DashboardMetadata>}
+     */
+    describe(): Promise<DashboardMetadata>;
+    /**
+     * Get details about dashboard components
+     */
+    components(componentIds?: string | string[]): Promise<DashboardResult>;
+    /**
+     * Get dashboard status
+     */
+    status(): Promise<DashboardStatusResult>;
+    /**
+     * Refresh a dashboard
+     */
+    refresh(): Promise<DashboardRefreshResult>;
+    /**
+     * Clone a dashboard
+     */
+    clone(config: {
+        name: string;
+        folderId?: string;
+    } | string, folderId?: string): Promise<DashboardMetadata>;
+    /**
+     * Destroy a dashboard
+     */
+    destroy(): Promise<void>;
+    /**
+     * Synonym of Analytics~Dashboard#destroy()
+     */
+    delete: () => Promise<void>;
+    /**
+     * Synonym of Analytics~Dashboard#destroy()
+     */
+    del: () => Promise<void>;
+}
+/**
+ * API class for Analytics API
+ */
+export declare class Analytics<S extends Schema> {
+    _conn: Connection<S>;
+    /**
+     *
+     */
+    constructor(conn: Connection<S>);
+    /**
+     * Get report object of Analytics API
+     */
+    report(id: string): Report<S>;
+    /**
+     * Get recent report list
+     */
+    reports(): import("../util/promise").StreamPromise<ReportInfo[]>;
+    /**
+     * Get dashboard object of Analytics API
+     */
+    dashboard(id: string): Dashboard<S>;
+    /**
+     * Get recent dashboard list
+     */
+    dashboards(): import("../util/promise").StreamPromise<DashboardInfo[]>;
+}
+export default Analytics;

package/lib/api/analytics.js

@@ -0,0 +1,342 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = exports.Dashboard = exports.Report = exports.ReportInstance = void 0;
+/**
+ * @file Manages Salesforce Analytics API
+ * @author Shinichi Tomita <shinichi.tomita@gmail.com>
+ */
+const jsforce_1 = require("../jsforce");
+/*----------------------------------------------------------------------------------*/
+/**
+ * Report object class in Analytics API
+ */
+class ReportInstance {
+    _report;
+    _conn;
+    id;
+    /**
+     *
+     */
+    constructor(report, id) {
+        this._report = report;
+        this._conn = report._conn;
+        this.id = id;
+    }
+    /**
+     * Retrieve report result asynchronously executed
+     */
+    retrieve() {
+        const url = [
+            this._conn._baseUrl(),
+            'analytics',
+            'reports',
+            this._report.id,
+            'instances',
+            this.id,
+        ].join('/');
+        return this._conn.request(url);
+    }
+}
+exports.ReportInstance = ReportInstance;
+/*----------------------------------------------------------------------------------*/
+/**
+ * Report object class in Analytics API
+ */
+class Report {
+    _conn;
+    id;
+    /**
+     *
+     */
+    constructor(conn, id) {
+        this._conn = conn;
+        this.id = id;
+    }
+    /**
+     * Describe report metadata
+     */
+    describe() {
+        const url = [
+            this._conn._baseUrl(),
+            'analytics',
+            'reports',
+            this.id,
+            'describe',
+        ].join('/');
+        return this._conn.request(url);
+    }
+    /**
+     * Destroy a report
+     */
+    destroy() {
+        const url = [this._conn._baseUrl(), 'analytics', 'reports', this.id].join('/');
+        return this._conn.request({ method: 'DELETE', url });
+    }
+    /**
+     * Synonym of Analytics~Report#destroy()
+     */
+    delete = this.destroy;
+    /**
+     * Synonym of Analytics~Report#destroy()
+     */
+    del = this.destroy;
+    /**
+     * Clones a given report
+     */
+    clone(name) {
+        const url = [this._conn._baseUrl(), 'analytics', 'reports'].join('/') +
+            '?cloneId=' +
+            this.id;
+        const config = { reportMetadata: { name } };
+        return this._conn.request({
+            method: 'POST',
+            url,
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify(config),
+        });
+    }
+    /**
+     * Explain plan for executing report
+     */
+    explain() {
+        const url = '/query/?explain=' + this.id;
+        return this._conn.request(url);
+    }
+    /**
+     * Run report synchronously
+     */
+    execute(options = {}) {
+        const url = [this._conn._baseUrl(), 'analytics', 'reports', this.id].join('/') +
+            '?includeDetails=' +
+            (options.details ? 'true' : 'false');
+        return this._conn.request({
+            url,
+            ...(options.metadata
+                ? {
+                    method: 'POST',
+                    headers: { 'Content-Type': 'application/json' },
+                    body: JSON.stringify(options.metadata),
+                }
+                : { method: 'GET' }),
+        });
+    }
+    /**
+     * Synonym of Analytics~Report#execute()
+     */
+    run = this.execute;
+    /**
+     * Synonym of Analytics~Report#execute()
+     */
+    exec = this.execute;
+    /**
+     * Run report asynchronously
+     */
+    executeAsync(options = {}) {
+        const url = [
+            this._conn._baseUrl(),
+            'analytics',
+            'reports',
+            this.id,
+            'instances',
+        ].join('/') + (options.details ? '?includeDetails=true' : '');
+        return this._conn.request({
+            method: 'POST',
+            url,
+            ...(options.metadata
+                ? {
+                    headers: { 'Content-Type': 'application/json' },
+                    body: JSON.stringify(options.metadata),
+                }
+                : { body: '' }),
+        });
+    }
+    /**
+     * Get report instance for specified instance ID
+     */
+    instance(id) {
+        return new ReportInstance(this, id);
+    }
+    /**
+     * List report instances which had been executed asynchronously
+     */
+    instances() {
+        const url = [
+            this._conn._baseUrl(),
+            'analytics',
+            'reports',
+            this.id,
+            'instances',
+        ].join('/');
+        return this._conn.request(url);
+    }
+}
+exports.Report = Report;
+/*----------------------------------------------------------------------------------*/
+/**
+ * Dashboard object class in the Analytics API
+ */
+class Dashboard {
+    _conn;
+    id;
+    /**
+     *
+     */
+    constructor(conn, id) {
+        this._conn = conn;
+        this.id = id;
+    }
+    /**
+     * Describe dashboard metadata
+     *
+     * @method Analytics~Dashboard#describe
+     * @param {Callback.<Analytics-DashboardMetadata>} [callback] - Callback function
+     * @returns {Promise.<Analytics-DashboardMetadata>}
+     */
+    describe() {
+        const url = [
+            this._conn._baseUrl(),
+            'analytics',
+            'dashboards',
+            this.id,
+            'describe',
+        ].join('/');
+        return this._conn.request(url);
+    }
+    /**
+     * Get details about dashboard components
+     */
+    components(componentIds) {
+        const url = [
+            this._conn._baseUrl(),
+            'analytics',
+            'dashboards',
+            this.id,
+        ].join('/');
+        const config = {
+            componentIds: Array.isArray(componentIds)
+                ? componentIds
+                : typeof componentIds === 'string'
+                    ? [componentIds]
+                    : undefined,
+        };
+        return this._conn.request({
+            method: 'POST',
+            url,
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify(config),
+        });
+    }
+    /**
+     * Get dashboard status
+     */
+    status() {
+        const url = [
+            this._conn._baseUrl(),
+            'analytics',
+            'dashboards',
+            this.id,
+            'status',
+        ].join('/');
+        return this._conn.request(url);
+    }
+    /**
+     * Refresh a dashboard
+     */
+    refresh() {
+        const url = [
+            this._conn._baseUrl(),
+            'analytics',
+            'dashboards',
+            this.id,
+        ].join('/');
+        return this._conn.request({
+            method: 'PUT',
+            url,
+            body: '',
+        });
+    }
+    /**
+     * Clone a dashboard
+     */
+    clone(config, folderId) {
+        const url = [this._conn._baseUrl(), 'analytics', 'dashboards'].join('/') +
+            '?cloneId=' +
+            this.id;
+        if (typeof config === 'string') {
+            config = { name: config, folderId };
+        }
+        return this._conn.request({
+            method: 'POST',
+            url,
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify(config),
+        });
+    }
+    /**
+     * Destroy a dashboard
+     */
+    destroy() {
+        const url = [
+            this._conn._baseUrl(),
+            'analytics',
+            'dashboards',
+            this.id,
+        ].join('/');
+        return this._conn.request({ method: 'DELETE', url });
+    }
+    /**
+     * Synonym of Analytics~Dashboard#destroy()
+     */
+    delete = this.destroy;
+    /**
+     * Synonym of Analytics~Dashboard#destroy()
+     */
+    del = this.destroy;
+}
+exports.Dashboard = Dashboard;
+/*----------------------------------------------------------------------------------*/
+/**
+ * API class for Analytics API
+ */
+class Analytics {
+    _conn;
+    /**
+     *
+     */
+    constructor(conn) {
+        this._conn = conn;
+    }
+    /**
+     * Get report object of Analytics API
+     */
+    report(id) {
+        return new Report(this._conn, id);
+    }
+    /**
+     * Get recent report list
+     */
+    reports() {
+        const url = [this._conn._baseUrl(), 'analytics', 'reports'].join('/');
+        return this._conn.request(url);
+    }
+    /**
+     * Get dashboard object of Analytics API
+     */
+    dashboard(id) {
+        return new Dashboard(this._conn, id);
+    }
+    /**
+     * Get recent dashboard list
+     */
+    dashboards() {
+        const url = [this._conn._baseUrl(), 'analytics', 'dashboards'].join('/');
+        return this._conn.request(url);
+    }
+}
+exports.Analytics = Analytics;
+/*--------------------------------------------*/
+/*
+ * Register hook in connection instantiation for dynamically adding this API module features
+ */
+(0, jsforce_1.registerModule)('analytics', (conn) => new Analytics(conn));
+exports.default = Analytics;

package/lib/api/apex.d.ts

@@ -0,0 +1,44 @@
+import Connection from '../connection';
+import { HttpRequest, HttpMethods, Schema } from '../types';
+/**
+ * API class for Apex REST endpoint call
+ */
+export declare class Apex<S extends Schema> {
+    _conn: Connection<S>;
+    /**
+     *
+     */
+    constructor(conn: Connection<S>);
+    _baseUrl(): string;
+    /**
+     * @private
+     */
+    _createRequestParams(method: HttpMethods, path: string, body?: Object, options?: {
+        headers?: HttpRequest['headers'];
+    }): HttpRequest;
+    /**
+     * Call Apex REST service in GET request
+     */
+    get<R = unknown>(path: string, options?: Object): import("../util/promise").StreamPromise<R>;
+    /**
+     * Call Apex REST service in POST request
+     */
+    post<R = unknown>(path: string, body?: Object, options?: Object): import("../util/promise").StreamPromise<R>;
+    /**
+     * Call Apex REST service in PUT request
+     */
+    put<R = unknown>(path: string, body?: Object, options?: Object): import("../util/promise").StreamPromise<R>;
+    /**
+     * Call Apex REST service in PATCH request
+     */
+    patch<R = unknown>(path: string, body?: Object, options?: Object): import("../util/promise").StreamPromise<R>;
+    /**
+     * Call Apex REST service in DELETE request
+     */
+    delete<R = unknown>(path: string, options?: Object): import("../util/promise").StreamPromise<R>;
+    /**
+     * Synonym of Apex#delete()
+     */
+    del: <R = unknown>(path: string, options?: Object) => import("../util/promise").StreamPromise<R>;
+}
+export default Apex;

package/lib/api/apex.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Apex = void 0;
+/**
+ * @file Manages Salesforce Apex REST endpoint calls
+ * @author Shinichi Tomita <shinichi.tomita@gmail.com>
+ */
+const jsforce_1 = require("../jsforce");
+/**
+ * API class for Apex REST endpoint call
+ */
+class Apex {
+    _conn;
+    /**
+     *
+     */
+    constructor(conn) {
+        this._conn = conn;
+    }
+    /* @private */
+    _baseUrl() {
+        return `${this._conn.instanceUrl}/services/apexrest`;
+    }
+    /**
+     * @private
+     */
+    _createRequestParams(method, path, body, options = {}) {
+        const headers = typeof options.headers === 'object' ? options.headers : {};
+        if (!/^(GET|DELETE)$/i.test(method)) {
+            headers['content-type'] = 'application/json';
+        }
+        const params = {
+            method,
+            url: this._baseUrl() + path,
+            headers,
+        };
+        if (body) {
+            params.body = JSON.stringify(body);
+        }
+        return params;
+    }
+    /**
+     * Call Apex REST service in GET request
+     */
+    get(path, options) {
+        return this._conn.request(this._createRequestParams('GET', path, undefined, options));
+    }
+    /**
+     * Call Apex REST service in POST request
+     */
+    post(path, body, options) {
+        const params = this._createRequestParams('POST', path, body, options);
+        return this._conn.request(params);
+    }
+    /**
+     * Call Apex REST service in PUT request
+     */
+    put(path, body, options) {
+        const params = this._createRequestParams('PUT', path, body, options);
+        return this._conn.request(params);
+    }
+    /**
+     * Call Apex REST service in PATCH request
+     */
+    patch(path, body, options) {
+        const params = this._createRequestParams('PATCH', path, body, options);
+        return this._conn.request(params);
+    }
+    /**
+     * Call Apex REST service in DELETE request
+     */
+    delete(path, options) {
+        return this._conn.request(this._createRequestParams('DELETE', path, undefined, options));
+    }
+    /**
+     * Synonym of Apex#delete()
+     */
+    del = this.delete;
+}
+exports.Apex = Apex;
+/*--------------------------------------------*/
+/*
+ * Register hook in connection instantiation for dynamically adding this API module features
+ */
+(0, jsforce_1.registerModule)('apex', (conn) => new Apex(conn));
+exports.default = Apex;