@forzalabs/remora 1.0.21 → 1.1.1

package/definitions/json_schemas/producer-schema.json

@@ -1,308 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Producer Schema",
-    "description": "Schema for defining data producers",
-    "type": "object",
-    "properties": {
-        "$schema": {
-            "type": "string",
-            "format": "uri"
-        },
-        "name": {
-            "type": "string",
-            "description": "The name of the producer"
-        },
-        "description": {
-            "type": "string",
-            "description": "Optional description of the producer"
-        },
-        "source": {
-            "type": "string",
-            "description": "The name of the Source"
-        },
-        "dimensions": {
-            "type": "array",
-            "description": "Dimensions for the producer",
-            "items": {
-                "type": "object",
-                "properties": {
-                    "name": {
-                        "type": "string",
-                        "description": "The name of the dimension. This is the output name of this dimension."
-                    },
-                    "description": {
-                        "type": "string",
-                        "description": "Optional description of the dimension"
-                    },
-                    "type": {
-                        "type": "string",
-                        "enum": [
-                            "string",
-                            "number",
-                            "datetime",
-                            "boolean"
-                        ],
-                        "description": "The data type of the dimension"
-                    },
-                    "alias": {
-                        "type": "string",
-                        "description": "The SQL column or field key that corresponds to this dimension. If left empty, the column name is assumed to be the same as the dimension name."
-                    },
-                    "pk": {
-                        "type": "boolean",
-                        "description": "Whether this is a primary key column or not"
-                    },
-                    "classification": {
-                        "type": "array",
-                        "items": {
-                            "type": "string",
-                            "enum": [
-                                "PHI",
-                                "PII",
-                                "GDPR"
-                            ],
-                            "description": "Classification categories for this dimension"
-                        }
-                    },
-                    "mask": {
-                        "type": "string",
-                        "description": "Masking type to apply to this dimension. Predefined values: 'hash' (replaces with a hashed value), 'mask' (replaces characters with a mask character), 'crypt' (encrypts the value), 'random' (replaces with a random value), 'seeded-random' (replaces with a random value generated from a seed), 'none' (no masking). You can also use environment variables by using the {your-env-var} notation or any custom string value.",
-                        "examples": [
-                            "hash",
-                            "mask",
-                            "crypt",
-                            "random",
-                            "seeded-random", 
-                            "none",
-                            "{REMORA_MASK_IN_DEV}"
-                        ]
-                    },
-                    "sourceFilename": {
-                        "type": "boolean",
-                        "description": "When true, this dimension will be populated with the source filename. Only valid for file-based producers (local, aws-s3) and only one dimension per producer can have this set to true. Useful when reading multiple files with wildcard patterns to track which file each row came from."
-                    }
-                },
-                "required": [
-                    "name",
-                    "type"
-                ],
-                "additionalProperties": false
-            },
-            "minItems": 1
-        },
-        "measures": {
-            "type": "array",
-            "description": "Optional measures for the producer",
-            "items": {
-                "type": "object",
-                "properties": {
-                    "name": {
-                        "type": "string",
-                        "description": "The name of the measure"
-                    },
-                    "description": {
-                        "type": "string",
-                        "description": "Optional description of the measure"
-                    },
-                    "sql": {
-                        "type": "string",
-                        "description": "SQL command used to create a metric"
-                    }
-                },
-                "required": [
-                    "name",
-                    "sql"
-                ],
-                "additionalProperties": false
-            }
-        },
-        "settings": {
-            "type": "object",
-            "compressionType": {
-                "type": "string",
-                "enum": [
-                    "GZ",
-                    "TAR",
-                    "ZIP"
-                    ],
-                "description": "The compression type used from the file to read"
-            },
-            "description": "Settings for the producer",
-            "properties": {
-                "sqlTable": {
-                    "type": "string",
-                    "description": "The SQL table name, which is a concise way of setting the sql property to 'SELECT * FROM <sql table name>'"
-                },
-                "direct": {
-                    "type": "boolean",
-                    "description": "If true, no view is created on the producer side due to permission limitations"
-                },
-                "sql": {
-                    "type": "string",
-                    "description": "The name of the file that has the SQL statement to run to create this producer"
-                },
-                "fileKey": {
-                    "type": "string",
-                    "description": "For S3/local sources: the file key/path that identifies the file to read. For HTTP API sources: the API endpoint path (e.g., '/api/v1/users')"
-                },
-                "fileType": {
-                    "type": "string",
-                    "enum": [
-                        "JSON",
-                        "JSONL",
-                        "CSV", 
-                        "TXT",
-                        "XLS",
-                        "XLSX",
-                        "XML",
-                        "PARQUET"
-                    ],
-                    "description": "The type of file to read."
-                },
-                "delimiter": {
-                    "type": "string",
-                    "description": "The column delimiter for CSV or TXT files if different from the default (,)."
-                },
-                "hasHeaderRow": {
-                    "type": "boolean",
-                    "description": "For TXT files, specifies whether the file has a header row containing column names. Defaults to true."
-                },
-                "sheetName": {
-                    "type": "string", 
-                    "description": "For Excel files (.xls/.xlsx), specifies the name of the sheet to read data from. If not specified, the first sheet will be used."
-                }
-            },
-            "additionalProperties": false
-        },
-        "_version": {
-            "type": "number",
-            "description": "Version number of the producer configuration"
-        }
-    },
-    "required": [
-        "name",
-        "source",
-        "dimensions",
-        "settings"
-    ],
-    "additionalProperties": false,
-    "examples": [
-        {
-            "name": "CustomerData",
-            "description": "Producer for customer data from the main database",
-            "source": "Production PostgreSQL Database",
-            "dimensions": [
-                {
-                    "name": "customer_id",
-                    "type": "string",
-                    "pk": true
-                },
-                {
-                    "name": "full_name",
-                    "type": "string",
-                    "classification": [
-                        "PII",
-                        "GDPR"
-                    ],
-                    "mask": "hash"
-                },
-                {
-                    "name": "email",
-                    "type": "string",
-                    "format": {
-                        "type": "string",
-                        "description": "Format for datetype of the source ('YYYYMMDD', 'DD-MM-YYYY')"
-                    },
-                    "classification": [
-                        "PII",
-                        "GDPR"
-                    ],
-                    "mask": "mask"
-                },
-                {
-                    "name": "signup_date",
-                    "type": "datetime"
-                }
-            ],
-            "measures": [
-                {
-                    "name": "total_orders",
-                    "description": "Total number of orders by this customer",
-                    "sql": "COUNT(order_id)"
-                },
-                {
-                    "name": "total_spent",
-                    "description": "Total amount spent by this customer",
-                    "sql": "SUM(order_amount)"
-                }
-            ],
-            "settings": {
-                "sqlTable": "customers"
-            },
-            "_version": 1
-        },
-        {
-            "name": "SalesData",
-            "description": "Producer for sales data from S3 bucket",
-            "source": "Data Lake",
-            "dimensions": [
-                {
-                    "name": "transaction_id",
-                    "type": "string",
-                    "pk": true
-                },
-                {
-                    "name": "product_id",
-                    "type": "string"
-                },
-                {
-                    "name": "sale_amount",
-                    "type": "number"
-                },
-                {
-                    "name": "sale_date",
-                    "type": "datetime"
-                }
-            ],
-            "settings": {
-                "fileKey": "sales/daily_sales.csv",
-                "fileType": "CSV"
-            },
-            "_version": 2
-        },
-        {
-            "name": "APIUsers",
-            "description": "Producer for user data from REST API",
-            "source": "REST API with Bearer Token",
-            "dimensions": [
-                {
-                    "name": "user_id",
-                    "type": "string",
-                    "pk": true
-                },
-                {
-                    "name": "username",
-                    "type": "string"
-                },
-                {
-                    "name": "email",
-                    "type": "string",
-                    "classification": [
-                        "PII",
-                        "GDPR"
-                    ],
-                    "mask": "mask"
-                },
-                {
-                    "name": "created_at",
-                    "type": "datetime"
-                }
-            ],
-            "settings": {
-                "fileKey": "/api/v1/users",
-                "fileType": "JSON"
-            },
-            "_version": 1
-        }
-    ]
-}

