@picked/analytics 0.0.117-next.1 → 0.0.117-next.3

package/dist/cjs/schemas/session/index.d.ts

@@ -0,0 +1,258 @@
+/** @file The `session` context schema versions, and the version the SDK's events send. */
+import type { SchemaUrl } from '../../types.js';
+import type { Schema as Schema1_0_4, Version as Version1_0_4 } from './1-0-4.js';
+export declare const name = "session";
+export declare const schemas: {
+    '1-0-0': {
+        readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+        readonly additionalProperties: true;
+        readonly description: 'Schema for a session';
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly id: {
+                readonly description: 'The session ID';
+                readonly type: 'string';
+                readonly maxLength: 255;
+            };
+            readonly meta: {
+                readonly description: 'Additional metadata';
+                readonly additionalProperties: true;
+                readonly type: readonly ['object', 'null'];
+            };
+        };
+        readonly required: readonly ['id'];
+        readonly self: {
+            readonly vendor: 'dev.pckd';
+            readonly name: 'session';
+            readonly format: 'jsonschema';
+            readonly version: '1-0-0';
+        };
+        readonly type: 'object';
+    };
+    '1-0-1': {
+        readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+        readonly additionalProperties: true;
+        readonly description: 'Schema for a session';
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly id: {
+                readonly description: 'The session ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly gaid: {
+                readonly description: 'The session Google Analytics Client ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly meta: {
+                readonly description: 'Additional metadata';
+                readonly additionalProperties: true;
+                readonly type: readonly ['object', 'null'];
+            };
+        };
+        readonly self: {
+            readonly vendor: 'dev.pckd';
+            readonly name: 'session';
+            readonly format: 'jsonschema';
+            readonly version: '1-0-1';
+        };
+        readonly type: 'object';
+    };
+    '1-0-2': {
+        readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+        readonly additionalProperties: true;
+        readonly description: 'Schema for a session';
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly id: {
+                readonly description: 'The session ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly gaid: {
+                readonly description: 'The session Google Analytics Client ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly shopify_client_id: {
+                readonly description: 'The session Shopify Client ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly meta: {
+                readonly description: 'Additional metadata';
+                readonly additionalProperties: true;
+                readonly type: readonly ['object', 'null'];
+            };
+        };
+        readonly self: {
+            readonly vendor: 'dev.pckd';
+            readonly name: 'session';
+            readonly format: 'jsonschema';
+            readonly version: '1-0-2';
+        };
+        readonly type: 'object';
+    };
+    '1-0-3': {
+        readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+        readonly additionalProperties: true;
+        readonly description: 'Schema for a session';
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly id: {
+                readonly description: 'The session ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly is_user: {
+                readonly description: 'The session is attributed to a Picked user';
+                readonly type: readonly ['boolean', 'null'];
+            };
+            readonly gaid: {
+                readonly description: 'The session Google Analytics Client ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly shopify_client_id: {
+                readonly description: 'The session Shopify Client ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly shopify_customer_id: {
+                readonly description: 'The session Shopify Customer ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly shopify_checkout_token: {
+                readonly description: 'The session Shopify Checkout token';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly meta: {
+                readonly description: 'Additional metadata';
+                readonly additionalProperties: true;
+                readonly type: readonly ['object', 'null'];
+            };
+        };
+        readonly self: {
+            readonly vendor: 'dev.pckd';
+            readonly name: 'session';
+            readonly format: 'jsonschema';
+            readonly version: '1-0-3';
+        };
+        readonly type: 'object';
+    };
+    '1-0-4': {
+        readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+        readonly additionalProperties: true;
+        readonly description: 'Schema for a session';
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly id: {
+                readonly description: 'The session ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly is_user: {
+                readonly description: 'The session is attributed to a Picked user';
+                readonly type: readonly ['boolean', 'null'];
+            };
+            readonly gaid: {
+                readonly description: 'The session Google Analytics Client ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly shopify_client_id: {
+                readonly description: 'The session Shopify Client ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly shopify_customer_id: {
+                readonly description: 'The session Shopify Customer ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly shopify_checkout_token: {
+                readonly description: 'The session Shopify Checkout token';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly fingerprintjs_visitor_id: {
+                readonly description: 'The FingerprintJS visitor ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly meta: {
+                readonly description: 'Additional metadata';
+                readonly additionalProperties: true;
+                readonly type: readonly ['object', 'null'];
+            };
+        };
+        readonly self: {
+            readonly vendor: 'dev.pckd';
+            readonly name: 'session';
+            readonly format: 'jsonschema';
+            readonly version: '1-0-4';
+        };
+        readonly type: 'object';
+    };
+    '2-0-0': {
+        readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+        readonly additionalProperties: true;
+        readonly description: 'Schema for a session';
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly visitor_browser_id: {
+                readonly description: 'The SDK visitor browser ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly is_user: {
+                readonly description: 'The session is attributed to a Picked user';
+                readonly type: readonly ['boolean', 'null'];
+            };
+            readonly gaid: {
+                readonly description: 'The session Google Analytics Client ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly shopify_client_id: {
+                readonly description: 'The session Shopify Client ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly shopify_customer_id: {
+                readonly description: 'The session Shopify Customer ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly shopify_checkout_token: {
+                readonly description: 'The session Shopify Checkout token';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly fingerprintjs_visitor_id: {
+                readonly description: 'The FingerprintJS visitor ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly meta: {
+                readonly description: 'Additional metadata';
+                readonly additionalProperties: true;
+                readonly type: readonly ['object', 'null'];
+            };
+        };
+        readonly self: {
+            readonly vendor: 'dev.pckd';
+            readonly name: 'session';
+            readonly format: 'jsonschema';
+            readonly version: '2-0-0';
+        };
+        readonly type: 'object';
+    };
+};
+export type CurrentSchema = Schema1_0_4;
+export type CurrentVersion = Version1_0_4;
+export type Url = SchemaUrl<typeof name, CurrentVersion>;
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/schemas/session/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/schemas/session/index.ts"],"names":[],"mappings":"AAAA,0FAA0F;AAC1F,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,MAAM,IAAI,WAAW,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,SAAS,CAAA;AAQ7E,eAAO,MAAM,IAAI,YAAY,CAAA;AAE7B,eAAO,MAAM,OAAO;IAClB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;IACP,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACP,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACP,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACP,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACP,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CACR,CAAA;AAGD,MAAM,MAAM,aAAa,GAAG,WAAW,CAAA;AACvC,MAAM,MAAM,cAAc,GAAG,YAAY,CAAA;AACzC,MAAM,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,IAAI,EAAE,cAAc,CAAC,CAAA"}

