@native-knowledge/knowledge-sdk 0.0.0-stage → 0.1.0-rc.1

package/dist/types/contracts/tenant-web-collection.d.ts

@@ -0,0 +1,287 @@
+import { z } from 'zod';
+export declare const TENANT_WEB_SPEC_CAPABILITY = "TENANT_WEB_COLLECTION_SPEC_V1";
+export declare const tenantWebUrlSchema: z.ZodString;
+export declare const tenantWebScopeSchema: z.ZodObject<{
+    mode: z.ZodEnum<{
+        FEED: "FEED";
+        SINGLE_PAGE: "SINGLE_PAGE";
+        URL_LIST: "URL_LIST";
+        SITE_SECTION: "SITE_SECTION";
+        SITEMAP: "SITEMAP";
+    }>;
+    allowedOrigins: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    includePaths: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    excludePaths: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    urls: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    followPagination: z.ZodDefault<z.ZodBoolean>;
+    followDetailLinks: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strict>;
+export declare const tenantWebRequirementsSchema: z.ZodObject<{
+    instruction: z.ZodString;
+    fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodEnum<{
+            string: "string";
+            number: "number";
+            boolean: "boolean";
+            object: "object";
+            array: "array";
+        }>;
+        required: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strict>>>;
+    outputs: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        RAW: "RAW";
+        DOCUMENT: "DOCUMENT";
+        RECORDS: "RECORDS";
+    }>>>;
+    attachments: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+        PDF: "PDF";
+        IMAGE: "IMAGE";
+        AUDIO: "AUDIO";
+        VIDEO: "VIDEO";
+        OTHER: "OTHER";
+    }>>>;
+}, z.core.$strict>;
+export declare const tenantWebDefaultLimits: {
+    maxPages: number;
+    maxDepth: number;
+    maxResourceBytes: number;
+    maxTotalBytes: number;
+    maxRuntimeMs: number;
+    maxInteractions: number;
+    maxFiles: number;
+};
+export declare const tenantWebLimitsSchema: z.ZodObject<{
+    maxPages: z.ZodDefault<z.ZodNumber>;
+    maxDepth: z.ZodDefault<z.ZodNumber>;
+    maxResourceBytes: z.ZodDefault<z.ZodNumber>;
+    maxTotalBytes: z.ZodDefault<z.ZodNumber>;
+    maxRuntimeMs: z.ZodDefault<z.ZodNumber>;
+    maxInteractions: z.ZodDefault<z.ZodNumber>;
+    maxFiles: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strict>;
+export declare const tenantWebSpecSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    url: z.ZodString;
+    scope: z.ZodObject<{
+        mode: z.ZodEnum<{
+            FEED: "FEED";
+            SINGLE_PAGE: "SINGLE_PAGE";
+            URL_LIST: "URL_LIST";
+            SITE_SECTION: "SITE_SECTION";
+            SITEMAP: "SITEMAP";
+        }>;
+        allowedOrigins: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        includePaths: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        excludePaths: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        urls: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        followPagination: z.ZodDefault<z.ZodBoolean>;
+        followDetailLinks: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strict>;
+    requirements: z.ZodObject<{
+        instruction: z.ZodString;
+        fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            type: z.ZodEnum<{
+                string: "string";
+                number: "number";
+                boolean: "boolean";
+                object: "object";
+                array: "array";
+            }>;
+            required: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strict>>>;
+        outputs: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            RAW: "RAW";
+            DOCUMENT: "DOCUMENT";
+            RECORDS: "RECORDS";
+        }>>>;
+        attachments: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+            PDF: "PDF";
+            IMAGE: "IMAGE";
+            AUDIO: "AUDIO";
+            VIDEO: "VIDEO";
+            OTHER: "OTHER";
+        }>>>;
+    }, z.core.$strict>;
+    limits: z.ZodDefault<z.ZodObject<{
+        maxPages: z.ZodDefault<z.ZodNumber>;
+        maxDepth: z.ZodDefault<z.ZodNumber>;
+        maxResourceBytes: z.ZodDefault<z.ZodNumber>;
+        maxTotalBytes: z.ZodDefault<z.ZodNumber>;
+        maxRuntimeMs: z.ZodDefault<z.ZodNumber>;
+        maxInteractions: z.ZodDefault<z.ZodNumber>;
+        maxFiles: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$strict>>;
+    refresh: z.ZodDefault<z.ZodObject<{
+        mode: z.ZodLiteral<"ONCE">;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type TenantWebSpec = z.infer<typeof tenantWebSpecSchema>;
+export type TenantWebSpecInput = z.input<typeof tenantWebSpecSchema>;
+export declare function tenantWebCanonical(value: unknown): string;
+export declare function tenantWebSpecRevision(spec: TenantWebSpec): string;
+export declare function tenantWebRequestKey(requestId: string): string;
+export declare function tenantWebJobRef(tenantId: string, requestId: string): string;
+export declare const tenantWebJobRefSchema: z.ZodString;
+export declare const tenantWebIntentSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    tenantId: z.ZodString;
+    requestId: z.ZodString;
+    jobRef: z.ZodString;
+    inputRevision: z.ZodString;
+    specRevision: z.ZodString;
+    requestedSpec: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<1>;
+        url: z.ZodString;
+        scope: z.ZodObject<{
+            mode: z.ZodEnum<{
+                FEED: "FEED";
+                SINGLE_PAGE: "SINGLE_PAGE";
+                URL_LIST: "URL_LIST";
+                SITE_SECTION: "SITE_SECTION";
+                SITEMAP: "SITEMAP";
+            }>;
+            allowedOrigins: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            includePaths: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            excludePaths: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            urls: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            followPagination: z.ZodDefault<z.ZodBoolean>;
+            followDetailLinks: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strict>;
+        requirements: z.ZodObject<{
+            instruction: z.ZodString;
+            fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                type: z.ZodEnum<{
+                    string: "string";
+                    number: "number";
+                    boolean: "boolean";
+                    object: "object";
+                    array: "array";
+                }>;
+                required: z.ZodDefault<z.ZodBoolean>;
+            }, z.core.$strict>>>;
+            outputs: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+                RAW: "RAW";
+                DOCUMENT: "DOCUMENT";
+                RECORDS: "RECORDS";
+            }>>>;
+            attachments: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+                PDF: "PDF";
+                IMAGE: "IMAGE";
+                AUDIO: "AUDIO";
+                VIDEO: "VIDEO";
+                OTHER: "OTHER";
+            }>>>;
+        }, z.core.$strict>;
+        limits: z.ZodDefault<z.ZodObject<{
+            maxPages: z.ZodDefault<z.ZodNumber>;
+            maxDepth: z.ZodDefault<z.ZodNumber>;
+            maxResourceBytes: z.ZodDefault<z.ZodNumber>;
+            maxTotalBytes: z.ZodDefault<z.ZodNumber>;
+            maxRuntimeMs: z.ZodDefault<z.ZodNumber>;
+            maxInteractions: z.ZodDefault<z.ZodNumber>;
+            maxFiles: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strict>>;
+        refresh: z.ZodDefault<z.ZodObject<{
+            mode: z.ZodLiteral<"ONCE">;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    spec: z.ZodObject<{
+        schemaVersion: z.ZodLiteral<1>;
+        url: z.ZodString;
+        scope: z.ZodObject<{
+            mode: z.ZodEnum<{
+                FEED: "FEED";
+                SINGLE_PAGE: "SINGLE_PAGE";
+                URL_LIST: "URL_LIST";
+                SITE_SECTION: "SITE_SECTION";
+                SITEMAP: "SITEMAP";
+            }>;
+            allowedOrigins: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            includePaths: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            excludePaths: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            urls: z.ZodDefault<z.ZodArray<z.ZodString>>;
+            followPagination: z.ZodDefault<z.ZodBoolean>;
+            followDetailLinks: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$strict>;
+        requirements: z.ZodObject<{
+            instruction: z.ZodString;
+            fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                name: z.ZodString;
+                type: z.ZodEnum<{
+                    string: "string";
+                    number: "number";
+                    boolean: "boolean";
+                    object: "object";
+                    array: "array";
+                }>;
+                required: z.ZodDefault<z.ZodBoolean>;
+            }, z.core.$strict>>>;
+            outputs: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+                RAW: "RAW";
+                DOCUMENT: "DOCUMENT";
+                RECORDS: "RECORDS";
+            }>>>;
+            attachments: z.ZodDefault<z.ZodArray<z.ZodEnum<{
+                PDF: "PDF";
+                IMAGE: "IMAGE";
+                AUDIO: "AUDIO";
+                VIDEO: "VIDEO";
+                OTHER: "OTHER";
+            }>>>;
+        }, z.core.$strict>;
+        limits: z.ZodDefault<z.ZodObject<{
+            maxPages: z.ZodDefault<z.ZodNumber>;
+            maxDepth: z.ZodDefault<z.ZodNumber>;
+            maxResourceBytes: z.ZodDefault<z.ZodNumber>;
+            maxTotalBytes: z.ZodDefault<z.ZodNumber>;
+            maxRuntimeMs: z.ZodDefault<z.ZodNumber>;
+            maxInteractions: z.ZodDefault<z.ZodNumber>;
+            maxFiles: z.ZodDefault<z.ZodNumber>;
+        }, z.core.$strict>>;
+        refresh: z.ZodDefault<z.ZodObject<{
+            mode: z.ZodLiteral<"ONCE">;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+    actor: z.ZodObject<{
+        tenantId: z.ZodString;
+        userId: z.ZodString;
+        agentId: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strict>;
+    authority: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"HOST">;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"OAUTH">;
+        authorityVersion: z.ZodLiteral<2>;
+        clientId: z.ZodString;
+        grantId: z.ZodString;
+        resource: z.ZodString;
+    }, z.core.$strict>], "type">;
+    submittedAt: z.ZodISODateTime;
+}, z.core.$strict>;
+export type TenantWebIntent = z.infer<typeof tenantWebIntentSchema>;
+/** S1 仅证明意图持久化；不制造待采列表、原件、时效或准入成功。 */
+export declare const tenantWebSummarySchema: z.ZodObject<{
+    requestId: z.ZodString;
+    jobRef: z.ZodString;
+    specRevision: z.ZodString;
+    submittedAt: z.ZodISODateTime;
+    phase: z.ZodLiteral<"WEB_INTENT_PERSISTED">;
+    state: z.ZodLiteral<"ACCEPTED">;
+    execution: z.ZodLiteral<"UNAVAILABLE">;
+    reason: z.ZodLiteral<"S2_NOT_IMPLEMENTED">;
+    completion: z.ZodNull;
+    networkValidated: z.ZodLiteral<false>;
+    budgetReserved: z.ZodLiteral<false>;
+    requirementsState: z.ZodLiteral<"DECLARED_NOT_EVALUATED">;
+    coverage: z.ZodObject<{
+        state: z.ZodLiteral<"NOT_STARTED">;
+        total: z.ZodNull;
+        discovered: z.ZodLiteral<0>;
+        acquired: z.ZodLiteral<0>;
+        extracted: z.ZodLiteral<0>;
+        registered: z.ZodLiteral<0>;
+    }, z.core.$strict>;
+}, z.core.$strict>;

package/dist/types/contracts/tenant-web-content-plan.d.ts

@@ -0,0 +1,86 @@
+import { z } from 'zod';
+import { tenantWebRequirementsSchema } from './tenant-web-collection.js';
+export declare const TENANT_WEB_CONTENT_CAPABILITY = "TENANT_WEB_CONTENT_V1";
+export declare const TENANT_WEB_CONTENT_EXTRACTOR: {
+    readonly id: "native-knowledge.web-content";
+    readonly version: "1.0.0";
+};
+export declare const tenantWebContentSelectorSchema: z.ZodString;
+export declare const tenantWebContentPlanSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    compiler: z.ZodEnum<{
+        CALLER_PLAN_V1: "CALLER_PLAN_V1";
+        BOUNDED_LANGUAGE_V1: "BOUNDED_LANGUAGE_V1";
+    }>;
+    extractor: z.ZodObject<{
+        id: z.ZodLiteral<"native-knowledge.web-content">;
+        version: z.ZodLiteral<"1.0.0">;
+    }, z.core.$strict>;
+    body: z.ZodBoolean;
+    tables: z.ZodBoolean;
+    links: z.ZodBoolean;
+    recordSelector: z.ZodNullable<z.ZodString>;
+    fields: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        selector: z.ZodString;
+        value: z.ZodDefault<z.ZodEnum<{
+            TEXT: "TEXT";
+            JSON: "JSON";
+            ATTRIBUTE: "ATTRIBUTE";
+        }>>;
+        attribute: z.ZodDefault<z.ZodNullable<z.ZodEnum<{
+            datetime: "datetime";
+            value: "value";
+            title: "title";
+            href: "href";
+            alt: "alt";
+            content: "content";
+            src: "src";
+        }>>>;
+        type: z.ZodEnum<{
+            string: "string";
+            number: "number";
+            boolean: "boolean";
+            object: "object";
+            array: "array";
+        }>;
+        required: z.ZodDefault<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    maxRecords: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strict>;
+export type TenantWebContentPlan = z.infer<typeof tenantWebContentPlanSchema>;
+export declare const tenantWebContentInputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    mode: z.ZodLiteral<"NATURAL_LANGUAGE">;
+}, z.core.$strict>, z.ZodObject<{
+    mode: z.ZodLiteral<"COMPILED">;
+    extractor: z.ZodDefault<z.ZodObject<{
+        id: z.ZodLiteral<"native-knowledge.web-content">;
+        version: z.ZodLiteral<"1.0.0">;
+    }, z.core.$strict>>;
+    body: z.ZodDefault<z.ZodBoolean>;
+    tables: z.ZodDefault<z.ZodBoolean>;
+    links: z.ZodDefault<z.ZodBoolean>;
+    recordSelector: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    fields: z.ZodDefault<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        selector: z.ZodString;
+        value: z.ZodDefault<z.ZodEnum<{
+            TEXT: "TEXT";
+            JSON: "JSON";
+            ATTRIBUTE: "ATTRIBUTE";
+        }>>;
+        attribute: z.ZodDefault<z.ZodNullable<z.ZodEnum<{
+            datetime: "datetime";
+            value: "value";
+            title: "title";
+            href: "href";
+            alt: "alt";
+            content: "content";
+            src: "src";
+        }>>>;
+    }, z.core.$strict>>>;
+    maxRecords: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strict>], "mode">;
+export type TenantWebContentInput = z.input<typeof tenantWebContentInputSchema>;
+export declare function compileTenantWebContent(requirements: z.infer<typeof tenantWebRequirementsSchema>, raw: unknown): TenantWebContentPlan;
+export declare const tenantWebContentRevision: (plan: TenantWebContentPlan) => string;

