@toolproof-npm/schema 0.1.12

package/README.md

@@ -0,0 +1,58 @@
+# @toolproof-npm/schema
+
+JSON schemas and TypeScript types for ToolProof.
+
+## Installation
+
+```bash
+pnpm add @toolproof-npm/schema
+# or
+npm install @toolproof-npm/schema
+# or
+yarn add @toolproof-npm/schema
+```
+
+## Usage
+
+### Import Schemas and Types
+
+```typescript
+import { /* schemas and types */ } from '@toolproof-npm/schema';
+```
+
+## Features
+
+- JSON Schema definitions with $defs subschemas
+- Generated TypeScript types from JSON schemas
+- Runtime schema validation support
+- Extractors for non-JSON resource types
+- Schema bundling utilities
+
+## Development
+
+### Generate Types
+
+```bash
+pnpm run generateTypes
+```
+
+### Build
+
+```bash
+pnpm run build
+```
+
+### Update (Clean build + generate types)
+
+```bash
+pnpm run update
+```
+
+## Requirements
+
+- Node.js 16+
+- TypeScript 4.5+ (for TypeScript projects)
+
+## License
+
+MIT

package/dist/_lib/test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/_lib/test.js

@@ -0,0 +1,122 @@
+const Job = {
+    identity: 'identity',
+    name: 'name',
+    description: 'description',
+    uri: 'uri',
+    roles: {
+        inputMap: {
+            'ROLE-1234': {
+                typeId: 'TYPE-1234',
+                name: 'name',
+                description: 'description'
+            }
+        },
+        outputMap: {
+            'ROLE-5678': {
+                typeId: 'TYPE-5678',
+                name: 'name',
+                description: 'description'
+            }
+        }
+    }
+};
+const jobAlpha = {
+    identity: 'identity',
+    name: 'name',
+    description: 'description',
+    uri: 'uri',
+    roles: {
+        inputMap: {
+            'data-input': {
+                typeId: 'typeId',
+                name: 'name',
+                description: 'description'
+            }
+        },
+        outputMap: {
+            'data-output': {
+                typeId: 'typeId',
+                name: 'name',
+                description: 'description'
+            }
+        }
+    }
+};
+const jobBeta = {
+    identity: 'identity',
+    name: 'name',
+    description: 'description',
+    uri: 'uri',
+    roles: {
+        inputMap: {
+            'data-input': {
+                typeId: 'typeId',
+                name: 'name',
+                description: 'description'
+            }
+        },
+        /* outputMap: {
+            'data-output': {
+                typeId: 'typeId',
+                name: 'name',
+                description: 'description'
+            }
+        } */
+    }
+};
+// This checks (no error expected); we're providing all required fields
+const resourceDataJobAlpha = {
+    id: 'RESOURCE-1',
+    typeId: 'TYPE-ID',
+    creationContext: {
+        roleId: 'ROLE-ID',
+        executionId: 'EXECUTION-ID',
+    },
+    kind: 'realized',
+    timestamp: 'timestamp',
+    path: 'path',
+    extractedData: jobAlpha
+};
+// @ts-expect-error Missing path property
+// This SHOULD fail (missing path) once ResourceData_Job enforces Path strictly.
+const resourceDataJobAlpha2 = {
+    id: 'RESOURCE-3',
+    typeId: 'TYPE-ID',
+    creationContext: {
+        roleId: 'ROLE-ID',
+        executionId: 'EXECUTION-ID',
+    },
+    kind: 'realized',
+    timestamp: 'timestamp',
+    // path: 'path',
+    extractedData: jobAlpha
+};
+// @ts-expect-error Missing extractedData property
+// This should fail; we're missing extractedData
+const resourceDataJobAlpha3 = {
+    id: 'RESOURCE-2',
+    typeId: 'TYPE-ID',
+    creationContext: {
+        roleId: 'ROLE-ID',
+        executionId: 'EXECUTION-ID',
+    },
+    kind: 'realized',
+    timestamp: 'timestamp',
+    path: 'path',
+    // extractedData: jobAlpha
+};
+// This SHOULD fail (missing roles.outputMap) once Job's roles is strictly enforced.
+const resourceDataJobBeta = {
+    id: 'RESOURCE-4',
+    typeId: 'TYPE-ID',
+    creationContext: {
+        roleId: 'ROLE-ID',
+        executionId: 'EXECUTION-ID',
+    },
+    kind: 'realized',
+    timestamp: 'timestamp',
+    path: 'path',
+    // @ts-expect-error Missing outputMap inside roles (Job requires outputMap)
+    extractedData: jobBeta
+};
+export {};

package/dist/_lib/types/ResourceData_Job.d.ts

@@ -0,0 +1,97 @@
+// Auto-generated strict composite type. Do not edit.
+export type ResourceData_Job = ResourceDataMetaBase & {
+  extractedData: Job;
+};
+export type ResourceDataMetaBase = ResourceBase &
+  ResourceKind & {
+    kind: "realized";
+  } & Path &
+  Timestamp;
+export type ResourceBase = Identifiable & {
+  id: string;
+} & {
+  typeId: string;
+} & CreationContext;
+export type Job = Documented &
+  RolesOuter &
+  Uri & {
+    identity: string;
+  };
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "Documented".
+ */
+export type Documented = Name & Description;
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "RoleLiteral".
+ */
+export type RoleLiteral = {
+  /**
+   * This interface was referenced by `undefined`'s JSON-Schema
+   * via the `definition` "TypeId".
+   */
+  typeId: string;
+} & Documented;
+
+export interface Identifiable {
+}
+export interface CreationContext {
+  creationContext: ResourceSocket;
+}
+export interface ResourceSocket {
+  executionId: string;
+  roleId: string;
+}
+export interface ResourceKind {
+  kind: "potential-input" | "potential-output" | "realized";
+}
+export interface Path {
+  path: string;
+}
+export interface Timestamp {
+  timestamp: string;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "Name".
+ */
+export interface Name {
+  name: string;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "Description".
+ */
+export interface Description {
+  description: string;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "RolesOuter".
+ */
+export interface RolesOuter {
+  roles: RolesInner;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "RolesInner".
+ */
+export interface RolesInner {
+  inputMap: RoleMap;
+  outputMap: RoleMap;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "RoleMap".
+ */
+export interface RoleMap {
+  [k: string]: RoleLiteral;
+}
+/**
+ * This interface was referenced by `undefined`'s JSON-Schema
+ * via the `definition` "Uri".
+ */
+export interface Uri {
+  uri: string;
+}

package/dist/_lib/types/ResourceData_Job.js

@@ -0,0 +1 @@
+export {}