@oddington/sdk 0.1.4 → 0.1.6

package/dist/types/packages/sdk/src/public.d.ts

@@ -13,16 +13,22 @@ export { AirtableOperationError } from '../../../shared/airtable-contract.js';
 export type { AirtableField, AirtableTable, AirtableRecord, AirtableListInput, AirtableGetInput, AirtableCreateInput, AirtableUpdateInput, AirtableDeleteInput, AirtableReceipt, AirtableWriteResult, AirtableClient, Connections } from '../../../shared/airtable-contract.js';
 export declare const connections: import('../../../shared/airtable-contract.js').Connections;
 export { DataOperationError } from '../../../shared/data-contract.js';
-export type { DataRepository, DataErrorCode, PublicValueDefinition, PublicField, CollectionSummary, CollectionSchema, QueryScalar, SelectionOptions, RecordSelection, RecordsQuery, DataValue, SelectedRecord, SelectionMetadata, RecordsResult, RecordIdentity, RecordUpdateSet, DataPublication, DataChangeSet, DataEffect } from '../../../shared/data-contract.js';
+export type { DataRepository, DataErrorCode, PublicValueDefinition, PublicField, CollectionSummary, CollectionSchema, QueryScalar, SelectionOptions, RecordSelection, RecordsQuery, DataValue, SelectedRecord, SelectionMetadata, RecordsResult, RecordsSearchOptions, RecordsSearchResult, RecordIdentity, RecordCreation, RecordUpdateSet, DataPublication, DataChangeSet, DataEffect } from '../../../shared/data-contract.js';
 export declare const data: {
     repository(name: string): import('../../../shared/data-contract.js').DataRepository;
 };
 export { FileOperationError } from '../../../shared/files-contract.js';
-export type { File, FileInput, FileStorage, FileCreateInput, FileCreateOptions, FileErrorCode } from '../../../shared/files-contract.js';
+export type { File, FileInput, FileStorage, FileCreateInput, FileCreateOptions, FileEnrichment, FileEnrichOptions, FileEnrichResult, FileErrorCode } from '../../../shared/files-contract.js';
 export declare const files: {
     create(input: import('../../../shared/files-contract.js').FileCreateInput, options?: import('../../../shared/files-contract.js').FileCreateOptions): Promise<import('../../../shared/files-contract.js').File>;
     get(id: string): Promise<import('../../../shared/files-contract.js').File>;
+    upload(id: string): Promise<import('../../../shared/files-contract.js').File>;
+    enrich(input: import('../../../shared/files-contract.js').FileEnrichOptions): Promise<import('../../../shared/files-contract.js').FileEnrichResult>;
     read(id: string): Promise<Response>;
+    read(id: string, name: string): Promise<Response>;
+    read<const Names extends readonly string[]>(id: string, names: Names): Promise<{
+        [Name in Names[number]]: Response;
+    }>;
 };
 /** The host's existing refreshing session source; supplies identity, never membership. */
 export type HostedSessionSource = {

package/dist/types/shared/data-contract.d.ts

@@ -107,15 +107,37 @@ export type RecordsResult = {
     [collection: string]: SelectedRecord[] | SelectionMetadata;
 };
 export type RecordIdentity = Pick<SelectedRecord, '$ref' | '$version'>;
+export type RecordsSearchOptions = {
+    collections?: string[];
+    limit?: number;
+};
+export type RecordsSearchResult = {
+    $meta: {
+        version: string;
+    };
+    matches: Array<{
+        collection: string;
+        record: SelectedRecord;
+    }>;
+};
 export type RecordUpdateSet = Record<string, DataValue>;
+export type RecordCreation = {
+    $ref: string;
+    $filing?: Record<string, string>;
+    $version?: never;
+    $path?: never;
+    [field: string]: DataValue | undefined;
+};
 export type DataPublication = {
     version: string;
-    created: [];
+    created: RecordIdentity[];
     updated: RecordIdentity[];
-    deleted: [];
+    deleted: RecordIdentity[];
 };
 export interface DataChangeSet {
+    create(record: RecordCreation): void;
     update(record: RecordIdentity, set: RecordUpdateSet): void;
+    delete(record: RecordIdentity): void;
     validate(): Promise<void>;
     publish(): Promise<DataPublication>;
 }
@@ -126,6 +148,7 @@ export interface DataRepository {
     };
     records: {
         select(query: RecordsQuery): Promise<RecordsResult>;
+        search(query: string, options?: RecordsSearchOptions): Promise<RecordsSearchResult>;
     };
     changes(): DataChangeSet;
 }
