@orq-ai/node 3.1.0-rc.64 → 3.1.0

package/docs/sdks/promptsnippets/README.md

@@ -103,30 +103,7 @@ async function run() {
     promptConfig: {
       messages: [
         {
-          role: "system",
-          content: "<value>",
-        },
-        {
-          role: "system",
-          content: [
-            {
-              type: "image_url",
-              imageUrl: {
-                url: "https://well-worn-formation.biz",
-              },
-            },
-            {
-              type: "text",
-              text: "<value>",
-            },
-            {
-              type: "text",
-              text: "<value>",
-            },
-          ],
-        },
-        {
-          role: "assistant",
+          role: "prompt",
           content: "<value>",
         },
       ],
@@ -161,30 +138,7 @@ async function run() {
     promptConfig: {
       messages: [
         {
-          role: "system",
-          content: "<value>",
-        },
-        {
-          role: "system",
-          content: [
-            {
-              type: "image_url",
-              imageUrl: {
-                url: "https://well-worn-formation.biz",
-              },
-            },
-            {
-              type: "text",
-              text: "<value>",
-            },
-            {
-              type: "text",
-              text: "<value>",
-            },
-          ],
-        },
-        {
-          role: "assistant",
+          role: "prompt",
           content: "<value>",
         },
       ],

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@orq-ai/node",
-  "version": "3.1.0-rc.64",
+  "version": "3.1.0",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/lib/config.d.ts

@@ -35,8 +35,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "2.0";
-    readonly sdkVersion: "3.1.0-rc.64";
+    readonly sdkVersion: "3.1.0";
     readonly genVersion: "2.506.0";
-    readonly userAgent: "speakeasy-sdk/typescript 3.1.0-rc.64 2.506.0 2.0 @orq-ai/node";
+    readonly userAgent: "speakeasy-sdk/typescript 3.1.0 2.506.0 2.0 @orq-ai/node";
 };
 //# sourceMappingURL=config.d.ts.map

package/lib/config.js

@@ -28,8 +28,8 @@ function serverURLFromOptions(options) {
 exports.SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "2.0",
-    sdkVersion: "3.1.0-rc.64",
+    sdkVersion: "3.1.0",
     genVersion: "2.506.0",
-    userAgent: "speakeasy-sdk/typescript 3.1.0-rc.64 2.506.0 2.0 @orq-ai/node",
+    userAgent: "speakeasy-sdk/typescript 3.1.0 2.506.0 2.0 @orq-ai/node",
 };
 //# sourceMappingURL=config.js.map

package/lib/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/lib/config.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA4CH,oDAeC;AAtDD,qCAA8C;AAE9C;;GAEG;AACU,QAAA,UAAU,GAAG;IACxB,mBAAmB;CACX,CAAC;AAgCX,SAAgB,oBAAoB,CAAC,OAAmB;IACtD,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,kBAAU,CAAC,MAAM,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,SAAS,GAAG,kBAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,GAAG,IAAA,mBAAU,EAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC;AAEY,QAAA,YAAY,GAAG;IAC1B,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,KAAK;IACxB,UAAU,EAAE,aAAa;IACzB,UAAU,EAAE,SAAS;IACrB,SAAS,EAAE,+DAA+D;CAClE,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/lib/config.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA4CH,oDAeC;AAtDD,qCAA8C;AAE9C;;GAEG;AACU,QAAA,UAAU,GAAG;IACxB,mBAAmB;CACX,CAAC;AAgCX,SAAgB,oBAAoB,CAAC,OAAmB;IACtD,IAAI,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAElC,MAAM,MAAM,GAAW,EAAE,CAAC;IAE1B,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC;QACzC,IAAI,SAAS,GAAG,CAAC,IAAI,SAAS,IAAI,kBAAU,CAAC,MAAM,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,SAAS,GAAG,kBAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC1C,CAAC;IAED,MAAM,CAAC,GAAG,IAAA,mBAAU,EAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;IACxC,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;AACpB,CAAC;AAEY,QAAA,YAAY,GAAG;IAC1B,QAAQ,EAAE,YAAY;IACtB,iBAAiB,EAAE,KAAK;IACxB,UAAU,EAAE,OAAO;IACnB,UAAU,EAAE,SAAS;IACrB,SAAS,EAAE,yDAAyD;CAC5D,CAAC"}

package/models/operations/createcontact.js

@@ -102,7 +102,7 @@ exports.CreateContactResponseBody$inboundSchema = z.object({
     metadata: z.record(z.any()).optional(),
     created: z.string().datetime({ offset: true }).transform(v => new Date(v))
         .optional(),
-    updated: z.string().datetime({ offset: true }).default("2025-02-11T15:57:59.882Z").transform(v => new Date(v)),
+    updated: z.string().datetime({ offset: true }).default("2025-02-11T16:43:21.610Z").transform(v => new Date(v)),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {
         "external_id": "externalId",
@@ -120,7 +120,7 @@ exports.CreateContactResponseBody$outboundSchema = z.object({
     tags: z.array(z.string()).optional(),
     metadata: z.record(z.any()).optional(),
     created: z.date().transform(v => v.toISOString()).optional(),
-    updated: z.date().default(() => new Date("2025-02-11T15:57:59.882Z"))
+    updated: z.date().default(() => new Date("2025-02-11T16:43:21.610Z"))
         .transform(v => v.toISOString()),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {

package/models/operations/createpromptsnippet.js

@@ -2999,7 +2999,7 @@ exports.CreatePromptSnippetResponseBody$inboundSchema = z.object({
     updated_by_id: z.string(),
     created: z.string().datetime({ offset: true }).transform(v => new Date(v))
         .optional(),
-    updated: z.string().datetime({ offset: true }).default("2025-02-11T15:57:59.882Z").transform(v => new Date(v)),
+    updated: z.string().datetime({ offset: true }).default("2025-02-11T16:43:21.610Z").transform(v => new Date(v)),
     type: exports.CreatePromptSnippetPromptSnippetsType$inboundSchema,
     versions: z.array(z.lazy(() => exports.Versions$inboundSchema)),
 }).transform((v) => {
@@ -3023,7 +3023,7 @@ exports.CreatePromptSnippetResponseBody$outboundSchema = z.object({
     createdById: z.string(),
     updatedById: z.string(),
     created: z.date().transform(v => v.toISOString()).optional(),
-    updated: z.date().default(() => new Date("2025-02-11T15:57:59.882Z"))
+    updated: z.date().default(() => new Date("2025-02-11T16:43:21.610Z"))
         .transform(v => v.toISOString()),
     type: exports.CreatePromptSnippetPromptSnippetsType$outboundSchema,
     versions: z.array(z.lazy(() => exports.Versions$outboundSchema)),

package/models/operations/fileget.js

@@ -107,7 +107,7 @@ exports.FileGetResponseBody$inboundSchema = z.object({
     bytes: z.number(),
     file_name: z.string(),
     workspace_id: z.string(),
-    created: z.string().datetime({ offset: true }).default("2025-02-11T15:58:00.983Z").transform(v => new Date(v)),
+    created: z.string().datetime({ offset: true }).default("2025-02-11T16:43:22.676Z").transform(v => new Date(v)),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {
         "_id": "id",
@@ -124,7 +124,7 @@ exports.FileGetResponseBody$outboundSchema = z.object({
     bytes: z.number(),
     fileName: z.string(),
     workspaceId: z.string(),
-    created: z.date().default(() => new Date("2025-02-11T15:58:00.983Z"))
+    created: z.date().default(() => new Date("2025-02-11T16:43:22.676Z"))
         .transform(v => v.toISOString()),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {

package/models/operations/filelist.js

@@ -125,7 +125,7 @@ exports.FileListData$inboundSchema = z.object({
     bytes: z.number(),
     file_name: z.string(),
     workspace_id: z.string(),
-    created: z.string().datetime({ offset: true }).default("2025-02-11T15:58:00.983Z").transform(v => new Date(v)),
+    created: z.string().datetime({ offset: true }).default("2025-02-11T16:43:22.676Z").transform(v => new Date(v)),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {
         "_id": "id",
@@ -142,7 +142,7 @@ exports.FileListData$outboundSchema = z.object({
     bytes: z.number(),
     fileName: z.string(),
     workspaceId: z.string(),
-    created: z.date().default(() => new Date("2025-02-11T15:58:00.983Z"))
+    created: z.date().default(() => new Date("2025-02-11T16:43:22.676Z"))
         .transform(v => v.toISOString()),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {

package/models/operations/fileupload.js

@@ -165,7 +165,7 @@ exports.FileUploadResponseBody$inboundSchema = z.object({
     bytes: z.number(),
     file_name: z.string(),
     workspace_id: z.string(),
-    created: z.string().datetime({ offset: true }).default("2025-02-11T15:58:00.983Z").transform(v => new Date(v)),
+    created: z.string().datetime({ offset: true }).default("2025-02-11T16:43:22.676Z").transform(v => new Date(v)),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {
         "_id": "id",
@@ -182,7 +182,7 @@ exports.FileUploadResponseBody$outboundSchema = z.object({
     bytes: z.number(),
     fileName: z.string(),
     workspaceId: z.string(),
-    created: z.date().default(() => new Date("2025-02-11T15:58:00.983Z"))
+    created: z.date().default(() => new Date("2025-02-11T16:43:22.676Z"))
         .transform(v => v.toISOString()),
 }).transform((v) => {
     return (0, primitives_js_1.remap)(v, {

package/models/operations/findonebykeypromptsnippet.js

@@ -2076,7 +2076,7 @@ exports.FindOneByKeyPromptSnippetResponseBody$inboundSchema = z.object({
     updated_by_id: z.string(),
     created: z.string().datetime({ offset: true }).transform(v => new Date(v))
         .optional(),
-    updated: z.string().datetime({ offset: true }).default("2025-02-11T15:57:59.882Z").transform(v => new Date(v)),
+    updated: z.string().datetime({ offset: true }).default("2025-02-11T16:43:21.610Z").transform(v => new Date(v)),
     type: exports.FindOneByKeyPromptSnippetType$inboundSchema,
     versions: z.array(z.lazy(() => exports.FindOneByKeyPromptSnippetVersions$inboundSchema)),
 }).transform((v) => {
@@ -2100,7 +2100,7 @@ exports.FindOneByKeyPromptSnippetResponseBody$outboundSchema = z.object({
     createdById: z.string(),
     updatedById: z.string(),
     created: z.date().transform(v => v.toISOString()).optional(),
-    updated: z.date().default(() => new Date("2025-02-11T15:57:59.882Z"))
+    updated: z.date().default(() => new Date("2025-02-11T16:43:21.610Z"))
         .transform(v => v.toISOString()),
     type: exports.FindOneByKeyPromptSnippetType$outboundSchema,
     versions: z.array(z.lazy(() => exports.FindOneByKeyPromptSnippetVersions$outboundSchema)),

package/models/operations/findonepromptsnippet.js

@@ -2067,7 +2067,7 @@ exports.FindOnePromptSnippetResponseBody$inboundSchema = z.object({
     updated_by_id: z.string(),
     created: z.string().datetime({ offset: true }).transform(v => new Date(v))
         .optional(),
-    updated: z.string().datetime({ offset: true }).default("2025-02-11T15:57:59.882Z").transform(v => new Date(v)),
+    updated: z.string().datetime({ offset: true }).default("2025-02-11T16:43:21.610Z").transform(v => new Date(v)),
     type: exports.FindOnePromptSnippetType$inboundSchema,
     versions: z.array(z.lazy(() => exports.FindOnePromptSnippetVersions$inboundSchema)),
 }).transform((v) => {
@@ -2091,7 +2091,7 @@ exports.FindOnePromptSnippetResponseBody$outboundSchema = z.object({
     createdById: z.string(),
     updatedById: z.string(),
     created: z.date().transform(v => v.toISOString()).optional(),
-    updated: z.date().default(() => new Date("2025-02-11T15:57:59.882Z"))
+    updated: z.date().default(() => new Date("2025-02-11T16:43:21.610Z"))
         .transform(v => v.toISOString()),
     type: exports.FindOnePromptSnippetType$outboundSchema,
     versions: z.array(z.lazy(() => exports.FindOnePromptSnippetVersions$outboundSchema)),

package/models/operations/getallpromptsnippets.js

@@ -2101,7 +2101,7 @@ exports.GetAllPromptSnippetsData$inboundSchema = z.object({
     updated_by_id: z.string(),
     created: z.string().datetime({ offset: true }).transform(v => new Date(v))
         .optional(),
-    updated: z.string().datetime({ offset: true }).default("2025-02-11T15:57:59.882Z").transform(v => new Date(v)),
+    updated: z.string().datetime({ offset: true }).default("2025-02-11T16:43:21.610Z").transform(v => new Date(v)),
     type: exports.GetAllPromptSnippetsType$inboundSchema,
     versions: z.array(z.lazy(() => exports.GetAllPromptSnippetsVersions$inboundSchema)),
 }).transform((v) => {
@@ -2125,7 +2125,7 @@ exports.GetAllPromptSnippetsData$outboundSchema = z.object({
     createdById: z.string(),
     updatedById: z.string(),
     created: z.date().transform(v => v.toISOString()).optional(),
-    updated: z.date().default(() => new Date("2025-02-11T15:57:59.882Z"))
+    updated: z.date().default(() => new Date("2025-02-11T16:43:21.610Z"))
         .transform(v => v.toISOString()),
     type: exports.GetAllPromptSnippetsType$outboundSchema,
     versions: z.array(z.lazy(() => exports.GetAllPromptSnippetsVersions$outboundSchema)),

package/models/operations/updatepromptsnippet.js

@@ -3059,7 +3059,7 @@ exports.UpdatePromptSnippetResponseBody$inboundSchema = z.object({
     updated_by_id: z.string(),
     created: z.string().datetime({ offset: true }).transform(v => new Date(v))
         .optional(),
-    updated: z.string().datetime({ offset: true }).default("2025-02-11T15:57:59.882Z").transform(v => new Date(v)),
+    updated: z.string().datetime({ offset: true }).default("2025-02-11T16:43:21.610Z").transform(v => new Date(v)),
     type: exports.UpdatePromptSnippetPromptSnippetsType$inboundSchema,
     versions: z.array(z.lazy(() => exports.UpdatePromptSnippetVersions$inboundSchema)),
 }).transform((v) => {
@@ -3083,7 +3083,7 @@ exports.UpdatePromptSnippetResponseBody$outboundSchema = z.object({
     createdById: z.string(),
     updatedById: z.string(),
     created: z.date().transform(v => v.toISOString()).optional(),
-    updated: z.date().default(() => new Date("2025-02-11T15:57:59.882Z"))
+    updated: z.date().default(() => new Date("2025-02-11T16:43:21.610Z"))
         .transform(v => v.toISOString()),
     type: exports.UpdatePromptSnippetPromptSnippetsType$outboundSchema,
     versions: z.array(z.lazy(() => exports.UpdatePromptSnippetVersions$outboundSchema)),

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@orq-ai/node",
-  "version": "3.1.0-rc.64",
+  "version": "3.1.0",
   "author": "Orq",
   "main": "./index.js",
   "sideEffects": false,
   "repository": {
     "type": "git",
-    "url": "https://github.com/orq-ai/orq-node.git",
-    "directory": "packages/orq-rc"
+    "url": "https://github.com/orq-ai/orq-node.git"
   },
   "scripts": {
     "lint": "eslint --cache --max-warnings=0 src",

package/packages/orq-rc/FUNCTIONS.md

@@ -0,0 +1,106 @@
+# Standalone Functions
+
+> [!NOTE]
+> This section is useful if you are using a bundler and targetting browsers and
+> runtimes where the size of an application affects performance and load times. 
+
+Every method in this SDK is also available as a standalone function. This
+alternative API is suitable when targetting the browser or serverless runtimes
+and using a bundler to build your application since all unused functionality
+will be tree-shaken away. This includes code for unused methods, Zod schemas,
+encoding helpers and response handlers. The result is dramatically smaller
+impact on the application's final bundle size which grows very slowly as you use
+more and more functionality from this SDK.
+
+Calling methods through the main SDK class remains a valid and generally more
+more ergonomic option. Standalone functions represent an optimisation for a
+specific category of applications.
+
+## Example
+
+```typescript
+import { OrqCore } from "@orq-ai/node/core.js";
+import { contactsCreate } from "@orq-ai/node/funcs/contactsCreate.js";
+import { SDKValidationError } from "@orq-ai/node/models/errors/sdkvalidationerror.js";
+
+// Use `OrqCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const orq = new OrqCore({
+  apiKey: process.env["ORQ_API_KEY"] ?? "",
+});
+
+async function run() {
+  const res = await contactsCreate(orq, {
+    externalId: "<id>",
+  });
+
+  switch (true) {
+    case res.ok:
+      // The success case will be handled outside of the switch block
+      break;
+    case res.error instanceof SDKValidationError:
+      // Pretty-print validation errors.
+      return console.log(res.error.pretty());
+    case res.error instanceof Error:
+      return console.log(res.error);
+    default:
+      // TypeScript's type checking will fail on the following line if the above
+      // cases were not exhaustive.
+      res.error satisfies never;
+      throw new Error("Assertion failed: expected error checks to be exhaustive: " + res.error);
+  }
+
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+## Result types
+
+Standalone functions differ from SDK methods in that they return a
+`Result<Value, Error>` type to capture _known errors_ and document them using
+the type system. By avoiding throwing errors, application code maintains clear
+control flow and error-handling become part of the regular flow of application
+code.
+
+> We use the term "known errors" because standalone functions, and JavaScript
+> code in general, can still throw unexpected errors such as `TypeError`s,
+> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
+> something this SDK addresses in the future. Nevertheless, there is still a lot
+> of benefit from capturing most errors and turning them into values.
+
+The second reason for this style of programming is because these functions will
+typically be used in front-end applications where exception throwing is
+sometimes discouraged or considered unidiomatic. React and similar ecosystems
+and libraries tend to promote this style of programming so that components
+render useful content under all states (loading, success, error and so on).
+
+The general pattern when calling standalone functions looks like this:
+
+```typescript
+import { Core } from "<sdk-package-name>";
+import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
+
+const client = new Core();
+
+async function run() {
+  const result = await fetchSomething(client, { id: "123" });
+  if (!result.ok) {
+    // You can throw the error or handle it. It's your choice now.
+    throw result.error;
+  }
+
+  console.log(result.value);
+}
+
+run();
+```
+
+Notably, `result.error` above will have an explicit type compared to a try-catch
+variation where the error in the catch block can only be of type `unknown` (or
+`any` depending on your TypeScript settings).