@segment/warehouse-destinations 1.0.1-staging-dbf70accf.0

package/README.md

@@ -0,0 +1,18 @@
+# `warehouse-destinations`
+
+**For Segment Use Only**
+
+Used to define warehouse destinations and their associated actions.
+
+The perform block will never be called in these actions, they are only used to create definitions.
+
+We do not need to register warehouse desitnations and return a manifest because the warehouse destination package is exclusively used by the CLI to push warehouse destination definitions to the Segment platform.
+
+## Usage
+
+```
+const warehouseDestinations = require('warehouse-destinations');
+
+const warehouseDefinitions = await warehouse.getDefinitions(actionsPath)
+// returns a list of warehouse definitions that can be registered on the Segment platform.
+```

package/dist/destinations/index.d.ts

@@ -0,0 +1,2 @@
+import type { WarehouseDestinationDefinition } from '@segment/actions-core';
+export declare const getDefinitions: (dirPath: string) => Promise<WarehouseDestinationDefinition[]>;

package/dist/destinations/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefinitions = void 0;
+const globby_1 = require("globby");
+const path_1 = __importDefault(require("path"));
+const getDefinitions = async (dirPath) => {
+    const destPath = path_1.default.join(dirPath, 'src/destinations/*');
+    const warehouseDestDirs = await (0, globby_1.globby)(destPath, {
+        expandDirectories: false,
+        onlyDirectories: true,
+        gitignore: false,
+        ignore: ['node_modules']
+    });
+    const definitions = warehouseDestDirs.map((dir) => {
+        const destination = require(dir).default;
+        return destination;
+    });
+    return definitions;
+};
+exports.getDefinitions = getDefinitions;
+//# sourceMappingURL=index.js.map

package/dist/destinations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/destinations/index.ts"],"names":[],"mappings":";;;;;;AAAA,mCAA+B;AAC/B,gDAAuB;AAUhB,MAAM,cAAc,GAAG,KAAK,EAAE,OAAe,EAA6C,EAAE;IACjG,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAA;IACzD,MAAM,iBAAiB,GAAG,MAAM,IAAA,eAAM,EAAC,QAAQ,EAAE;QAC/C,iBAAiB,EAAE,KAAK;QACxB,eAAe,EAAE,IAAI;QACrB,SAAS,EAAE,KAAK;QAChB,MAAM,EAAE,CAAC,cAAc,CAAC;KACzB,CAAC,CAAA;IAEF,MAAM,WAAW,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAEhD,MAAM,WAAW,GAAmC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAA;QACxE,OAAO,WAAW,CAAA;IACpB,CAAC,CAAC,CAAA;IAEF,OAAO,WAAW,CAAA;AACpB,CAAC,CAAA;AAhBY,QAAA,cAAc,kBAgB1B"}

package/dist/destinations/snowflake/generated-types.d.ts

@@ -0,0 +1,3 @@
+export interface Settings {
+    warehouseId: string;
+}

package/dist/destinations/snowflake/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/snowflake/generated-types.js.map

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

package/dist/destinations/snowflake/index.d.ts

@@ -0,0 +1,4 @@
+import type { WarehouseDestinationDefinition } from '@segment/actions-core';
+import type { Settings } from './generated-types';
+declare const destination: WarehouseDestinationDefinition<Settings>;
+export default destination;

package/dist/destinations/snowflake/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sendCustomEvent_1 = __importDefault(require("./sendCustomEvent"));
+const destination = {
+    name: 'Snowflake',
+    slug: 'snowflake',
+    mode: 'warehouse',
+    settings: {
+        warehouseId: {
+            label: 'Warehouse ID',
+            description: 'The ID of the existing Snowflake warehouse instance to use.',
+            type: 'string',
+            required: true
+        }
+    },
+    actions: {
+        sendCustomEvent: sendCustomEvent_1.default
+    }
+};
+exports.default = destination;
+//# sourceMappingURL=index.js.map

