@squidcloud/client 1.0.188 → 1.0.190

package/dist/typescript-client/src/query/snapshot-emitter.d.ts

@@ -0,0 +1,34 @@
+import { Observable } from 'rxjs';
+import { Pagination, PaginationOptions } from './pagination';
+export interface SnapshotEmitter<ReturnType> {
+    /**
+     * Returns a promise that resolves to the query results.
+     *
+     * @returns A promise that resolves to the query results.
+     */
+    snapshot(): Promise<Array<ReturnType>>;
+    /**
+     * Returns an observable that emits the query results and updates whenever the query results change unless
+     * `subscribe=false` is provided.
+     *
+     * Important: Make sure to unsubscribe from the observable when you are done with it.
+     *
+     * @param subscribe Whether to subscribe to changes to the query results. Defaults to `true`.
+     * @returns An observable for the query results.
+     */
+    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
+    /**
+     * Returns the results of the query based on the data that is currently available on the client. This method is useful
+     * for synchronously accessing data that has already been fetched by another query. The method will return an empty
+     * array if data has not yet been populated.
+     *
+     * @returns An array of query results.
+     */
+    peek(): Array<ReturnType>;
+    limit(limit: number): SnapshotEmitter<ReturnType>;
+    /**
+     * Returns a pagination wrapper for this query.
+     * @param options The pagination options. Defaults to `{ subscribe: true, pageSize: 100 }`.
+     */
+    paginate(options?: Partial<PaginationOptions>): Pagination<ReturnType>;
+}

package/dist/typescript-client/src/rate-limiter.d.ts

@@ -1,32 +1 @@
-export declare class RateLimiter {
-    private readonly capacity;
-    private readonly seconds;
-    private tokens;
-    private lastRefillTimestamp;
-    private readonly refillRatePerMs;
-    /**
-     * Creates a new rate limiter. It limits the number of requests using two parameters:
-     * - capacity: the maximum number of tokens (actions) that can be stored at any given time
-     * - seconds: the number of seconds it takes to refill the bucket to its maximum capacity
-     *
-     * We then can calculate the refillRatePerMs: the number of tokens (actions) that are added to the bucket every
-     * millisecond
-     *
-     * Example:
-     * Say we want to allow maximum 60 requests in a period of 5 seconds. We can create a rate limiter with:
-     * - capacity: 60
-     * - seconds: 5
-     * And we will get refillRatePerMs: 60 / (5 * 1000) = 0.012
-     *
-     * To use:
-     * const rateLimiter = new RateLimiter(60, 5);
-     * await rateLimiter.consume();
-     *
-     * @param capacity
-     * @param refillRatePerMs
-     */
-    constructor(capacity: number, seconds: number);
-    consume(): Promise<void>;
-    private attemptConsume;
-    private refill;
-}
+export {};

package/dist/typescript-client/src/rpc.manager.d.ts

@@ -1,24 +1 @@
-import { AuthManager } from './auth.manager';
-import { ClientIdService } from './client-id.service';
-import { DestructManager } from './destruct.manager';
-import { BlobAndFilename } from './types';
-import { SquidRegion } from './public-types';
-import { HttpResponse } from './squid-http-client';
-export declare class RpcManager {
-    private readonly region;
-    private readonly appId;
-    private readonly authManager;
-    private readonly clientIdService;
-    private readonly staticHeaders;
-    private readonly onGoingRpcCounter;
-    private readonly rateLimiters;
-    constructor(region: SquidRegion, appId: string, destructManager: DestructManager, headers: Record<string, string>, authManager: AuthManager, clientIdService: ClientIdService);
-    private getAuthHeaders;
-    awaitAllSettled(): Promise<void>;
-    setStaticHeader(key: string, value: string): void;
-    deleteStaticHeader(key: string): void;
-    getStaticHeaders(): Record<string, string>;
-    post<ResponseType = unknown, RequestType = unknown>(path: string, message: RequestType, files?: Array<File | BlobAndFilename>, filesFieldName?: string): Promise<ResponseType>;
-    rawPost<ResponseType = unknown, RequestType = unknown>(path: string, message: RequestType, files?: Array<File | BlobAndFilename>, filesFieldName?: string, extractErrorMessage?: boolean): Promise<HttpResponse<ResponseType>>;
-    private getRateLimiterBucket;
-}
+export {};

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

@@ -1,8 +1,6 @@
 import { SecretEntry, SecretKey, SecretValue, SetSecretRequestEntry } from './public-types';
