@oddington/sdk 0.1.12 → 0.1.14

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

@@ -22,6 +22,10 @@ export declare const data: {
     repository(name: string): import('../../../shared/data-contract.js').DataRepository;
 };
 export { FileOperationError } from '../../../shared/files-contract.js';
+export { InboxOperationError } from '../../../shared/inbox-member-contract.js';
+export type { InboxMember, InboxCurrent, QuestionItemSnapshot, QuestionSnapshot, ResponseConsequence, LinkedAskSnapshot, AskUpdate, DigestReadConfirmation, RecipientCandidate, RecipientAddition, ResponseAcceptance, InboxAnswerInput, InboxSearchInput } from '../../../shared/inbox-member-types.js';
+export type { RecordSelectionResult } from '../../../shared/record-selection.js';
+export declare const inbox: import('../../../shared/inbox-member-types.js').InboxMember;
 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>;

package/dist/types/shared/inbox-member-contract.d.ts

@@ -0,0 +1,19 @@
+import type { InboxCurrent, QuestionItemSnapshot, ResponseAcceptance } from './inbox-member-types.js';
+export declare class InboxOperationError extends Error {
+    readonly status: number;
+    readonly reason: 'invalid_input' | 'access_denied' | 'authority_unavailable' | 'conflict' | 'unavailable';
+    constructor(status: number, reason: 'invalid_input' | 'access_denied' | 'authority_unavailable' | 'conflict' | 'unavailable');
+}
+export declare const INBOX_RESULT_BYTES: number;
+export declare const INBOX_INPUT_BYTES = 8192;
+export declare const INBOX_UUID: RegExp;
+export type InboxOperation = 'current' | 'items.list' | 'items.read' | 'items.see' | 'items.markDigestRead' | 'items.rename' | 'items.setLifecycle' | 'items.listRecipientCandidates' | 'items.addRecipient' | 'questions.answer' | 'questions.searchRecords' | 'files.read';
+/** Closed wire vocabulary, shared by the SDK and its owning Worker. */
+export declare function parseInboxRequest(value: unknown): {
+    operation: InboxOperation;
+    input: Record<string, unknown>;
+};
+export declare function parseInboxCurrent(value: unknown): InboxCurrent;
+export declare function parseInboxItem(value: unknown): QuestionItemSnapshot;
+export declare function parseInboxAcceptance(value: unknown): ResponseAcceptance;
+export declare function parseInboxResult(operation: InboxOperation, value: unknown): unknown;

package/dist/types/shared/inbox-member-types.d.ts

