Merge branch 'main' of https://github.com/weaviate/typescript-client into 1.30/support-for-runtime-generate

Author: tsmith023

.github/workflows/main.yaml

@@ -30,7 +30,7 @@ jobs:
         npm run format:check
         npm run docs
 
-  tests:
+  tests-without-auth:
     needs: checks
     runs-on: ubuntu-latest
     strategy:
@@ -49,6 +49,37 @@ jobs:
         ]
     steps:
     - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.versions.node }}
+    - name: Login to Docker Hub
+      if: ${{ !github.event.pull_request.head.repo.fork && github.triggering_actor != 'dependabot[bot]' }}
+      uses: docker/login-action@v3
+      with:
+        username: ${{secrets.DOCKER_USERNAME}}
+        password: ${{secrets.DOCKER_PASSWORD}}
+    - name: "Install dependencies"
+      run: |
+        npm ci
+        ci/run_dependencies.sh ${{ matrix.versions.weaviate }}
+    - name: "Run tests without authentication tests"
+      run: WEAVIATE_VERSION=${{ matrix.versions.weaviate }} npm test
+    - name: "Transpile the package"
+      run: npm run build
+    - name: "Stop Weaviate"
+      run: ci/stop_dependencies.sh ${{ matrix.versions.weaviate }}
+
+  tests-with-auth:
+    needs: checks
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        versions: [
+          { node: "22.x", weaviate: $WEAVIATE_129}
+        ]
+    steps:
+    - uses: actions/checkout@v3
     - uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.versions.node }}
@@ -70,16 +101,11 @@ jobs:
         AZURE_CLIENT_SECRET: ${{ secrets.AZURE_CLIENT_SECRET }}
         OKTA_CLIENT_SECRET: ${{ secrets.OKTA_CLIENT_SECRET }}
       run: WEAVIATE_VERSION=${{ matrix.versions.weaviate }} npm test
-    - name: "Run tests without authentication tests (for forks)"
-      if: ${{ github.event.pull_request.head.repo.fork }}
-      run: WEAVIATE_VERSION=${{ matrix.versions.weaviate }} npm test
-    - name: "Transpile the package"
-      run: npm run build
     - name: "Stop Weaviate"
       run: ci/stop_dependencies.sh ${{ matrix.versions.weaviate }}
 
   publish:
-    needs: tests
+    needs: [tests-with-auth, tests-without-auth]
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
     runs-on: ubuntu-latest
     permissions:

src/openapi/schema.ts

