@taprootio/integration-sdk 0.1.2 → 0.1.3

package/README.md

@@ -7,7 +7,7 @@ Taproot publishes accepted, immutable content; it does not call an integration d
 ## Install
 
 ```sh
-npm install @taprootio/integration-sdk@0.1.2
+npm install @taprootio/integration-sdk@0.1.3
 ```
 
 The public manifest schema is exported at `@taprootio/integration-sdk/schema`. The fixtures under `@taprootio/integration-sdk/fixtures/...` are contract examples, not a local fixture host or a production deployment recipe.

package/index.d.ts

@@ -6,7 +6,7 @@ export { INTEGRATION_OPENAPI_OPERATIONS, INTEGRATION_OPENAPI_SCHEMAS, INTEGRATIO
 type OperationRequest<Name extends keyof IntegrationOpenApiOperationMap> = IntegrationOpenApiOperationMap[Name]["request"];
 type OperationResponse<Name extends keyof IntegrationOpenApiOperationMap> = IntegrationOpenApiOperationMap[Name]["response"];
 
-export const INTEGRATION_SDK_VERSION: "0.1.2";
+export const INTEGRATION_SDK_VERSION: "0.1.3";
 export const WEBHOOK_VERSION: "1";
 export const WEBHOOK_EVENT_TYPES: readonly WebhookEventType[];
 export const INTEGRATION_CAPABILITIES: readonly IntegrationCapability[];
@@ -209,9 +209,9 @@ export class TaprootIntegrationClient {
   deleteManagedPage(input: { installationId: string; syncId?: string; externalId: string; idempotencyKey: string }): Promise<IntegrationSyncResult>;
   putDataDocument(input: { installationId: string; syncId?: string; key: string; json: string; idempotencyKey: string }): Promise<IntegrationSyncResult>;
   deleteDataDocument(input: { installationId: string; syncId?: string; key: string; idempotencyKey: string }): Promise<IntegrationSyncResult>;
-  requestMediaUpload(input: { installationId: string; fileName: string; contentType: string; fileSize: number; contentHash: string; width: number; height: number }): Promise<RequestMediaUploadResponse>;
+  requestMediaUpload(input: { installationId: string; fileName: string; contentType: string; fileSize: number; contentHash: string; width: number; height: number; operationKey?: string }): Promise<RequestMediaUploadResponse>;
   confirmMediaUpload(input: { installationId: string; uploadId: string }): Promise<OperationResponse<"confirmMediaUpload">>;
-  putMedia(input: { installationId: string; fileName: string; contentType: string; fileSize: number; contentHash: string; width: number; height: number; body: Uint8Array | ArrayBuffer | string }): Promise<TaprootImage>;
+  putMedia(input: { installationId: string; fileName: string; contentType: string; fileSize: number; contentHash: string; width: number; height: number; body: Uint8Array | ArrayBuffer | string; operationKey?: string }): Promise<TaprootImage>;
   uploadPresigned(input: { url: string; requiredHeaders?: Record<string, string>; body: Uint8Array | ArrayBuffer | string }): Promise<void>;
   listPlacements(input: { installationId: string }): Promise<{ placements: IntegrationPlacement[] }>;
   putFragment(input: { installationId: string; placementId: string; configurationRevision: number; expectedFragmentRevision?: number; html: string; structuredData?: string[]; syncId?: string; idempotencyKey: string }): Promise<IntegrationPlacementFragmentResult>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taprootio/integration-sdk",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Public contracts and client for Taproot push integrations",
   "type": "module",
   "main": "./src/index.js",

package/src/client.js

@@ -334,10 +334,11 @@ export class TaprootIntegrationClient {
       body: withIdempotency({ installationId: id, syncId, key: nonEmptyString(key, "invalid_content_key") }, idempotencyKey), retry: true });
   }
 
