@mediaviz/sdk 1.8.0-dev.92 → 1.8.0-dev.96

package/dist/sdk.d.ts

@@ -60,6 +60,79 @@ export class ServerError extends ApiError {
 
 export function handleResponse(response: Response): Promise<any>;
 
+export type WebhookAck = 'handled' | 'duplicate' | 'bad_signature';
+
+export interface WebhookDeliveryEvent {
+  event_id: string;
+  event_type: string;
+  schema_version?: string;
+  subscription_id: string;
+  project_table_name: string;
+  photo_id: number;
+  target: string;
+  completed_at?: string;
+  result_location?: string;
+  [key: string]: any;
+}
+
+export interface WebhookStoreLike {
+  markSeen(eventId: string, ttlS: number): boolean;
+  unmarkSeen(eventId: string): void;
+  saveSecret(subscriptionId: string, secret: string): void;
+  rotateSecret(subscriptionId: string, newSecret: string, windowS: number): void;
+  getSecrets(subscriptionId: string): [string | null, string | null];
+  getCursor(subscriptionId: string): string | null;
+  setCursor(subscriptionId: string, cursor: string): void;
+}
+
+export class InMemoryWebhookStore implements WebhookStoreLike {
+  markSeen(eventId: string, ttlS: number): boolean;
+  unmarkSeen(eventId: string): void;
+  saveSecret(subscriptionId: string, secret: string): void;
+  rotateSecret(subscriptionId: string, newSecret: string, windowS: number): void;
+  getSecrets(subscriptionId: string): [string | null, string | null];
+  getCursor(subscriptionId: string): string | null;
+  setCursor(subscriptionId: string, cursor: string): void;
+}
+
+export class WebhookConsumer {
+  constructor(ctx: any, subscriptionApi: any, options?: {
+    store?: WebhookStoreLike;
+    onEvent?: (event: WebhookDeliveryEvent) => void | Promise<void>;
+    skewToleranceS?: number;
+    rotationWindowS?: number;
+    dedupeTtlS?: number;
+    pageLimit?: number;
+  });
+  store: WebhookStoreLike;
+  skewToleranceS: number;
+  rotationWindowS: number;
+  dedupeTtlS: number;
+  pageLimit: number;
+  onEvent(fn: (event: WebhookDeliveryEvent) => void | Promise<void>): (event: WebhookDeliveryEvent) => void | Promise<void>;
+  useStore(store: WebhookStoreLike): void;
+  classifyMessage(body: any): 'verification' | 'delivery' | 'unknown';
+  handleChallenge(body: any): { challenge: string };
+  handleDelivery(headers: any, rawBody: string | Uint8Array | ArrayBuffer): Promise<WebhookAck>;
+  handleRequest(headers: any, rawBody: string | Uint8Array | ArrayBuffer): Promise<{ status: number; body: any }>;
+  register(projectTableName: string, callbackUrl: string, targets: string[]): Promise<any>;
+  confirm(subscriptionId: string): Promise<any>;
+  rotateSecret(subscriptionId: string): Promise<string>;
+  updateCallback(subscriptionId: string, callbackUrl: string): Promise<any>;
+  disable(subscriptionId: string): Promise<any>;
+  listSubscriptions(): Promise<any>;
+  pullEvents(subscriptionId: string, options?: { since?: string; limit?: number }): Promise<any>;
+  reconcile(subscriptionId: string, projectTableName: string): Promise<{ pulled: number; dispatched: number }>;
+  fetchResult(event: WebhookDeliveryEvent): Promise<{ photo: any; selected: Record<string, any> | null }>;
+  saveSecret(subscriptionId: string, secret: string): void;
+}
+
+export function signWebhookPayload(secret: string, timestamp: string, rawBody: string | Uint8Array | ArrayBuffer): Promise<string>;
+export function verifyWebhookSignature(secretCurrent: string | null, secretPrevious: string | null, headers: any, rawBody: string | Uint8Array | ArrayBuffer, options?: { skewToleranceS?: number; now?: number }): Promise<boolean>;
+export function selectResultColumns(photo: any, target: string): Record<string, any> | null;
+export const WEBHOOK_MODEL_COLUMNS: Record<string, string[]>;
+export const WEBHOOK_OUTCOME_MODELS: Record<string, string[]>;
+
 // ── response schemas ──
 export interface AlbumDisplay {
   name?: string;
@@ -255,7 +328,7 @@ export interface PhotoPersonWithS3Link {
 export interface ProjectRunDisplay {
   name: string;
   private?: boolean;
-  type?: number;
+  type: number;
   description?: string;
   directory?: string;
   photo_upload_vector?: number;
@@ -290,6 +363,7 @@ export interface ProjectRunDisplay {
   evidence_model?: boolean;
   insights_model?: boolean;
   normalize?: boolean;
+  is_continuous_upload?: boolean;
 }
 
 export interface PullEvent {
@@ -430,7 +504,7 @@ export class OauthAuthorization {
 export class OauthToken {
   token(body: { grantType: string, code: string, redirectUri: string, clientId: string, codeVerifier: string, refreshToken: string, clientSecret: string }): Promise<Record<string, any>>;
   adminRevokeUserTokens(userId: number): Promise<Record<string, any>>;
-  revoke(body: { token: string, tokenTypeHint: string, clientId: string }): Promise<any>;
+  revoke(body: { token: string, tokenTypeHint: string, clientId: string }): Promise<Record<string, any>>;
 }
 
 export class OauthLogin {
@@ -467,7 +541,7 @@ export class Photos {
 }
 
 export class Projects {
-  createProjectAndRun(name: string, private_?: boolean, type?: number, description?: string, directory?: string, photoUploadVector?: number, thumbnail?: string, runName?: string, options?: { outcomes?: any, models?: any }): Promise<ProjectRunDisplay>;
+  createProjectAndRun(name: string, type: number, private_?: boolean, description?: string, directory?: string, photoUploadVector?: number, thumbnail?: string, runName?: string, options?: { outcomes?: any, models?: any }): Promise<ProjectRunDisplay>;
   markProjectUploadComplete(projectTableName: string, options?: { skippedFileCount?: number | number[] }): Promise<any>;
   checkProjectStatus(projectTableName: string): Promise<any>;
   getProjectPrelimModelRequestTemplate(projectTableName: string): Promise<Record<string, any>>;
@@ -500,8 +574,8 @@ export class Search {
 }
 
 export class Subscription {
-  createSubscription(projectTableName: string, callbackUrl: string, targets: string[]): Promise<any>;
-  verifySubscription(subscriptionId: string): Promise<any>;
+  createSubscription(projectTableName: string, callbackUrl: string, targets: string[]): Promise<SubscriptionActivated>;
+  verifySubscription(subscriptionId: string): Promise<SubscriptionActivated>;
   listSubscriptions(): Promise<SubscriptionDisplay[]>;
   listSubscriptionEvents(subscriptionId: string, options?: { since?: string | string[], limit?: number | number[] }): Promise<EventPage>;
   updateSubscription(subscriptionId: string, body?: { callbackUrl?: string, targets?: string[] }): Promise<SubscriptionDisplay>;
@@ -546,5 +620,6 @@ export class MediaViz {
   readonly search: Search;
   readonly subscription: Subscription;
   readonly users: Users;
+  readonly webhooks: WebhookConsumer;
 }
 

package/dist/sdk.esm.d.ts

@@ -60,6 +60,79 @@ export class ServerError extends ApiError {
 
 export function handleResponse(response: Response): Promise<any>;
 
+export type WebhookAck = 'handled' | 'duplicate' | 'bad_signature';
+
+export interface WebhookDeliveryEvent {
+  event_id: string;
+  event_type: string;
+  schema_version?: string;
+  subscription_id: string;
+  project_table_name: string;
+  photo_id: number;
+  target: string;
+  completed_at?: string;
+  result_location?: string;
+  [key: string]: any;
+}
+
+export interface WebhookStoreLike {
+  markSeen(eventId: string, ttlS: number): boolean;
+  unmarkSeen(eventId: string): void;
+  saveSecret(subscriptionId: string, secret: string): void;
+  rotateSecret(subscriptionId: string, newSecret: string, windowS: number): void;
+  getSecrets(subscriptionId: string): [string | null, string | null];
+  getCursor(subscriptionId: string): string | null;
+  setCursor(subscriptionId: string, cursor: string): void;
+}
+
+export class InMemoryWebhookStore implements WebhookStoreLike {
+  markSeen(eventId: string, ttlS: number): boolean;
+  unmarkSeen(eventId: string): void;
+  saveSecret(subscriptionId: string, secret: string): void;
+  rotateSecret(subscriptionId: string, newSecret: string, windowS: number): void;
+  getSecrets(subscriptionId: string): [string | null, string | null];
+  getCursor(subscriptionId: string): string | null;
+  setCursor(subscriptionId: string, cursor: string): void;
+}
+
+export class WebhookConsumer {
+  constructor(ctx: any, subscriptionApi: any, options?: {
+    store?: WebhookStoreLike;
+    onEvent?: (event: WebhookDeliveryEvent) => void | Promise<void>;
+    skewToleranceS?: number;
+    rotationWindowS?: number;
+    dedupeTtlS?: number;
+    pageLimit?: number;
+  });
+  store: WebhookStoreLike;
+  skewToleranceS: number;
+  rotationWindowS: number;
+  dedupeTtlS: number;
+  pageLimit: number;
+  onEvent(fn: (event: WebhookDeliveryEvent) => void | Promise<void>): (event: WebhookDeliveryEvent) => void | Promise<void>;
+  useStore(store: WebhookStoreLike): void;
+  classifyMessage(body: any): 'verification' | 'delivery' | 'unknown';
+  handleChallenge(body: any): { challenge: string };
+  handleDelivery(headers: any, rawBody: string | Uint8Array | ArrayBuffer): Promise<WebhookAck>;
+  handleRequest(headers: any, rawBody: string | Uint8Array | ArrayBuffer): Promise<{ status: number; body: any }>;
+  register(projectTableName: string, callbackUrl: string, targets: string[]): Promise<any>;
+  confirm(subscriptionId: string): Promise<any>;
+  rotateSecret(subscriptionId: string): Promise<string>;
+  updateCallback(subscriptionId: string, callbackUrl: string): Promise<any>;
+  disable(subscriptionId: string): Promise<any>;
+  listSubscriptions(): Promise<any>;
+  pullEvents(subscriptionId: string, options?: { since?: string; limit?: number }): Promise<any>;
+  reconcile(subscriptionId: string, projectTableName: string): Promise<{ pulled: number; dispatched: number }>;
+  fetchResult(event: WebhookDeliveryEvent): Promise<{ photo: any; selected: Record<string, any> | null }>;
+  saveSecret(subscriptionId: string, secret: string): void;
+}
+
+export function signWebhookPayload(secret: string, timestamp: string, rawBody: string | Uint8Array | ArrayBuffer): Promise<string>;
+export function verifyWebhookSignature(secretCurrent: string | null, secretPrevious: string | null, headers: any, rawBody: string | Uint8Array | ArrayBuffer, options?: { skewToleranceS?: number; now?: number }): Promise<boolean>;
+export function selectResultColumns(photo: any, target: string): Record<string, any> | null;
+export const WEBHOOK_MODEL_COLUMNS: Record<string, string[]>;
+export const WEBHOOK_OUTCOME_MODELS: Record<string, string[]>;
+
 // ── response schemas ──
 export interface AlbumDisplay {
   name?: string;
@@ -255,7 +328,7 @@ export interface PhotoPersonWithS3Link {
 export interface ProjectRunDisplay {
   name: string;
   private?: boolean;
-  type?: number;
+  type: number;
   description?: string;
   directory?: string;
   photo_upload_vector?: number;
@@ -290,6 +363,7 @@ export interface ProjectRunDisplay {
   evidence_model?: boolean;
   insights_model?: boolean;
   normalize?: boolean;
+  is_continuous_upload?: boolean;
 }
 
 export interface PullEvent {
@@ -430,7 +504,7 @@ export class OauthAuthorization {
 export class OauthToken {
   token(body: { grantType: string, code: string, redirectUri: string, clientId: string, codeVerifier: string, refreshToken: string, clientSecret: string }): Promise<Record<string, any>>;
   adminRevokeUserTokens(userId: number): Promise<Record<string, any>>;
-  revoke(body: { token: string, tokenTypeHint: string, clientId: string }): Promise<any>;
+  revoke(body: { token: string, tokenTypeHint: string, clientId: string }): Promise<Record<string, any>>;
 }
 
 export class OauthLogin {
@@ -467,7 +541,7 @@ export class Photos {
 }
 
 export class Projects {
-  createProjectAndRun(name: string, private_?: boolean, type?: number, description?: string, directory?: string, photoUploadVector?: number, thumbnail?: string, runName?: string, options?: { outcomes?: any, models?: any }): Promise<ProjectRunDisplay>;
+  createProjectAndRun(name: string, type: number, private_?: boolean, description?: string, directory?: string, photoUploadVector?: number, thumbnail?: string, runName?: string, options?: { outcomes?: any, models?: any }): Promise<ProjectRunDisplay>;
   markProjectUploadComplete(projectTableName: string, options?: { skippedFileCount?: number | number[] }): Promise<any>;
   checkProjectStatus(projectTableName: string): Promise<any>;
   getProjectPrelimModelRequestTemplate(projectTableName: string): Promise<Record<string, any>>;
@@ -500,8 +574,8 @@ export class Search {
 }
 
 export class Subscription {
-  createSubscription(projectTableName: string, callbackUrl: string, targets: string[]): Promise<any>;
-  verifySubscription(subscriptionId: string): Promise<any>;
+  createSubscription(projectTableName: string, callbackUrl: string, targets: string[]): Promise<SubscriptionActivated>;
+  verifySubscription(subscriptionId: string): Promise<SubscriptionActivated>;
   listSubscriptions(): Promise<SubscriptionDisplay[]>;
   listSubscriptionEvents(subscriptionId: string, options?: { since?: string | string[], limit?: number | number[] }): Promise<EventPage>;
   updateSubscription(subscriptionId: string, body?: { callbackUrl?: string, targets?: string[] }): Promise<SubscriptionDisplay>;
@@ -546,5 +620,6 @@ export class MediaViz {
   readonly search: Search;
   readonly subscription: Subscription;
   readonly users: Users;
+  readonly webhooks: WebhookConsumer;
 }