cybertipline-tools 0.0.1

package/dist/types/transactions/Report.d.ts

@@ -0,0 +1,49 @@
+import type { ResponseCode } from '../Constants.js';
+import type { CellPhoneIncident } from '../incidents/CellPhoneIncident.js';
+import type { ChatImIncident } from '../incidents/ChatImIncident.js';
+import type { EmailIncident } from '../incidents/EmailIncident.js';
+import type { NewsgroupIncident } from '../incidents/NewsgroupIncident.js';
+import type { NonInternetIncident } from '../incidents/NonInternetIncident.js';
+import type { OnlineGamingIncident } from '../incidents/OnlineGamingIncident.js';
+import type { Peer2peerIncident } from '../incidents/Peer2peerIncident.js';
+import type { WebPageIncident } from '../incidents/WebPageIncident.js';
+import type { IncidentSummary } from '../reportDetails/IncidentSummary.js';
+import type { IntendedRecipient } from '../reportDetails/IntendedRecipient.js';
+import type { LawEnforcement } from '../reportDetails/LawEnforcement.js';
+import type { PersonOrUserReported } from '../reportDetails/PersonOrUserReported.js';
+import type { Reporter } from '../reportDetails/Reporter.js';
+import type { Victim } from '../reportDetails/Victim.js';
+/**
+ * Request properties for the Report endpoint.
+ *
+ * @see https://report.cybertip.org/ispws/documentation/index.html#report-details-types
+ */
+export interface Report {
+    /** General incident information. */
+    incidentSummary: IncidentSummary;
+    /** Details of an incident being reported. */
+    internetDetails?: Array<WebPageIncident | EmailIncident | NewsgroupIncident | ChatImIncident | OnlineGamingIncident | CellPhoneIncident | NonInternetIncident | Peer2peerIncident>;
+    /** Law enforcement contact information if the incident information has already been reported to law enforcement or if the request originated from law enforcement. */
+    lawEnforcement?: LawEnforcement;
+    /** Information related to the person or company reporting the incident. */
+    reporter: Reporter;
+    /** The reported user or person involved in the incident. This person will be displayed as the suspect. */
+    personOrUserReported?: PersonOrUserReported;
+    /** An intended recipient(s) involved in the incident. */
+    intendedRecipient?: Array<IntendedRecipient>;
+    /** The victim(s) of the incident. */
+    victim?: Array<Victim>;
+    /** Additional notes on this incident not covered by any other section. */
+    additionalInfo?: string;
+}
+/**
+ * Response properties for the Report endpoint.
+ */
+export interface ReportResponse {
+    /** The response code returned from the submittal. Response code 0 indicates successful report submission, any non-zero number is an error code. */
+    responseCode: ResponseCode | number;
+    /** A description of the response code. */
+    responseDescription: string;
+    /** Report ID assigned to the submitted report. */
+    reportId: string;
+}

package/dist/types/transactions/Report.js

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

package/dist/types/transactions/Report.js.map

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

package/dist/types/transactions/SubmitFileDetails.d.ts

