@squidcloud/backend 1.0.103 → 1.0.105
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/backend/src/actions.d.ts +16 -13
- package/package.json +1 -1
|
@@ -10,7 +10,7 @@ import { ActionMethodDecorator, AiAssistantActionType, ApiEndpointId, ClientConn
|
|
|
10
10
|
* as a parameter. The context object contains information about the action.
|
|
11
11
|
*
|
|
12
12
|
* To read more about securing a database, see the
|
|
13
|
-
*
|
|
13
|
+
* {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-data-access#securedatabase documentation}.
|
|
14
14
|
* @param type The type af action to secure.
|
|
15
15
|
* @param integrationId The id of the integration to secure.
|
|
16
16
|
*/
|
|
@@ -26,7 +26,7 @@ export declare function secureDatabase<T extends DatabaseActionType>(type: T, in
|
|
|
26
26
|
* as a parameter. The context object contains information about the action.
|
|
27
27
|
*
|
|
28
28
|
* To read more about securing a collection rules, see the
|
|
29
|
-
*
|
|
29
|
+
* {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-data-access#securecollection documentation}.
|
|
30
30
|
* @param collectionName The name of the collection to secure.
|
|
31
31
|
* @param type The type af action to secure.
|
|
32
32
|
* @param integrationId The id of the integration to secure.
|
|
@@ -42,11 +42,11 @@ export declare function secureCollection<T extends DatabaseActionType>(collectio
|
|
|
42
42
|
* The function takes a context object as a parameter. The context object contains information about the action.
|
|
43
43
|
*
|
|
44
44
|
* To read more about securing an API, see the
|
|
45
|
-
*
|
|
45
|
+
* {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-api documentation}.
|
|
46
46
|
* @param integrationId The id of the integration to secure.
|
|
47
47
|
* @param endpointId The id of the endpoint to secure.
|
|
48
48
|
*/
|
|
49
|
-
export declare function secureApi
|
|
49
|
+
export declare function secureApi(integrationId: IntegrationId, endpointId?: ApiEndpointId): ActionMethodDecorator<SecureApiAction>;
|
|
50
50
|
/**
|
|
51
51
|
* Decorator that marks a function for securing a GraphQL integration.
|
|
52
52
|
*
|
|
@@ -55,10 +55,10 @@ export declare function secureApi<T extends SecureApiAction>(integrationId: Inte
|
|
|
55
55
|
* The function takes a context object as a parameter. The context object contains information about the action.
|
|
56
56
|
*
|
|
57
57
|
* To read more about securing a GraphQL integration, see the
|
|
58
|
-
*
|
|
58
|
+
* {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-graphql documentation}.
|
|
59
59
|
* @param integrationId
|
|
60
60
|
*/
|
|
61
|
-
export declare function secureGraphQL
|
|
61
|
+
export declare function secureGraphQL(integrationId: IntegrationId): ActionMethodDecorator<SecureGraphQLAction>;
|
|
62
62
|
/**
|
|
63
63
|
* Decorator that marks a function for exposing it as an executable.
|
|
64
64
|
* The function can accept any parameter that can be serialized to JSON and return any parameter that can be serialzied
|
|
@@ -66,7 +66,7 @@ export declare function secureGraphQL<T extends SecureGraphQLAction>(integration
|
|
|
66
66
|
*
|
|
67
67
|
* Once the function is exposed, it can be called from the Squid Cloud SDK using the `executeFunction` method.
|
|
68
68
|
* To read more about exposing an executable, see the
|
|
69
|
-
*
|
|
69
|
+
* {@link https://docs.squid.cloud/docs/development-tools/backend/executables documentation}.
|
|
70
70
|
*/
|
|
71
71
|
export declare function executable(): ActionMethodDecorator<ExecutableAction>;
|
|
72
72
|
/**
|
|
@@ -75,7 +75,7 @@ export declare function executable(): ActionMethodDecorator<ExecutableAction>;
|
|
|
75
75
|
* The function accepts a context object as a parameter. The context object contains information about the change.
|
|
76
76
|
*
|
|
77
77
|
* To read more about triggers, see the
|
|
78
|
-
*
|
|
78
|
+
* {@link https://docs.squid.cloud/docs/development-tools/backend/triggers documentation}.
|
|
79
79
|
*
|
|
80
80
|
* @param id The id of the trigger. Should be unique.
|
|
81
81
|
* @param collectionName The name of the collection to trigger on.
|
|
@@ -88,7 +88,7 @@ export declare function trigger(id: TriggerId, collectionName: CollectionName, i
|
|
|
88
88
|
* expression.
|
|
89
89
|
*
|
|
90
90
|
* To read more about schedulers, see the
|
|
91
|
-
*
|
|
91
|
+
* {@link https://docs.squid.cloud/docs/development-tools/backend/schedulers documentation}.
|
|
92
92
|
*
|
|
93
93
|
* @param id The id of the scheduler. Should be unique.
|
|
94
94
|
* @param cronExpression The cron expression to schedule the function on.
|
|
@@ -107,7 +107,7 @@ export declare function scheduler(id: SchedulerId, cronExpression: CronExpressio
|
|
|
107
107
|
* `this.createWebhookResponse(<params>)`.
|
|
108
108
|
*
|
|
109
109
|
* To read more about webhooks, see the
|
|
110
|
-
*
|
|
110
|
+
* {@link https://docs.squid.cloud/docs/development-tools/backend/webhooks documentation}.
|
|
111
111
|
* @param id The id of the webhook. Should be unique.
|
|
112
112
|
*/
|
|
113
113
|
export declare function webhook(id: WebhookId): ActionMethodDecorator<WebhookAction>;
|
|
@@ -118,7 +118,7 @@ export declare function webhook(id: WebhookId): ActionMethodDecorator<WebhookAct
|
|
|
118
118
|
* A named query can be invoked from the SDK using the `executeNamedQuery` method.
|
|
119
119
|
*
|
|
120
120
|
* To read more about named queries, see the
|
|
121
|
-
*
|
|
121
|
+
* {@link https://docs.squid.cloud/docs/development-tools/backend/named-queries documentation}.
|
|
122
122
|
*
|
|
123
123
|
* @param integrationId The database integration id (Note that the `built_in_db` does not support named queries)
|
|
124
124
|
* @param name The name of the query that will be used to call it from the SDK.
|
|
@@ -131,10 +131,13 @@ export declare function namedQuery(integrationId: string, name: string): any;
|
|
|
131
131
|
*
|
|
132
132
|
* The function accepts a context object as a parameter. The context object contains information about the query.
|
|
133
133
|
*
|
|
134
|
+
* To read more about securing a GraphQL integration, see the
|
|
135
|
+
* {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-data-access#securenamedquery documentation}.
|
|
136
|
+
*
|
|
134
137
|
* @param integrationId The database integration id.
|
|
135
138
|
* @param queryName The name of the query.
|
|
136
139
|
*/
|
|
137
|
-
export declare function secureNamedQuery
|
|
140
|
+
export declare function secureNamedQuery(integrationId: IntegrationId, queryName: QueryName): ActionMethodDecorator<SecureNamedQueryAction>;
|
|
138
141
|
/**
|
|
139
142
|
* A decorator that can be used to secure a distributed lock. Distributed locks are secured by default and can be
|
|
140
143
|
* invoked only if the decorated function allows it. The function returns a boolean or a `Promise` of a boolean that
|
|
@@ -145,7 +148,7 @@ export declare function secureNamedQuery<T extends SecureNamedQueryAction>(integ
|
|
|
145
148
|
*
|
|
146
149
|
* @param mutex The mutex to lock on. If none provided, the rule will apply for all mutexes.
|
|
147
150
|
*/
|
|
148
|
-
export declare function secureDistributedLock
|
|
151
|
+
export declare function secureDistributedLock(mutex?: string): ActionMethodDecorator<SecureDistributedLockAction>;
|
|
149
152
|
export declare function secureAiAssistant<T extends AiAssistantActionType>(integrationId: IntegrationId, type: T, profileId?: string): ActionMethodDecorator<SecureAiAssistantAction<T>>;
|
|
150
153
|
/** Decorator that marks a function for handling a client connection state change */
|
|
151
154
|
export declare function clientConnectionStateHandler(): ActionMethodDecorator<ClientConnectionStateChangeAction>;
|