Merge pull request #31 from cipherstash/prep-for-release

chore: clean up repo

Author: calvinbrewer

GETTINGSTARTED.md

@@ -15,12 +15,12 @@ We plan to support direct language integration in the future.
 ### Installation
 
 In order to use EQL, you must first install the EQL extension in your PostgreSQL database.
-You can do this by running the following command, which will execute the SQL from the `src/install.sql` file:
 
-Update the database credentials based on your environment.
+1. Download the [cipherstash-encrypt-dsl.sql](./release/cipherstash-encrypt-dsl.sql) file
+2. Run the following command to install the custom types and functions:
 
 ```bash
-psql -U postgres -d postgres -f src/install.sql
+psql -U postgres -d postgres -f cipherstash-encrypt-dsl.sql
 ```
 
 > Note: We also have direct language specific ORM support for installing the extension. See the `languages` directory for more information.

README.md

@@ -583,7 +583,7 @@ Encrypted data is stored as `jsonb` with a specific schema:
   }
   ```
 
-The format is defined as a [JSON Schema](src/cs_encrypted_v1.schema.json).
+The format is defined as a [JSON Schema](./cs_encrypted_v1.schema.json).
 
 It should never be necessary to directly interact with the stored `jsonb`.
 Cipherstash proxy handles the encoding, and EQL provides the functions.

src/cs_encrypted_v1.schema.json renamed to cs_encrypted_v1.schema.json

@@ -1,3 +1,3 @@
-module github.com/encrypt-query-language/go/goeql
+module github.com/cipherstash/encrypt-query-language/languages/go/goeql
 
 go 1.21.3

languages/go/goeql/go.mod

@@ -1,13 +1,13 @@
-import { defineConfig } from 'drizzle-kit'
+import { defineConfig } from "drizzle-kit";
 
 export default defineConfig({
-  schema: './src/schema.ts',
-  out: './migrations',
-  dialect: 'postgresql',
-  dbCredentials: {
-    host: process.env.DB_HOST,
-    user: process.env.DB_USER,
-    password: process.env.DB_PASSWORD,
-    database: process.env.DB_NAME,
-  },
-})
+	schema: "./src/schema.ts",
+	out: "./migrations",
+	dialect: "postgresql",
+	dbCredentials: {
+		host: process.env.DB_HOST,
+		user: process.env.DB_USER,
+		password: process.env.DB_PASSWORD,
+		database: process.env.DB_NAME,
+	},
+});

languages/javascript/apps/drizzle/drizzle.config.ts

@@ -1,52 +1,45 @@
 {
-  "name": "@cipherstash/eql",
-  "version": "0.0.0",
-  "description": "CipherStash Encrypted Query Language TypeScript Library",
-  "keywords": [
-    "encrypted",
-    "query",
-    "language",
-    "typescript",
-    "ts",
-    "eql"
-  ],
-  "homepage": "https://github.com/cipherstash/encrypt-query-language/tree/main/packages/ts-eql",
-  "bugs": {
-    "url": "https://github.com/cipherstash/encrypt-query-language/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/cipherstash/encrypt-query-language.git"
-  },
-  "license": "MIT",
-  "author": "CipherStash <hello@cipherstash.com>",
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    },
-    "./drizzle": {
-      "types": "./dist/drizzle/index.d.ts",
-      "import": "./dist/drizzle/index.js",
-      "require": "./dist/drizzle/index.cjs"
-    }
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "generate-types": "json2ts ../../../src/cs_encrypted_v1.schema.json --output ./cs_encrypted_v1.ts"
-  },
-  "devDependencies": {
-    "@types/bun": "latest",
-    "json-schema-to-typescript": "^15.0.2",
-    "tsup": "^8.3.0"
-  },
-  "peerDependencies": {
-    "typescript": "^5.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
-  }
-}
+	"name": "@cipherstash/eql",
+	"version": "0.0.0",
+	"description": "CipherStash Encrypted Query Language TypeScript Library",
+	"keywords": ["encrypted", "query", "language", "typescript", "ts", "eql"],
+	"homepage": "https://github.com/cipherstash/encrypt-query-language/tree/main/packages/ts-eql",
+	"bugs": {
+		"url": "https://github.com/cipherstash/encrypt-query-language/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/cipherstash/encrypt-query-language.git"
+	},
+	"license": "MIT",
+	"author": "CipherStash <hello@cipherstash.com>",
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"require": "./dist/index.cjs"
+		},
+		"./drizzle": {
+			"types": "./dist/drizzle/index.d.ts",
+			"import": "./dist/drizzle/index.js",
+			"require": "./dist/drizzle/index.cjs"
+		}
+	},
+	"scripts": {
+		"build": "tsup",
+		"dev": "tsup --watch",
+		"generate-types": "json2ts ../../../cs_encrypted_v1.schema.json --output ./cs_encrypted_v1.ts"
+	},
+	"devDependencies": {
+		"@types/bun": "latest",
+		"json-schema-to-typescript": "^15.0.2",
+		"tsup": "^8.3.0"
+	},
+	"peerDependencies": {
+		"typescript": "^5.0.0"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}

languages/javascript/packages/eql/package.json

@@ -1,8 +1,8 @@
-import { defineConfig } from 'tsup'
+import { defineConfig } from "tsup";
 
 export default defineConfig({
-  entry: ['src/index.ts'],
-  format: ['cjs', 'esm'],
-  sourcemap: true,
-  dts: true,
-})
+	entry: ["src/index.ts"],
+	format: ["cjs", "esm"],
+	sourcemap: true,
+	dts: true,
+});