sfobjects-basic-client 1.2.0 → 1.2.4

package/dist/index.d.ts

@@ -214,11 +214,27 @@ export declare class SfBasicClientReadError extends Error {
 export declare function isPlainObject(value: unknown): value is Record<string, any>;
 export declare function constructSoql<OI>(_cfg: SfObjCfgIndex<OI>): (objName: string, from: string, select: (string | {})[], where?: string | Record<string, any>, orderBy?: Record<string, any>, limit?: number) => string;
 export declare function getSfObject<OI>(_cfg: SfObjCfgIndex<OI>, o?: SfClientOptions): <N extends KeyOf<OI>>(from: N, _conn: ISfConnection) => SfObjActions<OI, N>;
-export declare const getSfObjects: <OI>(cfg: SfObjCfgIndex<OI>) => (conn: ISfConnection, options?: SfClientOptions) => { [N in KeyOf<OI>]: SfObjActions<OI, N>; } & {
-    __getObject: <N_1 extends KeyOf<OI>>(from: N_1) => SfObjActions<OI, N_1>;
+export type SfObjectsIndex<OI> = {
+    [N in KeyOf<OI>]: SfObjActions<OI, N>;
+} & {
+    __getObject: <N extends KeyOf<OI>>(from: N) => SfObjActions<OI, N>;
+};
+export type SfObjectFlat<O> = {
+    [K in KeyOf<O>]: NonNullable<O[K]> extends SfPrimitiveType ? O[K] : NonNullable<O[K]> extends ChildTable<infer CO> ? SfObjectFlat<CO> : SfObjectFlat<NonNullable<O[K]>>;
+} & {
+    ['{...}']: O;
 };
+export declare const getSfObjects: <OI>(cfg: SfObjCfgIndex<OI>) => (conn: ISfConnection, options?: SfClientOptions) => SfObjectsIndex<OI>;
 export declare const sfObject: <OI, N extends KeyOf<OI>>(cfg: SfObjCfgIndex<OI>, n: N) => {
     info: SfObjCfgIndex<OI>[N];
     select: <S extends SfRootSelect<OI, N>>(s: S[]) => S[];
+    wrapSelection: <S extends SfRootSelect<OI, N>>(value: S[]) => {
+        value: S[];
+        asProjection: (v: any) => SfRootSelectProjection<OI, N, S>;
+        asFlatProjection: (v: any) => SfObjectFlat<SfRootSelectProjection<OI, N, S>>;
+    };
+    toSuperShortId: (id: string) => string;
+    normalizeId: (id: string) => string;
+    idEquals: (a: string, b: string) => boolean;
 };
 export {};

package/dist/index.js

@@ -25,6 +25,7 @@ exports.sfObject = exports.getSfObjects = exports.SfBasicClientReadError = expor
 exports.isPlainObject = isPlainObject;
 exports.constructSoql = constructSoql;
 exports.getSfObject = getSfObject;
+const utils_1 = require("./utils");
 // Where
 const OP_KEY_AND = '__and';
 const OP_KEY_OR = '__or';
@@ -315,5 +316,16 @@ const getSfObjects = (cfg) => (conn, options) => {
     return Object.assign(Object.assign({}, Object.keys(cfg).reduce((p, n) => (Object.assign(Object.assign({}, p), { [n]: __getObject(n) })), {})), { __getObject });
 };
 exports.getSfObjects = getSfObjects;
-const sfObject = (cfg, n) => ({ info: cfg[n], select: (s) => s });
+const sfObject = (cfg, n) => ({
+    info: cfg[n],
+    select: (s) => s,
+    wrapSelection: (value) => ({
+        value,
+        asProjection: (v) => v,
+        asFlatProjection: (v) => v
+    }),
+    toSuperShortId: (id) => (0, utils_1.toSuperShortId)(id, cfg[n].objectPrefix),
+    normalizeId: (id) => (0, utils_1.normalizeId)(id, cfg[n].objectPrefix),
+    idEquals: (a, b) => (0, utils_1.idEquals)(a, b, cfg[n].objectPrefix)
+});
 exports.sfObject = sfObject;

package/dist/utils.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Convert an 18-char Salesforce ID into a 12-char "super-short" ID.
+ * Removes:
+ *  - 3-char object prefix
+ *  - 3-char checksum at the end
+ *
+ * Structure:
+ * 18-char ID = PPP + XXXXXXXXXXXX + CCC
+ * Result = 12 chars (XXXXXXXXXXXX)
+ */
+export declare function toSuperShortId(id: string, prefix: string): string;
+/**
+ * Normalize any Salesforce ID (12, 15, 18 chars) to full 18-char format.
+ */
+export declare function normalizeId(id: string, prefix: string): string;
+/**
+ * Compare two Salesforce IDs, allowing either 15 or 18 char formats.
+ */
+export declare function idEquals(a: string, b: string, prefix: string): boolean;

package/dist/utils.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toSuperShortId = toSuperShortId;
+exports.normalizeId = normalizeId;
+exports.idEquals = idEquals;
+function toLongId(shortId) {
+    if (shortId.length !== 15)
+        return shortId; // assume it's already 18 or invalid
+    const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ012345";
+    const chunks = [
+        shortId.substring(0, 5),
+        shortId.substring(5, 10),
+        shortId.substring(10, 15)
+    ];
+    let suffix = "";
+    for (const chunk of chunks) {
+        let flags = 0;
+        for (let i = 0; i < chunk.length; i++) {
+            const c = chunk[i];
+            if (c >= "A" && c <= "Z") {
+                flags |= 1 << i;
+            }
+        }
+        suffix += chars[flags];
+    }
+    return shortId + suffix;
+}
+/**
+ * Convert an 18-char Salesforce ID into a 12-char "super-short" ID.
+ * Removes:
+ *  - 3-char object prefix
+ *  - 3-char checksum at the end
+ *
+ * Structure:
+ * 18-char ID = PPP + XXXXXXXXXXXX + CCC
+ * Result = 12 chars (XXXXXXXXXXXX)
+ */
+function toSuperShortId(id, prefix) {
+    if (!id) {
+        throw new Error("Salesforce ID cannot be empty.");
+    }
+    const trimmed = id.trim();
+    if (trimmed.length !== 18) {
+        throw new Error("Input must be an 18-character Salesforce ID.");
+    }
+    if (trimmed.substring(0, 2) !== prefix) {
+        throw new Error(`Id must contain prefix '${prefix}'`);
+    }
+    // Remove prefix (first 3) and checksum (last 3)
+    return trimmed.substring(3, 15); // characters 3 through 14 (12 chars)
+}
+/**
+ * Turn a 12-char super-short ID into a full 18-char ID using the given object prefix.
+ */
+function expandSuperShort(body12, prefix) {
+    if (body12.length !== 12) {
+        throw new Error("Super-short ID must be 12 characters.");
+    }
+    if (prefix.length !== 3) {
+        throw new Error("Object prefix must be 3 characters.");
+    }
+    const id15 = prefix + body12; // prefix + 12-char body = 15-char ID
+    return toLongId(id15);
+}
+/**
+ * Normalize any Salesforce ID (12, 15, 18 chars) to full 18-char format.
+ */
+function normalizeId(id, prefix) {
+    if (!id)
+        return "";
+    const trimmed = id.trim();
+    if (trimmed.length === 18) {
+        return trimmed;
+    }
+    if (trimmed.length === 15) {
+        return toLongId(trimmed);
+    }
+    if (trimmed.length === 12) {
+        return expandSuperShort(trimmed, prefix);
+    }
+    throw new Error(`Unsupported Salesforce ID length: ${trimmed.length}`);
+}
+/**
+ * Compare two Salesforce IDs, allowing either 15 or 18 char formats.
+ */
+function idEquals(a, b, prefix) {
+    if (!a || !b)
+        return false;
+    return normalizeId(a, prefix) === normalizeId(b, prefix);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sfobjects-basic-client",
-  "version": "1.2.0",
+  "version": "1.2.4",
   "description": "Basic Salesforce Client to use together with sfobjects-to-typescript lib",
   "license": "ISC",
   "author": "Murad Aliyev",  

package/src/index.ts

@@ -1,5 +1,7 @@
 // utility
 
+import { idEquals, normalizeId, toSuperShortId } from "./utils";
+
 type WrapNull<T> = T extends null ? null : never;
 type KeyOf<O> = (keyof O) & string;
 type SfPrimitiveType = string | number | boolean | bigint;
@@ -705,8 +707,16 @@ export function getSfObject<OI>(_cfg: SfObjCfgIndex<OI>, o?: SfClientOptions) {
 
 }
 
+export type SfObjectsIndex<OI> = { [N in KeyOf<OI>]: SfObjActions<OI, N> } & { __getObject: <N extends KeyOf<OI>>(from: N) => SfObjActions<OI, N> };
+
+export type SfObjectFlat<O> = {
+    [K in KeyOf<O>]:
+    NonNullable<O[K]> extends SfPrimitiveType ? O[K] :
+    NonNullable<O[K]> extends ChildTable<infer CO> ? SfObjectFlat<CO> :
+    SfObjectFlat<NonNullable<O[K]>>
+} & { ['{...}']: O }
 
-export const getSfObjects = <OI>(cfg: SfObjCfgIndex<OI>) => (conn: ISfConnection, options?: SfClientOptions) => {
+export const getSfObjects = <OI>(cfg: SfObjCfgIndex<OI>) => (conn: ISfConnection, options?: SfClientOptions): SfObjectsIndex<OI> => {
 
     const __getObject = <N extends KeyOf<OI>>(from: N) => getSfObject<OI>(cfg, options)(from, conn);
 
@@ -716,4 +726,15 @@ export const getSfObjects = <OI>(cfg: SfObjCfgIndex<OI>) => (conn: ISfConnection
     };
 }
 
-export const sfObject = <OI, N extends KeyOf<OI>>(cfg: SfObjCfgIndex<OI>, n: N) => ({ info: cfg[n], select: <S extends SfRootSelect<OI, N>>(s: S[]) => s });
+export const sfObject = <OI, N extends KeyOf<OI>>(cfg: SfObjCfgIndex<OI>, n: N) => ({
+    info: cfg[n],
+    select: <S extends SfRootSelect<OI, N>>(s: S[]) => s,
+    wrapSelection: <S extends SfRootSelect<OI, N>>(value: S[]) => ({
+        value,
+        asProjection: (v: any) => v as SfRootSelectProjection<OI, N, S>,
+        asFlatProjection: (v: any) => v as SfObjectFlat<SfRootSelectProjection<OI, N, S>>
+    }),
+    toSuperShortId: (id: string) => toSuperShortId(id, cfg[n].objectPrefix),
+    normalizeId: (id: string) => normalizeId(id, cfg[n].objectPrefix),
+    idEquals: (a: string, b: string) => idEquals(a, b, cfg[n].objectPrefix)
+});

package/src/utils.ts

@@ -0,0 +1,106 @@
+function toLongId(shortId: string): string {
+
+    if (shortId.length !== 15) return shortId; // assume it's already 18 or invalid
+
+    const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ012345";
+
+    const chunks = [
+        shortId.substring(0, 5),
+        shortId.substring(5, 10),
+        shortId.substring(10, 15)
+    ];
+
+    let suffix = "";
+
+    for (const chunk of chunks) {
+        let flags = 0;
+        for (let i = 0; i < chunk.length; i++) {
+            const c = chunk[i];
+            if (c >= "A" && c <= "Z") {
+                flags |= 1 << i;
+            }
+        }
+
+        suffix += chars[flags];
+    }
+
+    return shortId + suffix;
+}
+
+
+/**
+ * Convert an 18-char Salesforce ID into a 12-char "super-short" ID.
+ * Removes:
+ *  - 3-char object prefix
+ *  - 3-char checksum at the end
+ *
+ * Structure:
+ * 18-char ID = PPP + XXXXXXXXXXXX + CCC
+ * Result = 12 chars (XXXXXXXXXXXX)
+ */
+export function toSuperShortId(id: string, prefix: string): string {
+    if (!id) {
+        throw new Error("Salesforce ID cannot be empty.");
+    }
+
+    const trimmed = id.trim();
+
+    if (trimmed.length !== 18) {
+        throw new Error("Input must be an 18-character Salesforce ID.");
+    }
+
+    if (trimmed.substring(0, 2) !== prefix) {
+        throw new Error(`Id must contain prefix '${prefix}'`);
+    }
+
+    // Remove prefix (first 3) and checksum (last 3)
+    return trimmed.substring(3, 15); // characters 3 through 14 (12 chars)
+}
+
+/**
+ * Turn a 12-char super-short ID into a full 18-char ID using the given object prefix.
+ */
+function expandSuperShort(body12: string, prefix: string): string {
+    if (body12.length !== 12) {
+        throw new Error("Super-short ID must be 12 characters.");
+    }
+    if (prefix.length !== 3) {
+        throw new Error("Object prefix must be 3 characters.");
+    }
+
+    const id15 = prefix + body12; // prefix + 12-char body = 15-char ID
+    return toLongId(id15);
+}
+
+
+
+/**
+ * Normalize any Salesforce ID (12, 15, 18 chars) to full 18-char format.
+ */
+export function normalizeId(id: string, prefix: string): string {
+    if (!id) return "";
+
+    const trimmed = id.trim();
+
+    if (trimmed.length === 18) {
+        return trimmed;
+    }
+
+    if (trimmed.length === 15) {
+        return toLongId(trimmed);
+    }
+
+    if (trimmed.length === 12) {
+        return expandSuperShort(trimmed, prefix);
+    }
+
+    throw new Error(`Unsupported Salesforce ID length: ${trimmed.length}`);
+}
+
+/**
+ * Compare two Salesforce IDs, allowing either 15 or 18 char formats.
+ */
+export function idEquals(a: string, b: string, prefix: string): boolean {
+    if (!a || !b) return false;
+    return normalizeId(a, prefix) === normalizeId(b, prefix);
+}