Collections v3 client

.eslintignore

@@ -1,3 +1,4 @@
 node_modules
 dist
 types
+docs

.eslintrc.js → .eslintrc.cjs

@@ -110,7 +110,7 @@ module.exports = {
     'no-native-reassign': 'error',
     'no-negated-condition': 'off',
     'no-negated-in-lhs': 'error',
-    'no-nested-ternary': 'error',
+    'no-nested-ternary': 'off',
     'no-new': 'error',
     'no-new-func': 'error',
     'no-new-object': 'error',

.github/workflows/main.yaml

@@ -6,23 +6,32 @@ on:
       - '**'
   pull_request:
 
-
 env:
-  WEAVIATE_VERSION: 1.25.1
+  WEAVIATE_124: 1.24.19
+  WEAVIATE_125: 1.25.4
 
 jobs:
   checks:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [
+          "18.x",
+          "20.x",
+          "22.x"
+        ]
     steps:
     - uses: actions/checkout@v3
     - uses: actions/setup-node@v3
       with:
-        node-version: '18.x'
+        node-version: ${{ matrix.node }}
     - name: "Run checks"
       run: |
-        npm install
+        npm ci
         npm run lint
         npm run format:check
+        npm run docs
 
   tests:
     needs: checks
@@ -31,9 +40,12 @@ jobs:
       fail-fast: false
       matrix:
         versions: [
-          { node: "18.x", weaviate: $WEAVIATE_VERSION},
-          { node: "20.x", weaviate: $WEAVIATE_VERSION},
-          { node: "22.x", weaviate: $WEAVIATE_VERSION}
+          { node: "18.x", weaviate: $WEAVIATE_124},
+          { node: "20.x", weaviate: $WEAVIATE_124},
+          { node: "22.x", weaviate: $WEAVIATE_124},
+          { node: "18.x", weaviate: $WEAVIATE_125},
+          { node: "20.x", weaviate: $WEAVIATE_125},
+          { node: "22.x", weaviate: $WEAVIATE_125}
         ]
     steps:
     - uses: actions/checkout@v3
@@ -42,7 +54,7 @@ jobs:
         node-version: ${{ matrix.versions.node }}
     - name: "Install dependencies"
       run: |
-        npm install
+        npm ci
         ci/run_dependencies.sh ${{ matrix.versions.weaviate }}
     - name: "Run tests with authentication tests"
       if: ${{ !github.event.pull_request.head.repo.fork }}
@@ -66,19 +78,31 @@ jobs:
     needs: tests
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
     runs-on: ubuntu-latest
+    permissions:
+      contents: write   # to upload the release
+      pages: write      # to deploy to Pages
+      id-token: write   # to verify the deployment originates from an appropriate source
     steps:
       - uses: actions/checkout@v3
       # Setup .npmrc file to publish to npm
       - uses: actions/setup-node@v3
         with:
           node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
-      - run: npm ci && npm run build
+      - run: npm ci
+      - run: npm run build
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTOMATION_TOKEN }}
+      - run: npm run docs
+      - name: "Upload docs as pages artifact"
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs
+      - name: "Deploy the uploaded pages artifact"
+        uses: actions/deploy-pages@v4
       - name: "Create a GitHub release"
         uses: softprops/action-gh-release@v1
         with:
           generate_release_notes: true
-          draft: true
+          draft: true

.gitignore

@@ -10,4 +10,6 @@ weaviate-data/
 *.tgz
 .npmrc
 .eslintcache
-test.sh
+test.sh
+scratch/
+docs/

.prettierignore

@@ -0,0 +1,3 @@
+src/proto/**/*.ts
+src/dist/**/*
+src/docs/**/*.js

.prettierrc

@@ -4,5 +4,6 @@
   "trailingComma": "es5",
   "bracketSpacing": true,
   "singleQuote": true,
-  "printWidth": 110
+  "printWidth": 110,
+  "tabWidth": 2
 }

README.md

@@ -1,10 +1,11 @@
-# Weaviate TypeScript client <img alt='Weaviate logo' src='https://weaviate.io/img/site/weaviate-logo-light.png' width='148' align='right' />
+# Weaviate JS/TS client <img alt='Weaviate logo' src='https://weaviate.io/img/site/weaviate-logo-light.png' width='148' align='right' />
 
-Official TypeScript client for easy interaction with a Weaviate instance.
+Official JS/TS client for easy interaction with a Weaviate instance.
 
 ## Documentation
 
