okf-search-native 0.2.0 → 0.3.3

package/dist/index.d.cts

@@ -0,0 +1,156 @@
+type IsoDateTime = string;
+type OkfStatus = "draft" | "stable" | "deprecated";
+type OkfTrustTier = "unverified" | "machine-confirmed" | "human-reviewed";
+interface OkfTimeWindow {
+    from: IsoDateTime;
+    to: IsoDateTime;
+}
+interface OkfSource {
+    id?: string;
+    resource: string;
+    title?: string;
+    author?: string;
+    usageCount?: number;
+    lastModified?: IsoDateTime;
+    usageWindow?: OkfTimeWindow;
+}
+interface OkfGeneration {
+    by: string;
+    at?: IsoDateTime;
+}
+interface OkfVerification {
+    by: string;
+    at: IsoDateTime;
+}
+interface OkfParameter {
+    name: string;
+    type: string;
+    required: boolean;
+}
+interface OkfExecutor {
+    resource: string;
+    receipt: string[];
+}
+interface OkfAttester {
+    resource: string;
+}
+interface OkfDocument {
+    id: string;
+    type: string;
+    title: string;
+    description?: string;
+    resource?: string;
+    tags: string[];
+    sources: OkfSource[];
+    usageWindow?: OkfTimeWindow;
+    generated?: OkfGeneration;
+    verified: OkfVerification[];
+    status: OkfStatus;
+    staleAfter?: IsoDateTime;
+    runtime?: string;
+    parameters?: OkfParameter[];
+    computation?: string;
+    executor?: OkfExecutor;
+    attester?: OkfAttester;
+    body: string;
+    extensions: Record<string, unknown>;
+}
+interface OkfDocumentInput {
+    /**
+     * Relative POSIX identity. Empty and `.` segments normalize away;
+     * case and `\\` remain significant.
+     */
+    path: string;
+    markdown: string;
+}
+type OkfDiagnosticCode = "ERR_OKF_PARSE" | "ERR_OKF_FIELD";
+type OkfErrorCode = "ERR_OKF_READ" | "ERR_OKF_PARSE" | "ERR_OKF_FIELD" | "ERR_OKF_INDEX_UNUSABLE" | "ERR_OKF_UNSUPPORTED";
+interface OkfDiagnostic {
+    code: OkfDiagnosticCode;
+    path: string;
+    field?: string;
+    message: string;
+}
+type OkfValidationResult = {
+    readonly isValid: true;
+    readonly isIndexable: true;
+    readonly errors: readonly [];
+} | {
+    readonly isValid: false;
+    readonly isIndexable: true;
+    readonly errors: readonly [OkfDiagnostic, ...OkfDiagnostic[]];
+} | {
+    readonly isValid: false;
+    readonly isIndexable: false;
+    readonly errors: readonly [OkfDiagnostic, ...OkfDiagnostic[]];
+};
+interface OkfDegradedDocument {
+    readonly documentId: string;
+    readonly path: string;
+    readonly diagnostics: readonly [OkfDiagnostic, ...OkfDiagnostic[]];
+}
+type OkfConformance = "strict" | "degraded";
+type OkfIngestResult = {
+    readonly conformance: "strict";
+    readonly document: OkfDocument;
+} | ({
+    readonly conformance: "degraded";
+} & OkfDegradedDocument);
+type OkfSearchField = "resource" | "title" | "heading" | "description" | "tags" | "type" | "sources" | "body";
+interface OkfSearchOptions {
+    limit?: number;
+    where?: {
+        types?: readonly string[];
+        tagsAny?: readonly string[];
+        statuses?: readonly OkfStatus[];
+        trustTiers?: readonly OkfTrustTier[];
+        stale?: boolean;
+        conformance?: readonly OkfConformance[];
+    };
+    asOf?: Date;
+    match?: "any" | "all";
+    fields?: readonly OkfSearchField[];
+    boost?: Readonly<Partial<Record<OkfSearchField, number>>>;
+    fuzzy?: boolean | number;
+}
+interface OkfSearchHit {
+    documentId: string;
+    title: string;
+    sectionId: string;
+    score: number;
+    conformance: OkfConformance;
+    matchedFields: OkfSearchField[];
+    headingPath: string;
+    path: string;
+    startLine: number;
+    endLine: number;
+    snippet: string;
+}
+interface OkfSearch {
+    ingest(input: OkfDocumentInput): OkfIngestResult;
+    listDegradedDocuments(): readonly OkfDegradedDocument[];
+    listTypes(): readonly string[];
+    remove(path: string): boolean;
+    search(query: string, options?: OkfSearchOptions): OkfSearchHit[];
+    autoSuggest(query: string, options?: OkfSearchOptions): never;
+}
+
+declare function createOkfSearch(documents: readonly OkfDocumentInput[]): OkfSearch;
+
+interface OkfErrorOptions {
+    readonly field?: string;
+    readonly cause?: unknown;
+}
+declare class OkfError extends Error {
+    readonly code: OkfErrorCode;
+    readonly path: string;
+    readonly field?: string;
+    constructor(code: OkfErrorCode, path: string, options?: OkfErrorOptions);
+}
+
+declare function openOkf(root: string): Promise<OkfSearch>;
+
+declare function validateOkfDocument(input: OkfDocumentInput): OkfValidationResult;
+
+export { OkfError, createOkfSearch, openOkf, validateOkfDocument };
+export type { IsoDateTime, OkfAttester, OkfConformance, OkfDegradedDocument, OkfDiagnostic, OkfDiagnosticCode, OkfDocument, OkfDocumentInput, OkfErrorCode, OkfExecutor, OkfGeneration, OkfIngestResult, OkfParameter, OkfSearch, OkfSearchField, OkfSearchHit, OkfSearchOptions, OkfSource, OkfStatus, OkfTimeWindow, OkfTrustTier, OkfValidationResult, OkfVerification };

