@hashgraphonline/standards-sdk 0.1.141-canary.0 → 0.1.141

package/dist/cjs/hcs-21/types.d.ts

@@ -1,690 +1,89 @@
 import { z } from 'zod';
 export declare const HCS21_PROTOCOL = "hcs-21";
 export declare const HCS21_MAX_MESSAGE_BYTES = 1024;
-export declare const HCS21ManifestPointerPattern: RegExp;
-export declare const HCS21TopicIdPattern: RegExp;
-export type HCS21Operation = 'register' | 'update' | 'delete';
-export interface AdapterPackage {
-    registry: string;
-    name: string;
-    version: string;
-    integrity: string;
-}
-export interface FloraContext {
-    account: string;
-    threshold: string;
-    ctopic: string;
-    ttopic: string;
-    stopic: string;
-}
-export interface AdapterDeclaration {
+export declare const HCS21_REGISTRY_NAMESPACES: readonly ["npm", "pypi", "oci", "composer", "packagist", "cargo", "nuget", "maven", "rubygems", "helm", "go"];
+export type PackageRegistryNamespace = (typeof HCS21_REGISTRY_NAMESPACES)[number];
+export type HCS21Operation = 'register' | 'update';
+export declare const HCS21MetadataPointerPattern: RegExp;
+export interface PackageDeclaration {
     p: typeof HCS21_PROTOCOL;
     op: HCS21Operation;
-    adapter_id: string;
-    entity: string;
-    package: AdapterPackage;
-    manifest: string;
-    flora: FloraContext;
-    state_model: string;
-    signature?: string;
+    registry: PackageRegistryNamespace;
+    t_id: string;
+    n: string;
+    d: string;
+    a: string;
+    tags?: string[];
+    metadata?: string;
 }
-export interface AdapterDeclarationEnvelope {
-    declaration: AdapterDeclaration;
-    consensusTimestamp?: string;
-    sequenceNumber: number;
-    payer?: string;
+export interface PackageArtifact {
+    type: string;
+    url: string;
+    digest?: string;
+    signature?: string;
+    [key: string]: unknown;
 }
-export declare enum HCS21TopicType {
-    ADAPTER_REGISTRY = 0,
-    REGISTRY_OF_REGISTRIES = 1
+export interface PackageMetadataRecord {
+    schema: string;
+    t_id?: string;
+    description?: string;
+    maintainers?: string[];
+    website?: string;
+    docs?: string;
+    source?: string;
+    support?: string;
+    tags?: string[];
+    artifacts?: PackageArtifact[];
+    capabilities?: string[];
+    dependencies?: Record<string, string>;
+    [key: string]: unknown;
 }
-export interface ManifestPointer {
+export interface PackageMetadataPointer {
     pointer: string;
     topicId: string;
     sequenceNumber: number;
     jobId?: string;
     transactionId?: string;
 }
-export declare const adapterPackageSchema: z.ZodObject<{
-    registry: z.ZodString;
-    name: z.ZodString;
-    version: z.ZodString;
-    integrity: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    name?: string;
-    version?: string;
-    registry?: string;
-    integrity?: string;
-}, {
-    name?: string;
-    version?: string;
-    registry?: string;
-    integrity?: string;
-}>;
-export declare const floraContextSchema: z.ZodObject<{
-    account: z.ZodString;
-    threshold: z.ZodString;
-    ctopic: z.ZodString;
-    ttopic: z.ZodString;
-    stopic: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    threshold?: string;
-    account?: string;
-    ctopic?: string;
-    ttopic?: string;
-    stopic?: string;
-}, {
-    threshold?: string;
-    account?: string;
-    ctopic?: string;
-    ttopic?: string;
-    stopic?: string;
-}>;
-export declare const adapterDeclarationSchema: z.ZodObject<{
+export interface PackageDeclarationEnvelope {
+    declaration: PackageDeclaration;
+    consensusTimestamp?: string;
+    sequenceNumber: number;
+    payer?: string;
+}
+export declare enum HCS21TopicType {
+    REGISTRY = 0
+}
+export declare const packageDeclarationSchema: z.ZodObject<{
     p: z.ZodLiteral<"hcs-21">;
-    op: z.ZodEnum<["register", "update", "delete"]>;
-    adapter_id: z.ZodString;
-    entity: z.ZodString;
-    package: z.ZodObject<{
-        registry: z.ZodString;
-        name: z.ZodString;
-        version: z.ZodString;
-        integrity: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        name?: string;
-        version?: string;
-        registry?: string;
-        integrity?: string;
-    }, {
-        name?: string;
-        version?: string;
-        registry?: string;
-        integrity?: string;
-    }>;
-    manifest: z.ZodString;
-    flora: z.ZodObject<{
-        account: z.ZodString;
-        threshold: z.ZodString;
-        ctopic: z.ZodString;
-        ttopic: z.ZodString;
-        stopic: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        threshold?: string;
-        account?: string;
-        ctopic?: string;
-        ttopic?: string;
-        stopic?: string;
-    }, {
-        threshold?: string;
-        account?: string;
-        ctopic?: string;
-        ttopic?: string;
-        stopic?: string;
-    }>;
-    state_model: z.ZodString;
-    signature: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    p?: "hcs-21";
-    op?: "delete" | "register" | "update";
-    signature?: string;
-    adapter_id?: string;
-    entity?: string;
-    package?: {
-        name?: string;
-        version?: string;
-        registry?: string;
-        integrity?: string;
-    };
-    manifest?: string;
-    flora?: {
-        threshold?: string;
-        account?: string;
-        ctopic?: string;
-        ttopic?: string;
-        stopic?: string;
-    };
-    state_model?: string;
-}, {
-    p?: "hcs-21";
-    op?: "delete" | "register" | "update";
-    signature?: string;
-    adapter_id?: string;
-    entity?: string;
-    package?: {
-        name?: string;
-        version?: string;
-        registry?: string;
-        integrity?: string;
-    };
-    manifest?: string;
-    flora?: {
-        threshold?: string;
-        account?: string;
-        ctopic?: string;
-        ttopic?: string;
-        stopic?: string;
-    };
-    state_model?: string;
-}>;
-export declare const adapterManifestSchema: z.ZodObject<{
-    meta: z.ZodObject<{
-        spec_version: z.ZodString;
-        adapter_version: z.ZodString;
-        minimum_flora_version: z.ZodString;
-        generated: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        spec_version?: string;
-        adapter_version?: string;
-        minimum_flora_version?: string;
-        generated?: string;
-    }, {
-        spec_version?: string;
-        adapter_version?: string;
-        minimum_flora_version?: string;
-        generated?: string;
-    }>;
-    adapter: z.ZodObject<{
-        name: z.ZodString;
-        id: z.ZodString;
-        maintainers: z.ZodArray<z.ZodObject<{
-            name: z.ZodString;
-            contact: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            name?: string;
-            contact?: string;
-        }, {
-            name?: string;
-            contact?: string;
-        }>, "many">;
-        license: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        name?: string;
-        id?: string;
-        license?: string;
-        maintainers?: {
-            name?: string;
-            contact?: string;
-        }[];
-    }, {
-        name?: string;
-        id?: string;
-        license?: string;
-        maintainers?: {
-            name?: string;
-            contact?: string;
-        }[];
-    }>;
-    package: z.ZodObject<{
-        registry: z.ZodString;
-        dist_tag: z.ZodOptional<z.ZodString>;
-        artifacts: z.ZodArray<z.ZodObject<{
-            url: z.ZodString;
-            digest: z.ZodString;
-            signature: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }, {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        registry?: string;
-        dist_tag?: string;
-        artifacts?: {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }[];
-    }, {
-        registry?: string;
-        dist_tag?: string;
-        artifacts?: {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }[];
-    }>;
-    runtime: z.ZodObject<{
-        platforms: z.ZodArray<z.ZodString, "many">;
-        primary: z.ZodString;
-        entry: z.ZodString;
-        dependencies: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-        env: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        env?: string[];
-        primary?: string;
-        entry?: string;
-        dependencies?: string[];
-        platforms?: string[];
-    }, {
-        env?: string[];
-        primary?: string;
-        entry?: string;
-        dependencies?: string[];
-        platforms?: string[];
-    }>;
-    capabilities: z.ZodObject<{
-        discovery: z.ZodBoolean;
-        communication: z.ZodBoolean;
-        protocols: z.ZodArray<z.ZodString, "many">;
-    }, "strip", z.ZodTypeAny, {
-        communication?: boolean;
-        protocols?: string[];
-        discovery?: boolean;
-    }, {
-        communication?: boolean;
-        protocols?: string[];
-        discovery?: boolean;
-    }>;
-    consensus: z.ZodObject<{
-        entity_schema: z.ZodString;
-        required_fields: z.ZodArray<z.ZodString, "many">;
-        hashing: z.ZodLiteral<"sha384">;
-    }, "strip", z.ZodTypeAny, {
-        entity_schema?: string;
-        required_fields?: string[];
-        hashing?: "sha384";
-    }, {
-        entity_schema?: string;
-        required_fields?: string[];
-        hashing?: "sha384";
-    }>;
-}, "strip", z.ZodTypeAny, {
-    meta?: {
-        spec_version?: string;
-        adapter_version?: string;
-        minimum_flora_version?: string;
-        generated?: string;
-    };
-    capabilities?: {
-        communication?: boolean;
-        protocols?: string[];
-        discovery?: boolean;
-    };
-    adapter?: {
-        name?: string;
-        id?: string;
-        license?: string;
-        maintainers?: {
-            name?: string;
-            contact?: string;
-        }[];
-    };
-    package?: {
-        registry?: string;
-        dist_tag?: string;
-        artifacts?: {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }[];
-    };
-    runtime?: {
-        env?: string[];
-        primary?: string;
-        entry?: string;
-        dependencies?: string[];
-        platforms?: string[];
-    };
-    consensus?: {
-        entity_schema?: string;
-        required_fields?: string[];
-        hashing?: "sha384";
-    };
-}, {
-    meta?: {
-        spec_version?: string;
-        adapter_version?: string;
-        minimum_flora_version?: string;
-        generated?: string;
-    };
-    capabilities?: {
-        communication?: boolean;
-        protocols?: string[];
-        discovery?: boolean;
-    };
-    adapter?: {
-        name?: string;
-        id?: string;
-        license?: string;
-        maintainers?: {
-            name?: string;
-            contact?: string;
-        }[];
-    };
-    package?: {
-        registry?: string;
-        dist_tag?: string;
-        artifacts?: {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }[];
-    };
-    runtime?: {
-        env?: string[];
-        primary?: string;
-        entry?: string;
-        dependencies?: string[];
-        platforms?: string[];
-    };
-    consensus?: {
-        entity_schema?: string;
-        required_fields?: string[];
-        hashing?: "sha384";
-    };
-}>;
-export declare const registryMetadataSchema: z.ZodObject<{
-    version: z.ZodString;
-    name: z.ZodString;
-    description: z.ZodString;
-    operator: z.ZodObject<{
-        account: z.ZodString;
-        name: z.ZodOptional<z.ZodString>;
-        contact: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name?: string;
-        account?: string;
-        contact?: string;
-    }, {
-        name?: string;
-        account?: string;
-        contact?: string;
-    }>;
-    entityTypes: z.ZodArray<z.ZodString, "many">;
-    categories: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    op: z.ZodEnum<["register", "update"]>;
+    registry: z.ZodEnum<["npm", "pypi", "oci", "composer", "packagist", "cargo", "nuget", "maven", "rubygems", "helm", "go"]>;
+    t_id: z.ZodString;
+    n: z.ZodString;
+    d: z.ZodString;
+    a: z.ZodString;
     tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    metadata: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    name?: string;
-    version?: string;
-    description?: string;
+    a?: string;
+    p?: "hcs-21";
+    metadata?: string;
+    op?: "register" | "update";
+    t_id?: string;
+    registry?: "npm" | "pypi" | "oci" | "composer" | "packagist" | "cargo" | "nuget" | "maven" | "rubygems" | "helm" | "go";
     tags?: string[];
-    operator?: {
-        name?: string;
-        account?: string;
-        contact?: string;
-    };
-    entityTypes?: string[];
-    categories?: string[];
-    links?: Record<string, string>;
+    d?: string;
+    n?: string;
 }, {
-    name?: string;
-    version?: string;
-    description?: string;
+    a?: string;
+    p?: "hcs-21";
+    metadata?: string;
+    op?: "register" | "update";
+    t_id?: string;
+    registry?: "npm" | "pypi" | "oci" | "composer" | "packagist" | "cargo" | "nuget" | "maven" | "rubygems" | "helm" | "go";
     tags?: string[];
-    operator?: {
-        name?: string;
-        account?: string;
-        contact?: string;
-    };
-    entityTypes?: string[];
-    categories?: string[];
-    links?: Record<string, string>;
+    d?: string;
+    n?: string;
 }>;
-export declare const metadataDocumentSchema: z.ZodUnion<[z.ZodObject<{
-    meta: z.ZodObject<{
-        spec_version: z.ZodString;
-        adapter_version: z.ZodString;
-        minimum_flora_version: z.ZodString;
-        generated: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        spec_version?: string;
-        adapter_version?: string;
-        minimum_flora_version?: string;
-        generated?: string;
-    }, {
-        spec_version?: string;
-        adapter_version?: string;
-        minimum_flora_version?: string;
-        generated?: string;
-    }>;
-    adapter: z.ZodObject<{
-        name: z.ZodString;
-        id: z.ZodString;
-        maintainers: z.ZodArray<z.ZodObject<{
-            name: z.ZodString;
-            contact: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            name?: string;
-            contact?: string;
-        }, {
-            name?: string;
-            contact?: string;
-        }>, "many">;
-        license: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        name?: string;
-        id?: string;
-        license?: string;
-        maintainers?: {
-            name?: string;
-            contact?: string;
-        }[];
-    }, {
-        name?: string;
-        id?: string;
-        license?: string;
-        maintainers?: {
-            name?: string;
-            contact?: string;
-        }[];
-    }>;
-    package: z.ZodObject<{
-        registry: z.ZodString;
-        dist_tag: z.ZodOptional<z.ZodString>;
-        artifacts: z.ZodArray<z.ZodObject<{
-            url: z.ZodString;
-            digest: z.ZodString;
-            signature: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }, {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        registry?: string;
-        dist_tag?: string;
-        artifacts?: {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }[];
-    }, {
-        registry?: string;
-        dist_tag?: string;
-        artifacts?: {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }[];
-    }>;
-    runtime: z.ZodObject<{
-        platforms: z.ZodArray<z.ZodString, "many">;
-        primary: z.ZodString;
-        entry: z.ZodString;
-        dependencies: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-        env: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        env?: string[];
-        primary?: string;
-        entry?: string;
-        dependencies?: string[];
-        platforms?: string[];
-    }, {
-        env?: string[];
-        primary?: string;
-        entry?: string;
-        dependencies?: string[];
-        platforms?: string[];
-    }>;
-    capabilities: z.ZodObject<{
-        discovery: z.ZodBoolean;
-        communication: z.ZodBoolean;
-        protocols: z.ZodArray<z.ZodString, "many">;
-    }, "strip", z.ZodTypeAny, {
-        communication?: boolean;
-        protocols?: string[];
-        discovery?: boolean;
-    }, {
-        communication?: boolean;
-        protocols?: string[];
-        discovery?: boolean;
-    }>;
-    consensus: z.ZodObject<{
-        entity_schema: z.ZodString;
-        required_fields: z.ZodArray<z.ZodString, "many">;
-        hashing: z.ZodLiteral<"sha384">;
-    }, "strip", z.ZodTypeAny, {
-        entity_schema?: string;
-        required_fields?: string[];
-        hashing?: "sha384";
-    }, {
-        entity_schema?: string;
-        required_fields?: string[];
-        hashing?: "sha384";
-    }>;
-}, "strip", z.ZodTypeAny, {
-    meta?: {
-        spec_version?: string;
-        adapter_version?: string;
-        minimum_flora_version?: string;
-        generated?: string;
-    };
-    capabilities?: {
-        communication?: boolean;
-        protocols?: string[];
-        discovery?: boolean;
-    };
-    adapter?: {
-        name?: string;
-        id?: string;
-        license?: string;
-        maintainers?: {
-            name?: string;
-            contact?: string;
-        }[];
-    };
-    package?: {
-        registry?: string;
-        dist_tag?: string;
-        artifacts?: {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }[];
-    };
-    runtime?: {
-        env?: string[];
-        primary?: string;
-        entry?: string;
-        dependencies?: string[];
-        platforms?: string[];
-    };
-    consensus?: {
-        entity_schema?: string;
-        required_fields?: string[];
-        hashing?: "sha384";
-    };
-}, {
-    meta?: {
-        spec_version?: string;
-        adapter_version?: string;
-        minimum_flora_version?: string;
-        generated?: string;
-    };
-    capabilities?: {
-        communication?: boolean;
-        protocols?: string[];
-        discovery?: boolean;
-    };
-    adapter?: {
-        name?: string;
-        id?: string;
-        license?: string;
-        maintainers?: {
-            name?: string;
-            contact?: string;
-        }[];
-    };
-    package?: {
-        registry?: string;
-        dist_tag?: string;
-        artifacts?: {
-            url?: string;
-            signature?: string;
-            digest?: string;
-        }[];
-    };
-    runtime?: {
-        env?: string[];
-        primary?: string;
-        entry?: string;
-        dependencies?: string[];
-        platforms?: string[];
-    };
-    consensus?: {
-        entity_schema?: string;
-        required_fields?: string[];
-        hashing?: "sha384";
-    };
-}>, z.ZodObject<{
-    version: z.ZodString;
-    name: z.ZodString;
-    description: z.ZodString;
-    operator: z.ZodObject<{
-        account: z.ZodString;
-        name: z.ZodOptional<z.ZodString>;
-        contact: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name?: string;
-        account?: string;
-        contact?: string;
-    }, {
-        name?: string;
-        account?: string;
-        contact?: string;
-    }>;
-    entityTypes: z.ZodArray<z.ZodString, "many">;
-    categories: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    links: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
-}, "strip", z.ZodTypeAny, {
-    name?: string;
-    version?: string;
-    description?: string;
-    tags?: string[];
-    operator?: {
-        name?: string;
-        account?: string;
-        contact?: string;
-    };
-    entityTypes?: string[];
-    categories?: string[];
-    links?: Record<string, string>;
-}, {
-    name?: string;
-    version?: string;
-    description?: string;
-    tags?: string[];
-    operator?: {
-        name?: string;
-        account?: string;
-        contact?: string;
-    };
-    entityTypes?: string[];
-    categories?: string[];
-    links?: Record<string, string>;
-}>]>;
-export type AdapterDeclarationValidation = z.infer<typeof adapterDeclarationSchema>;
-export type AdapterManifest = z.infer<typeof adapterManifestSchema>;
-export type RegistryMetadataRecord = z.infer<typeof registryMetadataSchema>;
-export type HCS21MetadataDocument = AdapterManifest | RegistryMetadataRecord;
+export type PackageDeclarationValidation = z.infer<typeof packageDeclarationSchema>;
 //# sourceMappingURL=types.d.ts.map