@segmentstream-cloud/app 0.13.1 → 0.13.2

package/README.md

@@ -263,7 +263,7 @@ Records, action inputs and action results are typed from the ontology:
 const { items, nextCursor } = await segmentstream.ontology.lead.find({
   where: { status: { in: ["new", "contacted"] } },
   orderBy: [{ field: "createdAt", direction: "desc" }],
-  include: { owner: true },
+  include: ["owner"],
   limit: 20,
 });
 const lead = await segmentstream.ontology.lead.get(id);
@@ -279,6 +279,8 @@ const { result, validation, edits } = await segmentstream.ontology.lead.actions.
 
 - `find` sends the query as URL parameters, `query` as a JSON body; both return
   `{ items, nextCursor }`. Pass `nextCursor` as `after` for the next page.
+- `include` adds related records under their relationship names: list the names,
+  `["owner", "tags"]`, or pass `{ owner: true, tags: true }`.
 - `actions.<name>(input, { validateOnly })` posts `{ input, options }` and returns
   `{ result, validation, edits }`. Generated actions are there too
   (`actions.create`, `update`, `delete`), and `action(name, input)` runs any action by

package/dist/ontology-wire.d.ts

@@ -46,6 +46,11 @@ export declare function encodeWhere(input: {
     readonly getCatalog: () => Promise<WireCatalog>;
 }): Promise<Where | undefined>;
 export declare function queryToWire(query: OntologyQuery): unknown;
+/**
+ * `include` with snake_case names, as an object: a list of names, `["assignedOwner"]`, becomes
+ * `{ assigned_owner: true }`, which every version of the ontology service accepts.
+ */
+export declare function includeToWire(include: NonNullable<OntologyQuery["include"]>): Readonly<Record<string, unknown>>;
 /** Decode record fields and included relationships without descending into JSON properties. */
 export declare function recordFromWire<A = unknown>(value: unknown, entity: string, catalog: WireCatalog): A;
 export declare function actionInputToWire(input: unknown, entity: string, action: string, catalog: WireCatalog): unknown;

package/dist/ontology-wire.js

@@ -127,14 +127,23 @@ export function queryToWire(query) {
         ...(orderBy === undefined
             ? {}
             : { order_by: orderBy.map((order) => ({ ...order, field: toSnakeCase(order.field) })) }),
-        ...(query.include === undefined
-            ? {}
-            : {
-                include: Object.fromEntries(Object.entries(query.include).map(([name, value]) => [toSnakeCase(name), value])),
-            }),
+        ...(query.include === undefined ? {} : { include: includeToWire(query.include) }),
         ...(where === undefined ? {} : { where }),
     };
 }
+/**
+ * `include` with snake_case names, as an object: a list of names, `["assignedOwner"]`, becomes
+ * `{ assigned_owner: true }`, which every version of the ontology service accepts.
+ */
+export function includeToWire(include) {
+    const entries = isIncludeList(include)
+        ? include.map((name) => [name, true])
+        : Object.entries(include);
+    return Object.fromEntries(entries.map(([name, value]) => [toSnakeCase(name), value]));
+}
+function isIncludeList(include) {
+    return Array.isArray(include);
+}
 function selectToWire(value, property) {
     if (property?.type !== "select") {
         return value;

package/dist/ontology.d.ts

@@ -53,8 +53,10 @@ export interface OrderBy<Field extends string = string> {
 export interface OntologyQuery<Row = JsonRecord> {
     readonly where?: Where;
     readonly orderBy?: ReadonlyArray<OrderBy<keyof Row & string>>;
-    /** Related records to add to each record, by relationship name. */
-    readonly include?: {
+    /**
+     * Related records to add to each record, by relationship name: `["owner"]` or `{ owner: true }`.
+     */
+    readonly include?: ReadonlyArray<string> | {
         readonly [relationship: string]: true;
     };
     /** The `nextCursor` of the previous page. */

package/dist/ontology.js

@@ -1,5 +1,5 @@
 import { SegmentStreamApiError, apiErrorFrom, readJson } from "./errors.js";
-import { actionInputToWire, encodeWhere, editsFromWire, queryToWire, recordFromWire, responseFromWire, } from "./ontology-wire.js";
+import { actionInputToWire, encodeWhere, editsFromWire, includeToWire, queryToWire, recordFromWire, responseFromWire, } from "./ontology-wire.js";
 import { toCamelCase, toReversibleCamelCase, toSnakeCase } from "./ontology-names.js";
 const ENTITY_NAME = /^[a-z][a-zA-Z0-9]*(?:_[a-z0-9]+)*$/;
 const ACTION_NAME = ENTITY_NAME;
@@ -198,9 +198,11 @@ export function findParameters(query) {
             .join(","));
     }
     if (query.include !== undefined) {
-        const relationships = Object.keys(query.include).filter((name) => query.include?.[name] === true);
+        const relationships = Object.entries(includeToWire(query.include))
+            .filter(([, included]) => included === true)
+            .map(([name]) => name);
         if (relationships.length > 0) {
-            search.set("include", relationships.map(toSnakeCase).join(","));
+            search.set("include", relationships.join(","));
         }
     }
     if (query.after !== undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@segmentstream-cloud/app",
-  "version": "0.13.1",
+  "version": "0.13.2",
   "description": "Sign-in, users, permissions, the ontology client and warehouse data access for SegmentStream workspace apps built with Next.js.",
   "license": "Apache-2.0",
   "author": "SegmentStream",