@squidcloud/client 1.0.152 → 1.0.154

package/dist/cjs/index.js

@@ -7041,8 +7041,10 @@ function assertObject(value, objectAssertion, errorContextProvider = undefined,
     assertTruthy(!Array.isArray(value), () => errorWithContext(`is an array.`));
     const assertionEntries = Object.entries(objectAssertion);
     if (constraints.failOnUnknownFields) {
+        const allowedUnknownFieldNames = constraints.allowedUnknownFieldNames || [];
         for (const objectFieldName in value) {
-            assertTruthy(assertionEntries.some(([assertionFieldName]) => objectFieldName === assertionFieldName), errorWithContext(`property can't be checked: ${objectFieldName}`));
+            const skipUnknownFieldCheck = allowedUnknownFieldNames.includes(objectFieldName);
+            assertTruthy(skipUnknownFieldCheck || assertionEntries.some(([assertionFieldName]) => objectFieldName === assertionFieldName), errorWithContext(`property can't be checked: ${objectFieldName}`));
         }
     }
     let $o;
@@ -7121,7 +7123,7 @@ exports.callValueAssertion = callValueAssertion;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.stringAssertion = exports.nullOr = exports.undefinedOr = exports.valueOr = exports.$a = exports.arrayAssertion = exports.objectAssertion = void 0;
+exports.stringAssertion = exports.nullOr = exports.undefinedOr = exports.valueOr = exports.$u = exports.$a = exports.arrayAssertion = exports.objectAssertion = void 0;
 const Assertion_1 = __webpack_require__(6676);
 const AssertionsLib_1 = __webpack_require__(4356);
 /** A shortcut to build new object type assertion. */
@@ -7159,6 +7161,16 @@ function $a(check, errorMessageProvider) {
     });
 }
 exports.$a = $a;
+/**
+ * Creates a new value assertion using *check* function.
+ * The assertion accepts the value as valid if 'check(value)' returns true or throws an error otherwise.
+ *
+ * Note: same as `$a` but forces processing of the check function argument as `unknown`.
+ */
+function $u(check, errorMessageProvider) {
+    return $a(check, errorMessageProvider);
+}
+exports.$u = $u;
 /**
  *  Creates an assertion that makes comparison by reference with the *expectedValue* before calling *orAssertion*.
  *  If comparison with the *expectedValue* succeeds, does not call the *orAssertion*.
@@ -7203,7 +7215,7 @@ exports.stringAssertion = stringAssertion;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.assertNonNullable = exports.assertEmail = exports.assertHexString = exports.assertUuid = exports.assertBoolean = exports.assertNumber = exports.assertString = exports.formatError = void 0;
+exports.assertNonNullable = exports.assertDate = exports.assertEmail = exports.assertHexString = exports.assertUuid = exports.assertBoolean = exports.assertNumber = exports.assertString = exports.formatError = void 0;
 const Assertion_1 = __webpack_require__(6676);
 const ChecksLib_1 = __webpack_require__(9862);
 function formatError(contextProvider, message, value) {
@@ -7244,6 +7256,11 @@ const assertEmail = (value, context = undefined) => {
     (0, Assertion_1.assertTruthy)((0, ChecksLib_1.isEmail)(value), () => formatError(context, 'Invalid email', value));
 };
 exports.assertEmail = assertEmail;
+/** Asserts that the `value` type is a `Date` object. */
+const assertDate = (value, context = undefined) => {
+    (0, Assertion_1.assertTruthy)(value instanceof Date, () => formatError(context, 'Invalid Date', value));
+};
+exports.assertDate = assertDate;
 function assertNonNullable(value, context) {
     (0, Assertion_1.assertTruthy)((0, ChecksLib_1.isNonNullable)(value), () => formatError(context, `Value is ${value === undefined ? 'undefined' : 'null'}`, value));
 }
@@ -7258,25 +7275,30 @@ exports.assertNonNullable = assertNonNullable;
 "use strict";
 
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.isNonNullable = exports.isHexString = exports.isUuid = exports.isEmail = exports.checkArrayHasUniqueElements = exports.isNumber = exports.isString = exports.isBoolean = void 0;
-/** Returns *true* if the value is *boolean*. */
+exports.isNonNullable = exports.isHexString = exports.isUuid = exports.isEmail = exports.checkArraysHasEqualElementsByComparator = exports.checkArraysHaveEqualElements = exports.checkArrayHasUniqueElements = exports.isDate = exports.isNumber = exports.isString = exports.isBoolean = void 0;
+/** Returns `true` if the value is `boolean`. */
 function isBoolean(value) {
     return typeof value === 'boolean';
 }
 exports.isBoolean = isBoolean;
