v6.0.0

What's New:

• Security Update - Axios Vulnerability Fixed: Updated Axios from ^0.21.1 to ^1.12.2 to address a high severity DoS (Denial of Service) vulnerability caused by lack of data size check. This critical security patch protects against potential attacks that could overwhelm your application.

• Added Support for AI Image Detection API: Seamlessly integrate the powerful Copyleaks AI Image Detection service into your applications.

• New Models Introduced: To support this functionality, the following new models have been added, providing a clear structure for requests and responses:

  Response Models (models\request\AiImageDetection):

  • CopyleaksImageShapeModel.ts
  • CopyleaksImageMetadataModel.ts
  • CopyleaksAiImageDetectionSummaryModel.ts
  • CopyleaksAiImageDetectionScannedDocumentModel.ts
  • CopyleaksAiImageDetectionResultModel.ts
  • CopyleaksAiImageDetectionResponseModel.ts
  • CopyleaksAiImageDetectionImageInfoModel.ts

  Request Models (models\request\AiImageDetection):

  • CopyleaksAiImageDetectionRequestModel.ts

How to Use:

Getting started with AI Image Detection is straightforward:

• Example Usage: Explore the new demo\examples\ai-detection.js for a practical demonstration of how to initiate an AI image detection scan and interpret the results.
• Updated Documentation: The README.md file has been updated with a dedicated section and example for AI Image Detection, making it easier to integrate into your projects.

v5.0.0

1. The AI Code Detection feature has been removed from our SDKs.
2. In addition to this change, we've updated the README file. It now offers enhanced documentation, including detailed descriptions and clear steps, to help you more effectively explore and use our SDK.

v4.5.0

Deprecation Notice
This release includes a warning message that will pop up for users who use the AI CODE DETECTION that it will be discontinued.

AI Code Detection will be discontinued on August 29, 2025.
Please remove AI code detection integrations before the sunset date.

v4.4.1

Added deprecation warning for AI Code detection.
"AI Code Detection will be discontinued on August 29, 2025.
Please remove AI code detection integrations before the sunset date."
when updating the package version or installing the package.

v4.4.0

This release contains our new Text Moderation Scanning feature, which provides real-time content moderation capabilities to help you maintain safe and appropriate content across your platform. The API automatically scans and flags potentially harmful content across multiple categories, enabling you to protect your users and uphold community standards.

Usage Example:
Check index.js at demo folder for example on sending request to the Text Moderation API and working with the relevant models.

Key Files and Models:

1. TextModerationClient.ts
2. CopyleaksTextModerationRequestModel.ts(for sending requests to the Text Moderation API)
3. CopyleaksTextModerationResponseModel.ts (for deserializing API responses)

Helper Models for the main response model:

1. ModerationsModel.ts
2. Text.ts
3. TextModerationCharsModel.ts
4. TextModerationScannedDocumentModel.ts
5. TextModerationsLegendModel.ts

v4.3.0

Fixed Typos and added to index

v4.2.0

Webhooks Model Integration

All Webhook Models Added: We have successfully integrated all models corresponding to the various webhook events you can receive from Copyleaks servers. This includes models for:

• completed: Indicates a scan that has successfully finished.
• error: Represents a scan that ended with an error.
• creditsChecked: Provides information about the credit cost estimation for a scan.
• indexed: Signifies that a submitted file has been indexed into Copyleaks' internal database.
• new-result: Reports newly found results instantly, providing a real-time stream of updates.
• export complete: Triggers after an export request completes;

These models allow users to effectively handle and utilize data received from Copyleaks, enhancing the overall functionality and adaptability of our platform.

Demo Update

• Server Listening to Webhooks: Our demo now includes a server component designed to listen for incoming webhooks from Copyleaks. This practical example demonstrates how to handle these in real-time, serving as a guide for your own implementations.
• Deserialization Guide: Learn how to employ Copyleaks classes to deserialize incoming webhook data efficiently. This new capability ensures you can easily parse and manipulate the data received, simplifying integration and improving data management.

v4.1.0

Release Notes:

1. AI detection - adding support for ai detection functions to detect AI generated text in both natural language and source code.
2. Writing Assistant - adding support for writing assistant functions to help assess the quality of text.
3. New property
   properties.filters.allowSameDomain - when set to true it will allow results from the same domain as the submitted url.

v4.0.0

Release notes:

added properties:

• properties.scanMethodAlgorithm
• properties.indexing.repositories[].maskingPolicy
• properties.exclude.citations
• properties.exclude.documentTemplateIds
• properties.pdf.version
• properties.aiGeneratedText.detect
• properties.customMetadata
• Properties.priority
• Properties.exclude.code.comments
• properties.pdf.colors.mainStrip
• properties.pdf.colors.titles
• properties.pdf.colors.identical
• properties.pdf.colors.minorChanges
• properties.pdf.colors.relatedMeaning
• properties.scanning.crossLanguages.languages[]
• properties.scanning.crossLanguages.languages[].code

v3.1.0

Release Notes:

1. We now use v3/scans endpoints instead of product specific endpoints
2. You can now use different domains as copyleaks api and copyleaks id