@pitcher/canvas-ui 2025.12.18-75050 → 2025.12.19-075910-beta

package/lib/sdk/api/HighLevelApi.d.ts

@@ -240,6 +240,7 @@ export declare function createHighLevelApi(options?: ApiOptions): {
     crmSmartDeleteObjects(payload: import('../payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
     crmCreate(payload: import('../payload.types').CRMCreatePayload): Promise<any>;
     crmUpsert(payload: import('../payload.types').CRMUpsertPayload): Promise<any>;
+    crmDescribe(payload: import('../payload.types').CRMDescribePayload): Promise<any>;
     getFolders(payload: import('../payload.types').FolderListRequest): Promise<import('../../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../../main.lib').FolderRetrieve["id"];

package/lib/sdk/api/modules/query.d.ts

@@ -1,4 +1,4 @@
-import { QueryPayload, CRMQueryPayload, UpsertCRMObjectsPayload, CRMSmartObjectValidationRulesPayload, CRMSmartObjectMetadataPayload, CRMSmartDeleteObjectsPayload, CRMCreatePayload, CRMUpsertPayload } from '../../payload.types';
+import { QueryPayload, CRMQueryPayload, UpsertCRMObjectsPayload, CRMSmartObjectValidationRulesPayload, CRMSmartObjectMetadataPayload, CRMSmartDeleteObjectsPayload, CRMCreatePayload, CRMUpsertPayload, CRMDescribePayload } from '../../payload.types';
 export declare function query(payload: QueryPayload): Promise<any>;
 export declare function crmQuery(payload: CRMQueryPayload): Promise<any>;
 /**
@@ -153,3 +153,23 @@ export declare function crmCreate(payload: CRMCreatePayload): Promise<any>;
  * })
  */
 export declare function crmUpsert(payload: CRMUpsertPayload): Promise<any>;
+/**
+ * Retrieves metadata/describe for a CRM object (Web only).
+ * Uses Salesforce REST API to fetch object metadata including fields and picklist values.
+ *
+ * @param {CRMDescribePayload} payload - The describe payload containing the sobject name.
+ * @returns {Promise<any>} - Promise resolving with the object metadata including fields and picklist values.
+ * @throws {Error} - Throws an error if the payload is invalid.
+ *
+ * @example
+ * // Web only method to get CRM object metadata.
+ * api.crmDescribe({ sobject: 'Account' })
+ *   .then(metadata => {
+ *     // Access fields
+ *     console.log(metadata.fields)
+ *     // Access picklist values for a specific field
+ *     const industryField = metadata.fields.find(f => f.name === 'Industry')
+ *     console.log(industryField.picklistValues)
+ *   })
+ */
+export declare function crmDescribe(payload: CRMDescribePayload): Promise<any>;

package/lib/sdk/main.d.ts

@@ -311,6 +311,7 @@ export declare function useApi(options?: ApiOptions): {
     crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
     crmCreate(payload: import('./payload.types').CRMCreatePayload): Promise<any>;
     crmUpsert(payload: import('./payload.types').CRMUpsertPayload): Promise<any>;
+    crmDescribe(payload: import('./payload.types').CRMDescribePayload): Promise<any>;
     getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../main.lib').FolderRetrieve["id"];
@@ -596,6 +597,7 @@ export declare function useApi(options?: ApiOptions): {
         crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
         crmCreate(payload: import('./payload.types').CRMCreatePayload): Promise<any>;
         crmUpsert(payload: import('./payload.types').CRMUpsertPayload): Promise<any>;
+        crmDescribe(payload: import('./payload.types').CRMDescribePayload): Promise<any>;
         getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
         getFolder(payload?: {
             id: import('../main.lib').FolderRetrieve["id"];
@@ -817,6 +819,7 @@ export declare function useApi(options?: ApiOptions): {
     crmSmartDeleteObjects(payload: import('./payload.types').CRMSmartDeleteObjectsPayload): Promise<any>;
     crmCreate(payload: import('./payload.types').CRMCreatePayload): Promise<any>;
     crmUpsert(payload: import('./payload.types').CRMUpsertPayload): Promise<any>;
+    crmDescribe(payload: import('./payload.types').CRMDescribePayload): Promise<any>;
     getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../main.lib').FolderRetrieve["id"];

package/lib/sdk/payload.types.d.ts

@@ -404,3 +404,17 @@ export interface CRMUpsertPayload {
      */
     service?: CRMServiceType;
 }
+/**
+ * Payload for retrieving CRM object metadata/describe (Web only).
+ * Uses Salesforce REST API to fetch object metadata including fields and picklist values.
+ */
+export interface CRMDescribePayload {
+    /**
+     * The Salesforce object type to describe (e.g., 'Account', 'Contact', 'Opportunity').
+     */
+    sobject: string;
+    /**
+     * Optional name of the CRM service to use.
+     */
+    service?: CRMServiceType;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/canvas-ui",
-  "version": "2025.12.18-75050",
+  "version": "2025.12.19-075910-beta",
   "type": "module",
   "publishConfig": {
     "access": "public"