@jami-studio/registry-schema 0.1.0

package/LICENSE

@@ -0,0 +1,182 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty percent
+or more of the outstanding shares, or (iii) beneficial ownership of such
+entity.
+
+"You" or "Your" shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source, and
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work.
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on or derived from the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as a
+whole, an original work of authorship. For the purposes of this License,
+Derivative Works shall not include works that remain separable from, or
+merely link or bind by name to the interfaces of, the Work and Derivative
+Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the purposes
+of this definition, "submitted" means any form of electronic, verbal, or
+written communication sent to the Licensor or its representatives, including
+but not limited to communication on electronic mailing lists, source code
+control systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise designated
+in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable patent license to make,
+have made, use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable by such
+Contributor that are necessarily infringed by their Contribution alone or by
+combination of their Contribution with the Work to which such Contribution was
+submitted. If You institute patent litigation against any entity alleging that
+the Work or a Contribution incorporated within the Work constitutes direct or
+contributory patent infringement, then any patent licenses granted to You
+under this License for that Work shall terminate as of the date such
+litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy
+of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any
+part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of
+the following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a
+whole, provided Your use, reproduction, and distribution of the Work otherwise
+complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may have
+executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as
+required for reasonable and customary use in describing the origin of the Work
+and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied, including, without
+limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT,
+MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
+responsible for determining the appropriateness of using or redistributing the
+Work and assume any risks associated with Your exercise of permissions under
+this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort, contract, or otherwise, unless required by applicable law or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any
+character arising as a result of this License or out of the use or inability
+to use the Work, including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all other
+commercial damages or losses, even if such Contributor has been advised of the
+possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or
+Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree
+to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification
+within third-party archives.
+
+Copyright 2026 Jami.Studio
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@jami-studio/registry-schema",
+  "version": "0.1.0",
+  "description": "Single source of truth for the Studio UI registry contract: registry item, registryRef handshake, item graph, and workspace/theme reference schemas as JSON Schema 2020-12 with AJV-strict validation utilities and TypeScript types.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/studio-jami/studio-ui.git",
+    "directory": "packages/registry-schema"
+  },
+  "type": "module",
+  "main": "./src/index.mjs",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.mjs"
+    },
+    "./json-source": "./src/json-source.mjs",
+    "./schemas/*": "./src/schemas/*"
+  },
+  "files": [
+    "src",
+    "package.json"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "jamiRelease": {
+    "publishable": true
+  },
+  "dependencies": {
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1"
+  },
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "test": "node --test test/registry-schema.test.mjs"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,296 @@
+// Type definitions for @jami-studio/registry-schema.
+
+export interface RegistryRef {
+  registryId: string;
+  namespace: string;
+  name: string;
+  version: string;
+}
+
+export type AgentManifestComponentName =
+  | "accordion"
+  | "agent-panel"
+  | "button"
+  | "calendar"
+  | "chart"
+  | "data-list"
+  | "date-control"
+  | "dialog"
+  | "docs-source-panel"
+  | "dropdown-menu"
+  | "media-grid"
+  | "panel"
+  | "popover"
+  | "select"
+  | "tabs"
+  | "text-field"
+  | "tooltip";
+
+export interface AgentManifest {
+  $schema: "https://jami.studio/schemas/registry/agent-manifest.schema.json";
+  schemaVersion: "2026-06-23.agent-manifest";
+  manifestId: string;
+  component: {
+    namespace: "@jami-studio/ui";
+    name: AgentManifestComponentName;
+    version: string;
+  };
+  propContract: {
+    schemaVersion: string;
+    additionalProperties: false;
+    required: string[];
+    properties: Record<string, Record<string, unknown>>;
+  };
+  actionSlots: AgentManifestActionSlot[];
+  runtimeBinding: {
+    renderer: "resident-renderer";
+    bindingMode: "resident-component";
+    payloadSchemaVersion: "2026-06-09";
+    vocabularyHandshakeVersion: "2026-06-09.vocabulary-handshake";
+    execution: "display-only-data-never-code";
+  };
+  residentRenderer: {
+    allowlistMode: "default-allowlist";
+    allowedComponents: AgentManifestComponentName[];
+    unknownComponentState: "unsupported";
+    unsafePayloadState: "invalid";
+  };
+}
+
+export interface AgentManifestActionSlot {
+  slotId: string;
+  name: string;
+  label: string;
+  harnessRoute: string;
+  risk: "read" | "write" | "destructive" | "external" | "secret_adjacent";
+  policyScope: string;
+  confirmationMode: "none" | "confirm" | "approval_required" | "owner_required";
+  inputSchema: Record<string, unknown>;
+  outputSchema: Record<string, unknown>;
+  safetyConstraints: Array<
+    | "policy-required"
+    | "audit-required"
+    | "evidence-required"
+    | "no-inline-secret-values"
+    | "no-model-provided-code"
+    | "schema-validated-input"
+    | "schema-validated-output"
+  >;
+}
+
+export interface RegistryItemLifecycle {
+  id: string;
+  version: string;
+  schemaVersion: string;
+  sourceHash: string;
+  migrationNotes: string;
+  [key: string]: unknown;
+}
+
+export interface RegistryItemProvenance {
+  source: string;
+  license: string;
+  reviewedAt: string;
+  copiedSource: boolean;
+  [key: string]: unknown;
+}
+
+export interface RegistryItemCompatibility {
+  shadcn: string;
+  tailwind: string;
+  react: string;
+  [key: string]: unknown;
+}
+
+export interface RegistryItemFile {
+  path: string;
+  target: string;
+  kind: string;
+  [key: string]: unknown;
+}
+
+export type RegistryItemType =
+  | "primitive"
+  | "component"
+  | "block"
+  | "page"
+  | "theme"
+  | "font"
+  | "app"
+  | "workspace";
+
+export interface RegistryItem {
+  $schema: "https://jami.studio/schemas/registry/registry-item.schema.json";
+  name: string;
+  type: RegistryItemType;
+  title: string;
+  description?: string;
+  workspace?: "solo" | "business-ops" | "mixed-media" | "research-writing";
+  registryRef?: RegistryRef;
+  agentManifest?: AgentManifest;
+  lifecycle: RegistryItemLifecycle;
+  provenance: RegistryItemProvenance;
+  compatibility: RegistryItemCompatibility;
+  tokenRequirements: string[];
+  dependencies: string[];
+  registryDependencies?: string[];
+  files: RegistryItemFile[];
+  [key: string]: unknown;
+}
+
+export type ItemGraphNodeType =
+  | "registry:ui"
+  | "registry:component"
+  | "registry:block"
+  | "registry:page"
+  | "registry:theme"
+  | "registry:font"
+  | "registry:app"
+  | "registry:workspace"
+  | "registry:item";
+
+export interface ItemGraphNode {
+  name: string;
+  type: ItemGraphNodeType;
+  level: number;
+  registryDependencies: string[];
+}
+
+export interface ItemGraphEdge {
+  from: string;
+  to: string;
+}
+
+export interface ItemGraph {
+  root: string;
+  nodes: ItemGraphNode[];
+  edges: ItemGraphEdge[];
+}
+
+export interface WorkspaceRef {
+  workspaceId: string;
+  audience?: "workspace" | "docs" | "operations" | "governance" | "custom";
+  registryRef: RegistryRef;
+  installedItems: RegistryRef[];
+  registryState?: "current" | "missing_dependency" | "unsupported_workspace_version" | "stale_registry_item";
+}
+
+export interface ThemeRef {
+  themeId: string;
+  tokenSchemaVersion?: string;
+  registryRef: RegistryRef;
+  kind: "factory" | "custom" | "default";
+  state?:
+    | "current"
+    | "deprecated"
+    | "missing_token"
+    | "invalid_alias"
+    | "contrast_failure"
+    | "migration_needed"
+    | "unsupported_family";
+}
+
+export interface WorkbenchStateDraft {
+  target: string;
+  themeName: string;
+  presetName: string;
+  controls: {
+    accent: string;
+    focusRing: string;
+    radius: string;
+    spacing: string;
+    density: string;
+    motion: string;
+    dockWidth: string;
+    fontSize: string;
+    [control: string]: string;
+  };
+}
+
+export interface WorkbenchState {
+  schemaVersion: "2026-06-23.workbench-state";
+  revision?: string | null;
+  saved: WorkbenchStateDraft;
+}
+
+export type ContractName =
+  | "registryRef"
+  | "agentManifest"
+  | "registryItem"
+  | "itemGraph"
+  | "workspaceRef"
+  | "themeRef"
+  | "workbenchState";
+
+export interface ValidationResult {
+  ok: boolean;
+  errors: unknown[];
+  messages: string[];
+}
+
+export interface ValidateFunction {
+  (data: unknown): boolean;
+  errors?: unknown[] | null;
+}
+
+export declare const registryRefSchema: Record<string, unknown>;
+export declare const agentManifestSchema: Record<string, unknown>;
+export declare const registryItemSchema: Record<string, unknown>;
+export declare const itemGraphSchema: Record<string, unknown>;
+export declare const workspaceRefSchema: Record<string, unknown>;
+export declare const themeRefSchema: Record<string, unknown>;
+export declare const workbenchStateSchema: Record<string, unknown>;
+export declare const schemas: Record<ContractName, Record<string, unknown>>;
+export declare const contractNames: ContractName[];
+export declare const agentManifestAllowedComponents: readonly AgentManifestComponentName[];
+
+export declare function createAjv(options?: Record<string, unknown>): unknown;
+export declare function getValidator(name: ContractName): ValidateFunction;
+export declare function validate(name: ContractName, data: unknown): ValidationResult;
+export declare function assertValid<T = unknown>(name: ContractName, data: T, label?: string): T;
+export declare function formatErrors(errors: unknown[]): string[];
+export interface DuplicateJsonObjectKey {
+  key: string;
+  first: { line: number; column: number };
+  duplicate: { line: number; column: number };
+}
+export declare function findDuplicateJsonObjectKeys(source: string): DuplicateJsonObjectKey[];
+export declare function formatDuplicateJsonObjectKeys(duplicates: DuplicateJsonObjectKey[]): string[];
+
+export declare const validateRegistryRef: ValidateFunction;
+export declare const validateAgentManifest: ValidateFunction;
+export declare const validateRegistryItem: ValidateFunction;
+export declare const validateItemGraph: ValidateFunction;
+export declare const validateWorkspaceRef: ValidateFunction;
+export declare const validateThemeRef: ValidateFunction;
+export declare const validateWorkbenchState: ValidateFunction;
+
+export type ShadcnRegistryItemType =
+  | "registry:lib"
+  | "registry:block"
+  | "registry:component"
+  | "registry:ui"
+  | "registry:hook"
+  | "registry:theme"
+  | "registry:page"
+  | "registry:file"
+  | "registry:style"
+  | "registry:base"
+  | "registry:font"
+  | "registry:item";
+
+export interface ShadcnRegistryItem {
+  name: string;
+  type: ShadcnRegistryItemType;
+  files?: Array<{ path: string; type: string; target?: string; content?: string }>;
+  [key: string]: unknown;
+}
+
+export declare const shadcnRegistryItemSchema: Record<string, unknown>;
+export declare const shadcnItemTypes: ReadonlySet<string>;
+export declare const shadcnFileTypes: ReadonlySet<string>;
+export declare const validateShadcnRegistryItem: ValidateFunction;
+export declare function validateShadcn(item: unknown): ValidationResult;
+export declare function toShadcnItemType(type: string): string;
+export declare function toShadcnFileType(type: string): string;
+export declare function toShadcnRegistryItem<T extends { type: string; files?: unknown[] }>(item: T): T;