scorecard-ai 1.2.0 → 2.0.0

package/resources/systems/versions.js

@@ -3,79 +3,45 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Versions = void 0;
 const resource_1 = require("../../core/resource.js");
-const pagination_1 = require("../../core/pagination.js");
 const path_1 = require("../../internal/utils/path.js");
 class Versions extends resource_1.APIResource {
     /**
-     * Create a new version for a system.
-     *
-     * Each version contains specific parameter values that match the system's
-     * `configSchema` - things like model parameters, thresholds, or processing
-     * options. Once created, versions cannot be modified, ensuring stable reference
-     * points for evaluations.
-     *
-     * When creating a system version:
-     *
-     * - The `config` object is validated against the parent system's `configSchema`.
-     * - System versions with validation errors are still stored, with errors included
-     *   in the response.
-     * - Validation errors indicate fields that don't match the schema but don't
-     *   prevent creation.
-     * - Having validation errors may affect how some evaluation metrics are
-     *   calculated.
+     * Retrieve a specific system version by ID.
      *
      * @example
      * ```ts
-     * const systemVersion = await client.systems.versions.create(
-     *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
-     *   {
-     *     config: {
-     *       temperature: 0.1,
-     *       maxTokens: 1024,
-     *       model: 'gpt-4-turbo',
-     *     },
-     *     name: 'Production (Low Temperature)',
-     *   },
+     * const systemVersion = await client.systems.versions.get(
+     *   '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
      * );
      * ```
      */
-    create(systemID, body, options) {
-        return this._client.post((0, path_1.path) `/systems/${systemID}/configs`, { body, ...options });
+    get(systemVersionID, options) {
+        return this._client.get((0, path_1.path) `/systems/versions/${systemVersionID}`, options);
     }
     /**
-     * Retrieve a paginated list of system versions for a specific system.
+     * Create a new system version if it does not already exist. Does **not** set the
+     * created version to be the system's production version.
      *
-     * System versions provide concrete parameter values for a System Under Test,
-     * defining exactly how the system should be configured during an evaluation run.
+     * If there is already a system version with the same config, its name will be
+     * updated.
      *
      * @example
      * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const systemVersion of client.systems.versions.list(
+     * const systemVersion = await client.systems.versions.upsert(
      *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
-     * )) {
-     *   // ...
-     * }
-     * ```
-     */
-    list(systemID, query = {}, options) {
-        return this._client.getAPIList((0, path_1.path) `/systems/${systemID}/configs`, (pagination_1.PaginatedResponse), {
-            query,
-            ...options,
-        });
-    }
-    /**
-     * Retrieve a specific system version by ID.
-     *
-     * @example
-     * ```ts
-     * const systemVersion = await client.systems.versions.get(
-     *   '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
+     *   {
+     *     config: {
+     *       temperature: 0.5,
+     *       maxTokens: 1024,
+     *       model: 'gemini-2.0-flash',
+     *     },
+     *     name: 'Test model: Gemini',
+     *   },
      * );
      * ```
      */
-    get(systemVersionID, options) {
-        return this._client.get((0, path_1.path) `/systems/configs/${systemVersionID}`, options);
+    upsert(systemID, body, options) {
+        return this._client.post((0, path_1.path) `/systems/${systemID}/versions`, { body, ...options });
     }
 }
 exports.Versions = Versions;

package/resources/systems/versions.js.map

@@ -1 +1 @@
-{"version":3,"file":"versions.js","sourceRoot":"","sources":["../../src/resources/systems/versions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,yDAAqG;AAErG,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAyB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAAgB,EAChB,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,UAAU,EAAE,CAAA,8BAAgC,CAAA,EAAE;YACnG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,eAAuB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,eAAe,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF;AA9ED,4BA8EC"}
+{"version":3,"file":"versions.js","sourceRoot":"","sources":["../../src/resources/systems/versions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;OASG;IACH,GAAG,CAAC,eAAuB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,qBAAqB,eAAe,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAyB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,QAAQ,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF;AAxCD,4BAwCC"}

package/resources/systems/versions.mjs

@@ -1,78 +1,44 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../../core/resource.mjs";
-import { PaginatedResponse } from "../../core/pagination.mjs";
 import { path } from "../../internal/utils/path.mjs";
 export class Versions extends APIResource {
     /**
-     * Create a new version for a system.
-     *
-     * Each version contains specific parameter values that match the system's
-     * `configSchema` - things like model parameters, thresholds, or processing
-     * options. Once created, versions cannot be modified, ensuring stable reference
-     * points for evaluations.
-     *
-     * When creating a system version:
-     *
-     * - The `config` object is validated against the parent system's `configSchema`.
-     * - System versions with validation errors are still stored, with errors included
-     *   in the response.
-     * - Validation errors indicate fields that don't match the schema but don't
-     *   prevent creation.
-     * - Having validation errors may affect how some evaluation metrics are
-     *   calculated.
+     * Retrieve a specific system version by ID.
      *
      * @example
      * ```ts
-     * const systemVersion = await client.systems.versions.create(
-     *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
-     *   {
-     *     config: {
-     *       temperature: 0.1,
-     *       maxTokens: 1024,
-     *       model: 'gpt-4-turbo',
-     *     },
-     *     name: 'Production (Low Temperature)',
-     *   },
+     * const systemVersion = await client.systems.versions.get(
+     *   '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
      * );
      * ```
      */
-    create(systemID, body, options) {
-        return this._client.post(path `/systems/${systemID}/configs`, { body, ...options });
+    get(systemVersionID, options) {
+        return this._client.get(path `/systems/versions/${systemVersionID}`, options);
     }
     /**
-     * Retrieve a paginated list of system versions for a specific system.
+     * Create a new system version if it does not already exist. Does **not** set the
+     * created version to be the system's production version.
      *
-     * System versions provide concrete parameter values for a System Under Test,
-     * defining exactly how the system should be configured during an evaluation run.
+     * If there is already a system version with the same config, its name will be
+     * updated.
      *
      * @example
      * ```ts
-     * // Automatically fetches more pages as needed.
-     * for await (const systemVersion of client.systems.versions.list(
+     * const systemVersion = await client.systems.versions.upsert(
      *   '12345678-0a8b-4f66-b6f3-2ddcfa097257',
-     * )) {
-     *   // ...
-     * }
-     * ```
-     */
-    list(systemID, query = {}, options) {
-        return this._client.getAPIList(path `/systems/${systemID}/configs`, (PaginatedResponse), {
-            query,
-            ...options,
-        });
-    }
-    /**
-     * Retrieve a specific system version by ID.
-     *
-     * @example
-     * ```ts
-     * const systemVersion = await client.systems.versions.get(
-     *   '87654321-4d3b-4ae4-8c7a-4b6e2a19ccf0',
+     *   {
+     *     config: {
+     *       temperature: 0.5,
+     *       maxTokens: 1024,
+     *       model: 'gemini-2.0-flash',
+     *     },
+     *     name: 'Test model: Gemini',
+     *   },
      * );
      * ```
      */
-    get(systemVersionID, options) {
-        return this._client.get(path `/systems/configs/${systemVersionID}`, options);
+    upsert(systemID, body, options) {
+        return this._client.post(path `/systems/${systemID}/versions`, { body, ...options });
     }
 }
 //# sourceMappingURL=versions.mjs.map

package/resources/systems/versions.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"versions.mjs","sourceRoot":"","sources":["../../src/resources/systems/versions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAe,iBAAiB,EAAgC;OAEhE,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAyB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,QAAQ,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,QAAgB,EAChB,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAA,YAAY,QAAQ,UAAU,EAAE,CAAA,iBAAgC,CAAA,EAAE;YACnG,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,GAAG,CAAC,eAAuB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,eAAe,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;CACF"}
+{"version":3,"file":"versions.mjs","sourceRoot":"","sources":["../../src/resources/systems/versions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,GAAG,CAAC,eAAuB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,qBAAqB,eAAe,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,QAAgB,EAAE,IAAyB,EAAE,OAAwB;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,QAAQ,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF"}

package/src/client.ts

@@ -51,10 +51,10 @@ import {
 } from './resources/testsets';
 import {
   System,
-  SystemCreateParams,
   SystemDeleteResponse,
   SystemListParams,
   SystemUpdateParams,
+  SystemUpsertParams,
   Systems,
   SystemsPaginatedResponse,
 } from './resources/systems/systems';
@@ -119,6 +119,8 @@ export interface ClientOptions {
    *
    * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
    * much longer than this timeout before the promise succeeds or fails.
+   *
+   * @unit milliseconds
    */
   timeout?: number | undefined;
   /**
@@ -883,9 +885,9 @@ export declare namespace Scorecard {
     type System as System,
     type SystemDeleteResponse as SystemDeleteResponse,
     type SystemsPaginatedResponse as SystemsPaginatedResponse,
-    type SystemCreateParams as SystemCreateParams,
     type SystemUpdateParams as SystemUpdateParams,
     type SystemListParams as SystemListParams,
+    type SystemUpsertParams as SystemUpsertParams,
   };
 
   export type APIError = API.APIError;

package/src/internal/request-options.ts

@@ -9,17 +9,70 @@ import { type HeadersLike } from './headers';
 export type FinalRequestOptions = RequestOptions & { method: HTTPMethod; path: string };
 
 export type RequestOptions = {
+  /**
+   * The HTTP method for the request (e.g., 'get', 'post', 'put', 'delete').
+   */
   method?: HTTPMethod;
+
+  /**
+   * The URL path for the request.
+   *
+   * @example "/v1/foo"
+   */
   path?: string;
+
+  /**
+   * Query parameters to include in the request URL.
+   */
   query?: object | undefined | null;
+
+  /**
+   * The request body. Can be a string, JSON object, FormData, or other supported types.
+   */
   body?: unknown;
+
+  /**
+   * HTTP headers to include with the request. Can be a Headers object, plain object, or array of tuples.
+   */
   headers?: HeadersLike;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
   maxRetries?: number;
+
   stream?: boolean | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * @unit milliseconds
+   */
   timeout?: number;
+
+  /**
+   * Additional `RequestInit` options to be passed to the underlying `fetch` call.
+   * These options will be merged with the client's default fetch options.
+   */
   fetchOptions?: MergedRequestInit;
+
+  /**
+   * An AbortSignal that can be used to cancel the request.
+   */
   signal?: AbortSignal | undefined | null;
+
+  /**
+   * A unique key for this request to enable idempotency.
+   */
   idempotencyKey?: string;
+
+  /**
+   * Override the default base URL for this specific request.
+   */
   defaultBaseURL?: string | undefined;
 
   __binaryResponse?: boolean | undefined;

package/src/internal/types.ts

@@ -7,7 +7,7 @@ export type KeysEnum<T> = { [P in keyof Required<T>]: true };
 
 export type FinalizedRequestInit = RequestInit & { headers: Headers };
 
-type NotAny<T> = [unknown] extends [T] ? never : T;
+type NotAny<T> = [0] extends [1 & T] ? never : T;
 
 /**
  * Some environments overload the global fetch function, and Parameters<T> only gets the last signature.
@@ -64,13 +64,15 @@ type OverloadedParameters<T> =
  * [1]: https://www.typescriptlang.org/tsconfig/#typeAcquisition
  */
 /** @ts-ignore For users with \@types/node */
-type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types').RequestInit> | NotAny<import('../../node_modules/undici-types').RequestInit> | NotAny<import('../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types').RequestInit>;
+type UndiciTypesRequestInit = NotAny<import('../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici-types/index.d.ts').RequestInit>;
 /** @ts-ignore For users with undici */
-type UndiciRequestInit = NotAny<import('../node_modules/undici').RequestInit> | NotAny<import('../../node_modules/undici').RequestInit> | NotAny<import('../../../node_modules/undici').RequestInit> | NotAny<import('../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici').RequestInit>;
+type UndiciRequestInit = NotAny<import('../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/undici/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/undici/index.d.ts').RequestInit>;
 /** @ts-ignore For users with \@types/bun */
 type BunRequestInit = globalThis.FetchRequestInit;
-/** @ts-ignore For users with node-fetch */
-type NodeFetchRequestInit = NotAny<import('../node_modules/node-fetch').RequestInit> | NotAny<import('../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/node-fetch').RequestInit>;
+/** @ts-ignore For users with node-fetch@2 */
+type NodeFetch2RequestInit = NotAny<import('../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/@types/node-fetch/index.d.ts').RequestInit>;
+/** @ts-ignore For users with node-fetch@3, doesn't need file extension because types are at ./@types/index.d.ts */
+type NodeFetch3RequestInit =  NotAny<import('../node_modules/node-fetch').RequestInit> | NotAny<import('../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../node_modules/node-fetch').RequestInit> | NotAny<import('../../../../../../../../../../node_modules/node-fetch').RequestInit>;
 /** @ts-ignore For users who use Deno */
 type FetchRequestInit = NonNullable<OverloadedParameters<typeof fetch>[1]>;
 /* eslint-enable */
@@ -79,7 +81,8 @@ type RequestInits =
   | NotAny<UndiciTypesRequestInit>
   | NotAny<UndiciRequestInit>
   | NotAny<BunRequestInit>
-  | NotAny<NodeFetchRequestInit>
+  | NotAny<NodeFetch2RequestInit>
+  | NotAny<NodeFetch3RequestInit>
   | NotAny<RequestInit>
   | NotAny<FetchRequestInit>;
 

package/src/internal/uploads.ts

@@ -90,7 +90,7 @@ export const multipartFormRequestOptions = async (
   return { ...opts, body: await createForm(opts.body, fetch) };
 };
 
-const supportsFormDataMap = /** @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
+const supportsFormDataMap = /* @__PURE__ */ new WeakMap<Fetch, Promise<boolean>>();
 
 /**
  * node-fetch doesn't support the global FormData object in recent node versions. Instead of sending

package/src/internal/utils/log.ts

@@ -58,7 +58,7 @@ const noopLogger = {
   debug: noop,
 };
 
-let cachedLoggers = /** @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
+let cachedLoggers = /* @__PURE__ */ new WeakMap<Logger, [LogLevel, Logger]>();
 
 export function loggerFor(client: Scorecard): Logger {
   const logger = client.logger;

package/src/internal/utils/path.ts

@@ -12,25 +12,43 @@ export function encodeURIPath(str: string) {
   return str.replace(/[^A-Za-z0-9\-._~!$&'()*+,;=:@]+/g, encodeURIComponent);
 }
 
+const EMPTY = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.create(null));
+
 export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
   function path(statics: readonly string[], ...params: readonly unknown[]): string {
     // If there are no params, no processing is needed.
     if (statics.length === 1) return statics[0]!;
 
     let postPath = false;
+    const invalidSegments = [];
     const path = statics.reduce((previousValue, currentValue, index) => {
       if (/[?#]/.test(currentValue)) {
         postPath = true;
       }
-      return (
-        previousValue +
-        currentValue +
-        (index === params.length ? '' : (postPath ? encodeURIComponent : pathEncoder)(String(params[index])))
-      );
+      const value = params[index];
+      let encoded = (postPath ? encodeURIComponent : pathEncoder)('' + value);
+      if (
+        index !== params.length &&
+        (value == null ||
+          (typeof value === 'object' &&
+            // handle values from other realms
+            value.toString ===
+              Object.getPrototypeOf(Object.getPrototypeOf((value as any).hasOwnProperty ?? EMPTY) ?? EMPTY)
+                ?.toString))
+      ) {
+        encoded = value + '';
+        invalidSegments.push({
+          start: previousValue.length + currentValue.length,
+          length: encoded.length,
+          error: `Value of type ${Object.prototype.toString
+            .call(value)
+            .slice(8, -1)} is not a valid path parameter`,
+        });
+      }
+      return previousValue + currentValue + (index === params.length ? '' : encoded);
     }, '');
 
     const pathOnly = path.split(/[?#]/, 1)[0]!;
-    const invalidSegments = [];
     const invalidSegmentPattern = /(?<=^|\/)(?:\.|%2e){1,2}(?=\/|$)/gi;
     let match;
 
@@ -39,9 +57,12 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
       invalidSegments.push({
         start: match.index,
         length: match[0].length,
+        error: `Value "${match[0]}" can\'t be safely passed as a path parameter`,
       });
     }
 
+    invalidSegments.sort((a, b) => a.start - b.start);
+
     if (invalidSegments.length > 0) {
       let lastEnd = 0;
       const underline = invalidSegments.reduce((acc, segment) => {
@@ -52,7 +73,9 @@ export const createPathTagFunction = (pathEncoder = encodeURIPath) =>
       }, '');
 
       throw new ScorecardError(
-        `Path parameters result in path with invalid segments:\n${path}\n${underline}`,
+        `Path parameters result in path with invalid segments:\n${invalidSegments
+          .map((e) => e.error)
+          .join('\n')}\n${path}\n${underline}`,
       );
     }
 

package/src/resources/index.ts

@@ -16,9 +16,9 @@ export {
   Systems,
   type System,
   type SystemDeleteResponse,
-  type SystemCreateParams,
   type SystemUpdateParams,
   type SystemListParams,
+  type SystemUpsertParams,
   type SystemsPaginatedResponse,
 } from './systems/systems';
 export {

package/src/resources/systems/index.ts

@@ -4,15 +4,9 @@ export {
   Systems,
   type System,
   type SystemDeleteResponse,
-  type SystemCreateParams,
   type SystemUpdateParams,
   type SystemListParams,
+  type SystemUpsertParams,
   type SystemsPaginatedResponse,
 } from './systems';
-export {
-  Versions,
-  type SystemVersion,
-  type VersionCreateParams,
-  type VersionListParams,
-  type SystemVersionsPaginatedResponse,
-} from './versions';
+export { Versions, type SystemVersion, type VersionUpsertParams } from './versions';