@kubun/connector 0.12.1 → 0.13.0

package/lib/index.d.ts

@@ -1,4 +1,4 @@
 export { clusterModelURNs, resolveModelID } from './cluster-utils.js';
 export { connectorClusters, connectorModelIDs } from './models/cluster.js';
 export { externalEntityDefinition } from './models/external-entity.js';
-export type { ActionDefinition, ActionHandler, ActionHandlerFactory, ActionResult, ClientDataProvider, ClientProviderFactory, ConnectorAuth, ConnectorDefinition, ConnectorSyncEventPayload, Credential, CredentialProvider, DataProvider, DeviceConnectorAuth, DevicePermission, EntityBatch, EntityRecord, FetchChangesParams, FetchParams, OAuthConnectorAuth, OAuthProviderDefinition, OAuthState, ServerDataProvider, ServerProviderFactory, SyncBoundary, SyncCompleteEvent, SyncErrorEvent, SyncEvent, SyncFailureSample, SyncProgressEvent, SyncState, SyncStateEntry, SyncStateStore, SyncStatus, TokenResponse, UserSyncPreferences, WebhookParams, WebhookRegistration, } from './types.js';
+export type { ActionDefinition, ActionHandler, ActionHandlerFactory, ActionResult, ClientDataProvider, ClientProviderFactory, ConnectorAuth, ConnectorDefinition, ConnectorSyncEventPayload, Credential, CredentialProvider, DataProvider, DeviceConnectorAuth, DevicePermission, EntityBatch, EntityRecord, FetchChangesParams, FetchParams, OAuthConnectorAuth, OAuthProviderDefinition, OAuthState, ServerDataProvider, ServerProviderFactory, SyncBoundary, SyncCompleteEvent, SyncErrorEvent, SyncEvent, SyncFailureSample, SyncProgressEvent, SyncState, SyncStateEntry, SyncStateStore, SyncStatus, TokenResponse, UserSyncPreferences, WebhookParams, WebhookRegistration, WriteAttachment, } from './types.js';

package/lib/models/external-entity.d.ts

@@ -41,7 +41,11 @@ export declare const externalEntityDefinition: {
                 readonly minLength: 1;
                 readonly maxLength: 500;
             };
-            readonly SourceURL: import("json-schema-typed").JSONSchema.String;
+            readonly SourceURL: {
+                readonly type: "string";
+                readonly format: "uri";
+                readonly title: "URL";
+            };
             readonly DateTime: import("json-schema-typed").JSONSchema.String;
         };
     };

package/lib/types.d.ts

@@ -18,7 +18,24 @@ export type Credential = {
 };
 export type CredentialProvider = {
     get(providerName: string, ownerDID: string): Promise<Credential | null>;
-    set(providerName: string, ownerDID: string, credential: Credential): Promise<void>;
+    /**
+     * `ownerWrappableDID` is the owner's DID in a form that can be encrypted to,
+     * and is required only when no credential is stored yet.
+     *
+     * It is separate from `ownerDID` because that one is a join key and is
+     * normalized, and a normalized `did:peer:4` is its short form, which carries
+     * no document and so no agreement key. The two coincide for `did:key`. A
+     * caller that cannot supply it can still refresh an existing credential but
+     * cannot create one — which is the intended asymmetry: minting is the step
+     * that decides who will be able to read.
+     */
+    set(params: {
+        providerName: string;
+        ownerDID: string;
+        credential: Credential;
+        ownerWrappableDID?: string;
+        controllerWrappableDID?: string;
+    }): Promise<void>;
     delete(providerName: string, ownerDID: string): Promise<void>;
 };
 export type OAuthState = {
@@ -53,8 +70,6 @@ export type SyncStateStore = {
     set(connectorName: string, ownerDID: string, state: SyncState): Promise<void>;
     delete(connectorName: string, ownerDID: string): Promise<void>;
     listForConnector(connectorName: string): Promise<Array<SyncStateEntry>>;
-    claimSync(connectorName: string, ownerDID: string, leaseMs: number): Promise<boolean>;
-    renewSync(connectorName: string, ownerDID: string, leaseMs: number): Promise<void>;
 };
 export type SyncBoundary = {
     maxAge?: string;
@@ -137,12 +152,18 @@ export type ActionResult = {
     documentID?: string;
     deletedDocumentID?: string;
 };
+export type WriteAttachment = (input: ReadableStream<Uint8Array>, options?: {
+    mimeType?: string;
+    encrypted?: boolean;
+    keyID?: string;
+}) => Promise<string>;
 export type ActionHandler = {
     create(model: string, params: Record<string, unknown>): Promise<EntityRecord>;
-    update(model: string, sourceID: string, params: Record<string, unknown>): Promise<EntityRecord>;
+    update(model: string, sourceID: string, params: Record<string, unknown>, existing?: Record<string, unknown>): Promise<EntityRecord>;
 };
 export type ActionHandlerFactory = (config: {
     credential: Credential;
+    writeAttachment?: WriteAttachment;
 }) => ActionHandler;
 export type ServerProviderFactory = (config: {
     credential: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubun/connector",
-  "version": "0.12.1",
+  "version": "0.13.0",
   "keywords": [],
   "license": "see LICENSE.md",
   "sideEffects": false,
@@ -17,7 +17,7 @@
   "dependencies": {
     "json-schema-typed": "^8.0.2",
     "@kubun/protocol": "^0.13.0",
-    "@kubun/scalars": "^0.12.0"
+    "@kubun/scalars": "^0.13.0"
   },
   "publishConfig": {
     "access": "public"