-  requestMediaUpload({ installationId, fileName, contentType, fileSize, contentHash, width, height }) {
+  requestMediaUpload({ installationId, fileName, contentType, fileSize, contentHash, width, height, operationKey = createIdempotencyKey() }) {
     const id = nonEmptyString(installationId, "invalid_installation_id");
+    const key = nonEmptyString(operationKey, "invalid_operation_key");
     return this.#request({ path: operationPath("requestMediaUpload", { installationId: id }), credential: "installation",
-      body: { installationId: id, fileName: nonEmptyString(fileName, "invalid_file_name"), contentType: nonEmptyString(contentType, "invalid_content_type"), fileSize, contentHash: nonEmptyString(contentHash, "invalid_content_hash"), width, height } });
+      body: { installationId: id, fileName: nonEmptyString(fileName, "invalid_file_name"), contentType: nonEmptyString(contentType, "invalid_content_type"), fileSize, contentHash: nonEmptyString(contentHash, "invalid_content_hash"), width, height, operationKey: key } });
   }
 
   confirmMediaUpload({ installationId, uploadId }) {
@@ -345,8 +346,8 @@ export class TaprootIntegrationClient {
     return this.#request({ path: operationPath("confirmMediaUpload", { installationId: id }), credential: "installation", body: { installationId: id, uploadId: nonEmptyString(uploadId, "invalid_upload_id") } });
   }
 
-  async putMedia({ installationId, fileName, contentType, fileSize, contentHash, width, height, body }) {
-    const requested = await this.requestMediaUpload({ installationId, fileName, contentType, fileSize, contentHash, width, height });
+  async putMedia({ installationId, fileName, contentType, fileSize, contentHash, width, height, body, operationKey = createIdempotencyKey() }) {
+    const requested = await this.requestMediaUpload({ installationId, fileName, contentType, fileSize, contentHash, width, height, operationKey });
     if (requested.isDuplicate) return requested.image;
     await this.uploadPresigned({ url: requested.presignedUrl, requiredHeaders: requested.requiredHeaders, body });
     return (await this.confirmMediaUpload({ installationId, uploadId: requested.uploadId })).image;

package/src/constants.js

@@ -1,6 +1,6 @@
 import { INTEGRATION_WEBHOOK_EVENTS } from "./openapi-contract.js";
 
-export const INTEGRATION_SDK_VERSION = "0.1.2";
+export const INTEGRATION_SDK_VERSION = "0.1.3";
 export const WEBHOOK_VERSION = "1";
 export const WEBHOOK_EVENT_TYPES = Object.freeze(Object.keys(INTEGRATION_WEBHOOK_EVENTS));
 export const INTEGRATION_CAPABILITIES = Object.freeze([

package/src/openapi-contract.d.ts

@@ -26,7 +26,7 @@ export type PutIntegrationDataDocumentRequest = { "installationId"?: string; "sy
 export type PutIntegrationFragmentRequest = { "installationId"?: string; "placementId"?: string; "configurationRevision"?: number; "expectedFragmentRevision"?: number; "html"?: string; "structuredData"?: Array<string>; "syncId"?: string; "idempotencyKey"?: string; };
 export type RequestIntegrationBundleUploadRequest = { "integrationId"?: string; "contentHash"?: string; "byteLength"?: number; "runtimeMajor"?: number; };
 export type RequestIntegrationBundleUploadResponse = { "uploadId"?: string; "presignedUrl"?: string; "requiredHeaders"?: { [key: string]: string; }; "expiresAt"?: string; "existingBundle"?: IntegrationBundle; "isDuplicate"?: boolean; };
-export type RequestIntegrationMediaUploadRequest = { "installationId"?: string; "fileName"?: string; "contentType"?: string; "fileSize"?: number; "contentHash"?: string; "width"?: number; "height"?: number; };
+export type RequestIntegrationMediaUploadRequest = { "installationId"?: string; "fileName"?: string; "contentType"?: string; "fileSize"?: number; "contentHash"?: string; "width"?: number; "height"?: number; "operationKey"?: string; };
 export type RequestIntegrationMediaUploadResponse = { "presignedUrl"?: string; "uploadId"?: string; "isDuplicate"?: boolean; "image"?: TaprootImage; "requiredHeaders"?: { [key: string]: string; }; };
 export type TaprootImage = { "imageId"?: string; "url"?: string; "height"?: number; "width"?: number; "fileSize"?: number; "uploadedName"?: string; "imageType"?: ImageType; "responsiveUrls"?: Array<ImageUrl>; "thumbHash"?: string; "processingState"?: ImageProcessingState; "ownershipScope"?: ImageOwnershipScope; "siteId"?: string; };
 export type UpsertIntegrationPageRequest = { "installationId"?: string; "syncId"?: string; "idempotencyKey"?: string; "page"?: IntegrationManagedPageContent; };

package/src/openapi-contract.js

@@ -844,6 +844,9 @@ export const INTEGRATION_OPENAPI_SCHEMAS = Object.freeze({
       "height": {
         "type": "integer",
         "format": "int32"
+      },
+      "operationKey": {
+        "type": "string"
       }
     },
     "additionalProperties": false