package/dist/index.d.mts

@@ -0,0 +1,156 @@
+type IsoDateTime = string;
+type OkfStatus = "draft" | "stable" | "deprecated";
+type OkfTrustTier = "unverified" | "machine-confirmed" | "human-reviewed";
+interface OkfTimeWindow {
+    from: IsoDateTime;
+    to: IsoDateTime;
+}
+interface OkfSource {
+    id?: string;
+    resource: string;
+    title?: string;
+    author?: string;
+    usageCount?: number;
+    lastModified?: IsoDateTime;
+    usageWindow?: OkfTimeWindow;
+}
+interface OkfGeneration {
+    by: string;
+    at?: IsoDateTime;
+}
+interface OkfVerification {
+    by: string;
+    at: IsoDateTime;
+}
+interface OkfParameter {
+    name: string;
+    type: string;
+    required: boolean;
+}
+interface OkfExecutor {
+    resource: string;
+    receipt: string[];
+}
+interface OkfAttester {
+    resource: string;
+}
+interface OkfDocument {
+    id: string;
+    type: string;
+    title: string;
+    description?: string;
+    resource?: string;
+    tags: string[];
+    sources: OkfSource[];
+    usageWindow?: OkfTimeWindow;
+    generated?: OkfGeneration;
+    verified: OkfVerification[];
+    status: OkfStatus;
+    staleAfter?: IsoDateTime;
+    runtime?: string;
+    parameters?: OkfParameter[];
+    computation?: string;
+    executor?: OkfExecutor;
+    attester?: OkfAttester;
+    body: string;
+    extensions: Record<string, unknown>;
+}
+interface OkfDocumentInput {
+    /**
+     * Relative POSIX identity. Empty and `.` segments normalize away;
+     * case and `\\` remain significant.
+     */
+    path: string;
+    markdown: string;
+}
+type OkfDiagnosticCode = "ERR_OKF_PARSE" | "ERR_OKF_FIELD";
+type OkfErrorCode = "ERR_OKF_READ" | "ERR_OKF_PARSE" | "ERR_OKF_FIELD" | "ERR_OKF_INDEX_UNUSABLE" | "ERR_OKF_UNSUPPORTED";
+interface OkfDiagnostic {
+    code: OkfDiagnosticCode;
+    path: string;
+    field?: string;
+    message: string;
+}
+type OkfValidationResult = {
+    readonly isValid: true;
+    readonly isIndexable: true;
+    readonly errors: readonly [];
+} | {
+    readonly isValid: false;
+    readonly isIndexable: true;
+    readonly errors: readonly [OkfDiagnostic, ...OkfDiagnostic[]];
+} | {
+    readonly isValid: false;
+    readonly isIndexable: false;
+    readonly errors: readonly [OkfDiagnostic, ...OkfDiagnostic[]];
+};
+interface OkfDegradedDocument {
+    readonly documentId: string;
+    readonly path: string;
+    readonly diagnostics: readonly [OkfDiagnostic, ...OkfDiagnostic[]];
+}
+type OkfConformance = "strict" | "degraded";
+type OkfIngestResult = {
+    readonly conformance: "strict";
+    readonly document: OkfDocument;
+} | ({
+    readonly conformance: "degraded";
+} & OkfDegradedDocument);
+type OkfSearchField = "resource" | "title" | "heading" | "description" | "tags" | "type" | "sources" | "body";
+interface OkfSearchOptions {
+    limit?: number;
+    where?: {
+        types?: readonly string[];
+        tagsAny?: readonly string[];
+        statuses?: readonly OkfStatus[];
+        trustTiers?: readonly OkfTrustTier[];
+        stale?: boolean;
+        conformance?: readonly OkfConformance[];
+    };
+    asOf?: Date;
+    match?: "any" | "all";
+    fields?: readonly OkfSearchField[];
+    boost?: Readonly<Partial<Record<OkfSearchField, number>>>;
+    fuzzy?: boolean | number;
+}
+interface OkfSearchHit {
+    documentId: string;
+    title: string;
+    sectionId: string;
+    score: number;
+    conformance: OkfConformance;
+    matchedFields: OkfSearchField[];
+    headingPath: string;
+    path: string;
+    startLine: number;
+    endLine: number;
+    snippet: string;
+}
+interface OkfSearch {
+    ingest(input: OkfDocumentInput): OkfIngestResult;
+    listDegradedDocuments(): readonly OkfDegradedDocument[];
+    listTypes(): readonly string[];
+    remove(path: string): boolean;
+    search(query: string, options?: OkfSearchOptions): OkfSearchHit[];
+    autoSuggest(query: string, options?: OkfSearchOptions): never;
+}
+
+declare function createOkfSearch(documents: readonly OkfDocumentInput[]): OkfSearch;
+
+interface OkfErrorOptions {
+    readonly field?: string;
+    readonly cause?: unknown;
+}
+declare class OkfError extends Error {
+    readonly code: OkfErrorCode;
+    readonly path: string;
+    readonly field?: string;
+    constructor(code: OkfErrorCode, path: string, options?: OkfErrorOptions);
+}
+
+declare function openOkf(root: string): Promise<OkfSearch>;
+
+declare function validateOkfDocument(input: OkfDocumentInput): OkfValidationResult;
+
+export { OkfError, createOkfSearch, openOkf, validateOkfDocument };
+export type { IsoDateTime, OkfAttester, OkfConformance, OkfDegradedDocument, OkfDiagnostic, OkfDiagnosticCode, OkfDocument, OkfDocumentInput, OkfErrorCode, OkfExecutor, OkfGeneration, OkfIngestResult, OkfParameter, OkfSearch, OkfSearchField, OkfSearchHit, OkfSearchOptions, OkfSource, OkfStatus, OkfTimeWindow, OkfTrustTier, OkfValidationResult, OkfVerification };

