@objectstack/client 1.0.11 → 1.0.12

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @objectstack/client@1.0.11 build /home/runner/work/spec/spec/packages/client
+> @objectstack/client@1.0.12 build /home/runner/work/spec/spec/packages/client
 > tsup --config ../../tsup.config.ts
 
 CLI Building entry: src/index.ts
@@ -10,13 +10,13 @@
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.js     21.60 KB
-CJS dist/index.js.map 42.30 KB
-CJS ⚡️ Build success in 41ms
-ESM dist/index.mjs     20.44 KB
-ESM dist/index.mjs.map 42.24 KB
-ESM ⚡️ Build success in 42ms
+CJS dist/index.js     25.81 KB
+CJS dist/index.js.map 50.45 KB
+CJS ⚡️ Build success in 48ms
+ESM dist/index.mjs     24.66 KB
+ESM dist/index.mjs.map 50.39 KB
+ESM ⚡️ Build success in 51ms
 DTS Build start
-DTS ⚡️ Build success in 4063ms
-DTS dist/index.d.mts 10.28 KB
-DTS dist/index.d.ts  10.28 KB
+DTS ⚡️ Build success in 4299ms
+DTS dist/index.d.mts 13.88 KB
+DTS dist/index.d.ts  13.88 KB

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @objectstack/client
 
+## 1.0.12
+
+### Patch Changes
+
+- chore: add Vercel deployment configs, simplify console runtime configuration
+- Updated dependencies
+  - @objectstack/spec@1.0.12
+  - @objectstack/core@1.0.12
+
 ## 1.0.11
 
 ### Patch Changes

package/dist/index.d.mts

@@ -159,8 +159,42 @@ interface QueryOptions {
     groupBy?: string[];
 }
 interface PaginatedResult<T = any> {
-    value: T[];
-    count: number;
+    /** @deprecated Use `records` — aligned with FindDataResponseSchema */
+    value?: T[];
+    /** Spec-compliant: array of matching records */
+    records: T[];
+    /** @deprecated Use `total` — aligned with FindDataResponseSchema */
+    count?: number;
+    /** Total number of matching records (if requested) */
+    total?: number;
+    /** The object name */
+    object?: string;
+    /** Whether more records are available */
+    hasMore?: boolean;
+}
+/** Spec: GetDataResponseSchema */
+interface GetDataResult<T = any> {
+    object: string;
+    id: string;
+    record: T;
+}
+/** Spec: CreateDataResponseSchema */
+interface CreateDataResult<T = any> {
+    object: string;
+    id: string;
+    record: T;
+}
+/** Spec: UpdateDataResponseSchema */
+interface UpdateDataResult<T = any> {
+    object: string;
+    id: string;
+    record: T;
+}
+/** Spec: DeleteDataResponseSchema */
+interface DeleteDataResult {
+    object: string;
+    id: string;
+    deleted: boolean;
 }
 interface StandardError {
     code: StandardErrorCode;
@@ -200,6 +234,7 @@ declare class ObjectStackClient {
             automation?: string | undefined;
             analytics?: string | undefined;
             hub?: string | undefined;
+            ui?: string | undefined;
         } | undefined;
     }>;
     /**
@@ -214,33 +249,36 @@ declare class ObjectStackClient {
         /**
          * Get all items of a specific metadata type
          * @param type - Metadata type name (e.g., 'object', 'plugin')
+         * @param options - Optional filters (e.g., packageId to scope by package)
          */
-        getItems: (type: string) => Promise<GetMetaItemsResponse>;
+        getItems: (type: string, options?: {
+            packageId?: string;
+        }) => Promise<GetMetaItemsResponse>;
         /**
          * Get a specific object definition by name
          * @deprecated Use `getItem('object', name)` instead for consistency with spec protocol
          * @param name - Object name (snake_case identifier)
          */
-        getObject: (name: string) => Promise<any>;
+        getObject: (name: string) => Promise<unknown>;
         /**
          * Get a specific metadata item by type and name
          * @param type - Metadata type (e.g., 'object', 'plugin')
          * @param name - Item name (snake_case identifier)
          */
-        getItem: (type: string, name: string) => Promise<any>;
+        getItem: (type: string, name: string) => Promise<unknown>;
         /**
          * Save a metadata item
          * @param type - Metadata type (e.g., 'object', 'plugin')
          * @param name - Item name
          * @param item - The metadata content to save
          */
