@tinycloud/sdk-core 1.0.0

package/dist/json-schema.js

@@ -0,0 +1,703 @@
+/**
+ * JSON Schema export for TinyCloud SDK schemas.
+ *
+ * This module provides functions to generate JSON Schema from Zod schemas,
+ * enabling documentation, external tool integration, and schema sharing.
+ *
+ * @packageDocumentation
+ */
+import { zodToJsonSchema } from "zod-to-json-schema";
+// =============================================================================
+// Storage Schemas
+// =============================================================================
+import { EnsDataSchema, PersistedTinyCloudSessionSchema, PersistedSessionDataSchema, TinyCloudSessionSchema, } from "./storage.schema";
+// =============================================================================
+// Delegation Schemas
+// =============================================================================
+import { JWKSchema, KeyTypeSchema, KeyInfoSchema, DelegationErrorSchema, DelegationSchema, CapabilityEntrySchema, DelegationRecordSchema, CreateDelegationParamsSchema, DelegationChainSchema, DelegationChainV2Schema, DelegationDirectionSchema, DelegationFiltersSchema, SpaceOwnershipSchema, SpaceInfoSchema, ShareSchemaSchema, ShareLinkSchema, IngestOptionsSchema, GenerateShareParamsSchema, DelegationApiResponseSchema, CreateDelegationWasmParamsSchema, CreateDelegationWasmResultSchema, } from "./delegations/types.schema";
+// =============================================================================
+// Space Hosting Schemas
+// =============================================================================
+import { SpaceHostResultSchema } from "./space.schema";
+// =============================================================================
+// Space Creation Schemas
+// =============================================================================
+import { SpaceCreationContextSchema, SpaceCreationHandlerSchema, } from "./authorization/spaceCreation.schema";
+// =============================================================================
+// TinyCloud Config Schemas
+// =============================================================================
+import { BackoffStrategySchema, RetryPolicySchema, PartialRetryPolicySchema, TinyCloudConfigSchema, } from "./TinyCloud.schema";
+// =============================================================================
+// User Authorization Schemas
+// =============================================================================
+import { PartialSiweMessageSchema, UserAuthorizationConfigSchema, } from "./userAuthorization.schema";
+// =============================================================================
+// Sign Strategy Schemas
+// =============================================================================
+import { SignRequestTypeSchema, SignRequestSchema, SignResponseSchema, AutoSignStrategySchema, AutoRejectStrategySchema, CallbackStrategySchema, EventEmitterStrategySchema, SignStrategySchema, } from "./authorization/strategies.schema";
+// =============================================================================
+// Space Service Schemas
+// =============================================================================
+import { SpaceConfigSchema, SpaceServiceConfigSchema, SpaceDelegationParamsSchema, } from "./spaces/spaces.schema";
+const defaultOptions = {
+    target: "jsonSchema7",
+};
+// =============================================================================
+// Individual Schema Exports - Storage
+// =============================================================================
+/**
+ * Generate JSON Schema for EnsData.
+ */
+export function getEnsDataJsonSchema(options) {
+    return zodToJsonSchema(EnsDataSchema, {
+        name: options?.name ?? "EnsData",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for PersistedTinyCloudSession.
+ */
+export function getPersistedTinyCloudSessionJsonSchema(options) {
+    return zodToJsonSchema(PersistedTinyCloudSessionSchema, {
+        name: options?.name ?? "PersistedTinyCloudSession",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for PersistedSessionData.
+ */
+export function getPersistedSessionDataJsonSchema(options) {
+    return zodToJsonSchema(PersistedSessionDataSchema, {
+        name: options?.name ?? "PersistedSessionData",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for TinyCloudSession.
+ */
+export function getTinyCloudSessionJsonSchema(options) {
+    return zodToJsonSchema(TinyCloudSessionSchema, {
+        name: options?.name ?? "TinyCloudSession",
+        ...defaultOptions,
+        ...options,
+    });
+}
+// =============================================================================
+// Individual Schema Exports - Delegations
+// =============================================================================
+/**
+ * Generate JSON Schema for JWK.
+ */
+export function getJWKJsonSchema(options) {
+    return zodToJsonSchema(JWKSchema, {
+        name: options?.name ?? "JWK",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for KeyType.
+ */
+export function getKeyTypeJsonSchema(options) {
+    return zodToJsonSchema(KeyTypeSchema, {
+        name: options?.name ?? "KeyType",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for KeyInfo.
+ */
+export function getKeyInfoJsonSchema(options) {
+    return zodToJsonSchema(KeyInfoSchema, {
+        name: options?.name ?? "KeyInfo",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for DelegationError.
+ */
+export function getDelegationErrorJsonSchema(options) {
+    return zodToJsonSchema(DelegationErrorSchema, {
+        name: options?.name ?? "DelegationError",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for Delegation.
+ */
+export function getDelegationJsonSchema(options) {
+    return zodToJsonSchema(DelegationSchema, {
+        name: options?.name ?? "Delegation",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for CapabilityEntry.
+ */
+export function getCapabilityEntryJsonSchema(options) {
+    return zodToJsonSchema(CapabilityEntrySchema, {
+        name: options?.name ?? "CapabilityEntry",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for DelegationRecord.
+ */
+export function getDelegationRecordJsonSchema(options) {
+    return zodToJsonSchema(DelegationRecordSchema, {
+        name: options?.name ?? "DelegationRecord",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for CreateDelegationParams.
+ */
+export function getCreateDelegationParamsJsonSchema(options) {
+    return zodToJsonSchema(CreateDelegationParamsSchema, {
+        name: options?.name ?? "CreateDelegationParams",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for DelegationChain.
+ */
+export function getDelegationChainJsonSchema(options) {
+    return zodToJsonSchema(DelegationChainSchema, {
+        name: options?.name ?? "DelegationChain",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for DelegationChainV2.
+ */
+export function getDelegationChainV2JsonSchema(options) {
+    return zodToJsonSchema(DelegationChainV2Schema, {
+        name: options?.name ?? "DelegationChainV2",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for DelegationDirection.
+ */
+export function getDelegationDirectionJsonSchema(options) {
+    return zodToJsonSchema(DelegationDirectionSchema, {
+        name: options?.name ?? "DelegationDirection",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for DelegationFilters.
+ */
+export function getDelegationFiltersJsonSchema(options) {
+    return zodToJsonSchema(DelegationFiltersSchema, {
+        name: options?.name ?? "DelegationFilters",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for SpaceOwnership.
+ */
+export function getSpaceOwnershipJsonSchema(options) {
+    return zodToJsonSchema(SpaceOwnershipSchema, {
+        name: options?.name ?? "SpaceOwnership",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for SpaceInfo.
+ */
+export function getSpaceInfoJsonSchema(options) {
+    return zodToJsonSchema(SpaceInfoSchema, {
+        name: options?.name ?? "SpaceInfo",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for ShareSchema.
+ */
+export function getShareSchemaJsonSchema(options) {
+    return zodToJsonSchema(ShareSchemaSchema, {
+        name: options?.name ?? "ShareSchema",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for ShareLink.
+ */
+export function getShareLinkJsonSchema(options) {
+    return zodToJsonSchema(ShareLinkSchema, {
+        name: options?.name ?? "ShareLink",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for IngestOptions.
+ */
+export function getIngestOptionsJsonSchema(options) {
+    return zodToJsonSchema(IngestOptionsSchema, {
+        name: options?.name ?? "IngestOptions",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for GenerateShareParams.
+ */
+export function getGenerateShareParamsJsonSchema(options) {
+    return zodToJsonSchema(GenerateShareParamsSchema, {
+        name: options?.name ?? "GenerateShareParams",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for DelegationApiResponse.
+ */
+export function getDelegationApiResponseJsonSchema(options) {
+    return zodToJsonSchema(DelegationApiResponseSchema, {
+        name: options?.name ?? "DelegationApiResponse",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for CreateDelegationWasmParams.
+ */
+export function getCreateDelegationWasmParamsJsonSchema(options) {
+    return zodToJsonSchema(CreateDelegationWasmParamsSchema, {
+        name: options?.name ?? "CreateDelegationWasmParams",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for CreateDelegationWasmResult.
+ */
+export function getCreateDelegationWasmResultJsonSchema(options) {
+    return zodToJsonSchema(CreateDelegationWasmResultSchema, {
+        name: options?.name ?? "CreateDelegationWasmResult",
+        ...defaultOptions,
+        ...options,
+    });
+}
+// =============================================================================
+// Individual Schema Exports - Space Hosting
+// =============================================================================
+/**
+ * Generate JSON Schema for SpaceHostResult.
+ */
+export function getSpaceHostResultJsonSchema(options) {
+    return zodToJsonSchema(SpaceHostResultSchema, {
+        name: options?.name ?? "SpaceHostResult",
+        ...defaultOptions,
+        ...options,
+    });
+}
+// =============================================================================
+// Individual Schema Exports - Space Creation
+// =============================================================================
+/**
+ * Generate JSON Schema for SpaceCreationContext.
+ */
+export function getSpaceCreationContextJsonSchema(options) {
+    return zodToJsonSchema(SpaceCreationContextSchema, {
+        name: options?.name ?? "SpaceCreationContext",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for SpaceCreationHandler.
+ */
+export function getSpaceCreationHandlerJsonSchema(options) {
+    return zodToJsonSchema(SpaceCreationHandlerSchema, {
+        name: options?.name ?? "SpaceCreationHandler",
+        ...defaultOptions,
+        ...options,
+    });
+}
+// =============================================================================
+// Individual Schema Exports - TinyCloud Config
+// =============================================================================
+/**
+ * Generate JSON Schema for BackoffStrategy.
+ */
+export function getBackoffStrategyJsonSchema(options) {
+    return zodToJsonSchema(BackoffStrategySchema, {
+        name: options?.name ?? "BackoffStrategy",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for RetryPolicy.
+ */
+export function getRetryPolicyJsonSchema(options) {
+    return zodToJsonSchema(RetryPolicySchema, {
+        name: options?.name ?? "RetryPolicy",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for PartialRetryPolicy.
+ */
+export function getPartialRetryPolicyJsonSchema(options) {
+    return zodToJsonSchema(PartialRetryPolicySchema, {
+        name: options?.name ?? "PartialRetryPolicy",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for TinyCloudConfig.
+ */
+export function getTinyCloudConfigJsonSchema(options) {
+    return zodToJsonSchema(TinyCloudConfigSchema, {
+        name: options?.name ?? "TinyCloudConfig",
+        ...defaultOptions,
+        ...options,
+    });
+}
+// =============================================================================
+// Individual Schema Exports - User Authorization
+// =============================================================================
+/**
+ * Generate JSON Schema for PartialSiweMessage.
+ */
+export function getPartialSiweMessageJsonSchema(options) {
+    return zodToJsonSchema(PartialSiweMessageSchema, {
+        name: options?.name ?? "PartialSiweMessage",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for UserAuthorizationConfig.
+ */
+export function getUserAuthorizationConfigJsonSchema(options) {
+    return zodToJsonSchema(UserAuthorizationConfigSchema, {
+        name: options?.name ?? "UserAuthorizationConfig",
+        ...defaultOptions,
+        ...options,
+    });
+}
+// =============================================================================
+// Individual Schema Exports - Sign Strategy
+// =============================================================================
+/**
+ * Generate JSON Schema for SignRequestType.
+ */
+export function getSignRequestTypeJsonSchema(options) {
+    return zodToJsonSchema(SignRequestTypeSchema, {
+        name: options?.name ?? "SignRequestType",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for SignRequest.
+ */
+export function getSignRequestJsonSchema(options) {
+    return zodToJsonSchema(SignRequestSchema, {
+        name: options?.name ?? "SignRequest",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for SignResponse.
+ */
+export function getSignResponseJsonSchema(options) {
+    return zodToJsonSchema(SignResponseSchema, {
+        name: options?.name ?? "SignResponse",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for AutoSignStrategy.
+ */
+export function getAutoSignStrategyJsonSchema(options) {
+    return zodToJsonSchema(AutoSignStrategySchema, {
+        name: options?.name ?? "AutoSignStrategy",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for AutoRejectStrategy.
+ */
+export function getAutoRejectStrategyJsonSchema(options) {
+    return zodToJsonSchema(AutoRejectStrategySchema, {
+        name: options?.name ?? "AutoRejectStrategy",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for CallbackStrategy.
+ */
+export function getCallbackStrategyJsonSchema(options) {
+    return zodToJsonSchema(CallbackStrategySchema, {
+        name: options?.name ?? "CallbackStrategy",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for EventEmitterStrategy.
+ */
+export function getEventEmitterStrategyJsonSchema(options) {
+    return zodToJsonSchema(EventEmitterStrategySchema, {
+        name: options?.name ?? "EventEmitterStrategy",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for SignStrategy.
+ */
+export function getSignStrategyJsonSchema(options) {
+    return zodToJsonSchema(SignStrategySchema, {
+        name: options?.name ?? "SignStrategy",
+        ...defaultOptions,
+        ...options,
+    });
+}
+// =============================================================================
+// Individual Schema Exports - Space Service
+// =============================================================================
+/**
+ * Generate JSON Schema for SpaceConfig.
+ */
+export function getSpaceConfigJsonSchema(options) {
+    return zodToJsonSchema(SpaceConfigSchema, {
+        name: options?.name ?? "SpaceConfig",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for SpaceServiceConfig.
+ */
+export function getSpaceServiceConfigJsonSchema(options) {
+    return zodToJsonSchema(SpaceServiceConfigSchema, {
+        name: options?.name ?? "SpaceServiceConfig",
+        ...defaultOptions,
+        ...options,
+    });
+}
+/**
+ * Generate JSON Schema for SpaceDelegationParams.
+ */
+export function getSpaceDelegationParamsJsonSchema(options) {
+    return zodToJsonSchema(SpaceDelegationParamsSchema, {
+        name: options?.name ?? "SpaceDelegationParams",
+        ...defaultOptions,
+        ...options,
+    });
+}
+// =============================================================================
+// Bundle Generation
+// =============================================================================
+/**
+ * Generate all JSON Schemas as a categorized bundle.
+ *
+ * This function generates JSON Schema for every Zod schema in the SDK,
+ * organized into logical categories for easy consumption.
+ *
+ * @param options - Options applied to all schema generation
+ * @returns Object containing all JSON Schemas organized by category
+ *
+ * @example
+ * ```typescript
+ * import { getAllJsonSchemas } from "@tinycloud/sdk-core";
+ *
+ * const schemas = getAllJsonSchemas();
+ *
+ * // Access individual schemas
+ * console.log(schemas.delegations.Delegation);
+ * console.log(schemas.storage.PersistedSessionData);
+ *
+ * // Export all schemas to file
+ * fs.writeFileSync("schemas.json", JSON.stringify(schemas, null, 2));
+ * ```
+ */
+export function getAllJsonSchemas(options) {
+    return {
+        storage: {
+            EnsData: getEnsDataJsonSchema(options),
+            PersistedTinyCloudSession: getPersistedTinyCloudSessionJsonSchema(options),
+            PersistedSessionData: getPersistedSessionDataJsonSchema(options),
+            TinyCloudSession: getTinyCloudSessionJsonSchema(options),
+        },
+        delegations: {
+            JWK: getJWKJsonSchema(options),
+            KeyType: getKeyTypeJsonSchema(options),
+            KeyInfo: getKeyInfoJsonSchema(options),
+            DelegationError: getDelegationErrorJsonSchema(options),
+            Delegation: getDelegationJsonSchema(options),
+            CapabilityEntry: getCapabilityEntryJsonSchema(options),
+            DelegationRecord: getDelegationRecordJsonSchema(options),
+            CreateDelegationParams: getCreateDelegationParamsJsonSchema(options),
+            DelegationChain: getDelegationChainJsonSchema(options),
+            DelegationChainV2: getDelegationChainV2JsonSchema(options),
+            DelegationDirection: getDelegationDirectionJsonSchema(options),
+            DelegationFilters: getDelegationFiltersJsonSchema(options),
+            SpaceOwnership: getSpaceOwnershipJsonSchema(options),
+            SpaceInfo: getSpaceInfoJsonSchema(options),
+            ShareSchema: getShareSchemaJsonSchema(options),
+            ShareLink: getShareLinkJsonSchema(options),
+            IngestOptions: getIngestOptionsJsonSchema(options),
+            GenerateShareParams: getGenerateShareParamsJsonSchema(options),
+            DelegationApiResponse: getDelegationApiResponseJsonSchema(options),
+            CreateDelegationWasmParams: getCreateDelegationWasmParamsJsonSchema(options),
+            CreateDelegationWasmResult: getCreateDelegationWasmResultJsonSchema(options),
+        },
+        spaceHosting: {
+            SpaceHostResult: getSpaceHostResultJsonSchema(options),
+        },
+        spaceCreation: {
+            SpaceCreationContext: getSpaceCreationContextJsonSchema(options),
+            SpaceCreationHandler: getSpaceCreationHandlerJsonSchema(options),
+        },
+        config: {
+            BackoffStrategy: getBackoffStrategyJsonSchema(options),
+            RetryPolicy: getRetryPolicyJsonSchema(options),
+            PartialRetryPolicy: getPartialRetryPolicyJsonSchema(options),
+            TinyCloudConfig: getTinyCloudConfigJsonSchema(options),
+        },
+        authorization: {
+            PartialSiweMessage: getPartialSiweMessageJsonSchema(options),
+            UserAuthorizationConfig: getUserAuthorizationConfigJsonSchema(options),
+        },
+        signStrategy: {
+            SignRequestType: getSignRequestTypeJsonSchema(options),
+            SignRequest: getSignRequestJsonSchema(options),
+            SignResponse: getSignResponseJsonSchema(options),
+            AutoSignStrategy: getAutoSignStrategyJsonSchema(options),
+            AutoRejectStrategy: getAutoRejectStrategyJsonSchema(options),
+            CallbackStrategy: getCallbackStrategyJsonSchema(options),
+            EventEmitterStrategy: getEventEmitterStrategyJsonSchema(options),
+            SignStrategy: getSignStrategyJsonSchema(options),
+        },
+        spaceService: {
+            SpaceConfig: getSpaceConfigJsonSchema(options),
+            SpaceServiceConfig: getSpaceServiceConfigJsonSchema(options),
+            SpaceDelegationParams: getSpaceDelegationParamsJsonSchema(options),
+        },
+    };
+}
+/**
+ * Get a flat object of all JSON Schemas keyed by name.
+ *
+ * @param options - Options applied to all schema generation
+ * @returns Object mapping schema names to JSON Schema definitions
+ *
+ * @example
+ * ```typescript
+ * import { getAllJsonSchemasFlat } from "@tinycloud/sdk-core";
+ *
+ * const schemas = getAllJsonSchemasFlat();
+ * console.log(Object.keys(schemas)); // ["EnsData", "Delegation", ...]
+ * ```
+ */
+export function getAllJsonSchemasFlat(options) {
+    const bundle = getAllJsonSchemas(options);
+    return {
+        // Storage
+        ...bundle.storage,
+        // Delegations
+        ...bundle.delegations,
+        // Space hosting
+        ...bundle.spaceHosting,
+        // Space creation
+        ...bundle.spaceCreation,
+        // Config
+        ...bundle.config,
+        // Authorization
+        ...bundle.authorization,
+        // Sign strategy
+        ...bundle.signStrategy,
+        // Space service
+        ...bundle.spaceService,
+    };
+}
+/**
+ * List of all available schema names.
+ */
+export const SCHEMA_NAMES = [
+    // Storage
+    "EnsData",
+    "PersistedTinyCloudSession",
+    "PersistedSessionData",
+    "TinyCloudSession",
+    // Delegations
+    "JWK",
+    "KeyType",
+    "KeyInfo",
+    "DelegationError",
+    "Delegation",
+    "CapabilityEntry",
+    "DelegationRecord",
+    "CreateDelegationParams",
+    "DelegationChain",
+    "DelegationChainV2",
+    "DelegationDirection",
+    "DelegationFilters",
+    "SpaceOwnership",
+    "SpaceInfo",
+    "ShareSchema",
+    "ShareLink",
+    "IngestOptions",
+    "GenerateShareParams",
+    "DelegationApiResponse",
+    "CreateDelegationWasmParams",
+    "CreateDelegationWasmResult",
+    // Space hosting
+    "SpaceHostResult",
+    // Space creation
+    "SpaceCreationContext",
+    "SpaceCreationHandler",
+    // Config
+    "BackoffStrategy",
+    "RetryPolicy",
+    "PartialRetryPolicy",
+    "TinyCloudConfig",
+    // Authorization
+    "PartialSiweMessage",
+    "UserAuthorizationConfig",
+    // Sign strategy
+    "SignRequestType",
+    "SignRequest",
+    "SignResponse",
+    "AutoSignStrategy",
+    "AutoRejectStrategy",
+    "CallbackStrategy",
+    "EventEmitterStrategy",
+    "SignStrategy",
+    // Space service
+    "SpaceConfig",
+    "SpaceServiceConfig",
+    "SpaceDelegationParams",
+];
+//# sourceMappingURL=json-schema.js.map