@collective-intelligence/external-apps-server-sdk 0.1.36 → 0.1.37

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/dist/index.d.ts CHANGED
@@ -1,21 +1,7 @@
1
1
  // Generated by dts-bundle-generator v9.5.1
2
2
 
3
- export type ResourceJsonValue = null | boolean | number | string | readonly ResourceJsonValue[] | Readonly<{
4
- [key: string]: ResourceJsonValue;
5
- }>;
6
- /** A File upload request for one File field of the entity schema. */
7
- export type EntityUploadInput = Readonly<{
8
- field: string;
9
- filename: string;
10
- mimeType: string;
11
- }>;
12
- /** PUT the file bytes to `url` with `headers`; then write `{ upload: uploadId }`. */
13
- export type EntityUploadSlot = Readonly<{
14
- headers: Readonly<Record<string, string>>;
15
- method: "PUT";
16
- uploadId: string;
17
- url: string;
18
- }>;
3
+ import { EntityUploadInput, EntityUploadSlot, ResourceJsonValue } from '@collective-intelligence/external-apps-client-sdk/resources';
4
+
19
5
  export type ExternalApplicationsGetContextErrors = {
20
6
  /**
21
7
  * Error
@@ -1013,6 +999,8 @@ export {
1013
999
  ApplicationUserPage as ServerApplicationUserPage,
1014
1000
  ApplicationUserResolution as ServerApplicationUserResolution,
1015
1001
  DurableFileUpload as ServerDurableFileUpload,
1002
+ EntityUploadInput,
1003
+ EntityUploadSlot,
1016
1004
  MemberSessionExchangeError$1 as MemberSessionExchangeError,
1017
1005
  MessageContent as ServerMessageContent,
1018
1006
  MessageReceipt as ServerMessageReceipt,
@@ -1020,6 +1008,7 @@ export {
1020
1008
  MessageSendFailure as ServerMessageSendFailure,
1021
1009
  MessageSendResult as ServerMessageSendResult,
1022
1010
  MessageTarget as ServerMessageTarget,
1011
+ ResourceJsonValue,
1023
1012
  StorageFileId as ServerStorageFileId,
1024
1013
  };
1025
1014
 
@@ -1,191 +1,7 @@
1
1
  // Generated by dts-bundle-generator v9.5.1
2
2
 
3
- export type ResourceJsonValue = null | boolean | number | string | readonly ResourceJsonValue[] | Readonly<{
4
- [key: string]: ResourceJsonValue;
5
- }>;
6
- /** Opaque wire identity. Callers must not infer or concatenate its internals. */
7
- export type ResourceId = string;
8
- export type ResourceRecordId = ResourceId;
9
- /** Opaque concurrency token independent from source timestamps. */
10
- export type ResourceRevision = string;
11
- /** Opaque pagination position issued and consumed only by a resource adapter. */
12
- export type ResourceCursor = string;
13
- export type IdempotencyKey = string;
14
- export type ResourceIdentityField = Readonly<{
15
- name: string;
16
- type: "number" | "string";
17
- }>;
18
- export type ResourceCapabilities = Readonly<{
19
- create?: boolean;
20
- /** Common entity deletion is always soft deletion. */
21
- delete?: boolean;
22
- get?: boolean;
23
- hardDelete?: boolean;
24
- includeDeleted?: boolean;
25
- restore?: boolean;
26
- search: true;
27
- softDelete?: boolean;
28
- update?: boolean;
29
- /** File uploads for the File fields of a common entity resource. */
30
- upload?: boolean;
31
- }>;
32
- export type ResourcePaginationMode = "cursor" | "page";
33
- export type PortableResourceSchema = Readonly<Record<string, ResourceJsonValue>>;
34
- export type ResourceDefinition<Entity, Create = Entity, Update = Partial<Entity>> = Readonly<{
35
- capabilities: ResourceCapabilities;
36
- concurrency: "revision";
37
- id: string;
38
- identity: Readonly<{
39
- fields: readonly [
40
- ResourceIdentityField,
41
- ...ResourceIdentityField[]
42
- ];
43
- }>;
44
- query: Readonly<{
45
- filterableFields: readonly string[];
46
- pagination: Readonly<{
47
- modes: readonly ResourcePaginationMode[];
48
- }>;
49
- sortableFields: readonly string[];
50
- textSearchFields?: readonly string[];
51
- }>;
52
- schemas: Readonly<{
53
- create?: PortableResourceSchema;
54
- entity: PortableResourceSchema;
55
- update?: PortableResourceSchema;
56
- }>;
57
- version: string;
58
- /** Portable UI metadata; required/enum/nullability remain in schemas. */
59
- metadata?: Readonly<Record<string, ResourceJsonValue>>;
60
- /** Type-only slots keep definition values portable and serializable. */
61
- readonly __types?: Readonly<{
62
- create: Create;
63
- entity: Entity;
64
- update: Update;
65
- }>;
66
- }>;
67
- export type FilterValue = ResourceJsonValue | readonly ResourceJsonValue[];
68
- /**
69
- * A filter predicate. `field` names a declared filterable field, or a path
70
- * through at most three fields that hold Entity References to a field of
71
- * the last target, such as `company.industry` or
72
- * `contacts.company.parent.industry`. On a field that holds Entity
73
- * References, `is_empty` means no reference. User fields accept identity
74
- * predicates for one ID and `contains_any`, `contains_all`, `contains_none`
75
- * for multiple IDs, plus empty/not-empty aliases. CI validates operators
76
- * against the actual field semantic; UUID shape alone does not declare User.
77
- */
78
- export type ResourceFilter = Readonly<{
79
- field: string;
80
- operator: "contains" | "contains_all" | "contains_any" | "contains_none" | "ends_with" | "eq" | "gt" | "gte" | "in" | "lt" | "lte" | "ne" | "not_in" | "starts_with";
81
- value: FilterValue;
82
- }> | Readonly<{
83
- field: string;
84
- operator: "is_empty" | "is_not_empty" | "is_not_null" | "is_null";
85
- }> | Readonly<{
86
- filters: readonly ResourceFilter[];
87
- operator: "and" | "or";
88
- }> | Readonly<{
89
- filter: ResourceFilter;
90
- operator: "not";
91
- }>;
92
- export type ResourceSort = Readonly<{
93
- direction: "asc" | "desc";
94
- field: string;
95
- }>;
96
- export type ResourcePagination = Readonly<{
97
- mode: "cursor";
98
- cursor?: ResourceCursor;
99
- limit: number;
100
- }> | Readonly<{
101
- mode: "page";
102
- page: number;
103
- pageSize: number;
104
- }>;
105
- export type ResourceListQuery = Readonly<{
106
- filter?: ResourceFilter;
107
- /**
108
- * Include Paths, such as `["company", "contacts.company"]`: relation
109
- * fields whose records each item carries in `included`.
110
- */
111
- include?: readonly string[];
112
- includeDeleted?: boolean;
113
- pagination: ResourcePagination;
114
- sort?: readonly ResourceSort[];
115
- textSearch?: string;
116
- }>;
117
- export type ResourceRecord<Entity> = Readonly<{
118
- deletedAt?: string;
119
- id: ResourceRecordId;
120
- /**
121
- * The records of the read's Include Paths by relation field key: one
122
- * record, or the records of a `many` field in reference order. Untyped:
123
- * the target schemas are CI's.
124
- */
125
- included?: Readonly<Record<string, ResourceJsonValue>>;
126
- revision: ResourceRevision;
127
- /** The keys whose included records were cut to the first 100. */
128
- truncated?: readonly string[];
129
- value: Entity;
130
- }>;
131
- export type ResourceErrorCode = "capability_not_supported" | "conflict" | "forbidden" | "internal" | "invalid_request" | "not_found" | "rate_limited" | "transport_error" | "unauthenticated" | "unavailable" |
132
- /** The CI Organization storage can not take a presigned File upload. */
133
- "upload_not_supported";
134
- export type ResourceError = Readonly<{
135
- code: ResourceErrorCode;
136
- /** Client-observed dispatch outcome; uncertainty never proves rollback. */
137
- outcome?: "not_dispatched" | "rejected" | "uncertain";
138
- details?: Readonly<Record<string, ResourceJsonValue>>;
139
- message: string;
140
- retryable: boolean;
141
- }>;
142
- export type ResourceResult<Value> = Readonly<{
143
- correlationId: string;
144
- ok: true;
145
- value: Value;
146
- }> | Readonly<{
147
- correlationId: string;
148
- error: ResourceError;
149
- ok: false;
150
- }>;
151
- export type ResourceListRequest = Readonly<{
152
- operation: "list";
153
- query: ResourceListQuery;
154
- requestId: string;
155
- resourceId: string;
156
- }>;
157
- export type ResourceGetRequest = Readonly<{
158
- id: ResourceRecordId;
159
- includeDeleted?: boolean;
160
- operation: "get";
161
- requestId: string;
162
- resourceId: string;
163
- }>;
164
- export type ResourceCreateRequest<Create> = Readonly<{
165
- idempotencyKey: IdempotencyKey;
166
- operation: "create";
167
- requestId: string;
168
- resourceId: string;
169
- value: Create;
170
- }>;
171
- export type ResourceUpdateRequest<Update> = Readonly<{
172
- expectedRevision: ResourceRevision;
173
- id: ResourceRecordId;
174
- idempotencyKey?: IdempotencyKey;
175
- operation: "update";
176
- requestId: string;
177
- resourceId: string;
178
- value: Update;
179
- }>;
180
- export type ResourceLifecycleRequest = Readonly<{
181
- expectedRevision: ResourceRevision;
182
- id: ResourceRecordId;
183
- idempotencyKey?: IdempotencyKey;
184
- operation: "hard_delete" | "restore" | "soft_delete";
185
- requestId: string;
186
- resourceId: string;
187
- }>;
188
- export type ResourceTransportRequest = ResourceCreateRequest<unknown> | ResourceGetRequest | ResourceLifecycleRequest | ResourceListRequest | ResourceUpdateRequest<unknown>;
3
+ import { IdempotencyKey, PortableResourceSchema, ResourceCapabilities, ResourceCreateRequest, ResourceCursor, ResourceDefinition, ResourceError, ResourceErrorCode, ResourceFilter, ResourceGetRequest, ResourceId, ResourceIdentityField, ResourceJsonValue, ResourceLifecycleRequest, ResourceListQuery, ResourceListRequest, ResourcePagination, ResourcePaginationMode, ResourceRecord, ResourceRecordId, ResourceResult, ResourceRevision, ResourceSort, ResourceTransportRequest, ResourceUpdateRequest } from '@collective-intelligence/external-apps-client-sdk/resources';
4
+
189
5
  export type PrincipalKind = "detached_user" | "service_principal";
190
6
  export type DelegatedSubjectPolicy = "allowed" | "forbidden" | "required";
191
7
  export type AuthorizationRequirement = Readonly<{
@@ -442,6 +258,34 @@ export type PayloadGlobalSourceOptions<Entity = NativeRecord> = DataSourceBaseOp
442
258
  nativeRequest?: (context: Parameters<DataSourceAdapter["execute"]>[1]) => PayloadOpaqueValue;
443
259
  user: (context: Parameters<DataSourceAdapter["execute"]>[1]) => PayloadOpaqueValue;
444
260
  }>;
445
- export declare const definePayloadGatewayPlugin: (hooks: PayloadGatewayHooks) => PayloadGatewayHooks, definePayloadGlobalSource: <Entity = Readonly<Record<string, ResourceJsonValue>>>(options: PayloadGlobalSourceOptions<Entity>) => DataSourceAdapter<Entity>, definePayloadSource: <Entity = Readonly<Record<string, ResourceJsonValue>>>(options: PayloadSourceOptions<Entity>) => DataSourceAdapter<Entity>;
261
+ export declare const definePayloadGatewayPlugin: (hooks: PayloadGatewayHooks) => PayloadGatewayHooks, definePayloadGlobalSource: <Entity = Readonly<Record<string, import("@collective-intelligence/external-apps-client-sdk/resources").ResourceJsonValue>>>(options: PayloadGlobalSourceOptions<Entity>) => DataSourceAdapter<Entity>, definePayloadSource: <Entity = Readonly<Record<string, import("@collective-intelligence/external-apps-client-sdk/resources").ResourceJsonValue>>>(options: PayloadSourceOptions<Entity>) => DataSourceAdapter<Entity>;
262
+
263
+ export {
264
+ IdempotencyKey,
265
+ PortableResourceSchema,
266
+ ResourceCapabilities,
267
+ ResourceCreateRequest,
268
+ ResourceCursor,
269
+ ResourceDefinition,
270
+ ResourceError,
271
+ ResourceErrorCode,
272
+ ResourceFilter,
273
+ ResourceGetRequest,
274
+ ResourceId,
275
+ ResourceIdentityField,
276
+ ResourceJsonValue,
277
+ ResourceLifecycleRequest,
278
+ ResourceListQuery,
279
+ ResourceListRequest,
280
+ ResourcePagination,
281
+ ResourcePaginationMode,
282
+ ResourceRecord,
283
+ ResourceRecordId,
284
+ ResourceResult,
285
+ ResourceRevision,
286
+ ResourceSort,
287
+ ResourceTransportRequest,
288
+ ResourceUpdateRequest,
289
+ };
446
290
 
447
291
  export {};
@@ -1,191 +1,7 @@
1
1
  // Generated by dts-bundle-generator v9.5.1
2
2
 
3
- export type ResourceJsonValue = null | boolean | number | string | readonly ResourceJsonValue[] | Readonly<{
4
- [key: string]: ResourceJsonValue;
5
- }>;
6
- /** Opaque wire identity. Callers must not infer or concatenate its internals. */
7
- export type ResourceId = string;
8
- export type ResourceRecordId = ResourceId;
9
- /** Opaque concurrency token independent from source timestamps. */
10
- export type ResourceRevision = string;
11
- /** Opaque pagination position issued and consumed only by a resource adapter. */
12
- export type ResourceCursor = string;
13
- export type IdempotencyKey = string;
14
- export type ResourceIdentityField = Readonly<{
15
- name: string;
16
- type: "number" | "string";
17
- }>;
18
- export type ResourceCapabilities = Readonly<{
19
- create?: boolean;
20
- /** Common entity deletion is always soft deletion. */
21
- delete?: boolean;
22
- get?: boolean;
23
- hardDelete?: boolean;
24
- includeDeleted?: boolean;
25
- restore?: boolean;
26
- search: true;
27
- softDelete?: boolean;
28
- update?: boolean;
29
- /** File uploads for the File fields of a common entity resource. */
30
- upload?: boolean;
31
- }>;
32
- export type ResourcePaginationMode = "cursor" | "page";
33
- export type PortableResourceSchema = Readonly<Record<string, ResourceJsonValue>>;
34
- export type ResourceDefinition<Entity, Create = Entity, Update = Partial<Entity>> = Readonly<{
35
- capabilities: ResourceCapabilities;
36
- concurrency: "revision";
37
- id: string;
38
- identity: Readonly<{
39
- fields: readonly [
40
- ResourceIdentityField,
41
- ...ResourceIdentityField[]
42
- ];
43
- }>;
44
- query: Readonly<{
45
- filterableFields: readonly string[];
46
- pagination: Readonly<{
47
- modes: readonly ResourcePaginationMode[];
48
- }>;
49
- sortableFields: readonly string[];
50
- textSearchFields?: readonly string[];
51
- }>;
52
- schemas: Readonly<{
53
- create?: PortableResourceSchema;
54
- entity: PortableResourceSchema;
55
- update?: PortableResourceSchema;
56
- }>;
57
- version: string;
58
- /** Portable UI metadata; required/enum/nullability remain in schemas. */
59
- metadata?: Readonly<Record<string, ResourceJsonValue>>;
60
- /** Type-only slots keep definition values portable and serializable. */
61
- readonly __types?: Readonly<{
62
- create: Create;
63
- entity: Entity;
64
- update: Update;
65
- }>;
66
- }>;
67
- export type FilterValue = ResourceJsonValue | readonly ResourceJsonValue[];
68
- /**
69
- * A filter predicate. `field` names a declared filterable field, or a path
70
- * through at most three fields that hold Entity References to a field of
71
- * the last target, such as `company.industry` or
72
- * `contacts.company.parent.industry`. On a field that holds Entity
73
- * References, `is_empty` means no reference. User fields accept identity
74
- * predicates for one ID and `contains_any`, `contains_all`, `contains_none`
75
- * for multiple IDs, plus empty/not-empty aliases. CI validates operators
76
- * against the actual field semantic; UUID shape alone does not declare User.
77
- */
78
- export type ResourceFilter = Readonly<{
79
- field: string;
80
- operator: "contains" | "contains_all" | "contains_any" | "contains_none" | "ends_with" | "eq" | "gt" | "gte" | "in" | "lt" | "lte" | "ne" | "not_in" | "starts_with";
81
- value: FilterValue;
82
- }> | Readonly<{
83
- field: string;
84
- operator: "is_empty" | "is_not_empty" | "is_not_null" | "is_null";
85
- }> | Readonly<{
86
- filters: readonly ResourceFilter[];
87
- operator: "and" | "or";
88
- }> | Readonly<{
89
- filter: ResourceFilter;
90
- operator: "not";
91
- }>;
92
- export type ResourceSort = Readonly<{
93
- direction: "asc" | "desc";
94
- field: string;
95
- }>;
96
- export type ResourcePagination = Readonly<{
97
- mode: "cursor";
98
- cursor?: ResourceCursor;
99
- limit: number;
100
- }> | Readonly<{
101
- mode: "page";
102
- page: number;
103
- pageSize: number;
104
- }>;
105
- export type ResourceListQuery = Readonly<{
106
- filter?: ResourceFilter;
107
- /**
108
- * Include Paths, such as `["company", "contacts.company"]`: relation
109
- * fields whose records each item carries in `included`.
110
- */
111
- include?: readonly string[];
112
- includeDeleted?: boolean;
113
- pagination: ResourcePagination;
114
- sort?: readonly ResourceSort[];
115
- textSearch?: string;
116
- }>;
117
- export type ResourceRecord<Entity> = Readonly<{
118
- deletedAt?: string;
119
- id: ResourceRecordId;
120
- /**
121
- * The records of the read's Include Paths by relation field key: one
122
- * record, or the records of a `many` field in reference order. Untyped:
123
- * the target schemas are CI's.
124
- */
125
- included?: Readonly<Record<string, ResourceJsonValue>>;
126
- revision: ResourceRevision;
127
- /** The keys whose included records were cut to the first 100. */
128
- truncated?: readonly string[];
129
- value: Entity;
130
- }>;
131
- export type ResourceErrorCode = "capability_not_supported" | "conflict" | "forbidden" | "internal" | "invalid_request" | "not_found" | "rate_limited" | "transport_error" | "unauthenticated" | "unavailable" |
132
- /** The CI Organization storage can not take a presigned File upload. */
133
- "upload_not_supported";
134
- export type ResourceError = Readonly<{
135
- code: ResourceErrorCode;
136
- /** Client-observed dispatch outcome; uncertainty never proves rollback. */
137
- outcome?: "not_dispatched" | "rejected" | "uncertain";
138
- details?: Readonly<Record<string, ResourceJsonValue>>;
139
- message: string;
140
- retryable: boolean;
141
- }>;
142
- export type ResourceResult<Value> = Readonly<{
143
- correlationId: string;
144
- ok: true;
145
- value: Value;
146
- }> | Readonly<{
147
- correlationId: string;
148
- error: ResourceError;
149
- ok: false;
150
- }>;
151
- export type ResourceListRequest = Readonly<{
152
- operation: "list";
153
- query: ResourceListQuery;
154
- requestId: string;
155
- resourceId: string;
156
- }>;
157
- export type ResourceGetRequest = Readonly<{
158
- id: ResourceRecordId;
159
- includeDeleted?: boolean;
160
- operation: "get";
161
- requestId: string;
162
- resourceId: string;
163
- }>;
164
- export type ResourceCreateRequest<Create> = Readonly<{
165
- idempotencyKey: IdempotencyKey;
166
- operation: "create";
167
- requestId: string;
168
- resourceId: string;
169
- value: Create;
170
- }>;
171
- export type ResourceUpdateRequest<Update> = Readonly<{
172
- expectedRevision: ResourceRevision;
173
- id: ResourceRecordId;
174
- idempotencyKey?: IdempotencyKey;
175
- operation: "update";
176
- requestId: string;
177
- resourceId: string;
178
- value: Update;
179
- }>;
180
- export type ResourceLifecycleRequest = Readonly<{
181
- expectedRevision: ResourceRevision;
182
- id: ResourceRecordId;
183
- idempotencyKey?: IdempotencyKey;
184
- operation: "hard_delete" | "restore" | "soft_delete";
185
- requestId: string;
186
- resourceId: string;
187
- }>;
188
- export type ResourceTransportRequest = ResourceCreateRequest<unknown> | ResourceGetRequest | ResourceLifecycleRequest | ResourceListRequest | ResourceUpdateRequest<unknown>;
3
+ import { IdempotencyKey, PortableResourceSchema, ResourceCapabilities, ResourceCreateRequest, ResourceCursor, ResourceDefinition, ResourceError, ResourceErrorCode, ResourceFilter, ResourceGetRequest, ResourceId, ResourceIdentityField, ResourceJsonValue, ResourceLifecycleRequest, ResourceListQuery, ResourceListRequest, ResourcePagination, ResourcePaginationMode, ResourceRecord, ResourceRecordId, ResourceResult, ResourceRevision, ResourceSort, ResourceTransportRequest, ResourceUpdateRequest } from '@collective-intelligence/external-apps-client-sdk/resources';
4
+
189
5
  export type PrincipalKind = "detached_user" | "service_principal";
190
6
  export type DelegatedSubjectPolicy = "allowed" | "forbidden" | "required";
191
7
  export type AuthorizationRequirement = Readonly<{
@@ -411,6 +227,34 @@ export type StrapiDataSource<Entity = NativeRecord> = DataSourceAdapter<Entity>
411
227
  }>) => Promise<Entity>;