-        saveItem: (type: string, name: string, item: any) => Promise<any>;
+        saveItem: (type: string, name: string, item: any) => Promise<unknown>;
         /**
          * Get object metadata with cache support
          * Supports ETag-based conditional requests for efficient caching
          */
         getCached: (name: string, cacheOptions?: MetadataCacheRequest) => Promise<MetadataCacheResponse>;
-        getView: (object: string, type?: "list" | "form") => Promise<any>;
+        getView: (object: string, type?: "list" | "form") => Promise<unknown>;
     };
     /**
      * Analytics Services
@@ -262,6 +300,73 @@ declare class ObjectStackClient {
             install: (pkg: string, version?: string) => Promise<any>;
         };
     };
+    /**
+     * Package Management Services
+     *
+     * Manages the lifecycle of installed packages.
+     * A package (ManifestSchema) is the unit of installation.
+     * An app (AppSchema) is a UI navigation definition within a package.
+     * A package may contain 0, 1, or many apps, or be a pure functionality plugin.
+     *
+     * Endpoints:
+     * - GET    /packages               → list installed packages
+     * - GET    /packages/:id           → get package details
+     * - POST   /packages               → install a package
+     * - DELETE  /packages/:id           → uninstall a package
+     * - PATCH  /packages/:id/enable    → enable a package
+     * - PATCH  /packages/:id/disable   → disable a package
+     */
+    packages: {
+        /**
+         * List all installed packages with optional filters.
+         */
+        list: (filters?: {
+            status?: string;
+            type?: string;
+            enabled?: boolean;
+        }) => Promise<{
+            packages: any[];
+            total: number;
+        }>;
+        /**
+         * Get a specific installed package by its ID (reverse domain identifier).
+         */
+        get: (id: string) => Promise<{
+            package: any;
+        }>;
+        /**
+         * Install a new package from its manifest.
+         */
+        install: (manifest: any, options?: {
+            settings?: Record<string, any>;
+            enableOnInstall?: boolean;
+        }) => Promise<{
+            package: any;
+            message?: string;
+        }>;
+        /**
+         * Uninstall a package by its ID.
+         */
+        uninstall: (id: string) => Promise<{
+            id: string;
+            success: boolean;
+            message?: string;
+        }>;
+        /**
+         * Enable a disabled package.
+         */
+        enable: (id: string) => Promise<{
+            package: any;
+            message?: string;
+        }>;
+        /**
+         * Disable an installed package.
+         */
+        disable: (id: string) => Promise<{
+            package: any;
+            message?: string;
+        }>;
+    };
     /**
      * Authentication Services
      */
