@adobe/alloy 2.29.0-beta.4 → 2.29.0

package/types/utils/request/types.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Request object with methods to access and modify request properties.
+ *
+ * @typedef {Object} Request
+ * @property {function(): string} getId
+ * @property {function(): RequestPayload} getPayload
+ * @property {function({isIdentityEstablished: boolean}): string}  getAction
+ * @property {function(): string|undefined} getDatastreamIdOverride
+ * @property {Function} getUseSendBeacon
+ * @property {function(): string|undefined} getEdgeSubPath
+ * @property {Function} getUseIdThirdPartyDomain
+ * @property {Function} setUseIdThirdPartyDomain
+ * @property {Function} setIsIdentityEstablished
+ */
+/**
+ * Request payload object with methods for merging different types of data.
+ *
+ * @typedef {Object} RequestPayload
+ * @property {function(object): void} mergeMeta
+ * @property {function(object): void} mergeState
+ * @property {function(object): void} mergeQuery
+ * @property {function(object): void} mergeConfigOverride
+ * @property {function(string, Identity): void} options.addIdentity
+ * @property {function(string): boolean} options.hasIdentity
+ * @property {function(): object} toJSON
+ */
+/**
+ * Request payload object with methods for merging different types of data.
+ *
+ * @typedef {Object} DataCollectionRequestPayload
+ * @property {function(object): void} mergeMeta
+ * @property {function(object): void} mergeState
+ * @property {function(object): void} mergeQuery
+ * @property {function(object): void} mergeConfigOverride
+ * @property {function(string, Identity): void} options.addIdentity
+ * @property {function(string): boolean} options.hasIdentity
+ * @property {function(object): void} addEvent
+ * @property {function(): boolean} getDocumentMayUnload
+ * @property {function(): object} toJSON
+ */
+/**
+ * @typedef {Object} Identity
+ * @property {string} id
+ */
+export const Types: {};
+/**
+ * Request object with methods to access and modify request properties.
+ */
+export type Request = {
+    getId: () => string;
+    getPayload: () => RequestPayload;
+    getAction: (arg0: {
+        isIdentityEstablished: boolean;
+    }) => string;
+    getDatastreamIdOverride: () => string | undefined;
+    getUseSendBeacon: Function;
+    getEdgeSubPath: () => string | undefined;
+    getUseIdThirdPartyDomain: Function;
+    setUseIdThirdPartyDomain: Function;
+    setIsIdentityEstablished: Function;
+};
+/**
+ * Request payload object with methods for merging different types of data.
+ */
+export type RequestPayload = {
+    mergeMeta: (arg0: object) => void;
+    mergeState: (arg0: object) => void;
+    mergeQuery: (arg0: object) => void;
+    mergeConfigOverride: (arg0: object) => void;
+    addIdentity: (arg0: string, arg1: Identity) => void;
+    hasIdentity: (arg0: string) => boolean;
+    toJSON: () => object;
+};
+/**
+ * Request payload object with methods for merging different types of data.
+ */
+export type DataCollectionRequestPayload = {
+    mergeMeta: (arg0: object) => void;
+    mergeState: (arg0: object) => void;
+    mergeQuery: (arg0: object) => void;
+    mergeConfigOverride: (arg0: object) => void;
+    addIdentity: (arg0: string, arg1: Identity) => void;
+    hasIdentity: (arg0: string) => boolean;
+    addEvent: (arg0: object) => void;
+    getDocumentMayUnload: () => boolean;
+    toJSON: () => object;
+};
+export type Identity = {
+    id: string;
+};
+//# sourceMappingURL=types.d.ts.map

package/types/utils/request/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/utils/request/types.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;GAGG;AAEH,uBAAwB;;;;;WA5CV,MAAY,MAAM;gBAClB,MAAY,cAAc;eAC1B,CAAS,IAAgC,EAAhC;QAAC,qBAAqB,EAAE,OAAO,CAAA;KAAC,KAAG,MAAM;6BAClD,MAAY,MAAM,GAAC,SAAS;;oBAE5B,MAAY,MAAM,GAAC,SAAS;;;;;;;;;eAU5B,CAAS,IAAM,EAAN,MAAM,KAAG,IAAI;gBACtB,CAAS,IAAM,EAAN,MAAM,KAAG,IAAI;gBACtB,CAAS,IAAM,EAAN,MAAM,KAAG,IAAI;yBACtB,CAAS,IAAM,EAAN,MAAM,KAAG,IAAI;iBACtB,CAAS,IAAM,EAAN,MAAM,EAAE,IAAQ,EAAR,QAAQ,KAAG,IAAI;iBAChC,CAAS,IAAM,EAAN,MAAM,KAAG,OAAO;YACzB,MAAY,MAAM;;;;;;eAOlB,CAAS,IAAM,EAAN,MAAM,KAAG,IAAI;gBACtB,CAAS,IAAM,EAAN,MAAM,KAAG,IAAI;gBACtB,CAAS,IAAM,EAAN,MAAM,KAAG,IAAI;yBACtB,CAAS,IAAM,EAAN,MAAM,KAAG,IAAI;iBACtB,CAAS,IAAM,EAAN,MAAM,EAAE,IAAQ,EAAR,QAAQ,KAAG,IAAI;iBAChC,CAAS,IAAM,EAAN,MAAM,KAAG,OAAO;cACzB,CAAS,IAAM,EAAN,MAAM,KAAG,IAAI;0BACtB,MAAY,OAAO;YACnB,MAAY,MAAM;;;QAKlB,MAAM"}

