@shrkcrft/framework-scanners 0.1.0-alpha.10

package/dist/schema/framework-schema.d.ts

@@ -0,0 +1,36 @@
+import type { IEdge, INode } from '@shrkcrft/graph';
+export declare const FRAMEWORK_SCHEMA: "sharkcraft.framework/v1";
+export type FrameworkSchemaVersion = typeof FRAMEWORK_SCHEMA;
+/**
+ * Known framework tags. Open string union so packs can later contribute
+ * additional extractors without touching this enum.
+ */
+export type FrameworkName = 'nestjs' | 'react' | 'express' | 'angular' | 'vue' | 'svelte' | string;
+/**
+ * NestJS subtypes the built-in extractor emits today.
+ */
+export type NestSubtype = 'controller' | 'module' | 'provider' | 'route';
+/**
+ * React subtypes the built-in extractor emits today.
+ */
+export type ReactSubtype = 'component' | 'hook-usage';
+export interface IFrameworkManifest {
+    schema: FrameworkSchemaVersion;
+    projectRoot: string;
+    lastBuiltAt: string;
+    lastBuildDurationMs: number;
+    /** SHA-256 of the framework store's JSONL files. */
+    digest: string;
+    /** Per-framework entity counts. */
+    countsByFramework: Readonly<Record<string, number>>;
+    /** Per-(framework + subtype) counts. */
+    countsBySubtype: Readonly<Record<string, number>>;
+    /** Frameworks active in this snapshot. */
+    frameworks: readonly string[];
+}
+export interface IFrameworkSnapshot {
+    manifest: IFrameworkManifest;
+    nodes: ReadonlyMap<string, INode>;
+    edges: ReadonlyMap<string, IEdge>;
+}
+//# sourceMappingURL=framework-schema.d.ts.map

package/dist/schema/framework-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"framework-schema.d.ts","sourceRoot":"","sources":["../../src/schema/framework-schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAEpD,eAAO,MAAM,gBAAgB,EAAG,yBAAkC,CAAC;AAEnE,MAAM,MAAM,sBAAsB,GAAG,OAAO,gBAAgB,CAAC;AAE7D;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEnG;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,QAAQ,GAAG,UAAU,GAAG,OAAO,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,YAAY,CAAC;AAEtD,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,sBAAsB,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,iBAAiB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,wCAAwC;IACxC,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAClD,0CAA0C;IAC1C,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAClC,KAAK,EAAE,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CACnC"}

package/dist/schema/framework-schema.js

@@ -0,0 +1 @@
+export const FRAMEWORK_SCHEMA = 'sharkcraft.framework/v1';

package/dist/store/framework-store.d.ts

@@ -0,0 +1,17 @@
+import type { IEdge, INode } from '@shrkcrft/graph';
+import { type IFrameworkManifest, type IFrameworkSnapshot } from '../schema/framework-schema.js';
+/**
+ * On-disk JSONL store for `@shrkcrft/framework-scanners`. Lives at
+ * `<root>/.sharkcraft/framework/` alongside the code-graph and bridge
+ * stores; merged in memory at query time.
+ */
+export declare class FrameworkStore {
+    private readonly projectRoot;
+    readonly storeDir: string;
+    constructor(projectRoot: string);
+    exists(): boolean;
+    clear(): void;
+    writeSnapshot(nodes: readonly INode[], edges: readonly IEdge[], partial: Omit<IFrameworkManifest, 'schema' | 'digest'>): IFrameworkManifest;
+    loadSnapshot(): IFrameworkSnapshot;
+}
+//# sourceMappingURL=framework-store.d.ts.map

package/dist/store/framework-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"framework-store.d.ts","sourceRoot":"","sources":["../../src/store/framework-store.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAEL,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACxB,MAAM,+BAA+B,CAAC;AAMvC;;;;GAIG;AACH,qBAAa,cAAc;IAGb,OAAO,CAAC,QAAQ,CAAC,WAAW;IAFxC,SAAgB,QAAQ,EAAE,MAAM,CAAC;gBAEJ,WAAW,EAAE,MAAM;IAIhD,MAAM,IAAI,OAAO;IAIjB,KAAK,IAAI,IAAI;IAMb,aAAa,CACX,KAAK,EAAE,SAAS,KAAK,EAAE,EACvB,KAAK,EAAE,SAAS,KAAK,EAAE,EACvB,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,GAAG,QAAQ,CAAC,GACrD,kBAAkB;IA8BrB,YAAY,IAAI,kBAAkB;CAoCnC"}

package/dist/store/framework-store.js

