@pitcher/js-api 1.28.0 → 1.30.0

package/lib/util/soql.util.d.ts

@@ -1,4 +1,40 @@
+/**
+ * Escape a user-typed search term for interpolation into a SOQL LIKE pattern or
+ * SOSL FIND term. Escapes the LIKE wildcards `%` and `_` in addition to quotes
+ * and control characters — do NOT use it for equality/IN comparison values,
+ * where escaping the wildcards would change the compared value; use
+ * `soqlLiteral` / `soqlIn` / `soqlEq` for those.
+ */
 export declare const escapeSoqlString: (input: string) => string;
+/**
+ * Quote a value as a SOQL string literal for equality/IN comparisons, e.g.
+ * `WHERE Id = ${soqlLiteral(id)}`. Escapes backslashes (first, so escaped
+ * quotes aren't doubled), single quotes, and newline/tab control characters.
+ * Deliberately does NOT escape the LIKE wildcards `%`/`_` — inside an equality
+ * literal those are ordinary characters, and escaping them would change the
+ * compared value. For LIKE patterns / SOSL FIND terms use `escapeSoqlString`.
+ */
+export declare const soqlLiteral: (value: string) => string;
+/**
+ * Build the parenthesized value list for a SOQL IN clause, e.g.
+ * `WHERE Id IN ${soqlIn(ids)}`. An empty input yields `('')` — valid SOQL that
+ * matches no record — so callers don't need an empty-array branch.
+ */
+export declare const soqlIn: (values: string[]) => string;
+/**
+ * True when `name` is a plain SObject field API name (letters, digits,
+ * underscores, leading letter). Field identifiers cannot be escaped as string
+ * literals, so anything interpolated as a field/relationship name must pass
+ * this gate (relationship paths like `Contact__r.Id` need each dotted segment
+ * validated separately).
+ */
+export declare const isSoqlFieldIdentifier: (name: string) => boolean;
+/**
+ * Build a `field = 'value'` SOQL condition with the field validated via
+ * `isSoqlFieldIdentifier` and the value quoted via `soqlLiteral`. Throws on an
+ * invalid field name — field identifiers cannot be escaped, only rejected.
+ */
+export declare const soqlEq: (field: string, value: string) => string;
 export declare const convertToSosl: (soqlQuery: string, searchString: string, searchInField?: string) => string | null;
 export interface AccountSortPriority {
     field: string;

package/lib/util/user.d.ts

@@ -1,3 +1,4 @@
+import { User } from '../../types/openapi';
 export declare const splitUserName: (name?: string) => {
     first_name: string;
     last_name: string;
@@ -51,4 +52,21 @@ export declare function pickTemplateUserFields<T extends Record<string, any>>(us
  * without per-app code changes.
  */
 export declare function flattenUserProperties<T extends Record<string, any>>(user: T | null | undefined, schema?: CustomUserPropertiesSchema | null): T | null;
+export interface CrmServiceLink {
+    /** Absolute URL opening the CRM web UI (e.g. the Salesforce custom domain). */
+    url: string;
+    /** Brand display name shown as the menu label — brand names are not translated. */
+    label: string;
+    /** Font Awesome icon name (without the `fa-` prefix). */
+    icon: string;
+    faType: 'fab' | 'far';
+    provider: string;
+}
+/**
+ * Resolve a browser link to the user's connected CRM from `connected_services`
+ * (the `/users/me/` response — `urls` is only populated on the `me`/`token` actions).
+ * Returns the first CRM service with a usable URL, or `null` when the user has
+ * no CRM connection to link to.
+ */
+export declare function getCrmServiceLink(user: Pick<User, 'connected_services'> | null | undefined): CrmServiceLink | null;
 export {};

package/lib/util/user.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.28.0",
+  "version": "1.30.0",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",

package/types/openapi/index.d.ts

@@ -134,7 +134,6 @@ export type { InstanceUpdateRequest } from './models/InstanceUpdateRequest';
 export type { Invitation } from './models/Invitation';
 export type { InvitationRequest } from './models/InvitationRequest';
 export { InvitationStatusEnum } from './models/InvitationStatusEnum';
-export { LanguageEnum } from './models/LanguageEnum';
 export type { MetadataTemplate } from './models/MetadataTemplate';
 export type { MetadataTemplateField } from './models/MetadataTemplateField';
 export type { MetadataTemplateFieldRequest } from './models/MetadataTemplateFieldRequest';

package/types/openapi/models/DeletedEnvironment.d.ts

@@ -2,7 +2,6 @@ import { MiniUser } from './MiniUser';
 export type DeletedEnvironment = {
     readonly id: number;
     name: string;
-    next_environment_ids?: Array<number>;
     color?: string | null;
     readonly created_at: string;
     readonly created_by: MiniUser;

package/types/openapi/models/Environment.d.ts

@@ -2,7 +2,6 @@ import { MiniUser } from './MiniUser';
 export type Environment = {
     readonly id: number;
     name: string;
-    next_environment_ids?: Array<number>;
     color?: string | null;
     readonly created_at: string;
     readonly created_by: MiniUser;

package/types/openapi/models/EnvironmentRequest.d.ts

@@ -1,5 +1,4 @@
 export type EnvironmentRequest = {
     name: string;
-    next_environment_ids?: Array<number>;
     color?: string | null;
 };

package/types/openapi/models/File.d.ts

@@ -23,6 +23,8 @@ export type File = {
     readonly original_url: string | null;
     readonly thumbnail_url: string | null;
     download_type?: DownloadTypeEnum;
+    /** iOS bridge only — not returned by the REST API. */
+    readonly downloaded_at?: string | null;
     readonly zip_size: number | null;
     readonly zip_url: string | null;
     access_type?: AccessTypeEnum;

package/types/openapi/models/FileRetrieve.d.ts

@@ -26,6 +26,8 @@ export type FileRetrieve = {
     readonly original_url: string | null;
     readonly thumbnail_url: string | null;
     download_type?: DownloadTypeEnum;
+    /** iOS bridge only — not returned by the REST API. */
+    readonly downloaded_at?: string | null;
     readonly zip_size: number | null;
     readonly zip_url: string | null;
     access_type?: AccessTypeEnum;

package/types/openapi/models/PatchedEnvironmentRequest.d.ts

@@ -1,5 +1,4 @@
 export type PatchedEnvironmentRequest = {
     name?: string;
-    next_environment_ids?: Array<number>;
     color?: string | null;
 };

package/types/openapi/models/PatchedUserRequest.d.ts

@@ -1,10 +1,9 @@
-import { LanguageEnum } from './LanguageEnum';
 import { UserRoleEnum } from './UserRoleEnum';
 export type PatchedUserRequest = {
     first_name?: string;
     last_name?: string;
     role?: UserRoleEnum;
-    language?: LanguageEnum;
+    language?: string;
     preferred_username?: string;
     timezone?: string;
     tags?: Array<string> | null;

package/types/openapi/models/User.d.ts

@@ -1,5 +1,4 @@
 import { ConnectedService } from './ConnectedService';
-import { LanguageEnum } from './LanguageEnum';
 import { UserRoleEnum } from './UserRoleEnum';
 export type User = {
     readonly id: number;
@@ -16,7 +15,7 @@ export type User = {
     readonly deactivated_at: string | null;
     readonly activated_at: string | null;
     readonly is_active: boolean;
-    language?: LanguageEnum;
+    language?: string;
     readonly connected_services: Array<ConnectedService>;
     preferred_username?: string;
     readonly picture: string | null;

package/types/openapi/models/UserRequest.d.ts

@@ -1,10 +1,9 @@
-import { LanguageEnum } from './LanguageEnum';
 import { UserRoleEnum } from './UserRoleEnum';
 export type UserRequest = {
     first_name?: string;
     last_name?: string;
     role?: UserRoleEnum;
-    language?: LanguageEnum;
+    language?: string;
     preferred_username?: string;
     timezone?: string;
     tags?: Array<string> | null;

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

@@ -1,8 +0,0 @@
-export type Language = [
-    string,
-    string
-];
-/**
- * Fetches available languages for the logged-in user
- */
-export declare function getLanguages(): Promise<Language[]>;

package/types/openapi/models/LanguageEnum.d.ts

@@ -1,12 +0,0 @@
-/**
- * * `en` - English
- * * `de` - Deutsch
- * * `pl` - Polski
- * * `tr` - Türkçe
- */
-export declare enum LanguageEnum {
-    EN = "en",
-    DE = "de",
-    PL = "pl",
-    TR = "tr"
-}