@collective-intelligence/external-apps-server-sdk 0.1.35 → 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.
@@ -1,276 +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 ResourceListResult<Entity> = Readonly<{
132
- items: readonly ResourceRecord<Entity>[];
133
- nextCursor?: ResourceCursor;
134
- pagination: "cursor";
135
- }> | Readonly<{
136
- items: readonly ResourceRecord<Entity>[];
137
- page: number;
138
- pageSize: number;
139
- pagination: "page";
140
- totalItems: number;
141
- totalPages: number;
142
- }>;
143
- export type ResourceErrorCode = "capability_not_supported" | "conflict" | "forbidden" | "internal" | "invalid_request" | "not_found" | "rate_limited" | "transport_error" | "unauthenticated" | "unavailable" |
144
- /** The CI Organization storage can not take a presigned File upload. */
145
- "upload_not_supported";
146
- export type ResourceError = Readonly<{
147
- code: ResourceErrorCode;
148
- /** Client-observed dispatch outcome; uncertainty never proves rollback. */
149
- outcome?: "not_dispatched" | "rejected" | "uncertain";
150
- details?: Readonly<Record<string, ResourceJsonValue>>;
151
- message: string;
152
- retryable: boolean;
153
- }>;
154
- export type ResourceResult<Value> = Readonly<{
155
- correlationId: string;
156
- ok: true;
157
- value: Value;
158
- }> | Readonly<{
159
- correlationId: string;
160
- error: ResourceError;
161
- ok: false;
162
- }>;
163
- export type ResourceListRequest = Readonly<{
164
- operation: "list";
165
- query: ResourceListQuery;
166
- requestId: string;
167
- resourceId: string;
168
- }>;
169
- export type ResourceGetRequest = Readonly<{
170
- id: ResourceRecordId;
171
- includeDeleted?: boolean;
172
- operation: "get";
173
- requestId: string;
174
- resourceId: string;
175
- }>;
176
- export type ResourceCreateRequest<Create> = Readonly<{
177
- idempotencyKey: IdempotencyKey;
178
- operation: "create";
179
- requestId: string;
180
- resourceId: string;
181
- value: Create;
182
- }>;
183
- export type ResourceUpdateRequest<Update> = Readonly<{
184
- expectedRevision: ResourceRevision;
185
- id: ResourceRecordId;
186
- idempotencyKey?: IdempotencyKey;
187
- operation: "update";
188
- requestId: string;
189
- resourceId: string;
190
- value: Update;
191
- }>;
192
- export type ResourceLifecycleRequest = Readonly<{
193
- expectedRevision: ResourceRevision;
194
- id: ResourceRecordId;
195
- idempotencyKey?: IdempotencyKey;
196
- operation: "hard_delete" | "restore" | "soft_delete";
197
- requestId: string;
198
- resourceId: string;
199
- }>;
200
- export type ResourceTransportRequest = ResourceCreateRequest<unknown> | ResourceGetRequest | ResourceLifecycleRequest | ResourceListRequest | ResourceUpdateRequest<unknown>;
201
- export type ResourceMutationInput<Value> = Readonly<{
202
- expectedRevision: ResourceRevision;
203
- id: ResourceRecordId;
204
- idempotencyKey?: IdempotencyKey;
205
- value: Value;
206
- }>;
207
- export type ResourceLifecycleInput = Readonly<{
208
- expectedRevision: ResourceRevision;
209
- id: ResourceRecordId;
210
- idempotencyKey?: IdempotencyKey;
211
- }>;
212
- export type ResourceCreateInput<Value> = Readonly<{
213
- idempotencyKey: IdempotencyKey;
214
- value: Value;
215
- }>;
216
- /** Common entity operations. Generic resource lifecycle/cursor APIs remain separate. */
217
- export type EntityOperation = "list_members" | "list" | "get" | "create" | "update" | "delete" | "upload";
218
- export type EntityListQuery = Omit<ResourceListQuery, "pagination" | "includeDeleted"> & Readonly<{
219
- pagination: Extract<ResourcePagination, {
220
- mode: "page";
221
- }>;
222
- }>;
223
- export type EntityPage<Value> = Extract<ResourceListResult<Value>, {
224
- pagination: "page";
225
- }>;
226
- /** Member schemas are resolved by CI, independently of the parent resource. */
227
- export type EntityMemberValue = Readonly<Record<string, ResourceJsonValue>>;
228
- export type EntityCreateInput<Value> = ResourceCreateInput<Value>;
229
- export type EntityUpdateInput<Patch> = ResourceMutationInput<Patch> & Readonly<{
230
- idempotencyKey: IdempotencyKey;
231
- }>;
232
- export type EntityDeleteInput = ResourceLifecycleInput & Readonly<{
233
- idempotencyKey: IdempotencyKey;
234
- }>;
235
- /** A File upload request for one File field of the entity schema. */
236
- export type EntityUploadInput = Readonly<{
237
- field: string;
238
- filename: string;
239
- mimeType: string;
240
- }>;
241
- /** PUT the file bytes to `url` with `headers`; then write `{ upload: uploadId }`. */
242
- export type EntityUploadSlot = Readonly<{
243
- headers: Readonly<Record<string, string>>;
244
- method: "PUT";
245
- uploadId: string;
246
- url: string;
247
- }>;
248
- export type EntityRequestIdentity = Readonly<{
249
- requestId: string;
250
- resourceId: string;
251
- }>;
252
- export type EntityRequest<Create = unknown, Patch = unknown> = EntityRequestIdentity & (Readonly<{
253
- operation: "list";
254
- query: EntityListQuery;
255
- }> | Readonly<{
256
- operation: "list_members";
257
- parentId: ResourceRecordId;
258
- field: string;
259
- query: EntityListQuery;
260
- }> | Readonly<{
261
- operation: "get";
262
- id: ResourceRecordId;
263
- include?: readonly string[];
264
- }> | (Readonly<{
265
- operation: "create";
266
- }> & EntityCreateInput<Create>) | (Readonly<{
267
- operation: "update";
268
- }> & EntityUpdateInput<Patch>) | (Readonly<{
269
- operation: "delete";
270
- }> & EntityDeleteInput) | (Readonly<{
271
- operation: "upload";
272
- }> & EntityUploadInput));
273
- export type EntityOperationResult<Value, Operation extends EntityOperation> = Operation extends "list_members" ? EntityPage<EntityMemberValue> : Operation extends "list" ? EntityPage<Value> : Operation extends "upload" ? EntityUploadSlot : ResourceRecord<Value>;
3
+ import { EntityCreateInput, EntityDeleteInput, EntityListQuery, EntityMemberValue, EntityOperation, EntityOperationResult, EntityPage, EntityRequest, EntityUpdateInput, EntityUploadInput, EntityUploadSlot, IdempotencyKey, PortableResourceSchema, ResourceCapabilities, ResourceCreateInput, ResourceCreateRequest, ResourceCursor, ResourceDefinition, ResourceError, ResourceErrorCode, ResourceFilter, ResourceGetRequest, ResourceId, ResourceIdentityField, ResourceJsonValue, ResourceLifecycleInput, ResourceLifecycleRequest, ResourceListQuery, ResourceListRequest, ResourceListResult, ResourceMutationInput, ResourcePagination, ResourcePaginationMode, ResourceRecord, ResourceRecordId, ResourceResult, ResourceRevision, ResourceSort, ResourceTransportRequest, ResourceUpdateRequest } from '@collective-intelligence/external-apps-client-sdk/resources';
4
+
274
5
  /** Application login identities are separate from gateway machine callers. */
