@squidcloud/client 1.0.189 → 1.0.190

package/dist/cjs/index.js

@@ -27757,6 +27757,7 @@ __webpack_require__.d(__webpack_exports__, {
   SecretClient: () => (/* reexport */ SecretClient),
   SocketManager: () => (/* reexport */ SocketManager),
   Squid: () => (/* reexport */ Squid),
+  StorageClient: () => (/* reexport */ StorageClient),
   allEnvironmentIds: () => (/* reexport */ allEnvironmentIds),
   deserializeQuery: () => (/* reexport */ deserializeQuery),
   generateId: () => (/* reexport */ generateId),
@@ -29337,7 +29338,6 @@ class ApiClient {
 
 // EXTERNAL MODULE: ../node_modules/lodash/lodash.js
 var lodash = __webpack_require__(8784);
-var lodash_default = /*#__PURE__*/__webpack_require__.n(lodash);
 // EXTERNAL MODULE: ../node_modules/assertic/dist/index.js
 var dist = __webpack_require__(8975);
 // EXTERNAL MODULE: ../node_modules/rfdc/index.js
@@ -29473,17 +29473,19 @@ function isEmpty(a) {
     }
     return false;
 }
-function omit(object, ...paths) {
+function omit(object, ...fieldsToRemove) {
     if (object === null || object === undefined) {
         return {};
     }
-    const result = {};
-    const omitKeys = new Set(paths);
-    Object.keys(object).forEach(key => {
-        if (!omitKeys.has(key)) {
-            result[key] = object[key];
+    if (fieldsToRemove.length === 0) {
+        return object;
+    }
+    const result = Object.assign({}, object);
+    for (const fieldToRemove of fieldsToRemove) {
+        if (result.hasOwnProperty(fieldToRemove)) {
+            delete result[fieldToRemove];
         }
-    });
+    }
     return result;
 }
 /** Creates a deep copy of the object. Copies all Date, Map, Set fields. */
@@ -29494,18 +29496,70 @@ function cloneDeep(value) {
     return rfdc_default()()(value);
 }
 /** Compares 2 values. 'null' and 'undefined' values are considered equal and are less than any other values. */
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-function compareValues(a, b) {
-    if (a === b || (isNil(a) && isNil(b))) {
+function compareValues(v1, v2) {
+    if (v1 === v2 || (isNil(v1) && isNil(v2))) {
         return 0;
     }
-    else if (isNil(a)) {
+    else if (isNil(v1)) {
         return -1;
     }
-    else if (isNil(b)) {
+    else if (isNil(v2)) {
         return 1;
     }
-    return a < b ? -1 : a > b ? 1 : 0;
+    const v1Type = typeof v1;
+    const v2Type = typeof v2;
+    if (v1Type !== v2Type) {
+        return v1Type < v2Type ? -1 : 1;
+    }
+    if (typeof v1 === 'number') {
+        (0,dist.assertTruthy)(typeof v2 === 'number');
+        if (isNaN(v1) && isNaN(v2))
+            return 0; // Consider NaNs as equal.
+        if (isNaN(v1))
+            return -1; // NaN is considered less than any number.
+        if (isNaN(v2))
+            return 1; // Any number is considered greater than NaN.
+        return v1 < v2 ? -1 : 1;
+    }
+    if (typeof v1 === 'boolean') {
+        (0,dist.assertTruthy)(typeof v2 === 'boolean');
+        return v1 < v2 ? -1 : 1;
+    }
+    if (typeof v1 === 'bigint') {
+        (0,dist.assertTruthy)(typeof v2 === 'bigint');
+        return v1 < v2 ? -1 : 1;
+    }
+    if (typeof v1 === 'string') {
+        (0,dist.assertTruthy)(typeof v2 === 'string');
+        return v1.localeCompare(v2);
+    }
+    if (v1 instanceof Date && v2 instanceof Date) {
+        return Math.sign(v1.getTime() - v2.getTime());
+    }
+    return 0; // Fallback if types are not comparable.
+}
+/** Returns a new object with all top-level object fields re-mapped using `valueMapperFn`. */
+function mapValues(obj, valueMapperFn) {
+    const result = {};
+    const keys = Object.keys(obj);
+    for (const key of keys) {
+        const value = obj[key];
+        result[key] = valueMapperFn(value, key, obj);
+    }
+    return result;
+}
+/** Groups elements of the array by key. See _.groupBy for details. */
+function groupBy(array, getKey) {
+    return array.reduce((result, item) => {
+        const key = getKey(item);
+        if (!result[key]) {
+            result[key] = [item];
+        }
+        else {
+            result[key].push(item);
+        }
+        return result;
+    }, {});
 }
 
 ;// CONCATENATED MODULE: ../internal-common/src/utils/serialization.ts
@@ -29593,14 +29647,14 @@ class ApiManager {
         this.clientIdService = clientIdService;
         this.rpcManager = rpcManager;
     }
-    callApiAndSubscribe(integrationId, endpointId, request, options) {
+    callApiAndSubscribe(integrationId, endpointId, request, options, file) {
         const callApiRequest = {
             integrationId,
             endpointId,
             request,
             options,
         };
-        return (0,external_rxjs_.race)((0,external_rxjs_.from)(this.rpcManager.post('api/call', callApiRequest)).pipe(map(response => {
+        return (0,external_rxjs_.race)((0,external_rxjs_.from)(this.rpcManager.post('api/call', callApiRequest, file ? [file] : undefined, file ? 'file' : undefined)).pipe(map(response => {
             const parsedPayload = response.payload ? deserializeObj(response.payload) : undefined;
             if (response.success) {
                 return parsedPayload;
@@ -29672,13 +29726,23 @@ class BackendFunctionManager {
         this.rpcManager = rpcManager;
     }
     executeFunctionAndSubscribe(functionName, ...params) {
+        const fileArr = [];
+        const paramArr = [];
+        params.forEach(param => {
+            if (typeof File !== 'undefined' && param instanceof File) {
+                fileArr.push(param);
+            }
+            else {
+                paramArr.push(param);
+            }
+        });
         const request = {
             functionName,
-            paramsArrayStr: serializeObj(params),
+            paramsArrayStr: serializeObj(paramArr),
         };
         // Append '?functionName' suffix to every POST request for visibility in the browser's 'Network' tab.
         const postUrl = `backend-function/execute?${encodeURIComponent(functionName)}`;
-        return (0,external_rxjs_.race)((0,external_rxjs_.from)(this.rpcManager.post(postUrl, request)).pipe(map(response => {
+        return (0,external_rxjs_.race)((0,external_rxjs_.from)(this.rpcManager.post(postUrl, request, fileArr.length > 0 ? fileArr : [])).pipe(map(response => {
             if (!response.success) {
                 throw new Error(response.payload);
             }
@@ -30086,6 +30150,8 @@ var IntegrationType;
     IntegrationType["kafka"] = "kafka";
     IntegrationType["confluent"] = "confluent";
     IntegrationType["built_in_queue"] = "built_in_queue";
+    IntegrationType["s3"] = "s3";
+    IntegrationType["built_in_s3"] = "built_in_s3";
     // Coming Soon
     IntegrationType["algolia"] = "algolia";
     IntegrationType["elastic_observability"] = "elastic_observability";
@@ -30269,15 +30335,54 @@ function isStringMatch(str, pattern, caseSensitive) {
         str = str.toLowerCase();
         pattern = pattern.toLowerCase();
     }
-    // Escape special regex characters in the pattern
-    const escapedPattern = pattern.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&');
-    // Replace '%' wildcard with regex equivalent
-    // Note: this allows for newlines, unlike .*
-    const regexPattern = escapedPattern.replace(/%/g, '[\\s\\S]*');
+    const regexPattern = replaceSpecialCharacters(pattern);
     // Create regex object and test if string matches
     const regex = new RegExp(`^${regexPattern}$`);
     return regex.test(str);
 }
+/**
+ * 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.
+ * */
+function replaceSpecialCharacters(input) {
+    let result = '';
+    for (let i = 0; i < input.length; ++i) {
+        if (input[i] === '\\') {
+            if (i + 1 < input.length && ['%', '_'].includes(input[i + 1])) {
+                result += input[i + 1];
+                i++;
+            }
+            else if (i + 1 < input.length && input[i + 1] === '\\') {
+                result += '\\\\';
+                i++;
+            }
+            else {
+                result += '\\';
+            }
+        }
+        else if (input[i] === '%') {
+            // Replace '%' wildcard with regex equivalent. Note: this allows for newlines, unlike .*
+            result += '[\\s\\S]*';
+        }
+        else if (input[i] === '_') {
+            result += '[\\s\\S]';
+        }
+        else {
+            // Escape special regex characters in the pattern
+            // '\' is checked above and needs to be manually escaped by the user
+            if ('/-\\^$*+?.()[]{}|'.includes(input[i])) {
+                result += '\\';
+            }
+            result += input[i];
+        }
+    }
+    return result;
+}
 /**
  * Returns a unique identifier for the query which includes both the client id and the client request id.
  * @internal
@@ -30602,6 +30707,7 @@ var ClientConnectionState;
 
 
 
+
 
 
 ;// CONCATENATED MODULE: ../internal-common/src/utils/assert.ts
@@ -31108,7 +31214,6 @@ class Pagination {
 
 
 
-
 /** @internal */
 class QueryBuilderFactory {
     constructor(querySubscriptionManager, localQueryManager, documentReferenceFactory, documentIdentityService) {
@@ -31218,24 +31323,32 @@ 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. '%' 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.
      */
     like(fieldName, pattern, caseSensitive) {
+        this.throwIfInvalidLikePattern(pattern);
         return this.where(fieldName, caseSensitive ? 'like_cs' : 'like', pattern);
     }
     /**
      * 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, pattern, caseSensitive) {
+        this.throwIfInvalidLikePattern(pattern);
         return this.where(fieldName, caseSensitive ? 'not like_cs' : 'not like', pattern);
     }
+    throwIfInvalidLikePattern(pattern) {
+        const invalidBackslash = /\\(?![%_\\])/;
+        if (invalidBackslash.test(pattern)) {
+            throw new Error(`Invalid pattern. Cannot have any \\ which are not followed by _, % or \\`);
+        }
+    }
 }
 /** @internal */
 class DereferenceEmitter {
@@ -31368,15 +31481,16 @@ class QueryBuilder extends BaseQueryBuilder {
     mergeConditions() {
         const simpleConditions = this.query.conditions.filter(isSimpleCondition);
         const result = [];
-        const groupByFieldName = lodash.groupBy(simpleConditions || [], condition => condition.fieldName);
+        const groupByFieldName = groupBy(simpleConditions || [], condition => condition.fieldName);
         for (const fieldNameGroup of Object.values(groupByFieldName)) {
-            const groupByOperator = lodash.groupBy(fieldNameGroup, operator => operator.operator);
+            const groupByOperator = groupBy(fieldNameGroup, operator => operator.operator);
             for (const [operator, operatorGroup] of Object.entries(groupByOperator)) {
                 if (operator === '==' || operator === '!=') {
                     result.push(...operatorGroup);
                     continue;
                 }
-                const sorted = lodash.sortBy(operatorGroup, o => o.value);
+                const sorted = [...operatorGroup];
+                sorted.sort((o1, o2) => compareValues(o1.value, o2.value));
                 if (operator === '>' || operator === '>=') {
                     result.push(sorted[sorted.length - 1]);
                 }
@@ -31567,7 +31681,6 @@ class Changes {
 
 
 
-
 /**
  * A query builder that can participate in a join.
  * To learn more about join queries, see the
@@ -31735,13 +31848,9 @@ class DereferencedJoin {
     }
     /** @inheritDoc */
     snapshots(subscribe) {
-        return this.joinQueryBuilder.snapshots(subscribe).pipe(map(docs => {
-            return docs.map(doc => {
-                return lodash.mapValues(doc, doc1 => {
-                    return doc1 === null || doc1 === void 0 ? void 0 : doc1.data;
-                });
-            });
-        }));
+        return this.joinQueryBuilder
+            .snapshots(subscribe)
+            .pipe(map(docs => docs.map(doc => mapValues(doc, fieldDoc => fieldDoc === null || fieldDoc === void 0 ? void 0 : fieldDoc.data))));
     }
     /**
      * @inheritDoc
@@ -31879,7 +31988,7 @@ class GroupedJoin {
         return new DereferencedGroupedJoin(this);
     }
     groupData(input, rootAlias) {
-        const oneLevelGroup = lodash.groupBy(input, inputRow => { var _a; return (_a = inputRow[rootAlias]) === null || _a === void 0 ? void 0 : _a.squidDocId; });
+        const oneLevelGroup = groupBy(input, inputRow => { var _a; return (_a = inputRow[rootAlias]) === null || _a === void 0 ? void 0 : _a.squidDocId; });
         return Object.values(oneLevelGroup)
             .filter(value => {
             return value[0][rootAlias] !== undefined;
@@ -32236,7 +32345,6 @@ var promise_pool_dist = __webpack_require__(3910);
 
 
 
-
 function applyStringFn(initialValue, propertyMutation) {
     switch (propertyMutation.fn) {
         case 'trim':
@@ -32268,7 +32376,7 @@ function applyPropertyMutation(property, propertyMutation) {
         case 'applyStringFn':
             return applyStringFn(property, propertyMutation);
         case 'update':
-            return typeof propertyMutation.value === 'object' ? lodash.cloneDeep(propertyMutation.value) : propertyMutation.value;
+            return typeof propertyMutation.value === 'object' ? cloneDeep(propertyMutation.value) : propertyMutation.value;
         case 'removeProperty':
             return undefined;
         default:
@@ -32351,18 +32459,6 @@ function applyUpdateMutation(doc, updateMutation) {
     }
     return result;
 }
-/** @internal */
-function convertInsertToUpdate(insertMutation) {
-    const result = {
-        type: 'update',
-        squidDocIdObj: insertMutation.squidDocIdObj,
-        properties: {},
-    };
-    for (const [key, value] of Object.entries(insertMutation.properties)) {
-        result.properties[key] = [{ type: 'update', value }];
-    }
-    return result;
-}
 /**
  * Reduces the list of mutations such that each document will have a single mutation. If for example there are multiple
  * updates to the same document, those will be merged and a single update will be returned.
@@ -33172,6 +33268,9 @@ class DistributedLockManager {
                 },
             };
         })), this.acquireLockMessagesFromServer.pipe((0,external_rxjs_.filter)(message => message.payload.clientRequestId === clientRequestId))));
+        if (this.destructManager.isDestructing) {
+            throw new Error('Destructing');
+        }
         if (!result.payload.lockId) {
             throw new Error(`Failed to acquire lock: ${result.payload.error}`);
         }
@@ -33587,7 +33686,6 @@ class DocumentReferenceFactory {
 
 
 
-
 class DocumentStore {
     constructor() {
         this.squidDocIdToDoc = new Map();
@@ -33635,9 +33733,7 @@ class DocumentStore {
         return 0;
     }
     group(sortedDocs, sortFieldNames) {
-        return Object.values(lodash_default().groupBy(sortedDocs, doc => {
-            return normalizeJsonAsString(sortFieldNames.map(fieldName => getInPath(doc, fieldName)));
-        }));
+        return Object.values(groupBy(sortedDocs, doc => normalizeJsonAsString(sortFieldNames.map(fieldName => getInPath(doc, fieldName)))));
     }
     sortAndLimitDocs(docIdSet, query) {
         if (docIdSet.size === 0) {
@@ -49573,6 +49669,7 @@ const kotlinControllers = [
     'queue',
     'mutation',
     'application',
+    'storage',
 ];
 function getApplicationUrl(regionPrefix, appId, path) {
     const baseUrl = 'https://squid.cloud';
@@ -51193,7 +51290,7 @@ async function performFetchRequest({ headers, files, filesFieldName, message: bo
         };
     }
     catch (e) {
-        console.error(`Unable to perform fetch request to url: ${url}`, e);
+        DebugLogger.debug(`Unable to perform fetch request to url: ${url}`, e);
         throw e;
     }
 }
@@ -51495,11 +51592,13 @@ class SocketManager {
         }))
             .subscribe(() => {
             if (this.connectionReady.value) {
-                DebugLogger.debug(`Client reconnected before becoming too old. Ignoring... ${this.clientIdService.getClientId()}`);
+                DebugLogger.debug(this.clientIdService.getClientId(), `Client reconnected before becoming too old. Ignoring...`);
                 return;
             }
-            DebugLogger.debug(`Client disconnected for a long period - refreshing ${this.clientIdService.getClientId()}`);
-            this.refreshClient();
+            if (!this.destructManager.isDestructing) {
+                DebugLogger.debug(this.clientIdService.getClientId(), `Client disconnected for a long period - refreshing`);
+                this.refreshClient();
+            }
         });
         this.observeConnectionReady()
             .pipe((0,external_rxjs_.filter)(Boolean))
@@ -51511,22 +51610,22 @@ class SocketManager {
     }
     refreshClient() {
         if (this.destructManager.isDestructing) {
-            DebugLogger.debug(`Client too old but is destructed. Ignoring... ${this.clientIdService.getClientId()}`);
+            DebugLogger.debug(this.clientIdService.getClientId(), `Client too old but is destructed. Ignoring...`);
             return;
         }
         else if (this.clientIdService.isClientTooOld()) {
-            DebugLogger.debug(`Client is already marked as too old. Ignoring... ${this.clientIdService.getClientId()}`);
+            DebugLogger.debug(this.clientIdService.getClientId(), `Client is already marked as too old. Ignoring...`);
             return;
         }
-        DebugLogger.debug(`Notifying client too old ${this.clientIdService.getClientId()}`);
+        DebugLogger.debug(this.clientIdService.getClientId(), `Notifying client too old`);
         this.clientIdService.notifyClientTooOld();
-        DebugLogger.debug('Client too old. Reconnecting...');
+        DebugLogger.debug(this.clientIdService.getClientId(), 'Client too old. Reconnecting...');
         this.connect();
     }
     tick() {
         const diff = Math.abs(Date.now() - this.lastTick.getTime());
         if (diff > this.clientTooOldThreshold) {
-            DebugLogger.debug('Tick: Client not responding for a long time. Refreshing...', this.clientIdService.getClientId());
+            DebugLogger.debug(this.clientIdService.getClientId(), 'Tick: Client not responding for a long time. Refreshing...');
             this.refreshClient();
         }
         this.lastTick = new Date();
@@ -51551,7 +51650,9 @@ class SocketManager {
         }
         try {
             (0,dist.assertTruthy)(this.socket, 'Socket is undefined in sendMessageAsync');
-            this.socket.send(serializeObj({ message, authToken }));
+            const serializedMessage = serializeObj({ message, authToken });
+            DebugLogger.debug(this.clientIdService.getClientId(), 'Sending message to socket: ', serializedMessage);
+            this.socket.send(serializedMessage);
         }
         catch (e) {
             if (!((_a = this.socket) === null || _a === void 0 ? void 0 : _a.connected)) {
@@ -51582,18 +51683,18 @@ class SocketManager {
             .replace('https', 'wss')
             .replace('http', 'ws');
         const clientId = this.clientIdService.getClientId();
-        DebugLogger.debug('Connecting to socket at:', endpoint, 'clientId:', clientId);
+        DebugLogger.debug(this.clientIdService.getClientId(), 'Connecting to socket at:', endpoint);
         const socketUri = `${endpoint}?clientId=${clientId}`;
         this.socket = createWebSocketWrapper(socketUri, {
             timeout: 5000, // 5 seconds
             onmessage: (e) => this.onMessage(e.data),
             onopen: () => {
-                DebugLogger.debug(`Connection to socket established. Endpoint: ${endpoint}  ${this.clientIdService.getClientId()}`);
+                DebugLogger.debug(this.clientIdService.getClientId(), `Connection to socket established. Endpoint: ${endpoint}`);
             },
             onreconnect: () => {
-                DebugLogger.debug(`WebSocket reconnect event triggered ${clientId}`);
+                DebugLogger.debug(clientId, `WebSocket reconnect event triggered`);
                 if (this.clientIdService.getClientId() !== clientId) {
-                    DebugLogger.debug(`WebSocket reconnect event triggered - ignored because the client id changed. Old: ${clientId}, new: ${this.clientIdService.getClientId()}`);
+                    DebugLogger.debug(clientId, `WebSocket reconnect event triggered - ignored because the client id changed. Old: ${this.clientIdService.getClientId()}`);
                     return;
                 }
                 if (this.connectionReady.value) {
@@ -51601,9 +51702,9 @@ class SocketManager {
                 }
             },
             onclose: () => {
-                DebugLogger.debug(`WebSocket onclose event triggered ${clientId}`);
+                DebugLogger.debug(clientId, `WebSocket onclose event triggered`);
                 if (this.clientIdService.getClientId() !== clientId) {
-                    DebugLogger.debug(`WebSocket onclose event triggered - ignored because the client id changed. Old: ${clientId}, new: ${this.clientIdService.getClientId()}`);
+                    DebugLogger.debug(clientId, `WebSocket onclose event triggered - ignored because the client id changed. new: ${this.clientIdService.getClientId()}`);
                     return;
                 }
                 if (this.connectionReady.value) {
@@ -51624,7 +51725,7 @@ class SocketManager {
     }
     onMessage(messagesStr) {
         if (messagesStr === 'connectionReady') {
-            DebugLogger.debug(`Got socket message: connectionReady ${this.clientIdService.getClientId()}`);
+            DebugLogger.debug(this.clientIdService.getClientId(), `Got socket message: connectionReady`);
             this.onConnectionReady();
             return;
         }
@@ -51635,7 +51736,7 @@ class SocketManager {
                 continue;
             }
             this.seenMessageIds.add(message.messageId);
-            DebugLogger.debug(new Date(), `Got socket message: (${this.clientIdService.getClientId()})`, JSON.stringify(message, null, 2));
+            DebugLogger.debug(this.clientIdService.getClientId(), new Date(), `Got socket message`, JSON.stringify(message, null, 2));
             this.messageNotificationWrapper(() => {
                 this.webSocketObserver.next(message);
             });
@@ -51717,6 +51818,55 @@ function omitSquidDevId(appId) {
     return appIdWithEnvironmentId(parsedAppId.appId, parsedAppId.environmentId);
 }
 
+;// CONCATENATED MODULE: ./src/storage-client.ts
+class StorageClient {
+    /** @internal */
+    constructor(integrationId = 'built_in_storage', rpcManager) {
+        this.integrationId = integrationId;
+        this.rpcManager = rpcManager;
+    }
+    async uploadFile(pathInBucket, file, expirationInSeconds) {
+        const request = {
+            integrationId: this.integrationId,
+            pathInBucket,
+            expirationInSeconds,
+        };
+        await this.rpcManager.post('storage/uploadFile', request, [file]);
+    }
+    async getFileMetadata(pathInBucket) {
+        const request = {
+            integrationId: this.integrationId,
+            pathInBucket,
+        };
+        return await this.rpcManager.post('storage/getFileMetadata', request);
+    }
+    async getDownloadUrl(pathInBucket, urlExpirationInSeconds) {
+        const request = {
+            integrationId: this.integrationId,
+            pathInBucket,
+            urlExpirationInSeconds,
+        };
+        return await this.rpcManager.post('storage/getDownloadUrl', request);
+    }
+    async listDirectoryContents(pathInBucket) {
+        const request = {
+            integrationId: this.integrationId,
+            pathInBucket,
+        };
+        return await this.rpcManager.post('storage/listDirectoryContents', request);
+    }
+    async deleteFile(pathInBucket) {
+        await this.deleteFiles([pathInBucket]);
+    }
+    async deleteFiles(pathsInBucket) {
+        const request = {
+            integrationId: this.integrationId,
+            pathsInBucket,
+        };
+        await this.rpcManager.post('storage/deleteFiles', request);
+    }
+}
+
 ;// CONCATENATED MODULE: ./src/squid.ts
 
 
@@ -51749,6 +51899,7 @@ function omitSquidDevId(appId) {
 
 
 
+
 
 
 /**
@@ -51923,12 +52074,13 @@ class Squid {
      * @param endpointId The id of the endpoint in the API integration.
      * @param request The request parameters to pass to the API.
      * @param options optional options for the API call.
+     * @param file optional file to pass in as part of the API
      * @returns A promise that resolves with the response of the API.
      * @typeParam T The type of the response of the API.
      */
-    callApi(integrationId, endpointId, request = {}, options) {
+    callApi(integrationId, endpointId, request = {}, options, file) {
         this._validateNotDestructed();
-        return (0,external_rxjs_.firstValueFrom)(this.apiManager.callApiAndSubscribe(integrationId, endpointId, request, options || {}));
+        return (0,external_rxjs_.firstValueFrom)(this.apiManager.callApiAndSubscribe(integrationId, endpointId, request, options || {}, file));
     }
     /**
      * Returns a GraphQL client for the given integration. The GraphQL client can be used to execute GraphQL queries and
@@ -51955,6 +52107,10 @@ class Squid {
         this._validateNotDestructed();
         return this.apiClient;
     }
+    storage(integrationId = 'built_in_storage') {
+        this._validateNotDestructed();
+        return new StorageClient(integrationId, this.rpcManager);
+    }
     get secrets() {
         return this.secretClient;
     }
@@ -51969,6 +52125,23 @@ class Squid {
         this._validateNotDestructed();
         return this.distributedLockManager.lock(mutex);
     }
+    /**
+     * 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.
+     */
+    async withLock(mutex, fn) {
+        const lock = await this.acquireLock(mutex);
+        try {
+            return await fn(lock);
+        }
+        finally {
+            void lock.release();
+        }
+    }
     /**
      * Returns a queue manager for the given topic name and integration id. Using the queue manager you can consume and
      * produce messages
@@ -52050,6 +52223,7 @@ Squid.squidInstancesMap = {};
 
 
 
+
 
 
 })();

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,12 @@ 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;
 /** 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.190",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",