@squidcloud/client 1.0.191 → 1.0.193

package/dist/cjs/index.js

@@ -29013,6 +29013,19 @@ function groupBy(array, getKey) {
         return result;
     }, {});
 }
+/**
+ * Picks selected fields from the object and returns a new object with the fields selected.
+ * The selected fields are assigned by reference (there is no cloning).
+ */
+function pick(obj, keys) {
+    const result = {};
+    for (const key of keys) {
+        if (key in obj) {
+            result[key] = obj[key];
+        }
+    }
+    return result;
+}
 
 ;// CONCATENATED MODULE: ../internal-common/src/utils/serialization.ts
 
@@ -29343,7 +29356,7 @@ const AI_MODEL_NAMES = [
     'gpt-3.5-turbo-1106',
     'gpt-4',
     'claude-2',
-    'gpt-4-1106-preview',
+    'gpt-4-turbo-preview',
 ];
 
 ;// CONCATENATED MODULE: ../internal-common/src/public-types/api-call.public-context.ts
@@ -30775,7 +30788,7 @@ class BaseQueryBuilder {
      * A shortcut for where(fieldName, 'like', pattern).
      *
      * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' matches 0 or more wildcard characters. '_' matches exactly one wildcard character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
+     * @param pattern The pattern to compare against. '%' matches 0 or more characters. '_' matches exactly one character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
      * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
      * @returns The query builder.
      */
@@ -30787,7 +30800,7 @@ class BaseQueryBuilder {
      * A shortcut for where(fieldName, 'not like', pattern).
      *
      * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' matches 0 or more wildcard characters. '_' matches exactly one wildcard character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
+     * @param pattern The pattern to compare against. '%' matches 0 or more characters. '_' matches exactly one character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
      * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
      * @returns The query builder.
      */
@@ -51233,43 +51246,82 @@ class StorageClient {
         this.integrationId = integrationId;
         this.rpcManager = rpcManager;
     }
-    async uploadFile(pathInBucket, file, expirationInSeconds) {
+    /**
+     * Uploads a file to a specified directory within the bucket.
+     *
+     * @param dirPathInBucket - The directory path within the bucket where the file should be uploaded.
+     * @param file - The file or blob (with filename) to upload.
+     * @param expirationInSeconds - Optional expiration time in seconds for the upload.
+     * @returns A promise that resolves to void when the upload is complete.
+     */
+    async uploadFile(dirPathInBucket, file, expirationInSeconds) {
         const request = {
             integrationId: this.integrationId,
-            pathInBucket,
+            pathInBucket: dirPathInBucket,
             expirationInSeconds,
         };
         await this.rpcManager.post('storage/uploadFile', request, [file]);
     }
-    async getFileMetadata(pathInBucket) {
+    /**
+     * Retrieves metadata for a file located in a specified path within the bucket.
+     *
+     * @param filePathInBucket - The path of the file within the bucket.
+     * @returns A promise that resolves to a `GetFileMetadataResponse` containing the file's metadata.
+     */
+    async getFileMetadata(filePathInBucket) {
         const request = {
             integrationId: this.integrationId,
-            pathInBucket,
+            pathInBucket: filePathInBucket,
         };
         return await this.rpcManager.post('storage/getFileMetadata', request);
     }
-    async getDownloadUrl(pathInBucket, urlExpirationInSeconds) {
+    /**
+     * Generates a URL for downloading a file from a specified path within the bucket.
+     *
+     * @param filePathInBucket - The path of the file within the bucket for which to generate the download URL.
+     * @param urlExpirationInSeconds - Optional expiration time in seconds for the download URL.
+     * @returns A promise that resolves to a `GetDownloadUrlResponse` containing the download URL.
+     */
+    async getDownloadUrl(filePathInBucket, urlExpirationInSeconds) {
         const request = {
             integrationId: this.integrationId,
-            pathInBucket,
+            pathInBucket: filePathInBucket,
             urlExpirationInSeconds,
         };
         return await this.rpcManager.post('storage/getDownloadUrl', request);
     }
-    async listDirectoryContents(pathInBucket) {
+    /**
+     * Lists the contents of a directory within the bucket.
+     *
+     * @param dirPathInBucket - The path of the directory within the bucket.
+     * @returns A promise that resolves to a `ListDirectoryContentsResponse` containing the directory contents.
+     */
+    async listDirectoryContents(dirPathInBucket) {
         const request = {
             integrationId: this.integrationId,
-            pathInBucket,
+            pathInBucket: dirPathInBucket,
         };
         return await this.rpcManager.post('storage/listDirectoryContents', request);
     }
-    async deleteFile(pathInBucket) {
-        await this.deleteFiles([pathInBucket]);
+    /**
+     * Deletes a single file from a specified path within the bucket.
+     *
+     * @param filePathInBucket - The path of the file within the bucket to be deleted.
+     * @returns A promise that resolves to void when the file has been deleted.
+     */
+    async deleteFile(filePathInBucket) {
+        await this.deleteFiles([filePathInBucket]);
     }
-    async deleteFiles(pathsInBucket) {
+    /**
+     * Deletes multiple files from specified paths within the bucket.
+     *
+     * @param filePathsInBucket - An array of paths for the files within the bucket to be deleted.
+     * @returns A promise that resolves to void when all specified files have been deleted.
+     */
+    async deleteFiles(filePathsInBucket) {
         const request = {
             integrationId: this.integrationId,
-            pathsInBucket,
+            pathsInBucket: filePathsInBucket,
         };
         await this.rpcManager.post('storage/deleteFiles', request);
     }

package/dist/internal-common/src/public-types/ai-chatbot.public-types.d.ts

@@ -1,5 +1,5 @@
 /** The supported AI model names. */
-export declare const AI_MODEL_NAMES: readonly ["gpt-3.5-turbo", "gpt-3.5-turbo-1106", "gpt-4", "claude-2", "gpt-4-1106-preview"];
+export declare const AI_MODEL_NAMES: readonly ["gpt-3.5-turbo", "gpt-3.5-turbo-1106", "gpt-4", "claude-2", "gpt-4-turbo-preview"];
 export type AiModelName = (typeof AI_MODEL_NAMES)[number];
 /** The possible sources for the LLM provider API key. */
 export type ApiKeySource = 'user' | 'system';

package/dist/internal-common/src/utils/object.d.ts

@@ -20,3 +20,8 @@ export declare function compareValues(v1: unknown, v2: unknown): number;
 export declare function mapValues<ResultType extends object = Record<string, unknown>, InputType extends Record<string, unknown> = Record<string, unknown>>(obj: InputType, valueMapperFn: (value: any, key: keyof InputType, obj: InputType) => unknown): ResultType;
 /** Groups elements of the array by key. See _.groupBy for details. */
 export declare function groupBy<T, K extends PropertyKey>(array: T[], getKey: (item: T) => K): Record<K, T[]>;
+/**
+ * Picks selected fields from the object and returns a new object with the fields selected.
+ * The selected fields are assigned by reference (there is no cloning).
+ */
+export declare function pick<T extends object, K extends keyof T>(obj: T, keys: K[]): Pick<T, K>;

package/dist/typescript-client/src/query/query-builder.factory.d.ts

@@ -87,7 +87,7 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * A shortcut for where(fieldName, 'like', pattern).
      *
      * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' matches 0 or more wildcard characters. '_' matches exactly one wildcard character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
+     * @param pattern The pattern to compare against. '%' matches 0 or more characters. '_' matches exactly one character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
      * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
      * @returns The query builder.
      */
@@ -96,7 +96,7 @@ export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
      * A shortcut for where(fieldName, 'not like', pattern).
      *
      * @param fieldName The name of the field to query.
-     * @param pattern The pattern to compare against. '%' matches 0 or more wildcard characters. '_' matches exactly one wildcard character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
+     * @param pattern The pattern to compare against. '%' matches 0 or more characters. '_' matches exactly one character. '\' can be used to escape '%', '_'. or another '\'. Note that any '\' that is not followed by '%', '_', or '\' is invalid.
      * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
      * @returns The query builder.
      */

package/dist/typescript-client/src/storage-client.d.ts

@@ -44,10 +44,49 @@ export interface ListDirectoryContentsResponse {
 export declare class StorageClient {
     private readonly integrationId;
     private readonly rpcManager;
-    uploadFile(pathInBucket: string, file: File | BlobAndFilename, expirationInSeconds?: number): Promise<void>;
-    getFileMetadata(pathInBucket: string): Promise<GetFileMetadataResponse>;
-    getDownloadUrl(pathInBucket: string, urlExpirationInSeconds?: number): Promise<GetDownloadUrlResponse>;
-    listDirectoryContents(pathInBucket: string): Promise<ListDirectoryContentsResponse>;
-    deleteFile(pathInBucket: string): Promise<void>;
-    deleteFiles(pathsInBucket: Array<string>): Promise<void>;
+    /**
+     * Uploads a file to a specified directory within the bucket.
+     *
+     * @param dirPathInBucket - The directory path within the bucket where the file should be uploaded.
+     * @param file - The file or blob (with filename) to upload.
+     * @param expirationInSeconds - Optional expiration time in seconds for the upload.
+     * @returns A promise that resolves to void when the upload is complete.
+     */
+    uploadFile(dirPathInBucket: string, file: File | BlobAndFilename, expirationInSeconds?: number): Promise<void>;
+    /**
+     * Retrieves metadata for a file located in a specified path within the bucket.
+     *
+     * @param filePathInBucket - The path of the file within the bucket.
+     * @returns A promise that resolves to a `GetFileMetadataResponse` containing the file's metadata.
+     */
+    getFileMetadata(filePathInBucket: string): Promise<GetFileMetadataResponse>;
+    /**
+     * Generates a URL for downloading a file from a specified path within the bucket.
+     *
+     * @param filePathInBucket - The path of the file within the bucket for which to generate the download URL.
+     * @param urlExpirationInSeconds - Optional expiration time in seconds for the download URL.
+     * @returns A promise that resolves to a `GetDownloadUrlResponse` containing the download URL.
+     */
+    getDownloadUrl(filePathInBucket: string, urlExpirationInSeconds?: number): Promise<GetDownloadUrlResponse>;
+    /**
+     * Lists the contents of a directory within the bucket.
+     *
+     * @param dirPathInBucket - The path of the directory within the bucket.
+     * @returns A promise that resolves to a `ListDirectoryContentsResponse` containing the directory contents.
+     */
+    listDirectoryContents(dirPathInBucket: string): Promise<ListDirectoryContentsResponse>;
+    /**
+     * Deletes a single file from a specified path within the bucket.
+     *
+     * @param filePathInBucket - The path of the file within the bucket to be deleted.
+     * @returns A promise that resolves to void when the file has been deleted.
+     */
+    deleteFile(filePathInBucket: string): Promise<void>;
+    /**
+     * Deletes multiple files from specified paths within the bucket.
+     *
+     * @param filePathsInBucket - An array of paths for the files within the bucket to be deleted.
+     * @returns A promise that resolves to void when all specified files have been deleted.
+     */
+    deleteFiles(filePathsInBucket: Array<string>): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.191",
+  "version": "1.0.193",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",