@croct/sdk 0.22.2 → 0.22.4

package/channel/httpBeaconChannel.cjs

@@ -17,7 +17,8 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var httpBeaconChannel_exports = {};
 __export(httpBeaconChannel_exports, {
-  HttpBeaconChannel: () => HttpBeaconChannel
+  HttpBeaconChannel: () => HttpBeaconChannel,
+  TrackingErrorType: () => TrackingErrorType
 });
 module.exports = __toCommonJS(httpBeaconChannel_exports);
 var import_channel = require('./channel.cjs');
@@ -25,6 +26,11 @@ var import_logging = require('../logging/index.cjs');
 var import_error = require('../error.cjs');
 var import_constants = require('../constants.cjs');
 var import_help = require('../help.cjs');
+var TrackingErrorType = /* @__PURE__ */ ((TrackingErrorType2) => {
+  TrackingErrorType2["SUSPENDED_SERVICE"] = "https://croct.help/sdk/javascript/suspended-service";
+  TrackingErrorType2["INTERNAL_ERROR"] = "https://croct.help/api/event-tracking/internal-error";
+  return TrackingErrorType2;
+})(TrackingErrorType || {});
 class HttpBeaconChannel {
   constructor({ logger = new import_logging.NullLogger(), ...configuration }) {
     this.listeners = [];
@@ -58,7 +64,7 @@ class HttpBeaconChannel {
       if (response.ok) {
         if (response.status === 202) {
           this.logger.warn(
-            "Event tracking is currently suspended for this application, check the workspace settings. For help, see https://croct.help/sdk/javascript/suspended-service"
+            `Event tracking is currently suspended for this application, check the workspace settings. For help, see ${"https://croct.help/sdk/javascript/suspended-service" /* SUSPENDED_SERVICE */}`
           );
         }
         this.notify(receiptId);
@@ -66,13 +72,13 @@ class HttpBeaconChannel {
       }
       const problem = await response.json().catch(
         () => ({
-          type: "https://croct.help/api/event-tracker#unexpected-error",
+          type: "https://croct.help/api/event-tracking/internal-error" /* INTERNAL_ERROR */,
           title: response.statusText,
           status: response.status
         })
       );
       const isRetryable = HttpBeaconChannel.isRetryable(problem.status);
-      const help = import_help.Help.forStatusCode(problem.status);
+      const help = import_help.Help.forApiProblem(problem);
       if (help !== void 0) {
         this.logger.error(help);
       } else if (!isRetryable) {
@@ -112,5 +118,6 @@ class HttpBeaconChannel {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  HttpBeaconChannel
+  HttpBeaconChannel,
+  TrackingErrorType
 });

package/channel/httpBeaconChannel.d.cts

@@ -9,6 +9,10 @@ type Configuration = {
     cidAssigner: CidAssigner;
     logger?: Logger;
 };
+declare enum TrackingErrorType {
+    SUSPENDED_SERVICE = "https://croct.help/sdk/javascript/suspended-service",
+    INTERNAL_ERROR = "https://croct.help/api/event-tracking/internal-error"
+}
 declare class HttpBeaconChannel implements DuplexChannel<string, Envelope<string, string>> {
     private readonly configuration;
     private readonly logger;
@@ -23,4 +27,4 @@ declare class HttpBeaconChannel implements DuplexChannel<string, Envelope<string
     private static isRetryable;
 }
 
-export { type Configuration, HttpBeaconChannel };
+export { type Configuration, HttpBeaconChannel, TrackingErrorType };

package/channel/httpBeaconChannel.d.ts

@@ -9,6 +9,10 @@ type Configuration = {
     cidAssigner: CidAssigner;
     logger?: Logger;
 };
+declare enum TrackingErrorType {
+    SUSPENDED_SERVICE = "https://croct.help/sdk/javascript/suspended-service",
+    INTERNAL_ERROR = "https://croct.help/api/event-tracking/internal-error"
+}
 declare class HttpBeaconChannel implements DuplexChannel<string, Envelope<string, string>> {
     private readonly configuration;
     private readonly logger;
@@ -23,4 +27,4 @@ declare class HttpBeaconChannel implements DuplexChannel<string, Envelope<string
     private static isRetryable;
 }
 
-export { type Configuration, HttpBeaconChannel };
+export { type Configuration, HttpBeaconChannel, TrackingErrorType };

package/channel/httpBeaconChannel.js

@@ -3,6 +3,11 @@ import { NullLogger } from "../logging/index.js";
 import { formatMessage } from "../error.js";
 import { CLIENT_LIBRARY } from "../constants.js";
 import { Help } from "../help.js";
+var TrackingErrorType = /* @__PURE__ */ ((TrackingErrorType2) => {
+  TrackingErrorType2["SUSPENDED_SERVICE"] = "https://croct.help/sdk/javascript/suspended-service";
+  TrackingErrorType2["INTERNAL_ERROR"] = "https://croct.help/api/event-tracking/internal-error";
+  return TrackingErrorType2;
+})(TrackingErrorType || {});
 class HttpBeaconChannel {
   constructor({ logger = new NullLogger(), ...configuration }) {
     this.listeners = [];
@@ -36,7 +41,7 @@ class HttpBeaconChannel {
       if (response.ok) {
         if (response.status === 202) {
           this.logger.warn(
-            "Event tracking is currently suspended for this application, check the workspace settings. For help, see https://croct.help/sdk/javascript/suspended-service"
+            `Event tracking is currently suspended for this application, check the workspace settings. For help, see ${"https://croct.help/sdk/javascript/suspended-service" /* SUSPENDED_SERVICE */}`
           );
         }
         this.notify(receiptId);
@@ -44,13 +49,13 @@ class HttpBeaconChannel {
       }
       const problem = await response.json().catch(
         () => ({
-          type: "https://croct.help/api/event-tracker#unexpected-error",
+          type: "https://croct.help/api/event-tracking/internal-error" /* INTERNAL_ERROR */,
           title: response.statusText,
           status: response.status
         })
       );
       const isRetryable = HttpBeaconChannel.isRetryable(problem.status);
-      const help = Help.forStatusCode(problem.status);
+      const help = Help.forApiProblem(problem);
       if (help !== void 0) {
         this.logger.error(help);
       } else if (!isRetryable) {
@@ -89,5 +94,6 @@ class HttpBeaconChannel {
   }
 }
 export {
-  HttpBeaconChannel
+  HttpBeaconChannel,
+  TrackingErrorType
 };

package/constants.cjs

@@ -24,8 +24,8 @@ __export(constants_exports, {
 });
 module.exports = __toCommonJS(constants_exports);
 const BASE_ENDPOINT_URL = "https://api.croct.io";
-const MAX_QUERY_LENGTH = parseInt("<@maxQueryLength@>", 10);
-const VERSION = "0.22.2";
+const MAX_QUERY_LENGTH = parseInt("500", 10);
+const VERSION = "0.22.4";
 const CLIENT_LIBRARY = `Croct SDK JS v${VERSION}`;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/constants.d.cts

@@ -1,6 +1,6 @@
 declare const BASE_ENDPOINT_URL = "https://api.croct.io";
 declare const MAX_QUERY_LENGTH: number;
-declare const VERSION = "0.22.2";
-declare const CLIENT_LIBRARY = "Croct SDK JS v0.22.2";
+declare const VERSION = "0.22.4";
+declare const CLIENT_LIBRARY = "Croct SDK JS v0.22.4";
 
 export { BASE_ENDPOINT_URL, CLIENT_LIBRARY, MAX_QUERY_LENGTH, VERSION };

package/constants.d.ts

@@ -1,6 +1,6 @@
 declare const BASE_ENDPOINT_URL = "https://api.croct.io";
 declare const MAX_QUERY_LENGTH: number;
-declare const VERSION = "0.22.2";
-declare const CLIENT_LIBRARY = "Croct SDK JS v0.22.2";
+declare const VERSION = "0.22.4";
+declare const CLIENT_LIBRARY = "Croct SDK JS v0.22.4";
 
 export { BASE_ENDPOINT_URL, CLIENT_LIBRARY, MAX_QUERY_LENGTH, VERSION };

package/constants.js

@@ -1,6 +1,6 @@
 const BASE_ENDPOINT_URL = "https://api.croct.io";
-const MAX_QUERY_LENGTH = parseInt("<@maxQueryLength@>", 10);
-const VERSION = "0.22.2";
+const MAX_QUERY_LENGTH = parseInt("500", 10);
+const VERSION = "0.22.4";
 const CLIENT_LIBRARY = `Croct SDK JS v${VERSION}`;
 export {
   BASE_ENDPOINT_URL,

package/container.d.cts

@@ -7,10 +7,11 @@ import { Evaluator } from './evaluator.cjs';
 import { CidAssigner } from './cid/assigner.cjs';
 import { EventManager } from './eventManager.cjs';
 import { SdkEventMap } from './sdkEvents.cjs';
-import { UrlSanitizer } from './tab.cjs';
+import { UrlSanitizer } from './url.cjs';
 import { ContentFetcher } from './contentFetcher.cjs';
 import { CookieCacheConfiguration } from './cache/cookieCache.cjs';
 import './cache/cache.cjs';
+import './tab.cjs';
 import './queue/queue.cjs';
 import '@croct/json';
 import './apiKey.cjs';
@@ -19,6 +20,7 @@ import './retry/policy.cjs';
 import './trackingEvents.cjs';
 import './patch.cjs';
 import './utilityTypes.cjs';
+import './error.cjs';
 import './sourceLocation.cjs';
 import '@croct/content-model/definition';
 

package/container.d.ts

@@ -7,10 +7,11 @@ import { Evaluator } from './evaluator.js';
 import { CidAssigner } from './cid/assigner.js';
 import { EventManager } from './eventManager.js';
 import { SdkEventMap } from './sdkEvents.js';
-import { UrlSanitizer } from './tab.js';
+import { UrlSanitizer } from './url.js';
 import { ContentFetcher } from './contentFetcher.js';
 import { CookieCacheConfiguration } from './cache/cookieCache.js';
 import './cache/cache.js';
+import './tab.js';
 import './queue/queue.js';
 import '@croct/json';
 import './apiKey.js';
@@ -19,6 +20,7 @@ import './retry/policy.js';
 import './trackingEvents.js';
 import './patch.js';
 import './utilityTypes.js';
+import './error.js';
 import './sourceLocation.js';
 import '@croct/content-model/definition';
 

package/contentFetcher.cjs

@@ -19,7 +19,8 @@ var contentFetcher_exports = {};
 __export(contentFetcher_exports, {
   ContentError: () => ContentError,
   ContentErrorType: () => ContentErrorType,
-  ContentFetcher: () => ContentFetcher
+  ContentFetcher: () => ContentFetcher,
+  InputError: () => InputError
 });
 module.exports = __toCommonJS(contentFetcher_exports);
 var import_constants = require('./constants.cjs');
@@ -29,8 +30,9 @@ var import_apiKey = require('./apiKey.cjs');
 var import_help = require('./help.cjs');
 var ContentErrorType = /* @__PURE__ */ ((ContentErrorType2) => {
   ContentErrorType2["TIMEOUT"] = "https://croct.help/sdk/javascript/request-timeout";
-  ContentErrorType2["UNEXPECTED_ERROR"] = "https://croct.help/sdk/javascript/unexpected-error";
   ContentErrorType2["SUSPENDED_SERVICE"] = "https://croct.help/sdk/javascript/suspended-service";
+  ContentErrorType2["INTERNAL_ERROR"] = "https://croct.help/api/content/internal-error";
+  ContentErrorType2["INVALID_PAYLOAD"] = "https://croct.help/api/content/invalid-payload";
   return ContentErrorType2;
 })(ContentErrorType || {});
 class ContentError extends Error {
@@ -40,6 +42,12 @@ class ContentError extends Error {
     Object.setPrototypeOf(this, ContentError.prototype);
   }
 }
+class InputError extends ContentError {
+  constructor(response) {
+    super(response);
+    Object.setPrototypeOf(this, InputError.prototype);
+  }
+}
 class ContentFetcher {
   constructor(configuration) {
     if (configuration.appId === void 0 === (configuration.apiKey === void 0)) {
@@ -76,7 +84,7 @@ class ContentFetcher {
               // Request Timeout
             };
             abortController.abort();
-            this.logHelp(response.status);
+            this.logHelp(response);
             reject(new ContentError(response));
           },
           timeout
@@ -98,8 +106,12 @@ class ContentFetcher {
           if (response.ok) {
             return resolve(body);
           }
-          this.logHelp(response.status);
-          reject(new ContentError(body));
+          const problem = body;
+          this.logHelp(problem);
+          if (problem.type === "https://croct.help/api/content/invalid-payload" /* INVALID_PAYLOAD */) {
+            return reject(new InputError(problem));
+          }
+          reject(new ContentError(problem));
         }).catch((error) => {
           if (!response.ok) {
             throw new Error(`Error ${response.status} - ${response.statusText}`);
@@ -111,7 +123,7 @@ class ContentFetcher {
           reject(
             new ContentError({
               title: (0, import_error.formatMessage)(error),
-              type: "https://croct.help/sdk/javascript/unexpected-error" /* UNEXPECTED_ERROR */,
+              type: "https://croct.help/api/content/internal-error" /* INTERNAL_ERROR */,
               detail: "Please try again or contact Croct support if the error persists.",
               status: 500
               // Internal Server Error
@@ -183,8 +195,8 @@ class ContentFetcher {
       body: JSON.stringify(payload)
     });
   }
-  logHelp(statusCode) {
-    const help = import_help.Help.forStatusCode(statusCode);
+  logHelp(problem) {
+    const help = import_help.Help.forApiProblem(problem);
     if (help !== void 0) {
       this.logger.error(help);
     }
@@ -200,5 +212,6 @@ class ContentFetcher {
 0 && (module.exports = {
   ContentError,
   ContentErrorType,
-  ContentFetcher
+  ContentFetcher,
+  InputError
 });

package/contentFetcher.d.cts

@@ -1,26 +1,34 @@
-import { JsonObject } from '@croct/json';
+import { JsonObject, JsonPrimitive } from '@croct/json';
 import { ContentDefinitionBundle } from '@croct/content-model/definition';
 import { EvaluationContext } from './evaluator.cjs';
 import { Token } from './token/token.cjs';
+import { ApiProblem } from './error.cjs';
 import { Logger } from './logging/logger.cjs';
 import { ApiKey } from './apiKey.cjs';
 import './sourceLocation.cjs';
+import './url.cjs';
 
-type ErrorResponse = {
-    type: string;
-    title: string;
-    status: number;
-    detail?: string;
-};
 declare enum ContentErrorType {
     TIMEOUT = "https://croct.help/sdk/javascript/request-timeout",
-    UNEXPECTED_ERROR = "https://croct.help/sdk/javascript/unexpected-error",
-    SUSPENDED_SERVICE = "https://croct.help/sdk/javascript/suspended-service"
+    SUSPENDED_SERVICE = "https://croct.help/sdk/javascript/suspended-service",
+    INTERNAL_ERROR = "https://croct.help/api/content/internal-error",
+    INVALID_PAYLOAD = "https://croct.help/api/content/invalid-payload"
 }
-declare class ContentError<T extends ErrorResponse = ErrorResponse> extends Error {
+declare class ContentError<T extends ApiProblem = ApiProblem> extends Error {
     readonly response: T;
     constructor(response: T);
 }
+type InputViolation = {
+    path: string;
+    reason?: string;
+    details?: Record<string, JsonPrimitive>;
+};
+type InputErrorResponse = ApiProblem & {
+    violations?: InputViolation[];
+};
+declare class InputError extends ContentError<InputErrorResponse> {
+    constructor(response: InputErrorResponse);
+}
 type FetchResponseOptions = {
     includeSchema?: boolean;
 };
@@ -90,4 +98,4 @@ declare class ContentFetcher {
     toJSON(): never;
 }
 
-export { type Configuration, ContentError, ContentErrorType, ContentFetcher, type DynamicContentOptions, type ErrorResponse, type FetchOptions, type FetchResponse, type FetchResponseOptions, type SlotMetadata, type StaticContentOptions };
+export { type Configuration, ContentError, ContentErrorType, ContentFetcher, type DynamicContentOptions, type FetchOptions, type FetchResponse, type FetchResponseOptions, InputError, type InputErrorResponse, type InputViolation, type SlotMetadata, type StaticContentOptions };

package/contentFetcher.d.ts

@@ -1,26 +1,34 @@
-import { JsonObject } from '@croct/json';
+import { JsonObject, JsonPrimitive } from '@croct/json';
 import { ContentDefinitionBundle } from '@croct/content-model/definition';
 import { EvaluationContext } from './evaluator.js';
 import { Token } from './token/token.js';
+import { ApiProblem } from './error.js';
 import { Logger } from './logging/logger.js';
 import { ApiKey } from './apiKey.js';
 import './sourceLocation.js';
+import './url.js';
 
-type ErrorResponse = {
-    type: string;
-    title: string;
-    status: number;
-    detail?: string;
-};
 declare enum ContentErrorType {
     TIMEOUT = "https://croct.help/sdk/javascript/request-timeout",
-    UNEXPECTED_ERROR = "https://croct.help/sdk/javascript/unexpected-error",
-    SUSPENDED_SERVICE = "https://croct.help/sdk/javascript/suspended-service"
+    SUSPENDED_SERVICE = "https://croct.help/sdk/javascript/suspended-service",
+    INTERNAL_ERROR = "https://croct.help/api/content/internal-error",
+    INVALID_PAYLOAD = "https://croct.help/api/content/invalid-payload"
 }
-declare class ContentError<T extends ErrorResponse = ErrorResponse> extends Error {
+declare class ContentError<T extends ApiProblem = ApiProblem> extends Error {
     readonly response: T;
     constructor(response: T);
 }
+type InputViolation = {
+    path: string;
+    reason?: string;
+    details?: Record<string, JsonPrimitive>;
+};
+type InputErrorResponse = ApiProblem & {
+    violations?: InputViolation[];
+};
+declare class InputError extends ContentError<InputErrorResponse> {
+    constructor(response: InputErrorResponse);
+}
 type FetchResponseOptions = {
     includeSchema?: boolean;
 };
@@ -90,4 +98,4 @@ declare class ContentFetcher {
     toJSON(): never;
 }
 
-export { type Configuration, ContentError, ContentErrorType, ContentFetcher, type DynamicContentOptions, type ErrorResponse, type FetchOptions, type FetchResponse, type FetchResponseOptions, type SlotMetadata, type StaticContentOptions };
+export { type Configuration, ContentError, ContentErrorType, ContentFetcher, type DynamicContentOptions, type FetchOptions, type FetchResponse, type FetchResponseOptions, InputError, type InputErrorResponse, type InputViolation, type SlotMetadata, type StaticContentOptions };

package/contentFetcher.js

@@ -5,8 +5,9 @@ import { ApiKey } from "./apiKey.js";
 import { Help } from "./help.js";
 var ContentErrorType = /* @__PURE__ */ ((ContentErrorType2) => {
   ContentErrorType2["TIMEOUT"] = "https://croct.help/sdk/javascript/request-timeout";
-  ContentErrorType2["UNEXPECTED_ERROR"] = "https://croct.help/sdk/javascript/unexpected-error";
   ContentErrorType2["SUSPENDED_SERVICE"] = "https://croct.help/sdk/javascript/suspended-service";
+  ContentErrorType2["INTERNAL_ERROR"] = "https://croct.help/api/content/internal-error";
+  ContentErrorType2["INVALID_PAYLOAD"] = "https://croct.help/api/content/invalid-payload";
   return ContentErrorType2;
 })(ContentErrorType || {});
 class ContentError extends Error {
@@ -16,6 +17,12 @@ class ContentError extends Error {
     Object.setPrototypeOf(this, ContentError.prototype);
   }
 }
+class InputError extends ContentError {
+  constructor(response) {
+    super(response);
+    Object.setPrototypeOf(this, InputError.prototype);
+  }
+}
 class ContentFetcher {
   constructor(configuration) {
     if (configuration.appId === void 0 === (configuration.apiKey === void 0)) {
@@ -52,7 +59,7 @@ class ContentFetcher {
               // Request Timeout
             };
             abortController.abort();
-            this.logHelp(response.status);
+            this.logHelp(response);
             reject(new ContentError(response));
           },
           timeout
@@ -74,8 +81,12 @@ class ContentFetcher {
           if (response.ok) {
             return resolve(body);
           }
-          this.logHelp(response.status);
-          reject(new ContentError(body));
+          const problem = body;
+          this.logHelp(problem);
+          if (problem.type === "https://croct.help/api/content/invalid-payload" /* INVALID_PAYLOAD */) {
+            return reject(new InputError(problem));
+          }
+          reject(new ContentError(problem));
         }).catch((error) => {
           if (!response.ok) {
             throw new Error(`Error ${response.status} - ${response.statusText}`);
@@ -87,7 +98,7 @@ class ContentFetcher {
           reject(
             new ContentError({
               title: formatMessage(error),
-              type: "https://croct.help/sdk/javascript/unexpected-error" /* UNEXPECTED_ERROR */,
+              type: "https://croct.help/api/content/internal-error" /* INTERNAL_ERROR */,
               detail: "Please try again or contact Croct support if the error persists.",
               status: 500
               // Internal Server Error
@@ -159,8 +170,8 @@ class ContentFetcher {
       body: JSON.stringify(payload)
     });
   }
-  logHelp(statusCode) {
-    const help = Help.forStatusCode(statusCode);
+  logHelp(problem) {
+    const help = Help.forApiProblem(problem);
     if (help !== void 0) {
       this.logger.error(help);
     }
@@ -175,5 +186,6 @@ class ContentFetcher {
 export {
   ContentError,
   ContentErrorType,
-  ContentFetcher
+  ContentFetcher,
+  InputError
 };

package/context.d.cts

@@ -1,8 +1,9 @@
 import { Token } from './token/token.cjs';
 import { Cache } from './cache/cache.cjs';
-import { UrlSanitizer, Tab } from './tab.cjs';
+import { Tab } from './tab.cjs';
 import { EventDispatcher } from './eventManager.cjs';
 import { SdkEventMap } from './sdkEvents.cjs';
+import { UrlSanitizer } from './url.cjs';
 import '@croct/json';
 import './apiKey.cjs';
 

package/context.d.ts

@@ -1,8 +1,9 @@
 import { Token } from './token/token.js';
 import { Cache } from './cache/cache.js';
-import { UrlSanitizer, Tab } from './tab.js';
+import { Tab } from './tab.js';
 import { EventDispatcher } from './eventManager.js';
 import { SdkEventMap } from './sdkEvents.js';
+import { UrlSanitizer } from './url.js';
 import '@croct/json';
 import './apiKey.js';
 

package/error.d.cts

@@ -1,4 +1,11 @@
+type ApiProblem = {
+    title: string;
+    type: string;
+    status: number;
+    detail?: string;
+    instance?: string;
+};
 declare function formatMessage(error: unknown): string;
 declare function formatCause(error: unknown): string;
 
-export { formatCause, formatMessage };
+export { type ApiProblem, formatCause, formatMessage };

package/error.d.ts

@@ -1,4 +1,11 @@
+type ApiProblem = {
+    title: string;
+    type: string;
+    status: number;
+    detail?: string;
+    instance?: string;
+};
 declare function formatMessage(error: unknown): string;
 declare function formatCause(error: unknown): string;
 
-export { formatCause, formatMessage };
+export { type ApiProblem, formatCause, formatMessage };