package/dist/cjs/schemas/step/1-0-0.d.ts

@@ -0,0 +1,33 @@
+/** @file The `step` context schema, version 1-0-0. */
+export declare const schema: {
+    readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+    readonly additionalProperties: true;
+    readonly description: 'Schema for a step';
+    readonly minProperties: 1;
+    readonly properties: {
+        readonly id: {
+            readonly description: 'The step ID';
+            readonly type: 'string';
+            readonly maxLength: 255;
+        };
+        readonly title: {
+            readonly description: 'The step title';
+            readonly type: 'string';
+            readonly maxLength: 255;
+        };
+        readonly meta: {
+            readonly description: 'Additional metadata';
+            readonly additionalProperties: true;
+            readonly type: readonly ['object', 'null'];
+        };
+    };
+    readonly required: readonly ['id', 'title'];
+    readonly self: {
+        readonly vendor: 'dev.pckd';
+        readonly name: 'step';
+        readonly format: 'jsonschema';
+        readonly version: '1-0-0';
+    };
+    readonly type: 'object';
+};
+//# sourceMappingURL=1-0-0.d.ts.map

package/dist/cjs/schemas/step/1-0-0.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"1-0-0.d.ts","sourceRoot":"","sources":["../../../../src/schemas/step/1-0-0.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,eAAO,MAAM,MAAM;aACjB,OAAO,EACL,yFAAyF;aAC3F,oBAAoB;aACpB,WAAW,EAAE,mBAAmB;aAChC,aAAa,EAAE,CAAC;aAChB,UAAU;iBACR,EAAE;qBACA,WAAW,EAAE,aAAa;qBAC1B,IAAI,EAAE,QAAQ;qBACd,SAAS,EAAE,GAAG;;iBAEhB,KAAK;qBACH,WAAW,EAAE,gBAAgB;qBAC7B,IAAI,EAAE,QAAQ;qBACd,SAAS,EAAE,GAAG;;iBAEhB,IAAI;qBACF,WAAW,EAAE,qBAAqB;qBAClC,oBAAoB;qBACpB,IAAI,YAAG,QAAQ,EAAE,MAAM;;;aAG3B,QAAQ,YAAG,IAAI,EAAE,OAAO;aACxB,IAAI;iBACF,MAAM,EAAE,UAAU;iBAClB,IAAI,EAAE,MAAM;iBACZ,MAAM,EAAE,YAAY;iBACpB,OAAO,EAAE,OAAO;;aAElB,IAAI,EAAE,QAAQ;CACN,CAAA"}

