itoolkit 1.0.0-rc.1 → 1.0.1

package/docs/deprecated/iObj.rst

@@ -1,64 +0,0 @@
-.. _iObj:
-
-iObj
-----
-
-.. autoclass:: iObj
-   :members:
-
-.. autofunction:: addToLibraryListCallback
-.. autofunction:: retrUsrAuthCallback
-.. autofunction:: retrUsrAuthOutput
-.. autofunction:: retrCmdInfoCallback
-.. autofunction:: retrCmdInfoOutput
-.. autofunction:: retrPgmInfoCallback
-.. autofunction:: retrPgmInfoOutput
-.. autofunction:: retrSrvPgmInfoCallback
-.. autofunction:: retrSrvPgmInfoOutput
-.. autofunction:: retrUserInfoCallback
-.. autofunction:: retrUserInfoOutput
-.. autofunction:: retrUserAuthToObjCallback
-.. autofunction:: retrUserAuthToObjOutput
-
-Examples
-^^^^^^^^
-
-Retrieve a user's authority to an object
-""""""""""""""""""""""""""""""""""""""""
-.. literalinclude:: examples/retrUsrAuth.js
-   :language: javascript
-
-Retrieve command information
-""""""""""""""""""""""""""""
-
-.. literalinclude:: examples/retrCmdInfo.js
-   :language: javascript
-
-Retrieve program information
-""""""""""""""""""""""""""""
-
-.. literalinclude:: examples/retrPgmInfo.js
-   :language: javascript
-
-Retrieve service program information
-
-.. literalinclude:: examples/retrSrvPgmInfo.js
-   :language: javascript
-
-Retrieve user information
-"""""""""""""""""""""""""
-
-.. literalinclude:: examples/retrUserInfo.js
-   :language: javascript
-
-Retrieve users authorized to an object
-""""""""""""""""""""""""""""""""""""""
-
-.. literalinclude:: examples/retrUserAuthToObj.js
-   :language: javascript
-
-Add a library to the library list
-"""""""""""""""""""""""""""""""""
-
-.. literalinclude:: examples/addToLibraryList.js
-   :language: javascript

package/docs/deprecated/iPgm.rst

@@ -1,9 +0,0 @@
-.. _ipgm:
-
-iPgm
-----
-
-.. autoclass:: iPgm
-   :members:
-
-.. autofunction:: iPgmOptions

package/docs/deprecated/iProd.rst

@@ -1,36 +0,0 @@
-.. _iProd:
-
-iProd
------
-
-.. autoclass:: iProd
-   :members:
-
-.. autofunction:: getPTFInfoCallback
-.. autofunction:: getPTFInfoOutput
-.. autofunction:: getProductInfoCallback
-.. autofunction:: getProductInfoOutput
-.. autofunction:: getInstalledProductsCallback
-.. autofunction:: getInstalledProductsOutput
-
-Examples
-^^^^^^^^
-
-Retrieve basic PTF info
-"""""""""""""""""""""""
-
-.. literalinclude:: examples/getPTFInfo.js
-   :language: javascript
-
-
-Retrieve basic information about the product load
-"""""""""""""""""""""""""""""""""""""""""""""""""
-
-.. literalinclude:: examples/getProductInfo.js
-   :language: javascript
-
-Retrieve the list of all installed products
-"""""""""""""""""""""""""""""""""""""""""""
-
-.. literalinclude:: examples/getInstalledProducts.js
-   :language: javascript

package/docs/deprecated/iQsh.rst

@@ -1,7 +0,0 @@
-.. _iQsh:
-
-iQsh
-----
-
-.. autofunction:: iQsh
-.. autofunction:: qshOptionsDeprecated

package/docs/deprecated/iSh.rst

@@ -1,7 +0,0 @@
-.. _iSh:
-
-iSh
----
-
-.. autofunction:: iSh
-.. autofunction:: shOptionsDeprecated

package/docs/deprecated/iSql.rst

@@ -1,30 +0,0 @@
-.. _iSql:
-
-iSql
-----
-
-.. autoclass:: iSql
-   :members:
-
-.. autofunction:: iSqlOptions
-.. autofunction:: commitOptions
-.. autofunction:: describeOptions
-.. autofunction:: countOptions
-.. autofunction:: executeParams
-.. autofunction:: fetchOptions
-
-Examples
-^^^^^^^^
-
-Run a query
-"""""""""""
-
-.. literalinclude:: examples/addQuery.js
-   :language: javascript
-
-
-Call a procedure
-""""""""""""""""
-
-.. literalinclude:: examples/callProcedure.js
-   :language: javascript

package/docs/deprecated/iUserSpace.rst

@@ -1,38 +0,0 @@
-.. _iUserSpace:
-
-iUserSpace
-----------
-
-.. autoclass:: iUserSpace
-   :members:
-
-.. autofunction:: createUserSpaceCallback
-.. autofunction:: setUserSpaceDataCallback
-.. autofunction:: getUserSpaceDataCallback
-.. autofunction:: deleteUserSpaceCallback
-
-Examples
-^^^^^^^^
-
-Create a new user space
-"""""""""""""""""""""""
-
-.. literalinclude:: examples/createUserSpace.js
-   :language: javascript
-
-Set the content of the user space
-"""""""""""""""""""""""""""""""""
-.. literalinclude:: examples/setUserSpaceData.js
-   :language: javascript
-
-Retrieve the content of the user space
-""""""""""""""""""""""""""""""""""""""
-
-.. literalinclude:: examples/getUserSpaceData.js
-   :language: javascript
-
-Delete the user space
-"""""""""""""""""""""
-
-.. literalinclude:: examples/deleteUserSpace.js
-   :language: javascript