@@ -0,0 +1,56 @@
+import type { FileAnnotations, FileRelevance, IndustryClassification, ResponseCode } from '../Constants.js';
+import type { DeviceId } from '../common/DeviceId.js';
+import type { IpCapture } from '../common/IpCapture.js';
+import type { FileDetails } from '../fileDetails/FileDetails.js';
+import type { OriginalFileHash } from '../fileDetails/OriginalFileHash.js';
+/**
+ * POST properties for the Submit File Details endpoint.
+ *
+ * @interface SubmitFileDetails
+ * @see https://report.cybertip.org/ispws/documentation/index.html#submit-file-details
+ */
+export interface SubmitFileDetails {
+    /** The report ID to which the uploaded file is associated. */
+    reportId: number;
+    /** The ID of the file to which the annotations should be associated. */
+    fileId: string;
+    /** The stored name of the file. */
+    fileName?: string;
+    /** The original filename associated with the file when it was uploaded to the company's servers by the reported user or person. */
+    originalFileName?: string;
+    /** The URL where file was originally located. */
+    locationOfFile?: string;
+    /** Whether the reporting company viewed the entire contents of the file being reported to NCMEC. */
+    fileViewedByEsp?: boolean;
+    /** Whether the reporting company viewed the EXIF for the file being reported to NCMEC. */
+    exifViewedByEsp?: boolean;
+    /** Whether the entire contents of the file were publicly accessible to online users. */
+    publiclyAvailable?: boolean;
+    /** The relevance or relation of the file to the report. Unless specified otherwise, a file is "Reported" by default. */
+    fileRelevance?: FileRelevance;
+    /** Tags to describe the file. */
+    fileAnnotations?: Array<FileAnnotations>;
+    /** A categorization from the ESP-designated categorization scale. */
+    industryClassification?: IndustryClassification;
+    /** The original binary hash value of the file at the time it was uploaded by the reported user or person (prior to any potential modification by the reporter). */
+    originalFileHash?: Array<OriginalFileHash>;
+    /** An IP address associated with the file. */
+    ipCaptureEvent?: IpCapture;
+    /** IDs for devices associated with the file. */
+    deviceId?: Array<DeviceId>;
+    /** Metadata associated with the file. */
+    details?: Array<FileDetails>;
+    /** Additional information about this file not covered by any other section. */
+    additionalInfo?: Array<string>;
+}
+/**
+ * Response properties for the Submit File Details endpoint.
+ */
+export interface SubmitFileDetailsResponse {
+    /** The response code returned from the submittal. 0 is success, any non-zero number is an error code. */
+    responseCode: ResponseCode | number;
+    /** A description of the response code. */
+    responseDescription: string;
+    /** The report ID to which this response is related. */
+    reportId: string;
+}

package/dist/types/transactions/SubmitFileDetails.js

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

package/dist/types/transactions/SubmitFileDetails.js.map

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

package/dist/types/transactions/UploadFile.d.ts

@@ -0,0 +1,28 @@
+import type { ResponseCode } from '../Constants.js';
+/**
+ * POST properties for the Upload File endpoint.
+ *
+ * @interface UploadFile
+ * @see https://report.cybertip.org/ispws/documentation/index.html#upload-a-file
+ */
+export interface UploadFile {
+    /** The report ID to which the uploaded file should be associated. */
+    id: string;
+    /** The actual file being uploaded */
+    file: File;
+}
+/**
+ * Response properties for the Upload File endpoint.
+ */
+export interface UploadFileResponse {
+    /** The response code returned from the submittal. 0 is success, any non-zero number is an error code. */
+    responseCode: ResponseCode | number;
+    /** A description of the response code. */
+    responseDescription: string;
+    /** The report ID to which this response is related. */
+    reportId: string;
+    /** If a file was successfully uploaded, the file ID for the file. */
+    fileId?: string;
+    /** If a file was successfully uploaded, the MD5 hash of the file. */
+    hash?: string;
+}

package/dist/types/transactions/UploadFile.js

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

package/dist/types/transactions/UploadFile.js.map

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

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "cybertipline-tools",
+  "version": "0.0.1",
+  "description": "Unofficial Types and Utilities for working with the CyberTipline API",
+  "homepage": "https://github.com/Johannes-Andersen/Cybertipline-Tools",
+  "bugs": {
+    "url": "https://github.com/Johannes-Andersen/Cybertipline-Tools/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Johannes-Andersen/Cybertipline-Tools.git"
+  },
+  "author": "Johannes Andersen (https://johand.dev)",
+  "keywords": [
+    "cybertipline",
+    "NCMEC",
+    "utils"
+  ],
+  "license": "MIT",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "dist/index.js",
+  "engines": {
+    "node": "22.12.0",
+    "pnpm": "9"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "0.17.0",
+    "@biomejs/biome": "1.9.4",
+    "@changesets/cli": "2.27.10",
+    "typescript": "5.7.2"
+  },
+  "scripts": {
+    "build": "tsc",
+    "changeset": "changeset",
+    "local-release": "changeset version && changeset publish",
+    "check-exports": "attw --pack . --ignore-rules=cjs-resolves-to-esm",
+    "type-check": "tsc --noEmit",
+    "lint": "biome lint .",
+    "lint:fix": "biome lint --write .",
+    "format": "biome format .",
+    "format:fix": "biome format --write .",
+    "check": "biome check .",
+    "check:fix": "biome check --write ."
+  }
+}