package/dist/cjs/schemas/step/1-0-1.d.ts

@@ -0,0 +1,41 @@
+/** @file Snowplow "step" context schema v1-0-1, adding the deterministic step key alongside the id. */
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const schema: {
+    readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+    readonly additionalProperties: true;
+    readonly description: 'Schema for a step';
+    readonly minProperties: 1;
+    readonly properties: {
+        readonly id: {
+            readonly description: 'The step ID';
+            readonly type: 'string';
+            readonly maxLength: 255;
+        };
+        readonly title: {
+            readonly description: 'The step title';
+            readonly type: 'string';
+            readonly maxLength: 255;
+        };
+        readonly key: {
+            readonly description: 'The stable, deterministic step key';
+            readonly type: readonly ['string', 'null'];
+            readonly maxLength: 255;
+        };
+        readonly meta: {
+            readonly description: 'Additional metadata';
+            readonly additionalProperties: true;
+            readonly type: readonly ['object', 'null'];
+        };
+    };
+    readonly required: readonly ['id', 'title'];
+    readonly self: {
+        readonly vendor: 'dev.pckd';
+        readonly name: 'step';
+        readonly format: 'jsonschema';
+        readonly version: '1-0-1';
+    };
+    readonly type: 'object';
+};
+export type Schema = FromSchema<typeof schema>;
+export type Version = typeof schema.self.version;
+//# sourceMappingURL=1-0-1.d.ts.map

package/dist/cjs/schemas/step/1-0-1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"1-0-1.d.ts","sourceRoot":"","sources":["../../../../src/schemas/step/1-0-1.ts"],"names":[],"mappings":"AAAA,uGAAuG;AACvG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAEnD,eAAO,MAAM,MAAM;aACjB,OAAO,EACL,yFAAyF;aAC3F,oBAAoB;aACpB,WAAW,EAAE,mBAAmB;aAChC,aAAa,EAAE,CAAC;aAChB,UAAU;iBACR,EAAE;qBACA,WAAW,EAAE,aAAa;qBAC1B,IAAI,EAAE,QAAQ;qBACd,SAAS,EAAE,GAAG;;iBAEhB,KAAK;qBACH,WAAW,EAAE,gBAAgB;qBAC7B,IAAI,EAAE,QAAQ;qBACd,SAAS,EAAE,GAAG;;iBAEhB,GAAG;qBACD,WAAW,EAAE,oCAAoC;qBACjD,IAAI,YAAG,QAAQ,EAAE,MAAM;qBACvB,SAAS,EAAE,GAAG;;iBAEhB,IAAI;qBACF,WAAW,EAAE,qBAAqB;qBAClC,oBAAoB;qBACpB,IAAI,YAAG,QAAQ,EAAE,MAAM;;;aAG3B,QAAQ,YAAG,IAAI,EAAE,OAAO;aACxB,IAAI;iBACF,MAAM,EAAE,UAAU;iBAClB,IAAI,EAAE,MAAM;iBACZ,MAAM,EAAE,YAAY;iBACpB,OAAO,EAAE,OAAO;;aAElB,IAAI,EAAE,QAAQ;CACN,CAAA;AAEV,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,MAAM,CAAC,CAAA;AAC9C,MAAM,MAAM,OAAO,GAAG,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAA"}

package/dist/cjs/schemas/step/index.d.ts