package/docs/deprecated/iWork.rst

@@ -1,58 +0,0 @@
-.. _iWork:
-
-iWork
------
-
-.. autoclass:: iWork
-   :members:
-
-.. autofunction:: getSysValueCallback
-.. autofunction:: getSysStatusCallback
-.. autofunction:: getSysStatusOutput
-.. autofunction:: getSysStatusExtCallback
-.. autofunction:: getSysStatusExtOutput
-.. autofunction:: getJobStatusCallback
-.. autofunction:: getJobStatusOutput
-.. autofunction:: getJobInfoCallback
-.. autofunction:: getJobInfoOutput
-.. autofunction:: getDataAreaCallback
-.. autofunction:: getDataAreaOutput
-
-Examples
-^^^^^^^^
-
-Retrieve a system value
-"""""""""""""""""""""""
-
-.. literalinclude:: examples/getSysValue.js
-   :language: javascript
-
-Retrieve basic system status
-""""""""""""""""""""""""""""
-
-.. literalinclude:: examples/getSysStatus.js
-   :language: javascript
-
-Retrieve extended system status
-"""""""""""""""""""""""""""""""
-
-.. literalinclude:: examples/getSysStatusExt.js
-   :language: javascript
-
-Retrieve job status
-"""""""""""""""""""
-
-.. literalinclude:: examples/getJobStatus.js
-   :language: javascript
-
-Retrieve job info
-"""""""""""""""""
-
-.. literalinclude:: examples/getJobInfo.js
-   :language: javascript
-
-Retrieve the contents of a data area
-"""""""""""""""""""""""""""""""""""""
-
-.. literalinclude:: examples/getDataArea.js
-   :language: javascript

package/docs/deprecated.rst

@@ -1,21 +0,0 @@
-.. _deprecated:
-
-
-Deprecated Classes and Functions
-================================
-
-.. toctree::
-   :maxdepth: 1
-   
-   deprecated/iConn
-   deprecated/iCmd
-   deprecated/iDataQueue
-   deprecated/iNetwork
-   deprecated/iObj
-   deprecated/iPgm
-   deprecated/iProd
-   deprecated/iQsh
-   deprecated/iSh
-   deprecated/iSql
-   deprecated/iUserSpace
-   deprecated/iWork

package/docs/examples/cosine.js

@@ -1,27 +0,0 @@
-const { Connection, ProgramCall } = require('itoolkit');
-const { parseString } = require('xml2js');
-
-const conn = new Connection({
-  transport: 'ssh',
-  transportOptions: { host: 'myhost', username: 'myuser', password: 'mypassword' },
-});
-
-const program = new ProgramCall('QC2UTIL2', { lib: 'QSYS', func: 'cos' });
-
-program.addParam({ type: '8f', value: '0' });
-program.addReturn({ type: '8f', value: '' });
-
-conn.add(program);
-conn.debug(true);
-
-conn.run((error, xmlOutput) => {
-  if (error) {
-    throw error;
-  }
-  parseString(xmlOutput, (parseError, result) => {
-    if (parseError) {
-      throw parseError;
-    }
-    console.log(result.myscript.pgm[0].return[0].data[0]._); // 1
-  });
-});

package/docs/examples/qusrobjd.js

@@ -1,80 +0,0 @@
-const { Connection, ProgramCall } = require('itoolkit');
-const { parseString } = require('xml2js');
-
-const conn = new Connection({
-  transport: 'ssh',
-  transportOptions: { host: 'myhost', username: 'myuser', password: 'mypassword' },
-});
-
-const receiver = {
-  name: 'receiver',
-  type: 'ds',
-  io: 'out',
-  len: 'rec1',
-  fields: [
-    { name: 'bytes_returned', type: '10i0', value: '0' },
-    { name: 'bytes_available', type: '10i0', value: '0' },
-    { name: 'object_name', type: '10A', value: '' },
-    { name: 'object_library_name', type: '10A', value: '' },
-    { name: 'object_type', type: '10A', value: '' },
-    { name: 'return_library', type: '10A', value: '0' },
-    { name: 'storage_pool_number', type: '10i0', value: '0' },
-    { name: 'object_owner', type: '10A', value: '' },
-    { name: 'object_domain', type: '2A', value: '' },
-    { name: 'creation_datetime', type: '13A', value: '' },
-    { name: 'object_change_datetime', type: '13A', value: '' },
-  ],
-};
-
-const errno = {
-  name: 'error_code',
-  type: 'ds',
-  io: 'both',
-  len: 'rec2',
-  fields: [
-    {
-      name: 'bytes_provided',
-      type: '10i0',
-      value: 0,
-      setlen: 'rec2',
-    },
-    { name: 'bytes_available', type: '10i0', value: 0 },
-    { name: 'msgid', type: '7A', value: '' },
-    { type: '1A', value: '' },
-  ],
-};
-
-const objectAndLibrary = {
-  type: 'ds',
-  fields: [
-    { name: 'object', type: '10A', value: 'QCSRC' },
-    { name: 'lib', type: '10A', value: '*LIBL' },
-  ],
-};
-
-const program = new ProgramCall('QUSROBJD', { lib: 'QSYS' });
-program.addParam(receiver);
-program.addParam({
-  name: 'length_of_receiver',
-  type: '10i0',
-  setlen: 'rec1',
-  value: '0',
-});
-program.addParam({ name: 'format_name', type: '8A', value: 'OBJD0100' });
-program.addParam(objectAndLibrary);
-program.addParam({ name: 'object_type', type: '10A', value: '*FILE' });
-program.addParam(errno);
-
-conn.add(program);
-
-conn.run((error, xmlOutput) => {
-  if (error) {
-    throw error;
-  }
-  parseString(xmlOutput, (parseError, result) => {
-    if (parseError) {
-      throw parseError;
-    }
-    console.log(JSON.stringify(result));
-  });
-});

package/docs/examples/rtvjoba.js

@@ -1,24 +0,0 @@
-const { Connection, CommandCall } = require('itoolkit');
-const { parseString } = require('xml2js');
-
-
-const connection = new Connection({
-  transport: 'ssh',
-  transportOptions: { host: 'myhost', username: 'myuser', password: 'mypassword' },
-});
-
-const command = new CommandCall({ type: 'cl', command: 'RTVJOBA USRLIBL(?) SYSLIBL(?)' });
-
-connection.add(command);
-
-connection.run((error, xmlOutput) => {
-  if (error) {
-    throw error;
-  }
-  parseString(xmlOutput, (parseError, result) => {
-    if (parseError) {
-      throw parseError;
-    }
-    console.log(JSON.stringify(result));
-  });
-});

package/docs/features.rst

@@ -1,12 +0,0 @@
-.. _features:
-
-
-Features
-========
-
-.. toctree::
-   :maxdepth: 1
-   
-   Connection
-   CommandCall
-   ProgramCall

package/docs/index.rst

@@ -1,71 +0,0 @@
-.. nodejs-itoolkit documentation master file, created by
-   sphinx-quickstart on Tue Mar 31 16:50:35 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to nodejs-itoolkit's documentation!
-===========================================
-
-Introduction
-============
-
-.. _XMLSERVICE: https://github.com/IBM/xmlservice#xmlservice
-
-``itoolkit`` is a Node.js interface to XMLSERVICE_ to access all things IBM i.
-
-XMLSERVICE provides interfaces to interact with IBM i resources such as programs and commands.
-
-XMLSERVICE receives xml input and returns xml output.
-
-For example we can execute a CL command by sending the following XML input to XMLSERVICE.
-
-.. code-block:: xml
-
-   <?xml version="1.0" encoding="UTF-8"?>
-   <myscript>
-      <cmd exec="rexx">RTVJOBA USRLIBL(?) SYSLIBL(?)</cmd>
-   </myscript>
-
-XMLSERVICE will run the command and respond with XML output.
-
-.. code-block:: xml
-
-   <?xml version="1.0" encoding="UTF-8"?>
-   <myscript>
-      <cmd exec="rexx">
-         <success>+++ success RTVJOBA USRLIBL(?) SYSLIBL(?)</success>
-         <row>
-            <data desc="USRLIBL">QGPL  QTEMP</data>
-         </row>
-         <row>
-            <data desc="SYSLIBL">QSYS  QSYS2  QHLPSYS  QUSRSYS</data>
-         </row>
-      </cmd>
-   </myscript>
-
-The purpose of this package is to simplify the process of creating XMLSERVICE input, invoking XMLSERVICE, and returning XMLSERVICE output from Node.js.
-
-Installation
-^^^^^^^^^^^^
-
-.. code-block:: bash
-
-   $ npm install itoolkit
-
-.. NOTE::
-   If you are upgrading from ``0.1.x`` be sure to read the :doc:`migration guide </migratation-guide-v1.0>`.
-
-.. toctree::
-   :maxdepth: 1
-   :caption: Contents:
-   
-   features
-   deprecated
-   migratation-guide-v1.0
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`