teraslice-client-js 0.60.1 → 0.60.3

package/examples/submit.js

@@ -1,8 +1,5 @@
-'use strict';
-
 /* eslint-disable no-console */
-
-const { TerasliceClient } = require('teraslice-client-js');
+import { TerasliceClient } from 'teraslice-client-js';
 
 const client = new TerasliceClient({
     host: 'http://localhost:5678'
@@ -27,16 +24,19 @@ const exampleJob = {
     ]
 };
 
-client.jobs.submit(exampleJob)
-    .then((job) => {
-        console.log(job.id());
+async function main() {
+    const job = await client.jobs.submit(exampleJob);
+
+    console.log(job.id());
+
+    const job2 = client.jobs.wrap(job.id());
+    const status = await job2.status();
+
+    console.log(status);
 
-        const job2 = client.jobs.wrap(job.id());
-        job2.status().then(console.log);
+    console.log('Waiting for the job to finish.');
+    await job2.waitForStatus('completed');
+    console.log('Job completed');
+}
 
-        console.log('Waiting for the job to finish.');
-        job2.waitForStatus('completed')
-            .then(() => {
-                console.log('Job completed');
-            });
-    });
+main();

package/jest.config.js

@@ -1,3 +1,44 @@
-'use strict';
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
 
-module.exports = require('../../jest.config.base')(__dirname);
+const dirPath = fileURLToPath(new URL('.', import.meta.url));
+const configModulePath = path.join(dirPath, '../../jest.config.base.js');
+
+const module = await import(configModulePath);
+
+const config = module.default(dirPath);
+
+config.extensionsToTreatAsEsm = ['.ts'];
+config.moduleNameMapper = {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+};
+config.testTimeout = 60 * 1000;
+
+// using swc for some reason throws rust file not found errors,
+// seems like a bug on their end, hope to change back later
+config.transform = {};
+config.transform['^.+\\.(t|j)sx?$'] = ['@swc/jest', {
+    jsc: {
+        loose: true,
+        parser: {
+            syntax: 'typescript',
+            tsx: false,
+            decorators: true
+        },
+        transform: {
+            legacyDecorator: true,
+            decoratorMetadata: true
+        },
+        target: 'esnext'
+    },
+    module: {
+        type: 'es6',
+        strictMode: false,
+        noInterop: false,
+        ignoreDynamic: true
+    }
+}];
+
+config.transformIgnorePatterns = [];
+config.preset = '';
+export default config;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "teraslice-client-js",
     "displayName": "Teraslice Client (JavaScript)",
-    "version": "0.60.1",
+    "version": "0.60.3",
     "description": "A Node.js client for teraslice jobs, assets, and cluster references.",
     "keywords": [
         "elasticsearch",
@@ -17,6 +17,7 @@
     "license": "MIT",
     "author": "Terascope, LLC <info@terascope.io>",
     "sideEffects": false,
+    "type": "module",
     "main": "dist/src/index.js",
     "typings": "dist/src/index.d.ts",
     "directories": {
@@ -31,8 +32,8 @@
         "test:watch": "ts-scripts test --watch . --"
     },
     "dependencies": {
-        "@terascope/types": "^0.17.1",
-        "@terascope/utils": "^0.59.1",
+        "@terascope/types": "^0.17.3",
+        "@terascope/utils": "^0.59.3",
         "auto-bind": "^4.0.0",
         "got": "^11.8.3"
     },
@@ -50,6 +51,6 @@
     "srcMain": "src/index.ts",
     "terascope": {
         "enableTypedoc": true,
-        "testSuite": "unit"
+        "testSuite": "unit-esm"
     }
 }

package/src/assets.ts

@@ -1,9 +1,9 @@
 import { TSError, isEmpty, isString } from '@terascope/utils';
 import { Teraslice } from '@terascope/types';
-import path from 'path';
+import path from 'node:path';
 import autoBind from 'auto-bind';
-import Client from './client';
-import { PostData, SearchOptions, ClientConfig } from './interfaces';
+import Client from './client.js';
+import { PostData, SearchOptions, ClientConfig } from './interfaces.js';
 
 export default class Assets extends Client {
     constructor(config: ClientConfig) {

package/src/client.ts

@@ -3,10 +3,10 @@ import {
     isTest, trimStart, tryParseJSON,
     withoutNil,
 } from '@terascope/utils';
-import { STATUS_CODES } from 'http';
-import { URL } from 'url';
+import { STATUS_CODES } from 'node:http';
+import { URL } from 'node:url';
 import got, { Got } from 'got';
-import { ClientConfig, SearchOptions, RequestOptions } from './interfaces';
+import { ClientConfig, SearchOptions, RequestOptions } from './interfaces.js';
 
 export default class Client {
     private readonly _apiVersion: string;

package/src/cluster.ts

@@ -1,8 +1,8 @@
 import { startsWith } from '@terascope/utils';
 import { Teraslice } from '@terascope/types';
-import util from 'util';
+import util from 'node:util';
 import autoBind from 'auto-bind';
-import Client from './client';
+import Client from './client.js';
 
 function _deprecateSlicerName(fn: () => Promise<Teraslice.ExecutionList>) {
     const msg = 'api endpoints with /slicers are being deprecated in favor of the semantically correct term of /controllers';

package/src/ex.ts

@@ -4,8 +4,8 @@ import {
 } from '@terascope/utils';
 import { Teraslice } from '@terascope/types';
 import autoBind from 'auto-bind';
-import Client from './client';
-import { ClientConfig, SearchOptions, RequestOptions } from './interfaces';
+import Client from './client.js';
+import { ClientConfig, SearchOptions, RequestOptions } from './interfaces.js';
 
 export default class Ex extends Client {
     private readonly _exId: string;
@@ -74,7 +74,7 @@ export default class Ex extends Client {
         return this.get(`/ex/${this._exId}/controller`, requestOptions);
     }
 
-    async config(requestOptions: RequestOptions = {}): Promise<Teraslice.ExecutionRecord> {
+    async config(requestOptions: RequestOptions = {}): Promise<Teraslice.ExecutionConfig> {
         return this.get(`/ex/${this._exId}`, requestOptions);
     }
 

package/src/executions.ts

@@ -3,8 +3,8 @@ import {
 } from '@terascope/utils';
 import { Teraslice } from '@terascope/types';
 import autoBind from 'auto-bind';
-import Client from './client';
-import Ex from './ex';
+import Client from './client.js';
+import Ex from './ex.js';
 
 import { ClientConfig, SearchOptions } from './interfaces';
 
@@ -19,7 +19,7 @@ export default class Executions extends Client {
     /**
      * Similar to jobs.submit but returns an instance of Ex not a Job
     */
-    async submit(jobSpec: Teraslice.JobConfig, shouldNotStart?: boolean): Promise<Ex> {
+    async submit(jobSpec: Teraslice.JobConfigParams, shouldNotStart?: boolean): Promise<Ex> {
         if (!jobSpec) {
             throw new TSError('Submit requires a jobSpec', {
                 statusCode: 400
@@ -37,7 +37,7 @@ export default class Executions extends Client {
         return this.wrap(job.ex_id);
     }
 
-    async list(options?: ListOptions): Promise<Teraslice.ExecutionRecord[]> {
+    async list(options?: ListOptions): Promise<Teraslice.ExecutionConfig[]> {
         const query = _parseListOptions(options);
         return this.get('/ex', { searchParams: query } as SearchOptions);
     }

package/src/index.ts

@@ -1,11 +1,11 @@
-import Assets from './assets';
-import Cluster from './cluster';
-import Ex from './ex';
-import Executions from './executions';
-import Job from './job';
-import Jobs from './jobs';
+import Assets from './assets.js';
+import Cluster from './cluster.js';
+import Ex from './ex.js';
+import Executions from './executions.js';
+import Job from './job.js';
+import Jobs from './jobs.js';
 
-import * as i from './interfaces';
+import * as i from './interfaces.js';
 
 class TerasliceClient {
     config?: i.ClientConfig;
@@ -27,7 +27,7 @@ class TerasliceClient {
     }
 }
 
-export * from './interfaces';
+export * from './interfaces.js';
 export {
     TerasliceClient,
     Assets,

package/src/job.ts

@@ -1,4 +1,4 @@
-import util from 'util';
+import util from 'node:util';
 import autoBind from 'auto-bind';
 import {
     pDelay, isString, toString,
@@ -9,8 +9,8 @@ import {
     ClientConfig,
     SearchOptions,
     RequestOptions
-} from './interfaces';
-import Client from './client';
+} from './interfaces.js';
+import Client from './client.js';
 
 /*
  * This is basically a wrapper around the job_id that acts as a proxy
@@ -89,19 +89,19 @@ export default class Job extends Client {
         return this.post(`/jobs/${this._jobId}/_recover`, null, options);
     }
 
-    async update(jobSpec: Teraslice.JobRecord): Promise<Teraslice.JobRecord> {
+    async update(jobSpec: Teraslice.JobConfig): Promise<Teraslice.JobConfig> {
         return this.put(`/jobs/${this._jobId}`, jobSpec);
     }
 
     async updatePartial(
-        jobSpec: Partial<Teraslice.JobRecord>
-    ): Promise<Teraslice.JobRecord> {
+        jobSpec: Partial<Teraslice.JobConfig>
+    ): Promise<Teraslice.JobConfig> {
         const current = await this.config();
-        const body: Teraslice.JobRecord = Object.assign({}, current, jobSpec);
+        const body: Teraslice.JobConfig = Object.assign({}, current, jobSpec);
         return this.update(body);
     }
 
-    async execution(requestOptions: RequestOptions = {}): Promise<Teraslice.ExecutionRecord> {
+    async execution(requestOptions: RequestOptions = {}): Promise<Teraslice.ExecutionConfig> {
         return this.get(`/jobs/${this._jobId}/ex`, requestOptions);
     }
 
@@ -182,7 +182,7 @@ export default class Job extends Client {
         return checkStatus();
     }
 
-    async config(requestOptions: RequestOptions = {}): Promise<Teraslice.JobRecord> {
+    async config(requestOptions: RequestOptions = {}): Promise<Teraslice.JobConfig> {
         return this.get(`/jobs/${this._jobId}`, requestOptions);
     }
 

package/src/jobs.ts

@@ -1,9 +1,9 @@
 import { isString, TSError } from '@terascope/utils';
 import { Teraslice } from '@terascope/types';
 import autoBind from 'auto-bind';
-import Client from './client';
-import Job from './job';
-import { SearchOptions, ClientConfig } from './interfaces';
+import Client from './client.js';
+import Job from './job.js';
+import { SearchOptions, ClientConfig } from './interfaces.js';
 
 export default class Jobs extends Client {
     constructor(config: ClientConfig) {
@@ -11,7 +11,7 @@ export default class Jobs extends Client {
         autoBind(this);
     }
 
-    async submit(jobSpec: Teraslice.JobConfig, shouldNotStart?: boolean): Promise<Job> {
+    async submit(jobSpec: Teraslice.JobConfigParams, shouldNotStart?: boolean): Promise<Job> {
         if (!jobSpec) {
             throw new TSError('Submit requires a jobSpec', {
                 statusCode: 400
@@ -28,7 +28,7 @@ export default class Jobs extends Client {
     async list(
         status?: Teraslice.JobListStatusQuery,
         searchOptions: SearchOptions = {}
-    ): Promise<Teraslice.JobRecord[]> {
+    ): Promise<Teraslice.JobConfig[]> {
         const query = _parseListOptions(status);
         return this.get('/jobs', this.makeOptions(query, searchOptions));
     }

package/test/assets-spec.ts

@@ -1,8 +1,11 @@
 import nock from 'nock';
-import path from 'path';
-import fs from 'fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import fs from 'node:fs';
 import { AssetRecord, AssetIDResponse } from '@terascope/types';
-import Assets from '../src/assets';
+import Assets from '../src/assets.js';
+
+const dirname = path.dirname(fileURLToPath(import.meta.url));
 
 describe('Teraslice Assets', () => {
     let assets: Assets;
@@ -71,7 +74,7 @@ describe('Teraslice Assets', () => {
         // teraslice/e2e/test/cases/assets/simple-spec.ts covers this test case
         // eslint-disable-next-line jest/no-disabled-tests
         xdescribe('when called with a stream', () => {
-            const testFilePath = path.join(__dirname, 'fixtures', 'test.txt');
+            const testFilePath = path.join(dirname, 'fixtures', 'test.txt');
             const contents = fs.readFileSync(testFilePath, 'utf-8');
             const idResponse: AssetIDResponse = { _id: 'some-asset-id' };
 

package/test/client-spec.ts

@@ -1,6 +1,6 @@
 import nock from 'nock';
-import TerasliceClient from '../src';
-import Client from '../src/client';
+import TerasliceClient from '../src/index.js';
+import Client from '../src/client.js';
 
 describe('Teraslice Client', () => {
     describe('when using the main export function', () => {

package/test/cluster-spec.ts

@@ -1,5 +1,5 @@
 import nock from 'nock';
-import Cluster from '../src/cluster';
+import Cluster from '../src/cluster.js';
 
 describe('Teraslice Cluster', () => {
     let cluster: Cluster;

package/test/ex-spec.ts

@@ -1,6 +1,6 @@
 import nock from 'nock';
 import { Teraslice } from '@terascope/types';
-import Ex from '../src/ex';
+import Ex from '../src/ex.js';
 
 describe('Teraslice Ex', () => {
     let scope: nock.Scope;

package/test/executions-spec.ts

@@ -1,6 +1,6 @@
 import nock from 'nock';
-import Ex from '../src/ex';
-import Executions from '../src/executions';
+import Ex from '../src/ex.js';
+import Executions from '../src/executions.js';
 
 describe('Teraslice Executions', () => {
     let executions: Executions;

package/test/job-spec.ts

@@ -1,6 +1,6 @@
 import nock from 'nock';
 import { Teraslice } from '@terascope/types';
-import Job from '../src/job';
+import Job from '../src/job.js';
 
 describe('Teraslice Job', () => {
     let scope: nock.Scope;
@@ -76,7 +76,7 @@ describe('Teraslice Job', () => {
     };
     const date = new Date().toISOString();
 
-    const executionResults: Teraslice.ExecutionRecord[] = [
+    const executionResults: Teraslice.ExecutionConfig[] = [
         {
             active: true,
             analytics: false,
@@ -308,7 +308,7 @@ describe('Teraslice Job', () => {
 
     describe('->update', () => {
         describe('when updating the whole config', () => {
-            const body: Teraslice.JobRecord = {
+            const body: Teraslice.JobConfig = {
                 name: 'hello',
                 apis: [],
                 operations: [],
@@ -343,7 +343,7 @@ describe('Teraslice Job', () => {
 
     describe('->updatePartial', () => {
         describe('when updating a partial config', () => {
-            const body: Teraslice.JobRecord = {
+            const body: Teraslice.JobConfig = {
                 name: 'hello',
                 apis: [],
                 operations: [],

package/test/jobs-spec.ts

@@ -1,8 +1,8 @@
 import 'jest-extended';
 import nock from 'nock';
 import { Teraslice } from '@terascope/types';
-import Job from '../src/job';
-import Jobs from '../src/jobs';
+import Job from '../src/job.js';
+import Jobs from '../src/jobs.js';
 
 describe('Teraslice Jobs', () => {
     let jobs: Jobs;
@@ -22,7 +22,7 @@ describe('Teraslice Jobs', () => {
 
     const date = new Date().toISOString();
 
-    const list: Teraslice.JobRecord[] = [
+    const list: Teraslice.JobConfig[] = [
         {
             job_id: 'some-random-job-id',
             active: true,

package/tsconfig.json

@@ -1,8 +1,14 @@
 {
     "extends": "../../tsconfig",
     "compilerOptions": {
+        "target": "ESNext",
+        "module": "ESNext",
         "outDir": "dist",
         "rootDir": "."
     },
-    "include": ["src", "test"]
+    "include": [
+        "src",
+        "test",
+        "test/fixtures/test.txt"
+    ]
 }