@@ -0,0 +1,77 @@
+/** @file Registry of Snowplow "step" context schema versions with the current-version pointer. */
+import type { SchemaUrl } from '../../types.js';
+import type { Schema as Schema1_0_1, Version as Version1_0_1 } from './1-0-1.js';
+export declare const name = "step";
+export declare const schemas: {
+    '1-0-0': {
+        readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+        readonly additionalProperties: true;
+        readonly description: 'Schema for a step';
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly id: {
+                readonly description: 'The step ID';
+                readonly type: 'string';
+                readonly maxLength: 255;
+            };
+            readonly title: {
+                readonly description: 'The step title';
+                readonly type: 'string';
+                readonly maxLength: 255;
+            };
+            readonly meta: {
+                readonly description: 'Additional metadata';
+                readonly additionalProperties: true;
+                readonly type: readonly ['object', 'null'];
+            };
+        };
+        readonly required: readonly ['id', 'title'];
+        readonly self: {
+            readonly vendor: 'dev.pckd';
+            readonly name: 'step';
+            readonly format: 'jsonschema';
+            readonly version: '1-0-0';
+        };
+        readonly type: 'object';
+    };
+    '1-0-1': {
+        readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+        readonly additionalProperties: true;
+        readonly description: 'Schema for a step';
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly id: {
+                readonly description: 'The step ID';
+                readonly type: 'string';
+                readonly maxLength: 255;
+            };
+            readonly title: {
+                readonly description: 'The step title';
+                readonly type: 'string';
+                readonly maxLength: 255;
+            };
+            readonly key: {
+                readonly description: 'The stable, deterministic step key';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly meta: {
+                readonly description: 'Additional metadata';
+                readonly additionalProperties: true;
+                readonly type: readonly ['object', 'null'];
+            };
+        };
+        readonly required: readonly ['id', 'title'];
+        readonly self: {
+            readonly vendor: 'dev.pckd';
+            readonly name: 'step';
+            readonly format: 'jsonschema';
+            readonly version: '1-0-1';
+        };
+        readonly type: 'object';
+    };
+};
+export type CurrentSchema = Schema1_0_1;
+export type CurrentVersion = Version1_0_1;
+export type Url = SchemaUrl<typeof name, CurrentVersion>;
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/schemas/step/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/schemas/step/index.ts"],"names":[],"mappings":"AAAA,kGAAkG;AAClG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,MAAM,IAAI,WAAW,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,SAAS,CAAA;AAI7E,eAAO,MAAM,IAAI,SAAS,CAAA;AAE1B,eAAO,MAAM,OAAO;IAClB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IACP,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CACR,CAAA;AAGD,MAAM,MAAM,aAAa,GAAG,WAAW,CAAA;AACvC,MAAM,MAAM,cAAc,GAAG,YAAY,CAAA;AACzC,MAAM,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,IAAI,EAAE,cAAc,CAAC,CAAA"}

package/dist/cjs/schemas/workspace/1-0-0.d.ts

@@ -0,0 +1,35 @@
+/** @file The `workspace` context schema, version 1-0-0: the workspace that served the project config. */
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const schema: {
+    readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+    readonly additionalProperties: true;
+    readonly description: 'Schema for a workspace';
+    readonly minProperties: 1;
+    readonly properties: {
+        readonly id: {
+            readonly description: 'The workspace ID';
+            readonly type: readonly ['string', 'null'];
+            readonly maxLength: 255;
+        };
+        readonly version_id: {
+            readonly description: 'The published workspace version ID';
+            readonly type: readonly ['string', 'null'];
+            readonly maxLength: 255;
+        };
+        readonly status: {
+            readonly description: 'The workspace status';
+            readonly type: readonly ['string', 'null'];
+            readonly maxLength: 255;
+        };
+    };
+    readonly self: {
+        readonly vendor: 'dev.pckd';
+        readonly name: 'workspace';
+        readonly format: 'jsonschema';
+        readonly version: '1-0-0';
+    };
+    readonly type: 'object';
+};
+export type Schema = FromSchema<typeof schema>;
+export type Version = typeof schema.self.version;
+//# sourceMappingURL=1-0-0.d.ts.map