@@ -0,0 +1,174 @@
+import type { InboxBlock, QuestionResponse, ResponseDefinition, RepositoryReceipt, RecordReference } from './inbox-contract.js';
+import type { ResolvedView } from './inbox-views.js';
+import type { RecordSelectionResult } from './record-selection.js';
+export interface InboxCurrent {
+    workspace: {
+        id: string;
+        slug: string;
+        name: string;
+        locale: string;
+        timezone: string;
+    };
+    viewer: {
+        id: string;
+        name: string;
+        email: string;
+    };
+}
+export interface ResponseConsequence {
+    state: 'pending' | 'running' | 'applied' | 'no-write' | 'stopped' | 'partial' | 'uncertain';
+    phase: 'loading' | 'invoking' | 'committing' | null;
+    updatedAt: string;
+    evidence: RepositoryReceipt[];
+    needsReconciliation: boolean;
+    reason: string | null;
+}
+export interface QuestionSnapshot {
+    id: string;
+    to: string;
+    prompt: string;
+    instructions: string | null;
+    response: ResponseDefinition;
+    allowedResponders: string[];
+    available: boolean;
+    acceptedResponse: {
+        id: string;
+        userId: string;
+        response: QuestionResponse;
+        acceptedAt: string;
+        label?: string;
+        acceptanceOrder?: number;
+    } | null;
+    execution: {
+        id: string;
+        state: 'pending' | 'running' | 'completed' | 'failed';
+        attempt: number;
+        consequence?: ResponseConsequence;
+    } | null;
+}
+export type LinkedAskSnapshot = {
+    id: string;
+    title: string;
+    state: 'yours' | 'done' | 'open';
+} | {
+    id: string;
+    title: string;
+    state: 'theirs';
+    assignee: {
+        id: string;
+        name: string;
+    };
+} | {
+    id: string;
+    state: 'unavailable';
+    done: boolean;
+};
+export interface QuestionItemSnapshot {
+    id: string;
+    workspaceId: string;
+    number: number;
+    kind: 'ask' | 'digest';
+    title: string;
+    description: string;
+    author: string;
+    revision: number;
+    publishedAt: string;
+    outcome: {
+        outcome: string;
+    } | null;
+    seenAt: string | null;
+    digestReadAt: string | null;
+    lifecycle: 'open' | 'closed';
+    activityVersion: number;
+    views: ResolvedView[];
+    body: InboxBlock[];
+    linkedAsks: LinkedAskSnapshot[];
+    questions: QuestionSnapshot[];
+    people: {
+        id: string;
+        name: string;
+    }[];
+    activity: {
+        id: number;
+        type: string;
+        actorId: string | null;
+        questionId: string | null;
+        revision: number;
+        createdAt: string;
+        data: Record<string, unknown>;
+    }[];
+    work: {
+        id: string;
+        questionId: string;
+        reason: string;
+        settledAt: string | null;
+    }[];
+}
+export interface DigestReadConfirmation {
+    readAt: string;
+    activityId: number;
+}
+export interface ResponseAcceptance {
+    responseId: string;
+    executionId?: string;
+    acceptedAt: string;
+    label?: string;
+    acceptanceOrder?: number;
+}
+export interface AskUpdate {
+    item: QuestionItemSnapshot;
+    activityId: number | null;
+    changedAt: string | null;
+}
+export interface RecipientCandidate {
+    id: string;
+    name: string;
+    email: string;
+}
+export interface RecipientAddition {
+    item: QuestionItemSnapshot;
+    addedPersonId: string;
+}
+export type ItemRevision = {
+    itemId: string;
+    revision: number;
+};
+export type InboxAnswerInput = ItemRevision & {
+    questionId: string;
+    response: QuestionResponse;
+};
+export type InboxSearchInput = ItemRevision & {
+    questionId: string;
+    query: string;
+    selected?: RecordReference;
+};
+export interface InboxMember {
+    current(): Promise<InboxCurrent>;
+    items: {
+        list(): Promise<QuestionItemSnapshot[]>;
+        read(itemId: string): Promise<QuestionItemSnapshot>;
+        see(itemId: string): Promise<void>;
+        markDigestRead(itemId: string): Promise<DigestReadConfirmation>;
+        rename(input: ItemRevision & {
+            title: string;
+        }): Promise<AskUpdate>;
+        setLifecycle(input: ItemRevision & {
+            lifecycle: 'open' | 'closed';
+        }): Promise<AskUpdate>;
+        listRecipientCandidates(itemId: string): Promise<RecipientCandidate[]>;
+        addRecipient(input: {
+            itemId: string;
+            personId: string;
+        }): Promise<RecipientAddition>;
+    };
+    questions: {
+        answer(input: InboxAnswerInput): Promise<ResponseAcceptance>;
+        searchRecords(input: InboxSearchInput): Promise<RecordSelectionResult>;
+    };
+    files: {
+        read(input: {
+            itemId: string;
+            fileId: string;
+        }): Promise<Response>;
+    };
+}

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

@@ -0,0 +1,21 @@
+import { type RecordSource, type RecordReference } from './inbox-contract.js';
+export type RecordSelectionInput = {
+    source: RecordSource;
+    query: string;
+    selected?: RecordReference;
+    publication?: boolean;
+};
+export type LabeledRecord = RecordReference & {
+    label: string;
+};
+export type RecordSelectionResult = {
+    recordType: string;
+    eligibleCount: number;
+    matchCount: number;
+    matches: LabeledRecord[];
+    suggestions: Array<LabeledRecord & {
+        reason?: string;
+    }>;
+    selected?: LabeledRecord;
+};
+export declare function validateRecordSelectionInput(value: unknown): RecordSelectionInput;

package/package.json

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