@memberjunction/integration-connectors 5.35.0 → 5.36.0

package/dist/AptifyConnector.d.ts

@@ -0,0 +1,88 @@
+import { type UserInfo } from '@memberjunction/core';
+import type { MJCompanyIntegrationEntity } from '@memberjunction/core-entities';
+import { BaseRESTIntegrationConnector, type RESTAuthContext, type RESTResponse, type PaginationState, type PaginationType, type ConnectionTestResult, type ExternalRecord, type DefaultFieldMapping, type DefaultIntegrationConfig, type FetchContext, type FetchBatchResult, type ExternalObjectSchema, type ExternalFieldSchema, type CreateRecordContext, type UpdateRecordContext, type DeleteRecordContext, type GetRecordContext, type CRUDResult, type IntegrationObjectInfo } from '@memberjunction/integration-engine';
+/**
+ * Credentials required to authenticate against an Aptify Web Services API tenant.
+ * BaseURL is customer-specific (no trailing slash); AuthProvider defaults to "AptifyUser".
+ */
+export interface AptifyConnectionConfig {
+    BaseURL: string;
+    Username: string;
+    Password: string;
+    AuthProvider?: string;
+    /** Maximum retries for rate-limited or transient failures. Default: 3. */
+    MaxRetries?: number;
+    /** HTTP request timeout in milliseconds. Default: 30000. */
+    RequestTimeoutMs?: number;
+    /** Minimum milliseconds between API requests (client-side throttle). Default: 200. */
+    MinRequestIntervalMs?: number;
+}
+export declare class AptifyConnector extends BaseRESTIntegrationConnector {
+    private authState;
+    private lastRequestTime;
+    get IntegrationName(): string;
+    get SupportsCreate(): boolean;
+    get SupportsUpdate(): boolean;
+    get SupportsDelete(): boolean;
+    get SupportsSearch(): boolean;
+    get SupportsListing(): boolean;
+    GetIntegrationObjects(): IntegrationObjectInfo[];
+    GetActionGeneratorConfig(): import("@memberjunction/integration-engine").ActionGeneratorConfig;
+    protected Authenticate(companyIntegration: MJCompanyIntegrationEntity, contextUser: UserInfo): Promise<RESTAuthContext>;
+    protected BuildHeaders(auth: RESTAuthContext): Record<string, string>;
+    protected MakeHTTPRequest(auth: RESTAuthContext, url: string, method: string, headers: Record<string, string>, body?: unknown): Promise<RESTResponse>;
+    protected NormalizeResponse(rawBody: unknown, responseDataKey: string | null): Record<string, unknown>[];
+    protected ExtractPaginationInfo(rawBody: unknown, paginationType: PaginationType, currentPage: number, currentOffset: number, pageSize: number): PaginationState;
+    protected GetBaseURL(_companyIntegration: MJCompanyIntegrationEntity, auth: RESTAuthContext): string;
+    /** Aptify list endpoints use OData `$top` / `$skip` (capitalized property names). */
+    protected BuildPaginatedURL(basePath: string, obj: {
+        PaginationType: string;
+        DefaultPageSize: number | null;
+    }, page: number, offset: number, _cursor?: string, effectivePageSize?: number): string;
+    TestConnection(companyIntegration: MJCompanyIntegrationEntity, contextUser: UserInfo): Promise<ConnectionTestResult>;
+    DiscoverObjects(companyIntegration: MJCompanyIntegrationEntity, contextUser: UserInfo): Promise<ExternalObjectSchema[]>;
+    /**
+     * Discovery strategy: fetch one sample record from `${BaseURL}/services/{Object}?$top=1`
+     * and infer fields from its JSON shape, overlaying static PK / FK metadata where we have it.
+     * Falls back to the static field set if the live call fails (offline scenarios, sandboxes
+     * with empty tables, etc.).
+     */
+    DiscoverFields(companyIntegration: MJCompanyIntegrationEntity, objectName: string, contextUser: UserInfo): Promise<ExternalFieldSchema[]>;
+    /** Pull a sample record's keys + values, overlay any static PK/FK metadata we have for the object. */
+    private InferFieldsFromSample;
+    private InferType;
+    FetchChanges(ctx: FetchContext): Promise<FetchBatchResult>;
+    private BuildFetchURL;
+    private ComputeNewWatermark;
+    CreateRecord(ctx: CreateRecordContext): Promise<CRUDResult>;
+    UpdateRecord(ctx: UpdateRecordContext): Promise<CRUDResult>;
+    DeleteRecord(ctx: DeleteRecordContext): Promise<CRUDResult>;
+    GetRecord(ctx: GetRecordContext): Promise<ExternalRecord | null>;
+    GetDefaultConfiguration(): DefaultIntegrationConfig;
+    GetDefaultFieldMappings(objectName: string, _entityName: string): DefaultFieldMapping[];
+    /**
+     * Returns a valid auth context, refreshing the cached token as needed. Accepts either
+     * (companyIntegration, contextUser) for normal callers or a pre-parsed config for the
+     * silent re-auth path inside MakeHTTPRequest.
+     */
+    private GetAuth;
+    private IsConfig;
+    private IsTokenValid;
+    private AcquireToken;
+    private ParseConfig;
+    private ParseConfigFromCredential;
+    private ExtractConfig;
+    private ExecuteFetch;
+    private BuildRESTResponse;
+    private ParseJsonSafely;
+    private ShouldRetry;
+    private ComputeRetryDelay;
+    private Throttle;
+    private Sleep;
+    private ExtractIdFromRecord;
+    private StripTrailingSlash;
+    private BuildCRUDError;
+}
+/** Tree-shaking prevention — import and call from module entry point. */
+export declare function LoadAptifyConnector(): void;
+//# sourceMappingURL=AptifyConnector.d.ts.map