@@ -0,0 +1,138 @@
+import { createHash } from 'node:crypto';
+import { existsSync, mkdirSync, readFileSync, readdirSync, rmSync, writeFileSync, } from 'node:fs';
+import * as nodePath from 'node:path';
+import { FRAMEWORK_SCHEMA, } from "../schema/framework-schema.js";
+const NODES_DIR = 'nodes';
+const EDGES_DIR = 'edges';
+const META_FILE = 'meta.json';
+/**
+ * On-disk JSONL store for `@shrkcrft/framework-scanners`. Lives at
+ * `<root>/.sharkcraft/framework/` alongside the code-graph and bridge
+ * stores; merged in memory at query time.
+ */
+export class FrameworkStore {
+    projectRoot;
+    storeDir;
+    constructor(projectRoot) {
+        this.projectRoot = projectRoot;
+        this.storeDir = nodePath.join(projectRoot, '.sharkcraft', 'framework');
+    }
+    exists() {
+        return existsSync(nodePath.join(this.storeDir, META_FILE));
+    }
+    clear() {
+        if (existsSync(this.storeDir)) {
+            rmSync(this.storeDir, { recursive: true, force: true });
+        }
+    }
+    writeSnapshot(nodes, edges, partial) {
+        const nodesDir = nodePath.join(this.storeDir, NODES_DIR);
+        const edgesDir = nodePath.join(this.storeDir, EDGES_DIR);
+        if (existsSync(nodesDir))
+            rmSync(nodesDir, { recursive: true, force: true });
+        if (existsSync(edgesDir))
+            rmSync(edgesDir, { recursive: true, force: true });
+        mkdirSync(nodesDir, { recursive: true });
+        mkdirSync(edgesDir, { recursive: true });
+        // Bucket by framework name (one file per framework).
+        const nodesByFramework = bucket(nodes, (n) => String(n.data?.['framework'] ?? 'unknown'));
+        const edgesByKind = bucket(edges, (e) => e.kind);
+        for (const [framework, list] of Object.entries(nodesByFramework)) {
+            list.sort((a, b) => a.id.localeCompare(b.id));
+            writeJsonl(nodePath.join(nodesDir, `${framework}.jsonl`), list);
+        }
+        for (const [kind, list] of Object.entries(edgesByKind)) {
+            list.sort((a, b) => a.id.localeCompare(b.id));
+            writeJsonl(nodePath.join(edgesDir, `${kind}.jsonl`), list);
+        }
+        const digest = computeDigest(this.storeDir);
+        const manifest = {
+            schema: FRAMEWORK_SCHEMA,
+            digest,
+            ...partial,
+        };
+        writeFileSync(nodePath.join(this.storeDir, META_FILE), JSON.stringify(manifest, null, 2));
+        return manifest;
+    }
+    loadSnapshot() {
+        if (!this.exists()) {
+            throw new Error(`framework store not found under ${this.storeDir}. Run 'shrk framework index'.`);
+        }
+        const manifest = JSON.parse(readFileSync(nodePath.join(this.storeDir, META_FILE), 'utf8'));
+        if (manifest.schema !== FRAMEWORK_SCHEMA) {
+            throw new Error(`framework schema mismatch: store=${manifest.schema}, expected=${FRAMEWORK_SCHEMA}.`);
+        }
+        const nodes = new Map();
+        const nodesDir = nodePath.join(this.storeDir, NODES_DIR);
+        if (existsSync(nodesDir)) {
+            for (const fname of readdirSync(nodesDir)) {
+                if (!fname.endsWith('.jsonl'))
+                    continue;
+                for (const row of readJsonl(nodePath.join(nodesDir, fname))) {
+                    nodes.set(row.id, row);
+                }
+            }
+        }
+        const edges = new Map();
+        const edgesDir = nodePath.join(this.storeDir, EDGES_DIR);
+        if (existsSync(edgesDir)) {
+            for (const fname of readdirSync(edgesDir)) {
+                if (!fname.endsWith('.jsonl'))
+                    continue;
+                for (const row of readJsonl(nodePath.join(edgesDir, fname))) {
+                    edges.set(row.id, row);
+                }
+            }
+        }
+        return { manifest, nodes, edges };
+    }
+}
+function bucket(list, key) {
+    const out = {};
+    for (const item of list) {
+        const k = key(item);
+        if (!out[k])
+            out[k] = [];
+        out[k].push(item);
+    }
+    return out;
+}
+function writeJsonl(path, rows) {
+    const body = rows.map((r) => JSON.stringify(r)).join('\n');
+    writeFileSync(path, body.length > 0 ? body + '\n' : '');
+}
+function readJsonl(path) {
+    const raw = readFileSync(path, 'utf8');
+    if (!raw)
+        return [];
+    const out = [];
+    for (const line of raw.split('\n')) {
+        const t = line.trim();
+        if (!t)
+            continue;
+        out.push(JSON.parse(t));
+    }
+    return out;
+}
+function computeDigest(storeDir) {
+    const hash = createHash('sha256');
+    const targets = [];
+    for (const sub of [NODES_DIR, EDGES_DIR]) {
+        const dir = nodePath.join(storeDir, sub);
+        if (!existsSync(dir))
+            continue;
+        for (const fname of readdirSync(dir).sort()) {
+            if (!fname.endsWith('.jsonl'))
+                continue;
+            targets.push(nodePath.join(dir, fname));
+        }
+    }
+    targets.sort();
+    for (const t of targets) {
+        hash.update(nodePath.relative(storeDir, t));
+        hash.update('\0');
+        hash.update(readFileSync(t));
+        hash.update('\0');
+    }
+    return hash.digest('hex');
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@shrkcrft/framework-scanners",
+  "version": "0.1.0-alpha.10",
+  "description": "SharkCraft framework-aware extractors. Plugin-shaped enrichment for the code graph: NestJS controllers/modules/providers, React components/hooks, future Angular/Express/Next.",
+  "license": "MIT",
+  "author": "SharkCraft contributors",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sharkcraft/sharkcraft.git",
+    "directory": "packages/framework-scanners"
+  },
+  "homepage": "https://github.com/sharkcraft/sharkcraft",
+  "bugs": {
+    "url": "https://github.com/sharkcraft/sharkcraft/issues"
+  },
+  "keywords": [
+    "sharkcraft",
+    "framework-scanners",
+    "nestjs",
+    "react",
+    "express",
+    "code-intelligence"
+  ],
+  "engines": {
+    "bun": ">=1.1.0",
+    "node": ">=18"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  },
+  "dependencies": {
+    "@shrkcrft/core": "^0.1.0-alpha.10",
+    "@shrkcrft/graph": "^0.1.0-alpha.10",
+    "@shrkcrft/packs": "^0.1.0-alpha.10",
+    "typescript": "^5.5.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}