openlore 2.0.2 → 2.0.4

package/dist/core/scip/moniker.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Derivation of SCIP symbol monikers and language tags from OpenLore graph
+ * nodes.
+ *
+ * SCIP symbols are formatted strings, not structured objects, per the grammar
+ * documented at https://github.com/sourcegraph/scip/blob/main/docs/scip.md.
+ * We emit global symbols of the form:
+ *
+ *   <scheme> ' ' <manager> ' ' <package-name> ' ' <version> <descriptors>
+ *
+ * where descriptors are `<repo-rel-path>/` (namespace) followed by
+ * `<qualified-name>(<arity>).` (method). Example:
+ *
+ *   openlore npm openlore 2.0.2 `src/core/scip/index.ts`/exportScip(1).
+ *
+ * Identifiers containing characters outside the SCIP "simple identifier" set
+ * are backtick-escaped (with embedded backticks doubled).
+ */
+import type { FunctionNode } from '../analyzer/call-graph.js';
+/** Package coordinates that fill the SCIP `<package>` slot of every symbol. */
+export interface PackageInfo {
+    manager: string;
+    name: string;
+    version: string;
+}
+/**
+ * Map an OpenLore language tag (see signature-extractor.ts) to the SCIP
+ * `Language` enum name used as `Document.language`. Returns `''` for languages
+ * SCIP has no value for (the caller records these for the export summary).
+ */
+export declare function scipLanguageName(openloreLanguage: string): string;
+/** Fully-qualified name within a file: `Class.method` or bare `function`. */
+export declare function qualifiedName(node: FunctionNode): string;
+/**
+ * Best-effort parameter count from a node's declaration `signature`. Counts
+ * top-level comma-separated parameters inside the first parenthesized group.
+ * Returns `undefined` when no signature is available (the analyzer does not
+ * persist arity directly — TODO(spec-04-followup): arity in analyzer).
+ */
+export declare function arityOf(node: FunctionNode): number | undefined;
+/**
+ * Build the SCIP symbol moniker string for a function node.
+ *
+ * `repoRelPath` must be the document's relative path (POSIX separators), the
+ * same value used for the node's `Document.relative_path`.
+ */
+export declare function symbolMoniker(node: FunctionNode, repoRelPath: string, pkg: PackageInfo): string;
+//# sourceMappingURL=moniker.d.ts.map

package/dist/core/scip/moniker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"moniker.d.ts","sourceRoot":"","sources":["../../../src/core/scip/moniker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAE9D,+EAA+E;AAC/E,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAcD;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,gBAAgB,EAAE,MAAM,GAAG,MAAM,CAsBjE;AAED,6EAA6E;AAC7E,wBAAgB,aAAa,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAExD;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS,CAoB9D;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,GAAG,MAAM,CAM/F"}

package/dist/core/scip/moniker.js

