@aurios/mizzling 1.1.4 → 1.1.6

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @aurios/mizzling@1.1.4 build /home/runner/work/mizzle/mizzle/packages/mizzling
+> @aurios/mizzling@1.1.6 build /home/runner/work/mizzle/mizzle/packages/mizzling
 > tsup
 
 CLI Building entry: src/cli.ts, src/index.ts
@@ -10,6 +10,10 @@
 CLI Cleaning output folder
 ESM Build start
 ESM dist/cli.js            13.77 KB
-ESM dist/chunk-DKDRM5WU.js 1.79 KB
 ESM dist/index.js          87.00 B
-ESM ⚡️ Build success in 36ms
+ESM dist/chunk-DKDRM5WU.js 1.79 KB
+ESM ⚡️ Build success in 58ms
+DTS Build start
+DTS ⚡️ Build success in 4820ms
+DTS dist/cli.d.ts   13.00 B
+DTS dist/index.d.ts 2.07 KB

package/README.md

@@ -1,4 +1,9 @@
-# 🌧️ Mizzling CLI
+# 🌧️ mizzling CLI
+
+![NPM Last Update](https://img.shields.io/npm/last-update/%40aurios%2Fmizzling?style=flat&color=0EA5E9)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/realfakenerd/mizzle/release.yml?style=flat&color=0EA5E9)
+![NPM Downloads](https://img.shields.io/npm/dw/%40aurios%2Fmizzling?style=flat&color=0EA5E9)
+![GitHub License](https://img.shields.io/github/license/realfakenerd/mizzle?style=flat&color=0EA5E9)
 
 Mizzling is the official command-line interface for the Mizzle ORM, designed to manage DynamoDB migrations and schemas with ease. It provides a streamlined workflow for initializing projects, detecting schema changes, and applying them to your AWS environment.
 

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/index.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Configuration for Mizzle ORM.
+ */
+interface MizzleConfig {
+    /**
+     * Path or glob pattern(s) to the schema files.
+     */
+    schema: string | string[];
+    /**
+     * Directory where generated migrations and snapshots will be stored.
+     */
+    out: string;
+    /**
+     * AWS Region to connect to. Defaults to "us-east-1" if not specified.
+     * Can be overridden by MIZZLE_REGION environment variable.
+     */
+    region?: string;
+    /**
+     * Optional custom endpoint for DynamoDB (e.g., for local development).
+     * Can be overridden by MIZZLE_ENDPOINT environment variable.
+     */
+    endpoint?: string;
+    /**
+     * Explicit AWS credentials. If provided, these will be used instead of the
+     * default credential provider chain or profile.
+     */
+    credentials?: {
+        /**
+         * AWS Access Key ID.
+         */
+        accessKeyId: string;
+        /**
+         * AWS Secret Access Key.
+         */
+        secretAccessKey: string;
+        /**
+         * Optional AWS Session Token.
+         */
+        sessionToken?: string;
+    };
+    /**
+     * AWS Profile name to use for credentials.
+     */
+    profile?: string;
+    /**
+     * Maximum number of retry attempts for DynamoDB requests.
+     */
+    maxAttempts?: number;
+    /**
+     * Print all SQL statements (or DynamoDB commands) and their execution time.
+     */
+    verbose?: boolean;
+    /**
+     * Require user confirmation before pushing any changes to the database.
+     */
+    strict?: boolean;
+}
+/**
+ * Helper function to define the Mizzle CLI configuration with type safety and autocompletion.
+ *
+ * Typically used in a `mizzle.config.ts` file at the root of your project.
+ *
+ * @example
+ * ```ts
+ * import { defineConfig } from "@aurios/mizzling";
+ *
+ * export default defineConfig({
+ *   schema: "./src/schema.ts",
+ *   out: "./mizzle",
+ *   region: "us-east-1",
+ * });
+ * ```
+ *
+ * @param config The Mizzle configuration object.
+ * @returns The same configuration object, validated by TypeScript.
+ */
+declare function defineConfig(config: MizzleConfig): MizzleConfig;
+
+export { type MizzleConfig, defineConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurios/mizzling",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "description": "A CLI tool for managing Mizzle projects",
   "publishConfig": {
     "access": "public",
@@ -33,7 +33,10 @@
   },
   "type": "module",
   "exports": {
-    ".": "./dist/index.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
   },
   "dependencies": {
     "@aws-sdk/client-dynamodb": "3.962.0",
@@ -47,9 +50,9 @@
   "devDependencies": {
     "tsup": "^8.5.1",
     "@repo/shared": "0.0.3",
-    "@aurios/mizzle": "1.1.3",
     "@repo/typescript-config": "0.0.0",
-    "@repo/vitest-config": "0.0.0"
+    "@repo/vitest-config": "0.0.0",
+    "@aurios/mizzle": "1.1.5"
   },
   "scripts": {
     "check": "tsc --noEmit",

package/tsup.config.ts

@@ -1,12 +1,13 @@
 import { defineConfig } from "tsup";
 
 export default defineConfig({
-  entry: ["src/cli.ts", "src/index.ts"],
-  format: ["esm"],
-  clean: true,
-  noExternal: ["@repo/shared", "mizzle"],
-  minify: true,
-  banner: {
-    js: "#!/usr/bin/env node",
-  },
+    entry: ["src/cli.ts", "src/index.ts"],
+    format: ["esm"],
+    clean: true,
+    noExternal: ["@repo/shared", "mizzle"],
+    minify: true,
+    banner: {
+        js: "#!/usr/bin/env node",
+    },
+    dts: true
 });