@zenstackhq/sdk 3.0.0-alpha.26 → 3.0.0-alpha.28

package/dist/index.d.cts

@@ -33,12 +33,44 @@ declare namespace modelUtils {
   export { modelUtils_DELEGATE_AUX_RELATION_PREFIX as DELEGATE_AUX_RELATION_PREFIX, modelUtils_getAttribute as getAttribute, modelUtils_getAuthDecl as getAuthDecl, modelUtils_getContainingModel as getContainingModel, modelUtils_getIdFields as getIdFields, modelUtils_hasAttribute as hasAttribute, modelUtils_isDelegateModel as isDelegateModel, modelUtils_isFromStdlib as isFromStdlib, modelUtils_isIdField as isIdField, modelUtils_isUniqueField as isUniqueField, modelUtils_resolved as resolved };
 }
 
+/**
+ * Context passed to CLI plugins when calling `generate`.
+ */
 type CliGeneratorContext = {
+    /**
+     * ZModel file path.
+     */
+    schemaFile: string;
+    /**
+     * ZModel AST.
+     */
     model: Model;
-    outputPath: string;
-    tsSchemaFile: string;
+    /**
+     * Default output path for code generation.
+     */
+    defaultOutputPath: string;
+    /**
+     * Plugin options provided by the user.
+     */
+    pluginOptions: Record<string, unknown>;
 };
-type CliGenerator = (context: CliGeneratorContext) => MaybePromise<void>;
+/**
+ * Contract for a CLI plugin.
+ */
+interface CliPlugin {
+    /**
+     * Plugin's display name.
+     */
+    name: string;
+    /**
+     * Text to show during generation.
+     */
+    statusText?: string;
+    /**
+     * Code generation callback.
+     */
+    generate(context: CliGeneratorContext): MaybePromise<void>;
+}
 
 declare class FunctionCall {
     func: string;
@@ -90,7 +122,7 @@ declare class PrismaSchemaGenerator {
 }
 
 declare class TsSchemaGenerator {
-    generate(schemaFile: string, pluginModelFiles: string[], outputDir: string): Promise<void>;
+    generate(model: Model, outputDir: string): Promise<void>;
     private generateSchema;
     private generateSchemaStatements;
     private createSchemaObject;
@@ -206,4 +238,4 @@ declare class ZModelCodeGenerator {
     private isCollectionPredicateOperator;
 }
 
-export { type CliGenerator, type CliGeneratorContext, modelUtils as ModelUtils, PrismaSchemaGenerator, TsSchemaGenerator, ZModelCodeGenerator, type ZModelCodeOptions };
+export { type CliGeneratorContext, type CliPlugin, modelUtils as ModelUtils, PrismaSchemaGenerator, TsSchemaGenerator, ZModelCodeGenerator, type ZModelCodeOptions };

package/dist/index.d.ts

@@ -33,12 +33,44 @@ declare namespace modelUtils {
   export { modelUtils_DELEGATE_AUX_RELATION_PREFIX as DELEGATE_AUX_RELATION_PREFIX, modelUtils_getAttribute as getAttribute, modelUtils_getAuthDecl as getAuthDecl, modelUtils_getContainingModel as getContainingModel, modelUtils_getIdFields as getIdFields, modelUtils_hasAttribute as hasAttribute, modelUtils_isDelegateModel as isDelegateModel, modelUtils_isFromStdlib as isFromStdlib, modelUtils_isIdField as isIdField, modelUtils_isUniqueField as isUniqueField, modelUtils_resolved as resolved };
 }
 
+/**
+ * Context passed to CLI plugins when calling `generate`.
+ */
 type CliGeneratorContext = {
+    /**
+     * ZModel file path.
+     */
+    schemaFile: string;
+    /**
+     * ZModel AST.
+     */
     model: Model;
-    outputPath: string;
-    tsSchemaFile: string;
+    /**
+     * Default output path for code generation.
+     */
+    defaultOutputPath: string;
+    /**
+     * Plugin options provided by the user.
+     */
+    pluginOptions: Record<string, unknown>;
 };
-type CliGenerator = (context: CliGeneratorContext) => MaybePromise<void>;
+/**
+ * Contract for a CLI plugin.
+ */
+interface CliPlugin {
+    /**
+     * Plugin's display name.
+     */
+    name: string;
+    /**
+     * Text to show during generation.
+     */
+    statusText?: string;
+    /**
+     * Code generation callback.
+     */
+    generate(context: CliGeneratorContext): MaybePromise<void>;
+}
 
 declare class FunctionCall {
     func: string;
@@ -90,7 +122,7 @@ declare class PrismaSchemaGenerator {
 }
 
 declare class TsSchemaGenerator {
-    generate(schemaFile: string, pluginModelFiles: string[], outputDir: string): Promise<void>;
+    generate(model: Model, outputDir: string): Promise<void>;
     private generateSchema;
     private generateSchemaStatements;
     private createSchemaObject;
@@ -206,4 +238,4 @@ declare class ZModelCodeGenerator {
     private isCollectionPredicateOperator;
 }
 
-export { type CliGenerator, type CliGeneratorContext, modelUtils as ModelUtils, PrismaSchemaGenerator, TsSchemaGenerator, ZModelCodeGenerator, type ZModelCodeOptions };
+export { type CliGeneratorContext, type CliPlugin, modelUtils as ModelUtils, PrismaSchemaGenerator, TsSchemaGenerator, ZModelCodeGenerator, type ZModelCodeOptions };

package/dist/index.js

@@ -778,7 +778,6 @@ var PrismaSchemaGenerator = class {
 
 // src/ts-schema-generator.ts
 import { invariant } from "@zenstackhq/common-helpers";
-import { loadDocument } from "@zenstackhq/language";
 import { isArrayExpr as isArrayExpr2, isBinaryExpr, isDataField, isDataModel as isDataModel3, isDataSource, isEnum, isEnumField, isInvocationExpr as isInvocationExpr2, isLiteralExpr as isLiteralExpr3, isMemberAccessExpr, isNullExpr as isNullExpr2, isProcedure, isReferenceExpr as isReferenceExpr2, isThisExpr, isTypeDef as isTypeDef2, isUnaryExpr } from "@zenstackhq/language/ast";
 import { getAllAttributes as getAllAttributes2, getAllFields as getAllFields3, isDataFieldReference } from "@zenstackhq/language/utils";
 import fs from "fs";
@@ -789,12 +788,7 @@ var TsSchemaGenerator = class {
   static {
     __name(this, "TsSchemaGenerator");
   }
-  async generate(schemaFile, pluginModelFiles, outputDir) {
-    const loaded = await loadDocument(schemaFile, pluginModelFiles);
-    if (!loaded.success) {
-      throw new Error(`Error loading schema:${loaded.errors.join("\n")}`);
-    }
-    const { model } = loaded;
+  async generate(model, outputDir) {
     fs.mkdirSync(outputDir, {
       recursive: true
     });