package/dist/index.d.ts

@@ -0,0 +1,156 @@
+type IsoDateTime = string;
+type OkfStatus = "draft" | "stable" | "deprecated";
+type OkfTrustTier = "unverified" | "machine-confirmed" | "human-reviewed";
+interface OkfTimeWindow {
+    from: IsoDateTime;
+    to: IsoDateTime;
+}
+interface OkfSource {
+    id?: string;
+    resource: string;
+    title?: string;
+    author?: string;
+    usageCount?: number;
+    lastModified?: IsoDateTime;
+    usageWindow?: OkfTimeWindow;
+}
+interface OkfGeneration {
+    by: string;
+    at?: IsoDateTime;
+}
+interface OkfVerification {
+    by: string;
+    at: IsoDateTime;
+}
+interface OkfParameter {
+    name: string;
+    type: string;
+    required: boolean;
+}
+interface OkfExecutor {
+    resource: string;
+    receipt: string[];
+}
+interface OkfAttester {
+    resource: string;
+}
+interface OkfDocument {
+    id: string;
+    type: string;
+    title: string;
+    description?: string;
+    resource?: string;
+    tags: string[];
+    sources: OkfSource[];
+    usageWindow?: OkfTimeWindow;
+    generated?: OkfGeneration;
+    verified: OkfVerification[];
+    status: OkfStatus;
+    staleAfter?: IsoDateTime;
+    runtime?: string;
+    parameters?: OkfParameter[];
+    computation?: string;
+    executor?: OkfExecutor;
+    attester?: OkfAttester;
+    body: string;
+    extensions: Record<string, unknown>;
+}
+interface OkfDocumentInput {
+    /**
+     * Relative POSIX identity. Empty and `.` segments normalize away;
+     * case and `\\` remain significant.
+     */
+    path: string;
+    markdown: string;
+}
+type OkfDiagnosticCode = "ERR_OKF_PARSE" | "ERR_OKF_FIELD";
+type OkfErrorCode = "ERR_OKF_READ" | "ERR_OKF_PARSE" | "ERR_OKF_FIELD" | "ERR_OKF_INDEX_UNUSABLE" | "ERR_OKF_UNSUPPORTED";
+interface OkfDiagnostic {
+    code: OkfDiagnosticCode;
+    path: string;
+    field?: string;
+    message: string;
+}
+type OkfValidationResult = {
+    readonly isValid: true;
+    readonly isIndexable: true;
+    readonly errors: readonly [];
+} | {
+    readonly isValid: false;
+    readonly isIndexable: true;
+    readonly errors: readonly [OkfDiagnostic, ...OkfDiagnostic[]];
+} | {
+    readonly isValid: false;
+    readonly isIndexable: false;
+    readonly errors: readonly [OkfDiagnostic, ...OkfDiagnostic[]];
+};
+interface OkfDegradedDocument {
+    readonly documentId: string;
+    readonly path: string;
+    readonly diagnostics: readonly [OkfDiagnostic, ...OkfDiagnostic[]];
+}
+type OkfConformance = "strict" | "degraded";
+type OkfIngestResult = {
+    readonly conformance: "strict";
+    readonly document: OkfDocument;
+} | ({
+    readonly conformance: "degraded";
+} & OkfDegradedDocument);
+type OkfSearchField = "resource" | "title" | "heading" | "description" | "tags" | "type" | "sources" | "body";
+interface OkfSearchOptions {
+    limit?: number;
+    where?: {
+        types?: readonly string[];
+        tagsAny?: readonly string[];
+        statuses?: readonly OkfStatus[];
+        trustTiers?: readonly OkfTrustTier[];
+        stale?: boolean;
+        conformance?: readonly OkfConformance[];
+    };
+    asOf?: Date;
+    match?: "any" | "all";
+    fields?: readonly OkfSearchField[];
+    boost?: Readonly<Partial<Record<OkfSearchField, number>>>;
+    fuzzy?: boolean | number;
+}
+interface OkfSearchHit {
+    documentId: string;
+    title: string;
+    sectionId: string;
+    score: number;
+    conformance: OkfConformance;
+    matchedFields: OkfSearchField[];
+    headingPath: string;
+    path: string;
+    startLine: number;
+    endLine: number;
+    snippet: string;
+}
+interface OkfSearch {
+    ingest(input: OkfDocumentInput): OkfIngestResult;
+    listDegradedDocuments(): readonly OkfDegradedDocument[];
+    listTypes(): readonly string[];
+    remove(path: string): boolean;
+    search(query: string, options?: OkfSearchOptions): OkfSearchHit[];
+    autoSuggest(query: string, options?: OkfSearchOptions): never;
+}
+
+declare function createOkfSearch(documents: readonly OkfDocumentInput[]): OkfSearch;
+
+interface OkfErrorOptions {
+    readonly field?: string;
+    readonly cause?: unknown;
+}
+declare class OkfError extends Error {
+    readonly code: OkfErrorCode;
+    readonly path: string;
+    readonly field?: string;
+    constructor(code: OkfErrorCode, path: string, options?: OkfErrorOptions);
+}
+
+declare function openOkf(root: string): Promise<OkfSearch>;
+
+declare function validateOkfDocument(input: OkfDocumentInput): OkfValidationResult;
+
+export { OkfError, createOkfSearch, openOkf, validateOkfDocument };
+export type { IsoDateTime, OkfAttester, OkfConformance, OkfDegradedDocument, OkfDiagnostic, OkfDiagnosticCode, OkfDocument, OkfDocumentInput, OkfErrorCode, OkfExecutor, OkfGeneration, OkfIngestResult, OkfParameter, OkfSearch, OkfSearchField, OkfSearchHit, OkfSearchOptions, OkfSource, OkfStatus, OkfTimeWindow, OkfTrustTier, OkfValidationResult, OkfVerification };