@@ -293,10 +398,10 @@ declare class ObjectStackClient {
          */
         query: <T = any>(object: string, query: Partial<QueryAST>) => Promise<PaginatedResult<T>>;
         find: <T = any>(object: string, options?: QueryOptions) => Promise<PaginatedResult<T>>;
-        get: <T = any>(object: string, id: string) => Promise<T>;
-        create: <T = any>(object: string, data: Partial<T>) => Promise<T>;
+        get: <T = any>(object: string, id: string) => Promise<GetDataResult<T>>;
+        create: <T = any>(object: string, data: Partial<T>) => Promise<CreateDataResult<T>>;
         createMany: <T = any>(object: string, data: Partial<T>[]) => Promise<T[]>;
-        update: <T = any>(object: string, id: string, data: Partial<T>) => Promise<T>;
+        update: <T = any>(object: string, id: string, data: Partial<T>) => Promise<UpdateDataResult<T>>;
         /**
          * Batch update multiple records
          * Uses the new BatchUpdateRequest schema with full control over options
@@ -310,9 +415,7 @@ declare class ObjectStackClient {
             id: string;
             data: Partial<T>;
         }>, options?: BatchOptions) => Promise<BatchUpdateResponse>;
-        delete: (object: string, id: string) => Promise<{
-            success: boolean;
-        }>;
+        delete: (object: string, id: string) => Promise<DeleteDataResult>;
         /**
          * Delete multiple records by IDs
          */
@@ -322,6 +425,14 @@ declare class ObjectStackClient {
      * Private Helpers
      */
     private isFilterAST;
+    /**
+     * Unwrap the standard REST API response envelope.
+     * The HTTP layer wraps responses as `{ success: boolean, data: T, meta? }`
+     * (see BaseResponseSchema in contract.zod.ts).
+     * This method strips the envelope and returns the inner `data` payload
+     * so callers receive the spec-level type (e.g. GetMetaTypesResponse).
+     */
+    private unwrapResponse;
     private fetch;
     /**
      * Get the conventional route path for a given API endpoint type
@@ -330,4 +441,4 @@ declare class ObjectStackClient {
     private getRoute;
 }
 
-export { type ClientConfig, type DiscoveryResult, FilterBuilder, ObjectStackClient, type PaginatedResult, QueryBuilder, type QueryOptions, type StandardError, createFilter, createQuery };
+export { type ClientConfig, type CreateDataResult, type DeleteDataResult, type DiscoveryResult, FilterBuilder, type GetDataResult, ObjectStackClient, type PaginatedResult, QueryBuilder, type QueryOptions, type StandardError, type UpdateDataResult, createFilter, createQuery };

package/dist/index.d.ts

@@ -159,8 +159,42 @@ interface QueryOptions {
     groupBy?: string[];
 }
 interface PaginatedResult<T = any> {
-    value: T[];
-    count: number;
+    /** @deprecated Use `records` — aligned with FindDataResponseSchema */
+    value?: T[];
+    /** Spec-compliant: array of matching records */
+    records: T[];
+    /** @deprecated Use `total` — aligned with FindDataResponseSchema */
+    count?: number;
+    /** Total number of matching records (if requested) */
+    total?: number;
+    /** The object name */
+    object?: string;
+    /** Whether more records are available */
+    hasMore?: boolean;
+}
+/** Spec: GetDataResponseSchema */
+interface GetDataResult<T = any> {
+    object: string;
+    id: string;
+    record: T;
+}
+/** Spec: CreateDataResponseSchema */
+interface CreateDataResult<T = any> {
+    object: string;
+    id: string;
+    record: T;
+}
+/** Spec: UpdateDataResponseSchema */
+interface UpdateDataResult<T = any> {
+    object: string;
+    id: string;
+    record: T;
+}
+/** Spec: DeleteDataResponseSchema */
+interface DeleteDataResult {
+    object: string;
+    id: string;
+    deleted: boolean;
 }
 interface StandardError {
     code: StandardErrorCode;
@@ -200,6 +234,7 @@ declare class ObjectStackClient {
             automation?: string | undefined;
             analytics?: string | undefined;
             hub?: string | undefined;
+            ui?: string | undefined;
         } | undefined;
     }>;
     /**
@@ -214,33 +249,36 @@ declare class ObjectStackClient {
         /**
          * Get all items of a specific metadata type
          * @param type - Metadata type name (e.g., 'object', 'plugin')
+         * @param options - Optional filters (e.g., packageId to scope by package)
          */
-        getItems: (type: string) => Promise<GetMetaItemsResponse>;
+        getItems: (type: string, options?: {
+            packageId?: string;
+        }) => Promise<GetMetaItemsResponse>;
         /**
          * Get a specific object definition by name
          * @deprecated Use `getItem('object', name)` instead for consistency with spec protocol
          * @param name - Object name (snake_case identifier)
          */
-        getObject: (name: string) => Promise<any>;
+        getObject: (name: string) => Promise<unknown>;
         /**
          * Get a specific metadata item by type and name
          * @param type - Metadata type (e.g., 'object', 'plugin')
          * @param name - Item name (snake_case identifier)
          */
-        getItem: (type: string, name: string) => Promise<any>;
+        getItem: (type: string, name: string) => Promise<unknown>;
         /**
          * Save a metadata item
          * @param type - Metadata type (e.g., 'object', 'plugin')
          * @param name - Item name
          * @param item - The metadata content to save
          */
-        saveItem: (type: string, name: string, item: any) => Promise<any>;
+        saveItem: (type: string, name: string, item: any) => Promise<unknown>;
         /**
          * Get object metadata with cache support
          * Supports ETag-based conditional requests for efficient caching
          */
         getCached: (name: string, cacheOptions?: MetadataCacheRequest) => Promise<MetadataCacheResponse>;
-        getView: (object: string, type?: "list" | "form") => Promise<any>;
+        getView: (object: string, type?: "list" | "form") => Promise<unknown>;
     };
     /**
      * Analytics Services
@@ -262,6 +300,73 @@ declare class ObjectStackClient {
             install: (pkg: string, version?: string) => Promise<any>;
         };
     };
+    /**
+     * Package Management Services
+     *
+     * Manages the lifecycle of installed packages.
+     * A package (ManifestSchema) is the unit of installation.
+     * An app (AppSchema) is a UI navigation definition within a package.
+     * A package may contain 0, 1, or many apps, or be a pure functionality plugin.
+     *
+     * Endpoints:
+     * - GET    /packages               → list installed packages
+     * - GET    /packages/:id           → get package details
+     * - POST   /packages               → install a package
+     * - DELETE  /packages/:id           → uninstall a package
+     * - PATCH  /packages/:id/enable    → enable a package
+     * - PATCH  /packages/:id/disable   → disable a package
+     */
+    packages: {
+        /**
+         * List all installed packages with optional filters.
+         */
+        list: (filters?: {
+            status?: string;
+            type?: string;
+            enabled?: boolean;
+        }) => Promise<{
+            packages: any[];
+            total: number;
+        }>;
+        /**
+         * Get a specific installed package by its ID (reverse domain identifier).
+         */
+        get: (id: string) => Promise<{
+            package: any;
+        }>;
+        /**
+         * Install a new package from its manifest.
+         */
+        install: (manifest: any, options?: {
+            settings?: Record<string, any>;
+            enableOnInstall?: boolean;
+        }) => Promise<{
+            package: any;
+            message?: string;
+        }>;
+        /**
+         * Uninstall a package by its ID.
+         */
+        uninstall: (id: string) => Promise<{
+            id: string;
+            success: boolean;
+            message?: string;
+        }>;
+        /**
+         * Enable a disabled package.
+         */
+        enable: (id: string) => Promise<{
+            package: any;
+            message?: string;
+        }>;
+        /**
+         * Disable an installed package.
+         */
+        disable: (id: string) => Promise<{
+            package: any;
+            message?: string;
+        }>;
+    };
     /**
      * Authentication Services
      */
