@oddington/sdk 0.1.23 → 0.1.24

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

@@ -19,7 +19,7 @@ export type { GmailRuntimeConnection, AirtableRuntimeConnection, RuntimeConnecti
 export type { 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, RecordsSearchOptions, RecordsSearchResult, HistoryListOptions, HistoryEntry, HistoryChangesOptions, HistoryChange, HistoryChangesResult, RecordIdentity, RecordCreation, 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, RecordsReadInput, RecordsReadResult, RecordsSearchOptions, RecordsSearchResult, HistoryListOptions, HistoryEntry, HistoryChangesOptions, HistoryChange, HistoryChangesResult, RecordIdentity, RecordCreation, RecordUpdateSet, DataPublication, DataChangeSet, DataEffect } from '../../../shared/data-contract.js';
 export declare const data: {
     repository(name: string): import('../../../shared/data-contract.js').DataRepository;
 };
@@ -185,6 +185,14 @@ export type AppRoutineBinding<Input, Result, Steps> = {
 };
 export declare const app: {
     listRoutines(): Promise<RoutineDescription[]>;
+    routine(id: string): {
+        describe(): Promise<RoutineDescription>;
+        run(input?: unknown): Promise<RunHandle>;
+        runs: {
+            list(): Promise<RunSummary[]>;
+            get(id: string): Promise<RunHandle>;
+        };
+    };
     routines: AppRoutineTypes;
 };
 /** A declared stage without a summary takes no second argument. */

package/dist/types/packages/sdk/src/routine-definition-types.d.ts

@@ -66,7 +66,7 @@ export type RoutineCapabilities<Access extends RoutineAccess> = {
 };
 type RoutineStepCalls<Steps extends RoutineSteps> = {
     [Key in keyof Steps]: {
-        input: Parameters<Steps[Key]['run']> extends [] ? [] : [input: RoutineInput<RoutineStepInput<Steps[Key]>>];
+        input: Parameters<Steps[Key]['run']> extends [] ? [] : [input: RoutineStepInput<Steps[Key]> | RoutineInput<RoutineStepInput<Steps[Key]>>];
         result: RoutineStepResult<Steps[Key]>;
     };
 };

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

@@ -102,11 +102,26 @@ export type SelectionMetadata = {
         next?: string;
     }>;
 };
-export type RecordsResult = {
+type SelectedRecordFor<Selection extends RecordSelection> = string extends keyof Selection ? SelectedRecord : SelectedRecord & {
+    [Link in Exclude<keyof Selection, '$'>]?: SelectedLinkFor<Selection[Link]>;
+};
+type SelectedLinkFor<Selection> = Selection extends RecordSelection ? SelectedRecordFor<Selection> | SelectedRecordFor<Selection>[] | null : never;
+export type RecordsResult<Query extends RecordsQuery = RecordsQuery> = string extends keyof Query ? {
     $meta: SelectionMetadata;
     [collection: string]: SelectedRecord[] | SelectionMetadata;
+} : {
+    $meta: SelectionMetadata;
+} & {
+    [Collection in keyof Query]: SelectedRecordFor<Query[Collection]>[];
 };
 export type RecordIdentity = Pick<SelectedRecord, '$ref' | '$version'>;
+export type RecordsReadInput = string | readonly string[];
+export type RecordsReadResult = {
+    $meta: {
+        version: string;
+    };
+    records: Array<SelectedRecord | null>;
+};
 export type RecordsSearchOptions = {
     collections?: string[];
     limit?: number;
@@ -190,7 +205,14 @@ export interface DataRepository {
         schema(name: string): Promise<CollectionSchema>;
     };
     records: {
-        select(query: RecordsQuery): Promise<RecordsResult>;
+        select<Query extends RecordsQuery>(query: Query): Promise<RecordsResult<Query>>;
+        pages<Query extends RecordsQuery>(query: Query): AsyncIterable<RecordsResult<Query>>;
+        all<Query extends RecordsQuery>(query: Query, options: {
+            maxRecords: number;
+        }): Promise<RecordsResult<Query>>;
+        read(ref: string): Promise<SelectedRecord | null>;
+        read(refs: readonly string[]): Promise<RecordsReadResult>;
+        read(input: RecordsReadInput): Promise<SelectedRecord | null | RecordsReadResult>;
         search(query: string, options?: RecordsSearchOptions): Promise<RecordsSearchResult>;
     };
     history: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oddington/sdk",
-  "version": "0.1.23",
-  "description": "Oddington routine and response-handler SDK",
+  "version": "0.1.24",
+  "description": "OS routine and response-handler SDK",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",
   "files": ["dist", "LICENSE", "README.md"],