-import { RpcManager } from './rpc.manager';
 export declare class SecretClient {
     private readonly rpcManager;
-    constructor(rpcManager: RpcManager);
     get(key: SecretKey): Promise<SecretEntry | undefined>;
     getAll(): Promise<Record<SecretKey, SecretEntry>>;
     upsert(key: SecretKey, value: SecretValue): Promise<SecretEntry>;
@@ -11,12 +9,10 @@ export declare class SecretClient {
     deleteMany(keys: Array<SecretKey>): Promise<void>;
     get apiKeys(): ApiKeysSecretClient;
 }
-declare class ApiKeysSecretClient {
+export declare class ApiKeysSecretClient {
     private readonly rpcManager;
-    constructor(rpcManager: RpcManager);
     get(key: SecretKey): Promise<SecretEntry | undefined>;
     getAll(): Promise<Record<SecretKey, SecretEntry>>;
     upsert(key: SecretKey): Promise<SecretEntry>;
     delete(key: SecretKey): Promise<void>;
 }
-export {};

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

@@ -1,4 +1,3 @@
-import { BlobAndFilename } from './types';
 export declare class RpcError<BodyType = unknown> extends Error {
     readonly statusCode: number;
     readonly statusText: string;
@@ -6,14 +5,6 @@ export declare class RpcError<BodyType = unknown> extends Error {
     readonly headers: Record<string, string>;
     readonly body: BodyType;
 }
-export interface HttpPostInput<RequestBodyType = unknown> {
-    url: string;
-    headers: Record<string, string>;
-    message: RequestBodyType;
-    files: Array<File | BlobAndFilename>;
-    filesFieldName: string;
-    extractErrorMessage: boolean;
-}
 /** A response object with type T for the body. */
 export interface HttpResponse<BodyType = unknown> {
     status: number;

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.188",
+  "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",

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

@@ -1,147 +0,0 @@
-import { Observable } from 'rxjs';
-import { SerializedQuery } from './serialized-query.public-types';
-import { Pagination, PaginationOptions } from './pagination.public-types';
-import { Operator } from './query.public-types';
-import { DocumentData, FieldName, PrimitiveFieldType } from './document.public-types';
-export interface SnapshotEmitter<ReturnType> {
-    /**
-     * Returns a promise that resolves to the query results.
-     *
-     * @returns A promise that resolves to the query results.
-     */
-    snapshot(): Promise<Array<ReturnType>>;
-    /**
-     * Returns an observable that emits the query results and updates whenever the query results change unless
-     * `subscribe=false` is provided.
-     *
-     * Important: Make sure to unsubscribe from the observable when you are done with it.
-     *
-     * @param subscribe Whether to subscribe to changes to the query results. Defaults to `true`.
-     * @returns An observable for the query results.
-     */
-    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
-    /**
-     * Returns the results of the query based on the data that is currently available on the client. This method is useful
-     * for synchronously accessing data that has already been fetched by another query. The method will return an empty
-     * array if data has not yet been populated.
-     *
-     * @returns An array of query results.
-     */
-    peek(): Array<ReturnType>;
-    limit(limit: number): SnapshotEmitter<ReturnType>;
-    /**
-     * Returns a pagination wrapper for this query.
-     * @param options The pagination options. Defaults to `{ subscribe: true, pageSize: 100 }`.
-     */
-    paginate(options?: Partial<PaginationOptions>): Pagination<ReturnType>;
-    serialize(): SerializedQuery;
-}
-/** Query builder base class. */
-export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
-    /**
-     * Adds a condition to the query.
-     * @param fieldName The name of the field to query.
-     * @param operator The operator to use.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    abstract where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, '==', value)
-     *
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '!=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, 'in', value)
-     * @param fieldName The name of the field to query.
-     * @param value An array of values to compare against.
-     * @returns The query builder.
-     */
-    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, 'not in', value)
-     * @param fieldName The name of the field to query.
-     * @param value An array of values to compare against.
-     * @returns The query builder.
-     */
-    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /**
-     * A shortcut for where(fieldName, '>', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '>=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '<', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * A shortcut for where(fieldName, '<=', value)
-     * @param fieldName The name of the field to query.
-     * @param value The value to compare against.
-     * @returns The query builder.
-     */
-    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /**
-     * 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 caseSensitive Whether to use case-sensitive comparison. Defaults to true.
-     * @returns The query builder.
-     */
-    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /**
-     * 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 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;
-    /**
-     * 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.
-     * @param limit The limit to set.
-     * @returns The query builder.
-     */
-    abstract limit(limit: number): this;
-    /**
-     * Adds a sort order to the query. You can add multiple sort orders to the query. The order in which you add them
-     * determines the order in which they are applied.
-     * @param fieldName The name of the field to sort by.
-     * @param asc Whether to sort in ascending order. Defaults to true.
-     * @returns The query builder.
-     */
-    abstract sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
-}
-export interface HasDereference {
-    /**
-     * Dereferences the document references in the result of this query. For example, collection.query().snapshot()
-     * returns an array of DocumentReference objects, but collection.query().dereference().snapshot() returns an array of
-     * the actual document data.
-     */
-    dereference(): any;
-}