-- [Documentation](https://weaviate.io/developers/weaviate/client-libraries/typescript).
+- [General Documentation](https://weaviate.io/developers/weaviate/client-libraries/typescript).
+- [Client-specific Documentation](https://weaviate.github.io/typescript-client/)
 
 ## Support
 

ci/compose.sh

@@ -8,7 +8,7 @@ function ls_compose {
 
 function exec_all {
   for file in $(ls_compose); do
-    docker-compose -f $(echo "ci/${file} ${1}")
+    docker compose -f $(echo "ci/${file} ${1}")
   done
 }
 
@@ -21,5 +21,5 @@ function compose_down_all {
 }
 
 function all_weaviate_ports {
-  echo "8080 8081 8082 8083 8085 8086 8087 8088"
+  echo "8078 8079 8080 8081 8082 8083 8085 8086 8087 8088 8089 8090"
 }

ci/docker-compose-async.yml

@@ -0,0 +1,23 @@
+---
+version: '3.4'
+services:
+  weaviate_async:
+    command:
+      - --host
+      - 0.0.0.0
+      - --port
+      - '8090'
+      - --scheme
+      - http
+    image: semitechnologies/weaviate:${WEAVIATE_VERSION}
+    ports:
+      - "8078:8090"
+      - "50049:50051"
+    restart: on-failure:0
+    environment:
+      QUERY_DEFAULTS_LIMIT: 25
+      AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: 'true'
+      PERSISTENCE_DATA_PATH: '/var/lib/weaviate'
+      CLUSTER_HOSTNAME: 'node1'
+      ASYNC_INDEXING: 'true'
+      DISABLE_TELEMETRY: 'true'

ci/docker-compose-backup.yml

@@ -0,0 +1,19 @@
+---
+version: '3.4'
+services:
+  weaviate-backup:
+    image: semitechnologies/weaviate:${WEAVIATE_VERSION}
+    restart: on-failure:0
+    ports:
+      - 8090:8080
+      - 50061:50051
+    environment:
+      QUERY_DEFAULTS_LIMIT: 20
+      AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: 'true'
+      PERSISTENCE_DATA_PATH: "./weaviate-data"
+      BACKUP_FILESYSTEM_PATH: "/tmp/backups"
+      ENABLE_MODULES: backup-filesystem
+      CLUSTER_GOSSIP_BIND_PORT: "7100"
+      CLUSTER_DATA_BIND_PORT: "7101"
+      DISABLE_TELEMETRY: 'true'
+...

ci/docker-compose-cluster.yml

@@ -86,4 +86,4 @@ services:
       CONTEXTIONARY_URL: contextionary:9999
       DEFAULT_VECTORIZER_MODULE: text2vec-contextionary
       ENABLE_MODULES: text2vec-contextionary
-...
+...

ci/docker-compose-openai.yml

@@ -12,6 +12,7 @@ services:
     image: semitechnologies/weaviate:${WEAVIATE_VERSION}
     ports:
       - 8086:8086
+      - 50057:50051
     restart: on-failure:0
     environment:
       QUERY_DEFAULTS_LIMIT: 25

ci/docker-compose-proxy.yml

@@ -0,0 +1,53 @@
+---
+version: '3.4'
+services:
+  weaviate-proxy:
+    command:
+      - --host
+      - 0.0.0.0
+      - --port
+      - '8020'
+      - --scheme
+      - http
+      - --write-timeout=600s
+    image: semitechnologies/weaviate:${WEAVIATE_VERSION}
+    restart: on-failure:0
+    environment:
+      CONTEXTIONARY_URL: contextionary:9999
+      QUERY_DEFAULTS_LIMIT: 25
+      AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: 'true'
+      PERSISTENCE_DATA_PATH: '/var/lib/weaviate'
+      DEFAULT_VECTORIZER_MODULE: 'text2vec-contextionary'
+      ENABLE_MODULES: text2vec-contextionary
+      BACKUP_FILESYSTEM_PATH: "/tmp/backups"
+      CLUSTER_GOSSIP_BIND_PORT: "7100"
+      CLUSTER_DATA_BIND_PORT: "7101"
+      CLUSTER_HOSTNAME: "node1"
+      AUTOSCHEMA_ENABLED: 'false'
+      DISABLE_TELEMETRY: 'true'
+      GRPC_PORT: 8021
+  contextionary:
+    environment:
+      OCCURRENCE_WEIGHT_LINEAR_FACTOR: 0.75
+      EXTENSIONS_STORAGE_MODE: weaviate
+      EXTENSIONS_STORAGE_ORIGIN: http://weaviate-proxy:8020
+      NEIGHBOR_OCCURRENCE_IGNORE_PERCENTILE: 5
+      ENABLE_COMPOUND_SPLITTING: 'false'
+    image: semitechnologies/contextionary:en0.16.0-v1.2.0
+    ports:
+      - 9999:9999
+  proxy-http:
+    image: envoyproxy/envoy:v1.29-latest
+    command: envoy --config-path /etc/envoy/http.yaml
+    ports:
+      - 10000:10000
+    volumes:
+      - ./proxy:/etc/envoy
+  proxy-grpc:
+    image: envoyproxy/envoy:v1.29-latest
+    command: envoy --config-path /etc/envoy/grpc.yaml
+    ports:
+      - 10001:10000
+    volumes:
+      - ./proxy:/etc/envoy
+...

ci/docker-compose-rerank.yml

@@ -0,0 +1,30 @@
+---
+version: '3.4'
+services:
+  weaviate-reranker:
+    command:
+    - --host
+    - 0.0.0.0
+    - --port
+    - '8080'
+    - --scheme
+    - http
+    image: semitechnologies/weaviate:${WEAVIATE_VERSION}
+    ports:
+    - 8079:8080
+    - 50050:50051
+    restart: on-failure:0
+    environment:
+      RERANKER_INFERENCE_API: http://reranker-transformers:8080
+      QUERY_DEFAULTS_LIMIT: 25
+      AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: 'true'
+      PERSISTENCE_DATA_PATH: "./data"
+      DEFAULT_VECTORIZER_MODULE: 'text2vec-openai'
+      ENABLE_MODULES: 'text2vec-openai,reranker-transformers,generative-openai'
+      CLUSTER_HOSTNAME: 'node1'
+      DISABLE_TELEMETRY: 'true'
+  reranker-transformers:
+    image: semitechnologies/reranker-transformers:cross-encoder-ms-marco-MiniLM-L-6-v2
+    environment:
+      ENABLE_CUDA: '0'
+...

ci/docker-compose.yml

@@ -2,29 +2,43 @@
 version: '3.4'
 services:
   weaviate:
+    command:
+      - --host
+      - 0.0.0.0
+      - --port
+      - '8080'
+      - --scheme
+      - http
+      - --write-timeout=600s
     image: semitechnologies/weaviate:${WEAVIATE_VERSION}
-    restart: on-failure:0
     ports:
       - "8080:8080"
+      - "50051:50051"
+    restart: on-failure:0
     environment:
       CONTEXTIONARY_URL: contextionary:9999
-      QUERY_DEFAULTS_LIMIT: 20
+      QUERY_DEFAULTS_LIMIT: 25
       AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED: 'true'
-      PERSISTENCE_DATA_PATH: "./weaviate-data"
-      DEFAULT_VECTORIZER_MODULE: text2vec-contextionary
-      ENABLE_MODULES: text2vec-contextionary,backup-filesystem
+      PERSISTENCE_DATA_PATH: '/var/lib/weaviate'
+      DEFAULT_VECTORIZER_MODULE: 'text2vec-contextionary'
+      ENABLE_MODULES: text2vec-contextionary,backup-filesystem,img2vec-neural
       BACKUP_FILESYSTEM_PATH: "/tmp/backups"
       CLUSTER_GOSSIP_BIND_PORT: "7100"
       CLUSTER_DATA_BIND_PORT: "7101"
+      CLUSTER_HOSTNAME: "node1"
+      AUTOSCHEMA_ENABLED: 'false'
+      IMAGE_INFERENCE_API: "http://i2v-neural:8080"
       DISABLE_TELEMETRY: 'true'
   contextionary:
-    image: semitechnologies/contextionary:en0.16.0-v1.2.1
-    ports:
-      - "9999:9999"
     environment:
       OCCURRENCE_WEIGHT_LINEAR_FACTOR: 0.75
       EXTENSIONS_STORAGE_MODE: weaviate
       EXTENSIONS_STORAGE_ORIGIN: http://weaviate:8080
       NEIGHBOR_OCCURRENCE_IGNORE_PERCENTILE: 5
       ENABLE_COMPOUND_SPLITTING: 'false'
+    image: semitechnologies/contextionary:en0.16.0-v1.2.0
+    ports:
+      - 9999:9999
+  i2v-neural:
+    image: semitechnologies/img2vec-pytorch:resnet50
 ...