@objectstack/client 3.3.1 → 4.0.0

package/dist/index.js

@@ -221,12 +221,20 @@ var QueryBuilder = class {
     return this;
   }
   /**
-   * Skip records (for pagination)
+   * Skip records (for pagination).
+   * @deprecated Prefer `.offset()` for alignment with Spec canonical field names.
    */
   skip(count) {
     this.query.offset = count;
     return this;
   }
+  /**
+   * Offset records (for pagination) — canonical alias for `.skip()`
+   */
+  offset(count) {
+    this.query.offset = count;
+    return this;
+  }
   /**
    * Paginate results
    */
@@ -1172,7 +1180,7 @@ var ObjectStackClient = class {
        * List feed items for a record
        */
       list: async (object, recordId, options) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const params = new URLSearchParams();
         if (options?.type) params.set("type", options.type);
         if (options?.limit) params.set("limit", String(options.limit));
@@ -1185,7 +1193,7 @@ var ObjectStackClient = class {
        * Create a new feed item (comment, note, task, etc.)
        */
       create: async (object, recordId, data) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/feed`, {
           method: "POST",
           body: JSON.stringify(data)
@@ -1196,7 +1204,7 @@ var ObjectStackClient = class {
        * Update an existing feed item
        */
       update: async (object, recordId, feedId, data) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/feed/${encodeURIComponent(feedId)}`, {
           method: "PUT",
           body: JSON.stringify(data)
@@ -1207,7 +1215,7 @@ var ObjectStackClient = class {
        * Delete a feed item
        */
       delete: async (object, recordId, feedId) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/feed/${encodeURIComponent(feedId)}`, {
           method: "DELETE"
         });
@@ -1217,7 +1225,7 @@ var ObjectStackClient = class {
        * Add an emoji reaction to a feed item
        */
       addReaction: async (object, recordId, feedId, emoji) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/feed/${encodeURIComponent(feedId)}/reactions`, {
           method: "POST",
           body: JSON.stringify({ emoji })
@@ -1228,7 +1236,7 @@ var ObjectStackClient = class {
        * Remove an emoji reaction from a feed item
        */
       removeReaction: async (object, recordId, feedId, emoji) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/feed/${encodeURIComponent(feedId)}/reactions/${encodeURIComponent(emoji)}`, {
           method: "DELETE"
         });
@@ -1238,7 +1246,7 @@ var ObjectStackClient = class {
        * Pin a feed item to the top of the timeline
        */
       pin: async (object, recordId, feedId) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/feed/${encodeURIComponent(feedId)}/pin`, {
           method: "POST"
         });
@@ -1248,7 +1256,7 @@ var ObjectStackClient = class {
        * Unpin a feed item
        */
       unpin: async (object, recordId, feedId) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/feed/${encodeURIComponent(feedId)}/pin`, {
           method: "DELETE"
         });
@@ -1258,7 +1266,7 @@ var ObjectStackClient = class {
        * Star (bookmark) a feed item
        */
       star: async (object, recordId, feedId) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/feed/${encodeURIComponent(feedId)}/star`, {
           method: "POST"
         });
@@ -1268,7 +1276,7 @@ var ObjectStackClient = class {
        * Unstar a feed item
        */
       unstar: async (object, recordId, feedId) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/feed/${encodeURIComponent(feedId)}/star`, {
           method: "DELETE"
         });
@@ -1278,7 +1286,7 @@ var ObjectStackClient = class {
        * Search feed items
        */
       search: async (object, recordId, query, options) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const params = new URLSearchParams();
         params.set("query", query);
         if (options?.type) params.set("type", options.type);
@@ -1294,7 +1302,7 @@ var ObjectStackClient = class {
        * Get field-level changelog for a record
        */
       getChangelog: async (object, recordId, options) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const params = new URLSearchParams();
         if (options?.field) params.set("field", options.field);
         if (options?.actorId) params.set("actorId", options.actorId);
@@ -1310,7 +1318,7 @@ var ObjectStackClient = class {
        * Subscribe to record notifications
        */
       subscribe: async (object, recordId, options) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/subscribe`, {
           method: "POST",
           body: JSON.stringify(options || {})
@@ -1321,7 +1329,7 @@ var ObjectStackClient = class {
        * Unsubscribe from record notifications
        */
       unsubscribe: async (object, recordId) => {
-        const route = this.getRoute("feed");
+        const route = this.getRoute("data");
         const res = await this.fetch(`${this.baseUrl}${route}/${encodeURIComponent(object)}/${encodeURIComponent(recordId)}/subscribe`, {
           method: "DELETE"
         });
@@ -1344,23 +1352,40 @@ var ObjectStackClient = class {
         });
         return this.unwrapResponse(res);
       },
+      /**
+       * @deprecated Use `data.query()` with standard QueryAST parameters instead.
+       * This method uses legacy parameter names. Internally adapts to HTTP GET params.
+       */
       find: async (object, options = {}) => {
         const route = this.getRoute("data");
         const queryParams = new URLSearchParams();
-        if (options.top) queryParams.set("top", options.top.toString());
-        if (options.skip) queryParams.set("skip", options.skip.toString());
-        if (options.sort) {
-          if (Array.isArray(options.sort) && typeof options.sort[0] === "object") {
-            queryParams.set("sort", JSON.stringify(options.sort));
+        const v2 = options;
+        const normalizedOptions = {};
+        if ("where" in options || "fields" in options || "orderBy" in options || "offset" in options) {
+          if (v2.where) normalizedOptions.filter = v2.where;
+          if (v2.fields) normalizedOptions.select = v2.fields;
+          if (v2.orderBy) normalizedOptions.sort = v2.orderBy;
+          if (v2.limit != null) normalizedOptions.top = v2.limit;
+          if (v2.offset != null) normalizedOptions.skip = v2.offset;
+          if (v2.aggregations) normalizedOptions.aggregations = v2.aggregations;
+          if (v2.groupBy) normalizedOptions.groupBy = v2.groupBy;
+        } else {
+          Object.assign(normalizedOptions, options);
+        }
+        if (normalizedOptions.top) queryParams.set("top", normalizedOptions.top.toString());
+        if (normalizedOptions.skip) queryParams.set("skip", normalizedOptions.skip.toString());
+        if (normalizedOptions.sort) {
+          if (Array.isArray(normalizedOptions.sort) && typeof normalizedOptions.sort[0] === "object") {
+            queryParams.set("sort", JSON.stringify(normalizedOptions.sort));
           } else {
-            const sortVal = Array.isArray(options.sort) ? options.sort.join(",") : options.sort;
+            const sortVal = Array.isArray(normalizedOptions.sort) ? normalizedOptions.sort.join(",") : normalizedOptions.sort;
             queryParams.set("sort", sortVal);
           }
         }
-        if (options.select) {
-          queryParams.set("select", options.select.join(","));
+        if (normalizedOptions.select) {
+          queryParams.set("select", normalizedOptions.select.join(","));
         }
-        const filterValue = options.filter ?? options.filters;
+        const filterValue = normalizedOptions.filter ?? normalizedOptions.filters;
         if (filterValue) {
           if (this.isFilterAST(filterValue) || Array.isArray(filterValue)) {
             queryParams.set("filter", JSON.stringify(filterValue));
@@ -1372,11 +1397,11 @@ var ObjectStackClient = class {
             });
           }
         }
-        if (options.aggregations) {
-          queryParams.set("aggregations", JSON.stringify(options.aggregations));
+        if (normalizedOptions.aggregations) {
+          queryParams.set("aggregations", JSON.stringify(normalizedOptions.aggregations));
         }
-        if (options.groupBy) {
-          queryParams.set("groupBy", options.groupBy.join(","));
+        if (normalizedOptions.groupBy) {
+          queryParams.set("groupBy", normalizedOptions.groupBy.join(","));
         }
         const res = await this.fetch(`${this.baseUrl}${route}/${object}?${queryParams.toString()}`);
         return this.unwrapResponse(res);
@@ -1496,8 +1521,8 @@ var ObjectStackClient = class {
         this.logger.debug("Standard discovery probe failed", { error: e.message });
       }
       if (!data) {
-        const fallbackUrl = `${this.baseUrl}/api/v1`;
-        this.logger.debug("Falling back to legacy discovery", { url: fallbackUrl });
+        const fallbackUrl = `${this.baseUrl}/api/v1/discovery`;
+        this.logger.debug("Falling back to standard discovery endpoint", { url: fallbackUrl });
         const res = await this.fetchImpl(fallbackUrl);
         if (!res.ok) {
           throw new Error(`Failed to connect to ${fallbackUrl}: ${res.statusText}`);
@@ -1524,9 +1549,19 @@ var ObjectStackClient = class {
    * Well-known capability flags discovered from the server.
    * Returns undefined if the client has not yet connected or the server
    * did not include capabilities in its discovery response.
+   *
+   * The server may return capabilities in hierarchical format
+   * `{ key: { enabled: boolean } }` or flat boolean format `{ key: boolean }`.
+   * This getter normalizes both to flat `WellKnownCapabilities`.
    */
   get capabilities() {
-    return this.discoveryInfo?.capabilities;
+    const raw = this.discoveryInfo?.capabilities;
+    if (!raw) return void 0;
+    const result = {};
+    for (const [key, value] of Object.entries(raw)) {
+      result[key] = typeof value === "object" && value !== null ? !!value.enabled : !!value;
+    }
+    return result;
   }
   /**
    * Private Helpers
@@ -1598,12 +1633,16 @@ var ObjectStackClient = class {
    * ObjectStack uses standard conventions: /api/v1/data, /api/v1/meta, /api/v1/ui
    */
   getRoute(type) {
-    if (this.discoveryInfo?.routes && this.discoveryInfo.routes[type]) {
-      return this.discoveryInfo.routes[type];
+    const routes = this.discoveryInfo?.routes;
+    if (routes) {
+      const key = type;
+      const discovered = routes[key];
+      if (discovered) return discovered;
     }
     const routeMap = {
       data: "/api/v1/data",
       metadata: "/api/v1/meta",
+      discovery: "/api/v1/discovery",
       ui: "/api/v1/ui",
       auth: "/api/v1/auth",
       analytics: "/api/v1/analytics",
@@ -1617,7 +1656,8 @@ var ObjectStackClient = class {
       notifications: "/api/v1/notifications",
       ai: "/api/v1/ai",
       i18n: "/api/v1/i18n",
-      feed: "/api/v1/data"
+      feed: "/api/v1/feed",
+      graphql: "/graphql"
     };
     return routeMap[type] || `/api/v1/${type}`;
   }