package/dist/cjs/schemas/workspace/1-0-0.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"1-0-0.d.ts","sourceRoot":"","sources":["../../../../src/schemas/workspace/1-0-0.ts"],"names":[],"mappings":"AAAA,yGAAyG;AACzG,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAEnD,eAAO,MAAM,MAAM;aACjB,OAAO,EACL,yFAAyF;aAC3F,oBAAoB;aACpB,WAAW,EAAE,wBAAwB;aACrC,aAAa,EAAE,CAAC;aAChB,UAAU;iBACR,EAAE;qBACA,WAAW,EAAE,kBAAkB;qBAC/B,IAAI,YAAG,QAAQ,EAAE,MAAM;qBACvB,SAAS,EAAE,GAAG;;iBAEhB,UAAU;qBACR,WAAW,EAAE,oCAAoC;qBACjD,IAAI,YAAG,QAAQ,EAAE,MAAM;qBACvB,SAAS,EAAE,GAAG;;iBAEhB,MAAM;qBACJ,WAAW,EAAE,sBAAsB;qBACnC,IAAI,YAAG,QAAQ,EAAE,MAAM;qBACvB,SAAS,EAAE,GAAG;;;aAGlB,IAAI;iBACF,MAAM,EAAE,UAAU;iBAClB,IAAI,EAAE,WAAW;iBACjB,MAAM,EAAE,YAAY;iBACpB,OAAO,EAAE,OAAO;;aAElB,IAAI,EAAE,QAAQ;CACN,CAAA;AAEV,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,MAAM,CAAC,CAAA;AAC9C,MAAM,MAAM,OAAO,GAAG,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAA"}

package/dist/cjs/schemas/workspace/index.d.ts

