@collective-intelligence/external-apps-server-sdk 0.1.9 → 0.1.11

package/dist/resources.d.ts

@@ -65,13 +65,21 @@ export type ResourceDefinition<Entity, Create = Entity, Update = Partial<Entity>
 	}>;
 }>;
 export type FilterValue = ResourceJsonValue | readonly ResourceJsonValue[];
+/**
+ * A filter predicate. `field` names a declared filterable field, or a path
+ * through at most three fields that hold Entity References to a field of
+ * the last target, such as `company.industry` or
+ * `contacts.company.parent.industry`. On a field that holds Entity
+ * References, `is_empty` means no reference, and `contains_any` and
+ * `contains_all` compare the ids of a field that holds many.
+ */
 export type ResourceFilter = Readonly<{
 	field: string;
-	operator: "contains" | "ends_with" | "eq" | "gt" | "gte" | "in" | "lt" | "lte" | "ne" | "not_in" | "starts_with";
+	operator: "contains" | "contains_all" | "contains_any" | "ends_with" | "eq" | "gt" | "gte" | "in" | "lt" | "lte" | "ne" | "not_in" | "starts_with";
 	value: FilterValue;
 }> | Readonly<{
 	field: string;
-	operator: "is_not_null" | "is_null";
+	operator: "is_empty" | "is_not_null" | "is_null";
 }> | Readonly<{
 	filters: readonly ResourceFilter[];
 	operator: "and" | "or";
@@ -94,6 +102,11 @@ export type ResourcePagination = Readonly<{
 }>;
 export type ResourceListQuery = Readonly<{
 	filter?: ResourceFilter;
+	/**
+	 * Include Paths, such as `["company", "contacts.company"]`: relation
+	 * fields whose records each item carries in `included`.
+	 */
+	include?: readonly string[];
 	includeDeleted?: boolean;
 	pagination: ResourcePagination;
 	sort?: readonly ResourceSort[];
@@ -102,7 +115,15 @@ export type ResourceListQuery = Readonly<{
 export type ResourceRecord<Entity> = Readonly<{
 	deletedAt?: string;
 	id: ResourceRecordId;
+	/**
+	 * The records of the read's Include Paths by relation field key: one
+	 * record, or the records of a `many` field in reference order. Untyped:
+	 * the target schemas are CI's.
+	 */
+	included?: Readonly<Record<string, ResourceJsonValue>>;
 	revision: ResourceRevision;
+	/** The keys whose included records were cut to the first 100. */
+	truncated?: readonly string[];
 	value: Entity;
 }>;
 export type ResourceListResult<Entity> = Readonly<{
@@ -191,7 +212,7 @@ export type ResourceCreateInput<Value> = Readonly<{
 	value: Value;
 }>;
 /** Common entity operations. Generic resource lifecycle/cursor APIs remain separate. */
-export type EntityOperation = "list" | "get" | "create" | "update" | "delete" | "upload";
+export type EntityOperation = "list_members" | "list" | "get" | "create" | "update" | "delete" | "upload";
 export type EntityListQuery = Omit<ResourceListQuery, "pagination" | "includeDeleted"> & Readonly<{
 	pagination: Extract<ResourcePagination, {
 		mode: "page";
@@ -200,6 +221,8 @@ export type EntityListQuery = Omit<ResourceListQuery, "pagination" | "includeDel
 export type EntityPage<Value> = Extract<ResourceListResult<Value>, {
 	pagination: "page";
 }>;
+/** Member schemas are resolved by CI, independently of the parent resource. */
+export type EntityMemberValue = Readonly<Record<string, ResourceJsonValue>>;
 export type EntityCreateInput<Value> = ResourceCreateInput<Value>;
 export type EntityUpdateInput<Patch> = ResourceMutationInput<Patch> & Readonly<{
 	idempotencyKey: IdempotencyKey;
@@ -227,9 +250,15 @@ export type EntityRequestIdentity = Readonly<{
 export type EntityRequest<Create = unknown, Patch = unknown> = EntityRequestIdentity & (Readonly<{
 	operation: "list";
 	query: EntityListQuery;
+}> | Readonly<{
+	operation: "list_members";
+	parentId: ResourceRecordId;
+	field: string;
+	query: EntityListQuery;
 }> | Readonly<{
 	operation: "get";
 	id: ResourceRecordId;
+	include?: readonly string[];
 }> | (Readonly<{
 	operation: "create";
 }> & EntityCreateInput<Create>) | (Readonly<{
@@ -239,7 +268,7 @@ export type EntityRequest<Create = unknown, Patch = unknown> = EntityRequestIden
 }> & EntityDeleteInput) | (Readonly<{
 	operation: "upload";
 }> & EntityUploadInput));
-export type EntityOperationResult<Value, Operation extends EntityOperation> = Operation extends "list" ? EntityPage<Value> : Operation extends "upload" ? EntityUploadSlot : ResourceRecord<Value>;
+export type EntityOperationResult<Value, Operation extends EntityOperation> = Operation extends "list_members" ? EntityPage<EntityMemberValue> : Operation extends "list" ? EntityPage<Value> : Operation extends "upload" ? EntityUploadSlot : ResourceRecord<Value>;
 /** Application login identities are separate from gateway machine callers. */
 export type ApplicationUserIdentity = Readonly<{
 	kind: "local_user";
@@ -259,13 +288,15 @@ export type ApplicationUserIdentity = Readonly<{
  * and request/correlation IDs are deliberately not part of that logical identity.
  */
 export type EntityInvocationContext = Readonly<{
+	/** The App Permissions of the user's effective roles on the app. */
+	appPermissions: readonly string[];
 	applicationId: string;
 	issuer: string;
 	organizationId: string;
 	resourceId: string;
+	/** The user's effective roles on the app, read from CI at this lookup. */
 	roles: readonly string[];
 	scopes: readonly string[];
-	groupIds: readonly string[];
 	user: ApplicationUserIdentity;
 }>;
 export type PrincipalKind = "detached_user" | "service_principal";
@@ -405,6 +436,9 @@ export type ResourceHttpHandlerOptions<Value = unknown, Create = Value, Patch =
 }>;
 export type EntityHttpRoute = {
 	readonly kind: "search";
+} | {
+	readonly kind: "relation_members";
+	readonly id: string;
 } | {
 	readonly kind: "collection";
 } | {