Merge pull request #120 from graphistry/dev/orgs

Dev/orgs

CHANGELOG.md

@@ -3,12 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## Development
+## 4.6.0
 
 ### Added
 
 - **js-upload-api**: CommonJS support with output binaries at `dist/cjs`
 - **node-api**: CommonJS support with output binaries at `dist/cjs`
+- **all**: Optional orgs login
+
+### Docs
+
+- **all**: Arrow uploads and login modes
 
 ## 4.5.0 - 2023-03-23
 

lerna.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.6.0-alpha.1",
+  "version": "4.6.0",
   "packages": [
     "projects/client-api",
     "projects/client-api-react",

projects/client-api-react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphistry/client-api-react",
-  "version": "4.6.0-alpha.1",
+  "version": "4.6.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/graphistry/graphistry-js.git"
@@ -69,7 +69,7 @@
   "author": "Graphistry, Inc <https://graphistry.com>",
   "license": "ISC",
   "dependencies": {
-    "@graphistry/client-api": "^4.6.0-alpha.1",
+    "@graphistry/client-api": "^4.6.0",
     "crypto-browserify": "3.12.0",
     "prop-types": ">=15.6.0",
     "shallowequal": "1.1.0",

projects/client-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphistry/client-api",
-  "version": "4.6.0-alpha.1",
+  "version": "4.6.0",
   "description": "Client-side API for interacting with a Graphistry embedded visualization.",
   "jsnext:main": "dist/index.js",
   "config": {
@@ -85,7 +85,7 @@
     "@graphistry/falcor-json-graph": "^2.9.10",
     "@graphistry/falcor-model-rxjs": "2.11.0",
     "@graphistry/falcor-socket-datasource": "2.11.3",
-    "@graphistry/js-upload-api": "^4.6.0-alpha.1",
+    "@graphistry/js-upload-api": "^4.6.0",
     "shallowequal": "1.1.0"
   },
   "peerDependencies": {

projects/client-api/src/index.js

@@ -26,6 +26,7 @@ export class Client extends ClientBase {
      * @constructor
      * @param {string} username - Graphistry server username
      * @param {string} password - Graphistry server password
+     * @param {string} org - Graphistry organization (optional)
      * @param {string} [protocol='https'] - 'http' or 'https' for client->server upload communication
      * @param {string} [host='hub.graphistry.com'] - Graphistry server hostname
      * @param {clientProtocolHostname} clientProtocolHostname - Override URL base path shown in browsers. By default uses protocol/host combo, e.g., https://hub.graphistry.com
@@ -39,13 +40,16 @@ export class Client extends ClientBase {
      * ```
     */
     constructor(
-        username, password,
+        username, password, org = undefined,
         protocol = 'https', host = 'hub.graphistry.com',
         clientProtocolHostname,
         version
     ) {
         console.debug('new client', { username }, { password }, { protocol }, { host }, { clientProtocolHostname }, { version });
-        super(username, password, protocol, host, clientProtocolHostname, window.fetch.bind(window), version, '@graphistry/client-api');
+        super(
+            username, password, org,
+            protocol, host, clientProtocolHostname,
+            window.fetch.bind(window), version, '@graphistry/client-api');
     }
 }
 

projects/cra-template/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphistry/cra-template",
-  "version": "4.6.0-alpha.1",
+  "version": "4.6.0",
   "private": true,
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",

projects/cra-test-18/package.json

@@ -1,9 +1,9 @@
 {
   "name": "test18",
-  "version": "4.6.0-alpha.1",
+  "version": "4.6.0",
   "private": true,
   "dependencies": {
-    "@graphistry/client-api-react": "^4.6.0-alpha.1",
+    "@graphistry/client-api-react": "^4.6.0",
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^13.2.0",
     "@testing-library/user-event": "^13.5.0",

projects/cra-test/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@graphistry/client-react-app-cra-test",
-  "version": "4.6.0-alpha.1",
+  "version": "4.6.0",
   "private": true,
   "dependencies": {
     "@craco/craco": "^6.4.2",
-    "@graphistry/client-api-react": "^4.6.0-alpha.1",
+    "@graphistry/client-api-react": "^4.6.0",
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^12.1.5",
     "@testing-library/user-event": "^14.2.0",

projects/js-upload-api/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphistry/js-upload-api",
-  "version": "4.6.0-alpha.1",
+  "version": "4.6.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/graphistry/graphistry-js.git"

projects/js-upload-api/src/Client.ts

@@ -11,13 +11,21 @@
  * 
  * <br>
  *  
- * @example **Authenticate against Graphistry Hub**
+ * @example **Authenticate against Graphistry Hub for a personal account**
  * ```javascript
  * import { Client } from '@graphistry/node-api';
  * const client = new Client('my_username', 'my_password');
  * ```
  * 
  * <br>
+ *  
+ * @example **Authenticate against an org in Graphistry Hub**
+ * ```javascript
+ * import { Client } from '@graphistry/node-api';
+ * const client = new Client('my_username', 'my_password', 'my_org');
+ * ```
+ * 
+ * <br>
  * 
  * @example **Authenticate against a private Graphistry server**
  * ```javascript
@@ -66,6 +74,7 @@ export class Client {
     public readonly clientProtocolHostname: string;
     public readonly agent: string;
     public readonly version?: string;
+    public readonly org?: string;
 
 
     private _getAuthTokenPromise?: Promise<string>;  // undefined if not configured
@@ -80,12 +89,16 @@ export class Client {
      * 
      * @param username The username to authenticate with.
      * @param password The password to authenticate with.
+     * @param org The organization to use (optional)
      * @param protocol The protocol to use for the server during uploads: 'http' or 'https'.
      * @param host The hostname of the server during uploads: defaults to 'hub.graphistry.com'
      * @param clientProtocolHostname Base path to use inside the browser and when sharing public URLs: defaults to '{protocol}://{host}'
+     * @param fetch The fetch implementation to use
+     * @param version The version of the client library
+     * @param agent The agent name to use when communicating with the server
      */
     constructor (
-        username: string, password: string,
+        username: string, password: string, org?: string,
         protocol = 'https', host = 'hub.graphistry.com',
         clientProtocolHostname?: string,
         fetch?: any,  // eslint-disable-line @typescript-eslint/no-explicit-any
@@ -94,6 +107,7 @@ export class Client {
     ) {
         this.username = username;
         this._password = password;
+        this.org = org;
         this.protocol = protocol;
         this.host = host;
         this.fetch = fetch;
@@ -201,7 +215,11 @@ export class Client {
 
         const response = await this.postToApi(
             'api/v2/auth/token/generate',
-            { username: this.username, password: this._password },
+            {
+                username: this.username,
+                password: this._password,
+                ...(this.org ? {org_name: this.org} : {}),
+            },
             this.getBaseHeaders(),
         )
 

projects/js-upload-api/src/Dataset.ts

@@ -56,6 +56,20 @@ import { Mode, ModeAction, Privacy } from './Privacy.js';
  * 
  * <br>
  * 
+ * @example **Create a dataset using Arrow**
+ * ```javascript
+ * import { tableFromArrays, tableToIPC, Table } from 'apache-arrow';
+ * import { EdgeFile } from '@graphistry/node-api';
+ * 
+ * //columnar data is fastest; column per attribute; reuse across datasets
+ * const edgesJSON = {'s': ['a1', 'b2'], 'd': ['b2', 'c3']};
+ * const edgesTable: Table = tableFromArrays(edgesJSON);
+ * const edgesUint8: Uint8Array = tableToIPC(edgesArr, 'file');
+ * const edgesFile = new EdgeFile(edgesUint8, 'arrow');
+ * ```
+ * 
+ * <br>
+ * 
  * @example **Add files after the Dataset is instantiated but before it has been uploaded**
  * ```javascript
  * import { Dataset } from '@graphistry/node-api';
@@ -315,7 +329,11 @@ export class Dataset {
             node_files: this.nodeFiles.map((file) => file.fileID),
             edge_files: this.edgeFiles.map((file) => file.fileID),
         };
-        const bindings = { ...fileBindings, ...this.bindings };
+        const bindings = { 
+            ...(client.org ? { org_name: client.org } : {}),
+            ...fileBindings,
+            ...this.bindings
+        };
         await this.createDataset(client, bindings);
 
         return this;

projects/js-upload-api/src/File.ts

@@ -249,7 +249,13 @@ export class File {
         }
         console.debug('Creating file');
 
-        const fileJsonResults = await client.post('api/v2/files/', {file_type: this.fileFormat, ...this.createOpts});
+        const fileJsonResults = await client.post(
+            'api/v2/files/',
+            {
+                file_type: this.fileFormat,
+                ...(client.org ? { org_name: client.org } : {}),
+                ...this.createOpts
+            });
         console.debug('File creation response:', fileJsonResults);
         this._fileCreateResponse = fileJsonResults;
         this._fileID = fileJsonResults.file_id;

projects/node-api-test-cjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphistry/node-api-test-cjs",
-  "version": "4.6.0-alpha.1",
+  "version": "4.6.0",
   "description": "",
   "main": "src/index.js",
   "type": "commonjs",
@@ -16,7 +16,7 @@
   "author": "Graphistry, Inc.",
   "license": "Apache-2.0",
   "dependencies": {
-    "@graphistry/node-api": "^4.6.0-alpha.1",
+    "@graphistry/node-api": "^4.6.0",
     "apache-arrow": "^11.0.0"
   }
 }

projects/node-api-test-cjs/src/index.js

@@ -37,6 +37,8 @@ if (!user) { throw new Error('GRAPHISTRY_USER environment variable not set'); }
 const password = process.env.GRAPHISTRY_PASSWORD;
 if (!password) { throw new Error('GRAPHISTRY_PASSWORD environment variable not set'); }
 
+const org = process.env.GRAPHISTRY_ORG;
+
 const protocol = process.env.GRAPHISTRY_PROTOCOL || 'https';
 const host = process.env.GRAPHISTRY_HOST || 'hub.graphistry.com';
 
@@ -48,7 +50,7 @@ async function go() {
 
 if (false) {
 
-    const client = new Client(user, password, protocol, host);
+    const client = new Client(user, password, org, protocol, host);
 
     const edgesFile = new EdgeFile(edges);
     const nodesFile = new NodeFile(nodes);  // optional
@@ -67,7 +69,7 @@ if (false) {
 
 } else if (false) {
 
-    const client = new Client(user, password, protocol, host);
+    const client = new Client(user, password, org, protocol, host);
 
     const edgesFile = new EdgeFile(edges);
     const nodesFile = new NodeFile(nodes);  // optional
@@ -85,7 +87,7 @@ if (false) {
 
 } else if (false) {
 
-    const client = new Client(user, password, protocol, host);
+    const client = new Client(user, password, org, protocol, host);
 
     const edgesFile = new EdgeFile(
         edgesRows,
@@ -186,7 +188,7 @@ if (false) {
 
 } else if (false) {
 
-    const client = new Client(user, password, protocol, host);
+    const client = new Client(user, password, org, protocol, host);
     const edgesFile = new EdgeFile(edges);
     const nodesFile = new NodeFile(nodes);  // optional
 
@@ -210,7 +212,7 @@ if (false) {
     //convert edges to apache-arrow table
     const edgesArr = tableFromArrays(edges);
     const nodesArr = tableFromArrays(nodes);
-    const client = new Client(user, password, protocol, host);
+    const client = new Client(user, password, org, protocol, host);
 
     function arrToUint8Array(arr) {
         const ui8 = tableToIPC(arr, 'file');
@@ -237,7 +239,7 @@ if (false) {
     //convert edges to apache-arrow table
     const edgesArr = tableFromArrays(edges);
     const nodesArr = tableFromArrays(nodes);
-    const client = new Client(user, password, protocol, host);
+    const client = new Client(user, password, org, protocol, host);
 
     function arrToUint8Array(arr) {
         const ui8 = tableToIPC(arr, 'file');