@@ -0,0 +1,40 @@
+/** @file The `workspace` context schema versions, and the version the SDK's events send. */
+import type { SchemaUrl } from '../../types.js';
+import type { Schema as Schema1_0_0, Version as Version1_0_0 } from './1-0-0.js';
+export declare const name = "workspace";
+export declare const schemas: {
+    '1-0-0': {
+        readonly $schema: 'http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#';
+        readonly additionalProperties: true;
+        readonly description: 'Schema for a workspace';
+        readonly minProperties: 1;
+        readonly properties: {
+            readonly id: {
+                readonly description: 'The workspace ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly version_id: {
+                readonly description: 'The published workspace version ID';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+            readonly status: {
+                readonly description: 'The workspace status';
+                readonly type: readonly ['string', 'null'];
+                readonly maxLength: 255;
+            };
+        };
+        readonly self: {
+            readonly vendor: 'dev.pckd';
+            readonly name: 'workspace';
+            readonly format: 'jsonschema';
+            readonly version: '1-0-0';
+        };
+        readonly type: 'object';
+    };
+};
+export type CurrentSchema = Schema1_0_0;
+export type CurrentVersion = Version1_0_0;
+export type Url = SchemaUrl<typeof name, CurrentVersion>;
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/schemas/workspace/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/schemas/workspace/index.ts"],"names":[],"mappings":"AAAA,4FAA4F;AAC5F,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAC5C,OAAO,KAAK,EAAE,MAAM,IAAI,WAAW,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,SAAS,CAAA;AAG7E,eAAO,MAAM,IAAI,cAAc,CAAA;AAE/B,eAAO,MAAM,OAAO;IAClB,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CACR,CAAA;AAGD,MAAM,MAAM,aAAa,GAAG,WAAW,CAAA;AACvC,MAAM,MAAM,cAAc,GAAG,YAAY,CAAA;AACzC,MAAM,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,IAAI,EAAE,cAAc,CAAC,CAAA"}

package/dist/cjs/snowplow-plugins/event-meta.d.ts

@@ -0,0 +1,25 @@
+/** @file Snowplow browser plugin that stamps a tracker's configured meta into every Picked event it sends. */
+import type { BrowserPlugin } from '@snowplow/browser-tracker';
+import type { EventMetaSource } from '../types.js';
+/**
+ * Snowplow browser plugin merging `eventMeta` over the `meta` of every Picked event
+ * (`iglu:dev.pckd/event`) the tracker it is registered on sends. Configured keys win over
+ * the event's own keys of the same name; events with any other schema pass through. A function
+ * is called for each Picked event, so the keys are the ones it returns when the event is sent.
+ *
+ * It runs at `beforeTrack` against the tracker's own payload builder. The builder's
+ * unstructured-event entry gets a new `json` object, copied level by level down to `meta`,
+ * so the event data the caller handed to Snowplow, shared by every tracker the event is
+ * dispatched to, is never written. The same object is queued again with `addJson`, so the
+ * final `build()` writes it into `ue_pr`/`ue_px` even when the payload was built before this
+ * plugin ran, as Snowplow does for the first event of a session.
+ *
+ * @param {EventMetaSource} eventMeta - The keys to stamp, or a function returning them.
+ * @returns {BrowserPlugin} The plugin to hand to `newTracker`.
+ * @example
+ * newTracker('app', 'collector.example.com', {
+ *   plugins: [eventMetaPlugin({ surface: 'marketing' })],
+ * })
+ */
+export declare function eventMetaPlugin(eventMeta: EventMetaSource): BrowserPlugin;
+//# sourceMappingURL=event-meta.d.ts.map

package/dist/cjs/snowplow-plugins/event-meta.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-meta.d.ts","sourceRoot":"","sources":["../../../src/snowplow-plugins/event-meta.ts"],"names":[],"mappings":"AAAA,8GAA8G;AAC9G,OAAO,KAAK,EAAE,aAAa,EAAkB,MAAM,2BAA2B,CAAA;AAC9E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAO/C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,eAAe,CAAC,SAAS,EAAE,eAAe,GAAG,aAAa,CA6BzE"}

package/dist/cjs/snowplow-plugins/url-scrub.d.ts

@@ -0,0 +1,84 @@
+/** @file Snowplow browser plugin that redacts sensitive parameter values from the URLs on every event. */
+import type { BrowserPlugin } from '@snowplow/browser-tracker';
+/**
+ * Parameter name patterns whose values are redacted from every tracked URL.
+ *
+ * Applied to the query string and the fragment alike. Both are `&`-separated
+ * `name=value` lists, and which half a credential lands in is decided by the
+ * OAuth flow rather than by anything meaningful about the parameter: the
+ * authorization-code flow returns `code` in the query, the implicit flow returns
+ * `access_token` in the fragment.
+ *
+ * Matched on the parameter *name* only, never the value — pattern-matching a
+ * value is how a redaction routine ends up handling the thing it redacts.
+ *
+ * Patterns are tested against the name as {@link normaliseParamName} returns it:
+ * percent-decoded, lower-cased, and with `_` and `-` removed. Separators carry no
+ * meaning here, so one entry covers every spelling a parameter gets written in —
+ * `api_key`, `api-key`, `apikey` and `api__key` are one rule rather than four
+ * that drift apart.
+ *
+ * Anchoring is the whole policy, and it is deliberately asymmetric:
+ *
+ * - **Suffix-anchored** (`/token$/`) matches a qualifying prefix, because a
+ *   prefix names the same secret: `access_token`, `csrf_token` and `my_api_key`
+ *   are all credentials. A *suffix* changes the meaning instead, so `tokenizer`,
+ *   `token_type` and `email_opt_in` are left alone — the last two appeared in
+ *   the very payloads that motivated this plugin, and neither is a credential.
+ * - **Whole-name** (`/^code$/`) applies to `code` alone. It is the OAuth
+ *   authorization-code parameter, but `promo_code`, `country_code` and
+ *   `post_code` are ordinary report dimensions, and suffix-anchoring it would
+ *   silently redact them for every project. The bare name is the credential; the
+ *   qualified ones are data.
+ */
+export declare const SENSITIVE_PARAM_PATTERNS: readonly RegExp[];
+/**
+ * Redacts denylisted parameter values from a URL's query string and fragment.
+ *
+ * Both halves get the same treatment, because both carry the same credentials
+ * depending on which OAuth flow produced them. The fragment is redacted rather
+ * than dropped whole, so hash routes and in-page anchors survive: only the value
+ * of a parameter the denylist names is replaced.
+ *
+ * A denylisted parameter is redacted rather than deleted, keeping its name so
+ * the event still records that it was there. The path is never touched — a
+ * customer's real paths are legitimate data.
+ *
+ * Deliberately string surgery rather than `URL` parsing: `URL` normalises
+ * (`https://a.test` gains a trailing slash) and `URLSearchParams` re-encodes
+ * (`%20` becomes `+`). Both would alter values that ClickHouse reads back with
+ * `extractURLParameter`, which does raw string matching — so a normalising
+ * round-trip could silently change UTM attribution for every project.
+ *
+ * The fragment is split off before the query, so a `?` after the `#` is fragment
+ * content rather than a query string, as RFC 3986 has it.
+ *
+ * When nothing matches, the input is returned unchanged, byte for byte.
+ *
+ * @param {string} url - The URL as the tracker captured it.
+ * @returns {string} The URL with denylisted values redacted.
+ * @example
+ * scrubUrl('https://a.test/cb?code=abc#access_token=xyz&token_type=bearer')
+ * // 'https://a.test/cb?code=REDACTED#access_token=REDACTED&token_type=bearer'
+ */
+export declare function scrubUrl(url: string): string;
+/**
+ * Snowplow browser plugin redacting denylisted parameter values from every
+ * event's URL and referrer, for every project.
+ *
+ * Registered unconditionally in `createTracker` rather than behind an option: a
+ * safety default with an off switch is not a default. It runs at `beforeTrack`
+ * so it covers events emitted by the SDK itself, not only those routed through
+ * a consumer's own emission path.
+ *
+ * Snowplow's own `discardHashTag` drops the fragment wholesale. That takes hash
+ * routes and in-page anchors with it, does nothing about the query string, and
+ * is tracker-wide mutable state a later call can flip. One rule applied to both
+ * halves keeps the parts that are ordinary data.
+ *
+ * @returns {BrowserPlugin} The plugin to hand to `newTracker`.
+ * @example
+ * newTracker('app', 'collector.example.com', { plugins: [urlScrubPlugin()] })
+ */
+export declare function urlScrubPlugin(): BrowserPlugin;
+//# sourceMappingURL=url-scrub.d.ts.map

package/dist/cjs/snowplow-plugins/url-scrub.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url-scrub.d.ts","sourceRoot":"","sources":["../../../src/snowplow-plugins/url-scrub.ts"],"names":[],"mappings":"AAAA,0GAA0G;AAC1G,OAAO,KAAK,EAAE,aAAa,EAAkB,MAAM,2BAA2B,CAAA;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,wBAAwB,mBAOnC,CAAA;AA0FF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAiB5C;AAmBD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,cAAc,IAAI,aAAa,CAc9C"}

package/dist/cjs/tracker.d.ts

@@ -0,0 +1,17 @@
+/** @file Snowplow tracker initialization and global context binding. */
+import { type BrowserTracker } from '@snowplow/browser-tracker';
+import type { CreateTrackerOptions } from './types.js';
+/**
+ * Starts a Snowplow tracker for a Picked project and binds the contexts every event carries.
+ * An `appId` that already names a tracker on the page creates nothing, adds nothing to that
+ * tracker, and logs a warning.
+ *
+ * @param {CreateTrackerOptions} options - Collector address, app identity, deployment
+ *   metadata, and the per-plugin tracking toggles.
+ * @returns {BrowserTracker | null | undefined} The tracker; `null` when `appId` is already in
+ *   use, and `undefined` outside a browser.
+ * @example
+ * createTracker({ projectId: 'abc', collectorUrl: 'evnts.pckd.dev', deployment: { env: 'production' } })
+ */
+export declare function createTracker({ projectId, cvlyX, deployment, collectorUrl, collectorPath, appId, trackVitals, trackPerformance, trackWebPage, trackSessions, trackBrowser, trackActivity, trackErrors, trackActivityCallback, trackButtonClickAllowList, trackButtonClickFilter, eventMeta, anonymousTracking, }: CreateTrackerOptions): BrowserTracker | null | undefined;
+//# sourceMappingURL=tracker.d.ts.map

package/dist/cjs/tracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracker.d.ts","sourceRoot":"","sources":["../../src/tracker.ts"],"names":[],"mappings":"AAAA,wEAAwE;AACxE,OAAO,EAML,KAAK,cAAc,EAGpB,MAAM,2BAA2B,CAAA;AAWlC,OAAO,KAAK,EAEV,oBAAoB,EAOrB,MAAM,SAAS,CAAA;AAsGhB;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,EAC5B,SAAS,EAET,KAAK,EACL,UAAU,EACV,YAA+B,EAC/B,aAAa,EACb,KAA0B,EAC1B,WAAmB,EACnB,gBAAwB,EACxB,YAAmB,EACnB,aAAoB,EACpB,YAAmB,EACnB,aAAqB,EACrB,WAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACtB,SAAS,EACT,iBAAiB,GAClB,EAAE,oBAAoB,GAAG,cAAc,GAAG,IAAI,GAAG,SAAS,CA0D1D"}