@raily/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,166 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or agreed
+      to in writing, Licensor provides the Work (and each Contributor
+      provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES
+      OR CONDITIONS OF ANY KIND, either express or implied, including,
+      without limitation, any warranties or conditions of TITLE,
+      NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
+      PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Raily
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,71 @@
+# Raily TypeScript SDK
+
+Official TypeScript/JavaScript client for the [Raily](https://raily.ai) search API —
+search your own sources from your app with a typed, one-call client.
+
+[Documentation](https://docs.raily.ai) · [Source](https://github.com/Raily-ai/raily-typescript)
+
+## Install
+
+```bash
+npm install @raily/sdk
+```
+
+## Quickstart
+
+```ts
+import { Raily } from "@raily/sdk";
+
+const client = new Raily({ apiKey: "rly_...", endpoint: "https://<your-endpoint-url>" });
+
+const hits = await client.search("anti-aging serum", { limit: 5 });
+for (const hit of hits) {
+  console.log(hit.id, hit.score, hit.fields, hit.text);
+}
+```
+
+## Authentication
+
+Create an API key in your Raily workspace (**Identities → API keys**) and pass it as
+`apiKey`. The `endpoint` is your endpoint's URL. A key is scoped to one workspace and to
+the endpoint it was issued for — using it elsewhere is rejected.
+
+```ts
+const client = new Raily({
+  apiKey: process.env.RAILY_API_KEY!,
+  endpoint: process.env.RAILY_ENDPOINT!,
+});
+```
+
+## Results
+
+`search()` resolves to `SearchHit[]`:
+
+| field | type | meaning |
+|---|---|---|
+| `id` | `string \| null` | stable result id |
+| `score` | `number \| null` | relevance score |
+| `source_collection` | `string \| null` | the source the hit came from |
+| `fields` | `unknown[]` | rendered display fields (when the source's display is configured) |
+| `text` | `string \| null` | rendered text |
+| `raw` | `Record<string, unknown>` | the full result object (forward-compatible) |
+
+## Errors
+
+```ts
+import { RailyError, RailyAuthError } from "@raily/sdk";
+
+try {
+  await client.search("query");
+} catch (err) {
+  if (err instanceof RailyAuthError) {
+    // key missing / invalid / expired / not authorized for this endpoint
+  } else if (err instanceof RailyError) {
+    // everything else (network, server, protocol)
+  }
+}
+```
+
+## License
+
+Apache-2.0

package/dist/index.cjs

@@ -0,0 +1,130 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  Raily: () => Raily,
+  RailyAuthError: () => RailyAuthError,
+  RailyError: () => RailyError
+});
+module.exports = __toCommonJS(index_exports);
+var import_client = require("@modelcontextprotocol/sdk/client/index.js");
+var import_streamableHttp = require("@modelcontextprotocol/sdk/client/streamableHttp.js");
+var AUTH_SIGNALS = ["401", "403", "unauthorized", "forbidden", "invalid api key", "not active"];
+function properties(tool) {
+  return tool.inputSchema?.properties ?? {};
+}
+function pickSearchTool(tools) {
+  if (!tools || tools.length === 0) throw new RailyError("this endpoint exposes no tools.");
+  const queryTools = tools.filter((t) => "query" in properties(t) && t.name !== "search_app");
+  if (queryTools.length === 0) throw new RailyError("this endpoint exposes no search tool.");
+  const signature = queryTools.filter((t) => "exact_user_query" in properties(t));
+  const pool = signature.length > 0 ? signature : queryTools;
+  return pool.find((t) => t.name === "search") ?? pool[0];
+}
+function buildArgs(tool, query, limit) {
+  const props = properties(tool);
+  const args = { query };
+  if ("exact_user_query" in props) args.exact_user_query = query;
+  if ("limit" in props) args.limit = limit;
+  return args;
+}
+var RailyError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "RailyError";
+  }
+};
+var RailyAuthError = class extends RailyError {
+  constructor(message) {
+    super(message);
+    this.name = "RailyAuthError";
+  }
+};
+function isAuthError(err) {
+  const anyErr = err;
+  const status = anyErr?.status ?? anyErr?.code;
+  if (status === 401 || status === 403) return true;
+  const text = String(anyErr?.message ?? err ?? "").toLowerCase();
+  return AUTH_SIGNALS.some((s) => text.includes(s));
+}
+function toHit(value) {
+  const r = value ?? {};
+  const id = r.id;
+  const score = r.score;
+  return {
+    id: id === void 0 || id === null ? null : String(id),
+    score: typeof score === "number" ? score : null,
+    source_collection: r.source_collection ?? null,
+    fields: Array.isArray(r.fields) ? r.fields : [],
+    text: r.text || null,
+    raw: r
+  };
+}
+function parseHits(structured) {
+  const results = structured?.results;
+  return Array.isArray(results) ? results.map(toHit) : [];
+}
+var Raily = class {
+  apiKey;
+  endpoint;
+  timeoutMs;
+  constructor(options) {
+    if (!options?.apiKey) throw new RailyError("apiKey is required");
+    if (!options?.endpoint) throw new RailyError("endpoint is required");
+    this.apiKey = options.apiKey;
+    this.endpoint = options.endpoint;
+    this.timeoutMs = options.timeoutMs ?? 6e4;
+  }
+  async search(query, options = {}) {
+    if (!query) throw new RailyError("query is required");
+    const transport = new import_streamableHttp.StreamableHTTPClientTransport(new URL(this.endpoint), {
+      requestInit: { headers: { Authorization: `Bearer ${this.apiKey}` } }
+    });
+    const client = new import_client.Client({ name: "raily-sdk", version: "0.1.0" }, { capabilities: {} });
+    const limit = options.limit ?? 3;
+    try {
+      await client.connect(transport);
+      const { tools } = await client.listTools();
+      const tool = pickSearchTool(tools);
+      const result = await client.callTool(
+        { name: tool.name, arguments: buildArgs(tool, query, limit) },
+        void 0,
+        { timeout: this.timeoutMs }
+      );
+      if (result?.isError) {
+        throw new RailyError("search failed on the server.");
+      }
+      return parseHits(result.structuredContent).slice(0, limit);
+    } catch (err) {
+      if (err instanceof RailyError) throw err;
+      if (isAuthError(err)) throw new RailyAuthError("API key was rejected for this endpoint.");
+      throw new RailyError(`search request failed: ${String(err?.message ?? err)}`);
+    } finally {
+      await client.close().catch(() => void 0);
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Raily,
+  RailyAuthError,
+  RailyError
+});

package/dist/index.d.cts

@@ -0,0 +1,43 @@
+/** One search result — the curated developer projection, never the raw payload. */
+interface SearchHit {
+    id: string | null;
+    score: number | null;
+    source_collection: string | null;
+    fields: unknown[];
+    text: string | null;
+    /** The full result object, for forward compatibility. */
+    raw: Record<string, unknown>;
+}
+declare class RailyError extends Error {
+    constructor(message: string);
+}
+/** The key was missing/invalid/expired, or not authorized for this endpoint
+ *  (also covers a cross-tenant key or a key bound to a different endpoint). */
+declare class RailyAuthError extends RailyError {
+    constructor(message: string);
+}
+interface RailyOptions {
+    apiKey: string;
+    endpoint: string;
+    /** Request timeout in milliseconds (default 60000). */
+    timeoutMs?: number;
+}
+interface SearchOptions {
+    /** Maximum number of results, 1–10 (default 3). */
+    limit?: number;
+}
+/**
+ * Client for the Raily search API.
+ *
+ * Each call opens a short-lived authenticated connection, so the client holds no
+ * mutable session state and is safe to reuse.
+ */
+declare class Raily {
+    private readonly apiKey;
+    private readonly endpoint;
+    private readonly timeoutMs;
+    constructor(options: RailyOptions);
+    search(query: string, options?: SearchOptions): Promise<SearchHit[]>;
+}
+
+export { Raily, RailyAuthError, RailyError, type RailyOptions, type SearchHit, type SearchOptions };

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+/** One search result — the curated developer projection, never the raw payload. */
+interface SearchHit {
+    id: string | null;
+    score: number | null;
+    source_collection: string | null;
+    fields: unknown[];
+    text: string | null;
+    /** The full result object, for forward compatibility. */
+    raw: Record<string, unknown>;
+}
+declare class RailyError extends Error {
+    constructor(message: string);
+}
+/** The key was missing/invalid/expired, or not authorized for this endpoint
+ *  (also covers a cross-tenant key or a key bound to a different endpoint). */
+declare class RailyAuthError extends RailyError {
+    constructor(message: string);
+}
+interface RailyOptions {
+    apiKey: string;
+    endpoint: string;
+    /** Request timeout in milliseconds (default 60000). */
+    timeoutMs?: number;
+}
+interface SearchOptions {
+    /** Maximum number of results, 1–10 (default 3). */
+    limit?: number;
+}
+/**
+ * Client for the Raily search API.
+ *
+ * Each call opens a short-lived authenticated connection, so the client holds no
+ * mutable session state and is safe to reuse.
+ */
+declare class Raily {
+    private readonly apiKey;
+    private readonly endpoint;
+    private readonly timeoutMs;
+    constructor(options: RailyOptions);
+    search(query: string, options?: SearchOptions): Promise<SearchHit[]>;
+}
+
+export { Raily, RailyAuthError, RailyError, type RailyOptions, type SearchHit, type SearchOptions };

package/dist/index.js

@@ -0,0 +1,103 @@
+// src/index.ts
+import { Client } from "@modelcontextprotocol/sdk/client/index.js";
+import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
+var AUTH_SIGNALS = ["401", "403", "unauthorized", "forbidden", "invalid api key", "not active"];
+function properties(tool) {
+  return tool.inputSchema?.properties ?? {};
+}
+function pickSearchTool(tools) {
+  if (!tools || tools.length === 0) throw new RailyError("this endpoint exposes no tools.");
+  const queryTools = tools.filter((t) => "query" in properties(t) && t.name !== "search_app");
+  if (queryTools.length === 0) throw new RailyError("this endpoint exposes no search tool.");
+  const signature = queryTools.filter((t) => "exact_user_query" in properties(t));
+  const pool = signature.length > 0 ? signature : queryTools;
+  return pool.find((t) => t.name === "search") ?? pool[0];
+}
+function buildArgs(tool, query, limit) {
+  const props = properties(tool);
+  const args = { query };
+  if ("exact_user_query" in props) args.exact_user_query = query;
+  if ("limit" in props) args.limit = limit;
+  return args;
+}
+var RailyError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "RailyError";
+  }
+};
+var RailyAuthError = class extends RailyError {
+  constructor(message) {
+    super(message);
+    this.name = "RailyAuthError";
+  }
+};
+function isAuthError(err) {
+  const anyErr = err;
+  const status = anyErr?.status ?? anyErr?.code;
+  if (status === 401 || status === 403) return true;
+  const text = String(anyErr?.message ?? err ?? "").toLowerCase();
+  return AUTH_SIGNALS.some((s) => text.includes(s));
+}
+function toHit(value) {
+  const r = value ?? {};
+  const id = r.id;
+  const score = r.score;
+  return {
+    id: id === void 0 || id === null ? null : String(id),
+    score: typeof score === "number" ? score : null,
+    source_collection: r.source_collection ?? null,
+    fields: Array.isArray(r.fields) ? r.fields : [],
+    text: r.text || null,
+    raw: r
+  };
+}
+function parseHits(structured) {
+  const results = structured?.results;
+  return Array.isArray(results) ? results.map(toHit) : [];
+}
+var Raily = class {
+  apiKey;
+  endpoint;
+  timeoutMs;
+  constructor(options) {
+    if (!options?.apiKey) throw new RailyError("apiKey is required");
+    if (!options?.endpoint) throw new RailyError("endpoint is required");
+    this.apiKey = options.apiKey;
+    this.endpoint = options.endpoint;
+    this.timeoutMs = options.timeoutMs ?? 6e4;
+  }
+  async search(query, options = {}) {
+    if (!query) throw new RailyError("query is required");
+    const transport = new StreamableHTTPClientTransport(new URL(this.endpoint), {
+      requestInit: { headers: { Authorization: `Bearer ${this.apiKey}` } }
+    });
+    const client = new Client({ name: "raily-sdk", version: "0.1.0" }, { capabilities: {} });
+    const limit = options.limit ?? 3;
+    try {
+      await client.connect(transport);
+      const { tools } = await client.listTools();
+      const tool = pickSearchTool(tools);
+      const result = await client.callTool(
+        { name: tool.name, arguments: buildArgs(tool, query, limit) },
+        void 0,
+        { timeout: this.timeoutMs }
+      );
+      if (result?.isError) {
+        throw new RailyError("search failed on the server.");
+      }
+      return parseHits(result.structuredContent).slice(0, limit);
+    } catch (err) {
+      if (err instanceof RailyError) throw err;
+      if (isAuthError(err)) throw new RailyAuthError("API key was rejected for this endpoint.");
+      throw new RailyError(`search request failed: ${String(err?.message ?? err)}`);
+    } finally {
+      await client.close().catch(() => void 0);
+    }
+  }
+};
+export {
+  Raily,
+  RailyAuthError,
+  RailyError
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@raily/sdk",
+  "version": "0.1.0",
+  "description": "Official TypeScript SDK for the Raily search API.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "require": { "types": "./dist/index.d.cts", "default": "./dist/index.cjs" }
+    }
+  },
+  "files": ["dist", "README.md", "LICENSE"],
+  "repository": { "type": "git", "url": "https://github.com/Raily-ai/raily-typescript.git" },
+  "homepage": "https://docs.raily.ai",
+  "keywords": ["raily", "search", "retrieval", "rag", "mcp", "sdk"],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.12.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0"
+  },
+  "engines": { "node": ">=18" }
+}