@apicurio/artifact-type-builtins 3.1.0

package/README.md

@@ -0,0 +1,54 @@
+# @apicurio/artifact-type-builtins
+
+Built-in functions and TypeScript type definitions for creating custom artifact types in Apicurio
+Registry.
+
+## Overview
+
+This package provides the TypeScript type definitions and built-in utility functions needed to develop
+custom artifact types for [Apicurio Registry](https://www.apicur.io/registry/). It enables type safety
+and IDE autocomplete support when implementing custom artifact type handlers in JavaScript/TypeScript.
+
+## Installation
+
+```bash
+npm install @apicurio/artifact-type-builtins
+```
+
+## Usage
+
+Import the types and built-in functions in your custom artifact type implementation:
+
+```typescript
+import {
+    ArtifactTypeScriptProvider,
+    info,
+    debug
+} from '@apicurio/artifact-type-builtins';
+
+export function acceptsContent(request: any): boolean {
+    info('Checking if content is accepted');
+    // Your implementation here
+    return true;
+}
+
+export function validate(request: any): any {
+    debug('Validating artifact content');
+    // Your implementation here
+    return {
+        ruleViolations: []
+    };
+}
+
+// Implement other required functions...
+```
+
+## Example
+
+For a complete example of creating a custom artifact type, see the
+[TOML Artifact Type Example](https://github.com/Apicurio/apicurio-registry/tree/main/examples/custom-artifact-type)
+in the Apicurio Registry repository.
+
+## License
+
+Apache License 2.0

package/lib/ArtifactTypeScriptProvider_Builtins.d.ts

@@ -0,0 +1,85 @@
+// Generated by quarkus-quickjs4j
+// TypeScript definitions for ArtifactTypeScriptProvider
+
+// =============================================================================
+// Context Builtins - Java methods callable from JavaScript
+// =============================================================================
+
+export function info(message: string): void;
+export function debug(message: string): void;
+
+// =============================================================================
+// Script Interface - Functions that must be implemented and exported
+// =============================================================================
+
+export interface ArtifactTypeScriptProvider {
+    acceptsContent(request: ContentAccepterRequest): boolean;
+    testCompatibility(request: CompatibilityCheckerRequest): CompatibilityCheckerResponse;
+    canonicalize(request: ContentCanonicalizerRequest): ContentCanonicalizerResponse;
+    dereference(request: ContentDereferencerRequest): ContentDereferencerResponse;
+    rewriteReferences(request: ContentDereferencerRequest): ContentDereferencerResponse;
+    validate(request: ContentValidatorRequest): ContentValidatorResponse;
+    validateReferences(request: ContentValidatorRequest): ContentValidatorResponse;
+    findExternalReferences(request: ReferenceFinderRequest): ReferenceFinderResponse;
+}
+
+// =============================================================================
+// Type Definitions - TypeScript interfaces for Java beans
+// =============================================================================
+
+export interface CompatibilityCheckerResponse {
+    incompatibleDifferences: any[];
+}
+
+export interface ContentCanonicalizerResponse {
+    typedContent: any;
+}
+
+export interface ContentCanonicalizerRequest {
+    content: any;
+    resolvedReferences: any[];
+}
+
+export interface ContentDereferencerResponse {
+    typedContent: any;
+}
+
+export interface ContentValidatorResponse {
+    ruleViolations: any[];
+}
+
+export interface ReferenceFinderRequest {
+    typedContent: any;
+}
+
+export interface ContentValidatorRequest {
+    level: string;
+    function: any;
+    content: any;
+    resolvedReferences: any[];
+    references: any[];
+}
+
+export interface ReferenceFinderResponse {
+    externalReferences: any[];
+}
+
+export interface ContentDereferencerRequest {
+    content: any;
+    resolvedReferences: any[];
+    function: any;
+    resolvedReferenceUrls: any[];
+}
+
+export interface CompatibilityCheckerRequest {
+    level: string;
+    existingArtifacts: any[];
+    proposedArtifact: any;
+    resolvedReferences: any[];
+}
+
+export interface ContentAccepterRequest {
+    typedContent: any;
+    resolvedReferences: any[];
+}
+

package/lib/ArtifactTypeScriptProvider_Builtins.mjs

@@ -0,0 +1,8 @@
+// File generated by QuickJs4j
+
+export function info(args0) {
+  ArtifactTypeScriptProvider_Builtins.info(args0);
+}
+export function debug(args0) {
+  ArtifactTypeScriptProvider_Builtins.debug(args0);
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+    "name": "@apicurio/artifact-type-builtins",
+    "private": false,
+    "version": "3.1.0",
+    "type": "module",
+    "description": "Built-in functions and TypeScript type definitions for creating custom artifact types in Apicurio Registry",
+    "main": "lib/ArtifactTypeScriptProvider_Builtins.mjs",
+    "types": "lib/ArtifactTypeScriptProvider_Builtins.d.ts",
+    "files": [
+        "lib"
+    ],
+    "scripts": {
+        "clean": "rimraf lib",
+        "copy-generated": "mkdir -p lib && cp ../app/target/classes/META-INF/quickjs4j/ArtifactTypeScriptProvider_Builtins.d.ts lib/ && cp ../app/target/classes/META-INF/quickjs4j/ArtifactTypeScriptProvider_Builtins.mjs lib/",
+        "build": "npm run clean && npm run copy-generated",
+        "prepublishOnly": "test -f lib/ArtifactTypeScriptProvider_Builtins.d.ts && test -f lib/ArtifactTypeScriptProvider_Builtins.mjs || (echo 'Error: Generated files not found. Run npm run build first.' && exit 1)"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Apicurio/apicurio-registry.git",
+        "directory": "artifact-type-builtins"
+    },
+    "keywords": [
+        "apicurio",
+        "registry",
+        "artifact-type",
+        "custom-artifact-type",
+        "typescript",
+        "quickjs"
+    ],
+    "author": "Apicurio",
+    "license": "Apache-2.0",
+    "devDependencies": {
+        "rimraf": "6.0.1"
+    }
+}