@volter/twin-pinecone 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,57 @@
1
+ # @volter/twin-pinecone
2
+
3
+ > **Legacy connector helpers:** this package still has callable helpers using the retired v1
4
+ > `syncPull` API. Those paths require migration before use on the current kernel;
5
+ > older helper descriptions below do not establish current compatibility. Check the
6
+ > [generated index](../../../generated/INDEX.md) for protocol standing and use the
7
+ > [shared model](../../../docs/concepts/the-model.md) for current state semantics.
8
+
9
+ Local Pinecone twin for the **vector-database** surface: index/collection management on the
10
+ control plane (`api.pinecone.io`), vector upsert/fetch/update/delete, a REAL brute-force top-K
11
+ similarity **query** (cosine / dotproduct / euclidean — exact, not approximate) gated by a REAL
12
+ Mongo-style metadata **filter** evaluator, namespaces, `describe_index_stats`, and host-split
13
+ control/data-plane routing — built on the shared `@volter/world-core` kernel. API-first vendor (no
14
+ product UI to mirror — the real surface agents integrate with is the REST API /
15
+ `@pinecone-database/pinecone` SDK, not the Pinecone console).
16
+
17
+ ```bash
18
+ bun packages/twin/pinecone/src/cli.ts
19
+ ```
20
+
21
+ ## Coverage
22
+
23
+ This is a v1 slice of the Pinecone API, not the full surface. Modeled **`done`**: index
24
+ management (create/list/describe/configure/delete, a deterministic minted per-index data-plane
25
+ host), collection management (create/list/describe/delete), vector upsert/fetch/update/delete
26
+ (by-ids, delete-all-in-namespace, delete-by-filter), vector list, **query with all three real
27
+ similarity metrics** (cosine, dotproduct, euclidean — hand-computed expected scores/ordering in
28
+ the test suite, including a crafted vector set where cosine and dotproduct rank neighbors
29
+ *differently* and a filter that excludes the otherwise-nearest match), namespace isolation,
30
+ `describe_index_stats`, and the host-split control/data-plane router.
31
+
32
+ Left as **`todo`** (honest gaps, not yet modeled): sparse/hybrid search + reranking, `$exists` /
33
+ deep-nested metadata filters, pod-based index configuration (replicas/pod-types/serverless-vs-pod
34
+ choice), deletion-protection enforcement, collection-from-index full snapshot/restore semantics,
35
+ bulk import (start/status/list/cancel), backups/restore, integrated inference (embed/rerank) and
36
+ the integrated-embedding surface (`createIndexForModel`, `/records/{namespace}/upsert|search`),
37
+ namespace list/delete as their own endpoints, real cursor pagination on `vectors.list`, the full
38
+ gRPC-status error-details envelope, the control-plane error-shape's exact wire format, API-key
39
+ 401 auth parity, real (non-zero) `indexFullness`, connector push, and a fixture-seed helper.
40
+
41
+ See `src/pinecone-capabilities.ts` for the full manifest (the real vendor surface is the
42
+ denominator — coverage is honest and partial until the twin reaches it).
43
+
44
+ ## A note on the query engine's honesty
45
+
46
+ Unlike this repo's generative twins (Anthropic/OpenAI/Replicate/fal), Pinecone's core operation —
47
+ nearest-neighbor search over stored vectors — is **genuinely computable offline**: given the
48
+ stored values, exact cosine/dotproduct/euclidean top-K is deterministic, correct math, not a
49
+ placeholder. `src/pinecone-similarity.ts` and `src/pinecone-filter.ts` are net-new modules (not
50
+ produced by cloning the `replicate` skeleton this pack started from) implementing that real
51
+ compute — see their file headers for the exact grounded semantics, including the one doc-
52
+ UNVERIFIED item (euclidean's exact wire-level score/sign) called out inline.
53
+
54
+ ## No webhooks, no signed requests
55
+
56
+ Pinecone's v1 REST surface has no webhook/signed-request surface (unlike Replicate/fal), so this
57
+ pack has no webhook module and no pure-crypto mutation-test allow entries.
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env node
2
+ export {};
@@ -0,0 +1,26 @@
1
+ #!/usr/bin/env node
2
+ import { keepProcessAlive } from '@volter/world-core/lifecycle';
3
+ // world-pinecone CLI: serve the KERNEL-BACKED Pinecone API twin, or run conformance. State
4
+ // lives in the @volter/world-core action log (no in-memory side-store). Conformance is dev-only +
5
+ // lazy-imported so the bin runs without @volter/world-tooling (E2).
6
+ import { hasFlag, optionValue } from '@volter/world-core/args';
7
+ import { createPineconeTwinServer } from "./pinecone-server.js";
8
+ const [cmd, ...rest] = process.argv.slice(2);
9
+ const port = Number(optionValue(rest, '--port', String(process.env.PORT ?? '0'))) || undefined;
10
+ const root = optionValue(rest, '--root') || undefined;
11
+ const readOnly = hasFlag(rest, '--read-only'); // a twin accepts writes unless started read-only
12
+ if (cmd === 'serve' || cmd === undefined) {
13
+ const s = await createPineconeTwinServer({ readOnly, ...(root ? { root } : {}), ...(port ? { port } : {}) });
14
+ process.stdout.write(`pinecone twin (vector database: indexes/collections/vectors + real similarity query)${readOnly ? ' [read-only]' : ''} at http://127.0.0.1:${s.port}\n`);
15
+ await keepProcessAlive();
16
+ }
17
+ else if (cmd === 'conformance') {
18
+ const { checkPineconeConformance } = await import("./pinecone-conformance.js");
19
+ const report = checkPineconeConformance();
20
+ process.stdout.write(`${JSON.stringify(report, null, 2)}\n`);
21
+ if (!report.ok)
22
+ process.exitCode = 1;
23
+ }
24
+ else {
25
+ process.stdout.write('Usage: world-pinecone serve|conformance [--port N] [--root DIR] [--read-only]\n');
26
+ }
@@ -0,0 +1,13 @@
1
+ export { handlePineconeTwinRequest, routePineconeSurface, mintHost, recoverIndexFromHost, pineconeTwinSnapshot, PINECONE_RESOURCE_TYPES, } from './pinecone-twin.js';
2
+ export type { PineconeRequest, PineconeResponse, PineconeSurface, PineconeResourceType, PineconeTwinSnapshot, } from './pinecone-twin.js';
3
+ export { createPineconeTwinFetch, createPineconeTwinServer, type PineconeTwinFetchOptions } from './pinecone-server.js';
4
+ export { mapIndex, mapVector, pullPineconeIndexes, pullPineconeVectors, syncPineconeFromReal, } from './pinecone-connector.js';
5
+ export type { PineconeLikeClient, PineconeRealIndex, PineconeRealVector, PineconeBudgetedOptions } from './pinecone-connector.js';
6
+ export { PINECONE_BUDGETED_METHODS, PINECONE_BUDGET_CEILING, PINECONE_BUDGET_MAX_RETRY_AFTER_S, PINECONE_BUDGET_WINDOW_MS, PINECONE_CALL_WEIGHTS, PINECONE_RATE_BUDGET, PineconeBudget, PineconeBudgetError, pineconeBudgetPath, pineconeCallWeight, pineconeClientBudget, guardPineconeClient, } from './pinecone-budget.js';
7
+ export type { PineconeBudgetErrorKind, PineconeBudgetOptions, PineconeBudgetReservation, PineconeBudgetSnapshot } from './pinecone-budget.js';
8
+ export { matchesFilter } from './pinecone-filter.js';
9
+ export type { PineconeFilter } from './pinecone-filter.js';
10
+ export { cosineSimilarity, dotProduct, squaredEuclideanDistance, scoreVector, sortByScore } from './pinecone-similarity.js';
11
+ export type { PineconeMetric } from './pinecone-similarity.js';
12
+ import type { TwinPack } from '@volter/world-core';
13
+ export declare const pack: TwinPack;
@@ -0,0 +1,50 @@
1
+ // @volter/twin-pinecone — the Pinecone (pinecone.io) vector-database API twin, built on the
2
+ // shared @volter/world-core kernel. Host-split REST transport: control plane (api.pinecone.io — index/
3
+ // collection management) + per-index data plane (a minted host — vector upsert/fetch/update/
4
+ // delete, REAL cosine/dotproduct/euclidean similarity query with a REAL Mongo-style metadata
5
+ // filter, namespaces, describe_index_stats). State lives entirely in the kernel action log (no
6
+ // side-store). API-first vendor: no mirror, no UI capabilities (ui-scope.json).
7
+ //
8
+ // INTEGRATED EMBEDDING IS A TODO: callers supply their own vectors today. The QUERY itself is a
9
+ // genuine strong done: exact brute-force top-K is a faithful, CORRECT superset of Pinecone's
10
+ // approximate-NN recall (see README ## Coverage). (Conformance/capability tooling lives in @volter/world-tooling, a dev dependency —
11
+ // NOT shipped.)
12
+ export { handlePineconeTwinRequest, routePineconeSurface, mintHost, recoverIndexFromHost, pineconeTwinSnapshot, PINECONE_RESOURCE_TYPES, } from "./pinecone-twin.js";
13
+ export { createPineconeTwinFetch, createPineconeTwinServer } from "./pinecone-server.js";
14
+ export { mapIndex, mapVector, pullPineconeIndexes, pullPineconeVectors, syncPineconeFromReal, } from "./pinecone-connector.js";
15
+ // The client-side rate budget — the fail-closed backstop every live call goes through. The
16
+ // MECHANISM is the kernel's shared, vendor-agnostic `RateBudget`; what lives here is this vendor's
17
+ // DECLARATION (window/ceiling/per-method weights) plus `guardPineconeClient`, the choke point the
18
+ // connector entrypoints apply unconditionally. Exported so an operator can inspect spend
19
+ // (`snapshot`) and a caller can catch `PineconeBudgetError` by type; there is deliberately no export
20
+ // that disables the guard.
21
+ export { PINECONE_BUDGETED_METHODS, PINECONE_BUDGET_CEILING, PINECONE_BUDGET_MAX_RETRY_AFTER_S, PINECONE_BUDGET_WINDOW_MS, PINECONE_CALL_WEIGHTS, PINECONE_RATE_BUDGET, PineconeBudget, PineconeBudgetError, pineconeBudgetPath, pineconeCallWeight, pineconeClientBudget, guardPineconeClient, } from "./pinecone-budget.js";
22
+ export { matchesFilter } from "./pinecone-filter.js";
23
+ export { cosineSimilarity, dotProduct, squaredEuclideanDistance, scoreVector, sortByScore } from "./pinecone-similarity.js";
24
+ import { PINECONE_RATE_BUDGET as RATE_BUDGET } from "./pinecone-budget.js";
25
+ export const pack = {
26
+ // The SAME object pinecone-budget.ts declares at module load — one source of truth, so registering
27
+ // the pack and importing the connector can never arm two different ceilings.
28
+ rateBudget: RATE_BUDGET,
29
+ vendor: 'pinecone',
30
+ transport: 'rest',
31
+ archetype: 'crud',
32
+ bin: 'world-pinecone',
33
+ resources: ['index', 'collection', 'vector'],
34
+ specSource: 'pinecone-conformance.ts (endpoint/resource inventory grounded against the installed @pinecone-database/pinecone SDK\'s own generated TypeScript-fetch client, fetched read-only via npm during the build — see spec-sources.json)',
35
+ description: 'Pinecone vector-database twin — index/collection management (control plane), vector upsert/fetch/update/delete, REAL brute-force cosine/dotproduct/euclidean similarity query with a REAL Mongo-style metadata filter evaluator, namespaces, describe_index_stats, host-split control/data-plane routing. Kernel-backed. No mirror (API-first vendor).',
36
+ browserRouting: { apiPathPrefix: '/', loaderHost: 'https://api.pinecone.io' },
37
+ // INTERCEPTION RULING — hostsNone, the pack's own home for it: control/data host split with
38
+ // per-index data-plane hostnames ({index}-{project}.svc.{env}.pinecone.io, see the pack
39
+ // README) — SDK is pointed at the twin by explicit host config.
40
+ hostsNone: "control/data host split with per-index data-plane hostnames ({index}-{project}.svc.{env}.pinecone.io, see the pack README) — SDK is pointed at the twin by explicit host config",
41
+ // Adoption, moved off the central maps unchanged (descriptor-first back-migration, adding-a-twin.md §3,
42
+ // 2026-08-31).
43
+ adoption: {
44
+ // Pinecone's official Python SDK under its current name and its deprecated one - repos carry both.
45
+ pypi: ['pinecone', 'pinecone-client'],
46
+ sdks: ['@pinecone-database/pinecone'],
47
+ scopes: ['@pinecone-database/'],
48
+ envStems: ['PINECONE'],
49
+ },
50
+ };
@@ -0,0 +1,85 @@
1
+ import { RateBudget, type RateBudgetDeclaration, type RateBudgetOptions, type RateBudgetReservation, type RateBudgetSnapshot } from '@volter/world-core';
2
+ import type { PineconeLikeClient } from './pinecone-connector.js';
3
+ /** Rolling window, in ms. Spend older than this is pruned. */
4
+ export declare const PINECONE_BUDGET_WINDOW_MS = 60000;
5
+ /** Weighted units allowed inside one window. See the header for where this number comes from. */
6
+ export declare const PINECONE_BUDGET_CEILING = 60;
7
+ /** Seconds. A `Retry-After` above this means the credential is throttled hard — fail loudly. */
8
+ export declare const PINECONE_BUDGET_MAX_RETRY_AFTER_S = 300;
9
+ /** Per-call cost, keyed by the client method the guard is about to invoke. See the header. */
10
+ export declare const PINECONE_CALL_WEIGHTS: {
11
+ /** `listVectors` — the per-index, per-namespace paginated aggregation. */
12
+ readonly fanout: 4;
13
+ /** Every other modeled call (`listIndexes`, and anything unclassified). */
14
+ readonly other: 2;
15
+ };
16
+ /**
17
+ * The client methods this pack PRICES BY NAME, as dotted paths into the injected client.
18
+ *
19
+ * Two kinds of entry: (a) every method this connector actually calls, and (b) an endpoint the
20
+ * VENDOR documents in a distinct tier which a consumer can reach through the guarded client even
21
+ * though this connector never calls it (see the weights section of the header). Used to build the
22
+ * guarded surface — and, in the pack's own suite, the counting fake.
23
+ *
24
+ * NOT a closed list, and not a claim about the injected client's shape. A path the real client does
25
+ * not have is SKIPPED (this connector's members are optional; inventing one would turn "observe
26
+ * nothing" into "call something that isn't there"), and a method absent from this list is still
27
+ * PRICED at `defaultWeight` when a caller reaches for it — an unmodeled endpoint must never be
28
+ * free, and dropping one would be worse than free because it would be invisible.
29
+ */
30
+ export declare const PINECONE_BUDGETED_METHODS: readonly ["listIndexes", "listVectors"];
31
+ /** THE PACK'S DECLARATION — pure data, the only Pinecone-specific thing in the whole budget. */
32
+ export declare const PINECONE_RATE_BUDGET: RateBudgetDeclaration;
33
+ /** Price one Pinecone call by its client method key (a dotted path, e.g. `listIndexes`). */
34
+ export declare function pineconeCallWeight(method: string): number;
35
+ /** Where Pinecone's ledger lives. Token-keyed and cwd-independent by default (the vendor limits per
36
+ * credential, so a cwd-scoped ledger would hand the same credential a fresh allowance in every
37
+ * checkout, worktree and CI matrix leg); pass `root` to opt into world-scoped accounting. */
38
+ export declare function pineconeBudgetPath(opts?: {
39
+ root?: string;
40
+ token?: string;
41
+ } | string): string;
42
+ /** Construction options for Pinecone's budget. The vendor is fixed; everything else may only TIGHTEN. */
43
+ export type PineconeBudgetOptions = Omit<RateBudgetOptions, 'vendor'>;
44
+ /**
45
+ * Pinecone's budget — the shared kernel guard bound to this vendor's declaration. A real subclass,
46
+ * not an alias, so `budget instanceof PineconeBudget` means "a budget that accounts against this
47
+ * vendor's ledger under this vendor's ceiling": another vendor's `RateBudget` (with its own,
48
+ * possibly larger, ceiling) is NOT assignable where one of these is required.
49
+ */
50
+ export declare class PineconeBudget extends RateBudget {
51
+ constructor(opts?: PineconeBudgetOptions);
52
+ }
53
+ export type { RateBudgetErrorKind as PineconeBudgetErrorKind } from '@volter/world-core';
54
+ export { RateBudgetError as PineconeBudgetError } from '@volter/world-core';
55
+ export type PineconeBudgetReservation = RateBudgetReservation;
56
+ export type PineconeBudgetSnapshot = RateBudgetSnapshot;
57
+ /** What every budgeted connector entrypoint accepts. There is deliberately no option that turns the
58
+ * guard OFF — only ones that say WHICH ledger and clock to account against. */
59
+ export type PineconeBudgetedOptions = {
60
+ /** An existing budget to share across calls. Omit and one is constructed. Cannot be null. */
61
+ budget?: PineconeBudget;
62
+ /** Construction options for the default budget (ledger path, clock). Cannot loosen it. */
63
+ budgetOptions?: PineconeBudgetOptions;
64
+ };
65
+ /** Pull the budget wiring out of a caller's opts bag, so an entrypoint can forward it verbatim. */
66
+ export declare function pineconeBudgetOf(opts: PineconeBudgetedOptions): PineconeBudgetedOptions;
67
+ /** Is this client already behind a budget? Returns the budget it is behind, if so. */
68
+ export declare function pineconeClientBudget(client: unknown): RateBudget | undefined;
69
+ /**
70
+ * Wrap an INJECTED Pinecone client so EVERY call it makes is charged against the shared budget
71
+ * BEFORE the request goes out. This pack's connector never constructs the transport itself (the
72
+ * consumer injects a client that satisfies `PineconeLikeClient` structurally), so the guard is a
73
+ * DECORATOR rather than a factory — which is exactly why every connector entrypoint applies it
74
+ * UNCONDITIONALLY instead of trusting the caller to have done it.
75
+ *
76
+ * IDEMPOTENT: wrapping an already-guarded client returns it unchanged, so a caller who forgot is
77
+ * protected and a caller who wrapped deliberately is not double-charged.
78
+ *
79
+ * A method that THROWS is still inspected: an SDK typically RAISES on a 429 rather than returning
80
+ * it, and that error's back-off is exactly the signal that must become a persisted cooldown. Losing
81
+ * it would leave the ledger cheerfully spending into a throttled credential. The original error is
82
+ * always re-raised afterwards — the budget never swallows a vendor failure — EXCEPT when the
83
+ * back-off is beyond the cap, where the budget's own louder "stop calling" error takes precedence.
84
+ */
85
+ export declare function guardPineconeClient(client: PineconeLikeClient, opts?: PineconeBudgetedOptions): PineconeLikeClient;