-/** Returns *true* if the value is *string*. */
+/** Returns `true` if the value is `string`. */
 function isString(value) {
     return typeof value === 'string';
 }
 exports.isString = isString;
-/** Returns *true* if the value is *number*. */
+/** Returns `true` if the value is `number`. */
 function isNumber(value) {
     return typeof value === 'number';
 }
 exports.isNumber = isNumber;
+/** Returns `true` if the value is `Date` object. */
+function isDate(value) {
+    return value instanceof Date;
+}
+exports.isDate = isDate;
 /**
  * Checks that array has only unique elements.
- * Uses 'identity' function to perform checks.
+ * Uses `identity` function to perform checks.
  */
 function checkArrayHasUniqueElements(array, identity) {
     if (array.length <= 1) {
@@ -7293,6 +7315,38 @@ function checkArrayHasUniqueElements(array, identity) {
     return true;
 }
 exports.checkArrayHasUniqueElements = checkArrayHasUniqueElements;
+/**
+ * Checks if two arrays have equal elements.
+ * Compares elements with by reference.
+ * See `checkArraysHasEqualElementsByComparator` if you need to use a custom comparator.
+ */
+function checkArraysHaveEqualElements(array1, array2) {
+    return checkArraysHasEqualElementsByComparator(array1, array2, (e1, e2) => e1 === e2);
+}
+exports.checkArraysHaveEqualElements = checkArraysHaveEqualElements;
+/**
+ * Checks that two arrays have equal elements.
+ * Returns `true` if all elements and their indexes are equal or false otherwise.
+ * Uses `comparator` to compare the elements.
+ */
+function checkArraysHasEqualElementsByComparator(array1, array2, comparator) {
+    if (array1 === array2) {
+        return true;
+    }
+    if (!array1 || !array2) {
+        return false;
+    }
+    if (array1.length !== array2.length) {
+        return false;
+    }
+    for (let i = 0; i < array1.length; i++) {
+        if (!comparator(array1[i], array2[i])) {
+            return false;
+        }
+    }
+    return true;
+}
+exports.checkArraysHasEqualElementsByComparator = checkArraysHasEqualElementsByComparator;
 const EMAIL_REGEX_REGULAR = /^[-!#$%&'*+/\d=?A-Z^_a-z{|}~](\.?[-!#$%&'*+/\d=?A-Z^_a-z`{|}~])*@[a-zA-Z0-9](-*\.?[a-zA-Z\d])*\.[a-zA-Z](-?[a-zA-Z\d])+$/;
 // eslint-disable-next-line no-misleading-character-class
 const EMAIL_REGEX_INTERNATIONAL = /^(?!\.)((?!.*\.{2})[a-zA-Z0-9\u0080-\u00FF\u0100-\u017F\u0180-\u024F\u0250-\u02AF\u0300-\u036F\u0370-\u03FF\u0400-\u04FF\u0500-\u052F\u0530-\u058F\u0590-\u05FF\u0600-\u06FF\u0700-\u074F\u0750-\u077F\u0780-\u07BF\u07C0-\u07FF\u0900-\u097F\u0980-\u09FF\u0A00-\u0A7F\u0A80-\u0AFF\u0B00-\u0B7F\u0B80-\u0BFF\u0C00-\u0C7F\u0C80-\u0CFF\u0D00-\u0D7F\u0D80-\u0DFF\u0E00-\u0E7F\u0E80-\u0EFF\u0F00-\u0FFF\u1000-\u109F\u10A0-\u10FF\u1100-\u11FF\u1200-\u137F\u1380-\u139F\u13A0-\u13FF\u1400-\u167F\u1680-\u169F\u16A0-\u16FF\u1700-\u171F\u1720-\u173F\u1740-\u175F\u1760-\u177F\u1780-\u17FF\u1800-\u18AF\u1900-\u194F\u1950-\u197F\u1980-\u19DF\u19E0-\u19FF\u1A00-\u1A1F\u1B00-\u1B7F\u1D00-\u1D7F\u1D80-\u1DBF\u1DC0-\u1DFF\u1E00-\u1EFF\u1F00-\u1FFF\u20D0-\u20FF\u2100-\u214F\u2C00-\u2C5F\u2C60-\u2C7F\u2C80-\u2CFF\u2D00-\u2D2F\u2D30-\u2D7F\u2D80-\u2DDF\u2F00-\u2FDF\u2FF0-\u2FFF\u3040-\u309F\u30A0-\u30FF\u3100-\u312F\u3130-\u318F\u3190-\u319F\u31C0-\u31EF\u31F0-\u31FF\u3200-\u32FF\u3300-\u33FF\u3400-\u4DBF\u4DC0-\u4DFF\u4E00-\u9FFF\uA000-\uA48F\uA490-\uA4CF\uA700-\uA71F\uA800-\uA82F\uA840-\uA87F\uAC00-\uD7AF\uF900-\uFAFF.!#$%&'*+-/=?^_`{|}~\-\d]+)@(?!\.)([a-zA-Z0-9\u0080-\u00FF\u0100-\u017F\u0180-\u024F\u0250-\u02AF\u0300-\u036F\u0370-\u03FF\u0400-\u04FF\u0500-\u052F\u0530-\u058F\u0590-\u05FF\u0600-\u06FF\u0700-\u074F\u0750-\u077F\u0780-\u07BF\u07C0-\u07FF\u0900-\u097F\u0980-\u09FF\u0A00-\u0A7F\u0A80-\u0AFF\u0B00-\u0B7F\u0B80-\u0BFF\u0C00-\u0C7F\u0C80-\u0CFF\u0D00-\u0D7F\u0D80-\u0DFF\u0E00-\u0E7F\u0E80-\u0EFF\u0F00-\u0FFF\u1000-\u109F\u10A0-\u10FF\u1100-\u11FF\u1200-\u137F\u1380-\u139F\u13A0-\u13FF\u1400-\u167F\u1680-\u169F\u16A0-\u16FF\u1700-\u171F\u1720-\u173F\u1740-\u175F\u1760-\u177F\u1780-\u17FF\u1800-\u18AF\u1900-\u194F\u1950-\u197F\u1980-\u19DF\u19E0-\u19FF\u1A00-\u1A1F\u1B00-\u1B7F\u1D00-\u1D7F\u1D80-\u1DBF\u1DC0-\u1DFF\u1E00-\u1EFF\u1F00-\u1FFF\u20D0-\u20FF\u2100-\u214F\u2C00-\u2C5F\u2C60-\u2C7F\u2C80-\u2CFF\u2D00-\u2D2F\u2D30-\u2D7F\u2D80-\u2DDF\u2F00-\u2FDF\u2FF0-\u2FFF\u3040-\u309F\u30A0-\u30FF\u3100-\u312F\u3130-\u318F\u3190-\u319F\u31C0-\u31EF\u31F0-\u31FF\u3200-\u32FF\u3300-\u33FF\u3400-\u4DBF\u4DC0-\u4DFF\u4E00-\u9FFF\uA000-\uA48F\uA490-\uA4CF\uA700-\uA71F\uA800-\uA82F\uA840-\uA87F\uAC00-\uD7AF\uF900-\uFAFF\-.\d]+)((\.([a-zA-Z\u0080-\u00FF\u0100-\u017F\u0180-\u024F\u0250-\u02AF\u0300-\u036F\u0370-\u03FF\u0400-\u04FF\u0500-\u052F\u0530-\u058F\u0590-\u05FF\u0600-\u06FF\u0700-\u074F\u0750-\u077F\u0780-\u07BF\u07C0-\u07FF\u0900-\u097F\u0980-\u09FF\u0A00-\u0A7F\u0A80-\u0AFF\u0B00-\u0B7F\u0B80-\u0BFF\u0C00-\u0C7F\u0C80-\u0CFF\u0D00-\u0D7F\u0D80-\u0DFF\u0E00-\u0E7F\u0E80-\u0EFF\u0F00-\u0FFF\u1000-\u109F\u10A0-\u10FF\u1100-\u11FF\u1200-\u137F\u1380-\u139F\u13A0-\u13FF\u1400-\u167F\u1680-\u169F\u16A0-\u16FF\u1700-\u171F\u1720-\u173F\u1740-\u175F\u1760-\u177F\u1780-\u17FF\u1800-\u18AF\u1900-\u194F\u1950-\u197F\u1980-\u19DF\u19E0-\u19FF\u1A00-\u1A1F\u1B00-\u1B7F\u1D00-\u1D7F\u1D80-\u1DBF\u1DC0-\u1DFF\u1E00-\u1EFF\u1F00-\u1FFF\u20D0-\u20FF\u2100-\u214F\u2C00-\u2C5F\u2C60-\u2C7F\u2C80-\u2CFF\u2D00-\u2D2F\u2D30-\u2D7F\u2D80-\u2DDF\u2F00-\u2FDF\u2FF0-\u2FFF\u3040-\u309F\u30A0-\u30FF\u3100-\u312F\u3130-\u318F\u3190-\u319F\u31C0-\u31EF\u31F0-\u31FF\u3200-\u32FF\u3300-\u33FF\u3400-\u4DBF\u4DC0-\u4DFF\u4E00-\u9FFF\uA000-\uA48F\uA490-\uA4CF\uA700-\uA71F\uA800-\uA82F\uA840-\uA87F\uAC00-\uD7AF\uF900-\uFAFF]){2,63})+)$/i;
@@ -36769,9 +36823,9 @@ function sortKeys(json) {
     return result;
 }
 function serialization_normalizeJsonAsString(json) {
-    return serialization_serializeObj(sortKeys(json));
+    return serializeObj(sortKeys(json));
 }
-function serialization_serializeObj(obj) {
+function serializeObj(obj) {
     if (obj === undefined)
         return null; // TODO: change method signature.
     const objWithReplacedDates = lodash.cloneDeepWith(obj, value => {
@@ -36790,7 +36844,7 @@ function deserializeObj(str) {
 function encodeValueForMapping(value) {
     if (value === undefined)
         throw new Error('INVALID_ENCODE_VALUE');
-    const serializedValue = serialization_serializeObj(value);
+    const serializedValue = serializeObj(value);
     if (typeof Buffer !== 'undefined') {
         // Node.js
         return Buffer.from(serializedValue, 'utf8').toString('base64');
@@ -37389,6 +37443,7 @@ function replaceKeyInRecord(record, a, b) {
 
 
 
+
 class Pagination {
     /** @internal */
     constructor(snapshotEmitter, options = {}) {
@@ -37419,6 +37474,7 @@ class Pagination {
          */
         this.navigatingToLastPage = false;
         this.lastElement = null;
+        (0,dist.assertTruthy)(snapshotEmitter.getSortOrders().length > 0, 'Unable to paginate results. Please specify a sort order.');
         this.snapshotSubject.pipe((0,external_rxjs_.switchAll)()).subscribe(data => this.dataReceived(data));
         this.templateSnapshotEmitter = snapshotEmitter.clone();
         this.options = Object.assign({ pageSize: 100, subscribe: true }, options);
@@ -37654,7 +37710,6 @@ class Pagination {
 
 
 
-
 /** @internal */
 const ExecuteFunctionSecureAnnotations = (/* unused pure expression or super */ null && ([
     'secureDistributedLock',
@@ -37711,7 +37766,7 @@ function transformResponse(functionResponse, executeFunctionAnnotationType) {
             'content-type': isStringOrNullBody ? 'text/plain' : 'application/json',
             'cache-control': 'no-cache',
         };
-        const body = isStringOrNullBody ? functionResponse || '' : serializeObj(functionResponse);
+        const body = isStringOrNullBody ? functionResponse || '' : JSON.stringify(functionResponse);
         // noinspection UnnecessaryLocalVariableJS
         const webhookResponse = {
             headers,
@@ -37720,6 +37775,26 @@ function transformResponse(functionResponse, executeFunctionAnnotationType) {
         };
         return webhookResponse;
     }
+    if (executeFunctionAnnotationType === 'openapi') {
+        if (isOpenApiResponse(functionResponse)) {
+            delete functionResponse['__isOpenApiResponse__'];
+            return functionResponse;
+        }
+        functionResponse = functionResponse !== null && functionResponse !== void 0 ? functionResponse : null;
+        const isStringOrNullBody = functionResponse === null || typeof functionResponse === 'string';
+        const headers = {
+            'content-type': isStringOrNullBody ? 'text/plain' : 'application/json',
+            'cache-control': 'no-cache',
+        };
+        const body = isStringOrNullBody ? functionResponse || '' : JSON.stringify(functionResponse);
+        // noinspection UnnecessaryLocalVariableJS
+        const openApiResponse = {
+            headers,
+            body,
+            statusCode: functionResponse === null ? 204 : 200,
+        };
+        return openApiResponse;
+    }
     return functionResponse;
 }
 function convertToRunSecrets(appSecrets) {
@@ -37735,6 +37810,9 @@ function convertToRunSecrets(appSecrets) {
 function isWebhookResponse(response) {
     return response && response.__isWebhookResponse__;
 }
+function isOpenApiResponse(response) {
+    return response && response.__isOpenApiResponse__;
+}
 
 ;// CONCATENATED MODULE: ../common/src/communication.types.ts
 /**
@@ -38839,6 +38917,8 @@ const kotlinControllers = [
     'quota',
     'named-query',
     'native-query',
+    'application-kotlin',
+    'openapi',
 ];
 function getApplicationUrl(regionPrefix, appId, path) {
     const baseUrl = 'https://squid.cloud';
@@ -39129,6 +39209,8 @@ function createWebSocketWrapper(url, opts = {}) {
 
 
 
+
+
 
 
 
@@ -40197,7 +40279,7 @@ class JoinQueryBuilder extends BaseQueryBuilder {
         return this;
     }
     extractData(data) {
-        return data[this.rootAlias].data;
+        return data[this.rootAlias].dataRef;
     }
     serialize() {
         return {
@@ -40424,10 +40506,10 @@ class GroupedJoin {
          * value is the document/document reference
          */
         if (Object.keys(this.joinQueryBuilder.leftToRight).length > 1) {
-            return data[this.joinQueryBuilder.rootAlias].data;
+            return data[this.joinQueryBuilder.rootAlias].dataRef;
         }
         else {
-            return data.data;
+            return data.dataRef;
         }
     }
     serialize() {
@@ -40699,6 +40781,16 @@ class DocumentReference {
      * @throws Error if the document does not exist.
      */
     get data() {
+        return lodash.cloneDeep(this.dataRef);
+    }
+    /**
+     * Returns a read-only internal copy of the document data. This works similar to `this.data`, except it does not
+     * perform a defensive copy. The caller may not modify this object, on penalty of unexpected behavior.
+     *
+     * @returns The document data.
+     * @throws Error if the document does not exist.
+     */
+    get dataRef() {
         const getError = () => {
             const { collectionName, integrationId, docId } = parseSquidDocId(this.squidDocId);
             return `No data found for document reference: ${JSON.stringify({
@@ -40707,7 +40799,7 @@ class DocumentReference {
                 integrationId,
             }, null, 2)}`;
         };
-        return (0,dist.truthy)(this.dataManager.getProperties(this.squidDocId), getError());
+        return (0,dist.truthy)(this.dataManager.getProperties(this.squidDocId), getError);
     }
     /**
      * Returns whether data has been populated for this document reference. Data
@@ -41173,7 +41265,7 @@ class QueryBuilder extends BaseQueryBuilder {
             else {
                 for (const docAfter of data) {
                     const squidDocId = docAfter.squidDocId;
-                    const docAfterData = docAfter.data;
+                    const docAfterData = docAfter.dataRef;
                     if (beforeDocSet.has(docAfterData)) {
                         delete beforeDocMap[squidDocId];
                         beforeDocSet.delete(docAfterData);
@@ -41196,7 +41288,7 @@ class QueryBuilder extends BaseQueryBuilder {
             beforeDocMap = {};
             beforeDocSet = new Set();
             for (const afterDoc of data) {
-                const afterDocData = afterDoc.data;
+                const afterDocData = afterDoc.dataRef;
                 beforeDocMap[afterDoc.squidDocId] = afterDocData;
                 beforeDocSet.add(afterDocData);
             }
@@ -41226,6 +41318,9 @@ class QueryBuilder extends BaseQueryBuilder {
         return res;
     }
     addCompositeCondition(conditions) {
+        if (!conditions.length) {
+            return this;
+        }
         this.query.conditions.push({ fields: conditions });
         return this;
     }
@@ -41246,7 +41341,7 @@ class QueryBuilder extends BaseQueryBuilder {
         };
     }
     extractData(data) {
-        return data.data;
+        return data.dataRef;
     }
     paginate(options) {
         return new Pagination(this, options);
@@ -41799,7 +41894,7 @@ class BackendFunctionManager {
     executeFunctionAndSubscribe(functionName, ...params) {
         const request = {
             functionName,
-            paramsArrayStr: serialization_serializeObj(params),
+            paramsArrayStr: serializeObj(params),
         };
         return (0,external_rxjs_.race)((0,external_rxjs_.from)(this.rpcManager.post('backend-function/execute', request)).pipe(map_map(response => {
             if (!response.success) {
@@ -57283,7 +57378,7 @@ class RpcManager {
                         const filename = file instanceof Blob ? undefined : file.name;
                         formData.append(filesFieldName, blob, filename);
                     });
-                    formData.append('body', serialization_serializeObj(message));
+                    formData.append('body', serializeObj(message));
                     // Make the axios call
                     axiosResponse = await external_axios_default().post(url, formData, {
                         headers: Object.assign({}, headers),
@@ -57291,7 +57386,7 @@ class RpcManager {
                     });
                 }
                 else {
-                    axiosResponse = await external_axios_default().post(url, serialization_serializeObj(message), {
+                    axiosResponse = await external_axios_default().post(url, serializeObj(message), {
                         headers: Object.assign(Object.assign({}, headers), { 'Content-Type': 'application/json' }),
                         responseType: 'text',
                     });
@@ -57504,7 +57599,7 @@ class SocketManager {
         }
         try {
             (0,dist.assertTruthy)(this.socket, 'Socket is undefined in sendMessageAsync');
-            this.socket.send(serialization_serializeObj({ message, authToken }));
+            this.socket.send(serializeObj({ message, authToken }));
         }
         catch (e) {
             if (!((_a = this.socket) === null || _a === void 0 ? void 0 : _a.connected)) {
@@ -57523,7 +57618,7 @@ class SocketManager {
         if (!((_a = this.socket) === null || _a === void 0 ? void 0 : _a.connected))
             return;
         const message = { type: 'kill' };
-        this.socket.send(serialization_serializeObj({ message }));
+        this.socket.send(serializeObj({ message }));
     }
     connect() {
         var _a;

package/dist/common/src/application.types.d.ts

@@ -104,6 +104,11 @@ export interface CreateEnvironmentRequest {
     sourceAppId: AppId;
     environmentId: EnvironmentId;
 }
+export interface UpdateApplicationCodeRequest {
+    appId: AppId;
+    openApiSpecStr?: string;
+    openApiControllersStr?: string;
+}
 interface BaseUpsertIntegrationRequest<T extends IntegrationTypeWithConfig, C extends IntegrationConfig> {
     id: IntegrationId;
     type: T;

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

@@ -30,8 +30,8 @@ export interface TriggerRequest<T extends DocumentData = any> {
 export type SchedulerAction = () => void | Promise<void>;
 export type WebhookAction = ((request: WebhookRequest) => any) | (() => any);
 /** The context provided to a webhook function. */
-export interface WebhookRequest {
-    body: any;
+export interface WebhookRequest<T = any> {
+    body: T;
     rawBody?: string;
     queryParams: Record<string, string>;
     headers: Record<string, string>;

package/dist/common/src/bundle-data.types.d.ts

@@ -2,4 +2,8 @@
 export type DatabaseActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
 /** The different types of actions that can be performed on an AI chatbot. */
 export type AiChatbotActionType = 'chat' | 'mutate' | 'all';
+export interface LocalBackendData {
+    applicationBundleData: ApplicationBundleData;
+    openApiSpecStr?: string;
+}
 export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date';

package/dist/common/src/index.d.ts

@@ -14,6 +14,7 @@ export * from './communication.types';
 export * from './context.types';
 export * from './distributed-lock.context';
 export * from './document.types';
+export * from './openapi.types';
 export * from './graphql.context';
 export * from './graphql.types';
 export * from './http-status.enum';
@@ -49,6 +50,7 @@ export * from './utils/transforms';
 export * from './utils/url';
 export * from './utils/validation';
 export * from './webhook-response';
+export * from './openapi-response';
 export * from './heartbeat.types';
 export * from './utils/global.utils';
 export * from './websocket.impl';

package/dist/common/src/openapi-response.d.ts

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

package/dist/common/src/openapi.types.d.ts

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

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

@@ -24,6 +24,14 @@ export declare class DocumentReference<T extends DocumentData = any> {
      * @throws Error if the document does not exist.
      */
     get data(): T;
+    /**
+     * Returns a read-only internal copy of the document data. This works similar to `this.data`, except it does not
+     * perform a defensive copy. The caller may not modify this object, on penalty of unexpected behavior.
+     *
+     * @returns The document data.
+     * @throws Error if the document does not exist.
+     */
+    get dataRef(): T;
     /**
      * Returns whether data has been populated for this document reference. Data
      * will not present if a document has not been queried, does not exist, or

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.152",
+  "version": "1.0.154",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",
@@ -33,7 +33,7 @@
   "license": "ISC",
   "dependencies": {
     "@apollo/client": "^3.7.4",
-    "@squidcloud/common": "1.0.152",
+    "@squidcloud/common": "^1.0.154",
     "@supercharge/promise-pool": "^2.3.2",
     "axios": "^1.6.2",
     "cross-fetch": "^3.1.5",