@idfkit/core 0.0.1 → 0.2.0-rc.1

package/README.md

@@ -16,17 +16,26 @@ npm install @idfkit/core @idfkit/schemas
 
 ## Entry points
 
-| Import                     | Contents                                                 | Environment |
-| -------------------------- | -------------------------------------------------------- | ----------- |
-| `@idfkit/core`             | Parsing, writing, the object model. Synchronous, no I/O. | Anywhere    |
-| `@idfkit/core/node`        | `loadIdf`, `saveIdf`, schema discovery from disk         | Node        |
-| `@idfkit/core/types/v26-1` | Generated interfaces and `TypeMap` for one version       | Types only  |
+| Import              | Contents                                                 | Environment |
+| ------------------- | -------------------------------------------------------- | ----------- |
+| `@idfkit/core`      | Parsing, writing, the object model. Synchronous, no I/O. | Anywhere    |
+| `@idfkit/core/node` | `loadIdf`, `saveIdf`, schema discovery from disk         | Node        |
+
+Generated per-version field types are **not** in this package. They are opt-in,
+one package per EnergyPlus version, installed by name:
+
+```bash
+npm install --save-dev @idfkit/types-v26-1   # or @idfkit/types-v9-4
+```
+
+Install neither and this package is complete: a document with no type map is
+typed permissively, and every operation below works unchanged.
 
 ## Usage
 
 ```ts
 import { loadIdf, saveIdf } from '@idfkit/core/node';
-import type { TypeMap } from '@idfkit/core/types/v26-1';
+import type { TypeMap } from '@idfkit/types-v26-1';
 
 const doc = await loadIdf<TypeMap>('model.idf');
 
@@ -97,7 +106,7 @@ The full API is generated from the source and published at
 
 The main entry points:
 
-- **`IDFDocument<M>`** — collections by type, a live reference graph, bound to
+- **`IdfDocument<M>`** — collections by type, a live reference graph, bound to
   one EnergyPlus version. `M` is an optional generated type map; omit it and
   everything still works, just untyped.
 - **`IdfObject`** — one EnergyPlus object. Fields are real properties;

package/dist/collection.d.ts

@@ -31,18 +31,5 @@ export declare class IdfCollection<T extends IdfObject = IdfObject> implements I
     find(predicate: (obj: T, index: number) => boolean): T | undefined;
     /** Objects whose `field` equals `value`, compared case-insensitively. */
     where(field: string, value: string): T[];
-    /** @internal */
-    insert(obj: T): void;
-    /** @internal */
-    delete(name: string): boolean;
-    /**
-     * Re-key an object after a rename, preserving insertion order.
-     *
-     * A plain delete-then-insert would move the object to the end of the
-     * collection, which shows up as a spurious reordering when the document is
-     * written back out.
-     * @internal
-     */
-    rekey(previous: string, next: string): void;
 }
 //# sourceMappingURL=collection.d.ts.map

package/dist/collection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../src/collection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;GASG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,CAAE,YAAW,QAAQ,CAAC,CAAC,CAAC;;IAChF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAKd,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,QAAQ,CAAC,CAAC,CAAM;IAKvD,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC;IAIhC,2CAA2C;IAC3C,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAIhC,2CAA2C;IAC3C,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC;IAQxB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B,oEAAoE;IACpE,IAAI,IAAI,IAAI,CAAC,GAAG,SAAS,CAGxB;IAED,4CAA4C;IAC5C,IAAI,KAAK,IAAI,CAAC,GAAG,SAAS,CAEzB;IAED,KAAK,IAAI,MAAM,EAAE;IAIjB,OAAO,IAAI,CAAC,EAAE;IAId,MAAM,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,GAAG,CAAC,EAAE;IAI1D,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,EAAE;IAI7C,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,GAAG,CAAC,GAAG,SAAS;IAIlE,yEAAyE;IACzE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,EAAE;IAUxC,gBAAgB;IAChB,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI;IAIpB,gBAAgB;IAChB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI7B;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;CAQ5C"}
+{"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../src/collection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;GASG;AACH,qBAAa,aAAa,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,CAAE,YAAW,QAAQ,CAAC,CAAC,CAAC;;IAChF,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;gBAKd,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,QAAQ,CAAC,CAAC,CAAM;IAKvD,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC;IAIhC,2CAA2C;IAC3C,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAIhC,2CAA2C;IAC3C,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC;IAQxB,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI1B,oEAAoE;IACpE,IAAI,IAAI,IAAI,CAAC,GAAG,SAAS,CAGxB;IAED,4CAA4C;IAC5C,IAAI,KAAK,IAAI,CAAC,GAAG,SAAS,CAEzB;IAED,KAAK,IAAI,MAAM,EAAE;IAIjB,OAAO,IAAI,CAAC,EAAE;IAId,MAAM,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,GAAG,CAAC,EAAE;IAI1D,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,EAAE;IAI7C,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,GAAG,CAAC,GAAG,SAAS;IAIlE,yEAAyE;IACzE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,EAAE;CAoCzC"}

package/dist/collection.js

@@ -71,7 +71,7 @@ export class IdfCollection {
             return typeof actual === 'string' && actual.toLowerCase() === needle;
         });
     }
-    // --- mutation, used by IDFDocument -------------------------------------
+    // --- mutation, used by IdfDocument -------------------------------------
     /** @internal */
     insert(obj) {
         this.#byName.set(obj.key.toLowerCase(), obj);

package/dist/conformance.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Auto-generated conformance declaration.
+ *
+ * DO NOT EDIT. Regenerate with:
+ *     node scripts/emit-conformance.mjs
+ *
+ * The value is derived from `idfkit.conformance` in `packages/core/package.json`, which is the
+ * one place the level is authored. `npm run check:conformance-level` regenerates this file and
+ * diffs it, so the declaration and the export cannot drift apart.
+ */
+/**
+ * The conformance corpus level this release is checked against, as an immutable tag in
+ * idfkit/idfkit-conformance. A release asserts this claim in its own checks (FR-024): the corpus
+ * at this tag passes against this library, or the release does not ship.
+ *
+ * This is not a version number and it is not compared to one. Two installed libraries agree on the
+ * formats when they declare the same level, whatever their own versions say (FR-025).
+ */
+export declare const CONFORMANCE_LEVEL = "conformance-2026.7";
+//# sourceMappingURL=conformance.d.ts.map

package/dist/conformance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conformance.d.ts","sourceRoot":"","sources":["../src/conformance.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,uBAAuB,CAAC"}

package/dist/conformance.js

@@ -0,0 +1,20 @@
+/**
+ * Auto-generated conformance declaration.
+ *
+ * DO NOT EDIT. Regenerate with:
+ *     node scripts/emit-conformance.mjs
+ *
+ * The value is derived from `idfkit.conformance` in `packages/core/package.json`, which is the
+ * one place the level is authored. `npm run check:conformance-level` regenerates this file and
+ * diffs it, so the declaration and the export cannot drift apart.
+ */
+/**
+ * The conformance corpus level this release is checked against, as an immutable tag in
+ * idfkit/idfkit-conformance. A release asserts this claim in its own checks (FR-024): the corpus
+ * at this tag passes against this library, or the release does not ship.
+ *
+ * This is not a version number and it is not compared to one. Two installed libraries agree on the
+ * formats when they declare the same level, whatever their own versions say (FR-025).
+ */
+export const CONFORMANCE_LEVEL = 'conformance-2026.7';
+//# sourceMappingURL=conformance.js.map

package/dist/conformance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conformance.js","sourceRoot":"","sources":["../src/conformance.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,oBAAoB,CAAC"}

package/dist/docs-url/index.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Documentation URL builder for docs.idfkit.com.
+ *
+ * Port of `idfkit/src/idfkit/docs.py`. The two libraries must produce
+ * byte-identical addresses, so every rule here mirrors the Python one exactly:
+ * the same version gate, the same bundled object-type mapping, the same
+ * schema-group fallback, and the same labels down to the em dash.
+ *
+ * Synchronous and free of I/O, like the rest of the `@idfkit/core` root entry.
+ * The one place Python is not — it lazily loads the latest schema when the
+ * caller omits one — is the single documented divergence; see
+ * {@link ioReferenceUrl}.
+ */
+import type { Schema } from '@idfkit/schemas';
+/** A resolved documentation URL with metadata. */
+export interface DocsUrl {
+    readonly url: string;
+    /** Python spells this `doc_set`; the field-casing rule renames it here. */
+    readonly docSet: 'io-reference' | 'engineering-reference' | 'search';
+    /** Short version used in the URL path, e.g. `v25.2`. */
+    readonly version: string;
+    /** Human-readable label, e.g. `Zone — I/O Reference`. */
+    readonly label: string;
+}
+/**
+ * Build a docs.idfkit.com URL for an object's I/O Reference page.
+ *
+ * Uses a bundled mapping from the documentation search index for accurate URLs.
+ * Falls back to schema-based group slug construction when the object type is
+ * not in the mapping.
+ *
+ * Returns undefined when the object type cannot be resolved or the version has
+ * no documentation.
+ *
+ * DIVERGENCE FROM PYTHON. `idfkit.docs.io_reference_url` also takes an optional
+ * schema, but when it is omitted and the mapping misses, it loads the schema for
+ * the latest EnergyPlus version from disk and tries the group fallback against
+ * that. Loading a schema is I/O and asynchronous here, and the `@idfkit/core`
+ * root entry is neither, so this returns undefined in that case instead. Pass a
+ * schema to get the fallback. The two libraries agree whenever the object type
+ * is in the mapping (which is every type the search index covers) and whenever
+ * a schema is supplied.
+ *
+ * @param objType EnergyPlus object type name, e.g. `Zone`.
+ * @param version EnergyPlus version, e.g. `26.1.0`.
+ * @param schema Schema for the fallback group lookup. Without it, an object
+ *   type outside the bundled mapping resolves to undefined.
+ * @param options `baseUrl` overrides the documentation site root, for tests.
+ */
+export declare function ioReferenceUrl(objType: string, version: string, schema?: Schema, options?: {
+    baseUrl?: string;
+}): DocsUrl | undefined;
+/**
+ * Build a docs.idfkit.com URL for the Engineering Reference landing page.
+ *
+ * Returns undefined if the version has no documentation.
+ */
+export declare function engineeringReferenceUrl(version: string, options?: {
+    baseUrl?: string;
+}): DocsUrl | undefined;
+/**
+ * Build a docs.idfkit.com URL for searching or browsing documentation.
+ *
+ * Links to the version's I/O Reference overview page, where the reader can
+ * browse or search for the object type. Returns undefined if the version has no
+ * documentation.
+ */
+export declare function searchUrl(query: string, version: string, options?: {
+    baseUrl?: string;
+}): DocsUrl | undefined;
+/**
+ * The best documentation URL for an object type.
+ *
+ * Tries the I/O Reference; returns undefined if the object type cannot be
+ * resolved or the version has no documentation. Carries the same omitted-schema
+ * divergence as {@link ioReferenceUrl}.
+ */
+export declare function docsUrlForObject(objType: string, version: string, schema?: Schema, options?: {
+    baseUrl?: string;
+}): DocsUrl | undefined;
+//# sourceMappingURL=index.d.ts.map

package/dist/docs-url/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs-url/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAQ9C,kDAAkD;AAClD,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,2EAA2E;IAC3E,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,uBAAuB,GAAG,QAAQ,CAAC;IACrE,wDAAwD;IACxD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAuGD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7B,OAAO,GAAG,SAAS,CAmBrB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7B,OAAO,GAAG,SAAS,CASrB;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7B,OAAO,GAAG,SAAS,CASrB;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7B,OAAO,GAAG,SAAS,CAErB"}

package/dist/docs-url/index.js

@@ -0,0 +1,201 @@
+/**
+ * Documentation URL builder for docs.idfkit.com.
+ *
+ * Port of `idfkit/src/idfkit/docs.py`. The two libraries must produce
+ * byte-identical addresses, so every rule here mirrors the Python one exactly:
+ * the same version gate, the same bundled object-type mapping, the same
+ * schema-group fallback, and the same labels down to the em dash.
+ *
+ * Synchronous and free of I/O, like the rest of the `@idfkit/core` root entry.
+ * The one place Python is not — it lazily loads the latest schema when the
+ * caller omits one — is the single documented divergence; see
+ * {@link ioReferenceUrl}.
+ */
+import { versionKey } from '../versions.js';
+import { DOC_LOCATIONS } from './locations.js';
+/** @internal Not public API: `baseUrl` overrides exist for tests. */
+const BASE_URL = 'https://docs.idfkit.com';
+/**
+ * EnergyPlus versions that have documentation on docs.idfkit.com.
+ *
+ * Mirrors `ENERGYPLUS_VERSIONS` in `idfkit/src/idfkit/versions.py`, which is
+ * what `is_supported_version` gates on. The set has to be identical in both
+ * libraries: a version in one and not the other means one emits a link where
+ * the other emits nothing. `docs-url.test.ts` holds this against the versions
+ * the schema bundle actually ships.
+ *
+ * @internal
+ */
+const DOCUMENTED_VERSIONS = [
+    '8.9.0',
+    '9.0.1',
+    '9.1.0',
+    '9.2.0',
+    '9.3.0',
+    '9.4.0',
+    '9.5.0',
+    '9.6.0',
+    '22.1.0',
+    '22.2.0',
+    '23.1.0',
+    '23.2.0',
+    '24.1.0',
+    '24.2.0',
+    '25.1.0',
+    '25.2.0',
+    '26.1.0',
+];
+/**
+ * Numeric version key -> the `vM.m` path segment.
+ *
+ * Keyed numerically rather than by string so that `9.01.0` and `9.1.0` are the
+ * same version, the way the Python tuple `(9, 1, 0)` is one value however it
+ * was spelled. The short form is taken from the registered version rather than
+ * from the caller's string, so the emitted path is canonical either way.
+ *
+ * @internal
+ */
+const SHORT_VERSIONS = new Map(DOCUMENTED_VERSIONS.map((version) => {
+    const [major, minor] = version.split('.');
+    return [versionKey(version), `v${major}.${minor}`];
+}));
+/**
+ * Object type -> documentation location, built on first use.
+ *
+ * Deferred the way Python defers reading `doc_locations.json`, so importing
+ * `@idfkit/core` costs nothing until something asks for a documentation URL.
+ *
+ * @internal
+ */
+let locations;
+/** @internal */
+function docLocations() {
+    if (locations === undefined) {
+        locations = new Map();
+        for (const [path, types] of DOC_LOCATIONS) {
+            for (const objType of types.split('\t')) {
+                locations.set(objType, `${path}${objectAnchor(objType)}`);
+            }
+        }
+    }
+    return locations;
+}
+/** @internal Mirrors `_object_anchor`: strip `:`, `/`, `(`, `)` and spaces. */
+function objectAnchor(objType) {
+    return objType.toLowerCase().replace(/[:/() ]/g, '');
+}
+/**
+ * The `vM.m` path segment, or undefined when the version has no documentation.
+ *
+ * @internal
+ */
+function resolveDocVersion(version) {
+    return SHORT_VERSIONS.get(versionKey(version));
+}
+/**
+ * The IDD group for an object type, matching Python's `schema.get_group`.
+ *
+ * That lookup is a plain dict access, so it is exact-case. `Schema.get` is
+ * case-insensitive, which would make this library emit a URL for `zone` where
+ * Python emits nothing, so the case check is reinstated here. `resolve` returns
+ * the input unchanged exactly when the schema holds that spelling.
+ *
+ * @internal
+ */
+function resolveGroup(objType, schema) {
+    if (schema === undefined)
+        return undefined;
+    if (schema.resolve(objType) !== objType)
+        return undefined;
+    return schema.get(objType)?.g;
+}
+/**
+ * Build a docs.idfkit.com URL for an object's I/O Reference page.
+ *
+ * Uses a bundled mapping from the documentation search index for accurate URLs.
+ * Falls back to schema-based group slug construction when the object type is
+ * not in the mapping.
+ *
+ * Returns undefined when the object type cannot be resolved or the version has
+ * no documentation.
+ *
+ * DIVERGENCE FROM PYTHON. `idfkit.docs.io_reference_url` also takes an optional
+ * schema, but when it is omitted and the mapping misses, it loads the schema for
+ * the latest EnergyPlus version from disk and tries the group fallback against
+ * that. Loading a schema is I/O and asynchronous here, and the `@idfkit/core`
+ * root entry is neither, so this returns undefined in that case instead. Pass a
+ * schema to get the fallback. The two libraries agree whenever the object type
+ * is in the mapping (which is every type the search index covers) and whenever
+ * a schema is supplied.
+ *
+ * @param objType EnergyPlus object type name, e.g. `Zone`.
+ * @param version EnergyPlus version, e.g. `26.1.0`.
+ * @param schema Schema for the fallback group lookup. Without it, an object
+ *   type outside the bundled mapping resolves to undefined.
+ * @param options `baseUrl` overrides the documentation site root, for tests.
+ */
+export function ioReferenceUrl(objType, version, schema, options) {
+    const ver = resolveDocVersion(version);
+    if (ver === undefined)
+        return undefined;
+    const baseUrl = options?.baseUrl ?? BASE_URL;
+    const label = `${objType} — I/O Reference`;
+    // Primary: the bundled mapping, which is accurate because it comes from the
+    // documentation search index rather than from a guess about the URL shape.
+    const location = docLocations().get(objType);
+    if (location !== undefined) {
+        return { url: `${baseUrl}/${ver}/${location}`, docSet: 'io-reference', version: ver, label };
+    }
+    // Fallback: derive from the schema group. May be inaccurate for some groups.
+    const group = resolveGroup(objType, schema);
+    if (group === undefined)
+        return undefined;
+    const slug = group.toLowerCase().replaceAll(' ', '-');
+    const url = `${baseUrl}/${ver}/io-reference/overview/group-${slug}/#${objectAnchor(objType)}`;
+    return { url, docSet: 'io-reference', version: ver, label };
+}
+/**
+ * Build a docs.idfkit.com URL for the Engineering Reference landing page.
+ *
+ * Returns undefined if the version has no documentation.
+ */
+export function engineeringReferenceUrl(version, options) {
+    const ver = resolveDocVersion(version);
+    if (ver === undefined)
+        return undefined;
+    return {
+        url: `${options?.baseUrl ?? BASE_URL}/${ver}/engineering-reference/`,
+        docSet: 'engineering-reference',
+        version: ver,
+        label: 'Engineering Reference',
+    };
+}
+/**
+ * Build a docs.idfkit.com URL for searching or browsing documentation.
+ *
+ * Links to the version's I/O Reference overview page, where the reader can
+ * browse or search for the object type. Returns undefined if the version has no
+ * documentation.
+ */
+export function searchUrl(query, version, options) {
+    const ver = resolveDocVersion(version);
+    if (ver === undefined)
+        return undefined;
+    return {
+        url: `${options?.baseUrl ?? BASE_URL}/${ver}/io-reference/overview/`,
+        docSet: 'search',
+        version: ver,
+        label: `Search: ${query}`,
+    };
+}
+/**
+ * The best documentation URL for an object type.
+ *
+ * Tries the I/O Reference; returns undefined if the object type cannot be
+ * resolved or the version has no documentation. Carries the same omitted-schema
+ * divergence as {@link ioReferenceUrl}.
+ */
+export function docsUrlForObject(objType, version, schema, options) {
+    return ioReferenceUrl(objType, version, schema, options);
+}
+//# sourceMappingURL=index.js.map