package/dist/destinations/snowflake/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/destinations/snowflake/index.ts"],"names":[],"mappings":";;;;;AAGA,wEAA+C;AAE/C,MAAM,WAAW,GAA6C;IAC5D,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,WAAW;IACjB,IAAI,EAAE,WAAW;IAEjB,QAAQ,EAAE;QACR,WAAW,EAAE;YACX,KAAK,EAAE,cAAc;YACrB,WAAW,EAAE,6DAA6D;YAC1E,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACf;KACF;IAED,OAAO,EAAE;QACP,eAAe,EAAf,yBAAe;KAChB;CACF,CAAA;AAED,kBAAe,WAAW,CAAA"}

package/dist/destinations/snowflake/sendCustomEvent/generated-types.d.ts

@@ -0,0 +1,9 @@
+export interface Payload {
+    timestamp: string;
+    messageId: string;
+    event: string;
+    type: string;
+    properties: {
+        [k: string]: unknown;
+    };
+}

package/dist/destinations/snowflake/sendCustomEvent/generated-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=generated-types.js.map

package/dist/destinations/snowflake/sendCustomEvent/generated-types.js.map

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

package/dist/destinations/snowflake/sendCustomEvent/index.d.ts

@@ -0,0 +1,5 @@
+import type { ActionDefinition } from '@segment/actions-core';
+import type { Settings } from '../generated-types';
+import type { Payload } from './generated-types';
+declare const action: ActionDefinition<Settings, Payload>;
+export default action;

package/dist/destinations/snowflake/sendCustomEvent/index.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const action = {
+    title: 'Send Custom Event',
+    description: 'Record custom events in Snowflake',
+    fields: {
+        timestamp: {
+            label: 'Timestamp',
+            description: 'Timestamp of the event',
+            type: 'string',
+            required: true,
+            default: { '@path': '$.timestamp' }
+        },
+        messageId: {
+            label: 'Message ID',
+            description: 'Name of column for the unique identifier for the message.',
+            type: 'string',
+            required: true,
+            default: { '@path': '$.messageId' },
+            readOnly: true
+        },
+        event: {
+            label: 'Table Name',
+            description: 'Name of the table. This will be the event name.',
+            type: 'string',
+            required: true,
+            default: { '@path': '$.event' },
+            readOnly: true
+        },
+        type: {
+            label: 'Event Type',
+            description: 'The type of event',
+            type: 'string',
+            required: true,
+            default: { '@path': '$.type' },
+            readOnly: true
+        },
+        properties: {
+            label: 'Columns',
+            description: `Additional columns to write to Snowflake.`,
+            type: 'object',
+            defaultObjectUI: 'keyvalue',
+            required: true,
+            additionalProperties: true,
+            default: {
+                entityContext: {
+                    '@json': {
+                        mode: 'encode',
+                        value: {
+                            '@path': '$.properties.data_graph_entity_context'
+                        }
+                    }
+                },
+                userId: {
+                    label: 'User ID',
+                    description: 'Unique ID for the user.',
+                    type: 'string',
+                    default: { '@path': '$.userId' }
+                },
+                audienceKey: {
+                    label: 'Audience Key',
+                    description: 'The Kky of the audience.',
+                    type: 'string',
+                    default: { '@path': '$.properties.audience_key' }
+                },
+                personasComputationKey: {
+                    label: 'Personas Computation Key',
+                    description: 'Computation key set by Segment Personas.',
+                    type: 'string',
+                    default: { '@path': '$.context.personas.computation_key' }
+                },
+                personasComputationId: {
+                    label: 'Personas Computation ID',
+                    description: 'Computation ID set by Segment Personas.',
+                    type: 'string',
+                    default: { '@path': '$.context.personas.computation_id' }
+                },
+                personasComputationRunId: {
+                    label: 'Personas Computation Run ID',
+                    description: 'Unique ID for this run, set by Segment Personas.',
+                    type: 'string',
+                    default: { '@path': '$.context.personas.computation_run_id' }
+                },
+                personasActivationId: {
+                    label: 'Personas Activation ID',
+                    description: 'ID of the activation, set by Segment Personas.',
+                    type: 'string',
+                    default: { '@path': '$.context.personas.event_emitter_id' }
+                }
+            }
+        }
+    },
+    perform: () => {
+        return undefined;
+    }
+};
+exports.default = action;
+//# sourceMappingURL=index.js.map