package/dist/types/contracts/tenant-web-content-result.d.ts

@@ -0,0 +1,63 @@
+import { z } from 'zod';
+export declare const TENANT_WEB_CONTENT_MEDIA_TYPE = "application/vnd.knowledge-v2.tenant-web-content+json";
+export declare const tenantWebContentDocumentSchema: z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    format: z.ZodLiteral<"TENANT_WEB_CONTENT_V1">;
+    tenantId: z.ZodString;
+    jobRef: z.ZodString;
+    planRevision: z.ZodString;
+    extractor: z.ZodObject<{
+        id: z.ZodLiteral<"native-knowledge.web-content">;
+        version: z.ZodLiteral<"1.0.0">;
+    }, z.core.$strict>;
+    dependencies: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        version: z.ZodString;
+    }, z.core.$strict>>;
+    propagation: z.ZodLiteral<"TENANT_ONLY">;
+    reviewState: z.ZodLiteral<"UNREVIEWED">;
+    parentEvidenceRef: z.ZodString;
+    sourceContentHash: z.ZodString;
+    sourceByteLength: z.ZodNumber;
+    sourceMediaType: z.ZodString;
+    sourceUri: z.ZodString;
+    observedAt: z.ZodISODateTime;
+    extractedAt: z.ZodISODateTime;
+    outputs: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        state: z.ZodEnum<{
+            MISSING: "MISSING";
+            UNSUPPORTED: "UNSUPPORTED";
+            PRESENT: "PRESENT";
+        }>;
+        value: z.ZodNullable<z.ZodJSONSchema>;
+        citations: z.ZodArray<z.ZodObject<{
+            evidenceRef: z.ZodString;
+            contentHash: z.ZodString;
+            locator: z.ZodString;
+            excerpt: z.ZodString;
+        }, z.core.$strict>>;
+        reason: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+    records: z.ZodArray<z.ZodObject<{
+        ordinal: z.ZodNumber;
+        fields: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            state: z.ZodEnum<{
+                MISSING: "MISSING";
+                UNSUPPORTED: "UNSUPPORTED";
+                PRESENT: "PRESENT";
+            }>;
+            value: z.ZodNullable<z.ZodJSONSchema>;
+            citations: z.ZodArray<z.ZodObject<{
+                evidenceRef: z.ZodString;
+                contentHash: z.ZodString;
+                locator: z.ZodString;
+                excerpt: z.ZodString;
+            }, z.core.$strict>>;
+            reason: z.ZodNullable<z.ZodString>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+    gaps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+export type TenantWebContentDocument = z.infer<typeof tenantWebContentDocumentSchema>;