@squidcloud/client 1.0.120 → 1.0.121

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/cjs/index.js CHANGED
@@ -30945,8 +30945,8 @@ function map_map(project, thisArg) {
30945
30945
 
30946
30946
  /**
30947
30947
  * A query builder that can participate in a join.
30948
- * To learn more about join queries, see
30949
- * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/queries#joining-data-across-collections-and-integrations}.
30948
+ * To learn more about join queries, see the
30949
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/queries#joining-data-across-collections-and-integrations documentation}.
30950
30950
  */
30951
30951
  class JoinQueryBuilder extends BaseQueryBuilder {
30952
30952
  /**
@@ -31327,7 +31327,7 @@ class GroupedJoin {
31327
31327
  * collection in a NoSQL database.
31328
31328
  *
31329
31329
  * Read more about collection references in the
31330
- * [documentation]{@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference}.
31330
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference documentation}.
31331
31331
  * @typeParam T The type of the document data.
31332
31332
  */
31333
31333
  class CollectionReference {
@@ -31551,7 +31551,7 @@ class MergedQueryBuilder {
31551
31551
  * use to create a new document.
31552
31552
  *
31553
31553
  * Read more about document references in the
31554
- * [documentation]{@link https://docs.squid.cloud/docs/development-tools/client-sdk/document-reference}.
31554
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/document-reference documentation}.
31555
31555
  * @typeParam T The type of the document data.
31556
31556
  */
31557
31557
  class DocumentReference {
@@ -48944,7 +48944,7 @@ class Squid {
48944
48944
  * If the integrationId is not provided, the `built_in_db` integration id will be used.
48945
48945
  *
48946
48946
  * For more information on the CollectionReference object, please refer to the
48947
- * documentation at {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference}.
48947
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference documentation}.
48948
48948
  *
48949
48949
  * @param collectionName The name of the collection.
48950
48950
  * @param integrationId The id of the integration, default to `built_in_db`.
@@ -48960,7 +48960,7 @@ class Squid {
48960
48960
  * will be atomic. Note that mutations for different integrations will not be atomic.
48961
48961
  *
48962
48962
  * For more information about transactions in Squid, please refer to the
48963
- * documentation at {@link https://docs.squid.cloud/docs/development-tools/client-sdk/transactions}.
48963
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/transactions documentation}.
48964
48964
  *
48965
48965
  * @param fn The callback to run as an atomic change. The function receives a transactionId that should be used for
48966
48966
  * all the mutations that should be atomic. The function should return a promise.
@@ -48975,7 +48975,7 @@ class Squid {
48975
48975
  * Executes the given backend function with the given parameters and returns a promise with the result.
48976
48976
  *
48977
48977
  * For more information about backend functions in Squid, please refer to the
48978
- * documentation at {@link https://docs.squid.cloud/docs/development-tools/backend/executables}.
48978
+ * {@link https://docs.squid.cloud/docs/development-tools/backend/executables documentation}.
48979
48979
  *
48980
48980
  * @param functionName The name of the function to execute on the server.
48981
48981
  * @param params The parameters to pass to the function.
@@ -48990,7 +48990,7 @@ class Squid {
48990
48990
  * Executes the given named query with the given parameters and returns a promise with the result.
48991
48991
  *
48992
48992
  * For more information about named queries in Squid, please refer to the
48993
- * documentation at {@link https://docs.squid.cloud/docs/development-tools/backend/named-queries}.
48993
+ * {@link https://docs.squid.cloud/docs/development-tools/backend/named-queries documentation}.
48994
48994
  *
48995
48995
  * @param integrationId The id of the integration that the named query is defined with.
48996
48996
  * @param queryName The name of the named query.
@@ -49008,7 +49008,7 @@ class Squid {
49008
49008
  * integration's schema page.
49009
49009
  *
49010
49010
  * For more information about API integrations in Squid, please refer to the
49011
- * documentation at {@link https://docs.squid.cloud/docs/integrations/api/httpapi}.
49011
+ * {@link https://docs.squid.cloud/docs/integrations/api/httpapi documentation}.
49012
49012
  *
49013
49013
  * @param integrationId The id of the integration that the API is defined with.
49014
49014
  * @param endpointId The id of the endpoint in the API integration.
@@ -49022,8 +49022,8 @@ class Squid {
49022
49022
  };
49023
49023
  /**
49024
49024
  * Returns a GraphQL client for the given integration. The GraphQL client can be used to execute GraphQL queries and
49025
- * mutations. For more information about GraphQL in Squid, please refer to the documentation at
49026
- * {@link https://docs.squid.cloud/docs/integrations/api/graphql}.
49025
+ * mutations. For more information about GraphQL in Squid, please refer to the
49026
+ * {@link https://docs.squid.cloud/docs/integrations/api/graphql documentation}.
49027
49027
  *
49028
49028
  * @param integrationId The id of the integration that the GraphQL API is defined with.
49029
49029
  * @returns A GraphQL client for the given integration.
@@ -8,7 +8,7 @@ import { QueryBuilder } from './query/query-builder.factory';
8
8
  * collection in a NoSQL database.
9
9
  *
10
10
  * Read more about collection references in the
11
- * [documentation]{@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference}.
11
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference documentation}.
12
12
  * @typeParam T The type of the document data.
13
13
  */
14
14
  export declare class CollectionReference<T extends DocumentData> {
@@ -8,7 +8,7 @@ import { TransactionId } from './types';
8
8
  * use to create a new document.
9
9
  *
10
10
  * Read more about document references in the
11
- * [documentation]{@link https://docs.squid.cloud/docs/development-tools/client-sdk/document-reference}.
11
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/document-reference documentation}.
12
12
  * @typeParam T The type of the document data.
13
13
  */
14
14
  export declare class DocumentReference<T extends DocumentData = any> {
@@ -29,8 +29,8 @@ interface HasGrouped {
29
29
  }
30
30
  /**
31
31
  * A query builder that can participate in a join.
32
- * To learn more about join queries, see
33
- * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/queries#joining-data-across-collections-and-integrations}.
32
+ * To learn more about join queries, see the
33
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/queries#joining-data-across-collections-and-integrations documentation}.
34
34
  */
35
35
  export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, LatestAlias extends Alias, RootAlias extends Alias> extends BaseQueryBuilder<ReturnType> implements SnapshotEmitter<WithDocumentReferences<ReturnType>>, HasGrouped, HasDereference {
36
36
  private readonly collectionName;
@@ -111,7 +111,7 @@ export declare class Squid {
111
111
  * If the integrationId is not provided, the `built_in_db` integration id will be used.
112
112
  *
113
113
  * For more information on the CollectionReference object, please refer to the
114
- * documentation at {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference}.
114
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/collection-reference documentation}.
115
115
  *
116
116
  * @param collectionName The name of the collection.
117
117
  * @param integrationId The id of the integration, default to `built_in_db`.
@@ -124,7 +124,7 @@ export declare class Squid {
124
124
  * will be atomic. Note that mutations for different integrations will not be atomic.
125
125
  *
126
126
  * For more information about transactions in Squid, please refer to the
127
- * documentation at {@link https://docs.squid.cloud/docs/development-tools/client-sdk/transactions}.
127
+ * {@link https://docs.squid.cloud/docs/development-tools/client-sdk/transactions documentation}.
128
128
  *
129
129
  * @param fn The callback to run as an atomic change. The function receives a transactionId that should be used for
130
130
  * all the mutations that should be atomic. The function should return a promise.
@@ -136,7 +136,7 @@ export declare class Squid {
136
136
  * Executes the given backend function with the given parameters and returns a promise with the result.
137
137
  *
138
138
  * For more information about backend functions in Squid, please refer to the
139
- * documentation at {@link https://docs.squid.cloud/docs/development-tools/backend/executables}.
139
+ * {@link https://docs.squid.cloud/docs/development-tools/backend/executables documentation}.
140
140
  *
141
141
  * @param functionName The name of the function to execute on the server.
142
142
  * @param params The parameters to pass to the function.
@@ -148,7 +148,7 @@ export declare class Squid {
148
148
  * Executes the given named query with the given parameters and returns a promise with the result.
149
149
  *
150
150
  * For more information about named queries in Squid, please refer to the
151
- * documentation at {@link https://docs.squid.cloud/docs/development-tools/backend/named-queries}.
151
+ * {@link https://docs.squid.cloud/docs/development-tools/backend/named-queries documentation}.
152
152
  *
153
153
  * @param integrationId The id of the integration that the named query is defined with.
154
154
  * @param queryName The name of the named query.
@@ -163,7 +163,7 @@ export declare class Squid {
163
163
  * integration's schema page.
164
164
  *
165
165
  * For more information about API integrations in Squid, please refer to the
166
- * documentation at {@link https://docs.squid.cloud/docs/integrations/api/httpapi}.
166
+ * {@link https://docs.squid.cloud/docs/integrations/api/httpapi documentation}.
167
167
  *
168
168
  * @param integrationId The id of the integration that the API is defined with.
169
169
  * @param endpointId The id of the endpoint in the API integration.
@@ -174,8 +174,8 @@ export declare class Squid {
174
174
  callApi: <T = any>(integrationId: IntegrationId, endpointId: ApiEndpointId, request?: Record<string, any>) => Promise<T>;
175
175
  /**
176
176
  * Returns a GraphQL client for the given integration. The GraphQL client can be used to execute GraphQL queries and
177
- * mutations. For more information about GraphQL in Squid, please refer to the documentation at
178
- * {@link https://docs.squid.cloud/docs/integrations/api/graphql}.
177
+ * mutations. For more information about GraphQL in Squid, please refer to the
178
+ * {@link https://docs.squid.cloud/docs/integrations/api/graphql documentation}.
179
179
  *
180
180
  * @param integrationId The id of the integration that the GraphQL API is defined with.
181
181
  * @returns A GraphQL client for the given integration.
@@ -190,8 +190,8 @@ export declare class Squid {
190
190
  ai: () => {
191
191
  /**
192
192
  * Returns an AI Assistant client for the given integration. The AI Assistant client can be used to build and chat
193
- * with custom AI profiles. For more information about the AI Assistant in Squid, please refer to the documentation
194
- * at {@link https://docs.squid.cloud/docs/ai/ai-assistant}.
193
+ * with custom AI profiles. For more information about the AI Assistant in Squid, please refer to the
194
+ * {@link https://docs.squid.cloud/docs/ai/ai-assistant documentation}.
195
195
  *
196
196
  * @param integrationId The id of the AI Assistant integration.
197
197
  * @returns An AI Assistant client.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/client",
3
- "version": "1.0.120",
3
+ "version": "1.0.121",
4
4
  "description": "A typescript implementation of the Squid client",
5
5
  "main": "dist/cjs/index.js",
6
6
  "types": "dist/typescript-client/src/index.d.ts",