improve namespace exports (#66)

* improve namespace exports

* renamings for better type exports

package.json

@@ -18,7 +18,7 @@
     "test": "env-cmd --file .env uvu tests -r esbuild-register",
     "test:file": "env-cmd --file .env uvu -r esbuild-register tests",
     "test:embeddings": "npm run test:file -- embedding.test.js",
-    "build-types": "openapi-typescript https://api-atlas.nomic.ai/v1/api-reference/openapi.json -o ./src/type-gen/openapi.d.ts",
+    "build-types": "openapi-typescript https://api-atlas.nomic.ai/v1/api-reference/openapi.json -o ./src/type-gen/openapi.ts",
     "build": "tsc",
     "build:watch": "tsc -w",
     "insert-version": "node -e \"const fs = require('fs'); const pkg = require('./package.json'); fs.writeFileSync('./src/version.ts', 'export const version = \\'' + pkg.version + '\\';');\"",

src/global.ts

@@ -0,0 +1,83 @@
+export type UUID = string;
+export type LoadProjectOptions = {
+  project_id: UUID;
+};
+
+/**
+ * Options for the nearest neighbors query.
+ */
+export type NNOptions = {
+  /**
+   * The datum_ids (i.e., user-specified keys) to query for.
+   */
+  datum_ids?: string[];
+  /**
+   * The Atom IDs (Nomic-generated integers) to query for.
+   */
+  atom_ids?: string[];
+  /**
+   * The number of nearest neighbors to return.
+   */
+  k?: number;
+};
+
+export type ProjectInitOptions = {
+  project_name: string;
+  organization_name?: string;
+  organization_id?: UUID;
+  unique_id_field: string;
+  modality: 'text' | 'embedding';
+};
+export type ProjectionInfo = {
+  id: UUID;
+  ready: boolean;
+  created_timestamp: string;
+};
+export type IndexInfo = {
+  id: UUID;
+  projections: ProjectionInfo[];
+};
+export type Payload = Record<string, any> | Uint8Array | null;
+export type AtlasUser = {};
+
+export type Envlogin = {
+  useEnvToken: true;
+  apiLocation?: never;
+  apiKey?: never;
+  bearerToken?: never;
+};
+export type ApiKeyLogin = {
+  useEnvToken?: never;
+  apiLocation?: string;
+  apiKey: string;
+  bearerToken?: never;
+};
+export type BearerTokenLogin = {
+  useEnvToken?: never;
+  bearerToken: string;
+  apiLocation?: string;
+  apiKey?: never;
+};
+export type AnonViewerLogin = {
+  useEnvToken?: never;
+  bearerToken?: never;
+  apiLocation?: string;
+  apiKey?: never;
+};
+export type LoginParams =
+  | Envlogin
+  | ApiKeyLogin
+  | BearerTokenLogin
+  | AnonViewerLogin;
+
+export type ApiCallOptions = {
+  octetStreamAsUint8?: boolean;
+};
+
+export type TokenRefreshResponse = any;
+
+export interface Credentials {
+  refresh_token: string | null;
+  token: string;
+  expires: number;
+}

src/index.ts

@@ -5,6 +5,7 @@ import { AtlasDataset as AtlasDataset } from './project.js';
 import type { Table } from 'apache-arrow';
 import { AtlasViewer } from './viewer.js';
 import type { components } from './type-gen/openapi.js';
+import * as Atlas from './global.js';
 
 type IndexInitializationOptions = {
   project_id?: Atlas.UUID;
@@ -29,7 +30,8 @@ export class AtlasIndex extends BaseAtlasClass<{}> {
       throw new Error('project_id or project is required');
     }
     this.project =
-      options.project || new AtlasDataset(options.project_id as string, user);
+      options.project ||
+      new AtlasDataset(options.project_id as string, this.viewer);
     this.id = id;
   }
 
@@ -74,11 +76,10 @@ export class AtlasIndex extends BaseAtlasClass<{}> {
     if (this._projections) {
       return this._projections;
     } else {
-      const project_info =
-        (await this.project.fetchAttributes()) as Atlas.ProjectInfo;
+      const project_info = await this.project.fetchAttributes();
       const projections =
-        project_info.atlas_indices?.find((d) => d.id === this.id)
-          ?.projections || [];
+        project_info.atlas_indices.find((d) => d.id === this.id)?.projections ||
+        [];
       this._projections = projections.map(
         (d) =>
           new AtlasProjection(d.id as string, this.viewer, {

src/organization.ts

@@ -1,8 +1,11 @@
-import { AtlasUser, BaseAtlasClass, getEnvViewer } from './user.js';
+import { AtlasUser, BaseAtlasClass } from './user.js';
 import { AtlasDataset } from './project.js';
 import type { components } from './type-gen/openapi.js';
+import { AtlasViewer } from 'viewer.js';
+
 type UUID = string;
 
+// The response here depends on the authorization
 export type OrganizationInfo =
   | components['schemas']['PublicOrganizationResponse']
   | components['schemas']['Organization'];
@@ -16,8 +19,8 @@ type ProjectInitOptions = {
 export class AtlasOrganization extends BaseAtlasClass<OrganizationInfo> {
   id: UUID;
 
-  constructor(id: UUID, user?: AtlasUser) {
-    super(user);
+  constructor(id: UUID, viewer?: AtlasViewer) {
+    super(viewer);
     this.id = id;
   }
 

src/project.ts

@@ -1,8 +1,10 @@
 import type { Schema, Table } from 'apache-arrow';
 import { tableToIPC, tableFromJSON, tableFromIPC } from 'apache-arrow';
-import { AtlasUser, BaseAtlasClass } from './user.js';
+import { BaseAtlasClass } from './user.js';
 import { AtlasIndex } from './index.js';
 import { AtlasViewer } from './viewer.js';
+import * as Atlas from './global.js';
+import { components } from 'type-gen/openapi.js';
 // get the API key from the node environment
 type UUID = string;
 
@@ -16,11 +18,6 @@ type EmbeddingMatrix = Array<SingleEmbedding>;
 type TypedArrayEmbedding = Float32Array | Float64Array;
 type EmbeddingType = EmbeddingMatrix | TypedArrayEmbedding;
 
-interface AddDataOptions {
-  data: DataIngest;
-  embeddings?: EmbeddingType;
-}
-
 type IndexCreateOptions = {
   project_id: UUID;
   index_name: string;
@@ -60,7 +57,9 @@ type CreateAtlasIndexRequest = {
  * interfaces to upload, update, and delete data, as well as create and delete
  * indices which handle specific views.
  */
-export class AtlasDataset extends BaseAtlasClass<Atlas.ProjectInfo> {
+export class AtlasDataset extends BaseAtlasClass<
+  components['schemas']['Project']
+> {
   _indices: AtlasIndex[] = [];
   _schema?: Schema | null;
   id: UUID;
@@ -73,8 +72,8 @@ export class AtlasDataset extends BaseAtlasClass<Atlas.ProjectInfo> {
    *
    * @returns An AtlasDataset object.
    */
-  constructor(id: UUID | string, user?: AtlasUser | AtlasViewer) {
-    super(user);
+  constructor(id: UUID | string, viewer?: AtlasViewer) {
+    super(viewer);
     // check if id is a valid UUID
 
     const uuidPattern =
@@ -83,7 +82,7 @@ export class AtlasDataset extends BaseAtlasClass<Atlas.ProjectInfo> {
     if (!id.toLowerCase().match(uuidPattern)) {
       // throw new Error(`${id} is not a valid UUID.`);
       this.id = id;
-      this.fetchAttributes().then((i) => (this.id = i.project_id));
+      this.fetchAttributes().then((i) => (this.id = i.id));
     }
   }
 
@@ -132,7 +131,7 @@ export class AtlasDataset extends BaseAtlasClass<Atlas.ProjectInfo> {
         // Create a new project to clear the cache.
 
         const renewed = new AtlasDataset(this.id, this.viewer);
-        const info = (await renewed.fetchAttributes()) as Atlas.ProjectInfo;
+        const info = await renewed.fetchAttributes();
         if (info.insert_update_delete_lock === false) {
           clearInterval(interval);
           // Clear the cache.
@@ -151,8 +150,7 @@ export class AtlasDataset extends BaseAtlasClass<Atlas.ProjectInfo> {
     if (this._indices.length > 0) {
       return this._indices;
     }
-    const { atlas_indices } =
-      (await this.fetchAttributes()) as Atlas.ProjectInfo;
+    const { atlas_indices } = await this.fetchAttributes();
 
     if (atlas_indices === undefined) {
       return [];

src/user.ts

@@ -1,5 +1,6 @@
 import { AtlasViewer } from './viewer.js';
 import type { components } from './type-gen/openapi.js';
+import * as Atlas from './global.js';
 
 export const isNode =
   typeof process !== 'undefined' && process.versions && process.versions.node;
@@ -187,7 +188,7 @@ export class AtlasUser extends BaseAtlasClass<UserInfo> {
       (d) => d.AtlasOrganization
     );
     return organizations.map(
-      (org) => new AtlasOrganization(org.organization_id, this)
+      (org) => new AtlasOrganization(org.organization_id, this.viewer)
     );
   }
 }

src/viewer.ts

@@ -1,5 +1,6 @@
 import { Table, tableFromIPC } from 'apache-arrow';
-import { version } from './version';
+import { version } from './version.js';
+import * as Atlas from './global.js';
 
 export class AtlasViewer {
   /* 

tsconfig.json

@@ -20,5 +20,5 @@
     "strict": true,
     "declaration": true
   },
-  "include": ["global.d.ts", "src/global.d.ts", "src/**/*.ts"]
+  "include": ["src/global.d.ts", "src/**/*.ts"]
 }