package/dist/AptifyConnector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AptifyConnector.d.ts","sourceRoot":"","sources":["../src/AptifyConnector.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAoC,KAAK,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,KAAK,EAAE,0BAA0B,EAAsB,MAAM,+BAA+B,CAAC;AACpG,OAAO,EAEH,4BAA4B,EAC5B,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,UAAU,EACf,KAAK,qBAAqB,EAC7B,MAAM,oCAAoC,CAAC;AAI5C;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4DAA4D;IAC5D,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,sFAAsF;IACtF,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAkND,qBACa,eAAgB,SAAQ,4BAA4B;IAE7D,OAAO,CAAC,SAAS,CAAkC;IACnD,OAAO,CAAC,eAAe,CAAK;IAI5B,IAAoB,eAAe,IAAI,MAAM,CAAqB;IAClE,IAAoB,cAAc,IAAI,OAAO,CAAiB;IAC9D,IAAoB,cAAc,IAAI,OAAO,CAAiB;IAC9D,IAAoB,cAAc,IAAI,OAAO,CAAiB;IAC9D,IAAoB,cAAc,IAAI,OAAO,CAAiB;IAC9D,IAAoB,eAAe,IAAI,OAAO,CAAiB;IAE/C,qBAAqB,IAAI,qBAAqB,EAAE;IAIhD,wBAAwB;cAaxB,YAAY,CACxB,kBAAkB,EAAE,0BAA0B,EAC9C,WAAW,EAAE,QAAQ,GACtB,OAAO,CAAC,eAAe,CAAC;IAI3B,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;cAQrD,eAAe,CAC3B,IAAI,EAAE,eAAe,EACrB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC/B,IAAI,CAAC,EAAE,OAAO,GACf,OAAO,CAAC,YAAY,CAAC;IAqCxB,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;IAcxG,SAAS,CAAC,qBAAqB,CAC3B,OAAO,EAAE,OAAO,EAChB,cAAc,EAAE,cAAc,EAC9B,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,MAAM,GACjB,eAAe;IAiBlB,SAAS,CAAC,UAAU,CAAC,mBAAmB,EAAE,0BAA0B,EAAE,IAAI,EAAE,eAAe,GAAG,MAAM;IAIpG,qFAAqF;cAClE,iBAAiB,CAChC,QAAQ,EAAE,MAAM,EAChB,GAAG,EAAE;QAAE,cAAc,EAAE,MAAM,CAAC;QAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,EAC/D,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,EAChB,iBAAiB,CAAC,EAAE,MAAM,GAC3B,MAAM;IAeI,cAAc,CACvB,kBAAkB,EAAE,0BAA0B,EAC9C,WAAW,EAAE,QAAQ,GACtB,OAAO,CAAC,oBAAoB,CAAC;IAgBV,eAAe,CACjC,kBAAkB,EAAE,0BAA0B,EAC9C,WAAW,EAAE,QAAQ,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAalC;;;;;OAKG;IACmB,cAAc,CAChC,kBAAkB,EAAE,0BAA0B,EAC9C,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,QAAQ,GACtB,OAAO,CAAC,mBAAmB,EAAE,CAAC;IA8BjC,sGAAsG;IACtG,OAAO,CAAC,qBAAqB;IAmB7B,OAAO,CAAC,SAAS;IAUK,YAAY,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA0BhF,OAAO,CAAC,aAAa;IAWrB,OAAO,CAAC,mBAAmB;IAeL,YAAY,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAe3D,YAAY,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAc3D,YAAY,CAAC,GAAG,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAc3D,SAAS,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IAetE,uBAAuB,IAAI,wBAAwB;IAInD,uBAAuB,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,mBAAmB,EAAE;IAcvG;;;;OAIG;YACW,OAAO;IAerB,OAAO,CAAC,QAAQ;IAKhB,OAAO,CAAC,YAAY;YAIN,YAAY;YA4CZ,WAAW;YAeX,yBAAyB;IAavC,OAAO,CAAC,aAAa;YA0BP,YAAY;YAoBZ,iBAAiB;YAUjB,eAAe;IAQ7B,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,iBAAiB;YASX,QAAQ;IAKtB,OAAO,CAAC,KAAK;IAMb,OAAO,CAAC,mBAAmB;IAS3B,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,cAAc;CAkBzB;AAED,yEAAyE;AACzE,wBAAgB,mBAAmB,IAAI,IAAI,CAA4B"}