package/types/utils/types.d.ts

@@ -0,0 +1,91 @@
+/**
+ * @typedef {Object} Storage
+ * @property {function(string): string|null} getItem
+ * @property {function(string, string): void} setItem
+ * @property {function(): void} clear
+ */
+/**
+ * @typedef {Object} CookieAttributes
+ * @property {number|Date} [expires] - Cookie expiration (number of days or Date object)
+ * @property {string} [path] - Cookie path (default: "/")
+ * @property {string} [domain] - Cookie domain
+ * @property {boolean} [secure] - Requires HTTPS transmission
+ * @property {"strict"|"lax"|"none"} [sameSite] - SameSite attribute
+ */
+/**
+ * @typedef {Object} CookieConverter
+ * @property {function(string, string): string} [read] - Custom decoder function
+ * @property {function(string, string): string} [write] - Custom encoder function
+ */
+/**
+ * @typedef {Object} CookieJar
+ * @property {function(string): string|undefined} get - Get cookie value by name, or get all cookies as object if no name provided
+ * @property {function(): Object<string, string>} get - Get all cookies as key-value object when called with no arguments
+ * @property {function(string, string, CookieAttributes=): string|undefined} set - Set cookie with optional attributes
+ * @property {function(string, CookieAttributes=): void} remove - Remove cookie with optional attributes (must match set attributes)
+ * @property {function(CookieConverter): CookieJar} withConverter - Create new instance with custom encoding/decoding
+ */
+/**
+ * @typedef {function(string): { session: Storage, persistent: Storage }} StorageCreator
+ */
+export const Types: {};
+export type Storage = {
+    getItem: (arg0: string) => string | null;
+    setItem: (arg0: string, arg1: string) => void;
+    clear: () => void;
+};
+export type CookieAttributes = {
+    /**
+     * - Cookie expiration (number of days or Date object)
+     */
+    expires?: number | Date;
+    /**
+     * - Cookie path (default: "/")
+     */
+    path?: string;
+    /**
+     * - Cookie domain
+     */
+    domain?: string;
+    /**
+     * - Requires HTTPS transmission
+     */
+    secure?: boolean;
+    /**
+     * - SameSite attribute
+     */
+    sameSite?: "strict" | "lax" | "none";
+};
+export type CookieConverter = {
+    /**
+     * - Custom decoder function
+     */
+    read?: (arg0: string, arg1: string) => string;
+    /**
+     * - Custom encoder function
+     */
+    write?: (arg0: string, arg1: string) => string;
+};
+export type CookieJar = {
+    /**
+     * - Get cookie value by name, or get all cookies as object if no name provided
+     */
+    get: (arg0: string) => string | undefined;
+    /**
+     * - Set cookie with optional attributes
+     */
+    set: (arg0: string, arg1: string, arg2: CookieAttributes | undefined) => string | undefined;
+    /**
+     * - Remove cookie with optional attributes (must match set attributes)
+     */
+    remove: (arg0: string, arg1: CookieAttributes | undefined) => void;
+    /**
+     * - Create new instance with custom encoding/decoding
+     */
+    withConverter: (arg0: CookieConverter) => CookieJar;
+};
+export type StorageCreator = (arg0: string) => {
+    session: Storage;
+    persistent: Storage;
+};
+//# sourceMappingURL=types.d.ts.map

package/types/utils/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/utils/types.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;GAOG;AAEH;;;;GAIG;AAEH;;;;;;;GAOG;AAEH;;GAEG;AAEH,uBAAwB;;aAjCV,CAAS,IAAM,EAAN,MAAM,KAAG,MAAM,GAAC,IAAI;aAC7B,CAAS,IAAM,EAAN,MAAM,EAAE,IAAM,EAAN,MAAM,KAAG,IAAI;WAC9B,MAAY,IAAI;;;;;;cAKhB,MAAM,GAAC,IAAI;;;;WACX,MAAM;;;;aACN,MAAM;;;;aACN,OAAO;;;;eACP,QAAQ,GAAC,KAAK,GAAC,MAAM;;;;;;WAKrB,CAAS,IAAM,EAAN,MAAM,EAAE,IAAM,EAAN,MAAM,KAAG,MAAM;;;;YAChC,CAAS,IAAM,EAAN,MAAM,EAAE,IAAM,EAAN,MAAM,KAAG,MAAM;;;;;;SAKhC,CAAS,IAAM,EAAN,MAAM,KAAG,MAAM,GAAC,SAAS;;;;SAElC,CAAS,IAAM,EAAN,MAAM,EAAE,IAAM,EAAN,MAAM,EAAE,IAAiB,EAAjB,gBAAgB,YAAC,KAAG,MAAM,GAAC,SAAS;;;;YAC7D,CAAS,IAAM,EAAN,MAAM,EAAE,IAAiB,EAAjB,gBAAgB,YAAC,KAAG,IAAI;;;;mBACzC,CAAS,IAAe,EAAf,eAAe,KAAG,SAAS;;6BAIrC,CAAS,IAAM,EAAN,MAAM,KAAG;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,UAAU,EAAE,OAAO,CAAA;CAAE"}