Migrate code from commonJS to EMS

.mocharc.yaml

@@ -0,0 +1 @@
+require: '@babel/register'

README.md

@@ -9,7 +9,8 @@ Javascript library to access the Zulip API
 ### With API Key
 
 ```js
-const zulipInit = require('zulip-js');
+import zulipInit from 'zulip-js';
+
 const config = {
   username: process.env.ZULIP_USERNAME,
   apiKey: process.env.ZULIP_API_KEY,
@@ -28,7 +29,8 @@ const config = {
 You will need to first retrieve the API key by calling `await zulipInit(config)`.
 
 ```js
-const zulipInit = require('zulip-js');
+import zulipInit from 'zulip-js';
+
 const config = {
   username: process.env.ZULIP_USERNAME,
   password: process.env.ZULIP_PASSWORD,
@@ -57,8 +59,9 @@ site=http://localhost:9991
 Please remember to add this file to your `.gitignore`! Calling `await zulipInit({ zuliprc: 'zuliprc' })` will read this file.
 
 ```js
-const zulipInit = require('zulip-js');
-const path = require('path');
+import zulipInit from 'zulip-js';
+import path from 'path';
+
 const zuliprc = path.resolve(__dirname, 'zuliprc');
 (async () => {
   const zulip = await zulipInit({ zuliprc });
@@ -141,9 +144,9 @@ Use `npm test` to run the tests.
 Currently, we have a simple testing framework which stubs our network requests and also allows us to test the input passed to it. This is what a sample test for an API endpoint looks like:
 
 ```js
-const chai = require('chai');
-const users = require('../../lib/resources/users'); // File to test.
-const common = require('../common'); // Common functions for tests.
+import chai from 'chai';
+import users from '../../lib/resources/users';
+import common from '../common';
 
 chai.should();
 

examples/accounts.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 process.on('unhandledRejection', (err) => {
   console.error(err);

examples/call_endpoint.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const config = {
   username: process.env.ZULIP_USERNAME,

examples/emojis.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const config = {
   username: process.env.ZULIP_USERNAME,

examples/events.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const config = {
   username: process.env.ZULIP_USERNAME,

examples/filters.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const config = {
   username: process.env.ZULIP_USERNAME,

examples/init.js

@@ -1,5 +1,5 @@
-const path = require('path');
-const zulip = require('../lib');
+import path from 'path';
+import zulip from '../lib';
 
 (async () => {
   // Initialization with zuliprc

examples/interactive_call_endpoint.js

@@ -1,6 +1,6 @@
-const path = require('path');
-const homedir = require('os').homedir();
-const zulip = require('../lib');
+import path from 'path';
+import { homedir } from 'os';
+import zulip from '../lib';
 
 if (process.argv[2] === 'help') {
   console.log('This is a helper script to test Zulip APIs.');

examples/messages.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const stream = 'test-bot';
 

examples/private-messages.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const config = {
   username: process.env.ZULIP_USERNAME,

examples/queue_helper.js

@@ -1,5 +1,5 @@
-const path = require('path');
-const zulip = require('../lib');
+import path from 'path';
+import zulip from '../lib';
 
 const zuliprc = path.resolve('/path/to/your/zuliprc');
 

examples/queues.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const config = {
   username: process.env.ZULIP_USERNAME,

examples/reactions.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const config = {
   username: process.env.ZULIP_USERNAME,

examples/server.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const config = {
   username: process.env.ZULIP_USERNAME,

examples/streams.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const config = {
   username: process.env.ZULIP_USERNAME,

examples/subscriptions.js

@@ -1,11 +1,11 @@
+import zulip from '../lib';
+
 const config = {
   username: process.env.ZULIP_USERNAME,
   apiKey: process.env.ZULIP_API_KEY,
   realm: process.env.ZULIP_REALM,
 };
 
-const zulip = require('../lib');
-
 (async () => {
   const z = await zulip(config);
 

examples/typing-notifications/send-and-recieve.js

@@ -1,4 +1,4 @@
-const zulip = require('../../lib');
+import zulip from '../../lib';
 
 if (process.argv.length < 7) {
   console.log(

examples/typing-notifications/send-often.js

@@ -1,4 +1,4 @@
-const zulip = require('../../lib');
+import zulip from '../../lib';
 
 if (process.argv.length < 6) {
   console.log(

examples/typing-notifications/send.js

@@ -1,4 +1,4 @@
-const zulip = require('../../lib');
+import zulip from '../../lib';
 
 const recipient = Number(process.env.ZULIP_TYPING_RECIPIENT);
 

examples/users.js

@@ -1,4 +1,4 @@
-const zulip = require('../lib');
+import zulip from '../lib';
 
 const config = {
   username: process.env.ZULIP_USERNAME,

package.json

@@ -8,6 +8,7 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.12.5",
+    "cjs-to-es6": "^1.1.1",
     "ini": "^1.3.7",
     "isomorphic-fetch": "^3.0.0",
     "isomorphic-form-data": "2.0.0"
@@ -17,6 +18,7 @@
     "@babel/core": "^7.12.10",
     "@babel/plugin-transform-runtime": "^7.12.10",
     "@babel/preset-env": "^7.12.10",
+    "@babel/register": "^7.9.0",
     "chai": "^4.2.0",
     "eslint": "^7.15.0",
     "eslint-config-airbnb": "^18.2.1",

src/api.js

@@ -1,4 +1,4 @@
-const helper = require('./helper');
+import helper from './helper';
 
 async function api(baseUrl, config, method, params) {
   const url = new URL(baseUrl);
@@ -45,4 +45,4 @@ async function api(baseUrl, config, method, params) {
   }
 }
 
-module.exports = api;
+export default api;

src/events_wrapper.js

@@ -1,5 +1,5 @@
-const queues = require('./resources/queues');
-const events = require('./resources/events');
+import queues from './resources/queues';
+import events from './resources/events';
 
 function sleep(ms) {
   // TODO add jitter.
@@ -72,4 +72,4 @@ function eventsWrapper(config) {
   return callOnEachEvent;
 }
 
-module.exports = eventsWrapper;
+export default eventsWrapper;

src/helper.js

@@ -1,7 +1,7 @@
-const fetch = require('isomorphic-fetch');
-const FormData = require('isomorphic-form-data');
+import fetch from 'isomorphic-fetch';
+import FormData from 'isomorphic-form-data';
 
-module.exports = {
+export default {
   fetch,
   FormData,
 };

src/index.js

@@ -1,19 +1,18 @@
 import parseConfigFile from './zuliprc';
 
-const api = require('./api');
-
-const accounts = require('./resources/accounts');
-const streams = require('./resources/streams');
-const messages = require('./resources/messages');
-const queues = require('./resources/queues');
-const events = require('./resources/events');
-const users = require('./resources/users');
-const emojis = require('./resources/emojis');
-const typing = require('./resources/typing');
-const reactions = require('./resources/reactions');
-const server = require('./resources/server');
-const filters = require('./resources/filters');
-const eventsWapper = require('./events_wrapper');
+import api from './api';
+import accounts from './resources/accounts';
+import streams from './resources/streams';
+import messages from './resources/messages';
+import queues from './resources/queues';
+import events from './resources/events';
+import users from './resources/users';
+import emojis from './resources/emojis';
+import typing from './resources/typing';
+import reactions from './resources/reactions';
+import server from './resources/server';
+import filters from './resources/filters';
+import eventsWapper from './events_wrapper';
 
 function getCallEndpoint(config) {
   return function callEndpoint(endpoint, method = 'GET', params) {
@@ -64,4 +63,4 @@ async function zulip(initialConfig) {
   return resources(config);
 }
 
-module.exports = zulip;
+export default zulip;

src/resources/accounts.js

@@ -1,4 +1,4 @@
-const helper = require('../helper');
+import helper from '../helper';
 
 function accounts(config) {
   return {
@@ -16,4 +16,4 @@ function accounts(config) {
   };
 }
 
-module.exports = accounts;
+export default accounts;

src/resources/emojis.js

@@ -1,4 +1,4 @@
-const api = require('../api');
+import api from '../api';
 
 function emojis(config) {
   return {
@@ -9,4 +9,4 @@ function emojis(config) {
   };
 }
 
-module.exports = emojis;
+export default emojis;

src/resources/events.js

@@ -1,4 +1,4 @@
-const api = require('../api');
+import api from '../api';
 
 function events(config) {
   return {
@@ -9,4 +9,4 @@ function events(config) {
   };
 }
 
-module.exports = events;
+export default events;

src/resources/filters.js

@@ -1,4 +1,4 @@
-const api = require('../api');
+import api from '../api';
 
 function filters(config) {
   return {
@@ -9,4 +9,4 @@ function filters(config) {
   };
 }
 
-module.exports = filters;
+export default filters;

src/resources/messages.js

@@ -1,4 +1,4 @@
-const api = require('../api');
+import api from '../api';
 
 function messages(config) {
   const baseURL = `${config.apiURL}/messages`;
@@ -71,4 +71,4 @@ function messages(config) {
   };
 }
 
-module.exports = messages;
+export default messages;

src/resources/queues.js

@@ -1,4 +1,4 @@
-const api = require('../api');
+import api from '../api';
 
 function queues(config) {
   return {
@@ -17,4 +17,4 @@ function queues(config) {
   };
 }
 
-module.exports = queues;
+export default queues;

src/resources/reactions.js

@@ -1,4 +1,4 @@
-const api = require('../api');
+import api from '../api';
 
 function reactions(config) {
   const url = (messageID) => `${config.apiURL}/messages/${messageID}/reactions`;
@@ -13,4 +13,4 @@ function reactions(config) {
   };
 }
 
-module.exports = reactions;
+export default reactions;

src/resources/server.js

@@ -1,4 +1,4 @@
-const api = require('../api');
+import api from '../api';
 
 function server(config) {
   return {
@@ -9,4 +9,4 @@ function server(config) {
   };
 }
 
-module.exports = server;
+export default server;

src/resources/streams.js

@@ -1,4 +1,4 @@
-const api = require('../api');
+import api from '../api';
 
 function streams(config) {
   return {
@@ -35,4 +35,4 @@ function streams(config) {
   };
 }
 
-module.exports = streams;
+export default streams;

src/resources/typing.js

@@ -1,4 +1,4 @@
-const api = require('../api');
+import api from '../api';
 
 function typing(config) {
   return {
@@ -13,4 +13,4 @@ function typing(config) {
   };
 }
 
-module.exports = typing;
+export default typing;

src/resources/users.js

@@ -1,4 +1,4 @@
-const api = require('../api');
+import api from '../api';
 
 function users(config) {
   return {
@@ -45,4 +45,4 @@ function users(config) {
   };
 }
 
-module.exports = users;
+export default users;

test/common.js

@@ -1,5 +1,5 @@
-const sinon = require('sinon');
-const helper = require('../lib/helper');
+import sinon from 'sinon';
+import helper from '../lib/helper';
 
 const getFakes = (validator, output) => {
   const fetch = (url, options) => {
@@ -48,7 +48,7 @@ const config = {
   realm: 'https://valid.realm.url/api',
 };
 
-module.exports = {
+export default {
   getFakes,
   stubNetwork,
   config,

test/index.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const lib = require('../lib/index');
-const common = require('./common');
+import chai from 'chai';
+import lib from '../lib/index';
+import common from './common';
 
 chai.should();
 

test/resources/accounts.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const accounts = require('../../lib/resources/accounts');
-const common = require('../common');
+import chai from 'chai';
+import accounts from '../../lib/resources/accounts';
+import common from '../common';
 
 chai.should();
 

test/resources/emojis.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const emojis = require('../../lib/resources/emojis');
-const common = require('../common');
+import chai from 'chai';
+import emojis from '../../lib/resources/emojis';
+import common from '../common';
 
 chai.should();
 

test/resources/events.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const events = require('../../lib/resources/events');
-const common = require('../common');
+import chai from 'chai';
+import events from '../../lib/resources/events';
+import common from '../common';
 
 chai.should();
 

test/resources/filters.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const filters = require('../../lib/resources/filters');
-const common = require('../common');
+import chai from 'chai';
+import filters from '../../lib/resources/filters';
+import common from '../common';
 
 chai.should();
 

test/resources/messages.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const messages = require('../../lib/resources/messages');
-const common = require('../common');
+import chai from 'chai';
+import messages from '../../lib/resources/messages';
+import common from '../common';
 
 chai.should();
 

test/resources/queues.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const queues = require('../../lib/resources/queues');
-const common = require('../common');
+import chai from 'chai';
+import queues from '../../lib/resources/queues';
+import common from '../common';
 
 chai.should();
 

test/resources/reactions.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const reactions = require('../../lib/resources/reactions');
-const common = require('../common');
+import chai from 'chai';
+import reactions from '../../lib/resources/reactions';
+import common from '../common';
 
 chai.should();
 

test/resources/server.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const server = require('../../lib/resources/server');
-const common = require('../common');
+import chai from 'chai';
+import server from '../../lib/resources/server';
+import common from '../common';
 
 chai.should();
 

test/resources/streams.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const streams = require('../../lib/resources/streams');
-const common = require('../common');
+import chai from 'chai';
+import streams from '../../lib/resources/streams';
+import common from '../common';
 
 chai.should();
 

test/resources/typing.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const typing = require('../../lib/resources/typing');
-const common = require('../common');
+import chai from 'chai';
+import typing from '../../lib/resources/typing';
+import common from '../common';
 
 chai.should();
 

test/resources/users.js

@@ -1,6 +1,6 @@
-const chai = require('chai');
-const users = require('../../lib/resources/users');
-const common = require('../common');
+import chai from 'chai';
+import users from '../../lib/resources/users';
+import common from '../common';
 
 chai.should();