@memberjunction/integration-connectors 5.51.0 → 6.1.0-edge.1

package/dist/ORCIDConnector.d.ts

@@ -1,207 +0,0 @@
-import { type UserInfo } from '@memberjunction/core';
-import type { MJCompanyIntegrationEntity, MJIntegrationObjectEntity, MJIntegrationObjectFieldEntity } from '@memberjunction/core-entities';
-import { BaseRESTIntegrationConnector, type RESTAuthContext, type RESTResponse, type PaginationState, type PaginationType, type ConnectionTestResult, type FetchContext, type FetchBatchResult, type RateLimitPolicy } from '@memberjunction/integration-engine';
-/**
- * Per-connection configuration for the ORCID connector.
- *
- * The ORCID Public API has NO list-all-records endpoint — the iD universe is
- * not enumerable. Instead the universe is SCOPED PER CONNECTION via
- * CompanyIntegration.Configuration. At least one of `searchQuery` / `orcidIds`
- * must be provided.
- */
-export interface ORCIDConnectionConfig {
-    /** OAuth2 client_credentials grant — client identifier. From the credential store. */
-    ClientID?: string;
-    /** OAuth2 client_credentials grant — client secret. From the credential store. */
-    ClientSecret?: string;
-    /** OAuth2 token endpoint. Defaults to the production/sandbox host based on UseSandbox. */
-    TokenURL?: string;
-    /** OAuth2 scope. Defaults to '/read-public'. */
-    Scope?: string;
-    /** When true, use the ORCID sandbox hosts (sandbox.orcid.org / pub.sandbox.orcid.org). */
-    UseSandbox?: boolean;
-    /**
-     * Lucene query string for GET /search or /expanded-search resolving the iD universe at runtime.
-     * Examples: 'affiliation-org-name:"Harvard University"', 'given-names:Albert family-name:Einstein'.
-     */
-    SearchQuery?: string;
-    /** Whether to use /expanded-search instead of /search. Default: false (plain /search). */
-    UseExpandedSearch?: boolean;
-    /** Explicit list of ORCID iDs to sync directly (in addition to / instead of searchQuery). */
-    OrcidIds?: string[];
-    /**
-     * Upper bound on the number of iDs resolved from a search per sync ("Goldilocks" — do NOT drain
-     * the ~10k ORCID cap). Default: 1000. Explicit OrcidIds are always synced and are not bounded.
-     */
-    MaxSearchResults?: number;
-    /** HTTP request timeout in milliseconds. Default: 30000. */
-    RequestTimeoutMs?: number;
-    /** Maximum retries for rate-limited / transient failures. Default: 4. */
-    MaxRetries?: number;
-    /** Minimum interval between outbound requests (ms). Default: 100 (~10 req/s, well under the 40/s burst cap). */
-    MinRequestIntervalMs?: number;
-    /**
-     * Non-secret API host override (e.g. a local mock for replay testing). When unset, the
-     * production/sandbox host is selected by UseSandbox. Same pattern as Path LMS / GrowthZone —
-     * required for mock-floor e2e testability.
-     */
-    ApiBaseUrl?: string;
-}
-/**
- * Connector for the ORCID Public API v3.0 (read-only).
- *
- * Authenticates via OAuth2 2-legged client_credentials (scope `/read-public`)
- * to obtain a bearer token. ORCID is NOT enumerable — there is no
- * "list all records" endpoint — so every sync is SCOPED per connection via
- * `CompanyIntegration.Configuration` (`searchQuery` Lucene query and/or an
- * explicit `orcidIds` array). FetchChanges resolves the in-scope iD set, then
- * fetches `GET /{iD}/record` (root IO) or `GET /{iD}/<section>` (child IOs)
- * per resolved iD.
- *
- * Pull-only: SupportsCreate/Update/Delete are false (the Public API is
- * read-only; writes require the Member API which is out of scope). Incremental
- * sync narrows client-side on each section's `last-modified-date`; the
- * search-scoped universe has no cursor so it re-resolves each run and dedup
- * rides content-hash idempotency in the base ToExternalRecord path.
- *
- * Rides BaseRESTIntegrationConnector (JSON over HTTP via Accept:
- * application/json). The standard FetchChanges template-var mechanism resolves
- * child sections off ALREADY-SYNCED parent iDs; we override FetchChanges so the
- * ROOT (record) iD set is sourced from the Configuration universe rather than a
- * parent table, then delegate child sections to the same per-iD fan-out.
- */
-export declare class ORCIDConnector extends BaseRESTIntegrationConnector {
-    /** Cached auth context (token + resolved host). Invalidated on token expiry or 401. */
-    private authState;
-    /** Timestamp of the last outbound request, used for throttling. */
-    private lastRequestTime;
-    get SupportsCreate(): boolean;
-    get SupportsUpdate(): boolean;
-    get SupportsDelete(): boolean;
-    get IntegrationName(): string;
-    /**
-     * ORCID documents a 40 req/s burst ceiling (HTTP 503 over it) and a daily quota
-     * (HTTP 429 with X-Rate-Limit-* + Retry-After). Run conservatively under the burst cap.
-     */
-    get RateLimitPolicy(): RateLimitPolicy | null;
-    /** Parse ORCID's Retry-After (delta-seconds or HTTP-date) into milliseconds. */
-    ExtractRetryAfterMs(error: unknown): number | undefined;
-    /**
-     * The search-scoped iD universe has no stable, monotonic ordering key — it is
-     * re-resolved from the Lucene query each run (insert/delete-volatile), so keyset
-     * resume is N/A. Dedup rides content-hash idempotency. Returns null for every object.
-     */
-    StableOrderingKey(_objectName: string): string | null;
-    /**
-     * Verifies connectivity by obtaining a client_credentials token, then issuing a
-     * lightweight authenticated probe against a well-known public iD's /record.
-     */
-    TestConnection(companyIntegration: MJCompanyIntegrationEntity, contextUser: UserInfo): Promise<ConnectionTestResult>;
-    /**
-     * Fetches records for the given object, sourcing the iD universe from
-     * CompanyIntegration.Configuration (search query and/or explicit list).
-     *
-     * - ROOT IO ('record'): fetch GET /{iD}/record for each resolved iD.
-     * - CHILD section IOs ('works', 'employments', ...): fetch GET /{iD}/<section>
-     *   for each resolved iD and expand the group envelope into individual items.
-     *
-     * Incremental: for sections that carry `last-modified-date`, narrow client-side
-     * to records strictly newer than ctx.WatermarkValue, and return the max-seen
-     * watermark as NewWatermarkValue (persisted by the engine on full-batch success
-     * only). The iD universe itself has no cursor (search is re-resolved each run);
-     * dedup rides content-hash idempotency in ToExternalRecord.
-     */
-    FetchChanges(ctx: FetchContext): Promise<FetchBatchResult>;
-    /**
-     * Fetches the raw item array for a single iD + object. For the root record IO this is
-     * a single-element array (the record itself); for a section it is the expanded group items.
-     */
-    private FetchForId;
-    /**
-     * Expands an ORCID activity-section group envelope into individual item objects.
-     *
-     * ORCID groups items under section-specific wrappers (e.g. works →
-     * `group[].work-summary[]`, employments → `affiliation-group[].summaries[]`).
-     * We walk the generic shape: any array whose elements carry a `put-code` is a
-     * leaf item; we flatten all such arrays found anywhere in the envelope. Each
-     * item is tagged with the parent `orcid-id` (the FK to record).
-     */
-    private expandSection;
-    /**
-     * Resolves the in-scope ORCID iD universe from CompanyIntegration.Configuration:
-     * the explicit `orcidIds` list (always included) plus the result of running the
-     * Lucene `searchQuery` against /search (or /expanded-search), bounded by
-     * MaxSearchResults to avoid draining the ~10k cap. Returns a de-duplicated set.
-     */
-    private ResolveOrcidIdUniverse;
-    /**
-     * Runs the Lucene query against ORCID /search (or /expanded-search) with offset
-     * pagination (start/rows), accumulating iDs up to maxResults ("Goldilocks" bound).
-     * Search is unordered and may return duplicates across pages — de-duplicated by the caller.
-     */
-    private RunSearch;
-    /** Normalizes a raw iD string to the canonical 0000-0000-0000-0000 form, or null if unusable. */
-    private normalizeOrcidId;
-    /**
-     * Builds the ExternalRecord, preserving the FULL raw source record in Fields
-     * (full-record pass-through) while flattening the declared scalar fields out of
-     * ORCID's nested JSON via TransformRecord/applyTransformPreservingKeys. PK identity
-     * (orcid-id for record, put-code for sections) drives the ExternalID; partial keys
-     * fall back to the base content-hash identity.
-     */
-    private toRecord;
-    /**
-     * Per-record reshaping: ORCID returns deeply-nested JSON; pull the declared scalar
-     * convenience fields up to the top level so the generated columns are populated, while
-     * the full raw record (every nested blob) is preserved by applyTransformPreservingKeys.
-     */
-    protected TransformRecord(raw: Record<string, unknown>, obj: MJIntegrationObjectEntity, _fields: MJIntegrationObjectFieldEntity[]): Record<string, unknown>;
-    /** Flattens the record IO's person/history-derived convenience scalars. */
-    private flattenRecordScalars;
-    /** ORCID scalar wrapper: { value: <x> } → <x>; otherwise returns the value as-is. */
-    private valueOf;
-    /** ORCID date wrapper: { value: <millis> } → ISO string; passthrough on already-scalar/empty. */
-    private coerceDate;
-    /** Extracts the last-modified-date millis from a record (for watermark comparison). */
-    private extractLastModifiedMs;
-    /** Pulls a millisecond epoch out of an ORCID timestamp wrapper or a scalar number/ISO string. */
-    private extractMs;
-    private asObject;
-    private parseWatermark;
-    protected Authenticate(companyIntegration: MJCompanyIntegrationEntity, contextUser: UserInfo): Promise<RESTAuthContext>;
-    protected BuildHeaders(auth: RESTAuthContext): Record<string, string>;
-    /** Not used by the overridden FetchChanges; retained for any base-pipeline callers (GetRecord). */
-    protected NormalizeResponse(rawBody: unknown, responseDataKey: string | null): Record<string, unknown>[];
-    /** ORCID per-iD endpoints are not paginated — every object declares PaginationType=None. */
-    protected ExtractPaginationInfo(_rawBody: unknown, _paginationType: PaginationType, currentPage: number, currentOffset: number, _pageSize: number): PaginationState;
-    protected GetBaseURL(_companyIntegration: MJCompanyIntegrationEntity, auth: RESTAuthContext): string;
-    private isTokenValid;
-    /**
-     * Exchanges the client_credentials grant for a bearer token at the ORCID token
-     * endpoint. POST form: grant_type=client_credentials, client_id, client_secret,
-     * scope=/read-public.
-     */
-    private obtainAccessToken;
-    protected MakeHTTPRequest(auth: RESTAuthContext, url: string, method: string, headers: Record<string, string>, body?: unknown): Promise<RESTResponse>;
-    /** Single fetch() with an AbortController-backed timeout. */
-    private doFetch;
-    private safeParseJSON;
-    private isRetryableError;
-    private backoffMs;
-    private backoffFromResponse;
-    private throttle;
-    private sleep;
-    /**
-     * Resolves the connection config: OAuth2 secrets (ClientID/ClientSecret/TokenURL/Scope) from the
-     * credential store; the iD-universe scope (searchQuery/orcidIds) + host selection (useSandbox)
-     * from CompanyIntegration.Configuration. Secrets are NEVER baked into code.
-     */
-    private parseConfig;
-    /** Parses the non-secret scope/host config from CompanyIntegration.Configuration JSON. */
-    private parseConfigurationJson;
-    /** Loads OAuth2 secrets from the MJ credential store (generic OAuth2 client-credentials schema). */
-    private loadFromCredential;
-}
-/** Tree-shaking prevention function — import and call from the module entry point. */
-export declare function LoadORCIDConnector(): void;
-//# sourceMappingURL=ORCIDConnector.d.ts.map