package/dist/docs-url/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/docs-url/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAIH,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAE/C,qEAAqE;AACrE,MAAM,QAAQ,GAAG,yBAAyB,CAAC;AAa3C;;;;;;;;;;GAUG;AACH,MAAM,mBAAmB,GAAsB;IAC7C,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;CACT,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,cAAc,GAAgC,IAAI,GAAG,CACzD,mBAAmB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;IAClC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC1C,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC,CAAC;AACrD,CAAC,CAAC,CACH,CAAC;AAEF;;;;;;;GAOG;AACH,IAAI,SAA0C,CAAC;AAE/C,gBAAgB;AAChB,SAAS,YAAY;IACnB,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,aAAa,EAAE,CAAC;YAC1C,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,+EAA+E;AAC/E,SAAS,YAAY,CAAC,OAAe;IACnC,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AACvD,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,OAAe;IACxC,OAAO,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,YAAY,CAAC,OAAe,EAAE,MAA0B;IAC/D,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC3C,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,OAAO;QAAE,OAAO,SAAS,CAAC;IAC1D,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAe,EACf,OAAe,EACf,MAAe,EACf,OAA8B;IAE9B,MAAM,GAAG,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACvC,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACxC,MAAM,OAAO,GAAG,OAAO,EAAE,OAAO,IAAI,QAAQ,CAAC;IAC7C,MAAM,KAAK,GAAG,GAAG,OAAO,kBAAkB,CAAC;IAE3C,4EAA4E;IAC5E,2EAA2E;IAC3E,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC7C,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,EAAE,GAAG,EAAE,GAAG,OAAO,IAAI,GAAG,IAAI,QAAQ,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;IAC/F,CAAC;IAED,6EAA6E;IAC7E,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC5C,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACtD,MAAM,GAAG,GAAG,GAAG,OAAO,IAAI,GAAG,gCAAgC,IAAI,KAAK,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9F,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;AAC9D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,OAAe,EACf,OAA8B;IAE9B,MAAM,GAAG,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACvC,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO;QACL,GAAG,EAAE,GAAG,OAAO,EAAE,OAAO,IAAI,QAAQ,IAAI,GAAG,yBAAyB;QACpE,MAAM,EAAE,uBAAuB;QAC/B,OAAO,EAAE,GAAG;QACZ,KAAK,EAAE,uBAAuB;KAC/B,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CACvB,KAAa,EACb,OAAe,EACf,OAA8B;IAE9B,MAAM,GAAG,GAAG,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACvC,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO;QACL,GAAG,EAAE,GAAG,OAAO,EAAE,OAAO,IAAI,QAAQ,IAAI,GAAG,yBAAyB;QACpE,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,GAAG;QACZ,KAAK,EAAE,WAAW,KAAK,EAAE;KAC1B,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,OAAe,EACf,OAAe,EACf,MAAe,EACf,OAA8B;IAE9B,OAAO,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC"}

package/dist/docs-url/locations.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=locations.d.ts.map

package/dist/docs-url/locations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"locations.d.ts","sourceRoot":"","sources":["../../src/docs-url/locations.ts"],"names":[],"mappings":""}