@@ -231,7 +231,7 @@ export interface paths {
 }
 
 export interface definitions {
-  UserInfo: {
+  UserOwnInfo: {
     /** @description The groups associated to the user */
     groups?: string[];
     roles?: definitions['Role'][];
@@ -1615,7 +1615,7 @@ export interface operations {
     responses: {
       /** Info about the user */
       200: {
-        schema: definitions['UserInfo'];
+        schema: definitions['UserOwnInfo'];
       };
       /** Unauthorized or invalid credentials. */
       401: unknown;

src/openapi/types.ts

@@ -54,7 +54,7 @@ export type WeaviateMultiTenancyConfig = WeaviateClass['multiTenancyConfig'];
 export type WeaviateReplicationConfig = WeaviateClass['replicationConfig'];
 export type WeaviateShardingConfig = WeaviateClass['shardingConfig'];
 export type WeaviateShardStatus = definitions['ShardStatusGetResponse'];
-export type WeaviateUser = definitions['UserInfo'];
+export type WeaviateUser = definitions['UserOwnInfo'];
 export type WeaviateVectorIndexConfig = WeaviateClass['vectorIndexConfig'];
 export type WeaviateVectorsConfig = WeaviateClass['vectorConfig'];
 export type WeaviateVectorConfig = definitions['VectorConfig'];

src/roles/index.ts

@@ -10,6 +10,7 @@ import {
   PermissionsInput,
   Role,
   RolesPermission,
+  TenantsPermission,
   UsersPermission,
 } from './types.js';
 import { Map } from './util.js';
@@ -207,6 +208,23 @@ export const permissions = {
       return out;
     });
   },
+  tenants: (args: {
+    collection: string | string[];
+    create?: boolean;
+    read?: boolean;
+    update?: boolean;
+    delete?: boolean;
+  }): TenantsPermission[] => {
+    const collections = Array.isArray(args.collection) ? args.collection : [args.collection];
+    return collections.flatMap((collection) => {
+      const out: TenantsPermission = { collection, actions: [] };
+      if (args.create) out.actions.push('create_tenants');
+      if (args.read) out.actions.push('read_tenants');
+      if (args.update) out.actions.push('update_tenants');
+      if (args.delete) out.actions.push('delete_tenants');
+      return out;
+    });
+  },
   users: (args: {
     user: string | string[];
     assign_and_revoke?: boolean;

src/roles/integration.test.ts

@@ -58,6 +58,7 @@ only('Integration testing of the roles namespace', () => {
           dataPermissions: [],
           nodesPermissions: [],
           rolesPermissions: [],
+          tenantsPermissions: [],
           usersPermissions: [],
         },
       },
@@ -72,6 +73,7 @@ only('Integration testing of the roles namespace', () => {
           dataPermissions: [],
           nodesPermissions: [],
           rolesPermissions: [],
+          tenantsPermissions: [],
           usersPermissions: [],
         },
       },
@@ -97,6 +99,7 @@ only('Integration testing of the roles namespace', () => {
           dataPermissions: [],
           nodesPermissions: [],
           rolesPermissions: [],
+          tenantsPermissions: [],
           usersPermissions: [],
         },
       },
@@ -122,6 +125,7 @@ only('Integration testing of the roles namespace', () => {
           ],
           nodesPermissions: [],
           rolesPermissions: [],
+          tenantsPermissions: [],
           usersPermissions: [],
         },
       },
@@ -141,6 +145,7 @@ only('Integration testing of the roles namespace', () => {
             { collection: 'Some-collection', verbosity: 'verbose', actions: ['read_nodes'] },
           ],
           rolesPermissions: [],
+          tenantsPermissions: [],
           usersPermissions: [],
         },
       },
@@ -157,6 +162,7 @@ only('Integration testing of the roles namespace', () => {
           dataPermissions: [],
           nodesPermissions: [{ collection: '*', verbosity: 'minimal', actions: ['read_nodes'] }],
           rolesPermissions: [],
+          tenantsPermissions: [],
           usersPermissions: [],
         },
       },
@@ -179,6 +185,33 @@ only('Integration testing of the roles namespace', () => {
           rolesPermissions: [
             { role: 'some-role', actions: ['create_roles', 'read_roles', 'update_roles', 'delete_roles'] },
           ],
+          tenantsPermissions: [],
+          usersPermissions: [],
+        },
+      },
+      {
+        roleName: 'tenants',
+        permissions: weaviate.permissions.tenants({
+          collection: 'some-collection',
+          create: true,
+          read: true,
+          update: true,
+          delete: true,
+        }),
+        expected: {
+          name: 'tenants',
+          backupsPermissions: [],
+          clusterPermissions: [],
+          collectionsPermissions: [],
+          dataPermissions: [],
+          nodesPermissions: [],
+          rolesPermissions: [],
+          tenantsPermissions: [
+            {
+              collection: 'Some-collection',
+              actions: ['create_tenants', 'read_tenants', 'update_tenants', 'delete_tenants'],
+            },
+          ],
           usersPermissions: [],
         },
       },
@@ -197,6 +230,7 @@ only('Integration testing of the roles namespace', () => {
           dataPermissions: [],
           nodesPermissions: [],
           rolesPermissions: [],
+          tenantsPermissions: [],
           usersPermissions: [{ users: 'some-user', actions: ['assign_and_revoke_users', 'read_users'] }],
         },
       },
@@ -218,9 +252,17 @@ only('Integration testing of the roles namespace', () => {
 
   afterAll(() =>
     Promise.all(
-      ['backups', 'cluster', 'collections', 'data', 'nodes-verbose', 'nodes-minimal', 'roles', 'users'].map(
-        (n) => client.roles.delete(n)
-      )
+      [
+        'backups',
+        'cluster',
+        'collections',
+        'data',
+        'nodes-verbose',
+        'nodes-minimal',
+        'roles',
+        'tenants',
+        'users',
+      ].map((n) => client.roles.delete(n))
     )
   );
 });

src/roles/types.ts

@@ -16,6 +16,10 @@ export type DataAction = Extract<
 >;
 export type NodesAction = Extract<Action, 'read_nodes'>;
 export type RolesAction = Extract<Action, 'create_roles' | 'read_roles' | 'update_roles' | 'delete_roles'>;
+export type TenantsAction = Extract<
+  Action,
+  'create_tenants' | 'delete_tenants' | 'read_tenants' | 'update_tenants'
+>;
 export type UsersAction = Extract<Action, 'read_users' | 'assign_and_revoke_users'>;
 
 export type BackupsPermission = {
@@ -48,6 +52,11 @@ export type RolesPermission = {
   actions: RolesAction[];
 };
 
+export type TenantsPermission = {
+  collection: string;
+  actions: TenantsAction[];
+};
+
 export type UsersPermission = {
   users: string;
   actions: UsersAction[];
@@ -61,6 +70,7 @@ export type Role = {
   dataPermissions: DataPermission[];
   nodesPermissions: NodesPermission[];
   rolesPermissions: RolesPermission[];
+  tenantsPermissions: TenantsPermission[];
   usersPermissions: UsersPermission[];
 };
 
@@ -71,6 +81,7 @@ export type Permission =
   | DataPermission
   | NodesPermission
   | RolesPermission
+  | TenantsPermission
   | UsersPermission;
 
 export type PermissionsInput = Permission | Permission[] | Permission[][] | (Permission | Permission[])[];