cybertipline-tools 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Johannes Andersen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# CyberTipline Tools
+
+A **unofficial** collection of tools for interacting with the National Center for Missing & Exploited Children's [CyberTipline Reporting API](https://report.cybertip.org/ispws/documentation).
+
+## Installation
+
+```bash
+pnpm install cybertipline-tools
+```
+
+## Requirements
+
+We officially support Node.js 22.x and later, but the library may work on older versions.
+
+The package exports ESM modules, so you may need to do some extra configuration to use it in a CommonJS environment.
+
+## Features
+
+- TypeScript support
+  - We export TypeScript declaration files with the package for all documented APIs.
+- Inline documentation
+  - We document all our APIs and types with JSDoc comments to give you inline documentation in your editor.
+
+Coming soon™️:
+- [ ] API client, ability to call the CyberTipline APIs
+- [ ] JSON to XML converter. Convert JSON objects to XML strings for use in the CyberTipline API.
+- [ ] Support batch reporting
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+
+## Links
+
+- Official API documentation: [CyberTipline Reporting API](https://report.cybertip.org/ispws/documentation)
+- Apply for access to [NCMEC CyberTipline](https://esp.ncmec.org/registration)

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+export * from './types/transactions/CancelReport.js';
+export * from './types/transactions/FinishReport.js';
+export * from './types/transactions/Report.js';
+export * from './types/transactions/SubmitFileDetails.js';
+export * from './types/transactions/UploadFile.js';
+export * from './types/reportDetails/IncidentSummary.js';
+export * from './types/reportDetails/IntendedRecipient.js';
+export * from './types/reportDetails/LawEnforcement.js';
+export * from './types/reportDetails/PersonOrUserReported.js';
+export * from './types/reportDetails/Reporter.js';
+export * from './types/reportDetails/Victim.js';
+export * from './types/fileDetails/FileDetails.js';
+export * from './types/fileDetails/OriginalFileHash.js';
+export * from './types/incidents/CellPhoneIncident.js';
+export * from './types/incidents/ChatImIncident.js';
+export * from './types/incidents/EmailIncident.js';
+export * from './types/incidents/NewsgroupIncident.js';
+export * from './types/incidents/NonInternetIncident.js';
+export * from './types/incidents/OnlineGamingIncident.js';
+export * from './types/incidents/Peer2peerIncident.js';
+export * from './types/incidents/WebPageIncident.js';
+export * from './types/common/Address.js';
+export * from './types/common/DeviceId.js';
+export * from './types/common/Email.js';
+export * from './types/common/EstimatedLocation.js';
+export * from './types/common/IpCapture.js';
+export * from './types/common/Person.js';
+export * from './types/common/Phone.js';
+export * from './types/Constants.js';

package/dist/index.js

@@ -0,0 +1,30 @@
+export * from './types/transactions/CancelReport.js';
+export * from './types/transactions/FinishReport.js';
+export * from './types/transactions/Report.js';
+export * from './types/transactions/SubmitFileDetails.js';
+export * from './types/transactions/UploadFile.js';
+export * from './types/reportDetails/IncidentSummary.js';
+export * from './types/reportDetails/IntendedRecipient.js';
+export * from './types/reportDetails/LawEnforcement.js';
+export * from './types/reportDetails/PersonOrUserReported.js';
+export * from './types/reportDetails/Reporter.js';
+export * from './types/reportDetails/Victim.js';
+export * from './types/fileDetails/FileDetails.js';
+export * from './types/fileDetails/OriginalFileHash.js';
+export * from './types/incidents/CellPhoneIncident.js';
+export * from './types/incidents/ChatImIncident.js';
+export * from './types/incidents/EmailIncident.js';
+export * from './types/incidents/NewsgroupIncident.js';
+export * from './types/incidents/NonInternetIncident.js';
+export * from './types/incidents/OnlineGamingIncident.js';
+export * from './types/incidents/Peer2peerIncident.js';
+export * from './types/incidents/WebPageIncident.js';
+export * from './types/common/Address.js';
+export * from './types/common/DeviceId.js';
+export * from './types/common/Email.js';
+export * from './types/common/EstimatedLocation.js';
+export * from './types/common/IpCapture.js';
+export * from './types/common/Person.js';
+export * from './types/common/Phone.js';
+export * from './types/Constants.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sCAAsC,CAAC;AACrD,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,oCAAoC,CAAC;AAEnD,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,yCAAyC,CAAC;AACxD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,mCAAmC,CAAC;AAClD,cAAc,iCAAiC,CAAC;AAEhD,cAAc,oCAAoC,CAAC;AACnD,cAAc,yCAAyC,CAAC;AAExD,cAAc,wCAAwC,CAAC;AACvD,cAAc,qCAAqC,CAAC;AACpD,cAAc,oCAAoC,CAAC;AACnD,cAAc,wCAAwC,CAAC;AACvD,cAAc,0CAA0C,CAAC;AACzD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,wCAAwC,CAAC;AACvD,cAAc,sCAAsC,CAAC;AAErD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC;AACxC,cAAc,qCAAqC,CAAC;AACpD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AAExC,cAAc,sBAAsB,CAAC"}

package/dist/types/Constants.d.ts

@@ -0,0 +1,135 @@
+/**
+ * The response code returned from the submittal. 0 is success, any non-zero number is an error code.
+ *
+ * The following is a non-exhaustive list of possible error codes.
+ * @see https://report.cybertip.org/ispws/documentation/index.html#report-response
+ */
+export declare enum ResponseCode {
+    /** Success */
+    Success = 0,
+    /** Server error */
+    ServerError = 1000,
+    /** Save failed */
+    SaveFailed = 1100,
+    /** Upload failed */
+    UploadFailed = 1110,
+    /** File upload failed */
+    FileUploadFailed = 1111,
+    /** Resource not found */
+    ResourceNotFound = 1210,
+    /** Update failed */
+    UpdateFailed = 1300,
+    /** Authentication required */
+    AuthenticationRequired = 2000,
+    /** User is not authorized to perform this action */
+    NotAuthorized = 3000,
+    /** User does not have authorization to make submissions */
+    NotAuthorizedForSubmissions = 3100,
+    /** User does not have authorization to make updates */
+    NotAuthorizedForUpdates = 3300,
+    /** Invalid request */
+    InvalidRequest = 4000,
+    /** Validation failed */
+    ValidationFailed = 4100,
+    /** Malformed XML submittal */
+    MalformedXmlSubmittal = 4110,
+    /** Malformed file submittal */
+    MalformedFileSubmittal = 4200,
+    /** Report does not exist */
+    ReportDoesNotExist = 5001,
+    /** File does not exist */
+    FileDoesNotExist = 5002,
+    /** Report already retracted */
+    ReportAlreadyRetracted = 5101,
+    /** Report already finished */
+    ReportAlreadyFinished = 5102
+}
+export declare enum IncidentType {
+    ChildPornography = "Child Pornography (possession, manufacture, and distribution)",
+    ChildSexTrafficking = "Child Sex Trafficking",
+    ChildSexTourism = "Child Sex Tourism",
+    ChildSexualMolestation = "Child Sexual Molestation",
+    MisleadingDomainName = "Misleading Domain Name",
+    MisleadingWordsOrImages = "Misleading Words or Digital Images on the Internet",
+    OnlineEnticement = "Online Enticement of Children for Sexual Act",
+    UnsolicitedObsceneMaterial = "Unsolicited Obscene Material Sent to a Child"
+}
+/**
+ * Tags to describe the report.
+ * @see https://report.cybertip.org/ispws/documentation/index.html#report-annotations
+ */
+export declare enum ReportAnnotation {
+    /** The report is associated with sextortion. */
+    Sextortion = "sextortion",
+    /** The report is associated with solicitation of child sexual assault material (CSAM). */
+    CsamSolicitation = "csamSolicitation",
+    /** The report is associated with an interaction between minors. */
+    MinorToMinorInteraction = "minorToMinorInteraction",
+    /** The report is associated with spam. */
+    Spam = "spam"
+}
+/**
+ * Tags used to describe a file.
+ *
+ * @see https://report.cybertip.org/ispws/documentation/index.html#file-annotations
+ */
+export declare enum FileAnnotations {
+    /** The file is depicting anime, drawing, cartoon, virtual or hentai. */
+    AnimeDrawingVirtualHentai = "animeDrawingVirtualHentai",
+    /** The file is being shared/posted out of mimicry or other seemingly non-malicious intent. */
+    PotentialMeme = "potentialMeme",
+    /** The file is circulating rapidly from one user to another. */
+    Viral = "viral",
+    /** The file contains content that is believed to be self-produced */
+    PossibleSelfProduction = "possibleSelfProduction",
+    /** The file depicts an intentional act of causing physical injury or trauma to a person. */
+    PhysicalHarm = "physicalHarm",
+    /** The file depicts graphic violence, including but not limited to acts of brutality or detailed or vivid gruesomeness. */
+    ViolenceGore = "violenceGore",
+    /** The file involves an animal. */
+    Bestiality = "bestiality",
+    /** The file depicts content that was streamed live at the time it was uploaded. */
+    LiveStreaming = "liveStreaming",
+    /** The file depicts an infant. */
+    Infant = "infant",
+    /** The file contains content that is believed to be Generative Artificial Intelligence. */
+    GenerativeAI = "generativeAi"
+}
+export declare enum FileRelevance {
+    /** Content that is the motivation for making the CyberTipline report, according to the chosen incident type.
+     *
+     * Only "Reported" files may be identified as potential meme or be given an industry classification.
+     */
+    Reported = "Reported",
+    /** Supplementary content that provides contextual value to the report.
+     *
+     * A part of the communication containing apparent child pornography, including any data or information regarding the transmission of the communication
+     * or any images, data, or other digital files contained in, or attached to, the communication (18 U.S. Code § 2258A (b)(5)).
+     */
+    SupplementalReported = "Supplemental Reported"
+}
+/**
+ * A = Prepubescent Minor
+ * B = Pubescent Minor
+ *
+ * 1 (Sex Act): Any imagery depicting sexual intercourse (
+ * including genital-genital, oral-genital, anal-genital,
+ * or oral-anal whether between person of the same or opposite sex),
+ * bestiality, masturbation, sadistic or masochistic abuse, degradation,
+ * or any such depiction of the above that lacks serious literary, artistic, political, or scientific value.
+ *
+ * 2 (Lascivious Exhibition): Any imagery depicting the lascivious exhibition of the anus, genitals, or pubic area of any person,
+ * where a minor is engaging in the lascivious exhibition or being used in connection with sexually explicit conduct,
+ * which may include but is not limited to imagery where the focal point is on the child's anus, genitals,
+ * or pubic area and where the depiction is intended or designed to elicit a sexual response in the viewer.
+ */
+export declare enum IndustryClassification {
+    /** Prepubescent Minor - Sex Act*/
+    A1 = "A1",
+    /** Prepubescent Minor - Lascivious Exhibition */
+    A2 = "A2",
+    /** Pubescent Minor - Sex Act */
+    B1 = "B1",
+    /** Pubescent Minor - Lascivious Exhibition */
+    B2 = "B2"
+}

package/dist/types/Constants.js

@@ -0,0 +1,142 @@
+/**
+ * The response code returned from the submittal. 0 is success, any non-zero number is an error code.
+ *
+ * The following is a non-exhaustive list of possible error codes.
+ * @see https://report.cybertip.org/ispws/documentation/index.html#report-response
+ */
+export var ResponseCode;
+(function (ResponseCode) {
+    /** Success */
+    ResponseCode[ResponseCode["Success"] = 0] = "Success";
+    /** Server error */
+    ResponseCode[ResponseCode["ServerError"] = 1000] = "ServerError";
+    /** Save failed */
+    ResponseCode[ResponseCode["SaveFailed"] = 1100] = "SaveFailed";
+    /** Upload failed */
+    ResponseCode[ResponseCode["UploadFailed"] = 1110] = "UploadFailed";
+    /** File upload failed */
+    ResponseCode[ResponseCode["FileUploadFailed"] = 1111] = "FileUploadFailed";
+    /** Resource not found */
+    ResponseCode[ResponseCode["ResourceNotFound"] = 1210] = "ResourceNotFound";
+    /** Update failed */
+    ResponseCode[ResponseCode["UpdateFailed"] = 1300] = "UpdateFailed";
+    /** Authentication required */
+    ResponseCode[ResponseCode["AuthenticationRequired"] = 2000] = "AuthenticationRequired";
+    /** User is not authorized to perform this action */
+    ResponseCode[ResponseCode["NotAuthorized"] = 3000] = "NotAuthorized";
+    /** User does not have authorization to make submissions */
+    ResponseCode[ResponseCode["NotAuthorizedForSubmissions"] = 3100] = "NotAuthorizedForSubmissions";
+    /** User does not have authorization to make updates */
+    ResponseCode[ResponseCode["NotAuthorizedForUpdates"] = 3300] = "NotAuthorizedForUpdates";
+    /** Invalid request */
+    ResponseCode[ResponseCode["InvalidRequest"] = 4000] = "InvalidRequest";
+    /** Validation failed */
+    ResponseCode[ResponseCode["ValidationFailed"] = 4100] = "ValidationFailed";
+    /** Malformed XML submittal */
+    ResponseCode[ResponseCode["MalformedXmlSubmittal"] = 4110] = "MalformedXmlSubmittal";
+    /** Malformed file submittal */
+    ResponseCode[ResponseCode["MalformedFileSubmittal"] = 4200] = "MalformedFileSubmittal";
+    /** Report does not exist */
+    ResponseCode[ResponseCode["ReportDoesNotExist"] = 5001] = "ReportDoesNotExist";
+    /** File does not exist */
+    ResponseCode[ResponseCode["FileDoesNotExist"] = 5002] = "FileDoesNotExist";
+    /** Report already retracted */
+    ResponseCode[ResponseCode["ReportAlreadyRetracted"] = 5101] = "ReportAlreadyRetracted";
+    /** Report already finished */
+    ResponseCode[ResponseCode["ReportAlreadyFinished"] = 5102] = "ReportAlreadyFinished";
+})(ResponseCode || (ResponseCode = {}));
+export var IncidentType;
+(function (IncidentType) {
+    IncidentType["ChildPornography"] = "Child Pornography (possession, manufacture, and distribution)";
+    IncidentType["ChildSexTrafficking"] = "Child Sex Trafficking";
+    IncidentType["ChildSexTourism"] = "Child Sex Tourism";
+    IncidentType["ChildSexualMolestation"] = "Child Sexual Molestation";
+    IncidentType["MisleadingDomainName"] = "Misleading Domain Name";
+    IncidentType["MisleadingWordsOrImages"] = "Misleading Words or Digital Images on the Internet";
+    IncidentType["OnlineEnticement"] = "Online Enticement of Children for Sexual Act";
+    IncidentType["UnsolicitedObsceneMaterial"] = "Unsolicited Obscene Material Sent to a Child";
+})(IncidentType || (IncidentType = {}));
+/**
+ * Tags to describe the report.
+ * @see https://report.cybertip.org/ispws/documentation/index.html#report-annotations
+ */
+export var ReportAnnotation;
+(function (ReportAnnotation) {
+    /** The report is associated with sextortion. */
+    ReportAnnotation["Sextortion"] = "sextortion";
+    /** The report is associated with solicitation of child sexual assault material (CSAM). */
+    ReportAnnotation["CsamSolicitation"] = "csamSolicitation";
+    /** The report is associated with an interaction between minors. */
+    ReportAnnotation["MinorToMinorInteraction"] = "minorToMinorInteraction";
+    /** The report is associated with spam. */
+    ReportAnnotation["Spam"] = "spam";
+})(ReportAnnotation || (ReportAnnotation = {}));
+/**
+ * Tags used to describe a file.
+ *
+ * @see https://report.cybertip.org/ispws/documentation/index.html#file-annotations
+ */
+export var FileAnnotations;
+(function (FileAnnotations) {
+    /** The file is depicting anime, drawing, cartoon, virtual or hentai. */
+    FileAnnotations["AnimeDrawingVirtualHentai"] = "animeDrawingVirtualHentai";
+    /** The file is being shared/posted out of mimicry or other seemingly non-malicious intent. */
+    FileAnnotations["PotentialMeme"] = "potentialMeme";
+    /** The file is circulating rapidly from one user to another. */
+    FileAnnotations["Viral"] = "viral";
+    /** The file contains content that is believed to be self-produced */
+    FileAnnotations["PossibleSelfProduction"] = "possibleSelfProduction";
+    /** The file depicts an intentional act of causing physical injury or trauma to a person. */
+    FileAnnotations["PhysicalHarm"] = "physicalHarm";
+    /** The file depicts graphic violence, including but not limited to acts of brutality or detailed or vivid gruesomeness. */
+    FileAnnotations["ViolenceGore"] = "violenceGore";
+    /** The file involves an animal. */
+    FileAnnotations["Bestiality"] = "bestiality";
+    /** The file depicts content that was streamed live at the time it was uploaded. */
+    FileAnnotations["LiveStreaming"] = "liveStreaming";
+    /** The file depicts an infant. */
+    FileAnnotations["Infant"] = "infant";
+    /** The file contains content that is believed to be Generative Artificial Intelligence. */
+    FileAnnotations["GenerativeAI"] = "generativeAi";
+})(FileAnnotations || (FileAnnotations = {}));
+export var FileRelevance;
+(function (FileRelevance) {
+    /** Content that is the motivation for making the CyberTipline report, according to the chosen incident type.
+     *
+     * Only "Reported" files may be identified as potential meme or be given an industry classification.
+     */
+    FileRelevance["Reported"] = "Reported";
+    /** Supplementary content that provides contextual value to the report.
+     *
+     * A part of the communication containing apparent child pornography, including any data or information regarding the transmission of the communication
+     * or any images, data, or other digital files contained in, or attached to, the communication (18 U.S. Code § 2258A (b)(5)).
+     */
+    FileRelevance["SupplementalReported"] = "Supplemental Reported";
+})(FileRelevance || (FileRelevance = {}));
+/**
+ * A = Prepubescent Minor
+ * B = Pubescent Minor
+ *
+ * 1 (Sex Act): Any imagery depicting sexual intercourse (
+ * including genital-genital, oral-genital, anal-genital,
+ * or oral-anal whether between person of the same or opposite sex),
+ * bestiality, masturbation, sadistic or masochistic abuse, degradation,
+ * or any such depiction of the above that lacks serious literary, artistic, political, or scientific value.
+ *
+ * 2 (Lascivious Exhibition): Any imagery depicting the lascivious exhibition of the anus, genitals, or pubic area of any person,
+ * where a minor is engaging in the lascivious exhibition or being used in connection with sexually explicit conduct,
+ * which may include but is not limited to imagery where the focal point is on the child's anus, genitals,
+ * or pubic area and where the depiction is intended or designed to elicit a sexual response in the viewer.
+ */
+export var IndustryClassification;
+(function (IndustryClassification) {
+    /** Prepubescent Minor - Sex Act*/
+    IndustryClassification["A1"] = "A1";
+    /** Prepubescent Minor - Lascivious Exhibition */
+    IndustryClassification["A2"] = "A2";
+    /** Pubescent Minor - Sex Act */
+    IndustryClassification["B1"] = "B1";
+    /** Pubescent Minor - Lascivious Exhibition */
+    IndustryClassification["B2"] = "B2";
+})(IndustryClassification || (IndustryClassification = {}));
+//# sourceMappingURL=Constants.js.map

package/dist/types/Constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Constants.js","sourceRoot":"","sources":["../../src/types/Constants.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAN,IAAY,YAuCX;AAvCD,WAAY,YAAY;IACtB,cAAc;IACd,qDAAW,CAAA;IACX,mBAAmB;IACnB,gEAAkB,CAAA;IAClB,kBAAkB;IAClB,8DAAiB,CAAA;IACjB,oBAAoB;IACpB,kEAAmB,CAAA;IACnB,yBAAyB;IACzB,0EAAuB,CAAA;IACvB,yBAAyB;IACzB,0EAAuB,CAAA;IACvB,oBAAoB;IACpB,kEAAmB,CAAA;IACnB,8BAA8B;IAC9B,sFAA6B,CAAA;IAC7B,oDAAoD;IACpD,oEAAoB,CAAA;IACpB,2DAA2D;IAC3D,gGAAkC,CAAA;IAClC,uDAAuD;IACvD,wFAA8B,CAAA;IAC9B,sBAAsB;IACtB,sEAAqB,CAAA;IACrB,wBAAwB;IACxB,0EAAuB,CAAA;IACvB,8BAA8B;IAC9B,oFAA4B,CAAA;IAC5B,+BAA+B;IAC/B,sFAA6B,CAAA;IAC7B,4BAA4B;IAC5B,8EAAyB,CAAA;IACzB,0BAA0B;IAC1B,0EAAuB,CAAA;IACvB,+BAA+B;IAC/B,sFAA6B,CAAA;IAC7B,8BAA8B;IAC9B,oFAA4B,CAAA;AAC9B,CAAC,EAvCW,YAAY,KAAZ,YAAY,QAuCvB;AAED,MAAM,CAAN,IAAY,YASX;AATD,WAAY,YAAY;IACtB,kGAAkF,CAAA;IAClF,6DAA6C,CAAA;IAC7C,qDAAqC,CAAA;IACrC,mEAAmD,CAAA;IACnD,+DAA+C,CAAA;IAC/C,8FAA8E,CAAA;IAC9E,iFAAiE,CAAA;IACjE,2FAA2E,CAAA;AAC7E,CAAC,EATW,YAAY,KAAZ,YAAY,QASvB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,gBASX;AATD,WAAY,gBAAgB;IAC1B,gDAAgD;IAChD,6CAAyB,CAAA;IACzB,0FAA0F;IAC1F,yDAAqC,CAAA;IACrC,mEAAmE;IACnE,uEAAmD,CAAA;IACnD,0CAA0C;IAC1C,iCAAa,CAAA;AACf,CAAC,EATW,gBAAgB,KAAhB,gBAAgB,QAS3B;AAED;;;;GAIG;AACH,MAAM,CAAN,IAAY,eAqBX;AArBD,WAAY,eAAe;IACzB,wEAAwE;IACxE,0EAAuD,CAAA;IACvD,8FAA8F;IAC9F,kDAA+B,CAAA;IAC/B,gEAAgE;IAChE,kCAAe,CAAA;IACf,qEAAqE;IACrE,oEAAiD,CAAA;IACjD,4FAA4F;IAC5F,gDAA6B,CAAA;IAC7B,2HAA2H;IAC3H,gDAA6B,CAAA;IAC7B,mCAAmC;IACnC,4CAAyB,CAAA;IACzB,mFAAmF;IACnF,kDAA+B,CAAA;IAC/B,kCAAkC;IAClC,oCAAiB,CAAA;IACjB,2FAA2F;IAC3F,gDAA6B,CAAA;AAC/B,CAAC,EArBW,eAAe,KAAf,eAAe,QAqB1B;AAED,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB;;;OAGG;IACH,sCAAqB,CAAA;IACrB;;;;OAIG;IACH,+DAA8C,CAAA;AAChD,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAN,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,kCAAkC;IAClC,mCAAS,CAAA;IACT,iDAAiD;IACjD,mCAAS,CAAA;IACT,gCAAgC;IAChC,mCAAS,CAAA;IACT,8CAA8C;IAC9C,mCAAS,CAAA;AACX,CAAC,EATW,sBAAsB,KAAtB,sBAAsB,QASjC"}

package/dist/types/TypeUtils.d.ts

@@ -0,0 +1,3 @@
+export type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};

package/dist/types/TypeUtils.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=TypeUtils.js.map

package/dist/types/TypeUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypeUtils.js","sourceRoot":"","sources":["../../src/types/TypeUtils.ts"],"names":[],"mappings":""}

package/dist/types/common/Address.d.ts

@@ -0,0 +1,26 @@
+export declare enum AddressType {
+    Home = "Home",
+    Business = "Business",
+    Billing = "Billing",
+    Shipping = "Shipping",
+    Technical = "Technical"
+}
+/**
+ * A physical street address.
+ */
+export interface Address {
+    /** Street address. */
+    address?: string;
+    /** City. */
+    city?: string;
+    /** Zip or postal code. */
+    zipCode?: string;
+    /** US state or territory postal abbreviation. */
+    state?: string;
+    /** State, province, or region if not in the United States. */
+    nonUsaState?: string;
+    /** ISO 3166-1 alpha-2 two-character country code. */
+    country?: string;
+    /** Type of address. */
+    type?: AddressType;
+}

package/dist/types/common/Address.js

@@ -0,0 +1,9 @@
+export var AddressType;
+(function (AddressType) {
+    AddressType["Home"] = "Home";
+    AddressType["Business"] = "Business";
+    AddressType["Billing"] = "Billing";
+    AddressType["Shipping"] = "Shipping";
+    AddressType["Technical"] = "Technical";
+})(AddressType || (AddressType = {}));
+//# sourceMappingURL=Address.js.map

package/dist/types/common/Address.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Address.js","sourceRoot":"","sources":["../../../src/types/common/Address.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,oCAAqB,CAAA;IACrB,kCAAmB,CAAA;IACnB,oCAAqB,CAAA;IACrB,sCAAuB,CAAA;AACzB,CAAC,EANW,WAAW,KAAX,WAAW,QAMtB"}

package/dist/types/common/DeviceId.d.ts

@@ -0,0 +1,26 @@
+export declare enum DeviceEventName {
+    Login = "Login",
+    Registration = "Registration",
+    Purchase = "Purchase",
+    Upload = "Upload",
+    Other = "Other",
+    Unknown = "Unknown"
+}
+export declare enum DeviceIdType {
+    IMEI = "IMEI",
+    ICCID = "ICCID",
+    SSID = "SSID"
+}
+/**
+ * A capture of a device ID. Similar to <ipCaptureEvent>.
+ * Used to report information such as ICCID or IMEI numbers associated with an event.
+ */
+export interface DeviceId {
+    /** The type of device ID captured (e.g., IMEI, ICCID, SSID). */
+    idType: DeviceIdType | string;
+    idValue: string;
+    /** The type of event from which the device ID was captured. */
+    eventName?: DeviceEventName;
+    /** The date and time the device ID was captured. */
+    dateTime?: Date;
+}

package/dist/types/common/DeviceId.js

@@ -0,0 +1,16 @@
+export var DeviceEventName;
+(function (DeviceEventName) {
+    DeviceEventName["Login"] = "Login";
+    DeviceEventName["Registration"] = "Registration";
+    DeviceEventName["Purchase"] = "Purchase";
+    DeviceEventName["Upload"] = "Upload";
+    DeviceEventName["Other"] = "Other";
+    DeviceEventName["Unknown"] = "Unknown";
+})(DeviceEventName || (DeviceEventName = {}));
+export var DeviceIdType;
+(function (DeviceIdType) {
+    DeviceIdType["IMEI"] = "IMEI";
+    DeviceIdType["ICCID"] = "ICCID";
+    DeviceIdType["SSID"] = "SSID";
+})(DeviceIdType || (DeviceIdType = {}));
+//# sourceMappingURL=DeviceId.js.map

package/dist/types/common/DeviceId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeviceId.js","sourceRoot":"","sources":["../../../src/types/common/DeviceId.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,eAOX;AAPD,WAAY,eAAe;IACzB,kCAAe,CAAA;IACf,gDAA6B,CAAA;IAC7B,wCAAqB,CAAA;IACrB,oCAAiB,CAAA;IACjB,kCAAe,CAAA;IACf,sCAAmB,CAAA;AACrB,CAAC,EAPW,eAAe,KAAf,eAAe,QAO1B;AAED,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,6BAAa,CAAA;IACb,+BAAe,CAAA;IACf,6BAAa,CAAA;AACf,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB"}

package/dist/types/common/Email.d.ts

@@ -0,0 +1,18 @@
+export declare enum EmailType {
+    Home = "Home",
+    Work = "Work",
+    Business = "Business"
+}
+/**
+ * An email address.
+ */
+export interface Email {
+    /** The email address. */
+    email: string;
+    /** Type of email address. */
+    type?: EmailType;
+    /** Whether the reporter has verified the email address. */
+    verified?: boolean;
+    /** The date and time that the reporter last verified the email address. */
+    verificationDate?: string;
+}

package/dist/types/common/Email.js

@@ -0,0 +1,7 @@
+export var EmailType;
+(function (EmailType) {
+    EmailType["Home"] = "Home";
+    EmailType["Work"] = "Work";
+    EmailType["Business"] = "Business";
+})(EmailType || (EmailType = {}));
+//# sourceMappingURL=Email.js.map

package/dist/types/common/Email.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Email.js","sourceRoot":"","sources":["../../../src/types/common/Email.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,0BAAa,CAAA;IACb,0BAAa,CAAA;IACb,kCAAqB,CAAA;AACvB,CAAC,EAJW,SAAS,KAAT,SAAS,QAIpB"}

package/dist/types/common/EstimatedLocation.d.ts

@@ -0,0 +1,15 @@
+/**
+ * An estimated location.
+ */
+export interface EstimatedLocation {
+    /** The city of the estimated location. */
+    city?: string;
+    /** The region of the estimated location. */
+    region?: string;
+    /** ISO 3166-1 alpha-2 two-character country code of the estimated location. */
+    countryCode?: string;
+    /** Whether the reporter has verified the estimated location. */
+    verified?: boolean;
+    /** The date and time the reporter made the location estimation. */
+    timestamp?: Date;
+}

package/dist/types/common/EstimatedLocation.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=EstimatedLocation.js.map

package/dist/types/common/EstimatedLocation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EstimatedLocation.js","sourceRoot":"","sources":["../../../src/types/common/EstimatedLocation.ts"],"names":[],"mappings":""}

package/dist/types/common/IpCapture.d.ts

@@ -0,0 +1,24 @@
+export declare enum IPEventName {
+    Login = "Login",
+    Registration = "Registration",
+    Purchase = "Purchase",
+    Upload = "Upload",
+    Other = "Other",
+    Unknown = "Unknown"
+}
+/**
+ * A capture of an IP address. For example, the IP address of the computer a user used
+ * to upload a csam picture and the time the upload happened.
+ */
+export interface IpCapture {
+    /** The IP address from which the event occurred. */
+    ipAddress: string;
+    /** The type of event from which the IP address was captured. */
+    eventName?: IPEventName;
+    /** The date and time the IP address was captured. */
+    dateTime?: Date;
+    /** Whether the reporter has reason to believe this IP address is a proxy. */
+    possibleProxy?: boolean;
+    /** The port number of the IP address. */
+    port?: number;
+}

package/dist/types/common/IpCapture.js

@@ -0,0 +1,10 @@
+export var IPEventName;
+(function (IPEventName) {
+    IPEventName["Login"] = "Login";
+    IPEventName["Registration"] = "Registration";
+    IPEventName["Purchase"] = "Purchase";
+    IPEventName["Upload"] = "Upload";
+    IPEventName["Other"] = "Other";
+    IPEventName["Unknown"] = "Unknown";
+})(IPEventName || (IPEventName = {}));
+//# sourceMappingURL=IpCapture.js.map

package/dist/types/common/IpCapture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IpCapture.js","sourceRoot":"","sources":["../../../src/types/common/IpCapture.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,4CAA6B,CAAA;IAC7B,oCAAqB,CAAA;IACrB,gCAAiB,CAAA;IACjB,8BAAe,CAAA;IACf,kCAAmB,CAAA;AACrB,CAAC,EAPW,WAAW,KAAX,WAAW,QAOtB"}

package/dist/types/common/Person.d.ts

@@ -0,0 +1,24 @@
+import type { Address } from './Address.js';
+import type { Email } from './Email.js';
+import type { Phone } from './Phone.js';
+/** A real world person. */
+export interface Person {
+    /** The person’s first name. */
+    firstName?: string;
+    /** The person’s last name. */
+    lastName?: string;
+    /** A phone number. */
+    phone?: Array<Phone>;
+    /** An email address. */
+    email?: Array<Email>;
+    /** A physical address. */
+    address?: Array<Address>;
+    /** The person’s approximate age. */
+    age?: number;
+    /** The person’s date of birth. */
+    dateOfBirth?: Date;
+}
+/**
+ * A real world person with information pertinent for professional contact.
+ */
+export type ContactPerson = Omit<Person, 'age' | 'dateOfBirth'>;

package/dist/types/common/Person.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Person.js.map

package/dist/types/common/Person.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Person.js","sourceRoot":"","sources":["../../../src/types/common/Person.ts"],"names":[],"mappings":""}