package/dist/ORCIDConnector.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ORCIDConnector.d.ts","sourceRoot":"","sources":["../src/ORCIDConnector.ts"],"names":[],"mappings":"AACA,OAAO,EAAoC,KAAK,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACvF,OAAO,KAAK,EAAE,0BAA0B,EAAsB,yBAAyB,EAAE,8BAA8B,EAAE,MAAM,+BAA+B,CAAC;AAC/J,OAAO,EAEH,4BAA4B,EAC5B,KAAK,eAAe,EACpB,KAAK,YAAY,EACjB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,YAAY,EACjB,KAAK,gBAAgB,EAGrB,KAAK,eAAe,EACvB,MAAM,oCAAoC,CAAC;AAI5C;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IAClC,sFAAsF;IACtF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kFAAkF;IAClF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0FAA0F;IAC1F,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0FAA0F;IAC1F,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,6FAA6F;IAC7F,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,4DAA4D;IAC5D,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gHAAgH;IAChH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAsDD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBACa,cAAe,SAAQ,4BAA4B;IAE5D,uFAAuF;IACvF,OAAO,CAAC,SAAS,CAAiC;IAClD,mEAAmE;IACnE,OAAO,CAAC,eAAe,CAAK;IAI5B,IAAoB,cAAc,IAAI,OAAO,CAAkB;IAC/D,IAAoB,cAAc,IAAI,OAAO,CAAkB;IAC/D,IAAoB,cAAc,IAAI,OAAO,CAAkB;IAE/D,IAAoB,eAAe,IAAI,MAAM,CAAoB;IAIjE;;;OAGG;IACH,IAAoB,eAAe,IAAI,eAAe,GAAG,IAAI,CAE5D;IAED,gFAAgF;IAChE,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS;IAevE;;;;OAIG;IACa,iBAAiB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAIrE;;;OAGG;IACU,cAAc,CACvB,kBAAkB,EAAE,0BAA0B,EAC9C,WAAW,EAAE,QAAQ,GACtB,OAAO,CAAC,oBAAoB,CAAC;IA2BhC;;;;;;;;;;;;;OAaG;IACmB,YAAY,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA2ChF;;;OAGG;YACW,UAAU;IA+BxB;;;;;;;;OAQG;IACH,OAAO,CAAC,aAAa;IAsBrB;;;;;OAKG;YACW,sBAAsB;IAqBpC;;;;OAIG;YACW,SAAS;IA8BvB,iGAAiG;IACjG,OAAO,CAAC,gBAAgB;IAWxB;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;IAmBhB;;;;OAIG;cACgB,eAAe,CAC9B,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC5B,GAAG,EAAE,yBAAyB,EAC9B,OAAO,EAAE,8BAA8B,EAAE,GAC1C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAa1B,2EAA2E;IAC3E,OAAO,CAAC,oBAAoB;IA+B5B,qFAAqF;IACrF,OAAO,CAAC,OAAO;IAMf,iGAAiG;IACjG,OAAO,CAAC,UAAU;IAMlB,uFAAuF;IACvF,OAAO,CAAC,qBAAqB;IAI7B,iGAAiG;IACjG,OAAO,CAAC,SAAS;IAcjB,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,cAAc;cAQN,YAAY,CACxB,kBAAkB,EAAE,0BAA0B,EAC9C,WAAW,EAAE,QAAQ,GACtB,OAAO,CAAC,eAAe,CAAC;IAgB3B,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAQrE,mGAAmG;IACnG,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE;IAcxG,4FAA4F;IAC5F,SAAS,CAAC,qBAAqB,CAC3B,QAAQ,EAAE,OAAO,EACjB,eAAe,EAAE,cAAc,EAC/B,WAAW,EAAE,MAAM,EACnB,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,GAClB,eAAe;IAIlB,SAAS,CAAC,UAAU,CAChB,mBAAmB,EAAE,0BAA0B,EAC/C,IAAI,EAAE,eAAe,GACtB,MAAM;IAMT,OAAO,CAAC,YAAY;IAIpB;;;;OAIG;YACW,iBAAiB;cAgCf,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;IA0CxB,6DAA6D;YAC/C,OAAO;IA0BrB,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,mBAAmB;YAMb,QAAQ;IAKtB,OAAO,CAAC,KAAK;IAMb;;;;OAIG;YACW,WAAW;IA+BzB,0FAA0F;IAC1F,OAAO,CAAC,sBAAsB;IAgC9B,oGAAoG;YACtF,kBAAkB;CA6BnC;AAED,sFAAsF;AACtF,wBAAgB,kBAAkB,IAAI,IAAI,CAAgB"}