275
6
  export type ApplicationUserIdentity = Readonly<{
276
7
  kind: "local_user";
@@ -455,16 +186,16 @@ export type EntityHttpRoute = {
455
186
  export declare const createResourceHttpHandler: <Value, Create = Value, Patch = Partial<Value>>(options: ResourceHttpHandlerOptions<Value, Create, Patch>) => (request: Request) => Promise<Response>;
456
187
  export declare const matchEntityHttpRoute: (pathname: string, basePath: string) => EntityHttpRoute | null;
457
188
  export declare const defineCrudResource: <Entity, Create = Entity, Update = Partial<Entity>>(input: Readonly<{
458
- definition: ResourceDefinition<Entity, Create, Update>;
189
+ definition: import("@collective-intelligence/external-apps-client-sdk").ResourceDefinition<Entity, Create, Update>;
459
190
  repository: CrudRepository<Entity, Create, Update>;
460
191
  authorization: GatewayResourceAuthorization;
461
192
  }>) => CrudResource<Entity, Create, Update>;
462
193
  export declare const defineEntityResource: <Value, Create = Value, Patch = Partial<Value>>(input: Readonly<{
463
- definition: ResourceDefinition<Value, Create, Patch>;
194
+ definition: import("@collective-intelligence/external-apps-client-sdk").ResourceDefinition<Value, Create, Patch>;
464
195
  repository: EntityRepository<Value, Create, Patch>;
465
196
  }>) => EntityResourceDefinition<Value, Create, Patch>;
466
197
  export declare const defineCiEntityResource: <Value, Create = Value, Patch = Partial<Value>>(input: Readonly<{
467
- definition: ResourceDefinition<Value, Create, Patch>;
198
+ definition: import("@collective-intelligence/external-apps-client-sdk").ResourceDefinition<Value, Create, Patch>;
468
199
  tenantUrl: string;
469
200
  schemaFqn: string;
470
201
  organizationId: string;
@@ -475,7 +206,47 @@ declare const ResourceRepositoryError$1: typeof ResourceRepositoryError;
475
206
  type ResourceRepositoryError$1 = ResourceRepositoryError;
476
207
 
477
208
  export {
209
+ EntityCreateInput,
210
+ EntityDeleteInput,
211
+ EntityListQuery,
212
+ EntityMemberValue,
213
+ EntityOperation,
214
+ EntityOperationResult,
215
+ EntityPage,
216
+ EntityRequest,
217
+ EntityUpdateInput,
218
+ EntityUploadInput,
219
+ EntityUploadSlot,
220
+ IdempotencyKey,
221
+ PortableResourceSchema,
222
+ ResourceCapabilities,
223
+ ResourceCreateInput,
224
+ ResourceCreateRequest,
225
+ ResourceCursor,
226
+ ResourceDefinition,
227
+ ResourceError,
228
+ ResourceErrorCode,
229
+ ResourceFilter,
230
+ ResourceGetRequest,
231
+ ResourceId,
232
+ ResourceIdentityField,
233
+ ResourceJsonValue,
234
+ ResourceLifecycleInput,
235
+ ResourceLifecycleRequest,
236
+ ResourceListQuery,
237
+ ResourceListRequest,
238
+ ResourceListResult,
239
+ ResourceMutationInput,
240
+ ResourcePagination,
241
+ ResourcePaginationMode,
242
+ ResourceRecord,
243
+ ResourceRecordId,
478
244
  ResourceRepositoryError$1 as ResourceRepositoryError,
245
+ ResourceResult,
246
+ ResourceRevision,
247
+ ResourceSort,
248
+ ResourceTransportRequest,
249
+ ResourceUpdateRequest,
479
250
  };
480
251
 
481
252
  export {};