@objectstack/client 4.0.0 → 4.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +11 -11
- package/CHANGELOG.md +9 -0
- package/dist/index.d.mts +18 -8
- package/dist/index.d.ts +18 -8
- package/dist/index.js +20 -13
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +20 -13
- package/dist/index.mjs.map +1 -1
- package/package.json +10 -10
- package/src/client.test.ts +4 -12
- package/src/index.ts +21 -17
package/.turbo/turbo-build.log
CHANGED
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
> @objectstack/client@4.0.
|
|
2
|
+
> @objectstack/client@4.0.2 build /home/runner/work/framework/framework/packages/client
|
|
3
3
|
> tsup --config ../../tsup.config.ts
|
|
4
4
|
|
|
5
5
|
[34mCLI[39m Building entry: src/index.ts
|
|
6
6
|
[34mCLI[39m Using tsconfig: tsconfig.json
|
|
7
7
|
[34mCLI[39m tsup v8.5.1
|
|
8
|
-
[34mCLI[39m Using tsup config: /home/runner/work/
|
|
8
|
+
[34mCLI[39m Using tsup config: /home/runner/work/framework/framework/tsup.config.ts
|
|
9
9
|
[34mCLI[39m Target: es2020
|
|
10
10
|
[34mCLI[39m Cleaning output folder
|
|
11
11
|
[34mESM[39m Build start
|
|
12
12
|
[34mCJS[39m Build start
|
|
13
|
-
[32mESM[39m [1mdist/index.mjs [22m[
|
|
14
|
-
[32mESM[39m [1mdist/index.mjs.map [22m[
|
|
15
|
-
[32mESM[39m ⚡️ Build success in
|
|
16
|
-
[32mCJS[39m [1mdist/index.js [22m[32m55.
|
|
17
|
-
[32mCJS[39m [1mdist/index.js.map [22m[
|
|
18
|
-
[32mCJS[39m ⚡️ Build success in
|
|
13
|
+
[32mESM[39m [1mdist/index.mjs [22m[32m54.51 KB[39m
|
|
14
|
+
[32mESM[39m [1mdist/index.mjs.map [22m[32m110.18 KB[39m
|
|
15
|
+
[32mESM[39m ⚡️ Build success in 31ms
|
|
16
|
+
[32mCJS[39m [1mdist/index.js [22m[32m55.68 KB[39m
|
|
17
|
+
[32mCJS[39m [1mdist/index.js.map [22m[32m110.24 KB[39m
|
|
18
|
+
[32mCJS[39m ⚡️ Build success in 31ms
|
|
19
19
|
[34mDTS[39m Build start
|
|
20
|
-
[32mDTS[39m ⚡️ Build success in
|
|
21
|
-
[32mDTS[39m [1mdist/index.d.mts [22m[32m33.
|
|
22
|
-
[32mDTS[39m [1mdist/index.d.ts [22m[32m33.
|
|
20
|
+
[32mDTS[39m ⚡️ Build success in 3191ms
|
|
21
|
+
[32mDTS[39m [1mdist/index.d.mts [22m[32m33.94 KB[39m
|
|
22
|
+
[32mDTS[39m [1mdist/index.d.ts [22m[32m33.94 KB[39m
|
package/CHANGELOG.md
CHANGED
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { FilterCondition, QueryAST, SortNode, AggregationNode } from '@objectstack/spec/data';
|
|
2
|
-
import { ApiRoutes, GetDiscoveryResponse, WellKnownCapabilities, GetMetaTypesResponse, GetMetaItemsResponse, MetadataCacheRequest, MetadataCacheResponse, LoginRequest, SessionResponse, RegisterRequest, FileUploadResponse, GetPresignedUrlRequest, PresignedUrlResponse, InitiateChunkedUploadRequest, InitiateChunkedUploadResponse, UploadChunkResponse, CompleteChunkedUploadRequest, CompleteChunkedUploadResponse, CheckPermissionRequest, CheckPermissionResponse, GetObjectPermissionsResponse, GetEffectivePermissionsResponse, RealtimeConnectRequest, RealtimeConnectResponse, RealtimeSubscribeRequest, RealtimeSubscribeResponse, SetPresenceRequest, GetPresenceResponse, GetWorkflowConfigResponse, GetWorkflowStateResponse, WorkflowTransitionRequest, WorkflowTransitionResponse, WorkflowApproveRequest, WorkflowApproveResponse, WorkflowRejectRequest, WorkflowRejectResponse, ListViewsResponse, GetViewResponse, CreateViewRequest, CreateViewResponse, UpdateViewRequest, UpdateViewResponse, DeleteViewResponse, RegisterDeviceRequest, RegisterDeviceResponse, UnregisterDeviceResponse, GetNotificationPreferencesResponse, UpdateNotificationPreferencesRequest, UpdateNotificationPreferencesResponse, ListNotificationsResponse, MarkNotificationsReadResponse, MarkAllNotificationsReadResponse, AiNlqRequest, AiNlqResponse,
|
|
3
|
-
export { AddReactionResponse,
|
|
2
|
+
import { ApiRoutes, GetDiscoveryResponse, WellKnownCapabilities, GetMetaTypesResponse, GetMetaItemsResponse, MetadataCacheRequest, MetadataCacheResponse, LoginRequest, SessionResponse, RegisterRequest, FileUploadResponse, GetPresignedUrlRequest, PresignedUrlResponse, InitiateChunkedUploadRequest, InitiateChunkedUploadResponse, UploadChunkResponse, CompleteChunkedUploadRequest, CompleteChunkedUploadResponse, CheckPermissionRequest, CheckPermissionResponse, GetObjectPermissionsResponse, GetEffectivePermissionsResponse, RealtimeConnectRequest, RealtimeConnectResponse, RealtimeSubscribeRequest, RealtimeSubscribeResponse, SetPresenceRequest, GetPresenceResponse, GetWorkflowConfigResponse, GetWorkflowStateResponse, WorkflowTransitionRequest, WorkflowTransitionResponse, WorkflowApproveRequest, WorkflowApproveResponse, WorkflowRejectRequest, WorkflowRejectResponse, ListViewsResponse, GetViewResponse, CreateViewRequest, CreateViewResponse, UpdateViewRequest, UpdateViewResponse, DeleteViewResponse, RegisterDeviceRequest, RegisterDeviceResponse, UnregisterDeviceResponse, GetNotificationPreferencesResponse, UpdateNotificationPreferencesRequest, UpdateNotificationPreferencesResponse, ListNotificationsResponse, MarkNotificationsReadResponse, MarkAllNotificationsReadResponse, AiNlqRequest, AiNlqResponse, AiSuggestRequest, AiSuggestResponse, AiInsightsRequest, AiInsightsResponse, GetLocalesResponse, GetTranslationsResponse, GetFieldLabelsResponse, GetFeedResponse, CreateFeedItemResponse, UpdateFeedItemResponse, DeleteFeedItemResponse, AddReactionResponse, RemoveReactionResponse, PinFeedItemResponse, UnpinFeedItemResponse, StarFeedItemResponse, UnstarFeedItemResponse, SearchFeedResponse, GetChangelogResponse, SubscribeResponse, UnsubscribeResponse, BatchUpdateRequest, BatchUpdateResponse, BatchOptions, StandardErrorCode, ErrorCategory } from '@objectstack/spec/api';
|
|
3
|
+
export { AddReactionResponse, AiInsightsRequest, AiInsightsResponse, AiNlqRequest, AiNlqResponse, AiSuggestRequest, AiSuggestResponse, BatchOperationResult, BatchOptions, BatchRecord, BatchUpdateRequest, BatchUpdateResponse, CheckPermissionRequest, CheckPermissionResponse, CreateFeedItemResponse, CreateViewResponse, DeleteFeedItemResponse, DeleteManyRequest, DeleteViewResponse, ErrorCategory, GetChangelogResponse, GetDiscoveryResponse, GetEffectivePermissionsResponse, GetFeedResponse, GetFieldLabelsResponse, GetLocalesResponse, GetMetaItemsResponse, GetMetaTypesResponse, GetObjectPermissionsResponse, GetPresenceResponse, GetTranslationsResponse, GetViewResponse, GetWorkflowConfigResponse, GetWorkflowStateResponse, ListNotificationsResponse, ListViewsResponse, MetadataCacheRequest, MetadataCacheResponse, PinFeedItemResponse, RealtimeConnectRequest, RealtimeConnectResponse, RealtimeSubscribeRequest, RealtimeSubscribeResponse, RefreshTokenRequest, RegisterDeviceRequest, RegisterDeviceResponse, RegisterRequest, RemoveReactionResponse, SearchFeedResponse, StandardErrorCode, StarFeedItemResponse, SubscribeResponse, UnpinFeedItemResponse, UnstarFeedItemResponse, UnsubscribeResponse, UpdateFeedItemResponse, UpdateManyRequest, UpdateViewResponse, WellKnownCapabilities, WorkflowApproveRequest, WorkflowApproveResponse, WorkflowRejectRequest, WorkflowRejectResponse, WorkflowTransitionRequest, WorkflowTransitionResponse } from '@objectstack/spec/api';
|
|
4
4
|
import { Logger } from '@objectstack/core';
|
|
5
5
|
|
|
6
6
|
/**
|
|
@@ -332,7 +332,8 @@ declare class ObjectStackClient {
|
|
|
332
332
|
} | undefined;
|
|
333
333
|
services?: Record<string, {
|
|
334
334
|
enabled: boolean;
|
|
335
|
-
status: "degraded" | "stub" | "available" | "unavailable";
|
|
335
|
+
status: "degraded" | "stub" | "available" | "registered" | "unavailable";
|
|
336
|
+
handlerReady?: boolean | undefined;
|
|
336
337
|
route?: string | undefined;
|
|
337
338
|
provider?: string | undefined;
|
|
338
339
|
version?: string | undefined;
|
|
@@ -388,8 +389,11 @@ declare class ObjectStackClient {
|
|
|
388
389
|
* Get a specific metadata item by type and name
|
|
389
390
|
* @param type - Metadata type (e.g., 'object', 'plugin')
|
|
390
391
|
* @param name - Item name (snake_case identifier)
|
|
392
|
+
* @param options - Optional filters (e.g., packageId to scope by package)
|
|
391
393
|
*/
|
|
392
|
-
getItem: (type: string, name: string
|
|
394
|
+
getItem: (type: string, name: string, options?: {
|
|
395
|
+
packageId?: string;
|
|
396
|
+
}) => Promise<unknown>;
|
|
393
397
|
/**
|
|
394
398
|
* Save a metadata item
|
|
395
399
|
* @param type - Metadata type (e.g., 'object', 'plugin')
|
|
@@ -397,6 +401,16 @@ declare class ObjectStackClient {
|
|
|
397
401
|
* @param item - The metadata content to save
|
|
398
402
|
*/
|
|
399
403
|
saveItem: (type: string, name: string, item: any) => Promise<unknown>;
|
|
404
|
+
/**
|
|
405
|
+
* Delete a metadata item
|
|
406
|
+
* @param type - Metadata type (e.g., 'object', 'plugin')
|
|
407
|
+
* @param name - Item name (snake_case identifier)
|
|
408
|
+
*/
|
|
409
|
+
deleteItem: (type: string, name: string) => Promise<{
|
|
410
|
+
type: string;
|
|
411
|
+
name: string;
|
|
412
|
+
deleted: boolean;
|
|
413
|
+
}>;
|
|
400
414
|
/**
|
|
401
415
|
* Get object metadata with cache support
|
|
402
416
|
* Supports ETag-based conditional requests for efficient caching
|
|
@@ -742,10 +756,6 @@ declare class ObjectStackClient {
|
|
|
742
756
|
* Natural language query — converts natural language to structured query
|
|
743
757
|
*/
|
|
744
758
|
nlq: (request: AiNlqRequest) => Promise<AiNlqResponse>;
|
|
745
|
-
/**
|
|
746
|
-
* Multi-turn AI chat
|
|
747
|
-
*/
|
|
748
|
-
chat: (request: AiChatRequest) => Promise<AiChatResponse>;
|
|
749
759
|
/**
|
|
750
760
|
* AI-powered field value suggestions
|
|
751
761
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { FilterCondition, QueryAST, SortNode, AggregationNode } from '@objectstack/spec/data';
|
|
2
|
-
import { ApiRoutes, GetDiscoveryResponse, WellKnownCapabilities, GetMetaTypesResponse, GetMetaItemsResponse, MetadataCacheRequest, MetadataCacheResponse, LoginRequest, SessionResponse, RegisterRequest, FileUploadResponse, GetPresignedUrlRequest, PresignedUrlResponse, InitiateChunkedUploadRequest, InitiateChunkedUploadResponse, UploadChunkResponse, CompleteChunkedUploadRequest, CompleteChunkedUploadResponse, CheckPermissionRequest, CheckPermissionResponse, GetObjectPermissionsResponse, GetEffectivePermissionsResponse, RealtimeConnectRequest, RealtimeConnectResponse, RealtimeSubscribeRequest, RealtimeSubscribeResponse, SetPresenceRequest, GetPresenceResponse, GetWorkflowConfigResponse, GetWorkflowStateResponse, WorkflowTransitionRequest, WorkflowTransitionResponse, WorkflowApproveRequest, WorkflowApproveResponse, WorkflowRejectRequest, WorkflowRejectResponse, ListViewsResponse, GetViewResponse, CreateViewRequest, CreateViewResponse, UpdateViewRequest, UpdateViewResponse, DeleteViewResponse, RegisterDeviceRequest, RegisterDeviceResponse, UnregisterDeviceResponse, GetNotificationPreferencesResponse, UpdateNotificationPreferencesRequest, UpdateNotificationPreferencesResponse, ListNotificationsResponse, MarkNotificationsReadResponse, MarkAllNotificationsReadResponse, AiNlqRequest, AiNlqResponse,
|
|
3
|
-
export { AddReactionResponse,
|
|
2
|
+
import { ApiRoutes, GetDiscoveryResponse, WellKnownCapabilities, GetMetaTypesResponse, GetMetaItemsResponse, MetadataCacheRequest, MetadataCacheResponse, LoginRequest, SessionResponse, RegisterRequest, FileUploadResponse, GetPresignedUrlRequest, PresignedUrlResponse, InitiateChunkedUploadRequest, InitiateChunkedUploadResponse, UploadChunkResponse, CompleteChunkedUploadRequest, CompleteChunkedUploadResponse, CheckPermissionRequest, CheckPermissionResponse, GetObjectPermissionsResponse, GetEffectivePermissionsResponse, RealtimeConnectRequest, RealtimeConnectResponse, RealtimeSubscribeRequest, RealtimeSubscribeResponse, SetPresenceRequest, GetPresenceResponse, GetWorkflowConfigResponse, GetWorkflowStateResponse, WorkflowTransitionRequest, WorkflowTransitionResponse, WorkflowApproveRequest, WorkflowApproveResponse, WorkflowRejectRequest, WorkflowRejectResponse, ListViewsResponse, GetViewResponse, CreateViewRequest, CreateViewResponse, UpdateViewRequest, UpdateViewResponse, DeleteViewResponse, RegisterDeviceRequest, RegisterDeviceResponse, UnregisterDeviceResponse, GetNotificationPreferencesResponse, UpdateNotificationPreferencesRequest, UpdateNotificationPreferencesResponse, ListNotificationsResponse, MarkNotificationsReadResponse, MarkAllNotificationsReadResponse, AiNlqRequest, AiNlqResponse, AiSuggestRequest, AiSuggestResponse, AiInsightsRequest, AiInsightsResponse, GetLocalesResponse, GetTranslationsResponse, GetFieldLabelsResponse, GetFeedResponse, CreateFeedItemResponse, UpdateFeedItemResponse, DeleteFeedItemResponse, AddReactionResponse, RemoveReactionResponse, PinFeedItemResponse, UnpinFeedItemResponse, StarFeedItemResponse, UnstarFeedItemResponse, SearchFeedResponse, GetChangelogResponse, SubscribeResponse, UnsubscribeResponse, BatchUpdateRequest, BatchUpdateResponse, BatchOptions, StandardErrorCode, ErrorCategory } from '@objectstack/spec/api';
|
|
3
|
+
export { AddReactionResponse, AiInsightsRequest, AiInsightsResponse, AiNlqRequest, AiNlqResponse, AiSuggestRequest, AiSuggestResponse, BatchOperationResult, BatchOptions, BatchRecord, BatchUpdateRequest, BatchUpdateResponse, CheckPermissionRequest, CheckPermissionResponse, CreateFeedItemResponse, CreateViewResponse, DeleteFeedItemResponse, DeleteManyRequest, DeleteViewResponse, ErrorCategory, GetChangelogResponse, GetDiscoveryResponse, GetEffectivePermissionsResponse, GetFeedResponse, GetFieldLabelsResponse, GetLocalesResponse, GetMetaItemsResponse, GetMetaTypesResponse, GetObjectPermissionsResponse, GetPresenceResponse, GetTranslationsResponse, GetViewResponse, GetWorkflowConfigResponse, GetWorkflowStateResponse, ListNotificationsResponse, ListViewsResponse, MetadataCacheRequest, MetadataCacheResponse, PinFeedItemResponse, RealtimeConnectRequest, RealtimeConnectResponse, RealtimeSubscribeRequest, RealtimeSubscribeResponse, RefreshTokenRequest, RegisterDeviceRequest, RegisterDeviceResponse, RegisterRequest, RemoveReactionResponse, SearchFeedResponse, StandardErrorCode, StarFeedItemResponse, SubscribeResponse, UnpinFeedItemResponse, UnstarFeedItemResponse, UnsubscribeResponse, UpdateFeedItemResponse, UpdateManyRequest, UpdateViewResponse, WellKnownCapabilities, WorkflowApproveRequest, WorkflowApproveResponse, WorkflowRejectRequest, WorkflowRejectResponse, WorkflowTransitionRequest, WorkflowTransitionResponse } from '@objectstack/spec/api';
|
|
4
4
|
import { Logger } from '@objectstack/core';
|
|
5
5
|
|
|
6
6
|
/**
|
|
@@ -332,7 +332,8 @@ declare class ObjectStackClient {
|
|
|
332
332
|
} | undefined;
|
|
333
333
|
services?: Record<string, {
|
|
334
334
|
enabled: boolean;
|
|
335
|
-
status: "degraded" | "stub" | "available" | "unavailable";
|
|
335
|
+
status: "degraded" | "stub" | "available" | "registered" | "unavailable";
|
|
336
|
+
handlerReady?: boolean | undefined;
|
|
336
337
|
route?: string | undefined;
|
|
337
338
|
provider?: string | undefined;
|
|
338
339
|
version?: string | undefined;
|
|
@@ -388,8 +389,11 @@ declare class ObjectStackClient {
|
|
|
388
389
|
* Get a specific metadata item by type and name
|
|
389
390
|
* @param type - Metadata type (e.g., 'object', 'plugin')
|
|
390
391
|
* @param name - Item name (snake_case identifier)
|
|
392
|
+
* @param options - Optional filters (e.g., packageId to scope by package)
|
|
391
393
|
*/
|
|
392
|
-
getItem: (type: string, name: string
|
|
394
|
+
getItem: (type: string, name: string, options?: {
|
|
395
|
+
packageId?: string;
|
|
396
|
+
}) => Promise<unknown>;
|
|
393
397
|
/**
|
|
394
398
|
* Save a metadata item
|
|
395
399
|
* @param type - Metadata type (e.g., 'object', 'plugin')
|
|
@@ -397,6 +401,16 @@ declare class ObjectStackClient {
|
|
|
397
401
|
* @param item - The metadata content to save
|
|
398
402
|
*/
|
|
399
403
|
saveItem: (type: string, name: string, item: any) => Promise<unknown>;
|
|
404
|
+
/**
|
|
405
|
+
* Delete a metadata item
|
|
406
|
+
* @param type - Metadata type (e.g., 'object', 'plugin')
|
|
407
|
+
* @param name - Item name (snake_case identifier)
|
|
408
|
+
*/
|
|
409
|
+
deleteItem: (type: string, name: string) => Promise<{
|
|
410
|
+
type: string;
|
|
411
|
+
name: string;
|
|
412
|
+
deleted: boolean;
|
|
413
|
+
}>;
|
|
400
414
|
/**
|
|
401
415
|
* Get object metadata with cache support
|
|
402
416
|
* Supports ETag-based conditional requests for efficient caching
|
|
@@ -742,10 +756,6 @@ declare class ObjectStackClient {
|
|
|
742
756
|
* Natural language query — converts natural language to structured query
|
|
743
757
|
*/
|
|
744
758
|
nlq: (request: AiNlqRequest) => Promise<AiNlqResponse>;
|
|
745
|
-
/**
|
|
746
|
-
* Multi-turn AI chat
|
|
747
|
-
*/
|
|
748
|
-
chat: (request: AiChatRequest) => Promise<AiChatResponse>;
|
|
749
759
|
/**
|
|
750
760
|
* AI-powered field value suggestions
|
|
751
761
|
*/
|
package/dist/index.js
CHANGED
|
@@ -338,10 +338,15 @@ var ObjectStackClient = class {
|
|
|
338
338
|
* Get a specific metadata item by type and name
|
|
339
339
|
* @param type - Metadata type (e.g., 'object', 'plugin')
|
|
340
340
|
* @param name - Item name (snake_case identifier)
|
|
341
|
+
* @param options - Optional filters (e.g., packageId to scope by package)
|
|
341
342
|
*/
|
|
342
|
-
getItem: async (type, name) => {
|
|
343
|
+
getItem: async (type, name, options) => {
|
|
343
344
|
const route = this.getRoute("metadata");
|
|
344
|
-
const
|
|
345
|
+
const params = new URLSearchParams();
|
|
346
|
+
if (options?.packageId) params.set("package", options.packageId);
|
|
347
|
+
const qs = params.toString();
|
|
348
|
+
const url = `${this.baseUrl}${route}/${type}/${name}${qs ? `?${qs}` : ""}`;
|
|
349
|
+
const res = await this.fetch(url);
|
|
345
350
|
return this.unwrapResponse(res);
|
|
346
351
|
},
|
|
347
352
|
/**
|
|
@@ -358,6 +363,18 @@ var ObjectStackClient = class {
|
|
|
358
363
|
});
|
|
359
364
|
return this.unwrapResponse(res);
|
|
360
365
|
},
|
|
366
|
+
/**
|
|
367
|
+
* Delete a metadata item
|
|
368
|
+
* @param type - Metadata type (e.g., 'object', 'plugin')
|
|
369
|
+
* @param name - Item name (snake_case identifier)
|
|
370
|
+
*/
|
|
371
|
+
deleteItem: async (type, name) => {
|
|
372
|
+
const route = this.getRoute("metadata");
|
|
373
|
+
const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(type)}/${encodeURIComponent(name)}`, {
|
|
374
|
+
method: "DELETE"
|
|
375
|
+
});
|
|
376
|
+
return this.unwrapResponse(res);
|
|
377
|
+
},
|
|
361
378
|
/**
|
|
362
379
|
* Get object metadata with cache support
|
|
363
380
|
* Supports ETag-based conditional requests for efficient caching
|
|
@@ -1101,17 +1118,7 @@ var ObjectStackClient = class {
|
|
|
1101
1118
|
});
|
|
1102
1119
|
return this.unwrapResponse(res);
|
|
1103
1120
|
},
|
|
1104
|
-
|
|
1105
|
-
* Multi-turn AI chat
|
|
1106
|
-
*/
|
|
1107
|
-
chat: async (request) => {
|
|
1108
|
-
const route = this.getRoute("ai");
|
|
1109
|
-
const res = await this.fetch(`${this.baseUrl}${route}/chat`, {
|
|
1110
|
-
method: "POST",
|
|
1111
|
-
body: JSON.stringify(request)
|
|
1112
|
-
});
|
|
1113
|
-
return this.unwrapResponse(res);
|
|
1114
|
-
},
|
|
1121
|
+
// AI chat method removed — use Vercel AI SDK `useChat()` / `@ai-sdk/react` directly.
|
|
1115
1122
|
/**
|
|
1116
1123
|
* AI-powered field value suggestions
|
|
1117
1124
|
*/
|