@knolo/cli 3.2.2 → 5.0.0

package/templates/icp-knowledge-canister/frontend/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+    "types": ["vite/client", "node"]
+  },
+  "include": ["src", "vite.config.ts"]
+}

package/templates/icp-knowledge-canister/frontend/vite.config.ts

@@ -0,0 +1,66 @@
+/// <reference types="vitest/config" />
+
+import fs from 'node:fs';
+import path from 'node:path';
+
+import react from '@vitejs/plugin-react';
+import { defineConfig, loadEnv } from 'vite';
+
+type CanisterIdsFile = {
+  knolo_knowledge?: Record<string, string | undefined>;
+};
+
+function readCanisterIds(exampleRoot: string): CanisterIdsFile | undefined {
+  const canisterIdsPath = path.join(exampleRoot, '.dfx', 'local', 'canister_ids.json');
+  if (!fs.existsSync(canisterIdsPath)) {
+    return undefined;
+  }
+
+  const raw = fs.readFileSync(canisterIdsPath, 'utf8');
+  return JSON.parse(raw) as CanisterIdsFile;
+}
+
+function trimValue(value: string | undefined): string | undefined {
+  const trimmed = value?.trim();
+  return trimmed ? trimmed : undefined;
+}
+
+function pickNetwork(env: Record<string, string>): string {
+  return trimValue(env.VITE_DFX_NETWORK) ?? trimValue(env.DFX_NETWORK) ?? 'local';
+}
+
+function pickCanisterId(
+  env: Record<string, string>,
+  canisterIds: CanisterIdsFile | undefined,
+  network: string
+): string | undefined {
+  return (
+    trimValue(env.VITE_KNOLO_CANISTER_ID) ??
+    trimValue(canisterIds?.knolo_knowledge?.[network]) ??
+    trimValue(canisterIds?.knolo_knowledge?.local)
+  );
+}
+
+export default defineConfig(({ mode }) => {
+  const env = loadEnv(mode, process.cwd(), '');
+  const exampleRoot = path.resolve(__dirname, '..');
+  const network = pickNetwork(env);
+  const canisterId = pickCanisterId(env, readCanisterIds(exampleRoot), network);
+
+  return {
+    plugins: [react()],
+    define: {
+      __KNOLO_CANISTER_ID__: canisterId ? JSON.stringify(canisterId) : 'undefined',
+      __KNOLO_DFX_NETWORK__: JSON.stringify(network),
+    },
+    server: {
+      fs: {
+        allow: [exampleRoot],
+      },
+    },
+    test: {
+      environment: 'node',
+      include: ['src/**/*.test.ts'],
+    },
+  };
+});

package/templates/icp-knowledge-canister/knolo.config.json

@@ -0,0 +1,15 @@
+{
+  "version": 1,
+  "sources": [
+    {
+      "name": "docs",
+      "path": "./knowledge"
+    }
+  ],
+  "output": {
+    "path": "./dist/knowledge.knolo"
+  },
+  "query": {
+    "topK": 5
+  }
+}

package/templates/icp-knowledge-canister/knowledge/alpha.md

@@ -0,0 +1,5 @@
+# Alpha Guide
+
+Alpha beta deployment notes for Knolo on the Internet Computer.
+
+This sample document explains that a developer can build a local knowledge pack, upload it to the canister with `set_pack`, and run deterministic lexical search without a middleware server.

package/templates/icp-knowledge-canister/knowledge/guides/beta.md

@@ -0,0 +1,5 @@
+# Beta Notes
+
+Beta guidance for local testing.
+
+Use the sample query `alpha beta` after uploading the pack. The canister should return this note and the alpha guide as direct lexical hits.

package/templates/icp-knowledge-canister/scripts/build-sample-pack.mjs

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+
+import { execFileSync } from 'node:child_process';
+import { existsSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const scriptDir = path.dirname(fileURLToPath(import.meta.url));
+const projectDir = path.resolve(scriptDir, '..');
+const knoloBin = process.env.KNOLO_BIN || 'knolo';
+const outPath = path.join(projectDir, 'dist/knowledge.knolo');
+
+console.log('[build-sample-pack] Building dist/knowledge.knolo');
+execFileSync(knoloBin, ['icp', 'build-pack', './knowledge', '--out', './dist/knowledge.knolo'], {
+  cwd: projectDir,
+  stdio: 'inherit',
+});
+
+if (!existsSync(outPath)) {
+  console.error(`Expected pack output at ${outPath}`);
+  process.exit(1);
+}
+
+console.log('[build-sample-pack] OK');

package/templates/icp-knowledge-canister/scripts/query.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+KNOLO_BIN="${KNOLO_BIN:-knolo}"
+CANISTER_NAME="${CANISTER_NAME:-knolo_knowledge}"
+QUERY_TEXT="${1:-alpha beta}"
+TOP_K="${TOP_K:-5}"
+
+cd "$ROOT"
+"$KNOLO_BIN" icp query "$QUERY_TEXT" --canister "$CANISTER_NAME" --k "$TOP_K"

package/templates/icp-knowledge-canister/scripts/upload-pack.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+KNOLO_BIN="${KNOLO_BIN:-knolo}"
+CANISTER_NAME="${CANISTER_NAME:-knolo_knowledge}"
+PACK_LABEL="${PACK_LABEL:-sample-knowledge-pack}"
+PACK_PATH="${PACK_PATH:-$ROOT/dist/knowledge.knolo}"
+
+if [ ! -f "$PACK_PATH" ]; then
+  echo "Pack file not found at $PACK_PATH. Run node scripts/build-sample-pack.mjs first." >&2
+  exit 1
+fi
+
+cd "$ROOT"
+"$KNOLO_BIN" icp upload "$PACK_PATH" --canister "$CANISTER_NAME" --label "$PACK_LABEL"