@orq-ai/node 3.3.1 → 3.4.0-rc.0
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/bin/mcp-server.js +40 -43
- package/bin/mcp-server.js.map +24 -24
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/lib/config.js.map +1 -1
- package/mcp-server/mcp-server.js +1 -1
- package/mcp-server/mcp-server.js.map +1 -1
- package/mcp-server/server.js +1 -1
- package/mcp-server/server.js.map +1 -1
- package/models/operations/bulkcreatedatapoints.js +2 -2
- package/models/operations/createcontact.js +2 -2
- package/models/operations/createdataset.js +2 -2
- package/models/operations/createdatasetitem.js +2 -2
- package/models/operations/createdatasource.js +2 -2
- package/models/operations/fileget.js +2 -2
- package/models/operations/filelist.js +2 -2
- package/models/operations/fileupload.js +2 -2
- package/models/operations/listdatasetdatapoints.js +2 -2
- package/models/operations/listdatasets.js +2 -2
- package/models/operations/listdatasources.js +2 -2
- package/models/operations/retrievedatapoint.js +2 -2
- package/models/operations/retrievedataset.js +2 -2
- package/models/operations/retrievedatasource.js +2 -2
- package/models/operations/updatedatapoint.js +2 -2
- package/models/operations/updatedataset.js +2 -2
- package/models/operations/updatedatasource.js +2 -2
- package/package.json +3 -2
- package/src/lib/config.ts +2 -2
- package/src/mcp-server/mcp-server.ts +1 -1
- package/src/mcp-server/server.ts +1 -1
- package/src/models/operations/bulkcreatedatapoints.ts +2 -2
- package/src/models/operations/createcontact.ts +2 -2
- package/src/models/operations/createdataset.ts +2 -2
- package/src/models/operations/createdatasetitem.ts +2 -2
- package/src/models/operations/createdatasource.ts +2 -2
- package/src/models/operations/fileget.ts +2 -2
- package/src/models/operations/filelist.ts +2 -2
- package/src/models/operations/fileupload.ts +2 -2
- package/src/models/operations/listdatasetdatapoints.ts +2 -2
- package/src/models/operations/listdatasets.ts +2 -2
- package/src/models/operations/listdatasources.ts +2 -2
- package/src/models/operations/retrievedatapoint.ts +2 -2
- package/src/models/operations/retrievedataset.ts +2 -2
- package/src/models/operations/retrievedatasource.ts +2 -2
- package/src/models/operations/updatedatapoint.ts +2 -2
- package/src/models/operations/updatedataset.ts +2 -2
- package/src/models/operations/updatedatasource.ts +2 -2
- package/packages/orq-rc/FUNCTIONS.md +0 -106
- package/packages/orq-rc/README.md +0 -698
- package/packages/orq-rc/RUNTIMES.md +0 -48
- package/packages/orq-rc/docs/sdks/contacts/README.md +0 -84
- package/packages/orq-rc/docs/sdks/datasets/README.md +0 -940
- package/packages/orq-rc/docs/sdks/deployments/README.md +0 -316
- package/packages/orq-rc/docs/sdks/feedback/README.md +0 -92
- package/packages/orq-rc/docs/sdks/files/README.md +0 -311
- package/packages/orq-rc/docs/sdks/knowledge/README.md +0 -1279
- package/packages/orq-rc/docs/sdks/metrics/README.md +0 -86
- package/packages/orq-rc/docs/sdks/orq/README.md +0 -10
- package/packages/orq-rc/docs/sdks/prompts/README.md +0 -614
- package/packages/orq-rc/docs/sdks/remoteconfigs/README.md +0 -80
- package/packages/orq-rc/jsr.json +0 -28
- package/packages/orq-rc/package-lock.json +0 -3217
- package/packages/orq-rc/package.json +0 -45
- package/packages/orq-rc/src/core.ts +0 -13
- package/packages/orq-rc/src/funcs/contactsCreate.ts +0 -154
- package/packages/orq-rc/src/funcs/datasetsClear.ts +0 -161
- package/packages/orq-rc/src/funcs/datasetsCreate.ts +0 -159
- package/packages/orq-rc/src/funcs/datasetsCreateDatapoint.ts +0 -161
- package/packages/orq-rc/src/funcs/datasetsCreateDatapoints.ts +0 -165
- package/packages/orq-rc/src/funcs/datasetsDelete.ts +0 -161
- package/packages/orq-rc/src/funcs/datasetsDeleteDatapoint.ts +0 -176
- package/packages/orq-rc/src/funcs/datasetsList.ts +0 -161
- package/packages/orq-rc/src/funcs/datasetsListDatapoints.ts +0 -168
- package/packages/orq-rc/src/funcs/datasetsRetrieve.ts +0 -169
- package/packages/orq-rc/src/funcs/datasetsRetrieveDatapoint.ts +0 -175
- package/packages/orq-rc/src/funcs/datasetsUpdate.ts +0 -170
- package/packages/orq-rc/src/funcs/datasetsUpdateDatapoint.ts +0 -173
- package/packages/orq-rc/src/funcs/deploymentsGetConfig.ts +0 -162
- package/packages/orq-rc/src/funcs/deploymentsInvoke.ts +0 -170
- package/packages/orq-rc/src/funcs/deploymentsList.ts +0 -170
- package/packages/orq-rc/src/funcs/deploymentsMetricsCreate.ts +0 -162
- package/packages/orq-rc/src/funcs/deploymentsStream.ts +0 -178
- package/packages/orq-rc/src/funcs/feedbackCreate.ts +0 -154
- package/packages/orq-rc/src/funcs/filesCreate.ts +0 -174
- package/packages/orq-rc/src/funcs/filesDelete.ts +0 -158
- package/packages/orq-rc/src/funcs/filesGet.ts +0 -160
- package/packages/orq-rc/src/funcs/filesList.ts +0 -161
- package/packages/orq-rc/src/funcs/knowledgeCreate.ts +0 -152
- package/packages/orq-rc/src/funcs/knowledgeCreateChunks.ts +0 -165
- package/packages/orq-rc/src/funcs/knowledgeCreateDatasource.ts +0 -160
- package/packages/orq-rc/src/funcs/knowledgeDelete.ts +0 -161
- package/packages/orq-rc/src/funcs/knowledgeDeleteChunk.ts +0 -168
- package/packages/orq-rc/src/funcs/knowledgeDeleteDatasource.ts +0 -167
- package/packages/orq-rc/src/funcs/knowledgeList.ts +0 -163
- package/packages/orq-rc/src/funcs/knowledgeListChunks.ts +0 -172
- package/packages/orq-rc/src/funcs/knowledgeListDatasources.ts +0 -168
- package/packages/orq-rc/src/funcs/knowledgeRetrieve.ts +0 -160
- package/packages/orq-rc/src/funcs/knowledgeRetrieveChunk.ts +0 -167
- package/packages/orq-rc/src/funcs/knowledgeRetrieveDatasource.ts +0 -163
- package/packages/orq-rc/src/funcs/knowledgeSearch.ts +0 -158
- package/packages/orq-rc/src/funcs/knowledgeUpdate.ts +0 -158
- package/packages/orq-rc/src/funcs/knowledgeUpdateChunk.ts +0 -168
- package/packages/orq-rc/src/funcs/knowledgeUpdateDatasource.ts +0 -164
- package/packages/orq-rc/src/funcs/promptsCreate.ts +0 -154
- package/packages/orq-rc/src/funcs/promptsDelete.ts +0 -158
- package/packages/orq-rc/src/funcs/promptsGetVersion.ts +0 -175
- package/packages/orq-rc/src/funcs/promptsList.ts +0 -161
- package/packages/orq-rc/src/funcs/promptsListVersions.ts +0 -167
- package/packages/orq-rc/src/funcs/promptsRetrieve.ts +0 -160
- package/packages/orq-rc/src/funcs/promptsUpdate.ts +0 -167
- package/packages/orq-rc/src/funcs/remoteconfigsRetrieve.ts +0 -155
- package/packages/orq-rc/src/hooks/global.ts +0 -44
- package/packages/orq-rc/src/hooks/hooks.ts +0 -132
- package/packages/orq-rc/src/hooks/index.ts +0 -6
- package/packages/orq-rc/src/hooks/registration.ts +0 -15
- package/packages/orq-rc/src/hooks/types.ts +0 -110
- package/packages/orq-rc/src/index.ts +0 -7
- package/packages/orq-rc/src/lib/base64.ts +0 -37
- package/packages/orq-rc/src/lib/config.ts +0 -70
- package/packages/orq-rc/src/lib/dlv.ts +0 -53
- package/packages/orq-rc/src/lib/encodings.ts +0 -483
- package/packages/orq-rc/src/lib/env.ts +0 -73
- package/packages/orq-rc/src/lib/event-streams.ts +0 -264
- package/packages/orq-rc/src/lib/files.ts +0 -40
- package/packages/orq-rc/src/lib/http.ts +0 -323
- package/packages/orq-rc/src/lib/is-plain-object.ts +0 -43
- package/packages/orq-rc/src/lib/logger.ts +0 -9
- package/packages/orq-rc/src/lib/matchers.ts +0 -325
- package/packages/orq-rc/src/lib/primitives.ts +0 -150
- package/packages/orq-rc/src/lib/retries.ts +0 -218
- package/packages/orq-rc/src/lib/schemas.ts +0 -91
- package/packages/orq-rc/src/lib/sdks.ts +0 -395
- package/packages/orq-rc/src/lib/security.ts +0 -261
- package/packages/orq-rc/src/lib/url.ts +0 -33
- package/packages/orq-rc/src/mcp-server/cli/start/command.ts +0 -125
- package/packages/orq-rc/src/mcp-server/cli/start/impl.ts +0 -140
- package/packages/orq-rc/src/mcp-server/cli.ts +0 -13
- package/packages/orq-rc/src/mcp-server/console-logger.ts +0 -71
- package/packages/orq-rc/src/mcp-server/extensions.ts +0 -17
- package/packages/orq-rc/src/mcp-server/mcp-server.ts +0 -26
- package/packages/orq-rc/src/mcp-server/prompts.ts +0 -110
- package/packages/orq-rc/src/mcp-server/resources.ts +0 -158
- package/packages/orq-rc/src/mcp-server/scopes.ts +0 -7
- package/packages/orq-rc/src/mcp-server/server.ts +0 -157
- package/packages/orq-rc/src/mcp-server/shared.ts +0 -75
- package/packages/orq-rc/src/mcp-server/tools/contactsCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsClear.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/datasetsCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoint.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsCreateDatapoints.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsDelete.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/datasetsDeleteDatapoint.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/datasetsList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsListDatapoints.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieve.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsRetrieveDatapoint.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsUpdate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/datasetsUpdateDatapoint.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/deploymentsGetConfig.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/deploymentsInvoke.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/deploymentsList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/deploymentsMetricsCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/deploymentsStream.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/feedbackCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/filesCreate.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/filesDelete.ts +0 -33
- package/packages/orq-rc/src/mcp-server/tools/filesGet.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/filesList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateChunks.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeCreateDatasource.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDelete.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteChunk.ts +0 -33
- package/packages/orq-rc/src/mcp-server/tools/knowledgeDeleteDatasource.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/knowledgeListChunks.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeListDatasources.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieve.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveChunk.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeRetrieveDatasource.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeSearch.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateChunk.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/knowledgeUpdateDatasource.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/promptsCreate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/promptsDelete.ts +0 -33
- package/packages/orq-rc/src/mcp-server/tools/promptsGetVersion.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/promptsList.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/promptsListVersions.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/promptsRetrieve.ts +0 -37
- package/packages/orq-rc/src/mcp-server/tools/promptsUpdate.ts +0 -35
- package/packages/orq-rc/src/mcp-server/tools/remoteconfigsRetrieve.ts +0 -36
- package/packages/orq-rc/src/mcp-server/tools.ts +0 -126
- package/packages/orq-rc/src/models/components/deployments.ts +0 -4164
- package/packages/orq-rc/src/models/components/index.ts +0 -6
- package/packages/orq-rc/src/models/components/security.ts +0 -71
- package/packages/orq-rc/src/models/errors/apierror.ts +0 -27
- package/packages/orq-rc/src/models/errors/getpromptversion.ts +0 -71
- package/packages/orq-rc/src/models/errors/honoapierror.ts +0 -82
- package/packages/orq-rc/src/models/errors/httpclienterrors.ts +0 -62
- package/packages/orq-rc/src/models/errors/index.ts +0 -10
- package/packages/orq-rc/src/models/errors/sdkvalidationerror.ts +0 -97
- package/packages/orq-rc/src/models/errors/updateprompt.ts +0 -71
- package/packages/orq-rc/src/models/operations/bulkcreatedatapoints.ts +0 -1816
- package/packages/orq-rc/src/models/operations/cleardataset.ts +0 -75
- package/packages/orq-rc/src/models/operations/createchunk.ts +0 -680
- package/packages/orq-rc/src/models/operations/createcontact.ts +0 -256
- package/packages/orq-rc/src/models/operations/createdataset.ts +0 -296
- package/packages/orq-rc/src/models/operations/createdatasetitem.ts +0 -1740
- package/packages/orq-rc/src/models/operations/createdatasource.ts +0 -852
- package/packages/orq-rc/src/models/operations/createfeedback.ts +0 -286
- package/packages/orq-rc/src/models/operations/createknowledge.ts +0 -676
- package/packages/orq-rc/src/models/operations/createprompt.ts +0 -3743
- package/packages/orq-rc/src/models/operations/deletechunk.ts +0 -96
- package/packages/orq-rc/src/models/operations/deletedatapoint.ts +0 -81
- package/packages/orq-rc/src/models/operations/deletedataset.ts +0 -75
- package/packages/orq-rc/src/models/operations/deletedatasource.ts +0 -87
- package/packages/orq-rc/src/models/operations/deleteknowledge.ts +0 -78
- package/packages/orq-rc/src/models/operations/deleteprompt.ts +0 -69
- package/packages/orq-rc/src/models/operations/deploymentcreatemetric.ts +0 -4936
- package/packages/orq-rc/src/models/operations/deploymentgetconfig.ts +0 -6090
- package/packages/orq-rc/src/models/operations/deploymentinvoke.ts +0 -1199
- package/packages/orq-rc/src/models/operations/deployments.ts +0 -2155
- package/packages/orq-rc/src/models/operations/deploymentstream.ts +0 -5960
- package/packages/orq-rc/src/models/operations/filedelete.ts +0 -78
- package/packages/orq-rc/src/models/operations/fileget.ts +0 -223
- package/packages/orq-rc/src/models/operations/filelist.ts +0 -337
- package/packages/orq-rc/src/models/operations/fileupload.ts +0 -324
- package/packages/orq-rc/src/models/operations/getallprompts.ts +0 -2127
- package/packages/orq-rc/src/models/operations/getonechunk.ts +0 -265
- package/packages/orq-rc/src/models/operations/getoneknowledge.ts +0 -444
- package/packages/orq-rc/src/models/operations/getoneprompt.ts +0 -1993
- package/packages/orq-rc/src/models/operations/getpromptversion.ts +0 -1991
- package/packages/orq-rc/src/models/operations/index.ts +0 -51
- package/packages/orq-rc/src/models/operations/listchunks.ts +0 -444
- package/packages/orq-rc/src/models/operations/listdatasetdatapoints.ts +0 -1071
- package/packages/orq-rc/src/models/operations/listdatasets.ts +0 -406
- package/packages/orq-rc/src/models/operations/listdatasources.ts +0 -447
- package/packages/orq-rc/src/models/operations/listknowledgebases.ts +0 -568
- package/packages/orq-rc/src/models/operations/listpromptversions.ts +0 -2125
- package/packages/orq-rc/src/models/operations/remoteconfigsgetconfig.ts +0 -190
- package/packages/orq-rc/src/models/operations/retrievedatapoint.ts +0 -924
- package/packages/orq-rc/src/models/operations/retrievedataset.ts +0 -288
- package/packages/orq-rc/src/models/operations/retrievedatasource.ts +0 -273
- package/packages/orq-rc/src/models/operations/searchknowledge.ts +0 -1673
- package/packages/orq-rc/src/models/operations/updatechunk.ts +0 -418
- package/packages/orq-rc/src/models/operations/updatedatapoint.ts +0 -1729
- package/packages/orq-rc/src/models/operations/updatedataset.ts +0 -393
- package/packages/orq-rc/src/models/operations/updatedatasource.ts +0 -345
- package/packages/orq-rc/src/models/operations/updateknowledge.ts +0 -790
- package/packages/orq-rc/src/models/operations/updateprompt.ts +0 -3929
- package/packages/orq-rc/src/sdk/contacts.ts +0 -27
- package/packages/orq-rc/src/sdk/datasets.ts +0 -222
- package/packages/orq-rc/src/sdk/deployments.ts +0 -89
- package/packages/orq-rc/src/sdk/feedback.ts +0 -27
- package/packages/orq-rc/src/sdk/files.ts +0 -78
- package/packages/orq-rc/src/sdk/index.ts +0 -5
- package/packages/orq-rc/src/sdk/knowledge.ts +0 -261
- package/packages/orq-rc/src/sdk/metrics.ts +0 -27
- package/packages/orq-rc/src/sdk/prompts.ts +0 -126
- package/packages/orq-rc/src/sdk/remoteconfigs.ts +0 -24
- package/packages/orq-rc/src/sdk/sdk.ts +0 -55
- package/packages/orq-rc/src/types/async.ts +0 -68
- package/packages/orq-rc/src/types/blobs.ts +0 -31
- package/packages/orq-rc/src/types/constdatetime.ts +0 -15
- package/packages/orq-rc/src/types/enums.ts +0 -16
- package/packages/orq-rc/src/types/fp.ts +0 -50
- package/packages/orq-rc/src/types/index.ts +0 -11
- package/packages/orq-rc/src/types/operations.ts +0 -105
- package/packages/orq-rc/src/types/rfcdate.ts +0 -54
- package/packages/orq-rc/src/types/streams.ts +0 -21
- package/packages/orq-rc/tsconfig.json +0 -41
|
@@ -912,7 +912,7 @@ export const ListDatasetDatapointsData$inboundSchema: z.ZodType<
|
|
|
912
912
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
913
913
|
.optional(),
|
|
914
914
|
updated: z.string().datetime({ offset: true }).default(
|
|
915
|
-
"2025-04-03T20:
|
|
915
|
+
"2025-04-03T20:49:20.627Z",
|
|
916
916
|
).transform(v => new Date(v)),
|
|
917
917
|
}).transform((v) => {
|
|
918
918
|
return remap$(v, {
|
|
@@ -955,7 +955,7 @@ export const ListDatasetDatapointsData$outboundSchema: z.ZodType<
|
|
|
955
955
|
createdById: z.string().optional(),
|
|
956
956
|
updatedById: z.string().optional(),
|
|
957
957
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
958
|
-
updated: z.date().default(() => new Date("2025-04-03T20:
|
|
958
|
+
updated: z.date().default(() => new Date("2025-04-03T20:49:20.627Z"))
|
|
959
959
|
.transform(v => v.toISOString()),
|
|
960
960
|
}).transform((v) => {
|
|
961
961
|
return remap$(v, {
|
|
@@ -253,7 +253,7 @@ export const ListDatasetsData$inboundSchema: z.ZodType<
|
|
|
253
253
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
254
254
|
.optional(),
|
|
255
255
|
updated: z.string().datetime({ offset: true }).default(
|
|
256
|
-
"2025-04-03T20:
|
|
256
|
+
"2025-04-03T20:49:20.627Z",
|
|
257
257
|
).transform(v => new Date(v)),
|
|
258
258
|
}).transform((v) => {
|
|
259
259
|
return remap$(v, {
|
|
@@ -293,7 +293,7 @@ export const ListDatasetsData$outboundSchema: z.ZodType<
|
|
|
293
293
|
updatedById: z.string().optional(),
|
|
294
294
|
metadata: z.lazy(() => ListDatasetsMetadata$outboundSchema),
|
|
295
295
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
296
|
-
updated: z.date().default(() => new Date("2025-04-03T20:
|
|
296
|
+
updated: z.date().default(() => new Date("2025-04-03T20:49:20.627Z"))
|
|
297
297
|
.transform(v => v.toISOString()),
|
|
298
298
|
}).transform((v) => {
|
|
299
299
|
return remap$(v, {
|
|
@@ -278,7 +278,7 @@ export const ListDatasourcesData$inboundSchema: z.ZodType<
|
|
|
278
278
|
z.ZodTypeDef,
|
|
279
279
|
unknown
|
|
280
280
|
> = z.object({
|
|
281
|
-
_id: z.string().default("
|
|
281
|
+
_id: z.string().default("01JQYPMWQFCYY75G59GZ5CRZNE"),
|
|
282
282
|
display_name: z.string(),
|
|
283
283
|
description: z.string().optional(),
|
|
284
284
|
status: ListDatasourcesStatus$inboundSchema,
|
|
@@ -322,7 +322,7 @@ export const ListDatasourcesData$outboundSchema: z.ZodType<
|
|
|
322
322
|
z.ZodTypeDef,
|
|
323
323
|
ListDatasourcesData
|
|
324
324
|
> = z.object({
|
|
325
|
-
id: z.string().default("
|
|
325
|
+
id: z.string().default("01JQYPMWQFCYY75G59GZ5CRZNE"),
|
|
326
326
|
displayName: z.string(),
|
|
327
327
|
description: z.string().optional(),
|
|
328
328
|
status: ListDatasourcesStatus$outboundSchema,
|
|
@@ -834,7 +834,7 @@ export const RetrieveDatapointResponseBody$inboundSchema: z.ZodType<
|
|
|
834
834
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
835
835
|
.optional(),
|
|
836
836
|
updated: z.string().datetime({ offset: true }).default(
|
|
837
|
-
"2025-04-03T20:
|
|
837
|
+
"2025-04-03T20:49:20.627Z",
|
|
838
838
|
).transform(v => new Date(v)),
|
|
839
839
|
}).transform((v) => {
|
|
840
840
|
return remap$(v, {
|
|
@@ -877,7 +877,7 @@ export const RetrieveDatapointResponseBody$outboundSchema: z.ZodType<
|
|
|
877
877
|
createdById: z.string().optional(),
|
|
878
878
|
updatedById: z.string().optional(),
|
|
879
879
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
880
|
-
updated: z.date().default(() => new Date("2025-04-03T20:
|
|
880
|
+
updated: z.date().default(() => new Date("2025-04-03T20:49:20.627Z"))
|
|
881
881
|
.transform(v => v.toISOString()),
|
|
882
882
|
}).transform((v) => {
|
|
883
883
|
return remap$(v, {
|
|
@@ -201,7 +201,7 @@ export const RetrieveDatasetResponseBody$inboundSchema: z.ZodType<
|
|
|
201
201
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
202
202
|
.optional(),
|
|
203
203
|
updated: z.string().datetime({ offset: true }).default(
|
|
204
|
-
"2025-04-03T20:
|
|
204
|
+
"2025-04-03T20:49:20.627Z",
|
|
205
205
|
).transform(v => new Date(v)),
|
|
206
206
|
}).transform((v) => {
|
|
207
207
|
return remap$(v, {
|
|
@@ -241,7 +241,7 @@ export const RetrieveDatasetResponseBody$outboundSchema: z.ZodType<
|
|
|
241
241
|
updatedById: z.string().optional(),
|
|
242
242
|
metadata: z.lazy(() => RetrieveDatasetMetadata$outboundSchema),
|
|
243
243
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
244
|
-
updated: z.date().default(() => new Date("2025-04-03T20:
|
|
244
|
+
updated: z.date().default(() => new Date("2025-04-03T20:49:20.627Z"))
|
|
245
245
|
.transform(v => v.toISOString()),
|
|
246
246
|
}).transform((v) => {
|
|
247
247
|
return remap$(v, {
|
|
@@ -172,7 +172,7 @@ export const RetrieveDatasourceResponseBody$inboundSchema: z.ZodType<
|
|
|
172
172
|
z.ZodTypeDef,
|
|
173
173
|
unknown
|
|
174
174
|
> = z.object({
|
|
175
|
-
_id: z.string().default("
|
|
175
|
+
_id: z.string().default("01JQYPMWQHFA1YG3BADX3Q9RCX"),
|
|
176
176
|
display_name: z.string(),
|
|
177
177
|
description: z.string().optional(),
|
|
178
178
|
status: RetrieveDatasourceStatus$inboundSchema,
|
|
@@ -216,7 +216,7 @@ export const RetrieveDatasourceResponseBody$outboundSchema: z.ZodType<
|
|
|
216
216
|
z.ZodTypeDef,
|
|
217
217
|
RetrieveDatasourceResponseBody
|
|
218
218
|
> = z.object({
|
|
219
|
-
id: z.string().default("
|
|
219
|
+
id: z.string().default("01JQYPMWQHFA1YG3BADX3Q9RCX"),
|
|
220
220
|
displayName: z.string(),
|
|
221
221
|
description: z.string().optional(),
|
|
222
222
|
status: RetrieveDatasourceStatus$outboundSchema,
|
|
@@ -1638,7 +1638,7 @@ export const UpdateDatapointResponseBody$inboundSchema: z.ZodType<
|
|
|
1638
1638
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
1639
1639
|
.optional(),
|
|
1640
1640
|
updated: z.string().datetime({ offset: true }).default(
|
|
1641
|
-
"2025-04-03T20:
|
|
1641
|
+
"2025-04-03T20:49:20.627Z",
|
|
1642
1642
|
).transform(v => new Date(v)),
|
|
1643
1643
|
}).transform((v) => {
|
|
1644
1644
|
return remap$(v, {
|
|
@@ -1682,7 +1682,7 @@ export const UpdateDatapointResponseBody$outboundSchema: z.ZodType<
|
|
|
1682
1682
|
createdById: z.string().optional(),
|
|
1683
1683
|
updatedById: z.string().optional(),
|
|
1684
1684
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
1685
|
-
updated: z.date().default(() => new Date("2025-04-03T20:
|
|
1685
|
+
updated: z.date().default(() => new Date("2025-04-03T20:49:20.627Z"))
|
|
1686
1686
|
.transform(v => v.toISOString()),
|
|
1687
1687
|
}).transform((v) => {
|
|
1688
1688
|
return remap$(v, {
|
|
@@ -302,7 +302,7 @@ export const UpdateDatasetResponseBody$inboundSchema: z.ZodType<
|
|
|
302
302
|
created: z.string().datetime({ offset: true }).transform(v => new Date(v))
|
|
303
303
|
.optional(),
|
|
304
304
|
updated: z.string().datetime({ offset: true }).default(
|
|
305
|
-
"2025-04-03T20:
|
|
305
|
+
"2025-04-03T20:49:20.627Z",
|
|
306
306
|
).transform(v => new Date(v)),
|
|
307
307
|
}).transform((v) => {
|
|
308
308
|
return remap$(v, {
|
|
@@ -347,7 +347,7 @@ export const UpdateDatasetResponseBody$outboundSchema: z.ZodType<
|
|
|
347
347
|
parentId: z.string().optional(),
|
|
348
348
|
version: z.string().optional(),
|
|
349
349
|
created: z.date().transform(v => v.toISOString()).optional(),
|
|
350
|
-
updated: z.date().default(() => new Date("2025-04-03T20:
|
|
350
|
+
updated: z.date().default(() => new Date("2025-04-03T20:49:20.627Z"))
|
|
351
351
|
.transform(v => v.toISOString()),
|
|
352
352
|
}).transform((v) => {
|
|
353
353
|
return remap$(v, {
|
|
@@ -244,7 +244,7 @@ export const UpdateDatasourceResponseBody$inboundSchema: z.ZodType<
|
|
|
244
244
|
z.ZodTypeDef,
|
|
245
245
|
unknown
|
|
246
246
|
> = z.object({
|
|
247
|
-
_id: z.string().default("
|
|
247
|
+
_id: z.string().default("01JQYPMWQKKZEW8DE5A9GZASYP"),
|
|
248
248
|
display_name: z.string(),
|
|
249
249
|
description: z.string().optional(),
|
|
250
250
|
status: UpdateDatasourceStatus$inboundSchema,
|
|
@@ -288,7 +288,7 @@ export const UpdateDatasourceResponseBody$outboundSchema: z.ZodType<
|
|
|
288
288
|
z.ZodTypeDef,
|
|
289
289
|
UpdateDatasourceResponseBody
|
|
290
290
|
> = z.object({
|
|
291
|
-
id: z.string().default("
|
|
291
|
+
id: z.string().default("01JQYPMWQKKZEW8DE5A9GZASYP"),
|
|
292
292
|
displayName: z.string(),
|
|
293
293
|
description: z.string().optional(),
|
|
294
294
|
status: UpdateDatasourceStatus$outboundSchema,
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
# Standalone Functions
|
|
2
|
-
|
|
3
|
-
> [!NOTE]
|
|
4
|
-
> This section is useful if you are using a bundler and targetting browsers and
|
|
5
|
-
> runtimes where the size of an application affects performance and load times.
|
|
6
|
-
|
|
7
|
-
Every method in this SDK is also available as a standalone function. This
|
|
8
|
-
alternative API is suitable when targetting the browser or serverless runtimes
|
|
9
|
-
and using a bundler to build your application since all unused functionality
|
|
10
|
-
will be tree-shaken away. This includes code for unused methods, Zod schemas,
|
|
11
|
-
encoding helpers and response handlers. The result is dramatically smaller
|
|
12
|
-
impact on the application's final bundle size which grows very slowly as you use
|
|
13
|
-
more and more functionality from this SDK.
|
|
14
|
-
|
|
15
|
-
Calling methods through the main SDK class remains a valid and generally more
|
|
16
|
-
more ergonomic option. Standalone functions represent an optimisation for a
|
|
17
|
-
specific category of applications.
|
|
18
|
-
|
|
19
|
-
## Example
|
|
20
|
-
|
|
21
|
-
```typescript
|
|
22
|
-
import { OrqCore } from "@orq-ai/node/core.js";
|
|
23
|
-
import { contactsCreate } from "@orq-ai/node/funcs/contactsCreate.js";
|
|
24
|
-
import { SDKValidationError } from "@orq-ai/node/models/errors/sdkvalidationerror.js";
|
|
25
|
-
|
|
26
|
-
// Use `OrqCore` for best tree-shaking performance.
|
|
27
|
-
// You can create one instance of it to use across an application.
|
|
28
|
-
const orq = new OrqCore({
|
|
29
|
-
apiKey: process.env["ORQ_API_KEY"] ?? "",
|
|
30
|
-
});
|
|
31
|
-
|
|
32
|
-
async function run() {
|
|
33
|
-
const res = await contactsCreate(orq, {
|
|
34
|
-
externalId: "<id>",
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
switch (true) {
|
|
38
|
-
case res.ok:
|
|
39
|
-
// The success case will be handled outside of the switch block
|
|
40
|
-
break;
|
|
41
|
-
case res.error instanceof SDKValidationError:
|
|
42
|
-
// Pretty-print validation errors.
|
|
43
|
-
return console.log(res.error.pretty());
|
|
44
|
-
case res.error instanceof Error:
|
|
45
|
-
return console.log(res.error);
|
|
46
|
-
default:
|
|
47
|
-
// TypeScript's type checking will fail on the following line if the above
|
|
48
|
-
// cases were not exhaustive.
|
|
49
|
-
res.error satisfies never;
|
|
50
|
-
throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
const { value: result } = res;
|
|
55
|
-
|
|
56
|
-
// Handle the result
|
|
57
|
-
console.log(result);
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
run();
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
## Result types
|
|
64
|
-
|
|
65
|
-
Standalone functions differ from SDK methods in that they return a
|
|
66
|
-
`Result<Value, Error>` type to capture _known errors_ and document them using
|
|
67
|
-
the type system. By avoiding throwing errors, application code maintains clear
|
|
68
|
-
control flow and error-handling become part of the regular flow of application
|
|
69
|
-
code.
|
|
70
|
-
|
|
71
|
-
> We use the term "known errors" because standalone functions, and JavaScript
|
|
72
|
-
> code in general, can still throw unexpected errors such as `TypeError`s,
|
|
73
|
-
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
|
74
|
-
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
|
75
|
-
> of benefit from capturing most errors and turning them into values.
|
|
76
|
-
|
|
77
|
-
The second reason for this style of programming is because these functions will
|
|
78
|
-
typically be used in front-end applications where exception throwing is
|
|
79
|
-
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
|
80
|
-
and libraries tend to promote this style of programming so that components
|
|
81
|
-
render useful content under all states (loading, success, error and so on).
|
|
82
|
-
|
|
83
|
-
The general pattern when calling standalone functions looks like this:
|
|
84
|
-
|
|
85
|
-
```typescript
|
|
86
|
-
import { Core } from "<sdk-package-name>";
|
|
87
|
-
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
|
88
|
-
|
|
89
|
-
const client = new Core();
|
|
90
|
-
|
|
91
|
-
async function run() {
|
|
92
|
-
const result = await fetchSomething(client, { id: "123" });
|
|
93
|
-
if (!result.ok) {
|
|
94
|
-
// You can throw the error or handle it. It's your choice now.
|
|
95
|
-
throw result.error;
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
console.log(result.value);
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
run();
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
Notably, `result.error` above will have an explicit type compared to a try-catch
|
|
105
|
-
variation where the error in the catch block can only be of type `unknown` (or
|
|
106
|
-
`any` depending on your TypeScript settings).
|