412
228
  }>;
413
229
  }>;
414
- export declare const defineStrapiGatewayPlugin: (hooks: StrapiGatewayHooks) => StrapiGatewayHooks, defineStrapiSource: <Entity = Readonly<Record<string, ResourceJsonValue>>>(options: StrapiSourceOptions<Entity>) => StrapiDataSource<Entity>;
230
+ export declare const defineStrapiGatewayPlugin: (hooks: StrapiGatewayHooks) => StrapiGatewayHooks, defineStrapiSource: <Entity = Readonly<Record<string, import("@collective-intelligence/external-apps-client-sdk/resources").ResourceJsonValue>>>(options: StrapiSourceOptions<Entity>) => StrapiDataSource<Entity>;
231
+
232
+ export {
233
+ IdempotencyKey,
234
+ PortableResourceSchema,
235
+ ResourceCapabilities,
236
+ ResourceCreateRequest,
237
+ ResourceCursor,
238
+ ResourceDefinition,
239
+ ResourceError,
240
+ ResourceErrorCode,
241
+ ResourceFilter,
242
+ ResourceGetRequest,
243
+ ResourceId,
244
+ ResourceIdentityField,
245
+ ResourceJsonValue,
246
+ ResourceLifecycleRequest,
247
+ ResourceListQuery,
248
+ ResourceListRequest,
249
+ ResourcePagination,
250
+ ResourcePaginationMode,
251
+ ResourceRecord,
252
+ ResourceRecordId,
253
+ ResourceResult,
254
+ ResourceRevision,
255
+ ResourceSort,
256
+ ResourceTransportRequest,
257
+ ResourceUpdateRequest,
258
+ };
415
259
 
416
260
  export {};