@thatopen/services 0.9.0 → 0.10.0

package/dist/types/batch.d.ts

@@ -0,0 +1,36 @@
+import { Metadata } from './files';
+import { ItemFolder, ItemVersion } from './items';
+
+/**
+ * Maximum number of ids the API accepts in one batch request. The client
+ * methods split larger inputs into chunks of this size automatically.
+ */
+export declare const STORAGE_BATCH_MAX = 100;
+export type BatchError = {
+    status: number;
+    message: string;
+};
+export type HiddenFileSignedUrlBatchEntry = {
+    hiddenFileId: string;
+    url?: string;
+    expiresAt?: string;
+    error?: BatchError;
+};
+export type ItemVersionsBatchEntry = {
+    itemId: string;
+    versions?: ItemVersion[];
+    error?: BatchError;
+};
+export type VersionMetadataBatchRequest = {
+    itemId: string;
+    versionTag: string;
+};
+export type VersionMetadataBatchEntry = VersionMetadataBatchRequest & {
+    metadata?: Metadata;
+    error?: BatchError;
+};
+export type ItemFoldersBatchEntry = {
+    folderId: string;
+    folder?: ItemFolder;
+    error?: BatchError;
+};

package/dist/types/notifications.d.ts

@@ -20,6 +20,29 @@ export interface NotificationDto {
     muted: boolean;
     readAt: string | null;
     createdAt: string;
+    /**
+     * What to group consecutive notifications by — the automation id for a run,
+     * absent for anything that should stand alone.
+     *
+     * Derived rather than the raw producer payload, so fifty runs of one
+     * automation can collapse into a single row without the whole payload being
+     * on the wire for every notification type, forever.
+     */
+    groupKey?: string;
+    /**
+     * How an automation run ended, straight from the producer's result.
+     *
+     * Use this rather than reading the copy. `title` is built from the user's own
+     * automation name, so an automation called "Failover sync" makes every
+     * successful run look failed to anything matching on the text.
+     */
+    outcome?: 'success' | 'error' | 'warning';
+    /**
+     * The automation's name, for a grouped row's heading. Here for the same
+     * reason as `outcome`: recovering it by stripping words off the title breaks
+     * on any name that contains them.
+     */
+    groupLabel?: string;
 }
 /** `nextCursor` is opaque — pass it back verbatim. Null means the last page. */
 export interface NotificationPageDto {

package/docs/client/paths.json

@@ -3,6 +3,10 @@
     "path": "src/core/examples/apps.ts",
     "description": "App lifecycle — list, get with versions, create, download bundle, and archive."
   },
+  {
+    "path": "src/core/examples/batch-reads.ts",
+    "description": "Batch reads — sign many hidden files, list versions and metadata for many files, and resolve many folders in one request each."
+  },
   {
     "path": "src/core/examples/components.ts",
     "description": "Cloud component lifecycle — list, get with versions, create, update, download bundle, archive, and recover."

package/package.json

@@ -15,7 +15,7 @@
     "access": "public"
   },
   "private": false,
-  "version": "0.9.0",
+  "version": "0.10.0",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
   "types": "dist/index.d.ts",