@butinapp/sdk 0.1.0 → 0.1.1

package/dist/plugin/capability.d.ts

@@ -16,13 +16,14 @@ export type CollectContext<TConfig = Record<string, unknown>> = {
 export type IncrementalSpec = {
     id: string;
     timestamp: string;
+    listKey?: string;
     window?: {
         days: number;
     };
 };
 export type IncrementalCapability = IncrementalSpec & {
-    fetch: (ctx: CollectContext) => Promise<Record<string, unknown>[]>;
-    build: (rows: Record<string, unknown>[]) => CapabilityResult;
+    fetch: (ctx: CollectContext) => Promise<unknown>;
+    build: (raw: unknown) => CapabilityResult;
 };
 export type Capability<TConfig = Record<string, unknown>> = {
     id: string;
@@ -36,6 +37,26 @@ export type Capability<TConfig = Record<string, unknown>> = {
     fetchFile?: (ctx: CollectContext<TConfig>, row: Record<string, unknown>) => Promise<DocumentBytes>;
 };
 type RowOf<TRaw> = TRaw extends readonly (infer R)[] ? R : never;
+type ListKeys<T> = {
+    [K in keyof T]: T[K] extends readonly unknown[] ? K : never;
+}[keyof T];
+type FieldOf<A> = keyof RowOf<A> & string;
+type IncrementalDecl<TRaw> = TRaw extends readonly unknown[] ? {
+    id: FieldOf<TRaw>;
+    timestamp: FieldOf<TRaw>;
+    window?: {
+        days: number;
+    };
+} : {
+    [K in ListKeys<TRaw>]: {
+        listKey: K;
+        id: FieldOf<TRaw[K]>;
+        timestamp: FieldOf<TRaw[K]>;
+        window?: {
+            days: number;
+        };
+    };
+}[ListKeys<TRaw>];
 export declare const defineCapability: <TRaw, TConfig = Record<string, unknown>>(spec: {
     id: string;
     label: string;
@@ -43,12 +64,6 @@ export declare const defineCapability: <TRaw, TConfig = Record<string, unknown>>
     build: (raw: TRaw) => CapabilityResult;
     sample: SampleGenerator<TRaw>;
     fetchFile?: (ctx: CollectContext<TConfig>, row: Record<string, unknown>) => Promise<DocumentBytes>;
-    incremental?: {
-        id: keyof RowOf<TRaw> & string;
-        timestamp: keyof RowOf<TRaw> & string;
-        window?: {
-            days: number;
-        };
-    };
+    incremental?: IncrementalDecl<TRaw>;
 }) => Capability<TConfig>;
 export {};

package/dist/plugin/capability.js

@@ -1,19 +1,23 @@
 import { createSampleGen, resolveSampleConfig } from '../testing/synthetic.js';
-export const defineCapability = (spec) => ({
-    id: spec.id,
-    label: spec.label,
-    collect: async (ctx) => spec.build(await spec.fetch(ctx)),
-    sample: (opts) => spec.build(spec.sample(createSampleGen(opts?.seed ?? spec.id), resolveSampleConfig(opts?.config))),
-    ...(spec.fetchFile ? { fetchFile: spec.fetchFile } : {}),
-    ...(spec.incremental
-        ? {
-            incremental: {
-                id: spec.incremental.id,
-                timestamp: spec.incremental.timestamp,
-                ...(spec.incremental.window ? { window: spec.incremental.window } : {}),
-                fetch: spec.fetch,
-                build: spec.build
+export const defineCapability = (spec) => {
+    const inc = spec.incremental;
+    return {
+        id: spec.id,
+        label: spec.label,
+        collect: async (ctx) => spec.build(await spec.fetch(ctx)),
+        sample: (opts) => spec.build(spec.sample(createSampleGen(opts?.seed ?? spec.id), resolveSampleConfig(opts?.config))),
+        ...(spec.fetchFile ? { fetchFile: spec.fetchFile } : {}),
+        ...(spec.incremental
+            ? {
+                incremental: {
+                    id: inc.id,
+                    timestamp: inc.timestamp,
+                    ...(inc.listKey ? { listKey: inc.listKey } : {}),
+                    ...(inc.window ? { window: inc.window } : {}),
+                    fetch: spec.fetch,
+                    build: spec.build
+                }
             }
-        }
-        : {})
-});
+            : {})
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@butinapp/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "The Butin plugin-authoring contract: descriptor types, the data-view result contract, presets, and edge utilities.",
   "homepage": "https://butin.app",
   "bugs": "https://github.com/butinapp/butin/issues",