@@ -0,0 +1,109 @@
+/**
+ * Derivation of SCIP symbol monikers and language tags from OpenLore graph
+ * nodes.
+ *
+ * SCIP symbols are formatted strings, not structured objects, per the grammar
+ * documented at https://github.com/sourcegraph/scip/blob/main/docs/scip.md.
+ * We emit global symbols of the form:
+ *
+ *   <scheme> ' ' <manager> ' ' <package-name> ' ' <version> <descriptors>
+ *
+ * where descriptors are `<repo-rel-path>/` (namespace) followed by
+ * `<qualified-name>(<arity>).` (method). Example:
+ *
+ *   openlore npm openlore 2.0.2 `src/core/scip/index.ts`/exportScip(1).
+ *
+ * Identifiers containing characters outside the SCIP "simple identifier" set
+ * are backtick-escaped (with embedded backticks doubled).
+ */
+const SCHEME = 'openlore';
+/** A simple identifier needs no escaping iff it matches this set entirely. */
+const SIMPLE_IDENTIFIER = /^[A-Za-z0-9\-+$_]+$/;
+/** Escape a name for use as a SCIP descriptor identifier. */
+function escapeName(name) {
+    if (SIMPLE_IDENTIFIER.test(name))
+        return name;
+    // Escaped identifier: wrap in backticks, double any embedded backticks.
+    return '`' + name.replace(/`/g, '``') + '`';
+}
+/**
+ * Map an OpenLore language tag (see signature-extractor.ts) to the SCIP
+ * `Language` enum name used as `Document.language`. Returns `''` for languages
+ * SCIP has no value for (the caller records these for the export summary).
+ */
+export function scipLanguageName(openloreLanguage) {
+    switch (openloreLanguage) {
+        case 'Python':
+        case 'TypeScript':
+        case 'JavaScript':
+        case 'Go':
+        case 'Rust':
+        case 'Ruby':
+        case 'Java':
+        case 'Kotlin':
+        case 'PHP':
+        case 'Swift':
+        case 'C':
+            return openloreLanguage;
+        case 'C++':
+            return 'CPP';
+        case 'C#':
+            return 'CSharp';
+        default:
+            // 'unknown' and anything SCIP lacks an enum value for.
+            return '';
+    }
+}
+/** Fully-qualified name within a file: `Class.method` or bare `function`. */
+export function qualifiedName(node) {
+    return node.className ? `${node.className}.${node.name}` : node.name;
+}
+/**
+ * Best-effort parameter count from a node's declaration `signature`. Counts
+ * top-level comma-separated parameters inside the first parenthesized group.
+ * Returns `undefined` when no signature is available (the analyzer does not
+ * persist arity directly — TODO(spec-04-followup): arity in analyzer).
+ */
+export function arityOf(node) {
+    const sig = node.signature;
+    if (!sig)
+        return undefined;
+    const open = sig.indexOf('(');
+    if (open === -1)
+        return undefined;
+    // Walk to the matching close paren, counting top-level commas.
+    let depth = 0;
+    let commas = 0;
+    let sawContent = false;
+    for (let i = open; i < sig.length; i++) {
+        const ch = sig[i];
+        if (ch === '(' || ch === '[' || ch === '{' || ch === '<')
+            depth++;
+        else if (ch === ')' || ch === ']' || ch === '}' || ch === '>') {
+            depth--;
+            if (depth === 0)
+                break;
+        }
+        else if (ch === ',' && depth === 1)
+            commas++;
+        else if (depth === 1 && !/\s/.test(ch))
+            sawContent = true;
+    }
+    if (!sawContent)
+        return 0;
+    return commas + 1;
+}
+/**
+ * Build the SCIP symbol moniker string for a function node.
+ *
+ * `repoRelPath` must be the document's relative path (POSIX separators), the
+ * same value used for the node's `Document.relative_path`.
+ */
+export function symbolMoniker(node, repoRelPath, pkg) {
+    const namespace = `${escapeName(repoRelPath)}/`;
+    const arity = arityOf(node);
+    const disambiguator = arity === undefined ? '' : String(arity);
+    const method = `${escapeName(qualifiedName(node))}(${disambiguator}).`;
+    return `${SCHEME} ${pkg.manager} ${pkg.name} ${pkg.version} ${namespace}${method}`;
+}
+//# sourceMappingURL=moniker.js.map

package/dist/core/scip/moniker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moniker.js","sourceRoot":"","sources":["../../../src/core/scip/moniker.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAWH,MAAM,MAAM,GAAG,UAAU,CAAC;AAE1B,8EAA8E;AAC9E,MAAM,iBAAiB,GAAG,qBAAqB,CAAC;AAEhD,6DAA6D;AAC7D,SAAS,UAAU,CAAC,IAAY;IAC9B,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC9C,wEAAwE;IACxE,OAAO,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,GAAG,CAAC;AAC9C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,gBAAwB;IACvD,QAAQ,gBAAgB,EAAE,CAAC;QACzB,KAAK,QAAQ,CAAC;QACd,KAAK,YAAY,CAAC;QAClB,KAAK,YAAY,CAAC;QAClB,KAAK,IAAI,CAAC;QACV,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,MAAM,CAAC;QACZ,KAAK,QAAQ,CAAC;QACd,KAAK,KAAK,CAAC;QACX,KAAK,OAAO,CAAC;QACb,KAAK,GAAG;YACN,OAAO,gBAAgB,CAAC;QAC1B,KAAK,KAAK;YACR,OAAO,KAAK,CAAC;QACf,KAAK,IAAI;YACP,OAAO,QAAQ,CAAC;QAClB;YACE,uDAAuD;YACvD,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,aAAa,CAAC,IAAkB;IAC9C,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,IAAkB;IACxC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC;IAC3B,IAAI,CAAC,GAAG;QAAE,OAAO,SAAS,CAAC;IAC3B,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,IAAI,KAAK,CAAC,CAAC;QAAE,OAAO,SAAS,CAAC;IAClC,+DAA+D;IAC/D,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,UAAU,GAAG,KAAK,CAAC;IACvB,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAClB,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG;YAAE,KAAK,EAAE,CAAC;aAC7D,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;YAC9D,KAAK,EAAE,CAAC;YACR,IAAI,KAAK,KAAK,CAAC;gBAAE,MAAM;QACzB,CAAC;aAAM,IAAI,EAAE,KAAK,GAAG,IAAI,KAAK,KAAK,CAAC;YAAE,MAAM,EAAE,CAAC;aAC1C,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAAE,UAAU,GAAG,IAAI,CAAC;IAC5D,CAAC;IACD,IAAI,CAAC,UAAU;QAAE,OAAO,CAAC,CAAC;IAC1B,OAAO,MAAM,GAAG,CAAC,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,IAAkB,EAAE,WAAmB,EAAE,GAAgB;IACrF,MAAM,SAAS,GAAG,GAAG,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC;IAChD,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,aAAa,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/D,MAAM,MAAM,GAAG,GAAG,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,IAAI,aAAa,IAAI,CAAC;IACvE,OAAO,GAAG,MAAM,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,IAAI,SAAS,GAAG,MAAM,EAAE,CAAC;AACrF,CAAC"}

package/dist/core/scip/schema.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Loads the vendored SCIP protobuf schema and exposes the `scip.Index` type.
+ *
+ * The schema is vendored verbatim at `vendor/scip.proto` (pinned — see the
+ * header comment in that file). We parse it at runtime with protobufjs (pure
+ * JS, no native build) rather than committing a generated `pb.js`, which keeps
+ * the vendored artifact human-readable and trivially re-fetchable.
+ */
+import protobuf from 'protobufjs';
+/** Absolute path to the vendored proto, resolved relative to this module. */
+export declare function scipProtoPath(): string;
+/** Parse the vendored proto and return the protobufjs Root. */
+export declare function loadScipRoot(): protobuf.Root;
+/** The `scip.Index` message type, used to verify + serialize an index payload. */
+export declare function scipIndexType(): protobuf.Type;
+/**
+ * SCIP `SymbolRole` bitset values we use. Mirrors the enum in scip.proto.
+ * Kept as a const object (not an import) because the proto enums are not
+ * surfaced as TS values by protobufjs's runtime parse.
+ */
+export declare const SymbolRole: {
+    readonly Definition: 1;
+    readonly ReadAccess: 8;
+};
+/**
+ * SCIP `TextEncoding.UTF8`. The index declares source files are UTF-8 on disk.
+ */
+export declare const TextEncoding_UTF8 = 1;
+/**
+ * SCIP `SymbolInformation.Kind.Function`. Every node we export is a
+ * function/method, so we tag them uniformly.
+ */
+export declare const SymbolKind_Function = 17;
+//# sourceMappingURL=schema.d.ts.map

package/dist/core/scip/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../src/core/scip/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,QAAQ,MAAM,YAAY,CAAC;AAKlC,6EAA6E;AAC7E,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAED,+DAA+D;AAC/D,wBAAgB,YAAY,IAAI,QAAQ,CAAC,IAAI,CAK5C;AAED,kFAAkF;AAClF,wBAAgB,aAAa,IAAI,QAAQ,CAAC,IAAI,CAE7C;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU;;;CAGb,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC;;;GAGG;AACH,eAAO,MAAM,mBAAmB,KAAK,CAAC"}

package/dist/core/scip/schema.js

@@ -0,0 +1,48 @@
+/**
+ * Loads the vendored SCIP protobuf schema and exposes the `scip.Index` type.
+ *
+ * The schema is vendored verbatim at `vendor/scip.proto` (pinned — see the
+ * header comment in that file). We parse it at runtime with protobufjs (pure
+ * JS, no native build) rather than committing a generated `pb.js`, which keeps
+ * the vendored artifact human-readable and trivially re-fetchable.
+ */
+import { readFileSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+import protobuf from 'protobufjs';
+/** Resolved once and memoized — parsing the proto is cheap but not free. */
+let cachedRoot;
+/** Absolute path to the vendored proto, resolved relative to this module. */
+export function scipProtoPath() {
+    return fileURLToPath(new URL('./vendor/scip.proto', import.meta.url));
+}
+/** Parse the vendored proto and return the protobufjs Root. */
+export function loadScipRoot() {
+    if (cachedRoot)
+        return cachedRoot;
+    const protoText = readFileSync(scipProtoPath(), 'utf-8');
+    cachedRoot = protobuf.parse(protoText, { keepCase: true }).root;
+    return cachedRoot;
+}
+/** The `scip.Index` message type, used to verify + serialize an index payload. */
+export function scipIndexType() {
+    return loadScipRoot().lookupType('scip.Index');
+}
+/**
+ * SCIP `SymbolRole` bitset values we use. Mirrors the enum in scip.proto.
+ * Kept as a const object (not an import) because the proto enums are not
+ * surfaced as TS values by protobufjs's runtime parse.
+ */
+export const SymbolRole = {
+    Definition: 0x1,
+    ReadAccess: 0x8,
+};
+/**
+ * SCIP `TextEncoding.UTF8`. The index declares source files are UTF-8 on disk.
+ */
+export const TextEncoding_UTF8 = 1;
+/**
+ * SCIP `SymbolInformation.Kind.Function`. Every node we export is a
+ * function/method, so we tag them uniformly.
+ */
+export const SymbolKind_Function = 17;
+//# sourceMappingURL=schema.js.map

package/dist/core/scip/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../src/core/scip/schema.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAElC,4EAA4E;AAC5E,IAAI,UAAqC,CAAC;AAE1C,6EAA6E;AAC7E,MAAM,UAAU,aAAa;IAC3B,OAAO,aAAa,CAAC,IAAI,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,YAAY;IAC1B,IAAI,UAAU;QAAE,OAAO,UAAU,CAAC;IAClC,MAAM,SAAS,GAAG,YAAY,CAAC,aAAa,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;IAChE,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,aAAa;IAC3B,OAAO,YAAY,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,UAAU,EAAE,GAAG;IACf,UAAU,EAAE,GAAG;CACP,CAAC;AAEX;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAEnC;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAC"}