@clegra/sdk 0.0.0-stage → 0.1.0-next.1

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.
Files changed (81) hide show
  1. package/CHANGELOG.md +158 -0
  2. package/LICENSE +21 -0
  3. package/NOTICE.md +25 -0
  4. package/README.md +258 -2
  5. package/dist/spec/kinds.json +211 -0
  6. package/dist/spec/schema/clegra.schema.json +1249 -0
  7. package/dist/spec/src/cli.d.ts +2 -0
  8. package/dist/spec/src/cli.js +21 -0
  9. package/dist/spec/src/cli.js.map +1 -0
  10. package/dist/spec/src/conformance.d.ts +34 -0
  11. package/dist/spec/src/conformance.js +704 -0
  12. package/dist/spec/src/conformance.js.map +1 -0
  13. package/dist/spec/src/init/index.d.ts +31 -0
  14. package/dist/spec/src/init/index.js +151 -0
  15. package/dist/spec/src/init/index.js.map +1 -0
  16. package/dist/spec/src/init/next-config.d.ts +19 -0
  17. package/dist/spec/src/init/next-config.js +77 -0
  18. package/dist/spec/src/init/next-config.js.map +1 -0
  19. package/dist/spec/src/init/project.d.ts +44 -0
  20. package/dist/spec/src/init/project.js +141 -0
  21. package/dist/spec/src/init/project.js.map +1 -0
  22. package/dist/spec/src/init/templates.d.ts +20 -0
  23. package/dist/spec/src/init/templates.js +166 -0
  24. package/dist/spec/src/init/templates.js.map +1 -0
  25. package/dist/spec/src/init/ui.d.ts +30 -0
  26. package/dist/spec/src/init/ui.js +82 -0
  27. package/dist/spec/src/init/ui.js.map +1 -0
  28. package/dist/spec/src/kinds.d.ts +89 -0
  29. package/dist/spec/src/kinds.js +319 -0
  30. package/dist/spec/src/kinds.js.map +1 -0
  31. package/dist/spec/src/protocol.d.ts +50 -0
  32. package/dist/spec/src/protocol.js +52 -0
  33. package/dist/spec/src/protocol.js.map +1 -0
  34. package/dist/spec/src/rules.d.ts +132 -0
  35. package/dist/spec/src/rules.js +282 -0
  36. package/dist/spec/src/rules.js.map +1 -0
  37. package/dist/src/auth.d.ts +371 -0
  38. package/dist/src/auth.js +964 -0
  39. package/dist/src/auth.js.map +1 -0
  40. package/dist/src/define.d.ts +249 -0
  41. package/dist/src/define.js +83 -0
  42. package/dist/src/define.js.map +1 -0
  43. package/dist/src/embed.d.ts +98 -0
  44. package/dist/src/embed.js +256 -0
  45. package/dist/src/embed.js.map +1 -0
  46. package/dist/src/index.d.ts +11 -0
  47. package/dist/src/index.js +11 -0
  48. package/dist/src/index.js.map +1 -0
  49. package/dist/src/labels.d.ts +10 -0
  50. package/dist/src/labels.js +22 -0
  51. package/dist/src/labels.js.map +1 -0
  52. package/dist/src/manifest.d.ts +499 -0
  53. package/dist/src/manifest.js +188 -0
  54. package/dist/src/manifest.js.map +1 -0
  55. package/dist/src/meaning.d.ts +64 -0
  56. package/dist/src/meaning.js +116 -0
  57. package/dist/src/meaning.js.map +1 -0
  58. package/dist/src/next/index.d.ts +101 -0
  59. package/dist/src/next/index.js +187 -0
  60. package/dist/src/next/index.js.map +1 -0
  61. package/dist/src/node.d.ts +14 -0
  62. package/dist/src/node.js +64 -0
  63. package/dist/src/node.js.map +1 -0
  64. package/dist/src/server.d.ts +229 -0
  65. package/dist/src/server.js +2256 -0
  66. package/dist/src/server.js.map +1 -0
  67. package/dist/src/store.d.ts +129 -0
  68. package/dist/src/store.js +213 -0
  69. package/dist/src/store.js.map +1 -0
  70. package/dist/src/testing.d.ts +133 -0
  71. package/dist/src/testing.js +81 -0
  72. package/dist/src/testing.js.map +1 -0
  73. package/dist/src/types.d.ts +352 -0
  74. package/dist/src/types.js +2 -0
  75. package/dist/src/types.js.map +1 -0
  76. package/dist/src/view.d.ts +35 -0
  77. package/dist/src/view.js +442 -0
  78. package/dist/src/view.js.map +1 -0
  79. package/docs/quickstart.md +350 -0
  80. package/docs/spec.md +997 -0
  81. package/package.json +89 -4
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env -S npx tsx
2
+ export {};
@@ -0,0 +1,21 @@
1
+ #!/usr/bin/env node
2
+ import { checkApp, formatReport } from "./conformance.js";
3
+ import { initMain } from "./init/index.js";
4
+ // clegra check <url> [--token <bearer>] (or CLEGRA_TOKEN in the environment)
5
+ // clegra init [dir] [--ui] [--dry-run] (@clegra/sdk added to an existing Next.js App Router app; --ui: @clegra/ui too)
6
+ const USAGE = "usage: clegra check <url> [--token <bearer>]\n clegra init [dir] [--ui] [--dry-run]";
7
+ const [command, ...args] = process.argv.slice(2);
8
+ if (command === "init")
9
+ process.exit(initMain(args));
10
+ const url = args.find((a, i) => !a.startsWith("--") && args[i - 1] !== "--token");
11
+ const at = args.indexOf("--token");
12
+ const token = at >= 0 ? args[at + 1] : process.env.CLEGRA_TOKEN;
13
+ if (command !== "check" || !url) {
14
+ console.error(USAGE);
15
+ process.exit(2);
16
+ }
17
+ const report = await checkApp({ url, ...(token ? { token } : {}) });
18
+ console.log(formatReport(report));
19
+ // 0: conformant; 1: a check failed; 3: nothing failed but the MCP checks did not run (no token).
20
+ process.exit(!report.ok ? 1 : report.complete ? 0 : 3);
21
+ //# sourceMappingURL=cli.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../spec/src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AAEvC,+EAA+E;AAC/E,0HAA0H;AAC1H,MAAM,KAAK,GAAG,2FAA2F,CAAA;AACzG,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AAEhD,IAAI,OAAO,KAAK,MAAM;IAAE,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAA;AAEpD,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,SAAS,CAAC,CAAA;AACjF,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;AAClC,MAAM,KAAK,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAA;AAC/D,IAAI,OAAO,KAAK,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC;IAChC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACpB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC;AACD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAA;AACnE,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAA;AACjC,iGAAiG;AACjG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA","sourcesContent":["#!/usr/bin/env -S npx tsx\nimport { checkApp, formatReport } from \"./conformance\"\nimport { initMain } from \"./init/index\"\n\n// clegra check <url> [--token <bearer>] (or CLEGRA_TOKEN in the environment)\n// clegra init [dir] [--ui] [--dry-run] (@clegra/sdk added to an existing Next.js App Router app; --ui: @clegra/ui too)\nconst USAGE = \"usage: clegra check <url> [--token <bearer>]\\n clegra init [dir] [--ui] [--dry-run]\"\nconst [command, ...args] = process.argv.slice(2)\n\nif (command === \"init\") process.exit(initMain(args))\n\nconst url = args.find((a, i) => !a.startsWith(\"--\") && args[i - 1] !== \"--token\")\nconst at = args.indexOf(\"--token\")\nconst token = at >= 0 ? args[at + 1] : process.env.CLEGRA_TOKEN\nif (command !== \"check\" || !url) {\n console.error(USAGE)\n process.exit(2)\n}\nconst report = await checkApp({ url, ...(token ? { token } : {}) })\nconsole.log(formatReport(report))\n// 0: conformant; 1: a check failed; 3: nothing failed but the MCP checks did not run (no token).\nprocess.exit(!report.ok ? 1 : report.complete ? 0 : 3)\n"]}
@@ -0,0 +1,34 @@
1
+ import { MANIFEST_PATH } from "./protocol.js";
2
+ /**
3
+ * CONFORMANCE (spec §8): what any app must do, checked from outside over
4
+ * HTTP. It knows nothing of the SDK: it reads the manifest, validates it
5
+ * against the published JSON Schema, and talks plain MCP to the endpoint.
6
+ *
7
+ * const report = await checkApp({ url: "http://127.0.0.1:3920", token })
8
+ */
9
+ export { MANIFEST_PATH };
10
+ export declare const MCP_APP_MIME_TYPE = "text/html;profile=mcp-app";
11
+ export declare const manifestSchema: Record<string, unknown>;
12
+ export type Check = {
13
+ id: string;
14
+ title: string;
15
+ ok: boolean;
16
+ detail?: string;
17
+ skipped?: boolean;
18
+ };
19
+ /** `ok`: no check failed. `complete`: every check ran (false when the MCP checks were skipped for lack of a token). Conformant = both. */
20
+ export type Report = {
21
+ ok: boolean;
22
+ complete: boolean;
23
+ checks: Check[];
24
+ };
25
+ export type Options = {
26
+ /** The app's origin, e.g. `https://crm.example.com`. */
27
+ url: string;
28
+ /** A bearer token of a plain MCP caller (not a workspace host). Without it only the public checks run. */
29
+ token?: string;
30
+ /** `fetch` to use (tests pass the app's own handler). */
31
+ fetch?: (request: Request) => Promise<Response>;
32
+ };
33
+ export declare function checkApp(options: Options): Promise<Report>;
34
+ export declare function formatReport(report: Report): string;