package/dist/destinations/snowflake/sendCustomEvent/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/destinations/snowflake/sendCustomEvent/index.ts"],"names":[],"mappings":";;AAIA,MAAM,MAAM,GAAwC;IAClD,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,mCAAmC;IAChD,MAAM,EAAE;QACN,SAAS,EAAE;YACT,KAAK,EAAE,WAAW;YAClB,WAAW,EAAE,wBAAwB;YACrC,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE;SACpC;QACD,SAAS,EAAE;YACT,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,2DAA2D;YACxE,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE;YACnC,QAAQ,EAAE,IAAI;SACf;QACD,KAAK,EAAE;YACL,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,iDAAiD;YAC9D,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;YAC/B,QAAQ,EAAE,IAAI;SACf;QACD,IAAI,EAAE;YACJ,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE,mBAAmB;YAChC,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE;YAC9B,QAAQ,EAAE,IAAI;SACf;QAED,UAAU,EAAE;YACV,KAAK,EAAE,SAAS;YAChB,WAAW,EAAE,2CAA2C;YACxD,IAAI,EAAE,QAAQ;YACd,eAAe,EAAE,UAAU;YAC3B,QAAQ,EAAE,IAAI;YACd,oBAAoB,EAAE,IAAI;YAC1B,OAAO,EAAE;gBACP,aAAa,EAAE;oBACb,OAAO,EAAE;wBACP,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE;4BACL,OAAO,EAAE,wCAAwC;yBAClD;qBACF;iBACF;gBACD,MAAM,EAAE;oBACN,KAAK,EAAE,SAAS;oBAChB,WAAW,EAAE,yBAAyB;oBACtC,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE;iBACjC;gBACD,WAAW,EAAE;oBACX,KAAK,EAAE,cAAc;oBACrB,WAAW,EAAE,0BAA0B;oBACvC,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE,OAAO,EAAE,2BAA2B,EAAE;iBAClD;gBACD,sBAAsB,EAAE;oBACtB,KAAK,EAAE,0BAA0B;oBACjC,WAAW,EAAE,0CAA0C;oBACvD,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE,OAAO,EAAE,oCAAoC,EAAE;iBAC3D;gBACD,qBAAqB,EAAE;oBACrB,KAAK,EAAE,yBAAyB;oBAChC,WAAW,EAAE,yCAAyC;oBACtD,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE,OAAO,EAAE,mCAAmC,EAAE;iBAC1D;gBACD,wBAAwB,EAAE;oBACxB,KAAK,EAAE,6BAA6B;oBACpC,WAAW,EAAE,kDAAkD;oBAC/D,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE,OAAO,EAAE,uCAAuC,EAAE;iBAC9D;gBACD,oBAAoB,EAAE;oBACpB,KAAK,EAAE,wBAAwB;oBAC/B,WAAW,EAAE,gDAAgD;oBAC7D,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,EAAE,OAAO,EAAE,qCAAqC,EAAE;iBAC5D;aACF;SACF;KACF;IACD,OAAO,EAAE,GAAG,EAAE;QACZ,OAAO,SAAS,CAAA;IAClB,CAAC;CACF,CAAA;AAED,kBAAe,MAAM,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './destinations';
+export { WarehouseDestinationDefinition } from '@segment/actions-core';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./destinations"), exports);
+//# 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,iDAA8B"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@segment/warehouse-destinations",
+  "version": "1.0.1-staging-dbf70accf.0",
+  "description": "Definitions for warehouse destinations. Only used for definitions - should not be imported for anything other than types.",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "yarn tsc -b tsconfig.build.json",
+    "clean": "tsc -b tsconfig.build.json --clean",
+    "postclean": "rm -rf dist",
+    "prepublishOnly": "yarn build",
+    "typecheck": "tsc -p tsconfig.build.json --noEmit"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "engines": {
+    "node": "^18.17 || ^22.13"
+  },
+  "engineStrict": true,
+  "license": "MIT",
+  "dependencies": {
+    "@segment/actions-core": "^3.152.0",
+    "globby": "^14.1.0"
+  },
+  "gitHead": "43ffaddf8f9856a98b6ce05047f67ed235d7d560"
+}