@kubun/connector 0.17.2 → 0.17.3

package/lib/index.d.ts

@@ -3,4 +3,5 @@ export { clusterModelURNs, resolveModelID } from './cluster-utils.js';
 export { ConnectorError, type ConnectorErrorKind, type ConnectorErrorOptions, classifyHTTPStatus, connectorHTTPError, markWriteSent, } from './errors.js';
 export { connectorClusters, connectorModelIDs } from './models/cluster.js';
 export { externalEntityDefinition } from './models/external-entity.js';
+export { type FetchOrAbsentOptions, fetchOrAbsent, isNotFoundError, parseMaxAgeDays, type TargetedRead, } from './provider-utils.js';
 export type { ActionDefinition, ActionHandler, ActionHandlerFactory, ActionResult, ActionTargetResolver, ActionTargetStorage, ActionWriteContext, ActionWriteResult, ClientDataProvider, ClientProviderFactory, ConnectorAuth, ConnectorDefinition, ConnectorSyncEventPayload, CreatedSourceIDPredictor, DataProvider, DeadLetter, DeviceConnectorAuth, DevicePermission, EntityBatch, EntityRecord, FetchChangesParams, FetchedAbsentEntity, FetchedEntity, FetchedPresentEntity, FetchParams, IntentCanonicalizer, IntentComparison, JSONValue, LocalAnnotationMerger, OAuthConnectorAuth, OAuthState, PendingOp, ReconcileResult, Recovery, ResolvedActionTarget, ServerDataProvider, ServerProviderFactory, SyncBoundary, SyncCompleteEvent, SyncErrorEvent, SyncEvent, SyncFailureSample, SyncProgressCASCurrent, SyncProgressCASResult, SyncProgressEvent, SyncProgressRecompute, SyncState, SyncStateEntry, SyncStateStore, SyncStatus, UserSyncPreferences, WebhookParams, WebhookRegistration, WriteAttachment, } from './types.js';

package/lib/index.js

@@ -3,3 +3,4 @@ export { clusterModelURNs, resolveModelID } from './cluster-utils.js';
 export { ConnectorError, classifyHTTPStatus, connectorHTTPError, markWriteSent } from './errors.js';
 export { connectorClusters, connectorModelIDs } from './models/cluster.js';
 export { externalEntityDefinition } from './models/external-entity.js';
+export { fetchOrAbsent, isNotFoundError, parseMaxAgeDays } from './provider-utils.js';

package/lib/provider-utils.d.ts

@@ -0,0 +1,13 @@
+import type { EntityRecord, ReconcileResult, SyncBoundary } from './types.js';
+export type TargetedRead = {
+    record: EntityRecord;
+    providerETag?: string;
+};
+export type FetchOrAbsentOptions = {
+    sourceID: string;
+    sourceFetchHLC: string;
+    read: () => Promise<TargetedRead>;
+};
+export declare function isNotFoundError(err: unknown): boolean;
+export declare function fetchOrAbsent(options: FetchOrAbsentOptions): Promise<ReconcileResult>;
+export declare function parseMaxAgeDays(boundary: SyncBoundary | undefined): number | null;

package/lib/provider-utils.js

@@ -0,0 +1,29 @@
+export function isNotFoundError(err) {
+    return err?.httpStatus === 404;
+}
+export async function fetchOrAbsent(options) {
+    try {
+        const { record, providerETag } = await options.read();
+        return {
+            present: true,
+            record,
+            sourceFetchHLC: options.sourceFetchHLC,
+            ...providerETag != null ? {
+                providerETag
+            } : {}
+        };
+    } catch (err) {
+        if (isNotFoundError(err)) {
+            return {
+                present: false,
+                sourceID: options.sourceID,
+                sourceFetchHLC: options.sourceFetchHLC
+            };
+        }
+        throw err;
+    }
+}
+export function parseMaxAgeDays(boundary) {
+    const match = boundary?.maxAge != null ? /^P(\d+)D$/i.exec(boundary.maxAge) : null;
+    return match?.[1] != null ? Number.parseInt(match[1], 10) : null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/connector",
-  "version": "0.17.2",
+  "version": "0.17.3",
   "keywords": [],
   "license": "see LICENSE.md",
   "sideEffects": false,
@@ -16,7 +16,7 @@
   ],
   "dependencies": {
     "@kubun/credential-types": "^0.17.2",
-    "@kubun/protocol": "^0.17.1",
+    "@kubun/protocol": "^0.17.2",
     "@kubun/scalars": "^0.17.0",
     "json-schema-typed": "^8.0.2"
   },