package/definitions/json_schemas/project-schema.json

@@ -1,100 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Project Schema",
-    "description": "Schema for defining remora project configuration",
-    "type": "object",
-    "required": ["name", "version", "consumers", "producers", "sources", "schemas", "settings"],
-    "properties": {
-        "$schema": {
-            "type": "string",
-            "format": "uri"
-        },
-        "name": {
-            "type": "string",
-            "description": "Name of the remora project"
-        },
-        "version": {
-            "type": "string",
-            "pattern": "^\\d+\\.\\d+\\.\\d+$",
-            "description": "Version of the project in semver format"
-        },
-        "description": {
-            "type": "string",
-            "description": "Optional description of the project"
-        },
-        "consumers": {
-            "type": "array",
-            "items": {
-                "type": "string",
-                "pattern": "^/"
-            },
-            "description": "Array of consumer paths"
-        },
-        "producers": {
-            "type": "array",
-            "items": {
-                "type": "string",
-                "pattern": "^/"
-            },
-            "description": "Array of producer paths"
-        },
-        "sources": {
-            "type": "array",
-            "items": {
-                "type": "string",
-                "pattern": "^/"
-            },
-            "description": "Array of source paths"
-        },
-        "schemas": {
-            "type": "array",
-            "items": {
-                "type": "string",
-                "pattern": "^/"
-            },
-            "description": "Array of schema paths"
-        },
-        "settings": {
-            "type": "object",
-            "required": ["SQL_MAX_QUERY_ROWS"],
-            "properties": {
-                "SQL_MAX_QUERY_ROWS": {
-                    "type": "integer",
-                    "minimum": 1,
-                    "description": "Maximum number of rows for SQL queries"
-                },
-                "STRING_MAX_CHARACTERS_LENGTH": {
-                    "type": "integer",
-                    "minimum": 1,
-                    "description": "Maximum length for string fields"
-                },
-                "MAX_ITEMS_IN_MEMORY": {
-                    "type": "integer",
-                    "minimum": 1,
-                    "description": "Maximum number of items to keep in memory"
-                },
-                "DEBUG_MODE": {
-                    "type": "boolean",
-                    "description": "Enable logging of internal steps"
-                }
-            }
-        }
-    },
-    "additionalProperties": false,
-    "examples": [
-        {
-            "$schema": "https://raw.githubusercontent.com/ForzaLabs/remora-public/refs/heads/main/json_schemas/project-schema.json",
-            "name": "analytics-project",
-            "version": "1.0.0",
-            "description": "Analytics data processing project",
-            "consumers": ["/consumers"],
-            "producers": ["/producers"],
-            "sources": ["/sources"],
-            "schemas": ["/schemas"],
-            "settings": {
-                "SQL_MAX_QUERY_ROWS": 10000,
-                "DEBUG_MODE": true
-            }
-        }
-    ]
-}

