@squidcloud/client 1.0.73 → 1.0.74

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

@@ -1,3 +1,4 @@
+import { AppId, ClientId } from './communication.types';
 export type AuthType = 'Bearer' | 'ApiKey';
 /**
  * The payload of a JWT token in case an auth token was used.
@@ -22,11 +23,18 @@ export interface AuthToken {
     token: string;
     integrationId?: string;
 }
-/**
- * The context of a request to a service.
- */
+/** The context of a request to a service. */
 export interface RunContext {
-    appId: string;
+    /** Your applicationId. */
+    appId: AppId;
+    /**
+     * The id of the client that initiated this request. This is only relevant in cases that the request was initiated by
+     * a client such as when securing an api call or a DB operation. This id will not be available for triggers,
+     * schedulers, webhooks and other functions that are not directly initiated by a user action.
+     */
+    clientId?: ClientId;
+    /** The IP address of the client that initiated this request. */
     sourceIp?: string;
+    /** The headers of the request. */
     headers?: Record<string, any>;
 }

package/dist/common/src/integrations/auth.types.d.ts

@@ -14,6 +14,13 @@ export interface CognitoIntegrationConfig extends BaseIntegrationConfig {
         appClientId: string;
     };
 }
+export interface OktaIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.okta;
+    configuration: {
+        domain: string;
+        clientId: string;
+    };
+}
 export interface JwtRsaIntegrationConfig extends BaseIntegrationConfig {
     type: IntegrationType.jwt_rsa;
     configuration: {

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

@@ -6,7 +6,7 @@ export * from './observability.types';
 import { IntegrationId } from '../communication.types';
 import { AiAssistantIntegrationConfig } from './ai_assistant.types';
 import { GraphQLIntegrationConfig, HttpApiIntegrationConfig, TestGraphQLDataConnectionRequest } from './api.types';
-import { Auth0IntegrationConfig, CognitoIntegrationConfig, JwtHmacIntegrationConfig, JwtRsaIntegrationConfig } from './auth.types';
+import { Auth0IntegrationConfig, CognitoIntegrationConfig, JwtHmacIntegrationConfig, JwtRsaIntegrationConfig, OktaIntegrationConfig } from './auth.types';
 import { BaseDatabaseIntegrationConfig, CockroachIntegrationConfig, InternalIntegrationConfig, MongoIntegrationConfig, MssqlIntegrationConfig, MySqlIntegrationConfig, OracleIntegrationConfig, PostgresIntegrationConfig, SnowflakeIntegrationConfig, TestDataConnectionRequest } from './database.types';
 import { DatadogIntegrationConfig, NewRelicIntegrationConfig } from './observability.types';
 export declare enum IntegrationCategory {
@@ -34,6 +34,7 @@ export declare enum IntegrationType {
     'jwt_hmac' = "jwt_hmac",
     'ai_assistant' = "ai_assistant",
     'cognito' = "cognito",
+    'okta' = "okta",
     'algolia' = "algolia",
     'elastic_observability' = "elastic_observability",
     'elastic_search' = "elastic_search",
@@ -72,13 +73,14 @@ export interface IntegrationConfigTypes {
     [IntegrationType.jwt_hmac]: JwtHmacIntegrationConfig;
     [IntegrationType.ai_assistant]: AiAssistantIntegrationConfig;
     [IntegrationType.cognito]: CognitoIntegrationConfig;
+    [IntegrationType.okta]: OktaIntegrationConfig;
 }
 export declare const DatabaseIntegrationTypes: readonly [IntegrationType.built_in_db, IntegrationType.mongo, IntegrationType.mysql, IntegrationType.mssql, IntegrationType.postgres, IntegrationType.cockroach, IntegrationType.snowflake, IntegrationType.oracledb];
 export type DatabaseIntegrationType = (typeof DatabaseIntegrationTypes)[number];
 export type DatabaseIntegrationConfig = IntegrationConfigTypes[DatabaseIntegrationType];
 export declare const ApiIntegrationTypes: readonly [IntegrationType.api, IntegrationType.graphql];
 export declare const ObservabilityIntegrationTypes: readonly [IntegrationType.datadog, IntegrationType.newrelic];
-export declare const AuthIntegrationTypes: readonly [IntegrationType.auth0, IntegrationType.jwt_rsa, IntegrationType.jwt_hmac, IntegrationType.cognito];
+export declare const AuthIntegrationTypes: readonly [IntegrationType.auth0, IntegrationType.jwt_rsa, IntegrationType.jwt_hmac, IntegrationType.cognito, IntegrationType.okta];
 export type ApiIntegrationType = (typeof ApiIntegrationTypes)[number];
 export type ApiIntegrationConfig = IntegrationConfigTypes[ApiIntegrationType];
 export type ObservabilityIntegrationType = (typeof ObservabilityIntegrationTypes)[number];

package/dist/common/src/mutation.context.d.ts

@@ -1,5 +1,5 @@
-import { Mutation, MutationType } from './mutation.types';
 import { BeforeAndAfterDocs } from './document.types';
+import { Mutation, MutationType } from './mutation.types';
 import { Paths } from './types';
 /** The mutation context that will be provided to the security function. */
 export declare class MutationContext<T = any> {
@@ -7,6 +7,8 @@ export declare class MutationContext<T = any> {
     readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
     readonly serverTimeStamp: Date;
     getMutationType(): MutationType;
+    get before(): T | undefined;
+    get after(): T | undefined;
     /** Returns true if the mutation affects the provided path. */
     affectsPath(path: Paths<T>): boolean;
 }

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

@@ -1,4 +1,4 @@
-import { ClientId, ClientRequestId } from './communication.types';
+import { ClientRequestId } from './communication.types';
 import { CollectionName, FieldName } from './document.types';
 /** A list of query conditions. */
 export type Conditions<Doc = any, F extends FieldName<Doc> = any> = Array<Condition<Doc, F>>;
@@ -50,7 +50,6 @@ export interface Query<Doc = any> {
     limit: number;
 }
 export interface QueryRegisterRequest {
-    clientId: ClientId;
     clientRequestId: ClientRequestId;
     query: Query;
     parentClientRequestId: ClientRequestId;

package/dist/common/src/utils/serialization.d.ts

@@ -1,6 +1,6 @@
 export declare function normalizeJsonAsString(json: any): string;
 export declare function serializeObj(obj: any): string;
-export declare function deserializeObj<T = any>(serializedObj: string): T;
+export declare function deserializeObj<T = any>(str: string): T;
 export declare function encodeValueForMapping(value: any): string;
 export declare function decodeValueForMapping(encodedString: string): any;
 export declare function recodeValue(value: any): any;