@@ -135,6 +158,7 @@ export declare class DataOperationError extends Error {
     readonly code: DataErrorCode;
     readonly retryable: boolean;
     readonly effect?: DataEffect | undefined;
-    constructor(code: DataErrorCode, retryable?: boolean, effect?: DataEffect | undefined);
+    readonly component?: string | undefined;
+    constructor(code: DataErrorCode, retryable?: boolean, effect?: DataEffect | undefined, component?: string | undefined);
 }
 export {};

package/dist/types/shared/files-contract.d.ts

@@ -1,5 +1,5 @@
 /** Provider-neutral authored contract. Registries and object locations stay server-side. */
-export type FileStorage = 'local' | 'remote' | 'both';
+export type FileStorage = 'local' | 'remote';
 export type FileInput = Blob | Uint8Array | ReadableStream<Uint8Array>;
 export type FileCsvHints = {
     encoding?: 'utf-8' | 'windows-1252';
@@ -17,6 +17,21 @@ export type FileCreateInput = {
 export type FileCreateOptions = {
     requestKey?: string;
 };
+export type FileEnrichment = {
+    mediaType: string;
+    size: number;
+    sha256: string;
+};
+export type FileEnrichOptions = {
+    file: string;
+    name: string;
+    content: string | Uint8Array;
+    mediaType?: string;
+    replace?: string;
+};
+export type FileEnrichResult = FileEnrichment & {
+    name: string;
+};
 export type File = {
     id: string;
     name: string;
@@ -24,11 +39,7 @@ export type File = {
     mediaType: string;
     size: number;
     sha256: string;
-    enrichments: Record<string, {
-        mediaType: string;
-        size: number;
-        sha256: string;
-    }>;
+    enrichments: Record<string, FileEnrichment>;
     details: {
         kind: 'csv';
         encoding: 'utf-8' | 'windows-1252';
@@ -42,7 +53,7 @@ export type File = {
         kind: 'other';
     };
 };
-export type FileErrorCode = 'invalid_input' | 'unsupported_context' | 'unauthenticated' | 'access_denied' | 'request_too_large' | 'conflict' | 'integrity' | 'unavailable' | 'capacity' | 'method_not_allowed';
+export type FileErrorCode = 'invalid_input' | 'unsupported_context' | 'unauthenticated' | 'access_denied' | 'request_too_large' | 'conflict' | 'local_only' | 'integrity' | 'unavailable' | 'capacity' | 'method_not_allowed';
 export declare class FileOperationError extends Error {
     readonly code: FileErrorCode;
     readonly status: number;
@@ -52,13 +63,22 @@ export declare class FileOperationError extends Error {
 export declare const FILE_ID_PATTERN: RegExp;
 /** Treat descriptor transport as untrusted; no provider fields escape the boundary. */
 export declare function parseFileDescriptor(value: unknown): File;
+export declare function parseEnrichmentDescriptor(value: unknown): FileEnrichment;
+export declare function safeEnrichmentName(value: unknown): value is string;
+export type FileEnrichMetadata = {
+    name: string;
+    size: number;
+    mediaType?: string;
+    replace?: string;
+};
+export declare function parseFileEnrichMetadata(value: unknown, maxBytes: number): FileEnrichMetadata;
 export declare function safeFileName(value: unknown): value is string;
 export declare function safeFilePath(value: unknown): value is string;
 /** Private transport metadata: normalized material options exclude the request key and size declaration. */
 export type FileCreateMetadata = {
     name: string;
     path: string;
-    storage: 'remote';
+    storage?: FileStorage;
     csv?: Required<FileCsvHints>;
     size: number;
     requestKey: string;

package/dist/types/shared/record-write.d.ts

@@ -12,7 +12,11 @@ export type RecordDeleteRequest = {
     repository: string;
     records: RecordDelete[];
 };
-export type RecordChangeRequest = RecordWriteRequest | RecordDeleteRequest;
+export type RecordChange = RecordWrite | RecordDelete;
+export type RecordChangeRequest = {
+    repository: string;
+    records: RecordChange[];
+};
 export type RoutineRecordWriteRequest = {
     input: RecordChangeRequest;
     requestKey: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oddington/sdk",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Oddington routine and response-handler SDK",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",