@arcmira/langchain 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; 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, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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

@@ -1,3 +1,43 @@
-# Temporary Holding Version
+# Arcmira: YouTube Transcript Search for LangChain
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Native LangChain tools for searching indexed YouTube transcripts and resolving people, organizations, products, topics and channels with Arcmira.
+
+Check [release status](https://github.com/arcmira/integrations/blob/master/RELEASE.md) for npm and catalog availability. The quick start below runs the source checkout.
+
+[Arcmira](https://arcmira.com) · [API docs](https://arcmira.com/docs) · [Authentication](https://arcmira.com/docs/authentication) · [Usage and billing](https://arcmira.com/docs/usage-and-billing)
+
+## Quick start
+
+Use Node.js 22 or later.
+
+```sh
+git clone https://github.com/arcmira/integrations.git
+cd integrations/packages/langchain
+npm ci --ignore-scripts
+npm run build
+export ARCMIRA_API_KEY='your-key'
+node --input-type=module <<'JS'
+import { createArcmiraTools } from "./dist/index.js";
+
+const [search, resolve] = createArcmiraTools({
+  apiKey: process.env.ARCMIRA_API_KEY ?? "",
+});
+
+const result = await search.invoke({ q: "AI agents", limit: 5 });
+console.log(result);
+JS
+```
+
+The registry package exports the same function as `@arcmira/langchain`. Its peers are `@langchain/core` and `zod`.
+
+Pass both returned tools to a LangChain agent or a LangGraph `ToolNode`. The tool names are `arcmira_search` and `arcmira_resolve`. The API key belongs in server-side configuration, never in tool arguments or a public browser bundle.
+
+Resolve a name before using ID filters. A channel's `youtube_channel_id` goes in `channel_ids`. Preserve ambiguous results for the user to disambiguate. Search accepts the current API's topic, entity, channel, speaker, mention kind, source, date and result-limit filters. Returned passages retain source URLs, timestamps and coverage notes.
+
+A paid read uses credits from your plan, then your on-demand budget. Account access and indexed coverage vary. An empty result does not prove a topic was never discussed. Speaker labels are not available for every show. These tools expose search and entity resolution; they do not retrieve a full transcript or manage monitors.
+
+API errors propagate with their code, status and response body. The adapter makes no retries and does not change refused filters or transcript sources. When using `ToolNode`, choose error handling for your application; the verification workflow uses `{ handleToolErrors: false }` to retain the original SDK error. Runnable cancellation reaches the API request.
+
+## Local verification
+
+The candidate uses Arcmira SDK 0.6.0. `npm run build` checks the public TypeScript declarations. `npm test` runs a compiled LangGraph against synthetic HTTP fixtures, covering filters, evidence, entity ambiguity, refusal responses, input validation and cancellation. An earlier live check with SDK 0.4.3 executed search and entity resolution against Arcmira through a compiled LangGraph with existing smoke-test access. Both return source-backed data. No model inference is part of these checks. Production authentication rejection is also verified with an invalid key.

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import { type DynamicStructuredTool } from "@langchain/core/tools";
+import { ArcmiraClient } from "arcmira";
+import { z } from "zod";
+import { searchInput, resolveInput } from "./inputs.js";
+export type ArcmiraToolsOptions = {
+    apiKey: string;
+    fetch?: typeof fetch;
+};
+export type ArcmiraTools = [
+    DynamicStructuredTool<typeof searchInput, z.output<typeof searchInput>, z.input<typeof searchInput>, Awaited<ReturnType<ArcmiraClient["transcripts"]["search"]>>>,
+    DynamicStructuredTool<typeof resolveInput, z.output<typeof resolveInput>, z.input<typeof resolveInput>, Awaited<ReturnType<ArcmiraClient["entities"]["resolve"]>>>
+];
+export declare function createArcmiraTools(options: ArcmiraToolsOptions): ArcmiraTools;

package/dist/index.js

@@ -0,0 +1,20 @@
+import { tool } from "@langchain/core/tools";
+import { ArcmiraClient } from "arcmira";
+import { z } from "zod";
+import { searchInput, resolveInput } from "./inputs.js";
+export function createArcmiraTools(options) {
+    const apiKey = z.string().trim().min(1).parse(options.apiKey);
+    const client = new ArcmiraClient({ apiKey, fetch: options.fetch, maxRetries: 0 });
+    return [
+        tool((input, config) => client.transcripts.search(input, { abortSignal: config.signal }), {
+            name: "arcmira_search",
+            description: "Search indexed YouTube transcripts for timestamped passages. Use one topic per call. Resolve names with arcmira_resolve before using ID filters. Preserve returned coverage notes and source links. Account access and speaker coverage vary. A paid read uses credits from your plan, then your on-demand budget. Do not silently widen refused filters or substitute another transcript source.",
+            schema: searchInput,
+        }),
+        tool((input, config) => client.entities.resolve(input, { abortSignal: config.signal }), {
+            name: "arcmira_resolve",
+            description: "Resolve one person, organization, product, topic or channel name to Arcmira IDs before searching. Use the user's context to disambiguate. Preserve ambiguous candidates instead of treating a suggestion as confirmed. Use a channel's returned youtube_channel_id in the search channel_ids filter.",
+            schema: resolveInput,
+        }),
+    ];
+}

package/dist/inputs.d.ts

@@ -0,0 +1,30 @@
+import { z } from "zod";
+export declare const searchInput: z.ZodObject<{
+    q: z.ZodString;
+    channel_ids: z.ZodOptional<z.ZodString>;
+    channel: z.ZodOptional<z.ZodString>;
+    entity_ids: z.ZodOptional<z.ZodString>;
+    about: z.ZodOptional<z.ZodString>;
+    by: z.ZodOptional<z.ZodString>;
+    kind: z.ZodOptional<z.ZodString>;
+    after: z.ZodOptional<z.ZodString>;
+    before: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodEnum<{
+        arcmira_premium: "arcmira_premium";
+        creator_captions: "creator_captions";
+        third_party_quick: "third_party_quick";
+    }>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export declare const resolveInput: z.ZodObject<{
+    q: z.ZodString;
+    type: z.ZodOptional<z.ZodEnum<{
+        channel: "channel";
+        person: "person";
+        organization: "organization";
+        product: "product";
+        topic: "topic";
+    }>>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    context: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;

package/dist/inputs.js

@@ -0,0 +1,20 @@
+import { z } from "zod";
+export const searchInput = z.object({
+    q: z.string().min(2).describe("One topic or phrase. Do not concatenate unrelated names; make one call per topic."),
+    channel_ids: z.string().optional().describe("Comma-separated YouTube channel ids (UC...), at most 8. Pass every show in scope unless drilling into one. Ids only: a name answers 400 id_required. Resolve names first with GET /v1/entities/resolve."),
+    channel: z.string().optional().describe("Alias of channel_ids for code-mode clients; the union of both is the scope."),
+    entity_ids: z.string().optional().describe("Comma-separated entity ids (ent_{n}), at most 8. A person id filters to that person's appearances; a channel id widens channel_ids. Ids only: a name answers 400 id_required. Resolve names first with GET /v1/entities/resolve."),
+    about: z.string().optional().describe("Comma-separated entity ids (ent_{n}), at most 8. Only passages about these entities: excerpt pins, exact-name mentions and ad verdicts. Ids only: a name answers 400 id_required. Resolve names first with GET /v1/entities/resolve."),
+    by: z.string().optional().describe("Comma-separated person ids (ent_{n}), at most 8. Only passages where one of these people says the query words (each line of a chunk is labeled with its speaker); a non-person id is refused with invalid_query naming its type. Speaker labels cover a minority of shows; an empty result carries a note saying whether the person is labeled anywhere. Ids only: a name answers 400 id_required. Resolve names first with GET /v1/entities/resolve."),
+    kind: z.string().optional().describe("Comma-separated passage classes: sponsored, organic, mention. Combine with about to read what was said about a brand in ad reads or in organic talk."),
+    after: z.string().optional().describe("Only media published at or after this instant. An after later than your plan's freshness gate is refused with freshness_requires_paid rather than widened. An ISO 8601 date (2026-09-01) or datetime with offset (2026-09-01T00:00:00Z), read in UTC. The window is half-open: after is inclusive, before is exclusive."),
+    before: z.string().optional().describe("Only media published before this instant, so before=2026-09-02 includes all of 2026-09-01. An ISO 8601 date (2026-09-01) or datetime with offset (2026-09-01T00:00:00Z), read in UTC. The window is half-open: after is inclusive, before is exclusive."),
+    source: z.enum(["arcmira_premium", "creator_captions", "third_party_quick"]).optional().describe("Restrict to one transcript source class. arcmira_premium on a plan without Premium transcripts is refused with filter_requires_paid."),
+    limit: z.number().int().min(1).max(20).optional().describe("Chunks to return, 1 to 20. Default 5."),
+}).strict();
+export const resolveInput = z.object({
+    q: z.string().min(2).describe("A name, @handle, YouTube URL or channel id (UC...). One thing per call."),
+    type: z.enum(["person", "organization", "product", "topic", "channel"]).optional().describe("Restrict candidates to one type. Pass channel for a show and read best.youtube_channel_id."),
+    limit: z.number().int().min(1).max(15).optional().describe("Candidates to return, 1 to 15. Default 8."),
+    context: z.string().min(2).max(300).optional().describe("What the user said about the name, in their words (\"the startup bank\", \"Canada's prime minister\", \"on My First Million\"). Ranks candidates by their description and by the episodes they share with what the context names; a clear winner comes back as suggested with reason context."),
+}).strict();

package/package.json

@@ -1,6 +1,64 @@
 {
   "name": "@arcmira/langchain",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "type": "module",
+  "description": "YouTube transcript search and entity resolution tools for LangChain, powered by Arcmira.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "node --test test/*.test.mjs"
+  },
+  "dependencies": {
+    "arcmira": "0.6.0"
+  },
+  "peerDependencies": {
+    "@langchain/core": "^1.2.13",
+    "zod": "^4.6.5"
+  },
+  "devDependencies": {
+    "@langchain/core": "1.2.13",
+    "@langchain/langgraph": "1.4.18",
+    "@types/node": "24.10.1",
+    "typescript": "5.9.3",
+    "zod": "4.6.5"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://arcmira.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arcmira/integrations.git",
+    "directory": "packages/langchain"
+  },
+  "bugs": {
+    "url": "https://github.com/arcmira/integrations/issues"
+  },
+  "author": "Arcmira",
+  "keywords": [
+    "youtube-transcript-search",
+    "youtube",
+    "transcript-search",
+    "arcmira",
+    "langchain",
+    "langgraph",
+    "tools"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}