Last-minute 1.5 changes (#72)

* fxied *Namespace commands in DataAPIDbAdmin

* deprecate bulkWrite

* deprecate db.collections()

* add warnings to events

* documented FetchH2 & FetchNative + udpated build report

* added some missing docuemntation

* changed scripts to use "/usr/bin/env sh"

* added -stargate option to tests

* added tests for legacy namespace admin fucntions

* made all tags "NOT-"-able

Author: toptobes

eslint.config.mjs

@@ -36,7 +36,7 @@ export default [
 
       parserOptions: {
         project: ['./tsconfig.json'],
-        tsconfigRootDir: '/home/me/work/astra-db-ts',
+        tsconfigRootDir: __dirname,
       },
     },
 

etc/astra-db-ts.api.md

@@ -56,9 +56,10 @@ export class AdminCommandStartedEvent extends AdminCommandEvent {
 // @public
 export class AdminCommandSucceededEvent extends AdminCommandEvent {
     // @internal
-    constructor(info: DevOpsAPIRequestInfo, longRunning: boolean, data: Record<string, any> | undefined, started: number);
+    constructor(info: DevOpsAPIRequestInfo, longRunning: boolean, data: Record<string, any> | undefined, warnings: string[], started: number);
     readonly duration: number;
     readonly resBody?: Record<string, any>;
+    readonly warnings: string[];
 }
 
 // @public
@@ -187,6 +188,7 @@ export class Collection<Schema extends SomeDoc = SomeDoc> {
     //
     // @internal
     constructor(db: Db, httpClient: DataAPIHttpClient, name: string, opts: CollectionSpawnOptions | undefined);
+    // @deprecated
     bulkWrite(operations: AnyBulkWriteOperation<Schema>[], options?: BulkWriteOptions): Promise<BulkWriteResult<Schema>>;
     readonly collectionName: string;
     countDocuments(filter: Filter<Schema>, upperBound: number, options?: WithTimeout): Promise<number>;
@@ -294,9 +296,10 @@ export class CommandStartedEvent extends CommandEvent {
 // @public
 export class CommandSucceededEvent extends CommandEvent {
     // @internal
-    constructor(info: DataAPIRequestInfo, reply: RawDataAPIResponse, started: number);
+    constructor(info: DataAPIRequestInfo, reply: RawDataAPIResponse, warnings: string[], started: number);
     readonly duration: number;
     readonly resp?: RawDataAPIResponse;
+    readonly warnings: string[];
 }
 
 // @public
@@ -566,6 +569,7 @@ export class Db {
         environment: Exclude<DataAPIEnvironment, 'astra'>;
     }): DataAPIDbAdmin;
     collection<Schema extends SomeDoc = SomeDoc>(name: string, options?: CollectionSpawnOptions): Collection<Schema>;
+    // @deprecated
     collections(options?: WithKeyspace & WithTimeout): Promise<Collection[]>;
     command(command: Record<string, any>, options?: RunCommandOptions): Promise<RawDataAPIResponse>;
     createCollection<Schema extends SomeDoc = SomeDoc>(collectionName: string, options?: CreateCollectionOptions<Schema>): Promise<Collection<Schema>>;
@@ -619,6 +623,9 @@ export interface DbSpawnOptions {
     token?: string | TokenProvider | null;
 }
 
+// @public
+export const DEFAULT_KEYSPACE = "default_keyspace";
+
 // @public
 export interface DefaultHttpClientOptions {
     client?: 'default';
@@ -799,12 +806,25 @@ export interface FetcherResponseInfo {
     url: string;
 }
 
+// @public
+export class FetchH2 implements Fetcher {
+    constructor(options: DefaultHttpClientOptions | undefined, preferHttp2: boolean);
+    close(): Promise<void>;
+    fetch(info: FetcherRequestInfo): Promise<FetcherResponseInfo>;
+}
+
 // @public
 export interface FetchHttpClientOptions {
     client: 'fetch';
     maxTimeMS?: number;
 }
 
+// @public
+export class FetchNative implements Fetcher {
+    close(): Promise<void>;
+    fetch(info: FetcherRequestInfo): Promise<FetcherResponseInfo>;
+}
+
 // @public
 export type Filter<Schema extends SomeDoc> = {
     [K in keyof NoId<Schema>]?: FilterExpr<NoId<Schema>[K]>;

scripts/build.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/sh
+#!/usr/bin/env sh
 
 # Cleans the previous build
 rm -rf ./dist

scripts/check-licensing.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/sh
+#!/usr/bin/env sh
 
 # Lists out all the files which don't contain the necessary license notice
 find tests/ src/ -type f -exec grep -L "^// Copyright DataStax, Inc." {} +

scripts/list-embedding-providers.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/sh
+#!/usr/bin/env sh
 
 # Errors on using unbound variables
 set -u

scripts/repl.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/sh
+#!/usr/bin/env sh
 
 # Properly sources the .env file to bring env variables into scope
 if [ -f .env ]; then

scripts/start-stargate-4-tests.sh

@@ -1,9 +1,3 @@
-#!/usr/bin/sh
-
-echo "Copy paste the following into your .env file:"
-echo "CLIENT_DB_URL=http://localhost:8181"
-echo "CLIENT_DB_TOKEN=Cassandra:Y2Fzc2FuZHJh:Y2Fzc2FuZHJh"
-echo "CLIENT_DB_ENVIRONMENT=dse"
-echo
+#!/usr/bin/env sh
 
 docker-compose -f scripts/utils/docker-compose-stargate.yml up

scripts/test.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/sh
+#!/usr/bin/env sh
 
 # Properly sources the .env file to bring env variables into scope
 if [ -f .env ]; then
@@ -80,11 +80,14 @@ while [ $# -gt 0 ]; do
       shift
       environment="$1"
       ;;
+    "-stargate")
+      stargate=1
+      ;;
     *)
       echo "Invalid flag $1"
       echo ""
       echo "Usage:"
-      echo "scripts/test.sh [-all | -light | -coverage] [-fand | -for] [-f/F <filter>]+ [-g/G <regex>]+ [-w/W <vectorize_whitelist>] [-b | -bail] [-R | -no-report] [-c <http_client>] [-e <environment>]"
+      echo "scripts/test.sh [-all | -light | -coverage] [-for] [-f/F <filter>]+ [-g/G <regex>]+ [-w/W <vectorize_whitelist>] [-b | -bail] [-R | -no-report] [-c <http_client>] [-e <environment>] [-stargate]"
       echo "or"
       echo "scripts/test.sh [-lint] [-tc]"
       exit
@@ -159,6 +162,10 @@ if [ -n "$environment" ]; then
   export CLIENT_DB_ENVIRONMENT="$environment"
 fi
 
+if [ -n "$stargate" ]; then
+  export USING_LOCAL_STARGATE=1
+fi
+
 # Get embedding providers, if desired, to build the vectorize part of the command
 if [ -n "$CLIENT_RUN_VECTORIZE_TESTS" ] && [ "$test_type" != 'code' ]; then
   CLIENT_VECTORIZE_PROVIDERS=$(bash scripts/list-embedding-providers.sh | jq -c)

scripts/update-example-client-dep.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/sh
+#!/usr/bin/env sh
 
 # Convenience script which auto-updates the `astra-db-ts` dependencies in all of the examples/ to use either:
 # - the local astra-db-ts for testing purposes (which should always be reverted before merging)

scripts/utils/docker-compose-stargate.yml

@@ -2,7 +2,7 @@ version: '2'
 
 services:
   coordinator:
-    image: stargateio/coordinator-dse-next:v2.1.0-BETA-12
+    image: stargateio/coordinator-dse-next:v2.1.0-BETA-16
     networks:
       - stargate
     ports:
@@ -24,7 +24,7 @@ services:
       retries: 10
 
   data-api:
-    image: stargateio/data-api:v1.0.14
+    image: stargateio/data-api:v1
     depends_on:
       coordinator:
         condition: service_healthy