package/definitions/json_schemas/source-schema.json

@@ -1,249 +0,0 @@
-{
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "title": "Source Schema",
-    "description": "Schema for defining data sources and their authentication methods",
-    "type": "object",
-    "properties": {
-        "$schema": {
-            "type": "string",
-            "format": "uri"
-        },
-        "name": {
-            "type": "string",
-            "description": "The name of the data source"
-        },
-        "description": {
-            "type": "string",
-            "description": "Optional description of the data source"
-        },
-        "engine": {
-            "type": "string",
-            "enum": [
-                "aws-redshift",
-                "aws-dynamodb",
-                "aws-s3",
-                "postgres",
-                "local",
-                "delta-share",
-                "http-api"
-            ],
-            "description": "The type of data engine"
-        },
-        "authentication": {
-            "type": "object",
-            "description": "Authentication details for connecting to the data source. You can use environment variables by using the {your-env-var} notation",
-            "properties": {
-                "method": {
-                    "type": "string",
-                    "enum": [
-                        "iam",
-                        "username-password",
-                        "access-secret-key",
-                        "arn",
-                        "implicit",
-                        "bearer-token",
-                        "api-key",
-                        "none"
-                    ],
-                    "description": "The authentication method to use"
-                },
-                "host": {
-                    "type": "string",
-                    "description": "Hostname or endpoint of the data source"
-                },
-                "user": {
-                    "type": "string",
-                    "description": "Username for authentication"
-                },
-                "password": {
-                    "type": "string",
-                    "description": "Password for authentication"
-                },
-                "database": {
-                    "type": "string",
-                    "description": "Database name"
-                },
-                "workgroup": {
-                    "type": "string",
-                    "description": "Workgroup name"
-                },
-                "schema": {
-                    "type": "string",
-                    "description": "Database schema name"
-                },
-                "table": {
-                    "type": "string",
-                    "description": "Table name (used by some engines like delta-share)"
-                },
-                "port": {
-                    "type": "string",
-                    "description": "Port number for the connection"
-                },
-                "accessKey": {
-                    "type": "string",
-                    "description": "AWS access key ID"
-                },
-                "secretKey": {
-                    "type": "string",
-                    "description": "AWS secret access key"
-                },
-                "sessionToken": {
-                    "type": "string",
-                    "description": "AWS session token (if required)"
-                },
-                "region": {
-                    "type": "string",
-                    "description": "AWS region"
-                },
-                "bucket": {
-                    "type": "string",
-                    "description": "S3 bucket name"
-                },
-                "iamProfile": {
-                    "type": "string",
-                    "description": "IAM role or profile name"
-                },
-                "clusterId": {
-                    "type": "string",
-                    "description": "Redshift cluster identifier"
-                },
-                "path": {
-                    "type": "string",
-                    "description": "The folder path"
-                },
-                "share": {
-                    "type": "string",
-                    "description": "Delta Sharing share name"
-                },
-                "bearerToken": {
-                    "type": "string",
-                    "description": "Bearer token used for authentication (Delta Sharing or HTTP API)"
-                },
-                "url": {
-                    "type": "string",
-                    "format": "uri",
-                    "description": "Base URL for HTTP API sources"
-                },
-                "headers": {
-                    "type": "object",
-                    "description": "Custom HTTP headers for API requests",
-                    "additionalProperties": {
-                        "type": "string"
-                    }
-                },
-                "queryParams": {
-                    "type": "object",
-                    "description": "Default query parameters for API requests",
-                    "additionalProperties": {
-                        "type": "string"
-                    }
-                },
-                "httpMethod": {
-                    "type": "string",
-                    "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"],
-                    "description": "HTTP method to use for API requests",
-                    "default": "GET"
-                },
-                "apiKey": {
-                    "type": "string",
-                    "description": "API key for api-key authentication method"
-                },
-                "apiKeyHeader": {
-                    "type": "string",
-                    "description": "Header name for API key (defaults to X-API-Key)",
-                    "default": "X-API-Key"
-                },
-                "timeout": {
-                    "type": "number",
-                    "description": "Request timeout in milliseconds",
-                    "default": 30000,
-                    "minimum": 1000
-                }
-            },
-            "required": ["method"]
-        },
-        "_version": {
-            "type": "number",
-            "description": "Version number of the source configuration"
-        }
-    },
-    "required": [
-        "name",
-        "engine",
-        "authentication"
-    ],
-    "additionalProperties": false,
-    "examples": [
-        {
-            "name": "Production PostgreSQL Database",
-            "description": "Main production database for customer data",
-            "engine": "postgres",
-            "authentication": {
-                "method": "username-password",
-                "host": "prod-db.example.com",
-                "user": "app_user",
-                "password": "password123",
-                "database": "customers",
-                "schema": "public",
-                "port": "5432"
-            },
-            "_version": 1
-        },
-        {
-            "name": "Data Lake",
-            "description": "AWS S3 bucket containing analytics data",
-            "engine": "aws-s3",
-            "authentication": {
-                "method": "access-secret-key",
-                "accessKey": "AKIAIOSFODNN7EXAMPLE",
-                "secretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
-                "region": "us-east-1",
-                "bucket": "analytics-data"
-            },
-            "_version": 2
-        },
-        {
-            "name": "Redshift Data Warehouse",
-            "engine": "aws-redshift",
-            "authentication": {
-                "method": "iam",
-                "host": "redshift-cluster.region.redshift.amazonaws.com",
-                "database": "analytics",
-                "port": "5439",
-                "iamProfile": "redshift-access-role",
-                "region": "us-west-2",
-                "clusterId": "analytics-cluster"
-            },
-            "_version": 1
-        },
-        {
-            "name": "REST API with Bearer Token",
-            "description": "HTTP API source with bearer token authentication",
-            "engine": "http-api",
-            "authentication": {
-                "method": "bearer-token",
-                "url": "https://api.example.com",
-                "bearerToken": "{API_BEARER_TOKEN}",
-                "headers": {
-                    "Accept": "application/json"
-                },
-                "timeout": 30000
-            },
-            "_version": 1
-        },
-        {
-            "name": "Public REST API",
-            "description": "Public HTTP API with no authentication",
-            "engine": "http-api",
-            "authentication": {
-                "method": "none",
-                "url": "https://api.publicapis.org",
-                "headers": {
-                    "Accept": "application/json"
-                },
-                "httpMethod": "GET"
-            },
-            "_version": 1
-        }
-    ]
-}

package/definitions/requests/ConsumerRequest.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/definitions/requests/Developer.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/definitions/requests/Mapping.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/definitions/requests/ProducerRequest.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/definitions/requests/Request.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/definitions/resources/Compiled.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });