@squidcloud/client 1.0.189 → 1.0.191

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

@@ -1,7 +1,7 @@
 import { MutationContext } from './mutation.public-context';
 import { ApiCallContext } from './api-call.public-context';
 import { QueryContext } from './query.public-context';
-import { AiChatbotActionType, DatabaseActionType, TopicActionType } from './bundle-data.public-types';
+import { AiChatbotActionType, DatabaseActionType, StorageActionType, TopicActionType } from './bundle-data.public-types';
 import { ClientConnectionState } from './socket.public-types';
 import { DocumentData } from './document.public-types';
 import { MutationType } from './mutation.public-types';
@@ -11,7 +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';
 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 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/bundle-data.public-types.d.ts

@@ -1,5 +1,7 @@
 /** The different types of actions that can be performed on a database. */
 export type DatabaseActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
+/** The different types of actions that can be performed for storage. */
+export type StorageActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
 /** The different types of actions that can be performed on a topic. */
 export type TopicActionType = 'read' | 'write' | 'all';
 /** The different types of actions that can be performed on an AI chatbot. */

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

@@ -21,6 +21,8 @@ export declare enum IntegrationType {
     'kafka' = "kafka",
     'confluent' = "confluent",
     'built_in_queue' = "built_in_queue",
+    's3' = "s3",
+    'built_in_s3' = "built_in_s3",
     'algolia' = "algolia",
     'elastic_observability' = "elastic_observability",
     'elastic_search' = "elastic_search",

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

@@ -39,3 +39,6 @@ export interface DiscoverOpenApiSchemaRequest {
     integrationType: IntegrationType.api;
     discoveryOptions: OpenApiDiscoveryOptions;
 }
+export interface DiscoverOpenApiSchemaFromFileRequest {
+    integrationType: IntegrationType.api;
+}

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

@@ -0,0 +1,9 @@
+import { IntegrationId } from './communication.public-types';
+import { StorageActionType } from './bundle-data.public-types';
+export type StorageFunctionality = 'fileUpload';
+export interface SecureStorageRequest {
+    integrationId: IntegrationId;
+    pathsInBucket: Array<string>;
+    action: StorageActionType;
+    functionality: StorageFunctionality;
+}

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

@@ -0,0 +1 @@
+export {};

package/dist/internal-common/src/types/query.types.d.ts

@@ -1 +1,10 @@
-export {};
+/**
+ * Generates the regex pattern, handling special characters as follows:
+ *  - `_` is replaced with a `.`
+ *  - `%` is replaced with `[\s\S]*`.
+ *  - The above characters can be escaped with \, eg. `\_` is replaced with `_` and `\%` with `%`.
+ *  - All special characters in regex (-, /, \, ^, $, *, +, ?, ., (, ), |, [, ], {, }) get escaped with \
+ *
+ *  Exported for testing purposes.
+ * */
+export declare function replaceSpecialCharacters(input: string): string;

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

@@ -9,8 +9,14 @@ export declare function replaceKeyInRecord<K extends keyof any, T>(record: Recor
 export declare function isNil(obj: unknown): obj is null | undefined;
 export declare function isEqual(a: unknown, b: unknown): boolean;
 export declare function isEmpty(a: unknown): boolean;
-export declare function omit<T extends object, K extends (string | number | symbol)[]>(object: T | null | undefined, ...paths: K): Pick<T, Exclude<keyof T, K[number]>>;
+export declare function omit<T extends object, K extends PropertyKey[]>(object: T | null | undefined, ...fieldsToRemove: K): Pick<T, Exclude<keyof T, K[number]>>;
 /** Creates a deep copy of the object. Copies all Date, Map, Set fields. */
 export declare function cloneDeep<T>(value: T): T;
+/** Creates a shallow clone of the object. */
+export declare function cloneShallow<T>(value: T): T;
 /** Compares 2 values. 'null' and 'undefined' values are considered equal and are less than any other values. */
-export declare function compareValues(a: any, b: any): number;
+export declare function compareValues(v1: unknown, v2: unknown): number;
+/** Returns a new object with all top-level object fields re-mapped using `valueMapperFn`. */
+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[]>;

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

@@ -40,3 +40,4 @@ export * from './socket.manager';
 export * from './squid-http-client';
 export * from './squid';
 export * from './types';
+export * from './storage-client';

package/dist/typescript-client/src/public-types.d.ts

@@ -29,3 +29,4 @@ export * from '../../internal-common/src/public-types/serialized-query.public-ty
 export * from '../../internal-common/src/public-types/socket.public-types';
 export * from '../../internal-common/src/public-types/topic.public-context';
 export * from '../../internal-common/src/public-types/typescript.public-types';
+export * from '../../internal-common/src/public-types/storage.types';

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. '%' is the only allowed wildcard
+     * @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 caseSensitive Whether to use case-sensitive comparison. Defaults to true.
      * @returns The query builder.
      */
@@ -96,11 +96,12 @@ 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. '%' is the only allowed wildcard
+     * @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 caseSensitive Whether to use case-sensitive comparison. Defaults to true.
      * @returns The query builder.
      */
     notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    throwIfInvalidLikePattern(pattern: string): void;
     /**
      * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
      * if none is provided.

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

@@ -5,9 +5,10 @@ import { GraphQLClient } from './graphql-client';
 import { SecretClient } from './secret.client';
 import { TransactionId } from './types';
 import { AiClient } from './ai.types';
-import { ApiEndpointId, ApiKey, CallApiOptions, AppId, CollectionName, DocumentData, EnvironmentId, IntegrationId, NativeApiCallResponse, SquidDeveloperId, SquidRegion } from './public-types';
+import { ApiEndpointId, ApiKey, AppId, CallApiOptions, CollectionName, DocumentData, EnvironmentId, IntegrationId, NativeApiCallResponse, SquidDeveloperId, SquidRegion } from './public-types';
 import { QueueManager } from './queue.manager';
 import { ApiClient } from './api-client';
+import { StorageClient } from './storage-client';
 /** The different options that can be used to initialize a Squid instance. */
 export interface SquidOptions {
     /**
@@ -207,6 +208,7 @@ export declare class Squid {
      */
     ai(): AiClient;
     api(): ApiClient;
+    storage(integrationId?: IntegrationId): StorageClient;
     get secrets(): SecretClient;
     /**
      * Returns a distributed lock for the given mutex. The lock can be used to synchronize access to a shared resource.
@@ -216,6 +218,15 @@ export declare class Squid {
      * @returns A promise that resolves with the lock object. The promise will reject if failed to acquire the lock.
      */
     acquireLock(mutex: string): Promise<DistributedLock>;
+    /**
+     * Executes the given callback while holding a lock for the given mutex. The lock will be released when the callback
+     * finishes.
+     * @param mutex A string that uniquely identifies the lock.
+     * @param fn The callback to execute while holding the lock.
+     * @returns A promise that resolves with the result of the callback. The promise will reject if failed
+     *   to acquire the lock.
+     */
+    withLock<T>(mutex: string, fn: (lock: DistributedLock) => Promise<T>): Promise<T>;
     /**
      * Returns a queue manager for the given topic name and integration id. Using the queue manager you can consume and
      * produce messages

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

@@ -0,0 +1,53 @@
+import { BlobAndFilename } from './types';
+import { IntegrationId } from '../../internal-common/src/public-types/communication.public-types';
+export interface StorageFileUploadRequest {
+    integrationId: IntegrationId;
+    pathInBucket: string;
+    expirationInSeconds?: number;
+}
+export interface GetFileMetadataRequest {
+    integrationId: IntegrationId;
+    pathInBucket: string;
+}
+export interface GetFileMetadataResponse {
+    filename: string;
+    size: number;
+    lastModified: Date;
+    metadata: Record<string, string>;
+}
+export interface GetDownloadUrlRequest {
+    integrationId: IntegrationId;
+    pathInBucket: string;
+    urlExpirationInSeconds?: number;
+}
+export interface GetDownloadUrlResponse {
+    url: string;
+}
+export interface DeleteFilesRequest {
+    integrationId: IntegrationId;
+    pathsInBucket: Array<string>;
+}
+export interface ListDirectoryContentsRequest {
+    integrationId: IntegrationId;
+    pathInBucket: string;
+}
+export interface FileInDirectory {
+    filename: string;
+    absolutePathInBucket: string;
+    size: number;
+    lastModified: Date;
+}
+export interface ListDirectoryContentsResponse {
+    directories: Array<string>;
+    files: Array<FileInDirectory>;
+}
+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>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.189",
+  "version": "1.0.191",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",
@@ -40,7 +40,6 @@
     "ajv": "^8.11.2",
     "ajv-formats": "^2.1.1",
     "bufferutil": "^4.0.7",
-    "cross-fetch": "^3.1.5",
     "date-fns": "^2.30.0",
     "deep-diff": "^1.0.2",
     "graphql": "^16.6.0",

package/dist/internal-common/src/utils/squid-private-options.d.ts

@@ -1,8 +0,0 @@
-export declare function setSquidPrivateOption<T = unknown>(optionName: string, value: T): void;
-export declare function getSquidPrivateOption<T = unknown>(optionName: string): T | undefined;
-/**
- * When set to 'true' (boolean), the Graphql client in Squid uses new 'fetch' based
- * HTTP client instead of cross-fetch library.
- * The option will be removed after the migration is tested and all issues are fixed.
- */
-export declare const SQUID_PRIVATE_OPTION_USE_FETCH_IN_GRAPHQL_CLIENT = "useFetchInGraphqlClient";