@@ -293,10 +398,10 @@ declare class ObjectStackClient {
          */
         query: <T = any>(object: string, query: Partial<QueryAST>) => Promise<PaginatedResult<T>>;
         find: <T = any>(object: string, options?: QueryOptions) => Promise<PaginatedResult<T>>;
-        get: <T = any>(object: string, id: string) => Promise<T>;
-        create: <T = any>(object: string, data: Partial<T>) => Promise<T>;
+        get: <T = any>(object: string, id: string) => Promise<GetDataResult<T>>;
+        create: <T = any>(object: string, data: Partial<T>) => Promise<CreateDataResult<T>>;
         createMany: <T = any>(object: string, data: Partial<T>[]) => Promise<T[]>;
-        update: <T = any>(object: string, id: string, data: Partial<T>) => Promise<T>;
+        update: <T = any>(object: string, id: string, data: Partial<T>) => Promise<UpdateDataResult<T>>;
         /**
          * Batch update multiple records
          * Uses the new BatchUpdateRequest schema with full control over options
@@ -310,9 +415,7 @@ declare class ObjectStackClient {
             id: string;
             data: Partial<T>;
         }>, options?: BatchOptions) => Promise<BatchUpdateResponse>;
-        delete: (object: string, id: string) => Promise<{
-            success: boolean;
-        }>;
+        delete: (object: string, id: string) => Promise<DeleteDataResult>;
         /**
          * Delete multiple records by IDs
          */
@@ -322,6 +425,14 @@ declare class ObjectStackClient {
      * Private Helpers
      */
     private isFilterAST;
+    /**
+     * Unwrap the standard REST API response envelope.
+     * The HTTP layer wraps responses as `{ success: boolean, data: T, meta? }`
+     * (see BaseResponseSchema in contract.zod.ts).
+     * This method strips the envelope and returns the inner `data` payload
+     * so callers receive the spec-level type (e.g. GetMetaTypesResponse).
+     */
+    private unwrapResponse;
     private fetch;
     /**
      * Get the conventional route path for a given API endpoint type
@@ -330,4 +441,4 @@ declare class ObjectStackClient {
     private getRoute;
 }
 
-export { type ClientConfig, type DiscoveryResult, FilterBuilder, ObjectStackClient, type PaginatedResult, QueryBuilder, type QueryOptions, type StandardError, createFilter, createQuery };
+export { type ClientConfig, type CreateDataResult, type DeleteDataResult, type DiscoveryResult, FilterBuilder, type GetDataResult, ObjectStackClient, type PaginatedResult, QueryBuilder, type QueryOptions, type StandardError, type UpdateDataResult, createFilter, createQuery };