@squidcloud/client 1.0.194 → 1.0.196

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-turbo-preview"];
+export declare const AI_MODEL_NAMES: readonly ["gpt-3.5-turbo", "gpt-3.5-turbo-1106", "gpt-4", "claude-3-opus-20240229", "claude-3-sonnet-20240229", "claude-3-haiku-20240307", "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/public-types/bundle-api.public-types.d.ts

@@ -11,9 +11,9 @@ import { NativeQueryContext } from './native-query.public-context';
 import { DistributedLockContext } from './distributed-lock.public-context';
 import { GraphqlContext } from './graphql.public-context';
 import { AiChatbotChatContext, AiChatbotMutationContext } from './ai-chatbot.public-context';
-import { SecureStorageRequest } from './storage.types';
+import { StorageContext } from './storage.types';
 export type SecureDatabaseAction<T extends DatabaseActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'read' ? ((context: QueryContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: MutationContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
-export type SecureStorageAction<T extends StorageActionType> = T extends 'all' ? () => boolean | Promise<boolean> : (request: SecureStorageRequest) => boolean | Promise<boolean>;
+export type SecureStorageAction<T extends StorageActionType> = T extends 'all' ? () => boolean | Promise<boolean> : (context: StorageContext) => boolean | Promise<boolean>;
 export type SecureTopicAction<T extends TopicActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'read' ? ((context: TopicReadContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: TopicWriteContext<T>) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
 export type SecureApiAction = ((context: ApiCallContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
 export type SecureNativeQueryAction = ((context: NativeQueryContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);

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

@@ -9,6 +9,8 @@ export type FieldName<T = any> = string & keyof T;
 export type DocId = string;
 /** A type alias for a document id object when the ID is a composite of primary keys. */
 export type DocIdObj = Record<FieldName, any>;
+/** A type alias for a document id or a document id object. */
+export type DocIdOrDocIdObj = DocId | DocIdObj;
 /** A type alias for a collection name. */
 export type CollectionName = string;
 /** A generic document data type. */

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

@@ -18,6 +18,7 @@ export declare enum IntegrationType {
     'cognito' = "cognito",
     'okta' = "okta",
     'descope' = "descope",
+    'firebase_auth' = "firebase_auth",
     'kafka' = "kafka",
     'confluent' = "confluent",
     'built_in_queue' = "built_in_queue",

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

@@ -1,7 +1,7 @@
 import { IntegrationId } from './communication.public-types';
 import { StorageActionType } from './bundle-data.public-types';
-export type StorageFunctionality = 'fileUpload';
-export interface SecureStorageRequest {
+export type StorageFunctionality = 'fileUpload' | 'getFileMetadata' | 'getDownloadUrl' | 'deleteFiles' | 'listDirectoryContents';
+export interface StorageContext {
     integrationId: IntegrationId;
     pathsInBucket: Array<string>;
     action: StorageActionType;

package/dist/internal-common/src/public-utils/id-utils.d.ts

@@ -2,5 +2,8 @@
 export declare function generateId(): string;
 /** Default length if ID produced by `generateShortId`. */
 export declare const DEFAULT_SHORT_ID_LENGTH = 18;
-/** Generates an ID of the given `length` using lowercase latin letters and digits.. */
-export declare function generateShortId(length?: number): string;
+/**
+ * Generates an ID of the given `length` using lowercase latin letters and digits.
+ * If the 'prefix' provided replaces the first generated characters with the prefix.
+ */
+export declare function generateShortId(length?: number, prefix?: string): string;

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

@@ -24,4 +24,4 @@ export declare function groupBy<T, K extends PropertyKey>(array: T[], getKey: (i
  * 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>;
+export declare function pick<T extends object, K extends keyof T>(obj: T, keys: ReadonlyArray<K>): Pick<T, K>;

package/dist/typescript-client/src/ai-chatbot-client.d.ts

@@ -73,7 +73,7 @@ export declare class AiChatbotProfileReference {
      * Adds a new profile to the chatbot. This will result in an error if a profile already exists with the same id.
      *
      * @param data An object containing options for creating the profile.
-     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4` or `claude-2`).
+     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4`, `claude-3-opus-20240229`, `claude-3-sonnet-20240229` or `claude-3-haiku-20240307`).
      * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
      * @returns A promise that resolves when the profile is successfully created.
      */
@@ -83,7 +83,7 @@ export declare class AiChatbotProfileReference {
      * current profile id.
      *
      * @param data An object containing options for updating the profile.
-     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4` or `claude-2`).
+     * @param data.modelName - The name of the OpenAI model (`gpt-3.5, `gpt-4`, `claude-3-opus-20240229`, `claude-3-sonnet-20240229` or `claude-3-haiku-20240307`).
      * @param data.isPublic - Whether the chat functionality of the profile can be accessed without security rules.
      * @returns A promise that resolves when the profile is successfully updated.
      */

package/dist/typescript-client/src/collection-reference.d.ts

@@ -1,8 +1,19 @@
-import { Alias, DocId, DocIdObj, DocumentData } from './public-types';
+import { Alias, DocIdOrDocIdObj, DocumentData } from './public-types';
 import { DocumentReference } from './document-reference';
 import { JoinQueryBuilder } from './query/join-query-builder.factory';
 import { QueryBuilder } from './query/query-builder.factory';
 import { SnapshotEmitter } from './query/snapshot-emitter';
+/**
+ * Represents a docId and the data to be inserted.
+ * If the docId is not provided, it will be generated on the server in case the integration supports it.
+ * Read more about docId in the
+ * {@link https://docs.squid.cloud/docs/api-reference/client-sdk-reference/classes/CollectionReference#doc
+ * documentation}.
+ */
+export interface DocIdAndData<T extends DocumentData> {
+    id?: DocIdOrDocIdObj;
+    data: T;
+}
 /**
  *  Holds a reference to a data collection. A collection reference is a reference to a collection in a database. You
  * can use it to read or write data to the collection. A collection can refer to a table in a relational database or a
@@ -18,6 +29,7 @@ export declare class CollectionReference<T extends DocumentData> {
     private readonly documentReferenceFactory;
     private readonly queryBuilderFactory;
     private readonly querySubscriptionManager;
+    private readonly dataManager;
     /** A string that uniquely identifies this collection reference. */
     refId: string;
     /**
@@ -53,7 +65,15 @@ export declare class CollectionReference<T extends DocumentData> {
      * @param docId The document id as an object for the different fields in the primary key or a string.
      * @returns A document reference for the given document id.
      */
-    doc(docId?: DocId | DocIdObj): DocumentReference<T>;
+    doc(docId?: DocIdOrDocIdObj): DocumentReference<T>;
+    /**
+     * Inserts multiple documents into the collection.
+     */
+    insertMany(docs: Array<DocIdAndData<T>>, txId?: string): Promise<void>;
+    /**
+     * Deletes multiple documents from the collection.
+     */
+    deleteMany(docIdsOrReferences: Array<DocIdOrDocIdObj | DocumentReference<T>>, txId?: string): Promise<void>;
     /**
      * Creates a `QueryBuilder` that can be used to query the collection.
      *

package/package.json

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